docs/faq_build.md

   1 # Frequently Asked Build Questions
   2
   3 This page covers questions about building QMK. If you have not yet you should read the [Build Guide](https://github.com/qmk/qmk_firmware/blob/master/docs/build_guide.md).
   4
   5 In short,
   6
   7     $ make [-f Makefile.<variant>] [KEYMAP=...] clean
   8     $ make [-f Makefile.<variant>] [KEYMAP=...]
   9     $ make [-f Makefile.<variant>] [KEYMAP=...] dfu
  10
  11
  12 ## Can't program on Linux
  13 You will need proper permission to operate a device. For Linux users see udev rules below.
  14 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.
  15
  16 In short when your controller is ATMega32u4,
  17
  18     $ sudo dfu-programmer atmega32u4 erase --force
  19     $ sudo dfu-programmer atmega32u4 flash your.hex
  20     $ sudo dfu-programmer atmega32u4 reset
  21
  22 or just
  23
  24     $ sudo make dfu
  25
  26 But to run `make` with root privilege is not good idea. Use former method as possible.
  27
  28 ## WINAVR is obsolete
  29 It is no longer recommended and may cause some problem.
  30 See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).
  31
  32 ## USB VID and PID
  33 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.
  34
  35 Most boards in QMK use `0xFEED` as the vendor ID. You should look through other keyboards to make sure you pick a unique Product ID.
  36
  37 Also see this.
  38 https://github.com/tmk/tmk_keyboard/issues/150
  39
  40 You can buy a really unique VID:PID here. I don't think you need this for personal use.
  41 - http://www.obdev.at/products/vusb/license.html
  42 - http://www.mcselec.com/index.php?page=shop.product_details&flypage=shop.flypage&product_id=92&option=com_phpshop&Itemid=1
  43
  44
  45 ## Linux udev rules
  46 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/`.
  47
  48 **/etc/udev/rules.d/50-atmel-dfu.rules:**
  49 ```
  50 # Atmel ATMega32U4
  51 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff4", MODE:="0666"
  52 # Atmel USBKEY AT90USB1287
  53 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ffb", MODE:="0666"
  54 # Atmel ATMega32U2
  55 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff0", MODE:="0666"
  56 ```
  57
  58 **/etc/udev/rules.d/52-tmk-keyboard.rules:**
  59 ```
  60 # tmk keyboard products     https://github.com/tmk/tmk_keyboard
  61 SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
  62 ```
  63
  64
  65 ## Cortex: cstddef: No such file or directory
  66 GCC 4.8 of Ubuntu 14.04 had this problem and had to update to 4.9 with this PPA.
  67 https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded
  68
  69 https://github.com/tmk/tmk_keyboard/issues/212
  70 https://github.com/tmk/tmk_keyboard/wiki/mbed-cortex-porting#compile-error-cstddef
  71 https://developer.mbed.org/forum/mbed/topic/5205/
  72
  73
  74 ## 'clock_prescale_set' and 'clock_div_1' not available
  75 Your toolchain is too old to support the MCU. For example WinAVR 20100110 doesn't support ATMega32u2.
  76
  77 ```
  78 Compiling C: ../../tmk_core/protocol/lufa/lufa.c
  79 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
  80 ../../tmk_core/protocol/lufa/lufa.c: In function 'setup_mcu':
  81 ../../tmk_core/protocol/lufa/lufa.c:575: warning: implicit declaration of function 'clock_prescale_set'
  82 ../../tmk_core/protocol/lufa/lufa.c:575: error: 'clock_div_1' undeclared (first use in this function)
  83 ../../tmk_core/protocol/lufa/lufa.c:575: error: (Each undeclared identifier is reported only once
  84 ../../tmk_core/protocol/lufa/lufa.c:575: error: for each function it appears in.)
  85 make: *** [obj_alps64/protocol/lufa/lufa.o] Error 1
  86 ```
  87
  88
  89 ## BOOTLOADER_SIZE for AVR
  90 Note that Teensy2.0++ bootloader size is 2048byte. Some Makefiles may have wrong comment.
  91
  92 ```
  93 # Boot Section Size in *bytes*
  94 #   Teensy halfKay   512
  95 #   Teensy++ halfKay 2048
  96 #   Atmel DFU loader 4096       (TMK Alt Controller)
  97 #   LUFA bootloader  4096
  98 #   USBaspLoader     2048
  99 OPT_DEFS += -DBOOTLOADER_SIZE=2048
 100 ```