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