iPXE
Data Fields
EFI_FFS_FILE_HEADER2 Struct Reference

#include <PiFirmwareFile.h>

Data Fields

EFI_GUID Name
 This GUID is the file name. More...
 
EFI_FFS_INTEGRITY_CHECK IntegrityCheck
 Used to verify the integrity of the file. More...
 
EFI_FV_FILETYPE Type
 Identifies the type of file. More...
 
EFI_FFS_FILE_ATTRIBUTES Attributes
 Declares various file attribute bits. More...
 
UINT8 Size [3]
 The length of the file in bytes, including the FFS header. More...
 
EFI_FFS_FILE_STATE State
 Used to track the state of the file throughout the life of the file from creation to deletion. More...
 
UINT64 ExtendedSize
 If FFS_ATTRIB_LARGE_FILE is set in Attributes, then ExtendedSize exists and Size must be set to zero. More...
 

Detailed Description

Definition at line 137 of file PiFirmwareFile.h.

Field Documentation

◆ Name

EFI_GUID EFI_FFS_FILE_HEADER2::Name

This GUID is the file name.

It is used to uniquely identify the file. There may be only one instance of a file with the file name GUID of Name in any given firmware volume, except if the file type is EFI_FV_FILETYPE_FFS_PAD.

Definition at line 143 of file PiFirmwareFile.h.

◆ IntegrityCheck

EFI_FFS_INTEGRITY_CHECK EFI_FFS_FILE_HEADER2::IntegrityCheck

Used to verify the integrity of the file.

Definition at line 148 of file PiFirmwareFile.h.

◆ Type

EFI_FV_FILETYPE EFI_FFS_FILE_HEADER2::Type

Identifies the type of file.

Definition at line 153 of file PiFirmwareFile.h.

◆ Attributes

EFI_FFS_FILE_ATTRIBUTES EFI_FFS_FILE_HEADER2::Attributes

Declares various file attribute bits.

Definition at line 158 of file PiFirmwareFile.h.

◆ Size

UINT8 EFI_FFS_FILE_HEADER2::Size[3]

The length of the file in bytes, including the FFS header.

The length of the file data is either (Size - sizeof(EFI_FFS_FILE_HEADER)). This calculation means a zero-length file has a Size of 24 bytes, which is sizeof(EFI_FFS_FILE_HEADER). Size is not required to be a multiple of 8 bytes. Given a file F, the next file header is located at the next 8-byte aligned firmware volume offset following the last byte of the file F.

Definition at line 167 of file PiFirmwareFile.h.

◆ State

EFI_FFS_FILE_STATE EFI_FFS_FILE_HEADER2::State

Used to track the state of the file throughout the life of the file from creation to deletion.

Definition at line 172 of file PiFirmwareFile.h.

◆ ExtendedSize

UINT64 EFI_FFS_FILE_HEADER2::ExtendedSize

If FFS_ATTRIB_LARGE_FILE is set in Attributes, then ExtendedSize exists and Size must be set to zero.

If FFS_ATTRIB_LARGE_FILE is not set then EFI_FFS_FILE_HEADER is used.

Definition at line 178 of file PiFirmwareFile.h.


The documentation for this struct was generated from the following file: