3 PS/2 Keyboard driver. Routines that interacts with callers,
4 conforming to EFI driver model
6 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include "Ps2Keyboard.h"
20 // Function prototypes
23 Test controller is a keyboard Controller.
25 @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL
26 @param Controller driver's controller
27 @param RemainingDevicePath children device path
29 @retval EFI_UNSUPPORTED controller is not floppy disk
30 @retval EFI_SUCCESS controller is floppy disk
34 KbdControllerDriverSupported (
35 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
36 IN EFI_HANDLE Controller
,
37 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
41 Create KEYBOARD_CONSOLE_IN_DEV instance on controller.
43 @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL
44 @param Controller driver controller handle
45 @param RemainingDevicePath Children's device path
47 @retval whether success to create floppy control instance.
51 KbdControllerDriverStart (
52 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
53 IN EFI_HANDLE Controller
,
54 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
58 Stop this driver on ControllerHandle. Support stoping any child handles
59 created by this driver.
61 @param This Protocol instance pointer.
62 @param ControllerHandle Handle of device to stop driver on
63 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
64 children is zero stop the entire bus driver.
65 @param ChildHandleBuffer List of Child Handles to Stop.
67 @retval EFI_SUCCESS This driver is removed ControllerHandle
68 @retval other This driver was not removed from this device
73 KbdControllerDriverStop (
74 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
75 IN EFI_HANDLE Controller
,
76 IN UINTN NumberOfChildren
,
77 IN EFI_HANDLE
*ChildHandleBuffer
81 Free the waiting key notify list.
83 @param ListHead Pointer to list head
85 @retval EFI_INVALID_PARAMETER ListHead is NULL
86 @retval EFI_SUCCESS Sucess to free NotifyList
90 IN OUT LIST_ENTRY
*ListHead
94 // DriverBinding Protocol Instance
96 EFI_DRIVER_BINDING_PROTOCOL gKeyboardControllerDriver
= {
97 KbdControllerDriverSupported
,
98 KbdControllerDriverStart
,
99 KbdControllerDriverStop
,
106 Test controller is a keyboard Controller.
108 @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL
109 @param Controller driver's controller
110 @param RemainingDevicePath children device path
112 @retval EFI_UNSUPPORTED controller is not floppy disk
113 @retval EFI_SUCCESS controller is floppy disk
117 KbdControllerDriverSupported (
118 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
119 IN EFI_HANDLE Controller
,
120 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
124 EFI_ISA_IO_PROTOCOL
*IsaIo
;
127 // Open the IO Abstraction(s) needed to perform the supported test
129 Status
= gBS
->OpenProtocol (
131 &gEfiIsaIoProtocolGuid
,
133 This
->DriverBindingHandle
,
135 EFI_OPEN_PROTOCOL_BY_DRIVER
137 if (EFI_ERROR (Status
)) {
141 // Use the ISA I/O Protocol to see if Controller is the Keyboard controller
143 if (IsaIo
->ResourceList
->Device
.HID
!= EISA_PNP_ID (0x303) || IsaIo
->ResourceList
->Device
.UID
!= 0) {
144 Status
= EFI_UNSUPPORTED
;
147 // Close the I/O Abstraction(s) used to perform the supported test
151 &gEfiIsaIoProtocolGuid
,
152 This
->DriverBindingHandle
,
160 Create KEYBOARD_CONSOLE_IN_DEV instance on controller.
162 @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL
163 @param Controller driver controller handle
164 @param RemainingDevicePath Children's device path
166 @retval whether success to create floppy control instance.
170 KbdControllerDriverStart (
171 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
172 IN EFI_HANDLE Controller
,
173 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
178 EFI_ISA_IO_PROTOCOL
*IsaIo
;
179 KEYBOARD_CONSOLE_IN_DEV
*ConsoleIn
;
181 EFI_STATUS_CODE_VALUE StatusCode
;
182 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
186 Status
= gBS
->OpenProtocol (
188 &gEfiDevicePathProtocolGuid
,
189 (VOID
**) &ParentDevicePath
,
190 This
->DriverBindingHandle
,
192 EFI_OPEN_PROTOCOL_BY_DRIVER
194 if (EFI_ERROR (Status
)) {
198 // Report that the keyboard is being enabled
200 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
202 EFI_PERIPHERAL_KEYBOARD
| EFI_P_PC_ENABLE
,
207 // Get the ISA I/O Protocol on Controller's handle
209 Status
= gBS
->OpenProtocol (
211 &gEfiIsaIoProtocolGuid
,
213 This
->DriverBindingHandle
,
215 EFI_OPEN_PROTOCOL_BY_DRIVER
217 if (EFI_ERROR (Status
)) {
220 &gEfiDevicePathProtocolGuid
,
221 This
->DriverBindingHandle
,
224 return EFI_INVALID_PARAMETER
;
227 // Allocate private data
229 ConsoleIn
= AllocateZeroPool (sizeof (KEYBOARD_CONSOLE_IN_DEV
));
230 if (ConsoleIn
== NULL
) {
231 Status
= EFI_OUT_OF_RESOURCES
;
232 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
236 // Setup the device instance
238 ConsoleIn
->Signature
= KEYBOARD_CONSOLE_IN_DEV_SIGNATURE
;
239 ConsoleIn
->Handle
= Controller
;
240 (ConsoleIn
->ConIn
).Reset
= KeyboardEfiReset
;
241 (ConsoleIn
->ConIn
).ReadKeyStroke
= KeyboardReadKeyStroke
;
242 ConsoleIn
->DataRegisterAddress
= KEYBOARD_8042_DATA_REGISTER
;
243 ConsoleIn
->StatusRegisterAddress
= KEYBOARD_8042_STATUS_REGISTER
;
244 ConsoleIn
->CommandRegisterAddress
= KEYBOARD_8042_COMMAND_REGISTER
;
245 ConsoleIn
->IsaIo
= IsaIo
;
246 ConsoleIn
->DevicePath
= ParentDevicePath
;
248 ConsoleIn
->ConInEx
.Reset
= KeyboardEfiResetEx
;
249 ConsoleIn
->ConInEx
.ReadKeyStrokeEx
= KeyboardReadKeyStrokeEx
;
250 ConsoleIn
->ConInEx
.SetState
= KeyboardSetState
;
251 ConsoleIn
->ConInEx
.RegisterKeyNotify
= KeyboardRegisterKeyNotify
;
252 ConsoleIn
->ConInEx
.UnregisterKeyNotify
= KeyboardUnregisterKeyNotify
;
254 InitializeListHead (&ConsoleIn
->NotifyList
);
257 // Fix for random hangs in System waiting for the Key if no KBC is present in BIOS.
259 KeyboardRead (ConsoleIn
, &Data
);
260 if ((KeyReadStatusRegister (ConsoleIn
) & (KBC_PARE
| KBC_TIM
)) == (KBC_PARE
| KBC_TIM
)) {
262 // If nobody decodes KBC I/O port, it will read back as 0xFF.
263 // Check the Time-Out and Parity bit to see if it has an active KBC in system
265 Status
= EFI_DEVICE_ERROR
;
266 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_NOT_DETECTED
;
271 // Setup the WaitForKey event
273 Status
= gBS
->CreateEvent (
278 &((ConsoleIn
->ConIn
).WaitForKey
)
280 if (EFI_ERROR (Status
)) {
281 Status
= EFI_OUT_OF_RESOURCES
;
282 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
286 // Setup the WaitForKeyEx event
288 Status
= gBS
->CreateEvent (
291 KeyboardWaitForKeyEx
,
293 &(ConsoleIn
->ConInEx
.WaitForKeyEx
)
295 if (EFI_ERROR (Status
)) {
296 Status
= EFI_OUT_OF_RESOURCES
;
297 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
300 // Setup a periodic timer, used for reading keystrokes at a fixed interval
302 Status
= gBS
->CreateEvent (
303 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
305 KeyboardTimerHandler
,
307 &ConsoleIn
->TimerEvent
309 if (EFI_ERROR (Status
)) {
310 Status
= EFI_OUT_OF_RESOURCES
;
311 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
315 Status
= gBS
->SetTimer (
316 ConsoleIn
->TimerEvent
,
318 KEYBOARD_TIMER_INTERVAL
320 if (EFI_ERROR (Status
)) {
321 Status
= EFI_OUT_OF_RESOURCES
;
322 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
326 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
328 EFI_PERIPHERAL_KEYBOARD
| EFI_P_PC_PRESENCE_DETECT
,
333 // Reset the keyboard device
335 Status
= ConsoleIn
->ConInEx
.Reset (&ConsoleIn
->ConInEx
, FeaturePcdGet (PcdPs2KbdExtendedVerification
));
336 if (EFI_ERROR (Status
)) {
337 Status
= EFI_DEVICE_ERROR
;
338 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_NOT_DETECTED
;
342 ConsoleIn
->ControllerNameTable
= NULL
;
345 gPs2KeyboardComponentName
.SupportedLanguages
,
346 &ConsoleIn
->ControllerNameTable
,
347 L
"PS/2 Keyboard Device",
352 gPs2KeyboardComponentName2
.SupportedLanguages
,
353 &ConsoleIn
->ControllerNameTable
,
354 L
"PS/2 Keyboard Device",
360 // Install protocol interfaces for the keyboard device.
362 Status
= gBS
->InstallMultipleProtocolInterfaces (
364 &gEfiSimpleTextInProtocolGuid
,
366 &gEfiSimpleTextInputExProtocolGuid
,
370 if (EFI_ERROR (Status
)) {
371 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
381 if (StatusCode
!= 0) {
382 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
383 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
389 if ((ConsoleIn
!= NULL
) && (ConsoleIn
->ConIn
.WaitForKey
!= NULL
)) {
390 gBS
->CloseEvent (ConsoleIn
->ConIn
.WaitForKey
);
393 if ((ConsoleIn
!= NULL
) && (ConsoleIn
->TimerEvent
!= NULL
)) {
394 gBS
->CloseEvent (ConsoleIn
->TimerEvent
);
396 if ((ConsoleIn
!= NULL
) && (ConsoleIn
->ConInEx
.WaitForKeyEx
!= NULL
)) {
397 gBS
->CloseEvent (ConsoleIn
->ConInEx
.WaitForKeyEx
);
399 KbdFreeNotifyList (&ConsoleIn
->NotifyList
);
400 if ((ConsoleIn
!= NULL
) && (ConsoleIn
->ControllerNameTable
!= NULL
)) {
401 FreeUnicodeStringTable (ConsoleIn
->ControllerNameTable
);
404 // Since there will be no timer handler for keyboard input any more,
405 // exhaust input data just in case there is still keyboard data left
407 if (ConsoleIn
!= NULL
) {
408 Status1
= EFI_SUCCESS
;
409 while (!EFI_ERROR (Status1
) && (Status
!= EFI_DEVICE_ERROR
)) {
410 Status1
= KeyboardRead (ConsoleIn
, &Data
);;
414 if (ConsoleIn
!= NULL
) {
415 gBS
->FreePool (ConsoleIn
);
420 &gEfiDevicePathProtocolGuid
,
421 This
->DriverBindingHandle
,
427 &gEfiIsaIoProtocolGuid
,
428 This
->DriverBindingHandle
,
436 Stop this driver on ControllerHandle. Support stoping any child handles
437 created by this driver.
439 @param This Protocol instance pointer.
440 @param ControllerHandle Handle of device to stop driver on
441 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
442 children is zero stop the entire bus driver.
443 @param ChildHandleBuffer List of Child Handles to Stop.
445 @retval EFI_SUCCESS This driver is removed ControllerHandle
446 @retval other This driver was not removed from this device
451 KbdControllerDriverStop (
452 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
453 IN EFI_HANDLE Controller
,
454 IN UINTN NumberOfChildren
,
455 IN EFI_HANDLE
*ChildHandleBuffer
459 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*ConIn
;
460 KEYBOARD_CONSOLE_IN_DEV
*ConsoleIn
;
466 Status
= gBS
->OpenProtocol (
468 &gEfiSimpleTextInProtocolGuid
,
470 This
->DriverBindingHandle
,
472 EFI_OPEN_PROTOCOL_GET_PROTOCOL
474 if (EFI_ERROR (Status
)) {
477 Status
= gBS
->OpenProtocol (
479 &gEfiSimpleTextInputExProtocolGuid
,
481 This
->DriverBindingHandle
,
483 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
485 if (EFI_ERROR (Status
)) {
489 ConsoleIn
= KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (ConIn
);
492 // Report that the keyboard is being disabled
494 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
496 EFI_PERIPHERAL_KEYBOARD
| EFI_P_PC_DISABLE
,
497 ConsoleIn
->DevicePath
500 if (ConsoleIn
->TimerEvent
!= NULL
) {
501 gBS
->CloseEvent (ConsoleIn
->TimerEvent
);
502 ConsoleIn
->TimerEvent
= NULL
;
506 // Since there will be no timer handler for keyboard input any more,
507 // exhaust input data just in case there is still keyboard data left
509 Status
= EFI_SUCCESS
;
510 while (!EFI_ERROR (Status
)) {
511 Status
= KeyboardRead (ConsoleIn
, &Data
);;
514 // Uninstall the SimpleTextIn and SimpleTextInEx protocols
516 Status
= gBS
->UninstallMultipleProtocolInterfaces (
518 &gEfiSimpleTextInProtocolGuid
,
520 &gEfiSimpleTextInputExProtocolGuid
,
524 if (EFI_ERROR (Status
)) {
530 &gEfiDevicePathProtocolGuid
,
531 This
->DriverBindingHandle
,
537 &gEfiIsaIoProtocolGuid
,
538 This
->DriverBindingHandle
,
543 // Free other resources
545 if ((ConsoleIn
->ConIn
).WaitForKey
!= NULL
) {
546 gBS
->CloseEvent ((ConsoleIn
->ConIn
).WaitForKey
);
547 (ConsoleIn
->ConIn
).WaitForKey
= NULL
;
549 if (ConsoleIn
->ConInEx
.WaitForKeyEx
!= NULL
) {
550 gBS
->CloseEvent (ConsoleIn
->ConInEx
.WaitForKeyEx
);
551 ConsoleIn
->ConInEx
.WaitForKeyEx
= NULL
;
553 KbdFreeNotifyList (&ConsoleIn
->NotifyList
);
554 FreeUnicodeStringTable (ConsoleIn
->ControllerNameTable
);
555 gBS
->FreePool (ConsoleIn
);
561 Free the waiting key notify list.
563 @param ListHead Pointer to list head
565 @retval EFI_INVALID_PARAMETER ListHead is NULL
566 @retval EFI_SUCCESS Sucess to free NotifyList
570 IN OUT LIST_ENTRY
*ListHead
573 KEYBOARD_CONSOLE_IN_EX_NOTIFY
*NotifyNode
;
575 if (ListHead
== NULL
) {
576 return EFI_INVALID_PARAMETER
;
578 while (!IsListEmpty (ListHead
)) {
580 ListHead
->ForwardLink
,
581 KEYBOARD_CONSOLE_IN_EX_NOTIFY
,
583 KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE
585 RemoveEntryList (ListHead
->ForwardLink
);
586 gBS
->FreePool (NotifyNode
);
593 The module Entry Point for module Ps2Keyboard.
595 @param[in] ImageHandle The firmware allocated handle for the EFI image.
596 @param[in] SystemTable A pointer to the EFI System Table.
598 @retval EFI_SUCCESS The entry point is executed successfully.
599 @retval other Some error occurs when executing this entry point.
604 InitializePs2Keyboard(
605 IN EFI_HANDLE ImageHandle
,
606 IN EFI_SYSTEM_TABLE
*SystemTable
612 // Install driver model protocol(s).
614 Status
= EfiLibInstallDriverBindingComponentName2 (
617 &gKeyboardControllerDriver
,
619 &gPs2KeyboardComponentName
,
620 &gPs2KeyboardComponentName2
622 ASSERT_EFI_ERROR (Status
);