Flesh out keymaps and some tweaks to indicators (#5608)
[jackhill/qmk/firmware.git] / common_features.mk
1 # Copyright 2017 Fred Sundvik
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 SERIAL_DIR := $(QUANTUM_DIR)/serial_link
17 SERIAL_PATH := $(QUANTUM_PATH)/serial_link
18 SERIAL_SRC := $(wildcard $(SERIAL_PATH)/protocol/*.c)
19 SERIAL_SRC += $(wildcard $(SERIAL_PATH)/system/*.c)
20 SERIAL_DEFS += -DSERIAL_LINK_ENABLE
21 COMMON_VPATH += $(SERIAL_PATH)
22
23 ifeq ($(strip $(API_SYSEX_ENABLE)), yes)
24 OPT_DEFS += -DAPI_SYSEX_ENABLE
25 SRC += $(QUANTUM_DIR)/api/api_sysex.c
26 OPT_DEFS += -DAPI_ENABLE
27 SRC += $(QUANTUM_DIR)/api.c
28 MIDI_ENABLE=yes
29 endif
30
31 MUSIC_ENABLE := 0
32
33 ifeq ($(strip $(AUDIO_ENABLE)), yes)
34 OPT_DEFS += -DAUDIO_ENABLE
35 MUSIC_ENABLE := 1
36 SRC += $(QUANTUM_DIR)/process_keycode/process_audio.c
37 SRC += $(QUANTUM_DIR)/process_keycode/process_clicky.c
38 ifeq ($(PLATFORM),AVR)
39 SRC += $(QUANTUM_DIR)/audio/audio.c
40 else
41 SRC += $(QUANTUM_DIR)/audio/audio_arm.c
42 endif
43 SRC += $(QUANTUM_DIR)/audio/voices.c
44 SRC += $(QUANTUM_DIR)/audio/luts.c
45 endif
46
47 ifeq ($(strip $(MIDI_ENABLE)), yes)
48 OPT_DEFS += -DMIDI_ENABLE
49 MUSIC_ENABLE := 1
50 SRC += $(QUANTUM_DIR)/process_keycode/process_midi.c
51 endif
52
53 ifeq ($(MUSIC_ENABLE), 1)
54 SRC += $(QUANTUM_DIR)/process_keycode/process_music.c
55 endif
56
57 ifeq ($(strip $(COMBO_ENABLE)), yes)
58 OPT_DEFS += -DCOMBO_ENABLE
59 SRC += $(QUANTUM_DIR)/process_keycode/process_combo.c
60 endif
61
62 ifeq ($(strip $(STENO_ENABLE)), yes)
63 OPT_DEFS += -DSTENO_ENABLE
64 VIRTSER_ENABLE := yes
65 SRC += $(QUANTUM_DIR)/process_keycode/process_steno.c
66 endif
67
68 ifeq ($(strip $(VIRTSER_ENABLE)), yes)
69 OPT_DEFS += -DVIRTSER_ENABLE
70 endif
71
72 ifeq ($(strip $(FAUXCLICKY_ENABLE)), yes)
73 OPT_DEFS += -DFAUXCLICKY_ENABLE
74 SRC += $(QUANTUM_DIR)/fauxclicky.c
75 endif
76
77 ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
78 OPT_DEFS += -DPOINTING_DEVICE_ENABLE
79 OPT_DEFS += -DMOUSE_ENABLE
80 SRC += $(QUANTUM_DIR)/pointing_device.c
81 endif
82
83 ifeq ($(strip $(UCIS_ENABLE)), yes)
84 OPT_DEFS += -DUCIS_ENABLE
85 UNICODE_COMMON = yes
86 SRC += $(QUANTUM_DIR)/process_keycode/process_ucis.c
87 endif
88
89 ifeq ($(strip $(UNICODEMAP_ENABLE)), yes)
90 OPT_DEFS += -DUNICODEMAP_ENABLE
91 UNICODE_COMMON = yes
92 SRC += $(QUANTUM_DIR)/process_keycode/process_unicodemap.c
93 endif
94
95 ifeq ($(strip $(UNICODE_ENABLE)), yes)
96 OPT_DEFS += -DUNICODE_ENABLE
97 UNICODE_COMMON = yes
98 SRC += $(QUANTUM_DIR)/process_keycode/process_unicode.c
99 endif
100
101 ifeq ($(strip $(UNICODE_COMMON)), yes)
102 SRC += $(QUANTUM_DIR)/process_keycode/process_unicode_common.c
103 endif
104
105 ifeq ($(strip $(RGBLIGHT_ENABLE)), yes)
106 OPT_DEFS += -DRGBLIGHT_ENABLE
107 SRC += $(QUANTUM_DIR)/rgblight.c
108 CIE1931_CURVE = yes
109 LED_BREATHING_TABLE = yes
110 ifeq ($(strip $(RGBLIGHT_CUSTOM_DRIVER)), yes)
111 OPT_DEFS += -DRGBLIGHT_CUSTOM_DRIVER
112 else
113 SRC += ws2812.c
114 endif
115 endif
116
117 VALID_MATRIX_TYPES := yes IS31FL3731 IS31FL3733 IS31FL3737 custom
118
119 LED_MATRIX_ENABLE ?= no
120 ifneq ($(strip $(LED_MATRIX_ENABLE)), no)
121 ifeq ($(filter $(LED_MATRIX_ENABLE),$(VALID_MATRIX_TYPES)),)
122 $(error LED_MATRIX_ENABLE="$(LED_MATRIX_ENABLE)" is not a valid matrix type)
123 else
124 OPT_DEFS += -DLED_MATRIX_ENABLE -DBACKLIGHT_ENABLE -DBACKLIGHT_CUSTOM_DRIVER
125 SRC += $(QUANTUM_DIR)/led_matrix.c
126 SRC += $(QUANTUM_DIR)/led_matrix_drivers.c
127 endif
128 endif
129
130 ifeq ($(strip $(LED_MATRIX_ENABLE)), IS31FL3731)
131 OPT_DEFS += -DIS31FL3731
132 COMMON_VPATH += $(DRIVER_PATH)/issi
133 SRC += is31fl3731-simple.c
134 SRC += i2c_master.c
135 endif
136
137 RGB_MATRIX_ENABLE ?= no
138
139 ifneq ($(strip $(RGB_MATRIX_ENABLE)), no)
140 ifeq ($(filter $(RGB_MATRIX_ENABLE),$(VALID_MATRIX_TYPES)),)
141 $(error RGB_MATRIX_ENABLE="$(RGB_MATRIX_ENABLE)" is not a valid matrix type)
142 endif
143 OPT_DEFS += -DRGB_MATRIX_ENABLE
144 SRC += $(QUANTUM_DIR)/color.c
145 SRC += $(QUANTUM_DIR)/rgb_matrix.c
146 SRC += $(QUANTUM_DIR)/rgb_matrix_drivers.c
147 CIE1931_CURVE = yes
148 endif
149
150 ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
151 RGB_MATRIX_ENABLE = IS31FL3731
152 endif
153
154 ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3731)
155 OPT_DEFS += -DIS31FL3731 -DSTM32_I2C -DHAL_USE_I2C=TRUE
156 COMMON_VPATH += $(DRIVER_PATH)/issi
157 SRC += is31fl3731.c
158 SRC += i2c_master.c
159 endif
160
161 ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3733)
162 OPT_DEFS += -DIS31FL3733 -DSTM32_I2C -DHAL_USE_I2C=TRUE
163 COMMON_VPATH += $(DRIVER_PATH)/issi
164 SRC += is31fl3733.c
165 SRC += i2c_master.c
166 endif
167
168 ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3737)
169 OPT_DEFS += -DIS31FL3737 -DSTM32_I2C -DHAL_USE_I2C=TRUE
170 COMMON_VPATH += $(DRIVER_PATH)/issi
171 SRC += is31fl3737.c
172 SRC += i2c_master.c
173 endif
174
175 ifeq ($(strip $(TAP_DANCE_ENABLE)), yes)
176 OPT_DEFS += -DTAP_DANCE_ENABLE
177 SRC += $(QUANTUM_DIR)/process_keycode/process_tap_dance.c
178 endif
179
180 ifeq ($(strip $(KEY_LOCK_ENABLE)), yes)
181 OPT_DEFS += -DKEY_LOCK_ENABLE
182 SRC += $(QUANTUM_DIR)/process_keycode/process_key_lock.c
183 endif
184
185 ifeq ($(strip $(PRINTING_ENABLE)), yes)
186 OPT_DEFS += -DPRINTING_ENABLE
187 SRC += $(QUANTUM_DIR)/process_keycode/process_printer.c
188 SRC += $(TMK_DIR)/protocol/serial_uart.c
189 endif
190
191 ifeq ($(strip $(AUTO_SHIFT_ENABLE)), yes)
192 OPT_DEFS += -DAUTO_SHIFT_ENABLE
193 SRC += $(QUANTUM_DIR)/process_keycode/process_auto_shift.c
194 ifeq ($(strip $(AUTO_SHIFT_MODIFIERS)), yes)
195 OPT_DEFS += -DAUTO_SHIFT_MODIFIERS
196 endif
197 endif
198
199 ifeq ($(strip $(SERIAL_LINK_ENABLE)), yes)
200 SRC += $(patsubst $(QUANTUM_PATH)/%,%,$(SERIAL_SRC))
201 OPT_DEFS += $(SERIAL_DEFS)
202 VAPTH += $(SERIAL_PATH)
203 endif
204
205 ifneq ($(strip $(VARIABLE_TRACE)),)
206 SRC += $(QUANTUM_DIR)/variable_trace.c
207 OPT_DEFS += -DNUM_TRACED_VARIABLES=$(strip $(VARIABLE_TRACE))
208 ifneq ($(strip $(MAX_VARIABLE_TRACE_SIZE)),)
209 OPT_DEFS += -DMAX_VARIABLE_TRACE_SIZE=$(strip $(MAX_VARIABLE_TRACE_SIZE))
210 endif
211 endif
212
213 ifeq ($(strip $(LCD_ENABLE)), yes)
214 CIE1931_CURVE = yes
215 endif
216
217 ifeq ($(strip $(BACKLIGHT_ENABLE)), yes)
218 ifeq ($(strip $(VISUALIZER_ENABLE)), yes)
219 CIE1931_CURVE = yes
220 endif
221 ifeq ($(strip $(BACKLIGHT_CUSTOM_DRIVER)), yes)
222 OPT_DEFS += -DBACKLIGHT_CUSTOM_DRIVER
223 endif
224 endif
225
226 ifeq ($(strip $(CIE1931_CURVE)), yes)
227 OPT_DEFS += -DUSE_CIE1931_CURVE
228 LED_TABLES = yes
229 endif
230
231 ifeq ($(strip $(LED_BREATHING_TABLE)), yes)
232 OPT_DEFS += -DUSE_LED_BREATHING_TABLE
233 LED_TABLES = yes
234 endif
235
236 ifeq ($(strip $(LED_TABLES)), yes)
237 SRC += $(QUANTUM_DIR)/led_tables.c
238 endif
239
240 ifeq ($(strip $(TERMINAL_ENABLE)), yes)
241 SRC += $(QUANTUM_DIR)/process_keycode/process_terminal.c
242 OPT_DEFS += -DTERMINAL_ENABLE
243 OPT_DEFS += -DUSER_PRINT
244 endif
245
246 ifeq ($(strip $(USB_HID_ENABLE)), yes)
247 include $(TMK_DIR)/protocol/usb_hid.mk
248 endif
249
250 ifeq ($(strip $(ENCODER_ENABLE)), yes)
251 SRC += $(QUANTUM_DIR)/encoder.c
252 OPT_DEFS += -DENCODER_ENABLE
253 endif
254
255 ifeq ($(strip $(HAPTIC_ENABLE)), DRV2605L)
256 COMMON_VPATH += $(DRIVER_PATH)/haptic
257 SRC += haptic.c
258 SRC += DRV2605L.c
259 SRC += i2c_master.c
260 OPT_DEFS += -DHAPTIC_ENABLE
261 OPT_DEFS += -DDRV2605L
262 endif
263
264 ifeq ($(strip $(HAPTIC_ENABLE)), SOLENOID)
265 COMMON_VPATH += $(DRIVER_PATH)/haptic
266 SRC += haptic.c
267 SRC += solenoid.c
268 OPT_DEFS += -DHAPTIC_ENABLE
269 OPT_DEFS += -DSOLENOID_ENABLE
270 endif
271
272 ifeq ($(strip $(HD44780_ENABLE)), yes)
273 SRC += drivers/avr/hd44780.c
274 OPT_DEFS += -DHD44780_ENABLE
275 endif
276
277 ifeq ($(strip $(VELOCIKEY_ENABLE)), yes)
278 OPT_DEFS += -DVELOCIKEY_ENABLE
279 SRC += $(QUANTUM_DIR)/velocikey.c
280 endif
281
282 ifeq ($(strip $(DYNAMIC_KEYMAP_ENABLE)), yes)
283 OPT_DEFS += -DDYNAMIC_KEYMAP_ENABLE
284 SRC += $(QUANTUM_DIR)/dynamic_keymap.c
285 endif
286
287 ifeq ($(strip $(LEADER_ENABLE)), yes)
288 SRC += $(QUANTUM_DIR)/process_keycode/process_leader.c
289 OPT_DEFS += -DLEADER_ENABLE
290 endif
291
292 include $(DRIVER_PATH)/qwiic/qwiic.mk
293
294 QUANTUM_SRC:= \
295 $(QUANTUM_DIR)/quantum.c \
296 $(QUANTUM_DIR)/keymap_common.c \
297 $(QUANTUM_DIR)/keycode_config.c
298
299 # Include the standard or split matrix code if needed
300 ifneq ($(strip $(CUSTOM_MATRIX)), yes)
301 ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
302 QUANTUM_SRC += $(QUANTUM_DIR)/split_common/matrix.c
303 else
304 QUANTUM_SRC += $(QUANTUM_DIR)/matrix.c
305 endif
306 endif
307
308 DEBOUNCE_DIR:= $(QUANTUM_DIR)/debounce
309 # Debounce Modules. Set DEBOUNCE_TYPE=custom if including one manually.
310 DEBOUNCE_TYPE?= sym_g
311 ifneq ($(strip $(DEBOUNCE_TYPE)), custom)
312 QUANTUM_SRC += $(DEBOUNCE_DIR)/$(strip $(DEBOUNCE_TYPE)).c
313 endif
314
315 ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
316 OPT_DEFS += -DSPLIT_KEYBOARD
317
318 # Include files used by all split keyboards
319 QUANTUM_SRC += $(QUANTUM_DIR)/split_common/split_util.c
320
321 # Determine which (if any) transport files are required
322 ifneq ($(strip $(SPLIT_TRANSPORT)), custom)
323 QUANTUM_SRC += $(QUANTUM_DIR)/split_common/transport.c
324 # Functions added via QUANTUM_LIB_SRC are only included in the final binary if they're called.
325 # Unused functions are pruned away, which is why we can add multiple drivers here without bloat.
326 QUANTUM_LIB_SRC += $(QUANTUM_DIR)/split_common/serial.c \
327 i2c_master.c \
328 i2c_slave.c
329 endif
330 COMMON_VPATH += $(QUANTUM_PATH)/split_common
331 endif