Update consplitter driver to use dynamic PCD to set console output mode instead of...

[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 5ff5e6adac2956ad44656aca28f54f6e257904a1..b4b8f1d322a7e15b4ea69d304eecae35537aeeff 100644 (file)
--- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
+++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
@@ -28,11 +28,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Protocol/SimpleTextInEx.h>\r
 #include <Protocol/GraphicsOutput.h>\r
 #include <Protocol/UgaDraw.h>\r
+#include <Protocol/SimpleTextInExNotify.h>\r
 \r
 #include <Guid/PrimaryStandardErrorDevice.h>\r
 #include <Guid/PrimaryConsoleOutDevice.h>\r
 #include <Guid/PrimaryConsoleInDevice.h>\r
-#include <Guid/GenericPlatformVariable.h>\r
 #include <Guid/ConsoleInDevice.h>\r
 #include <Guid/StandardErrorDevice.h>\r
 #include <Guid/ConsoleOutDevice.h>\r
@@ -67,7 +67,6 @@ extern EFI_DRIVER_BINDING_PROTOCOL  gConSplitterStdErrDriverBinding;
 extern EFI_COMPONENT_NAME_PROTOCOL  gConSplitterStdErrComponentName;\r
 extern EFI_COMPONENT_NAME2_PROTOCOL gConSplitterStdErrComponentName2;\r
 \r
-extern EFI_GUID                     gSimpleTextInExNotifyGuid;\r
 \r
 //\r
 // These definitions were in the old Hii protocol, but are not in the new UEFI\r
@@ -84,7 +83,6 @@ extern EFI_GUID                     gSimpleTextInExNotifyGuid;
 #define CONSOLE_SPLITTER_MODES_ALLOC_UNIT     32\r
 #define MAX_STD_IN_PASSWORD                   80\r
 \r
-#define VARCONOUTMODE L"ConOutMode"\r
 \r
 typedef struct {\r
   UINTN   Column;\r
@@ -1425,7 +1423,7 @@ ConSplitterTextInSetState (
                                    successfully.\r
   @retval EFI_OUT_OF_RESOURCES     Unable to allocate resources for necesssary data\r
                                    structures.\r
-  @retval EFI_INVALID_PARAMETER    KeyData or NotifyHandle is NULL.\r
+  @retval EFI_INVALID_PARAMETER    KeyData or KeyNotificationFunction or NotifyHandle is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1459,7 +1457,8 @@ ConSplitterTextInUnregisterKeyNotify (
   );\r
 \r
 /**\r
-  This event agregates all the events of the ConIn devices in the spliter.\r
+  This event aggregates all the events of the ConIn devices in the spliter.\r
+\r
   If the ConIn is password locked then return.\r
   If any events of physical ConIn devices are signaled, signal the ConIn\r
   spliter event. This will cause the calling code to call\r
@@ -1490,10 +1489,12 @@ ConSpliterConssoleControlStdInLocked (
   );\r
 \r
 /**\r
-  This timer event will fire when StdIn is locked. It will check the key\r
-  sequence on StdIn to see if it matches the password. Any error in the\r
-  password will cause the check to reset. As long a mConIn.PasswordEnabled is\r
-  TRUE the StdIn splitter will not report any input.\r
+  Record and check key sequence on StdIn.\r
+\r
+  This timer event will fire when StdIn is locked. It will record the key sequence\r
+  on StdIn and also check to see if it matches the password. Any error in the\r
+  password will cause the check to reset. As long as a mConIn.PasswordEnabled is\r
+  TRUE, the StdIn splitter will not report any input.\r
 \r
   @param  Event                  The Event this notify function registered to.\r
   @param  Context                Pointer to the context data registerd to the\r
@@ -2197,20 +2198,17 @@ DevNullTextOutClearScreen (
   );\r
 \r
 /**\r
-  Sets the current coordinates of the cursor position.\r
+  Sets the current coordinates of the cursor position on NULL device.\r
 \r
-  @param  Private                 Text Out Splitter pointer.\r
-  @param  Column\r
-  @param  Row                     the 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
+  @param  Private                  Text Out Splitter pointer.\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 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
-                                  the request.\r
-  @retval EFI_UNSUPPORTED         The output device is not in a valid text mode, or\r
-                                  the cursor position is invalid for the current\r
-                                  mode.\r
+  @retval EFI_SUCCESS              Always returned.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -2221,13 +2219,13 @@ DevNullTextOutSetCursorPosition (
   );\r
 \r
 /**\r
-  Set cursor visibility property.\r
+  Set cursor visibility property on NULL device.\r
 \r
   @param  Private                 Text Out Splitter pointer.\r
   @param  Visible                 If TRUE, the cursor is set to be visible, If\r
                                   FALSE, the cursor is set to be invisible.\r
 \r
-  @retval EFI_SUCCESS             Returns always.\r
+  @retval EFI_SUCCESS             Always returned.\r
 \r
 **/\r
 EFI_STATUS\r