[mirror_edk2.git] / IntelFsp2WrapperPkg / IntelFsp2WrapperPkg.dec

## @file\r
# Provides drivers and definitions to support fsp in EDKII bios.\r
#\r
# Copyright (c) 2014 - 2022, Intel Corporation. All rights reserved.<BR>\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
##\r
\r
[Defines]\r
  DEC_SPECIFICATION              = 0x00010005\r
  PACKAGE_NAME                   = IntelFsp2WrapperPkg\r
  PACKAGE_GUID                   = FAFE06D4-7245-42D7-9FD2-E5D5E36AB0A0\r
  PACKAGE_VERSION                = 0.1\r
\r
[Includes]\r
  Include\r
\r
[LibraryClasses]\r
  ##  @libraryclass  Provide FSP API related function.\r
  FspWrapperApiLib|Include/Library/FspWrapperApiLib.h\r
  FspWrapperApiTestLib|Include/Library/FspWrapperApiTestLib.h\r
\r
  ##  @libraryclass  Provide FSP hob process related function.\r
  FspWrapperHobProcessLib|Include/Library/FspWrapperHobProcessLib.h\r
\r
  ##  @libraryclass  Provide FSP platform related function.\r
  FspWrapperPlatformLib|Include/Library/FspWrapperPlatformLib.h\r
\r
  ##  @libraryclass  Provide FSP TPM measurement related function.\r
  FspMeasurementLib|Include/Library/FspMeasurementLib.h\r
\r
  ##  @libraryclass  Provide MultiPhase handling related functions.\r
  FspWrapperMultiPhaseProcessLib|Include/Library/FspWrapperMultiPhaseProcessLib.h\r
\r
  ##  @libraryclass  Provide MultiPhase platform actions related functions.\r
  FspWrapperPlatformMultiPhaseLib|Include/Library/FspWrapperPlatformMultiPhaseLib.h\r
\r
\r
[Guids]\r
  #\r
  # GUID defined in package\r
  #\r
  gIntelFsp2WrapperTokenSpaceGuid       = { 0xa34cf082, 0xf50, 0x4f0d,  { 0x89, 0x8a, 0x3d, 0x39, 0x30, 0x2b, 0xc5, 0x1e } }\r
  gFspApiPerformanceGuid                = { 0xc9122295, 0x56ed, 0x4d4e, { 0x06, 0xa6, 0x50, 0x8d, 0x89, 0x4d, 0x3e, 0x40 } }\r
  gFspHobGuid                           = { 0x6d86fb36, 0xba90, 0x472c, { 0xb5, 0x83, 0x3f, 0xbe, 0xd3, 0xfb, 0x20, 0x9a } }\r
\r
[Ppis]\r
  gFspSiliconInitDonePpiGuid            = { 0x4eb6e09c, 0xd256, 0x4e1e, { 0xb5, 0x0a, 0x87, 0x4b, 0xd2, 0x84, 0xb3, 0xde } }\r
  gTopOfTemporaryRamPpiGuid             = { 0x2f3962b2, 0x57c5, 0x44ec, { 0x9e, 0xfc, 0xa6, 0x9f, 0xd3, 0x02, 0x03, 0x2b } }\r
\r
[Protocols]\r
  gAddPerfRecordProtocolGuid            = { 0xc4a58d6d, 0x3677, 0x49cb, { 0xa0, 0x0a, 0x94, 0x70, 0x76, 0x5f, 0xb5, 0x5e } }\r
\r
################################################################################\r
#\r
# PCD Declarations section - list of all PCDs Declared by this Package\r
#                            Only this package should be providing the\r
#                            declaration, other packages should not.\r
#\r
################################################################################\r
[PcdsFixedAtBuild, PcdsPatchableInModule]\r
  ## Provides the memory mapped base address of the BIOS CodeCache Flash Device.\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdFlashCodeCacheAddress|0xFFE00000|UINT32|0x10000001\r
  ## Provides the size of the BIOS Flash Device.\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdFlashCodeCacheSize|0x00200000|UINT32|0x10000002\r
