2 This file contains functions required to generate a Firmware File System file.
4 Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
12 #include <sys/types.h>
20 #include <Common/UefiBaseTypes.h>
21 #include <Common/PiFirmwareFile.h>
22 #include <IndustryStandard/PeImage.h>
23 #include <Guid/FfsSectionAlignmentPadding.h>
25 #include "CommonLib.h"
27 #include "EfiUtilityMsgs.h"
29 #include "PeCoffLib.h"
31 #define UTILITY_NAME "GenFfs"
32 #define UTILITY_MAJOR_VERSION 0
33 #define UTILITY_MINOR_VERSION 1
35 STATIC CHAR8
*mFfsFileType
[] = {
37 "EFI_FV_FILETYPE_RAW", // 0x01
38 "EFI_FV_FILETYPE_FREEFORM", // 0x02
39 "EFI_FV_FILETYPE_SECURITY_CORE", // 0x03
40 "EFI_FV_FILETYPE_PEI_CORE", // 0x04
41 "EFI_FV_FILETYPE_DXE_CORE", // 0x05
42 "EFI_FV_FILETYPE_PEIM", // 0x06
43 "EFI_FV_FILETYPE_DRIVER", // 0x07
44 "EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER", // 0x08
45 "EFI_FV_FILETYPE_APPLICATION", // 0x09
46 "EFI_FV_FILETYPE_SMM", // 0x0A
47 "EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE",// 0x0B
48 "EFI_FV_FILETYPE_COMBINED_SMM_DXE", // 0x0C
49 "EFI_FV_FILETYPE_SMM_CORE", // 0x0D
50 "EFI_FV_FILETYPE_MM_STANDALONE", // 0x0E
51 "EFI_FV_FILETYPE_MM_CORE_STANDALONE" // 0x0F
54 STATIC CHAR8
*mAlignName
[] = {
55 "1", "2", "4", "8", "16", "32", "64", "128", "256", "512",
56 "1K", "2K", "4K", "8K", "16K", "32K", "64K", "128K", "256K",
57 "512K", "1M", "2M", "4M", "8M", "16M"
60 STATIC CHAR8
*mFfsValidAlignName
[] = {
61 "8", "16", "128", "512", "1K", "4K", "32K", "64K", "128K","256K",
62 "512K", "1M", "2M", "4M", "8M", "16M"
65 STATIC UINT32 mFfsValidAlign
[] = {0, 8, 16, 128, 512, 1024, 4096, 32768, 65536, 131072, 262144,
66 524288, 1048576, 2097152, 4194304, 8388608, 16777216};
68 STATIC EFI_GUID mZeroGuid
= {0};
70 STATIC EFI_GUID mEfiFfsSectionAlignmentPaddingGuid
= EFI_FFS_SECTION_ALIGNMENT_PADDING_GUID
;
81 Print out version information for this utility.
93 fprintf (stdout
, "%s Version %d.%d %s \n", UTILITY_NAME
, UTILITY_MAJOR_VERSION
, UTILITY_MINOR_VERSION
, __BUILD_VERSION
);
105 Print Error / Help message.
120 fprintf (stdout
, "\nUsage: %s [options]\n\n", UTILITY_NAME
);
123 // Copyright declaration
125 fprintf (stdout
, "Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.\n\n");
130 fprintf (stdout
, "Options:\n");
131 fprintf (stdout
, " -o FileName, --outputfile FileName\n\
132 File is FFS file to be created.\n");
133 fprintf (stdout
, " -t Type, --filetype Type\n\
134 Type is one FV file type defined in PI spec, which is\n\
135 EFI_FV_FILETYPE_RAW, EFI_FV_FILETYPE_FREEFORM,\n\
136 EFI_FV_FILETYPE_SECURITY_CORE, EFI_FV_FILETYPE_PEIM,\n\
137 EFI_FV_FILETYPE_PEI_CORE, EFI_FV_FILETYPE_DXE_CORE,\n\
138 EFI_FV_FILETYPE_DRIVER, EFI_FV_FILETYPE_APPLICATION,\n\
139 EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER,\n\
140 EFI_FV_FILETYPE_SMM, EFI_FV_FILETYPE_SMM_CORE,\n\
141 EFI_FV_FILETYPE_MM_STANDALONE,\n\
142 EFI_FV_FILETYPE_MM_CORE_STANDALONE,\n\
143 EFI_FV_FILETYPE_COMBINED_SMM_DXE, \n\
144 EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE.\n");
145 fprintf (stdout
, " -g FileGuid, --fileguid FileGuid\n\
146 FileGuid is one module guid.\n\
147 Its format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n");
148 fprintf (stdout
, " -x, --fixed Indicates that the file may not be moved\n\
149 from its present location.\n");
150 fprintf (stdout
, " -s, --checksum Indicates to calculate file checksum.\n");
151 fprintf (stdout
, " -a FileAlign, --align FileAlign\n\
152 FileAlign points to file alignment, which only support\n\
153 the following align: 1,2,4,8,16,128,512,1K,4K,32K,64K\n\
154 128K,256K,512K,1M,2M,4M,8M,16M\n");
155 fprintf (stdout
, " -i SectionFile, --sectionfile SectionFile\n\
156 Section file will be contained in this FFS file.\n");
157 fprintf (stdout
, " -n SectionAlign, --sectionalign SectionAlign\n\
158 SectionAlign points to section alignment, which support\n\
159 the alignment scope 0~16M. If SectionAlign is specified\n\
160 as 0, tool get alignment value from SectionFile. It is\n\
161 specified together with sectionfile to point its\n\
162 alignment in FFS file.\n");
163 fprintf (stdout
, " -v, --verbose Turn on verbose output with informational messages.\n");
164 fprintf (stdout
, " -q, --quiet Disable all messages except key message and fatal error\n");
165 fprintf (stdout
, " -d, --debug level Enable debug messages, at input debug level.\n");
166 fprintf (stdout
, " --version Show program's version number and exit.\n");
167 fprintf (stdout
, " -h, --help Show this help message and exit.\n");
173 IN CHAR8
*AlignBuffer
,
174 OUT UINT32
*AlignNumber
180 Converts Align String to align value (1~16M).
184 AlignBuffer - Pointer to Align string.
185 AlignNumber - Pointer to Align value.
189 EFI_SUCCESS Successfully convert align string to align value.
190 EFI_INVALID_PARAMETER Align string is invalid or align value is not in scope.
198 if (AlignBuffer
== NULL
) {
199 return EFI_INVALID_PARAMETER
;
201 for (Index
= 0; Index
< sizeof (mAlignName
) / sizeof (CHAR8
*); Index
++) {
202 if (stricmp (AlignBuffer
, mAlignName
[Index
]) == 0) {
203 *AlignNumber
= 1 << Index
;
207 return EFI_INVALID_PARAMETER
;
219 Converts File Type String to value. EFI_FV_FILETYPE_ALL indicates that an
220 unrecognized file type was specified.
224 String - File type string
234 if (String
== NULL
) {
235 return EFI_FV_FILETYPE_ALL
;
238 for (Index
= 0; Index
< sizeof (mFfsFileType
) / sizeof (CHAR8
*); Index
++) {
239 if (mFfsFileType
[Index
] != NULL
&& (stricmp (String
, mFfsFileType
[Index
]) == 0)) {
243 return EFI_FV_FILETYPE_ALL
;
249 IN CHAR8
**InputFileName
,
250 IN UINT32
*InputFileAlign
,
251 IN UINT32 InputFileNum
,
252 IN EFI_FFS_FILE_ATTRIBUTES FfsAttrib
,
253 OUT UINT8
*FileBuffer
,
254 OUT UINT32
*BufferLength
,
255 OUT UINT32
*MaxAlignment
,
256 OUT UINT8
*PESectionNum
262 Get the contents of all section files specified in InputFileName
267 InputFileName - Name of the input file.
269 InputFileAlign - Alignment required by the input file data.
271 InputFileNum - Number of input files. Should be at least 1.
273 FileBuffer - Output buffer to contain data
275 BufferLength - On input, this is size of the FileBuffer.
276 On output, this is the actual length of the data.
278 MaxAlignment - The max alignment required by all the input file datas.
280 PeSectionNum - Calculate the number of Pe/Te Section in this FFS file.
284 EFI_SUCCESS on successful return
285 EFI_INVALID_PARAMETER if InputFileNum is less than 1 or BufferLength point is NULL.
286 EFI_ABORTED if unable to open input file.
287 EFI_BUFFER_TOO_SMALL FileBuffer is not enough to contain all file data.
295 EFI_FREEFORM_SUBTYPE_GUID_SECTION
*SectHeader
;
296 EFI_COMMON_SECTION_HEADER2 TempSectHeader
;
297 EFI_TE_IMAGE_HEADER TeHeader
;
299 EFI_GUID_DEFINED_SECTION GuidSectHeader
;
300 EFI_GUID_DEFINED_SECTION2 GuidSectHeader2
;
302 UINT32 MaxEncounteredAlignment
;
307 MaxEncounteredAlignment
= 1;
310 // Go through our array of file names and copy their contents
311 // to the output buffer.
313 for (Index
= 0; Index
< InputFileNum
; Index
++) {
315 // make sure section ends on a DWORD boundary
317 while ((Size
& 0x03) != 0) {
322 // Open file and read contents
324 InFile
= fopen (LongFilePath (InputFileName
[Index
]), "rb");
325 if (InFile
== NULL
) {
326 Error (NULL
, 0, 0001, "Error opening file", InputFileName
[Index
]);
330 fseek (InFile
, 0, SEEK_END
);
331 FileSize
= ftell (InFile
);
332 fseek (InFile
, 0, SEEK_SET
);
333 DebugMsg (NULL
, 0, 9, "Input section files",
334 "the input section name is %s and the size is %u bytes", InputFileName
[Index
], (unsigned) FileSize
);
337 // Check this section is Te/Pe section, and Calculate the numbers of Te/Pe section.
340 if (FileSize
>= MAX_FFS_SIZE
) {
341 HeaderSize
= sizeof (EFI_COMMON_SECTION_HEADER2
);
343 HeaderSize
= sizeof (EFI_COMMON_SECTION_HEADER
);
345 fread (&TempSectHeader
, 1, HeaderSize
, InFile
);
346 if (TempSectHeader
.Type
== EFI_SECTION_TE
) {
348 fread (&TeHeader
, 1, sizeof (TeHeader
), InFile
);
349 if (TeHeader
.Signature
== EFI_TE_IMAGE_HEADER_SIGNATURE
) {
350 TeOffset
= TeHeader
.StrippedSize
- sizeof (TeHeader
);
352 } else if (TempSectHeader
.Type
== EFI_SECTION_PE32
) {
354 } else if (TempSectHeader
.Type
== EFI_SECTION_GUID_DEFINED
) {
355 fseek (InFile
, 0, SEEK_SET
);
356 if (FileSize
>= MAX_SECTION_SIZE
) {
357 fread (&GuidSectHeader2
, 1, sizeof (GuidSectHeader2
), InFile
);
358 if ((GuidSectHeader2
.Attributes
& EFI_GUIDED_SECTION_PROCESSING_REQUIRED
) == 0) {
359 HeaderSize
= GuidSectHeader2
.DataOffset
;
362 fread (&GuidSectHeader
, 1, sizeof (GuidSectHeader
), InFile
);
363 if ((GuidSectHeader
.Attributes
& EFI_GUIDED_SECTION_PROCESSING_REQUIRED
) == 0) {
364 HeaderSize
= GuidSectHeader
.DataOffset
;
368 } else if (TempSectHeader
.Type
== EFI_SECTION_COMPRESSION
||
369 TempSectHeader
.Type
== EFI_SECTION_FIRMWARE_VOLUME_IMAGE
) {
371 // for the encapsulated section, assume it contains Pe/Te section
376 fseek (InFile
, 0, SEEK_SET
);
379 // Revert TeOffset to the converse value relative to Alignment
380 // This is to assure the original PeImage Header at Alignment.
382 if ((TeOffset
!= 0) && (InputFileAlign
[Index
] != 0)) {
383 TeOffset
= InputFileAlign
[Index
] - (TeOffset
% InputFileAlign
[Index
]);
384 TeOffset
= TeOffset
% InputFileAlign
[Index
];
388 // make sure section data meet its alignment requirement by adding one pad section.
389 // But the different sections have the different section header. Necessary or not?
390 // Based on section type to adjust offset? Todo
392 if ((InputFileAlign
[Index
] != 0) && (((Size
+ HeaderSize
+ TeOffset
) % InputFileAlign
[Index
]) != 0)) {
393 Offset
= (Size
+ sizeof (EFI_COMMON_SECTION_HEADER
) + HeaderSize
+ TeOffset
+ InputFileAlign
[Index
] - 1) & ~(InputFileAlign
[Index
] - 1);
394 Offset
= Offset
- Size
- HeaderSize
- TeOffset
;
396 if (FileBuffer
!= NULL
&& ((Size
+ Offset
) < *BufferLength
)) {
398 // The maximal alignment is 64K, the raw section size must be less than 0xffffff
400 memset (FileBuffer
+ Size
, 0, Offset
);
401 SectHeader
= (EFI_FREEFORM_SUBTYPE_GUID_SECTION
*) (FileBuffer
+ Size
);
402 SectHeader
->CommonHeader
.Size
[0] = (UINT8
) (Offset
& 0xff);
403 SectHeader
->CommonHeader
.Size
[1] = (UINT8
) ((Offset
& 0xff00) >> 8);
404 SectHeader
->CommonHeader
.Size
[2] = (UINT8
) ((Offset
& 0xff0000) >> 16);
407 // Only add a special reducible padding section if
408 // - this FFS has the FFS_ATTRIB_FIXED attribute,
409 // - none of the preceding sections have alignment requirements,
410 // - the size of the padding is sufficient for the
411 // EFI_SECTION_FREEFORM_SUBTYPE_GUID header.
413 if ((FfsAttrib
& FFS_ATTRIB_FIXED
) != 0 &&
414 MaxEncounteredAlignment
<= 1 &&
415 Offset
>= sizeof (EFI_FREEFORM_SUBTYPE_GUID_SECTION
)) {
416 SectHeader
->CommonHeader
.Type
= EFI_SECTION_FREEFORM_SUBTYPE_GUID
;
417 SectHeader
->SubTypeGuid
= mEfiFfsSectionAlignmentPaddingGuid
;
419 SectHeader
->CommonHeader
.Type
= EFI_SECTION_RAW
;
422 DebugMsg (NULL
, 0, 9, "Pad raw section for section data alignment",
423 "Pad Raw section size is %u", (unsigned) Offset
);
425 Size
= Size
+ Offset
;
429 // Get the Max alignment of all input file datas
431 if (MaxEncounteredAlignment
< InputFileAlign
[Index
]) {
432 MaxEncounteredAlignment
= InputFileAlign
[Index
];
436 // Now read the contents of the file into the buffer
437 // Buffer must be enough to contain the file content.
439 if ((FileSize
> 0) && (FileBuffer
!= NULL
) && ((Size
+ FileSize
) <= *BufferLength
)) {
440 if (fread (FileBuffer
+ Size
, (size_t) FileSize
, 1, InFile
) != 1) {
441 Error (NULL
, 0, 0004, "Error reading file", InputFileName
[Index
]);
451 *MaxAlignment
= MaxEncounteredAlignment
;
454 // Set the actual length of the data.
456 if (Size
> *BufferLength
) {
457 *BufferLength
= Size
;
458 return EFI_BUFFER_TOO_SMALL
;
460 *BufferLength
= Size
;
469 IN OUT UINT32
*ReadSize
,
476 Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
480 FileHandle - The handle to the PE/COFF file
482 FileOffset - The offset, in bytes, into the file to read
484 ReadSize - The number of bytes to read from the file starting at FileOffset
486 Buffer - A pointer to the buffer to read the data into.
490 EFI_SUCCESS - ReadSize bytes of data were read into Buffer from the PE/COFF file starting at FileOffset
498 Destination8
= Buffer
;
499 Source8
= (CHAR8
*) ((UINTN
) FileHandle
+ FileOffset
);
502 *(Destination8
++) = *(Source8
++);
510 GetAlignmentFromFile(char *InFile
, UINT32
*Alignment
)
512 InFile is input file for getting alignment
519 UINT32 CurSecHdrSize
;
520 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
521 EFI_COMMON_SECTION_HEADER
*CommonHeader
;
528 memset (&ImageContext
, 0, sizeof (ImageContext
));
530 InFileHandle
= fopen(LongFilePath(InFile
), "rb");
531 if (InFileHandle
== NULL
){
532 Error (NULL
, 0, 0001, "Error opening file", InFile
);
535 PeFileSize
= _filelength (fileno(InFileHandle
));
536 PeFileBuffer
= (UINT8
*) malloc (PeFileSize
);
537 if (PeFileBuffer
== NULL
) {
538 fclose (InFileHandle
);
539 Error(NULL
, 0, 4001, "Resource", "memory cannot be allocated of %s", InFileHandle
);
540 return EFI_OUT_OF_RESOURCES
;
542 fread (PeFileBuffer
, sizeof (UINT8
), PeFileSize
, InFileHandle
);
543 fclose (InFileHandle
);
544 CommonHeader
= (EFI_COMMON_SECTION_HEADER
*) PeFileBuffer
;
545 CurSecHdrSize
= GetSectionHeaderLength(CommonHeader
);
546 ImageContext
.Handle
= (VOID
*) ((UINTN
)PeFileBuffer
+ CurSecHdrSize
);
547 ImageContext
.ImageRead
= (PE_COFF_LOADER_READ_FILE
)FfsRebaseImageRead
;
548 Status
= PeCoffLoaderGetImageInfo(&ImageContext
);
549 if (EFI_ERROR (Status
)) {
550 Error (NULL
, 0, 3000, "Invalid PeImage", "The input file is %s and return status is %x", InFile
, (int) Status
);
553 *Alignment
= ImageContext
.SectionAlignment
;
554 // Free the allocated memory resource
555 if (PeFileBuffer
!= NULL
) {
575 argc - Number of command line parameters.
576 argv - Array of pointers to parameter strings.
579 STATUS_SUCCESS - Utility exits successfully.
580 STATUS_ERROR - Some error occurred during execution.
585 EFI_FFS_FILE_ATTRIBUTES FfsAttrib
;
587 EFI_FV_FILETYPE FfsFiletype
;
588 CHAR8
*OutputFileName
;
589 EFI_GUID FileGuid
= {0};
591 UINT32
*InputFileAlign
;
592 CHAR8
**InputFileName
;
596 EFI_FFS_FILE_HEADER2 FfsFileHeader
;
604 // Workaround for static code checkers.
605 // Ensures the size of 'AlignmentBuffer' can hold all the digits of an
606 // unsigned 32-bit integer plus the size unit character.
608 CHAR8 AlignmentBuffer
[16];
611 // Init local variables
617 FfsFiletype
= EFI_FV_FILETYPE_ALL
;
618 OutputFileName
= NULL
;
620 InputFileName
= NULL
;
621 InputFileAlign
= NULL
;
626 Status
= EFI_SUCCESS
;
629 SetUtilityName (UTILITY_NAME
);
632 Error (NULL
, 0, 1001, "Missing options", "no options input");
638 // Parse command line
643 if ((stricmp (argv
[0], "-h") == 0) || (stricmp (argv
[0], "--help") == 0)) {
646 return STATUS_SUCCESS
;
649 if (stricmp (argv
[0], "--version") == 0) {
651 return STATUS_SUCCESS
;
655 if ((stricmp (argv
[0], "-t") == 0) || (stricmp (argv
[0], "--filetype") == 0)) {
656 if (argv
[1] == NULL
|| argv
[1][0] == '-') {
657 Error (NULL
, 0, 1003, "Invalid option value", "file type is missing for -t option");
660 FfsFiletype
= StringToType (argv
[1]);
661 if (FfsFiletype
== EFI_FV_FILETYPE_ALL
) {
662 Error (NULL
, 0, 1003, "Invalid option value", "%s is not a valid file type", argv
[1]);
670 if ((stricmp (argv
[0], "-o") == 0) || (stricmp (argv
[0], "--outputfile") == 0)) {
671 if (argv
[1] == NULL
|| argv
[1][0] == '-') {
672 Error (NULL
, 0, 1003, "Invalid option value", "Output file is missing for -o option");
675 OutputFileName
= argv
[1];
681 if ((stricmp (argv
[0], "-g") == 0) || (stricmp (argv
[0], "--fileguid") == 0)) {
682 Status
= StringToGuid (argv
[1], &FileGuid
);
683 if (EFI_ERROR (Status
)) {
684 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
692 if ((stricmp (argv
[0], "-x") == 0) || (stricmp (argv
[0], "--fixed") == 0)) {
693 FfsAttrib
|= FFS_ATTRIB_FIXED
;
699 if ((stricmp (argv
[0], "-s") == 0) || (stricmp (argv
[0], "--checksum") == 0)) {
700 FfsAttrib
|= FFS_ATTRIB_CHECKSUM
;
706 if ((stricmp (argv
[0], "-a") == 0) || (stricmp (argv
[0], "--align") == 0)) {
707 if (argv
[1] == NULL
|| argv
[1][0] == '-') {
708 Error (NULL
, 0, 1003, "Invalid option value", "Align value is missing for -a option");
711 for (Index
= 0; Index
< sizeof (mFfsValidAlignName
) / sizeof (CHAR8
*); Index
++) {
712 if (stricmp (argv
[1], mFfsValidAlignName
[Index
]) == 0) {
716 if (Index
== sizeof (mFfsValidAlignName
) / sizeof (CHAR8
*)) {
717 if ((stricmp (argv
[1], "1") == 0) || (stricmp (argv
[1], "2") == 0) || (stricmp (argv
[1], "4") == 0)) {
719 // 1, 2, 4 byte alignment same to 8 byte alignment
723 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
733 if ((stricmp (argv
[0], "-i") == 0) || (stricmp (argv
[0], "--sectionfile") == 0)) {
735 // Get Input file name and its alignment
737 if (argv
[1] == NULL
|| argv
[1][0] == '-') {
738 Error (NULL
, 0, 1003, "Invalid option value", "input section file is missing for -i option");
743 // Allocate Input file name buffer and its alignment buffer.
745 if ((InputFileNum
== 0) && (InputFileName
== NULL
)) {
746 InputFileName
= (CHAR8
**) malloc (MAXIMUM_INPUT_FILE_NUM
* sizeof (CHAR8
*));
747 if (InputFileName
== NULL
) {
748 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
751 memset (InputFileName
, 0, (MAXIMUM_INPUT_FILE_NUM
* sizeof (CHAR8
*)));
753 InputFileAlign
= (UINT32
*) malloc (MAXIMUM_INPUT_FILE_NUM
* sizeof (UINT32
));
754 if (InputFileAlign
== NULL
) {
755 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
756 free (InputFileName
);
759 memset (InputFileAlign
, 0, MAXIMUM_INPUT_FILE_NUM
* sizeof (UINT32
));
760 } else if (InputFileNum
% MAXIMUM_INPUT_FILE_NUM
== 0) {
762 // InputFileName and alignment buffer too small, need to realloc
764 InputFileName
= (CHAR8
**) realloc (
766 (InputFileNum
+ MAXIMUM_INPUT_FILE_NUM
) * sizeof (CHAR8
*)
769 if (InputFileName
== NULL
) {
770 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
771 free (InputFileAlign
);
774 memset (&(InputFileName
[InputFileNum
]), 0, (MAXIMUM_INPUT_FILE_NUM
* sizeof (CHAR8
*)));
776 InputFileAlign
= (UINT32
*) realloc (
778 (InputFileNum
+ MAXIMUM_INPUT_FILE_NUM
) * sizeof (UINT32
)
781 if (InputFileAlign
== NULL
) {
782 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
783 free (InputFileName
);
786 memset (&(InputFileAlign
[InputFileNum
]), 0, (MAXIMUM_INPUT_FILE_NUM
* sizeof (UINT32
)));
789 InputFileName
[InputFileNum
] = argv
[1];
799 // Section File alignment requirement
801 if ((stricmp (argv
[0], "-n") == 0) || (stricmp (argv
[0], "--sectionalign") == 0)) {
802 if ((argv
[1] != NULL
) && (stricmp("0", argv
[1]) == 0)) {
803 Status
= GetAlignmentFromFile(InputFileName
[InputFileNum
], &Alignment
);
804 if (EFI_ERROR(Status
)) {
805 Error (NULL
, 0, 1003, "Fail to get Alignment from %s", InputFileName
[InputFileNum
]);
808 if (Alignment
< 0x400){
809 sprintf (AlignmentBuffer
, "%d", Alignment
);
811 else if (Alignment
>= 0x400) {
812 if (Alignment
>= 0x100000) {
813 sprintf (AlignmentBuffer
, "%dM", Alignment
/0x100000);
815 sprintf (AlignmentBuffer
, "%dK", Alignment
/0x400);
818 Status
= StringtoAlignment (AlignmentBuffer
, &(InputFileAlign
[InputFileNum
]));
821 Status
= StringtoAlignment (argv
[1], &(InputFileAlign
[InputFileNum
]));
823 if (EFI_ERROR (Status
)) {
824 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
834 if ((stricmp (argv
[0], "-n") == 0) || (stricmp (argv
[0], "--sectionalign") == 0)) {
835 Error (NULL
, 0, 1000, "Unknown option", "SectionAlign option must be specified with section file.");
839 if ((stricmp (argv
[0], "-v") == 0) || (stricmp (argv
[0], "--verbose") == 0)) {
840 SetPrintLevel (VERBOSE_LOG_LEVEL
);
841 VerboseMsg ("Verbose output Mode Set!");
847 if ((stricmp (argv
[0], "-q") == 0) || (stricmp (argv
[0], "--quiet") == 0)) {
848 SetPrintLevel (KEY_LOG_LEVEL
);
849 KeyMsg ("Quiet output Mode Set!");
855 if ((stricmp (argv
[0], "-d") == 0) || (stricmp (argv
[0], "--debug") == 0)) {
856 Status
= AsciiStringToUint64 (argv
[1], FALSE
, &LogLevel
);
857 if (EFI_ERROR (Status
)) {
858 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
862 Error (NULL
, 0, 1003, "Invalid option value", "Debug Level range is 0-9, current input level is %d", (int) LogLevel
);
865 SetPrintLevel (LogLevel
);
866 DebugMsg (NULL
, 0, 9, "Debug Mode Set", "Debug Output Mode Level %s is set!", argv
[1]);
872 Error (NULL
, 0, 1000, "Unknown option", "%s", argv
[0]);
876 VerboseMsg ("%s tool start.", UTILITY_NAME
);
879 // Check the complete input parameters.
881 if (FfsFiletype
== EFI_FV_FILETYPE_ALL
) {
882 Error (NULL
, 0, 1001, "Missing option", "filetype");
886 if (CompareGuid (&FileGuid
, &mZeroGuid
) == 0) {
887 Error (NULL
, 0, 1001, "Missing option", "fileguid");
891 if (InputFileNum
== 0) {
892 Error (NULL
, 0, 1001, "Missing option", "Input files");
897 // Output input parameter information
899 VerboseMsg ("Fv File type is %s", mFfsFileType
[FfsFiletype
]);
900 VerboseMsg ("Output file name is %s", OutputFileName
);
901 VerboseMsg ("FFS File Guid is %08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",
902 (unsigned) FileGuid
.Data1
,
913 if ((FfsAttrib
& FFS_ATTRIB_FIXED
) != 0) {
914 VerboseMsg ("FFS File has the fixed file attribute");
916 if ((FfsAttrib
& FFS_ATTRIB_CHECKSUM
) != 0) {
917 VerboseMsg ("FFS File requires the checksum of the whole file");
919 VerboseMsg ("FFS file alignment is %s", mFfsValidAlignName
[FfsAlign
]);
920 for (Index
= 0; Index
< InputFileNum
; Index
++) {
921 if (InputFileAlign
[Index
] == 0) {
923 // Minimum alignment is 1 byte.
925 InputFileAlign
[Index
] = 1;
927 VerboseMsg ("the %dth input section name is %s and section alignment is %u", Index
, InputFileName
[Index
], (unsigned) InputFileAlign
[Index
]);
931 // Calculate the size of all input section files.
933 Status
= GetSectionContents (
944 if ((FfsFiletype
== EFI_FV_FILETYPE_SECURITY_CORE
||
945 FfsFiletype
== EFI_FV_FILETYPE_PEI_CORE
||
946 FfsFiletype
== EFI_FV_FILETYPE_DXE_CORE
) && (PeSectionNum
!= 1)) {
947 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
);
951 if ((FfsFiletype
== EFI_FV_FILETYPE_PEIM
||
952 FfsFiletype
== EFI_FV_FILETYPE_DRIVER
||
953 FfsFiletype
== EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER
||
954 FfsFiletype
== EFI_FV_FILETYPE_APPLICATION
) && (PeSectionNum
< 1)) {
955 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
]);
959 if (Status
== EFI_BUFFER_TOO_SMALL
) {
960 FileBuffer
= (UINT8
*) malloc (FileSize
);
961 if (FileBuffer
== NULL
) {
962 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
965 memset (FileBuffer
, 0, FileSize
);
968 // read all input file contents into a buffer
970 Status
= GetSectionContents (
982 if (EFI_ERROR (Status
)) {
986 if (FileBuffer
== NULL
&& FileSize
!= 0) {
987 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
992 // Create Ffs file header.
994 memset (&FfsFileHeader
, 0, sizeof (EFI_FFS_FILE_HEADER2
));
995 memcpy (&FfsFileHeader
.Name
, &FileGuid
, sizeof (EFI_GUID
));
996 FfsFileHeader
.Type
= FfsFiletype
;
998 // Update FFS Alignment based on the max alignment required by input section files
1000 VerboseMsg ("the max alignment of all input sections is %u", (unsigned) MaxAlignment
);
1001 for (Index
= 0; Index
< sizeof (mFfsValidAlign
) / sizeof (UINT32
) - 1; Index
++) {
1002 if ((MaxAlignment
> mFfsValidAlign
[Index
]) && (MaxAlignment
<= mFfsValidAlign
[Index
+ 1])) {
1006 if (FfsAlign
< Index
) {
1009 VerboseMsg ("the alignment of the generated FFS file is %u", (unsigned) mFfsValidAlign
[FfsAlign
+ 1]);
1012 // Now FileSize includes the EFI_FFS_FILE_HEADER
1014 if (FileSize
+ sizeof (EFI_FFS_FILE_HEADER
) >= MAX_FFS_SIZE
) {
1015 HeaderSize
= sizeof (EFI_FFS_FILE_HEADER2
);
1016 FileSize
+= sizeof (EFI_FFS_FILE_HEADER2
);
1017 FfsFileHeader
.ExtendedSize
= FileSize
;
1018 memset(FfsFileHeader
.Size
, 0, sizeof (UINT8
) * 3);
1019 FfsAttrib
|= FFS_ATTRIB_LARGE_FILE
;
1021 HeaderSize
= sizeof (EFI_FFS_FILE_HEADER
);
1022 FileSize
+= sizeof (EFI_FFS_FILE_HEADER
);
1023 FfsFileHeader
.Size
[0] = (UINT8
) (FileSize
& 0xFF);
1024 FfsFileHeader
.Size
[1] = (UINT8
) ((FileSize
& 0xFF00) >> 8);
1025 FfsFileHeader
.Size
[2] = (UINT8
) ((FileSize
& 0xFF0000) >> 16);
1027 VerboseMsg ("the size of the generated FFS file is %u bytes", (unsigned) FileSize
);
1029 //FfsAlign larger than 7, set FFS_ATTRIB_DATA_ALIGNMENT2
1031 FfsFileHeader
.Attributes
= (EFI_FFS_FILE_ATTRIBUTES
) (FfsAttrib
| (FfsAlign
<< 3));
1033 FfsFileHeader
.Attributes
= (EFI_FFS_FILE_ATTRIBUTES
) (FfsAttrib
| ((FfsAlign
& 0x7) << 3) | FFS_ATTRIB_DATA_ALIGNMENT2
);
1037 // Fill in checksums and state, these must be zero for checksumming
1039 // FileHeader.IntegrityCheck.Checksum.Header = 0;
1040 // FileHeader.IntegrityCheck.Checksum.File = 0;
1041 // FileHeader.State = 0;
1043 FfsFileHeader
.IntegrityCheck
.Checksum
.Header
= CalculateChecksum8 (
1044 (UINT8
*) &FfsFileHeader
,
1048 if (FfsFileHeader
.Attributes
& FFS_ATTRIB_CHECKSUM
) {
1050 // Ffs header checksum = zero, so only need to calculate ffs body.
1052 FfsFileHeader
.IntegrityCheck
.Checksum
.File
= CalculateChecksum8 (
1054 FileSize
- HeaderSize
1057 FfsFileHeader
.IntegrityCheck
.Checksum
.File
= FFS_FIXED_CHECKSUM
;
1060 FfsFileHeader
.State
= EFI_FILE_HEADER_CONSTRUCTION
| EFI_FILE_HEADER_VALID
| EFI_FILE_DATA_VALID
;
1063 // Open output file to write ffs data.
1065 if (OutputFileName
!= NULL
) {
1066 remove(OutputFileName
);
1067 FfsFile
= fopen (LongFilePath (OutputFileName
), "wb");
1068 if (FfsFile
== NULL
) {
1069 Error (NULL
, 0, 0001, "Error opening file", OutputFileName
);
1075 fwrite (&FfsFileHeader
, 1, HeaderSize
, FfsFile
);
1079 if (FileBuffer
!= NULL
) {
1080 fwrite (FileBuffer
, 1, FileSize
- HeaderSize
, FfsFile
);
1087 if (InputFileName
!= NULL
) {
1088 free (InputFileName
);
1090 if (InputFileAlign
!= NULL
) {
1091 free (InputFileAlign
);
1093 if (FileBuffer
!= NULL
) {
1097 // If any errors were reported via the standard error reporting
1098 // routines, then the status has been saved. Get the value and
1099 // return it to the caller.
1101 VerboseMsg ("%s tool done with return code is 0x%x.", UTILITY_NAME
, GetUtilityStatus ());
1103 return GetUtilityStatus ();