]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Bus/Usb/UsbKbDxe/efikey.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Add a Notification GUID for the implementation of EFI_SIMPLE_INPUT_EX protocol for...
[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbKbDxe / efikey.c
CommitLineData
ed838d0c 1/** @file\r
2\r
3Copyright (c) 2004 - 2007, Intel Corporation\r
4All rights reserved. This program and the accompanying materials\r
5are licensed and made available under the terms and conditions of the BSD License\r
6which accompanies this distribution. The full text of the license may be found at\r
7http://opensource.org/licenses/bsd-license.php\r
8\r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
11\r
12Module Name:\r
13\r
14 EfiKey.c\r
15\r
16Abstract:\r
17\r
18 USB Keyboard Driver\r
19\r
20Revision History\r
21\r
22\r
23**/\r
24\r
25#include "efikey.h"\r
26#include "keyboard.h"\r
27\r
28//\r
29// Prototypes\r
30// Driver model protocol interface\r
31//\r
32EFI_STATUS\r
33EFIAPI\r
34USBKeyboardDriverBindingEntryPoint (\r
35 IN EFI_HANDLE ImageHandle,\r
36 IN EFI_SYSTEM_TABLE *SystemTable\r
37 );\r
38\r
39EFI_STATUS\r
40EFIAPI\r
41USBKeyboardDriverBindingSupported (\r
42 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
43 IN EFI_HANDLE Controller,\r
44 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
45 );\r
46\r
47EFI_STATUS\r
48EFIAPI\r
49USBKeyboardDriverBindingStart (\r
50 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
51 IN EFI_HANDLE Controller,\r
52 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
53 );\r
54\r
55EFI_STATUS\r
56EFIAPI\r
57USBKeyboardDriverBindingStop (\r
58 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
59 IN EFI_HANDLE Controller,\r
60 IN UINTN NumberOfChildren,\r
61 IN EFI_HANDLE *ChildHandleBuffer\r
62 );\r
63\r
64//\r
65// Simple Text In Protocol Interface\r
66//\r
67STATIC\r
68EFI_STATUS\r
69EFIAPI\r
70USBKeyboardReset (\r
71 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
72 IN BOOLEAN ExtendedVerification\r
73 );\r
74\r
75STATIC\r
76EFI_STATUS\r
77EFIAPI\r
78USBKeyboardReadKeyStroke (\r
79 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
80 OUT EFI_INPUT_KEY *Key\r
81 );\r
82\r
83STATIC\r
84VOID\r
85EFIAPI\r
86USBKeyboardWaitForKey (\r
87 IN EFI_EVENT Event,\r
88 IN VOID *Context\r
89 );\r
90\r
91//\r
92// Helper functions\r
93//\r
94STATIC\r
95EFI_STATUS\r
96USBKeyboardCheckForKey (\r
97 IN USB_KB_DEV *UsbKeyboardDevice\r
98 );\r
99\r
100EFI_GUID gEfiUsbKeyboardDriverGuid = {\r
84b5c78e 101 0xa05f5f78, 0xfb3, 0x4d10, {0x90, 0x90, 0xac, 0x4, 0x6e, 0xeb, 0x7c, 0x3c}\r
ed838d0c 102};\r
103\r
104//\r
105// USB Keyboard Driver Global Variables\r
106//\r
107EFI_DRIVER_BINDING_PROTOCOL gUsbKeyboardDriverBinding = {\r
108 USBKeyboardDriverBindingSupported,\r
109 USBKeyboardDriverBindingStart,\r
110 USBKeyboardDriverBindingStop,\r
111 0xa,\r
112 NULL,\r
113 NULL\r
114};\r
115\r
ed838d0c 116EFI_STATUS\r
117EFIAPI\r
118USBKeyboardDriverBindingEntryPoint (\r
119 IN EFI_HANDLE ImageHandle,\r
120 IN EFI_SYSTEM_TABLE *SystemTable\r
121 )\r
122/*++\r
123\r
124 Routine Description:\r
125 Driver Entry Point.\r
126\r
127 Arguments:\r
128 ImageHandle - EFI_HANDLE\r
129 SystemTable - EFI_SYSTEM_TABLE\r
130 Returns:\r
131 EFI_STATUS\r
132\r
133--*/\r
134{\r
62b9bb55 135 return EfiLibInstallDriverBindingComponentName2 (\r
136 ImageHandle,\r
137 SystemTable,\r
138 &gUsbKeyboardDriverBinding,\r
139 ImageHandle,\r
140 &gUsbKeyboardComponentName,\r
141 &gUsbKeyboardComponentName2\r
142 );\r
ed838d0c 143}\r
144\r
145\r
146\r
147/**\r
148 Supported.\r
149\r
150 @param This EFI_DRIVER_BINDING_PROTOCOL\r
151 @param Controller Controller handle\r
152 @param RemainingDevicePath EFI_DEVICE_PATH_PROTOCOL\r
153 EFI_STATUS\r
154\r
155**/\r
156EFI_STATUS\r
157EFIAPI\r
158USBKeyboardDriverBindingSupported (\r
159 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
160 IN EFI_HANDLE Controller,\r
161 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
162 )\r
163{\r
164 EFI_STATUS OpenStatus;\r
165 EFI_USB_IO_PROTOCOL *UsbIo;\r
166 EFI_STATUS Status;\r
167\r
168 //\r
169 // Check if USB_IO protocol is attached on the controller handle.\r
170 //\r
171 OpenStatus = gBS->OpenProtocol (\r
172 Controller,\r
173 &gEfiUsbIoProtocolGuid,\r
c52fa98c 174 (VOID **) &UsbIo,\r
ed838d0c 175 This->DriverBindingHandle,\r
176 Controller,\r
177 EFI_OPEN_PROTOCOL_BY_DRIVER\r
178 );\r
179 if (EFI_ERROR (OpenStatus)) {\r
180 return OpenStatus;\r
181 }\r
182\r
183 //\r
184 // Use the USB I/O protocol interface to check whether the Controller is\r
185 // the Keyboard controller that can be managed by this driver.\r
186 //\r
187 Status = EFI_SUCCESS;\r
188\r
189 if (!IsUSBKeyboard (UsbIo)) {\r
190 Status = EFI_UNSUPPORTED;\r
191 }\r
192\r
193 gBS->CloseProtocol (\r
194 Controller,\r
195 &gEfiUsbIoProtocolGuid,\r
196 This->DriverBindingHandle,\r
197 Controller\r
198 );\r
199\r
200 return Status;\r
201}\r
202\r
203\r
204/**\r
205 Start.\r
206\r
207 @param This EFI_DRIVER_BINDING_PROTOCOL\r
208 @param Controller Controller handle\r
209 @param RemainingDevicePath EFI_DEVICE_PATH_PROTOCOL\r
210\r
211 @retval EFI_SUCCESS Success\r
212 @retval EFI_OUT_OF_RESOURCES Can't allocate memory\r
213 @retval EFI_UNSUPPORTED The Start routine fail\r
214\r
215**/\r
216EFI_STATUS\r
217EFIAPI\r
218USBKeyboardDriverBindingStart (\r
219 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
220 IN EFI_HANDLE Controller,\r
221 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
222 )\r
223{\r
224 EFI_STATUS Status;\r
225 EFI_USB_IO_PROTOCOL *UsbIo;\r
226 USB_KB_DEV *UsbKeyboardDevice;\r
227 UINT8 EndpointNumber;\r
228 EFI_USB_ENDPOINT_DESCRIPTOR EndpointDescriptor;\r
229 UINT8 Index;\r
230 UINT8 EndpointAddr;\r
231 UINT8 PollingInterval;\r
232 UINT8 PacketSize;\r
233 BOOLEAN Found;\r
234\r
235 UsbKeyboardDevice = NULL;\r
236 Found = FALSE;\r
237\r
238 //\r
239 // Open USB_IO Protocol\r
240 //\r
241 Status = gBS->OpenProtocol (\r
242 Controller,\r
243 &gEfiUsbIoProtocolGuid,\r
c52fa98c 244 (VOID **) &UsbIo,\r
ed838d0c 245 This->DriverBindingHandle,\r
246 Controller,\r
247 EFI_OPEN_PROTOCOL_BY_DRIVER\r
248 );\r
249 if (EFI_ERROR (Status)) {\r
250 return Status;\r
251 }\r
252\r
253 UsbKeyboardDevice = AllocateZeroPool (sizeof (USB_KB_DEV));\r
254 if (UsbKeyboardDevice == NULL) {\r
255 gBS->CloseProtocol (\r
256 Controller,\r
257 &gEfiUsbIoProtocolGuid,\r
258 This->DriverBindingHandle,\r
259 Controller\r
260 );\r
261 return EFI_OUT_OF_RESOURCES;\r
262 }\r
263 //\r
264 // Get the Device Path Protocol on Controller's handle\r
265 //\r
266 Status = gBS->OpenProtocol (\r
267 Controller,\r
268 &gEfiDevicePathProtocolGuid,\r
269 (VOID **) &UsbKeyboardDevice->DevicePath,\r
270 This->DriverBindingHandle,\r
271 Controller,\r
272 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
273 );\r
274\r
275 if (EFI_ERROR (Status)) {\r
276 gBS->FreePool (UsbKeyboardDevice);\r
277 gBS->CloseProtocol (\r
278 Controller,\r
279 &gEfiUsbIoProtocolGuid,\r
280 This->DriverBindingHandle,\r
281 Controller\r
282 );\r
283 return Status;\r
284 }\r
285 //\r
286 // Report that the usb keyboard is being enabled\r
287 //\r
288 KbdReportStatusCode (\r
289 UsbKeyboardDevice->DevicePath,\r
290 EFI_PROGRESS_CODE,\r
291 PcdGet32 (PcdStatusCodeValueKeyboardEnable)\r
292 );\r
293\r
294 //\r
295 // This is pretty close to keyboard detection, so log progress\r
296 //\r
297 KbdReportStatusCode (\r
298 UsbKeyboardDevice->DevicePath,\r
299 EFI_PROGRESS_CODE,\r
300 PcdGet32 (PcdStatusCodeValueKeyboardPresenceDetect)\r
301 );\r
302\r
303 //\r
304 // Initialize UsbKeyboardDevice\r
305 //\r
306 UsbKeyboardDevice->UsbIo = UsbIo;\r
307\r
308 //\r
309 // Get interface & endpoint descriptor\r
310 //\r
311 UsbIo->UsbGetInterfaceDescriptor (\r
312 UsbIo,\r
313 &UsbKeyboardDevice->InterfaceDescriptor\r
314 );\r
315\r
316 EndpointNumber = UsbKeyboardDevice->InterfaceDescriptor.NumEndpoints;\r
317\r
318 for (Index = 0; Index < EndpointNumber; Index++) {\r
319\r
320 UsbIo->UsbGetEndpointDescriptor (\r
321 UsbIo,\r
322 Index,\r
323 &EndpointDescriptor\r
324 );\r
325\r
326 if ((EndpointDescriptor.Attributes & 0x03) == 0x03) {\r
327 //\r
328 // We only care interrupt endpoint here\r
329 //\r
84b5c78e 330 CopyMem(&UsbKeyboardDevice->IntEndpointDescriptor, &EndpointDescriptor, sizeof(EndpointDescriptor));\r
ed838d0c 331 Found = TRUE;\r
332 }\r
333 }\r
334\r
335 if (!Found) {\r
336 //\r
337 // No interrupt endpoint found, then return unsupported.\r
338 //\r
339 gBS->FreePool (UsbKeyboardDevice);\r
340 gBS->CloseProtocol (\r
341 Controller,\r
342 &gEfiUsbIoProtocolGuid,\r
343 This->DriverBindingHandle,\r
344 Controller\r
345 );\r
346 return EFI_UNSUPPORTED;\r
347 }\r
348\r
349 UsbKeyboardDevice->Signature = USB_KB_DEV_SIGNATURE;\r
350 UsbKeyboardDevice->SimpleInput.Reset = USBKeyboardReset;\r
351 UsbKeyboardDevice->SimpleInput.ReadKeyStroke = USBKeyboardReadKeyStroke;\r
352 Status = gBS->CreateEvent (\r
353 EVT_NOTIFY_WAIT,\r
354 TPL_NOTIFY,\r
355 USBKeyboardWaitForKey,\r
356 UsbKeyboardDevice,\r
357 &(UsbKeyboardDevice->SimpleInput.WaitForKey)\r
358 );\r
359\r
360 if (EFI_ERROR (Status)) {\r
361 gBS->FreePool (UsbKeyboardDevice);\r
362 gBS->CloseProtocol (\r
363 Controller,\r
364 &gEfiUsbIoProtocolGuid,\r
365 This->DriverBindingHandle,\r
366 Controller\r
367 );\r
368 return Status;\r
369 }\r
370\r
371 //\r
372 // Install simple txt in protocol interface\r
373 // for the usb keyboard device.\r
374 // Usb keyboard is a hot plug device, and expected to work immediately\r
375 // when plugging into system, so a HotPlugDeviceGuid is installed onto\r
376 // the usb keyboard device handle, to distinguish it from other conventional\r
377 // console devices.\r
378 //\r
379 Status = gBS->InstallMultipleProtocolInterfaces (\r
380 &Controller,\r
381 &gEfiSimpleTextInProtocolGuid,\r
382 &UsbKeyboardDevice->SimpleInput,\r
383 &gEfiHotPlugDeviceGuid,\r
384 NULL,\r
385 NULL\r
386 );\r
387 if (EFI_ERROR (Status)) {\r
388 gBS->CloseEvent (UsbKeyboardDevice->SimpleInput.WaitForKey);\r
389 gBS->FreePool (UsbKeyboardDevice);\r
390 gBS->CloseProtocol (\r
391 Controller,\r
392 &gEfiUsbIoProtocolGuid,\r
393 This->DriverBindingHandle,\r
394 Controller\r
395 );\r
396 return Status;\r
397 }\r
398\r
399 //\r
400 // Reset USB Keyboard Device\r
401 //\r
402 Status = UsbKeyboardDevice->SimpleInput.Reset (\r
403 &UsbKeyboardDevice->SimpleInput,\r
404 TRUE\r
405 );\r
406 if (EFI_ERROR (Status)) {\r
407 gBS->UninstallMultipleProtocolInterfaces (\r
408 Controller,\r
409 &gEfiSimpleTextInProtocolGuid,\r
410 &UsbKeyboardDevice->SimpleInput,\r
411 &gEfiHotPlugDeviceGuid,\r
412 NULL,\r
413 NULL\r
414 );\r
415 gBS->CloseEvent (UsbKeyboardDevice->SimpleInput.WaitForKey);\r
416 gBS->FreePool (UsbKeyboardDevice);\r
417 gBS->CloseProtocol (\r
418 Controller,\r
419 &gEfiUsbIoProtocolGuid,\r
420 This->DriverBindingHandle,\r
421 Controller\r
422 );\r
423 return Status;\r
424 }\r
425 //\r
426 // submit async interrupt transfer\r
427 //\r
428 EndpointAddr = UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress;\r
429 PollingInterval = UsbKeyboardDevice->IntEndpointDescriptor.Interval;\r
430 PacketSize = (UINT8) (UsbKeyboardDevice->IntEndpointDescriptor.MaxPacketSize);\r
431\r
432 Status = UsbIo->UsbAsyncInterruptTransfer (\r
433 UsbIo,\r
434 EndpointAddr,\r
435 TRUE,\r
436 PollingInterval,\r
437 PacketSize,\r
438 KeyboardHandler,\r
439 UsbKeyboardDevice\r
440 );\r
441\r
442 if (EFI_ERROR (Status)) {\r
443\r
444 gBS->UninstallMultipleProtocolInterfaces (\r
445 Controller,\r
446 &gEfiSimpleTextInProtocolGuid,\r
447 &UsbKeyboardDevice->SimpleInput,\r
448 &gEfiHotPlugDeviceGuid,\r
449 NULL,\r
450 NULL\r
451 );\r
452 gBS->CloseEvent (UsbKeyboardDevice->SimpleInput.WaitForKey);\r
453 gBS->FreePool (UsbKeyboardDevice);\r
454 gBS->CloseProtocol (\r
455 Controller,\r
456 &gEfiUsbIoProtocolGuid,\r
457 This->DriverBindingHandle,\r
458 Controller\r
459 );\r
460 return Status;\r
461 }\r
462\r
463 UsbKeyboardDevice->ControllerNameTable = NULL;\r
62b9bb55 464 AddUnicodeString2 (\r
ed838d0c 465 "eng",\r
466 gUsbKeyboardComponentName.SupportedLanguages,\r
467 &UsbKeyboardDevice->ControllerNameTable,\r
62b9bb55 468 L"Generic Usb Keyboard",\r
469 TRUE\r
ed838d0c 470 );\r
62b9bb55 471 AddUnicodeString2 (\r
472 "en",\r
473 gUsbKeyboardComponentName2.SupportedLanguages,\r
474 &UsbKeyboardDevice->ControllerNameTable,\r
475 L"Generic Usb Keyboard",\r
476 FALSE\r
477 );\r
478\r
ed838d0c 479\r
480 return EFI_SUCCESS;\r
481}\r
482\r
483\r
484\r
485/**\r
486 Stop.\r
487\r
488 @param This EFI_DRIVER_BINDING_PROTOCOL\r
489 @param Controller Controller handle\r
490 @param NumberOfChildren Child handle number\r
491 @param ChildHandleBuffer Child handle buffer\r
492\r
493 @retval EFI_SUCCESS Success\r
494 @retval EFI_UNSUPPORTED Can't support\r
495\r
496**/\r
497EFI_STATUS\r
498EFIAPI\r
499USBKeyboardDriverBindingStop (\r
500 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
501 IN EFI_HANDLE Controller,\r
502 IN UINTN NumberOfChildren,\r
503 IN EFI_HANDLE *ChildHandleBuffer\r
504 )\r
505{\r
506 EFI_STATUS Status;\r
507 EFI_SIMPLE_TEXT_INPUT_PROTOCOL *SimpleInput;\r
508 USB_KB_DEV *UsbKeyboardDevice;\r
ed838d0c 509\r
510 Status = gBS->OpenProtocol (\r
511 Controller,\r
512 &gEfiSimpleTextInProtocolGuid,\r
c52fa98c 513 (VOID **) &SimpleInput,\r
ed838d0c 514 This->DriverBindingHandle,\r
515 Controller,\r
516 EFI_OPEN_PROTOCOL_BY_DRIVER\r
517 );\r
518 if (EFI_ERROR (Status)) {\r
519 return EFI_UNSUPPORTED;\r
520 }\r
521\r
522 //\r
523 // Get USB_KB_DEV instance.\r
524 //\r
525 UsbKeyboardDevice = USB_KB_DEV_FROM_THIS (SimpleInput);\r
526\r
527 gBS->CloseProtocol (\r
528 Controller,\r
529 &gEfiSimpleTextInProtocolGuid,\r
530 This->DriverBindingHandle,\r
531 Controller\r
532 );\r
533\r
ed838d0c 534 //\r
535 // Uninstall the Asyn Interrupt Transfer from this device\r
536 // will disable the key data input from this device\r
537 //\r
538 KbdReportStatusCode (\r
539 UsbKeyboardDevice->DevicePath,\r
540 EFI_PROGRESS_CODE,\r
541 PcdGet32 (PcdStatusCodeValueKeyboardDisable)\r
542 );\r
543\r
544 //\r
545 // Destroy asynchronous interrupt transfer\r
546 //\r
547 UsbKeyboardDevice->UsbIo->UsbAsyncInterruptTransfer (\r
548 UsbKeyboardDevice->UsbIo,\r
549 UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress,\r
550 FALSE,\r
551 UsbKeyboardDevice->IntEndpointDescriptor.Interval,\r
552 0,\r
553 NULL,\r
554 NULL\r
555 );\r
556\r
557 gBS->CloseProtocol (\r
558 Controller,\r
559 &gEfiUsbIoProtocolGuid,\r
560 This->DriverBindingHandle,\r
561 Controller\r
562 );\r
563\r
564 Status = gBS->UninstallMultipleProtocolInterfaces (\r
565 Controller,\r
566 &gEfiSimpleTextInProtocolGuid,\r
567 &UsbKeyboardDevice->SimpleInput,\r
568 &gEfiHotPlugDeviceGuid,\r
569 NULL,\r
570 NULL\r
571 );\r
572 //\r
573 // free all the resources.\r
574 //\r
575 gBS->CloseEvent (UsbKeyboardDevice->RepeatTimer);\r
576 gBS->CloseEvent (UsbKeyboardDevice->DelayedRecoveryEvent);\r
577 gBS->CloseEvent ((UsbKeyboardDevice->SimpleInput).WaitForKey);\r
578\r
579 if (UsbKeyboardDevice->ControllerNameTable != NULL) {\r
580 FreeUnicodeStringTable (UsbKeyboardDevice->ControllerNameTable);\r
581 }\r
582\r
583 gBS->FreePool (UsbKeyboardDevice);\r
584\r
585 return Status;\r
586\r
587}\r
588\r
589\r
590\r
591/**\r
592 Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.Reset() function.\r
593\r
594 This The EFI_SIMPLE_TEXT_INPUT_PROTOCOL instance.\r
595 ExtendedVerification\r
596 Indicates that the driver may perform a more exhaustive\r
597 verification operation of the device during reset.\r
598\r
599 @retval EFI_SUCCESS Success\r
600 @retval EFI_DEVICE_ERROR Hardware Error\r
601\r
602**/\r
603EFI_STATUS\r
604EFIAPI\r
605USBKeyboardReset (\r
606 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
607 IN BOOLEAN ExtendedVerification\r
608 )\r
609{\r
610 EFI_STATUS Status;\r
611 USB_KB_DEV *UsbKeyboardDevice;\r
ed838d0c 612\r
613 UsbKeyboardDevice = USB_KB_DEV_FROM_THIS (This);\r
614\r
ed838d0c 615 KbdReportStatusCode (\r
616 UsbKeyboardDevice->DevicePath,\r
617 EFI_PROGRESS_CODE,\r
618 PcdGet32 (PcdStatusCodeValueKeyboardReset)\r
619 );\r
620\r
621 //\r
622 // Non Exhaustive reset:\r
623 // only reset private data structures.\r
624 //\r
625 if (!ExtendedVerification) {\r
626 //\r
627 // Clear the key buffer of this Usb keyboard\r
628 //\r
629 KbdReportStatusCode (\r
630 UsbKeyboardDevice->DevicePath,\r
631 EFI_PROGRESS_CODE,\r
632 PcdGet32 (PcdStatusCodeValueKeyboardClearBuffer)\r
633 );\r
634\r
635 InitUSBKeyBuffer (&(UsbKeyboardDevice->KeyboardBuffer));\r
636 UsbKeyboardDevice->CurKeyChar = 0;\r
637 return EFI_SUCCESS;\r
638 }\r
639\r
640 //\r
641 // Exhaustive reset\r
642 //\r
643 Status = InitUSBKeyboard (UsbKeyboardDevice);\r
644 UsbKeyboardDevice->CurKeyChar = 0;\r
645 if (EFI_ERROR (Status)) {\r
646 return EFI_DEVICE_ERROR;\r
647 }\r
648\r
649 return EFI_SUCCESS;\r
650}\r
651\r
652\r
653/**\r
654 Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke() function.\r
655\r
656 This The EFI_SIMPLE_TEXT_INPUT_PROTOCOL instance.\r
657 Key A pointer to a buffer that is filled in with the keystroke\r
658 information for the key that was pressed.\r
659\r
660 @retval EFI_SUCCESS Success\r
661\r
662**/\r
663STATIC\r
664EFI_STATUS\r
665EFIAPI\r
666USBKeyboardReadKeyStroke (\r
667 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
668 OUT EFI_INPUT_KEY *Key\r
669 )\r
670{\r
671 USB_KB_DEV *UsbKeyboardDevice;\r
672 EFI_STATUS Status;\r
673 UINT8 KeyChar;\r
674\r
675 UsbKeyboardDevice = USB_KB_DEV_FROM_THIS (This);\r
676\r
677 //\r
678 // if there is no saved ASCII byte, fetch it\r
679 // by calling USBKeyboardCheckForKey().\r
680 //\r
681 if (UsbKeyboardDevice->CurKeyChar == 0) {\r
682 Status = USBKeyboardCheckForKey (UsbKeyboardDevice);\r
683 if (EFI_ERROR (Status)) {\r
684 return Status;\r
685 }\r
686 }\r
687\r
688 Key->UnicodeChar = 0;\r
689 Key->ScanCode = SCAN_NULL;\r
690\r
691 KeyChar = UsbKeyboardDevice->CurKeyChar;\r
692\r
693 UsbKeyboardDevice->CurKeyChar = 0;\r
694\r
695 //\r
696 // Translate saved ASCII byte into EFI_INPUT_KEY\r
697 //\r
698 Status = USBKeyCodeToEFIScanCode (UsbKeyboardDevice, KeyChar, Key);\r
699\r
700 return Status;\r
701\r
702}\r
703\r
704\r
705/**\r
706 Handler function for WaitForKey event.\r
707\r
708 Event Event to be signaled when a key is pressed.\r
709 Context Points to USB_KB_DEV instance.\r
710\r
711 @return VOID\r
712\r
713**/\r
714STATIC\r
715VOID\r
716EFIAPI\r
717USBKeyboardWaitForKey (\r
718 IN EFI_EVENT Event,\r
719 IN VOID *Context\r
720 )\r
721{\r
722 USB_KB_DEV *UsbKeyboardDevice;\r
723\r
724 UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
725\r
726 if (UsbKeyboardDevice->CurKeyChar == 0) {\r
727\r
728 if (EFI_ERROR (USBKeyboardCheckForKey (UsbKeyboardDevice))) {\r
729 return ;\r
730 }\r
731 }\r
732 //\r
733 // If has key pending, signal the event.\r
734 //\r
735 gBS->SignalEvent (Event);\r
736}\r
737\r
738\r
739\r
740/**\r
741 Check whether there is key pending.\r
742\r
743 UsbKeyboardDevice The USB_KB_DEV instance.\r
744\r
745 @retval EFI_SUCCESS Success\r
746\r
747**/\r
748STATIC\r
749EFI_STATUS\r
750USBKeyboardCheckForKey (\r
751 IN USB_KB_DEV *UsbKeyboardDevice\r
752 )\r
753{\r
754 EFI_STATUS Status;\r
755 UINT8 KeyChar;\r
756\r
757 //\r
758 // Fetch raw data from the USB keyboard input,\r
759 // and translate it into ASCII data.\r
760 //\r
761 Status = USBParseKey (UsbKeyboardDevice, &KeyChar);\r
762 if (EFI_ERROR (Status)) {\r
763 return Status;\r
764 }\r
765\r
766 UsbKeyboardDevice->CurKeyChar = KeyChar;\r
767 return EFI_SUCCESS;\r
768}\r
769\r
770\r
771/**\r
772 Report Status Code in Usb Bot Driver\r
773\r
774 @param DevicePath Use this to get Device Path\r
775 @param CodeType Status Code Type\r
776 @param CodeValue Status Code Value\r
777\r
778 @return None\r
779\r
780**/\r
781VOID\r
782KbdReportStatusCode (\r
783 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
784 IN EFI_STATUS_CODE_TYPE CodeType,\r
785 IN EFI_STATUS_CODE_VALUE Value\r
786 )\r
787{\r
788\r
789 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
790 CodeType,\r
791 Value,\r
792 DevicePath\r
793 );\r
794}\r
EFI Development Kit II mirror for PVE