3 Copyright (C) Dean Camera, 2014.
5 dean [at] fourwalledcubicle [dot] com
10 Copyright 2014 Dean Camera (dean [at] fourwalledcubicle [dot] com)
12 Permission to use, copy, modify, distribute, and sell this
13 software and its documentation for any purpose is hereby granted
14 without fee, provided that the above copyright notice appear in
15 all copies and that both that the copyright notice and this
16 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
21 The author disclaims all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
32 * \brief Module Clock Driver for the AVR32 UC3 microcontrollers.
34 * Clock management driver for the AVR32 UC3 microcontrollers. This driver allows for the configuration
35 * of the various clocks within the device to clock the various peripherals.
38 /** \ingroup Group_PlatformDrivers_UC3
39 * \defgroup Group_PlatformDrivers_UC3Clocks Clock Management Driver - LUFA/Platform/UC3/ClockManagement.h
40 * \brief Module Clock Driver for the AVR32 UC3 microcontrollers.
42 * \section Sec_PlatformDrivers_UC3Clocks_Dependencies Module Source Dependencies
43 * The following files must be built with any user project that uses this module:
46 * \section Sec_PlatformDrivers_UC3Clocks_ModDescription Module Description
47 * Clock management driver for the AVR32 UC3 microcontrollers. This driver allows for the configuration
48 * of the various clocks within the device to clock the various peripherals.
52 * #include <LUFA/Platform/UC3/ClockManagement.h>
56 * // Start the master external oscillator which will be used as the main clock reference
57 * UC3CLK_StartExternalOscillator(0, EXOSC_MODE_8MHZ_OR_MORE, EXOSC_START_0CLK);
59 * // Start the PLL for the CPU clock, switch CPU to it
60 * UC3CLK_StartPLL(0, CLOCK_SRC_OSC0, 12000000, F_CPU);
61 * UC3CLK_SetCPUClockSource(CLOCK_SRC_PLL0, F_CPU);
63 * // Start the PLL for the USB Generic Clock module
64 * UC3CLK_StartPLL(1, CLOCK_SRC_OSC0, 12000000, 48000000);
71 #ifndef _UC3_CLOCK_MANAGEMENT_H_
72 #define _UC3_CLOCK_MANAGEMENT_H_
75 #include "../../Common/Common.h"
77 /* Enable C linkage for C++ Compilers: */
78 #if defined(__cplusplus)
82 /* Public Interface - May be used in end-application: */
84 /** Enum for the possible external oscillator types. */
85 enum UC3_Extern_OSC_ClockTypes_t
87 EXOSC_MODE_CLOCK = AVR32_PM_OSCCTRL0_MODE_EXT_CLOCK, /**< External clock (non-crystal) mode. */
88 EXOSC_MODE_900KHZ_MAX = AVR32_PM_OSCCTRL0_MODE_CRYSTAL_G0, /**< External crystal oscillator equal to or slower than 900KHz. */
89 EXOSC_MODE_3MHZ_MAX = AVR32_PM_OSCCTRL0_MODE_CRYSTAL_G1, /**< External crystal oscillator equal to or slower than 3MHz. */
90 EXOSC_MODE_8MHZ_MAX = AVR32_PM_OSCCTRL0_MODE_CRYSTAL_G2, /**< External crystal oscillator equal to or slower than 8MHz. */
91 EXOSC_MODE_8MHZ_OR_MORE = AVR32_PM_OSCCTRL0_MODE_CRYSTAL_G3, /**< External crystal oscillator equal to or faster than 8MHz. */
94 /** Enum for the possible external oscillator startup times. */
95 enum UC3_Extern_OSC_ClockStartup_t
97 EXOSC_START_0CLK = AVR32_PM_OSCCTRL0_STARTUP_0_RCOSC, /**< Immediate startup, no delay. */
98 EXOSC_START_64CLK = AVR32_PM_OSCCTRL0_STARTUP_64_RCOSC, /**< Wait 64 clock cycles before startup for stability. */
99 EXOSC_START_128CLK = AVR32_PM_OSCCTRL0_STARTUP_128_RCOSC, /**< Wait 128 clock cycles before startup for stability. */
100 EXOSC_START_2048CLK = AVR32_PM_OSCCTRL0_STARTUP_2048_RCOSC, /**< Wait 2048 clock cycles before startup for stability. */
101 EXOSC_START_4096CLK = AVR32_PM_OSCCTRL0_STARTUP_4096_RCOSC, /**< Wait 4096 clock cycles before startup for stability. */
102 EXOSC_START_8192CLK = AVR32_PM_OSCCTRL0_STARTUP_8192_RCOSC, /**< Wait 8192 clock cycles before startup for stability. */
103 EXOSC_START_16384CLK = AVR32_PM_OSCCTRL0_STARTUP_16384_RCOSC, /**< Wait 16384 clock cycles before startup for stability. */
106 /** Enum for the possible module clock sources. */
107 enum UC3_System_ClockSource_t
109 CLOCK_SRC_SLOW_CLK = 0, /**< Clock sourced from the internal slow clock. */
110 CLOCK_SRC_OSC0 = 1, /**< Clock sourced from the Oscillator 0 clock. */
111 CLOCK_SRC_OSC1 = 2, /**< Clock sourced from the Oscillator 1 clock. */
112 CLOCK_SRC_PLL0 = 3, /**< Clock sourced from the PLL 0 clock. */
113 CLOCK_SRC_PLL1 = 4, /**< Clock sourced from the PLL 1 clock. */
116 /* Inline Functions: */
117 /** Starts the given external oscillator of the UC3 microcontroller, with the given options. This routine blocks until
118 * the oscillator is ready for use.
120 * \param[in] Channel Index of the external oscillator to start.
121 * \param[in] Type Type of clock attached to the given oscillator channel, a value from \ref UC3_Extern_OSC_ClockTypes_t.
122 * \param[in] Startup Startup time of the external oscillator, a value from \ref UC3_Extern_OSC_ClockStartup_t.
124 * \return Boolean \c true if the external oscillator was successfully started, \c false if invalid parameters specified.
126 static inline bool UC3CLK_StartExternalOscillator(const uint8_t Channel,
128 const uint8_t Startup) ATTR_ALWAYS_INLINE;
129 static inline bool UC3CLK_StartExternalOscillator(const uint8_t Channel,
131 const uint8_t Startup)
136 AVR32_PM.OSCCTRL0.startup = Startup;
137 AVR32_PM.OSCCTRL0.mode = Type;
140 AVR32_PM.OSCCTRL1.startup = Startup;
141 AVR32_PM.OSCCTRL1.mode = Type;
147 AVR32_PM.mcctrl |= (1 << (AVR32_PM_MCCTRL_OSC0EN_OFFSET + Channel));
149 while (!(AVR32_PM.poscsr & (1 << (AVR32_PM_POSCSR_OSC0RDY_OFFSET + Channel))));
153 /** Stops the given external oscillator of the UC3 microcontroller.
155 * \param[in] Channel Index of the external oscillator to stop.
157 static inline void UC3CLK_StopExternalOscillator(const uint8_t Channel) ATTR_ALWAYS_INLINE;
158 static inline void UC3CLK_StopExternalOscillator(const uint8_t Channel)
160 AVR32_PM.mcctrl &= ~(1 << (AVR32_PM_MCCTRL_OSC0EN_OFFSET + Channel));
163 /** Starts the given PLL of the UC3 microcontroller, with the given options. This routine blocks until the PLL is ready for use.
165 * \attention The output frequency must be equal to or greater than the source frequency.
167 * \param[in] Channel Index of the PLL to start.
168 * \param[in] Source Clock source for the PLL, a value from \ref UC3_System_ClockSource_t.
169 * \param[in] SourceFreq Frequency of the PLL's clock source, in Hz.
170 * \param[in] Frequency Target frequency of the PLL's output.
172 * \return Boolean \c true if the PLL was successfully started, \c false if invalid parameters specified.
174 static inline bool UC3CLK_StartPLL(const uint8_t Channel,
175 const uint8_t Source,
176 const uint32_t SourceFreq,
177 const uint32_t Frequency) ATTR_ALWAYS_INLINE;
178 static inline bool UC3CLK_StartPLL(const uint8_t Channel,
179 const uint8_t Source,
180 const uint32_t SourceFreq,
181 const uint32_t Frequency)
183 if (SourceFreq > Frequency)
189 AVR32_PM.PLL[Channel].pllosc = 0;
192 AVR32_PM.PLL[Channel].pllosc = 1;
198 AVR32_PM.PLL[Channel].pllmul = (Frequency / SourceFreq) ? (((Frequency / SourceFreq) - 1) / 2) : 0;
199 AVR32_PM.PLL[Channel].plldiv = 0;
200 AVR32_PM.PLL[Channel].pllen = true;
202 while (!(AVR32_PM.poscsr & (1 << (AVR32_PM_POSCSR_LOCK0_OFFSET + Channel))));
206 /** Stops the given PLL of the UC3 microcontroller.
208 * \param[in] Channel Index of the PLL to stop.
210 static inline void UC3CLK_StopPLL(const uint8_t Channel) ATTR_ALWAYS_INLINE;
211 static inline void UC3CLK_StopPLL(const uint8_t Channel)
213 AVR32_PM.PLL[Channel].pllen = false;
216 /** Starts the given Generic Clock of the UC3 microcontroller, with the given options.
218 * \param[in] Channel Index of the Generic Clock to start.
219 * \param[in] Source Clock source for the Generic Clock, a value from \ref UC3_System_ClockSource_t.
220 * \param[in] SourceFreq Frequency of the Generic Clock's clock source, in Hz.
221 * \param[in] Frequency Target frequency of the Generic Clock's output.
223 * \return Boolean \c true if the Generic Clock was successfully started, \c false if invalid parameters specified.
225 static inline bool UC3CLK_StartGenericClock(const uint8_t Channel,
226 const uint8_t Source,
227 const uint32_t SourceFreq,
228 const uint32_t Frequency) ATTR_ALWAYS_INLINE;
229 static inline bool UC3CLK_StartGenericClock(const uint8_t Channel,
230 const uint8_t Source,
231 const uint32_t SourceFreq,
232 const uint32_t Frequency)
234 if (Channel >= AVR32_PM_GCLK_NUM)
237 if (SourceFreq < Frequency)
243 AVR32_PM.GCCTRL[Channel].pllsel = false;
244 AVR32_PM.GCCTRL[Channel].oscsel = 0;
247 AVR32_PM.GCCTRL[Channel].pllsel = false;
248 AVR32_PM.GCCTRL[Channel].oscsel = 1;
251 AVR32_PM.GCCTRL[Channel].pllsel = true;
252 AVR32_PM.GCCTRL[Channel].oscsel = 0;
255 AVR32_PM.GCCTRL[Channel].pllsel = true;
256 AVR32_PM.GCCTRL[Channel].oscsel = 1;
262 AVR32_PM.GCCTRL[Channel].diven = (SourceFreq > Frequency) ? true : false;
263 AVR32_PM.GCCTRL[Channel].div = (((SourceFreq / Frequency) - 1) / 2);
264 AVR32_PM.GCCTRL[Channel].cen = true;
269 /** Stops the given generic clock of the UC3 microcontroller.
271 * \param[in] Channel Index of the generic clock to stop.
273 * \return Boolean \c true if the generic clock was successfully stopped, \c false if invalid parameters specified.
275 static inline bool UC3CLK_StopGenericClock(const uint8_t Channel) ATTR_ALWAYS_INLINE;
276 static inline bool UC3CLK_StopGenericClock(const uint8_t Channel)
278 if (Channel >= AVR32_PM_GCLK_NUM)
281 AVR32_PM.GCCTRL[Channel].cen = false;
286 /** Sets the clock source for the main microcontroller core. The given clock source should be configured
287 * and ready for use before this function is called.
289 * This function will configure the FLASH controller's wait states automatically to suit the given clock source.
291 * \param[in] Source Clock source for the CPU core, a value from \ref UC3_System_ClockSource_t.
292 * \param[in] SourceFreq Frequency of the CPU core's clock source, in Hz.
294 * \return Boolean \c true if the CPU core clock was successfully altered, \c false if invalid parameters specified.
296 static inline bool UC3CLK_SetCPUClockSource(const uint8_t Source,
297 const uint32_t SourceFreq) ATTR_ALWAYS_INLINE;
298 static inline bool UC3CLK_SetCPUClockSource(const uint8_t Source,
299 const uint32_t SourceFreq)
301 if (SourceFreq > AVR32_PM_CPU_MAX_FREQ)
304 AVR32_FLASHC.FCR.fws = (SourceFreq > AVR32_FLASHC_FWS_0_MAX_FREQ) ? true : false;
308 #if defined(AVR32_PM_MCCTRL_MCSEL_SLOW)
309 case CLOCK_SRC_SLOW_CLK:
310 AVR32_PM.MCCTRL.mcsel = AVR32_PM_MCCTRL_MCSEL_SLOW;
313 #if defined(AVR32_PM_MCCTRL_MCSEL_OSC0)
315 AVR32_PM.MCCTRL.mcsel = AVR32_PM_MCCTRL_MCSEL_OSC0;
318 #if defined(AVR32_PM_MCCTRL_MCSEL_PLL0)
320 AVR32_PM.MCCTRL.mcsel = AVR32_PM_MCCTRL_MCSEL_PLL0;
330 /* Disable C linkage for C++ Compilers: */
331 #if defined(__cplusplus)