2 SimpleFileSystem protocol as defined in the UEFI 2.0 specification.
4 The SimpleFileSystem protocol is the programatic access to the FAT (12,16,32)
5 file system specified in UEFI 2.0. It can also be used to abstract a file
8 UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem
10 Copyright (c) 2006 - 2008, Intel Corporation
11 All rights reserved. This program and the accompanying materials
12 are licensed and made available under the terms and conditions of the BSD License
13 which accompanies this distribution. The full text of the license may be found at
14 http://opensource.org/licenses/bsd-license.php
16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 #ifndef __SIMPLE_FILE_SYSTEM_H__
22 #define __SIMPLE_FILE_SYSTEM_H__
24 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
26 0x964e5b22, 0x6459, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
29 typedef struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
;
31 typedef struct _EFI_FILE_PROTOCOL EFI_FILE_PROTOCOL
;
32 typedef struct _EFI_FILE_PROTOCOL
*EFI_FILE_HANDLE
;
35 /// Protocol GUID name defined in EFI1.1.
37 #define SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID
40 /// Protocol name defined in EFI1.1.
42 typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_FILE_IO_INTERFACE
;
43 typedef struct _EFI_FILE_PROTOCOL EFI_FILE
;
46 Open the root directory on a volume.
48 @param This Protocol instance pointer.
49 @param Root Returns an Open file handle for the root directory
51 @retval EFI_SUCCESS The device was opened.
52 @retval EFI_UNSUPPORTED This volume does not suppor the file system.
53 @retval EFI_NO_MEDIA The device has no media.
54 @retval EFI_DEVICE_ERROR The device reported an error.
55 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
56 @retval EFI_ACCESS_DENIED The service denied access to the file
57 @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources
62 (EFIAPI
*EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME
)(
63 IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*This
,
64 OUT EFI_FILE_PROTOCOL
**Root
67 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
70 /// Revision defined in EFI1.1
72 #define EFI_FILE_IO_INTERFACE_REVISION EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION
74 struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
{
76 /// The version of the EFI_SIMPLE_FILE_SYSTEM_PROTOCOL. The version
77 /// specified by this specification is 0x00010000. All future revisions
78 /// must be backwards compatible.
81 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME OpenVolume
;
85 Open the root directory on a volume.
87 @param This Protocol instance pointer.
88 @param NewHandle Returns File Handle for FileName
89 @param FileName Null terminated string. "\", ".", and ".." are supported
90 @param OpenMode Open mode for file.
91 @param Attributes Only used for EFI_FILE_MODE_CREATE
93 @retval EFI_SUCCESS The device was opened.
94 @retval EFI_NOT_FOUND The specified file could not be found on the device
95 @retval EFI_NO_MEDIA The device has no media.
96 @retval EFI_MEDIA_CHANGED The media has changed
97 @retval EFI_DEVICE_ERROR The device reported an error.
98 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
99 @retval EFI_ACCESS_DENIED The service denied access to the file
100 @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources
101 @retval EFI_VOLUME_FULL The volume is full.
106 (EFIAPI
*EFI_FILE_OPEN
)(
107 IN EFI_FILE_PROTOCOL
*This
,
108 OUT EFI_FILE_PROTOCOL
**NewHandle
,
117 #define EFI_FILE_MODE_READ 0x0000000000000001ULL
118 #define EFI_FILE_MODE_WRITE 0x0000000000000002ULL
119 #define EFI_FILE_MODE_CREATE 0x8000000000000000ULL
124 #define EFI_FILE_READ_ONLY 0x0000000000000001ULL
125 #define EFI_FILE_HIDDEN 0x0000000000000002ULL
126 #define EFI_FILE_SYSTEM 0x0000000000000004ULL
127 #define EFI_FILE_RESERVED 0x0000000000000008ULL
128 #define EFI_FILE_DIRECTORY 0x0000000000000010ULL
129 #define EFI_FILE_ARCHIVE 0x0000000000000020ULL
130 #define EFI_FILE_VALID_ATTR 0x0000000000000037ULL
133 Close the file handle
135 @param This Protocol instance pointer.
137 @retval EFI_SUCCESS The device was opened.
142 (EFIAPI
*EFI_FILE_CLOSE
)(
147 Close and delete the file handle
149 @param This Protocol instance pointer.
151 @retval EFI_SUCCESS The device was opened.
152 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted
157 (EFIAPI
*EFI_FILE_DELETE
)(
162 Read data from the file.
164 @param This Protocol instance pointer.
165 @param BufferSize On input size of buffer, on output amount of data in buffer.
166 @param Buffer The buffer in which data is read.
168 @retval EFI_SUCCESS Data was read.
169 @retval EFI_NO_MEDIA The device has no media
170 @retval EFI_DEVICE_ERROR The device reported an error
171 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
172 @retval EFI_BUFFER_TO_SMALL BufferSize is too small. BufferSize contains required size
177 (EFIAPI
*EFI_FILE_READ
)(
178 IN EFI_FILE_PROTOCOL
*This
,
179 IN OUT UINTN
*BufferSize
,
184 Write data from to the file.
186 @param This Protocol instance pointer.
187 @param BufferSize On input size of buffer, on output amount of data in buffer.
188 @param Buffer The buffer in which data to write.
190 @retval EFI_SUCCESS Data was written.
191 @retval EFI_UNSUPPORT Writes to Open directory are not supported
192 @retval EFI_NO_MEDIA The device has no media
193 @retval EFI_DEVICE_ERROR The device reported an error
194 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
195 @retval EFI_WRITE_PROTECTED The device is write protected
196 @retval EFI_ACCESS_DENIED The file was open for read only
197 @retval EFI_VOLUME_FULL The volume is full
202 (EFIAPI
*EFI_FILE_WRITE
)(
203 IN EFI_FILE_PROTOCOL
*This
,
204 IN OUT UINTN
*BufferSize
,
209 Set a files current position
211 @param This Protocol instance pointer.
212 @param Position Byte possition from the start of the file
214 @retval EFI_SUCCESS Data was written.
215 @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.
220 (EFIAPI
*EFI_FILE_SET_POSITION
)(
221 IN EFI_FILE_PROTOCOL
*This
,
226 Get a files current position
228 @param This Protocol instance pointer.
229 @param Position Byte possition from the start of the file
231 @retval EFI_SUCCESS Data was written.
232 @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.
237 (EFIAPI
*EFI_FILE_GET_POSITION
)(
238 IN EFI_FILE_PROTOCOL
*This
,
243 Get information about a file
245 @param This Protocol instance pointer.
246 @param InformationType Type of info to return in Buffer
247 @param BufferSize On input size of buffer, on output amount of data in buffer.
248 @param Buffer The buffer to return data.
250 @retval EFI_SUCCESS Data was returned.
251 @retval EFI_UNSUPPORT InformationType is not supported
252 @retval EFI_NO_MEDIA The device has no media
253 @retval EFI_DEVICE_ERROR The device reported an error
254 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
255 @retval EFI_WRITE_PROTECTED The device is write protected
256 @retval EFI_ACCESS_DENIED The file was open for read only
257 @retval EFI_BUFFER_TOO_SMALL Buffer was too small, required size returned in BufferSize
262 (EFIAPI
*EFI_FILE_GET_INFO
)(
263 IN EFI_FILE_PROTOCOL
*This
,
264 IN EFI_GUID
*InformationType
,
265 IN OUT UINTN
*BufferSize
,
270 Set information about a file
272 @param File Protocol instance pointer.
273 @param InformationType Type of info in Buffer
274 @param BufferSize Size of buffer.
275 @param Buffer The data to write.
277 @retval EFI_SUCCESS Data was returned.
278 @retval EFI_UNSUPPORT InformationType is not supported
279 @retval EFI_NO_MEDIA The device has no media
280 @retval EFI_DEVICE_ERROR The device reported an error
281 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
282 @retval EFI_WRITE_PROTECTED The device is write protected
283 @retval EFI_ACCESS_DENIED The file was open for read only
288 (EFIAPI
*EFI_FILE_SET_INFO
)(
289 IN EFI_FILE_PROTOCOL
*This
,
290 IN EFI_GUID
*InformationType
,
296 Flush data back for the file handle
298 @param This Protocol instance pointer.
300 @retval EFI_SUCCESS Data was written.
301 @retval EFI_UNSUPPORT Writes to Open directory are not supported
302 @retval EFI_NO_MEDIA The device has no media
303 @retval EFI_DEVICE_ERROR The device reported an error
304 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
305 @retval EFI_WRITE_PROTECTED The device is write protected
306 @retval EFI_ACCESS_DENIED The file was open for read only
307 @retval EFI_VOLUME_FULL The volume is full
312 (EFIAPI
*EFI_FILE_FLUSH
)(
316 #define EFI_FILE_PROTOCOL_REVISION 0x00010000
318 // Revision defined in EFI1.1.
320 #define EFI_FILE_REVISION EFI_FILE_PROTOCOL_REVISION
323 /// The EFI_FILE_PROTOCOL provides file IO access to supported file systems.
324 /// An EFI_FILE_PROTOCOL provides access to a file's or directory's contents,
325 /// and is also a reference to a location in the directory tree of the file system
326 /// in which the file resides. With any given file handle, other files may be opened
327 /// relative to this file's location, yielding new file handles.
329 struct _EFI_FILE_PROTOCOL
{
331 /// The version of the EFI_FILE_PROTOCOL interface. The version specified
332 /// by this specification is 0x00010000. Future versions are required
333 /// to be backward compatible to version 1.0.
337 EFI_FILE_CLOSE Close
;
338 EFI_FILE_DELETE Delete
;
340 EFI_FILE_WRITE Write
;
341 EFI_FILE_GET_POSITION GetPosition
;
342 EFI_FILE_SET_POSITION SetPosition
;
343 EFI_FILE_GET_INFO GetInfo
;
344 EFI_FILE_SET_INFO SetInfo
;
345 EFI_FILE_FLUSH Flush
;
349 extern EFI_GUID gEfiSimpleFileSystemProtocolGuid
;