1
0
tmk_keyboard/doc/build.md
tmk 28203e909e Squashed 'tmk_core/' changes from 57d27a8..08ce4c3
08ce4c3 Add update for chibios in README
30cac1d Merge remote-tracking branch 'flabbergast-tmk_keyboard/chibios'
f218a38 core: Remove unused warning. Fix tmk_keyboard/#293
3e68807 Chibios: add more guards for transmitting (fix a deadlock bug).
cecc807 core: Speed up compilation
d01d959 Merge remote-tracking branch 'upstream/master' into chibios
8ff12ae Merge pull request #230 from jerryen/master
3afb83d core: Add note about sudo and git
2525d5d Chibios: Update to new USB API.
2fc5cd6 Merge branch 'master' into chibios
6f5511a core: Fix variable initialize
02a15fa core: Fix variable init and header include
1833ca1 Merge pull request #292 from obones/command_warning
bc9dc6f Merge pull request #294 from shayneholmes/fix-debug-message
c1b891b Merge pull request #295 from doopai/master
1da837c core: Add macro commands SM(), RM() and CM()
d9d5a93 Add support for storing, restoring and clearing modifiers in macros
4f371c0 core: Add dfu-programmer example to doc/build.md
ba3792e core: Fix doc/build.md
4b99fed remove  SERIAL_SOFT_DEBUG macro
984accb Fix typo in bootmagic debug message
67a7ea1 usb_usb: Fix for keymap editor
2fc9ae4 host_driver is only used if KEYBOARD_LOCK_ENABLE is defined
a35cdea Chibios: add 'core/protocol' to the makefiles' search path.
5ed2fd6 Merge remote-tracking branch 'upstream/master' into chibios
bbc4851 Do timeout when writing to CONSOLE EP queue.
2450559 Remove an errant comma trailing the KC_ERAS macro alias
8465747 Merge pull request #270 from jeffgran/single-tap-toggle
a37339a Merge pull request #271 from jeffgran/default-layer-toggle
8e732f7 core: Update doc/build.md and remove other_projects.md
e47dc15 Workaround for compiler warnings when console disabled.
4184c52 Add maple mini code.
b555238 core: Fix rules.mk for dfu target
26dacf4 add ACTION_DEFAULT_LAYER_TOGGLE to toggle a default layer on/off
83607d9 enable TAPPING_TOGGLE=1 to work correctly
bef3089 Merge branch 'master' into chibios
f7a55fd core: Fix debug print of usb_hid
1402f7d core: Add keycode KC_JPY for JIS
8e3a460 Chibios: Remove the wait in the main loop.
7d41746 ChibiOS: prettify/document sleep_led code.
235cdee ChibiOS: Update infinity bootloader code to match updated ChibiOS.
807bf1e Chibios: Add breathing sleep LED on Kinetis MCUs.
ba3bf7c ChibiOS: make reset request more CMSISy.
bf2ffd4 Add correct chibios/bootloader_jump for infinity KB.
f5e03fd Chibios/usb_main: rename a variable for clarity.
63a330c Fix drop key stroke
d8f5b06 Fix report size of boot protocol.
38abb50 ChibiOS/STM32: send remote wakeup.
6725650 ChibiOS/kinetis: sending remote wakeup.
69f6e54 Chibios: use WFI in idle. WIP suspend stuff.
02f044b Move chibios/cortex selection to local Makefiles.
fa59dfa Rename chibios example keyboard.
5c060de Add eeprom support for chibios/kinetis.
efd0044 Move declaration of keymap_config.
7196b24 Make bootmagic.c code portable (_delay_ms -> wait_ms).
37b15b2 Add missing #include to keymap.c.
31316e3 Merge branch 'master' into chibios
166f312 Fix chibios/usb_main GET_REPORT handing.
57ac6c2 Add ARM Teensies bootloader code.
1758086 Move STM32 bootloader address config to separate .h file.
03bb026 Rename some Makefile defines.
76ba6ac NKRO fixes.
06498f8 Update chibios README.
db0a4f5 Add basic sleep_led for chibios.
c3f930e Move AVR specific sleep_led.c into avr.
4069494 Fix bootloader-jump compiling.
9117f7b Small updates.
269cb85 Implement jump-to-bootloader.
7e81b34 Move chibios to tool.
923a892 Make usb_main more USB_DRIVER #define independent.
aa054f0 Add ChibiOS support (USB stack + support files).
1e3e282 Modularity and gcc warnings fixes.
2f60ce0 Add KEYBOARD_LOCK_ENABLE to makefile

git-subtree-dir: tmk_core
git-subtree-split: 08ce4c3021d2ecd446c5b9a137aded65423d241e
2016-02-11 12:21:21 +09:00

7.8 KiB

Build Firmware and Program Controller

Download and Install

1. Install Tools

  1. Toolchain On Windows install Atmel AVR Toolchain for AVR GCC compiler and Cygwin(or MinGW) for shell terminal. On Mac you can use CrossPack or your favorite package manager. On Linux you can install AVR GCC with your favorite package manager.

  2. Programmer Install dfu-programmer. GUI tool Atmel FLIP also can be used on Windows.

  3. Driver On Windows when you start DFU bootloader on the chip first time you will see Found New Hardware Wizard to install driver. If you install device driver properly you will find chip name like ATmega32U4 under LibUSB-Win32 Devices tree on Device Manager. If not you shall need to update its driver on Device Manager. You will find the driver in FLIP install directory like: C:\Program Files (x86)\Atmel\Flip 3.4.5\usb\. In case of dfu-programmer install driver distributed with it.

