build_keyboard.mk 24 KB

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