add functions header for ConSplitterDxe module.
authorvanjeff <vanjeff@de2fecce-e211-0410-80a6-f3fac2684e05>
Fri, 11 Jul 2008 07:23:59 +0000 (07:23 +0000)
committervanjeff <vanjeff@de2fecce-e211-0410-80a6-f3fac2684e05>
Fri, 11 Jul 2008 07:23:59 +0000 (07:23 +0000)
git-svn-id: https://edk2.tianocore.org/svn/edk2/trunk@5453 de2fecce-e211-0410-80a6-f3fac2684e05

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

index 9d45af2..4cf4dd0 100644 (file)
@@ -2019,6 +2019,15 @@ ConSplitterAbsolutePointerDeleteDevice (
   return EFI_NOT_FOUND;\r
 }\r
 \r
+/**\r
+  Reallocate Text Out mode map.\r
+\r
+  @param  Private                  Consplitter Text Out pointer.\r
+\r
+  @retval EFI_SUCCESS              Buffer size has grown\r
+  @retval EFI_OUT_OF_RESOURCES     Could not grow the buffer size.\r
+\r
+**/\r
 EFI_STATUS\r
 ConSplitterGrowMapTable (\r
   IN  TEXT_OUT_SPLITTER_PRIVATE_DATA  *Private\r
@@ -2240,10 +2249,10 @@ ConSplitterGetIntersection (
 /**\r
   Add the device's output mode to console splitter's mode list.\r
 \r
-  @param  Private               Text Out Splitter pointer\r
+  @param  Private               Text Out Splitter pointer.\r
   @param  TextOut               Simple Text Output protocol pointer.\r
   \r
-  @reture None\r
+  @return None\r
 \r
 **/\r
 VOID\r
@@ -2743,7 +2752,7 @@ Done:
   from ConsoleOutMode variable and set it; if the variable does not exist,\r
   set to user defined console mode.\r
 \r
-  None\r
+  @param  Private            Consplitter Text Out pointer.\r
 \r
   @return None\r
 \r
@@ -3154,7 +3163,7 @@ ConSplitterTextInReset (
   Reads the next keystroke from the input device. The WaitForKey Event can\r
   be used to test for existance of a keystroke via WaitForEvent () call.\r
 \r
-  @param  This                     Protocol instance pointer.\r
+  @param  Private                  Protocol instance pointer.\r
   @param  Key                      Driver may perform diagnostics on reset.\r
 \r
   @retval EFI_SUCCESS              The keystroke information was returned.\r
@@ -3304,6 +3313,8 @@ ConSpliterConsoleControlLockStdInEvent (
   timer. If the Password is too big return an error. If the Password is valid\r
   Copy the Password and enable state variable and then arm the periodic timer\r
 \r
+  @param  This                     Console Control protocol pointer.\r
+  @param  Password                 The password input.\r
 \r
   @retval EFI_SUCCESS              Lock the StdIn device\r
   @retval EFI_INVALID_PARAMETER    Password is NULL\r
@@ -3894,7 +3905,8 @@ ConSplitterSimplePointerReset (
   Reads the next keystroke from the input device. The WaitForKey Event can\r
   be used to test for existance of a keystroke via WaitForEvent () call.\r
 \r
-  @param  This                     Protocol instance pointer. State  -\r
+  @param  Private                  Protocol instance pointer.\r
+  @param  State                    The state information of simple pointer device.\r
 \r
   @retval EFI_SUCCESS              The keystroke information was returned.\r
   @retval EFI_NOT_READY            There was no keystroke data availiable.\r
@@ -4298,7 +4310,7 @@ ConSplitterTextOutReset (
   Write a Unicode string to the output device.\r
 \r
   @param  This                     Protocol instance pointer.\r
-  @param  String                   The NULL-terminated Unicode string to be\r
+  @param  WString                  The NULL-terminated Unicode string to be\r
                                    displayed on the output device(s). All output\r
                                    devices must also support the Unicode drawing\r
                                    defined in this file.\r
@@ -4379,7 +4391,7 @@ ConSplitterTextOutOutputString (
   target device.\r
 \r
   @param  This                     Protocol instance pointer.\r
-  @param  String                   The NULL-terminated Unicode string to be\r
+  @param  WString                  The NULL-terminated Unicode string to be\r
                                    examined for the output device(s).\r
 \r
   @retval EFI_SUCCESS              The device(s) are capable of rendering the\r
@@ -4432,7 +4444,9 @@ ConSplitterTextOutTestString (
 \r
   @param  This                     Protocol instance pointer.\r
   @param  ModeNumber               The mode number to return information on.\r
-  @param  Rows                     Returns the geometry of the text output device\r
+  @param  Columns                  Returns the columns of the text output device\r
+                                   for the requested ModeNumber.\r
+  @param  Rows                     Returns the rows of the text output device\r
                                    for the requested ModeNumber.\r
 \r
   @retval EFI_SUCCESS              The requested mode information was returned.\r
@@ -4681,9 +4695,12 @@ ConSplitterTextOutClearScreen (
   Sets the current coordinates of the cursor position\r
 \r
   @param  This                     Protocol instance pointer.\r
-  @param  Row                      the position to set the cursor to. Must be\r
+  @param  Column                   The column position to set the cursor to. Must be\r
+                                   greater than or equal to zero and less than the\r
+                                   number of columns by QueryMode ().\r
+  @param  Row                      The row position to set the cursor to. Must be\r
                                    greater than or equal to zero and less than the\r
-                                   number of columns and rows by QueryMode ().\r
+                                   number of rows by QueryMode ().\r
 \r
   @retval EFI_SUCCESS              The operation completed successfully.\r
   @retval EFI_DEVICE_ERROR         The device had an error and could not complete\r
index f43e63b..f4060a2 100644 (file)
@@ -1533,6 +1533,8 @@ ConSpliterConsoleControlLockStdInEvent (
   timer. If the Password is too big return an error. If the Password is valid\r
   Copy the Password and enable state variable and then arm the periodic timer\r
 \r
+  @param  This                     Console Control protocol pointer.\r
+  @param  Password                 The password input.\r
 \r
   @retval EFI_SUCCESS              Lock the StdIn device\r
   @retval EFI_INVALID_PARAMETER    Password is NULL\r
@@ -1551,7 +1553,7 @@ ConSpliterConsoleControlLockStdIn (
   Reads the next keystroke from the input device. The WaitForKey Event can\r
   be used to test for existance of a keystroke via WaitForEvent () call.\r
 \r
-  @param  This                     Protocol instance pointer.\r
+  @param  Private                  Protocol instance pointer.\r
   @param  Key                      Driver may perform diagnostics on reset.\r
 \r
   @retval EFI_SUCCESS              The keystroke information was returned.\r
@@ -1658,7 +1660,7 @@ ConSplitterTextOutReset (
   Write a Unicode string to the output device.\r
 \r
   @param  This                     Protocol instance pointer.\r
-  @param  String                   The NULL-terminated Unicode string to be\r
+  @param  WString                  The NULL-terminated Unicode string to be\r
                                    displayed on the output device(s). All output\r
                                    devices must also support the Unicode drawing\r
                                    defined in this file.\r
@@ -1686,7 +1688,7 @@ ConSplitterTextOutOutputString (
   target device.\r
 \r
   @param  This                     Protocol instance pointer.\r
-  @param  String                   The NULL-terminated Unicode string to be\r
+  @param  WString                  The NULL-terminated Unicode string to be\r
                                    examined for the output device(s).\r
 \r
   @retval EFI_SUCCESS              The device(s) are capable of rendering the\r
@@ -1710,7 +1712,9 @@ ConSplitterTextOutTestString (
 \r
   @param  This                     Protocol instance pointer.\r
   @param  ModeNumber               The mode number to return information on.\r
-  @param  Rows                     Returns the geometry of the text output device\r
+  @param  Columns                  Returns the columns of the text output device\r
+                                   for the requested ModeNumber.\r
+  @param  Rows                     Returns the rows of the text output device\r
                                    for the requested ModeNumber.\r
 \r
   @retval EFI_SUCCESS              The requested mode information was returned.\r
@@ -1797,9 +1801,12 @@ ConSplitterTextOutClearScreen (
   Sets the current coordinates of the cursor position\r
 \r
   @param  This                     Protocol instance pointer.\r
-  @param  Row                      the position to set the cursor to. Must be\r
+  @param  Column                   The column position to set the cursor to. Must be\r
                                    greater than or equal to zero and less than the\r
-                                   number of columns and rows by QueryMode ().\r
+                                   number of columns by QueryMode ().\r
+  @param  Row                      The row position to set the cursor to. Must be\r
+                                   greater than or equal to zero and less than the\r
+                                   number of rows by QueryMode ().\r
 \r
   @retval EFI_SUCCESS              The operation completed successfully.\r
   @retval EFI_DEVICE_ERROR         The device had an error and could not complete\r
@@ -1993,8 +2000,8 @@ ConSpliterGraphicsOutputSetMode (
   @param  DestinationX            X coordinate of destination for the BltBuffer.\r
   @param  DestinationY            Y coordinate of destination for the BltBuffer.\r
   @param  Width                   Width of rectangle in BltBuffer in pixels.\r
-  @param  Height                  Hight of rectangle in BltBuffer in pixels. Delta\r
-                                         -\r
+  @param  Height                  Hight of rectangle in BltBuffer in pixels. \r
+  @param  Delta                   OPTIONAL.\r
 \r
   @retval EFI_SUCCESS             The Blt operation completed.\r
   @retval EFI_INVALID_PARAMETER   BltOperation is not valid.\r
@@ -2018,6 +2025,20 @@ ConSpliterGraphicsOutputBlt (
   )\r
 ;\r
 \r
+/**\r
+  Write data from the buffer to video display based on Graphics Output setting. \r
+\r
+  @param  Private                 Consplitter Text Out pointer.\r
+  @param  GraphicsOutput          Graphics Output protocol pointer.\r
+  @param  UgaDraw                 UGA Draw protocol pointer.\r
+\r
+  @retval EFI_UNSUPPORTED         No graphics devcie available .\r
+  @retval EFI_SUCCESS             The Blt operation completed.\r
+  @retval EFI_INVALID_PARAMETER   BltOperation is not valid.\r
+  @retval EFI_DEVICE_ERROR        A hardware error occured writting to the video buffer.\r
+                 \r
+\r
+**/\r
 EFI_STATUS\r
 DevNullGopSync (\r
   IN  TEXT_OUT_SPLITTER_PRIVATE_DATA  *Private,\r
@@ -2113,8 +2134,8 @@ ConSpliterUgaDrawSetMode (
   @param  DestinationX            X coordinate of destination for the BltBuffer.\r
   @param  DestinationY            Y coordinate of destination for the BltBuffer.\r
   @param  Width                   Width of rectangle in BltBuffer in pixels.\r
-  @param  Height                  Hight of rectangle in BltBuffer in pixels. Delta\r
-                                         -\r
+  @param  Height                  Hight of rectangle in BltBuffer in pixels. \r
+  @param  Delta                   OPTIONAL.\r
 \r
   @retval EFI_SUCCESS             The Blt operation completed.\r
   @retval EFI_INVALID_PARAMETER   BltOperation is not valid.\r
@@ -2138,6 +2159,19 @@ ConSpliterUgaDrawBlt (
   )\r
 ;\r
 \r
+/**\r
+  Write data from the buffer to video display based on UGA Draw setting. \r
+\r
+  @param  Private                 Consplitter Text Out pointer.\r
+  @param  GraphicsOutput          Graphics Output protocol pointer.\r
+  @param  UgaDraw                 UGA Draw protocol pointer.\r
+\r
+  @retval EFI_UNSUPPORTED         No graphics devcie available .\r
+  @retval EFI_SUCCESS             The Blt operation completed.\r
+  @retval EFI_INVALID_PARAMETER   BltOperation is not valid.\r
+  @retval EFI_DEVICE_ERROR        A hardware error occured writting to the video buffer.\r
+                  \r
+**/\r
 EFI_STATUS\r
 DevNullUgaSync (\r
   IN  TEXT_OUT_SPLITTER_PRIVATE_DATA  *Private,\r
index aa08373..f663ec1 100644 (file)
@@ -330,6 +330,52 @@ ConSpliterGraphicsOutputSetMode (
   return ReturnStatus;\r
 }\r
 \r
+/**\r
+  The following table defines actions for BltOperations.\r
+\r
+  EfiBltVideoFill - Write data from the  BltBuffer pixel (SourceX, SourceY)\r
+  directly to every pixel of the video display rectangle\r
+  (DestinationX, DestinationY)\r
+  (DestinationX + Width, DestinationY + Height).\r
+  Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
+  EfiBltVideoToBltBuffer - Read data from the video display rectangle\r
+  (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in\r
+  the BltBuffer rectangle (DestinationX, DestinationY )\r
+  (DestinationX + Width, DestinationY + Height). If DestinationX or\r
+  DestinationY is not zero then Delta must be set to the length in bytes\r
+  of a row in the BltBuffer.\r
+  EfiBltBufferToVideo - Write data from the  BltBuffer rectangle\r
+  (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the\r
+  video display rectangle (DestinationX, DestinationY)\r
+  (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is\r
+  not zero then Delta must be set to the length in bytes of a row in the\r
+  BltBuffer.\r
+  EfiBltVideoToVideo - Copy from the video display rectangle\r
+  (SourceX, SourceY) (SourceX + Width, SourceY + Height) .\r
+  to the video display rectangle (DestinationX, DestinationY)\r
+  (DestinationX + Width, DestinationY + Height).\r
+  The BltBuffer and Delta  are not used in this mode.\r
+\r
+  @param  Private                 Protocol instance pointer.\r
+  @param  BltBuffer               Buffer containing data to blit into video buffer.\r
+                                  This buffer has a size of\r
+                                  Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
+  @param  BltOperation            Operation to perform on BlitBuffer and video\r
+                                  memory\r
+  @param  SourceX                 X coordinate of source for the BltBuffer.\r
+  @param  SourceY                 Y coordinate of source for the BltBuffer.\r
+  @param  DestinationX            X coordinate of destination for the BltBuffer.\r
+  @param  DestinationY            Y coordinate of destination for the BltBuffer.\r
+  @param  Width                   Width of rectangle in BltBuffer in pixels.\r
+  @param  Height                  Hight of rectangle in BltBuffer in pixels. \r
+  @param  Delta                   OPTIONAL.\r
+\r
+  @retval EFI_SUCCESS             The Blt operation completed.\r
+  @retval EFI_INVALID_PARAMETER   BltOperation is not valid.\r
+  @retval EFI_DEVICE_ERROR        A hardware error occured writting to the video\r
+                                  buffer.\r
+\r
+**/\r
 EFI_STATUS\r
 DevNullGraphicsOutputBlt (\r
   IN  TEXT_OUT_SPLITTER_PRIVATE_DATA                *Private,\r
@@ -486,7 +532,7 @@ DevNullGraphicsOutputBlt (
   @param  DestinationY            Y coordinate of destination for the BltBuffer.\r
   @param  Width                   Width of rectangle in BltBuffer in pixels.\r
   @param  Height                  Hight of rectangle in BltBuffer in pixels. \r
-  @param  Delta                   (not used here).\r
+  @param  Delta                   OPTIONAL.\r
 \r
   @retval EFI_SUCCESS             The Blt operation completed.\r
   @retval EFI_INVALID_PARAMETER   BltOperation is not valid.\r
@@ -593,6 +639,20 @@ ConSpliterGraphicsOutputBlt (
   return ReturnStatus;\r
 }\r
 \r
+/**\r
+  Write data from the buffer to video display based on Graphics Output setting. \r
+\r
+  @param  Private                 Consplitter Text Out pointer.\r
+  @param  GraphicsOutput          Graphics Output protocol pointer.\r
+  @param  UgaDraw                 UGA Draw protocol pointer.\r
+\r
+  @retval EFI_UNSUPPORTED         No graphics devcie available .\r
+  @retval EFI_SUCCESS             The Blt operation completed.\r
+  @retval EFI_INVALID_PARAMETER   BltOperation is not valid.\r
+  @retval EFI_DEVICE_ERROR        A hardware error occured writting to the video buffer.\r
+                 \r
+\r
+**/\r
 EFI_STATUS\r
 DevNullGopSync (\r
   IN  TEXT_OUT_SPLITTER_PRIVATE_DATA  *Private,\r
@@ -799,6 +859,52 @@ ConSpliterUgaDrawSetMode (
   return ReturnStatus;\r
 }\r
 \r
+/**\r
+  The following table defines actions for BltOperations.\r
+\r
+  EfiBltVideoFill - Write data from the  BltBuffer pixel (SourceX, SourceY)\r
+  directly to every pixel of the video display rectangle\r
+  (DestinationX, DestinationY)\r
+  (DestinationX + Width, DestinationY + Height).\r
+  Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
+  EfiBltVideoToBltBuffer - Read data from the video display rectangle\r
+  (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in\r
+  the BltBuffer rectangle (DestinationX, DestinationY )\r
+  (DestinationX + Width, DestinationY + Height). If DestinationX or\r
+  DestinationY is not zero then Delta must be set to the length in bytes\r
+  of a row in the BltBuffer.\r
+  EfiBltBufferToVideo - Write data from the  BltBuffer rectangle\r
+  (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the\r
+  video display rectangle (DestinationX, DestinationY)\r
+  (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is\r
+  not zero then Delta must be set to the length in bytes of a row in the\r
+  BltBuffer.\r
+  EfiBltVideoToVideo - Copy from the video display rectangle\r
+  (SourceX, SourceY) (SourceX + Width, SourceY + Height) .\r
+  to the video display rectangle (DestinationX, DestinationY)\r
+  (DestinationX + Width, DestinationY + Height).\r
+  The BltBuffer and Delta  are not used in this mode.\r
+\r
+  @param  Private                 Protocol instance pointer.\r
+  @param  BltBuffer               Buffer containing data to blit into video buffer.\r
+                                  This buffer has a size of\r
+                                  Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
+  @param  BltOperation            Operation to perform on BlitBuffer and video\r
+                                  memory\r
+  @param  SourceX                 X coordinate of source for the BltBuffer.\r
+  @param  SourceY                 Y coordinate of source for the BltBuffer.\r
+  @param  DestinationX            X coordinate of destination for the BltBuffer.\r
+  @param  DestinationY            Y coordinate of destination for the BltBuffer.\r
+  @param  Width                   Width of rectangle in BltBuffer in pixels.\r
+  @param  Height                  Hight of rectangle in BltBuffer in pixels. \r
+  @param  Delta                   OPTIONAL.\r
+\r
+  @retval EFI_SUCCESS             The Blt operation completed.\r
+  @retval EFI_INVALID_PARAMETER   BltOperation is not valid.\r
+  @retval EFI_DEVICE_ERROR        A hardware error occured writting to the video\r
+                                  buffer.\r
+\r
+**/\r
 EFI_STATUS\r
 DevNullUgaBlt (\r
   IN  TEXT_OUT_SPLITTER_PRIVATE_DATA                *Private,\r
@@ -955,7 +1061,7 @@ DevNullUgaBlt (
   @param  DestinationY            Y coordinate of destination for the BltBuffer.\r
   @param  Width                   Width of rectangle in BltBuffer in pixels.\r
   @param  Height                  Hight of rectangle in BltBuffer in pixels.\r
-  @param  Delta                   (not used here)\r
+  @param  Delta                   OPTIONAL.\r
 \r
   @retval EFI_SUCCESS             The Blt operation completed.\r
   @retval EFI_INVALID_PARAMETER   BltOperation is not valid.\r
@@ -1059,6 +1165,19 @@ ConSpliterUgaDrawBlt (
   return ReturnStatus;\r
 }\r
 \r
+/**\r
+  Write data from the buffer to video display based on UGA Draw setting. \r
+\r
+  @param  Private                 Consplitter Text Out pointer.\r
+  @param  GraphicsOutput          Graphics Output protocol pointer.\r
+  @param  UgaDraw                 UGA Draw protocol pointer.\r
+\r
+  @retval EFI_UNSUPPORTED         No graphics devcie available .\r
+  @retval EFI_SUCCESS             The Blt operation completed.\r
+  @retval EFI_INVALID_PARAMETER   BltOperation is not valid.\r
+  @retval EFI_DEVICE_ERROR        A hardware error occured writting to the video buffer.\r
+                  \r
+**/\r
 EFI_STATUS\r
 DevNullUgaSync (\r
   IN  TEXT_OUT_SPLITTER_PRIVATE_DATA  *Private,\r