]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/Acpi/BootScriptExecutorDxe/ScriptExecute.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Add comments to explain the reason return status is not checked. The return status...
[mirror_edk2.git] / MdeModulePkg / Universal / Acpi / BootScriptExecutorDxe / ScriptExecute.c
CommitLineData
be46cd5f 1/** @file\r
2 This is the code for Boot Script Executer module.\r
3\r
4 This driver is dispatched by Dxe core and the driver will reload itself to ACPI NVS memory\r
5 in the entry point. The functionality is to interpret and restore the S3 boot script\r
6\r
5c0687cc 7Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
be46cd5f 8\r
9This program and the accompanying materials\r
10are licensed and made available under the terms and conditions of the BSD License\r
11which accompanies this distribution. The full text of the license may be found at\r
12http://opensource.org/licenses/bsd-license.php\r
13\r
14THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
15WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
16\r
17**/\r
18\r
19#include "ScriptExecute.h"\r
20\r
be46cd5f 21EFI_GUID mBootScriptExecutorImageGuid = {\r
22 0x9a8d3433, 0x9fe8, 0x42b6, 0x87, 0xb, 0x1e, 0x31, 0xc8, 0x4e, 0xbe, 0x3b\r
23};\r
24\r
be46cd5f 25/**\r
26 Entry function of Boot script exector. This function will be executed in\r
27 S3 boot path.\r
28 This function should not return, because it is invoked by switch stack.\r
29\r
30 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT\r
31 @param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE\r
32\r
33 @retval EFI_INVALID_PARAMETER - OS waking vector not found\r
34 @retval EFI_UNSUPPORTED - something wrong when we resume to OS\r
35**/\r
36EFI_STATUS\r
37EFIAPI\r
38S3BootScriptExecutorEntryFunction (\r
39 IN ACPI_S3_CONTEXT *AcpiS3Context,\r
40 IN PEI_S3_RESUME_STATE *PeiS3ResumeState\r
41 )\r
42{\r
43 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs;\r
44 EFI_STATUS Status;\r
45 UINTN TempStackTop;\r
46 UINTN TempStack[0x10];\r
47 UINTN AsmTransferControl16Address;\r
48\r
be46cd5f 49 //\r
50 // Disable interrupt of Debug timer, since new IDT table cannot handle it.\r
51 //\r
52 SaveAndSetDebugTimerInterrupt (FALSE);\r
53\r
54 //\r
55 // Restore IDT for debug\r
56 //\r
57 SetIdtEntry (AcpiS3Context);\r
58\r
59 //\r
60 // Initialize Debug Agent to support source level debug in S3 path.\r
61 //\r
62 InitializeDebugAgent (DEBUG_AGENT_INIT_S3, NULL, NULL);\r
63\r
64 //\r
65 // Because not install BootScriptExecute PPI(used just in this module), So just pass NULL\r
66 // for that parameter.\r
67 //\r
be46cd5f 68 Status = S3BootScriptExecute ();\r
be46cd5f 69 if (EFI_ERROR (Status)) {\r
70 return Status;\r
71 }\r
72\r
73 AsmWbinvd ();\r
74\r
75 //\r
76 // Get ACPI Table Address\r
77 //\r
78 Facs = (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable));\r
79\r
80 if ((Facs == NULL) ||\r
81 (Facs->Signature != EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) ||\r
82 ((Facs->FirmwareWakingVector == 0) && (Facs->XFirmwareWakingVector == 0)) ) {\r
83 CpuDeadLoop();\r
84 return EFI_INVALID_PARAMETER;\r
85 }\r
86\r
87 //\r
88 // We need turn back to S3Resume - install boot script done ppi and report status code on S3resume.\r
89 //\r
90 if (PeiS3ResumeState != 0) {\r
91 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
92 //\r
93 // X64 S3 Resume\r
94 //\r
95 DEBUG ((EFI_D_ERROR, "Call AsmDisablePaging64() to return to S3 Resume in PEI Phase\n"));\r
96 PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl32;\r
97\r
98 //\r
99 // more step needed - because relative address is handled differently between X64 and IA32.\r
100 //\r
101 AsmTransferControl16Address = (UINTN)AsmTransferControl16;\r
102 AsmFixAddress16 = (UINT32)AsmTransferControl16Address;\r
103 AsmJmpAddr32 = (UINT32)((Facs->FirmwareWakingVector & 0xF) | ((Facs->FirmwareWakingVector & 0xFFFF0) << 12));\r
104\r
105 AsmDisablePaging64 (\r
106 PeiS3ResumeState->ReturnCs,\r
107 (UINT32)PeiS3ResumeState->ReturnEntryPoint,\r
108 (UINT32)(UINTN)AcpiS3Context,\r
109 (UINT32)(UINTN)PeiS3ResumeState,\r
110 (UINT32)PeiS3ResumeState->ReturnStackPointer\r
111 );\r
112 } else {\r
113 //\r
114 // IA32 S3 Resume\r
115 //\r
116 DEBUG ((EFI_D_ERROR, "Call SwitchStack() to return to S3 Resume in PEI Phase\n"));\r
117 PeiS3ResumeState->AsmTransferControl = (EFI_PHYSICAL_ADDRESS)(UINTN)AsmTransferControl;\r
118\r
119 SwitchStack (\r
120 (SWITCH_STACK_ENTRY_POINT)(UINTN)PeiS3ResumeState->ReturnEntryPoint,\r
121 (VOID *)(UINTN)AcpiS3Context,\r
122 (VOID *)(UINTN)PeiS3ResumeState,\r
123 (VOID *)(UINTN)PeiS3ResumeState->ReturnStackPointer\r
124 );\r
125 }\r
126\r
127 //\r
128 // Never run to here\r
129 //\r
130 CpuDeadLoop();\r
131 return EFI_UNSUPPORTED;\r
132 }\r
133\r
be46cd5f 134 if (Facs->XFirmwareWakingVector != 0) {\r
135 //\r
136 // Switch to native waking vector\r
137 //\r
138 TempStackTop = (UINTN)&TempStack + sizeof(TempStack);\r
139 if ((Facs->Version == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION) &&\r
140 ((Facs->Flags & EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F) != 0) &&\r
141 ((Facs->Flags & EFI_ACPI_4_0_OSPM_64BIT_WAKE__F) != 0)) {\r
142 //\r
143 // X64 long mode waking vector\r
144 //\r
145 DEBUG (( EFI_D_ERROR, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
146 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
147 SwitchStack (\r
148 (SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
149 NULL,\r
150 NULL,\r
151 (VOID *)(UINTN)TempStackTop\r
152 );\r
153 } else {\r
154 // Unsupported for 32bit DXE, 64bit OS vector\r
155 DEBUG (( EFI_D_ERROR, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));\r
156 ASSERT (FALSE);\r
157 }\r
158 } else {\r
159 //\r
160 // IA32 protected mode waking vector (Page disabled)\r
161 //\r
162 DEBUG (( EFI_D_ERROR, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
163 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
164 AsmDisablePaging64 (\r
165 0x10,\r
166 (UINT32)Facs->XFirmwareWakingVector,\r
167 0,\r
168 0,\r
169 (UINT32)TempStackTop\r
170 );\r
171 } else {\r
172 SwitchStack (\r
173 (SWITCH_STACK_ENTRY_POINT)(UINTN)Facs->XFirmwareWakingVector,\r
174 NULL,\r
175 NULL,\r
176 (VOID *)(UINTN)TempStackTop\r
177 );\r
178 }\r
179 }\r
180 } else {\r
181 //\r
182 // 16bit Realmode waking vector\r
183 //\r
184 DEBUG (( EFI_D_ERROR, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN)Facs->FirmwareWakingVector));\r
185 AsmTransferControl (Facs->FirmwareWakingVector, 0x0);\r
186 }\r
187\r
188 //\r
189 // Never run to here\r
190 //\r
191 CpuDeadLoop();\r
192 return EFI_UNSUPPORTED;\r
193}\r
194/**\r
195 Entrypoint of Boot script exector driver, this function will be executed in\r
196 normal boot phase and invoked by DXE dispatch.\r
197\r
198 @param[in] ImageHandle The firmware allocated handle for the EFI image.\r
199 @param[in] SystemTable A pointer to the EFI System Table.\r
200\r
201 @retval EFI_SUCCESS The entry point is executed successfully.\r
202 @retval other Some error occurs when executing this entry point.\r
203**/\r
204EFI_STATUS\r
205EFIAPI\r
206BootScriptExecutorEntryPoint (\r
207 IN EFI_HANDLE ImageHandle,\r
208 IN EFI_SYSTEM_TABLE *SystemTable\r
209 )\r
210{\r
211 UINT8 *Buffer;\r
212 UINTN BufferSize;\r
213 UINTN Pages;\r
214 EFI_PHYSICAL_ADDRESS FfsBuffer;\r
215 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;\r
216 BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable;\r
217 EFI_PHYSICAL_ADDRESS BootScriptExecutorBuffer;\r
218 EFI_STATUS Status;\r
219 VOID *DevicePath;\r
220 EFI_HANDLE NewImageHandle;\r
221\r
222 //\r
223 // Test if the gEfiCallerIdGuid of this image is already installed. if not, the entry\r
224 // point is loaded by DXE code which is the first time loaded. or else, it is already\r
225 // be reloaded be itself.This is a work-around\r
226 //\r
227 Status = gBS->LocateProtocol (&gEfiCallerIdGuid, NULL, &DevicePath);\r
228 if (EFI_ERROR (Status)) {\r
229\r
230 //\r
231 // This is the first-time loaded by DXE core. reload itself to NVS mem\r
232 //\r
233 //\r
234 // A workarouond: Here we install a dummy handle\r
235 //\r
236 NewImageHandle = NULL;\r
237 Status = gBS->InstallProtocolInterface (\r
238 &NewImageHandle,\r
239 &gEfiCallerIdGuid,\r
240 EFI_NATIVE_INTERFACE,\r
241 NULL\r
242 );\r
243\r
244 Status = GetSectionFromAnyFv (\r
245 &gEfiCallerIdGuid,\r
246 EFI_SECTION_PE32,\r
247 0,\r
248 (VOID **) &Buffer,\r
249 &BufferSize\r
250 );\r
251 ImageContext.Handle = Buffer;\r
252 ImageContext.ImageRead = PeCoffLoaderImageReadFromMemory;\r
253 //\r
254 // Get information about the image being loaded\r
255 //\r
256 Status = PeCoffLoaderGetImageInfo (&ImageContext);\r
257 if (EFI_ERROR (Status)) {\r
258 return Status;\r
259 }\r
260 Pages = EFI_SIZE_TO_PAGES(BufferSize + ImageContext.SectionAlignment);\r
261 FfsBuffer = 0xFFFFFFFF;\r
262 Status = gBS->AllocatePages (\r
263 AllocateMaxAddress,\r
264 EfiACPIMemoryNVS,\r
265 Pages,\r
266 &FfsBuffer\r
267 );\r
268 if (EFI_ERROR (Status)) {\r
269 return EFI_OUT_OF_RESOURCES;\r
270 }\r
271 ImageContext.ImageAddress = (PHYSICAL_ADDRESS)(UINTN)FfsBuffer;\r
272 //\r
273 // Align buffer on section boundry\r
274 //\r
275 ImageContext.ImageAddress += ImageContext.SectionAlignment - 1;\r
276 ImageContext.ImageAddress &= ~(ImageContext.SectionAlignment - 1);\r
277 //\r
278 // Load the image to our new buffer\r
279 //\r
280 Status = PeCoffLoaderLoadImage (&ImageContext);\r
281 if (EFI_ERROR (Status)) {\r
282 gBS->FreePages (FfsBuffer, Pages);\r
283 return Status;\r
284 }\r
285\r
286 //\r
287 // Relocate the image in our new buffer\r
288 //\r
289 Status = PeCoffLoaderRelocateImage (&ImageContext);\r
290\r
291 if (EFI_ERROR (Status)) {\r
292 PeCoffLoaderUnloadImage (&ImageContext);\r
293 gBS->FreePages (FfsBuffer, Pages);\r
294 return Status;\r
295 }\r
296 //\r
297 // Flush the instruction cache so the image data is written before we execute it\r
298 //\r
299 InvalidateInstructionCacheRange ((VOID *)(UINTN)ImageContext.ImageAddress, (UINTN)ImageContext.ImageSize);\r
300 Status = ((EFI_IMAGE_ENTRY_POINT)(UINTN)(ImageContext.EntryPoint)) (NewImageHandle, SystemTable);\r
301 if (EFI_ERROR (Status)) {\r
302 gBS->FreePages (FfsBuffer, Pages);\r
303 return Status;\r
304 }\r
305 //\r
306 // Additional step for BootScript integrity\r
307 // Save BootScriptExecutor image\r
308 //\r
309 Status = SaveLockBox (\r
310 &mBootScriptExecutorImageGuid,\r
311 (VOID *)(UINTN)ImageContext.ImageAddress,\r
312 (UINTN)ImageContext.ImageSize\r
313 );\r
314 ASSERT_EFI_ERROR (Status);\r
315\r
316 Status = SetLockBoxAttributes (&mBootScriptExecutorImageGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
317 ASSERT_EFI_ERROR (Status);\r
318\r
319 } else {\r
320 //\r
321 // the entry point is invoked after reloading. following code only run in ACPI NVS\r
322 //\r
323 BufferSize = sizeof (BOOT_SCRIPT_EXECUTOR_VARIABLE);\r
324\r
325 BootScriptExecutorBuffer = 0xFFFFFFFF;\r
326 Pages = EFI_SIZE_TO_PAGES(BufferSize);\r
327 Status = gBS->AllocatePages (\r
328 AllocateMaxAddress,\r
329 EfiACPIMemoryNVS,\r
330 Pages,\r
331 &BootScriptExecutorBuffer\r
332 );\r
333 if (EFI_ERROR (Status)) {\r
334 return EFI_OUT_OF_RESOURCES;\r
335 }\r
336\r
337 EfiBootScriptExecutorVariable = (BOOT_SCRIPT_EXECUTOR_VARIABLE *)(UINTN)BootScriptExecutorBuffer;\r
338 EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = (UINTN) S3BootScriptExecutorEntryFunction ;\r
339\r
340 Status = SaveLockBox (\r
341 &gEfiBootScriptExecutorVariableGuid,\r
342 &BootScriptExecutorBuffer,\r
343 sizeof(BootScriptExecutorBuffer)\r
344 );\r
345 ASSERT_EFI_ERROR (Status);\r
346\r
347 //\r
348 // Additional step for BootScript integrity\r
349 // Save BootScriptExecutor context\r
350 //\r
351 Status = SaveLockBox (\r
352 &gEfiBootScriptExecutorContextGuid,\r
353 EfiBootScriptExecutorVariable,\r
354 sizeof(*EfiBootScriptExecutorVariable)\r
355 );\r
356 ASSERT_EFI_ERROR (Status);\r
357\r
358 Status = SetLockBoxAttributes (&gEfiBootScriptExecutorContextGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
359 ASSERT_EFI_ERROR (Status);\r
360\r
be46cd5f 361 }\r
362\r
363 return EFI_SUCCESS;\r
364}\r
365\r
366\r
367\r
EFI Development Kit II mirror for PVE