Intel(R) Platform Innovation Framework for EFI\r
-EFI Development Kit 2.0 (EDK 2.0) \r
+EFI Development Kit II (EDK II (EDK 2)) \r
Alpha Release\r
-2006-04-26\r
+2006-06-29\r
\r
Copyright (c) 2006, Intel Corporation\r
\r
This document provides updates to documentation, along with a description on \r
-how to install and build the Edk 2.0.\r
+how to install and build the EDK II.\r
\r
Package Contents\r
----------------\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 2.0 Packages. It is also recommended that the top level files included\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 2.0 Module Development Environment Library Specification v0.50 \r
+ EDK II Module Development Environment Library Specification v0.50 \r
(MDE_Library_Spec_0_50.rtf)\r
- EDK 2.0 Build and Packaging Architecture Specification v0.50\r
+ EDK II Build and Packaging Architecture Specification v0.50\r
(Build_Packaging_Spec_0_50.rtf)\r
- EDK 2.0 Platform Configuration Database Infrastructure Description v0.51\r
+ EDK II Platform Configuration Database Infrastructure Description v0.51\r
(PCD_Infrastructure_0_51.rtf)\r
- EDK 2.0 Module Surface Area v0.50\r
+ EDK II Module Surface Area v0.50\r
(Module_Surface_Area_0_50.rtf)\r
- EDK 2.0 Module Development Environment (MDE) Package Specification v0.50\r
+ EDK II Module Development Environment (MDE) Package Specification v0.50\r
(MDE_Package_Spec_0_50.rtf)\r
- EDK 2.0 C Coding Standards Specification v0.50\r
+ EDK II C Coding Standards Specification v0.50\r
(C_Coding_Standards_Specification_ 0_50.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 2.0.\r
+prior to using the EDK II.\r
\r
Compiler Tool Chain\r
Microsoft* Visual Studio .NET 2003* (http://www.microsoft.com)\r
or\r
- GCC version 4.x or later (http://gcc.gnu.org)\r
+ A special GCC version 4.x or later (http://gcc.gnu.org). See below.\r
\r
Assembler Tool Chain\r
Microsoft Macro Assembler, version 6.15 or later\r
or\r
- GCC version 4.x or later\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
\r
Java Tools\r
Apache-ANT, version 1.6.5 or later (http://ant.apache.org)\r
- Ant-contrib, version 1.0b2 or later (http://antcontrib.sourceforge.net)\r
+ Ant-contrib, version 1.0b2 or later\r
+ (http://sourceforge.net/project/showfiles.php?group_id=36177)\r
Saxon8, version 8.1.1\r
(http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)\r
XMLBeans, version 2.1.0 or later (http://xmlbeans.apache.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 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
+ (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
-The EDK 2.0 is being managed by the Subversion Source Control on Tianocore.org.\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
recommended client is TortoiseSVN version 1.3.3. \r
(Available at http://tortoisesvn.tigris.org/)\r
There are instructions for the use of Subversion Source Control on the\r
Tianocore.org website, as part of the checkout procedures.\r
\r
-The URL of the EDK 2.0 repository is:\r
+The URL of the EDK II repository is:\r
https://edk2.tianocore.org/svn/edk2/trunk/edk2\r
\r
-----------------------\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 2.0 source tree. Refer to the checkout procedures on\r
-the Tianocore.org website for EDK 2.0.\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
Quick Start\r
-----------\r
-Edit the text file, tools_def.txt, located in the Tools/Conf directory. This\r
-file contains the names of the compiler tool chains and the location of the\r
-compiler binaries. It has been pre-populated with the standard location for\r
-the Microsoft tool chains and includes the standard location of the Intel C \r
+Edit the text file, msft_tools_def.txt, located in the Tools/Conf directory.\r
+This file contains the names of the compiler tool chains and the location of\r
+the compiler binaries. It has been pre-populated with the standard location\r
+for the Microsoft tool chains and includes the standard location of the Intel C\r
Compiler for EFI Byte Code (EBC)\r
\r
Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
-checkout the entire EDK 2.0 source tree.\r
+checkout the entire EDK II source tree.\r
\r
-In a command window, change to the top level directory of the Edk 2.0 sources.\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
\r
c:\> set WORKSPACE=C:\MyWork\Edk2.0\r
\r
This command builds all of the packages, including the NT32 reference platform.\r
\r
+------------------------------------\r
+Build Architectures other than IA32.\r
+------------------------------------\r
+\r
+By default, we are set up to build the ia32 architecture. If you would like to\r
+build for IPF, x64 and EBC, please copy MdePkg/MdePkg-All-Arch.fpd to\r
+MdePkg/MdePkg.fpd. For EdkModulePkg, copy EdkModulePkg-All-Archs.fpd to\r
+EdkModulePkg.fpd. Note, you may also add only the architecture you want from\r
+the -All-Archs files to the main fpd file. This is preferred if you do not have\r
+all the compilers installed.\r
+\r
+Optionally, you may modify the path to the compiler in\r
+Tools/Conf/msft_tools_def.txt. The flags for the ARCH tool chain are set in the\r
+file names by Tools/Conf/VENDOR_tools.txt, where VENDOR is set in\r
+Tools/Conf/msft_tools.txt.\r
+\r
+For example, if IPF_VENDOR = WINDDK, then the flags for the IPF DDK compiler\r
+will be specified in Tools/Conf/winddk_tools.txt.\r
+\r
-------------------------\r
Individual Package Builds\r
-------------------------\r
The EdkNt32Pkg has a special target; "run" that will execute the Nt32 emulation\r
platform under Microsoft Windows.\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
+\r
------------------------\r
Individual Module Builds\r
------------------------\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 Edk2.0 are auto-generated; any edits performed on the\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 ant is executed.\r
\r
Pre-defined targets in the build.xml files include:\r
\r
A Word on GCC tool chain\r
------------------------\r
-You will find a script in the tree that will download, configure, compile, and\r
-install a gcc 4.0.2 tool chain for development. It has support for the ia32\r
-architecture. It can be built and run on Cygwin, Linux, and many other POSIX\r
-compliant host environments. There are a few tools that you will need on your\r
-host computer in order to compile the tool chain. Among them are bash, gcc,\r
-gmake, curl (or wget).\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 that is\r
+configured to produce PE-COFF images. You will find a script in edk2/Tools/gcc\r
+that will download, configure, compile, and install a gcc 4.X cross-compile\r
+tool chain for EDK II development. It has support for the ia32 architecture. It\r
+can be built and run on Cygwin, Linux, and many other POSIX compliant host\r
+operating environments. There are a few tools that you will need on your host\r
+computer in order to compile the tool chain. Among them are bash, gcc, gmake,\r
+curl (or wget).\r
\r
-------------------------------------------------------------------------------\r
\r
=============================================================== \r
Mechanisms:\r
----------\r
-A quick understanding:\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
=======================================================\r
Notes:\r
------\r
-The EDK 2.0 represents significant changes in the structure of the EDK.\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
\r
Of particular note:\r
\r
-1) EDK 2.0 contains new hardware feature support for the ICH SMBUS Libraries.\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 resent significant changes in source\r
+2) The MDE Libraries - 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
3) The Fat Binary and the EDK Shell Binary Packages are functionally identical\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
-6) The Application "HelloWorld" has been ported to EDK 2.0 as well.\r
+6) The Application "HelloWorld" has been ported to EDK II as well.\r
\r
=======================================================\r
Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no\r
projects / mirror_edk2.git / blobdiff