[PATCH 0/7] MR432: Add support for SPDRP_BASE_CONTAINERID by querying drivers with BusQueryContainerID

[Claire (＠ClearlyClaire)]

This is the hidclass/ntoskrnl/setupapi counterpart to !359. As with that merge request, implementing `BusQueryContainerID` in the bus driver is left out and will be addressed in a different MR.

I believe this is useful to expose the Container ID no matter how those end up being assigned by the bus driver.

[PATCH 1/7] setupapi: Add support for SPDRP_BASE_CONTAINERID

[Claire Girka]

From: Claire Girka

---
 dlls/setupapi/devinst.c | 2 ++
 include/setupapi.h      | 3 ++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/dlls/setupapi/devinst.c b/dlls/setupapi/devinst.c
index 73e721753aa..1282285da4c 100644
--- a/dlls/setupapi/devinst.c
+++ b/dlls/setupapi/devinst.c
@@ -96,6 +96,7 @@ static const WCHAR Capabilities[] = {'C','a','p','a','b','i','l','i','t','i','e'
 static const WCHAR UINumber[] = {'U','I','N','u','m','b','e','r',0};
 static const WCHAR UpperFilters[] = {'U','p','p','e','r','F','i','l','t','e','r','s',0};
 static const WCHAR LowerFilters[] = {'L','o','w','e','r','F','i','l','t','e','r','s',0};
+static const WCHAR BaseContainerId[] = {'B','a','s','e','C','o','n','t','a','i','n','e','r','I','d',0};
 static const WCHAR Phantom[] = {'P','h','a','n','t','o','m',0};
 static const WCHAR SymbolicLink[] = {'S','y','m','b','o','l','i','c','L','i','n','k',0};
 static const WCHAR Control[] = {'C','o','n','t','r','o','l',0};
@@ -654,6 +655,7 @@ static const struct PropertyMapEntry PropertyMap[] = {
     { REG_DWORD, "UINumber", UINumber },
     { REG_MULTI_SZ, "UpperFilters", UpperFilters },
     { REG_MULTI_SZ, "LowerFilters", LowerFilters },
+    [0x24] = { REG_SZ, "BaseContainerId", BaseContainerId },
 };

static BOOL SETUPDI_SetDeviceRegistryPropertyW(struct device *device,
diff --git a/include/setupapi.h b/include/setupapi.h
index 14e3774fc42..806df7baaf5 100644
--- a/include/setupapi.h
+++ b/include/setupapi.h
@@ -1315,7 +1315,8 @@ DECL_WINELIB_SETUPAPI_TYPE_AW(PSP_INF_SIGNER_INFO)
 #define SPDRP_REMOVAL_POLICY_HW_DEFAULT   0x00000020
 #define SPDRP_REMOVAL_POLICY_OVERRIDE     0x00000021
 #define SPDRP_INSTALL_STATE               0x00000022
-#define SPDRP_MAXIMUM_PROPERTY            0x00000023
+#define SPDRP_BASE_CONTAINERID            0x00000024
+#define SPDRP_MAXIMUM_PROPERTY            0x00000025

#define DPROMPT_SUCCESS        0
 #define DPROMPT_CANCEL         1

[PATCH 2/7] hidclass: Fix error handling in get_device_id

[Claire Girka]

From: Claire Girka

This is necessary to avoid crashes in upcoming commits when hidclass will
query underlying drivers with BusQueryContainerID.
---
 dlls/hidclass.sys/pnp.c | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/dlls/hidclass.sys/pnp.c b/dlls/hidclass.sys/pnp.c
index 873c55c4a67..0d553ba11ce 100644
--- a/dlls/hidclass.sys/pnp.c
+++ b/dlls/hidclass.sys/pnp.c
@@ -71,7 +71,7 @@ static minidriver *find_minidriver(DRIVER_OBJECT *driver)
 static NTSTATUS get_device_id(DEVICE_OBJECT *device, BUS_QUERY_ID_TYPE type, WCHAR *id)
 {
     IO_STACK_LOCATION *irpsp;
-    IO_STATUS_BLOCK irp_status;
+    IO_STATUS_BLOCK irp_status = { .Status = STATUS_NOT_IMPLEMENTED };
     KEVENT event;
     IRP *irp;

@@ -87,8 +87,14 @@ static NTSTATUS get_device_id(DEVICE_OBJECT *device, BUS_QUERY_ID_TYPE type, WCH
     if (IoCallDriver(device, irp) == STATUS_PENDING)
         KeWaitForSingleObject(&event, Executive, KernelMode, FALSE, NULL);

-    wcscpy(id, (WCHAR *)irp_status.Information);
-    ExFreePool((WCHAR *)irp_status.Information);
+    if (irp_status.Information && !irp_status.Status)
+        wcscpy(id, (WCHAR *)irp_status.Information);
+    else
+        id[0] = 0;
+
+    if (irp_status.Information)
+        ExFreePool((WCHAR *)irp_status.Information);
+
     return irp_status.Status;
 }

[PATCH 3/7] hidclass: Copy ContainerID from underlying driver in driver_add_device

[Claire Girka]

From: Claire Girka

---
 dlls/hidclass.sys/hid.h | 1 +
 dlls/hidclass.sys/pnp.c | 5 ++++-
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/dlls/hidclass.sys/hid.h b/dlls/hidclass.sys/hid.h
index e20f12809eb..b8cec55fb7c 100644
--- a/dlls/hidclass.sys/hid.h
+++ b/dlls/hidclass.sys/hid.h
@@ -81,6 +81,7 @@ typedef struct _BASE_DEVICE_EXTENSION
      * for convenience. */
     WCHAR device_id[MAX_DEVICE_ID_LEN];
     WCHAR instance_id[MAX_DEVICE_ID_LEN];
+    WCHAR container_id[MAX_GUID_STRING_LEN];
     const GUID *class_guid;

BOOL is_fdo;
diff --git a/dlls/hidclass.sys/pnp.c b/dlls/hidclass.sys/pnp.c
index 0d553ba11ce..3e6cc5bd736 100644
--- a/dlls/hidclass.sys/pnp.c
+++ b/dlls/hidclass.sys/pnp.c
@@ -138,7 +138,7 @@ static void send_wm_input_device_change(BASE_DEVICE_EXTENSION *ext, LPARAM param

static NTSTATUS WINAPI driver_add_device(DRIVER_OBJECT *driver, DEVICE_OBJECT *bus_pdo)
 {
-    WCHAR device_id[MAX_DEVICE_ID_LEN], instance_id[MAX_DEVICE_ID_LEN];
+    WCHAR device_id[MAX_DEVICE_ID_LEN], instance_id[MAX_DEVICE_ID_LEN], container_id[MAX_DEVICE_ID_LEN];
     BASE_DEVICE_EXTENSION *ext;
     BOOL is_xinput_class;
     DEVICE_OBJECT *fdo;
@@ -174,6 +174,9 @@ static NTSTATUS WINAPI driver_add_device(DRIVER_OBJECT *driver, DEVICE_OBJECT *b
     swprintf(ext->device_id, ARRAY_SIZE(ext->device_id), L"HID\%s", wcsrchr(device_id, '\') + 1);
     wcscpy(ext->instance_id, instance_id);

+    if (!get_device_id(bus_pdo, BusQueryContainerID, container_id))
+        wcscpy(ext->container_id, container_id);
+
     is_xinput_class = !wcsncmp(device_id, L"WINEXINPUT\", 7) && wcsstr(device_id, L"&XI_") != NULL;
     if (is_xinput_class) ext->class_guid = &GUID_DEVINTERFACE_WINEXINPUT;
     else ext->class_guid = &GUID_DEVINTERFACE_HID;

[PATCH 4/7] hidclass: Copy device ContainerID to child devices

[Claire Girka]

From: Claire Girka

---
 dlls/hidclass.sys/pnp.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/dlls/hidclass.sys/pnp.c b/dlls/hidclass.sys/pnp.c
index 3e6cc5bd736..457e5a7dcf6 100644
--- a/dlls/hidclass.sys/pnp.c
+++ b/dlls/hidclass.sys/pnp.c
@@ -233,6 +233,7 @@ static void create_child(minidriver *minidriver, DEVICE_OBJECT *fdo)
     KeInitializeSpinLock( &pdo_ext->u.pdo.queues_lock );
     wcscpy(pdo_ext->device_id, fdo_ext->device_id);
     wcscpy(pdo_ext->instance_id, fdo_ext->instance_id);
+    wcscpy(pdo_ext->container_id, fdo_ext->container_id);
     pdo_ext->class_guid = fdo_ext->class_guid;

pdo_ext->u.pdo.information.VendorID = attr.VendorID;

[PATCH 5/7] hidclass: Expose ContainerID

[Claire Girka]

From: Claire Girka

---
 dlls/hidclass.sys/pnp.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/dlls/hidclass.sys/pnp.c b/dlls/hidclass.sys/pnp.c
index 457e5a7dcf6..aa841ecbcfb 100644
--- a/dlls/hidclass.sys/pnp.c
+++ b/dlls/hidclass.sys/pnp.c
@@ -421,8 +421,16 @@ static NTSTATUS pdo_pnp(DEVICE_OBJECT *device, IRP *irp)
                     irp->IoStatus.Information = (ULONG_PTR)id;
                     status = STATUS_SUCCESS;
                     break;
-
                 case BusQueryContainerID:
+                    if (ext->container_id[0]) {
+                        lstrcpyW(id, ext->container_id);
+                        irp->IoStatus.Information = (ULONG_PTR)id;
+                        status = STATUS_SUCCESS;
+                    } else {
+                        ExFreePool(id);
+                    }
+                    break;
+
                 case BusQueryDeviceSerialNumber:
                     FIXME("unimplemented id type %#x\n", irpsp->Parameters.QueryId.IdType);
                     ExFreePool(id);

[PATCH 6/7] ntoskrnl: Set device ContainerID from driver

[Claire Girka]

From: Claire Girka

---
 dlls/ntoskrnl.exe/pnp.c | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/dlls/ntoskrnl.exe/pnp.c b/dlls/ntoskrnl.exe/pnp.c
index 71c03586897..52da30d0c97 100644
--- a/dlls/ntoskrnl.exe/pnp.c
+++ b/dlls/ntoskrnl.exe/pnp.c
@@ -281,6 +281,13 @@ static BOOL install_device_driver( DEVICE_OBJECT *device, HDEVINFO set, SP_DEVIN
             sizeof_multiszW( ids ) * sizeof(WCHAR) );
     ExFreePool( ids );

+    if (!get_device_id(device, BusQueryContainerID, &ids) && ids)
+    {
+        SetupDiSetDeviceRegistryPropertyW( set, sp_device, SPDRP_BASE_CONTAINERID, (BYTE *)ids,
+            (lstrlenW( ids ) + 1) * sizeof(WCHAR) );
+        ExFreePool( ids );
+    }
+
     if (!SetupDiBuildDriverInfoList( set, sp_device, SPDIT_COMPATDRIVER ))
     {
         ERR("Failed to build compatible driver list, error %#lx.\n", GetLastError());

[PATCH 7/7] ntoskrnl: Set Device ContainerID from driver when registering an interface

[Claire Girka]

From: Claire Girka

---
 dlls/ntoskrnl.exe/pnp.c | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/dlls/ntoskrnl.exe/pnp.c b/dlls/ntoskrnl.exe/pnp.c
index 52da30d0c97..0d3d0dd3286 100644
--- a/dlls/ntoskrnl.exe/pnp.c
+++ b/dlls/ntoskrnl.exe/pnp.c
@@ -880,6 +880,7 @@ NTSTATUS WINAPI IoRegisterDeviceInterface(DEVICE_OBJECT *device, const GUID *cla
     struct wine_rb_entry *entry;
     DWORD required;
     HDEVINFO set;
+    WCHAR *id;

TRACE("device %p, class_guid %s, refstr %s, symbolic_link %p.\n",
             device, debugstr_guid(class_guid), debugstr_us(refstr), symbolic_link);
@@ -913,6 +914,13 @@ NTSTATUS WINAPI IoRegisterDeviceInterface(DEVICE_OBJECT *device, const GUID *cla
         return STATUS_UNSUCCESSFUL;
     }

+    if (!get_device_id(device, BusQueryContainerID, &id) && id)
+    {
+        SetupDiSetDeviceRegistryPropertyW( set, &sp_device, SPDRP_BASE_CONTAINERID, (BYTE *)id,
+            (lstrlenW( id ) + 1) * sizeof(WCHAR) );
+        ExFreePool( id );
+    }
+
     data->DevicePath[1] = '?';
     TRACE("Returning path %s.\n", debugstr_w(data->DevicePath));
     RtlCreateUnicodeString( &device_path, data->DevicePath);