Fix the issue that consplitter should not touch ConIn variable & do ConIn connection

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Library / GenericBdsLib.h

diff --git a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
index 422666abe0bf8f7e5fe10b8fe31f7d2f6f730eaa..b1887b60cae0ca34e5009cca49d84efe4c343b73 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
@@ -386,9 +386,10 @@ BdsLibConnectAll (
   );\r
 \r
 /**\r
-  This function creates all handles associated with the given device\r
-  path node. If the handle associated with one device path node cannot\r
-  be created, then it tries to execute the dispatch to load the missing drivers.  \r
+  This function will create all handles associate with every device\r
+  path node. If the handle associate with one device path node can not\r
+  be created successfully, then still give chance to do the dispatch,\r
+  which load the missing drivers if possible.\r
 \r
   @param  DevicePathToConnect   The device path to be connected. Can be\r
                                 a multi-instance device path.\r
@@ -507,17 +508,21 @@ BdsLibUpdateConsoleVariable (
   );\r
 \r
 /**\r
-  Connect the console device base on the variable ConVarName. If\r
-  ConVarName is a multi-instance device path, and at least one\r
-  instance connects successfully, then this function\r
+  Connect the console device base on the variable ConVarName, if\r
+  device path of the ConVarName is multi-instance device path and\r
+  anyone of the instances is connected success, then this function\r
   will return success.\r
+  If the handle associate with one device path node can not\r
+  be created successfully, then still give chance to do the dispatch,\r
+  which load the missing drivers if possible.\r
 \r
-  @param  ConVarName               The console related variable name: ConIn, ConOut,\r
+  @param  ConVarName               Console related variable name, ConIn, ConOut,\r
                                    ErrOut.\r
 \r
-  @retval EFI_NOT_FOUND            No console devices were connected successfully\r
-  @retval EFI_SUCCESS              Connected at least one instance of the console\r
-                                   device path based on the variable ConVarName.\r
+  @retval EFI_NOT_FOUND            There is not any console devices connected\r
+                                   success\r
+  @retval EFI_SUCCESS              Success connect any one instance of the console\r
+                                   device path base on the variable ConVarName.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -526,6 +531,30 @@ BdsLibConnectConsoleVariable (
   IN  CHAR16                 *ConVarName\r
   );\r
 \r
+/**\r
+  Connect the console device base on the variable ConVarName, if\r
+  device path of the ConVarName is multi-instance device path and\r
+  anyone of the instances is connected success, then this function\r
+  will return success. \r
+  Dispatch service is not called when the handle associate with one \r
+  device path node can not be created successfully. Here no driver \r
+  dependency is assumed exist, so need not to call this service.\r
+\r
+  @param  ConVarName               Console related variable name, ConIn, ConOut,\r
+                                   ErrOut.\r
+\r
+  @retval EFI_NOT_FOUND            There is not any console devices connected\r
+                                   success\r
+  @retval EFI_SUCCESS              Success connect any one instance of the console\r
+                                   device path base on the variable ConVarName.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+BdsLibConnectConsoleVariableWithOutDispatch (\r
+  IN  CHAR16                 *ConVarName\r
+  );\r
+\r
 //\r
 // Bds device path related lib functions\r
 //\r