lufa_build.mk 14.5 KB
Newer Older
1
2
3
4
5
6
7
8
#
#             LUFA Library
#     Copyright (C) Dean Camera, 2012.
#
#  dean [at] fourwalledcubicle [dot] com
#           www.lufa-lib.org
#

9
LUFA_BUILD_MODULES         += BUILD
10
LUFA_BUILD_TARGETS         += size 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 LINKER_RELAXATIONS
13
14
LUFA_BUILD_PROVIDED_VARS   += 
LUFA_BUILD_PROVIDED_MACROS += 
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# -----------------------------------------------------------------------------
#               LUFA GCC Compiler Buildsystem Makefile Module.
# -----------------------------------------------------------------------------
# DESCRIPTION:
#   Provides a set of targets to build a C, C++ and/or Assembly application
#   via the AVR-GCC compiler.
# -----------------------------------------------------------------------------
# TARGETS:
#
#    size                      - List built application size
#    symbol-sizes              - Print application symbols from the binary ELF
#                                file as a list sorted by size in bytes
#    all                       - Build application and list size
29
#    lib                       - Build and archive source files into a library
30
31
32
#    elf                       - Build application ELF debug object file
#    hex                       - Build application HEX object files
#    lss                       - Build application LSS assembly listing file
33
34
35
36
#    clean                     - Remove all project intermediatary and binary
#                                output files
#    mostlyclean               - Remove intermediatary output files, but
#                                preserve binaries
37
38
#    <filename>.s              - Compile C/C++ source file into an assembly file
#                                for manual code inspection
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#
# MANDATORY PARAMETERS:
#
#    TARGET                    - Application name
#    ARCH                      - Device architecture name
#    MCU                       - Microcontroller device model name
#    SRC                       - List of input source files (*.c, *.cpp, *.S)
#    F_USB                     - Speed of the input clock of the USB controller
#                                in Hz
#    LUFA_PATH                 - Path to the LUFA library core
#
# OPTIONAL PARAMETERS:
#
#    BOARD                     - LUFA board hardware
#    OPTIMIZATION              - Optimization level
#    C_STANDARD                - C Language Standard to use
#    CPP_STANDARD              - C++ Language Standard to use
#    F_CPU                     - Speed of the CPU, in Hz
#    C_FLAGS                   - Flags to pass to the C compiler only
#    CPP_FLAGS                 - Flags to pass to the C++ compiler only
#    ASM_FLAGS                 - Flags to pass to the assembler only
#    CC_FLAGS                  - Common flags to pass to the C/C++ compiler and
#                                assembler
#    LD_FLAGS                  - Flags to pass to the linker
63
64
65
#    LINKER_RELAXATIONS        - Enable or disable linker relaxations to
#                                decrease binary size (note: can cause link
#                                failures on systems with an unpatched binutils)
66
67
68
#    OBJDIR                    - Directory for the output object and dependency
#                                files; if equal to ".", the output files will
#                                be generated in the same folder as the sources
69
#    OBJECT_FILES              - Extra object files to link in to the binaries
70
71
72
73
#    DEBUG_FORMAT              - Format of the debugging information to
#                                generate in the compiled object files
#    DEBUG_LEVEL               - Level the debugging information to generate in
#                                the compiled object files
74
#
75
76
77
78
79
80
81
82
# PROVIDED VARIABLES:
#
#    (None)
#
# PROVIDED MACROS:
#
#    (None)
#
83
84
# -----------------------------------------------------------------------------

85
86
87
88
89
SHELL = /bin/sh

ERROR_IF_UNSET   ?= $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
ERROR_IF_EMPTY   ?= $(if $(strip $($(strip $(1)))), , $(error Makefile $(strip $(1)) option cannot be blank))
ERROR_IF_NONBOOL ?= $(if $(filter Y N, $($(strip $(1)))), , $(error Makefile $(strip $(1)) option must be Y or N))
90
91

