3 PS/2 Keyboard driver. Routines that interacts with callers,
4 conforming to EFI driver model
6 Copyright (c) 2006 - 2009, Intel Corporation
7 All rights reserved. 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
->ScancodeBufStartPos
= 0;
247 ConsoleIn
->ScancodeBufEndPos
= KEYBOARD_BUFFER_MAX_COUNT
- 1;
248 ConsoleIn
->ScancodeBufCount
= 0;
249 ConsoleIn
->Ctrled
= FALSE
;
250 ConsoleIn
->Alted
= FALSE
;
251 ConsoleIn
->DevicePath
= ParentDevicePath
;
253 ConsoleIn
->ConInEx
.Reset
= KeyboardEfiResetEx
;
254 ConsoleIn
->ConInEx
.ReadKeyStrokeEx
= KeyboardReadKeyStrokeEx
;
255 ConsoleIn
->ConInEx
.SetState
= KeyboardSetState
;
256 ConsoleIn
->ConInEx
.RegisterKeyNotify
= KeyboardRegisterKeyNotify
;
257 ConsoleIn
->ConInEx
.UnregisterKeyNotify
= KeyboardUnregisterKeyNotify
;
259 InitializeListHead (&ConsoleIn
->NotifyList
);
262 // Fix for random hangs in System waiting for the Key if no KBC is present in BIOS.
264 KeyboardRead (ConsoleIn
, &Data
);
265 if ((KeyReadStatusRegister (ConsoleIn
) & (KBC_PARE
| KBC_TIM
)) == (KBC_PARE
| KBC_TIM
)) {
267 // If nobody decodes KBC I/O port, it will read back as 0xFF.
268 // Check the Time-Out and Parity bit to see if it has an active KBC in system
270 Status
= EFI_DEVICE_ERROR
;
271 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_NOT_DETECTED
;
276 // Setup the WaitForKey event
278 Status
= gBS
->CreateEvent (
283 &((ConsoleIn
->ConIn
).WaitForKey
)
285 if (EFI_ERROR (Status
)) {
286 Status
= EFI_OUT_OF_RESOURCES
;
287 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
291 // Setup the WaitForKeyEx event
293 Status
= gBS
->CreateEvent (
296 KeyboardWaitForKeyEx
,
297 &(ConsoleIn
->ConInEx
),
298 &(ConsoleIn
->ConInEx
.WaitForKeyEx
)
300 if (EFI_ERROR (Status
)) {
301 Status
= EFI_OUT_OF_RESOURCES
;
302 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
305 // Setup a periodic timer, used for reading keystrokes at a fixed interval
307 Status
= gBS
->CreateEvent (
308 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
310 KeyboardTimerHandler
,
312 &ConsoleIn
->TimerEvent
314 if (EFI_ERROR (Status
)) {
315 Status
= EFI_OUT_OF_RESOURCES
;
316 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
320 Status
= gBS
->SetTimer (
321 ConsoleIn
->TimerEvent
,
323 KEYBOARD_TIMER_INTERVAL
325 if (EFI_ERROR (Status
)) {
326 Status
= EFI_OUT_OF_RESOURCES
;
327 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
331 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
333 EFI_PERIPHERAL_KEYBOARD
| EFI_P_PC_PRESENCE_DETECT
,
338 // Reset the keyboard device
340 Status
= ConsoleIn
->ConIn
.Reset (&ConsoleIn
->ConIn
, TRUE
);
341 if (EFI_ERROR (Status
)) {
342 Status
= EFI_DEVICE_ERROR
;
343 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_NOT_DETECTED
;
347 ConsoleIn
->ControllerNameTable
= NULL
;
350 gPs2KeyboardComponentName
.SupportedLanguages
,
351 &ConsoleIn
->ControllerNameTable
,
352 L
"PS/2 Keyboard Device",
357 gPs2KeyboardComponentName2
.SupportedLanguages
,
358 &ConsoleIn
->ControllerNameTable
,
359 L
"PS/2 Keyboard Device",
365 // Install protocol interfaces for the keyboard device.
367 Status
= gBS
->InstallMultipleProtocolInterfaces (
369 &gEfiSimpleTextInProtocolGuid
,
371 &gEfiSimpleTextInputExProtocolGuid
,
375 if (EFI_ERROR (Status
)) {
376 StatusCode
= EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_CONTROLLER_ERROR
;
386 if (StatusCode
!= 0) {
387 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
388 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
394 if ((ConsoleIn
!= NULL
) && (ConsoleIn
->ConIn
.WaitForKey
!= NULL
)) {
395 gBS
->CloseEvent (ConsoleIn
->ConIn
.WaitForKey
);
398 if ((ConsoleIn
!= NULL
) && (ConsoleIn
->TimerEvent
!= NULL
)) {
399 gBS
->CloseEvent (ConsoleIn
->TimerEvent
);
401 if ((ConsoleIn
!= NULL
) && (ConsoleIn
->ConInEx
.WaitForKeyEx
!= NULL
)) {
402 gBS
->CloseEvent (ConsoleIn
->ConInEx
.WaitForKeyEx
);
404 KbdFreeNotifyList (&ConsoleIn
->NotifyList
);
405 if ((ConsoleIn
!= NULL
) && (ConsoleIn
->ControllerNameTable
!= NULL
)) {
406 FreeUnicodeStringTable (ConsoleIn
->ControllerNameTable
);
409 // Since there will be no timer handler for keyboard input any more,
410 // exhaust input data just in case there is still keyboard data left
412 if (ConsoleIn
!= NULL
) {
413 Status1
= EFI_SUCCESS
;
414 while (!EFI_ERROR (Status1
) && (Status
!= EFI_DEVICE_ERROR
)) {
415 Status1
= KeyboardRead (ConsoleIn
, &Data
);;
419 if (ConsoleIn
!= NULL
) {
420 gBS
->FreePool (ConsoleIn
);
425 &gEfiDevicePathProtocolGuid
,
426 This
->DriverBindingHandle
,
432 &gEfiIsaIoProtocolGuid
,
433 This
->DriverBindingHandle
,
441 Stop this driver on ControllerHandle. Support stoping any child handles
442 created by this driver.
444 @param This Protocol instance pointer.
445 @param ControllerHandle Handle of device to stop driver on
446 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
447 children is zero stop the entire bus driver.
448 @param ChildHandleBuffer List of Child Handles to Stop.
450 @retval EFI_SUCCESS This driver is removed ControllerHandle
451 @retval other This driver was not removed from this device
456 KbdControllerDriverStop (
457 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
458 IN EFI_HANDLE Controller
,
459 IN UINTN NumberOfChildren
,
460 IN EFI_HANDLE
*ChildHandleBuffer
464 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*ConIn
;
465 KEYBOARD_CONSOLE_IN_DEV
*ConsoleIn
;
471 Status
= gBS
->OpenProtocol (
473 &gEfiSimpleTextInProtocolGuid
,
475 This
->DriverBindingHandle
,
477 EFI_OPEN_PROTOCOL_GET_PROTOCOL
479 if (EFI_ERROR (Status
)) {
482 Status
= gBS
->OpenProtocol (
484 &gEfiSimpleTextInputExProtocolGuid
,
486 This
->DriverBindingHandle
,
488 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
490 if (EFI_ERROR (Status
)) {
494 ConsoleIn
= KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (ConIn
);
497 // Report that the keyboard is being disabled
499 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
501 EFI_PERIPHERAL_KEYBOARD
| EFI_P_PC_DISABLE
,
502 ConsoleIn
->DevicePath
505 if (ConsoleIn
->TimerEvent
!= NULL
) {
506 gBS
->CloseEvent (ConsoleIn
->TimerEvent
);
507 ConsoleIn
->TimerEvent
= NULL
;
510 // Disable the keyboard interface
512 Status
= DisableKeyboard (ConsoleIn
);
515 // Since there will be no timer handler for keyboard input any more,
516 // exhaust input data just in case there is still keyboard data left
518 Status
= EFI_SUCCESS
;
519 while (!EFI_ERROR (Status
)) {
520 Status
= KeyboardRead (ConsoleIn
, &Data
);;
523 // Uninstall the SimpleTextIn and SimpleTextInEx protocols
525 Status
= gBS
->UninstallMultipleProtocolInterfaces (
527 &gEfiSimpleTextInProtocolGuid
,
529 &gEfiSimpleTextInputExProtocolGuid
,
533 if (EFI_ERROR (Status
)) {
539 &gEfiDevicePathProtocolGuid
,
540 This
->DriverBindingHandle
,
546 &gEfiIsaIoProtocolGuid
,
547 This
->DriverBindingHandle
,
552 // Free other resources
554 if ((ConsoleIn
->ConIn
).WaitForKey
!= NULL
) {
555 gBS
->CloseEvent ((ConsoleIn
->ConIn
).WaitForKey
);
556 (ConsoleIn
->ConIn
).WaitForKey
= NULL
;
558 if (ConsoleIn
->ConInEx
.WaitForKeyEx
!= NULL
) {
559 gBS
->CloseEvent (ConsoleIn
->ConInEx
.WaitForKeyEx
);
560 ConsoleIn
->ConInEx
.WaitForKeyEx
= NULL
;
562 KbdFreeNotifyList (&ConsoleIn
->NotifyList
);
563 FreeUnicodeStringTable (ConsoleIn
->ControllerNameTable
);
564 gBS
->FreePool (ConsoleIn
);
570 Free the waiting key notify list.
572 @param ListHead Pointer to list head
574 @retval EFI_INVALID_PARAMETER ListHead is NULL
575 @retval EFI_SUCCESS Sucess to free NotifyList
579 IN OUT LIST_ENTRY
*ListHead
582 KEYBOARD_CONSOLE_IN_EX_NOTIFY
*NotifyNode
;
584 if (ListHead
== NULL
) {
585 return EFI_INVALID_PARAMETER
;
587 while (!IsListEmpty (ListHead
)) {
589 ListHead
->ForwardLink
,
590 KEYBOARD_CONSOLE_IN_EX_NOTIFY
,
592 KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE
594 RemoveEntryList (ListHead
->ForwardLink
);
595 gBS
->FreePool (NotifyNode
);
602 The module Entry Point for module Ps2Keyboard.
604 @param[in] ImageHandle The firmware allocated handle for the EFI image.
605 @param[in] SystemTable A pointer to the EFI System Table.
607 @retval EFI_SUCCESS The entry point is executed successfully.
608 @retval other Some error occurs when executing this entry point.
613 InitializePs2Keyboard(
614 IN EFI_HANDLE ImageHandle
,
615 IN EFI_SYSTEM_TABLE
*SystemTable
621 // Install driver model protocol(s).
623 Status
= EfiLibInstallDriverBindingComponentName2 (
626 &gKeyboardControllerDriver
,
628 &gPs2KeyboardComponentName
,
629 &gPs2KeyboardComponentName2
631 ASSERT_EFI_ERROR (Status
);