tmk_core/avr.mk

   1 # Hey Emacs, this is a -*- makefile -*-
   2 ##############################################################################
   3 # Compiler settings
   4 #
   5 CC = avr-gcc
   6 OBJCOPY = avr-objcopy
   7 OBJDUMP = avr-objdump
   8 SIZE = avr-size
   9 AR = avr-ar
  10 NM = avr-nm
  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)
  13 BIN =
  14
  15 COMMON_VPATH += $(DRIVER_PATH)/avr
  16
  17 COMPILEFLAGS += -funsigned-char
  18 COMPILEFLAGS += -funsigned-bitfields
  19 COMPILEFLAGS += -ffunction-sections
  20 COMPILEFLAGS += -fdata-sections
  21 COMPILEFLAGS += -fpack-struct
  22 COMPILEFLAGS += -fshort-enums
  23
  24 ASFLAGS += $(AVR_ASFLAGS)
  25
  26 CFLAGS += $(COMPILEFLAGS) $(AVR_CFLAGS)
  27 CFLAGS += -fno-inline-small-functions
  28 CFLAGS += -fno-strict-aliasing
  29
  30 CXXFLAGS += $(COMPILEFLAGS)
  31 CXXFLAGS += -fno-exceptions -std=c++11
  32
  33 LDFLAGS +=-Wl,--gc-sections
  34
  35 OPT_DEFS += -DF_CPU=$(F_CPU)UL
  36
  37 MCUFLAGS = -mmcu=$(MCU)
  38
  39 # List any extra directories to look for libraries here.
  40 #     Each directory must be seperated by a space.
  41 #     Use forward slashes for directory separators.
  42 #     For a directory that has spaces, enclose it in quotes.
  43 EXTRALIBDIRS =
  44
  45
  46 #---------------- External Memory Options ----------------
  47
  48 # 64 KB of external RAM, starting after internal RAM (ATmega128!),
  49 # used for variables (.data/.bss) and heap (malloc()).
  50 #EXTMEMOPTS = -Wl,-Tdata=0x801100,--defsym=__heap_end=0x80ffff
  51
  52 # 64 KB of external RAM, starting after internal RAM (ATmega128!),
  53 # only used for heap (malloc()).
  54 #EXTMEMOPTS = -Wl,--section-start,.data=0x801100,--defsym=__heap_end=0x80ffff
  55
  56 EXTMEMOPTS =
  57
  58 #---------------- Debugging Options ----------------
  59
  60 # Debugging format.
  61 #     Native formats for AVR-GCC's -g are dwarf-2 [default] or stabs.
  62 #     AVR Studio 4.10 requires dwarf-2.
  63 #     AVR [Extended] COFF format requires stabs, plus an avr-objcopy run.
  64 DEBUG = dwarf-2
  65
  66 # For simulavr only - target MCU frequency.
  67 DEBUG_MFREQ = $(F_CPU)
  68
  69 # Set the DEBUG_UI to either gdb or insight.
  70 # DEBUG_UI = gdb
  71 DEBUG_UI = insight
  72
  73 # Set the debugging back-end to either avarice, simulavr.
  74 DEBUG_BACKEND = avarice
  75 #DEBUG_BACKEND = simulavr
  76
  77 # GDB Init Filename.
  78 GDBINIT_FILE = __avr_gdbinit
  79
  80 # When using avarice settings for the JTAG
  81 JTAG_DEV = /dev/com1
  82
  83 # Debugging port used to communicate between GDB / avarice / simulavr.
  84 DEBUG_PORT = 4242
  85
  86 # Debugging host used to communicate between GDB / avarice / simulavr, normally
  87 #     just set to localhost unless doing some sort of crazy debugging when
  88 #     avarice is running on a different computer.
  89 DEBUG_HOST = localhost
  90
  91 #============================================================================
  92 # Autodetect teensy loader
  93 ifndef TEENSY_LOADER_CLI
  94         ifneq (, $(shell which teensy-loader-cli 2>/dev/null))
  95                 TEENSY_LOADER_CLI ?= teensy-loader-cli
  96         else
  97                 TEENSY_LOADER_CLI ?= teensy_loader_cli
  98         endif
  99 endif
 100
 101 # Program the device.
 102 program: $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).eep check-size
 103         $(PROGRAM_CMD)
 104
 105 define EXEC_TEENSY
 106         $(TEENSY_LOADER_CLI) -mmcu=$(MCU) -w -v $(BUILD_DIR)/$(TARGET).hex
 107 endef
 108
 109 teensy: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 110         $(call EXEC_TEENSY)
 111
 112 BATCHISP ?= batchisp
 113
 114 flip: $(BUILD_DIR)/$(TARGET).hex check-size
 115         $(BATCHISP) -hardware usb -device $(MCU) -operation erase f
 116         $(BATCHISP) -hardware usb -device $(MCU) -operation loadbuffer $(BUILD_DIR)/$(TARGET).hex program
 117         $(BATCHISP) -hardware usb -device $(MCU) -operation start reset 0
 118
 119 DFU_PROGRAMMER ?= dfu-programmer
 120 GREP ?= grep
 121
 122
 123 define EXEC_DFU
 124         if [ "$(1)" ]; then \
 125                 echo "Flashing '$(1)' for EE_HANDS split keyboard support." ;\
 126         fi; \
 127         until $(DFU_PROGRAMMER) $(MCU) get bootloader-version; do\
 128                 printf "$(MSG_BOOTLOADER_NOT_FOUND)" ;\
 129                 sleep 5 ;\
 130         done; \
 131         if $(DFU_PROGRAMMER) --version 2>&1 | $(GREP) -q 0.7 ; then\
 132                 $(DFU_PROGRAMMER) $(MCU) erase --force; \
 133                 if [ "$(1)" ]; then \
 134                         $(DFU_PROGRAMMER) $(MCU) flash --eeprom $(QUANTUM_PATH)/split_common/$(1);\
 135                 fi; \
 136         else \
 137                 $(DFU_PROGRAMMER) $(MCU) erase; \
 138                 if [ "$(1)" ]; then \
 139                         $(DFU_PROGRAMMER) $(MCU) flash-eeprom $(QUANTUM_PATH)/split_common/$(1);\
 140                 fi; \
 141         fi; \
 142         $(DFU_PROGRAMMER) $(MCU) flash $(BUILD_DIR)/$(TARGET).hex;\
 143         $(DFU_PROGRAMMER) $(MCU) reset
 144 endef
 145
 146 dfu: $(BUILD_DIR)/$(TARGET).hex cpfirmware check-size
 147         $(call EXEC_DFU)
 148
 149 dfu-start:
 150         $(DFU_PROGRAMMER) $(MCU) reset
 151         $(DFU_PROGRAMMER) $(MCU) start
 152
 153 flip-ee: $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).eep
 154         $(COPY) $(BUILD_DIR)/$(TARGET).eep $(BUILD_DIR)/$(TARGET)eep.hex
 155         $(BATCHISP) -hardware usb -device $(MCU) -operation memory EEPROM erase
 156         $(BATCHISP) -hardware usb -device $(MCU) -operation memory EEPROM loadbuffer $(BUILD_DIR)/$(TARGET)eep.hex program
 157         $(BATCHISP) -hardware usb -device $(MCU) -operation start reset 0
 158         $(REMOVE) $(BUILD_DIR)/$(TARGET)eep.hex
 159
 160 dfu-ee: $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).eep
 161         if $(DFU_PROGRAMMER) --version 2>&1 | $(GREP) -q 0.7 ; then\
 162                 $(DFU_PROGRAMMER) $(MCU) flash --eeprom $(BUILD_DIR)/$(TARGET).eep;\
 163         else\
 164                 $(DFU_PROGRAMMER) $(MCU) flash-eeprom $(BUILD_DIR)/$(TARGET).eep;\
 165         fi
 166         $(DFU_PROGRAMMER) $(MCU) reset
 167
 168 dfu-split-left: $(BUILD_DIR)/$(TARGET).hex cpfirmware check-size
 169         $(call EXEC_DFU,eeprom-lefthand.eep)
 170
 171 dfu-split-right: $(BUILD_DIR)/$(TARGET).hex cpfirmware check-size
 172         $(call EXEC_DFU,eeprom-righthand.eep)
 173
 174 define EXEC_AVRDUDE
 175         USB= ;\
 176         if $(GREP) -q -s Microsoft /proc/version; then \
 177                 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.'; \
 178         else \
 179                 printf "Detecting USB port, reset your controller now."; \
 180                 ls /dev/tty* > /tmp/1; \
 181                 while [ -z $$USB ]; do \
 182                         sleep 0.5; \
 183                         printf "."; \
 184                         ls /dev/tty* > /tmp/2; \
 185                         USB=`comm -13 /tmp/1 /tmp/2 | $(GREP) -o '/dev/tty.*'`; \
 186                         mv /tmp/2 /tmp/1; \
 187                 done; \
 188                 echo ""; \
 189                 echo "Device $$USB has appeared; assuming it is the controller."; \
 190                 if $(GREP) -q -s 'MINGW\|MSYS' /proc/version; then \
 191                         USB=`echo "$$USB" | perl -pne 's/\/dev\/ttyS(\d+)/COM.($$1+1)/e'`; \
 192                         echo "Remapped MSYS2 USB port to $$USB"; \
 193                         sleep 1; \
 194                 else \
 195                         printf "Waiting for $$USB to become writable."; \
 196                         while [ ! -w "$$USB" ]; do sleep 0.5; printf "."; done; echo ""; \
 197                 fi; \
 198                 if [ -z "$(1)" ]; then \
 199                         avrdude -p $(MCU) -c avr109 -P $$USB -U flash:w:$(BUILD_DIR)/$(TARGET).hex; \
 200                 else \
 201                         avrdude -p $(MCU) -c avr109 -P $$USB -U flash:w:$(BUILD_DIR)/$(TARGET).hex -U eeprom:w:$(QUANTUM_PATH)/split_common/$(1); \
 202                 fi \
 203         fi
 204 endef
 205
 206 avrdude: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 207         $(call EXEC_AVRDUDE)
 208
 209 avrdude-loop: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 210         while true; do \
 211                 $(call EXEC_AVRDUDE) ; \
 212         done
 213
 214 avrdude-split-left: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 215         $(call EXEC_AVRDUDE,eeprom-lefthand.eep)
 216
 217 avrdude-split-right: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 218         $(call EXEC_AVRDUDE,eeprom-righthand.eep)
 219
 220 define EXEC_USBASP
 221         avrdude -p $(AVRDUDE_MCU) -c usbasp -U flash:w:$(BUILD_DIR)/$(TARGET).hex
 222 endef
 223
 224 usbasp: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 225         $(call EXEC_USBASP)
 226
 227 BOOTLOADHID_PROGRAMMER ?= bootloadHID
 228
 229 define EXEC_BOOTLOADHID
 230         # bootloadHid executable has no cross platform detect methods
 231         # so keep running bootloadHid if the output contains "The specified device was not found"
 232         until $(BOOTLOADHID_PROGRAMMER) -r $(BUILD_DIR)/$(TARGET).hex 2>&1 | tee /dev/stderr | grep -v "device was not found"; do\
 233                 printf "$(MSG_BOOTLOADER_NOT_FOUND)" ;\
 234                 sleep 5 ;\
 235         done
 236 endef
 237
 238 bootloadHID: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 239         $(call EXEC_BOOTLOADHID)
 240
 241 # Convert hex to bin.
 242 bin: $(BUILD_DIR)/$(TARGET).hex
 243         $(OBJCOPY) -Iihex -Obinary $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).bin
 244         $(COPY) $(BUILD_DIR)/$(TARGET).bin $(TARGET).bin;
 245
 246 # copy bin to FLASH.bin
 247 flashbin: bin
 248         $(COPY) $(BUILD_DIR)/$(TARGET).bin FLASH.bin;
 249
 250 # Generate avr-gdb config/init file which does the following:
 251 #     define the reset signal, load the target file, connect to target, and set
 252 #     a breakpoint at main().
 253 gdb-config:
 254         @$(REMOVE) $(GDBINIT_FILE)
 255         @echo define reset >> $(GDBINIT_FILE)
 256         @echo SIGNAL SIGHUP >> $(GDBINIT_FILE)
 257         @echo end >> $(GDBINIT_FILE)
 258         @echo file $(BUILD_DIR)/$(TARGET).elf >> $(GDBINIT_FILE)
 259         @echo target remote $(DEBUG_HOST):$(DEBUG_PORT)  >> $(GDBINIT_FILE)
 260 ifeq ($(DEBUG_BACKEND),simulavr)
 261         @echo load  >> $(GDBINIT_FILE)
 262 endif
 263         @echo break main >> $(GDBINIT_FILE)
 264
 265 debug: gdb-config $(BUILD_DIR)/$(TARGET).elf
 266 ifeq ($(DEBUG_BACKEND), avarice)
 267         @echo Starting AVaRICE - Press enter when "waiting to connect" message displays.
 268         @$(WINSHELL) /c start avarice --jtag $(JTAG_DEV) --erase --program --file \
 269         $(BUILD_DIR)/$(TARGET).elf $(DEBUG_HOST):$(DEBUG_PORT)
 270         @$(WINSHELL) /c pause
 271
 272 else
 273         @$(WINSHELL) /c start simulavr --gdbserver --device $(MCU) --clock-freq \
 274         $(DEBUG_MFREQ) --port $(DEBUG_PORT)
 275 endif
 276         @$(WINSHELL) /c start avr-$(DEBUG_UI) --command=$(GDBINIT_FILE)
 277
 278
 279
 280
 281 # Convert ELF to COFF for use in debugging / simulating in AVR Studio or VMLAB.
 282 COFFCONVERT = $(OBJCOPY) --debugging
 283 COFFCONVERT += --change-section-address .data-0x800000
 284 COFFCONVERT += --change-section-address .bss-0x800000
 285 COFFCONVERT += --change-section-address .noinit-0x800000
 286 COFFCONVERT += --change-section-address .eeprom-0x810000
 287
 288
 289
 290 coff: $(BUILD_DIR)/$(TARGET).elf
 291         @$(SECHO) $(MSG_COFF) $(BUILD_DIR)/$(TARGET).cof
 292         $(COFFCONVERT) -O coff-avr $< $(BUILD_DIR)/$(TARGET).cof
 293
 294
 295 extcoff: $(BUILD_DIR)/$(TARGET).elf
 296         @$(SECHO) $(MSG_EXTENDED_COFF) $(BUILD_DIR)/$(TARGET).cof
 297         $(COFFCONVERT) -O coff-ext-avr $< $(BUILD_DIR)/$(TARGET).cof
 298
 299 bootloader:
 300         make -C lib/lufa/Bootloaders/DFU/ clean
 301         $(TMK_DIR)/make_dfu_header.sh $(ALL_CONFIGS)
 302         $(eval MAX_SIZE=$(shell n=`$(CC) -E -mmcu=$(MCU) $(CFLAGS) $(OPT_DEFS) tmk_core/common/avr/bootloader_size.c 2> /dev/null | sed -ne 's/\r//;/^#/n;/^AVR_SIZE:/,$${s/^AVR_SIZE: //;p;}'` && echo $$(($$n)) || echo 0))
 303         $(eval PROGRAM_SIZE_KB=$(shell n=`expr $(MAX_SIZE) / 1024` && echo $$(($$n)) || echo 0))
 304         $(eval BOOT_SECTION_SIZE_KB=$(shell n=`expr  $(BOOTLOADER_SIZE) / 1024` && echo $$(($$n)) || echo 0))
 305         $(eval FLASH_SIZE_KB=$(shell n=`expr $(PROGRAM_SIZE_KB) + $(BOOT_SECTION_SIZE_KB)` && echo $$(($$n)) || echo 0))
 306         make -C lib/lufa/Bootloaders/DFU/ MCU=$(MCU) ARCH=$(ARCH) F_CPU=$(F_CPU) FLASH_SIZE_KB=$(FLASH_SIZE_KB) BOOT_SECTION_SIZE_KB=$(BOOT_SECTION_SIZE_KB)
 307         printf "BootloaderDFU.hex copied to $(TARGET)_bootloader.hex\n"
 308         cp lib/lufa/Bootloaders/DFU/BootloaderDFU.hex $(TARGET)_bootloader.hex
 309
 310 production: $(BUILD_DIR)/$(TARGET).hex bootloader cpfirmware
 311         @cat $(BUILD_DIR)/$(TARGET).hex | awk '/^:00000001FF/ == 0' > $(TARGET)_production.hex
 312         @cat $(TARGET)_bootloader.hex >> $(TARGET)_production.hex
 313         echo "File sizes:"
 314         $(SIZE) $(TARGET).hex $(TARGET)_bootloader.hex $(TARGET)_production.hex
 315
 316 flash:  $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 317 ifeq ($(strip $(BOOTLOADER)), caterina)
 318         $(call EXEC_AVRDUDE)
 319 else ifeq ($(strip $(BOOTLOADER)), halfkay)
 320         $(call EXEC_TEENSY)
 321 else ifeq (dfu,$(findstring dfu,$(BOOTLOADER)))
 322         $(call EXEC_DFU)
 323 else ifeq ($(strip $(BOOTLOADER)), USBasp)
 324         $(call EXEC_USBASP)
 325 else ifeq ($(strip $(BOOTLOADER)), bootloadHID)
 326         $(call EXEC_BOOTLOADHID)
 327 else
 328         $(PRINT_OK); $(SILENT) || printf "$(MSG_FLASH_BOOTLOADER)"
 329 endif