Merge branch 'qmk-master'
[jackhill/qmk/firmware.git] / tmk_core / rules.mk
1 # Hey Emacs, this is a -*- makefile -*-
2 #----------------------------------------------------------------------------
3 # WinAVR Makefile Template written by Eric B. Weddington, Jg Wunsch, et al.
4 #
5 # Released to the Public Domain
6 #
7 # Additional material for this makefile was written by:
8 # Peter Fleury
9 # Tim Henigan
10 # Colin O'Flynn
11 # Reiner Patommel
12 # Markus Pfaff
13 # Sander Pool
14 # Frederik Rouleau
15 # Carlos Lamas
16 #
17
18 # Enable vpath seraching for source files only
19 # Without this, output files, could be read from the wrong .build directories
20 VPATH_SRC := $(VPATH)
21 vpath %.c $(VPATH_SRC)
22 vpath %.h $(VPATH_SRC)
23 vpath %.cpp $(VPATH_SRC)
24 vpath %.cc $(VPATH_SRC)
25 vpath %.hpp $(VPATH_SRC)
26 vpath %.S $(VPATH_SRC)
27 VPATH :=
28
29 # Convert all SRC to OBJ
30 define OBJ_FROM_SRC
31 $(patsubst %.c,$1/%.o,$(patsubst %.cpp,$1/%.o,$(patsubst %.cc,$1/%.o,$(patsubst %.S,$1/%.o,$(patsubst %.clib,$1/%.a,$($1_SRC))))))
32 endef
33 $(foreach OUTPUT,$(OUTPUTS),$(eval $(OUTPUT)_OBJ +=$(call OBJ_FROM_SRC,$(OUTPUT))))
34
35 # Define a list of all objects
36 OBJ := $(foreach OUTPUT,$(OUTPUTS),$($(OUTPUT)_OBJ))
37 NO_LTO_OBJ := $(filter %.a,$(OBJ))
38
39 MASTER_OUTPUT := $(firstword $(OUTPUTS))
40
41
42
43 # Output format. (can be srec, ihex, binary)
44 FORMAT = ihex
45
46 # Optimization level, can be [0, 1, 2, 3, s].
47 # 0 = turn off optimization. s = optimize for size.
48 # (Note: 3 is not always the best optimization level. See avr-libc FAQ.)
49 OPT = s
50
51 # Compiler flag to set the C Standard level.
52 # c89 = "ANSI" C
53 # gnu89 = c89 plus GCC extensions
54 # c99 = ISO C99 standard (not yet fully implemented)
55 # gnu99 = c99 plus GCC extensions
56 CSTANDARD = -std=gnu99
57
58
59 # Place -D or -U options here for C sources
60 #CDEFS +=
61
62
63 # Place -D or -U options here for ASM sources
64 #ADEFS +=
65
66
67 # Place -D or -U options here for C++ sources
68 #CPPDEFS += -D__STDC_LIMIT_MACROS
69 #CPPDEFS += -D__STDC_CONSTANT_MACROS
70 #CPPDEFS +=
71
72
73
74
75 #---------------- Compiler Options C ----------------
76 # -g*: generate debugging information
77 # -O*: optimization level
78 # -f...: tuning, see GCC manual and avr-libc documentation
79 # -Wall...: warning level
80 # -Wa,...: tell GCC to pass this to the assembler.
81 # -adhlns...: create assembler listing
82 ifndef SKIP_DEBUG_INFO
83 CFLAGS += -g$(DEBUG)
84 endif
85 CFLAGS += $(CDEFS)
86 CFLAGS += -O$(OPT)
87 # add color
88 ifeq ($(COLOR),true)
89 ifeq ("$(shell echo "int main(){}" | $(CC) -fdiagnostics-color -x c - -o /dev/null 2>&1)", "")
90 CFLAGS+= -fdiagnostics-color
91 endif
92 endif
93 CFLAGS += -Wall
94 CFLAGS += -Wstrict-prototypes
95 ifneq ($(strip $(ALLOW_WARNINGS)), yes)
96 CFLAGS += -Werror
97 endif
98 #CFLAGS += -mshort-calls
99 #CFLAGS += -fno-unit-at-a-time
100 #CFLAGS += -Wundef
101 #CFLAGS += -Wunreachable-code
102 #CFLAGS += -Wsign-compare
103 CFLAGS += -Wa,-adhlns=$(@:%.o=%.lst)
104 CFLAGS += $(CSTANDARD)
105
106 #---------------- Compiler Options C++ ----------------
107 # -g*: generate debugging information
108 # -O*: optimization level
109 # -f...: tuning, see GCC manual and avr-libc documentation
110 # -Wall...: warning level
111 # -Wa,...: tell GCC to pass this to the assembler.
112 # -adhlns...: create assembler listing
113 ifndef SKIP_DEBUG_INFO
114 CPPFLAGS += -g$(DEBUG)
115 endif
116 CPPFLAGS += $(CPPDEFS)
117 CPPFLAGS += -O$(OPT)
118 # to supress "warning: only initialized variables can be placed into program memory area"
119 CPPFLAGS += -w
120 CPPFLAGS += -Wall
121 CPPFLAGS += -Wundef
122 ifneq ($(strip $(ALLOW_WARNINGS)), yes)
123 CPPFLAGS += -Werror
124 endif
125 #CPPFLAGS += -mshort-calls
126 #CPPFLAGS += -fno-unit-at-a-time
127 #CPPFLAGS += -Wstrict-prototypes
128 #CPPFLAGS += -Wunreachable-code
129 #CPPFLAGS += -Wsign-compare
130 CPPFLAGS += -Wa,-adhlns=$(@:%.o=%.lst)
131 #CPPFLAGS += $(CSTANDARD)
132
133 #---------------- Assembler Options ----------------
134 # -Wa,...: tell GCC to pass this to the assembler.
135 # -adhlns: create listing
136 # -gstabs: have the assembler create line number information; note that
137 # for use in COFF files, additional information about filenames
138 # and function names needs to be present in the assembler source
139 # files -- see avr-libc docs [FIXME: not yet described there]
140 # -listing-cont-lines: Sets the maximum number of continuation lines of hex
141 # dump that will be displayed for a given single line of source input.
142 ASFLAGS += $(ADEFS)
143 ifndef SKIP_DEBUG_INFO
144 ASFLAGS += -Wa,-adhlns=$(@:%.o=%.lst),-gstabs,--listing-cont-lines=100
145 else
146 ASFLAGS += -Wa,-adhlns=$(@:%.o=%.lst),--listing-cont-lines=100
147 endif
148
149 #---------------- Library Options ----------------
150 # Minimalistic printf version
151 PRINTF_LIB_MIN = -Wl,-u,vfprintf -lprintf_min
152
153 # Floating point printf version (requires MATH_LIB = -lm below)
154 PRINTF_LIB_FLOAT = -Wl,-u,vfprintf -lprintf_flt
155
156 # If this is left blank, then it will use the Standard printf version.
157 PRINTF_LIB =
158 #PRINTF_LIB = $(PRINTF_LIB_MIN)
159 #PRINTF_LIB = $(PRINTF_LIB_FLOAT)
160
161
162 # Minimalistic scanf version
163 SCANF_LIB_MIN = -Wl,-u,vfscanf -lscanf_min
164
165 # Floating point + %[ scanf version (requires MATH_LIB = -lm below)
166 SCANF_LIB_FLOAT = -Wl,-u,vfscanf -lscanf_flt
167
168 # If this is left blank, then it will use the Standard scanf version.
169 SCANF_LIB =
170 #SCANF_LIB = $(SCANF_LIB_MIN)
171 #SCANF_LIB = $(SCANF_LIB_FLOAT)
172
173
174 MATH_LIB = -lm
175 CREATE_MAP ?= yes
176
177
178 #---------------- Linker Options ----------------
179 # -Wl,...: tell GCC to pass this to linker.
180 # -Map: create map file
181 # --cref: add cross reference to map file
182 #
183 # Comennt out "--relax" option to avoid a error such:
184 # (.vectors+0x30): relocation truncated to fit: R_AVR_13_PCREL against symbol `__vector_12'
185 #
186
187 ifeq ($(CREATE_MAP),yes)
188 LDFLAGS += -Wl,-Map=$(BUILD_DIR)/$(TARGET).map,--cref
189 endif
190 #LDFLAGS += -Wl,--relax
191 LDFLAGS += $(EXTMEMOPTS)
192 LDFLAGS += $(patsubst %,-L%,$(EXTRALIBDIRS))
193 LDFLAGS += $(PRINTF_LIB) $(SCANF_LIB) $(MATH_LIB)
194 #LDFLAGS += -T linker_script.x
195 # You can give EXTRALDFLAGS at 'make' command line.
196 LDFLAGS += $(EXTRALDFLAGS)
197
198 # Define programs and commands.
199 SHELL = sh
200 REMOVE = rm -f
201 REMOVEDIR = rmdir
202 COPY = cp
203 WINSHELL = cmd
204 SECHO = $(SILENT) || echo
205
206
207 # Compiler flags to generate dependency files.
208 #GENDEPFLAGS = -MMD -MP -MF .dep/$(@F).d
209 GENDEPFLAGS = -MMD -MP -MF $(patsubst %.o,%.td,$@)
210
211
212 # Combine all necessary flags and optional flags.
213 # Add target processor to flags.
214 # You can give extra flags at 'make' command line like: make EXTRAFLAGS=-DFOO=bar
215 ALL_CFLAGS = $(MCUFLAGS) $(CFLAGS) $(EXTRAFLAGS)
216 ALL_CPPFLAGS = $(MCUFLAGS) -x c++ $(CPPFLAGS) $(EXTRAFLAGS)
217 ALL_ASFLAGS = $(MCUFLAGS) -x assembler-with-cpp $(ASFLAGS) $(EXTRAFLAGS)
218
219 define NO_LTO
220 $(patsubst %.a,%.o,$1): NOLTO_CFLAGS += -fno-lto
221 endef
222 $(foreach LOBJ, $(NO_LTO_OBJ), $(eval $(call NO_LTO,$(LOBJ))))
223
224 MOVE_DEP = mv -f $(patsubst %.o,%.td,$@) $(patsubst %.o,%.d,$@)
225
226
227 elf: $(BUILD_DIR)/$(TARGET).elf
228 hex: $(BUILD_DIR)/$(TARGET).hex
229 cpfirmware: $(FIRMWARE_FORMAT)
230 $(SILENT) || printf "Copying $(TARGET).$(FIRMWARE_FORMAT) to qmk_firmware folder" | $(AWK_CMD)
231 $(COPY) $(BUILD_DIR)/$(TARGET).$(FIRMWARE_FORMAT) $(TARGET).$(FIRMWARE_FORMAT) && $(PRINT_OK)
232 eep: $(BUILD_DIR)/$(TARGET).eep
233 lss: $(BUILD_DIR)/$(TARGET).lss
234 sym: $(BUILD_DIR)/$(TARGET).sym
235 LIBNAME=lib$(TARGET).a
236 lib: $(LIBNAME)
237
238 # Display size of file.
239 HEXSIZE = $(SIZE) --target=$(FORMAT) $(BUILD_DIR)/$(TARGET).hex
240 #ELFSIZE = $(SIZE) --mcu=$(MCU) --format=avr $(TARGET).elf
241 ELFSIZE = $(SIZE) $(BUILD_DIR)/$(TARGET).elf
242
243 sizebefore:
244 @if test -f $(BUILD_DIR)/$(TARGET).hex; then $(SECHO) $(MSG_SIZE_BEFORE); $(SILENT) || $(HEXSIZE); \
245 2>/dev/null; $(SECHO); fi
246
247 sizeafter: $(BUILD_DIR)/$(TARGET).hex
248 @if test -f $(BUILD_DIR)/$(TARGET).hex; then $(SECHO); $(SECHO) $(MSG_SIZE_AFTER); $(SILENT) || $(HEXSIZE); \
249 2>/dev/null; $(SECHO); fi
250
251 # Display compiler version information.
252 gccversion :
253 @$(SILENT) || $(CC) --version
254
255 # Create final output files (.hex, .eep) from ELF output file.
256 %.hex: %.elf
257 @$(SILENT) || printf "$(MSG_FLASH) $@" | $(AWK_CMD)
258 $(eval CMD=$(HEX) $< $@)
259 @$(BUILD_CMD)
260
261 %.eep: %.elf
262 @$(SILENT) || printf "$(MSG_EEPROM) $@" | $(AWK_CMD)
263 $(eval CMD=$(EEP) $< $@ || exit 0)
264 @$(BUILD_CMD)
265
266 # Create extended listing file from ELF output file.
267 %.lss: %.elf
268 @$(SILENT) || printf "$(MSG_EXTENDED_LISTING) $@" | $(AWK_CMD)
269 $(eval CMD=$(OBJDUMP) -h -S -z $< > $@)
270 @$(BUILD_CMD)
271
272 # Create a symbol table from ELF output file.
273 %.sym: %.elf
274 @$(SILENT) || printf "$(MSG_SYMBOL_TABLE) $@" | $(AWK_CMD)
275 $(eval CMD=$(NM) -n $< > $@ )
276 @$(BUILD_CMD)
277
278 %.bin: %.elf
279 @$(SILENT) || printf "$(MSG_BIN) $@" | $(AWK_CMD)
280 $(eval CMD=$(BIN) $< $@ || exit 0)
281 @$(BUILD_CMD)
282
283 BEGIN = gccversion sizebefore
284
285 # Link: create ELF output file from object files.
286 .SECONDARY : $(BUILD_DIR)/$(TARGET).elf
287 .PRECIOUS : $(OBJ)
288 # Note the obj.txt depeendency is there to force linking if a source file is deleted
289 %.elf: $(OBJ) $(MASTER_OUTPUT)/cflags.txt $(MASTER_OUTPUT)/ldflags.txt $(MASTER_OUTPUT)/obj.txt | $(BEGIN)
290 @$(SILENT) || printf "$(MSG_LINKING) $@" | $(AWK_CMD)
291 $(eval CMD=$(CC) $(ALL_CFLAGS) $(filter-out %.txt,$^) --output $@ $(LDFLAGS))
292 @$(BUILD_CMD)
293
294
295 define GEN_OBJRULE
296 $1_INCFLAGS := $$(patsubst %,-I%,$$($1_INC))
297 ifdef $1_CONFIG
298 $1_CONFIG_FLAGS += $$(patsubst %,-include %,$$($1_CONFIG))
299 endif
300 $1_CFLAGS = $$(ALL_CFLAGS) $$($1_DEFS) $$($1_INCFLAGS) $$($1_CONFIG_FLAGS) $$(NOLTO_CFLAGS)
301 $1_CPPFLAGS= $$(ALL_CPPFLAGS) $$($1_DEFS) $$($1_INCFLAGS) $$($1_CONFIG_FLAGS) $$(NOLTO_CFLAGS)
302 $1_ASFLAGS= $$(ALL_ASFLAGS) $$($1_DEFS) $$($1_INCFLAGS) $$($1_CONFIG_FLAGS)
303
304 # Compile: create object files from C source files.
305 $1/%.o : %.c $1/%.d $1/cflags.txt $1/compiler.txt | $(BEGIN)
306 @mkdir -p $$(@D)
307 @$$(SILENT) || printf "$$(MSG_COMPILING) $$<" | $$(AWK_CMD)
308 $$(eval CMD := $$(CC) -c $$($1_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
309 @$$(BUILD_CMD)
310
311 # Compile: create object files from C++ source files.
312 $1/%.o : %.cpp $1/%.d $1/cppflags.txt $1/compiler.txt | $(BEGIN)
313 @mkdir -p $$(@D)
314 @$$(SILENT) || printf "$$(MSG_COMPILING_CPP) $$<" | $$(AWK_CMD)
315 $$(eval CMD=$$(CC) -c $$($1_CPPFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
316 @$$(BUILD_CMD)
317
318 $1/%.o : %.cc $1/%.d $1/cppflags.txt $1/compiler.txt | $(BEGIN)
319 @mkdir -p $$(@D)
320 @$$(SILENT) || printf "$$(MSG_COMPILING_CPP) $$<" | $$(AWK_CMD)
321 $$(eval CMD=$$(CC) -c $$($1_CPPFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
322 @$$(BUILD_CMD)
323
324 # Assemble: create object files from assembler source files.
325 $1/%.o : %.S $1/asflags.txt $1/compiler.txt | $(BEGIN)
326 @mkdir -p $$(@D)
327 @$(SILENT) || printf "$$(MSG_ASSEMBLING) $$<" | $$(AWK_CMD)
328 $$(eval CMD=$$(CC) -c $$($1_ASFLAGS) $$< -o $$@)
329 @$$(BUILD_CMD)
330
331 $1/%.a : $1/%.o
332 @mkdir -p $$(@D)
333 @$(SILENT) || printf "Archiving: $$<" | $$(AWK_CMD)
334 $$(eval CMD=$$(AR) rcs $$@ $$<)
335 @$$(BUILD_CMD)
336
337 $1/force:
338
339 $1/cflags.txt: $1/force
340 echo '$$($1_CFLAGS)' | cmp -s - $$@ || echo '$$($1_CFLAGS)' > $$@
341
342 $1/cppflags.txt: $1/force
343 echo '$$($1_CPPFLAGS)' | cmp -s - $$@ || echo '$$($1_CPPFLAGS)' > $$@
344
345 $1/asflags.txt: $1/force
346 echo '$$($1_ASFLAGS)' | cmp -s - $$@ || echo '$$($1_ASFLAGS)' > $$@
347
348 $1/compiler.txt: $1/force
349 $$(CC) --version | cmp -s - $$@ || $$(CC) --version > $$@
350 endef
351
352 .PRECIOUS: $(MASTER_OUTPUT)/obj.txt
353 $(MASTER_OUTPUT)/obj.txt: $(MASTER_OUTPUT)/force
354 echo '$(OBJ)' | cmp -s - $@ || echo '$(OBJ)' > $@
355
356 .PRECIOUS: $(MASTER_OUTPUT)/ldflags.txt
357 $(MASTER_OUTPUT)/ldflags.txt: $(MASTER_OUTPUT)/force
358 echo '$(LDFLAGS)' | cmp -s - $@ || echo '$(LDFLAGS)' > $@
359
360
361 # We have to use static rules for the .d files for some reason
362 DEPS = $(patsubst %.o,%.d,$(patsubst %.a,%.o,$(OBJ)))
363 # Keep the .d files
364 .PRECIOUS: $(DEPS)
365 # Empty rule to force recompilation if the .d file is missing
366 $(DEPS):
367
368
369 $(foreach OUTPUT,$(OUTPUTS),$(eval $(call GEN_OBJRULE,$(OUTPUT))))
370
371 # Create preprocessed source for use in sending a bug report.
372 %.i : %.c | $(BEGIN)
373 $(CC) -E -mmcu=$(MCU) $(CFLAGS) $< -o $@
374
375 # Target: clean project.
376 clean:
377 $(foreach OUTPUT,$(OUTPUTS), $(REMOVE) -r $(OUTPUT) 2>/dev/null)
378 $(REMOVE) $(BUILD_DIR)/$(TARGET).*
379
380 show_path:
381 @echo VPATH=$(VPATH)
382 @echo SRC=$(SRC)
383 @echo OBJ=$(OBJ)
384
385 ifeq ($(findstring avr-gcc,$(CC)),avr-gcc)
386 SIZE_MARGIN = 1024
387
388 check-size:
389 $(eval MAX_SIZE=$(shell n=`$(CC) -E -mmcu=$(MCU) $(CFLAGS) $(OPT_DEFS) tmk_core/common/avr/bootloader_size.c 2> /dev/null | sed -ne '/^#/n;/^AVR_SIZE:/,$${s/^AVR_SIZE: //;p;}'` && echo $$(($$n)) || echo 0))
390 $(eval CURRENT_SIZE=$(shell if [ -f $(BUILD_DIR)/$(TARGET).hex ]; then $(SIZE) --target=$(FORMAT) $(BUILD_DIR)/$(TARGET).hex | $(AWK) 'NR==2 {print $$4}'; else printf 0; fi))
391 $(eval FREE_SIZE=$(shell expr $(MAX_SIZE) - $(CURRENT_SIZE)))
392 $(eval OVER_SIZE=$(shell expr $(CURRENT_SIZE) - $(MAX_SIZE)))
393 if [ $(MAX_SIZE) -gt 0 ] && [ $(CURRENT_SIZE) -gt 0 ]; then \
394 $(SILENT) || printf "$(MSG_CHECK_FILESIZE)" | $(AWK_CMD); \
395 if [ $(CURRENT_SIZE) -gt $(MAX_SIZE) ]; then \
396 printf "\n * $(MSG_FILE_TOO_BIG)"; $(PRINT_ERROR_PLAIN); \
397 else \
398 if [ $(FREE_SIZE) -lt $(SIZE_MARGIN) ]; then \
399 $(PRINT_WARNING_PLAIN); printf " * $(MSG_FILE_NEAR_LIMIT)"; \
400 else \
401 $(PRINT_OK); $(SILENT) || printf " * $(MSG_FILE_JUST_RIGHT)"; \
402 fi \
403 fi \
404 fi
405 else
406 check-size:
407 echo "(Firmware size check does not yet support $(MCU) microprocessors; skipping.)"
408 endif
409
410 # Create build directory
411 $(shell mkdir -p $(BUILD_DIR) 2>/dev/null)
412
413 # Create object files directory
414 $(eval $(foreach OUTPUT,$(OUTPUTS),$(shell mkdir -p $(OUTPUT) 2>/dev/null)))
415
416 # Include the dependency files.
417 -include $(patsubst %.o,%.d,$(patsubst %.a,%.o,$(OBJ)))
418
419
420 # Listing of phony targets.
421 .PHONY : all finish sizebefore sizeafter qmkversion \
422 gccversion build elf hex eep lss sym coff extcoff \
423 clean clean_list debug gdb-config show_path \
424 program teensy dfu flip dfu-ee flip-ee dfu-start