]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | S3 SMM Save State Protocol as defined in PI1.2 Specification VOLUME 5 Standard.\r | |
3 | \r | |
4 | The EFI_S3_SMM_SAVE_STATE_PROTOCOL publishes the PI SMMboot script abstractions\r | |
5 | On an S3 resume boot path the data stored via this protocol is replayed in the order it was stored.\r | |
6 | The order of replay is the order either of the S3 Save State Protocol or S3 SMM Save State Protocol\r | |
7 | Write() functions were called during the boot process. Insert(), Label(), and\r | |
8 | Compare() operations are ordered relative other S3 SMM Save State Protocol write() operations\r | |
9 | and the order relative to S3 State Save Write() operations is not defined. Due to these ordering\r | |
10 | restrictions it is recommended that the S3 State Save Protocol be used during the DXE phase when\r | |
11 | every possible.\r | |
12 | The EFI_S3_SMM_SAVE_STATE_PROTOCOL can be called at runtime and\r | |
13 | EFI_OUT_OF_RESOURCES may be returned from a runtime call. It is the responsibility of the\r | |
14 | platform to ensure enough memory resource exists to save the system state. It is recommended that\r | |
15 | runtime calls be minimized by the caller.\r | |
16 | \r | |
17 | Copyright (c) 2009, Intel Corporation \r | |
18 | All rights reserved. This program and the accompanying materials \r | |
19 | are licensed and made available under the terms and conditions of the BSD License \r | |
20 | which accompanies this distribution. The full text of the license may be found at \r | |
21 | http://opensource.org/licenses/bsd-license.php \r | |
22 | \r | |
23 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
24 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
25 | \r | |
26 | @par Revision Reference:\r | |
27 | This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 5: \r | |
28 | Standards \r | |
29 | \r | |
30 | **/\r | |
31 | \r | |
32 | #ifndef __S3_SMM_SAVE_STATE_H__\r | |
33 | #define __S3_SMM_SAVE_STATE_H__\r | |
34 | \r | |
35 | #include <Protocol/S3SaveState.h>\r | |
36 | \r | |
37 | #define EFI_S3_SMM_SAVE_STATE_PROTOCOL_GUID \\r | |
38 | {0x320afe62, 0xe593, 0x49cb, { 0xa9, 0xf1, 0xd4, 0xc2, 0xf4, 0xaf, 0x1, 0x4c }}\r | |
39 | \r | |
40 | typedef struct _EFI_S3_SMM_SAVE_STATE_PROTOCOL {\r | |
41 | EFI_S3_SAVE_STATE_WRITE Write;\r | |
42 | EFI_S3_SAVE_STATE_INSERT Insert;\r | |
43 | EFI_S3_SAVE_STATE_LABEL Label;\r | |
44 | EFI_S3_SAVE_STATE_COMPARE Compare;\r | |
45 | } EFI_S3_SMM_SAVE_STATE_PROTOCOL; \r | |
46 | \r | |
47 | extern EFI_GUID gEfiS3SmmSaveStateProtocolGuid;\r | |
48 | \r | |
49 | #endif // __S3_SMM_SAVE_STATE_H__\r | |
50 | \r |