2 Implementation for EFI_SIMPLE_TEXT_INPUT_PROTOCOL protocol.
4 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 Reads the next keystroke from the input device. The WaitForKey Event can
20 be used to test for existence of a keystroke via WaitForEvent () call.
22 @param TerminalDevice Terminal driver private structure
23 @param KeyData A pointer to a buffer that is filled in with the
24 keystroke state data for the key that was
27 @retval EFI_SUCCESS The keystroke information was returned.
28 @retval EFI_NOT_READY There was no keystroke data available.
29 @retval EFI_INVALID_PARAMETER KeyData is NULL.
34 IN TERMINAL_DEV
*TerminalDevice
,
35 OUT EFI_KEY_DATA
*KeyData
38 if (KeyData
== NULL
) {
39 return EFI_INVALID_PARAMETER
;
42 if (!EfiKeyFiFoRemoveOneKey (TerminalDevice
, &KeyData
->Key
)) {
46 KeyData
->KeyState
.KeyShiftState
= 0;
47 KeyData
->KeyState
.KeyToggleState
= 0;
55 Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.Reset().
56 This driver only perform dependent serial device reset regardless of
57 the value of ExtendeVerification
59 @param This Indicates the calling context.
60 @param ExtendedVerification Skip by this driver.
62 @retval EFI_SUCCESS The reset operation succeeds.
63 @retval EFI_DEVICE_ERROR The dependent serial port reset fails.
69 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*This
,
70 IN BOOLEAN ExtendedVerification
74 TERMINAL_DEV
*TerminalDevice
;
76 TerminalDevice
= TERMINAL_CON_IN_DEV_FROM_THIS (This
);
79 // Report progress code here
81 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
83 (EFI_PERIPHERAL_REMOTE_CONSOLE
| EFI_P_PC_RESET
),
84 TerminalDevice
->DevicePath
87 Status
= TerminalDevice
->SerialIo
->Reset (TerminalDevice
->SerialIo
);
90 // Make all the internal buffer empty for keys
92 TerminalDevice
->RawFiFo
->Head
= TerminalDevice
->RawFiFo
->Tail
;
93 TerminalDevice
->UnicodeFiFo
->Head
= TerminalDevice
->UnicodeFiFo
->Tail
;
94 TerminalDevice
->EfiKeyFiFo
->Head
= TerminalDevice
->EfiKeyFiFo
->Tail
;
96 if (EFI_ERROR (Status
)) {
97 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
98 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
99 (EFI_PERIPHERAL_REMOTE_CONSOLE
| EFI_P_EC_CONTROLLER_ERROR
),
100 TerminalDevice
->DevicePath
108 Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().
110 @param This Indicates the calling context.
111 @param Key A pointer to a buffer that is filled in with the
112 keystroke information for the key that was sent
115 @retval EFI_SUCCESS The keystroke information is returned successfully.
116 @retval EFI_NOT_READY There is no keystroke data available.
117 @retval EFI_DEVICE_ERROR The dependent serial device encounters error.
122 TerminalConInReadKeyStroke (
123 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*This
,
124 OUT EFI_INPUT_KEY
*Key
127 TERMINAL_DEV
*TerminalDevice
;
129 EFI_KEY_DATA KeyData
;
132 // get TERMINAL_DEV from "This" parameter.
134 TerminalDevice
= TERMINAL_CON_IN_DEV_FROM_THIS (This
);
136 Status
= ReadKeyStrokeWorker (TerminalDevice
, &KeyData
);
137 if (EFI_ERROR (Status
)) {
141 CopyMem (Key
, &KeyData
.Key
, sizeof (EFI_INPUT_KEY
));
148 Check if the key already has been registered.
150 If both RegsiteredData and InputData is NULL, then ASSERT().
152 @param RegsiteredData A pointer to a buffer that is filled in with the
153 keystroke state data for the key that was
155 @param InputData A pointer to a buffer that is filled in with the
156 keystroke state data for the key that was
159 @retval TRUE Key be pressed matches a registered key.
160 @retval FLASE Match failed.
165 IN EFI_KEY_DATA
*RegsiteredData
,
166 IN EFI_KEY_DATA
*InputData
169 ASSERT (RegsiteredData
!= NULL
&& InputData
!= NULL
);
171 if ((RegsiteredData
->Key
.ScanCode
!= InputData
->Key
.ScanCode
) ||
172 (RegsiteredData
->Key
.UnicodeChar
!= InputData
->Key
.UnicodeChar
)) {
182 Event notification function for EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event
183 Signal the event if there is key available
185 @param Event Indicates the event that invoke this function.
186 @param Context Indicates the calling context.
191 TerminalConInWaitForKeyEx (
196 TerminalConInWaitForKey (Event
, Context
);
200 // Simple Text Input Ex protocol functions
204 Reset the input device and optionally run diagnostics
206 @param This Protocol instance pointer.
207 @param ExtendedVerification Driver may perform diagnostics on reset.
209 @retval EFI_SUCCESS The device was reset.
210 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
216 TerminalConInResetEx (
217 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
218 IN BOOLEAN ExtendedVerification
222 TERMINAL_DEV
*TerminalDevice
;
224 TerminalDevice
= TERMINAL_CON_IN_EX_DEV_FROM_THIS (This
);
226 Status
= TerminalDevice
->SimpleInput
.Reset (&TerminalDevice
->SimpleInput
, ExtendedVerification
);
227 if (EFI_ERROR (Status
)) {
228 return EFI_DEVICE_ERROR
;
237 Reads the next keystroke from the input device. The WaitForKey Event can
238 be used to test for existence of a keystroke via WaitForEvent () call.
240 @param This Protocol instance pointer.
241 @param KeyData A pointer to a buffer that is filled in with the
242 keystroke state data for the key that was
245 @retval EFI_SUCCESS The keystroke information was returned.
246 @retval EFI_NOT_READY There was no keystroke data available.
247 @retval EFI_DEVICE_ERROR The keystroke information was not returned due
249 @retval EFI_INVALID_PARAMETER KeyData is NULL.
254 TerminalConInReadKeyStrokeEx (
255 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
256 OUT EFI_KEY_DATA
*KeyData
259 TERMINAL_DEV
*TerminalDevice
;
261 if (KeyData
== NULL
) {
262 return EFI_INVALID_PARAMETER
;
265 TerminalDevice
= TERMINAL_CON_IN_EX_DEV_FROM_THIS (This
);
267 return ReadKeyStrokeWorker (TerminalDevice
, KeyData
);
273 Set certain state for the input device.
275 @param This Protocol instance pointer.
276 @param KeyToggleState A pointer to the EFI_KEY_TOGGLE_STATE to set the
277 state for the input device.
279 @retval EFI_SUCCESS The device state was set successfully.
280 @retval EFI_DEVICE_ERROR The device is not functioning correctly and
281 could not have the setting adjusted.
282 @retval EFI_UNSUPPORTED The device does not have the ability to set its
284 @retval EFI_INVALID_PARAMETER KeyToggleState is NULL.
289 TerminalConInSetState (
290 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
291 IN EFI_KEY_TOGGLE_STATE
*KeyToggleState
294 if (KeyToggleState
== NULL
) {
295 return EFI_INVALID_PARAMETER
;
303 Register a notification function for a particular keystroke for the input device.
305 @param This Protocol instance pointer.
306 @param KeyData A pointer to a buffer that is filled in with the
307 keystroke information data for the key that was
309 @param KeyNotificationFunction Points to the function to be called when the key
310 sequence is typed specified by KeyData.
311 @param NotifyHandle Points to the unique handle assigned to the
312 registered notification.
314 @retval EFI_SUCCESS The notification function was registered
316 @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necessary data
318 @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.
323 TerminalConInRegisterKeyNotify (
324 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
325 IN EFI_KEY_DATA
*KeyData
,
326 IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction
,
327 OUT EFI_HANDLE
*NotifyHandle
330 TERMINAL_DEV
*TerminalDevice
;
331 TERMINAL_CONSOLE_IN_EX_NOTIFY
*NewNotify
;
333 LIST_ENTRY
*NotifyList
;
334 TERMINAL_CONSOLE_IN_EX_NOTIFY
*CurrentNotify
;
336 if (KeyData
== NULL
|| NotifyHandle
== NULL
|| KeyNotificationFunction
== NULL
) {
337 return EFI_INVALID_PARAMETER
;
340 TerminalDevice
= TERMINAL_CON_IN_EX_DEV_FROM_THIS (This
);
343 // Return EFI_SUCCESS if the (KeyData, NotificationFunction) is already registered.
345 NotifyList
= &TerminalDevice
->NotifyList
;
346 for (Link
= GetFirstNode (NotifyList
); !IsNull (NotifyList
,Link
); Link
= GetNextNode (NotifyList
,Link
)) {
349 TERMINAL_CONSOLE_IN_EX_NOTIFY
,
351 TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE
353 if (IsKeyRegistered (&CurrentNotify
->KeyData
, KeyData
)) {
354 if (CurrentNotify
->KeyNotificationFn
== KeyNotificationFunction
) {
355 *NotifyHandle
= CurrentNotify
->NotifyHandle
;
362 // Allocate resource to save the notification function
364 NewNotify
= (TERMINAL_CONSOLE_IN_EX_NOTIFY
*) AllocateZeroPool (sizeof (TERMINAL_CONSOLE_IN_EX_NOTIFY
));
365 if (NewNotify
== NULL
) {
366 return EFI_OUT_OF_RESOURCES
;
369 NewNotify
->Signature
= TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE
;
370 NewNotify
->KeyNotificationFn
= KeyNotificationFunction
;
371 NewNotify
->NotifyHandle
= (EFI_HANDLE
) NewNotify
;
372 CopyMem (&NewNotify
->KeyData
, KeyData
, sizeof (KeyData
));
373 InsertTailList (&TerminalDevice
->NotifyList
, &NewNotify
->NotifyEntry
);
375 *NotifyHandle
= NewNotify
->NotifyHandle
;
382 Remove a registered notification function from a particular keystroke.
384 @param This Protocol instance pointer.
385 @param NotificationHandle The handle of the notification function being
388 @retval EFI_SUCCESS The notification function was unregistered
390 @retval EFI_INVALID_PARAMETER The NotificationHandle is invalid.
395 TerminalConInUnregisterKeyNotify (
396 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
397 IN EFI_HANDLE NotificationHandle
400 TERMINAL_DEV
*TerminalDevice
;
402 TERMINAL_CONSOLE_IN_EX_NOTIFY
*CurrentNotify
;
403 LIST_ENTRY
*NotifyList
;
405 if (NotificationHandle
== NULL
) {
406 return EFI_INVALID_PARAMETER
;
409 if (((TERMINAL_CONSOLE_IN_EX_NOTIFY
*) NotificationHandle
)->Signature
!= TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE
) {
410 return EFI_INVALID_PARAMETER
;
413 TerminalDevice
= TERMINAL_CON_IN_EX_DEV_FROM_THIS (This
);
415 NotifyList
= &TerminalDevice
->NotifyList
;
416 for (Link
= GetFirstNode (NotifyList
); !IsNull (NotifyList
,Link
); Link
= GetNextNode (NotifyList
,Link
)) {
419 TERMINAL_CONSOLE_IN_EX_NOTIFY
,
421 TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE
423 if (CurrentNotify
->NotifyHandle
== NotificationHandle
) {
425 // Remove the notification function from NotifyList and free resources
427 RemoveEntryList (&CurrentNotify
->NotifyEntry
);
429 gBS
->FreePool (CurrentNotify
);
435 // Can not find the matching entry in database.
437 return EFI_INVALID_PARAMETER
;
441 Translate raw data into Unicode (according to different encode), and
442 translate Unicode into key information. (according to different standard).
444 @param TerminalDevice Terminal driver private structure.
448 TranslateRawDataToEfiKey (
449 IN TERMINAL_DEV
*TerminalDevice
452 switch (TerminalDevice
->TerminalType
) {
457 AnsiRawDataToUnicode (TerminalDevice
);
458 UnicodeToEfiKey (TerminalDevice
);
463 // Process all the raw data in the RawFIFO,
464 // put the processed key into UnicodeFIFO.
466 VTUTF8RawDataToUnicode (TerminalDevice
);
469 // Translate all the Unicode data in the UnicodeFIFO to Efi key,
470 // then put into EfiKeyFIFO.
472 UnicodeToEfiKey (TerminalDevice
);
479 Event notification function for EFI_SIMPLE_TEXT_INPUT_PROTOCOL.WaitForKey event
480 Signal the event if there is key available
482 @param Event Indicates the event that invoke this function.
483 @param Context Indicates the calling context.
488 TerminalConInWaitForKey (
494 // Someone is waiting on the keystroke event, if there's
495 // a key pending, signal the event
497 if (!IsEfiKeyFiFoEmpty ((TERMINAL_DEV
*) Context
)) {
499 gBS
->SignalEvent (Event
);
504 Timer handler to poll the key from serial.
506 @param Event Indicates the event that invoke this function.
507 @param Context Indicates the calling context.
511 TerminalConInTimerHandler (
517 TERMINAL_DEV
*TerminalDevice
;
519 EFI_SERIAL_IO_MODE
*Mode
;
520 EFI_SERIAL_IO_PROTOCOL
*SerialIo
;
521 UINTN SerialInTimeOut
;
523 TerminalDevice
= (TERMINAL_DEV
*) Context
;
525 SerialIo
= TerminalDevice
->SerialIo
;
526 if (SerialIo
== NULL
) {
530 // if current timeout value for serial device is not identical with
531 // the value saved in TERMINAL_DEV structure, then recalculate the
532 // timeout value again and set serial attribute according to this value.
534 Mode
= SerialIo
->Mode
;
535 if (Mode
->Timeout
!= TerminalDevice
->SerialInTimeOut
) {
538 if (Mode
->BaudRate
!= 0) {
540 // According to BAUD rate to calculate the timeout value.
542 SerialInTimeOut
= (1 + Mode
->DataBits
+ Mode
->StopBits
) * 2 * 1000000 / (UINTN
) Mode
->BaudRate
;
545 Status
= SerialIo
->SetAttributes (
548 Mode
->ReceiveFifoDepth
,
549 (UINT32
) SerialInTimeOut
,
550 (EFI_PARITY_TYPE
) (Mode
->Parity
),
551 (UINT8
) Mode
->DataBits
,
552 (EFI_STOP_BITS_TYPE
) (Mode
->StopBits
)
555 if (EFI_ERROR (Status
)) {
556 TerminalDevice
->SerialInTimeOut
= 0;
558 TerminalDevice
->SerialInTimeOut
= SerialInTimeOut
;
563 // Fetch all the keys in the serial buffer,
564 // and insert the byte stream into RawFIFO.
566 while( !IsRawFiFoFull(TerminalDevice
) ) {
568 Status
= GetOneKeyFromSerial (TerminalDevice
->SerialIo
, &Input
);
570 if (EFI_ERROR (Status
)) {
571 if (Status
== EFI_DEVICE_ERROR
) {
572 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
573 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
574 (EFI_PERIPHERAL_REMOTE_CONSOLE
| EFI_P_EC_INPUT_ERROR
),
575 TerminalDevice
->DevicePath
581 RawFiFoInsertOneKey (TerminalDevice
, Input
);
585 // Translate all the raw data in RawFIFO into EFI Key,
586 // according to different terminal type supported.
588 TranslateRawDataToEfiKey (TerminalDevice
);
592 Get one key out of serial buffer.
594 @param SerialIo Serial I/O protocol attached to the serial device.
595 @param Output The fetched key.
597 @retval EFI_NOT_READY If serial buffer is empty.
598 @retval EFI_DEVICE_ERROR If reading serial buffer encounter error.
599 @retval EFI_SUCCESS If reading serial buffer successfully, put
600 the fetched key to the parameter output.
604 GetOneKeyFromSerial (
605 EFI_SERIAL_IO_PROTOCOL
*SerialIo
,
616 // Read one key from serial I/O device.
618 Status
= SerialIo
->Read (SerialIo
, &Size
, Output
);
620 if (EFI_ERROR (Status
)) {
622 if (Status
== EFI_TIMEOUT
) {
623 return EFI_NOT_READY
;
626 return EFI_DEVICE_ERROR
;
631 return EFI_NOT_READY
;
638 Insert one byte raw data into the Raw Data FIFO.
640 @param TerminalDevice Terminal driver private structure.
641 @param Input The key will be input.
643 @retval TRUE If insert successfully.
644 @retval FLASE If Raw Data buffer is full before key insertion,
649 RawFiFoInsertOneKey (
650 TERMINAL_DEV
*TerminalDevice
,
656 Tail
= TerminalDevice
->RawFiFo
->Tail
;
658 if (IsRawFiFoFull (TerminalDevice
)) {
665 TerminalDevice
->RawFiFo
->Data
[Tail
] = Input
;
667 TerminalDevice
->RawFiFo
->Tail
= (UINT8
) ((Tail
+ 1) % (RAW_FIFO_MAX_NUMBER
+ 1));
673 Remove one pre-fetched key out of the Raw Data FIFO.
675 @param TerminalDevice Terminal driver private structure.
676 @param Output The key will be removed.
678 @retval TRUE If insert successfully.
679 @retval FLASE If Raw Data FIFO buffer is empty before remove operation.
683 RawFiFoRemoveOneKey (
684 TERMINAL_DEV
*TerminalDevice
,
690 Head
= TerminalDevice
->RawFiFo
->Head
;
692 if (IsRawFiFoEmpty (TerminalDevice
)) {
700 *Output
= TerminalDevice
->RawFiFo
->Data
[Head
];
702 TerminalDevice
->RawFiFo
->Head
= (UINT8
) ((Head
+ 1) % (RAW_FIFO_MAX_NUMBER
+ 1));
708 Clarify whether Raw Data FIFO buffer is empty.
710 @param TerminalDevice Terminal driver private structure
712 @retval TRUE If Raw Data FIFO buffer is empty.
713 @retval FLASE If Raw Data FIFO buffer is not empty.
718 TERMINAL_DEV
*TerminalDevice
721 if (TerminalDevice
->RawFiFo
->Head
== TerminalDevice
->RawFiFo
->Tail
) {
729 Clarify whether Raw Data FIFO buffer is full.
731 @param TerminalDevice Terminal driver private structure
733 @retval TRUE If Raw Data FIFO buffer is full.
734 @retval FLASE If Raw Data FIFO buffer is not full.
739 TERMINAL_DEV
*TerminalDevice
745 Tail
= TerminalDevice
->RawFiFo
->Tail
;
746 Head
= TerminalDevice
->RawFiFo
->Head
;
748 if (((Tail
+ 1) % (RAW_FIFO_MAX_NUMBER
+ 1)) == Head
) {
757 Insert one pre-fetched key into the FIFO buffer.
759 @param TerminalDevice Terminal driver private structure.
760 @param Key The key will be input.
762 @retval TRUE If insert successfully.
763 @retval FLASE If FIFO buffer is full before key insertion,
768 EfiKeyFiFoInsertOneKey (
769 TERMINAL_DEV
*TerminalDevice
,
775 LIST_ENTRY
*NotifyList
;
776 TERMINAL_CONSOLE_IN_EX_NOTIFY
*CurrentNotify
;
777 EFI_KEY_DATA KeyData
;
779 Tail
= TerminalDevice
->EfiKeyFiFo
->Tail
;
781 CopyMem (&KeyData
.Key
, Key
, sizeof (EFI_INPUT_KEY
));
782 KeyData
.KeyState
.KeyShiftState
= 0;
783 KeyData
.KeyState
.KeyToggleState
= 0;
786 // Invoke notification functions if exist
788 NotifyList
= &TerminalDevice
->NotifyList
;
789 for (Link
= GetFirstNode (NotifyList
); !IsNull (NotifyList
,Link
); Link
= GetNextNode (NotifyList
,Link
)) {
792 TERMINAL_CONSOLE_IN_EX_NOTIFY
,
794 TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE
796 if (IsKeyRegistered (&CurrentNotify
->KeyData
, &KeyData
)) {
797 CurrentNotify
->KeyNotificationFn (&KeyData
);
800 if (IsEfiKeyFiFoFull (TerminalDevice
)) {
802 // Efi Key FIFO is full
807 CopyMem (&TerminalDevice
->EfiKeyFiFo
->Data
[Tail
], Key
, sizeof (EFI_INPUT_KEY
));
809 TerminalDevice
->EfiKeyFiFo
->Tail
= (UINT8
) ((Tail
+ 1) % (FIFO_MAX_NUMBER
+ 1));
815 Remove one pre-fetched key out of the FIFO buffer.
817 @param TerminalDevice Terminal driver private structure.
818 @param Output The key will be removed.
820 @retval TRUE If insert successfully.
821 @retval FLASE If FIFO buffer is empty before remove operation.
825 EfiKeyFiFoRemoveOneKey (
826 TERMINAL_DEV
*TerminalDevice
,
827 EFI_INPUT_KEY
*Output
832 Head
= TerminalDevice
->EfiKeyFiFo
->Head
;
833 ASSERT (Head
< FIFO_MAX_NUMBER
+ 1);
835 if (IsEfiKeyFiFoEmpty (TerminalDevice
)) {
839 Output
->ScanCode
= SCAN_NULL
;
840 Output
->UnicodeChar
= 0;
844 *Output
= TerminalDevice
->EfiKeyFiFo
->Data
[Head
];
846 TerminalDevice
->EfiKeyFiFo
->Head
= (UINT8
) ((Head
+ 1) % (FIFO_MAX_NUMBER
+ 1));
852 Clarify whether FIFO buffer is empty.
854 @param TerminalDevice Terminal driver private structure
856 @retval TRUE If FIFO buffer is empty.
857 @retval FLASE If FIFO buffer is not empty.
862 TERMINAL_DEV
*TerminalDevice
865 if (TerminalDevice
->EfiKeyFiFo
->Head
== TerminalDevice
->EfiKeyFiFo
->Tail
) {
873 Clarify whether FIFO buffer is full.
875 @param TerminalDevice Terminal driver private structure
877 @retval TRUE If FIFO buffer is full.
878 @retval FLASE If FIFO buffer is not full.
883 TERMINAL_DEV
*TerminalDevice
889 Tail
= TerminalDevice
->EfiKeyFiFo
->Tail
;
890 Head
= TerminalDevice
->EfiKeyFiFo
->Head
;
892 if (((Tail
+ 1) % (FIFO_MAX_NUMBER
+ 1)) == Head
) {
901 Insert one pre-fetched key into the Unicode FIFO buffer.
903 @param TerminalDevice Terminal driver private structure.
904 @param Input The key will be input.
906 @retval TRUE If insert successfully.
907 @retval FLASE If Unicode FIFO buffer is full before key insertion,
912 UnicodeFiFoInsertOneKey (
913 TERMINAL_DEV
*TerminalDevice
,
919 Tail
= TerminalDevice
->UnicodeFiFo
->Tail
;
920 ASSERT (Tail
< FIFO_MAX_NUMBER
+ 1);
923 if (IsUnicodeFiFoFull (TerminalDevice
)) {
925 // Unicode FIFO is full
930 TerminalDevice
->UnicodeFiFo
->Data
[Tail
] = Input
;
932 TerminalDevice
->UnicodeFiFo
->Tail
= (UINT8
) ((Tail
+ 1) % (FIFO_MAX_NUMBER
+ 1));
938 Remove one pre-fetched key out of the Unicode FIFO buffer.
940 @param TerminalDevice Terminal driver private structure.
941 @param Output The key will be removed.
943 @retval TRUE If insert successfully.
944 @retval FLASE If Unicode FIFO buffer is empty before remove operation.
948 UnicodeFiFoRemoveOneKey (
949 TERMINAL_DEV
*TerminalDevice
,
955 Head
= TerminalDevice
->UnicodeFiFo
->Head
;
956 ASSERT (Head
< FIFO_MAX_NUMBER
+ 1);
958 if (IsUnicodeFiFoEmpty (TerminalDevice
)) {
966 *Output
= TerminalDevice
->UnicodeFiFo
->Data
[Head
];
968 TerminalDevice
->UnicodeFiFo
->Head
= (UINT8
) ((Head
+ 1) % (FIFO_MAX_NUMBER
+ 1));
974 Clarify whether Unicode FIFO buffer is empty.
976 @param TerminalDevice Terminal driver private structure
978 @retval TRUE If Unicode FIFO buffer is empty.
979 @retval FLASE If Unicode FIFO buffer is not empty.
984 TERMINAL_DEV
*TerminalDevice
987 if (TerminalDevice
->UnicodeFiFo
->Head
== TerminalDevice
->UnicodeFiFo
->Tail
) {
995 Clarify whether Unicode FIFO buffer is full.
997 @param TerminalDevice Terminal driver private structure
999 @retval TRUE If Unicode FIFO buffer is full.
1000 @retval FLASE If Unicode FIFO buffer is not full.
1005 TERMINAL_DEV
*TerminalDevice
1011 Tail
= TerminalDevice
->UnicodeFiFo
->Tail
;
1012 Head
= TerminalDevice
->UnicodeFiFo
->Head
;
1014 if (((Tail
+ 1) % (FIFO_MAX_NUMBER
+ 1)) == Head
) {
1023 Count Unicode FIFO buffer.
1025 @param TerminalDevice Terminal driver private structure
1027 @return The count in bytes of Unicode FIFO.
1031 UnicodeFiFoGetKeyCount (
1032 TERMINAL_DEV
*TerminalDevice
1038 Tail
= TerminalDevice
->UnicodeFiFo
->Tail
;
1039 Head
= TerminalDevice
->UnicodeFiFo
->Head
;
1042 return (UINT8
) (Tail
- Head
);
1044 return (UINT8
) (Tail
+ FIFO_MAX_NUMBER
+ 1 - Head
);
1049 Update the Unicode characters from a terminal input device into EFI Keys FIFO.
1051 @param TerminalDevice The terminal device to use to translate raw input into EFI Keys
1055 UnicodeToEfiKeyFlushState (
1056 IN TERMINAL_DEV
*TerminalDevice
1062 InputState
= TerminalDevice
->InputState
;
1064 if( IsEfiKeyFiFoFull(TerminalDevice
) ) return;
1066 if ((InputState
& INPUT_STATE_ESC
) != 0) {
1067 Key
.ScanCode
= SCAN_ESC
;
1068 Key
.UnicodeChar
= 0;
1069 EfiKeyFiFoInsertOneKey (TerminalDevice
, &Key
);
1072 if ((InputState
& INPUT_STATE_CSI
) != 0) {
1073 Key
.ScanCode
= SCAN_NULL
;
1074 Key
.UnicodeChar
= CSI
;
1075 EfiKeyFiFoInsertOneKey (TerminalDevice
, &Key
);
1078 if ((InputState
& INPUT_STATE_LEFTOPENBRACKET
) != 0) {
1079 Key
.ScanCode
= SCAN_NULL
;
1080 Key
.UnicodeChar
= LEFTOPENBRACKET
;
1081 EfiKeyFiFoInsertOneKey (TerminalDevice
, &Key
);
1084 if ((InputState
& INPUT_STATE_O
) != 0) {
1085 Key
.ScanCode
= SCAN_NULL
;
1086 Key
.UnicodeChar
= 'O';
1087 EfiKeyFiFoInsertOneKey (TerminalDevice
, &Key
);
1090 if ((InputState
& INPUT_STATE_2
) != 0) {
1091 Key
.ScanCode
= SCAN_NULL
;
1092 Key
.UnicodeChar
= '2';
1093 EfiKeyFiFoInsertOneKey (TerminalDevice
, &Key
);
1097 // Cancel the timer.
1100 TerminalDevice
->TwoSecondTimeOut
,
1105 TerminalDevice
->InputState
= INPUT_STATE_DEFAULT
;
1110 Converts a stream of Unicode characters from a terminal input device into EFI Keys that
1111 can be read through the Simple Input Protocol.
1113 The table below shows the keyboard input mappings that this function supports.
1114 If the ESC sequence listed in one of the columns is presented, then it is translated
1115 into the corresponding EFI Scan Code. If a matching sequence is not found, then the raw
1116 key strokes are converted into EFI Keys.
1118 2 seconds are allowed for an ESC sequence to be completed. If the ESC sequence is not
1119 completed in 2 seconds, then the raw key strokes of the partial ESC sequence are
1120 converted into EFI Keys.
1121 There is one special input sequence that will force the system to reset.
1122 This is ESC R ESC r ESC R.
1124 Note: current implementation support terminal types include: PC ANSI, VT100+/VTUTF8, VT100.
1125 The table below is not same with UEFI Spec 2.3 Appendix B Table 201(not support ANSI X3.64 /
1126 DEC VT200-500 and extra support PC ANSI, VT100)since UEFI Table 201 is just an example.
1128 Symbols used in table below
1129 ===========================
1135 +=========+======+===========+==========+==========+
1136 | | EFI | UEFI 2.0 | | |
1137 | | Scan | | VT100+ | |
1138 | KEY | Code | PC ANSI | VTUTF8 | VT100 |
1139 +=========+======+===========+==========+==========+
1140 | NULL | 0x00 | | | |
1141 | UP | 0x01 | ESC [ A | ESC [ A | ESC [ A |
1142 | DOWN | 0x02 | ESC [ B | ESC [ B | ESC [ B |
1143 | RIGHT | 0x03 | ESC [ C | ESC [ C | ESC [ C |
1144 | LEFT | 0x04 | ESC [ D | ESC [ D | ESC [ D |
1145 | HOME | 0x05 | ESC [ H | ESC h | ESC [ H |
1146 | END | 0x06 | ESC [ F | ESC k | ESC [ K |
1147 | INSERT | 0x07 | ESC [ @ | ESC + | ESC [ @ |
1148 | | | ESC [ L | | ESC [ L |
1149 | DELETE | 0x08 | ESC [ X | ESC - | ESC [ P |
1150 | PG UP | 0x09 | ESC [ I | ESC ? | ESC [ V |
1152 | PG DOWN | 0x0A | ESC [ G | ESC / | ESC [ U |
1154 | F1 | 0x0B | ESC [ M | ESC 1 | ESC O P |
1155 | F2 | 0x0C | ESC [ N | ESC 2 | ESC O Q |
1156 | F3 | 0x0D | ESC [ O | ESC 3 | ESC O w |
1157 | F4 | 0x0E | ESC [ P | ESC 4 | ESC O x |
1158 | F5 | 0x0F | ESC [ Q | ESC 5 | ESC O t |
1159 | F6 | 0x10 | ESC [ R | ESC 6 | ESC O u |
1160 | F7 | 0x11 | ESC [ S | ESC 7 | ESC O q |
1161 | F8 | 0x12 | ESC [ T | ESC 8 | ESC O r |
1162 | F9 | 0x13 | ESC [ U | ESC 9 | ESC O p |
1163 | F10 | 0x14 | ESC [ V | ESC 0 | ESC O M |
1164 | Escape | 0x17 | ESC | ESC | ESC |
1165 | F11 | 0x15 | | ESC ! | |
1166 | F12 | 0x16 | | ESC @ | |
1167 +=========+======+===========+==========+==========+
1171 ESC R ESC r ESC R = Reset System
1173 @param TerminalDevice The terminal device to use to translate raw input into EFI Keys
1178 IN TERMINAL_DEV
*TerminalDevice
1182 EFI_STATUS TimerStatus
;
1185 BOOLEAN SetDefaultResetState
;
1187 TimerStatus
= gBS
->CheckEvent (TerminalDevice
->TwoSecondTimeOut
);
1189 if (!EFI_ERROR (TimerStatus
)) {
1190 UnicodeToEfiKeyFlushState (TerminalDevice
);
1191 TerminalDevice
->ResetState
= RESET_STATE_DEFAULT
;
1194 while (!IsUnicodeFiFoEmpty(TerminalDevice
) && !IsEfiKeyFiFoFull(TerminalDevice
) ) {
1196 if (TerminalDevice
->InputState
!= INPUT_STATE_DEFAULT
) {
1198 // Check to see if the 2 seconds timer has expired
1200 TimerStatus
= gBS
->CheckEvent (TerminalDevice
->TwoSecondTimeOut
);
1201 if (!EFI_ERROR (TimerStatus
)) {
1202 UnicodeToEfiKeyFlushState (TerminalDevice
);
1203 TerminalDevice
->ResetState
= RESET_STATE_DEFAULT
;
1208 // Fetch one Unicode character from the Unicode FIFO
1210 UnicodeFiFoRemoveOneKey (TerminalDevice
, &UnicodeChar
);
1212 SetDefaultResetState
= TRUE
;
1214 switch (TerminalDevice
->InputState
) {
1215 case INPUT_STATE_DEFAULT
:
1219 case INPUT_STATE_ESC
:
1221 if (UnicodeChar
== LEFTOPENBRACKET
) {
1222 TerminalDevice
->InputState
|= INPUT_STATE_LEFTOPENBRACKET
;
1223 TerminalDevice
->ResetState
= RESET_STATE_DEFAULT
;
1227 if (UnicodeChar
== 'O' && TerminalDevice
->TerminalType
== VT100TYPE
) {
1228 TerminalDevice
->InputState
|= INPUT_STATE_O
;
1229 TerminalDevice
->ResetState
= RESET_STATE_DEFAULT
;
1233 Key
.ScanCode
= SCAN_NULL
;
1235 if (TerminalDevice
->TerminalType
== VT100PLUSTYPE
||
1236 TerminalDevice
->TerminalType
== VTUTF8TYPE
) {
1237 switch (UnicodeChar
) {
1239 Key
.ScanCode
= SCAN_F1
;
1242 Key
.ScanCode
= SCAN_F2
;
1245 Key
.ScanCode
= SCAN_F3
;
1248 Key
.ScanCode
= SCAN_F4
;
1251 Key
.ScanCode
= SCAN_F5
;
1254 Key
.ScanCode
= SCAN_F6
;
1257 Key
.ScanCode
= SCAN_F7
;
1260 Key
.ScanCode
= SCAN_F8
;
1263 Key
.ScanCode
= SCAN_F9
;
1266 Key
.ScanCode
= SCAN_F10
;
1269 Key
.ScanCode
= SCAN_F11
;
1272 Key
.ScanCode
= SCAN_F12
;
1275 Key
.ScanCode
= SCAN_HOME
;
1278 Key
.ScanCode
= SCAN_END
;
1281 Key
.ScanCode
= SCAN_INSERT
;
1284 Key
.ScanCode
= SCAN_DELETE
;
1287 Key
.ScanCode
= SCAN_PAGE_DOWN
;
1290 Key
.ScanCode
= SCAN_PAGE_UP
;
1297 switch (UnicodeChar
) {
1299 if (TerminalDevice
->ResetState
== RESET_STATE_DEFAULT
) {
1300 TerminalDevice
->ResetState
= RESET_STATE_ESC_R
;
1301 SetDefaultResetState
= FALSE
;
1302 } else if (TerminalDevice
->ResetState
== RESET_STATE_ESC_R_ESC_R
) {
1303 gRT
->ResetSystem (EfiResetWarm
, EFI_SUCCESS
, 0, NULL
);
1305 Key
.ScanCode
= SCAN_NULL
;
1308 if (TerminalDevice
->ResetState
== RESET_STATE_ESC_R
) {
1309 TerminalDevice
->ResetState
= RESET_STATE_ESC_R_ESC_R
;
1310 SetDefaultResetState
= FALSE
;
1312 Key
.ScanCode
= SCAN_NULL
;
1318 if (SetDefaultResetState
) {
1319 TerminalDevice
->ResetState
= RESET_STATE_DEFAULT
;
1322 if (Key
.ScanCode
!= SCAN_NULL
) {
1323 Key
.UnicodeChar
= 0;
1324 EfiKeyFiFoInsertOneKey (TerminalDevice
, &Key
);
1325 TerminalDevice
->InputState
= INPUT_STATE_DEFAULT
;
1326 UnicodeToEfiKeyFlushState (TerminalDevice
);
1330 UnicodeToEfiKeyFlushState (TerminalDevice
);
1334 case INPUT_STATE_ESC
| INPUT_STATE_O
:
1336 TerminalDevice
->ResetState
= RESET_STATE_DEFAULT
;
1338 Key
.ScanCode
= SCAN_NULL
;
1340 if (TerminalDevice
->TerminalType
== VT100TYPE
) {
1341 switch (UnicodeChar
) {
1343 Key
.ScanCode
= SCAN_F1
;
1346 Key
.ScanCode
= SCAN_F2
;
1349 Key
.ScanCode
= SCAN_F3
;
1352 Key
.ScanCode
= SCAN_F4
;
1355 Key
.ScanCode
= SCAN_F5
;
1358 Key
.ScanCode
= SCAN_F6
;
1361 Key
.ScanCode
= SCAN_F7
;
1364 Key
.ScanCode
= SCAN_F8
;
1367 Key
.ScanCode
= SCAN_F9
;
1370 Key
.ScanCode
= SCAN_F10
;
1377 if (Key
.ScanCode
!= SCAN_NULL
) {
1378 Key
.UnicodeChar
= 0;
1379 EfiKeyFiFoInsertOneKey (TerminalDevice
, &Key
);
1380 TerminalDevice
->InputState
= INPUT_STATE_DEFAULT
;
1381 UnicodeToEfiKeyFlushState (TerminalDevice
);
1385 UnicodeToEfiKeyFlushState (TerminalDevice
);
1389 case INPUT_STATE_ESC
| INPUT_STATE_LEFTOPENBRACKET
:
1391 TerminalDevice
->ResetState
= RESET_STATE_DEFAULT
;
1393 Key
.ScanCode
= SCAN_NULL
;
1395 if (TerminalDevice
->TerminalType
== PCANSITYPE
||
1396 TerminalDevice
->TerminalType
== VT100TYPE
||
1397 TerminalDevice
->TerminalType
== VT100PLUSTYPE
||
1398 TerminalDevice
->TerminalType
== VTUTF8TYPE
) {
1399 switch (UnicodeChar
) {
1401 Key
.ScanCode
= SCAN_UP
;
1404 Key
.ScanCode
= SCAN_DOWN
;
1407 Key
.ScanCode
= SCAN_RIGHT
;
1410 Key
.ScanCode
= SCAN_LEFT
;
1413 if (TerminalDevice
->TerminalType
== PCANSITYPE
||
1414 TerminalDevice
->TerminalType
== VT100TYPE
) {
1415 Key
.ScanCode
= SCAN_HOME
;
1419 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1420 Key
.ScanCode
= SCAN_END
;
1424 if (TerminalDevice
->TerminalType
== VT100TYPE
) {
1425 Key
.ScanCode
= SCAN_END
;
1430 if (TerminalDevice
->TerminalType
== PCANSITYPE
||
1431 TerminalDevice
->TerminalType
== VT100TYPE
) {
1432 Key
.ScanCode
= SCAN_INSERT
;
1436 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1437 Key
.ScanCode
= SCAN_DELETE
;
1441 if (TerminalDevice
->TerminalType
== VT100TYPE
) {
1442 Key
.ScanCode
= SCAN_DELETE
;
1443 } else if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1444 Key
.ScanCode
= SCAN_F4
;
1448 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1449 Key
.ScanCode
= SCAN_PAGE_UP
;
1453 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1454 Key
.ScanCode
= SCAN_F10
;
1457 if (TerminalDevice
->TerminalType
== VT100TYPE
) {
1458 Key
.ScanCode
= SCAN_PAGE_UP
;
1462 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1463 Key
.ScanCode
= SCAN_PAGE_DOWN
;
1467 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1468 Key
.ScanCode
= SCAN_F9
;
1471 if (TerminalDevice
->TerminalType
== VT100TYPE
) {
1472 Key
.ScanCode
= SCAN_PAGE_DOWN
;
1476 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1477 Key
.ScanCode
= SCAN_F1
;
1481 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1482 Key
.ScanCode
= SCAN_F2
;
1486 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1487 Key
.ScanCode
= SCAN_F3
;
1491 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1492 Key
.ScanCode
= SCAN_F5
;
1496 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1497 Key
.ScanCode
= SCAN_F6
;
1501 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1502 Key
.ScanCode
= SCAN_F7
;
1506 if (TerminalDevice
->TerminalType
== PCANSITYPE
) {
1507 Key
.ScanCode
= SCAN_F8
;
1515 if (Key
.ScanCode
!= SCAN_NULL
) {
1516 Key
.UnicodeChar
= 0;
1517 EfiKeyFiFoInsertOneKey (TerminalDevice
, &Key
);
1518 TerminalDevice
->InputState
= INPUT_STATE_DEFAULT
;
1519 UnicodeToEfiKeyFlushState (TerminalDevice
);
1523 UnicodeToEfiKeyFlushState (TerminalDevice
);
1530 // Invalid state. This should never happen.
1534 UnicodeToEfiKeyFlushState (TerminalDevice
);
1539 if (UnicodeChar
== ESC
) {
1540 TerminalDevice
->InputState
= INPUT_STATE_ESC
;
1543 if (UnicodeChar
== CSI
) {
1544 TerminalDevice
->InputState
= INPUT_STATE_CSI
;
1547 if (TerminalDevice
->InputState
!= INPUT_STATE_DEFAULT
) {
1548 Status
= gBS
->SetTimer(
1549 TerminalDevice
->TwoSecondTimeOut
,
1553 ASSERT_EFI_ERROR (Status
);
1557 if (SetDefaultResetState
) {
1558 TerminalDevice
->ResetState
= RESET_STATE_DEFAULT
;
1561 if (UnicodeChar
== DEL
) {
1562 Key
.ScanCode
= SCAN_DELETE
;
1563 Key
.UnicodeChar
= 0;
1565 Key
.ScanCode
= SCAN_NULL
;
1566 Key
.UnicodeChar
= UnicodeChar
;
1569 EfiKeyFiFoInsertOneKey (TerminalDevice
, &Key
);