1 Build Firmware and Program Controller
2 =====================================
8 First, you need tools to build firmware and program your controller. I assume you are on Windows here.
10 1. **Toolchain** Install [WinAVR][winavr]. This is old but works well for this purpose. `WinAVR` is a tool set to build firmware including C compiler(gcc) and make commands. You can use [CrossPack][crosspack] instead if you are on Mac.
12 2. **Programmer** Install [Atmel FLIP][flip]. `FLIP` is a tool to program(load) firmware into AVR controller via DFU bootloader. AVR USB chips including ATmega32U4 has DFU bootloader by factory default. You can also use [dfu-programmer][dfu-prog] instead if you are on Mac or Linux.
14 3. **Driver** At first time you start DFU bootloader on Chip 'Found New Hardware Wizard' will come up on Windows. If you install device driver properly you can 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\. If you use `dfu-programmer` install its driver.
16 If you use PJRC Teensy you don't need step 2 and 3 above, just get [Teensy loader][teensy-loader].
19 ### 2. Download source
20 You can find firmware source at github:
22 - <https://github.com/tmk/tmk_keyboard>
24 If you are familiar with `Git` tools you are recommended to use it but you can also download zip archive from:
26 - <https://github.com/tmk/tmk_keyboard/archive/master.zip>
32 Open terminal window to get access to commands. You can use `cmd` in Windows or `Terminal.app` on Mac OSX. In Windows press `Windows` key and `R` then enter `cmd` in 'Run command' dialog showing up.
34 ### 2. Change directory
35 Move to project directory in the firmware source.
37 cd tmk_keyboard/{'keyboard' or 'converter'}/<project>
40 Build firmware using GNU `make` command. You'll see `<project>_<variant>.hex` file in that directory unless something unexpected occurs in build process.
43 make -f Makefile.<variant> clean
44 make -f Makefile.<variant>
51 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.
53 ### 1. Start bootloader
54 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.
56 ### 2. Program with DFU bootloader
57 Stock AVR USB chip including ATmega32U4 has DFU bootloader by factory default. `FLIP` is a DFU programmer on Windows offered by Atmel. Open source command line tool `dfu-programmer` also supports AVR chips, it runs on Linux, Mac OSX and even Windows.
59 To program AVR chip with DFU bootloader use `FLIP` or `dfu-programmer`.
60 If you have a proper program command in `Makefile` just type this.
62 `FLIP` has two version of tool, GUI app and command line program. If you want GUI see tutorial below.
63 To use command line tool run this command. Note that you need to set PATH variable properly.
65 $ make -f Makefile.<variant> flip
67 Or to program with `dfu-programmer` run:
69 $ make -f Makefile.<variant> dfu
71 #### FLIP GUI tutorial
72 1. On menu bar click Device -> Select, then. `ATmega32u4`.
73 2. On menu bar click Settings -> Communication -> USB, then click 'Open' button on 'USB Port Connection' dialog.
74 At this point you'll see grey-outed widgets on the app get colored and ready.
76 3. On menu bar click File -> Load HEX File, then select your firmware hex file on File Selector dialog.
77 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.
78 5. Re-plug USB cord or click 'Start Application' button to restart your controller.
81 See also these instructions if you need.
83 - <http://code.google.com/p/micropendous/wiki/LoadingFirmwareWithFLIP>
84 - <http://www.atmel.com/Images/doc7769.pdf>
87 ### 3. Program with Teensy Loader
88 If you have PJRC Teensy see instruction of `Teensy Loader`.
90 - <http://www.pjrc.com/teensy/loader.html>
92 Or use this command if you have command line version of Teensy Loader installed.
94 $ make -f Makefile.<variant> teensy
97 ### 4. Program with Other programmer
98 You may want to use other programmer like `avrdude` with AVRISPmkII, Arduino or USBasp. In that case you can still use make target `program` for build with configuring `PROGRAM_CMD` in Makefile.
100 $ make -f Makefile.<variant> program
103 [winavr]: http://winavr.sourceforge.net/
104 [crosspack]: http://www.obdev.at/products/crosspack/index.html
105 [flip]: http://www.atmel.com/tools/FLIP.aspx
106 [dfu-prog]: http://dfu-programmer.sourceforge.net/
107 [teensy-loader]:http://www.pjrc.com/teensy/loader.html
113 ### 1. MCU and Frequency.
115 MCU = atmega32u4 # Teensy 2.0
116 #MCU = at90usb1286 # Teensy++ 2.0
119 # Boot Section Size in *bytes*
121 # Atmel DFU loader 4096
122 # LUFA bootloader 4096
123 OPT_DEFS += -DBOOTLOADER_SIZE=4096
126 Optional. Note that ***comment out*** to disable them.
128 BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000)
129 MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
130 EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
131 CONSOLE_ENABLE = yes # Console for debug(+400)
132 COMMAND_ENABLE = yes # Commands for debug and configuration
133 SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend
134 #NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA
135 #BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
138 Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`. Not needed if you use `FLIP`, `dfu-programmer` or `Teensy Loader`.
140 # avrdude with AVRISPmkII
141 PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex
143 # avrdude with USBaspLoader
144 PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex
146 # avrdude with arduino
147 PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex
153 ### 1. Magic command key combination
155 #define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT)))
157 ### 2. Mechanical Locking Support for CapsLock
159 /* Mechanical locking CapsLock support. Use KC_LCAP instead of KC_CAPS in keymap */
160 #define CAPSLOCK_LOCKING_ENABLE
161 /* Locking CapsLock re-synchronize hack */
162 #define CAPSLOCK_LOCKING_RESYNC_ENABLE
164 ### 3. Disable Debug and Print
166 /* disable debug print */
172 ### 4. Disable Action Features
174 #define NO_ACTION_LAYER
175 #define NO_ACTION_TAPPING
176 #define NO_ACTION_ONESHOT
177 #define NO_ACTION_MACRO
178 #define NO_ACTION_FUNCTION