# Default values of optionally user-supplied variables
92
93
94
95
96
97
98
99
100
101
102
103
104
105
BOARD              ?= NONE
OPTIMIZATION       ?= s
F_CPU              ?=
C_STANDARD         ?= gnu99
CPP_STANDARD       ?= gnu++98
C_FLAGS            ?=
CPP_FLAGS          ?=
ASM_FLAGS          ?=
CC_FLAGS           ?=
OBJDIR             ?= .
OBJECT_FILES       ?=
DEBUG_FORMAT       ?= dwarf-2
DEBUG_LEVEL        ?= 2
LINKER_RELAXATIONS ?= Y
106

107
108
109
110
111
112
113
114
115
116
117
# Sanity check user supplied values
$(foreach MANDATORY_VAR, $(LUFA_BUILD_MANDATORY_VARS), $(call ERROR_IF_UNSET, $(MANDATORY_VAR)))
$(call ERROR_IF_EMPTY, MCU)
$(call ERROR_IF_EMPTY, TARGET)
$(call ERROR_IF_EMPTY, ARCH)
$(call ERROR_IF_EMPTY, F_USB)
$(call ERROR_IF_EMPTY, LUFA_PATH)
$(call ERROR_IF_EMPTY, BOARD)
$(call ERROR_IF_EMPTY, OPTIMIZATION)
$(call ERROR_IF_EMPTY, C_STANDARD)
$(call ERROR_IF_EMPTY, CPP_STANDARD)
118
$(call ERROR_IF_EMPTY, OBJDIR)
119
120
$(call ERROR_IF_EMPTY, DEBUG_FORMAT)
$(call ERROR_IF_EMPTY, DEBUG_LEVEL)
121
$(call ERROR_IF_NONBOOL, LINKER_RELAXATIONS)
122

123
124
# Determine the utility prefix to use for the selected architecture
ifeq ($(ARCH), AVR8)
125
   CROSS        := avr
126
else ifeq ($(ARCH), XMEGA)
127
   CROSS        := avr
128
   $(warning The XMEGA device support is currently EXPERIMENTAL (incomplete and/or non-functional), and is included for preview purposes only.)
129
else ifeq ($(ARCH), UC3)
130
   CROSS        := avr32
131
   $(warning The UC3 device support is currently EXPERIMENTAL (incomplete and/or non-functional), and is included for preview purposes only.)
132
else
133
   $(error Unsupported architecture "$(ARCH)")
134
135
136
endif

# Output Messages
137
MSG_INFO_MESSAGE := ' [INFO]    :'
138
139
MSG_COMPILE_CMD  := ' [GCC]     :'
MSG_ASSEMBLE_CMD := ' [GAS]     :'
140
141
MSG_NM_CMD       := ' [NM]      :'
MSG_REMOVE_CMD   := ' [RM]      :'
142
143
MSG_LINK_CMD     := ' [LNK]     :'
MSG_ARCHIVE_CMD  := ' [AR]      :'
144
145
146
147
148
MSG_SIZE_CMD     := ' [SIZE]    :'
MSG_OBJCPY_CMD   := ' [OBJCPY]  :'
MSG_OBJDMP_CMD   := ' [OBJDMP]  :'

# Convert input source file list to differentiate them by type
149
150
151
C_SOURCE   := $(filter %.c, $(SRC))
CPP_SOURCE := $(filter %.cpp, $(SRC))
ASM_SOURCE := $(filter %.S, $(SRC))
152
153

# Create a list of unknown source file types, if any are found throw an error
154
UNKNOWN_SOURCE := $(filter-out $(C_SOURCE) $(CPP_SOURCE) $(ASM_SOURCE), $(SRC))
155
ifneq ($(UNKNOWN_SOURCE),)
156
   $(error Unknown input source file formats: $(UNKNOWN_SOURCE))
157
158
159
endif

