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 ## Do 'make clean' before 'make'
  12 You'll need `make clean` after you edit **config.h** or change options like `KEYMAP`.
  13
  14 Frist remove all files made in previous build,
  15
  16     $ make clean
  17
  18 then build new frimware.
  19
  20     $ make [KEYMAP=...]
  21
  22 Also you can always try `make clean` when you get other strange result during build.
  23
  24
  25 ## WINAVR is obsolete
  26 It is no longer recommended and may cause some problem.
  27 See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).
  28
  29 ## USB stack: LUFA or PJRC?
  30 Use **LUFA**.
  31
  32 **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.
  33 See also [Issue #50](https://github.com/tmk/tmk_keyboard/issues/50) and [Issue #58](https://github.com/tmk/tmk_keyboard/issues/58).
  34
  35 ## Edit configuration but not change
  36 You will need followings after editing `CONSOLE_ENABLE`, `NKRO_ENABLE`, `EXTRAKEY_ENABLE` or `MOUSEKEY_ENABLE` option in **Makefile**.
  37
  38 ### 1. make clean
  39 This will be needed when you edit **config.h**.
  40
  41 ### 2. Remove Drivers from Device Manager(Windows)
  42 **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**.
  43
  44 ### 3. Build with different VID:PID
  45 **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.
  46
  47 ### 4. Just try other ports
  48 This will be useful and the easiest workaround for **Windows**.
  49
  50
  51
  52 ## USB VID and PID
  53 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.
  54
  55 For example TMK uses following numbers by default.
  56 ```
  57 keyboard:
  58 hhkb: FEED:CAFE
  59 gh60: FEED:6060
  60
  61 converter:
  62 x68k: FEED:6800
  63 ps2: FEED:6512
  64 adb: FEED:0ADB
  65 ibm4704: FEED:4704
  66 pc98: FEED:9898
  67 ```
  68
  69 Also see this.
  70 https://github.com/tmk/tmk_keyboard/issues/150
  71
  72 You can buy a really unique VID:PID here. I don't think you need this for personal use.
  73 - http://www.obdev.at/products/vusb/license.html
  74 - http://www.mcselec.com/index.php?page=shop.product_details&flypage=shop.flypage&product_id=92&option=com_phpshop&Itemid=1
  75
  76
  77 ## Linux udev rules
  78 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/`.
  79
  80 **/etc/udev/rules.d/50-atmel-dfu.rules:**
  81 ```
  82 # Atmel ATMega32U4
  83 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff4", MODE:="0666"
  84 # Atmel USBKEY AT90USB1287
  85 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ffb", MODE:="0666"
  86 # Atmel ATMega32U2
  87 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff0", MODE:="0666"
  88 ```
  89
  90 **/etc/udev/rules.d/52-tmk-keyboard.rules:**
  91 ```
  92 # tmk keyboard products     https://github.com/tmk/tmk_keyboard
  93 SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
  94 ```
  95
  96
  97
  98 ## Cortex: cstddef: No such file or directory
  99 GCC 4.8 of Ubuntu 14.04 had this problem and had to update to 4.9 with this PPA.
 100 https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded
 101
 102 https://github.com/tmk/tmk_keyboard/issues/212
 103 https://github.com/tmk/tmk_keyboard/wiki/mbed-cortex-porting#compile-error-cstddef
 104 https://developer.mbed.org/forum/mbed/topic/5205/