1 # Frequently Asked Build Questions
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.
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).
8 An example of using `sudo`, when your controller is ATMega32u4:
10 $ sudo dfu-programmer atmega32u4 erase --force
11 $ sudo dfu-programmer atmega32u4 flash your.hex
12 $ sudo dfu-programmer atmega32u4 reset
16 $ sudo make <keyboard>:<keymap>:dfu
18 Note that running `make` with `sudo` is generally ***not*** a good idea, and you should use one of the former methods, if possible.
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:
24 sudo udevadm control --reload-rules
28 **/etc/udev/rules.d/50-atmel-dfu.rules:**
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"
35 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff0", MODE:="0666"
38 **/etc/udev/rules.d/52-tmk-keyboard.rules:**
40 # tmk keyboard products https://github.com/tmk/tmk_keyboard
41 SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
43 **/etc/udev/rules.d/54-input-club-keyboard.rules:**
46 # Input Club keyboard bootloader
47 SUBSYSTEMS=="usb", ATTRS{idVendor}=="1c11", MODE:="0666"
50 **/etc/udev/rules.d/55-caterina.rules:**
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"
57 **Note:** ModemManager filtering only works when not in strict mode, the following commands can update that settings:
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
64 **/etc/udev/rules.d/56-dfu-util.rules:**
67 SUBSYSTEMS=="usb", ATTRS{idVendor}=="1eaf", ATTRS{idProduct}=="0003", MODE:="0666"
69 SUBSYSTEMS=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="df11", MODE:="0666"
72 **/etc/udev/rules.d/57-bootloadhid.rules:**
75 SUBSYSTEMS=="usb", ATTRS{idVendor}=="16c0", ATTRS{idProduct}=="05df", MODE:="0666"
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.
82 ## Unknown Device for DFU Bootloader
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.
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.
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.
91 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.
93 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.
96 https://github.com/tmk/tmk_keyboard/issues/150
98 You can buy a really unique VID:PID here. I don't think you need this for personal use.
99 - http://www.obdev.at/products/vusb/license.html
100 - http://www.mcselec.com/index.php?page=shop.product_details&flypage=shop.flypage&product_id=92&option=com_phpshop&Itemid=1
102 ## Cortex: `cstddef: No such file or directory`
103 GCC 4.8 of Ubuntu 14.04 had this problem and had to update to 4.9 with this PPA.
104 https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded
106 https://github.com/tmk/tmk_keyboard/issues/212
107 https://github.com/tmk/tmk_keyboard/wiki/mbed-cortex-porting#compile-error-cstddef
108 https://developer.mbed.org/forum/mbed/topic/5205/
110 ## BOOTLOADER_SIZE for AVR
111 Note that Teensy2.0++ bootloader size is 2048byte. Some Makefiles may have wrong comment.
114 # Boot Section Size in *bytes*
116 # Teensy++ halfKay 2048
117 # Atmel DFU loader 4096 (TMK Alt Controller)
118 # LUFA bootloader 4096
120 OPT_DEFS += -DBOOTLOADER_SIZE=2048
123 ## `avr-gcc: internal compiler error: Abort trap: 6 (program cc1)` on MacOS
124 This is an issue with updating on brew, causing symlinks that avr-gcc depend on getting mangled.
126 The solution is to remove and reinstall all affected modules.
130 brew rm dfu-programmer
132 brew rm gcc-arm-none-eabi
135 brew install dfu-programmer
136 brew install dfu-util
137 brew install gcc-arm-none-eabi
141 ### avr-gcc 8.1 and LUFA
143 If you updated your avr-gcc to above 7 you may see errors involving LUFA. For example:
145 `lib/lufa/LUFA/Drivers/USB/Class/Device/AudioClassDevice.h:380:5: error: 'const' attribute on function returning 'void'`
147 For now, you need to rollback avr-gcc to 7 in brew.
150 brew uninstall --force avr-gcc
151 brew install avr-gcc@8
152 brew link --force avr-gcc@8
155 ### 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)
156 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.
158 [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.
159 [Preonic rev3 reset EEPROM](https://cdn.discordapp.com/attachments/473506116718952450/537849497313738762/preonic_rev3_default.bin)
161 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).