If you use PJRC Teensy you don't need step 2 and 3 above, just get Teensy loader.

2. Download source

You can find firmware source at github:

If you are familiar with git tools you are recommended to use it but you can also download zip archive from:

Build firmware

1. Open terminal

Open terminal window to get access to commands. Use Cygwin(or MingGW) shell terminal in Windows or Terminal.app on Mac OSX.

2. Change directory

Move to project directory in the firmware source.

cd tmk_keyboard/{'keyboard' or 'converter'}/<project>

3. Make

Build firmware using GNU make command. You'll see <project>_<variant>.hex file in that directory unless something unexpected occurs in build process.

make -f Makefile.<variant> clean
make -f Makefile.<variant>

Program Controller

Now you have hex file to program on current directory. This hex is only needed to program your controller, other files are used for development and you may leave and forget them.

1. Start bootloader

How to program controller depends on controller chip and its board design. To program AVR USB chips you'll need to start it up in bootloader mode. Most of boards with the chip have a push button to let bootloader come up. Consult with your controller board manual.

2. Program with DFU bootloader

Stock AVR USB chips have DFU bootloader by factory default. FLIP is a DFU programmer on Windows offered by Atmel. FLIP has two version of tool, GUI app and command line program. If you want GUI see tutorial below. Open source alternative dfu-programmer also supports AVR chips, it is command line tool and runs on Linux, Mac OSX and even Windows.

To program with command of FLIP run this. Note that you need to set PATH variable properly.

$ make -f Makefile.<variant> flip

With dfu-programmer run this.

$ make -f Makefile.<variant> dfu

Or you can execute the command directly as the following.

$ dfu-programmer <controller> erase --force
$ dfu-programmer <controller> flash <your_firmware.hex>
$ dfu-programmer <controller> reset

<controller> part will be atmega32u4 or atmega32u2 in most cases. See manual of the command for the detail. On Linux and Mac OSX you will need proper permission to program a controller and you can use sudo command for this purpose probably. On Linux you also can configure udev rules to set permission.

FLIP GUI tutorial

  1. On menu bar click Device -> Select, then choose your chip name. (In most cases ATmega32U2 or ATmega32U4)

  2. On menu bar click Settings -> Communication -> USB, then click Open button on USB Port Connection dialog. At this point you'll have to plug into USB and start bootloader.

  3. On menu bar click File -> Load HEX File, then select your firmware hex file on File Selector dialog.

  4. On Operations Flow panel click Run button to load the firmware binary to the chip. Note that you should keep Erase, Blank Check, Program and Verify check boxes selected.

  5. Re-plug USB cord or click Start Application button to restart your controller. Done.

See also these instructions if needed.

Troubleshoot
  • FLIP: AtLibUsbDfu.dll not found Remove current driver and re-install one FLIP provides from DeviceManager of WIndows. See http://imgur.com/a/bnwzy

3. Program with Other programmer

If you are using PJRC Teensy consult with instruction of Teensy Loader. Or run this target with make after you install command line version of it.

$ make -f Makefile.<variant> teensy

You may want to use other programmer like avrdude. In that case you can still use make target program for build with configuring PROGRAM_CMD in Makefile. See below.

$ make -f Makefile.<variant> program

Makefile Options

1. MCU and Frequency.

MCU = atmega32u4       # Teensy 2.0
#MCU = at90usb1286      # Teensy++ 2.0
F_CPU = 16000000

Set your MCU and its clock in Hz.

# Boot Section Size in *bytes*
#   Teensy halfKay   512
#   Teensy++ halfKay 2048
#   Atmel DFU loader 4096
#   LUFA bootloader  4096
OPT_DEFS += -DBOOTLOADER_SIZE=4096

If you are using PJRC Teensy use 512 for BOOTLOADER_SIZE, otherwise use 4096 unless you are sure.

2. Features

Optional. Note that comment out with # to disable them.

BOOTMAGIC_ENABLE = yes      # Virtual DIP switch configuration(+1000)
MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
CONSOLE_ENABLE = yes        # Console for debug(+400)
COMMAND_ENABLE = yes        # Commands for debug and configuration
SLEEP_LED_ENABLE = yes      # Breathing sleep LED during USB suspend
#NKRO_ENABLE = yes          # USB Nkey Rollover - not yet supported in LUFA
#BACKLIGHT_ENABLE = yes     # Enable keyboard backlight functionality

3. Programmer

Optional. Set proper command for your controller, bootloader and programmer. This command can be used with make program.

# avrdude with AVRISPmkII
PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex

# avrdude with USBaspLoader
PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex

# avrdude with arduino
PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex

Config.h Options

1. Magic command key combination

#define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT)))

2. Mechanical Locking Support for CapsLock

/* Mechanical locking CapsLock support. Use KC_LCAP instead of KC_CAPS in keymap */
#define CAPSLOCK_LOCKING_ENABLE
/* Locking CapsLock re-synchronize hack */
#define CAPSLOCK_LOCKING_RESYNC_ENABLE

3. Disable Debug and Print

/* disable debug print */
#define NO_DEBUG

/* disable print */
#define NO_PRINT

4. Disable Action Features

#define NO_ACTION_LAYER
#define NO_ACTION_TAPPING
#define NO_ACTION_ONESHOT
#define NO_ACTION_MACRO
#define NO_ACTION_FUNCTION

TBD