]>
Commit | Line | Data |
---|---|---|
3eb9473e | 1 | /*++\r |
2 | \r | |
3 | Copyright (c) 2007, Intel Corporation \r | |
4 | All rights reserved. This program and the accompanying materials \r | |
5 | are licensed and made available under the terms and conditions of the BSD License \r | |
6 | which accompanies this distribution. The full text of the license may be found at \r | |
7 | http://opensource.org/licenses/bsd-license.php \r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | FirmwareVolume2.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | PI 1.0 spec definition.\r | |
19 | \r | |
20 | --*/\r | |
21 | \r | |
22 | #ifndef __FIRMWARE_VOLUME2_H__\r | |
23 | #define __FIRMWARE_VOLUME2_H__\r | |
24 | #include "EfiImageFormat.h"\r | |
25 | #include "EfiFirmwareVolume.h"\r | |
26 | \r | |
27 | //\r | |
28 | // Firmware Volume Protocol GUID definition\r | |
29 | //\r | |
30 | #define EFI_FIRMWARE_VOLUME2_PROTOCOL_GUID \\r | |
31 | { 0x220e73b6, 0x6bdb, 0x4413, 0x84, 0x5, 0xb9, 0x74, 0xb1, 0x8, 0x61, 0x9a }\r | |
32 | \r | |
33 | \r | |
34 | EFI_FORWARD_DECLARATION (EFI_FIRMWARE_VOLUME2_PROTOCOL);\r | |
35 | \r | |
36 | \r | |
37 | //\r | |
38 | // ************************************************************\r | |
39 | // EFI_FV2_ATTRIBUTES bit definitions\r | |
40 | // ************************************************************\r | |
41 | //\r | |
42 | #define EFI_FV2_READ_DISABLE_CAP 0x0000000000000001\r | |
43 | #define EFI_FV2_READ_ENABLE_CAP 0x0000000000000002\r | |
44 | #define EFI_FV2_READ_STATUS 0x0000000000000004\r | |
45 | \r | |
46 | #define EFI_FV2_WRITE_DISABLE_CAP 0x0000000000000008\r | |
47 | #define EFI_FV2_WRITE_ENABLE_CAP 0x0000000000000010\r | |
48 | #define EFI_FV2_WRITE_STATUS 0x0000000000000020\r | |
49 | \r | |
50 | #define EFI_FV2_LOCK_CAP 0x0000000000000040\r | |
51 | #define EFI_FV2_LOCK_STATUS 0x0000000000000080\r | |
52 | #define EFI_FV2_WRITE_POLICY_RELIABLE 0x0000000000000100\r | |
53 | \r | |
54 | #define EFI_FV2_READ_LOCK_CAP 0x0000000000001000\r | |
55 | #define EFI_FV2_READ_LOCK_STATUS 0x0000000000002000\r | |
56 | #define EFI_FV2_WRITE_LOCK_CAP 0x0000000000004000\r | |
57 | #define EFI_FV2_WRITE_LOCK_STATUS 0x0000000000008000\r | |
58 | #define EFI_FV2_ALIGNMENT 0x00000000001F0000\r | |
59 | \r | |
60 | \r | |
61 | #define EFI_FV2_ALIGNMENT_1 0x0000000000000000\r | |
62 | #define EFI_FV2_ALIGNMENT_2 0x0000000000010000\r | |
63 | #define EFI_FV2_ALIGNMENT_4 0x0000000000020000\r | |
64 | #define EFI_FV2_ALIGNMENT_8 0x0000000000030000\r | |
65 | #define EFI_FV2_ALIGNMENT_16 0x0000000000040000\r | |
66 | #define EFI_FV2_ALIGNMENT_32 0x0000000000050000\r | |
67 | #define EFI_FV2_ALIGNMENT_64 0x0000000000060000\r | |
68 | #define EFI_FV2_ALIGNMENT_128 0x0000000000070000\r | |
69 | #define EFI_FV2_ALIGNMENT_256 0x0000000000080000\r | |
70 | #define EFI_FV2_ALIGNMENT_512 0x0000000000090000\r | |
71 | #define EFI_FV2_ALIGNMENT_1K 0x00000000000A0000\r | |
72 | #define EFI_FV2_ALIGNMENT_2K 0x00000000000B0000\r | |
73 | #define EFI_FV2_ALIGNMENT_4K 0x00000000000C0000\r | |
74 | #define EFI_FV2_ALIGNMENT_8K 0x00000000000D0000\r | |
75 | #define EFI_FV2_ALIGNMENT_16K 0x00000000000E0000\r | |
76 | #define EFI_FV2_ALIGNMENT_32K 0x00000000000F0000\r | |
77 | #define EFI_FV2_ALIGNMENT_64K 0x0000000000100000\r | |
78 | #define EFI_FV2_ALIGNMENT_128K 0x0000000000110000\r | |
79 | #define EFI_FV2_ALIGNMENT_256K 0x0000000000120000\r | |
80 | #define EFI_FV2_ALIGNMENT_512K 0x0000000000130000\r | |
81 | #define EFI_FV2_ALIGNMENT_1M 0x0000000000140000\r | |
82 | #define EFI_FV2_ALIGNMENT_2M 0x0000000000150000\r | |
83 | #define EFI_FV2_ALIGNMENT_4M 0x0000000000160000\r | |
84 | #define EFI_FV2_ALIGNMENT_8M 0x0000000000170000\r | |
85 | #define EFI_FV2_ALIGNMENT_16M 0x0000000000180000\r | |
86 | #define EFI_FV2_ALIGNMENT_32M 0x0000000000190000\r | |
87 | #define EFI_FV2_ALIGNMENT_64M 0x00000000001A0000\r | |
88 | #define EFI_FV2_ALIGNMENT_128M 0x00000000001B0000\r | |
89 | #define EFI_FV2_ALIGNMENT_256M 0x00000000001C0000\r | |
90 | #define EFI_FV2_ALIGNMENT_512M 0x00000000001D0000\r | |
91 | #define EFI_FV2_ALIGNMENT_1G 0x00000000001E0000\r | |
92 | #define EFI_FV2_ALIGNMENT_2G 0x00000000001F0000\r | |
93 | \r | |
94 | #define EFI_FV_FILE_ATTRIB_FIXED 0x00000100\r | |
95 | #define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED 0x00000200\r | |
96 | \r | |
97 | \r | |
98 | //\r | |
99 | // Protocol API definitions\r | |
100 | //\r | |
101 | \r | |
102 | typedef\r | |
103 | EFI_STATUS\r | |
104 | (EFIAPI *EFI_FV_GET_ATTRIBUTES) (\r | |
105 | IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r | |
106 | OUT EFI_FV_ATTRIBUTES *Attributes\r | |
107 | );\r | |
108 | \r | |
109 | typedef\r | |
110 | EFI_STATUS\r | |
111 | (EFIAPI *EFI_FV_SET_ATTRIBUTES) (\r | |
112 | IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r | |
113 | IN OUT EFI_FV_ATTRIBUTES *Attributes\r | |
114 | );\r | |
115 | \r | |
116 | typedef\r | |
117 | EFI_STATUS\r | |
118 | (EFIAPI *EFI_FV_READ_FILE) (\r | |
119 | IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r | |
120 | IN CONST EFI_GUID *NameGuid,\r | |
121 | IN OUT VOID **Buffer,\r | |
122 | IN OUT UINTN *BufferSize,\r | |
123 | OUT EFI_FV_FILETYPE *FoundType,\r | |
124 | OUT EFI_FV_FILE_ATTRIBUTES *FileAttributes,\r | |
125 | OUT UINT32 *AuthenticationStatus\r | |
126 | );\r | |
127 | \r | |
128 | typedef\r | |
129 | EFI_STATUS\r | |
130 | (EFIAPI *EFI_FV_READ_SECTION) (\r | |
131 | IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r | |
132 | IN CONST EFI_GUID *NameGuid,\r | |
133 | IN EFI_SECTION_TYPE SectionType,\r | |
134 | IN UINTN SectionInstance,\r | |
135 | IN OUT VOID **Buffer,\r | |
136 | IN OUT UINTN *BufferSize,\r | |
137 | OUT UINT32 *AuthenticationStatus\r | |
138 | );\r | |
139 | \r | |
140 | \r | |
141 | typedef\r | |
142 | EFI_STATUS\r | |
143 | (EFIAPI *EFI_FV_WRITE_FILE) (\r | |
144 | IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r | |
145 | IN UINT32 NumberOfFiles,\r | |
146 | IN EFI_FV_WRITE_POLICY WritePolicy,\r | |
147 | IN EFI_FV_WRITE_FILE_DATA *FileData\r | |
148 | );\r | |
149 | \r | |
150 | typedef\r | |
151 | EFI_STATUS\r | |
152 | (EFIAPI *EFI_FV_GET_NEXT_FILE) (\r | |
153 | IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r | |
154 | IN OUT VOID *Key,\r | |
155 | IN OUT EFI_FV_FILETYPE *FileType,\r | |
156 | OUT EFI_GUID *NameGuid,\r | |
157 | OUT EFI_FV_FILE_ATTRIBUTES *Attributes,\r | |
158 | OUT UINTN *Size\r | |
159 | );\r | |
160 | \r | |
161 | typedef\r | |
162 | EFI_STATUS\r | |
163 | (EFIAPI *EFI_FV_GET_INFO) (\r | |
164 | IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r | |
165 | IN CONST EFI_GUID *InformationType,\r | |
166 | IN OUT UINTN *BufferSize,\r | |
167 | OUT VOID *Buffer\r | |
168 | );\r | |
169 | \r | |
170 | typedef\r | |
171 | EFI_STATUS\r | |
172 | (EFIAPI *EFI_FV_SET_INFO) (\r | |
173 | IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r | |
174 | IN CONST EFI_GUID *InformationType,\r | |
175 | IN UINTN BufferSize,\r | |
176 | IN CONST VOID *Buffer\r | |
177 | );\r | |
178 | \r | |
179 | \r | |
5d46191d | 180 | struct _EFI_FIRMWARE_VOLUME2_PROTOCOL {\r |
3eb9473e | 181 | EFI_FV_GET_ATTRIBUTES GetVolumeAttributes;\r |
182 | EFI_FV_SET_ATTRIBUTES SetVolumeAttributes;\r | |
183 | EFI_FV_READ_FILE ReadFile;\r | |
184 | EFI_FV_READ_SECTION ReadSection;\r | |
185 | EFI_FV_WRITE_FILE WriteFile;\r | |
186 | EFI_FV_GET_NEXT_FILE GetNextFile;\r | |
187 | UINT32 KeySize;\r | |
188 | EFI_HANDLE ParentHandle;\r | |
189 | EFI_FV_GET_INFO GetInfo;\r | |
190 | EFI_FV_SET_INFO SetInfo;\r | |
5d46191d | 191 | };\r |
3eb9473e | 192 | \r |
193 | extern EFI_GUID gEfiFirmwareVolume2ProtocolGuid;\r | |
194 | \r | |
195 | #endif\r |