5 # Never run this makefile in parallel, as it could screw things up
6 # It won't affect the submakes, so you still get the speedup from specifying -jx
9 # Allow the silent with lower caps to work the same way as upper caps
15 SUB_IS_SILENT := $(SILENT)
18 # We need to make sure that silent is always turned off at the top level
19 # Otherwise the [OK], [ERROR] and [WARN] messages won't be displayed correctly
20 override SILENT := false
22 QMK_VERSION := $(shell git describe --abbrev=0 --tags 2>/dev/null)
23 ifneq ($(QMK_VERSION),)
24 $(info QMK Firmware v$(QMK_VERSION))
27 ON_ERROR := error_occurred=1
31 STARTING_MAKEFILE := $(firstword $(MAKEFILE_LIST))
32 ROOT_MAKEFILE := $(lastword $(MAKEFILE_LIST))
33 ROOT_DIR := $(dir $(ROOT_MAKEFILE))
37 ABS_STARTING_MAKEFILE := $(abspath $(STARTING_MAKEFILE))
38 ABS_ROOT_MAKEFILE := $(abspath $(ROOT_MAKEFILE))
39 ABS_STARTING_DIR := $(dir $(ABS_STARTING_MAKEFILE))
40 ABS_ROOT_DIR := $(dir $(ABS_ROOT_MAKEFILE))
41 STARTING_DIR := $(subst $(ABS_ROOT_DIR),,$(ABS_STARTING_DIR))
42 BUILD_DIR := $(ROOT_DIR)/.build
43 TEST_DIR := $(BUILD_DIR)/test
44 ERROR_FILE := $(BUILD_DIR)/error_occurred
48 # Helper function to process the newt element of a space separated path
49 # It works a bit like the traditional functional head tail
50 # so the CURRENT_PATH_ELEMENT will become the new head
51 # and the PATH_ELEMENTS are the rest that are still unprocessed
52 define NEXT_PATH_ELEMENT
53 $$(eval CURRENT_PATH_ELEMENT := $$(firstword $$(PATH_ELEMENTS)))
54 $$(eval PATH_ELEMENTS := $$(wordlist 2,9999,$$(PATH_ELEMENTS)))
57 # We change the / to spaces so that we more easily can work with the elements
59 PATH_ELEMENTS := $(subst /, ,$(STARTING_DIR))
60 # Initialize the path elements list for further processing
61 $(eval $(call NEXT_PATH_ELEMENT))
63 # This function sets the KEYBOARD; KEYMAP and SUBPROJECT to the correct
64 # variables depending on which directory you stand in.
65 # It's really a very simple if else chain, if you squint enough,
66 # but the makefile syntax makes it very verbose.
67 # If we are in a subfolder of keyboards
68 ifeq ($(CURRENT_PATH_ELEMENT),keyboards)
69 $(eval $(call NEXT_PATH_ELEMENT))
70 KEYBOARD := $(CURRENT_PATH_ELEMENT)
71 $(eval $(call NEXT_PATH_ELEMENT))
72 # If we are in a subfolder of keymaps, or in other words in a keymap
74 ifeq ($(CURRENT_PATH_ELEMENT),keymaps)
75 $(eval $(call NEXT_PATH_ELEMENT))
76 KEYMAP := $(CURRENT_PATH_ELEMENT)
77 # else if we are not in the keyboard folder itself
78 else ifneq ($(CURRENT_PATH_ELEMENT),)
79 # the we can assume it's a subproject, as no other folders
80 # should have make files in them
81 SUBPROJECT := $(CURRENT_PATH_ELEMENT)
82 $(eval $(call NEXT_PATH_ELEMENT))
83 # if we are inside a keymap folder of a subproject
84 ifeq ($(CURRENT_PATH_ELEMENT),keymaps)
85 $(eval $(call NEXT_PATH_ELEMENT))
86 KEYMAP := $(CURRENT_PATH_ELEMENT)
91 # Only consider folders with makefiles, to prevent errors in case there are extra folders
92 KEYBOARDS := $(notdir $(patsubst %/Makefile,%,$(wildcard $(ROOT_DIR)/keyboards/*/Makefile)))
94 #Compatibility with the old make variables, anything you specify directly on the command line
95 # always overrides the detected folders
97 KEYBOARD := $(keyboard)
103 SUBPROJECT := $(subproject)
109 # Uncomment these for debugging
110 #$(info Keyboard: $(KEYBOARD))
111 #$(info Keymap: $(KEYMAP))
112 #$(info Subproject: $(SUBPROJECT))
113 #$(info Keyboards: $(KEYBOARDS))
116 # Set the default goal depending on where we are running make from
117 # this handles the case where you run make without any arguments
120 ifeq ($(SUBPROJECT),)
121 # Inside a keymap folder, just build the keymap, with the
123 .DEFAULT_GOAL := $(KEYBOARD)-$(KEYMAP)
125 # Inside a subproject keyamp folder, build the keymap
126 # for that subproject
127 .DEFAULT_GOAL := $(KEYBOARD)-$(SUBPROJECT)-$(KEYMAP)
129 else ifneq ($(SUBPROJECT),)
130 # Inside a subproject folder, build all keymaps for that subproject
131 .DEFAULT_GOAL := $(KEYBOARD)-$(SUBPROJECT)-allkm
132 else ifneq ($(KEYBOARD),)
133 # Inside a keyboard folder, build all keymaps for all subprojects
134 # Note that this is different from the old behaviour, which would
135 # build only the default keymap of the default keyboard
136 .DEFAULT_GOAL := $(KEYBOARD)-allsp-allkm
140 # Compare the start of the RULE variable with the first argument($1)
141 # If the rules equals $1 or starts with $1-, RULE_FOUND is set to true
142 # and $1 is removed from the RULE variable
143 # Otherwise the RULE_FOUND variable is set to false, and RULE left as it was
144 # The function is a bit tricky, since there's no built in $(startswith) function
145 define COMPARE_AND_REMOVE_FROM_RULE_HELPER
150 STARTDASH_REMOVED=$$(subst START$1-,,START$$(RULE))
151 ifneq ($$(STARTDASH_REMOVED),START$$(RULE))
153 RULE := $$(STARTDASH_REMOVED)
160 # This makes it easier to call COMPARE_AND_REMOVE_FROM_RULE, since it makes it behave like
161 # a function that returns the value
162 COMPARE_AND_REMOVE_FROM_RULE = $(eval $(call COMPARE_AND_REMOVE_FROM_RULE_HELPER,$1))$(RULE_FOUND)
165 # Recursively try to find a match for the start of the rule to be checked
166 # $1 The list to be checked
167 # If a match is found, then RULE_FOUND is set to true
168 # and MATCHED_ITEM to the item that was matched
169 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
171 ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,$$(firstword $1)),true)
172 MATCHED_ITEM := $$(firstword $1)
174 $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$$(wordlist 2,9999,$1)))
179 # A recursive helper function for finding the longest match
180 # $1 The list to be checked
181 # It works by always removing the currently matched item from the list
182 # and call itself recursively, until a match is found
183 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
184 # Stop the recursion when the list is empty
186 RULE_BEFORE := $$(RULE)
187 $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$1))
188 # If a match is found in the current list, otherwise just return what we had before
189 ifeq ($$(RULE_FOUND),true)
190 # Save the best match so far and call itself recursively
191 BEST_MATCH := $$(MATCHED_ITEM)
192 BEST_MATCH_RULE := $$(RULE)
194 RULE := $$(RULE_BEFORE)
195 $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2,$$(filter-out $$(MATCHED_ITEM),$1)))
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
207 $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2,$1))
208 ifneq ($$(BEST_MATCH),)
210 RULE := $$(BEST_MATCH_RULE)
211 MATCHED_ITEM := $$(BEST_MATCH)
218 # Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST
219 TRY_TO_MATCH_RULE_FROM_LIST = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER,$1))$(RULE_FOUND)
221 define ALL_IN_LIST_LOOP
222 OLD_RULE$1 := $$(RULE)
223 $$(eval $$(call $1,$$(ITEM$1)))
224 RULE := $$(OLD_RULE$1)
227 define PARSE_ALL_IN_LIST
228 $$(foreach ITEM$1,$2,$$(eval $$(call ALL_IN_LIST_LOOP,$1)))
231 # The entry point for rule parsing
232 # parses a rule in the format <keyboard>-<subproject>-<keymap>-<target>
233 # but this particular function only deals with the first <keyboard> part
237 # If the rule starts with allkb, then continue the parsing from
238 # PARSE_ALL_KEYBOARDS
239 ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,allkb),true)
240 $$(eval $$(call PARSE_ALL_KEYBOARDS))
241 else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,test),true)
242 $$(eval $$(call PARSE_TEST))
243 # If the rule starts with the name of a known keyboard, then continue
244 # the parsing from PARSE_KEYBOARD
245 else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYBOARDS)),true)
246 $$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
247 # Otherwise use the KEYBOARD variable, which is determined either by
248 # the current directory you run make from, or passed in as an argument
249 else ifneq ($$(KEYBOARD),)
250 $$(eval $$(call PARSE_KEYBOARD,$$(KEYBOARD)))
252 $$(info make: *** No rule to make target '$1'. Stop.)
253 # Notice the tab instead of spaces below!
259 # Parses a rule in the format <subproject>-<keymap>-<target>
260 # the keyboard is already known when entering this function
261 define PARSE_KEYBOARD
263 # A subproject is any keyboard subfolder with a makefile
264 SUBPROJECTS := $$(notdir $$(patsubst %/Makefile,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/*/Makefile)))
265 # if the rule starts with allsp, then continue with looping over all subprojects
266 ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,allsp),true)
267 $$(eval $$(call PARSE_ALL_SUBPROJECTS))
268 # A special case for matching the defaultsp (default subproject)
269 else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,defaultsp),true)
270 $$(eval $$(call PARSE_SUBPROJECT,defaultsp))
271 # If the rule starts with the name of a known subproject
272 else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(SUBPROJECTS)),true)
273 $$(eval $$(call PARSE_SUBPROJECT,$$(MATCHED_ITEM)))
274 # Try to use the SUBPROJECT variable, which is either determined by the
275 # directory which invoked make, or passed as an argument to make
276 else ifneq ($$(SUBPROJECT),)
277 $$(eval $$(call PARSE_SUBPROJECT,$$(SUBPROJECT)))
278 # If there's no matching subproject, we assume it's the default
279 # This will allow you to leave the subproject part of the target out
281 $$(eval $$(call PARSE_SUBPROJECT,))
285 # if we are going to compile all keyboards, match the rest of the rule
287 define PARSE_ALL_KEYBOARDS
288 $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(KEYBOARDS)))
292 # When entering this, the keyboard and subproject are known, so now we need
293 # to determine which keymaps are going to get compiled
294 define PARSE_SUBPROJECT
295 # If we want to compile the default subproject, then we need to
296 # include the correct makefile to determine the actual name of it
298 ifeq ($$(CURRENT_SP),)
299 CURRENT_SP := defaultsp
301 ifeq ($$(CURRENT_SP),defaultsp)
303 $$(eval include $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/Makefile)
304 CURRENT_SP := $$(SUBPROJECT_DEFAULT)
306 # If current subproject is empty (the default was not defined), and we have a list of subproject
307 # then make all of them
308 ifeq ($$(CURRENT_SP),)
309 ifneq ($$(SUBPROJECTS),)
313 # The special allsp is handled later
314 ifneq ($$(CURRENT_SP),allsp)
315 # get a list of all keymaps
316 KEYMAPS := $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/keymaps/*/.)))
317 ifneq ($$(CURRENT_SP),)
318 # if the subproject is defined, then also look for keymaps inside the subproject folder
319 SP_KEYMAPS := $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/$$(CURRENT_SP)/keymaps/*/.)))
320 KEYMAPS := $$(sort $$(KEYMAPS) $$(SP_KEYMAPS))
322 # if the rule after removing the start of it is empty (we haven't specified a kemap or target)
323 # compile all the keymaps
325 $$(eval $$(call PARSE_ALL_KEYMAPS))
326 # The same if allkm was specified
327 else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,allkm),true)
328 $$(eval $$(call PARSE_ALL_KEYMAPS))
329 # Try to match the specified keyamp with the list of known keymaps
330 else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYMAPS)),true)
331 $$(eval $$(call PARSE_KEYMAP,$$(MATCHED_ITEM)))
332 # Otherwise try to match the keymap from the current folder, or arguments to the make command
333 else ifneq ($$(KEYMAP),)
334 $$(eval $$(call PARSE_KEYMAP,$$(KEYMAP)))
335 # No matching keymap found, so we assume that the rest of the rule is the target
336 # If we haven't been able to parse out a subproject, then make all of them
337 # This is consistent with running make without any arguments from the keyboard
340 $$(eval $$(call PARSE_ALL_SUBPROJECTS))
341 # Otherwise, make all keymaps, again this is consistent with how it works without
344 $$(eval $$(call PARSE_ALL_KEYMAPS))
347 # As earlier mentioned when allsb is specified, we call our self recursively
348 # for all of the subprojects
349 $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_SUBPROJECT,$(SUBPROJECTS)))
353 # If we want to parse all subprojects, but the keyboard doesn't have any,
354 # then use defaultsp instead
355 define PARSE_ALL_SUBPROJECTS
356 ifeq ($$(SUBPROJECTS),)
357 $$(eval $$(call PARSE_SUBPROJECT,defaultsp))
359 $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_SUBPROJECT,$$(SUBPROJECTS)))
364 # This is the meat of compiling a keyboard, when entering this, everything is known
365 # keyboard, subproject, and keymap
366 # Note that we are not directly calling the command here, but instead building a list,
367 # which will later be processed
370 # The rest of the rule is the target
371 # Remove the leading "-" from the target, as it acts as a separator
372 MAKE_TARGET := $$(patsubst -%,%,$$(RULE))
373 # We need to generate an unique indentifer to append to the COMMANDS list
374 COMMAND := COMMAND_KEYBOARD_$$(CURRENT_KB)_SUBPROJECT_$(CURRENT_SP)_KEYMAP_$$(CURRENT_KM)
375 # If we are compiling a keyboard without a subproject, we want to display just the name
376 # of the keyboard, otherwise keyboard/subproject
377 ifeq ($$(CURRENT_SP),)
378 KB_SP := $(CURRENT_KB)
380 KB_SP := $(CURRENT_KB)/$$(CURRENT_SP)
383 KB_SP := $(BOLD)$$(KB_SP)$(NO_COLOR)
384 # Specify the variables that we are passing forward to submake
385 MAKE_VARS := KEYBOARD=$$(CURRENT_KB) SUBPROJECT=$$(CURRENT_SP) KEYMAP=$$(CURRENT_KM)
386 # And the first part of the make command
387 MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_keyboard.mk $$(MAKE_TARGET)
388 # The message to display
389 MAKE_MSG := $$(MSG_MAKE_KB)
390 # We run the command differently, depending on if we want more output or not
391 # The true version for silent output and the false version otherwise
392 $$(eval $$(call BUILD))
396 MAKE_VARS += VERBOSE=$(VERBOSE) COLOR=$(COLOR)
397 COMMANDS += $$(COMMAND)
398 COMMAND_true_$$(COMMAND) := \
399 printf "$$(MAKE_MSG)" | \
400 $$(MAKE_MSG_FORMAT); \
401 LOG=$$$$($$(MAKE_CMD) $$(MAKE_VARS) SILENT=true 2>&1) ; \
402 if [ $$$$? -gt 0 ]; \
403 then $$(PRINT_ERROR_PLAIN); \
404 elif [ "$$$$LOG" != "" ] ; \
405 then $$(PRINT_WARNING_PLAIN); \
409 COMMAND_false_$$(COMMAND) := \
410 printf "$$(MAKE_MSG)\n\n"; \
411 $$(MAKE_CMD) $$(MAKE_VARS) SILENT=false; \
412 if [ $$$$? -gt 0 ]; \
413 then error_occurred=1; \
417 # Just parse all the keymaps for a specific keyboard
418 define PARSE_ALL_KEYMAPS
419 $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYMAP,$$(KEYMAPS)))
426 MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_test.mk $$(MAKE_TARGET)
427 MAKE_VARS := TEST=$$(TEST_NAME) FULL_TESTS="$$(FULL_TESTS)"
428 MAKE_MSG := $$(MSG_MAKE_TEST)
429 $$(eval $$(call BUILD))
430 ifneq ($$(MAKE_TARGET),clean)
431 TEST_EXECUTABLE := $$(TEST_DIR)/$$(TEST_NAME).elf
432 TESTS += $$(TEST_NAME)
433 TEST_MSG := $$(MSG_TEST)
434 $$(TEST_NAME)_COMMAND := \
435 printf "$$(TEST_MSG)\n"; \
436 $$(TEST_EXECUTABLE); \
437 if [ $$$$? -gt 0 ]; \
438 then error_occurred=1; \
446 TEST_NAME := $$(firstword $$(subst -, ,$$(RULE)))
447 TEST_TARGET := $$(subst $$(TEST_NAME),,$$(subst $$(TEST_NAME)-,,$$(RULE)))
448 ifeq ($$(TEST_NAME),all)
449 MATCHED_TESTS := $$(TEST_LIST)
451 MATCHED_TESTS := $$(foreach TEST,$$(TEST_LIST),$$(if $$(findstring $$(TEST_NAME),$$(TEST)),$$(TEST),))
453 $$(foreach TEST,$$(MATCHED_TESTS),$$(eval $$(call BUILD_TEST,$$(TEST),$$(TEST_TARGET))))
457 # Set the silent mode depending on if we are trying to compile multiple keyboards or not
458 # By default it's on in that case, but it can be overridden by specifying silent=false
459 # from the command line
460 define SET_SILENT_MODE
462 SILENT_MODE := $(SUB_IS_SILENT)
463 else ifeq ($$(words $$(COMMANDS)),1)
470 include $(ROOT_DIR)/message.mk
472 ifeq ($(strip $(BREAK_ON_ERRORS)), yes)
473 HANDLE_ERROR = exit 1
475 HANDLE_ERROR = echo $$error_occurred > $(ERROR_FILE)
478 # The empty line is important here, as it will force a new shell to be created for each command
479 # Otherwise the command line will become too long with a lot of keyboards and keymaps
482 $(COMMAND_$(SILENT_MODE)_$(COMMAND))\
483 if [ $$error_occurred -gt 0 ]; then $(HANDLE_ERROR); fi;
490 if [ $$error_occurred -gt 0 ]; then $(HANDLE_ERROR); fi;
495 # Allow specifying just the subproject, in the keyboard directory, which will compile all keymaps
496 SUBPROJECTS := $(notdir $(patsubst %/Makefile,%,$(wildcard ./*/Makefile)))
497 .PHONY: $(SUBPROJECTS)
498 $(SUBPROJECTS): %: %-allkm
500 # Let's match everything, we handle all the rule parsing ourselves
503 # Check if we have the CMP tool installed
504 cmp $(ROOT_DIR)/Makefile $(ROOT_DIR)/Makefile >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi;
505 # Check if the submodules are dirty, and display a warning if they are
507 git submodule status --recursive 2>/dev/null | \
508 while IFS= read -r x; do \
511 *) printf "$(MSG_SUBMODULE_DIRTY)";break;; \
515 rm -f $(ERROR_FILE) > /dev/null 2>&1
516 $(eval $(call PARSE_RULE,$@))
517 $(eval $(call SET_SILENT_MODE))
518 # Run all the commands in the same shell, notice the + at the first line
519 # it has to be there to allow parallel execution of the submake
520 # This always tries to compile everything, even if error occurs in the middle
521 # But we return the error code at the end, to trigger travis failures
522 $(foreach COMMAND,$(COMMANDS),$(RUN_COMMAND))
523 if [ -f $(ERROR_FILE) ]; then printf "$(MSG_ERRORS)" & exit 1; fi;
524 $(foreach TEST,$(TESTS),$(RUN_TEST))
525 if [ -f $(ERROR_FILE) ]; then printf "$(MSG_ERRORS)" & exit 1; fi;
527 # All should compile everything
529 all: all-keyboards test-all
531 # Define some shortcuts, mostly for compatibility with the old syntax
532 .PHONY: all-keyboards
533 all-keyboards: allkb-allsp-allkm
535 .PHONY: all-keyboards-defaults
536 all-keyboards-defaults: allkb-allsp-default
542 test-clean: test-all-clean
548 # Generate the version.h file
550 GIT_VERSION := $(shell git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
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)
562 include $(ROOT_DIR)/testlist.mk