aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/Board/LEDs.h
diff options
context:
space:
mode:
Diffstat (limited to 'LUFA/Drivers/Board/LEDs.h')
-rw-r--r--LUFA/Drivers/Board/LEDs.h368
1 files changed, 184 insertions, 184 deletions
diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h
index c44612522..5e6a4cd36 100644
--- a/LUFA/Drivers/Board/LEDs.h
+++ b/LUFA/Drivers/Board/LEDs.h
@@ -1,184 +1,184 @@
-/*
- 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
-
-/** @} */
+/*
+ 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
+
+/** @} */
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-04 21:15:59 +0000