UefiCpuPkg/UefiCpuPkg.dec: Add a set of CPU features 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 - 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.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 ## @libraryclass Provides functions to support MP services on CpuMpPei and CpuDxe module.
54 ##
55 MpInitLib|Include/Library/MpInitLib.h
56
57 ## @libraryclass Provides services to access Microcode region on flash device.
58 #
59 MicrocodeFlashAccessLib|Include/Library/MicrocodeFlashAccessLib.h
60
61 [Guids]
62 gUefiCpuPkgTokenSpaceGuid = { 0xac05bf33, 0x995a, 0x4ed4, { 0xaa, 0xb8, 0xef, 0x7a, 0xe8, 0xf, 0x5c, 0xb0 }}
63 gMsegSmramGuid = { 0x5802bce4, 0xeeee, 0x4e33, { 0xa1, 0x30, 0xeb, 0xad, 0x27, 0xf0, 0xe4, 0x39 }}
64
65 ## Include/Guid/MicrocodeFmp.h
66 gMicrocodeFmpImageTypeIdGuid = { 0x96d4fdcd, 0x1502, 0x424d, { 0x9d, 0x4c, 0x9b, 0x12, 0xd2, 0xdc, 0xae, 0x5c } }
67
68 [Protocols]
69 ## Include/Protocol/SmmCpuService.h
70 gEfiSmmCpuServiceProtocolGuid = { 0x1d202cab, 0xc8ab, 0x4d5c, { 0x94, 0xf7, 0x3c, 0xfc, 0xc0, 0xd3, 0xd3, 0x35 }}
71
72 ## Include/Protocol/SmMonitorInit.h
73 gEfiSmMonitorInitProtocolGuid = { 0x228f344d, 0xb3de, 0x43bb, { 0xa4, 0xd7, 0xea, 0x20, 0xb, 0x1b, 0x14, 0x82 }}
74
75 #
76 # [Error.gUefiCpuPkgTokenSpaceGuid]
77 # 0x80000001 | Invalid value provided.
78 #
79
80 [PcdsFeatureFlag]
81 ## Indicates if SMM Profile will be enabled.
82 # If enabled, instruction executions in and data accesses to memory outside of SMRAM will be logged.
83 # This PCD is only for validation purpose. It should be set to false in production.<BR><BR>
84 # TRUE - SMM Profile will be enabled.<BR>
85 # FALSE - SMM Profile will be disabled.<BR>
86 # @Prompt Enable SMM Profile.
87 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileEnable|FALSE|BOOLEAN|0x32132109
88
89 ## Indicates if the SMM profile log buffer is a ring buffer.
90 # If disabled, no additional log can be done when the buffer is full.<BR><BR>
91 # TRUE - the SMM profile log buffer is a ring buffer.<BR>
92 # FALSE - the SMM profile log buffer is a normal buffer.<BR>
93 # @Prompt The SMM profile log buffer is a ring buffer.
94 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileRingBuffer|FALSE|BOOLEAN|0x3213210a
95
96 ## Indicates if SMM Startup AP in a blocking fashion.
97 # TRUE - SMM Startup AP in a blocking fashion.<BR>
98 # FALSE - SMM Startup AP in a non-blocking fashion.<BR>
99 # @Prompt SMM Startup AP in a blocking fashion.
100 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmBlockStartupThisAp|FALSE|BOOLEAN|0x32132108
101
102 ## Indicates if SMM Stack Guard will be enabled.
103 # If enabled, stack overflow in SMM can be caught, preventing chaotic consequences.<BR><BR>
104 # TRUE - SMM Stack Guard will be enabled.<BR>
105 # FALSE - SMM Stack Guard will be disabled.<BR>
106 # @Prompt Enable SMM Stack Guard.
107 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStackGuard|TRUE|BOOLEAN|0x1000001C
108
109 ## Indicates if BSP election in SMM will be enabled.
110 # If enabled, a BSP will be dynamically elected among all processors in each SMI.
111 # Otherwise, processor 0 is always as BSP in each SMI.<BR><BR>
112 # TRUE - BSP election in SMM will be enabled.<BR>
113 # FALSE - BSP election in SMM will be disabled.<BR>
114 # @Prompt Enable BSP election in SMM.
115 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmEnableBspElection|TRUE|BOOLEAN|0x32132106
116
117 ## Indicates if CPU SMM hot-plug will be enabled.<BR><BR>
118 # TRUE - SMM CPU hot-plug will be enabled.<BR>
119 # FALSE - SMM CPU hot-plug will be disabled.<BR>
120 # @Prompt SMM CPU hot-plug.
121 gUefiCpuPkgTokenSpaceGuid.PcdCpuHotPlugSupport|FALSE|BOOLEAN|0x3213210C
122
123 ## Indicates if SMM Debug will be enabled.
124 # If enabled, hardware breakpoints in SMRAM can be set outside of SMM mode and take effect in SMM.<BR><BR>
125 # TRUE - SMM Debug will be enabled.<BR>
126 # FALSE - SMM Debug will be disabled.<BR>
127 # @Prompt Enable SMM Debug.
128 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmDebug|FALSE|BOOLEAN|0x1000001B
129
130 ## Indicates if lock SMM Feature Control MSR.<BR><BR>
131 # TRUE - SMM Feature Control MSR will be locked.<BR>
132 # FALSE - SMM Feature Control MSR will not be locked.<BR>
133 # @Prompt Lock SMM Feature Control MSR.
134 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmFeatureControlMsrLock|TRUE|BOOLEAN|0x3213210B
135
136 [PcdsFixedAtBuild, PcdsPatchableInModule]
137 ## This value is the CPU Local APIC base address, which aligns the address on a 4-KByte boundary.
138 # @Prompt Configure base address of CPU Local APIC
139 # @Expression 0x80000001 | (gUefiCpuPkgTokenSpaceGuid.PcdCpuLocalApicBaseAddress & 0xfff) == 0
140 gUefiCpuPkgTokenSpaceGuid.PcdCpuLocalApicBaseAddress|0xfee00000|UINT32|0x00000001
141
142 ## Specifies delay value in microseconds after sending out an INIT IPI.
143 # @Prompt Configure delay value after send an INIT IPI
144 gUefiCpuPkgTokenSpaceGuid.PcdCpuInitIpiDelayInMicroSeconds|10000|UINT32|0x30000002
145
146 ## This value specifies the Application Processor (AP) stack size, used for Mp Service, which must
147 ## aligns the address on a 4-KByte boundary.
148 # @Prompt Configure stack size for Application Processor (AP)
149 gUefiCpuPkgTokenSpaceGuid.PcdCpuApStackSize|0x8000|UINT32|0x00000003
150
151 ## Specifies stack size in the temporary RAM. 0 means half of TemporaryRamSize.
152 # @Prompt Stack size in the temporary RAM.
153 gUefiCpuPkgTokenSpaceGuid.PcdPeiTemporaryRamStackSize|0|UINT32|0x10001003
154
155 ## Specifies buffer size in bytes to save SMM profile data. The value should be a multiple of 4KB.
156 # @Prompt SMM profile data buffer size.
157 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileSize|0x200000|UINT32|0x32132107
158
159 ## Specifies stack size in bytes for each processor in SMM.
160 # @Prompt Processor stack size in SMM.
161 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStackSize|0x2000|UINT32|0x32132105
162
163 ## Indicates if SMM Code Access Check is enabled.
164 # If enabled, the SMM handler cannot execute the code outside SMM regions.
165 # This PCD is suggested to TRUE in production image.<BR><BR>
166 # TRUE - SMM Code Access Check will be enabled.<BR>
167 # FALSE - SMM Code Access Check will be disabled.<BR>
168 # @Prompt SMM Code Access Check.
169 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmCodeAccessCheckEnable|TRUE|BOOLEAN|0x60000013
170
171 ## Specifies the number of variable MTRRs reserved for OS use. The default number of
172 # MTRRs reserved for OS use is 2.
173 # @Prompt Number of reserved variable MTRRs.
174 gUefiCpuPkgTokenSpaceGuid.PcdCpuNumberOfReservedVariableMtrrs|0x2|UINT32|0x00000015
175
176 ## Specifies buffer size in bytes for STM exception stack. The value should be a multiple of 4KB.
177 # @Prompt STM exception stack size.
178 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStmExceptionStackSize|0x1000|UINT32|0x32132111
179
180 ## Specifies buffer size in bytes of MSEG. The value should be a multiple of 4KB.
181 # @Prompt MSEG size.
182 gUefiCpuPkgTokenSpaceGuid.PcdCpuMsegSize|0x200000|UINT32|0x32132112
183
184 ## Specifies the supported CPU features bit in array
185 # @Prompt Supported CPU features
186 gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesSupport|{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}|VOID*|0x00000016
187
188 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
189 ## Specifies max supported number of Logical Processors.
190 # @Prompt Configure max supported number of Logical Processors
191 gUefiCpuPkgTokenSpaceGuid.PcdCpuMaxLogicalProcessorNumber|64|UINT32|0x00000002
192 ## Specifies timeout value in microseconds for the BSP to detect all APs for the first time.
193 # @Prompt Timeout for the BSP to detect all APs for the first time.
194 gUefiCpuPkgTokenSpaceGuid.PcdCpuApInitTimeOutInMicroSeconds|50000|UINT32|0x00000004
195 ## Specifies the base address of the first microcode Patch in the microcode Region.
196 # @Prompt Microcode Region base address.
197 gUefiCpuPkgTokenSpaceGuid.PcdCpuMicrocodePatchAddress|0x0|UINT64|0x00000005
198 ## Specifies the size of the microcode Region.
199 # @Prompt Microcode Region size.
200 gUefiCpuPkgTokenSpaceGuid.PcdCpuMicrocodePatchRegionSize|0x0|UINT64|0x00000006
201 ## Specifies the AP wait loop state during POST phase.
202 # The value is defined as below.<BR><BR>
203 # 1: Place AP in the Hlt-Loop state.<BR>
204 # 2: Place AP in the Mwait-Loop state.<BR>
205 # 3: Place AP in the Run-Loop state.<BR>
206 # @Prompt The AP wait loop state.
207 # @ValidRange 0x80000001 | 1 - 3
208 gUefiCpuPkgTokenSpaceGuid.PcdCpuApLoopMode|1|UINT8|0x60008006
209 ## Specifies the AP target C-state for Mwait during POST phase.
210 # The default value 0 means C1 state.
211 # The value is defined as below.<BR><BR>
212 # @Prompt The specified AP target C-state for Mwait.
213 gUefiCpuPkgTokenSpaceGuid.PcdCpuApTargetCstate|0|UINT8|0x00000007
214
215 ## Indicates if SMM uses static page table.
216 # If enabled, SMM will not use on-demand paging. SMM will build static page table for all memory.<BR><BR>
217 # This flag only impacts X64 build, because SMM alway builds static page table for IA32.
218 # TRUE - SMM uses static page table for all memory.<BR>
219 # FALSE - SMM uses static page table for below 4G memory and use on-demand paging for above 4G memory.<BR>
220 # @Prompt Use static page table for all memory in SMM.
221 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStaticPageTable|TRUE|BOOLEAN|0x3213210D
222
223 ## Specifies timeout value in microseconds for the BSP in SMM to wait for all APs to come into SMM.
224 # @Prompt AP synchronization timeout value in SMM.
225 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmApSyncTimeout|1000000|UINT64|0x32132104
226
227 ## Indicates the CPU synchronization method used when processing an SMI.
228 # 0x00 - Traditional CPU synchronization method.<BR>
229 # 0x01 - Relaxed CPU synchronization method.<BR>
230 # @Prompt SMM CPU Synchronization Method.
231 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmSyncMode|0x00|UINT8|0x60000014
232
233 ## Specifies user's desired settings for enabling/disabling processor features.
234 # @Prompt User settings for enabling/disabling processor features.
235 gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesUserConfiguration|{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}|VOID*|0x00000017
236
237 [PcdsDynamic, PcdsDynamicEx]
238 ## Contains the pointer to a CPU S3 data buffer of structure ACPI_CPU_DATA.
239 # @Prompt The pointer to a CPU S3 data buffer.
240 # @ValidList 0x80000001 | 0
241 gUefiCpuPkgTokenSpaceGuid.PcdCpuS3DataAddress|0x0|UINT64|0x60000010
242
243 ## Contains the pointer to a CPU Hot Plug Data structure if CPU hot-plug is supported.
244 # @Prompt The pointer to CPU Hot Plug Data.
245 # @ValidList 0x80000001 | 0
246 gUefiCpuPkgTokenSpaceGuid.PcdCpuHotPlugDataAddress|0x0|UINT64|0x60000011
247
248 ## Indicates processor feature capabilities, each bit corresponding to a specific feature.
249 # @Prompt Processor feature capabilities.
250 # @ValidList 0x80000001 | 0
251 gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesCapability|{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}|VOID*|0x00000018
252
253 ## Specifies actual settings for processor features, each bit corresponding to a specific feature.
254 # @Prompt Actual processor feature settings.
255 # @ValidList 0x80000001 | 0
256 gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesSetting|{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}|VOID*|0x00000019
257
258 [UserExtensions.TianoCore."ExtraFiles"]
259 UefiCpuPkgExtra.uni