Fixed missing semicolon in the ATAVRUSBRF01 LED board driver code, changed LED board...
[pub/lufa.git] / LUFA / Drivers / Board / LEDs.h
index 1874dfd..f65e67c 100644 (file)
  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project\r
  *  directory. Otherwise, it will include the appropriate built in board driver header file.\r
  *\r
+ *  \note To make code as compatible as possible, it is assumed that all boards carry a minimum of four LEDs. If\r
+ *        a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect.\r
+ *        If other behaviour is desired, either alias the remaining LED masks to existing LED masks via the -D \r
+ *        switch in the project makefile, or alias them to nothing in the makefile to cause compilation errors when\r
+ *        a non-existing LED is referenced in application code. Note that this means that it is possible to make\r
+ *        compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers)\r
+ *        which contains only stub functions and defines no LEDs.\r
+ *\r
  *  @{\r
  */\r
 \r
                #include "Board/LEDs.h"\r
        #endif\r
        \r
+       #if !defined(LEDS_LED1)\r
+               #define LEDS_LED1      0\r
+       #endif\r
+\r
+       #if !defined(LEDS_LED2)\r
+               #define LEDS_LED2      0\r
+       #endif\r
+\r
+       #if !defined(LEDS_LED3)\r
+               #define LEDS_LED3      0\r
+       #endif\r
+\r
+       #if !defined(LEDS_LED4)\r
+               #define LEDS_LED4      0\r
+       #endif\r
+       \r
        /* Pseudo-Functions for Doxygen: */\r
        #if defined(__DOXYGEN__)\r
                /** Initializes the board LED driver so that the LEDs can be controlled. This sets the appropriate port\r