MdePkg/Include/Ppi/S3Resume.h

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