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