projects / pub / USBasp.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Minor documentation corrections.
[pub/USBasp.git] / LUFA / Build / lufa_build.mk
1 #
2 # LUFA Library
3 # Copyright (C) Dean Camera, 2012.
4 #
5 # dean [at] fourwalledcubicle [dot] com
6 # www.lufa-lib.org
7 #
8
9 LUFA_BUILD_MODULES += BUILD
10 LUFA_BUILD_TARGETS += size check-source symbol-sizes all lib elf hex lss clean mostlyclean
11 LUFA_BUILD_MANDATORY_VARS += TARGET ARCH MCU SRC F_USB LUFA_PATH
12 LUFA_BUILD_OPTIONAL_VARS += BOARD OPTIMIZATION C_STANDARD CPP_STANDARD F_CPU C_FLAGS CPP_FLAGS ASM_FLAGS CC_FLAGS LD_FLAGS OBJDIR OBJECT_FILES DEBUG_TYPE DEBUG_LEVEL
13 LUFA_BUILD_PROVIDED_VARS +=
14 LUFA_BUILD_PROVIDED_MACROS +=
15
16 # -----------------------------------------------------------------------------
17 # LUFA GCC Compiler Buildsystem Makefile Module.
18 # -----------------------------------------------------------------------------
19 # DESCRIPTION:
20 # Provides a set of targets to build a C, C++ and/or Assembly application
21 # via the AVR-GCC compiler.
22 # -----------------------------------------------------------------------------
23 # TARGETS:
24 #
25 # size - List built application size
26 # symbol-sizes - Print application symbols from the binary ELF
27 # file as a list sorted by size in bytes
28 # check-source - Print a list of SRC source files that cannot
29 # be found
30 # all - Build application and list size
31 # lib - Build and archive source files into a library
32 # elf - Build application ELF debug object file
33 # hex - Build application HEX object files
34 # lss - Build application LSS assembly listing file
35 # clean - Remove all project intermediatary and binary
36 # output files
37 # mostlyclean - Remove intermediatary output files, but
38 # preserve binaries
39 # <filename>.s - Compile C/C++ source file into an assembly file
40 # for manual code inspection
41 #
42 # MANDATORY PARAMETERS:
43 #
44 # TARGET - Application name
45 # ARCH - Device architecture name
46 # MCU - Microcontroller device model name
47 # SRC - List of input source files (*.c, *.cpp, *.S)
48 # F_USB - Speed of the input clock of the USB controller
49 # in Hz
50 # LUFA_PATH - Path to the LUFA library core
51 #
52 # OPTIONAL PARAMETERS:
53 #
54 # BOARD - LUFA board hardware
55 # OPTIMIZATION - Optimization level
56 # C_STANDARD - C Language Standard to use
57 # CPP_STANDARD - C++ Language Standard to use
58 # F_CPU - Speed of the CPU, in Hz
59 # C_FLAGS - Flags to pass to the C compiler only
60 # CPP_FLAGS - Flags to pass to the C++ compiler only
61 # ASM_FLAGS - Flags to pass to the assembler only
62 # CC_FLAGS - Common flags to pass to the C/C++ compiler and
63 # assembler
64 # LD_FLAGS - Flags to pass to the linker
65 # OBJDIR - Directory for the output object and dependency
66 # files; if equal to ".", the output files will
67 # be generated in the same folder as the sources
68 # OBJECT_FILES - Extra object files to link in to the binaries
69 # DEBUG_FORMAT - Format of the debugging information to
70 # generate in the compiled object files
71 # DEBUG_LEVEL - Level the debugging information to generate in
72 # the compiled object files
73 #
74 # PROVIDED VARIABLES:
75 #
76 # (None)
77 #
78 # PROVIDED MACROS:
79 #
80 # (None)
81 #
82 # -----------------------------------------------------------------------------
83
84 SHELL = /bin/sh
85
86 ERROR_IF_UNSET ?= $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
87 ERROR_IF_EMPTY ?= $(if $(strip $($(strip $(1)))), , $(error Makefile $(strip $(1)) option cannot be blank))
88 ERROR_IF_NONBOOL ?= $(if $(filter Y N, $($(strip $(1)))), , $(error Makefile $(strip $(1)) option must be Y or N))
89
90 # Default values of optionally user-supplied variables
91 BOARD ?= NONE
92 OPTIMIZATION ?= s
93 F_CPU ?=
94 C_STANDARD ?= gnu99
95 CPP_STANDARD ?= gnu++98
96 C_FLAGS ?=
97 CPP_FLAGS ?=
98 ASM_FLAGS ?=
99 CC_FLAGS ?=
100 OBJDIR ?= .
101 OBJECT_FILES ?=
102 DEBUG_FORMAT ?= dwarf-2
103 DEBUG_LEVEL ?= 2
104
105 # Sanity check user supplied values
106 $(foreach MANDATORY_VAR, $(LUFA_BUILD_MANDATORY_VARS), $(call ERROR_IF_UNSET, $(MANDATORY_VAR)))
107 $(call ERROR_IF_EMPTY, MCU)
108 $(call ERROR_IF_EMPTY, TARGET)
109 $(call ERROR_IF_EMPTY, ARCH)
110 $(call ERROR_IF_EMPTY, F_USB)
111 $(call ERROR_IF_EMPTY, LUFA_PATH)
112 $(call ERROR_IF_EMPTY, BOARD)
113 $(call ERROR_IF_EMPTY, OPTIMIZATION)
114 $(call ERROR_IF_EMPTY, C_STANDARD)
115 $(call ERROR_IF_EMPTY, CPP_STANDARD)
116 $(call ERROR_IF_EMPTY, OBJDIR)
117 $(call ERROR_IF_EMPTY, DEBUG_FORMAT)
118 $(call ERROR_IF_EMPTY, DEBUG_LEVEL)
119
120 # Determine the utility prefix to use for the selected architecture
121 ifeq ($(ARCH), AVR8)
122 CROSS := avr
123 else ifeq ($(ARCH), XMEGA)
124 CROSS := avr
125 $(warning The XMEGA device support is currently EXPERIMENTAL (incomplete and/or non-functional), and is included for preview purposes only.)
126 else ifeq ($(ARCH), UC3)
127 CROSS := avr32
128 $(warning The UC3 device support is currently EXPERIMENTAL (incomplete and/or non-functional), and is included for preview purposes only.)
129 else
130 $(error Unsupported architecture "$(ARCH)")
131 endif
132
133 # Output Messages
134 MSG_INFO_MESSAGE := ' [INFO] :'
135 MSG_COMPILE_CMD := ' [GCC] :'
136 MSG_ASSEMBLE_CMD := ' [GAS] :'
137 MSG_NM_CMD := ' [NM] :'
138 MSG_REMOVE_CMD := ' [RM] :'
139 MSG_LINK_CMD := ' [LNK] :'
140 MSG_ARCHIVE_CMD := ' [AR] :'
141 MSG_SIZE_CMD := ' [SIZE] :'
142 MSG_OBJCPY_CMD := ' [OBJCPY] :'
143 MSG_OBJDMP_CMD := ' [OBJDMP] :'
144
145 # Convert input source file list to differentiate them by type
146 C_SOURCE := $(filter %.c, $(SRC))
147 CPP_SOURCE := $(filter %.cpp, $(SRC))
148 ASM_SOURCE := $(filter %.S, $(SRC))
149
150 # Create a list of unknown source file types, if any are found throw an error
151 UNKNOWN_SOURCE := $(filter-out $(C_SOURCE) $(CPP_SOURCE) $(ASM_SOURCE), $(SRC))
152 ifneq ($(UNKNOWN_SOURCE),)
153 $(error Unknown input source file formats: $(UNKNOWN_SOURCE))
154 endif
155
156 # Convert input source filenames into a list of required output object files
157 OBJECT_FILES += $(addsuffix .o, $(basename $(SRC)))
158
159 # Check if an output object file directory was specified instead of the input file location
160 ifneq ($(OBJDIR),.)
161 # Prefix all the object filenames with the output object file directory path
162 OBJECT_FILES := $(addprefix $(patsubst %/,%,$(OBJDIR))/, $(notdir $(OBJECT_FILES)))
163
164 # Check if any object file (without path) appears more than once in the object file list
165 ifneq ($(words $(sort $(OBJECT_FILES))), $(words $(OBJECT_FILES)))
166 $(error Cannot build with OBJDIR parameter set - one or more object file name is not unique)
167 endif
168
169 # Create the output object file directory if it does not exist and add it to the virtual path list
170 $(shell mkdir $(OBJDIR) 2> /dev/null)
171 VPATH += $(dir $(SRC))
172 endif
173
174 # Create a list of dependency files from the list of object files
175 DEPENDENCY_FILES := $(OBJECT_FILES:%.o=%.d)
176
177 # Create a list of common flags to pass to the compiler/linker/assembler
178 BASE_CC_FLAGS := -pipe -g$(DEBUG_FORMAT) -g$(DEBUG_LEVEL)
179 ifeq ($(ARCH), AVR8)
180 BASE_CC_FLAGS += -mmcu=$(MCU) -fshort-enums -fno-inline-small-functions -fpack-struct
181 else ifeq ($(ARCH), XMEGA)
182 BASE_CC_FLAGS += -mmcu=$(MCU) -fshort-enums -fno-inline-small-functions -fpack-struct
183 else ifeq ($(ARCH), UC3)
184 BASE_CC_FLAGS += -mpart=$(MCU:at32%=%) -masm-addr-pseudos
185 endif
186 BASE_CC_FLAGS += -Wall -fno-strict-aliasing -funsigned-char -funsigned-bitfields -ffunction-sections
187 BASE_CC_FLAGS += -I. -I$(patsubst %/,%,$(LUFA_PATH))/..
188 BASE_CC_FLAGS += -DARCH=ARCH_$(ARCH) -DBOARD=BOARD_$(BOARD) -DF_USB=$(F_USB)UL
189 ifneq ($(F_CPU),)
190 BASE_CC_FLAGS += -DF_CPU=$(F_CPU)UL
191 endif
192
193 # Additional language specific compiler flags
194 BASE_C_FLAGS := -x c -O$(OPTIMIZATION) -std=$(C_STANDARD) -Wstrict-prototypes
195 BASE_CPP_FLAGS := -x c++ -O$(OPTIMIZATION) -std=$(CPP_STANDARD)
196 BASE_ASM_FLAGS := -x assembler-with-cpp
197
198 # Create a list of flags to pass to the linker
199 BASE_LD_FLAGS := -lm -Wl,-Map=$(TARGET).map,--cref -Wl,--gc-sections -Wl,--relax
200 ifeq ($(ARCH), AVR8)
201 BASE_LD_FLAGS += -mmcu=$(MCU)
202 else ifeq ($(ARCH), XMEGA)
203 BASE_LD_FLAGS += -mmcu=$(MCU)
204 else ifeq ($(ARCH), UC3)
205 BASE_LD_FLAGS += -mpart=$(MCU:at32%=%) --rodata-writable --direct-data
206 endif
207
208 # Determine flags to pass to the size utility based on its reported features (only invoke if size target required)
209 size: SIZE_MCU_FLAG := $(shell $(CROSS)-size --help | grep -- --mcu > /dev/null && echo --mcu=$(MCU) )
210 size: SIZE_FORMAT_FLAG := $(shell $(CROSS)-size --help | grep -- --format=.*avr > /dev/null && echo --format=avr )
211
212 # Pre-build informational target, to give compiler and project name information when building
213 build_begin:
214 @echo $(MSG_INFO_MESSAGE) Begin compilation of project \"$(TARGET)\"...
215 @echo ""
216 @$(CROSS)-gcc --version
217
218 # Post-build informational target, to project name information when building has completed
219 build_end:
220 @echo $(MSG_INFO_MESSAGE) Finished building project \"$(TARGET)\".
221
222 # Checks all target source files and provides information on whether they exist or not
223 check-source:
224 @for f in $(SRC); do \
225 if [ ! -f $$f ]; then \
226 echo "Error: Source file not found: $$f"; \
227 exit 1; \
228 fi; \
229 done
230
231 # Prints size information of a compiled application (FLASH, RAM and EEPROM usages)
232 size: $(TARGET).elf
233 @echo $(MSG_SIZE_CMD) Determining size of \"$<\"
234 @echo ""
235 $(CROSS)-size $(SIZE_MCU_FLAG) $(SIZE_FORMAT_FLAG) $< ; 2>/dev/null;
236
237 # Prints size information on the symbols within a compiled application in decimal bytes
238 symbol-sizes: $(TARGET).elf
239 @echo $(MSG_NM_CMD) Extracting \"$<\" symbols with decimal byte sizes
240 $(CROSS)-nm --size-sort --demangle --radix=d $<
241
242 # Cleans intermediatary build files, leaving only the compiled application files
243 mostlyclean:
244 @echo $(MSG_REMOVE_CMD) Removing object files of \"$(TARGET)\"
245 rm -f $(OBJECT_FILES)
246 @echo $(MSG_REMOVE_CMD) Removing dependency files of \"$(TARGET)\"
247 rm -f $(DEPENDENCY_FILES)
248
249 # Cleans all build files, leaving only the original source code
250 clean: mostlyclean
251 @echo $(MSG_REMOVE_CMD) Removing output files of \"$(TARGET)\"
252 rm -f $(TARGET).elf $(TARGET).hex $(TARGET).eep $(TARGET).map $(TARGET).lss $(TARGET).sym $(TARGET).a
253
254 # Performs a complete build of the user application and prints size information afterwards
255 all: build_begin elf hex lss sym size build_end
256
257 # Helper targets, to build a specific type of output file without having to know the project target name
258 lib: lib$(TARGET).a
259 elf: $(TARGET).elf
260 hex: $(TARGET).hex $(TARGET).eep
261 lss: $(TARGET).lss
262 sym: $(TARGET).sym
263
264 # Default target to *create* the user application's specified source files; if this rule is executed by
265 # make, the input source file doens't exist and an error needs to be presented to the user
266 $(SRC):
267 $(error Source file does not exist: $@)
268
269 # Compiles an input C source file and generates an assembly listing for it
270 %.s: %.c $(MAKEFILE_LIST)
271 @echo $(MSG_COMPILE_CMD) Generating assembly from C file \"$(notdir $<)\"
272 $(CROSS)-gcc -S $(BASE_CC_FLAGS) $(BASE_C_FLAGS) $(CC_FLAGS) $(C_FLAGS) $< -o $@
273
274 # Compiles an input C++ source file and generates an assembly listing for it
275 %.s: %.cpp $(MAKEFILE_LIST)
276 @echo $(MSG_COMPILE_CMD) Generating assembly from C++ file \"$(notdir $<)\"
277 $(CROSS)-gcc -S $(BASE_CC_FLAGS) $(BASE_CPP_FLAGS) $(CC_FLAGS) $(CPP_FLAGS) $< -o $@
278
279 # Compiles an input C source file and generates a linkable object file for it
280 $(OBJDIR)/%.o: %.c $(MAKEFILE_LIST)
281 @echo $(MSG_COMPILE_CMD) Compiling C file \"$(notdir $<)\"
282 $(CROSS)-gcc -c $(BASE_CC_FLAGS) $(BASE_C_FLAGS) $(CC_FLAGS) $(C_FLAGS) -MMD -MP -MF $(@:%.o=%.d) $< -o $@
283
284 # Compiles an input C++ source file and generates a linkable object file for it
285 $(OBJDIR)/%.o: %.cpp $(MAKEFILE_LIST)
286 @echo $(MSG_COMPILE_CMD) Compiling C++ file \"$(notdir $<)\"
287 $(CROSS)-gcc -c $(BASE_CC_FLAGS) $(BASE_CPP_FLAGS) $(CC_FLAGS) $(CPP_FLAGS) -MMD -MP -MF $(@:%.o=%.d) $< -o $@
288
289 # Assembles an input ASM source file and generates a linkable object file for it
290 $(OBJDIR)/%.o: %.S $(MAKEFILE_LIST)
291 @echo $(MSG_ASSEMBLE_CMD) Assembling \"$(notdir $<)\"
292 $(CROSS)-gcc -c $(BASE_CC_FLAGS) $(BASE_ASM_FLAGS) $(CC_FLAGS) $(ASM_FLAGS) -MMD -MP -MF $(@:%.o=%.d) $< -o $@
293
294 # Generates a library archive file from the user application, which can be linked into other applications
295 .PRECIOUS : $(OBJECT_FILES)
296 .SECONDARY : %.a
297 %.a: $(OBJECT_FILES)
298 @echo $(MSG_ARCHIVE_CMD) Archiving object files into \"$@\"
299 $(CROSS)-ar rcs $@ $(OBJECT_FILES)
300
301 # Generates an ELF debug file from the user application, which can be further processed for FLASH and EEPROM data
302 # files, or used for programming and debugging directly
303 .PRECIOUS : $(OBJECT_FILES)
304 .SECONDARY : %.elf
305 %.elf: $(OBJECT_FILES)
306 @echo $(MSG_LINK_CMD) Linking object files into \"$@\"
307 $(CROSS)-gcc $(BASE_LD_FLAGS) $(LD_FLAGS) $^ -o $@
308
309 # Extracts out the loadable FLASH memory data from the project ELF file, and creates an Intel HEX format file of it
310 %.hex: %.elf
311 @echo $(MSG_OBJCPY_CMD) Extracting HEX file data from \"$<\"
312 $(CROSS)-objcopy -O ihex -R .eeprom -R .fuse -R .lock -R .signature $< $@
313
314 # Extracts out the loadable EEPROM memory data from the project ELF file, and creates an Intel HEX format file of it
315 %.eep: %.elf
316 @echo $(MSG_OBJCPY_CMD) Extracting EEP file data from \"$<\"
317 $(CROSS)-objcopy -j .eeprom --set-section-flags=.eeprom="alloc,load" --change-section-lma .eeprom=0 --no-change-warnings -O ihex $< $@ || exit 0
318
319 # Creates an assembly listing file from an input project ELF file, containing interleaved assembly and source data
320 %.lss: %.elf
321 @echo $(MSG_OBJDMP_CMD) Extracting LSS file data from \"$<\"
322 $(CROSS)-objdump -h -S -z $< > $@
323
324 # Creates a symbol file listing the loadable and discarded symbols from an input project ELF file
325 %.sym: %.elf
326 @echo $(MSG_NM_CMD) Extracting SYM file data from \"$<\"
327 $(CROSS)-nm -n $< > $@
328
329 # Include build dependency files
330 -include $(DEPENDENCY_FILES)
331
332 # Phony build targets for this module
333 .PHONY: build_begin build_end check-source size symbol-sizes lib elf hex lss clean mostlyclean
USB isp AVR programmer