Minor documentation adjustments to the demos, projects and bootloaders to ensure...

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

diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h
index 7a135b8..f6f9d82 100644 (file)
--- a/LUFA/Drivers/Board/LEDs.h
+++ b/LUFA/Drivers/Board/LEDs.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -55,7 +55,7 @@
  *  Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It
  *  provides an interface to configure, test and change the status of all the board LEDs.
  *
  *  Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It
  *  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/Dataflash.h file in the user project
+ *  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
  *  is set to \c BOARD_NONE, this driver is silently disabled.
  *
  *  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.
  *


@@ -74,22 +74,22 @@
  *  application.
  *
  *  \code
  *  application.
  *
  *  \code

- *      // Initialise the board LED driver before first use
+ *      // Initialize the board LED driver before first use

  *      LEDs_Init();
  *
  *      // Turn on each of the four LEDs in turn
  *      LEDs_Init();
  *
  *      // Turn on each of the four LEDs in turn

- *      LEDs_SetAllLEDs(LEDS_LED1); 
- *      _delay_ms(500);
- *      LEDs_SetAllLEDs(LEDS_LED1); 
- *      _delay_ms(500);
- *      LEDs_SetAllLEDs(LEDS_LED1); 
- *      _delay_ms(500);
- *      LEDs_SetAllLEDs(LEDS_LED1); 
- *      _delay_ms(500);
+ *      LEDs_SetAllLEDs(LEDS_LED1);
+ *      Delay_MS(500);
+ *      LEDs_SetAllLEDs(LEDS_LED2);
+ *      Delay_MS(500);
+ *      LEDs_SetAllLEDs(LEDS_LED3);
+ *      Delay_MS(500);
+ *      LEDs_SetAllLEDs(LEDS_LED4);
+ *      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);


@@ -105,93 +105,125 @@
                #define __INCLUDE_FROM_LEDS_H
 
        /* Includes: */
                #define __INCLUDE_FROM_LEDS_H
 
        /* Includes: */

-       #include "../../Common/Common.h"
-
-       #if (BOARD == BOARD_NONE)
-               static inline void LEDs_Init(void) {};
-               static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) {};
-               static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) {};
-               static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) {};
-               static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask) {};
-               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"
-       #elif (BOARD == BOARD_STK525)
-               #include "STK525/LEDs.h"
-       #elif (BOARD == BOARD_STK526)
-               #include "STK526/LEDs.h"
-       #elif (BOARD == BOARD_RZUSBSTICK)
-               #include "RZUSBSTICK/LEDs.h"
-       #elif (BOARD == BOARD_ATAVRUSBRF01)
-               #include "ATAVRUSBRF01/LEDs.h"
-       #elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
-               #include "XPLAIN/LEDs.h"
-       #elif (BOARD == BOARD_BUMBLEB)
-               #include "BUMBLEB/LEDs.h"
-       #elif (BOARD == BOARD_EVK527)
-               #include "EVK527/LEDs.h"
-       #elif (BOARD == BOARD_TEENSY)
-               #include "TEENSY/LEDs.h"
-       #elif (BOARD == BOARD_USBTINYMKII)
-               #include "USBTINYMKII/LEDs.h"
-       #elif (BOARD == BOARD_BENITO)
-               #include "BENITO/LEDs.h"
-       #elif (BOARD == BOARD_JMDBU2)
-               #include "JMDBU2/LEDs.h"
-       #elif (BOARD == BOARD_OLIMEX162)
-               #include "OLIMEX162/LEDs.h"
-       #elif (BOARD == BOARD_USBFOO)
-               #include "USBFOO/LEDs.h"
-       #elif (BOARD == BOARD_UDIP)
-               #include "UDIP/LEDs.h"
-       #elif (BOARD == BOARD_BUI)
-               #include "BUI/LEDs.h"
-       #elif (BOARD == BOARD_UNO)
-               #include "UNO/LEDs.h"
-       #elif (BOARD == BOARD_CULV3)
-               #include "CULV3/LEDs.h"
-       #elif (BOARD == BOARD_BLACKCAT)
-               #include "BLACKCAT/LEDs.h"
-       #elif (BOARD == BOARD_MAXIMUS)
-               #include "MAXIMUS/LEDs.h"
-       #elif (BOARD == BOARD_MINIMUS)
-               #include "MINIMUS/LEDs.h"
-       #elif (BOARD == BOARD_ADAFRUITU4)
-               #include "ADAFRUITU4/LEDs.h"
-       #elif (BOARD == BOARD_MICROSIN162)
-               #include "MICROSIN162/LEDs.h"
-       #elif (BOARD == BOARD_SPARKFUN8U2)
-               #include "SPARKFUN8U2/LEDs.h"
-       #elif (BOARD == BOARD_EVK1101)
-               #include "EVK1101/LEDs.h"
-       #else
-               #include "Board/LEDs.h"
-       #endif
+               #include "../../Common/Common.h"

 
 

