Update header file comments.

[mirror_edk2.git] / IntelFrameworkModulePkg / Library / GenericBdsLib / GenericBdsLib.inf

#/** @file\r
#  \r
#  General BDS defines and produce general interfaces for platform BDS driver including:\r
#  1) BDS boot policy interface;\r
#  2) BDS boot device connect interface;\r
#  3) BDS Misc interfaces for mainting boot variable, ouput string, etc.\r
#  \r
#  Copyright (c) 2007 - 2009, 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                      = GenericBdsLib\r
  FILE_GUID                      = e405ec31-ccaa-4dd4-83e8-0aec01703f7e\r
  MODULE_TYPE                    = DXE_DRIVER\r
  VERSION_STRING                 = 1.0\r
  LIBRARY_CLASS                  = GenericBdsLib|DXE_DRIVER UEFI_APPLICATION \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
  DevicePath.c\r
  Performance.c\r
  BdsConnect.c\r
  BdsMisc.c\r
  BdsConsole.c\r
  BdsBoot.c\r
  InternalBdsLib.h\r
\r
[Sources.IPF]\r
  Ipf/ShadowRom.c\r
\r
[Packages]\r
  MdePkg/MdePkg.dec\r
  MdeModulePkg/MdeModulePkg.dec\r
  IntelFrameworkPkg/IntelFrameworkPkg.dec\r
  IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec\r
\r
[LibraryClasses]\r
  DevicePathLib\r
  PeCoffGetEntryPointLib\r
  BaseLib\r
  HobLib\r
  UefiRuntimeServicesTableLib\r
  DxeServicesTableLib\r
  MemoryAllocationLib\r
  UefiLib\r
  UefiBootServicesTableLib\r
  BaseMemoryLib\r
  DebugLib\r
  PrintLib\r
  PcdLib\r
  PerformanceLib\r
  TimerLib\r
  PcdLib\r
  DxeServicesLib\r
\r
[Guids]\r
  gEfiVT100PlusGuid                             ## CONSUMES ## GUID (The type of terminal)\r
  gEfiVT100Guid                                 ## CONSUMES ## GUID (The type of terminal)\r
  gEfiMemoryTypeInformationGuid                 ## CONSUMES ## GUID (The identifier of memory type information type in system table)\r
                                                ## CONSUMES ## GUID HOB (The hob holding memory type information)\r
  gEfiVTUTF8Guid                                ## CONSUMES ## GUID (The type of terminal)\r
  gEfiShellFileGuid                             ## CONSUMES ## GUID (Identify the shell file)\r
  gEfiGlobalVariableGuid                        ## SOMETIMES_PRODUCES ## Variable:L"BootCurrent" (The boot option of current boot)\r
                                                ## SOMETIMES_CONSUMES ## Variable:L"BootXX" (Boot option variable)\r
                                                ## CONSUMES           ## Variable:L"Timeout" (The time out value in second of showing progress bar)\r
                                                ## SOMETIMES_CONSUMES ## Variable:L"BootOrder" (The boot option array)\r
                                                ## SOMETIMES_CONSUMES ## Variable:L"DriverOrder" (The driver order list)\r
                                                ## SOMETIMES_CONSUMES ## Variable:L"ConIn" (The device path of console in device)\r
                                                ## SOMETIMES_CONSUMES ## Variable:L"ConOut" (The device path of console out device)\r
                                                ## SOMETIMES_CONSUMES ## Variable:L"ErrOut" (The device path of error out device)\r
  gEfiFileInfoGuid                              ## CONSUMES ## GUID\r
  gEfiPcAnsiGuid                                ## CONSUMES ## GUID (The type of terminal)\r
  gPerformanceProtocolGuid                      ## SOMETIMES_PRODUCES ## Variable:L"PerfDataMemAddr" (The ACPI address of performance data)\r
  gEfiUartDevicePathGuid                        ## CONSUMES ## GUID (Identify the device path for UARD device)\r
  gEfiSasDevicePathGuid                         ## CONSUMES ## GUID (Identify the device path for SAS device)\r
\r
[Protocols]\r
  gEfiSimpleFileSystemProtocolGuid              # PROTOCOL CONSUMES\r
  gEfiSimpleTextOutProtocolGuid                 # PROTOCOL CONSUMES\r
  gEfiPciIoProtocolGuid                         # PROTOCOL CONSUMES\r
  gEfiLoadedImageProtocolGuid                   # PROTOCOL CONSUMES\r
  gEfiDevicePathToTextProtocolGuid              # PROTOCOL SOMETIMES_CONSUMES\r
  gEfiSimpleNetworkProtocolGuid                 # PROTOCOL CONSUMES\r
  gEfiDebugPortProtocolGuid                     # PROTOCOL CONSUMES\r
  gEfiSimpleTextInProtocolGuid                  # PROTOCOL CONSUMES\r
  gEfiBlockIoProtocolGuid                       # PROTOCOL CONSUMES\r
  gEfiFirmwareVolume2ProtocolGuid               # PROTOCOL CONSUMES\r
  gEfiLegacyBiosProtocolGuid                    # PROTOCOL SOMETIMES_CONSUMES\r
  gEfiCpuArchProtocolGuid                       # PROTOCOL CONSUMES\r
  gEfiDevicePathProtocolGuid                    # PROTOCOL CONSUMES\r
  gEfiAcpiS3SaveProtocolGuid                    # PROTOCOL CONSUMES\r
  gEfiGraphicsOutputProtocolGuid                # PROTOCOL SOMETIMES_CONSUMES\r
  gEfiUgaDrawProtocolGuid |PcdUgaConsumeSupport # PROTOCOL SOMETIMES_CONSUMES\r
  gEfiOEMBadgingProtocolGuid                    # PROTOCOL CONSUMES\r
  gEfiHiiFontProtocolGuid                       # PROTOCOL CONSUMES\r
  gEfiSecurityArchProtocolGuid                  # PROTOCOL CONSUMES\r
\r
[FeaturePcd.common]\r
  gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport\r
\r