@param This Indicates the calling context.\r
@param ExtendedVerification Skip by this driver.\r
\r
- @return EFI_SUCCESS The reset operation succeeds.\r
- @return EFI_DEVICE_ERROR 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
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
keystroke information for the key that was sent\r
from terminal.\r
\r
- @return EFI_SUCCESS The keystroke information is returned successfully.\r
- @return EFI_NOT_READY There is no keystroke data available.\r
- @return EFI_DEVICE_ERROR 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
Check if the key already has been registered.\r
- \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
@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
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
\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
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 (NotificationHandle == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\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
/**\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
- @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
@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
@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
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
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
- @return None.\r
+ @param TerminalDevice The terminal device to use to translate raw input into EFI Keys\r
\r
**/\r
VOID\r
{\r
EFI_INPUT_KEY Key;\r
UINT32 InputState;\r
- \r
+\r
InputState = TerminalDevice->InputState;\r
- \r
+\r
if ((InputState & INPUT_STATE_ESC) != 0) {\r
Key.ScanCode = SCAN_ESC;\r
Key.UnicodeChar = 0;\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 corresponding EFI Scan Code. If a matching sequence is not found, then the raw\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
projects / mirror_edk2.git / blobdiff