3 Copyright (c) 2007 - 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
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.
18 This contains all code necessary to build the GenFvImage.exe utility.
19 This utility relies heavily on the GenFvImage Lib. Definitions for both
20 can be found in the Tiano Firmware Volume Generation Utility
21 Specification, review draft.
26 // File included in build
31 #include "GenFvInternalLib.h"
36 #define UTILITY_NAME "GenFv"
39 // Utility version information
41 #define UTILITY_MAJOR_VERSION 0
42 #define UTILITY_MINOR_VERSION 1
44 EFI_GUID mEfiFirmwareFileSystem2Guid
= EFI_FIRMWARE_FILE_SYSTEM2_GUID
;
55 Displays the standard utility information to SDTOUT
67 fprintf (stdout
, "%s Version %d.%d %s \n", UTILITY_NAME
, UTILITY_MAJOR_VERSION
, UTILITY_MINOR_VERSION
, __BUILD_VERSION
);
79 Displays the utility usage syntax to STDOUT
94 fprintf (stdout
, "\nUsage: %s [options]\n\n", UTILITY_NAME
);
97 // Copyright declaration
99 fprintf (stdout
, "Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.\n\n");
104 fprintf (stdout
, "Options:\n");
105 fprintf (stdout
, " -o FileName, --outputfile FileName\n\
106 File is the FvImage or CapImage to be created.\n");
107 fprintf (stdout
, " -i FileName, --inputfile FileName\n\
108 File is the input FV.inf or Cap.inf to specify\n\
109 how to construct FvImage or CapImage.\n");
110 fprintf (stdout
, " -b BlockSize, --blocksize BlockSize\n\
111 BlockSize is one HEX or DEC format value\n\
112 BlockSize is required by Fv Image.\n");
113 fprintf (stdout
, " -n NumberBlock, --numberblock NumberBlock\n\
114 NumberBlock is one HEX or DEC format value\n\
115 NumberBlock is one optional parameter.\n");
116 fprintf (stdout
, " -f FfsFile, --ffsfile FfsFile\n\
117 FfsFile is placed into Fv Image\n\
118 multi files can input one by one\n");
119 fprintf (stdout
, " -s FileTakenSize, --filetakensize FileTakenSize\n\
120 FileTakenSize specifies the size of the required\n\
121 space that the input file is placed in Fvimage.\n\
122 It is specified together with the input file.\n");
123 fprintf (stdout
, " -r Address, --baseaddr Address\n\
124 Address is the rebase start address for drivers that\n\
125 run in Flash. It supports DEC or HEX digital format.\n\
126 If it is set to zero, no rebase action will be taken\n");
127 fprintf (stdout
, " -a AddressFile, --addrfile AddressFile\n\
128 AddressFile is one file used to record the child\n\
129 FV base address when current FV base address is set.\n");
130 fprintf (stdout
, " -m logfile, --map logfile\n\
131 Logfile is the output fv map file name. if it is not\n\
132 given, the FvName.map will be the default map file name\n");
133 fprintf (stdout
, " -g Guid, --guid Guid\n\
134 GuidValue is one specific capsule guid value\n\
135 or fv file system guid value.\n\
136 Its format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n");
137 fprintf (stdout
, " --FvNameGuid Guid Guid is used to specify Fv Name.\n\
138 Its format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n");
139 fprintf (stdout
, " --capflag CapFlag Capsule Reset Flag can be PersistAcrossReset,\n\
140 or PopulateSystemTable or InitiateReset or not set\n");
141 fprintf (stdout
, " --capheadsize HeadSize\n\
142 HeadSize is one HEX or DEC format value\n\
143 HeadSize is required by Capsule Image.\n");
144 fprintf (stdout
, " -c, --capsule Create Capsule Image.\n");
145 fprintf (stdout
, " -p, --dump Dump Capsule Image header.\n");
146 fprintf (stdout
, " -v, --verbose Turn on verbose output with informational messages.\n");
147 fprintf (stdout
, " -q, --quiet Disable all messages except key message and fatal error\n");
148 fprintf (stdout
, " -d, --debug level Enable debug messages, at input debug level.\n");
149 fprintf (stdout
, " --version Show program's version number and exit.\n");
150 fprintf (stdout
, " -h, --help Show this help message and exit.\n");
165 This utility uses GenFvImage.Lib to build a firmware volume image.
169 FvInfFileName The name of an FV image description file or Capsule Image.
171 Arguments come in pair in any order.
176 EFI_SUCCESS No error conditions detected.
177 EFI_INVALID_PARAMETER One or more of the input parameters is invalid.
178 EFI_OUT_OF_RESOURCES A resource required by the utility was unavailable.
179 Most commonly this will be memory allocation
181 EFI_LOAD_ERROR GenFvImage.lib could not be loaded.
182 EFI_ABORTED Error executing the GenFvImage lib.
196 EFI_CAPSULE_HEADER
*CapsuleHeader
;
197 UINT64 LogLevel
, TempNumber
;
209 CapsuleHeader
= NULL
;
215 Status
= EFI_SUCCESS
;
217 SetUtilityName (UTILITY_NAME
);
220 Error (NULL
, 0, 1001, "Missing options", "No input options specified.");
226 // Init global data to Zero
228 memset (&mFvDataInfo
, 0, sizeof (FV_INFO
));
229 memset (&mCapDataInfo
, 0, sizeof (CAP_INFO
));
231 // Set the default FvGuid
233 memcpy (&mFvDataInfo
.FvFileSystemGuid
, &mEfiFirmwareFileSystem2Guid
, sizeof (EFI_GUID
));
236 // Parse command line
241 if ((stricmp (argv
[0], "-h") == 0) || (stricmp (argv
[0], "--help") == 0)) {
244 return STATUS_SUCCESS
;
247 if (stricmp (argv
[0], "--version") == 0) {
249 return STATUS_SUCCESS
;
253 if ((stricmp (argv
[0], "-i") == 0) || (stricmp (argv
[0], "--inputfile") == 0)) {
254 InfFileName
= argv
[1];
255 if (InfFileName
== NULL
) {
256 Error (NULL
, 0, 1003, "Invalid option value", "Input file can't be null");
264 if ((stricmp (argv
[0], "-a") == 0) || (stricmp (argv
[0], "--addrfile") == 0)) {
265 AddrFileName
= argv
[1];
266 if (AddrFileName
== NULL
) {
267 Error (NULL
, 0, 1003, "Invalid option value", "Address file can't be null");
275 if ((stricmp (argv
[0], "-o") == 0) || (stricmp (argv
[0], "--outputfile") == 0)) {
276 OutFileName
= argv
[1];
277 if (OutFileName
== NULL
) {
278 Error (NULL
, 0, 1003, "Invalid option value", "Output file can't be null");
286 if ((stricmp (argv
[0], "-r") == 0) || (stricmp (argv
[0], "--baseaddr") == 0)) {
287 Status
= AsciiStringToUint64 (argv
[1], FALSE
, &TempNumber
);
288 if (EFI_ERROR (Status
)) {
289 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
292 mFvDataInfo
.BaseAddress
= TempNumber
;
293 mFvDataInfo
.BaseAddressSet
= TRUE
;
299 if ((stricmp (argv
[0], "-b") == 0) || (stricmp (argv
[0], "--blocksize") == 0)) {
300 Status
= AsciiStringToUint64 (argv
[1], FALSE
, &TempNumber
);
301 if (EFI_ERROR (Status
)) {
302 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
305 if (TempNumber
== 0) {
306 Error (NULL
, 0, 1003, "Invalid option value", "Fv block size can't be be set to zero");
309 mFvDataInfo
.FvBlocks
[0].Length
= (UINT32
) TempNumber
;
310 DebugMsg (NULL
, 0, 9, "FV Block Size", "%s = 0x%llx", EFI_BLOCK_SIZE_STRING
, (unsigned long long) TempNumber
);
316 if ((stricmp (argv
[0], "-n") == 0) || (stricmp (argv
[0], "--numberblock") == 0)) {
317 Status
= AsciiStringToUint64 (argv
[1], FALSE
, &TempNumber
);
318 if (EFI_ERROR (Status
)) {
319 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
322 if (TempNumber
== 0) {
323 Error (NULL
, 0, 1003, "Invalid option value", "Fv block number can't be set to zero");
326 mFvDataInfo
.FvBlocks
[0].NumBlocks
= (UINT32
) TempNumber
;
327 DebugMsg (NULL
, 0, 9, "FV Number Block", "%s = 0x%llx", EFI_NUM_BLOCKS_STRING
, (unsigned long long) TempNumber
);
333 if ((stricmp (argv
[0], "-f") == 0) || (stricmp (argv
[0], "--ffsfile") == 0)) {
334 if (argv
[1] == NULL
) {
335 Error (NULL
, 0, 1003, "Invalid option value", "Input Ffsfile can't be null");
338 strcpy (mFvDataInfo
.FvFiles
[Index
], argv
[1]);
339 DebugMsg (NULL
, 0, 9, "FV component file", "the %uth name is %s", (unsigned) Index
+ 1, argv
[1]);
344 if ((stricmp (argv
[0], "-s") == 0) || (stricmp (argv
[0], "--filetakensize") == 0)) {
345 if (argv
[1] == NULL
) {
346 Error (NULL
, 0, 1003, "Invalid option value", "Ffsfile Size can't be null");
349 Status
= AsciiStringToUint64 (argv
[1], FALSE
, &TempNumber
);
350 if (EFI_ERROR (Status
)) {
351 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
354 mFvDataInfo
.SizeofFvFiles
[Index
] = (UINT32
) TempNumber
;
355 DebugMsg (NULL
, 0, 9, "FV component file size", "the %uth size is %s", (unsigned) Index
+ 1, argv
[1]);
364 if ((stricmp (argv
[0], "-s") == 0) || (stricmp (argv
[0], "--filetakensize") == 0)) {
365 Error (NULL
, 0, 1003, "Invalid option", "It must be specified together with -f option to specify the file size.");
369 if ((stricmp (argv
[0], "-c") == 0) || (stricmp (argv
[0], "--capsule") == 0)) {
376 if (stricmp (argv
[0], "--capheadsize") == 0) {
378 // Get Capsule Image Header Size
380 Status
= AsciiStringToUint64 (argv
[1], FALSE
, &TempNumber
);
381 if (EFI_ERROR (Status
)) {
382 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
385 mCapDataInfo
.HeaderSize
= (UINT32
) TempNumber
;
386 DebugMsg (NULL
, 0, 9, "Capsule Header size", "%s = 0x%llx", EFI_CAPSULE_HEADER_SIZE_STRING
, (unsigned long long) TempNumber
);
392 if (stricmp (argv
[0], "--capflag") == 0) {
394 // Get Capsule Header
396 if (argv
[1] == NULL
) {
397 Error (NULL
, 0, 1003, "Option value is not set", "%s = %s", argv
[0], argv
[1]);
400 if (strcmp (argv
[1], "PopulateSystemTable") == 0) {
401 mCapDataInfo
.Flags
|= CAPSULE_FLAGS_PERSIST_ACROSS_RESET
| CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE
;
402 } else if (strcmp (argv
[1], "PersistAcrossReset") == 0) {
403 mCapDataInfo
.Flags
|= CAPSULE_FLAGS_PERSIST_ACROSS_RESET
;
404 } else if (strcmp (argv
[1], "InitiateReset") == 0) {
405 mCapDataInfo
.Flags
|= CAPSULE_FLAGS_PERSIST_ACROSS_RESET
| CAPSULE_FLAGS_INITIATE_RESET
;
407 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
410 DebugMsg (NULL
, 0, 9, "Capsule Flag", argv
[1]);
416 if (stricmp (argv
[0], "--capguid") == 0) {
418 // Get the Capsule Guid
420 Status
= StringToGuid (argv
[1], &mCapDataInfo
.CapGuid
);
421 if (EFI_ERROR (Status
)) {
422 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", EFI_CAPSULE_GUID_STRING
, argv
[1]);
425 DebugMsg (NULL
, 0, 9, "Capsule Guid", "%s = %s", EFI_CAPSULE_GUID_STRING
, argv
[1]);
431 if ((stricmp (argv
[0], "-g") == 0) || (stricmp (argv
[0], "--guid") == 0)) {
433 // Get the Capsule or Fv Guid
435 Status
= StringToGuid (argv
[1], &mCapDataInfo
.CapGuid
);
436 if (EFI_ERROR (Status
)) {
437 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", EFI_GUID_STRING
, argv
[1]);
440 memcpy (&mFvDataInfo
.FvFileSystemGuid
, &mCapDataInfo
.CapGuid
, sizeof (EFI_GUID
));
441 mFvDataInfo
.FvFileSystemGuidSet
= TRUE
;
442 DebugMsg (NULL
, 0, 9, "Capsule Guid", "%s = %s", EFI_CAPSULE_GUID_STRING
, argv
[1]);
443 DebugMsg (NULL
, 0, 9, "FV Guid", "%s = %s", EFI_FV_FILESYSTEMGUID_STRING
, argv
[1]);
449 if (stricmp (argv
[0], "--FvNameGuid") == 0) {
453 Status
= StringToGuid (argv
[1], &mFvDataInfo
.FvNameGuid
);
454 if (EFI_ERROR (Status
)) {
455 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", EFI_GUID_STRING
, argv
[1]);
458 mFvDataInfo
.FvNameGuidSet
= TRUE
;
459 DebugMsg (NULL
, 0, 9, "FV Name Guid", "%s = %s", EFI_FV_NAMEGUID_STRING
, argv
[1]);
465 if ((stricmp (argv
[0], "-p") == 0) || (stricmp (argv
[0], "--dump") == 0)) {
472 if ((stricmp (argv
[0], "-m") == 0) || (stricmp (argv
[0], "--map") == 0)) {
473 MapFileName
= argv
[1];
474 if (MapFileName
== NULL
) {
475 Error (NULL
, 0, 1003, "Invalid option value", "Map file can't be null");
483 if ((stricmp (argv
[0], "-v") == 0) || (stricmp (argv
[0], "--verbose") == 0)) {
484 SetPrintLevel (VERBOSE_LOG_LEVEL
);
485 VerboseMsg ("Verbose output Mode Set!");
491 if ((stricmp (argv
[0], "-q") == 0) || (stricmp (argv
[0], "--quiet") == 0)) {
492 SetPrintLevel (KEY_LOG_LEVEL
);
493 KeyMsg ("Quiet output Mode Set!");
499 if ((stricmp (argv
[0], "-d") == 0) || (stricmp (argv
[0], "--debug") == 0)) {
500 Status
= AsciiStringToUint64 (argv
[1], FALSE
, &LogLevel
);
501 if (EFI_ERROR (Status
)) {
502 Error (NULL
, 0, 1003, "Invalid option value", "%s = %s", argv
[0], argv
[1]);
506 Error (NULL
, 0, 1003, "Invalid option value", "Debug Level range is 0-9, current input level is %d", (int) LogLevel
);
509 SetPrintLevel (LogLevel
);
510 DebugMsg (NULL
, 0, 9, "Debug Mode Set", "Debug Output Mode Level %s is set!", argv
[1]);
517 // Don't recognize the parameter.
519 Error (NULL
, 0, 1000, "Unknown option", "%s", argv
[0]);
523 VerboseMsg ("%s tool start.", UTILITY_NAME
);
526 // check input parameter, InfFileName can be NULL
528 if (InfFileName
== NULL
&& DumpCapsule
) {
529 Error (NULL
, 0, 1001, "Missing option", "Input Capsule Image");
532 VerboseMsg ("the input FvInf or CapInf file name is %s", InfFileName
);
534 if (!DumpCapsule
&& OutFileName
== NULL
) {
535 Error (NULL
, 0, 1001, "Missing option", "Output File");
538 if (OutFileName
!= NULL
) {
539 VerboseMsg ("the output file name is %s", OutFileName
);
543 // Read the INF file image
545 if (InfFileName
!= NULL
) {
546 Status
= GetFileImage (InfFileName
, &InfFileImage
, &InfFileSize
);
547 if (EFI_ERROR (Status
)) {
553 VerboseMsg ("Dump the capsule header information for the input capsule image %s", InfFileName
);
555 // Dump Capsule Image Header Information
557 CapsuleHeader
= (EFI_CAPSULE_HEADER
*) InfFileImage
;
558 if (OutFileName
== NULL
) {
561 FpFile
= fopen (OutFileName
, "w");
562 if (FpFile
== NULL
) {
563 Error (NULL
, 0, 0001, "Error opening file", OutFileName
);
567 fprintf (FpFile
, "Capsule %s Image Header Information\n", InfFileName
);
568 fprintf (FpFile
, " GUID %08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X\n",
569 (unsigned) CapsuleHeader
->CapsuleGuid
.Data1
,
570 (unsigned) CapsuleHeader
->CapsuleGuid
.Data2
,
571 (unsigned) CapsuleHeader
->CapsuleGuid
.Data3
,
572 (unsigned) CapsuleHeader
->CapsuleGuid
.Data4
[0],
573 (unsigned) CapsuleHeader
->CapsuleGuid
.Data4
[1],
574 (unsigned) CapsuleHeader
->CapsuleGuid
.Data4
[2],
575 (unsigned) CapsuleHeader
->CapsuleGuid
.Data4
[3],
576 (unsigned) CapsuleHeader
->CapsuleGuid
.Data4
[4],
577 (unsigned) CapsuleHeader
->CapsuleGuid
.Data4
[5],
578 (unsigned) CapsuleHeader
->CapsuleGuid
.Data4
[6],
579 (unsigned) CapsuleHeader
->CapsuleGuid
.Data4
[7]);
580 fprintf (FpFile
, " Header size 0x%08X\n", (unsigned) CapsuleHeader
->HeaderSize
);
581 fprintf (FpFile
, " Flags 0x%08X\n", (unsigned) CapsuleHeader
->Flags
);
582 fprintf (FpFile
, " Capsule image size 0x%08X\n", (unsigned) CapsuleHeader
->CapsuleImageSize
);
584 } else if (CapsuleFlag
) {
585 VerboseMsg ("Create capsule image");
587 // Call the GenerateCapImage to generate Capsule Image
589 for (Index
= 0; mFvDataInfo
.FvFiles
[Index
][0] != '\0'; Index
++) {
590 strcpy (mCapDataInfo
.CapFiles
[Index
], mFvDataInfo
.FvFiles
[Index
]);
593 Status
= GenerateCapImage (
599 VerboseMsg ("Create Fv image and its map file");
600 if (mFvDataInfo
.BaseAddress
!= 0) {
601 VerboseMsg ("FvImage Rebase Address is 0x%llX", (unsigned long long) mFvDataInfo
.BaseAddress
);
604 // Call the GenerateFvImage to generate Fv Image
606 Status
= GenerateFvImage (
615 // free InfFileImage memory
617 if (InfFileImage
!= NULL
) {
622 // update boot driver address and runtime driver address in address file
624 if (Status
== EFI_SUCCESS
&& AddrFileName
!= NULL
&& mFvBaseAddressNumber
> 0) {
625 FpFile
= fopen (AddrFileName
, "w");
626 if (FpFile
== NULL
) {
627 Error (NULL
, 0, 0001, "Error opening file", AddrFileName
);
630 fprintf (FpFile
, FV_BASE_ADDRESS_STRING
);
631 fprintf (FpFile
, "\n");
632 for (Index
= 0; Index
< mFvBaseAddressNumber
; Index
++) {
636 (unsigned long long)mFvBaseAddress
[Index
]
643 if (Status
== EFI_SUCCESS
) {
644 DebugMsg (NULL
, 0, 9, "The Total Fv Size", "%s = 0x%x", EFI_FV_TOTAL_SIZE_STRING
, (unsigned) mFvTotalSize
);
645 DebugMsg (NULL
, 0, 9, "The used Fv Size", "%s = 0x%x", EFI_FV_TAKEN_SIZE_STRING
, (unsigned) mFvTakenSize
);
646 DebugMsg (NULL
, 0, 9, "The space Fv size", "%s = 0x%x", EFI_FV_SPACE_SIZE_STRING
, (unsigned) (mFvTotalSize
- mFvTakenSize
));
649 VerboseMsg ("%s tool done with return code is 0x%x.", UTILITY_NAME
, GetUtilityStatus ());
651 return GetUtilityStatus ();