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