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