Ruff updates

Author: RetiredWizard

adafruit_usb_host_descriptors.py

@@ -43,7 +43,7 @@
 DESC_INTERFACE = 0x04
 DESC_ENDPOINT = 0x05
 DESC_HID = 0x21
-DESC_REPORT = 0X22
+DESC_REPORT = 0x22
 
 INTERFACE_HID = 0x03
 SUBCLASS_BOOT = 0x01
@@ -52,16 +52,16 @@
 PROTOCOL_KEYBOARD = 0x01
 
 # --- HID Report Descriptor Item Tags (The "Command") ---
-HID_TAG_USAGE_PAGE       = 0x05  # Defines the category (e.g., Generic Desktop, Game Controls)
-HID_TAG_USAGE            = 0x09  # Defines the specific item (e.g., Mouse, Joystick)
+HID_TAG_USAGE_PAGE = 0x05  # Defines the category (e.g., Generic Desktop, Game Controls)
+HID_TAG_USAGE = 0x09  # Defines the specific item (e.g., Mouse, Joystick)
 
 # --- Usage Page IDs (Values for 0x05) ---
 USAGE_PAGE_GENERIC_DESKTOP = 0x01
 
 # --- Usage IDs (Values for 0x09, inside Generic Desktop) ---
-USAGE_MOUSE    = 0x02
+USAGE_MOUSE = 0x02
 USAGE_JOYSTICK = 0x04
-USAGE_GAMEPAD  = 0x05
+USAGE_GAMEPAD = 0x05
 USAGE_KEYBOARD = 0x06
 
 
@@ -100,11 +100,15 @@ def get_configuration_descriptor(device, index):
     get_descriptor(device, DESC_CONFIGURATION, index, full_buf)
     return full_buf
 
+
 def get_report_descriptor(device, interface_num, length):
     """
     Fetches the HID Report Descriptor.
     This tells us what the device actually IS (Mouse vs Joystick).
     """
+    if length < 1:
+        return None
+
     buf = bytearray(length)
     try:
         # 0x81 = Dir: IN | Type: Standard | Recipient: Interface
@@ -114,13 +118,14 @@ def get_report_descriptor(device, interface_num, length):
             _REQ_GET_DESCRIPTOR,
             DESC_REPORT << 8,
             interface_num,
-            buf
+            buf,
         )
         return buf
     except Exception as e:
         print(f"Failed to read Report Descriptor: {e}")
         return None
 
+
 def _is_confirmed_mouse(report_desc):
     """
     Scans the raw descriptor bytes for:
@@ -129,33 +134,33 @@ def _is_confirmed_mouse(report_desc):
     """
     if not report_desc:
         return False
-    
+
     # Simple byte scan check
     # We look for Usage Page Generic Desktop (0x05 0x01)
     has_generic_desktop = False
     for i in range(len(report_desc) - 1):
-        if report_desc[i] == HID_TAG_USAGE_PAGE and report_desc[i+1] == USAGE_PAGE_GENERIC_DESKTOP:
+        if (
+            report_desc[i] == HID_TAG_USAGE_PAGE
+            and report_desc[i + 1] == USAGE_PAGE_GENERIC_DESKTOP
+        ):
             has_generic_desktop = True
-            
+
     # We look for Usage Mouse (0x09 0x02)
     has_mouse_usage = False
     for i in range(len(report_desc) - 1):
-        if report_desc[i] == HID_TAG_USAGE and report_desc[i+1] == USAGE_MOUSE:
+        if report_desc[i] == HID_TAG_USAGE and report_desc[i + 1] == USAGE_MOUSE:
             has_mouse_usage = True
-            
-    return has_generic_desktop and has_mouse_usage
 
+    return has_generic_desktop and has_mouse_usage
 
-def _find_endpoint(device, count, protocol_type: Literal[PROTOCOL_MOUSE, PROTOCOL_KEYBOARD], subclass):
-    # pass a count of <= 0 to return all HID interfaces/endpoints of selected protocol_type on the device
 
+def _find_endpoint(device, protocol_type: Literal[PROTOCOL_MOUSE, PROTOCOL_KEYBOARD], subclass):
     config_descriptor = get_configuration_descriptor(device, 0)
     i = 0
     mouse_interface_index = None
     found_mouse = False
     candidate_found = False
     hid_desc_len = 0
-    endpoints = []
     while i < len(config_descriptor):
         descriptor_len = config_descriptor[i]
         descriptor_type = config_descriptor[i + 1]
