UefiCpuPkg: Add GUID gEdkiiCpuFeaturesSetDoneGuid
[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 ## Include/Guid/CpuFeaturesSetDone.h
69 gEdkiiCpuFeaturesSetDoneGuid = { 0xa82485ce, 0xad6b, 0x4101, { 0x99, 0xd3, 0xe1, 0x35, 0x8c, 0x9e, 0x7e, 0x37 }}
70
71 [Protocols]
72 ## Include/Protocol/SmmCpuService.h
73 gEfiSmmCpuServiceProtocolGuid = { 0x1d202cab, 0xc8ab, 0x4d5c, { 0x94, 0xf7, 0x3c, 0xfc, 0xc0, 0xd3, 0xd3, 0x35 }}
74
75 ## Include/Protocol/SmMonitorInit.h
76 gEfiSmMonitorInitProtocolGuid = { 0x228f344d, 0xb3de, 0x43bb, { 0xa4, 0xd7, 0xea, 0x20, 0xb, 0x1b, 0x14, 0x82 }}
77
78 #
79 # [Error.gUefiCpuPkgTokenSpaceGuid]
80 # 0x80000001 | Invalid value provided.
81 #
82
83 [PcdsFeatureFlag]
84 ## Indicates if SMM Profile will be enabled.
85 # If enabled, instruction executions in and data accesses to memory outside of SMRAM will be logged.
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, PcdsPatchableInModule]
140 ## This value is the CPU Local APIC base address, which aligns the address on a 4-KByte boundary.
141 # @Prompt Configure base address of CPU Local APIC
142 # @Expression 0x80000001 | (gUefiCpuPkgTokenSpaceGuid.PcdCpuLocalApicBaseAddress & 0xfff) == 0
143 gUefiCpuPkgTokenSpaceGuid.PcdCpuLocalApicBaseAddress|0xfee00000|UINT32|0x00000001
144
145 ## Specifies delay value in microseconds after sending out an INIT IPI.
146 # @Prompt Configure delay value after send an INIT IPI
147 gUefiCpuPkgTokenSpaceGuid.PcdCpuInitIpiDelayInMicroSeconds|10000|UINT32|0x30000002
148
149 ## This value specifies the Application Processor (AP) stack size, used for Mp Service, which must
150 ## aligns the address on a 4-KByte boundary.
151 # @Prompt Configure stack size for Application Processor (AP)
152 gUefiCpuPkgTokenSpaceGuid.PcdCpuApStackSize|0x8000|UINT32|0x00000003
153
154 ## Specifies stack size in the temporary RAM. 0 means half of TemporaryRamSize.
155 # @Prompt Stack size in the temporary RAM.
156 gUefiCpuPkgTokenSpaceGuid.PcdPeiTemporaryRamStackSize|0|UINT32|0x10001003
157
158 ## Specifies buffer size in bytes to save SMM profile data. The value should be a multiple of 4KB.
159 # @Prompt SMM profile data buffer size.
160 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileSize|0x200000|UINT32|0x32132107
161
162 ## Specifies stack size in bytes for each processor in SMM.
163 # @Prompt Processor stack size in SMM.
164 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStackSize|0x2000|UINT32|0x32132105
165
166 ## Indicates if SMM Code Access Check is enabled.
167 # If enabled, the SMM handler cannot execute the code outside SMM regions.
168 # This PCD is suggested to TRUE in production image.<BR><BR>
169 # TRUE - SMM Code Access Check will be enabled.<BR>
170 # FALSE - SMM Code Access Check will be disabled.<BR>
171 # @Prompt SMM Code Access Check.
172 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmCodeAccessCheckEnable|TRUE|BOOLEAN|0x60000013
173
174 ## Specifies the number of variable MTRRs reserved for OS use. The default number of
175 # MTRRs reserved for OS use is 2.
176 # @Prompt Number of reserved variable MTRRs.
177 gUefiCpuPkgTokenSpaceGuid.PcdCpuNumberOfReservedVariableMtrrs|0x2|UINT32|0x00000015
178
179 ## Specifies buffer size in bytes for STM exception stack. The value should be a multiple of 4KB.
180 # @Prompt STM exception stack size.
181 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStmExceptionStackSize|0x1000|UINT32|0x32132111
182
183 ## Specifies buffer size in bytes of MSEG. The value should be a multiple of 4KB.
184 # @Prompt MSEG size.
185 gUefiCpuPkgTokenSpaceGuid.PcdCpuMsegSize|0x200000|UINT32|0x32132112
186
187 ## Specifies the supported CPU features bit in array
188 # @Prompt Supported CPU features
189 gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesSupport|{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}|VOID*|0x00000016
190
191 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
192 ## Specifies max supported number of Logical Processors.
193 # @Prompt Configure max supported number of Logical Processors
194 gUefiCpuPkgTokenSpaceGuid.PcdCpuMaxLogicalProcessorNumber|64|UINT32|0x00000002
195 ## Specifies timeout value in microseconds for the BSP to detect all APs for the first time.
196 # @Prompt Timeout for the BSP to detect all APs for the first time.
197 gUefiCpuPkgTokenSpaceGuid.PcdCpuApInitTimeOutInMicroSeconds|50000|UINT32|0x00000004
198 ## Specifies the base address of the first microcode Patch in the microcode Region.
199 # @Prompt Microcode Region base address.
200 gUefiCpuPkgTokenSpaceGuid.PcdCpuMicrocodePatchAddress|0x0|UINT64|0x00000005
201 ## Specifies the size of the microcode Region.
202 # @Prompt Microcode Region size.
203 gUefiCpuPkgTokenSpaceGuid.PcdCpuMicrocodePatchRegionSize|0x0|UINT64|0x00000006
204 ## Specifies the AP wait loop state during POST phase.
205 # The value is defined as below.<BR><BR>
206 # 1: Place AP in the Hlt-Loop state.<BR>
207 # 2: Place AP in the Mwait-Loop state.<BR>
208 # 3: Place AP in the Run-Loop state.<BR>
209 # @Prompt The AP wait loop state.
210 # @ValidRange 0x80000001 | 1 - 3
211 gUefiCpuPkgTokenSpaceGuid.PcdCpuApLoopMode|1|UINT8|0x60008006
212 ## Specifies the AP target C-state for Mwait during POST phase.
213 # The default value 0 means C1 state.
214 # The value is defined as below.<BR><BR>
215 # @Prompt The specified AP target C-state for Mwait.
216 gUefiCpuPkgTokenSpaceGuid.PcdCpuApTargetCstate|0|UINT8|0x00000007
217
218 ## Indicates if SMM uses static page table.
219 # If enabled, SMM will not use on-demand paging. SMM will build static page table for all memory.<BR><BR>
220 # This flag only impacts X64 build, because SMM alway builds static page table for IA32.
221 # TRUE - SMM uses static page table for all memory.<BR>
222 # FALSE - SMM uses static page table for below 4G memory and use on-demand paging for above 4G memory.<BR>
223 # @Prompt Use static page table for all memory in SMM.
224 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStaticPageTable|TRUE|BOOLEAN|0x3213210D
225
226 ## Specifies timeout value in microseconds for the BSP in SMM to wait for all APs to come into SMM.
227 # @Prompt AP synchronization timeout value in SMM.
228 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmApSyncTimeout|1000000|UINT64|0x32132104
229
230 ## Indicates the CPU synchronization method used when processing an SMI.
231 # 0x00 - Traditional CPU synchronization method.<BR>
232 # 0x01 - Relaxed CPU synchronization method.<BR>
233 # @Prompt SMM CPU Synchronization Method.
234 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmSyncMode|0x00|UINT8|0x60000014
235
236 ## Specifies user's desired settings for enabling/disabling processor features.
237 # @Prompt User settings for enabling/disabling processor features.
238 gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesUserConfiguration|{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}|VOID*|0x00000017
239
240 [PcdsDynamic, PcdsDynamicEx]
241 ## Contains the pointer to a CPU S3 data buffer of structure ACPI_CPU_DATA.
242 # @Prompt The pointer to a CPU S3 data buffer.
243 # @ValidList 0x80000001 | 0
244 gUefiCpuPkgTokenSpaceGuid.PcdCpuS3DataAddress|0x0|UINT64|0x60000010
245
246 ## Contains the pointer to a CPU Hot Plug Data structure if CPU hot-plug is supported.
247 # @Prompt The pointer to CPU Hot Plug Data.
248 # @ValidList 0x80000001 | 0
249 gUefiCpuPkgTokenSpaceGuid.PcdCpuHotPlugDataAddress|0x0|UINT64|0x60000011
250
251 ## Indicates processor feature capabilities, each bit corresponding to a specific feature.
252 # @Prompt Processor feature capabilities.
253 # @ValidList 0x80000001 | 0
254 gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesCapability|{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}|VOID*|0x00000018
255
256 ## Specifies actual settings for processor features, each bit corresponding to a specific feature.
257 # @Prompt Actual processor feature settings.
258 # @ValidList 0x80000001 | 0
259 gUefiCpuPkgTokenSpaceGuid.PcdCpuFeaturesSetting|{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}|VOID*|0x00000019
260
261 [UserExtensions.TianoCore."ExtraFiles"]
262 UefiCpuPkgExtra.uni