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 rcs
  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 teensy: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 128         $(TEENSY_LOADER_CLI) -mmcu=$(MCU) -w -v $(BUILD_DIR)/$(TARGET).hex
 129
 130 BATCHISP ?= batchisp
 131
 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
 136
 137 DFU_PROGRAMMER ?= dfu-programmer
 138 GREP ?= grep
 139
 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." ;\
 143                 sleep 5 ;\
 144         done
 145         if $(DFU_PROGRAMMER) --version 2>&1 | $(GREP) -q 0.7 ; then\
 146                 $(DFU_PROGRAMMER) $(MCU) erase --force;\
 147         else\
 148                 $(DFU_PROGRAMMER) $(MCU) erase;\
 149         fi
 150         $(DFU_PROGRAMMER) $(MCU) flash $(BUILD_DIR)/$(TARGET).hex
 151         $(DFU_PROGRAMMER) $(MCU) reset
 152
 153 dfu-start:
 154         $(DFU_PROGRAMMER) $(MCU) reset
 155         $(DFU_PROGRAMMER) $(MCU) start
 156
 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
 163
 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;\
 167         else\
 168                 $(DFU_PROGRAMMER) $(MCU) flash-eeprom $(BUILD_DIR)/$(TARGET).eep;\
 169         fi
 170         $(DFU_PROGRAMMER) $(MCU) reset
 171
 172 define EXEC_AVRDUDE
 173         USB= ;\
 174         if $(GREP) -q -s Microsoft /proc/version; then \
 175                 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.'; \
 176         else \
 177                 printf "Detecting USB port, reset your controller now."; \
 178                 ls /dev/tty* > /tmp/1; \
 179                 while [ -z $$USB ]; do \
 180                         sleep 0.5; \
 181                         printf "."; \
 182                         ls /dev/tty* > /tmp/2; \
 183                         USB=`comm -13 /tmp/1 /tmp/2 | $(GREP) -o '/dev/tty.*'`; \
 184                         mv /tmp/2 /tmp/1; \
 185                 done; \
 186                 echo ""; \
 187                 echo "Detected controller on USB port at $$USB"; \
 188                 if $(GREP) -q -s 'MINGW\|MSYS' /proc/version; then \
 189                         USB=`echo "$$USB" | perl -pne 's/\/dev\/ttyS(\d+)/COM.($$1+1)/e'`; \
 190                         echo "Remapped MSYS2 USB port to $$USB"; \
 191                 fi; \
 192                 sleep 1; \
 193                 avrdude -p $(MCU) -c avr109 -P $$USB -U flash:w:$(BUILD_DIR)/$(TARGET).hex; \
 194         fi
 195 endef
 196
 197 avrdude: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 198         $(call EXEC_AVRDUDE)
 199
 200 avrdude-loop: $(BUILD_DIR)/$(TARGET).hex check-size cpfirmware
 201         while true; do \
 202             $(call EXEC_AVRDUDE) ; \
 203         done
 204
 205 # Convert hex to bin.
 206 bin: $(BUILD_DIR)/$(TARGET).hex
 207         $(OBJCOPY) -Iihex -Obinary $(BUILD_DIR)/$(TARGET).hex $(BUILD_DIR)/$(TARGET).bin
 208         $(COPY) $(BUILD_DIR)/$(TARGET).bin $(TARGET).bin;
 209
 210 # copy bin to FLASH.bin
 211 flashbin: bin
 212         $(COPY) $(BUILD_DIR)/$(TARGET).bin FLASH.bin;
 213
 214 # Generate avr-gdb config/init file which does the following:
 215 #     define the reset signal, load the target file, connect to target, and set
 216 #     a breakpoint at main().
 217 gdb-config:
 218         @$(REMOVE) $(GDBINIT_FILE)
 219         @echo define reset >> $(GDBINIT_FILE)
 220         @echo SIGNAL SIGHUP >> $(GDBINIT_FILE)
 221         @echo end >> $(GDBINIT_FILE)
 222         @echo file $(BUILD_DIR)/$(TARGET).elf >> $(GDBINIT_FILE)
 223         @echo target remote $(DEBUG_HOST):$(DEBUG_PORT)  >> $(GDBINIT_FILE)
 224 ifeq ($(DEBUG_BACKEND),simulavr)
 225         @echo load  >> $(GDBINIT_FILE)
 226 endif
 227         @echo break main >> $(GDBINIT_FILE)
 228
 229 debug: gdb-config $(BUILD_DIR)/$(TARGET).elf
 230 ifeq ($(DEBUG_BACKEND), avarice)
 231         @echo Starting AVaRICE - Press enter when "waiting to connect" message displays.
 232         @$(WINSHELL) /c start avarice --jtag $(JTAG_DEV) --erase --program --file \
 233         $(BUILD_DIR)/$(TARGET).elf $(DEBUG_HOST):$(DEBUG_PORT)
 234         @$(WINSHELL) /c pause
 235
 236 else
 237         @$(WINSHELL) /c start simulavr --gdbserver --device $(MCU) --clock-freq \
 238         $(DEBUG_MFREQ) --port $(DEBUG_PORT)
 239 endif
 240         @$(WINSHELL) /c start avr-$(DEBUG_UI) --command=$(GDBINIT_FILE)
 241
 242
 243
 244
 245 # Convert ELF to COFF for use in debugging / simulating in AVR Studio or VMLAB.
 246 COFFCONVERT = $(OBJCOPY) --debugging
 247 COFFCONVERT += --change-section-address .data-0x800000
 248 COFFCONVERT += --change-section-address .bss-0x800000
 249 COFFCONVERT += --change-section-address .noinit-0x800000
 250 COFFCONVERT += --change-section-address .eeprom-0x810000
 251
 252
 253
 254 coff: $(BUILD_DIR)/$(TARGET).elf
 255         @$(SECHO) $(MSG_COFF) $(BUILD_DIR)/$(TARGET).cof
 256         $(COFFCONVERT) -O coff-avr $< $(BUILD_DIR)/$(TARGET).cof
 257
 258
 259 extcoff: $(BUILD_DIR)/$(TARGET).elf
 260         @$(SECHO) $(MSG_EXTENDED_COFF) $(BUILD_DIR)/$(TARGET).cof
 261         $(COFFCONVERT) -O coff-ext-avr $< $(BUILD_DIR)/$(TARGET).cof
 262
 263 bootloader:
 264         make -C lib/lufa/Bootloaders/DFU/ clean
 265         printf "#ifndef QMK_KEYBOARD\n#define QMK_KEYBOARD\n\n" > lib/lufa/Bootloaders/DFU/Keyboard.h
 266         printf "%s\n" "`$(GREP) "MANUFACTURER\s" $(ALL_CONFIGS) -h | tail -1`" >> lib/lufa/Bootloaders/DFU/Keyboard.h
 267         printf "%s Bootloader\n" "`$(GREP) "PRODUCT\s" $(ALL_CONFIGS) -h | tail -1 | tr -d '\r'`" >> lib/lufa/Bootloaders/DFU/Keyboard.h
 268         printf "%s\n" "`$(GREP) "QMK_ESC_OUTPUT\s" $(ALL_CONFIGS) -h | tail -1`" >> lib/lufa/Bootloaders/DFU/Keyboard.h
 269         printf "%s\n" "`$(GREP) "QMK_ESC_INPUT\s" $(ALL_CONFIGS) -h | tail -1`" >> lib/lufa/Bootloaders/DFU/Keyboard.h
 270         printf "%s\n" "`$(GREP) "QMK_LED\s" $(ALL_CONFIGS) -h | tail -1`" >> lib/lufa/Bootloaders/DFU/Keyboard.h
 271         printf "%s\n" "`$(GREP) "QMK_SPEAKER\s" $(ALL_CONFIGS) -h | tail -1`" >> lib/lufa/Bootloaders/DFU/Keyboard.h
 272         printf "\n#endif" >> lib/lufa/Bootloaders/DFU/Keyboard.h
 273         make -C lib/lufa/Bootloaders/DFU/
 274         printf "BootloaderDFU.hex copied to $(TARGET)_bootloader.hex\n"
 275         cp lib/lufa/Bootloaders/DFU/BootloaderDFU.hex $(TARGET)_bootloader.hex
 276
 277 production: $(BUILD_DIR)/$(TARGET).hex bootloader cpfirmware
 278         @cat $(BUILD_DIR)/$(TARGET).hex | awk '/^:00000001FF/ == 0' > $(TARGET)_production.hex
 279         @cat $(TARGET)_bootloader.hex >> $(TARGET)_production.hex
 280         echo "File sizes:"
 281         $(SIZE) $(TARGET).hex $(TARGET)_bootloader.hex $(TARGET)_production.hex
 282