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

## @file\r
#  General BDS library.\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 - 2018, Intel Corporation. All rights reserved.<BR>\r
#  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
  MODULE_UNI_FILE                = GenericBdsLib.uni\r
  FILE_GUID                      = e405ec31-ccaa-4dd4-83e8-0aec01703f7e\r
  MODULE_TYPE                    = DXE_DRIVER\r
  VERSION_STRING                 = 1.0\r
  LIBRARY_CLASS                  = GenericBdsLib|DXE_DRIVER DXE_RUNTIME_DRIVER UEFI_APPLICATION \r
  CONSTRUCTOR                    = GenericBdsLibConstructor\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]\r
  DevicePath.c\r
  BdsConnect.c\r
  BdsMisc.c\r
  BdsConsole.c\r
  BdsBoot.c\r
  InternalBdsLib.h\r
  String.h\r
  String.c\r
  GenericBdsStrings.uni\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
  DxeServicesLib\r
  HiiLib\r
  ReportStatusCodeLib\r
  BmpSupportLib\r
\r
[Guids]\r
  ## SOMETIMES_CONSUMES ## HOB         # The hob holding memory type information\r
  ## SOMETIMES_CONSUMES ## SystemTable # The identifier of memory type information type in system table\r
  ## SOMETIMES_CONSUMES ## Variable:L"MemoryTypeInformation"\r
  ## SOMETIMES_PRODUCES ## Variable:L"MemoryTypeInformation"\r
  gEfiMemoryTypeInformationGuid                 \r
  ## SOMETIMES_CONSUMES ## Variable:L"BootXXXX"    # Boot option variable\r
  ## SOMETIMES_PRODUCES ## Variable:L"BootXXXX"    # Boot option variable\r
  ## SOMETIMES_CONSUMES ## Variable:L"DriverXXXX"  # Driver load option.\r
  ## SOMETIMES_PRODUCES ## Variable:L"DriverXXXX"  # Driver load option.\r
  ## SOMETIMES_CONSUMES ## Variable:L"BootNext"    # Next Boot Option\r
  ## SOMETIMES_PRODUCES ## Variable:L"BootNext"    # Next Boot Option\r
  ## SOMETIMES_CONSUMES ## Variable:L"BootOrder"   # The boot option array\r
  ## SOMETIMES_PRODUCES ## 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_PRODUCES ## 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_PRODUCES ## Variable:L"ConOut"      # The device path of console out device\r
  ## SOMETIMES_CONSUMES ## Variable:L"ErrOut"      # The device path of error out device\r
  ## SOMETIMES_PRODUCES ## Variable:L"ErrOut"      # The device path of error out device\r
  ## SOMETIMES_PRODUCES ## Variable:L"BootCurrent" # The boot option of current boot\r
  ## SOMETIMES_PRODUCES ## Variable:L"BootNext"    # The number of next boot option\r
  gEfiGlobalVariableGuid\r
  gEfiFileInfoGuid                              ## SOMETIMES_CONSUMES ## GUID\r
  gLastEnumLangGuid                             ## SOMETIMES_PRODUCES ## Variable:L"LastEnumLang" # Platform language at last time enumeration.\r
  gHdBootDevicePathVariablGuid                  ## SOMETIMES_PRODUCES ## Variable:L"HDDP" # The device path of Boot file on Hard device.\r
  gBdsLibStringPackageGuid                      ## CONSUMES ## HII # HII String PackageList Guid\r
  ## SOMETIMES_PRODUCES ## Variable:L"LegacyDevOrder"\r
  ## SOMETIMES_CONSUMES ## Variable:L"LegacyDevOrder"\r
  gEfiLegacyDevOrderVariableGuid\r
  gEdkiiStatusCodeDataTypeVariableGuid          ## SOMETIMES_CONSUMES ## GUID\r
