1 /** @file 2 The firmware volume related definitions in PI. 3 4 Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR> 5 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 PI Version 1.3 15 16 **/ 17 18 #ifndef __PI_FIRMWAREVOLUME_H__ 19 #define __PI_FIRMWAREVOLUME_H__ 20 21 /// 22 /// EFI_FV_FILE_ATTRIBUTES 23 /// 24 typedef UINT32 EFI_FV_FILE_ATTRIBUTES; 25 26 // 27 // Value of EFI_FV_FILE_ATTRIBUTES. 28 // 29 #define EFI_FV_FILE_ATTRIB_ALIGNMENT 0x0000001F 30 #define EFI_FV_FILE_ATTRIB_FIXED 0x00000100 31 #define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED 0x00000200 32 33 /// 34 /// type of EFI FVB attribute 35 /// 36 typedef UINT32 EFI_FVB_ATTRIBUTES_2; 37 38 // 39 // Attributes bit definitions 40 // 41 #define EFI_FVB2_READ_DISABLED_CAP 0x00000001 42 #define EFI_FVB2_READ_ENABLED_CAP 0x00000002 43 #define EFI_FVB2_READ_STATUS 0x00000004 44 #define EFI_FVB2_WRITE_DISABLED_CAP 0x00000008 45 #define EFI_FVB2_WRITE_ENABLED_CAP 0x00000010 46 #define EFI_FVB2_WRITE_STATUS 0x00000020 47 #define EFI_FVB2_LOCK_CAP 0x00000040 48 #define EFI_FVB2_LOCK_STATUS 0x00000080 49 #define EFI_FVB2_STICKY_WRITE 0x00000200 50 #define EFI_FVB2_MEMORY_MAPPED 0x00000400 51 #define EFI_FVB2_ERASE_POLARITY 0x00000800 52 #define EFI_FVB2_READ_LOCK_CAP 0x00001000 53 #define EFI_FVB2_READ_LOCK_STATUS 0x00002000 54 #define EFI_FVB2_WRITE_LOCK_CAP 0x00004000 55 #define EFI_FVB2_WRITE_LOCK_STATUS 0x00008000 56 #define EFI_FVB2_ALIGNMENT 0x001F0000 57 #define EFI_FVB2_ALIGNMENT_1 0x00000000 58 #define EFI_FVB2_ALIGNMENT_2 0x00010000 59 #define EFI_FVB2_ALIGNMENT_4 0x00020000 60 #define EFI_FVB2_ALIGNMENT_8 0x00030000 61 #define EFI_FVB2_ALIGNMENT_16 0x00040000 62 #define EFI_FVB2_ALIGNMENT_32 0x00050000 63 #define EFI_FVB2_ALIGNMENT_64 0x00060000 64 #define EFI_FVB2_ALIGNMENT_128 0x00070000 65 #define EFI_FVB2_ALIGNMENT_256 0x00080000 66 #define EFI_FVB2_ALIGNMENT_512 0x00090000 67 #define EFI_FVB2_ALIGNMENT_1K 0x000A0000 68 #define EFI_FVB2_ALIGNMENT_2K 0x000B0000 69 #define EFI_FVB2_ALIGNMENT_4K 0x000C0000 70 #define EFI_FVB2_ALIGNMENT_8K 0x000D0000 71 #define EFI_FVB2_ALIGNMENT_16K 0x000E0000 72 #define EFI_FVB2_ALIGNMENT_32K 0x000F0000 73 #define EFI_FVB2_ALIGNMENT_64K 0x00100000 74 #define EFI_FVB2_ALIGNMENT_128K 0x00110000 75 #define EFI_FVB2_ALIGNMENT_256K 0x00120000 76 #define EFI_FVB2_ALIGNMENT_512K 0x00130000 77 #define EFI_FVB2_ALIGNMENT_1M 0x00140000 78 #define EFI_FVB2_ALIGNMENT_2M 0x00150000 79 #define EFI_FVB2_ALIGNMENT_4M 0x00160000 80 #define EFI_FVB2_ALIGNMENT_8M 0x00170000 81 #define EFI_FVB2_ALIGNMENT_16M 0x00180000 82 #define EFI_FVB2_ALIGNMENT_32M 0x00190000 83 #define EFI_FVB2_ALIGNMENT_64M 0x001A0000 84 #define EFI_FVB2_ALIGNMENT_128M 0x001B0000 85 #define EFI_FVB2_ALIGNMENT_256M 0x001C0000 86 #define EFI_FVB2_ALIGNMENT_512M 0x001D0000 87 #define EFI_FVB2_ALIGNMENT_1G 0x001E0000 88 #define EFI_FVB2_ALIGNMENT_2G 0x001F0000 89 #define EFI_FVB2_WEAK_ALIGNMENT 0x80000000 90 91 typedef struct { 92 /// 93 /// The number of sequential blocks which are of the same size. 94 /// 95 UINT32 NumBlocks; 96 /// 97 /// The size of the blocks. 98 /// 99 UINT32 Length; 100 } EFI_FV_BLOCK_MAP_ENTRY; 101 102 /// 103 /// Describes the features and layout of the firmware volume. 104 /// 105 typedef struct { 106 /// 107 /// The first 16 bytes are reserved to allow for the reset vector of 108 /// processors whose reset vector is at address 0. 109 /// 110 UINT8 ZeroVector[16]; 111 /// 112 /// Declares the file system with which the firmware volume is formatted. 113 /// 114 EFI_GUID FileSystemGuid; 115 /// 116 /// Length in bytes of the complete firmware volume, including the header. 117 /// 118 UINT64 FvLength; 119 /// 120 /// Set to EFI_FVH_SIGNATURE 121 /// 122 UINT32 Signature; 123 /// 124 /// Declares capabilities and power-on defaults for the firmware volume. 125 /// 126 EFI_FVB_ATTRIBUTES_2 Attributes; 127 /// 128 /// Length in bytes of the complete firmware volume header. 129 /// 130 UINT16 HeaderLength; 131 /// 132 /// A 16-bit checksum of the firmware volume header. A valid header sums to zero. 133 /// 134 UINT16 Checksum; 135 /// 136 /// Offset, relative to the start of the header, of the extended header 137 /// (EFI_FIRMWARE_VOLUME_EXT_HEADER) or zero if there is no extended header. 138 /// 139 UINT16 ExtHeaderOffset; 140 /// 141 /// This field must always be set to zero. 142 /// 143 UINT8 Reserved[1]; 144 /// 145 /// Set to 2. Future versions of this specification may define new header fields and will 146 /// increment the Revision field accordingly. 147 /// 148 UINT8 Revision; 149 /// 150 /// An array of run-length encoded FvBlockMapEntry structures. The array is 151 /// terminated with an entry of {0,0}. 152 /// 153 EFI_FV_BLOCK_MAP_ENTRY BlockMap[1]; 154 } EFI_FIRMWARE_VOLUME_HEADER; 155 156 #define EFI_FVH_SIGNATURE SIGNATURE_32 ('_', 'F', 'V', 'H') 157 158 /// 159 /// Firmware Volume Header Revision definition 160 /// 161 #define EFI_FVH_REVISION 0x02 162 163 /// 164 /// Extension header pointed by ExtHeaderOffset of volume header. 165 /// 166 typedef struct { 167 /// 168 /// Firmware volume name. 169 /// 170 EFI_GUID FvName; 171 /// 172 /// Size of the rest of the extension header, including this structure. 173 /// 174 UINT32 ExtHeaderSize; 175 } EFI_FIRMWARE_VOLUME_EXT_HEADER; 176 177 /// 178 /// Entry struture for describing FV extension header 179 /// 180 typedef struct { 181 /// 182 /// Size of this header extension. 183 /// 184 UINT16 ExtEntrySize; 185 /// 186 /// Type of the header. 187 /// 188 UINT16 ExtEntryType; 189 } EFI_FIRMWARE_VOLUME_EXT_ENTRY; 190 191 #define EFI_FV_EXT_TYPE_OEM_TYPE 0x01 192 /// 193 /// This extension header provides a mapping between a GUID and an OEM file type. 194 /// 195 typedef struct { 196 /// 197 /// Standard extension entry, with the type EFI_FV_EXT_TYPE_OEM_TYPE. 198 /// 199 EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr; 200 /// 201 /// A bit mask, one bit for each file type between 0xC0 (bit 0) and 0xDF (bit 31). If a bit 202 /// is '1', then the GUID entry exists in Types. If a bit is '0' then no GUID entry exists in Types. 203 /// 204 UINT32 TypeMask; 205 /// 206 /// An array of GUIDs, each GUID representing an OEM file type. 207 /// 208 /// EFI_GUID Types[1]; 209 /// 210 } EFI_FIRMWARE_VOLUME_EXT_ENTRY_OEM_TYPE; 211 212 #define EFI_FV_EXT_TYPE_GUID_TYPE 0x0002 213 214 /// 215 /// This extension header EFI_FIRMWARE_VOLUME_EXT_ENTRY_GUID_TYPE provides a vendor specific 216 /// GUID FormatType type which includes a length and a successive series of data bytes. 217 /// 218 typedef struct { 219 /// 220 /// Standard extension entry, with the type EFI_FV_EXT_TYPE_OEM_TYPE. 221 /// 222 EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr; 223 /// 224 /// Vendor-specific GUID. 225 /// 226 EFI_GUID FormatType; 227 /// 228 /// An arry of bytes of length Length. 229 /// 230 /// UINT8 Data[1]; 231 /// 232 } EFI_FIRMWARE_VOLUME_EXT_ENTRY_GUID_TYPE; 233 234 #endif 235