/** @file\r
Implementation for EFI_SIMPLE_TEXT_INPUT_PROTOCOL protocol.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2010, 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
#include "Terminal.h"\r
\r
\r
-\r
/**\r
Reads the next keystroke from the input device. The WaitForKey Event can\r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
+ be used to test for existence of a keystroke via WaitForEvent () call.\r
\r
@param TerminalDevice Terminal driver private structure\r
@param KeyData A pointer to a buffer that is filled in with the\r
pressed.\r
\r
@retval EFI_SUCCESS The keystroke information was returned.\r
- @retval EFI_NOT_READY There was no keystroke data availiable.\r
+ @retval EFI_NOT_READY There was no keystroke data available.\r
@retval EFI_DEVICE_ERROR The keystroke information was not returned due\r
to hardware errors.\r
@retval EFI_INVALID_PARAMETER KeyData is NULL.\r
{\r
EFI_STATUS Status;\r
LIST_ENTRY *Link;\r
+ LIST_ENTRY *NotifyList;\r
TERMINAL_CONSOLE_IN_EX_NOTIFY *CurrentNotify;\r
\r
if (KeyData == NULL) {\r
//\r
// Invoke notification functions if exist\r
//\r
- for (Link = TerminalDevice->NotifyList.ForwardLink; Link != &TerminalDevice->NotifyList; Link = Link->ForwardLink) {\r
+ NotifyList = &TerminalDevice->NotifyList;\r
+ for (Link = GetFirstNode (NotifyList); !IsNull (NotifyList,Link); Link = GetNextNode (NotifyList,Link)) {\r
CurrentNotify = CR (\r
Link,\r
TERMINAL_CONSOLE_IN_EX_NOTIFY,\r
@param This Indicates the calling context.\r
@param ExtendedVerification Skip by this driver.\r
\r
- @return EFI_SUCCESS\r
- @return The reset operation succeeds.\r
- @return EFI_DEVICE_ERROR\r
- @return The dependent serial port reset fails.\r
+ @retval EFI_SUCCESS The reset operation succeeds.\r
+ @retval EFI_DEVICE_ERROR The dependent serial port reset fails.\r
\r
**/\r
EFI_STATUS\r
//\r
REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
EFI_PROGRESS_CODE,\r
- PcdGet32 (PcdStatusCodeValueRemoteConsoleReset),\r
+ (EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_PC_RESET),\r
TerminalDevice->DevicePath\r
);\r
\r
Status = TerminalDevice->SerialIo->Reset (TerminalDevice->SerialIo);\r
\r
//\r
- // clear all the internal buffer for keys\r
+ // Make all the internal buffer empty for keys\r
//\r
- InitializeRawFiFo (TerminalDevice);\r
- InitializeUnicodeFiFo (TerminalDevice);\r
- InitializeEfiKeyFiFo (TerminalDevice);\r
+ TerminalDevice->RawFiFo->Head = TerminalDevice->RawFiFo->Tail;\r
+ TerminalDevice->UnicodeFiFo->Head = TerminalDevice->UnicodeFiFo->Tail;\r
+ TerminalDevice->EfiKeyFiFo->Head = TerminalDevice->EfiKeyFiFo->Tail;\r
\r
if (EFI_ERROR (Status)) {\r
REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
- PcdGet32 (PcdStatusCodeValueRemoteConsoleError),\r
+ (EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_EC_CONTROLLER_ERROR),\r
TerminalDevice->DevicePath\r
);\r
}\r
return Status;\r
}\r
\r
-\r
/**\r
Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().\r
\r
- @param This Indicates the calling context.\r
- @param Key A pointer to a buffer that is filled in with the\r
- keystroke information for the key that was sent\r
- from terminal.\r
+ @param This Indicates the calling context.\r
+ @param Key A pointer to a buffer that is filled in with the\r
+ keystroke information for the key that was sent\r
+ from terminal.\r
\r
- @return EFI_SUCCESS\r
- @return The keystroke information is returned successfully.\r
- @return EFI_NOT_READY\r
- @return There is no keystroke data available.\r
- @return EFI_DEVICE_ERROR\r
- @return The dependent serial device encounters error.\r
+ @retval EFI_SUCCESS The keystroke information is returned successfully.\r
+ @retval EFI_NOT_READY There is no keystroke data available.\r
+ @retval EFI_DEVICE_ERROR The dependent serial device encounters error.\r
\r
**/\r
EFI_STATUS\r
\r
}\r
\r
-\r
-\r
/**\r
+ Check if the key already has been registered.\r
+\r
+ If both RegsiteredData and InputData is NULL, then ASSERT().\r
\r
@param RegsiteredData A pointer to a buffer that is filled in with the\r
keystroke state data for the key that was\r
@param Event Indicates the event that invoke this function.\r
@param Context Indicates the calling context.\r
\r
- @return none.\r
-\r
**/\r
VOID\r
EFIAPI\r
// Simple Text Input Ex protocol functions\r
//\r
\r
-\r
/**\r
- Reset the input device and optionaly run diagnostics\r
+ Reset the input device and optionally run diagnostics\r
\r
@param This Protocol instance pointer.\r
@param ExtendedVerification Driver may perform diagnostics on reset.\r
\r
/**\r
Reads the next keystroke from the input device. The WaitForKey Event can\r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
+ be used to test for existence of a keystroke via WaitForEvent () call.\r
\r
@param This Protocol instance pointer.\r
@param KeyData A pointer to a buffer that is filled in with the\r
pressed.\r
\r
@retval EFI_SUCCESS The keystroke information was returned.\r
- @retval EFI_NOT_READY There was no keystroke data availiable.\r
+ @retval EFI_NOT_READY There was no keystroke data available.\r
@retval EFI_DEVICE_ERROR The keystroke information was not returned due\r
to hardware errors.\r
@retval EFI_INVALID_PARAMETER KeyData is NULL.\r
\r
@retval EFI_SUCCESS The notification function was registered\r
successfully.\r
- @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data\r
+ @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necessary data\r
structures.\r
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.\r
\r
OUT EFI_HANDLE *NotifyHandle\r
)\r
{\r
- EFI_STATUS Status;\r
TERMINAL_DEV *TerminalDevice;\r
TERMINAL_CONSOLE_IN_EX_NOTIFY *NewNotify;\r
LIST_ENTRY *Link;\r
+ LIST_ENTRY *NotifyList;\r
TERMINAL_CONSOLE_IN_EX_NOTIFY *CurrentNotify;\r
\r
if (KeyData == NULL || NotifyHandle == NULL || KeyNotificationFunction == NULL) {\r
//\r
// Return EFI_SUCCESS if the (KeyData, NotificationFunction) is already registered.\r
//\r
- for (Link = TerminalDevice->NotifyList.ForwardLink; Link != &TerminalDevice->NotifyList; Link = Link->ForwardLink) {\r
+ NotifyList = &TerminalDevice->NotifyList;\r
+ for (Link = GetFirstNode (NotifyList); !IsNull (NotifyList,Link); Link = GetNextNode (NotifyList,Link)) {\r
CurrentNotify = CR (\r
Link,\r
TERMINAL_CONSOLE_IN_EX_NOTIFY,\r
\r
NewNotify->Signature = TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE;\r
NewNotify->KeyNotificationFn = KeyNotificationFunction;\r
+ NewNotify->NotifyHandle = (EFI_HANDLE) NewNotify;\r
CopyMem (&NewNotify->KeyData, KeyData, sizeof (KeyData));\r
InsertTailList (&TerminalDevice->NotifyList, &NewNotify->NotifyEntry);\r
- //\r
- // Use gSimpleTextInExNotifyGuid to get a valid EFI_HANDLE\r
- //\r
- Status = gBS->InstallMultipleProtocolInterfaces (\r
- &NewNotify->NotifyHandle,\r
- &gSimpleTextInExNotifyGuid,\r
- NULL,\r
- NULL\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
+\r
*NotifyHandle = NewNotify->NotifyHandle;\r
\r
return EFI_SUCCESS;\r
@retval EFI_SUCCESS The notification function was unregistered\r
successfully.\r
@retval EFI_INVALID_PARAMETER The NotificationHandle is invalid.\r
- @retval EFI_NOT_FOUND Can not find the matching entry in database.\r
\r
**/\r
EFI_STATUS\r
IN EFI_HANDLE NotificationHandle\r
)\r
{\r
- EFI_STATUS Status;\r
TERMINAL_DEV *TerminalDevice;\r
LIST_ENTRY *Link;\r
TERMINAL_CONSOLE_IN_EX_NOTIFY *CurrentNotify;\r
+ LIST_ENTRY *NotifyList;\r
\r
if (NotificationHandle == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- Status = gBS->OpenProtocol (\r
- NotificationHandle,\r
- &gSimpleTextInExNotifyGuid,\r
- NULL,\r
- NULL,\r
- NULL,\r
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
- );\r
- if (EFI_ERROR (Status)) {\r
+ if (((TERMINAL_CONSOLE_IN_EX_NOTIFY *) NotificationHandle)->Signature != TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE) {\r
return EFI_INVALID_PARAMETER;\r
- }\r
-\r
+ } \r
+ \r
TerminalDevice = TERMINAL_CON_IN_EX_DEV_FROM_THIS (This);\r
\r
- for (Link = TerminalDevice->NotifyList.ForwardLink; Link != &TerminalDevice->NotifyList; Link = Link->ForwardLink) {\r
+ NotifyList = &TerminalDevice->NotifyList;\r
+ for (Link = GetFirstNode (NotifyList); !IsNull (NotifyList,Link); Link = GetNextNode (NotifyList,Link)) {\r
CurrentNotify = CR (\r
Link,\r
TERMINAL_CONSOLE_IN_EX_NOTIFY,\r
// Remove the notification function from NotifyList and free resources\r
//\r
RemoveEntryList (&CurrentNotify->NotifyEntry);\r
- Status = gBS->UninstallMultipleProtocolInterfaces (\r
- CurrentNotify->NotifyHandle,\r
- &gSimpleTextInExNotifyGuid,\r
- NULL,\r
- NULL\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
+\r
gBS->FreePool (CurrentNotify);\r
return EFI_SUCCESS;\r
}\r
}\r
\r
- return EFI_NOT_FOUND;\r
+ //\r
+ // Can not find the matching entry in database.\r
+ //\r
+ return EFI_INVALID_PARAMETER;\r
}\r
\r
/**\r
- Turn 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
- @return none.\r
-\r
**/\r
VOID\r
TranslateRawDataToEfiKey (\r
@param Event Indicates the event that invoke this function.\r
@param Context Indicates the calling context.\r
\r
- @return None\r
-\r
**/\r
VOID\r
EFIAPI\r
\r
@param This Indicates the calling context.\r
\r
- @return EFI_SUCCESS\r
- @return There is key pending.\r
- @return EFI_NOT_READY\r
- @return There is no key pending.\r
- @return EFI_DEVICE_ERROR\r
+ @retval EFI_SUCCESS There is key pending.\r
+ @retval EFI_NOT_READY There is no key pending.\r
+ @retval EFI_DEVICE_ERROR If Serial IO is not attached to serial device.\r
\r
**/\r
EFI_STATUS\r
\r
SerialInTimeOut = 0;\r
if (Mode->BaudRate != 0) {\r
+ //\r
+ // According to BAUD rate to calculate the timeout value.\r
+ //\r
SerialInTimeOut = (1 + Mode->DataBits + Mode->StopBits) * 2 * 1000000 / (UINTN) Mode->BaudRate;\r
}\r
\r
}\r
}\r
//\r
- // check whether serial buffer is empty\r
+ // Check whether serial buffer is empty.\r
//\r
Status = SerialIo->GetControl (SerialIo, &Control);\r
\r
- if (0 != (Control & EFI_SERIAL_INPUT_BUFFER_EMPTY)) {\r
+ if ((Control & EFI_SERIAL_INPUT_BUFFER_EMPTY) != 0) {\r
//\r
// Translate all the raw data in RawFIFO into EFI Key,\r
// according to different terminal type supported.\r
if (Status == EFI_DEVICE_ERROR) {\r
REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
- PcdGet32 (PcdStatusCodeValueRemoteConsoleInputError),\r
+ (EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_EC_INPUT_ERROR),\r
TerminalDevice->DevicePath\r
);\r
}\r
/**\r
Get one key out of serial buffer.\r
\r
- @param SerialIo Serial I/O protocl attached to the serial device.\r
+ @param SerialIo Serial I/O protocol attached to the serial device.\r
@param Output The fetched key.\r
\r
- @return EFI_NOT_READY If serial buffer is empty.\r
- @return EFI_DEVICE_ERROR If reading serial buffer encounter error.\r
- @return EFI_SUCCESS If reading serial buffer successfully, put\r
+ @retval EFI_NOT_READY If serial buffer is empty.\r
+ @retval EFI_DEVICE_ERROR If reading serial buffer encounter error.\r
+ @retval EFI_SUCCESS If reading serial buffer successfully, put\r
the fetched key to the parameter output.\r
\r
**/\r
Size = 1;\r
*Output = 0;\r
\r
+ //\r
+ // Read one key from serial I/O device.\r
+ //\r
Status = SerialIo->Read (SerialIo, &Size, Output);\r
\r
if (EFI_ERROR (Status)) {\r
@param TerminalDevice Terminal driver private structure.\r
@param Input The key will be input.\r
\r
- @return TRUE If insert successfully.\r
- @return FLASE If Raw Data buffer is full before key insertion,\r
+ @retval TRUE If insert successfully.\r
+ @retval FLASE If Raw Data buffer is full before key insertion,\r
and the key is lost.\r
\r
**/\r
{\r
UINT8 Tail;\r
\r
- Tail = TerminalDevice->RawFiFo.Tail;\r
+ Tail = TerminalDevice->RawFiFo->Tail;\r
\r
if (IsRawFiFoFull (TerminalDevice)) {\r
//\r
return FALSE;\r
}\r
\r
- TerminalDevice->RawFiFo.Data[Tail] = Input;\r
+ TerminalDevice->RawFiFo->Data[Tail] = Input;\r
\r
- TerminalDevice->RawFiFo.Tail = (UINT8) ((Tail + 1) % (RAW_FIFO_MAX_NUMBER + 1));\r
+ TerminalDevice->RawFiFo->Tail = (UINT8) ((Tail + 1) % (RAW_FIFO_MAX_NUMBER + 1));\r
\r
return TRUE;\r
}\r
@param TerminalDevice Terminal driver private structure.\r
@param Output The key will be removed.\r
\r
- @return TRUE If insert successfully.\r
- @return FLASE If Raw Data FIFO buffer is empty before remove operation.\r
+ @retval TRUE If insert successfully.\r
+ @retval FLASE If Raw Data FIFO buffer is empty before remove operation.\r
\r
**/\r
BOOLEAN\r
{\r
UINT8 Head;\r
\r
- Head = TerminalDevice->RawFiFo.Head;\r
+ Head = TerminalDevice->RawFiFo->Head;\r
\r
if (IsRawFiFoEmpty (TerminalDevice)) {\r
//\r
return FALSE;\r
}\r
\r
- *Output = TerminalDevice->RawFiFo.Data[Head];\r
+ *Output = TerminalDevice->RawFiFo->Data[Head];\r
\r
- TerminalDevice->RawFiFo.Head = (UINT8) ((Head + 1) % (RAW_FIFO_MAX_NUMBER + 1));\r
+ TerminalDevice->RawFiFo->Head = (UINT8) ((Head + 1) % (RAW_FIFO_MAX_NUMBER + 1));\r
\r
return TRUE;\r
}\r
\r
@param TerminalDevice Terminal driver private structure\r
\r
- @return TRUE If Raw Data FIFO buffer is empty.\r
- @return FLASE If Raw Data FIFO buffer is not empty.\r
+ @retval TRUE If Raw Data FIFO buffer is empty.\r
+ @retval FLASE If Raw Data FIFO buffer is not empty.\r
\r
**/\r
BOOLEAN\r
TERMINAL_DEV *TerminalDevice\r
)\r
{\r
- if (TerminalDevice->RawFiFo.Head == TerminalDevice->RawFiFo.Tail) {\r
+ if (TerminalDevice->RawFiFo->Head == TerminalDevice->RawFiFo->Tail) {\r
return TRUE;\r
} else {\r
return FALSE;\r
\r
@param TerminalDevice Terminal driver private structure\r
\r
- @return TRUE If Raw Data FIFO buffer is full.\r
- @return FLASE If Raw Data FIFO buffer is not full.\r
+ @retval TRUE If Raw Data FIFO buffer is full.\r
+ @retval FLASE If Raw Data FIFO buffer is not full.\r
\r
**/\r
BOOLEAN\r
UINT8 Tail;\r
UINT8 Head;\r
\r
- Tail = TerminalDevice->RawFiFo.Tail;\r
- Head = TerminalDevice->RawFiFo.Head;\r
+ Tail = TerminalDevice->RawFiFo->Tail;\r
+ Head = TerminalDevice->RawFiFo->Head;\r
\r
if (((Tail + 1) % (RAW_FIFO_MAX_NUMBER + 1)) == Head) {\r
\r
@param TerminalDevice Terminal driver private structure.\r
@param Key The key will be input.\r
\r
- @return TRUE If insert successfully.\r
- @return FLASE If FIFO buffer is full before key insertion,\r
+ @retval TRUE If insert successfully.\r
+ @retval FLASE If FIFO buffer is full before key insertion,\r
and the key is lost.\r
\r
**/\r
{\r
UINT8 Tail;\r
\r
- Tail = TerminalDevice->EfiKeyFiFo.Tail;\r
+ Tail = TerminalDevice->EfiKeyFiFo->Tail;\r
+ ASSERT (Tail < FIFO_MAX_NUMBER + 1);\r
\r
if (IsEfiKeyFiFoFull (TerminalDevice)) {\r
//\r
return FALSE;\r
}\r
\r
- TerminalDevice->EfiKeyFiFo.Data[Tail] = Key;\r
+ TerminalDevice->EfiKeyFiFo->Data[Tail] = Key;\r
\r
- TerminalDevice->EfiKeyFiFo.Tail = (UINT8) ((Tail + 1) % (FIFO_MAX_NUMBER + 1));\r
+ TerminalDevice->EfiKeyFiFo->Tail = (UINT8) ((Tail + 1) % (FIFO_MAX_NUMBER + 1));\r
\r
return TRUE;\r
}\r
@param TerminalDevice Terminal driver private structure.\r
@param Output The key will be removed.\r
\r
- @return TRUE If insert successfully.\r
- @return FLASE If FIFO buffer is empty before remove operation.\r
+ @retval TRUE If insert successfully.\r
+ @retval FLASE If FIFO buffer is empty before remove operation.\r
\r
**/\r
BOOLEAN\r
{\r
UINT8 Head;\r
\r
- Head = TerminalDevice->EfiKeyFiFo.Head;\r
+ Head = TerminalDevice->EfiKeyFiFo->Head;\r
+ ASSERT (Head < FIFO_MAX_NUMBER + 1);\r
\r
if (IsEfiKeyFiFoEmpty (TerminalDevice)) {\r
//\r
return FALSE;\r
}\r
\r
- *Output = TerminalDevice->EfiKeyFiFo.Data[Head];\r
+ *Output = TerminalDevice->EfiKeyFiFo->Data[Head];\r
\r
- TerminalDevice->EfiKeyFiFo.Head = (UINT8) ((Head + 1) % (FIFO_MAX_NUMBER + 1));\r
+ TerminalDevice->EfiKeyFiFo->Head = (UINT8) ((Head + 1) % (FIFO_MAX_NUMBER + 1));\r
\r
return TRUE;\r
}\r
\r
@param TerminalDevice Terminal driver private structure\r
\r
- @return TRUE If FIFO buffer is empty.\r
- @return FLASE If FIFO buffer is not empty.\r
+ @retval TRUE If FIFO buffer is empty.\r
+ @retval FLASE If FIFO buffer is not empty.\r
\r
**/\r
BOOLEAN\r
TERMINAL_DEV *TerminalDevice\r
)\r
{\r
- if (TerminalDevice->EfiKeyFiFo.Head == TerminalDevice->EfiKeyFiFo.Tail) {\r
+ if (TerminalDevice->EfiKeyFiFo->Head == TerminalDevice->EfiKeyFiFo->Tail) {\r
return TRUE;\r
} else {\r
return FALSE;\r
\r
@param TerminalDevice Terminal driver private structure\r
\r
- @return TRUE If FIFO buffer is full.\r
- @return FLASE If FIFO buffer is not full.\r
+ @retval TRUE If FIFO buffer is full.\r
+ @retval FLASE If FIFO buffer is not full.\r
\r
**/\r
BOOLEAN\r
UINT8 Tail;\r
UINT8 Head;\r
\r
- Tail = TerminalDevice->EfiKeyFiFo.Tail;\r
- Head = TerminalDevice->EfiKeyFiFo.Head;\r
+ Tail = TerminalDevice->EfiKeyFiFo->Tail;\r
+ Head = TerminalDevice->EfiKeyFiFo->Head;\r
\r
if (((Tail + 1) % (FIFO_MAX_NUMBER + 1)) == Head) {\r
\r
@param TerminalDevice Terminal driver private structure.\r
@param Input The key will be input.\r
\r
- @return TRUE If insert successfully.\r
- @return FLASE If Unicode FIFO buffer is full before key insertion,\r
+ @retval TRUE If insert successfully.\r
+ @retval FLASE If Unicode FIFO buffer is full before key insertion,\r
and the key is lost.\r
\r
**/\r
{\r
UINT8 Tail;\r
\r
- Tail = TerminalDevice->UnicodeFiFo.Tail;\r
+ Tail = TerminalDevice->UnicodeFiFo->Tail;\r
+ ASSERT (Tail < FIFO_MAX_NUMBER + 1);\r
+\r
\r
if (IsUnicodeFiFoFull (TerminalDevice)) {\r
//\r
return FALSE;\r
}\r
\r
- TerminalDevice->UnicodeFiFo.Data[Tail] = Input;\r
+ TerminalDevice->UnicodeFiFo->Data[Tail] = Input;\r
\r
- TerminalDevice->UnicodeFiFo.Tail = (UINT8) ((Tail + 1) % (FIFO_MAX_NUMBER + 1));\r
+ TerminalDevice->UnicodeFiFo->Tail = (UINT8) ((Tail + 1) % (FIFO_MAX_NUMBER + 1));\r
\r
return TRUE;\r
}\r
@param TerminalDevice Terminal driver private structure.\r
@param Output The key will be removed.\r
\r
- @return TRUE If insert successfully.\r
- @return FLASE If Unicode FIFO buffer is empty before remove operation.\r
+ @retval TRUE If insert successfully.\r
+ @retval FLASE If Unicode FIFO buffer is empty before remove operation.\r
\r
**/\r
BOOLEAN\r
{\r
UINT8 Head;\r
\r
- Head = TerminalDevice->UnicodeFiFo.Head;\r
+ Head = TerminalDevice->UnicodeFiFo->Head;\r
+ ASSERT (Head < FIFO_MAX_NUMBER + 1);\r
\r
if (IsUnicodeFiFoEmpty (TerminalDevice)) {\r
//\r
return FALSE;\r
}\r
\r
- *Output = TerminalDevice->UnicodeFiFo.Data[Head];\r
+ *Output = TerminalDevice->UnicodeFiFo->Data[Head];\r
\r
- TerminalDevice->UnicodeFiFo.Head = (UINT8) ((Head + 1) % (FIFO_MAX_NUMBER + 1));\r
+ TerminalDevice->UnicodeFiFo->Head = (UINT8) ((Head + 1) % (FIFO_MAX_NUMBER + 1));\r
\r
return TRUE;\r
}\r
\r
@param TerminalDevice Terminal driver private structure\r
\r
- @return TRUE If Unicode FIFO buffer is empty.\r
- @return FLASE If Unicode FIFO buffer is not empty.\r
+ @retval TRUE If Unicode FIFO buffer is empty.\r
+ @retval FLASE If Unicode FIFO buffer is not empty.\r
\r
**/\r
BOOLEAN\r
TERMINAL_DEV *TerminalDevice\r
)\r
{\r
- if (TerminalDevice->UnicodeFiFo.Head == TerminalDevice->UnicodeFiFo.Tail) {\r
+ if (TerminalDevice->UnicodeFiFo->Head == TerminalDevice->UnicodeFiFo->Tail) {\r
return TRUE;\r
} else {\r
return FALSE;\r
\r
@param TerminalDevice Terminal driver private structure\r
\r
- @return TRUE If Unicode FIFO buffer is full.\r
- @return FLASE If Unicode FIFO buffer is not full.\r
+ @retval TRUE If Unicode FIFO buffer is full.\r
+ @retval FLASE If Unicode FIFO buffer is not full.\r
\r
**/\r
BOOLEAN\r
UINT8 Tail;\r
UINT8 Head;\r
\r
- Tail = TerminalDevice->UnicodeFiFo.Tail;\r
- Head = TerminalDevice->UnicodeFiFo.Head;\r
+ Tail = TerminalDevice->UnicodeFiFo->Tail;\r
+ Head = TerminalDevice->UnicodeFiFo->Head;\r
\r
if (((Tail + 1) % (FIFO_MAX_NUMBER + 1)) == Head) {\r
\r
return FALSE;\r
}\r
\r
+/**\r
+ Count Unicode FIFO buffer.\r
+\r
+ @param TerminalDevice Terminal driver private structure\r
+\r
+ @return The count in bytes of Unicode FIFO.\r
+\r
+**/\r
UINT8\r
UnicodeFiFoGetKeyCount (\r
TERMINAL_DEV *TerminalDevice\r
UINT8 Tail;\r
UINT8 Head;\r
\r
- Tail = TerminalDevice->UnicodeFiFo.Tail;\r
- Head = TerminalDevice->UnicodeFiFo.Head;\r
+ Tail = TerminalDevice->UnicodeFiFo->Tail;\r
+ Head = TerminalDevice->UnicodeFiFo->Head;\r
\r
if (Tail >= Head) {\r
return (UINT8) (Tail - Head);\r
}\r
}\r
\r
+/**\r
+ Update the Unicode characters from a terminal input device into EFI Keys FIFO.\r
+\r
+ @param TerminalDevice The terminal device to use to translate raw input into EFI Keys\r
+\r
+**/\r
VOID\r
UnicodeToEfiKeyFlushState (\r
IN TERMINAL_DEV *TerminalDevice\r
)\r
{\r
EFI_INPUT_KEY Key;\r
+ UINT32 InputState;\r
+\r
+ InputState = TerminalDevice->InputState;\r
\r
- if (0 != (TerminalDevice->InputState & INPUT_STATE_ESC)) {\r
+ if ((InputState & INPUT_STATE_ESC) != 0) {\r
Key.ScanCode = SCAN_ESC;\r
Key.UnicodeChar = 0;\r
EfiKeyFiFoInsertOneKey (TerminalDevice, Key);\r
}\r
\r
- if (0 != (TerminalDevice->InputState & INPUT_STATE_CSI)) {\r
+ if ((InputState & INPUT_STATE_CSI) != 0) {\r
Key.ScanCode = SCAN_NULL;\r
Key.UnicodeChar = CSI;\r
EfiKeyFiFoInsertOneKey (TerminalDevice, Key);\r
}\r
\r
- if (0 != (TerminalDevice->InputState & INPUT_STATE_LEFTOPENBRACKET)) {\r
+ if ((InputState & INPUT_STATE_LEFTOPENBRACKET) != 0) {\r
Key.ScanCode = SCAN_NULL;\r
Key.UnicodeChar = LEFTOPENBRACKET;\r
EfiKeyFiFoInsertOneKey (TerminalDevice, Key);\r
}\r
\r
- if (0 != (TerminalDevice->InputState & INPUT_STATE_O)) {\r
+ if ((InputState & INPUT_STATE_O) != 0) {\r
Key.ScanCode = SCAN_NULL;\r
Key.UnicodeChar = 'O';\r
EfiKeyFiFoInsertOneKey (TerminalDevice, Key);\r
}\r
\r
- if (0 != (TerminalDevice->InputState & INPUT_STATE_2)) {\r
+ if ((InputState & INPUT_STATE_2) != 0) {\r
Key.ScanCode = SCAN_NULL;\r
Key.UnicodeChar = '2';\r
EfiKeyFiFoInsertOneKey (TerminalDevice, Key);\r
}\r
\r
+ //\r
+ // Cancel the timer.\r
+ //\r
gBS->SetTimer (\r
TerminalDevice->TwoSecondTimeOut,\r
TimerCancel,\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. The table below shows the keyboard\r
- input mappings that this function supports. If the ESC sequence listed in one of the\r
- columns is presented, then it is translated into the coorespoding EFI Scan Code. If a\r
- matching sequence is not found, then the raw key strokes are converted into EFI Keys.\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 corresponding EFI Scan Code. If a matching sequence is not found, then the raw\r
+ key strokes are converted into EFI Keys.\r
+\r
2 seconds are allowed for an ESC sequence to be completed. If the ESC sequence is not\r
completed in 2 seconds, then the raw key strokes of the partial ESC sequence are\r
converted into EFI Keys.\r
There is one special input sequence that will force the system to reset.\r
This is ESC R ESC r ESC R.\r
\r
+ Note: current implementation support terminal types include: PC ANSI, VT100+/VTUTF8, VT100. \r
+ The table below is not same with UEFI Spec 2.3 Appendix B Table 201(not support ANSI X3.64 /\r
+ DEC VT200-500 and extra support PC ANSI, VT100)since UEFI Table 201 is just an example.\r
+ \r
Symbols used in table below\r
===========================\r
ESC = 0x1B\r
CSI = 0x9B\r
DEL = 0x7f\r
^ = CTRL\r
- \r
+\r
+=========+======+===========+==========+==========+\r
| | EFI | UEFI 2.0 | | |\r
| | Scan | | VT100+ | |\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
\r
-\r
@param TerminalDevice The terminal device to use to translate raw input into EFI Keys\r
\r
- @return None\r
-\r
**/\r
VOID\r
UnicodeToEfiKey (\r
\r
if (TerminalDevice->InputState != INPUT_STATE_DEFAULT) {\r
//\r
- // Check to see if the 2 second timer has expired\r
+ // Check to see if the 2 seconds timer has expired\r
//\r
TimerStatus = gBS->CheckEvent (TerminalDevice->TwoSecondTimeOut);\r
if (!EFI_ERROR (TimerStatus)) {\r
//\r
// Fetch one Unicode character from the Unicode FIFO\r
//\r
- UnicodeFiFoRemoveOneKey (TerminalDevice,&UnicodeChar);\r
+ UnicodeFiFoRemoveOneKey (TerminalDevice, &UnicodeChar);\r
\r
SetDefaultResetState = TRUE;\r
\r
if (TerminalDevice->ResetState == RESET_STATE_DEFAULT) {\r
TerminalDevice->ResetState = RESET_STATE_ESC_R;\r
SetDefaultResetState = FALSE;\r
- } else if (TerminalDevice->ResetState == RESET_STATE_ESC_R_ESC_r) {\r
+ } else if (TerminalDevice->ResetState == RESET_STATE_ESC_R_ESC_R) {\r
gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
}\r
Key.ScanCode = SCAN_NULL;\r
break;\r
case 'r':\r
if (TerminalDevice->ResetState == RESET_STATE_ESC_R) {\r
- TerminalDevice->ResetState = RESET_STATE_ESC_R_ESC_r;\r
+ TerminalDevice->ResetState = RESET_STATE_ESC_R_ESC_R;\r
SetDefaultResetState = FALSE;\r
}\r
Key.ScanCode = SCAN_NULL;\r
projects / mirror_edk2.git / blobdiff