Parent directory

build_keyboard.mk

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