Updating ArmLib.h to add functions needed to turn on paging in CpuDxe. Also added...

[mirror_edk2.git] / BaseTools / UserManuals / GenPage_Utility_Man_Page.rtf

{\rtf1\adeflang1025\ansi\ansicpg1252\uc1\adeff0\deff0\stshfdbch13\stshfloch0\stshfhich0\stshfbi0\deflang1033\deflangfe2052{\fonttbl{\f0\froman\fcharset0\fprq2{\*\panose 02020603050405020304}Times New Roman{\*\falt Times New Roman};}{\f13\fnil\fcharset134\fprq2{\*\panose 02010600030101010101}SimSun{\*\falt SimSun};}\r
{\f38\fnil\fcharset134\fprq2{\*\panose 02010600030101010101}@SimSun;}{\f43\fswiss\fcharset0\fprq2{\*\panose 020b0604030504040204}Verdana{\*\falt Tahoma};}{\f147\froman\fcharset238\fprq2 Times New Roman CE{\*\falt Times New Roman};}\r
{\f148\froman\fcharset204\fprq2 Times New Roman Cyr{\*\falt Times New Roman};}{\f150\froman\fcharset161\fprq2 Times New Roman Greek{\*\falt Times New Roman};}{\f151\froman\fcharset162\fprq2 Times New Roman Tur{\*\falt Times New Roman};}\r
{\f152\fbidi \froman\fcharset177\fprq2 Times New Roman (Hebrew){\*\falt Times New Roman};}{\f153\fbidi \froman\fcharset178\fprq2 Times New Roman (Arabic){\*\falt Times New Roman};}\r
{\f154\froman\fcharset186\fprq2 Times New Roman Baltic{\*\falt Times New Roman};}{\f155\froman\fcharset163\fprq2 Times New Roman (Vietnamese){\*\falt Times New Roman};}{\f279\fnil\fcharset0\fprq2 SimSun Western{\*\falt SimSun};}\r
{\f529\fnil\fcharset0\fprq2 @SimSun Western;}{\f577\fswiss\fcharset238\fprq2 Verdana CE{\*\falt Tahoma};}{\f578\fswiss\fcharset204\fprq2 Verdana Cyr{\*\falt Tahoma};}{\f580\fswiss\fcharset161\fprq2 Verdana Greek{\*\falt Tahoma};}\r
{\f581\fswiss\fcharset162\fprq2 Verdana Tur{\*\falt Tahoma};}{\f584\fswiss\fcharset186\fprq2 Verdana Baltic{\*\falt Tahoma};}{\f585\fswiss\fcharset163\fprq2 Verdana (Vietnamese){\*\falt Tahoma};}}{\colortbl;\red0\green0\blue0;\red0\green0\blue255;\r
\red0\green255\blue255;\red0\green255\blue0;\red255\green0\blue255;\red255\green0\blue0;\red255\green255\blue0;\red255\green255\blue255;\red0\green0\blue128;\red0\green128\blue128;\red0\green128\blue0;\red128\green0\blue128;\red128\green0\blue0;\r
\red128\green128\blue0;\red128\green128\blue128;\red192\green192\blue192;\red8\green96\blue168;}{\stylesheet{\ql \li0\ri0\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \r
\fs24\lang1033\langfe2052\loch\f43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 \snext0 Normal;}{\s1\ql \li0\ri0\nowidctlpar\wrapdefault\faauto\outlinelevel0\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \r
\fs24\lang1033\langfe2052\loch\f43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 \sbasedon0 \snext0 heading 1;}{\s2\ql \li0\ri0\nowidctlpar\wrapdefault\faauto\outlinelevel1\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \r
\fs24\lang1033\langfe2052\loch\f43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 \sbasedon0 \snext0 heading 2;}{\*\cs10 \additive \ssemihidden Default Paragraph Font;}{\*\r
\ts11\tsrowd\trftsWidthB3\trpaddl108\trpaddr108\trpaddfl3\trpaddft3\trpaddfb3\trpaddfr3\tblind0\tblindtype3\tscellwidthfts0\tsvertalt\tsbrdrt\tsbrdrl\tsbrdrb\tsbrdrr\tsbrdrdgl\tsbrdrdgr\tsbrdrh\tsbrdrv \r
\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
{\*\latentstyles\lsdstimax156\lsdlockeddef0}{\*\rsidtbl \rsid5249883\rsid8653692}{\*\generator Microsoft Word 11.0.0000;}{\info{\operator lgao4}{\creatim\yr2008\mo12\dy31\hr15\min21}{\revtim\yr2009\mo5\dy22\hr10\min15}{\version3}{\edmins3}{\nofpages2}\r
{\nofwords263}{\nofchars1500}{\nofcharsws1760}{\vern24613}{\*\password 00000000}}{\*\xmlnstbl {\xmlns1 http://schemas.microsoft.com/office/word/2003/wordml}}\paperw12240\paperh15840\margl1800\margr1800\margt1440\margb1440\gutter0\ltrsect \r
\deftab360\widowctrl\ftnbj\aenddoc\donotembedsysfont0\donotembedlingdata1\grfdocevents0\validatexml0\showplaceholdtext0\ignoremixedcontent0\saveinvalidxml0\showxmlerrors0\horzdoc\dghspace120\dgvspace120\dghorigin1701\dgvorigin1984\dghshow0\dgvshow3\r
\jcompress\viewkind4\viewscale100\rsidroot5249883 \fet0{\*\wgrffmtfilter 013f}\ilfomacatclnup0\ltrpar \sectd \ltrsect\linex0\sectdefaultcl\sftnbj {\*\pnseclvl1\pnucrm\pnstart1\pnindent720\pnhang {\pntxta .}}{\*\pnseclvl2\r
\pnucltr\pnstart1\pnindent720\pnhang {\pntxta .}}{\*\pnseclvl3\pndec\pnstart1\pnindent720\pnhang {\pntxta .}}{\*\pnseclvl4\pnlcltr\pnstart1\pnindent720\pnhang {\pntxta )}}{\*\pnseclvl5\pndec\pnstart1\pnindent720\pnhang {\pntxtb (}{\pntxta )}}{\*\pnseclvl6\r
\pnlcltr\pnstart1\pnindent720\pnhang {\pntxtb (}{\pntxta )}}{\*\pnseclvl7\pnlcrm\pnstart1\pnindent720\pnhang {\pntxtb (}{\pntxta )}}{\*\pnseclvl8\pnlcltr\pnstart1\pnindent720\pnhang {\pntxtb (}{\pntxta )}}{\*\pnseclvl9\pnlcrm\pnstart1\pnindent720\pnhang \r
{\pntxtb (}{\pntxta )}}\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
\fs24\lang1033\langfe2052\loch\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af43\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid5249883 \hich\af43\dbch\af13\loch\f43 Name\r
\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\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \r
\fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43  GenPage.exe Options Filename\r
\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
\fs24\lang1033\langfe2052\loch\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af43\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid5249883 \hich\af43\dbch\af13\loch\f43 Description\r
\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\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \r
\fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 \r
The output of this tool is composed of two parts: the page table part and non-page table part. The latter is placed at the beginning of the output file while the former will be placed at the offset specified from option. Page table base address can also b\r
\hich\af43\dbch\af13\loch\f43 e\hich\af43\dbch\af13\loch\f43  specified by command line option.\r
\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
\fs24\lang1033\langfe2052\loch\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af43\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid5249883 \hich\af43\dbch\af13\loch\f43 Options\r
\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\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \r
\fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 [-f, --offset offset]\r
\par }\pard \ltrpar\ql \fi426\li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 The position that the page table will appear in the output file.\r
\par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 [-b, --baseaddr address]\tab \tab \tab \tab \tab \r
\par }\pard \ltrpar\ql \fi360\li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 The page table location.\r
\par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 -o, --output Filename\r
\par \tab \hich\af43\dbch\af13\loch\f43 The file that contains both non-page table part \hich\af43\dbch\af13\loch\f43 and page table.\r
\par }{\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \fs18\cf1\insrsid8653692 \hich\af43\dbch\af13\loch\f43  }{\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 [--version]\r
\par \tab \hich\af43\dbch\af13\loch\f43 Print version and copyright of this program and exit\r
\par \hich\af43\dbch\af13\loch\f43 [-v, --verbose]\r
\par }\pard \ltrpar\ql \li360\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin360\itap0 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 \r
Turn on verbose output with informational messages printed. This is a count value, so specifying \hich\f43 \endash \loch\f43 vv can be u\hich\af43\dbch\af13\loch\f43 sed to increase the verbosity level.\r
\par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 [-q, --quiet]\r
\par \tab \hich\af43\dbch\af13\loch\f43 disable all messages except FATAL ERRORS\r
\par \hich\af43\dbch\af13\loch\f43 [-d, --debug [#]]\r
\par \tab \hich\af43\dbch\af13\loch\f43 Enable debug messages, at level #\r
\par \hich\af43\dbch\af13\loch\f43 [-h, --help]\r
\par \tab \hich\af43\dbch\af13\loch\f43 Print copyright, version and usage of this program and exit\r
\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
\fs24\lang1033\langfe2052\loch\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af43\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid5249883 \hich\af43\dbch\af13\loch\f43 Example\r
\par }\pard\plain \ltrpar\ql \li60\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin60\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \fs24\lang1033\langfe2052\loch\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af43\afs18 \r
\ltrch\fcs0 \fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 1. c:\\Tools\\GenPage.exe \hich\f43 \endash \loch\f43 f 0\hich\af43\dbch\af13\loch\f43 x20000 \hich\f43 \endash \loch\f43 b 0x1000 \hich\f43 \endash \loch\f43 o loader.img loader.data\r
\r
\par \hich\af43\dbch\af13\loch\f43 The loader.data and a 4G range page table with base address 0x1000 will be put into loader.img file. The page table will be placed at offset 0x20000 of loader.img file.\r
\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
\fs24\lang1033\langfe2052\loch\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af43\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid5249883 \hich\af43\dbch\af13\loch\f43 Bugs\r
\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\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \r
\fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 Not found yet.\r
\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
\fs24\lang1033\langfe2052\loch\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af43\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid5249883 \hich\af43\dbch\af13\loch\f43 Files \r
\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\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \r
\fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 None.\r
\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
\fs24\lang1033\langfe2052\loch\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af43\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid5249883 \hich\af43\dbch\af13\loch\f43 See also\r
\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\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \r
\fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43  N\hich\af43\dbch\af13\loch\f43 one.\r
\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
\fs24\lang1033\langfe2052\loch\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af43\afs28 \ltrch\fcs0 \b\fs28\cf17\insrsid5249883 \hich\af43\dbch\af13\loch\f43 License\r
\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\af43\hich\af43\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \r
\fs18\cf1\insrsid5249883 \hich\af43\dbch\af13\loch\f43 Copyright (c)  1999-2009 Intel Corporation. All rights reserved\r
\par \hich\af43\dbch\af13\loch\f43 This program and the accompanying materials are licensed and made available \r
\par \hich\af43\dbch\af13\loch\f43 under the terms and conditions of the BSD License which accompanies this \r
\par \hich\af43\dbch\af13\loch\f43 distribution.  The full te\hich\af43\dbch\af13\loch\f43 xt of the license may be found at\r
\par \hich\af43\dbch\af13\loch\f43 http://opensource.org/licenses/bsd-license.php\r
\par \r
\par \hich\af43\dbch\af13\loch\f43 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\par }\pard \ltrpar\ql \li60\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin60\itap0 {\rtlch\fcs1 \af43\afs18 \ltrch\fcs0 \fs18\cf1\insrsid5249883 \r
\par }}