EfiFileLib.h

Go to the documentation of this file.

 
#ifndef __EFI_FILE_LIB_H__
#define __EFI_FILE_LIB_H__
 
#include <PiDxe.h>
#include <Protocol/FirmwareVolume2.h>
#include <Protocol/FirmwareVolumeBlock.h>
#include <Protocol/BlockIo.h>
#include <Protocol/LoadFile.h>
#include <Protocol/LoadFile.h>
#include <Protocol/SimpleFileSystem.h>
#include <Guid/FileInfo.h>
#include <Guid/FileSystemInfo.h>
 
#define MAX_PATHNAME  0x200
 
typedef enum {
  EfiOpenLoadFile,
  EfiOpenMemoryBuffer,
  EfiOpenFirmwareVolume,
  EfiOpenFileSystem,
  EfiOpenBlockIo,
  EfiOpenTftp,
  EfiOpenMaxValue
} EFI_OPEN_FILE_TYPE;
 
typedef struct {
  UINTN                            Version;       // Common information
  EFI_OPEN_FILE_TYPE               Type;
  EFI_DEVICE_PATH_PROTOCOL         *DevicePath;
  EFI_STATUS                       LastError;
  EFI_HANDLE                       EfiHandle;
  CHAR8                            *DeviceName;
  CHAR8                            *FileName;
 
  UINT64                           CurrentPosition; // Information for Seek
  UINT64                           MaxPosition;
 
  UINTN                            BaseOffset;    // Base offset for hexdump command
 
  UINTN                            Size;          // Valid for all types other than l#:
  UINT8                            *Buffer;       // Information valid for A#:
 
  EFI_FIRMWARE_VOLUME2_PROTOCOL    *Fv;           // Information valid for Fv#:
  EFI_GUID                         FvNameGuid;
  EFI_SECTION_TYPE                 FvSectionType;
  EFI_FV_FILETYPE                  FvType;
  EFI_FV_FILE_ATTRIBUTES           FvAttributes;
 
  EFI_PHYSICAL_ADDRESS             FvStart;
  UINTN                            FvSize;
  UINTN                            FvHeaderSize;
 
  EFI_FILE                         *FsFileHandle; // Information valid for Fs#:
  EFI_FILE_SYSTEM_INFO             *FsInfo;
  EFI_FILE_INFO                    *FsFileInfo;
  EFI_BLOCK_IO_MEDIA               *FsBlockIoMedia; // Information valid for Fs#: or B#:
  EFI_BLOCK_IO_PROTOCOL            *FsBlockIo;      // Information valid for Fs#: or B#:
 
  UINTN                            DiskOffset;    // Information valid for B#:
 
  EFI_LOAD_FILE_PROTOCOL           *LoadFile;     // Information valid for l#:
 
  EFI_IP_ADDRESS                   ServerIp;      // Information valid for t:
  BOOLEAN                          IsDirty;
  BOOLEAN                          IsBufferValid;
} EFI_OPEN_FILE;
 
typedef enum {
  EfiSeekStart,
  EfiSeekCurrent,
  EfiSeekEnd,
  EfiSeekMax
} EFI_SEEK_TYPE;
 
EFI_OPEN_FILE *
EfiOpen (
  IN        CHAR8             *PathName,
  IN  CONST UINT64            OpenMode,
  IN  CONST EFI_SECTION_TYPE  SectionType
  );
 
EFI_STATUS
EfiCopyFile (
  IN        CHAR8  *DestinationFile,
  IN        CHAR8  *SourceFile
  );
 
EFI_OPEN_FILE  *
EfiDeviceOpenByType (
  IN  EFI_OPEN_FILE_TYPE  DeviceType,
  IN  UINTN               Index
  );
 
EFI_STATUS
EfiClose (
  IN  EFI_OPEN_FILE  *Stream
  );
 
UINTN
EfiTell (
  IN  EFI_OPEN_FILE  *Stream,
  OUT UINT64         *CurrentPosition   OPTIONAL
  );
 
EFI_STATUS
EfiSeek (
  IN  EFI_OPEN_FILE  *Stream,
  IN  EFI_LBA        Offset,
  IN  EFI_SEEK_TYPE  SeekType
  );
 
EFI_STATUS
EfiRead (
  IN  EFI_OPEN_FILE  *Stream,
  OUT VOID           *Buffer,
  OUT UINTN          *BufferSize
  );
 
EFI_STATUS
EfiReadAllocatePool (
  IN  EFI_OPEN_FILE  *Stream,
  OUT VOID           **Buffer,
  OUT UINTN          *BufferSize
  );
 
EFI_STATUS
EfiWrite (
  IN  EFI_OPEN_FILE  *Stream,
  OUT VOID           *Buffer,
  OUT UINTN          *BufferSize
  );
 
UINTN
EfiGetDeviceCounts (
  IN  EFI_OPEN_FILE_TYPE  Type
  );
 
EFI_STATUS
EfiSetCwd (
  IN  CHAR8  *Cwd
  );
 
CHAR8 *
EfiGetCwd (
  VOID
  );
 
#endif