2 Header file for Terminal driver.
4 Copyright (c) 2006 - 2010, Intel Corporation. <BR>
5 All rights reserved. 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.
21 #include <Guid/GlobalVariable.h>
22 #include <Guid/PcAnsi.h>
24 #include <Protocol/SimpleTextOut.h>
25 #include <Protocol/SerialIo.h>
26 #include <Protocol/DevicePath.h>
27 #include <Protocol/SimpleTextIn.h>
28 #include <Protocol/SimpleTextInEx.h>
30 #include <Library/DebugLib.h>
31 #include <Library/UefiDriverEntryPoint.h>
32 #include <Library/UefiLib.h>
33 #include <Library/ReportStatusCodeLib.h>
34 #include <Library/BaseMemoryLib.h>
35 #include <Library/MemoryAllocationLib.h>
36 #include <Library/UefiBootServicesTableLib.h>
37 #include <Library/UefiRuntimeServicesTableLib.h>
38 #include <Library/DevicePathLib.h>
39 #include <Library/PcdLib.h>
40 #include <Library/BaseLib.h>
43 #define RAW_FIFO_MAX_NUMBER 256
44 #define FIFO_MAX_NUMBER 128
49 UINT8 Data
[RAW_FIFO_MAX_NUMBER
+ 1];
55 UINT16 Data
[FIFO_MAX_NUMBER
+ 1];
61 EFI_INPUT_KEY Data
[FIFO_MAX_NUMBER
+ 1];
64 #define TERMINAL_DEV_SIGNATURE SIGNATURE_32 ('t', 'm', 'n', 'l')
66 #define TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('t', 'm', 'e', 'n')
68 typedef struct _TERMINAL_CONSOLE_IN_EX_NOTIFY
{
70 EFI_HANDLE NotifyHandle
;
72 EFI_KEY_NOTIFY_FUNCTION KeyNotificationFn
;
73 LIST_ENTRY NotifyEntry
;
74 } TERMINAL_CONSOLE_IN_EX_NOTIFY
;
79 EFI_SERIAL_IO_PROTOCOL
*SerialIo
;
80 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
81 EFI_SIMPLE_TEXT_INPUT_PROTOCOL SimpleInput
;
82 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SimpleTextOutput
;
83 EFI_SIMPLE_TEXT_OUTPUT_MODE SimpleTextOutputMode
;
84 UINTN SerialInTimeOut
;
85 RAW_DATA_FIFO
*RawFiFo
;
86 UNICODE_FIFO
*UnicodeFiFo
;
87 EFI_KEY_FIFO
*EfiKeyFiFo
;
88 EFI_UNICODE_STRING_TABLE
*ControllerNameTable
;
89 EFI_EVENT TwoSecondTimeOut
;
94 // Esc could not be output to the screen by user,
95 // but the terminal driver need to output it to
96 // the terminal emulation software to send control sequence.
97 // This boolean is used by the terminal driver only
98 // to indicate whether the Esc could be sent or not.
100 BOOLEAN OutputEscChar
;
101 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL SimpleInputEx
;
102 LIST_ENTRY NotifyList
;
105 #define INPUT_STATE_DEFAULT 0x00
106 #define INPUT_STATE_ESC 0x01
107 #define INPUT_STATE_CSI 0x02
108 #define INPUT_STATE_LEFTOPENBRACKET 0x04
109 #define INPUT_STATE_O 0x08
110 #define INPUT_STATE_2 0x10
112 #define RESET_STATE_DEFAULT 0x00
113 #define RESET_STATE_ESC_R 0x01
114 #define RESET_STATE_ESC_R_ESC_R 0x02
116 #define TERMINAL_CON_IN_DEV_FROM_THIS(a) CR (a, TERMINAL_DEV, SimpleInput, TERMINAL_DEV_SIGNATURE)
117 #define TERMINAL_CON_OUT_DEV_FROM_THIS(a) CR (a, TERMINAL_DEV, SimpleTextOutput, TERMINAL_DEV_SIGNATURE)
118 #define TERMINAL_CON_IN_EX_DEV_FROM_THIS(a) CR (a, TERMINAL_DEV, SimpleInputEx, TERMINAL_DEV_SIGNATURE)
128 #define VT100PLUSTYPE 2
131 #define LEFTOPENBRACKET 0x5b // '['
137 #define MODE0_COLUMN_COUNT 80
138 #define MODE0_ROW_COUNT 25
140 #define MODE1_COLUMN_COUNT 80
141 #define MODE1_ROW_COUNT 50
143 #define MODE2_COLUMN_COUNT 100
144 #define MODE2_ROW_COUNT 31
150 #define BRIGHT_CONTROL_OFFSET 2
151 #define FOREGROUND_CONTROL_OFFSET 6
152 #define BACKGROUND_CONTROL_OFFSET 11
154 #define COLUMN_OFFSET 5
165 extern EFI_DRIVER_BINDING_PROTOCOL gTerminalDriverBinding
;
166 extern EFI_COMPONENT_NAME_PROTOCOL gTerminalComponentName
;
167 extern EFI_COMPONENT_NAME2_PROTOCOL gTerminalComponentName2
;
170 The user Entry Point for module Terminal. The user code starts with this function.
172 @param[in] ImageHandle The firmware allocated handle for the EFI image.
173 @param[in] SystemTable A pointer to the EFI System Table.
175 @retval EFI_SUCCESS The entry point is executed successfully.
176 @retval other Some error occurs when executing this entry point.
182 IN EFI_HANDLE ImageHandle
,
183 IN EFI_SYSTEM_TABLE
*SystemTable
187 Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.Reset().
188 This driver only perform dependent serial device reset regardless of
189 the value of ExtendeVerification
191 @param This Indicates the calling context.
192 @param ExtendedVerification Skip by this driver.
194 @retval EFI_SUCCESS The reset operation succeeds.
195 @retval EFI_DEVICE_ERROR The dependent serial port reset fails.
201 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*This
,
202 IN BOOLEAN ExtendedVerification
207 Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().
209 @param This Indicates the calling context.
210 @param Key A pointer to a buffer that is filled in with the
211 keystroke information for the key that was sent
214 @retval EFI_SUCCESS The keystroke information is returned successfully.
215 @retval EFI_NOT_READY There is no keystroke data available.
216 @retval EFI_DEVICE_ERROR The dependent serial device encounters error.
221 TerminalConInReadKeyStroke (
222 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*This
,
223 OUT EFI_INPUT_KEY
*Key
227 Check if the key already has been registered.
229 @param RegsiteredData A pointer to a buffer that is filled in with the
230 keystroke state data for the key that was
232 @param InputData A pointer to a buffer that is filled in with the
233 keystroke state data for the key that was
236 @retval TRUE Key be pressed matches a registered key.
237 @retval FLASE Match failed.
242 IN EFI_KEY_DATA
*RegsiteredData
,
243 IN EFI_KEY_DATA
*InputData
247 Event notification function for EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event
248 Signal the event if there is key available
250 @param Event Indicates the event that invoke this function.
251 @param Context Indicates the calling context.
256 TerminalConInWaitForKeyEx (
262 // Simple Text Input Ex protocol prototypes
266 Reset the input device and optionally run diagnostics
268 @param This Protocol instance pointer.
269 @param ExtendedVerification Driver may perform diagnostics on reset.
271 @retval EFI_SUCCESS The device was reset.
272 @retval EFI_DEVICE_ERROR The device is not functioning properly and could
278 TerminalConInResetEx (
279 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
280 IN BOOLEAN ExtendedVerification
284 Reads the next keystroke from the input device. The WaitForKey Event can
285 be used to test for existence of a keystroke via WaitForEvent () call.
287 @param This Protocol instance pointer.
288 @param KeyData A pointer to a buffer that is filled in with the
289 keystroke state data for the key that was
292 @retval EFI_SUCCESS The keystroke information was returned.
293 @retval EFI_NOT_READY There was no keystroke data available.
294 @retval EFI_DEVICE_ERROR The keystroke information was not returned due
296 @retval EFI_INVALID_PARAMETER KeyData is NULL.
301 TerminalConInReadKeyStrokeEx (
302 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
303 OUT EFI_KEY_DATA
*KeyData
307 Set certain state for the input device.
309 @param This Protocol instance pointer.
310 @param KeyToggleState A pointer to the EFI_KEY_TOGGLE_STATE to set the
311 state for the input device.
313 @retval EFI_SUCCESS The device state was set successfully.
314 @retval EFI_DEVICE_ERROR The device is not functioning correctly and
315 could not have the setting adjusted.
316 @retval EFI_UNSUPPORTED The device does not have the ability to set its
318 @retval EFI_INVALID_PARAMETER KeyToggleState is NULL.
323 TerminalConInSetState (
324 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
325 IN EFI_KEY_TOGGLE_STATE
*KeyToggleState
329 Register a notification function for a particular keystroke for the input device.
331 @param This Protocol instance pointer.
332 @param KeyData A pointer to a buffer that is filled in with the
333 keystroke information data for the key that was
335 @param KeyNotificationFunction Points to the function to be called when the key
336 sequence is typed specified by KeyData.
337 @param NotifyHandle Points to the unique handle assigned to the
338 registered notification.
340 @retval EFI_SUCCESS The notification function was registered
342 @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data
344 @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.
349 TerminalConInRegisterKeyNotify (
350 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
351 IN EFI_KEY_DATA
*KeyData
,
352 IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction
,
353 OUT EFI_HANDLE
*NotifyHandle
357 Remove a registered notification function from a particular keystroke.
359 @param This Protocol instance pointer.
360 @param NotificationHandle The handle of the notification function being
363 @retval EFI_SUCCESS The notification function was unregistered
365 @retval EFI_INVALID_PARAMETER The NotificationHandle is invalid.
366 @retval EFI_NOT_FOUND Can not find the matching entry in database.
371 TerminalConInUnregisterKeyNotify (
372 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*This
,
373 IN EFI_HANDLE NotificationHandle
377 Event notification function for EFI_SIMPLE_TEXT_INPUT_PROTOCOL.WaitForKey event
378 Signal the event if there is key available
380 @param Event Indicates the event that invoke this function.
381 @param Context Indicates the calling context.
386 TerminalConInWaitForKey (
392 Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.Reset().
393 If ExtendeVerification is TRUE, then perform dependent serial device reset,
394 and set display mode to mode 0.
395 If ExtendedVerification is FALSE, only set display mode to mode 0.
397 @param This Indicates the calling context.
398 @param ExtendedVerification Indicates that the driver may perform a more
399 exhaustive verification operation of the device
402 @retval EFI_SUCCESS The reset operation succeeds.
403 @retval EFI_DEVICE_ERROR The terminal is not functioning correctly or the serial port reset fails.
408 TerminalConOutReset (
409 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
410 IN BOOLEAN ExtendedVerification
414 Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.OutputString().
415 The Unicode string will be converted to terminal expressible data stream
416 and send to terminal via serial port.
418 @param This Indicates the calling context.
419 @param WString The Null-terminated Unicode string to be displayed
420 on the terminal screen.
422 @retval EFI_SUCCESS The string is output successfully.
423 @retval EFI_DEVICE_ERROR The serial port fails to send the string out.
424 @retval EFI_WARN_UNKNOWN_GLYPH Indicates that some of the characters in the Unicode string could not
425 be rendered and are skipped.
426 @retval EFI_UNSUPPORTED If current display mode is out of range.
431 TerminalConOutOutputString (
432 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
437 Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.TestString().
438 If one of the characters in the *Wstring is
439 neither valid Unicode drawing characters,
440 not ASCII code, then this function will return
443 @param This Indicates the calling context.
444 @param WString The Null-terminated Unicode string to be tested.
446 @retval EFI_SUCCESS The terminal is capable of rendering the output string.
447 @retval EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be rendered.
452 TerminalConOutTestString (
453 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
458 Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.QueryMode().
459 It returns information for an available text mode
460 that the terminal supports.
461 In this driver, we support text mode 80x25 (mode 0),
462 80x50 (mode 1), 100x31 (mode 2).
464 @param This Indicates the calling context.
465 @param ModeNumber The mode number to return information on.
466 @param Columns The returned columns of the requested mode.
467 @param Rows The returned rows of the requested mode.
469 @retval EFI_SUCCESS The requested mode information is returned.
470 @retval EFI_UNSUPPORTED The mode number is not valid.
471 @retval EFI_DEVICE_ERROR
476 TerminalConOutQueryMode (
477 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
484 Implements EFI_SIMPLE_TEXT_OUT.SetMode().
485 Set the terminal to a specified display mode.
486 In this driver, we only support mode 0.
488 @param This Indicates the calling context.
489 @param ModeNumber The text mode to set.
491 @retval EFI_SUCCESS The requested text mode is set.
492 @retval EFI_DEVICE_ERROR The requested text mode cannot be set
493 because of serial device error.
494 @retval EFI_UNSUPPORTED The text mode number is not valid.
499 TerminalConOutSetMode (
500 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
505 Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute().
507 @param This Indicates the calling context.
508 @param Attribute The attribute to set. Only bit0..6 are valid, all other bits
509 are undefined and must be zero.
511 @retval EFI_SUCCESS The requested attribute is set.
512 @retval EFI_DEVICE_ERROR The requested attribute cannot be set due to serial port error.
513 @retval EFI_UNSUPPORTED The attribute requested is not defined by EFI spec.
518 TerminalConOutSetAttribute (
519 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
524 Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.ClearScreen().
525 It clears the ANSI terminal's display to the
526 currently selected background color.
528 @param This Indicates the calling context.
530 @retval EFI_SUCCESS The operation completed successfully.
531 @retval EFI_DEVICE_ERROR The terminal screen cannot be cleared due to serial port error.
532 @retval EFI_UNSUPPORTED The terminal is not in a valid display mode.
537 TerminalConOutClearScreen (
538 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
542 Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetCursorPosition().
544 @param This Indicates the calling context.
545 @param Column The row to set cursor to.
546 @param Row The column to set cursor to.
548 @retval EFI_SUCCESS The operation completed successfully.
549 @retval EFI_DEVICE_ERROR The request fails due to serial port error.
550 @retval EFI_UNSUPPORTED The terminal is not in a valid text mode, or the cursor position
551 is invalid for current mode.
556 TerminalConOutSetCursorPosition (
557 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
563 Implements SIMPLE_TEXT_OUTPUT.EnableCursor().
564 In this driver, the cursor cannot be hidden.
566 @param This Indicates the calling context.
567 @param Visible If TRUE, the cursor is set to be visible,
568 If FALSE, the cursor is set to be invisible.
570 @retval EFI_SUCCESS The request is valid.
571 @retval EFI_UNSUPPORTED The terminal does not support cursor hidden.
576 TerminalConOutEnableCursor (
577 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
582 Test to see if this driver supports Controller.
584 @param This Protocol instance pointer.
585 @param ControllerHandle Handle of device to test
586 @param RemainingDevicePath Optional parameter use to pick a specific child
589 @retval EFI_SUCCESS This driver supports this device.
590 @retval EFI_ALREADY_STARTED This driver is already running on this device.
591 @retval other This driver does not support this device.
596 TerminalDriverBindingSupported (
597 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
598 IN EFI_HANDLE ControllerHandle
,
599 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
603 Start this driver on Controller by opening a Serial IO protocol,
604 reading Device Path, and creating a child handle with a Simple Text In,
605 Simple Text In Ex and Simple Text Out protocol, and device path protocol.
606 And store Console Device Environment Variables.
608 @param This Protocol instance pointer.
609 @param Controller Handle of device to bind driver to
610 @param RemainingDevicePath Optional parameter use to pick a specific child
613 @retval EFI_SUCCESS This driver is added to Controller.
614 @retval EFI_ALREADY_STARTED This driver is already running on Controller.
615 @retval other This driver does not support this device.
620 TerminalDriverBindingStart (
621 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
622 IN EFI_HANDLE Controller
,
623 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
628 Stop this driver on Controller by closing Simple Text In, Simple Text
629 In Ex, Simple Text Out protocol, and removing parent device path from
630 Console Device Environment Variables.
632 @param This Protocol instance pointer.
633 @param Controller Handle of device to stop driver on
634 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
635 children is zero stop the entire bus driver.
636 @param ChildHandleBuffer List of Child Handles to Stop.
638 @retval EFI_SUCCESS This driver is removed Controller.
639 @retval other This driver could not be removed from this device.
644 TerminalDriverBindingStop (
645 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
646 IN EFI_HANDLE Controller
,
647 IN UINTN NumberOfChildren
,
648 IN EFI_HANDLE
*ChildHandleBuffer
652 Free notify functions list.
654 @param ListHead The list head
656 @retval EFI_SUCCESS Free the notify list successfully.
657 @retval EFI_INVALID_PARAMETER ListHead is NULL.
661 TerminalFreeNotifyList (
662 IN OUT LIST_ENTRY
*ListHead
666 Retrieves a Unicode string that is the user readable name of the driver.
668 This function retrieves the user readable name of a driver in the form of a
669 Unicode string. If the driver specified by This has a user readable name in
670 the language specified by Language, then a pointer to the driver name is
671 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
672 by This does not support the language specified by Language,
673 then EFI_UNSUPPORTED is returned.
675 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
676 EFI_COMPONENT_NAME_PROTOCOL instance.
678 @param Language[in] A pointer to a Null-terminated ASCII string
679 array indicating the language. This is the
680 language of the driver name that the caller is
681 requesting, and it must match one of the
682 languages specified in SupportedLanguages. The
683 number of languages supported by a driver is up
684 to the driver writer. Language is specified
685 in RFC 4646 or ISO 639-2 language code format.
687 @param DriverName[out] A pointer to the Unicode string to return.
688 This Unicode string is the name of the
689 driver specified by This in the language
690 specified by Language.
692 @retval EFI_SUCCESS The Unicode string for the Driver specified by
693 This and the language specified by Language was
694 returned in DriverName.
696 @retval EFI_INVALID_PARAMETER Language is NULL.
698 @retval EFI_INVALID_PARAMETER DriverName is NULL.
700 @retval EFI_UNSUPPORTED The driver specified by This does not support
701 the language specified by Language.
706 TerminalComponentNameGetDriverName (
707 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
709 OUT CHAR16
**DriverName
714 Retrieves a Unicode string that is the user readable name of the controller
715 that is being managed by a driver.
717 This function retrieves the user readable name of the controller specified by
718 ControllerHandle and ChildHandle in the form of a Unicode string. If the
719 driver specified by This has a user readable name in the language specified by
720 Language, then a pointer to the controller name is returned in ControllerName,
721 and EFI_SUCCESS is returned. If the driver specified by This is not currently
722 managing the controller specified by ControllerHandle and ChildHandle,
723 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
724 support the language specified by Language, then EFI_UNSUPPORTED is returned.
726 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
727 EFI_COMPONENT_NAME_PROTOCOL instance.
729 @param ControllerHandle[in] The handle of a controller that the driver
730 specified by This is managing. This handle
731 specifies the controller whose name is to be
734 @param ChildHandle[in] The handle of the child controller to retrieve
735 the name of. This is an optional parameter that
736 may be NULL. It will be NULL for device
737 drivers. It will also be NULL for a bus drivers
738 that wish to retrieve the name of the bus
739 controller. It will not be NULL for a bus
740 driver that wishes to retrieve the name of a
743 @param Language[in] A pointer to a Null-terminated ASCII string
744 array indicating the language. This is the
745 language of the driver name that the caller is
746 requesting, and it must match one of the
747 languages specified in SupportedLanguages. The
748 number of languages supported by a driver is up
749 to the driver writer. Language is specified in
750 RFC 4646 or ISO 639-2 language code format.
752 @param ControllerName[out] A pointer to the Unicode string to return.
753 This Unicode string is the name of the
754 controller specified by ControllerHandle and
755 ChildHandle in the language specified by
756 Language from the point of view of the driver
759 @retval EFI_SUCCESS The Unicode string for the user readable name in
760 the language specified by Language for the
761 driver specified by This was returned in
764 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
766 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
769 @retval EFI_INVALID_PARAMETER Language is NULL.
771 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
773 @retval EFI_UNSUPPORTED The driver specified by This is not currently
774 managing the controller specified by
775 ControllerHandle and ChildHandle.
777 @retval EFI_UNSUPPORTED The driver specified by This does not support
778 the language specified by Language.
783 TerminalComponentNameGetControllerName (
784 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
785 IN EFI_HANDLE ControllerHandle
,
786 IN EFI_HANDLE ChildHandle OPTIONAL
,
788 OUT CHAR16
**ControllerName
793 // internal functions
797 Check for a pending key in the Efi Key FIFO or Serial device buffer.
799 @param This Indicates the calling context.
801 @retval EFI_SUCCESS There is key pending.
802 @retval EFI_NOT_READY There is no key pending.
803 @retval EFI_DEVICE_ERROR If Serial IO is not attached to serial device.
807 TerminalConInCheckForKey (
808 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*This
812 Update terminal device path in Console Device Environment Variables.
814 @param VariableName The Console Device Environment Variable.
815 @param ParentDevicePath The terminal device path to be updated.
821 TerminalUpdateConsoleDevVariable (
822 IN CHAR16
*VariableName
,
823 IN EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
827 Remove console device variable.
829 @param VariableName A pointer to the variable name.
830 @param ParentDevicePath A pointer to the parent device path.
834 TerminalRemoveConsoleDevVariable (
835 IN CHAR16
*VariableName
,
836 IN EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
840 Build termial device path according to terminal type.
842 @param TerminalType The terminal type is PC ANSI, VT100, VT100+ or VT-UTF8.
843 @param ParentDevicePath Parent device path.
844 @param TerminalDevicePath Returned terminal device path, if building successfully.
846 @retval EFI_UNSUPPORTED Terminal does not belong to the supported type.
847 @retval EFI_OUT_OF_RESOURCES Generate terminal device path failed.
848 @retval EFI_SUCCESS Build terminal device path successfully.
852 SetTerminalDevicePath (
853 IN UINT8 TerminalType
,
854 IN EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
,
855 OUT EFI_DEVICE_PATH_PROTOCOL
**TerminalDevicePath
859 Get one key out of serial buffer.
861 @param SerialIo Serial I/O protocl attached to the serial device.
862 @param Input The fetched key.
864 @retval EFI_NOT_READY If serial buffer is empty.
865 @retval EFI_DEVICE_ERROR If reading serial buffer encounter error.
866 @retval EFI_SUCCESS If reading serial buffer successfully, put
867 the fetched key to the parameter output.
871 GetOneKeyFromSerial (
872 EFI_SERIAL_IO_PROTOCOL
*SerialIo
,
877 Insert one byte raw data into the Raw Data FIFO.
879 @param TerminalDevice Terminal driver private structure.
880 @param Input The key will be input.
882 @retval TRUE If insert successfully.
883 @retval FLASE If Raw Data buffer is full before key insertion,
888 RawFiFoInsertOneKey (
889 TERMINAL_DEV
*TerminalDevice
,
894 Remove one pre-fetched key out of the Raw Data FIFO.
896 @param TerminalDevice Terminal driver private structure.
897 @param Output The key will be removed.
899 @retval TRUE If insert successfully.
900 @retval FLASE If Raw Data FIFO buffer is empty before remove operation.
904 RawFiFoRemoveOneKey (
905 TERMINAL_DEV
*TerminalDevice
,
910 Clarify whether Raw Data FIFO buffer is empty.
912 @param TerminalDevice Terminal driver private structure
914 @retval TRUE If Raw Data FIFO buffer is empty.
915 @retval FLASE If Raw Data FIFO buffer is not empty.
920 TERMINAL_DEV
*TerminalDevice
924 Clarify whether Raw Data FIFO buffer is full.
926 @param TerminalDevice Terminal driver private structure
928 @retval TRUE If Raw Data FIFO buffer is full.
929 @retval FLASE If Raw Data FIFO buffer is not full.
934 TERMINAL_DEV
*TerminalDevice
938 Insert one pre-fetched key into the FIFO buffer.
940 @param TerminalDevice Terminal driver private structure.
941 @param Key The key will be input.
943 @retval TRUE If insert successfully.
944 @retval FLASE If FIFO buffer is full before key insertion,
949 EfiKeyFiFoInsertOneKey (
950 TERMINAL_DEV
*TerminalDevice
,
955 Remove one pre-fetched key out of the FIFO buffer.
957 @param TerminalDevice Terminal driver private structure.
958 @param Output The key will be removed.
960 @retval TRUE If insert successfully.
961 @retval FLASE If FIFO buffer is empty before remove operation.
965 EfiKeyFiFoRemoveOneKey (
966 TERMINAL_DEV
*TerminalDevice
,
967 EFI_INPUT_KEY
*Output
971 Clarify whether FIFO buffer is empty.
973 @param TerminalDevice Terminal driver private structure
975 @retval TRUE If FIFO buffer is empty.
976 @retval FLASE If FIFO buffer is not empty.
981 TERMINAL_DEV
*TerminalDevice
985 Clarify whether FIFO buffer is full.
987 @param TerminalDevice Terminal driver private structure
989 @retval TRUE If FIFO buffer is full.
990 @retval FLASE If FIFO buffer is not full.
995 TERMINAL_DEV
*TerminalDevice
999 Insert one pre-fetched key into the Unicode FIFO buffer.
1001 @param TerminalDevice Terminal driver private structure.
1002 @param Input The key will be input.
1004 @retval TRUE If insert successfully.
1005 @retval FLASE If Unicode FIFO buffer is full before key insertion,
1006 and the key is lost.
1010 UnicodeFiFoInsertOneKey (
1011 TERMINAL_DEV
*TerminalDevice
,
1016 Remove one pre-fetched key out of the Unicode FIFO buffer.
1018 @param TerminalDevice Terminal driver private structure.
1019 @param Output The key will be removed.
1021 @retval TRUE If insert successfully.
1022 @retval FLASE If Unicode FIFO buffer is empty before remove operation.
1026 UnicodeFiFoRemoveOneKey (
1027 TERMINAL_DEV
*TerminalDevice
,
1032 Clarify whether Unicode FIFO buffer is empty.
1034 @param TerminalDevice Terminal driver private structure
1036 @retval TRUE If Unicode FIFO buffer is empty.
1037 @retval FLASE If Unicode FIFO buffer is not empty.
1041 IsUnicodeFiFoEmpty (
1042 TERMINAL_DEV
*TerminalDevice
1046 Clarify whether Unicode FIFO buffer is full.
1048 @param TerminalDevice Terminal driver private structure
1050 @retval TRUE If Unicode FIFO buffer is full.
1051 @retval FLASE If Unicode FIFO buffer is not full.
1056 TERMINAL_DEV
*TerminalDevice
1060 Count Unicode FIFO buffer.
1062 @param TerminalDevice Terminal driver private structure
1064 @return The count in bytes of Unicode FIFO.
1068 UnicodeFiFoGetKeyCount (
1069 TERMINAL_DEV
*TerminalDevice
1073 Translate raw data into Unicode (according to different encode), and
1074 translate Unicode into key information. (according to different standard).
1076 @param TerminalDevice Terminal driver private structure.
1080 TranslateRawDataToEfiKey (
1081 IN TERMINAL_DEV
*TerminalDevice
1085 // internal functions for PC ANSI
1089 Translate all raw data in the Raw FIFI into unicode, and insert
1090 them into Unicode FIFO.
1092 @param TerminalDevice The terminal device.
1096 AnsiRawDataToUnicode (
1097 IN TERMINAL_DEV
*TerminalDevice
1101 Converts a stream of Unicode characters from a terminal input device into EFI Keys that
1102 can be read through the Simple Input Protocol.
1104 The table below shows the keyboard input mappings that this function supports.
1105 If the ESC sequence listed in one of the columns is presented, then it is translated
1106 into the coorespoding EFI Scan Code. If a matching sequence is not found, then the raw
1107 key strokes are converted into EFI Keys.
1109 2 seconds are allowed for an ESC sequence to be completed. If the ESC sequence is not
1110 completed in 2 seconds, then the raw key strokes of the partial ESC sequence are
1111 converted into EFI Keys.
1112 There is one special input sequence that will force the system to reset.
1113 This is ESC R ESC r ESC R.
1115 Symbols used in table below
1116 ===========================
1121 +=========+======+===========+==========+==========+
1122 | | EFI | UEFI 2.0 | | |
1123 | | Scan | | VT100+ | |
1124 | KEY | Code | PC ANSI | VTUTF8 | VT100 |
1125 +=========+======+===========+==========+==========+
1126 | NULL | 0x00 | | | |
1127 | UP | 0x01 | ESC [ A | ESC [ A | ESC [ A |
1128 | DOWN | 0x02 | ESC [ B | ESC [ B | ESC [ B |
1129 | RIGHT | 0x03 | ESC [ C | ESC [ C | ESC [ C |
1130 | LEFT | 0x04 | ESC [ D | ESC [ D | ESC [ D |
1131 | HOME | 0x05 | ESC [ H | ESC h | ESC [ H |
1132 | END | 0x06 | ESC [ F | ESC k | ESC [ K |
1133 | INSERT | 0x07 | ESC [ @ | ESC + | ESC [ @ |
1134 | | | ESC [ L | | ESC [ L |
1135 | DELETE | 0x08 | ESC [ X | ESC - | ESC [ P |
1136 | PG UP | 0x09 | ESC [ I | ESC ? | ESC [ V |
1138 | PG DOWN | 0x0A | ESC [ G | ESC / | ESC [ U |
1140 | F1 | 0x0B | ESC [ M | ESC 1 | ESC O P |
1141 | F2 | 0x0C | ESC [ N | ESC 2 | ESC O Q |
1142 | F3 | 0x0D | ESC [ O | ESC 3 | ESC O w |
1143 | F4 | 0x0E | ESC [ P | ESC 4 | ESC O x |
1144 | F5 | 0x0F | ESC [ Q | ESC 5 | ESC O t |
1145 | F6 | 0x10 | ESC [ R | ESC 6 | ESC O u |
1146 | F7 | 0x11 | ESC [ S | ESC 7 | ESC O q |
1147 | F8 | 0x12 | ESC [ T | ESC 8 | ESC O r |
1148 | F9 | 0x13 | ESC [ U | ESC 9 | ESC O p |
1149 | F10 | 0x14 | ESC [ V | ESC 0 | ESC O M |
1150 | Escape | 0x17 | ESC | ESC | ESC |
1151 | F11 | 0x15 | | ESC ! | |
1152 | F12 | 0x16 | | ESC @ | |
1153 +=========+======+===========+==========+==========+
1157 ESC R ESC r ESC R = Reset System
1160 @param TerminalDevice The terminal device to use to translate raw input into EFI Keys
1165 IN TERMINAL_DEV
*TerminalDevice
1169 Check if input string is valid Ascii string, valid EFI control characters
1170 or valid text graphics.
1172 @param TerminalDevice The terminal device.
1173 @param WString The input string.
1175 @retval EFI_UNSUPPORTED If not all input characters are valid.
1176 @retval EFI_SUCCESS If all input characters are valid.
1181 IN TERMINAL_DEV
*TerminalDevice
,
1186 // internal functions for VTUTF8
1190 Translate all VT-UTF8 characters in the Raw FIFI into unicode characters,
1191 and insert them into Unicode FIFO.
1193 @param VtUtf8Device The terminal device.
1197 VTUTF8RawDataToUnicode (
1198 IN TERMINAL_DEV
*VtUtf8Device
1202 Check if input string is valid VT-UTF8 string.
1204 @param TerminalDevice The terminal device.
1205 @param WString The input string.
1207 @retval EFI_SUCCESS If all input characters are valid.
1212 IN TERMINAL_DEV
*TerminalDevice
,
1217 Translate one Unicode character into VT-UTF8 characters.
1220 Bits per Character | Unicode Character Range | Unicode Binary Encoding | UTF8 Binary Encoding
1221 0-7 | 0x0000 - 0x007F | 00000000 0xxxxxxx | 0xxxxxxx
1222 8-11 | 0x0080 - 0x07FF | 00000xxx xxxxxxxx | 110xxxxx 10xxxxxx
1223 12-16 | 0x0800 - 0xFFFF | xxxxxxxx xxxxxxxx | 1110xxxx 10xxxxxx 10xxxxxx
1226 @param Unicode Unicode character need translating.
1227 @param Utf8Char Return VT-UTF8 character set.
1228 @param ValidBytes The count of valid VT-UTF8 characters. If
1229 ValidBytes is zero, no valid VT-UTF8 returned.
1235 OUT UTF8_CHAR
*Utf8Char
,
1236 OUT UINT8
*ValidBytes
1240 Get one valid VT-UTF8 characters set from Raw Data FIFO.
1242 @param Utf8Device The terminal device.
1243 @param Utf8Char Returned valid VT-UTF8 characters set.
1244 @param ValidBytes The count of returned VT-VTF8 characters.
1245 If ValidBytes is zero, no valid VT-UTF8 returned.
1249 GetOneValidUtf8Char (
1250 IN TERMINAL_DEV
*Utf8Device
,
1251 OUT UTF8_CHAR
*Utf8Char
,
1252 OUT UINT8
*ValidBytes
1256 Translate VT-UTF8 characters into one Unicode character.
1259 Bits per Character | Unicode Character Range | Unicode Binary Encoding | UTF8 Binary Encoding
1260 0-7 | 0x0000 - 0x007F | 00000000 0xxxxxxx | 0xxxxxxx
1261 8-11 | 0x0080 - 0x07FF | 00000xxx xxxxxxxx | 110xxxxx 10xxxxxx
1262 12-16 | 0x0800 - 0xFFFF | xxxxxxxx xxxxxxxx | 1110xxxx 10xxxxxx 10xxxxxx
1265 @param Utf8Char VT-UTF8 character set needs translating.
1266 @param ValidBytes The count of valid VT-UTF8 characters.
1267 @param UnicodeChar Returned unicode character.
1272 IN UTF8_CHAR Utf8Char
,
1273 IN UINT8 ValidBytes
,
1274 OUT CHAR16
*UnicodeChar
1278 // functions for boxdraw unicode
1282 Detects if a Unicode char is for Box Drawing text graphics.
1284 @param Graphic Unicode char to test.
1285 @param PcAnsi Optional pointer to return PCANSI equivalent of
1287 @param Ascii Optional pointer to return ASCII equivalent of
1290 @retval TRUE If Graphic is a supported Unicode Box Drawing character.
1294 TerminalIsValidTextGraphics (
1296 OUT CHAR8
*PcAnsi
, OPTIONAL
1297 OUT CHAR8
*Ascii OPTIONAL
1301 Detects if a valid ASCII char.
1303 @param Ascii An ASCII character.
1305 @retval TRUE If it is a valid ASCII character.
1306 @retval FALSE If it is not a valid ASCII character.
1310 TerminalIsValidAscii (
1315 Detects if a valid EFI control character.
1317 @param CharC An input EFI Control character.
1319 @retval TRUE If it is a valid EFI control character.
1320 @retval FALSE If it is not a valid EFI control character.
1324 TerminalIsValidEfiCntlChar (
1329 Check if the device supports hot-plug through its device path.
1331 This function could be updated to check more types of Hot Plug devices.
1332 Currently, it checks USB and PCCard device.
1334 @param DevicePath Pointer to device's device path.
1336 @retval TRUE The devcie is a hot-plug device
1337 @retval FALSE The devcie is not a hot-plug device.
1342 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath