Refine function comments for BdsDxe module.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / BdsDxe.inf

diff --git a/MdeModulePkg/Universal/BdsDxe/BdsDxe.inf b/MdeModulePkg/Universal/BdsDxe/BdsDxe.inf
index 3de94909128e91ad3b7e1f34d58832d0b14b5d75..c8136db4fc204b31e528a9d462e592a92115a925 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/BdsDxe.inf
+++ b/MdeModulePkg/Universal/BdsDxe/BdsDxe.inf
@@ -1,6 +1,18 @@
 #/** @file\r
-#  \r
-#    Component discription file for Bds module\r
+#\r
+#  BDSDxe module is core driver for BDS phase. \r
+#  When DxeCore dispatching all DXE driver, this module will produce architecture protocol \r
+#  gEfiBdsArchProtocolGuid. After DxeCore finish dispatching, DxeCore will invoke Entry\r
+#  interface of protocol gEfiBdsArchProtocolGuid, then BDS phase is entered.\r
+#\r
+#  Generally, this module take reposiblity to connect all necessary devices for platform boot, \r
+#  these boot device path  are hold in PlatformBdsLib library instance produced by platform.\r
+#  For legacy boot, BDS will transfer control to legacy BIOS after legacy boot device is select.\r
+#  For EFI boot, BDS will load boot loader file EFI\BOOT\BOOTIA32.EFI, EFI\BOOT\BOOTX64.EFI, \r
+#  EFI\BOOT\BOOTIA64.EFI file from selected boot device and transfer control to boot loader.\r
+#\r
+#  BDSDxe also maintain the UI for "Boot Manager, Boot Maintaince Manager, Device Manager" which\r
+#  is used for user to configure boot option or maintain hardware device.\r
 #  \r
 #  Copyright (c) 2008, Intel Corporation. <BR>\r
 #  All rights reserved. This program and the accompanying materials\r
@@ -18,10 +30,8 @@
   BASE_NAME                      = BdsDxe\r
   FILE_GUID                      = FC5C7020-1A48-4198-9BE2-EAD5ABC8CF2F\r
   MODULE_TYPE                    = DXE_DRIVER\r
-  VERSION_STRING                 = 1.0\r
-  EDK_RELEASE_VERSION            = 0x00020000\r
+  VERSION_STRING                 = 1.0 \r
   EFI_SPECIFICATION_VERSION      = 0x00020000\r
-\r
   ENTRY_POINT                    = BdsInitialize\r
 \r
 #\r
@@ -94,9 +104,7 @@
   GenericBdsLib\r
   ReportStatusCodeLib\r
   PerformanceLib\r
-  DxeServicesTableLib\r
   MemoryAllocationLib\r
-  GraphicsLib\r
   UefiLib\r
   UefiBootServicesTableLib\r
   BaseMemoryLib\r
@@ -110,7 +118,6 @@
 \r
 [Guids]\r
   gEfiGlobalVariableGuid                        # ALWAYS_CONSUMED\r
-  gEfiHobListGuid                               # ALWAYS_CONSUMED\r
   gEfiBootStateGuid                             # ALWAYS_CONSUMED\r
   gEfiFileSystemVolumeLabelInfoIdGuid           # ALWAYS_CONSUMED\r
   gEfiFileInfoGuid                              # ALWAYS_CONSUMED\r
@@ -124,7 +131,7 @@
   gEfiHiiStringProtocolGuid                     # PROTOCOL ALWAYS_CONSUMED\r
   gEfiSimpleFileSystemProtocolGuid              # PROTOCOL ALWAYS_CONSUMED\r
   gEfiLoadFileProtocolGuid                      # PROTOCOL ALWAYS_CONSUMED\r
-  gEfiBdsArchProtocolGuid                       # PROTOCOL ALWAYS_CONSUMED\r
+  gEfiBdsArchProtocolGuid                       # PROTOCOL ALWAYS_PRODUCED\r
   gEfiDataHubProtocolGuid                       # PROTOCOL ALWAYS_CONSUMED\r
   gEfiGenericMemTestProtocolGuid                # PROTOCOL ALWAYS_CONSUMED\r
   gEfiLegacyBiosProtocolGuid                    # PROTOCOL ALWAYS_CONSUMED\r
@@ -141,9 +148,9 @@
   gEfiDevicePathProtocolGuid                    # PROTOCOL ALWAYS_CONSUMED\r
 \r
 [FeaturePcd.common]\r
-  gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangDepricate\r
+  gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangDeprecate\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdSupportHardwareErrorRecord\r
-  gEfiMdeModulePkgTokenSpaceGuid.PcdUgaConsumeSupport\r
+  gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport\r
 \r
 [Pcd.common]\r
   gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangCodes\r