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.<BR>
   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_SMM                   0x0A
  54 #define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B
  55 #define EFI_FV_FILETYPE_COMBINED_SMM_DXE      0x0C
  56 #define EFI_FV_FILETYPE_SMM_CORE              0x0D
  57 #define EFI_FV_FILETYPE_OEM_MIN               0xc0
  58 #define EFI_FV_FILETYPE_OEM_MAX               0xdf
  59 #define EFI_FV_FILETYPE_DEBUG_MIN             0xe0
  60 #define EFI_FV_FILETYPE_DEBUG_MAX             0xef
  61 #define EFI_FV_FILETYPE_FFS_MIN               0xf0
  62 #define EFI_FV_FILETYPE_FFS_MAX               0xff
  63 #define EFI_FV_FILETYPE_FFS_PAD               0xf0
  64 //
  65 // FFS File Attributes.
  66 //
  67 #define FFS_ATTRIB_FIXED              0x04
  68 #define FFS_ATTRIB_DATA_ALIGNMENT     0x38
  69 #define FFS_ATTRIB_CHECKSUM           0x40
  70 //
  71 // FFS_FIXED_CHECKSUM is the checksum value used when the
  72 // FFS_ATTRIB_CHECKSUM attribute bit is clear
  73 //
  74 #define FFS_FIXED_CHECKSUM  0xAA
  75
  76 //
  77 // FFS File State Bits.
  78 //
  79 #define EFI_FILE_HEADER_CONSTRUCTION  0x01
  80 #define EFI_FILE_HEADER_VALID         0x02
  81 #define EFI_FILE_DATA_VALID           0x04
  82 #define EFI_FILE_MARKED_FOR_UPDATE    0x08
  83 #define EFI_FILE_DELETED              0x10
  84 #define EFI_FILE_HEADER_INVALID       0x20
  85
  86 #define EFI_FILE_ALL_STATE_BITS       (EFI_FILE_HEADER_CONSTRUCTION | \
  87                                  EFI_FILE_HEADER_VALID | \
  88                                  EFI_FILE_DATA_VALID | \
  89                                  EFI_FILE_MARKED_FOR_UPDATE | \
  90                                  EFI_FILE_DELETED | \
  91                                  EFI_FILE_HEADER_INVALID \
  92                                   )
  93
  94 //
  95 // Each file begins with the header that describe the
  96 // contents and state of the files.
  97 //
  98 typedef struct {
  99   EFI_GUID                Name;
 100   EFI_FFS_INTEGRITY_CHECK IntegrityCheck;
 101   EFI_FV_FILETYPE         Type;
 102   EFI_FFS_FILE_ATTRIBUTES Attributes;
 103   UINT8                   Size[3];
 104   EFI_FFS_FILE_STATE      State;
 105 } EFI_FFS_FILE_HEADER;
 106
 107
 108 typedef UINT8 EFI_SECTION_TYPE;
 109
 110 //
 111 // Pseudo type. It is
 112 // used as a wild card when retrieving sections. The section
 113 // type EFI_SECTION_ALL matches all section types.
 114 //
 115 #define EFI_SECTION_ALL                   0x00
 116
 117 //
 118 // Encapsulation section Type values
 119 //
 120 #define EFI_SECTION_COMPRESSION           0x01
 121
 122 #define EFI_SECTION_GUID_DEFINED          0x02
 123
 124 //
 125 // Leaf section Type values
 126 //
 127 #define EFI_SECTION_PE32                  0x10
 128 #define EFI_SECTION_PIC                   0x11
 129 #define EFI_SECTION_TE                    0x12
 130 #define EFI_SECTION_DXE_DEPEX             0x13
 131 #define EFI_SECTION_VERSION               0x14
 132 #define EFI_SECTION_USER_INTERFACE        0x15
 133 #define EFI_SECTION_COMPATIBILITY16       0x16
 134 #define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17
 135 #define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18
 136 #define EFI_SECTION_RAW                   0x19
 137 #define EFI_SECTION_PEI_DEPEX             0x1B
 138 #define EFI_SECTION_SMM_DEPEX             0x1C
 139
 140 typedef struct {
 141   UINT8             Size[3];
 142   EFI_SECTION_TYPE  Type;
 143 } EFI_COMMON_SECTION_HEADER;
 144
 145 //
 146 // Leaf section type that contains an
 147 // IA-32 16-bit executable image.
 148 //
 149 typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;
 150
 151 //
 152 // CompressionType of EFI_COMPRESSION_SECTION.
 153 //
 154 #define EFI_NOT_COMPRESSED        0x00
 155 #define EFI_STANDARD_COMPRESSION  0x01
 156 //
 157 // An encapsulation section type in which the
 158 // section data is compressed.
 159 //
 160 typedef struct {
 161   EFI_COMMON_SECTION_HEADER   CommonHeader;
 162   UINT32                      UncompressedLength;
 163   UINT8                       CompressionType;
 164 } EFI_COMPRESSION_SECTION;
 165
 166 //
 167 // Leaf section which could be used to determine the dispatch order of DXEs.
 168 //
 169 typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;
 170
 171 //
 172 // Leaf section witch contains a PI FV.
 173 //
 174 typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;
 175
 176 //
 177 // Leaf section which contains a single GUID.
 178 //
 179 typedef struct {
 180   EFI_COMMON_SECTION_HEADER   CommonHeader;
 181   EFI_GUID                    SubTypeGuid;
 182 } EFI_FREEFORM_SUBTYPE_GUID_SECTION;
 183
 184 //
 185 // Attributes of EFI_GUID_DEFINED_SECTION
 186 //
 187 #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED  0x01
 188 #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID    0x02
 189 //
 190 // Leaf section which is encapsulation defined by specific GUID
 191 //
 192 typedef struct {
 193   EFI_COMMON_SECTION_HEADER   CommonHeader;
 194   EFI_GUID                    SectionDefinitionGuid;
 195   UINT16                      DataOffset;
 196   UINT16                      Attributes;
 197 } EFI_GUID_DEFINED_SECTION;
 198
 199 //
 200 // Leaf section which contains PE32+ image.
 201 //
 202 typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;
 203
 204 //
 205 // Leaf section which contains PIC image.
 206 //
 207 typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION;
 208
 209 //
 210 // Leaf section which used to determine the dispatch order of PEIMs.
 211 //
 212 typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;
 213
 214 //
 215 // Leaf section which constains the position-independent-code image.
 216 //
 217 typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;
 218
 219 //
 220 // Leaf section which contains an array of zero or more bytes.
 221 //
 222 typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;
 223
 224 //
 225 // Leaf section which contains a unicode string that
 226 // is human readable file name.
 227 //
 228 typedef struct {
 229   EFI_COMMON_SECTION_HEADER   CommonHeader;
 230
 231   //
 232   // Array of unicode string.
 233   //
 234   CHAR16                      FileNameString[1];
 235 } EFI_USER_INTERFACE_SECTION;
 236
 237
 238 //
 239 // Leaf section which contains a numeric build number and
 240 // an optional unicode string that represent the file revision.
 241 //
 242 typedef struct {
 243   EFI_COMMON_SECTION_HEADER   CommonHeader;
 244   UINT16                      BuildNumber;
 245   CHAR16                      VersionString[1];
 246 } EFI_VERSION_SECTION;
 247
 248
 249 #define SECTION_SIZE(SectionHeaderPtr) \
 250     ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))
 251
 252 #pragma pack()
 253
 254 typedef union {
 255   EFI_COMMON_SECTION_HEADER         *CommonHeader;
 256   EFI_COMPRESSION_SECTION           *CompressionSection;
 257   EFI_GUID_DEFINED_SECTION          *GuidDefinedSection;
 258   EFI_PE32_SECTION                  *Pe32Section;
 259   EFI_PIC_SECTION                   *PicSection;
 260   EFI_TE_SECTION                    *TeSection;
 261   EFI_PEI_DEPEX_SECTION             *PeimHeaderSection;
 262   EFI_DXE_DEPEX_SECTION             *DependencySection;
 263   EFI_VERSION_SECTION               *VersionSection;
 264   EFI_USER_INTERFACE_SECTION        *UISection;
 265   EFI_COMPATIBILITY16_SECTION       *Code16Section;
 266   EFI_FIRMWARE_VOLUME_IMAGE_SECTION *FVImageSection;
 267   EFI_FREEFORM_SUBTYPE_GUID_SECTION *FreeformSubtypeSection;
 268   EFI_RAW_SECTION                   *RawSection;
 269 } EFI_FILE_SECTION_POINTER;
 270
 271 #endif
 272