Refine function comments for BdsDxe module.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / Bds.h

diff --git a/MdeModulePkg/Universal/BdsDxe/Bds.h b/MdeModulePkg/Universal/BdsDxe/Bds.h
index fbfa9658da4187e160952d8d1c0ec41186879b3c..56b709ecca94a10ec77fa1e7a40e08ffe0b5f258 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Bds.h
+++ b/MdeModulePkg/Universal/BdsDxe/Bds.h
@@ -1,6 +1,7 @@
-/*++\r
+/** @file\r
+  Head file for BDS Architectural Protocol implementation\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation\r
+Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -9,23 +10,11 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
-\r
-  Bds.h\r
-\r
-Abstract:\r
-\r
-  Head file for BDS Architectural Protocol implementation\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
 \r
 #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
@@ -35,7 +24,6 @@ Revision History
 #include <Guid/DataHubRecords.h>\r
 #include <Protocol/LoadFile.h>\r
 #include <Protocol/CpuIo.h>\r
-#include <Guid/HobList.h>\r
 #include <Guid/FileInfo.h>\r
 #include <Protocol/HiiConfigRouting.h>\r
 #include <Protocol/Bds.h>\r
@@ -64,12 +52,11 @@ Revision History
 #include <Library/BaseMemoryLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/UefiLib.h>\r
-#include <Library/GraphicsLib.h>\r
 #include <Library/MemoryAllocationLib.h>\r
-#include <Library/DxeServicesTableLib.h>\r
 #include <Library/PerformanceLib.h>\r
 #include <Library/ReportStatusCodeLib.h>\r
 #include <Library/IfrSupportLib.h>\r
+#include <Library/ExtendedIfrSupportLib.h>\r
 #include <Library/UefiRuntimeServicesTableLib.h>\r
 #include <Library/HobLib.h>\r
 #include <Library/BaseLib.h>\r
@@ -77,17 +64,33 @@ Revision History
 #include <Library/PcdLib.h>\r
 #include <Library/CapsuleLib.h>\r
 #include <Library/HiiLib.h>\r
+#include <Library/ExtendedHiiLib.h>\r
+\r
 \r
 #include <Library/GenericBdsLib.h>\r
 #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
+  @param TitleForeground Foreground color for Title.\r
+  @param TitleBackground Background color for Title.\r
+  @param Title           Title above progress bar.\r
+  @param ProgressColor   Progress bar color.\r
+  @param Progress        Progress (0-100)\r
+  @param PreviousValue   The previous value of the progress.\r
+\r
+  @retval  EFI_STATUS       Success update the progress bar\r
+\r
+**/\r
 EFI_STATUS\r
 PlatformBdsShowProgress (\r
   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,\r
@@ -101,6 +104,19 @@ PlatformBdsShowProgress (
 //\r
 // Prototypes\r
 //\r
+\r
+/**\r
+\r
+  Install Boot Device Selection Protocol\r
+\r
+  @param ImageHandle     The image handle.\r
+  @param SystemTable     The system table.\r
+\r
+  @retval  EFI_SUCEESS  BDS has finished initializing.\r
+                        Return the dispatcher and recall BDS.Entry\r
+  @retval  Other        Return status from AllocatePool() or gBS->InstallProtocolInterface\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 BdsInitialize (\r
@@ -108,6 +124,14 @@ BdsInitialize (
   IN EFI_SYSTEM_TABLE               *SystemTable\r
   );\r
 \r
+/**\r
+\r
+  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
+\r
+**/\r
 VOID\r
 EFIAPI\r
 BdsEntry (\r