[mirror_edk2.git] / MdePkg / Include / Pi / PiFirmwareFile.h

/** @file\r
  The firmware file related definitions in PI.\r
\r
Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  PI Version 1.6.\r
\r
**/\r
\r
\r
#ifndef __PI_FIRMWARE_FILE_H__\r
#define __PI_FIRMWARE_FILE_H__\r
\r
#pragma pack(1)\r
///\r
/// Used to verify the integrity of the file.\r
///\r
typedef union {\r
  struct {\r
    ///\r
    /// The IntegrityCheck.Checksum.Header field is an 8-bit checksum of the file\r
    /// header. The State and IntegrityCheck.Checksum.File fields are assumed\r
    /// to be zero and the checksum is calculated such that the entire header sums to zero.\r
    ///\r
    UINT8   Header;\r
    ///\r
    /// If the FFS_ATTRIB_CHECKSUM (see definition below) bit of the Attributes\r
    /// field is set to one, the IntegrityCheck.Checksum.File field is an 8-bit\r
    /// checksum of the file data.\r
    /// If the FFS_ATTRIB_CHECKSUM bit of the Attributes field is cleared to zero,\r
    /// the IntegrityCheck.Checksum.File field must be initialized with a value of\r
    /// 0xAA. The IntegrityCheck.Checksum.File field is valid any time the\r
    /// EFI_FILE_DATA_VALID bit is set in the State field.\r
    ///\r
    UINT8   File;\r
  } Checksum;\r
  ///\r
  /// This is the full 16 bits of the IntegrityCheck field.\r
  ///\r
  UINT16    Checksum16;\r
} EFI_FFS_INTEGRITY_CHECK;\r
\r
///\r
/// FFS_FIXED_CHECKSUM is the checksum value used when the\r
/// FFS_ATTRIB_CHECKSUM attribute bit is clear.\r
///\r
#define FFS_FIXED_CHECKSUM  0xAA\r
\r
typedef UINT8 EFI_FV_FILETYPE;\r
typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;\r
typedef UINT8 EFI_FFS_FILE_STATE;\r
\r
///\r
/// File Types Definitions\r
///\r
#define EFI_FV_FILETYPE_ALL                   0x00\r
#define EFI_FV_FILETYPE_RAW                   0x01\r
#define EFI_FV_FILETYPE_FREEFORM              0x02\r
#define EFI_FV_FILETYPE_SECURITY_CORE         0x03\r
#define EFI_FV_FILETYPE_PEI_CORE              0x04\r
#define EFI_FV_FILETYPE_DXE_CORE              0x05\r
#define EFI_FV_FILETYPE_PEIM                  0x06\r
#define EFI_FV_FILETYPE_DRIVER                0x07\r
#define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER  0x08\r
#define EFI_FV_FILETYPE_APPLICATION           0x09\r
#define EFI_FV_FILETYPE_MM                    0x0A\r
#define EFI_FV_FILETYPE_SMM                   EFI_FV_FILETYPE_MM\r
#define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B\r
#define EFI_FV_FILETYPE_COMBINED_MM_DXE       0x0C\r
#define EFI_FV_FILETYPE_COMBINED_SMM_DXE      EFI_FV_FILETYPE_COMBINED_MM_DXE\r
#define EFI_FV_FILETYPE_MM_CORE               0x0D\r
#define EFI_FV_FILETYPE_SMM_CORE              EFI_FV_FILETYPE_MM_CORE\r
#define EFI_FV_FILETYPE_MM_STANDALONE         0x0E\r
#define EFI_FV_FILETYPE_MM_CORE_STANDALONE    0x0F\r
#define EFI_FV_FILETYPE_OEM_MIN               0xc0\r
#define EFI_FV_FILETYPE_OEM_MAX               0xdf\r
#define EFI_FV_FILETYPE_DEBUG_MIN             0xe0\r
#define EFI_FV_FILETYPE_DEBUG_MAX             0xef\r
#define EFI_FV_FILETYPE_FFS_MIN               0xf0\r
#define EFI_FV_FILETYPE_FFS_MAX               0xff\r
#define EFI_FV_FILETYPE_FFS_PAD               0xf0\r
///\r
/// FFS File Attributes.\r
///\r
#define FFS_ATTRIB_LARGE_FILE         0x01\r
#define FFS_ATTRIB_DATA_ALIGNMENT_2   0x02\r
#define FFS_ATTRIB_FIXED              0x04\r
#define FFS_ATTRIB_DATA_ALIGNMENT     0x38\r
#define FFS_ATTRIB_CHECKSUM           0x40\r
\r
///\r
/// FFS File State Bits.\r
///\r
#define EFI_FILE_HEADER_CONSTRUCTION  0x01\r
#define EFI_FILE_HEADER_VALID         0x02\r
#define EFI_FILE_DATA_VALID           0x04\r
#define EFI_FILE_MARKED_FOR_UPDATE    0x08\r
#define EFI_FILE_DELETED              0x10\r
#define EFI_FILE_HEADER_INVALID       0x20\r
\r
\r
///\r
/// Each file begins with the header that describe the\r
/// contents and state of the files.\r
///\r
typedef struct {\r
  ///\r
  /// This GUID is the file name. It is used to uniquely identify the file.\r
  ///\r
  EFI_GUID                Name;\r
  ///\r
  /// Used to verify the integrity of the file.\r
  ///\r
  EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r
  ///\r
  /// Identifies the type of file.\r
  ///\r
  EFI_FV_FILETYPE         Type;\r
  ///\r
  /// Declares various file attribute bits.\r
  ///\r
  EFI_FFS_FILE_ATTRIBUTES Attributes;\r
  ///\r
  /// The length of the file in bytes, including the FFS header.\r
  ///\r
  UINT8                   Size[3];\r
  ///\r
  /// Used to track the state of the file throughout the life of the file from creation to deletion.\r
  ///\r
  EFI_FFS_FILE_STATE      State;\r
} EFI_FFS_FILE_HEADER;\r
\r
typedef struct {\r
  ///\r
  /// This GUID is the file name. It is used to uniquely identify the file. There may be only\r
  /// one instance of a file with the file name GUID of Name in any given firmware\r
  /// volume, except if the file type is EFI_FV_FILETYPE_FFS_PAD.\r
  ///\r
  EFI_GUID                  Name;\r
\r
  ///\r
  /// Used to verify the integrity of the file.\r
  ///\r
  EFI_FFS_INTEGRITY_CHECK   IntegrityCheck;\r
\r
  ///\r
  /// Identifies the type of file.\r
  ///\r
  EFI_FV_FILETYPE           Type;\r
\r
  ///\r
  /// Declares various file attribute bits.\r
  ///\r
  EFI_FFS_FILE_ATTRIBUTES   Attributes;\r
\r
  ///\r
  /// The length of the file in bytes, including the FFS header.\r
  /// The length of the file data is either (Size - sizeof(EFI_FFS_FILE_HEADER)). This calculation means a\r
  /// zero-length file has a Size of 24 bytes, which is sizeof(EFI_FFS_FILE_HEADER).\r
  /// Size is not required to be a multiple of 8 bytes. Given a file F, the next file header is\r
  /// located at the next 8-byte aligned firmware volume offset following the last byte of the file F.\r
  ///\r
  UINT8                     Size[3];\r
\r
  ///\r
  /// Used to track the state of the file throughout the life of the file from creation to deletion.\r
  ///\r
  EFI_FFS_FILE_STATE        State;\r
\r
  ///\r
  /// If FFS_ATTRIB_LARGE_FILE is set in Attributes, then ExtendedSize exists and Size must be set to zero.\r
  /// If FFS_ATTRIB_LARGE_FILE is not set then EFI_FFS_FILE_HEADER is used.\r
  ///\r
  UINT64                    ExtendedSize;\r
} EFI_FFS_FILE_HEADER2;\r
\r
#define IS_FFS_FILE2(FfsFileHeaderPtr) \\r
    (((((EFI_FFS_FILE_HEADER *) (UINTN) FfsFileHeaderPtr)->Attributes) & FFS_ATTRIB_LARGE_FILE) == FFS_ATTRIB_LARGE_FILE)\r
