Update UC3 platform driver support to use the bitmasks defined in the header files over raw constants.

Start implementation of XMEGA platform drivers.

3 files changed, 242 insertions, 28 deletions

diff --git a/LUFA/Platform/UC3/ClockManagement.h b/LUFA/Platform/UC3/ClockManagement.h
index 608702069..d6fac358a 100644
--- a/LUFA/Platform/UC3/ClockManagement.h
+++ b/LUFA/Platform/UC3/ClockManagement.h
@@ -72,10 +72,6 @@
 #define _UC3_CLOCK_MANAGEMENT_H_

 

 	/* Includes: */

-		#include <avr32/io.h>

-		#include <stdbool.h>

-		#include <stdint.h>

-

 		#include <LUFA/Common/Common.h>

 

 	/* Enable C linkage for C++ Compilers: */

@@ -86,29 +82,29 @@
 	/* Public Interface - May be used in end-application: */

 		/* Macros: */

 			/** Enum for the possible external oscillator types. */

-			enum Extern_OSC_ClockTypes_t

+			enum UC3_Extern_OSC_ClockTypes_t

 			{

-				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. */		

+				EXOSC_MODE_CLOCK         = AVR32_PM_OSCCTRL0_MODE_EXT_CLOCK,  /**< External clock (non-crystal) mode. */

+				EXOSC_MODE_900KHZ_MAX    = AVR32_PM_OSCCTRL0_MODE_CRYSTAL_G0, /**< External crystal oscillator equal to or slower than 900KHz. */

+				EXOSC_MODE_3MHZ_MAX      = AVR32_PM_OSCCTRL0_MODE_CRYSTAL_G1, /**< External crystal oscillator equal to or slower than 3MHz. */

+				EXOSC_MODE_8MHZ_MAX      = AVR32_PM_OSCCTRL0_MODE_CRYSTAL_G2, /**< External crystal oscillator equal to or slower than 8MHz. */

+				EXOSC_MODE_8MHZ_OR_MORE  = AVR32_PM_OSCCTRL0_MODE_CRYSTAL_G3, /**< External crystal oscillator equal to or faster than 8MHz. */		

 			};

 

 			/** Enum for the possible external oscillator statup times. */

-			enum Extern_OSC_ClockStartup_t

+			enum UC3_Extern_OSC_ClockStartup_t

 			{

-				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. */

+				EXOSC_START_0CLK         = AVR32_PM_OSCCTRL0_STARTUP_0_RCOSC,     /**< Immediate startup, no delay. */

+				EXOSC_START_64CLK        = AVR32_PM_OSCCTRL0_STARTUP_64_RCOSC,    /**< Wait 64 clock cyles before startup for stability. */

+				EXOSC_START_128CLK       = AVR32_PM_OSCCTRL0_STARTUP_128_RCOSC,   /**< Wait 128 clock cyles before startup for stability. */

+				EXOSC_START_2048CLK      = AVR32_PM_OSCCTRL0_STARTUP_2048_RCOSC,  /**< Wait 2048 clock cyles before startup for stability. */

+				EXOSC_START_4096CLK      = AVR32_PM_OSCCTRL0_STARTUP_4096_RCOSC,  /**< Wait 4096 clock cyles before startup for stability. */

+				EXOSC_START_8192CLK      = AVR32_PM_OSCCTRL0_STARTUP_8192_RCOSC,  /**< Wait 8192 clock cyles before startup for stability. */

+				EXOSC_START_16384CLK     = AVR32_PM_OSCCTRL0_STARTUP_16384_RCOSC, /**< Wait 16384 clock cyles before startup for stability. */

 			};

 			

 			/** Enum for the possible module clock sources. */

-			enum System_ClockSource_t

