FwVol.h

Go to the documentation of this file.

 
#ifndef _FWVOL_H_
#define _FWVOL_H_
 
#include "PeiMain.h"
 
#define GET_OCCUPIED_SIZE(ActualSize, Alignment) \
  ((ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1)))
 
#define PEI_FW_VOL_SIGNATURE  SIGNATURE_32('P','F','W','V')
 
typedef struct {
  UINTN                          Signature;
  BOOLEAN                        IsFfs3Fv;
  EFI_PEI_FIRMWARE_VOLUME_PPI    Fv;
} PEI_FW_VOL_INSTANCE;
 
#define PEI_FW_VOL_INSTANCE_FROM_FV_THIS(a) \
  CR(a, PEI_FW_VOL_INSTANCE, Fv, PEI_FW_VOL_SIGNATURE)
 
EFI_STATUS
EFIAPI
PeiFfsFvPpiProcessVolume (
  IN  CONST  EFI_PEI_FIRMWARE_VOLUME_PPI  *This,
  IN  VOID                                *Buffer,
  IN  UINTN                               BufferSize,
  OUT EFI_PEI_FV_HANDLE                   *FvHandle
  );
 
EFI_STATUS
EFIAPI
PeiFfsFvPpiFindFileByType (
  IN CONST  EFI_PEI_FIRMWARE_VOLUME_PPI  *This,
  IN        EFI_FV_FILETYPE              SearchType,
  IN        EFI_PEI_FV_HANDLE            FvHandle,
  IN OUT    EFI_PEI_FILE_HANDLE          *FileHandle
  );
 
EFI_STATUS
EFIAPI
PeiFfsFvPpiFindFileByName (
  IN  CONST  EFI_PEI_FIRMWARE_VOLUME_PPI  *This,
  IN  CONST  EFI_GUID                     *FileName,
  IN  EFI_PEI_FV_HANDLE                   *FvHandle,
  OUT EFI_PEI_FILE_HANDLE                 *FileHandle
  );
 
EFI_STATUS
EFIAPI
PeiFfsFvPpiFindSectionByType (
  IN  CONST EFI_PEI_FIRMWARE_VOLUME_PPI  *This,
  IN        EFI_SECTION_TYPE             SearchType,
  IN        EFI_PEI_FILE_HANDLE          FileHandle,
  OUT VOID                               **SectionData
  );
 
EFI_STATUS
EFIAPI
PeiFfsFvPpiFindSectionByType2 (
  IN  CONST EFI_PEI_FIRMWARE_VOLUME_PPI  *This,
  IN        EFI_SECTION_TYPE             SearchType,
  IN        UINTN                        SearchInstance,
  IN        EFI_PEI_FILE_HANDLE          FileHandle,
  OUT VOID                               **SectionData,
  OUT UINT32                             *AuthenticationStatus
  );
 
EFI_STATUS
EFIAPI
PeiFfsFvPpiGetFileInfo (
  IN  CONST EFI_PEI_FIRMWARE_VOLUME_PPI  *This,
  IN        EFI_PEI_FILE_HANDLE          FileHandle,
  OUT       EFI_FV_FILE_INFO             *FileInfo
  );
 
EFI_STATUS
EFIAPI
PeiFfsFvPpiGetFileInfo2 (
  IN  CONST EFI_PEI_FIRMWARE_VOLUME_PPI  *This,
  IN        EFI_PEI_FILE_HANDLE          FileHandle,
  OUT       EFI_FV_FILE_INFO2            *FileInfo
  );
 
EFI_STATUS
EFIAPI
PeiFfsFvPpiGetVolumeInfo (
  IN  CONST  EFI_PEI_FIRMWARE_VOLUME_PPI  *This,
  IN  EFI_PEI_FV_HANDLE                   FvHandle,
  OUT EFI_FV_INFO                         *VolumeInfo
  );
 
PEI_CORE_FV_HANDLE *
FvHandleToCoreHandle (
  IN EFI_PEI_FV_HANDLE  FvHandle
  );
 
EFI_STATUS
FindFileEx (
  IN  CONST EFI_PEI_FV_HANDLE    FvHandle,
  IN  CONST EFI_GUID             *FileName    OPTIONAL,
  IN        EFI_FV_FILETYPE      SearchType,
  IN OUT    EFI_PEI_FILE_HANDLE  *FileHandle,
  IN OUT    EFI_PEI_FILE_HANDLE  *AprioriFile  OPTIONAL
  );
 
EFI_STATUS
AddUnknownFormatFvInfo (
  IN PEI_CORE_INSTANCE                  *PrivateData,
  IN EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI  *FvInfo2Ppi
  );
 
EFI_STATUS
FindUnknownFormatFvInfo (
  IN  PEI_CORE_INSTANCE  *PrivateData,
  IN  EFI_GUID           *Format,
  OUT VOID               **FvInfo,
  OUT UINT32             *FvInfoSize,
  OUT UINT32             *AuthenticationStatus
  );
 
EFI_STATUS
EFIAPI
ThirdPartyFvPpiNotifyCallback (
  IN EFI_PEI_SERVICES           **PeiServices,
  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,
  IN VOID                       *Ppi
  );
 
#endif