iPXE
Data Structures | Defines | Typedefs | Functions | Variables
SimpleFileSystem.h File Reference

SimpleFileSystem protocol as defined in the UEFI 2.0 specification. More...

Go to the source code of this file.

Data Structures

struct  _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
struct  EFI_FILE_IO_TOKEN
struct  _EFI_FILE_PROTOCOL
 The EFI_FILE_PROTOCOL provides file IO access to supported file systems. An EFI_FILE_PROTOCOL provides access to a file's or directory's contents, and is also a reference to a location in the directory tree of the file system in which the file resides. With any given file handle, other files may be opened relative to this file's location, yielding new file handles. More...

Defines

#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID
#define SIMPLE_FILE_SYSTEM_PROTOCOL   EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID
 Protocol GUID name defined in EFI1.1.
#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION   0x00010000
#define EFI_FILE_IO_INTERFACE_REVISION   EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION
 Revision defined in EFI1.1.
#define EFI_FILE_MODE_READ   0x0000000000000001ULL
#define EFI_FILE_MODE_WRITE   0x0000000000000002ULL
#define EFI_FILE_MODE_CREATE   0x8000000000000000ULL
#define EFI_FILE_READ_ONLY   0x0000000000000001ULL
#define EFI_FILE_HIDDEN   0x0000000000000002ULL
#define EFI_FILE_SYSTEM   0x0000000000000004ULL
#define EFI_FILE_RESERVED   0x0000000000000008ULL
#define EFI_FILE_DIRECTORY   0x0000000000000010ULL
#define EFI_FILE_ARCHIVE   0x0000000000000020ULL
#define EFI_FILE_VALID_ATTR   0x0000000000000037ULL
#define EFI_FILE_PROTOCOL_REVISION   0x00010000
#define EFI_FILE_PROTOCOL_REVISION2   0x00020000
#define EFI_FILE_PROTOCOL_LATEST_REVISION   EFI_FILE_PROTOCOL_REVISION2
#define EFI_FILE_REVISION   EFI_FILE_PROTOCOL_REVISION

Typedefs

typedef struct
_EFI_SIMPLE_FILE_SYSTEM_PROTOCOL 
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
typedef struct _EFI_FILE_PROTOCOL EFI_FILE_PROTOCOL
typedef struct _EFI_FILE_PROTOCOLEFI_FILE_HANDLE
typedef
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL 
EFI_FILE_IO_INTERFACE
 Protocol name defined in EFI1.1.
typedef EFI_FILE_PROTOCOL EFI_FILE
typedef EFI_STATUS(EFIAPIEFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME )(IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This, OUT EFI_FILE_PROTOCOL **Root)
 Open the root directory on a volume.
typedef EFI_STATUS(EFIAPIEFI_FILE_OPEN )(IN EFI_FILE_PROTOCOL *This, OUT EFI_FILE_PROTOCOL **NewHandle, IN CHAR16 *FileName, IN UINT64 OpenMode, IN UINT64 Attributes)
 Opens a new file relative to the source file's location.
typedef EFI_STATUS(EFIAPIEFI_FILE_CLOSE )(IN EFI_FILE_PROTOCOL *This)
 Closes a specified file handle.
typedef EFI_STATUS(EFIAPIEFI_FILE_DELETE )(IN EFI_FILE_PROTOCOL *This)
 Close and delete the file handle.
typedef EFI_STATUS(EFIAPIEFI_FILE_READ )(IN EFI_FILE_PROTOCOL *This, IN OUT UINTN *BufferSize, OUT VOID *Buffer)
 Reads data from a file.
typedef EFI_STATUS(EFIAPIEFI_FILE_WRITE )(IN EFI_FILE_PROTOCOL *This, IN OUT UINTN *BufferSize, IN VOID *Buffer)
 Writes data to a file.
typedef EFI_STATUS(EFIAPIEFI_FILE_SET_POSITION )(IN EFI_FILE_PROTOCOL *This, IN UINT64 Position)
 Sets a file's current position.
