2 This file contains functions required to generate a Firmware File System file.
4 Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>
5 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 #include <Common/UefiBaseTypes.h>
20 #include <Common/PiFirmwareFile.h>
21 #include <IndustryStandard/PeImage.h>
22 #include <Guid/FfsSectionAlignmentPadding.h>
24 #include "CommonLib.h"
26 #include "EfiUtilityMsgs.h"
28 #define UTILITY_NAME "GenFfs"
29 #define UTILITY_MAJOR_VERSION 0
30 #define UTILITY_MINOR_VERSION 1
32 STATIC CHAR8
*mFfsFileType
[] = {
34 "EFI_FV_FILETYPE_RAW", // 0x01
35 "EFI_FV_FILETYPE_FREEFORM", // 0x02
36 "EFI_FV_FILETYPE_SECURITY_CORE", // 0x03
37 "EFI_FV_FILETYPE_PEI_CORE", // 0x04
38 "EFI_FV_FILETYPE_DXE_CORE", // 0x05
39 "EFI_FV_FILETYPE_PEIM", // 0x06
40 "EFI_FV_FILETYPE_DRIVER", // 0x07
41 "EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER", // 0x08
42 "EFI_FV_FILETYPE_APPLICATION", // 0x09
43 "EFI_FV_FILETYPE_SMM", // 0x0A
44 "EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE",// 0x0B
45 "EFI_FV_FILETYPE_COMBINED_SMM_DXE", // 0x0C
46 "EFI_FV_FILETYPE_SMM_CORE", // 0x0D
47 "EFI_FV_FILETYPE_MM_STANDALONE", // 0x0E
48 "EFI_FV_FILETYPE_MM_CORE_STANDALONE" // 0x0F
51 STATIC CHAR8
*mAlignName
[] = {
52 "1", "2", "4", "8", "16", "32", "64", "128", "256", "512",
53 "1K", "2K", "4K", "8K", "16K", "32K", "64K", "128K", "256K",
54 "512K", "1M", "2M", "4M", "8M", "16M"
57 STATIC CHAR8
*mFfsValidAlignName
[] = {
58 "8", "16", "128", "512", "1K", "4K", "32K", "64K", "128K","256K",
59 "512K", "1M", "2M", "4M", "8M", "16M"
62 STATIC UINT32 mFfsValidAlign
[] = {0, 8, 16, 128, 512, 1024, 4096, 32768, 65536, 131072, 262144,
63 524288, 1048576, 2097152, 4194304, 8388608, 16777216};
65 STATIC EFI_GUID mZeroGuid
= {0};
67 STATIC EFI_GUID mEfiFfsSectionAlignmentPaddingGuid
= EFI_FFS_SECTION_ALIGNMENT_PADDING_GUID
;
78 Print out version information for this utility.
90 fprintf (stdout
, "%s Version %d.%d %s \n", UTILITY_NAME
, UTILITY_MAJOR_VERSION
, UTILITY_MINOR_VERSION
, __BUILD_VERSION
);
102 Print Error / Help message.
117 fprintf (stdout
, "\nUsage: %s [options]\n\n", UTILITY_NAME
);
120 // Copyright declaration
122 fprintf (stdout
, "Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.\n\n");
127 fprintf (stdout
, "Options:\n");
128 fprintf (stdout
, " -o FileName, --outputfile FileName\n\
129 File is FFS file to be created.\n");
130 fprintf (stdout
, " -t Type, --filetype Type\n\
131 Type is one FV file type defined in PI spec, which is\n\
132 EFI_FV_FILETYPE_RAW, EFI_FV_FILETYPE_FREEFORM,\n\
133 EFI_FV_FILETYPE_SECURITY_CORE, EFI_FV_FILETYPE_PEIM,\n\
134 EFI_FV_FILETYPE_PEI_CORE, EFI_FV_FILETYPE_DXE_CORE,\n\
135 EFI_FV_FILETYPE_DRIVER, EFI_FV_FILETYPE_APPLICATION,\n\
136 EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER,\n\
137 EFI_FV_FILETYPE_SMM, EFI_FV_FILETYPE_SMM_CORE,\n\
138 EFI_FV_FILETYPE_MM_STANDALONE,\n\
139 EFI_FV_FILETYPE_MM_CORE_STANDALONE,\n\
140 EFI_FV_FILETYPE_COMBINED_SMM_DXE, \n\
141 EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE.\n");
142 fprintf (stdout
, " -g FileGuid, --fileguid FileGuid\n\
143 FileGuid is one module guid.\n\
144 Its format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n");
145 fprintf (stdout
, " -x, --fixed Indicates that the file may not be moved\n\
146 from its present location.\n");
147 fprintf (stdout
, " -s, --checksum Indicates to calculate file checksum.\n");
148 fprintf (stdout
, " -a FileAlign, --align FileAlign\n\
149 FileAlign points to file alignment, which only support\n\
150 the following align: 1,2,4,8,16,128,512,1K,4K,32K,64K\n\
151 128K,256K,512K,1M,2M,4M,8M,16M\n");
152 fprintf (stdout
, " -i SectionFile, --sectionfile SectionFile\n\
153 Section file will be contained in this FFS file.\n");
154 fprintf (stdout
, " -n SectionAlign, --sectionalign SectionAlign\n\
155 SectionAlign points to section alignment, which support\n\
156 the alignment scope 1~16M. It is specified together\n\
157 with sectionfile to point its alignment in FFS file.\n");
158 fprintf (stdout
, " -v, --verbose Turn on verbose output with informational messages.\n");
159 fprintf (stdout
, " -q, --quiet Disable all messages except key message and fatal error\n");
160 fprintf (stdout
, " -d, --debug level Enable debug messages, at input debug level.\n");
161 fprintf (stdout
, " --version Show program's version number and exit.\n");
162 fprintf (stdout
, " -h, --help Show this help message and exit.\n");
168 IN CHAR8
*AlignBuffer
,
169 OUT UINT32
*AlignNumber
175 Converts Align String to align value (1~16M).
179 AlignBuffer - Pointer to Align string.
180 AlignNumber - Pointer to Align value.
184 EFI_SUCCESS Successfully convert align string to align value.
185 EFI_INVALID_PARAMETER Align string is invalid or align value is not in scope.
193 if (AlignBuffer
== NULL
) {
194 return EFI_INVALID_PARAMETER
;
196 for (Index
= 0; Index
< sizeof (mAlignName
) / sizeof (CHAR8
*); Index
++) {
197 if (stricmp (AlignBuffer
, mAlignName
[Index
]) == 0) {
198 *AlignNumber
= 1 << Index
;
202 return EFI_INVALID_PARAMETER
;
214 Converts File Type String to value. EFI_FV_FILETYPE_ALL indicates that an
215 unrecognized file type was specified.
219 String - File type string
229 if (String
== NULL
) {
230 return EFI_FV_FILETYPE_ALL
;
233 for (Index
= 0; Index
< sizeof (mFfsFileType
) / sizeof (CHAR8
*); Index
++) {
234 if (mFfsFileType
[Index
] != NULL
&& (stricmp (String
, mFfsFileType
[Index
]) == 0)) {
238 return EFI_FV_FILETYPE_ALL
;
244 IN CHAR8
**InputFileName
,
245 IN UINT32
*InputFileAlign
,
246 IN UINT32 InputFileNum
,
247 IN EFI_FFS_FILE_ATTRIBUTES FfsAttrib
,
248 OUT UINT8
*FileBuffer
,
249 OUT UINT32
*BufferLength
,
250 OUT UINT32
*MaxAlignment
,
251 OUT UINT8
*PESectionNum
257 Get the contents of all section files specified in InputFileName
262 InputFileName - Name of the input file.
264 InputFileAlign - Alignment required by the input file data.
266 InputFileNum - Number of input files. Should be at least 1.
268 FileBuffer - Output buffer to contain data
270 BufferLength - On input, this is size of the FileBuffer.
271 On output, this is the actual length of the data.
273 MaxAlignment - The max alignment required by all the input file datas.
275 PeSectionNum - Calculate the number of Pe/Te Section in this FFS file.
279 EFI_SUCCESS on successful return
280 EFI_INVALID_PARAMETER if InputFileNum is less than 1 or BufferLength point is NULL.
281 EFI_ABORTED if unable to open input file.
282 EFI_BUFFER_TOO_SMALL FileBuffer is not enough to contain all file data.
290 EFI_FREEFORM_SUBTYPE_GUID_SECTION
*SectHeader
;
291 EFI_COMMON_SECTION_HEADER2 TempSectHeader
;
292 EFI_TE_IMAGE_HEADER TeHeader
;
294 EFI_GUID_DEFINED_SECTION GuidSectHeader
;
295 EFI_GUID_DEFINED_SECTION2 GuidSectHeader2
;
297 UINT32 MaxEncounteredAlignment
;
302 MaxEncounteredAlignment
= 1;
305 // Go through our array of file names and copy their contents
306 // to the output buffer.
308 for (Index
= 0; Index
< InputFileNum
; Index
++) {
310 // make sure section ends on a DWORD boundary
312 while ((Size
& 0x03) != 0) {
317 // Open file and read contents
319 InFile
= fopen (LongFilePath (InputFileName
[Index
]), "rb");
320 if (InFile
== NULL
) {
321 Error (NULL
, 0, 0001, "Error opening file", InputFileName
[Index
]);
325 fseek (InFile
, 0, SEEK_END
);
326 FileSize
= ftell (InFile
);
327 fseek (InFile
, 0, SEEK_SET
);
328 DebugMsg (NULL
, 0, 9, "Input section files",
329 "the input section name is %s and the size is %u bytes", InputFileName
[Index
], (unsigned) FileSize
);
332 // Check this section is Te/Pe section, and Calculate the numbers of Te/Pe section.
335 if (FileSize
>= MAX_FFS_SIZE
) {
336 HeaderSize
= sizeof (EFI_COMMON_SECTION_HEADER2
);
338 HeaderSize
= sizeof (EFI_COMMON_SECTION_HEADER
);
340 fread (&TempSectHeader
, 1, HeaderSize
, InFile
);
341 if (TempSectHeader
.Type
== EFI_SECTION_TE
) {
343 fread (&TeHeader
, 1, sizeof (TeHeader
), InFile
);
344 if (TeHeader
.Signature
== EFI_TE_IMAGE_HEADER_SIGNATURE
) {
345 TeOffset
= TeHeader
.StrippedSize
- sizeof (TeHeader
);
347 } else if (TempSectHeader
.Type
== EFI_SECTION_PE32
) {
349 } else if (TempSectHeader
.Type
== EFI_SECTION_GUID_DEFINED
) {
350 fseek (InFile
, 0, SEEK_SET
);
351 if (FileSize
>= MAX_SECTION_SIZE
) {
352 fread (&GuidSectHeader2
, 1, sizeof (GuidSectHeader2
), InFile
);
353 if ((GuidSectHeader2
.Attributes
& EFI_GUIDED_SECTION_PROCESSING_REQUIRED
) == 0) {
354 HeaderSize
= GuidSectHeader2
.DataOffset
;
357 fread (&GuidSectHeader
, 1, sizeof (GuidSectHeader
), InFile
);
358 if ((GuidSectHeader
.Attributes
& EFI_GUIDED_SECTION_PROCESSING_REQUIRED
) == 0) {
359 HeaderSize
= GuidSectHeader
.DataOffset
;
363 } else if (TempSectHeader
.Type
== EFI_SECTION_COMPRESSION
||
364 TempSectHeader
.Type
== EFI_SECTION_FIRMWARE_VOLUME_IMAGE
) {
366 // for the encapsulated section, assume it contains Pe/Te section
371 fseek (InFile
, 0, SEEK_SET
);
374 // Revert TeOffset to the converse value relative to Alignment
375 // This is to assure the original PeImage Header at Alignment.
377 if ((TeOffset
!= 0) && (InputFileAlign
[Index
] != 0)) {
378 TeOffset
= InputFileAlign
[Index
] - (TeOffset
% InputFileAlign
[Index
]);
379 TeOffset
= TeOffset
% InputFileAlign
[Index
];
383 // make sure section data meet its alignment requirement by adding one pad section.
384 // But the different sections have the different section header. Necessary or not?
385 // Based on section type to adjust offset? Todo
387 if ((InputFileAlign
[Index
] != 0) && (((Size
+ HeaderSize
+ TeOffset
) % InputFileAlign
[Index
]) != 0)) {
388 Offset
= (Size
+ sizeof (EFI_COMMON_SECTION_HEADER
) + HeaderSize
+ TeOffset
+ InputFileAlign
[Index
] - 1) & ~(InputFileAlign
[Index
] - 1);
389 Offset
= Offset
- Size
- HeaderSize
- TeOffset
;
391 if (FileBuffer
!= NULL
&& ((Size
+ Offset
) < *BufferLength
)) {
393 // The maximal alignment is 64K, the raw section size must be less than 0xffffff
395 memset (FileBuffer
+ Size
, 0, Offset
);
396 SectHeader
= (EFI_FREEFORM_SUBTYPE_GUID_SECTION
*) (FileBuffer
+ Size
);
397 SectHeader
->CommonHeader
.Size
[0] = (UINT8
) (Offset
& 0xff);
398 SectHeader
->CommonHeader
.Size
[1] = (UINT8
) ((Offset
& 0xff00) >> 8);
399 SectHeader
->CommonHeader
.Size
[2] = (UINT8
) ((Offset
& 0xff0000) >> 16);
402 // Only add a special reducible padding section if
403 // - this FFS has the FFS_ATTRIB_FIXED attribute,
404 // - none of the preceding sections have alignment requirements,
405 // - the size of the padding is sufficient for the
406 // EFI_SECTION_FREEFORM_SUBTYPE_GUID header.
408 if ((FfsAttrib
& FFS_ATTRIB_FIXED
) != 0 &&
409 MaxEncounteredAlignment
<= 1 &&
410 Offset
>= sizeof (EFI_FREEFORM_SUBTYPE_GUID_SECTION
)) {
411 SectHeader
->CommonHeader
.Type
= EFI_SECTION_FREEFORM_SUBTYPE_GUID
;
412 SectHeader
->SubTypeGuid
= mEfiFfsSectionAlignmentPaddingGuid
;
414 SectHeader
->CommonHeader
.Type
= EFI_SECTION_RAW
;
417 DebugMsg (NULL
, 0, 9, "Pad raw section for section data alignment",
418 "Pad Raw section size is %u", (unsigned) Offset
);
420 Size
= Size
+ Offset
;
424 // Get the Max alignment of all input file datas
426 if (MaxEncounteredAlignment
< InputFileAlign
[Index
]) {
427 MaxEncounteredAlignment
= InputFileAlign
[Index
];
431 // Now read the contents of the file into the buffer
432 // Buffer must be enough to contain the file content.
434 if ((FileSize
> 0) && (FileBuffer
!= NULL
) && ((Size
+ FileSize
) <= *BufferLength
)) {
435 if (fread (FileBuffer
+ Size
, (size_t) FileSize
, 1, InFile
) != 1) {
436 Error (NULL
, 0, 0004, "Error reading file", InputFileName
[Index
]);
446 *MaxAlignment
= MaxEncounteredAlignment
;
449 // Set the actual length of the data.
451 if (Size
> *BufferLength
) {
452 *BufferLength
= Size
;
453 return EFI_BUFFER_TOO_SMALL
;
455 *BufferLength
= Size
;
473 argc - Number of command line parameters.
474 argv - Array of pointers to parameter strings.
477 STATUS_SUCCESS - Utility exits successfully.
478 STATUS_ERROR - Some error occurred during execution.
483 EFI_FFS_FILE_ATTRIBUTES FfsAttrib
;
485 EFI_FV_FILETYPE FfsFiletype
;
486 CHAR8
*OutputFileName
;
487 EFI_GUID FileGuid
= {0};
489 UINT32
*InputFileAlign
;
490 CHAR8
**InputFileName
;
494 EFI_FFS_FILE_HEADER2 FfsFileHeader
;
502 // Init local variables
508 FfsFiletype
= EFI_FV_FILETYPE_ALL
;
509 OutputFileName
= NULL
;
511 InputFileName
= NULL
;
512 InputFileAlign
= NULL
;
517 Status
= EFI_SUCCESS
;
520 SetUtilityName (UTILITY_NAME
);
523 Error (NULL
, 0, 1001, "Missing options", "no options input");
529 // Parse command line
534 if ((stricmp (argv
[0], "-h") == 0) || (stricmp (argv
[0], "--help") == 0)) {
537 return STATUS_SUCCESS
;
540 if (stricmp (argv
[0], "--version") == 0) {
542 return STATUS_SUCCESS
;
546 if ((stricmp (argv
[0], "-t") == 0) || (stricmp (argv
[0], "--filetype") == 0)) {
547 if (argv
[1] == NULL
|| argv
[1][0] == '-') {
548 Error (NULL
, 0, 1003, "Invalid option value", "file type is missing for -t option");
551 FfsFiletype
= StringToType (argv
[1]);
552 if (FfsFiletype
== EFI_FV_FILETYPE_ALL
) {
553 Error (NULL
, 0, 1003, "Invalid option value", "%s is not a valid file type", argv
[1]);
561 if ((stricmp (argv
[0], "-o") == 0) || (stricmp (argv
[0], "--outputfile") == 0)) {
562 if (argv
[1] == NULL
|| argv
[1][0] == '-') {
563 Error (NULL
, 0, 1003, "Invalid option value", "Output file is missing for -o option");
566 OutputFileName
= argv
[1];
572 if ((stricmp (argv
[0], "-g") == 0) || (stricmp (argv
[0], "--fileguid") == 0)) {
573 Status
= StringToGuid (argv
[1], &FileGuid
);
574 if (EFI_ERROR (Status
)) {
575 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
583 if ((stricmp (argv
[0], "-x") == 0) || (stricmp (argv
[0], "--fixed") == 0)) {
584 FfsAttrib
|= FFS_ATTRIB_FIXED
;
590 if ((stricmp (argv
[0], "-s") == 0) || (stricmp (argv
[0], "--checksum") == 0)) {
591 FfsAttrib
|= FFS_ATTRIB_CHECKSUM
;
597 if ((stricmp (argv
[0], "-a") == 0) || (stricmp (argv
[0], "--align") == 0)) {
598 if (argv
[1] == NULL
|| argv
[1][0] == '-') {
599 Error (NULL
, 0, 1003, "Invalid option value", "Align value is missing for -a option");
602 for (Index
= 0; Index
< sizeof (mFfsValidAlignName
) / sizeof (CHAR8
*); Index
++) {
603 if (stricmp (argv
[1], mFfsValidAlignName
[Index
]) == 0) {
607 if (Index
== sizeof (mFfsValidAlignName
) / sizeof (CHAR8
*)) {
608 if ((stricmp (argv
[1], "1") == 0) || (stricmp (argv
[1], "2") == 0) || (stricmp (argv
[1], "4") == 0)) {
610 // 1, 2, 4 byte alignment same to 8 byte alignment
614 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
624 if ((stricmp (argv
[0], "-i") == 0) || (stricmp (argv
[0], "--sectionfile") == 0)) {
626 // Get Input file name and its alignment
628 if (argv
[1] == NULL
|| argv
[1][0] == '-') {
629 Error (NULL
, 0, 1003, "Invalid option value", "input section file is missing for -i option");
634 // Allocate Input file name buffer and its alignment buffer.
636 if ((InputFileNum
== 0) && (InputFileName
== NULL
)) {
637 InputFileName
= (CHAR8
**) malloc (MAXIMUM_INPUT_FILE_NUM
* sizeof (CHAR8
*));
638 if (InputFileName
== NULL
) {
639 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
642 memset (InputFileName
, 0, (MAXIMUM_INPUT_FILE_NUM
* sizeof (CHAR8
*)));
644 InputFileAlign
= (UINT32
*) malloc (MAXIMUM_INPUT_FILE_NUM
* sizeof (UINT32
));
645 if (InputFileAlign
== NULL
) {
646 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
647 free (InputFileName
);
650 memset (InputFileAlign
, 0, MAXIMUM_INPUT_FILE_NUM
* sizeof (UINT32
));
651 } else if (InputFileNum
% MAXIMUM_INPUT_FILE_NUM
== 0) {
653 // InputFileName and alignment buffer too small, need to realloc
655 InputFileName
= (CHAR8
**) realloc (
657 (InputFileNum
+ MAXIMUM_INPUT_FILE_NUM
) * sizeof (CHAR8
*)
660 if (InputFileName
== NULL
) {
661 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
662 free (InputFileAlign
);
665 memset (&(InputFileName
[InputFileNum
]), 0, (MAXIMUM_INPUT_FILE_NUM
* sizeof (CHAR8
*)));
667 InputFileAlign
= (UINT32
*) realloc (
669 (InputFileNum
+ MAXIMUM_INPUT_FILE_NUM
) * sizeof (UINT32
)
672 if (InputFileAlign
== NULL
) {
673 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
674 free (InputFileName
);
677 memset (&(InputFileAlign
[InputFileNum
]), 0, (MAXIMUM_INPUT_FILE_NUM
* sizeof (UINT32
)));
680 InputFileName
[InputFileNum
] = argv
[1];
690 // Section File alignment requirement
692 if ((stricmp (argv
[0], "-n") == 0) || (stricmp (argv
[0], "--sectionalign") == 0)) {
693 Status
= StringtoAlignment (argv
[1], &(InputFileAlign
[InputFileNum
]));
694 if (EFI_ERROR (Status
)) {
695 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
705 if ((stricmp (argv
[0], "-n") == 0) || (stricmp (argv
[0], "--sectionalign") == 0)) {
706 Error (NULL
, 0, 1000, "Unknown option", "SectionAlign option must be specified with section file.");
710 if ((stricmp (argv
[0], "-v") == 0) || (stricmp (argv
[0], "--verbose") == 0)) {
711 SetPrintLevel (VERBOSE_LOG_LEVEL
);
712 VerboseMsg ("Verbose output Mode Set!");
718 if ((stricmp (argv
[0], "-q") == 0) || (stricmp (argv
[0], "--quiet") == 0)) {
719 SetPrintLevel (KEY_LOG_LEVEL
);
720 KeyMsg ("Quiet output Mode Set!");
726 if ((stricmp (argv
[0], "-d") == 0) || (stricmp (argv
[0], "--debug") == 0)) {
727 Status
= AsciiStringToUint64 (argv
[1], FALSE
, &LogLevel
);
728 if (EFI_ERROR (Status
)) {
729 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
733 Error (NULL
, 0, 1003, "Invalid option value", "Debug Level range is 0-9, current input level is %d", (int) LogLevel
);
736 SetPrintLevel (LogLevel
);
737 DebugMsg (NULL
, 0, 9, "Debug Mode Set", "Debug Output Mode Level %s is set!", argv
[1]);
743 Error (NULL
, 0, 1000, "Unknown option", "%s", argv
[0]);
747 VerboseMsg ("%s tool start.", UTILITY_NAME
);
750 // Check the complete input parameters.
752 if (FfsFiletype
== EFI_FV_FILETYPE_ALL
) {
753 Error (NULL
, 0, 1001, "Missing option", "filetype");
757 if (CompareGuid (&FileGuid
, &mZeroGuid
) == 0) {
758 Error (NULL
, 0, 1001, "Missing option", "fileguid");
762 if (InputFileNum
== 0) {
763 Error (NULL
, 0, 1001, "Missing option", "Input files");
768 // Output input parameter information
770 VerboseMsg ("Fv File type is %s", mFfsFileType
[FfsFiletype
]);
771 VerboseMsg ("Output file name is %s", OutputFileName
);
772 VerboseMsg ("FFS File Guid is %08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",
773 (unsigned) FileGuid
.Data1
,
784 if ((FfsAttrib
& FFS_ATTRIB_FIXED
) != 0) {
785 VerboseMsg ("FFS File has the fixed file attribute");
787 if ((FfsAttrib
& FFS_ATTRIB_CHECKSUM
) != 0) {
788 VerboseMsg ("FFS File requires the checksum of the whole file");
790 VerboseMsg ("FFS file alignment is %s", mFfsValidAlignName
[FfsAlign
]);
791 for (Index
= 0; Index
< InputFileNum
; Index
++) {
792 if (InputFileAlign
[Index
] == 0) {
794 // Minimum alignment is 1 byte.
796 InputFileAlign
[Index
] = 1;
798 VerboseMsg ("the %dth input section name is %s and section alignment is %u", Index
, InputFileName
[Index
], (unsigned) InputFileAlign
[Index
]);
802 // Calculate the size of all input section files.
804 Status
= GetSectionContents (
815 if ((FfsFiletype
== EFI_FV_FILETYPE_SECURITY_CORE
||
816 FfsFiletype
== EFI_FV_FILETYPE_PEI_CORE
||
817 FfsFiletype
== EFI_FV_FILETYPE_DXE_CORE
) && (PeSectionNum
!= 1)) {
818 Error (NULL
, 0, 2000, "Invalid parameter", "Fv File type %s must have one and only one Pe or Te section, but %u Pe/Te section are input", mFfsFileType
[FfsFiletype
], PeSectionNum
);
822 if ((FfsFiletype
== EFI_FV_FILETYPE_PEIM
||
823 FfsFiletype
== EFI_FV_FILETYPE_DRIVER
||
824 FfsFiletype
== EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER
||
825 FfsFiletype
== EFI_FV_FILETYPE_APPLICATION
) && (PeSectionNum
< 1)) {
826 Error (NULL
, 0, 2000, "Invalid parameter", "Fv File type %s must have at least one Pe or Te section, but no Pe/Te section is input", mFfsFileType
[FfsFiletype
]);
830 if (Status
== EFI_BUFFER_TOO_SMALL
) {
831 FileBuffer
= (UINT8
*) malloc (FileSize
);
832 if (FileBuffer
== NULL
) {
833 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
836 memset (FileBuffer
, 0, FileSize
);
839 // read all input file contents into a buffer
841 Status
= GetSectionContents (
853 if (EFI_ERROR (Status
)) {
857 if (FileBuffer
== NULL
&& FileSize
!= 0) {
858 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
863 // Create Ffs file header.
865 memset (&FfsFileHeader
, 0, sizeof (EFI_FFS_FILE_HEADER2
));
866 memcpy (&FfsFileHeader
.Name
, &FileGuid
, sizeof (EFI_GUID
));
867 FfsFileHeader
.Type
= FfsFiletype
;
869 // Update FFS Alignment based on the max alignment required by input section files
871 VerboseMsg ("the max alignment of all input sections is %u", (unsigned) MaxAlignment
);
872 for (Index
= 0; Index
< sizeof (mFfsValidAlign
) / sizeof (UINT32
) - 1; Index
++) {
873 if ((MaxAlignment
> mFfsValidAlign
[Index
]) && (MaxAlignment
<= mFfsValidAlign
[Index
+ 1])) {
877 if (FfsAlign
< Index
) {
880 VerboseMsg ("the alignment of the generated FFS file is %u", (unsigned) mFfsValidAlign
[FfsAlign
+ 1]);
883 // Now FileSize includes the EFI_FFS_FILE_HEADER
885 if (FileSize
+ sizeof (EFI_FFS_FILE_HEADER
) >= MAX_FFS_SIZE
) {
886 HeaderSize
= sizeof (EFI_FFS_FILE_HEADER2
);
887 FileSize
+= sizeof (EFI_FFS_FILE_HEADER2
);
888 FfsFileHeader
.ExtendedSize
= FileSize
;
889 memset(FfsFileHeader
.Size
, 0, sizeof (UINT8
) * 3);
890 FfsAttrib
|= FFS_ATTRIB_LARGE_FILE
;
892 HeaderSize
= sizeof (EFI_FFS_FILE_HEADER
);
893 FileSize
+= sizeof (EFI_FFS_FILE_HEADER
);
894 FfsFileHeader
.Size
[0] = (UINT8
) (FileSize
& 0xFF);
895 FfsFileHeader
.Size
[1] = (UINT8
) ((FileSize
& 0xFF00) >> 8);
896 FfsFileHeader
.Size
[2] = (UINT8
) ((FileSize
& 0xFF0000) >> 16);
898 VerboseMsg ("the size of the generated FFS file is %u bytes", (unsigned) FileSize
);
900 //FfsAlign larger than 7, set FFS_ATTRIB_DATA_ALIGNMENT2
902 FfsFileHeader
.Attributes
= (EFI_FFS_FILE_ATTRIBUTES
) (FfsAttrib
| (FfsAlign
<< 3));
904 FfsFileHeader
.Attributes
= (EFI_FFS_FILE_ATTRIBUTES
) (FfsAttrib
| ((FfsAlign
& 0x7) << 3) | FFS_ATTRIB_DATA_ALIGNMENT2
);
908 // Fill in checksums and state, these must be zero for checksumming
910 // FileHeader.IntegrityCheck.Checksum.Header = 0;
911 // FileHeader.IntegrityCheck.Checksum.File = 0;
912 // FileHeader.State = 0;
914 FfsFileHeader
.IntegrityCheck
.Checksum
.Header
= CalculateChecksum8 (
915 (UINT8
*) &FfsFileHeader
,
919 if (FfsFileHeader
.Attributes
& FFS_ATTRIB_CHECKSUM
) {
921 // Ffs header checksum = zero, so only need to calculate ffs body.
923 FfsFileHeader
.IntegrityCheck
.Checksum
.File
= CalculateChecksum8 (
925 FileSize
- HeaderSize
928 FfsFileHeader
.IntegrityCheck
.Checksum
.File
= FFS_FIXED_CHECKSUM
;
931 FfsFileHeader
.State
= EFI_FILE_HEADER_CONSTRUCTION
| EFI_FILE_HEADER_VALID
| EFI_FILE_DATA_VALID
;
934 // Open output file to write ffs data.
936 if (OutputFileName
!= NULL
) {
937 remove(OutputFileName
);
938 FfsFile
= fopen (LongFilePath (OutputFileName
), "wb");
939 if (FfsFile
== NULL
) {
940 Error (NULL
, 0, 0001, "Error opening file", OutputFileName
);
946 fwrite (&FfsFileHeader
, 1, HeaderSize
, FfsFile
);
950 if (FileBuffer
!= NULL
) {
951 fwrite (FileBuffer
, 1, FileSize
- HeaderSize
, FfsFile
);
958 if (InputFileName
!= NULL
) {
959 free (InputFileName
);
961 if (InputFileAlign
!= NULL
) {
962 free (InputFileAlign
);
964 if (FileBuffer
!= NULL
) {
968 // If any errors were reported via the standard error reporting
969 // routines, then the status has been saved. Get the value and
970 // return it to the caller.
972 VerboseMsg ("%s tool done with return code is 0x%x.", UTILITY_NAME
, GetUtilityStatus ());
974 return GetUtilityStatus ();