# Convert input source filenames into a list of required output object files
160
OBJECT_FILES += $(addsuffix .o, $(basename $(SRC)))
161
162

# Check if an output object file directory was specified instead of the input file location
163
ifneq ($(OBJDIR),.)
164
   # Prefix all the object filenames with the output object file directory path
165
   OBJECT_FILES    := $(addprefix $(patsubst %/,%,$(OBJDIR))/, $(notdir $(OBJECT_FILES)))
166
167
168
169
170
   
   # Check if any object file (without path) appears more than once in the object file list
   ifneq ($(words $(sort $(OBJECT_FILES))), $(words $(OBJECT_FILES)))
       $(error Cannot build with OBJDIR parameter set - one or more object file name is not unique)
   endif
171
172
173
174

   # Create the output object file directory if it does not exist and add it to the virtual path list
   $(shell mkdir $(OBJDIR) 2> /dev/null)   
   VPATH           += $(dir $(SRC))
175
176
endif

177
# Create a list of dependency files from the list of object files
178
DEPENDENCY_FILES := $(OBJECT_FILES:%.o=%.d)
179
180

# Create a list of common flags to pass to the compiler/linker/assembler
181
BASE_CC_FLAGS    := -pipe -g$(DEBUG_FORMAT) -g$(DEBUG_LEVEL)
182
ifeq ($(ARCH), AVR8)
183
   BASE_CC_FLAGS += -mmcu=$(MCU) -fshort-enums -fno-inline-small-functions -fpack-struct
184
else ifeq ($(ARCH), XMEGA)
185
   BASE_CC_FLAGS += -mmcu=$(MCU) -fshort-enums -fno-inline-small-functions -fpack-struct
186
else ifeq ($(ARCH), UC3)
187
   BASE_CC_FLAGS += -mpart=$(MCU:at32%=%) -masm-addr-pseudos
188
189
190
191
192
193
194
195
196
197
198
199
200
201
endif
BASE_CC_FLAGS += -Wall -fno-strict-aliasing -funsigned-char -funsigned-bitfields -ffunction-sections
BASE_CC_FLAGS += -I. -I$(patsubst %/,%,$(LUFA_PATH))/..
BASE_CC_FLAGS += -DARCH=ARCH_$(ARCH) -DBOARD=BOARD_$(BOARD) -DF_USB=$(F_USB)UL
ifneq ($(F_CPU),)
   BASE_CC_FLAGS += -DF_CPU=$(F_CPU)UL
endif

# Additional language specific compiler flags
BASE_C_FLAGS   := -x c -O$(OPTIMIZATION) -std=$(C_STANDARD) -Wstrict-prototypes
BASE_CPP_FLAGS := -x c++ -O$(OPTIMIZATION) -std=$(CPP_STANDARD)
BASE_ASM_FLAGS := -x assembler-with-cpp

# Create a list of flags to pass to the linker
202
203
204
205
BASE_LD_FLAGS := -lm -Wl,-Map=$(TARGET).map,--cref -Wl,--gc-sections
ifeq ($(LINKER_RELAXATIONS), Y)
   BASE_LD_FLAGS += -Wl,--relax
endif
206
207
208
209
210
211
ifeq ($(ARCH), AVR8)
   BASE_LD_FLAGS += -mmcu=$(MCU)
else ifeq ($(ARCH), XMEGA)
   BASE_LD_FLAGS += -mmcu=$(MCU)
else ifeq ($(ARCH), UC3)
   BASE_LD_FLAGS += -mpart=$(MCU:at32%=%) --rodata-writable --direct-data
212
213
endif

214
# Determine flags to pass to the size utility based on its reported features (only invoke if size target required)
215
216
# and on an architecture where this non-standard patch is available
ifneq ($(ARCH), UC3)
217
218
size: SIZE_MCU_FLAG    := $(shell $(CROSS)-size --help | grep -- --mcu > /dev/null && echo --mcu=$(MCU) )
size: SIZE_FORMAT_FLAG := $(shell $(CROSS)-size --help | grep -- --format=.*avr > /dev/null && echo --format=avr )
219
endif
220

