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
;
36 /// Protocol GUID defined in EFI1.1.
38 #define SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID
41 /// Protocol defined in EFI1.1.
43 typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_FILE_IO_INTERFACE
;
44 typedef struct _EFI_FILE_PROTOCOL EFI_FILE
;
47 Open the root directory on a volume.
49 @param This Protocol instance pointer.
50 @param Root Returns an Open file handle for the root directory
52 @retval EFI_SUCCESS The device was opened.
53 @retval EFI_UNSUPPORTED This volume does not suppor the file system.
54 @retval EFI_NO_MEDIA The device has no media.
55 @retval EFI_DEVICE_ERROR The device reported an error.
56 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
57 @retval EFI_ACCESS_DENIED The service denied access to the file
58 @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources
63 (EFIAPI
*EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME
)(
64 IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*This
,
65 OUT EFI_FILE_PROTOCOL
**Root
68 #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 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME OpenVolume
;
80 Open the root directory on a volume.
82 @param This Protocol instance pointer.
83 @param NewHandle Returns File Handle for FileName
84 @param FileName Null terminated string. "\", ".", and ".." are supported
85 @param OpenMode Open mode for file.
86 @param Attributes Only used for EFI_FILE_MODE_CREATE
88 @retval EFI_SUCCESS The device was opened.
89 @retval EFI_NOT_FOUND The specified file could not be found on the device
90 @retval EFI_NO_MEDIA The device has no media.
91 @retval EFI_MEDIA_CHANGED The media has changed
92 @retval EFI_DEVICE_ERROR The device reported an error.
93 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
94 @retval EFI_ACCESS_DENIED The service denied access to the file
95 @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources
96 @retval EFI_VOLUME_FULL The volume is full.
101 (EFIAPI
*EFI_FILE_OPEN
)(
102 IN EFI_FILE_PROTOCOL
*This
,
103 OUT EFI_FILE_PROTOCOL
**NewHandle
,
112 #define EFI_FILE_MODE_READ 0x0000000000000001ULL
113 #define EFI_FILE_MODE_WRITE 0x0000000000000002ULL
114 #define EFI_FILE_MODE_CREATE 0x8000000000000000ULL
119 #define EFI_FILE_READ_ONLY 0x0000000000000001ULL
120 #define EFI_FILE_HIDDEN 0x0000000000000002ULL
121 #define EFI_FILE_SYSTEM 0x0000000000000004ULL
122 #define EFI_FILE_RESERVED 0x0000000000000008ULL
123 #define EFI_FILE_DIRECTORY 0x0000000000000010ULL
124 #define EFI_FILE_ARCHIVE 0x0000000000000020ULL
125 #define EFI_FILE_VALID_ATTR 0x0000000000000037ULL
128 Close the file handle
130 @param This Protocol instance pointer.
132 @retval EFI_SUCCESS The device was opened.
137 (EFIAPI
*EFI_FILE_CLOSE
)(
142 Close and delete the file handle
144 @param This Protocol instance pointer.
146 @retval EFI_SUCCESS The device was opened.
147 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted
152 (EFIAPI
*EFI_FILE_DELETE
)(
157 Read data from the file.
159 @param This Protocol instance pointer.
160 @param BufferSize On input size of buffer, on output amount of data in buffer.
161 @param Buffer The buffer in which data is read.
163 @retval EFI_SUCCESS Data was read.
164 @retval EFI_NO_MEDIA The device has no media
165 @retval EFI_DEVICE_ERROR The device reported an error
166 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
167 @retval EFI_BUFFER_TO_SMALL BufferSize is too small. BufferSize contains required size
172 (EFIAPI
*EFI_FILE_READ
)(
173 IN EFI_FILE_PROTOCOL
*This
,
174 IN OUT UINTN
*BufferSize
,
179 Write data from to the file.
181 @param This Protocol instance pointer.
182 @param BufferSize On input size of buffer, on output amount of data in buffer.
183 @param Buffer The buffer in which data to write.
185 @retval EFI_SUCCESS Data was written.
186 @retval EFI_UNSUPPORT Writes to Open directory are not supported
187 @retval EFI_NO_MEDIA The device has no media
188 @retval EFI_DEVICE_ERROR The device reported an error
189 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
190 @retval EFI_WRITE_PROTECTED The device is write protected
191 @retval EFI_ACCESS_DENIED The file was open for read only
192 @retval EFI_VOLUME_FULL The volume is full
197 (EFIAPI
*EFI_FILE_WRITE
)(
198 IN EFI_FILE_PROTOCOL
*This
,
199 IN OUT UINTN
*BufferSize
,
204 Set a files current position
206 @param This Protocol instance pointer.
207 @param Position Byte possition from the start of the file
209 @retval EFI_SUCCESS Data was written.
210 @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.
215 (EFIAPI
*EFI_FILE_SET_POSITION
)(
216 IN EFI_FILE_PROTOCOL
*This
,
221 Get a files current position
223 @param This Protocol instance pointer.
224 @param Position Byte possition from the start of the file
226 @retval EFI_SUCCESS Data was written.
227 @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.
232 (EFIAPI
*EFI_FILE_GET_POSITION
)(
233 IN EFI_FILE_PROTOCOL
*This
,
238 Get information about a file
240 @param This Protocol instance pointer.
241 @param InformationType Type of info to return in Buffer
242 @param BufferSize On input size of buffer, on output amount of data in buffer.
243 @param Buffer The buffer to return data.
245 @retval EFI_SUCCESS Data was returned.
246 @retval EFI_UNSUPPORT InformationType is not supported
247 @retval EFI_NO_MEDIA The device has no media
248 @retval EFI_DEVICE_ERROR The device reported an error
249 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
250 @retval EFI_WRITE_PROTECTED The device is write protected
251 @retval EFI_ACCESS_DENIED The file was open for read only
252 @retval EFI_BUFFER_TOO_SMALL Buffer was too small, required size returned in BufferSize
257 (EFIAPI
*EFI_FILE_GET_INFO
)(
258 IN EFI_FILE_PROTOCOL
*This
,
259 IN EFI_GUID
*InformationType
,
260 IN OUT UINTN
*BufferSize
,
265 Set information about a file
267 @param File Protocol instance pointer.
268 @param InformationType Type of info in Buffer
269 @param BufferSize Size of buffer.
270 @param Buffer The data to write.
272 @retval EFI_SUCCESS Data was returned.
273 @retval EFI_UNSUPPORT InformationType is not supported
274 @retval EFI_NO_MEDIA The device has no media
275 @retval EFI_DEVICE_ERROR The device reported an error
276 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
277 @retval EFI_WRITE_PROTECTED The device is write protected
278 @retval EFI_ACCESS_DENIED The file was open for read only
283 (EFIAPI
*EFI_FILE_SET_INFO
)(
284 IN EFI_FILE_PROTOCOL
*This
,
285 IN EFI_GUID
*InformationType
,
291 Flush data back for the file handle
293 @param This Protocol instance pointer.
295 @retval EFI_SUCCESS Data was written.
296 @retval EFI_UNSUPPORT Writes to Open directory are not supported
297 @retval EFI_NO_MEDIA The device has no media
298 @retval EFI_DEVICE_ERROR The device reported an error
299 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
300 @retval EFI_WRITE_PROTECTED The device is write protected
301 @retval EFI_ACCESS_DENIED The file was open for read only
302 @retval EFI_VOLUME_FULL The volume is full
307 (EFIAPI
*EFI_FILE_FLUSH
)(
311 #define EFI_FILE_PROTOCOL_REVISION 0x00010000
313 // Revision defined in EFI1.1.
315 #define EFI_FILE_REVISION EFI_FILE_PROTOCOL_REVISION
318 /// The EFI_FILE_PROTOCOL provides file IO access to supported file systems.
319 /// An EFI_FILE_PROTOCOL provides access to a file's or directory's contents,
320 /// and is also a reference to a location in the directory tree of the file system
321 /// in which the file resides. With any given file handle, other files may be opened
322 /// relative to this file's location, yielding new file handles.
324 struct _EFI_FILE_PROTOCOL
{
326 /// The version of the EFI_FILE_PROTOCOL interface. The version specified
327 /// by this specification is 0x00010000. Future versions are required
328 /// to be backward compatible to version 1.0.
332 EFI_FILE_CLOSE Close
;
333 EFI_FILE_DELETE Delete
;
335 EFI_FILE_WRITE Write
;
336 EFI_FILE_GET_POSITION GetPosition
;
337 EFI_FILE_SET_POSITION SetPosition
;
338 EFI_FILE_GET_INFO GetInfo
;
339 EFI_FILE_SET_INFO SetInfo
;
340 EFI_FILE_FLUSH Flush
;
344 extern EFI_GUID gEfiSimpleFileSystemProtocolGuid
;