Intel(R) Platform Innovation Framework for EFI\r
EFI Development Kit II (EDK II) \r
Root Package 1.00\r
-2006-07-06\r
+2006-07-13\r
\r
+Intel is a trademark or registered trademark of Intel Corporation or its \r
+subsidiaries in the United States and other countries.\r
+* Other names and brands may be claimed as the property of others.\r
Copyright (c) 2006, Intel Corporation\r
\r
This document provides updates to documentation, along with a description on \r
Package Contents\r
----------------\r
ReleaseNote.txt- These release notes for the package.\r
- MdePkg - A package containing Industry Standard headers and libraries\r
- Tools - A package containing Build Specific tools which are designed\r
- to help the developer create and modify drivers and\r
- libraries\r
- EdkModulePkg - A package containing reference drivers\r
- EdkFatBinPkg - A package containing binary DXE drivers for the Fat 32 file\r
- system\r
+ MdePkg - Industry-standard headers and libraries\r
+ Tools - Build -specific tools that are designed to help the \r
+ developer create and modify drivers and libraries\r
+ EdkModulePkg - Reference drivers\r
+ EdkFatBinPkg - Binary DXE drivers for the Fat 32 file system\r
+ EdkShellBinPkg - Binary Shell applications and commands\r
+ EdkNt32Pkg - NT32 Emulation platform reference\r
+\r
+Note: MDE and MDK that appear in other documentation refer to the MdePkg and\r
+Tools packages, respectively. While, these two packages are the minimum \r
+requirement for developing EDK II Packageswe recommend that you download all \r
+of the top-level files listed above.\r
+\r
+The following package is available as a separate project, under a separate \r
+license, on the TianoCore.org website: https://fat-driver2.tianocore.org\r
+\r
EdkFatPkg - A package containing source DXE drivers for the Fat 32 file\r
system\r
- EdkShellBinPkg - A package containing binary Shell applications and commands\r
- EdkNt32Pkg - A package containing the NT32 Emulation platform reference\r
\r
-Note: MDE and MDK that appear in other documentation refer to the MdePkg and\r
-Tools packages. These two packages are the minimum requirement for developing\r
-EDK II Packages. It is also recommended that the top level files included\r
-with the EDK be downloaded in conjunction with these two packages.\r
-\r
-Note: Documents have the following filenames:\r
- EDK II Module Development Environment Library Specification v0.50 \r
- (MDE_Library_Spec_0_50.rtf)\r
- EDK II Build and Packaging Architecture Specification v0.50\r
- (Build_Packaging_Spec_0_50.rtf)\r
- EDK II Platform Configuration Database Infrastructure Description v0.51\r
- (PCD_Infrastructure_0_51.rtf)\r
- EDK II Module Surface Area v0.50\r
+Documents have the following filenames (to download these documents, see \93Notes \r
+on Documentation\94 later in these Release Notes):\r
+ EDK II Module Development Environment Library Specification, v0.58 \r
+ (MDE_Library_Spec_0_58.rtf)\r
+ EDK II Build and Packaging Architecture Specification, v0.53\r
+ (Build_Packaging_Spec_0_53.rtf)\r
+ EDK II Platform Configuration Database Infrastructure Description, v0.54\r
+ (PCD_Infrastructure_0_54.rtf)\r
+ EDK II Module Surface Area Specification, v0.51\r
(Module_Surface_Area_0_50.rtf)\r
- EDK II Module Development Environment (MDE) Package Specification v0.50\r
- (MDE_Package_Spec_0_50.rtf)\r
- EDK II C Coding Standards Specification v0.50\r
- (C_Coding_Standards_Specification_ 0_50.rtf)\r
+ EDK II Module Development Environment Package Specification, v0.51\r
+ (MDE_Package_Spec_0_51.rtf)\r
+ EDK II C Coding Standards Specification v0.51\r
+ (C_Coding_Standards_Specification_ 0_51.rtf)\r
+ EDK II Subversion Setup Guide\r
+ (edk2-subversion-setup.rtf)\r
\r
Pre-Requisites\r
--------------\r
The following list of tools must be installed on the development workstation\r
-prior to using the Edk II.\r
+prior to using the EDK II.\r
\r
Compiler Tool Chain\r
Microsoft* Visual Studio .NET 2003* (http://www.microsoft.com)\r
GNU binutils 2.16.1 or later\r
\r
Java Development Kit ( Java 5.0 or later)\r
- Sun* jdk-1.5.0_04 or later (http://java.sun.com)\r
+ Sun* jdk-1.5.0_06 or later (http://java.sun.com)\r
or\r
Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com)\r
\r
Saxon8, version 8.1.1\r
(http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)\r
XMLBeans, version 2.1.0 (http://xmlbeans.apache.org)\r
- DO NOT download the latest XMLBeans, version 2.2.0. It cannot work with\r
- Saxon8, version 8.1.1.\r
+ DO NOT download the latest XMLBeans, version 2.2.0. It is not compatible \r
+ with Saxon8, version 8.1.1.\r
\r
Other Tools\r
TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)\r
Optional Tools\r
--------------\r
Compiler Tool Chains:\r
- Intel C++ Compiler for Windows, ver. 9.0 or later (http://www.intel.com)\r
- Intel C Compiler for EFI Byte Code, ver. 1.2 or later \r
+ Intel(R) C++ Compiler for Windows*, ver. 9.0 or later (http://www.intel.com)\r
+ Intel(R) C Compiler for EFI Byte Code, ver. 1.2 or later \r
(http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm)\r
Microsoft Driver Development Kit, version 3790.1830 or later\r
(http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx)\r
Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later\r
Intel ACPI Component Architecture, version 20060113\r
\r
------------------------\r
-Notes On Required Tools (Source Control System)\r
------------------------\r
+-----------------------------------------------\r
+Notes on Required Tools (Source Control System)\r
+-----------------------------------------------\r
The EDK II is being managed by the Subversion Source Control on Tianocore.org.\r
-This software package provides speed, security, and additional features. The\r
+Subversion provides speed, security, and additional features. The\r
recommended client is TortoiseSVN version 1.3.3. \r
(Available at http://tortoisesvn.tigris.org/)\r
\r
-There are instructions for the use of Subversion Source Control on the\r
-Tianocore.org website, as part of the checkout procedures.\r
+The checkout procedures on the Tianocore.org Web site include\r
+instructions for the use of Subversion Source Control.\r
\r
The URL of the EDK II repository is:\r
https://edk2.tianocore.org/svn/edk2/trunk/edk2\r
\r
------------------------\r
-Notes On Documentation\r
------------------------\r
-The documents are being managed by the Subversion Source Control on\r
-Tianocore.org. The document repository is "docs" and must be checked out\r
-separately from the EDK II source tree. Refer to the checkout procedures on\r
-the Tianocore.org website for EDK II.\r
-\r
-The URL of the document repository is:\r
- https://edk2.tianocore.org/svn/edk2/trunk/docs\r
-\r
\r
------------------------\r
-Notes On Required Tools (With examples for Windows, OS X, and Linux) \r
------------------------\r
+--------------------------------------------------------------------\r
+Notes On Required Tools (With examples for Windows, OS X, and Linux*) \r
+--------------------------------------------------------------------\r
Software Installation Order:\r
- After installing the compiler tools and your Subversion client, the following\r
- required tools should be installed in order: \r
- Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8\r
+ After installing the compiler tools and your Subversion client, install the \r
+ following required tools in this order: \r
+ 1. Java JDK\r
+ 2. Apache-Ant\r
+ 3. ant-contrib\r
+ 4. xmlbeans\r
+ 5. saxon8\r
\r
Java Development Kit:\r
\r
The Java Environment Variable must be set before attempting to build.\r
- For Sun JDK (see note below*):\r
+ For Sun JDK (see note below\86):\r
set JAVA_HOME=c:\Java\jdk1.5.0_06 (Windows example)\r
export JAVA_HOME=/Library/Java/Home/ (OS X example)\r
export JAVA_HOME=/usr/lib/j2sdk1.5-sun/ (Linux example)\r
For Bea Systems:\r
set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04\r
\r
- *When using the Sun JDK5.0\r
+ \86 When using the Sun JDK5.0:\r
During installation, you should specify the install directory as C:\Java\r
instead of C:\Program Files\(or some other drive letter.) While installing\r
- to this non-standard location is not required. In use, it seems to work \r
+ to this non-standard location is not required, in practice, it seems to work \r
more reliably. \r
- For the JDK, the install path would be C:\Java\jdk1.5.0_06\r
- For the JRE, the install path would be C:\Java\jre1.5.0_06\r
+ For the JDK, the install path is C:\Java\jdk1.5.0_06\r
+ For the JRE, the install path is C:\Java\jre1.5.0_06\r
Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.\r
\r
- NOTE: You cannot combine the location for the JDK and the JRE, as the JRE\r
- install removes most of the binaries and libraries installed by the JDK\r
+ NOTE: You cannot combine the location for the JDK and the JRE, because the \r
+ JRE install removes most of the binaries and libraries installed by the JDK\r
install.\r
\r
Java Tools:\r
The Apache-ANT requires the ANT_HOME environment variable to be set before\r
attempting to build:\r
- i.e. set ANT_HOME=c:\<full path to where ant was installed>\r
+ set ANT_HOME=c:\<full path to where ant was installed>\r
export ANT_HOME=~/ExternalTools/apache-ant (OS X and Linux example)\r
\r
The ant-contrib.jar file should be installed in the %ANT_HOME%\lib \r
directory.\r
\r
- The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
+ XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
before attempting to build:\r
- i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
+ set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
export XMLBEANS_HOME=~/ExternalTools/xmlbeans (OS X and Linux example)\r
\r
- The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.\r
+ Copy the saxon8.jar file to the %XMLBEANS_HOME%\lib directory.\r
\r
- The Ant and XMLBean tools are required to be in the path.\r
+ The Ant and XMLBean tools must be in the path.\r
MS system example:\r
set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin\r
Linux/OS X bash shell example:\r
export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin\r
- \r
--------------------------------------------------------------------------------\r
-Quick Start\r
------------\r
-Copy the target.template file in the Tools/Conf directory to target.txt, which\r
-must also be in the Tools/Conf directory.\r
\r
-Edit the text file, target.txt, located in the Tools/Conf directory. This \r
-file contains options for setting the active platform and restricting the build. \r
-The restictions are used to limit the build output by specifying build target(s), \r
-tagname(s) and architecture(s) to less than the full set of possible options. \r
+--------------------\r
+A Word on Apache-ANT\r
+--------------------\r
+The Apache-ANT program is a build tool that uses XML-based project files.\r
+Similar to Makefiles, these project files may contain multiple targets. Most\r
+build.xml files in EDK II are auto-generated; any edits performed on the\r
+build.xml files will be overwritten by the next build.\r
\r
-The ACTIVE_PLATFORM must be set unless the current working directory contains one\r
-or more FPD files. All other options need not be set, however by unsetting these\r
-options (by removing the line from the file, or leaving the Value empty) will \r
-result in all available build possibilites when typing build. By default EDK II\r
-can build a matrix of binaries, using different target types, tool chain tags and \r
-architectures. Options to target.txt file are as follows:\r
+Pre-defined targets in the build.xml file include:\r
+ all - This target builds binaries for defined architectures.\r
+ clean - This target removes object files generated by commands.\r
+ cleanall - This target removes all generated files and directories.\r
\r
-ACTIVE_PLATFORM = Value REQUIRED\r
- Where Value is the WORKSPACE relative path and filename of a Framework Platform \r
- Definition (FPD) File. Example:\r
+----------------------------\r
+A Word on the GCC Tool Chain\r
+----------------------------\r
+EDK II will not compile with a standard Linux gcc tool chain. While Linux\r
+distributions are usually based on ELF, EDK II requires a version of gcc \r
+that is configured to produce PE-COFF images. You will find a script in \r
+edk2/Tools/gcc that will download, configure, compile, and install a gcc \r
+4.X cross-compile tool chain for EDK II development. This custom tool chain \r
+supports the IA-32 architecture. It can be built and run on Cygwin, Linux, and \r
+many other POSIX-compliant host operating environments. To compile the custom \r
+gcc tool chain, you need the following tools on your host computer: bash, gcc, \r
+gmake, curl (or wget).\r
+\r
+\r
+-----------------------\r
+Notes on Documentation\r
+-----------------------\r
+The documents are being managed by the Subversion Source Control on\r
+Tianocore.org. The document repository is "docs" and must be checked out\r
+separately from the EDK II source tree. Refer to the checkout procedures on\r
+the Tianocore.org Web site for EDK II.\r
\r
-ACTIVE_PLATFORM = MdePkg/MdePkg.fpd\r
+The URL of the document repository is:\r
+ https://edk2.tianocore.org/svn/edk2/trunk/docs\r
\r
-TARGET = Value OPTIONAL\r
- Where Value is a list of one or more of the following: DEBUG, RELEASE or a User\r
- Defined Target type, such as PERF. Example: \r
+ \r
+-------------------------------------------------------------------------------\r
+Quick Start\r
+-----------\r
+(assumes Microsoft Tools and OS environment, for GCC Tools or Linux, see \r
+"Detailed Starting Instructions" below)\r
\r
-TARGET = DEBUG RELEASE\r
+Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
+check out the entire EDK II source tree.\r
\r
-TARGET_ARCH = Value OPTIONAL\r
- Where Value is a list of one or more supported Architectures: IA32, X64, IPF or\r
- EBC. Example: \r
+In a command window, change to the top-level directory of the EDK II source.\r
\r
-TARGET_ARCH = IA32 X64 EBC\r
+To test your tool chain setup and to build the supplied tools, execute:\r
+ c:\MyWork\edkii\> edksetup ForceBuild\r
\r
-TOOL_CHAIN_CONF = Value OPTIONAL\r
- Where Value is the Filename of an alternate tools_def.txt file created by the\r
- user. The alternate tools_def.txt files must be in the Tools/Conf directory.\r
- These tool definitions are scoped to the WORKSPACE (location of the EDK \r
- installation) and cannot be shared between WORKSPACES. (You can copy the files\r
- from one workspace to another.) Example: \r
+(The edksetup script is referred to as the setup command throughout the \r
+rest of this document.)\r
+ NOTE: You should run the setup command at the start of every session.\r
+ This configures the environment to include the TianoTools and the\r
+ Java applications and libraries.\r
\r
-TOOL_CHAIN_CONF = alfred.txt\r
+You will need to set the WORKSPACE environment variable, or run the edksetup\r
+script (without any arguments), any time you want to build.\r
\r
-TOOL_CHAIN_TAG = Value OPTIONAL\r
- Where Value is a list of TagName entries as defined in the tools_def.txt file.\r
- The TagName can be used to specify different versions of a compiler, i.e., \r
- gcc 4.0 and gcc 4.1 which will allow you to build binaries with both tool chains \r
- during the same build - useful during testing of a new compiler tool chain, or \r
- for changing compiler flags to check out performance with a different set of \r
- flags than flags used for production. Example:\r
+ Set the WORKSPACE environment variable, e.g.:\r
\r
-TOOL_CHAIN_TAG = GCC40 GCC41\r
+ c:\> set WORKSPACE=C:\MyWork\edkii\r
\r
-To clear a restriction, just remove any data after the equal sign. To clear\r
-the TARGET_ARCH limitation that was set above, enter: \r
+You may need to edit the text files Tools/Conf/target.txt and\r
+Tools/Conf/tools_def.txt (created by edksetup) using your favorite \r
+text editor to ensure that the paths to the tools you want to use \r
+to build EDK II binaries are correct. These files contain the default \r
+paths (as per the default installation of the tools), so a customized \r
+install may require this manual process.\r
\r
-TARGET_ARCH =\r
+Once this is completed, you are ready to test the build, by executing:\r
+ c:\MyWork\edkii\> build\r
\r
------------\r
-Copy the tools_def.template file in Tools/Conf to tools_def.txt in the same\r
-directory.\r
-\r
-Edit the tools definition file, tools_def.txt, also located in the Tools/Conf \r
-directory. This file contains the names of the compiler tool chains and the \r
-location of the compiler binaries. It has been pre-populated with the standard \r
-location for the Microsoft tool chains and includes the standard location of \r
-the Intel C Compiler for EFI Byte Code (EBC.) In addition, EDK II provides\r
-support for Cygwin, Linux and OS X GCC compiler tool chains. A script has been\r
-provided in the Tools/gcc directory as well as instructions in obtaining and\r
-building a version of GCC that has been tested. The tools_def.txt file has\r
-the GCC binary locations that are created using this script.\r
-\r
-Both target.txt and tools_def.txt files are formatted as Property = Value, \r
-which must appear on a single line. Spanning a Value entry over multiple\r
-lines is not supported at this time. In the target.txt file, the Property is\r
-a single, uppercase word with underscore characters. These Property names are\r
-fixed by the build system. The tools_def.txt file's Property is an underscore\r
-delimited coding, which supports some user defined values. The coding for\r
-the Property is: TARGET_TAGNAME_ARCH_COMMAND_ATTR The Value, is either a \r
-full path, full path and filename or a reserved word.\r
-\r
-TARGET - DEBUG and RELEASE are predefined, however the user may define one or\r
- more of their own TARGET types in this file.\r
-\r
-TAGNAME - HOST, MSFT, GCC, INTC are predefined, however the user may define \r
- one or more of their own TAGNAME keywords in this file.\r
-\r
-ARCH - EDK II supports IA32, X64, IPF and EBC at this time.\r
-\r
-COMMAND - Predefined command codes are listed in the tools_def.txt file, however\r
- the user can specify additional command codes for their one, non-\r
- standard tools.\r
-\r
-ATTR - Predefined Attributes are listed in the tools_def.txt file.\r
-\r
-NOTE: The TAGNAME: HOST is reserved and MUST be defined in order to build the\r
- included Tiano tools from their C source files. These tools have been\r
- built and tested using both Microsoft and GCC tool chains.\r
-NOTE: The "*" symbol may be used as a wildcard character in most of these\r
- fields, refer to the tools_def.txt and the "EDK II Build and Packaging\r
- Architecture Specification" for more details.\r
+This command builds the active platform specified in text file target.txt. If \r
+the active platform is not specified target.txt, you must execute the build \r
+command from the sub-directory that contains FPD files. For more information \r
+about the active platform policy, see the \93EDK II Build and Packaging \r
+Architecture Specification.\94\r
\r
+-------------------------------------------------------------------------------\r
+Detailed Starting Instructions\r
+------------------------------\r
\r
------------\r
Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
-checkout the entire EDK II source tree.\r
+check out the entire EDK II source tree.\r
\r
-In a command window, change to the top level directory of the Edk II sources.\r
- Set the WORKSPACE environment variable, e.g.:\r
+In a command window, change to the top-level directory of the EDK II source.\r
\r
- c:\> set WORKSPACE=C:\MyWork\Edk2\r
+If the active compiler tool chain is GCC, you must set the\r
+environment variable, TOOL_CHAIN to "gcc" before running the\r
+edksetup script. Example: export TOOL_CHAIN=gcc\r
\r
-To test your tool chain setup and to build the Supplied Tools, execute:\r
- c:\MyWork\Edk2\> edksetup\r
+To test your tool chain setup and to build the supplied tools, execute:\r
+ c:\MyWork\edkii\> edksetup ForceBuild\r
\r
-On Unix systems you must source the edksetup.sh file to load the correct\r
+On Linux systems, you must source the edksetup.sh file to load the correct\r
settings into your shell.\r
\r
. edksetup.sh # Note the dot.\r
\r
-(This command will be referred to as the setup command throughout the rest of\r
-this document.)\r
+The edksetup script is referred to as the setup command throughout the \r
+rest of this document.\r
NOTE: You should run the setup command at the start of every session.\r
This configures the environment to include the TianoTools and the\r
Java applications and libraries.\r
\r
-If you are confident that none of the tool tool sources have changed, and you\r
-only want to set up the workspace environment you may execute:\r
- c:\MyWork\Edk2\> edksetup skip\r
+Any changes to the tool source code or XML Schema documents require that\r
+you execute the following:\r
+ c:\MyWork\edkii\> edksetup ForceBuild\r
+\r
+You must set the WORKSPACE environment variable, or run the edksetup\r
+script (without any arguments), any time you want to build.\r
\r
-Once this is completed, you are ready to test the Build, by executing:\r
- c:\MyWork\Edk2\> build\r
+ Set the WORKSPACE environment variable, e.g.:\r
\r
-This command builds active platform specified in text file target.txt. If \r
-active platform is not specified, go to sub-directory which contains FPD files and\r
-type build. More information about active platform policy reference to specification\r
-<<EDK II Build and Packaging Architecture Specification>>.\r
+ c:\> set WORKSPACE=C:\MyWork\edkii\r
\r
--------------------------\r
+You may need to edit the text files Tools/Conf/target.txt and\r
+Tools/Conf/tools_def.txt (created by edksetup) using your favorite \r
+text editor to ensure that the paths to the tools you want to use \r
+to build EDK II binaries are correct. These files contain the default \r
+paths (as per the default installation of the tools), so a customized \r
+tool installation may require this manual process.\r
+\r
+Once this is completed, you are ready to test the build, by executing:\r
+ c:\MyWork\edkii\> build\r
+\r
+This command builds the active platform specified in text file target.txt. If \r
+the active platform is not specified, go to the sub-directory that contains FPD \r
+files and execute the build command. For more information about the active \r
+platform policy, see the \93EDK II Build and Packaging Architecture \r
+Specification.\94\r
+\r
+--------------------------\r
Individual Platform Builds\r
--------------------------\r
+--------------------------\r
After running the setup command, you can build individual platforms.\r
- In the command window, \r
- 1. Set active platform in target.txt, and type "build" in whatever directory;\r
- 2. or cd to the platform (FPD file) that you want to build, and just type:\r
- c:\MyWork\Edk2\EdkNt32Pkg\> build\r
+In the command window:\r
+ Set the active platform in target.txt, and execute this command:\r
+ c:\<directory>\> build\r
+or\r
+ cd to the platform (FPD file) that you want to build and execute this command:\r
+ c:\MyWork\edkii\EdkNt32Pkg\> build\r
+\r
+ Note that the active platform specified in target.txt overrides the platform \r
+ specified by any FPD file in the current directory. For more information \r
+ about active platform policy, see the \93EDK II Build and Packaging Architecture\r
+ Specification.\94 \r
+\r
+To run the Nt32 emulation platform under Microsoft Windows, go to \r
+<full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe\r
+\r
+To exit the Nt32 emulation platform, type \93reset\94 at the EFI Shell>\r
+command prompt. Alternatively, from the graphical interface, select the Boot\r
+Maintenance Manager's \93Reset System\94 command.\r
+\r
+ NOTE: When creating a new platform, the Platform Name should be restricted\r
+ to a single word, containing alphanumeric characters, with special characters,\r
+ underscore, dash and the period character also allowed. Space characters and\r
+ other special characters are not allowed.\r
\r
- Note that active platform with the high priority to build, that means active \r
- platform will be built even if exists FPD file under current directory. More \r
- information about active platform policy reference to specification\r
- <<EDK II Build and Packaging Architecture Specification>>. \r
-\r
-Go to <full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe\r
-to run the Nt32 emulation platform under Microsoft Windows.\r
+-----------------------\r
+Notes on Symbolic Debug\r
+-----------------------\r
+To enable EFI Symbolic Debugging, make sure the target output is set to DEBUG\r
+in the text file Tools/Conf/target.txt and then modify the FPD <BuildOptions>\r
+<Options><Option BuildTargets="DEBUG" ToolCode="CC"> and append the following\r
+compiler options to the string:\r
+"/D EFI_GENERATE_SYM_FILE", "/D EFI_SYMBOLIC_DEBUG"\r
\r
-To exit the Nt32 emulation platform, you may type reset at the EFI Shell>\r
-command prompt. Alternately, you may use the Graphical interface, Boot\r
-Maintenance Manager screen's Reset System command.\r
+(If the Option line does not contain "/D EFI_DEBUG", you must add that\r
+option as well.)\r
\r
------------------------\r
Individual Module Builds\r
------------------------\r
After running the setup command, you can build individual modules.\r
- In the command window, cd to the module that you want to build, and just\r
- type:\r
- c:\MyWork\Edk2\MdePkg\Library\BaseLib\> build\r
+ In the command window, cd to the module that you want to build, and\r
+ execute the build command:\r
+ c:\MyWork\edkii\MdePkg\Library\BaseLib\> build\r
\r
- Note active platform must be set for individual module build. \r
-\r
--------------------------------------------------------------------------------\r
-A Word on Apache-ANT\r
---------------------\r
-The Apache-ANT program is a build tool that uses XML-based project files.\r
-Similar to Makefiles, these project files may contain multiple targets. Most\r
-build.xml files in EDK II are auto-generated; any edits performed on the\r
-build.xml files will be overwritten the next time build is executed.\r
-\r
-Pre-defined targets in the build.xml file include:\r
- all - This target builds binaries for defined architectures\r
- clean - This target removes object files generated by commands\r
- cleanall - This target removes all generated files and directories.\r
-\r
-A Word on GCC tool chain\r
-------------------------\r
-EDK II will not compile with a standard Linux gcc tool chain. While Linux\r
-distributions are usually based on ELF, EDK II requires a version of gcc \r
-that is configured to produce PE-COFF images. You will find a script in \r
-edk2/Tools/gcc that will download, configure, compile, and install a gcc \r
-4.X cross-compile tool chain for EDK II development. It has support for \r
-the IA32 architecture. It can be built and run on Cygwin, Linux, and many \r
-other POSIX compliant host operating environments. There are a few tools\r
-that you will need on your host computer in order to compile the tool \r
-chain. Among them are bash, gcc, gmake, curl (or wget).\r
+ You must set the active platform in target.txt for individual module builds. \r
\r
-------------------------------------------------------------------------------\r
\r
General Information:\r
=============================================================== \r
-Mechanisms:\r
+Mechanisms\r
----------\r
A brief overview:\r
\r
-A) Surface Area Package Description (SPD) file contains information about the\r
-modules that the package contains, including the location of all MSA files, and\r
-public library names and headers that might be provided by a module in the\r
+A) The Surface Area Package Description (SPD) file contains information about \r
+the modules that the package contains, including the location of all MSA files, \r
+and public library names and headers that might be provided by a module in the\r
package. Packages are defined by SPD files. (Found in the root of the Package\r
-subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "EDK Build \r
-and Packaging Architecture Specification" document.\r
+subdirectory (i.e. EdkNt32Pkg).) The SPD file is further explained in \93EDK II \r
+Build and Packaging Architecture Specification.\94\r
\r
B) Module Surface Area Definition (MSA) files. A description of a module's \r
surface area, with all module specific default flags and features specified.\r
-Refer to the "Module Surface Area Architecture Specification" for additional\r
-details. The MSA is further explained in the "EDK II Build Packaging Architecture \r
-Specification" document.\r
+For additional details, see the "EDK II Module Surface Area Specification" and \r
+the "EDK II Build and Packaging Architecture Specification."\r
\r
C) Framework Platform Description (FPD) files. A description of a platform's\r
surface are, including a list of modules that are needed by the platform. To\r
support individual module builds, developers are not required to provide\r
-information about specific flash devices, nor flash device layout. There are\r
-specific sections in the FPD file that do control aspects of the build, such \r
+information about specific flash devices, nor flash device layout. \r
+Specific sections in the FPD file control aspects of the build, such \r
as the Supported Architectures and Build Targets, as well as the tool flags \r
that are used to create the binary files. A valid platform file can specify \r
zero or more modules, so individual modules can be compiled within the context\r
of a platform (FPD) definition.\r
\r
-D) Platform Configuration Database (PCD). A platform database which contains a\r
-variety of current platform settings or directives by which a driver or\r
-application can interact with. The PCD is defined by the PCD_Protocol (This is\r
-further explained in the "Platform Configuration Database Infrastructure \r
-Description" document.\r
+D) Platform Configuration Database (PCD). A platform database that contains a\r
+variety of current platform settings or directives that can be accessed by a \r
+driver or application. The PCD is defined by the PCD_Protocol (This is\r
+further explained in the "EDK II Platform Configuration Database Infrastructure \r
+Description."\r
\r
E) Library Class. A library class is a logical grouping of similar functions.\r
When developing components, the module surface area declares the class of\r
libraries that can be used by the component. The MSA and SPD files can specify\r
-a recommended instance of the library that a platform integrator may select,\r
-however this is only a recommendation. The PI may choose to select a different\r
-library instance to be used during compilation/linking. All library type modules \r
-must include header files in their distribution package, as well as their MSA\r
-files. Components, on the other hand, need only provide an MSA and either source\r
-or binary files when distributing packages. The Library Classes are further \r
-explained in the "EDK II Build and Packaging Architecture Specification" \r
-document.\r
+a recommended instance of the library that a platform integrator (PI) may \r
+select, however this is only a recommendation. The PI may choose to select a \r
+different library instance to be used during compilation and linking. All \r
+library type modules must include header files in their distribution package, \r
+as well as their MSA files. Components, on the other hand, need provide only an \r
+MSA file and either source or binary files when distributing packages. The \r
+Library Classes are further explained in the "EDK II Build and Packaging \r
+Architecture Specification."\r
\r
=========================================================================\r
The common operations by developers of new modules are:\r
--------------------------------------------------------\r
-\r
-1) How to manually create a new module in a package:\r
+-----------------------------------------------\r
+1) Manually creating a new module in a package:\r
- The module source code must first be created in an appropriate directory\r
(under the package the module is to be a part of.) \r
- An MSA file must be created, spelling out all aspects of the module.\r
- The MSA must be added to the SPD for the package to include the module.\r
\r
------------------------------------------\r
-2) Add/Remove module(s) to/from a package:\r
-\r
- - Setup environment as Build\r
- - Add a module to a package\r
- * Generate the module SurfaceArea description file\r
- * Add a new <Filename> element under <MsaFiles> into\r
- <PackageDir>\<PackageName>.spd, using relative path to package\r
- * Add a new <ModuleSA> entry under each <FrameworkModules> into\r
+-----------------------------------------------------\r
+2) Adding and Removing modules to and from a package:\r
+\r
+ - Set up environment as Build\r
+ - Adding a module to a package:\r
+ - Generate the MSA file\r
+ - Add a new <Filename> element under <MsaFiles> into\r
+ <PackageDir>\<PackageName>.spd, using arelative path to the package\r
+ - Add a new <ModuleSA> entry under each <FrameworkModules> into the\r
<PackageDir>\<PackageName>.fpd file if necessary. \r
\r
- - Remove a module from a package\r
- * Comment out or remove corresponding <Filename> element under <MsaFiles>\r
- from <PackageDir>\<PackageName>.spd\r
- * Comment out or remove corresponding <ModuleSA> entry under each\r
+ - Removing a module from a package:\r
+ - Comment out or remove the corresponding <Filename> element under \r
+
<MsaFiles> from <PackageDir>\<PackageName>.spd
\r+ - Comment out or remove the corresponding <ModuleSA> entry under each\r
<FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary. \r
\r
------------------------------------\r
-3) How to manually create a package:\r
+-------------------------------\r
+3) Manually creating a package:\r
- Identify the modules that are to be members of the project.\r
- Identify the Variables and Guids required in and of the Package (including\r
- consumption/production information).\r
+ consumption and production information).\r
- Create an SPD file defining these modules and calling out their MSA files.\r
- -
add a new <Filename> element under <PackageList> into
\r- Tools\Conf\FrameworkDatabase.db, using the relative path to workspace. \r
+ -
Add a new <Filename> element under <PackageList> into
\r+ Tools\Conf\FrameworkDatabase.db, using the relative path to the workspace. \r
\r
---------------------------------------\r
-4) Declare a new Protocol in a package: \r
+-----------------------------------------\r
+4) Declaring a new Protocol in a package: \r
- This release requires manual editing of the SPD file, adding the protocol\r
to the ProtocolDeclarations section of the file. \r
- Add the Protocol .h file to the Include\Protocol directory.\r
- Add an <Entry> to the <ProtocolDeclarations> element in the \r
<PackageName>.spd file\r
- * Each line contains Protocol base name then the global variable name and\r
- then the hex value of the Protocol GUID.\r
+ - Each line contains Protocol base name, followed by the global variable \r
+ name, and the hex value of the Protocol GUID.\r
\r
-Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):\r
+Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD \r
+file):\r
<ProtocolDeclarations>\r
<Entry Name="Bds">\r
<C_Name>gEfiBdsArchProtocolGuid</C_Name>\r
</Entry>\r
</ProtocolDeclarations>\r
\r
----------------------------------\r
-5) Declare a new PPI in a package:\r
- - This release requires manual editing of the SPD file\r
+------------------------------------\r
+5) Declaring a new PPI in a package:\r
+ - This release requires manual editing of the SPD file\r
- Add the PPI .h file to the Include\Ppi directory.\r
- Add an <Entry> to the package <PpiDeclarations> element in the \r
<PackageName>.spd file\r
- * Each line contains PPI base name then the global variable name and then\r
- the hex value of the PPI GUID.\r
+ - Each line contains the PPI base name, followed by the global variable \r
+ name and the hex value of the PPI GUID.\r
\r
Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):\r
<PpiDeclarations>\r
</Entry>\r
</PpiDeclarations>\r
\r
-----------------------------------\r
-6) Declare a new GUID in a package:\r
+-------------------------------------\r
+6) Declaring a new GUID in a package:\r
- This release requires manual editing of the SPD file to include the new\r
Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration\r
- element as described above.\r
+ element, as described above.\r
\r
---------------------------------------- \r
-7) Declare a new PCD entry in a package:\r
+------------------------------------------\r
+7) Declaring a new PCD entry in a package:\r
- This release requires manual editing of the SPD file to include the new\r
PCD. New Pcd entries are added to the PcdDefinitions section of the\r
- <PackageName>.spd file using the following example for the format:\r
- NOTE: The hex <Token> value must be unique.\r
+ <PackageName>.spd file using the following example for the format\r
+ (NOTE: The hex <Token> value must be unique):\r
\r
<PcdDeclarations>\r
<PcdEntry ItemType="FIXED_AT_BUILD">\r
</PcdDeclarations>\r
\r
------------------------------\r
-8) Declare a new Library Class:\r
+8) Declaring a new Library Class:\r
- This release requires manual editing of the SPD file to include the new\r
Library Class. New Library Class entries are added to the \r
- LibraryClassDeclarations se
ection of the <PackageName>.spd file using
\r+ LibraryClassDeclarations section of the <PackageName>.spd file using\r
the following example for the format:\r
\r
<LibraryClassDeclarations>\r
</LibraryClassDeclarations>\r
\r
=======================================================\r
-Notes:\r
-------\r
+EDK II Changes Relative to the original EDK:\r
+--------------------------------------------\r
The EDK II represents significant changes in the structure of the EDK.\r
-Therefore it is very difficult to isolate all of the changes of this version of\r
-the EDK with the previous (EDK 1.0) version.\r
+Therefore, it is very difficult to isolate all of the changes of this version of\r
+the EDK with the original EDK.\r
\r
Of particular note:\r
\r
1) EDK II contains new hardware feature support for the ICH SMBUS Libraries.\r
These libraries are provided to make Memory Reference Code (MRC) development\r
easier.\r
-2) The MDE Libraries - The MDE libraries represent significant changes in source\r
+2) The MDE libraries represent significant changes in source\r
(with only limited changes in functionality.) These new libraries conform\r
- to the "MDE Library Specification". \r
+ to the "EDK II Module Development Environment Library Specification.\94 \r
3) The Fat Binary and the EDK Shell Binary Packages are functionally identical\r
- to the EDK 1.0 version.\r
+ to the original EDK.\r
4) The EDK tools directory has been expanded to include more tools and more\r
tool functionality.\r
5) The EDK NT32 section has been ported to the new build process, but\r
- functionally remains the same as the EDK 1.0 version.\r
+ functionally remains the same as the original EDK.\r
6) The Application "HelloWorld" has been ported to EDK II as well.\r
\r
=======================================================\r
projects / mirror_edk2.git / blobdiff