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

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

/*
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)

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
32
33
34
35
36
37
38
39
40
41
  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.
42
43
 *
 *  For possible BOARD makefile values, see \ref Group_BoardTypes.
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 */

/** \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.
 *
61
62
 *  For possible 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
 *        a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect.
65
 *        If other behaviour is desired, either alias the remaining LED masks to existing LED masks via the -D
66
67
68
69
70
 *        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.
 *
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 *  <b>Example Usage:</b>
 *  \code
 *      // Initialise the board LED driver before first use
 *      LEDs_Init();
 *
 *      // Turn on each of the four LEDs in turn
 *      LEDs_SetAllLEDs(LEDS_LED1); 
 *      _delay_ms(500);
 *      LEDs_SetAllLEDs(LEDS_LED1); 
 *      _delay_ms(500);
 *      LEDs_SetAllLEDs(LEDS_LED1); 
 *      _delay_ms(500);
 *      LEDs_SetAllLEDs(LEDS_LED1); 
 *      _delay_ms(500);
 *
 *      // Turn on all LEDs
 *      LEDs_SetAllLEDs(LEDS_ALL_LEDS);
 *      _delay_ms(1000);
 *
 *      // 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
 *
94
95
96
97
98
99
100
101
102
103
104
 *  @{
 */

#ifndef __LEDS_H__
#define __LEDS_H__

	/* Macros: */
	#if !defined(__DOXYGEN__)
		#define __INCLUDE_FROM_LEDS_H
		#define INCLUDE_FROM_LEDS_H
	#endif
105

106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
	/* 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"
141
142
	#elif (BOARD == BOARD_OLIMEX162)
		#include "OLIMEX162/LEDs.h"
143
144
	#elif (BOARD == BOARD_USBFOO)
		#include "USBFOO/LEDs.h"
145
	#elif (BOARD == BOARD_UDIP)
146
		#include "UDIP/LEDs.h"
147
	#elif (BOARD == BOARD_BUI)
148
149
150
		#include "BUI/LEDs.h"
	#elif (BOARD == BOARD_UNO)
		#include "UNO/LEDs.h"
151
152
	#elif (BOARD == BOARD_CULV3)
		#include "CULV3/LEDs.h"
153
154
	#elif (BOARD == BOARD_BLACKCAT)
		#include "BLACKCAT/LEDs.h"
155
156
	#elif (BOARD == BOARD_MAXIMUS)
		#include "MAXIMUS/LEDs.h"
157
158
	#elif (BOARD == BOARD_MINIMUS)
		#include "MINIMUS/LEDs.h"
159
160
	#elif (BOARD == BOARD_ADAFRUITU4)
		#include "ADAFRUITU4/LEDs.h"
161
162
	#elif (BOARD == BOARD_MICROSIN162)
		#include "MICROSIN162/LEDs.h"
163
164
165
	#elif (BOARD == BOARD_USER)
		#include "Board/LEDs.h"
	#endif
166

167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
	#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
182

183
184
	/* Pseudo-Functions for Doxygen: */
	#if defined(__DOXYGEN__)
185
		/** Initialises the board LED driver so that the LEDs can be controlled. This sets the appropriate port
186
187
188
189
190
191
		 *  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.
		 *
192
		 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
193
194
195
196
197
		 */
		static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask);

		/** Turns off the LEDs specified in the given LED mask.
		 *
198
		 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
199
200
201
202
203
204
		 */
		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.
		 *
205
		 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
206
207
208
209
210
211
		 */
		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.
		 *
212
213
		 *  \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.
214
		 */
215
216
		static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
		                                   const uint8_t ActiveMask);
217

218
219
		/** Toggles all LEDs in the LED mask, leaving all others in their current states.
		 *
220
		 *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
221
222
223
224
225
226
		 */
		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.
		 *
227
		 *  \return Mask of the board LEDs which are currently turned on.
228
229
230
231
232
233
234
		 */
		static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
	#endif

#endif

/** @} */
235