You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

644 lines
24KB

  1. ifndef VERBOSE
  2. .SILENT:
  3. endif
  4. # Never run this makefile in parallel, as it could screw things up
  5. # It won't affect the submakes, so you still get the speedup from specifying -jx
  6. .NOTPARALLEL:
  7. # Allow the silent with lower caps to work the same way as upper caps
  8. ifdef silent
  9. SILENT = $(silent)
  10. endif
  11. ifdef SILENT
  12. SUB_IS_SILENT := $(SILENT)
  13. endif
  14. # We need to make sure that silent is always turned off at the top level
  15. # Otherwise the [OK], [ERROR] and [WARN] messages won't be displayed correctly
  16. override SILENT := false
  17. ifndef SUB_IS_SILENT
  18. ifndef SKIP_GIT
  19. QMK_VERSION := $(shell git describe --abbrev=0 --tags 2>/dev/null)
  20. endif
  21. ifneq ($(QMK_VERSION),)
  22. $(info QMK Firmware $(QMK_VERSION))
  23. endif
  24. endif
  25. ON_ERROR := error_occurred=1
  26. BREAK_ON_ERRORS = no
  27. STARTING_MAKEFILE := $(firstword $(MAKEFILE_LIST))
  28. ROOT_MAKEFILE := $(lastword $(MAKEFILE_LIST))
  29. ROOT_DIR := $(dir $(ROOT_MAKEFILE))
  30. ifeq ($(ROOT_DIR),)
  31. ROOT_DIR := .
  32. endif
  33. ABS_STARTING_MAKEFILE := $(abspath $(STARTING_MAKEFILE))
  34. ABS_ROOT_MAKEFILE := $(abspath $(ROOT_MAKEFILE))
  35. ABS_STARTING_DIR := $(dir $(ABS_STARTING_MAKEFILE))
  36. ABS_ROOT_DIR := $(dir $(ABS_ROOT_MAKEFILE))
  37. STARTING_DIR := $(subst $(ABS_ROOT_DIR),,$(ABS_STARTING_DIR))
  38. BUILD_DIR := $(ROOT_DIR)/.build
  39. TEST_DIR := $(BUILD_DIR)/test
  40. ERROR_FILE := $(BUILD_DIR)/error_occurred
  41. MAKEFILE_INCLUDED=yes
  42. # Helper function to process the newt element of a space separated path
  43. # It works a bit like the traditional functional head tail
  44. # so the CURRENT_PATH_ELEMENT will become the new head
  45. # and the PATH_ELEMENTS are the rest that are still unprocessed
  46. define NEXT_PATH_ELEMENT
  47. $$(eval CURRENT_PATH_ELEMENT := $$(firstword $$(PATH_ELEMENTS)))
  48. $$(eval PATH_ELEMENTS := $$(wordlist 2,9999,$$(PATH_ELEMENTS)))
  49. endef
  50. # We change the / to spaces so that we more easily can work with the elements
  51. # separately
  52. PATH_ELEMENTS := $(subst /, ,$(STARTING_DIR))
  53. # Initialize the path elements list for further processing
  54. $(eval $(call NEXT_PATH_ELEMENT))
  55. # This function sets the KEYBOARD; KEYMAP and SUBPROJECT to the correct
  56. # variables depending on which directory you stand in.
  57. # It's really a very simple if else chain, if you squint enough,
  58. # but the makefile syntax makes it very verbose.
  59. # If we are in a subfolder of keyboards
  60. #
  61. # *** No longer needed **
  62. #
  63. # ifeq ($(CURRENT_PATH_ELEMENT),keyboards)
  64. # $(eval $(call NEXT_PATH_ELEMENT))
  65. # KEYBOARD := $(CURRENT_PATH_ELEMENT)
  66. # $(eval $(call NEXT_PATH_ELEMENT))
  67. # # If we are in a subfolder of keymaps, or in other words in a keymap
  68. # # folder
  69. # ifeq ($(CURRENT_PATH_ELEMENT),keymaps)
  70. # $(eval $(call NEXT_PATH_ELEMENT))
  71. # KEYMAP := $(CURRENT_PATH_ELEMENT)
  72. # # else if we are not in the keyboard folder itself
  73. # else ifneq ($(CURRENT_PATH_ELEMENT),)
  74. # # the we can assume it's a subproject, as no other folders
  75. # # should have make files in them
  76. # SUBPROJECT := $(CURRENT_PATH_ELEMENT)
  77. # $(eval $(call NEXT_PATH_ELEMENT))
  78. # # if we are inside a keymap folder of a subproject
  79. # ifeq ($(CURRENT_PATH_ELEMENT),keymaps)
  80. # $(eval $(call NEXT_PATH_ELEMENT))
  81. # KEYMAP := $(CURRENT_PATH_ELEMENT)
  82. # endif
  83. # endif
  84. # endif
  85. define GET_KEYBOARDS
  86. ifndef ALT_GET_KEYBOARDS
  87. All_RULES_MK := $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/rules.mk))
  88. All_RULES_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/rules.mk))
  89. All_RULES_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/rules.mk))
  90. All_RULES_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/*/rules.mk))
  91. KEYMAPS_MK := $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/keymaps/*/rules.mk))
  92. KEYMAPS_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/keymaps/*/rules.mk))
  93. KEYMAPS_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/keymaps/*/rules.mk))
  94. KEYMAPS_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/*/keymaps/*/rules.mk))
  95. KEYBOARDS := $$(sort $$(filter-out $$(KEYMAPS_MK), $$(All_RULES_MK)))
  96. else
  97. KEYBOARDS := $(shell find keyboards/ -type f -iname "rules.mk" | grep -v keymaps | sed 's!keyboards/\(.*\)/rules.mk!\1!' | sort | uniq)
  98. endif
  99. endef
  100. $(eval $(call GET_KEYBOARDS))
  101. # Only consider folders with makefiles, to prevent errors in case there are extra folders
  102. #KEYBOARDS += $(patsubst $(ROOD_DIR)/keyboards/%/rules.mk,%,$(wildcard $(ROOT_DIR)/keyboards/*/*/rules.mk))
  103. .PHONY: list-keyboards
  104. list-keyboards:
  105. echo $(KEYBOARDS)
  106. define PRINT_KEYBOARD
  107. $(info $(PRINTING_KEYBOARD))
  108. endef
  109. .PHONY: generate-keyboards-file
  110. generate-keyboards-file:
  111. $(foreach PRINTING_KEYBOARD,$(KEYBOARDS),$(eval $(call PRINT_KEYBOARD)))
  112. .PHONY: clean
  113. clean:
  114. echo -n 'Deleting .build/ ... '
  115. rm -rf $(BUILD_DIR)
  116. echo 'done.'
  117. .PHONY: distclean
  118. distclean: clean
  119. echo -n 'Deleting *.bin and *.hex ... '
  120. rm -f *.bin *.hex
  121. echo 'done.'
  122. #Compatibility with the old make variables, anything you specify directly on the command line
  123. # always overrides the detected folders
  124. ifdef keyboard
  125. KEYBOARD := $(keyboard)
  126. endif
  127. ifdef keymap
  128. KEYMAP := $(keymap)
  129. endif
  130. # Uncomment these for debugging
  131. # $(info Keyboard: $(KEYBOARD))
  132. # $(info Keymap: $(KEYMAP))
  133. # $(info Subproject: $(SUBPROJECT))
  134. # $(info Keyboards: $(KEYBOARDS))
  135. # Set the default goal depending on where we are running make from
  136. # this handles the case where you run make without any arguments
  137. .DEFAULT_GOAL := all:all
  138. ifneq ($(KEYMAP),)
  139. .DEFAULT_GOAL := $(KEYBOARD):$(KEYMAP)
  140. else ifneq ($(KEYBOARD),)
  141. # Inside a keyboard folder, build all keymaps for all subprojects
  142. # Note that this is different from the old behaviour, which would
  143. # build only the default keymap of the default keyboard
  144. .DEFAULT_GOAL := $(KEYBOARD):all
  145. endif
  146. # Compare the start of the RULE variable with the first argument($1)
  147. # If the rules equals $1 or starts with $1:, RULE_FOUND is set to true
  148. # and $1 is removed from the RULE variable
  149. # Otherwise the RULE_FOUND variable is set to false, and RULE left as it was
  150. # The function is a bit tricky, since there's no built in $(startswith) function
  151. define COMPARE_AND_REMOVE_FROM_RULE_HELPER
  152. ifeq ($1,$$(RULE))
  153. RULE:=
  154. RULE_FOUND := true
  155. else
  156. STARTCOLON_REMOVED=$$(subst START$1:,,START$$(RULE))
  157. ifneq ($$(STARTCOLON_REMOVED),START$$(RULE))
  158. RULE_FOUND := true
  159. RULE := $$(STARTCOLON_REMOVED)
  160. else
  161. RULE_FOUND := false
  162. endif
  163. endif
  164. endef
  165. # This makes it easier to call COMPARE_AND_REMOVE_FROM_RULE, since it makes it behave like
  166. # a function that returns the value
  167. COMPARE_AND_REMOVE_FROM_RULE = $(eval $(call COMPARE_AND_REMOVE_FROM_RULE_HELPER,$1))$(RULE_FOUND)
  168. # Recursively try to find a match for the start of the rule to be checked
  169. # $1 The list to be checked
  170. # If a match is found, then RULE_FOUND is set to true
  171. # and MATCHED_ITEM to the item that was matched
  172. define TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
  173. ifneq ($1,)
  174. ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,$$(firstword $1)),true)
  175. MATCHED_ITEM := $$(firstword $1)
  176. else
  177. $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$$(wordlist 2,9999,$1)))
  178. endif
  179. endif
  180. endef
  181. # A recursive helper function for finding the longest match
  182. # $1 The list to be checked
  183. # It works by always removing the currently matched item from the list
  184. # and call itself recursively, until a match is found
  185. define TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
  186. # Stop the recursion when the list is empty
  187. ifneq ($1,)
  188. RULE_BEFORE := $$(RULE)
  189. $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$1))
  190. # If a match is found in the current list, otherwise just return what we had before
  191. ifeq ($$(RULE_FOUND),true)
  192. # Save the best match so far and call itself recursively
  193. BEST_MATCH := $$(MATCHED_ITEM)
  194. BEST_MATCH_RULE := $$(RULE)
  195. RULE_FOUND := false
  196. RULE := $$(RULE_BEFORE)
  197. $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2,$$(filter-out $$(MATCHED_ITEM),$1)))
  198. endif
  199. endif
  200. endef
  201. # Recursively try to find the longest match for the start of the rule to be checked
  202. # $1 The list to be checked
  203. # If a match is found, then RULE_FOUND is set to true
  204. # and MATCHED_ITEM to the item that was matched
  205. define TRY_TO_MATCH_RULE_FROM_LIST_HELPER
  206. BEST_MATCH :=
  207. $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2,$1))
  208. ifneq ($$(BEST_MATCH),)
  209. RULE_FOUND := true
  210. RULE := $$(BEST_MATCH_RULE)
  211. MATCHED_ITEM := $$(BEST_MATCH)
  212. else
  213. RULE_FOUND := false
  214. MATCHED_ITEM :=
  215. endif
  216. endef
  217. # Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST
  218. TRY_TO_MATCH_RULE_FROM_LIST = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER,$1))$(RULE_FOUND)
  219. define ALL_IN_LIST_LOOP
  220. OLD_RULE$1 := $$(RULE)
  221. $$(eval $$(call $1,$$(ITEM$1)))
  222. RULE := $$(OLD_RULE$1)
  223. endef
  224. define PARSE_ALL_IN_LIST
  225. $$(foreach ITEM$1,$2,$$(eval $$(call ALL_IN_LIST_LOOP,$1)))
  226. endef
  227. # The entry point for rule parsing
  228. # parses a rule in the format <keyboard>:<keymap>:<target>
  229. # but this particular function only deals with the first <keyboard> part
  230. define PARSE_RULE
  231. RULE := $1
  232. COMMANDS :=
  233. # If the rule starts with all, then continue the parsing from
  234. # PARSE_ALL_KEYBOARDS
  235. ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all),true)
  236. KEYBOARD_RULE=all
  237. $$(eval $$(call PARSE_ALL_KEYBOARDS))
  238. else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,test),true)
  239. $$(eval $$(call PARSE_TEST))
  240. # If the rule starts with the name of a known keyboard, then continue
  241. # the parsing from PARSE_KEYBOARD
  242. else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYBOARDS)),true)
  243. KEYBOARD_RULE=$$(MATCHED_ITEM)
  244. $$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
  245. # Otherwise use the KEYBOARD variable, which is determined either by
  246. # the current directory you run make from, or passed in as an argument
  247. else ifneq ($$(KEYBOARD),)
  248. $$(eval $$(call PARSE_KEYBOARD,$$(KEYBOARD)))
  249. else
  250. $$(info make: *** No rule to make target '$1'. Stop.)
  251. $$(info |)
  252. $$(info | QMK's make format recently changed to use folder locations and colons:)
  253. $$(info | make project_folder:keymap[:target])
  254. $$(info | Examples:)
  255. $$(info | make planck/rev4:default:dfu)
  256. $$(info | make planck:default)
  257. $$(info |)
  258. endif
  259. endef
  260. # $1 = Keyboard
  261. # Parses a rule in the format <keymap>:<target>
  262. # the keyboard is already known when entering this function
  263. define PARSE_KEYBOARD
  264. # If we want to compile the default subproject, then we need to
  265. # include the correct makefile to determine the actual name of it
  266. CURRENT_KB := $1
  267. # KEYBOARD_FOLDERS := $$(subst /, , $(CURRENT_KB))
  268. DEFAULT_FOLDER := $$(CURRENT_KB)
  269. # We assume that every rules.mk will contain the full default value
  270. $$(eval include $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/rules.mk)
  271. ifneq ($$(DEFAULT_FOLDER),$$(CURRENT_KB))
  272. $$(eval include $(ROOT_DIR)/keyboards/$$(DEFAULT_FOLDER)/rules.mk)
  273. endif
  274. CURRENT_KB := $$(DEFAULT_FOLDER)
  275. # 5/4/3/2/1
  276. KEYBOARD_FOLDER_PATH_1 := $$(CURRENT_KB)
  277. KEYBOARD_FOLDER_PATH_2 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_1)))
  278. KEYBOARD_FOLDER_PATH_3 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_2)))
  279. KEYBOARD_FOLDER_PATH_4 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_3)))
  280. KEYBOARD_FOLDER_PATH_5 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_4)))
  281. KEYMAPS :=
  282. # get a list of all keymaps
  283. KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_1)/keymaps/*/.)))
  284. KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_2)/keymaps/*/.)))
  285. KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_3)/keymaps/*/.)))
  286. KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_4)/keymaps/*/.)))
  287. KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_5)/keymaps/*/.)))
  288. # this might be needed, but in a different form
  289. #KEYMAPS := $$(sort $$(filter-out $$(KEYBOARD_FOLDER_1) $$(KEYBOARD_FOLDER_2) \
  290. $$(KEYBOARD_FOLDER_3) $$(KEYBOARD_FOLDER_4) $$(KEYBOARD_FOLDER_5), $$(KEYMAPS)))
  291. KEYBOARD_LAYOUTS :=
  292. ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_5)/rules.mk)","")
  293. LAYOUTS :=
  294. $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_5)/rules.mk)
  295. KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
  296. endif
  297. ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_4)/rules.mk)","")
  298. LAYOUTS :=
  299. $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_4)/rules.mk)
  300. KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
  301. endif
  302. ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_3)/rules.mk)","")
  303. LAYOUTS :=
  304. $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_3)/rules.mk)
  305. KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
  306. endif
  307. ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_2)/rules.mk)","")
  308. LAYOUTS :=
  309. $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_2)/rules.mk)
  310. KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
  311. endif
  312. ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_1)/rules.mk)","")
  313. LAYOUTS :=
  314. $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_1)/rules.mk)
  315. KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
  316. endif
  317. LAYOUT_KEYMAPS :=
  318. $$(foreach LAYOUT,$$(KEYBOARD_LAYOUTS),$$(eval LAYOUT_KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/layouts/*/$$(LAYOUT)/*/.)))))
  319. KEYMAPS := $$(sort $$(KEYMAPS) $$(LAYOUT_KEYMAPS))
  320. # if the rule after removing the start of it is empty (we haven't specified a kemap or target)
  321. # compile all the keymaps
  322. ifeq ($$(RULE),)
  323. $$(eval $$(call PARSE_ALL_KEYMAPS))
  324. # The same if all was specified
  325. else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all),true)
  326. $$(eval $$(call PARSE_ALL_KEYMAPS))
  327. # List all keymaps for the given keyboard
  328. else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,list-keymaps),true)
  329. $$(eval $$(call LIST_ALL_KEYMAPS))
  330. # Try to match the specified keyamp with the list of known keymaps
  331. else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYMAPS)),true)
  332. $$(eval $$(call PARSE_KEYMAP,$$(MATCHED_ITEM)))
  333. # Otherwise try to match the keymap from the current folder, or arguments to the make command
  334. else ifneq ($$(KEYMAP),)
  335. $$(eval $$(call PARSE_KEYMAP,$$(KEYMAP)))
  336. # Otherwise if we are running make all:<user> just skip
  337. else ifeq ($$(KEYBOARD_RULE),all)
  338. # $$(info Skipping: No user keymap for $$(CURRENT_KB))
  339. # Otherwise, make all keymaps, again this is consistent with how it works without
  340. # any arguments
  341. else
  342. $$(eval $$(call PARSE_ALL_KEYMAPS))
  343. endif
  344. endef
  345. # if we are going to compile all keyboards, match the rest of the rule
  346. # for each of them
  347. define PARSE_ALL_KEYBOARDS
  348. $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(KEYBOARDS)))
  349. endef
  350. # $1 Subproject
  351. # When entering this, the keyboard and subproject are known, so now we need
  352. # to determine which keymaps are going to get compiled
  353. # define PARSE_SUBPROJECT
  354. # endef
  355. # If we want to parse all subprojects, but the keyboard doesn't have any,
  356. # then use defaultsp instead
  357. # define PARSE_ALL_SUBPROJECTS
  358. # ifeq ($$(SUBPROJECTS),)
  359. # $$(eval $$(call PARSE_SUBPROJECT,defaultsp))
  360. # else
  361. # $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_SUBPROJECT,$$(SUBPROJECTS)))
  362. # endif
  363. # endef
  364. # Prints a list of all known keymaps for the given keyboard
  365. define LIST_ALL_KEYMAPS
  366. COMMAND_true_LIST_KEYMAPS := \
  367. printf "$$(KEYMAPS)\n";
  368. COMMAND_false_LIST_KEYMAPS := \
  369. printf "$$(MSG_AVAILABLE_KEYMAPS)\n"; \
  370. printf "$$(KEYMAPS)\n";
  371. COMMANDS += LIST_KEYMAPS
  372. endef
  373. # $1 Keymap
  374. # This is the meat of compiling a keyboard, when entering this, everything is known
  375. # keyboard, subproject, and keymap
  376. # Note that we are not directly calling the command here, but instead building a list,
  377. # which will later be processed
  378. define PARSE_KEYMAP
  379. CURRENT_KM = $1
  380. # The rest of the rule is the target
  381. # Remove the leading ":" from the target, as it acts as a separator
  382. MAKE_TARGET := $$(patsubst :%,%,$$(RULE))
  383. # We need to generate an unique indentifer to append to the COMMANDS list
  384. CURRENT_KB_UNDER := $$(subst /,_,$$(CURRENT_KB))
  385. COMMAND := COMMAND_KEYBOARD_$$(CURRENT_KB_UNDER)_KEYMAP_$$(CURRENT_KM)
  386. # If we are compiling a keyboard without a subproject, we want to display just the name
  387. # of the keyboard, otherwise keyboard/subproject
  388. KB_SP := $$(CURRENT_KB)
  389. # Format it in bold
  390. KB_SP := $(BOLD)$$(KB_SP)$(NO_COLOR)
  391. # Specify the variables that we are passing forward to submake
  392. MAKE_VARS := KEYBOARD=$$(CURRENT_KB) KEYMAP=$$(CURRENT_KM)
  393. # And the first part of the make command
  394. MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_keyboard.mk $$(MAKE_TARGET)
  395. # The message to display
  396. MAKE_MSG := $$(MSG_MAKE_KB)
  397. # We run the command differently, depending on if we want more output or not
  398. # The true version for silent output and the false version otherwise
  399. $$(eval $$(call BUILD))
  400. endef
  401. define BUILD
  402. MAKE_VARS += VERBOSE=$(VERBOSE) COLOR=$(COLOR)
  403. COMMANDS += $$(COMMAND)
  404. COMMAND_true_$$(COMMAND) := \
  405. printf "$$(MAKE_MSG)" | \
  406. $$(MAKE_MSG_FORMAT); \
  407. LOG=$$$$($$(MAKE_CMD) $$(MAKE_VARS) SILENT=true 2>&1) ; \
  408. if [ $$$$? -gt 0 ]; \
  409. then $$(PRINT_ERROR_PLAIN); \
  410. elif [ "$$$$LOG" != "" ] ; \
  411. then $$(PRINT_WARNING_PLAIN); \
  412. else \
  413. $$(PRINT_OK); \
  414. fi;
  415. COMMAND_false_$$(COMMAND) := \
  416. printf "$$(MAKE_MSG)\n\n"; \
  417. $$(MAKE_CMD) $$(MAKE_VARS) SILENT=false; \
  418. if [ $$$$? -gt 0 ]; \
  419. then error_occurred=1; \
  420. fi;
  421. endef
  422. # Just parse all the keymaps for a specific keyboard
  423. define PARSE_ALL_KEYMAPS
  424. $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYMAP,$$(KEYMAPS)))
  425. endef
  426. define BUILD_TEST
  427. TEST_NAME := $1
  428. MAKE_TARGET := $2
  429. COMMAND := $1
  430. MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_test.mk $$(MAKE_TARGET)
  431. MAKE_VARS := TEST=$$(TEST_NAME) FULL_TESTS="$$(FULL_TESTS)"
  432. MAKE_MSG := $$(MSG_MAKE_TEST)
  433. $$(eval $$(call BUILD))
  434. ifneq ($$(MAKE_TARGET),clean)
  435. TEST_EXECUTABLE := $$(TEST_DIR)/$$(TEST_NAME).elf
  436. TESTS += $$(TEST_NAME)
  437. TEST_MSG := $$(MSG_TEST)
  438. $$(TEST_NAME)_COMMAND := \
  439. printf "$$(TEST_MSG)\n"; \
  440. $$(TEST_EXECUTABLE); \
  441. if [ $$$$? -gt 0 ]; \
  442. then error_occurred=1; \
  443. fi; \
  444. printf "\n";
  445. endif
  446. endef
  447. define PARSE_TEST
  448. TESTS :=
  449. TEST_NAME := $$(firstword $$(subst :, ,$$(RULE)))
  450. TEST_TARGET := $$(subst $$(TEST_NAME),,$$(subst $$(TEST_NAME):,,$$(RULE)))
  451. ifeq ($$(TEST_NAME),all)
  452. MATCHED_TESTS := $$(TEST_LIST)
  453. else
  454. MATCHED_TESTS := $$(foreach TEST,$$(TEST_LIST),$$(if $$(findstring $$(TEST_NAME),$$(TEST)),$$(TEST),))
  455. endif
  456. $$(foreach TEST,$$(MATCHED_TESTS),$$(eval $$(call BUILD_TEST,$$(TEST),$$(TEST_TARGET))))
  457. endef
  458. # Set the silent mode depending on if we are trying to compile multiple keyboards or not
  459. # By default it's on in that case, but it can be overridden by specifying silent=false
  460. # from the command line
  461. define SET_SILENT_MODE
  462. ifdef SUB_IS_SILENT
  463. SILENT_MODE := $(SUB_IS_SILENT)
  464. else ifeq ($$(words $$(COMMANDS)),1)
  465. SILENT_MODE := false
  466. else
  467. SILENT_MODE := true
  468. endif
  469. endef
  470. include $(ROOT_DIR)/message.mk
  471. ifeq ($(strip $(BREAK_ON_ERRORS)), yes)
  472. HANDLE_ERROR = exit 1
  473. else
  474. HANDLE_ERROR = echo $$error_occurred > $(ERROR_FILE)
  475. endif
  476. # The empty line is important here, as it will force a new shell to be created for each command
  477. # Otherwise the command line will become too long with a lot of keyboards and keymaps
  478. define RUN_COMMAND
  479. +error_occurred=0;\
  480. $(COMMAND_$(SILENT_MODE)_$(COMMAND))\
  481. if [ $$error_occurred -gt 0 ]; then $(HANDLE_ERROR); fi;
  482. endef
  483. define RUN_TEST
  484. +error_occurred=0;\
  485. $($(TEST)_COMMAND)\
  486. if [ $$error_occurred -gt 0 ]; then $(HANDLE_ERROR); fi;
  487. endef
  488. # Let's match everything, we handle all the rule parsing ourselves
  489. .PHONY: %
  490. %:
  491. # Check if we have the CMP tool installed
  492. cmp $(ROOT_DIR)/Makefile $(ROOT_DIR)/Makefile >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi;
  493. # Ensure that python3 is installed. This check can be removed after python is used in more places.
  494. if ! python3 --version 1> /dev/null 2>&1; then printf "$(MSG_PYTHON_MISSING)"; fi
  495. # Check if the submodules are dirty, and display a warning if they are
  496. ifndef SKIP_GIT
  497. if [ ! -e lib/chibios ]; then git submodule sync lib/chibios && git submodule update --depth 50 --init lib/chibios; fi
  498. if [ ! -e lib/chibios-contrib ]; then git submodule sync lib/chibios-contrib && git submodule update --depth 50 --init lib/chibios-contrib; fi
  499. if [ ! -e lib/ugfx ]; then git submodule sync lib/ugfx && git submodule update --depth 50 --init lib/ugfx; fi
  500. if [ ! -e lib/lufa ]; then git submodule sync lib/lufa && git submodule update --depth 50 --init lib/lufa; fi
  501. git submodule status --recursive 2>/dev/null | \
  502. while IFS= read -r x; do \
  503. case "$$x" in \
  504. \ *) ;; \
  505. *) printf "$(MSG_SUBMODULE_DIRTY)";break;; \
  506. esac \
  507. done
  508. endif
  509. rm -f $(ERROR_FILE) > /dev/null 2>&1
  510. $(eval $(call PARSE_RULE,$@))
  511. $(eval $(call SET_SILENT_MODE))
  512. # Run all the commands in the same shell, notice the + at the first line
  513. # it has to be there to allow parallel execution of the submake
  514. # This always tries to compile everything, even if error occurs in the middle
  515. # But we return the error code at the end, to trigger travis failures
  516. # The sort at this point is to remove duplicates
  517. $(foreach COMMAND,$(sort $(COMMANDS)),$(RUN_COMMAND))
  518. if [ -f $(ERROR_FILE) ]; then printf "$(MSG_ERRORS)" & exit 1; fi;
  519. $(foreach TEST,$(sort $(TESTS)),$(RUN_TEST))
  520. if [ -f $(ERROR_FILE) ]; then printf "$(MSG_ERRORS)" & exit 1; fi;
  521. # These no longer work because of the colon system
  522. # All should compile everything
  523. # .PHONY: all
  524. # all: all-keyboards test-all
  525. # Define some shortcuts, mostly for compatibility with the old syntax
  526. # .PHONY: all-keyboards
  527. # all-keyboards: all\:all\:all
  528. # .PHONY: all-keyboards-defaults
  529. # all-keyboards-defaults: all\:default
  530. # .PHONY: test
  531. # test: test-all
  532. # .PHONY: test-clean
  533. # test-clean: test-all-clean
  534. lib/%:
  535. git submodule sync $?
  536. git submodule update --init $?
  537. .PHONY: git-submodule
  538. git-submodule:
  539. git submodule sync --recursive
  540. git submodule update --init --recursive --progress
  541. ifdef SKIP_VERSION
  542. SKIP_GIT := yes
  543. endif
  544. # Generate the version.h file
  545. ifndef SKIP_GIT
  546. GIT_VERSION := $(shell git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
  547. CHIBIOS_VERSION := $(shell cd lib/chibios && git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
  548. CHIBIOS_CONTRIB_VERSION := $(shell cd lib/chibios-contrib && git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
  549. else
  550. GIT_VERSION := NA
  551. CHIBIOS_VERSION := NA
  552. CHIBIOS_CONTRIB_VERSION := NA
  553. endif
  554. ifndef SKIP_VERSION
  555. BUILD_DATE := $(shell date +"%Y-%m-%d-%H:%M:%S")
  556. $(shell echo '#define QMK_VERSION "$(GIT_VERSION)"' > $(ROOT_DIR)/quantum/version.h)
  557. $(shell echo '#define QMK_BUILDDATE "$(BUILD_DATE)"' >> $(ROOT_DIR)/quantum/version.h)
  558. $(shell echo '#define CHIBIOS_VERSION "$(CHIBIOS_VERSION)"' >> $(ROOT_DIR)/quantum/version.h)
  559. $(shell echo '#define CHIBIOS_CONTRIB_VERSION "$(CHIBIOS_CONTRIB_VERSION)"' >> $(ROOT_DIR)/quantum/version.h)
  560. else
  561. BUILD_DATE := NA
  562. endif
  563. include $(ROOT_DIR)/testlist.mk