Remove incorrect PROGMEM qualifier on the Manufacturer string descriptors in the...
[pub/USBasp.git] / LUFA / Drivers / Board / LEDs.h
index 97cb81a..6e08058 100644 (file)
  *  provides an interface to configure, test and change the status of all the board LEDs.
  *
  *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/LEDs.h file in the user project
- *  directory. Otherwise, it will include the appropriate built in board driver header file. If the BOARD value
+ *  directory. Otherwise, it will include the appropriate built-in board driver header file. If the BOARD value
  *  is set to \c BOARD_NONE, this driver is silently disabled.
  *
  *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
  *
  *  \note To make code as compatible as possible, it is assumed that all boards carry a minimum of four LEDs. If
  *        a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect.
- *        If other behaviour is desired, either alias the remaining LED masks to existing LED masks via the -D
+ *        If other behavior is desired, either alias the remaining LED masks to existing LED masks via the -D
  *        switch in the project makefile, or alias them to nothing in the makefile to cause compilation errors when
  *        a non-existing LED is referenced in application code. Note that this means that it is possible to make
  *        compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers)
                #elif (BOARD == BOARD_DUCE)
                        #include "AVR8/DUCE/LEDs.h"
                #elif (BOARD == BOARD_OLIMEX32U4)
-                       #include "AVR8/OLIMEX32U4/LEDs.h"               
+                       #include "AVR8/OLIMEX32U4/LEDs.h"
                #elif (BOARD == BOARD_OLIMEXT32U4)
-                       #include "AVR8/OLIMEXT32U4/LEDs.h"              
+                       #include "AVR8/OLIMEXT32U4/LEDs.h"
+               #elif (BOARD == BOARD_OLIMEXISPMK2)
+                       #include "AVR8/OLIMEXISPMK2/LEDs.h"
+               #elif (BOARD == BOARD_LEONARDO)
+                       #include "AVR8/LEONARDO/LEDs.h"
+               #elif (BOARD == BOARD_UC3A3_XPLAINED)
+                       #include "UC3/UC3A3_XPLAINED/LEDs.h"
                #else
                        #include "Board/LEDs.h"
                #endif
        #if defined(__DOXYGEN__)
                /** Initializes the board LED driver so that the LEDs can be controlled. This sets the appropriate port
                 *  I/O pins as outputs, and sets the LEDs to default to off.
+                *
+                *  This must be called before any LED driver functions are used.
                 */
                static inline void LEDs_Init(void);
 
-               /** Disables the board LED driver, releasing the I/O pins back to their default high-impedence input mode. */
+               /** Disables the board LED driver, releasing the I/O pins back to their default high-impedance input mode. */
                static inline void LEDs_Disable(void);
 
                /** Turns on the LEDs specified in the given LED mask.
                /** Returns the status of all the board LEDs; set LED masks in the return value indicate that the
                 *  corresponding LED is on.
                 *
-                *  \return Mask of the board LEDs which are currently turned on.
+                *  \return Mask of \c LEDS_LED* constants indicating which of the board LEDs are currently turned on.
                 */
                static inline uint_reg_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
        #endif