]> git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/C/GenFfs/GenFfs.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
BaseTools: align ERROR/WARNING/RETURN macros with MdePkg versions
[mirror_edk2.git] / BaseTools / Source / C / GenFfs / GenFfs.c
1 /** @file
2 This file contains functions required to generate a Firmware File System file.
3
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
9
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.
12
13 **/
14
15 #ifndef __GNUC__
16 #include <windows.h>
17 #include <io.h>
18 #include <sys/types.h>
19 #include <sys/stat.h>
20 #endif
21
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25
26 #include <Common/UefiBaseTypes.h>
27 #include <Common/PiFirmwareFile.h>
28 #include <IndustryStandard/PeImage.h>
29 #include <Guid/FfsSectionAlignmentPadding.h>
30
31 #include "CommonLib.h"
32 #include "ParseInf.h"
33 #include "EfiUtilityMsgs.h"
34 #include "FvLib.h"
35 #include "PeCoffLib.h"
36
37 #define UTILITY_NAME "GenFfs"
38 #define UTILITY_MAJOR_VERSION 0
39 #define UTILITY_MINOR_VERSION 1
40
41 STATIC CHAR8 *mFfsFileType[] = {
42 NULL, // 0x00
43 "EFI_FV_FILETYPE_RAW", // 0x01
44 "EFI_FV_FILETYPE_FREEFORM", // 0x02
45 "EFI_FV_FILETYPE_SECURITY_CORE", // 0x03
46 "EFI_FV_FILETYPE_PEI_CORE", // 0x04
47 "EFI_FV_FILETYPE_DXE_CORE", // 0x05
48 "EFI_FV_FILETYPE_PEIM", // 0x06
49 "EFI_FV_FILETYPE_DRIVER", // 0x07
50 "EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER", // 0x08
51 "EFI_FV_FILETYPE_APPLICATION", // 0x09
52 "EFI_FV_FILETYPE_SMM", // 0x0A
53 "EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE",// 0x0B
54 "EFI_FV_FILETYPE_COMBINED_SMM_DXE", // 0x0C
55 "EFI_FV_FILETYPE_SMM_CORE", // 0x0D
56 "EFI_FV_FILETYPE_MM_STANDALONE", // 0x0E
57 "EFI_FV_FILETYPE_MM_CORE_STANDALONE" // 0x0F
58 };
59
60 STATIC CHAR8 *mAlignName[] = {
61 "1", "2", "4", "8", "16", "32", "64", "128", "256", "512",
62 "1K", "2K", "4K", "8K", "16K", "32K", "64K", "128K", "256K",
63 "512K", "1M", "2M", "4M", "8M", "16M"
64 };
65
66 STATIC CHAR8 *mFfsValidAlignName[] = {
67 "8", "16", "128", "512", "1K", "4K", "32K", "64K", "128K","256K",
68 "512K", "1M", "2M", "4M", "8M", "16M"
69 };
70
71 STATIC UINT32 mFfsValidAlign[] = {0, 8, 16, 128, 512, 1024, 4096, 32768, 65536, 131072, 262144,
72 524288, 1048576, 2097152, 4194304, 8388608, 16777216};
73
74 STATIC EFI_GUID mZeroGuid = {0};
75
76 STATIC EFI_GUID mEfiFfsSectionAlignmentPaddingGuid = EFI_FFS_SECTION_ALIGNMENT_PADDING_GUID;
77
78 STATIC
79 VOID
80 Version (
81 VOID
82 )
83 /*++
84
85 Routine Description:
86
87 Print out version information for this utility.
88
89 Arguments:
90
91 None
92
93 Returns:
94
95 None
96
97 --*/
98 {
99 fprintf (stdout, "%s Version %d.%d %s \n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION);
100 }
101
102 STATIC
103 VOID
104 Usage (
105 VOID
106 )
107 /*++
108
109 Routine Description:
110
111 Print Error / Help message.
112
113 Arguments:
114
115 VOID
116
117 Returns:
118
119 None
120
121 --*/
122 {
123 //
124 // Summary usage
125 //
126 fprintf (stdout, "\nUsage: %s [options]\n\n", UTILITY_NAME);
127
128 //
129 // Copyright declaration
130 //
131 fprintf (stdout, "Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.\n\n");
132
133 //
134 // Details Option
135 //
136 fprintf (stdout, "Options:\n");
137 fprintf (stdout, " -o FileName, --outputfile FileName\n\
138 File is FFS file to be created.\n");
139 fprintf (stdout, " -t Type, --filetype Type\n\
140 Type is one FV file type defined in PI spec, which is\n\
141 EFI_FV_FILETYPE_RAW, EFI_FV_FILETYPE_FREEFORM,\n\
142 EFI_FV_FILETYPE_SECURITY_CORE, EFI_FV_FILETYPE_PEIM,\n\
143 EFI_FV_FILETYPE_PEI_CORE, EFI_FV_FILETYPE_DXE_CORE,\n\
144 EFI_FV_FILETYPE_DRIVER, EFI_FV_FILETYPE_APPLICATION,\n\
145 EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER,\n\
146 EFI_FV_FILETYPE_SMM, EFI_FV_FILETYPE_SMM_CORE,\n\
147 EFI_FV_FILETYPE_MM_STANDALONE,\n\
148 EFI_FV_FILETYPE_MM_CORE_STANDALONE,\n\
149 EFI_FV_FILETYPE_COMBINED_SMM_DXE, \n\
150 EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE.\n");
151 fprintf (stdout, " -g FileGuid, --fileguid FileGuid\n\
152 FileGuid is one module guid.\n\
153 Its format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n");
154 fprintf (stdout, " -x, --fixed Indicates that the file may not be moved\n\
155 from its present location.\n");
156 fprintf (stdout, " -s, --checksum Indicates to calculate file checksum.\n");
157 fprintf (stdout, " -a FileAlign, --align FileAlign\n\
158 FileAlign points to file alignment, which only support\n\
159 the following align: 1,2,4,8,16,128,512,1K,4K,32K,64K\n\
160 128K,256K,512K,1M,2M,4M,8M,16M\n");
161 fprintf (stdout, " -i SectionFile, --sectionfile SectionFile\n\
162 Section file will be contained in this FFS file.\n");
163 fprintf (stdout, " -n SectionAlign, --sectionalign SectionAlign\n\
164 SectionAlign points to section alignment, which support\n\
165 the alignment scope 0~16M. If SectionAlign is specified\n\
166 as 0, tool get alignment value from SectionFile. It is\n\
167 specified together with sectionfile to point its\n\
168 alignment in FFS file.\n");
169 fprintf (stdout, " -v, --verbose Turn on verbose output with informational messages.\n");
170 fprintf (stdout, " -q, --quiet Disable all messages except key message and fatal error\n");
171 fprintf (stdout, " -d, --debug level Enable debug messages, at input debug level.\n");
172 fprintf (stdout, " --version Show program's version number and exit.\n");
173 fprintf (stdout, " -h, --help Show this help message and exit.\n");
174 }
175
176 STATIC
177 EFI_STATUS
178 StringtoAlignment (
179 IN CHAR8 *AlignBuffer,
180 OUT UINT32 *AlignNumber
181 )
182 /*++
183
184 Routine Description:
185
186 Converts Align String to align value (1~16M).
187
188 Arguments:
189
190 AlignBuffer - Pointer to Align string.
191 AlignNumber - Pointer to Align value.
192
193 Returns:
194
195 EFI_SUCCESS Successfully convert align string to align value.
196 EFI_INVALID_PARAMETER Align string is invalid or align value is not in scope.
197
198 --*/
199 {
200 UINT32 Index = 0;
201 //
202 // Check AlignBuffer
203 //
204 if (AlignBuffer == NULL) {
205 return EFI_INVALID_PARAMETER;
206 }
207 for (Index = 0; Index < sizeof (mAlignName) / sizeof (CHAR8 *); Index ++) {
208 if (stricmp (AlignBuffer, mAlignName [Index]) == 0) {
209 *AlignNumber = 1 << Index;
210 return EFI_SUCCESS;
211 }
212 }
213 return EFI_INVALID_PARAMETER;
214 }
215
216 STATIC
217 UINT8
218 StringToType (
219 IN CHAR8 *String
220 )
221 /*++
222
223 Routine Description:
224
225 Converts File Type String to value. EFI_FV_FILETYPE_ALL indicates that an
226 unrecognized file type was specified.
227
228 Arguments:
229
230 String - File type string
231
232 Returns:
233
234 File Type Value
235
236 --*/
237 {
238 UINT8 Index = 0;
239
240 if (String == NULL) {
241 return EFI_FV_FILETYPE_ALL;
242 }
243
244 for (Index = 0; Index < sizeof (mFfsFileType) / sizeof (CHAR8 *); Index ++) {
245 if (mFfsFileType [Index] != NULL && (stricmp (String, mFfsFileType [Index]) == 0)) {
246 return Index;
247 }
248 }
249 return EFI_FV_FILETYPE_ALL;
250 }
251
252 STATIC
253 EFI_STATUS
254 GetSectionContents (
255 IN CHAR8 **InputFileName,
256 IN UINT32 *InputFileAlign,
257 IN UINT32 InputFileNum,
258 IN EFI_FFS_FILE_ATTRIBUTES FfsAttrib,
259 OUT UINT8 *FileBuffer,
260 OUT UINT32 *BufferLength,
261 OUT UINT32 *MaxAlignment,
262 OUT UINT8 *PESectionNum
263 )
264 /*++
265
266 Routine Description:
267
268 Get the contents of all section files specified in InputFileName
269 into FileBuffer.
270
271 Arguments:
272
273 InputFileName - Name of the input file.
274
275 InputFileAlign - Alignment required by the input file data.
276
277 InputFileNum - Number of input files. Should be at least 1.
278
279 FileBuffer - Output buffer to contain data
280
281 BufferLength - On input, this is size of the FileBuffer.
282 On output, this is the actual length of the data.
283
284 MaxAlignment - The max alignment required by all the input file datas.
285
286 PeSectionNum - Calculate the number of Pe/Te Section in this FFS file.
287
288 Returns:
289
290 EFI_SUCCESS on successful return
291 EFI_INVALID_PARAMETER if InputFileNum is less than 1 or BufferLength point is NULL.
292 EFI_ABORTED if unable to open input file.
293 EFI_BUFFER_TOO_SMALL FileBuffer is not enough to contain all file data.
294 --*/
295 {
296 UINT32 Size;
297 UINT32 Offset;
298 UINT32 FileSize;
299 UINT32 Index;
300 FILE *InFile;
301 EFI_FREEFORM_SUBTYPE_GUID_SECTION *SectHeader;
302 EFI_COMMON_SECTION_HEADER2 TempSectHeader;
303 EFI_TE_IMAGE_HEADER TeHeader;
304 UINT32 TeOffset;
305 EFI_GUID_DEFINED_SECTION GuidSectHeader;
306 EFI_GUID_DEFINED_SECTION2 GuidSectHeader2;
307 UINT32 HeaderSize;
308 UINT32 MaxEncounteredAlignment;
309
310 Size = 0;
311 Offset = 0;
312 TeOffset = 0;
313 MaxEncounteredAlignment = 1;
314
315 //
316 // Go through our array of file names and copy their contents
317 // to the output buffer.
318 //
319 for (Index = 0; Index < InputFileNum; Index++) {
320 //
321 // make sure section ends on a DWORD boundary
322 //
323 while ((Size & 0x03) != 0) {
324 Size++;
325 }
326
327 //
328 // Open file and read contents
329 //
330 InFile = fopen (LongFilePath (InputFileName[Index]), "rb");
331 if (InFile == NULL) {
332 Error (NULL, 0, 0001, "Error opening file", InputFileName[Index]);
333 return EFI_ABORTED;
334 }
335
336 fseek (InFile, 0, SEEK_END);
337 FileSize = ftell (InFile);
338 fseek (InFile, 0, SEEK_SET);
339 DebugMsg (NULL, 0, 9, "Input section files",
340 "the input section name is %s and the size is %u bytes", InputFileName[Index], (unsigned) FileSize);
341
342 //
343 // Check this section is Te/Pe section, and Calculate the numbers of Te/Pe section.
344 //
345 TeOffset = 0;
346 if (FileSize >= MAX_FFS_SIZE) {
347 HeaderSize = sizeof (EFI_COMMON_SECTION_HEADER2);
348 } else {
349 HeaderSize = sizeof (EFI_COMMON_SECTION_HEADER);
350 }
351 fread (&TempSectHeader, 1, HeaderSize, InFile);
352 if (TempSectHeader.Type == EFI_SECTION_TE) {
353 (*PESectionNum) ++;
354 fread (&TeHeader, 1, sizeof (TeHeader), InFile);
355 if (TeHeader.Signature == EFI_TE_IMAGE_HEADER_SIGNATURE) {
356 TeOffset = TeHeader.StrippedSize - sizeof (TeHeader);
357 }
358 } else if (TempSectHeader.Type == EFI_SECTION_PE32) {
359 (*PESectionNum) ++;
360 } else if (TempSectHeader.Type == EFI_SECTION_GUID_DEFINED) {
361 fseek (InFile, 0, SEEK_SET);
362 if (FileSize >= MAX_SECTION_SIZE) {
363 fread (&GuidSectHeader2, 1, sizeof (GuidSectHeader2), InFile);
364 if ((GuidSectHeader2.Attributes & EFI_GUIDED_SECTION_PROCESSING_REQUIRED) == 0) {
365 HeaderSize = GuidSectHeader2.DataOffset;
366 }
367 } else {
368 fread (&GuidSectHeader, 1, sizeof (GuidSectHeader), InFile);
369 if ((GuidSectHeader.Attributes & EFI_GUIDED_SECTION_PROCESSING_REQUIRED) == 0) {
370 HeaderSize = GuidSectHeader.DataOffset;
371 }
372 }
373 (*PESectionNum) ++;
374 } else if (TempSectHeader.Type == EFI_SECTION_COMPRESSION ||
375 TempSectHeader.Type == EFI_SECTION_FIRMWARE_VOLUME_IMAGE) {
376 //
377 // for the encapsulated section, assume it contains Pe/Te section
378 //
379 (*PESectionNum) ++;
380 }
381
382 fseek (InFile, 0, SEEK_SET);
383
384 //
385 // Revert TeOffset to the converse value relative to Alignment
386 // This is to assure the original PeImage Header at Alignment.
387 //
388 if ((TeOffset != 0) && (InputFileAlign [Index] != 0)) {
389 TeOffset = InputFileAlign [Index] - (TeOffset % InputFileAlign [Index]);
390 TeOffset = TeOffset % InputFileAlign [Index];
391 }
392
393 //
394 // make sure section data meet its alignment requirement by adding one pad section.
395 // But the different sections have the different section header. Necessary or not?
396 // Based on section type to adjust offset? Todo
397 //
398 if ((InputFileAlign [Index] != 0) && (((Size + HeaderSize + TeOffset) % InputFileAlign [Index]) != 0)) {
399 Offset = (Size + sizeof (EFI_COMMON_SECTION_HEADER) + HeaderSize + TeOffset + InputFileAlign [Index] - 1) & ~(InputFileAlign [Index] - 1);
400 Offset = Offset - Size - HeaderSize - TeOffset;
401
402 if (FileBuffer != NULL && ((Size + Offset) < *BufferLength)) {
403 //
404 // The maximal alignment is 64K, the raw section size must be less than 0xffffff
405 //
406 memset (FileBuffer + Size, 0, Offset);
407 SectHeader = (EFI_FREEFORM_SUBTYPE_GUID_SECTION *) (FileBuffer + Size);
408 SectHeader->CommonHeader.Size[0] = (UINT8) (Offset & 0xff);
409 SectHeader->CommonHeader.Size[1] = (UINT8) ((Offset & 0xff00) >> 8);
410 SectHeader->CommonHeader.Size[2] = (UINT8) ((Offset & 0xff0000) >> 16);
411
412 //
413 // Only add a special reducible padding section if
414 // - this FFS has the FFS_ATTRIB_FIXED attribute,
415 // - none of the preceding sections have alignment requirements,
416 // - the size of the padding is sufficient for the
417 // EFI_SECTION_FREEFORM_SUBTYPE_GUID header.
418 //
419 if ((FfsAttrib & FFS_ATTRIB_FIXED) != 0 &&
420 MaxEncounteredAlignment <= 1 &&
421 Offset >= sizeof (EFI_FREEFORM_SUBTYPE_GUID_SECTION)) {
422 SectHeader->CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID;
423 SectHeader->SubTypeGuid = mEfiFfsSectionAlignmentPaddingGuid;
424 } else {
425 SectHeader->CommonHeader.Type = EFI_SECTION_RAW;
426 }
427 }
428 DebugMsg (NULL, 0, 9, "Pad raw section for section data alignment",
429 "Pad Raw section size is %u", (unsigned) Offset);
430
431 Size = Size + Offset;
432 }
433
434 //
435 // Get the Max alignment of all input file datas
436 //
437 if (MaxEncounteredAlignment < InputFileAlign [Index]) {
438 MaxEncounteredAlignment = InputFileAlign [Index];
439 }
440
441 //
442 // Now read the contents of the file into the buffer
443 // Buffer must be enough to contain the file content.
444 //
445 if ((FileSize > 0) && (FileBuffer != NULL) && ((Size + FileSize) <= *BufferLength)) {
446 if (fread (FileBuffer + Size, (size_t) FileSize, 1, InFile) != 1) {
447 Error (NULL, 0, 0004, "Error reading file", InputFileName[Index]);
448 fclose (InFile);
449 return EFI_ABORTED;
450 }
451 }
452
453 fclose (InFile);
454 Size += FileSize;
455 }
456
457 *MaxAlignment = MaxEncounteredAlignment;
458
459 //
460 // Set the actual length of the data.
461 //
462 if (Size > *BufferLength) {
463 *BufferLength = Size;
464 return EFI_BUFFER_TOO_SMALL;
465 } else {
466 *BufferLength = Size;
467 return EFI_SUCCESS;
468 }
469 }
470
471 EFI_STATUS
472 FfsRebaseImageRead (
473 IN VOID *FileHandle,
474 IN UINTN FileOffset,
475 IN OUT UINT32 *ReadSize,
476 OUT VOID *Buffer
477 )
478 /*++
479
480 Routine Description:
481
482 Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
483
484 Arguments:
485
486 FileHandle - The handle to the PE/COFF file
487
488 FileOffset - The offset, in bytes, into the file to read
489
490 ReadSize - The number of bytes to read from the file starting at FileOffset
491
492 Buffer - A pointer to the buffer to read the data into.
493
494 Returns:
495
496 EFI_SUCCESS - ReadSize bytes of data were read into Buffer from the PE/COFF file starting at FileOffset
497
498 --*/
499 {
500 CHAR8 *Destination8;
501 CHAR8 *Source8;
502 UINT32 Length;
503
504 Destination8 = Buffer;
505 Source8 = (CHAR8 *) ((UINTN) FileHandle + FileOffset);
506 Length = *ReadSize;
507 while (Length--) {
508 *(Destination8++) = *(Source8++);
509 }
510
511 return EFI_SUCCESS;
512 }
513
514 STATIC
515 EFI_STATUS
516 GetAlignmentFromFile(char *InFile, UINT32 *Alignment)
517 /*++
518 InFile is input file for getting alignment
519 return the alignment
520 --*/
521 {
522 FILE *InFileHandle;
523 UINT8 *PeFileBuffer;
524 UINTN PeFileSize;
525 UINT32 CurSecHdrSize;
526 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;
527 EFI_COMMON_SECTION_HEADER *CommonHeader;
528 EFI_STATUS Status;
529
530 InFileHandle = NULL;
531 PeFileBuffer = NULL;
532 *Alignment = 0;
533
534 memset (&ImageContext, 0, sizeof (ImageContext));
535
536 InFileHandle = fopen(LongFilePath(InFile), "rb");
537 if (InFileHandle == NULL){
538 Error (NULL, 0, 0001, "Error opening file", InFile);
539 return EFI_ABORTED;
540 }
541 PeFileSize = _filelength (fileno(InFileHandle));
542 PeFileBuffer = (UINT8 *) malloc (PeFileSize);
543 if (PeFileBuffer == NULL) {
544 fclose (InFileHandle);
545 Error(NULL, 0, 4001, "Resource", "memory cannot be allocated of %s", InFileHandle);
546 return EFI_OUT_OF_RESOURCES;
547 }
548 fread (PeFileBuffer, sizeof (UINT8), PeFileSize, InFileHandle);
549 fclose (InFileHandle);
550 CommonHeader = (EFI_COMMON_SECTION_HEADER *) PeFileBuffer;
551 CurSecHdrSize = GetSectionHeaderLength(CommonHeader);
552 ImageContext.Handle = (VOID *) ((UINTN)PeFileBuffer + CurSecHdrSize);
553 ImageContext.ImageRead = (PE_COFF_LOADER_READ_FILE)FfsRebaseImageRead;
554 Status = PeCoffLoaderGetImageInfo(&ImageContext);
555 if (EFI_ERROR (Status)) {
556 Error (NULL, 0, 3000, "Invalid PeImage", "The input file is %s and return status is %x", InFile, (int) Status);
557 return Status;
558 }
559 *Alignment = ImageContext.SectionAlignment;
560 // Free the allocated memory resource
561 if (PeFileBuffer != NULL) {
562 free (PeFileBuffer);
563 PeFileBuffer = NULL;
564 }
565 return EFI_SUCCESS;
566 }
567
568 int
569 main (
570 int argc,
571 CHAR8 *argv[]
572 )
573 /*++
574
575 Routine Description:
576
577 Main function.
578
579 Arguments:
580
581 argc - Number of command line parameters.
582 argv - Array of pointers to parameter strings.
583
584 Returns:
585 STATUS_SUCCESS - Utility exits successfully.
586 STATUS_ERROR - Some error occurred during execution.
587
588 --*/
589 {
590 EFI_STATUS Status;
591 EFI_FFS_FILE_ATTRIBUTES FfsAttrib;
592 UINT32 FfsAlign;
593 EFI_FV_FILETYPE FfsFiletype;
594 CHAR8 *OutputFileName;
595 EFI_GUID FileGuid = {0};
596 UINT32 InputFileNum;
597 UINT32 *InputFileAlign;
598 CHAR8 **InputFileName;
599 UINT8 *FileBuffer;
600 UINT32 FileSize;
601 UINT32 MaxAlignment;
602 EFI_FFS_FILE_HEADER2 FfsFileHeader;
603 FILE *FfsFile;
604 UINT32 Index;
605 UINT64 LogLevel;
606 UINT8 PeSectionNum;
607 UINT32 HeaderSize;
608 UINT32 Alignment;
609 CHAR8 AlignmentBuffer[8];
610
611 //
612 // Init local variables
613 //
614 LogLevel = 0;
615 Index = 0;
616 FfsAttrib = 0;
617 FfsAlign = 0;
618 FfsFiletype = EFI_FV_FILETYPE_ALL;
619 OutputFileName = NULL;
620 InputFileNum = 0;
621 InputFileName = NULL;
622 InputFileAlign = NULL;
623 FileBuffer = NULL;
624 FileSize = 0;
625 MaxAlignment = 1;
626 FfsFile = NULL;
627 Status = EFI_SUCCESS;
628 PeSectionNum = 0;
629
630 SetUtilityName (UTILITY_NAME);
631
632 if (argc == 1) {
633 Error (NULL, 0, 1001, "Missing options", "no options input");
634 Usage ();
635 return STATUS_ERROR;
636 }
637
638 //
639 // Parse command line
640 //
641 argc --;
642 argv ++;
643
644 if ((stricmp (argv[0], "-h") == 0) || (stricmp (argv[0], "--help") == 0)) {
645 Version ();
646 Usage ();
647 return STATUS_SUCCESS;
648 }
649
650 if (stricmp (argv[0], "--version") == 0) {
651 Version ();
652 return STATUS_SUCCESS;
653 }
654
655 while (argc > 0) {
656 if ((stricmp (argv[0], "-t") == 0) || (stricmp (argv[0], "--filetype") == 0)) {
657 if (argv[1] == NULL || argv[1][0] == '-') {
658 Error (NULL, 0, 1003, "Invalid option value", "file type is missing for -t option");
659 goto Finish;
660 }
661 FfsFiletype = StringToType (argv[1]);
662 if (FfsFiletype == EFI_FV_FILETYPE_ALL) {
663 Error (NULL, 0, 1003, "Invalid option value", "%s is not a valid file type", argv[1]);
664 goto Finish;
665 }
666 argc -= 2;
667 argv += 2;
668 continue;
669 }
670
671 if ((stricmp (argv[0], "-o") == 0) || (stricmp (argv[0], "--outputfile") == 0)) {
672 if (argv[1] == NULL || argv[1][0] == '-') {
673 Error (NULL, 0, 1003, "Invalid option value", "Output file is missing for -o option");
674 goto Finish;
675 }
676 OutputFileName = argv[1];
677 argc -= 2;
678 argv += 2;
679 continue;
680 }
681
682 if ((stricmp (argv[0], "-g") == 0) || (stricmp (argv[0], "--fileguid") == 0)) {
683 Status = StringToGuid (argv[1], &FileGuid);
684 if (EFI_ERROR (Status)) {
685 Error (NULL, 0, 1003, "Invalid option value", "%s = %s", argv[0], argv[1]);
686 goto Finish;
687 }
688 argc -= 2;
689 argv += 2;
690 continue;
691 }
692
693 if ((stricmp (argv[0], "-x") == 0) || (stricmp (argv[0], "--fixed") == 0)) {
694 FfsAttrib |= FFS_ATTRIB_FIXED;
695 argc -= 1;
696 argv += 1;
697 continue;
698 }
699
700 if ((stricmp (argv[0], "-s") == 0) || (stricmp (argv[0], "--checksum") == 0)) {
701 FfsAttrib |= FFS_ATTRIB_CHECKSUM;
702 argc -= 1;
703 argv += 1;
704 continue;
705 }
706
707 if ((stricmp (argv[0], "-a") == 0) || (stricmp (argv[0], "--align") == 0)) {
708 if (argv[1] == NULL || argv[1][0] == '-') {
709 Error (NULL, 0, 1003, "Invalid option value", "Align value is missing for -a option");
710 goto Finish;
711 }
712 for (Index = 0; Index < sizeof (mFfsValidAlignName) / sizeof (CHAR8 *); Index ++) {
713 if (stricmp (argv[1], mFfsValidAlignName[Index]) == 0) {
714 break;
715 }
716 }
717 if (Index == sizeof (mFfsValidAlignName) / sizeof (CHAR8 *)) {
718 if ((stricmp (argv[1], "1") == 0) || (stricmp (argv[1], "2") == 0) || (stricmp (argv[1], "4") == 0)) {
719 //
720 // 1, 2, 4 byte alignment same to 8 byte alignment
721 //
722 Index = 0;
723 } else {
724 Error (NULL, 0, 1003, "Invalid option value", "%s = %s", argv[0], argv[1]);
725 goto Finish;
726 }
727 }
728 FfsAlign = Index;
729 argc -= 2;
730 argv += 2;
731 continue;
732 }
733
734 if ((stricmp (argv[0], "-i") == 0) || (stricmp (argv[0], "--sectionfile") == 0)) {
735 //
736 // Get Input file name and its alignment
737 //
738 if (argv[1] == NULL || argv[1][0] == '-') {
739 Error (NULL, 0, 1003, "Invalid option value", "input section file is missing for -i option");
740 goto Finish;
741 }
742
743 //
744 // Allocate Input file name buffer and its alignment buffer.
745 //
746 if ((InputFileNum == 0) && (InputFileName == NULL)) {
747 InputFileName = (CHAR8 **) malloc (MAXIMUM_INPUT_FILE_NUM * sizeof (CHAR8 *));
748 if (InputFileName == NULL) {
749 Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");
750 return STATUS_ERROR;
751 }
752 memset (InputFileName, 0, (MAXIMUM_INPUT_FILE_NUM * sizeof (CHAR8 *)));
753
754 InputFileAlign = (UINT32 *) malloc (MAXIMUM_INPUT_FILE_NUM * sizeof (UINT32));
755 if (InputFileAlign == NULL) {
756 Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");
757 free (InputFileName);
758 return STATUS_ERROR;
759 }
760 memset (InputFileAlign, 0, MAXIMUM_INPUT_FILE_NUM * sizeof (UINT32));
761 } else if (InputFileNum % MAXIMUM_INPUT_FILE_NUM == 0) {
762 //
763 // InputFileName and alignment buffer too small, need to realloc
764 //
765 InputFileName = (CHAR8 **) realloc (
766 InputFileName,
767 (InputFileNum + MAXIMUM_INPUT_FILE_NUM) * sizeof (CHAR8 *)
768 );
769
770 if (InputFileName == NULL) {
771 Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");
772 free (InputFileAlign);
773 return STATUS_ERROR;
774 }
775 memset (&(InputFileName[InputFileNum]), 0, (MAXIMUM_INPUT_FILE_NUM * sizeof (CHAR8 *)));
776
777 InputFileAlign = (UINT32 *) realloc (
778 InputFileAlign,
779 (InputFileNum + MAXIMUM_INPUT_FILE_NUM) * sizeof (UINT32)
780 );
781
782 if (InputFileAlign == NULL) {
783 Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");
784 free (InputFileName);
785 return STATUS_ERROR;
786 }
787 memset (&(InputFileAlign[InputFileNum]), 0, (MAXIMUM_INPUT_FILE_NUM * sizeof (UINT32)));
788 }
789
790 InputFileName[InputFileNum] = argv[1];
791 argc -= 2;
792 argv += 2;
793
794 if (argc <= 0) {
795 InputFileNum ++;
796 break;
797 }
798
799 //
800 // Section File alignment requirement
801 //
802 if ((stricmp (argv[0], "-n") == 0) || (stricmp (argv[0], "--sectionalign") == 0)) {
803 if ((argv[1] != NULL) && (stricmp("0", argv[1]) == 0)) {
804 Status = GetAlignmentFromFile(InputFileName[InputFileNum], &Alignment);
805 if (EFI_ERROR(Status)) {
806 Error (NULL, 0, 1003, "Fail to get Alignment from %s", InputFileName[InputFileNum]);
807 goto Finish;
808 }
809 if (Alignment < 0x400){
810 sprintf (AlignmentBuffer, "%d", Alignment);
811 }
812 else if (Alignment >= 0x400) {
813 if (Alignment >= 0x100000) {
814 sprintf (AlignmentBuffer, "%dM", Alignment/0x100000);
815 } else {
816 sprintf (AlignmentBuffer, "%dK", Alignment/0x400);
817 }
818 }
819 Status = StringtoAlignment (AlignmentBuffer, &(InputFileAlign[InputFileNum]));
820 }
821 else {
822 Status = StringtoAlignment (argv[1], &(InputFileAlign[InputFileNum]));
823 }
824 if (EFI_ERROR (Status)) {
825 Error (NULL, 0, 1003, "Invalid option value", "%s = %s", argv[0], argv[1]);
826 goto Finish;
827 }
828 argc -= 2;
829 argv += 2;
830 }
831 InputFileNum ++;
832 continue;
833 }
834
835 if ((stricmp (argv[0], "-n") == 0) || (stricmp (argv[0], "--sectionalign") == 0)) {
836 Error (NULL, 0, 1000, "Unknown option", "SectionAlign option must be specified with section file.");
837 goto Finish;
838 }
839
840 if ((stricmp (argv[0], "-v") == 0) || (stricmp (argv[0], "--verbose") == 0)) {
841 SetPrintLevel (VERBOSE_LOG_LEVEL);
842 VerboseMsg ("Verbose output Mode Set!");
843 argc --;
844 argv ++;
845 continue;
846 }
847
848 if ((stricmp (argv[0], "-q") == 0) || (stricmp (argv[0], "--quiet") == 0)) {
849 SetPrintLevel (KEY_LOG_LEVEL);
850 KeyMsg ("Quiet output Mode Set!");
851 argc --;
852 argv ++;
853 continue;
854 }
855
856 if ((stricmp (argv[0], "-d") == 0) || (stricmp (argv[0], "--debug") == 0)) {
857 Status = AsciiStringToUint64 (argv[1], FALSE, &LogLevel);
858 if (EFI_ERROR (Status)) {
859 Error (NULL, 0, 1003, "Invalid option value", "%s = %s", argv[0], argv[1]);
860 goto Finish;
861 }
862 if (LogLevel > 9) {
863 Error (NULL, 0, 1003, "Invalid option value", "Debug Level range is 0-9, current input level is %d", (int) LogLevel);
864 goto Finish;
865 }
866 SetPrintLevel (LogLevel);
867 DebugMsg (NULL, 0, 9, "Debug Mode Set", "Debug Output Mode Level %s is set!", argv[1]);
868 argc -= 2;
869 argv += 2;
870 continue;
871 }
872
873 Error (NULL, 0, 1000, "Unknown option", "%s", argv[0]);
874 goto Finish;
875 }
876
877 VerboseMsg ("%s tool start.", UTILITY_NAME);
878
879 //
880 // Check the complete input parameters.
881 //
882 if (FfsFiletype == EFI_FV_FILETYPE_ALL) {
883 Error (NULL, 0, 1001, "Missing option", "filetype");
884 goto Finish;
885 }
886
887 if (CompareGuid (&FileGuid, &mZeroGuid) == 0) {
888 Error (NULL, 0, 1001, "Missing option", "fileguid");
889 goto Finish;
890 }
891
892 if (InputFileNum == 0) {
893 Error (NULL, 0, 1001, "Missing option", "Input files");
894 goto Finish;
895 }
896
897 //
898 // Output input parameter information
899 //
900 VerboseMsg ("Fv File type is %s", mFfsFileType [FfsFiletype]);
901 VerboseMsg ("Output file name is %s", OutputFileName);
902 VerboseMsg ("FFS File Guid is %08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",
903 (unsigned) FileGuid.Data1,
904 FileGuid.Data2,
905 FileGuid.Data3,
906 FileGuid.Data4[0],
907 FileGuid.Data4[1],
908 FileGuid.Data4[2],
909 FileGuid.Data4[3],
910 FileGuid.Data4[4],
911 FileGuid.Data4[5],
912 FileGuid.Data4[6],
913 FileGuid.Data4[7]);
914 if ((FfsAttrib & FFS_ATTRIB_FIXED) != 0) {
915 VerboseMsg ("FFS File has the fixed file attribute");
916 }
917 if ((FfsAttrib & FFS_ATTRIB_CHECKSUM) != 0) {
918 VerboseMsg ("FFS File requires the checksum of the whole file");
919 }
920 VerboseMsg ("FFS file alignment is %s", mFfsValidAlignName[FfsAlign]);
921 for (Index = 0; Index < InputFileNum; Index ++) {
922 if (InputFileAlign[Index] == 0) {
923 //
924 // Minimum alignment is 1 byte.
925 //
926 InputFileAlign[Index] = 1;
927 }
928 VerboseMsg ("the %dth input section name is %s and section alignment is %u", Index, InputFileName[Index], (unsigned) InputFileAlign[Index]);
929 }
930
931 //
932 // Calculate the size of all input section files.
933 //
934 Status = GetSectionContents (
935 InputFileName,
936 InputFileAlign,
937 InputFileNum,
938 FfsAttrib,
939 FileBuffer,
940 &FileSize,
941 &MaxAlignment,
942 &PeSectionNum
943 );
944
945 if ((FfsFiletype == EFI_FV_FILETYPE_SECURITY_CORE ||
946 FfsFiletype == EFI_FV_FILETYPE_PEI_CORE ||
947 FfsFiletype == EFI_FV_FILETYPE_DXE_CORE) && (PeSectionNum != 1)) {
948 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);
949 goto Finish;
950 }
951
952 if ((FfsFiletype == EFI_FV_FILETYPE_PEIM ||
953 FfsFiletype == EFI_FV_FILETYPE_DRIVER ||
954 FfsFiletype == EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER ||
955 FfsFiletype == EFI_FV_FILETYPE_APPLICATION) && (PeSectionNum < 1)) {
956 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]);
957 goto Finish;
958 }
959
960 if (Status == EFI_BUFFER_TOO_SMALL) {
961 FileBuffer = (UINT8 *) malloc (FileSize);
962 if (FileBuffer == NULL) {
963 Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");
964 goto Finish;
965 }
966 memset (FileBuffer, 0, FileSize);
967
968 //
969 // read all input file contents into a buffer
970 //
971 Status = GetSectionContents (
972 InputFileName,
973 InputFileAlign,
974 InputFileNum,
975 FfsAttrib,
976 FileBuffer,
977 &FileSize,
978 &MaxAlignment,
979 &PeSectionNum
980 );
981 }
982
983 if (EFI_ERROR (Status)) {
984 goto Finish;
985 }
986
987 if (FileBuffer == NULL && FileSize != 0) {
988 Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");
989 goto Finish;
990 }
991
992 //
993 // Create Ffs file header.
994 //
995 memset (&FfsFileHeader, 0, sizeof (EFI_FFS_FILE_HEADER2));
996 memcpy (&FfsFileHeader.Name, &FileGuid, sizeof (EFI_GUID));
997 FfsFileHeader.Type = FfsFiletype;
998 //
999 // Update FFS Alignment based on the max alignment required by input section files
1000 //
1001 VerboseMsg ("the max alignment of all input sections is %u", (unsigned) MaxAlignment);
1002 for (Index = 0; Index < sizeof (mFfsValidAlign) / sizeof (UINT32) - 1; Index ++) {
1003 if ((MaxAlignment > mFfsValidAlign [Index]) && (MaxAlignment <= mFfsValidAlign [Index + 1])) {
1004 break;
1005 }
1006 }
1007 if (FfsAlign < Index) {
1008 FfsAlign = Index;
1009 }
1010 VerboseMsg ("the alignment of the generated FFS file is %u", (unsigned) mFfsValidAlign [FfsAlign + 1]);
1011
1012 //
1013 // Now FileSize includes the EFI_FFS_FILE_HEADER
1014 //
1015 if (FileSize + sizeof (EFI_FFS_FILE_HEADER) >= MAX_FFS_SIZE) {
1016 HeaderSize = sizeof (EFI_FFS_FILE_HEADER2);
1017 FileSize += sizeof (EFI_FFS_FILE_HEADER2);
1018 FfsFileHeader.ExtendedSize = FileSize;
1019 memset(FfsFileHeader.Size, 0, sizeof (UINT8) * 3);
1020 FfsAttrib |= FFS_ATTRIB_LARGE_FILE;
1021 } else {
1022 HeaderSize = sizeof (EFI_FFS_FILE_HEADER);
1023 FileSize += sizeof (EFI_FFS_FILE_HEADER);
1024 FfsFileHeader.Size[0] = (UINT8) (FileSize & 0xFF);
1025 FfsFileHeader.Size[1] = (UINT8) ((FileSize & 0xFF00) >> 8);
1026 FfsFileHeader.Size[2] = (UINT8) ((FileSize & 0xFF0000) >> 16);
1027 }
1028 VerboseMsg ("the size of the generated FFS file is %u bytes", (unsigned) FileSize);
1029
1030 //FfsAlign larger than 7, set FFS_ATTRIB_DATA_ALIGNMENT2
1031 if (FfsAlign < 8) {
1032 FfsFileHeader.Attributes = (EFI_FFS_FILE_ATTRIBUTES) (FfsAttrib | (FfsAlign << 3));
1033 } else {
1034 FfsFileHeader.Attributes = (EFI_FFS_FILE_ATTRIBUTES) (FfsAttrib | ((FfsAlign & 0x7) << 3) | FFS_ATTRIB_DATA_ALIGNMENT2);
1035 }
1036
1037 //
1038 // Fill in checksums and state, these must be zero for checksumming
1039 //
1040 // FileHeader.IntegrityCheck.Checksum.Header = 0;
1041 // FileHeader.IntegrityCheck.Checksum.File = 0;
1042 // FileHeader.State = 0;
1043 //
1044 FfsFileHeader.IntegrityCheck.Checksum.Header = CalculateChecksum8 (
1045 (UINT8 *) &FfsFileHeader,
1046 HeaderSize
1047 );
1048
1049 if (FfsFileHeader.Attributes & FFS_ATTRIB_CHECKSUM) {
1050 //
1051 // Ffs header checksum = zero, so only need to calculate ffs body.
1052 //
1053 FfsFileHeader.IntegrityCheck.Checksum.File = CalculateChecksum8 (
1054 FileBuffer,
1055 FileSize - HeaderSize
1056 );
1057 } else {
1058 FfsFileHeader.IntegrityCheck.Checksum.File = FFS_FIXED_CHECKSUM;
1059 }
1060
1061 FfsFileHeader.State = EFI_FILE_HEADER_CONSTRUCTION | EFI_FILE_HEADER_VALID | EFI_FILE_DATA_VALID;
1062
1063 //
1064 // Open output file to write ffs data.
1065 //
1066 if (OutputFileName != NULL) {
1067 remove(OutputFileName);
1068 FfsFile = fopen (LongFilePath (OutputFileName), "wb");
1069 if (FfsFile == NULL) {
1070 Error (NULL, 0, 0001, "Error opening file", OutputFileName);
1071 goto Finish;
1072 }
1073 //
1074 // write header
1075 //
1076 fwrite (&FfsFileHeader, 1, HeaderSize, FfsFile);
1077 //
1078 // write data
1079 //
1080 if (FileBuffer != NULL) {
1081 fwrite (FileBuffer, 1, FileSize - HeaderSize, FfsFile);
1082 }
1083
1084 fclose (FfsFile);
1085 }
1086
1087 Finish:
1088 if (InputFileName != NULL) {
1089 free (InputFileName);
1090 }
1091 if (InputFileAlign != NULL) {
1092 free (InputFileAlign);
1093 }
1094 if (FileBuffer != NULL) {
1095 free (FileBuffer);
1096 }
1097 //
1098 // If any errors were reported via the standard error reporting
1099 // routines, then the status has been saved. Get the value and
1100 // return it to the caller.
1101 //
1102 VerboseMsg ("%s tool done with return code is 0x%x.", UTILITY_NAME, GetUtilityStatus ());
1103
1104 return GetUtilityStatus ();
1105 }
EFI Development Kit II mirror for PVE