Updated for Makefile Build
[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 <P>The following are required to be able to build the EDK II using the new Makefile build: \r
25 </P>\r
26 <DIV ID="requirements" DIR="LTR"><A NAME="requirements_table"></A>\r
27         <TABLE BORDER=1 CELLPADDING=0 CELLSPACING=0>\r
28                 <TR>\r
29                         <TH>\r
30                                 <P STYLE="border: none; padding: 0in"><FONT COLOR="#ffffff">Name</FONT></P>\r
31                         </TH>\r
32                         <TH>\r
33                                 <P STYLE="border: none; padding: 0in"><FONT COLOR="#ffffff">Version</FONT></P>\r
34                         </TH>\r
35                         <TH>\r
36                                 <P STYLE="border: none; padding: 0in"><FONT COLOR="#ffffff">URL</FONT></P>\r
37                         </TH>\r
38                 </TR>\r
39                 <TR>\r
40                         <TD>\r
41                                 <P ALIGN=CENTER><B>TortoiseSVN</B></P>\r
42                         </TD>\r
43                         <TD>\r
44                                 <P ALIGN=CENTER><B>1.4.5</B></P>\r
45                         </TD>\r
46                         <TD>\r
47                                 <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/</A><BR><A HREF="http://prdownloads.sourceforge.net/tortoisesvn/TortoiseSVN-1.4.5.10425-win32-svn-1.4.5.msi?download">TortoiseSVN-1.4.5.10425-win32-svn-1.4.5.msi?download</A></P>\r
48                         </TD>\r
49                 </TR>\r
50 <!--\r
51                 <TR>\r
52                         <TD>\r
53                                 <P ALIGN=CENTER><B>Ant</B></P>\r
54                         </TD>\r
55                         <TD>\r
56                                 <P ALIGN=CENTER><B>1.6.5</B></P>\r
57                         </TD>\r
58                         <TD>\r
59                                 <P ALIGN=CENTER><A HREF="http://ant.apache.org/bindownload.cgi">http://ant.apache.org/bindownload.cgi</A></P>\r
60                         </TD>\r
61                 </TR>\r
62                 <TR>\r
63                         <TD>\r
64                                 <P ALIGN=CENTER><B>Ant Contrib</B></P>\r
65                         </TD>\r
66                         <TD>\r
67                                 <P ALIGN=CENTER><B>1.0b2</B></P>\r
68                         </TD>\r
69                         <TD>\r
70                                 <P ALIGN=CENTER><A HREF="http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download">http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download</A></P>\r
71                         </TD>\r
72                 </TR>\r
73                 <TR>\r
74                         <TD>\r
75                                 <P ALIGN=CENTER><B>Java JDK</B></P>\r
76                         </TD>\r
77                         <TD>\r
78                                 <P ALIGN=CENTER><B>1.5.x</B></P>\r
79                         </TD>\r
80                         <TD>\r
81                                 <P ALIGN=CENTER><A HREF="http://java.sun.com/j2se/1.5.0/download.jsp">http://java.sun.com/j2se/1.5.0/download.jsp</A></P>\r
82                         </TD>\r
83                 </TR>\r
84                 <TR>\r
85                         <TD>\r
86                                 <P ALIGN=CENTER><B>Saxon-B</B></P>\r
87                         </TD>\r
88                         <TD>\r
89                                 <P ALIGN=CENTER><B>8.1.1 for Java</B></P>\r
90                         </TD>\r
91                         <TD>\r
92                                 <P ALIGN=CENTER><A HREF="http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip">http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip</A></P>\r
93                         </TD>\r
94                 </TR>\r
95                 <TR>\r
96                         <TD>\r
97                                 <P ALIGN=CENTER><B>XMLBeans</B></P>\r
98                         </TD>\r
99                         <TD>\r
100                                 <P ALIGN=CENTER><B>2.1.0</B></P>\r
101                         </TD>\r
102                         <TD>\r
103                                 <P ALIGN=CENTER><A HREF="http://www.apache.org/dyn/closer.cgi/xmlbeans/binaries">http://www.apache.org/dyn/closer.cgi/xmlbeans/binaries</A></P>\r
104                         </TD>\r
105                 </TR>\r
106 -->\r
107         </TABLE>\r
108         <P><BR><BR>\r
109         </P>\r
110         <P>The following tools are optional:</P>\r
111         <DIV ID="Section1" DIR="LTR"><A NAME="requirements"></A><A NAME="requirements_table1"></A>\r
112                 <TABLE BORDER=1 CELLPADDING=0 CELLSPACING=0>\r
113                         <TR>\r
114                                 <TH>\r
115                                         <P STYLE="border: none; padding: 0in"><FONT COLOR="#ffffff">Name</FONT></P>\r
116                                 </TH>\r
117                                 <TH>\r
118                                         <P STYLE="border: none; padding: 0in"><FONT COLOR="#ffffff">Version</FONT></P>\r
119                                 </TH>\r
120                                 <TH>\r
121                                         <P STYLE="border: none; padding: 0in"><FONT COLOR="#ffffff">URL</FONT></P>\r
122                                 </TH>\r
123                         </TR>\r
124                         <TR>\r
125                                 <TD>\r
126                                         <P ALIGN=CENTER><B>Cygwin</B></P>\r
127                                 </TD>\r
128                                 <TD>\r
129                                         <P ALIGN=CENTER><B>Current</B></P>\r
130                                 </TD>\r
131                                 <TD>\r
132                                         <P ALIGN=CENTER><A HREF="http://www.cygwin.com/">http://www.cygwin.com</A></P>\r
133                                 </TD>\r
134                         </TR>\r
135                         <TR>\r
136                                 <TD>\r
137                                         <P ALIGN=CENTER><B>Microsoft Visual Studio*</B></P>\r
138                                 </TD>\r
139                                 <TD>\r
140                                         <P ALIGN=CENTER><B>2005 Professional</B>\r
141                                         </P>\r
142                                 </TD>\r
143                                 <TD>\r
144                                         <P ALIGN=CENTER><A HREF="http://www.intel.com/">http://www.intel.com</A></P>\r
145                                 </TD>\r
146                         </TR>\r
147                         <TR>\r
148                                 <TD>\r
149                                         <P ALIGN=CENTER><B>Microsoft Visual Studio**</B></P>\r
150                                 </TD>\r
151                                 <TD>\r
152                                         <P ALIGN=CENTER><B>2005 Team Suite</B>\r
153                                         </P>\r
154                                 </TD>\r
155                                 <TD>\r
156                                         <P ALIGN=CENTER><A HREF="http://www.intel.com/">http://www.intel.com</A></P>\r
157                                 </TD>\r
158                         </TR>\r
159                         <TR>\r
160                                 <TD>\r
161                                         <P ALIGN=CENTER><B>Microsoft Visual Studio</B></P>\r
162                                 </TD>\r
163                                 <TD>\r
164                                         <P ALIGN=CENTER><B>2003 .NET</B>\r
165                                         </P>\r
166                                 </TD>\r
167                                 <TD>\r
168                                         <P ALIGN=CENTER><A HREF="http://www.intel.com/">http://www.intel.com</A></P>\r
169                                 </TD>\r
170                         </TR>\r
171                         <TR>\r
172                                 <TD>\r
173                                         <P ALIGN=CENTER><B>Intel C++ Compiler for Windows</B></P>\r
174                                 </TD>\r
175                                 <TD>\r
176                                         <P ALIGN=CENTER><B>9.1</B>\r
177                                         </P>\r
178                                 </TD>\r
179                                 <TD>\r
180                                         <P ALIGN=CENTER><A HREF="http://www.intel.com/">http://www.intel.com</A></P>\r
181                                 </TD>\r
182                         </TR>\r
183                         <TR>\r
184                                 <TD>\r
185                                         <P ALIGN=CENTER><B>Intel C Compiler for EFI Byte Code</B></P>\r
186                                 </TD>\r
187                                 <TD>\r
188                                         <P ALIGN=CENTER><B>1.2</B></P>\r
189                                 </TD>\r
190                                 <TD>\r
191                                         <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
192                                 </TD>\r
193                         </TR>\r
194                         <TR>\r
195                                 <TD>\r
196                                         <P ALIGN=CENTER><B>Microsoft Driver Development Kit (DDK)</B></P>\r
197                                 </TD>\r
198                                 <TD>\r
199                                         <P ALIGN=CENTER><B>3790.1830</B></P>\r
200                                 </TD>\r
201                                 <TD>\r
202                                         <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
203                                 </TD>\r
204                         </TR>\r
205                         <TR>\r
206                                 <TD>\r
207                                         <P ALIGN=CENTER><B>Microsoft ACPI Source Language Assembler</B></P>\r
208                                 </TD>\r
209                                 <TD>\r
210                                         <P ALIGN=CENTER><B>3.0.0NT or later</B></P>\r
211                                 </TD>\r
212                                 <TD>\r
213                                         <P ALIGN=CENTER><A HREF="http://download.microsoft.com/download/2/c/1/2c16c7e0-96c1-40f5-81fc-3e4bf7b65496/MS_ASL-Compiler_3.0.1.msi">http://download.microsoft.com/download/2/c/1/2c16c7e0-96c1-40f5-81fc-3e4bf7b65496/MS_ASL-Compiler_3.0.1.msi</A><BR><A HREF="http://download.microsoft.com/download/2/c/1/2c16c7e0-96c1-40f5-81fc-3e4bf7b65496/MS_ASL-Compiler_3.0.1.msi">http://download.microsoft.com/download/2/c/1/2c16c7e0-96c1-40f5-81fc-3e4bf7b65496/MS_ASL-Compiler_3.0.1.msi</A></P>\r
214                                 </TD>\r
215                         </TR>\r
216                         <TR>\r
217                                 <TD>\r
218                                         <P ALIGN=CENTER><B>Intel ACPI Component Architecture</B></P>\r
219                                 </TD>\r
220                                 <TD>\r
221                                         <P ALIGN=CENTER><B>20060113 or later</B></P>\r
222                                 </TD>\r
223                                 <TD>\r
224                                         <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
225                                 </TD>\r
226                         </TR>\r
227       <TR>\r
228         <TD ALIGN=LEFT COLSPAN=3><Sup>*</Sup>The default tool chain for the IA32 and X64 Builds</TD>\r
229       <TR>\r
230         <TD ALIGN=LEFT COLSPAN=3><Sup>**</Sup>Needed for building IPF targets if the DDK is not installed.</TD>\r
231       </TR>\r
232                 </TABLE>\r
233                 <H3 CLASS="heading-2">Install and Configure Tools on Windows XP</H3>\r
234                 <H3>Software Installation Order</H3>\r
235                 <P>After installing the compiler tools and your Subversion client,\r
236                 download the edk2, read the BuildNotes2.txt file and you will be\r
237     ready to build and image.</P> \r
238     <P>All builds are started from a command prompt window.</P>\r
239     <H3>Cygwin</H3>\r
240                 <P>If you optionally install cygwin (for gcc support) you should\r
241                 install it in &quot;Unix&quot; mode. The gcc tool chain will not\r
242                 compile in &quot;DOS&quot; mode.</P>\r
243                 <H3 CLASS="heading-2">Environment Variables</H3>\r
244                 <P>Environment variables are <B>case sensitive</B>. You must use\r
245                 the exact case as in the examples of this document. Even though\r
246                 windows does not care about case, other operating systems that\r
247     are supported do care about case.<BR><BR>You need to set\r
248                 WORKSPACE to the location of the edk2 directory that you pulled\r
249                 from Subversion. For example</P>\r
250                 <PRE STYLE="margin-bottom: 0.2in">set WORKSPACE=c:\workspace\edk2\</PRE><P>\r
251                 It is recommended that you wrap up all the environment variables\r
252                 above into a script that you can launch each time you begin to do\r
253                 development in your EDK II workspace.</P>\r
254                 <H3 CLASS="heading-2">The first build</H3>\r
255                 <P>You will need to edit the text file, tools_def.txt, located\r
256                 in the \%WORKSPACE\%/Conf directory. This file contains the names of the\r
257                 compiler tool chains and the location of the compiler binaries. It\r
258                 has been pre-populated with the standard location for the Microsoft\r
259                 tool chains and includes the standard location of the Intel C\r
260                 Compiler for EFI Byte Code (EBC).</P>\r
261                 <P>Once the external tools are installed, the environment variables\r
262                 are set, and you have the ant executable in your path, you can try\r
263                 a build.</P>\r
264                 <OL>\r
265                         <LI><P STYLE="margin-bottom: 0in">cd to %WORKSPACE%</P>\r
266                         <LI><P STYLE="margin-bottom: 0in">run edksetup.bat newbuild (this\r
267       will set the PATH to point to the directory containing the Win32\r
268       binaries of the EDK II tools used in edk2 development.) It will\r
269                         fail if the external tools above are not properly installed.)</P>\r
270                         <LI><P STYLE="margin-bottom: 0in">If your Visual Studio installation\r
271       did not setup the environment globally, you will need to run the\r
272       vsvars32.bat file to setup standard C FLAGS, Library and Include\r
273       locations to build the Nt32 emulation environment.  Note if you\r
274       do not want to build the Nt32 emulation environment, you do not\r
275       need to run vsvars32.bat.</P>\r
276                         <LI><P STYLE="margin-bottom: 0in">cd Nt32Pkg</P>\r
277                         <LI><P>type build \r
278                         </P>\r
279                 </OL>\r
280         </DIV>\r
281 </DIV>\r
282 </BODY>\r
283 </HTML>\r