tmk_core/doc/build.md

   1 Build Firmware and Program Controller
   2 =====================================
   3
   4
   5 Download and Install
   6 --------------------
   7 ### 1. Install Tools
   8
   9 1. **Toolchain** On Windows install [Atmel AVR Toolchain][atmelgcc] for AVR GCC compiler and [Cygwin][cygwin](or [MinGW][mingw]) for shell terminal. On Mac you can use [CrossPack][crosspack] or your favorite package manager. On Linux you can install AVR GCC with your favorite package manager.
  10
  11 2. **Programmer** Install [dfu-programmer][dfu-prog]. GUI tool [Atmel FLIP][flip] also can be used on Windows.
  12
  13 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.
  14
  15 If you use PJRC Teensy you don't need step 2 and 3 above, just get [Teensy loader][teensy-loader].
  16
  17
  18 ### 2. Download source
  19 You can find firmware source at github:
  20
  21 - <https://github.com/tmk/tmk_keyboard>
  22
  23 If you are familiar with [`git`][git] tools you are recommended to use it but you can also download zip archive from:
  24
  25 - <https://github.com/tmk/tmk_keyboard/archive/master.zip>
  26
  27
  28 Build firmware
  29 --------------
  30 ### 1. Open terminal
  31 Open terminal window to get access to commands. Use Cygwin(or MingGW) shell terminal in Windows or `Terminal.app` on Mac OSX.
  32
  33 ### 2. Change directory
  34 Move to project directory in the firmware source.
  35
  36     cd tmk_keyboard/{'keyboard' or 'converter'}/<project>
  37
  38 ### 3. Make
  39 Build firmware using GNU `make` command. You'll see `<project>_<variant>.hex` file in that directory unless something unexpected occurs in build process.
  40
  41
  42     make -f Makefile.<variant> clean
  43     make -f Makefile.<variant>
  44
  45
  46
  47
  48 Program Controller
  49 ------------------
  50 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.
  51
  52 ### 1. Start bootloader
  53 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.
  54
  55 ### 2. Program with DFU bootloader
  56 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.
  57
  58
  59 To program with command of `FLIP` run this. Note that you need to set PATH variable properly.
  60
  61     $ make -f Makefile.<variant> flip
  62
  63 With `dfu-programmer` run this.
  64
  65     $ make -f Makefile.<variant> dfu
  66
  67 Or you can execute the command directly as the following.
  68
  69     $ dfu-programmer <controller> erase --force
  70     $ dfu-programmer <controller> flash <your_firmware.hex>
  71     $ dfu-programmer <controller> reset
  72
  73 `<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.
  74
  75
  76 #### FLIP GUI tutorial
  77 1. On menu bar click **Device** -> **Select**, then choose your chip name. (In most cases **ATmega32U2** or **ATmega32U4**)
  78 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.
  79
  80 3. On menu bar click **File** -> **Load HEX File**, then select your firmware hex file on File Selector dialog.
  81 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.
  82 5. Re-plug USB cord or click **Start Application** button to restart your controller.
  83 Done.
  84
  85 See also these instructions if needed.
  86
  87 - <http://code.google.com/p/micropendous/wiki/LoadingFirmwareWithFLIP>
  88 - <http://www.atmel.com/Images/doc7769.pdf>
  89
  90
  91 ##### Troubleshoot
  92 * **FLIP: AtLibUsbDfu.dll not found**
  93 Remove current driver and re-install one FLIP provides from DeviceManager of WIndows. See <http://imgur.com/a/bnwzy>
  94
  95
  96 ### 3. Program with Other programmer
  97 If you are using PJRC Teensy consult with instruction of [Teensy Loader][teensy-loader]. Or run this target with `make` after you install command line version of it.
  98
  99     $ make -f Makefile.<variant> teensy
 100
 101 You may want to use other programmer like [`avrdude`][avrdude]. In that case you can still use make target `program` for build with configuring `PROGRAM_CMD` in Makefile. See below.
 102
 103     $ make -f Makefile.<variant> program
 104
 105
 106 [atmelgcc]:     http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORWINDOWS.aspx
 107 [cygwin]:       https://www.cygwin.com/
 108 [mingw]:        http://www.mingw.org/
 109 [crosspack]:    http://www.obdev.at/products/crosspack/index.html
 110 [flip]:         http://www.atmel.com/tools/FLIP.aspx
 111 [dfu-prog]:     http://dfu-programmer.sourceforge.net/
 112 [teensy-loader]:http://www.pjrc.com/teensy/loader.html
 113 [avrdude]:      http://savannah.nongnu.org/projects/avrdude/
 114 [git]:          https://git-scm.com/
 115
 116
 117
 118 Makefile Options
 119 ----------------
 120 ### 1. MCU and Frequency.
 121
 122     MCU = atmega32u4       # Teensy 2.0
 123     #MCU = at90usb1286      # Teensy++ 2.0
 124     F_CPU = 16000000
 125
 126 Set your MCU and its clock in Hz.
 127
 128     # Boot Section Size in *bytes*
 129     #   Teensy halfKay   512
 130     #   Teensy++ halfKay 2048
 131     #   Atmel DFU loader 4096
 132     #   LUFA bootloader  4096
 133     OPT_DEFS += -DBOOTLOADER_SIZE=4096
 134
 135 If you are using PJRC Teensy use `512` for `BOOTLOADER_SIZE`, otherwise use `4096` unless you are sure.
 136
 137 ### 2. Features
 138 Optional. Note that ***comment out*** with `#` to disable them.
 139
 140     BOOTMAGIC_ENABLE = yes      # Virtual DIP switch configuration(+1000)
 141     MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
 142     EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
 143     CONSOLE_ENABLE = yes        # Console for debug(+400)
 144     COMMAND_ENABLE = yes        # Commands for debug and configuration
 145     SLEEP_LED_ENABLE = yes      # Breathing sleep LED during USB suspend
 146     #NKRO_ENABLE = yes          # USB Nkey Rollover - not yet supported in LUFA
 147     #BACKLIGHT_ENABLE = yes     # Enable keyboard backlight functionality
 148
 149 ### 3. Programmer
 150 Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`.
 151
 152     # avrdude with AVRISPmkII
 153     PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex
 154
 155     # avrdude with USBaspLoader
 156     PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex
 157
 158     # avrdude with arduino
 159     PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex
 160
 161
 162
 163 Config.h Options
 164 ----------------
 165 ### 1. Magic command key combination
 166
 167     #define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT)))
 168
 169 ### 2. Mechanical Locking Support for CapsLock
 170
 171     /* Mechanical locking CapsLock support. Use KC_LCAP instead of KC_CAPS in keymap */
 172     #define CAPSLOCK_LOCKING_ENABLE
 173     /* Locking CapsLock re-synchronize hack */
 174     #define CAPSLOCK_LOCKING_RESYNC_ENABLE
 175
 176 ### 3. Disable Debug and Print
 177
 178     /* disable debug print */
 179     #define NO_DEBUG
 180
 181     /* disable print */
 182     #define NO_PRINT
 183
 184 ### 4. Disable Action Features
 185
 186     #define NO_ACTION_LAYER
 187     #define NO_ACTION_TAPPING
 188     #define NO_ACTION_ONESHOT
 189     #define NO_ACTION_MACRO
 190     #define NO_ACTION_FUNCTION
 191
 192 ***TBD***