summaryrefslogtreecommitdiff
path: root/lib/lufa/LUFA/Drivers/Board/AVR8/QMK/LEDs.h
blob: be66b9ed20509a9ba13e1fa6f5c38c31e624ca1b (plain)
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
/*
Copyright 2017 Jack Humbert

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/** \file
 *  \brief General driver header for QMK-powered keyboards.
 *  \copydetails Group_LEDs_QMK
 *
 *  \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_QMK QMK
 *  \brief General driver header for QMK-powered keyboards.
 *
 *  General driver header for QMK-powered keyboards (http://qmk.fm).
 *
 *  <b>QMK</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>PORT(QMK_LED).6</td></tr>
 *  </table>
 *
 *  @{
 */

#ifndef __LEDS_QMK_H__
#define __LEDS_QMK_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

        #define B0 0x30
        #define B1 0x31
        #define B2 0x32
        #define B3 0x33
        #define B4 0x34
        #define B5 0x35
        #define B6 0x36
        #define B7 0x37
        #define C0 0x60
        #define C1 0x61
        #define C2 0x62
        #define C3 0x63
        #define C4 0x64
        #define C5 0x65
        #define C6 0x66
        #define C7 0x67
        #define D0 0x90
        #define D1 0x91
        #define D2 0x92
        #define D3 0x93
        #define D4 0x94
        #define D5 0x95
        #define D6 0x96
        #define D7 0x97
        #define E0 0xC0
        #define E1 0xC1
        #define E2 0xC2
        #define E3 0xC3
        #define E4 0xC4
        #define E5 0xC5
        #define E6 0xC6
        #define E7 0xC7
        #define F0 0xF0
        #define F1 0xF1
        #define F2 0xF2
        #define F3 0xF3
        #define F4 0xF4
        #define F5 0xF5
        #define F6 0xF6
        #define F7 0xF7
        #define A0 0x00
        #define A1 0x01
        #define A2 0x02
        #define A3 0x03
        #define A4 0x04
        #define A5 0x05
        #define A6 0x06
        #define A7 0x07

        #include "Keyboard.h"

        #ifndef QMK_ESC_INPUT
            #define QMK_ESC_INPUT F1
        #endif
        #ifndef QMK_ESC_OUTPUT
            #define QMK_ESC_OUTPUT D5
        #endif
        #ifndef QMK_LED
            #define QMK_LED     E6
        #endif
        #ifndef QMK_SPEAKER
            #define QMK_SPEAKER C6
        #endif

        #define DDR(pin) _SFR_IO8(((pin) >> 4) + 1)
        #define PORT(pin) _SFR_IO8(((pin) >> 4) + 2)
        #define PIN(pin) _SFR_IO8((pin) >> 4)
        #define NUM(pin) _BV((pin) & 0xF)

    /* Public Interface - May be used in end-application: */
        /* Macros: */
            /** LED mask for the first LED on the board. */
            #define LEDS_LED1        NUM(QMK_LED)
            #define LEDS_LED2        NUM(QMK_SPEAKER)

            /** 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)
            {
                DDR(QMK_LED)  |= LEDS_LED1;
                PORT(QMK_LED) |= LEDS_LED1;

                DDR(QMK_SPEAKER)  |= LEDS_LED2;
                PORT(QMK_SPEAKER) |= LEDS_LED2;
            }

            static inline void LEDs_Disable(void)
            {
                DDR(QMK_LED)  &= ~LEDS_LED1;
                PORT(QMK_LED) &= ~LEDS_LED2;

                DDR(QMK_SPEAKER)  &= ~LEDS_LED1;
                PORT(QMK_SPEAKER) &= ~LEDS_LED2;
            }

            static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
            {
                PORT(QMK_LED) &= (LEDS_LED1 & ~LEDMask);
                PORT(QMK_SPEAKER) &= (LEDS_LED2 & ~LEDMask);
            }

            static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
            {
                PORT(QMK_LED) |=  (LEDS_LED1 & LEDMask);
                PORT(QMK_SPEAKER) |=  (LEDS_LED2 & LEDMask);
            }

            static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
            {
                PORT(QMK_LED) = ((PORT(QMK_LED) | LEDS_LED1) & ~LEDMask);
                PORT(QMK_SPEAKER) = ((PORT(QMK_SPEAKER) | LEDS_LED2) & ~LEDMask);
            }

            static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
                                               const uint8_t ActiveMask)
            {
                PORT(QMK_LED) = ((PORT(QMK_LED) | (LEDS_LED1 & LEDMask)) & ~ActiveMask);
                PORT(QMK_SPEAKER) = ((PORT(QMK_SPEAKER) | (LEDS_LED1 & LEDMask)) & ~ActiveMask);
            }

            static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
            {
                PIN(QMK_LED)  = (LEDS_LED1 & LEDMask);
                PIN(QMK_SPEAKER)  = (LEDS_LED2 & LEDMask);
            }

            static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
            static inline uint8_t LEDs_GetLEDs(void)
            {
                return (~PORT(QMK_LED) & LEDS_LED1) | (~(PORT(QMK_SPEAKER) & LEDS_LED2));
            }
        #endif

    /* Disable C linkage for C++ Compilers: */
        #if defined(__cplusplus)
            }
        #endif

#endif

/** @} */