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