2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS Keyboard class driver
4 * FILE: drivers/kbdclass/kbdclass.c
5 * PURPOSE: Keyboard class driver
7 * PROGRAMMERS: Hervé Poussineau (hpoussin@reactos.org)
13 static DRIVER_UNLOAD DriverUnload
;
14 static DRIVER_DISPATCH ClassCreate
;
15 static DRIVER_DISPATCH ClassClose
;
16 static DRIVER_DISPATCH ClassCleanup
;
17 static DRIVER_DISPATCH ClassRead
;
18 static DRIVER_DISPATCH ClassDeviceControl
;
19 static DRIVER_DISPATCH IrpStub
;
20 static DRIVER_ADD_DEVICE ClassAddDevice
;
21 static DRIVER_STARTIO ClassStartIo
;
22 static DRIVER_CANCEL ClassCancelRoutine
;
25 IN PDEVICE_OBJECT DeviceObject
,
30 DriverUnload(IN PDRIVER_OBJECT DriverObject
)
32 // nothing to do here yet
37 IN PDEVICE_OBJECT DeviceObject
,
40 TRACE_(CLASS_NAME
, "IRP_MJ_CREATE\n");
42 if (!((PCOMMON_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
)->IsClassDO
)
43 return ForwardIrpAndForget(DeviceObject
, Irp
);
45 /* FIXME: open all associated Port devices */
46 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
47 Irp
->IoStatus
.Information
= 0;
48 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
49 return STATUS_SUCCESS
;
54 IN PDEVICE_OBJECT DeviceObject
,
57 TRACE_(CLASS_NAME
, "IRP_MJ_CLOSE\n");
59 if (!((PCOMMON_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
)->IsClassDO
)
60 return ForwardIrpAndForget(DeviceObject
, Irp
);
62 /* FIXME: close all associated Port devices */
63 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
64 Irp
->IoStatus
.Information
= 0;
65 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
66 return STATUS_SUCCESS
;
71 IN PDEVICE_OBJECT DeviceObject
,
74 TRACE_(CLASS_NAME
, "IRP_MJ_CLEANUP\n");
76 if (!((PCOMMON_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
)->IsClassDO
)
77 return ForwardIrpAndForget(DeviceObject
, Irp
);
79 /* FIXME: cleanup all associated Port devices */
80 Irp
->IoStatus
.Status
= STATUS_SUCCESS
;
81 Irp
->IoStatus
.Information
= 0;
82 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
83 return STATUS_SUCCESS
;
88 IN PDEVICE_OBJECT DeviceObject
,
91 PCLASS_DEVICE_EXTENSION DeviceExtension
= DeviceObject
->DeviceExtension
;
95 TRACE_(CLASS_NAME
, "IRP_MJ_READ\n");
97 ASSERT(DeviceExtension
->Common
.IsClassDO
);
99 if (!((PCOMMON_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
)->IsClassDO
)
100 return ForwardIrpAndForget(DeviceObject
, Irp
);
102 if (IoGetCurrentIrpStackLocation(Irp
)->Parameters
.Read
.Length
< sizeof(KEYBOARD_INPUT_DATA
))
104 Irp
->IoStatus
.Status
= STATUS_BUFFER_TOO_SMALL
;
105 Irp
->IoStatus
.Information
= 0;
106 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
108 return STATUS_BUFFER_TOO_SMALL
;
111 KeAcquireSpinLock(&DeviceExtension
->SpinLock
, &OldIrql
);
112 Status
= HandleReadIrp(DeviceObject
, Irp
, FALSE
);
113 KeReleaseSpinLock(&DeviceExtension
->SpinLock
, OldIrql
);
117 static NTSTATUS NTAPI
119 IN PDEVICE_OBJECT DeviceObject
,
122 PCLASS_DEVICE_EXTENSION DeviceExtension
;
123 NTSTATUS Status
= STATUS_NOT_SUPPORTED
;
125 TRACE_(CLASS_NAME
, "IRP_MJ_DEVICE_CONTROL\n");
127 if (!((PCOMMON_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
)->IsClassDO
)
128 return ForwardIrpAndForget(DeviceObject
, Irp
);
130 DeviceExtension
= (PCLASS_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
;
132 switch (IoGetCurrentIrpStackLocation(Irp
)->Parameters
.DeviceIoControl
.IoControlCode
)
134 case IOCTL_KEYBOARD_QUERY_ATTRIBUTES
:
135 case IOCTL_KEYBOARD_QUERY_INDICATOR_TRANSLATION
:
136 case IOCTL_KEYBOARD_QUERY_INDICATORS
:
137 case IOCTL_KEYBOARD_QUERY_TYPEMATIC
:
139 /* FIXME: We hope that all devices will return the same result.
140 * Ask only the first one */
141 PLIST_ENTRY Head
= &((PCLASS_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
)->ListHead
;
142 if (Head
->Flink
!= Head
)
144 /* We have at least one device */
145 PPORT_DEVICE_EXTENSION DevExt
= CONTAINING_RECORD(Head
->Flink
, PORT_DEVICE_EXTENSION
, ListEntry
);
146 IoGetCurrentIrpStackLocation(Irp
)->MajorFunction
= IRP_MJ_INTERNAL_DEVICE_CONTROL
;
147 IoSkipCurrentIrpStackLocation(Irp
);
148 return IoCallDriver(DevExt
->DeviceObject
, Irp
);
152 case IOCTL_KEYBOARD_SET_INDICATORS
:
153 case IOCTL_KEYBOARD_SET_TYPEMATIC
: /* not in MSDN, would seem logical */
155 /* Send it to all associated Port devices */
156 PLIST_ENTRY Head
= &((PCLASS_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
)->ListHead
;
157 PLIST_ENTRY Entry
= Head
->Flink
;
158 Status
= STATUS_SUCCESS
;
159 while (Entry
!= Head
)
161 PPORT_DEVICE_EXTENSION DevExt
= CONTAINING_RECORD(Entry
, PORT_DEVICE_EXTENSION
, ListEntry
);
162 NTSTATUS IntermediateStatus
;
164 IoGetCurrentIrpStackLocation(Irp
)->MajorFunction
= IRP_MJ_INTERNAL_DEVICE_CONTROL
;
165 IntermediateStatus
= ForwardIrpAndWait(DevExt
->DeviceObject
, Irp
);
166 if (!NT_SUCCESS(IntermediateStatus
))
167 Status
= IntermediateStatus
;
168 Entry
= Entry
->Flink
;
173 WARN_(CLASS_NAME
, "IRP_MJ_DEVICE_CONTROL / unknown I/O control code 0x%lx\n",
174 IoGetCurrentIrpStackLocation(Irp
)->Parameters
.DeviceIoControl
.IoControlCode
);
179 Irp
->IoStatus
.Status
= Status
;
180 Irp
->IoStatus
.Information
= 0;
181 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
186 static NTSTATUS NTAPI
188 IN PDEVICE_OBJECT DeviceObject
,
191 NTSTATUS Status
= STATUS_NOT_SUPPORTED
;
193 if (!((PCOMMON_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
)->IsClassDO
)
195 /* Forward some IRPs to lower device */
196 switch (IoGetCurrentIrpStackLocation(Irp
)->MajorFunction
)
199 case IRP_MJ_INTERNAL_DEVICE_CONTROL
:
200 return ForwardIrpAndForget(DeviceObject
, Irp
);
203 ERR_(CLASS_NAME
, "Port DO stub for major function 0x%lx\n",
204 IoGetCurrentIrpStackLocation(Irp
)->MajorFunction
);
211 ERR_(CLASS_NAME
, "Class DO stub for major function 0x%lx\n",
212 IoGetCurrentIrpStackLocation(Irp
)->MajorFunction
);
216 Irp
->IoStatus
.Status
= Status
;
217 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
223 IN PUNICODE_STRING RegistryPath
,
224 IN PCLASS_DRIVER_EXTENSION DriverExtension
)
226 UNICODE_STRING ParametersRegistryKey
;
227 RTL_QUERY_REGISTRY_TABLE Parameters
[4];
230 ULONG DefaultConnectMultiplePorts
= 0;
231 ULONG DefaultDataQueueSize
= 0x64;
232 PCWSTR DefaultDeviceBaseName
= L
"KeyboardClass";
234 ParametersRegistryKey
.Length
= 0;
235 ParametersRegistryKey
.MaximumLength
= RegistryPath
->Length
+ sizeof(L
"\\Parameters") + sizeof(UNICODE_NULL
);
236 ParametersRegistryKey
.Buffer
= ExAllocatePoolWithTag(PagedPool
, ParametersRegistryKey
.MaximumLength
, CLASS_TAG
);
237 if (!ParametersRegistryKey
.Buffer
)
239 WARN_(CLASS_NAME
, "ExAllocatePoolWithTag() failed\n");
240 return STATUS_NO_MEMORY
;
242 RtlCopyUnicodeString(&ParametersRegistryKey
, RegistryPath
);
243 RtlAppendUnicodeToString(&ParametersRegistryKey
, L
"\\Parameters");
244 ParametersRegistryKey
.Buffer
[ParametersRegistryKey
.Length
/ sizeof(WCHAR
)] = UNICODE_NULL
;
246 RtlZeroMemory(Parameters
, sizeof(Parameters
));
248 Parameters
[0].Flags
= RTL_QUERY_REGISTRY_DIRECT
| RTL_REGISTRY_OPTIONAL
;
249 Parameters
[0].Name
= L
"ConnectMultiplePorts";
250 Parameters
[0].EntryContext
= &DriverExtension
->ConnectMultiplePorts
;
251 Parameters
[0].DefaultType
= REG_DWORD
;
252 Parameters
[0].DefaultData
= &DefaultConnectMultiplePorts
;
253 Parameters
[0].DefaultLength
= sizeof(ULONG
);
255 Parameters
[1].Flags
= RTL_QUERY_REGISTRY_DIRECT
| RTL_REGISTRY_OPTIONAL
;
256 Parameters
[1].Name
= L
"KeyboardDataQueueSize";
257 Parameters
[1].EntryContext
= &DriverExtension
->DataQueueSize
;
258 Parameters
[1].DefaultType
= REG_DWORD
;
259 Parameters
[1].DefaultData
= &DefaultDataQueueSize
;
260 Parameters
[1].DefaultLength
= sizeof(ULONG
);
262 Parameters
[2].Flags
= RTL_QUERY_REGISTRY_DIRECT
| RTL_REGISTRY_OPTIONAL
;
263 Parameters
[2].Name
= L
"KeyboardDeviceBaseName";
264 Parameters
[2].EntryContext
= &DriverExtension
->DeviceBaseName
;
265 Parameters
[2].DefaultType
= REG_SZ
;
266 Parameters
[2].DefaultData
= (PVOID
)DefaultDeviceBaseName
;
267 Parameters
[2].DefaultLength
= 0;
269 Status
= RtlQueryRegistryValues(
270 RTL_REGISTRY_ABSOLUTE
,
271 ParametersRegistryKey
.Buffer
,
276 if (NT_SUCCESS(Status
))
279 if (DriverExtension
->ConnectMultiplePorts
!= 0
280 && DriverExtension
->ConnectMultiplePorts
!= 1)
282 DriverExtension
->ConnectMultiplePorts
= DefaultConnectMultiplePorts
;
284 if (DriverExtension
->DataQueueSize
== 0)
286 DriverExtension
->DataQueueSize
= DefaultDataQueueSize
;
289 else if (Status
== STATUS_OBJECT_NAME_NOT_FOUND
)
291 /* Registry path doesn't exist. Set defaults */
292 DriverExtension
->ConnectMultiplePorts
= DefaultConnectMultiplePorts
;
293 DriverExtension
->DataQueueSize
= DefaultDataQueueSize
;
294 if (RtlCreateUnicodeString(&DriverExtension
->DeviceBaseName
, DefaultDeviceBaseName
))
295 Status
= STATUS_SUCCESS
;
297 Status
= STATUS_NO_MEMORY
;
300 ExFreePoolWithTag(ParametersRegistryKey
.Buffer
, CLASS_TAG
);
305 CreateClassDeviceObject(
306 IN PDRIVER_OBJECT DriverObject
,
307 OUT PDEVICE_OBJECT
*ClassDO OPTIONAL
)
309 PCLASS_DRIVER_EXTENSION DriverExtension
;
312 UNICODE_STRING DeviceNameU
;
313 PWSTR DeviceIdW
= NULL
; /* Pointer into DeviceNameU.Buffer */
315 PCLASS_DEVICE_EXTENSION DeviceExtension
;
318 TRACE_(CLASS_NAME
, "CreateClassDeviceObject(0x%p)\n", DriverObject
);
320 /* Create new device object */
321 DriverExtension
= IoGetDriverObjectExtension(DriverObject
, DriverObject
);
322 DeviceNameU
.Length
= 0;
323 DeviceNameU
.MaximumLength
=
324 wcslen(L
"\\Device\\") * sizeof(WCHAR
) /* "\Device\" */
325 + DriverExtension
->DeviceBaseName
.Length
/* "KeyboardClass" */
326 + 4 * sizeof(WCHAR
) /* Id between 0 and 9999 */
327 + sizeof(UNICODE_NULL
); /* Final NULL char */
328 DeviceNameU
.Buffer
= ExAllocatePoolWithTag(PagedPool
, DeviceNameU
.MaximumLength
, CLASS_TAG
);
329 if (!DeviceNameU
.Buffer
)
331 WARN_(CLASS_NAME
, "ExAllocatePoolWithTag() failed\n");
332 return STATUS_NO_MEMORY
;
334 Status
= RtlAppendUnicodeToString(&DeviceNameU
, L
"\\Device\\");
335 if (!NT_SUCCESS(Status
))
337 WARN_(CLASS_NAME
, "RtlAppendUnicodeToString() failed with status 0x%08lx\n", Status
);
340 Status
= RtlAppendUnicodeStringToString(&DeviceNameU
, &DriverExtension
->DeviceBaseName
);
341 if (!NT_SUCCESS(Status
))
343 WARN_(CLASS_NAME
, "RtlAppendUnicodeStringToString() failed with status 0x%08lx\n", Status
);
346 PrefixLength
= DeviceNameU
.MaximumLength
- 4 * sizeof(WCHAR
) - sizeof(UNICODE_NULL
);
347 DeviceIdW
= &DeviceNameU
.Buffer
[PrefixLength
/ sizeof(WCHAR
)];
348 while (DeviceId
< 9999)
350 DeviceNameU
.Length
= (USHORT
)(PrefixLength
+ swprintf(DeviceIdW
, L
"%lu", DeviceId
) * sizeof(WCHAR
));
351 Status
= IoCreateDevice(
353 sizeof(CLASS_DEVICE_EXTENSION
),
355 FILE_DEVICE_KEYBOARD
,
356 FILE_DEVICE_SECURE_OPEN
,
359 if (NT_SUCCESS(Status
))
361 else if (Status
!= STATUS_OBJECT_NAME_COLLISION
)
363 WARN_(CLASS_NAME
, "IoCreateDevice() failed with status 0x%08lx\n", Status
);
368 WARN_(CLASS_NAME
, "Too many devices starting with '\\Device\\%wZ'\n", &DriverExtension
->DeviceBaseName
);
369 Status
= STATUS_TOO_MANY_NAMES
;
371 if (!NT_SUCCESS(Status
))
373 ExFreePoolWithTag(DeviceNameU
.Buffer
, CLASS_TAG
);
377 DeviceExtension
= (PCLASS_DEVICE_EXTENSION
)Fdo
->DeviceExtension
;
378 RtlZeroMemory(DeviceExtension
, sizeof(CLASS_DEVICE_EXTENSION
));
379 DeviceExtension
->Common
.IsClassDO
= TRUE
;
380 DeviceExtension
->DriverExtension
= DriverExtension
;
381 InitializeListHead(&DeviceExtension
->ListHead
);
382 KeInitializeSpinLock(&DeviceExtension
->ListSpinLock
);
383 KeInitializeSpinLock(&DeviceExtension
->SpinLock
);
384 DeviceExtension
->InputCount
= 0;
385 DeviceExtension
->PortData
= ExAllocatePoolWithTag(NonPagedPool
, DeviceExtension
->DriverExtension
->DataQueueSize
* sizeof(KEYBOARD_INPUT_DATA
), CLASS_TAG
);
386 if (!DeviceExtension
->PortData
)
388 ExFreePoolWithTag(DeviceNameU
.Buffer
, CLASS_TAG
);
389 return STATUS_NO_MEMORY
;
391 DeviceExtension
->DeviceName
= DeviceNameU
.Buffer
;
392 Fdo
->Flags
|= DO_POWER_PAGABLE
;
393 Fdo
->Flags
|= DO_BUFFERED_IO
; /* FIXME: Why is it needed for 1st stage setup? */
394 Fdo
->Flags
&= ~DO_DEVICE_INITIALIZING
;
396 /* Add entry entry to HKEY_LOCAL_MACHINE\HARDWARE\DEVICEMAP\[DeviceBaseName] */
397 RtlWriteRegistryValue(
398 RTL_REGISTRY_DEVICEMAP
,
399 DriverExtension
->DeviceBaseName
.Buffer
,
400 DeviceExtension
->DeviceName
,
402 DriverExtension
->RegistryPath
.Buffer
,
403 DriverExtension
->RegistryPath
.MaximumLength
);
408 return STATUS_SUCCESS
;
413 IN PDEVICE_OBJECT ClassDeviceObject
,
415 IN PKEYBOARD_INPUT_DATA DataStart
,
416 IN SIZE_T NumberOfEntries
)
418 NTSTATUS Status
= STATUS_SUCCESS
;
420 if (ClassDeviceObject
->Flags
& DO_BUFFERED_IO
)
423 Irp
->AssociatedIrp
.SystemBuffer
,
425 NumberOfEntries
* sizeof(KEYBOARD_INPUT_DATA
));
427 else if (ClassDeviceObject
->Flags
& DO_DIRECT_IO
)
429 PVOID DestAddress
= MmGetSystemAddressForMdlSafe(Irp
->MdlAddress
, NormalPagePriority
);
435 NumberOfEntries
* sizeof(KEYBOARD_INPUT_DATA
));
438 Status
= STATUS_UNSUCCESSFUL
;
447 NumberOfEntries
* sizeof(KEYBOARD_INPUT_DATA
));
449 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
451 Status
= _SEH2_GetExceptionCode();
461 IN PDEVICE_OBJECT ClassDeviceObject
,
462 IN OUT PKEYBOARD_INPUT_DATA DataStart
,
463 IN PKEYBOARD_INPUT_DATA DataEnd
,
464 IN OUT PULONG ConsumedCount
)
466 PCLASS_DEVICE_EXTENSION ClassDeviceExtension
= ClassDeviceObject
->DeviceExtension
;
468 SIZE_T InputCount
= DataEnd
- DataStart
;
471 TRACE_(CLASS_NAME
, "ClassCallback()\n");
473 ASSERT(ClassDeviceExtension
->Common
.IsClassDO
);
475 KeAcquireSpinLock(&ClassDeviceExtension
->SpinLock
, &OldIrql
);
478 if (ClassDeviceExtension
->InputCount
+ InputCount
> ClassDeviceExtension
->DriverExtension
->DataQueueSize
)
481 * We're exceeding the buffer, and data will be thrown away...
482 * FIXME: What could we do, as we are at DISPATCH_LEVEL?
484 ReadSize
= ClassDeviceExtension
->DriverExtension
->DataQueueSize
- ClassDeviceExtension
->InputCount
;
487 ReadSize
= InputCount
;
490 * Move the input data from the port data queue to our class data
494 &ClassDeviceExtension
->PortData
[ClassDeviceExtension
->InputCount
],
496 sizeof(KEYBOARD_INPUT_DATA
) * ReadSize
);
498 /* Move the counter up */
499 ClassDeviceExtension
->InputCount
+= ReadSize
;
501 (*ConsumedCount
) += (ULONG
)ReadSize
;
503 /* Complete pending IRP (if any) */
504 if (ClassDeviceExtension
->PendingIrp
)
505 HandleReadIrp(ClassDeviceObject
, ClassDeviceExtension
->PendingIrp
, FALSE
);
507 KeReleaseSpinLock(&ClassDeviceExtension
->SpinLock
, OldIrql
);
509 TRACE_(CLASS_NAME
, "Leaving ClassCallback()\n");
513 /* Send IOCTL_INTERNAL_*_CONNECT to port */
516 IN PDEVICE_OBJECT PortDO
,
517 IN PDEVICE_OBJECT ClassDO
)
521 IO_STATUS_BLOCK IoStatus
;
522 CONNECT_DATA ConnectData
;
525 TRACE_(CLASS_NAME
, "Connecting PortDO %p to ClassDO %p\n", PortDO
, ClassDO
);
527 KeInitializeEvent(&Event
, NotificationEvent
, FALSE
);
529 ConnectData
.ClassDeviceObject
= ClassDO
;
530 ConnectData
.ClassService
= ClassCallback
;
532 Irp
= IoBuildDeviceIoControlRequest(
533 IOCTL_INTERNAL_KEYBOARD_CONNECT
,
535 &ConnectData
, sizeof(CONNECT_DATA
),
537 TRUE
, &Event
, &IoStatus
);
539 return STATUS_INSUFFICIENT_RESOURCES
;
541 Status
= IoCallDriver(PortDO
, Irp
);
543 if (Status
== STATUS_PENDING
)
544 KeWaitForSingleObject(&Event
, Suspended
, KernelMode
, FALSE
, NULL
);
546 IoStatus
.Status
= Status
;
548 if (NT_SUCCESS(IoStatus
.Status
))
550 ObReferenceObject(PortDO
);
551 ExInterlockedInsertTailList(
552 &((PCLASS_DEVICE_EXTENSION
)ClassDO
->DeviceExtension
)->ListHead
,
553 &((PPORT_DEVICE_EXTENSION
)PortDO
->DeviceExtension
)->ListEntry
,
554 &((PCLASS_DEVICE_EXTENSION
)ClassDO
->DeviceExtension
)->ListSpinLock
);
555 if (ClassDO
->StackSize
<= PortDO
->StackSize
)
557 /* Increase the stack size, in case we have to
558 * forward some IRPs to the port device object
560 ClassDO
->StackSize
= PortDO
->StackSize
+ 1;
564 return IoStatus
.Status
;
567 /* Send IOCTL_INTERNAL_*_DISCONNECT to port + destroy the Port DO */
570 IN PDEVICE_OBJECT PortDO
)
572 PPORT_DEVICE_EXTENSION DeviceExtension
;
573 PCLASS_DEVICE_EXTENSION ClassDeviceExtension
;
574 PCLASS_DRIVER_EXTENSION DriverExtension
;
577 IO_STATUS_BLOCK IoStatus
;
581 TRACE_(CLASS_NAME
, "Destroying PortDO %p\n", PortDO
);
583 DeviceExtension
= (PPORT_DEVICE_EXTENSION
)PortDO
->DeviceExtension
;
584 ClassDeviceExtension
= DeviceExtension
->ClassDO
->DeviceExtension
;
585 DriverExtension
= IoGetDriverObjectExtension(PortDO
->DriverObject
, PortDO
->DriverObject
);
587 /* Send IOCTL_INTERNAL_*_DISCONNECT */
588 KeInitializeEvent(&Event
, NotificationEvent
, FALSE
);
589 Irp
= IoBuildDeviceIoControlRequest(
590 IOCTL_INTERNAL_KEYBOARD_DISCONNECT
,
594 TRUE
, &Event
, &IoStatus
);
597 Status
= IoCallDriver(PortDO
, Irp
);
598 if (Status
== STATUS_PENDING
)
599 KeWaitForSingleObject(&Event
, Suspended
, KernelMode
, FALSE
, NULL
);
602 /* Remove from ClassDeviceExtension->ListHead list */
603 KeAcquireSpinLock(&ClassDeviceExtension
->ListSpinLock
, &OldIrql
);
604 RemoveHeadList(DeviceExtension
->ListEntry
.Blink
);
605 KeReleaseSpinLock(&ClassDeviceExtension
->ListSpinLock
, OldIrql
);
607 /* Remove entry from HKEY_LOCAL_MACHINE\HARDWARE\DEVICEMAP\[DeviceBaseName] */
608 RtlDeleteRegistryValue(
609 RTL_REGISTRY_DEVICEMAP
,
610 DriverExtension
->DeviceBaseName
.Buffer
,
611 ClassDeviceExtension
->DeviceName
);
613 if (DeviceExtension
->LowerDevice
)
614 IoDetachDevice(DeviceExtension
->LowerDevice
);
615 ObDereferenceObject(PortDO
);
617 if (!DriverExtension
->ConnectMultiplePorts
&& DeviceExtension
->ClassDO
)
619 ExFreePoolWithTag(ClassDeviceExtension
->PortData
, CLASS_TAG
);
620 ExFreePoolWithTag((PVOID
)ClassDeviceExtension
->DeviceName
, CLASS_TAG
);
621 IoDeleteDevice(DeviceExtension
->ClassDO
);
624 IoDeleteDevice(PortDO
);
627 static NTSTATUS NTAPI
629 IN PDRIVER_OBJECT DriverObject
,
630 IN PDEVICE_OBJECT Pdo
)
632 PCLASS_DRIVER_EXTENSION DriverExtension
;
633 PDEVICE_OBJECT Fdo
= NULL
;
634 PPORT_DEVICE_EXTENSION DeviceExtension
= NULL
;
637 TRACE_(CLASS_NAME
, "ClassAddDevice called. Pdo = 0x%p\n", Pdo
);
639 DriverExtension
= IoGetDriverObjectExtension(DriverObject
, DriverObject
);
642 /* We may get a NULL Pdo at the first call as we're a legacy driver. Ignore it */
643 return STATUS_SUCCESS
;
645 /* Create new device object */
646 Status
= IoCreateDevice(
648 sizeof(PORT_DEVICE_EXTENSION
),
651 Pdo
->Characteristics
& FILE_DEVICE_SECURE_OPEN
? FILE_DEVICE_SECURE_OPEN
: 0,
654 if (!NT_SUCCESS(Status
))
656 WARN_(CLASS_NAME
, "IoCreateDevice() failed with status 0x%08lx\n", Status
);
659 IoSetStartIoAttributes(Fdo
, TRUE
, TRUE
);
661 DeviceExtension
= (PPORT_DEVICE_EXTENSION
)Fdo
->DeviceExtension
;
662 RtlZeroMemory(DeviceExtension
, sizeof(PORT_DEVICE_EXTENSION
));
663 DeviceExtension
->Common
.IsClassDO
= FALSE
;
664 DeviceExtension
->DeviceObject
= Fdo
;
665 DeviceExtension
->PnpState
= dsStopped
;
666 Status
= IoAttachDeviceToDeviceStackSafe(Fdo
, Pdo
, &DeviceExtension
->LowerDevice
);
667 if (!NT_SUCCESS(Status
))
669 WARN_(CLASS_NAME
, "IoAttachDeviceToDeviceStackSafe() failed with status 0x%08lx\n", Status
);
672 if (DeviceExtension
->LowerDevice
->Flags
& DO_POWER_PAGABLE
)
673 Fdo
->Flags
|= DO_POWER_PAGABLE
;
674 if (DeviceExtension
->LowerDevice
->Flags
& DO_BUFFERED_IO
)
675 Fdo
->Flags
|= DO_BUFFERED_IO
;
676 if (DeviceExtension
->LowerDevice
->Flags
& DO_DIRECT_IO
)
677 Fdo
->Flags
|= DO_DIRECT_IO
;
679 if (DriverExtension
->ConnectMultiplePorts
)
680 DeviceExtension
->ClassDO
= DriverExtension
->MainClassDeviceObject
;
683 /* We need a new class device object for this Fdo */
684 Status
= CreateClassDeviceObject(
686 &DeviceExtension
->ClassDO
);
687 if (!NT_SUCCESS(Status
))
689 WARN_(CLASS_NAME
, "CreateClassDeviceObject() failed with status 0x%08lx\n", Status
);
693 Status
= ConnectPortDriver(Fdo
, DeviceExtension
->ClassDO
);
694 if (!NT_SUCCESS(Status
))
696 WARN_(CLASS_NAME
, "ConnectPortDriver() failed with status 0x%08lx\n", Status
);
699 Fdo
->Flags
&= ~DO_DEVICE_INITIALIZING
;
701 /* Register interface ; ignore the error (if any) as having
702 * a registred interface is not so important... */
703 Status
= IoRegisterDeviceInterface(
705 &GUID_DEVINTERFACE_KEYBOARD
,
707 &DeviceExtension
->InterfaceName
);
708 if (!NT_SUCCESS(Status
))
709 DeviceExtension
->InterfaceName
.Length
= 0;
711 return STATUS_SUCCESS
;
715 DestroyPortDriver(Fdo
);
721 IN PDEVICE_OBJECT DeviceObject
,
724 PCLASS_DEVICE_EXTENSION ClassDeviceExtension
= DeviceObject
->DeviceExtension
;
726 BOOLEAN wasQueued
= FALSE
;
728 TRACE_(CLASS_NAME
, "ClassCancelRoutine(DeviceObject %p, Irp %p)\n", DeviceObject
, Irp
);
730 ASSERT(ClassDeviceExtension
->Common
.IsClassDO
);
732 IoReleaseCancelSpinLock(Irp
->CancelIrql
);
734 KeAcquireSpinLock(&ClassDeviceExtension
->SpinLock
, &OldIrql
);
736 if (ClassDeviceExtension
->PendingIrp
== Irp
)
738 ClassDeviceExtension
->PendingIrp
= NULL
;
741 KeReleaseSpinLock(&ClassDeviceExtension
->SpinLock
, OldIrql
);
745 Irp
->IoStatus
.Status
= STATUS_CANCELLED
;
746 Irp
->IoStatus
.Information
= 0;
747 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
751 /* Hm, this shouldn't happen */
758 IN PDEVICE_OBJECT DeviceObject
,
762 PCLASS_DEVICE_EXTENSION DeviceExtension
= DeviceObject
->DeviceExtension
;
765 TRACE_(CLASS_NAME
, "HandleReadIrp(DeviceObject %p, Irp %p)\n", DeviceObject
, Irp
);
767 ASSERT(DeviceExtension
->Common
.IsClassDO
);
769 if (DeviceExtension
->InputCount
> 0)
771 SIZE_T NumberOfEntries
;
773 NumberOfEntries
= MIN(
774 DeviceExtension
->InputCount
,
775 IoGetCurrentIrpStackLocation(Irp
)->Parameters
.Read
.Length
/ sizeof(KEYBOARD_INPUT_DATA
));
777 Status
= FillEntries(
780 DeviceExtension
->PortData
,
783 if (NT_SUCCESS(Status
))
785 if (DeviceExtension
->InputCount
> NumberOfEntries
)
788 &DeviceExtension
->PortData
[0],
789 &DeviceExtension
->PortData
[NumberOfEntries
],
790 (DeviceExtension
->InputCount
- NumberOfEntries
) * sizeof(KEYBOARD_INPUT_DATA
));
793 DeviceExtension
->InputCount
-= NumberOfEntries
;
795 Irp
->IoStatus
.Information
= NumberOfEntries
* sizeof(KEYBOARD_INPUT_DATA
);
798 /* Go to next packet and complete this request */
799 Irp
->IoStatus
.Status
= Status
;
801 (VOID
)IoSetCancelRoutine(Irp
, NULL
);
802 IoCompleteRequest(Irp
, IO_KEYBOARD_INCREMENT
);
803 DeviceExtension
->PendingIrp
= NULL
;
807 (VOID
)IoSetCancelRoutine(Irp
, ClassCancelRoutine
);
808 if (Irp
->Cancel
&& IoSetCancelRoutine(Irp
, NULL
))
810 DeviceExtension
->PendingIrp
= NULL
;
811 Status
= STATUS_CANCELLED
;
815 IoMarkIrpPending(Irp
);
816 DeviceExtension
->PendingIrp
= Irp
;
817 Status
= STATUS_PENDING
;
825 IN PDEVICE_OBJECT DeviceObject
,
828 PCLASS_DEVICE_EXTENSION DeviceExtension
= DeviceObject
->DeviceExtension
;
831 TRACE_(CLASS_NAME
, "ClassStartIo(DeviceObject %p, Irp %p)\n", DeviceObject
, Irp
);
833 ASSERT(DeviceExtension
->Common
.IsClassDO
);
835 KeAcquireSpinLock(&DeviceExtension
->SpinLock
, &OldIrql
);
836 HandleReadIrp(DeviceObject
, Irp
, TRUE
);
837 KeReleaseSpinLock(&DeviceExtension
->SpinLock
, OldIrql
);
841 SearchForLegacyDrivers(
842 IN PDRIVER_OBJECT DriverObject
,
843 IN PVOID Context
, /* PCLASS_DRIVER_EXTENSION */
846 UNICODE_STRING DeviceMapKeyU
= RTL_CONSTANT_STRING(L
"\\REGISTRY\\MACHINE\\HARDWARE\\DEVICEMAP");
847 PCLASS_DRIVER_EXTENSION DriverExtension
;
848 UNICODE_STRING PortBaseName
= { 0, 0, NULL
};
849 PKEY_VALUE_BASIC_INFORMATION KeyValueInformation
= NULL
;
850 OBJECT_ATTRIBUTES ObjectAttributes
;
851 HANDLE hDeviceMapKey
= (HANDLE
)-1;
852 HANDLE hPortKey
= (HANDLE
)-1;
854 ULONG Size
, ResultLength
;
857 TRACE_(CLASS_NAME
, "SearchForLegacyDrivers(%p %p %lu)\n",
858 DriverObject
, Context
, Count
);
862 DriverExtension
= (PCLASS_DRIVER_EXTENSION
)Context
;
864 /* Create port base name, by replacing Class by Port at the end of the class base name */
865 Status
= DuplicateUnicodeString(
866 RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE
,
867 &DriverExtension
->DeviceBaseName
,
869 if (!NT_SUCCESS(Status
))
871 WARN_(CLASS_NAME
, "DuplicateUnicodeString() failed with status 0x%08lx\n", Status
);
874 PortBaseName
.Length
-= (sizeof(L
"Class") - sizeof(UNICODE_NULL
));
875 RtlAppendUnicodeToString(&PortBaseName
, L
"Port");
877 /* Allocate memory */
878 Size
= sizeof(KEY_VALUE_BASIC_INFORMATION
) + MAX_PATH
;
879 KeyValueInformation
= ExAllocatePoolWithTag(PagedPool
, Size
, CLASS_TAG
);
880 if (!KeyValueInformation
)
882 WARN_(CLASS_NAME
, "ExAllocatePoolWithTag() failed\n");
883 Status
= STATUS_NO_MEMORY
;
887 /* Open HKEY_LOCAL_MACHINE\HARDWARE\DEVICEMAP */
888 InitializeObjectAttributes(&ObjectAttributes
, &DeviceMapKeyU
, OBJ_KERNEL_HANDLE
| OBJ_CASE_INSENSITIVE
, NULL
, NULL
);
889 Status
= ZwOpenKey(&hDeviceMapKey
, 0, &ObjectAttributes
);
890 if (Status
== STATUS_OBJECT_NAME_NOT_FOUND
)
892 INFO_(CLASS_NAME
, "HKLM\\HARDWARE\\DEVICEMAP is non-existent\n");
893 Status
= STATUS_SUCCESS
;
896 else if (!NT_SUCCESS(Status
))
898 WARN_(CLASS_NAME
, "ZwOpenKey() failed with status 0x%08lx\n", Status
);
903 InitializeObjectAttributes(&ObjectAttributes
, &PortBaseName
, OBJ_KERNEL_HANDLE
| OBJ_CASE_INSENSITIVE
, hDeviceMapKey
, NULL
);
904 Status
= ZwOpenKey(&hPortKey
, KEY_QUERY_VALUE
, &ObjectAttributes
);
905 if (Status
== STATUS_OBJECT_NAME_NOT_FOUND
)
907 INFO_(CLASS_NAME
, "HKLM\\HARDWARE\\DEVICEMAP\\%wZ is non-existent\n", &PortBaseName
);
908 Status
= STATUS_SUCCESS
;
911 else if (!NT_SUCCESS(Status
))
913 WARN_(CLASS_NAME
, "ZwOpenKey() failed with status 0x%08lx\n", Status
);
917 /* Read each value name */
918 while (ZwEnumerateValueKey(hPortKey
, Index
++, KeyValueBasicInformation
, KeyValueInformation
, Size
, &ResultLength
) == STATUS_SUCCESS
)
920 UNICODE_STRING PortName
;
921 PDEVICE_OBJECT PortDeviceObject
= NULL
;
922 PFILE_OBJECT FileObject
= NULL
;
924 PortName
.Length
= PortName
.MaximumLength
= (USHORT
)KeyValueInformation
->NameLength
;
925 PortName
.Buffer
= KeyValueInformation
->Name
;
927 /* Open the device object pointer */
928 Status
= IoGetDeviceObjectPointer(&PortName
, FILE_READ_ATTRIBUTES
, &FileObject
, &PortDeviceObject
);
929 if (!NT_SUCCESS(Status
))
931 WARN_(CLASS_NAME
, "IoGetDeviceObjectPointer(%wZ) failed with status 0x%08lx\n", &PortName
, Status
);
934 INFO_(CLASS_NAME
, "Legacy driver found\n");
936 Status
= ClassAddDevice(DriverObject
, PortDeviceObject
);
937 if (!NT_SUCCESS(Status
))
939 /* FIXME: Log the error */
940 WARN_(CLASS_NAME
, "ClassAddDevice() failed with status 0x%08lx\n", Status
);
943 /* A special hack for 1st stage setup: manually send start device to i8042prt */
944 if (IsFirstStageSetup())
945 Send8042StartDevice(DriverObject
, PortDeviceObject
);
949 if (KeyValueInformation
!= NULL
)
950 ExFreePoolWithTag(KeyValueInformation
, CLASS_TAG
);
951 if (hDeviceMapKey
!= (HANDLE
)-1)
952 ZwClose(hDeviceMapKey
);
953 if (hPortKey
!= (HANDLE
)-1)
958 * Standard DriverEntry method.
962 IN PDRIVER_OBJECT DriverObject
,
963 IN PUNICODE_STRING RegistryPath
)
965 PCLASS_DRIVER_EXTENSION DriverExtension
;
969 Status
= IoAllocateDriverObjectExtension(
972 sizeof(CLASS_DRIVER_EXTENSION
),
973 (PVOID
*)&DriverExtension
);
974 if (!NT_SUCCESS(Status
))
976 WARN_(CLASS_NAME
, "IoAllocateDriverObjectExtension() failed with status 0x%08lx\n", Status
);
979 RtlZeroMemory(DriverExtension
, sizeof(CLASS_DRIVER_EXTENSION
));
981 Status
= DuplicateUnicodeString(
982 RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE
,
984 &DriverExtension
->RegistryPath
);
985 if (!NT_SUCCESS(Status
))
987 WARN_(CLASS_NAME
, "DuplicateUnicodeString() failed with status 0x%08lx\n", Status
);
991 Status
= ReadRegistryEntries(RegistryPath
, DriverExtension
);
992 if (!NT_SUCCESS(Status
))
994 WARN_(CLASS_NAME
, "ReadRegistryEntries() failed with status 0x%08lx\n", Status
);
998 if (DriverExtension
->ConnectMultiplePorts
== 1)
1000 Status
= CreateClassDeviceObject(
1002 &DriverExtension
->MainClassDeviceObject
);
1003 if (!NT_SUCCESS(Status
))
1005 WARN_(CLASS_NAME
, "CreateClassDeviceObject() failed with status 0x%08lx\n", Status
);
1010 DriverObject
->DriverExtension
->AddDevice
= ClassAddDevice
;
1011 DriverObject
->DriverUnload
= DriverUnload
;
1013 for (i
= 0; i
<= IRP_MJ_MAXIMUM_FUNCTION
; i
++)
1014 DriverObject
->MajorFunction
[i
] = IrpStub
;
1016 DriverObject
->MajorFunction
[IRP_MJ_CREATE
] = ClassCreate
;
1017 DriverObject
->MajorFunction
[IRP_MJ_CLOSE
] = ClassClose
;
1018 DriverObject
->MajorFunction
[IRP_MJ_CLEANUP
] = ClassCleanup
;
1019 DriverObject
->MajorFunction
[IRP_MJ_READ
] = ClassRead
;
1020 DriverObject
->MajorFunction
[IRP_MJ_DEVICE_CONTROL
] = ClassDeviceControl
;
1021 DriverObject
->MajorFunction
[IRP_MJ_INTERNAL_DEVICE_CONTROL
] = ForwardIrpAndForget
;
1022 DriverObject
->DriverStartIo
= ClassStartIo
;
1024 /* We will detect the legacy devices later */
1025 IoRegisterDriverReinitialization(
1027 SearchForLegacyDrivers
,
1030 return STATUS_SUCCESS
;