1 # Hey Emacs, this is a -*- makefile -*-
2 ##############################################################################
11 HEX = $(OBJCOPY) -O $(FORMAT) -R .eeprom -R .fuse -R .lock -R .signature
12 EEP = $(OBJCOPY) -j .eeprom --set-section-flags=.eeprom="alloc,load" --change-section-lma .eeprom=0 --no-change-warnings -O $(FORMAT)
15 COMMON_VPATH += $(DRIVER_PATH)/avr
17 COMPILEFLAGS += -funsigned-char
18 COMPILEFLAGS += -funsigned-bitfields
19 COMPILEFLAGS += -ffunction-sections
20 COMPILEFLAGS += -fdata-sections
21 COMPILEFLAGS += -fpack-struct
22 COMPILEFLAGS += -fshort-enums
24 CFLAGS += $(COMPILEFLAGS)
25 CFLAGS += -fno-inline-small-functions
26 CFLAGS += -fno-strict-aliasing
28 CPPFLAGS += $(COMPILEFLAGS)
29 CPPFLAGS += -fno-exceptions -std=c++11
31 LDFLAGS +=-Wl,--gc-sections
33 OPT_DEFS += -DF_CPU=$(F_CPU)UL
35 MCUFLAGS = -mmcu=$(MCU)
37 # List any extra directories to look for libraries here.
38 # Each directory must be seperated by a space.
39 # Use forward slashes for directory separators.
40 # For a directory that has spaces, enclose it in quotes.
44 #---------------- External Memory Options ----------------
46 # 64 KB of external RAM, starting after internal RAM (ATmega128!),
47 # used for variables (.data/.bss) and heap (malloc()).
48 #EXTMEMOPTS = -Wl,-Tdata=0x801100,--defsym=__heap_end=0x80ffff
50 # 64 KB of external RAM, starting after internal RAM (ATmega128!),
51 # only used for heap (malloc()).
52 #EXTMEMOPTS = -Wl,--section-start,.data=0x801100,--defsym=__heap_end=0x80ffff
56 #---------------- Debugging Options ----------------
59 # Native formats for AVR-GCC's -g are dwarf-2 [default] or stabs.
60 # AVR Studio 4.10 requires dwarf-2.
61 # AVR [Extended] COFF format requires stabs, plus an avr-objcopy run.
64 # For simulavr only - target MCU frequency.
65 DEBUG_MFREQ = $(F_CPU)
67 # Set the DEBUG_UI to either gdb or insight.
71 # Set the debugging back-end to either avarice, simulavr.
72 DEBUG_BACKEND = avarice
73 #DEBUG_BACKEND = simulavr
76 GDBINIT_FILE = __avr_gdbinit
78 # When using avarice settings for the JTAG
81 # Debugging port used to communicate between GDB / avarice / simulavr.
84 # Debugging host used to communicate between GDB / avarice / simulavr, normally
85 # just set to localhost unless doing some sort of crazy debugging when
86 # avarice is running on a different computer.
87 DEBUG_HOST = localhost
89 #============================================================================
90 # Autodetect teensy loader
91 ifndef TEENSY_LOADER_CLI
92 ifneq (, $(shell which teensy-loader-cli 2>/dev/null))
93 TEENSY_LOADER_CLI ?= teensy-loader-cli
95 TEENSY_LOADER_CLI ?= teensy_loader_cli
99 # Generate a .qmk for the QMK-FF
100 qmk: $(BUILD_DIR)/$(TARGET).hex
101 zip $(TARGET).qmk -FSrj $(KEYMAP_PATH)/*
102 zip $(TARGET).qmk -u $<
103 printf "@ $<\n@=firmware.hex\n" | zipnote -w $(TARGET).qmk
104 printf "{\n \"generated\": \"%s\"\n}" "$$(date)" > $(BUILD_DIR)/$(TARGET).json
105 if [ -f $(KEYBOARD_PATH_5)/info.json ]; then \
106 jq -s '.[0] * .[1]' $(BUILD_DIR)/$(TARGET).json $(KEYBOARD_PATH_5)/info.json | ex -sc 'wq!$(BUILD_DIR)/$(TARGET).json' /dev/stdin; \
108 if [ -f $(KEYBOARD_PATH_4)/info.json ]; then \
109 jq -s '.[0] * .[1]' $(BUILD_DIR)/$(TARGET).json $(KEYBOARD_PATH_4)/info.json | ex -sc 'wq!$(BUILD_DIR)/$(TARGET).json' /dev/stdin; \
111 if [ -f $(KEYBOARD_PATH_3)/info.json ]; then \
112 jq -s '.[0] * .[1]' $(BUILD_DIR)/$(TARGET).json $(KEYBOARD_PATH_3)/info.json | ex -sc 'wq!$(BUILD_DIR)/$(TARGET).json' /dev/stdin; \
114 if [ -f $(KEYBOARD_PATH_2)/info.json ]; then \
115 jq -s '.[0] * .[1]' $(BUILD_DIR)/$(TARGET).json $(KEYBOARD_PATH_2)/info.json | ex -sc 'wq!$(BUILD_DIR)/$(TARGET).json' /dev/stdin; \
117 if [ -f $(KEYBOARD_PATH_1)/info.json ]; then \
118 jq -s '.[0] * .[1]' $(BUILD_DIR)/$(TARGET).json $(KEYBOARD_PATH_1)/info.json | ex -sc 'wq!$(BUILD_DIR)/$(TARGET).json' /dev/stdin; \
120 zip $(TARGET).qmk -urj $(BUILD_DIR)/$(TARGET).json
121 printf "@ $(TARGET).json\n@=info.json\n" | zipnote -w $(TARGET).qmk
123 # Program the device.
124 program: $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).eep check-size
127 teensy: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
128 $(TEENSY_LOADER_CLI) -mmcu=$(MCU) -w -v $(BUILD_DIR)/$(TARGET).hex
132 flip: $(BUILD_DIR)/$(TARGET).hex check-size
133 $(BATCHISP) -hardware usb -device $(MCU) -operation erase f
134 $(BATCHISP) -hardware usb -device $(MCU) -operation loadbuffer $(BUILD_DIR)/$(TARGET).hex program
135 $(BATCHISP) -hardware usb -device $(MCU) -operation start reset 0
137 DFU_PROGRAMMER ?= dfu-programmer
140 dfu: $(BUILD_DIR)/$(TARGET).hex cpfirmware check-size
141 until $(DFU_PROGRAMMER) $(MCU) get bootloader-version; do\
142 echo "Error: Bootloader not found. Trying again in 5s." ;\
145 if $(DFU_PROGRAMMER) --version 2>&1 | $(GREP) -q 0.7 ; then\
146 $(DFU_PROGRAMMER) $(MCU) erase --force;\
148 $(DFU_PROGRAMMER) $(MCU) erase;\
150 $(DFU_PROGRAMMER) $(MCU) flash $(BUILD_DIR)/$(TARGET).hex
151 $(DFU_PROGRAMMER) $(MCU) reset
154 $(DFU_PROGRAMMER) $(MCU) reset
155 $(DFU_PROGRAMMER) $(MCU) start
157 flip-ee: $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).eep
158 $(COPY) $(BUILD_DIR)/$(TARGET).eep $(BUILD_DIR)/$(TARGET)eep.hex
159 $(BATCHISP) -hardware usb -device $(MCU) -operation memory EEPROM erase
160 $(BATCHISP) -hardware usb -device $(MCU) -operation memory EEPROM loadbuffer $(BUILD_DIR)/$(TARGET)eep.hex program
161 $(BATCHISP) -hardware usb -device $(MCU) -operation start reset 0
162 $(REMOVE) $(BUILD_DIR)/$(TARGET)eep.hex
164 dfu-ee: $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).eep
165 if $(DFU_PROGRAMMER) --version 2>&1 | $(GREP) -q 0.7 ; then\
166 $(DFU_PROGRAMMER) $(MCU) flash --eeprom $(BUILD_DIR)/$(TARGET).eep;\
168 $(DFU_PROGRAMMER) $(MCU) flash-eeprom $(BUILD_DIR)/$(TARGET).eep;\
170 $(DFU_PROGRAMMER) $(MCU) reset
172 dfu-split-left: $(BUILD_DIR)/$(TARGET).hex cpfirmware check-size
173 until $(DFU_PROGRAMMER) $(MCU) get bootloader-version; do\
174 echo "Error: Bootloader not found. Trying again in 5s." ;\
177 if $(DFU_PROGRAMMER) --version 2>&1 | $(GREP) -q 0.7 ; then\
178 $(DFU_PROGRAMMER) $(MCU) erase --force;\
179 $(DFU_PROGRAMMER) $(MCU) flash --eeprom $(QUANTUM_PATH)/split_common/eeprom-lefthand.eep;\
181 $(DFU_PROGRAMMER) $(MCU) erase;\
182 $(DFU_PROGRAMMER) $(MCU) flash-eeprom $(QUANTUM_PATH)/split_common/eeprom-lefthand.eep;\
184 $(DFU_PROGRAMMER) $(MCU) flash $(BUILD_DIR)/$(TARGET).hex
185 $(DFU_PROGRAMMER) $(MCU) reset
187 dfu-split-right: $(BUILD_DIR)/$(TARGET).hex cpfirmware check-size
188 until $(DFU_PROGRAMMER) $(MCU) get bootloader-version; do\
189 echo "Error: Bootloader not found. Trying again in 5s." ;\
192 if $(DFU_PROGRAMMER) --version 2>&1 | $(GREP) -q 0.7 ; then\
193 $(DFU_PROGRAMMER) $(MCU) erase --force;\
194 $(DFU_PROGRAMMER) $(MCU) flash --eeprom $(QUANTUM_PATH)/split_common/eeprom-righthand.eep;\
196 $(DFU_PROGRAMMER) $(MCU) erase;\
197 $(DFU_PROGRAMMER) $(MCU) flash-eeprom $(QUANTUM_PATH)/split_common/eeprom-rightand.eep;\
199 $(DFU_PROGRAMMER) $(MCU) flash $(BUILD_DIR)/$(TARGET).hex
200 $(DFU_PROGRAMMER) $(MCU) reset
204 if $(GREP) -q -s Microsoft /proc/version; then \
205 echo 'ERROR: AVR flashing cannot be automated within the Windows Subsystem for Linux (WSL) currently. Instead, take the .hex file generated and flash it using AVRDUDE, AVRDUDESS, or XLoader.'; \
207 printf "Detecting USB port, reset your controller now."; \
208 ls /dev/tty* > /tmp/1; \
209 while [ -z $$USB ]; do \
212 ls /dev/tty* > /tmp/2; \
213 USB=`comm -13 /tmp/1 /tmp/2 | $(GREP) -o '/dev/tty.*'`; \
217 echo "Detected controller on USB port at $$USB"; \
218 if $(GREP) -q -s 'MINGW\|MSYS' /proc/version; then \
219 USB=`echo "$$USB" | perl -pne 's/\/dev\/ttyS(\d+)/COM.($$1+1)/e'`; \
220 echo "Remapped MSYS2 USB port to $$USB"; \
223 avrdude -p $(MCU) -c avr109 -P $$USB -U flash:w:$(BUILD_DIR)/$(TARGET).hex; \
227 avrdude: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
230 avrdude-loop: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
232 $(call EXEC_AVRDUDE) ; \
235 # Convert hex to bin.
236 bin: $(BUILD_DIR)/$(TARGET).hex
237 $(OBJCOPY) -Iihex -Obinary $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).bin
238 $(COPY) $(BUILD_DIR)/$(TARGET).bin $(TARGET).bin;
240 # copy bin to FLASH.bin
242 $(COPY) $(BUILD_DIR)/$(TARGET).bin FLASH.bin;
244 # Generate avr-gdb config/init file which does the following:
245 # define the reset signal, load the target file, connect to target, and set
246 # a breakpoint at main().
248 @$(REMOVE) $(GDBINIT_FILE)
249 @echo define reset >> $(GDBINIT_FILE)
250 @echo SIGNAL SIGHUP >> $(GDBINIT_FILE)
251 @echo end >> $(GDBINIT_FILE)
252 @echo file $(BUILD_DIR)/$(TARGET).elf >> $(GDBINIT_FILE)
253 @echo target remote $(DEBUG_HOST):$(DEBUG_PORT) >> $(GDBINIT_FILE)
254 ifeq ($(DEBUG_BACKEND),simulavr)
255 @echo load >> $(GDBINIT_FILE)
257 @echo break main >> $(GDBINIT_FILE)
259 debug: gdb-config $(BUILD_DIR)/$(TARGET).elf
260 ifeq ($(DEBUG_BACKEND), avarice)
261 @echo Starting AVaRICE - Press enter when "waiting to connect" message displays.
262 @$(WINSHELL) /c start avarice --jtag $(JTAG_DEV) --erase --program --file \
263 $(BUILD_DIR)/$(TARGET).elf $(DEBUG_HOST):$(DEBUG_PORT)
264 @$(WINSHELL) /c pause
267 @$(WINSHELL) /c start simulavr --gdbserver --device $(MCU) --clock-freq \
268 $(DEBUG_MFREQ) --port $(DEBUG_PORT)
270 @$(WINSHELL) /c start avr-$(DEBUG_UI) --command=$(GDBINIT_FILE)
275 # Convert ELF to COFF for use in debugging / simulating in AVR Studio or VMLAB.
276 COFFCONVERT = $(OBJCOPY) --debugging
277 COFFCONVERT += --change-section-address .data-0x800000
278 COFFCONVERT += --change-section-address .bss-0x800000
279 COFFCONVERT += --change-section-address .noinit-0x800000
280 COFFCONVERT += --change-section-address .eeprom-0x810000
284 coff: $(BUILD_DIR)/$(TARGET).elf
285 @$(SECHO) $(MSG_COFF) $(BUILD_DIR)/$(TARGET).cof
286 $(COFFCONVERT) -O coff-avr $< $(BUILD_DIR)/$(TARGET).cof
289 extcoff: $(BUILD_DIR)/$(TARGET).elf
290 @$(SECHO) $(MSG_EXTENDED_COFF) $(BUILD_DIR)/$(TARGET).cof
291 $(COFFCONVERT) -O coff-ext-avr $< $(BUILD_DIR)/$(TARGET).cof
294 make -C lib/lufa/Bootloaders/DFU/ clean
295 printf "#ifndef QMK_KEYBOARD\n#define QMK_KEYBOARD\n\n" > lib/lufa/Bootloaders/DFU/Keyboard.h
296 printf "%s\n" "`$(GREP) "MANUFACTURER\s" $(ALL_CONFIGS) -h | tail -1`" >> lib/lufa/Bootloaders/DFU/Keyboard.h
297 printf "%s Bootloader\n" "`$(GREP) "PRODUCT\s" $(ALL_CONFIGS) -h | tail -1 | tr -d '\r'`" >> lib/lufa/Bootloaders/DFU/Keyboard.h
298 printf "%s\n" "`$(GREP) "QMK_ESC_OUTPUT\s" $(ALL_CONFIGS) -h | tail -1`" >> lib/lufa/Bootloaders/DFU/Keyboard.h
299 printf "%s\n" "`$(GREP) "QMK_ESC_INPUT\s" $(ALL_CONFIGS) -h | tail -1`" >> lib/lufa/Bootloaders/DFU/Keyboard.h
300 printf "%s\n" "`$(GREP) "QMK_LED\s" $(ALL_CONFIGS) -h | tail -1`" >> lib/lufa/Bootloaders/DFU/Keyboard.h
301 printf "%s\n" "`$(GREP) "QMK_SPEAKER\s" $(ALL_CONFIGS) -h | tail -1`" >> lib/lufa/Bootloaders/DFU/Keyboard.h
302 printf "\n#endif" >> lib/lufa/Bootloaders/DFU/Keyboard.h
303 make -C lib/lufa/Bootloaders/DFU/
304 printf "BootloaderDFU.hex copied to $(TARGET)_bootloader.hex\n"
305 cp lib/lufa/Bootloaders/DFU/BootloaderDFU.hex $(TARGET)_bootloader.hex
307 production: $(BUILD_DIR)/$(TARGET).hex bootloader cpfirmware
308 @cat $(BUILD_DIR)/$(TARGET).hex | awk '/^:00000001FF/ == 0' > $(TARGET)_production.hex
309 @cat $(TARGET)_bootloader.hex >> $(TARGET)_production.hex
311 $(SIZE) $(TARGET).hex $(TARGET)_bootloader.hex $(TARGET)_production.hex