Enhance and document the AVR32 UC3 platform drivers.
This commit is contained in:
		
							parent
							
								
									bd8046976f
								
							
						
					
					
						commit
						5f51554a5e
					
				
					 5 changed files with 398 additions and 174 deletions
				
			
		| 
						 | 
				
			
			@ -28,8 +28,48 @@
 | 
			
		|||
  this software.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
#ifndef _CLOCK_MANAGEMENT_H_
 | 
			
		||||
#define _CLOCK_MANAGEMENT_H_
 | 
			
		||||
/** \file
 | 
			
		||||
 *  \brief Module Clock Driver for the AVR32 UC3 microcontrollers.
 | 
			
		||||
 *
 | 
			
		||||
 *  Clock management driver for the AVR32 UC3 microcontrollers. This driver allows for the configuration
 | 
			
		||||
 *  of the various clocks within the device to clock the various peripherals.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/** \ingroup Group_PlatformDrivers
 | 
			
		||||
 *  \defgroup Group_PlatformDrivers_UC3Clocks UC3 Clock Management Driver - LUFA/Platform/UC3/ClockManagement.h
 | 
			
		||||
 *  \brief Module Clock Driver for the AVR32 UC3 microcontrollers.
 | 
			
		||||
 *
 | 
			
		||||
 *  \section Sec_Dependencies Module Source Dependencies
 | 
			
		||||
 *  The following files must be built with any user project that uses this module:
 | 
			
		||||
 *    - None
 | 
			
		||||
 *
 | 
			
		||||
 *  \section Sec_ModDescription Module Description
 | 
			
		||||
 *  Clock management driver for the AVR32 UC3 microcontrollers. This driver allows for the configuration
 | 
			
		||||
 *  of the various clocks within the device to clock the various peripherals.
 | 
			
		||||
 *
 | 
			
		||||
 *  Usage Example:
 | 
			
		||||
 *  \code
 | 
			
		||||
 *		#include <LUFA/Platform/UC3/ClockManagement.h>
 | 
			
		||||
 *
 | 
			
		||||
 *		void main(void)
 | 
			
		||||
 *		{
 | 
			
		||||
 *			// Start the master external oscillator which will be used as the main clock reference
 | 
			
		||||
 *			AVR32CLK_StartExternalOscillator(0, EXOSC_MODE_8MHZ_OR_MORE, EXOSC_START_0CLK);
 | 
			
		||||
 *			
 | 
			
		||||
 *			// Start the PLL for the CPU clock, switch CPU to it
 | 
			
		||||
 *			AVR32CLK_StartPLL(0, CLOCK_SRC_OSC0, 12000000, F_CPU);
 | 
			
		||||
 *			AVR32CLK_SetCPUClockSource(CLOCK_SRC_PLL0, F_CPU);
 | 
			
		||||
 *
 | 
			
		||||
 *			// Start the PLL for the USB Generic Clock module
 | 
			
		||||
 *			AVR32CLK_StartPLL(1, CLOCK_SRC_OSC0, 12000000, 48000000);
 | 
			
		||||
 *		}
 | 
			
		||||
 *  \endcode
 | 
			
		||||
 *
 | 
			
		||||
 *  @{
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
#ifndef _UC3_CLOCK_MANAGEMENT_H_
 | 
			
		||||
#define _UC3_CLOCK_MANAGEMENT_H_
 | 
			
		||||
 | 
			
		||||
	/* Includes: */
 | 
			
		||||
		#include <avr32/io.h>
 | 
			
		||||
