code scrub for ConSplitter module.

[mirror_edk2.git] / MdeModulePkg / Universal / Console / ConSplitterDxe / ConSplitter.h

diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
index f4060a29ad360f45595bd913e53eda8089c9a8b5..b1bb79176e15e85a2c04cab089969e56c9a86d1d 100644 (file)
--- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
+++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
@@ -183,40 +183,40 @@ typedef struct {
 } TEXT_OUT_AND_GOP_DATA;\r
 \r
 typedef struct {\r
-  UINT64                             Signature;\r
-  EFI_HANDLE                         VirtualHandle;\r
-  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    TextOut;\r
-  EFI_SIMPLE_TEXT_OUTPUT_MODE        TextOutMode;\r
-\r
-  EFI_UGA_DRAW_PROTOCOL              UgaDraw;\r
-  UINT32                             UgaHorizontalResolution;\r
-  UINT32                             UgaVerticalResolution;\r
-  UINT32                             UgaColorDepth;\r
-  UINT32                             UgaRefreshRate;\r
-  EFI_UGA_PIXEL                      *UgaBlt;\r
-\r
-  EFI_GRAPHICS_OUTPUT_PROTOCOL       GraphicsOutput;\r
-  EFI_GRAPHICS_OUTPUT_BLT_PIXEL      *GraphicsOutputBlt;\r
+  UINT64                                Signature;\r
+  EFI_HANDLE                            VirtualHandle;\r
+  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL       TextOut;\r
+  EFI_SIMPLE_TEXT_OUTPUT_MODE           TextOutMode;\r
+                                        \r
+  EFI_UGA_DRAW_PROTOCOL                 UgaDraw;\r
+  UINT32                                UgaHorizontalResolution;\r
+  UINT32                                UgaVerticalResolution;\r
+  UINT32                                UgaColorDepth;\r
+  UINT32                                UgaRefreshRate;\r
+  EFI_UGA_PIXEL                         *UgaBlt;\r
+                                        \r
+  EFI_GRAPHICS_OUTPUT_PROTOCOL          GraphicsOutput;\r
+  EFI_GRAPHICS_OUTPUT_BLT_PIXEL         *GraphicsOutputBlt;\r
   EFI_GRAPHICS_OUTPUT_MODE_INFORMATION  *GraphicsOutputModeBuffer;\r
-  UINTN                              CurrentNumberOfGraphicsOutput;\r
-  UINTN                              CurrentNumberOfUgaDraw;\r
-  BOOLEAN                            HardwareNeedsStarting;\r
-\r
-  EFI_CONSOLE_CONTROL_PROTOCOL       ConsoleControl;\r
-\r
-  UINTN                              CurrentNumberOfConsoles;\r
-  TEXT_OUT_AND_GOP_DATA              *TextOutList;\r
-  UINTN                              TextOutListCount;\r
-  TEXT_OUT_SPLITTER_QUERY_DATA       *TextOutQueryData;\r
-  UINTN                              TextOutQueryDataCount;\r
-  INT32                              *TextOutModeMap;\r
-\r
-  EFI_CONSOLE_CONTROL_SCREEN_MODE    ConsoleOutputMode;\r
-\r
-  UINTN                              DevNullColumns;\r
-  UINTN                              DevNullRows;\r
-  CHAR16                             *DevNullScreen;\r
-  INT32                              *DevNullAttributes;\r
+  UINTN                                 CurrentNumberOfGraphicsOutput;\r
+  UINTN                                 CurrentNumberOfUgaDraw;\r
+  BOOLEAN                               HardwareNeedsStarting;\r
+                                        \r
+  EFI_CONSOLE_CONTROL_PROTOCOL          ConsoleControl;\r
+                                        \r
+  UINTN                                 CurrentNumberOfConsoles;\r
+  TEXT_OUT_AND_GOP_DATA                 *TextOutList;\r
+  UINTN                                 TextOutListCount;\r
+  TEXT_OUT_SPLITTER_QUERY_DATA          *TextOutQueryData;\r
+  UINTN                                 TextOutQueryDataCount;\r
+  INT32                                 *TextOutModeMap;\r
+                                        \r
+  EFI_CONSOLE_CONTROL_SCREEN_MODE       ConsoleOutputMode;\r
+                                        \r
+  UINTN                                 DevNullColumns;\r
+  UINTN                                 DevNullRows;\r
+  CHAR16                                *DevNullScreen;\r
+  INT32                                 *DevNullAttributes;\r
 \r
 } TEXT_OUT_SPLITTER_PRIVATE_DATA;\r
 \r
