Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / Board / LEDs.h @ 978b99e5

History | View | Annotate | Download (9.27 KB)

1
/*
2
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
*/
8

    
9
/*
10
  Copyright 2011  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 disclaim 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_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_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 behaviour 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_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_LED1); 
84
 *      Delay_MS(500);
85
 *      LEDs_SetAllLEDs(LEDS_LED1); 
86
 *      Delay_MS(500);
87
 *      LEDs_SetAllLEDs(LEDS_LED1); 
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_TurnOnLEDs(const uint_reg_t LEDMask) {};
113
                        static inline void LEDs_TurnOffLEDs(const uint_reg_t LEDMask) {};
114
                        static inline void LEDs_SetAllLEDs(const uint_reg_t LEDMask) {};
115
                        static inline void LEDs_ChangeLEDs(const uint_reg_t LEDMask, const uint_reg_t ActiveMask) {};
116
                        static inline void LEDs_ToggleLEDs(const uint_reg_t LEDMask) {};
117
                        static inline uint_reg_t LEDs_GetLEDs(void) { return 0; }
118
                #elif (BOARD == BOARD_USBKEY)
119
                        #include "AVR8/USBKEY/LEDs.h"
120
                #elif (BOARD == BOARD_STK525)
121
                        #include "AVR8/STK525/LEDs.h"
122
                #elif (BOARD == BOARD_STK526)
123
                        #include "AVR8/STK526/LEDs.h"
124
                #elif (BOARD == BOARD_RZUSBSTICK)
125
                        #include "AVR8/RZUSBSTICK/LEDs.h"
126
                #elif (BOARD == BOARD_ATAVRUSBRF01)
127
                        #include "AVR8/ATAVRUSBRF01/LEDs.h"
128
                #elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
129
                        #include "AVR8/XPLAIN/LEDs.h"
130
                #elif (BOARD == BOARD_BUMBLEB)
131
                        #include "AVR8/BUMBLEB/LEDs.h"
132
                #elif (BOARD == BOARD_EVK527)
133
                        #include "AVR8/EVK527/LEDs.h"
134
                #elif (BOARD == BOARD_TEENSY)
135
                        #include "AVR8/TEENSY/LEDs.h"
136
                #elif (BOARD == BOARD_USBTINYMKII)
137
                        #include "AVR8/USBTINYMKII/LEDs.h"
138
                #elif (BOARD == BOARD_BENITO)
139
                        #include "AVR8/BENITO/LEDs.h"
140
                #elif (BOARD == BOARD_JMDBU2)
141
                        #include "AVR8/JMDBU2/LEDs.h"
142
                #elif (BOARD == BOARD_OLIMEX162)
143
                        #include "AVR8/OLIMEX162/LEDs.h"
144
                #elif (BOARD == BOARD_USBFOO)
145
                        #include "AVR8/USBFOO/LEDs.h"
146
                #elif (BOARD == BOARD_UDIP)
147
                        #include "AVR8/UDIP/LEDs.h"
148
                #elif (BOARD == BOARD_BUI)
149
                        #include "AVR8/BUI/LEDs.h"
150
                #elif (BOARD == BOARD_UNO)
151
                        #include "AVR8/UNO/LEDs.h"
152
                #elif (BOARD == BOARD_CULV3)
153
                        #include "AVR8/CULV3/LEDs.h"
154
                #elif (BOARD == BOARD_BLACKCAT)
155
                        #include "AVR8/BLACKCAT/LEDs.h"
156
                #elif (BOARD == BOARD_MAXIMUS)
157
                        #include "AVR8/MAXIMUS/LEDs.h"
158
                #elif (BOARD == BOARD_MINIMUS)
159
                        #include "AVR8/MINIMUS/LEDs.h"
160
                #elif (BOARD == BOARD_ADAFRUITU4)
161
                        #include "AVR8/ADAFRUITU4/LEDs.h"
162
                #elif (BOARD == BOARD_MICROSIN162)
163
                        #include "AVR8/MICROSIN162/LEDs.h"
164
                #elif (BOARD == BOARD_SPARKFUN8U2)
165
                        #include "AVR8/SPARKFUN8U2/LEDs.h"
166
                #elif (BOARD == BOARD_EVK1101)
167
                        #include "UC3/EVK1101/LEDs.h"
168
                #elif (BOARD == BOARD_TUL)
169
                        #include "AVR8/TUL/LEDs.h"        
170
                #elif (BOARD == BOARD_EVK1100)
171
                        #include "UC3/EVK1100/LEDs.h"
172
                #elif (BOARD == BOARD_EVK1104)
173
                        #include "UC3/EVK1104/LEDs.h"
174
                #else
175
                        #include "Board/LEDs.h"
176
                #endif
177

    
178
        /* Preprocessor Checks: */
179
                #if !defined(__DOXYGEN__)
180
                        #if !defined(LEDS_LED1)
181
                                #define LEDS_LED1      0
182
                        #endif
183

    
184
                        #if !defined(LEDS_LED2)
185
                                #define LEDS_LED2      0
186
                        #endif
187

    
188
                        #if !defined(LEDS_LED3)
189
                                #define LEDS_LED3      0
190
                        #endif
191

    
192
                        #if !defined(LEDS_LED4)
193
                                #define LEDS_LED4      0
194
                        #endif
195
                #endif
196

    
197
        /* Pseudo-Functions for Doxygen: */
198
        #if defined(__DOXYGEN__)
199
                /** Initializes the board LED driver so that the LEDs can be controlled. This sets the appropriate port
200
                 *  I/O pins as outputs, and sets the LEDs to default to off.
201
                 */
202
                static inline void LEDs_Init(void);
203

    
204
                /** Turns on the LEDs specified in the given LED mask.
205
                 *
206
                 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
207
                 */
208
                static inline void LEDs_TurnOnLEDs(const uint_reg_t LEDMask);
209

    
210
                /** Turns off the LEDs specified in the given LED mask.
211
                 *
212
                 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
213
                 */
214
                static inline void LEDs_TurnOffLEDs(const uint_reg_t LEDMask);
215

    
216
                /** Turns off all LEDs not specified in the given LED mask, and turns on all the LEDs in the given LED
217
                 *  mask.
218
                 *
219
                 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
220
                 */
221
                static inline void LEDs_SetAllLEDs(const uint_reg_t LEDMask);
222

    
223
                /** Turns off all LEDs in the LED mask that are not set in the active mask, and turns on all the LEDs
224
                 *  specified in both the LED and active masks.
225
                 *
226
                 *  \param[in] LEDMask     Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
227
                 *  \param[in] ActiveMask  Mask of whether the LEDs in the LED mask should be turned on or off.
228
                 */
229
                static inline void LEDs_ChangeLEDs(const uint_reg_t LEDMask,
230
                                                   const uint_reg_t ActiveMask);
231

    
232
                /** Toggles all LEDs in the LED mask, leaving all others in their current states.
233
                 *
234
                 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
235
                 */
236
                static inline void LEDs_ToggleLEDs(const uint_reg_t LEDMask);
237

    
238
                /** Returns the status of all the board LEDs; set LED masks in the return value indicate that the
239
                 *  corresponding LED is on.
240
                 *
241
                 *  \return Mask of the board LEDs which are currently turned on.
242
                 */
243
                static inline uint_reg_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
244
        #endif
245

    
246
#endif
247

    
248
/** @} */
249