summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2009-08-18 07:26:41 +0000
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2009-08-18 07:26:41 +0000
commit26a31ad2bdcf2aff4b9882f64d0f50b85130a192 (patch)
tree97a979364ac6026dcaa06ab39718ffb16ab09873
parent6385a22c793221a8075568f68662f7dbda13cf80 (diff)
downloadedk2-26a31ad2bdcf2aff4b9882f64d0f50b85130a192.zip
edk2-26a31ad2bdcf2aff4b9882f64d0f50b85130a192.tar.gz
edk2-26a31ad2bdcf2aff4b9882f64d0f50b85130a192.tar.bz2
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
-rw-r--r--MdePkg/Include/Protocol/S3SmmSaveState.h46
-rw-r--r--MdePkg/MdePkg.dec3
2 files changed, 49 insertions, 0 deletions
diff --git a/MdePkg/Include/Protocol/S3SmmSaveState.h b/MdePkg/Include/Protocol/S3SmmSaveState.h
new file mode 100644
index 0000000..39510f4
--- /dev/null
+++ b/MdePkg/Include/Protocol/S3SmmSaveState.h
@@ -0,0 +1,46 @@
+/** @file
+ S3 SMM Save State Protocol as defined in PI1.2 Specification VOLUME 5 Standard.
+
+ The EFI_S3_SMM_SAVE_STATE_PROTOCOL publishes the PI SMMboot script abstractions
+ On an S3 resume boot path the data stored via this protocol is replayed in the order it was stored.
+ The order of replay is the order either of the S3 Save State Protocol or S3 SMM Save State Protocol
+ Write() functions were called during the boot process. Insert(), Label(), and
+ Compare() operations are ordered relative other S3 SMM Save State Protocol write() operations
+ and the order relative to S3 State Save Write() operations is not defined. Due to these ordering
+ restrictions it is recommended that the S3 State Save Protocol be used during the DXE phase when
+ every possible.
+ The EFI_S3_SMM_SAVE_STATE_PROTOCOL can be called at runtime and
+ EFI_OUT_OF_RESOURCES may be returned from a runtime call. It is the responsibility of the
+ platform to ensure enough memory resource exists to save the system state. It is recommended that
+ runtime calls be minimized by the caller.
+
+ Copyright (c) 2009, Intel Corporation
+ All rights reserved. This program and the accompanying materials
+ are licensed and made available under the terms and conditions of the BSD License
+ which accompanies this distribution. The full text of the license may be found at
+ http://opensource.org/licenses/bsd-license.php
+
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#ifndef __S3_SMM_SAVE_STATE_H__
+#define __S3_SMM_SAVE_STATE_H__
+
+#include <Protocol/S3SaveState.h>
+
+#define EFI_S3_SMM_SAVE_STATE_PROTOCOL_GUID \
+ {0x320afe62, 0xe593, 0x49cb, { 0xa9, 0xf1, 0xd4, 0xc2, 0xf4, 0xaf, 0x1, 0x4c }}
+
+typedef struct _EFI_S3_SMM_SAVE_STATE_PROTOCOL {
+ EFI_S3_SAVE_STATE_WRITE Write;
+ EFI_S3_SAVE_STATE_INSERT Insert;
+ EFI_S3_SAVE_STATE_LABEL Label;
+ EFI_S3_SAVE_STATE_COMPARE Compare;
+} EFI_S3_SMM_SAVE_STATE_PROTOCOL;
+
+extern EFI_GUID gEfiS3SmmSaveStateProtocolGuid;
+
+#endif // __S3_SMM_SAVE_STATE_H__
+
diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index 2903c00..abfe5c8 100644
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -550,6 +550,9 @@
## Include/Protocol/S3SaveState.h
gEfiS3SaveStateProtocolGuid = {0xe857caf6, 0xc046, 0x45dc, {0xbe, 0x3f, 0xee, 0x7, 0x65, 0xfb, 0xa8, 0x87}}
+ ## Include/Protocol/S3SmmSaveState.h
+ gEfiS3SmmSaveStateProtocolGuid = {0x320afe62, 0xe593, 0x49cb, { 0xa9, 0xf1, 0xd4, 0xc2, 0xf4, 0xaf, 0x1, 0x4c}}
+
#
# Protocols defined in UEFI2.1/UEFI2.0/EFI1.1
#