2 * PROJECT: ReactOS i8042 (ps/2 keyboard-mouse controller) driver
3 * LICENSE: GPL - See COPYING in the top level directory
4 * FILE: drivers/input/i8042prt/keyboard.c
5 * PURPOSE: Keyboard specific functions
6 * PROGRAMMERS: Copyright Victor Kirhenshtein (sauros@iname.com)
7 Copyright Jason Filby (jasonfilby@yahoo.com)
8 Copyright Martijn Vernooij (o112w8r02@sneakemail.com)
9 Copyright 2006-2007 Hervé Poussineau (hpoussin@reactos.org)
12 /* INCLUDES ****************************************************************/
17 #include <ndk/kdfuncs.h>
21 /* GLOBALS *******************************************************************/
23 static IO_WORKITEM_ROUTINE i8042PowerWorkItem
;
24 static KDEFERRED_ROUTINE i8042KbdDpcRoutine
;
26 /* This structure starts with the same layout as KEYBOARD_INDICATOR_TRANSLATION */
27 typedef struct _LOCAL_KEYBOARD_INDICATOR_TRANSLATION
{
28 USHORT NumberOfIndicatorKeys
;
29 INDICATOR_LIST IndicatorList
[3];
30 } LOCAL_KEYBOARD_INDICATOR_TRANSLATION
, *PLOCAL_KEYBOARD_INDICATOR_TRANSLATION
;
32 static LOCAL_KEYBOARD_INDICATOR_TRANSLATION IndicatorTranslation
= { 3, {
33 {0x3A, KEYBOARD_CAPS_LOCK_ON
},
34 {0x45, KEYBOARD_NUM_LOCK_ON
},
35 {0x46, KEYBOARD_SCROLL_LOCK_ON
}}};
37 /* FUNCTIONS *****************************************************************/
40 * These functions are callbacks for filter driver custom interrupt
48 PI8042_KEYBOARD_EXTENSION DeviceExtension;
50 DeviceExtension = (PI8042_KEYBOARD_EXTENSION)Context;
52 if (DeviceExtension->KeyboardHook.IsrWritePort)
54 DeviceExtension->KeyboardHook.IsrWritePort(
55 DeviceExtension->KeyboardHook.CallContext,
59 i8042IsrWritePort(Context, Value, 0);
66 PI8042_KEYBOARD_EXTENSION DeviceExtension
;
68 DeviceExtension
= (PI8042_KEYBOARD_EXTENSION
)Context
;
70 DeviceExtension
->KeyComplete
= TRUE
;
71 DeviceExtension
->KeysInBuffer
++;
72 if (DeviceExtension
->KeysInBuffer
> DeviceExtension
->Common
.PortDeviceExtension
->Settings
.KeyboardDataQueueSize
)
74 WARN_(I8042PRT
, "Keyboard buffer overflow\n");
75 DeviceExtension
->KeysInBuffer
--;
78 TRACE_(I8042PRT
, "Irq completes key\n");
79 KeInsertQueueDpc(&DeviceExtension
->DpcKeyboard
, NULL
, NULL
);
83 * These functions are callbacks for filter driver custom
84 * initialization routines.
87 i8042SynchWritePortKbd(
90 IN BOOLEAN WaitForAck
)
92 return i8042SynchWritePort(
93 (PPORT_DEVICE_EXTENSION
)Context
,
100 * Process the keyboard internal device requests
104 IN PDEVICE_OBJECT DeviceObject
,
107 PIO_STACK_LOCATION Stack
;
108 PI8042_KEYBOARD_EXTENSION DeviceExtension
;
109 PPORT_DEVICE_EXTENSION PortDeviceExtension
;
111 Stack
= IoGetCurrentIrpStackLocation(Irp
);
112 DeviceExtension
= (PI8042_KEYBOARD_EXTENSION
)DeviceObject
->DeviceExtension
;
113 PortDeviceExtension
= DeviceExtension
->Common
.PortDeviceExtension
;
115 switch (Stack
->Parameters
.DeviceIoControl
.IoControlCode
)
117 case IOCTL_KEYBOARD_SET_INDICATORS
:
119 TRACE_(I8042PRT
, "IOCTL_KEYBOARD_SET_INDICATORS\n");
120 INFO_(I8042PRT
, "Leds: {%s%s%s }\n",
121 DeviceExtension
->KeyboardIndicators
.LedFlags
& KEYBOARD_CAPS_LOCK_ON
? " CAPSLOCK" : "",
122 DeviceExtension
->KeyboardIndicators
.LedFlags
& KEYBOARD_NUM_LOCK_ON
? " NUMLOCK" : "",
123 DeviceExtension
->KeyboardIndicators
.LedFlags
& KEYBOARD_SCROLL_LOCK_ON
? " SCROLLLOCK" : "");
125 PortDeviceExtension
->PacketBuffer
[0] = KBD_CMD_SET_LEDS
;
126 PortDeviceExtension
->PacketBuffer
[1] = 0;
127 if (DeviceExtension
->KeyboardIndicators
.LedFlags
& KEYBOARD_CAPS_LOCK_ON
)
128 PortDeviceExtension
->PacketBuffer
[1] |= KBD_LED_CAPS
;
130 if (DeviceExtension
->KeyboardIndicators
.LedFlags
& KEYBOARD_NUM_LOCK_ON
)
131 PortDeviceExtension
->PacketBuffer
[1] |= KBD_LED_NUM
;
133 if (DeviceExtension
->KeyboardIndicators
.LedFlags
& KEYBOARD_SCROLL_LOCK_ON
)
134 PortDeviceExtension
->PacketBuffer
[1] |= KBD_LED_SCROLL
;
138 &DeviceExtension
->Common
,
139 PortDeviceExtension
->PacketBuffer
,
146 ERR_(I8042PRT
, "Unknown ioctl code 0x%lx\n",
147 Stack
->Parameters
.DeviceIoControl
.IoControlCode
);
155 IN PPORT_DEVICE_EXTENSION DeviceExtension
)
157 BOOLEAN FinishIrp
= FALSE
;
159 NTSTATUS Result
= STATUS_INTERNAL_ERROR
; /* Shouldn't happen */
161 /* If the interrupt happens before this is setup, the key
162 * was already in the buffer. Too bad! */
163 if (!DeviceExtension
->HighestDIRQLInterrupt
)
166 Irql
= KeAcquireInterruptSpinLock(DeviceExtension
->HighestDIRQLInterrupt
);
168 if (DeviceExtension
->Packet
.State
== Idle
169 && DeviceExtension
->PacketComplete
)
172 Result
= DeviceExtension
->PacketResult
;
173 DeviceExtension
->PacketComplete
= FALSE
;
176 KeReleaseInterruptSpinLock(DeviceExtension
->HighestDIRQLInterrupt
, Irql
);
181 if (DeviceExtension
->CurrentIrp
)
183 DeviceExtension
->CurrentIrp
->IoStatus
.Status
= Result
;
184 IoCompleteRequest(DeviceExtension
->CurrentIrp
, IO_NO_INCREMENT
);
185 IoStartNextPacket(DeviceExtension
->CurrentIrpDevice
, FALSE
);
186 DeviceExtension
->CurrentIrp
= NULL
;
187 DeviceExtension
->CurrentIrpDevice
= NULL
;
193 IN PDEVICE_OBJECT DeviceObject
,
196 PI8042_KEYBOARD_EXTENSION DeviceExtension
;
200 UNREFERENCED_PARAMETER(DeviceObject
);
202 __analysis_assume(Context
!= NULL
);
203 DeviceExtension
= Context
;
205 /* See http://blogs.msdn.com/doronh/archive/2006/09/08/746961.aspx */
207 /* Register GUID_DEVICE_SYS_BUTTON interface and report capability */
208 if (DeviceExtension
->NewCaps
!= DeviceExtension
->ReportedCaps
)
210 WaitingIrp
= InterlockedExchangePointer((PVOID
)&DeviceExtension
->PowerIrp
, NULL
);
213 /* Cancel the current power irp, as capability changed */
214 WaitingIrp
->IoStatus
.Status
= STATUS_UNSUCCESSFUL
;
215 WaitingIrp
->IoStatus
.Information
= sizeof(ULONG
);
216 IoCompleteRequest(WaitingIrp
, IO_NO_INCREMENT
);
219 if (DeviceExtension
->PowerInterfaceName
.MaximumLength
== 0)
221 /* We have never registred this interface ; do it */
222 Status
= IoRegisterDeviceInterface(
223 DeviceExtension
->Common
.Pdo
,
224 &GUID_DEVICE_SYS_BUTTON
,
226 &DeviceExtension
->PowerInterfaceName
);
227 if (!NT_SUCCESS(Status
))
229 /* We can't do more yet, ignore the keypress... */
230 WARN_(I8042PRT
, "IoRegisterDeviceInterface(GUID_DEVICE_SYS_BUTTON) failed with status 0x%08lx\n",
232 DeviceExtension
->PowerInterfaceName
.MaximumLength
= 0;
238 /* Disable the interface. Once activated again, capabilities would be asked again */
239 Status
= IoSetDeviceInterfaceState(
240 &DeviceExtension
->PowerInterfaceName
,
242 if (!NT_SUCCESS(Status
))
244 /* Ignore the key press... */
245 WARN_(I8042PRT
, "Disabling interface %wZ failed with status 0x%08lx\n",
246 &DeviceExtension
->PowerInterfaceName
, Status
);
250 /* Enable the interface. This leads to receving a IOCTL_GET_SYS_BUTTON_CAPS,
251 * so we can report new capability */
252 Status
= IoSetDeviceInterfaceState(
253 &DeviceExtension
->PowerInterfaceName
,
255 if (!NT_SUCCESS(Status
))
257 /* Ignore the key press... */
258 WARN_(I8042PRT
, "Enabling interface %wZ failed with status 0x%08lx\n",
259 &DeviceExtension
->PowerInterfaceName
, Status
);
264 /* Directly complete the IOCTL_GET_SYS_BUTTON_EVENT Irp (if any) */
265 WaitingIrp
= InterlockedExchangePointer((PVOID
)&DeviceExtension
->PowerIrp
, NULL
);
268 PULONG pEvent
= (PULONG
)WaitingIrp
->AssociatedIrp
.SystemBuffer
;
270 WaitingIrp
->IoStatus
.Status
= STATUS_SUCCESS
;
271 WaitingIrp
->IoStatus
.Information
= sizeof(ULONG
);
272 *pEvent
= InterlockedExchange((PLONG
)&DeviceExtension
->LastPowerKey
, 0);
273 IoCompleteRequest(WaitingIrp
, IO_NO_INCREMENT
);
277 /* Return TRUE if it was a power key */
280 IN PI8042_KEYBOARD_EXTENSION DeviceExtension
)
282 PKEYBOARD_INPUT_DATA InputData
;
285 InputData
= DeviceExtension
->KeyboardBuffer
+ DeviceExtension
->KeysInBuffer
- 1;
286 if (!(InputData
->Flags
& KEY_E0
))
289 switch (InputData
->MakeCode
)
291 case KEYBOARD_POWER_CODE
:
292 KeyPress
= SYS_BUTTON_POWER
;
294 case KEYBOARD_SLEEP_CODE
:
295 KeyPress
= SYS_BUTTON_SLEEP
;
297 case KEYBOARD_WAKE_CODE
:
298 KeyPress
= SYS_BUTTON_WAKE
;
304 if (InputData
->Flags
& KEY_BREAK
)
305 /* We already took care of the key press */
308 /* Our work can only be done at passive level, so use a workitem */
309 DeviceExtension
->NewCaps
|= KeyPress
;
310 InterlockedExchange((PLONG
)&DeviceExtension
->LastPowerKey
, KeyPress
);
312 DeviceExtension
->PowerWorkItem
,
322 IN PVOID DeferredContext
,
323 IN PVOID SystemArgument1
,
324 IN PVOID SystemArgument2
)
326 PI8042_KEYBOARD_EXTENSION DeviceExtension
;
327 PPORT_DEVICE_EXTENSION PortDeviceExtension
;
328 ULONG KeysTransferred
= 0;
329 ULONG KeysInBufferCopy
;
332 UNREFERENCED_PARAMETER(Dpc
);
333 UNREFERENCED_PARAMETER(SystemArgument1
);
334 UNREFERENCED_PARAMETER(SystemArgument2
);
336 __analysis_assume(DeferredContext
!= NULL
);
337 DeviceExtension
= DeferredContext
;
338 PortDeviceExtension
= DeviceExtension
->Common
.PortDeviceExtension
;
340 if (HandlePowerKeys(DeviceExtension
))
342 DeviceExtension
->KeyComplete
= FALSE
;
346 i8042PacketDpc(PortDeviceExtension
);
347 if (!DeviceExtension
->KeyComplete
)
349 /* We got the interrupt as it was being enabled, too bad */
350 if (!PortDeviceExtension
->HighestDIRQLInterrupt
)
353 Irql
= KeAcquireInterruptSpinLock(PortDeviceExtension
->HighestDIRQLInterrupt
);
355 DeviceExtension
->KeyComplete
= FALSE
;
356 KeysInBufferCopy
= DeviceExtension
->KeysInBuffer
;
358 KeReleaseInterruptSpinLock(PortDeviceExtension
->HighestDIRQLInterrupt
, Irql
);
360 TRACE_(I8042PRT
, "Send a key\n");
362 if (!DeviceExtension
->KeyboardData
.ClassService
)
365 INFO_(I8042PRT
, "Sending %lu key(s)\n", KeysInBufferCopy
);
366 (*(PSERVICE_CALLBACK_ROUTINE
)DeviceExtension
->KeyboardData
.ClassService
)(
367 DeviceExtension
->KeyboardData
.ClassDeviceObject
,
368 DeviceExtension
->KeyboardBuffer
,
369 DeviceExtension
->KeyboardBuffer
+ KeysInBufferCopy
,
372 KeAcquireInterruptSpinLock(PortDeviceExtension
->HighestDIRQLInterrupt
);
373 DeviceExtension
->KeysInBuffer
-= KeysTransferred
;
374 KeReleaseInterruptSpinLock(PortDeviceExtension
->HighestDIRQLInterrupt
, Irql
);
378 * Runs the keyboard IOCTL dispatch.
381 i8042KbdDeviceControl(
382 IN PDEVICE_OBJECT DeviceObject
,
385 PIO_STACK_LOCATION Stack
;
386 PI8042_KEYBOARD_EXTENSION DeviceExtension
;
389 Stack
= IoGetCurrentIrpStackLocation(Irp
);
390 Irp
->IoStatus
.Information
= 0;
391 DeviceExtension
= (PI8042_KEYBOARD_EXTENSION
)DeviceObject
->DeviceExtension
;
393 switch (Stack
->Parameters
.DeviceIoControl
.IoControlCode
)
395 case IOCTL_GET_SYS_BUTTON_CAPS
:
397 /* Part of GUID_DEVICE_SYS_BUTTON interface */
399 TRACE_(I8042PRT
, "IOCTL_GET_SYS_BUTTON_CAPS\n");
401 if (Stack
->Parameters
.DeviceIoControl
.OutputBufferLength
!= sizeof(ULONG
))
402 Status
= STATUS_INVALID_PARAMETER
;
405 pCaps
= (PULONG
)Irp
->AssociatedIrp
.SystemBuffer
;
406 *pCaps
= DeviceExtension
->NewCaps
;
407 DeviceExtension
->ReportedCaps
= DeviceExtension
->NewCaps
;
408 Irp
->IoStatus
.Information
= sizeof(ULONG
);
409 Status
= STATUS_SUCCESS
;
413 case IOCTL_GET_SYS_BUTTON_EVENT
:
415 /* Part of GUID_DEVICE_SYS_BUTTON interface */
417 TRACE_(I8042PRT
, "IOCTL_GET_SYS_BUTTON_EVENT\n");
419 if (Stack
->Parameters
.DeviceIoControl
.OutputBufferLength
!= sizeof(ULONG
))
420 Status
= STATUS_INVALID_PARAMETER
;
423 WaitingIrp
= InterlockedCompareExchangePointer(
424 (PVOID
)&DeviceExtension
->PowerIrp
,
427 /* Check if an Irp is already pending */
430 /* Unable to have a 2nd pending IRP for this IOCTL */
431 WARN_(I8042PRT
, "Unable to pend a second IRP for IOCTL_GET_SYS_BUTTON_EVENT\n");
432 Status
= STATUS_INVALID_PARAMETER
;
433 Irp
->IoStatus
.Status
= Status
;
434 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
439 PowerKey
= InterlockedExchange((PLONG
)&DeviceExtension
->LastPowerKey
, 0);
442 (VOID
)InterlockedCompareExchangePointer((PVOID
)&DeviceExtension
->PowerIrp
, NULL
, Irp
);
443 *(PULONG
)Irp
->AssociatedIrp
.SystemBuffer
= PowerKey
;
444 Status
= STATUS_SUCCESS
;
445 Irp
->IoStatus
.Status
= Status
;
446 Irp
->IoStatus
.Information
= sizeof(ULONG
);
447 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
451 TRACE_(I8042PRT
, "Pending IOCTL_GET_SYS_BUTTON_EVENT\n");
452 Status
= STATUS_PENDING
;
453 Irp
->IoStatus
.Status
= Status
;
454 IoMarkIrpPending(Irp
);
463 ERR_(I8042PRT
, "IRP_MJ_DEVICE_CONTROL / unknown ioctl code 0x%lx\n",
464 Stack
->Parameters
.DeviceIoControl
.IoControlCode
);
466 return ForwardIrpAndForget(DeviceObject
, Irp
);
470 Irp
->IoStatus
.Status
= Status
;
471 if (Status
== STATUS_PENDING
)
472 IoMarkIrpPending(Irp
);
474 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
481 i8042InitializeKeyboardAttributes(
482 PI8042_KEYBOARD_EXTENSION DeviceExtension
)
484 PPORT_DEVICE_EXTENSION PortDeviceExtension
;
485 PI8042_SETTINGS Settings
;
486 PKEYBOARD_ATTRIBUTES KeyboardAttributes
;
488 PortDeviceExtension
= DeviceExtension
->Common
.PortDeviceExtension
;
489 Settings
= &PortDeviceExtension
->Settings
;
491 KeyboardAttributes
= &DeviceExtension
->KeyboardAttributes
;
493 KeyboardAttributes
->KeyboardIdentifier
.Type
= (UCHAR
)Settings
->OverrideKeyboardType
;
494 KeyboardAttributes
->KeyboardIdentifier
.Subtype
= (UCHAR
)Settings
->OverrideKeyboardSubtype
;
495 KeyboardAttributes
->NumberOfFunctionKeys
= 4;
496 KeyboardAttributes
->NumberOfIndicators
= 3;
497 KeyboardAttributes
->NumberOfKeysTotal
= 101;
498 KeyboardAttributes
->InputDataQueueLength
= Settings
->KeyboardDataQueueSize
;
499 KeyboardAttributes
->KeyRepeatMinimum
.UnitId
= 0;
500 KeyboardAttributes
->KeyRepeatMinimum
.Rate
= (USHORT
)Settings
->SampleRate
;
501 KeyboardAttributes
->KeyRepeatMinimum
.Delay
= 0;
502 KeyboardAttributes
->KeyRepeatMinimum
.UnitId
= 0;
503 KeyboardAttributes
->KeyRepeatMinimum
.Rate
= (USHORT
)Settings
->SampleRate
;
504 KeyboardAttributes
->KeyRepeatMinimum
.Delay
= 0;
508 * Runs the keyboard IOCTL_INTERNAL dispatch.
511 i8042KbdInternalDeviceControl(
512 IN PDEVICE_OBJECT DeviceObject
,
515 PIO_STACK_LOCATION Stack
;
516 PI8042_KEYBOARD_EXTENSION DeviceExtension
;
519 Stack
= IoGetCurrentIrpStackLocation(Irp
);
520 Irp
->IoStatus
.Information
= 0;
521 DeviceExtension
= (PI8042_KEYBOARD_EXTENSION
)DeviceObject
->DeviceExtension
;
523 switch (Stack
->Parameters
.DeviceIoControl
.IoControlCode
)
525 case IOCTL_INTERNAL_KEYBOARD_CONNECT
:
528 PIO_WORKITEM WorkItem
= NULL
;
529 PI8042_HOOK_WORKITEM WorkItemData
= NULL
;
531 TRACE_(I8042PRT
, "IRP_MJ_INTERNAL_DEVICE_CONTROL / IOCTL_INTERNAL_KEYBOARD_CONNECT\n");
532 if (Stack
->Parameters
.DeviceIoControl
.InputBufferLength
!= sizeof(CONNECT_DATA
))
534 Status
= STATUS_INVALID_PARAMETER
;
538 DeviceExtension
->KeyboardData
=
539 *((PCONNECT_DATA
)Stack
->Parameters
.DeviceIoControl
.Type3InputBuffer
);
541 /* Send IOCTL_INTERNAL_I8042_HOOK_KEYBOARD to device stack */
542 WorkItem
= IoAllocateWorkItem(DeviceObject
);
545 WARN_(I8042PRT
, "IoAllocateWorkItem() failed\n");
546 Status
= STATUS_INSUFFICIENT_RESOURCES
;
549 WorkItemData
= ExAllocatePoolWithTag(
551 sizeof(I8042_HOOK_WORKITEM
),
555 WARN_(I8042PRT
, "ExAllocatePoolWithTag() failed\n");
556 Status
= STATUS_NO_MEMORY
;
559 WorkItemData
->WorkItem
= WorkItem
;
560 WorkItemData
->Irp
= Irp
;
562 /* Initialize extension */
563 DeviceExtension
->Common
.Type
= Keyboard
;
564 Size
= DeviceExtension
->Common
.PortDeviceExtension
->Settings
.KeyboardDataQueueSize
* sizeof(KEYBOARD_INPUT_DATA
);
565 DeviceExtension
->KeyboardBuffer
= ExAllocatePoolWithTag(
569 if (!DeviceExtension
->KeyboardBuffer
)
571 WARN_(I8042PRT
, "ExAllocatePoolWithTag() failed\n");
572 Status
= STATUS_NO_MEMORY
;
575 RtlZeroMemory(DeviceExtension
->KeyboardBuffer
, Size
);
577 &DeviceExtension
->DpcKeyboard
,
580 DeviceExtension
->PowerWorkItem
= IoAllocateWorkItem(DeviceObject
);
581 if (!DeviceExtension
->PowerWorkItem
)
583 WARN_(I8042PRT
, "IoAllocateWorkItem() failed\n");
584 Status
= STATUS_INSUFFICIENT_RESOURCES
;
587 DeviceExtension
->DebugWorkItem
= IoAllocateWorkItem(DeviceObject
);
588 if (!DeviceExtension
->DebugWorkItem
)
590 WARN_(I8042PRT
, "IoAllocateWorkItem() failed\n");
591 Status
= STATUS_INSUFFICIENT_RESOURCES
;
594 DeviceExtension
->Common
.PortDeviceExtension
->KeyboardExtension
= DeviceExtension
;
595 DeviceExtension
->Common
.PortDeviceExtension
->Flags
|= KEYBOARD_CONNECTED
;
597 i8042InitializeKeyboardAttributes(DeviceExtension
);
599 IoMarkIrpPending(Irp
);
600 /* FIXME: DeviceExtension->KeyboardHook.IsrWritePort = ; */
601 DeviceExtension
->KeyboardHook
.QueueKeyboardPacket
= i8042KbdQueuePacket
;
602 DeviceExtension
->KeyboardHook
.CallContext
= DeviceExtension
;
603 IoQueueWorkItem(WorkItem
,
604 i8042SendHookWorkItem
,
607 Status
= STATUS_PENDING
;
611 if (DeviceExtension
->KeyboardBuffer
)
612 ExFreePoolWithTag(DeviceExtension
->KeyboardBuffer
, I8042PRT_TAG
);
613 if (DeviceExtension
->PowerWorkItem
)
614 IoFreeWorkItem(DeviceExtension
->PowerWorkItem
);
615 if (DeviceExtension
->DebugWorkItem
)
616 IoFreeWorkItem(DeviceExtension
->DebugWorkItem
);
618 IoFreeWorkItem(WorkItem
);
620 ExFreePoolWithTag(WorkItemData
, I8042PRT_TAG
);
623 case IOCTL_INTERNAL_KEYBOARD_DISCONNECT
:
625 TRACE_(I8042PRT
, "IRP_MJ_INTERNAL_DEVICE_CONTROL / IOCTL_INTERNAL_KEYBOARD_DISCONNECT\n");
626 /* MSDN says that operation is to implemented.
627 * To implement it, we just have to do:
628 * DeviceExtension->KeyboardData.ClassService = NULL;
630 Status
= STATUS_NOT_IMPLEMENTED
;
633 case IOCTL_INTERNAL_I8042_HOOK_KEYBOARD
:
635 TRACE_(I8042PRT
, "IRP_MJ_INTERNAL_DEVICE_CONTROL / IOCTL_INTERNAL_I8042_HOOK_KEYBOARD\n");
636 /* Nothing to do here */
637 Status
= STATUS_SUCCESS
;
640 case IOCTL_KEYBOARD_QUERY_ATTRIBUTES
:
642 PKEYBOARD_ATTRIBUTES KeyboardAttributes
;
644 /* FIXME: KeyboardAttributes are not initialized anywhere */
645 TRACE_(I8042PRT
, "IRP_MJ_INTERNAL_DEVICE_CONTROL / IOCTL_KEYBOARD_QUERY_ATTRIBUTES\n");
646 if (Stack
->Parameters
.DeviceIoControl
.OutputBufferLength
< sizeof(KEYBOARD_ATTRIBUTES
))
648 Status
= STATUS_BUFFER_TOO_SMALL
;
652 KeyboardAttributes
= Irp
->AssociatedIrp
.SystemBuffer
;
653 *KeyboardAttributes
= DeviceExtension
->KeyboardAttributes
;
655 Irp
->IoStatus
.Information
= sizeof(KEYBOARD_ATTRIBUTES
);
656 Status
= STATUS_SUCCESS
;
659 case IOCTL_KEYBOARD_QUERY_TYPEMATIC
:
661 DPRINT1("IOCTL_KEYBOARD_QUERY_TYPEMATIC not implemented\n");
662 Status
= STATUS_NOT_IMPLEMENTED
;
665 case IOCTL_KEYBOARD_SET_TYPEMATIC
:
667 DPRINT1("IOCTL_KEYBOARD_SET_TYPEMATIC not implemented\n");
668 Status
= STATUS_NOT_IMPLEMENTED
;
671 case IOCTL_KEYBOARD_QUERY_INDICATOR_TRANSLATION
:
673 TRACE_(I8042PRT
, "IRP_MJ_INTERNAL_DEVICE_CONTROL / IOCTL_KEYBOARD_QUERY_INDICATOR_TRANSLATION\n");
675 /* We should check the UnitID, but it's kind of pointless as
676 * all keyboards are supposed to have the same one
678 if (Stack
->Parameters
.DeviceIoControl
.OutputBufferLength
< sizeof(LOCAL_KEYBOARD_INDICATOR_TRANSLATION
))
680 Status
= STATUS_BUFFER_TOO_SMALL
;
685 Irp
->AssociatedIrp
.SystemBuffer
,
686 &IndicatorTranslation
,
687 sizeof(LOCAL_KEYBOARD_INDICATOR_TRANSLATION
));
688 Irp
->IoStatus
.Information
= sizeof(LOCAL_KEYBOARD_INDICATOR_TRANSLATION
);
689 Status
= STATUS_SUCCESS
;
693 case IOCTL_KEYBOARD_QUERY_INDICATORS
:
695 TRACE_(I8042PRT
, "IRP_MJ_INTERNAL_DEVICE_CONTROL / IOCTL_KEYBOARD_QUERY_INDICATORS\n");
697 if (Stack
->Parameters
.DeviceIoControl
.OutputBufferLength
< sizeof(KEYBOARD_INDICATOR_PARAMETERS
))
699 Status
= STATUS_BUFFER_TOO_SMALL
;
704 Irp
->AssociatedIrp
.SystemBuffer
,
705 &DeviceExtension
->KeyboardIndicators
,
706 sizeof(KEYBOARD_INDICATOR_PARAMETERS
));
707 Irp
->IoStatus
.Information
= sizeof(KEYBOARD_INDICATOR_PARAMETERS
);
708 Status
= STATUS_SUCCESS
;
712 case IOCTL_KEYBOARD_SET_INDICATORS
:
714 TRACE_(I8042PRT
, "IRP_MJ_INTERNAL_DEVICE_CONTROL / IOCTL_KEYBOARD_SET_INDICATORS\n");
716 if (Stack
->Parameters
.DeviceIoControl
.InputBufferLength
< sizeof(KEYBOARD_INDICATOR_PARAMETERS
))
718 Status
= STATUS_BUFFER_TOO_SMALL
;
723 &DeviceExtension
->KeyboardIndicators
,
724 Irp
->AssociatedIrp
.SystemBuffer
,
725 sizeof(KEYBOARD_INDICATOR_PARAMETERS
));
726 Status
= STATUS_PENDING
;
727 IoMarkIrpPending(Irp
);
728 IoStartPacket(DeviceObject
, Irp
, NULL
, NULL
);
734 ERR_(I8042PRT
, "IRP_MJ_INTERNAL_DEVICE_CONTROL / unknown ioctl code 0x%lx\n",
735 Stack
->Parameters
.DeviceIoControl
.IoControlCode
);
737 return ForwardIrpAndForget(DeviceObject
, Irp
);
741 Irp
->IoStatus
.Status
= Status
;
742 if (Status
!= STATUS_PENDING
)
743 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
748 * Call the customization hook. The ToReturn parameter is about whether
749 * we should go on with the interrupt. The return value is what
750 * we should return (indicating to the system whether someone else
751 * should try to handle the interrupt)
755 IN PI8042_KEYBOARD_EXTENSION DeviceExtension
,
758 OUT PBOOLEAN ToReturn
)
760 BOOLEAN HookReturn
, HookContinue
;
762 HookContinue
= FALSE
;
764 if (DeviceExtension
->KeyboardHook
.IsrRoutine
)
766 HookReturn
= DeviceExtension
->KeyboardHook
.IsrRoutine(
767 DeviceExtension
->KeyboardHook
.Context
,
768 DeviceExtension
->KeyboardBuffer
+ DeviceExtension
->KeysInBuffer
,
769 &DeviceExtension
->Common
.PortDeviceExtension
->Packet
,
773 &DeviceExtension
->KeyboardScanState
);
777 *ToReturn
= HookReturn
;
785 i8042KbdInterruptService(
786 IN PKINTERRUPT Interrupt
,
789 PI8042_KEYBOARD_EXTENSION DeviceExtension
;
790 PPORT_DEVICE_EXTENSION PortDeviceExtension
;
791 PKEYBOARD_INPUT_DATA InputData
;
793 UCHAR PortStatus
= 0, Output
= 0;
794 BOOLEAN ToReturn
= FALSE
;
797 UNREFERENCED_PARAMETER(Interrupt
);
799 __analysis_assume(Context
!= NULL
);
800 DeviceExtension
= Context
;
801 PortDeviceExtension
= DeviceExtension
->Common
.PortDeviceExtension
;
802 InputData
= DeviceExtension
->KeyboardBuffer
+ DeviceExtension
->KeysInBuffer
;
803 Counter
= PortDeviceExtension
->Settings
.PollStatusIterations
;
807 Status
= i8042ReadStatus(PortDeviceExtension
, &PortStatus
);
808 if (!NT_SUCCESS(Status
))
810 WARN_(I8042PRT
, "i8042ReadStatus() failed with status 0x%08lx\n", Status
);
813 Status
= i8042ReadKeyboardData(PortDeviceExtension
, &Output
);
814 if (NT_SUCCESS(Status
))
816 KeStallExecutionProcessor(1);
821 WARN_(I8042PRT
, "Spurious i8042 keyboard interrupt\n");
825 INFO_(I8042PRT
, "Got: 0x%02x\n", Output
);
827 if (PortDeviceExtension
->Settings
.CrashOnCtrlScroll
)
829 /* Test for CTRL + SCROLL LOCK twice */
830 static const UCHAR ScanCodes
[] = { 0x1d, 0x46, 0xc6, 0x46, 0 };
832 if (Output
== ScanCodes
[DeviceExtension
->ComboPosition
])
834 DeviceExtension
->ComboPosition
++;
835 if (ScanCodes
[DeviceExtension
->ComboPosition
] == 0)
836 KeBugCheck(MANUALLY_INITIATED_CRASH
);
838 else if (Output
== 0xfa)
842 else if (Output
== ScanCodes
[0])
843 DeviceExtension
->ComboPosition
= 1;
845 DeviceExtension
->ComboPosition
= 0;
847 /* Test for TAB + key combination */
848 if (InputData
->MakeCode
== 0x0F)
849 DeviceExtension
->TabPressed
= !(InputData
->Flags
& KEY_BREAK
);
850 else if (DeviceExtension
->TabPressed
)
852 DeviceExtension
->TabPressed
= FALSE
;
854 /* Check which action to do */
855 if (InputData
->MakeCode
== 0x25)
860 else if (InputData
->MakeCode
== 0x30)
863 KeBugCheck(MANUALLY_INITIATED_CRASH
);
867 /* Send request to the kernel debugger.
868 * Unknown requests will be ignored. */
869 KdSystemDebugControl(' soR',
870 (PVOID
)(ULONG_PTR
)InputData
->MakeCode
,
880 if (i8042KbdCallIsrHook(DeviceExtension
, PortStatus
, Output
, &ToReturn
))
883 if (i8042PacketIsr(PortDeviceExtension
, Output
))
885 if (PortDeviceExtension
->PacketComplete
)
887 TRACE_(I8042PRT
, "Packet complete\n");
888 KeInsertQueueDpc(&DeviceExtension
->DpcKeyboard
, NULL
, NULL
);
890 TRACE_(I8042PRT
, "Irq eaten by packet\n");
894 TRACE_(I8042PRT
, "Irq is keyboard input\n");
896 if (DeviceExtension
->KeyboardScanState
== Normal
)
901 DeviceExtension
->KeyboardScanState
= GotE0
;
904 DeviceExtension
->KeyboardScanState
= GotE1
;
911 /* Update InputData */
912 InputData
->Flags
= 0;
913 switch (DeviceExtension
->KeyboardScanState
)
916 InputData
->Flags
|= KEY_E0
;
919 InputData
->Flags
|= KEY_E1
;
924 DeviceExtension
->KeyboardScanState
= Normal
;
926 InputData
->Flags
|= KEY_BREAK
;
928 InputData
->Flags
|= KEY_MAKE
;
929 InputData
->MakeCode
= Output
& 0x7f;
930 InputData
->Reserved
= 0;
932 DeviceExtension
->KeyboardHook
.QueueKeyboardPacket(DeviceExtension
->KeyboardHook
.CallContext
);