diff options
| -rw-r--r-- | build_keyboard.mk | 19 | ||||
| -rw-r--r-- | docs/cli_commands.md | 48 | ||||
| -rw-r--r-- | docs/hardware_keyboard_guidelines.md | 28 | ||||
| -rw-r--r-- | lib/python/qmk/cli/__init__.py | 1 | ||||
| -rw-r--r-- | lib/python/qmk/cli/console.py | 303 | ||||
| -rw-r--r-- | lib/python/qmk/cli/lint.py | 145 |
6 files changed, 148 insertions, 396 deletions
diff --git a/build_keyboard.mk b/build_keyboard.mk index 37fa6852f..420643c3e 100644 --- a/build_keyboard.mk +++ b/build_keyboard.mk | |||
| @@ -115,6 +115,7 @@ include $(INFO_RULES_MK) | |||
| 115 | # Check for keymap.json first, so we can regenerate keymap.c | 115 | # Check for keymap.json first, so we can regenerate keymap.c |
| 116 | include build_json.mk | 116 | include build_json.mk |
| 117 | 117 | ||
| 118 | # Pull in keymap level rules.mk | ||
| 118 | ifeq ("$(wildcard $(KEYMAP_PATH))", "") | 119 | ifeq ("$(wildcard $(KEYMAP_PATH))", "") |
| 119 | # Look through the possible keymap folders until we find a matching keymap.c | 120 | # Look through the possible keymap folders until we find a matching keymap.c |
| 120 | ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.c)","") | 121 | ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.c)","") |
| @@ -345,6 +346,7 @@ ifeq ("$(USER_NAME)","") | |||
| 345 | endif | 346 | endif |
| 346 | USER_PATH := users/$(USER_NAME) | 347 | USER_PATH := users/$(USER_NAME) |
| 347 | 348 | ||
| 349 | # Pull in user level rules.mk | ||
| 348 | -include $(USER_PATH)/rules.mk | 350 | -include $(USER_PATH)/rules.mk |
| 349 | ifneq ("$(wildcard $(USER_PATH)/config.h)","") | 351 | ifneq ("$(wildcard $(USER_PATH)/config.h)","") |
| 350 | CONFIG_H += $(USER_PATH)/config.h | 352 | CONFIG_H += $(USER_PATH)/config.h |
| @@ -356,6 +358,23 @@ endif | |||
| 356 | # Disable features that a keyboard doesn't support | 358 | # Disable features that a keyboard doesn't support |
| 357 | -include disable_features.mk | 359 | -include disable_features.mk |
| 358 | 360 | ||
| 361 | # Pull in post_rules.mk files from all our subfolders | ||
| 362 | ifneq ("$(wildcard $(KEYBOARD_PATH_1)/post_rules.mk)","") | ||
| 363 | include $(KEYBOARD_PATH_1)/post_rules.mk | ||
| 364 | endif | ||
| 365 | ifneq ("$(wildcard $(KEYBOARD_PATH_2)/post_rules.mk)","") | ||
| 366 | include $(KEYBOARD_PATH_2)/post_rules.mk | ||
| 367 | endif | ||
| 368 | ifneq ("$(wildcard $(KEYBOARD_PATH_3)/post_rules.mk)","") | ||
| 369 | include $(KEYBOARD_PATH_3)/post_rules.mk | ||
| 370 | endif | ||
| 371 | ifneq ("$(wildcard $(KEYBOARD_PATH_4)/post_rules.mk)","") | ||
| 372 | include $(KEYBOARD_PATH_4)/post_rules.mk | ||
| 373 | endif | ||
| 374 | ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_rules.mk)","") | ||
| 375 | include $(KEYBOARD_PATH_5)/post_rules.mk | ||
| 376 | endif | ||
| 377 | |||
| 359 | ifneq ("$(wildcard $(KEYMAP_PATH)/config.h)","") | 378 | ifneq ("$(wildcard $(KEYMAP_PATH)/config.h)","") |
| 360 | CONFIG_H += $(KEYMAP_PATH)/config.h | 379 | CONFIG_H += $(KEYMAP_PATH)/config.h |
| 361 | endif | 380 | endif |
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 8fa7ad41d..06568afb4 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -118,54 +118,6 @@ This command lets you configure the behavior of QMK. For the full `qmk config` d | |||
| 118 | qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] | 118 | qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] |
| 119 | ``` | 119 | ``` |
| 120 | 120 | ||
| 121 | ## `qmk console` | ||
| 122 | |||
| 123 | This command lets you connect to keyboard consoles to get debugging messages. It only works if your keyboard firmware has been compiled with `CONSOLE_ENABLE=yes`. | ||
| 124 | |||
| 125 | **Usage**: | ||
| 126 | |||
| 127 | ``` | ||
| 128 | qmk console [-d <pid>:<vid>[:<index>]] [-l] [-n] [-t] [-w <seconds>] | ||
| 129 | ``` | ||
| 130 | |||
| 131 | **Examples**: | ||
| 132 | |||
| 133 | Connect to all available keyboards and show their console messages: | ||
| 134 | |||
| 135 | ``` | ||
| 136 | qmk console | ||
| 137 | ``` | ||
| 138 | |||
| 139 | List all devices: | ||
| 140 | |||
| 141 | ``` | ||
| 142 | qmk console -l | ||
| 143 | ``` | ||
| 144 | |||
| 145 | Show only messages from clueboard/66/rev3 keyboards: | ||
| 146 | |||
| 147 | ``` | ||
| 148 | qmk console -d C1ED:2370 | ||
| 149 | ``` | ||
| 150 | |||
| 151 | Show only messages from the second clueboard/66/rev3: | ||
| 152 | |||
| 153 | ``` | ||
| 154 | qmk console -d C1ED:2370:2 | ||
| 155 | ``` | ||
| 156 | |||
| 157 | Show timestamps and VID:PID instead of names: | ||
| 158 | |||
| 159 | ``` | ||
| 160 | qmk console -n -t | ||
| 161 | ``` | ||
| 162 | |||
| 163 | Disable bootloader messages: | ||
| 164 | |||
| 165 | ``` | ||
| 166 | qmk console --no-bootloaders | ||
| 167 | ``` | ||
| 168 | |||
| 169 | ## `qmk doctor` | 121 | ## `qmk doctor` |
| 170 | 122 | ||
| 171 | This command examines your environment and alerts you to potential build or flash problems. It can fix many of them if you want it to. | 123 | This command examines your environment and alerts you to potential build or flash problems. It can fix many of them if you want it to. |
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md index 7630b44e0..17be7ee6a 100644 --- a/docs/hardware_keyboard_guidelines.md +++ b/docs/hardware_keyboard_guidelines.md | |||
| @@ -144,10 +144,38 @@ The `rules.mk` file can also be placed in a sub-folder, and its reading order is | |||
| 144 | * `keyboards/top_folder/sub_1/sub_2/sub_3/sub_4/rules.mk` | 144 | * `keyboards/top_folder/sub_1/sub_2/sub_3/sub_4/rules.mk` |
| 145 | * `keyboards/top_folder/keymaps/a_keymap/rules.mk` | 145 | * `keyboards/top_folder/keymaps/a_keymap/rules.mk` |
| 146 | * `users/a_user_folder/rules.mk` | 146 | * `users/a_user_folder/rules.mk` |
| 147 | * `keyboards/top_folder/sub_1/sub_2/sub_3/sub_4/post_rules.mk` | ||
| 148 | * `keyboards/top_folder/sub_1/sub_2/sub_3/post_rules.mk` | ||
| 149 | * `keyboards/top_folder/sub_1/sub_2/post_rules.mk` | ||
| 150 | * `keyboards/top_folder/sub_1/post_rules.mk` | ||
| 151 | * `keyboards/top_folder/post_rules.mk` | ||
| 147 | * `common_features.mk` | 152 | * `common_features.mk` |
| 148 | 153 | ||
| 149 | Many of the settings written in the `rules.mk` file are interpreted by `common_features.mk`, which sets the necessary source files and compiler options. | 154 | Many of the settings written in the `rules.mk` file are interpreted by `common_features.mk`, which sets the necessary source files and compiler options. |
| 150 | 155 | ||
| 156 | The `post_rules.mk` file can interpret `features` of a keyboard-level before `common_features.mk`. For example, when your designed keyboard has the option to implement backlighting or underglow using rgblight.c, writing the following in the `post_rules.mk` makes it easier for the user to configure the `rules.mk`. | ||
| 157 | |||
| 158 | * `keyboards/top_folder/keymaps/a_keymap/rules.mk` | ||
| 159 | ```makefile | ||
| 160 | # Please set the following according to the selection of the hardware implementation option. | ||
| 161 | RGBLED_OPTION_TYPE = backlight ## none, backlight or underglow | ||
| 162 | ``` | ||
| 163 | * `keyboards/top_folder/post_rules.mk` | ||
| 164 | ```makefile | ||
| 165 | ifeq ($(filter $(strip $(RGBLED_OPTION_TYPE))x, nonex backlightx underglowx x),) | ||
| 166 | $(error unknown RGBLED_OPTION_TYPE value "$(RGBLED_OPTION_TYPE)") | ||
| 167 | endif | ||
| 168 | |||
| 169 | ifeq ($(strip $(RGBLED_OPTION_TYPE)),backlight) | ||
| 170 | RGBLIGHT_ENABLE = yes | ||
| 171 | OPT_DEFS += -DRGBLED_NUM=30 | ||
| 172 | endif | ||
| 173 | ifeq ($(strip $(RGBLED_OPTION_TYPE)),underglow) | ||
| 174 | RGBLIGHT_ENABLE = yes | ||
| 175 | OPT_DEFS += -DRGBLED_NUM=6 | ||
| 176 | endif | ||
| 177 | ``` | ||
| 178 | |||
| 151 | ?> See `build_keyboard.mk` and `common_features.mk` for more details. | 179 | ?> See `build_keyboard.mk` and `common_features.mk` for more details. |
| 152 | 180 | ||
| 153 | ### `<keyboard_name.c>` | 181 | ### `<keyboard_name.c>` |
diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py index f45e33240..292dcbe81 100644 --- a/lib/python/qmk/cli/__init__.py +++ b/lib/python/qmk/cli/__init__.py | |||
| @@ -35,7 +35,6 @@ subcommands = [ | |||
| 35 | 'qmk.cli.chibios.confmigrate', | 35 | 'qmk.cli.chibios.confmigrate', |
| 36 | 'qmk.cli.clean', | 36 | 'qmk.cli.clean', |
| 37 | 'qmk.cli.compile', | 37 | 'qmk.cli.compile', |
| 38 | 'qmk.cli.console', | ||
| 39 | 'qmk.cli.docs', | 38 | 'qmk.cli.docs', |
| 40 | 'qmk.cli.doctor', | 39 | 'qmk.cli.doctor', |
| 41 | 'qmk.cli.fileformat', | 40 | 'qmk.cli.fileformat', |
diff --git a/lib/python/qmk/cli/console.py b/lib/python/qmk/cli/console.py deleted file mode 100644 index 3c508160e..000000000 --- a/lib/python/qmk/cli/console.py +++ /dev/null | |||
| @@ -1,303 +0,0 @@ | |||
| 1 | """Acquire debugging information from usb hid devices | ||
| 2 | |||
| 3 | cli implementation of https://www.pjrc.com/teensy/hid_listen.html | ||
| 4 | """ | ||
| 5 | from pathlib import Path | ||
| 6 | from threading import Thread | ||
| 7 | from time import sleep, strftime | ||
| 8 | |||
| 9 | import hid | ||
| 10 | import usb.core | ||
| 11 | |||
| 12 | from milc import cli | ||
| 13 | |||
| 14 | LOG_COLOR = { | ||
| 15 | 'next': 0, | ||
| 16 | 'colors': [ | ||
| 17 | '{fg_blue}', | ||
| 18 | '{fg_cyan}', | ||
| 19 | '{fg_green}', | ||
| 20 | '{fg_magenta}', | ||
| 21 | '{fg_red}', | ||
| 22 | '{fg_yellow}', | ||
| 23 | ], | ||
| 24 | } | ||
| 25 | |||
| 26 | KNOWN_BOOTLOADERS = { | ||
| 27 | # VID , PID | ||
| 28 | ('03EB', '2FEF'): 'atmel-dfu: ATmega16U2', | ||
| 29 | ('03EB', '2FF0'): 'atmel-dfu: ATmega32U2', | ||
| 30 | ('03EB', '2FF3'): 'atmel-dfu: ATmega16U4', | ||
| 31 | ('03EB', '2FF4'): 'atmel-dfu: ATmega32U4', | ||
| 32 | ('03EB', '2FF9'): 'atmel-dfu: AT90USB64', | ||
| 33 | ('03EB', '2FFA'): 'atmel-dfu: AT90USB162', | ||
| 34 | ('03EB', '2FFB'): 'atmel-dfu: AT90USB128', | ||
| 35 | ('03EB', '6124'): 'Microchip SAM-BA', | ||
| 36 | ('0483', 'DF11'): 'stm32-dfu: STM32 BOOTLOADER', | ||
| 37 | ('16C0', '05DC'): 'USBasp: USBaspLoader', | ||
| 38 | ('16C0', '05DF'): 'bootloadHID: HIDBoot', | ||
| 39 | ('16C0', '0478'): 'halfkay: Teensy Halfkay', | ||
| 40 | ('1B4F', '9203'): 'caterina: Pro Micro 3.3V', | ||
| 41 | ('1B4F', '9205'): 'caterina: Pro Micro 5V', | ||
| 42 | ('1B4F', '9207'): 'caterina: LilyPadUSB', | ||
| 43 | ('1C11', 'B007'): 'kiibohd: Kiibohd DFU Bootloader', | ||
| 44 | ('1EAF', '0003'): 'stm32duino: Maple 003', | ||
| 45 | ('1FFB', '0101'): 'caterina: Polou A-Star 32U4 Bootloader', | ||
| 46 | ('2341', '0036'): 'caterina: Arduino Leonardo', | ||
| 47 | ('2341', '0037'): 'caterina: Arduino Micro', | ||
| 48 | ('239A', '000C'): 'caterina: Adafruit Feather 32U4', | ||
| 49 | ('239A', '000D'): 'caterina: Adafruit ItsyBitsy 32U4 3v', | ||
| 50 | ('239A', '000E'): 'caterina: Adafruit ItsyBitsy 32U4 5v', | ||
| 51 | ('2A03', '0036'): 'caterina: Arduino Leonardo', | ||
| 52 | ('2A03', '0037'): 'caterina: Arduino Micro', | ||
| 53 | ('314B', '0106'): 'apm32-dfu: APM32 DFU ISP Mode', | ||
| 54 | ('03EB', '2067'): 'qmk-hid: HID Bootloader', | ||
| 55 | ('03EB', '2045'): 'lufa-ms: LUFA Mass Storage Bootloader' | ||
| 56 | } | ||
| 57 | |||
| 58 | |||
| 59 | class MonitorDevice(object): | ||
| 60 | def __init__(self, hid_device, numeric): | ||
| 61 | self.hid_device = hid_device | ||
| 62 | self.numeric = numeric | ||
| 63 | self.device = hid.Device(path=hid_device['path']) | ||
| 64 | self.current_line = '' | ||
| 65 | |||
| 66 | cli.log.info('Console Connected: %(color)s%(manufacturer_string)s %(product_string)s{style_reset_all} (%(color)s%(vendor_id)04X:%(product_id)04X:%(index)d{style_reset_all})', hid_device) | ||
| 67 | |||
| 68 | def read(self, size, encoding='ascii', timeout=1): | ||
| 69 | """Read size bytes from the device. | ||
| 70 | """ | ||
| 71 | return self.device.read(size, timeout).decode(encoding) | ||
| 72 | |||
| 73 | def read_line(self): | ||
| 74 | """Read from the device's console until we get a \n. | ||
| 75 | """ | ||
| 76 | while '\n' not in self.current_line: | ||
| 77 | self.current_line += self.read(32).replace('\x00', '') | ||
| 78 | |||
| 79 | lines = self.current_line.split('\n', 1) | ||
| 80 | self.current_line = lines[1] | ||
| 81 | |||
| 82 | return lines[0] | ||
| 83 | |||
| 84 | def run_forever(self): | ||
| 85 | while True: | ||
| 86 | try: | ||
| 87 | message = {**self.hid_device, 'text': self.read_line()} | ||
| 88 | identifier = (int2hex(message['vendor_id']), int2hex(message['product_id'])) if self.numeric else (message['manufacturer_string'], message['product_string']) | ||
| 89 | message['identifier'] = ':'.join(identifier) | ||
| 90 | message['ts'] = '{style_dim}{fg_green}%s{style_reset_all} ' % (strftime(cli.config.general.datetime_fmt),) if cli.args.timestamp else '' | ||
| 91 | |||
| 92 | cli.echo('%(ts)s%(color)s%(identifier)s:%(index)d{style_reset_all}: %(text)s' % message) | ||
| 93 | |||
| 94 | except hid.HIDException: | ||
| 95 | break | ||
| 96 | |||
| 97 | |||
| 98 | class FindDevices(object): | ||
| 99 | def __init__(self, vid, pid, index, numeric): | ||
| 100 | self.vid = vid | ||
| 101 | self.pid = pid | ||
| 102 | self.index = index | ||
| 103 | self.numeric = numeric | ||
| 104 | |||
| 105 | def run_forever(self): | ||
| 106 | """Process messages from our queue in a loop. | ||
| 107 | """ | ||
| 108 | live_devices = {} | ||
| 109 | live_bootloaders = {} | ||
| 110 | |||
| 111 | while True: | ||
| 112 | try: | ||
| 113 | for device in list(live_devices): | ||
| 114 | if not live_devices[device]['thread'].is_alive(): | ||
| 115 | cli.log.info('Console Disconnected: %(color)s%(manufacturer_string)s %(product_string)s{style_reset_all} (%(color)s%(vendor_id)04X:%(product_id)04X:%(index)d{style_reset_all})', live_devices[device]) | ||
| 116 | del live_devices[device] | ||
| 117 | |||
| 118 | for device in self.find_devices(): | ||
| 119 | if device['path'] not in live_devices: | ||
| 120 | device['color'] = LOG_COLOR['colors'][LOG_COLOR['next']] | ||
| 121 | LOG_COLOR['next'] = (LOG_COLOR['next'] + 1) % len(LOG_COLOR['colors']) | ||
| 122 | live_devices[device['path']] = device | ||
| 123 | |||
| 124 | try: | ||
| 125 | monitor = MonitorDevice(device, self.numeric) | ||
| 126 | device['thread'] = Thread(target=monitor.run_forever, daemon=True) | ||
| 127 | |||
| 128 | device['thread'].start() | ||
| 129 | except Exception as e: | ||
| 130 | device['e'] = e | ||
| 131 | device['e_name'] = e.__class__.__name__ | ||
| 132 | cli.log.error("Could not connect to %(color)s%(manufacturer_string)s %(product_string)s{style_reset_all} (%(color)s:%(vendor_id)04X:%(product_id)04X:%(index)d): %(e_name)s: %(e)s", device) | ||
| 133 | if cli.config.general.verbose: | ||
| 134 | cli.log.exception(e) | ||
| 135 | del live_devices[device['path']] | ||
| 136 | |||
| 137 | if cli.args.bootloaders: | ||
| 138 | for device in self.find_bootloaders(): | ||
| 139 | if device.address in live_bootloaders: | ||
| 140 | live_bootloaders[device.address]._qmk_found = True | ||
| 141 | else: | ||
| 142 | name = KNOWN_BOOTLOADERS[(int2hex(device.idVendor), int2hex(device.idProduct))] | ||
| 143 | cli.log.info('Bootloader Connected: {style_bright}{fg_magenta}%s', name) | ||
| 144 | device._qmk_found = True | ||
| 145 | live_bootloaders[device.address] = device | ||
| 146 | |||
| 147 | for device in list(live_bootloaders): | ||
| 148 | if live_bootloaders[device]._qmk_found: | ||
| 149 | live_bootloaders[device]._qmk_found = False | ||
| 150 | else: | ||
| 151 | name = KNOWN_BOOTLOADERS[(int2hex(live_bootloaders[device].idVendor), int2hex(live_bootloaders[device].idProduct))] | ||
| 152 | cli.log.info('Bootloader Disconnected: {style_bright}{fg_magenta}%s', name) | ||
| 153 | del live_bootloaders[device] | ||
| 154 | |||
| 155 | sleep(.1) | ||
| 156 | |||
| 157 | except KeyboardInterrupt: | ||
| 158 | break | ||
| 159 | |||
| 160 | def is_bootloader(self, hid_device): | ||
| 161 | """Returns true if the device in question matches a known bootloader vid/pid. | ||
| 162 | """ | ||
| 163 | return (int2hex(hid_device.idVendor), int2hex(hid_device.idProduct)) in KNOWN_BOOTLOADERS | ||
| 164 | |||
| 165 | def is_console_hid(self, hid_device): | ||
| 166 | """Returns true when the usage page indicates it's a teensy-style console. | ||
| 167 | """ | ||
| 168 | return hid_device['usage_page'] == 0xFF31 and hid_device['usage'] == 0x0074 | ||
| 169 | |||
| 170 | def is_filtered_device(self, hid_device): | ||
| 171 | """Returns True if the device should be included in the list of available consoles. | ||
| 172 | """ | ||
| 173 | return int2hex(hid_device['vendor_id']) == self.vid and int2hex(hid_device['product_id']) == self.pid | ||
| 174 | |||
| 175 | def find_devices_by_report(self, hid_devices): | ||
| 176 | """Returns a list of available teensy-style consoles by doing a brute-force search. | ||
| 177 | |||
| 178 | Some versions of linux don't report usage and usage_page. In that case we fallback to reading the report (possibly inaccurately) ourselves. | ||
| 179 | """ | ||
| 180 | devices = [] | ||
| 181 | |||
| 182 | for device in hid_devices: | ||
| 183 | path = device['path'].decode('utf-8') | ||
| 184 | |||
| 185 | if path.startswith('/dev/hidraw'): | ||
| 186 | number = path[11:] | ||
| 187 | report = Path(f'/sys/class/hidraw/hidraw{number}/device/report_descriptor') | ||
| 188 | |||
| 189 | if report.exists(): | ||
| 190 | rp = report.read_bytes() | ||
| 191 | |||
| 192 | if rp[1] == 0x31 and rp[3] == 0x09: | ||
| 193 | devices.append(device) | ||
| 194 | |||
| 195 | return devices | ||
| 196 | |||
| 197 | def find_bootloaders(self): | ||
| 198 | """Returns a list of available bootloader devices. | ||
| 199 | """ | ||
| 200 | return list(filter(self.is_bootloader, usb.core.find(find_all=True))) | ||
| 201 | |||
| 202 | def find_devices(self): | ||
| 203 | """Returns a list of available teensy-style consoles. | ||
| 204 | """ | ||
| 205 | hid_devices = hid.enumerate() | ||
| 206 | devices = list(filter(self.is_console_hid, hid_devices)) | ||
| 207 | |||
| 208 | if not devices: | ||
| 209 | devices = self.find_devices_by_report(hid_devices) | ||
| 210 | |||
| 211 | if self.vid and self.pid: | ||
| 212 | devices = list(filter(self.is_filtered_device, devices)) | ||
| 213 | |||
| 214 | # Add index numbers | ||
| 215 | device_index = {} | ||
| 216 | for device in devices: | ||
| 217 | id = ':'.join((int2hex(device['vendor_id']), int2hex(device['product_id']))) | ||
| 218 | |||
| 219 | if id not in device_index: | ||
| 220 | device_index[id] = 0 | ||
| 221 | |||
| 222 | device_index[id] += 1 | ||
| 223 | device['index'] = device_index[id] | ||
| 224 | |||
| 225 | return devices | ||
| 226 | |||
| 227 | |||
| 228 | def int2hex(number): | ||
| 229 | """Returns a string representation of the number as hex. | ||
| 230 | """ | ||
| 231 | return "%04X" % number | ||
| 232 | |||
| 233 | |||
| 234 | def list_devices(device_finder): | ||
| 235 | """Show the user a nicely formatted list of devices. | ||
| 236 | """ | ||
| 237 | devices = device_finder.find_devices() | ||
| 238 | |||
| 239 | if devices: | ||
| 240 | cli.log.info('Available devices:') | ||
| 241 | for dev in devices: | ||
| 242 | color = LOG_COLOR['colors'][LOG_COLOR['next']] | ||
| 243 | LOG_COLOR['next'] = (LOG_COLOR['next'] + 1) % len(LOG_COLOR['colors']) | ||
| 244 | cli.log.info("\t%s%s:%s:%d{style_reset_all}\t%s %s", color, int2hex(dev['vendor_id']), int2hex(dev['product_id']), dev['index'], dev['manufacturer_string'], dev['product_string']) | ||
| 245 | |||
| 246 | if cli.args.bootloaders: | ||
| 247 | bootloaders = device_finder.find_bootloaders() | ||
| 248 | |||
| 249 | if bootloaders: | ||
| 250 | cli.log.info('Available Bootloaders:') | ||
| 251 | |||
| 252 | for dev in bootloaders: | ||
| 253 | cli.log.info("\t%s:%s\t%s", int2hex(dev.idVendor), int2hex(dev.idProduct), KNOWN_BOOTLOADERS[(int2hex(dev.idVendor), int2hex(dev.idProduct))]) | ||
| 254 | |||
| 255 | |||
| 256 | @cli.argument('--bootloaders', arg_only=True, default=True, action='store_boolean', help='displaying bootloaders.') | ||
| 257 | @cli.argument('-d', '--device', help='Device to select - uses format <pid>:<vid>[:<index>].') | ||
| 258 | @cli.argument('-l', '--list', arg_only=True, action='store_true', help='List available hid_listen devices.') | ||
| 259 | @cli.argument('-n', '--numeric', arg_only=True, action='store_true', help='Show VID/PID instead of names.') | ||
| 260 | @cli.argument('-t', '--timestamp', arg_only=True, action='store_true', help='Print the timestamp for received messages as well.') | ||
| 261 | @cli.argument('-w', '--wait', type=int, default=1, help="How many seconds to wait between checks (Default: 1)") | ||
| 262 | @cli.subcommand('Acquire debugging information from usb hid devices.', hidden=False if cli.config.user.developer else True) | ||
| 263 | def console(cli): | ||
| 264 | """Acquire debugging information from usb hid devices | ||
| 265 | """ | ||
| 266 | vid = None | ||
| 267 | pid = None | ||
| 268 | index = 1 | ||
| 269 | |||
| 270 | if cli.config.console.device: | ||
| 271 | device = cli.config.console.device.split(':') | ||
| 272 | |||
| 273 | if len(device) == 2: | ||
| 274 | vid, pid = device | ||
| 275 | |||
| 276 | elif len(device) == 3: | ||
| 277 | vid, pid, index = device | ||
| 278 | |||
| 279 | if not index.isdigit(): | ||
| 280 | cli.log.error('Device index must be a number! Got "%s" instead.', index) | ||
| 281 | exit(1) | ||
| 282 | |||
| 283 | index = int(index) | ||
| 284 | |||
| 285 | if index < 1: | ||
| 286 | cli.log.error('Device index must be greater than 0! Got %s', index) | ||
| 287 | exit(1) | ||
| 288 | |||
| 289 | else: | ||
| 290 | cli.log.error('Invalid format for device, expected "<pid>:<vid>[:<index>]" but got "%s".', cli.config.console.device) | ||
| 291 | cli.print_help() | ||
| 292 | exit(1) | ||
| 293 | |||
| 294 | vid = vid.upper() | ||
| 295 | pid = pid.upper() | ||
| 296 | |||
| 297 | device_finder = FindDevices(vid, pid, index, cli.args.numeric) | ||
| 298 | |||
| 299 | if cli.args.list: | ||
| 300 | return list_devices(device_finder) | ||
| 301 | |||
| 302 | print('Looking for devices...', flush=True) | ||
| 303 | device_finder.run_forever() | ||
diff --git a/lib/python/qmk/cli/lint.py b/lib/python/qmk/cli/lint.py index 02b31fbc4..96593ed69 100644 --- a/lib/python/qmk/cli/lint.py +++ b/lib/python/qmk/cli/lint.py | |||
| @@ -1,72 +1,129 @@ | |||
| 1 | """Command to look over a keyboard/keymap and check for common mistakes. | 1 | """Command to look over a keyboard/keymap and check for common mistakes. |
| 2 | """ | 2 | """ |
| 3 | from pathlib import Path | ||
| 4 | |||
| 3 | from milc import cli | 5 | from milc import cli |
| 4 | 6 | ||
| 5 | from qmk.decorators import automagic_keyboard, automagic_keymap | 7 | from qmk.decorators import automagic_keyboard, automagic_keymap |
| 6 | from qmk.info import info_json | 8 | from qmk.info import info_json |
| 7 | from qmk.keyboard import find_readme, keyboard_completer | 9 | from qmk.keyboard import keyboard_completer, list_keyboards |
| 8 | from qmk.keymap import locate_keymap | 10 | from qmk.keymap import locate_keymap |
| 9 | from qmk.path import is_keyboard, keyboard | 11 | from qmk.path import is_keyboard, keyboard |
| 10 | 12 | ||
| 11 | 13 | ||
| 12 | @cli.argument('--strict', action='store_true', help='Treat warnings as errors.') | 14 | def keymap_check(kb, km): |
| 13 | @cli.argument('-kb', '--keyboard', completer=keyboard_completer, help='The keyboard to check.') | 15 | """Perform the keymap level checks. |
| 14 | @cli.argument('-km', '--keymap', help='The keymap to check.') | 16 | """ |
| 17 | ok = True | ||
| 18 | keymap_path = locate_keymap(kb, km) | ||
| 19 | |||
| 20 | if not keymap_path: | ||
| 21 | ok = False | ||
| 22 | cli.log.error("%s: Can't find %s keymap.", kb, km) | ||
| 23 | |||
| 24 | return ok | ||
| 25 | |||
| 26 | |||
| 27 | def rules_mk_assignment_only(keyboard_path): | ||
| 28 | """Check the keyboard-level rules.mk to ensure it only has assignments. | ||
| 29 | """ | ||
| 30 | current_path = Path() | ||
| 31 | errors = [] | ||
| 32 | |||
| 33 | for path_part in keyboard_path.parts: | ||
| 34 | current_path = current_path / path_part | ||
| 35 | rules_mk = current_path / 'rules.mk' | ||
| 36 | |||
| 37 | if rules_mk.exists(): | ||
| 38 | continuation = None | ||
| 39 | |||
| 40 | for i, line in enumerate(rules_mk.open()): | ||
| 41 | line = line.strip() | ||
| 42 | |||
| 43 | if '#' in line: | ||
| 44 | line = line[:line.index('#')] | ||
| 45 | |||
| 46 | if continuation: | ||
| 47 | line = continuation + line | ||
| 48 | continuation = None | ||
| 49 | |||
| 50 | if line: | ||
| 51 | if line[-1] == '\\': | ||
| 52 | continuation = line[:-1] | ||
| 53 | continue | ||
| 54 | |||
| 55 | if line and '=' not in line: | ||
| 56 | errors.append(f'Non-assignment code on line +{i} {rules_mk}: {line}') | ||
| 57 | |||
| 58 | return errors | ||
| 59 | |||
| 60 | |||
| 61 | @cli.argument('--strict', action='store_true', help='Treat warnings as errors') | ||
| 62 | @cli.argument('-kb', '--keyboard', completer=keyboard_completer, help='Comma separated list of keyboards to check') | ||
| 63 | @cli.argument('-km', '--keymap', help='The keymap to check') | ||
| 64 | @cli.argument('--all-kb', action='store_true', arg_only=True, help='Check all keyboards') | ||
| 15 | @cli.subcommand('Check keyboard and keymap for common mistakes.') | 65 | @cli.subcommand('Check keyboard and keymap for common mistakes.') |
| 16 | @automagic_keyboard | 66 | @automagic_keyboard |
| 17 | @automagic_keymap | 67 | @automagic_keymap |
| 18 | def lint(cli): | 68 | def lint(cli): |
| 19 | """Check keyboard and keymap for common mistakes. | 69 | """Check keyboard and keymap for common mistakes. |
| 20 | """ | 70 | """ |
| 21 | if not cli.config.lint.keyboard: | 71 | failed = [] |
| 22 | cli.log.error('Missing required argument: --keyboard') | ||
| 23 | cli.print_help() | ||
| 24 | return False | ||
| 25 | 72 | ||
| 26 | if not is_keyboard(cli.config.lint.keyboard): | 73 | # Determine our keyboard list |
| 27 | cli.log.error('No such keyboard: %s', cli.config.lint.keyboard) | 74 | if cli.args.all_kb: |
| 28 | return False | 75 | if cli.args.keyboard: |
| 76 | cli.log.warning('Both --all-kb and --keyboard passed, --all-kb takes presidence.') | ||
| 29 | 77 | ||
| 30 | # Gather data about the keyboard. | 78 | keyboard_list = list_keyboards() |
| 31 | ok = True | 79 | elif not cli.config.lint.keyboard: |
| 32 | keyboard_path = keyboard(cli.config.lint.keyboard) | 80 | cli.log.error('Missing required arguments: --keyboard or --all-kb') |
| 33 | keyboard_info = info_json(cli.config.lint.keyboard) | 81 | cli.print_help() |
| 34 | readme_path = find_readme(cli.config.lint.keyboard) | 82 | return False |
| 35 | missing_readme_path = keyboard_path / 'readme.md' | 83 | else: |
| 84 | keyboard_list = cli.config.lint.keyboard.split(',') | ||
| 36 | 85 | ||
| 37 | # Check for errors in the info.json | 86 | # Lint each keyboard |
| 38 | if keyboard_info['parse_errors']: | 87 | for kb in keyboard_list: |
| 39 | ok = False | 88 | if not is_keyboard(kb): |
| 40 | cli.log.error('Errors found when generating info.json.') | 89 | cli.log.error('No such keyboard: %s', kb) |
| 90 | continue | ||
| 41 | 91 | ||
| 42 | if cli.config.lint.strict and keyboard_info['parse_warnings']: | 92 | # Gather data about the keyboard. |
| 43 | ok = False | 93 | ok = True |
| 44 | cli.log.error('Warnings found when generating info.json (Strict mode enabled.)') | 94 | keyboard_path = keyboard(kb) |
| 95 | keyboard_info = info_json(kb) | ||
| 45 | 96 | ||
| 46 | # Check for a readme.md and warn if it doesn't exist | 97 | # Check for errors in the info.json |
| 47 | if not readme_path: | 98 | if keyboard_info['parse_errors']: |
| 48 | ok = False | 99 | ok = False |
| 49 | cli.log.error('Missing %s', missing_readme_path) | 100 | cli.log.error('%s: Errors found when generating info.json.', kb) |
| 50 | 101 | ||
| 51 | # Keymap specific checks | 102 | if cli.config.lint.strict and keyboard_info['parse_warnings']: |
| 52 | if cli.config.lint.keymap: | 103 | ok = False |
| 53 | keymap_path = locate_keymap(cli.config.lint.keyboard, cli.config.lint.keymap) | 104 | cli.log.error('%s: Warnings found when generating info.json (Strict mode enabled.)', kb) |
| 54 | 105 | ||
| 55 | if not keymap_path: | 106 | # Check the rules.mk file(s) |
| 107 | rules_mk_assignment_errors = rules_mk_assignment_only(keyboard_path) | ||
| 108 | if rules_mk_assignment_errors: | ||
| 56 | ok = False | 109 | ok = False |
| 57 | cli.log.error("Can't find %s keymap for %s keyboard.", cli.config.lint.keymap, cli.config.lint.keyboard) | 110 | cli.log.error('%s: Non-assignment code found in rules.mk. Move it to post_rules.mk instead.', kb) |
| 58 | else: | 111 | for assignment_error in rules_mk_assignment_errors: |
| 59 | keymap_readme = keymap_path.parent / 'readme.md' | 112 | cli.log.error(assignment_error) |
| 60 | if not keymap_readme.exists(): | ||
| 61 | cli.log.warning('Missing %s', keymap_readme) | ||
| 62 | 113 | ||
| 63 | if cli.config.lint.strict: | 114 | # Keymap specific checks |
| 64 | ok = False | 115 | if cli.config.lint.keymap: |
| 116 | if not keymap_check(kb, cli.config.lint.keymap): | ||
| 117 | ok = False | ||
| 118 | |||
| 119 | # Report status | ||
| 120 | if not ok: | ||
| 121 | failed.append(kb) | ||
| 65 | 122 | ||
| 66 | # Check and report the overall status | 123 | # Check and report the overall status |
| 67 | if ok: | 124 | if failed: |
| 68 | cli.log.info('Lint check passed!') | 125 | cli.log.error('Lint check failed for: %s', ', '.join(failed)) |
| 69 | return True | 126 | return False |
| 70 | 127 | ||
| 71 | cli.log.error('Lint check failed!') | 128 | cli.log.info('Lint check passed!') |
| 72 | return False | 129 | return True |
