build_keyboard.mk

   1 # Determine what keyboard we are building and setup the build environment.
   2 #
   3 # We support folders up to 5 levels deep below `keyboards/`. This file is
   4 # responsible for determining which folder is being used and doing the
   5 # corresponding environment setup.
   6
   7 ifndef VERBOSE
   8 .SILENT:
   9 endif
  10
  11 .DEFAULT_GOAL := all
  12
  13 include common.mk
  14
  15 # Set the filename for the final firmware binary
  16 KEYBOARD_FILESAFE := $(subst /,_,$(KEYBOARD))
  17 TARGET ?= $(KEYBOARD_FILESAFE)_$(KEYMAP)
  18 KEYBOARD_OUTPUT := $(BUILD_DIR)/obj_$(KEYBOARD_FILESAFE)
  19 STM32_PATH := quantum/stm32
  20
  21 # Force expansion
  22 TARGET := $(TARGET)
  23
  24 # For split boards we need to set a master half.
  25 MASTER ?= left
  26 ifdef master
  27     MASTER = $(master)
  28 endif
  29
  30 ifeq ($(MASTER),right)
  31     OPT_DEFS += -DMASTER_IS_ON_RIGHT
  32 else
  33     ifneq ($(MASTER),left)
  34 $(error MASTER does not have a valid value(left/right))
  35     endif
  36 endif
  37
  38 ifdef SKIP_VERSION
  39     OPT_DEFS += -DSKIP_VERSION
  40 endif
  41
  42 # Determine which subfolders exist.
  43 KEYBOARD_FOLDER_PATH_1 := $(KEYBOARD)
  44 KEYBOARD_FOLDER_PATH_2 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_1)))
  45 KEYBOARD_FOLDER_PATH_3 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_2)))
  46 KEYBOARD_FOLDER_PATH_4 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_3)))
  47 KEYBOARD_FOLDER_PATH_5 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_4)))
  48 KEYBOARD_FOLDER_1 := $(notdir $(KEYBOARD_FOLDER_PATH_1))
  49 KEYBOARD_FOLDER_2 := $(notdir $(KEYBOARD_FOLDER_PATH_2))
  50 KEYBOARD_FOLDER_3 := $(notdir $(KEYBOARD_FOLDER_PATH_3))
  51 KEYBOARD_FOLDER_4 := $(notdir $(KEYBOARD_FOLDER_PATH_4))
  52 KEYBOARD_FOLDER_5 := $(notdir $(KEYBOARD_FOLDER_PATH_5))
  53 KEYBOARD_PATHS :=
  54 KEYBOARD_PATH_1 := keyboards/$(KEYBOARD_FOLDER_PATH_1)
  55 KEYBOARD_PATH_2 := keyboards/$(KEYBOARD_FOLDER_PATH_2)
  56 KEYBOARD_PATH_3 := keyboards/$(KEYBOARD_FOLDER_PATH_3)
  57 KEYBOARD_PATH_4 := keyboards/$(KEYBOARD_FOLDER_PATH_4)
  58 KEYBOARD_PATH_5 := keyboards/$(KEYBOARD_FOLDER_PATH_5)
  59
  60 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/)","")
  61     KEYBOARD_PATHS += $(KEYBOARD_PATH_5)
  62 endif
  63 ifneq ("$(wildcard $(KEYBOARD_PATH_4)/)","")
  64     KEYBOARD_PATHS += $(KEYBOARD_PATH_4)
  65 endif
  66 ifneq ("$(wildcard $(KEYBOARD_PATH_3)/)","")
  67     KEYBOARD_PATHS += $(KEYBOARD_PATH_3)
  68 endif
  69 ifneq ("$(wildcard $(KEYBOARD_PATH_2)/)","")
  70     KEYBOARD_PATHS += $(KEYBOARD_PATH_2)
  71 endif
  72 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/)","")
  73     KEYBOARD_PATHS += $(KEYBOARD_PATH_1)
  74 endif
  75
  76
  77 # Pull in rules.mk files from all our subfolders
  78 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/rules.mk)","")
  79     include $(KEYBOARD_PATH_5)/rules.mk
  80 endif
  81 ifneq ("$(wildcard $(KEYBOARD_PATH_4)/rules.mk)","")
  82     include $(KEYBOARD_PATH_4)/rules.mk
  83 endif
  84 ifneq ("$(wildcard $(KEYBOARD_PATH_3)/rules.mk)","")
  85     include $(KEYBOARD_PATH_3)/rules.mk
  86 endif
  87 ifneq ("$(wildcard $(KEYBOARD_PATH_2)/rules.mk)","")
  88     include $(KEYBOARD_PATH_2)/rules.mk
  89 endif
  90 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/rules.mk)","")
  91     include $(KEYBOARD_PATH_1)/rules.mk
  92 endif
  93
  94
  95 MAIN_KEYMAP_PATH_1 := $(KEYBOARD_PATH_1)/keymaps/$(KEYMAP)
  96 MAIN_KEYMAP_PATH_2 := $(KEYBOARD_PATH_2)/keymaps/$(KEYMAP)
  97 MAIN_KEYMAP_PATH_3 := $(KEYBOARD_PATH_3)/keymaps/$(KEYMAP)
  98 MAIN_KEYMAP_PATH_4 := $(KEYBOARD_PATH_4)/keymaps/$(KEYMAP)
  99 MAIN_KEYMAP_PATH_5 := $(KEYBOARD_PATH_5)/keymaps/$(KEYMAP)
 100
 101 ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.c)","")
 102     -include $(MAIN_KEYMAP_PATH_5)/rules.mk
 103     KEYMAP_C := $(MAIN_KEYMAP_PATH_5)/keymap.c
 104     KEYMAP_PATH := $(MAIN_KEYMAP_PATH_5)
 105 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_4)/keymap.c)","")
 106     -include $(MAIN_KEYMAP_PATH_4)/rules.mk
 107     KEYMAP_C := $(MAIN_KEYMAP_PATH_4)/keymap.c
 108     KEYMAP_PATH := $(MAIN_KEYMAP_PATH_4)
 109 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_3)/keymap.c)","")
 110     -include $(MAIN_KEYMAP_PATH_3)/rules.mk
 111     KEYMAP_C := $(MAIN_KEYMAP_PATH_3)/keymap.c
 112     KEYMAP_PATH := $(MAIN_KEYMAP_PATH_3)
 113 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_2)/keymap.c)","")
 114     -include $(MAIN_KEYMAP_PATH_2)/rules.mk
 115     KEYMAP_C := $(MAIN_KEYMAP_PATH_2)/keymap.c
 116     KEYMAP_PATH := $(MAIN_KEYMAP_PATH_2)
 117 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.c)","")
 118     -include $(MAIN_KEYMAP_PATH_1)/rules.mk
 119     KEYMAP_C := $(MAIN_KEYMAP_PATH_1)/keymap.c
 120     KEYMAP_PATH := $(MAIN_KEYMAP_PATH_1)
 121 else ifneq ($(LAYOUTS),)
 122     include build_layout.mk
 123 else
 124     $(error Could not find keymap)
 125     # this state should never be reached
 126 endif
 127
 128 ifeq ($(strip $(CTPC)), yes)
 129   CONVERT_TO_PROTON_C=yes
 130 endif
 131
 132 ifeq ($(strip $(CONVERT_TO_PROTON_C)), yes)
 133     TARGET := $(TARGET)_proton_c
 134     include $(STM32_PATH)/proton_c.mk
 135     OPT_DEFS += -DCONVERT_TO_PROTON_C
 136 endif
 137
 138 ifneq ($(FORCE_LAYOUT),)
 139     TARGET := $(TARGET)_$(FORCE_LAYOUT)
 140 endif
 141
 142 include quantum/mcu_selection.mk
 143
 144 ifdef MCU_FAMILY
 145     OPT_DEFS += -DQMK_STM32
 146     KEYBOARD_PATHS += $(STM32_PATH)
 147 endif
 148
 149
 150 # Find all the C source files to be compiled in subfolders.
 151 KEYBOARD_SRC :=
 152
 153 KEYBOARD_C_1 := $(KEYBOARD_PATH_1)/$(KEYBOARD_FOLDER_1).c
 154 KEYBOARD_C_2 := $(KEYBOARD_PATH_2)/$(KEYBOARD_FOLDER_2).c
 155 KEYBOARD_C_3 := $(KEYBOARD_PATH_3)/$(KEYBOARD_FOLDER_3).c
 156 KEYBOARD_C_4 := $(KEYBOARD_PATH_4)/$(KEYBOARD_FOLDER_4).c
 157 KEYBOARD_C_5 := $(KEYBOARD_PATH_5)/$(KEYBOARD_FOLDER_5).c
 158
 159 ifneq ("$(wildcard $(KEYBOARD_C_5))","")
 160     KEYBOARD_SRC += $(KEYBOARD_C_5)
 161 endif
 162 ifneq ("$(wildcard $(KEYBOARD_C_4))","")
 163     KEYBOARD_SRC += $(KEYBOARD_C_4)
 164 endif
 165 ifneq ("$(wildcard $(KEYBOARD_C_3))","")
 166     KEYBOARD_SRC += $(KEYBOARD_C_3)
 167 endif
 168 ifneq ("$(wildcard $(KEYBOARD_C_2))","")
 169     KEYBOARD_SRC += $(KEYBOARD_C_2)
 170 endif
 171 ifneq ("$(wildcard $(KEYBOARD_C_1))","")
 172     KEYBOARD_SRC += $(KEYBOARD_C_1)
 173 endif
 174
 175 # Generate KEYBOARD_name_subname for all levels of the keyboard folder
 176 KEYBOARD_FILESAFE_1 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_1)))
 177 KEYBOARD_FILESAFE_2 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_2)))
 178 KEYBOARD_FILESAFE_3 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_3)))
 179 KEYBOARD_FILESAFE_4 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_4)))
 180 KEYBOARD_FILESAFE_5 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_5)))
 181
 182 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/)","")
 183     OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_5)
 184 endif
 185 ifneq ("$(wildcard $(KEYBOARD_PATH_4)/)","")
 186     OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_4)
 187 endif
 188 ifneq ("$(wildcard $(KEYBOARD_PATH_3)/)","")
 189     OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_3)
 190 endif
 191 ifneq ("$(wildcard $(KEYBOARD_PATH_2)/)","")
 192     OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_2)
 193 endif
 194 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/)","")
 195     OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_1)
 196 endif
 197
 198 # Setup the define for QMK_KEYBOARD_H. This is used inside of keymaps so
 199 # that the same keymap may be used on multiple keyboards.
 200 #
 201 # We grab the most top-level include file that we can. That file should
 202 # use #ifdef statements to include all the neccesary subfolder includes,
 203 # as described here:
 204 #
 205 #    https://docs.qmk.fm/#/feature_layouts?id=tips-for-making-layouts-keyboard-agnostic
 206 #
 207 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/$(KEYBOARD_FOLDER_1).h)","")
 208     QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_1).h
 209 endif
 210 ifneq ("$(wildcard $(KEYBOARD_PATH_2)/$(KEYBOARD_FOLDER_2).h)","")
 211     QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_2).h
 212 endif
 213 ifneq ("$(wildcard $(KEYBOARD_PATH_3)/$(KEYBOARD_FOLDER_3).h)","")
 214     QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_3).h
 215 endif
 216 ifneq ("$(wildcard $(KEYBOARD_PATH_4)/$(KEYBOARD_FOLDER_4).h)","")
 217     QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_4).h
 218 endif
 219 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/$(KEYBOARD_FOLDER_5).h)","")
 220     QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_5).h
 221 endif
 222
 223 # Determine and set parameters based on the keyboard's processor family.
 224 # We can assume a ChibiOS target When MCU_FAMILY is defined since it's
 225 # not used for LUFA
 226 ifdef MCU_FAMILY
 227     FIRMWARE_FORMAT?=bin
 228     PLATFORM=CHIBIOS
 229 else ifdef ARM_ATSAM
 230     PLATFORM=ARM_ATSAM
 231     FIRMWARE_FORMAT=bin
 232 else
 233     PLATFORM=AVR
 234     FIRMWARE_FORMAT?=hex
 235 endif
 236
 237 ifeq ($(PLATFORM),CHIBIOS)
 238     include $(TMK_PATH)/chibios.mk
 239     OPT_OS = chibios
 240     ifneq ("$(wildcard $(KEYBOARD_PATH_5)/bootloader_defs.h)","")
 241         OPT_DEFS += -include $(KEYBOARD_PATH_5)/bootloader_defs.h
 242      else ifneq ("$(wildcard $(KEYBOARD_PATH_5)/boards/$(BOARD)/bootloader_defs.h)","")
 243         OPT_DEFS += -include $(KEYBOARD_PATH_5)/boards/$(BOARD)/bootloader_defs.h
 244     else ifneq ("$(wildcard $(KEYBOARD_PATH_4)/bootloader_defs.h)","")
 245         OPT_DEFS += -include $(KEYBOARD_PATH_4)/bootloader_defs.h
 246      else ifneq ("$(wildcard $(KEYBOARD_PATH_4)/boards/$(BOARD)/bootloader_defs.h)","")
 247         OPT_DEFS += -include $(KEYBOARD_PATH_4)/boards/$(BOARD)/bootloader_defs.h
 248     else ifneq ("$(wildcard $(KEYBOARD_PATH_3)/bootloader_defs.h)","")
 249         OPT_DEFS += -include $(KEYBOARD_PATH_3)/bootloader_defs.h
 250      else ifneq ("$(wildcard $(KEYBOARD_PATH_3)/boards/$(BOARD)/bootloader_defs.h)","")
 251         OPT_DEFS += -include $(KEYBOARD_PATH_3)/boards/$(BOARD)/bootloader_defs.h
 252     else ifneq ("$(wildcard $(KEYBOARD_PATH_2)/bootloader_defs.h)","")
 253         OPT_DEFS += -include $(KEYBOARD_PATH_2)/bootloader_defs.h
 254      else ifneq ("$(wildcard $(KEYBOARD_PATH_2)/boards/$(BOARD)/bootloader_defs.h)","")
 255         OPT_DEFS += -include $(KEYBOARD_PATH_2)/boards/$(BOARD)/bootloader_defs.h
 256     else ifneq ("$(wildcard $(KEYBOARD_PATH_1)/bootloader_defs.h)","")
 257         OPT_DEFS += -include $(KEYBOARD_PATH_1)/bootloader_defs.h
 258      else ifneq ("$(wildcard $(KEYBOARD_PATH_1)/boards/$(BOARD)/bootloader_defs.h)","")
 259         OPT_DEFS += -include $(KEYBOARD_PATH_1)/boards/$(BOARD)/bootloader_defs.h
 260     else ifneq ("$(wildcard $(TOP_DIR)/drivers/boards/$(BOARD)/bootloader_defs.h)","")
 261         OPT_DEFS += -include $(TOP_DIR)/drivers/boards/$(BOARD)/bootloader_defs.h
 262     endif
 263 endif
 264
 265 # Find all of the config.h files and add them to our CONFIG_H define.
 266 CONFIG_H :=
 267 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/config.h)","")
 268     CONFIG_H += $(KEYBOARD_PATH_5)/config.h
 269 endif
 270 ifneq ("$(wildcard $(KEYBOARD_PATH_4)/config.h)","")
 271     CONFIG_H += $(KEYBOARD_PATH_4)/config.h
 272 endif
 273 ifneq ("$(wildcard $(KEYBOARD_PATH_3)/config.h)","")
 274     CONFIG_H += $(KEYBOARD_PATH_3)/config.h
 275 endif
 276 ifneq ("$(wildcard $(KEYBOARD_PATH_2)/config.h)","")
 277     CONFIG_H += $(KEYBOARD_PATH_2)/config.h
 278 endif
 279 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/config.h)","")
 280     CONFIG_H += $(KEYBOARD_PATH_1)/config.h
 281 endif
 282
 283 POST_CONFIG_H :=
 284 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/post_config.h)","")
 285     POST_CONFIG_H += $(KEYBOARD_PATH_1)/post_config.h
 286 endif
 287 ifneq ("$(wildcard $(KEYBOARD_PATH_2)/post_config.h)","")
 288     POST_CONFIG_H += $(KEYBOARD_PATH_2)/post_config.h
 289 endif
 290 ifneq ("$(wildcard $(KEYBOARD_PATH_3)/post_config.h)","")
 291     POST_CONFIG_H += $(KEYBOARD_PATH_3)/post_config.h
 292 endif
 293 ifneq ("$(wildcard $(KEYBOARD_PATH_4)/post_config.h)","")
 294     POST_CONFIG_H += $(KEYBOARD_PATH_4)/post_config.h
 295 endif
 296 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_config.h)","")
 297     POST_CONFIG_H += $(KEYBOARD_PATH_5)/post_config.h
 298 endif
 299
 300 # Save the defines and includes here, so we don't include any keymap specific ones
 301 PROJECT_DEFS := $(OPT_DEFS)
 302 PROJECT_INC := $(VPATH) $(EXTRAINCDIRS) $(KEYBOARD_PATHS)
 303 PROJECT_CONFIG := $(CONFIG_H)
 304
 305 # Userspace setup and definitions
 306 ifeq ("$(USER_NAME)","")
 307     USER_NAME := $(KEYMAP)
 308 endif
 309 USER_PATH := users/$(USER_NAME)
 310
 311 -include $(USER_PATH)/rules.mk
 312 ifneq ("$(wildcard $(USER_PATH)/config.h)","")
 313     CONFIG_H += $(USER_PATH)/config.h
 314 endif
 315
 316
 317 # Object files directory
 318 #     To put object files in current directory, use a dot (.), do NOT make
 319 #     this an empty or blank macro!
 320 KEYMAP_OUTPUT := $(BUILD_DIR)/obj_$(TARGET)
 321
 322 ifneq ("$(wildcard $(KEYMAP_PATH)/config.h)","")
 323     CONFIG_H += $(KEYMAP_PATH)/config.h
 324 endif
 325
 326 # # project specific files
 327 SRC += $(KEYBOARD_SRC) \
 328     $(KEYMAP_C) \
 329     $(QUANTUM_SRC)
 330
 331 # Optimize size but this may cause error "relocation truncated to fit"
 332 #EXTRALDFLAGS = -Wl,--relax
 333
 334 # Search Path
 335 VPATH += $(KEYMAP_PATH)
 336 VPATH += $(USER_PATH)
 337 VPATH += $(KEYBOARD_PATHS)
 338 VPATH += $(COMMON_VPATH)
 339
 340 include common_features.mk
 341 include $(TMK_PATH)/protocol.mk
 342 include $(TMK_PATH)/common.mk
 343 include bootloader.mk
 344
 345 SRC += $(patsubst %.c,%.clib,$(LIB_SRC))
 346 SRC += $(patsubst %.c,%.clib,$(QUANTUM_LIB_SRC))
 347 SRC += $(TMK_COMMON_SRC)
 348 OPT_DEFS += $(TMK_COMMON_DEFS)
 349 EXTRALDFLAGS += $(TMK_COMMON_LDFLAGS)
 350
 351 ifeq ($(PLATFORM),AVR)
 352 ifeq ($(strip $(PROTOCOL)), VUSB)
 353     include $(TMK_PATH)/protocol/vusb.mk
 354 else
 355     include $(TMK_PATH)/protocol/lufa.mk
 356 endif
 357     include $(TMK_PATH)/avr.mk
 358 endif
 359
 360 ifeq ($(PLATFORM),ARM_ATSAM)
 361     include $(TMK_PATH)/arm_atsam.mk
 362     include $(TMK_PATH)/protocol/arm_atsam.mk
 363 endif
 364
 365 ifeq ($(PLATFORM),CHIBIOS)
 366     include $(TMK_PATH)/protocol/chibios.mk
 367 endif
 368
 369 ifeq ($(strip $(VISUALIZER_ENABLE)), yes)
 370     VISUALIZER_DIR = $(QUANTUM_DIR)/visualizer
 371     VISUALIZER_PATH = $(QUANTUM_PATH)/visualizer
 372     include $(VISUALIZER_PATH)/visualizer.mk
 373 endif
 374
 375 CONFIG_H += $(POST_CONFIG_H)
 376 ALL_CONFIGS := $(PROJECT_CONFIG) $(CONFIG_H)
 377
 378 OUTPUTS := $(KEYMAP_OUTPUT) $(KEYBOARD_OUTPUT)
 379 $(KEYMAP_OUTPUT)_SRC := $(SRC)
 380 $(KEYMAP_OUTPUT)_DEFS := $(OPT_DEFS) $(GFXDEFS) \
 381 -DQMK_KEYBOARD=\"$(KEYBOARD)\" -DQMK_KEYBOARD_H=\"$(QMK_KEYBOARD_H)\" -DQMK_KEYBOARD_CONFIG_H=\"$(KEYBOARD_PATH_1)/config.h\" \
 382 -DQMK_KEYMAP=\"$(KEYMAP)\" -DQMK_KEYMAP_H=\"$(KEYMAP).h\" -DQMK_KEYMAP_CONFIG_H=\"$(KEYMAP_PATH)/config.h\" \
 383 -DQMK_SUBPROJECT -DQMK_SUBPROJECT_H -DQMK_SUBPROJECT_CONFIG_H
 384 $(KEYMAP_OUTPUT)_INC :=  $(VPATH) $(EXTRAINCDIRS)
 385 $(KEYMAP_OUTPUT)_CONFIG := $(CONFIG_H)
 386 $(KEYBOARD_OUTPUT)_SRC := $(CHIBISRC) $(GFXSRC)
 387 $(KEYBOARD_OUTPUT)_DEFS := $(PROJECT_DEFS) $(GFXDEFS)
 388 $(KEYBOARD_OUTPUT)_INC := $(PROJECT_INC) $(GFXINC)
 389 $(KEYBOARD_OUTPUT)_CONFIG := $(PROJECT_CONFIG)
 390
 391 # Default target.
 392 all: build check-size
 393 build: elf cpfirmware
 394 check-size: build
 395
 396 include show_options.mk
 397 include $(TMK_PATH)/rules.mk