Merge commit 'cedfbfcb1a9ad9cf93816f1952fc4bf7c55fbb61'
[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,$($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
38 MASTER_OUTPUT := $(firstword $(OUTPUTS))
39
40
41
42 # Output format. (can be srec, ihex, binary)
43 FORMAT = ihex
44
45 # Optimization level, can be [0, 1, 2, 3, s].
46 # 0 = turn off optimization. s = optimize for size.
47 # (Note: 3 is not always the best optimization level. See avr-libc FAQ.)
48 OPT = s
49
50 AUTOGEN ?= false
51
52
53 # Compiler flag to set the C Standard level.
54 # c89 = "ANSI" C
55 # gnu89 = c89 plus GCC extensions
56 # c99 = ISO C99 standard (not yet fully implemented)
57 # gnu99 = c99 plus GCC extensions
58 CSTANDARD = -std=gnu99
59
60
61 # Place -D or -U options here for C sources
62 #CDEFS +=
63
64
65 # Place -D or -U options here for ASM sources
66 #ADEFS +=
67
68
69 # Place -D or -U options here for C++ sources
70 #CPPDEFS += -D__STDC_LIMIT_MACROS
71 #CPPDEFS += -D__STDC_CONSTANT_MACROS
72 #CPPDEFS +=
73
74
75
76
77 #---------------- Compiler Options C ----------------
78 # -g*: generate debugging information
79 # -O*: optimization level
80 # -f...: tuning, see GCC manual and avr-libc documentation
81 # -Wall...: warning level
82 # -Wa,...: tell GCC to pass this to the assembler.
83 # -adhlns...: create assembler listing
84 CFLAGS += -g$(DEBUG)
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
107 #---------------- Compiler Options C++ ----------------
108 # -g*: generate debugging information
109 # -O*: optimization level
110 # -f...: tuning, see GCC manual and avr-libc documentation
111 # -Wall...: warning level
112 # -Wa,...: tell GCC to pass this to the assembler.
113 # -adhlns...: create assembler listing
114 CPPFLAGS += -g$(DEBUG)
115 CPPFLAGS += $(CPPDEFS)
116 CPPFLAGS += -O$(OPT)
117 # to supress "warning: only initialized variables can be placed into program memory area"
118 CPPFLAGS += -w
119 CPPFLAGS += -Wall
120 CPPFLAGS += -Wundef
121 ifneq ($(strip $(ALLOW_WARNINGS)), yes)
122 CPPFLAGS += -Werror
123 endif
124 #CPPFLAGS += -mshort-calls
125 #CPPFLAGS += -fno-unit-at-a-time
126 #CPPFLAGS += -Wstrict-prototypes
127 #CPPFLAGS += -Wunreachable-code
128 #CPPFLAGS += -Wsign-compare
129 CPPFLAGS += -Wa,-adhlns=$(@:%.o=%.lst)
130 #CPPFLAGS += $(CSTANDARD)
131
132 #---------------- Assembler Options ----------------
133 # -Wa,...: tell GCC to pass this to the assembler.
134 # -adhlns: create listing
135 # -gstabs: have the assembler create line number information; note that
136 # for use in COFF files, additional information about filenames
137 # and function names needs to be present in the assembler source
138 # files -- see avr-libc docs [FIXME: not yet described there]
139 # -listing-cont-lines: Sets the maximum number of continuation lines of hex
140 # dump that will be displayed for a given single line of source input.
141 ASFLAGS += $(ADEFS)
142 ASFLAGS += -Wa,-adhlns=$(@:%.o=%.lst),-gstabs,--listing-cont-lines=100
143
144 #---------------- Library Options ----------------
145 # Minimalistic printf version
146 PRINTF_LIB_MIN = -Wl,-u,vfprintf -lprintf_min
147
148 # Floating point printf version (requires MATH_LIB = -lm below)
149 PRINTF_LIB_FLOAT = -Wl,-u,vfprintf -lprintf_flt
150
151 # If this is left blank, then it will use the Standard printf version.
152 PRINTF_LIB =
153 #PRINTF_LIB = $(PRINTF_LIB_MIN)
154 #PRINTF_LIB = $(PRINTF_LIB_FLOAT)
155
156
157 # Minimalistic scanf version
158 SCANF_LIB_MIN = -Wl,-u,vfscanf -lscanf_min
159
160 # Floating point + %[ scanf version (requires MATH_LIB = -lm below)
161 SCANF_LIB_FLOAT = -Wl,-u,vfscanf -lscanf_flt
162
163 # If this is left blank, then it will use the Standard scanf version.
164 SCANF_LIB =
165 #SCANF_LIB = $(SCANF_LIB_MIN)
166 #SCANF_LIB = $(SCANF_LIB_FLOAT)
167
168
169 MATH_LIB = -lm
170 CREATE_MAP ?= yes
171
172
173 #---------------- Linker Options ----------------
174 # -Wl,...: tell GCC to pass this to linker.
175 # -Map: create map file
176 # --cref: add cross reference to map file
177 #
178 # Comennt out "--relax" option to avoid a error such:
179 # (.vectors+0x30): relocation truncated to fit: R_AVR_13_PCREL against symbol `__vector_12'
180 #
181
182 ifeq ($(CREATE_MAP),yes)
183 LDFLAGS += -Wl,-Map=$(BUILD_DIR)/$(TARGET).map,--cref
184 endif
185 #LDFLAGS += -Wl,--relax
186 LDFLAGS += $(EXTMEMOPTS)
187 LDFLAGS += $(patsubst %,-L%,$(EXTRALIBDIRS))
188 LDFLAGS += $(PRINTF_LIB) $(SCANF_LIB) $(MATH_LIB)
189 #LDFLAGS += -T linker_script.x
190 # You can give EXTRALDFLAGS at 'make' command line.
191 LDFLAGS += $(EXTRALDFLAGS)
192
193 # Define programs and commands.
194 SHELL = sh
195 REMOVE = rm -f
196 REMOVEDIR = rmdir
197 COPY = cp
198 WINSHELL = cmd
199 SECHO = $(SILENT) || echo
200
201
202 # Compiler flags to generate dependency files.
203 #GENDEPFLAGS = -MMD -MP -MF .dep/$(@F).d
204 GENDEPFLAGS = -MMD -MP -MF $(patsubst %.o,%.td,$@)
205
206
207 # Combine all necessary flags and optional flags.
208 # Add target processor to flags.
209 # You can give extra flags at 'make' command line like: make EXTRAFLAGS=-DFOO=bar
210 ALL_CFLAGS = $(MCUFLAGS) $(CFLAGS) $(EXTRAFLAGS)
211 ALL_CPPFLAGS = $(MCUFLAGS) -x c++ $(CPPFLAGS) $(EXTRAFLAGS)
212 ALL_ASFLAGS = $(MCUFLAGS) -x assembler-with-cpp $(ASFLAGS) $(EXTRAFLAGS)
213
214 MOVE_DEP = mv -f $(patsubst %.o,%.td,$@) $(patsubst %.o,%.d,$@)
215
216
217 elf: $(BUILD_DIR)/$(TARGET).elf
218 hex: $(BUILD_DIR)/$(TARGET).hex
219 eep: $(BUILD_DIR)/$(TARGET).eep
220 lss: $(BUILD_DIR)/$(TARGET).lss
221 sym: $(BUILD_DIR)/$(TARGET).sym
222 LIBNAME=lib$(TARGET).a
223 lib: $(LIBNAME)
224
225 # Display size of file.
226 HEXSIZE = $(SIZE) --target=$(FORMAT) $(TARGET).hex
227 #ELFSIZE = $(SIZE) --mcu=$(MCU) --format=avr $(TARGET).elf
228 ELFSIZE = $(SIZE) $(BUILD_DIR)/$(TARGET).elf
229
230 sizebefore:
231 @if test -f $(TARGET).hex; then $(SECHO) $(MSG_SIZE_BEFORE); $(SILENT) || $(HEXSIZE); \
232 2>/dev/null; $(SECHO); fi
233
234 sizeafter: $(BUILD_DIR)/$(TARGET).hex
235 @if test -f $(TARGET).hex; then $(SECHO); $(SECHO) $(MSG_SIZE_AFTER); $(SILENT) || $(HEXSIZE); \
236 2>/dev/null; $(SECHO); fi
237 # test file sizes eventually
238 # @if [[ $($(SIZE) --target=$(FORMAT) $(TARGET).hex | $(AWK) 'NR==2 {print "0x"$5}') -gt 0x200 ]]; then $(SECHO) "File is too big!"; fi
239
240 # Display compiler version information.
241 gccversion :
242 @$(SILENT) || $(CC) --version
243
244 # Create final output files (.hex, .eep) from ELF output file.
245 %.hex: %.elf
246 @$(SILENT) || printf "$(MSG_FLASH) $@" | $(AWK_CMD)
247 $(eval CMD=$(HEX) $< $@)
248 @$(BUILD_CMD)
249 @if $(AUTOGEN); then \
250 $(SILENT) || printf "Copying $(TARGET).hex to keymaps/$(KEYMAP)/$(KEYBOARD)_$(KEYMAP).hex\n"; \
251 $(COPY) $@ $(KEYMAP_PATH)/$(KEYBOARD)_$(KEYMAP).hex; \
252 else \
253 $(COPY) $@ $(TARGET).hex; \
254 fi
255
256 %.eep: %.elf
257 @$(SILENT) || printf "$(MSG_EEPROM) $@" | $(AWK_CMD)
258 $(eval CMD=$(EEP) $< $@ || exit 0)
259 @$(BUILD_CMD)
260
261 # Create extended listing file from ELF output file.
262 %.lss: %.elf
263 @$(SILENT) || printf "$(MSG_EXTENDED_LISTING) $@" | $(AWK_CMD)
264 $(eval CMD=$(OBJDUMP) -h -S -z $< > $@)
265 @$(BUILD_CMD)
266
267 # Create a symbol table from ELF output file.
268 %.sym: %.elf
269 @$(SILENT) || printf "$(MSG_SYMBOL_TABLE) $@" | $(AWK_CMD)
270 $(eval CMD=$(NM) -n $< > $@ )
271 @$(BUILD_CMD)
272
273 %.bin: %.elf
274 @$(SILENT) || printf "$(MSG_BIN) $@" | $(AWK_CMD)
275 $(eval CMD=$(BIN) $< $@ || exit 0)
276 @$(BUILD_CMD)
277
278 BEGIN = gccversion sizebefore
279
280 # Link: create ELF output file from object files.
281 .SECONDARY : $(BUILD_DIR)/$(TARGET).elf
282 .PRECIOUS : $(OBJ)
283 # Note the obj.txt depeendency is there to force linking if a source file is deleted
284 %.elf: $(OBJ) $(MASTER_OUTPUT)/cflags.txt $(MASTER_OUTPUT)/ldflags.txt $(MASTER_OUTPUT)/obj.txt | $(BEGIN)
285 @$(SILENT) || printf "$(MSG_LINKING) $@" | $(AWK_CMD)
286 $(eval CMD=$(CC) $(ALL_CFLAGS) $(filter-out %.txt,$^) --output $@ $(LDFLAGS))
287 @$(BUILD_CMD)
288
289
290 define GEN_OBJRULE
291 $1_INCFLAGS := $$(patsubst %,-I%,$$($1_INC))
292 ifdef $1_CONFIG
293 $1_CONFIG_FLAGS += -include $$($1_CONFIG)
294 endif
295 $1_CFLAGS = $$(ALL_CFLAGS) $$($1_DEFS) $$($1_INCFLAGS) $$($1_CONFIG_FLAGS)
296 $1_CPPFLAGS= $$(ALL_CPPFLAGS) $$($1_DEFS) $$($1_INCFLAGS) $$($1_CONFIG_FLAGS)
297 $1_ASFLAGS= $$(ALL_ASFLAGS) $$($1_DEFS) $$($1_INCFLAGS) $$($1_CONFIG_FLAGS)
298
299 # Compile: create object files from C source files.
300 $1/%.o : %.c $1/%.d $1/cflags.txt $1/compiler.txt | $(BEGIN)
301 @mkdir -p $$(@D)
302 @$$(SILENT) || printf "$$(MSG_COMPILING) $$<" | $$(AWK_CMD)
303 $$(eval CMD := $$(CC) -c $$($1_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
304 @$$(BUILD_CMD)
305
306 # Compile: create object files from C++ source files.
307 $1/%.o : %.cpp $1/%.d $1/cppflags.txt $1/compiler.txt | $(BEGIN)
308 @mkdir -p $$(@D)
309 @$$(SILENT) || printf "$$(MSG_COMPILING_CPP) $$<" | $$(AWK_CMD)
310 $$(eval CMD=$$(CC) -c $$($1_CPPFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
311 @$$(BUILD_CMD)
312
313 $1/%.o : %.cc $1/%.d $1/cppflags.txt $1/compiler.txt | $(BEGIN)
314 @mkdir -p $$(@D)
315 @$$(SILENT) || printf "$$(MSG_COMPILING_CPP) $$<" | $$(AWK_CMD)
316 $$(eval CMD=$$(CC) -c $$($1_CPPFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
317 @$$(BUILD_CMD)
318
319 # Assemble: create object files from assembler source files.
320 $1/%.o : %.S $1/asflags.txt $1/compiler.txt | $(BEGIN)
321 @mkdir -p $$(@D)
322 @$(SILENT) || printf "$$(MSG_ASSEMBLING) $$<" | $$(AWK_CMD)
323 $$(eval CMD=$$(CC) -c $$($1_ASFLAGS) $$< -o $$@)
324 @$$(BUILD_CMD)
325
326 $1/force:
327
328 $1/cflags.txt: $1/force
329 echo '$$($1_CFLAGS)' | cmp -s - $$@ || echo '$$($1_CFLAGS)' > $$@
330
331 $1/cppflags.txt: $1/force
332 echo '$$($1_CPPFLAGS)' | cmp -s - $$@ || echo '$$($1_CPPFLAGS)' > $$@
333
334 $1/asflags.txt: $1/force
335 echo '$$($1_ASFLAGS)' | cmp -s - $$@ || echo '$$($1_ASFLAGS)' > $$@
336
337 $1/compiler.txt: $1/force
338 $$(CC) --version | cmp -s - $$@ || $$(CC) --version > $$@
339 endef
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
351 DEPS = $(patsubst %.o,%.d,$(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.
365 clean:
366 $(foreach OUTPUT,$(OUTPUTS), $(REMOVE) -r $(OUTPUT) 2>/dev/null)
367 $(REMOVE) $(BUILD_DIR)/$(TARGET).*
368
369 show_path:
370 @echo VPATH=$(VPATH)
371 @echo SRC=$(SRC)
372 @echo OBJ=$(OBJ)
373
374 # Create build directory
375 $(shell mkdir -p $(BUILD_DIR) 2>/dev/null)
376
377 # Create object files directory
378 $(eval $(foreach OUTPUT,$(OUTPUTS),$(shell mkdir -p $(OUTPUT) 2>/dev/null)))
379
380 # Include the dependency files.
381 -include $(patsubst %.o,%.d,$(OBJ))
382
383
384 # Listing of phony targets.
385 .PHONY : all finish sizebefore sizeafter gccversion \
386 build elf hex eep lss sym coff extcoff \
387 clean clean_list debug gdb-config show_path \
388 program teensy dfu flip dfu-ee flip-ee dfu-start