\r
  ## Indicate the PEI memory size platform want to report\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdPeiMinMemSize|0x1800000|UINT32|0x40000004\r
  ## Indicate the PEI memory size platform want to report\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdPeiRecoveryMinMemSize|0x3000000|UINT32|0x40000005\r
\r
  ## This is the base address of FSP-T\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdFsptBaseAddress|0x00000000|UINT32|0x00000300\r
\r
  ## This PCD indicates if FSP APIs are skipped from FSP wrapper.<BR><BR>\r
  #  If a bit is set, that means this FSP API is skipped.<BR>\r
  #  If a bit is clear, that means this FSP API is NOT skipped.<BR>\r
  #  NOTE: Only NotifyPhase Post PCI enumeration (BIT16) is implemented.<BR>\r
  #  BIT[15:0] is for function:<BR>\r
  #    BIT0    - Skip TempRamInit<BR>\r
  #    BIT1    - Skip MemoryInit<BR>\r
  #    BIT2    - Skip TempRamExit<BR>\r
  #    BIT3    - Skip SiliconInit<BR>\r
  #    BIT4    - Skip NotifyPhase<BR>\r
  #  BIT[32:16] is for sub-function:<BR>\r
  #    BIT16   - Skip NotifyPhase (AfterPciEnumeration)<BR>\r
  #    BIT17   - Skip NotifyPhase (ReadyToBoot)<BR>\r
  #    BIT18   - Skip NotifyPhase (EndOfFirmware)<BR>\r
  #  Any undefined BITs are reserved for future use.<BR>\r
  # @Prompt Skip FSP API from FSP wrapper.\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdSkipFspApi|0x00000000|UINT32|0x40000009\r
\r
  ## This PCD decides how FSP is measured\r
  # 1) The BootGuard ACM may already measured the FSP component, such as FSPT/FSPM.\r
  # We need a flag (PCD) to indicate if there is need to do such FSP measurement or NOT.\r
  # 2) The FSP binary includes FSP code and FSP UPD region. The UPD region is considered\r
  # as configuration block, and it may be updated by OEM by design.\r
  # This flag (PCD) is to indicate if we need isolate the UPD region from the FSP code region.\r
  # BIT0: Need measure FSP. (for FSP1.x) - reserved in FSP2.\r
  # BIT1: Need measure FSPT. (for FSP 2.x)\r
  # BIT2: Need measure FSPM. (for FSP 2.x)\r
  # BIT3: Need measure FSPS. (for FSP 2.x)\r
  # BIT4~30: reserved.\r
  # BIT31: Need isolate UPD region measurement.\r
    #0: measure FSP[T|M|S] as one binary in one record (PCR0).\r
    #1: measure FSP UPD region in one record (PCR1), the FSP code without UPD in another record (PCR0).\r
  #\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdFspMeasurementConfig|0x00000000|UINT32|0x4000000B\r
\r
[PcdsFixedAtBuild, PcdsPatchableInModule,PcdsDynamic,PcdsDynamicEx]\r
  ## This PCD decides how Wrapper code utilizes FSP\r
  # 0: DISPATCH mode (FSP Wrapper will load PeiCore from FSP without calling FSP API)\r
  # 1: API mode (FSP Wrapper will call FSP API)\r
  #\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdFspModeSelection|0x00000001|UINT8|0x4000000A\r
