66e7cc4f59f92409bea5acae9f9a0c1209510d30
[people/mcb30/edk2.git] / www / installation.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">\r
2 <HTML>\r
3 <HEAD>\r
4         <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">\r
5         <TITLE>EDK II Installation Guide</TITLE>\r
6         <META NAME="GENERATOR" CONTENT="OpenOffice.org 2.0  (Win32)">\r
7         <META NAME="CREATED" CONTENT="20060512;12074440">\r
8         <META NAME="CHANGEDBY" CONTENT="Bruce Bahnsen">\r
9         <META NAME="CHANGED" CONTENT="20060706;14380303">\r
10         <STYLE>\r
11         <!--\r
12                 H3.heading-2 { font-size: 18pt }\r
13         -->\r
14         </STYLE>\r
15 </HEAD>\r
16 <BODY LANG="en-US" DIR="LTR">\r
17 <H1>Getting and installing the required tools for building the EDK II</H1>\r
18 <H3 CLASS="heading-2">Table of Contents</H3>\r
19 <UL>\r
20         <LI><P><A HREF="#Requirements">Requirements</A> \r
21         </P>\r
22 </UL>\r
23 <H3 CLASS="heading-2"><A NAME="Requirements"></A>Requirements</H3>\r
24 <DIV ID="requirements" DIR="LTR"><A NAME="requirements_table"></A>\r
25   <UL>\r
26     <LI>An IA32 or X64 Based Development Workstation (IPF Workstations are not supported)</LI>\r
27     <LI>Microsoft Windows XP or Vista, Apple Mac OS/X (10.4 or later) or Linux Operating System</LI>\r
28     <LI>Disk Space for compiler tools</LI>\r
29     <LI>Minimum of 1GB of Disk Space for edk2 development tree and output files</LI>\r
30     <LI>Minimum of 512MB (1GB recommended) of system memory </LI>\r
31   </UL>\r
32   <P>The following are required to be able to build the EDK II using the new Makefile build:</P>\r
33         <TABLE BORDER=1 CELLPADDING=1 CELLSPACING=0>\r
34                 <TR>\r
35                         <TH>\r
36                                 <P STYLE="border: none; padding: 0in"><FONT COLOR="#ffffff">Name</FONT></P>\r
37                         </TH>\r
38                         <TH>\r
39                                 <P STYLE="border: none; padding: 0in"><FONT COLOR="#ffffff">Version</FONT></P>\r
40                         </TH>\r
41                         <TH>\r
42                                 <P STYLE="border: none; padding: 0in"><FONT COLOR="#ffffff">URL</FONT></P>\r
43                         </TH>\r
44                 </TR>\r
45                 <TR>\r
46                         <TD>\r
47                                 <P ALIGN=CENTER><B>TortoiseSVN</B></P>\r
48                         </TD>\r
49                         <TD>\r
50                                 <P ALIGN=CENTER><B>1.4.5</B></P>\r
51                         </TD>\r
52                         <TD>\r
53                                 <P ALIGN=CENTER><A HREF="http://prdownloads.sourceforge.net/tortoisesvn/TortoiseSVN-1.4.5.10425-win32-svn-1.4.5.msi?download">http://prdownloads.sourceforge.net/tortoisesvn/TortoiseSVN-1.4.5.10425-win32-svn-1.4.5.msi</A></P>\r
54                         </TD>\r
55                 </TR>\r
56 \r
57     <!-- Removed ANT/JAVA information -->\r
58 \r
59         </TABLE>\r
60         <P><BR><BR>\r
61         </P>\r
62         <P>The following tools are optional:<BR>\r
63   <FONT SIZE="1">At least one compiler tool chain will be required</FONT></P>\r
64         <DIV ID="Section1" DIR="LTR"><A NAME="requirements"></A><A NAME="requirements_table1"></A>\r
65                 <TABLE BORDER=1 CELLPADDING=1 CELLSPACING=0>\r
66                         <TR>\r
67                                 <TH>\r
68                                         <P STYLE="border: none; padding: 0in"><FONT COLOR="#ffffff">Name</FONT></P>\r
69                                 </TH>\r
70                                 <TH>\r
71                                         <P STYLE="border: none; padding: 0in"><FONT COLOR="#ffffff">Version</FONT></P>\r
72                                 </TH>\r
73                                 <TH>\r
74                                         <P STYLE="border: none; padding: 0in"><FONT COLOR="#ffffff">URL</FONT></P>\r
75                                 </TH>\r
76                         </TR>\r
77                         <TR>\r
78                                 <TD>\r
79                                         <P ALIGN=CENTER><B>Cygwin</B><sup>1</sup></P>\r
80                                 </TD>\r
81                                 <TD>\r
82                                         <P ALIGN=CENTER><B>Current</B></P>\r
83                                 </TD>\r
84                                 <TD>\r
85                                         <P ALIGN=CENTER><A HREF="http://www.cygwin.com/">http://www.cygwin.com</A>\r
86           </P>\r
87                                 </TD>\r
88                         </TR>\r
89                         <TR>\r
90                                 <TD>\r
91                                         <P ALIGN=CENTER><B>Microsoft Visual Studio</B><sup>2</sup></P>\r
92                                 </TD>\r
93                                 <TD>\r
94                                         <P ALIGN=CENTER><B>2005 Professional</B>\r
95                                         </P>\r
96                                 </TD>\r
97                                 <TD>\r
98                                         <P ALIGN=CENTER><A HREF="http://www.intel.com/">http://www.intel.com</A></P>\r
99                                 </TD>\r
100                         </TR>\r
101                         <TR>\r
102                                 <TD>\r
103                                         <P ALIGN=CENTER><B>Microsoft Visual Studio</B><sup>3</sup></P>\r
104                                 </TD>\r
105                                 <TD>\r
106                                         <P ALIGN=CENTER><B>2005 Team Suite</B>\r
107                                         </P>\r
108                                 </TD>\r
109                                 <TD>\r
110                                         <P ALIGN=CENTER><A HREF="http://www.intel.com/">http://www.intel.com</A></P>\r
111                                 </TD>\r
112                         </TR>\r
113                         <TR>\r
114                                 <TD>\r
115                                         <P ALIGN=CENTER><B>Microsoft Visual Studio</B></P>\r
116                                 </TD>\r
117                                 <TD>\r
118                                         <P ALIGN=CENTER><B>2003 .NET</B>\r
119                                         </P>\r
120                                 </TD>\r
121                                 <TD>\r
122                                         <P ALIGN=CENTER><A HREF="http://www.intel.com/">http://www.intel.com</A></P>\r
123                                 </TD>\r
124                         </TR>\r
125                         <TR>\r
126                                 <TD>\r
127                                         <P ALIGN=CENTER><B>Intel C++ Compiler for Windows</B></P>\r
128                                 </TD>\r
129                                 <TD>\r
130                                         <P ALIGN=CENTER><B>9.1</B>\r
131                                         </P>\r
132                                 </TD>\r
133                                 <TD>\r
134                                         <P ALIGN=CENTER><A HREF="http://www.intel.com/">http://www.intel.com</A></P>\r
135                                 </TD>\r
136                         </TR>\r
137                         <TR>\r
138                                 <TD>\r
139                                         <P ALIGN=CENTER><B>Intel C Compiler for EFI Byte Code</B></P>\r
140                                 </TD>\r
141                                 <TD>\r
142                                         <P ALIGN=CENTER><B>1.2</B></P>\r
143                                 </TD>\r
144                                 <TD>\r
145                                         <P ALIGN=CENTER><A HREF="http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm">http://www.intel.com/cd/software/products</A><BR><A HREF="http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm">/asmo-na/eng/compilers/efibc/index.htm</A></P>\r
146                                 </TD>\r
147                         </TR>\r
148                         <TR>\r
149                                 <TD>\r
150                                         <P ALIGN=CENTER><B>Microsoft Driver Development Kit (DDK)</B><sup>4</sup></P>\r
151                                 </TD>\r
152                                 <TD>\r
153                                         <P ALIGN=CENTER><B>3790.1830</B></P>\r
154                                 </TD>\r
155                                 <TD>\r
156                                         <P ALIGN=CENTER><A HREF="http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx">http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx</A></P>\r
157                                 </TD>\r
158                         </TR>\r
159                         <TR>\r
160                                 <TD>\r
161                                         <P ALIGN=CENTER><B>Microsoft ACPI Source Language Assembler</B></P>\r
162                                 </TD>\r
163                                 <TD>\r
164                                         <P ALIGN=CENTER><B>3.0.0NT or later</B></P>\r
165                                 </TD>\r
166                                 <TD>\r
167                                         <P ALIGN=CENTER><A HREF="http://www.microsoft.com/whdc/system/pnppwr/powermgmt/default.mspx">\r
168               http://www.microsoft.com/whdc/system/pnppwr/powermgmt/default.mspx</A></P>\r
169                                 </TD>\r
170                         </TR>\r
171                         <TR>\r
172                                 <TD>\r
173                                         <P ALIGN=CENTER><B>Intel ACPI Component Architecture</B></P>\r
174                                 </TD>\r
175                                 <TD>\r
176                                         <P ALIGN=CENTER><B>20060113 or later</B></P>\r
177                                 </TD>\r
178                                 <TD>\r
179                                         <P ALIGN=CENTER><A HREF="http://www.intel.com/technology/iapc/acpi/downloads.htm">http://www.intel.com/technology/iapc/acpi/downloads.htm</A></P>\r
180                                 </TD>\r
181                         </TR>\r
182       <TR>\r
183         <TD ALIGN=LEFT COLSPAN=3>\r
184           <Sup>1</Sup><FONT SIZE="1">&nbsp;Instructions for installation of GCC are included in the BaseTools\Conf directory.</FONT><BR>\r
185           <Sup>2</Sup><FONT SIZE="1">&nbsp;The default tool chain for the IA32 and X64 builds</FONT><BR>\r
186           <Sup>3</Sup><FONT SIZE="1">&nbsp;Needed for building IPF targets if the DDK is not installed.</FONT><BR>\r
187           <Sup>4</Sup><FONT SIZE="1">&nbsp;The default tool chain for IPF builds.</FONT></TD>\r
188       </TR>\r
189                 </TABLE>\r
190     <BR>\r
191                 <H3 CLASS="heading-2">Install and Configure Tools on Windows XP or Windows Vista</H3>\r
192                 <H3>Software Installation Order</H3>\r
193                 <P>After installing the compiler tools and your Subversion client,\r
194                 download the edk2, read the BuildNotes2.txt file and you will be\r
195     ready to build and image.</P> \r
196     <P>All builds are started from a command prompt window.</P>\r
197     <H3>Cygwin</H3>\r
198                 <P>If you optionally install cygwin (for gcc support) you should\r
199                 install it in &quot;Unix&quot; mode. The gcc tool chain will not\r
200                 compile in &quot;DOS&quot; mode.</P>\r
201                 <H3 CLASS="heading-2">Environment Variables</H3>\r
202                 <P>Environment variables are <B>case sensitive</B>. You must use\r
203                 the exact case as in the examples of this document. Even though\r
204                 windows does not care about case, other operating systems that\r
205     are supported do care about case.<BR><BR>You need to set\r
206                 WORKSPACE to the location of the edk2 directory that you pulled\r
207                 from Subversion. For example</P>\r
208                 <PRE STYLE="margin-bottom: 0.2in">set WORKSPACE=c:\workspace\edk2</PRE><P>\r
209                 It is recommended that you wrap up all the environment variables\r
210                 above into a script that you can launch each time you begin to do\r
211                 development in your EDK II workspace.</P>\r
212                 <H3 CLASS="heading-2">The first build</H3>\r
213                 <P>You will need to edit the text file, tools_def.txt, located\r
214                 in the %WORKSPACE%\Conf directory. This file contains the names of the\r
215                 compiler tool chains and the location of the compiler binaries. It\r
216                 has been pre-populated with the standard location for the Microsoft\r
217                 tool chains and includes the standard location of the Intel C\r
218                 Compiler for EFI Byte Code (EBC).</P>\r
219                 <P>Once the external tools are installed, the environment variables\r
220                 are set, and you have the ant executable in your path, you can try\r
221                 a build.</P>\r
222                 <OL>\r
223                         <LI><P STYLE="margin-bottom: 0in">cd to %WORKSPACE%</P>\r
224                         <LI><P STYLE="margin-bottom: 0in">run edksetup.bat --nt32 newbuild\r
225       <UL>This will set the PATH to point to the directory containing the \r
226       Win32 binaries of the EDK II tools used in edk2 development. It will\r
227                         fail if the external tools above are not properly installed.<BR>\r
228                         Using the --nt32 switch will run &quot;%VS80COMNTOOLS%\vsvars32&quot; (VS2005) or \r
229       &quot;%VS71COMNTOOLS%\vsvars32&quot; (VS2003.NET) to setup standard C FLAGS, \r
230       Library and Include locations to build the Nt32 emulation environment.<BR>\r
231       <B>Note:</B> If you do not want to build the Nt32 emulation environment, you do not\r
232       need to use the --nt32 switch or run vsvars32.bat.</UL></P>\r
233                         <LI><P STYLE="margin-bottom: 0in">cd Nt32Pkg</P>\r
234                         <LI><P STYLE="margin-bottom: 0in">type build \r
235                         </P>\r
236       <P>The default build output directory is: %WORKSPACE%\Build\NT32\DEBUG_MYTOOLS\ \r
237                         </P>\r
238                 </OL>\r
239         </DIV>\r
240 </DIV>\r
241 </BODY>\r
242 </HTML>\r