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` 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. Open source command line tool `dfu-programmer` also supports AVR chips, it runs on Linux, Mac OSX and even Windows.
  57
  58 To program AVR chip with DFU bootloader use `FLIP` or `dfu-programmer`.
  59 If you have a proper program command in `Makefile` just type this.
  60
  61 `FLIP` has two version of tool, GUI app and command line program. If you want GUI see tutorial below.
  62 To use command line tool run this command. Note that you need to set PATH variable properly.
  63
  64     $ make -f Makefile.<variant> flip
  65
  66 Or to program with `dfu-programmer` run:
  67
  68     $ make -f Makefile.<variant> dfu
  69
  70 #### FLIP GUI tutorial
  71 1. On menu bar click **Device** -> **Select**, then choose your chip name. (In most case **ATmega32U2** or **ATmega32U4**)
  72 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.
  73
  74 3. On menu bar click **File** -> **Load HEX File**, then select your firmware hex file on File Selector dialog.
  75 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.
  76 5. Re-plug USB cord or click **Start Application** button to restart your controller.
  77 Done.
  78
  79 See also these instructions if needed.
  80
  81 - <http://code.google.com/p/micropendous/wiki/LoadingFirmwareWithFLIP>
  82 - <http://www.atmel.com/Images/doc7769.pdf>
  83
  84
  85 ##### Troubleshoot
  86 * **FLIP: AtLibUsbDfu.dll not found**
  87 Remove current driver and re-install one FLIP provides from DeviceManager of WIndows. See <http://imgur.com/a/bnwzy>
  88
  89
  90 ### 3. Program with Other programmer
  91 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.
  92
  93     $ make -f Makefile.<variant> teensy
  94
  95 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.
  96
  97     $ make -f Makefile.<variant> program
  98
  99
 100 [atmelgcc]:     http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORWINDOWS.aspx
 101 [cygwin]:       https://www.cygwin.com/
 102 [mingw]:        http://www.mingw.org/
 103 [crosspack]:    http://www.obdev.at/products/crosspack/index.html
 104 [flip]:         http://www.atmel.com/tools/FLIP.aspx
 105 [dfu-prog]:     http://dfu-programmer.sourceforge.net/
 106 [teensy-loader]:http://www.pjrc.com/teensy/loader.html
 107 [avrdude]:      http://savannah.nongnu.org/projects/avrdude/
 108
 109
 110
 111 Makefile Options
 112 ----------------
 113 ### 1. MCU and Frequency.
 114
 115     MCU = atmega32u4       # Teensy 2.0
 116     #MCU = at90usb1286      # Teensy++ 2.0
 117     F_CPU = 16000000
 118
 119 Set your MCU and its clock in Hz.
 120
 121     # Boot Section Size in *bytes*
 122     #   Teensy halfKay   512
 123     #   Teensy++ halfKay 2048
 124     #   Atmel DFU loader 4096
 125     #   LUFA bootloader  4096
 126     OPT_DEFS += -DBOOTLOADER_SIZE=4096
 127
 128 If you are using PJRC Teensy use `512` for `BOOTLOADER_SIZE`, otherwise use `4096` unless you are sure.
 129
 130 ### 2. Features
 131 Optional. Note that ***comment out*** with `#` to disable them.
 132
 133     BOOTMAGIC_ENABLE = yes      # Virtual DIP switch configuration(+1000)
 134     MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
 135     EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
 136     CONSOLE_ENABLE = yes        # Console for debug(+400)
 137     COMMAND_ENABLE = yes        # Commands for debug and configuration
 138     SLEEP_LED_ENABLE = yes      # Breathing sleep LED during USB suspend
 139     #NKRO_ENABLE = yes          # USB Nkey Rollover - not yet supported in LUFA
 140     #BACKLIGHT_ENABLE = yes     # Enable keyboard backlight functionality
 141
 142 ### 3. Programmer
 143 Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`.
 144
 145     # avrdude with AVRISPmkII
 146     PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex
 147
 148     # avrdude with USBaspLoader
 149     PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex
 150
 151     # avrdude with arduino
 152     PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex
 153
 154
 155
 156 Config.h Options
 157 ----------------
 158 ### 1. Magic command key combination
 159
 160     #define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT)))
 161
 162 ### 2. Mechanical Locking Support for CapsLock
 163
 164     /* Mechanical locking CapsLock support. Use KC_LCAP instead of KC_CAPS in keymap */
 165     #define CAPSLOCK_LOCKING_ENABLE
 166     /* Locking CapsLock re-synchronize hack */
 167     #define CAPSLOCK_LOCKING_RESYNC_ENABLE
 168
 169 ### 3. Disable Debug and Print
 170
 171     /* disable debug print */
 172     #define NO_DEBUG
 173
 174     /* disable print */
 175     #define NO_PRINT
 176
 177 ### 4. Disable Action Features
 178
 179     #define NO_ACTION_LAYER
 180     #define NO_ACTION_TAPPING
 181     #define NO_ACTION_ONESHOT
 182     #define NO_ACTION_MACRO
 183     #define NO_ACTION_FUNCTION
 184
 185 ***TBD***