From 97a1bb22e1f00d996af88ede72c26956e87e3f27 Mon Sep 17 00:00:00 2001
From: lucasg <lucas.georges@outlook.com>
Date: Wed, 15 Apr 2020 18:51:27 +0200
Subject: [PATCH] [device] Add device object associated with phy device

---
 samples/device/device_manager.py |  6 ++++--
 windows/winobject/device.py      | 37 ++++++++++++++++++++++++--------
 2 files changed, 32 insertions(+), 11 deletions(-)

diff --git a/samples/device/device_manager.py b/samples/device/device_manager.py
index b4beca1..badc59b 100644
--- a/samples/device/device_manager.py
+++ b/samples/device/device_manager.py
@@ -8,13 +8,15 @@ def main():
 
         for device in device_class.devices:
             if device.name != None:
-                print("  -Device : %s" % (device.name))
+                if device.device_object != None:
+                    print("  -Device : %s (%s)" % (device.name, device.device_object))
+                else:
+                    print("  -Device : %s" % (device.name))
             else:
                 print("  -Device : N/A")
         
             for resource in device.resources:
                 print('    -%s' % (resource))
-                # print('    -%s : [0x%08x - 0x%08x] (0x%04x)' % (resource.type, resource.start, resource.end, resource.flags))
 
 
 
diff --git a/windows/winobject/device.py b/windows/winobject/device.py
index 3ea09de..9fd4934 100644
--- a/windows/winobject/device.py
+++ b/windows/winobject/device.py
@@ -338,7 +338,7 @@ class DeviceResource(object):
 class DeviceObject(object):
     """ A Python object representing a setup device instance. """
 
-    def __init__(self, dev_data, device_name):
+    def __init__(self, dev_data, device_name, physical_object_name = None):
 
         # gdef.winstructs.SP_DEVINFO_DATA: associated device info
         self.dev_data = dev_data
@@ -349,10 +349,18 @@ class DeviceObject(object):
         # list(AbstractDeviceResource): list of resources registered by the device
         self._resources = None
 
+        # str: Physical object name (optional)
+        self._device_object = physical_object_name
+
+
     @property
     def name(self):
         return self._name
 
+    @property
+    def device_object(self):
+        return self._device_object
+
     @property
     def resources(self):
         if not self._resources:
@@ -364,10 +372,11 @@ class DeviceObject(object):
     @classmethod
     def from_device_info(cls, h_devs, device_data):
 
-        # DO NOT STORE h_devs since it may be invalidated in the future
-        device_name = None
+        # TODO : check if we can store h_devs in the class, and use it later
 
-        for name_params in [SPDRP_FRIENDLYNAME, SPDRP_DEVICEDESC, SPDRP_PHYSICAL_DEVICE_OBJECT_NAME]:
+        # Try to retrieve some name associated with the device
+        device_name = None
+        for name_params in [SPDRP_FRIENDLYNAME, SPDRP_DEVICEDESC]:
                 
             try:
                 device_name = winproxy.SetupDiGetDeviceRegistryPropertyW(h_devs, device_data, name_params, None)
@@ -376,12 +385,22 @@ class DeviceObject(object):
                     break        
 
             except WindowsError as e:
-                if e.winerror == gdef.ERROR_INVALID_DATA:
-                    continue
+                if e.winerror != gdef.ERROR_INVALID_DATA:
+                    raise
+        
+        # Read other useful infos such as PDO, BusParam, etc.
+        ERROR_NO_SUCH_DEVINST = 0xe000020b
+        pdo = None
+        try:
+            pdo = winproxy.SetupDiGetDeviceRegistryPropertyW(h_devs, device_data, SPDRP_PHYSICAL_DEVICE_OBJECT_NAME, None)
+            if pdo:
+                pdo = pdo.decode('utf-16-le').rstrip('\x00')
+        except WindowsError as e:
+            if e.winerror not in [gdef.ERROR_INVALID_DATA, ERROR_NO_SUCH_DEVINST]:
                 raise
-                
-
-        return cls(device_data, device_name)
+        
+                    
+        return cls(device_data, device_name, pdo)
 
     def get_resources(self, resource_type = None):