BaseTools/GenFv: Account for rebase of FV section containing VTF file
[mirror_edk2.git] / BaseTools / Source / C / GenFv / GenFvInternalLib.c
1 /** @file
2 This file contains the internal functions required to generate a Firmware Volume.
3
4 Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>
5 Portions Copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.<BR>
6 Portions Copyright (c) 2016 HP Development Company, L.P.<BR>
7 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 **/
16
17 //
18 // Include files
19 //
20
21 #if defined(__FreeBSD__)
22 #include <uuid.h>
23 #elif defined(__GNUC__)
24 #include <uuid/uuid.h>
25 #endif
26 #ifdef __GNUC__
27 #include <sys/stat.h>
28 #endif
29 #include <string.h>
30 #ifndef __GNUC__
31 #include <io.h>
32 #endif
33 #include <assert.h>
34
35 #include <Guid/FfsSectionAlignmentPadding.h>
36
37 #include "GenFvInternalLib.h"
38 #include "FvLib.h"
39 #include "PeCoffLib.h"
40 #include "WinNtInclude.h"
41
42 #define ARMT_UNCONDITIONAL_JUMP_INSTRUCTION 0xEB000000
43 #define ARM64_UNCONDITIONAL_JUMP_INSTRUCTION 0x14000000
44
45 BOOLEAN mArm = FALSE;
46 STATIC UINT32 MaxFfsAlignment = 0;
47
48 EFI_GUID mEfiFirmwareVolumeTopFileGuid = EFI_FFS_VOLUME_TOP_FILE_GUID;
49 EFI_GUID mFileGuidArray [MAX_NUMBER_OF_FILES_IN_FV];
50 EFI_GUID mZeroGuid = {0x0, 0x0, 0x0, {0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0}};
51 EFI_GUID mDefaultCapsuleGuid = {0x3B6686BD, 0x0D76, 0x4030, { 0xB7, 0x0E, 0xB5, 0x51, 0x9E, 0x2F, 0xC5, 0xA0 }};
52 EFI_GUID mEfiFfsSectionAlignmentPaddingGuid = EFI_FFS_SECTION_ALIGNMENT_PADDING_GUID;
53
54 CHAR8 *mFvbAttributeName[] = {
55 EFI_FVB2_READ_DISABLED_CAP_STRING,
56 EFI_FVB2_READ_ENABLED_CAP_STRING,
57 EFI_FVB2_READ_STATUS_STRING,
58 EFI_FVB2_WRITE_DISABLED_CAP_STRING,
59 EFI_FVB2_WRITE_ENABLED_CAP_STRING,
60 EFI_FVB2_WRITE_STATUS_STRING,
61 EFI_FVB2_LOCK_CAP_STRING,
62 EFI_FVB2_LOCK_STATUS_STRING,
63 NULL,
64 EFI_FVB2_STICKY_WRITE_STRING,
65 EFI_FVB2_MEMORY_MAPPED_STRING,
66 EFI_FVB2_ERASE_POLARITY_STRING,
67 EFI_FVB2_READ_LOCK_CAP_STRING,
68 EFI_FVB2_READ_LOCK_STATUS_STRING,
69 EFI_FVB2_WRITE_LOCK_CAP_STRING,
70 EFI_FVB2_WRITE_LOCK_STATUS_STRING
71 };
72
73 CHAR8 *mFvbAlignmentName[] = {
74 EFI_FVB2_ALIGNMENT_1_STRING,
75 EFI_FVB2_ALIGNMENT_2_STRING,
76 EFI_FVB2_ALIGNMENT_4_STRING,
77 EFI_FVB2_ALIGNMENT_8_STRING,
78 EFI_FVB2_ALIGNMENT_16_STRING,
79 EFI_FVB2_ALIGNMENT_32_STRING,
80 EFI_FVB2_ALIGNMENT_64_STRING,
81 EFI_FVB2_ALIGNMENT_128_STRING,
82 EFI_FVB2_ALIGNMENT_256_STRING,
83 EFI_FVB2_ALIGNMENT_512_STRING,
84 EFI_FVB2_ALIGNMENT_1K_STRING,
85 EFI_FVB2_ALIGNMENT_2K_STRING,
86 EFI_FVB2_ALIGNMENT_4K_STRING,
87 EFI_FVB2_ALIGNMENT_8K_STRING,
88 EFI_FVB2_ALIGNMENT_16K_STRING,
89 EFI_FVB2_ALIGNMENT_32K_STRING,
90 EFI_FVB2_ALIGNMENT_64K_STRING,
91 EFI_FVB2_ALIGNMENT_128K_STRING,
92 EFI_FVB2_ALIGNMENT_256K_STRING,
93 EFI_FVB2_ALIGNMENT_512K_STRING,
94 EFI_FVB2_ALIGNMENT_1M_STRING,
95 EFI_FVB2_ALIGNMENT_2M_STRING,
96 EFI_FVB2_ALIGNMENT_4M_STRING,
97 EFI_FVB2_ALIGNMENT_8M_STRING,
98 EFI_FVB2_ALIGNMENT_16M_STRING,
99 EFI_FVB2_ALIGNMENT_32M_STRING,
100 EFI_FVB2_ALIGNMENT_64M_STRING,
101 EFI_FVB2_ALIGNMENT_128M_STRING,
102 EFI_FVB2_ALIGNMENT_256M_STRING,
103 EFI_FVB2_ALIGNMENT_512M_STRING,
104 EFI_FVB2_ALIGNMENT_1G_STRING,
105 EFI_FVB2_ALIGNMENT_2G_STRING
106 };
107
108 //
109 // This data array will be located at the base of the Firmware Volume Header (FVH)
110 // in the boot block. It must not exceed 14 bytes of code. The last 2 bytes
111 // will be used to keep the FVH checksum consistent.
112 // This code will be run in response to a starutp IPI for HT-enabled systems.
113 //
114 #define SIZEOF_STARTUP_DATA_ARRAY 0x10
115
116 UINT8 m128kRecoveryStartupApDataArray[SIZEOF_STARTUP_DATA_ARRAY] = {
117 //
118 // EA D0 FF 00 F0 ; far jmp F000:FFD0
119 // 0, 0, 0, 0, 0, 0, 0, 0, 0, ; Reserved bytes
120 // 0, 0 ; Checksum Padding
121 //
122 0xEA,
123 0xD0,
124 0xFF,
125 0x0,
126 0xF0,
127 0x00,
128 0x00,
129 0x00,
130 0x00,
131 0x00,
132 0x00,
133 0x00,
134 0x00,
135 0x00,
136 0x00,
137 0x00
138 };
139
140 UINT8 m64kRecoveryStartupApDataArray[SIZEOF_STARTUP_DATA_ARRAY] = {
141 //
142 // EB CE ; jmp short ($-0x30)
143 // ; (from offset 0x0 to offset 0xFFD0)
144 // 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, ; Reserved bytes
145 // 0, 0 ; Checksum Padding
146 //
147 0xEB,
148 0xCE,
149 0x00,
150 0x00,
151 0x00,
152 0x00,
153 0x00,
154 0x00,
155 0x00,
156 0x00,
157 0x00,
158 0x00,
159 0x00,
160 0x00,
161 0x00,
162 0x00
163 };
164
165 FV_INFO mFvDataInfo;
166 CAP_INFO mCapDataInfo;
167 BOOLEAN mIsLargeFfs = FALSE;
168
169 EFI_PHYSICAL_ADDRESS mFvBaseAddress[0x10];
170 UINT32 mFvBaseAddressNumber = 0;
171
172 EFI_STATUS
173 ParseFvInf (
174 IN MEMORY_FILE *InfFile,
175 OUT FV_INFO *FvInfo
176 )
177 /*++
178
179 Routine Description:
180
181 This function parses a FV.INF file and copies info into a FV_INFO structure.
182
183 Arguments:
184
185 InfFile Memory file image.
186 FvInfo Information read from INF file.
187
188 Returns:
189
190 EFI_SUCCESS INF file information successfully retrieved.
191 EFI_ABORTED INF file has an invalid format.
192 EFI_NOT_FOUND A required string was not found in the INF file.
193 --*/
194 {
195 CHAR8 Value[MAX_LONG_FILE_PATH];
196 UINT64 Value64;
197 UINTN Index;
198 UINTN Number;
199 EFI_STATUS Status;
200 EFI_GUID GuidValue;
201
202 //
203 // Read the FV base address
204 //
205 if (!mFvDataInfo.BaseAddressSet) {
206 Status = FindToken (InfFile, OPTIONS_SECTION_STRING, EFI_FV_BASE_ADDRESS_STRING, 0, Value);
207 if (Status == EFI_SUCCESS) {
208 //
209 // Get the base address
210 //
211 Status = AsciiStringToUint64 (Value, FALSE, &Value64);
212 if (EFI_ERROR (Status)) {
213 Error (NULL, 0, 2000, "Invalid parameter", "%s = %s", EFI_FV_BASE_ADDRESS_STRING, Value);
214 return EFI_ABORTED;
215 }
216 DebugMsg (NULL, 0, 9, "rebase address", "%s = %s", EFI_FV_BASE_ADDRESS_STRING, Value);
217
218 FvInfo->BaseAddress = Value64;
219 FvInfo->BaseAddressSet = TRUE;
220 }
221 }
222
223 //
224 // Read the FV File System Guid
225 //
226 if (!FvInfo->FvFileSystemGuidSet) {
227 Status = FindToken (InfFile, OPTIONS_SECTION_STRING, EFI_FV_FILESYSTEMGUID_STRING, 0, Value);
228 if (Status == EFI_SUCCESS) {
229 //
230 // Get the guid value
231 //
232 Status = StringToGuid (Value, &GuidValue);
233 if (EFI_ERROR (Status)) {
234 Error (NULL, 0, 2000, "Invalid parameter", "%s = %s", EFI_FV_FILESYSTEMGUID_STRING, Value);
235 return EFI_ABORTED;
236 }
237 memcpy (&FvInfo->FvFileSystemGuid, &GuidValue, sizeof (EFI_GUID));
238 FvInfo->FvFileSystemGuidSet = TRUE;
239 }
240 }
241
242 //
243 // Read the FV Extension Header File Name
244 //
245 Status = FindToken (InfFile, ATTRIBUTES_SECTION_STRING, EFI_FV_EXT_HEADER_FILE_NAME, 0, Value);
246 if (Status == EFI_SUCCESS) {
247 strcpy (FvInfo->FvExtHeaderFile, Value);
248 }
249
250 //
251 // Read the FV file name
252 //
253 Status = FindToken (InfFile, OPTIONS_SECTION_STRING, EFI_FV_FILE_NAME_STRING, 0, Value);
254 if (Status == EFI_SUCCESS) {
255 //
256 // copy the file name
257 //
258 strcpy (FvInfo->FvName, Value);
259 }
260
261 //
262 // Read Fv Attribute
263 //
264 for (Index = 0; Index < sizeof (mFvbAttributeName)/sizeof (CHAR8 *); Index ++) {
265 if ((mFvbAttributeName [Index] != NULL) && \
266 (FindToken (InfFile, ATTRIBUTES_SECTION_STRING, mFvbAttributeName [Index], 0, Value) == EFI_SUCCESS)) {
267 if ((strcmp (Value, TRUE_STRING) == 0) || (strcmp (Value, ONE_STRING) == 0)) {
268 FvInfo->FvAttributes |= 1 << Index;
269 } else if ((strcmp (Value, FALSE_STRING) != 0) && (strcmp (Value, ZERO_STRING) != 0)) {
270 Error (NULL, 0, 2000, "Invalid parameter", "%s expected %s | %s", mFvbAttributeName [Index], TRUE_STRING, FALSE_STRING);
271 return EFI_ABORTED;
272 }
273 }
274 }
275
276 //
277 // Read Fv Alignment
278 //
279 for (Index = 0; Index < sizeof (mFvbAlignmentName)/sizeof (CHAR8 *); Index ++) {
280 if (FindToken (InfFile, ATTRIBUTES_SECTION_STRING, mFvbAlignmentName [Index], 0, Value) == EFI_SUCCESS) {
281 if (strcmp (Value, TRUE_STRING) == 0) {
282 FvInfo->FvAttributes |= Index << 16;
283 DebugMsg (NULL, 0, 9, "FV file alignment", "Align = %s", mFvbAlignmentName [Index]);
284 break;
285 }
286 }
287 }
288
289 //
290 // Read weak alignment flag
291 //
292 Status = FindToken (InfFile, ATTRIBUTES_SECTION_STRING, EFI_FV_WEAK_ALIGNMENT_STRING, 0, Value);
293 if (Status == EFI_SUCCESS) {
294 if ((strcmp (Value, TRUE_STRING) == 0) || (strcmp (Value, ONE_STRING) == 0)) {
295 FvInfo->FvAttributes |= EFI_FVB2_WEAK_ALIGNMENT;
296 } else if ((strcmp (Value, FALSE_STRING) != 0) && (strcmp (Value, ZERO_STRING) != 0)) {
297 Error (NULL, 0, 2000, "Invalid parameter", "Weak alignment value expected one of TRUE, FALSE, 1 or 0.");
298 return EFI_ABORTED;
299 }
300 }
301
302 //
303 // Read block maps
304 //
305 for (Index = 0; Index < MAX_NUMBER_OF_FV_BLOCKS; Index++) {
306 if (FvInfo->FvBlocks[Index].Length == 0) {
307 //
308 // Read block size
309 //
310 Status = FindToken (InfFile, OPTIONS_SECTION_STRING, EFI_BLOCK_SIZE_STRING, Index, Value);
311
312 if (Status == EFI_SUCCESS) {
313 //
314 // Update the size of block
315 //
316 Status = AsciiStringToUint64 (Value, FALSE, &Value64);
317 if (EFI_ERROR (Status)) {
318 Error (NULL, 0, 2000, "Invalid parameter", "%s = %s", EFI_BLOCK_SIZE_STRING, Value);
319 return EFI_ABORTED;
320 }
321
322 FvInfo->FvBlocks[Index].Length = (UINT32) Value64;
323 DebugMsg (NULL, 0, 9, "FV Block Size", "%s = %s", EFI_BLOCK_SIZE_STRING, Value);
324 } else {
325 //
326 // If there is no blocks size, but there is the number of block, then we have a mismatched pair
327 // and should return an error.
328 //
329 Status = FindToken (InfFile, OPTIONS_SECTION_STRING, EFI_NUM_BLOCKS_STRING, Index, Value);
330 if (!EFI_ERROR (Status)) {
331 Error (NULL, 0, 2000, "Invalid parameter", "both %s and %s must be specified.", EFI_NUM_BLOCKS_STRING, EFI_BLOCK_SIZE_STRING);
332 return EFI_ABORTED;
333 } else {
334 //
335 // We are done
336 //
337 break;
338 }
339 }
340
341 //
342 // Read blocks number
343 //
344 Status = FindToken (InfFile, OPTIONS_SECTION_STRING, EFI_NUM_BLOCKS_STRING, Index, Value);
345
346 if (Status == EFI_SUCCESS) {
347 //
348 // Update the number of blocks
349 //
350 Status = AsciiStringToUint64 (Value, FALSE, &Value64);
351 if (EFI_ERROR (Status)) {
352 Error (NULL, 0, 2000, "Invalid parameter", "%s = %s", EFI_NUM_BLOCKS_STRING, Value);
353 return EFI_ABORTED;
354 }
355
356 FvInfo->FvBlocks[Index].NumBlocks = (UINT32) Value64;
357 DebugMsg (NULL, 0, 9, "FV Block Number", "%s = %s", EFI_NUM_BLOCKS_STRING, Value);
358 }
359 }
360 }
361
362 if (Index == 0) {
363 Error (NULL, 0, 2001, "Missing required argument", "block size.");
364 return EFI_ABORTED;
365 }
366
367 //
368 // Read files
369 //
370 Number = 0;
371 for (Number = 0; Number < MAX_NUMBER_OF_FILES_IN_FV; Number ++) {
372 if (FvInfo->FvFiles[Number][0] == '\0') {
373 break;
374 }
375 }
376
377 for (Index = 0; Index < MAX_NUMBER_OF_FILES_IN_FV; Index++) {
378 //
379 // Read the FFS file list
380 //
381 Status = FindToken (InfFile, FILES_SECTION_STRING, EFI_FILE_NAME_STRING, Index, Value);
382
383 if (Status == EFI_SUCCESS) {
384 //
385 // Add the file
386 //
387 strcpy (FvInfo->FvFiles[Number + Index], Value);
388 DebugMsg (NULL, 0, 9, "FV component file", "the %uth name is %s", (unsigned) Index, Value);
389 } else {
390 break;
391 }
392 }
393
394 if ((Index + Number) == 0) {
395 Warning (NULL, 0, 0, "FV components are not specified.", NULL);
396 }
397
398 return EFI_SUCCESS;
399 }
400
401 VOID
402 UpdateFfsFileState (
403 IN EFI_FFS_FILE_HEADER *FfsFile,
404 IN EFI_FIRMWARE_VOLUME_HEADER *FvHeader
405 )
406 /*++
407
408 Routine Description:
409
410 This function changes the FFS file attributes based on the erase polarity
411 of the FV. Update the reserved bits of State to EFI_FVB2_ERASE_POLARITY.
412
413 Arguments:
414
415 FfsFile File header.
416 FvHeader FV header.
417
418 Returns:
419
420 None
421
422 --*/
423 {
424 if (FvHeader->Attributes & EFI_FVB2_ERASE_POLARITY) {
425 FfsFile->State = (UINT8)~(FfsFile->State);
426 // FfsFile->State |= ~(UINT8) EFI_FILE_ALL_STATE_BITS;
427 }
428 }
429
430 EFI_STATUS
431 ReadFfsAlignment (
432 IN EFI_FFS_FILE_HEADER *FfsFile,
433 IN OUT UINT32 *Alignment
434 )
435 /*++
436
437 Routine Description:
438
439 This function determines the alignment of the FFS input file from the file
440 attributes.
441
442 Arguments:
443
444 FfsFile FFS file to parse
445 Alignment The minimum required alignment offset of the FFS file
446
447 Returns:
448
449 EFI_SUCCESS The function completed successfully.
450 EFI_INVALID_PARAMETER One of the input parameters was invalid.
451 EFI_ABORTED An error occurred.
452
453 --*/
454 {
455 //
456 // Verify input parameters.
457 //
458 if (FfsFile == NULL || Alignment == NULL) {
459 return EFI_INVALID_PARAMETER;
460 }
461
462 switch ((FfsFile->Attributes >> 3) & 0x07) {
463
464 case 0:
465 //
466 // 1 byte alignment
467 //
468 *Alignment = 0;
469 break;
470
471 case 1:
472 //
473 // 16 byte alignment
474 //
475 *Alignment = 4;
476 break;
477
478 case 2:
479 //
480 // 128 byte alignment
481 //
482 *Alignment = 7;
483 break;
484
485 case 3:
486 //
487 // 512 byte alignment
488 //
489 *Alignment = 9;
490 break;
491
492 case 4:
493 //
494 // 1K byte alignment
495 //
496 *Alignment = 10;
497 break;
498
499 case 5:
500 //
501 // 4K byte alignment
502 //
503 *Alignment = 12;
504 break;
505
506 case 6:
507 //
508 // 32K byte alignment
509 //
510 *Alignment = 15;
511 break;
512
513 case 7:
514 //
515 // 64K byte alignment
516 //
517 *Alignment = 16;
518 break;
519
520 default:
521 break;
522 }
523
524 return EFI_SUCCESS;
525 }
526
527 EFI_STATUS
528 AddPadFile (
529 IN OUT MEMORY_FILE *FvImage,
530 IN UINT32 DataAlignment,
531 IN VOID *FvEnd,
532 IN EFI_FIRMWARE_VOLUME_EXT_HEADER *ExtHeader,
533 IN UINT32 NextFfsSize
534 )
535 /*++
536
537 Routine Description:
538
539 This function adds a pad file to the FV image if it required to align the
540 data of the next file.
541
542 Arguments:
543
544 FvImage The memory image of the FV to add it to.
545 The current offset must be valid.
546 DataAlignment The data alignment of the next FFS file.
547 FvEnd End of the empty data in FvImage.
548 ExtHeader PI FvExtHeader Optional
549
550 Returns:
551
552 EFI_SUCCESS The function completed successfully.
553 EFI_INVALID_PARAMETER One of the input parameters was invalid.
554 EFI_OUT_OF_RESOURCES Insufficient resources exist in the FV to complete
555 the pad file add.
556
557 --*/
558 {
559 EFI_FFS_FILE_HEADER *PadFile;
560 UINTN PadFileSize;
561 UINT32 NextFfsHeaderSize;
562 UINT32 CurFfsHeaderSize;
563
564 CurFfsHeaderSize = sizeof (EFI_FFS_FILE_HEADER);
565 //
566 // Verify input parameters.
567 //
568 if (FvImage == NULL) {
569 return EFI_INVALID_PARAMETER;
570 }
571
572 //
573 // Calculate the pad file size
574 //
575
576 //
577 // Append extension header size
578 //
579 if (ExtHeader != NULL) {
580 PadFileSize = ExtHeader->ExtHeaderSize;
581 if (PadFileSize + sizeof (EFI_FFS_FILE_HEADER) >= MAX_FFS_SIZE) {
582 CurFfsHeaderSize = sizeof (EFI_FFS_FILE_HEADER2);
583 }
584 PadFileSize += CurFfsHeaderSize;
585 } else {
586 NextFfsHeaderSize = sizeof (EFI_FFS_FILE_HEADER);
587 if (NextFfsSize >= MAX_FFS_SIZE) {
588 NextFfsHeaderSize = sizeof (EFI_FFS_FILE_HEADER2);
589 }
590 //
591 // Check if a pad file is necessary
592 //
593 if (((UINTN) FvImage->CurrentFilePointer - (UINTN) FvImage->FileImage + NextFfsHeaderSize) % DataAlignment == 0) {
594 return EFI_SUCCESS;
595 }
596 PadFileSize = (UINTN) FvImage->CurrentFilePointer - (UINTN) FvImage->FileImage + sizeof (EFI_FFS_FILE_HEADER) + NextFfsHeaderSize;
597 //
598 // Add whatever it takes to get to the next aligned address
599 //
600 while ((PadFileSize % DataAlignment) != 0) {
601 PadFileSize++;
602 }
603 //
604 // Subtract the next file header size
605 //
606 PadFileSize -= NextFfsHeaderSize;
607 //
608 // Subtract the starting offset to get size
609 //
610 PadFileSize -= (UINTN) FvImage->CurrentFilePointer - (UINTN) FvImage->FileImage;
611 }
612
613 //
614 // Verify that we have enough space for the file header
615 //
616 if (((UINTN) FvImage->CurrentFilePointer + PadFileSize) > (UINTN) FvEnd) {
617 return EFI_OUT_OF_RESOURCES;
618 }
619
620 //
621 // Write pad file header
622 //
623 PadFile = (EFI_FFS_FILE_HEADER *) FvImage->CurrentFilePointer;
624
625 //
626 // Write PadFile FFS header with PadType, don't need to set PAD file guid in its header.
627 //
628 PadFile->Type = EFI_FV_FILETYPE_FFS_PAD;
629 PadFile->Attributes = 0;
630
631 //
632 // Write pad file size (calculated size minus next file header size)
633 //
634 if (PadFileSize >= MAX_FFS_SIZE) {
635 memset(PadFile->Size, 0, sizeof(UINT8) * 3);
636 ((EFI_FFS_FILE_HEADER2 *)PadFile)->ExtendedSize = PadFileSize;
637 PadFile->Attributes |= FFS_ATTRIB_LARGE_FILE;
638 } else {
639 PadFile->Size[0] = (UINT8) (PadFileSize & 0xFF);
640 PadFile->Size[1] = (UINT8) ((PadFileSize >> 8) & 0xFF);
641 PadFile->Size[2] = (UINT8) ((PadFileSize >> 16) & 0xFF);
642 }
643
644 //
645 // Fill in checksums and state, they must be 0 for checksumming.
646 //
647 PadFile->IntegrityCheck.Checksum.Header = 0;
648 PadFile->IntegrityCheck.Checksum.File = 0;
649 PadFile->State = 0;
650 PadFile->IntegrityCheck.Checksum.Header = CalculateChecksum8 ((UINT8 *) PadFile, CurFfsHeaderSize);
651 PadFile->IntegrityCheck.Checksum.File = FFS_FIXED_CHECKSUM;
652
653 PadFile->State = EFI_FILE_HEADER_CONSTRUCTION | EFI_FILE_HEADER_VALID | EFI_FILE_DATA_VALID;
654 UpdateFfsFileState (
655 (EFI_FFS_FILE_HEADER *) PadFile,
656 (EFI_FIRMWARE_VOLUME_HEADER *) FvImage->FileImage
657 );
658
659 //
660 // Update the current FV pointer
661 //
662 FvImage->CurrentFilePointer += PadFileSize;
663
664 if (ExtHeader != NULL) {
665 //
666 // Copy Fv Extension Header and Set Fv Extension header offset
667 //
668 memcpy ((UINT8 *)PadFile + CurFfsHeaderSize, ExtHeader, ExtHeader->ExtHeaderSize);
669 ((EFI_FIRMWARE_VOLUME_HEADER *) FvImage->FileImage)->ExtHeaderOffset = (UINT16) ((UINTN) ((UINT8 *)PadFile + CurFfsHeaderSize) - (UINTN) FvImage->FileImage);
670 //
671 // Make next file start at QWord Boundry
672 //
673 while (((UINTN) FvImage->CurrentFilePointer & (EFI_FFS_FILE_HEADER_ALIGNMENT - 1)) != 0) {
674 FvImage->CurrentFilePointer++;
675 }
676 }
677
678 return EFI_SUCCESS;
679 }
680
681 BOOLEAN
682 IsVtfFile (
683 IN EFI_FFS_FILE_HEADER *FileBuffer
684 )
685 /*++
686
687 Routine Description:
688
689 This function checks the header to validate if it is a VTF file
690
691 Arguments:
692
693 FileBuffer Buffer in which content of a file has been read.
694
695 Returns:
696
697 TRUE If this is a VTF file
698 FALSE If this is not a VTF file
699
700 --*/
701 {
702 if (!memcmp (&FileBuffer->Name, &mEfiFirmwareVolumeTopFileGuid, sizeof (EFI_GUID))) {
703 return TRUE;
704 } else {
705 return FALSE;
706 }
707 }
708
709 EFI_STATUS
710 WriteMapFile (
711 IN OUT FILE *FvMapFile,
712 IN CHAR8 *FileName,
713 IN EFI_FFS_FILE_HEADER *FfsFile,
714 IN EFI_PHYSICAL_ADDRESS ImageBaseAddress,
715 IN PE_COFF_LOADER_IMAGE_CONTEXT *pImageContext
716 )
717 /*++
718
719 Routine Description:
720
721 This function gets the basic debug information (entrypoint, baseaddress, .text, .data section base address)
722 from PE/COFF image and abstracts Pe Map file information and add them into FvMap file for Debug.
723
724 Arguments:
725
726 FvMapFile A pointer to FvMap File
727 FileName Ffs File PathName
728 FfsFile A pointer to Ffs file image.
729 ImageBaseAddress PeImage Base Address.
730 pImageContext Image Context Information.
731
732 Returns:
733
734 EFI_SUCCESS Added required map information.
735
736 --*/
737 {
738 CHAR8 PeMapFileName [MAX_LONG_FILE_PATH];
739 CHAR8 *Cptr, *Cptr2;
740 CHAR8 FileGuidName [MAX_LINE_LEN];
741 FILE *PeMapFile;
742 CHAR8 Line [MAX_LINE_LEN];
743 CHAR8 KeyWord [MAX_LINE_LEN];
744 CHAR8 FunctionName [MAX_LINE_LEN];
745 EFI_PHYSICAL_ADDRESS FunctionAddress;
746 UINT32 FunctionType;
747 CHAR8 FunctionTypeName [MAX_LINE_LEN];
748 UINT32 Index;
749 UINT32 AddressOfEntryPoint;
750 UINT32 Offset;
751 EFI_IMAGE_OPTIONAL_HEADER_UNION *ImgHdr;
752 EFI_TE_IMAGE_HEADER *TEImageHeader;
753 EFI_IMAGE_SECTION_HEADER *SectionHeader;
754 unsigned long long TempLongAddress;
755 UINT32 TextVirtualAddress;
756 UINT32 DataVirtualAddress;
757 EFI_PHYSICAL_ADDRESS LinkTimeBaseAddress;
758
759 //
760 // Init local variable
761 //
762 FunctionType = 0;
763 //
764 // Print FileGuid to string buffer.
765 //
766 PrintGuidToBuffer (&FfsFile->Name, (UINT8 *)FileGuidName, MAX_LINE_LEN, TRUE);
767
768 //
769 // Construct Map file Name
770 //
771 strcpy (PeMapFileName, FileName);
772
773 //
774 // Change '\\' to '/', unified path format.
775 //
776 Cptr = PeMapFileName;
777 while (*Cptr != '\0') {
778 if (*Cptr == '\\') {
779 *Cptr = FILE_SEP_CHAR;
780 }
781 Cptr ++;
782 }
783
784 //
785 // Get Map file
786 //
787 Cptr = PeMapFileName + strlen (PeMapFileName);
788 while ((*Cptr != '.') && (Cptr >= PeMapFileName)) {
789 Cptr --;
790 }
791 if (Cptr < PeMapFileName) {
792 return EFI_NOT_FOUND;
793 } else {
794 *(Cptr + 1) = 'm';
795 *(Cptr + 2) = 'a';
796 *(Cptr + 3) = 'p';
797 *(Cptr + 4) = '\0';
798 }
799
800 //
801 // Get module Name
802 //
803 Cptr2 = Cptr;
804 while ((*Cptr != FILE_SEP_CHAR) && (Cptr >= PeMapFileName)) {
805 Cptr --;
806 }
807 *Cptr2 = '\0';
808 strcpy (KeyWord, Cptr + 1);
809 *Cptr2 = '.';
810
811 //
812 // AddressOfEntryPoint and Offset in Image
813 //
814 if (!pImageContext->IsTeImage) {
815 ImgHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION *) ((UINT8 *) pImageContext->Handle + pImageContext->PeCoffHeaderOffset);
816 AddressOfEntryPoint = ImgHdr->Pe32.OptionalHeader.AddressOfEntryPoint;
817 Offset = 0;
818 SectionHeader = (EFI_IMAGE_SECTION_HEADER *) (
819 (UINT8 *) ImgHdr +
820 sizeof (UINT32) +
821 sizeof (EFI_IMAGE_FILE_HEADER) +
822 ImgHdr->Pe32.FileHeader.SizeOfOptionalHeader
823 );
824 Index = ImgHdr->Pe32.FileHeader.NumberOfSections;
825 } else {
826 TEImageHeader = (EFI_TE_IMAGE_HEADER *) pImageContext->Handle;
827 AddressOfEntryPoint = TEImageHeader->AddressOfEntryPoint;
828 Offset = TEImageHeader->StrippedSize - sizeof (EFI_TE_IMAGE_HEADER);
829 SectionHeader = (EFI_IMAGE_SECTION_HEADER *) (TEImageHeader + 1);
830 Index = TEImageHeader->NumberOfSections;
831 }
832
833 //
834 // module information output
835 //
836 if (ImageBaseAddress == 0) {
837 fprintf (FvMapFile, "%s (dummy) (", KeyWord);
838 fprintf (FvMapFile, "BaseAddress=%010llx, ", (unsigned long long) ImageBaseAddress);
839 } else {
840 fprintf (FvMapFile, "%s (Fixed Flash Address, ", KeyWord);
841 fprintf (FvMapFile, "BaseAddress=0x%010llx, ", (unsigned long long) (ImageBaseAddress + Offset));
842 }
843
844 if (FfsFile->Type != EFI_FV_FILETYPE_SECURITY_CORE && pImageContext->Machine == EFI_IMAGE_MACHINE_IA64) {
845 //
846 // Process IPF PLABEL to get the real address after the image has been rebased.
847 // PLABEL structure is got by AddressOfEntryPoint offset to ImageBuffer stored in pImageContext->Handle.
848 //
849 fprintf (FvMapFile, "EntryPoint=0x%010llx", (unsigned long long) (*(UINT64 *)((UINTN) pImageContext->Handle + (UINTN) AddressOfEntryPoint)));
850 } else {
851 fprintf (FvMapFile, "EntryPoint=0x%010llx", (unsigned long long) (ImageBaseAddress + AddressOfEntryPoint));
852 }
853 fprintf (FvMapFile, ")\n");
854
855 fprintf (FvMapFile, "(GUID=%s", FileGuidName);
856 TextVirtualAddress = 0;
857 DataVirtualAddress = 0;
858 for (; Index > 0; Index --, SectionHeader ++) {
859 if (stricmp ((CHAR8 *)SectionHeader->Name, ".text") == 0) {
860 TextVirtualAddress = SectionHeader->VirtualAddress;
861 } else if (stricmp ((CHAR8 *)SectionHeader->Name, ".data") == 0) {
862 DataVirtualAddress = SectionHeader->VirtualAddress;
863 } else if (stricmp ((CHAR8 *)SectionHeader->Name, ".sdata") == 0) {
864 DataVirtualAddress = SectionHeader->VirtualAddress;
865 }
866 }
867 fprintf (FvMapFile, " .textbaseaddress=0x%010llx", (unsigned long long) (ImageBaseAddress + TextVirtualAddress));
868 fprintf (FvMapFile, " .databaseaddress=0x%010llx", (unsigned long long) (ImageBaseAddress + DataVirtualAddress));
869 fprintf (FvMapFile, ")\n\n");
870
871 //
872 // Open PeMapFile
873 //
874 PeMapFile = fopen (LongFilePath (PeMapFileName), "r");
875 if (PeMapFile == NULL) {
876 // fprintf (stdout, "can't open %s file to reading\n", PeMapFileName);
877 return EFI_ABORTED;
878 }
879 VerboseMsg ("The map file is %s", PeMapFileName);
880
881 //
882 // Output Functions information into Fv Map file
883 //
884 LinkTimeBaseAddress = 0;
885 while (fgets (Line, MAX_LINE_LEN, PeMapFile) != NULL) {
886 //
887 // Skip blank line
888 //
889 if (Line[0] == 0x0a) {
890 FunctionType = 0;
891 continue;
892 }
893 //
894 // By Address and Static keyword
895 //
896 if (FunctionType == 0) {
897 sscanf (Line, "%s", KeyWord);
898 if (stricmp (KeyWord, "Address") == 0) {
899 //
900 // function list
901 //
902 FunctionType = 1;
903 fgets (Line, MAX_LINE_LEN, PeMapFile);
904 } else if (stricmp (KeyWord, "Static") == 0) {
905 //
906 // static function list
907 //
908 FunctionType = 2;
909 fgets (Line, MAX_LINE_LEN, PeMapFile);
910 } else if (stricmp (KeyWord, "Preferred") ==0) {
911 sscanf (Line + strlen (" Preferred load address is"), "%llx", &TempLongAddress);
912 LinkTimeBaseAddress = (UINT64) TempLongAddress;
913 }
914 continue;
915 }
916 //
917 // Printf Function Information
918 //
919 if (FunctionType == 1) {
920 sscanf (Line, "%s %s %llx %s", KeyWord, FunctionName, &TempLongAddress, FunctionTypeName);
921 FunctionAddress = (UINT64) TempLongAddress;
922 if (FunctionTypeName [1] == '\0' && (FunctionTypeName [0] == 'f' || FunctionTypeName [0] == 'F')) {
923 fprintf (FvMapFile, " 0x%010llx ", (unsigned long long) (ImageBaseAddress + FunctionAddress - LinkTimeBaseAddress));
924 fprintf (FvMapFile, "%s\n", FunctionName);
925 }
926 } else if (FunctionType == 2) {
927 sscanf (Line, "%s %s %llx %s", KeyWord, FunctionName, &TempLongAddress, FunctionTypeName);
928 FunctionAddress = (UINT64) TempLongAddress;
929 if (FunctionTypeName [1] == '\0' && (FunctionTypeName [0] == 'f' || FunctionTypeName [0] == 'F')) {
930 fprintf (FvMapFile, " 0x%010llx ", (unsigned long long) (ImageBaseAddress + FunctionAddress - LinkTimeBaseAddress));
931 fprintf (FvMapFile, "%s\n", FunctionName);
932 }
933 }
934 }
935 //
936 // Close PeMap file
937 //
938 fprintf (FvMapFile, "\n\n");
939 fclose (PeMapFile);
940
941 return EFI_SUCCESS;
942 }
943
944 STATIC
945 BOOLEAN
946 AdjustInternalFfsPadding (
947 IN OUT EFI_FFS_FILE_HEADER *FfsFile,
948 IN OUT MEMORY_FILE *FvImage,
949 IN UINTN Alignment,
950 IN OUT UINTN *FileSize
951 )
952 /*++
953
954 Routine Description:
955
956 This function looks for a dedicated alignment padding section in the FFS, and
957 shrinks it to the size required to line up subsequent sections correctly.
958
959 Arguments:
960
961 FfsFile A pointer to Ffs file image.
962 FvImage The memory image of the FV to adjust it to.
963 Alignment Current file alignment
964 FileSize Reference to a variable holding the size of the FFS file
965
966 Returns:
967
968 TRUE Padding section was found and updated successfully
969 FALSE Otherwise
970
971 --*/
972 {
973 EFI_FILE_SECTION_POINTER PadSection;
974 UINT8 *Remainder;
975 EFI_STATUS Status;
976 UINT32 FfsHeaderLength;
977 UINT32 FfsFileLength;
978 UINT32 PadSize;
979 UINTN Misalignment;
980 EFI_FFS_INTEGRITY_CHECK *IntegrityCheck;
981
982 //
983 // Figure out the misalignment: all FFS sections are aligned relative to the
984 // start of the FFS payload, so use that as the base of the misalignment
985 // computation.
986 //
987 FfsHeaderLength = GetFfsHeaderLength(FfsFile);
988 Misalignment = (UINTN) FvImage->CurrentFilePointer -
989 (UINTN) FvImage->FileImage + FfsHeaderLength;
990 Misalignment &= Alignment - 1;
991 if (Misalignment == 0) {
992 // Nothing to do, return success
993 return TRUE;
994 }
995
996 //
997 // We only apply this optimization to FFS files with the FIXED attribute set,
998 // since the FFS will not be loadable at arbitrary offsets anymore after
999 // we adjust the size of the padding section.
1000 //
1001 if ((FfsFile->Attributes & FFS_ATTRIB_FIXED) == 0) {
1002 return FALSE;
1003 }
1004
1005 //
1006 // Look for a dedicated padding section that we can adjust to compensate
1007 // for the misalignment. If such a padding section exists, it precedes all
1008 // sections with alignment requirements, and so the adjustment will correct
1009 // all of them.
1010 //
1011 Status = GetSectionByType (FfsFile, EFI_SECTION_FREEFORM_SUBTYPE_GUID, 1,
1012 &PadSection);
1013 if (EFI_ERROR (Status) ||
1014 CompareGuid (&PadSection.FreeformSubtypeSection->SubTypeGuid,
1015 &mEfiFfsSectionAlignmentPaddingGuid) != 0) {
1016 return FALSE;
1017 }
1018
1019 //
1020 // Find out if the size of the padding section is sufficient to compensate
1021 // for the misalignment.
1022 //
1023 PadSize = GetSectionFileLength (PadSection.CommonHeader);
1024 if (Misalignment > PadSize - sizeof (EFI_FREEFORM_SUBTYPE_GUID_SECTION)) {
1025 return FALSE;
1026 }
1027
1028 //
1029 // Move the remainder of the FFS file towards the front, and adjust the
1030 // file size output parameter.
1031 //
1032 Remainder = (UINT8 *) PadSection.CommonHeader + PadSize;
1033 memmove (Remainder - Misalignment, Remainder,
1034 *FileSize - (UINTN) (Remainder - (UINTN) FfsFile));
1035 *FileSize -= Misalignment;
1036
1037 //
1038 // Update the padding section's length with the new values. Note that the
1039 // padding is always < 64 KB, so we can ignore EFI_COMMON_SECTION_HEADER2
1040 // ExtendedSize.
1041 //
1042 PadSize -= Misalignment;
1043 PadSection.CommonHeader->Size[0] = (UINT8) (PadSize & 0xff);
1044 PadSection.CommonHeader->Size[1] = (UINT8) ((PadSize & 0xff00) >> 8);
1045 PadSection.CommonHeader->Size[2] = (UINT8) ((PadSize & 0xff0000) >> 16);
1046
1047 //
1048 // Update the FFS header with the new overall length
1049 //
1050 FfsFileLength = GetFfsFileLength (FfsFile) - Misalignment;
1051 if (FfsHeaderLength > sizeof(EFI_FFS_FILE_HEADER)) {
1052 ((EFI_FFS_FILE_HEADER2 *)FfsFile)->ExtendedSize = FfsFileLength;
1053 } else {
1054 FfsFile->Size[0] = (UINT8) (FfsFileLength & 0x000000FF);
1055 FfsFile->Size[1] = (UINT8) ((FfsFileLength & 0x0000FF00) >> 8);
1056 FfsFile->Size[2] = (UINT8) ((FfsFileLength & 0x00FF0000) >> 16);
1057 }
1058
1059 //
1060 // Clear the alignment bits: these have become meaningless now that we have
1061 // adjusted the padding section.
1062 //
1063 FfsFile->Attributes &= ~FFS_ATTRIB_DATA_ALIGNMENT;
1064
1065 //
1066 // Recalculate the FFS header checksum. Instead of setting Header and State
1067 // both to zero, set Header to (UINT8)(-State) so State preserves its original
1068 // value
1069 //
1070 IntegrityCheck = &FfsFile->IntegrityCheck;
1071 IntegrityCheck->Checksum.Header = (UINT8) (0x100 - FfsFile->State);
1072 IntegrityCheck->Checksum.File = 0;
1073
1074 IntegrityCheck->Checksum.Header = CalculateChecksum8 (
1075 (UINT8 *) FfsFile, FfsHeaderLength);
1076
1077 if (FfsFile->Attributes & FFS_ATTRIB_CHECKSUM) {
1078 //
1079 // Ffs header checksum = zero, so only need to calculate ffs body.
1080 //
1081 IntegrityCheck->Checksum.File = CalculateChecksum8 (
1082 (UINT8 *) FfsFile + FfsHeaderLength,
1083 FfsFileLength - FfsHeaderLength);
1084 } else {
1085 IntegrityCheck->Checksum.File = FFS_FIXED_CHECKSUM;
1086 }
1087
1088 return TRUE;
1089 }
1090
1091 EFI_STATUS
1092 AddFile (
1093 IN OUT MEMORY_FILE *FvImage,
1094 IN FV_INFO *FvInfo,
1095 IN UINTN Index,
1096 IN OUT EFI_FFS_FILE_HEADER **VtfFileImage,
1097 IN FILE *FvMapFile,
1098 IN FILE *FvReportFile
1099 )
1100 /*++
1101
1102 Routine Description:
1103
1104 This function adds a file to the FV image. The file will pad to the
1105 appropriate alignment if required.
1106
1107 Arguments:
1108
1109 FvImage The memory image of the FV to add it to. The current offset
1110 must be valid.
1111 FvInfo Pointer to information about the FV.
1112 Index The file in the FvInfo file list to add.
1113 VtfFileImage A pointer to the VTF file within the FvImage. If this is equal
1114 to the end of the FvImage then no VTF previously found.
1115 FvMapFile Pointer to FvMap File
1116 FvReportFile Pointer to FvReport File
1117
1118 Returns:
1119
1120 EFI_SUCCESS The function completed successfully.
1121 EFI_INVALID_PARAMETER One of the input parameters was invalid.
1122 EFI_ABORTED An error occurred.
1123 EFI_OUT_OF_RESOURCES Insufficient resources exist to complete the add.
1124
1125 --*/
1126 {
1127 FILE *NewFile;
1128 UINTN FileSize;
1129 UINT8 *FileBuffer;
1130 UINTN NumBytesRead;
1131 UINT32 CurrentFileAlignment;
1132 EFI_STATUS Status;
1133 UINTN Index1;
1134 UINT8 FileGuidString[PRINTED_GUID_BUFFER_SIZE];
1135
1136 Index1 = 0;
1137 //
1138 // Verify input parameters.
1139 //
1140 if (FvImage == NULL || FvInfo == NULL || FvInfo->FvFiles[Index][0] == 0 || VtfFileImage == NULL) {
1141 return EFI_INVALID_PARAMETER;
1142 }
1143
1144 //
1145 // Read the file to add
1146 //
1147 NewFile = fopen (LongFilePath (FvInfo->FvFiles[Index]), "rb");
1148
1149 if (NewFile == NULL) {
1150 Error (NULL, 0, 0001, "Error opening file", FvInfo->FvFiles[Index]);
1151 return EFI_ABORTED;
1152 }
1153
1154 //
1155 // Get the file size
1156 //
1157 FileSize = _filelength (fileno (NewFile));
1158
1159 //
1160 // Read the file into a buffer
1161 //
1162 FileBuffer = malloc (FileSize);
1163 if (FileBuffer == NULL) {
1164 Error (NULL, 0, 4001, "Resouce", "memory cannot be allocated!");
1165 return EFI_OUT_OF_RESOURCES;
1166 }
1167
1168 NumBytesRead = fread (FileBuffer, sizeof (UINT8), FileSize, NewFile);
1169
1170 //
1171 // Done with the file, from this point on we will just use the buffer read.
1172 //
1173 fclose (NewFile);
1174
1175 //
1176 // Verify read successful
1177 //
1178 if (NumBytesRead != sizeof (UINT8) * FileSize) {
1179 free (FileBuffer);
1180 Error (NULL, 0, 0004, "Error reading file", FvInfo->FvFiles[Index]);
1181 return EFI_ABORTED;
1182 }
1183
1184 //
1185 // For None PI Ffs file, directly add them into FvImage.
1186 //
1187 if (!FvInfo->IsPiFvImage) {
1188 memcpy (FvImage->CurrentFilePointer, FileBuffer, FileSize);
1189 if (FvInfo->SizeofFvFiles[Index] > FileSize) {
1190 FvImage->CurrentFilePointer += FvInfo->SizeofFvFiles[Index];
1191 } else {
1192 FvImage->CurrentFilePointer += FileSize;
1193 }
1194 goto Done;
1195 }
1196
1197 //
1198 // Verify Ffs file
1199 //
1200 Status = VerifyFfsFile ((EFI_FFS_FILE_HEADER *)FileBuffer);
1201 if (EFI_ERROR (Status)) {
1202 free (FileBuffer);
1203 Error (NULL, 0, 3000, "Invalid", "%s is not a valid FFS file.", FvInfo->FvFiles[Index]);
1204 return EFI_INVALID_PARAMETER;
1205 }
1206
1207 //
1208 // Verify space exists to add the file
1209 //
1210 if (FileSize > (UINTN) ((UINTN) *VtfFileImage - (UINTN) FvImage->CurrentFilePointer)) {
1211 free (FileBuffer);
1212 Error (NULL, 0, 4002, "Resource", "FV space is full, not enough room to add file %s.", FvInfo->FvFiles[Index]);
1213 return EFI_OUT_OF_RESOURCES;
1214 }
1215
1216 //
1217 // Verify the input file is the duplicated file in this Fv image
1218 //
1219 for (Index1 = 0; Index1 < Index; Index1 ++) {
1220 if (CompareGuid ((EFI_GUID *) FileBuffer, &mFileGuidArray [Index1]) == 0) {
1221 Error (NULL, 0, 2000, "Invalid parameter", "the %dth file and %uth file have the same file GUID.", (unsigned) Index1 + 1, (unsigned) Index + 1);
1222 PrintGuid ((EFI_GUID *) FileBuffer);
1223 return EFI_INVALID_PARAMETER;
1224 }
1225 }
1226 CopyMem (&mFileGuidArray [Index], FileBuffer, sizeof (EFI_GUID));
1227
1228 //
1229 // Update the file state based on polarity of the FV.
1230 //
1231 UpdateFfsFileState (
1232 (EFI_FFS_FILE_HEADER *) FileBuffer,
1233 (EFI_FIRMWARE_VOLUME_HEADER *) FvImage->FileImage
1234 );
1235
1236 //
1237 // Check if alignment is required
1238 //
1239 ReadFfsAlignment ((EFI_FFS_FILE_HEADER *) FileBuffer, &CurrentFileAlignment);
1240
1241 //
1242 // Find the largest alignment of all the FFS files in the FV
1243 //
1244 if (CurrentFileAlignment > MaxFfsAlignment) {
1245 MaxFfsAlignment = CurrentFileAlignment;
1246 }
1247 //
1248 // If we have a VTF file, add it at the top.
1249 //
1250 if (IsVtfFile ((EFI_FFS_FILE_HEADER *) FileBuffer)) {
1251 if ((UINTN) *VtfFileImage == (UINTN) FvImage->Eof) {
1252 //
1253 // No previous VTF, add this one.
1254 //
1255 *VtfFileImage = (EFI_FFS_FILE_HEADER *) (UINTN) ((UINTN) FvImage->FileImage + FvInfo->Size - FileSize);
1256 //
1257 // Sanity check. The file MUST align appropriately
1258 //
1259 if (((UINTN) *VtfFileImage + GetFfsHeaderLength((EFI_FFS_FILE_HEADER *)FileBuffer) - (UINTN) FvImage->FileImage) % (1 << CurrentFileAlignment)) {
1260 Error (NULL, 0, 3000, "Invalid", "VTF file cannot be aligned on a %u-byte boundary.", (unsigned) (1 << CurrentFileAlignment));
1261 free (FileBuffer);
1262 return EFI_ABORTED;
1263 }
1264 //
1265 // Rebase the PE or TE image in FileBuffer of FFS file for XIP
1266 // Rebase for the debug genfvmap tool
1267 //
1268 Status = FfsRebase (FvInfo, FvInfo->FvFiles[Index], (EFI_FFS_FILE_HEADER *) FileBuffer, (UINTN) *VtfFileImage - (UINTN) FvImage->FileImage, FvMapFile);
1269 if (EFI_ERROR (Status)) {
1270 Error (NULL, 0, 3000, "Invalid", "Could not rebase %s.", FvInfo->FvFiles[Index]);
1271 return Status;
1272 }
1273 //
1274 // copy VTF File
1275 //
1276 memcpy (*VtfFileImage, FileBuffer, FileSize);
1277
1278 PrintGuidToBuffer ((EFI_GUID *) FileBuffer, FileGuidString, sizeof (FileGuidString), TRUE);
1279 fprintf (FvReportFile, "0x%08X %s\n", (unsigned)(UINTN) (((UINT8 *)*VtfFileImage) - (UINTN)FvImage->FileImage), FileGuidString);
1280
1281 free (FileBuffer);
1282 DebugMsg (NULL, 0, 9, "Add VTF FFS file in FV image", NULL);
1283 return EFI_SUCCESS;
1284 } else {
1285 //
1286 // Already found a VTF file.
1287 //
1288 Error (NULL, 0, 3000, "Invalid", "multiple VTF files are not permitted within a single FV.");
1289 free (FileBuffer);
1290 return EFI_ABORTED;
1291 }
1292 }
1293
1294 //
1295 // Add pad file if necessary
1296 //
1297 if (!AdjustInternalFfsPadding ((EFI_FFS_FILE_HEADER *) FileBuffer, FvImage,
1298 1 << CurrentFileAlignment, &FileSize)) {
1299 Status = AddPadFile (FvImage, 1 << CurrentFileAlignment, *VtfFileImage, NULL, FileSize);
1300 if (EFI_ERROR (Status)) {
1301 Error (NULL, 0, 4002, "Resource", "FV space is full, could not add pad file for data alignment property.");
1302 free (FileBuffer);
1303 return EFI_ABORTED;
1304 }
1305 }
1306 //
1307 // Add file
1308 //
1309 if ((UINTN) (FvImage->CurrentFilePointer + FileSize) <= (UINTN) (*VtfFileImage)) {
1310 //
1311 // Rebase the PE or TE image in FileBuffer of FFS file for XIP.
1312 // Rebase Bs and Rt drivers for the debug genfvmap tool.
1313 //
1314 Status = FfsRebase (FvInfo, FvInfo->FvFiles[Index], (EFI_FFS_FILE_HEADER *) FileBuffer, (UINTN) FvImage->CurrentFilePointer - (UINTN) FvImage->FileImage, FvMapFile);
1315 if (EFI_ERROR (Status)) {
1316 Error (NULL, 0, 3000, "Invalid", "Could not rebase %s.", FvInfo->FvFiles[Index]);
1317 return Status;
1318 }
1319 //
1320 // Copy the file
1321 //
1322 memcpy (FvImage->CurrentFilePointer, FileBuffer, FileSize);
1323 PrintGuidToBuffer ((EFI_GUID *) FileBuffer, FileGuidString, sizeof (FileGuidString), TRUE);
1324 fprintf (FvReportFile, "0x%08X %s\n", (unsigned) (FvImage->CurrentFilePointer - FvImage->FileImage), FileGuidString);
1325 FvImage->CurrentFilePointer += FileSize;
1326 } else {
1327 Error (NULL, 0, 4002, "Resource", "FV space is full, cannot add file %s.", FvInfo->FvFiles[Index]);
1328 free (FileBuffer);
1329 return EFI_ABORTED;
1330 }
1331 //
1332 // Make next file start at QWord Boundry
1333 //
1334 while (((UINTN) FvImage->CurrentFilePointer & (EFI_FFS_FILE_HEADER_ALIGNMENT - 1)) != 0) {
1335 FvImage->CurrentFilePointer++;
1336 }
1337
1338 Done:
1339 //
1340 // Free allocated memory.
1341 //
1342 free (FileBuffer);
1343
1344 return EFI_SUCCESS;
1345 }
1346
1347 EFI_STATUS
1348 PadFvImage (
1349 IN MEMORY_FILE *FvImage,
1350 IN EFI_FFS_FILE_HEADER *VtfFileImage
1351 )
1352 /*++
1353
1354 Routine Description:
1355
1356 This function places a pad file between the last file in the FV and the VTF
1357 file if the VTF file exists.
1358
1359 Arguments:
1360
1361 FvImage Memory file for the FV memory image
1362 VtfFileImage The address of the VTF file. If this is the end of the FV
1363 image, no VTF exists and no pad file is needed.
1364
1365 Returns:
1366
1367 EFI_SUCCESS Completed successfully.
1368 EFI_INVALID_PARAMETER One of the input parameters was NULL.
1369
1370 --*/
1371 {
1372 EFI_FFS_FILE_HEADER *PadFile;
1373 UINTN FileSize;
1374 UINT32 FfsHeaderSize;
1375
1376 //
1377 // If there is no VTF or the VTF naturally follows the previous file without a
1378 // pad file, then there's nothing to do
1379 //
1380 if ((UINTN) VtfFileImage == (UINTN) FvImage->Eof || \
1381 ((UINTN) VtfFileImage == (UINTN) FvImage->CurrentFilePointer)) {
1382 return EFI_SUCCESS;
1383 }
1384
1385 if ((UINTN) VtfFileImage < (UINTN) FvImage->CurrentFilePointer) {
1386 return EFI_INVALID_PARAMETER;
1387 }
1388
1389 //
1390 // Pad file starts at beginning of free space
1391 //
1392 PadFile = (EFI_FFS_FILE_HEADER *) FvImage->CurrentFilePointer;
1393
1394 //
1395 // write PadFile FFS header with PadType, don't need to set PAD file guid in its header.
1396 //
1397 PadFile->Type = EFI_FV_FILETYPE_FFS_PAD;
1398 PadFile->Attributes = 0;
1399
1400 //
1401 // FileSize includes the EFI_FFS_FILE_HEADER
1402 //
1403 FileSize = (UINTN) VtfFileImage - (UINTN) FvImage->CurrentFilePointer;
1404 if (FileSize >= MAX_FFS_SIZE) {
1405 PadFile->Attributes |= FFS_ATTRIB_LARGE_FILE;
1406 memset(PadFile->Size, 0, sizeof(UINT8) * 3);
1407 ((EFI_FFS_FILE_HEADER2 *)PadFile)->ExtendedSize = FileSize;
1408 FfsHeaderSize = sizeof(EFI_FFS_FILE_HEADER2);
1409 mIsLargeFfs = TRUE;
1410 } else {
1411 PadFile->Size[0] = (UINT8) (FileSize & 0x000000FF);
1412 PadFile->Size[1] = (UINT8) ((FileSize & 0x0000FF00) >> 8);
1413 PadFile->Size[2] = (UINT8) ((FileSize & 0x00FF0000) >> 16);
1414 FfsHeaderSize = sizeof(EFI_FFS_FILE_HEADER);
1415 }
1416
1417 //
1418 // Fill in checksums and state, must be zero during checksum calculation.
1419 //
1420 PadFile->IntegrityCheck.Checksum.Header = 0;
1421 PadFile->IntegrityCheck.Checksum.File = 0;
1422 PadFile->State = 0;
1423 PadFile->IntegrityCheck.Checksum.Header = CalculateChecksum8 ((UINT8 *) PadFile, FfsHeaderSize);
1424 PadFile->IntegrityCheck.Checksum.File = FFS_FIXED_CHECKSUM;
1425
1426 PadFile->State = EFI_FILE_HEADER_CONSTRUCTION | EFI_FILE_HEADER_VALID | EFI_FILE_DATA_VALID;
1427
1428 UpdateFfsFileState (
1429 (EFI_FFS_FILE_HEADER *) PadFile,
1430 (EFI_FIRMWARE_VOLUME_HEADER *) FvImage->FileImage
1431 );
1432 //
1433 // Update the current FV pointer
1434 //
1435 FvImage->CurrentFilePointer = FvImage->Eof;
1436
1437 return EFI_SUCCESS;
1438 }
1439
1440 EFI_STATUS
1441 UpdateResetVector (
1442 IN MEMORY_FILE *FvImage,
1443 IN FV_INFO *FvInfo,
1444 IN EFI_FFS_FILE_HEADER *VtfFile
1445 )
1446 /*++
1447
1448 Routine Description:
1449
1450 This parses the FV looking for the PEI core and then plugs the address into
1451 the SALE_ENTRY point of the BSF/VTF for IPF and does BUGBUG TBD action to
1452 complete an IA32 Bootstrap FV.
1453
1454 Arguments:
1455
1456 FvImage Memory file for the FV memory image
1457 FvInfo Information read from INF file.
1458 VtfFile Pointer to the VTF file in the FV image.
1459
1460 Returns:
1461
1462 EFI_SUCCESS Function Completed successfully.
1463 EFI_ABORTED Error encountered.
1464 EFI_INVALID_PARAMETER A required parameter was NULL.
1465 EFI_NOT_FOUND PEI Core file not found.
1466
1467 --*/
1468 {
1469 EFI_FFS_FILE_HEADER *PeiCoreFile;
1470 EFI_FFS_FILE_HEADER *SecCoreFile;
1471 EFI_STATUS Status;
1472 EFI_FILE_SECTION_POINTER Pe32Section;
1473 UINT32 EntryPoint;
1474 UINT32 BaseOfCode;
1475 UINT16 MachineType;
1476 EFI_PHYSICAL_ADDRESS PeiCorePhysicalAddress;
1477 EFI_PHYSICAL_ADDRESS SecCorePhysicalAddress;
1478 EFI_PHYSICAL_ADDRESS *SecCoreEntryAddressPtr;
1479 INT32 Ia32SecEntryOffset;
1480 UINT32 *Ia32ResetAddressPtr;
1481 UINT8 *BytePointer;
1482 UINT8 *BytePointer2;
1483 UINT16 *WordPointer;
1484 UINT16 CheckSum;
1485 UINT32 IpiVector;
1486 UINTN Index;
1487 EFI_FFS_FILE_STATE SavedState;
1488 UINT64 FitAddress;
1489 FIT_TABLE *FitTablePtr;
1490 BOOLEAN Vtf0Detected;
1491 UINT32 FfsHeaderSize;
1492 UINT32 SecHeaderSize;
1493
1494 //
1495 // Verify input parameters
1496 //
1497 if (FvImage == NULL || FvInfo == NULL || VtfFile == NULL) {
1498 return EFI_INVALID_PARAMETER;
1499 }
1500 //
1501 // Initialize FV library
1502 //
1503 InitializeFvLib (FvImage->FileImage, FvInfo->Size);
1504
1505 //
1506 // Verify VTF file
1507 //
1508 Status = VerifyFfsFile (VtfFile);
1509 if (EFI_ERROR (Status)) {
1510 return EFI_INVALID_PARAMETER;
1511 }
1512
1513 if (
1514 (((UINTN)FvImage->Eof - (UINTN)FvImage->FileImage) >=
1515 IA32_X64_VTF_SIGNATURE_OFFSET) &&
1516 (*(UINT32 *)(VOID*)((UINTN) FvImage->Eof -
1517 IA32_X64_VTF_SIGNATURE_OFFSET) ==
1518 IA32_X64_VTF0_SIGNATURE)
1519 ) {
1520 Vtf0Detected = TRUE;
1521 } else {
1522 Vtf0Detected = FALSE;
1523 }
1524
1525 //
1526 // Find the Sec Core
1527 //
1528 Status = GetFileByType (EFI_FV_FILETYPE_SECURITY_CORE, 1, &SecCoreFile);
1529 if (EFI_ERROR (Status) || SecCoreFile == NULL) {
1530 if (Vtf0Detected) {
1531 //
1532 // If the SEC core file is not found, but the VTF-0 signature
1533 // is found, we'll treat it as a VTF-0 'Volume Top File'.
1534 // This means no modifications are required to the VTF.
1535 //
1536 return EFI_SUCCESS;
1537 }
1538
1539 Error (NULL, 0, 3000, "Invalid", "could not find the SEC core file in the FV.");
1540 return EFI_ABORTED;
1541 }
1542 //
1543 // Sec Core found, now find PE32 section
1544 //
1545 Status = GetSectionByType (SecCoreFile, EFI_SECTION_PE32, 1, &Pe32Section);
1546 if (Status == EFI_NOT_FOUND) {
1547 Status = GetSectionByType (SecCoreFile, EFI_SECTION_TE, 1, &Pe32Section);
1548 }
1549
1550 if (EFI_ERROR (Status)) {
1551 Error (NULL, 0, 3000, "Invalid", "could not find a PE32 section in the SEC core file.");
1552 return EFI_ABORTED;
1553 }
1554
1555 SecHeaderSize = GetSectionHeaderLength(Pe32Section.CommonHeader);
1556 Status = GetPe32Info (
1557 (VOID *) ((UINTN) Pe32Section.Pe32Section + SecHeaderSize),
1558 &EntryPoint,
1559 &BaseOfCode,
1560 &MachineType
1561 );
1562
1563 if (EFI_ERROR (Status)) {
1564 Error (NULL, 0, 3000, "Invalid", "could not get the PE32 entry point for the SEC core.");
1565 return EFI_ABORTED;
1566 }
1567
1568 if (
1569 Vtf0Detected &&
1570 (MachineType == EFI_IMAGE_MACHINE_IA32 ||
1571 MachineType == EFI_IMAGE_MACHINE_X64)
1572 ) {
1573 //
1574 // If the SEC core code is IA32 or X64 and the VTF-0 signature
1575 // is found, we'll treat it as a VTF-0 'Volume Top File'.
1576 // This means no modifications are required to the VTF.
1577 //
1578 return EFI_SUCCESS;
1579 }
1580
1581 //
1582 // Physical address is FV base + offset of PE32 + offset of the entry point
1583 //
1584 SecCorePhysicalAddress = FvInfo->BaseAddress;
1585 SecCorePhysicalAddress += (UINTN) Pe32Section.Pe32Section + SecHeaderSize - (UINTN) FvImage->FileImage;
1586 SecCorePhysicalAddress += EntryPoint;
1587 DebugMsg (NULL, 0, 9, "SecCore physical entry point address", "Address = 0x%llX", (unsigned long long) SecCorePhysicalAddress);
1588
1589 //
1590 // Find the PEI Core
1591 //
1592 Status = GetFileByType (EFI_FV_FILETYPE_PEI_CORE, 1, &PeiCoreFile);
1593 if (EFI_ERROR (Status) || PeiCoreFile == NULL) {
1594 Error (NULL, 0, 3000, "Invalid", "could not find the PEI core in the FV.");
1595 return EFI_ABORTED;
1596 }
1597 //
1598 // PEI Core found, now find PE32 or TE section
1599 //
1600 Status = GetSectionByType (PeiCoreFile, EFI_SECTION_PE32, 1, &Pe32Section);
1601 if (Status == EFI_NOT_FOUND) {
1602 Status = GetSectionByType (PeiCoreFile, EFI_SECTION_TE, 1, &Pe32Section);
1603 }
1604
1605 if (EFI_ERROR (Status)) {
1606 Error (NULL, 0, 3000, "Invalid", "could not find either a PE32 or a TE section in PEI core file.");
1607 return EFI_ABORTED;
1608 }
1609
1610 SecHeaderSize = GetSectionHeaderLength(Pe32Section.CommonHeader);
1611 Status = GetPe32Info (
1612 (VOID *) ((UINTN) Pe32Section.Pe32Section + SecHeaderSize),
1613 &EntryPoint,
1614 &BaseOfCode,
1615 &MachineType
1616 );
1617
1618 if (EFI_ERROR (Status)) {
1619 Error (NULL, 0, 3000, "Invalid", "could not get the PE32 entry point for the PEI core.");
1620 return EFI_ABORTED;
1621 }
1622 //
1623 // Physical address is FV base + offset of PE32 + offset of the entry point
1624 //
1625 PeiCorePhysicalAddress = FvInfo->BaseAddress;
1626 PeiCorePhysicalAddress += (UINTN) Pe32Section.Pe32Section + SecHeaderSize - (UINTN) FvImage->FileImage;
1627 PeiCorePhysicalAddress += EntryPoint;
1628 DebugMsg (NULL, 0, 9, "PeiCore physical entry point address", "Address = 0x%llX", (unsigned long long) PeiCorePhysicalAddress);
1629
1630 if (MachineType == EFI_IMAGE_MACHINE_IA64) {
1631 //
1632 // Update PEI_CORE address
1633 //
1634 //
1635 // Set the uncached attribute bit in the physical address
1636 //
1637 PeiCorePhysicalAddress |= 0x8000000000000000ULL;
1638
1639 //
1640 // Check if address is aligned on a 16 byte boundary
1641 //
1642 if (PeiCorePhysicalAddress & 0xF) {
1643 Error (NULL, 0, 3000, "Invalid",
1644 "PEI_CORE entry point is not aligned on a 16 byte boundary, address specified is %llXh.",
1645 (unsigned long long) PeiCorePhysicalAddress
1646 );
1647 return EFI_ABORTED;
1648 }
1649 //
1650 // First Get the FIT table address
1651 //
1652 FitAddress = (*(UINT64 *) (FvImage->Eof - IPF_FIT_ADDRESS_OFFSET)) & 0xFFFFFFFF;
1653
1654 FitTablePtr = (FIT_TABLE *) (FvImage->FileImage + (FitAddress - FvInfo->BaseAddress));
1655
1656 Status = UpdatePeiCoreEntryInFit (FitTablePtr, PeiCorePhysicalAddress);
1657
1658 if (!EFI_ERROR (Status)) {
1659 UpdateFitCheckSum (FitTablePtr);
1660 }
1661
1662 //
1663 // Update SEC_CORE address
1664 //
1665 //
1666 // Set the uncached attribute bit in the physical address
1667 //
1668 SecCorePhysicalAddress |= 0x8000000000000000ULL;
1669 //
1670 // Check if address is aligned on a 16 byte boundary
1671 //
1672 if (SecCorePhysicalAddress & 0xF) {
1673 Error (NULL, 0, 3000, "Invalid",
1674 "SALE_ENTRY entry point is not aligned on a 16 byte boundary, address specified is %llXh.",
1675 (unsigned long long) SecCorePhysicalAddress
1676 );
1677 return EFI_ABORTED;
1678 }
1679 //
1680 // Update the address
1681 //
1682 SecCoreEntryAddressPtr = (EFI_PHYSICAL_ADDRESS *) ((UINTN) FvImage->Eof - IPF_SALE_ENTRY_ADDRESS_OFFSET);
1683 *SecCoreEntryAddressPtr = SecCorePhysicalAddress;
1684
1685 } else if (MachineType == EFI_IMAGE_MACHINE_IA32 || MachineType == EFI_IMAGE_MACHINE_X64) {
1686 //
1687 // Get the location to update
1688 //
1689 Ia32ResetAddressPtr = (UINT32 *) ((UINTN) FvImage->Eof - IA32_PEI_CORE_ENTRY_OFFSET);
1690
1691 //
1692 // Write lower 32 bits of physical address for Pei Core entry
1693 //
1694 *Ia32ResetAddressPtr = (UINT32) PeiCorePhysicalAddress;
1695
1696 //
1697 // Write SecCore Entry point relative address into the jmp instruction in reset vector.
1698 //
1699 Ia32ResetAddressPtr = (UINT32 *) ((UINTN) FvImage->Eof - IA32_SEC_CORE_ENTRY_OFFSET);
1700
1701 Ia32SecEntryOffset = (INT32) (SecCorePhysicalAddress - (FV_IMAGES_TOP_ADDRESS - IA32_SEC_CORE_ENTRY_OFFSET + 2));
1702 if (Ia32SecEntryOffset <= -65536) {
1703 Error (NULL, 0, 3000, "Invalid", "The SEC EXE file size is too large, it must be less than 64K.");
1704 return STATUS_ERROR;
1705 }
1706
1707 *(UINT16 *) Ia32ResetAddressPtr = (UINT16) Ia32SecEntryOffset;
1708
1709 //
1710 // Update the BFV base address
1711 //
1712 Ia32ResetAddressPtr = (UINT32 *) ((UINTN) FvImage->Eof - 4);
1713 *Ia32ResetAddressPtr = (UINT32) (FvInfo->BaseAddress);
1714 DebugMsg (NULL, 0, 9, "update BFV base address in the top FV image", "BFV base address = 0x%llX.", (unsigned long long) FvInfo->BaseAddress);
1715
1716 //
1717 // Update the Startup AP in the FVH header block ZeroVector region.
1718 //
1719 BytePointer = (UINT8 *) ((UINTN) FvImage->FileImage);
1720 if (FvInfo->Size <= 0x10000) {
1721 BytePointer2 = m64kRecoveryStartupApDataArray;
1722 } else if (FvInfo->Size <= 0x20000) {
1723 BytePointer2 = m128kRecoveryStartupApDataArray;
1724 } else {
1725 BytePointer2 = m128kRecoveryStartupApDataArray;
1726 //
1727 // Find the position to place Ap reset vector, the offset
1728 // between the position and the end of Fvrecovery.fv file
1729 // should not exceed 128kB to prevent Ap reset vector from
1730 // outside legacy E and F segment
1731 //
1732 Status = FindApResetVectorPosition (FvImage, &BytePointer);
1733 if (EFI_ERROR (Status)) {
1734 Error (NULL, 0, 3000, "Invalid", "FV image does not have enough space to place AP reset vector. The FV image needs to reserve at least 4KB of unused space.");
1735 return EFI_ABORTED;
1736 }
1737 }
1738
1739 for (Index = 0; Index < SIZEOF_STARTUP_DATA_ARRAY; Index++) {
1740 BytePointer[Index] = BytePointer2[Index];
1741 }
1742 //
1743 // Calculate the checksum
1744 //
1745 CheckSum = 0x0000;
1746 WordPointer = (UINT16 *) (BytePointer);
1747 for (Index = 0; Index < SIZEOF_STARTUP_DATA_ARRAY / 2; Index++) {
1748 CheckSum = (UINT16) (CheckSum + ((UINT16) *WordPointer));
1749 WordPointer++;
1750 }
1751 //
1752 // Update the checksum field
1753 //
1754 WordPointer = (UINT16 *) (BytePointer + SIZEOF_STARTUP_DATA_ARRAY - 2);
1755 *WordPointer = (UINT16) (0x10000 - (UINT32) CheckSum);
1756
1757 //
1758 // IpiVector at the 4k aligned address in the top 2 blocks in the PEI FV.
1759 //
1760 IpiVector = (UINT32) (FV_IMAGES_TOP_ADDRESS - ((UINTN) FvImage->Eof - (UINTN) BytePointer));
1761 DebugMsg (NULL, 0, 9, "Startup AP Vector address", "IpiVector at 0x%X", (unsigned) IpiVector);
1762 if ((IpiVector & 0xFFF) != 0) {
1763 Error (NULL, 0, 3000, "Invalid", "Startup AP Vector address are not 4K aligned, because the FV size is not 4K aligned");
1764 return EFI_ABORTED;
1765 }
1766 IpiVector = IpiVector >> 12;
1767 IpiVector = IpiVector & 0xFF;
1768
1769 //
1770 // Write IPI Vector at Offset FvrecoveryFileSize - 8
1771 //
1772 Ia32ResetAddressPtr = (UINT32 *) ((UINTN) FvImage->Eof - 8);
1773 *Ia32ResetAddressPtr = IpiVector;
1774 } else if (MachineType == EFI_IMAGE_MACHINE_ARMT) {
1775 //
1776 // Since the ARM reset vector is in the FV Header you really don't need a
1777 // Volume Top File, but if you have one for some reason don't crash...
1778 //
1779 } else if (MachineType == EFI_IMAGE_MACHINE_AARCH64) {
1780 //
1781 // Since the AArch64 reset vector is in the FV Header you really don't need a
1782 // Volume Top File, but if you have one for some reason don't crash...
1783 //
1784 } else {
1785 Error (NULL, 0, 3000, "Invalid", "machine type=0x%X in PEI core.", MachineType);
1786 return EFI_ABORTED;
1787 }
1788
1789 //
1790 // Now update file checksum
1791 //
1792 SavedState = VtfFile->State;
1793 VtfFile->IntegrityCheck.Checksum.File = 0;
1794 VtfFile->State = 0;
1795 if (VtfFile->Attributes & FFS_ATTRIB_CHECKSUM) {
1796 FfsHeaderSize = GetFfsHeaderLength(VtfFile);
1797 VtfFile->IntegrityCheck.Checksum.File = CalculateChecksum8 (
1798 (UINT8 *) ((UINT8 *)VtfFile + FfsHeaderSize),
1799 GetFfsFileLength (VtfFile) - FfsHeaderSize
1800 );
1801 } else {
1802 VtfFile->IntegrityCheck.Checksum.File = FFS_FIXED_CHECKSUM;
1803 }
1804
1805 VtfFile->State = SavedState;
1806
1807 return EFI_SUCCESS;
1808 }
1809
1810 EFI_STATUS
1811 FindCorePeSection(
1812 IN VOID *FvImageBuffer,
1813 IN UINT64 FvSize,
1814 IN EFI_FV_FILETYPE FileType,
1815 OUT EFI_FILE_SECTION_POINTER *Pe32Section
1816 )
1817 /*++
1818
1819 Routine Description:
1820
1821 Recursively searches the FV for the FFS file of specified type (typically
1822 SEC or PEI core) and extracts the PE32 section for further processing.
1823
1824 Arguments:
1825
1826 FvImageBuffer Buffer containing FV data
1827 FvSize Size of the FV
1828 FileType Type of FFS file to search for
1829 Pe32Section PE32 section pointer when FFS file is found.
1830
1831 Returns:
1832
1833 EFI_SUCCESS Function Completed successfully.
1834 EFI_ABORTED Error encountered.
1835 EFI_INVALID_PARAMETER A required parameter was NULL.
1836 EFI_NOT_FOUND Core file not found.
1837
1838 --*/
1839 {
1840 EFI_STATUS Status;
1841 EFI_FIRMWARE_VOLUME_HEADER *OrigFvHeader;
1842 UINT32 OrigFvLength;
1843 EFI_FFS_FILE_HEADER *CoreFfsFile;
1844 UINTN FvImageFileCount;
1845 EFI_FFS_FILE_HEADER *FvImageFile;
1846 UINTN EncapFvSectionCount;
1847 EFI_FILE_SECTION_POINTER EncapFvSection;
1848 EFI_FIRMWARE_VOLUME_HEADER *EncapsulatedFvHeader;
1849
1850 if (Pe32Section == NULL) {
1851 return EFI_INVALID_PARAMETER;
1852 }
1853
1854 //
1855 // Initialize FV library, saving previous values
1856 //
1857 OrigFvHeader = (EFI_FIRMWARE_VOLUME_HEADER *)NULL;
1858 GetFvHeader (&OrigFvHeader, &OrigFvLength);
1859 InitializeFvLib(FvImageBuffer, (UINT32)FvSize);
1860
1861 //
1862 // First see if we can obtain the file directly in outer FV
1863 //
1864 Status = GetFileByType(FileType, 1, &CoreFfsFile);
1865 if (!EFI_ERROR(Status) && (CoreFfsFile != NULL) ) {
1866
1867 //
1868 // Core found, now find PE32 or TE section
1869 //
1870 Status = GetSectionByType(CoreFfsFile, EFI_SECTION_PE32, 1, Pe32Section);
1871 if (EFI_ERROR(Status)) {
1872 Status = GetSectionByType(CoreFfsFile, EFI_SECTION_TE, 1, Pe32Section);
1873 }
1874
1875 if (EFI_ERROR(Status)) {
1876 Error(NULL, 0, 3000, "Invalid", "could not find a PE32 section in the core file.");
1877 return EFI_ABORTED;
1878 }
1879
1880 //
1881 // Core PE/TE section, found, return
1882 //
1883 Status = EFI_SUCCESS;
1884 goto EarlyExit;
1885 }
1886
1887 //
1888 // File was not found, look for FV Image file
1889 //
1890
1891 // iterate through all FV image files in outer FV
1892 for (FvImageFileCount = 1;; FvImageFileCount++) {
1893
1894 Status = GetFileByType(EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE, FvImageFileCount, &FvImageFile);
1895
1896 if (EFI_ERROR(Status) || (FvImageFile == NULL) ) {
1897 // exit FV image file loop, no more found
1898 break;
1899 }
1900
1901 // Found an fv image file, look for an FV image section. The PI spec does not
1902 // preclude multiple FV image sections so we loop accordingly.
1903 for (EncapFvSectionCount = 1;; EncapFvSectionCount++) {
1904
1905 // Look for the next FV image section. The section search code will
1906 // iterate into encapsulation sections. For example, it will iterate
1907 // into an EFI_SECTION_GUID_DEFINED encapsulation section to find the
1908 // EFI_SECTION_FIRMWARE_VOLUME_IMAGE sections contained therein.
1909 Status = GetSectionByType(FvImageFile, EFI_SECTION_FIRMWARE_VOLUME_IMAGE, EncapFvSectionCount, &EncapFvSection);
1910
1911 if (EFI_ERROR(Status)) {
1912 // exit section inner loop, no more found
1913 break;
1914 }
1915
1916 EncapsulatedFvHeader = (EFI_FIRMWARE_VOLUME_HEADER *)((UINT8 *)EncapFvSection.FVImageSection + GetSectionHeaderLength(EncapFvSection.FVImageSection));
1917
1918 // recurse to search the encapsulated FV for this core file type
1919 Status = FindCorePeSection(EncapsulatedFvHeader, EncapsulatedFvHeader->FvLength, FileType, Pe32Section);
1920
1921 if (!EFI_ERROR(Status)) {
1922 // we found the core in the capsulated image, success
1923 goto EarlyExit;
1924 }
1925
1926 } // end encapsulated fv image section loop
1927 } // end fv image file loop
1928
1929 // core was not found
1930 Status = EFI_NOT_FOUND;
1931
1932 EarlyExit:
1933
1934 // restore FV lib values
1935 if(OrigFvHeader != NULL) {
1936 InitializeFvLib(OrigFvHeader, OrigFvLength);
1937 }
1938
1939 return Status;
1940 }
1941
1942 EFI_STATUS
1943 GetCoreMachineType(
1944 IN EFI_FILE_SECTION_POINTER Pe32Section,
1945 OUT UINT16 *CoreMachineType
1946 )
1947 /*++
1948
1949 Routine Description:
1950
1951 Returns the machine type of a P32 image, typically SEC or PEI core.
1952
1953 Arguments:
1954
1955 Pe32Section PE32 section data
1956 CoreMachineType The extracted machine type
1957
1958 Returns:
1959
1960 EFI_SUCCESS Function Completed successfully.
1961 EFI_ABORTED Error encountered.
1962 EFI_INVALID_PARAMETER A required parameter was NULL.
1963
1964 --*/
1965 {
1966 EFI_STATUS Status;
1967 UINT32 EntryPoint;
1968 UINT32 BaseOfCode;
1969
1970 if (CoreMachineType == NULL) {
1971 return EFI_INVALID_PARAMETER;
1972 }
1973
1974 Status = GetPe32Info(
1975 (VOID *)((UINTN)Pe32Section.Pe32Section + GetSectionHeaderLength(Pe32Section.CommonHeader)),
1976 &EntryPoint,
1977 &BaseOfCode,
1978 CoreMachineType
1979 );
1980 if (EFI_ERROR(Status)) {
1981 Error(NULL, 0, 3000, "Invalid", "could not get the PE32 machine type for the core.");
1982 return EFI_ABORTED;
1983 }
1984
1985 return EFI_SUCCESS;
1986 }
1987
1988 EFI_STATUS
1989 GetCoreEntryPointAddress(
1990 IN VOID *FvImageBuffer,
1991 IN FV_INFO *FvInfo,
1992 IN EFI_FILE_SECTION_POINTER Pe32Section,
1993 OUT EFI_PHYSICAL_ADDRESS *CoreEntryAddress
1994 )
1995 /*++
1996
1997 Routine Description:
1998
1999 Returns the physical address of the core (SEC or PEI) entry point.
2000
2001 Arguments:
2002
2003 FvImageBuffer Pointer to buffer containing FV data
2004 FvInfo Info for the parent FV
2005 Pe32Section PE32 section data
2006 CoreEntryAddress The extracted core entry physical address
2007
2008 Returns:
2009
2010 EFI_SUCCESS Function Completed successfully.
2011 EFI_ABORTED Error encountered.
2012 EFI_INVALID_PARAMETER A required parameter was NULL.
2013
2014 --*/
2015 {
2016 EFI_STATUS Status;
2017 UINT32 EntryPoint;
2018 UINT32 BaseOfCode;
2019 UINT16 MachineType;
2020 EFI_PHYSICAL_ADDRESS EntryPhysicalAddress;
2021
2022 if (CoreEntryAddress == NULL) {
2023 return EFI_INVALID_PARAMETER;
2024 }
2025
2026 Status = GetPe32Info(
2027 (VOID *)((UINTN)Pe32Section.Pe32Section + GetSectionHeaderLength(Pe32Section.CommonHeader)),
2028 &EntryPoint,
2029 &BaseOfCode,
2030 &MachineType
2031 );
2032 if (EFI_ERROR(Status)) {
2033 Error(NULL, 0, 3000, "Invalid", "could not get the PE32 entry point for the core.");
2034 return EFI_ABORTED;
2035 }
2036
2037 //
2038 // Physical address is FV base + offset of PE32 + offset of the entry point
2039 //
2040 EntryPhysicalAddress = FvInfo->BaseAddress;
2041 EntryPhysicalAddress += (UINTN)Pe32Section.Pe32Section + GetSectionHeaderLength(Pe32Section.CommonHeader) - (UINTN)FvImageBuffer;
2042 EntryPhysicalAddress += EntryPoint;
2043
2044 *CoreEntryAddress = EntryPhysicalAddress;
2045
2046 return EFI_SUCCESS;
2047 }
2048
2049 EFI_STATUS
2050 UpdateArmResetVectorIfNeeded (
2051 IN MEMORY_FILE *FvImage,
2052 IN FV_INFO *FvInfo
2053 )
2054 /*++
2055
2056 Routine Description:
2057 This parses the FV looking for SEC and patches that address into the
2058 beginning of the FV header.
2059
2060 For ARM32 the reset vector is at 0x00000000 or 0xFFFF0000.
2061 For AArch64 the reset vector is at 0x00000000.
2062
2063 This would commonly map to the first entry in the ROM.
2064 ARM32 Exceptions:
2065 Reset +0
2066 Undefined +4
2067 SWI +8
2068 Prefetch Abort +12
2069 Data Abort +16
2070 IRQ +20
2071 FIQ +24
2072
2073 We support two schemes on ARM.
2074 1) Beginning of the FV is the reset vector
2075 2) Reset vector is data bytes FDF file and that code branches to reset vector
2076 in the beginning of the FV (fixed size offset).
2077
2078 Need to have the jump for the reset vector at location zero.
2079 We also need to store the address or PEI (if it exists).
2080 We stub out a return from interrupt in case the debugger
2081 is using SWI (not done for AArch64, not enough space in struct).
2082 The optional entry to the common exception handler is
2083 to support full featured exception handling from ROM and is currently
2084 not support by this tool.
2085
2086 Arguments:
2087 FvImage Memory file for the FV memory image
2088 FvInfo Information read from INF file.
2089
2090 Returns:
2091
2092 EFI_SUCCESS Function Completed successfully.
2093 EFI_ABORTED Error encountered.
2094 EFI_INVALID_PARAMETER A required parameter was NULL.
2095 EFI_NOT_FOUND PEI Core file not found.
2096
2097 --*/
2098 {
2099 EFI_STATUS Status;
2100 EFI_FILE_SECTION_POINTER SecPe32;
2101 EFI_FILE_SECTION_POINTER PeiPe32;
2102 BOOLEAN UpdateVectorSec = FALSE;
2103 BOOLEAN UpdateVectorPei = FALSE;
2104 UINT16 MachineType = 0;
2105 EFI_PHYSICAL_ADDRESS SecCoreEntryAddress = 0;
2106 UINT16 PeiMachineType = 0;
2107 EFI_PHYSICAL_ADDRESS PeiCoreEntryAddress = 0;
2108
2109 //
2110 // Verify input parameters
2111 //
2112 if (FvImage == NULL || FvInfo == NULL) {
2113 return EFI_INVALID_PARAMETER;
2114 }
2115
2116 //
2117 // Locate an SEC Core instance and if found extract the machine type and entry point address
2118 //
2119 Status = FindCorePeSection(FvImage->FileImage, FvInfo->Size, EFI_FV_FILETYPE_SECURITY_CORE, &SecPe32);
2120 if (!EFI_ERROR(Status)) {
2121
2122 Status = GetCoreMachineType(SecPe32, &MachineType);
2123 if (EFI_ERROR(Status)) {
2124 Error(NULL, 0, 3000, "Invalid", "Could not get the PE32 machine type for SEC Core.");
2125 return EFI_ABORTED;
2126 }
2127
2128 Status = GetCoreEntryPointAddress(FvImage->FileImage, FvInfo, SecPe32, &SecCoreEntryAddress);
2129 if (EFI_ERROR(Status)) {
2130 Error(NULL, 0, 3000, "Invalid", "Could not get the PE32 entry point address for SEC Core.");
2131 return EFI_ABORTED;
2132 }
2133
2134 VerboseMsg("UpdateArmResetVectorIfNeeded found SEC core entry at 0x%llx", (unsigned long long)SecCoreEntryAddress);
2135 UpdateVectorSec = TRUE;
2136 }
2137
2138 //
2139 // Locate a PEI Core instance and if found extract the machine type and entry point address
2140 //
2141 Status = FindCorePeSection(FvImage->FileImage, FvInfo->Size, EFI_FV_FILETYPE_PEI_CORE, &PeiPe32);
2142 if (!EFI_ERROR(Status)) {
2143
2144 Status = GetCoreMachineType(PeiPe32, &PeiMachineType);
2145 if (EFI_ERROR(Status)) {
2146 Error(NULL, 0, 3000, "Invalid", "Could not get the PE32 machine type for PEI Core.");
2147 return EFI_ABORTED;
2148 }
2149
2150 Status = GetCoreEntryPointAddress(FvImage->FileImage, FvInfo, PeiPe32, &PeiCoreEntryAddress);
2151 if (EFI_ERROR(Status)) {
2152 Error(NULL, 0, 3000, "Invalid", "Could not get the PE32 entry point address for PEI Core.");
2153 return EFI_ABORTED;
2154 }
2155
2156 VerboseMsg("UpdateArmResetVectorIfNeeded found PEI core entry at 0x%llx", (unsigned long long)PeiCoreEntryAddress);
2157
2158 // if we previously found an SEC Core make sure machine types match
2159 if (UpdateVectorSec && (MachineType != PeiMachineType)) {
2160 Error(NULL, 0, 3000, "Invalid", "SEC and PEI machine types do not match, can't update reset vector");
2161 return EFI_ABORTED;
2162 }
2163 else {
2164 MachineType = PeiMachineType;
2165 }
2166
2167 UpdateVectorPei = TRUE;
2168 }
2169
2170 if (!UpdateVectorSec && !UpdateVectorPei) {
2171 return EFI_SUCCESS;
2172 }
2173
2174 if (MachineType == EFI_IMAGE_MACHINE_ARMT) {
2175 // ARM: Array of 4 UINT32s:
2176 // 0 - is branch relative to SEC entry point
2177 // 1 - PEI Entry Point
2178 // 2 - movs pc,lr for a SWI handler
2179 // 3 - Place holder for Common Exception Handler
2180 UINT32 ResetVector[4];
2181
2182 memset(ResetVector, 0, sizeof (ResetVector));
2183
2184 // if we found an SEC core entry point then generate a branch instruction
2185 // to it and populate a debugger SWI entry as well
2186 if (UpdateVectorSec) {
2187
2188 VerboseMsg("UpdateArmResetVectorIfNeeded updating ARM SEC vector");
2189
2190 // B SecEntryPoint - signed_immed_24 part +/-32MB offset
2191 // on ARM, the PC is always 8 ahead, so we're not really jumping from the base address, but from base address + 8
2192 ResetVector[0] = (INT32)(SecCoreEntryAddress - FvInfo->BaseAddress - 8) >> 2;
2193
2194 if (ResetVector[0] > 0x00FFFFFF) {
2195 Error(NULL, 0, 3000, "Invalid", "SEC Entry point must be within 32MB of the start of the FV");
2196 return EFI_ABORTED;
2197 }
2198
2199 // Add opcode for an uncondional branch with no link. i.e.: " B SecEntryPoint"
2200 ResetVector[0] |= ARMT_UNCONDITIONAL_JUMP_INSTRUCTION;
2201
2202 // SWI handler movs pc,lr. Just in case a debugger uses SWI
2203 ResetVector[2] = 0xE1B0F07E;
2204
2205 // Place holder to support a common interrupt handler from ROM.
2206 // Currently not suppprted. For this to be used the reset vector would not be in this FV
2207 // and the exception vectors would be hard coded in the ROM and just through this address
2208 // to find a common handler in the a module in the FV.
2209 ResetVector[3] = 0;
2210 }
2211
2212 // if a PEI core entry was found place its address in the vector area
2213 if (UpdateVectorPei) {
2214
2215 VerboseMsg("UpdateArmResetVectorIfNeeded updating ARM PEI address");
2216
2217 // Address of PEI Core, if we have one
2218 ResetVector[1] = (UINT32)PeiCoreEntryAddress;
2219 }
2220
2221 //
2222 // Copy to the beginning of the FV
2223 //
2224 memcpy(FvImage->FileImage, ResetVector, sizeof (ResetVector));
2225
2226 } else if (MachineType == EFI_IMAGE_MACHINE_AARCH64) {
2227 // AArch64: Used as UINT64 ResetVector[2]
2228 // 0 - is branch relative to SEC entry point
2229 // 1 - PEI Entry Point
2230 UINT64 ResetVector[2];
2231
2232 memset(ResetVector, 0, sizeof (ResetVector));
2233
2234 /* NOTE:
2235 ARMT above has an entry in ResetVector[2] for SWI. The way we are using the ResetVector
2236 array at the moment, for AArch64, does not allow us space for this as the header only
2237 allows for a fixed amount of bytes at the start. If we are sure that UEFI will live
2238 within the first 4GB of addressable RAM we could potensioally adopt the same ResetVector
2239 layout as above. But for the moment we replace the four 32bit vectors with two 64bit
2240 vectors in the same area of the Image heasder. This allows UEFI to start from a 64bit
2241 base.
2242 */
2243
2244 // if we found an SEC core entry point then generate a branch instruction to it
2245 if (UpdateVectorSec) {
2246
2247 VerboseMsg("UpdateArmResetVectorIfNeeded updating AArch64 SEC vector");
2248
2249 ResetVector[0] = (UINT64)(SecCoreEntryAddress - FvInfo->BaseAddress) >> 2;
2250
2251 // B SecEntryPoint - signed_immed_26 part +/-128MB offset
2252 if (ResetVector[0] > 0x03FFFFFF) {
2253 Error(NULL, 0, 3000, "Invalid", "SEC Entry point must be within 128MB of the start of the FV");
2254 return EFI_ABORTED;
2255 }
2256 // Add opcode for an uncondional branch with no link. i.e.: " B SecEntryPoint"
2257 ResetVector[0] |= ARM64_UNCONDITIONAL_JUMP_INSTRUCTION;
2258 }
2259
2260 // if a PEI core entry was found place its address in the vector area
2261 if (UpdateVectorPei) {
2262
2263 VerboseMsg("UpdateArmResetVectorIfNeeded updating AArch64 PEI address");
2264
2265 // Address of PEI Core, if we have one
2266 ResetVector[1] = (UINT64)PeiCoreEntryAddress;
2267 }
2268
2269 //
2270 // Copy to the beginning of the FV
2271 //
2272 memcpy(FvImage->FileImage, ResetVector, sizeof (ResetVector));
2273
2274 } else {
2275 Error(NULL, 0, 3000, "Invalid", "Unknown machine type");
2276 return EFI_ABORTED;
2277 }
2278
2279 return EFI_SUCCESS;
2280 }
2281
2282 EFI_STATUS
2283 GetPe32Info (
2284 IN UINT8 *Pe32,
2285 OUT UINT32 *EntryPoint,
2286 OUT UINT32 *BaseOfCode,
2287 OUT UINT16 *MachineType
2288 )
2289 /*++
2290
2291 Routine Description:
2292
2293 Retrieves the PE32 entry point offset and machine type from PE image or TeImage.
2294 See EfiImage.h for machine types. The entry point offset is from the beginning
2295 of the PE32 buffer passed in.
2296
2297 Arguments:
2298
2299 Pe32 Beginning of the PE32.
2300 EntryPoint Offset from the beginning of the PE32 to the image entry point.
2301 BaseOfCode Base address of code.
2302 MachineType Magic number for the machine type.
2303
2304 Returns:
2305
2306 EFI_SUCCESS Function completed successfully.
2307 EFI_ABORTED Error encountered.
2308 EFI_INVALID_PARAMETER A required parameter was NULL.
2309 EFI_UNSUPPORTED The operation is unsupported.
2310
2311 --*/
2312 {
2313 EFI_IMAGE_DOS_HEADER *DosHeader;
2314 EFI_IMAGE_OPTIONAL_HEADER_UNION *ImgHdr;
2315 EFI_TE_IMAGE_HEADER *TeHeader;
2316
2317 //
2318 // Verify input parameters
2319 //
2320 if (Pe32 == NULL) {
2321 return EFI_INVALID_PARAMETER;
2322 }
2323
2324 //
2325 // First check whether it is one TE Image.
2326 //
2327 TeHeader = (EFI_TE_IMAGE_HEADER *) Pe32;
2328 if (TeHeader->Signature == EFI_TE_IMAGE_HEADER_SIGNATURE) {
2329 //
2330 // By TeImage Header to get output
2331 //
2332 *EntryPoint = TeHeader->AddressOfEntryPoint + sizeof (EFI_TE_IMAGE_HEADER) - TeHeader->StrippedSize;
2333 *BaseOfCode = TeHeader->BaseOfCode + sizeof (EFI_TE_IMAGE_HEADER) - TeHeader->StrippedSize;
2334 *MachineType = TeHeader->Machine;
2335 } else {
2336
2337 //
2338 // Then check whether
2339 // First is the DOS header
2340 //
2341 DosHeader = (EFI_IMAGE_DOS_HEADER *) Pe32;
2342
2343 //
2344 // Verify DOS header is expected
2345 //
2346 if (DosHeader->e_magic != EFI_IMAGE_DOS_SIGNATURE) {
2347 Error (NULL, 0, 3000, "Invalid", "Unknown magic number in the DOS header, 0x%04X.", DosHeader->e_magic);
2348 return EFI_UNSUPPORTED;
2349 }
2350 //
2351 // Immediately following is the NT header.
2352 //
2353 ImgHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION *) ((UINTN) Pe32 + DosHeader->e_lfanew);
2354
2355 //
2356 // Verify NT header is expected
2357 //
2358 if (ImgHdr->Pe32.Signature != EFI_IMAGE_NT_SIGNATURE) {
2359 Error (NULL, 0, 3000, "Invalid", "Unrecognized image signature 0x%08X.", (unsigned) ImgHdr->Pe32.Signature);
2360 return EFI_UNSUPPORTED;
2361 }
2362 //
2363 // Get output
2364 //
2365 *EntryPoint = ImgHdr->Pe32.OptionalHeader.AddressOfEntryPoint;
2366 *BaseOfCode = ImgHdr->Pe32.OptionalHeader.BaseOfCode;
2367 *MachineType = ImgHdr->Pe32.FileHeader.Machine;
2368 }
2369
2370 //
2371 // Verify machine type is supported
2372 //
2373 if ((*MachineType != EFI_IMAGE_MACHINE_IA32) && (*MachineType != EFI_IMAGE_MACHINE_IA64) && (*MachineType != EFI_IMAGE_MACHINE_X64) && (*MachineType != EFI_IMAGE_MACHINE_EBC) &&
2374 (*MachineType != EFI_IMAGE_MACHINE_ARMT) && (*MachineType != EFI_IMAGE_MACHINE_AARCH64)) {
2375 Error (NULL, 0, 3000, "Invalid", "Unrecognized machine type in the PE32 file.");
2376 return EFI_UNSUPPORTED;
2377 }
2378
2379 return EFI_SUCCESS;
2380 }
2381
2382 EFI_STATUS
2383 GenerateFvImage (
2384 IN CHAR8 *InfFileImage,
2385 IN UINTN InfFileSize,
2386 IN CHAR8 *FvFileName,
2387 IN CHAR8 *MapFileName
2388 )
2389 /*++
2390
2391 Routine Description:
2392
2393 This is the main function which will be called from application.
2394
2395 Arguments:
2396
2397 InfFileImage Buffer containing the INF file contents.
2398 InfFileSize Size of the contents of the InfFileImage buffer.
2399 FvFileName Requested name for the FV file.
2400 MapFileName Fv map file to log fv driver information.
2401
2402 Returns:
2403
2404 EFI_SUCCESS Function completed successfully.
2405 EFI_OUT_OF_RESOURCES Could not allocate required resources.
2406 EFI_ABORTED Error encountered.
2407 EFI_INVALID_PARAMETER A required parameter was NULL.
2408
2409 --*/
2410 {
2411 EFI_STATUS Status;
2412 MEMORY_FILE InfMemoryFile;
2413 MEMORY_FILE FvImageMemoryFile;
2414 UINTN Index;
2415 EFI_FIRMWARE_VOLUME_HEADER *FvHeader;
2416 EFI_FFS_FILE_HEADER *VtfFileImage;
2417 UINT8 *FvBufferHeader; // to make sure fvimage header 8 type alignment.
2418 UINT8 *FvImage;
2419 UINTN FvImageSize;
2420 FILE *FvFile;
2421 CHAR8 FvMapName [MAX_LONG_FILE_PATH];
2422 FILE *FvMapFile;
2423 EFI_FIRMWARE_VOLUME_EXT_HEADER *FvExtHeader;
2424 FILE *FvExtHeaderFile;
2425 UINTN FileSize;
2426 CHAR8 FvReportName[MAX_LONG_FILE_PATH];
2427 FILE *FvReportFile;
2428
2429 FvBufferHeader = NULL;
2430 FvFile = NULL;
2431 FvMapFile = NULL;
2432 FvReportFile = NULL;
2433
2434 if (InfFileImage != NULL) {
2435 //
2436 // Initialize file structures
2437 //
2438 InfMemoryFile.FileImage = InfFileImage;
2439 InfMemoryFile.CurrentFilePointer = InfFileImage;
2440 InfMemoryFile.Eof = InfFileImage + InfFileSize;
2441
2442 //
2443 // Parse the FV inf file for header information
2444 //
2445 Status = ParseFvInf (&InfMemoryFile, &mFvDataInfo);
2446 if (EFI_ERROR (Status)) {
2447 Error (NULL, 0, 0003, "Error parsing file", "the input FV INF file.");
2448 return Status;
2449 }
2450 }
2451
2452 //
2453 // Update the file name return values
2454 //
2455 if (FvFileName == NULL && mFvDataInfo.FvName[0] != '\0') {
2456 FvFileName = mFvDataInfo.FvName;
2457 }
2458
2459 if (FvFileName == NULL) {
2460 Error (NULL, 0, 1001, "Missing option", "Output file name");
2461 return EFI_ABORTED;
2462 }
2463
2464 if (mFvDataInfo.FvBlocks[0].Length == 0) {
2465 Error (NULL, 0, 1001, "Missing required argument", "Block Size");
2466 return EFI_ABORTED;
2467 }
2468
2469 //
2470 // Debug message Fv File System Guid
2471 //
2472 if (mFvDataInfo.FvFileSystemGuidSet) {
2473 DebugMsg (NULL, 0, 9, "FV File System Guid", "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",
2474 (unsigned) mFvDataInfo.FvFileSystemGuid.Data1,
2475 mFvDataInfo.FvFileSystemGuid.Data2,
2476 mFvDataInfo.FvFileSystemGuid.Data3,
2477 mFvDataInfo.FvFileSystemGuid.Data4[0],
2478 mFvDataInfo.FvFileSystemGuid.Data4[1],
2479 mFvDataInfo.FvFileSystemGuid.Data4[2],
2480 mFvDataInfo.FvFileSystemGuid.Data4[3],
2481 mFvDataInfo.FvFileSystemGuid.Data4[4],
2482 mFvDataInfo.FvFileSystemGuid.Data4[5],
2483 mFvDataInfo.FvFileSystemGuid.Data4[6],
2484 mFvDataInfo.FvFileSystemGuid.Data4[7]);
2485 }
2486
2487 //
2488 // Add PI FV extension header
2489 //
2490 FvExtHeader = NULL;
2491 FvExtHeaderFile = NULL;
2492 if (mFvDataInfo.FvExtHeaderFile[0] != 0) {
2493 //
2494 // Open the FV Extension Header file
2495 //
2496 FvExtHeaderFile = fopen (LongFilePath (mFvDataInfo.FvExtHeaderFile), "rb");
2497
2498 //
2499 // Get the file size
2500 //
2501 FileSize = _filelength (fileno (FvExtHeaderFile));
2502
2503 //
2504 // Allocate a buffer for the FV Extension Header
2505 //
2506 FvExtHeader = malloc(FileSize);
2507 if (FvExtHeader == NULL) {
2508 fclose (FvExtHeaderFile);
2509 return EFI_OUT_OF_RESOURCES;
2510 }
2511
2512 //
2513 // Read the FV Extension Header
2514 //
2515 fread (FvExtHeader, sizeof (UINT8), FileSize, FvExtHeaderFile);
2516 fclose (FvExtHeaderFile);
2517
2518 //
2519 // See if there is an override for the FV Name GUID
2520 //
2521 if (mFvDataInfo.FvNameGuidSet) {
2522 memcpy (&FvExtHeader->FvName, &mFvDataInfo.FvNameGuid, sizeof (EFI_GUID));
2523 }
2524 memcpy (&mFvDataInfo.FvNameGuid, &FvExtHeader->FvName, sizeof (EFI_GUID));
2525 mFvDataInfo.FvNameGuidSet = TRUE;
2526 } else if (mFvDataInfo.FvNameGuidSet) {
2527 //
2528 // Allocate a buffer for the FV Extension Header
2529 //
2530 FvExtHeader = malloc(sizeof (EFI_FIRMWARE_VOLUME_EXT_HEADER));
2531 if (FvExtHeader == NULL) {
2532 return EFI_OUT_OF_RESOURCES;
2533 }
2534 memcpy (&FvExtHeader->FvName, &mFvDataInfo.FvNameGuid, sizeof (EFI_GUID));
2535 FvExtHeader->ExtHeaderSize = sizeof (EFI_FIRMWARE_VOLUME_EXT_HEADER);
2536 }
2537
2538 //
2539 // Debug message Fv Name Guid
2540 //
2541 if (mFvDataInfo.FvNameGuidSet) {
2542 DebugMsg (NULL, 0, 9, "FV Name Guid", "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",
2543 (unsigned) mFvDataInfo.FvNameGuid.Data1,
2544 mFvDataInfo.FvNameGuid.Data2,
2545 mFvDataInfo.FvNameGuid.Data3,
2546 mFvDataInfo.FvNameGuid.Data4[0],
2547 mFvDataInfo.FvNameGuid.Data4[1],
2548 mFvDataInfo.FvNameGuid.Data4[2],
2549 mFvDataInfo.FvNameGuid.Data4[3],
2550 mFvDataInfo.FvNameGuid.Data4[4],
2551 mFvDataInfo.FvNameGuid.Data4[5],
2552 mFvDataInfo.FvNameGuid.Data4[6],
2553 mFvDataInfo.FvNameGuid.Data4[7]);
2554 }
2555
2556 if (CompareGuid (&mFvDataInfo.FvFileSystemGuid, &mEfiFirmwareFileSystem2Guid) == 0 ||
2557 CompareGuid (&mFvDataInfo.FvFileSystemGuid, &mEfiFirmwareFileSystem3Guid) == 0) {
2558 mFvDataInfo.IsPiFvImage = TRUE;
2559 }
2560
2561 //
2562 // FvMap file to log the function address of all modules in one Fvimage
2563 //
2564 if (MapFileName != NULL) {
2565 strcpy (FvMapName, MapFileName);
2566 } else {
2567 strcpy (FvMapName, FvFileName);
2568 strcat (FvMapName, ".map");
2569 }
2570 VerboseMsg ("FV Map file name is %s", FvMapName);
2571
2572 //
2573 // FvReport file to log the FV information in one Fvimage
2574 //
2575 strcpy (FvReportName, FvFileName);
2576 strcat (FvReportName, ".txt");
2577
2578 //
2579 // Calculate the FV size and Update Fv Size based on the actual FFS files.
2580 // And Update mFvDataInfo data.
2581 //
2582 Status = CalculateFvSize (&mFvDataInfo);
2583 if (EFI_ERROR (Status)) {
2584 return Status;
2585 }
2586 VerboseMsg ("the generated FV image size is %u bytes", (unsigned) mFvDataInfo.Size);
2587
2588 //
2589 // support fv image and empty fv image
2590 //
2591 FvImageSize = mFvDataInfo.Size;
2592
2593 //
2594 // Allocate the FV, assure FvImage Header 8 byte alignment
2595 //
2596 FvBufferHeader = malloc (FvImageSize + sizeof (UINT64));
2597 if (FvBufferHeader == NULL) {
2598 return EFI_OUT_OF_RESOURCES;
2599 }
2600 FvImage = (UINT8 *) (((UINTN) FvBufferHeader + 7) & ~7);
2601
2602 //
2603 // Initialize the FV to the erase polarity
2604 //
2605 if (mFvDataInfo.FvAttributes == 0) {
2606 //
2607 // Set Default Fv Attribute
2608 //
2609 mFvDataInfo.FvAttributes = FV_DEFAULT_ATTRIBUTE;
2610 }
2611 if (mFvDataInfo.FvAttributes & EFI_FVB2_ERASE_POLARITY) {
2612 memset (FvImage, -1, FvImageSize);
2613 } else {
2614 memset (FvImage, 0, FvImageSize);
2615 }
2616
2617 //
2618 // Initialize FV header
2619 //
2620 FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) FvImage;
2621
2622 //
2623 // Initialize the zero vector to all zeros.
2624 //
2625 memset (FvHeader->ZeroVector, 0, 16);
2626
2627 //
2628 // Copy the Fv file system GUID
2629 //
2630 memcpy (&FvHeader->FileSystemGuid, &mFvDataInfo.FvFileSystemGuid, sizeof (EFI_GUID));
2631
2632 FvHeader->FvLength = FvImageSize;
2633 FvHeader->Signature = EFI_FVH_SIGNATURE;
2634 FvHeader->Attributes = mFvDataInfo.FvAttributes;
2635 FvHeader->Revision = EFI_FVH_REVISION;
2636 FvHeader->ExtHeaderOffset = 0;
2637 FvHeader->Reserved[0] = 0;
2638
2639 //
2640 // Copy firmware block map
2641 //
2642 for (Index = 0; mFvDataInfo.FvBlocks[Index].Length != 0; Index++) {
2643 FvHeader->BlockMap[Index].NumBlocks = mFvDataInfo.FvBlocks[Index].NumBlocks;
2644 FvHeader->BlockMap[Index].Length = mFvDataInfo.FvBlocks[Index].Length;
2645 }
2646
2647 //
2648 // Add block map terminator
2649 //
2650 FvHeader->BlockMap[Index].NumBlocks = 0;
2651 FvHeader->BlockMap[Index].Length = 0;
2652
2653 //
2654 // Complete the header
2655 //
2656 FvHeader->HeaderLength = (UINT16) (((UINTN) &(FvHeader->BlockMap[Index + 1])) - (UINTN) FvImage);
2657 FvHeader->Checksum = 0;
2658 FvHeader->Checksum = CalculateChecksum16 ((UINT16 *) FvHeader, FvHeader->HeaderLength / sizeof (UINT16));
2659
2660 //
2661 // If there is no FFS file, generate one empty FV
2662 //
2663 if (mFvDataInfo.FvFiles[0][0] == 0 && !mFvDataInfo.FvNameGuidSet) {
2664 goto WriteFile;
2665 }
2666
2667 //
2668 // Initialize our "file" view of the buffer
2669 //
2670 FvImageMemoryFile.FileImage = (CHAR8 *)FvImage;
2671 FvImageMemoryFile.CurrentFilePointer = (CHAR8 *)FvImage + FvHeader->HeaderLength;
2672 FvImageMemoryFile.Eof = (CHAR8 *)FvImage + FvImageSize;
2673
2674 //
2675 // Initialize the FV library.
2676 //
2677 InitializeFvLib (FvImageMemoryFile.FileImage, FvImageSize);
2678
2679 //
2680 // Initialize the VTF file address.
2681 //
2682 VtfFileImage = (EFI_FFS_FILE_HEADER *) FvImageMemoryFile.Eof;
2683
2684 //
2685 // Open FvMap file
2686 //
2687 FvMapFile = fopen (LongFilePath (FvMapName), "w");
2688 if (FvMapFile == NULL) {
2689 Error (NULL, 0, 0001, "Error opening file", FvMapName);
2690 return EFI_ABORTED;
2691 }
2692
2693 //
2694 // Open FvReport file
2695 //
2696 FvReportFile = fopen (LongFilePath (FvReportName), "w");
2697 if (FvReportFile == NULL) {
2698 Error (NULL, 0, 0001, "Error opening file", FvReportName);
2699 return EFI_ABORTED;
2700 }
2701 //
2702 // record FV size information into FvMap file.
2703 //
2704 if (mFvTotalSize != 0) {
2705 fprintf (FvMapFile, EFI_FV_TOTAL_SIZE_STRING);
2706 fprintf (FvMapFile, " = 0x%x\n", (unsigned) mFvTotalSize);
2707 }
2708 if (mFvTakenSize != 0) {
2709 fprintf (FvMapFile, EFI_FV_TAKEN_SIZE_STRING);
2710 fprintf (FvMapFile, " = 0x%x\n", (unsigned) mFvTakenSize);
2711 }
2712 if (mFvTotalSize != 0 && mFvTakenSize != 0) {
2713 fprintf (FvMapFile, EFI_FV_SPACE_SIZE_STRING);
2714 fprintf (FvMapFile, " = 0x%x\n\n", (unsigned) (mFvTotalSize - mFvTakenSize));
2715 }
2716
2717 //
2718 // record FV size information to FvReportFile.
2719 //
2720 fprintf (FvReportFile, "%s = 0x%x\n", EFI_FV_TOTAL_SIZE_STRING, (unsigned) mFvTotalSize);
2721 fprintf (FvReportFile, "%s = 0x%x\n", EFI_FV_TAKEN_SIZE_STRING, (unsigned) mFvTakenSize);
2722
2723 //
2724 // Add PI FV extension header
2725 //
2726 if (FvExtHeader != NULL) {
2727 //
2728 // Add FV Extended Header contents to the FV as a PAD file
2729 //
2730 AddPadFile (&FvImageMemoryFile, 4, VtfFileImage, FvExtHeader, 0);
2731
2732 //
2733 // Fv Extension header change update Fv Header Check sum
2734 //
2735 FvHeader->Checksum = 0;
2736 FvHeader->Checksum = CalculateChecksum16 ((UINT16 *) FvHeader, FvHeader->HeaderLength / sizeof (UINT16));
2737 }
2738
2739 //
2740 // Add files to FV
2741 //
2742 for (Index = 0; mFvDataInfo.FvFiles[Index][0] != 0; Index++) {
2743 //
2744 // Add the file
2745 //
2746 Status = AddFile (&FvImageMemoryFile, &mFvDataInfo, Index, &VtfFileImage, FvMapFile, FvReportFile);
2747
2748 //
2749 // Exit if error detected while adding the file
2750 //
2751 if (EFI_ERROR (Status)) {
2752 goto Finish;
2753 }
2754 }
2755
2756 //
2757 // If there is a VTF file, some special actions need to occur.
2758 //
2759 if ((UINTN) VtfFileImage != (UINTN) FvImageMemoryFile.Eof) {
2760 //
2761 // Pad from the end of the last file to the beginning of the VTF file.
2762 // If the left space is less than sizeof (EFI_FFS_FILE_HEADER)?
2763 //
2764 Status = PadFvImage (&FvImageMemoryFile, VtfFileImage);
2765 if (EFI_ERROR (Status)) {
2766 Error (NULL, 0, 4002, "Resource", "FV space is full, cannot add pad file between the last file and the VTF file.");
2767 goto Finish;
2768 }
2769 if (!mArm) {
2770 //
2771 // Update reset vector (SALE_ENTRY for IPF)
2772 // Now for IA32 and IA64 platform, the fv which has bsf file must have the
2773 // EndAddress of 0xFFFFFFFF (unless the section was rebased).
2774 // Thus, only this type fv needs to update the reset vector.
2775 // If the PEI Core is found, the VTF file will probably get
2776 // corrupted by updating the entry point.
2777 //
2778 if (mFvDataInfo.ForceRebase == 1 ||
2779 (mFvDataInfo.BaseAddress + mFvDataInfo.Size) == FV_IMAGES_TOP_ADDRESS) {
2780 Status = UpdateResetVector (&FvImageMemoryFile, &mFvDataInfo, VtfFileImage);
2781 if (EFI_ERROR(Status)) {
2782 Error (NULL, 0, 3000, "Invalid", "Could not update the reset vector.");
2783 goto Finish;
2784 }
2785 DebugMsg (NULL, 0, 9, "Update Reset vector in VTF file", NULL);
2786 }
2787 }
2788 }
2789
2790 if (mArm) {
2791 Status = UpdateArmResetVectorIfNeeded (&FvImageMemoryFile, &mFvDataInfo);
2792 if (EFI_ERROR (Status)) {
2793 Error (NULL, 0, 3000, "Invalid", "Could not update the reset vector.");
2794 goto Finish;
2795 }
2796
2797 //
2798 // Update Checksum for FvHeader
2799 //
2800 FvHeader->Checksum = 0;
2801 FvHeader->Checksum = CalculateChecksum16 ((UINT16 *) FvHeader, FvHeader->HeaderLength / sizeof (UINT16));
2802 }
2803
2804 //
2805 // Update FV Alignment attribute to the largest alignment of all the FFS files in the FV
2806 //
2807 if (((FvHeader->Attributes & EFI_FVB2_WEAK_ALIGNMENT) != EFI_FVB2_WEAK_ALIGNMENT) &&
2808 (((FvHeader->Attributes & EFI_FVB2_ALIGNMENT) >> 16)) < MaxFfsAlignment) {
2809 FvHeader->Attributes = ((MaxFfsAlignment << 16) | (FvHeader->Attributes & 0xFFFF));
2810 //
2811 // Update Checksum for FvHeader
2812 //
2813 FvHeader->Checksum = 0;
2814 FvHeader->Checksum = CalculateChecksum16 ((UINT16 *) FvHeader, FvHeader->HeaderLength / sizeof (UINT16));
2815 }
2816
2817 //
2818 // If there are large FFS in FV, the file system GUID should set to system 3 GUID.
2819 //
2820 if (mIsLargeFfs && CompareGuid (&FvHeader->FileSystemGuid, &mEfiFirmwareFileSystem2Guid) == 0) {
2821 memcpy (&FvHeader->FileSystemGuid, &mEfiFirmwareFileSystem3Guid, sizeof (EFI_GUID));
2822 FvHeader->Checksum = 0;
2823 FvHeader->Checksum = CalculateChecksum16 ((UINT16 *) FvHeader, FvHeader->HeaderLength / sizeof (UINT16));
2824 }
2825
2826 WriteFile:
2827 //
2828 // Write fv file
2829 //
2830 FvFile = fopen (LongFilePath (FvFileName), "wb");
2831 if (FvFile == NULL) {
2832 Error (NULL, 0, 0001, "Error opening file", FvFileName);
2833 Status = EFI_ABORTED;
2834 goto Finish;
2835 }
2836
2837 if (fwrite (FvImage, 1, FvImageSize, FvFile) != FvImageSize) {
2838 Error (NULL, 0, 0002, "Error writing file", FvFileName);
2839 Status = EFI_ABORTED;
2840 goto Finish;
2841 }
2842
2843 Finish:
2844 if (FvBufferHeader != NULL) {
2845 free (FvBufferHeader);
2846 }
2847
2848 if (FvExtHeader != NULL) {
2849 free (FvExtHeader);
2850 }
2851
2852 if (FvFile != NULL) {
2853 fflush (FvFile);
2854 fclose (FvFile);
2855 }
2856
2857 if (FvMapFile != NULL) {
2858 fflush (FvMapFile);
2859 fclose (FvMapFile);
2860 }
2861
2862 if (FvReportFile != NULL) {
2863 fflush (FvReportFile);
2864 fclose (FvReportFile);
2865 }
2866 return Status;
2867 }
2868
2869 EFI_STATUS
2870 UpdatePeiCoreEntryInFit (
2871 IN FIT_TABLE *FitTablePtr,
2872 IN UINT64 PeiCorePhysicalAddress
2873 )
2874 /*++
2875
2876 Routine Description:
2877
2878 This function is used to update the Pei Core address in FIT, this can be used by Sec core to pass control from
2879 Sec to Pei Core
2880
2881 Arguments:
2882
2883 FitTablePtr - The pointer of FIT_TABLE.
2884 PeiCorePhysicalAddress - The address of Pei Core entry.
2885
2886 Returns:
2887
2888 EFI_SUCCESS - The PEI_CORE FIT entry was updated successfully.
2889 EFI_NOT_FOUND - Not found the PEI_CORE FIT entry.
2890
2891 --*/
2892 {
2893 FIT_TABLE *TmpFitPtr;
2894 UINTN Index;
2895 UINTN NumFitComponents;
2896
2897 TmpFitPtr = FitTablePtr;
2898 NumFitComponents = TmpFitPtr->CompSize;
2899
2900 for (Index = 0; Index < NumFitComponents; Index++) {
2901 if ((TmpFitPtr->CvAndType & FIT_TYPE_MASK) == COMP_TYPE_FIT_PEICORE) {
2902 TmpFitPtr->CompAddress = PeiCorePhysicalAddress;
2903 return EFI_SUCCESS;
2904 }
2905
2906 TmpFitPtr++;
2907 }
2908
2909 return EFI_NOT_FOUND;
2910 }
2911
2912 VOID
2913 UpdateFitCheckSum (
2914 IN FIT_TABLE *FitTablePtr
2915 )
2916 /*++
2917
2918 Routine Description:
2919
2920 This function is used to update the checksum for FIT.
2921
2922
2923 Arguments:
2924
2925 FitTablePtr - The pointer of FIT_TABLE.
2926
2927 Returns:
2928
2929 None.
2930
2931 --*/
2932 {
2933 if ((FitTablePtr->CvAndType & CHECKSUM_BIT_MASK) >> 7) {
2934 FitTablePtr->CheckSum = 0;
2935 FitTablePtr->CheckSum = CalculateChecksum8 ((UINT8 *) FitTablePtr, FitTablePtr->CompSize * 16);
2936 }
2937 }
2938
2939 EFI_STATUS
2940 CalculateFvSize (
2941 FV_INFO *FvInfoPtr
2942 )
2943 /*++
2944 Routine Description:
2945 Calculate the FV size and Update Fv Size based on the actual FFS files.
2946 And Update FvInfo data.
2947
2948 Arguments:
2949 FvInfoPtr - The pointer to FV_INFO structure.
2950
2951 Returns:
2952 EFI_ABORTED - Ffs Image Error
2953 EFI_SUCCESS - Successfully update FvSize
2954 --*/
2955 {
2956 UINTN CurrentOffset;
2957 UINTN Index;
2958 FILE *fpin;
2959 UINTN FfsFileSize;
2960 UINTN FvExtendHeaderSize;
2961 UINT32 FfsAlignment;
2962 UINT32 FfsHeaderSize;
2963 EFI_FFS_FILE_HEADER FfsHeader;
2964 BOOLEAN VtfFileFlag;
2965 UINTN VtfFileSize;
2966
2967 FvExtendHeaderSize = 0;
2968 VtfFileSize = 0;
2969 VtfFileFlag = FALSE;
2970 fpin = NULL;
2971 Index = 0;
2972
2973 //
2974 // Compute size for easy access later
2975 //
2976 FvInfoPtr->Size = 0;
2977 for (Index = 0; FvInfoPtr->FvBlocks[Index].NumBlocks > 0 && FvInfoPtr->FvBlocks[Index].Length > 0; Index++) {
2978 FvInfoPtr->Size += FvInfoPtr->FvBlocks[Index].NumBlocks * FvInfoPtr->FvBlocks[Index].Length;
2979 }
2980
2981 //
2982 // Calculate the required sizes for all FFS files.
2983 //
2984 CurrentOffset = sizeof (EFI_FIRMWARE_VOLUME_HEADER);
2985
2986 for (Index = 1;; Index ++) {
2987 CurrentOffset += sizeof (EFI_FV_BLOCK_MAP_ENTRY);
2988 if (FvInfoPtr->FvBlocks[Index].NumBlocks == 0 || FvInfoPtr->FvBlocks[Index].Length == 0) {
2989 break;
2990 }
2991 }
2992
2993 //
2994 // Calculate PI extension header
2995 //
2996 if (mFvDataInfo.FvExtHeaderFile[0] != '\0') {
2997 fpin = fopen (LongFilePath (mFvDataInfo.FvExtHeaderFile), "rb");
2998 if (fpin == NULL) {
2999 Error (NULL, 0, 0001, "Error opening file", mFvDataInfo.FvExtHeaderFile);
3000 return EFI_ABORTED;
3001 }
3002 FvExtendHeaderSize = _filelength (fileno (fpin));
3003 fclose (fpin);
3004 if (sizeof (EFI_FFS_FILE_HEADER) + FvExtendHeaderSize >= MAX_FFS_SIZE) {
3005 CurrentOffset += sizeof (EFI_FFS_FILE_HEADER2) + FvExtendHeaderSize;
3006 mIsLargeFfs = TRUE;
3007 } else {
3008 CurrentOffset += sizeof (EFI_FFS_FILE_HEADER) + FvExtendHeaderSize;
3009 }
3010 CurrentOffset = (CurrentOffset + 7) & (~7);
3011 } else if (mFvDataInfo.FvNameGuidSet) {
3012 CurrentOffset += sizeof (EFI_FFS_FILE_HEADER) + sizeof (EFI_FIRMWARE_VOLUME_EXT_HEADER);
3013 CurrentOffset = (CurrentOffset + 7) & (~7);
3014 }
3015
3016 //
3017 // Accumlate every FFS file size.
3018 //
3019 for (Index = 0; FvInfoPtr->FvFiles[Index][0] != 0; Index++) {
3020 //
3021 // Open FFS file
3022 //
3023 fpin = NULL;
3024 fpin = fopen (LongFilePath (FvInfoPtr->FvFiles[Index]), "rb");
3025 if (fpin == NULL) {
3026 Error (NULL, 0, 0001, "Error opening file", FvInfoPtr->FvFiles[Index]);
3027 return EFI_ABORTED;
3028 }
3029 //
3030 // Get the file size
3031 //
3032 FfsFileSize = _filelength (fileno (fpin));
3033 if (FfsFileSize >= MAX_FFS_SIZE) {
3034 FfsHeaderSize = sizeof(EFI_FFS_FILE_HEADER2);
3035 mIsLargeFfs = TRUE;
3036 } else {
3037 FfsHeaderSize = sizeof(EFI_FFS_FILE_HEADER);
3038 }
3039 //
3040 // Read Ffs File header
3041 //
3042 fread (&FfsHeader, sizeof (UINT8), sizeof (EFI_FFS_FILE_HEADER), fpin);
3043 //
3044 // close file
3045 //
3046 fclose (fpin);
3047
3048 if (FvInfoPtr->IsPiFvImage) {
3049 //
3050 // Check whether this ffs file is vtf file
3051 //
3052 if (IsVtfFile (&FfsHeader)) {
3053 if (VtfFileFlag) {
3054 //
3055 // One Fv image can't have two vtf files.
3056 //
3057 Error (NULL, 0, 3000,"Invalid", "One Fv image can't have two vtf files.");
3058 return EFI_ABORTED;
3059 }
3060 VtfFileFlag = TRUE;
3061 VtfFileSize = FfsFileSize;
3062 continue;
3063 }
3064
3065 //
3066 // Get the alignment of FFS file
3067 //
3068 ReadFfsAlignment (&FfsHeader, &FfsAlignment);
3069 FfsAlignment = 1 << FfsAlignment;
3070 //
3071 // Add Pad file
3072 //
3073 if (((CurrentOffset + FfsHeaderSize) % FfsAlignment) != 0) {
3074 //
3075 // Only EFI_FFS_FILE_HEADER is needed for a pad section.
3076 //
3077 CurrentOffset = (CurrentOffset + FfsHeaderSize + sizeof(EFI_FFS_FILE_HEADER) + FfsAlignment - 1) & ~(FfsAlignment - 1);
3078 CurrentOffset -= FfsHeaderSize;
3079 }
3080 }
3081
3082 //
3083 // Add ffs file size
3084 //
3085 if (FvInfoPtr->SizeofFvFiles[Index] > FfsFileSize) {
3086 CurrentOffset += FvInfoPtr->SizeofFvFiles[Index];
3087 } else {
3088 CurrentOffset += FfsFileSize;
3089 }
3090
3091 //
3092 // Make next ffs file start at QWord Boundry
3093 //
3094 if (FvInfoPtr->IsPiFvImage) {
3095 CurrentOffset = (CurrentOffset + EFI_FFS_FILE_HEADER_ALIGNMENT - 1) & ~(EFI_FFS_FILE_HEADER_ALIGNMENT - 1);
3096 }
3097 }
3098 CurrentOffset += VtfFileSize;
3099 DebugMsg (NULL, 0, 9, "FvImage size", "The calculated fv image size is 0x%x and the current set fv image size is 0x%x", (unsigned) CurrentOffset, (unsigned) FvInfoPtr->Size);
3100
3101 if (FvInfoPtr->Size == 0) {
3102 //
3103 // Update FvInfo data
3104 //
3105 FvInfoPtr->FvBlocks[0].NumBlocks = CurrentOffset / FvInfoPtr->FvBlocks[0].Length + ((CurrentOffset % FvInfoPtr->FvBlocks[0].Length)?1:0);
3106 FvInfoPtr->Size = FvInfoPtr->FvBlocks[0].NumBlocks * FvInfoPtr->FvBlocks[0].Length;
3107 FvInfoPtr->FvBlocks[1].NumBlocks = 0;
3108 FvInfoPtr->FvBlocks[1].Length = 0;
3109 } else if (FvInfoPtr->Size < CurrentOffset) {
3110 //
3111 // Not invalid
3112 //
3113 Error (NULL, 0, 3000, "Invalid", "the required fv image size 0x%x exceeds the set fv image size 0x%x", (unsigned) CurrentOffset, (unsigned) FvInfoPtr->Size);
3114 return EFI_INVALID_PARAMETER;
3115 }
3116
3117 //
3118 // Set Fv Size Information
3119 //
3120 mFvTotalSize = FvInfoPtr->Size;
3121 mFvTakenSize = CurrentOffset;
3122
3123 return EFI_SUCCESS;
3124 }
3125
3126 EFI_STATUS
3127 FfsRebaseImageRead (
3128 IN VOID *FileHandle,
3129 IN UINTN FileOffset,
3130 IN OUT UINT32 *ReadSize,
3131 OUT VOID *Buffer
3132 )
3133 /*++
3134