Make variable names for protocol GUIDs consistent
[mirror_edk2.git] / MdePkg / Include / Protocol / BootScriptSave.h
CommitLineData
878ddf1f 1/** @file\r
2 Definition of the Boot Script Save protocol.\r
3\r
4 Copyright (c) 2006, Intel Corporation \r
5 All rights reserved. This program and the accompanying materials \r
6 are licensed and made available under the terms and conditions of the BSD License \r
7 which accompanies this distribution. The full text of the license may be found at \r
8 http://opensource.org/licenses/bsd-license.php \r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12\r
13 Module Name: BootScriptSave.h\r
14\r
15 @par Revision Reference:\r
16 This protocol defined in the Boot Script Specification, Version 0.91.\r
17\r
18**/\r
19\r
20#ifndef _BOOT_SCRIPT_SAVE_PROTOCOL_H\r
21#define _BOOT_SCRIPT_SAVE_PROTOCOL_H\r
22\r
23//\r
24// S3 Save Protocol GUID\r
25//\r
26#define EFI_BOOT_SCRIPT_SAVE_PROTOCOL_GUID \\r
27 { \\r
28 0x470e1529, 0xb79e, 0x4e32, {0xa0, 0xfe, 0x6a, 0x15, 0x6d, 0x29, 0xf9, 0xb2 } \\r
29 }\r
30\r
31typedef struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL EFI_BOOT_SCRIPT_SAVE_PROTOCOL;\r
32\r
33//\r
34// Protocol Member_Function\r
35//\r
36/**\r
37 Adds a record into a specified Framework boot script table.\r
38\r
39 @param This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r
40 \r
41 @param TableName Name of the script table.Currently, the only meaningful \r
42 value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.\r
43 \r
44 @param OpCode The operation code (opcode) number.\r
45 \r
46 @param ... Argument list that is specific to each opcode.\r
47\r
48 @retval EFI_SUCCESS The operation succeeded. A record was added into the specified script table.\r
49 \r
50 @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.\r
51 \r
52 @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.\r
53\r
54**/\r
55typedef\r
56EFI_STATUS\r
57(EFIAPI *EFI_BOOT_SCRIPT_WRITE) (\r
58 IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL *This,\r
59 IN UINT16 TableName,\r
60 IN UINT16 OpCode,\r
61 ...\r
62 );\r
63\r
64/**\r
65 Closes the specified script table.\r
66\r
67 @param This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r
68 \r
69 @param TableName Name of the script table.\r
70 \r
71 @param Address A pointer to the physical address where the table begins.\r
72\r
73 @retval EFI_SUCCESS The table was successfully returned.\r
74 \r
75 @retval EFI_NOT_FOUND The specified table was not created previously.\r
76 \r
77 @retval EFI_OUT_OF_RESOURCES Memory is insufficient to hold the reorganized boot script table.\r
78\r
79**/\r
80typedef\r
81EFI_STATUS\r
82(EFIAPI *EFI_BOOT_SCRIPT_CLOSE_TABLE) (\r
83 IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL *This,\r
84 IN UINT16 TableName,\r
85 OUT EFI_PHYSICAL_ADDRESS *Address\r
86 );\r
87\r
88//\r
89// S3 Save Protocol data structure\r
90//\r
91/**\r
92 @par Protocol Description:\r
93 The EFI_BOOT_SCRIPT_SAVE_PROTOCOL publishes the Framework boot script abstractions\r
94 to store or record various boot scripts into boot script tables.\r
95\r
96 @param Write\r
97 Writes various boot scripts to a boot script table.\r
98\r
99 @param CloseTable\r
100 Retrieves and closes a script table.\r
101\r
102**/\r
103struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL {\r
104 EFI_BOOT_SCRIPT_WRITE Write;\r
105 EFI_BOOT_SCRIPT_CLOSE_TABLE CloseTable;\r
106};\r
107\r
f15e4e27 108extern EFI_GUID gEfiBootScriptSaveProtocolGuid;\r
878ddf1f 109\r
110#endif\r