/** @file\r
- This file declares S3 Resume PPI.\r
-\r
+ This file declares S3 Resume PPI which accomplishes the firmware S3 resume boot path\r
+ and transfers control to OS.\r
+ \r
+ This PPI is published by the S3 resume PEIM and can be used on the S3 resume boot path to\r
+ restore the platform to its preboot configuration and transfer control to OS. The information that is\r
+ required for an S3 resume can be saved during the normal boot path using\r
+ EFI_ACPI_S3_SAVE_PROTOCOL. This presaved information can then be restored in the S3\r
+ resume boot path using EFI_PEI_S3_RESUME_PPI. Architecturally, the S3 resume PEIM is the\r
+ last PEIM to be dispatched in the S3 resume boot path.\r
+ Before using this PPI, the caller has to ensure the necessary information for the S3 resume, such as\r
+ the following, is available for the S3 resume boot path:\r
+ - EFI_ACPI_S3_RESUME_SCRIPT_TABLE script table. Type\r
+ EFI_ACPI_S3_RESUME_SCRIPT_TABLE is defined in the IntelĀ® Platform Innovation\r
+ Framework for EFI Boot Script Specification.\r
+ - OS waking vector.\r
+ - The reserved memory range to be used for the S3 resume.\r
+ Otherwise, the S3 resume boot path may fail.\r
+ \r
Copyright (c) 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r