2 * PROJECT: ReactOS Kernel
3 * COPYRIGHT: GPL - See COPYING in the top level directory
4 * FILE: ntoskrnl/io/pnpmgr/pnpreport.c
5 * PURPOSE: Device Changes Reporting Functions
6 * PROGRAMMERS: Cameron Gutman (cameron.gutman@reactos.org)
10 /* INCLUDES ******************************************************************/
16 /* TYPES *******************************************************************/
18 typedef struct _INTERNAL_WORK_QUEUE_ITEM
20 WORK_QUEUE_ITEM WorkItem
;
21 PDEVICE_OBJECT PhysicalDeviceObject
;
22 PDEVICE_CHANGE_COMPLETE_CALLBACK Callback
;
24 PTARGET_DEVICE_CUSTOM_NOTIFICATION NotificationStructure
;
25 } INTERNAL_WORK_QUEUE_ITEM
, *PINTERNAL_WORK_QUEUE_ITEM
;
29 IopCreateDeviceKeyPath(IN PCUNICODE_STRING RegistryPath
,
30 IN ULONG CreateOptions
,
34 IopSetDeviceInstanceData(HANDLE InstanceKey
,
35 PDEVICE_NODE DeviceNode
);
38 IopActionInterrogateDeviceStack(PDEVICE_NODE DeviceNode
,
42 PpSetCustomTargetEvent(IN PDEVICE_OBJECT DeviceObject
,
43 IN OUT PKEVENT SyncEvent OPTIONAL
,
44 IN OUT PNTSTATUS SyncStatus OPTIONAL
,
45 IN PDEVICE_CHANGE_COMPLETE_CALLBACK Callback OPTIONAL
,
46 IN PVOID Context OPTIONAL
,
47 IN PTARGET_DEVICE_CUSTOM_NOTIFICATION NotificationStructure
);
49 /* PRIVATE FUNCTIONS *********************************************************/
52 IopGetInterfaceTypeString(INTERFACE_TYPE IfType
)
66 return L
"MicroChannel";
69 return L
"TurboChannel";
92 case ProcessorInternal
:
93 return L
"ProcessorInternal";
105 DPRINT1("Invalid bus type: %d\n", IfType
);
111 IopReportTargetDeviceChangeAsyncWorker(PVOID Context
)
113 PINTERNAL_WORK_QUEUE_ITEM Item
;
115 Item
= (PINTERNAL_WORK_QUEUE_ITEM
)Context
;
116 PpSetCustomTargetEvent(Item
->PhysicalDeviceObject
, NULL
, NULL
, Item
->Callback
, Item
->Context
, Item
->NotificationStructure
);
117 ObDereferenceObject(Item
->PhysicalDeviceObject
);
118 ExFreePoolWithTag(Context
, ' pP');
122 PpSetCustomTargetEvent(IN PDEVICE_OBJECT DeviceObject
,
123 IN OUT PKEVENT SyncEvent OPTIONAL
,
124 IN OUT PNTSTATUS SyncStatus OPTIONAL
,
125 IN PDEVICE_CHANGE_COMPLETE_CALLBACK Callback OPTIONAL
,
126 IN PVOID Context OPTIONAL
,
127 IN PTARGET_DEVICE_CUSTOM_NOTIFICATION NotificationStructure
)
129 ASSERT(NotificationStructure
!= NULL
);
130 ASSERT(DeviceObject
!= NULL
);
135 *SyncStatus
= STATUS_PENDING
;
138 /* That call is totally wrong but notifications handler must be fixed first */
139 IopNotifyPlugPlayNotification(DeviceObject
,
140 EventCategoryTargetDeviceChange
,
141 &GUID_PNP_CUSTOM_NOTIFICATION
,
142 NotificationStructure
,
147 KeSetEvent(SyncEvent
, IO_NO_INCREMENT
, FALSE
);
148 *SyncStatus
= STATUS_SUCCESS
;
151 return STATUS_SUCCESS
;
154 /* PUBLIC FUNCTIONS **********************************************************/
161 IoReportDetectedDevice(IN PDRIVER_OBJECT DriverObject
,
162 IN INTERFACE_TYPE LegacyBusType
,
165 IN PCM_RESOURCE_LIST ResourceList
,
166 IN PIO_RESOURCE_REQUIREMENTS_LIST ResourceRequirements OPTIONAL
,
167 IN BOOLEAN ResourceAssigned
,
168 IN OUT PDEVICE_OBJECT
*DeviceObject OPTIONAL
)
170 PDEVICE_NODE DeviceNode
;
174 ULONG RequiredLength
;
175 UNICODE_STRING ValueName
, ServiceName
;
176 WCHAR HardwareId
[256];
180 DPRINT("IoReportDetectedDevice (DeviceObject %p, *DeviceObject %p)\n",
181 DeviceObject
, DeviceObject
? *DeviceObject
: NULL
);
183 /* Create the service name (eg. ACPI_HAL) */
184 ServiceName
.Buffer
= DriverObject
->DriverName
.Buffer
+
185 sizeof(DRIVER_ROOT_NAME
) / sizeof(WCHAR
) - 1;
186 ServiceName
.Length
= DriverObject
->DriverName
.Length
-
187 sizeof(DRIVER_ROOT_NAME
) + sizeof(WCHAR
);
188 ServiceName
.MaximumLength
= ServiceName
.Length
;
190 /* If the interface type is unknown, treat it as internal */
191 if (LegacyBusType
== InterfaceTypeUndefined
)
192 LegacyBusType
= Internal
;
194 /* Get the string equivalent of the interface type */
195 IfString
= IopGetInterfaceTypeString(LegacyBusType
);
197 /* If NULL is returned then it's a bad type */
199 return STATUS_INVALID_PARAMETER
;
201 /* We use the caller's PDO if they supplied one */
202 if (DeviceObject
&& *DeviceObject
)
205 DeviceNode
= IopGetDeviceNode(*DeviceObject
);
210 Status
= PnpRootCreateDevice(&ServiceName
,
213 if (!NT_SUCCESS(Status
))
215 DPRINT("PnpRootCreateDevice() failed (Status 0x%08lx)\n", Status
);
219 /* Create the device node for the new PDO */
220 Status
= IopCreateDeviceNode(IopRootDeviceNode
,
225 if (!NT_SUCCESS(Status
))
227 DPRINT("IopCreateDeviceNode() failed (Status 0x%08lx)\n", Status
);
232 /* We don't call AddDevice for devices reported this way */
233 IopDeviceNodeSetFlag(DeviceNode
, DNF_ADDED
);
235 /* We don't send IRP_MN_START_DEVICE */
236 IopDeviceNodeSetFlag(DeviceNode
, DNF_STARTED
);
238 /* We need to get device IDs */
240 IopDeviceNodeSetFlag(DeviceNode
, DNF_NEED_QUERY_IDS
);
243 /* This is a legacy driver for this device */
244 IopDeviceNodeSetFlag(DeviceNode
, DNF_LEGACY_DRIVER
);
246 /* Perform a manual configuration of our device */
247 IopActionInterrogateDeviceStack(DeviceNode
, DeviceNode
->Parent
);
248 IopActionConfigureChildServices(DeviceNode
, DeviceNode
->Parent
);
250 /* Open a handle to the instance path key */
251 Status
= IopCreateDeviceKeyPath(&DeviceNode
->InstancePath
, 0, &InstanceKey
);
252 if (!NT_SUCCESS(Status
))
255 /* Add DETECTEDInterfaceType\DriverName */
257 IdLength
+= swprintf(&HardwareId
[IdLength
],
261 HardwareId
[IdLength
++] = UNICODE_NULL
;
263 /* Add DETECTED\DriverName */
264 IdLength
+= swprintf(&HardwareId
[IdLength
],
267 HardwareId
[IdLength
++] = UNICODE_NULL
;
269 /* Terminate the string with another null */
270 HardwareId
[IdLength
] = UNICODE_NULL
;
272 /* Store the value for CompatibleIDs */
273 RtlInitUnicodeString(&ValueName
, L
"CompatibleIDs");
274 Status
= ZwSetValueKey(InstanceKey
, &ValueName
, 0, REG_MULTI_SZ
, HardwareId
, IdLength
* sizeof(WCHAR
));
275 if (!NT_SUCCESS(Status
))
277 DPRINT("Failed to write the compatible IDs: 0x%x\n", Status
);
278 ZwClose(InstanceKey
);
282 /* Add a hardware ID if the driver didn't report one */
283 RtlInitUnicodeString(&ValueName
, L
"HardwareID");
284 if (ZwQueryValueKey(InstanceKey
, &ValueName
, KeyValueBasicInformation
, NULL
, 0, &RequiredLength
) == STATUS_OBJECT_NAME_NOT_FOUND
)
286 /* Just use our most specific compatible ID */
288 IdLength
+= swprintf(&HardwareId
[IdLength
],
292 HardwareId
[++IdLength
] = UNICODE_NULL
;
294 /* Write the value to the registry */
295 Status
= ZwSetValueKey(InstanceKey
, &ValueName
, 0, REG_SZ
, HardwareId
, IdLength
* sizeof(WCHAR
));
296 if (!NT_SUCCESS(Status
))
298 DPRINT("Failed to write the hardware ID: 0x%x\n", Status
);
299 ZwClose(InstanceKey
);
304 /* Assign the resources to the device node */
305 DeviceNode
->BootResources
= ResourceList
;
306 DeviceNode
->ResourceRequirements
= ResourceRequirements
;
308 /* Set appropriate flags */
309 if (DeviceNode
->BootResources
)
310 IopDeviceNodeSetFlag(DeviceNode
, DNF_HAS_BOOT_CONFIG
);
312 if (!DeviceNode
->ResourceRequirements
&& !DeviceNode
->BootResources
)
313 IopDeviceNodeSetFlag(DeviceNode
, DNF_NO_RESOURCE_REQUIRED
);
315 /* Write the resource information to the registry */
316 IopSetDeviceInstanceData(InstanceKey
, DeviceNode
);
318 /* If the caller didn't get the resources assigned for us, do it now */
319 if (!ResourceAssigned
)
321 Status
= IopAssignDeviceResources(DeviceNode
);
323 /* See if we failed */
324 if (!NT_SUCCESS(Status
))
326 DPRINT("Assigning resources failed: 0x%x\n", Status
);
327 ZwClose(InstanceKey
);
332 /* Close the instance key handle */
333 ZwClose(InstanceKey
);
335 /* Report the device's enumeration to umpnpmgr */
336 IopQueueTargetDeviceEvent(&GUID_DEVICE_ENUMERATED
,
337 &DeviceNode
->InstancePath
);
339 /* Report the device's arrival to umpnpmgr */
340 IopQueueTargetDeviceEvent(&GUID_DEVICE_ARRIVAL
,
341 &DeviceNode
->InstancePath
);
343 DPRINT1("Reported device: %S (%wZ)\n", HardwareId
, &DeviceNode
->InstancePath
);
346 if (DeviceObject
) *DeviceObject
= Pdo
;
348 return STATUS_SUCCESS
;
356 IoReportResourceForDetection(IN PDRIVER_OBJECT DriverObject
,
357 IN PCM_RESOURCE_LIST DriverList OPTIONAL
,
358 IN ULONG DriverListSize OPTIONAL
,
359 IN PDEVICE_OBJECT DeviceObject OPTIONAL
,
360 IN PCM_RESOURCE_LIST DeviceList OPTIONAL
,
361 IN ULONG DeviceListSize OPTIONAL
,
362 OUT PBOOLEAN ConflictDetected
)
364 PCM_RESOURCE_LIST ResourceList
;
367 *ConflictDetected
= FALSE
;
369 if (!DriverList
&& !DeviceList
)
370 return STATUS_INVALID_PARAMETER
;
372 /* Find the real list */
374 ResourceList
= DeviceList
;
376 ResourceList
= DriverList
;
378 /* Look for a resource conflict */
379 Status
= IopDetectResourceConflict(ResourceList
, FALSE
, NULL
);
380 if (Status
== STATUS_CONFLICTING_ADDRESSES
)
383 *ConflictDetected
= TRUE
;
385 else if (NT_SUCCESS(Status
))
387 /* Looks like we're good to go */
389 /* TODO: Claim the resources in the ResourceMap */
397 IopSetEvent(IN PVOID Context
)
399 PKEVENT Event
= Context
;
402 KeSetEvent(Event
, IO_NO_INCREMENT
, FALSE
);
410 IoReportTargetDeviceChange(IN PDEVICE_OBJECT PhysicalDeviceObject
,
411 IN PVOID NotificationStructure
)
414 NTSTATUS Status
, NotifyStatus
;
415 PTARGET_DEVICE_CUSTOM_NOTIFICATION notifyStruct
= (PTARGET_DEVICE_CUSTOM_NOTIFICATION
)NotificationStructure
;
417 ASSERT(notifyStruct
);
419 /* Check for valid PDO */
420 if (!IopIsValidPhysicalDeviceObject(PhysicalDeviceObject
))
422 KeBugCheckEx(PNP_DETECTED_FATAL_ERROR
, 0x2, (ULONG
)PhysicalDeviceObject
, 0, 0);
425 /* FileObject must be null. PnP will fill in it */
426 ASSERT(notifyStruct
->FileObject
== NULL
);
428 /* Do not handle system PnP events */
429 if ((RtlCompareMemory(&(notifyStruct
->Event
), &(GUID_TARGET_DEVICE_QUERY_REMOVE
), sizeof(GUID
)) != sizeof(GUID
)) ||
430 (RtlCompareMemory(&(notifyStruct
->Event
), &(GUID_TARGET_DEVICE_REMOVE_CANCELLED
), sizeof(GUID
)) != sizeof(GUID
)) ||
431 (RtlCompareMemory(&(notifyStruct
->Event
), &(GUID_TARGET_DEVICE_REMOVE_COMPLETE
), sizeof(GUID
)) != sizeof(GUID
)))
433 return STATUS_INVALID_DEVICE_REQUEST
;
436 if (notifyStruct
->Version
!= 1)
438 return STATUS_INVALID_DEVICE_REQUEST
;
441 /* Initialize even that will let us know when PnP will have finished notify */
442 KeInitializeEvent(&NotifyEvent
, NotificationEvent
, FALSE
);
444 Status
= PpSetCustomTargetEvent(PhysicalDeviceObject
, &NotifyEvent
, &NotifyStatus
, NULL
, NULL
, notifyStruct
);
445 /* If no error, wait for the notify to end and return the status of the notify and not of the event */
446 if (NT_SUCCESS(Status
))
448 KeWaitForSingleObject(&NotifyEvent
, Executive
, KernelMode
, FALSE
, NULL
);
449 Status
= NotifyStatus
;
460 IoReportTargetDeviceChangeAsynchronous(IN PDEVICE_OBJECT PhysicalDeviceObject
,
461 IN PVOID NotificationStructure
,
462 IN PDEVICE_CHANGE_COMPLETE_CALLBACK Callback OPTIONAL
,
463 IN PVOID Context OPTIONAL
)
465 PINTERNAL_WORK_QUEUE_ITEM Item
= NULL
;
466 PTARGET_DEVICE_CUSTOM_NOTIFICATION notifyStruct
= (PTARGET_DEVICE_CUSTOM_NOTIFICATION
)NotificationStructure
;
468 ASSERT(notifyStruct
);
470 /* Check for valid PDO */
471 if (!IopIsValidPhysicalDeviceObject(PhysicalDeviceObject
))
473 KeBugCheckEx(PNP_DETECTED_FATAL_ERROR
, 0x2, (ULONG
)PhysicalDeviceObject
, 0, 0);
476 /* FileObject must be null. PnP will fill in it */
477 ASSERT(notifyStruct
->FileObject
== NULL
);
479 /* Do not handle system PnP events */
480 if ((RtlCompareMemory(&(notifyStruct
->Event
), &(GUID_TARGET_DEVICE_QUERY_REMOVE
), sizeof(GUID
)) != sizeof(GUID
)) ||
481 (RtlCompareMemory(&(notifyStruct
->Event
), &(GUID_TARGET_DEVICE_REMOVE_CANCELLED
), sizeof(GUID
)) != sizeof(GUID
)) ||
482 (RtlCompareMemory(&(notifyStruct
->Event
), &(GUID_TARGET_DEVICE_REMOVE_COMPLETE
), sizeof(GUID
)) != sizeof(GUID
)))
484 return STATUS_INVALID_DEVICE_REQUEST
;
487 if (notifyStruct
->Version
!= 1)
489 return STATUS_INVALID_DEVICE_REQUEST
;
492 /* We need to store all the data given by the caller with the WorkItem, so use our own struct */
493 Item
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(INTERNAL_WORK_QUEUE_ITEM
), ' pP');
494 if (!Item
) return STATUS_INSUFFICIENT_RESOURCES
;
496 /* Initialize all stuff */
497 ObReferenceObject(PhysicalDeviceObject
);
498 Item
->NotificationStructure
= notifyStruct
;
499 Item
->PhysicalDeviceObject
= PhysicalDeviceObject
;
500 Item
->Callback
= Callback
;
501 Item
->Context
= Context
;
502 ExInitializeWorkItem(&(Item
->WorkItem
), (PWORKER_THREAD_ROUTINE
)IopReportTargetDeviceChangeAsyncWorker
, Item
);
504 /* Finally, queue the item, our work here is done */
505 ExQueueWorkItem(&(Item
->WorkItem
), DelayedWorkQueue
);
507 return STATUS_PENDING
;