\r
///\r
/// The argument passed as the FfsFileHeaderPtr parameter to the\r
/// FFS_FILE_SIZE() function-like macro below must not have side effects:\r
/// FfsFileHeaderPtr is evaluated multiple times.\r
///\r
#define FFS_FILE_SIZE(FfsFileHeaderPtr) ((UINT32) ( \\r
    (((EFI_FFS_FILE_HEADER *) (UINTN) (FfsFileHeaderPtr))->Size[0]      ) | \\r
    (((EFI_FFS_FILE_HEADER *) (UINTN) (FfsFileHeaderPtr))->Size[1] <<  8) | \\r
    (((EFI_FFS_FILE_HEADER *) (UINTN) (FfsFileHeaderPtr))->Size[2] << 16)))\r
\r
#define FFS_FILE2_SIZE(FfsFileHeaderPtr) \\r
    ((UINT32) (((EFI_FFS_FILE_HEADER2 *) (UINTN) FfsFileHeaderPtr)->ExtendedSize))\r
\r
typedef UINT8 EFI_SECTION_TYPE;\r
\r
///\r
/// Pseudo type. It is used as a wild card when retrieving sections.\r
///  The section type EFI_SECTION_ALL matches all section types.\r
///\r
#define EFI_SECTION_ALL                   0x00\r
\r
///\r
/// Encapsulation section Type values.\r
///\r
#define EFI_SECTION_COMPRESSION           0x01\r
\r
#define EFI_SECTION_GUID_DEFINED          0x02\r
\r
#define EFI_SECTION_DISPOSABLE            0x03\r
\r
///\r
/// Leaf section Type values.\r
///\r
#define EFI_SECTION_PE32                  0x10\r
#define EFI_SECTION_PIC                   0x11\r
#define EFI_SECTION_TE                    0x12\r
#define EFI_SECTION_DXE_DEPEX             0x13\r
#define EFI_SECTION_VERSION               0x14\r
#define EFI_SECTION_USER_INTERFACE        0x15\r
#define EFI_SECTION_COMPATIBILITY16       0x16\r
#define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17\r
#define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18\r
#define EFI_SECTION_RAW                   0x19\r
#define EFI_SECTION_PEI_DEPEX             0x1B\r
#define EFI_SECTION_MM_DEPEX              0x1C\r
#define EFI_SECTION_SMM_DEPEX             EFI_SECTION_MM_DEPEX\r
\r
///\r
/// Common section header.\r
///\r
typedef struct {\r
  ///\r
  /// A 24-bit unsigned integer that contains the total size of the section in bytes,\r
  /// including the EFI_COMMON_SECTION_HEADER.\r
  ///\r
  UINT8             Size[3];\r
  EFI_SECTION_TYPE  Type;\r
  ///\r
  /// Declares the section type.\r
  ///\r
} EFI_COMMON_SECTION_HEADER;\r
\r
typedef struct {\r
  ///\r
  /// A 24-bit unsigned integer that contains the total size of the section in bytes,\r
  /// including the EFI_COMMON_SECTION_HEADER.\r
  ///\r
  UINT8             Size[3];\r
\r
  EFI_SECTION_TYPE  Type;\r
\r
  ///\r
  /// If Size is 0xFFFFFF, then ExtendedSize contains the size of the section. If\r
  /// Size is not equal to 0xFFFFFF, then this field does not exist.\r
  ///\r
  UINT32            ExtendedSize;\r
} EFI_COMMON_SECTION_HEADER2;\r
\r
///\r
/// Leaf section type that contains an\r
/// IA-32 16-bit executable image.\r
///\r
typedef EFI_COMMON_SECTION_HEADER  EFI_COMPATIBILITY16_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2;\r
\r
///\r
/// CompressionType of EFI_COMPRESSION_SECTION.\r
///\r
#define EFI_NOT_COMPRESSED        0x00\r
#define EFI_STANDARD_COMPRESSION  0x01\r
///\r
/// An encapsulation section type in which the\r
/// section data is compressed.\r
///\r
typedef struct {\r
  ///\r
  /// Usual common section header. CommonHeader.Type = EFI_SECTION_COMPRESSION.\r
  ///\r
  EFI_COMMON_SECTION_HEADER   CommonHeader;\r
  ///\r
  /// The UINT32 that indicates the size of the section data after decompression.\r
  ///\r
  UINT32                      UncompressedLength;\r
  ///\r
  /// Indicates which compression algorithm is used.\r
  ///\r
  UINT8                       CompressionType;\r
} EFI_COMPRESSION_SECTION;\r
\r
typedef struct {\r
  ///\r
  /// Usual common section header. CommonHeader.Type = EFI_SECTION_COMPRESSION.\r
  ///\r
  EFI_COMMON_SECTION_HEADER2    CommonHeader;\r
  ///\r
  /// UINT32 that indicates the size of the section data after decompression.\r
  ///\r
  UINT32                        UncompressedLength;\r
  ///\r
  /// Indicates which compression algorithm is used.\r
  ///\r
  UINT8                         CompressionType;\r
} EFI_COMPRESSION_SECTION2;\r
\r
///\r
/// An encapsulation section type in which the section data is disposable.\r
/// A disposable section is an encapsulation section in which the section data may be disposed of during\r
/// the process of creating or updating a firmware image without significant impact on the usefulness of\r
/// the file. The Type field in the section header is set to EFI_SECTION_DISPOSABLE. This\r
/// allows optional or descriptive data to be included with the firmware file which can be removed in\r
/// order to conserve space. The contents of this section are implementation specific, but might contain\r
/// debug data or detailed integration instructions.\r
///\r
typedef EFI_COMMON_SECTION_HEADER   EFI_DISPOSABLE_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2  EFI_DISPOSABLE_SECTION2;\r
\r
///\r
/// The leaf section which could be used to determine the dispatch order of DXEs.\r
///\r
typedef EFI_COMMON_SECTION_HEADER   EFI_DXE_DEPEX_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2  EFI_DXE_DEPEX_SECTION2;\r
\r
///\r
/// The leaf section which contains a PI FV.\r
///\r
typedef EFI_COMMON_SECTION_HEADER   EFI_FIRMWARE_VOLUME_IMAGE_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2  EFI_FIRMWARE_VOLUME_IMAGE_SECTION2;\r
\r
///\r
/// The leaf section which contains a single GUID.\r
///\r
typedef struct {\r
  ///\r
  /// Common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.\r
  ///\r
  EFI_COMMON_SECTION_HEADER   CommonHeader;\r
  ///\r
  /// This GUID is defined by the creator of the file. It is a vendor-defined file type.\r
  ///\r
  EFI_GUID                    SubTypeGuid;\r
} EFI_FREEFORM_SUBTYPE_GUID_SECTION;\r
\r
typedef struct {\r
  ///\r
  /// The common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.\r
  ///\r
  EFI_COMMON_SECTION_HEADER2    CommonHeader;\r
  ///\r
  /// This GUID is defined by the creator of the file. It is a vendor-defined file type.\r
  ///\r
  EFI_GUID                      SubTypeGuid;\r
} EFI_FREEFORM_SUBTYPE_GUID_SECTION2;\r
\r
///\r
/// Attributes of EFI_GUID_DEFINED_SECTION.\r
///\r
#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED  0x01\r
#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID    0x02\r
///\r
/// The leaf section which is encapsulation defined by specific GUID.\r
///\r
typedef struct {\r
  ///\r
  /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.\r
  ///\r
  EFI_COMMON_SECTION_HEADER   CommonHeader;\r
  ///\r
  /// The GUID that defines the format of the data that follows. It is a vendor-defined section type.\r
  ///\r
  EFI_GUID                    SectionDefinitionGuid;\r
  ///\r
  /// Contains the offset in bytes from the beginning of the common header to the first byte of the data.\r
  ///\r
  UINT16                      DataOffset;\r
  ///\r
  /// The bit field that declares some specific characteristics of the section contents.\r
  ///\r
  UINT16                      Attributes;\r
} EFI_GUID_DEFINED_SECTION;\r
\r
typedef struct {\r
  ///\r
  /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.\r
  ///\r
  EFI_COMMON_SECTION_HEADER2    CommonHeader;\r
  ///\r
  /// The GUID that defines the format of the data that follows. It is a vendor-defined section type.\r
  ///\r
  EFI_GUID                      SectionDefinitionGuid;\r
  ///\r
  /// Contains the offset in bytes from the beginning of the common header to the first byte of the data.\r
  ///\r
  UINT16                        DataOffset;\r
  ///\r
  /// The bit field that declares some specific characteristics of the section contents.\r
  ///\r
  UINT16                        Attributes;\r
} EFI_GUID_DEFINED_SECTION2;\r
\r
///\r
/// The leaf section which contains PE32+ image.\r
///\r
typedef EFI_COMMON_SECTION_HEADER   EFI_PE32_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2  EFI_PE32_SECTION2;\r
\r
///\r
/// The leaf section used to determine the dispatch order of PEIMs.\r
///\r
typedef EFI_COMMON_SECTION_HEADER   EFI_PEI_DEPEX_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2  EFI_PEI_DEPEX_SECTION2;\r
\r
///\r
/// A leaf section type that contains a position-independent-code (PIC) image.\r
/// A PIC image section is a leaf section that contains a position-independent-code (PIC) image.\r
/// In addition to normal PE32+ images that contain relocation information, PEIM executables may be\r
/// PIC and are referred to as PIC images. A PIC image is the same as a PE32+ image except that all\r
/// relocation information has been stripped from the image and the image can be moved and will\r
/// execute correctly without performing any relocation or other fix-ups. EFI_PIC_SECTION2 must\r
/// be used if the section is 16MB or larger.\r
///\r
typedef EFI_COMMON_SECTION_HEADER   EFI_PIC_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2  EFI_PIC_SECTION2;\r
\r
///\r
/// The leaf section which constains the position-independent-code image.\r
///\r
typedef EFI_COMMON_SECTION_HEADER   EFI_TE_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2  EFI_TE_SECTION2;\r
\r
///\r
/// The leaf section which contains an array of zero or more bytes.\r
///\r
typedef EFI_COMMON_SECTION_HEADER   EFI_RAW_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2  EFI_RAW_SECTION2;\r
\r
///\r
/// The SMM dependency expression section is a leaf section that contains a dependency expression that\r
/// is used to determine the dispatch order for SMM drivers. Before the SMRAM invocation of the\r
/// SMM driver's entry point, this dependency expression must evaluate to TRUE. See the Platform\r
/// Initialization Specification, Volume 2, for details regarding the format of the dependency expression.\r
/// The dependency expression may refer to protocols installed in either the UEFI or the SMM protocol\r
/// database. EFI_SMM_DEPEX_SECTION2 must be used if the section is 16MB or larger.\r
///\r
typedef EFI_COMMON_SECTION_HEADER EFI_SMM_DEPEX_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_SMM_DEPEX_SECTION2;\r
\r
///\r
/// The leaf section which contains a unicode string that\r
/// is human readable file name.\r
///\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER   CommonHeader;\r
\r
  ///\r
  /// Array of unicode string.\r
  ///\r
  CHAR16                      FileNameString[1];\r
} EFI_USER_INTERFACE_SECTION;\r
\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER2    CommonHeader;\r
  CHAR16                        FileNameString[1];\r
} EFI_USER_INTERFACE_SECTION2;\r
\r
///\r
/// The leaf section which contains a numeric build number and\r
/// an optional unicode string that represents the file revision.\r
///\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER   CommonHeader;\r
  UINT16                      BuildNumber;\r