\r
  #\r
  ## These are the base address of FSP-M/S\r
  #\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdFspmBaseAddress|0x00000000|UINT32|0x00001000\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdFspsBaseAddress|0x00000000|UINT32|0x00001001\r
  #\r
  # To provide flexibility for platform to pre-allocate FSP UPD buffer\r
  #\r
  # The PCDs define the pre-allocated FSPM and FSPS UPD Data Buffer Address.\r
  # 0x00000000 - Platform will not pre-allocate UPD buffer before FspWrapper module\r
  # non-zero   - Platform will pre-allocate UPD buffer and patch this value to\r
  #              buffer address before FspWrapper module executing.\r
  #\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdFspmUpdDataAddress|0x00000000|UINT32|0x50000000\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdFspsUpdDataAddress|0x00000000|UINT32|0x50000001\r
  #\r
  # Non-0 means PcdFspmUpdDataAddress will be ignored, otherwise PcdFspmUpdDataAddress will be used.\r
  #\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdFspmUpdDataAddress64|0x00000000|UINT64|0x50000002\r
  #\r
  # Non-0 means PcdFspsUpdDataAddress will be ignored, otherwise PcdFspsUpdDataAddress will be used.\r
  #\r
  gIntelFsp2WrapperTokenSpaceGuid.PcdFspsUpdDataAddress64|0x00000000|UINT64|0x50000003\r
Commit	Line	Data
cf1d4549 JY	1	## @file\r
	2	# Provides drivers and definitions to support fsp in EDKII bios.\r
	3	#\r
31a94f7f	4	# Copyright (c) 2014 - 2022, Intel Corporation. All rights reserved.<BR>\r
512e23a3	5	# SPDX-License-Identifier: BSD-2-Clause-Patent\r
cf1d4549 JY	6	#\r
	7	##\r
	8	\r
	9	[Defines]\r
	10	DEC_SPECIFICATION = 0x00010005\r
	11	PACKAGE_NAME = IntelFsp2WrapperPkg\r
	12	PACKAGE_GUID = FAFE06D4-7245-42D7-9FD2-E5D5E36AB0A0\r
	13	PACKAGE_VERSION = 0.1\r
	14	\r
	15	[Includes]\r
	16	Include\r
	17	\r
	18	[LibraryClasses]\r
	19	## @libraryclass Provide FSP API related function.\r
	20	FspWrapperApiLib\|Include/Library/FspWrapperApiLib.h\r
	21	FspWrapperApiTestLib\|Include/Library/FspWrapperApiTestLib.h\r
	22	\r
	23	## @libraryclass Provide FSP hob process related function.\r
	24	FspWrapperHobProcessLib\|Include/Library/FspWrapperHobProcessLib.h\r
	25	\r
	26	## @libraryclass Provide FSP platform related function.\r
	27	FspWrapperPlatformLib\|Include/Library/FspWrapperPlatformLib.h\r
	28	\r
0c5c45a1 QZ	29	## @libraryclass Provide FSP TPM measurement related function.\r
0c5c45a1 QZ	30	FspMeasurementLib\|Include/Library/FspMeasurementLib.h\r
31a94f7f CC	31	\r
	32	## @libraryclass Provide MultiPhase handling related functions.\r
	33	FspWrapperMultiPhaseProcessLib\|Include/Library/FspWrapperMultiPhaseProcessLib.h\r
	34	\r
	35	## @libraryclass Provide MultiPhase platform actions related functions.\r
f054beec	36	FspWrapperPlatformMultiPhaseLib\|Include/Library/FspWrapperPlatformMultiPhaseLib.h\r
31a94f7f CC	37	\r
31a94f7f CC	38	\r
cf1d4549 JY	39	[Guids]\r
	40	#\r
	41	# GUID defined in package\r
	42	#\r
