UefiCpuPkg/UefiCpuPkg.dec

   1 ## @file  UefiCpuPkg.dec
   2 # This Package provides UEFI compatible CPU modules and libraries.
   3 #
   4 # Copyright (c) 2007 - 2016, 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.3
  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 [LibraryClasses.IA32, LibraryClasses.X64]
  33   ##  @libraryclass  Provides functions to manage MTRR settings on IA32 and X64 CPUs.
  34   ##
  35   MtrrLib|Include/Library/MtrrLib.h
  36
  37   ##  @libraryclass  Provides functions to manage the Local APIC on IA32 and X64 CPUs.
  38   ##
  39   LocalApicLib|Include/Library/LocalApicLib.h
  40
  41   ##  @libraryclass  Provides platform specific initialization functions in the SEC phase.
  42   ##
  43   PlatformSecLib|Include/Library/PlatformSecLib.h
  44
  45   ##  @libraryclass  Public include file for the SMM CPU Platform Hook Library.
  46   ##
  47   SmmCpuPlatformHookLib|Include/Library/SmmCpuPlatformHookLib.h
  48
  49   ##  @libraryclass  Provides the CPU specific programming for PiSmmCpuDxeSmm module.
  50   ##
  51   SmmCpuFeaturesLib|Include/Library/SmmCpuFeaturesLib.h
  52
  53 [Guids]
  54   gUefiCpuPkgTokenSpaceGuid      = { 0xac05bf33, 0x995a, 0x4ed4, { 0xaa, 0xb8, 0xef, 0x7a, 0xe8, 0xf, 0x5c, 0xb0 }}
  55
  56 [Protocols]
  57   ## Include/Protocol/SmmCpuService.h
  58   gEfiSmmCpuServiceProtocolGuid  = { 0x1d202cab, 0xc8ab, 0x4d5c, { 0x94, 0xf7, 0x3c, 0xfc, 0xc0, 0xd3, 0xd3, 0x35 }}
  59
  60 #
  61 # [Error.gUefiCpuPkgTokenSpaceGuid]
  62 #   0x80000001 | Invalid value provided.
  63 #
  64
  65 [PcdsFeatureFlag]
  66   ## Indicates if SMM Profile will be enabled.
  67   #  If enabled, instruction executions in and data accesses to memory outside of SMRAM will be logged.
  68   #  This PCD is only for validation purpose. It should be set to false in production.<BR><BR>
  69   #   TRUE  - SMM Profile will be enabled.<BR>
  70   #   FALSE - SMM Profile will be disabled.<BR>
  71   # @Prompt Enable SMM Profile.
  72   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileEnable|FALSE|BOOLEAN|0x32132109
  73
  74   ## Indicates if the SMM profile log buffer is a ring buffer.
  75   #  If disabled, no additional log can be done when the buffer is full.<BR><BR>
  76   #   TRUE  - the SMM profile log buffer is a ring buffer.<BR>
  77   #   FALSE - the SMM profile log buffer is a normal buffer.<BR>
  78   # @Prompt The SMM profile log buffer is a ring buffer.
  79   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileRingBuffer|FALSE|BOOLEAN|0x3213210a
  80
  81   ## Indicates if SMM Startup AP in a blocking fashion.
  82   #   TRUE  - SMM Startup AP in a blocking fashion.<BR>
  83   #   FALSE - SMM Startup AP in a non-blocking fashion.<BR>
  84   # @Prompt SMM Startup AP in a blocking fashion.
  85   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmBlockStartupThisAp|FALSE|BOOLEAN|0x32132108
  86
  87   ## Indicates if SMM Stack Guard will be enabled.
  88   #  If enabled, stack overflow in SMM can be caught which eases debugging.<BR><BR>
  89   #   TRUE  - SMM Stack Guard will be enabled.<BR>
  90   #   FALSE - SMM Stack Guard will be disabled.<BR>
  91   # @Prompt Enable SMM Stack Guard.
  92   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStackGuard|FALSE|BOOLEAN|0x1000001C
  93
  94   ## Indicates if BSP election in SMM will be enabled.
  95   #  If enabled, a BSP will be dynamically elected among all processors in each SMI.
  96   #  Otherwise, processor 0 is always as BSP in each SMI.<BR><BR>
  97   #   TRUE  - BSP election in SMM will be enabled.<BR>
  98   #   FALSE - BSP election in SMM will be disabled.<BR>
  99   # @Prompt Enable BSP election in SMM.
 100   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmEnableBspElection|TRUE|BOOLEAN|0x32132106
 101
 102   ## Indicates if CPU SMM hot-plug will be enabled.<BR><BR>
 103   #   TRUE  - SMM CPU hot-plug will be enabled.<BR>
 104   #   FALSE - SMM CPU hot-plug will be disabled.<BR>
 105   # @Prompt SMM CPU hot-plug.
 106   gUefiCpuPkgTokenSpaceGuid.PcdCpuHotPlugSupport|FALSE|BOOLEAN|0x3213210C
 107
 108   ## Indicates if SMM Debug will be enabled.
 109   #  If enabled, hardware breakpoints in SMRAM can be set outside of SMM mode and take effect in SMM.<BR><BR>
 110   #   TRUE  - SMM Debug will be enabled.<BR>
 111   #   FALSE - SMM Debug will be disabled.<BR>
 112   # @Prompt Enable SMM Debug.
 113   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmDebug|FALSE|BOOLEAN|0x1000001B
 114
 115   ## Indicates if lock SMM Feature Control MSR.<BR><BR>
 116   #   TRUE  - SMM Feature Control MSR will be locked.<BR>
 117   #   FALSE - SMM Feature Control MSR will not be locked.<BR>
 118   # @Prompt Lock SMM Feature Control MSR.
 119   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmFeatureControlMsrLock|TRUE|BOOLEAN|0x3213210B
 120
 121 [PcdsFixedAtBuild, PcdsPatchableInModule]
 122   ## This value is the CPU Local APIC base address, which aligns the address on a 4-KByte boundary.
 123   # @Prompt Configure base address of CPU Local APIC
 124   # @Expression  0x80000001 | (gUefiCpuPkgTokenSpaceGuid.PcdCpuLocalApicBaseAddress & 0xfff) == 0
 125   gUefiCpuPkgTokenSpaceGuid.PcdCpuLocalApicBaseAddress|0xfee00000|UINT32|0x00000001
 126
 127   ## Specifies delay value in microseconds after sending out an INIT IPI.
 128   # @Prompt Configure delay value after send an INIT IPI
 129   gUefiCpuPkgTokenSpaceGuid.PcdCpuInitIpiDelayInMicroSeconds|10000|UINT32|0x30000002
 130
 131   ## This value specifies the Application Processor (AP) stack size, used for Mp Service, which must
 132   ## aligns the address on a 4-KByte boundary.
 133   # @Prompt Configure stack size for Application Processor (AP)
 134   gUefiCpuPkgTokenSpaceGuid.PcdCpuApStackSize|0x8000|UINT32|0x00000003
 135
 136   ## Specifies stack size in the temporary RAM. 0 means half of TemporaryRamSize.
 137   # @Prompt Stack size in the temporary RAM.
 138   gUefiCpuPkgTokenSpaceGuid.PcdPeiTemporaryRamStackSize|0|UINT32|0x10001003
 139
 140   ## Specifies buffer size in bytes to save SMM profile data. The value should be a multiple of 4KB.
 141   # @Prompt SMM profile data buffer size.
 142   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileSize|0x200000|UINT32|0x32132107
 143
 144   ## Specifies stack size in bytes for each processor in SMM.
 145   # @Prompt Processor stack size in SMM.
 146   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStackSize|0x2000|UINT32|0x32132105
 147
 148   ## Specifies timeout value in microseconds for the BSP in SMM to wait for all APs to come into SMM.
 149   # @Prompt AP synchronization timeout value in SMM.
 150   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmApSyncTimeout|1000000|UINT64|0x32132104
 151
 152   ## Indicates if SMM Code Access Check is enabled.
 153   #  If enabled, the SMM handler cannot execute the code outside SMM regions.
 154   #  This PCD is suggested to TRUE in production image.<BR><BR>
 155   #   TRUE  - SMM Code Access Check will be enabled.<BR>
 156   #   FALSE - SMM Code Access Check will be disabled.<BR>
 157   # @Prompt SMM Code Access Check.
 158   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmCodeAccessCheckEnable|TRUE|BOOLEAN|0x60000013
 159
 160   ## Indicates the CPU synchronization method used when processing an SMI.
 161   #   0x00  - Traditional CPU synchronization method.<BR>
 162   #   0x01  - Relaxed CPU synchronization method.<BR>
 163   # @Prompt SMM CPU Synchronization Method.
 164   gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmSyncMode|0x00|UINT8|0x60000014
 165
 166   ## Specifies the number of variable MTRRs reserved for OS use. The default number of
 167   #  MTRRs reserved for OS use is 2.
 168   # @Prompt Number of reserved variable MTRRs.
 169   gUefiCpuPkgTokenSpaceGuid.PcdCpuNumberOfReservedVariableMtrrs|0x2|UINT32|0x00000015
 170
 171 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
 172   ## Specifies max supported number of Logical Processors.
 173   # @Prompt Configure max supported number of Logical Processors
 174   gUefiCpuPkgTokenSpaceGuid.PcdCpuMaxLogicalProcessorNumber|64|UINT32|0x00000002
 175   ## Specifies timeout value in microseconds for the BSP to detect all APs for the first time.
 176   # @Prompt Timeout for the BSP to detect all APs for the first time.
 177   gUefiCpuPkgTokenSpaceGuid.PcdCpuApInitTimeOutInMicroSeconds|50000|UINT32|0x00000004
 178   ## Specifies the base address of the first microcode Patch in the microcode Region.
 179   # @Prompt Microcode Region base address.
 180   gUefiCpuPkgTokenSpaceGuid.PcdCpuMicrocodePatchAddress|0x0|UINT64|0x00000005
 181   ## Specifies the size of the microcode Region.
 182   # @Prompt Microcode Region size.
 183   gUefiCpuPkgTokenSpaceGuid.PcdCpuMicrocodePatchRegionSize|0x0|UINT64|0x00000006
 184   ## Specifies the AP wait loop state during POST phase.
 185   #  The value is defined as below.<BR><BR>
 186   #  1: Place AP in the Hlt-Loop state.<BR>
 187   #  2: Place AP in the Mwait-Loop state.<BR>
 188   #  3: Place AP in the Run-Loop state.<BR>
 189   # @Prompt The AP wait loop state.
 190   # @ValidRange  0x80000001 | 1 - 3
 191   gUefiCpuPkgTokenSpaceGuid.PcdCpuApLoopMode|1|UINT8|0x60008006
 192   ## Specifies the AP target C-state for Mwait during POST phase.
 193   #  The default value 0 means C1 state.
 194   #  The value is defined as below.<BR><BR>
 195   # @Prompt The specified AP target C-state for Mwait.
 196   gUefiCpuPkgTokenSpaceGuid.PcdCpuApTargetCstate|0|UINT8|0x00000007
 197
 198 [PcdsDynamic, PcdsDynamicEx]
 199   ## Contains the pointer to a CPU S3 data buffer of structure ACPI_CPU_DATA.
 200   # @Prompt The pointer to a CPU S3 data buffer.
 201   # @ValidList   0x80000001 | 0
 202   gUefiCpuPkgTokenSpaceGuid.PcdCpuS3DataAddress|0x0|UINT64|0x60000010
 203
 204   ## Contains the pointer to a CPU Hot Plug Data structure if CPU hot-plug is supported.
 205   # @Prompt The pointer to CPU Hot Plug Data.
 206   # @ValidList   0x80000001 | 0
 207   gUefiCpuPkgTokenSpaceGuid.PcdCpuHotPlugDataAddress|0x0|UINT64|0x60000011
 208
 209 [UserExtensions.TianoCore."ExtraFiles"]
 210   UefiCpuPkgExtra.uni