Parent directory

common_features.mk

36618 bytes
  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
 16QUANTUM_SRC += \
 17    $(QUANTUM_DIR)/quantum.c \
 18    $(QUANTUM_DIR)/bitwise.c \
 19    $(QUANTUM_DIR)/led.c \
 20    $(QUANTUM_DIR)/action.c \
 21    $(QUANTUM_DIR)/action_layer.c \
 22    $(QUANTUM_DIR)/action_tapping.c \
 23    $(QUANTUM_DIR)/action_util.c \
 24    $(QUANTUM_DIR)/eeconfig.c \
 25    $(QUANTUM_DIR)/keyboard.c \
 26    $(QUANTUM_DIR)/keymap_common.c \
 27    $(QUANTUM_DIR)/keycode_config.c \
 28    $(QUANTUM_DIR)/sync_timer.c \
 29    $(QUANTUM_DIR)/logging/debug.c \
 30    $(QUANTUM_DIR)/logging/sendchar.c \
 31    $(QUANTUM_DIR)/process_keycode/process_default_layer.c \
 32
 33VPATH += $(QUANTUM_DIR)/logging
 34# Fall back to lib/printf if there is no platform provided print
 35ifeq ("$(wildcard $(PLATFORM_PATH)/$(PLATFORM_KEY)/printf.mk)","")
 36    include $(QUANTUM_PATH)/logging/print.mk
 37else
 38    include $(PLATFORM_PATH)/$(PLATFORM_KEY)/printf.mk
 39endif
 40
 41ifeq ($(strip $(DEBUG_MATRIX_SCAN_RATE_ENABLE)), yes)
 42    OPT_DEFS += -DDEBUG_MATRIX_SCAN_RATE
 43    CONSOLE_ENABLE = yes
 44else ifeq ($(strip $(DEBUG_MATRIX_SCAN_RATE_ENABLE)), api)
 45    OPT_DEFS += -DDEBUG_MATRIX_SCAN_RATE
 46endif
 47
 48AUDIO_ENABLE ?= no
 49ifeq ($(strip $(AUDIO_ENABLE)), yes)
 50    ifeq ($(PLATFORM),CHIBIOS)
 51        AUDIO_DRIVER ?= dac_basic
 52        ifeq ($(strip $(AUDIO_DRIVER)), dac_basic)
 53            OPT_DEFS += -DAUDIO_DRIVER_DAC
 54        else ifeq ($(strip $(AUDIO_DRIVER)), dac_additive)
 55            OPT_DEFS += -DAUDIO_DRIVER_DAC
 56        ## stm32f2 and above have a usable DAC unit, f1 do not, and need to use pwm instead
 57        else ifeq ($(strip $(AUDIO_DRIVER)), pwm_software)
 58            OPT_DEFS += -DAUDIO_DRIVER_PWM
 59        else ifeq ($(strip $(AUDIO_DRIVER)), pwm_hardware)
 60            OPT_DEFS += -DAUDIO_DRIVER_PWM
 61        endif
 62    else
 63        # fallback for all other platforms is pwm
 64        AUDIO_DRIVER ?= pwm_hardware
 65        OPT_DEFS += -DAUDIO_DRIVER_PWM
 66    endif
 67    OPT_DEFS += -DAUDIO_ENABLE
 68    COMMON_VPATH += $(QUANTUM_PATH)/audio
 69    MUSIC_ENABLE = yes
 70    SRC += $(QUANTUM_DIR)/process_keycode/process_audio.c
 71    SRC += $(QUANTUM_DIR)/process_keycode/process_clicky.c
 72    SRC += $(QUANTUM_DIR)/audio/audio.c ## common audio code, hardware agnostic
 73    SRC += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/audio_$(strip $(AUDIO_DRIVER)).c
 74    SRC += $(QUANTUM_DIR)/audio/voices.c
 75    SRC += $(QUANTUM_DIR)/audio/luts.c
 76endif
 77
 78ifeq ($(strip $(SEQUENCER_ENABLE)), yes)
 79    MUSIC_ENABLE = yes
 80endif
 81
 82ifeq ($(strip $(MIDI_ENABLE)), yes)
 83    OPT_DEFS += -DMIDI_ENABLE
 84    MUSIC_ENABLE = yes
 85    COMMON_VPATH += $(QUANTUM_PATH)/midi
 86    SRC += $(QUANTUM_DIR)/midi/midi.c
 87    SRC += $(QUANTUM_DIR)/midi/midi_device.c
 88    SRC += $(QUANTUM_DIR)/midi/qmk_midi.c
 89    SRC += $(QUANTUM_DIR)/midi/sysex_tools.c
 90    SRC += $(QUANTUM_DIR)/midi/bytequeue/bytequeue.c
 91    SRC += $(QUANTUM_DIR)/midi/bytequeue/interrupt_setting.c
 92    SRC += $(QUANTUM_DIR)/process_keycode/process_midi.c
 93endif
 94
 95VALID_STENO_PROTOCOL_TYPES := geminipr txbolt all
 96STENO_PROTOCOL ?= all
 97ifeq ($(strip $(STENO_ENABLE)), yes)
 98    ifeq ($(filter $(STENO_PROTOCOL),$(VALID_STENO_PROTOCOL_TYPES)),)
 99        $(call CATASTROPHIC_ERROR,Invalid STENO_PROTOCOL,STENO_PROTOCOL="$(STENO_PROTOCOL)" is not a valid stenography protocol)
100    else
101        OPT_DEFS += -DSTENO_ENABLE
102        VIRTSER_ENABLE ?= yes
103
104        ifeq ($(strip $(STENO_PROTOCOL)), geminipr)
105            OPT_DEFS += -DSTENO_ENABLE_GEMINI
106        endif
107        ifeq ($(strip $(STENO_PROTOCOL)), txbolt)
108            OPT_DEFS += -DSTENO_ENABLE_BOLT
109        endif
110        ifeq ($(strip $(STENO_PROTOCOL)), all)
111            OPT_DEFS += -DSTENO_ENABLE_ALL
112            OPT_DEFS += -DSTENO_ENABLE_GEMINI
113            OPT_DEFS += -DSTENO_ENABLE_BOLT
114        endif
115
116        SRC += $(QUANTUM_DIR)/process_keycode/process_steno.c
117    endif
118endif
119
120ifeq ($(strip $(MOUSEKEY_ENABLE)), yes)
121    MOUSE_ENABLE := yes
122endif
123
124VALID_POINTING_DEVICE_DRIVER_TYPES := adns5050 adns9800 analog_joystick azoteq_iqs5xx cirque_pinnacle_i2c cirque_pinnacle_spi paw3204 pmw3320 pmw3360 pmw3389 pimoroni_trackball custom
125ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
126    ifeq ($(filter $(POINTING_DEVICE_DRIVER),$(VALID_POINTING_DEVICE_DRIVER_TYPES)),)
127        $(call CATASTROPHIC_ERROR,Invalid POINTING_DEVICE_DRIVER,POINTING_DEVICE_DRIVER="$(POINTING_DEVICE_DRIVER)" is not a valid pointing device type)
128    else
129        OPT_DEFS += -DPOINTING_DEVICE_ENABLE
130        MOUSE_ENABLE := yes
131        VPATH += $(QUANTUM_DIR)/pointing_device
132        SRC += $(QUANTUM_DIR)/pointing_device/pointing_device.c
133        SRC += $(QUANTUM_DIR)/pointing_device/pointing_device_auto_mouse.c
134        ifneq ($(strip $(POINTING_DEVICE_DRIVER)), custom)
135            SRC += drivers/sensors/$(strip $(POINTING_DEVICE_DRIVER)).c
136            OPT_DEFS += -DPOINTING_DEVICE_DRIVER_$(strip $(shell echo $(POINTING_DEVICE_DRIVER) | tr '[:lower:]' '[:upper:]'))
137        endif
138        OPT_DEFS += -DPOINTING_DEVICE_DRIVER_$(strip $(POINTING_DEVICE_DRIVER))
139        OPT_DEFS += -DPOINTING_DEVICE_DRIVER_NAME=$(strip $(POINTING_DEVICE_DRIVER))
140        ifeq ($(strip $(POINTING_DEVICE_DRIVER)), adns9800)
141            SPI_DRIVER_REQUIRED = yes
142        else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), analog_joystick)
143            ANALOG_DRIVER_REQUIRED = yes
144        else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), azoteq_iqs5xx)
145            I2C_DRIVER_REQUIRED = yes
146        else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), cirque_pinnacle_i2c)
147            I2C_DRIVER_REQUIRED = yes
148            SRC += drivers/sensors/cirque_pinnacle.c
149            SRC += drivers/sensors/cirque_pinnacle_gestures.c
150            SRC += $(QUANTUM_DIR)/pointing_device/pointing_device_gestures.c
151        else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), cirque_pinnacle_spi)
152            SPI_DRIVER_REQUIRED = yes
153            SRC += drivers/sensors/cirque_pinnacle.c
154            SRC += drivers/sensors/cirque_pinnacle_gestures.c
155            SRC += $(QUANTUM_DIR)/pointing_device/pointing_device_gestures.c
156        else ifeq ($(strip $(POINTING_DEVICE_DRIVER)), pimoroni_trackball)
157            I2C_DRIVER_REQUIRED = yes
158        else ifneq ($(filter $(strip $(POINTING_DEVICE_DRIVER)),pmw3360 pmw3389),)
159            SPI_DRIVER_REQUIRED = yes
160            SRC += drivers/sensors/pmw33xx_common.c
161        endif
162    endif
163endif
164
165QUANTUM_PAINTER_ENABLE ?= no
166ifeq ($(strip $(QUANTUM_PAINTER_ENABLE)), yes)
167    include $(QUANTUM_DIR)/painter/rules.mk
168endif
169
170VALID_EEPROM_DRIVER_TYPES := vendor custom transient i2c spi wear_leveling legacy_stm32_flash
171EEPROM_DRIVER ?= vendor
172ifeq ($(filter $(EEPROM_DRIVER),$(VALID_EEPROM_DRIVER_TYPES)),)
173  $(call CATASTROPHIC_ERROR,Invalid EEPROM_DRIVER,EEPROM_DRIVER="$(EEPROM_DRIVER)" is not a valid EEPROM driver)
174else
175  OPT_DEFS += -DEEPROM_ENABLE
176  COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/eeprom
177  COMMON_VPATH += $(DRIVER_PATH)/eeprom
178  COMMON_VPATH += $(PLATFORM_COMMON_DIR)
179  ifeq ($(strip $(EEPROM_DRIVER)), custom)
180    # Custom EEPROM implementation -- only needs to implement init/erase/read_block/write_block
181    OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_CUSTOM
182    SRC += eeprom_driver.c
183  else ifeq ($(strip $(EEPROM_DRIVER)), wear_leveling)
184    # Wear-leveling EEPROM implementation
185    OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_WEAR_LEVELING
186    SRC += eeprom_driver.c eeprom_wear_leveling.c
187  else ifeq ($(strip $(EEPROM_DRIVER)), i2c)
188    # External I2C EEPROM implementation
189    OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_I2C
190    I2C_DRIVER_REQUIRED = yes
191    SRC += eeprom_driver.c eeprom_i2c.c
192  else ifeq ($(strip $(EEPROM_DRIVER)), spi)
193    # External SPI EEPROM implementation
194    OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_SPI
195    SPI_DRIVER_REQUIRED = yes
196    SRC += eeprom_driver.c eeprom_spi.c
197  else ifeq ($(strip $(EEPROM_DRIVER)), legacy_stm32_flash)
198    # STM32 Emulated EEPROM, backed by MCU flash (soon to be deprecated)
199    OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_LEGACY_EMULATED_FLASH
200    COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/flash
201    COMMON_VPATH += $(DRIVER_PATH)/flash
202    SRC += eeprom_driver.c eeprom_legacy_emulated_flash.c legacy_flash_ops.c
203  else ifeq ($(strip $(EEPROM_DRIVER)), transient)
204    # Transient EEPROM implementation -- no data storage but provides runtime area for it
205    OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_TRANSIENT
206    SRC += eeprom_driver.c eeprom_transient.c
207  else ifeq ($(strip $(EEPROM_DRIVER)), vendor)
208    # Vendor-implemented EEPROM
209    OPT_DEFS += -DEEPROM_VENDOR
210    ifeq ($(PLATFORM),AVR)
211      # Automatically provided by avr-libc, nothing required
212    else ifeq ($(PLATFORM),CHIBIOS)
213      ifneq ($(filter %_STM32F072xB %_STM32F042x6, $(MCU_SERIES)_$(MCU_LDSCRIPT)),)
214        # STM32 Emulated EEPROM, backed by MCU flash (soon to be deprecated)
215        OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_LEGACY_EMULATED_FLASH
216        COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/flash
217        COMMON_VPATH += $(DRIVER_PATH)/flash
218        SRC += eeprom_driver.c eeprom_legacy_emulated_flash.c legacy_flash_ops.c
219      else ifneq ($(filter $(MCU_SERIES),STM32F1xx STM32F3xx STM32F4xx STM32L4xx STM32G4xx WB32F3G71xx WB32FQ95xx AT32F415 GD32VF103),)
220        # Wear-leveling EEPROM implementation, backed by MCU flash
221        OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_WEAR_LEVELING
222        SRC += eeprom_driver.c eeprom_wear_leveling.c
223        WEAR_LEVELING_DRIVER ?= embedded_flash
224      else ifneq ($(filter $(MCU_SERIES),STM32L0xx STM32L1xx),)
225        # True EEPROM on STM32L0xx, L1xx
226        OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_STM32_L0_L1
227        SRC += eeprom_driver.c eeprom_stm32_L0_L1.c
228      else ifneq ($(filter $(MCU_SERIES),RP2040),)
229        # Wear-leveling EEPROM implementation, backed by RP2040 flash
230        OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_WEAR_LEVELING
231        SRC += eeprom_driver.c eeprom_wear_leveling.c
232        WEAR_LEVELING_DRIVER ?= rp2040_flash
233      else ifneq ($(filter $(MCU_SERIES),KL2x K20x),)
234        # Teensy EEPROM implementations
235        OPT_DEFS += -DEEPROM_KINETIS_FLEXRAM
236        SRC += eeprom_kinetis_flexram.c
237      else
238        # Fall back to transient, i.e. non-persistent
239        OPT_DEFS += -DEEPROM_DRIVER -DEEPROM_TRANSIENT
240        SRC += eeprom_driver.c eeprom_transient.c
241      endif
242    else ifeq ($(PLATFORM),TEST)
243      # Test harness "EEPROM"
244      OPT_DEFS += -DEEPROM_TEST_HARNESS
245      SRC += eeprom.c
246    endif
247  endif
248endif
249
250VALID_WEAR_LEVELING_DRIVER_TYPES := custom embedded_flash spi_flash rp2040_flash legacy
251WEAR_LEVELING_DRIVER ?= none
252ifneq ($(strip $(WEAR_LEVELING_DRIVER)),none)
253  ifeq ($(filter $(WEAR_LEVELING_DRIVER),$(VALID_WEAR_LEVELING_DRIVER_TYPES)),)
254    $(call CATASTROPHIC_ERROR,Invalid WEAR_LEVELING_DRIVER,WEAR_LEVELING_DRIVER="$(WEAR_LEVELING_DRIVER)" is not a valid wear leveling driver)
255  else
256    FNV_ENABLE := yes
257    OPT_DEFS += -DWEAR_LEVELING_ENABLE
258    OPT_DEFS += -DWEAR_LEVELING_$(strip $(shell echo $(WEAR_LEVELING_DRIVER) | tr '[:lower:]' '[:upper:]'))
259    COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/wear_leveling
260    COMMON_VPATH += $(DRIVER_PATH)/wear_leveling
261    COMMON_VPATH += $(QUANTUM_DIR)/wear_leveling
262    SRC += wear_leveling.c
263    ifeq ($(strip $(WEAR_LEVELING_DRIVER)), embedded_flash)
264      OPT_DEFS += -DHAL_USE_EFL
265      SRC += wear_leveling_efl.c
266      POST_CONFIG_H += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/wear_leveling/wear_leveling_efl_config.h
267    else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), spi_flash)
268      FLASH_DRIVER := spi
269      SRC += wear_leveling_flash_spi.c
270      POST_CONFIG_H += $(DRIVER_PATH)/wear_leveling/wear_leveling_flash_spi_config.h
271    else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), rp2040_flash)
272      SRC += wear_leveling_rp2040_flash.c
273      POST_CONFIG_H += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_PATH)/wear_leveling/wear_leveling_rp2040_flash_config.h
274    else ifeq ($(strip $(WEAR_LEVELING_DRIVER)), legacy)
275      COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/flash
276      SRC += legacy_flash_ops.c wear_leveling_legacy.c
277      POST_CONFIG_H += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/wear_leveling/wear_leveling_legacy_config.h
278    endif
279  endif
280endif
281
282VALID_FLASH_DRIVER_TYPES := spi custom
283FLASH_DRIVER ?= none
284ifneq ($(strip $(FLASH_DRIVER)), none)
285    ifeq ($(filter $(FLASH_DRIVER),$(VALID_FLASH_DRIVER_TYPES)),)
286        $(call CATASTROPHIC_ERROR,Invalid FLASH_DRIVER,FLASH_DRIVER="$(FLASH_DRIVER)" is not a valid flash driver)
287    else
288        OPT_DEFS += -DFLASH_ENABLE -DFLASH_DRIVER -DFLASH_DRIVER_$(strip $(shell echo $(FLASH_DRIVER) | tr '[:lower:]' '[:upper:]'))
289		COMMON_VPATH += $(DRIVER_PATH)/flash
290        ifeq ($(strip $(FLASH_DRIVER)),spi)
291            SRC += flash_spi.c
292            SPI_DRIVER_REQUIRED = yes
293        endif
294    endif
295endif
296
297RGBLIGHT_ENABLE ?= no
298VALID_RGBLIGHT_TYPES := ws2812 apa102 custom
299
300ifeq ($(strip $(RGBLIGHT_ENABLE)), yes)
301    RGBLIGHT_DRIVER ?= ws2812
302
303    ifeq ($(filter $(RGBLIGHT_DRIVER),$(VALID_RGBLIGHT_TYPES)),)
304        $(call CATASTROPHIC_ERROR,Invalid RGBLIGHT_DRIVER,RGBLIGHT_DRIVER="$(RGBLIGHT_DRIVER)" is not a valid RGB type)
305    else
306        COMMON_VPATH += $(QUANTUM_DIR)/rgblight
307        POST_CONFIG_H += $(QUANTUM_DIR)/rgblight/rgblight_post_config.h
308        OPT_DEFS += -DRGBLIGHT_ENABLE
309        OPT_DEFS += -DRGBLIGHT_$(strip $(shell echo $(RGBLIGHT_DRIVER) | tr '[:lower:]' '[:upper:]'))
310        SRC += $(QUANTUM_DIR)/process_keycode/process_underglow.c
311        SRC += $(QUANTUM_DIR)/color.c
312        SRC += $(QUANTUM_DIR)/rgblight/rgblight.c
313        SRC += $(QUANTUM_DIR)/rgblight/rgblight_drivers.c
314        CIE1931_CURVE := yes
315    endif
316
317    ifeq ($(strip $(RGBLIGHT_DRIVER)), ws2812)
318        WS2812_DRIVER_REQUIRED := yes
319    endif
320
321    ifeq ($(strip $(RGBLIGHT_DRIVER)), apa102)
322        APA102_DRIVER_REQUIRED := yes
323    endif
324
325    ifeq ($(strip $(VELOCIKEY_ENABLE)), yes)
326        OPT_DEFS += -DVELOCIKEY_ENABLE
327    endif
328endif
329
330# Deprecated driver names - do not use
331ifeq ($(strip $(LED_MATRIX_DRIVER)), aw20216)
332LED_MATRIX_DRIVER := aw20216s
333endif
334ifeq ($(strip $(LED_MATRIX_DRIVER)), ckled2001)
335LED_MATRIX_DRIVER := snled27351
336endif
337
338LED_MATRIX_ENABLE ?= no
339VALID_LED_MATRIX_TYPES := is31fl3218 is31fl3236 is31fl3729 is31fl3731 is31fl3733 is31fl3736 is31fl3737 is31fl3741 is31fl3742a is31fl3743a is31fl3745 is31fl3746a snled27351 custom
340
341ifeq ($(strip $(LED_MATRIX_ENABLE)), yes)
342    ifeq ($(filter $(LED_MATRIX_DRIVER),$(VALID_LED_MATRIX_TYPES)),)
343        $(call CATASTROPHIC_ERROR,Invalid LED_MATRIX_DRIVER,LED_MATRIX_DRIVER="$(LED_MATRIX_DRIVER)" is not a valid matrix type)
344    endif
345    OPT_DEFS += -DLED_MATRIX_ENABLE
346    OPT_DEFS += -DLED_MATRIX_$(strip $(shell echo $(LED_MATRIX_DRIVER) | tr '[:lower:]' '[:upper:]'))
347
348    COMMON_VPATH += $(QUANTUM_DIR)/led_matrix
349    COMMON_VPATH += $(QUANTUM_DIR)/led_matrix/animations
350    COMMON_VPATH += $(QUANTUM_DIR)/led_matrix/animations/runners
351    POST_CONFIG_H += $(QUANTUM_DIR)/led_matrix/post_config.h
352    SRC += $(QUANTUM_DIR)/process_keycode/process_led_matrix.c
353    SRC += $(QUANTUM_DIR)/led_matrix/led_matrix.c
354    SRC += $(QUANTUM_DIR)/led_matrix/led_matrix_drivers.c
355    LIB8TION_ENABLE := yes
356    CIE1931_CURVE := yes
357
358    ifeq ($(strip $(LED_MATRIX_DRIVER)), is31fl3218)
359        I2C_DRIVER_REQUIRED = yes
360        COMMON_VPATH += $(DRIVER_PATH)/led/issi
361        SRC += is31fl3218-mono.c
362    endif
363
364    ifeq ($(strip $(LED_MATRIX_DRIVER)), is31fl3236)
365        I2C_DRIVER_REQUIRED = yes
366        COMMON_VPATH += $(DRIVER_PATH)/led/issi
367        SRC += is31fl3236-mono.c
368    endif
369
370    ifeq ($(strip $(LED_MATRIX_DRIVER)), is31fl3729)
371        I2C_DRIVER_REQUIRED = yes
372        COMMON_VPATH += $(DRIVER_PATH)/led/issi
373        SRC += is31fl3729-mono.c
374    endif
375
376    ifeq ($(strip $(LED_MATRIX_DRIVER)), is31fl3731)
377        I2C_DRIVER_REQUIRED = yes
378        COMMON_VPATH += $(DRIVER_PATH)/led/issi
379        SRC += is31fl3731-mono.c
380    endif
381
382    ifeq ($(strip $(LED_MATRIX_DRIVER)), is31fl3733)
383        I2C_DRIVER_REQUIRED = yes
384        COMMON_VPATH += $(DRIVER_PATH)/led/issi
385        SRC += is31fl3733-mono.c
386    endif
387
388    ifeq ($(strip $(LED_MATRIX_DRIVER)), is31fl3736)
389        I2C_DRIVER_REQUIRED = yes
390        COMMON_VPATH += $(DRIVER_PATH)/led/issi
391        SRC += is31fl3736-mono.c
392    endif
393
394    ifeq ($(strip $(LED_MATRIX_DRIVER)), is31fl3737)
395        I2C_DRIVER_REQUIRED = yes
396        COMMON_VPATH += $(DRIVER_PATH)/led/issi
397        SRC += is31fl3737-mono.c
398    endif
399
400    ifeq ($(strip $(LED_MATRIX_DRIVER)), is31fl3741)
401        I2C_DRIVER_REQUIRED = yes
402        COMMON_VPATH += $(DRIVER_PATH)/led/issi
403        SRC += is31fl3741-mono.c
404    endif
405
406    ifeq ($(strip $(LED_MATRIX_DRIVER)), is31fl3742a)
407        I2C_DRIVER_REQUIRED = yes
408        COMMON_VPATH += $(DRIVER_PATH)/led/issi
409        SRC += is31fl3742a-mono.c
410    endif
411
412    ifeq ($(strip $(LED_MATRIX_DRIVER)), is31fl3743a)
413        I2C_DRIVER_REQUIRED = yes
414        COMMON_VPATH += $(DRIVER_PATH)/led/issi
415        SRC += is31fl3743a-mono.c
416    endif
417
418    ifeq ($(strip $(LED_MATRIX_DRIVER)), is31fl3745)
419        I2C_DRIVER_REQUIRED = yes
420        COMMON_VPATH += $(DRIVER_PATH)/led/issi
421        SRC += is31fl3745-mono.c
422    endif
423
424    ifeq ($(strip $(LED_MATRIX_DRIVER)), is31fl3746a)
425        I2C_DRIVER_REQUIRED = yes
426        COMMON_VPATH += $(DRIVER_PATH)/led/issi
427        SRC += is31fl3746a-mono.c
428    endif
429
430    ifeq ($(strip $(LED_MATRIX_DRIVER)), snled27351)
431        I2C_DRIVER_REQUIRED = yes
432        COMMON_VPATH += $(DRIVER_PATH)/led
433        SRC += snled27351-mono.c
434    endif
435
436    ifeq ($(strip $(LED_MATRIX_CUSTOM_KB)), yes)
437        OPT_DEFS += -DLED_MATRIX_CUSTOM_KB
438    endif
439
440    ifeq ($(strip $(LED_MATRIX_CUSTOM_USER)), yes)
441        OPT_DEFS += -DLED_MATRIX_CUSTOM_USER
442    endif
443endif
444
445# Deprecated driver names - do not use
446ifeq ($(strip $(RGB_MATRIX_DRIVER)), aw20216)
447RGB_MATRIX_DRIVER := aw20216s
448endif
449ifeq ($(strip $(RGB_MATRIX_DRIVER)), ckled2001)
450RGB_MATRIX_DRIVER := snled27351
451endif
452
453RGB_MATRIX_ENABLE ?= no
454
455VALID_RGB_MATRIX_TYPES := aw20216s is31fl3218 is31fl3236 is31fl3729 is31fl3731 is31fl3733 is31fl3736 is31fl3737 is31fl3741 is31fl3742a is31fl3743a is31fl3745 is31fl3746a snled27351 ws2812 custom
456ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
457    ifeq ($(filter $(RGB_MATRIX_DRIVER),$(VALID_RGB_MATRIX_TYPES)),)
458        $(call CATASTROPHIC_ERROR,Invalid RGB_MATRIX_DRIVER,RGB_MATRIX_DRIVER="$(RGB_MATRIX_DRIVER)" is not a valid matrix type)
459    endif
460    OPT_DEFS += -DRGB_MATRIX_ENABLE
461    OPT_DEFS += -DRGB_MATRIX_$(strip $(shell echo $(RGB_MATRIX_DRIVER) | tr '[:lower:]' '[:upper:]'))
462
463    COMMON_VPATH += $(QUANTUM_DIR)/rgb_matrix
464    COMMON_VPATH += $(QUANTUM_DIR)/rgb_matrix/animations
465    COMMON_VPATH += $(QUANTUM_DIR)/rgb_matrix/animations/runners
466    POST_CONFIG_H += $(QUANTUM_DIR)/rgb_matrix/post_config.h
467
468    # TODO: Remove this
469    SRC += $(QUANTUM_DIR)/process_keycode/process_underglow.c
470
471    SRC += $(QUANTUM_DIR)/process_keycode/process_rgb_matrix.c
472    SRC += $(QUANTUM_DIR)/color.c
473    SRC += $(QUANTUM_DIR)/rgb_matrix/rgb_matrix.c
474    SRC += $(QUANTUM_DIR)/rgb_matrix/rgb_matrix_drivers.c
475    LIB8TION_ENABLE := yes
476    CIE1931_CURVE := yes
477
478    ifeq ($(strip $(RGB_MATRIX_DRIVER)), aw20216s)
479        SPI_DRIVER_REQUIRED = yes
480        COMMON_VPATH += $(DRIVER_PATH)/led
481        SRC += aw20216s.c
482    endif
483
484    ifeq ($(strip $(RGB_MATRIX_DRIVER)), is31fl3218)
485        I2C_DRIVER_REQUIRED = yes
486        COMMON_VPATH += $(DRIVER_PATH)/led/issi
487        SRC += is31fl3218.c
488    endif
489
490    ifeq ($(strip $(RGB_MATRIX_DRIVER)), is31fl3236)
491        I2C_DRIVER_REQUIRED = yes
492        COMMON_VPATH += $(DRIVER_PATH)/led/issi
493        SRC += is31fl3236.c
494    endif
495
496    ifeq ($(strip $(RGB_MATRIX_DRIVER)), is31fl3729)
497        I2C_DRIVER_REQUIRED = yes
498        COMMON_VPATH += $(DRIVER_PATH)/led/issi
499        SRC += is31fl3729.c
500    endif
501
502    ifeq ($(strip $(RGB_MATRIX_DRIVER)), is31fl3731)
503        I2C_DRIVER_REQUIRED = yes
504        COMMON_VPATH += $(DRIVER_PATH)/led/issi
505        SRC += is31fl3731.c
506    endif
507
508    ifeq ($(strip $(RGB_MATRIX_DRIVER)), is31fl3733)
509        I2C_DRIVER_REQUIRED = yes
510        COMMON_VPATH += $(DRIVER_PATH)/led/issi
511        SRC += is31fl3733.c
512    endif
513
514    ifeq ($(strip $(RGB_MATRIX_DRIVER)), is31fl3736)
515        I2C_DRIVER_REQUIRED = yes
516        COMMON_VPATH += $(DRIVER_PATH)/led/issi
517        SRC += is31fl3736.c
518    endif
519
520    ifeq ($(strip $(RGB_MATRIX_DRIVER)), is31fl3737)
521        I2C_DRIVER_REQUIRED = yes
522        COMMON_VPATH += $(DRIVER_PATH)/led/issi
523        SRC += is31fl3737.c
524    endif
525
526    ifeq ($(strip $(RGB_MATRIX_DRIVER)), is31fl3741)
527        I2C_DRIVER_REQUIRED = yes
528        COMMON_VPATH += $(DRIVER_PATH)/led/issi
529        SRC += is31fl3741.c
530    endif
531
532    ifeq ($(strip $(RGB_MATRIX_DRIVER)), is31fl3742a)
533        I2C_DRIVER_REQUIRED = yes
534        COMMON_VPATH += $(DRIVER_PATH)/led/issi
535        SRC += is31fl3742a.c
536    endif
537
538    ifeq ($(strip $(RGB_MATRIX_DRIVER)), is31fl3743a)
539        I2C_DRIVER_REQUIRED = yes
540        COMMON_VPATH += $(DRIVER_PATH)/led/issi
541        SRC += is31fl3743a.c
542    endif
543
544    ifeq ($(strip $(RGB_MATRIX_DRIVER)), is31fl3745)
545        I2C_DRIVER_REQUIRED = yes
546        COMMON_VPATH += $(DRIVER_PATH)/led/issi
547        SRC += is31fl3745.c
548    endif
549
550    ifeq ($(strip $(RGB_MATRIX_DRIVER)), is31fl3746a)
551        I2C_DRIVER_REQUIRED = yes
552        COMMON_VPATH += $(DRIVER_PATH)/led/issi
553        SRC += is31fl3746a.c
554    endif
555
556    ifeq ($(strip $(RGB_MATRIX_DRIVER)), snled27351)
557        I2C_DRIVER_REQUIRED = yes
558        COMMON_VPATH += $(DRIVER_PATH)/led
559        SRC += snled27351.c
560    endif
561
562    ifeq ($(strip $(RGB_MATRIX_DRIVER)), ws2812)
563        WS2812_DRIVER_REQUIRED := yes
564    endif
565
566    ifeq ($(strip $(RGB_MATRIX_DRIVER)), apa102)
567        APA102_DRIVER_REQUIRED := yes
568    endif
569
570    ifeq ($(strip $(RGB_MATRIX_CUSTOM_KB)), yes)
571        OPT_DEFS += -DRGB_MATRIX_CUSTOM_KB
572    endif
573
574    ifeq ($(strip $(RGB_MATRIX_CUSTOM_USER)), yes)
575        OPT_DEFS += -DRGB_MATRIX_CUSTOM_USER
576    endif
577endif
578
579VARIABLE_TRACE ?= no
580ifneq ($(strip $(VARIABLE_TRACE)),no)
581    SRC += $(QUANTUM_DIR)/variable_trace.c
582    OPT_DEFS += -DNUM_TRACED_VARIABLES=$(strip $(VARIABLE_TRACE))
583    ifneq ($(strip $(MAX_VARIABLE_TRACE_SIZE)),)
584        OPT_DEFS += -DMAX_VARIABLE_TRACE_SIZE=$(strip $(MAX_VARIABLE_TRACE_SIZE))
585    endif
586endif
587
588ifeq ($(strip $(SLEEP_LED_ENABLE)), yes)
589    SRC += $(PLATFORM_COMMON_DIR)/sleep_led.c
590    OPT_DEFS += -DSLEEP_LED_ENABLE
591
592    NO_SUSPEND_POWER_DOWN := yes
593endif
594
595VALID_BACKLIGHT_TYPES := pwm timer software custom
596
597BACKLIGHT_ENABLE ?= no
598BACKLIGHT_DRIVER ?= pwm
599ifeq ($(strip $(BACKLIGHT_ENABLE)), yes)
600    ifeq ($(filter $(BACKLIGHT_DRIVER),$(VALID_BACKLIGHT_TYPES)),)
601        $(call CATASTROPHIC_ERROR,Invalid BACKLIGHT_DRIVER,BACKLIGHT_DRIVER="$(BACKLIGHT_DRIVER)" is not a valid backlight type)
602    endif
603
604    COMMON_VPATH += $(QUANTUM_DIR)/backlight
605    COMMON_VPATH += $(DRIVER_PATH)/backlight
606    SRC += $(QUANTUM_DIR)/backlight/backlight.c
607    SRC += $(QUANTUM_DIR)/process_keycode/process_backlight.c
608    OPT_DEFS += -DBACKLIGHT_ENABLE
609    OPT_DEFS += -DBACKLIGHT_$(strip $(shell echo $(BACKLIGHT_DRIVER) | tr '[:lower:]' '[:upper:]'))
610
611    ifneq ($(strip $(BACKLIGHT_DRIVER)), custom)
612        SRC += $(QUANTUM_DIR)/backlight/backlight_driver_common.c
613
614        ifeq ($(strip $(BACKLIGHT_DRIVER)), software)
615            SRC += $(DRIVER_PATH)/backlight/backlight_software.c
616        else
617            SRC += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/backlight_$(strip $(BACKLIGHT_DRIVER)).c
618        endif
619    endif
620endif
621
622ifeq ($(strip $(CIE1931_CURVE)), yes)
623    OPT_DEFS += -DUSE_CIE1931_CURVE
624    LED_TABLES := yes
625endif
626
627ifeq ($(strip $(LED_TABLES)), yes)
628    SRC += $(QUANTUM_DIR)/led_tables.c
629endif
630
631ifeq ($(strip $(VIA_ENABLE)), yes)
632    DYNAMIC_KEYMAP_ENABLE := yes
633    RAW_ENABLE := yes
634    BOOTMAGIC_ENABLE := yes
635    TRI_LAYER_ENABLE := yes
636endif
637
638VALID_CUSTOM_MATRIX_TYPES:= yes lite no
639
640CUSTOM_MATRIX ?= no
641ifneq ($(strip $(CUSTOM_MATRIX)), yes)
642    ifeq ($(filter $(CUSTOM_MATRIX),$(VALID_CUSTOM_MATRIX_TYPES)),)
643        $(call CATASTROPHIC_ERROR,Invalid CUSTOM_MATRIX,CUSTOM_MATRIX="$(CUSTOM_MATRIX)" is not a valid custom matrix type)
644    endif
645
646    # Include common stuff for all non custom matrix users
647    QUANTUM_SRC += $(QUANTUM_DIR)/matrix_common.c
648
649    # if 'lite' then skip the actual matrix implementation
650    ifneq ($(strip $(CUSTOM_MATRIX)), lite)
651        # Include the standard or split matrix code if needed
652        QUANTUM_SRC += $(QUANTUM_DIR)/matrix.c
653    endif
654endif
655
656# Debounce Modules. Set DEBOUNCE_TYPE=custom if including one manually.
657DEBOUNCE_TYPE ?= sym_defer_g
658ifneq ($(strip $(DEBOUNCE_TYPE)), custom)
659    QUANTUM_SRC += $(QUANTUM_DIR)/debounce/$(strip $(DEBOUNCE_TYPE)).c
660endif
661
662
663VALID_SERIAL_DRIVER_TYPES := bitbang usart vendor
664
665SERIAL_DRIVER ?= bitbang
666ifeq ($(filter $(SERIAL_DRIVER),$(VALID_SERIAL_DRIVER_TYPES)),)
667    $(call CATASTROPHIC_ERROR,Invalid SERIAL_DRIVER,SERIAL_DRIVER="$(SERIAL_DRIVER)" is not a valid SERIAL driver)
668endif
669
670ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
671    POST_CONFIG_H += $(QUANTUM_DIR)/split_common/post_config.h
672    OPT_DEFS += -DSPLIT_KEYBOARD
673    CRC_ENABLE := yes
674
675    # Include files used by all split keyboards
676    QUANTUM_SRC += $(QUANTUM_DIR)/split_common/split_util.c
677
678    # Determine which (if any) transport files are required
679    ifneq ($(strip $(SPLIT_TRANSPORT)), custom)
680        QUANTUM_SRC += $(QUANTUM_DIR)/split_common/transport.c \
681                       $(QUANTUM_DIR)/split_common/transactions.c
682
683        OPT_DEFS += -DSPLIT_COMMON_TRANSACTIONS
684
685        # Functions added via QUANTUM_LIB_SRC are only included in the final binary if they're called.
686        # Unused functions are pruned away, which is why we can add multiple drivers here without bloat.
687        ifeq ($(PLATFORM),AVR)
688            ifneq ($(NO_I2C),yes)
689                QUANTUM_LIB_SRC += i2c_master.c \
690                                   i2c_slave.c
691            endif
692        endif
693
694        OPT_DEFS += -DSERIAL_DRIVER_$(strip $(shell echo $(SERIAL_DRIVER) | tr '[:lower:]' '[:upper:]'))
695        ifeq ($(strip $(SERIAL_DRIVER)), bitbang)
696            QUANTUM_LIB_SRC += serial.c
697        else
698            QUANTUM_LIB_SRC += serial_protocol.c
699            QUANTUM_LIB_SRC += serial_$(strip $(SERIAL_DRIVER)).c
700        endif
701    endif
702    COMMON_VPATH += $(QUANTUM_PATH)/split_common
703endif
704
705ifeq ($(strip $(FNV_ENABLE)), yes)
706    OPT_DEFS += -DFNV_ENABLE
707    VPATH += $(LIB_PATH)/fnv
708    SRC += qmk_fnv_type_validation.c hash_32a.c hash_64a.c
709endif
710
711ifeq ($(strip $(LIB8TION_ENABLE)), yes)
712    ifneq (,$(filter $(MCU), atmega16u2 atmega32u2 at90usb162))
713        # ATmegaxxU2 does not have hardware MUL instruction - lib8tion must be told to use software multiplication routines
714        OPT_DEFS += -DLIB8_ATTINY
715    endif
716    SRC += $(LIB_PATH)/lib8tion/lib8tion.c
717endif
718
719VALID_HAPTIC_DRIVER_TYPES := drv2605l solenoid
720ifeq ($(strip $(HAPTIC_ENABLE)),yes)
721    ifeq ($(filter $(HAPTIC_DRIVER),$(VALID_HAPTIC_DRIVER_TYPES)),)
722        $(call CATASTROPHIC_ERROR,Invalid HAPTIC_DRIVER,HAPTIC_DRIVER="$(HAPTIC_DRIVER)" is not a valid Haptic driver)
723    else
724        OPT_DEFS += -DHAPTIC_$(strip $(shell echo $(HAPTIC_DRIVER) | tr '[:lower:]' '[:upper:]'))
725        COMMON_VPATH += $(DRIVER_PATH)/haptic
726
727        ifeq ($(strip $(HAPTIC_DRIVER)), drv2605l)
728            I2C_DRIVER_REQUIRED = yes
729            SRC += drv2605l.c
730        endif
731
732        ifeq ($(strip $(HAPTIC_DRIVER)), solenoid)
733            SRC += solenoid.c
734        endif
735    endif
736endif
737
738ifeq ($(strip $(HD44780_ENABLE)), yes)
739    OPT_DEFS += -DHD44780_ENABLE
740    COMMON_VPATH += $(DRIVER_PATH)/lcd
741    SRC += hd44780.c
742endif
743
744VALID_OLED_DRIVER_TYPES := custom ssd1306
745OLED_DRIVER ?= ssd1306
746VALID_OLED_TRANSPORT_TYPES := i2c spi custom
747OLED_TRANSPORT ?= i2c
748ifeq ($(strip $(OLED_ENABLE)), yes)
749    ifeq ($(filter $(OLED_DRIVER),$(VALID_OLED_DRIVER_TYPES)),)
750        $(call CATASTROPHIC_ERROR,Invalid OLED_DRIVER,OLED_DRIVER="$(OLED_DRIVER)" is not a valid OLED driver)
751    else
752        ifeq ($(filter $(OLED_TRANSPORT),$(VALID_OLED_TRANSPORT_TYPES)),)
753            $(call CATASTROPHIC_ERROR,Invalid OLED_TRANSPORT,OLED_TRANSPORT="$(OLED_TRANSPORT)" is not a valid OLED transport)
754        else
755            OPT_DEFS += -DOLED_ENABLE
756            OPT_DEFS += -DOLED_$(strip $(shell echo $(OLED_DRIVER) | tr '[:lower:]' '[:upper:]'))
757            COMMON_VPATH += $(DRIVER_PATH)/oled
758            ifneq ($(strip $(OLED_DRIVER)), custom)
759                SRC += oled_driver.c
760            endif
761
762            OPT_DEFS += -DOLED_TRANSPORT_$(strip $(shell echo $(OLED_TRANSPORT) | tr '[:lower:]' '[:upper:]'))
763            ifeq ($(strip $(OLED_TRANSPORT)), i2c)
764                I2C_DRIVER_REQUIRED = yes
765            endif
766            ifeq ($(strip $(OLED_TRANSPORT)), spi)
767                SPI_DRIVER_REQUIRED = yes
768            endif
769        endif
770    endif
771endif
772
773ifeq ($(strip $(ST7565_ENABLE)), yes)
774    OPT_DEFS += -DST7565_ENABLE
775    SPI_DRIVER_REQUIRED = yes
776    COMMON_VPATH += $(DRIVER_PATH)/oled # For glcdfont.h
777    COMMON_VPATH += $(DRIVER_PATH)/lcd
778    SRC += st7565.c
779endif
780
781ifeq ($(strip $(UCIS_ENABLE)), yes)
782    OPT_DEFS += -DUCIS_ENABLE
783    UNICODE_COMMON := yes
784    SRC += $(QUANTUM_DIR)/process_keycode/process_ucis.c \
785           $(QUANTUM_DIR)/unicode/ucis.c
786endif
787
788ifeq ($(strip $(UNICODEMAP_ENABLE)), yes)
789    OPT_DEFS += -DUNICODEMAP_ENABLE
790    UNICODE_COMMON := yes
791    SRC += $(QUANTUM_DIR)/process_keycode/process_unicodemap.c \
792           $(QUANTUM_DIR)/unicode/unicodemap.c
793endif
794
795ifeq ($(strip $(UNICODE_ENABLE)), yes)
796    OPT_DEFS += -DUNICODE_ENABLE
797    UNICODE_COMMON := yes
798    SRC += $(QUANTUM_DIR)/process_keycode/process_unicode.c
799endif
800
801ifeq ($(strip $(UNICODE_COMMON)), yes)
802    OPT_DEFS += -DUNICODE_COMMON_ENABLE
803    COMMON_VPATH += $(QUANTUM_DIR)/unicode
804    SRC += $(QUANTUM_DIR)/process_keycode/process_unicode_common.c \
805           $(QUANTUM_DIR)/unicode/unicode.c \
806           $(QUANTUM_DIR)/unicode/utf8.c
807endif
808
809ifeq ($(strip $(PS2_MOUSE_ENABLE)), yes)
810    PS2_ENABLE := yes
811    MOUSE_ENABLE := yes
812    SRC += ps2_mouse.c
813    OPT_DEFS += -DPS2_MOUSE_ENABLE
814endif
815
816VALID_PS2_DRIVER_TYPES := busywait interrupt usart vendor
817
818PS2_DRIVER ?= busywait
819ifeq ($(strip $(PS2_ENABLE)), yes)
820    ifeq ($(filter $(PS2_DRIVER),$(VALID_PS2_DRIVER_TYPES)),)
821        $(call CATASTROPHIC_ERROR,Invalid PS2_DRIVER,PS2_DRIVER="$(PS2_DRIVER)" is not a valid PS/2 driver)
822    endif
823
824    OPT_DEFS += -DPS2_DRIVER_$(strip $(shell echo $(PS2_DRIVER) | tr '[:lower:]' '[:upper:]'))
825
826    COMMON_VPATH += $(DRIVER_PATH)/ps2
827    COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/ps2
828    OPT_DEFS += -DPS2_ENABLE
829
830    ifneq ($(strip $(PS2_DRIVER)), vendor)
831        SRC += ps2_io.c
832    endif
833
834    SRC += ps2_$(strip $(PS2_DRIVER)).c
835endif
836
837JOYSTICK_ENABLE ?= no
838VALID_JOYSTICK_TYPES := analog digital
839JOYSTICK_DRIVER ?= analog
840ifeq ($(strip $(JOYSTICK_ENABLE)), yes)
841    ifeq ($(filter $(JOYSTICK_DRIVER),$(VALID_JOYSTICK_TYPES)),)
842        $(call CATASTROPHIC_ERROR,Invalid JOYSTICK_DRIVER,JOYSTICK_DRIVER="$(JOYSTICK_DRIVER)" is not a valid joystick driver)
843    endif
844    OPT_DEFS += -DJOYSTICK_ENABLE
845    OPT_DEFS += -DJOYSTICK_$(strip $(shell echo $(JOYSTICK_DRIVER) | tr '[:lower:]' '[:upper:]'))
846    SRC += $(QUANTUM_DIR)/process_keycode/process_joystick.c
847    SRC += $(QUANTUM_DIR)/joystick.c
848
849    ifeq ($(strip $(JOYSTICK_DRIVER)), analog)
850        ANALOG_DRIVER_REQUIRED = yes
851    endif
852endif
853
854USBPD_ENABLE ?= no
855VALID_USBPD_DRIVER_TYPES = custom vendor
856USBPD_DRIVER ?= vendor
857ifeq ($(strip $(USBPD_ENABLE)), yes)
858    ifeq ($(filter $(strip $(USBPD_DRIVER)),$(VALID_USBPD_DRIVER_TYPES)),)
859        $(call CATASTROPHIC_ERROR,Invalid USBPD_DRIVER,USBPD_DRIVER="$(USBPD_DRIVER)" is not a valid USBPD driver)
860    else
861        OPT_DEFS += -DUSBPD_ENABLE
862        ifeq ($(strip $(USBPD_DRIVER)), vendor)
863            # Vendor-specific implementations
864            OPT_DEFS += -DUSBPD_VENDOR
865            ifeq ($(strip $(MCU_SERIES)), STM32G4xx)
866                OPT_DEFS += -DUSBPD_STM32G4
867                SRC += usbpd_stm32g4.c
868            else
869                $(call CATASTROPHIC_ERROR,Invalid USBPD_DRIVER,There is no vendor-provided USBPD driver available)
870            endif
871        else ifeq ($(strip $(USBPD_DRIVER)), custom)
872            OPT_DEFS += -DUSBPD_CUSTOM
873            # Board designers can add their own driver to $(SRC)
874        endif
875    endif
876endif
877
878BLUETOOTH_ENABLE ?= no
879VALID_BLUETOOTH_DRIVER_TYPES := bluefruit_le custom rn42
880ifeq ($(strip $(BLUETOOTH_ENABLE)), yes)
881    ifeq ($(filter $(strip $(BLUETOOTH_DRIVER)),$(VALID_BLUETOOTH_DRIVER_TYPES)),)
882        $(call CATASTROPHIC_ERROR,Invalid BLUETOOTH_DRIVER,BLUETOOTH_DRIVER="$(BLUETOOTH_DRIVER)" is not a valid Bluetooth driver type)
883    endif
884    OPT_DEFS += -DBLUETOOTH_ENABLE
885    OPT_DEFS += -DBLUETOOTH_$(strip $(shell echo $(BLUETOOTH_DRIVER) | tr '[:lower:]' '[:upper:]'))
886    NO_USB_STARTUP_CHECK := yes
887    COMMON_VPATH += $(DRIVER_PATH)/bluetooth
888    SRC += outputselect.c process_connection.c
889
890    ifeq ($(strip $(BLUETOOTH_DRIVER)), bluefruit_le)
891        SPI_DRIVER_REQUIRED = yes
892        ANALOG_DRIVER_REQUIRED = yes
893        SRC += $(DRIVER_PATH)/bluetooth/bluetooth.c
894        SRC += $(DRIVER_PATH)/bluetooth/bluefruit_le.cpp
895    endif
896
897    ifeq ($(strip $(BLUETOOTH_DRIVER)), rn42)
898        UART_DRIVER_REQUIRED = yes
899        SRC += $(DRIVER_PATH)/bluetooth/bluetooth.c
900        SRC += $(DRIVER_PATH)/bluetooth/rn42.c
901    endif
902endif
903
904ENCODER_ENABLE ?= no
905ENCODER_DRIVER ?= quadrature
906VALID_ENCODER_DRIVER_TYPES := quadrature custom
907ifeq ($(strip $(ENCODER_ENABLE)), yes)
908    ifeq ($(filter $(ENCODER_DRIVER),$(VALID_ENCODER_DRIVER_TYPES)),)
909        $(call CATASTROPHIC_ERROR,Invalid ENCODER_DRIVER,ENCODER_DRIVER="$(ENCODER_DRIVER)" is not a valid encoder driver)
910    endif
911    SRC += $(QUANTUM_DIR)/encoder.c
912    OPT_DEFS += -DENCODER_ENABLE
913    OPT_DEFS += -DENCODER_DRIVER_$(strip $(shell echo $(ENCODER_DRIVER) | tr '[:lower:]' '[:upper:]'))
914
915    COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/encoder
916    COMMON_VPATH += $(DRIVER_PATH)/encoder
917
918    ifneq ($(strip $(ENCODER_DRIVER)), custom)
919        SRC += encoder_$(strip $(ENCODER_DRIVER)).c
920    endif
921
922    ifeq ($(strip $(ENCODER_MAP_ENABLE)), yes)
923        OPT_DEFS += -DENCODER_MAP_ENABLE
924    endif
925endif
926
927ifeq ($(strip $(DIP_SWITCH_ENABLE)), yes)
928    ifeq ($(strip $(DIP_SWITCH_MAP_ENABLE)), yes)
929        OPT_DEFS += -DDIP_SWITCH_MAP_ENABLE
930    endif
931endif
932
933VALID_WS2812_DRIVER_TYPES := bitbang custom i2c pwm spi vendor
934
935WS2812_DRIVER ?= bitbang
936ifeq ($(strip $(WS2812_DRIVER_REQUIRED)), yes)
937    ifeq ($(filter $(WS2812_DRIVER),$(VALID_WS2812_DRIVER_TYPES)),)
938        $(call CATASTROPHIC_ERROR,Invalid WS2812_DRIVER,WS2812_DRIVER="$(WS2812_DRIVER)" is not a valid WS2812 driver)
939    endif
940
941    OPT_DEFS += -DWS2812_$(strip $(shell echo $(WS2812_DRIVER) | tr '[:lower:]' '[:upper:]'))
942
943    SRC += ws2812.c ws2812_$(strip $(WS2812_DRIVER)).c
944
945    ifeq ($(strip $(PLATFORM)), CHIBIOS)
946        ifeq ($(strip $(WS2812_DRIVER)), pwm)
947            OPT_DEFS += -DSTM32_DMA_REQUIRED=TRUE
948        endif
949    endif
950
951    # add extra deps
952    ifeq ($(strip $(WS2812_DRIVER)), i2c)
953        I2C_DRIVER_REQUIRED = yes
954    endif
955endif
956
957ifeq ($(strip $(APA102_DRIVER_REQUIRED)), yes)
958    COMMON_VPATH += $(DRIVER_PATH)/led
959    SRC += apa102.c
960endif
961
962ifeq ($(strip $(ANALOG_DRIVER_REQUIRED)), yes)
963    OPT_DEFS += -DHAL_USE_ADC=TRUE
964    QUANTUM_LIB_SRC += analog.c
965endif
966
967ifeq ($(strip $(I2C_DRIVER_REQUIRED)), yes)
968    OPT_DEFS += -DHAL_USE_I2C=TRUE
969    QUANTUM_LIB_SRC += i2c_master.c
970endif
971
972ifeq ($(strip $(SPI_DRIVER_REQUIRED)), yes)
973    OPT_DEFS += -DHAL_USE_SPI=TRUE
974    QUANTUM_LIB_SRC += spi_master.c
975endif
976
977ifeq ($(strip $(UART_DRIVER_REQUIRED)), yes)
978    ifeq ($(strip $(PLATFORM)), CHIBIOS)
979        ifneq ($(filter $(MCU_SERIES),RP2040),)
980            OPT_DEFS += -DHAL_USE_SIO=TRUE
981            QUANTUM_LIB_SRC += uart_sio.c
982        else
983            OPT_DEFS += -DHAL_USE_SERIAL=TRUE
984            QUANTUM_LIB_SRC += uart_serial.c
985        endif
986    else
987        QUANTUM_LIB_SRC += uart.c
988    endif
989endif