]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdCtrller.c
Change functional static variable to Global variable. No STATIC modifier is recommend...
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / Ps2KeyboardDxe / Ps2KbdCtrller.c
CommitLineData
05fbd06d 1/**@file\r
2 PS/2 Keyboard driver\r
3 Routines that access 8042 keyboard controller\r
4\r
df0dcb5e 5Copyright (c) 2006 - 2007, Intel Corporation\r
6All rights reserved. This program and the accompanying materials\r
7are licensed and made available under the terms and conditions of the BSD License\r
8which accompanies this distribution. The full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
05fbd06d 13\r
14**/\r
15\r
05fbd06d 16#include "Ps2Keyboard.h"\r
17\r
18//\r
19// Function declarations\r
20//\r
05fbd06d 21UINT8\r
22KeyReadDataRegister (\r
23 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
24 );\r
25\r
05fbd06d 26VOID\r
27KeyWriteDataRegister (\r
28 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
29 IN UINT8 Data\r
30 );\r
31\r
05fbd06d 32VOID\r
33KeyWriteCommandRegister (\r
34 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
35 IN UINT8 Data\r
36 );\r
37\r
05fbd06d 38VOID\r
39KeyboardError (\r
40 IN KEYBOARD_CONSOLE_IN_DEV*ConsoleIn,\r
41 IN CHAR16 *ErrMsg // should be a unicode string\r
42 );\r
43\r
05fbd06d 44EFI_STATUS\r
45GetScancodeBufHead (\r
46 KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
47 IN UINT32 Count,\r
48 OUT UINT8 *Buf\r
49 );\r
50\r
05fbd06d 51EFI_STATUS\r
52PopScancodeBufHead (\r
53 KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
54 IN UINT32 Count,\r
55 OUT UINT8 *Buf\r
56 );\r
57\r
05fbd06d 58EFI_STATUS\r
59KeyboardWrite (\r
60 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
61 IN UINT8 Data\r
62 );\r
63\r
05fbd06d 64EFI_STATUS\r
65KeyboardCommand (\r
66 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
67 IN UINT8 Data\r
68 );\r
69\r
05fbd06d 70EFI_STATUS\r
71KeyboardWaitForValue (\r
72 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
73 IN UINT8 Value\r
74 );\r
75\r
819d1488 76struct {\r
05fbd06d 77 UINT8 ScanCode;\r
78 UINT16 EfiScanCode;\r
79 CHAR16 UnicodeChar;\r
80 CHAR16 ShiftUnicodeChar;\r
81}\r
82ConvertKeyboardScanCodeToEfiKey[] = {\r
83\r
84 {\r
85 0x01, // Escape\r
86 SCAN_ESC,\r
87 0x00,\r
88 0x00\r
89 },\r
90 {\r
91 0x02,\r
92 SCAN_NULL,\r
93 '1',\r
94 '!'\r
95 },\r
96 {\r
97 0x03,\r
98 SCAN_NULL,\r
99 '2',\r
100 '@'\r
101 },\r
102 {\r
103 0x04,\r
104 SCAN_NULL,\r
105 '3',\r
106 '#'\r
107 },\r
108 {\r
109 0x05,\r
110 SCAN_NULL,\r
111 '4',\r
112 '$'\r
113 },\r
114 {\r
115 0x06,\r
116 SCAN_NULL,\r
117 '5',\r
118 '%'\r
119 },\r
120 {\r
121 0x07,\r
122 SCAN_NULL,\r
123 '6',\r
124 '^'\r
125 },\r
126 {\r
127 0x08,\r
128 SCAN_NULL,\r
129 '7',\r
130 '&'\r
131 },\r
132 {\r
133 0x09,\r
134 SCAN_NULL,\r
135 '8',\r
136 '*'\r
137 },\r
138 {\r
139 0x0A,\r
140 SCAN_NULL,\r
141 '9',\r
142 '('\r
143 },\r
144 {\r
145 0x0B,\r
146 SCAN_NULL,\r
147 '0',\r
148 ')'\r
149 },\r
150 {\r
151 0x0C,\r
152 SCAN_NULL,\r
153 '-',\r
154 '_'\r
155 },\r
156 {\r
157 0x0D,\r
158 SCAN_NULL,\r
159 '=',\r
160 '+'\r
161 },\r
162 {\r
163 0x0E, // BackSpace\r
164 SCAN_NULL,\r
165 0x08,\r
166 0x08\r
167 },\r
168 {\r
169 0x0F, // Tab\r
170 SCAN_NULL,\r
171 0x09,\r
172 0x09\r
173 },\r
174 {\r
175 0x10,\r
176 SCAN_NULL,\r
177 'q',\r
178 'Q'\r
179 },\r
180 {\r
181 0x11,\r
182 SCAN_NULL,\r
183 'w',\r
184 'W'\r
185 },\r
186 {\r
187 0x12,\r
188 SCAN_NULL,\r
189 'e',\r
190 'E'\r
191 },\r
192 {\r
193 0x13,\r
194 SCAN_NULL,\r
195 'r',\r
196 'R'\r
197 },\r
198 {\r
199 0x14,\r
200 SCAN_NULL,\r
201 't',\r
202 'T'\r
203 },\r
204 {\r
205 0x15,\r
206 SCAN_NULL,\r
207 'y',\r
208 'Y'\r
209 },\r
210 {\r
211 0x16,\r
212 SCAN_NULL,\r
213 'u',\r
214 'U'\r
215 },\r
216 {\r
217 0x17,\r
218 SCAN_NULL,\r
219 'i',\r
220 'I'\r
221 },\r
222 {\r
223 0x18,\r
224 SCAN_NULL,\r
225 'o',\r
226 'O'\r
227 },\r
228 {\r
229 0x19,\r
230 SCAN_NULL,\r
231 'p',\r
232 'P'\r
233 },\r
234 {\r
235 0x1a,\r
236 SCAN_NULL,\r
237 '[',\r
238 '{'\r
239 },\r
240 {\r
241 0x1b,\r
242 SCAN_NULL,\r
243 ']',\r
244 '}'\r
245 },\r
246 {\r
247 0x1c, // Enter\r
248 SCAN_NULL,\r
249 0x0d,\r
250 0x0d\r
251 },\r
252 {\r
253 0x1d,\r
254 SCAN_NULL,\r
255 0x00,\r
256 0x00\r
257 },\r
258 {\r
259 0x1e,\r
260 SCAN_NULL,\r
261 'a',\r
262 'A'\r
263 },\r
264 {\r
265 0x1f,\r
266 SCAN_NULL,\r
267 's',\r
268 'S'\r
269 },\r
270 {\r
271 0x20,\r
272 SCAN_NULL,\r
273 'd',\r
274 'D'\r
275 },\r
276 {\r
277 0x21,\r
278 SCAN_NULL,\r
279 'f',\r
280 'F'\r
281 },\r
282 {\r
283 0x22,\r
284 SCAN_NULL,\r
285 'g',\r
286 'G'\r
287 },\r
288 {\r
289 0x23,\r
290 SCAN_NULL,\r
291 'h',\r
292 'H'\r
293 },\r
294 {\r
295 0x24,\r
296 SCAN_NULL,\r
297 'j',\r
298 'J'\r
299 },\r
300 {\r
301 0x25,\r
302 SCAN_NULL,\r
303 'k',\r
304 'K'\r
305 },\r
306 {\r
307 0x26,\r
308 SCAN_NULL,\r
309 'l',\r
310 'L'\r
311 },\r
312 {\r
313 0x27,\r
314 SCAN_NULL,\r
315 ';',\r
316 ':'\r
317 },\r
318 {\r
319 0x28,\r
320 SCAN_NULL,\r
321 '\'',\r
322 '"'\r
323 },\r
324 {\r
325 0x29,\r
326 SCAN_NULL,\r
327 '`',\r
328 '~'\r
329 },\r
330 {\r
331 0x2a, // Left Shift\r
332 SCAN_NULL,\r
333 0x00,\r
334 0x00\r
335 },\r
336 {\r
337 0x2b,\r
338 SCAN_NULL,\r
339 '\\',\r
340 '|'\r
341 },\r
342 {\r
343 0x2c,\r
344 SCAN_NULL,\r
345 'z',\r
346 'Z'\r
347 },\r
348 {\r
349 0x2d,\r
350 SCAN_NULL,\r
351 'x',\r
352 'X'\r
353 },\r
354 {\r
355 0x2e,\r
356 SCAN_NULL,\r
357 'c',\r
358 'C'\r
359 },\r
360 {\r
361 0x2f,\r
362 SCAN_NULL,\r
363 'v',\r
364 'V'\r
365 },\r
366 {\r
367 0x30,\r
368 SCAN_NULL,\r
369 'b',\r
370 'B'\r
371 },\r
372 {\r
373 0x31,\r
374 SCAN_NULL,\r
375 'n',\r
376 'N'\r
377 },\r
378 {\r
379 0x32,\r
380 SCAN_NULL,\r
381 'm',\r
382 'M'\r
383 },\r
384 {\r
385 0x33,\r
386 SCAN_NULL,\r
387 ',',\r
388 '<'\r
389 },\r
390 {\r
391 0x34,\r
392 SCAN_NULL,\r
393 '.',\r
394 '>'\r
395 },\r
396 {\r
397 0x35,\r
398 SCAN_NULL,\r
399 '/',\r
400 '?'\r
401 },\r
402 {\r
403 0x36, //Right Shift\r
404 SCAN_NULL,\r
405 0x00,\r
406 0x00\r
407 },\r
408 {\r
409 0x37, // Numeric Keypad *\r
410 SCAN_NULL,\r
411 '*',\r
412 '*'\r
413 },\r
414 {\r
415 0x38, //Left Alt/Extended Right Alt\r
416 SCAN_NULL,\r
417 0x00,\r
418 0x00\r
419 },\r
420 {\r
421 0x39,\r
422 SCAN_NULL,\r
423 ' ',\r
424 ' '\r
425 },\r
426 {\r
427 0x3A, //CapsLock\r
428 SCAN_NULL,\r
429 0x00,\r
430 0x00\r
431 },\r
432 {\r
433 0x3B,\r
434 SCAN_F1,\r
435 0x00,\r
436 0x00\r
437 },\r
438 {\r
439 0x3C,\r
440 SCAN_F2,\r
441 0x00,\r
442 0x00\r
443 },\r
444 {\r
445 0x3D,\r
446 SCAN_F3,\r
447 0x00,\r
448 0x00\r
449 },\r
450 {\r
451 0x3E,\r
452 SCAN_F4,\r
453 0x00,\r
454 0x00\r
455 },\r
456 {\r
457 0x3F,\r
458 SCAN_F5,\r
459 0x00,\r
460 0x00\r
461 },\r
462 {\r
463 0x40,\r
464 SCAN_F6,\r
465 0x00,\r
466 0x00\r
467 },\r
468 {\r
469 0x41,\r
470 SCAN_F7,\r
471 0x00,\r
472 0x00\r
473 },\r
474 {\r
475 0x42,\r
476 SCAN_F8,\r
477 0x00,\r
478 0x00\r
479 },\r
480 {\r
481 0x43,\r
482 SCAN_F9,\r
483 0x00,\r
484 0x00\r
485 },\r
486 {\r
487 0x44,\r
488 SCAN_F10,\r
489 0x00,\r
490 0x00\r
491 },\r
492 {\r
493 0x45, // NumLock\r
494 SCAN_NULL,\r
495 0x00,\r
496 0x00\r
497 },\r
498 {\r
499 0x46, // ScrollLock\r
500 SCAN_NULL,\r
501 0x00,\r
502 0x00\r
503 },\r
504 {\r
505 0x47,\r
506 SCAN_HOME,\r
507 '7',\r
508 '7'\r
509 },\r
510 {\r
511 0x48,\r
512 SCAN_UP,\r
513 '8',\r
514 '8'\r
515 },\r
516 {\r
517 0x49,\r
518 SCAN_PAGE_UP,\r
519 '9',\r
520 '9'\r
521 },\r
522 {\r
523 0x4a,\r
524 SCAN_NULL,\r
525 '-',\r
526 '-'\r
527 },\r
528 {\r
529 0x4b,\r
530 SCAN_LEFT,\r
531 '4',\r
532 '4'\r
533 },\r
534 {\r
535 0x4c, // Numeric Keypad 5\r
536 SCAN_NULL,\r
537 '5',\r
538 '5'\r
539 },\r
540 {\r
541 0x4d,\r
542 SCAN_RIGHT,\r
543 '6',\r
544 '6'\r
545 },\r
546 {\r
547 0x4e,\r
548 SCAN_NULL,\r
549 '+',\r
550 '+'\r
551 },\r
552 {\r
553 0x4f,\r
554 SCAN_END,\r
555 '1',\r
556 '1'\r
557 },\r
558 {\r
559 0x50,\r
560 SCAN_DOWN,\r
561 '2',\r
562 '2'\r
563 },\r
564 {\r
565 0x51,\r
566 SCAN_PAGE_DOWN,\r
567 '3',\r
568 '3'\r
569 },\r
570 {\r
571 0x52,\r
572 SCAN_INSERT,\r
573 '0',\r
574 '0'\r
575 },\r
576 {\r
577 0x53,\r
578 SCAN_DELETE,\r
579 '.',\r
580 '.'\r
581 },\r
582 {\r
583 0x57,\r
584 SCAN_F11,\r
585 0x00,\r
586 0x00\r
587 },\r
588 {\r
589 0x58,\r
590 SCAN_F12,\r
591 0x00,\r
592 0x00\r
593 },\r
f3d1e940 594 {\r
595 0x5B, //Left LOGO\r
596 SCAN_NULL,\r
597 0x00,\r
598 0x00\r
599 }, \r
600 {\r
601 0x5C, //Right LOGO\r
602 SCAN_NULL,\r
603 0x00,\r
604 0x00\r
605 }, \r
606 {\r
607 0x5D, //Menu key\r
608 SCAN_NULL,\r
609 0x00,\r
610 0x00\r
611 }, \r
05fbd06d 612 {\r
613 TABLE_END,\r
614 TABLE_END,\r
615 SCAN_NULL,\r
616 SCAN_NULL\r
617 },\r
618};\r
619\r
620\r
621//\r
622// The WaitForValue time out\r
623//\r
819d1488 624UINTN mWaitForValueTimeOut = KEYBOARD_WAITFORVALUE_TIMEOUT;\r
05fbd06d 625\r
4fd730b3 626BOOLEAN mEnableMouseInterface;\r
627\r
bcd70414 628/**\r
629 Read data register \r
630\r
631 @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
632\r
633 @return return the value \r
634\r
635**/\r
05fbd06d 636UINT8\r
637KeyReadDataRegister (\r
638 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
639 )\r
05fbd06d 640\r
05fbd06d 641{\r
642 EFI_ISA_IO_PROTOCOL *IsaIo;\r
643 UINT8 Data;\r
644\r
645 //\r
646 // Use IsaIo protocol to perform IO operations\r
647 //\r
648 IsaIo = ConsoleIn->IsaIo;\r
649\r
650 IsaIo->Io.Read (\r
651 IsaIo,\r
652 EfiIsaIoWidthUint8,\r
653 ConsoleIn->DataRegisterAddress,\r
654 1,\r
655 &Data\r
656 );\r
657\r
658 return Data;\r
659}\r
660\r
bcd70414 661/**\r
662 Write data register\r
663\r
664 @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
665 @param Data value wanted to be written\r
666\r
667**/\r
05fbd06d 668VOID\r
669KeyWriteDataRegister (\r
670 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
671 IN UINT8 Data\r
672 )\r
05fbd06d 673\r
05fbd06d 674{\r
675 EFI_ISA_IO_PROTOCOL *IsaIo;\r
676\r
677 //\r
678 // Use IsaIo protocol to perform IO operations\r
679 //\r
680 IsaIo = ConsoleIn->IsaIo;\r
681\r
682 IsaIo->Io.Write (\r
683 IsaIo,\r
684 EfiIsaIoWidthUint8,\r
685 ConsoleIn->DataRegisterAddress,\r
686 1,\r
687 &Data\r
688 );\r
689\r
690 //\r
691 // outp(ConsoleIn->DataRegisterAddress, Data);\r
692 //\r
693}\r
694\r
bcd70414 695/**\r
696 Read status register\r
697\r
698 @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
699\r
700 @return value in status register\r
701\r
702**/\r
05fbd06d 703UINT8\r
704KeyReadStatusRegister (\r
705 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
706 )\r
05fbd06d 707{\r
708 EFI_ISA_IO_PROTOCOL *IsaIo;\r
709 UINT8 Data;\r
710\r
711 //\r
712 // Use IsaIo protocol to perform IO operations\r
713 //\r
714 IsaIo = ConsoleIn->IsaIo;\r
715\r
716 IsaIo->Io.Read (\r
717 IsaIo,\r
718 EfiIsaIoWidthUint8,\r
719 ConsoleIn->StatusRegisterAddress,\r
720 1,\r
721 &Data\r
722 );\r
723\r
724 return Data;\r
725\r
726}\r
727\r
bcd70414 728/**\r
729 Write command register \r
730\r
731 @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
732 @param Data The value wanted to be written\r
733\r
734**/\r
735\r
05fbd06d 736VOID\r
737KeyWriteCommandRegister (\r
738 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
739 IN UINT8 Data\r
740 )\r
05fbd06d 741{\r
742 EFI_ISA_IO_PROTOCOL *IsaIo;\r
743\r
744 //\r
745 // Use IsaIo protocol to perform IO operations\r
746 //\r
747 IsaIo = ConsoleIn->IsaIo;\r
748\r
749 IsaIo->Io.Write (\r
750 IsaIo,\r
751 EfiIsaIoWidthUint8,\r
752 ConsoleIn->CommandRegisterAddress,\r
753 1,\r
754 &Data\r
755 );\r
756\r
757}\r
758\r
bcd70414 759/**\r
760 Display error message\r
761\r
762 @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
763 @param ErrMsg Unicode string of error message\r
764 \r
765**/\r
05fbd06d 766VOID\r
767KeyboardError (\r
768 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
769 IN CHAR16 *ErrMsg\r
770 )\r
05fbd06d 771{\r
772 ConsoleIn->KeyboardErr = TRUE;\r
773\r
774 //\r
775 // gST -> ConOut -> OutputString (gST -> ConOut, L"Keyboard Driver: ");\r
776 // gST -> ConOut -> OutputString (gST -> ConOut, ErrMsg);\r
777 //\r
778}\r
779\r
bcd70414 780/**\r
05fbd06d 781 Timer event handler: read a series of scancodes from 8042\r
782 and put them into memory scancode buffer.\r
783 it read as much scancodes to either fill\r
784 the memory buffer or empty the keyboard buffer.\r
785 It is registered as running under TPL_NOTIFY\r
786\r
bcd70414 787 @param Event - The timer event\r
788 @param Context - A KEYBOARD_CONSOLE_IN_DEV pointer\r
05fbd06d 789\r
bcd70414 790**/\r
791VOID\r
792EFIAPI\r
793KeyboardTimerHandler (\r
794 IN EFI_EVENT Event,\r
795 IN VOID *Context\r
796 )\r
05fbd06d 797\r
05fbd06d 798{\r
799 UINT8 Data;\r
800 EFI_TPL OldTpl;\r
801 KEYBOARD_CONSOLE_IN_DEV *ConsoleIn;\r
802\r
803 ConsoleIn = Context;\r
804\r
805 //\r
806 // Enter critical section\r
807 //\r
808 OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
809\r
810 if (((KEYBOARD_CONSOLE_IN_DEV *) Context)->KeyboardErr) {\r
811 //\r
812 // Leave critical section and return\r
813 //\r
814 gBS->RestoreTPL (OldTpl);\r
815 return ;\r
816 }\r
817 //\r
818 // To let KB driver support Hot plug, here should skip the 'resend' command for the case that\r
819 // KB is not connected to system. If KB is not connected to system, driver will find there's something\r
820 // error in the following code and wait for the input buffer empty, this waiting time shoulb be short enough since\r
821 // this is a NOTIFY TPL period function, or the system performance will degrade hardly when KB is not connected.\r
822 // Just skip the 'resend' process simply.\r
823 //\r
824\r
825 Data = 0;\r
826\r
827 //\r
828 // if there is no key present, just return\r
829 //\r
830 if ((KeyReadStatusRegister (Context) & 0x21) != 0x1) {\r
831 //\r
832 // Leave critical section and return\r
833 //\r
834 gBS->RestoreTPL (OldTpl);\r
835\r
836 return ;\r
837 }\r
838 //\r
839 // Read one byte of the scan code and store it into the memory buffer\r
840 //\r
841 if (ConsoleIn->ScancodeBufCount < KEYBOARD_BUFFER_MAX_COUNT) {\r
842\r
843 Data = KeyReadDataRegister (Context);\r
844 //\r
845 // put the scancode into the memory scancode buffer\r
846 //\r
847 ConsoleIn->ScancodeBufCount++;\r
848 ConsoleIn->ScancodeBufEndPos++;\r
849 if (ConsoleIn->ScancodeBufEndPos >= KEYBOARD_BUFFER_MAX_COUNT) {\r
850 ConsoleIn->ScancodeBufEndPos = 0;\r
851 }\r
852\r
853 ConsoleIn->ScancodeBuf[ConsoleIn->ScancodeBufEndPos] = Data;\r
854\r
855 //\r
856 // Handle Alt+Ctrl+Del Key combination\r
857 //\r
858 switch (Data) {\r
859 case SCANCODE_CTRL_MAKE:\r
860 ConsoleIn->Ctrled = TRUE;\r
861 break;\r
862\r
863 case SCANCODE_CTRL_BREAK:\r
864 ConsoleIn->Ctrled = FALSE;\r
865 break;\r
866\r
867 case SCANCODE_ALT_MAKE:\r
868 ConsoleIn->Alted = TRUE;\r
869 break;\r
870\r
871 case SCANCODE_ALT_BREAK:\r
872 ConsoleIn->Alted = FALSE;\r
873 break;\r
874 }\r
875 //\r
876 // if Alt+Ctrl+Del, Reboot the System\r
877 //\r
878 if (ConsoleIn->Ctrled && ConsoleIn->Alted && Data == 0x53) {\r
879 gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
880 }\r
881 }\r
882 //\r
883 // Leave critical section and return\r
884 //\r
885 gBS->RestoreTPL (OldTpl);\r
886\r
887 return ;\r
888}\r
889\r
bcd70414 890/**\r
891 Read several bytes from the scancode buffer without removing them.\r
892 This function is called to see if there are enough bytes of scancode\r
893 representing a single key.\r
894\r
895 @param Count - Number of bytes to be read\r
896 @param Buf - Store the results\r
897\r
898 @retval EFI_SUCCESS success to scan the keyboard code\r
899 @retval EFI_NOT_READY invalid parameter\r
900**/\r
05fbd06d 901EFI_STATUS\r
902GetScancodeBufHead (\r
903 KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
904 IN UINT32 Count,\r
905 OUT UINT8 *Buf\r
906 )\r
05fbd06d 907{\r
908 UINT32 Index;\r
909 UINT32 Pos;\r
910\r
911 Index = 0;\r
912 Pos = 0;\r
913\r
914 //\r
915 // check the valid range of parameter 'Count'\r
916 //\r
917 if (Count <= 0 || ConsoleIn->ScancodeBufCount < Count) {\r
918 return EFI_NOT_READY;\r
919 }\r
920 //\r
921 // retrieve the values\r
922 //\r
923 for (Index = 0; Index < Count; Index++) {\r
924\r
925 if (Index == 0) {\r
926\r
927 Pos = ConsoleIn->ScancodeBufStartPos;\r
928 } else {\r
929\r
930 Pos = Pos + 1;\r
931 if (Pos >= KEYBOARD_BUFFER_MAX_COUNT) {\r
932 Pos = 0;\r
933 }\r
934 }\r
935\r
936 Buf[Index] = ConsoleIn->ScancodeBuf[Pos];\r
937 }\r
938\r
939 return EFI_SUCCESS;\r
940}\r
941\r
bcd70414 942/**\r
943\r
944 Read & remove several bytes from the scancode buffer.\r
945 This function is usually called after GetScancodeBufHead()\r
946\r
947 @param Count - Number of bytes to be read\r
948 @param Buf - Store the results\r
949\r
950 @retval EFI_SUCCESS success to scan the keyboard code\r
951 @retval EFI_NOT_READY invalid parameter\r
952**/\r
05fbd06d 953EFI_STATUS\r
954PopScancodeBufHead (\r
955 KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
956 IN UINT32 Count,\r
957 OUT UINT8 *Buf\r
958 )\r
05fbd06d 959{\r
960 UINT32 Index;\r
961\r
962 Index = 0;\r
963\r
964 //\r
965 // Check the valid range of parameter 'Count'\r
966 //\r
967 if (Count <= 0 || ConsoleIn->ScancodeBufCount < Count) {\r
968 return EFI_NOT_READY;\r
969 }\r
970 //\r
971 // Retrieve and remove the values\r
972 //\r
973 for (Index = 0; Index < Count; Index++) {\r
974\r
975 if (Index != 0) {\r
976\r
977 ConsoleIn->ScancodeBufStartPos++;\r
978 if (ConsoleIn->ScancodeBufStartPos >= KEYBOARD_BUFFER_MAX_COUNT) {\r
979 ConsoleIn->ScancodeBufStartPos = 0;\r
980 }\r
981 }\r
982\r
983 Buf[Index] = ConsoleIn->ScancodeBuf[ConsoleIn->ScancodeBufStartPos];\r
984 ConsoleIn->ScancodeBufCount--;\r
985 }\r
986\r
987 ConsoleIn->ScancodeBufStartPos++;\r
988 if (ConsoleIn->ScancodeBufStartPos >= KEYBOARD_BUFFER_MAX_COUNT) {\r
989 ConsoleIn->ScancodeBufStartPos = 0;\r
990 }\r
991\r
992 return EFI_SUCCESS;\r
993}\r
994\r
bcd70414 995/**\r
996 Read key value \r
997\r
998 @param ConsoleIn - Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
999 @param Data - Pointer to outof buffer for keeping key value\r
1000\r
1001 @retval EFI_TIMEOUT Status resigter time out\r
1002 @retval EFI_SUCCESS Success to read keyboard\r
1003\r
1004**/\r
05fbd06d 1005EFI_STATUS\r
1006KeyboardRead (\r
1007 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
1008 OUT UINT8 *Data\r
1009 )\r
05fbd06d 1010\r
05fbd06d 1011{\r
1012 UINT32 TimeOut;\r
1013 UINT32 RegFilled;\r
1014\r
1015 TimeOut = 0;\r
1016 RegFilled = 0;\r
1017\r
1018 //\r
1019 // wait till output buffer full then perform the read\r
1020 //\r
1021 for (TimeOut = 0; TimeOut < KEYBOARD_TIMEOUT; TimeOut += 30) {\r
1022 if (KeyReadStatusRegister (ConsoleIn) & 0x01) {\r
1023 RegFilled = 1;\r
1024 *Data = KeyReadDataRegister (ConsoleIn);\r
1025 break;\r
1026 }\r
1027\r
1028 gBS->Stall (30);\r
1029 }\r
1030\r
1031 if (!RegFilled) {\r
1032 return EFI_TIMEOUT;\r
1033 }\r
1034\r
1035 return EFI_SUCCESS;\r
1036}\r
1037\r
bcd70414 1038/**\r
1039 write key to keyboard\r
1040\r
1041 @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
1042 @param Data value wanted to be written\r
1043\r
1044 @retval EFI_TIMEOUT - GC_TODO: Add description for return value\r
1045 @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
1046\r
1047**/\r
05fbd06d 1048EFI_STATUS\r
1049KeyboardWrite (\r
1050 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
1051 IN UINT8 Data\r
1052 )\r
05fbd06d 1053{\r
1054 UINT32 TimeOut;\r
1055 UINT32 RegEmptied;\r
1056\r
1057 TimeOut = 0;\r
1058 RegEmptied = 0;\r
1059\r
1060 //\r
1061 // wait for input buffer empty\r
1062 //\r
1063 for (TimeOut = 0; TimeOut < KEYBOARD_TIMEOUT; TimeOut += 30) {\r
1064 if (!(KeyReadStatusRegister (ConsoleIn) & 0x02)) {\r
1065 RegEmptied = 1;\r
1066 break;\r
1067 }\r
1068\r
1069 gBS->Stall (30);\r
1070 }\r
1071\r
1072 if (!RegEmptied) {\r
1073 return EFI_TIMEOUT;\r
1074 }\r
1075 //\r
1076 // Write it\r
1077 //\r
1078 KeyWriteDataRegister (ConsoleIn, Data);\r
1079\r
1080 return EFI_SUCCESS;\r
1081}\r
1082\r
bcd70414 1083/**\r
1084 Issue keyboard command\r
1085\r
1086 @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
1087 @param Data The buff holding the command \r
1088\r
1089 @retval EFI_TIMEOUT Keyboard is not ready to issuing \r
1090 @retval EFI_SUCCESS Success to issue keyboard command\r
1091\r
1092**/\r
05fbd06d 1093EFI_STATUS\r
1094KeyboardCommand (\r
1095 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
1096 IN UINT8 Data\r
1097 )\r
05fbd06d 1098{\r
1099 UINT32 TimeOut;\r
1100 UINT32 RegEmptied;\r
1101\r
1102 TimeOut = 0;\r
1103 RegEmptied = 0;\r
1104\r
1105 //\r
1106 // Wait For Input Buffer Empty\r
1107 //\r
1108 for (TimeOut = 0; TimeOut < KEYBOARD_TIMEOUT; TimeOut += 30) {\r
1109 if (!(KeyReadStatusRegister (ConsoleIn) & 0x02)) {\r
1110 RegEmptied = 1;\r
1111 break;\r
1112 }\r
1113\r
1114 gBS->Stall (30);\r
1115 }\r
1116\r
1117 if (!RegEmptied) {\r
1118 return EFI_TIMEOUT;\r
1119 }\r
1120 //\r
1121 // issue the command\r
1122 //\r
1123 KeyWriteCommandRegister (ConsoleIn, Data);\r
1124\r
1125 //\r
1126 // Wait For Input Buffer Empty again\r
1127 //\r
1128 RegEmptied = 0;\r
1129 for (TimeOut = 0; TimeOut < KEYBOARD_TIMEOUT; TimeOut += 30) {\r
1130 if (!(KeyReadStatusRegister (ConsoleIn) & 0x02)) {\r
1131 RegEmptied = 1;\r
1132 break;\r
1133 }\r
1134\r
1135 gBS->Stall (30);\r
1136 }\r
1137\r
1138 if (!RegEmptied) {\r
1139 return EFI_TIMEOUT;\r
1140 }\r
1141\r
1142 return EFI_SUCCESS;\r
1143}\r
1144\r
bcd70414 1145/**\r
1146 wait for a specific value to be presented on\r
1147 8042 Data register by keyboard and then read it,\r
1148 used in keyboard commands ack\r
1149\r
1150 @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
1151 @param Value the value wanted to be waited.\r
1152\r
1153 @retval EFI_TIMEOUT Fail to get specific value in given time\r
1154 @retval EFI_SUCCESS Success to get specific value in given time.\r
1155 \r
1156**/\r
05fbd06d 1157EFI_STATUS\r
1158KeyboardWaitForValue (\r
1159 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
1160 IN UINT8 Value\r
1161 )\r
05fbd06d 1162{\r
1163 UINT8 Data;\r
1164 UINT32 TimeOut;\r
1165 UINT32 SumTimeOut;\r
1166 UINT32 GotIt;\r
1167\r
1168 GotIt = 0;\r
1169 TimeOut = 0;\r
1170 SumTimeOut = 0;\r
1171\r
1172 //\r
1173 // Make sure the initial value of 'Data' is different from 'Value'\r
1174 //\r
1175 Data = 0;\r
1176 if (Data == Value) {\r
1177 Data = 1;\r
1178 }\r
1179 //\r
1180 // Read from 8042 (multiple times if needed)\r
1181 // until the expected value appears\r
1182 // use SumTimeOut to control the iteration\r
1183 //\r
1184 while (1) {\r
1185 //\r
1186 // Perform a read\r
1187 //\r
1188 for (TimeOut = 0; TimeOut < KEYBOARD_TIMEOUT; TimeOut += 30) {\r
1189 if (KeyReadStatusRegister (ConsoleIn) & 0x01) {\r
1190 Data = KeyReadDataRegister (ConsoleIn);\r
1191 break;\r
1192 }\r
1193\r
1194 gBS->Stall (30);\r
1195 }\r
1196\r
1197 SumTimeOut += TimeOut;\r
1198\r
1199 if (Data == Value) {\r
1200 GotIt = 1;\r
1201 break;\r
1202 }\r
1203\r
1204 if (SumTimeOut >= mWaitForValueTimeOut) {\r
1205 break;\r
1206 }\r
1207 }\r
1208 //\r
1209 // Check results\r
1210 //\r
1211 if (GotIt) {\r
1212 return EFI_SUCCESS;\r
1213 } else {\r
1214 return EFI_TIMEOUT;\r
1215 }\r
1216\r
1217}\r
1218\r
bcd70414 1219/**\r
05fbd06d 1220 Show keyboard status lights according to\r
1221 indicators in ConsoleIn.\r
1222\r
bcd70414 1223 @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
1224 \r
1225 @return status\r
05fbd06d 1226\r
bcd70414 1227**/\r
1228EFI_STATUS\r
1229UpdateStatusLights (\r
1230 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
1231 )\r
05fbd06d 1232{\r
1233 EFI_STATUS Status;\r
1234 UINT8 Command;\r
1235\r
1236 //\r
1237 // Send keyboard command\r
1238 //\r
1239 Status = KeyboardWrite (ConsoleIn, 0xed);\r
1240 if (EFI_ERROR (Status)) {\r
1241 return Status;\r
1242 }\r
1243\r
1244 KeyboardWaitForValue (ConsoleIn, 0xfa);\r
1245\r
1246 //\r
1247 // Light configuration\r
1248 //\r
1249 Command = 0;\r
1250 if (ConsoleIn->CapsLock) {\r
1251 Command |= 4;\r
1252 }\r
1253\r
1254 if (ConsoleIn->NumLock) {\r
1255 Command |= 2;\r
1256 }\r
1257\r
1258 if (ConsoleIn->ScrollLock) {\r
1259 Command |= 1;\r
1260 }\r
1261\r
1262 Status = KeyboardWrite (ConsoleIn, Command);\r
1263\r
1264 if (EFI_ERROR (Status)) {\r
1265 return Status;\r
1266 }\r
1267\r
1268 KeyboardWaitForValue (ConsoleIn, 0xfa);\r
1269 return Status;\r
1270}\r
1271\r
bcd70414 1272/**\r
05fbd06d 1273 Get scancode from scancode buffer\r
1274 and translate into EFI-scancode and unicode defined by EFI spec\r
1275 The function is always called in TPL_NOTIFY\r
1276\r
bcd70414 1277 @param ConsoleIn KEYBOARD_CONSOLE_IN_DEV instance pointer\r
05fbd06d 1278\r
bcd70414 1279 @retval EFI_NOT_READY - Input from console not ready yet.\r
1280 @retval EFI_SUCCESS - Function executed successfully.\r
05fbd06d 1281\r
bcd70414 1282**/\r
1283EFI_STATUS\r
1284KeyGetchar (\r
1285 IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
1286 )\r
05fbd06d 1287{\r
1288 EFI_STATUS Status;\r
1289 UINT8 ScanCode;\r
1290 UINT8 Readed;\r
1291 BOOLEAN Extended;\r
1292 UINT8 ScancodeArr[4];\r
1293 UINTN Index;\r
1294 //\r
1295 // 4 bytes most\r
1296 //\r
1297 UINT32 ScancodeArrPos;\r
1298 //\r
1299 // point to the current position in ScancodeArr\r
1300 //\r
1301\r
1302 Readed = 0;\r
1303 Extended = FALSE;\r
1304 ScancodeArrPos = 0;\r
1305\r
1306 //\r
1307 // Read one byte of the scan code and store it into the memory buffer\r
1308 // This block of code is added to insert an action that is equivalent to\r
1309 // the timer event handling function, so as to increase the frequency of\r
1310 // detecting the availability of keys. Timer event has a max frequency of\r
1311 // 18Hz which is insufficient\r
1312 //\r
1313 //\r
1314 // To let KB driver support Hot plug, here should skip the 'resend' command for the case that\r
1315 // KB is not connected to system. If KB is not connected to system, driver will find there's something\r
1316 // error in the following code and wait for the input buffer empty, this waiting time shoulb be short enough since\r
1317 // this is a NOTIFY TPL period function, or the system performance will degrade hardly when KB is not connected.\r
1318 // Just skip the 'resend' process simply.\r
1319 //\r
1320\r
1321\r
1322 if (((KeyReadStatusRegister (ConsoleIn) & 0x21) == 0x1) && (ConsoleIn->ScancodeBufCount < KEYBOARD_BUFFER_MAX_COUNT)) {\r
1323\r
1324 Readed = KeyReadDataRegister (ConsoleIn);\r
1325 //\r
1326 // put the scancode into the memory scancode buffer\r
1327 //\r
1328 ConsoleIn->ScancodeBufCount++;\r
1329 ConsoleIn->ScancodeBufEndPos++;\r
1330 if (ConsoleIn->ScancodeBufEndPos >= KEYBOARD_BUFFER_MAX_COUNT) {\r
1331 ConsoleIn->ScancodeBufEndPos = 0;\r
1332 }\r
1333\r
1334 ConsoleIn->ScancodeBuf[ConsoleIn->ScancodeBufEndPos] = Readed;\r
1335\r
1336 //\r
1337 // Handle Alt+Ctrl+Del Key combination\r
1338 //\r
1339 switch (Readed) {\r
1340\r
1341 case SCANCODE_CTRL_MAKE:\r
1342 ConsoleIn->Ctrled = TRUE;\r
1343 break;\r
1344\r
1345 case SCANCODE_CTRL_BREAK:\r
1346 ConsoleIn->Ctrled = FALSE;\r
1347 break;\r
1348\r
1349 case SCANCODE_ALT_MAKE:\r
1350 ConsoleIn->Alted = TRUE;\r
1351 break;\r
1352\r
1353 case SCANCODE_ALT_BREAK:\r
1354 ConsoleIn->Alted = FALSE;\r
1355 break;\r
1356 }\r
1357 //\r
1358 // if Alt+Ctrl+Del, Reboot the System\r
1359 //\r
1360 if (ConsoleIn->Ctrled && ConsoleIn->Alted && Readed == 0x53) {\r
1361 gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
1362 }\r
1363 }\r
1364 //\r
1365 // Check if there are enough bytes of scancode representing a single key\r
1366 // available in the buffer\r
1367 //\r
1368 while (1) {\r
1369\r
1370 Status = GetScancodeBufHead (ConsoleIn, 1, ScancodeArr);\r
1371 ScancodeArrPos = 0;\r
1372 if (EFI_ERROR (Status)) {\r
1373 return EFI_NOT_READY;\r
1374 }\r
1375\r
1376 if (ScancodeArr[ScancodeArrPos] == SCANCODE_EXTENDED) {\r
1377 Extended = TRUE;\r
1378 Status = GetScancodeBufHead (ConsoleIn, 2, ScancodeArr);\r
1379 ScancodeArrPos = 1;\r
1380 if (EFI_ERROR (Status)) {\r
1381 return EFI_NOT_READY;\r
1382 }\r
1383 }\r
1384 //\r
1385 // Checks for key scancode for PAUSE:E1-1D/45-E1/9D-C5\r
1386 // if present, ignore them\r
1387 //\r
1388 if (ScancodeArr[ScancodeArrPos] == SCANCODE_EXTENDED1) {\r
1389\r
1390 Status = GetScancodeBufHead (ConsoleIn, 2, ScancodeArr);\r
1391 ScancodeArrPos = 1;\r
1392\r
1393 if (EFI_ERROR (Status)) {\r
1394 return EFI_NOT_READY;\r
1395 }\r
1396\r
1397 Status = GetScancodeBufHead (ConsoleIn, 3, ScancodeArr);\r
1398 ScancodeArrPos = 2;\r
1399\r
1400 if (EFI_ERROR (Status)) {\r
1401 return EFI_NOT_READY;\r
1402 }\r
1403\r
1404 PopScancodeBufHead (ConsoleIn, 3, ScancodeArr);\r
1405 return EFI_NOT_READY;\r
1406 }\r
1407 //\r
1408 // if we reach this position, scancodes for a key is in buffer now,pop them\r
1409 //\r
1410 Status = PopScancodeBufHead (ConsoleIn, ScancodeArrPos + 1, ScancodeArr);\r
1411 if (EFI_ERROR (Status)) {\r
1412 return EFI_NOT_READY;\r
1413 }\r
1414 //\r
1415 // store the last available byte, this byte of scancode will be checked\r
1416 //\r
1417 ScanCode = ScancodeArr[ScancodeArrPos];\r
1418\r
1419 //\r
1420 // Check for special keys and update the driver state.\r
1421 //\r
1422 switch (ScanCode) {\r
1423\r
1424 case SCANCODE_CTRL_MAKE:\r
1425 ConsoleIn->Ctrl = TRUE;\r
1426 break;\r
1427\r
1428 case SCANCODE_CTRL_BREAK:\r
1429 ConsoleIn->Ctrl = FALSE;\r
1430 break;\r
1431\r
1432 case SCANCODE_ALT_MAKE:\r
1433 ConsoleIn->Alt = TRUE;\r
1434 break;\r
1435\r
1436 case SCANCODE_ALT_BREAK:\r
1437 ConsoleIn->Alt = FALSE;\r
1438 break;\r
1439\r
1440 case SCANCODE_LEFT_SHIFT_MAKE:\r
f3d1e940 1441 if (!Extended) {\r
1442 ConsoleIn->Shift = TRUE;\r
1443 ConsoleIn->LeftShift = TRUE;\r
1444 } \r
1445 break;\r
05fbd06d 1446 case SCANCODE_RIGHT_SHIFT_MAKE:\r
1447 if (!Extended) {\r
1448 ConsoleIn->Shift = TRUE;\r
f3d1e940 1449 ConsoleIn->RightShift = TRUE;\r
05fbd06d 1450 }\r
1451 break;\r
1452\r
1453 case SCANCODE_LEFT_SHIFT_BREAK:\r
f3d1e940 1454 if (!Extended) {\r
1455 ConsoleIn->Shift = FALSE;\r
1456 ConsoleIn->LeftShift = FALSE;\r
1457 } else {\r
1458 ConsoleIn->SysReq = FALSE;\r
1459 } \r
1460 break;\r
05fbd06d 1461 case SCANCODE_RIGHT_SHIFT_BREAK:\r
1462 if (!Extended) {\r
1463 ConsoleIn->Shift = FALSE;\r
f3d1e940 1464 ConsoleIn->RightShift = FALSE;\r
05fbd06d 1465 }\r
1466 break;\r
1467\r
f3d1e940 1468 case SCANCODE_LEFT_LOGO_MAKE:\r
1469 ConsoleIn->LeftLogo = TRUE;\r
1470 break; \r
1471 case SCANCODE_LEFT_LOGO_BREAK:\r
1472 ConsoleIn->LeftLogo = FALSE;\r
1473 break; \r
1474 case SCANCODE_RIGHT_LOGO_MAKE:\r
1475 ConsoleIn->RightLogo = TRUE;\r
1476 break;\r
1477 case SCANCODE_RIGHT_LOGO_BREAK:\r
1478 ConsoleIn->RightLogo = FALSE;\r
1479 break; \r
1480 case SCANCODE_MENU_MAKE:\r
1481 ConsoleIn->Menu = TRUE;\r
1482 break;\r
1483 case SCANCODE_MENU_BREAK:\r
1484 ConsoleIn->Menu = FALSE;\r
1485 break; \r
1486 case SCANCODE_SYS_REQ_MAKE:\r
1487 if (Extended) {\r
1488 ConsoleIn->SysReq = TRUE;\r
1489 }\r
05fbd06d 1490 case SCANCODE_CAPS_LOCK_MAKE:\r
1491 ConsoleIn->CapsLock = (BOOLEAN)!ConsoleIn->CapsLock;\r
1492 UpdateStatusLights (ConsoleIn);\r
1493 break;\r
1494\r
1495 case SCANCODE_NUM_LOCK_MAKE:\r
1496 ConsoleIn->NumLock = (BOOLEAN)!ConsoleIn->NumLock;\r
1497 UpdateStatusLights (ConsoleIn);\r
1498 break;\r
1499\r
1500 case SCANCODE_SCROLL_LOCK_MAKE:\r
1501 ConsoleIn->ScrollLock = (BOOLEAN)!ConsoleIn->ScrollLock;\r
1502 UpdateStatusLights (ConsoleIn);\r
1503 break;\r
1504 }\r
1505 //\r
1506 // If this is a BREAK Key or above the valid range, ignore it\r
1507 //\r
1508 if (ScanCode >= SCANCODE_MAX_MAKE) {\r
1509 continue;\r
1510 } else {\r
1511 break;\r
1512 }\r
1513 }\r
1514 //\r
05fbd06d 1515 // Treat Numeric Key Pad "/" specially\r
1516 //\r
1517 if (Extended && ScanCode == 0x35) {\r
1518 ConsoleIn->Key.ScanCode = SCAN_NULL;\r
1519 ConsoleIn->Key.UnicodeChar = '/';\r
1520 return EFI_SUCCESS;\r
1521 }\r
1522 //\r
1523 // Convert Keyboard ScanCode into an EFI Key\r
1524 //\r
1525 for (Index = 0; ConvertKeyboardScanCodeToEfiKey[Index].ScanCode != TABLE_END; Index += 1) {\r
1526 if (ScanCode == ConvertKeyboardScanCodeToEfiKey[Index].ScanCode) {\r
1527 ConsoleIn->Key.ScanCode = ConvertKeyboardScanCodeToEfiKey[Index].EfiScanCode;\r
1528 if (ConsoleIn->Shift) {\r
1529 ConsoleIn->Key.UnicodeChar = ConvertKeyboardScanCodeToEfiKey[Index].ShiftUnicodeChar;\r
f3d1e940 1530 //\r
1531 // Need not return associated shift state if a class of printable characters that\r
1532 // are normally adjusted by shift modifiers. e.g. Shift Key + 'f' key = 'F'\r
1533 //\r
1534 if (ConsoleIn->Key.UnicodeChar >= 'A' && ConsoleIn->Key.UnicodeChar <= 'Z') {\r
1535 ConsoleIn->LeftShift = FALSE;\r
1536 ConsoleIn->RightShift = FALSE;\r
1537 }\r
05fbd06d 1538 } else {\r
1539 ConsoleIn->Key.UnicodeChar = ConvertKeyboardScanCodeToEfiKey[Index].UnicodeChar;\r
1540 }\r
1541 //\r
1542 // alphabetic key is affected by CapsLock State\r
1543 //\r
1544 if (ConsoleIn->CapsLock) {\r
1545 if (ConsoleIn->Key.UnicodeChar >= 'a' && ConsoleIn->Key.UnicodeChar <= 'z') {\r
1546 ConsoleIn->Key.UnicodeChar = ConvertKeyboardScanCodeToEfiKey[Index].ShiftUnicodeChar;\r
1547 } else if (ConsoleIn->Key.UnicodeChar >= 'A' && ConsoleIn->Key.UnicodeChar <= 'Z') {\r
1548 ConsoleIn->Key.UnicodeChar = ConvertKeyboardScanCodeToEfiKey[Index].UnicodeChar;\r
1549 }\r
1550 }\r
1f771698 1551 //\r
1552 // Translate the CTRL-Alpha characters to their corresponding control value (ctrl-a = 0x0001 through ctrl-Z = 0x001A)\r
1553 //\r
1554 if (ConsoleIn->Ctrled) {\r
1555 if (ConsoleIn->Key.UnicodeChar >= 'a' && ConsoleIn->Key.UnicodeChar <= 'z') {\r
1556 ConsoleIn->Key.UnicodeChar = (UINT16) (ConsoleIn->Key.UnicodeChar - 'a' + 1);\r
1557 } else if (ConsoleIn->Key.UnicodeChar >= 'A' && ConsoleIn->Key.UnicodeChar <= 'Z') {\r
1558 ConsoleIn->Key.UnicodeChar = (UINT16) (ConsoleIn->Key.UnicodeChar - 'A' + 1);\r
1559 }\r
1560 }\r
05fbd06d 1561\r
1562 break;\r
1563 }\r
1564 }\r
1565\r
1566 //\r
1567 // distinguish numeric key pad keys' 'up symbol' and 'down symbol'\r
1568 //\r
1569 if (ScanCode >= 0x47 && ScanCode <= 0x53) {\r
1570\r
1571 if (ConsoleIn->NumLock && !ConsoleIn->Shift && !Extended) {\r
1572 ConsoleIn->Key.ScanCode = SCAN_NULL;\r
1573 } else if (ScanCode != 0x4a && ScanCode != 0x4e) {\r
1574 ConsoleIn->Key.UnicodeChar = 0x00;\r
1575 }\r
1576 }\r
1577 //\r
1578 // If the key can not be converted then just return.\r
1579 //\r
1580 if (ConsoleIn->Key.ScanCode == SCAN_NULL && ConsoleIn->Key.UnicodeChar == 0x00) {\r
1581 return EFI_NOT_READY;\r
1582 }\r
1583\r
f3d1e940 1584 //\r
1585 // Save the Shift/Toggle state\r
1586 //\r
1587 if (ConsoleIn->Ctrl) {\r
1588 ConsoleIn->KeyState.KeyShiftState |= (Extended == TRUE) ? EFI_RIGHT_CONTROL_PRESSED : EFI_LEFT_CONTROL_PRESSED;\r
1589 } \r
1590 if (ConsoleIn->Alt) { \r
1591 ConsoleIn->KeyState.KeyShiftState |= (Extended == TRUE) ? EFI_RIGHT_ALT_PRESSED : EFI_LEFT_ALT_PRESSED;\r
1592 } \r
1593 if (ConsoleIn->LeftShift) { \r
1594 ConsoleIn->KeyState.KeyShiftState |= EFI_LEFT_SHIFT_PRESSED;\r
1595 } \r
1596 if (ConsoleIn->RightShift) { \r
1597 ConsoleIn->KeyState.KeyShiftState |= EFI_RIGHT_SHIFT_PRESSED;\r
1598 } \r
1599 if (ConsoleIn->LeftLogo) { \r
1600 ConsoleIn->KeyState.KeyShiftState |= EFI_LEFT_LOGO_PRESSED;\r
1601 } \r
1602 if (ConsoleIn->RightLogo) { \r
1603 ConsoleIn->KeyState.KeyShiftState |= EFI_RIGHT_LOGO_PRESSED;\r
1604 } \r
1605 if (ConsoleIn->Menu) { \r
1606 ConsoleIn->KeyState.KeyShiftState |= EFI_MENU_KEY_PRESSED;\r
1607 } \r
1608 if (ConsoleIn->SysReq) { \r
1609 ConsoleIn->KeyState.KeyShiftState |= EFI_SYS_REQ_PRESSED;\r
1610 } \r
1611 if (ConsoleIn->CapsLock) {\r
1612 ConsoleIn->KeyState.KeyToggleState |= EFI_CAPS_LOCK_ACTIVE;\r
1613 }\r
1614 if (ConsoleIn->NumLock) {\r
1615 ConsoleIn->KeyState.KeyToggleState |= EFI_NUM_LOCK_ACTIVE;\r
1616 }\r
1617 if (ConsoleIn->ScrollLock) {\r
1618 ConsoleIn->KeyState.KeyToggleState |= EFI_SCROLL_LOCK_ACTIVE;\r
1619 }\r
1620\r
05fbd06d 1621 return EFI_SUCCESS;\r
1622}\r
1623\r
bcd70414 1624/**\r
05fbd06d 1625 Perform 8042 controller and keyboard Initialization\r
1626 If ExtendedVerification is TRUE, do additional test for\r
1627 the keyboard interface\r
1628\r
bcd70414 1629 @param ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer\r
1630 @param ExtendedVerification - indicates a thorough initialization\r
05fbd06d 1631\r
bcd70414 1632 @retval EFI_DEVICE_ERROR Fail to init keyboard\r
1633 @retval EFI_SUCCESS Success to init keyboard\r
1634**/\r
1635EFI_STATUS\r
1636InitKeyboard (\r
1637 IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
1638 IN BOOLEAN ExtendedVerification\r
1639 )\r
05fbd06d 1640{\r
1641 EFI_STATUS Status;\r
1642 EFI_STATUS Status1;\r
1643 UINT8 CommandByte;\r
05fbd06d 1644 EFI_PS2_POLICY_PROTOCOL *Ps2Policy;\r
1645\r
1646 Status = EFI_SUCCESS;\r
4fd730b3 1647 mEnableMouseInterface = TRUE;\r
05fbd06d 1648\r
1649 //\r
1650 // Get Ps2 policy to set this\r
1651 //\r
1652 Status = gBS->LocateProtocol (\r
1653 &gEfiPs2PolicyProtocolGuid,\r
1654 NULL,\r
1655 (VOID **) &Ps2Policy\r
1656 );\r
1657\r
1658 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
1659 EFI_PROGRESS_CODE,\r
1660 EFI_PERIPHERAL_KEYBOARD | EFI_P_KEYBOARD_PC_CLEAR_BUFFER,\r
1661 ConsoleIn->DevicePath\r
1662 );\r
1663\r
1664 //\r
1665 // Perform a read to cleanup the Status Register's\r
1666 // output buffer full bits\r
1667 //\r
1668 while (!EFI_ERROR (Status)) {\r
1669 Status = KeyboardRead (ConsoleIn, &CommandByte);\r
1670 }\r
1671 //\r
1672 // We should disable mouse interface during the initialization process\r
1673 // since mouse device output could block keyboard device output in the\r
1674 // 60H port of 8042 controller.\r
1675 //\r
1676 // So if we are not initializing 8042 controller for the\r
1677 // first time, we have to remember the previous mouse interface\r
1678 // enabling state\r
1679 //\r
1680 // Test the system flag in to determine whether this is the first\r
1681 // time initialization\r
1682 //\r
1683 if ((KeyReadStatusRegister (ConsoleIn) & 0x04)) {\r
1684 //\r
1685 // 8042 controller is already setup (by myself or by mouse driver):\r
1686 // See whether mouse interface is already enabled\r
1687 // which determines whether we should enable it later\r
1688 //\r
1689 //\r
1690 // Read the command byte of 8042 controller\r
1691 //\r
1692 Status = KeyboardCommand (ConsoleIn, 0x20);\r
1693 if (EFI_ERROR (Status)) {\r
1694 KeyboardError (ConsoleIn, L"\n\r");\r
1695 goto Done;\r
1696 }\r
1697\r
1698 Status = KeyboardRead (ConsoleIn, &CommandByte);\r
1699 if (EFI_ERROR (Status)) {\r
1700 KeyboardError (ConsoleIn, L"\n\r");\r
1701 goto Done;\r
1702 }\r
1703 //\r
1704 // Test the mouse enabling bit\r
1705 //\r
1706 if (CommandByte & 0x20) {\r
4fd730b3 1707 mEnableMouseInterface = FALSE;\r
05fbd06d 1708 } else {\r
4fd730b3 1709 mEnableMouseInterface = TRUE;\r
05fbd06d 1710 }\r
1711\r
1712 } else {\r
1713 //\r
1714 // 8042 controller is not setup yet:\r
1715 // 8042 controller selftest;\r
1716 // Don't enable mouse interface later.\r
1717 //\r
1718 //\r
1719 // Disable keyboard and mouse interfaces\r
1720 //\r
1721 Status = KeyboardCommand (ConsoleIn, 0xad);\r
1722 if (EFI_ERROR (Status)) {\r
1723 KeyboardError (ConsoleIn, L"\n\r");\r
1724 goto Done;\r
1725 }\r
1726\r
1727 Status = KeyboardCommand (ConsoleIn, 0xa7);\r
1728 if (EFI_ERROR (Status)) {\r
1729 KeyboardError (ConsoleIn, L"\n\r");\r
1730 goto Done;\r
1731 }\r
1732\r
1733 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
1734 EFI_PROGRESS_CODE,\r
1735 EFI_PERIPHERAL_KEYBOARD | EFI_P_KEYBOARD_PC_SELF_TEST,\r
1736 ConsoleIn->DevicePath\r
1737 );\r
1738 //\r
1739 // 8042 Controller Self Test\r
1740 //\r
1741 Status = KeyboardCommand (ConsoleIn, 0xaa);\r
1742 if (EFI_ERROR (Status)) {\r
1743 KeyboardError (ConsoleIn, L"8042 controller command write error!\n\r");\r
1744 goto Done;\r
1745 }\r
1746\r
1747 Status = KeyboardWaitForValue (ConsoleIn, 0x55);\r
1748 if (EFI_ERROR (Status)) {\r
1749 KeyboardError (ConsoleIn, L"8042 controller self test failed!\n\r");\r
1750 goto Done;\r
1751 }\r
1752 //\r
1753 // Don't enable mouse interface later\r
1754 //\r
4fd730b3 1755 mEnableMouseInterface = FALSE;\r
05fbd06d 1756\r
1757 }\r
1758\r
1759 if (Ps2Policy != NULL) {\r
1760 Ps2Policy->Ps2InitHardware (ConsoleIn->Handle);\r
1761 }\r
1762 //\r
1763 // Write 8042 Command Byte, set System Flag\r
1764 // While at the same time:\r
1765 // 1. disable mouse interface,\r
1766 // 2. enable kbd interface,\r
1767 // 3. enable PC/XT kbd translation mode\r
1768 // 4. enable mouse and kbd interrupts\r
1769 //\r
1770 // ( Command Byte bits:\r
1771 // 7: Reserved\r
1772 // 6: PC/XT translation mode\r
1773 // 5: Disable Auxiliary device interface\r
1774 // 4: Disable keyboard interface\r
1775 // 3: Reserved\r
1776 // 2: System Flag\r
1777 // 1: Enable Auxiliary device interrupt\r
1778 // 0: Enable Keyboard interrupt )\r
1779 //\r
1780 Status = KeyboardCommand (ConsoleIn, 0x60);\r
1781 if (EFI_ERROR (Status)) {\r
1782 KeyboardError (ConsoleIn, L"8042 controller command write error!\n\r");\r
1783 goto Done;\r
1784 }\r
1785\r
1786 Status = KeyboardWrite (ConsoleIn, 0x67);\r
1787 if (EFI_ERROR (Status)) {\r
1788 KeyboardError (ConsoleIn, L"8042 controller data write error!\n\r");\r
1789 goto Done;\r
1790 }\r
1791\r
1792 //\r
1793 // Clear Memory Scancode Buffer\r
1794 //\r
1795 ConsoleIn->ScancodeBufStartPos = 0;\r
1796 ConsoleIn->ScancodeBufEndPos = KEYBOARD_BUFFER_MAX_COUNT - 1;\r
1797 ConsoleIn->ScancodeBufCount = 0;\r
1798 ConsoleIn->Ctrled = FALSE;\r
1799 ConsoleIn->Alted = FALSE;\r
1800\r
1801 //\r
1802 // Reset the status indicators\r
1803 //\r
1804 ConsoleIn->Ctrl = FALSE;\r
1805 ConsoleIn->Alt = FALSE;\r
1806 ConsoleIn->Shift = FALSE;\r
1807 ConsoleIn->CapsLock = FALSE;\r
1808 ConsoleIn->NumLock = FALSE;\r
1809 ConsoleIn->ScrollLock = FALSE;\r
f3d1e940 1810 ConsoleIn->LeftShift = FALSE;\r
1811 ConsoleIn->RightShift = FALSE;\r
1812 ConsoleIn->LeftLogo = FALSE;\r
1813 ConsoleIn->RightLogo = FALSE;\r
1814 ConsoleIn->Menu = FALSE;\r
1815 ConsoleIn->SysReq = FALSE; \r
05fbd06d 1816\r
1817 //\r
1818 // For reseting keyboard is not mandatory before booting OS and sometimes keyboard responses very slow,\r
1819 // and to support KB hot plug, we need to let the InitKB succeed no matter whether there is a KB device connected\r
1820 // to system. So we only do the real reseting for keyboard when user asks and there is a real KB connected t system,\r
1821 // and normally during booting an OS, it's skipped.\r
1822 //\r
1823 if (ExtendedVerification && CheckKeyboardConnect (ConsoleIn)) {\r
1824 //\r
1825 // Additional verifications for keyboard interface\r
1826 //\r
1827 //\r
1828 // Keyboard Interface Test\r
1829 //\r
1830 Status = KeyboardCommand (ConsoleIn, 0xab);\r
1831 if (EFI_ERROR (Status)) {\r
1832 KeyboardError (ConsoleIn, L"8042 controller command write error!\n\r");\r
1833 goto Done;\r
1834 }\r
1835\r
1836 Status = KeyboardWaitForValue (ConsoleIn, 0x00);\r
1837 if (EFI_ERROR (Status)) {\r
1838 KeyboardError (\r
1839 ConsoleIn,\r
1840 L"Some specific value not aquired from 8042 controller!\n\r"\r
1841 );\r
1842 goto Done;\r
1843 }\r
1844 //\r
1845 // Keyboard reset with a BAT(Basic Assurance Test)\r
1846 //\r
1847 Status = KeyboardWrite (ConsoleIn, 0xff);\r
1848 if (EFI_ERROR (Status)) {\r
1849 KeyboardError (ConsoleIn, L"8042 controller data write error!\n\r");\r
1850 goto Done;\r
1851 }\r
1852\r
1853 Status = KeyboardWaitForValue (ConsoleIn, 0xfa);\r
1854 if (EFI_ERROR (Status)) {\r
1855 KeyboardError (ConsoleIn, L"Some specific value not aquired from 8042 controller!\n\r");\r
1856 goto Done;\r
1857 }\r
1858 //\r
1859 // wait for BAT completion code\r
1860 //\r
1861 mWaitForValueTimeOut = KEYBOARD_BAT_TIMEOUT;\r
1862\r
1863 Status = KeyboardWaitForValue (ConsoleIn, 0xaa);\r
1864 if (EFI_ERROR (Status)) {\r
1865 KeyboardError (ConsoleIn, L"Keyboard self test failed!\n\r");\r
1866 goto Done;\r
1867 }\r
1868\r
1869 mWaitForValueTimeOut = KEYBOARD_WAITFORVALUE_TIMEOUT;\r
1870\r
1871 //\r
1872 // Set Keyboard to use Scan Code Set 2\r
1873 //\r
1874 Status = KeyboardWrite (ConsoleIn, 0xf0);\r
1875 if (EFI_ERROR (Status)) {\r
1876 KeyboardError (ConsoleIn, L"8042 controller data write error!\n\r");\r
1877 goto Done;\r
1878 }\r
1879\r
1880 Status = KeyboardWaitForValue (ConsoleIn, 0xfa);\r
1881 if (EFI_ERROR (Status)) {\r
1882 KeyboardError (ConsoleIn, L"Some specific value not aquired from 8042 controller!\n\r");\r
1883 goto Done;\r
1884 }\r
1885\r
1886 Status = KeyboardWrite (ConsoleIn, 0x02);\r
1887 if (EFI_ERROR (Status)) {\r
1888 KeyboardError (ConsoleIn, L"8042 controller data write error!!\n\r");\r
1889 goto Done;\r
1890 }\r
1891\r
1892 Status = KeyboardWaitForValue (ConsoleIn, 0xfa);\r
1893 if (EFI_ERROR (Status)) {\r
1894 KeyboardError (ConsoleIn, L"Some specific value not aquired from 8042 controller!\n\r");\r
1895 goto Done;\r
1896 }\r
1897\r
1898 //\r
1899 // Clear Keyboard Scancode Buffer\r
1900 //\r
1901 Status = KeyboardWrite (ConsoleIn, 0xf4);\r
1902 if (EFI_ERROR (Status)) {\r
1903 KeyboardError (ConsoleIn, L"8042 controller data write error!\n\r");\r
1904 goto Done;\r
1905 }\r
1906\r
1907 Status = KeyboardWaitForValue (ConsoleIn, 0xfa);\r
1908 if (EFI_ERROR (Status)) {\r
1909 KeyboardError (ConsoleIn, L"Some specific value not aquired from 8042 controller!\n\r");\r
1910 goto Done;\r
1911 }\r
1912 //\r
1913 if (Ps2Policy != NULL) {\r
1914 if ((Ps2Policy->KeyboardLight & EFI_KEYBOARD_CAPSLOCK) == EFI_KEYBOARD_CAPSLOCK) {\r
1915 ConsoleIn->CapsLock = TRUE;\r
1916 }\r
1917\r
1918 if ((Ps2Policy->KeyboardLight & EFI_KEYBOARD_NUMLOCK) == EFI_KEYBOARD_NUMLOCK) {\r
1919 ConsoleIn->NumLock = TRUE;\r
1920 }\r
1921\r
1922 if ((Ps2Policy->KeyboardLight & EFI_KEYBOARD_SCROLLLOCK) == EFI_KEYBOARD_SCROLLLOCK) {\r
1923 ConsoleIn->ScrollLock = TRUE;\r
1924 }\r
1925 }\r
1926 //\r
1927 // Update Keyboard Lights\r
1928 //\r
1929 Status = UpdateStatusLights (ConsoleIn);\r
1930 if (EFI_ERROR (Status)) {\r
1931 KeyboardError (ConsoleIn, L"Update keyboard status lights error!\n\r");\r
1932 goto Done;\r
1933 }\r
1934 }\r
1935 //\r
1936 // At last, we can now enable the mouse interface if appropriate\r
1937 //\r
1938Done:\r
1939\r
4fd730b3 1940 if (mEnableMouseInterface) {\r
05fbd06d 1941 //\r
1942 // Enable mouse interface\r
1943 //\r
1944 Status1 = KeyboardCommand (ConsoleIn, 0xa8);\r
1945 if (EFI_ERROR (Status1)) {\r
1946 KeyboardError (ConsoleIn, L"8042 controller command write error!\n\r");\r
1947 return EFI_DEVICE_ERROR;\r
1948 }\r
1949 }\r
1950\r
1951 if (!EFI_ERROR (Status)) {\r
1952 return EFI_SUCCESS;\r
1953 } else {\r
1954 return EFI_DEVICE_ERROR;\r
1955 }\r
1956\r
1957}\r
1958\r
bcd70414 1959/**\r
05fbd06d 1960 Disable the keyboard interface of the 8042 controller\r
1961\r
bcd70414 1962 @param ConsoleIn - the device instance\r
05fbd06d 1963\r
bcd70414 1964 @return status of issuing disable command\r
05fbd06d 1965\r
bcd70414 1966**/\r
1967EFI_STATUS\r
1968DisableKeyboard (\r
1969 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
1970 )\r
05fbd06d 1971{\r
1972 EFI_STATUS Status;\r
1973\r
1974 //\r
1975 // Disable keyboard interface\r
1976 //\r
1977 Status = KeyboardCommand (ConsoleIn, 0xad);\r
1978 if (EFI_ERROR (Status)) {\r
1979 KeyboardError (ConsoleIn, L"\n\r");\r
1980 return EFI_DEVICE_ERROR;\r
1981 }\r
1982\r
1983 return Status;\r
1984}\r
1985\r
1986/**\r
1987 Check whether there is Ps/2 Keyboard device in system by 0xF4 Keyboard Command\r
1988 If Keyboard receives 0xF4, it will respond with 'ACK'. If it doesn't respond, the device\r
1989 should not be in system.\r
1990\r
fdb05fa3 1991 @param[in] ConsoleIn Keyboard Private Data Structure\r
05fbd06d 1992\r
f3d1e940 1993 @retval TRUE Keyboard in System.\r
1994 @retval FALSE Keyboard not in System.\r
05fbd06d 1995**/\r
1996BOOLEAN\r
1997EFIAPI\r
1998CheckKeyboardConnect (\r
1999 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
2000 )\r
2001{\r
2002 EFI_STATUS Status;\r
2003 UINTN WaitForValueTimeOutBcakup;\r
2004\r
2005 Status = EFI_SUCCESS;\r
2006 //\r
2007 // enable keyboard itself and wait for its ack\r
2008 // If can't receive ack, Keyboard should not be connected.\r
2009 //\r
2010 Status = KeyboardWrite (\r
2011 ConsoleIn,\r
2012 KEYBOARD_KBEN\r
2013 );\r
2014\r
2015 if (EFI_ERROR (Status)) {\r
2016 return FALSE;\r
2017 }\r
2018 //\r
2019 // wait for 1s\r
2020 //\r
2021 WaitForValueTimeOutBcakup = mWaitForValueTimeOut;\r
2022 mWaitForValueTimeOut = KEYBOARD_WAITFORVALUE_TIMEOUT;\r
2023 Status = KeyboardWaitForValue (\r
2024 ConsoleIn,\r
2025 KEYBOARD_CMDECHO_ACK\r
2026 );\r
2027 mWaitForValueTimeOut = WaitForValueTimeOutBcakup;\r
2028\r
2029 if (EFI_ERROR (Status)) {\r
2030 return FALSE;\r
2031 }\r
2032\r
2033 return TRUE;\r
2034}\r
bcd70414 2035\r