Fixed tap/down/up handling in dynamic keymap macros (#5363)
[jackhill/qmk/firmware.git] / tmk_core / avr.mk
CommitLineData
4d4f7684 1# Hey Emacs, this is a -*- makefile -*-
2##############################################################################
3# Compiler settings
4#
5CC = avr-gcc
6OBJCOPY = avr-objcopy
7OBJDUMP = avr-objdump
8SIZE = avr-size
9AR = avr-ar rcs
10NM = avr-nm
11HEX = $(OBJCOPY) -O $(FORMAT) -R .eeprom -R .fuse -R .lock -R .signature
c2bec5b3 12EEP = $(OBJCOPY) -j .eeprom --set-section-flags=.eeprom="alloc,load" --change-section-lma .eeprom=0 --no-change-warnings -O $(FORMAT)
f9a6e34c 13BIN =
4d4f7684 14
42d5a324 15COMMON_VPATH += $(DRIVER_PATH)/avr
4d4f7684 16
17COMPILEFLAGS += -funsigned-char
18COMPILEFLAGS += -funsigned-bitfields
19COMPILEFLAGS += -ffunction-sections
20COMPILEFLAGS += -fdata-sections
21COMPILEFLAGS += -fpack-struct
22COMPILEFLAGS += -fshort-enums
23
24CFLAGS += $(COMPILEFLAGS)
25CFLAGS += -fno-inline-small-functions
26CFLAGS += -fno-strict-aliasing
27
28CPPFLAGS += $(COMPILEFLAGS)
901f29e3 29CPPFLAGS += -fno-exceptions -std=c++11
4d4f7684 30
31LDFLAGS +=-Wl,--gc-sections
32
33OPT_DEFS += -DF_CPU=$(F_CPU)UL
34
35MCUFLAGS = -mmcu=$(MCU)
36
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.
41EXTRALIBDIRS =
42
43
44#---------------- External Memory Options ----------------
45
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
49
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
53
54EXTMEMOPTS =
55
56#---------------- Debugging Options ----------------
57
58# Debugging format.
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.
62DEBUG = dwarf-2
63
64# For simulavr only - target MCU frequency.
65DEBUG_MFREQ = $(F_CPU)
66
67# Set the DEBUG_UI to either gdb or insight.
68# DEBUG_UI = gdb
69DEBUG_UI = insight
70
71# Set the debugging back-end to either avarice, simulavr.
72DEBUG_BACKEND = avarice
73#DEBUG_BACKEND = simulavr
74
75# GDB Init Filename.
76GDBINIT_FILE = __avr_gdbinit
77
78# When using avarice settings for the JTAG
79JTAG_DEV = /dev/com1
80
81# Debugging port used to communicate between GDB / avarice / simulavr.
82DEBUG_PORT = 4242
83
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.
87DEBUG_HOST = localhost
88
89#============================================================================
ba405cfb
FS
90# Autodetect teensy loader
91ifndef TEENSY_LOADER_CLI
92 ifneq (, $(shell which teensy-loader-cli 2>/dev/null))
93 TEENSY_LOADER_CLI ?= teensy-loader-cli
94 else
95 TEENSY_LOADER_CLI ?= teensy_loader_cli
96 endif
4d4f7684 97endif
98
fe56fffe
JH
99# Generate a .qmk for the QMK-FF
100qmk: $(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; \
107 fi
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; \
110 fi
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; \
113 fi
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; \
116 fi
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; \
119 fi
120 zip $(TARGET).qmk -urj $(BUILD_DIR)/$(TARGET).json
121 printf "@ $(TARGET).json\n@=info.json\n" | zipnote -w $(TARGET).qmk
122
4d4f7684 123# Program the device.
9fdc2762 124program: $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).eep check-size
4d4f7684 125 $(PROGRAM_CMD)
126
c2bec5b3 127teensy: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
4d4f7684 128 $(TEENSY_LOADER_CLI) -mmcu=$(MCU) -w -v $(BUILD_DIR)/$(TARGET).hex
c2bec5b3
L
129
130BATCHISP ?= batchisp
4d4f7684 131
9fdc2762 132flip: $(BUILD_DIR)/$(TARGET).hex check-size
18b4d24c
FS
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
c2bec5b3 136
18b4d24c 137DFU_PROGRAMMER ?= dfu-programmer
19a1fbac 138GREP ?= grep
4d4f7684 139
9bfaf667 140dfu: $(BUILD_DIR)/$(TARGET).hex cpfirmware check-size
18b4d24c 141 until $(DFU_PROGRAMMER) $(MCU) get bootloader-version; do\
0b8c448b
TLM
142 echo "Error: Bootloader not found. Trying again in 5s." ;\
143 sleep 5 ;\
144 done
19a1fbac 145 if $(DFU_PROGRAMMER) --version 2>&1 | $(GREP) -q 0.7 ; then\
7ea8753b
FS
146 $(DFU_PROGRAMMER) $(MCU) erase --force;\
147 else\
148 $(DFU_PROGRAMMER) $(MCU) erase;\
149 fi
18b4d24c
FS
150 $(DFU_PROGRAMMER) $(MCU) flash $(BUILD_DIR)/$(TARGET).hex
151 $(DFU_PROGRAMMER) $(MCU) reset
4d4f7684 152
153dfu-start:
18b4d24c
FS
154 $(DFU_PROGRAMMER) $(MCU) reset
155 $(DFU_PROGRAMMER) $(MCU) start
4d4f7684 156
157flip-ee: $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).eep
158 $(COPY) $(BUILD_DIR)/$(TARGET).eep $(BUILD_DIR)/$(TARGET)eep.hex
18b4d24c
FS
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
4d4f7684 162 $(REMOVE) $(BUILD_DIR)/$(TARGET)eep.hex
163
164dfu-ee: $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).eep
19a1fbac 165 if $(DFU_PROGRAMMER) --version 2>&1 | $(GREP) -q 0.7 ; then\
7ea8753b
FS
166 $(DFU_PROGRAMMER) $(MCU) flash --eeprom $(BUILD_DIR)/$(TARGET).eep;\
167 else\
168 $(DFU_PROGRAMMER) $(MCU) flash-eeprom $(BUILD_DIR)/$(TARGET).eep;\
169 fi
18b4d24c 170 $(DFU_PROGRAMMER) $(MCU) reset
4d4f7684 171
4f1f52b5
DJ
172dfu-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." ;\
175 sleep 5 ;\
176 done
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;\
180 else\
181 $(DFU_PROGRAMMER) $(MCU) erase;\
182 $(DFU_PROGRAMMER) $(MCU) flash-eeprom $(QUANTUM_PATH)/split_common/eeprom-lefthand.eep;\
183 fi
184 $(DFU_PROGRAMMER) $(MCU) flash $(BUILD_DIR)/$(TARGET).hex
185 $(DFU_PROGRAMMER) $(MCU) reset
186
187dfu-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." ;\
190 sleep 5 ;\
191 done
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;\
195 else\
196 $(DFU_PROGRAMMER) $(MCU) erase;\
afdc6718 197 $(DFU_PROGRAMMER) $(MCU) flash-eeprom $(QUANTUM_PATH)/split_common/eeprom-righthand.eep;\
4f1f52b5
DJ
198 fi
199 $(DFU_PROGRAMMER) $(MCU) flash $(BUILD_DIR)/$(TARGET).hex
200 $(DFU_PROGRAMMER) $(MCU) reset
201
baebbc09
TI
202define EXEC_AVRDUDE
203 USB= ;\
19a1fbac 204 if $(GREP) -q -s Microsoft /proc/version; then \
0f5928fd 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.'; \
71d1c02a 206 else \
c5d81a84 207 printf "Detecting USB port, reset your controller now."; \
71d1c02a 208 ls /dev/tty* > /tmp/1; \
71d1c02a 209 while [ -z $$USB ]; do \
361810dc 210 sleep 0.5; \
c5d81a84 211 printf "."; \
71d1c02a 212 ls /dev/tty* > /tmp/2; \
19a1fbac 213 USB=`comm -13 /tmp/1 /tmp/2 | $(GREP) -o '/dev/tty.*'`; \
361810dc 214 mv /tmp/2 /tmp/1; \
71d1c02a
DN
215 done; \
216 echo ""; \
f34244a8 217 echo "Device $$USB has appeared; assuming it is the controller."; \
19a1fbac 218 if $(GREP) -q -s 'MINGW\|MSYS' /proc/version; then \
524053e3
D
219 USB=`echo "$$USB" | perl -pne 's/\/dev\/ttyS(\d+)/COM.($$1+1)/e'`; \
220 echo "Remapped MSYS2 USB port to $$USB"; \
f34244a8
ML
221 sleep 1; \
222 else \
223 printf "Waiting for $$USB to become writable."; \
224 while [ ! -w "$$USB" ]; do sleep 0.5; printf "."; done; echo ""; \
524053e3 225 fi; \
3c257c1c
D
226 if [ -z "$(1)" ]; then \
227 avrdude -p $(MCU) -c avr109 -P $$USB -U flash:w:$(BUILD_DIR)/$(TARGET).hex; \
228 else \
229 avrdude -p $(MCU) -c avr109 -P $$USB -U flash:w:$(BUILD_DIR)/$(TARGET).hex -U eeprom:w:$(QUANTUM_PATH)/split_common/$(1); \
230 fi \
71d1c02a 231 fi
baebbc09
TI
232endef
233
234avrdude: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
235 $(call EXEC_AVRDUDE)
236
237avrdude-loop: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
238 while true; do \
3c257c1c 239 $(call EXEC_AVRDUDE) ; \
baebbc09 240 done
e0caf943 241
3c257c1c
D
242avrdude-split-left: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
243 $(call EXEC_AVRDUDE,eeprom-lefthand.eep)
244
245avrdude-split-right: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
246 $(call EXEC_AVRDUDE,eeprom-righthand.eep)
247
677b8976
JH
248# Convert hex to bin.
249bin: $(BUILD_DIR)/$(TARGET).hex
250 $(OBJCOPY) -Iihex -Obinary $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).bin
251 $(COPY) $(BUILD_DIR)/$(TARGET).bin $(TARGET).bin;
252
ba2ad57c
JH
253# copy bin to FLASH.bin
254flashbin: bin
c2bec5b3 255 $(COPY) $(BUILD_DIR)/$(TARGET).bin FLASH.bin;
4d4f7684 256
257# Generate avr-gdb config/init file which does the following:
258# define the reset signal, load the target file, connect to target, and set
259# a breakpoint at main().
260gdb-config:
261 @$(REMOVE) $(GDBINIT_FILE)
262 @echo define reset >> $(GDBINIT_FILE)
263 @echo SIGNAL SIGHUP >> $(GDBINIT_FILE)
264 @echo end >> $(GDBINIT_FILE)
265 @echo file $(BUILD_DIR)/$(TARGET).elf >> $(GDBINIT_FILE)
266 @echo target remote $(DEBUG_HOST):$(DEBUG_PORT) >> $(GDBINIT_FILE)
267ifeq ($(DEBUG_BACKEND),simulavr)
268 @echo load >> $(GDBINIT_FILE)
269endif
270 @echo break main >> $(GDBINIT_FILE)
271
272debug: gdb-config $(BUILD_DIR)/$(TARGET).elf
273ifeq ($(DEBUG_BACKEND), avarice)
274 @echo Starting AVaRICE - Press enter when "waiting to connect" message displays.
275 @$(WINSHELL) /c start avarice --jtag $(JTAG_DEV) --erase --program --file \
276 $(BUILD_DIR)/$(TARGET).elf $(DEBUG_HOST):$(DEBUG_PORT)
277 @$(WINSHELL) /c pause
278
279else
280 @$(WINSHELL) /c start simulavr --gdbserver --device $(MCU) --clock-freq \
281 $(DEBUG_MFREQ) --port $(DEBUG_PORT)
282endif
283 @$(WINSHELL) /c start avr-$(DEBUG_UI) --command=$(GDBINIT_FILE)
284
285
286
287
288# Convert ELF to COFF for use in debugging / simulating in AVR Studio or VMLAB.
289COFFCONVERT = $(OBJCOPY) --debugging
290COFFCONVERT += --change-section-address .data-0x800000
291COFFCONVERT += --change-section-address .bss-0x800000
292COFFCONVERT += --change-section-address .noinit-0x800000
293COFFCONVERT += --change-section-address .eeprom-0x810000
294
295
296
297coff: $(BUILD_DIR)/$(TARGET).elf
298 @$(SECHO) $(MSG_COFF) $(BUILD_DIR)/$(TARGET).cof
299 $(COFFCONVERT) -O coff-avr $< $(BUILD_DIR)/$(TARGET).cof
300
301
302extcoff: $(BUILD_DIR)/$(TARGET).elf
303 @$(SECHO) $(MSG_EXTENDED_COFF) $(BUILD_DIR)/$(TARGET).cof
304 $(COFFCONVERT) -O coff-ext-avr $< $(BUILD_DIR)/$(TARGET).cof
305
c2bec5b3 306bootloader:
ec3e065f 307 make -C lib/lufa/Bootloaders/DFU/ clean
149015e7 308 $(TMK_DIR)/make_dfu_header.sh $(ALL_CONFIGS)
ec3e065f 309 make -C lib/lufa/Bootloaders/DFU/
b5d6c049 310 printf "BootloaderDFU.hex copied to $(TARGET)_bootloader.hex\n"
ec3e065f
JH
311 cp lib/lufa/Bootloaders/DFU/BootloaderDFU.hex $(TARGET)_bootloader.hex
312
c2bec5b3 313production: $(BUILD_DIR)/$(TARGET).hex bootloader cpfirmware
ec3e065f
JH
314 @cat $(BUILD_DIR)/$(TARGET).hex | awk '/^:00000001FF/ == 0' > $(TARGET)_production.hex
315 @cat $(TARGET)_bootloader.hex >> $(TARGET)_production.hex
316 echo "File sizes:"
317 $(SIZE) $(TARGET).hex $(TARGET)_bootloader.hex $(TARGET)_production.hex