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 CFLAGS += $(COMPILEFLAGS)
  25 CFLAGS += -fno-inline-small-functions
  26 CFLAGS += -fno-strict-aliasing
  27
  28 CPPFLAGS += $(COMPILEFLAGS)
  29 CPPFLAGS += -fno-exceptions -std=c++11
  30
  31 LDFLAGS +=-Wl,--gc-sections
  32
  33 OPT_DEFS += -DF_CPU=$(F_CPU)UL
  34
  35 MCUFLAGS = -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.
  41 EXTRALIBDIRS =
  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
  54 EXTMEMOPTS =
  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.
  62 DEBUG = dwarf-2
  63
  64 # For simulavr only - target MCU frequency.
  65 DEBUG_MFREQ = $(F_CPU)
  66
  67 # Set the DEBUG_UI to either gdb or insight.
  68 # DEBUG_UI = gdb
  69 DEBUG_UI = insight
  70
  71 # Set the debugging back-end to either avarice, simulavr.
  72 DEBUG_BACKEND = avarice
  73 #DEBUG_BACKEND = simulavr
  74
  75 # GDB Init Filename.
  76 GDBINIT_FILE = __avr_gdbinit
  77
  78 # When using avarice settings for the JTAG
  79 JTAG_DEV = /dev/com1
  80
  81 # Debugging port used to communicate between GDB / avarice / simulavr.
  82 DEBUG_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.
  87 DEBUG_HOST = localhost
  88
  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
  94         else
  95                 TEENSY_LOADER_CLI ?= teensy_loader_cli
  96         endif
  97 endif
  98
  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; \
 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
 123 # Program the device.
 124 program: $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).eep check-size
 125         $(PROGRAM_CMD)
 126
 127 define EXEC_TEENSY
 128         $(TEENSY_LOADER_CLI) -mmcu=$(MCU) -w -v $(BUILD_DIR)/$(TARGET).hex
 129 endef
 130
 131 teensy: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 132         $(call EXEC_TEENSY)
 133
 134 BATCHISP ?= batchisp
 135
 136 flip: $(BUILD_DIR)/$(TARGET).hex check-size
 137         $(BATCHISP) -hardware usb -device $(MCU) -operation erase f
 138         $(BATCHISP) -hardware usb -device $(MCU) -operation loadbuffer $(BUILD_DIR)/$(TARGET).hex program
 139         $(BATCHISP) -hardware usb -device $(MCU) -operation start reset 0
 140
 141 DFU_PROGRAMMER ?= dfu-programmer
 142 GREP ?= grep
 143
 144
 145 define EXEC_DFU
 146         if [ "$(1)" ]; then \
 147                 echo "Flashing '$(1)' for EE_HANDS split keyboard support." ;\
 148         fi; \
 149         until $(DFU_PROGRAMMER) $(MCU) get bootloader-version; do\
 150                 printf "$(MSG_BOOTLOADER_NOT_FOUND)" ;\
 151                 sleep 5 ;\
 152         done; \
 153         if $(DFU_PROGRAMMER) --version 2>&1 | $(GREP) -q 0.7 ; then\
 154                 $(DFU_PROGRAMMER) $(MCU) erase --force; \
 155                 if [ "$(1)" ]; then \
 156                         $(DFU_PROGRAMMER) $(MCU) flash --eeprom $(QUANTUM_PATH)/split_common/$(1);\
 157                 fi; \
 158         else \
 159                 $(DFU_PROGRAMMER) $(MCU) erase; \
 160                 if [ "$(1)" ]; then \
 161                         $(DFU_PROGRAMMER) $(MCU) flash-eeprom $(QUANTUM_PATH)/split_common/$(1);\
 162                 fi; \
 163         fi; \
 164         $(DFU_PROGRAMMER) $(MCU) flash $(BUILD_DIR)/$(TARGET).hex;\
 165         $(DFU_PROGRAMMER) $(MCU) reset
 166 endef
 167
 168 dfu: $(BUILD_DIR)/$(TARGET).hex cpfirmware check-size
 169         $(call EXEC_DFU)
 170
 171 dfu-start:
 172         $(DFU_PROGRAMMER) $(MCU) reset
 173         $(DFU_PROGRAMMER) $(MCU) start
 174
 175 flip-ee: $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).eep
 176         $(COPY) $(BUILD_DIR)/$(TARGET).eep $(BUILD_DIR)/$(TARGET)eep.hex
 177         $(BATCHISP) -hardware usb -device $(MCU) -operation memory EEPROM erase
 178         $(BATCHISP) -hardware usb -device $(MCU) -operation memory EEPROM loadbuffer $(BUILD_DIR)/$(TARGET)eep.hex program
 179         $(BATCHISP) -hardware usb -device $(MCU) -operation start reset 0
 180         $(REMOVE) $(BUILD_DIR)/$(TARGET)eep.hex
 181
 182 dfu-ee: $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).eep
 183         if $(DFU_PROGRAMMER) --version 2>&1 | $(GREP) -q 0.7 ; then\
 184                 $(DFU_PROGRAMMER) $(MCU) flash --eeprom $(BUILD_DIR)/$(TARGET).eep;\
 185         else\
 186                 $(DFU_PROGRAMMER) $(MCU) flash-eeprom $(BUILD_DIR)/$(TARGET).eep;\
 187         fi
 188         $(DFU_PROGRAMMER) $(MCU) reset
 189
 190 dfu-split-left: $(BUILD_DIR)/$(TARGET).hex cpfirmware check-size
 191         $(call EXEC_DFU,eeprom-lefthand.eep)
 192
 193 dfu-split-right: $(BUILD_DIR)/$(TARGET).hex cpfirmware check-size
 194         $(call EXEC_DFU,eeprom-righthand.eep)
 195
 196 define EXEC_AVRDUDE
 197         USB= ;\
 198         if $(GREP) -q -s Microsoft /proc/version; then \
 199                 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.'; \
 200         else \
 201                 printf "Detecting USB port, reset your controller now."; \
 202                 ls /dev/tty* > /tmp/1; \
 203                 while [ -z $$USB ]; do \
 204                         sleep 0.5; \
 205                         printf "."; \
 206                         ls /dev/tty* > /tmp/2; \
 207                         USB=`comm -13 /tmp/1 /tmp/2 | $(GREP) -o '/dev/tty.*'`; \
 208                         mv /tmp/2 /tmp/1; \
 209                 done; \
 210                 echo ""; \
 211                 echo "Device $$USB has appeared; assuming it is the controller."; \
 212                 if $(GREP) -q -s 'MINGW\|MSYS' /proc/version; then \
 213                         USB=`echo "$$USB" | perl -pne 's/\/dev\/ttyS(\d+)/COM.($$1+1)/e'`; \
 214                         echo "Remapped MSYS2 USB port to $$USB"; \
 215                         sleep 1; \
 216                 else \
 217                         printf "Waiting for $$USB to become writable."; \
 218                         while [ ! -w "$$USB" ]; do sleep 0.5; printf "."; done; echo ""; \
 219                 fi; \
 220                 if [ -z "$(1)" ]; then \
 221                         avrdude -p $(MCU) -c avr109 -P $$USB -U flash:w:$(BUILD_DIR)/$(TARGET).hex; \
 222                 else \
 223                         avrdude -p $(MCU) -c avr109 -P $$USB -U flash:w:$(BUILD_DIR)/$(TARGET).hex -U eeprom:w:$(QUANTUM_PATH)/split_common/$(1); \
 224                 fi \
 225         fi
 226 endef
 227
 228 avrdude: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 229         $(call EXEC_AVRDUDE)
 230
 231 avrdude-loop: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 232         while true; do \
 233                 $(call EXEC_AVRDUDE) ; \
 234         done
 235
 236 avrdude-split-left: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 237         $(call EXEC_AVRDUDE,eeprom-lefthand.eep)
 238
 239 avrdude-split-right: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 240         $(call EXEC_AVRDUDE,eeprom-righthand.eep)
 241
 242 define EXEC_USBASP
 243         avrdude -p $(AVRDUDE_MCU) -c usbasp -U flash:w:$(BUILD_DIR)/$(TARGET).hex
 244 endef
 245
 246 usbasp: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 247         $(call EXEC_USBASP)
 248
 249 BOOTLOADHID_PROGRAMMER ?= bootloadHID
 250
 251 define EXEC_BOOTLOADHID
 252         # bootloadHid executable has no cross platform detect methods
 253         # so keep running bootloadHid if the output contains "The specified device was not found"
 254         until $(BOOTLOADHID_PROGRAMMER) -r $(BUILD_DIR)/$(TARGET).hex 2>&1 | tee /dev/stderr | grep -v "device was not found"; do\
 255                 printf "$(MSG_BOOTLOADER_NOT_FOUND)" ;\
 256                 sleep 5 ;\
 257         done
 258 endef
 259
 260 bootloadHID: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 261         $(call EXEC_BOOTLOADHID)
 262
 263 # Convert hex to bin.
 264 bin: $(BUILD_DIR)/$(TARGET).hex
 265         $(OBJCOPY) -Iihex -Obinary $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).bin
 266         $(COPY) $(BUILD_DIR)/$(TARGET).bin $(TARGET).bin;
 267
 268 # copy bin to FLASH.bin
 269 flashbin: bin
 270         $(COPY) $(BUILD_DIR)/$(TARGET).bin FLASH.bin;
 271
 272 # Generate avr-gdb config/init file which does the following:
 273 #     define the reset signal, load the target file, connect to target, and set
 274 #     a breakpoint at main().
 275 gdb-config:
 276         @$(REMOVE) $(GDBINIT_FILE)
 277         @echo define reset >> $(GDBINIT_FILE)
 278         @echo SIGNAL SIGHUP >> $(GDBINIT_FILE)
 279         @echo end >> $(GDBINIT_FILE)
 280         @echo file $(BUILD_DIR)/$(TARGET).elf >> $(GDBINIT_FILE)
 281         @echo target remote $(DEBUG_HOST):$(DEBUG_PORT)  >> $(GDBINIT_FILE)
 282 ifeq ($(DEBUG_BACKEND),simulavr)
 283         @echo load  >> $(GDBINIT_FILE)
 284 endif
 285         @echo break main >> $(GDBINIT_FILE)
 286
 287 debug: gdb-config $(BUILD_DIR)/$(TARGET).elf
 288 ifeq ($(DEBUG_BACKEND), avarice)
 289         @echo Starting AVaRICE - Press enter when "waiting to connect" message displays.
 290         @$(WINSHELL) /c start avarice --jtag $(JTAG_DEV) --erase --program --file \
 291         $(BUILD_DIR)/$(TARGET).elf $(DEBUG_HOST):$(DEBUG_PORT)
 292         @$(WINSHELL) /c pause
 293
 294 else
 295         @$(WINSHELL) /c start simulavr --gdbserver --device $(MCU) --clock-freq \
 296         $(DEBUG_MFREQ) --port $(DEBUG_PORT)
 297 endif
 298         @$(WINSHELL) /c start avr-$(DEBUG_UI) --command=$(GDBINIT_FILE)
 299
 300
 301
 302
 303 # Convert ELF to COFF for use in debugging / simulating in AVR Studio or VMLAB.
 304 COFFCONVERT = $(OBJCOPY) --debugging
 305 COFFCONVERT += --change-section-address .data-0x800000
 306 COFFCONVERT += --change-section-address .bss-0x800000
 307 COFFCONVERT += --change-section-address .noinit-0x800000
 308 COFFCONVERT += --change-section-address .eeprom-0x810000
 309
 310
 311
 312 coff: $(BUILD_DIR)/$(TARGET).elf
 313         @$(SECHO) $(MSG_COFF) $(BUILD_DIR)/$(TARGET).cof
 314         $(COFFCONVERT) -O coff-avr $< $(BUILD_DIR)/$(TARGET).cof
 315
 316
 317 extcoff: $(BUILD_DIR)/$(TARGET).elf
 318         @$(SECHO) $(MSG_EXTENDED_COFF) $(BUILD_DIR)/$(TARGET).cof
 319         $(COFFCONVERT) -O coff-ext-avr $< $(BUILD_DIR)/$(TARGET).cof
 320
 321 bootloader:
 322         make -C lib/lufa/Bootloaders/DFU/ clean
 323         $(TMK_DIR)/make_dfu_header.sh $(ALL_CONFIGS)
 324         $(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))
 325         $(eval PROGRAM_SIZE_KB=$(shell n=`expr $(MAX_SIZE) / 1024` && echo $$(($$n)) || echo 0))
 326         $(eval BOOT_SECTION_SIZE_KB=$(shell n=`expr  $(BOOTLOADER_SIZE) / 1024` && echo $$(($$n)) || echo 0))
 327         $(eval FLASH_SIZE_KB=$(shell n=`expr $(PROGRAM_SIZE_KB) + $(BOOT_SECTION_SIZE_KB)` && echo $$(($$n)) || echo 0))
 328         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)
 329         printf "BootloaderDFU.hex copied to $(TARGET)_bootloader.hex\n"
 330         cp lib/lufa/Bootloaders/DFU/BootloaderDFU.hex $(TARGET)_bootloader.hex
 331
 332 production: $(BUILD_DIR)/$(TARGET).hex bootloader cpfirmware
 333         @cat $(BUILD_DIR)/$(TARGET).hex | awk '/^:00000001FF/ == 0' > $(TARGET)_production.hex
 334         @cat $(TARGET)_bootloader.hex >> $(TARGET)_production.hex
 335         echo "File sizes:"
 336         $(SIZE) $(TARGET).hex $(TARGET)_bootloader.hex $(TARGET)_production.hex
 337
 338 flash:  $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 339 ifeq ($(strip $(BOOTLOADER)), caterina)
 340         $(call EXEC_AVRDUDE)
 341 else ifeq ($(strip $(BOOTLOADER)), halfkay)
 342         $(call EXEC_TEENSY)
 343 else ifeq (dfu,$(findstring dfu,$(BOOTLOADER)))
 344         $(call EXEC_DFU)
 345 else ifeq ($(strip $(BOOTLOADER)), USBasp)
 346         $(call EXEC_USBASP)
 347 else ifeq ($(strip $(BOOTLOADER)), bootloadHID)
 348         $(call EXEC_BOOTLOADHID)
 349 else
 350         $(PRINT_OK); $(SILENT) || printf "$(MSG_FLASH_BOOTLOADER)"
 351 endif