]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /** @file\r |
2 | SimpleFileSystem protocol as defined in the EFI 1.0 specification.\r | |
3 | \r | |
4 | The SimpleFileSystem protocol is the programatic access to the FAT (12,16,32) \r | |
5 | file system specified in EFI 1.0. It can also be used to abstract a file \r | |
6 | system other than FAT.\r | |
7 | \r | |
8 | EFI 1.0 can boot from any valid EFI image contained in a SimpleFileSystem\r | |
9 | \r | |
10 | Copyright (c) 2006, Intel Corporation \r | |
11 | All rights reserved. This program and the accompanying materials \r | |
12 | are licensed and made available under the terms and conditions of the BSD License \r | |
13 | which accompanies this distribution. The full text of the license may be found at \r | |
14 | http://opensource.org/licenses/bsd-license.php \r | |
15 | \r | |
16 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
17 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
18 | \r | |
19 | Module Name: SimpleFileSystem.h\r | |
20 | \r | |
21 | **/\r | |
22 | \r | |
23 | #ifndef __SIMPLE_FILE_SYSTEM_H__\r | |
24 | #define __SIMPLE_FILE_SYSTEM_H__\r | |
25 | \r | |
26 | #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \\r | |
27 | { \\r | |
28 | 0x964e5b22, 0x6459, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r | |
29 | }\r | |
30 | \r | |
31 | typedef struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL;\r | |
32 | typedef struct _EFI_FILE EFI_FILE;\r | |
33 | typedef struct _EFI_FILE *EFI_FILE_HANDLE;\r | |
34 | typedef struct _EFI_FILE EFI_FILE_PROTOCOL;\r | |
35 | \r | |
36 | /**\r | |
37 | Open the root directory on a volume.\r | |
38 | \r | |
39 | @param This Protocol instance pointer.\r | |
40 | @param Root Returns an Open file handle for the root directory\r | |
41 | \r | |
42 | @retval EFI_SUCCESS The device was opened.\r | |
43 | @retval EFI_UNSUPPORTED This volume does not suppor the file system.\r | |
44 | @retval EFI_NO_MEDIA The device has no media.\r | |
45 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
46 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
47 | @retval EFI_ACCESS_DENIED The service denied access to the file\r | |
48 | @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources\r | |
49 | \r | |
50 | **/\r | |
51 | typedef\r | |
52 | EFI_STATUS\r | |
53 | (EFIAPI *EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME) (\r | |
54 | IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This,\r | |
55 | OUT EFI_FILE **Root\r | |
56 | )\r | |
57 | ;\r | |
58 | \r | |
59 | #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000\r | |
60 | \r | |
61 | struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL {\r | |
62 | UINT64 Revision;\r | |
63 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME OpenVolume;\r | |
64 | };\r | |
65 | \r | |
66 | /**\r | |
67 | Open the root directory on a volume.\r | |
68 | \r | |
69 | @param This Protocol instance pointer.\r | |
70 | @param NewHandle Returns File Handle for FileName\r | |
71 | @param FileName Null terminated string. "\", ".", and ".." are supported\r | |
72 | @param OpenMode Open mode for file.\r | |
73 | @param Attributes Only used for EFI_FILE_MODE_CREATE\r | |
74 | \r | |
75 | @retval EFI_SUCCESS The device was opened.\r | |
76 | @retval EFI_NOT_FOUND The specified file could not be found on the device\r | |
77 | @retval EFI_NO_MEDIA The device has no media.\r | |
78 | @retval EFI_MEDIA_CHANGED The media has changed\r | |
79 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
80 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
81 | @retval EFI_ACCESS_DENIED The service denied access to the file\r | |
82 | @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources\r | |
83 | @retval EFI_VOLUME_FULL The volume is full.\r | |
84 | \r | |
85 | **/\r | |
86 | typedef\r | |
87 | EFI_STATUS\r | |
88 | (EFIAPI *EFI_FILE_OPEN) (\r | |
89 | IN EFI_FILE *This,\r | |
90 | OUT EFI_FILE **NewHandle,\r | |
91 | IN CHAR16 *FileName,\r | |
92 | IN UINT64 OpenMode,\r | |
93 | IN UINT64 Attributes\r | |
94 | )\r | |
95 | ;\r | |
96 | \r | |
97 | //\r | |
98 | // Open modes\r | |
99 | //\r | |
100 | #define EFI_FILE_MODE_READ 0x0000000000000001ULL\r | |
101 | #define EFI_FILE_MODE_WRITE 0x0000000000000002ULL\r | |
102 | #define EFI_FILE_MODE_CREATE 0x8000000000000000ULL\r | |
103 | \r | |
104 | //\r | |
105 | // File attributes\r | |
106 | //\r | |
107 | #define EFI_FILE_READ_ONLY 0x0000000000000001ULL\r | |
108 | #define EFI_FILE_HIDDEN 0x0000000000000002ULL\r | |
109 | #define EFI_FILE_SYSTEM 0x0000000000000004ULL\r | |
110 | #define EFI_FILE_RESERVED 0x0000000000000008ULL\r | |
111 | #define EFI_FILE_DIRECTORY 0x0000000000000010ULL\r | |
112 | #define EFI_FILE_ARCHIVE 0x0000000000000020ULL\r | |
113 | #define EFI_FILE_VALID_ATTR 0x0000000000000037ULL\r | |
114 | \r | |
115 | /**\r | |
116 | Close the file handle\r | |
117 | \r | |
118 | @param This Protocol instance pointer.\r | |
119 | \r | |
120 | @retval EFI_SUCCESS The device was opened.\r | |
121 | \r | |
122 | **/\r | |
123 | typedef\r | |
124 | EFI_STATUS\r | |
125 | (EFIAPI *EFI_FILE_CLOSE) (\r | |
126 | IN EFI_FILE *This\r | |
127 | )\r | |
128 | ;\r | |
129 | \r | |
130 | /**\r | |
131 | Close and delete the file handle\r | |
132 | \r | |
133 | @param This Protocol instance pointer.\r | |
134 | \r | |
135 | @retval EFI_SUCCESS The device was opened.\r | |
136 | @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted\r | |
137 | \r | |
138 | **/\r | |
139 | typedef\r | |
140 | EFI_STATUS\r | |
141 | (EFIAPI *EFI_FILE_DELETE) (\r | |
142 | IN EFI_FILE *This\r | |
143 | )\r | |
144 | ;\r | |
145 | \r | |
146 | /**\r | |
147 | Read data from the file.\r | |
148 | \r | |
149 | @param This Protocol instance pointer.\r | |
150 | @param BufferSize On input size of buffer, on output amount of data in buffer.\r | |
151 | @param Buffer The buffer in which data is read.\r | |
152 | \r | |
153 | @retval EFI_SUCCESS Data was read.\r | |
154 | @retval EFI_NO_MEDIA The device has no media\r | |
155 | @retval EFI_DEVICE_ERROR The device reported an error\r | |
156 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
157 | @retval EFI_BUFFER_TO_SMALL BufferSize is too small. BufferSize contains required size\r | |
158 | \r | |
159 | **/\r | |
160 | typedef\r | |
161 | EFI_STATUS\r | |
162 | (EFIAPI *EFI_FILE_READ) (\r | |
163 | IN EFI_FILE *This,\r | |
164 | IN OUT UINTN *BufferSize,\r | |
165 | OUT VOID *Buffer\r | |
166 | )\r | |
167 | ;\r | |
168 | \r | |
169 | /**\r | |
170 | Write data from to the file.\r | |
171 | \r | |
172 | @param This Protocol instance pointer.\r | |
173 | @param BufferSize On input size of buffer, on output amount of data in buffer.\r | |
174 | @param Buffer The buffer in which data to write.\r | |
175 | \r | |
176 | @retval EFI_SUCCESS Data was written.\r | |
177 | @retval EFI_UNSUPPORT Writes to Open directory are not supported\r | |
178 | @retval EFI_NO_MEDIA The device has no media\r | |
179 | @retval EFI_DEVICE_ERROR The device reported an error\r | |
180 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
181 | @retval EFI_WRITE_PROTECTED The device is write protected\r | |
182 | @retval EFI_ACCESS_DENIED The file was open for read only\r | |
183 | @retval EFI_VOLUME_FULL The volume is full\r | |
184 | \r | |
185 | **/\r | |
186 | typedef\r | |
187 | EFI_STATUS\r | |
188 | (EFIAPI *EFI_FILE_WRITE) (\r | |
189 | IN EFI_FILE *This,\r | |
190 | IN OUT UINTN *BufferSize,\r | |
191 | IN VOID *Buffer\r | |
192 | )\r | |
193 | ;\r | |
194 | \r | |
195 | /**\r | |
196 | Set a files current position\r | |
197 | \r | |
198 | @param This Protocol instance pointer.\r | |
199 | @param Position Byte possition from the start of the file\r | |
200 | \r | |
201 | @retval EFI_SUCCESS Data was written.\r | |
202 | @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r | |
203 | \r | |
204 | **/\r | |
205 | typedef\r | |
206 | EFI_STATUS\r | |
207 | (EFIAPI *EFI_FILE_SET_POSITION) (\r | |
208 | IN EFI_FILE *This,\r | |
209 | IN UINT64 Position\r | |
210 | )\r | |
211 | ;\r | |
212 | \r | |
213 | /**\r | |
214 | Get a files current position\r | |
215 | \r | |
216 | @param This Protocol instance pointer.\r | |
217 | @param Position Byte possition from the start of the file\r | |
218 | \r | |
219 | @retval EFI_SUCCESS Data was written.\r | |
220 | @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r | |
221 | \r | |
222 | **/\r | |
223 | typedef\r | |
224 | EFI_STATUS\r | |
225 | (EFIAPI *EFI_FILE_GET_POSITION) (\r | |
226 | IN EFI_FILE *This,\r | |
227 | OUT UINT64 *Position\r | |
228 | )\r | |
229 | ;\r | |
230 | \r | |
231 | /**\r | |
232 | Get information about a file\r | |
233 | \r | |
234 | @param This Protocol instance pointer.\r | |
235 | @param InformationType Type of info to return in Buffer\r | |
236 | @param BufferSize On input size of buffer, on output amount of data in buffer.\r | |
237 | @param Buffer The buffer to return data.\r | |
238 | \r | |
239 | @retval EFI_SUCCESS Data was returned.\r | |
240 | @retval EFI_UNSUPPORT InformationType is not supported\r | |
241 | @retval EFI_NO_MEDIA The device has no media\r | |
242 | @retval EFI_DEVICE_ERROR The device reported an error\r | |
243 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
244 | @retval EFI_WRITE_PROTECTED The device is write protected\r | |
245 | @retval EFI_ACCESS_DENIED The file was open for read only\r | |
246 | @retval EFI_BUFFER_TOO_SMALL Buffer was too small, required size returned in BufferSize\r | |
247 | \r | |
248 | **/\r | |
249 | typedef\r | |
250 | EFI_STATUS\r | |
251 | (EFIAPI *EFI_FILE_GET_INFO) (\r | |
252 | IN EFI_FILE *This,\r | |
253 | IN EFI_GUID *InformationType,\r | |
254 | IN OUT UINTN *BufferSize,\r | |
255 | OUT VOID *Buffer\r | |
256 | )\r | |
257 | ;\r | |
258 | \r | |
259 | /**\r | |
260 | Set information about a file\r | |
261 | \r | |
262 | @param File Protocol instance pointer.\r | |
263 | @param InformationType Type of info in Buffer\r | |
264 | @param BufferSize Size of buffer.\r | |
265 | @param Buffer The data to write.\r | |
266 | \r | |
267 | @retval EFI_SUCCESS Data was returned.\r | |
268 | @retval EFI_UNSUPPORT InformationType is not supported\r | |
269 | @retval EFI_NO_MEDIA The device has no media\r | |
270 | @retval EFI_DEVICE_ERROR The device reported an error\r | |
271 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
272 | @retval EFI_WRITE_PROTECTED The device is write protected\r | |
273 | @retval EFI_ACCESS_DENIED The file was open for read only\r | |
274 | \r | |
275 | **/\r | |
276 | typedef\r | |
277 | EFI_STATUS\r | |
278 | (EFIAPI *EFI_FILE_SET_INFO) (\r | |
279 | IN EFI_FILE *This,\r | |
280 | IN EFI_GUID *InformationType,\r | |
281 | IN UINTN BufferSize,\r | |
282 | IN VOID *Buffer\r | |
283 | )\r | |
284 | ;\r | |
285 | \r | |
286 | /**\r | |
287 | Flush data back for the file handle\r | |
288 | \r | |
289 | @param This Protocol instance pointer.\r | |
290 | \r | |
291 | @retval EFI_SUCCESS Data was written.\r | |
292 | @retval EFI_UNSUPPORT Writes to Open directory are not supported\r | |
293 | @retval EFI_NO_MEDIA The device has no media\r | |
294 | @retval EFI_DEVICE_ERROR The device reported an error\r | |
295 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
296 | @retval EFI_WRITE_PROTECTED The device is write protected\r | |
297 | @retval EFI_ACCESS_DENIED The file was open for read only\r | |
298 | @retval EFI_VOLUME_FULL The volume is full\r | |
299 | \r | |
300 | **/\r | |
301 | typedef\r | |
302 | EFI_STATUS\r | |
303 | (EFIAPI *EFI_FILE_FLUSH) (\r | |
304 | IN EFI_FILE *This\r | |
305 | )\r | |
306 | ;\r | |
307 | \r | |
308 | #define EFI_FILE_HANDLE_REVISION 0x00010000\r | |
309 | #define EFI_FILE_PROTOCOL_REVISION EFI_FILE_HANDLE_REVISION\r | |
310 | \r | |
311 | struct _EFI_FILE {\r | |
312 | UINT64 Revision;\r | |
313 | EFI_FILE_OPEN Open;\r | |
314 | EFI_FILE_CLOSE Close;\r | |
315 | EFI_FILE_DELETE Delete;\r | |
316 | EFI_FILE_READ Read;\r | |
317 | EFI_FILE_WRITE Write;\r | |
318 | EFI_FILE_GET_POSITION GetPosition;\r | |
319 | EFI_FILE_SET_POSITION SetPosition;\r | |
320 | EFI_FILE_GET_INFO GetInfo;\r | |
321 | EFI_FILE_SET_INFO SetInfo;\r | |
322 | EFI_FILE_FLUSH Flush;\r | |
323 | };\r | |
324 | \r | |
325 | \r | |
326 | extern EFI_GUID gEfiSimpleFileSystemProtocolGuid;\r | |
327 | \r | |
328 | #endif\r |