]>
Commit | Line | Data |
---|---|---|
26a31ad2 | 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 | |
26a31ad2 | 16 | \r |
9095d37b | 17 | Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 18 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
fd53905e | 19 | \r |
20 | @par Revision Reference:\r | |
9095d37b LG |
21 | This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 5:\r |
22 | Standards\r | |
26a31ad2 | 23 | \r |
24 | **/\r | |
25 | \r | |
26 | #ifndef __S3_SMM_SAVE_STATE_H__\r | |
27 | #define __S3_SMM_SAVE_STATE_H__\r | |
28 | \r | |
29 | #include <Protocol/S3SaveState.h>\r | |
30 | \r | |
31 | #define EFI_S3_SMM_SAVE_STATE_PROTOCOL_GUID \\r | |
32 | {0x320afe62, 0xe593, 0x49cb, { 0xa9, 0xf1, 0xd4, 0xc2, 0xf4, 0xaf, 0x1, 0x4c }}\r | |
9095d37b | 33 | \r |
11f4ce06 | 34 | typedef EFI_S3_SAVE_STATE_PROTOCOL EFI_S3_SMM_SAVE_STATE_PROTOCOL;\r |
35 | \r | |
2f88bd3a | 36 | extern EFI_GUID gEfiS3SmmSaveStateProtocolGuid;\r |
9095d37b | 37 | \r |
26a31ad2 | 38 | #endif // __S3_SMM_SAVE_STATE_H__\r |