Clean up Boot Manager module in BdsDxe.

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

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
index 0abd781003c4da9c07f2fd98235835054d773fc5..5dd1e31eb94d66df9f6a8fba7b2e00e5f3c4ba96 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
@@ -31,7 +31,9 @@ BOOT_MANAGER_CALLBACK_DATA  gBootManagerPrivate = {
 };\r
 \r
 /**\r
-  This function processes the results of changes in configuration.\r
+  This call back funtion is registered with Boot Manager formset.\r
+  When user selects a boot option, this call back function will\r
+  be triggered. The boot option is saved for later processing.\r
 \r
 \r
   @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
@@ -43,9 +45,7 @@ BOOT_MANAGER_CALLBACK_DATA  gBootManagerPrivate = {
   @param ActionRequest   On return, points to the action requested by the callback function.\r
 \r
   @retval  EFI_SUCCESS           The callback successfully handled the action.\r
-  @retval  EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the variable and its data.\r
-  @retval  EFI_DEVICE_ERROR      The variable could not be saved.\r
-  @retval  EFI_UNSUPPORTED       The specified Action is not supported by the callback.\r
+  @retval  EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -101,11 +101,10 @@ BootManagerCallback (
 \r
 /**\r
 \r
-  Initialize HII information for the FrontPage\r
+  Registers HII packages for the Boot Manger to HII Database.\r
+  It also registers the browser call back function.\r
 \r
 \r
-  @param VOID            EDES_TODO: Add parameter description\r
-\r
   @return EDES_TODO: Add description for return value\r
 \r
 **/\r
@@ -154,8 +153,11 @@ InitializeBootManager (
 }\r
 \r
 /**\r
-  Invoke Boot Manager. Hook to enable UI timeout override behavior.\r
-\r
+  This funtion invokees Boot Manager. If all devices have not a chance to be connected,\r
+  the connect all will be triggered. It then enumerate all boot options. If \r
+  a boot option from the Boot Manager page is selected, Boot Manager will boot\r
+  from this boot option.\r
+  \r
 **/\r
 VOID\r
 CallBootManager (\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.h b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.h
index 3b40fa6d4208067cca613120113ef5bf7692b56e..68ddf49da924e5b681eed0c80ba92fe14f66ea34 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.h
+++ b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.h
@@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _EFI_BOOT_MANAGER_H\r
-#define _EFI_BOOT_MANAGER_H\r
+#ifndef _EFI_BOOT_MANAGER_H_\r
+#define _EFI_BOOT_MANAGER_H_\r
 \r
 #include "Bds.h"\r
 #include "FrontPage.h"\r
@@ -53,16 +53,21 @@ typedef struct {
 } BOOT_MANAGER_CALLBACK_DATA;\r
 \r
 /**\r
-  EDES_TODO: Add function description.\r
+  This call back funtion is registered with Boot Manager formset.\r
+  When user selects a boot option, this call back function will\r
+  be triggered. The boot option is saved for later processing.\r
 \r
-  @param This            EDES_TODO: Add parameter description\r
-  @param Action          EDES_TODO: Add parameter description\r
-  @param QuestionId      EDES_TODO: Add parameter description\r
-  @param Type            EDES_TODO: Add parameter description\r
-  @param Value           EDES_TODO: Add parameter description\r
-  @param ActionRequest   EDES_TODO: Add parameter description\r
 \r
-  @return EDES_TODO: Add description for return value\r
+  @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+  @param Action          Specifies the type of action taken by the browser.\r
+  @param QuestionId      A unique value which is sent to the original exporting driver\r
+                         so that it can identify the type of data to expect.\r
+  @param Type            The type of value for the question.\r
+  @param Value           A pointer to the data being sent to the original exporting driver.\r
+  @param ActionRequest   On return, points to the action requested by the callback function.\r
+\r
+  @retval  EFI_SUCCESS           The callback successfully handled the action.\r
+  @retval  EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -78,9 +83,10 @@ BootManagerCallback (
 ;\r
 \r
 /**\r
-  EDES_TODO: Add function description.\r
 \r
-  @param VOID            EDES_TODO: Add parameter description\r
+  Registers HII packages for the Boot Manger to HII Database.\r
+  It also registers the browser call back function.\r
+\r
 \r
   @return EDES_TODO: Add description for return value\r
 \r
@@ -92,12 +98,11 @@ InitializeBootManager (
 ;\r
 \r
 /**\r
-  EDES_TODO: Add function description.\r
-\r
-  @param VOID            EDES_TODO: Add parameter description\r
-\r
-  @return EDES_TODO: Add description for return value\r
-\r
+  This funtion invokees Boot Manager. If all devices have not a chance to be connected,\r
+  the connect all will be triggered. It then enumerate all boot options. If \r
+  a boot option from the Boot Manager page is selected, Boot Manager will boot\r
+  from this boot option.\r
+  \r
 **/\r
 VOID\r
 CallBootManager (\r