docs/faq_build.md

   1 # Frequently Asked Build Questions
   2
   3 This page covers questions about building QMK. If you haven't yet done so, you should read the [Build Environment Setup](getting_started_build_tools.md) and [Make Instructions](getting_started_make_guide.md) guides.
   4
   5 ## Can't Program on Linux
   6 You will need proper permissions to operate a device. For Linux users, see the instructions regarding `udev` rules, below. If you have issues with `udev`, a work-around is to use the `sudo` command. If you are not familiar with this command, check its manual with `man sudo` or [see this webpage](https://linux.die.net/man/8/sudo).
   7
   8 An example of using `sudo`, when your controller is ATMega32u4:
   9
  10     $ sudo dfu-programmer atmega32u4 erase --force
  11     $ sudo dfu-programmer atmega32u4 flash your.hex
  12     $ sudo dfu-programmer atmega32u4 reset
  13
  14 or just:
  15
  16     $ sudo make <keyboard>:<keymap>:dfu
  17
  18 Note that running `make` with `sudo` is generally ***not*** a good idea, and you should use one of the former methods, if possible.
  19
  20 ### Linux `udev` Rules
  21 On Linux, you'll need proper privileges to access the MCU. You can either use
  22 `sudo` when flashing firmware, or place these files in `/etc/udev/rules.d/`. Once added run the following:
  23 ```console
  24 sudo udevadm control --reload-rules
  25 sudo udevadm trigger
  26 ```
  27
  28 **/etc/udev/rules.d/50-atmel-dfu.rules:**
  29 ```
  30 # Atmel ATMega32U4
  31 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff4", MODE:="0666"
  32 # Atmel USBKEY AT90USB1287
  33 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ffb", MODE:="0666"
  34 # Atmel ATMega32U2
  35 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff0", MODE:="0666"
  36 ```
  37
  38 **/etc/udev/rules.d/52-tmk-keyboard.rules:**
  39 ```
  40 # tmk keyboard products     https://github.com/tmk/tmk_keyboard
  41 SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
  42 ```
  43 **/etc/udev/rules.d/54-input-club-keyboard.rules:**
  44
  45 ```
  46 # Input Club keyboard bootloader
  47 SUBSYSTEMS=="usb", ATTRS{idVendor}=="1c11", MODE:="0666"
  48 ```
  49
  50 **/etc/udev/rules.d/55-caterina.rules:**
  51 ```
  52 # ModemManager should ignore the following devices
  53 ATTRS{idVendor}=="2a03", ENV{ID_MM_DEVICE_IGNORE}="1"
  54 ATTRS{idVendor}=="2341", ENV{ID_MM_DEVICE_IGNORE}="1"
  55 ```
  56
  57 **Note:** ModemManager filtering only works when not in strict mode, the following commands can update that settings:
  58 ```console
  59 sudo sed -i 's/--filter-policy=strict/--filter-policy=default/' /lib/systemd/system/ModemManager.service
  60 sudo systemctl daemon-reload
  61 sudo systemctl restart ModemManager
  62 ```
  63
  64 **/etc/udev/rules.d/56-dfu-util.rules:**
  65 ```
  66 # stm32duino
  67 SUBSYSTEMS=="usb", ATTRS{idVendor}=="1eaf", ATTRS{idProduct}=="0003", MODE:="0666"
  68 # Generic stm32
  69 SUBSYSTEMS=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="df11", MODE:="0666"
  70 ```
  71
  72 **/etc/udev/rules.d/57-bootloadhid.rules:**
  73 ```
  74 # bootloadHID
  75 SUBSYSTEMS=="usb", ATTRS{idVendor}=="16c0", ATTRS{idProduct}=="05df", MODE:="0666"
  76 ```
  77
  78 ### Serial device is not detected in bootloader mode on Linux
  79 Make sure your kernel has appropriate support for your device. If your device uses USB ACM, such as
  80 Pro Micro (Atmega32u4), make sure to include `CONFIG_USB_ACM=y`. Other devices may require `USB_SERIAL` and any of its sub options.
  81
  82 ## Unknown Device for DFU Bootloader
  83
  84 Issues encountered when flashing keyboards on Windows are most often due to having the wrong drivers installed for the bootloader, or none at all.
  85
  86 Re-running the QMK installation script (`./util/qmk_install.sh` from the `qmk_firmware` directory in MSYS2 or WSL) or reinstalling the QMK Toolbox may fix the issue. Alternatively, you can download and run the [`qmk_driver_installer`](https://github.com/qmk/qmk_driver_installer) package manually.
  87
  88 If that doesn't work, then you may need to download and run Zadig. See [Bootloader Driver Installation with Zadig](driver_installation_zadig.md) for more detailed information.
  89
  90 ## WINAVR is Obsolete
  91 It is no longer recommended and may cause some problem.
  92 See [TMK Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).
  93
  94 ## USB VID and PID
  95 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.
  96
  97 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.
  98
  99 Also see this.
 100 https://github.com/tmk/tmk_keyboard/issues/150
 101
 102 You can buy a really unique VID:PID here. I don't think you need this for personal use.
 103 - http://www.obdev.at/products/vusb/license.html
 104 - http://www.mcselec.com/index.php?page=shop.product_details&flypage=shop.flypage&product_id=92&option=com_phpshop&Itemid=1
 105
 106 ## Cortex: `cstddef: No such file or directory`
 107 GCC 4.8 of Ubuntu 14.04 had this problem and had to update to 4.9 with this PPA.
 108 https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded
 109
 110 https://github.com/tmk/tmk_keyboard/issues/212
 111 https://github.com/tmk/tmk_keyboard/wiki/mbed-cortex-porting#compile-error-cstddef
 112 https://developer.mbed.org/forum/mbed/topic/5205/
 113
 114 ## `clock_prescale_set` and `clock_div_1` Not Available
 115 Your toolchain is too old to support the MCU. For example WinAVR 20100110 doesn't support ATMega32u2.
 116
 117 ```
 118 Compiling C: ../../tmk_core/protocol/lufa/lufa.c
 119 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
 120 ../../tmk_core/protocol/lufa/lufa.c: In function 'setup_mcu':
 121 ../../tmk_core/protocol/lufa/lufa.c:575: warning: implicit declaration of function 'clock_prescale_set'
 122 ../../tmk_core/protocol/lufa/lufa.c:575: error: 'clock_div_1' undeclared (first use in this function)
 123 ../../tmk_core/protocol/lufa/lufa.c:575: error: (Each undeclared identifier is reported only once
 124 ../../tmk_core/protocol/lufa/lufa.c:575: error: for each function it appears in.)
 125 make: *** [obj_alps64/protocol/lufa/lufa.o] Error 1
 126 ```
 127
 128
 129 ## BOOTLOADER_SIZE for AVR
 130 Note that Teensy2.0++ bootloader size is 2048byte. Some Makefiles may have wrong comment.
 131
 132 ```
 133 # Boot Section Size in *bytes*
 134 #   Teensy halfKay   512
 135 #   Teensy++ halfKay 2048
 136 #   Atmel DFU loader 4096       (TMK Alt Controller)
 137 #   LUFA bootloader  4096
 138 #   USBaspLoader     2048
 139 OPT_DEFS += -DBOOTLOADER_SIZE=2048
 140 ```
 141
 142 ## `avr-gcc: internal compiler error: Abort trap: 6 (program cc1)` on MacOS
 143 This is an issue with updating on brew, causing symlinks that avr-gcc depend on getting mangled.
 144
 145 The solution is to remove and reinstall all affected modules.
 146
 147 ```
 148 brew rm avr-gcc
 149 brew rm dfu-programmer
 150 brew rm dfu-util
 151 brew rm gcc-arm-none-eabi
 152 brew rm avrdude
 153 brew install avr-gcc
 154 brew install dfu-programmer
 155 brew install dfu-util
 156 brew install gcc-arm-none-eabi
 157 brew install avrdude
 158 ```
 159
 160 ### avr-gcc 8.1 and LUFA
 161
 162 If you updated your avr-gcc to above 7 you may see errors involving LUFA. For example:
 163
 164 `lib/lufa/LUFA/Drivers/USB/Class/Device/AudioClassDevice.h:380:5: error: 'const' attribute on function returning 'void'`
 165
 166 For now, you need to rollback avr-gcc to 7 in brew.
 167
 168 ```
 169 brew uninstall --force avr-gcc
 170 brew install avr-gcc@8
 171 brew link --force avr-gcc@8
 172 ```
 173
 174 ### I just flashed my keyboard and it does nothing/keypresses don't register - it's also ARM (rev6 planck, clueboard 60, hs60v2, etc...) (Feb 2019)
 175 Due to how EEPROM works on ARM based chips, saved settings may no longer be valid.  This affects the default layers, and *may*, under certain circumstances we are still figuring out, make the keyboard unusable.  Resetting the EEPROM will correct this.
 176
 177 [Planck rev6 reset EEPROM](https://cdn.discordapp.com/attachments/473506116718952450/539284620861243409/planck_rev6_default.bin) can be used to force an eeprom reset. After flashing this image, flash your normal firmware again which should restore your keyboard to _normal_ working order.
 178 [Preonic rev3 reset EEPROM](https://cdn.discordapp.com/attachments/473506116718952450/537849497313738762/preonic_rev3_default.bin)
 179
 180 If bootmagic is enabled in any form, you should be able to do this too (see [Bootmagic docs](feature_bootmagic.md) and keyboard info for specifics on how to do this).