diff options
author | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-04-08 06:29:25 +0000 |
---|---|---|
committer | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-04-08 06:29:25 +0000 |
commit | 4a71b21a6375549aa514e4680449a29f9c64802f (patch) | |
tree | 97f8683ca5371f3488bccad2f3cdac6313792d8d /IntelFrameworkPkg/Include/Ppi/S3Resume.h | |
parent | f42be64210ea5ef394835a3c35f0444086537f66 (diff) | |
download | edk2-platforms-4a71b21a6375549aa514e4680449a29f9c64802f.tar.xz |
Add more comments for IntelFramework's header files.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5003 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'IntelFrameworkPkg/Include/Ppi/S3Resume.h')
-rw-r--r-- | IntelFrameworkPkg/Include/Ppi/S3Resume.h | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/IntelFrameworkPkg/Include/Ppi/S3Resume.h b/IntelFrameworkPkg/Include/Ppi/S3Resume.h index cbb38f5722..b04a62ab79 100644 --- a/IntelFrameworkPkg/Include/Ppi/S3Resume.h +++ b/IntelFrameworkPkg/Include/Ppi/S3Resume.h @@ -1,6 +1,22 @@ /** @file
- This file declares S3 Resume PPI.
-
+ This file declares S3 Resume PPI which accomplishes the firmware S3 resume boot path
+ and transfers control to OS.
+
+ This PPI is published by the S3 resume PEIM and can be used on the S3 resume boot path to
+ restore the platform to its preboot configuration and transfer control to OS. The information that is
+ required for an S3 resume can be saved during the normal boot path using
+ EFI_ACPI_S3_SAVE_PROTOCOL. This presaved information can then be restored in the S3
+ resume boot path using EFI_PEI_S3_RESUME_PPI. Architecturally, the S3 resume PEIM is the
+ last PEIM to be dispatched in the S3 resume boot path.
+ Before using this PPI, the caller has to ensure the necessary information for the S3 resume, such as
+ the following, is available for the S3 resume boot path:
+ - EFI_ACPI_S3_RESUME_SCRIPT_TABLE script table. Type
+ EFI_ACPI_S3_RESUME_SCRIPT_TABLE is defined in the Intel® Platform Innovation
+ Framework for EFI Boot Script Specification.
+ - OS waking vector.
+ - The reserved memory range to be used for the S3 resume.
+ Otherwise, the S3 resume boot path may fail.
+
Copyright (c) 2007, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
|