/** @file | |
The firmware file related definitions in PI. | |
Copyright (c) 2006 - 2009, Intel Corporation | |
All rights reserved. This program and the accompanying materials | |
are licensed and made available under the terms and conditions of the BSD License | |
which accompanies this distribution. The full text of the license may be found at | |
http://opensource.org/licenses/bsd-license.php | |
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, | |
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. | |
@par Revision Reference: | |
PI Version 1.0 | |
**/ | |
#ifndef __PI_FIRMWARE_FILE_H__ | |
#define __PI_FIRMWARE_FILE_H__ | |
#pragma pack(1) | |
/// | |
/// Used to verify the integrity of the file. | |
/// | |
typedef union { | |
struct { | |
/// | |
/// The IntegrityCheck.Checksum.Header field is an 8-bit checksum of the file | |
/// header. The State and IntegrityCheck.Checksum.File fields are assumed | |
/// to be zero and the checksum is calculated such that the entire header sums to zero. | |
/// | |
UINT8 Header; | |
/// | |
/// If the FFS_ATTRIB_CHECKSUM (see definition below) bit of the Attributes | |
/// field is set to one, the IntegrityCheck.Checksum.File field is an 8-bit | |
/// checksum of the entire file The State field and the file tail are assumed to be zero | |
/// and the checksum is calculated such that the entire file sums to zero. | |
/// If the FFS_ATTRIB_CHECKSUM bit of the Attributes field is cleared to zero, | |
/// the IntegrityCheck.Checksum.File field must be initialized with a value of | |
/// 0x55AA. The IntegrityCheck.Checksum.File field is valid any time the | |
/// EFI_FILE_DATA_VALID bit is set in the State field. | |
/// | |
UINT8 File; | |
} Checksum; | |
/// | |
/// This is the full 16 bits of the IntegrityCheck field. | |
/// | |
UINT16 Checksum16; | |
} EFI_FFS_INTEGRITY_CHECK; | |
typedef UINT8 EFI_FV_FILETYPE; | |
typedef UINT8 EFI_FFS_FILE_ATTRIBUTES; | |
typedef UINT8 EFI_FFS_FILE_STATE; | |
/// | |
/// File Types Definitions | |
/// | |
#define EFI_FV_FILETYPE_ALL 0x00 | |
#define EFI_FV_FILETYPE_RAW 0x01 | |
#define EFI_FV_FILETYPE_FREEFORM 0x02 | |
#define EFI_FV_FILETYPE_SECURITY_CORE 0x03 | |
#define EFI_FV_FILETYPE_PEI_CORE 0x04 | |
#define EFI_FV_FILETYPE_DXE_CORE 0x05 | |
#define EFI_FV_FILETYPE_PEIM 0x06 | |
#define EFI_FV_FILETYPE_DRIVER 0x07 | |
#define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER 0x08 | |
#define EFI_FV_FILETYPE_APPLICATION 0x09 | |
#define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B | |
#define EFI_FV_FILETYPE_OEM_MIN 0xc0 | |
#define EFI_FV_FILETYPE_OEM_MAX 0xdf | |
#define EFI_FV_FILETYPE_DEBUG_MIN 0xe0 | |
#define EFI_FV_FILETYPE_DEBUG_MAX 0xef | |
#define EFI_FV_FILETYPE_FFS_MIN 0xf0 | |
#define EFI_FV_FILETYPE_FFS_MAX 0xff | |
#define EFI_FV_FILETYPE_FFS_PAD 0xf0 | |
/// | |
/// FFS File Attributes. | |
/// | |
#define FFS_ATTRIB_FIXED 0x04 | |
#define FFS_ATTRIB_DATA_ALIGNMENT 0x38 | |
#define FFS_ATTRIB_CHECKSUM 0x40 | |
/// | |
/// FFS File State Bits. | |
/// | |
#define EFI_FILE_HEADER_CONSTRUCTION 0x01 | |
#define EFI_FILE_HEADER_VALID 0x02 | |
#define EFI_FILE_DATA_VALID 0x04 | |
#define EFI_FILE_MARKED_FOR_UPDATE 0x08 | |
#define EFI_FILE_DELETED 0x10 | |
#define EFI_FILE_HEADER_INVALID 0x20 | |
/// | |
/// Each file begins with the header that describe the | |
/// contents and state of the files. | |
/// | |
typedef struct { | |
/// | |
/// This GUID is the file name. It is used to uniquely identify the file. | |
/// | |
EFI_GUID Name; | |
/// | |
/// Used to verify the integrity of the file. | |
/// | |
EFI_FFS_INTEGRITY_CHECK IntegrityCheck; | |
/// | |
/// Identifies the type of file. | |
/// | |
EFI_FV_FILETYPE Type; | |
/// | |
/// Declares various file attribute bits. | |
/// | |
EFI_FFS_FILE_ATTRIBUTES Attributes; | |
/// | |
/// The length of the file in bytes, including the FFS header. | |
/// | |
UINT8 Size[3]; | |
/// | |
/// Used to track the state of the file throughout the life of the file from creation to deletion. | |
/// | |
EFI_FFS_FILE_STATE State; | |
} EFI_FFS_FILE_HEADER; | |
typedef UINT8 EFI_SECTION_TYPE; | |
/// | |
/// Pseudo type. It is | |
/// used as a wild card when retrieving sections. The section | |
/// type EFI_SECTION_ALL matches all section types. | |
/// | |
#define EFI_SECTION_ALL 0x00 | |
/// | |
/// Encapsulation section Type values | |
/// | |
#define EFI_SECTION_COMPRESSION 0x01 | |
#define EFI_SECTION_GUID_DEFINED 0x02 | |
/// | |
/// Leaf section Type values | |
/// | |
#define EFI_SECTION_PE32 0x10 | |
#define EFI_SECTION_PIC 0x11 | |
#define EFI_SECTION_TE 0x12 | |
#define EFI_SECTION_DXE_DEPEX 0x13 | |
#define EFI_SECTION_VERSION 0x14 | |
#define EFI_SECTION_USER_INTERFACE 0x15 | |
#define EFI_SECTION_COMPATIBILITY16 0x16 | |
#define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17 | |
#define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18 | |
#define EFI_SECTION_RAW 0x19 | |
#define EFI_SECTION_PEI_DEPEX 0x1B | |
/// | |
/// Common section header | |
/// | |
typedef struct { | |
/// | |
/// A 24-bit unsigned integer that contains the total size of the section in bytes, | |
/// including the EFI_COMMON_SECTION_HEADER. | |
/// | |
UINT8 Size[3]; | |
EFI_SECTION_TYPE Type; | |
/// | |
/// Declares the section type. | |
/// | |
} EFI_COMMON_SECTION_HEADER; | |
/// | |
/// Leaf section type that contains an | |
/// IA-32 16-bit executable image. | |
/// | |
typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION; | |
/// | |
/// CompressionType of EFI_COMPRESSION_SECTION. | |
/// | |
#define EFI_NOT_COMPRESSED 0x00 | |
#define EFI_STANDARD_COMPRESSION 0x01 | |
/// | |
/// An encapsulation section type in which the | |
/// section data is compressed. | |
/// | |
typedef struct { | |
/// | |
/// Usual common section header. CommonHeader.Type = EFI_SECTION_COMPRESSION. | |
/// | |
EFI_COMMON_SECTION_HEADER CommonHeader; | |
/// | |
/// UINT32 that indicates the size of the section data after decompression. | |
/// | |
UINT32 UncompressedLength; | |
/// | |
/// Indicates which compression algorithm is used. | |
/// | |
UINT8 CompressionType; | |
} EFI_COMPRESSION_SECTION; | |
/// | |
/// Leaf section which could be used to determine the dispatch order of DXEs. | |
/// | |
typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION; | |
/// | |
/// Leaf section which contains a PI FV. | |
/// | |
typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION; | |
/// | |
/// Leaf section which contains a single GUID. | |
/// | |
typedef struct { | |
/// | |
/// Common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID. | |
/// | |
EFI_COMMON_SECTION_HEADER CommonHeader; | |
/// | |
/// This GUID is defined by the creator of the file. It is a vendor-defined file type. | |
/// | |
EFI_GUID SubTypeGuid; | |
} EFI_FREEFORM_SUBTYPE_GUID_SECTION; | |
/// | |
/// Attributes of EFI_GUID_DEFINED_SECTION | |
/// | |
#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01 | |
#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02 | |
/// | |
/// Leaf section which is encapsulation defined by specific GUID | |
/// | |
typedef struct { | |
/// | |
/// Common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED. | |
/// | |
EFI_COMMON_SECTION_HEADER CommonHeader; | |
/// | |
/// GUID that defines the format of the data that follows. It is a vendor-defined section type. | |
/// | |
EFI_GUID SectionDefinitionGuid; | |
/// | |
/// Contains the offset in bytes from the beginning of the common header to the first byte of the data. | |
/// | |
UINT16 DataOffset; | |
/// | |
/// Bit field that declares some specific characteristics of the section contents. | |
/// | |
UINT16 Attributes; | |
} EFI_GUID_DEFINED_SECTION; | |
/// | |
/// Leaf section which contains PE32+ image. | |
/// | |
typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION; | |
/// | |
/// Leaf section which used to determine the dispatch order of PEIMs. | |
/// | |
typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION; | |
/// | |
/// Leaf section which constains the position-independent-code image. | |
/// | |
typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION; | |
/// | |
/// Leaf section which contains an array of zero or more bytes. | |
/// | |
typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION; | |
/// | |
/// Leaf section which contains a unicode string that | |
/// is human readable file name. | |
/// | |
typedef struct { | |
EFI_COMMON_SECTION_HEADER CommonHeader; | |
/// | |
/// Array of unicode string. | |
/// | |
CHAR16 FileNameString[1]; | |
} EFI_USER_INTERFACE_SECTION; | |
/// | |
/// Leaf section which contains a numeric build number and | |
/// an optional unicode string that represents the file revision. | |
/// | |
typedef struct { | |
EFI_COMMON_SECTION_HEADER CommonHeader; | |
UINT16 BuildNumber; | |
/// | |
/// Array of unicode string. | |
/// | |
CHAR16 VersionString[1]; | |
} EFI_VERSION_SECTION; | |
#define SECTION_SIZE(SectionHeaderPtr) \ | |
((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff)) | |
#pragma pack() | |
#endif | |