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