typedef EFI_STATUS(EFIAPIEFI_FILE_GET_POSITION )(IN EFI_FILE_PROTOCOL *This, OUT UINT64 *Position)
 Returns a file's current position.
typedef EFI_STATUS(EFIAPIEFI_FILE_GET_INFO )(IN EFI_FILE_PROTOCOL *This, IN EFI_GUID *InformationType, IN OUT UINTN *BufferSize, OUT VOID *Buffer)
 Returns information about a file.
typedef EFI_STATUS(EFIAPIEFI_FILE_SET_INFO )(IN EFI_FILE_PROTOCOL *This, IN EFI_GUID *InformationType, IN UINTN BufferSize, IN VOID *Buffer)
 Sets information about a file.
typedef EFI_STATUS(EFIAPIEFI_FILE_FLUSH )(IN EFI_FILE_PROTOCOL *This)
 Flushes all modified data associated with a file to a device.
typedef EFI_STATUS(EFIAPIEFI_FILE_OPEN_EX )(IN EFI_FILE_PROTOCOL *This, OUT EFI_FILE_PROTOCOL **NewHandle, IN CHAR16 *FileName, IN UINT64 OpenMode, IN UINT64 Attributes, IN OUT EFI_FILE_IO_TOKEN *Token)
 Opens a new file relative to the source directory's location.
typedef IN OUT EFI_FILE_IO_TOKENToken

Functions

 FILE_LICENCE (BSD3)
