UefiCpuPkg: Enhance feature dependency check
[mirror_edk2.git] / UefiCpuPkg / Library / CpuCommonFeaturesLib / MachineCheck.c
1 /** @file
2 Machine Check features.
3
4 Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #include "CpuCommonFeatures.h"
16
17 /**
18 Detects if Machine Check Exception feature supported on current processor.
19
20 @param[in] ProcessorNumber The index of the CPU executing this function.
21 @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION
22 structure for the CPU executing this function.
23 @param[in] ConfigData A pointer to the configuration buffer returned
24 by CPU_FEATURE_GET_CONFIG_DATA. NULL if
25 CPU_FEATURE_GET_CONFIG_DATA was not provided in
26 RegisterCpuFeature().
27
28 @retval TRUE Machine Check Exception feature is supported.
29 @retval FALSE Machine Check Exception feature is not supported.
30
31 @note This service could be called by BSP/APs.
32 **/
33 BOOLEAN
34 EFIAPI
35 MceSupport (
36 IN UINTN ProcessorNumber,
37 IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
38 IN VOID *ConfigData OPTIONAL
39 )
40 {
41 return (CpuInfo->CpuIdVersionInfoEdx.Bits.MCE == 1);
42 }
43
44 /**
45 Initializes Machine Check Exception feature to specific state.
46
47 @param[in] ProcessorNumber The index of the CPU executing this function.
48 @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION
49 structure for the CPU executing this function.
50 @param[in] ConfigData A pointer to the configuration buffer returned
51 by CPU_FEATURE_GET_CONFIG_DATA. NULL if
52 CPU_FEATURE_GET_CONFIG_DATA was not provided in
53 RegisterCpuFeature().
54 @param[in] State If TRUE, then the Machine Check Exception feature must be enabled.
55 If FALSE, then the Machine Check Exception feature must be disabled.
56
57 @retval RETURN_SUCCESS Machine Check Exception feature is initialized.
58
59 @note This service could be called by BSP only.
60 **/
61 RETURN_STATUS
62 EFIAPI
63 MceInitialize (
64 IN UINTN ProcessorNumber,
65 IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
66 IN VOID *ConfigData, OPTIONAL
67 IN BOOLEAN State
68 )
69 {
70 //
71 // Set MCE bit in CR4
72 //
73 CPU_REGISTER_TABLE_WRITE_FIELD (
74 ProcessorNumber,
75 ControlRegister,
76 4,
77 IA32_CR4,
78 Bits.MCE,
79 (State) ? 1 : 0
80 );
81 return RETURN_SUCCESS;
82 }
83
84 /**
85 Detects if Machine Check Architecture feature supported on current processor.
86
87 @param[in] ProcessorNumber The index of the CPU executing this function.
88 @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION
89 structure for the CPU executing this function.
90 @param[in] ConfigData A pointer to the configuration buffer returned
91 by CPU_FEATURE_GET_CONFIG_DATA. NULL if
92 CPU_FEATURE_GET_CONFIG_DATA was not provided in
93 RegisterCpuFeature().
94
95 @retval TRUE Machine Check Architecture feature is supported.
96 @retval FALSE Machine Check Architecture feature is not supported.
97
98 @note This service could be called by BSP/APs.
99 **/
100 BOOLEAN
101 EFIAPI
102 McaSupport (
103 IN UINTN ProcessorNumber,
104 IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
105 IN VOID *ConfigData OPTIONAL
106 )
107 {
108 if (!MceSupport (ProcessorNumber, CpuInfo, ConfigData)) {
109 return FALSE;
110 }
111 return (CpuInfo->CpuIdVersionInfoEdx.Bits.MCA == 1);
112 }
113
114 /**
115 Initializes Machine Check Architecture feature to specific state.
116
117 @param[in] ProcessorNumber The index of the CPU executing this function.
118 @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION
119 structure for the CPU executing this function.
120 @param[in] ConfigData A pointer to the configuration buffer returned
121 by CPU_FEATURE_GET_CONFIG_DATA. NULL if
122 CPU_FEATURE_GET_CONFIG_DATA was not provided in
123 RegisterCpuFeature().
124 @param[in] State If TRUE, then the Machine Check Architecture feature must be enabled.
125 If FALSE, then the Machine Check Architecture feature must be disabled.
126
127 @retval RETURN_SUCCESS Machine Check Architecture feature is initialized.
128
129 @note This service could be called by BSP only.
130 **/
131 RETURN_STATUS
132 EFIAPI
133 McaInitialize (
134 IN UINTN ProcessorNumber,
135 IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
136 IN VOID *ConfigData, OPTIONAL
137 IN BOOLEAN State
138 )
139 {
140 MSR_IA32_MCG_CAP_REGISTER McgCap;
141 UINT32 BankIndex;
142
143 McgCap.Uint64 = AsmReadMsr64 (MSR_IA32_MCG_CAP);
144 for (BankIndex = 0; BankIndex < (UINT32) McgCap.Bits.Count; BankIndex++) {
145 CPU_REGISTER_TABLE_WRITE64 (
146 ProcessorNumber,
147 Msr,
148 MSR_IA32_MC0_CTL + BankIndex * 4,
149 MAX_UINT64
150 );
151 }
152
153 if (PcdGetBool (PcdIsPowerOnReset)) {
154 for (BankIndex = 0; BankIndex < (UINTN) McgCap.Bits.Count; BankIndex++) {
155 CPU_REGISTER_TABLE_WRITE64 (
156 ProcessorNumber,
157 Msr,
158 MSR_IA32_MC0_STATUS + BankIndex * 4,
159 0
160 );
161 }
162 }
163
164 return RETURN_SUCCESS;
165 }
166
167 /**
168 Detects if IA32_MCG_CTL feature supported on current processor.
169
170 @param[in] ProcessorNumber The index of the CPU executing this function.
171 @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION
172 structure for the CPU executing this function.
173 @param[in] ConfigData A pointer to the configuration buffer returned
174 by CPU_FEATURE_GET_CONFIG_DATA. NULL if
175 CPU_FEATURE_GET_CONFIG_DATA was not provided in
176 RegisterCpuFeature().
177
178 @retval TRUE IA32_MCG_CTL feature is supported.
179 @retval FALSE IA32_MCG_CTL feature is not supported.
180
181 @note This service could be called by BSP/APs.
182 **/
183 BOOLEAN
184 EFIAPI
185 McgCtlSupport (
186 IN UINTN ProcessorNumber,
187 IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
188 IN VOID *ConfigData OPTIONAL
189 )
190 {
191 MSR_IA32_MCG_CAP_REGISTER McgCap;
192
193 if (!McaSupport (ProcessorNumber, CpuInfo, ConfigData)) {
194 return FALSE;
195 }
196 McgCap.Uint64 = AsmReadMsr64 (MSR_IA32_MCG_CAP);
197 return (McgCap.Bits.MCG_CTL_P == 1);
198 }
199
200 /**
201 Initializes IA32_MCG_CTL feature to specific state.
202
203 @param[in] ProcessorNumber The index of the CPU executing this function.
204 @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION
205 structure for the CPU executing this function.
206 @param[in] ConfigData A pointer to the configuration buffer returned
207 by CPU_FEATURE_GET_CONFIG_DATA. NULL if
208 CPU_FEATURE_GET_CONFIG_DATA was not provided in
209 RegisterCpuFeature().
210 @param[in] State If TRUE, then the IA32_MCG_CTL feature must be enabled.
211 If FALSE, then the IA32_MCG_CTL feature must be disabled.
212
213 @retval RETURN_SUCCESS IA32_MCG_CTL feature is initialized.
214
215 @note This service could be called by BSP only.
216 **/
217 RETURN_STATUS
218 EFIAPI
219 McgCtlInitialize (
220 IN UINTN ProcessorNumber,
221 IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
222 IN VOID *ConfigData, OPTIONAL
223 IN BOOLEAN State
224 )
225 {
226 CPU_REGISTER_TABLE_WRITE64 (
227 ProcessorNumber,
228 Msr,
229 MSR_IA32_MCG_CTL,
230 (State)? MAX_UINT64 : 0
231 );
232 return RETURN_SUCCESS;
233 }
234
235 /**
236 Detects if Local machine check exception feature supported on current
237 processor.
238
239 @param[in] ProcessorNumber The index of the CPU executing this function.
240 @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION
241 structure for the CPU executing this function.
242 @param[in] ConfigData A pointer to the configuration buffer returned
243 by CPU_FEATURE_GET_CONFIG_DATA. NULL if
244 CPU_FEATURE_GET_CONFIG_DATA was not provided in
245 RegisterCpuFeature().
246
247 @retval TRUE Local machine check exception feature is supported.
248 @retval FALSE Local machine check exception feature is not supported.
249
250 @note This service could be called by BSP/APs.
251 **/
252 BOOLEAN
253 EFIAPI
254 LmceSupport (
255 IN UINTN ProcessorNumber,
256 IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
257 IN VOID *ConfigData OPTIONAL
258 )
259 {
260 MSR_IA32_MCG_CAP_REGISTER McgCap;
261
262 if (!McaSupport (ProcessorNumber, CpuInfo, ConfigData)) {
263 return FALSE;
264 }
265
266 McgCap.Uint64 = AsmReadMsr64 (MSR_IA32_MCG_CAP);
267 if (ProcessorNumber == 0) {
268 DEBUG ((EFI_D_INFO, "LMCE eanble = %x\n", (BOOLEAN) (McgCap.Bits.MCG_LMCE_P != 0)));
269 }
270 return (BOOLEAN) (McgCap.Bits.MCG_LMCE_P != 0);
271 }
272
273 /**
274 Initializes Local machine check exception feature to specific state.
275
276 @param[in] ProcessorNumber The index of the CPU executing this function.
277 @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION
278 structure for the CPU executing this function.
279 @param[in] ConfigData A pointer to the configuration buffer returned
280 by CPU_FEATURE_GET_CONFIG_DATA. NULL if
281 CPU_FEATURE_GET_CONFIG_DATA was not provided in
282 RegisterCpuFeature().
283 @param[in] State If TRUE, then the Local machine check exception
284 feature must be enabled.
285 If FALSE, then the Local machine check exception
286 feature must be disabled.
287
288 @retval RETURN_SUCCESS Local machine check exception feature is initialized.
289
290 **/
291 RETURN_STATUS
292 EFIAPI
293 LmceInitialize (
294 IN UINTN ProcessorNumber,
295 IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
296 IN VOID *ConfigData, OPTIONAL
297 IN BOOLEAN State
298 )
299 {
300 MSR_IA32_FEATURE_CONTROL_REGISTER *MsrRegister;
301
302 ASSERT (ConfigData != NULL);
303 MsrRegister = (MSR_IA32_FEATURE_CONTROL_REGISTER *) ConfigData;
304 if (MsrRegister[ProcessorNumber].Bits.Lock == 0) {
305 CPU_REGISTER_TABLE_WRITE_FIELD (
306 ProcessorNumber,
307 Msr,
308 MSR_IA32_FEATURE_CONTROL,
309 MSR_IA32_FEATURE_CONTROL_REGISTER,
310 Bits.LmceOn,
311 (State) ? 1 : 0
312 );
313 }
314 return RETURN_SUCCESS;
315 }