FvSimpleFileSystemInternal.h

Go to the documentation of this file.

 
#ifndef __FVFS_INTERNAL_H__
#define __FVFS_INTERNAL_H__
 
#include <Uefi.h>
#include <PiDxe.h>
 
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/DevicePathLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/PrintLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
 
#include <Protocol/DriverBinding.h>
#include <Protocol/FirmwareVolume2.h>
#include <Protocol/SimpleFileSystem.h>
#include <Protocol/UnicodeCollation.h>
 
#include <Guid/FileSystemInfo.h>
#include <Guid/FileInfo.h>
#include <Guid/FileSystemVolumeLabelInfo.h>
 
typedef struct _FV_FILESYSTEM_FILE       FV_FILESYSTEM_FILE;
typedef struct _FV_FILESYSTEM_FILE_INFO  FV_FILESYSTEM_FILE_INFO;
typedef struct _FV_FILESYSTEM_INSTANCE   FV_FILESYSTEM_INSTANCE;
 
//
// Struct representing an instance of the "filesystem". There will be one of
// these structs per FV.
//
struct _FV_FILESYSTEM_INSTANCE {
  UINT32                             Signature;
  LIST_ENTRY                         FileInfoHead;
  LIST_ENTRY                         FileHead;
  EFI_DRIVER_BINDING_PROTOCOL        *DriverBinding;
  EFI_FIRMWARE_VOLUME2_PROTOCOL      *FvProtocol;
  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL    SimpleFs;
  FV_FILESYSTEM_FILE                 *Root;
  CHAR16                             *VolumeLabel;
};
 
//
// Struct representing a opening file. Each opening operation on file will
// create such an instance except for the "root directory", which will only
// be created once for each FV.
//
struct _FV_FILESYSTEM_FILE {
  UINT32                     Signature;
  LIST_ENTRY                 Link;
  FV_FILESYSTEM_FILE_INFO    *DirReadNext;
  FV_FILESYSTEM_INSTANCE     *Instance;
  EFI_FILE_PROTOCOL          FileProtocol;
  FV_FILESYSTEM_FILE_INFO    *FvFileInfo;
  UINT64                     Position;
};
 
//
// Struct representing the info of a file.
//
struct _FV_FILESYSTEM_FILE_INFO {
  UINT32             Signature;
  LIST_ENTRY         Link;
  EFI_GUID           NameGuid;
  EFI_FV_FILETYPE    Type;
  EFI_FILE_INFO      FileInfo;
};
 
#define FVFS_FILE_SIGNATURE       SIGNATURE_32 ('f', 'v', 'f', 'i')
#define FVFS_FILE_INFO_SIGNATURE  SIGNATURE_32 ('f', 'v', 'i', 'n')
#define FVFS_INSTANCE_SIGNATURE   SIGNATURE_32 ('f', 'v', 'f', 's')
 
#define FVFS_INSTANCE_FROM_SIMPLE_FS_THIS(This)  CR ( \
          This,                                       \
          FV_FILESYSTEM_INSTANCE,                     \
          SimpleFs,                                   \
          FVFS_INSTANCE_SIGNATURE                     \
          )
 
#define FVFS_FILE_FROM_FILE_THIS(This)  CR (          \
          This,                                       \
          FV_FILESYSTEM_FILE,                         \
          FileProtocol,                               \
          FVFS_FILE_SIGNATURE                         \
          )
 
#define FVFS_FILE_INFO_FROM_LINK(This)  CR (          \
          This,                                       \
          FV_FILESYSTEM_FILE_INFO,                    \
          Link,                                       \
          FVFS_FILE_INFO_SIGNATURE                    \
          )
 
#define FVFS_FILE_FROM_LINK(FileLink)  CR (FileLink, FV_FILESYSTEM_FILE, Link, FVFS_FILE_SIGNATURE)
 
#define FVFS_GET_FIRST_FILE(Instance)  FVFS_FILE_FROM_LINK (GetFirstNode (&Instance->FileHead))
 
#define FVFS_GET_FIRST_FILE_INFO(Instance)  FVFS_FILE_INFO_FROM_LINK (GetFirstNode (&Instance->FileInfoHead))
 
#define FV_FILETYPE_IS_EXECUTABLE(Type)  ((Type) == EFI_FV_FILETYPE_PEIM                  ||\
                                         (Type) == EFI_FV_FILETYPE_DRIVER                || \
                                         (Type) == EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER  || \
                                         (Type) == EFI_FV_FILETYPE_APPLICATION)
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemOpenVolume (
  IN     EFI_SIMPLE_FILE_SYSTEM_PROTOCOL  *This,
  OUT EFI_FILE_PROTOCOL                   **RootFile
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemDriverSupported (
  IN  EFI_DRIVER_BINDING_PROTOCOL  *DriverBinding,
  IN  EFI_HANDLE                   ControllerHandle,
  IN  EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemDriverStart (
  IN  EFI_DRIVER_BINDING_PROTOCOL  *DriverBinding,
  IN  EFI_HANDLE                   ControllerHandle,
  IN  EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemDriverStop (
  IN  EFI_DRIVER_BINDING_PROTOCOL  *DriverBinding,
  IN  EFI_HANDLE                   ControllerHandle,
  IN  UINTN                        NumberOfChildren,
  IN  EFI_HANDLE                   *ChildHandleBuffer OPTIONAL
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemOpen (
  IN     EFI_FILE_PROTOCOL  *This,
  OUT EFI_FILE_PROTOCOL     **NewHandle,
  IN     CHAR16             *FileName,
  IN     UINT64             OpenMode,
  IN     UINT64             Attributes
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemClose (
  IN EFI_FILE_PROTOCOL  *This
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemRead (
  IN     EFI_FILE_PROTOCOL  *This,
  IN OUT UINTN              *BufferSize,
  OUT VOID                  *Buffer
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemWrite (
  IN     EFI_FILE_PROTOCOL  *This,
  IN OUT UINTN              *BufferSize,
  IN     VOID               *Buffer
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemGetPosition (
  IN     EFI_FILE_PROTOCOL  *This,
  OUT UINT64                *Position
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemSetPosition (
  IN EFI_FILE_PROTOCOL  *This,
  IN UINT64             Position
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemFlush (
  IN EFI_FILE_PROTOCOL  *This
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemDelete (
  IN EFI_FILE_PROTOCOL  *This
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemGetInfo (
  IN     EFI_FILE_PROTOCOL  *This,
  IN     EFI_GUID           *InformationType,
  IN OUT UINTN              *BufferSize,
  OUT VOID                  *Buffer
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemSetInfo (
  IN EFI_FILE_PROTOCOL  *This,
  IN EFI_GUID           *InformationType,
  IN UINTN              BufferSize,
  IN VOID               *Buffer
  );
 
EFI_STATUS
FvFsGetFileSize (
  IN     EFI_FIRMWARE_VOLUME2_PROTOCOL  *FvProtocol,
  IN OUT FV_FILESYSTEM_FILE_INFO        *FvFileInfo
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **DriverName
  );
 
EFI_STATUS
EFIAPI
FvSimpleFileSystemComponentNameGetControllerName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  EFI_HANDLE                   ControllerHandle,
  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **ControllerName
  );
 
extern EFI_UNICODE_COLLATION_PROTOCOL  *mUnicodeCollation;
extern EFI_FILE_PROTOCOL               mFileSystemTemplate;
extern EFI_COMPONENT_NAME_PROTOCOL     gFvSimpleFileSystemComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL    gFvSimpleFileSystemComponentName2;
 
#endif