typedef EFI_STATUS (EFIAPI *EFI_FILE_READ_EX)(IN EFI_FILE_PROTOCOL *This
 Reads data from a file.

Variables

EFI_GUID gEfiSimpleFileSystemProtocolGuid

Detailed Description

SimpleFileSystem protocol as defined in the UEFI 2.0 specification.

The SimpleFileSystem protocol is the programmatic access to the FAT (12,16,32) file system specified in UEFI 2.0. It can also be used to abstract a file system other than FAT.

UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem.

Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file SimpleFileSystem.h.


Define Documentation

Value:
{ \
    0x964e5b22, 0x6459, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  }

Definition at line 26 of file SimpleFileSystem.h.

Protocol GUID name defined in EFI1.1.

Definition at line 39 of file SimpleFileSystem.h.

Definition at line 74 of file SimpleFileSystem.h.

Revision defined in EFI1.1.

Definition at line 79 of file SimpleFileSystem.h.

#define EFI_FILE_MODE_READ   0x0000000000000001ULL

Definition at line 134 of file SimpleFileSystem.h.

Referenced by efi_file_open(), and efi_local_open_resolved().

#define EFI_FILE_MODE_WRITE   0x0000000000000002ULL

Definition at line 135 of file SimpleFileSystem.h.

#define EFI_FILE_MODE_CREATE   0x8000000000000000ULL

Definition at line 136 of file SimpleFileSystem.h.

#define EFI_FILE_READ_ONLY   0x0000000000000001ULL

Definition at line 141 of file SimpleFileSystem.h.

Referenced by efi_file_info().

#define EFI_FILE_HIDDEN   0x0000000000000002ULL

Definition at line 142 of file SimpleFileSystem.h.

#define EFI_FILE_SYSTEM   0x0000000000000004ULL

Definition at line 143 of file SimpleFileSystem.h.

#define EFI_FILE_RESERVED   0x0000000000000008ULL

Definition at line 144 of file SimpleFileSystem.h.

#define EFI_FILE_DIRECTORY   0x0000000000000010ULL

Definition at line 145 of file SimpleFileSystem.h.

Referenced by efi_file_info().

#define EFI_FILE_ARCHIVE   0x0000000000000020ULL

Definition at line 146 of file SimpleFileSystem.h.

#define EFI_FILE_VALID_ATTR   0x0000000000000037ULL

Definition at line 147 of file SimpleFileSystem.h.

#define EFI_FILE_PROTOCOL_REVISION   0x00010000

Definition at line 522 of file SimpleFileSystem.h.

#define EFI_FILE_PROTOCOL_REVISION2   0x00020000

Definition at line 523 of file SimpleFileSystem.h.

Definition at line 524 of file SimpleFileSystem.h.

Definition at line 529 of file SimpleFileSystem.h.


Typedef Documentation

Definition at line 31 of file SimpleFileSystem.h.

Definition at line 33 of file SimpleFileSystem.h.

Definition at line 34 of file SimpleFileSystem.h.

Protocol name defined in EFI1.1.

Definition at line 44 of file SimpleFileSystem.h.

Definition at line 45 of file SimpleFileSystem.h.

Open the root directory on a volume.

Parameters:
ThisA pointer to the volume to open the root directory.
RootA pointer to the location to return the opened file handle for the root directory.
Return values:
EFI_SUCCESSThe device was opened.
EFI_UNSUPPORTEDThis volume does not support the requested file system type.
EFI_NO_MEDIAThe device has no medium.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_ACCESS_DENIEDThe service denied access to the file.
EFI_OUT_OF_RESOURCESThe volume was not opened due to lack of resources.
EFI_MEDIA_CHANGEDThe device has a different medium in it or the medium is no longer supported. Any existing file handles for this volume are no longer valid. To access the files on the new medium, the volume must be reopened with OpenVolume().

Definition at line 69 of file SimpleFileSystem.h.

typedef EFI_STATUS(EFIAPI * EFI_FILE_OPEN)(IN EFI_FILE_PROTOCOL *This, OUT EFI_FILE_PROTOCOL **NewHandle, IN CHAR16 *FileName, IN UINT64 OpenMode, IN UINT64 Attributes)

Opens a new file relative to the source file's location.

Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the file handle to the source location. This would typically be an open handle to a directory.
NewHandleA pointer to the location to return the opened handle for the new file.
FileNameThe Null-terminated string of the name of the file to be opened. The file name may contain the following path modifiers: "\", ".", and "..".
OpenModeThe mode to open the file. The only valid combinations that the file may be opened with are: Read, Read/Write, or Create/Read/Write.
AttributesOnly valid for EFI_FILE_MODE_CREATE, in which case these are the attribute bits for the newly created file.
Return values:
EFI_SUCCESSThe file was opened.
EFI_NOT_FOUNDThe specified file could not be found on the device.
EFI_NO_MEDIAThe device has no medium.
EFI_MEDIA_CHANGEDThe device has a different medium in it or the medium is no longer supported.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDAn attempt was made to create a file, or open a file for write when the media is write-protected.
EFI_ACCESS_DENIEDThe service denied access to the file.
EFI_OUT_OF_RESOURCESNot enough resources were available to open the file.
EFI_VOLUME_FULLThe volume is full.

Definition at line 123 of file SimpleFileSystem.h.

Closes a specified file handle.

Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the file handle to close.
Return values:
EFI_SUCCESSThe file was closed.

Definition at line 160 of file SimpleFileSystem.h.

Close and delete the file handle.

Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the handle to the file to delete.
Return values:
EFI_SUCCESSThe file was closed and deleted, and the handle was closed.
EFI_WARN_DELETE_FAILUREThe handle was closed, but the file was not deleted.

Definition at line 176 of file SimpleFileSystem.h.

Reads data from a file.

Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the file handle to read data from.
BufferSizeOn input, the size of the Buffer. On output, the amount of data returned in Buffer. In both cases, the size is measured in bytes.
BufferThe buffer into which the data is read.
Return values:
EFI_SUCCESSData was read.
EFI_NO_MEDIAThe device has no medium.
EFI_DEVICE_ERRORThe device reported an error.
EFI_DEVICE_ERRORAn attempt was made to read from a deleted file.
EFI_DEVICE_ERROROn entry, the current file position is beyond the end of the file.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_BUFFER_TOO_SMALLThe BufferSize is too small to read the current directory entry. BufferSize has been updated with the size needed to complete the request.

Definition at line 202 of file SimpleFileSystem.h.

Writes data to a file.

Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the file handle to write data to.
BufferSizeOn input, the size of the Buffer. On output, the amount of data actually written. In both cases, the size is measured in bytes.
BufferThe buffer of data to write.
Return values:
EFI_SUCCESSData was written.
EFI_UNSUPPORTEDWrites to open directory files are not supported.
EFI_NO_MEDIAThe device has no medium.
EFI_DEVICE_ERRORThe device reported an error.
EFI_DEVICE_ERRORAn attempt was made to write to a deleted file.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe file or medium is write-protected.
EFI_ACCESS_DENIEDThe file was opened read only.
EFI_VOLUME_FULLThe volume is full.

Definition at line 230 of file SimpleFileSystem.h.

Sets a file's current position.

Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the file handle to set the requested position on.
PositionThe byte position from the start of the file to set.
Return values:
EFI_SUCCESSThe position was set.
EFI_UNSUPPORTEDThe seek request for nonzero is not valid on open directories.
EFI_DEVICE_ERRORAn attempt was made to set the position of a deleted file.

Definition at line 251 of file SimpleFileSystem.h.

Returns a file's current position.

Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the file handle to get the current position on.
PositionThe address to return the file's current position value.
Return values:
EFI_SUCCESSThe position was returned.
EFI_UNSUPPORTEDThe request is not valid on open directories.
EFI_DEVICE_ERRORAn attempt was made to get the position from a deleted file.

Definition at line 270 of file SimpleFileSystem.h.

Returns information about a file.

Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the file handle the requested information is for.
InformationTypeThe type identifier for the information being requested.
BufferSizeOn input, the size of Buffer. On output, the amount of data returned in Buffer. In both cases, the size is measured in bytes.
BufferA pointer to the data buffer to return. The buffer's type is indicated by InformationType.
Return values:
EFI_SUCCESSThe information was returned.
EFI_UNSUPPORTEDThe InformationType is not known.
EFI_NO_MEDIAThe device has no medium.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_BUFFER_TOO_SMALLThe BufferSize is too small to read the current directory entry. BufferSize has been updated with the size needed to complete the request.

Definition at line 297 of file SimpleFileSystem.h.

Sets information about a file.

Parameters:
FileA pointer to the EFI_FILE_PROTOCOL instance that is the file handle the information is for.
InformationTypeThe type identifier for the information being set.
BufferSizeThe size, in bytes, of Buffer.
BufferA pointer to the data buffer to write. The buffer's type is indicated by InformationType.
Return values:
EFI_SUCCESSThe information was set.
EFI_UNSUPPORTEDThe InformationType is not known.
EFI_NO_MEDIAThe device has no medium.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDInformationType is EFI_FILE_INFO_ID and the media is read-only.
EFI_WRITE_PROTECTEDInformationType is EFI_FILE_PROTOCOL_SYSTEM_INFO_ID and the media is read only.
EFI_WRITE_PROTECTEDInformationType is EFI_FILE_SYSTEM_VOLUME_LABEL_ID and the media is read-only.
EFI_ACCESS_DENIEDAn attempt is made to change the name of a file to a file that is already present.
EFI_ACCESS_DENIEDAn attempt is being made to change the EFI_FILE_DIRECTORY Attribute.
EFI_ACCESS_DENIEDAn attempt is being made to change the size of a directory.
EFI_ACCESS_DENIEDInformationType is EFI_FILE_INFO_ID and the file was opened read-only and an attempt is being made to modify a field other than Attribute.
EFI_VOLUME_FULLThe volume is full.
EFI_BAD_BUFFER_SIZEBufferSize is smaller than the size of the type indicated by InformationType.

Definition at line 340 of file SimpleFileSystem.h.

Flushes all modified data associated with a file to a device.

Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the file handle to flush.
Return values:
EFI_SUCCESSThe data was flushed.
EFI_NO_MEDIAThe device has no medium.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe file or medium is write-protected.
EFI_ACCESS_DENIEDThe file was opened read-only.
EFI_VOLUME_FULLThe volume is full.

Definition at line 364 of file SimpleFileSystem.h.

Opens a new file relative to the source directory's location.

Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the file handle to the source location.
NewHandleA pointer to the location to return the opened handle for the new file.
FileNameThe Null-terminated string of the name of the file to be opened. The file name may contain the following path modifiers: "\", ".", and "..".
OpenModeThe mode to open the file. The only valid combinations that the file may be opened with are: Read, Read/Write, or Create/Read/Write.
AttributesOnly valid for EFI_FILE_MODE_CREATE, in which case these are the attribute bits for the newly created file.
TokenA pointer to the token associated with the transaction.
Return values:
EFI_SUCCESSIf Event is NULL (blocking I/O): The data was read successfully. If Event is not NULL (asynchronous I/O): The request was successfully queued for processing.
EFI_NOT_FOUNDThe specified file could not be found on the device.
EFI_NO_MEDIAThe device has no medium.
EFI_MEDIA_CHANGEDThe device has a different medium in it or the medium is no longer supported.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDAn attempt was made to create a file, or open a file for write when the media is write-protected.
EFI_ACCESS_DENIEDThe service denied access to the file.
EFI_OUT_OF_RESOURCESNot enough resources were available to open the file.
EFI_VOLUME_FULLThe volume is full.

Definition at line 436 of file SimpleFileSystem.h.

Definition at line 467 of file SimpleFileSystem.h.


Function Documentation

FILE_LICENCE ( BSD3  )
typedef EFI_STATUS ( EFIAPI EFI_FILE_FLUSH_EX)

Reads data from a file.

Flushes all modified data associated with a file to a device.

Writes data to a file.

Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the file handle to read data from.
TokenA pointer to the token associated with the transaction.
Return values:
EFI_SUCCESSIf Event is NULL (blocking I/O): The data was read successfully. If Event is not NULL (asynchronous I/O): The request was successfully queued for processing.
EFI_NO_MEDIAThe device has no medium.
EFI_DEVICE_ERRORThe device reported an error.
EFI_DEVICE_ERRORAn attempt was made to read from a deleted file.
EFI_DEVICE_ERROROn entry, the current file position is beyond the end of the file.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_OUT_OF_RESOURCESUnable to queue the request due to lack of resources.
Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the file handle to write data to.
TokenA pointer to the token associated with the transaction.
Return values:
EFI_SUCCESSIf Event is NULL (blocking I/O): The data was read successfully. If Event is not NULL (asynchronous I/O): The request was successfully queued for processing.
EFI_UNSUPPORTEDWrites to open directory files are not supported.
EFI_NO_MEDIAThe device has no medium.
EFI_DEVICE_ERRORThe device reported an error.
EFI_DEVICE_ERRORAn attempt was made to write to a deleted file.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe file or medium is write-protected.
EFI_ACCESS_DENIEDThe file was opened read only.
EFI_VOLUME_FULLThe volume is full.
EFI_OUT_OF_RESOURCESUnable to queue the request due to lack of resources.
Parameters:
ThisA pointer to the EFI_FILE_PROTOCOL instance that is the file handle to flush.
TokenA pointer to the token associated with the transaction.
Return values:
EFI_SUCCESSIf Event is NULL (blocking I/O): The data was read successfully. If Event is not NULL (asynchronous I/O): The request was successfully queued for processing.
EFI_NO_MEDIAThe device has no medium.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe file or medium is write-protected.
EFI_ACCESS_DENIEDThe file was opened read-only.
EFI_VOLUME_FULLThe volume is full.
EFI_OUT_OF_RESOURCESUnable to queue the request due to lack of resources.

Variable Documentation