UefiCpuPkg/UefiCpuPkg.dec

   1 ## @file  UefiCpuPkg.dec
   2 # This Package provides UEFI compatible CPU modules and libraries.
   3 #
   4 # Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>
   5 #
   6 # This program and the accompanying materials are licensed and made available under
   7 # the terms and conditions of the BSD License which accompanies this distribution.
   8 # The full text of the license may be found at
   9 # http://opensource.org/licenses/bsd-license.php
  10 #
  11 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13 #
  14 ##
  15
  16 [Defines]
  17   DEC_SPECIFICATION              = 0x00010005
  18   PACKAGE_NAME                   = UefiCpuPkg
  19   PACKAGE_UNI_FILE               = UefiCpuPkg.uni
  20   PACKAGE_GUID                   = 2171df9b-0d39-45aa-ac37-2de190010d23
  21   PACKAGE_VERSION                = 0.80
  22
  23 [Includes]
  24   Include
  25
  26 [LibraryClasses]
  27   ##  @libraryclass  Defines some routines that are generic for IA32 family CPU
  28   ##                 to be UEFI specification compliant.
  29   ##
  30   UefiCpuLib|Include/Library/UefiCpuLib.h
  31
  32   ##  @libraryclass  Defines some routines that are used to register/manage/program
  33   ##                 CPU features.
  34   ##
  35   RegisterCpuFeaturesLib|Include/Library/RegisterCpuFeaturesLib.h
  36
  37 [LibraryClasses.IA32, LibraryClasses.X64]
  38   ##  @libraryclass  Provides functions to manage MTRR settings on IA32 and X64 CPUs.
  39   ##
  40   MtrrLib|Include/Library/MtrrLib.h
  41
  42   ##  @libraryclass  Provides functions to manage the Local APIC on IA32 and X64 CPUs.
  43   ##
  44   LocalApicLib|Include/Library/LocalApicLib.h
  45
  46   ##  @libraryclass  Provides platform specific initialization functions in the SEC phase.
  47   ##
  48   PlatformSecLib|Include/Library/PlatformSecLib.h
  49
  50   ##  @libraryclass  Public include file for the SMM CPU Platform Hook Library.
  51   ##
  52   SmmCpuPlatformHookLib|Include/Library/SmmCpuPlatformHookLib.h
  53
  54   ##  @libraryclass  Provides the CPU specific programming for PiSmmCpuDxeSmm module.
  55   ##
  56   SmmCpuFeaturesLib|Include/Library/SmmCpuFeaturesLib.h
  57
  58   ##  @libraryclass  Provides functions to support MP services on CpuMpPei and CpuDxe module.
  59   ##
  60   MpInitLib|Include/Library/MpInitLib.h
  61
  62 [Guids]
  63   gUefiCpuPkgTokenSpaceGuid      = { 0xac05bf33, 0x995a, 0x4ed4, { 0xaa, 0xb8, 0xef, 0x7a, 0xe8, 0xf, 0x5c, 0xb0 }}
  64   gMsegSmramGuid                 = { 0x5802bce4, 0xeeee, 0x4e33, { 0xa1, 0x30, 0xeb, 0xad, 0x27, 0xf0, 0xe4, 0x39 }}
  65
  66   ## Include/Guid/CpuFeaturesSetDone.h
  67   gEdkiiCpuFeaturesSetDoneGuid   = { 0xa82485ce, 0xad6b, 0x4101, { 0x99, 0xd3, 0xe1, 0x35, 0x8c, 0x9e, 0x7e, 0x37 }}
  68
  69   ## Include/Guid/CpuFeaturesInitDone.h
  70   gEdkiiCpuFeaturesInitDoneGuid  = { 0xc77c3a41, 0x61ab, 0x4143, { 0x98, 0x3e, 0x33, 0x39, 0x28, 0x6, 0x28, 0xe5 }}
  71
  72 [Protocols]
  73   ## Include/Protocol/SmmCpuService.h
  74   gEfiSmmCpuServiceProtocolGuid  = { 0x1d202cab, 0xc8ab, 0x4d5c, { 0x94, 0xf7, 0x3c, 0xfc, 0xc0, 0xd3, 0xd3, 0x35 }}
  75
  76   ## Include/Protocol/SmMonitorInit.h
  77   gEfiSmMonitorInitProtocolGuid  = { 0x228f344d, 0xb3de, 0x43bb, { 0xa4, 0xd7, 0xea, 0x20, 0xb, 0x1b, 0x14, 0x82 }}
  78
  79 #
  80 # [Error.gUefiCpuPkgTokenSpaceGuid]
  81 #   0x80000001 | Invalid value provided.
  82 #
  83
  84 [PcdsFeatureFlag]
  85   ## Indicates if SMM Profile will be enabled.
  86   #  If enabled, instruction executions in and data accesses to memory outside of SMRAM will be logged.
  87   #  It could not be enabled at the same time with SMM static page table feature (PcdCpuSmmStaticPageTable).
  88   #  This PCD is only for validation purpose. It should be set to false in production.<BR><BR>
  89   #   TRUE  - SMM Profile will be enabled.<BR>
  90   #   FALSE - SMM Profile will be disabled.<BR>
  91   # @Prompt Enable SMM Profile.
  92   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileEnable|FALSE|BOOLEAN|0x32132109
  93
  94   ## Indicates if the SMM profile log buffer is a ring buffer.
  95   #  If disabled, no additional log can be done when the buffer is full.<BR><BR>
  96   #   TRUE  - the SMM profile log buffer is a ring buffer.<BR>
  97   #   FALSE - the SMM profile log buffer is a normal buffer.<BR>
  98   # @Prompt The SMM profile log buffer is a ring buffer.
  99   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileRingBuffer|FALSE|BOOLEAN|0x3213210a
 100
 101   ## Indicates if SMM Startup AP in a blocking fashion.
 102   #   TRUE  - SMM Startup AP in a blocking fashion.<BR>
 103   #   FALSE - SMM Startup AP in a non-blocking fashion.<BR>
 104   # @Prompt SMM Startup AP in a blocking fashion.
 105   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmBlockStartupThisAp|FALSE|BOOLEAN|0x32132108
 106
 107   ## Indicates if SMM Stack Guard will be enabled.
 108   #  If enabled, stack overflow in SMM can be caught, preventing chaotic consequences.<BR><BR>
 109   #   TRUE  - SMM Stack Guard will be enabled.<BR>
 110   #   FALSE - SMM Stack Guard will be disabled.<BR>
 111   # @Prompt Enable SMM Stack Guard.
 112   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStackGuard|TRUE|BOOLEAN|0x1000001C
 113
 114   ## Indicates if BSP election in SMM will be enabled.
 115   #  If enabled, a BSP will be dynamically elected among all processors in each SMI.
 116   #  Otherwise, processor 0 is always as BSP in each SMI.<BR><BR>
 117   #   TRUE  - BSP election in SMM will be enabled.<BR>
 118   #   FALSE - BSP election in SMM will be disabled.<BR>
 119   # @Prompt Enable BSP election in SMM.
 120   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmEnableBspElection|TRUE|BOOLEAN|0x32132106
 121
 122   ## Indicates if CPU SMM hot-plug will be enabled.<BR><BR>
 123   #   TRUE  - SMM CPU hot-plug will be enabled.<BR>
 124   #   FALSE - SMM CPU hot-plug will be disabled.<BR>
 125   # @Prompt SMM CPU hot-plug.
 126   gUefiCpuPkgTokenSpaceGuid.PcdCpuHotPlugSupport|FALSE|BOOLEAN|0x3213210C
 127
 128   ## Indicates if SMM Debug will be enabled.
 129   #  If enabled, hardware breakpoints in SMRAM can be set outside of SMM mode and take effect in SMM.<BR><BR>
 130   #   TRUE  - SMM Debug will be enabled.<BR>
 131   #   FALSE - SMM Debug will be disabled.<BR>
 132   # @Prompt Enable SMM Debug.
 133   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmDebug|FALSE|BOOLEAN|0x1000001B
 134
 135   ## Indicates if lock SMM Feature Control MSR.<BR><BR>
 136   #   TRUE  - SMM Feature Control MSR will be locked.<BR>
 137   #   FALSE - SMM Feature Control MSR will not be locked.<BR>
 138   # @Prompt Lock SMM Feature Control MSR.
 139   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmFeatureControlMsrLock|TRUE|BOOLEAN|0x3213210B
 140
 141 [PcdsFixedAtBuild, PcdsPatchableInModule]
 142   ## This value is the CPU Local APIC base address, which aligns the address on a 4-KByte boundary.
 143   # @Prompt Configure base address of CPU Local APIC
 144   # @Expression  0x80000001 | (gUefiCpuPkgTokenSpaceGuid.PcdCpuLocalApicBaseAddress & 0xfff) == 0
 145   gUefiCpuPkgTokenSpaceGuid.PcdCpuLocalApicBaseAddress|0xfee00000|UINT32|0x00000001
 146
 147   ## Specifies delay value in microseconds after sending out an INIT IPI.
 148   # @Prompt Configure delay value after send an INIT IPI
 149   gUefiCpuPkgTokenSpaceGuid.PcdCpuInitIpiDelayInMicroSeconds|10000|UINT32|0x30000002
 150
 151   ## This value specifies the Application Processor (AP) stack size, used for Mp Service, which must
 152   ## aligns the address on a 4-KByte boundary.
 153   # @Prompt Configure stack size for Application Processor (AP)
 154   gUefiCpuPkgTokenSpaceGuid.PcdCpuApStackSize|0x8000|UINT32|0x00000003
 155
 156   ## Specifies stack size in the temporary RAM. 0 means half of TemporaryRamSize.
 157   # @Prompt Stack size in the temporary RAM.
 158   gUefiCpuPkgTokenSpaceGuid.PcdPeiTemporaryRamStackSize|0|UINT32|0x10001003
 159
 160   ## Specifies buffer size in bytes to save SMM profile data. The value should be a multiple of 4KB.
 161   # @Prompt SMM profile data buffer size.
 162   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileSize|0x200000|UINT32|0x32132107
 163
 164   ## Specifies stack size in bytes for each processor in SMM.
 165   # @Prompt Processor stack size in SMM.
 166   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStackSize|0x2000|UINT32|0x32132105
 167
 168   ## Indicates if SMM Code Access Check is enabled.
 169   #  If enabled, the SMM handler cannot execute the code outside SMM regions.
 170   #  This PCD is suggested to TRUE in production image.<BR><BR>
 171   #   TRUE  - SMM Code Access Check will be enabled.<BR>
 172   #   FALSE - SMM Code Access Check will be disabled.<BR>
 173   # @Prompt SMM Code Access Check.
 174   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmCodeAccessCheckEnable|TRUE|BOOLEAN|0x60000013
 175
 176   ## Specifies the number of variable MTRRs reserved for OS use. The default number of
 177   #  MTRRs reserved for OS use is 2.
 178   # @Prompt Number of reserved variable MTRRs.
 179   gUefiCpuPkgTokenSpaceGuid.PcdCpuNumberOfReservedVariableMtrrs|0x2|UINT32|0x00000015
 180
 181   ## Specifies buffer size in bytes for STM exception stack. The value should be a multiple of 4KB.
 182   # @Prompt STM exception stack size.
 183   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStmExceptionStackSize|0x1000|UINT32|0x32132111
 184
 185   ## Specifies buffer size in bytes of MSEG. The value should be a multiple of 4KB.
 186   # @Prompt MSEG size.
 187   gUefiCpuPkgTokenSpaceGuid.PcdCpuMsegSize|0x200000|UINT32|0x32132112
 188
 189   ## Specifies the supported CPU features bit in array.
 190   # @Prompt Supported CPU features.
 191   gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesSupport|{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}|VOID*|0x00000016
 192
 193   ## Specifies if CPU features will be initialized after SMM relocation.
 194   # @Prompt If CPU features will be initialized after SMM relocation.
 195   gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesInitAfterSmmRelocation|FALSE|BOOLEAN|0x0000001C
 196
 197   ## Specifies if CPU features will be initialized during S3 resume.
 198   # @Prompt If CPU features will be initialized during S3 resume.
 199   gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesInitOnS3Resume|FALSE|BOOLEAN|0x0000001D
 200
 201 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
 202   ## Specifies max supported number of Logical Processors.
 203   # @Prompt Configure max supported number of Logical Processors
 204   gUefiCpuPkgTokenSpaceGuid.PcdCpuMaxLogicalProcessorNumber|64|UINT32|0x00000002
 205   ## Specifies timeout value in microseconds for the BSP to detect all APs for the first time.
 206   # @Prompt Timeout for the BSP to detect all APs for the first time.
 207   gUefiCpuPkgTokenSpaceGuid.PcdCpuApInitTimeOutInMicroSeconds|50000|UINT32|0x00000004
 208   ## Specifies the base address of the first microcode Patch in the microcode Region.
 209   # @Prompt Microcode Region base address.
 210   gUefiCpuPkgTokenSpaceGuid.PcdCpuMicrocodePatchAddress|0x0|UINT64|0x00000005
 211   ## Specifies the size of the microcode Region.
 212   # @Prompt Microcode Region size.
 213   gUefiCpuPkgTokenSpaceGuid.PcdCpuMicrocodePatchRegionSize|0x0|UINT64|0x00000006
 214   ## Specifies the AP wait loop state during POST phase.
 215   #  The value is defined as below.<BR><BR>
 216   #  1: Place AP in the Hlt-Loop state.<BR>
 217   #  2: Place AP in the Mwait-Loop state.<BR>
 218   #  3: Place AP in the Run-Loop state.<BR>
 219   # @Prompt The AP wait loop state.
 220   # @ValidRange  0x80000001 | 1 - 3
 221   gUefiCpuPkgTokenSpaceGuid.PcdCpuApLoopMode|1|UINT8|0x60008006
 222   ## Specifies the AP target C-state for Mwait during POST phase.
 223   #  The default value 0 means C1 state.
 224   #  The value is defined as below.<BR><BR>
 225   # @Prompt The specified AP target C-state for Mwait.
 226   gUefiCpuPkgTokenSpaceGuid.PcdCpuApTargetCstate|0|UINT8|0x00000007
 227
 228   ## Indicates if SMM uses static page table.
 229   #  If enabled, SMM will not use on-demand paging. SMM will build static page table for all memory.
 230   #  This flag only impacts X64 build, because SMM always builds static page table for IA32.
 231   #  It could not be enabled at the same time with SMM profile feature (PcdCpuSmmProfileEnable).
 232   #  It could not be enabled also at the same time with heap guard feature for SMM
 233   #  (PcdHeapGuardPropertyMask in MdeModulePkg).<BR><BR>
 234   #   TRUE  - SMM uses static page table for all memory.<BR>
 235   #   FALSE - SMM uses static page table for below 4G memory and use on-demand paging for above 4G memory.<BR>
 236   # @Prompt Use static page table for all memory in SMM.
 237   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStaticPageTable|TRUE|BOOLEAN|0x3213210D
 238
 239   ## Specifies timeout value in microseconds for the BSP in SMM to wait for all APs to come into SMM.
 240   # @Prompt AP synchronization timeout value in SMM.
 241   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmApSyncTimeout|1000000|UINT64|0x32132104
 242
 243   ## Indicates the CPU synchronization method used when processing an SMI.
 244   #   0x00  - Traditional CPU synchronization method.<BR>
 245   #   0x01  - Relaxed CPU synchronization method.<BR>
 246   # @Prompt SMM CPU Synchronization Method.
 247   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmSyncMode|0x00|UINT8|0x60000014
 248
 249   ## Specifies user's desired settings for enabling/disabling processor features.
 250   # @Prompt User settings for enabling/disabling processor features.
 251   gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesUserConfiguration|{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}|VOID*|0x00000017
 252
 253   ## Specifies the On-demand clock modulation duty cycle when ACPI feature is enabled.
 254   # @Prompt The encoded values for target duty cycle modulation.
 255   # @ValidRange  0x80000001 | 0 - 15
 256   gUefiCpuPkgTokenSpaceGuid.PcdCpuClockModulationDutyCycle|0x0|UINT8|0x0000001A
 257
 258   ## Indicates if the current boot is a power-on reset.<BR><BR>
 259   #   TRUE  - Current boot is a power-on reset.<BR>
 260   #   FALSE - Current boot is not a power-on reset.<BR>
 261   # @Prompt Current boot is a power-on reset.
 262   gUefiCpuPkgTokenSpaceGuid.PcdIsPowerOnReset|FALSE|BOOLEAN|0x0000001B
 263
 264 [PcdsDynamic, PcdsDynamicEx]
 265   ## Contains the pointer to a CPU S3 data buffer of structure ACPI_CPU_DATA.
 266   # @Prompt The pointer to a CPU S3 data buffer.
 267   # @ValidList   0x80000001 | 0
 268   gUefiCpuPkgTokenSpaceGuid.PcdCpuS3DataAddress|0x0|UINT64|0x60000010
 269
 270   ## Contains the pointer to a CPU Hot Plug Data structure if CPU hot-plug is supported.
 271   # @Prompt The pointer to CPU Hot Plug Data.
 272   # @ValidList   0x80000001 | 0
 273   gUefiCpuPkgTokenSpaceGuid.PcdCpuHotPlugDataAddress|0x0|UINT64|0x60000011
 274
 275   ## Indicates processor feature capabilities, each bit corresponding to a specific feature.
 276   # @Prompt Processor feature capabilities.
 277   # @ValidList   0x80000001 | 0
 278   gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesCapability|{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}|VOID*|0x00000018
 279
 280   ## Specifies actual settings for processor features, each bit corresponding to a specific feature.
 281   # @Prompt Actual processor feature settings.
 282   # @ValidList   0x80000001 | 0
 283   gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesSetting|{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}|VOID*|0x00000019
 284
 285   ## Contains the size of memory required when CPU processor trace is enabled.<BR><BR>
 286   #  Processor trace is enabled through set BIT44(CPU_FEATURE_PROC_TRACE) in PcdCpuFeaturesSetting.<BR><BR>
 287   #  This PCD is ignored if CPU processor trace is disabled.<BR><BR>
 288   #  Default value is 0x00 which means 4KB of memory is allocated if CPU processor trace is enabled.<BR>
 289   #  0x0  -  4K.<BR>
 290   #  0x1  -  8K.<BR>
 291   #  0x2  -  16K.<BR>
 292   #  0x3  -  32K.<BR>
 293   #  0x4  -  64K.<BR>
 294   #  0x5  -  128K.<BR>
 295   #  0x6  -  256K.<BR>
 296   #  0x7  -  512K.<BR>
 297   #  0x8  -  1M.<BR>
 298   #  0x9  -  2M.<BR>
 299   #  0xA  -  4M.<BR>
 300   #  0xB  -  8M.<BR>
 301   #  0xC  -  16M.<BR>
 302   #  0xD  -  32M.<BR>
 303   #  0xE  -  64M.<BR>
 304   #  0xF  -  128M.<BR>
 305   # @Prompt The memory size used for processor trace if processor trace is enabled.
 306   # @ValidRange  0x80000001 | 0 - 0xF
 307   gUefiCpuPkgTokenSpaceGuid.PcdCpuProcTraceMemSize|0x0|UINT32|0x60000012
 308
 309   ## Contains the processor trace output scheme when CPU processor trace is enabled.<BR><BR>
 310   #  Processor trace is enabled through set BIT44(CPU_FEATURE_PROC_TRACE) in PcdCpuFeaturesSetting.<BR><BR>
 311   #  This PCD is ignored if CPU processor trace is disabled.<BR><BR>
 312   #  Default value is 0 which means single range output scheme will be used if CPU processor trace is enabled.<BR>
 313   #  0 - Single Range output scheme.<BR>
 314   #  1 - ToPA(Table of physical address) scheme.<BR>
 315   # @Prompt The processor trace output scheme used when processor trace is enabled.
 316   # @ValidRange  0x80000001 | 0 - 1
 317   gUefiCpuPkgTokenSpaceGuid.PcdCpuProcTraceOutputScheme|0x0|UINT8|0x60000015
 318
 319 [UserExtensions.TianoCore."ExtraFiles"]
 320   UefiCpuPkgExtra.uni