logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

build_keyboard.mk (24915B)

    

  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.
  7. ifndef VERBOSE
  8. .SILENT:
  9. endif
  11. .DEFAULT_GOAL := all
  13. include paths.mk
  14. include $(BUILDDEFS_PATH)/support.mk
  15. include $(BUILDDEFS_PATH)/message.mk
  17. # Helper to add defines with a 'QMK_' prefix
  18. define add_qmk_prefix_defs
  19.     ifdef $1
  20.         # Need to cater for 'STM32L4xx+'
  21.         OPT_DEFS += -DQMK_$(2)="$($1)" -DQMK_$(2)_$(shell echo $($1) | sed -e 's@+@Plus@g' -e 's@[^a-zA-Z0-9]@_@g' | tr '[:lower:]' '[:upper:]')
  22.     endif
  23. endef
  25. # Set the qmk cli to use
  26. QMK_BIN ?= qmk
  28. # Set the filename for the final firmware binary
  29. KEYBOARD_FILESAFE := $(subst /,_,$(KEYBOARD))
  30. TARGET ?= $(KEYBOARD_FILESAFE)_$(KEYMAP)
  32. ifeq ($(strip $(DUMP_CI_METADATA)),yes)
  33.     $(info CI Metadata: KEYBOARD=$(KEYBOARD))
  34.     $(info CI Metadata: KEYMAP=$(KEYMAP))
  35. endif
  37. # Force expansion
  38. override TARGET := $(TARGET)
  40. ifneq ($(FORCE_LAYOUT),)
  41.     override TARGET := $(TARGET)_$(FORCE_LAYOUT)
  42. endif
  43. ifneq ($(CONVERT_TO),)
  44.     override TARGET := $(TARGET)_$(CONVERT_TO)
  45. endif
  47. # Object files and generated keymap directory
  48. #     To put object files in current directory, use a dot (.), do NOT make
  49. #     this an empty or blank macro!
  50. INTERMEDIATE_OUTPUT := $(BUILD_DIR)/obj_$(TARGET)
  52. ifdef SKIP_VERSION
  53.     OPT_DEFS += -DSKIP_VERSION
  54. endif
  56. # Generate the version.h file
  57. VERSION_H_FLAGS :=
  58. ifdef SKIP_VERSION
  59. VERSION_H_FLAGS += --skip-all
  60. endif
  61. ifdef SKIP_GIT
  62. VERSION_H_FLAGS += --skip-git
  63. endif
  65. # Determine which subfolders exist.
  66. KEYBOARD_FOLDER_PATH_1 := $(KEYBOARD)
  67. KEYBOARD_FOLDER_PATH_2 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_1)))
  68. KEYBOARD_FOLDER_PATH_3 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_2)))
  69. KEYBOARD_FOLDER_PATH_4 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_3)))
  70. KEYBOARD_FOLDER_PATH_5 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_4)))
  71. KEYBOARD_FOLDER_1 := $(notdir $(KEYBOARD_FOLDER_PATH_1))
  72. KEYBOARD_FOLDER_2 := $(notdir $(KEYBOARD_FOLDER_PATH_2))
  73. KEYBOARD_FOLDER_3 := $(notdir $(KEYBOARD_FOLDER_PATH_3))
  74. KEYBOARD_FOLDER_4 := $(notdir $(KEYBOARD_FOLDER_PATH_4))
  75. KEYBOARD_FOLDER_5 := $(notdir $(KEYBOARD_FOLDER_PATH_5))
  76. KEYBOARD_PATHS :=
  77. KEYBOARD_PATH_1 := keyboards/$(KEYBOARD_FOLDER_PATH_1)
  78. KEYBOARD_PATH_2 := keyboards/$(KEYBOARD_FOLDER_PATH_2)
  79. KEYBOARD_PATH_3 := keyboards/$(KEYBOARD_FOLDER_PATH_3)
  80. KEYBOARD_PATH_4 := keyboards/$(KEYBOARD_FOLDER_PATH_4)
  81. KEYBOARD_PATH_5 := keyboards/$(KEYBOARD_FOLDER_PATH_5)
  83. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/)","")
  84.     KEYBOARD_PATHS += $(KEYBOARD_PATH_5)
  85. endif
  86. ifneq ("$(wildcard $(KEYBOARD_PATH_4)/)","")
  87.     KEYBOARD_PATHS += $(KEYBOARD_PATH_4)
  88. endif
  89. ifneq ("$(wildcard $(KEYBOARD_PATH_3)/)","")
  90.     KEYBOARD_PATHS += $(KEYBOARD_PATH_3)
  91. endif
  92. ifneq ("$(wildcard $(KEYBOARD_PATH_2)/)","")
  93.     KEYBOARD_PATHS += $(KEYBOARD_PATH_2)
  94. endif
  95. ifneq ("$(wildcard $(KEYBOARD_PATH_1)/)","")
  96.     KEYBOARD_PATHS += $(KEYBOARD_PATH_1)
  97. endif
  100. # Pull in rules.mk files from all our subfolders
  101. -include $(KEYBOARD_PATH_5)/rules.mk
  102. -include $(KEYBOARD_PATH_4)/rules.mk
  103. -include $(KEYBOARD_PATH_3)/rules.mk
  104. -include $(KEYBOARD_PATH_2)/rules.mk
  105. -include $(KEYBOARD_PATH_1)/rules.mk
  107. # Create dependencies on DD keyboard config - structure validated elsewhere
  108. DD_CONFIG_FILES :=
  109. ifneq ("$(wildcard $(KEYBOARD_PATH_1)/info.json)","")
  110.     DD_CONFIG_FILES += $(KEYBOARD_PATH_1)/info.json
  111. endif
  112. ifneq ("$(wildcard $(KEYBOARD_PATH_2)/info.json)","")
  113.     DD_CONFIG_FILES += $(KEYBOARD_PATH_2)/info.json
  114. endif
  115. ifneq ("$(wildcard $(KEYBOARD_PATH_3)/info.json)","")
  116.     DD_CONFIG_FILES += $(KEYBOARD_PATH_3)/info.json
  117. endif
  118. ifneq ("$(wildcard $(KEYBOARD_PATH_4)/info.json)","")
  119.     DD_CONFIG_FILES += $(KEYBOARD_PATH_4)/info.json
  120. endif
  121. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/info.json)","")
  122.     DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/info.json
  123. endif
  125. ifneq ("$(wildcard $(KEYBOARD_PATH_1)/keyboard.json)","")
  126.     DD_CONFIG_FILES += $(KEYBOARD_PATH_1)/keyboard.json
  127. endif
  128. ifneq ("$(wildcard $(KEYBOARD_PATH_2)/keyboard.json)","")
  129.     DD_CONFIG_FILES += $(KEYBOARD_PATH_2)/keyboard.json
  130. endif
  131. ifneq ("$(wildcard $(KEYBOARD_PATH_3)/keyboard.json)","")
  132.     DD_CONFIG_FILES += $(KEYBOARD_PATH_3)/keyboard.json
  133. endif
  134. ifneq ("$(wildcard $(KEYBOARD_PATH_4)/keyboard.json)","")
  135.     DD_CONFIG_FILES += $(KEYBOARD_PATH_4)/keyboard.json
  136. endif
  137. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/keyboard.json)","")
  138.     DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/keyboard.json
  139. endif
  141. MAIN_KEYMAP_PATH_1 := $(KEYBOARD_PATH_1)/keymaps/$(KEYMAP)
  142. MAIN_KEYMAP_PATH_2 := $(KEYBOARD_PATH_2)/keymaps/$(KEYMAP)
  143. MAIN_KEYMAP_PATH_3 := $(KEYBOARD_PATH_3)/keymaps/$(KEYMAP)
  144. MAIN_KEYMAP_PATH_4 := $(KEYBOARD_PATH_4)/keymaps/$(KEYMAP)
  145. MAIN_KEYMAP_PATH_5 := $(KEYBOARD_PATH_5)/keymaps/$(KEYMAP)
  147. # Pull in rules from DD keyboard config
  148. INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --keyboard $(KEYBOARD) --output $(INTERMEDIATE_OUTPUT)/src/info_rules.mk)
  149. include $(INFO_RULES_MK)
  151. # Check for keymap.json first, so we can regenerate keymap.c
  152. include $(BUILDDEFS_PATH)/build_json.mk
  154. # Pull in keymap level rules.mk
  155. ifeq ("$(wildcard $(KEYMAP_PATH))", "")
  156.     # Look through the possible keymap folders until we find a matching keymap.c
  157.     ifneq ($(QMK_USERSPACE),)
  158.         ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/keymap.c)","")
  159.             -include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/rules.mk
  160.             KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/keymap.c
  161.             KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)
  162.         else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/keymap.c)","")
  163.             -include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/rules.mk
  164.             KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/keymap.c
  165.             KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)
  166.         else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/keymap.c)","")
  167.             -include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/rules.mk
  168.             KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/keymap.c
  169.             KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)
  170.         else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/keymap.c)","")
  171.             -include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/rules.mk
  172.             KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/keymap.c
  173.             KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)
  174.         else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/keymap.c)","")
  175.             -include $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/rules.mk
  176.             KEYMAP_C := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/keymap.c
  177.             KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)
  178.         endif
  179.     endif
  180.     ifeq ($(KEYMAP_PATH),)
  181.         ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.c)","")
  182.             -include $(MAIN_KEYMAP_PATH_1)/rules.mk
  183.             KEYMAP_C := $(MAIN_KEYMAP_PATH_1)/keymap.c
  184.             KEYMAP_PATH := $(MAIN_KEYMAP_PATH_1)
  185.         else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_2)/keymap.c)","")
  186.             -include $(MAIN_KEYMAP_PATH_2)/rules.mk
  187.             KEYMAP_C := $(MAIN_KEYMAP_PATH_2)/keymap.c
  188.             KEYMAP_PATH := $(MAIN_KEYMAP_PATH_2)
  189.         else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_3)/keymap.c)","")
  190.             -include $(MAIN_KEYMAP_PATH_3)/rules.mk
  191.             KEYMAP_C := $(MAIN_KEYMAP_PATH_3)/keymap.c
  192.             KEYMAP_PATH := $(MAIN_KEYMAP_PATH_3)
  193.         else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_4)/keymap.c)","")
  194.             -include $(MAIN_KEYMAP_PATH_4)/rules.mk
  195.             KEYMAP_C := $(MAIN_KEYMAP_PATH_4)/keymap.c
  196.             KEYMAP_PATH := $(MAIN_KEYMAP_PATH_4)
  197.         else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.c)","")
  198.             -include $(MAIN_KEYMAP_PATH_5)/rules.mk
  199.             KEYMAP_C := $(MAIN_KEYMAP_PATH_5)/keymap.c
  200.             KEYMAP_PATH := $(MAIN_KEYMAP_PATH_5)
  201.         else ifneq ($(LAYOUTS),)
  202.             # If we haven't found a keymap yet fall back to community layouts
  203.             include $(BUILDDEFS_PATH)/build_layout.mk
  204.         else ifeq ("$(wildcard $(KEYMAP_JSON_PATH))", "") # Not finding keymap.c is fine if we found a keymap.json
  205.             $(call CATASTROPHIC_ERROR,Invalid keymap,Could not find keymap)
  206.             # this state should never be reached
  207.         endif
  208.     endif
  209. endif
  211. # Have we found a keymap.json?
  212. ifneq ("$(wildcard $(KEYMAP_JSON))", "")
  213.     ifneq ("$(wildcard $(KEYMAP_C))", "")
  214.         # Allow a separately-found keymap.c next to keymap.json -- the keymap.c
  215.         # generator will include the other keymap.c in the process, if supplied.
  216.         OTHER_KEYMAP_C := $(KEYMAP_C)
  217.         OPT_DEFS += -DOTHER_KEYMAP_C=\"$(OTHER_KEYMAP_C)\"
  218.     endif
  220.     KEYMAP_PATH := $(KEYMAP_JSON_PATH)
  222.     KEYMAP_C := $(INTERMEDIATE_OUTPUT)/src/keymap.c
  223.     KEYMAP_H := $(INTERMEDIATE_OUTPUT)/src/config.h
  225.     ifeq ($(OTHER_KEYMAP_C),)
  226.         # Load the keymap-level rules.mk if exists (and we havent already loaded it for keymap.c)
  227.         -include $(KEYMAP_PATH)/rules.mk
  228.     endif
  230.     # Load any rules.mk content from keymap.json
  231.     INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --output $(INTERMEDIATE_OUTPUT)/src/rules.mk $(KEYMAP_JSON))
  232.     include $(INFO_RULES_MK)
  234. # Add rules to generate the keymap files - indentation here is important
  235. $(INTERMEDIATE_OUTPUT)/src/keymap.c: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
  236. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  237. 	$(eval CMD=$(QMK_BIN) json2c --quiet --output $(KEYMAP_C) $(KEYMAP_JSON))
  238. 	@$(BUILD_CMD)
  240. $(INTERMEDIATE_OUTPUT)/src/config.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
  241. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  242. 	$(eval CMD=$(QMK_BIN) generate-config-h --quiet --output $(KEYMAP_H) $(KEYMAP_JSON))
  243. 	@$(BUILD_CMD)
  245. $(INTERMEDIATE_OUTPUT)/src/keymap.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
  246. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  247. 	$(eval CMD=$(QMK_BIN) generate-keymap-h --quiet --output $(INTERMEDIATE_OUTPUT)/src/keymap.h $(KEYMAP_JSON))
  248. 	@$(BUILD_CMD)
  250. generated-files: $(INTERMEDIATE_OUTPUT)/src/config.h $(INTERMEDIATE_OUTPUT)/src/keymap.c $(INTERMEDIATE_OUTPUT)/src/keymap.h
  252. endif
  254. # Community modules
  255. COMMUNITY_RULES_MK = $(shell $(QMK_BIN) generate-community-modules-rules-mk -kb $(KEYBOARD) --quiet --escape --output $(INTERMEDIATE_OUTPUT)/src/community_rules.mk $(KEYMAP_JSON))
  256. include $(COMMUNITY_RULES_MK)
  258. $(INTERMEDIATE_OUTPUT)/src/community_modules.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
  259. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  260. 	$(eval CMD=$(QMK_BIN) generate-community-modules-h -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules.h $(KEYMAP_JSON))
  261. 	@$(BUILD_CMD)
  263. $(INTERMEDIATE_OUTPUT)/src/community_modules.c: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
  264. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  265. 	$(eval CMD=$(QMK_BIN) generate-community-modules-c -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules.c $(KEYMAP_JSON))
  266. 	@$(BUILD_CMD)
  268. $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.c: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
  269. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  270. 	$(eval CMD=$(QMK_BIN) generate-community-modules-introspection-c -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.c $(KEYMAP_JSON))
  271. 	@$(BUILD_CMD)
  273. $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.h: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
  274. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  275. 	$(eval CMD=$(QMK_BIN) generate-community-modules-introspection-h -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.h $(KEYMAP_JSON))
  276. 	@$(BUILD_CMD)
  278. $(INTERMEDIATE_OUTPUT)/src/led_matrix_community_modules.inc: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
  279. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  280. 	$(eval CMD=$(QMK_BIN) generate-led-matrix-community-modules-inc -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/led_matrix_community_modules.inc $(KEYMAP_JSON))
  281. 	@$(BUILD_CMD)
  283. $(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc: $(KEYMAP_JSON) $(DD_CONFIG_FILES)
  284. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  285. 	$(eval CMD=$(QMK_BIN) generate-rgb-matrix-community-modules-inc -kb $(KEYBOARD) --quiet --output $(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc $(KEYMAP_JSON))
  286. 	@$(BUILD_CMD)
  288. SRC += $(INTERMEDIATE_OUTPUT)/src/community_modules.c
  290. generated-files: $(INTERMEDIATE_OUTPUT)/src/community_modules.h $(INTERMEDIATE_OUTPUT)/src/community_modules.c $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.c $(INTERMEDIATE_OUTPUT)/src/community_modules_introspection.h $(INTERMEDIATE_OUTPUT)/src/led_matrix_community_modules.inc $(INTERMEDIATE_OUTPUT)/src/rgb_matrix_community_modules.inc
  292. include $(BUILDDEFS_PATH)/converters.mk
  294. # Generate the board's version.h file.
  295. $(shell $(QMK_BIN) generate-version-h $(VERSION_H_FLAGS) -q -o $(INTERMEDIATE_OUTPUT)/src/version.h)
  297. MCU_ORIG := $(MCU)
  298. include $(wildcard $(PLATFORM_PATH)/*/mcu_selection.mk)
  300. # PLATFORM_KEY should be detected in DD keyboard config via key 'processor' (or rules.mk 'MCU')
  301. ifeq ($(PLATFORM_KEY),)
  302.     $(call CATASTROPHIC_ERROR,Platform not defined)
  303. endif
  304. PLATFORM=$(shell echo $(PLATFORM_KEY) | tr '[:lower:]' '[:upper:]')
  306. # Find all the C source files to be compiled in subfolders.
  307. KEYBOARD_SRC :=
  309. KEYBOARD_C_1 := $(KEYBOARD_PATH_1)/$(KEYBOARD_FOLDER_1).c
  310. KEYBOARD_C_2 := $(KEYBOARD_PATH_2)/$(KEYBOARD_FOLDER_2).c
  311. KEYBOARD_C_3 := $(KEYBOARD_PATH_3)/$(KEYBOARD_FOLDER_3).c
  312. KEYBOARD_C_4 := $(KEYBOARD_PATH_4)/$(KEYBOARD_FOLDER_4).c
  313. KEYBOARD_C_5 := $(KEYBOARD_PATH_5)/$(KEYBOARD_FOLDER_5).c
  315. ifneq ("$(wildcard $(KEYBOARD_C_5))","")
  316.     KEYBOARD_SRC += $(KEYBOARD_C_5)
  317. endif
  318. ifneq ("$(wildcard $(KEYBOARD_C_4))","")
  319.     KEYBOARD_SRC += $(KEYBOARD_C_4)
  320. endif
  321. ifneq ("$(wildcard $(KEYBOARD_C_3))","")
  322.     KEYBOARD_SRC += $(KEYBOARD_C_3)
  323. endif
  324. ifneq ("$(wildcard $(KEYBOARD_C_2))","")
  325.     KEYBOARD_SRC += $(KEYBOARD_C_2)
  326. endif
  327. ifneq ("$(wildcard $(KEYBOARD_C_1))","")
  328.     KEYBOARD_SRC += $(KEYBOARD_C_1)
  329. endif
  331. # Generate KEYBOARD_name_subname for all levels of the keyboard folder
  332. KEYBOARD_FILESAFE_1 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_1)))
  333. KEYBOARD_FILESAFE_2 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_2)))
  334. KEYBOARD_FILESAFE_3 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_3)))
  335. KEYBOARD_FILESAFE_4 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_4)))
  336. KEYBOARD_FILESAFE_5 := $(subst .,,$(subst /,_,$(KEYBOARD_FOLDER_PATH_5)))
  338. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/)","")
  339.     OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_5)
  340. endif
  341. ifneq ("$(wildcard $(KEYBOARD_PATH_4)/)","")
  342.     OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_4)
  343. endif
  344. ifneq ("$(wildcard $(KEYBOARD_PATH_3)/)","")
  345.     OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_3)
  346. endif
  347. ifneq ("$(wildcard $(KEYBOARD_PATH_2)/)","")
  348.     OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_2)
  349. endif
  350. ifneq ("$(wildcard $(KEYBOARD_PATH_1)/)","")
  351.     OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE_1)
  352. endif
  354. # Setup the define for QMK_KEYBOARD_H. This is used inside of keymaps so
  355. # that the same keymap may be used on multiple keyboards.
  356. #
  357. # We grab the most top-level include file that we can. That file should
  358. # use #ifdef statements to include all the necessary subfolder includes,
  359. # as described here:
  360. #
  361. #    https://docs.qmk.fm/#/feature_layouts?id=tips-for-making-layouts-keyboard-agnostic
  362. #
  363. ifneq ("$(wildcard $(KEYBOARD_PATH_1)/$(KEYBOARD_FOLDER_1).h)","")
  364.     FOUND_KEYBOARD_H = $(KEYBOARD_FOLDER_1).h
  365. endif
  366. ifneq ("$(wildcard $(KEYBOARD_PATH_2)/$(KEYBOARD_FOLDER_2).h)","")
  367.     FOUND_KEYBOARD_H = $(KEYBOARD_FOLDER_2).h
  368. endif
  369. ifneq ("$(wildcard $(KEYBOARD_PATH_3)/$(KEYBOARD_FOLDER_3).h)","")
  370.     FOUND_KEYBOARD_H = $(KEYBOARD_FOLDER_3).h
  371. endif
  372. ifneq ("$(wildcard $(KEYBOARD_PATH_4)/$(KEYBOARD_FOLDER_4).h)","")
  373.     FOUND_KEYBOARD_H = $(KEYBOARD_FOLDER_4).h
  374. endif
  375. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/$(KEYBOARD_FOLDER_5).h)","")
  376.     FOUND_KEYBOARD_H = $(KEYBOARD_FOLDER_5).h
  377. endif
  379. # Find all of the config.h files and add them to our CONFIG_H define.
  380. CONFIG_H :=
  382. define config_h_community_module_appender
  383. 	ifneq ("$(wildcard $(1)/config.h)","")
  384. 		CONFIG_H += $(1)/config.h
  385. 	endif
  386. endef
  387. $(foreach module,$(COMMUNITY_MODULE_PATHS),$(eval $(call config_h_community_module_appender,$(module))))
  389. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/config.h)","")
  390.     CONFIG_H += $(KEYBOARD_PATH_5)/config.h
  391. endif
  392. ifneq ("$(wildcard $(KEYBOARD_PATH_4)/config.h)","")
  393.     CONFIG_H += $(KEYBOARD_PATH_4)/config.h
  394. endif
  395. ifneq ("$(wildcard $(KEYBOARD_PATH_3)/config.h)","")
  396.     CONFIG_H += $(KEYBOARD_PATH_3)/config.h
  397. endif
  398. ifneq ("$(wildcard $(KEYBOARD_PATH_2)/config.h)","")
  399.     CONFIG_H += $(KEYBOARD_PATH_2)/config.h
  400. endif
  401. ifneq ("$(wildcard $(KEYBOARD_PATH_1)/config.h)","")
  402.     CONFIG_H += $(KEYBOARD_PATH_1)/config.h
  403. endif
  405. POST_CONFIG_H :=
  407. define post_config_h_community_module_appender
  408. 	ifneq ("$(wildcard $(1)/post_config.h)","")
  409. 		POST_CONFIG_H += $(1)/post_config.h
  410. 	endif
  411. endef
  412. $(foreach module,$(COMMUNITY_MODULE_PATHS),$(eval $(call post_config_h_community_module_appender,$(module))))
  414. ifneq ("$(wildcard $(KEYBOARD_PATH_1)/post_config.h)","")
  415.     POST_CONFIG_H += $(KEYBOARD_PATH_1)/post_config.h
  416. endif
  417. ifneq ("$(wildcard $(KEYBOARD_PATH_2)/post_config.h)","")
  418.     POST_CONFIG_H += $(KEYBOARD_PATH_2)/post_config.h
  419. endif
  420. ifneq ("$(wildcard $(KEYBOARD_PATH_3)/post_config.h)","")
  421.     POST_CONFIG_H += $(KEYBOARD_PATH_3)/post_config.h
  422. endif
  423. ifneq ("$(wildcard $(KEYBOARD_PATH_4)/post_config.h)","")
  424.     POST_CONFIG_H += $(KEYBOARD_PATH_4)/post_config.h
  425. endif
  426. ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_config.h)","")
  427.     POST_CONFIG_H += $(KEYBOARD_PATH_5)/post_config.h
  428. endif
  430. CONFIG_H += $(INTERMEDIATE_OUTPUT)/src/info_config.h
  431. KEYBOARD_SRC += $(INTERMEDIATE_OUTPUT)/src/default_keyboard.c
  433. $(INTERMEDIATE_OUTPUT)/src/info_config.h: $(DD_CONFIG_FILES)
  434. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  435. 	$(eval CMD=$(QMK_BIN) generate-config-h --quiet --keyboard $(KEYBOARD) --output $(INTERMEDIATE_OUTPUT)/src/info_config.h)
  436. 	@$(BUILD_CMD)
  438. $(INTERMEDIATE_OUTPUT)/src/default_keyboard.c: $(DD_CONFIG_FILES)
  439. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  440. 	$(eval CMD=$(QMK_BIN) generate-keyboard-c --quiet --keyboard $(KEYBOARD) --output $(INTERMEDIATE_OUTPUT)/src/default_keyboard.c)
  441. 	@$(BUILD_CMD)
  443. $(INTERMEDIATE_OUTPUT)/src/default_keyboard.h: $(DD_CONFIG_FILES)
  444. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  445. 	$(eval CMD=$(QMK_BIN) generate-keyboard-h --quiet --keyboard $(KEYBOARD) --include $(FOUND_KEYBOARD_H) --output $(INTERMEDIATE_OUTPUT)/src/default_keyboard.h)
  446. 	@$(BUILD_CMD)
  448. generated-files: $(INTERMEDIATE_OUTPUT)/src/info_config.h $(INTERMEDIATE_OUTPUT)/src/default_keyboard.c $(INTERMEDIATE_OUTPUT)/src/default_keyboard.h
  450. generated-files: $(INTERMEDIATE_OUTPUT)/src/info_deps.d
  452. $(INTERMEDIATE_OUTPUT)/src/info_deps.d:
  453. 	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
  454. 	$(eval CMD=$(QMK_BIN) generate-make-dependencies -kb $(KEYBOARD) -km $(KEYMAP) -o $(INTERMEDIATE_OUTPUT)/src/info_deps.d)
  455. 	@$(BUILD_CMD)
  457. -include $(INTERMEDIATE_OUTPUT)/src/info_deps.d
  459. .INTERMEDIATE : generated-files
  461. # Userspace setup and definitions
  462. ifeq ("$(USER_NAME)","")
  463.     USER_NAME := $(KEYMAP)
  464. endif
  465. USER_PATH := users/$(USER_NAME)
  467. # If we have userspace, then add it to the lookup VPATH
  468. ifneq ($(wildcard $(QMK_USERSPACE)),)
  469.     VPATH += $(QMK_USERSPACE)
  470. endif
  472. # If the equivalent users directory exists in userspace, use that in preference to anything currently in the main repo
  473. ifneq ($(wildcard $(QMK_USERSPACE)/$(USER_PATH)),)
  474.     USER_PATH := $(QMK_USERSPACE)/$(USER_PATH)
  475. endif
  477. # Pull in user level rules.mk
  478. -include $(USER_PATH)/rules.mk
  479. ifneq ("$(wildcard $(USER_PATH)/config.h)","")
  480.     CONFIG_H += $(USER_PATH)/config.h
  481. endif
  482. ifneq ("$(wildcard $(USER_PATH)/post_config.h)","")
  483.     POST_CONFIG_H += $(USER_PATH)/post_config.h
  484. endif
  486. # Disable features that a keyboard doesn't support
  487. -include $(BUILDDEFS_PATH)/disable_features.mk
  489. ifneq ("$(CONVERTER)","")
  490.     -include $(CONVERTER)/post_converter.mk
  491. endif
  493. # Pull in post_rules.mk files from all our subfolders
  494. -include $(KEYBOARD_PATH_1)/post_rules.mk
  495. -include $(KEYBOARD_PATH_2)/post_rules.mk
  496. -include $(KEYBOARD_PATH_3)/post_rules.mk
  497. -include $(KEYBOARD_PATH_4)/post_rules.mk
  498. -include $(KEYBOARD_PATH_5)/post_rules.mk
  500. define post_rules_mk_community_module_includer
  501. 	ifneq ("$(wildcard $(1)/post_rules.mk)","")
  502. 		include $(1)/post_rules.mk
  503. 	endif
  504. endef
  505. $(foreach module,$(COMMUNITY_MODULE_PATHS),$(eval $(call post_rules_mk_community_module_includer,$(module))))
  507. ifneq ("$(wildcard $(KEYMAP_PATH)/config.h)","")
  508.     CONFIG_H += $(KEYMAP_PATH)/config.h
  509. endif
  510. ifneq ("$(KEYMAP_H)","")
  511.     CONFIG_H += $(KEYMAP_H)
  512. endif
  514. ifeq ($(KEYMAP_C),)
  515.     $(call CATASTROPHIC_ERROR,Invalid keymap,Could not find keymap)
  516. endif
  518. OPT_DEFS += -DKEYMAP_C=\"$(KEYMAP_C)\"
  520. # If a keymap or userspace places their keymap array in another file instead, allow for it to be included
  521. # !!NOTE!! -- For this to work, the source file cannot be part of $(SRC), so users should not add it via `SRC += <file>`
  522. ifneq ($(strip $(INTROSPECTION_KEYMAP_C)),)
  523. OPT_DEFS += -DINTROSPECTION_KEYMAP_C=\"$(strip $(INTROSPECTION_KEYMAP_C))\"
  524. endif
  526. # project specific files
  527. SRC += \
  528.     $(KEYBOARD_SRC) \
  529.     $(QUANTUM_DIR)/keymap_introspection.c \
  530.     $(QUANTUM_SRC) \
  531.     $(QUANTUM_DIR)/main.c \
  533. # Optimize size but this may cause error "relocation truncated to fit"
  534. #EXTRALDFLAGS = -Wl,--relax
  536. # Search Path
  537. VPATH += $(KEYMAP_PATH)
  538. VPATH += $(USER_PATH)
  539. VPATH += $(KEYBOARD_PATHS)
  540. VPATH += $(COMMON_VPATH)
  541. VPATH += $(INTERMEDIATE_OUTPUT)/src
  543. include $(BUILDDEFS_PATH)/common_features.mk
  544. include $(BUILDDEFS_PATH)/generic_features.mk
  545. include $(TMK_PATH)/protocol.mk
  546. include $(PLATFORM_PATH)/common.mk
  548. SRC += $(patsubst %.c,%.clib,$(LIB_SRC))
  549. SRC += $(patsubst %.c,%.clib,$(QUANTUM_LIB_SRC))
  551. -include $(PLATFORM_PATH)/$(PLATFORM_KEY)/bootloader.mk
  552. include $(PLATFORM_PATH)/$(PLATFORM_KEY)/platform.mk
  553. -include $(PLATFORM_PATH)/$(PLATFORM_KEY)/flash.mk
  555. ifneq ($(strip $(PROTOCOL)),)
  556. PROTOCOL_KEY = $(strip $(shell echo $(PROTOCOL) | tr '[:upper:]' '[:lower:]'))
  557. else
  558. PROTOCOL_KEY = $(PLATFORM_KEY)
  559. endif
  560. include $(TMK_PATH)/protocol/$(PROTOCOL_KEY)/$(PROTOCOL_KEY).mk
  562. # Setup definitions based on the selected MCU
  563. $(eval $(call add_qmk_prefix_defs,MCU_ORIG,MCU))
  564. $(eval $(call add_qmk_prefix_defs,MCU_ARCH,MCU_ARCH))
  565. $(eval $(call add_qmk_prefix_defs,MCU_PORT_NAME,MCU_PORT_NAME))
  566. $(eval $(call add_qmk_prefix_defs,MCU_FAMILY,MCU_FAMILY))
  567. $(eval $(call add_qmk_prefix_defs,MCU_SERIES,MCU_SERIES))
  568. $(eval $(call add_qmk_prefix_defs,BOARD,BOARD))
  569. $(eval $(call add_qmk_prefix_defs,OPT,OPT))
  571. # Control whether intermediate file listings are generated
  572. # e.g.:
  573. #    make handwired/onekey/blackpill_f411:default KEEP_INTERMEDIATES=yes
  574. #    cat .build/obj_handwired_onekey_blackpill_f411_default/quantum/quantum.i | sed -e 's@^#.*@@g' -e 's@^\s*//.*@@g' -e '/^\s*$/d' | clang-format
  575. ifeq ($(strip $(KEEP_INTERMEDIATES)), yes)
  576.     OPT_DEFS += -save-temps=obj
  577. endif
  579. OUTPUTS := $(INTERMEDIATE_OUTPUT)
  580. $(INTERMEDIATE_OUTPUT)_SRC := $(SRC) $(PLATFORM_SRC)
  581. $(INTERMEDIATE_OUTPUT)_DEFS := \
  582. 	-DQMK_KEYBOARD=\"$(KEYBOARD)\" -DQMK_KEYBOARD_H=\"$(INTERMEDIATE_OUTPUT)/src/default_keyboard.h\" \
  583. 	-DQMK_KEYMAP=\"$(KEYMAP)\" -DQMK_KEYMAP_H=\"$(KEYMAP).h\" -DQMK_KEYMAP_CONFIG_H=\"$(KEYMAP_PATH)/config.h\" \
  584. 	$(OPT_DEFS)
  585. $(INTERMEDIATE_OUTPUT)_INC :=  $(VPATH) $(EXTRAINCDIRS) $(KEYBOARD_PATHS)
  586. $(INTERMEDIATE_OUTPUT)_CONFIG := $(CONFIG_H) $(POST_CONFIG_H)
  588. # Default target.
  589. all: build check-size
  591. build: elf cpfirmware
  592. check-size: build
  593. check-md5: build
  594. objs-size: build
  596. ifneq ($(strip $(TOP_SYMBOLS)),)
  597. ifeq ($(strip $(TOP_SYMBOLS)),yes)
  598. NUM_TOP_SYMBOLS := 10
  599. else
  600. NUM_TOP_SYMBOLS := $(strip $(TOP_SYMBOLS))
  601. endif
  602. all: top-symbols
  603. check-size: top-symbols
  604. top-symbols: build
  605. 	echo "###########################################"
  606. 	echo "# Highest flash usage:"
  607. 	$(NM) -Crtd --size-sort $(BUILD_DIR)/$(TARGET).elf | grep ' [RrTt] ' | head -n$(NUM_TOP_SYMBOLS) | sed -e 's#^0000000#       #g' -e 's#^000000#      #g' -e 's#^00000#     #g' -e 's#^0000#    #g' -e 's#^000#   #g' -e 's#^00#  #g' -e 's#^0# #g'
  608. 	echo "###########################################"
  609. 	echo "# Highest RAM usage:"
  610. 	$(NM) -Crtd --size-sort $(BUILD_DIR)/$(TARGET).elf | grep ' [BbCDdGgSs] ' | head -n$(NUM_TOP_SYMBOLS) | sed -e 's#^0000000#       #g' -e 's#^000000#      #g' -e 's#^00000#     #g' -e 's#^0000#    #g' -e 's#^000#   #g' -e 's#^00#  #g' -e 's#^0# #g'
  611. 	echo "###########################################"
  612. endif
  614. include $(BUILDDEFS_PATH)/show_options.mk
  615. include $(BUILDDEFS_PATH)/common_rules.mk
  617. # Ensure we have generated files available for each of the objects
  618. define GEN_FILES
  619. $1: generated-files
  620. endef
  621. $(foreach O,$(OBJ),$(eval $(call GEN_FILES,$(patsubst %.a,%.o,$(O)))))