aboutsummaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli/doctor.py
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2020-09-27 20:36:33 +1000
committerGitHub <noreply@github.com>2020-09-27 20:36:33 +1000
commite7acd39b78a7cb81b258044dd190dc5bda55d120 (patch)
tree0935e361916e9acc7c81b2f9e7a7c1f1a57bd79b /lib/python/qmk/cli/doctor.py
parent70fce6564fe691912387d09344efa1d1ce5b949e (diff)
parenta0305f5e7e1ffc19ef2dba077d000915f2fdf35b (diff)
downloadqmk_firmware-e7acd39b78a7cb81b258044dd190dc5bda55d120.tar.gz
qmk_firmware-e7acd39b78a7cb81b258044dd190dc5bda55d120.zip
Consolidate udev rules into a single file (#9693)
* Consolidate udev rules into a single file * Update rules in doctor.py * Simplify doctor rule checking * Fix errors * Add TMK "FEED" VID to list of deprecated udev rules * A comma would be nice * Split rules back up into bootloaders * Link to docs page in "missing" case * Add Pololu VID * Be more specific about Caterina devices, and add LilyPad PID
Diffstat (limited to 'lib/python/qmk/cli/doctor.py')
-rwxr-xr-xlib/python/qmk/cli/doctor.py57
1 files changed, 45 insertions, 12 deletions
diff --git a/lib/python/qmk/cli/doctor.py b/lib/python/qmk/cli/doctor.py
index 920615396..bad864f72 100755
--- a/lib/python/qmk/cli/doctor.py
+++ b/lib/python/qmk/cli/doctor.py
@@ -150,25 +150,58 @@ def check_udev_rules():
150 ok = True 150 ok = True
151 udev_dir = Path("/etc/udev/rules.d/") 151 udev_dir = Path("/etc/udev/rules.d/")
152 desired_rules = { 152 desired_rules = {
153 'dfu': {_udev_rule("03eb", "2ff4"), _udev_rule("03eb", "2ffb"), _udev_rule("03eb", "2ff0")}, 153 'atmel-dfu': {
154 'input_club': {_udev_rule("1c11", "b007")}, 154 _udev_rule("03EB", "2FEF"), # ATmega16U2
155 'stm32': {_udev_rule("1eaf", "0003"), _udev_rule("0483", "df11")}, 155 _udev_rule("03EB", "2FF0"), # ATmega32U2
156 'bootloadhid': {_udev_rule("16c0", "05df")}, 156 _udev_rule("03EB", "2FF3"), # ATmega16U4
157 _udev_rule("03EB", "2FF4"), # ATmega32U4
158 _udev_rule("03EB", "2FF9"), # AT90USB64
159 _udev_rule("03EB", "2FFB") # AT90USB128
160 },
161 'kiibohd': {
162 _udev_rule("1C11", "B007")
163 },
164 'stm32': {
165 _udev_rule("1EAF", "0003"), # STM32duino
166 _udev_rule("0483", "DF11") # STM32 DFU
167 },
168 'bootloadhid': {
169 _udev_rule("16C0", "05DF")
170 },
171 'usbasploader': {
172 _udev_rule("16C0", "05DC")
173 },
174 'massdrop': {
175 _udev_rule("03EB", "6124")
176 },
157 'caterina': { 177 'caterina': {
158 _udev_rule("2341", "0036", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), 178 # Spark Fun Electronics
159 _udev_rule("1b4f", "9205", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), 179 _udev_rule("1B4F", "9203", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), # Pro Micro 3V3/8MHz
160 _udev_rule("1b4f", "9203", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), 180 _udev_rule("1B4F", "9205", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), # Pro Micro 5V/16MHz
161 _udev_rule("2a03", "0036", 'ENV{ID_MM_DEVICE_IGNORE}="1"') 181 _udev_rule("1B4F", "9207", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), # LilyPad 3V3/8MHz (and some Pro Micro clones)
182 # Pololu Electronics
183 _udev_rule("1FFB", "0101", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), # A-Star 32U4
184 # Arduino SA
185 _udev_rule("2341", "0036", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), # Leonardo
186 _udev_rule("2341", "0037", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), # Micro
187 # Adafruit Industries LLC
188 _udev_rule("239A", "000C", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), # Feather 32U4
189 _udev_rule("239A", "000D", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), # ItsyBitsy 32U4 3V3/8MHz
190 _udev_rule("239A", "000E", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), # ItsyBitsy 32U4 5V/16MHz
191 # dog hunter AG
192 _udev_rule("2A03", "0036", 'ENV{ID_MM_DEVICE_IGNORE}="1"'), # Leonardo
193 _udev_rule("2A03", "0037", 'ENV{ID_MM_DEVICE_IGNORE}="1"') # Micro
162 } 194 }
163 } 195 }
164 196
165 # These rules are no longer recommended, only use them to check for their presence. 197 # These rules are no longer recommended, only use them to check for their presence.
166 deprecated_rules = { 198 deprecated_rules = {
167 'dfu': {_deprecated_udev_rule("03eb", "2ff4"), _deprecated_udev_rule("03eb", "2ffb"), _deprecated_udev_rule("03eb", "2ff0")}, 199 'atmel-dfu': {_deprecated_udev_rule("03eb", "2ff4"), _deprecated_udev_rule("03eb", "2ffb"), _deprecated_udev_rule("03eb", "2ff0")},
168 'input_club': {_deprecated_udev_rule("1c11")}, 200 'kiibohd': {_deprecated_udev_rule("1c11")},
169 'stm32': {_deprecated_udev_rule("1eaf", "0003"), _deprecated_udev_rule("0483", "df11")}, 201 'stm32': {_deprecated_udev_rule("1eaf", "0003"), _deprecated_udev_rule("0483", "df11")},
170 'bootloadhid': {_deprecated_udev_rule("16c0", "05df")}, 202 'bootloadhid': {_deprecated_udev_rule("16c0", "05df")},
171 'caterina': {'ATTRS{idVendor}=="2a03", ENV{ID_MM_DEVICE_IGNORE}="1"', 'ATTRS{idVendor}=="2341", ENV{ID_MM_DEVICE_IGNORE}="1"'} 203 'caterina': {'ATTRS{idVendor}=="2a03", ENV{ID_MM_DEVICE_IGNORE}="1"', 'ATTRS{idVendor}=="2341", ENV{ID_MM_DEVICE_IGNORE}="1"'},
204 'tmk': {_deprecated_udev_rule("feed")}
172 } 205 }
173 206
174 if udev_dir.exists(): 207 if udev_dir.exists():
@@ -194,7 +227,7 @@ def check_udev_rules():
194 if deprecated_rule and deprecated_rule.issubset(current_rules): 227 if deprecated_rule and deprecated_rule.issubset(current_rules):
195 cli.log.warn("{bg_yellow}Found old, deprecated udev rules for '%s' boards. The new rules on https://docs.qmk.fm/#/faq_build?id=linux-udev-rules offer better security with the same functionality.", bootloader) 228 cli.log.warn("{bg_yellow}Found old, deprecated udev rules for '%s' boards. The new rules on https://docs.qmk.fm/#/faq_build?id=linux-udev-rules offer better security with the same functionality.", bootloader)
196 else: 229 else:
197 cli.log.warn("{bg_yellow}Missing udev rules for '%s' boards. You'll need to use `sudo` in order to flash them.", bootloader) 230 cli.log.warn("{bg_yellow}Missing udev rules for '%s' boards. See https://docs.qmk.fm/#/faq_build?id=linux-udev-rules for more details.", bootloader)
198 231
199 return ok 232 return ok
200 233