-       #if !defined(LEDS_LED1)
-               #define LEDS_LED1      0
-       #endif
+               #if (BOARD == BOARD_NONE)
+                       static inline void LEDs_Init(void) {};
+                       static inline void LEDs_Disable(void) {};
+                       static inline void LEDs_TurnOnLEDs(const uint_reg_t LEDMask) {};
+                       static inline void LEDs_TurnOffLEDs(const uint_reg_t LEDMask) {};
+                       static inline void LEDs_SetAllLEDs(const uint_reg_t LEDMask) {};
+                       static inline void LEDs_ChangeLEDs(const uint_reg_t LEDMask, const uint_reg_t ActiveMask) {};
+                       static inline void LEDs_ToggleLEDs(const uint_reg_t LEDMask) {};
+                       static inline uint_reg_t LEDs_GetLEDs(void) { return 0; }
+               #elif (BOARD == BOARD_USBKEY)
+                       #include "AVR8/USBKEY/LEDs.h"
+               #elif (BOARD == BOARD_STK525)
+                       #include "AVR8/STK525/LEDs.h"
+               #elif (BOARD == BOARD_STK526)
+                       #include "AVR8/STK526/LEDs.h"
+               #elif (BOARD == BOARD_RZUSBSTICK)
+                       #include "AVR8/RZUSBSTICK/LEDs.h"
+               #elif (BOARD == BOARD_ATAVRUSBRF01)
+                       #include "AVR8/ATAVRUSBRF01/LEDs.h"
+               #elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
+                       #include "AVR8/XPLAIN/LEDs.h"
+               #elif (BOARD == BOARD_BUMBLEB)
+                       #include "AVR8/BUMBLEB/LEDs.h"
+               #elif (BOARD == BOARD_EVK527)
+                       #include "AVR8/EVK527/LEDs.h"
+               #elif ((BOARD == BOARD_TEENSY) || (BOARD == BOARD_TEENSY2))
+                       #include "AVR8/TEENSY/LEDs.h"
+               #elif (BOARD == BOARD_USBTINYMKII)
+                       #include "AVR8/USBTINYMKII/LEDs.h"
+               #elif (BOARD == BOARD_BENITO)
+                       #include "AVR8/BENITO/LEDs.h"
+               #elif (BOARD == BOARD_JMDBU2)
+                       #include "AVR8/JMDBU2/LEDs.h"
+               #elif (BOARD == BOARD_OLIMEX162)
+                       #include "AVR8/OLIMEX162/LEDs.h"
+               #elif (BOARD == BOARD_USBFOO)
+                       #include "AVR8/USBFOO/LEDs.h"
+               #elif (BOARD == BOARD_UDIP)
+                       #include "AVR8/UDIP/LEDs.h"
+               #elif (BOARD == BOARD_BUI)
+                       #include "AVR8/BUI/LEDs.h"
+               #elif (BOARD == BOARD_UNO)
+                       #include "AVR8/UNO/LEDs.h"
+               #elif (BOARD == BOARD_CULV3)
+                       #include "AVR8/CULV3/LEDs.h"
+               #elif (BOARD == BOARD_BLACKCAT)
+                       #include "AVR8/BLACKCAT/LEDs.h"
+               #elif (BOARD == BOARD_MAXIMUS)
+                       #include "AVR8/MAXIMUS/LEDs.h"
+               #elif (BOARD == BOARD_MINIMUS)
+                       #include "AVR8/MINIMUS/LEDs.h"
+               #elif (BOARD == BOARD_ADAFRUITU4)
+                       #include "AVR8/ADAFRUITU4/LEDs.h"
+               #elif (BOARD == BOARD_MICROSIN162)
+                       #include "AVR8/MICROSIN162/LEDs.h"
+               #elif (BOARD == BOARD_SPARKFUN8U2)
+                       #include "AVR8/SPARKFUN8U2/LEDs.h"
+               #elif (BOARD == BOARD_EVK1101)
+                       #include "UC3/EVK1101/LEDs.h"
+               #elif (BOARD == BOARD_TUL)
+                       #include "AVR8/TUL/LEDs.h"
+               #elif (BOARD == BOARD_EVK1100)
+                       #include "UC3/EVK1100/LEDs.h"
+               #elif (BOARD == BOARD_EVK1104)
+                       #include "UC3/EVK1104/LEDs.h"
+               #elif (BOARD == BOARD_A3BU_XPLAINED)
+                       #include "XMEGA/A3BU_XPLAINED/LEDs.h"
+               #elif ((BOARD == BOARD_USB2AX) || (BOARD == BOARD_USB2AX_V3))
+                       #include "AVR8/USB2AX/LEDs.h"
+               #elif ((BOARD == BOARD_MICROPENDOUS_REV1) || (BOARD == BOARD_MICROPENDOUS_REV2) || \
+                      (BOARD == BOARD_MICROPENDOUS_32U2))
+                       #include "AVR8/MICROPENDOUS/LEDs.h"
+               #elif (BOARD == BOARD_B1_XPLAINED)
+                       #include "XMEGA/B1_XPLAINED/LEDs.h"
+               #elif (BOARD == BOARD_MULTIO)
+                       #include "AVR8/MULTIO/LEDs.h"
+               #elif (BOARD == BOARD_BIGMULTIO)
+                       #include "AVR8/BIGMULTIO/LEDs.h"
+               #elif (BOARD == BOARD_DUCE)
+                       #include "AVR8/DUCE/LEDs.h"
+               #elif (BOARD == BOARD_OLIMEX32U4)
+                       #include "AVR8/OLIMEX32U4/LEDs.h"               
+               #elif (BOARD == BOARD_OLIMEXT32U4)
+                       #include "AVR8/OLIMEXT32U4/LEDs.h"              
+               #else
+                       #include "Board/LEDs.h"
+               #endif

 
 

