Add more comments for IntelFramework's header files.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / AcpiS3Save.h
CommitLineData
cf7e50f8 1/** @file\r
4a71b21a 2 This protocol is used to prepare all information that is needed for the S3 resume boot path. This\r
3 protocol is not required for all platforms.\r
4 This protocol is defined in framework S3Resume v0.9, page 21.\r
5 \r
8f23e4e6 6Copyright (c) 2006, Intel Corporation\r
7All rights reserved. This program and the accompanying materials\r
8are licensed and made available under the terms and conditions of the BSD License\r
9which accompanies this distribution. The full text of the license may be found at\r
10http://opensource.org/licenses/bsd-license.php\r
11\r
12THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14\r
cf7e50f8 15**/\r
8f23e4e6 16\r
17#ifndef _ACPI_S3_SAVE_PROTOCOL_H\r
18#define _ACPI_S3_SAVE_PROTOCOL_H\r
19\r
20#include <PiDxe.h>\r
21\r
22//\r
23// Forward reference for pure ANSI compatability\r
24//\r
25typedef struct _EFI_ACPI_S3_SAVE_PROTOCOL EFI_ACPI_S3_SAVE_PROTOCOL;\r
26\r
27//\r
28// S3 Save Protocol GUID\r
29//\r
30#define EFI_ACPI_S3_SAVE_GUID \\r
31 { \\r
32 0x125f2de1, 0xfb85, 0x440c, {0xa5, 0x4c, 0x4d, 0x99, 0x35, 0x8a, 0x8d, 0x38 } \\r
33 }\r
34\r
35//\r
36// Protocol Data Structures\r
37//\r
38typedef\r
39EFI_STATUS\r
40(EFIAPI *EFI_ACPI_S3_SAVE) (\r
41 IN EFI_ACPI_S3_SAVE_PROTOCOL * This,\r
42 IN VOID * LegacyMemoryAddress\r
43 );\r
44\r
45typedef\r
46EFI_STATUS\r
47(EFIAPI *EFI_ACPI_GET_LEGACY_MEMORY_SIZE) (\r
48 IN EFI_ACPI_S3_SAVE_PROTOCOL * This,\r
49 OUT UINTN * Size\r
50);\r
51\r
52struct _EFI_ACPI_S3_SAVE_PROTOCOL {\r
53 EFI_ACPI_GET_LEGACY_MEMORY_SIZE GetLegacyMemorySize;\r
54 EFI_ACPI_S3_SAVE S3Save;\r
55};\r
56\r
57extern EFI_GUID gEfiAcpiS3SaveProtocolGuid;\r
58\r
59#endif\r