4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The firmware file related definitions in PI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PI Version 1.2.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Used to verify the integrity of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The IntegrityCheck.Checksum.Header field is an 8-bit checksum of the file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// header. The State and IntegrityCheck.Checksum.File fields are assumed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to be zero and the checksum is calculated such that the entire header sums to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If the FFS_ATTRIB_CHECKSUM (see definition below) bit of the Attributes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// field is set to one, the IntegrityCheck.Checksum.File field is an 8-bit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// checksum of the file data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If the FFS_ATTRIB_CHECKSUM bit of the Attributes field is cleared to zero,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the IntegrityCheck.Checksum.File field must be initialized with a value of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// 0xAA. The IntegrityCheck.Checksum.File field is valid any time the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_FILE_DATA_VALID bit is set in the State field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This is the full 16 bits of the IntegrityCheck field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// FFS_FIXED_CHECKSUM is the checksum value used when the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// FFS_ATTRIB_CHECKSUM attribute bit is clear.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// File Types Definitions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// FFS File Attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// FFS File State Bits.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Each file begins with the header that describe the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// contents and state of the files.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This GUID is the file name. It is used to uniquely identify the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Used to verify the integrity of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Identifies the type of file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Declares various file attribute bits.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length of the file in bytes, including the FFS header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Used to track the state of the file throughout the life of the file from creation to deletion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This GUID is the file name. It is used to uniquely identify the file. There may be only
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// one instance of a file with the file name GUID of Name in any given firmware
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// volume, except if the file type is EFI_FV_FILETYPE_FFS_PAD.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Used to verify the integrity of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Identifies the type of file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Declares various file attribute bits.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length of the file in bytes, including the FFS header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length of the file data is either (Size - sizeof(EFI_FFS_FILE_HEADER)). This calculation means a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// zero-length file has a Size of 24 bytes, which is sizeof(EFI_FFS_FILE_HEADER).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Size is not required to be a multiple of 8 bytes. Given a file F, the next file header is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// located at the next 8-byte aligned firmware volume offset following the last byte of the file F.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Used to track the state of the file throughout the life of the file from creation to deletion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If FFS_ATTRIB_LARGE_FILE is set in Attributes, then ExtendedSize exists and Size must be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If FFS_ATTRIB_LARGE_FILE is not set then EFI_FFS_FILE_HEADER is used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((((EFI_FFS_FILE_HEADER *) (UINTN) FfsFileHeaderPtr)->Attributes) & FFS_ATTRIB_LARGE_FILE) == FFS_ATTRIB_LARGE_FILE)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((UINT32) (*((UINT32 *) ((EFI_FFS_FILE_HEADER *) (UINTN) FfsFileHeaderPtr)->Size) & 0x00ffffff))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((EFI_FFS_FILE_HEADER2 *) (UINTN) FfsFileHeaderPtr)->ExtendedSize)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Pseudo type. It is used as a wild card when retrieving sections.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The section type EFI_SECTION_ALL matches all section types.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Encapsulation section Type values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Leaf section Type values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Common section header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A 24-bit unsigned integer that contains the total size of the section in bytes,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// including the EFI_COMMON_SECTION_HEADER.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Declares the section type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A 24-bit unsigned integer that contains the total size of the section in bytes,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// including the EFI_COMMON_SECTION_HEADER.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If Size is 0xFFFFFF, then ExtendedSize contains the size of the section. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Size is not equal to 0xFFFFFF, then this field does not exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Leaf section type that contains an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// IA-32 16-bit executable image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// CompressionType of EFI_COMPRESSION_SECTION.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// An encapsulation section type in which the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// section data is compressed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Usual common section header. CommonHeader.Type = EFI_SECTION_COMPRESSION.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The UINT32 that indicates the size of the section data after decompression.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Indicates which compression algorithm is used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Usual common section header. CommonHeader.Type = EFI_SECTION_COMPRESSION.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UINT32 that indicates the size of the section data after decompression.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Indicates which compression algorithm is used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// An encapsulation section type in which the section data is disposable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A disposable section is an encapsulation section in which the section data may be disposed of during
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the process of creating or updating a firmware image without significant impact on the usefulness of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the file. The Type field in the section header is set to EFI_SECTION_DISPOSABLE. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// allows optional or descriptive data to be included with the firmware file which can be removed in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// order to conserve space. The contents of this section are implementation specific, but might contain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// debug data or detailed integration instructions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER EFI_DISPOSABLE_SECTION;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER2 EFI_DISPOSABLE_SECTION2;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The leaf section which could be used to determine the dispatch order of DXEs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The leaf section which contains a PI FV.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The leaf section which contains a single GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This GUID is defined by the creator of the file. It is a vendor-defined file type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This GUID is defined by the creator of the file. It is a vendor-defined file type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Attributes of EFI_GUID_DEFINED_SECTION.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The leaf section which is encapsulation defined by specific GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The GUID that defines the format of the data that follows. It is a vendor-defined section type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Contains the offset in bytes from the beginning of the common header to the first byte of the data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The bit field that declares some specific characteristics of the section contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The GUID that defines the format of the data that follows. It is a vendor-defined section type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Contains the offset in bytes from the beginning of the common header to the first byte of the data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The bit field that declares some specific characteristics of the section contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The leaf section which contains PE32+ image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The leaf section used to determine the dispatch order of PEIMs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A leaf section type that contains a position-independent-code (PIC) image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A PIC image section is a leaf section that contains a position-independent-code (PIC) image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// In addition to normal PE32+ images that contain relocation information, PEIM executables may be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// PIC and are referred to as PIC images. A PIC image is the same as a PE32+ image except that all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// relocation information has been stripped from the image and the image can be moved and will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// execute correctly without performing any relocation or other fix-ups. EFI_PIC_SECTION2 must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// be used if the section is 16MB or larger.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The leaf section which constains the position-independent-code image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The leaf section which contains an array of zero or more bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The SMM dependency expression section is a leaf section that contains a dependency expression that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// is used to determine the dispatch order for SMM drivers. Before the SMRAM invocation of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// SMM driver's entry point, this dependency expression must evaluate to TRUE. See the Platform
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Initialization Specification, Volume 2, for details regarding the format of the dependency expression.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The dependency expression may refer to protocols installed in either the UEFI or the SMM protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// database. EFI_SMM_DEPEX_SECTION2 must be used if the section is 16MB or larger.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER EFI_SMM_DEPEX_SECTION;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_COMMON_SECTION_HEADER2 EFI_SMM_DEPEX_SECTION2;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The leaf section which contains a unicode string that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// is human readable file name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of unicode string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The leaf section which contains a numeric build number and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// an optional unicode string that represents the file revision.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of unicode string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A UINT16 that represents a particular build. Subsequent builds have monotonically
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// increasing build numbers relative to earlier builds.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) (UINTN) SectionHeaderPtr)->Size) & 0x00ffffff) == 0x00ffffff)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) (UINTN) SectionHeaderPtr)->Size) & 0x00ffffff))