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