doc/build_old.md

   1 Build Firmware and Program Controller
   2 =====================================
   3
   4 ## This guide may be out-dated - use doc/BUILD_GUIDE.md instead
   5
   6 Download and Install
   7 --------------------
   8 ### 1. Install Tools
   9
  10 1. **Toolchain** On Windows install [MHV AVR Tools][mhv] for AVR GCC compiler and [Cygwin][cygwin](or [MinGW][mingw]) for shell terminal. On Mac you can use [CrossPack][crosspack]. On Linux you can install AVR GCC (and avr-libc) with your favorite package manager or run the avr_setup.sh script in the root of this repository.
  11
  12 2. **Programmer** On Windows install [Atmel FLIP][flip]. On Mac and Linux install [dfu-programmer][dfu-prog].
  13
  14 3. **Driver** On Windows 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 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\. In case of `dfu-programmer` use its driver.
  15
  16 If you use PJRC Teensy you don't need step 2 and 3 above, just get [Teensy loader][teensy-loader].
  17
  18
  19 ### 2. Download source
  20 You can find firmware source at github:
  21
  22 - <https://github.com/tmk/tmk_keyboard>
  23
  24 If you are familiar with `Git` tools you are recommended to use it but you can also download zip archive from:
  25
  26 - <https://github.com/tmk/tmk_keyboard/archive/master.zip>
  27
  28
  29 Build firmware
  30 --------------
  31 ### 1. Open terminal
  32 Open terminal window to get access to commands. Use Cygwin(or MingGW) `shell terminal` in Windows or `Terminal.app` on Mac OSX. In Windows press `Windows` key and `R` then enter `cmd` in 'Run command' dialog showing up.
  33
  34 ### 2. Change directory
  35 Move to project directory in the firmware source.
  36
  37     cd tmk_keyboard/{'keyboard' or 'converter'}/<project>
  38
  39 ### 3. Make
  40 Build firmware using GNU `make` command. You'll see `<project>_<variant>.hex` file in that directory unless something unexpected occurs in build process.
  41
  42
  43     make -f Makefile.<variant> clean
  44     make -f Makefile.<variant>
  45
  46
  47
  48
  49 Program Controller
  50 ------------------
  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.
  52
  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.
  55
  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.
  58
  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.
  61
  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.
  64
  65     $ make -f Makefile.<variant> flip
  66
  67 Or to program with `dfu-programmer` run:
  68
  69     $ make -f Makefile.<variant> dfu
  70
  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.
  75
  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.
  79 Done.
  80
  81 See also these instructions if you need.
  82
  83 - <http://code.google.com/p/micropendous/wiki/LoadingFirmwareWithFLIP>
  84 - <http://www.atmel.com/Images/doc7769.pdf>
  85
  86
  87 ### 3. Program with Teensy Loader
  88 If you have PJRC Teensy see instruction of `Teensy Loader`.
  89
  90 - <http://www.pjrc.com/teensy/loader.html>
  91
  92 Or use this command if you have command line version of Teensy Loader installed.
  93
  94     $ make -f Makefile.<variant> teensy
  95
  96
  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.
  99
 100     $ make -f Makefile.<variant> program
 101
 102
 103 [cygwin]:       https://www.cygwin.com/
 104 [mingw]:        http://www.mingw.org/
 105 [mhv]:          https://infernoembedded.com/products/avr-tools
 106 [winavr]:       http://winavr.sourceforge.net/
 107 [crosspack]:    http://www.obdev.at/products/crosspack/index.html
 108 [flip]:         http://www.atmel.com/tools/FLIP.aspx
 109 [dfu-prog]:     http://dfu-programmer.sourceforge.net/
 110 [teensy-loader]:http://www.pjrc.com/teensy/loader.html
 111
 112
 113
 114 Makefile Options
 115 ----------------
 116 ### 1. MCU and Frequency.
 117
 118     MCU = atmega32u4       # Teensy 2.0
 119     #MCU = at90usb1286      # Teensy++ 2.0
 120     F_CPU = 16000000
 121
 122 Set your MCU and its clock in Hz.
 123
 124     # Boot Section Size in *bytes*
 125     #   Teensy halfKay   512
 126     #   Atmel DFU loader 4096
 127     #   LUFA bootloader  4096
 128     OPT_DEFS += -DBOOTLOADER_SIZE=4096
 129
 130 If you are using PJRC Teensy use `512` for `BOOTLOADER_SIZE`, otherwise use `4096` unless you are sure.
 131
 132 ### 2. Features
 133 Optional. Note that ***comment out*** with `#` to disable them.
 134
 135     BOOTMAGIC_ENABLE = yes      # Virtual DIP switch configuration(+1000)
 136     MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
 137     EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
 138     CONSOLE_ENABLE = yes        # Console for debug(+400)
 139     COMMAND_ENABLE = yes        # Commands for debug and configuration
 140     SLEEP_LED_ENABLE = yes      # Breathing sleep LED during USB suspend
 141     #NKRO_ENABLE = yes          # USB Nkey Rollover - not yet supported in LUFA
 142     #BACKLIGHT_ENABLE = yes     # Enable keyboard backlight functionality
 143
 144 ### 3. Programmer
 145 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`.
 146
 147     # avrdude with AVRISPmkII
 148     PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex
 149
 150     # avrdude with USBaspLoader
 151     PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex
 152
 153     # avrdude with arduino
 154     PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex
 155
 156
 157
 158 Config.h Options
 159 ----------------
 160 ### 1. Magic command key combination
 161
 162     #define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT)))
 163
 164 ### 2. Mechanical Locking Support for CapsLock
 165
 166     /* Mechanical locking CapsLock support. Use KC_LCAP instead of KC_CAPS in keymap */
 167     #define CAPSLOCK_LOCKING_ENABLE
 168     /* Locking CapsLock re-synchronize hack */
 169     #define CAPSLOCK_LOCKING_RESYNC_ENABLE
 170
 171 ### 3. Disable Debug and Print
 172
 173     /* disable debug print */
 174     #define NO_DEBUG
 175
 176     /* disable print */
 177     #define NO_PRINT
 178
 179 ### 4. Disable Action Features
 180
 181     #define NO_ACTION_LAYER
 182     #define NO_ACTION_TAPPING
 183     #define NO_ACTION_ONESHOT
 184     #define NO_ACTION_MACRO
 185     #define NO_ACTION_FUNCTION
 186
 187 ***TBD***