Moved the MdePkg to OldMdePkg so that new code in MdePkg does not break existing...

[mirror_edk2.git] / OldMdePkg / Include / Ppi / S3Resume.h

diff --git a/OldMdePkg/Include/Ppi/S3Resume.h b/OldMdePkg/Include/Ppi/S3Resume.h
new file mode 100644 (file)
index 0000000..c5c0259
--- /dev/null
+++ b/OldMdePkg/Include/Ppi/S3Resume.h
@@ -0,0 +1,64 @@
+/** @file\r
+  This file declares S3 Resume PPI.\r
+\r
+  Copyright (c) 2006, Intel Corporation                                                         \r
+  All rights reserved. This program and the accompanying materials                          \r
+  are licensed and made available under the terms and conditions of the BSD License         \r
+  which accompanies this distribution.  The full text of the license may be found at        \r
+  http://opensource.org/licenses/bsd-license.php                                            \r
+\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+\r
+  Module Name:  S3Resume.h\r
+\r
+  @par Revision Reference:\r
+  This PPI is defined in Framework of EFI S3 Resume Boot Path spec.\r
+  Version 0.9\r
+\r
+**/\r
+\r
+#ifndef __PEI_S3_RESUME_PPI_H__\r
+#define __PEI_S3_RESUME_PPI_H__\r
+\r
+#define EFI_PEI_S3_RESUME_PPI_GUID \\r
+  { \\r
+    0x4426CCB2, 0xE684, 0x4a8a, {0xAE, 0x40, 0x20, 0xD4, 0xB0, 0x25, 0xB7, 0x10 } \\r
+  }\r
+\r
+typedef struct _EFI_PEI_S3_RESUME_PPI   EFI_PEI_S3_RESUME_PPI;\r
+\r
+/**\r
+  Restores the platform to its preboot configuration for an S3 resume and \r
+  jumps to the OS waking vector.\r
+\r
+  @param  PeiServices    Pointer to the PEI Services Table\r
+\r
+  @retval EFI_ABORTED           Execution of the S3 resume boot script table failed.\r
+  @retval EFI_NOT_FOUND         Some necessary information that is used for\r
+                                the S3 resume boot path could not be located.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG) (\r
+  IN EFI_PEI_SERVICES   **PeiServices\r
+  );\r
+\r
+/**\r
+  @par Ppi Description:\r
+  EFI_PEI_S3_RESUME_PPI accomplishes the firmware S3 resume boot \r
+  path and transfers control to OS.\r
+\r
+  @param S3RestoreConfig\r
+  Restores the platform to its preboot configuration for an S3 resume and \r
+  jumps to the OS waking vector.\r
+\r
+**/\r
+struct _EFI_PEI_S3_RESUME_PPI {\r
+  EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG  S3RestoreConfig;\r
+};\r
+\r
+extern EFI_GUID gEfiPeiS3ResumePpiGuid;\r
+\r
+#endif\r