\r
[Protocols]\r
  gEfiSimpleFileSystemProtocolGuid              ## SOMETIMES_CONSUMES\r
  gEfiLoadFileProtocolGuid                      ## SOMETIMES_CONSUMES\r
  gEfiSimpleTextOutProtocolGuid                 ## CONSUMES\r
  gEfiPciIoProtocolGuid                         ## SOMETIMES_CONSUMES\r
  gEfiLoadedImageProtocolGuid                   ## SOMETIMES_CONSUMES\r
  gEfiSimpleNetworkProtocolGuid                 ## SOMETIMES_CONSUMES\r
  gEfiDebugPortProtocolGuid                     ## SOMETIMES_CONSUMES\r
  gEfiSimpleTextInProtocolGuid                  ## CONSUMES\r
  gEfiBlockIoProtocolGuid                       ## SOMETIMES_CONSUMES\r
  gEfiFirmwareVolume2ProtocolGuid               ## SOMETIMES_CONSUMES\r
  gEfiLegacyBiosProtocolGuid                    ## SOMETIMES_CONSUMES\r
  gEfiCpuArchProtocolGuid                       ## CONSUMES\r
  gEfiDevicePathProtocolGuid                    ## CONSUMES\r
  gEfiGraphicsOutputProtocolGuid                ## SOMETIMES_CONSUMES\r
  gEfiUgaDrawProtocolGuid |gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport ## SOMETIMES_CONSUMES\r
  gEfiOEMBadgingProtocolGuid                    ## SOMETIMES_CONSUMES\r
  gEfiHiiFontProtocolGuid                       ## CONSUMES\r
  gEfiUserManagerProtocolGuid                   ## SOMETIMES_CONSUMES\r
  gEfiUsbIoProtocolGuid                         ## SOMETIMES_CONSUMES\r
  gEfiBootLogoProtocolGuid                      ## SOMETIMES_CONSUMES\r
\r
[FeaturePcd]\r
  gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport                   ## CONSUMES\r
  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBootlogoOnlyEnable ## CONSUMES\r
\r
[Pcd]\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdResetOnMemoryTypeInformationChange ## SOMETIMES_CONSUMES\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeOsLoaderLoad  ## SOMETIMES_CONSUMES\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeOsLoaderStart ## SOMETIMES_CONSUMES\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdErrorCodeSetVariable      ## CONSUMES\r
  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile      ## CONSUMES\r
\r
#\r
# [BootMode] \r
#   RECOVERY_FULL    ## SOMETIMES_CONSUMES # Memory Type Information variable\r
#\r
\r
Commit	Line	Data
a7a523e0	1	## @file\r
f9841f04	2	# General BDS library.\r
5c08e117	3	# \r
	4	# General BDS defines and produce general interfaces for platform BDS driver including:\r
	5	# 1) BDS boot policy interface;\r
	6	# 2) BDS boot device connect interface;\r
	7	# 3) BDS Misc interfaces for mainting boot variable, ouput string, etc.\r
	8	# \r
53473721	9	# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
180a5a35	10	# This program and the accompanying materials\r
5c08e117	11	# are licensed and made available under the terms and conditions of the BSD License\r
	12	# which accompanies this distribution. The full text of the license may be found at\r
	13	# http://opensource.org/licenses/bsd-license.php\r
	14	# \r
	15	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	16	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	17	# \r
a7a523e0	18	##\r
5c08e117	19	\r
	20	[Defines]\r
	21	INF_VERSION = 0x00010005\r
	22	BASE_NAME = GenericBdsLib\r
f9841f04	23	MODULE_UNI_FILE = GenericBdsLib.uni\r
5c08e117	24	FILE_GUID = e405ec31-ccaa-4dd4-83e8-0aec01703f7e\r
	25	MODULE_TYPE = DXE_DRIVER\r
	26	VERSION_STRING = 1.0\r
566771b0	27	LIBRARY_CLASS = GenericBdsLib\|DXE_DRIVER DXE_RUNTIME_DRIVER UEFI_APPLICATION \r
9aa7ba01	28	CONSTRUCTOR = GenericBdsLibConstructor\r
5c08e117	29	\r
	30	#\r
	31	# The following information is for reference only and not required by the build tools.\r
	32	#\r
	33	# VALID_ARCHITECTURES = IA32 X64 IPF EBC\r
	34	#\r
	35	\r
