UefiCpuPkg/Msr: Add CPUID signature check MACROs
[mirror_edk2.git] / UefiCpuPkg / UefiCpuPkg.dec
CommitLineData
7798fb83 1## @file UefiCpuPkg.dec\r
7798fb83
HT
2# This Package provides UEFI compatible CPU modules and libraries.\r
3#\r
b1e01bd4 4# Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>\r
7798fb83
HT
5#\r
6# This program and the accompanying materials are licensed and made available under\r
7# the terms and conditions of the BSD License which accompanies this distribution.\r
8# The full text of the license may be found at\r
9# http://opensource.org/licenses/bsd-license.php\r
10#\r
11# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13#\r
14##\r
15\r
16[Defines]\r
17 DEC_SPECIFICATION = 0x00010005\r
18 PACKAGE_NAME = UefiCpuPkg\r
abae030a 19 PACKAGE_UNI_FILE = UefiCpuPkg.uni\r
7798fb83
HT
20 PACKAGE_GUID = 2171df9b-0d39-45aa-ac37-2de190010d23\r
21 PACKAGE_VERSION = 0.3\r
22\r
23[Includes]\r
24 Include\r
25\r
26[LibraryClasses]\r
27 ## @libraryclass Defines some routines that are generic for IA32 family CPU\r
28 ## to be UEFI specification compliant.\r
29 ##\r
30 UefiCpuLib|Include/Library/UefiCpuLib.h\r
31\r
32[LibraryClasses.IA32, LibraryClasses.X64]\r
33 ## @libraryclass Provides functions to manage MTRR settings on IA32 and X64 CPUs.\r
34 ##\r
35 MtrrLib|Include/Library/MtrrLib.h\r
36\r
37 ## @libraryclass Provides functions to manage the Local APIC on IA32 and X64 CPUs.\r
38 ##\r
39 LocalApicLib|Include/Library/LocalApicLib.h\r
d947a4cc
MK
40\r
41 ## @libraryclass Provides platform specific initialization functions in the SEC phase.\r
42 ##\r
43 PlatformSecLib|Include/Library/PlatformSecLib.h\r
529a5a86 44\r
406c7200
MK
45 ## @libraryclass Public include file for the SMM CPU Platform Hook Library.\r
46 ##\r
47 SmmCpuPlatformHookLib|Include/Library/SmmCpuPlatformHookLib.h\r
529a5a86 48\r
406c7200
MK
49 ## @libraryclass Provides the CPU specific programming for PiSmmCpuDxeSmm module.\r
50 ##\r
51 SmmCpuFeaturesLib|Include/Library/SmmCpuFeaturesLib.h\r
52\r
87896d03
JF
53 ## @libraryclass Provides functions to support MP services on CpuMpPei and CpuDxe module.\r
54 ##\r
55 MpInitLib|Include/Library/MpInitLib.h\r
56\r
90c45da4
JY
57 ## @libraryclass Provides services to access Microcode region on flash device.\r
58 #\r
59 MicrocodeFlashAccessLib|Include/Library/MicrocodeFlashAccessLib.h\r
60\r
7798fb83
HT
61[Guids]\r
62 gUefiCpuPkgTokenSpaceGuid = { 0xac05bf33, 0x995a, 0x4ed4, { 0xaa, 0xb8, 0xef, 0x7a, 0xe8, 0xf, 0x5c, 0xb0 }}\r
f7c11c53 63 gMsegSmramGuid = { 0x5802bce4, 0xeeee, 0x4e33, { 0xa1, 0x30, 0xeb, 0xad, 0x27, 0xf0, 0xe4, 0x39 }}\r
7798fb83 64\r
90c45da4
JY
65 ## Include/Guid/MicrocodeFmp.h\r
66 gMicrocodeFmpImageTypeIdGuid = { 0x96d4fdcd, 0x1502, 0x424d, { 0x9d, 0x4c, 0x9b, 0x12, 0xd2, 0xdc, 0xae, 0x5c } }\r
67\r
406c7200
MK
68[Protocols]\r
69 ## Include/Protocol/SmmCpuService.h\r
70 gEfiSmmCpuServiceProtocolGuid = { 0x1d202cab, 0xc8ab, 0x4d5c, { 0x94, 0xf7, 0x3c, 0xfc, 0xc0, 0xd3, 0xd3, 0x35 }}\r
529a5a86 71\r
f7c11c53
MK
72 ## Include/Protocol/SmMonitorInit.h\r
73 gEfiSmMonitorInitProtocolGuid = { 0x228f344d, 0xb3de, 0x43bb, { 0xa4, 0xd7, 0xea, 0x20, 0xb, 0x1b, 0x14, 0x82 }}\r
74\r
abae030a
LG
75#\r
76# [Error.gUefiCpuPkgTokenSpaceGuid]\r
77# 0x80000001 | Invalid value provided.\r
78#\r
79\r
529a5a86
MK
80[PcdsFeatureFlag]\r
81 ## Indicates if SMM Profile will be enabled.\r
82 # If enabled, instruction executions in and data accesses to memory outside of SMRAM will be logged.\r
83 # This PCD is only for validation purpose. It should be set to false in production.<BR><BR>\r
84 # TRUE - SMM Profile will be enabled.<BR>\r
85 # FALSE - SMM Profile will be disabled.<BR>\r
86 # @Prompt Enable SMM Profile.\r
87 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileEnable|FALSE|BOOLEAN|0x32132109\r
88\r
89 ## Indicates if the SMM profile log buffer is a ring buffer.\r
90 # If disabled, no additional log can be done when the buffer is full.<BR><BR>\r
91 # TRUE - the SMM profile log buffer is a ring buffer.<BR>\r
92 # FALSE - the SMM profile log buffer is a normal buffer.<BR>\r
93 # @Prompt The SMM profile log buffer is a ring buffer.\r
94 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileRingBuffer|FALSE|BOOLEAN|0x3213210a\r
95\r
96 ## Indicates if SMM Startup AP in a blocking fashion.\r
97 # TRUE - SMM Startup AP in a blocking fashion.<BR>\r
98 # FALSE - SMM Startup AP in a non-blocking fashion.<BR>\r
99 # @Prompt SMM Startup AP in a blocking fashion.\r
100 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmBlockStartupThisAp|FALSE|BOOLEAN|0x32132108\r
101\r
102 ## Indicates if SMM Stack Guard will be enabled.\r
509f8425 103 # If enabled, stack overflow in SMM can be caught, preventing chaotic consequences.<BR><BR>\r
529a5a86
MK
104 # TRUE - SMM Stack Guard will be enabled.<BR>\r
105 # FALSE - SMM Stack Guard will be disabled.<BR>\r
106 # @Prompt Enable SMM Stack Guard.\r
509f8425 107 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStackGuard|TRUE|BOOLEAN|0x1000001C\r
529a5a86
MK
108\r
109 ## Indicates if BSP election in SMM will be enabled.\r
110 # If enabled, a BSP will be dynamically elected among all processors in each SMI.\r
111 # Otherwise, processor 0 is always as BSP in each SMI.<BR><BR>\r
112 # TRUE - BSP election in SMM will be enabled.<BR>\r
113 # FALSE - BSP election in SMM will be disabled.<BR>\r
114 # @Prompt Enable BSP election in SMM.\r
115 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmEnableBspElection|TRUE|BOOLEAN|0x32132106\r
116\r
117 ## Indicates if CPU SMM hot-plug will be enabled.<BR><BR>\r
118 # TRUE - SMM CPU hot-plug will be enabled.<BR>\r
119 # FALSE - SMM CPU hot-plug will be disabled.<BR>\r
120 # @Prompt SMM CPU hot-plug.\r
121 gUefiCpuPkgTokenSpaceGuid.PcdCpuHotPlugSupport|FALSE|BOOLEAN|0x3213210C\r
122\r
123 ## Indicates if SMM Debug will be enabled.\r
124 # If enabled, hardware breakpoints in SMRAM can be set outside of SMM mode and take effect in SMM.<BR><BR>\r
125 # TRUE - SMM Debug will be enabled.<BR>\r
126 # FALSE - SMM Debug will be disabled.<BR>\r
127 # @Prompt Enable SMM Debug.\r
128 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmDebug|FALSE|BOOLEAN|0x1000001B\r
129\r
130 ## Indicates if lock SMM Feature Control MSR.<BR><BR>\r
131 # TRUE - SMM Feature Control MSR will be locked.<BR>\r
132 # FALSE - SMM Feature Control MSR will not be locked.<BR>\r
133 # @Prompt Lock SMM Feature Control MSR.\r
134 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmFeatureControlMsrLock|TRUE|BOOLEAN|0x3213210B\r
135\r
7798fb83 136[PcdsFixedAtBuild, PcdsPatchableInModule]\r
529a5a86
MK
137 ## This value is the CPU Local APIC base address, which aligns the address on a 4-KByte boundary.\r
138 # @Prompt Configure base address of CPU Local APIC\r
abae030a 139 # @Expression 0x80000001 | (gUefiCpuPkgTokenSpaceGuid.PcdCpuLocalApicBaseAddress & 0xfff) == 0\r
7798fb83 140 gUefiCpuPkgTokenSpaceGuid.PcdCpuLocalApicBaseAddress|0xfee00000|UINT32|0x00000001\r
529a5a86 141\r
abae030a
LG
142 ## Specifies delay value in microseconds after sending out an INIT IPI.\r
143 # @Prompt Configure delay value after send an INIT IPI\r
cf1eb6e6 144 gUefiCpuPkgTokenSpaceGuid.PcdCpuInitIpiDelayInMicroSeconds|10000|UINT32|0x30000002\r
529a5a86 145\r
6a26a597
CF
146 ## This value specifies the Application Processor (AP) stack size, used for Mp Service, which must\r
147 ## aligns the address on a 4-KByte boundary.\r
148 # @Prompt Configure stack size for Application Processor (AP)\r
149 gUefiCpuPkgTokenSpaceGuid.PcdCpuApStackSize|0x8000|UINT32|0x00000003\r
7798fb83 150\r
d947a4cc
MK
151 ## Specifies stack size in the temporary RAM. 0 means half of TemporaryRamSize.\r
152 # @Prompt Stack size in the temporary RAM.\r
153 gUefiCpuPkgTokenSpaceGuid.PcdPeiTemporaryRamStackSize|0|UINT32|0x10001003\r
154\r
529a5a86
MK
155 ## Specifies buffer size in bytes to save SMM profile data. The value should be a multiple of 4KB.\r
156 # @Prompt SMM profile data buffer size.\r
157 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmProfileSize|0x200000|UINT32|0x32132107\r
158\r
159 ## Specifies stack size in bytes for each processor in SMM.\r
160 # @Prompt Processor stack size in SMM.\r
161 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStackSize|0x2000|UINT32|0x32132105\r
162\r
529a5a86
MK
163 ## Indicates if SMM Code Access Check is enabled.\r
164 # If enabled, the SMM handler cannot execute the code outside SMM regions.\r
165 # This PCD is suggested to TRUE in production image.<BR><BR>\r
166 # TRUE - SMM Code Access Check will be enabled.<BR>\r
167 # FALSE - SMM Code Access Check will be disabled.<BR>\r
168 # @Prompt SMM Code Access Check.\r
169 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmCodeAccessCheckEnable|TRUE|BOOLEAN|0x60000013\r
170\r
46309b11
JF
171 ## Specifies the number of variable MTRRs reserved for OS use. The default number of\r
172 # MTRRs reserved for OS use is 2.\r
173 # @Prompt Number of reserved variable MTRRs.\r
174 gUefiCpuPkgTokenSpaceGuid.PcdCpuNumberOfReservedVariableMtrrs|0x2|UINT32|0x00000015\r
175\r
f7c11c53
MK
176 ## Specifies buffer size in bytes for STM exception stack. The value should be a multiple of 4KB.\r
177 # @Prompt STM exception stack size.\r
178 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStmExceptionStackSize|0x1000|UINT32|0x32132111\r
179\r
180 ## Specifies buffer size in bytes of MSEG. The value should be a multiple of 4KB.\r
181 # @Prompt MSEG size.\r
182 gUefiCpuPkgTokenSpaceGuid.PcdCpuMsegSize|0x200000|UINT32|0x32132112\r
183\r
f79fcf45 184[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]\r
b1e01bd4
JF
185 ## Specifies max supported number of Logical Processors.\r
186 # @Prompt Configure max supported number of Logical Processors\r
187 gUefiCpuPkgTokenSpaceGuid.PcdCpuMaxLogicalProcessorNumber|64|UINT32|0x00000002\r
f79fcf45
JF
188 ## Specifies timeout value in microseconds for the BSP to detect all APs for the first time.\r
189 # @Prompt Timeout for the BSP to detect all APs for the first time.\r
190 gUefiCpuPkgTokenSpaceGuid.PcdCpuApInitTimeOutInMicroSeconds|50000|UINT32|0x00000004\r
30314463
JF
191 ## Specifies the base address of the first microcode Patch in the microcode Region.\r
192 # @Prompt Microcode Region base address.\r
193 gUefiCpuPkgTokenSpaceGuid.PcdCpuMicrocodePatchAddress|0x0|UINT64|0x00000005\r
194 ## Specifies the size of the microcode Region.\r
195 # @Prompt Microcode Region size.\r
196 gUefiCpuPkgTokenSpaceGuid.PcdCpuMicrocodePatchRegionSize|0x0|UINT64|0x00000006\r
54a3e8c9
JF
197 ## Specifies the AP wait loop state during POST phase.\r
198 # The value is defined as below.<BR><BR>\r
199 # 1: Place AP in the Hlt-Loop state.<BR>\r
200 # 2: Place AP in the Mwait-Loop state.<BR>\r
201 # 3: Place AP in the Run-Loop state.<BR>\r
202 # @Prompt The AP wait loop state.\r
203 # @ValidRange 0x80000001 | 1 - 3\r
204 gUefiCpuPkgTokenSpaceGuid.PcdCpuApLoopMode|1|UINT8|0x60008006\r
9d39ed93
JF
205 ## Specifies the AP target C-state for Mwait during POST phase.\r
206 # The default value 0 means C1 state.\r
207 # The value is defined as below.<BR><BR>\r
208 # @Prompt The specified AP target C-state for Mwait.\r
209 gUefiCpuPkgTokenSpaceGuid.PcdCpuApTargetCstate|0|UINT8|0x00000007\r
f79fcf45 210\r
28b020b5
JY
211 ## Indicates if SMM uses static page table.\r
212 # If enabled, SMM will not use on-demand paging. SMM will build static page table for all memory.<BR><BR>\r
213 # This flag only impacts X64 build, because SMM alway builds static page table for IA32.\r
214 # TRUE - SMM uses static page table for all memory.<BR>\r
215 # FALSE - SMM uses static page table for below 4G memory and use on-demand paging for above 4G memory.<BR>\r
216 # @Prompt Use static page table for all memory in SMM.\r
217 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmStaticPageTable|TRUE|BOOLEAN|0x3213210D\r
218\r
b43dd229
LE
219 ## Specifies timeout value in microseconds for the BSP in SMM to wait for all APs to come into SMM.\r
220 # @Prompt AP synchronization timeout value in SMM.\r
221 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmApSyncTimeout|1000000|UINT64|0x32132104\r
222\r
223 ## Indicates the CPU synchronization method used when processing an SMI.\r
224 # 0x00 - Traditional CPU synchronization method.<BR>\r
225 # 0x01 - Relaxed CPU synchronization method.<BR>\r
226 # @Prompt SMM CPU Synchronization Method.\r
227 gUefiCpuPkgTokenSpaceGuid.PcdCpuSmmSyncMode|0x00|UINT8|0x60000014\r
228\r
529a5a86
MK
229[PcdsDynamic, PcdsDynamicEx]\r
230 ## Contains the pointer to a CPU S3 data buffer of structure ACPI_CPU_DATA.\r
231 # @Prompt The pointer to a CPU S3 data buffer.\r
232 # @ValidList 0x80000001 | 0\r
233 gUefiCpuPkgTokenSpaceGuid.PcdCpuS3DataAddress|0x0|UINT64|0x60000010\r
234\r
235 ## Contains the pointer to a CPU Hot Plug Data structure if CPU hot-plug is supported.\r
236 # @Prompt The pointer to CPU Hot Plug Data.\r
237 # @ValidList 0x80000001 | 0\r
238 gUefiCpuPkgTokenSpaceGuid.PcdCpuHotPlugDataAddress|0x0|UINT64|0x60000011\r
239\r
abae030a
LG
240[UserExtensions.TianoCore."ExtraFiles"]\r
241 UefiCpuPkgExtra.uni\r