]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c
projects / mirror_edk2.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
MdeModulePkg: Refine casting expression result to bigger size
[mirror_edk2.git] / MdeModulePkg / Library / PiDxeS3BootScriptLib / BootScriptSave.c
... / ...
CommitLineData
1/** @file\r
2 Save the S3 data to S3 boot script.\r
3\r
4 Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
5\r
6 This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions\r
8 of the BSD License which accompanies this distribution. The\r
9 full text of the license may be found at\r
10 http://opensource.org/licenses/bsd-license.php\r
11\r
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14\r
15**/\r
16#include "InternalBootScriptLib.h"\r
17\r
18/**\r
19\r
20 Data structure usage:\r
21\r
22 +------------------------------+<------- PcdS3BootScriptTablePrivateDataPtr\r
23 | SCRIPT_TABLE_PRIVATE_DATA | (mS3BootScriptTablePtr, Before SmmReadyToLock)\r
24 | TableBase |--- PcdS3BootScriptTablePrivateSmmDataPtr\r
25 | TableLength |--|-- (mS3BootScriptTablePtr = mS3BootScriptTableSmmPtr, After SmmReadyToLock InSmm)\r
26 | TableMemoryPageNumber |--|-|----\r
27 | AtRuntime | | | |\r
28 | InSmm | | | |\r
29 | BootTimeScriptLength |--|-|---|---\r
30 | SmmLocked | | | | |\r
31 | BackFromS3 | | | | |\r
32 +------------------------------+ | | | |\r
33 | | | |\r
34 +------------------------------+<-- | | |\r
35 | EFI_BOOT_SCRIPT_TABLE_HEADER | | | |\r
36 | TableLength |----|-- | |\r
37 +------------------------------+ | | | |\r
38 | ...... | | | | |\r
39 +------------------------------+<---- | | |\r
40 | EFI_BOOT_SCRIPT_TERMINATE | | | |\r
41 +------------------------------+<------ | |\r
42 | |\r
43 | |\r
44 mBootScriptDataBootTimeGuid LockBox: | |\r
45 Used to restore data after back from S3| |\r
46 to handle potential INSERT boot script | |\r
47 at runtime. | |\r
48 +------------------------------+ | |\r
49 | Boot Time Boot Script | | |\r
50 | Before SmmReadyToLock | | |\r
51 | | | |\r
52 | | | |\r
53 +------------------------------+ | |\r
54 | Boot Time Boot Script | | |\r
55 | After SmmReadyToLock InSmm | | |\r
56 | | | |\r
57 +------------------------------+<-------|--|\r
58 | |\r
59 | |\r
60 mBootScriptDataGuid LockBox: (IN_PLACE) | |\r
61 Used to restore data at S3 resume. | |\r
62 +------------------------------+ | |\r
63 | Boot Time Boot Script | | |\r
64 | Before SmmReadyToLock | | |\r
65 | | | |\r
66 | | | |\r
67 +------------------------------+ | |\r
68 | Boot Time Boot Script | | |\r
69 | After SmmReadyToLock InSmm | | |\r
70 | | | |\r
71 +------------------------------+<-------|---\r
72 | Runtime Boot Script | |\r
73 | After SmmReadyToLock InSmm | |\r
74 +------------------------------+ |\r
75 | ...... | |\r
76 +------------------------------+<--------\r
77\r
78\r
79 mBootScriptTableBaseGuid LockBox: (IN_PLACE)\r
80 +------------------------------+\r
81 | mS3BootScriptTablePtr-> |\r
82 | TableBase |\r
83 +------------------------------+\r
84\r
85\r
86 mBootScriptSmmPrivateDataGuid LockBox: (IN_PLACE)\r
87 SMM private data with BackFromS3 = TRUE\r
88 at runtime. S3 will help restore it to\r
89 tell the Library the system is back from S3.\r
90 +------------------------------+\r
91 | SCRIPT_TABLE_PRIVATE_DATA |\r
92 | TableBase |\r
93 | TableLength |\r
94 | TableMemoryPageNumber |\r
95 | AtRuntime |\r
96 | InSmm |\r
97 | BootTimeScriptLength |\r
98 | SmmLocked |\r
99 | BackFromS3 = TRUE |\r
100 +------------------------------+\r
101\r
102**/\r
103\r
104SCRIPT_TABLE_PRIVATE_DATA *mS3BootScriptTablePtr;\r
105\r
106//\r
107// Allocate SMM copy because we can not use mS3BootScriptTablePtr after SmmReadyToLock in InSmm.\r
108//\r
109SCRIPT_TABLE_PRIVATE_DATA *mS3BootScriptTableSmmPtr;\r
110\r
111EFI_GUID mBootScriptDataGuid = {\r
112 0xaea6b965, 0xdcf5, 0x4311, { 0xb4, 0xb8, 0xf, 0x12, 0x46, 0x44, 0x94, 0xd2 }\r
113};\r
114\r
115EFI_GUID mBootScriptDataBootTimeGuid = {\r
116 0xb5af1d7a, 0xb8cf, 0x4eb3, { 0x89, 0x25, 0xa8, 0x20, 0xe1, 0x6b, 0x68, 0x7d }\r
117};\r
118\r
119EFI_GUID mBootScriptTableBaseGuid = {\r
120 0x1810ab4a, 0x2314, 0x4df6, { 0x81, 0xeb, 0x67, 0xc6, 0xec, 0x5, 0x85, 0x91 }\r
121};\r
122\r
123EFI_GUID mBootScriptSmmPrivateDataGuid = {\r
124 0x627ee2da, 0x3bf9, 0x439b, { 0x92, 0x9f, 0x2e, 0xe, 0x6e, 0x9d, 0xba, 0x62 }\r
125};\r
126\r
127EFI_EVENT mEventDxeSmmReadyToLock = NULL;\r
128VOID *mRegistrationSmmExitBootServices = NULL;\r
129VOID *mRegistrationSmmLegacyBoot = NULL;\r
130VOID *mRegistrationSmmReadyToLock = NULL;\r
131BOOLEAN mS3BootScriptTableAllocated = FALSE;\r
132BOOLEAN mS3BootScriptTableSmmAllocated = FALSE;\r
133EFI_SMM_SYSTEM_TABLE2 *mBootScriptSmst = NULL;\r
134\r
135/**\r
136 This is an internal function to add a terminate node the entry, recalculate the table\r
137 length and fill into the table.\r
138\r
139 @return the base address of the boot script table.\r
140 **/\r
141UINT8*\r
142S3BootScriptInternalCloseTable (\r
143 VOID\r
144 )\r
145{\r
146 UINT8 *S3TableBase;\r
147 EFI_BOOT_SCRIPT_TERMINATE ScriptTerminate;\r
148 EFI_BOOT_SCRIPT_TABLE_HEADER *ScriptTableInfo;\r
149 S3TableBase = mS3BootScriptTablePtr->TableBase;\r
150\r
151 if (S3TableBase == NULL) {\r
152 //\r
153 // the table is not exist\r
154 //\r
155 return S3TableBase;\r
156 }\r
157 //\r
158 // Append the termination entry.\r
159 //\r
160 ScriptTerminate.OpCode = S3_BOOT_SCRIPT_LIB_TERMINATE_OPCODE;\r
161 ScriptTerminate.Length = (UINT8) sizeof (EFI_BOOT_SCRIPT_TERMINATE);\r
162 CopyMem (mS3BootScriptTablePtr->TableBase + mS3BootScriptTablePtr->TableLength, &ScriptTerminate, sizeof (EFI_BOOT_SCRIPT_TERMINATE));\r
163 //\r
164 // fill the table length\r
165 //\r
166 ScriptTableInfo = (EFI_BOOT_SCRIPT_TABLE_HEADER*)(mS3BootScriptTablePtr->TableBase);\r
167 ScriptTableInfo->TableLength = mS3BootScriptTablePtr->TableLength + sizeof (EFI_BOOT_SCRIPT_TERMINATE);\r
168\r
169\r
170\r
171 return S3TableBase;\r
172 //\r
173 // NOTE: Here we did NOT adjust the mS3BootScriptTablePtr->TableLength to\r
174 // mS3BootScriptTablePtr->TableLength + sizeof (EFI_BOOT_SCRIPT_TERMINATE).\r
175 // Because maybe after SmmReadyToLock, we still need add entries into the table,\r
176 // and the entry should be added start before this TERMINATE node.\r
177 //\r
178}\r
179\r
180/**\r
181 This function save boot script data to LockBox.\r
182\r
183**/\r
184VOID\r
185SaveBootScriptDataToLockBox (\r
186 VOID\r
187 )\r
188{\r
189 EFI_STATUS Status;\r
190\r
191 //\r
192 // Save whole memory copy into LockBox.\r
193 // It will be used to restore data at S3 resume.\r
194 //\r
195 Status = SaveLockBox (\r
196 &mBootScriptDataGuid,\r
197 (VOID *)mS3BootScriptTablePtr->TableBase,\r
198 EFI_PAGES_TO_SIZE (mS3BootScriptTablePtr->TableMemoryPageNumber)\r
199 );\r
200 ASSERT_EFI_ERROR (Status);\r
201\r
202 Status = SetLockBoxAttributes (&mBootScriptDataGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
203 ASSERT_EFI_ERROR (Status);\r
204\r
205 //\r
206 // Just need save TableBase.\r
207 // Do not update other field because they will NOT be used in S3.\r
208 //\r
209 Status = SaveLockBox (\r
210 &mBootScriptTableBaseGuid,\r
211 (VOID *)&mS3BootScriptTablePtr->TableBase,\r
212 sizeof(mS3BootScriptTablePtr->TableBase)\r
213 );\r
214 ASSERT_EFI_ERROR (Status);\r
215\r
216 Status = SetLockBoxAttributes (&mBootScriptTableBaseGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
217 ASSERT_EFI_ERROR (Status);\r
218}\r
219\r
220/**\r
221 This is the Event call back function to notify the Library the system is entering\r
222 SmmLocked phase.\r
223\r
224 @param Event Pointer to this event\r
225 @param Context Event handler private data\r
226 **/\r
227VOID\r
228EFIAPI\r
229S3BootScriptEventCallBack (\r
230 IN EFI_EVENT Event,\r
231 IN VOID *Context\r
232 )\r
233{\r
234 EFI_STATUS Status;\r
235 VOID *Interface;\r
236\r
237 //\r
238 // Try to locate it because EfiCreateProtocolNotifyEvent will trigger it once when registration.\r
239 // Just return if it is not found.\r
240 //\r
241 Status = gBS->LocateProtocol (\r
242 &gEfiDxeSmmReadyToLockProtocolGuid,\r
243 NULL,\r
244 &Interface\r
245 );\r
246 if (EFI_ERROR (Status)) {\r
247 return ;\r
248 }\r
249\r
250 //\r
251 // Here we should tell the library that we are entering SmmLocked phase.\r
252 // and the memory page number occupied by the table should not grow anymore.\r
253 //\r
254 if (!mS3BootScriptTablePtr->SmmLocked) {\r
255 //\r
256 // Before SmmReadyToLock, we need not write the terminate node when adding a node to boot scipt table\r
257 // or else, that will impact the performance. However, after SmmReadyToLock, we should append terminate\r
258 // node on every add to boot script table.\r
259 //\r
260 S3BootScriptInternalCloseTable ();\r
261 mS3BootScriptTablePtr->SmmLocked = TRUE;\r
262\r
263 //\r
264 // Save BootScript data to lockbox\r
265 //\r
266 SaveBootScriptDataToLockBox ();\r
267 }\r
268}\r
269\r
270/**\r
271 This is the Event call back function is triggered in SMM to notify the Library\r
272 the system is entering SmmLocked phase and set InSmm flag.\r
273\r
274 @param Protocol Points to the protocol's unique identifier\r
275 @param Interface Points to the interface instance\r
276 @param Handle The handle on which the interface was installed\r
277\r
278 @retval EFI_SUCCESS SmmEventCallback runs successfully\r
279 **/\r
280EFI_STATUS\r
281EFIAPI\r
282S3BootScriptSmmEventCallBack (\r
283 IN CONST EFI_GUID *Protocol,\r
284 IN VOID *Interface,\r
285 IN EFI_HANDLE Handle\r
286 )\r
287{\r
288 //\r
289 // Check if it is already done\r
290 //\r
291 if (mS3BootScriptTablePtr == mS3BootScriptTableSmmPtr) {\r
292 return EFI_SUCCESS;\r
293 }\r
294\r
295 //\r
296 // Last chance to call-out, just make sure SmmLocked is set.\r
297 //\r
298 S3BootScriptEventCallBack (NULL, NULL);\r
299\r
300 //\r
301 // Save a SMM copy. If TableBase is NOT null, it means SMM copy has been ready, skip copy mem.\r
302 //\r
303 if (mS3BootScriptTableSmmPtr->TableBase == NULL) {\r
304 CopyMem (mS3BootScriptTableSmmPtr, mS3BootScriptTablePtr, sizeof(*mS3BootScriptTablePtr));\r
305\r
306 //\r
307 // Set InSmm, we allow boot script update when InSmm, but not allow boot script outside SMM.\r
308 // InSmm will only be checked if SmmLocked is TRUE.\r
309 //\r
310 mS3BootScriptTableSmmPtr->InSmm = TRUE;\r
311 }\r
312 //\r
313 // We should not use ACPI Reserved copy, because it is not safe.\r
314 //\r
315 mS3BootScriptTablePtr = mS3BootScriptTableSmmPtr;\r
316\r
317 return EFI_SUCCESS;\r
318}\r
319\r
320/**\r
321 This function is to save boot time boot script data to LockBox.\r
322\r
323 Because there may be INSERT boot script at runtime in SMM.\r
324 The boot time copy will be used to restore data after back from S3.\r
325 Otherwise the data inserted may cause some boot time boot script data lost\r
326 if only BootScriptData used.\r
327\r
328**/\r
329VOID\r
330SaveBootTimeDataToLockBox (\r
331 VOID\r
332 )\r
333{\r
334 EFI_STATUS Status;\r
335\r
336 //\r
337 // ACPI Reserved copy is not safe, restore from BootScriptData LockBox first,\r
338 // and then save the data to BootScriptDataBootTime LockBox.\r
339 //\r
340 Status = RestoreLockBox (\r
341 &mBootScriptDataGuid,\r
342 NULL,\r
343 NULL\r
344 );\r
345 ASSERT_EFI_ERROR (Status);\r
346\r
347 //\r
348 // Save BootScriptDataBootTime\r
349 // It will be used to restore data after back from S3.\r
350 //\r
351 Status = SaveLockBox (\r
352 &mBootScriptDataBootTimeGuid,\r
353 (VOID *) mS3BootScriptTablePtr->TableBase,\r
354 mS3BootScriptTablePtr->BootTimeScriptLength\r
355 );\r
356 ASSERT_EFI_ERROR (Status);\r
357}\r
358\r
359/**\r
360 This function save boot script SMM private data to LockBox with BackFromS3 = TRUE at runtime.\r
361 S3 resume will help restore it to tell the Library the system is back from S3.\r
362\r
363**/\r
364VOID\r
365SaveSmmPriviateDataToLockBoxAtRuntime (\r
366 VOID\r
367 )\r
368{\r
369 EFI_STATUS Status;\r
370\r
371 //\r
372 // Save boot script SMM private data with BackFromS3 = TRUE.\r
373 //\r
374 mS3BootScriptTablePtr->BackFromS3 = TRUE;\r
375 Status = SaveLockBox (\r
376 &mBootScriptSmmPrivateDataGuid,\r
377 (VOID *) mS3BootScriptTablePtr,\r
378 sizeof (SCRIPT_TABLE_PRIVATE_DATA)\r
379 );\r
380 ASSERT_EFI_ERROR (Status);\r
381\r
382 Status = SetLockBoxAttributes (&mBootScriptSmmPrivateDataGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);\r
383 ASSERT_EFI_ERROR (Status);\r
384\r
385 //\r
386 // Set BackFromS3 flag back to FALSE to indicate that now is not back from S3.\r
387 //\r
388 mS3BootScriptTablePtr->BackFromS3 = FALSE;\r
389}\r
390\r
391/**\r
392 This is the Event call back function is triggered in SMM to notify the Library\r
393 the system is entering runtime phase.\r
394\r
395 @param[in] Protocol Points to the protocol's unique identifier\r
396 @param[in] Interface Points to the interface instance\r
397 @param[in] Handle The handle on which the interface was installed\r
398\r
399 @retval EFI_SUCCESS SmmAtRuntimeCallBack runs successfully\r
400 **/\r
401EFI_STATUS\r
402EFIAPI\r
403S3BootScriptSmmAtRuntimeCallBack (\r
404 IN CONST EFI_GUID *Protocol,\r
405 IN VOID *Interface,\r
406 IN EFI_HANDLE Handle\r
407 )\r
408{\r
409 if (!mS3BootScriptTablePtr->AtRuntime) {\r
410 mS3BootScriptTablePtr->BootTimeScriptLength = (UINT32) (mS3BootScriptTablePtr->TableLength + sizeof (EFI_BOOT_SCRIPT_TERMINATE));\r
411 SaveBootTimeDataToLockBox ();\r
412\r
413 mS3BootScriptTablePtr->AtRuntime = TRUE;\r
414 SaveSmmPriviateDataToLockBoxAtRuntime ();\r
415 }\r
416\r
417 return EFI_SUCCESS;\r
418}\r
419\r
420/**\r
421 Library Constructor.\r
422 this function just identify it is a smm driver or non-smm driver linked against\r
423 with the library\r
424\r
425 @param ImageHandle The firmware allocated handle for the EFI image.\r
426 @param SystemTable A pointer to the EFI System Table.\r
427\r
428 @retval RETURN_SUCCESS The constructor always returns RETURN_SUCCESS.\r
429\r
430**/\r
431RETURN_STATUS\r
432EFIAPI\r
433S3BootScriptLibInitialize (\r
434 IN EFI_HANDLE ImageHandle,\r
435 IN EFI_SYSTEM_TABLE *SystemTable\r
436 )\r
437{\r
438 EFI_STATUS Status;\r
439 SCRIPT_TABLE_PRIVATE_DATA *S3TablePtr;\r
440 SCRIPT_TABLE_PRIVATE_DATA *S3TableSmmPtr;\r
441 VOID *Registration;\r
442 EFI_SMM_BASE2_PROTOCOL *SmmBase2;\r
443 BOOLEAN InSmm;\r
444 EFI_PHYSICAL_ADDRESS Buffer;\r
445\r
446 S3TablePtr = (SCRIPT_TABLE_PRIVATE_DATA*)(UINTN)PcdGet64(PcdS3BootScriptTablePrivateDataPtr);\r
447 //\r
448 // The Boot script private data is not be initialized. create it\r
449 //\r
450 if (S3TablePtr == 0) {\r
451 Buffer = SIZE_4GB - 1;\r
452 Status = gBS->AllocatePages (\r
453 AllocateMaxAddress,\r
454 EfiReservedMemoryType,\r
455 EFI_SIZE_TO_PAGES(sizeof(SCRIPT_TABLE_PRIVATE_DATA)),\r
456 &Buffer\r
457 );\r
458 ASSERT_EFI_ERROR (Status);\r
459 mS3BootScriptTableAllocated = TRUE;\r
460 S3TablePtr = (VOID *) (UINTN) Buffer;\r
461\r
462 Status = PcdSet64S (PcdS3BootScriptTablePrivateDataPtr, (UINT64) (UINTN)S3TablePtr);\r
463 ASSERT_EFI_ERROR (Status);\r
464 ZeroMem (S3TablePtr, sizeof(SCRIPT_TABLE_PRIVATE_DATA));\r
465 //\r
466 // Create event to notify the library system enter the SmmLocked phase.\r
467 //\r
468 mEventDxeSmmReadyToLock = EfiCreateProtocolNotifyEvent (\r
469 &gEfiDxeSmmReadyToLockProtocolGuid,\r
470 TPL_CALLBACK,\r
471 S3BootScriptEventCallBack,\r
472 NULL,\r
473 &Registration\r
474 );\r
475 ASSERT (mEventDxeSmmReadyToLock != NULL);\r
476 }\r
477 mS3BootScriptTablePtr = S3TablePtr;\r
478\r
479 //\r
480 // Get InSmm, we need to register SmmReadyToLock if this library is linked to SMM driver.\r
481 //\r
482 Status = gBS->LocateProtocol (&gEfiSmmBase2ProtocolGuid, NULL, (VOID**) &SmmBase2);\r
483 if (EFI_ERROR (Status)) {\r
484 return RETURN_SUCCESS;\r
485 }\r
486 Status = SmmBase2->InSmm (SmmBase2, &InSmm);\r
487 if (EFI_ERROR (Status)) {\r
488 return RETURN_SUCCESS;\r
489 }\r
490 if (!InSmm) {\r
491 return RETURN_SUCCESS;\r
492 }\r
493 //\r
494 // Good, we are in SMM\r
495 //\r
496 Status = SmmBase2->GetSmstLocation (SmmBase2, &mBootScriptSmst);\r
497 if (EFI_ERROR (Status)) {\r
498 return RETURN_SUCCESS;\r
499 }\r
500\r
501 S3TableSmmPtr = (SCRIPT_TABLE_PRIVATE_DATA*)(UINTN)PcdGet64(PcdS3BootScriptTablePrivateSmmDataPtr);\r
502 //\r
503 // The Boot script private data in SMM is not be initialized. create it\r
504 //\r
505 if (S3TableSmmPtr == 0) {\r
506 Status = mBootScriptSmst->SmmAllocatePool (\r
507 EfiRuntimeServicesData,\r
508 sizeof(SCRIPT_TABLE_PRIVATE_DATA),\r
509 (VOID **) &S3TableSmmPtr\r
510 );\r
511 ASSERT_EFI_ERROR (Status);\r
512 mS3BootScriptTableSmmAllocated = TRUE;\r
513\r
514 Status = PcdSet64S (PcdS3BootScriptTablePrivateSmmDataPtr, (UINT64) (UINTN)S3TableSmmPtr);\r
515 ASSERT_EFI_ERROR (Status);\r
516 ZeroMem (S3TableSmmPtr, sizeof(SCRIPT_TABLE_PRIVATE_DATA));\r
517\r
518 //\r
519 // Register SmmExitBootServices and SmmLegacyBoot notification.\r
520 //\r
521 Status = mBootScriptSmst->SmmRegisterProtocolNotify (\r
522 &gEdkiiSmmExitBootServicesProtocolGuid,\r
523 S3BootScriptSmmAtRuntimeCallBack,\r
524 &mRegistrationSmmExitBootServices\r
525 );\r
526 ASSERT_EFI_ERROR (Status);\r
527\r
528 Status = mBootScriptSmst->SmmRegisterProtocolNotify (\r
529 &gEdkiiSmmLegacyBootProtocolGuid,\r
530 S3BootScriptSmmAtRuntimeCallBack,\r
531 &mRegistrationSmmLegacyBoot\r
532 );\r
533 ASSERT_EFI_ERROR (Status);\r
534 }\r
535 mS3BootScriptTableSmmPtr = S3TableSmmPtr;\r
536\r
537 //\r
538 // Register SmmReadyToLock notification.\r
539 //\r
540 Status = mBootScriptSmst->SmmRegisterProtocolNotify (\r
541 &gEfiSmmReadyToLockProtocolGuid,\r
542 S3BootScriptSmmEventCallBack,\r
543 &mRegistrationSmmReadyToLock\r
544 );\r
545 ASSERT_EFI_ERROR (Status);\r
546\r
547 return RETURN_SUCCESS;\r
548}\r
549\r
550/**\r
551 Library Destructor to free the resources allocated by\r
552 S3BootScriptLibInitialize() and unregister callbacks.\r
553\r
554 NOTICE: The destructor doesn't support unloading as a separate action, and it\r
555 only supports unloading if the containing driver's entry point function fails.\r
556\r
557 @param ImageHandle The firmware allocated handle for the EFI image.\r
558 @param SystemTable A pointer to the EFI System Table.\r
559\r
560 @retval RETURN_SUCCESS The destructor always returns RETURN_SUCCESS.\r
561\r
562**/\r
563RETURN_STATUS\r
564EFIAPI\r
565S3BootScriptLibDeinitialize (\r
566 IN EFI_HANDLE ImageHandle,\r
567 IN EFI_SYSTEM_TABLE *SystemTable\r
568 )\r
569{\r
570 EFI_STATUS Status;\r
571\r
572 DEBUG ((EFI_D_INFO, "%a() in %a module\n", __FUNCTION__, gEfiCallerBaseName));\r
573\r
574 if (mEventDxeSmmReadyToLock != NULL) {\r
575 //\r
576 // Close the DxeSmmReadyToLock event.\r
577 //\r
578 Status = gBS->CloseEvent (mEventDxeSmmReadyToLock);\r
579 ASSERT_EFI_ERROR (Status);\r
580 }\r
581\r
582 if (mBootScriptSmst != NULL) {\r
583 if (mRegistrationSmmExitBootServices != NULL) {\r
584 //\r
585 // Unregister SmmExitBootServices notification.\r
586 //\r
587 Status = mBootScriptSmst->SmmRegisterProtocolNotify (\r
588 &gEdkiiSmmExitBootServicesProtocolGuid,\r
589 NULL,\r
590 &mRegistrationSmmExitBootServices\r
591 );\r
592 ASSERT_EFI_ERROR (Status);\r
593 }\r
594 if (mRegistrationSmmLegacyBoot != NULL) {\r
595 //\r
596 // Unregister SmmLegacyBoot notification.\r
597 //\r
598 Status = mBootScriptSmst->SmmRegisterProtocolNotify (\r
599 &gEdkiiSmmLegacyBootProtocolGuid,\r
600 NULL,\r
601 &mRegistrationSmmLegacyBoot\r
602 );\r
603 ASSERT_EFI_ERROR (Status);\r
604 }\r
605 if (mRegistrationSmmReadyToLock != NULL) {\r
606 //\r
607 // Unregister SmmReadyToLock notification.\r
608 //\r
609 Status = mBootScriptSmst->SmmRegisterProtocolNotify (\r
610 &gEfiSmmReadyToLockProtocolGuid,\r
611 NULL,\r
612 &mRegistrationSmmReadyToLock\r
613 );\r
614 ASSERT_EFI_ERROR (Status);\r
615 }\r
616 }\r
617\r
618 //\r
619 // Free the resources allocated and set PCDs to 0.\r
620 //\r
621 if (mS3BootScriptTableAllocated) {\r
622 Status = gBS->FreePages ((EFI_PHYSICAL_ADDRESS) (UINTN) mS3BootScriptTablePtr, EFI_SIZE_TO_PAGES(sizeof(SCRIPT_TABLE_PRIVATE_DATA)));\r
623 ASSERT_EFI_ERROR (Status);\r
624 Status = PcdSet64S (PcdS3BootScriptTablePrivateDataPtr, 0);\r
625 ASSERT_EFI_ERROR (Status);\r
626 }\r
627 if ((mBootScriptSmst != NULL) && mS3BootScriptTableSmmAllocated) {\r
628 Status = mBootScriptSmst->SmmFreePool (mS3BootScriptTableSmmPtr);\r
629 ASSERT_EFI_ERROR (Status);\r
630 Status = PcdSet64S (PcdS3BootScriptTablePrivateSmmDataPtr, 0);\r
631 ASSERT_EFI_ERROR (Status);\r
632 }\r
633\r
634 return RETURN_SUCCESS;\r
635}\r
636\r
637/**\r
638 To get the start address from which a new boot time s3 boot script entry will write into.\r
639 If the table is not exist, the functio will first allocate a buffer for the table\r
640 If the table buffer is not enough for the new entry, in non-smm mode, the funtion will\r
641 invoke reallocate to enlarge buffer.\r
642\r
643 @param EntryLength the new entry length.\r
644\r
645 @retval the address from which the a new s3 boot script entry will write into\r
646 **/\r
647UINT8*\r
648S3BootScriptGetBootTimeEntryAddAddress (\r
649 UINT8 EntryLength\r
650 )\r
651{\r
652 EFI_PHYSICAL_ADDRESS S3TableBase;\r
653 EFI_PHYSICAL_ADDRESS NewS3TableBase;\r
654 UINT8 *NewEntryPtr;\r
655 UINT32 TableLength;\r
656 UINT16 PageNumber;\r
657 EFI_STATUS Status;\r
658 EFI_BOOT_SCRIPT_TABLE_HEADER *ScriptTableInfo;\r
659\r
660 S3TableBase = (EFI_PHYSICAL_ADDRESS)(UINTN)(mS3BootScriptTablePtr->TableBase);\r
661 if (S3TableBase == 0) {\r
662 //\r
663 // The table is not exist. This is the first to add entry.\r
664 // Allocate ACPI script table space under 4G memory.\r
665 //\r
666 S3TableBase = 0xffffffff;\r
667 Status = gBS->AllocatePages (\r
668 AllocateMaxAddress,\r
669 EfiReservedMemoryType,\r
670 2 + PcdGet16(PcdS3BootScriptRuntimeTableReservePageNumber),\r
671 (EFI_PHYSICAL_ADDRESS*)&S3TableBase\r
672 );\r
673\r
674 if (EFI_ERROR(Status)) {\r
675 ASSERT_EFI_ERROR (Status);\r
676 return 0;\r
677 }\r
678 //\r
679 // Fill Table Header\r
680 //\r
681 ScriptTableInfo = (EFI_BOOT_SCRIPT_TABLE_HEADER*)(UINTN)S3TableBase;\r
682 ScriptTableInfo->OpCode = S3_BOOT_SCRIPT_LIB_TABLE_OPCODE;\r
683 ScriptTableInfo->Length = (UINT8) sizeof (EFI_BOOT_SCRIPT_TABLE_HEADER);\r
684 ScriptTableInfo->Version = BOOT_SCRIPT_TABLE_VERSION;\r
685 ScriptTableInfo->TableLength = 0; // will be calculate at CloseTable\r
686 mS3BootScriptTablePtr->TableLength = sizeof (EFI_BOOT_SCRIPT_TABLE_HEADER);\r
687 mS3BootScriptTablePtr->TableBase = (UINT8*)(UINTN)S3TableBase;\r
688 mS3BootScriptTablePtr->TableMemoryPageNumber = (UINT16)(2 + PcdGet16(PcdS3BootScriptRuntimeTableReservePageNumber));\r
689 }\r
690\r
691 // Here we do not count the reserved memory for runtime script table.\r
692 PageNumber = (UINT16) (mS3BootScriptTablePtr->TableMemoryPageNumber - PcdGet16(PcdS3BootScriptRuntimeTableReservePageNumber));\r
693 TableLength = mS3BootScriptTablePtr->TableLength;\r
694 if (EFI_PAGES_TO_SIZE ((UINTN) PageNumber) < (TableLength + EntryLength + sizeof (EFI_BOOT_SCRIPT_TERMINATE))) {\r
695 //\r
696 // The buffer is too small to hold the table, Reallocate the buffer\r
697 //\r
698 NewS3TableBase = 0xffffffff;\r
699 Status = gBS->AllocatePages (\r
700 AllocateMaxAddress,\r
701 EfiReservedMemoryType,\r
702 2 + PageNumber + PcdGet16(PcdS3BootScriptRuntimeTableReservePageNumber),\r
703 (EFI_PHYSICAL_ADDRESS*)&NewS3TableBase\r
704 );\r
705\r
706 if (EFI_ERROR(Status)) {\r
707 ASSERT_EFI_ERROR (Status);\r
708 return 0;\r
709 }\r
710\r
711 CopyMem ((VOID*)(UINTN)NewS3TableBase, (VOID*)(UINTN)S3TableBase, TableLength);\r
712 gBS->FreePages (S3TableBase, mS3BootScriptTablePtr->TableMemoryPageNumber);\r
713\r
714 mS3BootScriptTablePtr->TableBase = (UINT8*)(UINTN)NewS3TableBase;\r
715 mS3BootScriptTablePtr->TableMemoryPageNumber = (UINT16) (2 + PageNumber + PcdGet16(PcdS3BootScriptRuntimeTableReservePageNumber));\r
716 }\r
717 //\r
718 // calculate the the start address for the new entry.\r
719 //\r
720 NewEntryPtr = mS3BootScriptTablePtr->TableBase + TableLength;\r
721\r
722 //\r
723 // update the table lenghth\r
724 //\r
725 mS3BootScriptTablePtr->TableLength = TableLength + EntryLength;\r
726\r
727 //\r
728 // In the boot time, we will not append the termination entry to the boot script\r
729 // table until the callers think there is no boot time data that should be added and\r
730 // it is caller's responsibility to explicit call the CloseTable.\r
731 //\r
732 //\r
733\r
734 return NewEntryPtr;\r
735}\r
736/**\r
737 To get the start address from which a new runtime(after SmmReadyToLock) s3 boot script entry will write into.\r
738 In this case, it should be ensured that there is enough buffer to hold the entry.\r
739\r
740 @param EntryLength the new entry length.\r
741\r
742 @retval the address from which the a new s3 runtime(after SmmReadyToLock) script entry will write into\r
743 **/\r
744UINT8*\r
745S3BootScriptGetRuntimeEntryAddAddress (\r
746 UINT8 EntryLength\r
747 )\r
748{\r
749 UINT8 *NewEntryPtr;\r
750\r
751 NewEntryPtr = NULL;\r
752 //\r
753 // Check if the memory range reserved for S3 Boot Script table is large enough to hold the node.\r
754 //\r
755 if ((mS3BootScriptTablePtr->TableLength + EntryLength + sizeof (EFI_BOOT_SCRIPT_TERMINATE)) <= EFI_PAGES_TO_SIZE ((UINTN) (mS3BootScriptTablePtr->TableMemoryPageNumber))) {\r
756 NewEntryPtr = mS3BootScriptTablePtr->TableBase + mS3BootScriptTablePtr->TableLength;\r
757 mS3BootScriptTablePtr->TableLength = mS3BootScriptTablePtr->TableLength + EntryLength;\r
758 //\r
759 // Append a terminate node on every insert\r
760 //\r
761 S3BootScriptInternalCloseTable ();\r
762 }\r
763 return (UINT8*)NewEntryPtr;\r
764}\r
765\r
766/**\r
767 This function is to restore boot time boot script data from LockBox.\r
768\r
769**/\r
770VOID\r
771RestoreBootTimeDataFromLockBox (\r
772 VOID\r
773 )\r
774{\r
775 EFI_STATUS Status;\r
776 UINTN LockBoxLength;\r
777\r
778 //\r
779 // Restore boot time boot script data from LockBox.\r
780 //\r
781 LockBoxLength = mS3BootScriptTablePtr->BootTimeScriptLength;\r
782 Status = RestoreLockBox (\r
783 &mBootScriptDataBootTimeGuid,\r
784 (VOID *) mS3BootScriptTablePtr->TableBase,\r
785 &LockBoxLength\r
786 );\r
787 ASSERT_EFI_ERROR (Status);\r
788\r
789 //\r
790 // Update the data to BootScriptData LockBox.\r
791 //\r
792 Status = UpdateLockBox (\r
793 &mBootScriptDataGuid,\r
794 0,\r
795 (VOID *) mS3BootScriptTablePtr->TableBase,\r
796 LockBoxLength\r
797 );\r
798 ASSERT_EFI_ERROR (Status);\r
799\r
800 //\r
801 // Update TableLength.\r
802 //\r
803 mS3BootScriptTablePtr->TableLength = (UINT32) (mS3BootScriptTablePtr->BootTimeScriptLength - sizeof (EFI_BOOT_SCRIPT_TERMINATE));\r
804}\r
805\r
806/**\r
807 To get the start address from which a new s3 boot script entry will write into.\r
808\r
809 @param EntryLength the new entry length.\r
810\r
811 @retval the address from which the a new s3 boot script entry will write into\r
812 **/\r
813UINT8*\r
814S3BootScriptGetEntryAddAddress (\r
815 UINT8 EntryLength\r
816 )\r
817{\r
818 UINT8* NewEntryPtr;\r
819\r
820 if (mS3BootScriptTablePtr->SmmLocked) {\r
821 //\r
822 // We need check InSmm, because after SmmReadyToLock, only SMM driver is allowed to write boot script.\r
823 //\r
824 if (!mS3BootScriptTablePtr->InSmm) {\r
825 //\r
826 // Add DEBUG ERROR, so that we can find it after SmmReadyToLock.\r
827 // Do not use ASSERT, because we may have test to invoke this interface.\r
828 //\r
829 DEBUG ((EFI_D_ERROR, "FATAL ERROR: Set boot script outside SMM after SmmReadyToLock!!!\n"));\r
830 return NULL;\r
831 }\r
832\r
833 if (mS3BootScriptTablePtr->BackFromS3) {\r
834 //\r
835 // Back from S3, restore boot time boot script data from LockBox\r
836 // and set BackFromS3 flag back to FALSE.\r
837 //\r
838 RestoreBootTimeDataFromLockBox ();\r
839 mS3BootScriptTablePtr->BackFromS3 = FALSE;\r
840 }\r
841\r
842 NewEntryPtr = S3BootScriptGetRuntimeEntryAddAddress (EntryLength);\r
843 } else {\r
844 NewEntryPtr = S3BootScriptGetBootTimeEntryAddAddress (EntryLength);\r
845 }\r
846 return NewEntryPtr;\r
847\r
848}\r
849\r
850/**\r
851 Sync BootScript LockBox data.\r
852\r
853 @param Script The address from where the boot script has been added or updated.\r
854\r
855**/\r
856VOID\r
857SyncBootScript (\r
858 IN UINT8 *Script\r
859 )\r
860{\r
861 EFI_STATUS Status;\r
862 UINT32 ScriptOffset;\r
863 UINT32 TotalScriptLength;\r
864\r
865 if (!mS3BootScriptTablePtr->SmmLocked || !mS3BootScriptTablePtr->InSmm) {\r
866 //\r
867 // If it is not after SmmReadyToLock in SMM,\r
868 // just return.\r
869 //\r
870 return ;\r
871 }\r
872\r
873 ScriptOffset = (UINT32) (Script - mS3BootScriptTablePtr->TableBase);\r
874\r
875 TotalScriptLength = (UINT32) (mS3BootScriptTablePtr->TableLength + sizeof (EFI_BOOT_SCRIPT_TERMINATE));\r
876\r
877 //\r
878 // Update BootScriptData\r
879 // So in S3 resume, the data can be restored correctly.\r
880 //\r
881 Status = UpdateLockBox (\r
882 &mBootScriptDataGuid,\r
883 ScriptOffset,\r
884 (VOID *)((UINTN)mS3BootScriptTablePtr->TableBase + ScriptOffset),\r
885 TotalScriptLength - ScriptOffset\r
886 );\r
887 ASSERT_EFI_ERROR (Status);\r
888\r
889 //\r
890 // Now the length field is updated, need sync to lockbox.\r
891 // So at S3 resume, the data can be restored correctly.\r
892 //\r
893 Status = UpdateLockBox (\r
894 &mBootScriptDataGuid,\r
895 OFFSET_OF (EFI_BOOT_SCRIPT_TABLE_HEADER, TableLength),\r
896 &TotalScriptLength,\r
897 sizeof (TotalScriptLength)\r
898 );\r
899 ASSERT_EFI_ERROR (Status);\r
900}\r
901\r
902/**\r
903 This is an function to close the S3 boot script table. The function could only be called in\r
904 BOOT time phase. To comply with the Framework spec definition on\r
905 EFI_BOOT_SCRIPT_SAVE_PROTOCOL.CloseTable(), this function will fulfill following things:\r
906 1. Closes the specified boot script table\r
907 2. It allocates a new memory pool to duplicate all the boot scripts in the specified table.\r
908 Once this function is called, the table maintained by the library will be destroyed\r
909 after it is copied into the allocated pool.\r
910 3. Any attempts to add a script record after calling this function will cause a new table\r
911 to be created by the library.\r
912 4. The base address of the allocated pool will be returned in Address. Note that after\r
913 using the boot script table, the CALLER is responsible for freeing the pool that is allocated\r
914 by this function.\r
915\r
916 In Spec PI1.1, this EFI_BOOT_SCRIPT_SAVE_PROTOCOL.CloseTable() is retired. To provides this API for now is\r
917 for Framework Spec compatibility.\r
918\r
919 If anyone does call CloseTable() on a real platform, then the caller is responsible for figuring out\r
920 how to get the script to run at S3 resume because the boot script maintained by the lib will be\r
921 destroyed.\r
922\r
923 @return the base address of the new copy of the boot script table.\r
924 @note this function could only called in boot time phase\r
925\r
926**/\r
927UINT8*\r
928EFIAPI\r
929S3BootScriptCloseTable (\r
930 VOID\r
931 )\r
932{\r
933 UINT8 *S3TableBase;\r
934 UINT32 TableLength;\r
935 UINT8 *Buffer;\r
936 EFI_STATUS Status;\r
937 EFI_BOOT_SCRIPT_TABLE_HEADER *ScriptTableInfo;\r
938\r
939 S3TableBase = mS3BootScriptTablePtr->TableBase;\r
940 if (S3TableBase == 0) {\r
941 return 0;\r
942 }\r
943 //\r
944 // Append the termination record the S3 boot script table\r
945 //\r
946 S3BootScriptInternalCloseTable();\r
947 TableLength = mS3BootScriptTablePtr->TableLength + sizeof (EFI_BOOT_SCRIPT_TERMINATE);\r
948 //\r
949 // Allocate the buffer and copy the boot script to the buffer.\r
950 //\r
951 Status = gBS->AllocatePool (\r
952 EfiBootServicesData,\r
953 (UINTN)TableLength,\r
954 (VOID **) &Buffer\r
955 );\r
956 if (EFI_ERROR (Status)) {\r
957 return 0;\r
958 }\r
959 CopyMem (Buffer, S3TableBase, TableLength);\r
960\r
961 //\r
962 // Destroy the table maintained by the library so that the next write operation\r
963 // will write the record to the first entry of the table.\r
964 //\r
965 // Fill the table header.\r
966 ScriptTableInfo = (EFI_BOOT_SCRIPT_TABLE_HEADER*)S3TableBase;\r
967 ScriptTableInfo->OpCode = S3_BOOT_SCRIPT_LIB_TABLE_OPCODE;\r
968 ScriptTableInfo->Length = (UINT8) sizeof (EFI_BOOT_SCRIPT_TABLE_HEADER);\r
969 ScriptTableInfo->TableLength = 0; // will be calculate at close the table\r
970\r
971 mS3BootScriptTablePtr->TableLength = sizeof (EFI_BOOT_SCRIPT_TABLE_HEADER);\r
972 return Buffer;\r
973}\r
974/**\r
975 Save I/O write to boot script\r
976\r
977 @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r
978 @param Address The base address of the I/O operations.\r
979 @param Count The number of I/O operations to perform.\r
980 @param Buffer The source buffer from which to write data.\r
981\r
982 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
983 @retval RETURN_SUCCESS Opcode is added.\r
984**/\r
985RETURN_STATUS\r
986EFIAPI\r
987S3BootScriptSaveIoWrite (\r
988 IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r
989 IN UINT64 Address,\r
990 IN UINTN Count,\r
991 IN VOID *Buffer\r
992 )\r
993\r
994{\r
995 UINT8 Length;\r
996 UINT8 *Script;\r
997 UINT8 WidthInByte;\r
998 EFI_BOOT_SCRIPT_IO_WRITE ScriptIoWrite;\r
999\r
1000 WidthInByte = (UINT8) (0x01 << (Width & 0x03));\r
1001 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_IO_WRITE) + (WidthInByte * Count));\r
1002\r
1003 Script = S3BootScriptGetEntryAddAddress (Length);\r
1004 if (Script == NULL) {\r
1005 return RETURN_OUT_OF_RESOURCES;\r
1006 }\r
1007 //\r
1008 // save script data\r
1009 //\r
1010 ScriptIoWrite.OpCode = EFI_BOOT_SCRIPT_IO_WRITE_OPCODE;\r
1011 ScriptIoWrite.Length = Length;\r
1012 ScriptIoWrite.Width = Width;\r
1013 ScriptIoWrite.Address = Address;\r
1014 ScriptIoWrite.Count = (UINT32) Count;\r
1015 CopyMem ((VOID*)Script, (VOID*)&ScriptIoWrite, sizeof(EFI_BOOT_SCRIPT_IO_WRITE));\r
1016 CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_IO_WRITE)), Buffer, WidthInByte * Count);\r
1017\r
1018 SyncBootScript (Script);\r
1019\r
1020 return RETURN_SUCCESS;\r
1021}\r
1022\r
1023/**\r
1024 Adds a record for an I/O modify operation into a S3 boot script table\r
1025\r
1026 @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r
1027 @param Address The base address of the I/O operations.\r
1028 @param Data A pointer to the data to be OR-ed.\r
1029 @param DataMask A pointer to the data mask to be AND-ed with the data read from the register\r
1030\r
1031 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1032 @retval RETURN_SUCCESS Opcode is added.\r
1033**/\r
1034RETURN_STATUS\r
1035EFIAPI\r
1036S3BootScriptSaveIoReadWrite (\r
1037 IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r
1038 IN UINT64 Address,\r
1039 IN VOID *Data,\r
1040 IN VOID *DataMask\r
1041 )\r
1042{\r
1043 UINT8 Length;\r
1044 UINT8 *Script;\r
1045 UINT8 WidthInByte;\r
1046 EFI_BOOT_SCRIPT_IO_READ_WRITE ScriptIoReadWrite;\r
1047\r
1048 WidthInByte = (UINT8) (0x01 << (Width & 0x03));\r
1049 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_IO_READ_WRITE) + (WidthInByte * 2));\r
1050\r
1051 Script = S3BootScriptGetEntryAddAddress (Length);\r
1052 if (Script == NULL) {\r
1053 return RETURN_OUT_OF_RESOURCES;\r
1054 }\r
1055 //\r
1056 // Build script data\r
1057 //\r
1058 ScriptIoReadWrite.OpCode = EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE;\r
1059 ScriptIoReadWrite.Length = Length;\r
1060 ScriptIoReadWrite.Width = Width;\r
1061 ScriptIoReadWrite.Address = Address;\r
1062\r
1063 CopyMem ((VOID*)Script, (VOID*)&ScriptIoReadWrite, sizeof(EFI_BOOT_SCRIPT_IO_READ_WRITE));\r
1064 CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_IO_READ_WRITE)), Data, WidthInByte);\r
1065 CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_IO_READ_WRITE) + WidthInByte), DataMask, WidthInByte);\r
1066\r
1067 SyncBootScript (Script);\r
1068\r
1069 return RETURN_SUCCESS;\r
1070}\r
1071/**\r
1072 Adds a record for a memory write operation into a specified boot script table.\r
1073\r
1074 @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r
1075 @param Address The base address of the memory operations\r
1076 @param Count The number of memory operations to perform.\r
1077 @param Buffer The source buffer from which to write the data.\r
1078\r
1079 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1080 @retval RETURN_SUCCESS Opcode is added.\r
1081**/\r
1082RETURN_STATUS\r
1083EFIAPI\r
1084S3BootScriptSaveMemWrite (\r
1085 IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r
1086 IN UINT64 Address,\r
1087 IN UINTN Count,\r
1088 IN VOID *Buffer\r
1089 )\r
1090{\r
1091 UINT8 Length;\r
1092 UINT8 *Script;\r
1093 UINT8 WidthInByte;\r
1094 EFI_BOOT_SCRIPT_MEM_WRITE ScriptMemWrite;\r
1095\r
1096 WidthInByte = (UINT8) (0x01 << (Width & 0x03));\r
1097 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_MEM_WRITE) + (WidthInByte * Count));\r
1098\r
1099 Script = S3BootScriptGetEntryAddAddress (Length);\r
1100 if (Script == NULL) {\r
1101 return RETURN_OUT_OF_RESOURCES;\r
1102 }\r
1103 //\r
1104 // Build script data\r
1105 //\r
1106 ScriptMemWrite.OpCode = EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE;\r
1107 ScriptMemWrite.Length = Length;\r
1108 ScriptMemWrite.Width = Width;\r
1109 ScriptMemWrite.Address = Address;\r
1110 ScriptMemWrite.Count = (UINT32) Count;\r
1111\r
1112 CopyMem ((VOID*)Script, (VOID*)&ScriptMemWrite, sizeof(EFI_BOOT_SCRIPT_MEM_WRITE));\r
1113 CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_MEM_WRITE)), Buffer, WidthInByte * Count);\r
1114\r
1115 SyncBootScript (Script);\r
1116\r
1117 return RETURN_SUCCESS;\r
1118}\r
1119/**\r
1120 Adds a record for a memory modify operation into a specified boot script table.\r
1121\r
1122 @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r
1123 @param Address The base address of the memory operations. Address needs alignment if required\r
1124 @param Data A pointer to the data to be OR-ed.\r
1125 @param DataMask A pointer to the data mask to be AND-ed with the data read from the register.\r
1126\r
1127 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1128 @retval RETURN_SUCCESS Opcode is added.\r
1129**/\r
1130RETURN_STATUS\r
1131EFIAPI\r
1132S3BootScriptSaveMemReadWrite (\r
1133 IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r
1134 IN UINT64 Address,\r
1135 IN VOID *Data,\r
1136 IN VOID *DataMask\r
1137 )\r
1138{\r
1139 UINT8 Length;\r
1140 UINT8 *Script;\r
1141 UINT8 WidthInByte;\r
1142 EFI_BOOT_SCRIPT_MEM_READ_WRITE ScriptMemReadWrite;\r
1143\r
1144 WidthInByte = (UINT8) (0x01 << (Width & 0x03));\r
1145 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_MEM_READ_WRITE) + (WidthInByte * 2));\r
1146\r
1147 Script = S3BootScriptGetEntryAddAddress (Length);\r
1148 if (Script == NULL) {\r
1149 return RETURN_OUT_OF_RESOURCES;\r
1150 }\r
1151 //\r
1152 // Build script data\r
1153 //\r
1154 ScriptMemReadWrite.OpCode = EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE;\r
1155 ScriptMemReadWrite.Length = Length;\r
1156 ScriptMemReadWrite.Width = Width;\r
1157 ScriptMemReadWrite.Address = Address;\r
1158\r
1159 CopyMem ((VOID*)Script, (VOID*)&ScriptMemReadWrite , sizeof (EFI_BOOT_SCRIPT_MEM_READ_WRITE));\r
1160 CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_MEM_READ_WRITE)), Data, WidthInByte);\r
1161 CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_MEM_READ_WRITE) + WidthInByte), DataMask, WidthInByte);\r
1162\r
1163 SyncBootScript (Script);\r
1164\r
1165 return RETURN_SUCCESS;\r
1166}\r
1167/**\r
1168 Adds a record for a PCI configuration space write operation into a specified boot script table.\r
1169\r
1170 @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r
1171 @param Address The address within the PCI configuration space.\r
1172 @param Count The number of PCI operations to perform.\r
1173 @param Buffer The source buffer from which to write the data.\r
1174\r
1175 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1176 @retval RETURN_SUCCESS Opcode is added.\r
1177 @note A known Limitations in the implementation which is 64bits operations are not supported.\r
1178\r
1179**/\r
1180RETURN_STATUS\r
1181EFIAPI\r
1182S3BootScriptSavePciCfgWrite (\r
1183 IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r
1184 IN UINT64 Address,\r
1185 IN UINTN Count,\r
1186 IN VOID *Buffer\r
1187 )\r
1188{\r
1189 UINT8 Length;\r
1190 UINT8 *Script;\r
1191 UINT8 WidthInByte;\r
1192 EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE ScriptPciWrite;\r
1193\r
1194 if (Width == S3BootScriptWidthUint64 ||\r
1195 Width == S3BootScriptWidthFifoUint64 ||\r
1196 Width == S3BootScriptWidthFillUint64) {\r
1197 return EFI_INVALID_PARAMETER;\r
1198 }\r
1199\r
1200 WidthInByte = (UINT8) (0x01 << (Width & 0x03));\r
1201 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE) + (WidthInByte * Count));\r
1202\r
1203 Script = S3BootScriptGetEntryAddAddress (Length);\r
1204 if (Script == NULL) {\r
1205 return RETURN_OUT_OF_RESOURCES;\r
1206 }\r
1207 //\r
1208 // Build script data\r
1209 //\r
1210 ScriptPciWrite.OpCode = EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE;\r
1211 ScriptPciWrite.Length = Length;\r
1212 ScriptPciWrite.Width = Width;\r
1213 ScriptPciWrite.Address = Address;\r
1214 ScriptPciWrite.Count = (UINT32) Count;\r
1215\r
1216 CopyMem ((VOID*)Script, (VOID*)&ScriptPciWrite, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE));\r
1217 CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE)), Buffer, WidthInByte * Count);\r
1218\r
1219 SyncBootScript (Script);\r
1220\r
1221 return RETURN_SUCCESS;\r
1222}\r
1223/**\r
1224 Adds a record for a PCI configuration space modify operation into a specified boot script table.\r
1225\r
1226 @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r
1227 @param Address The address within the PCI configuration space.\r
1228 @param Data A pointer to the data to be OR-ed.The size depends on Width.\r
1229 @param DataMask A pointer to the data mask to be AND-ed.\r
1230\r
1231 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1232 @retval RETURN__SUCCESS Opcode is added.\r
1233 @note A known Limitations in the implementation which is 64bits operations are not supported.\r
1234\r
1235**/\r
1236RETURN_STATUS\r
1237EFIAPI\r
1238S3BootScriptSavePciCfgReadWrite (\r
1239 IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r
1240 IN UINT64 Address,\r
1241 IN VOID *Data,\r
1242 IN VOID *DataMask\r
1243 )\r
1244{\r
1245 UINT8 Length;\r
1246 UINT8 *Script;\r
1247 UINT8 WidthInByte;\r
1248 EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE ScriptPciReadWrite;\r
1249\r
1250 if (Width == S3BootScriptWidthUint64 ||\r
1251 Width == S3BootScriptWidthFifoUint64 ||\r
1252 Width == S3BootScriptWidthFillUint64) {\r
1253 return EFI_INVALID_PARAMETER;\r
1254 }\r
1255\r
1256 WidthInByte = (UINT8) (0x01 << (Width & 0x03));\r
1257 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE) + (WidthInByte * 2));\r
1258\r
1259 Script = S3BootScriptGetEntryAddAddress (Length);\r
1260 if (Script == NULL) {\r
1261 return RETURN_OUT_OF_RESOURCES;\r
1262 }\r
1263 //\r
1264 // Build script data\r
1265 //\r
1266 ScriptPciReadWrite.OpCode = EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE;\r
1267 ScriptPciReadWrite.Length = Length;\r
1268 ScriptPciReadWrite.Width = Width;\r
1269 ScriptPciReadWrite.Address = Address;\r
1270\r
1271 CopyMem ((VOID*)Script, (VOID*)&ScriptPciReadWrite, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE));\r
1272 CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE)), Data, WidthInByte);\r
1273 CopyMem (\r
1274 (VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE) + WidthInByte),\r
1275 DataMask,\r
1276 WidthInByte\r
1277 );\r
1278\r
1279 SyncBootScript (Script);\r
1280\r
1281 return RETURN_SUCCESS;\r
1282}\r
1283/**\r
1284 Adds a record for a PCI configuration 2 space write operation into a specified boot script table.\r
1285\r
1286 @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r
1287 @param Segment The PCI segment number for Address.\r
1288 @param Address The address within the PCI configuration space.\r
1289 @param Count The number of PCI operations to perform.\r
1290 @param Buffer The source buffer from which to write the data.\r
1291\r
1292 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1293 @retval RETURN_SUCCESS Opcode is added.\r
1294 @note A known Limitations in the implementation which is 64bits operations are not supported.\r
1295\r
1296**/\r
1297RETURN_STATUS\r
1298EFIAPI\r
1299S3BootScriptSavePciCfg2Write (\r
1300 IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r
1301 IN UINT16 Segment,\r
1302 IN UINT64 Address,\r
1303 IN UINTN Count,\r
1304 IN VOID *Buffer\r
1305 )\r
1306{\r
1307 UINT8 Length;\r
1308 UINT8 *Script;\r
1309 UINT8 WidthInByte;\r
1310 EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE ScriptPciWrite2;\r
1311\r
1312 if (Width == S3BootScriptWidthUint64 ||\r
1313 Width == S3BootScriptWidthFifoUint64 ||\r
1314 Width == S3BootScriptWidthFillUint64) {\r
1315 return EFI_INVALID_PARAMETER;\r
1316 }\r
1317\r
1318 WidthInByte = (UINT8) (0x01 << (Width & 0x03));\r
1319 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE) + (WidthInByte * Count));\r
1320\r
1321 Script = S3BootScriptGetEntryAddAddress (Length);\r
1322 if (Script == NULL) {\r
1323 return RETURN_OUT_OF_RESOURCES;\r
1324 }\r
1325 //\r
1326 // Build script data\r
1327 //\r
1328 ScriptPciWrite2.OpCode = EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE;\r
1329 ScriptPciWrite2.Length = Length;\r
1330 ScriptPciWrite2.Width = Width;\r
1331 ScriptPciWrite2.Address = Address;\r
1332 ScriptPciWrite2.Segment = Segment;\r
1333 ScriptPciWrite2.Count = (UINT32)Count;\r
1334\r
1335 CopyMem ((VOID*)Script, (VOID*)&ScriptPciWrite2, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE));\r
1336 CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE)), Buffer, WidthInByte * Count);\r
1337\r
1338 SyncBootScript (Script);\r
1339\r
1340 return RETURN_SUCCESS;\r
1341}\r
1342/**\r
1343 Adds a record for a PCI configuration 2 space modify operation into a specified boot script table.\r
1344\r
1345 @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r
1346 @param Segment The PCI segment number for Address.\r
1347 @param Address The address within the PCI configuration space.\r
1348 @param Data A pointer to the data to be OR-ed. The size depends on Width.\r
1349 @param DataMask A pointer to the data mask to be AND-ed.\r
1350\r
1351 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1352 @retval RETURN_SUCCESS Opcode is added.\r
1353 @note A known Limitations in the implementation which is 64bits operations are not supported.\r
1354\r
1355**/\r
1356RETURN_STATUS\r
1357EFIAPI\r
1358S3BootScriptSavePciCfg2ReadWrite (\r
1359 IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r
1360 IN UINT16 Segment,\r
1361 IN UINT64 Address,\r
1362 IN VOID *Data,\r
1363 IN VOID *DataMask\r
1364 )\r
1365{\r
1366 UINT8 Length;\r
1367 UINT8 *Script;\r
1368 UINT8 WidthInByte;\r
1369 EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE ScriptPciReadWrite2;\r
1370\r
1371 if (Width == S3BootScriptWidthUint64 ||\r
1372 Width == S3BootScriptWidthFifoUint64 ||\r
1373 Width == S3BootScriptWidthFillUint64) {\r
1374 return EFI_INVALID_PARAMETER;\r
1375 }\r
1376\r
1377 WidthInByte = (UINT8) (0x01 << (Width & 0x03));\r
1378 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE) + (WidthInByte * 2));\r
1379\r
1380 Script = S3BootScriptGetEntryAddAddress (Length);\r
1381 if (Script == NULL) {\r
1382 return RETURN_OUT_OF_RESOURCES;\r
1383 }\r
1384 //\r
1385 // Build script data\r
1386 //\r
1387 ScriptPciReadWrite2.OpCode = EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE;\r
1388 ScriptPciReadWrite2.Length = Length;\r
1389 ScriptPciReadWrite2.Width = Width;\r
1390 ScriptPciReadWrite2.Segment = Segment;\r
1391 ScriptPciReadWrite2.Address = Address;\r
1392\r
1393 CopyMem ((VOID*)Script, (VOID*)&ScriptPciReadWrite2, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE));\r
1394 CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE)), Data, WidthInByte);\r
1395 CopyMem (\r
1396 (VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE) + WidthInByte),\r
1397 DataMask,\r
1398 WidthInByte\r
1399 );\r
1400\r
1401 SyncBootScript (Script);\r
1402\r
1403 return RETURN_SUCCESS;\r
1404}\r
1405\r
1406/**\r
1407 Checks the parameter of S3BootScriptSaveSmbusExecute().\r
1408\r
1409 This function checks the input parameters of SmbusExecute(). If the input parameters are valid\r
1410 for certain SMBus bus protocol, it will return EFI_SUCCESS; otherwise, it will return certain\r
1411 error code based on the input SMBus bus protocol.\r
1412\r
1413 @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length,\r
1414 and PEC.\r
1415 @param Operation Signifies which particular SMBus hardware protocol instance that\r
1416 it will use to execute the SMBus transactions. This SMBus\r
1417 hardware protocol is defined by the SMBus Specification and is\r
1418 not related to EFI.\r
1419 @param Length Signifies the number of bytes that this operation will do. The\r
1420 maximum number of bytes can be revision specific and operation\r
1421 specific. This field will contain the actual number of bytes that\r
1422 are executed for this operation. Not all operations require this\r
1423 argument.\r
1424 @param Buffer Contains the value of data to execute to the SMBus slave device.\r
1425 Not all operations require this argument. The length of this\r
1426 buffer is identified by Length.\r
1427\r
1428 @retval EFI_SUCCESS All the parameters are valid for the corresponding SMBus bus\r
1429 protocol.\r
1430 @retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.\r
1431 @retval EFI_INVALID_PARAMETER Length/Buffer is NULL for operations except for EfiSmbusQuickRead\r
1432 and EfiSmbusQuickWrite. Length is outside the range of valid\r
1433 values.\r
1434 @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.\r
1435 @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.\r
1436\r
1437**/\r
1438EFI_STATUS\r
1439CheckParameters (\r
1440 IN UINTN SmBusAddress,\r
1441 IN EFI_SMBUS_OPERATION Operation,\r
1442 IN OUT UINTN *Length,\r
1443 IN VOID *Buffer\r
1444 )\r
1445{\r
1446 EFI_STATUS Status;\r
1447 UINTN RequiredLen;\r
1448 EFI_SMBUS_DEVICE_COMMAND Command;\r
1449 BOOLEAN PecCheck;\r
1450\r
1451 Command = SMBUS_LIB_COMMAND (SmBusAddress);\r
1452 PecCheck = SMBUS_LIB_PEC (SmBusAddress);\r
1453 //\r
1454 // Set default value to be 2:\r
1455 // for SmbusReadWord, SmbusWriteWord and SmbusProcessCall.\r
1456 //\r
1457 RequiredLen = 2;\r
1458 Status = EFI_SUCCESS;\r
1459 switch (Operation) {\r
1460 case EfiSmbusQuickRead:\r
1461 case EfiSmbusQuickWrite:\r
1462 if (PecCheck || Command != 0) {\r
1463 return EFI_UNSUPPORTED;\r
1464 }\r
1465 break;\r
1466 case EfiSmbusReceiveByte:\r
1467 case EfiSmbusSendByte:\r
1468 if (Command != 0) {\r
1469 return EFI_UNSUPPORTED;\r
1470 }\r
1471 //\r
1472 // Cascade to check length parameter.\r
1473 //\r
1474 case EfiSmbusReadByte:\r
1475 case EfiSmbusWriteByte:\r
1476 RequiredLen = 1;\r
1477 //\r
1478 // Cascade to check length parameter.\r
1479 //\r
1480 case EfiSmbusReadWord:\r
1481 case EfiSmbusWriteWord:\r
1482 case EfiSmbusProcessCall:\r
1483 if (Buffer == NULL || Length == NULL) {\r
1484 return EFI_INVALID_PARAMETER;\r
1485 } else if (*Length < RequiredLen) {\r
1486 Status = EFI_BUFFER_TOO_SMALL;\r
1487 }\r
1488 *Length = RequiredLen;\r
1489 break;\r
1490 case EfiSmbusReadBlock:\r
1491 case EfiSmbusWriteBlock:\r
1492 case EfiSmbusBWBRProcessCall:\r
1493 if ((Buffer == NULL) ||\r
1494 (Length == NULL) ||\r
1495 (*Length < MIN_SMBUS_BLOCK_LEN) ||\r
1496 (*Length > MAX_SMBUS_BLOCK_LEN)) {\r
1497 return EFI_INVALID_PARAMETER;\r
1498 }\r
1499 break;\r
1500 default:\r
1501 return EFI_INVALID_PARAMETER;\r
1502 }\r
1503 return Status;\r
1504}\r
1505\r
1506/**\r
1507 Adds a record for an SMBus command execution into a specified boot script table.\r
1508\r
1509 @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.\r
1510 @param Operation Indicates which particular SMBus protocol it will use to execute the SMBus\r
1511 transactions.\r
1512 @param Length A pointer to signify the number of bytes that this operation will do.\r
1513 @param Buffer Contains the value of data to execute to the SMBUS slave device.\r
1514\r
1515 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1516 @retval RETURN_SUCCESS Opcode is added.\r
1517**/\r
1518RETURN_STATUS\r
1519EFIAPI\r
1520S3BootScriptSaveSmbusExecute (\r
1521 IN UINTN SmBusAddress,\r
1522 IN EFI_SMBUS_OPERATION Operation,\r
1523 IN UINTN *Length,\r
1524 IN VOID *Buffer\r
1525 )\r
1526{\r
1527 EFI_STATUS Status;\r
1528 UINTN BufferLength;\r
1529 UINT8 DataSize;\r
1530 UINT8 *Script;\r
1531 EFI_BOOT_SCRIPT_SMBUS_EXECUTE ScriptSmbusExecute;\r
1532\r
1533 if (Length == NULL) {\r
1534 BufferLength = 0;\r
1535 } else {\r
1536 BufferLength = *Length;\r
1537 }\r
1538\r
1539 Status = CheckParameters (SmBusAddress, Operation, &BufferLength, Buffer);\r
1540 if (EFI_ERROR (Status)) {\r
1541 return Status;\r
1542 }\r
1543\r
1544 DataSize = (UINT8)(sizeof (EFI_BOOT_SCRIPT_SMBUS_EXECUTE) + BufferLength);\r
1545\r
1546 Script = S3BootScriptGetEntryAddAddress (DataSize);\r
1547 if (Script == NULL) {\r
1548 return RETURN_OUT_OF_RESOURCES;\r
1549 }\r
1550 //\r
1551 // Build script data\r
1552 //\r
1553 ScriptSmbusExecute.OpCode = EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE;\r
1554 ScriptSmbusExecute.Length = DataSize;\r
1555 ScriptSmbusExecute.SmBusAddress = (UINT64) SmBusAddress;\r
1556 ScriptSmbusExecute.Operation = Operation;\r
1557 ScriptSmbusExecute.DataSize = (UINT32) BufferLength;\r
1558\r
1559 CopyMem ((VOID*)Script, (VOID*)&ScriptSmbusExecute, sizeof (EFI_BOOT_SCRIPT_SMBUS_EXECUTE));\r
1560 CopyMem (\r
1561 (VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_SMBUS_EXECUTE)),\r
1562 Buffer,\r
1563 BufferLength\r
1564 );\r
1565\r
1566 SyncBootScript (Script);\r
1567\r
1568 return RETURN_SUCCESS;\r
1569}\r
1570/**\r
1571 Adds a record for an execution stall on the processor into a specified boot script table.\r
1572\r
1573 @param Duration Duration in microseconds of the stall\r
1574\r
1575 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1576 @retval RETURN_SUCCESS Opcode is added.\r
1577**/\r
1578RETURN_STATUS\r
1579EFIAPI\r
1580S3BootScriptSaveStall (\r
1581 IN UINTN Duration\r
1582 )\r
1583{\r
1584 UINT8 Length;\r
1585 UINT8 *Script;\r
1586 EFI_BOOT_SCRIPT_STALL ScriptStall;\r
1587\r
1588 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_STALL));\r
1589\r
1590 Script = S3BootScriptGetEntryAddAddress (Length);\r
1591 if (Script == NULL) {\r
1592 return RETURN_OUT_OF_RESOURCES;\r
1593 }\r
1594 //\r
1595 // Build script data\r
1596 //\r
1597 ScriptStall.OpCode = EFI_BOOT_SCRIPT_STALL_OPCODE;\r
1598 ScriptStall.Length = Length;\r
1599 ScriptStall.Duration = Duration;\r
1600\r
1601 CopyMem ((VOID*)Script, (VOID*)&ScriptStall, sizeof (EFI_BOOT_SCRIPT_STALL));\r
1602\r
1603 SyncBootScript (Script);\r
1604\r
1605 return RETURN_SUCCESS;\r
1606}\r
1607/**\r
1608 Adds a record for dispatching specified arbitrary code into a specified boot script table.\r
1609\r
1610 @param EntryPoint Entry point of the code to be dispatched.\r
1611 @param Context Argument to be passed into the EntryPoint of the code to be dispatched.\r
1612\r
1613 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1614 @retval RETURN_SUCCESS Opcode is added.\r
1615**/\r
1616RETURN_STATUS\r
1617EFIAPI\r
1618S3BootScriptSaveDispatch2 (\r
1619 IN VOID *EntryPoint,\r
1620 IN VOID *Context\r
1621 )\r
1622{\r
1623 UINT8 Length;\r
1624 UINT8 *Script;\r
1625 EFI_BOOT_SCRIPT_DISPATCH_2 ScriptDispatch2;\r
1626 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_DISPATCH_2));\r
1627\r
1628 Script = S3BootScriptGetEntryAddAddress (Length);\r
1629 if (Script == NULL) {\r
1630 return RETURN_OUT_OF_RESOURCES;\r
1631 }\r
1632 //\r
1633 // Build script data\r
1634 //\r
1635 ScriptDispatch2.OpCode = EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE;\r
1636 ScriptDispatch2.Length = Length;\r
1637 ScriptDispatch2.EntryPoint = (EFI_PHYSICAL_ADDRESS)(UINTN)EntryPoint;\r
1638 ScriptDispatch2.Context = (EFI_PHYSICAL_ADDRESS)(UINTN)Context;\r
1639\r
1640 CopyMem ((VOID*)Script, (VOID*)&ScriptDispatch2, sizeof (EFI_BOOT_SCRIPT_DISPATCH_2));\r
1641\r
1642 SyncBootScript (Script);\r
1643\r
1644 return RETURN_SUCCESS;\r
1645\r
1646}\r
1647/**\r
1648 Adds a record for memory reads of the memory location and continues when the exit criteria is\r
1649 satisfied or after a defined duration.\r
1650\r
1651 Please aware, below interface is different with PI specification, Vol 5:\r
1652 EFI_S3_SAVE_STATE_PROTOCOL.Write() for EFI_BOOT_SCRIPT_MEM_POLL_OPCODE.\r
1653 "Duration" below is microseconds, while "Delay" in PI specification means\r
1654 the number of 100ns units to poll.\r
1655\r
1656 @param Width The width of the memory operations.\r
1657 @param Address The base address of the memory operations.\r
1658 @param BitMask A pointer to the bit mask to be AND-ed with the data read from the register.\r
1659 @param BitValue A pointer to the data value after to be Masked.\r
1660 @param Duration Duration in microseconds of the stall.\r
1661 @param LoopTimes The times of the register polling.\r
1662\r
1663 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1664 @retval RETURN_SUCCESS Opcode is added.\r
1665\r
1666**/\r
1667RETURN_STATUS\r
1668EFIAPI\r
1669S3BootScriptSaveMemPoll (\r
1670 IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r
1671 IN UINT64 Address,\r
1672 IN VOID *BitMask,\r
1673 IN VOID *BitValue,\r
1674 IN UINTN Duration,\r
1675 IN UINT64 LoopTimes\r
1676 )\r
1677{\r
1678 UINT8 Length;\r
1679 UINT8 *Script;\r
1680 UINT8 WidthInByte;\r
1681 EFI_BOOT_SCRIPT_MEM_POLL ScriptMemPoll;\r
1682\r
1683 WidthInByte = (UINT8) (0x01 << (Width & 0x03));\r
1684\r
1685 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_MEM_POLL) + (WidthInByte * 2));\r
1686\r
1687 Script = S3BootScriptGetEntryAddAddress (Length);\r
1688 if (Script == NULL) {\r
1689 return RETURN_OUT_OF_RESOURCES;\r
1690 }\r
1691 //\r
1692 // Build script data\r
1693 //\r
1694 ScriptMemPoll.OpCode = EFI_BOOT_SCRIPT_MEM_POLL_OPCODE;\r
1695 ScriptMemPoll.Length = Length;\r
1696 ScriptMemPoll.Width = Width;\r
1697 ScriptMemPoll.Address = Address;\r
1698 ScriptMemPoll.Duration = Duration;\r
1699 ScriptMemPoll.LoopTimes = LoopTimes;\r
1700\r
1701 CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_MEM_POLL)), BitValue, WidthInByte);\r
1702 CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_MEM_POLL) + WidthInByte), BitMask, WidthInByte);\r
1703 CopyMem ((VOID*)Script, (VOID*)&ScriptMemPoll, sizeof (EFI_BOOT_SCRIPT_MEM_POLL));\r
1704\r
1705 SyncBootScript (Script);\r
1706\r
1707 return RETURN_SUCCESS;\r
1708}\r
1709/**\r
1710 Store arbitrary information in the boot script table. This opcode is a no-op on dispatch and is only\r
1711 used for debugging script issues.\r
1712\r
1713 @param InformationLength Length of the data in bytes\r
1714 @param Information Information to be logged in the boot scrpit\r
1715\r
1716 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1717 @retval RETURN_SUCCESS Opcode is added.\r
1718\r
1719**/\r
1720RETURN_STATUS\r
1721EFIAPI\r
1722S3BootScriptSaveInformation (\r
1723 IN UINT32 InformationLength,\r
1724 IN VOID *Information\r
1725 )\r
1726{\r
1727 UINT8 Length;\r
1728 UINT8 *Script;\r
1729 EFI_BOOT_SCRIPT_INFORMATION ScriptInformation;\r
1730\r
1731 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_INFORMATION) + InformationLength);\r
1732\r
1733 Script = S3BootScriptGetEntryAddAddress (Length);\r
1734 if (Script == NULL) {\r
1735 return RETURN_OUT_OF_RESOURCES;\r
1736 }\r
1737 //\r
1738 // Build script data\r
1739 //\r
1740 ScriptInformation.OpCode = EFI_BOOT_SCRIPT_INFORMATION_OPCODE;\r
1741 ScriptInformation.Length = Length;\r
1742\r
1743\r
1744 ScriptInformation.InformationLength = InformationLength;\r
1745\r
1746 CopyMem ((VOID*)Script, (VOID*)&ScriptInformation, sizeof (EFI_BOOT_SCRIPT_INFORMATION));\r
1747 CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_INFORMATION)), (VOID *) Information, (UINTN) InformationLength);\r
1748\r
1749 SyncBootScript (Script);\r
1750\r
1751 return RETURN_SUCCESS;\r
1752\r
1753}\r
1754/**\r
1755 Store a string in the boot script table. This opcode is a no-op on dispatch and is only\r
1756 used for debugging script issues.\r
1757\r
1758 @param String The string to save to boot script table\r
1759\r
1760 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1761 @retval RETURN_SUCCESS Opcode is added.\r
1762\r
1763**/\r
1764RETURN_STATUS\r
1765EFIAPI\r
1766S3BootScriptSaveInformationAsciiString (\r
1767 IN CONST CHAR8 *String\r
1768 )\r
1769{\r
1770 return S3BootScriptSaveInformation (\r
1771 (UINT32) AsciiStrLen (String) + 1,\r
1772 (VOID*) String\r
1773 );\r
1774}\r
1775/**\r
1776 Adds a record for dispatching specified arbitrary code into a specified boot script table.\r
1777\r
1778 @param EntryPoint Entry point of the code to be dispatched.\r
1779\r
1780 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1781 @retval RETURN_SUCCESS Opcode is added.\r
1782**/\r
1783RETURN_STATUS\r
1784EFIAPI\r
1785S3BootScriptSaveDispatch (\r
1786 IN VOID *EntryPoint\r
1787 )\r
1788{\r
1789 UINT8 Length;\r
1790 UINT8 *Script;\r
1791 EFI_BOOT_SCRIPT_DISPATCH ScriptDispatch;\r
1792\r
1793 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_DISPATCH));\r
1794\r
1795 Script = S3BootScriptGetEntryAddAddress (Length);\r
1796 if (Script == NULL) {\r
1797 return RETURN_OUT_OF_RESOURCES;\r
1798 }\r
1799 //\r
1800 // Build script data\r
1801 //\r
1802 ScriptDispatch.OpCode = EFI_BOOT_SCRIPT_DISPATCH_OPCODE;\r
1803 ScriptDispatch.Length = Length;\r
1804 ScriptDispatch.EntryPoint = (EFI_PHYSICAL_ADDRESS)(UINTN)EntryPoint;\r
1805\r
1806 CopyMem ((VOID*)Script, (VOID*)&ScriptDispatch, sizeof (EFI_BOOT_SCRIPT_DISPATCH));\r
1807\r
1808 SyncBootScript (Script);\r
1809\r
1810 return RETURN_SUCCESS;\r
1811\r
1812}\r
1813/**\r
1814 Adds a record for I/O reads the I/O location and continues when the exit criteria is satisfied or after a\r
1815 defined duration.\r
1816\r
1817 @param Width The width of the I/O operations.\r
1818 @param Address The base address of the I/O operations.\r
1819 @param Data The comparison value used for the polling exit criteria.\r
1820 @param DataMask Mask used for the polling criteria. The bits in the bytes below Width which are zero\r
1821 in Data are ignored when polling the memory address.\r
1822 @param Delay The number of 100ns units to poll. Note that timer available may be of poorer\r
1823 granularity so the delay may be longer.\r
1824\r
1825 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1826 @retval RETURN_SUCCESS Opcode is added.\r
1827\r
1828**/\r
1829RETURN_STATUS\r
1830EFIAPI\r
1831S3BootScriptSaveIoPoll (\r
1832 IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r
1833 IN UINT64 Address,\r
1834 IN VOID *Data,\r
1835 IN VOID *DataMask,\r
1836 IN UINT64 Delay\r
1837 )\r
1838{\r
1839 UINT8 WidthInByte;\r
1840 UINT8 *Script;\r
1841 UINT8 Length;\r
1842 EFI_BOOT_SCRIPT_IO_POLL ScriptIoPoll;\r
1843\r
1844\r
1845 WidthInByte = (UINT8) (0x01 << (Width & 0x03));\r
1846 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_IO_POLL) + (WidthInByte * 2));\r
1847\r
1848 Script = S3BootScriptGetEntryAddAddress (Length);\r
1849 if (Script == NULL) {\r
1850 return RETURN_OUT_OF_RESOURCES;\r
1851 }\r
1852 //\r
1853 // Build script data\r
1854 //\r
1855 ScriptIoPoll.OpCode = EFI_BOOT_SCRIPT_IO_POLL_OPCODE;\r
1856 ScriptIoPoll.Length = (UINT8) (sizeof (EFI_BOOT_SCRIPT_IO_POLL) + (WidthInByte * 2));\r
1857 ScriptIoPoll.Width = Width;\r
1858 ScriptIoPoll.Address = Address;\r
1859 ScriptIoPoll.Delay = Delay;\r
1860\r
1861 CopyMem ((VOID*)Script, (VOID*)&ScriptIoPoll, sizeof (EFI_BOOT_SCRIPT_IO_POLL));\r
1862 CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_IO_POLL)), Data, WidthInByte);\r
1863 CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_IO_POLL) + WidthInByte), DataMask, WidthInByte);\r
1864\r
1865 SyncBootScript (Script);\r
1866\r
1867 return RETURN_SUCCESS;\r
1868}\r
1869\r
1870/**\r
1871 Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied or\r
1872 after a defined duration.\r
1873\r
1874 @param Width The width of the I/O operations.\r
1875 @param Address The address within the PCI configuration space.\r
1876 @param Data The comparison value used for the polling exit criteria.\r
1877 @param DataMask Mask used for the polling criteria. The bits in the bytes below Width which are zero\r
1878 in Data are ignored when polling the memory address\r
1879 @param Delay The number of 100ns units to poll. Note that timer available may be of poorer\r
1880 granularity so the delay may be longer.\r
1881\r
1882 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1883 @retval RETURN_SUCCESS Opcode is added.\r
1884 @note A known Limitations in the implementation which is 64bits operations are not supported.\r
1885\r
1886**/\r
1887RETURN_STATUS\r
1888EFIAPI\r
1889S3BootScriptSavePciPoll (\r
1890 IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r
1891 IN UINT64 Address,\r
1892 IN VOID *Data,\r
1893 IN VOID *DataMask,\r
1894 IN UINT64 Delay\r
1895)\r
1896{\r
1897 UINT8 *Script;\r
1898 UINT8 WidthInByte;\r
1899 UINT8 Length;\r
1900 EFI_BOOT_SCRIPT_PCI_CONFIG_POLL ScriptPciPoll;\r
1901\r
1902 if (Width == S3BootScriptWidthUint64 ||\r
1903 Width == S3BootScriptWidthFifoUint64 ||\r
1904 Width == S3BootScriptWidthFillUint64) {\r
1905 return EFI_INVALID_PARAMETER;\r
1906 }\r
1907\r
1908 WidthInByte = (UINT8) (0x01 << (Width & 0x03));\r
1909 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_POLL) + (WidthInByte * 2));\r
1910\r
1911 Script = S3BootScriptGetEntryAddAddress (Length);\r
1912 if (Script == NULL) {\r
1913 return RETURN_OUT_OF_RESOURCES;\r
1914 }\r
1915 //\r
1916 // Build script data\r
1917 //\r
1918 ScriptPciPoll.OpCode = EFI_BOOT_SCRIPT_PCI_CONFIG_POLL_OPCODE;\r
1919 ScriptPciPoll.Length = (UINT8) (sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_POLL) + (WidthInByte * 2));\r
1920 ScriptPciPoll.Width = Width;\r
1921 ScriptPciPoll.Address = Address;\r
1922 ScriptPciPoll.Delay = Delay;\r
1923\r
1924 CopyMem ((VOID*)Script, (VOID*)&ScriptPciPoll, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_POLL));\r
1925 CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_POLL)), Data, WidthInByte);\r
1926 CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_POLL) + WidthInByte), DataMask, WidthInByte);\r
1927\r
1928 SyncBootScript (Script);\r
1929\r
1930 return RETURN_SUCCESS;\r
1931}\r
1932/**\r
1933 Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied or\r
1934 after a defined duration.\r
1935\r
1936 @param Width The width of the I/O operations.\r
1937 @param Segment The PCI segment number for Address.\r
1938 @param Address The address within the PCI configuration space.\r
1939 @param Data The comparison value used for the polling exit criteria.\r
1940 @param DataMask Mask used for the polling criteria. The bits in the bytes below Width which are zero\r
1941 in Data are ignored when polling the memory address\r
1942 @param Delay The number of 100ns units to poll. Note that timer available may be of poorer\r
1943 granularity so the delay may be longer.\r
1944\r
1945 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
1946 @retval RETURN_SUCCESS Opcode is added.\r
1947 @note A known Limitations in the implementation which is 64bits operations are not supported.\r
1948\r
1949**/\r
1950RETURN_STATUS\r
1951EFIAPI\r
1952S3BootScriptSavePci2Poll (\r
1953 IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r
1954 IN UINT16 Segment,\r
1955 IN UINT64 Address,\r
1956 IN VOID *Data,\r
1957 IN VOID *DataMask,\r
1958 IN UINT64 Delay\r
1959)\r
1960{\r
1961 UINT8 WidthInByte;\r
1962 UINT8 *Script;\r
1963 UINT8 Length;\r
1964 EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL ScriptPci2Poll;\r
1965\r
1966 if (Width == S3BootScriptWidthUint64 ||\r
1967 Width == S3BootScriptWidthFifoUint64 ||\r
1968 Width == S3BootScriptWidthFillUint64) {\r
1969 return EFI_INVALID_PARAMETER;\r
1970 }\r
1971\r
1972 WidthInByte = (UINT8) (0x01 << (Width & 0x03));\r
1973 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL) + (WidthInByte * 2));\r
1974\r
1975 Script = S3BootScriptGetEntryAddAddress (Length);\r
1976 if (Script == NULL) {\r
1977 return RETURN_OUT_OF_RESOURCES;\r
1978 }\r
1979 //\r
1980 // Build script data\r
1981 //\r
1982 ScriptPci2Poll.OpCode = EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE;\r
1983 ScriptPci2Poll.Length = (UINT8) (sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL) + (WidthInByte * 2));\r
1984 ScriptPci2Poll.Width = Width;\r
1985 ScriptPci2Poll.Segment = Segment;\r
1986 ScriptPci2Poll.Address = Address;\r
1987 ScriptPci2Poll.Delay = Delay;\r
1988\r
1989 CopyMem ((VOID*)Script, (VOID*)&ScriptPci2Poll, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL));\r
1990 CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL)), Data, WidthInByte);\r
1991 CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL) + WidthInByte), DataMask, WidthInByte);\r
1992\r
1993 SyncBootScript (Script);\r
1994\r
1995 return RETURN_SUCCESS;\r
1996}\r
1997/**\r
1998 Do the calculation of start address from which a new s3 boot script entry will write into.\r
1999\r
2000 @param EntryLength The new entry length.\r
2001 @param Position specifies the position in the boot script table where the opcode will be\r
2002 inserted, either before or after, depending on BeforeOrAfter.\r
2003 @param BeforeOrAfter The flag to indicate to insert the nod before or after the position.\r
2004 This parameter is effective when InsertFlag is TRUE\r
2005 @param Script return out the position from which the a new s3 boot script entry will write into\r
2006**/\r
2007VOID\r
2008S3BootScriptCalculateInsertAddress (\r
2009 IN UINT8 EntryLength,\r
2010 IN VOID *Position OPTIONAL,\r
2011 IN BOOLEAN BeforeOrAfter OPTIONAL,\r
2012 OUT UINT8 **Script\r
2013 )\r
2014{\r
2015 UINTN TableLength;\r
2016 UINT8 *S3TableBase;\r
2017 UINTN PositionOffset;\r
2018 EFI_BOOT_SCRIPT_COMMON_HEADER ScriptHeader;\r
2019 //\r
2020 // The entry inserting to table is already added to the end of the table\r
2021 //\r
2022 TableLength = mS3BootScriptTablePtr->TableLength - EntryLength;\r
2023 S3TableBase = mS3BootScriptTablePtr->TableBase ;\r
2024 //\r
2025 // calculate the Position offset\r
2026 //\r
2027 if (Position != NULL) {\r
2028 PositionOffset = (UINTN)Position - (UINTN)S3TableBase;\r
2029\r
2030 //\r
2031 // If the BeforeOrAfter is FALSE, that means to insert the node right after the node.\r
2032 //\r
2033 if (!BeforeOrAfter) {\r
2034 CopyMem ((VOID*)&ScriptHeader, Position, sizeof(EFI_BOOT_SCRIPT_COMMON_HEADER));\r
2035 PositionOffset += (ScriptHeader.Length);\r
2036 }\r
2037 //\r
2038 // Insert the node before the adjusted Position\r
2039 //\r
2040 CopyMem (S3TableBase+PositionOffset+EntryLength, S3TableBase+PositionOffset, TableLength - PositionOffset);\r
2041 //\r
2042 // calculate the the start address for the new entry.\r
2043 //\r
2044 *Script = S3TableBase + PositionOffset;\r
2045\r
2046 } else {\r
2047 if (!BeforeOrAfter) {\r
2048 //\r
2049 // Insert the node to the end of the table\r
2050 //\r
2051 *Script = S3TableBase + TableLength;\r
2052 } else {\r
2053 //\r
2054 // Insert the node to the beginning of the table\r
2055 //\r
2056 PositionOffset = (UINTN) sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER);\r
2057 CopyMem (S3TableBase+PositionOffset+EntryLength, S3TableBase+PositionOffset, TableLength - PositionOffset);\r
2058 *Script = S3TableBase + PositionOffset;\r
2059 }\r
2060 }\r
2061}\r
2062/**\r
2063 Move the last boot script entry to the position\r
2064\r
2065 @param BeforeOrAfter Specifies whether the opcode is stored before (TRUE) or after (FALSE) the position\r
2066 in the boot script table specified by Position. If Position is NULL or points to\r
2067 NULL then the new opcode is inserted at the beginning of the table (if TRUE) or end\r
2068 of the table (if FALSE).\r
2069 @param Position On entry, specifies the position in the boot script table where the opcode will be\r
2070 inserted, either before or after, depending on BeforeOrAfter. On exit, specifies\r
2071 the position of the inserted opcode in the boot script table.\r
2072\r
2073 @retval RETURN_OUT_OF_RESOURCES The table is not available.\r
2074 @retval RETURN_INVALID_PARAMETER The Position is not a valid position in the boot script table.\r
2075 @retval RETURN_SUCCESS Opcode is inserted.\r
2076**/\r
2077RETURN_STATUS\r
2078EFIAPI\r
2079S3BootScriptMoveLastOpcode (\r
2080 IN BOOLEAN BeforeOrAfter,\r
2081 IN OUT VOID **Position OPTIONAL\r
2082)\r
2083{\r
2084 UINT8* Script;\r
2085 VOID *TempPosition;\r
2086 UINTN StartAddress;\r
2087 UINT32 TableLength;\r
2088 EFI_BOOT_SCRIPT_COMMON_HEADER ScriptHeader;\r
2089 BOOLEAN ValidatePosition;\r
2090 UINT8* LastOpcode;\r
2091 UINT8 TempBootScriptEntry[BOOT_SCRIPT_NODE_MAX_LENGTH];\r
2092\r
2093 ValidatePosition = FALSE;\r
2094 TempPosition = (Position == NULL) ? NULL:(*Position);\r
2095\r
2096 //\r
2097 // Check that the script is initialized and synced without adding an entry to the script.\r
2098 //\r
2099 Script = S3BootScriptGetEntryAddAddress (0);\r
2100 if (Script == NULL) {\r
2101 return RETURN_OUT_OF_RESOURCES;\r
2102 }\r
2103 Script = mS3BootScriptTablePtr->TableBase;\r
2104\r
2105 StartAddress = (UINTN) Script;\r
2106 TableLength = mS3BootScriptTablePtr->TableLength;\r
2107 Script = Script + sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER);\r
2108 LastOpcode = Script;\r
2109 //\r
2110 // Find the last boot Script Entry which is not the terminate node\r
2111 //\r
2112 while ((UINTN) Script < (UINTN) (StartAddress + TableLength)) {\r
2113 CopyMem ((VOID*)&ScriptHeader, Script, sizeof(EFI_BOOT_SCRIPT_COMMON_HEADER));\r
2114 if (TempPosition != NULL && TempPosition == Script) {\r
2115 //\r
2116 // If the position is specified, the position must be pointed to a boot script entry start address.\r
2117 //\r
2118 ValidatePosition = TRUE;\r
2119 }\r
2120 if (ScriptHeader.OpCode != S3_BOOT_SCRIPT_LIB_TERMINATE_OPCODE) {\r
2121 LastOpcode = Script;\r
2122 }\r
2123 Script = Script + ScriptHeader.Length;\r
2124 }\r
2125 //\r
2126 // If the position is specified, but not the start of a boot script entry, it is a invalid input\r
2127 //\r
2128 if (TempPosition != NULL && !ValidatePosition) {\r
2129 return RETURN_INVALID_PARAMETER;\r
2130 }\r
2131\r
2132 CopyMem ((VOID*)&ScriptHeader, LastOpcode, sizeof(EFI_BOOT_SCRIPT_COMMON_HEADER));\r
2133\r
2134 CopyMem((VOID*)TempBootScriptEntry, LastOpcode, ScriptHeader.Length);\r
2135 //\r
2136 // Find the right position to write the node in\r
2137 //\r
2138 S3BootScriptCalculateInsertAddress (\r
2139 ScriptHeader.Length,\r
2140 TempPosition,\r
2141 BeforeOrAfter,\r
2142 &Script\r
2143 );\r
2144 //\r
2145 // Copy the node to Boot script table\r
2146 //\r
2147 CopyMem((VOID*)Script, (VOID*)TempBootScriptEntry, ScriptHeader.Length);\r
2148\r
2149 SyncBootScript (Script);\r
2150\r
2151 //\r
2152 // return out the Position\r
2153 //\r
2154 if (Position != NULL) {\r
2155 *Position = Script;\r
2156 }\r
2157 return RETURN_SUCCESS;\r
2158}\r
2159/**\r
2160 Create a Label node in the boot script table.\r
2161\r
2162 @param BeforeOrAfter Specifies whether the opcode is stored before (TRUE) or after (FALSE) the position\r
2163 in the boot script table specified by Position. If Position is NULL or points to\r
2164 NULL then the new opcode is inserted at the beginning of the table (if TRUE) or end\r
2165 of the table (if FALSE).\r
2166 @param Position On entry, specifies the position in the boot script table where the opcode will be\r
2167 inserted, either before or after, depending on BeforeOrAfter. On exit, specifies\r
2168 the position of the inserted opcode in the boot script table.\r
2169 @param InformationLength Length of the label in bytes\r
2170 @param Information Label to be logged in the boot scrpit\r
2171\r
2172 @retval RETURN_INVALID_PARAMETER The Position is not a valid position in the boot script table.\r
2173 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r
2174 @retval RETURN_SUCCESS Opcode is added.\r
2175\r
2176**/\r
2177RETURN_STATUS\r
2178EFIAPI\r
2179S3BootScriptLabelInternal (\r
2180 IN BOOLEAN BeforeOrAfter,\r
2181 IN OUT VOID **Position OPTIONAL,\r
2182 IN UINT32 InformationLength,\r
2183 IN CONST CHAR8 *Information\r
2184 )\r
2185{\r
2186 UINT8 Length;\r
2187 UINT8 *Script;\r
2188 EFI_BOOT_SCRIPT_INFORMATION ScriptInformation;\r
2189\r
2190 Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_INFORMATION) + InformationLength);\r
2191\r
2192 Script = S3BootScriptGetEntryAddAddress (Length);\r
2193 if (Script == NULL) {\r
2194 return RETURN_OUT_OF_RESOURCES;\r
2195 }\r
2196 //\r
2197 // Build script data\r
2198 //\r
2199 ScriptInformation.OpCode = S3_BOOT_SCRIPT_LIB_LABEL_OPCODE;\r
2200 ScriptInformation.Length = Length;\r
2201\r
2202\r
2203 ScriptInformation.InformationLength = InformationLength;\r
2204\r
2205 CopyMem ((VOID*)Script, (VOID*)&ScriptInformation, sizeof (EFI_BOOT_SCRIPT_INFORMATION));\r
2206 CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_INFORMATION)), (VOID *) Information, (UINTN) InformationLength);\r
2207\r
2208 SyncBootScript (Script);\r
2209\r
2210 return S3BootScriptMoveLastOpcode (BeforeOrAfter, Position);\r
2211\r
2212}\r
2213/**\r
2214 Find a label within the boot script table and, if not present, optionally create it.\r
2215\r
2216 @param BeforeOrAfter Specifies whether the opcode is stored before (TRUE)\r
2217 or after (FALSE) the position in the boot script table\r
2218 specified by Position.\r
2219 @param CreateIfNotFound Specifies whether the label will be created if the label\r
2220 does not exists (TRUE) or not (FALSE).\r
2221 @param Position On entry, specifies the position in the boot script table\r
2222 where the opcode will be inserted, either before or after,\r
2223 depending on BeforeOrAfter. On exit, specifies the position\r
2224 of the inserted opcode in the boot script table.\r
2225 @param Label Points to the label which will be inserted in the boot script table.\r
2226\r
2227 @retval EFI_SUCCESS The operation succeeded. A record was added into the\r
2228 specified script table.\r
2229 @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.\r
2230 If the opcode is unknow or not supported because of the PCD\r
2231 Feature Flags.\r
2232 @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.\r
2233\r
2234**/\r
2235RETURN_STATUS\r
2236EFIAPI\r
2237S3BootScriptLabel (\r
2238 IN BOOLEAN BeforeOrAfter,\r
2239 IN BOOLEAN CreateIfNotFound,\r
2240 IN OUT VOID **Position OPTIONAL,\r
2241 IN CONST CHAR8 *Label\r
2242 )\r
2243{\r
2244 UINT8* Script;\r
2245 UINTN StartAddress;\r
2246 UINT32 TableLength;\r
2247 EFI_BOOT_SCRIPT_COMMON_HEADER ScriptHeader;\r
2248 EFI_BOOT_SCRIPT_TABLE_HEADER TableHeader;\r
2249 UINT32 LabelLength;\r
2250 //\r
2251 // Check NULL Label\r
2252 //\r
2253 if (Label == NULL) {\r
2254 return EFI_INVALID_PARAMETER;\r
2255 }\r
2256 //\r
2257 // Check empty Label\r
2258 //\r
2259 if (Label[0] == '\0') {\r
2260 return EFI_INVALID_PARAMETER;\r
2261 }\r
2262\r
2263 //\r
2264 // Check that the script is initialized and synced without adding an entry to the script.\r
2265 // The code must search for the label first before it knows if a new entry needs\r
2266 // to be added.\r
2267 //\r
2268 Script = S3BootScriptGetEntryAddAddress (0);\r
2269 if (Script == NULL) {\r
2270 return RETURN_OUT_OF_RESOURCES;\r
2271 }\r
2272\r
2273 //\r
2274 // Check the header and search for existing label.\r
2275 //\r
2276 Script = mS3BootScriptTablePtr->TableBase;\r
2277 CopyMem ((VOID*)&TableHeader, Script, sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER));\r
2278 if (TableHeader.OpCode != S3_BOOT_SCRIPT_LIB_TABLE_OPCODE) {\r
2279 return EFI_INVALID_PARAMETER;\r
2280 }\r
2281 StartAddress = (UINTN) Script;\r
2282 TableLength = mS3BootScriptTablePtr->TableLength;\r
2283 Script = Script + TableHeader.Length;\r
2284 while ((UINTN) Script < (UINTN) (StartAddress + TableLength)) {\r
2285\r
2286 CopyMem ((VOID*)&ScriptHeader, Script, sizeof(EFI_BOOT_SCRIPT_COMMON_HEADER));\r
2287 if (ScriptHeader.OpCode == S3_BOOT_SCRIPT_LIB_LABEL_OPCODE) {\r
2288 if (AsciiStrCmp ((CHAR8 *)(UINTN)(Script+sizeof(EFI_BOOT_SCRIPT_INFORMATION)), Label) == 0) {\r
2289 (*Position) = Script;\r
2290 return EFI_SUCCESS;\r
2291 }\r
2292 }\r
2293 Script = Script + ScriptHeader.Length;\r
2294 }\r
2295 if (CreateIfNotFound) {\r
2296 LabelLength = (UINT32)AsciiStrSize(Label);\r
2297 return S3BootScriptLabelInternal (BeforeOrAfter,Position, LabelLength, Label);\r
2298 } else {\r
2299 return EFI_NOT_FOUND;\r
2300 }\r
2301}\r
2302\r
2303/**\r
2304 Compare two positions in the boot script table and return their relative position.\r
2305 @param Position1 The positions in the boot script table to compare\r
2306 @param Position2 The positions in the boot script table to compare\r
2307 @param RelativePosition On return, points to the result of the comparison\r
2308\r
2309 @retval EFI_SUCCESS The operation succeeded. A record was added into the\r
2310 specified script table.\r
2311 @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.\r
2312 If the opcode is unknow or not supported because of the PCD\r
2313 Feature Flags.\r
2314 @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.\r
2315\r
2316**/\r
2317RETURN_STATUS\r
2318EFIAPI\r
2319S3BootScriptCompare (\r
2320 IN UINT8 *Position1,\r
2321 IN UINT8 *Position2,\r
2322 OUT UINTN *RelativePosition\r
2323 )\r
2324{\r
2325 UINT8* Script;\r
2326 UINT32 TableLength;\r
2327\r
2328 if (RelativePosition == NULL) {\r
2329 return EFI_INVALID_PARAMETER;\r
2330 }\r
2331\r
2332 //\r
2333 // Check that the script is initialized and synced without adding an entry to the script.\r
2334 //\r
2335 Script = S3BootScriptGetEntryAddAddress (0);\r
2336 if (Script == NULL) {\r
2337 return RETURN_OUT_OF_RESOURCES;\r
2338 }\r
2339 Script = mS3BootScriptTablePtr->TableBase;\r
2340\r
2341 //\r
2342 // mS3BootScriptTablePtr->TableLength does not include the termination node, so add it up\r
2343 //\r
2344 TableLength = mS3BootScriptTablePtr->TableLength + sizeof (EFI_BOOT_SCRIPT_TERMINATE);\r
2345 if (Position1 < Script || Position1 > Script+TableLength) {\r
2346 return EFI_INVALID_PARAMETER;\r
2347 }\r
2348 if (Position2 < Script || Position2 > Script+TableLength) {\r
2349 return EFI_INVALID_PARAMETER;\r
2350 }\r
2351 *RelativePosition = (Position1 < Position2)?-1:((Position1 == Position2)?0:1);\r
2352\r
2353 return EFI_SUCCESS;\r
2354}\r
2355\r
EFI Development Kit II mirror for PVE