\r
  ///\r
  /// Array of unicode string.\r
  ///\r
  CHAR16                      VersionString[1];\r
} EFI_VERSION_SECTION;\r
\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER2    CommonHeader;\r
  ///\r
  /// A UINT16 that represents a particular build. Subsequent builds have monotonically\r
  /// increasing build numbers relative to earlier builds.\r
  ///\r
  UINT16                        BuildNumber;\r
  CHAR16                        VersionString[1];\r
} EFI_VERSION_SECTION2;\r
\r
///\r
/// The argument passed as the SectionHeaderPtr parameter to the SECTION_SIZE()\r
/// and IS_SECTION2() function-like macros below must not have side effects:\r
/// SectionHeaderPtr is evaluated multiple times.\r
///\r
#define SECTION_SIZE(SectionHeaderPtr) ((UINT32) ( \\r
    (((EFI_COMMON_SECTION_HEADER *) (UINTN) (SectionHeaderPtr))->Size[0]      ) | \\r
    (((EFI_COMMON_SECTION_HEADER *) (UINTN) (SectionHeaderPtr))->Size[1] <<  8) | \\r
    (((EFI_COMMON_SECTION_HEADER *) (UINTN) (SectionHeaderPtr))->Size[2] << 16)))\r
\r
#define IS_SECTION2(SectionHeaderPtr) \\r
    (SECTION_SIZE (SectionHeaderPtr) == 0x00ffffff)\r
\r
#define SECTION2_SIZE(SectionHeaderPtr) \\r
    (((EFI_COMMON_SECTION_HEADER2 *) (UINTN) SectionHeaderPtr)->ExtendedSize)\r
\r
#pragma pack()\r
\r
#endif\r
\r