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