ReleaseNotes.txt

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