2 This file contains functions required to generate a Firmware File System file.
4 Copyright (c) 2004 - 2014, 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
49 STATIC CHAR8
*mAlignName
[] = {
50 "1", "2", "4", "8", "16", "32", "64", "128", "256", "512",
51 "1K", "2K", "4K", "8K", "16K", "32K", "64K"
54 STATIC CHAR8
*mFfsValidAlignName
[] = {
55 "8", "16", "128", "512", "1K", "4K", "32K", "64K"
58 STATIC UINT32 mFfsValidAlign
[] = {0, 8, 16, 128, 512, 1024, 4096, 32768, 65536};
60 STATIC EFI_GUID mZeroGuid
= {0};
62 STATIC EFI_GUID mEfiFfsSectionAlignmentPaddingGuid
= EFI_FFS_SECTION_ALIGNMENT_PADDING_GUID
;
73 Print out version information for this utility.
85 fprintf (stdout
, "%s Version %d.%d %s \n", UTILITY_NAME
, UTILITY_MAJOR_VERSION
, UTILITY_MINOR_VERSION
, __BUILD_VERSION
);
97 Print Error / Help message.
112 fprintf (stdout
, "\nUsage: %s [options]\n\n", UTILITY_NAME
);
115 // Copyright declaration
117 fprintf (stdout
, "Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.\n\n");
122 fprintf (stdout
, "Options:\n");
123 fprintf (stdout
, " -o FileName, --outputfile FileName\n\
124 File is FFS file to be created.\n");
125 fprintf (stdout
, " -t Type, --filetype Type\n\
126 Type is one FV file type defined in PI spec, which is\n\
127 EFI_FV_FILETYPE_RAW, EFI_FV_FILETYPE_FREEFORM,\n\
128 EFI_FV_FILETYPE_SECURITY_CORE, EFI_FV_FILETYPE_PEIM,\n\
129 EFI_FV_FILETYPE_PEI_CORE, EFI_FV_FILETYPE_DXE_CORE,\n\
130 EFI_FV_FILETYPE_DRIVER, EFI_FV_FILETYPE_APPLICATION,\n\
131 EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER,\n\
132 EFI_FV_FILETYPE_SMM, EFI_FV_FILETYPE_SMM_CORE,\n\
133 EFI_FV_FILETYPE_COMBINED_SMM_DXE, \n\
134 EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE.\n");
135 fprintf (stdout
, " -g FileGuid, --fileguid FileGuid\n\
136 FileGuid is one module guid.\n\
137 Its format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n");
138 fprintf (stdout
, " -x, --fixed Indicates that the file may not be moved\n\
139 from its present location.\n");
140 fprintf (stdout
, " -s, --checksum Indicates to calculate file checksum.\n");
141 fprintf (stdout
, " -a FileAlign, --align FileAlign\n\
142 FileAlign points to file alignment, which only support\n\
143 the following align: 1,2,4,8,16,128,512,1K,4K,32K,64K\n");
144 fprintf (stdout
, " -i SectionFile, --sectionfile SectionFile\n\
145 Section file will be contained in this FFS file.\n");
146 fprintf (stdout
, " -n SectionAlign, --sectionalign SectionAlign\n\
147 SectionAlign points to section alignment, which support\n\
148 the alignment scope 1~64K. It is specified together\n\
149 with sectionfile to point its alignment in FFS file.\n");
150 fprintf (stdout
, " -v, --verbose Turn on verbose output with informational messages.\n");
151 fprintf (stdout
, " -q, --quiet Disable all messages except key message and fatal error\n");
152 fprintf (stdout
, " -d, --debug level Enable debug messages, at input debug level.\n");
153 fprintf (stdout
, " --version Show program's version number and exit.\n");
154 fprintf (stdout
, " -h, --help Show this help message and exit.\n");
160 IN CHAR8
*AlignBuffer
,
161 OUT UINT32
*AlignNumber
167 Converts Align String to align value (1~64K).
171 AlignBuffer - Pointer to Align string.
172 AlignNumber - Pointer to Align value.
176 EFI_SUCCESS Successfully convert align string to align value.
177 EFI_INVALID_PARAMETER Align string is invalid or align value is not in scope.
185 if (AlignBuffer
== NULL
) {
186 return EFI_INVALID_PARAMETER
;
188 for (Index
= 0; Index
< sizeof (mAlignName
) / sizeof (CHAR8
*); Index
++) {
189 if (stricmp (AlignBuffer
, mAlignName
[Index
]) == 0) {
190 *AlignNumber
= 1 << Index
;
194 return EFI_INVALID_PARAMETER
;
206 Converts File Type String to value. EFI_FV_FILETYPE_ALL indicates that an
207 unrecognized file type was specified.
211 String - File type string
221 if (String
== NULL
) {
222 return EFI_FV_FILETYPE_ALL
;
225 for (Index
= 0; Index
< sizeof (mFfsFileType
) / sizeof (CHAR8
*); Index
++) {
226 if (mFfsFileType
[Index
] != NULL
&& (stricmp (String
, mFfsFileType
[Index
]) == 0)) {
230 return EFI_FV_FILETYPE_ALL
;
236 IN CHAR8
**InputFileName
,
237 IN UINT32
*InputFileAlign
,
238 IN UINT32 InputFileNum
,
239 IN EFI_FFS_FILE_ATTRIBUTES FfsAttrib
,
240 OUT UINT8
*FileBuffer
,
241 OUT UINT32
*BufferLength
,
242 OUT UINT32
*MaxAlignment
,
243 OUT UINT8
*PESectionNum
249 Get the contents of all section files specified in InputFileName
254 InputFileName - Name of the input file.
256 InputFileAlign - Alignment required by the input file data.
258 InputFileNum - Number of input files. Should be at least 1.
260 FileBuffer - Output buffer to contain data
262 BufferLength - On input, this is size of the FileBuffer.
263 On output, this is the actual length of the data.
265 MaxAlignment - The max alignment required by all the input file datas.
267 PeSectionNum - Calculate the number of Pe/Te Section in this FFS file.
271 EFI_SUCCESS on successful return
272 EFI_INVALID_PARAMETER if InputFileNum is less than 1 or BufferLength point is NULL.
273 EFI_ABORTED if unable to open input file.
274 EFI_BUFFER_TOO_SMALL FileBuffer is not enough to contain all file data.
282 EFI_FREEFORM_SUBTYPE_GUID_SECTION
*SectHeader
;
283 EFI_COMMON_SECTION_HEADER2 TempSectHeader
;
284 EFI_TE_IMAGE_HEADER TeHeader
;
286 EFI_GUID_DEFINED_SECTION GuidSectHeader
;
287 EFI_GUID_DEFINED_SECTION2 GuidSectHeader2
;
289 UINT32 MaxEncounteredAlignment
;
294 MaxEncounteredAlignment
= 1;
297 // Go through our array of file names and copy their contents
298 // to the output buffer.
300 for (Index
= 0; Index
< InputFileNum
; Index
++) {
302 // make sure section ends on a DWORD boundary
304 while ((Size
& 0x03) != 0) {
309 // Open file and read contents
311 InFile
= fopen (LongFilePath (InputFileName
[Index
]), "rb");
312 if (InFile
== NULL
) {
313 Error (NULL
, 0, 0001, "Error opening file", InputFileName
[Index
]);
317 fseek (InFile
, 0, SEEK_END
);
318 FileSize
= ftell (InFile
);
319 fseek (InFile
, 0, SEEK_SET
);
320 DebugMsg (NULL
, 0, 9, "Input section files",
321 "the input section name is %s and the size is %u bytes", InputFileName
[Index
], (unsigned) FileSize
);
324 // Check this section is Te/Pe section, and Calculate the numbers of Te/Pe section.
327 if (FileSize
>= MAX_FFS_SIZE
) {
328 HeaderSize
= sizeof (EFI_COMMON_SECTION_HEADER2
);
330 HeaderSize
= sizeof (EFI_COMMON_SECTION_HEADER
);
332 fread (&TempSectHeader
, 1, HeaderSize
, InFile
);
333 if (TempSectHeader
.Type
== EFI_SECTION_TE
) {
335 fread (&TeHeader
, 1, sizeof (TeHeader
), InFile
);
336 if (TeHeader
.Signature
== EFI_TE_IMAGE_HEADER_SIGNATURE
) {
337 TeOffset
= TeHeader
.StrippedSize
- sizeof (TeHeader
);
339 } else if (TempSectHeader
.Type
== EFI_SECTION_PE32
) {
341 } else if (TempSectHeader
.Type
== EFI_SECTION_GUID_DEFINED
) {
342 fseek (InFile
, 0, SEEK_SET
);
343 if (FileSize
>= MAX_SECTION_SIZE
) {
344 fread (&GuidSectHeader2
, 1, sizeof (GuidSectHeader2
), InFile
);
345 if ((GuidSectHeader2
.Attributes
& EFI_GUIDED_SECTION_PROCESSING_REQUIRED
) == 0) {
346 HeaderSize
= GuidSectHeader2
.DataOffset
;
349 fread (&GuidSectHeader
, 1, sizeof (GuidSectHeader
), InFile
);
350 if ((GuidSectHeader
.Attributes
& EFI_GUIDED_SECTION_PROCESSING_REQUIRED
) == 0) {
351 HeaderSize
= GuidSectHeader
.DataOffset
;
355 } else if (TempSectHeader
.Type
== EFI_SECTION_COMPRESSION
||
356 TempSectHeader
.Type
== EFI_SECTION_FIRMWARE_VOLUME_IMAGE
) {
358 // for the encapsulated section, assume it contains Pe/Te section
363 fseek (InFile
, 0, SEEK_SET
);
366 // Revert TeOffset to the converse value relative to Alignment
367 // This is to assure the original PeImage Header at Alignment.
369 if ((TeOffset
!= 0) && (InputFileAlign
[Index
] != 0)) {
370 TeOffset
= InputFileAlign
[Index
] - (TeOffset
% InputFileAlign
[Index
]);
371 TeOffset
= TeOffset
% InputFileAlign
[Index
];
375 // make sure section data meet its alignment requirement by adding one pad section.
376 // But the different sections have the different section header. Necessary or not?
377 // Based on section type to adjust offset? Todo
379 if ((InputFileAlign
[Index
] != 0) && (((Size
+ HeaderSize
+ TeOffset
) % InputFileAlign
[Index
]) != 0)) {
380 Offset
= (Size
+ sizeof (EFI_COMMON_SECTION_HEADER
) + HeaderSize
+ TeOffset
+ InputFileAlign
[Index
] - 1) & ~(InputFileAlign
[Index
] - 1);
381 Offset
= Offset
- Size
- HeaderSize
- TeOffset
;
383 if (FileBuffer
!= NULL
&& ((Size
+ Offset
) < *BufferLength
)) {
385 // The maximal alignment is 64K, the raw section size must be less than 0xffffff
387 memset (FileBuffer
+ Size
, 0, Offset
);
388 SectHeader
= (EFI_FREEFORM_SUBTYPE_GUID_SECTION
*) (FileBuffer
+ Size
);
389 SectHeader
->CommonHeader
.Size
[0] = (UINT8
) (Offset
& 0xff);
390 SectHeader
->CommonHeader
.Size
[1] = (UINT8
) ((Offset
& 0xff00) >> 8);
391 SectHeader
->CommonHeader
.Size
[2] = (UINT8
) ((Offset
& 0xff0000) >> 16);
394 // Only add a special reducible padding section if
395 // - this FFS has the FFS_ATTRIB_FIXED attribute,
396 // - none of the preceding sections have alignment requirements,
397 // - the size of the padding is sufficient for the
398 // EFI_SECTION_FREEFORM_SUBTYPE_GUID header.
400 if ((FfsAttrib
& FFS_ATTRIB_FIXED
) != 0 &&
401 MaxEncounteredAlignment
<= 1 &&
402 Offset
>= sizeof (EFI_FREEFORM_SUBTYPE_GUID_SECTION
)) {
403 SectHeader
->CommonHeader
.Type
= EFI_SECTION_FREEFORM_SUBTYPE_GUID
;
404 SectHeader
->SubTypeGuid
= mEfiFfsSectionAlignmentPaddingGuid
;
406 SectHeader
->CommonHeader
.Type
= EFI_SECTION_RAW
;
409 DebugMsg (NULL
, 0, 9, "Pad raw section for section data alignment",
410 "Pad Raw section size is %u", (unsigned) Offset
);
412 Size
= Size
+ Offset
;
416 // Get the Max alignment of all input file datas
418 if (MaxEncounteredAlignment
< InputFileAlign
[Index
]) {
419 MaxEncounteredAlignment
= InputFileAlign
[Index
];
423 // Now read the contents of the file into the buffer
424 // Buffer must be enough to contain the file content.
426 if ((FileSize
> 0) && (FileBuffer
!= NULL
) && ((Size
+ FileSize
) <= *BufferLength
)) {
427 if (fread (FileBuffer
+ Size
, (size_t) FileSize
, 1, InFile
) != 1) {
428 Error (NULL
, 0, 0004, "Error reading file", InputFileName
[Index
]);
438 *MaxAlignment
= MaxEncounteredAlignment
;
441 // Set the actual length of the data.
443 if (Size
> *BufferLength
) {
444 *BufferLength
= Size
;
445 return EFI_BUFFER_TOO_SMALL
;
447 *BufferLength
= Size
;
465 argc - Number of command line parameters.
466 argv - Array of pointers to parameter strings.
469 STATUS_SUCCESS - Utility exits successfully.
470 STATUS_ERROR - Some error occurred during execution.
475 EFI_FFS_FILE_ATTRIBUTES FfsAttrib
;
477 EFI_FV_FILETYPE FfsFiletype
;
478 CHAR8
*OutputFileName
;
479 EFI_GUID FileGuid
= {0};
481 UINT32
*InputFileAlign
;
482 CHAR8
**InputFileName
;
486 EFI_FFS_FILE_HEADER2 FfsFileHeader
;
494 // Init local variables
500 FfsFiletype
= EFI_FV_FILETYPE_ALL
;
501 OutputFileName
= NULL
;
503 InputFileName
= NULL
;
504 InputFileAlign
= NULL
;
509 Status
= EFI_SUCCESS
;
512 SetUtilityName (UTILITY_NAME
);
515 Error (NULL
, 0, 1001, "Missing options", "no options input");
521 // Parse command line
526 if ((stricmp (argv
[0], "-h") == 0) || (stricmp (argv
[0], "--help") == 0)) {
529 return STATUS_SUCCESS
;
532 if (stricmp (argv
[0], "--version") == 0) {
534 return STATUS_SUCCESS
;
538 if ((stricmp (argv
[0], "-t") == 0) || (stricmp (argv
[0], "--filetype") == 0)) {
539 if (argv
[1] == NULL
|| argv
[1][0] == '-') {
540 Error (NULL
, 0, 1003, "Invalid option value", "file type is missing for -t option");
543 FfsFiletype
= StringToType (argv
[1]);
544 if (FfsFiletype
== EFI_FV_FILETYPE_ALL
) {
545 Error (NULL
, 0, 1003, "Invalid option value", "%s is not a valid file type", argv
[1]);
553 if ((stricmp (argv
[0], "-o") == 0) || (stricmp (argv
[0], "--outputfile") == 0)) {
554 if (argv
[1] == NULL
|| argv
[1][0] == '-') {
555 Error (NULL
, 0, 1003, "Invalid option value", "Output file is missing for -o option");
558 OutputFileName
= argv
[1];
564 if ((stricmp (argv
[0], "-g") == 0) || (stricmp (argv
[0], "--fileguid") == 0)) {
565 Status
= StringToGuid (argv
[1], &FileGuid
);
566 if (EFI_ERROR (Status
)) {
567 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
575 if ((stricmp (argv
[0], "-x") == 0) || (stricmp (argv
[0], "--fixed") == 0)) {
576 FfsAttrib
|= FFS_ATTRIB_FIXED
;
582 if ((stricmp (argv
[0], "-s") == 0) || (stricmp (argv
[0], "--checksum") == 0)) {
583 FfsAttrib
|= FFS_ATTRIB_CHECKSUM
;
589 if ((stricmp (argv
[0], "-a") == 0) || (stricmp (argv
[0], "--align") == 0)) {
590 if (argv
[1] == NULL
|| argv
[1][0] == '-') {
591 Error (NULL
, 0, 1003, "Invalid option value", "Align value is missing for -a option");
594 for (Index
= 0; Index
< sizeof (mFfsValidAlignName
) / sizeof (CHAR8
*); Index
++) {
595 if (stricmp (argv
[1], mFfsValidAlignName
[Index
]) == 0) {
599 if (Index
== sizeof (mFfsValidAlignName
) / sizeof (CHAR8
*)) {
600 if ((stricmp (argv
[1], "1") == 0) || (stricmp (argv
[1], "2") == 0) || (stricmp (argv
[1], "4") == 0)) {
602 // 1, 2, 4 byte alignment same to 8 byte alignment
606 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
616 if ((stricmp (argv
[0], "-i") == 0) || (stricmp (argv
[0], "--sectionfile") == 0)) {
618 // Get Input file name and its alignment
620 if (argv
[1] == NULL
|| argv
[1][0] == '-') {
621 Error (NULL
, 0, 1003, "Invalid option value", "input section file is missing for -i option");
626 // Allocate Input file name buffer and its alignment buffer.
628 if ((InputFileNum
== 0) && (InputFileName
== NULL
)) {
629 InputFileName
= (CHAR8
**) malloc (MAXIMUM_INPUT_FILE_NUM
* sizeof (CHAR8
*));
630 if (InputFileName
== NULL
) {
631 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
634 memset (InputFileName
, 0, (MAXIMUM_INPUT_FILE_NUM
* sizeof (CHAR8
*)));
636 InputFileAlign
= (UINT32
*) malloc (MAXIMUM_INPUT_FILE_NUM
* sizeof (UINT32
));
637 if (InputFileAlign
== NULL
) {
638 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
639 free (InputFileName
);
642 memset (InputFileAlign
, 0, MAXIMUM_INPUT_FILE_NUM
* sizeof (UINT32
));
643 } else if (InputFileNum
% MAXIMUM_INPUT_FILE_NUM
== 0) {
645 // InputFileName and alignment buffer too small, need to realloc
647 InputFileName
= (CHAR8
**) realloc (
649 (InputFileNum
+ MAXIMUM_INPUT_FILE_NUM
) * sizeof (CHAR8
*)
652 if (InputFileName
== NULL
) {
653 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
654 free (InputFileAlign
);
657 memset (&(InputFileName
[InputFileNum
]), 0, (MAXIMUM_INPUT_FILE_NUM
* sizeof (CHAR8
*)));
659 InputFileAlign
= (UINT32
*) realloc (
661 (InputFileNum
+ MAXIMUM_INPUT_FILE_NUM
) * sizeof (UINT32
)
664 if (InputFileAlign
== NULL
) {
665 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
666 free (InputFileName
);
669 memset (&(InputFileAlign
[InputFileNum
]), 0, (MAXIMUM_INPUT_FILE_NUM
* sizeof (UINT32
)));
672 InputFileName
[InputFileNum
] = argv
[1];
682 // Section File alignment requirement
684 if ((stricmp (argv
[0], "-n") == 0) || (stricmp (argv
[0], "--sectionalign") == 0)) {
685 Status
= StringtoAlignment (argv
[1], &(InputFileAlign
[InputFileNum
]));
686 if (EFI_ERROR (Status
)) {
687 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
697 if ((stricmp (argv
[0], "-n") == 0) || (stricmp (argv
[0], "--sectionalign") == 0)) {
698 Error (NULL
, 0, 1000, "Unknown option", "SectionAlign option must be specified with section file.");
702 if ((stricmp (argv
[0], "-v") == 0) || (stricmp (argv
[0], "--verbose") == 0)) {
703 SetPrintLevel (VERBOSE_LOG_LEVEL
);
704 VerboseMsg ("Verbose output Mode Set!");
710 if ((stricmp (argv
[0], "-q") == 0) || (stricmp (argv
[0], "--quiet") == 0)) {
711 SetPrintLevel (KEY_LOG_LEVEL
);
712 KeyMsg ("Quiet output Mode Set!");
718 if ((stricmp (argv
[0], "-d") == 0) || (stricmp (argv
[0], "--debug") == 0)) {
719 Status
= AsciiStringToUint64 (argv
[1], FALSE
, &LogLevel
);
720 if (EFI_ERROR (Status
)) {
721 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
725 Error (NULL
, 0, 1003, "Invalid option value", "Debug Level range is 0-9, current input level is %d", (int) LogLevel
);
728 SetPrintLevel (LogLevel
);
729 DebugMsg (NULL
, 0, 9, "Debug Mode Set", "Debug Output Mode Level %s is set!", argv
[1]);
735 Error (NULL
, 0, 1000, "Unknown option", argv
[0]);
739 VerboseMsg ("%s tool start.", UTILITY_NAME
);
742 // Check the complete input parameters.
744 if (FfsFiletype
== EFI_FV_FILETYPE_ALL
) {
745 Error (NULL
, 0, 1001, "Missing option", "filetype");
749 if (CompareGuid (&FileGuid
, &mZeroGuid
) == 0) {
750 Error (NULL
, 0, 1001, "Missing option", "fileguid");
754 if (InputFileNum
== 0) {
755 Error (NULL
, 0, 1001, "Missing option", "Input files");
760 // Output input parameter information
762 VerboseMsg ("Fv File type is %s", mFfsFileType
[FfsFiletype
]);
763 VerboseMsg ("Output file name is %s", OutputFileName
);
764 VerboseMsg ("FFS File Guid is %08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",
765 (unsigned) FileGuid
.Data1
,
776 if ((FfsAttrib
& FFS_ATTRIB_FIXED
) != 0) {
777 VerboseMsg ("FFS File has the fixed file attribute");
779 if ((FfsAttrib
& FFS_ATTRIB_CHECKSUM
) != 0) {
780 VerboseMsg ("FFS File requires the checksum of the whole file");
782 VerboseMsg ("FFS file alignment is %s", mFfsValidAlignName
[FfsAlign
]);
783 for (Index
= 0; Index
< InputFileNum
; Index
++) {
784 if (InputFileAlign
[Index
] == 0) {
786 // Minimum alignment is 1 byte.
788 InputFileAlign
[Index
] = 1;
790 VerboseMsg ("the %dth input section name is %s and section alignment is %u", Index
, InputFileName
[Index
], (unsigned) InputFileAlign
[Index
]);
794 // Calculate the size of all input section files.
796 Status
= GetSectionContents (
807 if ((FfsFiletype
== EFI_FV_FILETYPE_SECURITY_CORE
||
808 FfsFiletype
== EFI_FV_FILETYPE_PEI_CORE
||
809 FfsFiletype
== EFI_FV_FILETYPE_DXE_CORE
) && (PeSectionNum
!= 1)) {
810 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
);
814 if ((FfsFiletype
== EFI_FV_FILETYPE_PEIM
||
815 FfsFiletype
== EFI_FV_FILETYPE_DRIVER
||
816 FfsFiletype
== EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER
||
817 FfsFiletype
== EFI_FV_FILETYPE_APPLICATION
) && (PeSectionNum
< 1)) {
818 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
]);
822 if (Status
== EFI_BUFFER_TOO_SMALL
) {
823 FileBuffer
= (UINT8
*) malloc (FileSize
);
824 if (FileBuffer
== NULL
) {
825 Error (NULL
, 0, 4001, "Resource", "memory cannot be allocated!");
828 memset (FileBuffer
, 0, FileSize
);
831 // read all input file contents into a buffer
833 Status
= GetSectionContents (
845 if (EFI_ERROR (Status
)) {
850 // Create Ffs file header.
852 memset (&FfsFileHeader
, 0, sizeof (EFI_FFS_FILE_HEADER2
));
853 memcpy (&FfsFileHeader
.Name
, &FileGuid
, sizeof (EFI_GUID
));
854 FfsFileHeader
.Type
= FfsFiletype
;
856 // Update FFS Alignment based on the max alignment required by input section files
858 VerboseMsg ("the max alignment of all input sections is %u", (unsigned) MaxAlignment
);
859 for (Index
= 0; Index
< sizeof (mFfsValidAlign
) / sizeof (UINT32
) - 1; Index
++) {
860 if ((MaxAlignment
> mFfsValidAlign
[Index
]) && (MaxAlignment
<= mFfsValidAlign
[Index
+ 1])) {
864 if (FfsAlign
< Index
) {
867 VerboseMsg ("the alignment of the generated FFS file is %u", (unsigned) mFfsValidAlign
[FfsAlign
+ 1]);
870 // Now FileSize includes the EFI_FFS_FILE_HEADER
872 if (FileSize
+ sizeof (EFI_FFS_FILE_HEADER
) >= MAX_FFS_SIZE
) {
873 HeaderSize
= sizeof (EFI_FFS_FILE_HEADER2
);
874 FileSize
+= sizeof (EFI_FFS_FILE_HEADER2
);
875 FfsFileHeader
.ExtendedSize
= FileSize
;
876 memset(FfsFileHeader
.Size
, 0, sizeof (UINT8
) * 3);
877 FfsAttrib
|= FFS_ATTRIB_LARGE_FILE
;
879 HeaderSize
= sizeof (EFI_FFS_FILE_HEADER
);
880 FileSize
+= sizeof (EFI_FFS_FILE_HEADER
);
881 FfsFileHeader
.Size
[0] = (UINT8
) (FileSize
& 0xFF);
882 FfsFileHeader
.Size
[1] = (UINT8
) ((FileSize
& 0xFF00) >> 8);
883 FfsFileHeader
.Size
[2] = (UINT8
) ((FileSize
& 0xFF0000) >> 16);
885 VerboseMsg ("the size of the generated FFS file is %u bytes", (unsigned) FileSize
);
887 FfsFileHeader
.Attributes
= (EFI_FFS_FILE_ATTRIBUTES
) (FfsAttrib
| (FfsAlign
<< 3));
890 // Fill in checksums and state, these must be zero for checksumming
892 // FileHeader.IntegrityCheck.Checksum.Header = 0;
893 // FileHeader.IntegrityCheck.Checksum.File = 0;
894 // FileHeader.State = 0;
896 FfsFileHeader
.IntegrityCheck
.Checksum
.Header
= CalculateChecksum8 (
897 (UINT8
*) &FfsFileHeader
,
901 if (FfsFileHeader
.Attributes
& FFS_ATTRIB_CHECKSUM
) {
903 // Ffs header checksum = zero, so only need to calculate ffs body.
905 FfsFileHeader
.IntegrityCheck
.Checksum
.File
= CalculateChecksum8 (
907 FileSize
- HeaderSize
910 FfsFileHeader
.IntegrityCheck
.Checksum
.File
= FFS_FIXED_CHECKSUM
;
913 FfsFileHeader
.State
= EFI_FILE_HEADER_CONSTRUCTION
| EFI_FILE_HEADER_VALID
| EFI_FILE_DATA_VALID
;
916 // Open output file to write ffs data.
918 remove(OutputFileName
);
919 FfsFile
= fopen (LongFilePath (OutputFileName
), "wb");
920 if (FfsFile
== NULL
) {
921 Error (NULL
, 0, 0001, "Error opening file", OutputFileName
);
927 fwrite (&FfsFileHeader
, 1, HeaderSize
, FfsFile
);
931 fwrite (FileBuffer
, 1, FileSize
- HeaderSize
, FfsFile
);
936 if (InputFileName
!= NULL
) {
937 free (InputFileName
);
939 if (InputFileAlign
!= NULL
) {
940 free (InputFileAlign
);
942 if (FileBuffer
!= NULL
) {
946 // If any errors were reported via the standard error reporting
947 // routines, then the status has been saved. Get the value and
948 // return it to the caller.
950 VerboseMsg ("%s tool done with return code is 0x%x.", UTILITY_NAME
, GetUtilityStatus ());
952 return GetUtilityStatus ();