You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

91 lines
4.6 KiB

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