Intel(R) Platform Innovation Framework for EFI\r
-EFI Development Kit II (EDK II) \r
+EFI Development Kit II (EDK II)\r
Root Package 1.00\r
2006-11-08\r
\r
-Intel is a trademark or registered trademark of Intel Corporation or its \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
+Copyright (c) 2006 - 2007, Intel Corporation\r
\r
-This document provides updates to documentation, along with a description on \r
+This document provides updates to documentation, along with a description on\r
how to install and build the EDK II.\r
\r
Package Contents\r
----------------\r
BuildNotes.txt - The build notes for this package.\r
- MdePkg - Industry-standard headers and libraries\r
- Tools - Build -specific tools that are designed to help the \r
+ OldMdePkg - 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
EdkUnixPkg - Posix/Unix Emulation platform reference (Currently this\r
builds only on ia32 Linux, but is meant to be portable.)\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 Packages we recommend that you download all \r
+Note: MDE and MDK that appear in other documentation refer to the OldMdePkg and\r
+Tools packages, respectively. While, these two packages are the minimum\r
+requirement for developing EDK II Packages we 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
+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
\r
-Documents have the following filenames (to download these documents, see \93Notes \r
+Documents have the following filenames (to download these documents, see \93Notes\r
on Documentation?later in these Release Notes):\r
- EDK II Module Development Environment Library Specification, v0.58 \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
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 is not compatible \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
--------------\r
Compiler Tool Chains:\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
+ 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
-----------------------------------------------\r
The EDK II is being managed by the Subversion Source Control on Tianocore.org.\r
Subversion provides speed, security, and additional features. The\r
-recommended client is TortoiseSVN version 1.3.3. \r
+recommended client is TortoiseSVN version 1.3.3.\r
(Available at http://tortoisesvn.tigris.org/)\r
\r
The checkout procedures on the Tianocore.org Web site include\r
\r
\r
--------------------------------------------------------------------\r
-Notes On Required Tools (With examples for Windows, OS X, and Linux*) \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, install the \r
- following required tools in this order: \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
5. saxon8\r
\r
Java Development Kit:\r
- \r
+\r
The Java Environment Variable must be set before attempting to build.\r
For Sun JDK (see note below?:\r
set JAVA_HOME=c:\Java\jdk1.5.0_06 (Windows 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
+\r
?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 practice, it seems to work \r
- more reliably. \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 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, because the \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
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
+ The ant-contrib.jar file should be installed in the %ANT_HOME%\lib\r
directory.\r
\r
XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
compile the custom gcc tool chain, you need the following tools on your host\r
computer: bash, gcc, gmake, curl (or wget).\r
\r
-Only the MdePkg, EdkModulePkg and EdkUnixPkg are currently supported by gcc\r
+Only the OldMdePkg, EdkModulePkg and EdkUnixPkg are currently supported by gcc\r
builds. Other builds, such as the EdkNt32Pkg, will not compile with gcc. By\r
default, the edk2 will try to build the NT32.fpd, which is not supported by\r
gcc. So, you need to change the Tools/Conf/target.txt.\r
file mode. Unix mode will cause all the cygwin directories to be mounted in\r
binmode, while DOS will mount the dirs in textmode. Here is an example of a\r
cygwin install where the dirs are (properly) mounted in binmode.\r
-To view mount information, type: \r
+To view mount information, type:\r
mount\r
\r
C:\cygwin\bin on /usr/bin type user (binmode)\r
hard to debug. Textmode is required to retain or add the DOS ^M characters\r
in DOS batch files during file editing sessions.\r
\r
-You can switch from textmode to binmode for compilation by executing the \r
+You can switch from textmode to binmode for compilation by executing the\r
following:\r
mount -b --change-cygdrive-prefix cygdrive\r
\r
#\r
# PROPERTY Type Use Description\r
# ---------------- -------- -------- -----------------------------------------------------------\r
-# ACTIVE_PLATFORM Filename Recommended Specify the WORKSPACE relative Path and Filename \r
+# ACTIVE_PLATFORM Filename Recommended Specify the WORKSPACE relative Path and Filename\r
# of the platform FPD file that will be used for the build\r
# This line is required if and only if the current working\r
# directory does not contain one or more FPD files.\r
\r
ACTIVE_PLATFORM =\r
- \r
+\r
You can leave it black, as above, or set it to any .fpd file in the workspace.\r
If you leave it blank, then you just cd to the dir that contains the .fpd that\r
-you would like to build (MdePkg/ or EdkModulePkg/) and then type build.\r
+you would like to build (OldMdePkg/ or EdkModulePkg/) and then type build.\r
\r
----------------------------\r
A Word on compiling on Linux\r
-----------------------------------------\r
\r
Cygwin is a POSIX style operating environment for Windows. It is possible to\r
-compile the EDK 2 using gcc and cygwin. Compiling under cygwin is slow, because \r
-the underlying file accesses are slow in cygwin. For this reason, we do not \r
-encourage the use of cygwin. A true unix system will be a superior choice for \r
+compile the EDK 2 using gcc and cygwin. Compiling under cygwin is slow, because\r
+the underlying file accesses are slow in cygwin. For this reason, we do not\r
+encourage the use of cygwin. A true unix system will be a superior choice for\r
those wishing to compile with gcc.\r
\r
Make sure that you select the e2fsprogs development package when you install\r
A Word on gcc for Processor Architectures\r
----------------------------------------\r
\r
-Currently gcc support is limited to IA-32 builds, generating IA-32 PE32 images. \r
+Currently gcc support is limited to IA-32 builds, generating IA-32 PE32 images.\r
\r
-The X64 bit (Intel 64, etc.) support under the gcc compiler does not support the EFIAPI \r
-calling convention (as defined in the UEFI 2.0 specification Chapter 2), so it is not \r
-possible to build a working EFI image for an X64 environment. Since the x64 gcc does \r
-not support the EFIAPI calling convention the x64 tools do not support generating a \r
-PE32+ image. The EFIAPI calling convention is very similar to the Microsoft x64 \r
+The X64 bit (Intel 64, etc.) support under the gcc compiler does not support the EFIAPI\r
+calling convention (as defined in the UEFI 2.0 specification Chapter 2), so it is not\r
+possible to build a working EFI image for an X64 environment. Since the x64 gcc does\r
+not support the EFIAPI calling convention the x64 tools do not support generating a\r
+PE32+ image. The EFIAPI calling convention is very similar to the Microsoft x64\r
calling convention.\r
\r
We have added prelinary support for the MinGW64 Tool chain. This gcc tool\r
TOOL_CHAIN_TAG = ELFGCC\r
\r
Once that is setup, type build, and then you will end up with the simulator in\r
-Build/Unix/DEBUG_ELFGCC/IA32/SecMain.exe. \r
+Build/Unix/DEBUG_ELFGCC/IA32/SecMain.exe.\r
\r
In order to use the gdb debugger with the simulator, you may need to load the\r
correct symbol file for the various modules that are loaded. For example,\r
The URL of the document repository is:\r
https://edk2.tianocore.org/svn/edk2/trunk/docs\r
\r
- \r
+\r
-------------------------------------------------------------------------------\r
Quick Start\r
-----------\r
-(assumes Microsoft Tools and OS environment, for GCC Tools or Linux, see \r
+(assumes Microsoft Tools and OS environment, for GCC Tools or Linux, see\r
"Detailed Starting Instructions" below)\r
\r
Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
To test your tool chain setup and to build the supplied tools, execute:\r
c:\MyWork\edk2\> edksetup ForceRebuild\r
\r
-(The edksetup script is referred to as the setup command throughout the \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
c:\> set WORKSPACE=C:\MyWork\edk2\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
+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
Once this is completed, you are ready to test the build, by executing:\r
c:\MyWork\edk2\> build\r
\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
+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.?\r
\r
-------------------------------------------------------------------------------\r
. edksetup.sh Rebuild # Unix-like systems\r
edksetup.bat Rebuild # Windows\r
\r
-The edksetup script is referred to as the setup command throughout the \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 (edksetup)at the start of every \r
- session. This configures the environment to include the \r
+ NOTE: You should run the setup command (edksetup)at the start of every\r
+ session. This configures the environment to include the\r
TianoTools and the Java applications and libraries.\r
\r
Any changes to the tool source code or XML Schema documents require that\r
c:\> set WORKSPACE=C:\MyWork\edk2\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
+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\edk2\> 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
+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.?\r
\r
--------------------------\r
cd to the platform (FPD file) that you want to build and execute this command:\r
c:\MyWork\edk2\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
+ 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.?\r
\r
-To run the Nt32 emulation platform under Microsoft Windows, go to \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?at the EFI Shell>\r
Maintenance Manager's \93Reset System?command.\r
\r
NOTE: When creating a new platform, the Platform Name is restricted\r
- to a single word containing alphanumeric characters, underscore, dash, \r
- and period. The space character and other special characters are \r
+ to a single word containing alphanumeric characters, underscore, dash,\r
+ and period. The space character and other special characters are\r
not allowed.\r
\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\r
execute the build command:\r
- c:\MyWork\edk2\MdePkg\Library\BaseLib\> build\r
+ c:\MyWork\edk2\OldMdePkg\Library\BaseLib\> build\r
\r
- You must set the active platform in target.txt for individual module builds. \r
+ You must set the active platform in target.txt for individual module builds.\r
\r
-------------------------------------------------------------------------------\r
\r
General Information:\r
-=============================================================== \r
+===============================================================\r
Mechanisms\r
----------\r
A brief overview:\r
\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
+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 file is further explained in \93EDK II \r
+subdirectory (i.e. EdkNt32Pkg).) The SPD file is further explained in \93EDK II\r
Build and Packaging Architecture Specification.?\r
- \r
-B) Module Surface Area Definition (MSA) files. A description of a module's \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
-For additional details, see the "EDK II Module Surface Area Specification" and \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. \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
+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 that contains a\r
-variety of current platform settings or directives that can be accessed by 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
+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 (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
+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
-----------------------------------------------\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
+ (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
- 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
+ <PackageDir>\<PackageName>.fpd file if necessary.\r
\r
- Removing a module from a package:\r
- - Comment out or remove the corresponding <Filename> element under \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
+ <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary.\r
\r
-------------------------------\r
3) Manually creating a package:\r
- Identify the Variables and Guids required in and of the Package (including\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 the 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) Declaring a new Protocol in a package: \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
+ 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
+ - Add an <Entry> to the <ProtocolDeclarations> element in the\r
<PackageName>.spd file\r
- - Each line contains Protocol base name, followed by the global variable \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 \r
+Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD\r
file):\r
<ProtocolDeclarations>\r
<Entry Name="Bds">\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
+ - Add an <Entry> to the package <PpiDeclarations> element in the\r
<PackageName>.spd file\r
- - Each line contains the PPI base name, followed by the global variable \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
<HelpText>The maximum lengh for unicode string.</HelpText>\r
</PcdEntry>\r
</PcdDeclarations>\r
- \r
+\r
------------------------------\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
+ Library Class. New Library Class entries are added to the\r
LibraryClassDeclarations section of the <PackageName>.spd file using\r
the following example for the format:\r
\r
projects / mirror_edk2.git / commitdiff