Refine comments.

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

diff --git a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
index e5a35ed958494c6c593e1d71dbd5866b9b7750ec..db302c986a7f002e555508d18f26a47c791734c0 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
@@ -415,12 +415,14 @@ BdsLibConnectDevicePath (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  This function will connect all current system handles recursively. The\r
-  connection will finish until every handle's child handle created if it have.\r
+  This function will connect all current system handles recursively. \r
+  \r
+  gBS->ConnectController() service is invoked for each handle exist in system handler buffer.\r
+  If the handle is bus type handler, all childrens also will be connected recursively\r
+  by gBS->ConnectController().\r

 \r
 \r

-  @retval EFI_SUCCESS           All handles and it's child handle have been\r
-                                connected\r
-  @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().\r
+  @retval EFI_SUCCESS           All handles and it's child handle have been connected\r
+  @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -429,13 +431,15 @@ BdsLibConnectAllEfi (
   VOID\r
   );\r
 \r
   VOID\r
   );\r
 \r

-\r

 /**\r
 /**\r

-  This function will disconnect all current system handles. The disconnection\r
-  will finish until every handle have been disconnected.\r
+  This function will disconnect all current system handles. \r
+  \r
+  gBS->DisconnectController() is invoked for each handle exists in system handle buffer.\r
+  If handle is a bus type handle, all childrens also are disconnected recursively by\r
+  gBS->DisconnectController().\r

 \r
   @retval EFI_SUCCESS           All handles have been disconnected\r
 \r
   @retval EFI_SUCCESS           All handles have been disconnected\r

-  @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().\r
+  @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r

diff --git a/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConnect.c b/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConnect.c
index 7d0254d33c810d9ebc5be85edf16d01a5f379c6d..2b01f5392bb7dc1ff4e178eb33045d07401d2f06 100644 (file)
--- a/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConnect.c
+++ b/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConnect.c
@@ -191,12 +191,14 @@ BdsLibConnectDevicePath (
 \r
 \r
 /**\r
 \r
 \r
 /**\r

-  This function will connect all current system handles recursively. The\r
-  connection will finish until every handle's child handle created if it have.\r
+  This function will connect all current system handles recursively. \r
+  \r
+  gBS->ConnectController() service is invoked for each handle exist in system handler buffer.\r
+  If the handle is bus type handler, all childrens also will be connected recursively\r
+  by gBS->ConnectController().\r

 \r
 \r

-  @retval EFI_SUCCESS           All handles and it's child handle have been\r
-                                connected\r
-  @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().\r
+  @retval EFI_SUCCESS           All handles and it's child handle have been connected\r
+  @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -232,13 +234,15 @@ BdsLibConnectAllEfi (
   return EFI_SUCCESS;\r
 }\r
 \r
   return EFI_SUCCESS;\r
 }\r
 \r

-\r

 /**\r
 /**\r

-  This function will disconnect all current system handles. The disconnection\r
-  will finish until every handle have been disconnected.\r
+  This function will disconnect all current system handles. \r
+  \r
+  gBS->DisconnectController() is invoked for each handle exists in system handle buffer.\r
+  If handle is a bus type handle, all childrens also are disconnected recursively by\r
+  gBS->DisconnectController().\r

 \r
   @retval EFI_SUCCESS           All handles have been disconnected\r
 \r
   @retval EFI_SUCCESS           All handles have been disconnected\r

-  @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().\r
+  @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r