projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 40d841f6 LG |
1 | {\rtf1\ansi\ansicpg1252\deff0\deflang1033\deflangfe2052\deftab360{\fonttbl{\f0\fswiss\fprq2\fcharset0 Verdana;}{\f1\froman\fprq2\fcharset0 Times New Roman;}}\r |
| 2 | {\colortbl ;\red8\green96\blue168;\red0\green0\blue0;\red255\green0\blue0;}\r | |
| 3 | {\stylesheet{ Normal;}{\s1 heading 1;}{\s2 heading 2;}}\r | |
| 4 | {\*\generator Msftedit 5.41.15.1515;}\viewkind4\uc1\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Name\par\r | |
| 5 | \pard\nowidctlpar\sb200\cf2\b0\fs18 GenFfs.exe \endash build one PI firmware file.\par\r | |
| 6 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 Synopsis\par\r | |
| 7 | \pard\nowidctlpar\sb200\cf2\fs18 GenFfs.exe [options]\b0\f1\par\r | |
| 8 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Description\par\r | |
| 9 | \pard\nowidctlpar\sb200\cf2\b0\fs18 GenFfs is used to generate FFS files for inclusion in a firmware volume. FFS file is the file system file for the firmware storage defined in the Volume 3 of the PI 1.0 specification. This utility is responsible for aggregating all of the file components into a single, correctly formed FFS file\par\r | |
| 10 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 Options\par\r | |
| 11 | \pard\nowidctlpar\sb200\cf2\fs18 -o FileName, --outputfile FileName\par\r | |
| 12 | \pard\nowidctlpar\li360\sb200\b0 The PI firmware file is created. This option is required.\par\r | |
| 13 | \pard\nowidctlpar\sb200\b -t Type, --filetype Type\par\r | |
| 14 | \pard\nowidctlpar\li360\sb200\b0 Type is one FV file type defined in PI spec, which is one type of EFI_FV_FILETYPE_RAW, EFI_FV_FILETYPE_FREEFORM, EFI_FV_FILETYPE_SECURITY_CORE, EFI_FV_FILETYPE_PEIM, EFI_FV_FILETYPE_PEI_CORE, EFI_FV_FILETYPE_DXE_CORE, EFI_FV_FILETYPE_DRIVER, EFI_FV_FILETYPE_APPLICATION, EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER, EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE. This option is required.\par\r | |
| 15 | \pard\nowidctlpar\sb200\b -g FileGuid, --fileguid FileGuid\par\r | |
| 16 | \pard\nowidctlpar\li360\sb200\b0 FileGuid is the unique identifier for this FFS file. Its format is 00000000-0000-0000-0000-000000000000. This option is required.\par\r | |
| 17 | \pard\nowidctlpar\sb200\b -x, --fixed\par\r | |
| 18 | \pard\nowidctlpar\li360\sb200\b0 Set fixed attribute in FFS file header to indicate that the file may not be moved from its present location.\par\r | |
| 19 | \pard\nowidctlpar\sb200\b -s, --checksum\par\r | |
| 20 | \pard\nowidctlpar\li360\sb200\b0 Set checksum attribute in FFS file header to calculate the whole file checksum.\par\r | |
| 21 | \pard\nowidctlpar\sb200\b -a FileAlign, --align FileAlign\par\r | |
| 22 | \pard\nowidctlpar\li360\sb200\b0 FileAlign specifies FFS file alignment, which only support the following alignment: 8,16,128,512,1K,4K,32K,64K.\par\r | |
| 23 | \pard\nowidctlpar\sb200\b -i SectionFile, --sectionfile SectionFile\par\r | |
| 24 | \pard\nowidctlpar\li360\sb200\b0 Section file will be read into this FFS file. This option is required.\par\r | |
| 25 | \pard\nowidctlpar\sb200\b -n SectionAlign, --sectionalign SectionAlign\par\r | |
| 26 | \pard\nowidctlpar\li360\sb200\b0 SectionAlign specifies this section file alignment in the FFS file, which support the alignment scope 1~64K. It is specified together with sectionfile parameter. \par\r | |
| 27 | \pard\nowidctlpar\sb200\b -v, --verbose\par\r | |
| 28 | \pard\nowidctlpar\fi360\sb200\b0 Turn on verbose output with informational messages.\par\r | |
| 29 | \pard\nowidctlpar\sb200\b --version\par\r | |
| 30 | \pard\nowidctlpar\fi360\sb200\b0 Show program's version number and exit\par\r | |
| 31 | \pard\nowidctlpar\sb200\b -h, --help\par\r | |
| 32 | \pard\nowidctlpar\fi360\sb200\b0 Show this help message and exit\par\r | |
| 33 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 Example\par\r | |
| 34 | \pard\nowidctlpar\sb200\cf2\b0\fs18 1. Generate PeiCore FFS file with the input sections, fileguid, and the output file name.\par\r | |
| 35 | \b GenFfs -t EFI_FV_FILETYPE_PEI_CORE -g 52C05B14-0B98-496c-BC3B-04B50211D680 -i PeiMain.pe32 -i PeiMain.ui -i PeiMain.ver -o 52C05B14-0B98-496c-BC3B-04B50211D680-PeiMain.ffs\par\r | |
| 36 | \b0 2. Generate PeiCore FFS file with the fixed, checksum attributes, the input sections with 16 byte alignment, the fileguid, and the output file name.\par\r | |
| 37 | \b GenFfs -t EFI_FV_FILETYPE_PEI_CORE -g 52C05B14-0B98-496c-BC3B-04B50211D680 \cf3\endash x \endash s\cf2 -i PeiMain.pe32 \cf3\endash n 16\cf2 -i PeiMain.ui -i PeiMain.ver -o 52C05B14-0B98-496c-BC3B-04B50211D680-PeiMain.ffs\par\r | |
| 38 | \b0 3. Generate RAW type FFS file with the input raw files, checksum attribute, fileguid, and the output file name. The RAW type FFS file doesn\rquote t care whether the input files are the formed section files or not.\par\r | |
| 39 | \b GenFfs \endash t EFI_FV_FILETYPE_RAW \endash g E8B33A4F-4C07-4e3f-A746-4A1E4036C5EC \endash s \endash i vendor.raw \endash o E8B33A4F-4C07-4e3f-A746-4A1E4036C5EC-vendor.raw\par\r | |
| 40 | \b0 4. Generate FV type FFS file with the input FV section file, checksum attribute, fileguid, and the output filename.\par\r | |
| 41 | \b GenFfs \endash t EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE \endash g 47C70572-CA18-455d-ABB9-B37FBA402AB2 \endash s \endash i fvmain.fvsec \endash o 47C70572-CA18-455d-ABB9-B37FBA402AB2-fvmain.ffs\par\r | |
| 42 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\fs28 Bugs\par\r | |
| 43 | \pard\nowidctlpar\sb200\cf2\b0\fs18 No known bugs.\par\r | |
| 44 | Report bugs to edk2-buildtools-devel@lists.sourceforge.net\f1\par\r | |
| 45 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Files\par\r | |
| 46 | \pard\nowidctlpar\sb200\cf2\b0\fs18 None\par\r | |
| 47 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 See also\par\r | |
| 48 | \pard\nowidctlpar\sb200\cf2\b0\fs18 None\par\r | |
| 49 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 License\par\r | |
| 50 | \pard\nowidctlpar\cf2\b0\fs18 Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.\par\r | |
| 51 | This program and the accompanying materials are licensed and made available \par\r | |
| 52 | under the terms and conditions of the BSD License which accompanies this \par\r | |
| 53 | distribution. The full text of the license may be found at\par\r | |
| 54 | http://opensource.org/licenses/bsd-license.php\par\r | |
| 55 | \par\r | |
| 56 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\par\r | |
| 57 | \pard\nowidctlpar\sb200 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par\r | |
| 58 | }\r | |
| 59 | \0 |