Add more comments for IntelFramework's header files.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / S3Resume.h
1 /** @file
2 This file declares S3 Resume PPI which accomplishes the firmware S3 resume boot path
3 and transfers control to OS.
4
5 This PPI is published by the S3 resume PEIM and can be used on the S3 resume boot path to
6 restore the platform to its preboot configuration and transfer control to OS. The information that is
7 required for an S3 resume can be saved during the normal boot path using
8 EFI_ACPI_S3_SAVE_PROTOCOL. This presaved information can then be restored in the S3
9 resume boot path using EFI_PEI_S3_RESUME_PPI. Architecturally, the S3 resume PEIM is the
10 last PEIM to be dispatched in the S3 resume boot path.
11 Before using this PPI, the caller has to ensure the necessary information for the S3 resume, such as
12 the following, is available for the S3 resume boot path:
13 - EFI_ACPI_S3_RESUME_SCRIPT_TABLE script table. Type
14 EFI_ACPI_S3_RESUME_SCRIPT_TABLE is defined in the IntelĀ® Platform Innovation
15 Framework for EFI Boot Script Specification.
16 - OS waking vector.
17 - The reserved memory range to be used for the S3 resume.
18 Otherwise, the S3 resume boot path may fail.
19
20 Copyright (c) 2007, Intel Corporation
21 All rights reserved. This program and the accompanying materials
22 are licensed and made available under the terms and conditions of the BSD License
23 which accompanies this distribution. The full text of the license may be found at
24 http://opensource.org/licenses/bsd-license.php
25
26 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
27 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
28
29 Module Name: S3Resume.h
30
31 @par Revision Reference:
32 This PPI is defined in Framework of EFI S3 Resume Boot Path spec.
33 Version 0.9
34
35 **/
36
37 #ifndef __PEI_S3_RESUME_PPI_H__
38 #define __PEI_S3_RESUME_PPI_H__
39
40 #include <PiPei.h>
41
42 #define EFI_PEI_S3_RESUME_PPI_GUID \
43 { \
44 0x4426CCB2, 0xE684, 0x4a8a, {0xAE, 0x40, 0x20, 0xD4, 0xB0, 0x25, 0xB7, 0x10 } \
45 }
46
47 typedef struct _EFI_PEI_S3_RESUME_PPI EFI_PEI_S3_RESUME_PPI;
48
49 /**
50 Restores the platform to its preboot configuration for an S3 resume and
51 jumps to the OS waking vector.
52
53 @param PeiServices Pointer to the PEI Services Table
54
55 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
56 @retval EFI_NOT_FOUND Some necessary information that is used for
57 the S3 resume boot path could not be located.
58
59 **/
60 typedef
61 EFI_STATUS
62 (EFIAPI *EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG) (
63 IN EFI_PEI_SERVICES **PeiServices
64 );
65
66 /**
67 @par Ppi Description:
68 EFI_PEI_S3_RESUME_PPI accomplishes the firmware S3 resume boot
69 path and transfers control to OS.
70
71 @param S3RestoreConfig
72 Restores the platform to its preboot configuration for an S3 resume and
73 jumps to the OS waking vector.
74
75 **/
76 struct _EFI_PEI_S3_RESUME_PPI {
77 EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG S3RestoreConfig;
78 };
79
80 extern EFI_GUID gEfiPeiS3ResumePpiGuid;
81
82 #endif