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.
258 // When KBC decode (IO port 0x60/0x64 decode) is not enabled,
259 // KeyboardRead will read back as 0xFF and return status is EFI_SUCCESS.
260 // So instead we read status register to detect after read if KBC decode is enabled.
264 // Return code is ignored on purpose.
266 KeyboardRead (ConsoleIn
, &Data
);
267 if ((KeyReadStatusRegister (ConsoleIn
) & (KBC_PARE
| KBC_TIM
)) == (KBC_PARE
| KBC_TIM
)) {
269 // If nobody decodes KBC I/O port, it will read back as 0xFF.
270 // Check the Time-Out and Parity bit to see if it has an active KBC in system
272 Status
= EFI_DEVICE_ERROR
;
273 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_NOT_DETECTED
;
278 // Setup the WaitForKey event
280 Status
= gBS
->CreateEvent (
285 &((ConsoleIn
->ConIn
).WaitForKey
)
287 if (EFI_ERROR (Status
)) {
288 Status
= EFI_OUT_OF_RESOURCES
;
289 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
293 // Setup the WaitForKeyEx event
295 Status
= gBS
->CreateEvent (
298 KeyboardWaitForKeyEx
,
300 &(ConsoleIn
->ConInEx
.WaitForKeyEx
)
302 if (EFI_ERROR (Status
)) {
303 Status
= EFI_OUT_OF_RESOURCES
;
304 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
307 // Setup a periodic timer, used for reading keystrokes at a fixed interval
309 Status
= gBS
->CreateEvent (
310 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
312 KeyboardTimerHandler
,
314 &ConsoleIn
->TimerEvent
316 if (EFI_ERROR (Status
)) {
317 Status
= EFI_OUT_OF_RESOURCES
;
318 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
322 Status
= gBS
->SetTimer (
323 ConsoleIn
->TimerEvent
,
325 KEYBOARD_TIMER_INTERVAL
327 if (EFI_ERROR (Status
)) {
328 Status
= EFI_OUT_OF_RESOURCES
;
329 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
333 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
335 EFI_PERIPHERAL_KEYBOARD
| EFI_P_PC_PRESENCE_DETECT
,
340 // Reset the keyboard device
342 Status
= ConsoleIn
->ConInEx
.Reset (&ConsoleIn
->ConInEx
, FeaturePcdGet (PcdPs2KbdExtendedVerification
));
343 if (EFI_ERROR (Status
)) {
344 Status
= EFI_DEVICE_ERROR
;
345 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_NOT_DETECTED
;
349 ConsoleIn
->ControllerNameTable
= NULL
;
352 gPs2KeyboardComponentName
.SupportedLanguages
,
353 &ConsoleIn
->ControllerNameTable
,
354 L
"PS/2 Keyboard Device",
359 gPs2KeyboardComponentName2
.SupportedLanguages
,
360 &ConsoleIn
->ControllerNameTable
,
361 L
"PS/2 Keyboard Device",
367 // Install protocol interfaces for the keyboard device.
369 Status
= gBS
->InstallMultipleProtocolInterfaces (
371 &gEfiSimpleTextInProtocolGuid
,
373 &gEfiSimpleTextInputExProtocolGuid
,
377 if (EFI_ERROR (Status
)) {
378 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
388 if (StatusCode
!= 0) {
389 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
390 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
396 if ((ConsoleIn
!= NULL
) && (ConsoleIn
->ConIn
.WaitForKey
!= NULL
)) {
397 gBS
->CloseEvent (ConsoleIn
->ConIn
.WaitForKey
);
400 if ((ConsoleIn
!= NULL
) && (ConsoleIn
->TimerEvent
!= NULL
)) {
401 gBS
->CloseEvent (ConsoleIn
->TimerEvent
);
403 if ((ConsoleIn
!= NULL
) && (ConsoleIn
->ConInEx
.WaitForKeyEx
!= NULL
)) {
404 gBS
->CloseEvent (ConsoleIn
->ConInEx
.WaitForKeyEx
);
406 KbdFreeNotifyList (&ConsoleIn
->NotifyList
);
407 if ((ConsoleIn
!= NULL
) && (ConsoleIn
->ControllerNameTable
!= NULL
)) {
408 FreeUnicodeStringTable (ConsoleIn
->ControllerNameTable
);
411 // Since there will be no timer handler for keyboard input any more,
412 // exhaust input data just in case there is still keyboard data left
414 if (ConsoleIn
!= NULL
) {
415 Status1
= EFI_SUCCESS
;
416 while (!EFI_ERROR (Status1
) && (Status
!= EFI_DEVICE_ERROR
)) {
417 Status1
= KeyboardRead (ConsoleIn
, &Data
);;
421 if (ConsoleIn
!= NULL
) {
422 gBS
->FreePool (ConsoleIn
);
427 &gEfiDevicePathProtocolGuid
,
428 This
->DriverBindingHandle
,
434 &gEfiIsaIoProtocolGuid
,
435 This
->DriverBindingHandle
,
443 Stop this driver on ControllerHandle. Support stoping any child handles
444 created by this driver.
446 @param This Protocol instance pointer.
447 @param ControllerHandle Handle of device to stop driver on
448 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
449 children is zero stop the entire bus driver.
450 @param ChildHandleBuffer List of Child Handles to Stop.
452 @retval EFI_SUCCESS This driver is removed ControllerHandle
453 @retval other This driver was not removed from this device
458 KbdControllerDriverStop (
459 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
460 IN EFI_HANDLE Controller
,
461 IN UINTN NumberOfChildren
,
462 IN EFI_HANDLE
*ChildHandleBuffer
466 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*ConIn
;
467 KEYBOARD_CONSOLE_IN_DEV
*ConsoleIn
;
473 Status
= gBS
->OpenProtocol (
475 &gEfiSimpleTextInProtocolGuid
,
477 This
->DriverBindingHandle
,
479 EFI_OPEN_PROTOCOL_GET_PROTOCOL
481 if (EFI_ERROR (Status
)) {
484 Status
= gBS
->OpenProtocol (
486 &gEfiSimpleTextInputExProtocolGuid
,
488 This
->DriverBindingHandle
,
490 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
492 if (EFI_ERROR (Status
)) {
496 ConsoleIn
= KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (ConIn
);
499 // Report that the keyboard is being disabled
501 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
503 EFI_PERIPHERAL_KEYBOARD
| EFI_P_PC_DISABLE
,
504 ConsoleIn
->DevicePath
507 if (ConsoleIn
->TimerEvent
!= NULL
) {
508 gBS
->CloseEvent (ConsoleIn
->TimerEvent
);
509 ConsoleIn
->TimerEvent
= NULL
;
513 // Since there will be no timer handler for keyboard input any more,
514 // exhaust input data just in case there is still keyboard data left
516 Status
= EFI_SUCCESS
;
517 while (!EFI_ERROR (Status
)) {
518 Status
= KeyboardRead (ConsoleIn
, &Data
);;
521 // Uninstall the SimpleTextIn and SimpleTextInEx protocols
523 Status
= gBS
->UninstallMultipleProtocolInterfaces (
525 &gEfiSimpleTextInProtocolGuid
,
527 &gEfiSimpleTextInputExProtocolGuid
,
531 if (EFI_ERROR (Status
)) {
537 &gEfiDevicePathProtocolGuid
,
538 This
->DriverBindingHandle
,
544 &gEfiIsaIoProtocolGuid
,
545 This
->DriverBindingHandle
,
550 // Free other resources
552 if ((ConsoleIn
->ConIn
).WaitForKey
!= NULL
) {
553 gBS
->CloseEvent ((ConsoleIn
->ConIn
).WaitForKey
);
554 (ConsoleIn
->ConIn
).WaitForKey
= NULL
;
556 if (ConsoleIn
->ConInEx
.WaitForKeyEx
!= NULL
) {
557 gBS
->CloseEvent (ConsoleIn
->ConInEx
.WaitForKeyEx
);
558 ConsoleIn
->ConInEx
.WaitForKeyEx
= NULL
;
560 KbdFreeNotifyList (&ConsoleIn
->NotifyList
);
561 FreeUnicodeStringTable (ConsoleIn
->ControllerNameTable
);
562 gBS
->FreePool (ConsoleIn
);
568 Free the waiting key notify list.
570 @param ListHead Pointer to list head
572 @retval EFI_INVALID_PARAMETER ListHead is NULL
573 @retval EFI_SUCCESS Sucess to free NotifyList
577 IN OUT LIST_ENTRY
*ListHead
580 KEYBOARD_CONSOLE_IN_EX_NOTIFY
*NotifyNode
;
582 if (ListHead
== NULL
) {
583 return EFI_INVALID_PARAMETER
;
585 while (!IsListEmpty (ListHead
)) {
587 ListHead
->ForwardLink
,
588 KEYBOARD_CONSOLE_IN_EX_NOTIFY
,
590 KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE
592 RemoveEntryList (ListHead
->ForwardLink
);
593 gBS
->FreePool (NotifyNode
);
600 The module Entry Point for module Ps2Keyboard.
602 @param[in] ImageHandle The firmware allocated handle for the EFI image.
603 @param[in] SystemTable A pointer to the EFI System Table.
605 @retval EFI_SUCCESS The entry point is executed successfully.
606 @retval other Some error occurs when executing this entry point.
611 InitializePs2Keyboard(
612 IN EFI_HANDLE ImageHandle
,
613 IN EFI_SYSTEM_TABLE
*SystemTable
619 // Install driver model protocol(s).
621 Status
= EfiLibInstallDriverBindingComponentName2 (
624 &gKeyboardControllerDriver
,
626 &gPs2KeyboardComponentName
,
627 &gPs2KeyboardComponentName2
629 ASSERT_EFI_ERROR (Status
);