Data Structures
struct	_EFI_SIMPLE_FILE_SYSTEM_PROTOCOL

struct	EFI_FILE_IO_TOKEN

struct	_EFI_FILE_PROTOCOL

Macros
#define	EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID

#define	SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID

#define	EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000

#define	EFI_FILE_IO_INTERFACE_REVISION EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION

#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_PROTOCOL *	EFI_FILE_HANDLE

typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL	EFI_FILE_IO_INTERFACE

typedef EFI_FILE_PROTOCOL	EFI_FILE

typedef EFI_STATUS(EFIAPI *	EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME )(IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL This, OUT EFI_FILE_PROTOCOL *Root)

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)

typedef EFI_STATUS(EFIAPI *	EFI_FILE_CLOSE )(IN EFI_FILE_PROTOCOL *This)

typedef EFI_STATUS(EFIAPI *	EFI_FILE_DELETE )(IN EFI_FILE_PROTOCOL *This)

typedef EFI_STATUS(EFIAPI *	EFI_FILE_READ )(IN EFI_FILE_PROTOCOL This, IN OUT UINTN BufferSize, OUT VOID *Buffer)

typedef EFI_STATUS(EFIAPI *	EFI_FILE_WRITE )(IN EFI_FILE_PROTOCOL This, IN OUT UINTN BufferSize, IN VOID *Buffer)

typedef EFI_STATUS(EFIAPI *	EFI_FILE_SET_POSITION )(IN EFI_FILE_PROTOCOL *This, IN UINT64 Position)

typedef EFI_STATUS(EFIAPI *	EFI_FILE_GET_POSITION )(IN EFI_FILE_PROTOCOL This, OUT UINT64 Position)

typedef EFI_STATUS(EFIAPI *	EFI_FILE_GET_INFO )(IN EFI_FILE_PROTOCOL This, IN EFI_GUID InformationType, IN OUT UINTN BufferSize, OUT VOID Buffer)

typedef EFI_STATUS(EFIAPI *	EFI_FILE_SET_INFO )(IN EFI_FILE_PROTOCOL This, IN EFI_GUID InformationType, IN UINTN BufferSize, IN VOID *Buffer)

typedef EFI_STATUS(EFIAPI *	EFI_FILE_FLUSH )(IN EFI_FILE_PROTOCOL *This)

typedef EFI_STATUS(EFIAPI *	EFI_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)

typedef IN OUT EFI_FILE_IO_TOKEN *	Token

