1 /** @file 2 This file contains describes the public interfaces to the GenFvImage Library. 3 The basic purpose of the library is to create Firmware Volume images. 4 5 Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR> 6 This program and the accompanying materials 7 are licensed and made available under the terms and conditions of the BSD License 8 which accompanies this 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 **/ 15 16 #ifndef _EFI_GEN_FV_INTERNAL_LIB_H 17 #define _EFI_GEN_FV_INTERNAL_LIB_H 18 19 // 20 // Include files 21 // 22 #include <stdlib.h> 23 24 #include <Common/UefiBaseTypes.h> 25 #include <Common/UefiCapsule.h> 26 27 #include <Common/PiFirmwareFile.h> 28 #include <Common/PiFirmwareVolume.h> 29 #include <Guid/PiFirmwareFileSystem.h> 30 #include <IndustryStandard/PeImage.h> 31 32 #include "CommonLib.h" 33 #include "ParseInf.h" 34 #include "EfiUtilityMsgs.h" 35 36 // 37 // Different file separater for Linux and Windows 38 // 39 #define FILE_SEP_CHAR '/' 40 41 // 42 // The maximum number of Pad file guid entries. 43 // 44 #define MAX_NUMBER_OF_PAD_FILE_GUIDS 1024 45 46 // 47 // The maximum number of block map entries supported by the library 48 // 49 #define MAX_NUMBER_OF_FV_BLOCKS 100 50 51 // 52 // The maximum number of files in the FV supported by the library 53 // 54 #define MAX_NUMBER_OF_FILES_IN_FV 1000 55 #define MAX_NUMBER_OF_FILES_IN_CAP 1000 56 #define EFI_FFS_FILE_HEADER_ALIGNMENT 8 57 // 58 // INF file strings 59 // 60 #define OPTIONS_SECTION_STRING "[options]" 61 #define ATTRIBUTES_SECTION_STRING "[attributes]" 62 #define FILES_SECTION_STRING "[files]" 63 #define FV_BASE_ADDRESS_STRING "[FV_BASE_ADDRESS]" 64 65 // 66 // Options section 67 // 68 #define EFI_FV_BASE_ADDRESS_STRING "EFI_BASE_ADDRESS" 69 #define EFI_FV_FILE_NAME_STRING "EFI_FILE_NAME" 70 #define EFI_NUM_BLOCKS_STRING "EFI_NUM_BLOCKS" 71 #define EFI_BLOCK_SIZE_STRING "EFI_BLOCK_SIZE" 72 #define EFI_GUID_STRING "EFI_GUID" 73 #define EFI_FV_FILESYSTEMGUID_STRING "EFI_FV_GUID" 74 #define EFI_FV_NAMEGUID_STRING "EFI_FVNAME_GUID" 75 #define EFI_CAPSULE_GUID_STRING "EFI_CAPSULE_GUID" 76 #define EFI_CAPSULE_HEADER_SIZE_STRING "EFI_CAPSULE_HEADER_SIZE" 77 #define EFI_CAPSULE_FLAGS_STRING "EFI_CAPSULE_FLAGS" 78 #define EFI_OEM_CAPSULE_FLAGS_STRING "EFI_OEM_CAPSULE_FLAGS" 79 #define EFI_CAPSULE_VERSION_STRING "EFI_CAPSULE_VERSION" 80 81 #define EFI_FV_TOTAL_SIZE_STRING "EFI_FV_TOTAL_SIZE" 82 #define EFI_FV_TAKEN_SIZE_STRING "EFI_FV_TAKEN_SIZE" 83 #define EFI_FV_SPACE_SIZE_STRING "EFI_FV_SPACE_SIZE" 84 85 // 86 // Attributes section 87 // 88 #define EFI_FVB2_READ_DISABLED_CAP_STRING "EFI_READ_DISABLED_CAP" 89 #define EFI_FVB2_READ_ENABLED_CAP_STRING "EFI_READ_ENABLED_CAP" 90 #define EFI_FVB2_READ_STATUS_STRING "EFI_READ_STATUS" 91 92 #define EFI_FVB2_WRITE_DISABLED_CAP_STRING "EFI_WRITE_DISABLED_CAP" 93 #define EFI_FVB2_WRITE_ENABLED_CAP_STRING "EFI_WRITE_ENABLED_CAP" 94 #define EFI_FVB2_WRITE_STATUS_STRING "EFI_WRITE_STATUS" 95 96 #define EFI_FVB2_LOCK_CAP_STRING "EFI_LOCK_CAP" 97 #define EFI_FVB2_LOCK_STATUS_STRING "EFI_LOCK_STATUS" 98 99 #define EFI_FVB2_STICKY_WRITE_STRING "EFI_STICKY_WRITE" 100 #define EFI_FVB2_MEMORY_MAPPED_STRING "EFI_MEMORY_MAPPED" 101 #define EFI_FVB2_ERASE_POLARITY_STRING "EFI_ERASE_POLARITY" 102 103 #define EFI_FVB2_READ_LOCK_CAP_STRING "EFI_READ_LOCK_CAP" 104 #define EFI_FVB2_READ_LOCK_STATUS_STRING "EFI_READ_LOCK_STATUS" 105 #define EFI_FVB2_WRITE_LOCK_CAP_STRING "EFI_WRITE_LOCK_CAP" 106 #define EFI_FVB2_WRITE_LOCK_STATUS_STRING "EFI_WRITE_LOCK_STATUS" 107 108 #define EFI_FVB2_ALIGNMENT_1_STRING "EFI_FVB2_ALIGNMENT_1" 109 #define EFI_FVB2_ALIGNMENT_2_STRING "EFI_FVB2_ALIGNMENT_2" 110 #define EFI_FVB2_ALIGNMENT_4_STRING "EFI_FVB2_ALIGNMENT_4" 111 #define EFI_FVB2_ALIGNMENT_8_STRING "EFI_FVB2_ALIGNMENT_8" 112 #define EFI_FVB2_ALIGNMENT_16_STRING "EFI_FVB2_ALIGNMENT_16" 113 #define EFI_FVB2_ALIGNMENT_32_STRING "EFI_FVB2_ALIGNMENT_32" 114 #define EFI_FVB2_ALIGNMENT_64_STRING "EFI_FVB2_ALIGNMENT_64" 115 #define EFI_FVB2_ALIGNMENT_128_STRING "EFI_FVB2_ALIGNMENT_128" 116 #define EFI_FVB2_ALIGNMENT_256_STRING "EFI_FVB2_ALIGNMENT_256" 117 #define EFI_FVB2_ALIGNMENT_512_STRING "EFI_FVB2_ALIGNMENT_512" 118 #define EFI_FVB2_ALIGNMENT_1K_STRING "EFI_FVB2_ALIGNMENT_1K" 119 #define EFI_FVB2_ALIGNMENT_2K_STRING "EFI_FVB2_ALIGNMENT_2K" 120 #define EFI_FVB2_ALIGNMENT_4K_STRING "EFI_FVB2_ALIGNMENT_4K" 121 #define EFI_FVB2_ALIGNMENT_8K_STRING "EFI_FVB2_ALIGNMENT_8K" 122 #define EFI_FVB2_ALIGNMENT_16K_STRING "EFI_FVB2_ALIGNMENT_16K" 123 #define EFI_FVB2_ALIGNMENT_32K_STRING "EFI_FVB2_ALIGNMENT_32K" 124 #define EFI_FVB2_ALIGNMENT_64K_STRING "EFI_FVB2_ALIGNMENT_64K" 125 #define EFI_FVB2_ALIGNMENT_128K_STRING "EFI_FVB2_ALIGNMENT_128K" 126 #define EFI_FVB2_ALIGNMENT_256K_STRING "EFI_FVB2_ALIGNMENT_256K" 127 #define EFI_FVB2_ALIGNMENT_512K_STRING "EFI_FVB2_ALIGNMENT_512K" 128 #define EFI_FVB2_ALIGNMENT_1M_STRING "EFI_FVB2_ALIGNMENT_1M" 129 #define EFI_FVB2_ALIGNMENT_2M_STRING "EFI_FVB2_ALIGNMENT_2M" 130 #define EFI_FVB2_ALIGNMENT_4M_STRING "EFI_FVB2_ALIGNMENT_4M" 131 #define EFI_FVB2_ALIGNMENT_8M_STRING "EFI_FVB2_ALIGNMENT_8M" 132 #define EFI_FVB2_ALIGNMENT_16M_STRING "EFI_FVB2_ALIGNMENT_16M" 133 #define EFI_FVB2_ALIGNMENT_32M_STRING "EFI_FVB2_ALIGNMENT_32M" 134 #define EFI_FVB2_ALIGNMENT_64M_STRING "EFI_FVB2_ALIGNMENT_64M" 135 #define EFI_FVB2_ALIGNMENT_128M_STRING "EFI_FVB2_ALIGNMENT_128M" 136 #define EFI_FVB2_ALIGNMENT_256M_STRING "EFI_FVB2_ALIGNMENT_256M" 137 #define EFI_FVB2_ALIGNMENT_512M_STRING "EFI_FVB2_ALIGNMENT_512M" 138 #define EFI_FVB2_ALIGNMENT_1G_STRING "EFI_FVB2_ALIGNMENT_1G" 139 #define EFI_FVB2_ALIGNMENT_2G_STRING "EFI_FVB2_ALIGNMENT_2G" 140 141 #define EFI_FV_WEAK_ALIGNMENT_STRING "EFI_WEAK_ALIGNMENT" 142 143 // 144 // File sections 145 // 146 #define EFI_FILE_NAME_STRING "EFI_FILE_NAME" 147 148 #define ONE_STRING "1" 149 #define ZERO_STRING "0" 150 #define TRUE_STRING "TRUE" 151 #define FALSE_STRING "FALSE" 152 #define NULL_STRING "NULL" 153 154 // 155 // 156 // 157 #define EFI_FV_EXT_HEADER_FILE_NAME "EFI_FV_EXT_HEADER_FILE_NAME" 158 159 160 // 161 // VTF (Firmware Volume Top File) signatures 162 // 163 #define IA32_X64_VTF_SIGNATURE_OFFSET 0x14 164 #define IA32_X64_VTF0_SIGNATURE SIGNATURE_32('V','T','F',0) 165 166 // 167 // Defines to calculate the offset for PEI CORE entry points 168 // 169 #define IA32_PEI_CORE_ENTRY_OFFSET 0x20 170 171 // 172 // Defines to calculate the offset for IA32 SEC CORE entry point 173 // 174 #define IA32_SEC_CORE_ENTRY_OFFSET 0xD 175 176 // 177 // Defines to calculate the FIT table 178 // 179 #define IPF_FIT_ADDRESS_OFFSET 0x20 180 181 // 182 // Defines to calculate the offset for SALE_ENTRY 183 // 184 #define IPF_SALE_ENTRY_ADDRESS_OFFSET 0x18 185 186 // 187 // Symbol file definitions, current max size if 512K 188 // 189 #define SYMBOL_FILE_SIZE 0x80000 190 191 #define FV_IMAGES_TOP_ADDRESS 0x100000000ULL 192 193 // 194 // Following definition is used for FIT in IPF 195 // 196 #define COMP_TYPE_FIT_PEICORE 0x10 197 #define COMP_TYPE_FIT_UNUSED 0x7F 198 199 #define FIT_TYPE_MASK 0x7F 200 #define CHECKSUM_BIT_MASK 0x80 201 202 // 203 // Private data types 204 // 205 // 206 // Component information 207 // 208 typedef struct { 209 UINTN Size; 210 CHAR8 ComponentName[MAX_LONG_FILE_PATH]; 211 } COMPONENT_INFO; 212 213 // 214 // FV and capsule information holder 215 // 216 typedef struct { 217 BOOLEAN BaseAddressSet; 218 EFI_PHYSICAL_ADDRESS BaseAddress; 219 EFI_GUID FvFileSystemGuid; 220 BOOLEAN FvFileSystemGuidSet; 221 EFI_GUID FvNameGuid; 222 BOOLEAN FvNameGuidSet; 223 CHAR8 FvExtHeaderFile[MAX_LONG_FILE_PATH]; 224 UINTN Size; 225 EFI_FVB_ATTRIBUTES_2 FvAttributes; 226 CHAR8 FvName[MAX_LONG_FILE_PATH]; 227 EFI_FV_BLOCK_MAP_ENTRY FvBlocks[MAX_NUMBER_OF_FV_BLOCKS]; 228 CHAR8 FvFiles[MAX_NUMBER_OF_FILES_IN_FV][MAX_LONG_FILE_PATH]; 229 UINT32 SizeofFvFiles[MAX_NUMBER_OF_FILES_IN_FV]; 230 BOOLEAN IsPiFvImage; 231 INT8 ForceRebase; 232 } FV_INFO; 233 234 typedef struct { 235 EFI_GUID CapGuid; 236 UINT32 HeaderSize; 237 UINT32 Flags; 238 CHAR8 CapName[MAX_LONG_FILE_PATH]; 239 CHAR8 CapFiles[MAX_NUMBER_OF_FILES_IN_CAP][MAX_LONG_FILE_PATH]; 240 } CAP_INFO; 241 242 #pragma pack(1) 243 244 typedef struct { 245 UINT64 CompAddress; 246 UINT32 CompSize; 247 UINT16 CompVersion; 248 UINT8 CvAndType; 249 UINT8 CheckSum; 250 } FIT_TABLE; 251 252 #pragma pack() 253 254 #define FV_DEFAULT_ATTRIBUTE 0x0004FEFF 255 extern FV_INFO mFvDataInfo; 256 extern CAP_INFO mCapDataInfo; 257 extern EFI_GUID mEfiFirmwareFileSystem2Guid; 258 extern EFI_GUID mEfiFirmwareFileSystem3Guid; 259 extern UINT32 mFvTotalSize; 260 extern UINT32 mFvTakenSize; 261 262 extern EFI_PHYSICAL_ADDRESS mFvBaseAddress[]; 263 extern UINT32 mFvBaseAddressNumber; 264 // 265 // Local function prototypes 266 // 267 EFI_STATUS 268 ParseFvInf ( 269 IN MEMORY_FILE *InfFile, 270 OUT FV_INFO *FvInfo 271 ) 272 ; 273 274 EFI_STATUS 275 UpdatePeiCoreEntryInFit ( 276 IN FIT_TABLE *FitTablePtr, 277 IN UINT64 PeiCorePhysicalAddress 278 ) 279 /*++ 280 281 Routine Description: 282 283 This function is used to update the Pei Core address in FIT, this can be used by Sec core to pass control from 284 Sec to Pei Core 285 286 Arguments: 287 288 FitTablePtr - The pointer of FIT_TABLE. 289 PeiCorePhysicalAddress - The address of Pei Core entry. 290 291 Returns: 292 293 EFI_SUCCESS - The PEI_CORE FIT entry was updated successfully. 294 EFI_NOT_FOUND - Not found the PEI_CORE FIT entry. 295 296 --*/ 297 ; 298 299 VOID 300 UpdateFitCheckSum ( 301 IN FIT_TABLE *FitTablePtr 302 ) 303 /*++ 304 305 Routine Description: 306 307 This function is used to update the checksum for FIT. 308 309 310 Arguments: 311 312 FitTablePtr - The pointer of FIT_TABLE. 313 314 Returns: 315 316 None. 317 318 --*/ 319 ; 320 321 EFI_STATUS 322 GetPe32Info ( 323 IN UINT8 *Pe32, 324 OUT UINT32 *EntryPoint, 325 OUT UINT32 *BaseOfCode, 326 OUT UINT16 *MachineType 327 ); 328 329 EFI_STATUS 330 ParseCapInf ( 331 IN MEMORY_FILE *InfFile, 332 OUT CAP_INFO *CapInfo 333 ); 334 335 EFI_STATUS 336 FindApResetVectorPosition ( 337 IN MEMORY_FILE *FvImage, 338 OUT UINT8 **Pointer 339 ); 340 341 EFI_STATUS 342 CalculateFvSize ( 343 FV_INFO *FvInfoPtr 344 ); 345 346 EFI_STATUS 347 FfsRebase ( 348 IN OUT FV_INFO *FvInfo, 349 IN CHAR8 *FileName, 350 IN OUT EFI_FFS_FILE_HEADER *FfsFile, 351 IN UINTN XipOffset, 352 IN FILE *FvMapFile 353 ); 354 355 // 356 // Exported function prototypes 357 // 358 EFI_STATUS 359 GenerateCapImage ( 360 IN CHAR8 *InfFileImage, 361 IN UINTN InfFileSize, 362 IN CHAR8 *CapFileName 363 ) 364 /*++ 365 366 Routine Description: 367 368 This is the main function which will be called from application to 369 generate UEFI Capsule image. 370 371 Arguments: 372 373 InfFileImage Buffer containing the INF file contents. 374 InfFileSize Size of the contents of the InfFileImage buffer. 375 CapFileName Requested name for the Cap file. 376 377 Returns: 378 379 EFI_SUCCESS Function completed successfully. 380 EFI_OUT_OF_RESOURCES Could not allocate required resources. 381 EFI_ABORTED Error encountered. 382 EFI_INVALID_PARAMETER A required parameter was NULL. 383 384 --*/ 385 ; 386 387 EFI_STATUS 388 GenerateFvImage ( 389 IN CHAR8 *InfFileImage, 390 IN UINTN InfFileSize, 391 IN CHAR8 *FvFileName, 392 IN CHAR8 *MapFileName 393 ) 394 /*++ 395 396 Routine Description: 397 398 This is the main function which will be called from application to 399 generate Firmware Image conforms to PI spec. 400 401 Arguments: 402 403 InfFileImage Buffer containing the INF file contents. 404 InfFileSize Size of the contents of the InfFileImage buffer. 405 FvFileName Requested name for the FV file. 406 MapFileName Fv map file to log fv driver information. 407 408 Returns: 409 410 EFI_SUCCESS Function completed successfully. 411 EFI_OUT_OF_RESOURCES Could not allocate required resources. 412 EFI_ABORTED Error encountered. 413 EFI_INVALID_PARAMETER A required parameter was NULL. 414 415 --*/ 416 ; 417 418 #endif 419
