diff options
Diffstat (limited to 'MdeModulePkg')
8 files changed, 127 insertions, 179 deletions
diff --git a/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsoleDxe.inf b/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsoleDxe.inf index b6a4bfe6a8..a12406c236 100644 --- a/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsoleDxe.inf +++ b/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsoleDxe.inf @@ -53,12 +53,12 @@ HiiLib
[Protocols]
- gEfiDevicePathProtocolGuid # PROTOCOL ALWAYS_CONSUMED
- gEfiSimpleTextOutProtocolGuid # PROTOCOL BY_START
- gEfiGraphicsOutputProtocolGuid # PROTOCOL TO_START
- gEfiUgaDrawProtocolGuid # PROTOCOL TO_START
- gEfiHiiFontProtocolGuid # PROTOCOL TO_START
- gEfiHiiDatabaseProtocolGuid # PROTOCOL TO_START
+ gEfiDevicePathProtocolGuid ## CONSUMES
+ gEfiSimpleTextOutProtocolGuid ## BY_START
+ gEfiGraphicsOutputProtocolGuid ## TO_START
+ gEfiUgaDrawProtocolGuid ## TO_START
+ gEfiHiiFontProtocolGuid ## TO_START
+ gEfiHiiDatabaseProtocolGuid ## TO_START
[FeaturePcd.common]
gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport
\ No newline at end of file diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Ansi.c b/MdeModulePkg/Universal/Console/TerminalDxe/Ansi.c index 58d35f1256..c24108b512 100644 --- a/MdeModulePkg/Universal/Console/TerminalDxe/Ansi.c +++ b/MdeModulePkg/Universal/Console/TerminalDxe/Ansi.c @@ -21,8 +21,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param TerminalDevice The terminal device.
- @return None.
-
**/
VOID
AnsiRawDataToUnicode (
diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.c b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.c index 6fd19de664..f39cbcd8f5 100644 --- a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.c +++ b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.c @@ -958,8 +958,6 @@ TerminalFreeNotifyList ( @param VariableName The Console Device Environment Variable.
@param ParentDevicePath The terminal device path to be updated.
- @return None.
-
**/
VOID
TerminalUpdateConsoleDevVariable (
@@ -1023,8 +1021,6 @@ TerminalUpdateConsoleDevVariable ( @param VariableName Console Device Environment Variables.
@param ParentDevicePath The terminal device path to be updated.
- @return None.
-
**/
VOID
TerminalRemoveConsoleDevVariable (
@@ -1288,8 +1284,6 @@ SetTerminalDevicePath ( @param TerminalDevice The terminal device.
- @return None.
-
**/
VOID
InitializeRawFiFo (
@@ -1307,8 +1301,6 @@ InitializeRawFiFo ( @param TerminalDevice The terminal device.
- @return None.
-
**/
VOID
InitializeUnicodeFiFo (
@@ -1326,8 +1318,6 @@ InitializeUnicodeFiFo ( @param TerminalDevice The terminal device.
- @return None.
-
**/
VOID
InitializeEfiKeyFiFo (
diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h index 1cea44b489..f228400142 100644 --- a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h +++ b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h @@ -191,8 +191,8 @@ InitializeTerminal ( @param This Indicates the calling context.
@param ExtendedVerification Skip by this driver.
- @return EFI_SUCCESS The reset operation succeeds.
- @return EFI_DEVICE_ERROR The dependent serial port reset fails.
+ @retval EFI_SUCCESS The reset operation succeeds.
+ @retval EFI_DEVICE_ERROR The dependent serial port reset fails.
**/
EFI_STATUS
@@ -211,9 +211,9 @@ TerminalConInReset ( keystroke information for the key that was sent
from terminal.
- @return EFI_SUCCESS The keystroke information is returned successfully.
- @return EFI_NOT_READY There is no keystroke data available.
- @return EFI_DEVICE_ERROR The dependent serial device encounters error.
+ @retval EFI_SUCCESS The keystroke information is returned successfully.
+ @retval EFI_NOT_READY There is no keystroke data available.
+ @retval EFI_DEVICE_ERROR The dependent serial device encounters error.
**/
EFI_STATUS
@@ -250,8 +250,6 @@ IsKeyRegistered ( @param Event Indicates the event that invoke this function.
@param Context Indicates the calling context.
- @return none.
-
**/
VOID
EFIAPI
@@ -382,8 +380,6 @@ TerminalConInUnregisterKeyNotify ( @param Event Indicates the event that invoke this function.
@param Context Indicates the calling context.
- @return None
-
**/
VOID
EFIAPI
@@ -403,8 +399,8 @@ TerminalConInWaitForKey ( exhaustive verification operation of the device
during reset.
- @return EFI_SUCCESS The reset operation succeeds.
- @return EFI_DEVICE_ERROR The terminal is not functioning correctly or the serial port reset fails.
+ @retval EFI_SUCCESS The reset operation succeeds.
+ @retval EFI_DEVICE_ERROR The terminal is not functioning correctly or the serial port reset fails.
**/
EFI_STATUS
@@ -447,8 +443,8 @@ TerminalConOutOutputString ( @param This Indicates the calling context.
@param WString The Null-terminated Unicode string to be tested.
- @return EFI_SUCCESS The terminal is capable of rendering the output string.
- @return EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be rendered.
+ @retval EFI_SUCCESS The terminal is capable of rendering the output string.
+ @retval EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be rendered.
**/
EFI_STATUS
@@ -470,9 +466,9 @@ TerminalConOutTestString ( @param Columns The returned columns of the requested mode.
@param Rows The returned rows of the requested mode.
- @return EFI_SUCCESS The requested mode information is returned.
- @return EFI_UNSUPPORTED The mode number is not valid.
- @return EFI_DEVICE_ERROR
+ @retval EFI_SUCCESS The requested mode information is returned.
+ @retval EFI_UNSUPPORTED The mode number is not valid.
+ @retval EFI_DEVICE_ERROR
**/
EFI_STATUS
@@ -492,10 +488,10 @@ TerminalConOutQueryMode ( @param This Indicates the calling context.
@param ModeNumber The text mode to set.
- @return EFI_SUCCESS The requested text mode is set.
- @return EFI_DEVICE_ERROR The requested text mode cannot be set
+ @retval EFI_SUCCESS The requested text mode is set.
+ @retval EFI_DEVICE_ERROR The requested text mode cannot be set
because of serial device error.
- @return EFI_UNSUPPORTED The text mode number is not valid.
+ @retval EFI_UNSUPPORTED The text mode number is not valid.
**/
EFI_STATUS
@@ -512,9 +508,9 @@ TerminalConOutSetMode ( @param Attribute The attribute to set. Only bit0..6 are valid, all other bits
are undefined and must be zero.
- @return EFI_SUCCESS The requested attribute is set.
- @return EFI_DEVICE_ERROR The requested attribute cannot be set due to serial port error.
- @return EFI_UNSUPPORTED The attribute requested is not defined by EFI spec.
+ @retval EFI_SUCCESS The requested attribute is set.
+ @retval EFI_DEVICE_ERROR The requested attribute cannot be set due to serial port error.
+ @retval EFI_UNSUPPORTED The attribute requested is not defined by EFI spec.
**/
EFI_STATUS
@@ -531,9 +527,9 @@ TerminalConOutSetAttribute ( @param This Indicates the calling context.
- @return EFI_SUCCESS The operation completed successfully.
- @return EFI_DEVICE_ERROR The terminal screen cannot be cleared due to serial port error.
- @return EFI_UNSUPPORTED The terminal is not in a valid display mode.
+ @retval EFI_SUCCESS The operation completed successfully.
+ @retval EFI_DEVICE_ERROR The terminal screen cannot be cleared due to serial port error.
+ @retval EFI_UNSUPPORTED The terminal is not in a valid display mode.
**/
EFI_STATUS
@@ -549,9 +545,9 @@ TerminalConOutClearScreen ( @param Column The row to set cursor to.
@param Row The column to set cursor to.
- @return EFI_SUCCESS The operation completed successfully.
- @return EFI_DEVICE_ERROR The request fails due to serial port error.
- @return EFI_UNSUPPORTED The terminal is not in a valid text mode, or the cursor position
+ @retval EFI_SUCCESS The operation completed successfully.
+ @retval EFI_DEVICE_ERROR The request fails due to serial port error.
+ @retval EFI_UNSUPPORTED The terminal is not in a valid text mode, or the cursor position
is invalid for current mode.
**/
@@ -571,8 +567,8 @@ TerminalConOutSetCursorPosition ( @param Visible If TRUE, the cursor is set to be visible,
If FALSE, the cursor is set to be invisible.
- @return EFI_SUCCESS The request is valid.
- @return EFI_UNSUPPORTED The terminal does not support cursor hidden.
+ @retval EFI_SUCCESS The request is valid.
+ @retval EFI_UNSUPPORTED The terminal does not support cursor hidden.
**/
EFI_STATUS
@@ -833,8 +829,6 @@ TerminalUpdateConsoleDevVariable ( @param VariableName A pointer to the variable name.
@param ParentDevicePath A pointer to the parent device path.
- @return None.
-
**/
VOID
TerminalRemoveConsoleDevVariable (
@@ -855,7 +849,7 @@ TerminalRemoveConsoleDevVariable ( NULL regturned.
**/
-VOID *
+VOID *
TerminalGetVariableAndSize (
IN CHAR16 *Name,
IN EFI_GUID *VendorGuid,
@@ -886,8 +880,6 @@ SetTerminalDevicePath ( @param TerminalDevice The terminal device.
- @return None.
-
**/
VOID
InitializeRawFiFo (
@@ -899,8 +891,6 @@ InitializeRawFiFo ( @param TerminalDevice The terminal device.
- @return None.
-
**/
VOID
InitializeUnicodeFiFo (
@@ -912,8 +902,6 @@ InitializeUnicodeFiFo ( @param TerminalDevice The terminal device.
- @return None.
-
**/
VOID
InitializeEfiKeyFiFo (
@@ -926,9 +914,9 @@ InitializeEfiKeyFiFo ( @param SerialIo Serial I/O protocl attached to the serial device.
@param Input The fetched key.
- @return EFI_NOT_READY If serial buffer is empty.
- @return EFI_DEVICE_ERROR If reading serial buffer encounter error.
- @return EFI_SUCCESS If reading serial buffer successfully, put
+ @retval EFI_NOT_READY If serial buffer is empty.
+ @retval EFI_DEVICE_ERROR If reading serial buffer encounter error.
+ @retval EFI_SUCCESS If reading serial buffer successfully, put
the fetched key to the parameter output.
**/
@@ -944,8 +932,8 @@ GetOneKeyFromSerial ( @param TerminalDevice Terminal driver private structure.
@param Input The key will be input.
- @return TRUE If insert successfully.
- @return FLASE If Raw Data buffer is full before key insertion,
+ @retval TRUE If insert successfully.
+ @retval FLASE If Raw Data buffer is full before key insertion,
and the key is lost.
**/
@@ -961,8 +949,8 @@ RawFiFoInsertOneKey ( @param TerminalDevice Terminal driver private structure.
@param Output The key will be removed.
- @return TRUE If insert successfully.
- @return FLASE If Raw Data FIFO buffer is empty before remove operation.
+ @retval TRUE If insert successfully.
+ @retval FLASE If Raw Data FIFO buffer is empty before remove operation.
**/
BOOLEAN
@@ -976,8 +964,8 @@ RawFiFoRemoveOneKey ( @param TerminalDevice Terminal driver private structure
- @return TRUE If Raw Data FIFO buffer is empty.
- @return FLASE If Raw Data FIFO buffer is not empty.
+ @retval TRUE If Raw Data FIFO buffer is empty.
+ @retval FLASE If Raw Data FIFO buffer is not empty.
**/
BOOLEAN
@@ -990,8 +978,8 @@ IsRawFiFoEmpty ( @param TerminalDevice Terminal driver private structure
- @return TRUE If Raw Data FIFO buffer is full.
- @return FLASE If Raw Data FIFO buffer is not full.
+ @retval TRUE If Raw Data FIFO buffer is full.
+ @retval FLASE If Raw Data FIFO buffer is not full.
**/
BOOLEAN
@@ -1005,8 +993,8 @@ IsRawFiFoFull ( @param TerminalDevice Terminal driver private structure.
@param Key The key will be input.
- @return TRUE If insert successfully.
- @return FLASE If FIFO buffer is full before key insertion,
+ @retval TRUE If insert successfully.
+ @retval FLASE If FIFO buffer is full before key insertion,
and the key is lost.
**/
@@ -1022,8 +1010,8 @@ EfiKeyFiFoInsertOneKey ( @param TerminalDevice Terminal driver private structure.
@param Output The key will be removed.
- @return TRUE If insert successfully.
- @return FLASE If FIFO buffer is empty before remove operation.
+ @retval TRUE If insert successfully.
+ @retval FLASE If FIFO buffer is empty before remove operation.
**/
BOOLEAN
@@ -1037,8 +1025,8 @@ EfiKeyFiFoRemoveOneKey ( @param TerminalDevice Terminal driver private structure
- @return TRUE If FIFO buffer is empty.
- @return FLASE If FIFO buffer is not empty.
+ @retval TRUE If FIFO buffer is empty.
+ @retval FLASE If FIFO buffer is not empty.
**/
BOOLEAN
@@ -1051,8 +1039,8 @@ IsEfiKeyFiFoEmpty ( @param TerminalDevice Terminal driver private structure
- @return TRUE If FIFO buffer is full.
- @return FLASE If FIFO buffer is not full.
+ @retval TRUE If FIFO buffer is full.
+ @retval FLASE If FIFO buffer is not full.
**/
BOOLEAN
@@ -1066,8 +1054,8 @@ IsEfiKeyFiFoFull ( @param TerminalDevice Terminal driver private structure.
@param Input The key will be input.
- @return TRUE If insert successfully.
- @return FLASE If Unicode FIFO buffer is full before key insertion,
+ @retval TRUE If insert successfully.
+ @retval FLASE If Unicode FIFO buffer is full before key insertion,
and the key is lost.
**/
@@ -1083,8 +1071,8 @@ UnicodeFiFoInsertOneKey ( @param TerminalDevice Terminal driver private structure.
@param Output The key will be removed.
- @return TRUE If insert successfully.
- @return FLASE If Unicode FIFO buffer is empty before remove operation.
+ @retval TRUE If insert successfully.
+ @retval FLASE If Unicode FIFO buffer is empty before remove operation.
**/
BOOLEAN
@@ -1098,8 +1086,8 @@ UnicodeFiFoRemoveOneKey ( @param TerminalDevice Terminal driver private structure
- @return TRUE If Unicode FIFO buffer is empty.
- @return FLASE If Unicode FIFO buffer is not empty.
+ @retval TRUE If Unicode FIFO buffer is empty.
+ @retval FLASE If Unicode FIFO buffer is not empty.
**/
BOOLEAN
@@ -1112,8 +1100,8 @@ IsUnicodeFiFoEmpty ( @param TerminalDevice Terminal driver private structure
- @return TRUE If Unicode FIFO buffer is full.
- @return FLASE If Unicode FIFO buffer is not full.
+ @retval TRUE If Unicode FIFO buffer is full.
+ @retval FLASE If Unicode FIFO buffer is not full.
**/
BOOLEAN
@@ -1140,8 +1128,6 @@ UnicodeFiFoGetKeyCount ( @param TerminalDevice Terminal driver private structure.
- @return none.
-
**/
VOID
TranslateRawDataToEfiKey (
@@ -1158,8 +1144,6 @@ TranslateRawDataToEfiKey ( @param TerminalDevice The terminal device.
- @return None.
-
**/
VOID
AnsiRawDataToUnicode (
@@ -1228,8 +1212,6 @@ AnsiRawDataToUnicode ( @param TerminalDevice The terminal device to use to translate raw input into EFI Keys
- @return None.
-
**/
VOID
UnicodeToEfiKey (
@@ -1263,8 +1245,6 @@ AnsiTestString ( @param VtUtf8Device The terminal device.
- @return None.
-
**/
VOID
VTUTF8RawDataToUnicode (
@@ -1300,8 +1280,6 @@ VTUTF8TestString ( @param Utf8Char Return VT-UTF8 character set.
@param ValidBytes The count of valid VT-UTF8 characters. If
ValidBytes is zero, no valid VT-UTF8 returned.
-
- @return None.
**/
VOID
@@ -1340,8 +1318,6 @@ GetOneValidUtf8Char ( @param Utf8Char VT-UTF8 character set needs translating.
@param ValidBytes The count of valid VT-UTF8 characters.
@param UnicodeChar Returned unicode character.
-
- @return None.
**/
VOID
@@ -1364,7 +1340,7 @@ Utf8ToUnicode ( @param Ascii Optional pointer to return ASCII equivalent of
Graphic.
- @return TRUE If Graphic is a supported Unicode Box Drawing character.
+ @retval TRUE If Graphic is a supported Unicode Box Drawing character.
**/
BOOLEAN
diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c index 406dcb7942..4bb2e77d01 100644 --- a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c +++ b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c @@ -92,8 +92,8 @@ ReadKeyStrokeWorker ( @param This Indicates the calling context.
@param ExtendedVerification Skip by this driver.
- @return EFI_SUCCESS The reset operation succeeds.
- @return EFI_DEVICE_ERROR The dependent serial port reset fails.
+ @retval EFI_SUCCESS The reset operation succeeds.
+ @retval EFI_DEVICE_ERROR The dependent serial port reset fails.
**/
EFI_STATUS
@@ -145,9 +145,9 @@ TerminalConInReset ( keystroke information for the key that was sent
from terminal.
- @return EFI_SUCCESS The keystroke information is returned successfully.
- @return EFI_NOT_READY There is no keystroke data available.
- @return EFI_DEVICE_ERROR The dependent serial device encounters error.
+ @retval EFI_SUCCESS The keystroke information is returned successfully.
+ @retval EFI_NOT_READY There is no keystroke data available.
+ @retval EFI_DEVICE_ERROR The dependent serial device encounters error.
**/
EFI_STATUS
@@ -218,8 +218,6 @@ IsKeyRegistered ( @param Event Indicates the event that invoke this function.
@param Context Indicates the calling context.
- @return none.
-
**/
VOID
EFIAPI
@@ -505,8 +503,6 @@ TerminalConInUnregisterKeyNotify ( @param TerminalDevice Terminal driver private structure.
- @return none.
-
**/
VOID
TranslateRawDataToEfiKey (
@@ -546,8 +542,6 @@ TranslateRawDataToEfiKey ( @param Event Indicates the event that invoke this function.
@param Context Indicates the calling context.
- @return None
-
**/
VOID
EFIAPI
@@ -693,9 +687,9 @@ TerminalConInCheckForKey ( @param SerialIo Serial I/O protocol attached to the serial device.
@param Output The fetched key.
- @return EFI_NOT_READY If serial buffer is empty.
- @return EFI_DEVICE_ERROR If reading serial buffer encounter error.
- @return EFI_SUCCESS If reading serial buffer successfully, put
+ @retval EFI_NOT_READY If serial buffer is empty.
+ @retval EFI_DEVICE_ERROR If reading serial buffer encounter error.
+ @retval EFI_SUCCESS If reading serial buffer successfully, put
the fetched key to the parameter output.
**/
@@ -739,8 +733,8 @@ GetOneKeyFromSerial ( @param TerminalDevice Terminal driver private structure.
@param Input The key will be input.
- @return TRUE If insert successfully.
- @return FLASE If Raw Data buffer is full before key insertion,
+ @retval TRUE If insert successfully.
+ @retval FLASE If Raw Data buffer is full before key insertion,
and the key is lost.
**/
@@ -774,8 +768,8 @@ RawFiFoInsertOneKey ( @param TerminalDevice Terminal driver private structure.
@param Output The key will be removed.
- @return TRUE If insert successfully.
- @return FLASE If Raw Data FIFO buffer is empty before remove operation.
+ @retval TRUE If insert successfully.
+ @retval FLASE If Raw Data FIFO buffer is empty before remove operation.
**/
BOOLEAN
@@ -808,8 +802,8 @@ RawFiFoRemoveOneKey ( @param TerminalDevice Terminal driver private structure
- @return TRUE If Raw Data FIFO buffer is empty.
- @return FLASE If Raw Data FIFO buffer is not empty.
+ @retval TRUE If Raw Data FIFO buffer is empty.
+ @retval FLASE If Raw Data FIFO buffer is not empty.
**/
BOOLEAN
@@ -829,8 +823,8 @@ IsRawFiFoEmpty ( @param TerminalDevice Terminal driver private structure
- @return TRUE If Raw Data FIFO buffer is full.
- @return FLASE If Raw Data FIFO buffer is not full.
+ @retval TRUE If Raw Data FIFO buffer is full.
+ @retval FLASE If Raw Data FIFO buffer is not full.
**/
BOOLEAN
@@ -858,8 +852,8 @@ IsRawFiFoFull ( @param TerminalDevice Terminal driver private structure.
@param Key The key will be input.
- @return TRUE If insert successfully.
- @return FLASE If FIFO buffer is full before key insertion,
+ @retval TRUE If insert successfully.
+ @retval FLASE If FIFO buffer is full before key insertion,
and the key is lost.
**/
@@ -893,8 +887,8 @@ EfiKeyFiFoInsertOneKey ( @param TerminalDevice Terminal driver private structure.
@param Output The key will be removed.
- @return TRUE If insert successfully.
- @return FLASE If FIFO buffer is empty before remove operation.
+ @retval TRUE If insert successfully.
+ @retval FLASE If FIFO buffer is empty before remove operation.
**/
BOOLEAN
@@ -928,8 +922,8 @@ EfiKeyFiFoRemoveOneKey ( @param TerminalDevice Terminal driver private structure
- @return TRUE If FIFO buffer is empty.
- @return FLASE If FIFO buffer is not empty.
+ @retval TRUE If FIFO buffer is empty.
+ @retval FLASE If FIFO buffer is not empty.
**/
BOOLEAN
@@ -949,8 +943,8 @@ IsEfiKeyFiFoEmpty ( @param TerminalDevice Terminal driver private structure
- @return TRUE If FIFO buffer is full.
- @return FLASE If FIFO buffer is not full.
+ @retval TRUE If FIFO buffer is full.
+ @retval FLASE If FIFO buffer is not full.
**/
BOOLEAN
@@ -978,8 +972,8 @@ IsEfiKeyFiFoFull ( @param TerminalDevice Terminal driver private structure.
@param Input The key will be input.
- @return TRUE If insert successfully.
- @return FLASE If Unicode FIFO buffer is full before key insertion,
+ @retval TRUE If insert successfully.
+ @retval FLASE If Unicode FIFO buffer is full before key insertion,
and the key is lost.
**/
@@ -1013,8 +1007,8 @@ UnicodeFiFoInsertOneKey ( @param TerminalDevice Terminal driver private structure.
@param Output The key will be removed.
- @return TRUE If insert successfully.
- @return FLASE If Unicode FIFO buffer is empty before remove operation.
+ @retval TRUE If insert successfully.
+ @retval FLASE If Unicode FIFO buffer is empty before remove operation.
**/
BOOLEAN
@@ -1047,8 +1041,8 @@ UnicodeFiFoRemoveOneKey ( @param TerminalDevice Terminal driver private structure
- @return TRUE If Unicode FIFO buffer is empty.
- @return FLASE If Unicode FIFO buffer is not empty.
+ @retval TRUE If Unicode FIFO buffer is empty.
+ @retval FLASE If Unicode FIFO buffer is not empty.
**/
BOOLEAN
@@ -1068,8 +1062,8 @@ IsUnicodeFiFoEmpty ( @param TerminalDevice Terminal driver private structure
- @return TRUE If Unicode FIFO buffer is full.
- @return FLASE If Unicode FIFO buffer is not full.
+ @retval TRUE If Unicode FIFO buffer is full.
+ @retval FLASE If Unicode FIFO buffer is not full.
**/
BOOLEAN
@@ -1122,8 +1116,6 @@ UnicodeFiFoGetKeyCount ( @param TerminalDevice The terminal device to use to translate raw input into EFI Keys
- @return None.
-
**/
VOID
UnicodeToEfiKeyFlushState (
@@ -1240,8 +1232,6 @@ UnicodeToEfiKeyFlushState ( @param TerminalDevice The terminal device to use to translate raw input into EFI Keys
- @return None.
-
**/
VOID
UnicodeToEfiKey (
diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConOut.c b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConOut.c index 83f7c900e3..3c2f45bb6b 100644 --- a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConOut.c +++ b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConOut.c @@ -99,8 +99,8 @@ CHAR16 mSetCursorPositionString[] = { ESC, '[', '0', '0', ';', '0', '0', 'H', 0 exhaustive verification operation of the device
during reset.
- @return EFI_SUCCESS The reset operation succeeds.
- @return EFI_DEVICE_ERROR The terminal is not functioning correctly or the serial port reset fails.
+ @retval EFI_SUCCESS The reset operation succeeds.
+ @retval EFI_DEVICE_ERROR The terminal is not functioning correctly or the serial port reset fails.
**/
EFI_STATUS
@@ -346,8 +346,8 @@ OutputError: @param This Indicates the calling context.
@param WString The Null-terminated Unicode string to be tested.
- @return EFI_SUCCESS The terminal is capable of rendering the output string.
- @return EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be rendered.
+ @retval EFI_SUCCESS The terminal is capable of rendering the output string.
+ @retval EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be rendered.
**/
EFI_STATUS
@@ -399,9 +399,9 @@ TerminalConOutTestString ( @param Columns The returned columns of the requested mode.
@param Rows The returned rows of the requested mode.
- @return EFI_SUCCESS The requested mode information is returned.
- @return EFI_UNSUPPORTED The mode number is not valid.
- @return EFI_DEVICE_ERROR
+ @retval EFI_SUCCESS The requested mode information is returned.
+ @retval EFI_UNSUPPORTED The mode number is not valid.
+ @retval EFI_DEVICE_ERROR
**/
EFI_STATUS
@@ -444,10 +444,10 @@ TerminalConOutQueryMode ( @param This Indicates the calling context.
@param ModeNumber The text mode to set.
- @return EFI_SUCCESS The requested text mode is set.
- @return EFI_DEVICE_ERROR The requested text mode cannot be set
+ @retval EFI_SUCCESS The requested text mode is set.
+ @retval EFI_DEVICE_ERROR The requested text mode cannot be set
because of serial device error.
- @return EFI_UNSUPPORTED The text mode number is not valid.
+ @retval EFI_UNSUPPORTED The text mode number is not valid.
**/
EFI_STATUS
@@ -503,9 +503,9 @@ TerminalConOutSetMode ( @param Attribute The attribute to set. Only bit0..6 are valid, all other bits
are undefined and must be zero.
- @return EFI_SUCCESS The requested attribute is set.
- @return EFI_DEVICE_ERROR The requested attribute cannot be set due to serial port error.
- @return EFI_UNSUPPORTED The attribute requested is not defined by EFI spec.
+ @retval EFI_SUCCESS The requested attribute is set.
+ @retval EFI_DEVICE_ERROR The requested attribute cannot be set due to serial port error.
+ @retval EFI_UNSUPPORTED The attribute requested is not defined by EFI spec.
**/
EFI_STATUS
@@ -676,9 +676,9 @@ TerminalConOutSetAttribute ( @param This Indicates the calling context.
- @return EFI_SUCCESS The operation completed successfully.
- @return EFI_DEVICE_ERROR The terminal screen cannot be cleared due to serial port error.
- @return EFI_UNSUPPORTED The terminal is not in a valid display mode.
+ @retval EFI_SUCCESS The operation completed successfully.
+ @retval EFI_DEVICE_ERROR The terminal screen cannot be cleared due to serial port error.
+ @retval EFI_UNSUPPORTED The terminal is not in a valid display mode.
**/
EFI_STATUS
@@ -716,9 +716,9 @@ TerminalConOutClearScreen ( @param Column The row to set cursor to.
@param Row The column to set cursor to.
- @return EFI_SUCCESS The operation completed successfully.
- @return EFI_DEVICE_ERROR The request fails due to serial port error.
- @return EFI_UNSUPPORTED The terminal is not in a valid text mode, or the cursor position
+ @retval EFI_SUCCESS The operation completed successfully.
+ @retval EFI_DEVICE_ERROR The request fails due to serial port error.
+ @retval EFI_UNSUPPORTED The terminal is not in a valid text mode, or the cursor position
is invalid for current mode.
**/
@@ -794,8 +794,8 @@ TerminalConOutSetCursorPosition ( @param Visible If TRUE, the cursor is set to be visible,
If FALSE, the cursor is set to be invisible.
- @return EFI_SUCCESS The request is valid.
- @return EFI_UNSUPPORTED The terminal does not support cursor hidden.
+ @retval EFI_SUCCESS The request is valid.
+ @retval EFI_UNSUPPORTED The terminal does not support cursor hidden.
**/
EFI_STATUS
@@ -822,7 +822,7 @@ TerminalConOutEnableCursor ( @param Ascii Optional pointer to return ASCII equivalent of
Graphic.
- @return TRUE If Graphic is a supported Unicode Box Drawing character.
+ @retval TRUE If Graphic is a supported Unicode Box Drawing character.
**/
BOOLEAN
diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalDxe.inf b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalDxe.inf index ff0f788c88..67e154df56 100644 --- a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalDxe.inf +++ b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalDxe.inf @@ -60,20 +60,20 @@ BaseLib
[Guids]
- gEfiGlobalVariableGuid # SOMETIMES_CONSUMED L"ErrOutDev"
- gEfiVTUTF8Guid # SOMETIMES_CONSUMED
- gEfiVT100Guid # SOMETIMES_CONSUMED
- gEfiVT100PlusGuid # SOMETIMES_CONSUMED
- gEfiPcAnsiGuid # SOMETIMES_CONSUMED
- gSimpleTextInExNotifyGuid # SOMETIMES_CONSUMED
- gEfiHotPlugDeviceGuid # PROTOCOL SOMETIMES_CONSUMED
+ gEfiGlobalVariableGuid ## SOMETIMES_CONSUMES ## Variable:L"ErrOutDev"
+ gEfiVTUTF8Guid ## SOMETIMES_CONSUMES ## GUID
+ gEfiVT100Guid ## SOMETIMES_CONSUMES ## GUID
+ gEfiVT100PlusGuid ## SOMETIMES_CONSUMES ## GUID
+ gEfiPcAnsiGuid ## SOMETIMES_CONSUMES ## GUID
+ gSimpleTextInExNotifyGuid ## SOMETIMES_CONSUMES ##
+ gEfiHotPlugDeviceGuid ## SOMETIMES_CONSUMES ##
[Protocols]
- gEfiSerialIoProtocolGuid # PROTOCOL TO_START
- gEfiDevicePathProtocolGuid # PROTOCOL TO_START
- gEfiSimpleTextInProtocolGuid # PROTOCOL BY_START
- gEfiSimpleTextInputExProtocolGuid # PROTOCOL BY_START
- gEfiSimpleTextOutProtocolGuid # PROTOCOL BY_START
+ gEfiSerialIoProtocolGuid ## TO_START
+ gEfiDevicePathProtocolGuid ## TO_START
+ gEfiSimpleTextInProtocolGuid ## BY_START
+ gEfiSimpleTextInputExProtocolGuid ## BY_START
+ gEfiSimpleTextOutProtocolGuid ## BY_START
[Pcd]
gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueRemoteConsoleError
diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Vtutf8.c b/MdeModulePkg/Universal/Console/TerminalDxe/Vtutf8.c index 6b1ec577f8..179f718e15 100644 --- a/MdeModulePkg/Universal/Console/TerminalDxe/Vtutf8.c +++ b/MdeModulePkg/Universal/Console/TerminalDxe/Vtutf8.c @@ -20,8 +20,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param TerminalDevice The terminal device.
- @return None.
-
**/
VOID
VTUTF8RawDataToUnicode (
@@ -179,8 +177,6 @@ GetOneValidUtf8Char ( @param Utf8Char VT-UTF8 character set needs translating.
@param ValidBytes The count of valid VT-UTF8 characters.
@param UnicodeChar Returned unicode character.
-
- @return None.
**/
VOID
@@ -255,8 +251,6 @@ Utf8ToUnicode ( @param Utf8Char Return VT-UTF8 character set.
@param ValidBytes The count of valid VT-UTF8 characters. If
ValidBytes is zero, no valid VT-UTF8 returned.
-
- @return None.
**/
VOID
|