]>
Commit | Line | Data |
---|---|---|
79964ac8 | 1 | /** @file\r |
2 | Definition of the Boot Script Save protocol.\r | |
3 | \r | |
4 | Copyright (c) 2007, 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 | |
b80fbe85 | 23 | #include <PiDxe.h>\r |
b451309e | 24 | //\r |
25 | // To get the multiple phase definitions defined in Boot Script Specification\r | |
26 | //\r | |
27 | #include <Ppi/BootScriptExecuter.h>\r | |
b80fbe85 | 28 | \r |
79964ac8 | 29 | //\r |
30 | // S3 Save Protocol GUID\r | |
31 | //\r | |
32 | #define EFI_BOOT_SCRIPT_SAVE_PROTOCOL_GUID \\r | |
33 | { \\r | |
34 | 0x470e1529, 0xb79e, 0x4e32, {0xa0, 0xfe, 0x6a, 0x15, 0x6d, 0x29, 0xf9, 0xb2 } \\r | |
35 | }\r | |
36 | \r | |
37 | typedef struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL EFI_BOOT_SCRIPT_SAVE_PROTOCOL;\r | |
38 | \r | |
39 | //\r | |
40 | // Protocol Member_Function\r | |
41 | //\r | |
42 | /**\r | |
43 | Adds a record into a specified Framework boot script table.\r | |
44 | \r | |
45 | @param This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r | |
46 | @param TableName Name of the script table.Currently, the only meaningful\r | |
47 | value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.\r | |
48 | @param OpCode The operation code (opcode) number.\r | |
49 | @param ... Argument list that is specific to each opcode.\r | |
50 | \r | |
51 | @retval EFI_SUCCESS The operation succeeded. A record was added into the specified script table.\r | |
52 | @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.\r | |
53 | @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.\r | |
54 | \r | |
55 | **/\r | |
56 | typedef\r | |
57 | EFI_STATUS\r | |
58 | (EFIAPI *EFI_BOOT_SCRIPT_WRITE) (\r | |
59 | IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL *This,\r | |
60 | IN UINT16 TableName,\r | |
61 | IN UINT16 OpCode,\r | |
62 | ...\r | |
63 | );\r | |
64 | \r | |
65 | /**\r | |
66 | Closes the specified script table.\r | |
67 | \r | |
68 | @param This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r | |
69 | @param TableName Name of the script table.\r | |
70 | @param Address A pointer to the physical address where the table begins.\r | |
71 | \r | |
72 | @retval EFI_SUCCESS The table was successfully returned.\r | |
73 | @retval EFI_NOT_FOUND The specified table was not created previously.\r | |
74 | @retval EFI_OUT_OF_RESOURCES Memory is insufficient to hold the reorganized boot script table.\r | |
75 | \r | |
76 | **/\r | |
77 | typedef\r | |
78 | EFI_STATUS\r | |
79 | (EFIAPI *EFI_BOOT_SCRIPT_CLOSE_TABLE) (\r | |
80 | IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL *This,\r | |
81 | IN UINT16 TableName,\r | |
82 | OUT EFI_PHYSICAL_ADDRESS *Address\r | |
83 | );\r | |
84 | \r | |
85 | //\r | |
86 | // S3 Save Protocol data structure\r | |
87 | //\r | |
88 | /**\r | |
89 | @par Protocol Description:\r | |
90 | The EFI_BOOT_SCRIPT_SAVE_PROTOCOL publishes the Framework boot script abstractions\r | |
91 | to store or record various boot scripts into boot script tables.\r | |
92 | \r | |
93 | @param Write\r | |
94 | Writes various boot scripts to a boot script table.\r | |
95 | \r | |
96 | @param CloseTable\r | |
97 | Retrieves and closes a script table.\r | |
98 | \r | |
99 | **/\r | |
100 | struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL {\r | |
101 | EFI_BOOT_SCRIPT_WRITE Write;\r | |
102 | EFI_BOOT_SCRIPT_CLOSE_TABLE CloseTable;\r | |
103 | };\r | |
104 | \r | |
105 | extern EFI_GUID gEfiBootScriptSaveProtocolGuid;\r | |
106 | \r | |
107 | #endif\r | |
108 | \r |