LUFA/Build/lufa_build.mk

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