2 * PROJECT: ReactOS Kernel
3 * COPYRIGHT: GPL - See COPYING in the top level directory
4 * FILE: ntoskrnl/io/pnpmgr/plugplay.c
5 * PURPOSE: Plug-and-play interface routines
6 * PROGRAMMERS: Eric Kohl <eric.kohl@t-online.de>
9 /* INCLUDES *****************************************************************/
15 #if defined (ALLOC_PRAGMA)
16 #pragma alloc_text(INIT, IopInitPlugPlayEvents)
19 typedef struct _PNP_EVENT_ENTRY
22 PLUGPLAY_EVENT_BLOCK Event
;
23 } PNP_EVENT_ENTRY
, *PPNP_EVENT_ENTRY
;
26 /* GLOBALS *******************************************************************/
28 static LIST_ENTRY IopPnpEventQueueHead
;
29 static KEVENT IopPnpNotifyEvent
;
31 /* FUNCTIONS *****************************************************************/
33 NTSTATUS INIT_FUNCTION
34 IopInitPlugPlayEvents(VOID
)
36 InitializeListHead(&IopPnpEventQueueHead
);
38 KeInitializeEvent(&IopPnpNotifyEvent
,
42 return STATUS_SUCCESS
;
46 IopQueueTargetDeviceEvent(const GUID
*Guid
,
47 PUNICODE_STRING DeviceIds
)
49 PPNP_EVENT_ENTRY EventEntry
;
56 /* Allocate a big enough buffer */
58 Copy
.MaximumLength
= DeviceIds
->Length
+ sizeof(UNICODE_NULL
);
60 FIELD_OFFSET(PLUGPLAY_EVENT_BLOCK
, TargetDevice
.DeviceIds
) +
63 EventEntry
= ExAllocatePool(NonPagedPool
,
64 TotalSize
+ FIELD_OFFSET(PNP_EVENT_ENTRY
, Event
));
66 return STATUS_INSUFFICIENT_RESOURCES
;
68 /* Fill the buffer with the event GUID */
69 RtlCopyMemory(&EventEntry
->Event
.EventGuid
,
72 EventEntry
->Event
.EventCategory
= TargetDeviceChangeEvent
;
73 EventEntry
->Event
.TotalSize
= TotalSize
;
75 /* Fill the device id */
76 Copy
.Buffer
= EventEntry
->Event
.TargetDevice
.DeviceIds
;
77 Status
= RtlAppendUnicodeStringToString(&Copy
, DeviceIds
);
78 if (!NT_SUCCESS(Status
))
81 InsertHeadList(&IopPnpEventQueueHead
,
82 &EventEntry
->ListEntry
);
83 KeSetEvent(&IopPnpNotifyEvent
,
87 return STATUS_SUCCESS
;
92 * Remove the current PnP event from the tail of the event queue
93 * and signal IopPnpNotifyEvent if there is yet another event in the queue.
96 IopRemovePlugPlayEvent(VOID
)
98 /* Remove a pnp event entry from the tail of the queue */
99 if (!IsListEmpty(&IopPnpEventQueueHead
))
101 ExFreePool(RemoveTailList(&IopPnpEventQueueHead
));
104 /* Signal the next pnp event in the queue */
105 if (!IsListEmpty(&IopPnpEventQueueHead
))
107 KeSetEvent(&IopPnpNotifyEvent
,
112 return STATUS_SUCCESS
;
115 static PDEVICE_OBJECT
116 IopTraverseDeviceNode(PDEVICE_NODE Node
, PUNICODE_STRING DeviceInstance
)
118 PDEVICE_OBJECT DeviceObject
;
119 PDEVICE_NODE ChildNode
;
121 if (RtlEqualUnicodeString(&Node
->InstancePath
,
122 DeviceInstance
, TRUE
))
124 ObReferenceObject(Node
->PhysicalDeviceObject
);
125 return Node
->PhysicalDeviceObject
;
128 /* Traversal of all children nodes */
129 for (ChildNode
= Node
->Child
;
131 ChildNode
= ChildNode
->Sibling
)
133 DeviceObject
= IopTraverseDeviceNode(ChildNode
, DeviceInstance
);
134 if (DeviceObject
!= NULL
)
144 static PDEVICE_OBJECT
145 IopGetDeviceObjectFromDeviceInstance(PUNICODE_STRING DeviceInstance
)
147 if (IopRootDeviceNode
== NULL
)
150 if (DeviceInstance
== NULL
||
151 DeviceInstance
->Length
== 0)
153 if (IopRootDeviceNode
->PhysicalDeviceObject
)
155 ObReferenceObject(IopRootDeviceNode
->PhysicalDeviceObject
);
156 return IopRootDeviceNode
->PhysicalDeviceObject
;
162 return IopTraverseDeviceNode(IopRootDeviceNode
, DeviceInstance
);
167 IopCaptureUnicodeString(PUNICODE_STRING DstName
, PUNICODE_STRING SrcName
)
169 NTSTATUS Status
= STATUS_SUCCESS
;
175 Name
.Length
= SrcName
->Length
;
176 Name
.MaximumLength
= SrcName
->MaximumLength
;
177 if (Name
.Length
> Name
.MaximumLength
)
179 Status
= STATUS_INVALID_PARAMETER
;
183 if (Name
.MaximumLength
)
185 ProbeForRead(SrcName
->Buffer
,
188 Name
.Buffer
= ExAllocatePool(NonPagedPool
, Name
.MaximumLength
);
189 if (Name
.Buffer
== NULL
)
191 Status
= STATUS_INSUFFICIENT_RESOURCES
;
195 memcpy(Name
.Buffer
, SrcName
->Buffer
, Name
.MaximumLength
);
200 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
203 ExFreePool(Name
.Buffer
);
204 Status
= _SEH2_GetExceptionCode();
212 IopGetDeviceProperty(PPLUGPLAY_CONTROL_PROPERTY_DATA PropertyData
)
214 PDEVICE_OBJECT DeviceObject
= NULL
;
216 UNICODE_STRING DeviceInstance
;
221 DPRINT("IopGetDeviceProperty() called\n");
222 DPRINT("Device name: %wZ\n", &PropertyData
->DeviceInstance
);
224 Status
= IopCaptureUnicodeString(&DeviceInstance
, &PropertyData
->DeviceInstance
);
225 if (!NT_SUCCESS(Status
))
232 Property
= PropertyData
->Property
;
233 BufferSize
= PropertyData
->BufferSize
;
234 ProbeForWrite(PropertyData
->Buffer
,
238 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
240 ExFreePool(DeviceInstance
.Buffer
);
241 _SEH2_YIELD(return _SEH2_GetExceptionCode());
245 /* Get the device object */
246 DeviceObject
= IopGetDeviceObjectFromDeviceInstance(&DeviceInstance
);
247 ExFreePool(DeviceInstance
.Buffer
);
248 if (DeviceObject
== NULL
)
250 return STATUS_NO_SUCH_DEVICE
;
253 Buffer
= ExAllocatePool(NonPagedPool
, BufferSize
);
256 return STATUS_INSUFFICIENT_RESOURCES
;
259 Status
= IoGetDeviceProperty(DeviceObject
,
265 ObDereferenceObject(DeviceObject
);
267 if (NT_SUCCESS(Status
))
271 memcpy(PropertyData
->Buffer
, Buffer
, BufferSize
);
272 PropertyData
->BufferSize
= BufferSize
;
274 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
276 Status
= _SEH2_GetExceptionCode();
287 IopGetRelatedDevice(PPLUGPLAY_CONTROL_RELATED_DEVICE_DATA RelatedDeviceData
)
289 UNICODE_STRING RootDeviceName
;
290 PDEVICE_OBJECT DeviceObject
= NULL
;
291 PDEVICE_NODE DeviceNode
= NULL
;
292 PDEVICE_NODE RelatedDeviceNode
;
293 UNICODE_STRING TargetDeviceInstance
;
294 NTSTATUS Status
= STATUS_SUCCESS
;
296 ULONG MaximumLength
= 0;
298 DPRINT("IopGetRelatedDevice() called\n");
299 DPRINT("Device name: %wZ\n", &RelatedDeviceData
->TargetDeviceInstance
);
301 Status
= IopCaptureUnicodeString(&TargetDeviceInstance
, &RelatedDeviceData
->TargetDeviceInstance
);
302 if (!NT_SUCCESS(Status
))
309 Relation
= RelatedDeviceData
->Relation
;
310 MaximumLength
= RelatedDeviceData
->RelatedDeviceInstanceLength
;
311 ProbeForWrite(RelatedDeviceData
->RelatedDeviceInstance
,
315 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
317 ExFreePool(TargetDeviceInstance
.Buffer
);
318 _SEH2_YIELD(return _SEH2_GetExceptionCode());
322 RtlInitUnicodeString(&RootDeviceName
,
324 if (RtlEqualUnicodeString(&TargetDeviceInstance
,
328 DeviceNode
= IopRootDeviceNode
;
329 ExFreePool(TargetDeviceInstance
.Buffer
);
333 /* Get the device object */
334 DeviceObject
= IopGetDeviceObjectFromDeviceInstance(&TargetDeviceInstance
);
335 ExFreePool(TargetDeviceInstance
.Buffer
);
336 if (DeviceObject
== NULL
)
337 return STATUS_NO_SUCH_DEVICE
;
339 DeviceNode
= ((PEXTENDED_DEVOBJ_EXTENSION
)DeviceObject
->DeviceObjectExtension
)->DeviceNode
;
344 case PNP_GET_PARENT_DEVICE
:
345 RelatedDeviceNode
= DeviceNode
->Parent
;
348 case PNP_GET_CHILD_DEVICE
:
349 RelatedDeviceNode
= DeviceNode
->Child
;
352 case PNP_GET_SIBLING_DEVICE
:
353 RelatedDeviceNode
= DeviceNode
->Sibling
;
357 if (DeviceObject
!= NULL
)
359 ObDereferenceObject(DeviceObject
);
362 return STATUS_INVALID_PARAMETER
;
365 if (RelatedDeviceNode
== NULL
)
369 ObDereferenceObject(DeviceObject
);
372 return STATUS_NO_SUCH_DEVICE
;
375 if (RelatedDeviceNode
->InstancePath
.Length
> MaximumLength
)
379 ObDereferenceObject(DeviceObject
);
382 return STATUS_BUFFER_TOO_SMALL
;
385 /* Copy related device instance name */
388 RtlCopyMemory(RelatedDeviceData
->RelatedDeviceInstance
,
389 RelatedDeviceNode
->InstancePath
.Buffer
,
390 RelatedDeviceNode
->InstancePath
.Length
);
391 RelatedDeviceData
->RelatedDeviceInstanceLength
= RelatedDeviceNode
->InstancePath
.Length
;
393 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
395 Status
= _SEH2_GetExceptionCode();
399 if (DeviceObject
!= NULL
)
401 ObDereferenceObject(DeviceObject
);
404 DPRINT("IopGetRelatedDevice() done\n");
411 IopDeviceStatus(PPLUGPLAY_CONTROL_STATUS_DATA StatusData
)
413 PDEVICE_OBJECT DeviceObject
;
414 PDEVICE_NODE DeviceNode
;
416 ULONG DeviceStatus
= 0;
417 ULONG DeviceProblem
= 0;
418 UNICODE_STRING DeviceInstance
;
421 DPRINT("IopDeviceStatus() called\n");
423 Status
= IopCaptureUnicodeString(&DeviceInstance
, &StatusData
->DeviceInstance
);
424 if (!NT_SUCCESS(Status
))
426 DPRINT("Device name: '%wZ'\n", &DeviceInstance
);
430 Operation
= StatusData
->Operation
;
431 if (Operation
== PNP_SET_DEVICE_STATUS
)
433 DeviceStatus
= StatusData
->DeviceStatus
;
434 DeviceProblem
= StatusData
->DeviceProblem
;
437 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
439 if (DeviceInstance
.Buffer
) ExFreePool(DeviceInstance
.Buffer
);
440 _SEH2_YIELD(return _SEH2_GetExceptionCode());
444 /* Get the device object */
445 DeviceObject
= IopGetDeviceObjectFromDeviceInstance(&DeviceInstance
);
446 ExFreePool(DeviceInstance
.Buffer
);
447 if (DeviceObject
== NULL
)
448 return STATUS_NO_SUCH_DEVICE
;
450 DeviceNode
= IopGetDeviceNode(DeviceObject
);
454 case PNP_GET_DEVICE_STATUS
:
455 DPRINT("Get status data\n");
456 DeviceStatus
= DeviceNode
->Flags
;
457 DeviceProblem
= DeviceNode
->Problem
;
460 case PNP_SET_DEVICE_STATUS
:
461 DPRINT("Set status data\n");
462 DeviceNode
->Flags
= DeviceStatus
;
463 DeviceNode
->Problem
= DeviceProblem
;
466 case PNP_CLEAR_DEVICE_STATUS
:
467 DPRINT1("FIXME: Clear status data!\n");
471 ObDereferenceObject(DeviceObject
);
473 if (Operation
== PNP_GET_DEVICE_STATUS
)
477 StatusData
->DeviceStatus
= DeviceStatus
;
478 StatusData
->DeviceProblem
= DeviceProblem
;
480 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
482 Status
= _SEH2_GetExceptionCode();
492 IopGetDeviceDepth(PPLUGPLAY_CONTROL_DEPTH_DATA DepthData
)
494 PDEVICE_OBJECT DeviceObject
;
495 PDEVICE_NODE DeviceNode
;
496 UNICODE_STRING DeviceInstance
;
497 NTSTATUS Status
= STATUS_SUCCESS
;
499 DPRINT("IopGetDeviceDepth() called\n");
500 DPRINT("Device name: %wZ\n", &DepthData
->DeviceInstance
);
502 Status
= IopCaptureUnicodeString(&DeviceInstance
, &DepthData
->DeviceInstance
);
503 if (!NT_SUCCESS(Status
))
508 /* Get the device object */
509 DeviceObject
= IopGetDeviceObjectFromDeviceInstance(&DeviceInstance
);
510 ExFreePool(DeviceInstance
.Buffer
);
511 if (DeviceObject
== NULL
)
512 return STATUS_NO_SUCH_DEVICE
;
514 DeviceNode
= IopGetDeviceNode(DeviceObject
);
518 DepthData
->Depth
= DeviceNode
->Level
;
520 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
522 Status
= _SEH2_GetExceptionCode();
526 ObDereferenceObject(DeviceObject
);
533 IopResetDevice(PPLUGPLAY_CONTROL_RESET_DEVICE_DATA ResetDeviceData
)
535 PDEVICE_OBJECT DeviceObject
;
536 PDEVICE_NODE DeviceNode
;
537 NTSTATUS Status
= STATUS_SUCCESS
;
538 UNICODE_STRING DeviceInstance
;
540 Status
= IopCaptureUnicodeString(&DeviceInstance
, &ResetDeviceData
->DeviceInstance
);
541 if (!NT_SUCCESS(Status
))
544 DPRINT("IopResetDevice(%wZ)\n", &DeviceInstance
);
546 /* Get the device object */
547 DeviceObject
= IopGetDeviceObjectFromDeviceInstance(&DeviceInstance
);
548 ExFreePool(DeviceInstance
.Buffer
);
549 if (DeviceObject
== NULL
)
550 return STATUS_NO_SUCH_DEVICE
;
552 DeviceNode
= IopGetDeviceNode(DeviceObject
);
554 /* FIXME: we should stop the device, before starting it again */
556 /* Start the device */
557 IopDeviceNodeClearFlag(DeviceNode
, DNF_DISABLED
);
558 Status
= IopActionConfigureChildServices(DeviceNode
, DeviceNode
->Parent
);
560 if (NT_SUCCESS(Status
))
561 Status
= IopActionInitChildServices(DeviceNode
, DeviceNode
->Parent
);
563 ObDereferenceObject(DeviceObject
);
568 /* PUBLIC FUNCTIONS **********************************************************/
571 * Plug and Play event structure used by NtGetPlugPlayEvent.
574 * Can be one of the following values:
575 * GUID_HWPROFILE_QUERY_CHANGE
576 * GUID_HWPROFILE_CHANGE_CANCELLED
577 * GUID_HWPROFILE_CHANGE_COMPLETE
578 * GUID_TARGET_DEVICE_QUERY_REMOVE
579 * GUID_TARGET_DEVICE_REMOVE_CANCELLED
580 * GUID_TARGET_DEVICE_REMOVE_COMPLETE
581 * GUID_PNP_CUSTOM_NOTIFICATION
582 * GUID_PNP_POWER_NOTIFICATION
583 * GUID_DEVICE_* (see above)
586 * Type of the event that happened.
595 * Size of the event block including the device IDs and other
596 * per category specific fields.
602 * Returns one Plug & Play event from a global queue.
607 * Always set to zero.
610 * The buffer that will be filled with the event information on
611 * successful return from the function.
614 * Size of the buffer pointed by the Buffer parameter. If the
615 * buffer size is not large enough to hold the whole event
616 * information, error STATUS_BUFFER_TOO_SMALL is returned and
617 * the buffer remains untouched.
620 * STATUS_PRIVILEGE_NOT_HELD
621 * STATUS_BUFFER_TOO_SMALL
625 * This function isn't multi-thread safe!
631 NtGetPlugPlayEvent(IN ULONG Reserved1
,
633 OUT PPLUGPLAY_EVENT_BLOCK Buffer
,
636 PPNP_EVENT_ENTRY Entry
;
639 DPRINT("NtGetPlugPlayEvent() called\n");
641 /* Function can only be called from user-mode */
642 if (KeGetPreviousMode() == KernelMode
)
644 DPRINT1("NtGetPlugPlayEvent cannot be called from kernel mode!\n");
645 return STATUS_ACCESS_DENIED
;
648 /* Check for Tcb privilege */
649 if (!SeSinglePrivilegeCheck(SeTcbPrivilege
,
652 DPRINT1("NtGetPlugPlayEvent: Caller does not hold the SeTcbPrivilege privilege!\n");
653 return STATUS_PRIVILEGE_NOT_HELD
;
656 /* Wait for a PnP event */
657 DPRINT("Waiting for pnp notification event\n");
658 Status
= KeWaitForSingleObject(&IopPnpNotifyEvent
,
663 if (!NT_SUCCESS(Status
))
665 DPRINT1("KeWaitForSingleObject() failed (Status %lx)\n", Status
);
669 /* Get entry from the tail of the queue */
670 Entry
= CONTAINING_RECORD(IopPnpEventQueueHead
.Blink
,
674 /* Check the buffer size */
675 if (BufferSize
< Entry
->Event
.TotalSize
)
677 DPRINT1("Buffer is too small for the pnp-event\n");
678 return STATUS_BUFFER_TOO_SMALL
;
681 /* Copy event data to the user buffer */
684 Entry
->Event
.TotalSize
);
686 DPRINT("NtGetPlugPlayEvent() done\n");
688 return STATUS_SUCCESS
;
694 * A function for doing various Plug & Play operations from user mode.
697 * PlugPlayControlClass
698 * 0x00 Reenumerate device tree
700 * Buffer points to UNICODE_STRING decribing the instance
701 * path (like "HTREE\ROOT\0" or "Root\ACPI_HAL\0000"). For
702 * more information about instance paths see !devnode command
703 * in kernel debugger or look at "Inside Windows 2000" book,
704 * chapter "Driver Loading, Initialization, and Installation".
706 * 0x01 Register new device
707 * 0x02 Deregister device
708 * 0x03 Initialize device
710 * 0x06 Query and remove device
713 * Called after processing the message from NtGetPlugPlayEvent.
715 * 0x08 Generate legacy device
716 * 0x09 Get interface device list
717 * 0x0A Get property data
718 * 0x0B Device class association (Registration)
719 * 0x0C Get related device
720 * 0x0D Get device interface alias
721 * 0x0E Get/set/clear device status
722 * 0x0F Get device depth
723 * 0x10 Query device relations
724 * 0x11 Query target device relation
725 * 0x12 Query conflict list
726 * 0x13 Retrieve dock data
729 * 0x16 Get blocked driver data
732 * The buffer contains information that is specific to each control
733 * code. The buffer is read-only.
736 * Size of the buffer pointed by the Buffer parameter. If the
737 * buffer size specifies incorrect value for specified control
738 * code, error ??? is returned.
741 * STATUS_PRIVILEGE_NOT_HELD
749 NtPlugPlayControl(IN PLUGPLAY_CONTROL_CLASS PlugPlayControlClass
,
751 IN ULONG BufferLength
)
753 DPRINT("NtPlugPlayControl(%lu %p %lu) called\n",
754 PlugPlayControlClass
, Buffer
, BufferLength
);
756 /* Function can only be called from user-mode */
757 if (KeGetPreviousMode() == KernelMode
)
759 DPRINT1("NtGetPlugPlayEvent cannot be called from kernel mode!\n");
760 return STATUS_ACCESS_DENIED
;
763 /* Check for Tcb privilege */
764 if (!SeSinglePrivilegeCheck(SeTcbPrivilege
,
767 DPRINT1("NtGetPlugPlayEvent: Caller does not hold the SeTcbPrivilege privilege!\n");
768 return STATUS_PRIVILEGE_NOT_HELD
;
771 /* Probe the buffer */
774 ProbeForWrite(Buffer
,
778 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
780 _SEH2_YIELD(return _SEH2_GetExceptionCode());
784 switch (PlugPlayControlClass
)
786 case PlugPlayControlUserResponse
:
787 if (Buffer
|| BufferLength
!= 0)
788 return STATUS_INVALID_PARAMETER
;
789 return IopRemovePlugPlayEvent();
791 case PlugPlayControlProperty
:
792 if (!Buffer
|| BufferLength
< sizeof(PLUGPLAY_CONTROL_PROPERTY_DATA
))
793 return STATUS_INVALID_PARAMETER
;
794 return IopGetDeviceProperty((PPLUGPLAY_CONTROL_PROPERTY_DATA
)Buffer
);
796 case PlugPlayControlGetRelatedDevice
:
797 if (!Buffer
|| BufferLength
< sizeof(PLUGPLAY_CONTROL_RELATED_DEVICE_DATA
))
798 return STATUS_INVALID_PARAMETER
;
799 return IopGetRelatedDevice((PPLUGPLAY_CONTROL_RELATED_DEVICE_DATA
)Buffer
);
801 case PlugPlayControlDeviceStatus
:
802 if (!Buffer
|| BufferLength
< sizeof(PLUGPLAY_CONTROL_STATUS_DATA
))
803 return STATUS_INVALID_PARAMETER
;
804 return IopDeviceStatus((PPLUGPLAY_CONTROL_STATUS_DATA
)Buffer
);
806 case PlugPlayControlGetDeviceDepth
:
807 if (!Buffer
|| BufferLength
< sizeof(PLUGPLAY_CONTROL_DEPTH_DATA
))
808 return STATUS_INVALID_PARAMETER
;
809 return IopGetDeviceDepth((PPLUGPLAY_CONTROL_DEPTH_DATA
)Buffer
);
811 case PlugPlayControlResetDevice
:
812 if (!Buffer
|| BufferLength
< sizeof(PLUGPLAY_CONTROL_RESET_DEVICE_DATA
))
813 return STATUS_INVALID_PARAMETER
;
814 return IopResetDevice((PPLUGPLAY_CONTROL_RESET_DEVICE_DATA
)Buffer
);
817 return STATUS_NOT_IMPLEMENTED
;
820 return STATUS_NOT_IMPLEMENTED
;