Ensure the DFU bootloader disables and clears the activity LED toggle timer when...
[pub/USBasp.git] / LUFA / Platform / UC3 / ClockManagement.h
index d444097..2cd96d2 100644 (file)
@@ -7,7 +7,7 @@
 */
 
 /*
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  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
@@ -35,8 +35,8 @@
  *  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
+/** \ingroup Group_PlatformDrivers_UC3
+ *  \defgroup Group_PlatformDrivers_UC3Clocks Clock Management Driver - LUFA/Platform/UC3/ClockManagement.h
  *  \brief Module Clock Driver for the AVR32 UC3 microcontrollers.
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  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);
  *             }
 
                        /** Starts the given PLL of the UC3 microcontroller, with the given options. This routine blocks until the PLL is ready for use.
                         *
-                        *  \note The output frequency must be equal to or greater than the source frequency.
+                        *  \attention The output frequency must be equal to or greater than the source frequency.
                         *
                         *  \param[in] Channel     Index of the PLL to start.
                         *  \param[in] Source      Clock source for the PLL, a value from \ref UC3_System_ClockSource_t.