Tools/CodeTools/TianoTools/Include/Common/FirmwareVolumeImageFormat.h

   1 /** @file
   2   This file defines the data structures that are architecturally defined for file
   3   images loaded via the FirmwareVolume protocol.  The Firmware Volume specification
   4   is the basis for these definitions.
   5
   6   Copyright (c) 2006, Intel Corporation
   7   All rights reserved. This program and the accompanying materials
   8   are licensed and made available under the terms and conditions of the BSD License
   9   which accompanies this distribution.  The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15   Module Name:  FimrwareVolumeImageFormat.h
  16
  17   @par Revision Reference:
  18   These definitions are from Firmware Volume Spec 0.9.
  19
  20 **/
  21
  22 #ifndef __FIRMWARE_VOLUME_IMAGE_FORMAT_H__
  23 #define __FIRMWARE_VOLUME_IMAGE_FORMAT_H__
  24
  25 //
  26 // pack all data structures since this is actually a binary format and we cannot
  27 // allow internal padding in the data structures because of some compilerism..
  28 //
  29 #pragma pack(1)
  30 //
  31 // ////////////////////////////////////////////////////////////////////////////
  32 //
  33 // Architectural file types
  34 //
  35 typedef UINT8 EFI_FV_FILETYPE;
  36
  37 #define EFI_FV_FILETYPE_ALL                   0x00
  38 #define EFI_FV_FILETYPE_RAW                   0x01
  39 #define EFI_FV_FILETYPE_FREEFORM              0x02
  40 #define EFI_FV_FILETYPE_SECURITY_CORE         0x03
  41 #define EFI_FV_FILETYPE_PEI_CORE              0x04
  42 #define EFI_FV_FILETYPE_DXE_CORE              0x05
  43 #define EFI_FV_FILETYPE_PEIM                  0x06
  44 #define EFI_FV_FILETYPE_DRIVER                0x07
  45 #define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER  0x08
  46 #define EFI_FV_FILETYPE_APPLICATION           0x09
  47 //
  48 // File type 0x0A is reserved and should not be used
  49 //
  50 #define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B
  51
  52 //
  53 // ////////////////////////////////////////////////////////////////////////////
  54 //
  55 // Section types
  56 //
  57 typedef UINT8 EFI_SECTION_TYPE;
  58
  59 //
  60 // ************************************************************
  61 // The section type EFI_SECTION_ALL is a psuedo type.  It is
  62 // used as a wildcard when retrieving sections.  The section
  63 // type EFI_SECTION_ALL matches all section types.
  64 // ************************************************************
  65 //
  66 #define EFI_SECTION_ALL 0x00
  67
  68 //
  69 // ************************************************************
  70 // Encapsulation section Type values
  71 // ************************************************************
  72 //
  73 #define EFI_SECTION_COMPRESSION   0x01
  74 #define EFI_SECTION_GUID_DEFINED  0x02
  75
  76 //
  77 // ************************************************************
  78 // Leaf section Type values
  79 // ************************************************************
  80 //
  81 #define EFI_SECTION_FIRST_LEAF_SECTION_TYPE 0x10
  82
  83 #define EFI_SECTION_PE32                    0x10
  84 #define EFI_SECTION_PIC                     0x11
  85 #define EFI_SECTION_TE                      0x12
  86 #define EFI_SECTION_DXE_DEPEX               0x13
  87 #define EFI_SECTION_VERSION                 0x14
  88 #define EFI_SECTION_USER_INTERFACE          0x15
  89 #define EFI_SECTION_COMPATIBILITY16         0x16
  90 #define EFI_SECTION_FIRMWARE_VOLUME_IMAGE   0x17
  91 #define EFI_SECTION_FREEFORM_SUBTYPE_GUID   0x18
  92 #define EFI_SECTION_RAW                     0x19
  93 #define EFI_SECTION_PEI_DEPEX               0x1B
  94
  95 #define EFI_SECTION_LAST_LEAF_SECTION_TYPE  0x1B
  96 #define EFI_SECTION_LAST_SECTION_TYPE       0x1B
  97
  98 //
  99 // ////////////////////////////////////////////////////////////////////////////
 100 //
 101 // Common section header
 102 //
 103 typedef struct {
 104   UINT8 Size[3];
 105   UINT8 Type;
 106 } EFI_COMMON_SECTION_HEADER;
 107
 108 #define SECTION_SIZE(SectionHeaderPtr) \
 109     ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))
 110
 111 //
 112 // ////////////////////////////////////////////////////////////////////////////
 113 //
 114 // Compression section
 115 //
 116 //
 117 // CompressionType values
 118 //
 119 #define EFI_NOT_COMPRESSED          0x00
 120 #define EFI_STANDARD_COMPRESSION    0x01
 121 #define EFI_CUSTOMIZED_COMPRESSION  0x02
 122
 123 typedef struct {
 124   EFI_COMMON_SECTION_HEADER CommonHeader;
 125   UINT32                    UncompressedLength;
 126   UINT8                     CompressionType;
 127 } EFI_COMPRESSION_SECTION;
 128
 129 //
 130 // ////////////////////////////////////////////////////////////////////////////
 131 //
 132 // GUID defined section
 133 //
 134 typedef struct {
 135   EFI_COMMON_SECTION_HEADER CommonHeader;
 136   EFI_GUID                  SectionDefinitionGuid;
 137   UINT16                    DataOffset;
 138   UINT16                    Attributes;
 139 } EFI_GUID_DEFINED_SECTION;
 140
 141 //
 142 // Bit values for Attributes
 143 //
 144 #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED  0x01
 145 #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID    0x02
 146
 147 //
 148 // Bit values for AuthenticationStatus
 149 //
 150 #define EFI_AGGREGATE_AUTH_STATUS_PLATFORM_OVERRIDE 0x000001
 151 #define EFI_AGGREGATE_AUTH_STATUS_IMAGE_SIGNED      0x000002
 152 #define EFI_AGGREGATE_AUTH_STATUS_NOT_TESTED        0x000004
 153 #define EFI_AGGREGATE_AUTH_STATUS_TEST_FAILED       0x000008
 154 #define EFI_AGGREGATE_AUTH_STATUS_ALL               0x00000f
 155
 156 #define EFI_LOCAL_AUTH_STATUS_PLATFORM_OVERRIDE     0x010000
 157 #define EFI_LOCAL_AUTH_STATUS_IMAGE_SIGNED          0x020000
 158 #define EFI_LOCAL_AUTH_STATUS_NOT_TESTED            0x040000
 159 #define EFI_LOCAL_AUTH_STATUS_TEST_FAILED           0x080000
 160 #define EFI_LOCAL_AUTH_STATUS_ALL                   0x0f0000
 161
 162 //
 163 // ////////////////////////////////////////////////////////////////////////////
 164 //
 165 // PE32+ section
 166 //
 167 typedef struct {
 168   EFI_COMMON_SECTION_HEADER CommonHeader;
 169 } EFI_PE32_SECTION;
 170
 171 //
 172 // ////////////////////////////////////////////////////////////////////////////
 173 //
 174 // PIC section
 175 //
 176 typedef struct {
 177   EFI_COMMON_SECTION_HEADER CommonHeader;
 178 } EFI_PIC_SECTION;
 179
 180 //
 181 // ////////////////////////////////////////////////////////////////////////////
 182 //
 183 // PEIM header section
 184 //
 185 typedef struct {
 186   EFI_COMMON_SECTION_HEADER CommonHeader;
 187 } EFI_PEIM_HEADER_SECTION;
 188
 189 //
 190 // ////////////////////////////////////////////////////////////////////////////
 191 //
 192 // DEPEX section
 193 //
 194 typedef struct {
 195   EFI_COMMON_SECTION_HEADER CommonHeader;
 196 } EFI_DEPEX_SECTION;
 197
 198 //
 199 // ////////////////////////////////////////////////////////////////////////////
 200 //
 201 // Version section
 202 //
 203 typedef struct {
 204   EFI_COMMON_SECTION_HEADER CommonHeader;
 205   UINT16                    BuildNumber;
 206   INT16                     VersionString[1];
 207 } EFI_VERSION_SECTION;
 208
 209 //
 210 // ////////////////////////////////////////////////////////////////////////////
 211 //
 212 // User interface section
 213 //
 214 typedef struct {
 215   EFI_COMMON_SECTION_HEADER CommonHeader;
 216   INT16                     FileNameString[1];
 217 } EFI_USER_INTERFACE_SECTION;
 218
 219 //
 220 // ////////////////////////////////////////////////////////////////////////////
 221 //
 222 // Code16 section
 223 //
 224 typedef struct {
 225   EFI_COMMON_SECTION_HEADER CommonHeader;
 226 } EFI_CODE16_SECTION;
 227
 228 //
 229 // ////////////////////////////////////////////////////////////////////////////
 230 //
 231 // Firmware Volume Image section
 232 //
 233 typedef struct {
 234   EFI_COMMON_SECTION_HEADER CommonHeader;
 235 } EFI_FIRMWARE_VOLUME_IMAGE_SECTION;
 236
 237 //
 238 // ////////////////////////////////////////////////////////////////////////////
 239 //
 240 // Freeform subtype GUID section
 241 //
 242 typedef struct {
 243   EFI_COMMON_SECTION_HEADER CommonHeader;
 244   EFI_GUID                  SubTypeGuid;
 245 } EFI_FREEFORM_SUBTYPE_GUID_SECTION;
 246
 247 //
 248 // ////////////////////////////////////////////////////////////////////////////
 249 //
 250 // Raw section
 251 //
 252 typedef struct {
 253   EFI_COMMON_SECTION_HEADER CommonHeader;
 254 } EFI_RAW_SECTION;
 255
 256 //
 257 // undo the pragma from the beginning...
 258 //
 259 #pragma pack()
 260
 261 typedef union {
 262   EFI_COMMON_SECTION_HEADER         *CommonHeader;
 263   EFI_COMPRESSION_SECTION           *CompressionSection;
 264   EFI_GUID_DEFINED_SECTION          *GuidDefinedSection;
 265   EFI_PE32_SECTION                  *Pe32Section;
 266   EFI_PIC_SECTION                   *PicSection;
 267   EFI_PEIM_HEADER_SECTION           *PeimHeaderSection;
 268   EFI_DEPEX_SECTION                 *DependencySection;
 269   EFI_VERSION_SECTION               *VersionSection;
 270   EFI_USER_INTERFACE_SECTION        *UISection;
 271   EFI_CODE16_SECTION                *Code16Section;
 272   EFI_FIRMWARE_VOLUME_IMAGE_SECTION *FVImageSection;
 273   EFI_FREEFORM_SUBTYPE_GUID_SECTION *FreeformSubtypeSection;
 274   EFI_RAW_SECTION                   *RawSection;
 275 } EFI_FILE_SECTION_POINTER;
 276
 277 #endif