Blame view

src/lufa-LUFA-170418/LUFA/Drivers/Board/AVR8/USB2AX/LEDs.h 6.2 KB
ca85a266   gperson   le vrai commit, c...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
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
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
  /*
               LUFA Library
       Copyright (C) Dean Camera, 2017.
  
    dean [at] fourwalledcubicle [dot] com
             www.lufa-lib.org
  */
  
  /*
    Copyright 2017  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  
    Permission to use, copy, modify, distribute, and sell this
    software and its documentation for any purpose is hereby granted
    without fee, provided that the above copyright notice appear in
    all copies and that both that the copyright notice and this
    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
    software without specific, written prior permission.
  
    The author disclaims 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 Board specific LED driver header for the Xevelabs USB2AX.
   *  \copydetails Group_LEDs_USB2AX
   *
   *  \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.
   */
  
  /** \ingroup Group_LEDs
   *  \defgroup Group_LEDs_USB2AX_V31 USB2AX_V31
   *  \brief Board specific LED driver header for the Xevelabs USB2AX revision 3.1.
   *
   *  See \ref Group_LEDs_USB2AX for more details.
   */
  
  /** \ingroup Group_LEDs
   *  \defgroup Group_LEDs_USB2AX_V3 USB2AX_V3
   *  \brief Board specific LED driver header for the Xevelabs USB2AX revision 3.
   *
   *  See \ref Group_LEDs_USB2AX for more details.
   */
  
  /** \ingroup Group_LEDs
   *  \defgroup Group_LEDs_USB2AX USB2AX
   *  \brief Board specific LED driver header for the Xevelabs USB2AX revisions 1 and 2.
   *
   *  \note For version 3 USB2AX boards, compile with <code>BOARD = USB2AX_V3</code> and for version 3.1, with <code>BOARD = USB2AX_V31</code>.
   *
   *  Board specific LED driver header for the Xevelabs USB2AX (http://paranoidstudio.assembla.com/wiki/show/paranoidstudio/USB2AX).
   *
   *  <b>USB2AX</b>:
   *  <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>High</td><td>PORTC.6</td></tr>
   *  </table>
   *
   *  <b>USB2AX_V3</b>:
   *  <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>High</td><td>PORTD.1</td></tr>
   *  </table>
   *
   *  <b>USB2AX_V31</b>:
   *  <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>High</td><td>PORTD.5</td></tr>
   *    <tr><td>LEDS_LED2</td><td>Red</td><td>General Indicator</td><td>High</td><td>PORTD.6</td></tr>
   *  </table>
   *
   *  @{
   */
  
  #ifndef __LEDS_USB2AX_H__
  #define __LEDS_USB2AX_H__
  
  	/* Includes: */
  		#include "../../../../Common/Common.h"
  
  	/* 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
  
  	/* Private Interface - For use in library only: */
  	#if !defined(__DOXYGEN__)
  		/* Macros: */
  			#if (BOARD == BOARD_USB2AX_V31)
                  #define USB2AX_LEDS_LED1   (1 << 5)
                  #define USB2AX_LEDS_LED2   (1 << 6)
              #elif (BOARD == BOARD_USB2AX_V3)
  				#define USB2AX_LEDS_LED1   (1 << 1)
                  #define USB2AX_LEDS_LED2   0
  			#else
  				#define USB2AX_LEDS_LED1   (1 << 6)
                  #define USB2AX_LEDS_LED2   0
  			#endif
  	#endif
  
  	/* Public Interface - May be used in end-application: */
  		/* Macros: */
  			/** LED mask for the first LED on the board. */
  			#define LEDS_LED1        USB2AX_LEDS_LED1
  
  			/** LED mask for the second LED on the board. */
  			#define LEDS_LED2        USB2AX_LEDS_LED2
  
  			/** LED mask for all the LEDs on the board. */
  			#define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2)
  
  			/** LED mask for none of the board LEDs. */
  			#define LEDS_NO_LEDS     0
  
  		/* Inline Functions: */
  		#if !defined(__DOXYGEN__)
  			static inline void LEDs_Init(void)
  			{
  				#if (BOARD == BOARD_USB2AX)
  				DDRC  |=  LEDS_ALL_LEDS;
  				PORTC &= ~LEDS_ALL_LEDS;
  				#else
  				DDRD  |=  LEDS_ALL_LEDS;
  				PORTD &= ~LEDS_ALL_LEDS;
  				#endif
  			}
  
  			static inline void LEDs_Disable(void)
  			{
  				#if (BOARD == BOARD_USB2AX)
  				DDRC  &= ~LEDS_ALL_LEDS;
  				PORTC &= ~LEDS_ALL_LEDS;
  				#else
  				DDRD  &= ~LEDS_ALL_LEDS;
  				PORTD &= ~LEDS_ALL_LEDS;
  				#endif
  			}
  
  			static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
  			{
  				#if (BOARD == BOARD_USB2AX)
  				PORTC |= LEDMask;
  				#else
  				PORTD |= LEDMask;
  				#endif
  			}
  
  			static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
  			{
  				#if (BOARD == BOARD_USB2AX)
  				PORTC &= ~LEDMask;
  				#else
  				PORTD &= ~LEDMask;
  				#endif
  			}
  
  			static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
  			{
  				#if (BOARD == BOARD_USB2AX)
  				PORTC = ((PORTC & ~LEDS_ALL_LEDS) | LEDMask);
  				#else
  				PORTD = ((PORTD & ~LEDS_ALL_LEDS) | LEDMask);
  				#endif
  			}
  
  			static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
  			                                   const uint8_t ActiveMask)
  			{
  				#if (BOARD == BOARD_USB2AX)
  				PORTC = ((PORTC & ~LEDMask) | ActiveMask);
  				#else
  				PORTD = ((PORTD & ~LEDMask) | ActiveMask);
  				#endif
  			}
  
  			static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
  			{
  				#if (BOARD == BOARD_USB2AX)
  				PINC  = LEDMask;
  				#else
  				PIND  = LEDMask;
  				#endif
  			}
  
  			static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
  			static inline uint8_t LEDs_GetLEDs(void)
  			{
  				#if (BOARD == BOARD_USB2AX)
  				return (PORTC & LEDS_ALL_LEDS);
  				#else
  				return (PORTD & LEDS_ALL_LEDS);
  				#endif
  			}
  		#endif
  
  	/* Disable C linkage for C++ Compilers: */
  		#if defined(__cplusplus)
  			}
  		#endif
  
  #endif
  
  /** @} */