diff options
Diffstat (limited to 'lib/python/qmk/cli/doctor/linux.py')
| -rw-r--r-- | lib/python/qmk/cli/doctor/linux.py | 162 | 
1 files changed, 162 insertions, 0 deletions
| diff --git a/lib/python/qmk/cli/doctor/linux.py b/lib/python/qmk/cli/doctor/linux.py new file mode 100644 index 0000000000..c0b77216a1 --- /dev/null +++ b/lib/python/qmk/cli/doctor/linux.py @@ -0,0 +1,162 @@ +"""OS-specific functions for: Linux +""" +import platform +import shutil +from pathlib import Path + +from milc import cli + +from qmk.constants import QMK_FIRMWARE +from .check import CheckStatus + + +def _udev_rule(vid, pid=None, *args): +    """ Helper function that return udev rules +    """ +    rule = "" +    if pid: +        rule = 'SUBSYSTEMS=="usb", ATTRS{idVendor}=="%s", ATTRS{idProduct}=="%s", TAG+="uaccess"' % ( +            vid, +            pid, +        ) +    else: +        rule = 'SUBSYSTEMS=="usb", ATTRS{idVendor}=="%s", TAG+="uaccess"' % vid +    if args: +        rule = ', '.join([rule, *args]) +    return rule + + +def _deprecated_udev_rule(vid, pid=None): +    """ Helper function that return udev rules + +    Note: these are no longer the recommended rules, this is just used to check for them +    """ +    if pid: +        return 'SUBSYSTEMS=="usb", ATTRS{idVendor}=="%s", ATTRS{idProduct}=="%s", MODE:="0666"' % (vid, pid) +    else: +        return 'SUBSYSTEMS=="usb", ATTRS{idVendor}=="%s", MODE:="0666"' % vid + + +def check_udev_rules(): +    """Make sure the udev rules look good. +    """ +    rc = CheckStatus.OK +    udev_dir = Path("/etc/udev/rules.d/") +    desired_rules = { +        'atmel-dfu': { +            _udev_rule("03eb", "2fef"),  # ATmega16U2 +            _udev_rule("03eb", "2ff0"),  # ATmega32U2 +            _udev_rule("03eb", "2ff3"),  # ATmega16U4 +            _udev_rule("03eb", "2ff4"),  # ATmega32U4 +            _udev_rule("03eb", "2ff9"),  # AT90USB64 +            _udev_rule("03eb", "2ffa"),  # AT90USB162 +            _udev_rule("03eb", "2ffb")  # AT90USB128 +        }, +        'kiibohd': {_udev_rule("1c11", "b007")}, +        'stm32': { +            _udev_rule("1eaf", "0003"),  # STM32duino +            _udev_rule("0483", "df11")  # STM32 DFU +        }, +        'bootloadhid': {_udev_rule("16c0", "05df")}, +        'usbasploader': {_udev_rule("16c0", "05dc")}, +        'massdrop': {_udev_rule("03eb", "6124", 'ENV{ID_MM_DEVICE_IGNORE}="1"')}, +        'caterina': { +            # Spark Fun Electronics +            _udev_rule("1b4f", "9203", 'ENV{ID_MM_DEVICE_IGNORE}="1"'),  # Pro Micro 3V3/8MHz +            _udev_rule("1b4f", "9205", 'ENV{ID_MM_DEVICE_IGNORE}="1"'),  # Pro Micro 5V/16MHz +            _udev_rule("1b4f", "9207", 'ENV{ID_MM_DEVICE_IGNORE}="1"'),  # LilyPad 3V3/8MHz (and some Pro Micro clones) +            # Pololu Electronics +            _udev_rule("1ffb", "0101", 'ENV{ID_MM_DEVICE_IGNORE}="1"'),  # A-Star 32U4 +            # Arduino SA +            _udev_rule("2341", "0036", 'ENV{ID_MM_DEVICE_IGNORE}="1"'),  # Leonardo +            _udev_rule("2341", "0037", 'ENV{ID_MM_DEVICE_IGNORE}="1"'),  # Micro +            # Adafruit Industries LLC +            _udev_rule("239a", "000c", 'ENV{ID_MM_DEVICE_IGNORE}="1"'),  # Feather 32U4 +            _udev_rule("239a", "000d", 'ENV{ID_MM_DEVICE_IGNORE}="1"'),  # ItsyBitsy 32U4 3V3/8MHz +            _udev_rule("239a", "000e", 'ENV{ID_MM_DEVICE_IGNORE}="1"'),  # ItsyBitsy 32U4 5V/16MHz +            # dog hunter AG +            _udev_rule("2a03", "0036", 'ENV{ID_MM_DEVICE_IGNORE}="1"'),  # Leonardo +            _udev_rule("2a03", "0037", 'ENV{ID_MM_DEVICE_IGNORE}="1"')  # Micro +        } +    } + +    # These rules are no longer recommended, only use them to check for their presence. +    deprecated_rules = { +        'atmel-dfu': {_deprecated_udev_rule("03eb", "2ff4"), _deprecated_udev_rule("03eb", "2ffb"), _deprecated_udev_rule("03eb", "2ff0")}, +        'kiibohd': {_deprecated_udev_rule("1c11")}, +        'stm32': {_deprecated_udev_rule("1eaf", "0003"), _deprecated_udev_rule("0483", "df11")}, +        'bootloadhid': {_deprecated_udev_rule("16c0", "05df")}, +        'caterina': {'ATTRS{idVendor}=="2a03", ENV{ID_MM_DEVICE_IGNORE}="1"', 'ATTRS{idVendor}=="2341", ENV{ID_MM_DEVICE_IGNORE}="1"'}, +        'tmk': {_deprecated_udev_rule("feed")} +    } + +    if udev_dir.exists(): +        udev_rules = [rule_file for rule_file in udev_dir.glob('*.rules')] +        current_rules = set() + +        # Collect all rules from the config files +        for rule_file in udev_rules: +            for line in rule_file.read_text(encoding='utf-8').split('\n'): +                line = line.strip() +                if not line.startswith("#") and len(line): +                    current_rules.add(line) + +        # Check if the desired rules are among the currently present rules +        for bootloader, rules in desired_rules.items(): +            if not rules.issubset(current_rules): +                deprecated_rule = deprecated_rules.get(bootloader) +                if deprecated_rule and deprecated_rule.issubset(current_rules): +                    cli.log.warning("{fg_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) +                else: +                    # For caterina, check if ModemManager is running +                    if bootloader == "caterina": +                        if check_modem_manager(): +                            rc = CheckStatus.WARNING +                            cli.log.warning("{fg_yellow}Detected ModemManager without the necessary udev rules. Please either disable it or set the appropriate udev rules if you are using a Pro Micro.") +                    rc = CheckStatus.WARNING +                    cli.log.warning("{fg_yellow}Missing or outdated udev rules for '%s' boards. Run 'sudo cp %s/util/udev/50-qmk.rules /etc/udev/rules.d/'.", bootloader, QMK_FIRMWARE) + +    else: +        cli.log.warning("{fg_yellow}'%s' does not exist. Skipping udev rule checking...", udev_dir) + +    return rc + + +def check_systemd(): +    """Check if it's a systemd system +    """ +    return bool(shutil.which("systemctl")) + + +def check_modem_manager(): +    """Returns True if ModemManager is running. + +    """ +    if check_systemd(): +        mm_check = cli.run(["systemctl", "--quiet", "is-active", "ModemManager.service"], timeout=10) +        if mm_check.returncode == 0: +            return True +    else: +        """(TODO): Add check for non-systemd systems +        """ +    return False + + +def os_test_linux(): +    """Run the Linux specific tests. +    """ +    # Don't bother with udev on WSL, for now +    if 'microsoft' in platform.uname().release.lower(): +        cli.log.info("Detected {fg_cyan}Linux (WSL){fg_reset}.") + +        # https://github.com/microsoft/WSL/issues/4197 +        if QMK_FIRMWARE.as_posix().startswith("/mnt"): +            cli.log.warning("I/O performance on /mnt may be extremely slow.") +            return CheckStatus.WARNING + +        return CheckStatus.OK +    else: +        cli.log.info("Detected {fg_cyan}Linux{fg_reset}.") +        from .linux import check_udev_rules + +        return check_udev_rules() | 
