Minor documentation adjustments to the demos, projects and bootloaders to ensure...
[pub/USBasp.git] / LUFA / Drivers / Board / LEDs.h
index eec9991..f6f9d82 100644 (file)
@@ -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
  *      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); 
+ *      LEDs_SetAllLEDs(LEDS_LED1);
  *      Delay_MS(500);
  *      Delay_MS(500);
- *      LEDs_SetAllLEDs(LEDS_LED1); 
+ *      LEDs_SetAllLEDs(LEDS_LED2);
  *      Delay_MS(500);
  *      Delay_MS(500);
- *      LEDs_SetAllLEDs(LEDS_LED1); 
+ *      LEDs_SetAllLEDs(LEDS_LED3);
  *      Delay_MS(500);
  *      Delay_MS(500);
- *      LEDs_SetAllLEDs(LEDS_LED1); 
+ *      LEDs_SetAllLEDs(LEDS_LED4);
  *      Delay_MS(500);
  *
  *      // Turn on all LEDs
  *      Delay_MS(500);
  *
  *      // Turn on all LEDs
 
                #if (BOARD == BOARD_NONE)
                        static inline void LEDs_Init(void) {};
 
                #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_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) {};
                        #include "AVR8/BUMBLEB/LEDs.h"
                #elif (BOARD == BOARD_EVK527)
                        #include "AVR8/EVK527/LEDs.h"
                        #include "AVR8/BUMBLEB/LEDs.h"
                #elif (BOARD == BOARD_EVK527)
                        #include "AVR8/EVK527/LEDs.h"
-               #elif (BOARD == BOARD_TEENSY)
+               #elif ((BOARD == BOARD_TEENSY) || (BOARD == BOARD_TEENSY2))
                        #include "AVR8/TEENSY/LEDs.h"
                #elif (BOARD == BOARD_USBTINYMKII)
                        #include "AVR8/USBTINYMKII/LEDs.h"
                        #include "AVR8/TEENSY/LEDs.h"
                #elif (BOARD == BOARD_USBTINYMKII)
                        #include "AVR8/USBTINYMKII/LEDs.h"
                #elif (BOARD == BOARD_EVK1101)
                        #include "UC3/EVK1101/LEDs.h"
                #elif (BOARD == BOARD_TUL)
                #elif (BOARD == BOARD_EVK1101)
                        #include "UC3/EVK1101/LEDs.h"
                #elif (BOARD == BOARD_TUL)
-                       #include "AVR8/TUL/LEDs.h"      
+                       #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_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_TEENSY2)
-                       #include "AVR8/TEENSY/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
                #else
                        #include "Board/LEDs.h"
                #endif
                 */
                static inline void LEDs_Init(void);
 
                 */
                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).