6f6bf5c7	43	gIntelFsp2WrapperTokenSpaceGuid = { 0xa34cf082, 0xf50, 0x4f0d, { 0x89, 0x8a, 0x3d, 0x39, 0x30, 0x2b, 0xc5, 0x1e } }\r
cf1d4549 JY	44	gFspApiPerformanceGuid = { 0xc9122295, 0x56ed, 0x4d4e, { 0x06, 0xa6, 0x50, 0x8d, 0x89, 0x4d, 0x3e, 0x40 } }\r
	45	gFspHobGuid = { 0x6d86fb36, 0xba90, 0x472c, { 0xb5, 0x83, 0x3f, 0xbe, 0xd3, 0xfb, 0x20, 0x9a } }\r
	46	\r
	47	[Ppis]\r
	48	gFspSiliconInitDonePpiGuid = { 0x4eb6e09c, 0xd256, 0x4e1e, { 0xb5, 0x0a, 0x87, 0x4b, 0xd2, 0x84, 0xb3, 0xde } }\r
	49	gTopOfTemporaryRamPpiGuid = { 0x2f3962b2, 0x57c5, 0x44ec, { 0x9e, 0xfc, 0xa6, 0x9f, 0xd3, 0x02, 0x03, 0x2b } }\r
	50	\r
	51	[Protocols]\r
	52	gAddPerfRecordProtocolGuid = { 0xc4a58d6d, 0x3677, 0x49cb, { 0xa0, 0x0a, 0x94, 0x70, 0x76, 0x5f, 0xb5, 0x5e } }\r
	53	\r
	54	################################################################################\r
	55	#\r
	56	# PCD Declarations section - list of all PCDs Declared by this Package\r
	57	# Only this package should be providing the\r
	58	# declaration, other packages should not.\r
	59	#\r
	60	################################################################################\r
	61	[PcdsFixedAtBuild, PcdsPatchableInModule]\r
	62	## Provides the memory mapped base address of the BIOS CodeCache Flash Device.\r
6f6bf5c7	63	gIntelFsp2WrapperTokenSpaceGuid.PcdFlashCodeCacheAddress\|0xFFE00000\|UINT32\|0x10000001\r
cf1d4549	64	## Provides the size of the BIOS Flash Device.\r
6f6bf5c7	65	gIntelFsp2WrapperTokenSpaceGuid.PcdFlashCodeCacheSize\|0x00200000\|UINT32\|0x10000002\r
cf1d4549	66	\r
cf1d4549	67	## Indicate the PEI memory size platform want to report\r
6f6bf5c7	68	gIntelFsp2WrapperTokenSpaceGuid.PcdPeiMinMemSize\|0x1800000\|UINT32\|0x40000004\r
cf1d4549	69	## Indicate the PEI memory size platform want to report\r
6f6bf5c7	70	gIntelFsp2WrapperTokenSpaceGuid.PcdPeiRecoveryMinMemSize\|0x3000000\|UINT32\|0x40000005\r
cf1d4549	71	\r
2098de62	72	## This is the base address of FSP-T\r
6f6bf5c7	73	gIntelFsp2WrapperTokenSpaceGuid.PcdFsptBaseAddress\|0x00000000\|UINT32\|0x00000300\r
6d40ea81	74	\r
4d4b8169 DG	75	## This PCD indicates if FSP APIs are skipped from FSP wrapper.<BR><BR>\r
	76	# If a bit is set, that means this FSP API is skipped.<BR>\r
	77	# If a bit is clear, that means this FSP API is NOT skipped.<BR>\r
	78	# NOTE: Only NotifyPhase Post PCI enumeration (BIT16) is implemented.<BR>\r
	79	# BIT[15:0] is for function:<BR>\r
	80	# BIT0 - Skip TempRamInit<BR>\r
	81	# BIT1 - Skip MemoryInit<BR>\r
	82	# BIT2 - Skip TempRamExit<BR>\r
	83	# BIT3 - Skip SiliconInit<BR>\r
	84	# BIT4 - Skip NotifyPhase<BR>\r
	85	# BIT[32:16] is for sub-function:<BR>\r
	86	# BIT16 - Skip NotifyPhase (AfterPciEnumeration)<BR>\r
	87	# BIT17 - Skip NotifyPhase (ReadyToBoot)<BR>\r
	88	# BIT18 - Skip NotifyPhase (EndOfFirmware)<BR>\r
	89	# Any undefined BITs are reserved for future use.<BR>\r
	90	# @Prompt Skip FSP API from FSP wrapper.\r
	91	gIntelFsp2WrapperTokenSpaceGuid.PcdSkipFspApi\|0x00000000\|UINT32\|0x40000009\r
	92	\r
