/** @file\r
The firmware file related definitions in PI.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation \r
+ Copyright (c) 2006 - 2009, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution. The full text of the license may be found at \r
#ifndef __PI_FIRMWARE_FILE_H__\r
#define __PI_FIRMWARE_FILE_H__\r
\r
-#include <ProcessorBind.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 entire file The State field and the file tail are assumed to be zero\r
+ /// and the checksum is calculated such that the entire file sums to zero.\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
+ /// 0x55AA. 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
/// 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
/// 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
///\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
+ /// 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
+///\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
+\r
///\r
/// Leaf section which could be used to determine the dispatch order of DXEs.\r
/// \r
/// 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
/// Leaf section which is encapsulation defined by specific GUID\r
/// \r
typedef struct {\r
+ ///\r
+ /// Common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.\r
+ ///\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
+ ///\r
+ /// 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
+ /// Bit field that declares some specific characteristics of the section contents.\r
+ ///\r
UINT16 Attributes;\r
} EFI_GUID_DEFINED_SECTION;\r
\r
projects / mirror_edk2.git / blobdiff