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 for the first time you will see **Found New Hardware Wizard** to install driver. If you install the device driver properly you will find a chip name like **ATmega32U4** under the **LibUSB-Win32 Devices** tree in **Device Manager**. If not you will need to update its driver in **Device Manager**. You will find the driver in the `FLIP` install directory, something like this: `C:\Program Files (x86)\Atmel\Flip 3.4.5\usb\`. For `dfu-programmer` install the driver distributed with it.
  14
  15 If you use a PJRC Teensy you don't need step 2 and 3 above, just get the [Teensy loader][teensy-loader].
  16
  17
  18 ### 2. Download Source
  19 You can find the firmware source on github:
  20
  21 - <https://github.com/tmk/tmk_keyboard>
  22
  23 If you are familiar with [`git`][git] tools you can use that; otherwise you can download the 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 a terminal window. Use the Cygwin (or MingGW) shell terminal on Windows, the `Terminal.app` on Mac OSX, and whatever terminal you like on Linux.
  32
  33 ### 2. Change Directory
  34 Move to the project directory in the firmware source.
  35
  36     cd tmk_keyboard/{'keyboard' or 'converter'}/<project>
  37
  38 ### 3. Make
  39 Build the firmware using the GNU `make` command. You'll see a `<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 a **hex** file in the current directory. This **hex** file 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 you program the controller depends on the controller chip and its board design. To program an AVR USB chip you'll need to start it up in bootloader mode. Most boards have a push-button to load the bootloader. Consult with your controller board's manual.
  54
  55 <!--PROGRESS-->
  56 ### 2. Program with DFU bootloader
  57 Stock AVR USB chips have the DFU bootloader by factory default. `FLIP` is a DFU programmer on Windows offered by Atmel. `FLIP` has two version of the tool, a GUI app and a command line program. If you want the GUI see the tutorial below. An open source alternative, `dfu-programmer`, also supports AVR chips; it is a command line tool and runs on Linux, Mac OSX and even Windows.
  58
  59
  60 To program with the command line version of `FLIP` run this. Note that you need to set the PATH variable properly.
  61
  62     $ make -f Makefile.<variant> flip
  63
  64 With `dfu-programmer` run this.
  65
  66     $ make -f Makefile.<variant> dfu
  67
  68 Or you can execute the command directly as the following.
  69
  70     $ dfu-programmer <controller> erase --force
  71     $ dfu-programmer <controller> flash <your_firmware.hex>
  72     $ dfu-programmer <controller> reset
  73
  74 The `<controller>` part will be `atmega32u4` or `atmega32u2` in most cases. See the manual of the command for details. On Linux and Mac OSX you will need proper permissions to program a controller and you can probably use `sudo` command for this purpose. On Linux you also can configure `udev` rules to set permissions.
  75
  76
  77 #### FLIP GUI Tutorial
  78 1. In the menu bar click **Device** -> **Select**, then choose your chip name. (In most cases **ATmega32U2** or **ATmega32U4**)
  79 2. In the menu bar click **Settings** -> **Communication** -> **USB**, then click the **Open** button in the **USB Port Connection** dialog. At this point you'll have to plug into USB and start the bootloader.
  80
  81 3. In the menu bar click **File** -> **Load HEX File**, then select your firmware hex file in the File Selector dialog.
  82 4. In the **Operations Flow** panel click the **Run** button to load the firmware binary to the chip. Note that you should keep the **Erase**, **Blank Check**, **Program** and **Verify** check boxes selected.
  83 5. Re-connect the USB cord or click the **Start Application** button to restart your controller.
  84 Done.
  85
  86 See also these instructions if needed.
  87
  88 - <http://code.google.com/p/micropendous/wiki/LoadingFirmwareWithFLIP>
  89 - <http://www.atmel.com/Images/doc7769.pdf>
  90
  91
  92 ##### Troubleshooting
  93 * **FLIP: AtLibUsbDfu.dll not found**
  94 Remove the current driver and re-install the one FLIP provides from DeviceManager of Windows. See <http://imgur.com/a/bnwzy>
  95
  96
  97 ### 3. Program with Another Programmer
  98 If you are using a PJRC Teensy consult with the instructions for [Teensy Loader][teensy-loader]. Or run this target with `make` after you install the command line version of it.
  99
 100     $ make -f Makefile.<variant> teensy
 101
 102 You may want to use another programmer like [`avrdude`][avrdude]. In that case you can still use make target `program` for build with configuring `PROGRAM_CMD` in the Makefile. See below.
 103
 104     $ make -f Makefile.<variant> program
 105
 106
 107 [atmelgcc]:     http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORWINDOWS.aspx
 108 [cygwin]:       https://www.cygwin.com/
 109 [mingw]:        http://www.mingw.org/
 110 [crosspack]:    http://www.obdev.at/products/crosspack/index.html
 111 [flip]:         http://www.atmel.com/tools/FLIP.aspx
 112 [dfu-prog]:     http://dfu-programmer.sourceforge.net/
 113 [teensy-loader]:http://www.pjrc.com/teensy/loader.html
 114 [avrdude]:      http://savannah.nongnu.org/projects/avrdude/
 115 [git]:          https://git-scm.com/
 116
 117
 118
 119 Makefile Options
 120 ----------------
 121 ### 1. MCU and Frequency.
 122
 123     MCU = atmega32u4       # Teensy 2.0
 124     #MCU = at90usb1286      # Teensy++ 2.0
 125     F_CPU = 16000000
 126
 127 Set your MCU and its clock in Hz.
 128
 129     # Boot Section Size in *bytes*
 130     #   Teensy halfKay   512
 131     #   Teensy++ halfKay 2048
 132     #   Atmel DFU loader 4096
 133     #   LUFA bootloader  4096
 134     OPT_DEFS += -DBOOTLOADER_SIZE=4096
 135
 136 If you are using a PJRC Teensy use `512` for `BOOTLOADER_SIZE`, otherwise use `4096` unless you are sure.
 137
 138 ### 2. Features
 139 Optional. Note that you can ***comment out*** lines with `#` to disable them.
 140
 141     BOOTMAGIC_ENABLE = yes      # Virtual DIP switch configuration(+1000)
 142     MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
 143     EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
 144     CONSOLE_ENABLE = yes        # Console for debug(+400)
 145     COMMAND_ENABLE = yes        # Commands for debug and configuration
 146     SLEEP_LED_ENABLE = yes      # Breathing sleep LED during USB suspend
 147     #NKRO_ENABLE = yes          # USB Nkey Rollover - not yet supported in LUFA
 148     #BACKLIGHT_ENABLE = yes     # Enable keyboard backlight functionality
 149
 150 ### 3. Programmer
 151 Optional. Set the proper command for your controller, bootloader, and programmer. This command can be used with `make program`.
 152
 153     # avrdude with AVRISPmkII
 154     PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex
 155
 156     # avrdude with USBaspLoader
 157     PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex
 158
 159     # avrdude with arduino
 160     PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex
 161
 162
 163
 164 Config.h Options
 165 ----------------
 166 ### 1. Magic Command Key Combination
 167
 168     #define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT)))
 169
 170 ### 2. Mechanical Locking Support for CapsLock
 171
 172     /* Mechanical locking CapsLock support. Use KC_LCAP instead of KC_CAPS in keymap */
 173     #define CAPSLOCK_LOCKING_ENABLE
 174     /* Locking CapsLock re-synchronize hack */
 175     #define CAPSLOCK_LOCKING_RESYNC_ENABLE
 176
 177 ### 3. Disable Debug and Print
 178
 179     /* disable debug print */
 180     #define NO_DEBUG
 181
 182     /* disable print */
 183     #define NO_PRINT
 184
 185 ### 4. Disable Action Features
 186
 187     #define NO_ACTION_LAYER
 188     #define NO_ACTION_TAPPING
 189     #define NO_ACTION_ONESHOT
 190     #define NO_ACTION_MACRO
 191     #define NO_ACTION_FUNCTION
 192
 193 ***TBD***