c1a42bb0 JY	93	## This PCD decides how FSP is measured\r
	94	# 1) The BootGuard ACM may already measured the FSP component, such as FSPT/FSPM.\r
	95	# We need a flag (PCD) to indicate if there is need to do such FSP measurement or NOT.\r
	96	# 2) The FSP binary includes FSP code and FSP UPD region. The UPD region is considered\r
	97	# as configuration block, and it may be updated by OEM by design.\r
6edd2578	98	# This flag (PCD) is to indicate if we need isolate the UPD region from the FSP code region.\r
c1a42bb0 JY	99	# BIT0: Need measure FSP. (for FSP1.x) - reserved in FSP2.\r
	100	# BIT1: Need measure FSPT. (for FSP 2.x)\r
	101	# BIT2: Need measure FSPM. (for FSP 2.x)\r
	102	# BIT3: Need measure FSPS. (for FSP 2.x)\r
	103	# BIT4~30: reserved.\r
	104	# BIT31: Need isolate UPD region measurement.\r
	105	#0: measure FSP[T\|M\|S] as one binary in one record (PCR0).\r
	106	#1: measure FSP UPD region in one record (PCR1), the FSP code without UPD in another record (PCR0).\r
	107	#\r
	108	gIntelFsp2WrapperTokenSpaceGuid.PcdFspMeasurementConfig\|0x00000000\|UINT32\|0x4000000B\r
	109	\r
6d40ea81	110	[PcdsFixedAtBuild, PcdsPatchableInModule,PcdsDynamic,PcdsDynamicEx]\r
f334c5a4 ZX	111	## This PCD decides how Wrapper code utilizes FSP\r
	112	# 0: DISPATCH mode (FSP Wrapper will load PeiCore from FSP without calling FSP API)\r
	113	# 1: API mode (FSP Wrapper will call FSP API)\r
	114	#\r
	115	gIntelFsp2WrapperTokenSpaceGuid.PcdFspModeSelection\|0x00000001\|UINT8\|0x4000000A\r
	116	\r
2098de62 CC	117	#\r
	118	## These are the base address of FSP-M/S\r
	119	#\r
	120	gIntelFsp2WrapperTokenSpaceGuid.PcdFspmBaseAddress\|0x00000000\|UINT32\|0x00001000\r
6d40ea81	121	gIntelFsp2WrapperTokenSpaceGuid.PcdFspsBaseAddress\|0x00000000\|UINT32\|0x00001001\r
e69dcef5 CC	122	#\r
	123	# To provide flexibility for platform to pre-allocate FSP UPD buffer\r
	124	#\r
	125	# The PCDs define the pre-allocated FSPM and FSPS UPD Data Buffer Address.\r
	126	# 0x00000000 - Platform will not pre-allocate UPD buffer before FspWrapper module\r
	127	# non-zero - Platform will pre-allocate UPD buffer and patch this value to\r
	128	# buffer address before FspWrapper module executing.\r
	129	#\r
	130	gIntelFsp2WrapperTokenSpaceGuid.PcdFspmUpdDataAddress\|0x00000000\|UINT32\|0x50000000\r
cae524cd	131	gIntelFsp2WrapperTokenSpaceGuid.PcdFspsUpdDataAddress\|0x00000000\|UINT32\|0x50000001\r
de9e5b7d AA	132	#\r
	133	# Non-0 means PcdFspmUpdDataAddress will be ignored, otherwise PcdFspmUpdDataAddress will be used.\r
	134	#\r
	135	gIntelFsp2WrapperTokenSpaceGuid.PcdFspmUpdDataAddress64\|0x00000000\|UINT64\|0x50000002\r
	136	#\r
	137	# Non-0 means PcdFspsUpdDataAddress will be ignored, otherwise PcdFspsUpdDataAddress will be used.\r
	138	#\r
	139	gIntelFsp2WrapperTokenSpaceGuid.PcdFspsUpdDataAddress64\|0x00000000\|UINT64\|0x50000003\r