Intel(R) Platform Innovation Framework for EFI\r
-EFI Development Kit 2.0 (EDK 2.0) \r
-Alpha Release\r
-2006-04-26\r
+EFI Development Kit II (EDK II) \r
+Root Package 1.00\r
+2006-07-06\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
EdkModulePkg - A package containing reference drivers\r
EdkFatBinPkg - A package containing binary DXE drivers for the Fat 32 file\r
system\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 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
-----------------------\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, 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
+Edit the text file, target.txt, located in the Tools/Conf directory. This \r
+file contains the tools defintion file and ative platform. It can also restrict\r
+current build target(s), tagname(s) and arch(s). Uncomment the line ACTIVE_PLATFORM\r
+which is commented out by default. \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)\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
Java applications and libraries.\r
\r
Once this is completed, you are ready to test the Build, by executing:\r
- c:\MyWork\Edk2.0\> ant\r
+ c:\MyWork\Edk2.0\> build\r
\r
-This command builds all of the packages, including the NT32 reference platform.\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
\r
-------------------------\r
-Individual Package Builds\r
+Individual Platform Builds\r
-------------------------\r
-After running the setup command, you can build individual packages.\r
- In the command window, cd to the package that you want to build, and just\r
- type:\r
- c:\MyWork\Edk2.0\EdkNt32Pkg\> ant\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.0\EdkNt32Pkg\> build\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
-The EdkNt32Pkg has a special target; "run" that will execute the Nt32 emulation\r
-platform under Microsoft Windows.\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
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
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.0\MdePkg\Library\BaseLib\> ant\r
+ c:\MyWork\Edk2.0\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
details. The MSA is further explained in the "Build Packaging Specification"\r
document.\r
\r
-C) Module Build Description (MDB). The "as-built" definition file that contains\r
-only the changes to the default flags defined in the MSA. The MSA and MDB are\r
-further explained in the "Build Packaging Specification" document.\r
-\r
-D) Platform Configuration Database (PCD). A platform database which contains a\r
+C) 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
\r
-E) Library Class. A library class is a logical grouping of similar functions.\r
+D) 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 MBD file specifies the\r
instance(s) of the library that will be used during compilation/linking. All\r
\r
- Setup environment as Build\r
- Add a module to a package\r
- * Generate the module SurfaceArea description file and build description\r
- file\r
- * Run GenBuildFile.bat under <PackageDir> to generate an entrance\r
- build.xml for the module\r
- * Add a new <MsaFile> element under <MsaFiles> into\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 <TianoImage> into\r
- <PackageDir>\<PackageName>.fpd file\r
+ * Add a new <ModuleSA> entry under each <FrameworkModules> into\r
+ <PackageDir>\<PackageName>.fpd file if necessary. \r
\r
- Remove a module from a package\r
- * Comment out or remove corresponding <MsaFile> element under <MsaFiles>\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
- <TianoImage> from <PackageDir>\<PackageName>.fpd\r
+ <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary. \r
\r
-----------------------------------\r
3) How to manually create a package:\r
- Identify the Variables and Guids required in and of the Package (including\r
consumption/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
\r
--------------------------------------\r
4) Declare a new Protocol in a package: \r
\r
Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):\r
<ProtocolDeclarations>\r
- <Entry Name="UnicodeCollation">\r
- <C_Name>gEfiUnicodeCollationProtocolGuid</C_Name>\r
- <Guid>{ 0x1d85cd7f, 0xf43d, 0x11d2, 0x9a, 0xc, 0x0, 0x90, 0x27,\r
- 0x3f, 0xc1, 0x4d }</Guid>\r
- <Entry Name="UsbHc">\r
- <C_Name>gEfiUsbHcProtocolGuid</C_Name>\r
- <Guid>{ 0xf5089266, 0x1aa0, 0x4953, 0x97, 0xd8, 0x56, 0x2f, 0x8a,\r
- 0x73, 0xb5, 0x19 }</Guid>\r
+ <Entry Name="Bds">\r
+ <C_Name>gEfiBdsArchProtocolGuid</C_Name>\r
+ <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>\r
+ <HelpText/>\r
+ </Entry>\r
+ <Entry Name="Cpu">\r
+ <C_Name>gEfiCpuArchProtocolGuid</C_Name>\r
+ <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>\r
+ <HelpText/>\r
+ </Entry>\r
+</ProtocolDeclarations>\r
\r
---------------------------------\r
5) Declare a new PPI in a package:\r
\r
Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):\r
<PpiDeclarations>\r
- <Entry Name="NtPeiLoadFile">\r
- <C_Name>gNtPeiLoadFilePpiGuid</C_Name>\r
- <Guid>{ 0xfd0c65eb, 0x405, 0x4cd2, 0x8a, 0xee, 0xf4, 0x0, 0xef, 0x13,\r
- 0xba, 0xc2 }</Guid>\r
+ <Entry Name="BootInRecoveryMode">\r
+ <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>\r
+ <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>\r
+ <HelpText/>\r
</Entry>\r
- <Entry Name="NtThunk">\r
- <C_Name>gPeiNtThunkPpiGuid</C_Name>\r
- <Guid>{ 0x98c281e5, 0xf906, 0x43dd, 0xa9, 0x2b, 0xb0, 0x3, 0xbf,\r
- 0x27, 0x65, 0xda }</Guid>\r
+ <Entry Name="CpuIo">\r
+ <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>\r
+ <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>\r
+ <HelpText/>\r
</Entry>\r
</PpiDeclarations>\r
\r
-\r
----------------------------------\r
6) Declare a new GUID in a package:\r
- This release requires manual editing of the SPD file to include the new\r
the following example for the format:\r
\r
<LibraryClassDeclarations>\r
- <LibraryClassDeclaration>\r
- <LibraryClass>BaseLib</LibraryClass>\r
+ <LibraryClass Name="BaseLib">\r
<IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>\r
- </LibraryClassDeclaration>\r
+ <HelpText/>\r
+ </LibraryClass>\r
+ <LibraryClass Name="BaseMemoryLib">\r
+ <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>\r
+ <HelpText/>\r
+ </LibraryClass>\r
</LibraryClassDeclarations>\r
\r
---------------------------------------\r
-9) Add a library instance to a package:\r
- - This requires manual MSA and MBD file.\r
-\r
------------------------------\r
-10) Add a module to a package:\r
- - This requires manual MSA and MBD editing\r
-\r
-\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 represent significant changes in source\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