add functions header for ConSplitterDxe module.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5453 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 44 insertions, 10 deletions

diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
index f43e63b..f4060a2 100644
--- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
+++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
@@ -1533,6 +1533,8 @@ ConSpliterConsoleControlLockStdInEvent (
   timer. If the Password is too big return an error. If the Password is valid

   Copy the Password and enable state variable and then arm the periodic timer

 

+  @param  This                     Console Control protocol pointer.

+  @param  Password                 The password input.

 

   @retval EFI_SUCCESS              Lock the StdIn device

   @retval EFI_INVALID_PARAMETER    Password is NULL

@@ -1551,7 +1553,7 @@ ConSpliterConsoleControlLockStdIn (
   Reads the next keystroke from the input device. The WaitForKey Event can

   be used to test for existance of a keystroke via WaitForEvent () call.

 

-  @param  This                     Protocol instance pointer.

+  @param  Private                  Protocol instance pointer.

   @param  Key                      Driver may perform diagnostics on reset.

 

   @retval EFI_SUCCESS              The keystroke information was returned.

@@ -1658,7 +1660,7 @@ ConSplitterTextOutReset (
   Write a Unicode string to the output device.

 

   @param  This                     Protocol instance pointer.

-  @param  String                   The NULL-terminated Unicode string to be

+  @param  WString                  The NULL-terminated Unicode string to be

                                    displayed on the output device(s). All output

                                    devices must also support the Unicode drawing

                                    defined in this file.

@@ -1686,7 +1688,7 @@ ConSplitterTextOutOutputString (
   target device.

 

   @param  This                     Protocol instance pointer.

-  @param  String                   The NULL-terminated Unicode string to be

+  @param  WString                  The NULL-terminated Unicode string to be

                                    examined for the output device(s).

 

   @retval EFI_SUCCESS              The device(s) are capable of rendering the

@@ -1710,7 +1712,9 @@ ConSplitterTextOutTestString (
 

   @param  This                     Protocol instance pointer.

   @param  ModeNumber               The mode number to return information on.

-  @param  Rows                     Returns the geometry of the text output device

+  @param  Columns                  Returns the columns of the text output device

+                                   for the requested ModeNumber.

+  @param  Rows                     Returns the rows of the text output device

                                    for the requested ModeNumber.

 

   @retval EFI_SUCCESS              The requested mode information was returned.

@@ -1797,9 +1801,12 @@ ConSplitterTextOutClearScreen (
   Sets the current coordinates of the cursor position

 

   @param  This                     Protocol instance pointer.

-  @param  Row                      the position to set the cursor to. Must be

+  @param  Column                   The column position to set the cursor to. Must be

                                    greater than or equal to zero and less than the

-                                   number of columns and rows by QueryMode ().

+                                   number of columns by QueryMode ().

+  @param  Row                      The row position to set the cursor to. Must be

+                                   greater than or equal to zero and less than the

+                                   number of rows by QueryMode ().

 

   @retval EFI_SUCCESS              The operation completed successfully.

   @retval EFI_DEVICE_ERROR         The device had an error and could not complete

@@ -1993,8 +2000,8 @@ ConSpliterGraphicsOutputSetMode (
   @param  DestinationX            X coordinate of destination for the BltBuffer.

   @param  DestinationY            Y coordinate of destination for the BltBuffer.

   @param  Width                   Width of rectangle in BltBuffer in pixels.

-  @param  Height                  Hight of rectangle in BltBuffer in pixels. Delta

-                                         -

+  @param  Height                  Hight of rectangle in BltBuffer in pixels. 

+  @param  Delta                   OPTIONAL.

 

   @retval EFI_SUCCESS             The Blt operation completed.

   @retval EFI_INVALID_PARAMETER   BltOperation is not valid.

@@ -2018,6 +2025,20 @@ ConSpliterGraphicsOutputBlt (
   )

 ;

 

+/**

+  Write data from the buffer to video display based on Graphics Output setting. 

+

+  @param  Private                 Consplitter Text Out pointer.

+  @param  GraphicsOutput          Graphics Output protocol pointer.

+  @param  UgaDraw                 UGA Draw protocol pointer.

+

+  @retval EFI_UNSUPPORTED         No graphics devcie available .

+  @retval EFI_SUCCESS             The Blt operation completed.

+  @retval EFI_INVALID_PARAMETER   BltOperation is not valid.

+  @retval EFI_DEVICE_ERROR        A hardware error occured writting to the video buffer.

+                 

+

+**/

 EFI_STATUS

 DevNullGopSync (

   IN  TEXT_OUT_SPLITTER_PRIVATE_DATA  *Private,

@@ -2113,8 +2134,8 @@ ConSpliterUgaDrawSetMode (
   @param  DestinationX            X coordinate of destination for the BltBuffer.

   @param  DestinationY            Y coordinate of destination for the BltBuffer.

   @param  Width                   Width of rectangle in BltBuffer in pixels.

-  @param  Height                  Hight of rectangle in BltBuffer in pixels. Delta

-                                         -

+  @param  Height                  Hight of rectangle in BltBuffer in pixels. 

+  @param  Delta                   OPTIONAL.

 

   @retval EFI_SUCCESS             The Blt operation completed.

   @retval EFI_INVALID_PARAMETER   BltOperation is not valid.

@@ -2138,6 +2159,19 @@ ConSpliterUgaDrawBlt (
   )

 ;

 

+/**

+  Write data from the buffer to video display based on UGA Draw setting. 

+

+  @param  Private                 Consplitter Text Out pointer.

+  @param  GraphicsOutput          Graphics Output protocol pointer.

+  @param  UgaDraw                 UGA Draw protocol pointer.

+

+  @retval EFI_UNSUPPORTED         No graphics devcie available .

+  @retval EFI_SUCCESS             The Blt operation completed.

+  @retval EFI_INVALID_PARAMETER   BltOperation is not valid.

+  @retval EFI_DEVICE_ERROR        A hardware error occured writting to the video buffer.

+                  

+**/

 EFI_STATUS

 DevNullUgaSync (

   IN  TEXT_OUT_SPLITTER_PRIVATE_DATA  *Private,