projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 878ddf1f | 1 | /** @file\r |
| 2 | This file declares S3 Resume PPI.\r | |
| 3 | \r | |
| 4 | Copyright (c) 2006, Intel Corporation \r | |
| 5 | All rights reserved. This program and the accompanying materials \r | |
| 6 | are licensed and made available under the terms and conditions of the BSD License \r | |
| 7 | which accompanies this distribution. The full text of the license may be found at \r | |
| 8 | http://opensource.org/licenses/bsd-license.php \r | |
| 9 | \r | |
| 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
| 11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
| 12 | \r | |
| 13 | Module Name: S3Resume.h\r | |
| 14 | \r | |
| 15 | @par Revision Reference:\r | |
| 16 | This PPI is defined in Framework of EFI S3 Resume Boot Path spec.\r | |
| 17 | Version 0.9\r | |
| 18 | \r | |
| 19 | **/\r | |
| 20 | \r | |
| 21 | #ifndef __PEI_S3_RESUME_PPI_H__\r | |
| 22 | #define __PEI_S3_RESUME_PPI_H__\r | |
| 23 | \r | |
| 24 | #define EFI_PEI_S3_RESUME_PPI_GUID \\r | |
| 25 | { \\r | |
| 26 | 0x4426CCB2, 0xE684, 0x4a8a, {0xAE, 0x40, 0x20, 0xD4, 0xB0, 0x25, 0xB7, 0x10 } \\r | |
| 27 | }\r | |
| 28 | \r | |
| 29 | typedef struct _EFI_PEI_S3_RESUME_PPI EFI_PEI_S3_RESUME_PPI;\r | |
| 30 | \r | |
| 31 | /**\r | |
| 32 | Restores the platform to its preboot configuration for an S3 resume and \r | |
| 33 | jumps to the OS waking vector.\r | |
| 34 | \r | |
| 0647c9ad | 35 | @param PeiServices Pointer to the PEI Services Table\r |
| 878ddf1f | 36 | \r |
| 0647c9ad LG |
37 | @retval EFI_ABORTED Execution of the S3 resume boot script table failed.\r |
| 38 | @retval EFI_NOT_FOUND Some necessary information that is used for\r | |
| 39 | the S3 resume boot path could not be located.\r | |
| 878ddf1f | 40 | \r |
| 41 | **/\r | |
| 42 | typedef\r | |
| 43 | EFI_STATUS\r | |
| 44 | (EFIAPI *EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG) (\r | |
| 45 | IN EFI_PEI_SERVICES **PeiServices\r | |
| 46 | );\r | |
| 47 | \r | |
| 48 | /**\r | |
| 49 | @par Ppi Description:\r | |
| 50 | EFI_PEI_S3_RESUME_PPI accomplishes the firmware S3 resume boot \r | |
| 51 | path and transfers control to OS.\r | |
| 52 | \r | |
| 53 | @param S3RestoreConfig\r | |
| 54 | Restores the platform to its preboot configuration for an S3 resume and \r | |
| 55 | jumps to the OS waking vector.\r | |
| 56 | \r | |
| 57 | **/\r | |
| 58 | struct _EFI_PEI_S3_RESUME_PPI {\r | |
| 59 | EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG S3RestoreConfig;\r | |
| 60 | };\r | |
| 61 | \r | |
| 62 | extern EFI_GUID gEfiPeiS3ResumePpiGuid;\r | |
| 63 | \r | |
| 64 | #endif\r |