2 The firmware file related definitions in PI.
4 Copyright (c) 2006 - 2007, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 Module Name: PiFirmwareFile.h
15 @par Revision Reference:
20 #ifndef __PI_FIRMWARE_FILE_H__
21 #define __PI_FIRMWARE_FILE_H__
24 // Used to verify the integrity of the file.
32 } EFI_FFS_INTEGRITY_CHECK
;
34 typedef UINT8 EFI_FV_FILETYPE
;
35 typedef UINT8 EFI_FFS_FILE_ATTRIBUTES
;
36 typedef UINT8 EFI_FFS_FILE_STATE
;
39 // FFS File Attributes.
41 #define FFS_ATTRIB_FIXED 0x04
42 #define FFS_ATTRIB_DATA_ALIGNMENT 0x38
43 #define FFS_ATTRIB_CHECKSUM 0x40
46 // FFS File State Bits.
48 #define EFI_FILE_HEADER_CONSTRUCTION 0x01
49 #define EFI_FILE_HEADER_VALID 0x02
50 #define EFI_FILE_DATA_VALID 0x04
51 #define EFI_FILE_MARKED_FOR_UPDATE 0x08
52 #define EFI_FILE_DELETED 0x10
53 #define EFI_FILE_HEADER_INVALID 0x20
57 // Each file begins with the header that describe the
58 // contents and state of the files.
62 EFI_FFS_INTEGRITY_CHECK IntegrityCheck
;
64 EFI_FFS_FILE_ATTRIBUTES Attributes
;
66 EFI_FFS_FILE_STATE State
;
67 } EFI_FFS_FILE_HEADER
;
70 typedef UINT8 EFI_SECTION_TYPE
;
74 // used as a wild card when retrieving sections. The section
75 // type EFI_SECTION_ALL matches all section types.
77 #define EFI_SECTION_ALL 0x00
80 // Encapsulation section Type values
82 #define EFI_SECTION_COMPRESSION 0x01
84 #define EFI_SECTION_GUID_DEFINED 0x02
87 // Leaf section Type values
89 #define EFI_SECTION_PE32 0x10
90 #define EFI_SECTION_PIC 0x11
91 #define EFI_SECTION_TE 0x12
92 #define EFI_SECTION_DXE_DEPEX 0x13
93 #define EFI_SECTION_VERSION 0x14
94 #define EFI_SECTION_USER_INTERFACE 0x15
95 #define EFI_SECTION_COMPATIBILITY16 0x16
96 #define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17
97 #define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18
98 #define EFI_SECTION_RAW 0x19
99 #define EFI_SECTION_PEI_DEPEX 0x1B
103 EFI_SECTION_TYPE Type
;
104 } EFI_COMMON_SECTION_HEADER
;
107 // Leaf section type that contains an
108 // IA-32 16-bit executable image.
110 typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION
;
113 // CompressionType of EFI_COMPRESSION_SECTION.
115 #define EFI_NOT_COMPRESSED 0x00
116 #define EFI_STANDARD_COMPRESSION 0x01
118 // An encapsulation section type in which the
119 // section data is compressed.
122 EFI_COMMON_SECTION_HEADER CommonHeader
;
123 UINT32 UncompressedLength
;
124 UINT8 CompressionType
;
125 } EFI_COMPRESSION_SECTION
;
128 // Leaf section which could be used to determine the dispatch order of DXEs.
130 typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION
;
133 // Leaf section witch contains a PI FV.
135 typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION
;
138 // Leaf section which contains a single GUID.
141 EFI_COMMON_SECTION_HEADER CommonHeader
;
142 EFI_GUID SubTypeGuid
;
143 } EFI_FREEFORM_SUBTYPE_GUID_SECTION
;
146 // Attributes of EFI_GUID_DEFINED_SECTION
148 #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01
149 #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02
151 // Leaf section which is encapsulation defined by specific GUID
154 EFI_COMMON_SECTION_HEADER CommonHeader
;
155 EFI_GUID SectionDefinitionGuid
;
158 } EFI_GUID_DEFINED_SECTION
;
161 // Leaf section which contains PE32+ image.
163 typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION
;
167 // Leaf section which used to determine the dispatch order of PEIMs.
169 typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION
;
172 // Leaf section which constains the position-independent-code image.
174 typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION
;
177 // Leaf section which contains an array of zero or more bytes.
179 typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION
;
182 // Leaf section which contains a unicode string that
183 // is human readable file name.
186 EFI_COMMON_SECTION_HEADER CommonHeader
;
189 // Array of unicode string.
191 CHAR16 FileNameString
[1];
192 } EFI_USER_INTERFACE_SECTION
;
196 // Leaf section which contains a numeric build number and
197 // an optional unicode string that represent the file revision.
200 EFI_COMMON_SECTION_HEADER CommonHeader
;
202 CHAR16 VersionString
[1];
203 } EFI_VERSION_SECTION
;