]> git.donarmstrong.com Git - qmk_firmware.git/blob - tmk_core/rules.mk
ce3cd83b3f15a075412fa2282285f32624531b79
[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 #---------------- 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 CPPFLAGS += -g$(DEBUG)
114 CPPFLAGS += $(CPPDEFS)
115 CPPFLAGS += -O$(OPT)
116 # to supress "warning: only initialized variables can be placed into program memory area"
117 CPPFLAGS += -w
118 CPPFLAGS += -Wall
119 CPPFLAGS += -Wundef
120 ifneq ($(strip $(ALLOW_WARNINGS)), yes)
121     CPPFLAGS += -Werror
122 endif
123 #CPPFLAGS += -mshort-calls
124 #CPPFLAGS += -fno-unit-at-a-time
125 #CPPFLAGS += -Wstrict-prototypes
126 #CPPFLAGS += -Wunreachable-code
127 #CPPFLAGS += -Wsign-compare
128 CPPFLAGS += -Wa,-adhlns=$(@:%.o=%.lst)
129 #CPPFLAGS += $(CSTANDARD)
130
131 #---------------- Assembler Options ----------------
132 #  -Wa,...:   tell GCC to pass this to the assembler.
133 #  -adhlns:   create listing
134 #  -gstabs:   have the assembler create line number information; note that
135 #             for use in COFF files, additional information about filenames
136 #             and function names needs to be present in the assembler source
137 #             files -- see avr-libc docs [FIXME: not yet described there]
138 #  -listing-cont-lines: Sets the maximum number of continuation lines of hex
139 #       dump that will be displayed for a given single line of source input.
140 ASFLAGS += $(ADEFS) 
141 ASFLAGS += -Wa,-adhlns=$(@:%.o=%.lst),-gstabs,--listing-cont-lines=100
142
143 #---------------- Library Options ----------------
144 # Minimalistic printf version
145 PRINTF_LIB_MIN = -Wl,-u,vfprintf -lprintf_min
146
147 # Floating point printf version (requires MATH_LIB = -lm below)
148 PRINTF_LIB_FLOAT = -Wl,-u,vfprintf -lprintf_flt
149
150 # If this is left blank, then it will use the Standard printf version.
151 PRINTF_LIB =
152 #PRINTF_LIB = $(PRINTF_LIB_MIN)
153 #PRINTF_LIB = $(PRINTF_LIB_FLOAT)
154
155
156 # Minimalistic scanf version
157 SCANF_LIB_MIN = -Wl,-u,vfscanf -lscanf_min
158
159 # Floating point + %[ scanf version (requires MATH_LIB = -lm below)
160 SCANF_LIB_FLOAT = -Wl,-u,vfscanf -lscanf_flt
161
162 # If this is left blank, then it will use the Standard scanf version.
163 SCANF_LIB =
164 #SCANF_LIB = $(SCANF_LIB_MIN)
165 #SCANF_LIB = $(SCANF_LIB_FLOAT)
166
167
168 MATH_LIB = -lm
169 CREATE_MAP ?= yes
170
171
172 #---------------- Linker Options ----------------
173 #  -Wl,...:     tell GCC to pass this to linker.
174 #    -Map:      create map file
175 #    --cref:    add cross reference to  map file
176 #
177 # Comennt out "--relax" option to avoid a error such:
178 #       (.vectors+0x30): relocation truncated to fit: R_AVR_13_PCREL against symbol `__vector_12'
179 #
180
181 ifeq ($(CREATE_MAP),yes)
182         LDFLAGS += -Wl,-Map=$(BUILD_DIR)/$(TARGET).map,--cref
183 endif
184 #LDFLAGS += -Wl,--relax
185 LDFLAGS += $(EXTMEMOPTS)
186 LDFLAGS += $(patsubst %,-L%,$(EXTRALIBDIRS))
187 LDFLAGS += $(PRINTF_LIB) $(SCANF_LIB) $(MATH_LIB)
188 #LDFLAGS += -T linker_script.x
189 # You can give EXTRALDFLAGS at 'make' command line.
190 LDFLAGS += $(EXTRALDFLAGS)
191
192 # Define programs and commands.
193 SHELL = sh
194 REMOVE = rm -f
195 REMOVEDIR = rmdir
196 COPY = cp
197 WINSHELL = cmd
198 SECHO = $(SILENT) || echo
199
200
201 # Compiler flags to generate dependency files.
202 #GENDEPFLAGS = -MMD -MP -MF .dep/$(@F).d
203 GENDEPFLAGS = -MMD -MP -MF $(patsubst %.o,%.td,$@)
204
205
206 # Combine all necessary flags and optional flags.
207 # Add target processor to flags.
208 # You can give extra flags at 'make' command line like: make EXTRAFLAGS=-DFOO=bar
209 ALL_CFLAGS = $(MCUFLAGS) $(CFLAGS) $(EXTRAFLAGS)
210 ALL_CPPFLAGS = $(MCUFLAGS) -x c++ $(CPPFLAGS) $(EXTRAFLAGS)
211 ALL_ASFLAGS = $(MCUFLAGS) -x assembler-with-cpp $(ASFLAGS) $(EXTRAFLAGS)
212
213 MOVE_DEP = mv -f $(patsubst %.o,%.td,$@) $(patsubst %.o,%.d,$@)
214
215
216 elf: $(BUILD_DIR)/$(TARGET).elf
217 hex: $(BUILD_DIR)/$(TARGET).hex
218 cpfirmware: $(FIRMWARE_FORMAT)
219         $(SILENT) || printf "Copying $(TARGET).$(FIRMWARE_FORMAT) to qmk_firmware folder" | $(AWK_CMD)
220         $(COPY) $(BUILD_DIR)/$(TARGET).$(FIRMWARE_FORMAT) $(TARGET).$(FIRMWARE_FORMAT) && $(PRINT_OK)
221 eep: $(BUILD_DIR)/$(TARGET).eep
222 lss: $(BUILD_DIR)/$(TARGET).lss
223 sym: $(BUILD_DIR)/$(TARGET).sym
224 LIBNAME=lib$(TARGET).a
225 lib: $(LIBNAME)
226
227 # Display size of file.
228 HEXSIZE = $(SIZE) --target=$(FORMAT) $(BUILD_DIR)/$(TARGET).hex
229 #ELFSIZE = $(SIZE) --mcu=$(MCU) --format=avr $(TARGET).elf
230 ELFSIZE = $(SIZE) $(BUILD_DIR)/$(TARGET).elf
231
232 sizebefore:
233         @if test -f $(BUILD_DIR)/$(TARGET).hex; then $(SECHO) $(MSG_SIZE_BEFORE); $(SILENT) || $(HEXSIZE); \
234         2>/dev/null; $(SECHO); fi
235
236 sizeafter: $(BUILD_DIR)/$(TARGET).hex
237         @if test -f $(BUILD_DIR)/$(TARGET).hex; then $(SECHO); $(SECHO) $(MSG_SIZE_AFTER); $(SILENT) || $(HEXSIZE); \
238         2>/dev/null; $(SECHO); 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)/$(TARGET).hex\n"; \
251                 $(COPY) $@ $(KEYMAP_PATH)/$(TARGET).hex; \
252         fi
253
254 %.eep: %.elf
255         @$(SILENT) || printf "$(MSG_EEPROM) $@" | $(AWK_CMD)
256         $(eval CMD=$(EEP) $< $@ || exit 0)
257         @$(BUILD_CMD)
258
259 # Create extended listing file from ELF output file.
260 %.lss: %.elf
261         @$(SILENT) || printf "$(MSG_EXTENDED_LISTING) $@" | $(AWK_CMD)
262         $(eval CMD=$(OBJDUMP) -h -S -z $< > $@)
263         @$(BUILD_CMD)
264
265 # Create a symbol table from ELF output file.
266 %.sym: %.elf
267         @$(SILENT) || printf "$(MSG_SYMBOL_TABLE) $@" | $(AWK_CMD)
268         $(eval CMD=$(NM) -n $< > $@ )
269         @$(BUILD_CMD)
270
271 %.bin: %.elf
272         @$(SILENT) || printf "$(MSG_BIN) $@" | $(AWK_CMD)
273         $(eval CMD=$(BIN) $< $@ || exit 0)
274         @$(BUILD_CMD)
275
276 BEGIN = gccversion sizebefore
277
278 # Link: create ELF output file from object files.
279 .SECONDARY : $(BUILD_DIR)/$(TARGET).elf
280 .PRECIOUS : $(OBJ)
281 # Note the obj.txt depeendency is there to force linking if a source file is deleted
282 %.elf: $(OBJ) $(MASTER_OUTPUT)/cflags.txt $(MASTER_OUTPUT)/ldflags.txt $(MASTER_OUTPUT)/obj.txt | $(BEGIN)
283         @$(SILENT) || printf "$(MSG_LINKING) $@" | $(AWK_CMD)
284         $(eval CMD=$(CC) $(ALL_CFLAGS) $(filter-out %.txt,$^) --output $@ $(LDFLAGS))
285         @$(BUILD_CMD)
286         
287
288 define GEN_OBJRULE
289 $1_INCFLAGS := $$(patsubst %,-I%,$$($1_INC))
290 ifdef $1_CONFIG
291 $1_CONFIG_FLAGS += $$(patsubst %,-include %,$$($1_CONFIG))
292 endif
293 $1_CFLAGS = $$(ALL_CFLAGS) $$($1_DEFS) $$($1_INCFLAGS) $$($1_CONFIG_FLAGS)
294 $1_CPPFLAGS= $$(ALL_CPPFLAGS) $$($1_DEFS) $$($1_INCFLAGS) $$($1_CONFIG_FLAGS)
295 $1_ASFLAGS= $$(ALL_ASFLAGS) $$($1_DEFS) $$($1_INCFLAGS) $$($1_CONFIG_FLAGS)
296
297 # Compile: create object files from C source files.
298 $1/%.o : %.c $1/%.d $1/cflags.txt $1/compiler.txt | $(BEGIN)
299         @mkdir -p $$(@D)
300         @$$(SILENT) || printf "$$(MSG_COMPILING) $$<" | $$(AWK_CMD)
301         $$(eval CMD := $$(CC) -c $$($1_CFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
302         @$$(BUILD_CMD)
303
304 # Compile: create object files from C++ source files.
305 $1/%.o : %.cpp $1/%.d $1/cppflags.txt $1/compiler.txt | $(BEGIN)
306         @mkdir -p $$(@D)
307         @$$(SILENT) || printf "$$(MSG_COMPILING_CPP) $$<" | $$(AWK_CMD)
308         $$(eval CMD=$$(CC) -c $$($1_CPPFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
309         @$$(BUILD_CMD)
310
311 $1/%.o : %.cc $1/%.d $1/cppflags.txt $1/compiler.txt | $(BEGIN)
312         @mkdir -p $$(@D)
313         @$$(SILENT) || printf "$$(MSG_COMPILING_CPP) $$<" | $$(AWK_CMD)
314         $$(eval CMD=$$(CC) -c $$($1_CPPFLAGS) $$(GENDEPFLAGS) $$< -o $$@ && $$(MOVE_DEP))
315         @$$(BUILD_CMD)
316
317 # Assemble: create object files from assembler source files.
318 $1/%.o : %.S $1/asflags.txt $1/compiler.txt | $(BEGIN)
319         @mkdir -p $$(@D)
320         @$(SILENT) || printf "$$(MSG_ASSEMBLING) $$<" | $$(AWK_CMD)
321         $$(eval CMD=$$(CC) -c $$($1_ASFLAGS) $$< -o $$@)
322         @$$(BUILD_CMD)
323
324 $1/force:
325
326 $1/cflags.txt: $1/force
327         echo '$$($1_CFLAGS)' | cmp -s - $$@ || echo '$$($1_CFLAGS)' > $$@
328
329 $1/cppflags.txt: $1/force
330         echo '$$($1_CPPFLAGS)' | cmp -s - $$@ || echo '$$($1_CPPFLAGS)' > $$@
331
332 $1/asflags.txt: $1/force
333         echo '$$($1_ASFLAGS)' | cmp -s - $$@ || echo '$$($1_ASFLAGS)' > $$@
334
335 $1/compiler.txt: $1/force
336         $$(CC) --version | cmp -s - $$@ || $$(CC) --version > $$@
337 endef
338
339 .PRECIOUS: $(MASTER_OUTPUT)/obj.txt
340 $(MASTER_OUTPUT)/obj.txt: $(MASTER_OUTPUT)/force
341         echo '$(OBJ)' | cmp -s - $@ || echo '$(OBJ)' > $@
342
343 .PRECIOUS: $(MASTER_OUTPUT)/ldflags.txt
344 $(MASTER_OUTPUT)/ldflags.txt: $(MASTER_OUTPUT)/force
345         echo '$(LDFLAGS)' | cmp -s - $@ || echo '$(LDFLAGS)' > $@
346
347
348 # We have to use static rules for the .d files for some reason
349 DEPS = $(patsubst %.o,%.d,$(OBJ))
350 # Keep the .d files
351 .PRECIOUS: $(DEPS)
352 # Empty rule to force recompilation if the .d file is missing
353 $(DEPS):
354         
355
356 $(foreach OUTPUT,$(OUTPUTS),$(eval $(call GEN_OBJRULE,$(OUTPUT))))
357
358 # Create preprocessed source for use in sending a bug report.
359 %.i : %.c | $(BEGIN)
360         $(CC) -E -mmcu=$(MCU) $(CFLAGS) $< -o $@
361
362 # Target: clean project.
363 clean:
364         $(foreach OUTPUT,$(OUTPUTS), $(REMOVE) -r $(OUTPUT) 2>/dev/null)
365         $(REMOVE) $(BUILD_DIR)/$(TARGET).*
366
367 show_path:
368         @echo VPATH=$(VPATH)
369         @echo SRC=$(SRC)
370         @echo OBJ=$(OBJ)
371
372 ifeq ($(findstring avr-gcc,$(CC)),avr-gcc)
373 check-size:
374         $(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))
375         $(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))
376         $(eval FREE_SIZE=$(shell expr $(MAX_SIZE) - $(CURRENT_SIZE)))
377         $(eval OVER_SIZE=$(shell expr $(CURRENT_SIZE) - $(MAX_SIZE)))
378         if [ $(MAX_SIZE) -gt 0 ] && [ $(CURRENT_SIZE) -gt 0 ]; then \
379                 $(SILENT) || printf "$(MSG_CHECK_FILESIZE)" | $(AWK_CMD); \
380                 if [ $(CURRENT_SIZE) -gt $(MAX_SIZE) ]; then printf "\n * $(MSG_FILE_TOO_BIG)"; $(PRINT_ERROR_PLAIN); else $(PRINT_OK); $(SILENT) || printf " * $(MSG_FILE_JUST_RIGHT)";  fi \
381         fi
382 else
383 check-size:
384         echo "(Firmware size check does not yet support $(MCU) microprocessors; skipping.)"
385 endif
386
387 # Create build directory
388 $(shell mkdir -p $(BUILD_DIR) 2>/dev/null)
389
390 # Create object files directory
391 $(eval $(foreach OUTPUT,$(OUTPUTS),$(shell mkdir -p $(OUTPUT) 2>/dev/null)))
392
393 # Include the dependency files.
394 -include $(patsubst %.o,%.d,$(OBJ))
395
396
397 # Listing of phony targets.
398 .PHONY : all finish sizebefore sizeafter qmkversion \
399 gccversion build elf hex eep lss sym coff extcoff \
400 clean clean_list debug gdb-config show_path \
401 program teensy dfu flip dfu-ee flip-ee dfu-start