]> git.proxmox.com Git - mirror_edk2.git/blob - IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.c
Add PcdFastPS2Detection to improve PS2 keyboard driver start performance.
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / Ps2KeyboardDxe / Ps2Keyboard.c
1 /** @file
2
3 PS/2 Keyboard driver. Routines that interacts with callers,
4 conforming to EFI driver model
5
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
11
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.
14
15 **/
16
17 #include "Ps2Keyboard.h"
18
19 //
20 // Function prototypes
21 //
22 /**
23 Test controller is a keyboard Controller.
24
25 @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL
26 @param Controller driver's controller
27 @param RemainingDevicePath children device path
28
29 @retval EFI_UNSUPPORTED controller is not floppy disk
30 @retval EFI_SUCCESS controller is floppy disk
31 **/
32 EFI_STATUS
33 EFIAPI
34 KbdControllerDriverSupported (
35 IN EFI_DRIVER_BINDING_PROTOCOL *This,
36 IN EFI_HANDLE Controller,
37 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
38 );
39
40 /**
41 Create KEYBOARD_CONSOLE_IN_DEV instance on controller.
42
43 @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL
44 @param Controller driver controller handle
45 @param RemainingDevicePath Children's device path
46
47 @retval whether success to create floppy control instance.
48 **/
49 EFI_STATUS
50 EFIAPI
51 KbdControllerDriverStart (
52 IN EFI_DRIVER_BINDING_PROTOCOL *This,
53 IN EFI_HANDLE Controller,
54 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
55 );
56
57 /**
58 Stop this driver on ControllerHandle. Support stoping any child handles
59 created by this driver.
60
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.
66
67 @retval EFI_SUCCESS This driver is removed ControllerHandle
68 @retval other This driver was not removed from this device
69
70 **/
71 EFI_STATUS
72 EFIAPI
73 KbdControllerDriverStop (
74 IN EFI_DRIVER_BINDING_PROTOCOL *This,
75 IN EFI_HANDLE Controller,
76 IN UINTN NumberOfChildren,
77 IN EFI_HANDLE *ChildHandleBuffer
78 );
79
80 /**
81 Free the waiting key notify list.
82
83 @param ListHead Pointer to list head
84
85 @retval EFI_INVALID_PARAMETER ListHead is NULL
86 @retval EFI_SUCCESS Sucess to free NotifyList
87 **/
88 EFI_STATUS
89 KbdFreeNotifyList (
90 IN OUT LIST_ENTRY *ListHead
91 );
92
93 //
94 // DriverBinding Protocol Instance
95 //
96 EFI_DRIVER_BINDING_PROTOCOL gKeyboardControllerDriver = {
97 KbdControllerDriverSupported,
98 KbdControllerDriverStart,
99 KbdControllerDriverStop,
100 0xa,
101 NULL,
102 NULL
103 };
104
105 /**
106 Test controller is a keyboard Controller.
107
108 @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL
109 @param Controller driver's controller
110 @param RemainingDevicePath children device path
111
112 @retval EFI_UNSUPPORTED controller is not floppy disk
113 @retval EFI_SUCCESS controller is floppy disk
114 **/
115 EFI_STATUS
116 EFIAPI
117 KbdControllerDriverSupported (
118 IN EFI_DRIVER_BINDING_PROTOCOL *This,
119 IN EFI_HANDLE Controller,
120 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
121 )
122 {
123 EFI_STATUS Status;
124 EFI_ISA_IO_PROTOCOL *IsaIo;
125
126 //
127 // Open the IO Abstraction(s) needed to perform the supported test
128 //
129 Status = gBS->OpenProtocol (
130 Controller,
131 &gEfiIsaIoProtocolGuid,
132 (VOID **) &IsaIo,
133 This->DriverBindingHandle,
134 Controller,
135 EFI_OPEN_PROTOCOL_BY_DRIVER
136 );
137 if (EFI_ERROR (Status)) {
138 return Status;
139 }
140 //
141 // Use the ISA I/O Protocol to see if Controller is the Keyboard controller
142 //
143 if (IsaIo->ResourceList->Device.HID != EISA_PNP_ID (0x303) || IsaIo->ResourceList->Device.UID != 0) {
144 Status = EFI_UNSUPPORTED;
145 }
146 //
147 // Close the I/O Abstraction(s) used to perform the supported test
148 //
149 gBS->CloseProtocol (
150 Controller,
151 &gEfiIsaIoProtocolGuid,
152 This->DriverBindingHandle,
153 Controller
154 );
155
156 return Status;
157 }
158
159 /**
160 Create KEYBOARD_CONSOLE_IN_DEV instance on controller.
161
162 @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL
163 @param Controller driver controller handle
164 @param RemainingDevicePath Children's device path
165
166 @retval whether success to create floppy control instance.
167 **/
168 EFI_STATUS
169 EFIAPI
170 KbdControllerDriverStart (
171 IN EFI_DRIVER_BINDING_PROTOCOL *This,
172 IN EFI_HANDLE Controller,
173 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
174 )
175 {
176 EFI_STATUS Status;
177 EFI_STATUS Status1;
178 EFI_ISA_IO_PROTOCOL *IsaIo;
179 KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;
180 UINT8 Data;
181 EFI_STATUS_CODE_VALUE StatusCode;
182 EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;
183
184 StatusCode = 0;
185
186 Status = gBS->OpenProtocol (
187 Controller,
188 &gEfiDevicePathProtocolGuid,
189 (VOID **) &ParentDevicePath,
190 This->DriverBindingHandle,
191 Controller,
192 EFI_OPEN_PROTOCOL_BY_DRIVER
193 );
194 if (EFI_ERROR (Status)) {
195 return Status;
196 }
197 //
198 // Report that the keyboard is being enabled
199 //
200 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
201 EFI_PROGRESS_CODE,
202 EFI_PERIPHERAL_KEYBOARD | EFI_P_PC_ENABLE,
203 ParentDevicePath
204 );
205
206 //
207 // Get the ISA I/O Protocol on Controller's handle
208 //
209 Status = gBS->OpenProtocol (
210 Controller,
211 &gEfiIsaIoProtocolGuid,
212 (VOID **) &IsaIo,
213 This->DriverBindingHandle,
214 Controller,
215 EFI_OPEN_PROTOCOL_BY_DRIVER
216 );
217 if (EFI_ERROR (Status)) {
218 gBS->CloseProtocol (
219 Controller,
220 &gEfiDevicePathProtocolGuid,
221 This->DriverBindingHandle,
222 Controller
223 );
224 return EFI_INVALID_PARAMETER;
225 }
226 //
227 // Allocate private data
228 //
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;
233 goto ErrorExit;
234 }
235 //
236 // Setup the device instance
237 //
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;
247
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;
253
254 InitializeListHead (&ConsoleIn->NotifyList);
255
256 //
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.
261 //
262
263 //
264 // Return code is ignored on purpose.
265 //
266 if (!PcdGetBool (PcdFastPS2Detection)) {
267 KeyboardRead (ConsoleIn, &Data);
268 if ((KeyReadStatusRegister (ConsoleIn) & (KBC_PARE | KBC_TIM)) == (KBC_PARE | KBC_TIM)) {
269 //
270 // If nobody decodes KBC I/O port, it will read back as 0xFF.
271 // Check the Time-Out and Parity bit to see if it has an active KBC in system
272 //
273 Status = EFI_DEVICE_ERROR;
274 StatusCode = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_NOT_DETECTED;
275 goto ErrorExit;
276 }
277 }
278
279 //
280 // Setup the WaitForKey event
281 //
282 Status = gBS->CreateEvent (
283 EVT_NOTIFY_WAIT,
284 TPL_NOTIFY,
285 KeyboardWaitForKey,
286 ConsoleIn,
287 &((ConsoleIn->ConIn).WaitForKey)
288 );
289 if (EFI_ERROR (Status)) {
290 Status = EFI_OUT_OF_RESOURCES;
291 StatusCode = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_CONTROLLER_ERROR;
292 goto ErrorExit;
293 }
294 //
295 // Setup the WaitForKeyEx event
296 //
297 Status = gBS->CreateEvent (
298 EVT_NOTIFY_WAIT,
299 TPL_NOTIFY,
300 KeyboardWaitForKeyEx,
301 ConsoleIn,
302 &(ConsoleIn->ConInEx.WaitForKeyEx)
303 );
304 if (EFI_ERROR (Status)) {
305 Status = EFI_OUT_OF_RESOURCES;
306 StatusCode = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_CONTROLLER_ERROR;
307 goto ErrorExit;
308 }
309 // Setup a periodic timer, used for reading keystrokes at a fixed interval
310 //
311 Status = gBS->CreateEvent (
312 EVT_TIMER | EVT_NOTIFY_SIGNAL,
313 TPL_NOTIFY,
314 KeyboardTimerHandler,
315 ConsoleIn,
316 &ConsoleIn->TimerEvent
317 );
318 if (EFI_ERROR (Status)) {
319 Status = EFI_OUT_OF_RESOURCES;
320 StatusCode = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_CONTROLLER_ERROR;
321 goto ErrorExit;
322 }
323
324 Status = gBS->SetTimer (
325 ConsoleIn->TimerEvent,
326 TimerPeriodic,
327 KEYBOARD_TIMER_INTERVAL
328 );
329 if (EFI_ERROR (Status)) {
330 Status = EFI_OUT_OF_RESOURCES;
331 StatusCode = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_CONTROLLER_ERROR;
332 goto ErrorExit;
333 }
334
335 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
336 EFI_PROGRESS_CODE,
337 EFI_PERIPHERAL_KEYBOARD | EFI_P_PC_PRESENCE_DETECT,
338 ParentDevicePath
339 );
340
341 //
342 // Reset the keyboard device
343 //
344 Status = ConsoleIn->ConInEx.Reset (&ConsoleIn->ConInEx, FeaturePcdGet (PcdPs2KbdExtendedVerification));
345 if (EFI_ERROR (Status)) {
346 Status = EFI_DEVICE_ERROR;
347 StatusCode = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_NOT_DETECTED;
348 goto ErrorExit;
349 }
350
351 ConsoleIn->ControllerNameTable = NULL;
352 AddUnicodeString2 (
353 "eng",
354 gPs2KeyboardComponentName.SupportedLanguages,
355 &ConsoleIn->ControllerNameTable,
356 L"PS/2 Keyboard Device",
357 TRUE
358 );
359 AddUnicodeString2 (
360 "en",
361 gPs2KeyboardComponentName2.SupportedLanguages,
362 &ConsoleIn->ControllerNameTable,
363 L"PS/2 Keyboard Device",
364 FALSE
365 );
366
367
368 //
369 // Install protocol interfaces for the keyboard device.
370 //
371 Status = gBS->InstallMultipleProtocolInterfaces (
372 &Controller,
373 &gEfiSimpleTextInProtocolGuid,
374 &ConsoleIn->ConIn,
375 &gEfiSimpleTextInputExProtocolGuid,
376 &ConsoleIn->ConInEx,
377 NULL
378 );
379 if (EFI_ERROR (Status)) {
380 StatusCode = EFI_PERIPHERAL_KEYBOARD | EFI_P_EC_CONTROLLER_ERROR;
381 goto ErrorExit;
382 }
383
384 return Status;
385
386 ErrorExit:
387 //
388 // Report error code
389 //
390 if (StatusCode != 0) {
391 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
392 EFI_ERROR_CODE | EFI_ERROR_MINOR,
393 StatusCode,
394 ParentDevicePath
395 );
396 }
397
398 if ((ConsoleIn != NULL) && (ConsoleIn->ConIn.WaitForKey != NULL)) {
399 gBS->CloseEvent (ConsoleIn->ConIn.WaitForKey);
400 }
401
402 if ((ConsoleIn != NULL) && (ConsoleIn->TimerEvent != NULL)) {
403 gBS->CloseEvent (ConsoleIn->TimerEvent);
404 }
405 if ((ConsoleIn != NULL) && (ConsoleIn->ConInEx.WaitForKeyEx != NULL)) {
406 gBS->CloseEvent (ConsoleIn->ConInEx.WaitForKeyEx);
407 }
408 KbdFreeNotifyList (&ConsoleIn->NotifyList);
409 if ((ConsoleIn != NULL) && (ConsoleIn->ControllerNameTable != NULL)) {
410 FreeUnicodeStringTable (ConsoleIn->ControllerNameTable);
411 }
412 //
413 // Since there will be no timer handler for keyboard input any more,
414 // exhaust input data just in case there is still keyboard data left
415 //
416 if (ConsoleIn != NULL) {
417 Status1 = EFI_SUCCESS;
418 while (!EFI_ERROR (Status1) && (Status != EFI_DEVICE_ERROR)) {
419 Status1 = KeyboardRead (ConsoleIn, &Data);;
420 }
421 }
422
423 if (ConsoleIn != NULL) {
424 gBS->FreePool (ConsoleIn);
425 }
426
427 gBS->CloseProtocol (
428 Controller,
429 &gEfiDevicePathProtocolGuid,
430 This->DriverBindingHandle,
431 Controller
432 );
433
434 gBS->CloseProtocol (
435 Controller,
436 &gEfiIsaIoProtocolGuid,
437 This->DriverBindingHandle,
438 Controller
439 );
440
441 return Status;
442 }
443
444 /**
445 Stop this driver on ControllerHandle. Support stoping any child handles
446 created by this driver.
447
448 @param This Protocol instance pointer.
449 @param ControllerHandle Handle of device to stop driver on
450 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
451 children is zero stop the entire bus driver.
452 @param ChildHandleBuffer List of Child Handles to Stop.
453
454 @retval EFI_SUCCESS This driver is removed ControllerHandle
455 @retval other This driver was not removed from this device
456
457 **/
458 EFI_STATUS
459 EFIAPI
460 KbdControllerDriverStop (
461 IN EFI_DRIVER_BINDING_PROTOCOL *This,
462 IN EFI_HANDLE Controller,
463 IN UINTN NumberOfChildren,
464 IN EFI_HANDLE *ChildHandleBuffer
465 )
466 {
467 EFI_STATUS Status;
468 EFI_SIMPLE_TEXT_INPUT_PROTOCOL *ConIn;
469 KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;
470 UINT8 Data;
471
472 //
473 // Disable Keyboard
474 //
475 Status = gBS->OpenProtocol (
476 Controller,
477 &gEfiSimpleTextInProtocolGuid,
478 (VOID **) &ConIn,
479 This->DriverBindingHandle,
480 Controller,
481 EFI_OPEN_PROTOCOL_GET_PROTOCOL
482 );
483 if (EFI_ERROR (Status)) {
484 return Status;
485 }
486 Status = gBS->OpenProtocol (
487 Controller,
488 &gEfiSimpleTextInputExProtocolGuid,
489 NULL,
490 This->DriverBindingHandle,
491 Controller,
492 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
493 );
494 if (EFI_ERROR (Status)) {
495 return Status;
496 }
497
498 ConsoleIn = KEYBOARD_CONSOLE_IN_DEV_FROM_THIS (ConIn);
499
500 //
501 // Report that the keyboard is being disabled
502 //
503 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
504 EFI_PROGRESS_CODE,
505 EFI_PERIPHERAL_KEYBOARD | EFI_P_PC_DISABLE,
506 ConsoleIn->DevicePath
507 );
508
509 if (ConsoleIn->TimerEvent != NULL) {
510 gBS->CloseEvent (ConsoleIn->TimerEvent);
511 ConsoleIn->TimerEvent = NULL;
512 }
513
514 //
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
517 //
518 Status = EFI_SUCCESS;
519 while (!EFI_ERROR (Status)) {
520 Status = KeyboardRead (ConsoleIn, &Data);;
521 }
522 //
523 // Uninstall the SimpleTextIn and SimpleTextInEx protocols
524 //
525 Status = gBS->UninstallMultipleProtocolInterfaces (
526 Controller,
527 &gEfiSimpleTextInProtocolGuid,
528 &ConsoleIn->ConIn,
529 &gEfiSimpleTextInputExProtocolGuid,
530 &ConsoleIn->ConInEx,
531 NULL
532 );
533 if (EFI_ERROR (Status)) {
534 return Status;
535 }
536
537 gBS->CloseProtocol (
538 Controller,
539 &gEfiDevicePathProtocolGuid,
540 This->DriverBindingHandle,
541 Controller
542 );
543
544 gBS->CloseProtocol (
545 Controller,
546 &gEfiIsaIoProtocolGuid,
547 This->DriverBindingHandle,
548 Controller
549 );
550
551 //
552 // Free other resources
553 //
554 if ((ConsoleIn->ConIn).WaitForKey != NULL) {
555 gBS->CloseEvent ((ConsoleIn->ConIn).WaitForKey);
556 (ConsoleIn->ConIn).WaitForKey = NULL;
557 }
558 if (ConsoleIn->ConInEx.WaitForKeyEx != NULL) {
559 gBS->CloseEvent (ConsoleIn->ConInEx.WaitForKeyEx);
560 ConsoleIn->ConInEx.WaitForKeyEx = NULL;
561 }
562 KbdFreeNotifyList (&ConsoleIn->NotifyList);
563 FreeUnicodeStringTable (ConsoleIn->ControllerNameTable);
564 gBS->FreePool (ConsoleIn);
565
566 return EFI_SUCCESS;
567 }
568
569 /**
570 Free the waiting key notify list.
571
572 @param ListHead Pointer to list head
573
574 @retval EFI_INVALID_PARAMETER ListHead is NULL
575 @retval EFI_SUCCESS Sucess to free NotifyList
576 **/
577 EFI_STATUS
578 KbdFreeNotifyList (
579 IN OUT LIST_ENTRY *ListHead
580 )
581 {
582 KEYBOARD_CONSOLE_IN_EX_NOTIFY *NotifyNode;
583
584 if (ListHead == NULL) {
585 return EFI_INVALID_PARAMETER;
586 }
587 while (!IsListEmpty (ListHead)) {
588 NotifyNode = CR (
589 ListHead->ForwardLink,
590 KEYBOARD_CONSOLE_IN_EX_NOTIFY,
591 NotifyEntry,
592 KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE
593 );
594 RemoveEntryList (ListHead->ForwardLink);
595 gBS->FreePool (NotifyNode);
596 }
597
598 return EFI_SUCCESS;
599 }
600
601 /**
602 The module Entry Point for module Ps2Keyboard.
603
604 @param[in] ImageHandle The firmware allocated handle for the EFI image.
605 @param[in] SystemTable A pointer to the EFI System Table.
606
607 @retval EFI_SUCCESS The entry point is executed successfully.
608 @retval other Some error occurs when executing this entry point.
609
610 **/
611 EFI_STATUS
612 EFIAPI
613 InitializePs2Keyboard(
614 IN EFI_HANDLE ImageHandle,
615 IN EFI_SYSTEM_TABLE *SystemTable
616 )
617 {
618 EFI_STATUS Status;
619
620 //
621 // Install driver model protocol(s).
622 //
623 Status = EfiLibInstallDriverBindingComponentName2 (
624 ImageHandle,
625 SystemTable,
626 &gKeyboardControllerDriver,
627 ImageHandle,
628 &gPs2KeyboardComponentName,
629 &gPs2KeyboardComponentName2
630 );
631 ASSERT_EFI_ERROR (Status);
632
633
634 return Status;
635 }
636