Fixed ANT and XMLBEANS environment setting.
[mirror_edk2.git] / ReleaseNotes.txt
1 Intel(R) Platform Innovation Framework for EFI
2 EFI Development Kit 2.0 (EDK 2.0)
3 Alpha Release
4 2006-04-26
5
6 Copyright (c) 2006, Intel Corporation
7
8 This document provides updates to documentation, along with a description on
9 how to install and build the Edk 2.0.
10
11 Package Contents
12 ----------------
13 ReleaseNote.txt- These release notes for the package.
14 MdePkg - A package containing Industry Standard headers and libraries
15 Tools - A package containing Build Specific tools which are designed
16 to help the developer create and modify drivers and
17 libraries
18 EdkModulePkg - A package containing reference drivers
19 EdkFatBinPkg - A package containing binary DXE drivers for the Fat 32 file
20 system
21 EdkShellBinPkg - A package containing binary Shell applications and commands
22 EdkNt32Pkg - A package containing the NT32 Emulation platform reference
23
24 Note: MDE and MDK that appear in other documentation refer to the MdePkg and
25 Tools packages. These two packages are the minimum requirement for developing
26 EDK 2.0 Packages. It is also recommended that the top level files included
27 with the EDK be downloaded in conjunction with these two packages.
28
29 Note: Documents have the following filenames:
30 EDK 2.0 Module Development Environment Library Specification v0.50
31 (MDE_Library_Spec_0_50.rtf)
32 EDK 2.0 Build and Packaging Architecture Specification v0.50
33 (Build_Packaging_Spec_0_50.rtf)
34 EDK 2.0 Platform Configuration Database Infrastructure Description v0.51
35 (PCD_Infrastructure_0_51.rtf)
36 EDK 2.0 Module Surface Area v0.50
37 (Module_Surface_Area_0_50.rtf)
38 EDK 2.0 Module Development Environment (MDE) Package Specification v0.50
39 (MDE_Package_Spec_0_50.rtf)
40 EDK 2.0 C Coding Standards Specification v0.50
41 (C_Coding_Standards_Specification_ 0_50.rtf)
42
43 Pre-Requisites
44 --------------
45 The following list of tools must be installed on the development workstation
46 prior to using the Edk 2.0.
47
48 Compiler Tool Chain
49 Microsoft* Visual Studio .NET 2003* (http://www.microsoft.com)
50 or
51 GCC version 4.x or later (http://gcc.gnu.org)
52
53 Assembler Tool Chain
54 Microsoft Macro Assembler, version 6.15 or later
55 or
56 GCC version 4.x or later
57
58 Java Development Kit ( Java 5.0 or later)
59 Sun* jdk-1.5.0_04 or later (http://java.sun.com)
60 or
61 Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com)
62
63 Java Tools
64 Apache-ANT, version 1.6.5 or later (http://ant.apache.org)
65 Ant-contrib, version 1.0b2 or later (http://antcontrib.sourceforge.net)
66 Saxon8, version 8.1.1
67 (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)
68 XMLBeans, version 2.1.0 or later (http://xmlbeans.apache.org)
69
70 Other Tools
71 TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)
72
73 Optional Tools
74 --------------
75 Compiler Tool Chains:
76 Intel C++ Compiler for Windows, ver. 9.0 or later (http://www.intel,com)
77 Intel C Compiler for EFI Byte Code, ver. 1.2 or later
78 Microsoft Driver Development Kit, version 3790.1830 or later
79 Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later
80 Intel ACPI Component Architecture, version 20060113
81
82 -----------------------
83 Notes On Required Tools (Source Control System)
84 -----------------------
85 The EDK 2.0 is being managed by the Subversion Source Control on Tianocore.org.
86 This software package provides speed, security, and additional features. The
87 recommended client is TortoiseSVN version 1.3.3.
88 (Available at http://tortoisesvn.tigris.org/)
89
90 There are instructions for the use of Subversion Source Control on the
91 Tianocore.org website, as part of the checkout procedures.
92
93 The URL of the EDK 2.0 repository is:
94 https://edk2.tianocore.org/svn/edk2/trunk/edk2
95
96 -----------------------
97 Notes On Documentation
98 -----------------------
99 The documents are being managed by the Subversion Source Control on
100 Tianocore.org. The document repository is "docs" and must be checked out
101 separately from the EDK 2.0 source tree. Refer to the checkout procedures on
102 the Tianocore.org website for EDK 2.0.
103
104 The URL of the document repository is:
105 https://edk2.tianocore.org/svn/edk2/trunk/docs
106
107
108 -----------------------
109 Notes On Required Tools (MS Windows environment example)
110 -----------------------
111 Software Installation Order:
112 After installing the compiler tools and your Subversion client, the following
113 required tools should be installed in order:
114 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8
115
116 Java Development Kit:
117
118 The Java Environment Variable must be set before attempting to build.
119 i.e. For Sun JDK (see note below*):
120 set JAVA_HOME=c:\ Java\jdk1.5.0_06
121 i.e. For Bea Systems:
122 set JAVA_HOME=c:\Program Files\Java\jrockit-R26.0.0-jdk1.5.0_04
123
124 *When using the Sun JDK5.0
125 During installation, you should specify the install directory as C:\Java
126 instead of C:\Program Files\(or some other drive letter.) While installing
127 to this non-standard location is not required. In use, it seems to work
128 more reliably.
129 For the JDK, the install path would be C:\Java\jdk1.5.0_06
130 For the JRE, the install path would be C:\Java\jre1.5.0_06
131 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.
132
133 NOTE: You cannot combine the location for the JDK and the JRE, as the JRE
134 install removes most of the binaries and libraries installed by the JDK
135 install.
136
137 Java Tools:
138 The Apache-ANT requires the ANT_HOME environment variable to be set before
139 attempting to build:
140 i.e. set ANT_HOME=c:\<full path to where ant was installed>
141
142 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib
143 directory.
144
145 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set
146 before attempting to build:
147 i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>
148
149 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.
150
151 The Ant and XMLBean tools are required to be in the path.
152 MS system example:
153 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin
154 Linux/OS X bash shell example:
155 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin
156
157 -------------------------------------------------------------------------------
158 Quick Start
159 -----------
160 Edit the text file, tools_def.txt, located in the Tools/Conf directory. This
161 file contains the names of the compiler tool chains and the location of the
162 compiler binaries. It has been pre-populated with the standard location for
163 the Microsoft tool chains and includes the standard location of the Intel C
164 Compiler for EFI Byte Code (EBC)
165
166 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to
167 checkout the entire EDK 2.0 source tree.
168
169 In a command window, change to the top level directory of the Edk 2.0 sources.
170 Set the WORKSPACE environment variable, e.g.:
171
172 c:\> set WORKSPACE=C:\MyWork\Edk2.0
173
174 To test your tool chain setup and to build the Supplied Tools, execute:
175 c:\MyWork\Edk2.0\> edksetup
176
177 (This command will be referred to as the setup command throughout the rest of
178 this document.)
179 NOTE: You should run the setup command at the start of every session.
180 This configures the environment to include the TianoTools and the
181 Java applications and libraries.
182
183 Once this is completed, you are ready to test the Build, by executing:
184 c:\MyWork\Edk2.0\> ant
185
186 This command builds all of the packages, including the NT32 reference platform.
187
188 -------------------------
189 Individual Package Builds
190 -------------------------
191 After running the setup command, you can build individual packages.
192 In the command window, cd to the package that you want to build, and just
193 type:
194 c:\MyWork\Edk2.0\EdkNt32Pkg\> ant
195
196 The EdkNt32Pkg has a special target; "run" that will execute the Nt32 emulation
197 platform under Microsoft Windows.
198
199 ------------------------
200 Individual Module Builds
201 ------------------------
202 After running the setup command, you can build individual modules.
203 In the command window, cd to the module that you want to build, and just
204 type:
205 c:\MyWork\Edk2.0\MdePkg\Library\BaseLib\> ant
206
207 -------------------------------------------------------------------------------
208 A Word on Apache-ANT
209 --------------------
210 The Apache-ANT program is a build tool that uses XML-based project files.
211 Similar to Makefiles, these project files may contain multiple targets. Most
212 build.xml files in Edk2.0 are auto-generated; any edits performed on the
213 build.xml files will be overwritten the next time ant is executed.
214
215 Pre-defined targets in the build.xml files include:
216 all - This target builds binaries for defined architectures
217 clean - This target removes object files generated by commands
218 cleanall - This target removes all generated files and directories.
219
220 A Word on GCC tool chain
221 ------------------------
222 You will find a script in the tree that will download, configure, compile, and
223 install a gcc 4.0.2 tool chain for development. It has support for the ia32
224 architecture. It can be built and run on Cygwin, Linux, and many other POSIX
225 compliant host environments. There are a few tools that you will need on your
226 host computer in order to compile the tool chain. Among them are bash, gcc,
227 gmake, curl (or wget).
228
229 -------------------------------------------------------------------------------
230
231 General Information:
232 ===============================================================
233 Mechanisms:
234 ----------
235 A quick understanding:
236
237 A) Surface Area Package Description (SPD) file contains information about the
238 modules that the package contains, including the location of all MSA files, and
239 public library names and headers that might be provided by a module in the
240 package. Packages are defined by SPD files. (Found in the root of the Package
241 subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "Build
242 Packaging Specification" document.
243
244 B) Module Surface Area Definition (MSA) files. A description of a module's
245 surface area, with all module specific default flags and features specified.
246 Refer to the "Module Surface Area Architecture Specification" for additional
247 details. The MSA is further explained in the "Build Packaging Specification"
248 document.
249
250 C) Module Build Description (MDB). The "as-built" definition file that contains
251 only the changes to the default flags defined in the MSA. The MSA and MDB are
252 further explained in the "Build Packaging Specification" document.
253
254 D) Platform Configuration Database (PCD). A platform database which contains a
255 variety of current platform settings or directives by which a driver or
256 application can interact with. The PCD is defined by the PCD_Protocol (This is
257 further explained in the "Platform Configuration Database Infrastructure
258 Description" document.
259
260 E) Library Class. A library class is a logical grouping of similar functions.
261 When developing components, the module surface area declares the class of
262 libraries that can be used by the component. The MBD file specifies the
263 instance(s) of the library that will be used during compilation/linking. All
264 library type modules must include header files in their distribution package,
265 as well as their surface area and module build description files. Components,
266 on the other hand, need only provide the binary and build description files
267 when distributing BINARY packages. The Library Classes are further explained
268 in the "Build Packaging Specification" document.
269
270 =========================================================================
271 The common operations by developers of new modules are:
272 -------------------------------------------------------
273
274 1) How to manually create a new module in a package:
275 - The module source code must first be created in an appropriate directory
276 (under the package the module is to be a part of.)
277 - An MSA file must be created, spelling out all aspects of the module.
278 - The MSA must be added to the SPD for the package to include the module.
279
280 -----------------------------------------
281 2) Add/Remove module(s) to/from a package:
282
283 - Setup environment as Build
284 - Add a module to a package
285 * Generate the module SurfaceArea description file and build description
286 file
287 * Run GenBuildFile.bat under <PackageDir> to generate an entrance
288 build.xml for the module
289 * Add a new <MsaFile> element under <MsaFiles> into
290 <PackageDir>\<PackageName>.spd, using relative path to package
291 * Add a new <ModuleSA> entry under each <TianoImage> into
292 <PackageDir>\<PackageName>.fpd file
293
294 - Remove a module from a package
295 * Comment out or remove corresponding <MsaFile> element under <MsaFiles>
296 from <PackageDir>\<PackageName>.spd
297 * Comment out or remove corresponding <ModuleSA> entry under each
298 <TianoImage> from <PackageDir>\<PackageName>.fpd
299
300 -----------------------------------
301 3) How to manually create a package:
302 - Identify the modules that are to be members of the project.
303 - Identify the Variables and Guids required in and of the Package (including
304 consumption/production information).
305 - Create an SPD file defining these modules and calling out their MSA files.
306
307 --------------------------------------
308 4) Declare a new Protocol in a package:
309 - This release requires manual editing of the SPD file, adding the protocol
310 to the ProtocolDeclarations section of the file.
311 - Add the Protocol .h file to the Include\Protocol directory.
312 - Add an entry to the Protocol.info file
313 * Each line contains Protocol base name then the global variable name and
314 then the hex value of the Protocol GUID.
315
316 Example Protocol.info file (2 lines):
317 UnicodeCollation gEfiUnicodeCollationProtocolGuid
318 { 0x1d85cd7f, 0xf43d, 0x11d2, 0x9a, 0xc, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d }
319 UsbHc gEfiUsbHcProtocolGuid
320 { 0xf5089266, 0x1aa0, 0x4953, 0x97, 0xd8, 0x56, 0x2f, 0x8a, 0x73, 0xb5, 0x19 }
321
322 ---------------------------------
323 5) Declare a new PPI in a package:
324 - This release requires manual editing of the SPD file
325 - Add the PPI .h file to the Include\Ppi directory.
326 - Add an entry to the Ppi.info file
327 * Each line contains PPI base name then the global variable name and then
328 the hex value of the PPI GUID.
329
330 Example Ppi.info file (2 lines):
331 NtPeiLoadFile gNtPeiLoadFilePpiGuid
332 { 0xfd0c65eb, 0x405, 0x4cd2, 0x8a, 0xee, 0xf4, 0x0, 0xef, 0x13, 0xba, 0xc2 }
333 NtThunk gPeiNtThunkPpiGuid
334 { 0x98c281e5, 0xf906, 0x43dd, 0xa9, 0x2b, 0xb0, 0x3, 0xbf, 0x27, 0x65, 0xda }
335
336 ----------------------------------
337 6) Declare a new GUID in a package:
338 - This release requires manual editing of the SPD file to include the new
339 Guid.
340
341 ---------------------------------------
342 7) Declare a new PCD entry in a package:
343 - This release requires manual editing of the SPD file to include the new
344 PCD.
345
346 ------------------------------
347 8) Declare a new Library Class:
348 - This release requires manual editing of the SPD file to include the new
349 Library Class.
350
351 --------------------------------------
352 9) Add a library instance to a package:
353 - This requires manual MSA and MBD file.
354
355 -----------------------------
356 10) Add a module to a package:
357 - This requires manual MSA and MBD editing
358
359
360 =======================================================
361 Notes:
362 ------
363 The EDK 2.0 represents significant changes in the structure of the EDK.
364 Therefore it is very difficult to isolate all of the changes of this version of
365 the EDK with the previous (EDK 1.0) version.
366
367 Of particular note:
368
369 1) EDK 2.0 contains new hardware feature support for the ICH SMBUS Libraries.
370 These libraries are provided to make Memory Reference Code (MRC) development
371 easier.
372 2) The MDE Libraries - The MDE libraries resent significant changes in source
373 (with only limited changes in functionality.) These new libraries conform
374 to the "MDE Library Specification".
375 3) The Fat Binary and the EDK Shell Binary Packages are functionally identical
376 to the EDK 1.0 version.
377 4) The EDK tools directory has been expanded to include more tools and more
378 tool functionality.
379 5) The EDK NT32 section has been ported to the new build process, but
380 functionally remains the same as the EDK 1.0 version.
381 6) The Application "HelloWorld" has been ported to EDK 2.0 as well.
382
383 =======================================================
384 Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no
385 virus detected.
386