@@ -180,7 +185,7 @@ def _find_endpoint(device, count, protocol_type: Literal[PROTOCOL_MOUSE, PROTOCO
             ):
                 found_mouse = True
                 mouse_interface_index = interface_number
-            
+
             # May be trackpad interface if it's not a keyboard and looking for mouse
             elif (
                 interface_class == INTERFACE_HID
@@ -195,44 +200,29 @@ def _find_endpoint(device, count, protocol_type: Literal[PROTOCOL_MOUSE, PROTOCO
             # The HID descriptor stores the Report Descriptor length at offset 7
             # Bytes: [Length, Type, BCD, BCD, Country, Count, ReportType, ReportLenL, ReportLenH]
             if descriptor_len >= 9:
-                hid_desc_len = config_descriptor[i+7] + (config_descriptor[i+8] << 8)
+                hid_desc_len = config_descriptor[i + 7] + (config_descriptor[i + 8] << 8)
 
         elif descriptor_type == DESC_ENDPOINT:
             endpoint_address = config_descriptor[i + 2]
             if endpoint_address & _DIR_IN:
                 if found_mouse:
-                    endpoints.append((mouse_interface_index, endpoint_address))
-                    if len(endpoints) == count:
-                        return endpoints
+                    return mouse_interface_index, endpoint_address
 
                 elif candidate_found:
                     print(f"Checking Interface {interface_number}...")
-                    
+
                     # If it's Protocol 2, it's definitely a mouse (Standard).
                     # If it's Protocol 0, we must check the descriptor.
-                    is_mouse = False
-                    
-                    if hid_desc_len > 0:
-                        rep_desc = get_report_descriptor(device, interface_number, hid_desc_len)
-                        if _is_confirmed_mouse(rep_desc):
-                            is_mouse = True
-                            print(f" -> CONFIRMED: It is a Mouse/Trackpad (Usage 0x09 0x02)")
-                        else:
-                            print(f" -> REJECTED: Generic HID, but not a mouse (Joystick/Ups?)")
-                    else:
-                        # Fallback if we missed the HID descriptor, assume no if Candidate
-                        print(" -> Warning: Could not verify Usage, assuming no.")
-                        is_mouse = False
-
-                    if is_mouse:
-                        endpoints.append((interface_number, endpoint_address))
-                        if len(endpoints) == count:
-                            return endpoints
-                    else:
-                        candidate_found = False # Stop looking at this interface
+
+                    rep_desc = get_report_descriptor(device, interface_number, hid_desc_len)
+                    if _is_confirmed_mouse(rep_desc):
+                        print(f" -> CONFIRMED: It is a Mouse/Trackpad (Usage 0x09 0x02)")
+                        return interface_number, endpoint_address
+
+                    candidate_found = False  # Stop looking at this interface
 
         i += descriptor_len
-    return [(None, None)]
+    return None, None
 
 
 def find_boot_mouse_endpoint(device):
@@ -242,7 +232,8 @@ def find_boot_mouse_endpoint(device):
     :param device: The device to search within
     :return: mouse_interface_index, mouse_endpoint_address if found, or None, None otherwise
     """
-    return _find_endpoint(device, 1, PROTOCOL_MOUSE, SUBCLASS_BOOT)[0]
+    return _find_endpoint(device, PROTOCOL_MOUSE, SUBCLASS_BOOT)
+
 
 def find_report_mouse_endpoint(device):
     """
@@ -251,7 +242,8 @@ def find_report_mouse_endpoint(device):
     :param device: The device to search within
     :return: mouse_interface_index, mouse_endpoint_address if found, or None, None otherwise
     """
-    return _find_endpoint(device, 1, PROTOCOL_MOUSE, SUBCLASS_REPORT)[0]
+    return _find_endpoint(device, PROTOCOL_MOUSE, SUBCLASS_REPORT)
+
 
 def find_boot_keyboard_endpoint(device):
     """
@@ -260,5 +252,4 @@ def find_boot_keyboard_endpoint(device):
     :param device: The device to search within
     :return: keyboard_interface_index, keyboard_endpoint_address if found, or None, None otherwise
     """
-    return _find_endpoint(device, 1, PROTOCOL_KEYBOARD, SUBCLASS_BOOT)[0]
-
+    return _find_endpoint(device, PROTOCOL_KEYBOARD, SUBCLASS_BOOT)