]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
Clean up to update the reference of the these macros:
[mirror_edk2.git] / MdeModulePkg / Universal / Console / TerminalDxe / Terminal.h
index abe432437ee4432515da27045b23d90586dea7fb..1aedfee78856e858f6610336bcbb22f721c377c1 100644 (file)
@@ -16,7 +16,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define _TERMINAL_H_\r
 \r
 \r
-#include <PiDxe.h>\r
+#include <Uefi.h>\r
 #include <Protocol/SimpleTextOut.h>\r
 #include <Protocol/SerialIo.h>\r
 #include <Guid/GlobalVariable.h>\r
@@ -59,9 +59,9 @@ typedef struct {
   EFI_INPUT_KEY Data[FIFO_MAX_NUMBER + 1];\r
 } EFI_KEY_FIFO;\r
 \r
-#define TERMINAL_DEV_SIGNATURE  EFI_SIGNATURE_32 ('t', 'm', 'n', 'l')\r
+#define TERMINAL_DEV_SIGNATURE  SIGNATURE_32 ('t', 'm', 'n', 'l')\r
 \r
-#define TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE EFI_SIGNATURE_32 ('t', 'm', 'e', 'n')\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
@@ -181,8 +181,7 @@ EFIAPI
 InitializeTerminal (\r
   IN EFI_HANDLE         ImageHandle,\r
   IN EFI_SYSTEM_TABLE   *SystemTable\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.Reset().\r
@@ -201,8 +200,7 @@ EFIAPI
 TerminalConInReset (\r
   IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL    *This,\r
   IN  BOOLEAN                           ExtendedVerification\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -223,8 +221,7 @@ EFIAPI
 TerminalConInReadKeyStroke (\r
   IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This,\r
   OUT EFI_INPUT_KEY                   *Key\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Check if the key already has been registered.\r
@@ -244,8 +241,7 @@ BOOLEAN
 IsKeyRegistered (\r
   IN EFI_KEY_DATA  *RegsiteredData,\r
   IN EFI_KEY_DATA  *InputData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Event notification function for EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event\r
@@ -262,8 +258,7 @@ EFIAPI
 TerminalConInWaitForKeyEx (\r
   IN  EFI_EVENT       Event,\r
   IN  VOID            *Context\r
-  )\r
-;\r
+  );\r
 \r
 //\r
 // Simple Text Input Ex protocol prototypes\r
@@ -285,8 +280,7 @@ EFIAPI
 TerminalConInResetEx (\r
   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
   IN BOOLEAN                            ExtendedVerification\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads the next keystroke from the input device. The WaitForKey Event can\r
@@ -309,8 +303,7 @@ EFIAPI
 TerminalConInReadKeyStrokeEx (\r
   IN  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
   OUT EFI_KEY_DATA                      *KeyData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Set certain state for the input device.\r
@@ -332,8 +325,7 @@ EFIAPI
 TerminalConInSetState (\r
   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
   IN EFI_KEY_TOGGLE_STATE               *KeyToggleState\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Register a notification function for a particular keystroke for the input device.\r
@@ -361,8 +353,7 @@ TerminalConInRegisterKeyNotify (
   IN EFI_KEY_DATA                       *KeyData,\r
   IN EFI_KEY_NOTIFY_FUNCTION            KeyNotificationFunction,\r
   OUT EFI_HANDLE                        *NotifyHandle\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Remove a registered notification function from a particular keystroke.\r
@@ -382,8 +373,7 @@ EFIAPI
 TerminalConInUnregisterKeyNotify (\r
   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
   IN EFI_HANDLE                         NotificationHandle\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Event notification function for EFI_SIMPLE_TEXT_INPUT_PROTOCOL.WaitForKey event\r
@@ -400,8 +390,7 @@ EFIAPI
 TerminalConInWaitForKey (\r
   IN  EFI_EVENT     Event,\r
   IN  VOID          *Context\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.Reset().\r
@@ -423,8 +412,7 @@ EFIAPI
 TerminalConOutReset (\r
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *This,\r
   IN  BOOLEAN                            ExtendedVerification\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.OutputString().\r
@@ -447,8 +435,7 @@ EFIAPI
 TerminalConOutOutputString (\r
   IN   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
   IN  CHAR16                            *WString\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.TestString().\r
@@ -469,8 +456,7 @@ EFIAPI
 TerminalConOutTestString (\r
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
   IN  CHAR16                           *WString\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.QueryMode().\r
@@ -496,8 +482,7 @@ TerminalConOutQueryMode (
   IN  UINTN                            ModeNumber,\r
   OUT UINTN                            *Columns,\r
   OUT UINTN                            *Rows\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Implements EFI_SIMPLE_TEXT_OUT.SetMode().\r
@@ -518,8 +503,7 @@ EFIAPI
 TerminalConOutSetMode (\r
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
   IN  UINTN                            ModeNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute().\r
@@ -538,8 +522,7 @@ EFIAPI
 TerminalConOutSetAttribute (\r
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
   IN  UINTN                            Attribute\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.ClearScreen().\r
@@ -557,8 +540,7 @@ EFI_STATUS
 EFIAPI\r
 TerminalConOutClearScreen (\r
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetCursorPosition().\r
@@ -579,8 +561,7 @@ TerminalConOutSetCursorPosition (
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
   IN  UINTN                            Column,\r
   IN  UINTN                            Row\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Implements SIMPLE_TEXT_OUTPUT.EnableCursor().\r
@@ -599,14 +580,13 @@ EFIAPI
 TerminalConOutEnableCursor (\r
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,\r
   IN  BOOLEAN                          Visible\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Test to see if this driver supports Controller. \r
 \r
   @param  This                Protocol instance pointer.\r
-  @param  Controller          Handle of device to test\r
+  @param  ControllerHandle    Handle of device to test\r
   @param  RemainingDevicePath Optional parameter use to pick a specific child\r
                               device to start.\r
 \r
@@ -816,8 +796,7 @@ TerminalComponentNameGetControllerName (
 EFI_STATUS\r
 TerminalConInCheckForKey (\r
   IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Update terminal device path in Console Device Environment Variables.\r
@@ -832,8 +811,7 @@ VOID
 TerminalUpdateConsoleDevVariable (\r
   IN CHAR16                    *VariableName,\r
   IN EFI_DEVICE_PATH_PROTOCOL  *ParentDevicePath\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Remove console device variable.\r
@@ -848,8 +826,7 @@ VOID
 TerminalRemoveConsoleDevVariable (\r
   IN CHAR16                    *VariableName,\r
   IN EFI_DEVICE_PATH_PROTOCOL  *ParentDevicePath\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Read the EFI variable (VendorGuid/Name) and return a dynamically allocated\r
@@ -869,8 +846,7 @@ TerminalGetVariableAndSize (
   IN  CHAR16              *Name,\r
   IN  EFI_GUID            *VendorGuid,\r
   OUT UINTN               *VariableSize\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Build termial device path according to terminal type.\r
@@ -889,8 +865,7 @@ SetTerminalDevicePath (
   IN  UINT8                       TerminalType,\r
   IN  EFI_DEVICE_PATH_PROTOCOL    *ParentDevicePath,\r
   OUT EFI_DEVICE_PATH_PROTOCOL    **TerminalDevicePath\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Initialize the Raw Data FIFO.\r
@@ -903,8 +878,7 @@ SetTerminalDevicePath (
 VOID\r
 InitializeRawFiFo (\r
   IN  TERMINAL_DEV  *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Initialize the Unicode FIFO.\r
@@ -917,8 +891,7 @@ InitializeRawFiFo (
 VOID\r
 InitializeUnicodeFiFo (\r
   IN  TERMINAL_DEV  *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Initialize the EFI Key FIFO.\r
@@ -931,8 +904,7 @@ InitializeUnicodeFiFo (
 VOID\r
 InitializeEfiKeyFiFo (\r
   IN  TERMINAL_DEV  *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Get one key out of serial buffer.\r
@@ -950,8 +922,7 @@ EFI_STATUS
 GetOneKeyFromSerial (\r
   EFI_SERIAL_IO_PROTOCOL  *SerialIo,\r
   UINT8                   *Input\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Insert one byte raw data into the Raw Data FIFO.\r
@@ -968,8 +939,7 @@ BOOLEAN
 RawFiFoInsertOneKey (\r
   TERMINAL_DEV  *TerminalDevice,\r
   UINT8         Input\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Remove one pre-fetched key out of the Raw Data FIFO.\r
@@ -985,8 +955,7 @@ BOOLEAN
 RawFiFoRemoveOneKey (\r
   TERMINAL_DEV  *TerminalDevice,\r
   UINT8         *Output\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Clarify whether Raw Data FIFO buffer is empty.\r
@@ -1000,8 +969,7 @@ RawFiFoRemoveOneKey (
 BOOLEAN\r
 IsRawFiFoEmpty (\r
   TERMINAL_DEV  *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Clarify whether Raw Data FIFO buffer is full.\r
@@ -1015,8 +983,7 @@ IsRawFiFoEmpty (
 BOOLEAN\r
 IsRawFiFoFull (\r
   TERMINAL_DEV  *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Insert one pre-fetched key into the FIFO buffer.\r
@@ -1033,8 +1000,7 @@ BOOLEAN
 EfiKeyFiFoInsertOneKey (\r
   TERMINAL_DEV      *TerminalDevice,\r
   EFI_INPUT_KEY     Key\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Remove one pre-fetched key out of the FIFO buffer.\r
@@ -1050,8 +1016,7 @@ BOOLEAN
 EfiKeyFiFoRemoveOneKey (\r
   TERMINAL_DEV  *TerminalDevice,\r
   EFI_INPUT_KEY *Output\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Clarify whether FIFO buffer is empty.\r
@@ -1065,8 +1030,7 @@ EfiKeyFiFoRemoveOneKey (
 BOOLEAN\r
 IsEfiKeyFiFoEmpty (\r
   TERMINAL_DEV  *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Clarify whether FIFO buffer is full.\r
@@ -1080,8 +1044,7 @@ IsEfiKeyFiFoEmpty (
 BOOLEAN\r
 IsEfiKeyFiFoFull (\r
   TERMINAL_DEV  *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Insert one pre-fetched key into the Unicode FIFO buffer.\r
@@ -1098,8 +1061,7 @@ BOOLEAN
 UnicodeFiFoInsertOneKey (\r
   TERMINAL_DEV      *TerminalDevice,\r
   UINT16            Input\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Remove one pre-fetched key out of the Unicode FIFO buffer.\r
@@ -1115,8 +1077,7 @@ BOOLEAN
 UnicodeFiFoRemoveOneKey (\r
   TERMINAL_DEV  *TerminalDevice,\r
   UINT16        *Output\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Clarify whether Unicode FIFO buffer is empty.\r
@@ -1130,8 +1091,7 @@ UnicodeFiFoRemoveOneKey (
 BOOLEAN\r
 IsUnicodeFiFoEmpty (\r
   TERMINAL_DEV  *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Clarify whether Unicode FIFO buffer is full.\r
@@ -1145,8 +1105,7 @@ IsUnicodeFiFoEmpty (
 BOOLEAN\r
 IsUnicodeFiFoFull (\r
   TERMINAL_DEV  *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Count Unicode FIFO buffer.\r
@@ -1159,8 +1118,7 @@ IsUnicodeFiFoFull (
 UINT8\r
 UnicodeFiFoGetKeyCount (\r
   TERMINAL_DEV    *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Translate raw data into Unicode (according to different encode), and \r
@@ -1174,8 +1132,7 @@ UnicodeFiFoGetKeyCount (
 VOID\r
 TranslateRawDataToEfiKey (\r
   IN  TERMINAL_DEV      *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 //\r
 // internal functions for PC ANSI\r
@@ -1193,8 +1150,7 @@ TranslateRawDataToEfiKey (
 VOID\r
 AnsiRawDataToUnicode (\r
   IN  TERMINAL_DEV    *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Converts a stream of Unicode characters from a terminal input device into EFI Keys that\r
@@ -1264,8 +1220,7 @@ AnsiRawDataToUnicode (
 VOID\r
 UnicodeToEfiKey (\r
   IN  TERMINAL_DEV    *TerminalDevice\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Check if input string is valid Ascii string, valid EFI control characters\r
@@ -1282,8 +1237,7 @@ EFI_STATUS
 AnsiTestString (\r
   IN  TERMINAL_DEV    *TerminalDevice,\r
   IN  CHAR16          *WString\r
-  )\r
-;\r
+  );\r
 \r
 //\r
 // internal functions for VTUTF8\r
@@ -1301,8 +1255,7 @@ AnsiTestString (
 VOID\r
 VTUTF8RawDataToUnicode (\r
   IN  TERMINAL_DEV    *VtUtf8Device\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Check if input string is valid VT-UTF8 string.\r
@@ -1317,8 +1270,7 @@ EFI_STATUS
 VTUTF8TestString (\r
   IN  TERMINAL_DEV    *TerminalDevice,\r
   IN  CHAR16          *WString\r
-  )\r
-;\r
+  );\r
 \r
 /** \r
   Translate one Unicode character into VT-UTF8 characters.\r
@@ -1343,8 +1295,7 @@ UnicodeToUtf8 (
   IN  CHAR16      Unicode,\r
   OUT UTF8_CHAR   *Utf8Char,\r
   OUT UINT8       *ValidBytes\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Get one valid VT-UTF8 characters set from Raw Data FIFO.\r
@@ -1354,16 +1305,13 @@ UnicodeToUtf8 (
   @param  ValidBytes          The count of returned VT-VTF8 characters. \r
                               If ValidBytes is zero, no valid VT-UTF8 returned.\r
 \r
-  @retval None.\r
-\r
 **/\r
 VOID\r
 GetOneValidUtf8Char (\r
   IN  TERMINAL_DEV      *Utf8Device,\r
   OUT UTF8_CHAR         *Utf8Char,\r
   OUT UINT8             *ValidBytes\r
-  )\r
-;\r
+  );\r
 \r
 /** \r
   Translate VT-UTF8 characters into one Unicode character.\r
@@ -1387,8 +1335,7 @@ Utf8ToUnicode (
   IN  UTF8_CHAR       Utf8Char,\r
   IN  UINT8           ValidBytes,\r
   OUT CHAR16          *UnicodeChar\r
-  )\r
-;\r
+  );\r
 \r
 //\r
 // functions for boxdraw unicode\r
@@ -1411,8 +1358,7 @@ TerminalIsValidTextGraphics (
   IN  CHAR16  Graphic,\r
   OUT CHAR8   *PcAnsi, OPTIONAL\r
   OUT CHAR8   *Ascii OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Detects if a valid ASCII char.\r
@@ -1426,8 +1372,7 @@ TerminalIsValidTextGraphics (
 BOOLEAN\r
 TerminalIsValidAscii (\r
   IN  CHAR16  Ascii\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Detects if a valid EFI control character.\r
@@ -1441,7 +1386,6 @@ TerminalIsValidAscii (
 BOOLEAN\r
 TerminalIsValidEfiCntlChar (\r
   IN  CHAR16  CharC\r
-  )\r
-;\r
+  );\r
 \r
 #endif\r