]> git.donarmstrong.com Git - qmk_firmware.git/blob - common_features.mk
Update KBD67 readme so that it mentions the KBD65 PCB (#5143)
[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 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 ifneq ($(strip $(RGB_MATRIX_ENABLE)), no)
139 ifeq ($(filter $(RGB_MATRIX_ENABLE),$(VALID_MATRIX_TYPES)),)
140     $(error RGB_MATRIX_ENABLE="$(RGB_MATRIX_ENABLE)" is not a valid matrix type)
141 endif
142     OPT_DEFS += -DRGB_MATRIX_ENABLE
143     SRC += $(QUANTUM_DIR)/color.c
144     SRC += $(QUANTUM_DIR)/rgb_matrix.c
145     SRC += $(QUANTUM_DIR)/rgb_matrix_drivers.c
146     CIE1931_CURVE = yes
147 endif
148
149 ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
150         RGB_MATRIX_ENABLE = IS31FL3731
151 endif
152
153 ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3731)
154     OPT_DEFS += -DIS31FL3731
155     COMMON_VPATH += $(DRIVER_PATH)/issi
156     SRC += is31fl3731.c
157     SRC += i2c_master.c
158 endif
159
160 ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3733)
161     OPT_DEFS += -DIS31FL3733
162     COMMON_VPATH += $(DRIVER_PATH)/issi
163     SRC += is31fl3733.c
164     SRC += i2c_master.c
165 endif
166
167 ifeq ($(strip $(TAP_DANCE_ENABLE)), yes)
168     OPT_DEFS += -DTAP_DANCE_ENABLE
169     SRC += $(QUANTUM_DIR)/process_keycode/process_tap_dance.c
170 endif
171
172 ifeq ($(strip $(KEY_LOCK_ENABLE)), yes)
173     OPT_DEFS += -DKEY_LOCK_ENABLE
174     SRC += $(QUANTUM_DIR)/process_keycode/process_key_lock.c
175 endif
176
177 ifeq ($(strip $(PRINTING_ENABLE)), yes)
178     OPT_DEFS += -DPRINTING_ENABLE
179     SRC += $(QUANTUM_DIR)/process_keycode/process_printer.c
180     SRC += $(TMK_DIR)/protocol/serial_uart.c
181 endif
182
183 ifeq ($(strip $(AUTO_SHIFT_ENABLE)), yes)
184     OPT_DEFS += -DAUTO_SHIFT_ENABLE
185     SRC += $(QUANTUM_DIR)/process_keycode/process_auto_shift.c
186     ifeq ($(strip $(AUTO_SHIFT_MODIFIERS)), yes)
187         OPT_DEFS += -DAUTO_SHIFT_MODIFIERS
188     endif
189 endif
190
191 ifeq ($(strip $(SERIAL_LINK_ENABLE)), yes)
192     SRC += $(patsubst $(QUANTUM_PATH)/%,%,$(SERIAL_SRC))
193     OPT_DEFS += $(SERIAL_DEFS)
194     VAPTH += $(SERIAL_PATH)
195 endif
196
197 ifneq ($(strip $(VARIABLE_TRACE)),)
198     SRC += $(QUANTUM_DIR)/variable_trace.c
199     OPT_DEFS += -DNUM_TRACED_VARIABLES=$(strip $(VARIABLE_TRACE))
200 ifneq ($(strip $(MAX_VARIABLE_TRACE_SIZE)),)
201     OPT_DEFS += -DMAX_VARIABLE_TRACE_SIZE=$(strip $(MAX_VARIABLE_TRACE_SIZE))
202 endif
203 endif
204
205 ifeq ($(strip $(LCD_ENABLE)), yes)
206     CIE1931_CURVE = yes
207 endif
208
209 ifeq ($(strip $(BACKLIGHT_ENABLE)), yes)
210     ifeq ($(strip $(VISUALIZER_ENABLE)), yes)
211         CIE1931_CURVE = yes
212     endif
213     ifeq ($(strip $(BACKLIGHT_CUSTOM_DRIVER)), yes)
214         OPT_DEFS += -DBACKLIGHT_CUSTOM_DRIVER
215     endif
216 endif
217
218 ifeq ($(strip $(CIE1931_CURVE)), yes)
219     OPT_DEFS += -DUSE_CIE1931_CURVE
220     LED_TABLES = yes
221 endif
222
223 ifeq ($(strip $(LED_BREATHING_TABLE)), yes)
224     OPT_DEFS += -DUSE_LED_BREATHING_TABLE
225     LED_TABLES = yes
226 endif
227
228 ifeq ($(strip $(LED_TABLES)), yes)
229     SRC += $(QUANTUM_DIR)/led_tables.c
230 endif
231
232 ifeq ($(strip $(TERMINAL_ENABLE)), yes)
233     SRC += $(QUANTUM_DIR)/process_keycode/process_terminal.c
234     OPT_DEFS += -DTERMINAL_ENABLE
235     OPT_DEFS += -DUSER_PRINT
236 endif
237
238 ifeq ($(strip $(USB_HID_ENABLE)), yes)
239     include $(TMK_DIR)/protocol/usb_hid.mk
240 endif
241
242 ifeq ($(strip $(ENCODER_ENABLE)), yes)
243     SRC += $(QUANTUM_DIR)/encoder.c
244     OPT_DEFS += -DENCODER_ENABLE
245 endif
246
247 ifeq ($(strip $(HAPTIC_ENABLE)), DRV2605L)
248     COMMON_VPATH += $(DRIVER_PATH)/haptic
249     SRC += haptic.c
250     SRC += DRV2605L.c
251     SRC += i2c_master.c
252     OPT_DEFS += -DHAPTIC_ENABLE
253     OPT_DEFS += -DDRV2605L
254 endif
255
256 ifeq ($(strip $(HAPTIC_ENABLE)), SOLENOID)
257     COMMON_VPATH += $(DRIVER_PATH)/haptic
258     SRC += haptic.c
259     SRC += solenoid.c
260     OPT_DEFS += -DHAPTIC_ENABLE
261     OPT_DEFS += -DSOLENOID_ENABLE
262 endif
263
264 ifeq ($(strip $(HD44780_ENABLE)), yes)
265     SRC += drivers/avr/hd44780.c
266     OPT_DEFS += -DHD44780_ENABLE
267 endif
268
269 ifeq ($(strip $(VELOCIKEY_ENABLE)), yes)
270     OPT_DEFS += -DVELOCIKEY_ENABLE
271     SRC += $(QUANTUM_DIR)/velocikey.c
272 endif
273
274 ifeq ($(strip $(DYNAMIC_KEYMAP_ENABLE)), yes)
275     OPT_DEFS += -DDYNAMIC_KEYMAP_ENABLE
276     SRC += $(QUANTUM_DIR)/dynamic_keymap.c
277 endif
278
279 ifeq ($(strip $(LEADER_ENABLE)), yes)
280   SRC += $(QUANTUM_DIR)/process_keycode/process_leader.c
281   OPT_DEFS += -DLEADER_ENABLE
282 endif
283
284 include $(DRIVER_PATH)/qwiic/qwiic.mk
285
286 QUANTUM_SRC:= \
287     $(QUANTUM_DIR)/quantum.c \
288     $(QUANTUM_DIR)/keymap_common.c \
289     $(QUANTUM_DIR)/keycode_config.c
290
291 # Include the standard or split matrix code if needed
292 ifneq ($(strip $(CUSTOM_MATRIX)), yes)
293     ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
294         QUANTUM_SRC += $(QUANTUM_DIR)/split_common/matrix.c
295     else
296         QUANTUM_SRC += $(QUANTUM_DIR)/matrix.c
297     endif
298 endif
299
300 DEBOUNCE_DIR:= $(QUANTUM_DIR)/debounce
301 # Debounce Modules. Set DEBOUNCE_TYPE=custom if including one manually.
302 DEBOUNCE_TYPE?= sym_g
303 ifneq ($(strip $(DEBOUNCE_TYPE)), custom)
304     QUANTUM_SRC += $(DEBOUNCE_DIR)/$(strip $(DEBOUNCE_TYPE)).c
305 endif
306
307 ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
308     OPT_DEFS += -DSPLIT_KEYBOARD
309
310     # Include files used by all split keyboards
311     QUANTUM_SRC += $(QUANTUM_DIR)/split_common/split_util.c
312
313     # Determine which (if any) transport files are required
314     ifneq ($(strip $(SPLIT_TRANSPORT)), custom)
315         QUANTUM_SRC += $(QUANTUM_DIR)/split_common/transport.c
316         # Functions added via QUANTUM_LIB_SRC are only included in the final binary if they're called.
317         # Unused functions are pruned away, which is why we can add multiple drivers here without bloat.
318         QUANTUM_LIB_SRC += $(QUANTUM_DIR)/split_common/serial.c \
319                            i2c_master.c \
320                            i2c_slave.c
321     endif
322     COMMON_VPATH += $(QUANTUM_PATH)/split_common
323 endif