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 (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
 122
 123 Java Development Kit:
 124
 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
 132
 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.
 141
 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.
 145
 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)
 151
 152     The ant-contrib.jar file should be installed in the %ANT_HOME%\lib
 153     directory.
 154
 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)
 159
 160     The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.
 161
 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
 167
 168 -------------------------------------------------------------------------------
 169 Quick Start
 170 -----------
 171 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to
 172 checkout the entire EDK II source tree.
 173
 174 In a command window, change to the top level directory of the Edk II sources.
 175
 176 If the active compiler tool chain is GCC, you must set the
 177 environment variable, TOOL_CHAIN to "gcc" before running the
 178 edksetup script.  Example: export TOOL_CHAIN=gcc
 179
 180 To test your tool chain setup and to build the Supplied Tools, execute:
 181     c:\MyWork\edkii\> edksetup ForceBuild
 182
 183 On Unix systems you must source the edksetup.sh file to load the correct
 184 settings into your shell.
 185
 186     . edksetup.sh # Note the dot.
 187
 188 (This command will be referred to as the setup command throughout the rest of
 189 this document.)
 190       NOTE: You should run the setup command at the start of every session.
 191             This configures the environment to include the TianoTools and the
 192             Java applications and libraries.
 193
 194 Any changes to the tool source code or XML Schema documents will require that
 195 you run:
 196    c:\MyWork\edkii\> edksetup ForceBuild
 197
 198 You will need to set the WORKSPACE environment variable, or run the edksetup
 199 script (without any arguments) any time you want to build.
 200
 201   Set the WORKSPACE environment variable, e.g.:
 202
 203     c:\> set WORKSPACE=C:\MyWork\edkii
 204
 205 You may need to edit the text files, Tools/Conf/target.txt and/or
 206 Tools/Conf/tools_def.txt (created by edksetup,) using your favorite
 207 text editor to point to the tools you want to use to build EDK II binaries.
 208
 209 Once this is completed, you are ready to test the Build, by executing:
 210     c:\MyWork\edkii\> build
 211
 212 This command builds active platform specified in text file target.txt. If
 213 active platform is not specified, go to sub-directory which contains FPD files and
 214 type build. More information about active platform policy reference to specification
 215 <<EDK II Build and Packaging Architecture Specification>>.
 216
 217 -------------------------
 218 Individual Platform Builds
 219 -------------------------
 220 After running the setup command, you can build individual platforms.
 221   In the command window,
 222   1. Set active platform in target.txt, and type "build" in whatever directory;
 223   2. or cd to the platform (FPD file) that you want to build, and just type:
 224     c:\MyWork\edkii\EdkNt32Pkg\> build
 225
 226   Note that active platform with the high priority to build, that means active
 227   platform will be built even if exists FPD file under current directory. More
 228   information about active platform policy reference to specification
 229   <<EDK II Build and Packaging Architecture Specification>>.
 230
 231 Go to <full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe
 232 to run the Nt32 emulation platform under Microsoft Windows.
 233
 234 To exit the Nt32 emulation platform, you may type reset at the EFI Shell>
 235 command prompt.  Alternately, you may use the Graphical interface, Boot
 236 Maintenance Manager screen's Reset System command.
 237
 238 ------------------------
 239 Individual Module Builds
 240 ------------------------
 241 After running the setup command, you can build individual modules.
 242   In the command window, cd to the module that you want to build, and just
 243   type:
 244     c:\MyWork\edkii\MdePkg\Library\BaseLib\> build
 245
 246   Note active platform must be set for individual module build.
 247
 248 -------------------------------------------------------------------------------
 249 A Word on Apache-ANT
 250 --------------------
 251 The Apache-ANT program is a build tool that uses XML-based project files.
 252 Similar to Makefiles, these project files may contain multiple targets.  Most
 253 build.xml files in EDK II are auto-generated; any edits performed on the
 254 build.xml files will be overwritten the next time build is executed.
 255
 256 Pre-defined targets in the build.xml file include:
 257     all      - This target builds binaries for defined architectures
 258     clean    - This target removes object files generated by commands
 259     cleanall - This target removes all generated files and directories.
 260
 261 A Word on GCC tool chain
 262 ------------------------
 263 EDK II will not compile with a standard Linux gcc tool chain. While Linux
 264 distributions are usually based on ELF, EDK II requires a version of gcc
 265 that is configured to produce PE-COFF images. You will find a script in
 266 edk2/Tools/gcc that will download, configure, compile, and install a gcc
 267 4.X cross-compile tool chain for EDK II development. It has support for
 268 the IA32 architecture. It can be built and run on Cygwin, Linux, and many
 269 other POSIX compliant host operating environments. There are a few tools
 270 that you will need on your host computer in order to compile the tool
 271 chain. Among them are bash, gcc, gmake, curl (or wget).
 272
 273 -------------------------------------------------------------------------------
 274
 275 General Information:
 276 ===============================================================
 277 Mechanisms:
 278 ----------
 279 A brief overview:
 280
 281 A) Surface Area Package Description (SPD) file contains information about the
 282 modules that the package contains, including the location of all MSA files, and
 283 public library names and headers that might be provided by a module in the
 284 package.  Packages are defined by SPD files.  (Found in the root of the Package
 285 subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "EDK Build
 286 and Packaging Architecture Specification" document.
 287
 288 B) Module Surface Area Definition (MSA) files.  A description of a module's
 289 surface area, with all module specific default flags and features specified.
 290 Refer to the "Module Surface Area Architecture Specification" for additional
 291 details. The MSA is further explained in the "EDK II Build Packaging Architecture
 292 Specification" document.
 293
 294 C) Framework Platform Description (FPD) files.  A description of a platform's
 295 surface are, including a list of modules that are needed by the platform.  To
 296 support individual module builds, developers are not required to provide
 297 information about specific flash devices, nor flash device layout.  There are
 298 specific sections in the FPD file that do control aspects of the build, such
 299 as the Supported Architectures and Build Targets, as well as the tool flags
 300 that are used to create the binary files.  A valid platform file can specify
 301 zero or more modules, so individual modules can be compiled within the context
 302 of a platform (FPD) definition.
 303
 304 D) Platform Configuration Database (PCD).  A platform database which contains a
 305 variety of current platform settings or directives by which a driver or
 306 application can interact with.  The PCD is defined by the PCD_Protocol (This is
 307 further explained in the "Platform Configuration Database Infrastructure
 308 Description" document.
 309
 310 E) Library Class.  A library class is a logical grouping of similar functions.
 311 When developing components, the module surface area declares the class of
 312 libraries that can be used by the component. The MSA and SPD files can specify
 313 a recommended instance of the library that a platform integrator may select,
 314 however this is only a recommendation.  The PI may choose to select a different
 315 library instance to be used during compilation/linking. All library type modules
 316 must include header files in their distribution package, as well as their MSA
 317 files. Components, on the other hand, need only provide an MSA and either source
 318 or binary files when distributing packages.  The Library Classes are further
 319 explained in the "EDK II Build and Packaging Architecture Specification"
 320 document.
 321
 322 =========================================================================
 323 The common operations by developers of new modules are:
 324 -------------------------------------------------------
 325
 326 1) How to manually create a new module in a package:
 327   - The module source code must first be created in an appropriate directory
 328     (under the package the module is to be a part of.)
 329   - An MSA file must be created, spelling out all aspects of the module.
 330   - The MSA must be added to the SPD for the package to include the module.
 331
 332 -----------------------------------------
 333 2) Add/Remove module(s) to/from a package:
 334
 335   - Setup environment as Build
 336   - Add a module to a package
 337      * Generate the module SurfaceArea description file
 338      * Add a new <Filename> element under <MsaFiles> into
 339        <PackageDir>\<PackageName>.spd, using relative path to package
 340      * Add a new <ModuleSA> entry under each <FrameworkModules> into
 341        <PackageDir>\<PackageName>.fpd file if necessary.
 342
 343    - Remove a module from a package
 344      * Comment out or remove corresponding <Filename> element under <MsaFiles>
 345        from <PackageDir>\<PackageName>.spd
 346      * Comment out or remove corresponding <ModuleSA> entry under each
 347        <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary.
 348
 349 -----------------------------------
 350 3) How to manually create a package:
 351   - Identify the modules that are to be members of the project.
 352   - Identify the Variables and Guids required in and of the Package (including
 353     consumption/production information).
 354   - Create an SPD file defining these modules and calling out their MSA files.
 355   - add a new <Filename> element under <PackageList> into
 356     Tools\Conf\FrameworkDatabase.db, using the relative path to workspace.
 357
 358 --------------------------------------
 359 4) Declare a new Protocol in a package:
 360   - This release requires manual editing of the SPD file, adding the protocol
 361     to the ProtocolDeclarations section of the file.
 362   - Add the Protocol .h file to the Include\Protocol directory.
 363   - Add an <Entry> to the <ProtocolDeclarations> element in the
 364     <PackageName>.spd file
 365      * Each line contains Protocol base name then the global variable name and
 366        then the hex value of the Protocol GUID.
 367
 368 Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):
 369 <ProtocolDeclarations>
 370   <Entry Name="Bds">
 371     <C_Name>gEfiBdsArchProtocolGuid</C_Name>
 372     <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>
 373     <HelpText/>
 374   </Entry>
 375   <Entry Name="Cpu">
 376     <C_Name>gEfiCpuArchProtocolGuid</C_Name>
 377     <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>
 378     <HelpText/>
 379   </Entry>
 380 </ProtocolDeclarations>
 381
 382 ---------------------------------
 383 5) Declare a new PPI in a package:
 384  - This release requires manual editing of the SPD file
 385   - Add the PPI .h file to the Include\Ppi directory.
 386   - Add an <Entry> to the package <PpiDeclarations> element in the
 387     <PackageName>.spd file
 388      * Each line contains PPI base name then the global variable name and then
 389        the hex value of the PPI GUID.
 390
 391 Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):
 392 <PpiDeclarations>
 393   <Entry Name="BootInRecoveryMode">
 394     <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>
 395     <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>
 396     <HelpText/>
 397   </Entry>
 398   <Entry Name="CpuIo">
 399     <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>
 400     <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>
 401     <HelpText/>
 402   </Entry>
 403 </PpiDeclarations>
 404
 405 ----------------------------------
 406 6) Declare a new GUID in a package:
 407   - This release requires manual editing of the SPD file to include the new
 408     Guid.  This is identical to adding a ProtocolDeclaration or PpiDeclaration
 409     element as described above.
 410
 411 ---------------------------------------
 412 7) Declare a new PCD entry in a package:
 413   - This release requires manual editing of the SPD file to include the new
 414     PCD.  New Pcd entries are added to the PcdDefinitions section of the
 415     <PackageName>.spd file using the following example for the format:
 416     NOTE: The hex <Token> value must be unique.
 417
 418 <PcdDeclarations>
 419   <PcdEntry ItemType="FIXED_AT_BUILD">
 420     <C_Name>PcdMaximumUnicodeStringLength</C_Name>
 421     <Token>0x00000001</Token>
 422     <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
 423     <DatumType>UINT32</DatumType>
 424     <ValidUsage>FIXED_AT_BUILD</ValidUsage>
 425     <DefaultValue>1000000</DefaultValue>
 426     <HelpText>The maximum lengh for unicode string.</HelpText>
 427   </PcdEntry>
 428 </PcdDeclarations>
 429
 430 ------------------------------
 431 8) Declare a new Library Class:
 432   - This release requires manual editing of the SPD file to include the new
 433     Library Class.  New Library Class entries are added to the
 434     LibraryClassDeclarations seection of the <PackageName>.spd file using
 435     the following example for the format:
 436
 437 <LibraryClassDeclarations>
 438   <LibraryClass Name="BaseLib">
 439     <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>
 440     <HelpText/>
 441   </LibraryClass>
 442   <LibraryClass Name="BaseMemoryLib">
 443     <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>
 444     <HelpText/>
 445   </LibraryClass>
 446 </LibraryClassDeclarations>
 447
 448 =======================================================
 449 Notes:
 450 ------
 451 The EDK II represents significant changes in the structure of the EDK.
 452 Therefore it is very difficult to isolate all of the changes of this version of
 453 the EDK with the previous (EDK 1.0) version.
 454
 455 Of particular note:
 456
 457 1) EDK II contains new hardware feature support for the ICH SMBUS Libraries.
 458    These libraries are provided to make Memory Reference Code (MRC) development
 459    easier.
 460 2) The MDE Libraries - The MDE libraries represent significant changes in source
 461    (with only limited changes in functionality.)  These new libraries conform
 462    to the "MDE Library Specification".
 463 3) The Fat Binary and the EDK Shell Binary Packages are functionally identical
 464    to the EDK 1.0 version.
 465 4) The EDK tools directory has been expanded to include more tools and more
 466    tool functionality.
 467 5) The EDK NT32 section has been ported to the new build process, but
 468    functionally remains the same as the EDK 1.0 version.
 469 6) The Application "HelloWorld" has been ported to EDK II as well.
 470
 471 =======================================================
 472 Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no
 473 virus detected.
 474