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