LUFA/Drivers/Board/LEDs.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief LED board hardware driver.
  33  *
  34  *  This file is the master dispatch header file for the board-specific LED driver, for boards containing user
  35  *  controllable LEDs.
  36  *
  37  *  User code should include this file, which will in turn include the correct LED driver header file for the
  38  *  currently selected board.
  39  *
  40  *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/LEDs.h file in the user project
  41  *  directory.
  42  *
  43  *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
  44  */
  45
  46 /** \ingroup Group_BoardDrivers
  47  *  \defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h
  48  *  \brief LED board hardware driver.
  49  *
  50  *  \section Sec_LEDs_Dependencies Module Source Dependencies
  51  *  The following files must be built with any user project that uses this module:
  52  *    - None
  53  *
  54  *  \section Sec_LEDs_ModDescription Module Description
  55  *  Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It
  56  *  provides an interface to configure, test and change the status of all the board LEDs.
  57  *
  58  *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/LEDs.h file in the user project
  59  *  directory. Otherwise, it will include the appropriate built-in board driver header file. If the BOARD value
  60  *  is set to \c BOARD_NONE, this driver is silently disabled.
  61  *
  62  *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
  63  *
  64  *  \note To make code as compatible as possible, it is assumed that all boards carry a minimum of four LEDs. If
  65  *        a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect.
  66  *        If other behavior is desired, either alias the remaining LED masks to existing LED masks via the -D
  67  *        switch in the project makefile, or alias them to nothing in the makefile to cause compilation errors when
  68  *        a non-existing LED is referenced in application code. Note that this means that it is possible to make
  69  *        compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers)
  70  *        which contains only stub functions and defines no LEDs.
  71  *
  72  *  \section Sec_LEDs_ExampleUsage Example Usage
  73  *  The following snippet is an example of how this module may be used within a typical
  74  *  application.
  75  *
  76  *  \code
  77  *      // Initialize the board LED driver before first use
  78  *      LEDs_Init();
  79  *
  80  *      // Turn on each of the four LEDs in turn
  81  *      LEDs_SetAllLEDs(LEDS_LED1);
  82  *      Delay_MS(500);
  83  *      LEDs_SetAllLEDs(LEDS_LED2);
  84  *      Delay_MS(500);
  85  *      LEDs_SetAllLEDs(LEDS_LED3);
  86  *      Delay_MS(500);
  87  *      LEDs_SetAllLEDs(LEDS_LED4);
  88  *      Delay_MS(500);
  89  *
  90  *      // Turn on all LEDs
  91  *      LEDs_SetAllLEDs(LEDS_ALL_LEDS);
  92  *      Delay_MS(1000);
  93  *
  94  *      // Turn on LED 1, turn off LED 2, leaving LEDs 3 and 4 in their current state
  95  *      LEDs_ChangeLEDs((LEDS_LED1 | LEDS_LED2), LEDS_LED1);
  96  *  \endcode
  97  *
  98  *  @{
  99  */
 100
 101 #ifndef __LEDS_H__
 102 #define __LEDS_H__
 103
 104         /* Macros: */
 105                 #define __INCLUDE_FROM_LEDS_H
 106
 107         /* Includes: */
 108                 #include "../../Common/Common.h"
 109
 110                 #if (BOARD == BOARD_NONE)
 111                         static inline void LEDs_Init(void) {};
 112                         static inline void LEDs_Disable(void) {};
 113                         static inline void LEDs_TurnOnLEDs(const uint_reg_t LEDMask) {};
 114                         static inline void LEDs_TurnOffLEDs(const uint_reg_t LEDMask) {};
 115                         static inline void LEDs_SetAllLEDs(const uint_reg_t LEDMask) {};
 116                         static inline void LEDs_ChangeLEDs(const uint_reg_t LEDMask, const uint_reg_t ActiveMask) {};
 117                         static inline void LEDs_ToggleLEDs(const uint_reg_t LEDMask) {};
 118                         static inline uint_reg_t LEDs_GetLEDs(void) { return 0; }
 119                 #elif (BOARD == BOARD_USBKEY)
 120                         #include "AVR8/USBKEY/LEDs.h"
 121                 #elif (BOARD == BOARD_STK525)
 122                         #include "AVR8/STK525/LEDs.h"
 123                 #elif (BOARD == BOARD_STK526)
 124                         #include "AVR8/STK526/LEDs.h"
 125                 #elif (BOARD == BOARD_RZUSBSTICK)
 126                         #include "AVR8/RZUSBSTICK/LEDs.h"
 127                 #elif (BOARD == BOARD_ATAVRUSBRF01)
 128                         #include "AVR8/ATAVRUSBRF01/LEDs.h"
 129                 #elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
 130                         #include "AVR8/XPLAIN/LEDs.h"
 131                 #elif (BOARD == BOARD_BUMBLEB)
 132                         #include "AVR8/BUMBLEB/LEDs.h"
 133                 #elif (BOARD == BOARD_EVK527)
 134                         #include "AVR8/EVK527/LEDs.h"
 135                 #elif ((BOARD == BOARD_TEENSY) || (BOARD == BOARD_TEENSY2))
 136                         #include "AVR8/TEENSY/LEDs.h"
 137                 #elif (BOARD == BOARD_USBTINYMKII)
 138                         #include "AVR8/USBTINYMKII/LEDs.h"
 139                 #elif (BOARD == BOARD_BENITO)
 140                         #include "AVR8/BENITO/LEDs.h"
 141                 #elif (BOARD == BOARD_JMDBU2)
 142                         #include "AVR8/JMDBU2/LEDs.h"
 143                 #elif (BOARD == BOARD_OLIMEX162)
 144                         #include "AVR8/OLIMEX162/LEDs.h"
 145                 #elif (BOARD == BOARD_USBFOO)
 146                         #include "AVR8/USBFOO/LEDs.h"
 147                 #elif (BOARD == BOARD_UDIP)
 148                         #include "AVR8/UDIP/LEDs.h"
 149                 #elif (BOARD == BOARD_BUI)
 150                         #include "AVR8/BUI/LEDs.h"
 151                 #elif (BOARD == BOARD_UNO)
 152                         #include "AVR8/UNO/LEDs.h"
 153                 #elif (BOARD == BOARD_CULV3)
 154                         #include "AVR8/CULV3/LEDs.h"
 155                 #elif (BOARD == BOARD_BLACKCAT)
 156                         #include "AVR8/BLACKCAT/LEDs.h"
 157                 #elif (BOARD == BOARD_MAXIMUS)
 158                         #include "AVR8/MAXIMUS/LEDs.h"
 159                 #elif (BOARD == BOARD_MINIMUS)
 160                         #include "AVR8/MINIMUS/LEDs.h"
 161                 #elif (BOARD == BOARD_ADAFRUITU4)
 162                         #include "AVR8/ADAFRUITU4/LEDs.h"
 163                 #elif (BOARD == BOARD_MICROSIN162)
 164                         #include "AVR8/MICROSIN162/LEDs.h"
 165                 #elif (BOARD == BOARD_SPARKFUN8U2)
 166                         #include "AVR8/SPARKFUN8U2/LEDs.h"
 167                 #elif (BOARD == BOARD_EVK1101)
 168                         #include "UC3/EVK1101/LEDs.h"
 169                 #elif (BOARD == BOARD_TUL)
 170                         #include "AVR8/TUL/LEDs.h"
 171                 #elif (BOARD == BOARD_EVK1100)
 172                         #include "UC3/EVK1100/LEDs.h"
 173                 #elif (BOARD == BOARD_EVK1104)
 174                         #include "UC3/EVK1104/LEDs.h"
 175                 #elif (BOARD == BOARD_A3BU_XPLAINED)
 176                         #include "XMEGA/A3BU_XPLAINED/LEDs.h"
 177                 #elif ((BOARD == BOARD_USB2AX) || (BOARD == BOARD_USB2AX_V3) || (BOARD == BOARD_USB2AX_V31))
 178                         #include "AVR8/USB2AX/LEDs.h"
 179                 #elif ((BOARD == BOARD_MICROPENDOUS_REV1) || (BOARD == BOARD_MICROPENDOUS_REV2) || \
 180                        (BOARD == BOARD_MICROPENDOUS_32U2))
 181                         #include "AVR8/MICROPENDOUS/LEDs.h"
 182                 #elif (BOARD == BOARD_B1_XPLAINED)
 183                         #include "XMEGA/B1_XPLAINED/LEDs.h"
 184                 #elif (BOARD == BOARD_MULTIO)
 185                         #include "AVR8/MULTIO/LEDs.h"
 186                 #elif (BOARD == BOARD_BIGMULTIO)
 187                         #include "AVR8/BIGMULTIO/LEDs.h"
 188                 #elif (BOARD == BOARD_DUCE)
 189                         #include "AVR8/DUCE/LEDs.h"
 190                 #elif (BOARD == BOARD_OLIMEX32U4)
 191                         #include "AVR8/OLIMEX32U4/LEDs.h"
 192                 #elif (BOARD == BOARD_OLIMEXT32U4)
 193                         #include "AVR8/OLIMEXT32U4/LEDs.h"
 194                 #elif (BOARD == BOARD_OLIMEXISPMK2)
 195                         #include "AVR8/OLIMEXISPMK2/LEDs.h"
 196                 #elif (BOARD == BOARD_LEONARDO)
 197                         #include "AVR8/LEONARDO/LEDs.h"
 198                 #elif (BOARD == BOARD_UC3A3_XPLAINED)
 199                         #include "UC3/UC3A3_XPLAINED/LEDs.h"
 200                 #elif (BOARD == BOARD_STANGE_ISP)
 201                         #include "AVR8/STANGE_ISP/LEDs.h"
 202                 #elif (BOARD == BOARD_C3_XPLAINED)
 203                         #include "XMEGA/C3_XPLAINED/LEDs.h"
 204                 #elif (BOARD == BOARD_U2S)
 205                         #include "AVR8/U2S/LEDs.h"
 206                 #else
 207                         #include "Board/LEDs.h"
 208                 #endif
 209
 210         /* Preprocessor Checks: */
 211                 #if !defined(__DOXYGEN__)
 212                         #if !defined(LEDS_NO_LEDS)
 213                                 #define LEDS_NO_LEDS   0
 214                         #endif
 215
 216                         #if !defined(LEDS_ALL_LEDS)
 217                                 #define LEDS_ALL_LEDS  (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
 218                         #endif
 219
 220                         #if !defined(LEDS_LED1)
 221                                 #define LEDS_LED1      0
 222                         #endif
 223
 224                         #if !defined(LEDS_LED2)
 225                                 #define LEDS_LED2      0
 226                         #endif
 227
 228                         #if !defined(LEDS_LED3)
 229                                 #define LEDS_LED3      0
 230                         #endif
 231
 232                         #if !defined(LEDS_LED4)
 233                                 #define LEDS_LED4      0
 234                         #endif
 235                 #endif
 236
 237         /* Pseudo-Functions for Doxygen: */
 238         #if defined(__DOXYGEN__)
 239                 /** Initializes the board LED driver so that the LEDs can be controlled. This sets the appropriate port
 240                  *  I/O pins as outputs, and sets the LEDs to default to off.
 241                  *
 242                  *  This must be called before any LED driver functions are used.
 243                  */
 244                 static inline void LEDs_Init(void);
 245
 246                 /** Disables the board LED driver, releasing the I/O pins back to their default high-impedance input mode. */
 247                 static inline void LEDs_Disable(void);
 248
 249                 /** Turns on the LEDs specified in the given LED mask.
 250                  *
 251                  *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
 252                  */
 253                 static inline void LEDs_TurnOnLEDs(const uint_reg_t LEDMask);
 254
 255                 /** Turns off the LEDs specified in the given LED mask.
 256                  *
 257                  *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
 258                  */
 259                 static inline void LEDs_TurnOffLEDs(const uint_reg_t LEDMask);
 260
 261                 /** Turns off all LEDs not specified in the given LED mask, and turns on all the LEDs in the given LED
 262                  *  mask.
 263                  *
 264                  *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
 265                  */
 266                 static inline void LEDs_SetAllLEDs(const uint_reg_t LEDMask);
 267
 268                 /** Turns off all LEDs in the LED mask that are not set in the active mask, and turns on all the LEDs
 269                  *  specified in both the LED and active masks.
 270                  *
 271                  *  \param[in] LEDMask     Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
 272                  *  \param[in] ActiveMask  Mask of whether the LEDs in the LED mask should be turned on or off.
 273                  */
 274                 static inline void LEDs_ChangeLEDs(const uint_reg_t LEDMask,
 275                                                    const uint_reg_t ActiveMask);
 276
 277                 /** Toggles all LEDs in the LED mask, leaving all others in their current states.
 278                  *
 279                  *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
 280                  */
 281                 static inline void LEDs_ToggleLEDs(const uint_reg_t LEDMask);
 282
 283                 /** Returns the status of all the board LEDs; set LED masks in the return value indicate that the
 284                  *  corresponding LED is on.
 285                  *
 286                  *  \return Mask of \c LEDS_LED* constants indicating which of the board LEDs are currently turned on.
 287                  */
 288                 static inline uint_reg_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 289         #endif
 290
 291 #endif
 292
 293 /** @} */
 294