+			enum UC3_System_ClockSource_t

 			{

 				CLOCK_SRC_SLOW_CLK       = 0, /**< Clock sourced from the internal slow clock. */

 				CLOCK_SRC_OSC0           = 1, /**< Clock sourced from the Oscillator 0 clock. */

@@ -122,8 +118,8 @@
 			 *  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.

+			 *  \param[in] Type     Type of clock attached to the given oscillator channel, a value from \ref UC3_Extern_OSC_ClockTypes_t.

+			 *  \param[in] Startup  Statup time of the external oscillator, a value from \ref UC3_Extern_OSC_ClockStartup_t.

 			 *

 			 *  \return Boolean \c true if the external oscillator was successfully started, \c false if invalid parameters specified.

 			 */

@@ -167,7 +163,7 @@
 			/** 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] Source      Clock source for the PLL, a value from \ref UC3_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.

 			 *

@@ -215,7 +211,7 @@
 			/** 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] Source      Clock source for the Generic Clock, a value from \ref UC3_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.

 			 *

@@ -277,7 +273,7 @@
 			 *

 			 *  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] Source      Clock source for the CPU core, a value from \ref UC3_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.

diff --git a/LUFA/Platform/UC3/InterruptManagement.h b/LUFA/Platform/UC3/InterruptManagement.h
index bc27f2207..67dc3ea1d 100644
--- a/LUFA/Platform/UC3/InterruptManagement.h
+++ b/LUFA/Platform/UC3/InterruptManagement.h
@@ -71,10 +71,6 @@
 #define _UC3_INTERRUPT_MANAGEMENT_H_

 

 	/* Includes: */

-		#include <avr32/io.h>

-		#include <stdbool.h>

-		#include <stdint.h>

-

 		#include <LUFA/Common/Common.h>

 

 	/* Enable C linkage for C++ Compilers: */

diff --git a/LUFA/Platform/XMEGA/ClockManagement.h b/LUFA/Platform/XMEGA/ClockManagement.h
new file mode 100644
index 000000000..de531c298
--- /dev/null
+++ b/LUFA/Platform/XMEGA/ClockManagement.h
@@ -0,0 +1,222 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2011.

+

+  dean [at] fourwalledcubicle [dot] com

+           www.lufa-lib.org

+*/

+

+/*

+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)

+

+  Permission to use, copy, modify, distribute, and sell this

+  software and its documentation for any purpose is hereby granted

+  without fee, provided that the above copyright notice appear in

+  all copies and that both that the copyright notice and this

+  permission notice and warranty disclaimer appear in supporting

+  documentation, and that the name of the author not be used in

+  advertising or publicity pertaining to distribution of the

+  software without specific, written prior permission.

+

+  The author disclaim all warranties with regard to this

+  software, including all implied warranties of merchantability

+  and fitness.  In no event shall the author be liable for any

+  special, indirect or consequential damages or any damages

+  whatsoever resulting from loss of use, data or profits, whether

+  in an action of contract, negligence or other tortious action,

+  arising out of or in connection with the use or performance of

+  this software.

+*/

+

+/** \file

+ *  \brief Module Clock Driver for the AVR USB XMEGA microcontrollers.

+ *

+ *  Clock management driver for the AVR USB XMEGA 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_XMEGAClocks AVR USB XMEGA Clock Management Driver - LUFA/Platform/XMEGA/ClockManagement.h

+ *  \brief Module Clock Driver for the AVR USB XMEGA 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 AVR USB XMEGA 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/XMEGA/ClockManagement.h>

+ *

+ *		void main(void)

+ *		{

+ *			[TODO]

+ *		}

+ *  \endcode

+ *

+ *  @{

+ */

+

+#ifndef _XMEGA_CLOCK_MANAGEMENT_H_

+#define _XMEGA_CLOCK_MANAGEMENT_H_

+

+	/* Includes: */

+		#include <LUFA/Common/Common.h>

+

+	/* Enable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			extern "C" {

+		#endif

+

+	/* Public Interface - May be used in end-application: */

+		/* Macros: */

+			/** Enum for the possible external oscillator types. */

+			enum XMEGA_Extern_OSC_ClockTypes_t

+			{

+				EXOSC_MODE_2MHZ_MAX      = OSC_FRQRANGE_04TO2_gc,  /**< External crystal oscillator equal to or slower than 2MHz. */

+				EXOSC_MODE_9MHZ_MAX      = OSC_FRQRANGE_2TO9_gc,   /**< External crystal oscillator equal to or slower than 9MHz. */

+				EXOSC_MODE_12MHZ_MAX     = OSC_FRQRANGE_9TO12_gc,  /**< External crystal oscillator equal to or slower than 12MHz. */

+				EXOSC_MODE_16MHZ_MAX     = OSC_FRQRANGE_12TO16_gc, /**< External crystal oscillator equal to or slower than 16MHz. */	

+			};

+

+			/** Enum for the possible external oscillator statup times. */

+			enum XMEGA_Extern_OSC_ClockStartup_t

+			{

+				EXOSC_START_6CLK         = OSC_XOSCSEL_EXTCLK_gc,      /**< Wait 6 clock cycles before startup (external clock). */

+				EXOSC_START_32KCLK       = OSC_XOSCSEL_32KHz_gc,       /**< Wait 32K clock cycles before startup (32.768KHz crystal). */

+				EXOSC_START_256CLK       = OSC_XOSCSEL_XTAL_256CLK_gc, /**< Wait 256 clock cycles before startup. */

+				EXOSC_START_1KCLK        = OSC_XOSCSEL_XTAL_1KCLK_gc,  /**< Wait 1K clock cycles before startup. */

+				EXOSC_START_16KCLK       = OSC_XOSCSEL_XTAL_16KCLK_gc, /**< Wait 16K clock cycles before startup. */

+			};

+			

+			/** Enum for the possible module clock sources. */

+			enum XMEGA_System_ClockSource_t

+			{

+				CLOCK_SRC_INT_RC2MHZ    = 0, /**< Clock sourced from the Internal 2MHz RC Oscillator clock. */

+				CLOCK_SRC_INT_RC32MHZ   = 1, /**< Clock sourced from the Internal 32MHz RC Oscillator clock. */

+				CLOCK_SRC_INT_RC32KHZ   = 2, /**< Clock sourced from the Internal 32KHz RC Oscillator clock. */

+				CLOCK_SRC_XOSC          = 3, /**< Clock sourced from the External Oscillator clock. */

+				CLOCK_SRC_PLL           = 4, /**< Clock sourced from the Internal PLL 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 XMEGA_Extern_OSC_ClockTypes_t.

+			 *  \param[in] Startup  Statup time of the external oscillator, a value from \ref XMEGA_Extern_OSC_ClockStartup_t.

+			 *

+			 *  \return Boolean \c true if the external oscillator was successfully started, \c false if invalid parameters specified.

+			 */

+			static inline uint8_t AVR32CLK_StartExternalOscillator(const uint8_t Channel,

+			                                                       const uint8_t Type,

+			                                                       const uint8_t Startup) ATTR_ALWAYS_INLINE;

+			static inline uint8_t AVR32CLK_StartExternalOscillator(const uint8_t Channel,

+			                                                       const uint8_t Type,

+			                                                       const uint8_t Startup)

+			{

+				return false; // TODO

+			}

+

+			/** 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)

+			{

+				return; // TODO

+			}

+

+			/** 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 XMEGA_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)

+			{

+				return false; // TODO

+			}

+

+			/** 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)

+			{

+				// TODO

+			}

+			

+			/** 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 XMEGA_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)

+			{

+				return false; // TODO

+			}

+			

+			/** 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)

+			{

+				// TODO

+			}

+			

+			/** 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 XMEGA_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)

+			{

+				return false // TODO

+			}

+

+	/* Disable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			}

+		#endif

+

+#endif

+

+/** @} */