-       #if !defined(LEDS_LED2)
-               #define LEDS_LED2      0
-       #endif
+       /* Preprocessor Checks: */
+               #if !defined(__DOXYGEN__)
+                       #if !defined(LEDS_LED1)
+                               #define LEDS_LED1      0
+                       #endif

 
 

-       #if !defined(LEDS_LED3)
-               #define LEDS_LED3      0
-       #endif
+                       #if !defined(LEDS_LED2)
+                               #define LEDS_LED2      0
+                       #endif

 
 

-       #if !defined(LEDS_LED4)
-               #define LEDS_LED4      0
-       #endif
+                       #if !defined(LEDS_LED3)
+                               #define LEDS_LED3      0
+                       #endif
+
+                       #if !defined(LEDS_LED4)
+                               #define LEDS_LED4      0
+                       #endif
+               #endif

 
        /* Pseudo-Functions for Doxygen: */
        #if defined(__DOXYGEN__)
 
        /* Pseudo-Functions for Doxygen: */
        #if defined(__DOXYGEN__)

-               /** Initialises the board LED driver so that the LEDs can be controlled. This sets the appropriate port
+               /** 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.
                 */
                static inline void LEDs_Init(void);
 
                 *  I/O pins as outputs, and sets the LEDs to default to off.
                 */
                static inline void LEDs_Init(void);
 

+               /** Disables the board LED driver, releasing the I/O pins back to their default high-impedence input mode. */
+               static inline void LEDs_Disable(void);
+

                /** Turns on 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 on 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).