]> git.donarmstrong.com Git - qmk_firmware.git/blob - quantum/config_common.h
[Keyboard] [runner3680] Fix the number of keys (#6302)
[qmk_firmware.git] / quantum / config_common.h
1 /* Copyright 2015-2018 Jack Humbert
2  *
3  * This program is free software: you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License as published by
5  * the Free Software Foundation, either version 2 of the License, or
6  * (at your option) any later version.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
15  */
16
17 #pragma once
18
19 /* diode directions */
20 #define COL2ROW       0
21 #define ROW2COL       1
22 #define CUSTOM_MATRIX 2 /* Disables built-in matrix scanning code */
23
24 // useful for direct pin mapping
25 #define NO_PIN (~0)
26
27 #ifdef __AVR__
28     #ifndef __ASSEMBLER__
29       #include <avr/io.h>
30     #endif
31     #define PORT_SHIFTER 4 // this may be 4 for all AVR chips
32
33     // If you want to add more to this list, reference the PINx definitions in these header
34     // files: https://github.com/vancegroup-mirrors/avr-libc/tree/master/avr-libc/include/avr
35
36     #if defined(__AVR_ATmega32U4__) || defined(__AVR_ATmega16U4__)
37         #define ADDRESS_BASE 0x00
38         #define PINB_ADDRESS 0x3
39         #define PINC_ADDRESS 0x6
40         #define PIND_ADDRESS 0x9
41         #define PINE_ADDRESS 0xC
42         #define PINF_ADDRESS 0xF
43     #elif defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U2__)
44         #define ADDRESS_BASE 0x00
45         #define PINB_ADDRESS 0x3
46         #define PINC_ADDRESS 0x6
47         #define PIND_ADDRESS 0x9
48     #elif defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__)
49         #define ADDRESS_BASE 0x00
50         #define PINA_ADDRESS 0x0
51         #define PINB_ADDRESS 0x3
52         #define PINC_ADDRESS 0x6
53         #define PIND_ADDRESS 0x9
54         #define PINE_ADDRESS 0xC
55         #define PINF_ADDRESS 0xF
56     #elif defined(__AVR_ATmega32A__)
57         #define ADDRESS_BASE 0x10
58         #define PIND_ADDRESS 0x0
59         #define PINC_ADDRESS 0x3
60         #define PINB_ADDRESS 0x6
61         #define PINA_ADDRESS 0x9
62     #elif defined(__AVR_ATmega328P__)
63         #define ADDRESS_BASE 0x00
64         #define PINB_ADDRESS 0x3
65         #define PINC_ADDRESS 0x6
66         #define PIND_ADDRESS 0x9
67     #else
68         #error "Pins are not defined"
69     #endif
70
71     /* I/O pins */
72     #define PINDEF(port, pin) ((PIN##port##_ADDRESS << PORT_SHIFTER) | pin)
73
74     #ifdef PORTA
75         #define A0 PINDEF(A, 0)
76         #define A1 PINDEF(A, 1)
77         #define A2 PINDEF(A, 2)
78         #define A3 PINDEF(A, 3)
79         #define A4 PINDEF(A, 4)
80         #define A5 PINDEF(A, 5)
81         #define A6 PINDEF(A, 6)
82         #define A7 PINDEF(A, 7)
83     #endif
84     #ifdef PORTB
85         #define B0 PINDEF(B, 0)
86         #define B1 PINDEF(B, 1)
87         #define B2 PINDEF(B, 2)
88         #define B3 PINDEF(B, 3)
89         #define B4 PINDEF(B, 4)
90         #define B5 PINDEF(B, 5)
91         #define B6 PINDEF(B, 6)
92         #define B7 PINDEF(B, 7)
93     #endif
94     #ifdef PORTC
95         #define C0 PINDEF(C, 0)
96         #define C1 PINDEF(C, 1)
97         #define C2 PINDEF(C, 2)
98         #define C3 PINDEF(C, 3)
99         #define C4 PINDEF(C, 4)
100         #define C5 PINDEF(C, 5)
101         #define C6 PINDEF(C, 6)
102         #define C7 PINDEF(C, 7)
103     #endif
104     #ifdef PORTD
105         #define D0 PINDEF(D, 0)
106         #define D1 PINDEF(D, 1)
107         #define D2 PINDEF(D, 2)
108         #define D3 PINDEF(D, 3)
109         #define D4 PINDEF(D, 4)
110         #define D5 PINDEF(D, 5)
111         #define D6 PINDEF(D, 6)
112         #define D7 PINDEF(D, 7)
113     #endif
114     #ifdef PORTE
115         #define E0 PINDEF(E, 0)
116         #define E1 PINDEF(E, 1)
117         #define E2 PINDEF(E, 2)
118         #define E3 PINDEF(E, 3)
119         #define E4 PINDEF(E, 4)
120         #define E5 PINDEF(E, 5)
121         #define E6 PINDEF(E, 6)
122         #define E7 PINDEF(E, 7)
123     #endif
124     #ifdef PORTF
125         #define F0 PINDEF(F, 0)
126         #define F1 PINDEF(F, 1)
127         #define F2 PINDEF(F, 2)
128         #define F3 PINDEF(F, 3)
129         #define F4 PINDEF(F, 4)
130         #define F5 PINDEF(F, 5)
131         #define F6 PINDEF(F, 6)
132         #define F7 PINDEF(F, 7)
133     #endif
134
135 #elif defined(PROTOCOL_CHIBIOS)
136   // Defines mapping for Proton C replacement
137   #ifdef CONVERT_TO_PROTON_C
138     // Left side (front)
139     #define D3 PAL_LINE(GPIOA, 9)
140     #define D2 PAL_LINE(GPIOA, 10)
141     //      GND
142     //      GND
143     #define D1 PAL_LINE(GPIOB, 7)
144     #define D0 PAL_LINE(GPIOB, 6)
145     #define D4 PAL_LINE(GPIOB, 5)
146     #define C6 PAL_LINE(GPIOB, 4)
147     #define D7 PAL_LINE(GPIOB, 3)
148     #define E6 PAL_LINE(GPIOB, 2)
149     #define B4 PAL_LINE(GPIOB, 1)
150     #define B5 PAL_LINE(GPIOB, 0)
151
152     // Right side (front)
153     //      RAW
154     //      GND
155     //      RESET
156     //      VCC
157     #define F4 PAL_LINE(GPIOA, 2)
158     #define F5 PAL_LINE(GPIOA, 1)
159     #define F6 PAL_LINE(GPIOA, 0)
160     #define F7 PAL_LINE(GPIOB, 8)
161     #define B1 PAL_LINE(GPIOB, 13)
162     #define B3 PAL_LINE(GPIOB, 14)
163     #define B2 PAL_LINE(GPIOB, 15)
164     #define B6 PAL_LINE(GPIOB, 9)
165
166     // LEDs (only D5/C13 uses an actual LED)
167     #ifdef CONVERT_TO_PROTON_C_RXLED
168       #define D5 PAL_LINE(GPIOC, 13)
169       #define B0 PAL_LINE(GPIOC, 13)
170     #else
171       #define D5 PAL_LINE(GPIOC, 13)
172       #define B0 PAL_LINE(GPIOC, 14)
173     #endif
174   #else
175     #define A0  PAL_LINE(GPIOA, 0)
176     #define A1  PAL_LINE(GPIOA, 1)
177     #define A2  PAL_LINE(GPIOA, 2)
178     #define A3  PAL_LINE(GPIOA, 3)
179     #define A4  PAL_LINE(GPIOA, 4)
180     #define A5  PAL_LINE(GPIOA, 5)
181     #define A6  PAL_LINE(GPIOA, 6)
182     #define A7  PAL_LINE(GPIOA, 7)
183     #define A8  PAL_LINE(GPIOA, 8)
184     #define A9  PAL_LINE(GPIOA, 9)
185     #define A10 PAL_LINE(GPIOA, 10)
186     #define A11 PAL_LINE(GPIOA, 11)
187     #define A12 PAL_LINE(GPIOA, 12)
188     #define A13 PAL_LINE(GPIOA, 13)
189     #define A14 PAL_LINE(GPIOA, 14)
190     #define A15 PAL_LINE(GPIOA, 15)
191     #define B0  PAL_LINE(GPIOB, 0)
192     #define B1  PAL_LINE(GPIOB, 1)
193     #define B2  PAL_LINE(GPIOB, 2)
194     #define B3  PAL_LINE(GPIOB, 3)
195     #define B4  PAL_LINE(GPIOB, 4)
196     #define B5  PAL_LINE(GPIOB, 5)
197     #define B6  PAL_LINE(GPIOB, 6)
198     #define B7  PAL_LINE(GPIOB, 7)
199     #define B8  PAL_LINE(GPIOB, 8)
200     #define B9  PAL_LINE(GPIOB, 9)
201     #define B10 PAL_LINE(GPIOB, 10)
202     #define B11 PAL_LINE(GPIOB, 11)
203     #define B12 PAL_LINE(GPIOB, 12)
204     #define B13 PAL_LINE(GPIOB, 13)
205     #define B14 PAL_LINE(GPIOB, 14)
206     #define B15 PAL_LINE(GPIOB, 15)
207     #define B16 PAL_LINE(GPIOB, 16)
208     #define B17 PAL_LINE(GPIOB, 17)
209     #define C0  PAL_LINE(GPIOC, 0)
210     #define C1  PAL_LINE(GPIOC, 1)
211     #define C2  PAL_LINE(GPIOC, 2)
212     #define C3  PAL_LINE(GPIOC, 3)
213     #define C4  PAL_LINE(GPIOC, 4)
214     #define C5  PAL_LINE(GPIOC, 5)
215     #define C6  PAL_LINE(GPIOC, 6)
216     #define C7  PAL_LINE(GPIOC, 7)
217     #define C8  PAL_LINE(GPIOC, 8)
218     #define C9  PAL_LINE(GPIOC, 9)
219     #define C10 PAL_LINE(GPIOC, 10)
220     #define C11 PAL_LINE(GPIOC, 11)
221     #define C12 PAL_LINE(GPIOC, 12)
222     #define C13 PAL_LINE(GPIOC, 13)
223     #define C14 PAL_LINE(GPIOC, 14)
224     #define C15 PAL_LINE(GPIOC, 15)
225     #define D0  PAL_LINE(GPIOD, 0)
226     #define D1  PAL_LINE(GPIOD, 1)
227     #define D2  PAL_LINE(GPIOD, 2)
228     #define D3  PAL_LINE(GPIOD, 3)
229     #define D4  PAL_LINE(GPIOD, 4)
230     #define D5  PAL_LINE(GPIOD, 5)
231     #define D6  PAL_LINE(GPIOD, 6)
232     #define D7  PAL_LINE(GPIOD, 7)
233     #define D8  PAL_LINE(GPIOD, 8)
234     #define D9  PAL_LINE(GPIOD, 9)
235     #define D10 PAL_LINE(GPIOD, 10)
236     #define D11 PAL_LINE(GPIOD, 11)
237     #define D12 PAL_LINE(GPIOD, 12)
238     #define D13 PAL_LINE(GPIOD, 13)
239     #define D14 PAL_LINE(GPIOD, 14)
240     #define D15 PAL_LINE(GPIOD, 15)
241     #define E0  PAL_LINE(GPIOE, 0)
242     #define E1  PAL_LINE(GPIOE, 1)
243     #define E2  PAL_LINE(GPIOE, 2)
244     #define E3  PAL_LINE(GPIOE, 3)
245     #define E4  PAL_LINE(GPIOE, 4)
246     #define E5  PAL_LINE(GPIOE, 5)
247     #define E6  PAL_LINE(GPIOE, 6)
248     #define E7  PAL_LINE(GPIOE, 7)
249     #define E8  PAL_LINE(GPIOE, 8)
250     #define E9  PAL_LINE(GPIOE, 9)
251     #define E10 PAL_LINE(GPIOE, 10)
252     #define E11 PAL_LINE(GPIOE, 11)
253     #define E12 PAL_LINE(GPIOE, 12)
254     #define E13 PAL_LINE(GPIOE, 13)
255     #define E14 PAL_LINE(GPIOE, 14)
256     #define E15 PAL_LINE(GPIOE, 15)
257     #define F0  PAL_LINE(GPIOF, 0)
258     #define F1  PAL_LINE(GPIOF, 1)
259     #define F2  PAL_LINE(GPIOF, 2)
260     #define F3  PAL_LINE(GPIOF, 3)
261     #define F4  PAL_LINE(GPIOF, 4)
262     #define F5  PAL_LINE(GPIOF, 5)
263     #define F6  PAL_LINE(GPIOF, 6)
264     #define F7  PAL_LINE(GPIOF, 7)
265     #define F8  PAL_LINE(GPIOF, 8)
266     #define F9  PAL_LINE(GPIOF, 9)
267     #define F10 PAL_LINE(GPIOF, 10)
268     #define F11 PAL_LINE(GPIOF, 11)
269     #define F12 PAL_LINE(GPIOF, 12)
270     #define F13 PAL_LINE(GPIOF, 13)
271     #define F14 PAL_LINE(GPIOF, 14)
272     #define F15 PAL_LINE(GPIOF, 15)
273   #endif
274 #endif
275
276 /* USART configuration */
277 #ifdef BLUETOOTH_ENABLE
278 #   ifdef __AVR_ATmega32U4__
279 #      define SERIAL_UART_BAUD 9600
280 #      define SERIAL_UART_DATA UDR1
281 #      define SERIAL_UART_UBRR (F_CPU / (16UL * SERIAL_UART_BAUD) - 1)
282 #      define SERIAL_UART_RXD_VECT USART1_RX_vect
283 #      define SERIAL_UART_TXD_READY (UCSR1A & _BV(UDRE1))
284 #      define SERIAL_UART_INIT() do { \
285             /* baud rate */ \
286             UBRR1L = SERIAL_UART_UBRR; \
287             /* baud rate */ \
288             UBRR1H = SERIAL_UART_UBRR >> 8; \
289             /* enable TX */ \
290             UCSR1B = _BV(TXEN1); \
291             /* 8-bit data */ \
292             UCSR1C = _BV(UCSZ11) | _BV(UCSZ10); \
293             sei(); \
294         } while(0)
295 #   else
296 #       error "USART configuration is needed."
297 #   endif
298 #endif
299
300 #define API_SYSEX_MAX_SIZE 32
301
302 #include "song_list.h"