LEDs.h 3.88 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 Board specific LED driver header for the original Atmel XPLAIN.
33
 *  \copydetails Group_LEDs_XPLAIN
34
35
36
37
 *
 *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
 *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
 */
38

39
40
41
42
43
44
/** \ingroup Group_LEDs
 *  \defgroup Group_LEDs_XPLAIN_REV1 XPLAIN_REV1
 *  \brief Board specific LED driver header for the original Atmel XPLAIN, revision 1.
 *
 *  See \ref Group_LEDs_XPLAIN for more details.
 */
45
46

/** \ingroup Group_LEDs
47
 *  \defgroup Group_LEDs_XPLAIN XPLAIN
48
 *  \brief Board specific LED driver header for the original Atmel XPLAIN.
49
 *
50
 *  Board specific LED driver header for the Atmel XPLAIN.
51
 *
52
53
54
55
56
 *  <table>
 *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
 *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>Low</td><td>PORTB.6</td></tr>
 *  </table>
 *
57
58
 *  @{
 */
59

60
61
62
63
#ifndef __LEDS_XPLAIN_H__
#define __LEDS_XPLAIN_H__

	/* Includes: */
64
		#include "../../../../Common/Common.h"
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_LEDS_H)
			#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
		#endif

	/* Public Interface - May be used in end-application: */
		/* Macros: */
			/** LED mask for the first LED on the board. */
			#define LEDS_LED1        (1 << 6)

			/** LED mask for all the LEDs on the board. */
			#define LEDS_ALL_LEDS    LEDS_LED1

84
			/** LED mask for none of the board LEDs. */
85
86
87
88
89
90
91
92
93
			#define LEDS_NO_LEDS     0

		/* Inline Functions: */
		#if !defined(__DOXYGEN__)
			static inline void LEDs_Init(void)
			{
				DDRB  |= LEDS_ALL_LEDS;
				PORTB |= LEDS_ALL_LEDS;
			}
94

95
96
97
98
99
100
			static inline void LEDs_Disable(void)
			{
				DDRB  &= ~LEDS_ALL_LEDS;
				PORTB &= ~LEDS_ALL_LEDS;
			}

101
102
103
104
105
106
107
108
109
110
111
112
113
114
			static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
			{
				PORTB &= ~LEDMask;
			}

			static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
			{
				PORTB |= LEDMask;
			}

			static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
			{
				PORTB = ((PORTB | LEDS_ALL_LEDS) & ~LEDMask);
			}
115

116
117
			static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
			                                   const uint8_t ActiveMask)
118
			{
119
				PORTB = ((PORTB | LEDMask) & ~ActiveMask);
120
			}
121

122
123
			static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
			{
124
				PINB  = LEDMask;
125
			}
126

127
128
129
130
131
132
			static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
			static inline uint8_t LEDs_GetLEDs(void)
			{
				return (~PORTB & LEDS_ALL_LEDS);
			}
		#endif
133

134
135
136
137
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
138

139
140
141
#endif

/** @} */
142