]> git.proxmox.com Git - mirror_edk2.git/blame - OvmfPkg/Library/SmmCpuFeaturesLib/SmmCpuFeaturesLib.c
OvmfPkg: Apply uncrustify changes
[mirror_edk2.git] / OvmfPkg / Library / SmmCpuFeaturesLib / SmmCpuFeaturesLib.c
CommitLineData
86d71589 1/** @file\r
b1bfdd65 2 The CPU specific programming for PiSmmCpuDxeSmm module.\r
86d71589 3\r
b1bfdd65 4 Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>\r
86d71589 5\r
b26f0cf9 6 SPDX-License-Identifier: BSD-2-Clause-Patent\r
86d71589
PB
7**/\r
8\r
300aae11 9#include <IndustryStandard/Q35MchIch9.h>\r
86d71589 10#include <Library/BaseLib.h>\r
4036b4e5 11#include <Library/BaseMemoryLib.h>\r
4a9b250b 12#include <Library/DebugLib.h>\r
5ef3b66f 13#include <Library/MemEncryptSevLib.h>\r
b6d59967 14#include <Library/MemoryAllocationLib.h>\r
300aae11 15#include <Library/PcdLib.h>\r
b6d59967 16#include <Library/SafeIntLib.h>\r
4a9b250b 17#include <Library/SmmCpuFeaturesLib.h>\r
4036b4e5 18#include <Library/SmmServicesTableLib.h>\r
5ef3b66f 19#include <Library/UefiBootServicesTableLib.h>\r
b6d59967 20#include <Pcd/CpuHotEjectData.h>\r
4a9b250b 21#include <PiSmm.h>\r
300aae11 22#include <Register/Intel/SmramSaveStateMap.h>\r
c1fcd80b 23#include <Register/QemuSmramSaveStateMap.h>\r
86d71589 24\r
4036b4e5
PB
25//\r
26// EFER register LMA bit\r
27//\r
ac0a286f 28#define LMA BIT10\r
4036b4e5 29\r
86d71589
PB
30/**\r
31 The constructor function\r
32\r
33 @param[in] ImageHandle The firmware allocated handle for the EFI image.\r
34 @param[in] SystemTable A pointer to the EFI System Table.\r
35\r
36 @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.\r
37\r
38**/\r
39EFI_STATUS\r
40EFIAPI\r
41SmmCpuFeaturesLibConstructor (\r
42 IN EFI_HANDLE ImageHandle,\r
43 IN EFI_SYSTEM_TABLE *SystemTable\r
44 )\r
45{\r
86d71589 46 //\r
d7e71b29 47 // No need to program SMRRs on our virtual platform.\r
86d71589 48 //\r
86d71589
PB
49 return EFI_SUCCESS;\r
50}\r
51\r
52/**\r
53 Called during the very first SMI into System Management Mode to initialize\r
54 CPU features, including SMBASE, for the currently executing CPU. Since this\r
55 is the first SMI, the SMRAM Save State Map is at the default address of\r
56 SMM_DEFAULT_SMBASE + SMRAM_SAVE_STATE_MAP_OFFSET. The currently executing\r
57 CPU is specified by CpuIndex and CpuIndex can be used to access information\r
58 about the currently executing CPU in the ProcessorInfo array and the\r
59 HotPlugCpuData data structure.\r
60\r
61 @param[in] CpuIndex The index of the CPU to initialize. The value\r
62 must be between 0 and the NumberOfCpus field in\r
63 the System Management System Table (SMST).\r
64 @param[in] IsMonarch TRUE if the CpuIndex is the index of the CPU that\r
65 was elected as monarch during System Management\r
66 Mode initialization.\r
67 FALSE if the CpuIndex is not the index of the CPU\r
68 that was elected as monarch during System\r
69 Management Mode initialization.\r
70 @param[in] ProcessorInfo Pointer to an array of EFI_PROCESSOR_INFORMATION\r
71 structures. ProcessorInfo[CpuIndex] contains the\r
72 information for the currently executing CPU.\r
73 @param[in] CpuHotPlugData Pointer to the CPU_HOT_PLUG_DATA structure that\r
74 contains the ApidId and SmBase arrays.\r
75**/\r
76VOID\r
77EFIAPI\r
78SmmCpuFeaturesInitializeProcessor (\r
79 IN UINTN CpuIndex,\r
80 IN BOOLEAN IsMonarch,\r
81 IN EFI_PROCESSOR_INFORMATION *ProcessorInfo,\r
82 IN CPU_HOT_PLUG_DATA *CpuHotPlugData\r
83 )\r
84{\r
c1fcd80b 85 QEMU_SMRAM_SAVE_STATE_MAP *CpuState;\r
86d71589
PB
86\r
87 //\r
88 // Configure SMBASE.\r
89 //\r
b1bfdd65 90 CpuState = (QEMU_SMRAM_SAVE_STATE_MAP *)(UINTN)(\r
ac0a286f
MK
91 SMM_DEFAULT_SMBASE +\r
92 SMRAM_SAVE_STATE_MAP_OFFSET\r
93 );\r
c1fcd80b
PB
94 if ((CpuState->x86.SMMRevId & 0xFFFF) == 0) {\r
95 CpuState->x86.SMBASE = (UINT32)CpuHotPlugData->SmBase[CpuIndex];\r
96 } else {\r
97 CpuState->x64.SMBASE = (UINT32)CpuHotPlugData->SmBase[CpuIndex];\r
98 }\r
86d71589
PB
99\r
100 //\r
d7e71b29 101 // No need to program SMRRs on our virtual platform.\r
86d71589 102 //\r
86d71589
PB
103}\r
104\r
105/**\r
106 This function updates the SMRAM save state on the currently executing CPU\r
107 to resume execution at a specific address after an RSM instruction. This\r
108 function must evaluate the SMRAM save state to determine the execution mode\r
109 the RSM instruction resumes and update the resume execution address with\r
110 either NewInstructionPointer32 or NewInstructionPoint. The auto HALT restart\r
111 flag in the SMRAM save state must always be cleared. This function returns\r
112 the value of the instruction pointer from the SMRAM save state that was\r
113 replaced. If this function returns 0, then the SMRAM save state was not\r
114 modified.\r
115\r
116 This function is called during the very first SMI on each CPU after\r
117 SmmCpuFeaturesInitializeProcessor() to set a flag in normal execution mode\r
118 to signal that the SMBASE of each CPU has been updated before the default\r
119 SMBASE address is used for the first SMI to the next CPU.\r
120\r
121 @param[in] CpuIndex The index of the CPU to hook. The value\r
122 must be between 0 and the NumberOfCpus\r
b1bfdd65
LE
123 field in the System Management System\r
124 Table (SMST).\r
86d71589
PB
125 @param[in] CpuState Pointer to SMRAM Save State Map for the\r
126 currently executing CPU.\r
127 @param[in] NewInstructionPointer32 Instruction pointer to use if resuming to\r
128 32-bit execution mode from 64-bit SMM.\r
129 @param[in] NewInstructionPointer Instruction pointer to use if resuming to\r
130 same execution mode as SMM.\r
131\r
132 @retval 0 This function did modify the SMRAM save state.\r
133 @retval > 0 The original instruction pointer value from the SMRAM save state\r
134 before it was replaced.\r
135**/\r
136UINT64\r
137EFIAPI\r
138SmmCpuFeaturesHookReturnFromSmm (\r
139 IN UINTN CpuIndex,\r
140 IN SMRAM_SAVE_STATE_MAP *CpuState,\r
141 IN UINT64 NewInstructionPointer32,\r
142 IN UINT64 NewInstructionPointer\r
143 )\r
144{\r
ac0a286f
MK
145 UINT64 OriginalInstructionPointer;\r
146 QEMU_SMRAM_SAVE_STATE_MAP *CpuSaveState;\r
4036b4e5 147\r
b1bfdd65 148 CpuSaveState = (QEMU_SMRAM_SAVE_STATE_MAP *)CpuState;\r
4036b4e5
PB
149 if ((CpuSaveState->x86.SMMRevId & 0xFFFF) == 0) {\r
150 OriginalInstructionPointer = (UINT64)CpuSaveState->x86._EIP;\r
ac0a286f 151 CpuSaveState->x86._EIP = (UINT32)NewInstructionPointer;\r
4036b4e5
PB
152 //\r
153 // Clear the auto HALT restart flag so the RSM instruction returns\r
154 // program control to the instruction following the HLT instruction.\r
155 //\r
156 if ((CpuSaveState->x86.AutoHALTRestart & BIT0) != 0) {\r
157 CpuSaveState->x86.AutoHALTRestart &= ~BIT0;\r
158 }\r
159 } else {\r
160 OriginalInstructionPointer = CpuSaveState->x64._RIP;\r
161 if ((CpuSaveState->x64.IA32_EFER & LMA) == 0) {\r
162 CpuSaveState->x64._RIP = (UINT32)NewInstructionPointer32;\r
163 } else {\r
164 CpuSaveState->x64._RIP = (UINT32)NewInstructionPointer;\r
165 }\r
ac0a286f 166\r
4036b4e5
PB
167 //\r
168 // Clear the auto HALT restart flag so the RSM instruction returns\r
169 // program control to the instruction following the HLT instruction.\r
170 //\r
171 if ((CpuSaveState->x64.AutoHALTRestart & BIT0) != 0) {\r
172 CpuSaveState->x64.AutoHALTRestart &= ~BIT0;\r
173 }\r
174 }\r
ac0a286f 175\r
4036b4e5 176 return OriginalInstructionPointer;\r
86d71589
PB
177}\r
178\r
ac0a286f 179STATIC CPU_HOT_EJECT_DATA *mCpuHotEjectData = NULL;\r
b6d59967
AA
180\r
181/**\r
182 Initialize mCpuHotEjectData if PcdCpuMaxLogicalProcessorNumber > 1.\r
183\r
184 Also setup the corresponding PcdCpuHotEjectDataAddress.\r
185**/\r
186STATIC\r
187VOID\r
188InitCpuHotEjectData (\r
189 VOID\r
190 )\r
191{\r
192 UINTN Size;\r
193 UINT32 Idx;\r
194 UINT32 MaxNumberOfCpus;\r
195 RETURN_STATUS PcdStatus;\r
196\r
197 MaxNumberOfCpus = PcdGet32 (PcdCpuMaxLogicalProcessorNumber);\r
198 if (MaxNumberOfCpus == 1) {\r
199 return;\r
200 }\r
201\r
202 //\r
203 // We allocate CPU_HOT_EJECT_DATA and CPU_HOT_EJECT_DATA->QemuSelectorMap[]\r
204 // in a single allocation, and explicitly align the QemuSelectorMap[] (which\r
205 // is a UINT64 array) at its natural boundary.\r
206 // Accordingly, allocate:\r
207 // sizeof(*mCpuHotEjectData) + (MaxNumberOfCpus * sizeof(UINT64))\r
208 // and, add sizeof(UINT64) - 1 to use as padding if needed.\r
209 //\r
210\r
211 if (RETURN_ERROR (SafeUintnMult (MaxNumberOfCpus, sizeof (UINT64), &Size)) ||\r
212 RETURN_ERROR (SafeUintnAdd (Size, sizeof (*mCpuHotEjectData), &Size)) ||\r
ac0a286f
MK
213 RETURN_ERROR (SafeUintnAdd (Size, sizeof (UINT64) - 1, &Size)))\r
214 {\r
b6d59967
AA
215 DEBUG ((DEBUG_ERROR, "%a: invalid CPU_HOT_EJECT_DATA\n", __FUNCTION__));\r
216 goto Fatal;\r
217 }\r
218\r
219 mCpuHotEjectData = AllocatePool (Size);\r
220 if (mCpuHotEjectData == NULL) {\r
221 ASSERT (mCpuHotEjectData != NULL);\r
222 goto Fatal;\r
223 }\r
224\r
ac0a286f 225 mCpuHotEjectData->Handler = NULL;\r
b6d59967
AA
226 mCpuHotEjectData->ArrayLength = MaxNumberOfCpus;\r
227\r
ac0a286f
MK
228 mCpuHotEjectData->QemuSelectorMap = ALIGN_POINTER (\r
229 mCpuHotEjectData + 1,\r
230 sizeof (UINT64)\r
231 );\r
b6d59967
AA
232 //\r
233 // We use mCpuHotEjectData->QemuSelectorMap to map\r
234 // ProcessorNum -> QemuSelector. Initialize to invalid values.\r
235 //\r
236 for (Idx = 0; Idx < mCpuHotEjectData->ArrayLength; Idx++) {\r
237 mCpuHotEjectData->QemuSelectorMap[Idx] = CPU_EJECT_QEMU_SELECTOR_INVALID;\r
238 }\r
239\r
240 //\r
241 // Expose address of CPU Hot eject Data structure\r
242 //\r
ac0a286f
MK
243 PcdStatus = PcdSet64S (\r
244 PcdCpuHotEjectDataAddress,\r
245 (UINTN)(VOID *)mCpuHotEjectData\r
246 );\r
b6d59967
AA
247 ASSERT_RETURN_ERROR (PcdStatus);\r
248\r
249 return;\r
250\r
251Fatal:\r
252 CpuDeadLoop ();\r
253}\r
254\r
86d71589
PB
255/**\r
256 Hook point in normal execution mode that allows the one CPU that was elected\r
257 as monarch during System Management Mode initialization to perform additional\r
258 initialization actions immediately after all of the CPUs have processed their\r
259 first SMI and called SmmCpuFeaturesInitializeProcessor() relocating SMBASE\r
260 into a buffer in SMRAM and called SmmCpuFeaturesHookReturnFromSmm().\r
261**/\r
262VOID\r
263EFIAPI\r
264SmmCpuFeaturesSmmRelocationComplete (\r
265 VOID\r
266 )\r
267{\r
ac0a286f
MK
268 EFI_STATUS Status;\r
269 UINTN MapPagesBase;\r
270 UINTN MapPagesCount;\r
b6d59967
AA
271\r
272 InitCpuHotEjectData ();\r
273\r
5ef3b66f
LE
274 if (!MemEncryptSevIsEnabled ()) {\r
275 return;\r
276 }\r
277\r
278 //\r
279 // Now that SMBASE relocation is complete, re-encrypt the original SMRAM save\r
280 // state map's container pages, and release the pages to DXE. (The pages were\r
281 // allocated in PlatformPei.)\r
282 //\r
283 Status = MemEncryptSevLocateInitialSmramSaveStateMapPages (\r
284 &MapPagesBase,\r
285 &MapPagesCount\r
286 );\r
287 ASSERT_EFI_ERROR (Status);\r
288\r
289 Status = MemEncryptSevSetPageEncMask (\r
290 0, // Cr3BaseAddress -- use current CR3\r
291 MapPagesBase, // BaseAddress\r
adfa3327 292 MapPagesCount // NumPages\r
5ef3b66f
LE
293 );\r
294 if (EFI_ERROR (Status)) {\r
ac0a286f
MK
295 DEBUG ((\r
296 DEBUG_ERROR,\r
297 "%a: MemEncryptSevSetPageEncMask(): %r\n",\r
298 __FUNCTION__,\r
299 Status\r
300 ));\r
5ef3b66f
LE
301 ASSERT (FALSE);\r
302 CpuDeadLoop ();\r
303 }\r
304\r
305 ZeroMem ((VOID *)MapPagesBase, EFI_PAGES_TO_SIZE (MapPagesCount));\r
306\r
300aae11
LE
307 if (PcdGetBool (PcdQ35SmramAtDefaultSmbase)) {\r
308 //\r
309 // The initial SMRAM Save State Map has been covered as part of a larger\r
310 // reserved memory allocation in PlatformPei's InitializeRamRegions(). That\r
311 // allocation is supposed to survive into OS runtime; we must not release\r
312 // any part of it. Only re-assert the containment here.\r
313 //\r
314 ASSERT (SMM_DEFAULT_SMBASE <= MapPagesBase);\r
315 ASSERT (\r
316 (MapPagesBase + EFI_PAGES_TO_SIZE (MapPagesCount) <=\r
317 SMM_DEFAULT_SMBASE + MCH_DEFAULT_SMBASE_SIZE)\r
318 );\r
319 } else {\r
320 Status = gBS->FreePages (MapPagesBase, MapPagesCount);\r
321 ASSERT_EFI_ERROR (Status);\r
322 }\r
86d71589
PB
323}\r
324\r
325/**\r
326 Return the size, in bytes, of a custom SMI Handler in bytes. If 0 is\r
327 returned, then a custom SMI handler is not provided by this library,\r
328 and the default SMI handler must be used.\r
329\r
330 @retval 0 Use the default SMI handler.\r
b1bfdd65
LE
331 @retval > 0 Use the SMI handler installed by\r
332 SmmCpuFeaturesInstallSmiHandler(). The caller is required to\r
333 allocate enough SMRAM for each CPU to support the size of the\r
334 custom SMI handler.\r
86d71589
PB
335**/\r
336UINTN\r
337EFIAPI\r
338SmmCpuFeaturesGetSmiHandlerSize (\r
339 VOID\r
340 )\r
341{\r
342 return 0;\r
343}\r
344\r
345/**\r
b1bfdd65
LE
346 Install a custom SMI handler for the CPU specified by CpuIndex. This\r
347 function is only called if SmmCpuFeaturesGetSmiHandlerSize() returns a size\r
348 is greater than zero and is called by the CPU that was elected as monarch\r
349 during System Management Mode initialization.\r
86d71589
PB
350\r
351 @param[in] CpuIndex The index of the CPU to install the custom SMI handler.\r
352 The value must be between 0 and the NumberOfCpus field\r
353 in the System Management System Table (SMST).\r
354 @param[in] SmBase The SMBASE address for the CPU specified by CpuIndex.\r
355 @param[in] SmiStack The stack to use when an SMI is processed by the\r
356 the CPU specified by CpuIndex.\r
357 @param[in] StackSize The size, in bytes, if the stack used when an SMI is\r
358 processed by the CPU specified by CpuIndex.\r
359 @param[in] GdtBase The base address of the GDT to use when an SMI is\r
360 processed by the CPU specified by CpuIndex.\r
361 @param[in] GdtSize The size, in bytes, of the GDT used when an SMI is\r
362 processed by the CPU specified by CpuIndex.\r
363 @param[in] IdtBase The base address of the IDT to use when an SMI is\r
364 processed by the CPU specified by CpuIndex.\r
365 @param[in] IdtSize The size, in bytes, of the IDT used when an SMI is\r
366 processed by the CPU specified by CpuIndex.\r
367 @param[in] Cr3 The base address of the page tables to use when an SMI\r
368 is processed by the CPU specified by CpuIndex.\r
369**/\r
370VOID\r
371EFIAPI\r
372SmmCpuFeaturesInstallSmiHandler (\r
373 IN UINTN CpuIndex,\r
374 IN UINT32 SmBase,\r
375 IN VOID *SmiStack,\r
376 IN UINTN StackSize,\r
377 IN UINTN GdtBase,\r
378 IN UINTN GdtSize,\r
379 IN UINTN IdtBase,\r
380 IN UINTN IdtSize,\r
381 IN UINT32 Cr3\r
382 )\r
383{\r
384}\r
385\r
386/**\r
387 Determines if MTRR registers must be configured to set SMRAM cache-ability\r
388 when executing in System Management Mode.\r
389\r
390 @retval TRUE MTRR registers must be configured to set SMRAM cache-ability.\r
391 @retval FALSE MTRR registers do not need to be configured to set SMRAM\r
392 cache-ability.\r
393**/\r
394BOOLEAN\r
395EFIAPI\r
396SmmCpuFeaturesNeedConfigureMtrrs (\r
397 VOID\r
398 )\r
399{\r
d7e71b29 400 return FALSE;\r
86d71589
PB
401}\r
402\r
403/**\r
b1bfdd65
LE
404 Disable SMRR register if SMRR is supported and\r
405 SmmCpuFeaturesNeedConfigureMtrrs() returns TRUE.\r
86d71589
PB
406**/\r
407VOID\r
408EFIAPI\r
409SmmCpuFeaturesDisableSmrr (\r
410 VOID\r
411 )\r
412{\r
d7e71b29
PB
413 //\r
414 // No SMRR support, nothing to do\r
415 //\r
86d71589
PB
416}\r
417\r
418/**\r
b1bfdd65
LE
419 Enable SMRR register if SMRR is supported and\r
420 SmmCpuFeaturesNeedConfigureMtrrs() returns TRUE.\r
86d71589
PB
421**/\r
422VOID\r
423EFIAPI\r
424SmmCpuFeaturesReenableSmrr (\r
425 VOID\r
426 )\r
427{\r
d7e71b29
PB
428 //\r
429 // No SMRR support, nothing to do\r
430 //\r
86d71589
PB
431}\r
432\r
433/**\r
434 Processor specific hook point each time a CPU enters System Management Mode.\r
435\r
436 @param[in] CpuIndex The index of the CPU that has entered SMM. The value\r
437 must be between 0 and the NumberOfCpus field in the\r
438 System Management System Table (SMST).\r
439**/\r
440VOID\r
441EFIAPI\r
442SmmCpuFeaturesRendezvousEntry (\r
443 IN UINTN CpuIndex\r
444 )\r
445{\r
446 //\r
d7e71b29 447 // No SMRR support, nothing to do\r
86d71589 448 //\r
86d71589
PB
449}\r
450\r
451/**\r
452 Processor specific hook point each time a CPU exits System Management Mode.\r
453\r
b1bfdd65
LE
454 @param[in] CpuIndex The index of the CPU that is exiting SMM. The value\r
455 must be between 0 and the NumberOfCpus field in the\r
456 System Management System Table (SMST).\r
86d71589
PB
457**/\r
458VOID\r
459EFIAPI\r
460SmmCpuFeaturesRendezvousExit (\r
461 IN UINTN CpuIndex\r
462 )\r
463{\r
af9c77e1
AA
464 //\r
465 // We only call the Handler if CPU hot-eject is enabled\r
466 // (PcdCpuMaxLogicalProcessorNumber > 1), and hot-eject is needed\r
467 // in this SMI exit (otherwise mCpuHotEjectData->Handler is not armed.)\r
468 //\r
469\r
470 if (mCpuHotEjectData != NULL) {\r
ac0a286f 471 CPU_HOT_EJECT_HANDLER Handler;\r
af9c77e1
AA
472\r
473 //\r
474 // As the comment above mentions, mCpuHotEjectData->Handler might be\r
475 // written to on the BSP as part of handling of the CPU-ejection.\r
476 //\r
477 // We know that any initial assignment to mCpuHotEjectData->Handler\r
478 // (on the BSP, in the CpuHotplugMmi() context) is ordered-before the\r
479 // load below, since it is guaranteed to happen before the\r
480 // control-dependency of the BSP's SMI exit signal -- by way of a store\r
481 // to AllCpusInSync (on the BSP, in BspHandler()) and the corresponding\r
482 // AllCpusInSync loop (on the APs, in SmiRendezvous()) which depends on\r
483 // that store.\r
484 //\r
485 // This guarantees that these pieces of code can never execute\r
486 // simultaneously. In addition, we ensure that the following load is\r
487 // ordered-after the AllCpusInSync loop by using a MemoryFence() with\r
488 // acquire semantics.\r
489 //\r
ac0a286f 490 MemoryFence ();\r
af9c77e1
AA
491\r
492 Handler = mCpuHotEjectData->Handler;\r
493\r
494 if (Handler != NULL) {\r
495 Handler (CpuIndex);\r
496 }\r
497 }\r
86d71589
PB
498}\r
499\r
500/**\r
501 Check to see if an SMM register is supported by a specified CPU.\r
502\r
503 @param[in] CpuIndex The index of the CPU to check for SMM register support.\r
504 The value must be between 0 and the NumberOfCpus field\r
505 in the System Management System Table (SMST).\r
506 @param[in] RegName Identifies the SMM register to check for support.\r
507\r
508 @retval TRUE The SMM register specified by RegName is supported by the CPU\r
509 specified by CpuIndex.\r
510 @retval FALSE The SMM register specified by RegName is not supported by the\r
511 CPU specified by CpuIndex.\r
512**/\r
513BOOLEAN\r
514EFIAPI\r
515SmmCpuFeaturesIsSmmRegisterSupported (\r
516 IN UINTN CpuIndex,\r
517 IN SMM_REG_NAME RegName\r
518 )\r
519{\r
d7e71b29 520 ASSERT (RegName == SmmRegFeatureControl);\r
86d71589
PB
521 return FALSE;\r
522}\r
523\r
524/**\r
525 Returns the current value of the SMM register for the specified CPU.\r
526 If the SMM register is not supported, then 0 is returned.\r
527\r
528 @param[in] CpuIndex The index of the CPU to read the SMM register. The\r
529 value must be between 0 and the NumberOfCpus field in\r
530 the System Management System Table (SMST).\r
531 @param[in] RegName Identifies the SMM register to read.\r
532\r
533 @return The value of the SMM register specified by RegName from the CPU\r
534 specified by CpuIndex.\r
535**/\r
536UINT64\r
537EFIAPI\r
538SmmCpuFeaturesGetSmmRegister (\r
539 IN UINTN CpuIndex,\r
540 IN SMM_REG_NAME RegName\r
541 )\r
542{\r
d7e71b29
PB
543 //\r
544 // This is called for SmmRegSmmDelayed, SmmRegSmmBlocked, SmmRegSmmEnable.\r
545 // The last of these should actually be SmmRegSmmDisable, so we can just\r
546 // return FALSE.\r
547 //\r
86d71589
PB
548 return 0;\r
549}\r
550\r
551/**\r
552 Sets the value of an SMM register on a specified CPU.\r
553 If the SMM register is not supported, then no action is performed.\r
554\r
555 @param[in] CpuIndex The index of the CPU to write the SMM register. The\r
556 value must be between 0 and the NumberOfCpus field in\r
557 the System Management System Table (SMST).\r
558 @param[in] RegName Identifies the SMM register to write.\r
559 registers are read-only.\r
560 @param[in] Value The value to write to the SMM register.\r
561**/\r
562VOID\r
563EFIAPI\r
564SmmCpuFeaturesSetSmmRegister (\r
565 IN UINTN CpuIndex,\r
566 IN SMM_REG_NAME RegName,\r
567 IN UINT64 Value\r
568 )\r
569{\r
d7e71b29 570 ASSERT (FALSE);\r
86d71589
PB
571}\r
572\r
4036b4e5 573///\r
b1bfdd65
LE
574/// Macro used to simplify the lookup table entries of type\r
575/// CPU_SMM_SAVE_STATE_LOOKUP_ENTRY\r
4036b4e5 576///\r
ac0a286f 577#define SMM_CPU_OFFSET(Field) OFFSET_OF (QEMU_SMRAM_SAVE_STATE_MAP, Field)\r
4036b4e5
PB
578\r
579///\r
b1bfdd65
LE
580/// Macro used to simplify the lookup table entries of type\r
581/// CPU_SMM_SAVE_STATE_REGISTER_RANGE\r
4036b4e5 582///\r
ac0a286f 583#define SMM_REGISTER_RANGE(Start, End) { Start, End, End - Start + 1 }\r
4036b4e5
PB
584\r
585///\r
586/// Structure used to describe a range of registers\r
587///\r
588typedef struct {\r
ac0a286f
MK
589 EFI_SMM_SAVE_STATE_REGISTER Start;\r
590 EFI_SMM_SAVE_STATE_REGISTER End;\r
591 UINTN Length;\r
4036b4e5
PB
592} CPU_SMM_SAVE_STATE_REGISTER_RANGE;\r
593\r
594///\r
595/// Structure used to build a lookup table to retrieve the widths and offsets\r
596/// associated with each supported EFI_SMM_SAVE_STATE_REGISTER value\r
597///\r
598\r
ac0a286f 599#define SMM_SAVE_STATE_REGISTER_FIRST_INDEX 1\r
4036b4e5
PB
600\r
601typedef struct {\r
ac0a286f
MK
602 UINT8 Width32;\r
603 UINT8 Width64;\r
604 UINT16 Offset32;\r
605 UINT16 Offset64Lo;\r
606 UINT16 Offset64Hi;\r
607 BOOLEAN Writeable;\r
4036b4e5
PB
608} CPU_SMM_SAVE_STATE_LOOKUP_ENTRY;\r
609\r
610///\r
b1bfdd65 611/// Table used by GetRegisterIndex() to convert an EFI_SMM_SAVE_STATE_REGISTER\r
4036b4e5
PB
612/// value to an index into a table of type CPU_SMM_SAVE_STATE_LOOKUP_ENTRY\r
613///\r
ac0a286f 614STATIC CONST CPU_SMM_SAVE_STATE_REGISTER_RANGE mSmmCpuRegisterRanges[] = {\r
b1bfdd65
LE
615 SMM_REGISTER_RANGE (\r
616 EFI_SMM_SAVE_STATE_REGISTER_GDTBASE,\r
617 EFI_SMM_SAVE_STATE_REGISTER_LDTINFO\r
618 ),\r
619 SMM_REGISTER_RANGE (\r
620 EFI_SMM_SAVE_STATE_REGISTER_ES,\r
621 EFI_SMM_SAVE_STATE_REGISTER_RIP\r
622 ),\r
623 SMM_REGISTER_RANGE (\r
624 EFI_SMM_SAVE_STATE_REGISTER_RFLAGS,\r
625 EFI_SMM_SAVE_STATE_REGISTER_CR4\r
626 ),\r
ac0a286f 627 { (EFI_SMM_SAVE_STATE_REGISTER)0, (EFI_SMM_SAVE_STATE_REGISTER)0,0 }\r
4036b4e5
PB
628};\r
629\r
630///\r
b1bfdd65
LE
631/// Lookup table used to retrieve the widths and offsets associated with each\r
632/// supported EFI_SMM_SAVE_STATE_REGISTER value\r
4036b4e5 633///\r
ac0a286f 634STATIC CONST CPU_SMM_SAVE_STATE_LOOKUP_ENTRY mSmmCpuWidthOffset[] = {\r
b1bfdd65
LE
635 {\r
636 0, // Width32\r
637 0, // Width64\r
638 0, // Offset32\r
639 0, // Offset64Lo\r
640 0, // Offset64Hi\r
641 FALSE // Writeable\r
642 }, // Reserved\r
4036b4e5
PB
643\r
644 //\r
645 // CPU Save State registers defined in PI SMM CPU Protocol.\r
646 //\r
b1bfdd65
LE
647 {\r
648 0, // Width32\r
649 8, // Width64\r
650 0, // Offset32\r
651 SMM_CPU_OFFSET (x64._GDTRBase), // Offset64Lo\r
652 SMM_CPU_OFFSET (x64._GDTRBase) + 4, // Offset64Hi\r
653 FALSE // Writeable\r
654 }, // EFI_SMM_SAVE_STATE_REGISTER_GDTBASE = 4\r
655\r
656 {\r
657 0, // Width32\r
658 8, // Width64\r
659 0, // Offset32\r
660 SMM_CPU_OFFSET (x64._IDTRBase), // Offset64Lo\r
661 SMM_CPU_OFFSET (x64._IDTRBase) + 4, // Offset64Hi\r
662 FALSE // Writeable\r
663 }, // EFI_SMM_SAVE_STATE_REGISTER_IDTBASE = 5\r
664\r
665 {\r
666 0, // Width32\r
667 8, // Width64\r
668 0, // Offset32\r
669 SMM_CPU_OFFSET (x64._LDTRBase), // Offset64Lo\r
670 SMM_CPU_OFFSET (x64._LDTRBase) + 4, // Offset64Hi\r
671 FALSE // Writeable\r
672 }, // EFI_SMM_SAVE_STATE_REGISTER_LDTBASE = 6\r
673\r
674 {\r
675 0, // Width32\r
676 0, // Width64\r
677 0, // Offset32\r
678 SMM_CPU_OFFSET (x64._GDTRLimit), // Offset64Lo\r
679 SMM_CPU_OFFSET (x64._GDTRLimit) + 4, // Offset64Hi\r
680 FALSE // Writeable\r
681 }, // EFI_SMM_SAVE_STATE_REGISTER_GDTLIMIT = 7\r
682\r
683 {\r
684 0, // Width32\r
685 0, // Width64\r
686 0, // Offset32\r
687 SMM_CPU_OFFSET (x64._IDTRLimit), // Offset64Lo\r
688 SMM_CPU_OFFSET (x64._IDTRLimit) + 4, // Offset64Hi\r
689 FALSE // Writeable\r
690 }, // EFI_SMM_SAVE_STATE_REGISTER_IDTLIMIT = 8\r
691\r
692 {\r
693 0, // Width32\r
694 0, // Width64\r
695 0, // Offset32\r
696 SMM_CPU_OFFSET (x64._LDTRLimit), // Offset64Lo\r
697 SMM_CPU_OFFSET (x64._LDTRLimit) + 4, // Offset64Hi\r
698 FALSE // Writeable\r
699 }, // EFI_SMM_SAVE_STATE_REGISTER_LDTLIMIT = 9\r
700\r
701 {\r
702 0, // Width32\r
703 0, // Width64\r
704 0, // Offset32\r
705 0, // Offset64Lo\r
706 0 + 4, // Offset64Hi\r
707 FALSE // Writeable\r
708 }, // EFI_SMM_SAVE_STATE_REGISTER_LDTINFO = 10\r
709\r
710 {\r
711 4, // Width32\r
712 4, // Width64\r
713 SMM_CPU_OFFSET (x86._ES), // Offset32\r
714 SMM_CPU_OFFSET (x64._ES), // Offset64Lo\r
715 0, // Offset64Hi\r
716 FALSE // Writeable\r
717 }, // EFI_SMM_SAVE_STATE_REGISTER_ES = 20\r
718\r
719 {\r
720 4, // Width32\r
721 4, // Width64\r
722 SMM_CPU_OFFSET (x86._CS), // Offset32\r
723 SMM_CPU_OFFSET (x64._CS), // Offset64Lo\r
724 0, // Offset64Hi\r
725 FALSE // Writeable\r
726 }, // EFI_SMM_SAVE_STATE_REGISTER_CS = 21\r
727\r
728 {\r
729 4, // Width32\r
730 4, // Width64\r
731 SMM_CPU_OFFSET (x86._SS), // Offset32\r
732 SMM_CPU_OFFSET (x64._SS), // Offset64Lo\r
733 0, // Offset64Hi\r
734 FALSE // Writeable\r
735 }, // EFI_SMM_SAVE_STATE_REGISTER_SS = 22\r
736\r
737 {\r
738 4, // Width32\r
739 4, // Width64\r
740 SMM_CPU_OFFSET (x86._DS), // Offset32\r
741 SMM_CPU_OFFSET (x64._DS), // Offset64Lo\r
742 0, // Offset64Hi\r
743 FALSE // Writeable\r
744 }, // EFI_SMM_SAVE_STATE_REGISTER_DS = 23\r
745\r
746 {\r
747 4, // Width32\r
748 4, // Width64\r
749 SMM_CPU_OFFSET (x86._FS), // Offset32\r
750 SMM_CPU_OFFSET (x64._FS), // Offset64Lo\r
751 0, // Offset64Hi\r
752 FALSE // Writeable\r
753 }, // EFI_SMM_SAVE_STATE_REGISTER_FS = 24\r
754\r
755 {\r
756 4, // Width32\r
757 4, // Width64\r
758 SMM_CPU_OFFSET (x86._GS), // Offset32\r
759 SMM_CPU_OFFSET (x64._GS), // Offset64Lo\r
760 0, // Offset64Hi\r
761 FALSE // Writeable\r
762 }, // EFI_SMM_SAVE_STATE_REGISTER_GS = 25\r
763\r
764 {\r
765 0, // Width32\r
766 4, // Width64\r
767 0, // Offset32\r
768 SMM_CPU_OFFSET (x64._LDTR), // Offset64Lo\r
769 0, // Offset64Hi\r
770 FALSE // Writeable\r
771 }, // EFI_SMM_SAVE_STATE_REGISTER_LDTR_SEL = 26\r
772\r
773 {\r
774 4, // Width32\r
775 4, // Width64\r
776 SMM_CPU_OFFSET (x86._TR), // Offset32\r
777 SMM_CPU_OFFSET (x64._TR), // Offset64Lo\r
778 0, // Offset64Hi\r
779 FALSE // Writeable\r
780 }, // EFI_SMM_SAVE_STATE_REGISTER_TR_SEL = 27\r
781\r
782 {\r
783 4, // Width32\r
784 8, // Width64\r
785 SMM_CPU_OFFSET (x86._DR7), // Offset32\r
786 SMM_CPU_OFFSET (x64._DR7), // Offset64Lo\r
787 SMM_CPU_OFFSET (x64._DR7) + 4, // Offset64Hi\r
788 FALSE // Writeable\r
789 }, // EFI_SMM_SAVE_STATE_REGISTER_DR7 = 28\r
790\r
791 {\r
792 4, // Width32\r
793 8, // Width64\r
794 SMM_CPU_OFFSET (x86._DR6), // Offset32\r
795 SMM_CPU_OFFSET (x64._DR6), // Offset64Lo\r
796 SMM_CPU_OFFSET (x64._DR6) + 4, // Offset64Hi\r
797 FALSE // Writeable\r
798 }, // EFI_SMM_SAVE_STATE_REGISTER_DR6 = 29\r
799\r
800 {\r
801 0, // Width32\r
802 8, // Width64\r
803 0, // Offset32\r
804 SMM_CPU_OFFSET (x64._R8), // Offset64Lo\r
805 SMM_CPU_OFFSET (x64._R8) + 4, // Offset64Hi\r
806 TRUE // Writeable\r
807 }, // EFI_SMM_SAVE_STATE_REGISTER_R8 = 30\r
808\r
809 {\r
810 0, // Width32\r
811 8, // Width64\r
812 0, // Offset32\r
813 SMM_CPU_OFFSET (x64._R9), // Offset64Lo\r
814 SMM_CPU_OFFSET (x64._R9) + 4, // Offset64Hi\r
815 TRUE // Writeable\r
816 }, // EFI_SMM_SAVE_STATE_REGISTER_R9 = 31\r
817\r
818 {\r
819 0, // Width32\r
820 8, // Width64\r
821 0, // Offset32\r
822 SMM_CPU_OFFSET (x64._R10), // Offset64Lo\r
823 SMM_CPU_OFFSET (x64._R10) + 4, // Offset64Hi\r
824 TRUE // Writeable\r
825 }, // EFI_SMM_SAVE_STATE_REGISTER_R10 = 32\r
826\r
827 {\r
828 0, // Width32\r
829 8, // Width64\r
830 0, // Offset32\r
831 SMM_CPU_OFFSET (x64._R11), // Offset64Lo\r
832 SMM_CPU_OFFSET (x64._R11) + 4, // Offset64Hi\r
833 TRUE // Writeable\r
834 }, // EFI_SMM_SAVE_STATE_REGISTER_R11 = 33\r
835\r
836 {\r
837 0, // Width32\r
838 8, // Width64\r
839 0, // Offset32\r
840 SMM_CPU_OFFSET (x64._R12), // Offset64Lo\r
841 SMM_CPU_OFFSET (x64._R12) + 4, // Offset64Hi\r
842 TRUE // Writeable\r
843 }, // EFI_SMM_SAVE_STATE_REGISTER_R12 = 34\r
844\r
845 {\r
846 0, // Width32\r
847 8, // Width64\r
848 0, // Offset32\r
849 SMM_CPU_OFFSET (x64._R13), // Offset64Lo\r
850 SMM_CPU_OFFSET (x64._R13) + 4, // Offset64Hi\r
851 TRUE // Writeable\r
852 }, // EFI_SMM_SAVE_STATE_REGISTER_R13 = 35\r
853\r
854 {\r
855 0, // Width32\r
856 8, // Width64\r
857 0, // Offset32\r
858 SMM_CPU_OFFSET (x64._R14), // Offset64Lo\r
859 SMM_CPU_OFFSET (x64._R14) + 4, // Offset64Hi\r
860 TRUE // Writeable\r
861 }, // EFI_SMM_SAVE_STATE_REGISTER_R14 = 36\r
862\r
863 {\r
864 0, // Width32\r
865 8, // Width64\r
866 0, // Offset32\r
867 SMM_CPU_OFFSET (x64._R15), // Offset64Lo\r
868 SMM_CPU_OFFSET (x64._R15) + 4, // Offset64Hi\r
869 TRUE // Writeable\r
870 }, // EFI_SMM_SAVE_STATE_REGISTER_R15 = 37\r
871\r
872 {\r
873 4, // Width32\r
874 8, // Width64\r
875 SMM_CPU_OFFSET (x86._EAX), // Offset32\r
876 SMM_CPU_OFFSET (x64._RAX), // Offset64Lo\r
877 SMM_CPU_OFFSET (x64._RAX) + 4, // Offset64Hi\r
878 TRUE // Writeable\r
879 }, // EFI_SMM_SAVE_STATE_REGISTER_RAX = 38\r
880\r
881 {\r
882 4, // Width32\r
883 8, // Width64\r
884 SMM_CPU_OFFSET (x86._EBX), // Offset32\r
885 SMM_CPU_OFFSET (x64._RBX), // Offset64Lo\r
886 SMM_CPU_OFFSET (x64._RBX) + 4, // Offset64Hi\r
887 TRUE // Writeable\r
888 }, // EFI_SMM_SAVE_STATE_REGISTER_RBX = 39\r
889\r
890 {\r
891 4, // Width32\r
892 8, // Width64\r
893 SMM_CPU_OFFSET (x86._ECX), // Offset32\r
894 SMM_CPU_OFFSET (x64._RCX), // Offset64Lo\r
895 SMM_CPU_OFFSET (x64._RCX) + 4, // Offset64Hi\r
896 TRUE // Writeable\r
897 }, // EFI_SMM_SAVE_STATE_REGISTER_RCX = 40\r
898\r
899 {\r
900 4, // Width32\r
901 8, // Width64\r
902 SMM_CPU_OFFSET (x86._EDX), // Offset32\r
903 SMM_CPU_OFFSET (x64._RDX), // Offset64Lo\r
904 SMM_CPU_OFFSET (x64._RDX) + 4, // Offset64Hi\r
905 TRUE // Writeable\r
906 }, // EFI_SMM_SAVE_STATE_REGISTER_RDX = 41\r
907\r
908 {\r
909 4, // Width32\r
910 8, // Width64\r
911 SMM_CPU_OFFSET (x86._ESP), // Offset32\r
912 SMM_CPU_OFFSET (x64._RSP), // Offset64Lo\r
913 SMM_CPU_OFFSET (x64._RSP) + 4, // Offset64Hi\r
914 TRUE // Writeable\r
915 }, // EFI_SMM_SAVE_STATE_REGISTER_RSP = 42\r
916\r
917 {\r
918 4, // Width32\r
919 8, // Width64\r
920 SMM_CPU_OFFSET (x86._EBP), // Offset32\r
921 SMM_CPU_OFFSET (x64._RBP), // Offset64Lo\r
922 SMM_CPU_OFFSET (x64._RBP) + 4, // Offset64Hi\r
923 TRUE // Writeable\r
924 }, // EFI_SMM_SAVE_STATE_REGISTER_RBP = 43\r
925\r
926 {\r
927 4, // Width32\r
928 8, // Width64\r
929 SMM_CPU_OFFSET (x86._ESI), // Offset32\r
930 SMM_CPU_OFFSET (x64._RSI), // Offset64Lo\r
931 SMM_CPU_OFFSET (x64._RSI) + 4, // Offset64Hi\r
932 TRUE // Writeable\r
933 }, // EFI_SMM_SAVE_STATE_REGISTER_RSI = 44\r
934\r
935 {\r
936 4, // Width32\r
937 8, // Width64\r
938 SMM_CPU_OFFSET (x86._EDI), // Offset32\r
939 SMM_CPU_OFFSET (x64._RDI), // Offset64Lo\r
940 SMM_CPU_OFFSET (x64._RDI) + 4, // Offset64Hi\r
941 TRUE // Writeable\r
942 }, // EFI_SMM_SAVE_STATE_REGISTER_RDI = 45\r
943\r
944 {\r
945 4, // Width32\r
946 8, // Width64\r
947 SMM_CPU_OFFSET (x86._EIP), // Offset32\r
948 SMM_CPU_OFFSET (x64._RIP), // Offset64Lo\r
949 SMM_CPU_OFFSET (x64._RIP) + 4, // Offset64Hi\r
950 TRUE // Writeable\r
951 }, // EFI_SMM_SAVE_STATE_REGISTER_RIP = 46\r
952\r
953 {\r
954 4, // Width32\r
955 8, // Width64\r
956 SMM_CPU_OFFSET (x86._EFLAGS), // Offset32\r
957 SMM_CPU_OFFSET (x64._RFLAGS), // Offset64Lo\r
958 SMM_CPU_OFFSET (x64._RFLAGS) + 4, // Offset64Hi\r
959 TRUE // Writeable\r
960 }, // EFI_SMM_SAVE_STATE_REGISTER_RFLAGS = 51\r
961\r
962 {\r
963 4, // Width32\r
964 8, // Width64\r
965 SMM_CPU_OFFSET (x86._CR0), // Offset32\r
966 SMM_CPU_OFFSET (x64._CR0), // Offset64Lo\r
967 SMM_CPU_OFFSET (x64._CR0) + 4, // Offset64Hi\r
968 FALSE // Writeable\r
969 }, // EFI_SMM_SAVE_STATE_REGISTER_CR0 = 52\r
970\r
971 {\r
972 4, // Width32\r
973 8, // Width64\r
974 SMM_CPU_OFFSET (x86._CR3), // Offset32\r
975 SMM_CPU_OFFSET (x64._CR3), // Offset64Lo\r
976 SMM_CPU_OFFSET (x64._CR3) + 4, // Offset64Hi\r
977 FALSE // Writeable\r
978 }, // EFI_SMM_SAVE_STATE_REGISTER_CR3 = 53\r
979\r
980 {\r
981 0, // Width32\r
982 4, // Width64\r
983 0, // Offset32\r
984 SMM_CPU_OFFSET (x64._CR4), // Offset64Lo\r
985 SMM_CPU_OFFSET (x64._CR4) + 4, // Offset64Hi\r
986 FALSE // Writeable\r
987 }, // EFI_SMM_SAVE_STATE_REGISTER_CR4 = 54\r
4036b4e5
PB
988};\r
989\r
990//\r
991// No support for I/O restart\r
992//\r
993\r
994/**\r
995 Read information from the CPU save state.\r
996\r
997 @param Register Specifies the CPU register to read form the save state.\r
998\r
999 @retval 0 Register is not valid\r
1000 @retval >0 Index into mSmmCpuWidthOffset[] associated with Register\r
1001\r
1002**/\r
ea992760
LE
1003STATIC\r
1004UINTN\r
4036b4e5
PB
1005GetRegisterIndex (\r
1006 IN EFI_SMM_SAVE_STATE_REGISTER Register\r
1007 )\r
1008{\r
1009 UINTN Index;\r
1010 UINTN Offset;\r
1011\r
b1bfdd65
LE
1012 for (Index = 0, Offset = SMM_SAVE_STATE_REGISTER_FIRST_INDEX;\r
1013 mSmmCpuRegisterRanges[Index].Length != 0;\r
ac0a286f
MK
1014 Index++)\r
1015 {\r
1016 if ((Register >= mSmmCpuRegisterRanges[Index].Start) &&\r
1017 (Register <= mSmmCpuRegisterRanges[Index].End))\r
1018 {\r
4036b4e5
PB
1019 return Register - mSmmCpuRegisterRanges[Index].Start + Offset;\r
1020 }\r
ac0a286f 1021\r
4036b4e5
PB
1022 Offset += mSmmCpuRegisterRanges[Index].Length;\r
1023 }\r
ac0a286f 1024\r
4036b4e5
PB
1025 return 0;\r
1026}\r
1027\r
1028/**\r
1029 Read a CPU Save State register on the target processor.\r
1030\r
b1bfdd65
LE
1031 This function abstracts the differences that whether the CPU Save State\r
1032 register is in the IA32 CPU Save State Map or X64 CPU Save State Map.\r
4036b4e5 1033\r
b1bfdd65
LE
1034 This function supports reading a CPU Save State register in SMBase relocation\r
1035 handler.\r
4036b4e5 1036\r
b1bfdd65
LE
1037 @param[in] CpuIndex Specifies the zero-based index of the CPU save\r
1038 state.\r
4036b4e5 1039 @param[in] RegisterIndex Index into mSmmCpuWidthOffset[] look up table.\r
b1bfdd65
LE
1040 @param[in] Width The number of bytes to read from the CPU save\r
1041 state.\r
1042 @param[out] Buffer Upon return, this holds the CPU register value\r
1043 read from the save state.\r
4036b4e5
PB
1044\r
1045 @retval EFI_SUCCESS The register was read from Save State.\r
b1bfdd65
LE
1046 @retval EFI_NOT_FOUND The register is not defined for the Save State\r
1047 of Processor.\r
4036b4e5
PB
1048 @retval EFI_INVALID_PARAMTER This or Buffer is NULL.\r
1049\r
1050**/\r
ea992760
LE
1051STATIC\r
1052EFI_STATUS\r
4036b4e5 1053ReadSaveStateRegisterByIndex (\r
ac0a286f
MK
1054 IN UINTN CpuIndex,\r
1055 IN UINTN RegisterIndex,\r
1056 IN UINTN Width,\r
1057 OUT VOID *Buffer\r
4036b4e5
PB
1058 )\r
1059{\r
c1fcd80b 1060 QEMU_SMRAM_SAVE_STATE_MAP *CpuSaveState;\r
4036b4e5 1061\r
c1fcd80b 1062 CpuSaveState = (QEMU_SMRAM_SAVE_STATE_MAP *)gSmst->CpuSaveState[CpuIndex];\r
4036b4e5
PB
1063\r
1064 if ((CpuSaveState->x86.SMMRevId & 0xFFFF) == 0) {\r
1065 //\r
b1bfdd65
LE
1066 // If 32-bit mode width is zero, then the specified register can not be\r
1067 // accessed\r
4036b4e5
PB
1068 //\r
1069 if (mSmmCpuWidthOffset[RegisterIndex].Width32 == 0) {\r
1070 return EFI_NOT_FOUND;\r
1071 }\r
1072\r
1073 //\r
b1bfdd65
LE
1074 // If Width is bigger than the 32-bit mode width, then the specified\r
1075 // register can not be accessed\r
4036b4e5
PB
1076 //\r
1077 if (Width > mSmmCpuWidthOffset[RegisterIndex].Width32) {\r
1078 return EFI_INVALID_PARAMETER;\r
1079 }\r
1080\r
1081 //\r
1082 // Write return buffer\r
1083 //\r
ac0a286f 1084 ASSERT (CpuSaveState != NULL);\r
b1bfdd65
LE
1085 CopyMem (\r
1086 Buffer,\r
1087 (UINT8 *)CpuSaveState + mSmmCpuWidthOffset[RegisterIndex].Offset32,\r
1088 Width\r
1089 );\r
4036b4e5
PB
1090 } else {\r
1091 //\r
b1bfdd65
LE
1092 // If 64-bit mode width is zero, then the specified register can not be\r
1093 // accessed\r
4036b4e5
PB
1094 //\r
1095 if (mSmmCpuWidthOffset[RegisterIndex].Width64 == 0) {\r
1096 return EFI_NOT_FOUND;\r
1097 }\r
1098\r
1099 //\r
b1bfdd65
LE
1100 // If Width is bigger than the 64-bit mode width, then the specified\r
1101 // register can not be accessed\r
4036b4e5
PB
1102 //\r
1103 if (Width > mSmmCpuWidthOffset[RegisterIndex].Width64) {\r
1104 return EFI_INVALID_PARAMETER;\r
1105 }\r
1106\r
1107 //\r
1108 // Write lower 32-bits of return buffer\r
1109 //\r
b1bfdd65
LE
1110 CopyMem (\r
1111 Buffer,\r
1112 (UINT8 *)CpuSaveState + mSmmCpuWidthOffset[RegisterIndex].Offset64Lo,\r
1113 MIN (4, Width)\r
1114 );\r
4036b4e5
PB
1115 if (Width >= 4) {\r
1116 //\r
1117 // Write upper 32-bits of return buffer\r
1118 //\r
b1bfdd65
LE
1119 CopyMem (\r
1120 (UINT8 *)Buffer + 4,\r
1121 (UINT8 *)CpuSaveState + mSmmCpuWidthOffset[RegisterIndex].Offset64Hi,\r
1122 Width - 4\r
1123 );\r
4036b4e5
PB
1124 }\r
1125 }\r
ac0a286f 1126\r
4036b4e5
PB
1127 return EFI_SUCCESS;\r
1128}\r
1129\r
86d71589
PB
1130/**\r
1131 Read an SMM Save State register on the target processor. If this function\r
1132 returns EFI_UNSUPPORTED, then the caller is responsible for reading the\r
1133 SMM Save Sate register.\r
1134\r
1135 @param[in] CpuIndex The index of the CPU to read the SMM Save State. The\r
1136 value must be between 0 and the NumberOfCpus field in\r
1137 the System Management System Table (SMST).\r
1138 @param[in] Register The SMM Save State register to read.\r
1139 @param[in] Width The number of bytes to read from the CPU save state.\r
1140 @param[out] Buffer Upon return, this holds the CPU register value read\r
1141 from the save state.\r
1142\r
1143 @retval EFI_SUCCESS The register was read from Save State.\r
1144 @retval EFI_INVALID_PARAMTER Buffer is NULL.\r
b1bfdd65
LE
1145 @retval EFI_UNSUPPORTED This function does not support reading\r
1146 Register.\r
86d71589
PB
1147**/\r
1148EFI_STATUS\r
1149EFIAPI\r
1150SmmCpuFeaturesReadSaveStateRegister (\r
1151 IN UINTN CpuIndex,\r
1152 IN EFI_SMM_SAVE_STATE_REGISTER Register,\r
1153 IN UINTN Width,\r
1154 OUT VOID *Buffer\r
1155 )\r
1156{\r
ac0a286f 1157 UINTN RegisterIndex;\r
c1fcd80b 1158 QEMU_SMRAM_SAVE_STATE_MAP *CpuSaveState;\r
4036b4e5
PB
1159\r
1160 //\r
1161 // Check for special EFI_SMM_SAVE_STATE_REGISTER_LMA\r
1162 //\r
1163 if (Register == EFI_SMM_SAVE_STATE_REGISTER_LMA) {\r
1164 //\r
1165 // Only byte access is supported for this register\r
1166 //\r
1167 if (Width != 1) {\r
1168 return EFI_INVALID_PARAMETER;\r
1169 }\r
1170\r
c1fcd80b 1171 CpuSaveState = (QEMU_SMRAM_SAVE_STATE_MAP *)gSmst->CpuSaveState[CpuIndex];\r
4036b4e5
PB
1172\r
1173 //\r
1174 // Check CPU mode\r
1175 //\r
1176 if ((CpuSaveState->x86.SMMRevId & 0xFFFF) == 0) {\r
1177 *(UINT8 *)Buffer = 32;\r
1178 } else {\r
1179 *(UINT8 *)Buffer = 64;\r
1180 }\r
1181\r
1182 return EFI_SUCCESS;\r
1183 }\r
1184\r
1185 //\r
1186 // Check for special EFI_SMM_SAVE_STATE_REGISTER_IO\r
1187 //\r
1188 if (Register == EFI_SMM_SAVE_STATE_REGISTER_IO) {\r
1189 return EFI_NOT_FOUND;\r
1190 }\r
1191\r
1192 //\r
1193 // Convert Register to a register lookup table index. Let\r
1194 // PiSmmCpuDxeSmm implement other special registers (currently\r
1195 // there is only EFI_SMM_SAVE_STATE_REGISTER_PROCESSOR_ID).\r
1196 //\r
1197 RegisterIndex = GetRegisterIndex (Register);\r
1198 if (RegisterIndex == 0) {\r
b1bfdd65
LE
1199 return (Register < EFI_SMM_SAVE_STATE_REGISTER_IO ?\r
1200 EFI_NOT_FOUND :\r
1201 EFI_UNSUPPORTED);\r
4036b4e5
PB
1202 }\r
1203\r
1204 return ReadSaveStateRegisterByIndex (CpuIndex, RegisterIndex, Width, Buffer);\r
86d71589
PB
1205}\r
1206\r
1207/**\r
1208 Writes an SMM Save State register on the target processor. If this function\r
1209 returns EFI_UNSUPPORTED, then the caller is responsible for writing the\r
1210 SMM Save Sate register.\r
1211\r
1212 @param[in] CpuIndex The index of the CPU to write the SMM Save State. The\r
1213 value must be between 0 and the NumberOfCpus field in\r
1214 the System Management System Table (SMST).\r
1215 @param[in] Register The SMM Save State register to write.\r
1216 @param[in] Width The number of bytes to write to the CPU save state.\r
1217 @param[in] Buffer Upon entry, this holds the new CPU register value.\r
1218\r
1219 @retval EFI_SUCCESS The register was written to Save State.\r
1220 @retval EFI_INVALID_PARAMTER Buffer is NULL.\r
b1bfdd65
LE
1221 @retval EFI_UNSUPPORTED This function does not support writing\r
1222 Register.\r
86d71589
PB
1223**/\r
1224EFI_STATUS\r
1225EFIAPI\r
1226SmmCpuFeaturesWriteSaveStateRegister (\r
1227 IN UINTN CpuIndex,\r
1228 IN EFI_SMM_SAVE_STATE_REGISTER Register,\r
1229 IN UINTN Width,\r
1230 IN CONST VOID *Buffer\r
1231 )\r
1232{\r
ac0a286f 1233 UINTN RegisterIndex;\r
c1fcd80b 1234 QEMU_SMRAM_SAVE_STATE_MAP *CpuSaveState;\r
4036b4e5
PB
1235\r
1236 //\r
1237 // Writes to EFI_SMM_SAVE_STATE_REGISTER_LMA are ignored\r
1238 //\r
1239 if (Register == EFI_SMM_SAVE_STATE_REGISTER_LMA) {\r
1240 return EFI_SUCCESS;\r
1241 }\r
1242\r
1243 //\r
1244 // Writes to EFI_SMM_SAVE_STATE_REGISTER_IO are not supported\r
1245 //\r
1246 if (Register == EFI_SMM_SAVE_STATE_REGISTER_IO) {\r
1247 return EFI_NOT_FOUND;\r
1248 }\r
1249\r
1250 //\r
1251 // Convert Register to a register lookup table index. Let\r
1252 // PiSmmCpuDxeSmm implement other special registers (currently\r
1253 // there is only EFI_SMM_SAVE_STATE_REGISTER_PROCESSOR_ID).\r
1254 //\r
1255 RegisterIndex = GetRegisterIndex (Register);\r
1256 if (RegisterIndex == 0) {\r
b1bfdd65
LE
1257 return (Register < EFI_SMM_SAVE_STATE_REGISTER_IO ?\r
1258 EFI_NOT_FOUND :\r
1259 EFI_UNSUPPORTED);\r
4036b4e5
PB
1260 }\r
1261\r
c1fcd80b 1262 CpuSaveState = (QEMU_SMRAM_SAVE_STATE_MAP *)gSmst->CpuSaveState[CpuIndex];\r
4036b4e5
PB
1263\r
1264 //\r
1265 // Do not write non-writable SaveState, because it will cause exception.\r
b1bfdd65 1266 //\r
4036b4e5
PB
1267 if (!mSmmCpuWidthOffset[RegisterIndex].Writeable) {\r
1268 return EFI_UNSUPPORTED;\r
1269 }\r
1270\r
1271 //\r
1272 // Check CPU mode\r
1273 //\r
1274 if ((CpuSaveState->x86.SMMRevId & 0xFFFF) == 0) {\r
1275 //\r
b1bfdd65
LE
1276 // If 32-bit mode width is zero, then the specified register can not be\r
1277 // accessed\r
4036b4e5
PB
1278 //\r
1279 if (mSmmCpuWidthOffset[RegisterIndex].Width32 == 0) {\r
1280 return EFI_NOT_FOUND;\r
1281 }\r
1282\r
1283 //\r
b1bfdd65
LE
1284 // If Width is bigger than the 32-bit mode width, then the specified\r
1285 // register can not be accessed\r
4036b4e5
PB
1286 //\r
1287 if (Width > mSmmCpuWidthOffset[RegisterIndex].Width32) {\r
1288 return EFI_INVALID_PARAMETER;\r
1289 }\r
ac0a286f 1290\r
4036b4e5
PB
1291 //\r
1292 // Write SMM State register\r
1293 //\r
1294 ASSERT (CpuSaveState != NULL);\r
b1bfdd65
LE
1295 CopyMem (\r
1296 (UINT8 *)CpuSaveState + mSmmCpuWidthOffset[RegisterIndex].Offset32,\r
1297 Buffer,\r
1298 Width\r
1299 );\r
4036b4e5
PB
1300 } else {\r
1301 //\r
b1bfdd65
LE
1302 // If 64-bit mode width is zero, then the specified register can not be\r
1303 // accessed\r
4036b4e5
PB
1304 //\r
1305 if (mSmmCpuWidthOffset[RegisterIndex].Width64 == 0) {\r
1306 return EFI_NOT_FOUND;\r
1307 }\r
1308\r
1309 //\r
b1bfdd65
LE
1310 // If Width is bigger than the 64-bit mode width, then the specified\r
1311 // register can not be accessed\r
4036b4e5
PB
1312 //\r
1313 if (Width > mSmmCpuWidthOffset[RegisterIndex].Width64) {\r
1314 return EFI_INVALID_PARAMETER;\r
1315 }\r
1316\r
1317 //\r
1318 // Write lower 32-bits of SMM State register\r
1319 //\r
b1bfdd65
LE
1320 CopyMem (\r
1321 (UINT8 *)CpuSaveState + mSmmCpuWidthOffset[RegisterIndex].Offset64Lo,\r
1322 Buffer,\r
1323 MIN (4, Width)\r
1324 );\r
4036b4e5
PB
1325 if (Width >= 4) {\r
1326 //\r
1327 // Write upper 32-bits of SMM State register\r
1328 //\r
b1bfdd65
LE
1329 CopyMem (\r
1330 (UINT8 *)CpuSaveState + mSmmCpuWidthOffset[RegisterIndex].Offset64Hi,\r
1331 (UINT8 *)Buffer + 4,\r
1332 Width - 4\r
1333 );\r
4036b4e5
PB
1334 }\r
1335 }\r
ac0a286f 1336\r
4036b4e5 1337 return EFI_SUCCESS;\r
86d71589
PB
1338}\r
1339\r
1340/**\r
1341 This function is hook point called after the gEfiSmmReadyToLockProtocolGuid\r
1342 notification is completely processed.\r
1343**/\r
1344VOID\r
1345EFIAPI\r
1346SmmCpuFeaturesCompleteSmmReadyToLock (\r
1347 VOID\r
1348 )\r
1349{\r
1350}\r
1351\r
1352/**\r
b1bfdd65
LE
1353 This API provides a method for a CPU to allocate a specific region for\r
1354 storing page tables.\r
86d71589
PB
1355\r
1356 This API can be called more once to allocate memory for page tables.\r
1357\r
b1bfdd65
LE
1358 Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns\r
1359 a pointer to the allocated buffer. The buffer returned is aligned on a 4KB\r
1360 boundary. If Pages is 0, then NULL is returned. If there is not enough\r
1361 memory remaining to satisfy the request, then NULL is returned.\r
86d71589 1362\r
b1bfdd65
LE
1363 This function can also return NULL if there is no preference on where the\r
1364 page tables are allocated in SMRAM.\r
86d71589
PB
1365\r
1366 @param Pages The number of 4 KB pages to allocate.\r
1367\r
1368 @return A pointer to the allocated buffer for page tables.\r
1369 @retval NULL Fail to allocate a specific region for storing page tables,\r
b1bfdd65
LE
1370 Or there is no preference on where the page tables are\r
1371 allocated in SMRAM.\r
86d71589
PB
1372\r
1373**/\r
1374VOID *\r
1375EFIAPI\r
1376SmmCpuFeaturesAllocatePageTableMemory (\r
ac0a286f 1377 IN UINTN Pages\r
86d71589
PB
1378 )\r
1379{\r
1380 return NULL;\r
1381}\r