Changed the ant-contrib download address to sync with the website;
[mirror_edk2.git] / ReleaseNotes.txt
1 Intel(R) Platform Innovation Framework for EFI
2 EFI Development Kit II (EDK II)
3 Root Package 1.00
4 2006-07-06
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 II.
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 EdkFatPkg - A package containing source DXE drivers for the Fat 32 file
22 system
23 EdkShellBinPkg - A package containing binary Shell applications and commands
24 EdkNt32Pkg - A package containing the NT32 Emulation platform reference
25
26 Note: MDE and MDK that appear in other documentation refer to the MdePkg and
27 Tools packages. These two packages are the minimum requirement for developing
28 EDK II Packages. It is also recommended that the top level files included
29 with the EDK be downloaded in conjunction with these two packages.
30
31 Note: Documents have the following filenames:
32 EDK II Module Development Environment Library Specification v0.50
33 (MDE_Library_Spec_0_50.rtf)
34 EDK II Build and Packaging Architecture Specification v0.50
35 (Build_Packaging_Spec_0_50.rtf)
36 EDK II Platform Configuration Database Infrastructure Description v0.51
37 (PCD_Infrastructure_0_51.rtf)
38 EDK II Module Surface Area v0.50
39 (Module_Surface_Area_0_50.rtf)
40 EDK II Module Development Environment (MDE) Package Specification v0.50
41 (MDE_Package_Spec_0_50.rtf)
42 EDK II C Coding Standards Specification v0.50
43 (C_Coding_Standards_Specification_ 0_50.rtf)
44
45 Pre-Requisites
46 --------------
47 The following list of tools must be installed on the development workstation
48 prior to using the Edk II.
49
50 Compiler Tool Chain
51 Microsoft* Visual Studio .NET 2003* (http://www.microsoft.com)
52 or
53 A special GCC version 4.x or later (http://gcc.gnu.org). See below.
54
55 Assembler Tool Chain
56 Microsoft Macro Assembler, version 6.15 or later
57 or
58 GNU binutils 2.16.1 or later
59
60 Java Development Kit ( Java 5.0 or later)
61 Sun* jdk-1.5.0_04 or later (http://java.sun.com)
62 or
63 Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com)
64
65 Java Tools
66 Apache-ANT, version 1.6.5 or later (http://ant.apache.org)
67 Ant-contrib, version 1.0b2 or later
68 (http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download)
69 Saxon8, version 8.1.1
70 (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)
71 XMLBeans, version 2.1.0 (http://xmlbeans.apache.org)
72 DO NOT download the latest XMLBeans, version 2.2.0. It cannot work with
73 Saxon8, version 8.1.1.
74
75 Other Tools
76 TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)
77
78 Optional Tools
79 --------------
80 Compiler Tool Chains:
81 Intel C++ Compiler for Windows, ver. 9.0 or later (http://www.intel.com)
82 Intel C Compiler for EFI Byte Code, ver. 1.2 or later
83 (http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm)
84 Microsoft Driver Development Kit, version 3790.1830 or later
85 (http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx)
86 Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later
87 Intel ACPI Component Architecture, version 20060113
88
89 -----------------------
90 Notes On Required Tools (Source Control System)
91 -----------------------
92 The EDK II is being managed by the Subversion Source Control on Tianocore.org.
93 This software package provides speed, security, and additional features. The
94 recommended client is TortoiseSVN version 1.3.3.
95 (Available at http://tortoisesvn.tigris.org/)
96
97 There are instructions for the use of Subversion Source Control on the
98 Tianocore.org website, as part of the checkout procedures.
99
100 The URL of the EDK II repository is:
101 https://edk2.tianocore.org/svn/edk2/trunk/edk2
102
103 -----------------------
104 Notes On Documentation
105 -----------------------
106 The documents are being managed by the Subversion Source Control on
107 Tianocore.org. The document repository is "docs" and must be checked out
108 separately from the EDK II source tree. Refer to the checkout procedures on
109 the Tianocore.org website for EDK II.
110
111 The URL of the document repository is:
112 https://edk2.tianocore.org/svn/edk2/trunk/docs
113
114
115 -----------------------
116 Notes On Required Tools (MS Windows environment example)
117 -----------------------
118 Software Installation Order:
119 After installing the compiler tools and your Subversion client, the following
120 required tools should be installed in order:
121 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8
122
123 Java Development Kit:
124
125 The Java Environment Variable must be set before attempting to build.
126 i.e. For Sun JDK (see note below*):
127 set JAVA_HOME=c:\Java\jdk1.5.0_06
128 i.e. For Bea Systems:
129 set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04
130
131 *When using the Sun JDK5.0
132 During installation, you should specify the install directory as C:\Java
133 instead of C:\Program Files\(or some other drive letter.) While installing
134 to this non-standard location is not required. In use, it seems to work
135 more reliably.
136 For the JDK, the install path would be C:\Java\jdk1.5.0_06
137 For the JRE, the install path would be C:\Java\jre1.5.0_06
138 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.
139
140 NOTE: You cannot combine the location for the JDK and the JRE, as the JRE
141 install removes most of the binaries and libraries installed by the JDK
142 install.
143
144 Java Tools:
145 The Apache-ANT requires the ANT_HOME environment variable to be set before
146 attempting to build:
147 i.e. set ANT_HOME=c:\<full path to where ant was installed>
148
149 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib
150 directory.
151
152 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set
153 before attempting to build:
154 i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>
155
156 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.
157
158 The Ant and XMLBean tools are required to be in the path.
159 MS system example:
160 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin
161 Linux/OS X bash shell example:
162 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin
163
164 -------------------------------------------------------------------------------
165 Quick Start
166 -----------
167 Copy the target.template file in the Tools/Conf directory to target.txt, which
168 must also be in the Tools/Conf directory.
169
170 Edit the text file, target.txt, located in the Tools/Conf directory. This
171 file contains options for setting the active platform and restricting the build.
172 The restictions are used to limit the build output by specifying build target(s),
173 tagname(s) and architecture(s) to less than the full set of possible options.
174
175 The ACTIVE_PLATFORM must be set unless the current working directory contains one
176 or more FPD files. All other options need not be set, however by unsetting these
177 options (by removing the line from the file, or leaving the Value empty) will
178 result in all available build possibilites when typing build. By default EDK II
179 can build a matrix of binaries, using different target types, tool chain tags and
180 architectures. Options to target.txt file are as follows:
181
182 ACTIVE_PLATFORM = Value REQUIRED
183 Where Value is the WORKSPACE relative path and filename of a Framework Platform
184 Definition (FPD) File. Example:
185
186 ACTIVE_PLATFORM = MdePkg/MdePkg.fpd
187
188 TARGET = Value OPTIONAL
189 Where Value is a list of one or more of the following: DEBUG, RELEASE or a User
190 Defined Target type, such as PERF. Example:
191
192 TARGET = DEBUG RELEASE
193
194 TARGET_ARCH = Value OPTIONAL
195 Where Value is a list of one or more supported Architectures: IA32, X64, IPF or
196 EBC. Example:
197
198 TARGET_ARCH = IA32 X64 EBC
199
200 TOOL_CHAIN_CONF = Value OPTIONAL
201 Where Value is the Filename of an alternate tools_def.txt file created by the
202 user. The alternate tools_def.txt files must be in the Tools/Conf directory.
203 These tool definitions are scoped to the WORKSPACE (location of the EDK
204 installation) and cannot be shared between WORKSPACES. (You can copy the files
205 from one workspace to another.) Example:
206
207 TOOL_CHAIN_CONF = alfred.txt
208
209 TOOL_CHAIN_TAG = Value OPTIONAL
210 Where Value is a list of TagName entries as defined in the tools_def.txt file.
211 The TagName can be used to specify different versions of a compiler, i.e.,
212 gcc 4.0 and gcc 4.1 which will allow you to build binaries with both tool chains
213 during the same build - useful during testing of a new compiler tool chain, or
214 for changing compiler flags to check out performance with a different set of
215 flags than flags used for production. Example:
216
217 TOOL_CHAIN_TAG = GCC40 GCC41
218
219 To clear a restriction, just remove any data after the equal sign. To clear
220 the TARGET_ARCH limitation that was set above, enter:
221
222 TARGET_ARCH =
223
224 -----------
225 Copy the tools_def.template file in Tools/Conf to tools_def.txt in the same
226 directory.
227
228 Edit the tools definition file, tools_def.txt, also located in the Tools/Conf
229 directory. This file contains the names of the compiler tool chains and the
230 location of the compiler binaries. It has been pre-populated with the standard
231 location for the Microsoft tool chains and includes the standard location of
232 the Intel C Compiler for EFI Byte Code (EBC.) In addition, EDK II provides
233 support for Cygwin, Linux and OS X GCC compiler tool chains. A script has been
234 provided in the Tools/gcc directory as well as instructions in obtaining and
235 building a version of GCC that has been tested. The tools_def.txt file has
236 the GCC binary locations that are created using this script.
237
238 Both target.txt and tools_def.txt files are formatted as Property = Value,
239 which must appear on a single line. Spanning a Value entry over multiple
240 lines is not supported at this time. In the target.txt file, the Property is
241 a single, uppercase word with underscore characters. These Property names are
242 fixed by the build system. The tools_def.txt file's Property is an underscore
243 delimited coding, which supports some user defined values. The coding for
244 the Property is: TARGET_TAGNAME_ARCH_COMMAND_ATTR The Value, is either a
245 full path, full path and filename or a reserved word.
246
247 TARGET - DEBUG and RELEASE are predefined, however the user may define one or
248 more of their own TARGET types in this file.
249
250 TAGNAME - HOST, MSFT, GCC, INTC are predefined, however the user may define
251 one or more of their own TAGNAME keywords in this file.
252
253 ARCH - EDK II supports IA32, X64, IPF and EBC at this time.
254
255 COMMAND - Predefined command codes are listed in the tools_def.txt file, however
256 the user can specify additional command codes for their one, non-
257 standard tools.
258
259 ATTR - Predefined Attributes are listed in the tools_def.txt file.
260
261 NOTE: The TAGNAME: HOST is reserved and MUST be defined in order to build the
262 included Tiano tools from their C source files. These tools have been
263 built and tested using both Microsoft and GCC tool chains.
264 NOTE: The "*" symbol may be used as a wildcard character in most of these
265 fields, refer to the tools_def.txt and the "EDK II Build and Packaging
266 Architecture Specification" for more details.
267
268
269 -----------
270 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to
271 checkout the entire EDK II source tree.
272
273 In a command window, change to the top level directory of the Edk II sources.
274 Set the WORKSPACE environment variable, e.g.:
275
276 c:\> set WORKSPACE=C:\MyWork\Edk2
277
278 To test your tool chain setup and to build the Supplied Tools, execute:
279 c:\MyWork\Edk2\> edksetup
280
281 (This command will be referred to as the setup command throughout the rest of
282 this document.)
283 NOTE: You should run the setup command at the start of every session.
284 This configures the environment to include the TianoTools and the
285 Java applications and libraries.
286
287 If you are confident that none of the tool tool sources have changed, and you
288 only want to set up the workspace environment you may execute:
289 c:\MyWork\Edk2\> edksetup skip
290
291 Once this is completed, you are ready to test the Build, by executing:
292 c:\MyWork\Edk2\> build
293
294 This command builds active platform specified in text file target.txt. If
295 active platform is not specified, go to sub-directory which contains FPD files and
296 type build. More information about active platform policy reference to specification
297 <<EDK II Build and Packaging Architecture Specification>>.
298
299 -------------------------
300 Individual Platform Builds
301 -------------------------
302 After running the setup command, you can build individual platforms.
303 In the command window,
304 1. Set active platform in target.txt, and type "build" in whatever directory;
305 2. or cd to the platform (FPD file) that you want to build, and just type:
306 c:\MyWork\Edk2\EdkNt32Pkg\> build
307
308 Note that active platform with the high priority to build, that means active
309 platform will be built even if exists FPD file under current directory. More
310 information about active platform policy reference to specification
311 <<EDK II Build and Packaging Architecture Specification>>.
312
313 Go to <full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe
314 to run the Nt32 emulation platform under Microsoft Windows.
315
316 To exit the Nt32 emulation platform, you may type reset at the EFI Shell>
317 command prompt. Alternately, you may use the Graphical interface, Boot
318 Maintenance Manager screen's Reset System command.
319
320 ------------------------
321 Individual Module Builds
322 ------------------------
323 After running the setup command, you can build individual modules.
324 In the command window, cd to the module that you want to build, and just
325 type:
326 c:\MyWork\Edk2\MdePkg\Library\BaseLib\> build
327
328 Note active platform must be set for individual module build.
329
330 -------------------------------------------------------------------------------
331 A Word on Apache-ANT
332 --------------------
333 The Apache-ANT program is a build tool that uses XML-based project files.
334 Similar to Makefiles, these project files may contain multiple targets. Most
335 build.xml files in EDK II are auto-generated; any edits performed on the
336 build.xml files will be overwritten the next time build is executed.
337
338 Pre-defined targets in the build.xml file include:
339 all - This target builds binaries for defined architectures
340 clean - This target removes object files generated by commands
341 cleanall - This target removes all generated files and directories.
342
343 A Word on GCC tool chain
344 ------------------------
345 EDK II will not compile with a standard Linux gcc tool chain. While Linux
346 distributions are usually based on ELF, EDK II requires a version of gcc
347 that is configured to produce PE-COFF images. You will find a script in
348 edk2/Tools/gcc that will download, configure, compile, and install a gcc
349 4.X cross-compile tool chain for EDK II development. It has support for
350 the IA32 architecture. It can be built and run on Cygwin, Linux, and many
351 other POSIX compliant host operating environments. There are a few tools
352 that you will need on your host computer in order to compile the tool
353 chain. Among them are bash, gcc, gmake, curl (or wget).
354
355 -------------------------------------------------------------------------------
356
357 General Information:
358 ===============================================================
359 Mechanisms:
360 ----------
361 A brief overview:
362
363 A) Surface Area Package Description (SPD) file contains information about the
364 modules that the package contains, including the location of all MSA files, and
365 public library names and headers that might be provided by a module in the
366 package. Packages are defined by SPD files. (Found in the root of the Package
367 subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "EDK Build
368 and Packaging Architecture Specification" document.
369
370 B) Module Surface Area Definition (MSA) files. A description of a module's
371 surface area, with all module specific default flags and features specified.
372 Refer to the "Module Surface Area Architecture Specification" for additional
373 details. The MSA is further explained in the "EDK II Build Packaging Architecture
374 Specification" document.
375
376 C) Framework Platform Description (FPD) files. A description of a platform's
377 surface are, including a list of modules that are needed by the platform. To
378 support individual module builds, developers are not required to provide
379 information about specific flash devices, nor flash device layout. There are
380 specific sections in the FPD file that do control aspects of the build, such
381 as the Supported Architectures and Build Targets, as well as the tool flags
382 that are used to create the binary files. A valid platform file can specify
383 zero or more modules, so individual modules can be compiled within the context
384 of a platform (FPD) definition.
385
386 D) Platform Configuration Database (PCD). A platform database which contains a
387 variety of current platform settings or directives by which a driver or
388 application can interact with. The PCD is defined by the PCD_Protocol (This is
389 further explained in the "Platform Configuration Database Infrastructure
390 Description" document.
391
392 E) Library Class. A library class is a logical grouping of similar functions.
393 When developing components, the module surface area declares the class of
394 libraries that can be used by the component. The MSA and SPD files can specify
395 a recommended instance of the library that a platform integrator may select,
396 however this is only a recommendation. The PI may choose to select a different
397 library instance to be used during compilation/linking. All library type modules
398 must include header files in their distribution package, as well as their MSA
399 files. Components, on the other hand, need only provide an MSA and either source
400 or binary files when distributing packages. The Library Classes are further
401 explained in the "EDK II Build and Packaging Architecture Specification"
402 document.
403
404 =========================================================================
405 The common operations by developers of new modules are:
406 -------------------------------------------------------
407
408 1) How to manually create a new module in a package:
409 - The module source code must first be created in an appropriate directory
410 (under the package the module is to be a part of.)
411 - An MSA file must be created, spelling out all aspects of the module.
412 - The MSA must be added to the SPD for the package to include the module.
413
414 -----------------------------------------
415 2) Add/Remove module(s) to/from a package:
416
417 - Setup environment as Build
418 - Add a module to a package
419 * Generate the module SurfaceArea description file
420 * Add a new <Filename> element under <MsaFiles> into
421 <PackageDir>\<PackageName>.spd, using relative path to package
422 * Add a new <ModuleSA> entry under each <FrameworkModules> into
423 <PackageDir>\<PackageName>.fpd file if necessary.
424
425 - Remove a module from a package
426 * Comment out or remove corresponding <Filename> element under <MsaFiles>
427 from <PackageDir>\<PackageName>.spd
428 * Comment out or remove corresponding <ModuleSA> entry under each
429 <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary.
430
431 -----------------------------------
432 3) How to manually create a package:
433 - Identify the modules that are to be members of the project.
434 - Identify the Variables and Guids required in and of the Package (including
435 consumption/production information).
436 - Create an SPD file defining these modules and calling out their MSA files.
437 - add a new <Filename> element under <PackageList> into
438 Tools\Conf\FrameworkDatabase.db, using the relative path to workspace.
439
440 --------------------------------------
441 4) Declare a new Protocol in a package:
442 - This release requires manual editing of the SPD file, adding the protocol
443 to the ProtocolDeclarations section of the file.
444 - Add the Protocol .h file to the Include\Protocol directory.
445 - Add an <Entry> to the <ProtocolDeclarations> element in the
446 <PackageName>.spd file
447 * Each line contains Protocol base name then the global variable name and
448 then the hex value of the Protocol GUID.
449
450 Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):
451 <ProtocolDeclarations>
452 <Entry Name="Bds">
453 <C_Name>gEfiBdsArchProtocolGuid</C_Name>
454 <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>
455 <HelpText/>
456 </Entry>
457 <Entry Name="Cpu">
458 <C_Name>gEfiCpuArchProtocolGuid</C_Name>
459 <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>
460 <HelpText/>
461 </Entry>
462 </ProtocolDeclarations>
463
464 ---------------------------------
465 5) Declare a new PPI in a package:
466 - This release requires manual editing of the SPD file
467 - Add the PPI .h file to the Include\Ppi directory.
468 - Add an <Entry> to the package <PpiDeclarations> element in the
469 <PackageName>.spd file
470 * Each line contains PPI base name then the global variable name and then
471 the hex value of the PPI GUID.
472
473 Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):
474 <PpiDeclarations>
475 <Entry Name="BootInRecoveryMode">
476 <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>
477 <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>
478 <HelpText/>
479 </Entry>
480 <Entry Name="CpuIo">
481 <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>
482 <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>
483 <HelpText/>
484 </Entry>
485 </PpiDeclarations>
486
487 ----------------------------------
488 6) Declare a new GUID in a package:
489 - This release requires manual editing of the SPD file to include the new
490 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration
491 element as described above.
492
493 ---------------------------------------
494 7) Declare a new PCD entry in a package:
495 - This release requires manual editing of the SPD file to include the new
496 PCD. New Pcd entries are added to the PcdDefinitions section of the
497 <PackageName>.spd file using the following example for the format:
498 NOTE: The hex <Token> value must be unique.
499
500 <PcdDeclarations>
501 <PcdEntry ItemType="FIXED_AT_BUILD">
502 <C_Name>PcdMaximumUnicodeStringLength</C_Name>
503 <Token>0x00000001</Token>
504 <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
505 <DatumType>UINT32</DatumType>
506 <ValidUsage>FIXED_AT_BUILD</ValidUsage>
507 <DefaultValue>1000000</DefaultValue>
508 <HelpText>The maximum lengh for unicode string.</HelpText>
509 </PcdEntry>
510 </PcdDeclarations>
511
512 ------------------------------
513 8) Declare a new Library Class:
514 - This release requires manual editing of the SPD file to include the new
515 Library Class. New Library Class entries are added to the
516 LibraryClassDeclarations seection of the <PackageName>.spd file using
517 the following example for the format:
518
519 <LibraryClassDeclarations>
520 <LibraryClass Name="BaseLib">
521 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>
522 <HelpText/>
523 </LibraryClass>
524 <LibraryClass Name="BaseMemoryLib">
525 <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>
526 <HelpText/>
527 </LibraryClass>
528 </LibraryClassDeclarations>
529
530 =======================================================
531 Notes:
532 ------
533 The EDK II represents significant changes in the structure of the EDK.
534 Therefore it is very difficult to isolate all of the changes of this version of
535 the EDK with the previous (EDK 1.0) version.
536
537 Of particular note:
538
539 1) EDK II contains new hardware feature support for the ICH SMBUS Libraries.
540 These libraries are provided to make Memory Reference Code (MRC) development
541 easier.
542 2) The MDE Libraries - The MDE libraries represent significant changes in source
543 (with only limited changes in functionality.) These new libraries conform
544 to the "MDE Library Specification".
545 3) The Fat Binary and the EDK Shell Binary Packages are functionally identical
546 to the EDK 1.0 version.
547 4) The EDK tools directory has been expanded to include more tools and more
548 tool functionality.
549 5) The EDK NT32 section has been ported to the new build process, but
550 functionally remains the same as the EDK 1.0 version.
551 6) The Application "HelloWorld" has been ported to EDK II as well.
552
553 =======================================================
554 Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no
555 virus detected.
556