LEDs.h 6.23 KB
 Dean Camera committed Feb 23, 2009 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 /* LUFA Library Copyright (C) Dean Camera, 2009. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, 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 * * 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. */  Dean Camera committed Apr 16, 2009 42 43 44 45  /** \ingroup Group_BoardDrivers * @defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h *  Dean Camera committed Apr 17, 2009 46 47 48 49 50  * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * * \section Module Description  Dean Camera committed Jul 14, 2009 51 52  * 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.  Dean Camera committed Apr 16, 2009 53  *  Dean Camera committed Apr 17, 2009 54 55 56  * 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. *  Dean Camera committed May 05, 2009 57 58 59 60 61 62 63 64  * \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. *  Dean Camera committed Apr 16, 2009 65 66 67  * @{ */  Dean Camera committed Feb 23, 2009 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 #ifndef __LEDS_H__ #define __LEDS_H__ /* Macros: */ #if !defined(__DOXYGEN__) #define INCLUDE_FROM_LEDS_H #endif /* Includes: */ #include "../../Common/Common.h" #if !defined(BOARD) #error BOARD must be set in makefile to a value specified in BoardTypes.h. #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"  Dean Camera committed Oct 02, 2009 91  #elif (BOARD == BOARD_XPLAIN)  Dean Camera committed Oct 03, 2009 92  #include "XPLAIN/LEDs.h"  Dean Camera committed Dec 03, 2009 93 94  #elif (BOARD == BOARD_XPLAIN_REV1) #include "XPLAIN/LEDs.h"  Dean Camera committed Sep 17, 2009 95 96  #elif (BOARD == BOARD_BUMBLEB) #include "BUMBLEB/LEDs.h"  Dean Camera committed Oct 02, 2009 97 98  #elif (BOARD == BOARD_USER) #include "Board/LEDs.h"  Dean Camera committed Feb 23, 2009 99 100  #endif  Dean Camera committed May 05, 2009 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116  #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  Dean Camera committed Apr 01, 2009 117  /* Pseudo-Functions for Doxygen: */  Dean Camera committed Feb 23, 2009 118 119 120 121 122 123 124 125  #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. *  Dean Camera committed Jun 28, 2009 126  * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)  Dean Camera committed Feb 23, 2009 127 128 129 130 131  */ static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask); /** Turns off the LEDs specified in the given LED mask. *  Dean Camera committed Jun 28, 2009 132  * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)  Dean Camera committed Feb 23, 2009 133 134 135 136 137 138  */ 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. *  Dean Camera committed Jun 28, 2009 139  * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)  Dean Camera committed Feb 23, 2009 140 141 142 143 144 145  */ 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. *  Dean Camera committed Jun 28, 2009 146 147  * \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  Dean Camera committed Feb 23, 2009 148 149  */ static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask);  Dean Camera committed Jul 24, 2009 150 151 152 153 154 155  /** 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);  Dean Camera committed Feb 23, 2009 156 157 158 159 160 161 162 163 164 165  /** 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  Dean Camera committed Apr 16, 2009 166 167  /** @} */