Ronak Kanabar | 1ae366f | 2023-06-07 01:21:56 +0530 | [diff] [blame^] | 1 | /** @file |
| 2 | This PPI produces functions to interpret and execute the PI boot script table. |
| 3 | |
| 4 | This PPI is published by a PEIM and provides for the restoration of the platform's |
| 5 | configuration when resuming from the ACPI S3 power state. The ability to execute |
| 6 | the boot script may depend on the availability of other PPIs. For example, if |
| 7 | the boot script includes an SMBus command, this PEIM looks for the relevant PPI |
| 8 | that is able to execute that command. |
| 9 | |
| 10 | Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR> |
| 11 | SPDX-License-Identifier: BSD-2-Clause-Patent |
| 12 | |
| 13 | @par Revision Reference: |
| 14 | This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 5: |
| 15 | Standards |
| 16 | |
| 17 | **/ |
| 18 | |
| 19 | #ifndef __PEI_S3_RESUME_PPI_H__ |
| 20 | #define __PEI_S3_RESUME_PPI_H__ |
| 21 | |
| 22 | /// |
| 23 | /// Global ID for EFI_PEI_S3_RESUME2_PPI |
| 24 | /// |
| 25 | #define EFI_PEI_S3_RESUME2_PPI_GUID \ |
| 26 | { \ |
| 27 | 0x6D582DBC, 0xDB85, 0x4514, {0x8F, 0xCC, 0x5A, 0xDF, 0x62, 0x27, 0xB1, 0x47 } \ |
| 28 | } |
| 29 | |
| 30 | /// |
| 31 | /// Forward declaration for EFI_PEI_S3_RESUME_PPI |
| 32 | /// |
| 33 | typedef struct _EFI_PEI_S3_RESUME2_PPI EFI_PEI_S3_RESUME2_PPI; |
| 34 | |
| 35 | /** |
| 36 | Restores the platform to its preboot configuration for an S3 resume and |
| 37 | jumps to the OS waking vector. |
| 38 | |
| 39 | This function will restore the platform to its pre-boot configuration that was |
| 40 | pre-stored in the boot script table and transfer control to OS waking vector. |
| 41 | Upon invocation, this function is responsible for locating the following |
| 42 | information before jumping to OS waking vector: |
| 43 | - ACPI tables |
| 44 | - boot script table |
| 45 | - any other information that it needs |
| 46 | |
| 47 | The S3RestoreConfig() function then executes the pre-stored boot script table |
| 48 | and transitions the platform to the pre-boot state. The boot script is recorded |
| 49 | during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and |
| 50 | EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function |
| 51 | transfers control to the OS waking vector. If the OS supports only a real-mode |
| 52 | waking vector, this function will switch from flat mode to real mode before |
| 53 | jumping to the waking vector. If all platform pre-boot configurations are |
| 54 | successfully restored and all other necessary information is ready, this |
| 55 | function will never return and instead will directly jump to the OS waking |
| 56 | vector. If this function returns, it indicates that the attempt to resume |
| 57 | from the ACPI S3 sleep state failed. |
| 58 | |
| 59 | @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI |
| 60 | |
| 61 | @retval EFI_ABORTED Execution of the S3 resume boot script table failed. |
| 62 | @retval EFI_NOT_FOUND Some necessary information that is used for the S3 |
| 63 | resume boot path could not be located. |
| 64 | |
| 65 | **/ |
| 66 | typedef |
| 67 | EFI_STATUS |
| 68 | (EFIAPI *EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG2)( |
| 69 | IN EFI_PEI_S3_RESUME2_PPI *This |
| 70 | ); |
| 71 | |
| 72 | /** |
| 73 | EFI_PEI_S3_RESUME2_PPI accomplishes the firmware S3 resume boot |
| 74 | path and transfers control to OS. |
| 75 | **/ |
| 76 | struct _EFI_PEI_S3_RESUME2_PPI { |
| 77 | /// |
| 78 | /// Restores the platform to its preboot configuration for an S3 resume and |
| 79 | /// jumps to the OS waking vector. |
| 80 | /// |
| 81 | EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG2 S3RestoreConfig2; |
| 82 | }; |
| 83 | |
| 84 | extern EFI_GUID gEfiPeiS3Resume2PpiGuid; |
| 85 | |
| 86 | #endif |