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