_EFI_ACPI_S3_SAVE_PROTOCOL Struct Reference
Detailed Description
The EFI_ACPI_S3_SAVE_PROTOCOL is responsible for preparing all the information that the Framework needs to restore the platform's preboot state during an S3 resume boot. This information can include the following:
- The Framework boot script table, containing all necessary operations to initialize the platform.
- ACPI table information, such as RSDT, through which the OS waking vector can be located.
- The range of reserved memory that can be used on the S3 resume boot path. This protocol can be used after the Framework makes sure that the boot process is complete and that no hardware has been left unconfigured. Where to call this protocol to save information is implementation-specific. In the case of an EFI-aware OS, ExitBootServices() can be a choice to provide this hook. The currently executing EFI OS loader image calls ExitBootServices()to terminate all boot services. After ExitBootServices() successfully completes, the loader becomes responsible for the continued operation of the system. On a normal boot, ExitBootServices() checks if the platform supports S3 by looking for EFI_ACPI_S3_SAVE_PROTOCOL. If the protocol exists, ExitBootServices()will assume that the target platform supports an S3 resume and then call EFI_ACPI_S3_SAVE_PROTOCOL to save the S3 resume information. The entire Framework boot script table will then be generated, assuming the platform currently is in the preboot state.
Field Documentation
Gets the size of legacy memory below 1 MB that is required for S3 resume.
Prepare all information for an S3 resume.