BaseTools/Source/C/Include/Common/PiFirmwareFile.h

   1 /** @file
   2   The firmware file related definitions in PI.
   3
   4   Copyright (c) 2006 - 2008, Intel Corporation  All rights reserved.
   5
   6   This program and the accompanying materials are licensed and made available
   7   under the terms and conditions of the BSD License which accompanies this
   8   distribution.  The full text of the license may be found at:
   9     http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14   File Name: PiFirmwareFile.h
  15
  16   @par Revision Reference:
  17   Version 1.0.
  18
  19 **/
  20
  21 #ifndef __PI_FIRMWARE_FILE_H__
  22 #define __PI_FIRMWARE_FILE_H__
  23
  24 #pragma pack(1)
  25 //
  26 // Used to verify the integrity of the file.
  27 //
  28 typedef union {
  29   struct {
  30     UINT8   Header;
  31     UINT8   File;
  32   } Checksum;
  33   UINT16    Checksum16;
  34 } EFI_FFS_INTEGRITY_CHECK;
  35
  36 typedef UINT8 EFI_FV_FILETYPE;
  37 typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;
  38 typedef UINT8 EFI_FFS_FILE_STATE;
  39
  40 //
  41 // File Types Definitions
  42 //
  43 #define EFI_FV_FILETYPE_ALL                   0x00
  44 #define EFI_FV_FILETYPE_RAW                   0x01
  45 #define EFI_FV_FILETYPE_FREEFORM              0x02
  46 #define EFI_FV_FILETYPE_SECURITY_CORE         0x03
  47 #define EFI_FV_FILETYPE_PEI_CORE              0x04
  48 #define EFI_FV_FILETYPE_DXE_CORE              0x05
  49 #define EFI_FV_FILETYPE_PEIM                  0x06
  50 #define EFI_FV_FILETYPE_DRIVER                0x07
  51 #define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER  0x08
  52 #define EFI_FV_FILETYPE_APPLICATION           0x09
  53 #define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B
  54 #define EFI_FV_FILETYPE_OEM_MIN               0xc0
  55 #define EFI_FV_FILETYPE_OEM_MAX               0xdf
  56 #define EFI_FV_FILETYPE_DEBUG_MIN             0xe0
  57 #define EFI_FV_FILETYPE_DEBUG_MAX             0xef
  58 #define EFI_FV_FILETYPE_FFS_MIN               0xf0
  59 #define EFI_FV_FILETYPE_FFS_MAX               0xff
  60 #define EFI_FV_FILETYPE_FFS_PAD               0xf0
  61 //
  62 // FFS File Attributes.
  63 //
  64 #define FFS_ATTRIB_FIXED              0x04
  65 #define FFS_ATTRIB_DATA_ALIGNMENT     0x38
  66 #define FFS_ATTRIB_CHECKSUM           0x40
  67 //
  68 // FFS_FIXED_CHECKSUM is the default checksum value used when the
  69 // FFS_ATTRIB_CHECKSUM attribute bit is clear
  70 // note this is NOT an architecturally defined value, but is in this file for
  71 // implementation convenience
  72 //
  73 #define FFS_FIXED_CHECKSUM  0x5A
  74
  75 //
  76 // FFS File State Bits.
  77 //
  78 #define EFI_FILE_HEADER_CONSTRUCTION  0x01
  79 #define EFI_FILE_HEADER_VALID         0x02
  80 #define EFI_FILE_DATA_VALID           0x04
  81 #define EFI_FILE_MARKED_FOR_UPDATE    0x08
  82 #define EFI_FILE_DELETED              0x10
  83 #define EFI_FILE_HEADER_INVALID       0x20
  84
  85 #define EFI_FILE_ALL_STATE_BITS       (EFI_FILE_HEADER_CONSTRUCTION | \
  86                                  EFI_FILE_HEADER_VALID | \
  87                                  EFI_FILE_DATA_VALID | \
  88                                  EFI_FILE_MARKED_FOR_UPDATE | \
  89                                  EFI_FILE_DELETED | \
  90                                  EFI_FILE_HEADER_INVALID \
  91                                   )
  92
  93 //
  94 // Each file begins with the header that describe the
  95 // contents and state of the files.
  96 //
  97 typedef struct {
  98   EFI_GUID                Name;
  99   EFI_FFS_INTEGRITY_CHECK IntegrityCheck;
 100   EFI_FV_FILETYPE         Type;
 101   EFI_FFS_FILE_ATTRIBUTES Attributes;
 102   UINT8                   Size[3];
 103   EFI_FFS_FILE_STATE      State;
 104 } EFI_FFS_FILE_HEADER;
 105
 106
 107 typedef UINT8 EFI_SECTION_TYPE;
 108
 109 //
 110 // Pseudo type. It is
 111 // used as a wild card when retrieving sections. The section
 112 // type EFI_SECTION_ALL matches all section types.
 113 //
 114 #define EFI_SECTION_ALL                   0x00
 115
 116 //
 117 // Encapsulation section Type values
 118 //
 119 #define EFI_SECTION_COMPRESSION           0x01
 120
 121 #define EFI_SECTION_GUID_DEFINED          0x02
 122
 123 //
 124 // Leaf section Type values
 125 //
 126 #define EFI_SECTION_PE32                  0x10
 127 #define EFI_SECTION_PIC                   0x11
 128 #define EFI_SECTION_TE                    0x12
 129 #define EFI_SECTION_DXE_DEPEX             0x13
 130 #define EFI_SECTION_VERSION               0x14
 131 #define EFI_SECTION_USER_INTERFACE        0x15
 132 #define EFI_SECTION_COMPATIBILITY16       0x16
 133 #define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17
 134 #define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18
 135 #define EFI_SECTION_RAW                   0x19
 136 #define EFI_SECTION_PEI_DEPEX             0x1B
 137 #define EFI_SECTION_SMM_DEPEX             0x1C
 138
 139 typedef struct {
 140   UINT8             Size[3];
 141   EFI_SECTION_TYPE  Type;
 142 } EFI_COMMON_SECTION_HEADER;
 143
 144 //
 145 // Leaf section type that contains an
 146 // IA-32 16-bit executable image.
 147 //
 148 typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;
 149
 150 //
 151 // CompressionType of EFI_COMPRESSION_SECTION.
 152 //
 153 #define EFI_NOT_COMPRESSED        0x00
 154 #define EFI_STANDARD_COMPRESSION  0x01
 155 //
 156 // An encapsulation section type in which the
 157 // section data is compressed.
 158 //
 159 typedef struct {
 160   EFI_COMMON_SECTION_HEADER   CommonHeader;
 161   UINT32                      UncompressedLength;
 162   UINT8                       CompressionType;
 163 } EFI_COMPRESSION_SECTION;
 164
 165 //
 166 // Leaf section which could be used to determine the dispatch order of DXEs.
 167 //
 168 typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;
 169
 170 //
 171 // Leaf section witch contains a PI FV.
 172 //
 173 typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;
 174
 175 //
 176 // Leaf section which contains a single GUID.
 177 //
 178 typedef struct {
 179   EFI_COMMON_SECTION_HEADER   CommonHeader;
 180   EFI_GUID                    SubTypeGuid;
 181 } EFI_FREEFORM_SUBTYPE_GUID_SECTION;
 182
 183 //
 184 // Attributes of EFI_GUID_DEFINED_SECTION
 185 //
 186 #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED  0x01
 187 #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID    0x02
 188 //
 189 // Leaf section which is encapsulation defined by specific GUID
 190 //
 191 typedef struct {
 192   EFI_COMMON_SECTION_HEADER   CommonHeader;
 193   EFI_GUID                    SectionDefinitionGuid;
 194   UINT16                      DataOffset;
 195   UINT16                      Attributes;
 196 } EFI_GUID_DEFINED_SECTION;
 197
 198 //
 199 // Leaf section which contains PE32+ image.
 200 //
 201 typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;
 202
 203 //
 204 // Leaf section which contains PIC image.
 205 //
 206 typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION;
 207
 208 //
 209 // Leaf section which used to determine the dispatch order of PEIMs.
 210 //
 211 typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;
 212
 213 //
 214 // Leaf section which constains the position-independent-code image.
 215 //
 216 typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;
 217
 218 //
 219 // Leaf section which contains an array of zero or more bytes.
 220 //
 221 typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;
 222
 223 //
 224 // Leaf section which contains a unicode string that
 225 // is human readable file name.
 226 //
 227 typedef struct {
 228   EFI_COMMON_SECTION_HEADER   CommonHeader;
 229
 230   //
 231   // Array of unicode string.
 232   //
 233   CHAR16                      FileNameString[1];
 234 } EFI_USER_INTERFACE_SECTION;
 235
 236
 237 //
 238 // Leaf section which contains a numeric build number and
 239 // an optional unicode string that represent the file revision.
 240 //
 241 typedef struct {
 242   EFI_COMMON_SECTION_HEADER   CommonHeader;
 243   UINT16                      BuildNumber;
 244   CHAR16                      VersionString[1];
 245 } EFI_VERSION_SECTION;
 246
 247
 248 #define SECTION_SIZE(SectionHeaderPtr) \
 249     ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))
 250
 251 #pragma pack()
 252
 253 typedef union {
 254   EFI_COMMON_SECTION_HEADER         *CommonHeader;
 255   EFI_COMPRESSION_SECTION           *CompressionSection;
 256   EFI_GUID_DEFINED_SECTION          *GuidDefinedSection;
 257   EFI_PE32_SECTION                  *Pe32Section;
 258   EFI_PIC_SECTION                   *PicSection;
 259   EFI_TE_SECTION                    *TeSection;
 260   EFI_PEI_DEPEX_SECTION             *PeimHeaderSection;
 261   EFI_DXE_DEPEX_SECTION             *DependencySection;
 262   EFI_VERSION_SECTION               *VersionSection;
 263   EFI_USER_INTERFACE_SECTION        *UISection;
 264   EFI_COMPATIBILITY16_SECTION       *Code16Section;
 265   EFI_FIRMWARE_VOLUME_IMAGE_SECTION *FVImageSection;
 266   EFI_FREEFORM_SUBTYPE_GUID_SECTION *FreeformSubtypeSection;
 267   EFI_RAW_SECTION                   *RawSection;
 268 } EFI_FILE_SECTION_POINTER;
 269
 270 #endif
 271