Implement and document TAPPING_FORCE_HOLD_PER_KEY (#7859)
[jackhill/qmk/firmware.git] / common_features.mk
CommitLineData
1c0fe956
FS
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
16SERIAL_DIR := $(QUANTUM_DIR)/serial_link
17SERIAL_PATH := $(QUANTUM_PATH)/serial_link
18SERIAL_SRC := $(wildcard $(SERIAL_PATH)/protocol/*.c)
19SERIAL_SRC += $(wildcard $(SERIAL_PATH)/system/*.c)
20SERIAL_DEFS += -DSERIAL_LINK_ENABLE
1aa0be4c 21COMMON_VPATH += $(SERIAL_PATH)
1c0fe956
FS
22
23ifeq ($(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
29endif
30
31MUSIC_ENABLE := 0
32
33ifeq ($(strip $(AUDIO_ENABLE)), yes)
34 OPT_DEFS += -DAUDIO_ENABLE
35 MUSIC_ENABLE := 1
36 SRC += $(QUANTUM_DIR)/process_keycode/process_audio.c
33fdd1d2 37 SRC += $(QUANTUM_DIR)/process_keycode/process_clicky.c
5836d1a0 38 ifeq ($(PLATFORM),AVR)
39 SRC += $(QUANTUM_DIR)/audio/audio.c
40 else
41 SRC += $(QUANTUM_DIR)/audio/audio_arm.c
42 endif
1c0fe956
FS
43 SRC += $(QUANTUM_DIR)/audio/voices.c
44 SRC += $(QUANTUM_DIR)/audio/luts.c
45endif
46
47ifeq ($(strip $(MIDI_ENABLE)), yes)
48 OPT_DEFS += -DMIDI_ENABLE
49 MUSIC_ENABLE := 1
50 SRC += $(QUANTUM_DIR)/process_keycode/process_midi.c
51endif
52
53ifeq ($(MUSIC_ENABLE), 1)
54 SRC += $(QUANTUM_DIR)/process_keycode/process_music.c
55endif
56
57ifeq ($(strip $(COMBO_ENABLE)), yes)
58 OPT_DEFS += -DCOMBO_ENABLE
59 SRC += $(QUANTUM_DIR)/process_keycode/process_combo.c
60endif
61
5987f679
JW
62ifeq ($(strip $(STENO_ENABLE)), yes)
63 OPT_DEFS += -DSTENO_ENABLE
fdd0f915 64 VIRTSER_ENABLE := yes
65 SRC += $(QUANTUM_DIR)/process_keycode/process_steno.c
5987f679
JW
66endif
67
1c0fe956
FS
68ifeq ($(strip $(VIRTSER_ENABLE)), yes)
69 OPT_DEFS += -DVIRTSER_ENABLE
70endif
71
72ifeq ($(strip $(FAUXCLICKY_ENABLE)), yes)
73 OPT_DEFS += -DFAUXCLICKY_ENABLE
74 SRC += $(QUANTUM_DIR)/fauxclicky.c
75endif
76
ee132284 77ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
fdd0f915 78 OPT_DEFS += -DPOINTING_DEVICE_ENABLE
79 OPT_DEFS += -DMOUSE_ENABLE
80 SRC += $(QUANTUM_DIR)/pointing_device.c
ee132284
S
81endif
82
1c0fe956
FS
83ifeq ($(strip $(UCIS_ENABLE)), yes)
84 OPT_DEFS += -DUCIS_ENABLE
320822d7 85 UNICODE_COMMON := yes
1c0fe956
FS
86 SRC += $(QUANTUM_DIR)/process_keycode/process_ucis.c
87endif
88
89ifeq ($(strip $(UNICODEMAP_ENABLE)), yes)
90 OPT_DEFS += -DUNICODEMAP_ENABLE
320822d7 91 UNICODE_COMMON := yes
1c0fe956
FS
92 SRC += $(QUANTUM_DIR)/process_keycode/process_unicodemap.c
93endif
94
95ifeq ($(strip $(UNICODE_ENABLE)), yes)
96 OPT_DEFS += -DUNICODE_ENABLE
320822d7 97 UNICODE_COMMON := yes
1c0fe956
FS
98 SRC += $(QUANTUM_DIR)/process_keycode/process_unicode.c
99endif
100
101ifeq ($(strip $(UNICODE_COMMON)), yes)
102 SRC += $(QUANTUM_DIR)/process_keycode/process_unicode_common.c
103endif
104
105ifeq ($(strip $(RGBLIGHT_ENABLE)), yes)
7e67bd79 106 POST_CONFIG_H += $(QUANTUM_DIR)/rgblight_post_config.h
1c0fe956 107 OPT_DEFS += -DRGBLIGHT_ENABLE
22ba36a4 108 SRC += $(QUANTUM_DIR)/color.c
024f0455 109 SRC += $(QUANTUM_DIR)/rgblight.c
320822d7
W
110 CIE1931_CURVE := yes
111 LED_BREATHING_TABLE := yes
112 RGB_KEYCODES_ENABLE := yes
d5486265
LR
113 ifeq ($(strip $(RGBLIGHT_CUSTOM_DRIVER)), yes)
114 OPT_DEFS += -DRGBLIGHT_CUSTOM_DRIVER
115 else
320822d7 116 WS2812_DRIVER_REQUIRED := yes
d5486265 117 endif
1c0fe956
FS
118endif
119
5fcd744d 120VALID_MATRIX_TYPES := yes IS31FL3731 IS31FL3733 IS31FL3737 WS2812 custom
fd698c43 121
122LED_MATRIX_ENABLE ?= no
123ifneq ($(strip $(LED_MATRIX_ENABLE)), no)
cc738e32 124 ifeq ($(filter $(LED_MATRIX_ENABLE),$(VALID_MATRIX_TYPES)),)
125 $(error LED_MATRIX_ENABLE="$(LED_MATRIX_ENABLE)" is not a valid matrix type)
126 else
127 OPT_DEFS += -DLED_MATRIX_ENABLE -DBACKLIGHT_ENABLE -DBACKLIGHT_CUSTOM_DRIVER
128 SRC += $(QUANTUM_DIR)/led_matrix.c
129 SRC += $(QUANTUM_DIR)/led_matrix_drivers.c
130 endif
fd698c43 131endif
132
133ifeq ($(strip $(LED_MATRIX_ENABLE)), IS31FL3731)
134 OPT_DEFS += -DIS31FL3731
135 COMMON_VPATH += $(DRIVER_PATH)/issi
136 SRC += is31fl3731-simple.c
6cccc22b 137 QUANTUM_LIB_SRC += i2c_master.c
fd698c43 138endif
139
140RGB_MATRIX_ENABLE ?= no
fa4052c2 141
f70f45ee
JLW
142ifneq ($(strip $(RGB_MATRIX_ENABLE)), no)
143ifeq ($(filter $(RGB_MATRIX_ENABLE),$(VALID_MATRIX_TYPES)),)
144 $(error RGB_MATRIX_ENABLE="$(RGB_MATRIX_ENABLE)" is not a valid matrix type)
145endif
14b7602a 146 OPT_DEFS += -DRGB_MATRIX_ENABLE
14b7602a
JH
147 SRC += $(QUANTUM_DIR)/color.c
148 SRC += $(QUANTUM_DIR)/rgb_matrix.c
f70f45ee 149 SRC += $(QUANTUM_DIR)/rgb_matrix_drivers.c
320822d7
W
150 CIE1931_CURVE := yes
151 RGB_KEYCODES_ENABLE := yes
14b7602a
JH
152endif
153
f70f45ee 154ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
320822d7 155 RGB_MATRIX_ENABLE := IS31FL3731
f70f45ee
JLW
156endif
157
fdd0f915 158ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3731)
fa4052c2 159 OPT_DEFS += -DIS31FL3731 -DSTM32_I2C -DHAL_USE_I2C=TRUE
fdd0f915 160 COMMON_VPATH += $(DRIVER_PATH)/issi
161 SRC += is31fl3731.c
6cccc22b 162 QUANTUM_LIB_SRC += i2c_master.c
fdd0f915 163endif
164
165ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3733)
fa4052c2 166 OPT_DEFS += -DIS31FL3733 -DSTM32_I2C -DHAL_USE_I2C=TRUE
fdd0f915 167 COMMON_VPATH += $(DRIVER_PATH)/issi
168 SRC += is31fl3733.c
6cccc22b 169 QUANTUM_LIB_SRC += i2c_master.c
fdd0f915 170endif
171
fa4052c2
JH
172ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3737)
173 OPT_DEFS += -DIS31FL3737 -DSTM32_I2C -DHAL_USE_I2C=TRUE
174 COMMON_VPATH += $(DRIVER_PATH)/issi
175 SRC += is31fl3737.c
6cccc22b 176 QUANTUM_LIB_SRC += i2c_master.c
fa4052c2
JH
177endif
178
5fcd744d
X
179ifeq ($(strip $(RGB_MATRIX_ENABLE)), WS2812)
180 OPT_DEFS += -DWS2812
320822d7 181 WS2812_DRIVER_REQUIRED := yes
5fcd744d
X
182endif
183
1d784f0f
DP
184ifeq ($(strip $(RGB_MATRIX_CUSTOM_KB)), yes)
185 OPT_DEFS += -DRGB_MATRIX_CUSTOM_KB
186endif
187
188ifeq ($(strip $(RGB_MATRIX_CUSTOM_USER)), yes)
189 OPT_DEFS += -DRGB_MATRIX_CUSTOM_USER
190endif
191
ae40fc49
JC
192ifeq ($(strip $(RGB_KEYCODES_ENABLE)), yes)
193 SRC += $(QUANTUM_DIR)/process_keycode/process_rgb.c
194endif
195
1c0fe956
FS
196ifeq ($(strip $(TAP_DANCE_ENABLE)), yes)
197 OPT_DEFS += -DTAP_DANCE_ENABLE
198 SRC += $(QUANTUM_DIR)/process_keycode/process_tap_dance.c
199endif
200
8e1be7c7
FS
201ifeq ($(strip $(KEY_LOCK_ENABLE)), yes)
202 OPT_DEFS += -DKEY_LOCK_ENABLE
203 SRC += $(QUANTUM_DIR)/process_keycode/process_key_lock.c
204endif
205
1c0fe956
FS
206ifeq ($(strip $(PRINTING_ENABLE)), yes)
207 OPT_DEFS += -DPRINTING_ENABLE
208 SRC += $(QUANTUM_DIR)/process_keycode/process_printer.c
209 SRC += $(TMK_DIR)/protocol/serial_uart.c
210endif
211
abba393f
JC
212ifeq ($(strip $(AUTO_SHIFT_ENABLE)), yes)
213 OPT_DEFS += -DAUTO_SHIFT_ENABLE
214 SRC += $(QUANTUM_DIR)/process_keycode/process_auto_shift.c
00b4dce6
JS
215 ifeq ($(strip $(AUTO_SHIFT_MODIFIERS)), yes)
216 OPT_DEFS += -DAUTO_SHIFT_MODIFIERS
217 endif
abba393f
JC
218endif
219
1c0fe956
FS
220ifeq ($(strip $(SERIAL_LINK_ENABLE)), yes)
221 SRC += $(patsubst $(QUANTUM_PATH)/%,%,$(SERIAL_SRC))
222 OPT_DEFS += $(SERIAL_DEFS)
223 VAPTH += $(SERIAL_PATH)
224endif
225
226ifneq ($(strip $(VARIABLE_TRACE)),)
227 SRC += $(QUANTUM_DIR)/variable_trace.c
228 OPT_DEFS += -DNUM_TRACED_VARIABLES=$(strip $(VARIABLE_TRACE))
229ifneq ($(strip $(MAX_VARIABLE_TRACE_SIZE)),)
230 OPT_DEFS += -DMAX_VARIABLE_TRACE_SIZE=$(strip $(MAX_VARIABLE_TRACE_SIZE))
231endif
232endif
233
234ifeq ($(strip $(LCD_ENABLE)), yes)
320822d7 235 CIE1931_CURVE := yes
1c0fe956
FS
236endif
237
38aefaf7
JC
238# backward compat
239ifeq ($(strip $(BACKLIGHT_CUSTOM_DRIVER)), yes)
320822d7 240 BACKLIGHT_DRIVER := custom
38aefaf7
JC
241endif
242
d4c23d88 243VALID_BACKLIGHT_TYPES := pwm software custom
38aefaf7
JC
244
245BACKLIGHT_ENABLE ?= no
d4c23d88 246BACKLIGHT_DRIVER ?= pwm
247ifeq ($(strip $(BACKLIGHT_ENABLE)), yes)
248 ifeq ($(filter $(BACKLIGHT_DRIVER),$(VALID_BACKLIGHT_TYPES)),)
249 $(error BACKLIGHT_DRIVER="$(BACKLIGHT_DRIVER)" is not a valid backlight type)
38aefaf7
JC
250 endif
251
1c0fe956 252 ifeq ($(strip $(VISUALIZER_ENABLE)), yes)
320822d7 253 CIE1931_CURVE := yes
365b8635 254 endif
38aefaf7 255
abfd6ed9
JC
256 COMMON_VPATH += $(QUANTUM_DIR)/backlight
257 SRC += $(QUANTUM_DIR)/backlight/backlight.c
258 OPT_DEFS += -DBACKLIGHT_ENABLE
259
b89e35bd
JC
260 ifeq ($(strip $(BACKLIGHT_DRIVER)), custom)
261 OPT_DEFS += -DBACKLIGHT_CUSTOM_DRIVER
262 else ifeq ($(strip $(BACKLIGHT_DRIVER)), software)
4531cc87 263 SRC += $(QUANTUM_DIR)/backlight/backlight_soft.c
38aefaf7 264 else
4531cc87
JC
265 ifeq ($(PLATFORM),AVR)
266 SRC += $(QUANTUM_DIR)/backlight/backlight_avr.c
267 else
268 SRC += $(QUANTUM_DIR)/backlight/backlight_arm.c
269 endif
38aefaf7 270 endif
1c0fe956
FS
271endif
272
64b7cfe7
JC
273VALID_WS2812_DRIVER_TYPES := bitbang pwm spi i2c
274
275WS2812_DRIVER ?= bitbang
276ifeq ($(strip $(WS2812_DRIVER_REQUIRED)), yes)
277 ifeq ($(filter $(WS2812_DRIVER),$(VALID_WS2812_DRIVER_TYPES)),)
278 $(error WS2812_DRIVER="$(WS2812_DRIVER)" is not a valid WS2812 driver)
279 endif
280
61cd1801
JC
281 OPT_DEFS += -DWS2812_DRIVER_$(strip $(shell echo $(WS2812_DRIVER) | tr '[:lower:]' '[:upper:]'))
282
64b7cfe7
JC
283 ifeq ($(strip $(WS2812_DRIVER)), bitbang)
284 SRC += ws2812.c
285 else
286 SRC += ws2812_$(strip $(WS2812_DRIVER)).c
287 endif
288
289 # add extra deps
290 ifeq ($(strip $(WS2812_DRIVER)), i2c)
291 QUANTUM_LIB_SRC += i2c_master.c
292 endif
293endif
294
1c0fe956
FS
295ifeq ($(strip $(CIE1931_CURVE)), yes)
296 OPT_DEFS += -DUSE_CIE1931_CURVE
320822d7 297 LED_TABLES := yes
1c0fe956
FS
298endif
299
300ifeq ($(strip $(LED_BREATHING_TABLE)), yes)
301 OPT_DEFS += -DUSE_LED_BREATHING_TABLE
320822d7 302 LED_TABLES := yes
1c0fe956
FS
303endif
304
305ifeq ($(strip $(LED_TABLES)), yes)
306 SRC += $(QUANTUM_DIR)/led_tables.c
307endif
308
7ad924ba
JH
309ifeq ($(strip $(TERMINAL_ENABLE)), yes)
310 SRC += $(QUANTUM_DIR)/process_keycode/process_terminal.c
311 OPT_DEFS += -DTERMINAL_ENABLE
40313cfa 312 OPT_DEFS += -DUSER_PRINT
7ad924ba
JH
313endif
314
800ec55d
JH
315ifeq ($(strip $(USB_HID_ENABLE)), yes)
316 include $(TMK_DIR)/protocol/usb_hid.mk
317endif
318
85688e5b
JH
319ifeq ($(strip $(ENCODER_ENABLE)), yes)
320 SRC += $(QUANTUM_DIR)/encoder.c
321 OPT_DEFS += -DENCODER_ENABLE
322endif
323
265d8abe
DJ
324HAPTIC_ENABLE ?= no
325ifneq ($(strip $(HAPTIC_ENABLE)),no)
326 COMMON_VPATH += $(DRIVER_PATH)/haptic
327 SRC += haptic.c
328 OPT_DEFS += -DHAPTIC_ENABLE
329endif
330
331ifneq ($(filter DRV2605L, $(HAPTIC_ENABLE)), )
4099536c 332 SRC += DRV2605L.c
6cccc22b 333 QUANTUM_LIB_SRC += i2c_master.c
4099536c 334 OPT_DEFS += -DDRV2605L
335endif
336
265d8abe 337ifneq ($(filter SOLENOID, $(HAPTIC_ENABLE)), )
2cee371b 338 SRC += solenoid.c
2cee371b 339 OPT_DEFS += -DSOLENOID_ENABLE
340endif
341
bbea9dad
MA
342ifeq ($(strip $(HD44780_ENABLE)), yes)
343 SRC += drivers/avr/hd44780.c
fdd0f915 344 OPT_DEFS += -DHD44780_ENABLE
bbea9dad
MA
345endif
346
c1c5922a
CL
347ifeq ($(strip $(VELOCIKEY_ENABLE)), yes)
348 OPT_DEFS += -DVELOCIKEY_ENABLE
349 SRC += $(QUANTUM_DIR)/velocikey.c
350endif
351
320822d7
W
352ifeq ($(strip $(VIA_ENABLE)), yes)
353 DYNAMIC_KEYMAP_ENABLE := yes
354 RAW_ENABLE := yes
355 BOOTMAGIC_ENABLE := lite
356 SRC += $(QUANTUM_DIR)/via.c
357 OPT_DEFS += -DVIA_ENABLE
358endif
359
48a992f1
W
360ifeq ($(strip $(DYNAMIC_KEYMAP_ENABLE)), yes)
361 OPT_DEFS += -DDYNAMIC_KEYMAP_ENABLE
362 SRC += $(QUANTUM_DIR)/dynamic_keymap.c
363endif
364
74344947
JW
365ifeq ($(strip $(LEADER_ENABLE)), yes)
366 SRC += $(QUANTUM_DIR)/process_keycode/process_leader.c
367 OPT_DEFS += -DLEADER_ENABLE
368endif
369
4099536c 370include $(DRIVER_PATH)/qwiic/qwiic.mk
371
1c0fe956
FS
372QUANTUM_SRC:= \
373 $(QUANTUM_DIR)/quantum.c \
374 $(QUANTUM_DIR)/keymap_common.c \
74344947 375 $(QUANTUM_DIR)/keycode_config.c
1c0fe956 376
dcb7ca3f
JC
377
378
379VALID_CUSTOM_MATRIX_TYPES:= yes lite no
380
381CUSTOM_MATRIX ?= no
382
28929ad0 383ifneq ($(strip $(CUSTOM_MATRIX)), yes)
dcb7ca3f
JC
384 ifeq ($(filter $(CUSTOM_MATRIX),$(VALID_CUSTOM_MATRIX_TYPES)),)
385 $(error CUSTOM_MATRIX="$(CUSTOM_MATRIX)" is not a valid custom matrix type)
386 endif
387
388 # Include common stuff for all non custom matrix users
389 QUANTUM_SRC += $(QUANTUM_DIR)/matrix_common.c
390
391 # if 'lite' then skip the actual matrix implementation
392 ifneq ($(strip $(CUSTOM_MATRIX)), lite)
393 # Include the standard or split matrix code if needed
394 ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
395 QUANTUM_SRC += $(QUANTUM_DIR)/split_common/matrix.c
396 else
397 QUANTUM_SRC += $(QUANTUM_DIR)/matrix.c
398 endif
929065b1 399 endif
28929ad0
JC
400endif
401
d0b691df 402DEBOUNCE_DIR:= $(QUANTUM_DIR)/debounce
c7c4937e 403# Debounce Modules. Set DEBOUNCE_TYPE=custom if including one manually.
7d8c6299 404DEBOUNCE_TYPE?= sym_g
c7c4937e
JC
405ifneq ($(strip $(DEBOUNCE_TYPE)), custom)
406 QUANTUM_SRC += $(DEBOUNCE_DIR)/$(strip $(DEBOUNCE_TYPE)).c
28929ad0
JC
407endif
408
409ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
7e67bd79 410 POST_CONFIG_H += $(QUANTUM_DIR)/split_common/post_config.h
0fab3bbd 411 OPT_DEFS += -DSPLIT_KEYBOARD
28929ad0
JC
412
413 # Include files used by all split keyboards
37932c29 414 QUANTUM_SRC += $(QUANTUM_DIR)/split_common/split_util.c
28929ad0
JC
415
416 # Determine which (if any) transport files are required
417 ifneq ($(strip $(SPLIT_TRANSPORT)), custom)
418 QUANTUM_SRC += $(QUANTUM_DIR)/split_common/transport.c
419 # Functions added via QUANTUM_LIB_SRC are only included in the final binary if they're called.
37932c29
JC
420 # Unused functions are pruned away, which is why we can add multiple drivers here without bloat.
421 QUANTUM_LIB_SRC += $(QUANTUM_DIR)/split_common/serial.c \
422 i2c_master.c \
423 i2c_slave.c
28929ad0 424 endif
7f0def77 425 COMMON_VPATH += $(QUANTUM_PATH)/split_common
8e1be7c7 426endif
0a645225
RC
427
428ifeq ($(strip $(OLED_DRIVER_ENABLE)), yes)
429 OPT_DEFS += -DOLED_DRIVER_ENABLE
430 COMMON_VPATH += $(DRIVER_PATH)/oled
431 QUANTUM_LIB_SRC += i2c_master.c
432 SRC += oled_driver.c
433endif
c745d9b8
X
434
435SPACE_CADET_ENABLE ?= yes
436ifeq ($(strip $(SPACE_CADET_ENABLE)), yes)
437 SRC += $(QUANTUM_DIR)/process_keycode/process_space_cadet.c
438 OPT_DEFS += -DSPACE_CADET_ENABLE
439endif
dab4967f 440
d598f01c
JC
441MAGIC_ENABLE ?= yes
442ifeq ($(strip $(MAGIC_ENABLE)), yes)
443 SRC += $(QUANTUM_DIR)/process_keycode/process_magic.c
444 OPT_DEFS += -DMAGIC_KEYCODE_ENABLE
dab4967f 445endif
542cb0a8
DJ
446
447ifeq ($(strip $(DYNAMIC_MACRO_ENABLE)), yes)
448 SRC += $(QUANTUM_DIR)/process_keycode/process_dynamic_macro.c
449 OPT_DEFS += -DDYNAMIC_MACRO_ENABLE
450endif
d598f01c
JC
451
452ifeq ($(strip $(DIP_SWITCH_ENABLE)), yes)
453 SRC += $(QUANTUM_DIR)/dip_switch.c
454 OPT_DEFS += -DDIP_SWITCH_ENABLE
455endif