LEDs.h 10.3 KB
Newer Older
1
2
/*
             LUFA Library
3
     Copyright (C) Dean Camera, 2012.
4

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

/*
10
  Copyright 2012  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
17
18
  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
19
20
21
22
23
24
25
26
27
28
29
30
31
  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
32
 *  \brief LED board hardware driver.
33
34
35
36
37
38
39
 *
 *  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.
 *
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
51
52
53
 *
 *  \section Sec_Dependencies Module Source Dependencies
 *  The following files must be built with any user project that uses this module:
 *    - None
 *
54
 *  \section Sec_ModDescription Module Description
55
56
57
 *  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.
 *
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
65
 *  \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.
66
 *        If other behavior is desired, either alias the remaining LED masks to existing LED masks via the -D
67
68
69
70
71
 *        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.
 *
72
73
74
75
 *  \section Sec_ExampleUsage Example Usage
 *  The following snippet is an example of how this module may be used within a typical
 *  application.
 *
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
91
 *      // Turn on all LEDs
 *      LEDs_SetAllLEDs(LEDS_ALL_LEDS);
92
 *      Delay_MS(1000);
93
 *      
94
95
96
97
 *      // Turn on LED 1, turn off LED 2, leaving LEDs 3 and 4 in their current state
 *      LEDs_ChangeLEDs((LEDS_LED1 | LEDS_LED2), LEDS_LED1);
 *  \endcode
 *
98
99
100
101
102
103
104
105
 *  @{
 */

#ifndef __LEDS_H__
#define __LEDS_H__

	/* Macros: */
		#define __INCLUDE_FROM_LEDS_H
106

107
	/* Includes: */
108
		#include "../../Common/Common.h"
109

110
111
		#if (BOARD == BOARD_NONE)
			static inline void LEDs_Init(void) {};
112
			static inline void LEDs_Disable(void) {};
113
114
115
116
117
118
			static inline void LEDs_TurnOnLEDs(const uint_reg_t LEDMask) {};
			static inline void LEDs_TurnOffLEDs(const uint_reg_t LEDMask) {};
			static inline void LEDs_SetAllLEDs(const uint_reg_t LEDMask) {};
			static inline void LEDs_ChangeLEDs(const uint_reg_t LEDMask, const uint_reg_t ActiveMask) {};
			static inline void LEDs_ToggleLEDs(const uint_reg_t LEDMask) {};
			static inline uint_reg_t LEDs_GetLEDs(void) { return 0; }
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
		#elif (BOARD == BOARD_USBKEY)
			#include "AVR8/USBKEY/LEDs.h"
		#elif (BOARD == BOARD_STK525)
			#include "AVR8/STK525/LEDs.h"
		#elif (BOARD == BOARD_STK526)
			#include "AVR8/STK526/LEDs.h"
		#elif (BOARD == BOARD_RZUSBSTICK)
			#include "AVR8/RZUSBSTICK/LEDs.h"
		#elif (BOARD == BOARD_ATAVRUSBRF01)
			#include "AVR8/ATAVRUSBRF01/LEDs.h"
		#elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
			#include "AVR8/XPLAIN/LEDs.h"
		#elif (BOARD == BOARD_BUMBLEB)
			#include "AVR8/BUMBLEB/LEDs.h"
		#elif (BOARD == BOARD_EVK527)
			#include "AVR8/EVK527/LEDs.h"
135
		#elif ((BOARD == BOARD_TEENSY) || (BOARD == BOARD_TEENSY2))
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
			#include "AVR8/TEENSY/LEDs.h"
		#elif (BOARD == BOARD_USBTINYMKII)
			#include "AVR8/USBTINYMKII/LEDs.h"
		#elif (BOARD == BOARD_BENITO)
			#include "AVR8/BENITO/LEDs.h"
		#elif (BOARD == BOARD_JMDBU2)
			#include "AVR8/JMDBU2/LEDs.h"
		#elif (BOARD == BOARD_OLIMEX162)
			#include "AVR8/OLIMEX162/LEDs.h"
		#elif (BOARD == BOARD_USBFOO)
			#include "AVR8/USBFOO/LEDs.h"
		#elif (BOARD == BOARD_UDIP)
			#include "AVR8/UDIP/LEDs.h"
		#elif (BOARD == BOARD_BUI)
			#include "AVR8/BUI/LEDs.h"
		#elif (BOARD == BOARD_UNO)
			#include "AVR8/UNO/LEDs.h"
		#elif (BOARD == BOARD_CULV3)
			#include "AVR8/CULV3/LEDs.h"
		#elif (BOARD == BOARD_BLACKCAT)
			#include "AVR8/BLACKCAT/LEDs.h"
		#elif (BOARD == BOARD_MAXIMUS)
			#include "AVR8/MAXIMUS/LEDs.h"
		#elif (BOARD == BOARD_MINIMUS)
			#include "AVR8/MINIMUS/LEDs.h"
		#elif (BOARD == BOARD_ADAFRUITU4)
			#include "AVR8/ADAFRUITU4/LEDs.h"
		#elif (BOARD == BOARD_MICROSIN162)
			#include "AVR8/MICROSIN162/LEDs.h"
		#elif (BOARD == BOARD_SPARKFUN8U2)
			#include "AVR8/SPARKFUN8U2/LEDs.h"
		#elif (BOARD == BOARD_EVK1101)
			#include "UC3/EVK1101/LEDs.h"
		#elif (BOARD == BOARD_TUL)
