Update trunk documentation for new LUFA release.

[pub/USBasp.git] / LUFA / Drivers / Board / LEDs.h

diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h
index 58cdffe..ac7716b 100644 (file)
--- a/LUFA/Drivers/Board/LEDs.h
+++ b/LUFA/Drivers/Board/LEDs.h
@@ -29,7 +29,7 @@
 */
 
 /** \file
 */
 
 /** \file

- *  \brief Master include file for the board LEDs driver.
+ *  \brief LED board hardware driver.

  *
  *  This file is the master dispatch header file for the board-specific LED driver, for boards containing user
  *  controllable LEDs.
  *
  *  This file is the master dispatch header file for the board-specific LED driver, for boards containing user
  *  controllable LEDs.


@@ -44,7 +44,8 @@
  */
 
 /** \ingroup Group_BoardDrivers
  */
 
 /** \ingroup Group_BoardDrivers

- *  @defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h
+ *  \defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h
+ *  \brief LED board hardware driver.

  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:


@@ -78,17 +79,17 @@
  *
  *      // Turn on each of the four LEDs in turn
  *      LEDs_SetAllLEDs(LEDS_LED1); 
  *
  *      // Turn on each of the four LEDs in turn
  *      LEDs_SetAllLEDs(LEDS_LED1); 

- *      _delay_ms(500);
+ *      Delay_MS(500);

  *      LEDs_SetAllLEDs(LEDS_LED1); 
  *      LEDs_SetAllLEDs(LEDS_LED1); 

- *      _delay_ms(500);
+ *      Delay_MS(500);

  *      LEDs_SetAllLEDs(LEDS_LED1); 
  *      LEDs_SetAllLEDs(LEDS_LED1); 

- *      _delay_ms(500);
+ *      Delay_MS(500);

  *      LEDs_SetAllLEDs(LEDS_LED1); 
  *      LEDs_SetAllLEDs(LEDS_LED1); 

- *      _delay_ms(500);
+ *      Delay_MS(500);

  *
  *      // Turn on all LEDs
  *      LEDs_SetAllLEDs(LEDS_ALL_LEDS);
  *
  *      // Turn on all LEDs
  *      LEDs_SetAllLEDs(LEDS_ALL_LEDS);

- *      _delay_ms(1000);
+ *      Delay_MS(1000);

  *
  *      // Turn on LED 1, turn off LED 2, leaving LEDs 3 and 4 in their current state
  *      LEDs_ChangeLEDs((LEDS_LED1 | LEDS_LED2), LEDS_LED1);
  *
  *      // Turn on LED 1, turn off LED 2, leaving LEDs 3 and 4 in their current state
  *      LEDs_ChangeLEDs((LEDS_LED1 | LEDS_LED2), LEDS_LED1);


@@ -101,10 +102,7 @@
 #define __LEDS_H__
 
        /* Macros: */
 #define __LEDS_H__
 
        /* Macros: */

-       #if !defined(__DOXYGEN__)

                #define __INCLUDE_FROM_LEDS_H
                #define __INCLUDE_FROM_LEDS_H

-               #define INCLUDE_FROM_LEDS_H
-       #endif

 
        /* Includes: */
        #include "../../Common/Common.h"
 
        /* Includes: */
        #include "../../Common/Common.h"


@@ -118,54 +116,56 @@
                static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) {};
                static inline uint8_t LEDs_GetLEDs(void) { return 0; }
        #elif (BOARD == BOARD_USBKEY)
                static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) {};
                static inline uint8_t LEDs_GetLEDs(void) { return 0; }
        #elif (BOARD == BOARD_USBKEY)

-               #include "USBKEY/LEDs.h"
+               #include "AVR8/USBKEY/LEDs.h"

        #elif (BOARD == BOARD_STK525)
        #elif (BOARD == BOARD_STK525)

-               #include "STK525/LEDs.h"
+               #include "AVR8/STK525/LEDs.h"

        #elif (BOARD == BOARD_STK526)
        #elif (BOARD == BOARD_STK526)

-               #include "STK526/LEDs.h"
+               #include "AVR8/STK526/LEDs.h"

        #elif (BOARD == BOARD_RZUSBSTICK)
        #elif (BOARD == BOARD_RZUSBSTICK)

-               #include "RZUSBSTICK/LEDs.h"
+               #include "AVR8/RZUSBSTICK/LEDs.h"

        #elif (BOARD == BOARD_ATAVRUSBRF01)
        #elif (BOARD == BOARD_ATAVRUSBRF01)

-               #include "ATAVRUSBRF01/LEDs.h"
+               #include "AVR8/ATAVRUSBRF01/LEDs.h"

        #elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
        #elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))

-               #include "XPLAIN/LEDs.h"
+               #include "AVR8/XPLAIN/LEDs.h"

        #elif (BOARD == BOARD_BUMBLEB)
        #elif (BOARD == BOARD_BUMBLEB)

-               #include "BUMBLEB/LEDs.h"
+               #include "AVR8/BUMBLEB/LEDs.h"

        #elif (BOARD == BOARD_EVK527)
        #elif (BOARD == BOARD_EVK527)

-               #include "EVK527/LEDs.h"
+               #include "AVR8/EVK527/LEDs.h"

        #elif (BOARD == BOARD_TEENSY)
        #elif (BOARD == BOARD_TEENSY)

-               #include "TEENSY/LEDs.h"
+               #include "AVR8/TEENSY/LEDs.h"

        #elif (BOARD == BOARD_USBTINYMKII)
        #elif (BOARD == BOARD_USBTINYMKII)

-               #include "USBTINYMKII/LEDs.h"
+               #include "AVR8/USBTINYMKII/LEDs.h"

        #elif (BOARD == BOARD_BENITO)
        #elif (BOARD == BOARD_BENITO)

