]> git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/C/GenFfs/GenFfs.c
projects / mirror_edk2.git / blob
? search:


24081ebfc44e8ac1765ac2062a25ca84fe5d4964
[mirror_edk2.git] / BaseTools / Source / C / GenFfs / GenFfs.c
1 /**
2
3 Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>
4 This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
8
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
11
12 Module Name:
13
14 GenFfs.c
15
16 Abstract:
17
18 This file contains functions required to generate a Firmware File System
19 file.
20
21 **/
22
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26
27 #include <Common/UefiBaseTypes.h>
28 #include <Common/PiFirmwareFile.h>
29 #include <IndustryStandard/PeImage.h>
30
31 #include "CommonLib.h"
32 #include "ParseInf.h"
33 #include "EfiUtilityMsgs.h"
34
35 #define UTILITY_NAME "GenFfs"
36 #define UTILITY_MAJOR_VERSION 0
37 #define UTILITY_MINOR_VERSION 1
38
39 STATIC CHAR8 *mFfsFileType[] = {
40 NULL, // 0x00
41 "EFI_FV_FILETYPE_RAW", // 0x01
42 "EFI_FV_FILETYPE_FREEFORM", // 0x02
43 "EFI_FV_FILETYPE_SECURITY_CORE", // 0x03
44 "EFI_FV_FILETYPE_PEI_CORE", // 0x04
45 "EFI_FV_FILETYPE_DXE_CORE", // 0x05
46 "EFI_FV_FILETYPE_PEIM", // 0x06
47 "EFI_FV_FILETYPE_DRIVER", // 0x07
48 "EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER", // 0x08
49 "EFI_FV_FILETYPE_APPLICATION", // 0x09
50 "EFI_FV_FILETYPE_SMM", // 0x0A
51 "EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE",// 0x0B
52 "EFI_FV_FILETYPE_COMBINED_SMM_DXE", // 0x0C
53 "EFI_FV_FILETYPE_SMM_CORE" // 0x0D
54 };
55
56 STATIC CHAR8 *mAlignName[] = {
57 "1", "2", "4", "8", "16", "32", "64", "128", "256", "512",
58 "1K", "2K", "4K", "8K", "16K", "32K", "64K"
59 };
60
61 STATIC CHAR8 *mFfsValidAlignName[] = {
62 "8", "16", "128", "512", "1K", "4K", "32K", "64K"
63 };
64
65 STATIC UINT32 mFfsValidAlign[] = {0, 8, 16, 128, 512, 1024, 4096, 32768, 65536};
66
67 STATIC EFI_GUID mZeroGuid = {0};
68
69 STATIC
70 VOID
71 Version (
72 VOID
73 )
74 /*++
75
76 Routine Description:
77
78 Print out version information for this utility.
79
80 Arguments:
81
82 None
83
84 Returns:
85
86 None
87
88 --*/
89 {
90 fprintf (stdout, "%s Version %d.%d %s \n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION);
91 }
92
93 STATIC
94 VOID
95 Usage (
96 VOID
97 )
98 /*++
99
100 Routine Description:
101
102 Print Error / Help message.
103
104 Arguments:
105
106 VOID
107
108 Returns:
109
110 None
111
112 --*/
113 {
114 //
115 // Summary usage
116 //
117 fprintf (stdout, "\nUsage: %s [options]\n\n", UTILITY_NAME);
118
119 //
120 // Copyright declaration
121 //
122 fprintf (stdout, "Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.\n\n");
123
124 //
125 // Details Option
126 //
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_COMBINED_SMM_DXE, \n\
139 EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE.\n");
140 fprintf (stdout, " -g FileGuid, --fileguid FileGuid\n\
141 FileGuid is one module guid.\n\
142 Its format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n");
143 fprintf (stdout, " -x, --fixed Indicates that the file may not be moved\n\
144 from its present location.\n");
145 fprintf (stdout, " -s, --checksum Indicates to calculate file checksum.\n");
146 fprintf (stdout, " -a FileAlign, --align FileAlign\n\
147 FileAlign points to file alignment, which only support\n\
148 the following align: 1,2,4,8,16,128,512,1K,4K,32K,64K\n");
149 fprintf (stdout, " -i SectionFile, --sectionfile SectionFile\n\
150 Section file will be contained in this FFS file.\n");
151 fprintf (stdout, " -n SectionAlign, --sectionalign SectionAlign\n\
152 SectionAlign points to section alignment, which support\n\
153 the alignment scope 1~64K. It is specified together\n\
154 with sectionfile to point its alignment in FFS file.\n");
155 fprintf (stdout, " -v, --verbose Turn on verbose output with informational messages.\n");
156 fprintf (stdout, " -q, --quiet Disable all messages except key message and fatal error\n");
157 fprintf (stdout, " -d, --debug level Enable debug messages, at input debug level.\n");
158 fprintf (stdout, " --version Show program's version number and exit.\n");
159 fprintf (stdout, " -h, --help Show this help message and exit.\n");
160 }
161
162 STATIC
163 EFI_STATUS
164 StringtoAlignment (
165 IN CHAR8 *AlignBuffer,
166 OUT UINT32 *AlignNumber
167 )
168 /*++
169
170 Routine Description:
171
172 Converts Align String to align value (1~64K).
173
174 Arguments:
175
176 AlignBuffer - Pointer to Align string.
177 AlignNumber - Pointer to Align value.
178
179 Returns:
180
181 EFI_SUCCESS Successfully convert align string to align value.
182 EFI_INVALID_PARAMETER Align string is invalid or align value is not in scope.
183
184 --*/
185 {
186 UINT32 Index = 0;
187 //
188 // Check AlignBuffer
189 //
190 if (AlignBuffer == NULL) {
191 return EFI_INVALID_PARAMETER;
192 }
193 for (Index = 0; Index < sizeof (mAlignName) / sizeof (CHAR8 *); Index ++) {
194 if (stricmp (AlignBuffer, mAlignName [Index]) == 0) {
195 *AlignNumber = 1 << Index;
196 return EFI_SUCCESS;
197 }
198 }
199 return EFI_INVALID_PARAMETER;
200 }
201
202 STATIC
203 UINT8
204 StringToType (
205 IN CHAR8 *String
206 )
207 /*++
208
209 Routine Description:
210
211 Converts File Type String to value. EFI_FV_FILETYPE_ALL indicates that an
212 unrecognized file type was specified.
213
214 Arguments:
215
216 String - File type string
217
218 Returns:
219
220 File Type Value
221
222 --*/
223 {
224 UINT8 Index = 0;
225
226 if (String == NULL) {
227 return EFI_FV_FILETYPE_ALL;
228 }
229
230 for (Index = 0; Index < sizeof (mFfsFileType) / sizeof (CHAR8 *); Index ++) {
231 if (mFfsFileType [Index] != NULL && (stricmp (String, mFfsFileType [Index]) == 0)) {
232 return Index;
233 }
234 }
235 return EFI_FV_FILETYPE_ALL;
236 }
237
238 STATIC
239 EFI_STATUS
240 GetSectionContents (
241 IN CHAR8 **InputFileName,
242 IN UINT32 *InputFileAlign,
243 IN UINT32 InputFileNum,
244 OUT UINT8 *FileBuffer,
245 OUT UINT32 *BufferLength,
246 OUT UINT32 *MaxAlignment,
247 OUT UINT8 *PESectionNum
248 )
249 /*++
250
251 Routine Description:
252
253 Get the contents of all section files specified in InputFileName
254 into FileBuffer.
255
256 Arguments:
257
258 InputFileName - Name of the input file.
259
260 InputFileAlign - Alignment required by the input file data.
261
262 InputFileNum - Number of input files. Should be at least 1.
263
264 FileBuffer - Output buffer to contain data
265
266 BufferLength - On input, this is size of the FileBuffer.
267 On output, this is the actual length of the data.
268
269 MaxAlignment - The max alignment required by all the input file datas.
270
271 PeSectionNum - Calculate the number of Pe/Te Section in this FFS file.
272
273 Returns:
274
275 EFI_SUCCESS on successful return
276 EFI_INVALID_PARAMETER if InputFileNum is less than 1 or BufferLength point is NULL.
277 EFI_ABORTED if unable to open input file.
278 EFI_BUFFER_TOO_SMALL FileBuffer is not enough to contain all file data.
279 --*/
280 {
281 UINT32 Size;
282 UINT32 Offset;
283 UINT32 FileSize;
284 UINT32 Index;
285 FILE *InFile;
286 EFI_COMMON_SECTION_HEADER *SectHeader;
287 EFI_COMMON_SECTION_HEADER TempSectHeader;
288 EFI_TE_IMAGE_HEADER TeHeader;
289 UINT32 TeOffset;
290 EFI_GUID_DEFINED_SECTION GuidSectHeader;
291 UINT32 HeaderSize;
292
293 Size = 0;
294 Offset = 0;
295 TeOffset = 0;
296
297 //
298 // Go through our array of file names and copy their contents
299 // to the output buffer.
300 //
301 for (Index = 0; Index < InputFileNum; Index++) {
302 //
303 // make sure section ends on a DWORD boundary
304 //
305 while ((Size & 0x03) != 0) {
306 Size++;
307 }
308
309 //
310 // Get the Max alignment of all input file datas
311 //
312 if (*MaxAlignment < InputFileAlign [Index]) {
313 *MaxAlignment = InputFileAlign [Index];
314 }
315
316 //
317 // Open file and read contents
318 //
319 InFile = fopen (InputFileName[Index], "rb");
320 if (InFile == NULL) {
321 Error (NULL, 0, 0001, "Error opening file", InputFileName[Index]);
322 return EFI_ABORTED;
323 }
324
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);
330
331 //
332 // Check this section is Te/Pe section, and Calculate the numbers of Te/Pe section.
333 //
334 TeOffset = 0;
335 HeaderSize = sizeof (EFI_COMMON_SECTION_HEADER);
336 fread (&TempSectHeader, 1, sizeof (TempSectHeader), InFile);
337 if (TempSectHeader.Type == EFI_SECTION_TE) {
338 (*PESectionNum) ++;
339 fread (&TeHeader, 1, sizeof (TeHeader), InFile);
340 if (TeHeader.Signature == EFI_TE_IMAGE_HEADER_SIGNATURE) {
341 TeOffset = TeHeader.StrippedSize - sizeof (TeHeader);
342 }
343 } else if (TempSectHeader.Type == EFI_SECTION_PE32) {
344 (*PESectionNum) ++;
345 } else if (TempSectHeader.Type == EFI_SECTION_GUID_DEFINED) {
346 fseek (InFile, 0, SEEK_SET);
347 fread (&GuidSectHeader, 1, sizeof (GuidSectHeader), InFile);
348 if ((GuidSectHeader.Attributes & EFI_GUIDED_SECTION_PROCESSING_REQUIRED) == 0) {
349 HeaderSize = GuidSectHeader.DataOffset;
350 }
351 (*PESectionNum) ++;
352 } else if (TempSectHeader.Type == EFI_SECTION_COMPRESSION ||
353 TempSectHeader.Type == EFI_SECTION_FIRMWARE_VOLUME_IMAGE) {
354 //
355 // for the encapsulated section, assume it contains Pe/Te section
356 //
357 (*PESectionNum) ++;
358 }
359
360 fseek (InFile, 0, SEEK_SET);
361
362 //
363 // Revert TeOffset to the converse value relative to Alignment
364 // This is to assure the original PeImage Header at Alignment.
365 //
366 if ((TeOffset != 0) && (InputFileAlign [Index] != 0)) {
367 TeOffset = InputFileAlign [Index] - (TeOffset % InputFileAlign [Index]);
368 TeOffset = TeOffset % InputFileAlign [Index];
369 }
370
371 //
372 // make sure section data meet its alignment requirement by adding one raw pad section.
373 // But the different sections have the different section header. Necessary or not?
374 // Based on section type to adjust offset? Todo
375 //
376 if ((InputFileAlign [Index] != 0) && (((Size + HeaderSize + TeOffset) % InputFileAlign [Index]) != 0)) {
377 Offset = (Size + sizeof (EFI_COMMON_SECTION_HEADER) + HeaderSize + TeOffset + InputFileAlign [Index] - 1) & ~(InputFileAlign [Index] - 1);
378 Offset = Offset - Size - HeaderSize - TeOffset;
379
380 if (FileBuffer != NULL && ((Size + Offset) < *BufferLength)) {
381 memset (FileBuffer + Size, 0, Offset);
382 SectHeader = (EFI_COMMON_SECTION_HEADER *) (FileBuffer + Size);
383 SectHeader->Type = EFI_SECTION_RAW;
384 SectHeader->Size[0] = (UINT8) (Offset & 0xff);
385 SectHeader->Size[1] = (UINT8) ((Offset & 0xff00) >> 8);
386 SectHeader->Size[2] = (UINT8) ((Offset & 0xff0000) >> 16);
387 }
388 DebugMsg (NULL, 0, 9, "Pad raw section for section data alignment",
389 "Pad Raw section size is %u", (unsigned) Offset);
390
391 Size = Size + Offset;
392 }
393
394 //
395 // Now read the contents of the file into the buffer
396 // Buffer must be enough to contain the file content.
397 //
398 if ((FileSize > 0) && (FileBuffer != NULL) && ((Size + FileSize) <= *BufferLength)) {
399 if (fread (FileBuffer + Size, (size_t) FileSize, 1, InFile) != 1) {
400 Error (NULL, 0, 0004, "Error reading file", InputFileName[Index]);
401 fclose (InFile);
402 return EFI_ABORTED;
403 }
404 }
405
406 fclose (InFile);
407 Size += FileSize;
408 }
409
410 //
411 // Set the actual length of the data.
412 //
413 if (Size > *BufferLength) {
414 *BufferLength = Size;
415 return EFI_BUFFER_TOO_SMALL;
416 } else {
417 *BufferLength = Size;
418 return EFI_SUCCESS;
419 }
420 }
421
422 int
423 main (
424 int argc,
425 CHAR8 *argv[]
426 )
427 /*++
428
429 Routine Description:
430
431 Main function.
432
433 Arguments:
434
435 argc - Number of command line parameters.
436 argv - Array of pointers to parameter strings.
437
438 Returns:
439 STATUS_SUCCESS - Utility exits successfully.
440 STATUS_ERROR - Some error occurred during execution.
441
442 --*/
443 {
444 EFI_STATUS Status;
445 EFI_FFS_FILE_ATTRIBUTES FfsAttrib;
446 UINT32 FfsAlign;
447 EFI_FV_FILETYPE FfsFiletype;
448 CHAR8 *OutputFileName;
449 EFI_GUID FileGuid = {0};
450 UINT32 InputFileNum;
451 UINT32 *InputFileAlign;
452 CHAR8 **InputFileName;
453 UINT8 *FileBuffer;
454 UINT32 FileSize;
455 UINT32 MaxAlignment;
456 EFI_FFS_FILE_HEADER FfsFileHeader;
457 FILE *FfsFile;
458 UINT32 Index;
459 UINT64 LogLevel;
460 UINT8 PeSectionNum;
461
462 //
463 // Init local variables
464 //
465 LogLevel = 0;
466 Index = 0;
467 FfsAttrib = 0;
468 FfsAlign = 0;
469 FfsFiletype = EFI_FV_FILETYPE_ALL;
470 OutputFileName = NULL;
471 InputFileNum = 0;
472 InputFileName = NULL;
473 InputFileAlign = NULL;
474 FileBuffer = NULL;
475 FileSize = 0;
476 MaxAlignment = 1;
477 FfsFile = NULL;
478 Status = EFI_SUCCESS;
479 PeSectionNum = 0;
480
481 SetUtilityName (UTILITY_NAME);
482
483 if (argc == 1) {
484 Error (NULL, 0, 1001, "Missing options", "no options input");
485 Usage ();
486 return STATUS_ERROR;
487 }
488
489 //
490 // Parse command line
491 //
492 argc --;
493 argv ++;
494
495 if ((stricmp (argv[0], "-h") == 0) || (stricmp (argv[0], "--help") == 0)) {
496 Version ();
497 Usage ();
498 return STATUS_SUCCESS;
499 }
500
501 if (stricmp (argv[0], "--version") == 0) {
502 Version ();
503 return STATUS_SUCCESS;
504 }
505
506 while (argc > 0) {
507 if ((stricmp (argv[0], "-t") == 0) || (stricmp (argv[0], "--filetype") == 0)) {
508 if (argv[1] == NULL || argv[1][0] == '-') {
509 Error (NULL, 0, 1003, "Invalid option value", "file type is missing for -t option");
510 goto Finish;
511 }
512 FfsFiletype = StringToType (argv[1]);
513 if (FfsFiletype == EFI_FV_FILETYPE_ALL) {
514 Error (NULL, 0, 1003, "Invalid option value", "%s is not a valid file type", argv[1]);
515 goto Finish;
516 }
517 argc -= 2;
518 argv += 2;
519 continue;
520 }
521
522 if ((stricmp (argv[0], "-o") == 0) || (stricmp (argv[0], "--outputfile") == 0)) {
523 if (argv[1] == NULL || argv[1][0] == '-') {
524 Error (NULL, 0, 1003, "Invalid option value", "Output file is missing for -o option");
525 goto Finish;
526 }
527 OutputFileName = argv[1];
528 argc -= 2;
529 argv += 2;
530 continue;
531 }
532
533 if ((stricmp (argv[0], "-g") == 0) || (stricmp (argv[0], "--fileguid") == 0)) {
534 Status = StringToGuid (argv[1], &FileGuid);
535 if (EFI_ERROR (Status)) {
536 Error (NULL, 0, 1003, "Invalid option value", "%s = %s", argv[0], argv[1]);
537 goto Finish;
538 }
539 argc -= 2;
540 argv += 2;
541 continue;
542 }
543
544 if ((stricmp (argv[0], "-x") == 0) || (stricmp (argv[0], "--fixed") == 0)) {
545 FfsAttrib |= FFS_ATTRIB_FIXED;
546 argc -= 1;
547 argv += 1;
548 continue;
549 }
550
551 if ((stricmp (argv[0], "-s") == 0) || (stricmp (argv[0], "--checksum") == 0)) {
552 FfsAttrib |= FFS_ATTRIB_CHECKSUM;
553 argc -= 1;
554 argv += 1;
555 continue;
556 }
557
558 if ((stricmp (argv[0], "-a") == 0) || (stricmp (argv[0], "--align") == 0)) {
559 if (argv[1] == NULL || argv[1][0] == '-') {
560 Error (NULL, 0, 1003, "Invalid option value", "Align value is missing for -a option");
561 goto Finish;
562 }
563 for (Index = 0; Index < sizeof (mFfsValidAlignName) / sizeof (CHAR8 *); Index ++) {
564 if (stricmp (argv[1], mFfsValidAlignName[Index]) == 0) {
565 break;
566 }
567 }
568 if (Index == sizeof (mFfsValidAlignName) / sizeof (CHAR8 *)) {
569 if ((stricmp (argv[1], "1") == 0) || (stricmp (argv[1], "2") == 0) || (stricmp (argv[1], "4") == 0)) {
570 //
571 // 1, 2, 4 byte alignment same to 8 byte alignment
572 //
573 Index = 0;
574 } else {
575 Error (NULL, 0, 1003, "Invalid option value", "%s = %s", argv[0], argv[1]);
576 goto Finish;
577 }
578 }
579 FfsAlign = Index;
580 argc -= 2;
581 argv += 2;
582 continue;
583 }
584
585 if ((stricmp (argv[0], "-i") == 0) || (stricmp (argv[0], "--sectionfile") == 0)) {
586 //
587 // Get Input file name and its alignment
588 //
589 if (argv[1] == NULL || argv[1][0] == '-') {
590 Error (NULL, 0, 1003, "Invalid option value", "input section file is missing for -i option");
591 goto Finish;
592 }
593
594 //
595 // Allocate Input file name buffer and its alignment buffer.
596 //
597 if ((InputFileNum == 0) && (InputFileName == NULL)) {
598 InputFileName = (CHAR8 **) malloc (MAXIMUM_INPUT_FILE_NUM * sizeof (CHAR8 *));
599 if (InputFileName == NULL) {
600 Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");
601 return STATUS_ERROR;
602 }
603 memset (InputFileName, 0, (MAXIMUM_INPUT_FILE_NUM * sizeof (CHAR8 *)));
604
605 InputFileAlign = (UINT32 *) malloc (MAXIMUM_INPUT_FILE_NUM * sizeof (UINT32));
606 if (InputFileAlign == NULL) {
607 Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");
608 free (InputFileName);
609 return STATUS_ERROR;
610 }
611 memset (InputFileAlign, 0, MAXIMUM_INPUT_FILE_NUM * sizeof (UINT32));
612 } else if (InputFileNum % MAXIMUM_INPUT_FILE_NUM == 0) {
613 //
614 // InputFileName and alignment buffer too small, need to realloc
615 //
616 InputFileName = (CHAR8 **) realloc (
617 InputFileName,
618 (InputFileNum + MAXIMUM_INPUT_FILE_NUM) * sizeof (CHAR8 *)
619 );
620
621 if (InputFileName == NULL) {
622 Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");
623 free (InputFileAlign);
624 return STATUS_ERROR;
625 }
626 memset (&(InputFileName[InputFileNum]), 0, (MAXIMUM_INPUT_FILE_NUM * sizeof (CHAR8 *)));
627
628 InputFileAlign = (UINT32 *) realloc (
629 InputFileAlign,
630 (InputFileNum + MAXIMUM_INPUT_FILE_NUM) * sizeof (UINT32)
631 );
632
633 if (InputFileAlign == NULL) {
634 Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");
635 free (InputFileName);
636 return STATUS_ERROR;
637 }
638 memset (&(InputFileAlign[InputFileNum]), 0, (MAXIMUM_INPUT_FILE_NUM * sizeof (UINT32)));
639 }
640
641 InputFileName[InputFileNum] = argv[1];
642 argc -= 2;
643 argv += 2;
644
645 if (argc <= 0) {
646 InputFileNum ++;
647 break;
648 }
649
650 //
651 // Section File alignment requirement
652 //
653 if ((stricmp (argv[0], "-n") == 0) || (stricmp (argv[0], "--sectionalign") == 0)) {
654 Status = StringtoAlignment (argv[1], &(InputFileAlign[InputFileNum]));
655 if (EFI_ERROR (Status)) {
656 Error (NULL, 0, 1003, "Invalid option value", "%s = %s", argv[0], argv[1]);
657 goto Finish;
658 }
659 argc -= 2;
660 argv += 2;
661 }
662 InputFileNum ++;
663 continue;
664 }
665
666 if ((stricmp (argv[0], "-n") == 0) || (stricmp (argv[0], "--sectionalign") == 0)) {
667 Error (NULL, 0, 1000, "Unknown option", "SectionAlign option must be specified with section file.");
668 goto Finish;
669 }
670
671 if ((stricmp (argv[0], "-v") == 0) || (stricmp (argv[0], "--verbose") == 0)) {
672 SetPrintLevel (VERBOSE_LOG_LEVEL);
673 VerboseMsg ("Verbose output Mode Set!");
674 argc --;
675 argv ++;
676 continue;
677 }
678
679 if ((stricmp (argv[0], "-q") == 0) || (stricmp (argv[0], "--quiet") == 0)) {
680 SetPrintLevel (KEY_LOG_LEVEL);
681 KeyMsg ("Quiet output Mode Set!");
682 argc --;
683 argv ++;
684 continue;
685 }
686
687 if ((stricmp (argv[0], "-d") == 0) || (stricmp (argv[0], "--debug") == 0)) {
688 Status = AsciiStringToUint64 (argv[1], FALSE, &LogLevel);
689 if (EFI_ERROR (Status)) {
690 Error (NULL, 0, 1003, "Invalid option value", "%s = %s", argv[0], argv[1]);
691 goto Finish;
692 }
693 if (LogLevel > 9) {
694 Error (NULL, 0, 1003, "Invalid option value", "Debug Level range is 0-9, current input level is %d", (int) LogLevel);
695 goto Finish;
696 }
697 SetPrintLevel (LogLevel);
698 DebugMsg (NULL, 0, 9, "Debug Mode Set", "Debug Output Mode Level %s is set!", argv[1]);
699 argc -= 2;
700 argv += 2;
701 continue;
702 }
703
704 Error (NULL, 0, 1000, "Unknown option", argv[0]);
705 goto Finish;
706 }
707
708 VerboseMsg ("%s tool start.", UTILITY_NAME);
709
710 //
711 // Check the complete input paramters.
712 //
713 if (FfsFiletype == EFI_FV_FILETYPE_ALL) {
714 Error (NULL, 0, 1001, "Missing option", "filetype");
715 goto Finish;
716 }
717
718 if (CompareGuid (&FileGuid, &mZeroGuid) == 0) {
719 Error (NULL, 0, 1001, "Missing option", "fileguid");
720 goto Finish;
721 }
722
723 if (InputFileNum == 0) {
724 Error (NULL, 0, 1001, "Missing option", "Input files");
725 goto Finish;
726 }
727
728 //
729 // Output input parameter information
730 //
731 VerboseMsg ("Fv File type is %s", mFfsFileType [FfsFiletype]);
732 VerboseMsg ("Output file name is %s", OutputFileName);
733 VerboseMsg ("FFS File Guid is %08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",
734 (unsigned) FileGuid.Data1,
735 FileGuid.Data2,
736 FileGuid.Data3,
737 FileGuid.Data4[0],
738 FileGuid.Data4[1],
739 FileGuid.Data4[2],
740 FileGuid.Data4[3],
741 FileGuid.Data4[4],
742 FileGuid.Data4[5],
743 FileGuid.Data4[6],
744 FileGuid.Data4[7]);
745 if ((FfsAttrib & FFS_ATTRIB_FIXED) != 0) {
746 VerboseMsg ("FFS File has the fixed file attribute");
747 }
748 if ((FfsAttrib & FFS_ATTRIB_CHECKSUM) != 0) {
749 VerboseMsg ("FFS File requires the checksum of the whole file");
750 }
751 VerboseMsg ("FFS file alignment is %s", mFfsValidAlignName[FfsAlign]);
752 for (Index = 0; Index < InputFileNum; Index ++) {
753 if (InputFileAlign[Index] == 0) {
754 //
755 // Minimum alignment is 1 byte.
756 //
757 InputFileAlign[Index] = 1;
758 }
759 VerboseMsg ("the %dth input section name is %s and section alignment is %u", Index, InputFileName[Index], (unsigned) InputFileAlign[Index]);
760 }
761
762 //
763 // Calculate the size of all input section files.
764 //
765 Status = GetSectionContents (
766 InputFileName,
767 InputFileAlign,
768 InputFileNum,
769 FileBuffer,
770 &FileSize,
771 &MaxAlignment,
772 &PeSectionNum
773 );
774
775 if ((FfsFiletype == EFI_FV_FILETYPE_SECURITY_CORE ||
776 FfsFiletype == EFI_FV_FILETYPE_PEI_CORE ||
777 FfsFiletype == EFI_FV_FILETYPE_DXE_CORE) && (PeSectionNum != 1)) {
778 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);
779 goto Finish;
780 }
781
782 if ((FfsFiletype == EFI_FV_FILETYPE_PEIM ||
783 FfsFiletype == EFI_FV_FILETYPE_DRIVER ||
784 FfsFiletype == EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER ||
785 FfsFiletype == EFI_FV_FILETYPE_APPLICATION) && (PeSectionNum < 1)) {
786 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]);
787 goto Finish;
788 }
789
790 if (Status == EFI_BUFFER_TOO_SMALL) {
791 FileBuffer = (UINT8 *) malloc (FileSize);
792 if (FileBuffer == NULL) {
793 Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");
794 goto Finish;
795 }
796 memset (FileBuffer, 0, FileSize);
797
798 //
799 // read all input file contents into a buffer
800 //
801 Status = GetSectionContents (
802 InputFileName,
803 InputFileAlign,
804 InputFileNum,
805 FileBuffer,
806 &FileSize,
807 &MaxAlignment,
808 &PeSectionNum
809 );
810 }
811
812 if (EFI_ERROR (Status)) {
813 goto Finish;
814 }
815
816 //
817 // Create Ffs file header.
818 //
819 memset (&FfsFileHeader, 0, sizeof (EFI_FFS_FILE_HEADER));
820 memcpy (&FfsFileHeader.Name, &FileGuid, sizeof (EFI_GUID));
821 FfsFileHeader.Type = FfsFiletype;
822 //
823 // Update FFS Alignment based on the max alignment required by input section files
824 //
825 VerboseMsg ("the max alignment of all input sections is %u", (unsigned) MaxAlignment);
826 for (Index = 0; Index < sizeof (mFfsValidAlign) / sizeof (UINT32) - 1; Index ++) {
827 if ((MaxAlignment > mFfsValidAlign [Index]) && (MaxAlignment <= mFfsValidAlign [Index + 1])) {
828 break;
829 }
830 }
831 if (FfsAlign < Index) {
832 FfsAlign = Index;
833 }
834 VerboseMsg ("the alignment of the generated FFS file is %u", (unsigned) mFfsValidAlign [FfsAlign + 1]);
835 FfsFileHeader.Attributes = (EFI_FFS_FILE_ATTRIBUTES) (FfsAttrib | (FfsAlign << 3));
836
837 //
838 // Now FileSize includes the EFI_FFS_FILE_HEADER
839 //
840 FileSize += sizeof (EFI_FFS_FILE_HEADER);
841 VerboseMsg ("the size of the generated FFS file is %u bytes", (unsigned) FileSize);
842 FfsFileHeader.Size[0] = (UINT8) (FileSize & 0xFF);
843 FfsFileHeader.Size[1] = (UINT8) ((FileSize & 0xFF00) >> 8);
844 FfsFileHeader.Size[2] = (UINT8) ((FileSize & 0xFF0000) >> 16);
845 //
846 // Fill in checksums and state, these must be zero for checksumming
847 //
848 // FileHeader.IntegrityCheck.Checksum.Header = 0;
849 // FileHeader.IntegrityCheck.Checksum.File = 0;
850 // FileHeader.State = 0;
851 //
852 FfsFileHeader.IntegrityCheck.Checksum.Header = CalculateChecksum8 (
853 (UINT8 *) &FfsFileHeader,
854 sizeof (EFI_FFS_FILE_HEADER)
855 );
856
857 if (FfsFileHeader.Attributes & FFS_ATTRIB_CHECKSUM) {
858 //
859 // Ffs header checksum = zero, so only need to calculate ffs body.
860 //
861 FfsFileHeader.IntegrityCheck.Checksum.File = CalculateChecksum8 (
862 FileBuffer,
863 FileSize - sizeof (EFI_FFS_FILE_HEADER)
864 );
865 } else {
866 FfsFileHeader.IntegrityCheck.Checksum.File = FFS_FIXED_CHECKSUM;
867 }
868
869 FfsFileHeader.State = EFI_FILE_HEADER_CONSTRUCTION | EFI_FILE_HEADER_VALID | EFI_FILE_DATA_VALID;
870
871 //
872 // Open output file to write ffs data.
873 //
874 remove(OutputFileName);
875 FfsFile = fopen (OutputFileName, "wb");
876 if (FfsFile == NULL) {
877 Error (NULL, 0, 0001, "Error opening file", OutputFileName);
878 goto Finish;
879 }
880 //
881 // write header
882 //
883 fwrite (&FfsFileHeader, 1, sizeof (FfsFileHeader), FfsFile);
884 //
885 // write data
886 //
887 fwrite (FileBuffer, 1, FileSize - sizeof (EFI_FFS_FILE_HEADER), FfsFile);
888
889 fclose (FfsFile);
890
891 Finish:
892 if (InputFileName != NULL) {
893 free (InputFileName);
894 }
895 if (InputFileAlign != NULL) {
896 free (InputFileAlign);
897 }
898 if (FileBuffer != NULL) {
899 free (FileBuffer);
900 }
901 //
902 // If any errors were reported via the standard error reporting
903 // routines, then the status has been saved. Get the value and
904 // return it to the caller.
905 //
906 VerboseMsg ("%s tool done with return code is 0x%x.", UTILITY_NAME, GetUtilityStatus ());
907
908 return GetUtilityStatus ();
909 }
EFI Development Kit II mirror for PVE