X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=ReleaseNotes.txt;h=b9da6c308069e353e7c97f51ac34e6826fc211b9;hp=372703ef820c2df056ffea6a1314572abbbaaebf;hb=c80da0c44248639cc87bd10c8d0dc355f4cd3a9c;hpb=3c367f9de6345969bbf70453e74f741acb840cb1 diff --git a/ReleaseNotes.txt b/ReleaseNotes.txt index 372703ef82..b9da6c3080 100644 --- a/ReleaseNotes.txt +++ b/ReleaseNotes.txt @@ -1,8 +1,11 @@ Intel(R) Platform Innovation Framework for EFI EFI Development Kit II (EDK II) Root Package 1.00 -2006-07-06 +2006-07-18 +Intel is a trademark or registered trademark of Intel Corporation or its +subsidiaries in the United States and other countries. +* Other names and brands may be claimed as the property of others. Copyright (c) 2006, Intel Corporation This document provides updates to documentation, along with a description on @@ -11,41 +14,46 @@ how to install and build the EDK II. Package Contents ---------------- ReleaseNote.txt- These release notes for the package. - MdePkg - A package containing Industry Standard headers and libraries - Tools - A package containing Build Specific tools which are designed - to help the developer create and modify drivers and - libraries - EdkModulePkg - A package containing reference drivers - EdkFatBinPkg - A package containing binary DXE drivers for the Fat 32 file - system + MdePkg - Industry-standard headers and libraries + Tools - Build -specific tools that are designed to help the + developer create and modify drivers and libraries + EdkModulePkg - Reference drivers + EdkFatBinPkg - Binary DXE drivers for the Fat 32 file system + EdkShellBinPkg - Binary Shell applications and commands + EdkNt32Pkg - NT32 Emulation platform reference + +Note: MDE and MDK that appear in other documentation refer to the MdePkg and +Tools packages, respectively. While, these two packages are the minimum +requirement for developing EDK II Packageswe recommend that you download all +of the top-level files listed above. + +The following package is available as a separate project, under a separate +license, on the TianoCore.org website: https://fat-driver2.tianocore.org + EdkFatPkg - A package containing source DXE drivers for the Fat 32 file system - EdkShellBinPkg - A package containing binary Shell applications and commands - EdkNt32Pkg - A package containing the NT32 Emulation platform reference -Note: MDE and MDK that appear in other documentation refer to the MdePkg and -Tools packages. These two packages are the minimum requirement for developing -EDK II Packages. It is also recommended that the top level files included -with the EDK be downloaded in conjunction with these two packages. - -Note: Documents have the following filenames: - EDK II Module Development Environment Library Specification v0.50 - (MDE_Library_Spec_0_50.rtf) - EDK II Build and Packaging Architecture Specification v0.50 - (Build_Packaging_Spec_0_50.rtf) - EDK II Platform Configuration Database Infrastructure Description v0.51 - (PCD_Infrastructure_0_51.rtf) - EDK II Module Surface Area v0.50 +Documents have the following filenames (to download these documents, see “Notes +on Documentation” later in these Release Notes): + EDK II Module Development Environment Library Specification, v0.58 + (MDE_Library_Spec_0_58.rtf) + EDK II Build and Packaging Architecture Specification, v0.53 + (Build_Packaging_Spec_0_53.rtf) + EDK II Platform Configuration Database Infrastructure Description, v0.54 + (PCD_Infrastructure_0_54.rtf) + EDK II Module Surface Area Specification, v0.51 (Module_Surface_Area_0_50.rtf) - EDK II Module Development Environment (MDE) Package Specification v0.50 - (MDE_Package_Spec_0_50.rtf) - EDK II C Coding Standards Specification v0.50 - (C_Coding_Standards_Specification_ 0_50.rtf) + EDK II Module Development Environment Package Specification, v0.51 + (MDE_Package_Spec_0_51.rtf) + EDK II C Coding Standards Specification v0.51 + (C_Coding_Standards_Specification_ 0_51.rtf) + EDK II Subversion Setup Guide + (edk2-subversion-setup.rtf) Pre-Requisites -------------- The following list of tools must be installed on the development workstation -prior to using the Edk II. +prior to using the EDK II. Compiler Tool Chain Microsoft* Visual Studio .NET 2003* (http://www.microsoft.com) @@ -58,7 +66,7 @@ Assembler Tool Chain GNU binutils 2.16.1 or later Java Development Kit ( Java 5.0 or later) - Sun* jdk-1.5.0_04 or later (http://java.sun.com) + Sun* jdk-1.5.0_06 or later (http://java.sun.com) or Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com) @@ -69,8 +77,8 @@ Java Tools Saxon8, version 8.1.1 (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download) XMLBeans, version 2.1.0 (http://xmlbeans.apache.org) - DO NOT download the latest XMLBeans, version 2.2.0. It cannot work with - Saxon8, version 8.1.1. + DO NOT download the latest XMLBeans, version 2.2.0. It is not compatible + with Saxon8, version 8.1.1. Other Tools TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/) @@ -78,388 +86,437 @@ Other Tools Optional Tools -------------- Compiler Tool Chains: - Intel C++ Compiler for Windows, ver. 9.0 or later (http://www.intel.com) - Intel C Compiler for EFI Byte Code, ver. 1.2 or later + Intel(R) C++ Compiler for Windows*, ver. 9.0 or later (http://www.intel.com) + Intel(R) C Compiler for EFI Byte Code, ver. 1.2 or later (http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm) Microsoft Driver Development Kit, version 3790.1830 or later (http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx) Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later Intel ACPI Component Architecture, version 20060113 ------------------------ -Notes On Required Tools (Source Control System) ------------------------ +----------------------------------------------- +Notes on Required Tools (Source Control System) +----------------------------------------------- The EDK II is being managed by the Subversion Source Control on Tianocore.org. -This software package provides speed, security, and additional features. The +Subversion provides speed, security, and additional features. The recommended client is TortoiseSVN version 1.3.3. (Available at http://tortoisesvn.tigris.org/) -There are instructions for the use of Subversion Source Control on the -Tianocore.org website, as part of the checkout procedures. +The checkout procedures on the Tianocore.org Web site include +instructions for the use of Subversion Source Control. The URL of the EDK II repository is: https://edk2.tianocore.org/svn/edk2/trunk/edk2 ------------------------ -Notes On Documentation ------------------------ -The documents are being managed by the Subversion Source Control on -Tianocore.org. The document repository is "docs" and must be checked out -separately from the EDK II source tree. Refer to the checkout procedures on -the Tianocore.org website for EDK II. -The URL of the document repository is: - https://edk2.tianocore.org/svn/edk2/trunk/docs - - ------------------------ -Notes On Required Tools (With examples for Windows, OS X, and Linux) ------------------------ +-------------------------------------------------------------------- +Notes On Required Tools (With examples for Windows, OS X, and Linux*) +-------------------------------------------------------------------- Software Installation Order: - After installing the compiler tools and your Subversion client, the following - required tools should be installed in order: - Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8 + After installing the compiler tools and your Subversion client, install the + following required tools in this order: + 1. Java JDK + 2. Apache-Ant + 3. ant-contrib + 4. xmlbeans + 5. saxon8 Java Development Kit: The Java Environment Variable must be set before attempting to build. - For Sun JDK (see note below*): + For Sun JDK (see note below†): set JAVA_HOME=c:\Java\jdk1.5.0_06 (Windows example) export JAVA_HOME=/Library/Java/Home/ (OS X example) export JAVA_HOME=/usr/lib/j2sdk1.5-sun/ (Linux example) For Bea Systems: set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04 - *When using the Sun JDK5.0 + † When using the Sun JDK5.0: During installation, you should specify the install directory as C:\Java instead of C:\Program Files\(or some other drive letter.) While installing - to this non-standard location is not required. In use, it seems to work + to this non-standard location is not required, in practice, it seems to work more reliably. - For the JDK, the install path would be C:\Java\jdk1.5.0_06 - For the JRE, the install path would be C:\Java\jre1.5.0_06 + For the JDK, the install path is C:\Java\jdk1.5.0_06 + For the JRE, the install path is C:\Java\jre1.5.0_06 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre. - NOTE: You cannot combine the location for the JDK and the JRE, as the JRE - install removes most of the binaries and libraries installed by the JDK + NOTE: You cannot combine the location for the JDK and the JRE, because the + JRE install removes most of the binaries and libraries installed by the JDK install. Java Tools: The Apache-ANT requires the ANT_HOME environment variable to be set before attempting to build: - i.e. set ANT_HOME=c:\ + set ANT_HOME=c:\ export ANT_HOME=~/ExternalTools/apache-ant (OS X and Linux example) The ant-contrib.jar file should be installed in the %ANT_HOME%\lib directory. - The XMLBeans, requires the XMLBEANS_HOME environment variable to be set + XMLBeans, requires the XMLBEANS_HOME environment variable to be set before attempting to build: - i.e. set XMLBEANS_HOME=C:\ + set XMLBEANS_HOME=C:\ export XMLBEANS_HOME=~/ExternalTools/xmlbeans (OS X and Linux example) - The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory. + Copy the saxon8.jar file to the %XMLBEANS_HOME%\lib directory. - The Ant and XMLBean tools are required to be in the path. + The Ant and XMLBean tools must be in the path. MS system example: set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin Linux/OS X bash shell example: export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin - -------------------------------------------------------------------------------- -Quick Start ------------ -For editing text files under Windows, use the Wordpad application. Notepad -does not handle UNIX style newline characters properly. - -Copy the target.template file in the Tools/Conf directory to target.txt, which -must also be in the Tools/Conf directory. -Edit the text file, target.txt, located in the Tools/Conf directory. This -file contains options for setting the active platform and restricting the build. -The restictions are used to limit the build output by specifying build target(s), -tagname(s) and architecture(s) to less than the full set of possible options. +-------------------- +A Word on Apache-ANT +-------------------- +The Apache-ANT program is a build tool that uses XML-based project files. +Similar to Makefiles, these project files may contain multiple targets. Most +build.xml files in EDK II are auto-generated; any edits performed on the +build.xml files will be overwritten by the next build. -The ACTIVE_PLATFORM must be set unless the current working directory contains one -or more FPD files. All other options need not be set, however by unsetting these -options (by removing the line from the file, or leaving the Value empty) will -result in all available build possibilites when typing build. By default EDK II -can build a matrix of binaries, using different target types, tool chain tags and -architectures. Options to target.txt file are as follows: +Pre-defined targets in the build.xml file include: + all - This target builds binaries for defined architectures. + clean - This target removes object files generated by commands. + cleanall - This target removes all generated files and directories. -ACTIVE_PLATFORM = Value RECOMMENDED - Where Value is the WORKSPACE relative path and filename of a Framework Platform - Definition (FPD) File. Example: +---------------------------- +A Word on the GCC Tool Chain +---------------------------- +EDK II will not compile with a standard Linux gcc tool chain. While Linux +distributions are usually based on ELF, EDK II requires a version of gcc +that is configured to produce PE-COFF images. You will find a script in +edk2/Tools/gcc that will download, configure, compile, and install a gcc +4.X cross-compile tool chain for EDK II development. This custom tool chain +supports the IA-32 architecture. It can be built and run on Cygwin, Linux, and +many other POSIX-compliant host operating environments. To compile the custom +gcc tool chain, you need the following tools on your host computer: bash, gcc, +gmake, curl (or wget). + +Only the MdePkg and EdkModulePkg are currently supported by gcc builds. Other +builds, such as the EdkNt32Pkg, will not compile with gcc. By default, the edk2 +will try to build the NT32.fpd, which is not supported by gcc. So, you need to +change the Tools/Conf/target.txt. + +The platform to be built is identified by the Tools/Conf/target.txt file: + +# +# PROPERTY Type Use Description +# ---------------- -------- -------- ----------------------------------------------------------- +# ACTIVE_PLATFORM Filename Recommended Specify the WORKSPACE relative Path and Filename +# of the platform FPD file that will be used for the build +# This line is required if and only if the current working +# directory does not contain one or more FPD files. + +ACTIVE_PLATFORM = + +You can leave it black, as above, or set it to any .fpd file in the workspace. +If you leave it blank, then you just cd to the dir that contains the .fpd that +you would like to build (MdePkg/ or EdkModulePkg/) and then type build. -ACTIVE_PLATFORM = MdePkg/MdePkg.fpd +---------------------------- +A Word on compiling on Linux +---------------------------- -TARGET = Value OPTIONAL - Where Value is a list of one or more of the following: DEBUG, RELEASE or a User - Defined Target type, such as PERF. Example: +In order to compile on Linux, you will need to have the e2fsprogs-dev package +installed. Check your distribution for the rpm, deb or other package format. +This package contains the uuid library and header that are used by some of the +host tools. -TARGET = DEBUG RELEASE +If you are running on x86_64 Linux, then you should install a 64 bit version of +the Java JDK. The version that was used was jdk-1_5_0_07-linux-amd64-rpm.bin. +It may be downloaded from sun.com. -TARGET_ARCH = Value OPTIONAL - Where Value is a list of one or more supported Architectures: IA32, X64, IPF or - EBC. Example: +----------------------------------------- +A Word on compiling under Cygwin with gcc +----------------------------------------- -TARGET_ARCH = IA32 X64 EBC +Cygwin is a POSIX style operating environment for Windows. It is possible to +compile the EDK 2 using gcc and cygwin. There are a few extra steps necessary +to make this happen. There is a JNI (Java Native Interface) library in the +Tools. In order to compile this under Cygwin, the 'linux' java headers must be +installed to the $JAVA_HOME dir on the windows system. To accomplish this, you +must install the JDK on a linux system, and then copy +linux:$JAVA_HOME/include/linux/ to windows:$JAVA_HOME/include. These are really +typedefs needed by gcc. -TOOL_CHAIN_CONF = Value OPTIONAL - Where Value is the Filename of an alternate tools_def.txt file created by the - user. The alternate tools_def.txt files must be in the Tools/Conf directory. - These tool definitions are scoped to the WORKSPACE (location of the EDK - installation) and cannot be shared between WORKSPACES. (You can copy the files - from one workspace to another.) Example: +Compiling under cygwin is slow, because the underlying file accesses are slow +in cygwin. For this reason, we do not encourage the use of cygwin. A true unix +system will be a superior choice for those wishing to compile with gcc. -TOOL_CHAIN_CONF = alfred.txt +Make sure that you select the e2fsprogs development package when you install +cygwin. It is necessary for the GenFvImage tool. -TOOL_CHAIN_TAG = Value OPTIONAL - Where Value is a list of TagName entries as defined in the tools_def.txt file. - The TagName can be used to specify different versions of a compiler, i.e., - gcc 4.0 and gcc 4.1 which will allow you to build binaries with both tool chains - during the same build - useful during testing of a new compiler tool chain, or - for changing compiler flags to check out performance with a different set of - flags than flags used for production. Example: +---------------------------------------- +A Word on gcc for Processor Architectures +---------------------------------------- -TOOL_CHAIN_TAG = GCC40 GCC41 +Currently gcc support is limited to IA-32 builds, generating IA-32 PE32 images. -To clear a restriction, just remove any data after the equal sign. To clear -the TARGET_ARCH limitation that was set above, enter: +The X64 bit (Intel 64, etc.) support under the gcc compiler does not support the EFIAPI calling convention (as defined in the UEFI 2.0 specification Chapter 2), so it is not possible to build a working EFI image for an X64 environment. Since the x64 gcc does not support the EFIAPI calling convention the x64 tools do not support generating a PE32+ image. The EFIAPI calling convention is very similar to the Microsoft x64 calling convention. -TARGET_ARCH = +On Itanium® Processors the gcc compiler does not support generating a PE32+ image. ------------ -Copy the tools_def.template file in Tools/Conf to tools_def.txt in the same -directory. - -Edit the tools definition file, tools_def.txt, also located in the Tools/Conf -directory. This file contains the names of the compiler tool chains and the -location of the compiler binaries. It has been pre-populated with the standard -location for the Microsoft tool chains and includes the standard location of -the Intel C Compiler for EFI Byte Code (EBC.) In addition, EDK II provides -support for Cygwin, Linux and OS X GCC compiler tool chains. A script has been -provided in the Tools/gcc directory as well as instructions in obtaining and -building a version of GCC that has been tested. The tools_def.txt file has -the GCC binary locations that are created using this script. - -Both target.txt and tools_def.txt files are formatted as Property = Value, -which must appear on a single line. Spanning a Value entry over multiple -lines is not supported at this time. In the target.txt file, the Property is -a single, uppercase word with underscore characters. These Property names are -fixed by the build system. The tools_def.txt file's Property is an underscore -delimited coding, which supports some user defined values. The coding for -the Property is: TARGET_TAGNAME_ARCH_COMMAND_ATTR The Value, is either a -full path, full path and filename or a reserved word. - -TARGET - DEBUG and RELEASE are predefined, however the user may define one or - more of their own TARGET types in this file. - -TAGNAME - HOST, MSFT, GCC, INTC are predefined, however the user may define - one or more of their own TAGNAME keywords in this file. - -ARCH - EDK II supports IA32, X64, IPF and EBC at this time. - -COMMAND - Predefined command codes are listed in the tools_def.txt file, however - the user can specify additional command codes for their one, non- - standard tools. - -ATTR - Predefined Attributes are listed in the tools_def.txt file. - -NOTE: The TAGNAME: HOST is reserved and MUST be defined in order to build the - included Tiano tools from their C source files. These tools have been - built and tested using both Microsoft and GCC tool chains. -NOTE: The "*" symbol may be used as a wildcard character in most of these - fields, refer to the tools_def.txt and the "EDK II Build and Packaging - Architecture Specification" for more details. +----------------------- +Notes on Documentation +----------------------- +The documents are being managed by the Subversion Source Control on +Tianocore.org. The document repository is "docs" and must be checked out +separately from the EDK II source tree. Refer to the checkout procedures on +the Tianocore.org Web site for EDK II. +The URL of the document repository is: + https://edk2.tianocore.org/svn/edk2/trunk/docs + +------------------------------------------------------------------------------- +Quick Start ----------- +(assumes Microsoft Tools and OS environment, for GCC Tools or Linux, see +"Detailed Starting Instructions" below) + Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to -checkout the entire EDK II source tree. +check out the entire EDK II source tree. + +In a command window, change to the top-level directory of the EDK II source. + +To test your tool chain setup and to build the supplied tools, execute: + c:\MyWork\edkii\> edksetup ForceRebuild + +(The edksetup script is referred to as the setup command throughout the +rest of this document.) + NOTE: You should run the setup command at the start of every session. + This configures the environment to include the TianoTools and the + Java applications and libraries. + +You will need to set the WORKSPACE environment variable, or run the edksetup +script (without any arguments), any time you want to build. -In a command window, change to the top level directory of the Edk II sources. Set the WORKSPACE environment variable, e.g.: - c:\> set WORKSPACE=C:\MyWork\Edk2 + c:\> set WORKSPACE=C:\MyWork\edkii + +You may need to edit the text files Tools/Conf/target.txt and +Tools/Conf/tools_def.txt (created by edksetup) using your favorite +text editor to ensure that the paths to the tools you want to use +to build EDK II binaries are correct. These files contain the default +paths (as per the default installation of the tools), so a customized +install may require this manual process. -To test your tool chain setup and to build the Supplied Tools, execute: - c:\MyWork\Edk2\> edksetup +Once this is completed, you are ready to test the build, by executing: + c:\MyWork\edkii\> build -On Unix systems you must source the edksetup.sh file to load the correct +This command builds the active platform specified in text file target.txt. If +the active platform is not specified target.txt, you must execute the build +command from the sub-directory that contains FPD files. For more information +about the active platform policy, see the “EDK II Build and Packaging +Architecture Specification.” + +------------------------------------------------------------------------------- +Detailed Starting Instructions +------------------------------ + +Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to +check out the entire EDK II source tree. + +In a command window, change to the top-level directory of the EDK II source. + +If the active compiler tool chain is GCC, you must set the +environment variable, TOOL_CHAIN to "gcc" before running the +edksetup script. Example: export TOOL_CHAIN=gcc + +To test your tool chain setup and to build the supplied tools, execute: + c:\MyWork\edkii\> edksetup ForceRebuild + +On Linux systems, you must source the edksetup.sh file to load the correct settings into your shell. . edksetup.sh # Note the dot. -(This command will be referred to as the setup command throughout the rest of -this document.) +If you have recently updated your code from subversion, the tools will need to +be rebuilt if there were any code changes made to them. You can request that +the tools get rebuilt by typing: + + . edksetup.sh Rebuild # Unix-like systems + edksetup.bat Rebuild # Windows + +The edksetup script is referred to as the setup command throughout the +rest of this document. NOTE: You should run the setup command at the start of every session. This configures the environment to include the TianoTools and the Java applications and libraries. -If you are confident that none of the tool tool sources have changed, and you -only want to set up the workspace environment you may execute: - c:\MyWork\Edk2\> edksetup skip +Any changes to the tool source code or XML Schema documents require that +you execute the following: + c:\MyWork\edkii\> edksetup ForceRebuild + +You must set the WORKSPACE environment variable, or run the edksetup +script (without any arguments), any time you want to build. + + Set the WORKSPACE environment variable, e.g.: + + c:\> set WORKSPACE=C:\MyWork\edkii -Once this is completed, you are ready to test the Build, by executing: - c:\MyWork\Edk2\> build +You may need to edit the text files Tools/Conf/target.txt and +Tools/Conf/tools_def.txt (created by edksetup) using your favorite +text editor to ensure that the paths to the tools you want to use +to build EDK II binaries are correct. These files contain the default +paths (as per the default installation of the tools), so a customized +tool installation may require this manual process. -This command builds active platform specified in text file target.txt. If -active platform is not specified, go to sub-directory which contains FPD files and -type build. More information about active platform policy reference to specification -<>. +Once this is completed, you are ready to test the build, by executing: + c:\MyWork\edkii\> build -------------------------- +This command builds the active platform specified in text file target.txt. If +the active platform is not specified, go to the sub-directory that contains FPD +files and execute the build command. For more information about the active +platform policy, see the “EDK II Build and Packaging Architecture +Specification.” + +-------------------------- Individual Platform Builds -------------------------- +-------------------------- After running the setup command, you can build individual platforms. - In the command window, - 1. Set active platform in target.txt, and type "build" in whatever directory; - 2. or cd to the platform (FPD file) that you want to build, and just type: - c:\MyWork\Edk2\EdkNt32Pkg\> build - - Note that active platform with the high priority to build, that means active - platform will be built even if exists FPD file under current directory. More - information about active platform policy reference to specification - <>. +In the command window: + Set the active platform in target.txt, and execute this command: + c:\\> build +or + cd to the platform (FPD file) that you want to build and execute this command: + c:\MyWork\edkii\EdkNt32Pkg\> build + + Note that the active platform specified in target.txt overrides the platform + specified by any FPD file in the current directory. For more information + about active platform policy, see the “EDK II Build and Packaging Architecture + Specification.” + +To run the Nt32 emulation platform under Microsoft Windows, go to +\DEBUG\MSFT\IA32 and execute SecMain.exe + +To exit the Nt32 emulation platform, type “reset” at the EFI Shell> +command prompt. Alternatively, from the graphical interface, select the Boot +Maintenance Manager's “Reset System” command. + + NOTE: When creating a new platform, the Platform Name is restricted + to a single word containing alphanumeric characters, underscore, dash, + and period. The space character and other special characters are + not allowed. -Go to \DEBUG\MSFT\IA32 and execute SecMain.exe -to run the Nt32 emulation platform under Microsoft Windows. +----------------------- +Notes on Symbolic Debug +----------------------- +To enable EFI Symbolic Debugging, make sure the target output is set to DEBUG +in the text file Tools/Conf/target.txt and then modify the FPD +