Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/USBasp.git] / LUFA / Drivers / Board / LEDs.h
index c446125..5e6a4cd 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *  \brief Master include file for the board LEDs driver.\r
- *\r
- *  This file is the master dispatch header file for the board-specific LED driver, for boards containing user\r
- *  controllable LEDs.\r
- *\r
- *  User code should include this file, which will in turn include the correct LED driver header file for the\r
- *  currently selected board.\r
- *\r
- *  If the BOARD value is set to BOARD_USER, this will include the /Board/LEDs.h file in the user project\r
- *  directory.\r
- */\r
-\r
-/** \ingroup Group_BoardDrivers\r
- *  @defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h\r
- *\r
- *  \section Sec_Dependencies Module Source Dependencies\r
- *  The following files must be built with any user project that uses this module:\r
- *    - None\r
- *\r
- *  \section Module Description\r
- *  Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It\r
- *  provides an interface to configure, test and change the status of all the board LEDs.\r
- *\r
- *  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. If the BOARD value\r
- *  is set to BOARD_NONE, this driver is silently disabled.\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
-#ifndef __LEDS_H__\r
-#define __LEDS_H__\r
-\r
-       /* Macros: */\r
-       #if !defined(__DOXYGEN__)\r
-               #define __INCLUDE_FROM_LEDS_H\r
-               #define INCLUDE_FROM_LEDS_H\r
-       #endif\r
-       \r
-       /* Includes: */\r
-       #include "../../Common/Common.h"\r
-\r
-       #if (BOARD == BOARD_NONE)\r
-               static inline void LEDs_Init(void) {};\r
-               static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) {};\r
-               static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) {};\r
-               static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) {};\r
-               static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask) {};\r
-               static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) {};\r
-               static inline uint8_t LEDs_GetLEDs(void) { return 0; }\r
-       #elif (BOARD == BOARD_USBKEY)\r
-               #include "USBKEY/LEDs.h"\r
-       #elif (BOARD == BOARD_STK525)\r
-               #include "STK525/LEDs.h"\r
-       #elif (BOARD == BOARD_STK526)\r
-               #include "STK526/LEDs.h"\r
-       #elif (BOARD == BOARD_RZUSBSTICK)\r
-               #include "RZUSBSTICK/LEDs.h"\r
-       #elif (BOARD == BOARD_ATAVRUSBRF01)\r
-               #include "ATAVRUSBRF01/LEDs.h"\r
-       #elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))\r
-               #include "XPLAIN/LEDs.h"\r
-       #elif (BOARD == BOARD_BUMBLEB)\r
-               #include "BUMBLEB/LEDs.h"\r
-       #elif (BOARD == BOARD_EVK527)\r
-               #include "EVK527/LEDs.h"\r
-       #elif (BOARD == BOARD_TEENSY)\r
-               #include "TEENSY/LEDs.h"\r
-       #elif (BOARD == BOARD_USBTINYMKII)\r
-               #include "USBTINYMKII/LEDs.h"\r
-       #elif (BOARD == BOARD_BENITO)\r
-               #include "BENITO/LEDs.h"\r
-       #elif (BOARD == BOARD_JMDBU2)\r
-               #include "JMDBU2/LEDs.h"\r
-       #elif (BOARD == BOARD_USER)\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
-                *  I/O pins as outputs, and sets the LEDs to default to off.\r
-                */\r
-               static inline void LEDs_Init(void);\r
-\r
-               /** Turns on the LEDs specified in the given LED mask.\r
-                *\r
-                *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)\r
-                */\r
-               static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask);\r
-\r
-               /** Turns off the LEDs specified in the given LED mask.\r
-                *\r
-                *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)\r
-                */\r
-               static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask);\r
-\r
-               /** Turns off all LEDs not specified in the given LED mask, and turns on all the LEDs in the given LED\r
-                *  mask.\r
-                *\r
-                *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)\r
-                */\r
-               static inline void LEDs_SetAllLEDs(const uint8_t LEDMask);\r
-\r
-               /** Turns off all LEDs in the LED mask that are not set in the active mask, and turns on all the LEDs\r
-                *  specified in both the LED and active masks.\r
-                *\r
-                *  \param[in] LEDMask     Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)\r
-                *  \param[in] ActiveMask  Mask of whether the LEDs in the LED mask should be turned on or off\r
-                */\r
-               static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask);\r
-               \r
-               /** Toggles all LEDs in the LED mask, leaving all others in their current states.\r
-                *\r
-                *  \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)\r
-                */\r
-               static inline void LEDs_ToggleLEDs(const uint8_t LEDMask);\r
-\r
-               /** Returns the status of all the board LEDs; set LED masks in the return value indicate that the\r
-                *  corresponding LED is on.\r
-                *\r
-                *  \return Mask of the board LEDs which are currently turned on\r
-                */\r
-               static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
-       #endif\r
-\r
-#endif\r
-\r
-/** @} */\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2010  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
+  without fee, provided that the above copyright notice appear in 
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting 
+  documentation, and that the name of the author not be used in 
+  advertising or publicity pertaining to distribution of the 
+  software without specific, written prior permission.
+
+  The author disclaim 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
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *  \brief Master include file for the board LEDs driver.
+ *
+ *  This file is the master dispatch header file for the board-specific LED driver, for boards containing user
+ *  controllable LEDs.
+ *
+ *  User code should include this file, which will in turn include the correct LED driver header file for the
+ *  currently selected board.
+ *
+ *  If the BOARD value is set to BOARD_USER, this will include the /Board/LEDs.h file in the user project
+ *  directory.
+ */
+
+/** \ingroup Group_BoardDrivers
+ *  @defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h
+ *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - None
+ *
+ *  \section 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 BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.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 BOARD_NONE, this driver is silently disabled.
+ *
+ *  \note To make code as compatible as possible, it is assumed that all boards carry a minimum of four LEDs. If
+ *        a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect.
+ *        If other behaviour is desired, either alias the remaining LED masks to existing LED masks via the -D 
+ *        switch in the project makefile, or alias them to nothing in the makefile to cause compilation errors when
+ *        a non-existing LED is referenced in application code. Note that this means that it is possible to make
+ *        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.
+ *
+ *  @{
+ */
+
+#ifndef __LEDS_H__
+#define __LEDS_H__
+
+       /* Macros: */
+       #if !defined(__DOXYGEN__)
+               #define __INCLUDE_FROM_LEDS_H
+               #define INCLUDE_FROM_LEDS_H
+       #endif
+       
+       /* 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_USER)
+               #include "Board/LEDs.h"
+       #endif
+       
+       #if !defined(LEDS_LED1)
+               #define LEDS_LED1      0
+       #endif
+
+       #if !defined(LEDS_LED2)
+               #define LEDS_LED2      0
+       #endif
+
+       #if !defined(LEDS_LED3)
+               #define LEDS_LED3      0
+       #endif
+
+       #if !defined(LEDS_LED4)
+               #define LEDS_LED4      0
+       #endif
+       
+       /* Pseudo-Functions for Doxygen: */
+       #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.
+                */
+               static inline void LEDs_Init(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)
+                */
+               static inline void LEDs_TurnOnLEDs(const uint8_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)
+                */
+               static inline void LEDs_TurnOffLEDs(const uint8_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)
+                */
+               static inline void LEDs_SetAllLEDs(const uint8_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.
+                *
+                *  \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);
+               
+               /** 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);
+
+               /** 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;
+       #endif
+
+#endif
+
+/** @} */