6bfbb5f0	36	[Sources]\r
5c08e117	37	DevicePath.c\r
5c08e117	38	BdsConnect.c\r
	39	BdsMisc.c\r
	40	BdsConsole.c\r
	41	BdsBoot.c\r
	42	InternalBdsLib.h\r
9aa7ba01	43	String.h\r
	44	String.c\r
	45	GenericBdsStrings.uni\r
3dcb6018	46	\r
5c08e117	47	[Packages]\r
	48	MdePkg/MdePkg.dec\r
	49	MdeModulePkg/MdeModulePkg.dec\r
5c08e117	50	IntelFrameworkPkg/IntelFrameworkPkg.dec\r
ddac74d1	51	IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec\r
5c08e117	52	\r
	53	[LibraryClasses]\r
	54	DevicePathLib\r
	55	PeCoffGetEntryPointLib\r
	56	BaseLib\r
	57	HobLib\r
	58	UefiRuntimeServicesTableLib\r
	59	DxeServicesTableLib\r
	60	MemoryAllocationLib\r
	61	UefiLib\r
	62	UefiBootServicesTableLib\r
	63	BaseMemoryLib\r
	64	DebugLib\r
	65	PrintLib\r
	66	PcdLib\r
	67	PerformanceLib\r
	68	TimerLib\r
5c08e117	69	DxeServicesLib\r
9aa7ba01	70	HiiLib\r
79b7a6a1	71	ReportStatusCodeLib\r
53473721	72	BmpSupportLib\r
5c08e117	73	\r
5c08e117	74	[Guids]\r
f9841f04 SZ	75	## SOMETIMES_CONSUMES ## HOB # The hob holding memory type information\r
	76	## SOMETIMES_CONSUMES ## SystemTable # The identifier of memory type information type in system table\r
	77	## SOMETIMES_CONSUMES ## Variable:L"MemoryTypeInformation"\r
	78	## SOMETIMES_PRODUCES ## Variable:L"MemoryTypeInformation"\r
	79	gEfiMemoryTypeInformationGuid \r
	80	## SOMETIMES_CONSUMES ## Variable:L"BootXXXX" # Boot option variable\r
	81	## SOMETIMES_PRODUCES ## Variable:L"BootXXXX" # Boot option variable\r
	82	## SOMETIMES_CONSUMES ## Variable:L"DriverXXXX" # Driver load option.\r
	83	## SOMETIMES_PRODUCES ## Variable:L"DriverXXXX" # Driver load option.\r
	84	## SOMETIMES_CONSUMES ## Variable:L"BootNext" # Next Boot Option\r
	85	## SOMETIMES_PRODUCES ## Variable:L"BootNext" # Next Boot Option\r
	86	## SOMETIMES_CONSUMES ## Variable:L"BootOrder" # The boot option array\r
	87	## SOMETIMES_PRODUCES ## Variable:L"BootOrder" # The boot option array\r
	88	## SOMETIMES_CONSUMES ## Variable:L"DriverOrder" # The driver order list\r
	89	## SOMETIMES_CONSUMES ## Variable:L"ConIn" # The device path of console in device\r
	90	## SOMETIMES_PRODUCES ## Variable:L"ConIn" # The device path of console in device\r
	91	## SOMETIMES_CONSUMES ## Variable:L"ConOut" # The device path of console out device\r
	92	## SOMETIMES_PRODUCES ## Variable:L"ConOut" # The device path of console out device\r
	93	## SOMETIMES_CONSUMES ## Variable:L"ErrOut" # The device path of error out device\r
	94	## SOMETIMES_PRODUCES ## Variable:L"ErrOut" # The device path of error out device\r
	95	## SOMETIMES_PRODUCES ## Variable:L"BootCurrent" # The boot option of current boot\r
	96	## SOMETIMES_PRODUCES ## Variable:L"BootNext" # The number of next boot option\r
	97	gEfiGlobalVariableGuid\r
	98	gEfiFileInfoGuid ## SOMETIMES_CONSUMES ## GUID\r
