OVMF: Add support for saving the NV variables to disk following each SetVariable...
[edk2.git] / BaseTools / UserManuals / GenFv_Utility_Man_Page.rtf
blob90b3562dc0b2cddab36774429c67f070af8d4190
1 {\rtf1\adeflang1025\ansi\ansicpg936\uc2\adeff0\deff0\stshfdbch13\stshfloch0\stshfhich0\stshfbi0\deflang1033\deflangfe2052{\fonttbl{\f0\froman\fcharset0\fprq2{\*\panose 02020603050405020304}Times New Roman;}{\f13\fnil\fcharset134\fprq2{\*\panose 02010600030101010101}\'cb\'ce\'cc\'e5{\*\falt SimSun};}\r
2 {\f37\fswiss\fcharset0\fprq2{\*\panose 020b0604030504040204}Verdana;}{\f38\fnil\fcharset134\fprq2{\*\panose 02010600030101010101}@\'cb\'ce\'cc\'e5;}{\f39\froman\fcharset238\fprq2 Times New Roman CE;}{\f40\froman\fcharset204\fprq2 Times New Roman Cyr;}\r
3 {\f42\froman\fcharset161\fprq2 Times New Roman Greek;}{\f43\froman\fcharset162\fprq2 Times New Roman Tur;}{\f44\fbidi \froman\fcharset177\fprq2 Times New Roman (Hebrew);}{\f45\fbidi \froman\fcharset178\fprq2 Times New Roman (Arabic);}\r
4 {\f46\froman\fcharset186\fprq2 Times New Roman Baltic;}{\f47\froman\fcharset163\fprq2 Times New Roman (Vietnamese);}{\f171\fnil\fcharset0\fprq2 SimSun Western{\*\falt SimSun};}{\f409\fswiss\fcharset238\fprq2 Verdana CE;}\r
5 {\f410\fswiss\fcharset204\fprq2 Verdana Cyr;}{\f412\fswiss\fcharset161\fprq2 Verdana Greek;}{\f413\fswiss\fcharset162\fprq2 Verdana Tur;}{\f416\fswiss\fcharset186\fprq2 Verdana Baltic;}{\f417\fswiss\fcharset163\fprq2 Verdana (Vietnamese);}\r
6 {\f421\fnil\fcharset0\fprq2 @\'cb\'ce\'cc\'e5 Western;}}{\colortbl;\red0\green0\blue0;\red0\green0\blue255;\red0\green255\blue255;\red0\green255\blue0;\red255\green0\blue255;\red255\green0\blue0;\red255\green255\blue0;\red255\green255\blue255;\r
7 \red0\green0\blue128;\red0\green128\blue128;\red0\green128\blue0;\red128\green0\blue128;\red128\green0\blue0;\red128\green128\blue0;\red128\green128\blue128;\red192\green192\blue192;\red8\green96\blue168;}{\stylesheet{\r
8 \ql \li0\ri0\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\f37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 \snext0 Normal;}{\r
9 \s1\ql \li0\ri0\nowidctlpar\wrapdefault\faauto\outlinelevel0\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\f37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 \sbasedon0 \snext0 heading 1;}{\r
10 \s2\ql \li0\ri0\nowidctlpar\wrapdefault\faauto\outlinelevel1\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\f37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 \sbasedon0 \snext0 heading 2;}{\*\cs10 \r
11 \additive \ssemihidden Default Paragraph Font;}{\*\r
12 \ts11\tsrowd\trftsWidthB3\trpaddl108\trpaddr108\trpaddfl3\trpaddft3\trpaddfb3\trpaddfr3\trcbpat1\trcfpat1\tblind0\tblindtype3\tscellwidthfts0\tsvertalt\tsbrdrt\tsbrdrl\tsbrdrb\tsbrdrr\tsbrdrdgl\tsbrdrdgr\tsbrdrh\tsbrdrv \r
13 \ql \li0\ri0\widctlpar\wrapdefault\aspalpha\aspnum\faauto\adjustright\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs20 \ltrch\fcs0 \fs20\lang1024\langfe1024\loch\f0\hich\af0\dbch\af13\cgrid\langnp1024\langfenp1024 \snext11 \ssemihidden Normal Table;}}\r
14 {\*\latentstyles\lsdstimax156\lsdlockeddef0}{\*\rsidtbl \rsid5535427\rsid6904443\rsid7348251}{\*\generator Microsoft Word 11.0.0000;}{\info{\operator jwang36}{\creatim\yr2008\mo12\dy31\hr15\min9}{\revtim\yr2008\mo12\dy31\hr15\min18}{\version4}{\edmins9}\r
15 {\nofpages5}{\nofwords930}{\nofchars5304}{\nofcharsws6222}{\vern24613}{\*\password 00000000}}{\*\xmlnstbl {\xmlns1 http://schemas.microsoft.com/office/word/2003/wordml}{\xmlns2 urn:schemas-microsoft-com:office:smarttags}}\r
16 \paperw12240\paperh15840\margl1800\margr1800\margt1440\margb1440\gutter0\ltrsect \r
17 \deftab360\ftnbj\aenddoc\donotembedsysfont0\donotembedlingdata1\grfdocevents0\validatexml0\showplaceholdtext0\ignoremixedcontent0\saveinvalidxml0\showxmlerrors0\horzdoc\dghspace120\dgvspace120\dghorigin1701\dgvorigin1984\dghshow0\dgvshow3\r
18 \jcompress\viewkind4\viewscale100\rsidroot5535427 \fet0{\*\wgrffmtfilter 013f}\ilfomacatclnup0\ltrpar \sectd \ltrsect\linex0\sectdefaultcl\sftnbj {\*\pnseclvl1\pnucrm\pnstart1\pnindent720\pnhang {\pntxta \dbch .}}{\*\pnseclvl2\r
19 \pnucltr\pnstart1\pnindent720\pnhang {\pntxta \dbch .}}{\*\pnseclvl3\pndec\pnstart1\pnindent720\pnhang {\pntxta \dbch .}}{\*\pnseclvl4\pnlcltr\pnstart1\pnindent720\pnhang {\pntxta \dbch )}}{\*\pnseclvl5\pndec\pnstart1\pnindent720\pnhang {\pntxtb \dbch (}\r
20 {\pntxta \dbch )}}{\*\pnseclvl6\pnlcltr\pnstart1\pnindent720\pnhang {\pntxtb \dbch (}{\pntxta \dbch )}}{\*\pnseclvl7\pnlcrm\pnstart1\pnindent720\pnhang {\pntxtb \dbch (}{\pntxta \dbch )}}{\*\pnseclvl8\pnlcltr\pnstart1\pnindent720\pnhang {\pntxtb \dbch (}\r
21 {\pntxta \dbch )}}{\*\pnseclvl9\pnlcrm\pnstart1\pnindent720\pnhang {\pntxtb \dbch (}{\pntxta \dbch )}}\pard\plain \ltrpar\s2\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\keep\keepn\nowidctlpar\wrapdefault\faauto\outlinelevel1\rin0\lin-1440\itap0 \rtlch\fcs1 \r
22 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af37\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid6904443 \hich\af37\dbch\af13\loch\f37 Name\r
23 \par }\pard\plain \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \r
24 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 GenFv.exe \hich\f37 \endash \loch\f37  build one PI firmware volume image or one UEFI capsule image.\r
25 \par }\pard\plain \ltrpar\s2\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\keep\keepn\nowidctlpar\tx1440\wrapdefault\faauto\outlinelevel1\rin0\lin-1440\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \r
26 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af37\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid6904443 \hich\af37\dbch\af13\loch\f37 Synopsis\r
27 \par }\pard\plain \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af37\afs18 \r
28 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 GenFv.exe [options]}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \r
29 \par }\pard\plain \ltrpar\s2\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\keep\keepn\nowidctlpar\wrapdefault\faauto\outlinelevel1\rin0\lin-1440\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \r
30 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af37\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid6904443 \hich\af37\dbch\af13\loch\f37 Description\r
31 \par }\pard\plain \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \r
32 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 GenFv is used to }{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\insrsid6904443 \hich\af37\dbch\af13\loch\f37 \r
33 generate a PI firmware volume image or a UEFI capsule image from the PI firmware files or the binary files, which conforms to the firmware volume image format defined in PI specification or uefi capsule image format defined in UEFI specification.}{\r
34 \rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \r
35 \par \hich\af37\dbch\af13\loch\f37 This util\hich\af37\dbch\af13\loch\f37 \r
36 ity is responsible for aggregating Firmware File System (FFS) files into a single FV image.  The input files must be compliant with the PI 1.0 specification.  The utility will create a FV header, append all of the FFS input files, and optionally add the F\r
37 \hich\af37\dbch\af13\loch\f37 F\hich\af37\dbch\af13\loch\f37 S pad file for those FFS files that require the specific file alignment. When adding {\*\xmlopen\xmlns2{\factoidname place}}{\*\xmlopen\xmlns2{\factoidname State}}PEI{\*\xmlclose}{\*\xmlclose}\r
38  files or dxe drivers, it will relocate them to the fixed flash address or the prefered loaded memory address if necessary.  Also, one symbol map file that contains th\hich\af37\dbch\af13\loch\f37 e\hich\af37\dbch\af13\loch\f37 \r
39  symbol information (Function and Variable) for each driver in the FV will be produced. This utility is also responsible for aggregating the binary files into a single UEFI capsule image with the UEFI capsule header. \r
40 \par \hich\af37\dbch\af13\loch\f37 GenFv takes as input the path/filename\hich\af37\dbch\af13\loch\f37 \r
41  of the Fv.inf or Cap.inf file, the output file name, the starting physical address of the FV, the boot driver base address and the runtime driver base address of the address.inf file to create the final Fv or Capsule image. This utility is usually called\r
42 \hich\af37\dbch\af13\loch\f37  \hich\af37\dbch\af13\loch\f37 by GenFds tool, which parses platform.fdf file to create the interanl Fv.inf or Cap.inf. Generally, user doesn't need to care about these internal file format.\r
43 \par }\pard\plain \ltrpar\s2\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\keep\keepn\nowidctlpar\wrapdefault\faauto\outlinelevel1\rin0\lin-1440\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \r
44 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37  }{\rtlch\fcs1 \ab\af37\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid6904443 \r
45 \hich\af37\dbch\af13\loch\f37 Options\r
46 \par }\pard\plain \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af37\afs18 \r
47 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 -o FileName, --outputfile FileName\r
48 \par }\pard \ltrpar\ql \li360\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin360\itap0 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 The PI firmware volume image or Uefi Capsule image i\r
49 \hich\af37\dbch\af13\loch\f37 s created. This option is required.\r
50 \par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 -i FileName, --inputfile FileName}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \r
51 \fs18\cf1\insrsid6904443 \r
52 \par }\pard \ltrpar\ql \li360\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin360\itap0 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 \r
53 File is the input FV.inf or Cap.inf to specify how to construct FvImage or CapImage. Fv.inf and Cap.inf will be introduced in the following examples. File may be one capsule image whoes \hich\af37\dbch\af13\loch\f37 \r
54 header will be dumped. This option is required.\r
55 \par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0\pararsid7348251 {\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid7348251 \hich\af37\dbch\af13\loch\f37 -\hich\af37\dbch\af13\loch\f37 b\hich\af37\dbch\af13\loch\f37 \r
56  \hich\af37\dbch\af13\loch\f37 Block\hich\af37\dbch\af13\loch\f37 Size\hich\af37\dbch\af13\loch\f37 , --\hich\af37\dbch\af13\loch\f37 blocksize \hich\af37\dbch\af13\loch\f37 BlockSize}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid7348251 \r
57 \par \tab \hich\af37\dbch\af13\loch\f37 BlockSize is one HEX or DEC format of value required by FV image\hich\af37\dbch\af13\loch\f37 .\r
58 \par }{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid7348251 \hich\af37\dbch\af13\loch\f37 -\hich\af37\dbch\af13\loch\f37 f\hich\af37\dbch\af13\loch\f37  \hich\af37\dbch\af13\loch\f37 FfsFile\hich\af37\dbch\af13\loch\f37 , --\r
59 \hich\af37\dbch\af13\loch\f37 ffsfile\hich\af37\dbch\af13\loch\f37  \hich\af37\dbch\af13\loch\f37 FfsFile}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid7348251 \r
60 \par \tab \hich\af37\dbch\af13\loch\f37 FfsFile is placed into FV image. \hich\af37\dbch\af13\loch\f37 Multiple files can be input one by one\hich\af37\dbch\af13\loch\f37 .\r
61 \par }{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid7348251 \hich\af37\dbch\af13\loch\f37 -\hich\af37\dbch\af13\loch\f37 s\hich\af37\dbch\af13\loch\f37  \hich\af37\dbch\af13\loch\f37 FileTakeSize\hich\af37\dbch\af13\loch\f37 , --\r
62 \hich\af37\dbch\af13\loch\f37 filetakesize \hich\af37\dbch\af13\loch\f37 FileTakenSize}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid7348251 \r
63 \par \tab \hich\af37\dbch\af13\loch\f37 Specify \hich\af37\dbch\af13\loch\f37 the size\hich\af37\dbch\af13\loch\f37  of the required space that the input file is placed in FV image\hich\af37\dbch\af13\loch\f37 .\hich\af37\dbch\af13\loch\f37  I\r
64 \hich\af37\dbch\af13\loch\f37 t should be specified together with the input file.\r
65 \par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 -r Address, --baseaddr Address}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \r
66 \fs18\cf1\insrsid6904443 \r
67 \par \tab \hich\af37\dbch\af13\loch\f37 Address is the rebase start address for {\*\xmlopen\xmlns2{\factoidname place}}{\*\xmlopen\xmlns2{\factoidname State}}PEI{\*\xmlclose}{\*\xmlclose} drivers that run in Flash. It supports DEC or HEX digital format.\r
68 \par }{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 -a AddressFile, --addrfile AddressFile\r
69 \par \tab }{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 AddressFile is one file us\hich\af37\dbch\af13\loch\f37 \r
70 ed to log boot driver base address and runtime driver base address. And this tool will update these two addresses after it \tab relocates all boot drivers and runtime drivers in this fv image to the preferred loaded memory address.\r
71 \par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0\pararsid7348251 {\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid7348251 \hich\af37\dbch\af13\loch\f37 -\hich\af37\dbch\af13\loch\f37 g\hich\af37\dbch\af13\loch\f37 \r
72  \hich\af37\dbch\af13\loch\f37 Guid\hich\af37\dbch\af13\loch\f37 , --\hich\af37\dbch\af13\loch\f37 capguid \hich\af37\dbch\af13\loch\f37 Guid}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid7348251 \r
73 \par \tab \hich\af37\dbch\af13\loch\f37 Specify GUID value of specific capsule or FV vendor\hich\af37\dbch\af13\loch\f37  in the format of }{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid7348251\charrsid7348251 \hich\af37\dbch\af13\loch\f37 \r
74 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid7348251 \hich\af37\dbch\af13\loch\f37 .\r
75 \par }{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid7348251 \hich\af37\dbch\af13\loch\f37 --\hich\af37\dbch\af13\loch\f37 capflag \hich\af37\dbch\af13\loch\f37 CapFlag}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid7348251 \r
76 \par \tab \hich\af37\dbch\af13\loch\f37 Specify capsule reset flag (PersistAcrossReset, PopulateSystemTable or none)\hich\af37\dbch\af13\loch\f37 .\r
77 \par }{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid7348251 \hich\af37\dbch\af13\loch\f37 --\hich\af37\dbch\af13\loch\f37 capheadsize HeadSize}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid7348251 \r
78 \par \tab \hich\af37\dbch\af13\loch\f37 Specify head size for capsule image in the format of HEX or DEC\hich\af37\dbch\af13\loch\f37 .\r
79 \par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 -p, --dump}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \r
81 \par \tab \hich\af37\dbch\af13\loch\f37 Dump a capsule i\hich\af37\dbch\af13\loch\f37 mage header.\r
82 \par }{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 -m logfile, --map logfile}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \r
83 \par \tab \hich\af37\dbch\af13\loch\f37 Logfile is the output Fv map file. If this option is not given, the FvName.map will be the default fv map file name.}{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \r
84 \par \hich\af37\dbch\af13\loch\f37 -c, --capsule}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \r
85 \par \tab \hich\af37\dbch\af13\loch\f37 Create Uefi capsule image.\r
86 \par }{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 -v, --verbose\r
87 \par }{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \tab \hich\af37\dbch\af13\loch\f37 Turn on verbose output\hich\af37\dbch\af13\loch\f37  with informational messages.\r
88 \par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0\pararsid6904443 {\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 -\hich\af37\dbch\af13\loch\f37 d\hich\af37\dbch\af13\loch\f37 \r
89 , --\hich\af37\dbch\af13\loch\f37 debug level\r
90 \par }{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \tab \hich\af37\dbch\af13\loch\f37 Enable debug message with specified level\hich\af37\dbch\af13\loch\f37 .\r
91 \par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 --version\r
92 \par }\pard \ltrpar\ql \fi360\li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 Show program's version number and exit\r
93 \par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 -h, --help\r
94 \par }\pard \ltrpar\ql \fi360\li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 Show this help message and exit\r
95 \par }\pard\plain \ltrpar\s2\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\keep\keepn\nowidctlpar\wrapdefault\faauto\outlinelevel1\rin0\lin-1440\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \r
96 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af37\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid6904443 \hich\af37\dbch\af13\loch\f37 Example\r
97 \par }\pard\plain \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \r
98 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 1. Generate BFV that contains {\*\xmlopen\xmlns2{\factoidname State}}{\*\xmlopen\xmlns2{\factoidname State}}PEI{\*\xmlclose}{\*\xmlclose}\r
99  drivers in Flash with the input FV.inf, base address, and the output file name.\r
100 \par }{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 GenFv -i FvR\hich\af37\dbch\af13\loch\f37 ecovery.inf -o FvRecovery.fv -r 0xFFFD0000\r
101 \par }{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 FvRecovery.inf\r
102 \par \hich\af37\dbch\af13\loch\f37 [options]\r
103 \par \hich\af37\dbch\af13\loch\f37 EFI_BLOCK_SIZE = 0x10000           #required option\r
104 \par \hich\af37\dbch\af13\loch\f37 EFI_NUM_BLOCKS   =  0x3\r
105 \par \hich\af37\dbch\af13\loch\f37 EFI_BASE_ADDRESS = 0xFFFD0000 #optional, if command line -r is not specified, this option will be used.\r
106 \par \hich\af37\dbch\af13\loch\f37 [attribu\hich\af37\dbch\af13\loch\f37 tes]\r
107 \par \hich\af37\dbch\af13\loch\f37 EFI_ERASE_POLARITY   =  1\r
108 \par \hich\af37\dbch\af13\loch\f37 EFI_WRITE_ENABLED_CAP = TRUE\r
109 \par \hich\af37\dbch\af13\loch\f37 EFI_READ_ENABLED_CAP = TRUE\r
110 \par \hich\af37\dbch\af13\loch\f37 EFI_READ_LOCK_STATUS = TRUE\r
111 \par \hich\af37\dbch\af13\loch\f37 EFI_WRITE_STATUS = TRUE\r
112 \par \hich\af37\dbch\af13\loch\f37 EFI_READ_DISABLED_CAP = TRUE\r
113 \par \hich\af37\dbch\af13\loch\f37 EFI_WRITE_LOCK_STATUS = TRUE\r
114 \par \hich\af37\dbch\af13\loch\f37 EFI_LOCK_CAP = TRUE\r
115 \par \hich\af37\dbch\af13\loch\f37 EFI_LOCK_STATUS = TRUE\r
116 \par \hich\af37\dbch\af13\loch\f37 EFI_ERASE_POLAR\hich\af37\dbch\af13\loch\f37 ITY = 1\r
117 \par \hich\af37\dbch\af13\loch\f37 EFI_MEMORY_MAPPED = TRUE\r
118 \par \hich\af37\dbch\af13\loch\f37 EFI_READ_LOCK_CAP = TRUE\r
119 \par \hich\af37\dbch\af13\loch\f37 EFI_WRITE_DISABLED_CAP = TRUE\r
120 \par \hich\af37\dbch\af13\loch\f37 EFI_READ_STATUS = TRUE\r
121 \par \hich\af37\dbch\af13\loch\f37 EFI_WRITE_LOCK_CAP = TRUE\r
122 \par \hich\af37\dbch\af13\loch\f37 EFI_STICKY_WRITE = TRUE\r
123 \par \hich\af37\dbch\af13\loch\f37 EFI_FVB2_ALIGNMENT_16 = TRUE\r
124 \par \hich\af37\dbch\af13\loch\f37 [files]\r
125 \par \hich\af37\dbch\af13\loch\f37 EFI_FILE_NAME = K:\\Build\\NT32\\DEBUG_MYTOOLS\\Fv\\Ffs\\\hich\af37\dbch\af13\loch\f37 52C05B14-0B98-496c-BC3B-04B50211D680PeiMain\\52C05B14-0B98-496c-BC3B-04B50211D680.ffs\r
126 \par \hich\af37\dbch\af13\loch\f37 EFI_FILE_NAME = K:\\Build\\NT32\\DEBUG_MYTOOLS\\Fv\\Ffs\\9B3ADA4F-AE56-4c24-8DEA-F03B7558AE50PcdPeim\\9B3ADA4F-AE56-4c24-8DEA-F03B7558AE50.ffs\r
127 \par \hich\af37\dbch\af13\loch\f37 ......}{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \r
128 \par }{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 2. Generate FvMain that cont\hich\af37\dbch\af13\loch\f37 \r
129 ains Dxe drivers loaded in the preferred loaded memory address with the input FV.inf, address file, and the output file name.\r
130 \par }{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 GenFv -i FvMain.inf -o FvMain.fv -a Addr.inf\r
131 \par }{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 Addr.inf}{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \r
132 \par }{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 [options]\r
133 \par \hich\af37\dbch\af13\loch\f37 EFI_BOOT_DRIVER_BASE_ADDRESS = 0x1f300000\r
134 \par \hich\af37\dbch\af13\loch\f37 EFI_RUNTIME_DRIVER_BASE_\hich\af37\dbch\af13\loch\f37 ADDRESS = 0x1f600000}{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \r
135 \par }{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 3. Generate the capsule image with the input cap.inf, and the output file name.\r
136 \par }{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 GenFv -i BiosUpdate.inf -o BiosUpdate.cap\r
137 \par }{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 BiosUpdate.inf}{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \r
138 \par }{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 [options]\r
139 \par \hich\af37\dbch\af13\loch\f37 EFI_CAPSULE_GUID                = 25A5CD7D-A5EB-4d74-9C28-D6EF04E03B16 (Required)\r
140 \par \hich\af37\dbch\af13\loch\f37 EFI_CA\hich\af37\dbch\af13\loch\f37 PSULE_HEADER_SIZE  = 0x20                                                                (Optional)\r
141 \par \hich\af37\dbch\af13\loch\f37 EFI_CAPSULE_FLAGS              = PopulateSystemTable                                      (Optional)\r
142 \par \hich\af37\dbch\af13\loch\f37 [attributes]\r
143 \par \hich\af37\dbch\af13\loch\f37 [files]\r
144 \par \hich\af37\dbch\af13\loch\f37 EFI_FILE_NAME = K:\\Build\\NT32\\DEBU\hich\af37\dbch\af13\loch\f37 G_MYTOOLS\\Fv\\Ffs\\EDBEDF47-6EA3-4512-83C1-70F4769D4BDE-Capsule_A.fvi\r
145 \par \hich\af37\dbch\af13\loch\f37 3. Dump capsule image header information for the input capsule image.\r
146 \par }{\rtlch\fcs1 \ab\af37\afs18 \ltrch\fcs0 \b\fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 GenFv -p -i BiosUpdate.cap -o Cap.info}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \r
147 \par }\pard\plain \ltrpar\s2\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\keep\keepn\nowidctlpar\wrapdefault\faauto\outlinelevel1\rin0\lin-1440\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \r
148 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af37\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid6904443 \hich\af37\dbch\af13\loch\f37 Bugs\r
149 \par }\pard\plain \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \r
150 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 No known bugs.\r
151 \par \hich\af37\dbch\af13\loch\f37 Report bugs to issues@buildtools.tianocore.org\r
152 \par }\pard\plain \ltrpar\s2\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\keep\keepn\nowidctlpar\wrapdefault\faauto\outlinelevel1\rin0\lin-1440\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \r
153 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af37\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid6904443 \hich\af37\dbch\af13\loch\f37 Files\r
154 \par }\pard\plain \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \r
155 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 None\r
156 \par }\pard\plain \ltrpar\s2\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\keep\keepn\nowidctlpar\wrapdefault\faauto\outlinelevel1\rin0\lin-1440\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \r
157 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af37\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid6904443 \hich\af37\dbch\af13\loch\f37 See also\r
158 \par }\pard\plain \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \r
159 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 None\r
160 \par }\pard\plain \ltrpar\s2\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\keep\keepn\nowidctlpar\wrapdefault\faauto\outlinelevel1\rin0\lin-1440\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \r
161 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af37\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid6904443 \hich\af37\dbch\af13\loch\f37 License\r
162 \par }\pard\plain \ltrpar\ql \li0\ri0\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\af37\hich\af37\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \r
163 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 Copyright (c) 2007}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid5535427 \hich\af37\dbch\af13\loch\f37 -2009}{\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \r
164 \hich\af37\dbch\af13\loch\f37  Intel Corporation. All rights reserved\r
165 \par \hich\af37\dbch\af13\loch\f37 This program and the accompanying materials are licensed and made available \r
166 \par \hich\af37\dbch\af13\loch\f37 under the terms and conditions of the BSD License which accompanies this \r
167 \par \hich\af37\dbch\af13\loch\f37 distribution.  The full t\hich\af37\dbch\af13\loch\f37 ext of the license may be found at\r
168 \par \hich\af37\dbch\af13\loch\f37 http://opensource.org/licenses/bsd-license.php\r
169 \par \r
170 \par \hich\af37\dbch\af13\loch\f37 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
171 \par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af37\afs18 \ltrch\fcs0 \fs18\cf1\insrsid6904443 \hich\af37\dbch\af13\loch\f37 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
173 \par }}