]> git.proxmox.com Git - mirror_edk2.git/blame - UefiCpuPkg/Universal/Acpi/S3Resume2Pei/S3Resume.c
MdeModulePkg PiSmmCore: Register SMI handler to install S3SmmInitDone
[mirror_edk2.git] / UefiCpuPkg / Universal / Acpi / S3Resume2Pei / S3Resume.c
CommitLineData
1f569620 1/** @file\r
e48e0742 2 This module produces the EFI_PEI_S3_RESUME2_PPI.\r
1f569620 3 This module works with StandAloneBootScriptExecutor to S3 resume to OS.\r
438f1766 4 This module will execute the boot script saved during last boot and after that,\r
1f569620 5 control is passed to OS waking up handler.\r
6\r
582e4e44 7 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
787a085b 8 Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>\r
1f569620 9\r
10 This program and the accompanying materials\r
11 are licensed and made available under the terms and conditions\r
12 of the BSD License which accompanies this distribution. The\r
13 full text of the license may be found at\r
14 http://opensource.org/licenses/bsd-license.php\r
15\r
16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
18\r
19**/\r
20\r
21#include <PiPei.h>\r
22\r
23#include <Guid/AcpiS3Context.h>\r
24#include <Guid/BootScriptExecutorVariable.h>\r
582e4e44 25#include <Guid/ExtendedFirmwarePerformance.h>\r
a85e7127 26#include <Guid/EndOfS3Resume.h>\r
1f569620 27#include <Ppi/ReadOnlyVariable2.h>\r
28#include <Ppi/S3Resume2.h>\r
29#include <Ppi/SmmAccess.h>\r
30#include <Ppi/PostBootScriptTable.h>\r
31#include <Ppi/EndOfPeiPhase.h>\r
18b13fab
ED
32#include <Ppi/SmmCommunication.h>\r
33\r
1f569620 34#include <Library/DebugLib.h>\r
35#include <Library/BaseLib.h>\r
36#include <Library/TimerLib.h>\r
37#include <Library/PeimEntryPoint.h>\r
38#include <Library/PeiServicesLib.h>\r
39#include <Library/HobLib.h>\r
40#include <Library/PerformanceLib.h>\r
41#include <Library/PeiServicesTablePointerLib.h>\r
42#include <Library/IoLib.h>\r
43#include <Library/BaseMemoryLib.h>\r
44#include <Library/MemoryAllocationLib.h>\r
45#include <Library/PcdLib.h>\r
46#include <Library/DebugAgentLib.h>\r
47#include <Library/LocalApicLib.h>\r
48#include <Library/ReportStatusCodeLib.h>\r
49#include <Library/PrintLib.h>\r
c56b6566 50#include <Library/HobLib.h>\r
1f569620 51#include <Library/LockBoxLib.h>\r
52#include <IndustryStandard/Acpi.h>\r
53\r
f98f5ec3
LE
54/**\r
55 This macro aligns the address of a variable with auto storage\r
56 duration down to CPU_STACK_ALIGNMENT.\r
57\r
58 Since the stack grows downward, the result preserves more of the\r
59 stack than the original address (or the same amount), not less.\r
60**/\r
61#define STACK_ALIGN_DOWN(Ptr) \\r
62 ((UINTN)(Ptr) & ~(UINTN)(CPU_STACK_ALIGNMENT - 1))\r
63\r
787a085b
LD
64#define PAGING_1G_ADDRESS_MASK_64 0x000FFFFFC0000000ull\r
65\r
1f569620 66#pragma pack(1)\r
67typedef union {\r
68 struct {\r
69 UINT32 LimitLow : 16;\r
70 UINT32 BaseLow : 16;\r
71 UINT32 BaseMid : 8;\r
72 UINT32 Type : 4;\r
73 UINT32 System : 1;\r
74 UINT32 Dpl : 2;\r
75 UINT32 Present : 1;\r
76 UINT32 LimitHigh : 4;\r
77 UINT32 Software : 1;\r
78 UINT32 Reserved : 1;\r
79 UINT32 DefaultSize : 1;\r
80 UINT32 Granularity : 1;\r
81 UINT32 BaseHigh : 8;\r
82 } Bits;\r
83 UINT64 Uint64;\r
84} IA32_GDT;\r
85\r
86//\r
87// Page-Map Level-4 Offset (PML4) and\r
88// Page-Directory-Pointer Offset (PDPE) entries 4K & 2MB\r
89//\r
90typedef union {\r
91 struct {\r
92 UINT64 Present:1; // 0 = Not present in memory, 1 = Present in memory\r
93 UINT64 ReadWrite:1; // 0 = Read-Only, 1= Read/Write\r
94 UINT64 UserSupervisor:1; // 0 = Supervisor, 1=User\r
95 UINT64 WriteThrough:1; // 0 = Write-Back caching, 1=Write-Through caching\r
96 UINT64 CacheDisabled:1; // 0 = Cached, 1=Non-Cached\r
97 UINT64 Accessed:1; // 0 = Not accessed, 1 = Accessed (set by CPU)\r
98 UINT64 Reserved:1; // Reserved\r
99 UINT64 MustBeZero:2; // Must Be Zero\r
100 UINT64 Available:3; // Available for use by system software\r
101 UINT64 PageTableBaseAddress:40; // Page Table Base Address\r
102 UINT64 AvabilableHigh:11; // Available for use by system software\r
103 UINT64 Nx:1; // No Execute bit\r
104 } Bits;\r
105 UINT64 Uint64;\r
106} PAGE_MAP_AND_DIRECTORY_POINTER;\r
107\r
108//\r
109// Page Table Entry 2MB\r
110//\r
111typedef union {\r
112 struct {\r
113 UINT64 Present:1; // 0 = Not present in memory, 1 = Present in memory\r
114 UINT64 ReadWrite:1; // 0 = Read-Only, 1= Read/Write\r
115 UINT64 UserSupervisor:1; // 0 = Supervisor, 1=User\r
116 UINT64 WriteThrough:1; // 0 = Write-Back caching, 1=Write-Through caching\r
117 UINT64 CacheDisabled:1; // 0 = Cached, 1=Non-Cached\r
118 UINT64 Accessed:1; // 0 = Not accessed, 1 = Accessed (set by CPU)\r
119 UINT64 Dirty:1; // 0 = Not Dirty, 1 = written by processor on access to page\r
120 UINT64 MustBe1:1; // Must be 1 \r
121 UINT64 Global:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write\r
122 UINT64 Available:3; // Available for use by system software\r
123 UINT64 PAT:1; //\r
124 UINT64 MustBeZero:8; // Must be zero;\r
125 UINT64 PageTableBaseAddress:31; // Page Table Base Address\r
126 UINT64 AvabilableHigh:11; // Available for use by system software\r
127 UINT64 Nx:1; // 0 = Execute Code, 1 = No Code Execution\r
128 } Bits;\r
129 UINT64 Uint64;\r
130} PAGE_TABLE_ENTRY;\r
131\r
c56b6566
JY
132//\r
133// Page Table Entry 1GB\r
134//\r
135typedef union {\r
136 struct {\r
137 UINT64 Present:1; // 0 = Not present in memory, 1 = Present in memory\r
138 UINT64 ReadWrite:1; // 0 = Read-Only, 1= Read/Write\r
139 UINT64 UserSupervisor:1; // 0 = Supervisor, 1=User\r
140 UINT64 WriteThrough:1; // 0 = Write-Back caching, 1=Write-Through caching\r
141 UINT64 CacheDisabled:1; // 0 = Cached, 1=Non-Cached\r
142 UINT64 Accessed:1; // 0 = Not accessed, 1 = Accessed (set by CPU)\r
143 UINT64 Dirty:1; // 0 = Not Dirty, 1 = written by processor on access to page\r
144 UINT64 MustBe1:1; // Must be 1 \r
145 UINT64 Global:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write\r
146 UINT64 Available:3; // Available for use by system software\r
147 UINT64 PAT:1; //\r
148 UINT64 MustBeZero:17; // Must be zero;\r
149 UINT64 PageTableBaseAddress:22; // Page Table Base Address\r
150 UINT64 AvabilableHigh:11; // Available for use by system software\r
151 UINT64 Nx:1; // 0 = Execute Code, 1 = No Code Execution\r
152 } Bits;\r
153 UINT64 Uint64;\r
154} PAGE_TABLE_1G_ENTRY;\r
155\r
18b13fab
ED
156//\r
157// Define two type of smm communicate headers.\r
a85e7127 158// One for 32 bits PEI + 64 bits DXE, the other for 32 bits PEI + 32 bits DXE case.\r
18b13fab
ED
159//\r
160typedef struct {\r
161 EFI_GUID HeaderGuid;\r
162 UINT32 MessageLength;\r
163 UINT8 Data[1];\r
164} SMM_COMMUNICATE_HEADER_32;\r
165\r
166typedef struct {\r
167 EFI_GUID HeaderGuid;\r
168 UINT64 MessageLength;\r
169 UINT8 Data[1];\r
170} SMM_COMMUNICATE_HEADER_64;\r
171\r
1f569620 172#pragma pack()\r
173\r
174//\r
175// Function prototypes\r
176//\r
177/**\r
178 a ASM function to transfer control to OS.\r
179 \r
180 @param S3WakingVector The S3 waking up vector saved in ACPI Facs table\r
181 @param AcpiLowMemoryBase a buffer under 1M which could be used during the transfer \r
182**/\r
183typedef\r
184VOID\r
185(EFIAPI *ASM_TRANSFER_CONTROL) (\r
186 IN UINT32 S3WakingVector,\r
187 IN UINT32 AcpiLowMemoryBase\r
188 );\r
189\r
190/**\r
191 Restores the platform to its preboot configuration for an S3 resume and\r
192 jumps to the OS waking vector.\r
193\r
194 This function will restore the platform to its pre-boot configuration that was\r
195 pre-stored in the boot script table and transfer control to OS waking vector.\r
196 Upon invocation, this function is responsible for locating the following\r
197 information before jumping to OS waking vector:\r
198 - ACPI tables\r
199 - boot script table\r
200 - any other information that it needs\r
201\r
202 The S3RestoreConfig() function then executes the pre-stored boot script table\r
203 and transitions the platform to the pre-boot state. The boot script is recorded\r
204 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and\r
205 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function\r
206 transfers control to the OS waking vector. If the OS supports only a real-mode\r
207 waking vector, this function will switch from flat mode to real mode before\r
208 jumping to the waking vector. If all platform pre-boot configurations are\r
209 successfully restored and all other necessary information is ready, this\r
210 function will never return and instead will directly jump to the OS waking\r
211 vector. If this function returns, it indicates that the attempt to resume\r
212 from the ACPI S3 sleep state failed.\r
213\r
214 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI\r
215\r
216 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.\r
217 @retval EFI_NOT_FOUND Some necessary information that is used for the S3\r
218 resume boot path could not be located.\r
219\r
220**/\r
221EFI_STATUS\r
222EFIAPI\r
223S3RestoreConfig2 (\r
224 IN EFI_PEI_S3_RESUME2_PPI *This\r
225 );\r
226\r
abef469f 227/**\r
228 Set data segment selectors value including DS/ES/FS/GS/SS.\r
229\r
230 @param[in] SelectorValue Segment selector value to be set.\r
231\r
232**/\r
233VOID\r
234EFIAPI\r
235AsmSetDataSelectors (\r
236 IN UINT16 SelectorValue\r
237 );\r
238\r
1f569620 239//\r
240// Globals\r
241//\r
242EFI_PEI_S3_RESUME2_PPI mS3ResumePpi = { S3RestoreConfig2 };\r
243\r
244EFI_PEI_PPI_DESCRIPTOR mPpiList = {\r
245 (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
246 &gEfiPeiS3Resume2PpiGuid,\r
247 &mS3ResumePpi\r
248};\r
249\r
250EFI_PEI_PPI_DESCRIPTOR mPpiListPostScriptTable = {\r
251 (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
252 &gPeiPostScriptTablePpiGuid,\r
253 0\r
254};\r
255\r
256EFI_PEI_PPI_DESCRIPTOR mPpiListEndOfPeiTable = {\r
257 (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
258 &gEfiEndOfPeiSignalPpiGuid,\r
259 0\r
260};\r
261\r
262//\r
263// Global Descriptor Table (GDT)\r
264//\r
265GLOBAL_REMOVE_IF_UNREFERENCED IA32_GDT mGdtEntries[] = {\r
266/* selector { Global Segment Descriptor } */\r
267/* 0x00 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},\r
268/* 0x08 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},\r
269/* 0x10 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 0, 1, 1, 0}},\r
270/* 0x18 */ {{0xFFFF, 0, 0, 0x3, 1, 0, 1, 0xF, 0, 0, 1, 1, 0}},\r
271/* 0x20 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},\r
272/* 0x28 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 0, 0, 1, 0}},\r
273/* 0x30 */ {{0xFFFF, 0, 0, 0x3, 1, 0, 1, 0xF, 0, 0, 0, 1, 0}},\r
274/* 0x38 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 1, 0, 1, 0}},\r
275/* 0x40 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},\r
276};\r
277\r
abef469f 278#define DATA_SEGEMENT_SELECTOR 0x18\r
279\r
1f569620 280//\r
281// IA32 Gdt register\r
282//\r
283GLOBAL_REMOVE_IF_UNREFERENCED CONST IA32_DESCRIPTOR mGdt = {\r
284 sizeof (mGdtEntries) - 1,\r
285 (UINTN) mGdtEntries\r
286 };\r
287\r
1f569620 288\r
d0bf5623
JY
289/**\r
290 The function will check if current waking vector is long mode.\r
291\r
292 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT\r
293\r
294 @retval TRUE Current context need long mode waking vector.\r
295 @retval FALSE Current context need not long mode waking vector.\r
296**/\r
297BOOLEAN\r
298IsLongModeWakingVector (\r
299 IN ACPI_S3_CONTEXT *AcpiS3Context\r
300 )\r
301{\r
302 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs;\r
303\r
304 Facs = (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable));\r
305 if ((Facs == NULL) ||\r
306 (Facs->Signature != EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) ||\r
307 ((Facs->FirmwareWakingVector == 0) && (Facs->XFirmwareWakingVector == 0)) ) {\r
308 // Something wrong with FACS\r
309 return FALSE;\r
310 }\r
311 if (Facs->XFirmwareWakingVector != 0) {\r
312 if ((Facs->Version == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION) &&\r
313 ((Facs->Flags & EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F) != 0) &&\r
314 ((Facs->Flags & EFI_ACPI_4_0_OSPM_64BIT_WAKE__F) != 0)) {\r
315 // Both BIOS and OS wants 64bit vector\r
316 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
317 return TRUE;\r
318 }\r
319 }\r
320 }\r
321 return FALSE;\r
322}\r
323\r
18b13fab
ED
324/**\r
325 Send EndOfS3Resume event to SmmCore through communication buffer way.\r
326\r
327 @retval EFI_SUCCESS Return send the event success.\r
328**/\r
329EFI_STATUS\r
330SignalEndOfS3Resume (\r
331 VOID\r
332 )\r
333{\r
334 EFI_STATUS Status;\r
335 EFI_PEI_SMM_COMMUNICATION_PPI *SmmCommunicationPpi;\r
336 UINTN CommSize;\r
337 SMM_COMMUNICATE_HEADER_32 Header32;\r
338 SMM_COMMUNICATE_HEADER_64 Header64;\r
339 VOID *CommBuffer;\r
340\r
152e8d76 341 DEBUG ((DEBUG_INFO, "SignalEndOfS3Resume - Enter\n"));\r
18b13fab
ED
342\r
343 //\r
344 // This buffer consumed in DXE phase, so base on DXE mode to prepare communicate buffer.\r
345 // Detect whether DXE is 64 bits mode.\r
346 // if (sizeof(UINTN) == sizeof(UINT64), PEI already 64 bits, assume DXE also 64 bits.\r
a85e7127 347 // or (FeaturePcdGet (PcdDxeIplSwitchToLongMode)), DXE will switch to 64 bits.\r
18b13fab
ED
348 //\r
349 if ((sizeof(UINTN) == sizeof(UINT64)) || (FeaturePcdGet (PcdDxeIplSwitchToLongMode))) {\r
350 CommBuffer = &Header64;\r
351 Header64.MessageLength = 0;\r
352 CommSize = OFFSET_OF (SMM_COMMUNICATE_HEADER_64, Data);\r
353 } else {\r
354 CommBuffer = &Header32;\r
355 Header32.MessageLength = 0;\r
356 CommSize = OFFSET_OF (SMM_COMMUNICATE_HEADER_32, Data);\r
357 }\r
a85e7127 358 CopyGuid (CommBuffer, &gEdkiiEndOfS3ResumeGuid);\r
18b13fab 359\r
18b13fab
ED
360 Status = PeiServicesLocatePpi (\r
361 &gEfiPeiSmmCommunicationPpiGuid,\r
362 0,\r
363 NULL,\r
364 (VOID **)&SmmCommunicationPpi\r
365 );\r
152e8d76
ED
366 if (EFI_ERROR (Status)) {\r
367 DEBUG ((DEBUG_ERROR, "Locate Smm Communicate Ppi failed (%r)!\n", Status));\r
368 return Status;\r
369 }\r
18b13fab 370\r
18b13fab
ED
371 Status = SmmCommunicationPpi->Communicate (\r
372 SmmCommunicationPpi,\r
373 (VOID *)CommBuffer,\r
374 &CommSize\r
375 );\r
152e8d76
ED
376 if (EFI_ERROR (Status)) {\r
377 DEBUG ((DEBUG_ERROR, "SmmCommunicationPpi->Communicate return failure (%r)!\n", Status));\r
378 }\r
18b13fab 379\r
152e8d76 380 DEBUG ((DEBUG_INFO, "SignalEndOfS3Resume - Exit (%r)\n", Status));\r
18b13fab
ED
381 return Status;\r
382}\r
383\r
1f569620 384/**\r
385 Jump to OS waking vector.\r
386 The function will install boot script done PPI, report S3 resume status code, and then jump to OS waking vector.\r
387\r
388 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT\r
389 @param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE\r
390**/\r
391VOID\r
392EFIAPI\r
393S3ResumeBootOs (\r
394 IN ACPI_S3_CONTEXT *AcpiS3Context,\r
395 IN PEI_S3_RESUME_STATE *PeiS3ResumeState\r
396 )\r
397{\r
398 EFI_STATUS Status;\r
399 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs;\r
400 ASM_TRANSFER_CONTROL AsmTransferControl;\r
401 UINTN TempStackTop;\r
402 UINTN TempStack[0x10];\r
403\r
404 //\r
405 // Restore IDT\r
406 //\r
407 AsmWriteIdtr (&PeiS3ResumeState->Idtr);\r
408\r
f6d5cbe7 409 if (PeiS3ResumeState->ReturnStatus != EFI_SUCCESS) {\r
410 //\r
411 // Report Status code that boot script execution is failed\r
412 //\r
413 REPORT_STATUS_CODE (\r
414 EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
415 (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_S3_BOOT_SCRIPT_ERROR)\r
416 );\r
417 }\r
418\r
f5c941b1 419 //\r
420 // NOTE: Because Debug Timer interrupt and system interrupts will be disabled \r
421 // in BootScriptExecuteDxe, the rest code in S3ResumeBootOs() cannot be halted\r
422 // by soft debugger.\r
423 //\r
424\r
5c0687cc
SZ
425 PERF_END (NULL, "ScriptExec", NULL, 0);\r
426\r
1f569620 427 //\r
428 // Install BootScriptDonePpi\r
429 //\r
582e4e44
BD
430 PERF_START_EX (NULL, "BootScriptDonePpi", NULL, 0, PERF_INMODULE_START_ID);\r
431\r
1f569620 432 Status = PeiServicesInstallPpi (&mPpiListPostScriptTable);\r
433 ASSERT_EFI_ERROR (Status);\r
434\r
582e4e44
BD
435 PERF_END_EX (NULL, "BootScriptDonePpi", NULL, 0, PERF_INMODULE_END_ID);\r
436\r
1f569620 437 //\r
438 // Get ACPI Table Address\r
439 //\r
440 Facs = (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable));\r
441\r
442 if ((Facs == NULL) ||\r
443 (Facs->Signature != EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) ||\r
444 ((Facs->FirmwareWakingVector == 0) && (Facs->XFirmwareWakingVector == 0)) ) {\r
f6d5cbe7 445 //\r
446 // Report Status code that no valid vector is found\r
447 //\r
448 REPORT_STATUS_CODE (\r
449 EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
450 (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_S3_OS_WAKE_ERROR)\r
451 );\r
1f569620 452 CpuDeadLoop ();\r
453 return ;\r
454 }\r
455\r
1f569620 456 //\r
457 // Install EndOfPeiPpi\r
458 //\r
582e4e44
BD
459 PERF_START_EX (NULL, "EndOfPeiPpi", NULL, 0, PERF_INMODULE_START_ID);\r
460\r
1f569620 461 Status = PeiServicesInstallPpi (&mPpiListEndOfPeiTable);\r
462 ASSERT_EFI_ERROR (Status);\r
463\r
582e4e44
BD
464 PERF_END_EX (NULL, "EndOfPeiPpi", NULL, 0, PERF_INMODULE_END_ID);\r
465\r
18b13fab
ED
466 //\r
467 // Signal EndOfS3Resume event.\r
468 //\r
582e4e44
BD
469 PERF_START_EX (NULL, "EndOfS3Resume", NULL, 0, PERF_INMODULE_START_ID);\r
470\r
152e8d76 471 SignalEndOfS3Resume ();\r
18b13fab 472\r
582e4e44
BD
473 PERF_END_EX (NULL, "EndOfS3Resume", NULL, 0, PERF_INMODULE_END_ID);\r
474\r
26c0ba77
SZ
475 //\r
476 // report status code on S3 resume\r
477 //\r
478 REPORT_STATUS_CODE (EFI_PROGRESS_CODE, EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_OS_WAKE);\r
479\r
1f569620 480 AsmTransferControl = (ASM_TRANSFER_CONTROL)(UINTN)PeiS3ResumeState->AsmTransferControl;\r
481 if (Facs->XFirmwareWakingVector != 0) {\r
482 //\r
483 // Switch to native waking vector\r
484 //\r
485 TempStackTop = (UINTN)&TempStack + sizeof(TempStack);\r
af34c106
JF
486 DEBUG ((\r
487 DEBUG_INFO,\r
488 "%a() Stack Base: 0x%x, Stack Size: 0x%x\n",\r
489 __FUNCTION__,\r
490 TempStackTop,\r
491 sizeof (TempStack)\r
492 ));\r
1f569620 493 if ((Facs->Version == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION) &&\r
494 ((Facs->Flags & EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F) != 0) &&\r
495 ((Facs->Flags & EFI_ACPI_4_0_OSPM_64BIT_WAKE__F) != 0)) {\r
496 //\r
497 // X64 long mode waking vector\r
498 //\r
c5719579 499 DEBUG ((DEBUG_INFO, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
1f569620 500 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
501 AsmEnablePaging64 (\r
502 0x38,\r
503 Facs->XFirmwareWakingVector,\r
504 0,\r
505 0,\r
506 (UINT64)(UINTN)TempStackTop\r
507 );\r
508 } else {\r
f6d5cbe7 509 //\r
510 // Report Status code that no valid waking vector is found\r
511 //\r
512 REPORT_STATUS_CODE (\r
513 EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
514 (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_S3_OS_WAKE_ERROR)\r
515 );\r
1f569620 516 DEBUG (( EFI_D_ERROR, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));\r
517 ASSERT (FALSE);\r
f6d5cbe7 518 CpuDeadLoop ();\r
519 return ;\r
1f569620 520 }\r
521 } else {\r
522 //\r
523 // IA32 protected mode waking vector (Page disabled)\r
524 //\r
c5719579 525 DEBUG ((DEBUG_INFO, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
1f569620 526 SwitchStack (\r
527 (SWITCH_STACK_ENTRY_POINT) (UINTN) Facs->XFirmwareWakingVector,\r
528 NULL,\r
529 NULL,\r
530 (VOID *)(UINTN)TempStackTop\r
531 );\r
532 }\r
533 } else {\r
534 //\r
535 // 16bit Realmode waking vector\r
536 //\r
c5719579 537 DEBUG ((DEBUG_INFO, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN)Facs->FirmwareWakingVector));\r
1f569620 538 AsmTransferControl (Facs->FirmwareWakingVector, 0x0);\r
539 }\r
540\r
f6d5cbe7 541 //\r
542 // Report Status code the failure of S3Resume\r
543 //\r
544 REPORT_STATUS_CODE (\r
545 EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
546 (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_S3_OS_WAKE_ERROR)\r
547 );\r
548\r
1f569620 549 //\r
550 // Never run to here\r
551 //\r
552 CpuDeadLoop();\r
553}\r
554\r
555/**\r
556 Restore S3 page table because we do not trust ACPINvs content.\r
557 If BootScriptExector driver will not run in 64-bit mode, this function will do nothing. \r
558\r
559 @param S3NvsPageTableAddress PageTableAddress in ACPINvs\r
d0bf5623 560 @param Build4GPageTableOnly If BIOS just build 4G page table only\r
1f569620 561**/\r
562VOID\r
563RestoreS3PageTables (\r
d0bf5623
JY
564 IN UINTN S3NvsPageTableAddress,\r
565 IN BOOLEAN Build4GPageTableOnly\r
1f569620 566 )\r
567{\r
568 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
569 UINT32 RegEax;\r
c56b6566 570 UINT32 RegEdx;\r
1f569620 571 UINT8 PhysicalAddressBits;\r
572 EFI_PHYSICAL_ADDRESS PageAddress;\r
573 UINTN IndexOfPml4Entries;\r
574 UINTN IndexOfPdpEntries;\r
575 UINTN IndexOfPageDirectoryEntries;\r
c56b6566
JY
576 UINT32 NumberOfPml4EntriesNeeded;\r
577 UINT32 NumberOfPdpEntriesNeeded;\r
1f569620 578 PAGE_MAP_AND_DIRECTORY_POINTER *PageMapLevel4Entry;\r
579 PAGE_MAP_AND_DIRECTORY_POINTER *PageMap;\r
580 PAGE_MAP_AND_DIRECTORY_POINTER *PageDirectoryPointerEntry;\r
581 PAGE_TABLE_ENTRY *PageDirectoryEntry;\r
c56b6566
JY
582 VOID *Hob;\r
583 BOOLEAN Page1GSupport;\r
584 PAGE_TABLE_1G_ENTRY *PageDirectory1GEntry;\r
787a085b
LD
585 UINT64 AddressEncMask;\r
586\r
587 //\r
588 // Make sure AddressEncMask is contained to smallest supported address field\r
589 //\r
590 AddressEncMask = PcdGet64 (PcdPteMemoryEncryptionAddressOrMask) & PAGING_1G_ADDRESS_MASK_64;\r
1f569620 591\r
592 //\r
593 // NOTE: We have to ASSUME the page table generation format, because we do not know whole page table information.\r
594 // The whole page table is too large to be saved in SMRAM.\r
595 //\r
438f1766 596 // The assumption is : whole page table is allocated in CONTINUOUS memory and CR3 points to TOP page.\r
1f569620 597 //\r
c5719579 598 DEBUG ((DEBUG_INFO, "S3NvsPageTableAddress - %x (%x)\n", (UINTN)S3NvsPageTableAddress, (UINTN)Build4GPageTableOnly));\r
1f569620 599\r
600 //\r
438f1766 601 // By architecture only one PageMapLevel4 exists - so lets allocate storage for it.\r
1f569620 602 //\r
603 PageMap = (PAGE_MAP_AND_DIRECTORY_POINTER *)S3NvsPageTableAddress;\r
604 S3NvsPageTableAddress += SIZE_4KB;\r
605 \r
c56b6566 606 Page1GSupport = FALSE;\r
378175d2
JY
607 if (PcdGetBool(PcdUse1GPageTable)) {\r
608 AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
609 if (RegEax >= 0x80000001) {\r
610 AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);\r
611 if ((RegEdx & BIT26) != 0) {\r
612 Page1GSupport = TRUE;\r
613 }\r
c56b6566
JY
614 }\r
615 }\r
616 \r
1f569620 617 //\r
618 // Get physical address bits supported.\r
619 //\r
c56b6566
JY
620 Hob = GetFirstHob (EFI_HOB_TYPE_CPU);\r
621 if (Hob != NULL) {\r
622 PhysicalAddressBits = ((EFI_HOB_CPU *) Hob)->SizeOfMemorySpace;\r
1f569620 623 } else {\r
c56b6566
JY
624 AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
625 if (RegEax >= 0x80000008) {\r
626 AsmCpuid (0x80000008, &RegEax, NULL, NULL, NULL);\r
627 PhysicalAddressBits = (UINT8) RegEax;\r
628 } else {\r
629 PhysicalAddressBits = 36;\r
630 }\r
1f569620 631 }\r
632 \r
c56b6566
JY
633 //\r
634 // IA-32e paging translates 48-bit linear addresses to 52-bit physical addresses.\r
635 //\r
636 ASSERT (PhysicalAddressBits <= 52);\r
637 if (PhysicalAddressBits > 48) {\r
638 PhysicalAddressBits = 48;\r
639 }\r
640\r
d0bf5623
JY
641 //\r
642 // NOTE: In order to save time to create full page table, we just create 4G page table by default.\r
643 // And let PF handler in BootScript driver to create more on request.\r
644 //\r
645 if (Build4GPageTableOnly) {\r
646 PhysicalAddressBits = 32;\r
647 ZeroMem (PageMap, EFI_PAGES_TO_SIZE(2));\r
648 }\r
1f569620 649 //\r
650 // Calculate the table entries needed.\r
651 //\r
652 if (PhysicalAddressBits <= 39) {\r
653 NumberOfPml4EntriesNeeded = 1;\r
c56b6566 654 NumberOfPdpEntriesNeeded = (UINT32)LShiftU64 (1, (PhysicalAddressBits - 30));\r
1f569620 655 } else {\r
c56b6566 656 NumberOfPml4EntriesNeeded = (UINT32)LShiftU64 (1, (PhysicalAddressBits - 39));\r
1f569620 657 NumberOfPdpEntriesNeeded = 512;\r
658 }\r
659 \r
660 PageMapLevel4Entry = PageMap;\r
661 PageAddress = 0;\r
662 for (IndexOfPml4Entries = 0; IndexOfPml4Entries < NumberOfPml4EntriesNeeded; IndexOfPml4Entries++, PageMapLevel4Entry++) {\r
663 //\r
664 // Each PML4 entry points to a page of Page Directory Pointer entires.\r
665 // So lets allocate space for them and fill them in in the IndexOfPdpEntries loop.\r
666 //\r
667 PageDirectoryPointerEntry = (PAGE_MAP_AND_DIRECTORY_POINTER *)S3NvsPageTableAddress;\r
668 S3NvsPageTableAddress += SIZE_4KB;\r
669 \r
670 //\r
671 // Make a PML4 Entry\r
672 //\r
787a085b 673 PageMapLevel4Entry->Uint64 = (UINT64)(UINTN)PageDirectoryPointerEntry | AddressEncMask;\r
1f569620 674 PageMapLevel4Entry->Bits.ReadWrite = 1;\r
675 PageMapLevel4Entry->Bits.Present = 1;\r
c56b6566
JY
676\r
677 if (Page1GSupport) {\r
54d3b84e 678 PageDirectory1GEntry = (VOID *) PageDirectoryPointerEntry;\r
1f569620 679 \r
c56b6566 680 for (IndexOfPageDirectoryEntries = 0; IndexOfPageDirectoryEntries < 512; IndexOfPageDirectoryEntries++, PageDirectory1GEntry++, PageAddress += SIZE_1GB) {\r
1f569620 681 //\r
682 // Fill in the Page Directory entries\r
683 //\r
787a085b 684 PageDirectory1GEntry->Uint64 = (UINT64)PageAddress | AddressEncMask;\r
c56b6566
JY
685 PageDirectory1GEntry->Bits.ReadWrite = 1;\r
686 PageDirectory1GEntry->Bits.Present = 1;\r
687 PageDirectory1GEntry->Bits.MustBe1 = 1;\r
688 }\r
689 } else {\r
690 for (IndexOfPdpEntries = 0; IndexOfPdpEntries < NumberOfPdpEntriesNeeded; IndexOfPdpEntries++, PageDirectoryPointerEntry++) {\r
691 //\r
692 // Each Directory Pointer entries points to a page of Page Directory entires.\r
693 // So allocate space for them and fill them in in the IndexOfPageDirectoryEntries loop.\r
694 // \r
695 PageDirectoryEntry = (PAGE_TABLE_ENTRY *)S3NvsPageTableAddress;\r
696 S3NvsPageTableAddress += SIZE_4KB;\r
697 \r
698 //\r
699 // Fill in a Page Directory Pointer Entries\r
700 //\r
787a085b 701 PageDirectoryPointerEntry->Uint64 = (UINT64)(UINTN)PageDirectoryEntry | AddressEncMask;\r
c56b6566
JY
702 PageDirectoryPointerEntry->Bits.ReadWrite = 1;\r
703 PageDirectoryPointerEntry->Bits.Present = 1;\r
704 \r
705 for (IndexOfPageDirectoryEntries = 0; IndexOfPageDirectoryEntries < 512; IndexOfPageDirectoryEntries++, PageDirectoryEntry++, PageAddress += SIZE_2MB) {\r
706 //\r
707 // Fill in the Page Directory entries\r
708 //\r
787a085b 709 PageDirectoryEntry->Uint64 = (UINT64)PageAddress | AddressEncMask;\r
c56b6566
JY
710 PageDirectoryEntry->Bits.ReadWrite = 1;\r
711 PageDirectoryEntry->Bits.Present = 1;\r
712 PageDirectoryEntry->Bits.MustBe1 = 1;\r
713 }\r
1f569620 714 }\r
715 }\r
716 }\r
717 return ;\r
718 } else {\r
719 //\r
720 // If DXE is running 32-bit mode, no need to establish page table.\r
721 //\r
722 return ;\r
723 }\r
724}\r
725\r
726/**\r
727 Jump to boot script executor driver.\r
728\r
729 The function will close and lock SMRAM and then jump to boot script execute driver to executing S3 boot script table.\r
730\r
731 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT\r
732 @param EfiBootScriptExecutorVariable The function entry to executing S3 boot Script table. This function is build in\r
733 boot script execute driver\r
734**/\r
735VOID\r
736EFIAPI\r
737S3ResumeExecuteBootScript (\r
738 IN ACPI_S3_CONTEXT *AcpiS3Context,\r
739 IN BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable\r
740 )\r
741{\r
742 EFI_STATUS Status;\r
743 PEI_SMM_ACCESS_PPI *SmmAccess;\r
744 UINTN Index;\r
745 VOID *GuidHob;\r
746 IA32_DESCRIPTOR *IdtDescriptor;\r
747 VOID *IdtBuffer;\r
748 PEI_S3_RESUME_STATE *PeiS3ResumeState;\r
abef469f 749 BOOLEAN InterruptStatus;\r
1f569620 750\r
c5719579 751 DEBUG ((DEBUG_INFO, "S3ResumeExecuteBootScript()\n"));\r
1f569620 752\r
753 //\r
754 // Attempt to use content from SMRAM first\r
755 //\r
756 GuidHob = GetFirstGuidHob (&gEfiAcpiVariableGuid);\r
757 if (GuidHob != NULL) {\r
758 //\r
759 // Last step for SMM - send SMI for initialization\r
760 //\r
761\r
762 //\r
763 // Send SMI to APs\r
764 // \r
765 SendSmiIpiAllExcludingSelf ();\r
766 //\r
767 // Send SMI to BSP\r
768 //\r
769 SendSmiIpi (GetApicId ());\r
770\r
771 Status = PeiServicesLocatePpi (\r
772 &gPeiSmmAccessPpiGuid,\r
773 0,\r
774 NULL,\r
775 (VOID **) &SmmAccess\r
776 );\r
40ef06fc 777 if (!EFI_ERROR (Status)) {\r
c5719579 778 DEBUG ((DEBUG_INFO, "Close all SMRAM regions before executing boot script\n"));\r
40ef06fc
SZ
779 \r
780 for (Index = 0, Status = EFI_SUCCESS; !EFI_ERROR (Status); Index++) {\r
781 Status = SmmAccess->Close ((EFI_PEI_SERVICES **)GetPeiServicesTablePointer (), SmmAccess, Index);\r
782 }\r
1f569620 783\r
c5719579 784 DEBUG ((DEBUG_INFO, "Lock all SMRAM regions before executing boot script\n"));\r
40ef06fc
SZ
785 \r
786 for (Index = 0, Status = EFI_SUCCESS; !EFI_ERROR (Status); Index++) {\r
787 Status = SmmAccess->Lock ((EFI_PEI_SERVICES **)GetPeiServicesTablePointer (), SmmAccess, Index);\r
788 }\r
1f569620 789 }\r
790 }\r
791\r
792 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
1f569620 793 AsmWriteCr3 ((UINTN)AcpiS3Context->S3NvsPageTableAddress);\r
794 }\r
795\r
796 if (FeaturePcdGet (PcdFrameworkCompatibilitySupport)) {\r
797 //\r
798 // On some platform, such as ECP, a dispatch node in boot script table may execute a 32-bit PEIM which may need PeiServices\r
799 // pointer. So PeiServices need preserve in (IDTBase- sizeof (UINTN)). \r
800 //\r
801 IdtDescriptor = (IA32_DESCRIPTOR *) (UINTN) (AcpiS3Context->IdtrProfile);\r
802 //\r
438f1766 803 // Make sure the newly allocated IDT align with 16-bytes\r
1f569620 804 // \r
805 IdtBuffer = AllocatePages (EFI_SIZE_TO_PAGES((IdtDescriptor->Limit + 1) + 16));\r
6f9760d8
SZ
806 if (IdtBuffer == NULL) {\r
807 REPORT_STATUS_CODE (\r
808 EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
809 (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_S3_RESUME_FAILED)\r
810 );\r
811 ASSERT (FALSE);\r
812 }\r
e47459e6 813 //\r
814 // Additional 16 bytes allocated to save IA32 IDT descriptor and Pei Service Table Pointer\r
815 // IA32 IDT descriptor will be used to setup IA32 IDT table for 32-bit Framework Boot Script code\r
816 // \r
817 ZeroMem (IdtBuffer, 16);\r
818 AsmReadIdtr ((IA32_DESCRIPTOR *)IdtBuffer);\r
1f569620 819 CopyMem ((VOID*)((UINT8*)IdtBuffer + 16),(VOID*)(IdtDescriptor->Base), (IdtDescriptor->Limit + 1));\r
820 IdtDescriptor->Base = (UINTN)((UINT8*)IdtBuffer + 16);\r
821 *(UINTN*)(IdtDescriptor->Base - sizeof(UINTN)) = (UINTN)GetPeiServicesTablePointer ();\r
822 }\r
823\r
abef469f 824 InterruptStatus = SaveAndDisableInterrupts ();\r
1f569620 825 //\r
826 // Need to make sure the GDT is loaded with values that support long mode and real mode.\r
827 //\r
828 AsmWriteGdtr (&mGdt);\r
abef469f 829 //\r
830 // update segment selectors per the new GDT.\r
831 //\r
832 AsmSetDataSelectors (DATA_SEGEMENT_SELECTOR);\r
833 //\r
834 // Restore interrupt state.\r
835 //\r
836 SetInterruptState (InterruptStatus);\r
1f569620 837\r
838 //\r
839 // Prepare data for return back\r
840 //\r
841 PeiS3ResumeState = AllocatePool (sizeof(*PeiS3ResumeState));\r
6f9760d8
SZ
842 if (PeiS3ResumeState == NULL) {\r
843 REPORT_STATUS_CODE (\r
844 EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
845 (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_S3_RESUME_FAILED)\r
846 );\r
847 ASSERT (FALSE);\r
848 }\r
c5719579 849 DEBUG ((DEBUG_INFO, "PeiS3ResumeState - %x\r\n", PeiS3ResumeState));\r
1f569620 850 PeiS3ResumeState->ReturnCs = 0x10;\r
851 PeiS3ResumeState->ReturnEntryPoint = (EFI_PHYSICAL_ADDRESS)(UINTN)S3ResumeBootOs;\r
f98f5ec3 852 PeiS3ResumeState->ReturnStackPointer = (EFI_PHYSICAL_ADDRESS)STACK_ALIGN_DOWN (&Status);\r
1f569620 853 //\r
854 // Save IDT\r
855 //\r
856 AsmReadIdtr (&PeiS3ResumeState->Idtr);\r
f6d5cbe7 857 \r
858 //\r
859 // Report Status Code to indicate S3 boot script execution\r
860 //\r
861 REPORT_STATUS_CODE (EFI_PROGRESS_CODE, EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_S3_BOOT_SCRIPT);\r
1f569620 862\r
5c0687cc
SZ
863 PERF_START (NULL, "ScriptExec", NULL, 0);\r
864\r
1f569620 865 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
866 //\r
867 // X64 S3 Resume\r
868 //\r
c5719579 869 DEBUG ((DEBUG_INFO, "Enable X64 and transfer control to Standalone Boot Script Executor\r\n"));\r
1f569620 870\r
871 //\r
872 // Switch to long mode to complete resume.\r
873 //\r
874 AsmEnablePaging64 (\r
875 0x38,\r
876 EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint,\r
877 (UINT64)(UINTN)AcpiS3Context,\r
878 (UINT64)(UINTN)PeiS3ResumeState,\r
879 (UINT64)(UINTN)(AcpiS3Context->BootScriptStackBase + AcpiS3Context->BootScriptStackSize)\r
880 );\r
881 } else {\r
882 //\r
883 // IA32 S3 Resume\r
884 //\r
c5719579 885 DEBUG ((DEBUG_INFO, "transfer control to Standalone Boot Script Executor\r\n"));\r
1f569620 886 SwitchStack (\r
887 (SWITCH_STACK_ENTRY_POINT) (UINTN) EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint,\r
888 (VOID *)AcpiS3Context,\r
889 (VOID *)PeiS3ResumeState,\r
890 (VOID *)(UINTN)(AcpiS3Context->BootScriptStackBase + AcpiS3Context->BootScriptStackSize)\r
891 );\r
892 }\r
893\r
894 //\r
895 // Never run to here\r
896 //\r
897 CpuDeadLoop();\r
898}\r
899/**\r
900 Restores the platform to its preboot configuration for an S3 resume and\r
901 jumps to the OS waking vector.\r
902\r
903 This function will restore the platform to its pre-boot configuration that was\r
904 pre-stored in the boot script table and transfer control to OS waking vector.\r
905 Upon invocation, this function is responsible for locating the following\r
906 information before jumping to OS waking vector:\r
907 - ACPI tables\r
908 - boot script table\r
909 - any other information that it needs\r
910\r
911 The S3RestoreConfig() function then executes the pre-stored boot script table\r
912 and transitions the platform to the pre-boot state. The boot script is recorded\r
913 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and\r
914 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function\r
915 transfers control to the OS waking vector. If the OS supports only a real-mode\r
916 waking vector, this function will switch from flat mode to real mode before\r
917 jumping to the waking vector. If all platform pre-boot configurations are\r
918 successfully restored and all other necessary information is ready, this\r
919 function will never return and instead will directly jump to the OS waking\r
920 vector. If this function returns, it indicates that the attempt to resume\r
921 from the ACPI S3 sleep state failed.\r
922\r
923 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI\r
924\r
925 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.\r
926 @retval EFI_NOT_FOUND Some necessary information that is used for the S3\r
927 resume boot path could not be located.\r
928\r
929**/\r
930EFI_STATUS\r
931EFIAPI\r
932S3RestoreConfig2 (\r
933 IN EFI_PEI_S3_RESUME2_PPI *This\r
934 )\r
935{\r
936 EFI_STATUS Status;\r
937 PEI_SMM_ACCESS_PPI *SmmAccess;\r
938 UINTN Index;\r
939 ACPI_S3_CONTEXT *AcpiS3Context;\r
1f569620 940 EFI_PHYSICAL_ADDRESS TempEfiBootScriptExecutorVariable;\r
941 EFI_PHYSICAL_ADDRESS TempAcpiS3Context;\r
942 BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable;\r
943 UINTN VarSize;\r
944 EFI_SMRAM_DESCRIPTOR *SmramDescriptor;\r
945 SMM_S3_RESUME_STATE *SmmS3ResumeState;\r
946 VOID *GuidHob;\r
d0bf5623 947 BOOLEAN Build4GPageTableOnly;\r
abef469f 948 BOOLEAN InterruptStatus;\r
1f569620 949\r
48ee8e3e
SZ
950 TempAcpiS3Context = 0;\r
951 TempEfiBootScriptExecutorVariable = 0;\r
952\r
c5719579 953 DEBUG ((DEBUG_INFO, "Enter S3 PEIM\r\n"));\r
1f569620 954\r
1f569620 955 VarSize = sizeof (EFI_PHYSICAL_ADDRESS);\r
956 Status = RestoreLockBox (\r
957 &gEfiAcpiVariableGuid,\r
958 &TempAcpiS3Context,\r
959 &VarSize\r
960 );\r
961 ASSERT_EFI_ERROR (Status);\r
962\r
1f569620 963 Status = RestoreLockBox (\r
964 &gEfiAcpiS3ContextGuid,\r
965 NULL,\r
966 NULL\r
967 );\r
968 ASSERT_EFI_ERROR (Status);\r
969\r
48ee8e3e
SZ
970 AcpiS3Context = (ACPI_S3_CONTEXT *)(UINTN)TempAcpiS3Context;\r
971 ASSERT (AcpiS3Context != NULL);\r
972\r
973 VarSize = sizeof (EFI_PHYSICAL_ADDRESS);\r
1f569620 974 Status = RestoreLockBox (\r
975 &gEfiBootScriptExecutorVariableGuid,\r
976 &TempEfiBootScriptExecutorVariable,\r
977 &VarSize\r
978 );\r
979 ASSERT_EFI_ERROR (Status);\r
980\r
981 Status = RestoreLockBox (\r
982 &gEfiBootScriptExecutorContextGuid,\r
983 NULL,\r
984 NULL\r
985 );\r
986 ASSERT_EFI_ERROR (Status);\r
987\r
988 EfiBootScriptExecutorVariable = (BOOT_SCRIPT_EXECUTOR_VARIABLE *) (UINTN) TempEfiBootScriptExecutorVariable;\r
48ee8e3e 989 ASSERT (EfiBootScriptExecutorVariable != NULL);\r
1f569620 990\r
c5719579
JF
991 DEBUG (( DEBUG_INFO, "AcpiS3Context = %x\n", AcpiS3Context));\r
992 DEBUG (( DEBUG_INFO, "Waking Vector = %x\n", ((EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable)))->FirmwareWakingVector));\r
993 DEBUG (( DEBUG_INFO, "AcpiS3Context->AcpiFacsTable = %x\n", AcpiS3Context->AcpiFacsTable));\r
994 DEBUG (( DEBUG_INFO, "AcpiS3Context->IdtrProfile = %x\n", AcpiS3Context->IdtrProfile)); \r
995 DEBUG (( DEBUG_INFO, "AcpiS3Context->S3NvsPageTableAddress = %x\n", AcpiS3Context->S3NvsPageTableAddress));\r
996 DEBUG (( DEBUG_INFO, "AcpiS3Context->S3DebugBufferAddress = %x\n", AcpiS3Context->S3DebugBufferAddress));\r
997 DEBUG (( DEBUG_INFO, "AcpiS3Context->BootScriptStackBase = %x\n", AcpiS3Context->BootScriptStackBase));\r
998 DEBUG (( DEBUG_INFO, "AcpiS3Context->BootScriptStackSize = %x\n", AcpiS3Context->BootScriptStackSize));\r
999 DEBUG (( DEBUG_INFO, "EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = %x\n", EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint));\r
1f569620 1000\r
1001 //\r
1002 // Additional step for BootScript integrity - we only handle BootScript and BootScriptExecutor.\r
1003 // Script dispatch image and context (parameter) are handled by platform.\r
1004 // We just use restore all lock box in place, no need restore one by one.\r
1005 //\r
1006 Status = RestoreAllLockBoxInPlace ();\r
1007 ASSERT_EFI_ERROR (Status);\r
1008 if (EFI_ERROR (Status)) {\r
1009 // Something wrong\r
1010 CpuDeadLoop ();\r
1011 }\r
1012\r
3a69f7cb 1013 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
1014 //\r
1015 // Need reconstruct page table here, since we do not trust ACPINvs.\r
1016 //\r
d0bf5623
JY
1017 if (IsLongModeWakingVector (AcpiS3Context)) {\r
1018 Build4GPageTableOnly = FALSE;\r
1019 } else {\r
1020 Build4GPageTableOnly = TRUE;\r
1021 }\r
1022 RestoreS3PageTables ((UINTN)AcpiS3Context->S3NvsPageTableAddress, Build4GPageTableOnly);\r
3a69f7cb 1023 }\r
1024\r
1f569620 1025 //\r
1026 // Attempt to use content from SMRAM first\r
1027 //\r
1028 GuidHob = GetFirstGuidHob (&gEfiAcpiVariableGuid);\r
1029 if (GuidHob != NULL) {\r
40ef06fc
SZ
1030 Status = PeiServicesLocatePpi (\r
1031 &gPeiSmmAccessPpiGuid,\r
1032 0,\r
1033 NULL,\r
1034 (VOID **) &SmmAccess\r
1035 );\r
1036 for (Index = 0; !EFI_ERROR (Status); Index++) {\r
1037 Status = SmmAccess->Open ((EFI_PEI_SERVICES **)GetPeiServicesTablePointer (), SmmAccess, Index);\r
1038 }\r
1039\r
1f569620 1040 SmramDescriptor = (EFI_SMRAM_DESCRIPTOR *) GET_GUID_HOB_DATA (GuidHob);\r
1041 SmmS3ResumeState = (SMM_S3_RESUME_STATE *)(UINTN)SmramDescriptor->CpuStart;\r
1042\r
1043 SmmS3ResumeState->ReturnCs = AsmReadCs ();\r
1044 SmmS3ResumeState->ReturnEntryPoint = (EFI_PHYSICAL_ADDRESS)(UINTN)S3ResumeExecuteBootScript;\r
1045 SmmS3ResumeState->ReturnContext1 = (EFI_PHYSICAL_ADDRESS)(UINTN)AcpiS3Context;\r
1046 SmmS3ResumeState->ReturnContext2 = (EFI_PHYSICAL_ADDRESS)(UINTN)EfiBootScriptExecutorVariable;\r
f98f5ec3 1047 SmmS3ResumeState->ReturnStackPointer = (EFI_PHYSICAL_ADDRESS)STACK_ALIGN_DOWN (&Status);\r
1f569620 1048\r
c5719579
JF
1049 DEBUG (( DEBUG_INFO, "SMM S3 Signature = %x\n", SmmS3ResumeState->Signature));\r
1050 DEBUG (( DEBUG_INFO, "SMM S3 Stack Base = %x\n", SmmS3ResumeState->SmmS3StackBase));\r
1051 DEBUG (( DEBUG_INFO, "SMM S3 Stack Size = %x\n", SmmS3ResumeState->SmmS3StackSize));\r
1052 DEBUG (( DEBUG_INFO, "SMM S3 Resume Entry Point = %x\n", SmmS3ResumeState->SmmS3ResumeEntryPoint));\r
1053 DEBUG (( DEBUG_INFO, "SMM S3 CR0 = %x\n", SmmS3ResumeState->SmmS3Cr0));\r
1054 DEBUG (( DEBUG_INFO, "SMM S3 CR3 = %x\n", SmmS3ResumeState->SmmS3Cr3));\r
1055 DEBUG (( DEBUG_INFO, "SMM S3 CR4 = %x\n", SmmS3ResumeState->SmmS3Cr4));\r
1056 DEBUG (( DEBUG_INFO, "SMM S3 Return CS = %x\n", SmmS3ResumeState->ReturnCs));\r
1057 DEBUG (( DEBUG_INFO, "SMM S3 Return Entry Point = %x\n", SmmS3ResumeState->ReturnEntryPoint));\r
1058 DEBUG (( DEBUG_INFO, "SMM S3 Return Context1 = %x\n", SmmS3ResumeState->ReturnContext1));\r
1059 DEBUG (( DEBUG_INFO, "SMM S3 Return Context2 = %x\n", SmmS3ResumeState->ReturnContext2));\r
1060 DEBUG (( DEBUG_INFO, "SMM S3 Return Stack Pointer = %x\n", SmmS3ResumeState->ReturnStackPointer));\r
1061 DEBUG (( DEBUG_INFO, "SMM S3 Smst = %x\n", SmmS3ResumeState->Smst));\r
1f569620 1062\r
1f569620 1063 if (SmmS3ResumeState->Signature == SMM_S3_RESUME_SMM_32) {\r
1064 SwitchStack (\r
1065 (SWITCH_STACK_ENTRY_POINT)(UINTN)SmmS3ResumeState->SmmS3ResumeEntryPoint,\r
1066 (VOID *)AcpiS3Context,\r
1067 0,\r
1068 (VOID *)(UINTN)(SmmS3ResumeState->SmmS3StackBase + SmmS3ResumeState->SmmS3StackSize)\r
1069 );\r
1070 }\r
1071 if (SmmS3ResumeState->Signature == SMM_S3_RESUME_SMM_64) {\r
1072 //\r
1073 // Switch to long mode to complete resume.\r
1074 //\r
1075\r
abef469f 1076 InterruptStatus = SaveAndDisableInterrupts ();\r
1f569620 1077 //\r
1078 // Need to make sure the GDT is loaded with values that support long mode and real mode.\r
1079 //\r
1080 AsmWriteGdtr (&mGdt);\r
abef469f 1081 //\r
1082 // update segment selectors per the new GDT.\r
1083 // \r
1084 AsmSetDataSelectors (DATA_SEGEMENT_SELECTOR);\r
1085 //\r
1086 // Restore interrupt state.\r
1087 //\r
1088 SetInterruptState (InterruptStatus);\r
1089\r
1f569620 1090 AsmWriteCr3 ((UINTN)SmmS3ResumeState->SmmS3Cr3);\r
f5c941b1 1091\r
1092 //\r
1093 // Disable interrupt of Debug timer, since IDT table cannot work in long mode.\r
1094 // NOTE: On x64 platforms, because DisablePaging64() will disable interrupts,\r
1095 // the code in S3ResumeExecuteBootScript() cannot be halted by soft debugger.\r
1096 //\r
1097 SaveAndSetDebugTimerInterrupt (FALSE);\r
1098\r
1f569620 1099 AsmEnablePaging64 (\r
1100 0x38,\r
1101 SmmS3ResumeState->SmmS3ResumeEntryPoint,\r
1102 (UINT64)(UINTN)AcpiS3Context,\r
1103 0,\r
1104 SmmS3ResumeState->SmmS3StackBase + SmmS3ResumeState->SmmS3StackSize\r
1105 );\r
1106 }\r
1107\r
1108 }\r
1109\r
1110 S3ResumeExecuteBootScript (AcpiS3Context, EfiBootScriptExecutorVariable );\r
1111 return EFI_SUCCESS;\r
1112}\r
1113/**\r
1114 Main entry for S3 Resume PEIM.\r
1115\r
1116 This routine is to install EFI_PEI_S3_RESUME2_PPI.\r
1117 \r
1118 @param FileHandle Handle of the file being invoked.\r
1119 @param PeiServices Pointer to PEI Services table.\r
1120\r
1121 @retval EFI_SUCCESS S3Resume Ppi is installed successfully.\r
1122\r
1123**/\r
1124EFI_STATUS\r
1125EFIAPI\r
1126PeimS3ResumeEntryPoint (\r
1127 IN EFI_PEI_FILE_HANDLE FileHandle,\r
1128 IN CONST EFI_PEI_SERVICES **PeiServices\r
1129 )\r
1130{\r
1131 EFI_STATUS Status;\r
1132\r
1133 //\r
1134 // Install S3 Resume Ppi\r
1135 //\r
1136 Status = (**PeiServices).InstallPpi (PeiServices, &mPpiList);\r
1137 ASSERT_EFI_ERROR (Status);\r
1138\r
1139 return EFI_SUCCESS;\r
1140}\r
1141\r