Functions
typedef	EFI_STATUS (EFIAPI EFI_FILE_READ_EX)(IN EFI_FILE_PROTOCOL This

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 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define EFI_FILE_ARCHIVE 0x0000000000000020ULL

#define EFI_FILE_DIRECTORY 0x0000000000000010ULL

#define EFI_FILE_HIDDEN 0x0000000000000002ULL

#define EFI_FILE_IO_INTERFACE_REVISION EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION

Revision defined in EFI1.1

#define EFI_FILE_MODE_CREATE 0x8000000000000000ULL

#define EFI_FILE_MODE_READ 0x0000000000000001ULL

#define EFI_FILE_MODE_WRITE 0x0000000000000002ULL

#define EFI_FILE_PROTOCOL_LATEST_REVISION EFI_FILE_PROTOCOL_REVISION2

#define EFI_FILE_PROTOCOL_REVISION 0x00010000

#define EFI_FILE_PROTOCOL_REVISION2 0x00020000

#define EFI_FILE_READ_ONLY 0x0000000000000001ULL

#define EFI_FILE_RESERVED 0x0000000000000008ULL

#define EFI_FILE_REVISION EFI_FILE_PROTOCOL_REVISION

#define EFI_FILE_SYSTEM 0x0000000000000004ULL

#define EFI_FILE_VALID_ATTR 0x0000000000000037ULL

#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID

Value:

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

#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000

#define SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID

Protocol GUID name defined in EFI1.1.

Typedef Documentation

typedef EFI_FILE_PROTOCOL EFI_FILE

typedef EFI_STATUS(EFIAPI * EFI_FILE_CLOSE)(IN EFI_FILE_PROTOCOL *This)

Closes a specified file handle.

Parameters

This	A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to close.

Return values

EFI_SUCCESS The file was closed.

typedef EFI_STATUS(EFIAPI * EFI_FILE_DELETE)(IN EFI_FILE_PROTOCOL *This)

Close and delete the file handle.

Parameters

This	A pointer to the EFI_FILE_PROTOCOL instance that is the handle to the file to delete.

Return values

EFI_SUCCESS	The file was closed and deleted, and the handle was closed.
EFI_WARN_DELETE_FAILURE	The handle was closed, but the file was not deleted.

typedef EFI_STATUS(EFIAPI * EFI_FILE_FLUSH)(IN EFI_FILE_PROTOCOL *This)

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

Parameters

This	A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to flush.

Return values

EFI_SUCCESS	The data was flushed.
EFI_NO_MEDIA	The device has no medium.
EFI_DEVICE_ERROR	The device reported an error.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_WRITE_PROTECTED	The file or medium is write-protected.
EFI_ACCESS_DENIED	The file was opened read-only.
EFI_VOLUME_FULL	The volume is full.

typedef EFI_STATUS(EFIAPI * EFI_FILE_GET_INFO)(IN EFI_FILE_PROTOCOL *This, IN EFI_GUID *InformationType, IN OUT UINTN *BufferSize, OUT VOID *Buffer)

Returns information about a file.

Parameters

This	A pointer to the EFI_FILE_PROTOCOL instance that is the file handle the requested information is for.
InformationType	The type identifier for the information being requested.
BufferSize	On input, the size of Buffer. On output, the amount of data returned in Buffer. In both cases, the size is measured in bytes.
Buffer	A pointer to the data buffer to return. The buffer's type is indicated by InformationType.

Return values

EFI_SUCCESS	The information was returned.
EFI_UNSUPPORTED	The InformationType is not known.
EFI_NO_MEDIA	The device has no medium.
EFI_DEVICE_ERROR	The device reported an error.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_BUFFER_TOO_SMALL	The BufferSize is too small to read the current directory entry. BufferSize has been updated with the size needed to complete the request.

typedef EFI_STATUS(EFIAPI * EFI_FILE_GET_POSITION)(IN EFI_FILE_PROTOCOL *This, OUT UINT64 *Position)

Returns a file's current position.

Parameters

This	A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to get the current position on.
Position	The address to return the file's current position value.

Return values

EFI_SUCCESS	The position was returned.
EFI_UNSUPPORTED	The request is not valid on open directories.
EFI_DEVICE_ERROR	An attempt was made to get the position from a deleted file.

typedef struct _EFI_FILE_PROTOCOL* EFI_FILE_HANDLE

typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_FILE_IO_INTERFACE

Protocol name defined in EFI1.1.

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

This	A 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.
NewHandle	A pointer to the location to return the opened handle for the new file.
FileName	The Null-terminated string of the name of the file to be opened. The file name may contain the following path modifiers: "\", ".", and "..".
OpenMode	The mode to open the file. The only valid combinations that the file may be opened with are: Read, Read/Write, or Create/Read/Write.
Attributes	Only valid for EFI_FILE_MODE_CREATE, in which case these are the attribute bits for the newly created file.

Return values

EFI_SUCCESS	The file was opened.
EFI_NOT_FOUND	The specified file could not be found on the device.
EFI_NO_MEDIA	The device has no medium.
EFI_MEDIA_CHANGED	The device has a different medium in it or the medium is no longer supported.
EFI_DEVICE_ERROR	The device reported an error.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_WRITE_PROTECTED	An attempt was made to create a file, or open a file for write when the media is write-protected.
EFI_ACCESS_DENIED	The service denied access to the file.
EFI_OUT_OF_RESOURCES	Not enough resources were available to open the file.
EFI_VOLUME_FULL	The volume is full.

typedef EFI_STATUS(EFIAPI * EFI_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.

Parameters

This	A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to the source location.
NewHandle	A pointer to the location to return the opened handle for the new file.
FileName	The Null-terminated string of the name of the file to be opened. The file name may contain the following path modifiers: "\", ".", and "..".
OpenMode	The mode to open the file. The only valid combinations that the file may be opened with are: Read, Read/Write, or Create/Read/Write.
Attributes	Only valid for EFI_FILE_MODE_CREATE, in which case these are the attribute bits for the newly created file.
Token	A pointer to the token associated with the transaction.

Return values

EFI_SUCCESS	If 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_FOUND	The specified file could not be found on the device.
EFI_NO_MEDIA	The device has no medium.
EFI_MEDIA_CHANGED	The device has a different medium in it or the medium is no longer supported.
EFI_DEVICE_ERROR	The device reported an error.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_WRITE_PROTECTED	An attempt was made to create a file, or open a file for write when the media is write-protected.
EFI_ACCESS_DENIED	The service denied access to the file.
EFI_OUT_OF_RESOURCES	Not enough resources were available to open the file.
EFI_VOLUME_FULL	The volume is full.

typedef struct _EFI_FILE_PROTOCOL EFI_FILE_PROTOCOL

typedef EFI_STATUS(EFIAPI * EFI_FILE_READ)(IN EFI_FILE_PROTOCOL *This, IN OUT UINTN *BufferSize, OUT VOID *Buffer)

Reads data from a file.

Parameters

This	A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to read data from.
BufferSize	On input, the size of the Buffer. On output, the amount of data returned in Buffer. In both cases, the size is measured in bytes.
Buffer	The buffer into which the data is read.

Return values

EFI_SUCCESS	Data was read.
EFI_NO_MEDIA	The device has no medium.
EFI_DEVICE_ERROR	The device reported an error.
EFI_DEVICE_ERROR	An attempt was made to read from a deleted file.
EFI_DEVICE_ERROR	On entry, the current file position is beyond the end of the file.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_BUFFER_TOO_SMALL	The BufferSize is too small to read the current directory entry. BufferSize has been updated with the size needed to complete the request.

typedef EFI_STATUS(EFIAPI * EFI_FILE_SET_INFO)(IN EFI_FILE_PROTOCOL *This, IN EFI_GUID *InformationType, IN UINTN BufferSize, IN VOID *Buffer)

Sets information about a file.

Parameters

File	A pointer to the EFI_FILE_PROTOCOL instance that is the file handle the information is for.
InformationType	The type identifier for the information being set.
BufferSize	The size, in bytes, of Buffer.
Buffer	A pointer to the data buffer to write. The buffer's type is indicated by InformationType.

Return values

EFI_SUCCESS	The information was set.
EFI_UNSUPPORTED	The InformationType is not known.
EFI_NO_MEDIA	The device has no medium.
EFI_DEVICE_ERROR	The device reported an error.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_WRITE_PROTECTED	InformationType is EFI_FILE_INFO_ID and the media is read-only.
EFI_WRITE_PROTECTED	InformationType is EFI_FILE_PROTOCOL_SYSTEM_INFO_ID and the media is read only.
EFI_WRITE_PROTECTED	InformationType is EFI_FILE_SYSTEM_VOLUME_LABEL_ID and the media is read-only.
EFI_ACCESS_DENIED	An attempt is made to change the name of a file to a file that is already present.
EFI_ACCESS_DENIED	An attempt is being made to change the EFI_FILE_DIRECTORY Attribute.
EFI_ACCESS_DENIED	An attempt is being made to change the size of a directory.
EFI_ACCESS_DENIED	InformationType 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_FULL	The volume is full.
EFI_BAD_BUFFER_SIZE	BufferSize is smaller than the size of the type indicated by InformationType.

typedef EFI_STATUS(EFIAPI * EFI_FILE_SET_POSITION)(IN EFI_FILE_PROTOCOL *This, IN UINT64 Position)

Sets a file's current position.

Parameters

This	A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to set the requested position on.
Position	The byte position from the start of the file to set.

Return values

EFI_SUCCESS	The position was set.
EFI_UNSUPPORTED	The seek request for nonzero is not valid on open directories.
EFI_DEVICE_ERROR	An attempt was made to set the position of a deleted file.

typedef EFI_STATUS(EFIAPI * EFI_FILE_WRITE)(IN EFI_FILE_PROTOCOL *This, IN OUT UINTN *BufferSize, IN VOID *Buffer)

Writes data to a file.

Parameters

This	A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to write data to.
BufferSize	On input, the size of the Buffer. On output, the amount of data actually written. In both cases, the size is measured in bytes.
Buffer	The buffer of data to write.

Return values

EFI_SUCCESS	Data was written.
EFI_UNSUPPORTED	Writes to open directory files are not supported.
EFI_NO_MEDIA	The device has no medium.
EFI_DEVICE_ERROR	The device reported an error.
EFI_DEVICE_ERROR	An attempt was made to write to a deleted file.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_WRITE_PROTECTED	The file or medium is write-protected.
EFI_ACCESS_DENIED	The file was opened read only.
EFI_VOLUME_FULL	The volume is full.

typedef struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL

typedef EFI_STATUS(EFIAPI * EFI_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.

Parameters

This	A pointer to the volume to open the root directory.
Root	A pointer to the location to return the opened file handle for the root directory.

Return values

EFI_SUCCESS	The device was opened.
EFI_UNSUPPORTED	This volume does not support the requested file system type.
EFI_NO_MEDIA	The device has no medium.
EFI_DEVICE_ERROR	The device reported an error.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_ACCESS_DENIED	The service denied access to the file.
EFI_OUT_OF_RESOURCES	The volume was not opened due to lack of resources.
EFI_MEDIA_CHANGED	The 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().

typedef IN OUT EFI_FILE_IO_TOKEN* Token

Function Documentation

typedef EFI_STATUS ( EFIAPI * EFI_FILE_FLUSH_EX )

Reads data from a file.

Parameters

This	A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to read data from.
Token	A pointer to the token associated with the transaction.

Return values

EFI_SUCCESS	If 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_MEDIA	The device has no medium.
EFI_DEVICE_ERROR	The device reported an error.
EFI_DEVICE_ERROR	An attempt was made to read from a deleted file.
EFI_DEVICE_ERROR	On entry, the current file position is beyond the end of the file.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_OUT_OF_RESOURCES	Unable to queue the request due to lack of resources.

Writes data to a file.

Parameters

This	A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to write data to.
Token	A pointer to the token associated with the transaction.

Return values

EFI_SUCCESS	If 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_UNSUPPORTED	Writes to open directory files are not supported.
EFI_NO_MEDIA	The device has no medium.
EFI_DEVICE_ERROR	The device reported an error.
EFI_DEVICE_ERROR	An attempt was made to write to a deleted file.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_WRITE_PROTECTED	The file or medium is write-protected.
EFI_ACCESS_DENIED	The file was opened read only.
EFI_VOLUME_FULL	The volume is full.
EFI_OUT_OF_RESOURCES	Unable to queue the request due to lack of resources.

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

Parameters

This	A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to flush.
Token	A pointer to the token associated with the transaction.

Return values

EFI_SUCCESS	If 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_MEDIA	The device has no medium.
EFI_DEVICE_ERROR	The device reported an error.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_WRITE_PROTECTED	The file or medium is write-protected.
EFI_ACCESS_DENIED	The file was opened read-only.
EFI_VOLUME_FULL	The volume is full.
EFI_OUT_OF_RESOURCES	Unable to queue the request due to lack of resources.

Variable Documentation

EFI_GUID gEfiSimpleFileSystemProtocolGuid

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation

Variable Documentation