common_rules.mk
13096 bytes
1# Hey Emacs, this is a -*- makefile -*-
2#----------------------------------------------------------------------------
3
4# Enable vpath searching for source files only
5# Without this, output files, could be read from the wrong .build directories
6VPATH_SRC := $(VPATH)
7vpath %.c $(VPATH_SRC)
8vpath %.h $(VPATH_SRC)
9vpath %.cpp $(VPATH_SRC)
10vpath %.cc $(VPATH_SRC)
11vpath %.hpp $(VPATH_SRC)
12vpath %.S $(VPATH_SRC)
13VPATH :=
14
15# Helper to return the distinct elements of a list
16uniq = $(if $1,$(firstword $1) $(call uniq,$(filter-out $(firstword $1),$1)))
17
18# Convert all SRC to OBJ
19define OBJ_FROM_SRC
20$(patsubst %.c,$1/%.o,$(patsubst %.cpp,$1/%.o,$(patsubst %.cc,$1/%.o,$(patsubst %.S,$1/%.o,$(patsubst %.clib,$1/%.a,$($1_SRC))))))
21endef
22$(foreach OUTPUT,$(OUTPUTS),$(eval $(OUTPUT)_OBJ +=$(call OBJ_FROM_SRC,$(OUTPUT))))
23
24# Define a list of all objects
25OBJ := $(foreach OUTPUT,$(OUTPUTS),$($(OUTPUT)_OBJ))
26NO_LTO_OBJ := $(filter %.a,$(OBJ))
27
28MASTER_OUTPUT := $(firstword $(OUTPUTS))
29
30# Output format. (can be srec, ihex, binary)
31FORMAT = ihex
32
33# Optimization level, can be [0, 1, 2, 3, s].
34OPT ?= s
35
36# Compiler flag to set the C and C++ language standard level
37CSTANDARD = -std=gnu11
38CXXSTANDARD = -std=gnu++14
39
40# Speed up recompilations by opt-in usage of ccache
41USE_CCACHE ?= no
42ifneq ($(USE_CCACHE),no)
43 CC_PREFIX ?= ccache
44endif
45
46#---------------- Debug Options ----------------
47
48DEBUG_ENABLE ?= no
49ifeq ($(strip $(DEBUG_ENABLE)),yes)
50 CFLAGS += -ggdb3
51 CXXFLAGS += -ggdb3
52 ASFLAGS += -ggdb3
53# Create a map file when debugging
54 LDFLAGS += -Wl,-Map=$(BUILD_DIR)/$(TARGET).map,--cref
55endif
56
57
58#---------------- C Compiler Options ----------------
59
60ifeq ($(strip $(LTO_ENABLE)), yes)
61 CDEFS += -flto
62 CDEFS += -DLTO_ENABLE
63endif
64
65CFLAGS += $(CDEFS)
66CFLAGS += -O$(OPT)
67# add color
68ifeq ($(COLOR),true)
69ifeq ("$(shell echo "int main(){}" | $(CC) -fdiagnostics-color -x c - -o /dev/null 2>&1)", "")
70 CFLAGS+= -fdiagnostics-color
71endif
72endif
73CFLAGS += -Wall
74CFLAGS += -Wstrict-prototypes
75ifneq ($(strip $(ALLOW_WARNINGS)), yes)
76 CFLAGS += -Werror
77endif
78CFLAGS += $(CSTANDARD)
79
80# This fixes lots of keyboards linking errors but SHOULDN'T BE A FINAL SOLUTION
81# Fixing of multiple variable definitions must be made.
82CFLAGS += -fcommon
83
84#---------------- C++ Compiler Options ----------------
85
86CXXFLAGS += $(CXXDEFS)
87CXXFLAGS += -O$(OPT)
88# to suppress "warning: only initialized variables can be placed into program memory area"
89CXXFLAGS += -w
90CXXFLAGS += -Wall
91CXXFLAGS += -Wundef
92
93ifneq ($(strip $(ALLOW_WARNINGS)), yes)
94 CXXFLAGS += -Werror
95endif
96
97#---------------- Assembler Options ----------------
98
99ASFLAGS += $(ADEFS)
100ifeq ($(VERBOSE_AS_CMD),yes)
101 ASFLAGS += -v
102endif
103
104#---------------- Linker Options ----------------
105
106ifeq ($(VERBOSE_LD_CMD),yes)
107 LDFLAGS += -v
108endif
109
110LDFLAGS += $(EXTMEMOPTS)
111LDFLAGS += $(patsubst %,-L%,$(EXTRALIBDIRS))
112LDFLAGS += -lm
113# You can give EXTRALDFLAGS at 'make' command line.
114LDFLAGS += $(EXTRALDFLAGS)
115
116#---------------- Assembler Listings ----------------
117
118ADHLNS_ENABLE ?= no
119ifeq ($(ADHLNS_ENABLE),yes)
120 # Avoid "Options to '-Xassembler' do not match" - only specify assembler options at LTO link time
121 ifeq ($(strip $(LTO_ENABLE)), yes)
122 LDFLAGS += -Wa,-adhlns=$(BUILD_DIR)/$(TARGET).lst
123 else
124 CFLAGS += -Wa,-adhlns=$(@:%.o=%.lst)
125 CXXFLAGS += -Wa,-adhlns=$(@:%.o=%.lst)
126 ASFLAGS += -Wa,-adhlns=$(@:%.o=%.lst),--listing-cont-lines=100
127 endif
128endif
129
130# Define programs and commands.
131SHELL = sh
132SED = sed
133REMOVE = rm -f
134REMOVEDIR = rmdir
135COPY = cp
136WINSHELL = cmd
137SECHO = $(SILENT) || echo
138MD5SUM ?= md5sum
139ifneq ($(filter Darwin FreeBSD,$(shell uname -s)),)
140 MD5SUM = md5
141endif
142
143# UF2 format settings
144# To produce a UF2 file in your build, add to your keyboard's rules.mk:
145# FIRMWARE_FORMAT = uf2
146UF2CONV = $(TOP_DIR)/util/uf2conv.py
147UF2CONV_ARGS ?=
148UF2_FAMILY ?= 0x0
149
150# Compiler flags to generate dependency files.
151#GENDEPFLAGS = -MMD -MP -MF .dep/$(@F).d
152GENDEPFLAGS = -MMD -MP -MF $(patsubst %.o,%.td,$@)
153
154
155# Combine all necessary flags and optional flags.
156# Add target processor to flags.
157# You can give extra flags at 'make' command line like: make EXTRAFLAGS=-DFOO=bar
158ALL_CFLAGS = $(MCUFLAGS) $(CFLAGS) $(EXTRAFLAGS)
159ALL_CXXFLAGS = $(MCUFLAGS) -x c++ $(CXXFLAGS) $(EXTRAFLAGS)
160ALL_ASFLAGS = $(MCUFLAGS) -x assembler-with-cpp $(ASFLAGS) $(EXTRAFLAGS)
161
162define NO_LTO
163$(patsubst %.a,%.o,$1): NOLTO_CFLAGS += -fno-lto
164endef
165$(foreach LOBJ, $(NO_LTO_OBJ), $(eval $(call NO_LTO,$(LOBJ))))
166
167MOVE_DEP = mv -f $(patsubst %.o,%.td,$@) $(patsubst %.o,%.d,$@)
168
169# For a ChibiOS build, ensure that the board files have the hook overrides injected
170define BOARDSRC_INJECT_HOOKS
171$(INTERMEDIATE_OUTPUT)/$(patsubst %.c,%.o,$(patsubst ./%,%,$1)): INIT_HOOK_CFLAGS += -include $(TOP_DIR)/tmk_core/protocol/chibios/init_hooks.h
172endef
173$(foreach LOBJ, $(BOARDSRC), $(eval $(call BOARDSRC_INJECT_HOOKS,$(LOBJ))))
174
175# Add QMK specific flags
176DFU_SUFFIX ?= dfu-suffix
177DFU_SUFFIX_ARGS ?=
178
179
180elf: $(BUILD_DIR)/$(TARGET).elf
181hex: $(BUILD_DIR)/$(TARGET).hex
182uf2: $(BUILD_DIR)/$(TARGET).uf2
183cpfirmware_qmk: $(FIRMWARE_FORMAT)
184 $(SILENT) || printf "Copying $(TARGET).$(FIRMWARE_FORMAT) to qmk_firmware folder" | $(AWK_CMD)
185 $(COPY) $(BUILD_DIR)/$(TARGET).$(FIRMWARE_FORMAT) $(TARGET).$(FIRMWARE_FORMAT) && $(PRINT_OK)
186eep: $(BUILD_DIR)/$(TARGET).eep
187lss: $(BUILD_DIR)/$(TARGET).lss
188sym: $(BUILD_DIR)/$(TARGET).sym
189LIBNAME=lib$(TARGET).a
190lib: $(LIBNAME)
191
192cpfirmware: cpfirmware_qmk
193
194ifneq ($(QMK_USERSPACE),)
195cpfirmware: cpfirmware_userspace
196cpfirmware_userspace: cpfirmware_qmk
197 $(SILENT) || printf "Copying $(TARGET).$(FIRMWARE_FORMAT) to userspace folder" | $(AWK_CMD)
198 $(COPY) $(BUILD_DIR)/$(TARGET).$(FIRMWARE_FORMAT) $(QMK_USERSPACE)/$(TARGET).$(FIRMWARE_FORMAT) && $(PRINT_OK)
199endif
200
201# Display size of file, modifying the output so people don't mistakenly grab the hex output
202BINARY_SIZE = $(SIZE) --target=$(FORMAT) $(BUILD_DIR)/$(TARGET).hex | $(SED) -e 's/\.build\/.*$$/$(TARGET).$(FIRMWARE_FORMAT)/g'
203
204sizebefore:
205 @if test -f $(BUILD_DIR)/$(TARGET).hex; then $(SECHO) $(MSG_SIZE_BEFORE); $(SILENT) || $(BINARY_SIZE); \
206 2>/dev/null; $(SECHO); fi
207
208sizeafter: $(BUILD_DIR)/$(TARGET).hex
209 @if test -f $(BUILD_DIR)/$(TARGET).hex; then $(SECHO); $(SECHO) $(MSG_SIZE_AFTER); $(SILENT) || $(BINARY_SIZE); \
210 2>/dev/null; $(SECHO); fi
211
212# Display compiler version information.
213gccversion :
214 @$(SILENT) || $(CC) --version
215
216# Create final output files (.hex, .eep) from ELF output file.
217%.hex: %.elf
218 $(eval CMD=$(HEX) $< $@)
219 #@$(SILENT) || printf "$(MSG_EXECUTING) '$(CMD)':\n"
220 @$(SILENT) || printf "$(MSG_FLASH) $@" | $(AWK_CMD)
221 @$(BUILD_CMD)
222
223%.uf2: %.elf
224 $(eval CMD=$(HEX) $< $(BUILD_DIR)/$(TARGET).tmp && $(UF2CONV) $(UF2CONV_ARGS) $(BUILD_DIR)/$(TARGET).tmp --output $@ --convert --family $(UF2_FAMILY) >/dev/null 2>&1)
225 #@$(SILENT) || printf "$(MSG_EXECUTING) '$(CMD)':\n"
226 @$(SILENT) || printf "$(MSG_UF2) $@" | $(AWK_CMD)
227 @$(BUILD_CMD)
228
229%.eep: %.elf
230 $(eval CMD=$(EEP) $< $@ || exit 0)
231 #@$(SILENT) || printf "$(MSG_EXECUTING) '$(CMD)':\n"
232 @$(SILENT) || printf "$(MSG_EEPROM) $@" | $(AWK_CMD)
233 @$(BUILD_CMD)
234
235# Create extended listing file from ELF output file.
236%.lss: %.elf
237 $(eval CMD=$(OBJDUMP) -h -S -z $< > $@)
238 #@$(SILENT) || printf "$(MSG_EXECUTING) '$(CMD)':\n"
239 @$(SILENT) || printf "$(MSG_EXTENDED_LISTING) $@" | $(AWK_CMD)
240 @$(BUILD_CMD)
241
242# Create a symbol table from ELF output file.
243%.sym: %.elf
244 $(eval CMD=$(NM) -n $< > $@ )
245 #@$(SILENT) || printf "$(MSG_EXECUTING) '$(CMD)':\n"
246 @$(SILENT) || printf "$(MSG_SYMBOL_TABLE) $@" | $(AWK_CMD)
247 @$(BUILD_CMD)
248
249%.bin: %.elf
250 $(eval CMD=$(BIN) $< $@ || exit 0)
251 #@$(SILENT) || printf "$(MSG_EXECUTING) '$(CMD)':\n"
252 @$(SILENT) || printf "$(MSG_BIN) $@" | $(AWK_CMD)
253 @$(BUILD_CMD)
254 if [ ! -z "$(DFU_SUFFIX_ARGS)" ]; then \
255 $(DFU_SUFFIX) $(DFU_SUFFIX_ARGS) -a $(BUILD_DIR)/$(TARGET).bin 1>/dev/null ;\
256 fi
257 #$(SILENT) || printf "$(MSG_EXECUTING) '$(DFU_SUFFIX) $(DFU_SUFFIX_ARGS) -a $(BUILD_DIR)/$(TARGET).bin 1>/dev/null':\n" ;\
258 $(COPY) $(BUILD_DIR)/$(TARGET).bin $(TARGET).bin;
259
260BEGIN = gccversion sizebefore
261
262# Link: create ELF output file from object files.
263.SECONDARY : $(BUILD_DIR)/$(TARGET).elf
264.PRECIOUS : $(OBJ)
265# Note the obj.txt depeendency is there to force linking if a source file is deleted
266%.elf: $(OBJ) $(MASTER_OUTPUT)/cflags.txt $(MASTER_OUTPUT)/ldflags.txt $(MASTER_OUTPUT)/obj.txt | $(BEGIN)
267 @$(SILENT) || printf "$(MSG_LINKING) $@" | $(AWK_CMD)
268 $(eval CMD=MAKE=$(MAKE) $(CC) $(ALL_CFLAGS) $(call uniq,$(OBJ)) --output $@ $(LDFLAGS))
269 @$(BUILD_CMD)
270
271
272define GEN_OBJRULE
273$1_INCFLAGS := $$(patsubst %,-I%,$$($1_INC))
274ifdef $1_CONFIG
275$1_CONFIG_FLAGS += $$(patsubst %,-include %,$$($1_CONFIG))
276endif
277$1_CFLAGS = $$(ALL_CFLAGS) $$($1_DEFS) $$($1_INCFLAGS) $$($1_CONFIG_FLAGS) $$(NOLTO_CFLAGS)
278$1_CXXFLAGS = $$(ALL_CXXFLAGS) $$($1_DEFS) $$($1_INCFLAGS) $$($1_CONFIG_FLAGS) $$(NOLTO_CFLAGS)
279$1_ASFLAGS = $$(ALL_ASFLAGS) $$($1_DEFS) $$($1_INCFLAGS) $$($1_CONFIG_FLAGS)
280
281# Compile: create object files from C source files.
282$1/%.o : %.c $1/%.d $1/cflags.txt $1/compiler.txt | $(BEGIN)
283 @mkdir -p $$(@D)
284 @$$(SILENT) || printf "$$(MSG_COMPILING) $$<" | $$(AWK_CMD)
285 $$(eval CC_EXEC := $$(CC))
286 ifneq ($$(VERBOSE_C_CMD),)
287 $$(if $$(filter $$(notdir $$(VERBOSE_C_CMD)),$$(notdir $$<)),$$(eval CC_EXEC += -v))
288 endif
289 ifneq ($$(VERBOSE_C_INCLUDE),)
290 $$(if $$(filter $$(notdir $$(VERBOSE_C_INCLUDE)),$$(notdir $$<)),$$(eval CC_EXEC += -H))
291 endif
292 $$(eval CMD := $$(CC_EXEC) -c $$($1_CFLAGS) $$(INIT_HOOK_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
293 @$$(BUILD_CMD)
294 ifneq ($$(DUMP_C_MACROS),)
295 $$(eval CMD := $$(CC) -E -dM $$($1_CFLAGS) $$(INIT_HOOK_CFLAGS) $$(GENDEPFLAGS) $$<)
296 @$$(if $$(filter $$(notdir $$(DUMP_C_MACROS)),$$(notdir $$<)),$$(BUILD_CMD))
297 endif
298
299# Compile: create object files from C++ source files.
300$1/%.o : %.cpp $1/%.d $1/cxxflags.txt $1/compiler.txt | $(BEGIN)
301 @mkdir -p $$(@D)
302 @$$(SILENT) || printf "$$(MSG_COMPILING_CXX) $$<" | $$(AWK_CMD)
303 $$(eval CMD=$$(CC) -c $$($1_CXXFLAGS) $$(INIT_HOOK_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
304 @$$(BUILD_CMD)
305
306$1/%.o : %.cc $1/%.d $1/cxxflags.txt $1/compiler.txt | $(BEGIN)
307 @mkdir -p $$(@D)
308 @$$(SILENT) || printf "$$(MSG_COMPILING_CXX) $$<" | $$(AWK_CMD)
309 $$(eval CMD=$$(CC) -c $$($1_CXXFLAGS) $$(INIT_HOOK_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
310 @$$(BUILD_CMD)
311
312# Assemble: create object files from assembler source files.
313$1/%.o : %.S $1/asflags.txt $1/compiler.txt | $(BEGIN)
314 @mkdir -p $$(@D)
315 @$(SILENT) || printf "$$(MSG_ASSEMBLING) $$<" | $$(AWK_CMD)
316 $$(eval CMD=$$(CC) -c $$($1_ASFLAGS) $$< -o $$@)
317 @$$(BUILD_CMD)
318
319$1/%.a : $1/%.o
320 @mkdir -p $$(@D)
321 @$(SILENT) || printf "Archiving: $$<" | $$(AWK_CMD)
322 $$(eval CMD=$$(AR) rcs $$@ $$<)
323 @$$(BUILD_CMD)
324
325$1/force:
326
327$1/cflags.txt: $1/force
328 echo '$$($1_CFLAGS)' | cmp -s - $$@ || echo '$$($1_CFLAGS)' > $$@
329
330$1/cxxflags.txt: $1/force
331 echo '$$($1_CXXFLAGS)' | cmp -s - $$@ || echo '$$($1_CXXFLAGS)' > $$@
332
333$1/asflags.txt: $1/force
334 echo '$$($1_ASFLAGS)' | cmp -s - $$@ || echo '$$($1_ASFLAGS)' > $$@
335
336$1/compiler.txt: $1/force
337 test -f $$@ || touch $$@
338 $$(CC) --version | cmp -s - $$@ || $$(CC) --version > $$@
339endef
340
341.PRECIOUS: $(MASTER_OUTPUT)/obj.txt
342$(MASTER_OUTPUT)/obj.txt: $(MASTER_OUTPUT)/force
343 echo '$(OBJ)' | cmp -s - $@ || echo '$(OBJ)' > $@
344
345.PRECIOUS: $(MASTER_OUTPUT)/ldflags.txt
346$(MASTER_OUTPUT)/ldflags.txt: $(MASTER_OUTPUT)/force
347 echo '$(LDFLAGS)' | cmp -s - $@ || echo '$(LDFLAGS)' > $@
348
349
350# We have to use static rules for the .d files for some reason
351DEPS = $(patsubst %.o,%.d,$(patsubst %.a,%.o,$(OBJ)))
352# Keep the .d files
353.PRECIOUS: $(DEPS)
354# Empty rule to force recompilation if the .d file is missing
355$(DEPS):
356
357
358$(foreach OUTPUT,$(OUTPUTS),$(eval $(call GEN_OBJRULE,$(OUTPUT))))
359
360# Create preprocessed source for use in sending a bug report.
361%.i : %.c | $(BEGIN)
362 $(CC) -E -mmcu=$(MCU) $(CFLAGS) $< -o $@
363
364# Target: clean project.
365clean:
366 $(foreach OUTPUT,$(OUTPUTS), $(REMOVE) -r $(OUTPUT) 2>/dev/null)
367 $(REMOVE) $(BUILD_DIR)/$(TARGET).*
368
369show_path:
370 @echo VPATH=$(VPATH)
371 @echo SRC=$(SRC)
372 @echo OBJ=$(OBJ)
373
374dump_vars: ERROR_IF_EMPTY=""
375dump_vars: ERROR_IF_NONBOOL=""
376dump_vars: ERROR_IF_UNSET=""
377dump_vars: CATASTROPHIC_ERROR=""
378dump_vars:
379 @$(foreach V,$(sort $(.VARIABLES)),$(if $(filter-out environment% default automatic,$(origin $V)),$(info $V=$($V))))
380
381objs-size:
382 for i in $(OBJ); do echo $$i; done | sort | xargs $(SIZE)
383
384
385# size check optionally implemented in its platform.mk
386check-size:
387
388check-md5:
389 $(MD5SUM) $(BUILD_DIR)/$(TARGET).$(FIRMWARE_FORMAT)
390
391# Create build directory
392$(shell mkdir -p $(BUILD_DIR) 2>/dev/null)
393
394# Create object files directory
395$(eval $(foreach OUTPUT,$(OUTPUTS),$(shell mkdir -p $(OUTPUT) 2>/dev/null)))
396
397# Include the dependency files.
398-include $(patsubst %.o,%.d,$(patsubst %.a,%.o,$(OBJ)))
399
400
401# Listing of phony targets.
402.PHONY : all dump_vars finish sizebefore sizeafter qmkversion \
403gccversion build elf hex uf2 eep lss sym coff extcoff \
404clean clean_list debug gdb-config show_path \
405program teensy dfu dfu-ee dfu-start \
406flash dfu-split-left dfu-split-right \
407avrdude-split-left avrdude-split-right \
408avrdude-loop usbasp