-               #include "BENITO/LEDs.h"
+               #include "AVR8/BENITO/LEDs.h"

        #elif (BOARD == BOARD_JMDBU2)
        #elif (BOARD == BOARD_JMDBU2)

-               #include "JMDBU2/LEDs.h"
+               #include "AVR8/JMDBU2/LEDs.h"

        #elif (BOARD == BOARD_OLIMEX162)
        #elif (BOARD == BOARD_OLIMEX162)

-               #include "OLIMEX162/LEDs.h"
+               #include "AVR8/OLIMEX162/LEDs.h"

        #elif (BOARD == BOARD_USBFOO)
        #elif (BOARD == BOARD_USBFOO)

-               #include "USBFOO/LEDs.h"
+               #include "AVR8/USBFOO/LEDs.h"

        #elif (BOARD == BOARD_UDIP)
        #elif (BOARD == BOARD_UDIP)

-               #include "UDIP/LEDs.h"
+               #include "AVR8/UDIP/LEDs.h"

        #elif (BOARD == BOARD_BUI)
        #elif (BOARD == BOARD_BUI)

-               #include "BUI/LEDs.h"
+               #include "AVR8/BUI/LEDs.h"

        #elif (BOARD == BOARD_UNO)
        #elif (BOARD == BOARD_UNO)

-               #include "UNO/LEDs.h"
+               #include "AVR8/UNO/LEDs.h"

        #elif (BOARD == BOARD_CULV3)
        #elif (BOARD == BOARD_CULV3)

-               #include "CULV3/LEDs.h"
+               #include "AVR8/CULV3/LEDs.h"

        #elif (BOARD == BOARD_BLACKCAT)
        #elif (BOARD == BOARD_BLACKCAT)

-               #include "BLACKCAT/LEDs.h"
+               #include "AVR8/BLACKCAT/LEDs.h"

        #elif (BOARD == BOARD_MAXIMUS)
        #elif (BOARD == BOARD_MAXIMUS)

-               #include "MAXIMUS/LEDs.h"
+               #include "AVR8/MAXIMUS/LEDs.h"

        #elif (BOARD == BOARD_MINIMUS)
        #elif (BOARD == BOARD_MINIMUS)

-               #include "MINIMUS/LEDs.h"
+               #include "AVR8/MINIMUS/LEDs.h"

        #elif (BOARD == BOARD_ADAFRUITU4)
        #elif (BOARD == BOARD_ADAFRUITU4)

-               #include "ADAFRUITU4/LEDs.h"
+               #include "AVR8/ADAFRUITU4/LEDs.h"

        #elif (BOARD == BOARD_MICROSIN162)
        #elif (BOARD == BOARD_MICROSIN162)

-               #include "MICROSIN162/LEDs.h"
+               #include "AVR8/MICROSIN162/LEDs.h"

        #elif (BOARD == BOARD_SPARKFUN8U2)
        #elif (BOARD == BOARD_SPARKFUN8U2)

-               #include "SPARKFUN8U2/LEDs.h"
-       #elif (BOARD == BOARD_USER)
+               #include "AVR8/SPARKFUN8U2/LEDs.h"
+       #elif (BOARD == BOARD_EVK1101)
+               #include "UC3/EVK1101/LEDs.h"
+       #else

                #include "Board/LEDs.h"
        #endif
 
                #include "Board/LEDs.h"
        #endif
 


@@ -196,20 +196,20 @@
                 *
                 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
                 */
                 *
                 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
                 */

-               static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask);
+               static inline void LEDs_TurnOnLEDs(const uint_reg_t LEDMask);

 
                /** Turns off the LEDs specified in the given LED mask.
                 *
                 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
                 */
 
                /** Turns off the LEDs specified in the given LED mask.
                 *
                 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
                 */

-               static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask);
+               static inline void LEDs_TurnOffLEDs(const uint_reg_t LEDMask);

 
                /** Turns off all LEDs not specified in the given LED mask, and turns on all the LEDs in the given LED
                 *  mask.
                 *
                 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
                 */
 
                /** Turns off all LEDs not specified in the given LED mask, and turns on all the LEDs in the given LED
                 *  mask.
                 *
                 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
                 */

-               static inline void LEDs_SetAllLEDs(const uint8_t LEDMask);
+               static inline void LEDs_SetAllLEDs(const uint_reg_t LEDMask);

 
                /** Turns off all LEDs in the LED mask that are not set in the active mask, and turns on all the LEDs
                 *  specified in both the LED and active masks.
 
                /** Turns off all LEDs in the LED mask that are not set in the active mask, and turns on all the LEDs
                 *  specified in both the LED and active masks.


@@ -217,21 +217,21 @@
                 *  \param[in] LEDMask     Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
                 *  \param[in] ActiveMask  Mask of whether the LEDs in the LED mask should be turned on or off.
                 */
                 *  \param[in] LEDMask     Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
                 *  \param[in] ActiveMask  Mask of whether the LEDs in the LED mask should be turned on or off.
                 */

-               static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
-                                                  const uint8_t ActiveMask);
+               static inline void LEDs_ChangeLEDs(const uint_reg_t LEDMask,
+                                                  const uint_reg_t ActiveMask);

 
                /** Toggles all LEDs in the LED mask, leaving all others in their current states.
                 *
                 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
                 */
 
                /** Toggles all LEDs in the LED mask, leaving all others in their current states.
                 *
                 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
                 */

-               static inline void LEDs_ToggleLEDs(const uint8_t LEDMask);
+               static inline void LEDs_ToggleLEDs(const uint_reg_t LEDMask);

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

-               static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
+               static inline uint_reg_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;

        #endif
 
 #endif
        #endif
 
 #endif