MdePkg/Include/Pi/PiFirmwareFile.h

   1 /** @file
   2   The firmware file related definitions in PI.
   3
   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
   9
  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.
  12
  13   @par Revision Reference:
  14   Version 1.0.
  15
  16 **/
  17
  18 #ifndef __PI_FIRMWARE_FILE_H__
  19 #define __PI_FIRMWARE_FILE_H__
  20
  21 #pragma pack(1)
  22 //
  23 // Used to verify the integrity of the file.
  24 //
  25 typedef union {
  26   struct {
  27     UINT8   Header;
  28     UINT8   File;
  29   } Checksum;
  30   UINT16    Checksum16;
  31 } EFI_FFS_INTEGRITY_CHECK;
  32
  33 typedef UINT8 EFI_FV_FILETYPE;
  34 typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;
  35 typedef UINT8 EFI_FFS_FILE_STATE;
  36
  37 //
  38 // File Types Definitions
  39 //
  40 #define EFI_FV_FILETYPE_ALL                   0x00
  41 #define EFI_FV_FILETYPE_RAW                   0x01
  42 #define EFI_FV_FILETYPE_FREEFORM              0x02
  43 #define EFI_FV_FILETYPE_SECURITY_CORE         0x03
  44 #define EFI_FV_FILETYPE_PEI_CORE              0x04
  45 #define EFI_FV_FILETYPE_DXE_CORE              0x05
  46 #define EFI_FV_FILETYPE_PEIM                  0x06
  47 #define EFI_FV_FILETYPE_DRIVER                0x07
  48 #define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER  0x08
  49 #define EFI_FV_FILETYPE_APPLICATION           0x09
  50 #define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B
  51 #define EFI_FV_FILETYPE_OEM_MIN               0xc0
  52 #define EFI_FV_FILETYPE_OEM_MAX               0xdf
  53 #define EFI_FV_FILETYPE_DEBUG_MIN             0xe0
  54 #define EFI_FV_FILETYPE_DEBUG_MAX             0xef
  55 #define EFI_FV_FILETYPE_FFS_MIN               0xf0
  56 #define EFI_FV_FILETYPE_FFS_MAX               0xff
  57 #define EFI_FV_FILETYPE_FFS_PAD               0xf0
  58 //
  59 // FFS File Attributes.
  60 //
  61 #define FFS_ATTRIB_FIXED              0x04
  62 #define FFS_ATTRIB_DATA_ALIGNMENT     0x38
  63 #define FFS_ATTRIB_CHECKSUM           0x40
  64
  65 //
  66 // FFS File State Bits.
  67 //
  68 #define EFI_FILE_HEADER_CONSTRUCTION  0x01
  69 #define EFI_FILE_HEADER_VALID         0x02
  70 #define EFI_FILE_DATA_VALID           0x04
  71 #define EFI_FILE_MARKED_FOR_UPDATE    0x08
  72 #define EFI_FILE_DELETED              0x10
  73 #define EFI_FILE_HEADER_INVALID       0x20
  74
  75
  76 //
  77 // Each file begins with the header that describe the
  78 // contents and state of the files.
  79 //
  80 typedef struct {
  81   EFI_GUID                Name;
  82   EFI_FFS_INTEGRITY_CHECK IntegrityCheck;
  83   EFI_FV_FILETYPE         Type;
  84   EFI_FFS_FILE_ATTRIBUTES Attributes;
  85   UINT8                   Size[3];
  86   EFI_FFS_FILE_STATE      State;
  87 } EFI_FFS_FILE_HEADER;
  88
  89
  90 typedef UINT8 EFI_SECTION_TYPE;
  91
  92 //
  93 // Pseudo type. It is
  94 // used as a wild card when retrieving sections. The section
  95 // type EFI_SECTION_ALL matches all section types.
  96 //
  97 #define EFI_SECTION_ALL                   0x00
  98
  99 //
 100 // Encapsulation section Type values
 101 //
 102 #define EFI_SECTION_COMPRESSION           0x01
 103
 104 #define EFI_SECTION_GUID_DEFINED          0x02
 105
 106 //
 107 // Leaf section Type values
 108 //
 109 #define EFI_SECTION_PE32                  0x10
 110 #define EFI_SECTION_PIC                   0x11
 111 #define EFI_SECTION_TE                    0x12
 112 #define EFI_SECTION_DXE_DEPEX             0x13
 113 #define EFI_SECTION_VERSION               0x14
 114 #define EFI_SECTION_USER_INTERFACE        0x15
 115 #define EFI_SECTION_COMPATIBILITY16       0x16
 116 #define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17
 117 #define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18
 118 #define EFI_SECTION_RAW                   0x19
 119 #define EFI_SECTION_PEI_DEPEX             0x1B
 120
 121 typedef struct {
 122   UINT8             Size[3];
 123   EFI_SECTION_TYPE  Type;
 124 } EFI_COMMON_SECTION_HEADER;
 125
 126 //
 127 // Leaf section type that contains an
 128 // IA-32 16-bit executable image.
 129 //
 130 typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;
 131
 132 //
 133 // CompressionType of EFI_COMPRESSION_SECTION.
 134 //
 135 #define EFI_NOT_COMPRESSED        0x00
 136 #define EFI_STANDARD_COMPRESSION  0x01
 137 //
 138 // An encapsulation section type in which the
 139 // section data is compressed.
 140 //
 141 typedef struct {
 142   EFI_COMMON_SECTION_HEADER   CommonHeader;
 143   UINT32                      UncompressedLength;
 144   UINT8                       CompressionType;
 145 } EFI_COMPRESSION_SECTION;
 146
 147 //
 148 // Leaf section which could be used to determine the dispatch order of DXEs.
 149 //
 150 typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;
 151
 152 //
 153 // Leaf section witch contains a PI FV.
 154 //
 155 typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;
 156
 157 //
 158 // Leaf section which contains a single GUID.
 159 //
 160 typedef struct {
 161   EFI_COMMON_SECTION_HEADER   CommonHeader;
 162   EFI_GUID                    SubTypeGuid;
 163 } EFI_FREEFORM_SUBTYPE_GUID_SECTION;
 164
 165 //
 166 // Attributes of EFI_GUID_DEFINED_SECTION
 167 //
 168 #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED  0x01
 169 #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID    0x02
 170 //
 171 // Leaf section which is encapsulation defined by specific GUID
 172 //
 173 typedef struct {
 174   EFI_COMMON_SECTION_HEADER   CommonHeader;
 175   EFI_GUID                    SectionDefinitionGuid;
 176   UINT16                      DataOffset;
 177   UINT16                      Attributes;
 178 } EFI_GUID_DEFINED_SECTION;
 179
 180 //
 181 // Leaf section which contains PE32+ image.
 182 //
 183 typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;
 184
 185
 186 //
 187 // Leaf section which used to determine the dispatch order of PEIMs.
 188 //
 189 typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;
 190
 191 //
 192 // Leaf section which constains the position-independent-code image.
 193 //
 194 typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;
 195
 196 //
 197 // Leaf section which contains an array of zero or more bytes.
 198 //
 199 typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;
 200
 201 //
 202 // Leaf section which contains a unicode string that
 203 // is human readable file name.
 204 //
 205 typedef struct {
 206   EFI_COMMON_SECTION_HEADER   CommonHeader;
 207
 208   //
 209   // Array of unicode string.
 210   //
 211   CHAR16                      FileNameString[1];
 212 } EFI_USER_INTERFACE_SECTION;
 213
 214
 215 //
 216 // Leaf section which contains a numeric build number and
 217 // an optional unicode string that represent the file revision.
 218 //
 219 typedef struct {
 220   EFI_COMMON_SECTION_HEADER   CommonHeader;
 221   UINT16                      BuildNumber;
 222   CHAR16                      VersionString[1];
 223 } EFI_VERSION_SECTION;
 224
 225
 226 #define SECTION_SIZE(SectionHeaderPtr) \
 227     ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))
 228
 229 #pragma pack()
 230
 231 #endif
 232