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
)
209 Status
= PnpRootCreateDevice(&ServiceName
,
213 if (!NT_SUCCESS(Status
))
215 DPRINT("PnpRootCreateDevice() failed (Status 0x%08lx)\n", Status
);
220 /* Create the device node for the new PDO */
221 Status
= IopCreateDeviceNode(IopRootDeviceNode
,
226 if (!NT_SUCCESS(Status
))
228 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 /* REG_OPTION_VOLATILE is a HACK!!! */
252 Status
= IopCreateDeviceKeyPath(&DeviceNode
->InstancePath
, REG_OPTION_VOLATILE
, &InstanceKey
);
253 if (!NT_SUCCESS(Status
))
256 /* Add DETECTEDInterfaceType\DriverName */
258 IdLength
+= swprintf(&HardwareId
[IdLength
],
264 /* Add DETECTED\DriverName */
265 IdLength
+= swprintf(&HardwareId
[IdLength
],
270 /* Terminate the string with another null */
271 HardwareId
[IdLength
++] = UNICODE_NULL
;
273 /* Store the value for CompatibleIDs */
274 RtlInitUnicodeString(&ValueName
, L
"CompatibleIDs");
275 Status
= ZwSetValueKey(InstanceKey
, &ValueName
, 0, REG_MULTI_SZ
, HardwareId
, IdLength
* sizeof(WCHAR
));
276 if (!NT_SUCCESS(Status
))
278 DPRINT("Failed to write the compatible IDs: 0x%x\n", Status
);
279 ZwClose(InstanceKey
);
283 /* Add a hardware ID if the driver didn't report one */
284 RtlInitUnicodeString(&ValueName
, L
"HardwareID");
285 if (ZwQueryValueKey(InstanceKey
, &ValueName
, KeyValueBasicInformation
, NULL
, 0, &RequiredLength
) == STATUS_OBJECT_NAME_NOT_FOUND
)
287 /* Just use our most specific compatible ID */
289 IdLength
+= swprintf(&HardwareId
[IdLength
],
295 HardwareId
[IdLength
++] = UNICODE_NULL
;
297 /* Write the value to the registry */
298 Status
= ZwSetValueKey(InstanceKey
, &ValueName
, 0, REG_MULTI_SZ
, HardwareId
, IdLength
* sizeof(WCHAR
));
299 if (!NT_SUCCESS(Status
))
301 DPRINT("Failed to write the hardware ID: 0x%x\n", Status
);
302 ZwClose(InstanceKey
);
307 /* Assign the resources to the device node */
308 DeviceNode
->BootResources
= ResourceList
;
309 DeviceNode
->ResourceRequirements
= ResourceRequirements
;
311 /* Set appropriate flags */
312 if (DeviceNode
->BootResources
)
313 IopDeviceNodeSetFlag(DeviceNode
, DNF_HAS_BOOT_CONFIG
);
315 if (!DeviceNode
->ResourceRequirements
&& !DeviceNode
->BootResources
)
316 IopDeviceNodeSetFlag(DeviceNode
, DNF_NO_RESOURCE_REQUIRED
);
318 /* Write the resource information to the registry */
319 IopSetDeviceInstanceData(InstanceKey
, DeviceNode
);
321 /* If the caller didn't get the resources assigned for us, do it now */
322 if (!ResourceAssigned
)
324 Status
= IopAssignDeviceResources(DeviceNode
);
326 /* See if we failed */
327 if (!NT_SUCCESS(Status
))
329 DPRINT("Assigning resources failed: 0x%x\n", Status
);
330 ZwClose(InstanceKey
);
335 /* Close the instance key handle */
336 ZwClose(InstanceKey
);
338 /* Report the device's enumeration to umpnpmgr */
339 IopQueueTargetDeviceEvent(&GUID_DEVICE_ENUMERATED
,
340 &DeviceNode
->InstancePath
);
342 /* Report the device's arrival to umpnpmgr */
343 IopQueueTargetDeviceEvent(&GUID_DEVICE_ARRIVAL
,
344 &DeviceNode
->InstancePath
);
346 DPRINT1("Reported device: %S (%wZ)\n", HardwareId
, &DeviceNode
->InstancePath
);
349 if (DeviceObject
) *DeviceObject
= Pdo
;
351 return STATUS_SUCCESS
;
359 IoReportResourceForDetection(IN PDRIVER_OBJECT DriverObject
,
360 IN PCM_RESOURCE_LIST DriverList OPTIONAL
,
361 IN ULONG DriverListSize OPTIONAL
,
362 IN PDEVICE_OBJECT DeviceObject OPTIONAL
,
363 IN PCM_RESOURCE_LIST DeviceList OPTIONAL
,
364 IN ULONG DeviceListSize OPTIONAL
,
365 OUT PBOOLEAN ConflictDetected
)
367 PCM_RESOURCE_LIST ResourceList
;
370 *ConflictDetected
= FALSE
;
372 if (!DriverList
&& !DeviceList
)
373 return STATUS_INVALID_PARAMETER
;
375 /* Find the real list */
377 ResourceList
= DeviceList
;
379 ResourceList
= DriverList
;
381 /* Look for a resource conflict */
382 Status
= IopDetectResourceConflict(ResourceList
, FALSE
, NULL
);
383 if (Status
== STATUS_CONFLICTING_ADDRESSES
)
386 *ConflictDetected
= TRUE
;
388 else if (NT_SUCCESS(Status
))
390 /* Looks like we're good to go */
392 /* TODO: Claim the resources in the ResourceMap */
400 IopSetEvent(IN PVOID Context
)
402 PKEVENT Event
= Context
;
405 KeSetEvent(Event
, IO_NO_INCREMENT
, FALSE
);
413 IoReportTargetDeviceChange(IN PDEVICE_OBJECT PhysicalDeviceObject
,
414 IN PVOID NotificationStructure
)
417 NTSTATUS Status
, NotifyStatus
;
418 PTARGET_DEVICE_CUSTOM_NOTIFICATION notifyStruct
= (PTARGET_DEVICE_CUSTOM_NOTIFICATION
)NotificationStructure
;
420 ASSERT(notifyStruct
);
422 /* Check for valid PDO */
423 if (!IopIsValidPhysicalDeviceObject(PhysicalDeviceObject
))
425 KeBugCheckEx(PNP_DETECTED_FATAL_ERROR
, 0x2, (ULONG
)PhysicalDeviceObject
, 0, 0);
428 /* FileObject must be null. PnP will fill in it */
429 ASSERT(notifyStruct
->FileObject
== NULL
);
431 /* Do not handle system PnP events */
432 if ((RtlCompareMemory(&(notifyStruct
->Event
), &(GUID_TARGET_DEVICE_QUERY_REMOVE
), sizeof(GUID
)) != sizeof(GUID
)) ||
433 (RtlCompareMemory(&(notifyStruct
->Event
), &(GUID_TARGET_DEVICE_REMOVE_CANCELLED
), sizeof(GUID
)) != sizeof(GUID
)) ||
434 (RtlCompareMemory(&(notifyStruct
->Event
), &(GUID_TARGET_DEVICE_REMOVE_COMPLETE
), sizeof(GUID
)) != sizeof(GUID
)))
436 return STATUS_INVALID_DEVICE_REQUEST
;
439 if (notifyStruct
->Version
!= 1)
441 return STATUS_INVALID_DEVICE_REQUEST
;
444 /* Initialize even that will let us know when PnP will have finished notify */
445 KeInitializeEvent(&NotifyEvent
, NotificationEvent
, FALSE
);
447 Status
= PpSetCustomTargetEvent(PhysicalDeviceObject
, &NotifyEvent
, &NotifyStatus
, NULL
, NULL
, notifyStruct
);
448 /* If no error, wait for the notify to end and return the status of the notify and not of the event */
449 if (NT_SUCCESS(Status
))
451 KeWaitForSingleObject(&NotifyEvent
, Executive
, KernelMode
, FALSE
, NULL
);
452 Status
= NotifyStatus
;
463 IoReportTargetDeviceChangeAsynchronous(IN PDEVICE_OBJECT PhysicalDeviceObject
,
464 IN PVOID NotificationStructure
,
465 IN PDEVICE_CHANGE_COMPLETE_CALLBACK Callback OPTIONAL
,
466 IN PVOID Context OPTIONAL
)
468 PINTERNAL_WORK_QUEUE_ITEM Item
= NULL
;
469 PTARGET_DEVICE_CUSTOM_NOTIFICATION notifyStruct
= (PTARGET_DEVICE_CUSTOM_NOTIFICATION
)NotificationStructure
;
471 ASSERT(notifyStruct
);
473 /* Check for valid PDO */
474 if (!IopIsValidPhysicalDeviceObject(PhysicalDeviceObject
))
476 KeBugCheckEx(PNP_DETECTED_FATAL_ERROR
, 0x2, (ULONG
)PhysicalDeviceObject
, 0, 0);
479 /* FileObject must be null. PnP will fill in it */
480 ASSERT(notifyStruct
->FileObject
== NULL
);
482 /* Do not handle system PnP events */
483 if ((RtlCompareMemory(&(notifyStruct
->Event
), &(GUID_TARGET_DEVICE_QUERY_REMOVE
), sizeof(GUID
)) != sizeof(GUID
)) ||
484 (RtlCompareMemory(&(notifyStruct
->Event
), &(GUID_TARGET_DEVICE_REMOVE_CANCELLED
), sizeof(GUID
)) != sizeof(GUID
)) ||
485 (RtlCompareMemory(&(notifyStruct
->Event
), &(GUID_TARGET_DEVICE_REMOVE_COMPLETE
), sizeof(GUID
)) != sizeof(GUID
)))
487 return STATUS_INVALID_DEVICE_REQUEST
;
490 if (notifyStruct
->Version
!= 1)
492 return STATUS_INVALID_DEVICE_REQUEST
;
495 /* We need to store all the data given by the caller with the WorkItem, so use our own struct */
496 Item
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(INTERNAL_WORK_QUEUE_ITEM
), ' pP');
497 if (!Item
) return STATUS_INSUFFICIENT_RESOURCES
;
499 /* Initialize all stuff */
500 ObReferenceObject(PhysicalDeviceObject
);
501 Item
->NotificationStructure
= notifyStruct
;
502 Item
->PhysicalDeviceObject
= PhysicalDeviceObject
;
503 Item
->Callback
= Callback
;
504 Item
->Context
= Context
;
505 ExInitializeWorkItem(&(Item
->WorkItem
), (PWORKER_THREAD_ROUTINE
)IopReportTargetDeviceChangeAsyncWorker
, Item
);
507 /* Finally, queue the item, our work here is done */
508 ExQueueWorkItem(&(Item
->WorkItem
), DelayedWorkQueue
);
510 return STATUS_PENDING
;