170
			#include "AVR8/TUL/LEDs.h"
171
172
173
174
		#elif (BOARD == BOARD_EVK1100)
			#include "UC3/EVK1100/LEDs.h"
		#elif (BOARD == BOARD_EVK1104)
			#include "UC3/EVK1104/LEDs.h"
175
		#elif (BOARD == BOARD_A3BU_XPLAINED)
176
			#include "XMEGA/A3BU_XPLAINED/LEDs.h"
177
178
		#elif ((BOARD == BOARD_USB2AX) || (BOARD == BOARD_USB2AX_V3))
			#include "AVR8/USB2AX/LEDs.h"
179
180
		#elif ((BOARD == BOARD_MICROPENDOUS_REV1) || (BOARD == BOARD_MICROPENDOUS_REV2) || \
		       (BOARD == BOARD_MICROPENDOUS_32U2))
181
			#include "AVR8/MICROPENDOUS/LEDs.h"
182
183
		#elif (BOARD == BOARD_B1_XPLAINED)
			#include "XMEGA/B1_XPLAINED/LEDs.h"
184
185
186
187
		#elif (BOARD == BOARD_MULTIO)
			#include "AVR8/MULTIO/LEDs.h"
		#elif (BOARD == BOARD_BIGMULTIO)
			#include "AVR8/BIGMULTIO/LEDs.h"
188
189
		#elif (BOARD == BOARD_DUCE)
			#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
199
		#elif (BOARD == BOARD_UC3A3_XPLAINED)
			#include "UC3/UC3A3_XPLAINED/LEDs.h"
200
201
202
		#else
			#include "Board/LEDs.h"
		#endif
203

204
	/* Preprocessor Checks: */
205
206
207
208
		#if !defined(__DOXYGEN__)
			#if !defined(LEDS_LED1)
				#define LEDS_LED1      0
			#endif
209

210
211
212
			#if !defined(LEDS_LED2)
				#define LEDS_LED2      0
			#endif
213

214
215
216
			#if !defined(LEDS_LED3)
				#define LEDS_LED3      0
			#endif
217

218
219
220
			#if !defined(LEDS_LED4)
				#define LEDS_LED4      0
			#endif
221
		#endif
222

223
224
	/* Pseudo-Functions for Doxygen: */
	#if defined(__DOXYGEN__)
225
		/** Initializes the board LED driver so that the LEDs can be controlled. This sets the appropriate port
226
		 *  I/O pins as outputs, and sets the LEDs to default to off.
227
228
		 *
		 *  This must be called before any LED driver functions are used.
229
230
231
		 */
		static inline void LEDs_Init(void);

232
		/** Disables the board LED driver, releasing the I/O pins back to their default high-impedance input mode. */
233
234
		static inline void LEDs_Disable(void);

235
236
		/** Turns on the LEDs specified in the given LED mask.
		 *
237
		 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
238
		 */
239
		static inline void LEDs_TurnOnLEDs(const uint_reg_t LEDMask);
240
241
242

		/** Turns off the LEDs specified in the given LED mask.
		 *
243
		 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
244
		 */
245
		static inline void LEDs_TurnOffLEDs(const uint_reg_t LEDMask);
246
247
248
249

		/** Turns off all LEDs not specified in the given LED mask, and turns on all the LEDs in the given LED
		 *  mask.
		 *
250
		 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
251
		 */
252
		static inline void LEDs_SetAllLEDs(const uint_reg_t LEDMask);
253
254
255
256

		/** 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.
		 *
257
258
		 *  \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.
259
		 */
260
261
		static inline void LEDs_ChangeLEDs(const uint_reg_t LEDMask,
		                                   const uint_reg_t ActiveMask);
262

263
264
		/** Toggles all LEDs in the LED mask, leaving all others in their current states.
		 *
265
		 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
266
		 */
267
		static inline void LEDs_ToggleLEDs(const uint_reg_t LEDMask);
268
269
270
271

		/** Returns the status of all the board LEDs; set LED masks in the return value indicate that the
		 *  corresponding LED is on.
		 *
272
		 *  \return Mask of \c LEDS_LED* constants indicating which of the board LEDs are currently turned on.
273
		 */
274
		static inline uint_reg_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
275
276
277
278
279
	#endif

#endif

/** @} */
280