/** @file\r
Header file for Terminal driver.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
\r
#include <Uefi.h>\r
+\r
+#include <Guid/GlobalVariable.h>\r
+#include <Guid/PcAnsi.h>\r
+#include <Guid/StatusCodeDataTypeVariable.h>\r
+\r
#include <Protocol/SimpleTextOut.h>\r
#include <Protocol/SerialIo.h>\r
-#include <Guid/GlobalVariable.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/SimpleTextIn.h>\r
#include <Protocol/SimpleTextInEx.h>\r
-#include <Guid/HotPlugDevice.h>\r
-#include <Guid/PcAnsi.h>\r
+\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
EFI_INPUT_KEY Data[FIFO_MAX_NUMBER + 1];\r
} EFI_KEY_FIFO;\r
\r
+typedef struct {\r
+ UINTN Columns;\r
+ UINTN Rows;\r
+} TERMINAL_CONSOLE_MODE_DATA;\r
+\r
+#define KEYBOARD_TIMER_INTERVAL 200000 // 0.02s\r
+\r
#define TERMINAL_DEV_SIGNATURE SIGNATURE_32 ('t', 'm', 'n', 'l')\r
\r
#define TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('t', 'm', 'e', 'n')\r
\r
typedef struct _TERMINAL_CONSOLE_IN_EX_NOTIFY {\r
UINTN Signature;\r
- EFI_HANDLE NotifyHandle;\r
EFI_KEY_DATA KeyData;\r
EFI_KEY_NOTIFY_FUNCTION KeyNotificationFn;\r
LIST_ENTRY NotifyEntry;\r
EFI_SIMPLE_TEXT_INPUT_PROTOCOL SimpleInput;\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SimpleTextOutput;\r
EFI_SIMPLE_TEXT_OUTPUT_MODE SimpleTextOutputMode;\r
+ TERMINAL_CONSOLE_MODE_DATA *TerminalConsoleModeData;\r
UINTN SerialInTimeOut;\r
- RAW_DATA_FIFO RawFiFo;\r
- UNICODE_FIFO UnicodeFiFo;\r
- EFI_KEY_FIFO EfiKeyFiFo;\r
+ RAW_DATA_FIFO *RawFiFo;\r
+ UNICODE_FIFO *UnicodeFiFo;\r
+ EFI_KEY_FIFO *EfiKeyFiFo;\r
EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
+ EFI_EVENT TimerEvent;\r
EFI_EVENT TwoSecondTimeOut;\r
UINT32 InputState;\r
UINT32 ResetState;\r
\r
#define RESET_STATE_DEFAULT 0x00\r
#define RESET_STATE_ESC_R 0x01\r
-#define RESET_STATE_ESC_R_ESC_r 0x02\r
+#define RESET_STATE_ESC_R_ESC_R 0x02\r
\r
#define TERMINAL_CON_IN_DEV_FROM_THIS(a) CR (a, TERMINAL_DEV, SimpleInput, TERMINAL_DEV_SIGNATURE)\r
#define TERMINAL_CON_OUT_DEV_FROM_THIS(a) CR (a, TERMINAL_DEV, SimpleTextOutput, TERMINAL_DEV_SIGNATURE)\r
#define CCAP 0x43\r
#define DCAP 0x44\r
\r
-#define MODE0_COLUMN_COUNT 80\r
-#define MODE0_ROW_COUNT 25\r
-\r
-#define MODE1_COLUMN_COUNT 80\r
-#define MODE1_ROW_COUNT 50\r
-\r
-#define MODE2_COLUMN_COUNT 100\r
-#define MODE2_ROW_COUNT 31\r
-\r
#define BACKSPACE 8\r
#define ESC 27\r
#define CSI 0x9B\r
extern EFI_COMPONENT_NAME_PROTOCOL gTerminalComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL gTerminalComponentName2;\r
\r
-extern EFI_GUID gSimpleTextInExNotifyGuid;\r
-\r
/**\r
The user Entry Point for module Terminal. The user code starts with this function.\r
\r
pressed.\r
\r
@retval TRUE Key be pressed matches a registered key.\r
- @retval FLASE Match failed.\r
+ @retval FALSE Match failed.\r
\r
**/\r
BOOLEAN\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN EFI_KEY_DATA *KeyData,\r
IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r
- OUT EFI_HANDLE *NotifyHandle\r
+ OUT VOID **NotifyHandle\r
);\r
\r
/**\r
EFIAPI\r
TerminalConInUnregisterKeyNotify (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
- IN EFI_HANDLE NotificationHandle\r
+ IN VOID *NotificationHandle\r
);\r
\r
/**\r
@param ModeNumber The text mode to set.\r
\r
@retval EFI_SUCCESS The requested text mode is set.\r
- @retval EFI_DEVICE_ERROR The requested text mode cannot be set \r
+ @retval EFI_DEVICE_ERROR The requested text mode cannot be set\r
because of serial device error.\r
@retval EFI_UNSUPPORTED The text mode number is not valid.\r
\r
);\r
\r
/**\r
- Test to see if this driver supports Controller. \r
+ Test to see if this driver supports Controller.\r
\r
@param This Protocol instance pointer.\r
@param ControllerHandle Handle of device to test\r
/**\r
Stop this driver on Controller by closing Simple Text In, Simple Text\r
In Ex, Simple Text Out protocol, and removing parent device path from\r
- Console Device Environment Variables. \r
+ Console Device Environment Variables.\r
\r
@param This Protocol instance pointer.\r
@param Controller Handle of device to stop driver on\r
**/\r
EFI_STATUS\r
TerminalFreeNotifyList (\r
- IN OUT LIST_ENTRY *ListHead\r
- );\r
+ IN OUT LIST_ENTRY *ListHead\r
+ );\r
\r
/**\r
Retrieves a Unicode string that is the user readable name of the driver.\r
languages specified in SupportedLanguages. The\r
number of languages supported by a driver is up\r
to the driver writer. Language is specified\r
- in RFC 3066 or ISO 639-2 language code format.\r
+ in RFC 4646 or ISO 639-2 language code format.\r
\r
@param DriverName[out] A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
languages specified in SupportedLanguages. The\r
number of languages supported by a driver is up\r
to the driver writer. Language is specified in\r
- RFC 3066 or ISO 639-2 language code format.\r
+ RFC 4646 or ISO 639-2 language code format.\r
\r
@param ControllerName[out] A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
driver specified by This was returned in\r
DriverName.\r
\r
- @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
\r
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
EFI_HANDLE.\r
IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath\r
);\r
\r
-/**\r
- Read the EFI variable (VendorGuid/Name) and return a dynamically allocated\r
- buffer, and the size of the buffer. On failure return NULL.\r
-\r
- @param Name String part of EFI variable name\r
- @param VendorGuid GUID part of EFI variable name\r
- @param VariableSize Returns the size of the EFI variable that was read\r
-\r
- @return Dynamically allocated memory that contains a copy of the EFI variable.\r
- Caller is repsoncible freeing the buffer. If variable was not read, \r
- NULL regturned.\r
-\r
-**/\r
-VOID *\r
-TerminalGetVariableAndSize (\r
- IN CHAR16 *Name,\r
- IN EFI_GUID *VendorGuid,\r
- OUT UINTN *VariableSize\r
- );\r
-\r
/**\r
Build termial device path according to terminal type.\r
\r
OUT EFI_DEVICE_PATH_PROTOCOL **TerminalDevicePath\r
);\r
\r
-/**\r
- Initialize the Raw Data FIFO.\r
-\r
- @param TerminalDevice The terminal device.\r
-\r
-**/\r
-VOID\r
-InitializeRawFiFo (\r
- IN TERMINAL_DEV *TerminalDevice\r
- );\r
-\r
-/**\r
- Initialize the Unicode FIFO.\r
-\r
- @param TerminalDevice The terminal device.\r
-\r
-**/\r
-VOID\r
-InitializeUnicodeFiFo (\r
- IN TERMINAL_DEV *TerminalDevice\r
- );\r
-\r
-/**\r
- Initialize the EFI Key FIFO.\r
-\r
- @param TerminalDevice The terminal device.\r
-\r
-**/\r
-VOID\r
-InitializeEfiKeyFiFo (\r
- IN TERMINAL_DEV *TerminalDevice\r
- );\r
-\r
/**\r
Get one key out of serial buffer.\r
\r
@param Input The key will be input.\r
\r
@retval TRUE If insert successfully.\r
- @retval FLASE If Raw Data buffer is full before key insertion,\r
+ @retval FALSE If Raw Data buffer is full before key insertion,\r
and the key is lost.\r
\r
**/\r
@param Output The key will be removed.\r
\r
@retval TRUE If insert successfully.\r
- @retval FLASE If Raw Data FIFO buffer is empty before remove operation.\r
+ @retval FALSE If Raw Data FIFO buffer is empty before remove operation.\r
\r
**/\r
BOOLEAN\r
@param TerminalDevice Terminal driver private structure\r
\r
@retval TRUE If Raw Data FIFO buffer is empty.\r
- @retval FLASE If Raw Data FIFO buffer is not empty.\r
+ @retval FALSE If Raw Data FIFO buffer is not empty.\r
\r
**/\r
BOOLEAN\r
@param TerminalDevice Terminal driver private structure\r
\r
@retval TRUE If Raw Data FIFO buffer is full.\r
- @retval FLASE If Raw Data FIFO buffer is not full.\r
+ @retval FALSE If Raw Data FIFO buffer is not full.\r
\r
**/\r
BOOLEAN\r
@param Key The key will be input.\r
\r
@retval TRUE If insert successfully.\r
- @retval FLASE If FIFO buffer is full before key insertion,\r
+ @retval FALSE If FIFO buffer is full before key insertion,\r
and the key is lost.\r
\r
**/\r
BOOLEAN\r
EfiKeyFiFoInsertOneKey (\r
TERMINAL_DEV *TerminalDevice,\r
- EFI_INPUT_KEY Key\r
+ EFI_INPUT_KEY *Key\r
);\r
\r
/**\r
@param Output The key will be removed.\r
\r
@retval TRUE If insert successfully.\r
- @retval FLASE If FIFO buffer is empty before remove operation.\r
+ @retval FALSE If FIFO buffer is empty before remove operation.\r
\r
**/\r
BOOLEAN\r
@param TerminalDevice Terminal driver private structure\r
\r
@retval TRUE If FIFO buffer is empty.\r
- @retval FLASE If FIFO buffer is not empty.\r
+ @retval FALSE If FIFO buffer is not empty.\r
\r
**/\r
BOOLEAN\r
@param TerminalDevice Terminal driver private structure\r
\r
@retval TRUE If FIFO buffer is full.\r
- @retval FLASE If FIFO buffer is not full.\r
+ @retval FALSE If FIFO buffer is not full.\r
\r
**/\r
BOOLEAN\r
@param Input The key will be input.\r
\r
@retval TRUE If insert successfully.\r
- @retval FLASE If Unicode FIFO buffer is full before key insertion,\r
+ @retval FALSE If Unicode FIFO buffer is full before key insertion,\r
and the key is lost.\r
\r
**/\r
\r
/**\r
Remove one pre-fetched key out of the Unicode FIFO buffer.\r
+ The caller should guarantee that Unicode FIFO buffer is not empty \r
+ by IsUnicodeFiFoEmpty ().\r
\r
@param TerminalDevice Terminal driver private structure.\r
@param Output The key will be removed.\r
\r
- @retval TRUE If insert successfully.\r
- @retval FLASE If Unicode FIFO buffer is empty before remove operation.\r
-\r
**/\r
-BOOLEAN\r
+VOID\r
UnicodeFiFoRemoveOneKey (\r
TERMINAL_DEV *TerminalDevice,\r
UINT16 *Output\r
@param TerminalDevice Terminal driver private structure\r
\r
@retval TRUE If Unicode FIFO buffer is empty.\r
- @retval FLASE If Unicode FIFO buffer is not empty.\r
+ @retval FALSE If Unicode FIFO buffer is not empty.\r
\r
**/\r
BOOLEAN\r
@param TerminalDevice Terminal driver private structure\r
\r
@retval TRUE If Unicode FIFO buffer is full.\r
- @retval FLASE If Unicode FIFO buffer is not full.\r
+ @retval FALSE If Unicode FIFO buffer is not full.\r
\r
**/\r
BOOLEAN\r
);\r
\r
/**\r
- Translate raw data into Unicode (according to different encode), and \r
- translate Unicode into key information. (according to different standard). \r
+ Translate raw data into Unicode (according to different encode), and\r
+ translate Unicode into key information. (according to different standard).\r
\r
@param TerminalDevice Terminal driver private structure.\r
\r
\r
/**\r
Converts a stream of Unicode characters from a terminal input device into EFI Keys that\r
- can be read through the Simple Input Protocol. \r
- \r
+ can be read through the Simple Input Protocol.\r
+\r
The table below shows the keyboard input mappings that this function supports.\r
If the ESC sequence listed in one of the columns is presented, then it is translated\r
into the coorespoding EFI Scan Code. If a matching sequence is not found, then the raw\r
| F11 | 0x15 | | ESC ! | |\r
| F12 | 0x16 | | ESC @ | |\r
+=========+======+===========+==========+==========+\r
- \r
+\r
Special Mappings\r
================\r
ESC R ESC r ESC R = Reset System\r
or valid text graphics.\r
\r
@param TerminalDevice The terminal device.\r
- @param WString The input string. \r
- \r
+ @param WString The input string.\r
+\r
@retval EFI_UNSUPPORTED If not all input characters are valid.\r
@retval EFI_SUCCESS If all input characters are valid.\r
\r
//\r
\r
/**\r
- Translate all VT-UTF8 characters in the Raw FIFI into unicode characters, \r
+ Translate all VT-UTF8 characters in the Raw FIFI into unicode characters,\r
and insert them into Unicode FIFO.\r
\r
@param VtUtf8Device The terminal device.\r
Check if input string is valid VT-UTF8 string.\r
\r
@param TerminalDevice The terminal device.\r
- @param WString The input string. \r
- \r
+ @param WString The input string.\r
+\r
@retval EFI_SUCCESS If all input characters are valid.\r
\r
**/\r
IN CHAR16 *WString\r
);\r
\r
-/** \r
+/**\r
Translate one Unicode character into VT-UTF8 characters.\r
\r
UTF8 Encoding Table\r
\r
@param Utf8Device The terminal device.\r
@param Utf8Char Returned valid VT-UTF8 characters set.\r
- @param ValidBytes The count of returned VT-VTF8 characters. \r
+ @param ValidBytes The count of returned VT-VTF8 characters.\r
If ValidBytes is zero, no valid VT-UTF8 returned.\r
\r
**/\r
OUT UINT8 *ValidBytes\r
);\r
\r
-/** \r
+/**\r
Translate VT-UTF8 characters into one Unicode character.\r
\r
UTF8 Encoding Table\r
\r
@param Utf8Char VT-UTF8 character set needs translating.\r
@param ValidBytes The count of valid VT-UTF8 characters.\r
- @param UnicodeChar Returned unicode character. \r
+ @param UnicodeChar Returned unicode character.\r
\r
**/\r
VOID\r
Detects if a valid ASCII char.\r
\r
@param Ascii An ASCII character.\r
- \r
+\r
@retval TRUE If it is a valid ASCII character.\r
@retval FALSE If it is not a valid ASCII character.\r
\r
Detects if a valid EFI control character.\r
\r
@param CharC An input EFI Control character.\r
- \r
+\r
@retval TRUE If it is a valid EFI control character.\r
@retval FALSE If it is not a valid EFI control character.\r
\r
IN CHAR16 CharC\r
);\r
\r
+/**\r
+ Check if the device supports hot-plug through its device path.\r
+\r
+ This function could be updated to check more types of Hot Plug devices.\r
+ Currently, it checks USB and PCCard device.\r
+\r
+ @param DevicePath Pointer to device's device path.\r
+\r
+ @retval TRUE The devcie is a hot-plug device\r
+ @retval FALSE The devcie is not a hot-plug device.\r
+\r
+**/\r
+BOOLEAN\r
+IsHotPlugDevice (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
+ );\r
+\r
+/**\r
+ Timer handler to poll the key from serial.\r
+\r
+ @param Event Indicates the event that invoke this function.\r
+ @param Context Indicates the calling context.\r
+**/\r
+VOID\r
+EFIAPI\r
+TerminalConInTimerHandler (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ );\r
#endif\r
projects / mirror_edk2.git / blobdiff