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     POST_CONFIG_H += $(QUANTUM_DIR)/rgblight_post_config.h
 107     OPT_DEFS += -DRGBLIGHT_ENABLE
 108     SRC += $(QUANTUM_DIR)/color.c
 109     SRC += $(QUANTUM_DIR)/rgblight.c
 110     CIE1931_CURVE = yes
 111     LED_BREATHING_TABLE = yes
 112     RGB_KEYCODES_ENABLE = yes
 113     ifeq ($(strip $(RGBLIGHT_CUSTOM_DRIVER)), yes)
 114         OPT_DEFS += -DRGBLIGHT_CUSTOM_DRIVER
 115     else
 116         WS2812_DRIVER_REQUIRED = yes
 117     endif
 118 endif
 119
 120 VALID_MATRIX_TYPES := yes IS31FL3731 IS31FL3733 IS31FL3737 WS2812 custom
 121
 122 LED_MATRIX_ENABLE ?= no
 123 ifneq ($(strip $(LED_MATRIX_ENABLE)), no)
 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
 131 endif
 132
 133 ifeq ($(strip $(LED_MATRIX_ENABLE)), IS31FL3731)
 134     OPT_DEFS += -DIS31FL3731
 135     COMMON_VPATH += $(DRIVER_PATH)/issi
 136     SRC += is31fl3731-simple.c
 137     QUANTUM_LIB_SRC += i2c_master.c
 138 endif
 139
 140 RGB_MATRIX_ENABLE ?= no
 141
 142 ifneq ($(strip $(RGB_MATRIX_ENABLE)), no)
 143 ifeq ($(filter $(RGB_MATRIX_ENABLE),$(VALID_MATRIX_TYPES)),)
 144     $(error RGB_MATRIX_ENABLE="$(RGB_MATRIX_ENABLE)" is not a valid matrix type)
 145 endif
 146     OPT_DEFS += -DRGB_MATRIX_ENABLE
 147     SRC += $(QUANTUM_DIR)/color.c
 148     SRC += $(QUANTUM_DIR)/rgb_matrix.c
 149     SRC += $(QUANTUM_DIR)/rgb_matrix_drivers.c
 150     CIE1931_CURVE = yes
 151     RGB_KEYCODES_ENABLE = yes
 152 endif
 153
 154 ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
 155         RGB_MATRIX_ENABLE = IS31FL3731
 156 endif
 157
 158 ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3731)
 159     OPT_DEFS += -DIS31FL3731 -DSTM32_I2C -DHAL_USE_I2C=TRUE
 160     COMMON_VPATH += $(DRIVER_PATH)/issi
 161     SRC += is31fl3731.c
 162     QUANTUM_LIB_SRC += i2c_master.c
 163 endif
 164
 165 ifeq ($(strip $(RGB_MATRIX_ENABLE)), IS31FL3733)
 166     OPT_DEFS += -DIS31FL3733 -DSTM32_I2C -DHAL_USE_I2C=TRUE
 167     COMMON_VPATH += $(DRIVER_PATH)/issi
 168     SRC += is31fl3733.c
 169     QUANTUM_LIB_SRC += i2c_master.c
 170 endif
 171
 172 ifeq ($(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
 176     QUANTUM_LIB_SRC += i2c_master.c
 177 endif
 178
 179 ifeq ($(strip $(RGB_MATRIX_ENABLE)), WS2812)
 180     OPT_DEFS += -DWS2812
 181     WS2812_DRIVER_REQUIRED = yes
 182 endif
 183
 184 ifeq ($(strip $(RGB_MATRIX_CUSTOM_KB)), yes)
 185     OPT_DEFS += -DRGB_MATRIX_CUSTOM_KB
 186 endif
 187
 188 ifeq ($(strip $(RGB_MATRIX_CUSTOM_USER)), yes)
 189     OPT_DEFS += -DRGB_MATRIX_CUSTOM_USER
 190 endif
 191
 192 ifeq ($(strip $(RGB_KEYCODES_ENABLE)), yes)
 193     SRC += $(QUANTUM_DIR)/process_keycode/process_rgb.c
 194 endif
 195
 196 ifeq ($(strip $(TAP_DANCE_ENABLE)), yes)
 197     OPT_DEFS += -DTAP_DANCE_ENABLE
 198     SRC += $(QUANTUM_DIR)/process_keycode/process_tap_dance.c
 199 endif
 200
 201 ifeq ($(strip $(KEY_LOCK_ENABLE)), yes)
 202     OPT_DEFS += -DKEY_LOCK_ENABLE
 203     SRC += $(QUANTUM_DIR)/process_keycode/process_key_lock.c
 204 endif
 205
 206 ifeq ($(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
 210 endif
 211
 212 ifeq ($(strip $(AUTO_SHIFT_ENABLE)), yes)
 213     OPT_DEFS += -DAUTO_SHIFT_ENABLE
 214     SRC += $(QUANTUM_DIR)/process_keycode/process_auto_shift.c
 215     ifeq ($(strip $(AUTO_SHIFT_MODIFIERS)), yes)
 216         OPT_DEFS += -DAUTO_SHIFT_MODIFIERS
 217     endif
 218 endif
 219
 220 ifeq ($(strip $(SERIAL_LINK_ENABLE)), yes)
 221     SRC += $(patsubst $(QUANTUM_PATH)/%,%,$(SERIAL_SRC))
 222     OPT_DEFS += $(SERIAL_DEFS)
 223     VAPTH += $(SERIAL_PATH)
 224 endif
 225
 226 ifneq ($(strip $(VARIABLE_TRACE)),)
 227     SRC += $(QUANTUM_DIR)/variable_trace.c
 228     OPT_DEFS += -DNUM_TRACED_VARIABLES=$(strip $(VARIABLE_TRACE))
 229 ifneq ($(strip $(MAX_VARIABLE_TRACE_SIZE)),)
 230     OPT_DEFS += -DMAX_VARIABLE_TRACE_SIZE=$(strip $(MAX_VARIABLE_TRACE_SIZE))
 231 endif
 232 endif
 233
 234 ifeq ($(strip $(LCD_ENABLE)), yes)
 235     CIE1931_CURVE = yes
 236 endif
 237
 238 # backward compat
 239 ifeq ($(strip $(BACKLIGHT_CUSTOM_DRIVER)), yes)
 240     BACKLIGHT_DRIVER = custom
 241 endif
 242
 243 VALID_BACKLIGHT_TYPES := pwm software custom
 244
 245 BACKLIGHT_ENABLE ?= no
 246 BACKLIGHT_DRIVER ?= pwm
 247 ifeq ($(strip $(BACKLIGHT_ENABLE)), yes)
 248     ifeq ($(filter $(BACKLIGHT_DRIVER),$(VALID_BACKLIGHT_TYPES)),)
 249         $(error BACKLIGHT_DRIVER="$(BACKLIGHT_DRIVER)" is not a valid backlight type)
 250     endif
 251
 252     ifeq ($(strip $(VISUALIZER_ENABLE)), yes)
 253         CIE1931_CURVE = yes
 254     endif
 255
 256     COMMON_VPATH += $(QUANTUM_DIR)/backlight
 257     SRC += $(QUANTUM_DIR)/backlight/backlight.c
 258     OPT_DEFS += -DBACKLIGHT_ENABLE
 259
 260     ifeq ($(strip $(BACKLIGHT_DRIVER)), software)
 261         SRC += $(QUANTUM_DIR)/backlight/backlight_soft.c
 262     else
 263         ifeq ($(strip $(BACKLIGHT_DRIVER)), custom)
 264             OPT_DEFS += -DBACKLIGHT_CUSTOM_DRIVER
 265         endif
 266
 267         ifeq ($(PLATFORM),AVR)
 268             SRC += $(QUANTUM_DIR)/backlight/backlight_avr.c
 269         else
 270             SRC += $(QUANTUM_DIR)/backlight/backlight_arm.c
 271         endif
 272     endif
 273 endif
 274
 275 VALID_WS2812_DRIVER_TYPES := bitbang pwm spi i2c
 276
 277 WS2812_DRIVER ?= bitbang
 278 ifeq ($(strip $(WS2812_DRIVER_REQUIRED)), yes)
 279     ifeq ($(filter $(WS2812_DRIVER),$(VALID_WS2812_DRIVER_TYPES)),)
 280         $(error WS2812_DRIVER="$(WS2812_DRIVER)" is not a valid WS2812 driver)
 281     endif
 282
 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
 293 endif
 294
 295 ifeq ($(strip $(CIE1931_CURVE)), yes)
 296     OPT_DEFS += -DUSE_CIE1931_CURVE
 297     LED_TABLES = yes
 298 endif
 299
 300 ifeq ($(strip $(LED_BREATHING_TABLE)), yes)
 301     OPT_DEFS += -DUSE_LED_BREATHING_TABLE
 302     LED_TABLES = yes
 303 endif
 304
 305 ifeq ($(strip $(LED_TABLES)), yes)
 306     SRC += $(QUANTUM_DIR)/led_tables.c
 307 endif
 308
 309 ifeq ($(strip $(TERMINAL_ENABLE)), yes)
 310     SRC += $(QUANTUM_DIR)/process_keycode/process_terminal.c
 311     OPT_DEFS += -DTERMINAL_ENABLE
 312     OPT_DEFS += -DUSER_PRINT
 313 endif
 314
 315 ifeq ($(strip $(USB_HID_ENABLE)), yes)
 316     include $(TMK_DIR)/protocol/usb_hid.mk
 317 endif
 318
 319 ifeq ($(strip $(ENCODER_ENABLE)), yes)
 320     SRC += $(QUANTUM_DIR)/encoder.c
 321     OPT_DEFS += -DENCODER_ENABLE
 322 endif
 323
 324 HAPTIC_ENABLE ?= no
 325 ifneq ($(strip $(HAPTIC_ENABLE)),no)
 326         COMMON_VPATH += $(DRIVER_PATH)/haptic
 327         SRC += haptic.c
 328         OPT_DEFS += -DHAPTIC_ENABLE
 329 endif
 330
 331 ifneq ($(filter DRV2605L, $(HAPTIC_ENABLE)), )
 332     SRC += DRV2605L.c
 333     QUANTUM_LIB_SRC += i2c_master.c
 334     OPT_DEFS += -DDRV2605L
 335 endif
 336
 337 ifneq ($(filter SOLENOID, $(HAPTIC_ENABLE)), )
 338     SRC += solenoid.c
 339     OPT_DEFS += -DSOLENOID_ENABLE
 340 endif
 341
 342 ifeq ($(strip $(HD44780_ENABLE)), yes)
 343     SRC += drivers/avr/hd44780.c
 344     OPT_DEFS += -DHD44780_ENABLE
 345 endif
 346
 347 ifeq ($(strip $(VELOCIKEY_ENABLE)), yes)
 348     OPT_DEFS += -DVELOCIKEY_ENABLE
 349     SRC += $(QUANTUM_DIR)/velocikey.c
 350 endif
 351
 352 ifeq ($(strip $(DYNAMIC_KEYMAP_ENABLE)), yes)
 353     OPT_DEFS += -DDYNAMIC_KEYMAP_ENABLE
 354     SRC += $(QUANTUM_DIR)/dynamic_keymap.c
 355 endif
 356
 357 ifeq ($(strip $(LEADER_ENABLE)), yes)
 358   SRC += $(QUANTUM_DIR)/process_keycode/process_leader.c
 359   OPT_DEFS += -DLEADER_ENABLE
 360 endif
 361
 362 include $(DRIVER_PATH)/qwiic/qwiic.mk
 363
 364 QUANTUM_SRC:= \
 365     $(QUANTUM_DIR)/quantum.c \
 366     $(QUANTUM_DIR)/keymap_common.c \
 367     $(QUANTUM_DIR)/keycode_config.c
 368
 369 # Include the standard or split matrix code if needed
 370 ifneq ($(strip $(CUSTOM_MATRIX)), yes)
 371     ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
 372         QUANTUM_SRC += $(QUANTUM_DIR)/split_common/matrix.c
 373     else
 374         QUANTUM_SRC += $(QUANTUM_DIR)/matrix.c
 375     endif
 376 endif
 377
 378 DEBOUNCE_DIR:= $(QUANTUM_DIR)/debounce
 379 # Debounce Modules. Set DEBOUNCE_TYPE=custom if including one manually.
 380 DEBOUNCE_TYPE?= sym_g
 381 ifneq ($(strip $(DEBOUNCE_TYPE)), custom)
 382     QUANTUM_SRC += $(DEBOUNCE_DIR)/$(strip $(DEBOUNCE_TYPE)).c
 383 endif
 384
 385 ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
 386     POST_CONFIG_H += $(QUANTUM_DIR)/split_common/post_config.h
 387     OPT_DEFS += -DSPLIT_KEYBOARD
 388
 389     # Include files used by all split keyboards
 390     QUANTUM_SRC += $(QUANTUM_DIR)/split_common/split_util.c
 391
 392     # Determine which (if any) transport files are required
 393     ifneq ($(strip $(SPLIT_TRANSPORT)), custom)
 394         QUANTUM_SRC += $(QUANTUM_DIR)/split_common/transport.c
 395         # Functions added via QUANTUM_LIB_SRC are only included in the final binary if they're called.
 396         # Unused functions are pruned away, which is why we can add multiple drivers here without bloat.
 397         QUANTUM_LIB_SRC += $(QUANTUM_DIR)/split_common/serial.c \
 398                            i2c_master.c \
 399                            i2c_slave.c
 400     endif
 401     COMMON_VPATH += $(QUANTUM_PATH)/split_common
 402 endif
 403
 404 ifeq ($(strip $(OLED_DRIVER_ENABLE)), yes)
 405     OPT_DEFS += -DOLED_DRIVER_ENABLE
 406     COMMON_VPATH += $(DRIVER_PATH)/oled
 407     QUANTUM_LIB_SRC += i2c_master.c
 408     SRC += oled_driver.c
 409 endif
 410
 411 SPACE_CADET_ENABLE ?= yes
 412 ifeq ($(strip $(SPACE_CADET_ENABLE)), yes)
 413   SRC += $(QUANTUM_DIR)/process_keycode/process_space_cadet.c
 414   OPT_DEFS += -DSPACE_CADET_ENABLE
 415 endif
 416
 417 MAGIC_ENABLE ?= yes
 418 ifeq ($(strip $(MAGIC_ENABLE)), yes)
 419     SRC += $(QUANTUM_DIR)/process_keycode/process_magic.c
 420     OPT_DEFS += -DMAGIC_KEYCODE_ENABLE
 421 endif
 422
 423 ifeq ($(strip $(DYNAMIC_MACRO_ENABLE)), yes)
 424     SRC += $(QUANTUM_DIR)/process_keycode/process_dynamic_macro.c
 425     OPT_DEFS += -DDYNAMIC_MACRO_ENABLE
 426 endif
 427
 428 ifeq ($(strip $(DIP_SWITCH_ENABLE)), yes)
 429   SRC += $(QUANTUM_DIR)/dip_switch.c
 430   OPT_DEFS += -DDIP_SWITCH_ENABLE
 431 endif