]> 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
Remove Variable PPI dependency from S3Resume module, check return status of locating...
[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 Jump to OS waking vector.
372 The function will install boot script done PPI, report S3 resume status code, and then jump to OS waking vector.
373
374 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
375 @param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE
376 **/
377 VOID
378 EFIAPI
379 S3ResumeBootOs (
380 IN ACPI_S3_CONTEXT *AcpiS3Context,
381 IN PEI_S3_RESUME_STATE *PeiS3ResumeState
382 )
383 {
384 EFI_STATUS Status;
385 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs;
386 ASM_TRANSFER_CONTROL AsmTransferControl;
387 UINTN TempStackTop;
388 UINTN TempStack[0x10];
389
390 //
391 // Restore IDT
392 //
393 AsmWriteIdtr (&PeiS3ResumeState->Idtr);
394
395 PERF_END (NULL, "ScriptExec", NULL, 0);
396
397 //
398 // Install BootScriptDonePpi
399 //
400 Status = PeiServicesInstallPpi (&mPpiListPostScriptTable);
401 ASSERT_EFI_ERROR (Status);
402
403 //
404 // Get ACPI Table Address
405 //
406 Facs = (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable));
407
408 if ((Facs == NULL) ||
409 (Facs->Signature != EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) ||
410 ((Facs->FirmwareWakingVector == 0) && (Facs->XFirmwareWakingVector == 0)) ) {
411 CpuDeadLoop ();
412 return ;
413 }
414
415 //
416 // Install EndOfPeiPpi
417 //
418 Status = PeiServicesInstallPpi (&mPpiListEndOfPeiTable);
419 ASSERT_EFI_ERROR (Status);
420
421 //
422 // report status code on S3 resume
423 //
424 REPORT_STATUS_CODE (EFI_PROGRESS_CODE, EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_OS_WAKE);
425
426 PERF_CODE (
427 WriteToOsS3PerformanceData ();
428 );
429
430 AsmTransferControl = (ASM_TRANSFER_CONTROL)(UINTN)PeiS3ResumeState->AsmTransferControl;
431 if (Facs->XFirmwareWakingVector != 0) {
432 //
433 // Switch to native waking vector
434 //
435 TempStackTop = (UINTN)&TempStack + sizeof(TempStack);
436 if ((Facs->Version == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION) &&
437 ((Facs->Flags & EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F) != 0) &&
438 ((Facs->Flags & EFI_ACPI_4_0_OSPM_64BIT_WAKE__F) != 0)) {
439 //
440 // X64 long mode waking vector
441 //
442 DEBUG (( EFI_D_ERROR, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));
443 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {
444 AsmEnablePaging64 (
445 0x38,
446 Facs->XFirmwareWakingVector,
447 0,
448 0,
449 (UINT64)(UINTN)TempStackTop
450 );
451 } else {
452 DEBUG (( EFI_D_ERROR, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));
453 ASSERT (FALSE);
454 }
455 } else {
456 //
457 // IA32 protected mode waking vector (Page disabled)
458 //
459 DEBUG (( EFI_D_ERROR, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));
460 SwitchStack (
461 (SWITCH_STACK_ENTRY_POINT) (UINTN) Facs->XFirmwareWakingVector,
462 NULL,
463 NULL,
464 (VOID *)(UINTN)TempStackTop
465 );
466 }
467 } else {
468 //
469 // 16bit Realmode waking vector
470 //
471 DEBUG (( EFI_D_ERROR, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN)Facs->FirmwareWakingVector));
472 AsmTransferControl (Facs->FirmwareWakingVector, 0x0);
473 }
474
475 //
476 // Never run to here
477 //
478 CpuDeadLoop();
479 }
480
481 /**
482 Restore S3 page table because we do not trust ACPINvs content.
483 If BootScriptExector driver will not run in 64-bit mode, this function will do nothing.
484
485 @param S3NvsPageTableAddress PageTableAddress in ACPINvs
486 **/
487 VOID
488 RestoreS3PageTables (
489 IN UINTN S3NvsPageTableAddress
490 )
491 {
492 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {
493 UINT32 RegEax;
494 UINT32 RegEdx;
495 UINT8 PhysicalAddressBits;
496 EFI_PHYSICAL_ADDRESS PageAddress;
497 UINTN IndexOfPml4Entries;
498 UINTN IndexOfPdpEntries;
499 UINTN IndexOfPageDirectoryEntries;
500 UINT32 NumberOfPml4EntriesNeeded;
501 UINT32 NumberOfPdpEntriesNeeded;
502 PAGE_MAP_AND_DIRECTORY_POINTER *PageMapLevel4Entry;
503 PAGE_MAP_AND_DIRECTORY_POINTER *PageMap;
504 PAGE_MAP_AND_DIRECTORY_POINTER *PageDirectoryPointerEntry;
505 PAGE_TABLE_ENTRY *PageDirectoryEntry;
506 VOID *Hob;
507 BOOLEAN Page1GSupport;
508 PAGE_TABLE_1G_ENTRY *PageDirectory1GEntry;
509
510 //
511 // NOTE: We have to ASSUME the page table generation format, because we do not know whole page table information.
512 // The whole page table is too large to be saved in SMRAM.
513 //
514 // The assumption is : whole page table is allocated in CONTINOUS memory and CR3 points to TOP page.
515 //
516 DEBUG ((EFI_D_ERROR, "S3NvsPageTableAddress - %x\n", S3NvsPageTableAddress));
517
518 //
519 // By architecture only one PageMapLevel4 exists - so lets allocate storgage for it.
520 //
521 PageMap = (PAGE_MAP_AND_DIRECTORY_POINTER *)S3NvsPageTableAddress;
522 S3NvsPageTableAddress += SIZE_4KB;
523
524 Page1GSupport = FALSE;
525 if (PcdGetBool(PcdUse1GPageTable)) {
526 AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);
527 if (RegEax >= 0x80000001) {
528 AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);
529 if ((RegEdx & BIT26) != 0) {
530 Page1GSupport = TRUE;
531 }
532 }
533 }
534
535 //
536 // Get physical address bits supported.
537 //
538 Hob = GetFirstHob (EFI_HOB_TYPE_CPU);
539 if (Hob != NULL) {
540 PhysicalAddressBits = ((EFI_HOB_CPU *) Hob)->SizeOfMemorySpace;
541 } else {
542 AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);
543 if (RegEax >= 0x80000008) {
544 AsmCpuid (0x80000008, &RegEax, NULL, NULL, NULL);
545 PhysicalAddressBits = (UINT8) RegEax;
546 } else {
547 PhysicalAddressBits = 36;
548 }
549 }
550
551 //
552 // IA-32e paging translates 48-bit linear addresses to 52-bit physical addresses.
553 //
554 ASSERT (PhysicalAddressBits <= 52);
555 if (PhysicalAddressBits > 48) {
556 PhysicalAddressBits = 48;
557 }
558
559 //
560 // Calculate the table entries needed.
561 //
562 if (PhysicalAddressBits <= 39) {
563 NumberOfPml4EntriesNeeded = 1;
564 NumberOfPdpEntriesNeeded = (UINT32)LShiftU64 (1, (PhysicalAddressBits - 30));
565 } else {
566 NumberOfPml4EntriesNeeded = (UINT32)LShiftU64 (1, (PhysicalAddressBits - 39));
567 NumberOfPdpEntriesNeeded = 512;
568 }
569
570 PageMapLevel4Entry = PageMap;
571 PageAddress = 0;
572 for (IndexOfPml4Entries = 0; IndexOfPml4Entries < NumberOfPml4EntriesNeeded; IndexOfPml4Entries++, PageMapLevel4Entry++) {
573 //
574 // Each PML4 entry points to a page of Page Directory Pointer entires.
575 // So lets allocate space for them and fill them in in the IndexOfPdpEntries loop.
576 //
577 PageDirectoryPointerEntry = (PAGE_MAP_AND_DIRECTORY_POINTER *)S3NvsPageTableAddress;
578 S3NvsPageTableAddress += SIZE_4KB;
579
580 //
581 // Make a PML4 Entry
582 //
583 PageMapLevel4Entry->Uint64 = (UINT64)(UINTN)PageDirectoryPointerEntry;
584 PageMapLevel4Entry->Bits.ReadWrite = 1;
585 PageMapLevel4Entry->Bits.Present = 1;
586
587 if (Page1GSupport) {
588 PageDirectory1GEntry = (VOID *) PageDirectoryPointerEntry;
589
590 for (IndexOfPageDirectoryEntries = 0; IndexOfPageDirectoryEntries < 512; IndexOfPageDirectoryEntries++, PageDirectory1GEntry++, PageAddress += SIZE_1GB) {
591 //
592 // Fill in the Page Directory entries
593 //
594 PageDirectory1GEntry->Uint64 = (UINT64)PageAddress;
595 PageDirectory1GEntry->Bits.ReadWrite = 1;
596 PageDirectory1GEntry->Bits.Present = 1;
597 PageDirectory1GEntry->Bits.MustBe1 = 1;
598 }
599 } else {
600 for (IndexOfPdpEntries = 0; IndexOfPdpEntries < NumberOfPdpEntriesNeeded; IndexOfPdpEntries++, PageDirectoryPointerEntry++) {
601 //
602 // Each Directory Pointer entries points to a page of Page Directory entires.
603 // So allocate space for them and fill them in in the IndexOfPageDirectoryEntries loop.
604 //
605 PageDirectoryEntry = (PAGE_TABLE_ENTRY *)S3NvsPageTableAddress;
606 S3NvsPageTableAddress += SIZE_4KB;
607
608 //
609 // Fill in a Page Directory Pointer Entries
610 //
611 PageDirectoryPointerEntry->Uint64 = (UINT64)(UINTN)PageDirectoryEntry;
612 PageDirectoryPointerEntry->Bits.ReadWrite = 1;
613 PageDirectoryPointerEntry->Bits.Present = 1;
614
615 for (IndexOfPageDirectoryEntries = 0; IndexOfPageDirectoryEntries < 512; IndexOfPageDirectoryEntries++, PageDirectoryEntry++, PageAddress += SIZE_2MB) {
616 //
617 // Fill in the Page Directory entries
618 //
619 PageDirectoryEntry->Uint64 = (UINT64)PageAddress;
620 PageDirectoryEntry->Bits.ReadWrite = 1;
621 PageDirectoryEntry->Bits.Present = 1;
622 PageDirectoryEntry->Bits.MustBe1 = 1;
623 }
624 }
625 }
626 }
627 return ;
628 } else {
629 //
630 // If DXE is running 32-bit mode, no need to establish page table.
631 //
632 return ;
633 }
634 }
635
636 /**
637 Jump to boot script executor driver.
638
639 The function will close and lock SMRAM and then jump to boot script execute driver to executing S3 boot script table.
640
641 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
642 @param EfiBootScriptExecutorVariable The function entry to executing S3 boot Script table. This function is build in
643 boot script execute driver
644 **/
645 VOID
646 EFIAPI
647 S3ResumeExecuteBootScript (
648 IN ACPI_S3_CONTEXT *AcpiS3Context,
649 IN BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable
650 )
651 {
652 EFI_STATUS Status;
653 PEI_SMM_ACCESS_PPI *SmmAccess;
654 UINTN Index;
655 VOID *GuidHob;
656 IA32_DESCRIPTOR *IdtDescriptor;
657 VOID *IdtBuffer;
658 PEI_S3_RESUME_STATE *PeiS3ResumeState;
659
660 DEBUG ((EFI_D_ERROR, "S3ResumeExecuteBootScript()\n"));
661
662 //
663 // Attempt to use content from SMRAM first
664 //
665 GuidHob = GetFirstGuidHob (&gEfiAcpiVariableGuid);
666 if (GuidHob != NULL) {
667 //
668 // Last step for SMM - send SMI for initialization
669 //
670
671 //
672 // Send SMI to APs
673 //
674 SendSmiIpiAllExcludingSelf ();
675 //
676 // Send SMI to BSP
677 //
678 SendSmiIpi (GetApicId ());
679
680 Status = PeiServicesLocatePpi (
681 &gPeiSmmAccessPpiGuid,
682 0,
683 NULL,
684 (VOID **) &SmmAccess
685 );
686 if (!EFI_ERROR (Status)) {
687 DEBUG ((EFI_D_ERROR, "Close all SMRAM regions before executing boot script\n"));
688
689 for (Index = 0, Status = EFI_SUCCESS; !EFI_ERROR (Status); Index++) {
690 Status = SmmAccess->Close ((EFI_PEI_SERVICES **)GetPeiServicesTablePointer (), SmmAccess, Index);
691 }
692
693 DEBUG ((EFI_D_ERROR, "Lock all SMRAM regions before executing boot script\n"));
694
695 for (Index = 0, Status = EFI_SUCCESS; !EFI_ERROR (Status); Index++) {
696 Status = SmmAccess->Lock ((EFI_PEI_SERVICES **)GetPeiServicesTablePointer (), SmmAccess, Index);
697 }
698 }
699 }
700
701 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {
702 AsmWriteCr3 ((UINTN)AcpiS3Context->S3NvsPageTableAddress);
703 }
704
705 if (FeaturePcdGet (PcdFrameworkCompatibilitySupport)) {
706 //
707 // On some platform, such as ECP, a dispatch node in boot script table may execute a 32-bit PEIM which may need PeiServices
708 // pointer. So PeiServices need preserve in (IDTBase- sizeof (UINTN)).
709 //
710 IdtDescriptor = (IA32_DESCRIPTOR *) (UINTN) (AcpiS3Context->IdtrProfile);
711 //
712 // Make sure the newly allcated IDT align with 16-bytes
713 //
714 IdtBuffer = AllocatePages (EFI_SIZE_TO_PAGES((IdtDescriptor->Limit + 1) + 16));
715 ASSERT (IdtBuffer != NULL);
716 //
717 // Additional 16 bytes allocated to save IA32 IDT descriptor and Pei Service Table Pointer
718 // IA32 IDT descriptor will be used to setup IA32 IDT table for 32-bit Framework Boot Script code
719 //
720 ZeroMem (IdtBuffer, 16);
721 AsmReadIdtr ((IA32_DESCRIPTOR *)IdtBuffer);
722 CopyMem ((VOID*)((UINT8*)IdtBuffer + 16),(VOID*)(IdtDescriptor->Base), (IdtDescriptor->Limit + 1));
723 IdtDescriptor->Base = (UINTN)((UINT8*)IdtBuffer + 16);
724 *(UINTN*)(IdtDescriptor->Base - sizeof(UINTN)) = (UINTN)GetPeiServicesTablePointer ();
725 }
726
727 //
728 // Need to make sure the GDT is loaded with values that support long mode and real mode.
729 //
730 AsmWriteGdtr (&mGdt);
731
732 //
733 // Prepare data for return back
734 //
735 PeiS3ResumeState = AllocatePool (sizeof(*PeiS3ResumeState));
736 ASSERT (PeiS3ResumeState != NULL);
737 DEBUG (( EFI_D_ERROR, "PeiS3ResumeState - %x\r\n", PeiS3ResumeState));
738 PeiS3ResumeState->ReturnCs = 0x10;
739 PeiS3ResumeState->ReturnEntryPoint = (EFI_PHYSICAL_ADDRESS)(UINTN)S3ResumeBootOs;
740 PeiS3ResumeState->ReturnStackPointer = (EFI_PHYSICAL_ADDRESS)(UINTN)&Status;
741 //
742 // Save IDT
743 //
744 AsmReadIdtr (&PeiS3ResumeState->Idtr);
745
746 PERF_START (NULL, "ScriptExec", NULL, 0);
747
748 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {
749 //
750 // X64 S3 Resume
751 //
752 DEBUG (( EFI_D_ERROR, "Enable X64 and transfer control to Standalone Boot Script Executor\r\n"));
753
754 //
755 // Switch to long mode to complete resume.
756 //
757 AsmEnablePaging64 (
758 0x38,
759 EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint,
760 (UINT64)(UINTN)AcpiS3Context,
761 (UINT64)(UINTN)PeiS3ResumeState,
762 (UINT64)(UINTN)(AcpiS3Context->BootScriptStackBase + AcpiS3Context->BootScriptStackSize)
763 );
764 } else {
765 //
766 // IA32 S3 Resume
767 //
768 DEBUG (( EFI_D_ERROR, "transfer control to Standalone Boot Script Executor\r\n"));
769 SwitchStack (
770 (SWITCH_STACK_ENTRY_POINT) (UINTN) EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint,
771 (VOID *)AcpiS3Context,
772 (VOID *)PeiS3ResumeState,
773 (VOID *)(UINTN)(AcpiS3Context->BootScriptStackBase + AcpiS3Context->BootScriptStackSize)
774 );
775 }
776
777 //
778 // Never run to here
779 //
780 CpuDeadLoop();
781 }
782 /**
783 Restores the platform to its preboot configuration for an S3 resume and
784 jumps to the OS waking vector.
785
786 This function will restore the platform to its pre-boot configuration that was
787 pre-stored in the boot script table and transfer control to OS waking vector.
788 Upon invocation, this function is responsible for locating the following
789 information before jumping to OS waking vector:
790 - ACPI tables
791 - boot script table
792 - any other information that it needs
793
794 The S3RestoreConfig() function then executes the pre-stored boot script table
795 and transitions the platform to the pre-boot state. The boot script is recorded
796 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and
797 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function
798 transfers control to the OS waking vector. If the OS supports only a real-mode
799 waking vector, this function will switch from flat mode to real mode before
800 jumping to the waking vector. If all platform pre-boot configurations are
801 successfully restored and all other necessary information is ready, this
802 function will never return and instead will directly jump to the OS waking
803 vector. If this function returns, it indicates that the attempt to resume
804 from the ACPI S3 sleep state failed.
805
806 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI
807
808 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
809 @retval EFI_NOT_FOUND Some necessary information that is used for the S3
810 resume boot path could not be located.
811
812 **/
813 EFI_STATUS
814 EFIAPI
815 S3RestoreConfig2 (
816 IN EFI_PEI_S3_RESUME2_PPI *This
817 )
818 {
819 EFI_STATUS Status;
820 PEI_SMM_ACCESS_PPI *SmmAccess;
821 UINTN Index;
822 ACPI_S3_CONTEXT *AcpiS3Context;
823 EFI_PHYSICAL_ADDRESS TempEfiBootScriptExecutorVariable;
824 EFI_PHYSICAL_ADDRESS TempAcpiS3Context;
825 BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable;
826 UINTN VarSize;
827 EFI_SMRAM_DESCRIPTOR *SmramDescriptor;
828 SMM_S3_RESUME_STATE *SmmS3ResumeState;
829 VOID *GuidHob;
830
831 DEBUG ((EFI_D_ERROR, "Enter S3 PEIM\r\n"));
832
833 VarSize = sizeof (EFI_PHYSICAL_ADDRESS);
834 Status = RestoreLockBox (
835 &gEfiAcpiVariableGuid,
836 &TempAcpiS3Context,
837 &VarSize
838 );
839 ASSERT_EFI_ERROR (Status);
840
841 AcpiS3Context = (ACPI_S3_CONTEXT *)(UINTN)TempAcpiS3Context;
842 ASSERT (AcpiS3Context != NULL);
843
844 Status = RestoreLockBox (
845 &gEfiAcpiS3ContextGuid,
846 NULL,
847 NULL
848 );
849 ASSERT_EFI_ERROR (Status);
850
851 VarSize = sizeof (TempEfiBootScriptExecutorVariable);
852 Status = RestoreLockBox (
853 &gEfiBootScriptExecutorVariableGuid,
854 &TempEfiBootScriptExecutorVariable,
855 &VarSize
856 );
857 ASSERT_EFI_ERROR (Status);
858
859 Status = RestoreLockBox (
860 &gEfiBootScriptExecutorContextGuid,
861 NULL,
862 NULL
863 );
864 ASSERT_EFI_ERROR (Status);
865
866 EfiBootScriptExecutorVariable = (BOOT_SCRIPT_EXECUTOR_VARIABLE *) (UINTN) TempEfiBootScriptExecutorVariable;
867
868 DEBUG (( EFI_D_ERROR, "AcpiS3Context = %x\n", AcpiS3Context));
869 DEBUG (( EFI_D_ERROR, "Waking Vector = %x\n", ((EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable)))->FirmwareWakingVector));
870 DEBUG (( EFI_D_ERROR, "AcpiS3Context->AcpiFacsTable = %x\n", AcpiS3Context->AcpiFacsTable));
871 DEBUG (( EFI_D_ERROR, "AcpiS3Context->S3NvsPageTableAddress = %x\n", AcpiS3Context->S3NvsPageTableAddress));
872 DEBUG (( EFI_D_ERROR, "AcpiS3Context->S3DebugBufferAddress = %x\n", AcpiS3Context->S3DebugBufferAddress));
873 DEBUG (( EFI_D_ERROR, "EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = %x\n", EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint));
874
875 //
876 // Additional step for BootScript integrity - we only handle BootScript and BootScriptExecutor.
877 // Script dispatch image and context (parameter) are handled by platform.
878 // We just use restore all lock box in place, no need restore one by one.
879 //
880 Status = RestoreAllLockBoxInPlace ();
881 ASSERT_EFI_ERROR (Status);
882 if (EFI_ERROR (Status)) {
883 // Something wrong
884 CpuDeadLoop ();
885 }
886
887 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {
888 //
889 // Need reconstruct page table here, since we do not trust ACPINvs.
890 //
891 RestoreS3PageTables ((UINTN)AcpiS3Context->S3NvsPageTableAddress);
892 }
893
894 //
895 // Attempt to use content from SMRAM first
896 //
897 GuidHob = GetFirstGuidHob (&gEfiAcpiVariableGuid);
898 if (GuidHob != NULL) {
899 Status = PeiServicesLocatePpi (
900 &gPeiSmmAccessPpiGuid,
901 0,
902 NULL,
903 (VOID **) &SmmAccess
904 );
905 for (Index = 0; !EFI_ERROR (Status); Index++) {
906 Status = SmmAccess->Open ((EFI_PEI_SERVICES **)GetPeiServicesTablePointer (), SmmAccess, Index);
907 }
908
909 SmramDescriptor = (EFI_SMRAM_DESCRIPTOR *) GET_GUID_HOB_DATA (GuidHob);
910 SmmS3ResumeState = (SMM_S3_RESUME_STATE *)(UINTN)SmramDescriptor->CpuStart;
911
912 SmmS3ResumeState->ReturnCs = AsmReadCs ();
913 SmmS3ResumeState->ReturnEntryPoint = (EFI_PHYSICAL_ADDRESS)(UINTN)S3ResumeExecuteBootScript;
914 SmmS3ResumeState->ReturnContext1 = (EFI_PHYSICAL_ADDRESS)(UINTN)AcpiS3Context;
915 SmmS3ResumeState->ReturnContext2 = (EFI_PHYSICAL_ADDRESS)(UINTN)EfiBootScriptExecutorVariable;
916 SmmS3ResumeState->ReturnStackPointer = (EFI_PHYSICAL_ADDRESS)(UINTN)&Status;
917
918 DEBUG (( EFI_D_ERROR, "SMM S3 Signature = %x\n", SmmS3ResumeState->Signature));
919 DEBUG (( EFI_D_ERROR, "SMM S3 Stack Base = %x\n", SmmS3ResumeState->SmmS3StackBase));
920 DEBUG (( EFI_D_ERROR, "SMM S3 Stack Size = %x\n", SmmS3ResumeState->SmmS3StackSize));
921 DEBUG (( EFI_D_ERROR, "SMM S3 Resume Entry Point = %x\n", SmmS3ResumeState->SmmS3ResumeEntryPoint));
922 DEBUG (( EFI_D_ERROR, "SMM S3 CR0 = %x\n", SmmS3ResumeState->SmmS3Cr0));
923 DEBUG (( EFI_D_ERROR, "SMM S3 CR3 = %x\n", SmmS3ResumeState->SmmS3Cr3));
924 DEBUG (( EFI_D_ERROR, "SMM S3 CR4 = %x\n", SmmS3ResumeState->SmmS3Cr4));
925 DEBUG (( EFI_D_ERROR, "SMM S3 Return CS = %x\n", SmmS3ResumeState->ReturnCs));
926 DEBUG (( EFI_D_ERROR, "SMM S3 Return Entry Point = %x\n", SmmS3ResumeState->ReturnEntryPoint));
927 DEBUG (( EFI_D_ERROR, "SMM S3 Return Context1 = %x\n", SmmS3ResumeState->ReturnContext1));
928 DEBUG (( EFI_D_ERROR, "SMM S3 Return Context2 = %x\n", SmmS3ResumeState->ReturnContext2));
929 DEBUG (( EFI_D_ERROR, "SMM S3 Return Stack Pointer = %x\n", SmmS3ResumeState->ReturnStackPointer));
930 DEBUG (( EFI_D_ERROR, "SMM S3 Smst = %x\n", SmmS3ResumeState->Smst));
931
932 //
933 // Disable interrupt of Debug timer.
934 //
935 SaveAndSetDebugTimerInterrupt (FALSE);
936
937 if (SmmS3ResumeState->Signature == SMM_S3_RESUME_SMM_32) {
938 SwitchStack (
939 (SWITCH_STACK_ENTRY_POINT)(UINTN)SmmS3ResumeState->SmmS3ResumeEntryPoint,
940 (VOID *)AcpiS3Context,
941 0,
942 (VOID *)(UINTN)(SmmS3ResumeState->SmmS3StackBase + SmmS3ResumeState->SmmS3StackSize)
943 );
944 }
945 if (SmmS3ResumeState->Signature == SMM_S3_RESUME_SMM_64) {
946 //
947 // Switch to long mode to complete resume.
948 //
949
950 //
951 // Need to make sure the GDT is loaded with values that support long mode and real mode.
952 //
953 AsmWriteGdtr (&mGdt);
954 AsmWriteCr3 ((UINTN)SmmS3ResumeState->SmmS3Cr3);
955 AsmEnablePaging64 (
956 0x38,
957 SmmS3ResumeState->SmmS3ResumeEntryPoint,
958 (UINT64)(UINTN)AcpiS3Context,
959 0,
960 SmmS3ResumeState->SmmS3StackBase + SmmS3ResumeState->SmmS3StackSize
961 );
962 }
963
964 }
965
966 S3ResumeExecuteBootScript (AcpiS3Context, EfiBootScriptExecutorVariable );
967 return EFI_SUCCESS;
968 }
969 /**
970 Main entry for S3 Resume PEIM.
971
972 This routine is to install EFI_PEI_S3_RESUME2_PPI.
973
974 @param FileHandle Handle of the file being invoked.
975 @param PeiServices Pointer to PEI Services table.
976
977 @retval EFI_SUCCESS S3Resume Ppi is installed successfully.
978
979 **/
980 EFI_STATUS
981 EFIAPI
982 PeimS3ResumeEntryPoint (
983 IN EFI_PEI_FILE_HANDLE FileHandle,
984 IN CONST EFI_PEI_SERVICES **PeiServices
985 )
986 {
987 EFI_STATUS Status;
988
989 //
990 // Install S3 Resume Ppi
991 //
992 Status = (**PeiServices).InstallPpi (PeiServices, &mPpiList);
993 ASSERT_EFI_ERROR (Status);
994
995 return EFI_SUCCESS;
996 }
997
EFI Development Kit II mirror for PVE