Refine function comments for BdsDxe module.

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

#/** @file\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
#  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
#  http://opensource.org/licenses/bsd-license.php\r
#  \r
#  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
#**/\r
\r
[Defines]\r
  INF_VERSION                    = 0x00010005\r
  BASE_NAME                      = BdsDxe\r
  FILE_GUID                      = FC5C7020-1A48-4198-9BE2-EAD5ABC8CF2F\r
  MODULE_TYPE                    = DXE_DRIVER\r
  VERSION_STRING                 = 1.0 \r
  EFI_SPECIFICATION_VERSION      = 0x00020000\r
  ENTRY_POINT                    = BdsInitialize\r
\r
#\r
# The following information is for reference only and not required by the build tools.\r
#\r
#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC\r
#\r
\r
[Sources.common]\r
  FrontPage.h\r
  Language.h\r
  Bds.h\r
  Hotkey.h\r
  BootMaint/BBSsupport.h\r
  BootMngr/BootManager.h\r
  BootMaint/BootMaint.h\r
  String.h\r
  BootMaint/FormGuid.h\r
  HwErrRecSupport.c\r
  HwErrRecSupport.h\r
\r
  DeviceMngr/DeviceManager.h\r
  DeviceMngr/DeviceManagerVfr.Vfr\r
  DeviceMngr/DeviceManagerStrings.uni\r
  DeviceMngr/DeviceManager.c\r
  BootMngr/BootManagerVfr.Vfr\r
  BootMngr/BootManagerStrings.uni\r
  BootMngr/BootManager.c\r
  BootMaint/FE.vfr\r
  BootMaint/FileExplorer.c\r
  BootMaint/BootMaint.c\r
  BootMaint/BBSsupport.c\r
  BootMaint/UpdatePage.c\r
  BootMaint/Variable.c\r
  BootMaint/Data.c\r
  BootMaint/ConsoleOption.c\r
  BootMaint/BootOption.c\r
  BootMaint/BmLib.c\r
  BootMaint/Bm.vfr\r
  BootMaint/Bmstring.uni\r
  Hotkey.c\r
  MemoryTest.c\r
  Capsules.c\r
  Strings.uni\r
  String.c\r
  Language.c\r
  FrontPageVfr.Vfr\r
  FrontPageStrings.uni\r
  FrontPage.c\r
  BdsEntry.c\r
\r
\r
[Packages]\r
  MdePkg/MdePkg.dec\r
  MdeModulePkg/MdeModulePkg.dec\r
  #\r
  #This dependency is because of gEfiLegacyBiosProtocolGuid and gEfiDataHubProtocolGuid. It may be removed if a Library class is created to\r
  #abstract away definition in Framework specification or PI spec incorporates the Legacy Booting Protocols and Data Hub Protocols.\r
  #\r
  IntelFrameworkPkg/IntelFrameworkPkg.dec\r
\r
\r
[LibraryClasses]\r
  DevicePathLib\r
  BaseLib\r
  HobLib\r
  UefiRuntimeServicesTableLib\r
  IfrSupportLib\r
  ExtendedIfrSupportLib\r
  GenericBdsLib\r
  ReportStatusCodeLib\r
  PerformanceLib\r
  MemoryAllocationLib\r
  UefiLib\r
  UefiBootServicesTableLib\r
  BaseMemoryLib\r
  DebugLib\r
  PrintLib\r
  HiiLib\r
  ExtendedHiiLib\r
  UefiDriverEntryPoint\r
  PlatformBdsLib\r
  CapsuleLib\r
\r
[Guids]\r
  gEfiGlobalVariableGuid                        # ALWAYS_CONSUMED\r
  gEfiBootStateGuid                             # ALWAYS_CONSUMED\r
  gEfiFileSystemVolumeLabelInfoIdGuid           # ALWAYS_CONSUMED\r
  gEfiFileInfoGuid                              # ALWAYS_CONSUMED\r
  gEfiGenericPlatformVariableGuid\r
  gEfiMiscSubClassGuid\r
  gEfiMemorySubClassGuid\r
  gEfiProcessorSubClassGuid\r
  gEfiCapsuleVendorGuid\r
\r
[Protocols]\r
  gEfiHiiStringProtocolGuid                     # PROTOCOL ALWAYS_CONSUMED\r
  gEfiSimpleFileSystemProtocolGuid              # PROTOCOL ALWAYS_CONSUMED\r
  gEfiLoadFileProtocolGuid                      # PROTOCOL ALWAYS_CONSUMED\r
  gEfiBdsArchProtocolGuid                       # PROTOCOL ALWAYS_PRODUCED\r
  gEfiDataHubProtocolGuid                       # PROTOCOL ALWAYS_CONSUMED\r
  gEfiGenericMemTestProtocolGuid                # PROTOCOL ALWAYS_CONSUMED\r
  gEfiLegacyBiosProtocolGuid                    # PROTOCOL ALWAYS_CONSUMED\r
  gEfiConsoleControlProtocolGuid                # PROTOCOL ALWAYS_CONSUMED\r
  gEfiHiiDatabaseProtocolGuid                   # PROTOCOL ALWAYS_CONSUMED\r
  gEfiUgaDrawProtocolGuid                       # PROTOCOL ALWAYS_CONSUMED\r
  gEfiBlockIoProtocolGuid                       # PROTOCOL ALWAYS_CONSUMED\r
  gEfiGraphicsOutputProtocolGuid                # PROTOCOL ALWAYS_CONSUMED\r
  gEfiSimpleTextInputExProtocolGuid             # PROTOCOL ALWAYS_CONSUMED\r
  gEfiHiiConfigRoutingProtocolGuid              # PROTOCOL ALWAYS_CONSUMED\r
  gEfiHiiConfigAccessProtocolGuid               # PROTOCOL ALWAYS_CONSUMED\r
  gEfiFormBrowser2ProtocolGuid                  # PROTOCOL ALWAYS_CONSUMED\r
  gEfiSerialIoProtocolGuid                      # PROTOCOL ALWAYS_CONSUMED\r
  gEfiDevicePathProtocolGuid                    # PROTOCOL ALWAYS_CONSUMED\r
\r
[FeaturePcd.common]\r
  gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangDeprecate\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdSupportHardwareErrorRecord\r
  gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport\r
\r
[Pcd.common]\r
  gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangCodes\r
  gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLang\r
  gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultPlatformLangCodes\r
  gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultPlatformLang\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdHardwareErrorRecordLevel\r
\r
[Depex]\r
  gEfiHiiDatabaseProtocolGuid\r
\r