Include/Protocol/SimpleFileSystem.h

1 /** @file
5   file system specified in UEFI 2.0. It can also be used to abstract a file
43   @param  Root A pointer to the location to return the opened file handle for the
47   @retval EFI_UNSUPPORTED      This volume does not support the requested file system type.
50   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
51   @retval EFI_ACCESS_DENIED    The service denied access to the file.
54                                longer supported. Any existing file handles for this volume are
84   Opens a new file relative to the source file's location.
86   @param  This       A pointer to the EFI_FILE_PROTOCOL instance that is the file
90                      file.
91   @param  FileName   The Null-terminated string of the name of the file to be opened.
92                      The file name may contain the following path modifiers: "\", ".",
94   @param  OpenMode   The mode to open the file. The only valid combinations that the
95                      file may be opened with are: Read, Read/Write, or Create/Read/Write.
97                      attribute bits for the newly created file.
99   @retval EFI_SUCCESS          The file was opened.
100   @retval EFI_NOT_FOUND        The specified file could not be found on the device.
105   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
106   @retval EFI_WRITE_PROTECTED  An attempt was made to create a file, or open a file for write
108   @retval EFI_ACCESS_DENIED    The service denied access to the file.
109   @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
131 // File attributes
142   Closes a specified file handle.
144   @param  This          A pointer to the EFI_FILE_PROTOCOL instance that is the file
147   @retval EFI_SUCCESS   The file was closed.
157   Close and delete the file handle.
160                                    handle to the file to delete.
162   @retval EFI_SUCCESS              The file was closed and deleted, and the handle was closed.
163   @retval EFI_WARN_DELETE_FAILURE  The handle was closed, but the file was not deleted.
173   Reads data from a file.
175   @param  This       A pointer to the EFI_FILE_PROTOCOL instance that is the file
184   @retval EFI_DEVICE_ERROR     An attempt was made to read from a deleted file.
185   @retval EFI_DEVICE_ERROR     On entry, the current file position is beyond the end of the file.
186   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
201   Writes data to a file.
203   @param  This       A pointer to the EFI_FILE_PROTOCOL instance that is the file
213   @retval EFI_DEVICE_ERROR     An attempt was made to write to a deleted file.
214   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
215   @retval EFI_WRITE_PROTECTED  The file or medium is write-protected.
216   @retval EFI_ACCESS_DENIED    The file was opened read only.
229   Sets a file's current position.
232                           file handle to set the requested position on.
233   @param  Position        The byte position from the start of the file to set.
238   @retval EFI_DEVICE_ERROR An attempt was made to set the position of a deleted file.
249   Returns a file's current position.
251   @param  This            A pointer to the EFI_FILE_PROTOCOL instance that is the file
253   @param  Position        The address to return the file's current position value.
257   @retval EFI_DEVICE_ERROR An attempt was made to get the position from a deleted file.
268   Returns information about a file.
270   @param  This            A pointer to the EFI_FILE_PROTOCOL instance that is the file
282   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
297   Sets information about a file.
299   @param  File            A pointer to the EFI_FILE_PROTOCOL instance that is the file
310   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
317   @retval EFI_ACCESS_DENIED    An attempt is made to change the name of a file to a
318                                file that is already present.
322   @retval EFI_ACCESS_DENIED    InformationType is EFI_FILE_INFO_ID and the file was opened
340   Flushes all modified data associated with a file to a device.
342   @param  This A pointer to the EFI_FILE_PROTOCOL instance that is the file
348   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
349   @retval EFI_WRITE_PROTECTED  The file or medium is write-protected.
350   @retval EFI_ACCESS_DENIED    The file was opened read-only.
395   Opens a new file relative to the source directory's location.
397   @param  This       A pointer to the EFI_FILE_PROTOCOL instance that is the file
400                      file.
401   @param  FileName   The Null-terminated string of the name of the file to be opened.
402                      The file name may contain the following path modifiers: "\", ".",
404   @param  OpenMode   The mode to open the file. The only valid combinations that the
405                      file may be opened with are: Read, Read/Write, or Create/Read/Write.
407                      attribute bits for the newly created file.
413   @retval EFI_NOT_FOUND        The specified file could not be found on the device.
418   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
419   @retval EFI_WRITE_PROTECTED  An attempt was made to create a file, or open a file for write
421   @retval EFI_ACCESS_DENIED    The service denied access to the file.
422   @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
438   Reads data from a file.
440 …@param  This       A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to read dat…
448   @retval EFI_DEVICE_ERROR     An attempt was made to read from a deleted file.
449   @retval EFI_DEVICE_ERROR     On entry, the current file position is beyond the end of the file.
450   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
461   Writes data to a file.
463 …@param  This       A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to write da…
472   @retval EFI_DEVICE_ERROR     An attempt was made to write to a deleted file.
473   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
474   @retval EFI_WRITE_PROTECTED  The file or medium is write-protected.
475   @retval EFI_ACCESS_DENIED    The file was opened read only.
487   Flushes all modified data associated with a file to a device.
489   @param  This  A pointer to the EFI_FILE_PROTOCOL instance that is the file
498   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
499   @retval EFI_WRITE_PROTECTED  The file or medium is write-protected.
500   @retval EFI_ACCESS_DENIED    The file was opened read-only.
522 /// The EFI_FILE_PROTOCOL provides file IO access to supported file systems.
523 /// An EFI_FILE_PROTOCOL provides access to a file's or directory's contents,
524 /// and is also a reference to a location in the directory tree of the file system
525 /// in which the file resides. With any given file handle, other files may be opened
526 /// relative to this file's location, yielding new file handles.