Intel(R) Platform Innovation Framework for EFI\r
-EFI Development Kit II (EDK II (EDK 2)) \r
-Alpha Release\r
-2006-06-29\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
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
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
Java Tools\r
Apache-ANT, version 1.6.5 or later (http://ant.apache.org)\r
Ant-contrib, version 1.0b2 or later\r
- (http://sourceforge.net/project/showfiles.php?group_id=36177)\r
+ (http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download)\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
+ 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
\r
Other Tools\r
TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)\r
\r
\r
-----------------------\r
-Notes On Required Tools (MS Windows environment example)\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
Java Development Kit:\r
\r
The Java Environment Variable must be set before attempting to build.\r
- i.e. For Sun JDK (see note below*):\r
- set JAVA_HOME=c:\ Java\jdk1.5.0_06 \r
- i.e. For Bea Systems:\r
- set JAVA_HOME=c:\Program Files\Java\jrockit-R26.0.0-jdk1.5.0_04\r
+ For Sun JDK (see note below*):\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
During installation, you should specify the install directory as C:\Java\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
+ 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
before attempting to build:\r
- i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
+ i.e. 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
\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
- \r
Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
checkout 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 sources.\r
\r
- c:\> set WORKSPACE=C:\MyWork\Edk2.0\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.0\> edksetup\r
+ c:\MyWork\edkii\> edksetup ForceBuild\r
+\r
+On Unix 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
This configures the environment to include the TianoTools and the\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
+Any changes to the tool source code or XML Schema documents will require that\r
+you run:\r
+ c:\MyWork\edkii\> edksetup ForceBuild\r
\r
-This command builds all of the packages, including the NT32 reference platform.\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
-------------------------------------\r
-Build Architectures other than IA32.\r
-------------------------------------\r
+ Set the WORKSPACE environment variable, e.g.:\r
+\r
+ c:\> set WORKSPACE=C:\MyWork\edkii\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
+You may need to edit the text files, Tools/Conf/target.txt and/or\r
+Tools/Conf/tools_def.txt (created by edksetup,) using your favorite \r
+text editor to point to the tools you want to use to build EDK II binaries.\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
+Once this is completed, you are ready to test the Build, by executing:\r
+ c:\MyWork\edkii\> build\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
+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\edkii\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\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
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 ant is executed.\r
+build.xml files will be overwritten the next time build is executed.\r
\r
-Pre-defined targets in the build.xml files include:\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
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 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
+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
\r
-------------------------------------------------------------------------------\r
\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
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 "Build \r
-Packaging Specification" document.\r
+subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "EDK Build \r
+and Packaging Architecture Specification" document.\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 "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
+details. The MSA is further explained in the "EDK II Build Packaging Architecture \r
+Specification" document.\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
+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
\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 MBD file specifies the\r
-instance(s) of the library that will be used during compilation/linking. All\r
-library type modules must include header files in their distribution package,\r
-as well as their surface area and module build description files. Components,\r
-on the other hand, need only provide the binary and build description files\r
-when distributing BINARY packages. The Library Classes are further explained\r
-in the "Build Packaging Specification" document.\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
\r
=========================================================================\r
The common operations by developers of new modules are:\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
element as described above.\r
\r
--------------------------------------- \r
-7) Define a new PCD entry in a package:\r
+7) Declare 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
\r
-<PcdDefinitions>\r
+<PcdDeclarations>\r
<PcdEntry ItemType="FIXED_AT_BUILD">\r
<C_Name>PcdMaximumUnicodeStringLength</C_Name>\r
<Token>0x00000001</Token>\r
+ <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
<DatumType>UINT32</DatumType>\r
+ <ValidUsage>FIXED_AT_BUILD</ValidUsage>\r
<DefaultValue>1000000</DefaultValue>\r
+ <HelpText>The maximum lengh for unicode string.</HelpText>\r
</PcdEntry>\r
-</PcdDefinition>\r
+</PcdDeclarations>\r
\r
------------------------------\r
8) Declare a new Library Class:\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
projects / mirror_edk2.git / blobdiff