Refine comments for BDS module.

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

diff --git a/MdeModulePkg/Universal/BdsDxe/Bds.h b/MdeModulePkg/Universal/BdsDxe/Bds.h
index b02dfc0c8ec4c4f0db428c2dc25142c999313bd6..56b709ecca94a10ec77fa1e7a40e08ffe0b5f258 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Bds.h
+++ b/MdeModulePkg/Universal/BdsDxe/Bds.h
@@ -15,8 +15,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef _BDS_MODULE_H_\r
 #define _BDS_MODULE_H_\r
 \r
-#undef EFI_SPECIFICATION_VERSION\r
-#define EFI_SPECIFICATION_VERSION 0x0002000A\r
 #include <PiDxe.h>\r
 #include <MdeModuleHii.h>\r
 \r
@@ -73,17 +71,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/PlatformBdsLib.h>\r
 \r
 #define EFI_BDS_ARCH_PROTOCOL_INSTANCE_FROM_THIS(_this) \\r
-  CR (_this, \\r
-      EFI_BDS_ARCH_PROTOCOL_INSTANCE, \\r
-      Bds, \\r
-      EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE \\r
+  CR ((_this),                                          \\r
+      EFI_BDS_ARCH_PROTOCOL_INSTANCE,                   \\r
+      Bds,                                              \\r
+      EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE          \\r
       )\r
 \r
 /**\r
 \r
   Show progress bar with title above it. It only works in Graphics mode.\r
 \r
-\r
   @param TitleForeground Foreground color for Title.\r
   @param TitleBackground Background color for Title.\r
   @param Title           Title above progress bar.\r
@@ -112,15 +109,12 @@ PlatformBdsShowProgress (
 \r
   Install Boot Device Selection Protocol\r
 \r
-\r
   @param ImageHandle     The image handle.\r
   @param SystemTable     The system table.\r
 \r
   @retval  EFI_SUCEESS  BDS has finished initializing.\r
-                        Rerun the\r
-                        dispatcher and recall BDS.Entry\r
-  @retval  Other        Return value from AllocatePool()\r
-                        or gBS->InstallProtocolInterface\r
+                        Return the dispatcher and recall BDS.Entry\r
+  @retval  Other        Return status from AllocatePool() or gBS->InstallProtocolInterface\r
 \r
 **/\r
 EFI_STATUS\r
@@ -135,7 +129,7 @@ BdsInitialize (
   Service routine for BdsInstance->Entry(). Devices are connected, the\r
   consoles are initialized, and the boot options are tried.\r
 \r
-  @param This            - Protocol Instance structure.\r
+  @param This            Protocol Instance structure.\r
 \r
 **/\r
 VOID\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BdsEntry.c b/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
index ba72ba2ee3f7df576d13e3ee296ed714aec40760..c70559e098fce893485c9dd1703638f694084af7 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
+++ b/MdeModulePkg/Universal/BdsDxe/BdsEntry.c
@@ -1,5 +1,9 @@
 /** @file\r
-  The entry of the bds\r
+  This module produce main entry for BDS phase - BdsEntry. \r
+  When this module was dispatched by DxeCore, gEfiBdsArchProtocolGuid will be installed\r
+  which contains interface of BdsEntry.\r
+  After DxeCore finish DXE phase, gEfiBdsArchProtocolGuid->BdsEntry will be invoked\r
+  to enter BDS phase.\r
 \r
 Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
@@ -44,15 +48,12 @@ EFI_HANDLE                      mBdsImageHandle;
 \r
   Install Boot Device Selection Protocol\r
 \r
-\r
   @param ImageHandle     The image handle.\r
   @param SystemTable     The system table.\r
 \r
   @retval  EFI_SUCEESS  BDS has finished initializing.\r
-                        Rerun the\r
-                        dispatcher and recall BDS.Entry\r
-  @retval  Other        Return value from AllocatePool()\r
-                        or gBS->InstallProtocolInterface\r
+                        Return the dispatcher and recall BDS.Entry\r
+  @retval  Other        Return status from AllocatePool() or gBS->InstallProtocolInterface\r
 \r
 **/\r
 EFI_STATUS\r
@@ -262,7 +263,7 @@ BdsBootDeviceSelect (
   Service routine for BdsInstance->Entry(). Devices are connected, the\r
   consoles are initialized, and the boot options are tried.\r
 \r
-  @param This            - Protocol Instance structure.\r
+  @param This             Protocol Instance structure.\r
 \r
 **/\r
 VOID\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
index 96000749c9efcff581f5eba66c8c6869d53bbd94..94261a0bef5824ed75e7e32a48fdb9a691bfb033 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
@@ -172,14 +172,14 @@ BdsBuildLegacyDevNameString (
   order list.\r
 \r
 \r
-  @param CurrentBbsEntry Pointer to current BBS table.\r
-  @param CurrentBbsDevPath Pointer to the Device Path Protocol instance of BBS\r
-  @param Index           Index of the specified entry in BBS table.\r
-  @param BootOrderList   On input, the original boot order list.\r
-                         On output, the new boot order list attached with the\r
-                         created node.\r
-  @param BootOrderListSize On input, the original size of boot order list.\r
-                         - On output, the size of new boot order list.\r
+  @param CurrentBbsEntry    Pointer to current BBS table.\r
+  @param CurrentBbsDevPath  Pointer to the Device Path Protocol instance of BBS\r
+  @param Index              Index of the specified entry in BBS table.\r
+  @param BootOrderList      On input, the original boot order list.\r
+                            On output, the new boot order list attached with the\r
+                            created node.\r
+  @param BootOrderListSize  On input, the original size of boot order list.\r
+                            On output, the size of new boot order list.\r
 \r
   @retval  EFI_SUCCESS             Boot Option successfully created.\r
   @retval  EFI_OUT_OF_RESOURCES    Fail to allocate necessary memory.\r
@@ -1654,10 +1654,10 @@ BdsRefreshBbsTableForBoot (
   if (BootOrder != NULL) {\r
     FreePool (BootOrder);\r
   }\r
-  //\r
-  // For debug\r
-  //\r
-  PrintBbsTable (LocalBbsTable);\r
 \r
+  DEBUG_CODE_BEGIN();\r
+    PrintBbsTable (LocalBbsTable);\r
+  DEBUG_CODE_END();\r
+  \r
   return Status;\r
 }\r

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
index 48f750d444fb383c751dfb1684de69eeb7bb7672..33be4199a7e12db055dcc17b384e212cd28bc331 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
+++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
@@ -1041,8 +1041,6 @@ InitializeBM (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  \r
-\r
 **/\r
 VOID\r
 InitAllMenu (\r
@@ -1068,10 +1066,6 @@ InitAllMenu (
 /**\r
   Free up all Menu Option list.\r
 \r
-  \r
-\r
-  \r
-\r
 **/\r
 VOID\r
 FreeAllMenu (\r
@@ -1090,11 +1084,6 @@ FreeAllMenu (
 /**\r
   Intialize all the string depositories.\r
 \r
-\r
-  \r
-\r
-  \r
-\r
 **/\r
 VOID\r
 InitializeStringDepository (\r
@@ -1115,7 +1104,6 @@ InitializeStringDepository (
 /**\r
   Fetch a usable string node from the string depository and return the string token.\r
 \r
-\r
   @param CallbackData    The BMM context data.\r
   @param StringDepository  The string repository.\r
 \r
@@ -1164,11 +1152,6 @@ GetStringTokenFromDepository (
 /**\r
   Reclaim string depositories by moving the current node pointer to list head..\r
 \r
-\r
-   \r
-\r
-  \r
-\r
 **/\r
 VOID\r
 ReclaimStringDepository (\r
@@ -1188,11 +1171,6 @@ ReclaimStringDepository (
 /**\r
   Release resource for all the string depositories.\r
 \r
-\r
-  \r
-\r
-  \r
-\r
 **/\r
 VOID\r
 CleanUpStringDepository (\r