IntelFsp2WrapperPkg/IntelFsp2WrapperPkg.dec

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