Add S3 SMM Save State protocol definition from PI 1.2 specification.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9091 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Protocol/S3SmmSaveState.h b/MdePkg/Include/Protocol/S3SmmSaveState.h
new file mode 100644 (file)
index 0000000..39510f4
--- /dev/null
+++ b/MdePkg/Include/Protocol/S3SmmSaveState.h
@@ -0,0 +1,46 @@
+/** @file\r
+  S3 SMM Save State Protocol as defined in PI1.2 Specification VOLUME 5 Standard.\r
+\r
+  The EFI_S3_SMM_SAVE_STATE_PROTOCOL publishes the PI SMMboot script abstractions\r
+  On an S3 resume boot path the data stored via this protocol is replayed in the order it was stored.\r
+  The order of replay is the order either of the S3 Save State Protocol or S3 SMM Save State Protocol\r
+  Write() functions were called during the boot process. Insert(), Label(), and\r
+  Compare() operations are ordered relative other S3 SMM Save State Protocol write() operations\r
+  and the order relative to S3 State Save Write() operations is not defined. Due to these ordering\r
+  restrictions it is recommended that the S3 State Save Protocol be used during the DXE phase when\r
+  every possible.\r
+  The EFI_S3_SMM_SAVE_STATE_PROTOCOL can be called at runtime and\r
+  EFI_OUT_OF_RESOURCES may be returned from a runtime call. It is the responsibility of the\r
+  platform to ensure enough memory resource exists to save the system state. It is recommended that\r
+  runtime calls be minimized by the caller.\r
+  \r
+  Copyright (c) 2009, 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
+**/\r
+\r
+#ifndef __S3_SMM_SAVE_STATE_H__\r
+#define __S3_SMM_SAVE_STATE_H__\r
+\r
+#include <Protocol/S3SaveState.h>\r
+\r
+#define EFI_S3_SMM_SAVE_STATE_PROTOCOL_GUID \\r
+    {0x320afe62, 0xe593, 0x49cb, { 0xa9, 0xf1, 0xd4, 0xc2, 0xf4, 0xaf, 0x1, 0x4c }}\r
+    \r
+typedef struct _EFI_S3_SMM_SAVE_STATE_PROTOCOL {\r
+  EFI_S3_SAVE_STATE_WRITE   Write;\r
+  EFI_S3_SAVE_STATE_INSERT  Insert;\r
+  EFI_S3_SAVE_STATE_LABEL   Label;\r
+  EFI_S3_SAVE_STATE_COMPARE Compare;\r
+} EFI_S3_SMM_SAVE_STATE_PROTOCOL;    \r
+    \r
+extern EFI_GUID gEfiS3SmmSaveStateProtocolGuid;\r
+    \r
+#endif // __S3_SMM_SAVE_STATE_H__\r
+\r

diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index 2903c009d7e95427295d161f815b16a77d2d5ba3..abfe5c8496ccaa6435a9379c99d107c1930ffeb5 100644 (file)
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -550,6 +550,9 @@
   ## Include/Protocol/S3SaveState.h\r
   gEfiS3SaveStateProtocolGuid     = {0xe857caf6, 0xc046, 0x45dc, {0xbe, 0x3f, 0xee, 0x7, 0x65, 0xfb, 0xa8, 0x87}}\r
   \r
+  ## Include/Protocol/S3SmmSaveState.h\r
+  gEfiS3SmmSaveStateProtocolGuid  = {0x320afe62, 0xe593, 0x49cb, { 0xa9, 0xf1, 0xd4, 0xc2, 0xf4, 0xaf, 0x1, 0x4c}}\r
+  \r
   #\r
   # Protocols defined in UEFI2.1/UEFI2.0/EFI1.1\r
   #\r