FAQ-Build.md

   1 ## READ FIRST
   2 - https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md
   3
   4 In short,
   5
   6     $ make [-f Makefile.<variant>] [KEYMAP=...] clean
   7     $ make [-f Makefile.<variant>] [KEYMAP=...]
   8     $ make [-f Makefile.<variant>] [KEYMAP=...] dfu
   9
  10
  11 ## Can't program on Linux and Mac
  12 You will need proper permission to operate a device. For Linux users see udev rules below.
  13 Easy way is to use `sudo` command, if you are not familiar with this command check its manual with `man sudo` or this page on line.
  14
  15 https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man8/sudo.8.html
  16
  17 in short,
  18
  19     $ sudo dfu-programmer atmega32u4 erase --force
  20     $ sudo dfu-programmer atmega32u4 flash hhkb_rn42.hex
  21     $ sudo dfu-programmer atmega32u4 reset
  22
  23 or
  24
  25     $ sudo make dfu
  26
  27
  28 ## Do 'make clean' before 'make'
  29 You'll need `make clean` after you edit **config.h** or change options like `KEYMAP`.
  30
  31 Frist remove all files made in previous build,
  32
  33     $ make clean
  34
  35 then build new frimware.
  36
  37     $ make [KEYMAP=...]
  38
  39 Also you can always try `make clean` when you get other strange result during build.
  40
  41
  42 ## WINAVR is obsolete
  43 It is no longer recommended and may cause some problem.
  44 See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).
  45
  46 ## USB stack: LUFA or PJRC?
  47 Use **LUFA**.
  48
  49 **PJRC** stack won't be supported actively anymore. There is no reason to hesitate to use LUFA except for binary size(about 1KB lager?). But **PJRC** is still very useful for debug and development purpose.
  50 See also [Issue #50](https://github.com/tmk/tmk_keyboard/issues/50) and [Issue #58](https://github.com/tmk/tmk_keyboard/issues/58).
  51
  52 ## Edit configuration but not change
  53 You will need followings after editing `CONSOLE_ENABLE`, `NKRO_ENABLE`, `EXTRAKEY_ENABLE` or `MOUSEKEY_ENABLE` option in **Makefile**.
  54
  55 ### 1. make clean
  56 This will be needed when you edit **config.h**.
  57
  58 ### 2. Remove Drivers from Device Manager(Windows)
  59 **Windows only.** Linux, OSX and other OS's doesn't require this. It looks like Windows keeps using driver installed when device was connected first time even after the device changes its configuration. To load proper drivers for new configuration you need to remove existent drivers from **Drvice Manager**.
  60
  61 ### 3. Build with different VID:PID
  62 **Windows only.** If method 2. does't work fou you try this. Change Vendor ID or Product ID in **config.h** and build firmware. Windows should recognize it as whole new device and start drivers install process.
  63
  64 ### 4. Just try other ports
  65 This will be useful and the easiest workaround for **Windows**.
  66
  67
  68
  69 ## USB VID and PID
  70 You can use any ID you want with editing `config.h`. Using any presumably unused ID will be no problem in fact except for very least chance of collision with other product.
  71
  72 For example TMK uses following numbers by default.
  73 ```
  74 keyboard:
  75 hhkb: FEED:CAFE
  76 gh60: FEED:6060
  77
  78 converter:
  79 x68k: FEED:6800
  80 ps2: FEED:6512
  81 adb: FEED:0ADB
  82 ibm4704: FEED:4704
  83 pc98: FEED:9898
  84 ```
  85
  86 Also see this.
  87 https://github.com/tmk/tmk_keyboard/issues/150
  88
  89 You can buy a really unique VID:PID here. I don't think you need this for personal use.
  90 - http://www.obdev.at/products/vusb/license.html
  91 - http://www.mcselec.com/index.php?page=shop.product_details&flypage=shop.flypage&product_id=92&option=com_phpshop&Itemid=1
  92
  93
  94 ## Linux udev rules
  95 On Linux you need proper privilege to access device file of MCU, you'll have to use `sudo` when flashing firmware. You can circumvent this with placing these files in `/etc/udev/rules.d/`.
  96
  97 **/etc/udev/rules.d/50-atmel-dfu.rules:**
  98 ```
  99 # Atmel ATMega32U4
 100 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff4", MODE:="0666"
 101 # Atmel USBKEY AT90USB1287
 102 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ffb", MODE:="0666"
 103 # Atmel ATMega32U2
 104 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff0", MODE:="0666"
 105 ```
 106
 107 **/etc/udev/rules.d/52-tmk-keyboard.rules:**
 108 ```
 109 # tmk keyboard products     https://github.com/tmk/tmk_keyboard
 110 SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
 111 ```
 112
 113
 114
 115 ## Cortex: cstddef: No such file or directory
 116 GCC 4.8 of Ubuntu 14.04 had this problem and had to update to 4.9 with this PPA.
 117 https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded
 118
 119 https://github.com/tmk/tmk_keyboard/issues/212
 120 https://github.com/tmk/tmk_keyboard/wiki/mbed-cortex-porting#compile-error-cstddef
 121 https://developer.mbed.org/forum/mbed/topic/5205/
 122
 123
 124 ## 'clock_prescale_set' and 'clock_div_1' not available
 125 Your toolchain is too old to support the MCU. For example WinAVR 20100110 doesn't support ATMega32u2.
 126
 127 ```
 128 Compiling C: ../../tmk_core/protocol/lufa/lufa.c
 129 avr-gcc -c -mmcu=atmega32u2 -gdwarf-2 -DF_CPU=16000000UL -DINTERRUPT_CONTROL_ENDPOINT -DBOOTLOADER_SIZE=4096 -DF_USB=16000000UL -DARCH=ARCH_AVR8 -DUSB_DEVICE_ONLY -DUSE_FLASH_DESCRIPTORS -DUSE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)" -DFIXED_CONTROL_ENDPOINT_SIZE=8  -DFIXED_NUM_CONFIGURATIONS=1 -DPROTOCOL_LUFA -DEXTRAKEY_ENABLE -DCONSOLE_ENABLE -DCOMMAND_ENABLE -DVERSION=unknown -Os -funsigned-char -funsigned-bitfields -ffunction-sections -fdata-sections -fno-inline-small-functions -fpack-struct -fshort-enums -fno-strict-aliasing -Wall -Wstrict-prototypes -Wa,-adhlns=obj_alps64/protocol/lufa/lufa.lst -I. -I../../tmk_core -I../../tmk_core/protocol/lufa -I../../tmk_core/protocol/lufa/LUFA-git -I../../tmk_core/common -std=gnu99 -include config.h -MMD -MP -MF .dep/obj_alps64_protocol_lufa_lufa.o.d  ../../tmk_core/protocol/lufa/lufa.c -o obj_alps64/protocol/lufa/lufa.o
 130 ../../tmk_core/protocol/lufa/lufa.c: In function 'setup_mcu':
 131 ../../tmk_core/protocol/lufa/lufa.c:575: warning: implicit declaration of function 'clock_prescale_set'
 132 ../../tmk_core/protocol/lufa/lufa.c:575: error: 'clock_div_1' undeclared (first use in this function)
 133 ../../tmk_core/protocol/lufa/lufa.c:575: error: (Each undeclared identifier is reported only once
 134 ../../tmk_core/protocol/lufa/lufa.c:575: error: for each function it appears in.)
 135 make: *** [obj_alps64/protocol/lufa/lufa.o] Error 1
 136 ```