4 Copyright (c) 2004, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 This file contains functions required to generate a Firmware Volume.
27 #include <uuid/uuid.h>
36 #include <Common/UefiBaseTypes.h>
37 #include <Common/FirmwareVolumeImageFormat.h>
38 #include <Common/Variable.h>
39 #include <Common/WorkingBlockHeader.h>
40 #include <Guid/FirmwareFileSystem.h>
42 #include "GenFvImageLib.h"
43 #include "GenFvImageLibInternal.h"
44 #include "CommonLib.h"
46 #include "EfiUtilityMsgs.h"
48 #include "EfiCompress.h"
49 #include "WinNtInclude.h"
53 // Local function prototypes
58 OUT UINT32
*EntryPoint
,
59 OUT UINT32
*BaseOfCode
,
60 OUT UINT16
*MachineType
64 // Local function implementations.
66 EFI_GUID FfsGuid
= EFI_FIRMWARE_FILE_SYSTEM_GUID
;
67 EFI_GUID DefaultFvPadFileNameGuid
= { 0x78f54d4, 0xcc22, 0x4048, 0x9e, 0x94, 0x87, 0x9c, 0x21, 0x4d, 0x56, 0x2f };
70 // This data array will be located at the base of the Firmware Volume Header (FVH)
71 // in the boot block. It must not exceed 14 bytes of code. The last 2 bytes
72 // will be used to keep the FVH checksum consistent.
73 // This code will be run in response to a starutp IPI for HT-enabled systems.
75 #define SIZEOF_STARTUP_DATA_ARRAY 0x10
77 UINT8 m128kRecoveryStartupApDataArray
[SIZEOF_STARTUP_DATA_ARRAY
] = {
79 // EA D0 FF 00 F0 ; far jmp F000:FFD0
80 // 0, 0, 0, 0, 0, 0, 0, 0, 0, ; Reserved bytes
81 // 0, 0 ; Checksum Padding
101 UINT8 m64kRecoveryStartupApDataArray
[SIZEOF_STARTUP_DATA_ARRAY
] = {
103 // EB CE ; jmp short ($-0x30)
104 // ; (from offset 0x0 to offset 0xFFD0)
105 // 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, ; Reserved bytes
106 // 0, 0 ; Checksum Padding
128 IN MEMORY_FILE
*InfFile
,
135 This function parses a FV.INF file and copies info into a FV_INFO structure.
139 InfFile Memory file image.
140 FvInfo Information read from INF file.
144 EFI_SUCCESS INF file information successfully retrieved.
145 EFI_ABORTED INF file has an invalid format.
146 EFI_NOT_FOUND A required string was not found in the INF file.
149 CHAR8 Value
[_MAX_PATH
];
155 // Initialize FV info
157 memset (FvInfo
, 0, sizeof (FV_INFO
));
160 // Read the FV base address
162 Status
= FindToken (InfFile
, OPTIONS_SECTION_STRING
, EFI_FV_BASE_ADDRESS_STRING
, 0, Value
);
164 if (Status
== EFI_SUCCESS
) {
166 // Get the base address
168 Status
= AsciiStringToUint64 (Value
, FALSE
, &Value64
);
169 if (EFI_ERROR (Status
)) {
170 Error (NULL
, 0, 0, EFI_FV_BASE_ADDRESS_STRING
, "invalid value");
174 FvInfo
->BaseAddress
= Value64
;
176 Error (NULL
, 0, 0, EFI_FV_BASE_ADDRESS_STRING
, "could not find value");
182 Status
= FindToken (InfFile
, OPTIONS_SECTION_STRING
, EFI_FV_GUID_STRING
, 0, Value
);
184 if (Status
== EFI_SUCCESS
) {
186 // Get the guid value
188 Status
= StringToGuid (Value
, &FvInfo
->FvGuid
);
189 if (EFI_ERROR (Status
)) {
190 memcpy (&FvInfo
->FvGuid
, &FfsGuid
, sizeof (EFI_GUID
));
193 memcpy (&FvInfo
->FvGuid
, &FfsGuid
, sizeof (EFI_GUID
));
196 // Read the FV file name
198 Status
= FindToken (InfFile
, OPTIONS_SECTION_STRING
, EFI_FV_FILE_NAME_STRING
, 0, Value
);
200 if (Status
== EFI_SUCCESS
) {
202 // copy the file name
204 strcpy (FvInfo
->FvName
, Value
);
206 Error (NULL
, 0, 0, EFI_FV_FILE_NAME_STRING
, "value not specified");
210 // Read the Sym file name
212 Status
= FindToken (InfFile
, OPTIONS_SECTION_STRING
, EFI_SYM_FILE_NAME_STRING
, 0, Value
);
214 if (Status
== EFI_SUCCESS
) {
216 // copy the file name
218 strcpy (FvInfo
->SymName
, Value
);
221 // Symbols not required, so init to NULL.
223 strcpy (FvInfo
->SymName
, "");
226 // Read the read disabled capability attribute
228 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_READ_DISABLED_CAP_STRING
, 0, Value
);
230 if (Status
== EFI_SUCCESS
) {
232 // Update the read disabled flag
234 if (strcmp (Value
, TRUE_STRING
) == 0) {
235 FvInfo
->FvAttributes
|= EFI_FVB_READ_DISABLED_CAP
;
236 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
237 Error (NULL
, 0, 0, EFI_FVB_READ_DISABLED_CAP_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
241 Error (NULL
, 0, 0, EFI_FVB_READ_DISABLED_CAP_STRING
, "value not specified");
245 // Read the read enabled capability attribute
247 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_READ_ENABLED_CAP_STRING
, 0, Value
);
249 if (Status
== EFI_SUCCESS
) {
251 // Update the read disabled flag
253 if (strcmp (Value
, TRUE_STRING
) == 0) {
254 FvInfo
->FvAttributes
|= EFI_FVB_READ_ENABLED_CAP
;
255 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
256 Error (NULL
, 0, 0, EFI_FVB_READ_ENABLED_CAP_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
260 Error (NULL
, 0, 0, EFI_FVB_READ_ENABLED_CAP_STRING
, "value not specified");
264 // Read the read status attribute
266 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_READ_STATUS_STRING
, 0, Value
);
268 if (Status
== EFI_SUCCESS
) {
270 // Update the read disabled flag
272 if (strcmp (Value
, TRUE_STRING
) == 0) {
273 FvInfo
->FvAttributes
|= EFI_FVB_READ_STATUS
;
274 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
275 Error (NULL
, 0, 0, EFI_FVB_READ_STATUS_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
279 Error (NULL
, 0, 0, EFI_FVB_READ_STATUS_STRING
, "value not specified");
283 // Read the write disabled capability attribute
285 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_WRITE_DISABLED_CAP_STRING
, 0, Value
);
287 if (Status
== EFI_SUCCESS
) {
289 // Update the write disabled flag
291 if (strcmp (Value
, TRUE_STRING
) == 0) {
292 FvInfo
->FvAttributes
|= EFI_FVB_WRITE_DISABLED_CAP
;
293 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
294 Error (NULL
, 0, 0, EFI_FVB_WRITE_DISABLED_CAP_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
298 Error (NULL
, 0, 0, EFI_FVB_WRITE_DISABLED_CAP_STRING
, "value not specified");
302 // Read the write enabled capability attribute
304 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_WRITE_ENABLED_CAP_STRING
, 0, Value
);
306 if (Status
== EFI_SUCCESS
) {
308 // Update the write disabled flag
310 if (strcmp (Value
, TRUE_STRING
) == 0) {
311 FvInfo
->FvAttributes
|= EFI_FVB_WRITE_ENABLED_CAP
;
312 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
313 Error (NULL
, 0, 0, EFI_FVB_WRITE_ENABLED_CAP_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
317 Error (NULL
, 0, 0, EFI_FVB_WRITE_ENABLED_CAP_STRING
, "value not specified");
321 // Read the write status attribute
323 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_WRITE_STATUS_STRING
, 0, Value
);
325 if (Status
== EFI_SUCCESS
) {
327 // Update the write disabled flag
329 if (strcmp (Value
, TRUE_STRING
) == 0) {
330 FvInfo
->FvAttributes
|= EFI_FVB_WRITE_STATUS
;
331 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
332 Error (NULL
, 0, 0, EFI_FVB_WRITE_STATUS_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
336 Error (NULL
, 0, 0, EFI_FVB_WRITE_STATUS_STRING
, "value not specified");
340 // Read the lock capability attribute
342 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_LOCK_CAP_STRING
, 0, Value
);
344 if (Status
== EFI_SUCCESS
) {
346 // Update the attribute flag
348 if (strcmp (Value
, TRUE_STRING
) == 0) {
349 FvInfo
->FvAttributes
|= EFI_FVB_LOCK_CAP
;
350 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
351 Error (NULL
, 0, 0, EFI_FVB_LOCK_CAP_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
355 Error (NULL
, 0, 0, EFI_FVB_LOCK_CAP_STRING
, "value not specified");
359 // Read the lock status attribute
361 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_LOCK_STATUS_STRING
, 0, Value
);
363 if (Status
== EFI_SUCCESS
) {
365 // Update the attribute flag
367 if (strcmp (Value
, TRUE_STRING
) == 0) {
368 FvInfo
->FvAttributes
|= EFI_FVB_LOCK_STATUS
;
369 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
370 Error (NULL
, 0, 0, EFI_FVB_LOCK_STATUS_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
374 Error (NULL
, 0, 0, EFI_FVB_LOCK_STATUS_STRING
, "value not specified");
378 // Read the sticky write attribute
380 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_STICKY_WRITE_STRING
, 0, Value
);
382 if (Status
== EFI_SUCCESS
) {
384 // Update the attribute flag
386 if (strcmp (Value
, TRUE_STRING
) == 0) {
387 FvInfo
->FvAttributes
|= EFI_FVB_STICKY_WRITE
;
388 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
389 Error (NULL
, 0, 0, EFI_FVB_STICKY_WRITE_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
393 Error (NULL
, 0, 0, EFI_FVB_STICKY_WRITE_STRING
, "value not specified");
397 // Read the memory mapped attribute
399 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_MEMORY_MAPPED_STRING
, 0, Value
);
401 if (Status
== EFI_SUCCESS
) {
403 // Update the attribute flag
405 if (strcmp (Value
, TRUE_STRING
) == 0) {
406 FvInfo
->FvAttributes
|= EFI_FVB_MEMORY_MAPPED
;
407 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
408 Error (NULL
, 0, 0, EFI_FVB_MEMORY_MAPPED_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
412 Error (NULL
, 0, 0, EFI_FVB_MEMORY_MAPPED_STRING
, "value not specified");
416 // Read the erase polarity attribute
418 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ERASE_POLARITY_STRING
, 0, Value
);
420 if (Status
== EFI_SUCCESS
) {
422 // Update the attribute flag
424 if (strcmp (Value
, ONE_STRING
) == 0) {
425 FvInfo
->FvAttributes
|= EFI_FVB_ERASE_POLARITY
;
426 } else if (strcmp (Value
, ZERO_STRING
) != 0) {
427 Error (NULL
, 0, 0, EFI_FVB_ERASE_POLARITY_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
431 Error (NULL
, 0, 0, EFI_FVB_ERASE_POLARITY_STRING
, "value not specified");
435 // Read the alignment capabilities attribute
437 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_CAP_STRING
, 0, Value
);
439 if (Status
== EFI_SUCCESS
) {
443 if (strcmp (Value
, TRUE_STRING
) == 0) {
444 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_CAP
;
445 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
446 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_CAP_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
450 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_CAP_STRING
, "value not specified");
454 // Read the word alignment capability attribute
456 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_2_STRING
, 0, Value
);
458 if (Status
== EFI_SUCCESS
) {
462 if (strcmp (Value
, TRUE_STRING
) == 0) {
463 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_2
;
464 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
465 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_2_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
469 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_2_STRING
, "value not specified");
473 // Read the dword alignment capability attribute
475 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_4_STRING
, 0, Value
);
477 if (Status
== EFI_SUCCESS
) {
481 if (strcmp (Value
, TRUE_STRING
) == 0) {
482 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_4
;
483 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
484 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_4_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
488 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_4_STRING
, "value not specified");
492 // Read the word alignment capability attribute
494 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_8_STRING
, 0, Value
);
496 if (Status
== EFI_SUCCESS
) {
500 if (strcmp (Value
, TRUE_STRING
) == 0) {
501 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_8
;
502 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
503 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_8_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
507 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_8_STRING
, "value not specified");
511 // Read the qword alignment capability attribute
513 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_16_STRING
, 0, Value
);
515 if (Status
== EFI_SUCCESS
) {
519 if (strcmp (Value
, TRUE_STRING
) == 0) {
520 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_16
;
521 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
522 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_16_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
526 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_16_STRING
, "value not specified");
530 // Read the 32 byte alignment capability attribute
532 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_32_STRING
, 0, Value
);
534 if (Status
== EFI_SUCCESS
) {
538 if (strcmp (Value
, TRUE_STRING
) == 0) {
539 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_32
;
540 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
541 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_32_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
545 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_32_STRING
, "value not specified");
549 // Read the 64 byte alignment capability attribute
551 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_64_STRING
, 0, Value
);
553 if (Status
== EFI_SUCCESS
) {
557 if (strcmp (Value
, TRUE_STRING
) == 0) {
558 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_64
;
559 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
560 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_64_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
564 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_64_STRING
, "value not specified");
568 // Read the 128 byte alignment capability attribute
570 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_128_STRING
, 0, Value
);
572 if (Status
== EFI_SUCCESS
) {
576 if (strcmp (Value
, TRUE_STRING
) == 0) {
577 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_128
;
578 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
579 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_128_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
583 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_128_STRING
, "value not specified");
587 // Read the 256 byte alignment capability attribute
589 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_256_STRING
, 0, Value
);
591 if (Status
== EFI_SUCCESS
) {
595 if (strcmp (Value
, TRUE_STRING
) == 0) {
596 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_256
;
597 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
598 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_256_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
602 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_256_STRING
, "value not specified");
606 // Read the 512 byte alignment capability attribute
608 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_512_STRING
, 0, Value
);
610 if (Status
== EFI_SUCCESS
) {
614 if (strcmp (Value
, TRUE_STRING
) == 0) {
615 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_512
;
616 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
617 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_512_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
621 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_512_STRING
, "value not specified");
625 // Read the 1K byte alignment capability attribute
627 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_1K_STRING
, 0, Value
);
629 if (Status
== EFI_SUCCESS
) {
633 if (strcmp (Value
, TRUE_STRING
) == 0) {
634 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_1K
;
635 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
636 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_1K_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
640 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_1K_STRING
, "value not specified");
644 // Read the 2K byte alignment capability attribute
646 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_2K_STRING
, 0, Value
);
648 if (Status
== EFI_SUCCESS
) {
652 if (strcmp (Value
, TRUE_STRING
) == 0) {
653 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_2K
;
654 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
655 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_2K_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
659 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_2K_STRING
, "value not specified");
663 // Read the 4K byte alignment capability attribute
665 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_4K_STRING
, 0, Value
);
667 if (Status
== EFI_SUCCESS
) {
671 if (strcmp (Value
, TRUE_STRING
) == 0) {
672 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_4K
;
673 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
674 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_4K_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
678 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_4K_STRING
, "value not specified");
682 // Read the 8K byte alignment capability attribute
684 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_8K_STRING
, 0, Value
);
686 if (Status
== EFI_SUCCESS
) {
690 if (strcmp (Value
, TRUE_STRING
) == 0) {
691 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_8K
;
692 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
693 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_8K_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
697 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_8K_STRING
, "value not specified");
701 // Read the 16K byte alignment capability attribute
703 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_16K_STRING
, 0, Value
);
705 if (Status
== EFI_SUCCESS
) {
709 if (strcmp (Value
, TRUE_STRING
) == 0) {
710 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_16K
;
711 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
712 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_16K_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
716 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_16K_STRING
, "value not specified");
720 // Read the 32K byte alignment capability attribute
722 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_32K_STRING
, 0, Value
);
724 if (Status
== EFI_SUCCESS
) {
728 if (strcmp (Value
, TRUE_STRING
) == 0) {
729 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_32K
;
730 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
731 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_32K_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
735 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_32K_STRING
, "value not specified");
739 // Read the 64K byte alignment capability attribute
741 Status
= FindToken (InfFile
, ATTRIBUTES_SECTION_STRING
, EFI_FVB_ALIGNMENT_64K_STRING
, 0, Value
);
743 if (Status
== EFI_SUCCESS
) {
747 if (strcmp (Value
, TRUE_STRING
) == 0) {
748 FvInfo
->FvAttributes
|= EFI_FVB_ALIGNMENT_64K
;
749 } else if (strcmp (Value
, FALSE_STRING
) != 0) {
750 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_64K_STRING
, "expected %s | %s", TRUE_STRING
, FALSE_STRING
);
754 Error (NULL
, 0, 0, EFI_FVB_ALIGNMENT_64K_STRING
, "value not specified");
758 if (!(FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_CAP
) &&
760 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_2
) ||
761 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_4
) ||
762 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_8
) ||
763 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_16
) ||
764 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_32
) ||
765 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_64
) ||
766 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_128
) ||
767 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_256
) ||
768 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_512
) ||
769 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_1K
) ||
770 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_2K
) ||
771 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_4K
) ||
772 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_8K
) ||
773 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_16K
) ||
774 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_32K
) ||
775 (FvInfo
->FvAttributes
& EFI_FVB_ALIGNMENT_64K
)
782 "illegal combination of alignment attributes",
783 "if %s is not %s, no individual alignments can be %s",
784 EFI_FVB_ALIGNMENT_CAP_STRING
,
793 for (Index
= 0; Index
< MAX_NUMBER_OF_FV_BLOCKS
; Index
++) {
795 // Read the number of blocks
797 Status
= FindToken (InfFile
, OPTIONS_SECTION_STRING
, EFI_NUM_BLOCKS_STRING
, Index
, Value
);
799 if (Status
== EFI_SUCCESS
) {
801 // Update the number of blocks
803 Status
= AsciiStringToUint64 (Value
, FALSE
, &Value64
);
804 if (EFI_ERROR (Status
)) {
805 Error (NULL
, 0, 0, Value
, "invalid value for %s", EFI_NUM_BLOCKS_STRING
);
809 FvInfo
->FvBlocks
[Index
].NumBlocks
= (UINT32
) Value64
;
812 // If there is no number of blocks, but there is a size, then we have a mismatched pair
813 // and should return an error.
815 Status
= FindToken (InfFile
, OPTIONS_SECTION_STRING
, EFI_BLOCK_SIZE_STRING
, Index
, Value
);
816 if (!EFI_ERROR (Status
)) {
817 Error (NULL
, 0, 0, "must specify both", "%s and %s", EFI_NUM_BLOCKS_STRING
, EFI_BLOCK_SIZE_STRING
);
827 // Read the size of blocks
829 Status
= FindToken (InfFile
, OPTIONS_SECTION_STRING
, EFI_BLOCK_SIZE_STRING
, Index
, Value
);
831 if (Status
== EFI_SUCCESS
) {
833 // Update the number of blocks
835 Status
= AsciiStringToUint64 (Value
, FALSE
, &Value64
);
836 if (EFI_ERROR (Status
)) {
837 Error (NULL
, 0, 0, Value
, "invalid value specified for %s", EFI_BLOCK_SIZE_STRING
);
841 FvInfo
->FvBlocks
[Index
].BlockLength
= (UINT32
) Value64
;
844 // There is a number of blocks, but there is no size, so we have a mismatched pair
845 // and should return an error.
847 Error (NULL
, 0, 0, "must specify both", "%s and %s", EFI_NUM_BLOCKS_STRING
, EFI_BLOCK_SIZE_STRING
);
854 for (Index
= 0; Index
< MAX_NUMBER_OF_FILES_IN_FV
; Index
++) {
856 // Read the number of blocks
858 Status
= FindToken (InfFile
, FILES_SECTION_STRING
, EFI_FILE_NAME_STRING
, Index
, Value
);
860 if (Status
== EFI_SUCCESS
) {
864 strcpy (FvInfo
->FvFiles
[Index
], Value
);
870 if (FindSection (InfFile
, COMPONENT_SECTION_STRING
)) {
873 // Read component FV_VARIABLE
875 Status
= FindToken (InfFile
, COMPONENT_SECTION_STRING
, EFI_NV_VARIABLE_STRING
, 0, Value
);
877 if (Status
== EFI_SUCCESS
) {
881 strcpy (FvInfo
->FvComponents
[Index
].ComponentName
, EFI_NV_VARIABLE_STRING
);
882 Status
= AsciiStringToUint64 (Value
, FALSE
, &Value64
);
883 if (EFI_ERROR (Status
)) {
884 printf ("ERROR: %s is not a valid integer.\n", EFI_NV_VARIABLE_STRING
);
888 FvInfo
->FvComponents
[Index
].Size
= (UINTN
) Value64
;
890 printf ("WARNING: Could not read %s.\n", EFI_NV_VARIABLE_STRING
);
895 // Read component FV_EVENT_LOG
897 Status
= FindToken (InfFile
, COMPONENT_SECTION_STRING
, EFI_NV_EVENT_LOG_STRING
, 0, Value
);
899 if (Status
== EFI_SUCCESS
) {
903 strcpy (FvInfo
->FvComponents
[Index
].ComponentName
, EFI_NV_EVENT_LOG_STRING
);
904 Status
= AsciiStringToUint64 (Value
, FALSE
, &Value64
);
905 if (EFI_ERROR (Status
)) {
906 printf ("ERROR: %s is not a valid integer.\n", EFI_NV_EVENT_LOG_STRING
);
910 FvInfo
->FvComponents
[Index
].Size
= (UINTN
) Value64
;
912 printf ("WARNING: Could not read %s.\n", EFI_NV_EVENT_LOG_STRING
);
917 // Read component FV_FTW_WORKING
919 Status
= FindToken (InfFile
, COMPONENT_SECTION_STRING
, EFI_NV_FTW_WORKING_STRING
, 0, Value
);
921 if (Status
== EFI_SUCCESS
) {
925 strcpy (FvInfo
->FvComponents
[Index
].ComponentName
, EFI_NV_FTW_WORKING_STRING
);
926 Status
= AsciiStringToUint64 (Value
, FALSE
, &Value64
);
927 if (EFI_ERROR (Status
)) {
928 printf ("ERROR: %s is not a valid integer.\n", EFI_NV_FTW_WORKING_STRING
);
932 FvInfo
->FvComponents
[Index
].Size
= (UINTN
) Value64
;
934 printf ("WARNING: Could not read %s.\n", EFI_NV_FTW_WORKING_STRING
);
939 // Read component FV_FTW_SPARE
941 Status
= FindToken (InfFile
, COMPONENT_SECTION_STRING
, EFI_NV_FTW_SPARE_STRING
, 0, Value
);
943 if (Status
== EFI_SUCCESS
) {
947 strcpy (FvInfo
->FvComponents
[Index
].ComponentName
, EFI_NV_FTW_SPARE_STRING
);
948 Status
= AsciiStringToUint64 (Value
, FALSE
, &Value64
);
949 if (EFI_ERROR (Status
)) {
950 printf ("ERROR: %s is not a valid integer.\n", EFI_NV_FTW_SPARE_STRING
);
954 FvInfo
->FvComponents
[Index
].Size
= (UINTN
) Value64
;
956 printf ("WARNING: Could not read %s.\n", EFI_NV_FTW_SPARE_STRING
);
960 // Compute size for easy access later
963 for (Index
= 0; FvInfo
->FvBlocks
[Index
].NumBlocks
; Index
++) {
964 FvInfo
->Size
+= FvInfo
->FvBlocks
[Index
].NumBlocks
* FvInfo
->FvBlocks
[Index
].BlockLength
;
972 IN EFI_FFS_FILE_HEADER
*FfsFile
,
973 IN EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
979 This function changes the FFS file attributes based on the erase polarity
993 if (FvHeader
->Attributes
& EFI_FVB_ERASE_POLARITY
) {
994 FfsFile
->State
= (UINT8
)~(FfsFile
->State
);
1000 IN EFI_FFS_FILE_HEADER
*FfsFile
,
1001 IN OUT UINT32
*Alignment
1005 Routine Description:
1007 This function determines the alignment of the FFS input file from the file
1012 FfsFile FFS file to parse
1013 Alignment The minimum required alignment of the FFS file, in bytes
1017 EFI_SUCCESS The function completed successfully.
1018 EFI_INVALID_PARAMETER One of the input parameters was invalid.
1019 EFI_ABORTED An error occurred.
1024 // Verify input parameters.
1026 if (FfsFile
== NULL
|| Alignment
== NULL
) {
1027 return EFI_INVALID_PARAMETER
;
1030 switch ((FfsFile
->Attributes
>> 3) & 0x07) {
1036 *Alignment
= (1 << 0);
1041 // 16 byte alignment
1043 *Alignment
= (1 << 4);
1048 // 128 byte alignment
1050 *Alignment
= (1 << 7);
1055 // 512 byte alignment
1057 *Alignment
= (1 << 9);
1062 // 1K byte alignment
1064 *Alignment
= (1 << 10);
1069 // 4K byte alignment
1071 *Alignment
= (1 << 12);
1076 // 32K byte alignment
1078 *Alignment
= (1 << 15);
1083 // 64K byte alignment
1085 *Alignment
= (1 << 16);
1089 Error (NULL
, 0, 0, "nvalid file attribute calculated, this is most likely a utility error", NULL
);
1098 IN OUT MEMORY_FILE
*FvImage
,
1099 IN UINT32 DataAlignment
1103 Routine Description:
1105 This function adds a pad file to the FV image if it required to align the
1106 data of the next file.
1110 FvImage The memory image of the FV to add it to. The current offset
1112 DataAlignment The data alignment of the next FFS file.
1116 EFI_SUCCESS The function completed successfully.
1117 EFI_INVALID_PARAMETER One of the input parameters was invalid.
1118 EFI_OUT_OF_RESOURCES Insufficient resources exist in the FV to complete
1123 EFI_FFS_FILE_HEADER
*PadFile
;
1124 EFI_GUID PadFileGuid
;
1128 // Verify input parameters.
1130 if (FvImage
== NULL
) {
1131 return EFI_INVALID_PARAMETER
;
1134 // Basic assumption is we start from an 8 byte aligned address
1135 // and our file header is a multiple of 8 bytes
1137 assert ((UINTN
) FvImage
->CurrentFilePointer
% 8 == 0);
1138 assert (sizeof (EFI_FFS_FILE_HEADER
) % 8 == 0);
1141 // Check if a pad file is necessary
1143 if (((UINTN
) FvImage
->CurrentFilePointer
- (UINTN
) FvImage
->FileImage
+ sizeof (EFI_FFS_FILE_HEADER
)) % DataAlignment
== 0) {
1147 // Write pad file header
1149 PadFile
= (EFI_FFS_FILE_HEADER
*) FvImage
->CurrentFilePointer
;
1152 // Verify that we have enough space for the file header
1154 if ((UINTN
) (PadFile
+ sizeof (EFI_FFS_FILE_HEADER
)) >= (UINTN
) FvImage
->Eof
) {
1155 return EFI_OUT_OF_RESOURCES
;
1161 uuid_generate (tmp_id
);
1162 memcpy (&PadFileGuid
, tmp_id
, sizeof (EFI_GUID
));
1165 UuidCreate (&PadFileGuid
);
1167 memset (PadFile
, 0, sizeof (EFI_FFS_FILE_HEADER
));
1168 memcpy (&PadFile
->Name
, &PadFileGuid
, sizeof (EFI_GUID
));
1169 PadFile
->Type
= EFI_FV_FILETYPE_FFS_PAD
;
1170 PadFile
->Attributes
= 0;
1173 // Calculate the pad file size
1176 // This is the earliest possible valid offset (current plus pad file header
1177 // plus the next file header)
1179 PadFileSize
= (UINTN
) FvImage
->CurrentFilePointer
- (UINTN
) FvImage
->FileImage
+ (sizeof (EFI_FFS_FILE_HEADER
) * 2);
1182 // Add whatever it takes to get to the next aligned address
1184 while ((PadFileSize
% DataAlignment
) != 0) {
1188 // Subtract the next file header size
1190 PadFileSize
-= sizeof (EFI_FFS_FILE_HEADER
);
1193 // Subtract the starting offset to get size
1195 PadFileSize
-= (UINTN
) FvImage
->CurrentFilePointer
- (UINTN
) FvImage
->FileImage
;
1198 // Write pad file size (calculated size minus next file header size)
1200 PadFile
->Size
[0] = (UINT8
) (PadFileSize
& 0xFF);
1201 PadFile
->Size
[1] = (UINT8
) ((PadFileSize
>> 8) & 0xFF);
1202 PadFile
->Size
[2] = (UINT8
) ((PadFileSize
>> 16) & 0xFF);
1205 // Fill in checksums and state, they must be 0 for checksumming.
1207 PadFile
->IntegrityCheck
.Checksum
.Header
= 0;
1208 PadFile
->IntegrityCheck
.Checksum
.File
= 0;
1210 PadFile
->IntegrityCheck
.Checksum
.Header
= CalculateChecksum8 ((UINT8
*) PadFile
, sizeof (EFI_FFS_FILE_HEADER
));
1211 if (PadFile
->Attributes
& FFS_ATTRIB_CHECKSUM
) {
1212 PadFile
->IntegrityCheck
.Checksum
.File
= CalculateChecksum8 ((UINT8
*) PadFile
, PadFileSize
);
1214 PadFile
->IntegrityCheck
.Checksum
.File
= FFS_FIXED_CHECKSUM
;
1217 PadFile
->State
= EFI_FILE_HEADER_CONSTRUCTION
| EFI_FILE_HEADER_VALID
| EFI_FILE_DATA_VALID
;
1218 UpdateFfsFileState (
1219 (EFI_FFS_FILE_HEADER
*) PadFile
,
1220 (EFI_FIRMWARE_VOLUME_HEADER
*) FvImage
->FileImage
1224 // Verify that we have enough space (including the padding
1226 if ((UINTN
) (PadFile
+ sizeof (EFI_FFS_FILE_HEADER
)) >= (UINTN
) FvImage
->Eof
) {
1227 return EFI_OUT_OF_RESOURCES
;
1230 // Update the current FV pointer
1232 FvImage
->CurrentFilePointer
+= PadFileSize
;
1239 IN EFI_FFS_FILE_HEADER
*FileBuffer
1243 Routine Description:
1245 This function checks the header to validate if it is a VTF file
1249 FileBuffer Buffer in which content of a file has been read.
1253 TRUE If this is a VTF file
1254 FALSE If this is not a VTF file
1258 EFI_GUID VtfGuid
= EFI_FFS_VOLUME_TOP_FILE_GUID
;
1259 if (!memcmp (&FileBuffer
->Name
, &VtfGuid
, sizeof (EFI_GUID
))) {
1267 FfsRebaseImageRead (
1268 IN VOID
*FileHandle
,
1269 IN UINTN FileOffset
,
1270 IN OUT UINT32
*ReadSize
,
1275 Routine Description:
1277 Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
1281 FileHandle - The handle to the PE/COFF file
1283 FileOffset - The offset, in bytes, into the file to read
1285 ReadSize - The number of bytes to read from the file starting at FileOffset
1287 Buffer - A pointer to the buffer to read the data into.
1291 EFI_SUCCESS - ReadSize bytes of data were read into Buffer from the PE/COFF file starting at FileOffset
1295 CHAR8
*Destination8
;
1299 Destination8
= Buffer
;
1300 Source8
= (CHAR8
*) ((UINTN
) FileHandle
+ FileOffset
);
1303 *(Destination8
++) = *(Source8
++);
1312 IN UINT64 BaseAddress
,
1313 IN EFI_FFS_FILE_HEADER
*FfsFile
,
1314 IN OUT MEMORY_FILE
*SymImage
,
1315 IN CHAR8
*SourceFileName
1319 Routine Description:
1321 This function adds the SYM tokens in the source file to the destination file.
1322 The SYM tokens are updated to reflect the base address.
1326 BaseAddress The base address for the new SYM tokens.
1327 FfsFile Pointer to the beginning of the FFS file in question.
1328 SymImage The memory file to update with symbol information.
1329 SourceFileName The source file.
1333 EFI_SUCCESS The function completed successfully.
1334 EFI_INVALID_PARAMETER One of the input parameters was invalid.
1335 EFI_ABORTED An error occurred.
1341 CHAR8 Buffer
[_MAX_PATH
];
1342 CHAR8 Type
[_MAX_PATH
];
1343 CHAR8 Address
[_MAX_PATH
];
1344 CHAR8 Section
[_MAX_PATH
];
1345 CHAR8 Token
[_MAX_PATH
];
1346 CHAR8 SymFileName
[_MAX_PATH
];
1347 CHAR8 CodeModuleName
[_MAX_PATH
];
1350 UINT64 TokenAddress
;
1353 EFI_FILE_SECTION_POINTER Pe32Section
;
1359 // Verify input parameters.
1361 if (BaseAddress
== 0 || FfsFile
== NULL
|| SymImage
== NULL
|| SourceFileName
== NULL
) {
1362 Error (NULL
, 0, 0, "invalid parameter passed to AddSymFile()", NULL
);
1363 return EFI_INVALID_PARAMETER
;
1366 // Check if we want to add this file
1369 // Get the file name
1371 strcpy (Buffer
, SourceFileName
);
1374 // Copy the file name for the path of the sym file and truncate the name portion.
1376 strcpy (SymFileName
, Buffer
);
1377 Ptr
= strrchr (SymFileName
, '\\');
1382 // Find the file extension and make it lower case
1384 Ptr
= strrchr (SymFileName
, '.');
1389 // Check if it is PEI file
1391 if (strstr (Buffer
, ".pei") != NULL
) {
1393 // Find the human readable portion
1395 if (!strtok (Buffer
, "-") ||
1396 !strtok (NULL
, "-") ||
1397 !strtok (NULL
, "-") ||
1398 !strtok (NULL
, "-") ||
1399 !strtok (NULL
, "-") ||
1400 !strcpy (Buffer
, strtok (NULL
, "."))
1402 Error (NULL
, 0, 0, "failed to find human readable portion of the file name in AddSymFile()", NULL
);
1406 // Save code module name
1408 strcpy (CodeModuleName
, Buffer
);
1411 // Add the symbol file name and extension to the file path.
1413 strcat (Buffer
, ".sym");
1414 strcat (SymFileName
, "\\");
1415 strcat (SymFileName
, Buffer
);
1418 // Only handle PEIM files.
1423 // Find PE32 section
1425 Status
= GetSectionByType (FfsFile
, EFI_SECTION_PE32
, 1, &Pe32Section
);
1428 // BUGBUG: Assume if no PE32 section it is PIC and hardcode base address
1430 if (Status
== EFI_NOT_FOUND
) {
1431 Status
= GetSectionByType (FfsFile
, EFI_SECTION_TE
, 1, &Pe32Section
);
1434 if (Status
== EFI_SUCCESS
) {
1435 Status
= GetPe32Info (
1436 (VOID
*) ((UINTN
) Pe32Section
.Pe32Section
+ sizeof (EFI_SECTION_PE32
)),
1441 } else if (Status
== EFI_NOT_FOUND
) {
1443 // For PIC, hardcode.
1446 Status
= EFI_SUCCESS
;
1448 Error (NULL
, 0, 0, "could not parse a PE32 section from the PEI file", NULL
);
1452 if (EFI_ERROR (Status
)) {
1453 Error (NULL
, 0, 0, "GetPe32Info() could not get PE32 entry point for PEI file", NULL
);
1458 // Open the source file
1460 SourceFile
= fopen (SymFileName
, "r");
1461 if (SourceFile
== NULL
) {
1463 // SYM files are not required.
1468 // Read the first line
1470 if (fgets (Buffer
, _MAX_PATH
, SourceFile
) == NULL
) {
1474 // Make sure it matches the expected sym format
1476 if (strcmp (Buffer
, "TEXTSYM format | V1.0\n")) {
1477 fclose (SourceFile
);
1478 Error (NULL
, 0, 0, "AddSymFile() found unexpected sym format in input file", NULL
);
1484 while (feof (SourceFile
) == 0) {
1490 "%s | %s | %s | %s\n",
1497 // If the token starts with "??" ignore it
1499 if (Token
[0] == '?' && Token
[1] == '?') {
1503 // Get the token address
1505 AsciiStringToUint64 (Address
, TRUE
, &TokenAddress
);
1508 // Add the base address
1510 TokenAddress
+= BaseAddress
;
1513 // If PE32 or TE section then find the start of code. For PIC it is hardcoded.
1515 if (Pe32Section
.Pe32Section
) {
1517 // Add the offset of the PE32 section
1519 TokenAddress
+= (UINTN
) Pe32Section
.Pe32Section
- (UINTN
) FfsFile
;
1522 // Add the size of the PE32 section header
1524 TokenAddress
+= sizeof (EFI_PE32_SECTION
);
1527 // For PIC hardcoded.
1529 TokenAddress
+= 0x28;
1533 // Add the beginning of the code
1535 TokenAddress
+= BaseOfCode
;
1539 "%s | %016I64X | %s | _%s%s\n",
1546 memcpy (SymImage
->CurrentFilePointer
, Buffer
, strlen (Buffer
) + 1);
1547 SymImage
->CurrentFilePointer
= (UINT8
*) (((UINTN
) SymImage
->CurrentFilePointer
) + strlen (Buffer
) + 1);
1551 fclose (SourceFile
);
1557 IN OUT MEMORY_FILE
*FvImage
,
1560 IN OUT EFI_FFS_FILE_HEADER
**VtfFileImage
,
1561 IN OUT MEMORY_FILE
*SymImage
1565 Routine Description:
1567 This function adds a file to the FV image. The file will pad to the
1568 appropriate alignment if required.
1572 FvImage The memory image of the FV to add it to. The current offset
1574 FvInfo Pointer to information about the FV.
1575 Index The file in the FvInfo file list to add.
1576 VtfFileImage A pointer to the VTF file within the FvImage. If this is equal
1577 to the end of the FvImage then no VTF previously found.
1578 SymImage The memory image of the Sym file to update if symbols are present.
1579 The current offset must be valid.
1583 EFI_SUCCESS The function completed successfully.
1584 EFI_INVALID_PARAMETER One of the input parameters was invalid.
1585 EFI_ABORTED An error occurred.
1586 EFI_OUT_OF_RESOURCES Insufficient resources exist to complete the add.
1594 UINT32 CurrentFileAlignment
;
1596 EFI_PHYSICAL_ADDRESS CurrentFileBaseAddress
;
1597 UINT8 VtfHeaderChecksum
;
1598 UINT8 VtfFileChecksum
;
1600 EFI_FFS_FILE_TAIL TailValue
;
1603 // Verify input parameters.
1605 if (FvImage
== NULL
|| FvInfo
== NULL
|| FvInfo
->FvFiles
[Index
][0] == 0 || VtfFileImage
== NULL
|| SymImage
== NULL
) {
1606 return EFI_INVALID_PARAMETER
;
1609 // Read the file to add
1611 NewFile
= fopen (FvInfo
->FvFiles
[Index
], "rb");
1613 if (NewFile
== NULL
) {
1614 Error (NULL
, 0, 0, FvInfo
->FvFiles
[Index
], "failed to open file for reading");
1618 // Get the file size
1620 FileSize
= _filelength (fileno (NewFile
));
1623 // Read the file into a buffer
1625 FileBuffer
= malloc (FileSize
);
1626 if (FileBuffer
== NULL
) {
1627 Error (NULL
, 0, 0, "memory allocation failure", NULL
);
1628 return EFI_OUT_OF_RESOURCES
;
1631 NumBytesRead
= fread (FileBuffer
, sizeof (UINT8
), FileSize
, NewFile
);
1634 // Done with the file, from this point on we will just use the buffer read.
1639 // Verify read successful
1641 if (NumBytesRead
!= sizeof (UINT8
) * FileSize
) {
1643 Error (NULL
, 0, 0, FvInfo
->FvFiles
[Index
], "failed to read input file contents");
1647 // Verify space exists to add the file
1649 if (FileSize
> (UINTN
) ((UINTN
) *VtfFileImage
- (UINTN
) FvImage
->CurrentFilePointer
)) {
1650 Error (NULL
, 0, 0, FvInfo
->FvFiles
[Index
], "insufficient space remains to add the file");
1651 return EFI_OUT_OF_RESOURCES
;
1654 // Update the file state based on polarity of the FV.
1656 UpdateFfsFileState (
1657 (EFI_FFS_FILE_HEADER
*) FileBuffer
,
1658 (EFI_FIRMWARE_VOLUME_HEADER
*) FvImage
->FileImage
1662 // If we have a VTF file, add it at the top.
1664 if (IsVtfFile ((EFI_FFS_FILE_HEADER
*) FileBuffer
)) {
1665 if ((UINTN
) *VtfFileImage
== (UINTN
) FvImage
->Eof
) {
1667 // No previous VTF, add this one.
1669 *VtfFileImage
= (EFI_FFS_FILE_HEADER
*) (UINTN
) ((UINTN
) FvImage
->FileImage
+ FvInfo
->Size
- FileSize
);
1671 // Sanity check. The file MUST align appropriately
1673 if ((((UINTN
) *VtfFileImage
) & 0x07) != 0) {
1674 Error (NULL
, 0, 0, "VTF file does not align on 8-byte boundary", NULL
);
1677 // copy VTF File Header
1679 memcpy (*VtfFileImage
, FileBuffer
, sizeof (EFI_FFS_FILE_HEADER
));
1685 (UINT8
*) *VtfFileImage
+ sizeof (EFI_FFS_FILE_HEADER
),
1686 FileBuffer
+ sizeof (EFI_FFS_FILE_HEADER
),
1687 FileSize
- sizeof (EFI_FFS_FILE_HEADER
)
1691 // re-calculate the VTF File Header
1693 FileState
= (*VtfFileImage
)->State
;
1694 (*VtfFileImage
)->State
= 0;
1695 *(UINT32
*) ((*VtfFileImage
)->Size
) = FileSize
;
1696 (*VtfFileImage
)->IntegrityCheck
.Checksum
.Header
= 0;
1697 (*VtfFileImage
)->IntegrityCheck
.Checksum
.File
= 0;
1699 VtfHeaderChecksum
= CalculateChecksum8 ((UINT8
*) *VtfFileImage
, sizeof (EFI_FFS_FILE_HEADER
));
1700 (*VtfFileImage
)->IntegrityCheck
.Checksum
.Header
= VtfHeaderChecksum
;
1702 // Determine if it has a tail
1704 if ((*VtfFileImage
)->Attributes
& FFS_ATTRIB_TAIL_PRESENT
) {
1705 TailSize
= sizeof (EFI_FFS_FILE_TAIL
);
1710 if ((*VtfFileImage
)->Attributes
& FFS_ATTRIB_CHECKSUM
) {
1711 VtfFileChecksum
= CalculateChecksum8 ((UINT8
*) *VtfFileImage
, FileSize
- TailSize
);
1712 (*VtfFileImage
)->IntegrityCheck
.Checksum
.File
= VtfFileChecksum
;
1714 (*VtfFileImage
)->IntegrityCheck
.Checksum
.File
= FFS_FIXED_CHECKSUM
;
1717 // If it has a file tail, update it
1719 if ((*VtfFileImage
)->Attributes
& FFS_ATTRIB_TAIL_PRESENT
) {
1720 TailValue
= (EFI_FFS_FILE_TAIL
) (~((*VtfFileImage
)->IntegrityCheck
.TailReference
));
1721 *(EFI_FFS_FILE_TAIL
*) (((UINTN
) (*VtfFileImage
) + GetLength ((*VtfFileImage
)->Size
) - sizeof (EFI_FFS_FILE_TAIL
))) = TailValue
;
1723 (*VtfFileImage
)->State
= FileState
;
1728 // Already found a VTF file.
1730 Error (NULL
, 0, 0, "multiple VTF files are illegal in a single FV", NULL
);
1736 // Check if alignment is required
1738 Status
= ReadFfsAlignment ((EFI_FFS_FILE_HEADER
*) FileBuffer
, &CurrentFileAlignment
);
1739 if (EFI_ERROR (Status
)) {
1740 printf ("ERROR: Could not determine alignment of file %s.\n", FvInfo
->FvFiles
[Index
]);
1745 // Add pad file if necessary
1747 Status
= AddPadFile (FvImage
, CurrentFileAlignment
);
1748 if (EFI_ERROR (Status
)) {
1749 printf ("ERROR: Could not align the file data properly.\n");
1756 if ((FvImage
->CurrentFilePointer
+ FileSize
) < FvImage
->Eof
) {
1760 memcpy (FvImage
->CurrentFilePointer
, FileBuffer
, FileSize
);
1763 // If the file is XIP, rebase
1765 CurrentFileBaseAddress
= FvInfo
->BaseAddress
+ ((UINTN
) FvImage
->CurrentFilePointer
- (UINTN
) FvImage
->FileImage
);
1767 // Status = RebaseFfsFile ((EFI_FFS_FILE_HEADER*) FvImage->CurrentFilePointer, CurrentFileBaseAddress);
1768 // if (EFI_ERROR(Status)) {
1769 // printf ("ERROR: Could not rebase the file %s.\n", FvInfo->FvFiles[Index]);
1770 // return EFI_ABORTED;
1773 // Update Symbol file
1775 Status
= AddSymFile (
1776 CurrentFileBaseAddress
,
1777 (EFI_FFS_FILE_HEADER
*) FvImage
->CurrentFilePointer
,
1779 FvInfo
->FvFiles
[Index
]
1781 assert (!EFI_ERROR (Status
));
1784 // Update the current pointer in the FV image
1786 FvImage
->CurrentFilePointer
+= FileSize
;
1788 printf ("ERROR: The firmware volume is out of space, could not add file %s.\n", FvInfo
->FvFiles
[Index
]);
1792 // Make next file start at QWord Boundry
1794 while (((UINTN
) FvImage
->CurrentFilePointer
& 0x07) != 0) {
1795 FvImage
->CurrentFilePointer
++;
1798 // Free allocated memory.
1812 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
1813 VARIABLE_STORE_HEADER
*VarStoreHeader
;
1815 // Variable block should exclude FvHeader. Since the length of
1816 // FvHeader depends on the block map, which is variable length,
1817 // we could only decide the actual variable block length here.
1819 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) FvImage
;
1820 FvImage
= FvImage
+ FvHeader
->HeaderLength
;
1822 VarStoreHeader
= (VARIABLE_STORE_HEADER
*) FvImage
;
1824 VarStoreHeader
->Signature
= VARIABLE_STORE_SIGNATURE
;
1825 VarStoreHeader
->Size
= Size
- FvHeader
->HeaderLength
;
1826 VarStoreHeader
->Format
= VARIABLE_STORE_FORMATTED
;
1827 VarStoreHeader
->State
= VARIABLE_STORE_HEALTHY
;
1828 VarStoreHeader
->Reserved
= 0;
1829 VarStoreHeader
->Reserved1
= 0;
1845 AddFTWWorkingBlock (
1851 EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER
*FTWHeader
;
1855 FTWHeader
= (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER
*) FvImage
;
1856 memcpy (&FTWHeader
->Signature
, &(FvInfo
->FvGuid
), sizeof (EFI_GUID
));
1857 FTWHeader
->WriteQueueSize
= Size
- sizeof (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER
);
1858 CalculateCrc32 (FvImage
, sizeof (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER
), &Crc32
);
1859 FTWHeader
->Crc
= Crc32
;
1860 if (FvInfo
->FvAttributes
& EFI_FVB_ERASE_POLARITY
) {
1861 FTWHeader
->WorkingBlockValid
= 0;
1862 FTWHeader
->WorkingBlockInvalid
= 1;
1864 FTWHeader
->WorkingBlockValid
= 1;
1865 FTWHeader
->WorkingBlockInvalid
= 0;
1888 Routine Description:
1890 This function generate the non FFS FV image, such as the working block
1891 and spare block. How each component of the FV is built is component
1896 FvImage The memory image of the FV to add it to. The current offset
1898 FvInfo Pointer to information about the FV.
1902 EFI_SUCCESS The function completed successfully.
1903 EFI_INVALID_PARAMETER One of the input parameters was invalid.
1904 EFI_ABORTED An error occurred.
1905 EFI_OUT_OF_RESOURCES Insufficient resources exist to complete the add.
1910 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
1913 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) FvImage
;
1916 for (Index
= 0; FvInfo
->FvComponents
[Index
].Size
!= 0; Index
++) {
1917 if (stricmp (FvInfo
->FvComponents
[Index
].ComponentName
, EFI_NV_VARIABLE_STRING
) == 0) {
1918 AddVariableBlock (FvImage
, FvInfo
->FvComponents
[Index
].Size
, FvInfo
);
1919 } else if (stricmp (FvInfo
->FvComponents
[Index
].ComponentName
, EFI_NV_EVENT_LOG_STRING
) == 0) {
1920 AddEventLogBlock (FvImage
, FvInfo
->FvComponents
[Index
].Size
, FvInfo
);
1921 } else if (stricmp (FvInfo
->FvComponents
[Index
].ComponentName
, EFI_NV_FTW_WORKING_STRING
) == 0) {
1922 AddFTWWorkingBlock (FvImage
, FvInfo
->FvComponents
[Index
].Size
, FvInfo
);
1923 } else if (stricmp (FvInfo
->FvComponents
[Index
].ComponentName
, EFI_NV_FTW_SPARE_STRING
) == 0) {
1924 AddFTWSpareBlock (FvImage
, FvInfo
->FvComponents
[Index
].Size
, FvInfo
);
1926 printf ("Error. Unknown Non-FFS block %s \n", FvInfo
->FvComponents
[Index
].ComponentName
);
1930 FvImage
= FvImage
+ FvInfo
->FvComponents
[Index
].Size
;
1931 TotalSize
= TotalSize
+ FvInfo
->FvComponents
[Index
].Size
;
1934 // Index and TotalSize is zero mean there's no component, so this is an empty fv
1936 if ((Index
!= 0 || TotalSize
!= 0) && TotalSize
!= FvInfo
->Size
) {
1937 printf ("Error. Component size does not sum up to FV size.\n");
1946 IN MEMORY_FILE
*FvImage
,
1947 IN EFI_FFS_FILE_HEADER
*VtfFileImage
1951 Routine Description:
1953 This function places a pad file between the last file in the FV and the VTF
1954 file if the VTF file exists.
1958 FvImage Memory file for the FV memory image
1959 VtfFileImage The address of the VTF file. If this is the end of the FV
1960 image, no VTF exists and no pad file is needed.
1964 EFI_SUCCESS Completed successfully.
1965 EFI_INVALID_PARAMETER One of the input parameters was NULL.
1969 EFI_FFS_FILE_HEADER
*PadFile
;
1973 // If there is no VTF or the VTF naturally follows the previous file without a
1974 // pad file, then there's nothing to do
1976 if ((UINTN
) VtfFileImage
== (UINTN
) FvImage
->Eof
|| (void *) FvImage
->CurrentFilePointer
== (void *) VtfFileImage
) {
1980 // Pad file starts at beginning of free space
1982 PadFile
= (EFI_FFS_FILE_HEADER
*) FvImage
->CurrentFilePointer
;
1987 memset (PadFile
, 0, sizeof (EFI_FFS_FILE_HEADER
));
1988 memcpy (&PadFile
->Name
, &DefaultFvPadFileNameGuid
, sizeof (EFI_GUID
));
1989 PadFile
->Type
= EFI_FV_FILETYPE_FFS_PAD
;
1990 PadFile
->Attributes
= 0;
1993 // FileSize includes the EFI_FFS_FILE_HEADER
1995 FileSize
= (UINTN
) VtfFileImage
- (UINTN
) FvImage
->CurrentFilePointer
;
1996 PadFile
->Size
[0] = (UINT8
) (FileSize
& 0x000000FF);
1997 PadFile
->Size
[1] = (UINT8
) ((FileSize
& 0x0000FF00) >> 8);
1998 PadFile
->Size
[2] = (UINT8
) ((FileSize
& 0x00FF0000) >> 16);
2001 // Fill in checksums and state, must be zero during checksum calculation.
2003 PadFile
->IntegrityCheck
.Checksum
.Header
= 0;
2004 PadFile
->IntegrityCheck
.Checksum
.File
= 0;
2006 PadFile
->IntegrityCheck
.Checksum
.Header
= CalculateChecksum8 ((UINT8
*) PadFile
, sizeof (EFI_FFS_FILE_HEADER
));
2007 if (PadFile
->Attributes
& FFS_ATTRIB_CHECKSUM
) {
2008 PadFile
->IntegrityCheck
.Checksum
.File
= CalculateChecksum8 ((UINT8
*) PadFile
, FileSize
);
2010 PadFile
->IntegrityCheck
.Checksum
.File
= FFS_FIXED_CHECKSUM
;
2013 PadFile
->State
= EFI_FILE_HEADER_CONSTRUCTION
| EFI_FILE_HEADER_VALID
| EFI_FILE_DATA_VALID
;
2015 UpdateFfsFileState (
2016 (EFI_FFS_FILE_HEADER
*) PadFile
,
2017 (EFI_FIRMWARE_VOLUME_HEADER
*) FvImage
->FileImage
2020 // Update the current FV pointer
2022 FvImage
->CurrentFilePointer
= FvImage
->Eof
;
2029 IN MEMORY_FILE
*FvImage
,
2031 IN EFI_FFS_FILE_HEADER
*VtfFile
2035 Routine Description:
2037 This parses the FV looking for the PEI core and then plugs the address into
2038 the SALE_ENTRY point of the BSF/VTF for IPF and does BUGBUG TBD action to
2039 complete an IA32 Bootstrap FV.
2043 FvImage Memory file for the FV memory image
2044 FvInfo Information read from INF file.
2045 VtfFile Pointer to the VTF file in the FV image.
2049 EFI_SUCCESS Function Completed successfully.
2050 EFI_ABORTED Error encountered.
2051 EFI_INVALID_PARAMETER A required parameter was NULL.
2052 EFI_NOT_FOUND PEI Core file not found.
2056 EFI_FFS_FILE_HEADER
*PeiCoreFile
;
2057 EFI_FFS_FILE_HEADER
*SecCoreFile
;
2059 EFI_FILE_SECTION_POINTER Pe32Section
;
2063 EFI_PHYSICAL_ADDRESS PeiCorePhysicalAddress
;
2064 EFI_PHYSICAL_ADDRESS SecCorePhysicalAddress
;
2065 EFI_PHYSICAL_ADDRESS
*SecCoreEntryAddressPtr
;
2066 UINT32
*Ia32ResetAddressPtr
;
2068 UINT8
*BytePointer2
;
2069 UINT16
*WordPointer
;
2072 EFI_FFS_FILE_STATE SavedState
;
2073 EFI_FFS_FILE_TAIL TailValue
;
2076 FIT_TABLE
*FitTablePtr
;
2079 // Verify input parameters
2081 if (FvImage
== NULL
|| FvInfo
== NULL
|| VtfFile
== NULL
) {
2082 return EFI_INVALID_PARAMETER
;
2085 // Initialize FV library
2087 InitializeFvLib (FvImage
->FileImage
, (UINTN
) FvImage
->Eof
- (UINTN
) FvImage
->FileImage
);
2092 Status
= VerifyFfsFile (VtfFile
);
2093 if (EFI_ERROR (Status
)) {
2094 return EFI_INVALID_PARAMETER
;
2097 // Find the PEI Core
2099 Status
= GetFileByType (EFI_FV_FILETYPE_PEI_CORE
, 1, &PeiCoreFile
);
2100 if (EFI_ERROR (Status
) || PeiCoreFile
== NULL
) {
2101 Error (NULL
, 0, 0, "could not find the PEI core in the FV", NULL
);
2106 // PEI Core found, now find PE32 or TE section
2108 Status
= GetSectionByType (PeiCoreFile
, EFI_SECTION_PE32
, 1, &Pe32Section
);
2109 if (Status
== EFI_NOT_FOUND
) {
2110 Status
= GetSectionByType (PeiCoreFile
, EFI_SECTION_TE
, 1, &Pe32Section
);
2113 if (EFI_ERROR (Status
)) {
2114 Error (NULL
, 0, 0, "could not find PE32 or TE section in PEI core file", NULL
);
2118 Status
= GetPe32Info (
2119 (VOID
*) ((UINTN
) Pe32Section
.Pe32Section
+ sizeof (EFI_SECTION_PE32
)),
2125 if (EFI_ERROR (Status
)) {
2126 Error (NULL
, 0, 0, "could not get PE32 entry point for PEI core", NULL
);
2130 // Physical address is FV base + offset of PE32 + offset of the entry point
2132 PeiCorePhysicalAddress
= FvInfo
->BaseAddress
;
2133 PeiCorePhysicalAddress
+= (UINTN
) Pe32Section
.Pe32Section
+ sizeof (EFI_SECTION_PE32
) - (UINTN
) FvImage
->FileImage
;
2134 PeiCorePhysicalAddress
+= EntryPoint
;
2136 if (MachineType
== EFI_IMAGE_MACHINE_IA64
) {
2138 // Update PEI_CORE address
2141 // Set the uncached attribute bit in the physical address
2143 PeiCorePhysicalAddress
|= 0x8000000000000000ULL
;
2146 // Check if address is aligned on a 16 byte boundary
2148 if (PeiCorePhysicalAddress
& 0xF) {
2150 "ERROR: PEI_CORE entry point is not aligned on a 16 byte boundary, address specified is %Xh.\n",
2151 PeiCorePhysicalAddress
2156 // First Get the FIT table address
2158 FitAddress
= (*(UINT64
*) (FvImage
->Eof
- IPF_FIT_ADDRESS_OFFSET
)) & 0xFFFFFFFF;
2160 FitTablePtr
= (FIT_TABLE
*) (FvImage
->FileImage
+ (FitAddress
- FvInfo
->BaseAddress
));
2162 Status
= UpdatePeiCoreEntryInFit (FitTablePtr
, PeiCorePhysicalAddress
);
2164 if (!EFI_ERROR (Status
)) {
2165 UpdateFitCheckSum (FitTablePtr
);
2168 // Find the Sec Core
2170 Status
= GetFileByType (EFI_FV_FILETYPE_SECURITY_CORE
, 1, &SecCoreFile
);
2171 if (EFI_ERROR (Status
) || SecCoreFile
== NULL
) {
2172 Error (NULL
, 0, 0, "could not find the Sec core in the FV", NULL
);
2176 // Sec Core found, now find PE32 section
2178 Status
= GetSectionByType (SecCoreFile
, EFI_SECTION_PE32
, 1, &Pe32Section
);
2179 if (EFI_ERROR (Status
)) {
2180 Error (NULL
, 0, 0, "could not find PE32 section in SEC core file", NULL
);
2184 Status
= GetPe32Info (
2185 (VOID
*) ((UINTN
) Pe32Section
.Pe32Section
+ sizeof (EFI_SECTION_PE32
)),
2190 if (EFI_ERROR (Status
)) {
2191 Error (NULL
, 0, 0, "could not get PE32 entry point for SEC core", NULL
);
2195 // Physical address is FV base + offset of PE32 + offset of the entry point
2197 SecCorePhysicalAddress
= FvInfo
->BaseAddress
;
2198 SecCorePhysicalAddress
+= (UINTN
) Pe32Section
.Pe32Section
+ sizeof (EFI_SECTION_PE32
) - (UINTN
) FvImage
->FileImage
;
2199 SecCorePhysicalAddress
+= EntryPoint
;
2202 // Update SEC_CORE address
2205 // Set the uncached attribute bit in the physical address
2207 SecCorePhysicalAddress
|= 0x8000000000000000ULL
;
2210 // Update the address
2212 SecCoreEntryAddressPtr
= (EFI_PHYSICAL_ADDRESS
*) ((UINTN
) FvImage
->Eof
- IPF_SALE_ENTRY_ADDRESS_OFFSET
);
2213 *SecCoreEntryAddressPtr
= SecCorePhysicalAddress
;
2216 // Check if address is aligned on a 16 byte boundary
2218 if (SecCorePhysicalAddress
& 0xF) {
2220 "ERROR: SALE_ENTRY entry point is not aligned on a 16 byte boundary, address specified is %Xh.\n",
2221 SecCorePhysicalAddress
2225 } else if (MachineType
== EFI_IMAGE_MACHINE_IA32
) {
2227 // Get the location to update
2229 Ia32ResetAddressPtr
= (UINT32
*) ((UINTN
) FvImage
->Eof
- IA32_PEI_CORE_ENTRY_OFFSET
);
2232 // Write lower 32 bits of physical address
2234 *Ia32ResetAddressPtr
= (UINT32
) PeiCorePhysicalAddress
;
2237 // Update the BFV base address
2239 Ia32ResetAddressPtr
= (UINT32
*) ((UINTN
) FvImage
->Eof
- 4);
2240 *Ia32ResetAddressPtr
= (UINT32
) (FvInfo
->BaseAddress
);
2245 // Update the Startup AP in the FVH header block ZeroVector region.
2247 BytePointer
= (UINT8
*) ((UINTN
) FvImage
->FileImage
);
2248 BytePointer2
= (FvInfo
->Size
== 0x10000) ? m64kRecoveryStartupApDataArray
: m128kRecoveryStartupApDataArray
;
2249 for (Index
= 0; Index
< SIZEOF_STARTUP_DATA_ARRAY
; Index
++) {
2250 *BytePointer
++ = *BytePointer2
++;
2253 // Calculate the checksum
2255 WordPointer
= (UINT16
*) ((UINTN
) FvImage
->FileImage
);
2256 for (Index
= 0; Index
< SIZEOF_STARTUP_DATA_ARRAY
/ 2; Index
++) {
2257 CheckSum
= (UINT16
) (CheckSum
+ ((UINT16
) *WordPointer
));
2261 // Update the checksum field
2263 BytePointer
= (UINT8
*) ((UINTN
) FvImage
->FileImage
);
2264 BytePointer
+= (SIZEOF_STARTUP_DATA_ARRAY
- 2);
2265 WordPointer
= (UINT16
*) BytePointer
;
2266 *WordPointer
= (UINT16
) (0x10000 - (UINT32
) CheckSum
);
2268 Error (NULL
, 0, 0, "invalid machine type in PEI core", "machine type=0x%X", (UINT32
) MachineType
);
2272 // Determine if it has an FFS file tail.
2274 if (VtfFile
->Attributes
& FFS_ATTRIB_TAIL_PRESENT
) {
2275 TailSize
= sizeof (EFI_FFS_FILE_TAIL
);
2280 // Now update file checksum
2282 SavedState
= VtfFile
->State
;
2283 VtfFile
->IntegrityCheck
.Checksum
.File
= 0;
2285 if (VtfFile
->Attributes
& FFS_ATTRIB_CHECKSUM
) {
2286 VtfFile
->IntegrityCheck
.Checksum
.File
= CalculateChecksum8 (
2288 GetLength (VtfFile
->Size
) - TailSize
2291 VtfFile
->IntegrityCheck
.Checksum
.File
= FFS_FIXED_CHECKSUM
;
2294 VtfFile
->State
= SavedState
;
2297 // Update tail if present
2299 if (VtfFile
->Attributes
& FFS_ATTRIB_TAIL_PRESENT
) {
2300 TailValue
= (EFI_FFS_FILE_TAIL
) (~(VtfFile
->IntegrityCheck
.TailReference
));
2301 *(EFI_FFS_FILE_TAIL
*) (((UINTN
) (VtfFile
) + GetLength (VtfFile
->Size
) - sizeof (EFI_FFS_FILE_TAIL
))) = TailValue
;
2310 OUT UINT32
*EntryPoint
,
2311 OUT UINT32
*BaseOfCode
,
2312 OUT UINT16
*MachineType
2316 Routine Description:
2318 Retrieves the PE32 entry point offset and machine type from PE image or TeImage.
2319 See EfiImage.h for machine types. The entry point offset is from the beginning
2320 of the PE32 buffer passed in.
2324 Pe32 Beginning of the PE32.
2325 EntryPoint Offset from the beginning of the PE32 to the image entry point.
2326 BaseOfCode Base address of code.
2327 MachineType Magic number for the machine type.
2331 EFI_SUCCESS Function completed successfully.
2332 EFI_ABORTED Error encountered.
2333 EFI_INVALID_PARAMETER A required parameter was NULL.
2334 EFI_UNSUPPORTED The operation is unsupported.
2338 EFI_IMAGE_DOS_HEADER
*DosHeader
;
2339 EFI_IMAGE_NT_HEADERS
*NtHeader
;
2340 EFI_TE_IMAGE_HEADER
*TeHeader
;
2343 // Verify input parameters
2346 return EFI_INVALID_PARAMETER
;
2350 // First check whether it is one TE Image.
2352 TeHeader
= (EFI_TE_IMAGE_HEADER
*) Pe32
;
2353 if (TeHeader
->Signature
== EFI_TE_IMAGE_HEADER_SIGNATURE
) {
2355 // By TeImage Header to get output
2357 *EntryPoint
= TeHeader
->AddressOfEntryPoint
+ sizeof (EFI_TE_IMAGE_HEADER
) - TeHeader
->StrippedSize
;
2358 *BaseOfCode
= TeHeader
->BaseOfCode
+ sizeof (EFI_TE_IMAGE_HEADER
) - TeHeader
->StrippedSize
;
2359 *MachineType
= TeHeader
->Machine
;
2363 // Then check whether
2364 // First is the DOS header
2366 DosHeader
= (EFI_IMAGE_DOS_HEADER
*) Pe32
;
2369 // Verify DOS header is expected
2371 if (DosHeader
->e_magic
!= EFI_IMAGE_DOS_SIGNATURE
) {
2372 printf ("ERROR: Unknown magic number in the DOS header, 0x%04X.\n", DosHeader
->e_magic
);
2373 return EFI_UNSUPPORTED
;
2376 // Immediately following is the NT header.
2378 NtHeader
= (EFI_IMAGE_NT_HEADERS
*) ((UINTN
) Pe32
+ DosHeader
->e_lfanew
);
2381 // Verify NT header is expected
2383 if (NtHeader
->Signature
!= EFI_IMAGE_NT_SIGNATURE
) {
2384 printf ("ERROR: Unrecognized image signature 0x%08X.\n", NtHeader
->Signature
);
2385 return EFI_UNSUPPORTED
;
2390 *EntryPoint
= NtHeader
->OptionalHeader
.AddressOfEntryPoint
;
2391 *BaseOfCode
= NtHeader
->OptionalHeader
.BaseOfCode
;
2392 *MachineType
= NtHeader
->FileHeader
.Machine
;
2396 // Verify machine type is supported
2398 if (*MachineType
!= EFI_IMAGE_MACHINE_IA32
&& *MachineType
!= EFI_IMAGE_MACHINE_IA64
&& *MachineType
!= EFI_IMAGE_MACHINE_X64
&& *MachineType
!= EFI_IMAGE_MACHINE_EBC
) {
2399 printf ("ERROR: Unrecognized machine type in the PE32 file.\n");
2400 return EFI_UNSUPPORTED
;
2406 // Exposed function implementations (prototypes are defined in GenFvImageLib.h)
2410 IN CHAR8
*InfFileImage
,
2411 IN UINTN InfFileSize
,
2412 OUT UINT8
**FvImage
,
2413 OUT UINTN
*FvImageSize
,
2414 OUT CHAR8
**FvFileName
,
2415 OUT UINT8
**SymImage
,
2416 OUT UINTN
*SymImageSize
,
2417 OUT CHAR8
**SymFileName
2421 Routine Description:
2423 This is the main function which will be called from application.
2427 InfFileImage Buffer containing the INF file contents.
2428 InfFileSize Size of the contents of the InfFileImage buffer.
2429 FvImage Pointer to the FV image created.
2430 FvImageSize Size of the FV image created and pointed to by FvImage.
2431 FvFileName Requested name for the FV file.
2432 SymImage Pointer to the Sym image created.
2433 SymImageSize Size of the Sym image created and pointed to by SymImage.
2434 SymFileName Requested name for the Sym file.
2438 EFI_SUCCESS Function completed successfully.
2439 EFI_OUT_OF_RESOURCES Could not allocate required resources.
2440 EFI_ABORTED Error encountered.
2441 EFI_INVALID_PARAMETER A required parameter was NULL.
2446 MEMORY_FILE InfMemoryFile
;
2447 MEMORY_FILE FvImageMemoryFile
;
2448 MEMORY_FILE SymImageMemoryFile
;
2451 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
2452 EFI_FFS_FILE_HEADER
*VtfFileImage
;
2455 // Check for invalid parameter
2457 if (InfFileImage
== NULL
|| FvImage
== NULL
|| FvImageSize
== NULL
|| FvFileName
== NULL
) {
2458 return EFI_INVALID_PARAMETER
;
2461 // Initialize file structures
2463 InfMemoryFile
.FileImage
= InfFileImage
;
2464 InfMemoryFile
.CurrentFilePointer
= InfFileImage
;
2465 InfMemoryFile
.Eof
= InfFileImage
+ InfFileSize
;
2468 // Parse the FV inf file for header information
2470 Status
= ParseFvInf (&InfMemoryFile
, &FvInfo
);
2471 if (EFI_ERROR (Status
)) {
2472 printf ("ERROR: Could not parse the input INF file.\n");
2476 // Update the file name return values
2478 strcpy (*FvFileName
, FvInfo
.FvName
);
2479 strcpy (*SymFileName
, FvInfo
.SymName
);
2482 // Calculate the FV size
2484 *FvImageSize
= FvInfo
.Size
;
2489 *FvImage
= malloc (*FvImageSize
);
2490 if (*FvImage
== NULL
) {
2491 return EFI_OUT_OF_RESOURCES
;
2494 // Allocate space for symbol file storage
2496 *SymImage
= malloc (SYMBOL_FILE_SIZE
);
2497 if (*SymImage
== NULL
) {
2498 return EFI_OUT_OF_RESOURCES
;
2501 // Initialize the FV to the erase polarity
2503 if (FvInfo
.FvAttributes
& EFI_FVB_ERASE_POLARITY
) {
2504 memset (*FvImage
, -1, *FvImageSize
);
2506 memset (*FvImage
, 0, *FvImageSize
);
2509 // Initialize FV header
2511 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*) *FvImage
;
2514 // Initialize the zero vector to all zeros.
2516 memset (FvHeader
->ZeroVector
, 0, 16);
2519 // Copy the FFS GUID
2521 memcpy (&FvHeader
->FileSystemGuid
, &FvInfo
.FvGuid
, sizeof (EFI_GUID
));
2523 FvHeader
->FvLength
= *FvImageSize
;
2524 FvHeader
->Signature
= EFI_FVH_SIGNATURE
;
2525 FvHeader
->Attributes
= FvInfo
.FvAttributes
;
2526 FvHeader
->Revision
= EFI_FVH_REVISION
;
2527 FvHeader
->Reserved
[0] = 0;
2528 FvHeader
->Reserved
[1] = 0;
2529 FvHeader
->Reserved
[2] = 0;
2532 // Copy firmware block map
2534 for (Index
= 0; FvInfo
.FvBlocks
[Index
].NumBlocks
!= 0; Index
++) {
2535 FvHeader
->FvBlockMap
[Index
].NumBlocks
= FvInfo
.FvBlocks
[Index
].NumBlocks
;
2536 FvHeader
->FvBlockMap
[Index
].BlockLength
= FvInfo
.FvBlocks
[Index
].BlockLength
;
2539 // Add block map terminator
2541 FvHeader
->FvBlockMap
[Index
].NumBlocks
= 0;
2542 FvHeader
->FvBlockMap
[Index
].BlockLength
= 0;
2545 // Complete the header
2547 FvHeader
->HeaderLength
= (UINT16
) (((UINTN
) &(FvHeader
->FvBlockMap
[Index
+ 1])) - (UINTN
) *FvImage
);
2548 FvHeader
->Checksum
= 0;
2549 FvHeader
->Checksum
= CalculateChecksum16 ((UINT16
*) FvHeader
, FvHeader
->HeaderLength
/ sizeof (UINT16
));
2552 // If there is no FFS file, find and generate each components of the FV
2554 if (FvInfo
.FvFiles
[0][0] == 0) {
2555 Status
= GenNonFFSFv (*FvImage
, &FvInfo
);
2556 if (EFI_ERROR (Status
)) {
2557 printf ("ERROR: Could not generate NonFFS FV.\n");
2565 // Initialize our "file" view of the buffer
2567 FvImageMemoryFile
.FileImage
= *FvImage
;
2568 FvImageMemoryFile
.CurrentFilePointer
= *FvImage
+ FvHeader
->HeaderLength
;
2569 FvImageMemoryFile
.Eof
= *FvImage
+*FvImageSize
;
2572 // Initialize our "file" view of the symbol file.
2574 SymImageMemoryFile
.FileImage
= *SymImage
;
2575 SymImageMemoryFile
.CurrentFilePointer
= *SymImage
;
2576 SymImageMemoryFile
.Eof
= *FvImage
+ SYMBOL_FILE_SIZE
;
2579 // Initialize the FV library.
2581 InitializeFvLib (FvImageMemoryFile
.FileImage
, FvInfo
.Size
);
2584 // Files start on 8 byte alignments, so move to the next 8 byte aligned
2585 // address. For now, just assert if it isn't. Currently FV header is
2586 // always a multiple of 8 bytes.
2587 // BUGBUG: Handle this better
2589 assert ((((UINTN
) FvImageMemoryFile
.CurrentFilePointer
) % 8) == 0);
2592 // Initialize the VTF file address.
2594 VtfFileImage
= (EFI_FFS_FILE_HEADER
*) FvImageMemoryFile
.Eof
;
2599 for (Index
= 0; FvInfo
.FvFiles
[Index
][0] != 0; Index
++) {
2603 Status
= AddFile (&FvImageMemoryFile
, &FvInfo
, Index
, &VtfFileImage
, &SymImageMemoryFile
);
2606 // Exit if error detected while adding the file
2608 if (EFI_ERROR (Status
)) {
2609 printf ("ERROR: Could not add file %s.\n", FvInfo
.FvFiles
[Index
]);
2615 // If there is a VTF file, some special actions need to occur.
2617 if ((UINTN
) VtfFileImage
!= (UINTN
) FvImageMemoryFile
.Eof
) {
2619 // Pad from the end of the last file to the beginning of the VTF file.
2621 Status
= PadFvImage (&FvImageMemoryFile
, VtfFileImage
);
2622 if (EFI_ERROR (Status
)) {
2623 printf ("ERROR: Could not create the pad file between the last file and the VTF file.\n");
2628 // Update reset vector (SALE_ENTRY for IPF)
2629 // Now for IA32 and IA64 platform, the fv which has bsf file must have the
2630 // EndAddress of 0xFFFFFFFF. Thus, only this type fv needs to update the
2631 // reset vector. If the PEI Core is found, the VTF file will probably get
2632 // corrupted by updating the entry point.
2634 if ((FvInfo
.BaseAddress
+ FvInfo
.Size
) == FV_IMAGES_TOP_ADDRESS
) {
2635 Status
= UpdateResetVector (&FvImageMemoryFile
, &FvInfo
, VtfFileImage
);
2636 if (EFI_ERROR(Status
)) {
2637 printf ("ERROR: Could not update the reset vector.\n");
2644 // Determine final Sym file size
2646 *SymImageSize
= SymImageMemoryFile
.CurrentFilePointer
- SymImageMemoryFile
.FileImage
;
2652 UpdatePeiCoreEntryInFit (
2653 IN FIT_TABLE
*FitTablePtr
,
2654 IN UINT64 PeiCorePhysicalAddress
2658 Routine Description:
2660 This function is used to update the Pei Core address in FIT, this can be used by Sec core to pass control from
2665 FitTablePtr - The pointer of FIT_TABLE.
2666 PeiCorePhysicalAddress - The address of Pei Core entry.
2670 EFI_SUCCESS - The PEI_CORE FIT entry was updated successfully.
2671 EFI_NOT_FOUND - Not found the PEI_CORE FIT entry.
2675 FIT_TABLE
*TmpFitPtr
;
2677 UINTN NumFitComponents
;
2679 TmpFitPtr
= FitTablePtr
;
2680 NumFitComponents
= TmpFitPtr
->CompSize
;
2682 for (Index
= 0; Index
< NumFitComponents
; Index
++) {
2683 if ((TmpFitPtr
->CvAndType
& FIT_TYPE_MASK
) == COMP_TYPE_FIT_PEICORE
) {
2684 TmpFitPtr
->CompAddress
= PeiCorePhysicalAddress
;
2691 return EFI_NOT_FOUND
;
2696 IN FIT_TABLE
*FitTablePtr
2700 Routine Description:
2702 This function is used to update the checksum for FIT.
2707 FitTablePtr - The pointer of FIT_TABLE.
2715 if ((FitTablePtr
->CvAndType
& CHECKSUM_BIT_MASK
) >> 7) {
2716 FitTablePtr
->CheckSum
= 0;
2717 FitTablePtr
->CheckSum
= CalculateChecksum8 ((UINT8
*) FitTablePtr
, FitTablePtr
->CompSize
* 16);