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