BuildNotes.txt

   1 Intel(R) Platform Innovation Framework for EFI
   2 EFI Development Kit II (EDK II)
   3 Root Package 1.00
   4 2006-11-08
   5
   6 Intel is a trademark or registered trademark of Intel Corporation or its
   7 subsidiaries in the United States and other countries.
   8 * Other names and brands may be claimed as the property of others.
   9 Copyright (c) 2006, Intel Corporation
  10
  11 This document provides updates to documentation, along with a description on
  12 how to install and build the EDK II.
  13
  14 Package Contents
  15 ----------------
  16   BuildNotes.txt - The build notes for this package.
  17   MdePkg         - Industry-standard headers and libraries
  18   Tools          - Build -specific tools that are designed to help the
  19                    developer create and modify drivers and libraries
  20   EdkModulePkg   - Reference drivers
  21   EdkFatBinPkg   - Binary DXE drivers for the Fat 32 file system
  22   EdkShellBinPkg - Binary Shell applications and commands
  23   EdkNt32Pkg     - NT32 Emulation platform reference
  24
  25 Note: MDE and MDK that appear in other documentation refer to the MdePkg and
  26 Tools packages, respectively.  While, these two packages are the minimum
  27 requirement for developing EDK II Packages we recommend that you download all
  28 of the top-level files listed above.
  29
  30 The following package is available as a separate project, under a separate
  31 license, on the TianoCore.org website: https://fat-driver2.tianocore.org
  32
  33   EdkFatPkg      - A package containing source DXE drivers for the Fat 32 file
  34                    system
  35
  36 Documents have the following filenames (to download these documents, see \93Notes
  37 on Documentation?later in these Release Notes):
  38   EDK II Module Development Environment Library Specification, v0.58
  39       (MDE_Library_Spec_0_58.rtf)
  40   EDK II Build and Packaging Architecture Specification, v0.53
  41       (Build_Packaging_Spec_0_53.rtf)
  42   EDK II Platform Configuration Database Infrastructure Description, v0.54
  43       (PCD_Infrastructure_0_54.rtf)
  44   EDK II Module Surface Area Specification, v0.51
  45       (Module_Surface_Area_0_50.rtf)
  46   EDK II Module Development Environment Package Specification, v0.51
  47       (MDE_Package_Spec_0_51.rtf)
  48   EDK II C Coding Standards Specification v0.51
  49       (C_Coding_Standards_Specification_ 0_51.rtf)
  50   EDK II Subversion Setup Guide
  51       (edk2-subversion-setup.rtf)
  52
  53 Pre-Requisites
  54 --------------
  55 The following list of tools must be installed on the development workstation
  56 prior to using the EDK II.
  57
  58 Compiler Tool Chain
  59       Microsoft* Visual Studio .NET 2003*  (http://www.microsoft.com)
  60     or
  61       A special GCC version 4.x or later (http://gcc.gnu.org). See below.
  62
  63 Assembler Tool Chain
  64       Microsoft Macro Assembler, version 6.15 or later
  65     or
  66       GNU binutils 2.16.1 or later
  67       (Http://ftp.gnu.org/gnu/binutils)
  68
  69 Java Development Kit ( Java 5.0 or later)
  70       Sun* jdk-1.5.0_06 or later (http://java.sun.com)
  71     or
  72       Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com)
  73
  74 Java Tools
  75     Apache-ANT, version 1.6.5 or later (http://ant.apache.org)
  76     Ant-contrib, version 1.0b2 or later
  77       (http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download)
  78     Saxon8, version 8.1.1
  79       (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)
  80     XMLBeans, version 2.1.0 (http://xmlbeans.apache.org)
  81       DO NOT download the latest XMLBeans, version 2.2.0. It is not compatible
  82       with Saxon8, version 8.1.1.
  83
  84 Other Tools
  85     TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)
  86
  87 Optional Tools
  88 --------------
  89 Compiler Tool Chains:
  90     Intel(R) C++ Compiler for Windows*, ver. 9.0 or later (http://www.intel.com)
  91     Intel(R) C Compiler for EFI Byte Code, ver. 1.2 or later
  92       (http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm)
  93     Microsoft Driver Development Kit, version 3790.1830 or later
  94       (http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx)
  95     Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later
  96     Intel ACPI Component Architecture, version 20060113
  97
  98 -----------------------------------------------
  99 Notes on Required Tools (Source Control System)
 100 -----------------------------------------------
 101 The EDK II is being managed by the Subversion Source Control on Tianocore.org.
 102 Subversion provides speed, security, and additional features. The
 103 recommended client is TortoiseSVN version 1.3.3.
 104  (Available at http://tortoisesvn.tigris.org/)
 105
 106 The checkout procedures on the Tianocore.org Web site include
 107 instructions for the use of Subversion Source Control.
 108
 109 The URL of the EDK II repository is:
 110   https://edk2.tianocore.org/svn/edk2/trunk/edk2
 111
 112
 113 --------------------------------------------------------------------
 114 Notes On Required Tools (With examples for Windows, OS X, and Linux*)
 115 --------------------------------------------------------------------
 116 Software Installation Order:
 117   After installing the compiler tools and your Subversion client, install the
 118   following required tools in this order:
 119     1. Java JDK
 120     2. Apache-Ant
 121     3. ant-contrib
 122     4. xmlbeans
 123     5. saxon8
 124
 125 Java Development Kit:
 126
 127    The Java Environment Variable must be set before attempting to build.
 128        For Sun JDK (see note below?:
 129               set JAVA_HOME=c:\Java\jdk1.5.0_06  (Windows example)
 130               export JAVA_HOME=/Library/Java/Home/ (OS X example)
 131               export JAVA_HOME=/usr/lib/j2sdk1.5-sun/ (Linux example)
 132        For Bea Systems:
 133               set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04
 134
 135   ?When using the Sun JDK5.0:
 136     During installation, you should specify the install directory as C:\Java
 137     instead of C:\Program Files\(or some other drive letter.)  While installing
 138     to this non-standard location is not required, in practice, it seems to work
 139     more reliably.
 140     For the JDK, the install path is C:\Java\jdk1.5.0_06
 141     For the JRE, the install path is C:\Java\jre1.5.0_06
 142     Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.
 143
 144     NOTE: You cannot combine the location for the JDK and the JRE, because the
 145     JRE install removes most of the binaries and libraries installed by the JDK
 146     install.
 147
 148 Java Tools:
 149     The Apache-ANT requires the ANT_HOME environment variable to be set before
 150     attempting to build:
 151          set ANT_HOME=c:\<full path to where ant was installed>
 152           export ANT_HOME=~/ExternalTools/apache-ant (OS X and Linux example)
 153
 154     The ant-contrib.jar file should be installed in the %ANT_HOME%\lib
 155     directory.
 156
 157     XMLBeans, requires the XMLBEANS_HOME environment variable to be set
 158     before attempting to build:
 159          set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>
 160           export XMLBEANS_HOME=~/ExternalTools/xmlbeans (OS X and Linux example)
 161
 162     Copy the saxon8.jar file to the %XMLBEANS_HOME%\lib directory.
 163
 164    The Ant and XMLBean tools must be in the path.
 165      MS system example:
 166         set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin
 167      Linux/OS X bash shell example:
 168         export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin
 169
 170 --------------------
 171 A Word on Apache-ANT
 172 --------------------
 173 The Apache-ANT program is a build tool that uses XML-based project files.
 174 Similar to Makefiles, these project files may contain multiple targets.  Most
 175 build.xml files in EDK II are auto-generated; any edits performed on the
 176 build.xml files will be overwritten by the next build.
 177
 178 Pre-defined targets in the build.xml file include:
 179     all      - This target builds binaries for defined architectures.
 180     clean    - This target removes object files generated by commands.
 181     cleanall - This target removes all generated files and directories.
 182
 183 ----------------------------
 184 A Word on the GCC Tool Chain
 185 ----------------------------
 186
 187 EDK II will not compile with a standard Linux gcc tool chain. While Linux
 188 distributions are usually based on ELF, EDK II requires a version of gcc that
 189 is configured to produce PE-COFF images. You will find a script in <Root of
 190 EDK2 tree>/Tools/gcc/tianoCross-gcc-4.1 that will download, configure, compile,
 191 and install a gcc 4.1 cross-compile tool chain for EDK II development. This
 192 custom tool chain supports the IA-32 architecture. It can be built and run on
 193 Cygwin, Linux, and many other POSIX-compliant host operating environments. To
 194 compile the custom gcc tool chain, you need the following tools on your host
 195 computer: bash, gcc, gmake, curl (or wget).
 196
 197 Only the MdePkg and EdkModulePkg are currently supported by gcc builds. Other
 198 builds, such as the EdkNt32Pkg, will not compile with gcc. By default, the edk2
 199 will try to build the NT32.fpd, which is not supported by gcc. So, you need to
 200 change the Tools/Conf/target.txt.
 201
 202 The cross-compile build script has been tested on Cygwin, OS X and Linux. You
 203 should expect to hack on these scripts to make them work on your system. You
 204 may need to install additional tools on your system to make the scripts work.
 205
 206 You will need
 207
 208   A recent version (3.0 or later should be fine) of gcc that is able to produce
 209     executables for the machine that you want to run this compiler on (the host
 210     machine).
 211   wget or curl (which enables the download of the gcc compiler source code)
 212   tar
 213   bzip
 214   gzip
 215   bash
 216   and possibly others
 217
 218 CYGWIN Notes
 219
 220 You should setup cygwin to use binmode on all mounts. When you initially
 221 install cygwin it gives you the choice of Unix file mode (recommended) or DOS
 222 file mode. Unix mode will cause all the cygwin directories to be mounted in
 223 binmode, while DOS will mount the dirs in textmode. Here is an example of a
 224 cygwin install where the dirs are (properly) mounted in binmode.
 225 To view mount information, type:
 226     mount
 227
 228 C:\cygwin\bin on /usr/bin type user (binmode)
 229 C:\cygwin\lib on /usr/lib type user (binmode)
 230 c:\workspace on /workspace type system (binmode)
 231 C:\cygwin on / type user (binmode)
 232
 233 If you use textmode, it is likely that the build will fail in a way that is
 234 hard to debug.  Textmode is required to retain or add the DOS ^M characters
 235 in DOS batch files during file editing sessions.
 236
 237 You can switch from textmode to binmode for compilation by executing the
 238 following:
 239     mount -b --change-cygdrive-prefix cygdrive
 240
 241 Cygwin is pretty slow, so it is not recommended for large builds.
 242
 243
 244
 245
 246
 247 The platform to be built is identified by the Tools/Conf/target.txt file:
 248
 249 #
 250 #  PROPERTY              Type       Use         Description
 251 #  ----------------      --------   --------    -----------------------------------------------------------
 252 #  ACTIVE_PLATFORM       Filename   Recommended Specify the WORKSPACE relative Path and Filename
 253 #                                               of the platform FPD file that will be used for the build
 254 #                                               This line is required if and only if the current working
 255 #                                               directory does not contain one or more FPD files.
 256
 257 ACTIVE_PLATFORM       =
 258
 259 You can leave it black, as above, or set it to any .fpd file in the workspace.
 260 If you leave it blank, then you just cd to the dir that contains the .fpd that
 261 you would like to build (MdePkg/ or EdkModulePkg/) and then type build.
 262
 263 ----------------------------
 264 A Word on compiling on Linux
 265 ----------------------------
 266
 267 In order to compile on Linux, you will need to have the e2fsprogs-devel package
 268 installed.  Check your distribution for the rpm, deb or other package format.
 269 This package contains the uuid library and header that are used by some of the
 270 host tools.
 271
 272 If you are running on x86_64 Linux, then you should install a 64 bit version of
 273 the Java JDK. The version that was used was jdk-1_5_0_07-linux-amd64-rpm.bin.
 274 It may be downloaded from sun.com.
 275
 276 -----------------------------------------
 277 A Word on compiling under Cygwin with gcc
 278 -----------------------------------------
 279
 280 Cygwin is a POSIX style operating environment for Windows. It is possible to
 281 compile the EDK 2 using gcc and cygwin. Compiling under cygwin is slow, because
 282 the underlying file accesses are slow in cygwin. For this reason, we do not
 283 encourage the use of cygwin. A true unix system will be a superior choice for
 284 those wishing to compile with gcc.
 285
 286 Make sure that you select the e2fsprogs development package when you install
 287 cygwin. It is necessary for the GenFvImage tool.
 288
 289 ----------------------------------------
 290 A Word on gcc for Processor Architectures
 291 ----------------------------------------
 292
 293 Currently gcc support is limited to IA-32 builds, generating IA-32 PE32 images.
 294
 295 The X64 bit (Intel 64, etc.) support under the gcc compiler does not support the EFIAPI
 296 calling convention (as defined in the UEFI 2.0 specification Chapter 2), so it is not
 297 possible to build a working EFI image for an X64 environment.  Since the x64 gcc does
 298 not support the EFIAPI calling convention the x64 tools do not support generating a
 299 PE32+ image.  The EFIAPI calling convention is very similar to the Microsoft x64
 300 calling convention.
 301
 302 On Itanium?Processors the gcc compiler does not support generating a PE32+ image.
 303
 304 -----------------------
 305 Notes on Documentation
 306 -----------------------
 307 The documents are being managed by the Subversion Source Control on
 308 Tianocore.org.  The document repository is "docs" and must be checked out
 309 separately from the EDK II source tree. Refer to the checkout procedures on
 310 the Tianocore.org Web site for EDK II.
 311
 312 The URL of the document repository is:
 313   https://edk2.tianocore.org/svn/edk2/trunk/docs
 314
 315
 316 -------------------------------------------------------------------------------
 317 Quick Start
 318 -----------
 319 (assumes Microsoft Tools and OS environment, for GCC Tools or Linux, see
 320 "Detailed Starting Instructions" below)
 321
 322 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to
 323 check out the entire EDK II source tree.
 324
 325 In a command window, change to the top-level directory of the EDK II source.
 326
 327 To test your tool chain setup and to build the supplied tools, execute:
 328     c:\MyWork\edk2\> edksetup ForceRebuild
 329
 330 (The edksetup script is referred to as the setup command throughout the
 331 rest of this document.)
 332       NOTE: You should run the setup command at the start of every session.
 333             This configures the environment to include the TianoTools and the
 334             Java applications and libraries.
 335
 336 You will need to set the WORKSPACE environment variable, or run the edksetup
 337 script (without any arguments), any time you want to build.
 338
 339   Set the WORKSPACE environment variable, e.g.:
 340
 341     c:\> set WORKSPACE=C:\MyWork\edk2
 342
 343 You may need to edit the text files Tools/Conf/target.txt and
 344 Tools/Conf/tools_def.txt (created by edksetup) using your favorite
 345 text editor to ensure that the paths to the tools you want to use
 346 to build EDK II binaries are correct.  These files contain the default
 347 paths (as per the default installation of the tools), so a customized
 348 install may require this manual process.
 349
 350 Once this is completed, you are ready to test the build, by executing:
 351     c:\MyWork\edk2\> build
 352
 353 This command builds the active platform specified in text file target.txt. If
 354 the active platform is not specified target.txt, you must execute the build
 355 command from the sub-directory that contains FPD files. For more information
 356 about the active platform policy, see the \93EDK II Build and Packaging
 357 Architecture Specification.?
 358
 359 -------------------------------------------------------------------------------
 360 Detailed Starting Instructions
 361 ------------------------------
 362
 363 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to
 364 check out the entire EDK II source tree.
 365
 366 In a command window, change to the top-level directory of the EDK II source.
 367
 368 If the active compiler tool chain is GCC, you must set the
 369 environment variable, TOOL_CHAIN to "gcc" before running the
 370 edksetup script.  Example: export TOOL_CHAIN=gcc
 371
 372 To test your tool chain setup and to build the supplied tools, execute:
 373     c:\MyWork\edk2\> edksetup ForceRebuild
 374
 375 On Linux systems, you must source the edksetup.sh file to load the correct
 376 settings into your shell.
 377
 378     . edksetup.sh # Note the dot.
 379
 380 If you have recently updated your code from subversion, the tools will need to
 381 be rebuilt if there were any code changes made to them. You can request that
 382 the tools get rebuilt by typing:
 383
 384     . edksetup.sh Rebuild # Unix-like systems
 385     edksetup.bat Rebuild  # Windows
 386
 387 The edksetup script is referred to as the setup command throughout the
 388 rest of this document.
 389       NOTE: You should run the setup command (edksetup)at the start of every
 390             session.  This configures the environment to include the
 391             TianoTools and the Java applications and libraries.
 392
 393 Any changes to the tool source code or XML Schema documents require that
 394 you execute the following:
 395    c:\MyWork\edk2\> edksetup ForceRebuild
 396
 397 You must set the WORKSPACE environment variable, or run the edksetup
 398 script (without any arguments), any time you want to build.
 399
 400   Set the WORKSPACE environment variable, e.g.:
 401
 402     c:\> set WORKSPACE=C:\MyWork\edk2
 403
 404 You may need to edit the text files Tools/Conf/target.txt and
 405 Tools/Conf/tools_def.txt (created by edksetup) using your favorite
 406 text editor to ensure that the paths to the tools you want to use
 407 to build EDK II binaries are correct.  These files contain the default
 408 paths (as per the default installation of the tools), so a customized
 409 tool installation may require this manual process.
 410
 411 Once this is completed, you are ready to test the build, by executing:
 412     c:\MyWork\edk2\> build
 413
 414 This command builds the active platform specified in text file target.txt. If
 415 the active platform is not specified, go to the sub-directory that contains FPD
 416 files and execute the build command. For more information about the active
 417 platform policy, see the \93EDK II Build and Packaging Architecture
 418 Specification.?
 419
 420 --------------------------
 421 Individual Platform Builds
 422 --------------------------
 423 After running the setup command, you can build individual platforms.
 424 In the command window:
 425   Set the active platform in target.txt, and execute this command:
 426     c:\<directory>\> build
 427 or
 428   cd to the platform (FPD file) that you want to build and execute this command:
 429     c:\MyWork\edk2\EdkNt32Pkg\> build
 430
 431   Note that the active platform specified in target.txt overrides the platform
 432   specified by any FPD file in the current directory. For more   information
 433   about active platform policy, see the \93EDK II Build and Packaging Architecture
 434   Specification.?
 435
 436 To run the Nt32 emulation platform under Microsoft Windows, go to
 437 <full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe
 438
 439 To exit the Nt32 emulation platform, type \93reset?at the EFI Shell>
 440 command prompt.  Alternatively, from the graphical interface, select the Boot
 441 Maintenance Manager's \93Reset System?command.
 442
 443       NOTE: When creating a new platform, the Platform Name is restricted
 444       to a single word containing alphanumeric characters, underscore, dash,
 445       and period.  The space character and other special characters are
 446       not allowed.
 447
 448 -----------------------
 449 Notes on Symbolic Debug
 450 -----------------------
 451 To enable EFI Symbolic Debugging, make sure the target output is set to DEBUG
 452 in the text file Tools/Conf/target.txt and then modify the FPD <BuildOptions>
 453 <Options><Option BuildTargets="DEBUG" ToolCode="CC"> and append the following
 454 compiler options to the string:
 455 "/D EFI_GENERATE_SYM_FILE", "/D EFI_SYMBOLIC_DEBUG"
 456
 457 (If the Option line does not contain "/D EFI_DEBUG", you must add that
 458 option as well.)
 459
 460 ------------------------
 461 Individual Module Builds
 462 ------------------------
 463 After running the setup command, you can build individual modules.
 464   In the command window, cd to the module that you want to build, and
 465   execute the build command:
 466     c:\MyWork\edk2\MdePkg\Library\BaseLib\> build
 467
 468   You must set the active platform in target.txt for individual module builds.
 469
 470 -------------------------------------------------------------------------------
 471
 472 General Information:
 473 ===============================================================
 474 Mechanisms
 475 ----------
 476 A brief overview:
 477
 478 A) The Surface Area Package Description (SPD) file contains information about
 479 the modules that the package contains, including the location of all MSA files,
 480 and public library names and headers that might be provided by a module in the
 481 package.  Packages are defined by SPD files.  (Found in the root of the Package
 482 subdirectory (i.e. EdkNt32Pkg).) The SPD file is further explained in \93EDK II
 483 Build and Packaging Architecture Specification.?
 484
 485 B) Module Surface Area Definition (MSA) files.  A description of a module's
 486 surface area, with all module specific default flags and features specified.
 487 For additional details, see the "EDK II Module Surface Area Specification" and
 488 the "EDK II Build and Packaging Architecture Specification."
 489
 490 C) Framework Platform Description (FPD) files.  A description of a platform's
 491 surface are, including a list of modules that are needed by the platform.  To
 492 support individual module builds, developers are not required to provide
 493 information about specific flash devices, nor flash device layout.
 494 Specific sections in the FPD file control aspects of the build, such
 495 as the Supported Architectures and Build Targets, as well as the tool flags
 496 that are used to create the binary files.  A valid platform file can specify
 497 zero or more modules, so individual modules can be compiled within the context
 498 of a platform (FPD) definition.
 499
 500 D) Platform Configuration Database (PCD).  A platform database that contains a
 501 variety of current platform settings or directives that can be accessed by a
 502 driver or application.  The PCD is defined by the PCD_Protocol (This is
 503 further explained in the "EDK II Platform Configuration Database Infrastructure
 504 Description."
 505
 506 E) Library Class.  A library class is a logical grouping of similar functions.
 507 When developing components, the module surface area declares the class of
 508 libraries that can be used by the component. The MSA and SPD files can specify
 509 a recommended instance of the library that a platform integrator (PI) may
 510 select, however this is only a recommendation.  The PI may choose to select a
 511 different library instance to be used during compilation and linking. All
 512 library type modules must include header files in their distribution package,
 513 as well as their MSA files. Components, on the other hand, need provide only an
 514 MSA file and either source or binary files when distributing packages.  The
 515 Library Classes are further explained in the "EDK II Build and Packaging
 516 Architecture Specification."
 517
 518 =========================================================================
 519 The common operations by developers of new modules are:
 520 -----------------------------------------------
 521 1) Manually creating a new module in a package:
 522   - The module source code must first be created in an appropriate directory
 523     (under the package the module is to be a part of.)
 524   - An MSA file must be created, spelling out all aspects of the module.
 525   - The MSA must be added to the SPD for the package to include the module.
 526
 527 -----------------------------------------------------
 528 2) Adding and Removing modules to and from a package:
 529
 530   - Set up environment as Build
 531   - Adding a module to a package:
 532      - Generate the MSA file
 533      - Add a new <Filename> element under <MsaFiles> into
 534        <PackageDir>\<PackageName>.spd, using arelative path to the package
 535      - Add a new <ModuleSA> entry under each <FrameworkModules> into the
 536        <PackageDir>\<PackageName>.fpd file if necessary.
 537
 538    - Removing a module from a package:
 539      - Comment out or remove the corresponding <Filename> element under
 540        <MsaFiles> from <PackageDir>\<PackageName>.spd
 541      - Comment out or remove the corresponding <ModuleSA> entry under each
 542        <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary.
 543
 544 -------------------------------
 545 3) Manually creating a package:
 546   - Identify the modules that are to be members of the project.
 547   - Identify the Variables and Guids required in and of the Package (including
 548     consumption and production information).
 549   - Create an SPD file defining these modules and calling out their MSA files.
 550   - Add a new <Filename> element under <PackageList> into
 551     Tools\Conf\FrameworkDatabase.db, using the relative path to the workspace.
 552
 553 -----------------------------------------
 554 4) Declaring a new Protocol in a package:
 555   - This release requires manual editing of the SPD file, adding the protocol
 556     to the ProtocolDeclarations section of the file.
 557   - Add the Protocol .h file to the Include\Protocol directory.
 558   - Add an <Entry> to the <ProtocolDeclarations> element in the
 559     <PackageName>.spd file
 560      - Each line contains Protocol base name, followed by the global variable
 561        name, and        the hex value of the Protocol GUID.
 562
 563 Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD
 564 file):
 565 <ProtocolDeclarations>
 566   <Entry Name="Bds">
 567     <C_Name>gEfiBdsArchProtocolGuid</C_Name>
 568     <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>
 569     <HelpText/>
 570   </Entry>
 571   <Entry Name="Cpu">
 572     <C_Name>gEfiCpuArchProtocolGuid</C_Name>
 573     <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>
 574     <HelpText/>
 575   </Entry>
 576 </ProtocolDeclarations>
 577
 578 ------------------------------------
 579 5) Declaring a new PPI in a package:
 580   - This release requires manual editing of the SPD file
 581   - Add the PPI .h file to the Include\Ppi directory.
 582   - Add an <Entry> to the package <PpiDeclarations> element in the
 583     <PackageName>.spd file
 584      - Each line contains the PPI base name, followed by the global variable
 585        name and        the hex value of the PPI GUID.
 586
 587 Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):
 588 <PpiDeclarations>
 589   <Entry Name="BootInRecoveryMode">
 590     <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>
 591     <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>
 592     <HelpText/>
 593   </Entry>
 594   <Entry Name="CpuIo">
 595     <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>
 596     <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>
 597     <HelpText/>
 598   </Entry>
 599 </PpiDeclarations>
 600
 601 -------------------------------------
 602 6) Declaring a new GUID in a package:
 603   - This release requires manual editing of the SPD file to include the new
 604     Guid.  This is identical to adding a ProtocolDeclaration or PpiDeclaration
 605     element, as described above.
 606
 607 ------------------------------------------
 608 7) Declaring a new PCD entry in a package:
 609   - This release requires manual editing of the SPD file to include the new
 610     PCD.  New Pcd entries are added to the PcdDefinitions section of the
 611     <PackageName>.spd file using the following example for the format
 612     (NOTE: The hex <Token> value must be unique):
 613
 614 <PcdDeclarations>
 615   <PcdEntry ItemType="FIXED_AT_BUILD">
 616     <C_Name>PcdMaximumUnicodeStringLength</C_Name>
 617     <Token>0x00000001</Token>
 618     <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
 619     <DatumType>UINT32</DatumType>
 620     <ValidUsage>FIXED_AT_BUILD</ValidUsage>
 621     <DefaultValue>1000000</DefaultValue>
 622     <HelpText>The maximum lengh for unicode string.</HelpText>
 623   </PcdEntry>
 624 </PcdDeclarations>
 625
 626 ------------------------------
 627 8) Declaring a new Library Class:
 628   - This release requires manual editing of the SPD file to include the new
 629     Library Class.  New Library Class entries are added to the
 630     LibraryClassDeclarations section of the <PackageName>.spd file using
 631     the following example for the format:
 632
 633 <LibraryClassDeclarations>
 634   <LibraryClass Name="BaseLib">
 635     <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>
 636     <HelpText/>
 637   </LibraryClass>
 638   <LibraryClass Name="BaseMemoryLib">
 639     <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>
 640     <HelpText/>
 641   </LibraryClass>
 642 </LibraryClassDeclarations>
 643
 644 =======================================================
 645 EDK II Changes Relative to the original EDK:
 646 --------------------------------------------
 647 The EDK II represents significant changes in the structure of the EDK.
 648 Therefore, it is very difficult to isolate all of the changes of this version of
 649 the EDK with the original EDK.
 650
 651 Of particular note:
 652
 653 1) EDK II contains new hardware feature support for the ICH SMBUS Libraries.
 654    These libraries are provided to make Memory Reference Code (MRC) development
 655    easier.
 656 2) The MDE libraries represent significant changes in source
 657    (with only limited changes in functionality.)  These new libraries conform
 658    to the "EDK II Module Development Environment Library Specification.?
 659 3) The Fat Binary and the EDK Shell Binary Packages are functionally identical
 660    to the original EDK.
 661 4) The EDK tools directory has been expanded to include more tools and more
 662    tool functionality.
 663 5) The EDK NT32 section has been ported to the new build process, but
 664    functionally remains the same as the original EDK.
 665 6) The Application "HelloWorld" has been ported to EDK II as well.
 666
 667 =======================================================
 668 Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4890, no
 669 virus detected.