1 # Hey Emacs, this is a -*- makefile -*-
2 #----------------------------------------------------------------------------
3 # WinAVR Makefile Template written by Eric B. Weddington, Jörg Wunsch, et al.
4 # >> Modified for use with the LUFA project. <<
6 # Released to the Public Domain
8 # Additional material for this makefile was written by:
21 #----------------------------------------------------------------------------
24 # make all = Make software.
26 # make clean = Clean out built project files.
28 # make coff = Convert ELF to AVR COFF.
30 # make extcoff = Convert ELF to AVR Extended COFF.
32 # make program = Download the hex file to the device, using avrdude.
33 # Please customize the avrdude settings below first!
35 # make dfu = Download the hex file to the device, using dfu-programmer (must
36 # have dfu-programmer installed).
38 # make flip = Download the hex file to the device, using Atmel FLIP (must
39 # have Atmel FLIP installed).
41 # make dfu-ee = Download the eeprom file to the device, using dfu-programmer
42 # (must have dfu-programmer installed).
44 # make flip-ee = Download the eeprom file to the device, using Atmel FLIP
45 # (must have Atmel FLIP installed).
47 # make doxygen = Generate DoxyGen documentation for the project (must have
50 # make debug = Start either simulavr or avarice as specified for debugging,
51 # with avr-gdb or avr-insight as the front end for debugging.
53 # make filename.s = Just compile filename.c into the assembler code only.
55 # make filename.i = Create a preprocessed source file for use in submitting
56 # bug reports to the GCC project.
58 # To rebuild project do "make clean" then "make all".
59 #----------------------------------------------------------------------------
63 MCU = ### INSERT NAME OF MICROCONTROLLER MODEL HERE ###
66 # Targeted chip architecture (see library "Architectures" documentation)
70 # Target board (see library "Board Types" documentation, NONE for projects not requiring
71 # LUFA board drivers). If USER is selected, put custom board drivers in a directory called
72 # "Board" inside the application directory.
73 BOARD = ### INSERT NAME OF BOARD HERE, OR NONE IF NO BOARD DRIVERS USED ###
76 # Processor frequency.
77 # This will define a symbol, F_CPU, in all source code files equal to the
78 # processor frequency in Hz. You can then use this symbol in your source code to
79 # calculate timings. Do NOT tack on a 'UL' at the end, this will be done
80 # automatically to create a 32-bit value in your source code.
82 # This should be the frequency the system core runs at, after the system clock
83 # has been set up correctly and started.
84 F_CPU = ### INSERT PRESCALED SYSTEM CLOCK SPEED HERE, IN HZ ###
87 # USB controller master clock frequency.
88 # This will define a symbol, F_USB, in all source code files equal to the
89 # input clock frequency of the USB controller's clock generator in Hz.
91 # For the XMEGA chips, this should be equal to a multiple of 6MHz for Low
92 # Speed USB mode, or a multiple of 48MHz for Full Speed USB mode.
93 F_USB = ### INSERT CLOCK TO USB MODULE HERE, IN HZ ###
96 # Output format. (can be srec, ihex, binary)
100 # Target file name (without extension).
101 TARGET = ### INSERT NAME OF MAIN FILENAME HERE, WITHOUT EXTENSION ###
104 # Object files directory
105 # To put object files in current directory, use a dot (.), do NOT make
106 # this an empty or blank macro!
110 # Path to the LUFA library
111 LUFA_PATH = ### INSERT PATH TO LUFA LIBRARY RELATIVE TO PROJECT DIRECTORY HERE ###
114 # LUFA library compile-time options and predefined tokens (add '-D' before each token)
115 LUFA_OPTS = ### INSERT LUFA COMPILE TIME TOKENS HERE ###
118 # Create the LUFA source path variables by including the LUFA root makefile
119 include $(LUFA_PATH)/LUFA/makefile
122 # List C source files here. (C dependencies are automatically generated.)
126 ### INSERT ADDITIONAL PROJECT SOURCE FILENAMES OR LUFA MODULE NAMES HERE ###
129 # List C++ source files here. (C dependencies are automatically generated.)
133 # List Assembler source files here.
134 # Make them always end in a capital .S. Files ending in a lowercase .s
135 # will not be considered source files but generated files (assembler
136 # output from the compiler), and will be deleted upon "make clean"!
137 # Even though the DOS/Win* filesystem matches both .s and .S the same,
138 # it will preserve the spelling of the filenames, and gcc itself does
139 # care about how the name is spelled on its command-line.
143 # Optimization level, can be [0, 1, 2, 3, s].
144 # 0 = turn off optimization. s = optimize for size.
145 # (Note: 3 is not always the best optimization level. See avr-libc FAQ.)
149 # List any extra directories to look for include files here.
150 # Each directory must be seperated by a space.
151 # Use forward slashes for directory separators.
152 # For a directory that has spaces, enclose it in quotes.
153 EXTRAINCDIRS = $(LUFA_PATH)/
156 # Compiler flag to set the C Standard level.
158 # gnu89 = c89 plus GCC extensions
159 # c99 = ISO C99 standard (not yet fully implemented)
160 # gnu99 = c99 plus GCC extensions
161 CSTANDARD = -std=gnu99
164 # Place -D or -U options here for C sources
165 CDEFS = -DF_CPU=$(F_CPU)UL
166 CDEFS += -DF_USB=$(F_USB)UL
167 CDEFS += -DBOARD=BOARD_$(BOARD)
168 CDEFS += -DARCH=ARCH_$(ARCH)
169 CDEFS += $(LUFA_OPTS)
172 # Place -D or -U options here for ASM sources
173 ADEFS = -DF_CPU=$(F_CPU)
174 ADEFS += -DF_USB=$(F_USB)UL
175 ADEFS += -DBOARD=BOARD_$(BOARD)
176 ADEFS += -DARCH=ARCH_$(ARCH)
177 ADEFS += $(LUFA_OPTS)
179 # Place -D or -U options here for C++ sources
180 CPPDEFS = -DF_CPU=$(F_CPU)UL
181 CPPDEFS += -DF_USB=$(F_USB)UL
182 CPPDEFS += -DBOARD=BOARD_$(BOARD)
183 CPPDEFS += -DARCH=ARCH_$(ARCH)
184 CPPDEFS += $(LUFA_OPTS)
188 # Native formats for AVR-GCC's -g are dwarf-2 [default] or stabs.
189 # AVR Studio 4.10 requires dwarf-2.
190 # AVR [Extended] COFF format requires stabs, plus an avr-objcopy run.
194 #---------------- Compiler Options C ----------------
195 # -g*: generate debugging information
196 # -O*: optimization level
197 # -f...: tuning, see GCC manual and avr-libc documentation
198 # -Wall...: warning level
199 # -Wa,...: tell GCC to pass this to the assembler.
200 # -adhlns...: create assembler listing
204 CFLAGS += -funsigned-char
205 CFLAGS += -funsigned-bitfields
206 CFLAGS += -ffunction-sections
207 CFLAGS += -fno-inline-small-functions
208 CFLAGS += -fpack-struct
209 CFLAGS += -fshort-enums
210 CFLAGS += -fno-strict-aliasing
212 CFLAGS += -Wstrict-prototypes
213 CFLAGS += -Wa,-adhlns=$(<:%.c=$(OBJDIR)/%.lst)
214 CFLAGS += $(patsubst %,-I%,$(EXTRAINCDIRS))
215 CFLAGS += $(CSTANDARD)
218 #---------------- Compiler Options C++ ----------------
219 # -g*: generate debugging information
220 # -O*: optimization level
221 # -f...: tuning, see GCC manual and avr-libc documentation
222 # -Wall...: warning level
223 # -Wa,...: tell GCC to pass this to the assembler.
224 # -adhlns...: create assembler listing
225 CPPFLAGS = -g$(DEBUG)
226 CPPFLAGS += $(CPPDEFS)
228 CPPFLAGS += -funsigned-char
229 CPPFLAGS += -funsigned-bitfields
230 CPPFLAGS += -fpack-struct
231 CPPFLAGS += -fshort-enums
232 CPPFLAGS += -ffunction-sections
233 CPPFLAGS += -fno-strict-aliasing
234 CPPFLAGS += -fno-exceptions
237 CPPFLAGS += -Wa,-adhlns=$(<:%.cpp=$(OBJDIR)/%.lst)
238 CPPFLAGS += $(patsubst %,-I%,$(EXTRAINCDIRS))
239 #CPPFLAGS += $(CSTANDARD)
242 #---------------- Assembler Options ----------------
243 # -Wa,...: tell GCC to pass this to the assembler.
244 # -adhlns: create listing
245 # -gstabs: have the assembler create line number information; note that
246 # for use in COFF files, additional information about filenames
247 # and function names needs to be present in the assembler source
248 # files -- see avr-libc docs [FIXME: not yet described there]
249 # -listing-cont-lines: Sets the maximum number of continuation lines of hex
250 # dump that will be displayed for a given single line of source input.
251 ASFLAGS = $(ADEFS) -Wa,-adhlns=$(<:%.S=$(OBJDIR)/%.lst),-gstabs,--listing-cont-lines=100
254 #---------------- Library Options ----------------
255 # Minimalistic printf version
256 PRINTF_LIB_MIN = -Wl,-u,vfprintf -lprintf_min
258 # Floating point printf version (requires MATH_LIB = -lm below)
259 PRINTF_LIB_FLOAT = -Wl,-u,vfprintf -lprintf_flt
261 # If this is left blank, then it will use the Standard printf version.
263 #PRINTF_LIB = $(PRINTF_LIB_MIN)
264 #PRINTF_LIB = $(PRINTF_LIB_FLOAT)
267 # Minimalistic scanf version
268 SCANF_LIB_MIN = -Wl,-u,vfscanf -lscanf_min
270 # Floating point + %[ scanf version (requires MATH_LIB = -lm below)
271 SCANF_LIB_FLOAT = -Wl,-u,vfscanf -lscanf_flt
273 # If this is left blank, then it will use the Standard scanf version.
275 #SCANF_LIB = $(SCANF_LIB_MIN)
276 #SCANF_LIB = $(SCANF_LIB_FLOAT)
282 # List any extra directories to look for libraries here.
283 # Each directory must be seperated by a space.
284 # Use forward slashes for directory separators.
285 # For a directory that has spaces, enclose it in quotes.
290 #---------------- External Memory Options ----------------
292 # 64 KB of external RAM, starting after internal RAM (ATmega128!),
293 # used for variables (.data/.bss) and heap (malloc()).
294 #EXTMEMOPTS = -Wl,-Tdata=0x801100,--defsym=__heap_end=0x80ffff
296 # 64 KB of external RAM, starting after internal RAM (ATmega128!),
297 # only used for heap (malloc()).
298 #EXTMEMOPTS = -Wl,--section-start,.data=0x801100,--defsym=__heap_end=0x80ffff
304 #---------------- Linker Options ----------------
305 # -Wl,...: tell GCC to pass this to linker.
306 # -Map: create map file
307 # --cref: add cross reference to map file
308 LDFLAGS = -Wl,-Map=$(TARGET).map,--cref
309 LDFLAGS += -Wl,--relax
310 LDFLAGS += -Wl,--gc-sections
311 LDFLAGS += $(EXTMEMOPTS)
312 LDFLAGS += $(patsubst %,-L%,$(EXTRALIBDIRS))
313 LDFLAGS += $(PRINTF_LIB) $(SCANF_LIB) $(MATH_LIB)
314 #LDFLAGS += -T linker_script.x
318 #---------------- Programming Options (avrdude) ----------------
320 # Programming hardware
322 # to get a full listing.
324 AVRDUDE_PROGRAMMER = jtagmkII
326 # com1 = serial port. Use lpt1 to connect to parallel port.
329 AVRDUDE_WRITE_FLASH = -U flash:w:$(TARGET).hex
330 #AVRDUDE_WRITE_EEPROM = -U eeprom:w:$(TARGET).eep
333 # Uncomment the following if you want avrdude's erase cycle counter.
334 # Note that this counter needs to be initialized first using -Yn,
335 # see avrdude manual.
336 #AVRDUDE_ERASE_COUNTER = -y
338 # Uncomment the following if you do /not/ wish a verification to be
339 # performed after programming the device.
340 #AVRDUDE_NO_VERIFY = -V
342 # Increase verbosity level. Please use this when submitting bug
343 # reports about avrdude. See <http://savannah.nongnu.org/projects/avrdude>
344 # to submit bug reports.
345 #AVRDUDE_VERBOSE = -v -v
347 AVRDUDE_FLAGS = -p $(MCU) -P $(AVRDUDE_PORT) -c $(AVRDUDE_PROGRAMMER)
348 AVRDUDE_FLAGS += $(AVRDUDE_NO_VERIFY)
349 AVRDUDE_FLAGS += $(AVRDUDE_VERBOSE)
350 AVRDUDE_FLAGS += $(AVRDUDE_ERASE_COUNTER)
354 #---------------- Debugging Options ----------------
356 # For simulavr only - target MCU frequency.
357 DEBUG_MFREQ = $(F_CPU)
359 # Set the DEBUG_UI to either gdb or insight.
363 # Set the debugging back-end to either avarice, simulavr.
364 DEBUG_BACKEND = avarice
365 #DEBUG_BACKEND = simulavr
368 GDBINIT_FILE = __avr_gdbinit
370 # When using avarice settings for the JTAG
373 # Debugging port used to communicate between GDB / avarice / simulavr.
376 # Debugging host used to communicate between GDB / avarice / simulavr, normally
377 # just set to localhost unless doing some sort of crazy debugging when
378 # avarice is running on a different computer.
379 DEBUG_HOST = localhost
383 #============================================================================
386 # Define programs and commands.
389 OBJCOPY = avr-objcopy
390 OBJDUMP = avr-objdump
403 MSG_ERRORS_NONE = Errors: none
404 MSG_BEGIN = -------- begin --------
405 MSG_END = -------- end --------
406 MSG_SIZE_BEFORE = Size before:
407 MSG_SIZE_AFTER = Size after:
408 MSG_COFF = Converting to AVR COFF:
409 MSG_EXTENDED_COFF = Converting to AVR Extended COFF:
410 MSG_FLASH = Creating load file for Flash:
411 MSG_EEPROM = Creating load file for EEPROM:
412 MSG_EXTENDED_LISTING = Creating Extended Listing:
413 MSG_SYMBOL_TABLE = Creating Symbol Table:
414 MSG_LINKING = Linking:
415 MSG_COMPILING = Compiling C:
416 MSG_COMPILING_CPP = Compiling C++:
417 MSG_ASSEMBLING = Assembling:
418 MSG_CLEANING = Cleaning project:
419 MSG_CREATING_LIBRARY = Creating library:
424 # Define all object files.
425 OBJ = $(SRC:%.c=$(OBJDIR)/%.o) $(CPPSRC:%.cpp=$(OBJDIR)/%.o) $(ASRC:%.S=$(OBJDIR)/%.o)
427 # Define all listing files.
428 LST = $(SRC:%.c=$(OBJDIR)/%.lst) $(CPPSRC:%.cpp=$(OBJDIR)/%.lst) $(ASRC:%.S=$(OBJDIR)/%.lst)
431 # Compiler flags to generate dependency files.
432 GENDEPFLAGS = -MMD -MP -MF .dep/$(@F).d
435 # Combine all necessary flags and optional flags.
436 # Add target processor to flags.
437 ALL_CFLAGS = -mmcu=$(MCU) -I. $(CFLAGS) $(GENDEPFLAGS)
438 ALL_CPPFLAGS = -mmcu=$(MCU) -I. -x c++ $(CPPFLAGS) $(GENDEPFLAGS)
439 ALL_ASFLAGS = -mmcu=$(MCU) -I. -x assembler-with-cpp $(ASFLAGS)
446 all: begin gccversion sizebefore build sizeafter end
448 # Change the build target to build a HEX file or a library.
449 build: elf hex eep lss sym
458 LIBNAME=lib$(TARGET).a
464 # AVR Studio 3.x does not check make's exit code but relies on
465 # the following magic strings to be generated by the compile job.
475 # Display size of file.
476 HEXSIZE = $(SIZE) --target=$(FORMAT) $(TARGET).hex
477 ELFSIZE = $(SIZE) $(MCU_FLAG) $(FORMAT_FLAG) $(TARGET).elf
478 MCU_FLAG = $(shell $(SIZE) --help | grep -- --mcu > /dev/null && echo --mcu=$(MCU) )
479 FORMAT_FLAG = $(shell $(SIZE) --help | grep -- --format=.*avr > /dev/null && echo --format=avr )
483 @if test -f $(TARGET).elf; then echo; echo $(MSG_SIZE_BEFORE); $(ELFSIZE); \
484 2>/dev/null; echo; fi
487 @if test -f $(TARGET).elf; then echo; echo $(MSG_SIZE_AFTER); $(ELFSIZE); \
488 2>/dev/null; echo; fi
492 # Display compiler version information.
497 # Program the device.
498 program: $(TARGET).hex $(TARGET).eep
499 $(AVRDUDE) $(AVRDUDE_FLAGS) $(AVRDUDE_WRITE_FLASH) $(AVRDUDE_WRITE_EEPROM)
502 batchisp -hardware usb -device $(MCU) -operation erase f
503 batchisp -hardware usb -device $(MCU) -operation loadbuffer $(TARGET).hex program
504 batchisp -hardware usb -device $(MCU) -operation start reset 0
507 dfu-programmer $(MCU) erase
508 dfu-programmer $(MCU) flash $(TARGET).hex
509 dfu-programmer $(MCU) reset
511 flip-ee: $(TARGET).hex $(TARGET).eep
512 $(COPY) $(TARGET).eep $(TARGET)eep.hex
513 batchisp -hardware usb -device $(MCU) -operation memory EEPROM erase
514 batchisp -hardware usb -device $(MCU) -operation memory EEPROM loadbuffer $(TARGET)eep.hex program
515 batchisp -hardware usb -device $(MCU) -operation start reset 0
516 $(REMOVE) $(TARGET)eep.hex
518 dfu-ee: $(TARGET).hex $(TARGET).eep
519 dfu-programmer $(MCU) eeprom-flash $(TARGET).eep
520 dfu-programmer $(MCU) reset
523 # Generate avr-gdb config/init file which does the following:
524 # define the reset signal, load the target file, connect to target, and set
525 # a breakpoint at main().
527 @$(REMOVE) $(GDBINIT_FILE)
528 @echo define reset >> $(GDBINIT_FILE)
529 @echo SIGNAL SIGHUP >> $(GDBINIT_FILE)
530 @echo end >> $(GDBINIT_FILE)
531 @echo file $(TARGET).elf >> $(GDBINIT_FILE)
532 @echo target remote $(DEBUG_HOST):$(DEBUG_PORT) >> $(GDBINIT_FILE)
533 ifeq ($(DEBUG_BACKEND),simulavr)
534 @echo load >> $(GDBINIT_FILE)
536 @echo break main >> $(GDBINIT_FILE)
538 debug: gdb-config $(TARGET).elf
539 ifeq ($(DEBUG_BACKEND), avarice)
540 @echo Starting AVaRICE - Press enter when "waiting to connect" message displays.
541 @$(WINSHELL) /c start avarice --jtag $(JTAG_DEV) --erase --program --file \
542 $(TARGET).elf $(DEBUG_HOST):$(DEBUG_PORT)
543 @$(WINSHELL) /c pause
546 @$(WINSHELL) /c start simulavr --gdbserver --device $(MCU) --clock-freq \
547 $(DEBUG_MFREQ) --port $(DEBUG_PORT)
549 @$(WINSHELL) /c start avr-$(DEBUG_UI) --command=$(GDBINIT_FILE)
554 # Convert ELF to COFF for use in debugging / simulating in AVR Studio or VMLAB.
555 COFFCONVERT = $(OBJCOPY) --debugging
556 COFFCONVERT += --change-section-address .data-0x800000
557 COFFCONVERT += --change-section-address .bss-0x800000
558 COFFCONVERT += --change-section-address .noinit-0x800000
559 COFFCONVERT += --change-section-address .eeprom-0x810000
565 @echo $(MSG_COFF) $(TARGET).cof
566 $(COFFCONVERT) -O coff-avr $< $(TARGET).cof
569 extcoff: $(TARGET).elf
571 @echo $(MSG_EXTENDED_COFF) $(TARGET).cof
572 $(COFFCONVERT) -O coff-ext-avr $< $(TARGET).cof
576 # Create final output files (.hex, .eep) from ELF output file.
579 @echo $(MSG_FLASH) $@
580 $(OBJCOPY) -O $(FORMAT) -R .eeprom -R .fuse -R .lock -R .signature $< $@
584 @echo $(MSG_EEPROM) $@
585 -$(OBJCOPY) -j .eeprom --set-section-flags=.eeprom="alloc,load" \
586 --change-section-lma .eeprom=0 --no-change-warnings -O $(FORMAT) $< $@ || exit 0
588 # Create extended listing file from ELF output file.
591 @echo $(MSG_EXTENDED_LISTING) $@
592 $(OBJDUMP) -h -S -z $< > $@
594 # Create a symbol table from ELF output file.
597 @echo $(MSG_SYMBOL_TABLE) $@
602 # Create library from object files.
603 .SECONDARY : $(TARGET).a
607 @echo $(MSG_CREATING_LIBRARY) $@
611 # Link: create ELF output file from object files.
612 .SECONDARY : $(TARGET).elf
616 @echo $(MSG_LINKING) $@
617 $(CC) $(ALL_CFLAGS) $^ --output $@ $(LDFLAGS)
620 # Compile: create object files from C source files.
623 @echo $(MSG_COMPILING) $<
624 $(CC) -c $(ALL_CFLAGS) $< -o $@
627 # Compile: create object files from C++ source files.
628 $(OBJDIR)/%.o : %.cpp
630 @echo $(MSG_COMPILING_CPP) $<
631 $(CC) -c $(ALL_CPPFLAGS) $< -o $@
634 # Compile: create assembler files from C source files.
636 $(CC) -S $(ALL_CFLAGS) $< -o $@
639 # Compile: create assembler files from C++ source files.
641 $(CC) -S $(ALL_CPPFLAGS) $< -o $@
644 # Assemble: create object files from assembler source files.
647 @echo $(MSG_ASSEMBLING) $<
648 $(CC) -c $(ALL_ASFLAGS) $< -o $@
651 # Create preprocessed source for use in sending a bug report.
653 $(CC) -E -mmcu=$(MCU) -I. $(CFLAGS) $< -o $@
656 # Target: clean project.
657 clean: begin clean_list end
661 @echo $(MSG_CLEANING)
662 $(REMOVE) $(TARGET).hex
663 $(REMOVE) $(TARGET).eep
664 $(REMOVE) $(TARGET).cof
665 $(REMOVE) $(TARGET).elf
666 $(REMOVE) $(TARGET).map
667 $(REMOVE) $(TARGET).sym
668 $(REMOVE) $(TARGET).lss
669 $(REMOVE) $(SRC:%.c=$(OBJDIR)/%.o) $(CPPSRC:%.cpp=$(OBJDIR)/%.o) $(ASRC:%.S=$(OBJDIR)/%.o)
670 $(REMOVE) $(SRC:%.c=$(OBJDIR)/%.lst) $(CPPSRC:%.cpp=$(OBJDIR)/%.lst) $(ASRC:%.S=$(OBJDIR)/%.lst)
671 $(REMOVE) $(SRC:.c=.s)
672 $(REMOVE) $(SRC:.c=.d)
673 $(REMOVE) $(SRC:.c=.i)
677 @echo Generating Project Documentation \($(TARGET)\)...
678 @if ( doxygen Doxygen.conf 2>&1 | grep -v "warning: ignoring unsupported tag" ;); then \
681 @echo Documentation Generation Complete.
687 @for f in $(SRC) $(CPPSRC) $(ASRC); do \
688 if [ -f $$f ]; then \
689 echo "Found Source File: $$f" ; \
691 echo "Source File Not Found: $$f" ; \
695 # Create object files directory
696 $(shell mkdir $(OBJDIR) 2>/dev/null)
699 # Include the dependency files.
700 -include $(shell mkdir .dep 2>/dev/null) $(wildcard .dep/*)
703 # Listing of phony targets.
704 .PHONY : all begin finish end sizebefore sizeafter gccversion \
705 build elf hex eep lss sym coff extcoff doxygen clean \
706 clean_list clean_doxygen program dfu flip flip-ee dfu-ee \
707 debug gdb-config checksource