BaseTools/UserManuals/GenVtf_Utility_Man_Page.rtf

   1 {\rtf1\ansi\ansicpg1252\deff0\deflang1033\deflangfe2052\deftab360{\fonttbl{\f0\fswiss\fprq2\fcharset0 Verdana;}{\f1\froman\fprq2\fcharset0 Times New Roman;}}
   2 {\colortbl ;\red8\green96\blue168;\red0\green0\blue0;\red0\green127\blue127;}
   3 {\stylesheet{ Normal;}{\s1 heading 1;}{\s2 heading 2;}}
   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
   5 \pard\nowidctlpar\sb200\cf2\b0\fs18 GenVtf.exe - generate the Boot Strap File (AKA Volume Top File, or VTF) for IPF images\par
   6 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 Synopsis\par
   7 \pard\nowidctlpar\sb200\cf2\fs18 GenVtf.exe [options]\lang1036\b0\f1\par
   8 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\lang1033\b\f0\fs28 Description\par
   9 \pard\nowidctlpar\sb200\cf2\b0\fs18 GenVtf is used to generate the Boot Strap File (AKA Volume Top File, or VTF) for IPF images. This utility will parse the input BSF inf file and get the component information. If all the components which are required to put into a single VTF file, then only one VTF Base Address and Size will be needed and only one raw data output file and one symbol output file which is the symbol of raw data. If there\rquote s component which is required to put into the second VTF file but there\rquote s no second VTF Base Address and Size specified in command line interface, then this utility will exit with related error message; if there\rquote s second VTF Base Address and Size specified, then there are two raw data output files and one symbol output file.\par
  10 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 Options\cf3\f1\par
  11 \pard\nowidctlpar\sb200\cf2\f0\fs18 -f, --filename BS_INFFile\par
  12 \b0       Name of the BS Image INF file to use\par
  13 \b -r, --baseaddr hexaddress\par
  14 \b0       The Base Address is the starting address of the Firmware Volume where the Boot Strapped Image will reside\par
  15 \b -s, --size Size\par
  16 \b0       The size of the Firmware Volume\par
  17 \b  -o, --output Filename\par
  18 \b0       VTF Filename that will be created\par
  19 \b --version\par
  20 \b0\f1\tab\f0 Print version and copyright of this program and exit\par
  21 \b -v, --verbose\par
  22 \pard\nowidctlpar\li360\sb200\b0 Turn on verbose output with informational messages printed. This is a count value, so specifying \endash vv can be used to increase the verbosity level.\par
  23 \pard\nowidctlpar\sb200\b -q, --quiet\par
  24 \b0\f1\tab\f0 Disable all messages except FATAL ERRORS\par
  25 \b -d, --debug [#]\par
  26 \b0\f1\tab\f0 Enable debug messages, at level #\par
  27 \b -h, --help\par
  28 \b0\f1\tab\f0 Print copyright, version and usage of this program and exit\par
  29 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 Example\cf3\f1\par
  30 \pard\nowidctlpar\sb200\cf2\b0\f0\fs18 Generate one VTF file with inf file name, base address and size specified in command line and without output filename specified. So default filename \ldblquote VTF1.RAW\rdblquote  will be used.\par
  31 \b GenVtf \endash f bsf.inf \endash r 0xFFE00000 \endash s 0x200000\par
  32 \b0 Generate two VTF files with inf file name, base address and size specified in command line and without output filename specified. So default filename \ldblquote VTF1.RAW\rdblquote  and \ldblquote VTF2.RAW\rdblquote will be used.\par
  33 \b GenVtf \endash f bsf.inf \endash r 0xFFE00000 \endash s 0x200000 \endash r 0xFFD00000 \endash s 0x100000\par
  34 \b0 Generate one VTF file with inf file name, base address and size specified in command line and output filename specified.\par
  35 \b GenVtf \endash o file.tmp \endash f bsf.inf \endash r 0xFFE00000 \endash s 0x200000\par
  36 \b0 Generate two VTF files with inf file name, base address and size specified in command line and output filename specified.\par
  37 \b GenVtf \endash o file1.tmp \endash o file2.tmp \endash f bsf.inf \endash r 0xFFE00000 \endash s 0x200000 \endash r 0xFFD00000 \endash s 0x100000\par
  38 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\fs28 Bugs\cf3\f1\par
  39 \pard\nowidctlpar\sb200\cf2\b0\f0\fs18 No known bugs.\par
  40 Report bugs to edk2-buildtools-devel@lists.sourceforge.net\f1\par
  41 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Files\cf3\f1\par
  42 \pard\nowidctlpar\sb200\cf2\b0\f0\fs18 None\par
  43 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 See\cf3  \cf1 also\cf3\f1\par
  44 \pard\nowidctlpar\sb200\cf2\b0\f0\fs18 None\par
  45 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 License\cf3\f1\par
  46 \pard\nowidctlpar\cf2\b0\f0\fs18 Copyright (c) 1999 - 2009, Intel Corporation. All rights reserved.\par
  47 This program and the accompanying materials\par
  48 are licensed and made available under the terms and conditions of the BSD License\par
  49 which accompanies this distribution.  The full text of the license may be found at\par
  50 http://opensource.org/licenses/bsd-license.php\tab\par
  51 \par
  52 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\par
  53 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par
  54 \pard\nowidctlpar\sb200\f1\par
  55 }
  56