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.
5 Copyright (c) 2004 - 2018, 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
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.
16 #ifndef _EFI_GEN_FV_INTERNAL_LIB_H
17 #define _EFI_GEN_FV_INTERNAL_LIB_H
24 #include <Common/UefiBaseTypes.h>
25 #include <Common/UefiCapsule.h>
27 #include <Common/PiFirmwareFile.h>
28 #include <Common/PiFirmwareVolume.h>
29 #include <Guid/PiFirmwareFileSystem.h>
30 #include <IndustryStandard/PeImage.h>
32 #include "CommonLib.h"
34 #include "EfiUtilityMsgs.h"
37 // Different file separater for Linux and Windows
39 #define FILE_SEP_CHAR '/'
42 // The maximum number of Pad file guid entries.
44 #define MAX_NUMBER_OF_PAD_FILE_GUIDS 1024
47 // The maximum number of block map entries supported by the library
49 #define MAX_NUMBER_OF_FV_BLOCKS 100
52 // The maximum number of files in the FV supported by the library
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
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]"
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"
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"
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"
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"
96 #define EFI_FVB2_LOCK_CAP_STRING "EFI_LOCK_CAP"
97 #define EFI_FVB2_LOCK_STATUS_STRING "EFI_LOCK_STATUS"
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"
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"
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"
141 #define EFI_FV_WEAK_ALIGNMENT_STRING "EFI_WEAK_ALIGNMENT"
146 #define EFI_FILE_NAME_STRING "EFI_FILE_NAME"
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"
157 #define EFI_FV_EXT_HEADER_FILE_NAME "EFI_FV_EXT_HEADER_FILE_NAME"
161 // VTF (Firmware Volume Top File) signatures
163 #define IA32_X64_VTF_SIGNATURE_OFFSET 0x14
164 #define IA32_X64_VTF0_SIGNATURE SIGNATURE_32('V','T','F',0)
167 // Defines to calculate the offset for PEI CORE entry points
169 #define IA32_PEI_CORE_ENTRY_OFFSET 0x20
172 // Defines to calculate the offset for IA32 SEC CORE entry point
174 #define IA32_SEC_CORE_ENTRY_OFFSET 0xD
177 // Symbol file definitions, current max size if 512K
179 #define SYMBOL_FILE_SIZE 0x80000
181 #define FV_IMAGES_TOP_ADDRESS 0x100000000ULL
184 // Following definition is used for FIT in IPF
186 #define COMP_TYPE_FIT_PEICORE 0x10
187 #define COMP_TYPE_FIT_UNUSED 0x7F
189 #define FIT_TYPE_MASK 0x7F
190 #define CHECKSUM_BIT_MASK 0x80
193 // Private data types
196 // Component information
200 CHAR8 ComponentName
[MAX_LONG_FILE_PATH
];
204 // FV and capsule information holder
207 BOOLEAN BaseAddressSet
;
208 EFI_PHYSICAL_ADDRESS BaseAddress
;
209 EFI_GUID FvFileSystemGuid
;
210 BOOLEAN FvFileSystemGuidSet
;
212 BOOLEAN FvNameGuidSet
;
213 CHAR8 FvExtHeaderFile
[MAX_LONG_FILE_PATH
];
215 EFI_FVB_ATTRIBUTES_2 FvAttributes
;
216 CHAR8 FvName
[MAX_LONG_FILE_PATH
];
217 EFI_FV_BLOCK_MAP_ENTRY FvBlocks
[MAX_NUMBER_OF_FV_BLOCKS
];
218 CHAR8 FvFiles
[MAX_NUMBER_OF_FILES_IN_FV
][MAX_LONG_FILE_PATH
];
219 UINT32 SizeofFvFiles
[MAX_NUMBER_OF_FILES_IN_FV
];
228 CHAR8 CapName
[MAX_LONG_FILE_PATH
];
229 CHAR8 CapFiles
[MAX_NUMBER_OF_FILES_IN_CAP
][MAX_LONG_FILE_PATH
];
244 #define FV_DEFAULT_ATTRIBUTE 0x0004FEFF
245 extern FV_INFO mFvDataInfo
;
246 extern CAP_INFO mCapDataInfo
;
247 extern EFI_GUID mEfiFirmwareFileSystem2Guid
;
248 extern EFI_GUID mEfiFirmwareFileSystem3Guid
;
249 extern UINT32 mFvTotalSize
;
250 extern UINT32 mFvTakenSize
;
252 extern EFI_PHYSICAL_ADDRESS mFvBaseAddress
[];
253 extern UINT32 mFvBaseAddressNumber
;
255 // Local function prototypes
259 IN MEMORY_FILE
*InfFile
,
265 UpdatePeiCoreEntryInFit (
266 IN FIT_TABLE
*FitTablePtr
,
267 IN UINT64 PeiCorePhysicalAddress
273 This function is used to update the Pei Core address in FIT, this can be used by Sec core to pass control from
278 FitTablePtr - The pointer of FIT_TABLE.
279 PeiCorePhysicalAddress - The address of Pei Core entry.
283 EFI_SUCCESS - The PEI_CORE FIT entry was updated successfully.
284 EFI_NOT_FOUND - Not found the PEI_CORE FIT entry.
291 IN FIT_TABLE
*FitTablePtr
297 This function is used to update the checksum for FIT.
302 FitTablePtr - The pointer of FIT_TABLE.
314 OUT UINT32
*EntryPoint
,
315 OUT UINT32
*BaseOfCode
,
316 OUT UINT16
*MachineType
321 IN MEMORY_FILE
*InfFile
,
322 OUT CAP_INFO
*CapInfo
326 FindApResetVectorPosition (
327 IN MEMORY_FILE
*FvImage
,
338 IN OUT FV_INFO
*FvInfo
,
340 IN OUT EFI_FFS_FILE_HEADER
*FfsFile
,
346 // Exported function prototypes
350 IN CHAR8
*InfFileImage
,
351 IN UINTN InfFileSize
,
352 IN CHAR8
*CapFileName
358 This is the main function which will be called from application to
359 generate UEFI Capsule image.
363 InfFileImage Buffer containing the INF file contents.
364 InfFileSize Size of the contents of the InfFileImage buffer.
365 CapFileName Requested name for the Cap file.
369 EFI_SUCCESS Function completed successfully.
370 EFI_OUT_OF_RESOURCES Could not allocate required resources.
371 EFI_ABORTED Error encountered.
372 EFI_INVALID_PARAMETER A required parameter was NULL.
379 IN CHAR8
*InfFileImage
,
380 IN UINTN InfFileSize
,
381 IN CHAR8
*FvFileName
,
382 IN CHAR8
*MapFileName
388 This is the main function which will be called from application to
389 generate Firmware Image conforms to PI spec.
393 InfFileImage Buffer containing the INF file contents.
394 InfFileSize Size of the contents of the InfFileImage buffer.
395 FvFileName Requested name for the FV file.
396 MapFileName Fv map file to log fv driver information.
400 EFI_SUCCESS Function completed successfully.
401 EFI_OUT_OF_RESOURCES Could not allocate required resources.
402 EFI_ABORTED Error encountered.
403 EFI_INVALID_PARAMETER A required parameter was NULL.