code scrub for ConSplitter module.
authorvanjeff <vanjeff@de2fecce-e211-0410-80a6-f3fac2684e05>
Fri, 1 Aug 2008 07:38:26 +0000 (07:38 +0000)
committervanjeff <vanjeff@de2fecce-e211-0410-80a6-f3fac2684e05>
Fri, 1 Aug 2008 07:38:26 +0000 (07:38 +0000)
git-svn-id: https://edk2.tianocore.org/svn/edk2/trunk@5598 de2fecce-e211-0410-80a6-f3fac2684e05

edk2/MdeModulePkg/Universal/Console/ConSplitterDxe/ComponentName.c
edk2/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
edk2/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
edk2/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitterGraphics.c

index e9c3f5d..a75f78c 100644 (file)
@@ -274,6 +274,9 @@ ConSplitterTestControllerHandles (
     return EFI_UNSUPPORTED;\r
   }\r
 \r
+  //\r
+  // Tests whether a controller handle is being managed by a specific driver.\r
+  //\r
   Status = EfiTestManagedDevice (\r
              ControllerHandle,\r
              DriverBindingHandle,\r
@@ -283,6 +286,9 @@ ConSplitterTestControllerHandles (
     return Status;\r
   }\r
 \r
+  //\r
+  // Tests whether a child handle is a child device of the controller.\r
+  //\r
   Status = EfiTestChildHandle (\r
              ControllerHandle,\r
              ChildHandle,\r
index 4cf4dd0..db9f245 100644 (file)
@@ -30,7 +30,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "ConSplitter.h"\r
 \r
 //\r
-// Global Variables\r
+// Template for Text In Splitter\r
 //\r
 STATIC TEXT_IN_SPLITTER_PRIVATE_DATA  mConIn = {\r
   TEXT_IN_SPLITTER_PRIVATE_DATA_SIGNATURE,\r
@@ -117,19 +117,28 @@ STATIC TEXT_IN_SPLITTER_PRIVATE_DATA  mConIn = {
   FALSE\r
 };\r
 \r
-GLOBAL_REMOVE_IF_UNREFERENCED EFI_UGA_DRAW_PROTOCOL gUgaDrawProtocolTemplate = {\r
+//\r
+// Template for Uga Draw Protocol\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UGA_DRAW_PROTOCOL mUgaDrawProtocolTemplate = {\r
   ConSpliterUgaDrawGetMode,\r
   ConSpliterUgaDrawSetMode,\r
   ConSpliterUgaDrawBlt\r
 };\r
 \r
-GLOBAL_REMOVE_IF_UNREFERENCED EFI_GRAPHICS_OUTPUT_PROTOCOL gGraphicsOutputProtocolTemplate = {\r
+//\r
+// Template for Graphics Output Protocol\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_GRAPHICS_OUTPUT_PROTOCOL mGraphicsOutputProtocolTemplate = {\r
   ConSpliterGraphicsOutputQueryMode,\r
   ConSpliterGraphicsOutputSetMode,\r
   ConSpliterGraphicsOutputBlt,\r
   NULL\r
 };\r
 \r
+//\r
+// Template for Text Out Splitter\r
+//\r
 STATIC TEXT_OUT_SPLITTER_PRIVATE_DATA mConOut = {\r
   TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE,\r
   (EFI_HANDLE) NULL,\r
@@ -194,6 +203,9 @@ STATIC TEXT_OUT_SPLITTER_PRIVATE_DATA mConOut = {
   (INT32 *) NULL\r
 };\r
 \r
+//\r
+// Template for Standard Error Text Out Splitter\r
+//\r
 STATIC TEXT_OUT_SPLITTER_PRIVATE_DATA mStdErr = {\r
   TEXT_OUT_SPLITTER_PRIVATE_DATA_SIGNATURE,\r
   (EFI_HANDLE) NULL,\r
@@ -258,6 +270,9 @@ STATIC TEXT_OUT_SPLITTER_PRIVATE_DATA mStdErr = {
   (INT32 *) NULL\r
 };\r
 \r
+//\r
+// Driver binding instance for Console Input Device\r
+//\r
 EFI_DRIVER_BINDING_PROTOCOL           gConSplitterConInDriverBinding = {\r
   ConSplitterConInDriverBindingSupported,\r
   ConSplitterConInDriverBindingStart,\r
@@ -267,6 +282,9 @@ EFI_DRIVER_BINDING_PROTOCOL           gConSplitterConInDriverBinding = {
   NULL\r
 };\r
 \r
+//\r
+// Driver binding instance for Simple Pointer protocol\r
+//\r
 EFI_DRIVER_BINDING_PROTOCOL           gConSplitterSimplePointerDriverBinding = {\r
   ConSplitterSimplePointerDriverBindingSupported,\r
   ConSplitterSimplePointerDriverBindingStart,\r
@@ -288,6 +306,9 @@ EFI_DRIVER_BINDING_PROTOCOL           gConSplitterAbsolutePointerDriverBinding =
   NULL\r
 };\r
 \r
+//\r
+// Driver binding instance for Console Out device\r
+//\r
 EFI_DRIVER_BINDING_PROTOCOL           gConSplitterConOutDriverBinding = {\r
   ConSplitterConOutDriverBindingSupported,\r
   ConSplitterConOutDriverBindingStart,\r
@@ -297,6 +318,9 @@ EFI_DRIVER_BINDING_PROTOCOL           gConSplitterConOutDriverBinding = {
   NULL\r
 };\r
 \r
+//\r
+// Driver binding instance for Standard Error device\r
+//\r
 EFI_DRIVER_BINDING_PROTOCOL           gConSplitterStdErrDriverBinding = {\r
   ConSplitterStdErrDriverBindingSupported,\r
   ConSplitterStdErrDriverBindingStart,\r
@@ -521,7 +545,8 @@ ConSplitterDriverEntry(
                                    structure.\r
 \r
   @retval EFI_OUT_OF_RESOURCES     Out of resources.\r
-  @retval other     Out of resources.\r
+  @retval EFI_SUCCESS              Text Input Devcie's private data has been constructed.\r
+  @retval other                    Failed to construct private data.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -638,6 +663,7 @@ ConSplitterTextInConstructor (
                                    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
@@ -652,11 +678,11 @@ ConSplitterTextOutConstructor (
   // Copy protocols template\r
   //\r
   if (FeaturePcdGet (PcdConOutUgaSupport)) {\r
-    CopyMem (&ConOutPrivate->UgaDraw, &gUgaDrawProtocolTemplate, sizeof (EFI_UGA_DRAW_PROTOCOL));\r
+    CopyMem (&ConOutPrivate->UgaDraw, &mUgaDrawProtocolTemplate, sizeof (EFI_UGA_DRAW_PROTOCOL));\r
   }\r
 \r
   if (FeaturePcdGet (PcdConOutGopSupport)) {\r
-    CopyMem (&ConOutPrivate->GraphicsOutput, &gGraphicsOutputProtocolTemplate, sizeof (EFI_GRAPHICS_OUTPUT_PROTOCOL));\r
+    CopyMem (&ConOutPrivate->GraphicsOutput, &mGraphicsOutputProtocolTemplate, sizeof (EFI_GRAPHICS_OUTPUT_PROTOCOL));\r
   }\r
 \r
   //\r
@@ -735,13 +761,13 @@ ConSplitterTextOutConstructor (
 \r
     ConOutPrivate->GraphicsOutput.Mode->MaxMode = 1;\r
     //\r
-    // Initial current mode to unknow state, and then set to mode 0\r
+    // Initial current mode to unknown state, and then set to mode 0\r
     //\r
     ConOutPrivate->GraphicsOutput.Mode->Mode = 0xffff;\r
     ConOutPrivate->GraphicsOutput.SetMode (&ConOutPrivate->GraphicsOutput, 0);\r
   }\r
 \r
-  return Status;\r
+  return EFI_SUCCESS;\r
 }\r
 \r
 \r
@@ -814,8 +840,8 @@ ConSplitterSupported (
   @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
@@ -841,8 +867,8 @@ ConSplitterConInDriverBindingSupported (
   @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
@@ -869,8 +895,8 @@ ConSplitterSimplePointerDriverBindingSupported (
   @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
@@ -897,8 +923,8 @@ ConSplitterAbsolutePointerDriverBindingSupported (
   @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
@@ -924,8 +950,8 @@ ConSplitterConOutDriverBindingSupported (
   @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
@@ -956,7 +982,7 @@ ConSplitterStdErrDriverBindingSupported (
   @param  InterfaceGuid             The specified protocol to be opened.\r
   @param  Interface                 Protocol interface returned.\r
 \r
-  @retval EFI_SUCCESS               This driver supports this device\r
+  @retval EFI_SUCCESS               This driver supports this device.\r
   @retval other                     Failed to open the specified Console Device Guid\r
                                     or specified protocol.\r
 \r
@@ -1052,6 +1078,9 @@ ConSplitterConInDriverBindingStart (
     return Status;\r
   }\r
 \r
+  //\r
+  // Add this device into Text In devices list.\r
+  //\r
   Status = ConSplitterTextInAddDevice (&mConIn, TextIn);\r
   if (EFI_ERROR (Status)) {\r
     return Status;\r
@@ -1069,6 +1098,9 @@ ConSplitterConInDriverBindingStart (
     return Status;\r
   }\r
 \r
+  //\r
+  // Add this device into Text In Ex devices list.\r
+  //\r
   Status = ConSplitterTextInExAddDevice (&mConIn, TextInEx);\r
 \r
   return Status;\r
@@ -1098,6 +1130,10 @@ ConSplitterSimplePointerDriverBindingStart (
   EFI_STATUS                  Status;\r
   EFI_SIMPLE_POINTER_PROTOCOL *SimplePointer;\r
 \r
+  //\r
+  // Start ConSplitter on ControllerHandle, and create the virtual\r
+  // agrogated console device on first call Start for a SimplePointer handle.\r
+  //\r
   Status = ConSplitterStart (\r
             This,\r
             ControllerHandle,\r
@@ -1110,6 +1146,9 @@ ConSplitterSimplePointerDriverBindingStart (
     return Status;\r
   }\r
 \r
+  //\r
+  // Add this devcie into Simple Pointer devices list.\r
+  //\r
   return ConSplitterSimplePointerAddDevice (&mConIn, SimplePointer);\r
 }\r
 \r
@@ -1137,6 +1176,10 @@ ConSplitterAbsolutePointerDriverBindingStart (
   EFI_STATUS                        Status;\r
   EFI_ABSOLUTE_POINTER_PROTOCOL     *AbsolutePointer;\r
 \r
+  //\r
+  // Start ConSplitter on ControllerHandle, and create the virtual\r
+  // agrogated console device on first call Start for a AbsolutePointer handle.\r
+  //\r
   Status = ConSplitterStart (\r
              This,\r
              ControllerHandle,\r
@@ -1150,6 +1193,9 @@ ConSplitterAbsolutePointerDriverBindingStart (
     return Status;\r
   }\r
 \r
+  //\r
+  // Add this devcie into Absolute Pointer devices list.\r
+  //\r
   return ConSplitterAbsolutePointerAddDevice (&mConIn, AbsolutePointer);\r
 }\r
 \r
@@ -1179,6 +1225,10 @@ ConSplitterConOutDriverBindingStart (
   EFI_GRAPHICS_OUTPUT_PROTOCOL     *GraphicsOutput;\r
   EFI_UGA_DRAW_PROTOCOL            *UgaDraw;\r
 \r
+  //\r
+  // Start ConSplitter on ControllerHandle, and create the virtual\r
+  // agrogated console device on first call Start for a ConsoleOut handle.\r
+  //\r
   Status = ConSplitterStart (\r
             This,\r
             ControllerHandle,\r
@@ -1207,7 +1257,7 @@ ConSplitterConOutDriverBindingStart (
 \r
   if (EFI_ERROR (Status) && FeaturePcdGet (PcdUgaConsumeSupport)) {\r
     //\r
-    // Open UGA_DRAW protocol\r
+    // Open UGA DRAW protocol\r
     //\r
     Status = gBS->OpenProtocol (\r
                     ControllerHandle,\r
@@ -1273,6 +1323,10 @@ ConSplitterStdErrDriverBindingStart (
   EFI_STATUS                       Status;\r
   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *TextOut;\r
 \r
+  //\r
+  // Start ConSplitter on ControllerHandle, and create the virtual\r
+  // agrogated console device on first call Start for a StandardError handle.\r
+  //\r
   Status = ConSplitterStart (\r
             This,\r
             ControllerHandle,\r
@@ -1320,7 +1374,7 @@ ConSplitterStdErrDriverBindingStart (
 \r
 \r
 /**\r
-  Stop ConSplitter on device handle by opening Console Device Guid on device handle \r
+  Stop ConSplitter on device handle by closing Console Device Guid on device handle \r
   and the console virtual handle.\r
   \r
   @param  This                      Protocol instance pointer.\r
@@ -1367,6 +1421,7 @@ ConSplitterStop (
         This->DriverBindingHandle,\r
         ConSplitterVirtualHandle\r
         );\r
+\r
   gBS->CloseProtocol (\r
         ControllerHandle,\r
         DeviceGuid,\r
@@ -1420,12 +1475,18 @@ ConSplitterConInDriverBindingStop (
     return Status;\r
   }\r
 \r
+  //\r
+  // Remove device from Text Input Ex devices list.\r
+  //  \r
   Status = ConSplitterTextInExDeleteDevice (&mConIn, TextInEx);\r
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
 \r
 \r
+  //\r
+  // Close Simple Text In protocol on controller handle and virtual handle.\r
+  //\r
   Status = ConSplitterStop (\r
             This,\r
             ControllerHandle,\r
@@ -1437,9 +1498,10 @@ ConSplitterConInDriverBindingStop (
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
+\r
   //\r
-  // Delete this console input device's data structures.\r
-  //\r
+  // Remove device from Text Input devices list.\r
+  // \r
   return ConSplitterTextInDeleteDevice (&mConIn, TextIn);\r
 }\r
 \r
@@ -1474,6 +1536,9 @@ ConSplitterSimplePointerDriverBindingStop (
     return EFI_SUCCESS;\r
   }\r
 \r
+  //\r
+  // Close Simple Pointer protocol on controller handle and virtual handle.\r
+  //\r
   Status = ConSplitterStop (\r
             This,\r
             ControllerHandle,\r
@@ -1485,8 +1550,9 @@ ConSplitterSimplePointerDriverBindingStop (
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
+\r
   //\r
-  // Delete this console input device's data structures.\r
+  // Remove this device from Simple Pointer device list.\r
   //\r
   return ConSplitterSimplePointerDeleteDevice (&mConIn, SimplePointer);\r
 }\r
@@ -1522,6 +1588,9 @@ ConSplitterAbsolutePointerDriverBindingStop (
     return EFI_SUCCESS;\r
   }\r
 \r
+  //\r
+  // Close Absolute Pointer protocol on controller handle and virtual handle.\r
+  //\r
   Status = ConSplitterStop (\r
              This,\r
              ControllerHandle,\r
@@ -1533,8 +1602,9 @@ ConSplitterAbsolutePointerDriverBindingStop (
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
+\r
   //\r
-  // Delete this console input device's data structures.\r
+  // Remove this device from Absolute Pointer device list.\r
   //\r
   return ConSplitterAbsolutePointerDeleteDevice (&mConIn, AbsolutePointer);\r
 }\r
@@ -1569,6 +1639,9 @@ ConSplitterConOutDriverBindingStop (
     return EFI_SUCCESS;\r
   }\r
 \r
+  //\r
+  // Close Absolute Pointer protocol on controller handle and virtual handle.\r
+  //\r
   Status = ConSplitterStop (\r
             This,\r
             ControllerHandle,\r
@@ -1582,7 +1655,7 @@ ConSplitterConOutDriverBindingStop (
   }\r
 \r
   //\r
-  // Delete this console output device's data structures.\r
+  // Remove this device from Text Out device list.\r
   //\r
   return ConSplitterTextOutDeleteDevice (&mConOut, TextOut);\r
 }\r
@@ -1617,6 +1690,9 @@ ConSplitterStdErrDriverBindingStop (
     return EFI_SUCCESS;\r
   }\r
 \r
+  //\r
+  // Close Standard Error Device on controller handle and virtual handle.\r
+  //\r
   Status = ConSplitterStop (\r
             This,\r
             ControllerHandle,\r
@@ -3111,9 +3187,7 @@ ConSplitterTextOutDeleteDevice (
 \r
   return Status;\r
 }\r
-//\r
-// ConSplitter TextIn member functions\r
-//\r
+\r
 \r
 /**\r
   Reset the input device and optionaly run diagnostics\r
@@ -3280,7 +3354,7 @@ ConSpliterConsoleControlLockStdInEvent (
           BackSpaceString[0]  = CHAR_BACKSPACE;\r
           BackSpaceString[1]  = 0;\r
 \r
-          SpaceString[0]      = ' ';\r
+          SpaceString[0]      = L' ';\r
           SpaceString[1]      = 0;\r
 \r
           ConSplitterTextOutOutputString (&mConOut.TextOut, BackSpaceString);\r
@@ -3441,6 +3515,7 @@ ConSplitterTextInWaitForKey (
 \r
 \r
 /**\r
+  Test if the key has been registered on input device.\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
@@ -3482,10 +3557,6 @@ IsKeyRegistered (
 \r
 }\r
 \r
-//\r
-// Simple Text Input Ex protocol functions\r
-//\r
-\r
 \r
 /**\r
   Reset the input device and optionaly run diagnostics\r
@@ -4065,11 +4136,6 @@ ConSplitterSimplePointerWaitForInput (
   }\r
 }\r
 \r
-//\r
-// Absolute Pointer Protocol functions\r
-//\r
-\r
-\r
 /**\r
   Resets the pointer device hardware.\r
 \r
index f4060a2..b1bb791 100644 (file)
@@ -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
index f663ec1..a9e71fe 100644 (file)
@@ -30,7 +30,7 @@ STATIC CHAR16 mCrLfString[3] = { CHAR_CARRIAGE_RETURN, CHAR_LINEFEED, CHAR_NULL
 \r
   @param  This                    Protocol instance pointer.\r
   @param  Mode                    Are we in text of grahics mode.\r
-  @param  GopExists               TRUE if GOP Spliter has found a GOP/UGA device\r
+  @param  GopExists               TRUE if Console Spliter has found a GOP or UGA device\r
   @param  StdInLocked             TRUE if StdIn device is keyboard locked\r
 \r
   @retval EFI_SUCCESS             Mode information returned.\r
@@ -42,7 +42,7 @@ EFIAPI
 ConSpliterConsoleControlGetMode (\r
   IN  EFI_CONSOLE_CONTROL_PROTOCOL    *This,\r
   OUT EFI_CONSOLE_CONTROL_SCREEN_MODE *Mode,\r
-  OUT BOOLEAN                         *GopExists,\r
+  OUT BOOLEAN                         *GopUgaExists,\r
   OUT BOOLEAN                         *StdInLocked\r
   )\r
 {\r
@@ -57,11 +57,11 @@ ConSpliterConsoleControlGetMode (
 \r
   *Mode = Private->ConsoleOutputMode;\r
 \r
-  if (GopExists != NULL) {\r
-    *GopExists = FALSE;\r
+  if (GopUgaExists != NULL) {\r
+    *GopUgaExists = FALSE;\r
     for (Index = 0; Index < Private->CurrentNumberOfConsoles; Index++) {\r
       if ((Private->TextOutList[Index].GraphicsOutput != NULL) || (Private->TextOutList[Index].UgaDraw != NULL)) {\r
-        *GopExists = TRUE;\r
+        *GopUgaExists = TRUE;\r
         break;\r
       }\r
     }\r
@@ -207,7 +207,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
@@ -247,9 +247,6 @@ ConSpliterGraphicsOutputSetMode (
 \r
   Private = GRAPHICS_OUTPUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);\r
 \r
-  //\r
-  // GopDevNullSetMode ()\r
-  //\r
   ReturnStatus = EFI_SUCCESS;\r
 \r
   //\r
@@ -1349,7 +1346,7 @@ DevNullTextOutOutputString (
         Attribute = NullAttributes + SizeAttribute;\r
 \r
         for (Index = 0; Index < MaxColumn; Index++, Screen++, Attribute++) {\r
-          *Screen     = ' ';\r
+          *Screen     = L' ';\r
           *Attribute  = Mode->Attribute;\r
         }\r
       } else {\r
@@ -1545,7 +1542,7 @@ DevNullTextOutClearScreen (
 \r
   for (Row = 0; Row < Private->DevNullRows; Row++) {\r
     for (Column = 0; Column < Private->DevNullColumns; Column++, Screen++, Attributes++) {\r
-      *Screen     = ' ';\r
+      *Screen     = L' ';\r
       *Attributes = CurrentAttribute;\r
     }\r
     //\r