Don't compile in ISP sources into the XPLAIN bridge project.

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

diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h
index 946ea5e..ba0b1bb 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, 2012.
+     Copyright (C) Dean Camera, 2017.

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

-  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2017  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


@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this

   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages


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

- *  \section Sec_Dependencies Module Source Dependencies
+ *  \section Sec_LEDs_Dependencies Module Source Dependencies

  *  The following files must be built with any user project that uses this module:
  *    - None
  *
  *  The following files must be built with any user project that uses this module:
  *    - None
  *

- *  \section Sec_ModDescription Module Description
+ *  \section Sec_LEDs_ModDescription Module Description

  *  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/LEDs.h file in the user project
  *  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/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.
  *  is set to \c BOARD_NONE, this driver is silently disabled.
  *
  *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.


@@ -69,14 +69,14 @@
  *        compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers)
  *        which contains only stub functions and defines no LEDs.
  *
  *        compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers)
  *        which contains only stub functions and defines no LEDs.
  *

- *  \section Sec_ExampleUsage Example Usage
+ *  \section Sec_LEDs_ExampleUsage Example Usage

  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *
  *  \code
  *      // Initialize the board LED driver before first use
  *      LEDs_Init();
  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *
  *  \code
  *      // Initialize the board LED driver before first use
  *      LEDs_Init();

- *      
+ *

  *      // Turn on each of the four LEDs in turn
  *      LEDs_SetAllLEDs(LEDS_LED1);
  *      Delay_MS(500);
  *      // Turn on each of the four LEDs in turn
  *      LEDs_SetAllLEDs(LEDS_LED1);
  *      Delay_MS(500);


@@ -86,11 +86,11 @@
  *      Delay_MS(500);
  *      LEDs_SetAllLEDs(LEDS_LED4);
  *      Delay_MS(500);
  *      Delay_MS(500);
  *      LEDs_SetAllLEDs(LEDS_LED4);
  *      Delay_MS(500);

- *      
+ *

  *      // Turn on all LEDs
  *      LEDs_SetAllLEDs(LEDS_ALL_LEDS);
  *      Delay_MS(1000);
  *      // Turn on all LEDs
  *      LEDs_SetAllLEDs(LEDS_ALL_LEDS);
  *      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);
  *  \endcode
  *      // 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);
  *  \endcode


@@ -108,13 +108,13 @@
                #include "../../Common/Common.h"
 
                #if (BOARD == BOARD_NONE)
                #include "../../Common/Common.h"
 
                #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 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"
                        static inline uint_reg_t LEDs_GetLEDs(void) { return 0; }
                #elif (BOARD == BOARD_USBKEY)
                        #include "AVR8/USBKEY/LEDs.h"


@@ -174,7 +174,7 @@
                        #include "UC3/EVK1104/LEDs.h"
                #elif (BOARD == BOARD_A3BU_XPLAINED)
                        #include "XMEGA/A3BU_XPLAINED/LEDs.h"
                        #include "UC3/EVK1104/LEDs.h"
                #elif (BOARD == BOARD_A3BU_XPLAINED)
                        #include "XMEGA/A3BU_XPLAINED/LEDs.h"

-               #elif ((BOARD == BOARD_USB2AX) || (BOARD == BOARD_USB2AX_V3))
+               #elif ((BOARD == BOARD_USB2AX) || (BOARD == BOARD_USB2AX_V3) || (BOARD == BOARD_USB2AX_V31))

                        #include "AVR8/USB2AX/LEDs.h"
                #elif ((BOARD == BOARD_MICROPENDOUS_REV1) || (BOARD == BOARD_MICROPENDOUS_REV2) || \
                       (BOARD == BOARD_MICROPENDOUS_32U2))
                        #include "AVR8/USB2AX/LEDs.h"
                #elif ((BOARD == BOARD_MICROPENDOUS_REV1) || (BOARD == BOARD_MICROPENDOUS_REV2) || \
                       (BOARD == BOARD_MICROPENDOUS_32U2))


@@ -188,17 +188,43 @@
                #elif (BOARD == BOARD_DUCE)
                        #include "AVR8/DUCE/LEDs.h"
                #elif (BOARD == BOARD_OLIMEX32U4)
                #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)
                #elif (BOARD == BOARD_OLIMEXT32U4)

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

                #elif (BOARD == BOARD_OLIMEXISPMK2)
                #elif (BOARD == BOARD_OLIMEXISPMK2)

-                       #include "AVR8/OLIMEXISPMK2/LEDs.h"             
+                       #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"
+               #elif (BOARD == BOARD_STANGE_ISP)
+                       #include "AVR8/STANGE_ISP/LEDs.h"
+               #elif (BOARD == BOARD_C3_XPLAINED)
+                       #include "XMEGA/C3_XPLAINED/LEDs.h"
+               #elif (BOARD == BOARD_U2S)
+                       #include "AVR8/U2S/LEDs.h"
+               #elif (BOARD == BOARD_YUN)
+                       #include "AVR8/YUN/LEDs.h"
+               #elif (BOARD == BOARD_MICRO)
+                       #include "AVR8/MICRO/LEDs.h"
+               #elif (BOARD == BOARD_POLOLUMICRO)
+                       #include "AVR8/POLOLUMICRO/LEDs.h"
+               #elif (BOARD == BOARD_XPLAINED_MINI)
+                       #include "AVR8/XPLAINED_MINI/LEDs.h"

                #else
                        #include "Board/LEDs.h"
                #endif
 
        /* Preprocessor Checks: */
                #if !defined(__DOXYGEN__)
                #else
                        #include "Board/LEDs.h"
                #endif
 
        /* Preprocessor Checks: */
                #if !defined(__DOXYGEN__)

+                       #if !defined(LEDS_NO_LEDS)
+                               #define LEDS_NO_LEDS   0
+                       #endif
+
+                       #if !defined(LEDS_ALL_LEDS)
+                               #define LEDS_ALL_LEDS  (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
+                       #endif
+

                        #if !defined(LEDS_LED1)
                                #define LEDS_LED1      0
                        #endif
                        #if !defined(LEDS_LED1)
                                #define LEDS_LED1      0
                        #endif


@@ -220,6 +246,8 @@
        #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.
        #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);
 
                 */
                static inline void LEDs_Init(void);
 


@@ -263,7 +291,7 @@
                /** Returns the status of all the board LEDs; set LED masks in the return value indicate that the
                 *  corresponding LED is 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.
+                *  \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
                 */
                static inline uint_reg_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
        #endif