BaseTools/UserManuals/VolInfo_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;}
   3 {\stylesheet{ Normal;}{\s1 heading 1;}{\s2 heading 2;}}
   4 {\*\generator Msftedit 5.41.15.1515;}\viewkind4\uc1\pard\keep\keepn\nowidctlpar\s2\sb400\sa60\sl-340\slmult0\tx360\tx1440\cf1\b\f0\fs28 Name\par
   5 \pard\nowidctlpar\li360\sb200\cf2\b0\fs18 VolInfo \endash  Displays the contents of a firmware volume\par
   6 \pard\keep\keepn\nowidctlpar\s2\sb400\sa60\sl-340\slmult0\tx360\tx1440\cf1\b\fs28 Synopsis\par
   7 \pard\nowidctlpar\li360\sb200\cf2\fs18 VolInfo [options] [target]\par
   8 \pard\keep\keepn\nowidctlpar\s2\sb400\sa60\sl-340\slmult0\tx360\tx1440\cf1\fs28 Description\par
   9 \pard\nowidctlpar\li360\sb200\cf2\b0\fs18 VolInfo is a utility which displays the contents of a firmware volume residing in a file for informational purposes.\par
  10 \pard\keep\keepn\nowidctlpar\s2\sb400\sa60\sl-340\slmult0\tx360\tx1440\cf1\b\fs28 Options\par
  11 \pard\nowidctlpar\li360\sb200\cf2\fs18 -x xref, --xref xref\par
  12 \pard\nowidctlpar\li720\sb200\b0 xref is the path to a file-guid cross reference file.  This file will be used to provide human readable names to the GUIDs found in the firmware volume.\par
  13 \pard\nowidctlpar\li360\sb200\b --offset offset\par
  14 \pard\nowidctlpar\li720\sb200\b0 offset is the offset within the file to start processing the firmware volume.  This can be useful if the specified disk file is a firmware device image which generally will contain multiple firmware volume.  The offset is a number and can be specified as a decimal number or a hexadecimal number  (for example, 0x1ffe).  If a 'k' suffix is attached to the number, then the number will be multiplied by 1024 (0x400) to turn the number into kilobytes.\par
  15 \pard\keep\keepn\nowidctlpar\s2\sb400\sa60\sl-340\slmult0\tx360\tx1440\cf1\b\fs28 Examples\par
  16 \pard\nowidctlpar\li360\sb200\cf2\b0\fs18 Assume that $(WORKSPACE) is /home/joeuser/src/edk2 and the firmware volumes have been built into Build/EdkUnix/DEBUG_UNIXGCC/FV.\par
  17 \pard\nowidctlpar\li720\sb200 ~/src/edk2$\b  VolInfo  Build/EdkUnix/DEBUG_UNIXGCC/FV/FVMAIN.fv\cf0\b0\f1\fs24\par
  18 \pard\nowidctlpar\li360\sb200\cf2\f0\fs18 Assuming that a firmware device image had been built and that the firmware volume of interest resided at byte offset 65536 of that file, then the following command would show that firmware volume.\par
  19 \pard\nowidctlpar\li720\sb200 ~/src/edk2$ \b VolInfo  --offset 65536 path/to/FV/EDKUNIX.fd\b0\f1\par
  20 \pard\nowidctlpar\li360\sb200\f0 Or, equivalently,\par
  21 \pard\nowidctlpar\li720\sb200 ~/src/edk2$ \b VolInfo  --offset 64k path/to/FV/EDKUNIX.fd\b0\f1\par
  22 \pard\nowidctlpar\li360\sb200\f0 Or, equivalently,\par
  23 \pard\nowidctlpar\li720\sb200 ~/src/edk2$ \b VolInfo  --offset 0x10000 path/to/FV/EDKUNIX.fd\b0\f1\par
  24 \pard\keep\keepn\nowidctlpar\s2\sb400\sa60\sl-340\slmult0\tx360\tx1440\cf1\b\f0\fs28 GuidedSectionTools.txt \par
  25 \pard\nowidctlpar\li360\sb200\cf2\b0\fs18 This (optional) file is built as part of the edk2 build process.  It will be generated in the FV directory alongside the firmware volume file.  The VolInfo utility will look for this file alongside the input firmware volume file, and if found it will read it's contents to define tools to use for extracting GUID defined firmware volume sections.\par
  26 Each line contains three tokens and they are separated by whitespace.  The three tokens are (in order): 1) the GUID associated with the tool, 2) a name for the tool, and 3) the path to the tool executable.  An example of a possible line from the file:\par
  27 \pard\nowidctlpar\li720\sb200 a31280ad-481e-41b6-95e8-127f4c984779 TIANO /path/to/TianoCompress\par
  28 \pard\keep\keepn\nowidctlpar\s2\sb400\sa60\sl-340\slmult0\tx360\tx1440\cf1\b\fs28 Files \par
  29 \pard\nowidctlpar\li360\sb200\cf2\b0\fs18 GuidedSectionTools.txt\par
  30 \pard\keep\keepn\nowidctlpar\s2\sb400\sa60\sl-340\slmult0\tx360\tx1440\cf1\b\fs28 Bugs \par
  31 \pard\nowidctlpar\li360\sb200\cf2\b0\fs18 No known bugs.\par
  32 Report bugs to edk2-buildtools-devel@lists.sourceforge.net\f1\par
  33 \pard\nowidctlpar\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Files \par
  34 \pard\nowidctlpar\li360\sb200\cf2\b0\fs18 GuidedSectionTools.txt\par
  35 \pard\keep\keepn\nowidctlpar\s2\sb400\sa60\sl-340\slmult0\tx360\tx1440\cf1\b\fs28 License\par
  36 \pard\nowidctlpar\li360\cf2\b0\fs18 Copyright (c) 1999 - 2009, Intel Corporation. All rights reserved.\par
  37 \par
  38 This program and the accompanying materials are licensed and made available under the terms and\par
  39 conditions of the BSD License which accompanies this distribution.  The full text of the license may be\par
  40 found at:\par
  41 http://opensource.org/licenses/bsd-license.php\par
  42 \par
  43 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES\par
  44 OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par
  45 \par
  46 \pard\nowidctlpar\li360\sb200\cf0\f1\fs24\par
  47 }
  48