1 # Determine what keyboard we are building and setup the build environment.
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.
15 # Set the filename for the final firmware binary
16 KEYBOARD_FILESAFE := $(subst /,_,$(KEYBOARD))
17 TARGET ?= $(KEYBOARD_FILESAFE)_$(KEYMAP)
18 KEYBOARD_OUTPUT := $(BUILD_DIR)/obj_$(KEYBOARD_FILESAFE)
23 # For split boards we need to set a master half.
29 ifeq ($(MASTER),right)
30 OPT_DEFS += -DMASTER_IS_ON_RIGHT
32 ifneq ($(MASTER),left)
33 $(error MASTER does not have a valid value(left/right))
37 # Determine which subfolders exist.
38 KEYBOARD_FOLDER_PATH_1 := $(KEYBOARD)
39 KEYBOARD_FOLDER_PATH_2 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_1)))
40 KEYBOARD_FOLDER_PATH_3 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_2)))
41 KEYBOARD_FOLDER_PATH_4 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_3)))
42 KEYBOARD_FOLDER_PATH_5 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_4)))
43 KEYBOARD_FOLDER_1 := $(notdir $(KEYBOARD_FOLDER_PATH_1))
44 KEYBOARD_FOLDER_2 := $(notdir $(KEYBOARD_FOLDER_PATH_2))
45 KEYBOARD_FOLDER_3 := $(notdir $(KEYBOARD_FOLDER_PATH_3))
46 KEYBOARD_FOLDER_4 := $(notdir $(KEYBOARD_FOLDER_PATH_4))
47 KEYBOARD_FOLDER_5 := $(notdir $(KEYBOARD_FOLDER_PATH_5))
49 KEYBOARD_PATH_1 := keyboards/$(KEYBOARD_FOLDER_PATH_1)
50 KEYBOARD_PATH_2 := keyboards/$(KEYBOARD_FOLDER_PATH_2)
51 KEYBOARD_PATH_3 := keyboards/$(KEYBOARD_FOLDER_PATH_3)
52 KEYBOARD_PATH_4 := keyboards/$(KEYBOARD_FOLDER_PATH_4)
53 KEYBOARD_PATH_5 := keyboards/$(KEYBOARD_FOLDER_PATH_5)
55 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/)","")
56 KEYBOARD_PATHS += $(KEYBOARD_PATH_5)
58 ifneq ("$(wildcard $(KEYBOARD_PATH_4)/)","")
59 KEYBOARD_PATHS += $(KEYBOARD_PATH_4)
61 ifneq ("$(wildcard $(KEYBOARD_PATH_3)/)","")
62 KEYBOARD_PATHS += $(KEYBOARD_PATH_3)
64 ifneq ("$(wildcard $(KEYBOARD_PATH_2)/)","")
65 KEYBOARD_PATHS += $(KEYBOARD_PATH_2)
67 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/)","")
68 KEYBOARD_PATHS += $(KEYBOARD_PATH_1)
71 # Pull in rules.mk files from all our subfolders
72 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/rules.mk)","")
73 include $(KEYBOARD_PATH_5)/rules.mk
75 ifneq ("$(wildcard $(KEYBOARD_PATH_4)/rules.mk)","")
76 include $(KEYBOARD_PATH_4)/rules.mk
78 ifneq ("$(wildcard $(KEYBOARD_PATH_3)/rules.mk)","")
79 include $(KEYBOARD_PATH_3)/rules.mk
81 ifneq ("$(wildcard $(KEYBOARD_PATH_2)/rules.mk)","")
82 include $(KEYBOARD_PATH_2)/rules.mk
84 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/rules.mk)","")
85 include $(KEYBOARD_PATH_1)/rules.mk
88 # Find all the C source files to be compiled in subfolders.
91 KEYBOARD_C_1 := $(KEYBOARD_PATH_1)/$(KEYBOARD_FOLDER_1).c
92 KEYBOARD_C_2 := $(KEYBOARD_PATH_2)/$(KEYBOARD_FOLDER_2).c
93 KEYBOARD_C_3 := $(KEYBOARD_PATH_3)/$(KEYBOARD_FOLDER_3).c
94 KEYBOARD_C_4 := $(KEYBOARD_PATH_4)/$(KEYBOARD_FOLDER_4).c
95 KEYBOARD_C_5 := $(KEYBOARD_PATH_5)/$(KEYBOARD_FOLDER_5).c
97 ifneq ("$(wildcard $(KEYBOARD_C_5))","")
98 KEYBOARD_SRC += $(KEYBOARD_C_5)
100 ifneq ("$(wildcard $(KEYBOARD_C_4))","")
101 KEYBOARD_SRC += $(KEYBOARD_C_4)
103 ifneq ("$(wildcard $(KEYBOARD_C_3))","")
104 KEYBOARD_SRC += $(KEYBOARD_C_3)
106 ifneq ("$(wildcard $(KEYBOARD_C_2))","")
107 KEYBOARD_SRC += $(KEYBOARD_C_2)
109 ifneq ("$(wildcard $(KEYBOARD_C_1))","")
110 KEYBOARD_SRC += $(KEYBOARD_C_1)
113 OPT_DEFS += -DKEYBOARD_$(KEYBOARD_FILESAFE)
116 # Setup the define for QMK_KEYBOARD_H. This is used inside of keymaps so
117 # that the same keymap may be used on multiple keyboards.
119 # We grab the most top-level include file that we can. That file should
120 # use #ifdef statements to include all the neccesary subfolder includes,
123 # https://docs.qmk.fm/#/feature_layouts?id=tips-for-making-layouts-keyboard-agnostic
125 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/$(KEYBOARD_FOLDER_1).h)","")
126 QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_1).h
128 ifneq ("$(wildcard $(KEYBOARD_PATH_2)/$(KEYBOARD_FOLDER_2).h)","")
129 QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_2).h
131 ifneq ("$(wildcard $(KEYBOARD_PATH_3)/$(KEYBOARD_FOLDER_3).h)","")
132 QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_3).h
134 ifneq ("$(wildcard $(KEYBOARD_PATH_4)/$(KEYBOARD_FOLDER_4).h)","")
135 QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_4).h
137 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/$(KEYBOARD_FOLDER_5).h)","")
138 QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_5).h
141 # Determine and set parameters based on the keyboard's processor family.
142 # We can assume a ChibiOS target When MCU_FAMILY is defined since it's
155 ifeq ($(PLATFORM),CHIBIOS)
156 include $(TMK_PATH)/chibios.mk
158 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/bootloader_defs.h)","")
159 OPT_DEFS += -include $(KEYBOARD_PATH_5)/bootloader_defs.h
160 else ifneq ("$(wildcard $(KEYBOARD_PATH_5)/boards/$(BOARD)/bootloader_defs.h)","")
161 OPT_DEFS += -include $(KEYBOARD_PATH_5)/boards/$(BOARD)/bootloader_defs.h
162 else ifneq ("$(wildcard $(KEYBOARD_PATH_4)/bootloader_defs.h)","")
163 OPT_DEFS += -include $(KEYBOARD_PATH_4)/bootloader_defs.h
164 else ifneq ("$(wildcard $(KEYBOARD_PATH_4)/boards/$(BOARD)/bootloader_defs.h)","")
165 OPT_DEFS += -include $(KEYBOARD_PATH_4)/boards/$(BOARD)/bootloader_defs.h
166 else ifneq ("$(wildcard $(KEYBOARD_PATH_3)/bootloader_defs.h)","")
167 OPT_DEFS += -include $(KEYBOARD_PATH_3)/bootloader_defs.h
168 else ifneq ("$(wildcard $(KEYBOARD_PATH_3)/boards/$(BOARD)/bootloader_defs.h)","")
169 OPT_DEFS += -include $(KEYBOARD_PATH_3)/boards/$(BOARD)/bootloader_defs.h
170 else ifneq ("$(wildcard $(KEYBOARD_PATH_2)/bootloader_defs.h)","")
171 OPT_DEFS += -include $(KEYBOARD_PATH_2)/bootloader_defs.h
172 else ifneq ("$(wildcard $(KEYBOARD_PATH_2)/boards/$(BOARD)/bootloader_defs.h)","")
173 OPT_DEFS += -include $(KEYBOARD_PATH_2)/boards/$(BOARD)/bootloader_defs.h
174 else ifneq ("$(wildcard $(KEYBOARD_PATH_1)/bootloader_defs.h)","")
175 OPT_DEFS += -include $(KEYBOARD_PATH_1)/bootloader_defs.h
176 else ifneq ("$(wildcard $(KEYBOARD_PATH_1)/boards/$(BOARD)/bootloader_defs.h)","")
177 OPT_DEFS += -include $(KEYBOARD_PATH_1)/boards/$(BOARD)/bootloader_defs.h
178 else ifneq ("$(wildcard $(TOP_DIR)/drivers/boards/$(BOARD)/bootloader_defs.h)","")
179 OPT_DEFS += -include $(TOP_DIR)/drivers/boards/$(BOARD)/bootloader_defs.h
183 # Find all of the config.h files and add them to our CONFIG_H define.
185 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/config.h)","")
186 CONFIG_H += $(KEYBOARD_PATH_5)/config.h
188 ifneq ("$(wildcard $(KEYBOARD_PATH_4)/config.h)","")
189 CONFIG_H += $(KEYBOARD_PATH_4)/config.h
191 ifneq ("$(wildcard $(KEYBOARD_PATH_3)/config.h)","")
192 CONFIG_H += $(KEYBOARD_PATH_3)/config.h
194 ifneq ("$(wildcard $(KEYBOARD_PATH_2)/config.h)","")
195 CONFIG_H += $(KEYBOARD_PATH_2)/config.h
197 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/config.h)","")
198 CONFIG_H += $(KEYBOARD_PATH_1)/config.h
201 # Save the defines and includes here, so we don't include any keymap specific ones
202 PROJECT_DEFS := $(OPT_DEFS)
203 PROJECT_INC := $(VPATH) $(EXTRAINCDIRS) $(KEYBOARD_PATHS)
204 PROJECT_CONFIG := $(CONFIG_H)
206 MAIN_KEYMAP_PATH_1 := $(KEYBOARD_PATH_1)/keymaps/$(KEYMAP)
207 MAIN_KEYMAP_PATH_2 := $(KEYBOARD_PATH_2)/keymaps/$(KEYMAP)
208 MAIN_KEYMAP_PATH_3 := $(KEYBOARD_PATH_3)/keymaps/$(KEYMAP)
209 MAIN_KEYMAP_PATH_4 := $(KEYBOARD_PATH_4)/keymaps/$(KEYMAP)
210 MAIN_KEYMAP_PATH_5 := $(KEYBOARD_PATH_5)/keymaps/$(KEYMAP)
212 ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.c)","")
213 -include $(MAIN_KEYMAP_PATH_5)/rules.mk
214 KEYMAP_C := $(MAIN_KEYMAP_PATH_5)/keymap.c
215 KEYMAP_PATH := $(MAIN_KEYMAP_PATH_5)
216 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_4)/keymap.c)","")
217 -include $(MAIN_KEYMAP_PATH_4)/rules.mk
218 KEYMAP_C := $(MAIN_KEYMAP_PATH_4)/keymap.c
219 KEYMAP_PATH := $(MAIN_KEYMAP_PATH_4)
220 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_3)/keymap.c)","")
221 -include $(MAIN_KEYMAP_PATH_3)/rules.mk
222 KEYMAP_C := $(MAIN_KEYMAP_PATH_3)/keymap.c
223 KEYMAP_PATH := $(MAIN_KEYMAP_PATH_3)
224 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_2)/keymap.c)","")
225 -include $(MAIN_KEYMAP_PATH_2)/rules.mk
226 KEYMAP_C := $(MAIN_KEYMAP_PATH_2)/keymap.c
227 KEYMAP_PATH := $(MAIN_KEYMAP_PATH_2)
228 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.c)","")
229 -include $(MAIN_KEYMAP_PATH_1)/rules.mk
230 KEYMAP_C := $(MAIN_KEYMAP_PATH_1)/keymap.c
231 KEYMAP_PATH := $(MAIN_KEYMAP_PATH_1)
232 else ifneq ($(LAYOUTS),)
233 include build_layout.mk
235 $(error Could not find keymap)
236 # this state should never be reached
239 # Userspace setup and definitions
240 ifeq ("$(USER_NAME)","")
241 USER_NAME := $(KEYMAP)
243 USER_PATH := users/$(USER_NAME)
245 -include $(USER_PATH)/rules.mk
246 ifneq ("$(wildcard $(USER_PATH)/config.h)","")
247 CONFIG_H += $(USER_PATH)/config.h
251 # Object files directory
252 # To put object files in current directory, use a dot (.), do NOT make
253 # this an empty or blank macro!
254 KEYMAP_OUTPUT := $(BUILD_DIR)/obj_$(TARGET)
256 ifneq ("$(wildcard $(KEYMAP_PATH)/config.h)","")
257 CONFIG_H += $(KEYMAP_PATH)/config.h
260 # # project specific files
261 SRC += $(KEYBOARD_SRC) \
265 # Optimize size but this may cause error "relocation truncated to fit"
266 #EXTRALDFLAGS = -Wl,--relax
269 VPATH += $(KEYMAP_PATH)
270 VPATH += $(KEYBOARD_PATHS)
271 VPATH += $(COMMON_VPATH)
272 VPATH += $(USER_PATH)
274 include common_features.mk
275 include $(TMK_PATH)/protocol.mk
276 include $(TMK_PATH)/common.mk
277 include bootloader.mk
279 SRC += $(TMK_COMMON_SRC)
280 OPT_DEFS += $(TMK_COMMON_DEFS)
281 EXTRALDFLAGS += $(TMK_COMMON_LDFLAGS)
283 ifeq ($(PLATFORM),AVR)
284 ifeq ($(strip $(PROTOCOL)), VUSB)
285 include $(TMK_PATH)/protocol/vusb.mk
287 include $(TMK_PATH)/protocol/lufa.mk
289 include $(TMK_PATH)/avr.mk
292 ifeq ($(PLATFORM),ARM_ATSAM)
293 include $(TMK_PATH)/arm_atsam.mk
294 include $(TMK_PATH)/protocol/arm_atsam.mk
297 ifeq ($(PLATFORM),CHIBIOS)
298 include $(TMK_PATH)/protocol/chibios.mk
301 ifeq ($(strip $(VISUALIZER_ENABLE)), yes)
302 VISUALIZER_DIR = $(QUANTUM_DIR)/visualizer
303 VISUALIZER_PATH = $(QUANTUM_PATH)/visualizer
304 include $(VISUALIZER_PATH)/visualizer.mk
307 ALL_CONFIGS := $(PROJECT_CONFIG) $(CONFIG_H)
309 OUTPUTS := $(KEYMAP_OUTPUT) $(KEYBOARD_OUTPUT)
310 $(KEYMAP_OUTPUT)_SRC := $(SRC)
311 $(KEYMAP_OUTPUT)_DEFS := $(OPT_DEFS) $(GFXDEFS) \
312 -DQMK_KEYBOARD=\"$(KEYBOARD)\" -DQMK_KEYBOARD_H=\"$(QMK_KEYBOARD_H)\" -DQMK_KEYBOARD_CONFIG_H=\"$(KEYBOARD_PATH_1)/config.h\" \
313 -DQMK_KEYMAP=\"$(KEYMAP)\" -DQMK_KEYMAP_H=\"$(KEYMAP).h\" -DQMK_KEYMAP_CONFIG_H=\"$(KEYMAP_PATH)/config.h\" \
314 -DQMK_SUBPROJECT -DQMK_SUBPROJECT_H -DQMK_SUBPROJECT_CONFIG_H
315 $(KEYMAP_OUTPUT)_INC := $(VPATH) $(EXTRAINCDIRS)
316 $(KEYMAP_OUTPUT)_CONFIG := $(CONFIG_H)
317 $(KEYBOARD_OUTPUT)_SRC := $(CHIBISRC) $(GFXSRC)
318 $(KEYBOARD_OUTPUT)_DEFS := $(PROJECT_DEFS) $(GFXDEFS)
319 $(KEYBOARD_OUTPUT)_INC := $(PROJECT_INC) $(GFXINC)
320 $(KEYBOARD_OUTPUT)_CONFIG := $(PROJECT_CONFIG)
323 all: build check-size
324 build: elf cpfirmware
326 include $(TMK_PATH)/rules.mk