221
# Pre-build informational target, to give compiler and project name information when building
222
build_begin:
223
	@echo $(MSG_INFO_MESSAGE) Begin compilation of project \"$(TARGET)\"...
224
	@echo ""
225
	@$(CROSS)-gcc --version
226
	
227
# Post-build informational target, to project name information when building has completed
228
build_end:
229
	@echo $(MSG_INFO_MESSAGE) Finished building project \"$(TARGET)\".
230

231
# Prints size information of a compiled application (FLASH, RAM and EEPROM usages)
232
233
size: $(TARGET).elf
	@echo $(MSG_SIZE_CMD) Determining size of \"$<\"
234
	@echo ""
235
	$(CROSS)-size $(SIZE_MCU_FLAG) $(SIZE_FORMAT_FLAG) $<
236

237
# Prints size information on the symbols within a compiled application in decimal bytes
238
239
symbol-sizes: $(TARGET).elf
	@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
245
246
247
	@echo $(MSG_REMOVE_CMD) Removing object files of \"$(TARGET)\"
	rm -f $(OBJECT_FILES)
	@echo $(MSG_REMOVE_CMD) Removing dependency files of \"$(TARGET)\"
	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
255
# Performs a complete build of the user application and prints size information afterwards
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
260
261
elf: $(TARGET).elf
hex: $(TARGET).hex $(TARGET).eep
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 doesn't exist and an error needs to be presented to the user
266
267
268
269
$(SRC):
	$(error Source file does not exist: $@)

# Compiles an input C source file and generates an assembly listing for it
270
271
272
273
%.s: %.c $(MAKEFILE_LIST)
	@echo $(MSG_COMPILE_CMD) Generating assembly from C file \"$(notdir $<)\"
	$(CROSS)-gcc -S $(BASE_CC_FLAGS) $(BASE_C_FLAGS) $(CC_FLAGS) $(C_FLAGS) $< -o $@

274
# Compiles an input C++ source file and generates an assembly listing for it
275
276
277
278
%.s: %.cpp $(MAKEFILE_LIST)
	@echo $(MSG_COMPILE_CMD) Generating assembly from C++ file \"$(notdir $<)\"
	$(CROSS)-gcc -S $(BASE_CC_FLAGS) $(BASE_CPP_FLAGS) $(CC_FLAGS) $(CPP_FLAGS) $< -o $@

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
296
297
298
299
300
.PRECIOUS  : $(OBJECT_FILES)
.SECONDARY : %.a
%.a: $(OBJECT_FILES)
	@echo $(MSG_ARCHIVE_CMD) Archiving object files into \"$@\"
	$(CROSS)-ar rcs $@ $(OBJECT_FILES)

301
302
# Generates an ELF debug file from the user application, which can be further processed for FLASH and EEPROM data
# files, or used for programming and debugging directly
303
304
.PRECIOUS  : $(OBJECT_FILES)
.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
311
%.hex: %.elf
	@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
316
%.eep: %.elf
	@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
321
%.lss: %.elf
	@echo $(MSG_OBJDMP_CMD) Extracting LSS file data from \"$<\"
322
	$(CROSS)-objdump -h -d -S -z $< > $@
323

324
# Creates a symbol file listing the loadable and discarded symbols from an input project ELF file
325
326
%.sym: %.elf
	@echo $(MSG_NM_CMD) Extracting SYM file data from \"$<\"
327
	$(CROSS)-nm -n $< > $@
328

329
330
331
332
# Include build dependency files
-include $(DEPENDENCY_FILES)

# Phony build targets for this module
333
.PHONY: build_begin build_end size symbol-sizes lib elf hex lss clean mostlyclean