f9841f04 SZ	99	gLastEnumLangGuid ## SOMETIMES_PRODUCES ## Variable:L"LastEnumLang" # Platform language at last time enumeration.\r
	100	gHdBootDevicePathVariablGuid ## SOMETIMES_PRODUCES ## Variable:L"HDDP" # The device path of Boot file on Hard device.\r
	101	gBdsLibStringPackageGuid ## CONSUMES ## HII # HII String PackageList Guid\r
	102	## SOMETIMES_PRODUCES ## Variable:L"LegacyDevOrder"\r
	103	## SOMETIMES_CONSUMES ## Variable:L"LegacyDevOrder"\r
	104	gEfiLegacyDevOrderVariableGuid\r
	105	gEdkiiStatusCodeDataTypeVariableGuid ## SOMETIMES_CONSUMES ## GUID\r
f999350b	106	\r
5c08e117	107	[Protocols]\r
f9841f04 SZ	108	gEfiSimpleFileSystemProtocolGuid ## SOMETIMES_CONSUMES\r
	109	gEfiLoadFileProtocolGuid ## SOMETIMES_CONSUMES\r
	110	gEfiSimpleTextOutProtocolGuid ## CONSUMES\r
	111	gEfiPciIoProtocolGuid ## SOMETIMES_CONSUMES\r
	112	gEfiLoadedImageProtocolGuid ## SOMETIMES_CONSUMES\r
	113	gEfiSimpleNetworkProtocolGuid ## SOMETIMES_CONSUMES\r
	114	gEfiDebugPortProtocolGuid ## SOMETIMES_CONSUMES\r
	115	gEfiSimpleTextInProtocolGuid ## CONSUMES\r
	116	gEfiBlockIoProtocolGuid ## SOMETIMES_CONSUMES\r
	117	gEfiFirmwareVolume2ProtocolGuid ## SOMETIMES_CONSUMES\r
	118	gEfiLegacyBiosProtocolGuid ## SOMETIMES_CONSUMES\r
	119	gEfiCpuArchProtocolGuid ## CONSUMES\r
	120	gEfiDevicePathProtocolGuid ## CONSUMES\r
f9841f04 SZ	121	gEfiGraphicsOutputProtocolGuid ## SOMETIMES_CONSUMES\r
	122	gEfiUgaDrawProtocolGuid \|gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport ## SOMETIMES_CONSUMES\r
	123	gEfiOEMBadgingProtocolGuid ## SOMETIMES_CONSUMES\r
	124	gEfiHiiFontProtocolGuid ## CONSUMES\r
	125	gEfiUserManagerProtocolGuid ## SOMETIMES_CONSUMES\r
	126	gEfiUsbIoProtocolGuid ## SOMETIMES_CONSUMES\r
	127	gEfiBootLogoProtocolGuid ## SOMETIMES_CONSUMES\r
5c08e117	128	\r
d46f3632	129	[FeaturePcd]\r
f9841f04 SZ	130	gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport ## CONSUMES\r
f9841f04 SZ	131	gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBootlogoOnlyEnable ## CONSUMES\r
5c08e117	132	\r
d46f3632	133	[Pcd]\r
f9841f04 SZ	134	gEfiMdeModulePkgTokenSpaceGuid.PcdResetOnMemoryTypeInformationChange ## SOMETIMES_CONSUMES\r
	135	gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeOsLoaderLoad ## SOMETIMES_CONSUMES\r
	136	gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeOsLoaderStart ## SOMETIMES_CONSUMES\r
	137	gEfiMdeModulePkgTokenSpaceGuid.PcdErrorCodeSetVariable ## CONSUMES\r
	138	gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile ## CONSUMES\r
	139	\r
	140	#\r
	141	# [BootMode] \r
	142	# RECOVERY_FULL ## SOMETIMES_CONSUMES # Memory Type Information variable\r
	143	#\r
	144	\r