build_keyboard.mk 21 KB

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