@@ -276,12 +276,14 @@ ConSplitterDriverEntry (
 ;\r
 \r
 /**\r
-  Construct the ConSplitter.\r
+  Construct console input devices' private data.\r
 \r
   @param  ConInPrivate             A pointer to the TEXT_IN_SPLITTER_PRIVATE_DATA\r
                                    structure.\r
 \r
   @retval EFI_OUT_OF_RESOURCES     Out of resources.\r
+  @retval EFI_SUCCESS              Console Input Devcie's private data has been constructed.\r
+  @retval other                    Failed to construct private data.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -293,10 +295,11 @@ ConSplitterTextInConstructor (
 /**\r
   Construct console output devices' private data.\r
 \r
-  @param  ConInPrivate             A pointer to the TEXT_IN_SPLITTER_PRIVATE_DATA\r
+  @param  ConOutPrivate            A pointer to the TEXT_IN_SPLITTER_PRIVATE_DATA\r
                                    structure.\r
 \r
   @retval EFI_OUT_OF_RESOURCES     Out of resources.\r
+  @retval EFI_SUCCESS              Text Input Devcie's private data has been constructed.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -310,13 +313,15 @@ ConSplitterTextOutConstructor (
 //\r
 \r
 /**\r
-  Console In Supported Check\r
+  Test to see if Console In Device could be supported on the ControllerHandle. \r
 \r
-  @param  This                     Pointer to protocol.\r
-  @param  ControllerHandle         Controller handle.\r
-  @param  RemainingDevicePath      Remaining device path.\r
+  @param  This                Protocol instance pointer.\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
-  @return EFI_STATUS\r
+  @retval EFI_SUCCESS         This driver supports this device.\r
+  @retval other               This driver does not support this device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -329,13 +334,15 @@ ConSplitterConInDriverBindingSupported (
 ;\r
 \r
 /**\r
-  Standard Error Supported Check\r
+  Test to see if Simple Pointer protocol could be supported on the ControllerHandle. \r
 \r
-  @param  This                     Pointer to protocol.\r
-  @param  ControllerHandle         Controller handle.\r
-  @param  RemainingDevicePath      Remaining device path.\r
+  @param  This                Protocol instance pointer.\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
-  @return EFI_STATUS\r
+  @retval EFI_SUCCESS         This driver supports this device.\r
+  @retval other               This driver does not support this device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -348,13 +355,15 @@ ConSplitterSimplePointerDriverBindingSupported (
 ;\r
 \r
 /**\r
-  Console Out Supported Check\r
+  Test to see if Console Out Device could be supported on the ControllerHandle. \r
 \r
-  @param  This                     Pointer to protocol.\r
-  @param  ControllerHandle         Controller handle.\r
-  @param  RemainingDevicePath      Remaining device path.\r
+  @param  This                Protocol instance pointer.\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
-  @return EFI_STATUS\r
+  @retval EFI_SUCCESS         This driver supports this device.\r
+  @retval other               This driver does not support this device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -367,13 +376,15 @@ ConSplitterConOutDriverBindingSupported (
 ;\r
 \r
 /**\r
-  Standard Error Supported Check\r
+  Test to see if Standard Error Device could be supported on the ControllerHandle. \r
 \r
-  @param  This                     Pointer to protocol.\r
-  @param  ControllerHandle         Controller handle.\r
-  @param  RemainingDevicePath      Remaining device path.\r
+  @param  This                Protocol instance pointer.\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
-  @return EFI_STATUS\r
+  @retval EFI_SUCCESS         This driver supports this device.\r
+  @retval other               This driver does not support this device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -571,8 +582,8 @@ ConSplitterStdErrDriverBindingStop (
   @param  RemainingDevicePath Optional parameter use to pick a specific child\r
                               device to start.\r
 \r
-  @retval EFI_SUCCESS         This driver supports this device\r
-  @retval other               This driver does not support this device\r
+  @retval EFI_SUCCESS         This driver supports this device.\r
+  @retval other               This driver does not support this device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1944,7 +1955,7 @@ ConSpliterGraphicsOutputQueryMode (
 ;\r
 \r
 /**\r
-  Graphics output protocol interface to set video mode\r
+  Graphics output protocol interface to set video mode.\r
 \r
   @param  This                    Protocol instance pointer.\r
   @param  ModeNumber              The mode number to be set.\r