labgrid-suggest: prefer properties of the device itself

As the default udev configuration enables the path_id and usb_id helpers for
many USB-based devices, first check if ID_PATH or ID_SERIAL_SHORT are available
on the device itself. Use the parent USB device only if it's not found.

Signed-off-by: Jan Luebbe <[email protected]>

Author: jluebbe

labgrid/resource/udev.py

@@ -85,17 +85,18 @@ def suggest_match(self, device):
         if self.device.properties.get('ID_REVISION'):
             meta['revision'] = self.device.properties.get('ID_REVISION')
 
-        if self.match.get('SUBSYSTEM', None) == 'usb':
-            path = self._get_usb_device().properties.get('ID_PATH')
-            if path:
-                suggestions.append({'ID_PATH': path})
-            serial = self._get_usb_device().properties.get('ID_SERIAL_SHORT')
-            if serial:
-                suggestions.append({'ID_SERIAL_SHORT': serial})
+        path = self.device.properties.get('ID_PATH')
+        if path:
+            suggestions.append({'ID_PATH': path})
         elif self.match.get('@SUBSYSTEM', None) == 'usb':
             path = self._get_usb_device().properties.get('ID_PATH')
             if path:
                 suggestions.append({'@ID_PATH': path})
+
+        serial = self.device.properties.get('ID_SERIAL_SHORT')
+        if serial:
+            suggestions.append({'ID_SERIAL_SHORT': serial})
+        elif self.match.get('@SUBSYSTEM', None) == 'usb':
             serial = self._get_usb_device().properties.get('ID_SERIAL_SHORT')
             if serial:
                 suggestions.append({'@ID_SERIAL_SHORT': serial})

man/labgrid-suggest.1

@@ -54,15 +54,30 @@ enable debug mode
 .SH EXAMPLES
 .sp
 For a device that has an \fBID_SERIAL_SHORT\fP key with a unique ID embedded
-in the USB\-serial converter, the resource match configuration is:
+in the USB\-serial converter, \fBlabgrid\-suggest\fP shows two alternatives:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
+=== added device ===
+USBSerialPort for /devices/pci0000:00/0000:00:01.3/0000:02:00.0/usb1/1\-3/1\-3.1/1\-3.1:1.0/ttyUSB0/tty/ttyUSB0
+=== device properties ===
+device node: /dev/ttyUSB0
+udev tags: , systemd
+vendor: Silicon_Labs
+vendor (DB): Advanced Micro Devices, Inc. [AMD]
+model: CP2102_USB_to_UART_Bridge_Controller
+revision: 0100
+=== suggested matches ===
 USBSerialPort:
   match:
-    \(aq@ID_SERIAL_SHORT\(aq: \(aqP\-00\-00682\(aq
+    ID_PATH: pci\-0000:02:00.0\-usb\-0:3.1:1.0
+\-\-\-
+USBSerialPort:
+  match:
+    ID_SERIAL_SHORT: P\-00\-03564
+\-\-\-
 .ft P
 .fi
 .UNINDENT

man/labgrid-suggest.rst

@@ -45,14 +45,28 @@ EXAMPLES
 --------
 
 For a device that has an ``ID_SERIAL_SHORT`` key with a unique ID embedded
-in the USB-serial converter, the resource match configuration is:
+in the USB-serial converter, ``labgrid-suggest`` shows two alternatives:
 
 .. code-block:: yaml
 
+   === added device ===
+   USBSerialPort for /devices/pci0000:00/0000:00:01.3/0000:02:00.0/usb1/1-3/1-3.1/1-3.1:1.0/ttyUSB0/tty/ttyUSB0
+   === device properties ===
+   device node: /dev/ttyUSB0
+   udev tags: , systemd
+   vendor: Silicon_Labs
+   vendor (DB): Advanced Micro Devices, Inc. [AMD]
+   model: CP2102_USB_to_UART_Bridge_Controller
+   revision: 0100
+   === suggested matches ===
    USBSerialPort:
      match:
-       '@ID_SERIAL_SHORT': 'P-00-00682'
-
+       ID_PATH: pci-0000:02:00.0-usb-0:3.1:1.0
+   ---
+   USBSerialPort:
+     match:
+       ID_SERIAL_SHORT: P-00-03564
+   ---
 
 SEE ALSO
 --------