X-Git-Url: https://git.ayoreis.com/Adafruit_Blinka-hackapet.git/blobdiff_plain/ed7fa2e0b327ec381e13396001d7a6fc267c9f73..0a5ff29100196bd9a41bf6deee6c46e65f3ff3d5:/src/usb_hid.py diff --git a/src/usb_hid.py b/src/usb_hid.py index b9d9dac..791647b 100644 --- a/src/usb_hid.py +++ b/src/usb_hid.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries +# +# SPDX-License-Identifier: MIT """ `usb_hid` - support for usb hid devices via usb_gadget driver =========================================================== @@ -15,8 +18,8 @@ import atexit import sys for module in ["dwc2", "libcomposite"]: - if Path("/proc/modules").read_text().find(module) == -1: - raise Exception( + if Path("/proc/modules").read_text(encoding="utf-8").find(module) == -1: + raise Exception( # pylint: disable=broad-exception-raised "%s module not present in your kernel. did you insmod it?" % module ) this = sys.modules[__name__] @@ -52,9 +55,9 @@ class Device: def send_report(self, report: bytearray, report_id: int = None): """Send an HID report. If the device descriptor specifies zero or one report id's, - you can supply `None` (the default) as the value of ``report_id``. - Otherwise you must specify which report id to use when sending the report. - """ + you can supply `None` (the default) as the value of ``report_id``. + Otherwise you must specify which report id to use when sending the report. + """ report_id = report_id or self.report_ids[0] device_path = self.get_device_path(report_id) with open(device_path, "rb+") as fd: @@ -95,7 +98,7 @@ class Device: "%s/functions/hid.usb%s/dev" % (this.gadget_root, report_id or self.report_ids[0]) ) - .read_text() + .read_text(encoding="utf-8") .strip() .split(":")[1] ) @@ -258,7 +261,7 @@ Device.MOUSE = Device( ), usage_page=0x1, usage=0x02, - report_ids=[2], + report_ids=[0x02], in_report_lengths=[4], out_report_lengths=[0], ) @@ -447,7 +450,7 @@ Device.BOOT_MOUSE = Device( ), usage_page=0x1, usage=0x02, - report_ids=[1], + report_ids=[0], in_report_lengths=[4], out_report_lengths=[0], ) @@ -462,7 +465,7 @@ def disable() -> None: as `usb_cdc` or `storage` to free up endpoints for use by `usb_hid`. """ try: - Path("%s/UDC" % this.gadget_root).write_text("") + Path("%s/UDC" % this.gadget_root).write_text("", encoding="utf-8") except FileNotFoundError: pass for symlink in Path(this.gadget_root).glob("configs/**/hid.usb*"): @@ -582,18 +585,30 @@ def enable(requested_devices: Sequence[Device], boot_device: int = 0) -> None: # """ Path("%s/functions" % this.gadget_root).mkdir(parents=True, exist_ok=True) Path("%s/configs" % this.gadget_root).mkdir(parents=True, exist_ok=True) - Path("%s/bcdDevice" % this.gadget_root).write_text("%s" % 1) # Version 1.0.0 - Path("%s/bcdUSB" % this.gadget_root).write_text("%s" % 0x0200) # USB 2.0 + Path("%s/bcdDevice" % this.gadget_root).write_text( + "%s" % 1, encoding="utf-8" + ) # Version 1.0.0 + Path("%s/bcdUSB" % this.gadget_root).write_text( + "%s" % 0x0200, encoding="utf-8" + ) # USB 2.0 Path("%s/bDeviceClass" % this.gadget_root).write_text( - "%s" % 0x00 + "%s" % 0x00, encoding="utf-8" ) # multipurpose i guess? - Path("%s/bDeviceProtocol" % this.gadget_root).write_text("%s" % 0x00) - Path("%s/bDeviceSubClass" % this.gadget_root).write_text("%s" % 0x00) - Path("%s/bMaxPacketSize0" % this.gadget_root).write_text("%s" % 0x08) + Path("%s/bDeviceProtocol" % this.gadget_root).write_text( + "%s" % 0x00, encoding="utf-8" + ) + Path("%s/bDeviceSubClass" % this.gadget_root).write_text( + "%s" % 0x00, encoding="utf-8" + ) + Path("%s/bMaxPacketSize0" % this.gadget_root).write_text( + "%s" % 0x08, encoding="utf-8" + ) Path("%s/idProduct" % this.gadget_root).write_text( - "%s" % 0x0104 + "%s" % 0x0104, encoding="utf-8" ) # Multifunction Composite Gadget - Path("%s/idVendor" % this.gadget_root).write_text("%s" % 0x1D6B) # Linux Foundation + Path("%s/idVendor" % this.gadget_root).write_text( + "%s" % 0x1D6B, encoding="utf-8" + ) # Linux Foundation # """ # 2. Creating the configurations # ------------------------------ @@ -626,15 +641,15 @@ def enable(requested_devices: Sequence[Device], boot_device: int = 0) -> None: # $ echo 120 > configs/c.1/MaxPower # """ - for i, device in enumerate(requested_devices): - config_root = "%s/configs/device.%s" % (this.gadget_root, i + 1) + for device in requested_devices: + config_root = "%s/configs/device.1" % this.gadget_root Path("%s/" % config_root).mkdir(parents=True, exist_ok=True) Path("%s/strings/0x409" % config_root).mkdir(parents=True, exist_ok=True) Path("%s/strings/0x409/configuration" % config_root).write_text( - "my configuration" + "my configuration", encoding="utf-8" ) - Path("%s/MaxPower" % config_root).write_text("150") - Path("%s/bmAttributes" % config_root).write_text("%s" % 0x080) + Path("%s/MaxPower" % config_root).write_text("150", encoding="utf-8") + Path("%s/bmAttributes" % config_root).write_text("%s" % 0x080, encoding="utf-8") this.devices.append(device) # """ # 3. Creating the functions @@ -664,11 +679,13 @@ def enable(requested_devices: Sequence[Device], boot_device: int = 0) -> None: Path("%s/" % function_root).mkdir(parents=True) except FileExistsError: continue - Path("%s/protocol" % function_root).write_text("%s" % report_id) + Path("%s/protocol" % function_root).write_text( + "%s" % report_id, encoding="utf-8" + ) Path("%s/report_length" % function_root).write_text( - "%s" % device.in_report_lengths[report_index] + "%s" % device.in_report_lengths[report_index], encoding="utf-8" ) - Path("%s/subclass" % function_root).write_text("%s" % 1) + Path("%s/subclass" % function_root).write_text("%s" % 1, encoding="utf-8") Path("%s/report_desc" % function_root).write_bytes(device.descriptor) # """ # 4. Associating the functions with their configurations @@ -685,7 +702,12 @@ def enable(requested_devices: Sequence[Device], boot_device: int = 0) -> None: # e.g.:: # # $ ln -s functions/ncm.usb0 configs/c.1 """ - Path("%s/hid.usb%s" % (config_root, report_id)).symlink_to(function_root) + try: + Path("%s/hid.usb%s" % (config_root, report_id)).symlink_to( + function_root + ) + except FileNotFoundError: + pass # """ 5. Enabling the gadget # ---------------------- # Such a gadget must be finally enabled so that the USB host can enumerate it. @@ -700,4 +722,4 @@ def enable(requested_devices: Sequence[Device], boot_device: int = 0) -> None: # # $ echo s3c-hsotg > UDC """ udc = next(Path("/sys/class/udc/").glob("*")) - Path("%s/UDC" % this.gadget_root).write_text("%s" % udc.name) + Path("%s/UDC" % this.gadget_root).write_text("%s" % udc.name, encoding="utf-8")