aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2019-08-01 17:20:31 +0100
committerDrashna Jaelre <drashna@live.com>2019-08-01 09:20:31 -0700
commitb5677853453d7fa1a9c15c2fed5e4fd1d8258b58 (patch)
tree81026f4d732bfee026e2cb95629a53463d1c7b0b
parent9177c6fedd2f4731b0cdf069910d6449a66e1333 (diff)
downloadqmk_firmware-b5677853453d7fa1a9c15c2fed5e4fd1d8258b58.tar.gz
qmk_firmware-b5677853453d7fa1a9c15c2fed5e4fd1d8258b58.zip
[Docs] Add dfu-util and caterina udev examples (#6429)
-rw-r--r--docs/faq_build.md28
1 files changed, 27 insertions, 1 deletions
diff --git a/docs/faq_build.md b/docs/faq_build.md
index bcf017a9b..3fe358eda 100644
--- a/docs/faq_build.md
+++ b/docs/faq_build.md
@@ -19,7 +19,11 @@ Note that running `make` with `sudo` is generally ***not*** a good idea, and you
19 19
20### Linux `udev` Rules 20### Linux `udev` Rules
21On Linux, you'll need proper privileges to access the MCU. You can either use 21On 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/`. 22`sudo` when flashing firmware, or place these files in `/etc/udev/rules.d/`. Once added run the following:
23```console
24sudo udevadm control --reload-rules
25sudo udevadm trigger
26```
23 27
24**/etc/udev/rules.d/50-atmel-dfu.rules:** 28**/etc/udev/rules.d/50-atmel-dfu.rules:**
25``` 29```
@@ -43,6 +47,28 @@ SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
43SUBSYSTEMS=="usb", ATTRS{idVendor}=="1c11", MODE:="0666" 47SUBSYSTEMS=="usb", ATTRS{idVendor}=="1c11", MODE:="0666"
44``` 48```
45 49
50**/etc/udev/rules.d/55-catalina.rules:**
51```
52# ModemManager should ignore the following devices
53ATTRS{idVendor}=="2a03", ENV{ID_MM_DEVICE_IGNORE}="1"
54ATTRS{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
59sudo sed -i 's/--filter-policy=strict/--filter-policy=default/' /lib/systemd/system/ModemManager.service
60sudo systemctl daemon-reload
61sudo systemctl restart ModemManager
62```
63
64**/etc/udev/rules.d/56-dfu-util.rules:**
65```
66# stm32duino
67SUBSYSTEMS=="usb", ATTRS{idVendor}=="1eaf", ATTRS{idProduct}=="0003", MODE:="0666"
68# Generic stm32
69SUBSYSTEMS=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="df11", MODE:="0666"
70```
71
46### Serial device is not detected in bootloader mode on Linux 72### Serial device is not detected in bootloader mode on Linux
47Make sure your kernel has appropriate support for your device. If your device uses USB ACM, such as 73Make sure your kernel has appropriate support for your device. If your device uses USB ACM, such as
48Pro Micro (Atmega32u4), make sure to include `CONFIG_USB_ACM=y`. Other devices may require `USB_SERIAL` and any of its sub options. 74Pro Micro (Atmega32u4), make sure to include `CONFIG_USB_ACM=y`. Other devices may require `USB_SERIAL` and any of its sub options.