| 
						 | 
				
			
			@ -38,144 +78,240 @@
 | 
			
		|||
 | 
			
		||||
		#include <LUFA/Common/Common.h>
 | 
			
		||||
 | 
			
		||||
	/* Macros: */
 | 
			
		||||
		enum Extern_OSC_ClockStartup_t
 | 
			
		||||
		{
 | 
			
		||||
			EXOSC_START_0CLK         = 0,
 | 
			
		||||
			EXOSC_START_64CLK        = 1,
 | 
			
		||||
			EXOSC_START_128CLK       = 2,
 | 
			
		||||
			EXOSC_START_2048CLK      = 3,
 | 
			
		||||
			EXOSC_START_4096CLK      = 4,
 | 
			
		||||
			EXOSC_START_8192CLK      = 5,
 | 
			
		||||
			EXOSC_START_16384CLK     = 6,
 | 
			
		||||
		};
 | 
			
		||||
		
 | 
			
		||||
		enum Extern_OSC_ClockMode_t
 | 
			
		||||
		{
 | 
			
		||||
			EXOSC_MODE_CLOCK         = 0,
 | 
			
		||||
			EXOSC_MODE_900KHZ_MAX    = 1,
 | 
			
		||||
			EXOSC_MODE_3MHZ_MAX      = 2,
 | 
			
		||||
			EXOSC_MODE_8MHZ_MAX      = 3,
 | 
			
		||||
			EXOSC_MODE_8MHZ_OR_MORE  = 4,			
 | 
			
		||||
		};
 | 
			
		||||
		
 | 
			
		||||
		enum
 | 
			
		||||
		{
 | 
			
		||||
			CLOCK_SRC_SLOW_CLK       = 0,
 | 
			
		||||
			CLOCK_SRC_OSC0           = 1,
 | 
			
		||||
			CLOCK_SRC_OSC1           = 2,
 | 
			
		||||
			CLOCK_SRC_PLL0           = 3,
 | 
			
		||||
			CLOCK_SRC_PLL1           = 4,
 | 
			
		||||
		};
 | 
			
		||||
	/* Enable C linkage for C++ Compilers: */
 | 
			
		||||
		#if defined(__cplusplus)
 | 
			
		||||
			extern "C" {
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
	/* Inline Functions: */
 | 
			
		||||
		static inline bool AVR32CLK_StartExternalOscillator(const uint8_t Channel,
 | 
			
		||||
		                                                    const uint8_t Type,
 | 
			
		||||
		                                                    const uint8_t Startup)
 | 
			
		||||
		{
 | 
			
		||||
			AVR32_PM.OSCCTRL0.startup       = Startup;
 | 
			
		||||
			AVR32_PM.OSCCTRL0.mode          = Type;
 | 
			
		||||
			AVR32_PM.mcctrl                |= (1 << (AVR32_PM_MCCTRL_OSC0EN_OFFSET + Channel));
 | 
			
		||||
 | 
			
		||||
			while (!(AVR32_PM.poscsr & (1 << (AVR32_PM_POSCSR_OSC0RDY_OFFSET + Channel))));
 | 
			
		||||
			return true;
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		static inline void AVR32CLK_StopExternalOscillator(const uint8_t Channel)
 | 
			
		||||
		{
 | 
			
		||||
			AVR32_PM.mcctrl                &= ~(1 << (AVR32_PM_MCCTRL_OSC0EN_OFFSET + Channel));
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		static inline bool AVR32CLK_StartPLL(const uint8_t Channel,
 | 
			
		||||
		                                     const uint8_t Source,
 | 
			
		||||
		                                     const uint32_t SourceFreq,
 | 
			
		||||
		                                     const uint32_t Frequency)
 | 
			
		||||
		{
 | 
			
		||||
			switch (Source)
 | 
			
		||||
	/* Public Interface - May be used in end-application: */
 | 
			
		||||
		/* Macros: */
 | 
			
		||||
			/** Enum for the possible external oscillator types. */
 | 
			
		||||
			enum Extern_OSC_ClockTypes_t
 | 
			
		||||
			{
 | 
			
		||||
				case CLOCK_SRC_OSC0:
 | 
			
		||||
					AVR32_PM.PLL[Channel].pllosc = 0;
 | 
			
		||||
					break;
 | 
			
		||||
				case CLOCK_SRC_OSC1:
 | 
			
		||||
					AVR32_PM.PLL[Channel].pllosc = 1;
 | 
			
		||||
					break;
 | 
			
		||||
				default:
 | 
			
		||||
					return false;
 | 
			
		||||
			}
 | 
			
		||||
				EXOSC_MODE_CLOCK         = 0, /**< External clock (non-crystal) mode. */
 | 
			
		||||
				EXOSC_MODE_900KHZ_MAX    = 1, /**< External crystal oscillator equal to or slower than 900KHz. */
 | 
			
		||||
				EXOSC_MODE_3MHZ_MAX      = 2, /**< External crystal oscillator equal to or slower than 3MHz. */
 | 
			
		||||
				EXOSC_MODE_8MHZ_MAX      = 3, /**< External crystal oscillator equal to or slower than 8MHz. */
 | 
			
		||||
				EXOSC_MODE_8MHZ_OR_MORE  = 4, /**< External crystal oscillator equal to or faster than 8MHz. */		
 | 
			
		||||
			};
 | 
			
		||||
 | 
			
		||||
			AVR32_PM.PLL[Channel].pllmul    = (Frequency / SourceFreq) ? (((Frequency / SourceFreq) - 1) / 2) : 0;
 | 
			
		||||
			AVR32_PM.PLL[Channel].plldiv    = 0;
 | 
			
		||||
			AVR32_PM.PLL[Channel].pllen     = true;
 | 
			
		||||
 | 
			
		||||
			while (!(AVR32_PM.poscsr & (1 << (AVR32_PM_POSCSR_LOCK0_OFFSET + Channel))));
 | 
			
		||||
			return true;
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		static inline void AVR32CLK_StopPLL(const uint8_t Channel)
 | 
			
		||||
		{
 | 
			
		||||
			AVR32_PM.PLL[Channel].pllen     = false;
 | 
			
		||||
		}
 | 
			
		||||
		
 | 
			
		||||
		static inline bool AVR32CLK_StartGenericClock(const uint8_t Channel,
 | 
			
		||||
		                                              const uint8_t Source,
 | 
			
		||||
		                                              const uint32_t SourceFreq,
 | 
			
		||||
		                                              const uint32_t Frequency)
 | 
			
		||||
		{
 | 
			
		||||
			switch (Source)
 | 
			
		||||
			/** Enum for the possible external oscillator statup times. */
 | 
			
		||||
			enum Extern_OSC_ClockStartup_t
 | 
			
		||||
			{
 | 
			
		||||
				case CLOCK_SRC_OSC0:
 | 
			
		||||
					AVR32_PM.GCCTRL[Channel].pllsel = 0;
 | 
			
		||||
					AVR32_PM.GCCTRL[Channel].oscsel = 0;
 | 
			
		||||
					break;
 | 
			
		||||
				case CLOCK_SRC_OSC1:
 | 
			
		||||
					AVR32_PM.GCCTRL[Channel].pllsel = 0;
 | 
			
		||||
					AVR32_PM.GCCTRL[Channel].oscsel = 1;
 | 
			
		||||
					break;
 | 
			
		||||
				case CLOCK_SRC_PLL0:
 | 
			
		||||
					AVR32_PM.GCCTRL[Channel].pllsel = 1;
 | 
			
		||||
					AVR32_PM.GCCTRL[Channel].oscsel = 0;
 | 
			
		||||
					break;
 | 
			
		||||
				case CLOCK_SRC_PLL1:
 | 
			
		||||
					AVR32_PM.GCCTRL[Channel].pllsel = 1;
 | 
			
		||||
					AVR32_PM.GCCTRL[Channel].oscsel = 1;
 | 
			
		||||
					break;
 | 
			
		||||
				default:
 | 
			
		||||
					return false;
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			AVR32_PM.GCCTRL[Channel].diven  = (SourceFreq > Frequency) ? true : false;
 | 
			
		||||
			AVR32_PM.GCCTRL[Channel].div    = (((SourceFreq / Frequency) - 1) / 2);
 | 
			
		||||
			AVR32_PM.GCCTRL[Channel].cen    = true;
 | 
			
		||||
				EXOSC_START_0CLK         = 0, /**< Immediate startup, no delay. */
 | 
			
		||||
				EXOSC_START_64CLK        = 1, /**< Wait 64 clock cyles before startup for stability. */
 | 
			
		||||
				EXOSC_START_128CLK       = 2, /**< Wait 128 clock cyles before startup for stability. */
 | 
			
		||||
				EXOSC_START_2048CLK      = 3, /**< Wait 2048 clock cyles before startup for stability. */
 | 
			
		||||
				EXOSC_START_4096CLK      = 4, /**< Wait 4096 clock cyles before startup for stability. */
 | 
			
		||||
				EXOSC_START_8192CLK      = 5, /**< Wait 8192 clock cyles before startup for stability. */
 | 
			
		||||
				EXOSC_START_16384CLK     = 6, /**< Wait 16384 clock cyles before startup for stability. */
 | 
			
		||||
			};
 | 
			
		||||
			
 | 
			
		||||
			return true;
 | 
			
		||||
		}
 | 
			
		||||
		
 | 
			
		||||
		static inline void AVR32CLK_StopGenericClock(const uint8_t Channel)
 | 
			
		||||
		{
 | 
			
		||||
			AVR32_PM.GCCTRL[Channel].cen    = false;
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		static inline bool AVR32CLK_SetCPUClockSource(const uint8_t Source,
 | 
			
		||||
		                                              const uint32_t SourceFreq)
 | 
			
		||||
		{
 | 
			
		||||
			AVR32_FLASHC.FCR.fws            = (SourceFreq > 30000000) ? true : false;
 | 
			
		||||
 | 
			
		||||
			switch (Source)
 | 
			
		||||
			/** Enum for the possible module clock sources. */
 | 
			
		||||
			enum System_ClockSource_t
 | 
			
		||||
			{
 | 
			
		||||
				case CLOCK_SRC_SLOW_CLK:
 | 
			
		||||
					AVR32_PM.MCCTRL.mcsel   = 0;
 | 
			
		||||
					break;
 | 
			
		||||
				case CLOCK_SRC_OSC0:
 | 
			
		||||
					AVR32_PM.MCCTRL.mcsel   = 1;
 | 
			
		||||
					break;
 | 
			
		||||
				case CLOCK_SRC_PLL0:
 | 
			
		||||
					AVR32_PM.MCCTRL.mcsel   = 2;
 | 
			
		||||
					break;
 | 
			
		||||
				default:
 | 
			
		||||
					return false;
 | 
			
		||||
				CLOCK_SRC_SLOW_CLK       = 0, /**< Clock sourced from the internal slow clock. */
 | 
			
		||||
				CLOCK_SRC_OSC0           = 1, /**< Clock sourced from the Oscillator 0 clock. */
 | 
			
		||||
				CLOCK_SRC_OSC1           = 2, /**< Clock sourced from the Oscillator 1 clock. */
 | 
			
		||||
				CLOCK_SRC_PLL0           = 3, /**< Clock sourced from the PLL 0 clock. */
 | 
			
		||||
				CLOCK_SRC_PLL1           = 4, /**< Clock sourced from the PLL 1 clock. */
 | 
			
		||||
			};
 | 
			
		||||
 | 
			
		||||
		/* Inline Functions: */
 | 
			
		||||
			/** Starts the given external oscillator of the UC3 microcontroller, with the given options. This routine blocks until
 | 
			
		||||
			 *  the oscillator is ready for use.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \param[in] Channel  Index of the external oscillator to start.
 | 
			
		||||
			 *  \param[in] Type     Type of clock attached to the given oscillator channel, a value from \ref Extern_OSC_ClockTypes_t.
 | 
			
		||||
			 *  \param[in] Startup  Statup time of the external oscillator, a value from \ref Extern_OSC_ClockStartup_t.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \return Boolean \c true if the external oscillator was successfully started, \c false if invalid parameters specified.
 | 
			
		||||
			 */
 | 
			
		||||
			static inline void AVR32CLK_StartExternalOscillator(const uint8_t Channel,
 | 
			
		||||
			                                                    const uint8_t Type,
 | 
			
		||||
			                                                    const uint8_t Startup) ATTR_ALWAYS_INLINE;
 | 
			
		||||
			static inline void AVR32CLK_StartExternalOscillator(const uint8_t Channel,
 | 
			
		||||
			                                                    const uint8_t Type,
 | 
			
		||||
			                                                    const uint8_t Startup)
 | 
			
		||||
			{
 | 
			
		||||
				switch (Channel)
 | 
			
		||||
				{
 | 
			
		||||
					case 0:
 | 
			
		||||
						AVR32_PM.OSCCTRL0.startup = Startup;
 | 
			
		||||
						AVR32_PM.OSCCTRL0.mode    = Type;
 | 
			
		||||
						break;
 | 
			
		||||
					case 1:
 | 
			
		||||
						AVR32_PM.OSCCTRL1.startup = Startup;
 | 
			
		||||
						AVR32_PM.OSCCTRL1.mode    = Type;
 | 
			
		||||
						break;
 | 
			
		||||
					default:
 | 
			
		||||
						return false;
 | 
			
		||||
				}
 | 
			
		||||
 | 
			
		||||
				AVR32_PM.mcctrl                |= (1 << (AVR32_PM_MCCTRL_OSC0EN_OFFSET + Channel));
 | 
			
		||||
 | 
			
		||||
				while (!(AVR32_PM.poscsr & (1 << (AVR32_PM_POSCSR_OSC0RDY_OFFSET + Channel))));
 | 
			
		||||
				return true;
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			/** Stops the given external oscillator of the UC3 microcontroller.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \param[in] Channel  Index of the external oscillator to stop.
 | 
			
		||||
			 */
 | 
			
		||||
			static inline void AVR32CLK_StopExternalOscillator(const uint8_t Channel) ATTR_ALWAYS_INLINE;
 | 
			
		||||
			static inline void AVR32CLK_StopExternalOscillator(const uint8_t Channel)
 | 
			
		||||
			{
 | 
			
		||||
				AVR32_PM.mcctrl                &= ~(1 << (AVR32_PM_MCCTRL_OSC0EN_OFFSET + Channel));
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			/** Starts the given PLL of the UC3 microcontroller, with the given options. This routine blocks until the PLL is ready for use.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \param[in] Channel     Index of the PLL to start.
 | 
			
		||||
			 *  \param[in] Source      Clock source for the PLL, a value from \ref System_ClockSource_t.
 | 
			
		||||
			 *  \param[in] SourceFreq  Frequency of the PLL's clock source, in Hz.
 | 
			
		||||
			 *  \param[in] Frequency   Target frequency of the PLL's output.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \return Boolean \c true if the PLL was successfully started, \c false if invalid parameters specified.
 | 
			
		||||
			 */
 | 
			
		||||
			static inline bool AVR32CLK_StartPLL(const uint8_t Channel,
 | 
			
		||||
			                                     const uint8_t Source,
 | 
			
		||||
			                                     const uint32_t SourceFreq,
 | 
			
		||||
			                                     const uint32_t Frequency) ATTR_ALWAYS_INLINE;
 | 
			
		||||
			static inline bool AVR32CLK_StartPLL(const uint8_t Channel,
 | 
			
		||||
			                                     const uint8_t Source,
 | 
			
		||||
			                                     const uint32_t SourceFreq,
 | 
			
		||||
			                                     const uint32_t Frequency)
 | 
			
		||||
			{
 | 
			
		||||
				switch (Source)
 | 
			
		||||
				{
 | 
			
		||||
					case CLOCK_SRC_OSC0:
 | 
			
		||||
						AVR32_PM.PLL[Channel].pllosc = 0;
 | 
			
		||||
						break;
 | 
			
		||||
					case CLOCK_SRC_OSC1:
 | 
			
		||||
						AVR32_PM.PLL[Channel].pllosc = 1;
 | 
			
		||||
						break;
 | 
			
		||||
					default:
 | 
			
		||||
						return false;
 | 
			
		||||
				}
 | 
			
		||||
 | 
			
		||||
				AVR32_PM.PLL[Channel].pllmul    = (Frequency / SourceFreq) ? (((Frequency / SourceFreq) - 1) / 2) : 0;
 | 
			
		||||
				AVR32_PM.PLL[Channel].plldiv    = 0;
 | 
			
		||||
				AVR32_PM.PLL[Channel].pllen     = true;
 | 
			
		||||
 | 
			
		||||
				while (!(AVR32_PM.poscsr & (1 << (AVR32_PM_POSCSR_LOCK0_OFFSET + Channel))));
 | 
			
		||||
				return true;
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			/** Stops the given PLL of the UC3 microcontroller.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \param[in] Channel  Index of the PLL to stop.
 | 
			
		||||
			 */
 | 
			
		||||
			static inline void AVR32CLK_StopPLL(const uint8_t Channel) ATTR_ALWAYS_INLINE;
 | 
			
		||||
			static inline void AVR32CLK_StopPLL(const uint8_t Channel)
 | 
			
		||||
			{
 | 
			
		||||
				AVR32_PM.PLL[Channel].pllen     = false;
 | 
			
		||||
			}
 | 
			
		||||
			
 | 
			
		||||
			return true;
 | 
			
		||||
		}
 | 
			
		||||
			/** Starts the given Generic Clock of the UC3 microcontroller, with the given options.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \param[in] Channel     Index of the Generic Clock to start.
 | 
			
		||||
			 *  \param[in] Source      Clock source for the Generic Clock, a value from \ref System_ClockSource_t.
 | 
			
		||||
			 *  \param[in] SourceFreq  Frequency of the Generic Clock's clock source, in Hz.
 | 
			
		||||
			 *  \param[in] Frequency   Target frequency of the Generic Clock's output.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \return Boolean \c true if the Generic Clock was successfully started, \c false if invalid parameters specified.
 | 
			
		||||
			 */
 | 
			
		||||
			static inline bool AVR32CLK_StartGenericClock(const uint8_t Channel,
 | 
			
		||||
			                                              const uint8_t Source,
 | 
			
		||||
			                                              const uint32_t SourceFreq,
 | 
			
		||||
			                                              const uint32_t Frequency) ATTR_ALWAYS_INLINE;
 | 
			
		||||
			static inline bool AVR32CLK_StartGenericClock(const uint8_t Channel,
 | 
			
		||||
			                                              const uint8_t Source,
 | 
			
		||||
			                                              const uint32_t SourceFreq,
 | 
			
		||||
			                                              const uint32_t Frequency)
 | 
			
		||||
			{
 | 
			
		||||
				switch (Source)
 | 
			
		||||
				{
 | 
			
		||||
					case CLOCK_SRC_OSC0:
 | 
			
		||||
						AVR32_PM.GCCTRL[Channel].pllsel = 0;
 | 
			
		||||
						AVR32_PM.GCCTRL[Channel].oscsel = 0;
 | 
			
		||||
						break;
 | 
			
		||||
					case CLOCK_SRC_OSC1:
 | 
			
		||||
						AVR32_PM.GCCTRL[Channel].pllsel = 0;
 | 
			
		||||
						AVR32_PM.GCCTRL[Channel].oscsel = 1;
 | 
			
		||||
						break;
 | 
			
		||||
					case CLOCK_SRC_PLL0:
 | 
			
		||||
						AVR32_PM.GCCTRL[Channel].pllsel = 1;
 | 
			
		||||
						AVR32_PM.GCCTRL[Channel].oscsel = 0;
 | 
			
		||||
						break;
 | 
			
		||||
					case CLOCK_SRC_PLL1:
 | 
			
		||||
						AVR32_PM.GCCTRL[Channel].pllsel = 1;
 | 
			
		||||
						AVR32_PM.GCCTRL[Channel].oscsel = 1;
 | 
			
		||||
						break;
 | 
			
		||||
					default:
 | 
			
		||||
						return false;
 | 
			
		||||
				}
 | 
			
		||||
				
 | 
			
		||||
				if (SourceFreq < Frequency)
 | 
			
		||||
				  return false;
 | 
			
		||||
 | 
			
		||||
				AVR32_PM.GCCTRL[Channel].diven  = (SourceFreq > Frequency) ? true : false;
 | 
			
		||||
				AVR32_PM.GCCTRL[Channel].div    = (((SourceFreq / Frequency) - 1) / 2);
 | 
			
		||||
				AVR32_PM.GCCTRL[Channel].cen    = true;
 | 
			
		||||
				
 | 
			
		||||
				return true;
 | 
			
		||||
			}
 | 
			
		||||
			
 | 
			
		||||
			/** Stops the given generic clock of the UC3 microcontroller.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \param[in] Channel  Index of the generic clock to stop.
 | 
			
		||||
			 */
 | 
			
		||||
			static inline void AVR32CLK_StopGenericClock(const uint8_t Channel) ATTR_ALWAYS_INLINE;
 | 
			
		||||
			static inline void AVR32CLK_StopGenericClock(const uint8_t Channel)
 | 
			
		||||
			{
 | 
			
		||||
				AVR32_PM.GCCTRL[Channel].cen    = false;
 | 
			
		||||
			}
 | 
			
		||||
			
 | 
			
		||||
			/** Sets the clock source for the main microcontroller core. The given clock source should be configured
 | 
			
		||||
			 *  and ready for use before this function is called.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  This function will configure the FLASH controller's wait states automatically to suit the given clock source.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \param[in] Source      Clock source for the CPU core, a value from \ref System_ClockSource_t.
 | 
			
		||||
			 *  \param[in] SourceFreq  Frequency of the CPU core's clock source, in Hz.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \return Boolean \c true if the CPU core clock was sucessfully altered, \c false if invalid parameters specified.
 | 
			
		||||
			 */
 | 
			
		||||
			static inline bool AVR32CLK_SetCPUClockSource(const uint8_t Source,
 | 
			
		||||
			                                              const uint32_t SourceFreq) ATTR_ALWAYS_INLINE;
 | 
			
		||||
			static inline bool AVR32CLK_SetCPUClockSource(const uint8_t Source,
 | 
			
		||||
			                                              const uint32_t SourceFreq)
 | 
			
		||||
			{
 | 
			
		||||
				AVR32_FLASHC.FCR.fws = (SourceFreq > 30000000) ? true : false;
 | 
			
		||||
 | 
			
		||||
				switch (Source)
 | 
			
		||||
				{
 | 
			
		||||
					case CLOCK_SRC_SLOW_CLK:
 | 
			
		||||
						AVR32_PM.MCCTRL.mcsel   = 0;
 | 
			
		||||
						break;
 | 
			
		||||
					case CLOCK_SRC_OSC0:
 | 
			
		||||
						AVR32_PM.MCCTRL.mcsel   = 1;
 | 
			
		||||
						break;
 | 
			
		||||
					case CLOCK_SRC_PLL0:
 | 
			
		||||
						AVR32_PM.MCCTRL.mcsel   = 2;
 | 
			
		||||
						break;
 | 
			
		||||
					default:
 | 
			
		||||
						return false;
 | 
			
		||||
				}
 | 
			
		||||
				
 | 
			
		||||
				return true;
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
	/* Disable C linkage for C++ Compilers: */
 | 
			
		||||
		#if defined(__cplusplus)
 | 
			
		||||
			}
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
/** @} */
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -36,11 +36,11 @@ InterruptHandlerPtr_t InterruptHandlers[AVR32_INTC_NUM_INT_GRPS];
 | 
			
		|||
/** ISR for unhandled interrupt groups */
 | 
			
		||||
ISR(Unhandled_Interrupt)
 | 
			
		||||
{
 | 
			
		||||
	while (true);
 | 
			
		||||
	for (;;);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/** Retrieves the associated interrupt handler for the interrupt currently being fired. This is
 | 
			
		||||
 *  called directly from the exception handler routine before dispatching to the ISR.
 | 
			
		||||
/** Retrieves the associated interrupt handler for the interrupt group currently being fired. This
 | 
			
		||||
 *  is called directly from the exception handler routine before dispatching to the ISR.
 | 
			
		||||
 */
 | 
			
		||||
InterruptHandlerPtr_t INTC_GetInterruptHandler(const uint_reg_t InterruptLevel)
 | 
			
		||||
{
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -28,8 +28,47 @@
 | 
			
		|||
  this software.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
#ifndef _INTERRUPT_MANAGEMENT_H_
 | 
			
		||||
#define _INTERRUPT_MANAGEMENT_H_
 | 
			
		||||
/** \file
 | 
			
		||||
 *  \brief Interrupt Controller Driver for the AVR32 UC3 microcontrollers.
 | 
			
		||||
 *
 | 
			
		||||
 *  Interrupt controller driver for the AVR32 UC3 microcontrollers, for the configuration of interrupt
 | 
			
		||||
 *  handlers within the device.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/** \ingroup Group_PlatformDrivers
 | 
			
		||||
 *  \defgroup Group_PlatformDrivers_UC3Interrupts UC3 Interrupt Controller Driver - LUFA/Platform/UC3/InterruptManagement.h
 | 
			
		||||
 *  \brief Interrupt Controller Driver for the AVR32 UC3 microcontrollers.
 | 
			
		||||
 *
 | 
			
		||||
 *  \section Sec_Dependencies Module Source Dependencies
 | 
			
		||||
 *  The following files must be built with any user project that uses this module:
 | 
			
		||||
 *    - LUFA/Platform/UC3/InterruptManagement.c
 | 
			
		||||
 *    - LUFA/Platform/UC3/Exception.S
 | 
			
		||||
 *
 | 
			
		||||
 *  \section Sec_ModDescription Module Description
 | 
			
		||||
 *  Interrupt controller driver for the AVR32 UC3 microcontrollers, for the configuration of interrupt
 | 
			
		||||
 *  handlers within the device.
 | 
			
		||||
 *
 | 
			
		||||
 *  Usage Example:
 | 
			
		||||
 *  \code
 | 
			
		||||
 *		#include <LUFA/Platform/UC3/InterruptManagement.h>
 | 
			
		||||
 *
 | 
			
		||||
 *		ISR(USB_Group_IRQ_Handler)
 | 
			
		||||
 *		{
 | 
			
		||||
 *			// USB group handler code here
 | 
			
		||||
 *		}
 | 
			
		||||
 *
 | 
			
		||||
 *		void main(void)
 | 
			
		||||
 *		{
 | 
			
		||||
 *			INTC_Init();
 | 
			
		||||
 *			INTC_RegisterGroupHandler(INTC_IRQ_GROUP(AVR32_USBB_IRQ), AVR32_INTC_INT0, USB_Group_IRQ_Handler);
 | 
			
		||||
 *		}
 | 
			
		||||
 *  \endcode
 | 
			
		||||
 *
 | 
			
		||||
 *  @{
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
#ifndef _UC3_INTERRUPT_MANAGEMENT_H_
 | 
			
		||||
#define _UC3_INTERRUPT_MANAGEMENT_H_
 | 
			
		||||
 | 
			
		||||
	/* Includes: */
 | 
			
		||||
		#include <avr32/io.h>
 | 
			
		||||
| 
						 | 
				
			
			@ -38,46 +77,91 @@
 | 
			
		|||
 | 
			
		||||
		#include <LUFA/Common/Common.h>
 | 
			
		||||
 | 
			
		||||
	/* Macros: */
 | 
			
		||||
		#if !defined(ISR)
 | 
			
		||||
			#define ISR(Name)                 void Name (void) __attribute__((__interrupt__)); void Name (void)
 | 
			
		||||
	/* Enable C linkage for C++ Compilers: */
 | 
			
		||||
		#if defined(__cplusplus)
 | 
			
		||||
			extern "C" {
 | 
			
		||||
		#endif
 | 
			
		||||
		
 | 
			
		||||
		#define INTC_EnableInterrupts()   do { GCC_MEMORY_BARRIER(); __builtin_csrf(AVR32_SR_GM_OFFSET); } while (0)
 | 
			
		||||
		#define INTC_DisableInterrupts()  do { __builtin_ssrf(AVR32_SR_GM_OFFSET); GCC_MEMORY_BARRIER(); } while (0)
 | 
			
		||||
 | 
			
		||||
	/* Type Defines: */
 | 
			
		||||
		typedef void (*InterruptHandlerPtr_t)(void);
 | 
			
		||||
	/* Private Interface - For use in library only: */
 | 
			
		||||
	#if !defined(__DOXYGEN__)
 | 
			
		||||
		/* External Variables: */
 | 
			
		||||
			extern const void            EVBA_Table;
 | 
			
		||||
			extern const uint32_t        Autovector_Table[];
 | 
			
		||||
			extern InterruptHandlerPtr_t InterruptHandlers[AVR32_INTC_NUM_INT_GRPS];
 | 
			
		||||
	#endif
 | 
			
		||||
 | 
			
		||||
	/* External Variables: */
 | 
			
		||||
		extern const void            EVBA_Table;
 | 
			
		||||
		extern const uint32_t        Autovector_Table[];
 | 
			
		||||
		extern InterruptHandlerPtr_t InterruptHandlers[AVR32_INTC_NUM_INT_GRPS];
 | 
			
		||||
	/* Public Interface - May be used in end-application: */
 | 
			
		||||
		/* Macros: */
 | 
			
		||||
			/** Converts a given interrupt index into its assocated interrupt group.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \param[in] IRQIndex  Index of the interrupt request to convert.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \return Interrupt group number associated with the interrupt index.
 | 
			
		||||
			 */
 | 
			
		||||
			#define INTC_IRQ_GROUP(IRQIndex)  (IRQIndex / 32)
 | 
			
		||||
 | 
			
		||||
	/* Function Prototypes: */
 | 
			
		||||
		void INTC_Init(void);
 | 
			
		||||
			/** Converts a given interrupt index into its assocated interrupt line.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \param[in] IRQIndex  Index of the interrupt request to convert.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \return Interrupt line number associated with the interrupt index.
 | 
			
		||||
			 */
 | 
			
		||||
			#define INTC_IRQ_LINE(IRQIndex)   (IRQIndex % 32)
 | 
			
		||||
 | 
			
		||||
	/* Inline Functions: */
 | 
			
		||||
		/** Registers a handler for a given interrupt group. On the AVR32 UC3 devices, interrupts are grouped by
 | 
			
		||||
		 *  peripheral. To save on SRAM used, a single ISR handles all interrupt lines within a single group - to
 | 
			
		||||
		 *  determine the exact line that has interrupted within the group ISR handler, examine the module's interrupt
 | 
			
		||||
		 *  flag register bits.
 | 
			
		||||
		 *
 | 
			
		||||
		 *  If multiple interrupts with the same group are registered, the last registered handler will become the
 | 
			
		||||
		 *  handler called for interrupts raised within that group.
 | 
			
		||||
		 *
 | 
			
		||||
		 *  \param[in] InterruptRequest  Interrupt request index for the given interrupt, a AVR32_*_IRQ mask.
 | 
			
		||||
		 *  \param[in] InterruptLevel    Priority level for the specified interrupt, a AVR32_INTC_INT* mask.
 | 
			
		||||
		 *  \param[in] Handler           Address of the ISR handler for the interrupt group.
 | 
			
		||||
		 */
 | 
			
		||||
		static inline void INTC_RegisterGroupHandler(const uint16_t InterruptRequest,
 | 
			
		||||
												     const uint8_t  InterruptLevel,
 | 
			
		||||
												     const InterruptHandlerPtr_t Handler)
 | 
			
		||||
		{
 | 
			
		||||
			uint8_t InterruptGroup = (InterruptRequest >> 5);
 | 
			
		||||
		/* Type Defines: */
 | 
			
		||||
			/** Type define for an interrupt handler ISR function. */
 | 
			
		||||
			typedef void (*InterruptHandlerPtr_t)(void);
 | 
			
		||||
 | 
			
		||||
			InterruptHandlers[InterruptGroup] = Handler;
 | 
			
		||||
			AVR32_INTC.ipr[InterruptGroup]    = Autovector_Table[InterruptLevel];
 | 
			
		||||
		}
 | 
			
		||||
		/* Function Prototypes: */
 | 
			
		||||
			/** Initializes the interrupt controller, nulling out all interrupt handlers ready for new registration. This
 | 
			
		||||
			 *  function should be called once on startup to ensure the interrupt controller is ready for use.
 | 
			
		||||
			 */
 | 
			
		||||
			void INTC_Init(void);
 | 
			
		||||
 | 
			
		||||
		/* Inline Functions: */
 | 
			
		||||
			/** Registers a handler for a given interrupt group. On the AVR32 UC3 devices, interrupts are grouped by
 | 
			
		||||
			 *  peripheral. To save on SRAM used, a single ISR handles all interrupt lines within a single group - to
 | 
			
		||||
			 *  determine the exact line that has interrupted within the group ISR handler, use \ref INTC_GetGroupInterrupts().
 | 
			
		||||
			 *
 | 
			
		||||
			 *  If multiple interrupts with the same group are registered, the last registered handler will become the
 | 
			
		||||
			 *  handler called for interrupts raised within that group.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  To obtain the group number of a specific interrupt index, use the \ref INTC_IRQ_GROUP() macro.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \param[in] GroupNumber       Group number of the interrupt group to register a handler for.
 | 
			
		||||
			 *  \param[in] InterruptLevel    Priority level for the specified interrupt, a \c AVR32_INTC_INT* mask.
 | 
			
		||||
			 *  \param[in] Handler           Address of the ISR handler for the interrupt group.
 | 
			
		||||
			 */
 | 
			
		||||
			static inline void INTC_RegisterGroupHandler(const uint16_t GroupNumber,
 | 
			
		||||
			                                             const uint8_t InterruptLevel,
 | 
			
		||||
			                                             const InterruptHandlerPtr_t Handler) ATTR_ALWAYS_INLINE;
 | 
			
		||||
			static inline void INTC_RegisterGroupHandler(const uint16_t GroupNumber,
 | 
			
		||||
			                                             const uint8_t InterruptLevel,
 | 
			
		||||
			                                             const InterruptHandlerPtr_t Handler)
 | 
			
		||||
			{
 | 
			
		||||
				InterruptHandlers[GroupNumber] = Handler;
 | 
			
		||||
				AVR32_INTC.ipr[GroupNumber]    = Autovector_Table[InterruptLevel];
 | 
			
		||||
			}
 | 
			
		||||
			
 | 
			
		||||
			/** Retrieves the pending interrupts for a given interrupt group. The result of this function should be masked
 | 
			
		||||
			 *  against interrupt request indexes converted to a request line number via the \ref INTC_IRQ_LINE() macro. To
 | 
			
		||||
			 *  obtain the group number of a given interrupt request, use the \ref INTC_IRQ_GROUP() macro.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \param[in] GroupNumber Group number of the interrupt group to check.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \return Mask of pending interrupt lines for the given interrupt group.
 | 
			
		||||
			 */
 | 
			
		||||
			static inline uint_reg_t INTC_GetGroupInterrupts(const uint16_t GroupNumber) ATTR_ALWAYS_INLINE;
 | 
			
		||||
			static inline uint_reg_t INTC_GetGroupInterrupts(const uint16_t GroupNumber)
 | 
			
		||||
			{
 | 
			
		||||
				return AVR32_INTC.irr[GroupNumber];
 | 
			
		||||
			}
 | 
			
		||||
	
 | 
			
		||||
	/* Disable C linkage for C++ Compilers: */
 | 
			
		||||
		#if defined(__cplusplus)
 | 
			
		||||
			}
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
/** @} */
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue