[mirror_edk2.git] / ReleaseNotes.txt
aa0bf4f4 1Intel(R) Platform Innovation Framework for EFI\r
e3f236c8 2EFI Development Kit 2.0 (EDK II) \r
aa0bf4f4 3Alpha Release\r
e3f236c8 42006-04-26\r
aa0bf4f4 5\r
6Copyright (c) 2006, Intel Corporation\r
8This document provides updates to documentation, along with a description on \r
e3f236c8 9how to install and build the Edk II.\r
aa0bf4f4 10\r
11Package Contents\r
13 ReleaseNote.txt- These release notes for the package.\r
14 MdePkg - A package containing Industry Standard headers and libraries\r
15 Tools - A package containing Build Specific tools which are designed\r
16 to help the developer create and modify drivers and\r
17 libraries\r
18 EdkModulePkg - A package containing reference drivers\r
19 EdkFatBinPkg - A package containing binary DXE drivers for the Fat 32 file\r
20 system\r
21 EdkShellBinPkg - A package containing binary Shell applications and commands\r
22 EdkNt32Pkg - A package containing the NT32 Emulation platform reference\r
24Note: MDE and MDK that appear in other documentation refer to the MdePkg and\r
25Tools packages. These two packages are the minimum requirement for developing\r
13421853 26EDK II Packages. It is also recommended that the top level files included\r
aa0bf4f4 27with the EDK be downloaded in conjunction with these two packages.\r
29Note: Documents have the following filenames:\r
13421853 30 EDK II Module Development Environment Library Specification v0.50 \r
aa0bf4f4 31 (MDE_Library_Spec_0_50.rtf)\r
13421853 32 EDK II Build and Packaging Architecture Specification v0.50\r
aa0bf4f4 33 (Build_Packaging_Spec_0_50.rtf)\r
13421853 34 EDK II Platform Configuration Database Infrastructure Description v0.51\r
aa0bf4f4 35 (PCD_Infrastructure_0_51.rtf)\r
13421853 36 EDK II Module Surface Area v0.50\r
aa0bf4f4 37 (Module_Surface_Area_0_50.rtf)\r
13421853 38 EDK II Module Development Environment (MDE) Package Specification v0.50\r
aa0bf4f4 39 (MDE_Package_Spec_0_50.rtf)\r
13421853 40 EDK II C Coding Standards Specification v0.50\r
aa0bf4f4 41 (C_Coding_Standards_Specification_ 0_50.rtf)\r
45The following list of tools must be installed on the development workstation\r
e3f236c8 46prior to using the Edk II.\r
aa0bf4f4 47\r
48Compiler Tool Chain\r
49 Microsoft* Visual Studio .NET 2003* (http://www.microsoft.com)\r
50 or\r
43475442 51 A special GCC version 4.x or later (http://gcc.gnu.org). See below.\r
aa0bf4f4 52\r
53Assembler Tool Chain\r
54 Microsoft Macro Assembler, version 6.15 or later\r
55 or\r
8fb9e6b8 56 GNU binutils 2.16.1 or later\r
aa0bf4f4 57\r
58Java Development Kit ( Java 5.0 or later)\r
59 Sun* jdk-1.5.0_04 or later (http://java.sun.com)\r
60 or\r
61 Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com)\r
63Java Tools\r
64 Apache-ANT, version 1.6.5 or later (http://ant.apache.org)\r
50518883 65 Ant-contrib, version 1.0b2 or later\r
66 (http://sourceforge.net/project/showfiles.php?group_id=36177)\r
aa0bf4f4 67 Saxon8, version 8.1.1\r
68 (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)\r
69 XMLBeans, version 2.1.0 or later (http://xmlbeans.apache.org) \r
71Other Tools\r
72 TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)\r
74Optional Tools\r
76Compiler Tool Chains:\r
50518883 77 Intel C++ Compiler for Windows, ver. 9.0 or later (http://www.intel.com)\r
8fb9e6b8 78 Intel C Compiler for EFI Byte Code, ver. 1.2 or later \r
79 (http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm)\r
aa0bf4f4 80 Microsoft Driver Development Kit, version 3790.1830 or later\r
8fb9e6b8 81 (http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx)\r
aa0bf4f4 82 Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later\r
83 Intel ACPI Component Architecture, version 20060113\r
86Notes On Required Tools (Source Control System)\r
13421853 88The EDK II is being managed by the Subversion Source Control on Tianocore.org.\r
aa0bf4f4 89This software package provides speed, security, and additional features. The\r
90recommended client is TortoiseSVN version 1.3.3. \r
91 (Available at http://tortoisesvn.tigris.org/)\r
93There are instructions for the use of Subversion Source Control on the\r
94Tianocore.org website, as part of the checkout procedures.\r
13421853 96The URL of the EDK II repository is:\r
aa0bf4f4 97 https://edk2.tianocore.org/svn/edk2/trunk/edk2\r
100Notes On Documentation\r
102The documents are being managed by the Subversion Source Control on\r
103Tianocore.org. The document repository is "docs" and must be checked out\r
13421853 104separately from the EDK II source tree. Refer to the checkout procedures on\r
105the Tianocore.org website for EDK II.\r
aa0bf4f4 106\r
107The URL of the document repository is:\r
108 https://edk2.tianocore.org/svn/edk2/trunk/docs\r
112Notes On Required Tools (MS Windows environment example)\r
114Software Installation Order:\r
115 After installing the compiler tools and your Subversion client, the following\r
116 required tools should be installed in order: \r
117 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8\r
119Java Development Kit:\r
120 \r
121 The Java Environment Variable must be set before attempting to build.\r
122 i.e. For Sun JDK (see note below*):\r
123 set JAVA_HOME=c:\ Java\jdk1.5.0_06 \r
124 i.e. For Bea Systems:\r
125 set JAVA_HOME=c:\Program Files\Java\jrockit-R26.0.0-jdk1.5.0_04\r
126 \r
127 *When using the Sun JDK5.0\r
128 During installation, you should specify the install directory as C:\Java\r
129 instead of C:\Program Files\(or some other drive letter.) While installing\r
130 to this non-standard location is not required. In use, it seems to work \r
131 more reliably. \r
132 For the JDK, the install path would be C:\Java\jdk1.5.0_06\r
133 For the JRE, the install path would be C:\Java\jre1.5.0_06\r
134 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.\r
01d2ed5e 135\r
aa0bf4f4 136 NOTE: You cannot combine the location for the JDK and the JRE, as the JRE\r
137 install removes most of the binaries and libraries installed by the JDK\r
138 install.\r
140Java Tools:\r
141 The Apache-ANT requires the ANT_HOME environment variable to be set before\r
142 attempting to build:\r
01d2ed5e 143 i.e. set ANT_HOME=c:\<full path to where ant was installed>\r
aa0bf4f4 144\r
145 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib \r
146 directory.\r
148 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
149 before attempting to build:\r
01d2ed5e 150 i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
aa0bf4f4 151\r
152 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.\r
154 The Ant and XMLBean tools are required to be in the path.\r
155 MS system example:\r
156 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin\r
157 Linux/OS X bash shell example:\r
158 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin\r
159 \r
161Quick Start\r
e3f236c8 163Edit the text file, target.txt, located in the Tools/Conf directory. This \r
164file contains the tools defintion file and ative platform. It can also restrict\r
165current build target(s), tagname(s) and arch(s). Uncomment the line ACTIVE_PLATFORM\r
166which is commented out by default. \r
168Edit the tools definition file, tools_def.txt, also located in the Tools/Conf \r
169directory. This file contains the names of the compiler tool chains and the \r
170location of the compiler binaries. It has been pre-populated with the standard \r
171location for the Microsoft tool chains and includes the standard location of \r
172the Intel C Compiler for EFI Byte Code (EBC)\r
aa0bf4f4 173 \r
174Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
13421853 175checkout the entire EDK II source tree.\r
aa0bf4f4 176\r
e3f236c8 177In a command window, change to the top level directory of the Edk II sources.\r
aa0bf4f4 178 Set the WORKSPACE environment variable, e.g.:\r
180 c:\> set WORKSPACE=C:\MyWork\Edk2.0\r
182To test your tool chain setup and to build the Supplied Tools, execute:\r
183 c:\MyWork\Edk2.0\> edksetup\r
185(This command will be referred to as the setup command throughout the rest of\r
186this document.)\r
187 NOTE: You should run the setup command at the start of every session.\r
188 This configures the environment to include the TianoTools and the\r
189 Java applications and libraries.\r
191Once this is completed, you are ready to test the Build, by executing:\r
e3f236c8 192 c:\MyWork\Edk2.0\> build\r
aa0bf4f4 193\r
e3f236c8 194This command builds active platform specified in text file target.txt. If \r
195active platform is not specified, go to sub-directory which contains FPD files and\r
196type build. More information about active platform policy reference to specification\r
197<<EDK II Build and Packaging Architecture Specification>>.\r
90f7b6a8 198\r
aa0bf4f4 199-------------------------\r
e3f236c8 200Individual Platform Builds\r
aa0bf4f4 201-------------------------\r
e3f236c8 202After running the setup command, you can build individual platforms.\r
203 In the command window, \r
204 1. Set active platform in target.txt, and type "build" in whatever directory;\r
205 2. or cd to the platform (FPD file) that you want to build, and just type:\r
206 c:\MyWork\Edk2.0\EdkNt32Pkg\> build\r
208 Note that active platform with the high priority to build, that means active \r
209 platform will be built even if exists FPD file under current directory. More \r
210 information about active platform policy reference to specification\r
211 <<EDK II Build and Packaging Architecture Specification>>. \r
aa0bf4f4 212\r
e3f236c8 213Go to <full build path>\Debug\MSFT\IA32 and execute SecMain.exe\r
214to run the Nt32 emulation platform under Microsoft Windows.\r
aa0bf4f4 215\r
03fed93e 216To exit the Nt32 emulation platform, you may type reset at the EFI Shell>\r
217command prompt. Alternately, you may use the Graphical interface, Boot\r
218Maintenance Manager screen's Reset System command.\r
aa0bf4f4 220------------------------\r
221Individual Module Builds\r
223After running the setup command, you can build individual modules.\r
224 In the command window, cd to the module that you want to build, and just\r
225 type:\r
e3f236c8 226 c:\MyWork\Edk2.0\MdePkg\Library\BaseLib\> build\r
228 Note active platform must be set for individual module build. \r
aa0bf4f4 229\r
231A Word on Apache-ANT\r
233The Apache-ANT program is a build tool that uses XML-based project files.\r
234Similar to Makefiles, these project files may contain multiple targets. Most\r
e3f236c8 235build.xml files in Edk2.0 are auto-generated; any edits performed on the\r
aa0bf4f4 236build.xml files will be overwritten the next time ant is executed.\r
238Pre-defined targets in the build.xml files include:\r
239 all - This target builds binaries for defined architectures\r
240 clean - This target removes object files generated by commands\r
241 cleanall - This target removes all generated files and directories.\r
243A Word on GCC tool chain\r
e3f236c8 245EDK2 will not compile with a standard Linux gcc tool chain. While Linux\r
246distributions are usually based on ELF, EDK2 requires a version of gcc that is\r
43475442 247configured to produce PE-COFF images. You will find a script in edk2/Tools/gcc\r
248that will download, configure, compile, and install a gcc 4.X cross-compile\r
e3f236c8 249tool chain for EDK2 development. It has support for the ia32 architecture. It\r
43475442 250can be built and run on Cygwin, Linux, and many other POSIX compliant host\r
251operating environments. There are a few tools that you will need on your host\r
252computer in order to compile the tool chain. Among them are bash, gcc, gmake,\r
253curl (or wget).\r
aa0bf4f4 254\r
257General Information:\r
258=============================================================== \r
8fb9e6b8 261A brief overview:\r
aa0bf4f4 262\r
263A) Surface Area Package Description (SPD) file contains information about the\r
264modules that the package contains, including the location of all MSA files, and\r
265public library names and headers that might be provided by a module in the\r
266package. Packages are defined by SPD files. (Found in the root of the Package\r
267subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "Build \r
268Packaging Specification" document.\r
269 \r
270B) Module Surface Area Definition (MSA) files. A description of a module's \r
271surface area, with all module specific default flags and features specified.\r
272Refer to the "Module Surface Area Architecture Specification" for additional\r
273details. The MSA is further explained in the "Build Packaging Specification"\r
275 \r
276C) Module Build Description (MDB). The "as-built" definition file that contains\r
277only the changes to the default flags defined in the MSA. The MSA and MDB are\r
278further explained in the "Build Packaging Specification" document.\r
280D) Platform Configuration Database (PCD). A platform database which contains a\r
281variety of current platform settings or directives by which a driver or\r
282application can interact with. The PCD is defined by the PCD_Protocol (This is\r
283further explained in the "Platform Configuration Database Infrastructure \r
284Description" document.\r
286E) Library Class. A library class is a logical grouping of similar functions.\r
287When developing components, the module surface area declares the class of\r
288libraries that can be used by the component. The MBD file specifies the\r
289instance(s) of the library that will be used during compilation/linking. All\r
290library type modules must include header files in their distribution package,\r
291as well as their surface area and module build description files. Components,\r
292on the other hand, need only provide the binary and build description files\r
293when distributing BINARY packages. The Library Classes are further explained\r
294in the "Build Packaging Specification" document.\r
297The common operations by developers of new modules are:\r
3001) How to manually create a new module in a package:\r
301 - The module source code must first be created in an appropriate directory\r
302 (under the package the module is to be a part of.) \r
303 - An MSA file must be created, spelling out all aspects of the module.\r
304 - The MSA must be added to the SPD for the package to include the module.\r
3072) Add/Remove module(s) to/from a package:\r
309 - Setup environment as Build\r
310 - Add a module to a package\r
e3f236c8 311 * Generate the module SurfaceArea description file\r
312 * Add a new <Filename> element under <MsaFiles> into\r
aa0bf4f4 313 <PackageDir>\<PackageName>.spd, using relative path to package\r
e3f236c8 314 * Add a new <ModuleSA> entry under each <FrameworkModules> into\r
315 <PackageDir>\<PackageName>.fpd file if necessary. \r
aa0bf4f4 316\r
317 - Remove a module from a package\r
e3f236c8 318 * Comment out or remove corresponding <Filename> element under <MsaFiles>\r
aa0bf4f4 319 from <PackageDir>\<PackageName>.spd\r
320 * Comment out or remove corresponding <ModuleSA> entry under each\r
e3f236c8 321 <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary. \r
aa0bf4f4 322\r
3243) How to manually create a package:\r
325 - Identify the modules that are to be members of the project.\r
326 - Identify the Variables and Guids required in and of the Package (including\r
327 consumption/production information).\r
328 - Create an SPD file defining these modules and calling out their MSA files.\r
e3f236c8 329 - add a new <Filename> element under <PackageList> into \r
330 Tools\Conf\FrameworkDatabase.db, using the relative path to workspace. \r
aa0bf4f4 331\r
3334) Declare a new Protocol in a package: \r
334 - This release requires manual editing of the SPD file, adding the protocol\r
335 to the ProtocolDeclarations section of the file. \r
336 - Add the Protocol .h file to the Include\Protocol directory.\r
64fcaead 337 - Add an <Entry> to the <ProtocolDeclarations> element in the \r
338 <PackageName>.spd file\r
aa0bf4f4 339 * Each line contains Protocol base name then the global variable name and\r
340 then the hex value of the Protocol GUID.\r
64fcaead 342Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):\r
e3f236c8 344 <Entry Name="Bds">\r
345 <C_Name>gEfiBdsArchProtocolGuid</C_Name>\r
346 <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>\r
347 <HelpText/>\r
348 </Entry>\r
349 <Entry Name="Cpu">\r
350 <C_Name>gEfiCpuArchProtocolGuid</C_Name>\r
351 <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>\r
352 <HelpText/>\r
353 </Entry>\r
aa0bf4f4 355\r
3575) Declare a new PPI in a package:\r
358 - This release requires manual editing of the SPD file\r
359 - Add the PPI .h file to the Include\Ppi directory.\r
64fcaead 360 - Add an <Entry> to the package <PpiDeclarations> element in the \r
361 <PackageName>.spd file\r
aa0bf4f4 362 * Each line contains PPI base name then the global variable name and then\r
363 the hex value of the PPI GUID.\r
64fcaead 365Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):\r
e3f236c8 367 <Entry Name="BootInRecoveryMode">\r
368 <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>\r
369 <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>\r
370 <HelpText/>\r
64fcaead 371 </Entry>\r
e3f236c8 372 <Entry Name="CpuIo">\r
373 <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>\r
374 <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>\r
375 <HelpText/>\r
64fcaead 376 </Entry>\r
aa0bf4f4 379----------------------------------\r
3806) Declare a new GUID in a package:\r
381 - This release requires manual editing of the SPD file to include the new\r
64fcaead 382 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration\r
383 element as described above.\r
aa0bf4f4 384\r
385--------------------------------------- \r
64fcaead 3867) Define a new PCD entry in a package:\r
aa0bf4f4 387 - This release requires manual editing of the SPD file to include the new\r
64fcaead 388 PCD. New Pcd entries are added to the PcdDefinitions section of the\r
389 <PackageName>.spd file using the following example for the format:\r
390 NOTE: The hex <Token> value must be unique.\r
393 <PcdEntry ItemType="FIXED_AT_BUILD">\r
394 <C_Name>PcdMaximumUnicodeStringLength</C_Name>\r
395 <Token>0x00000001</Token>\r
396 <DatumType>UINT32</DatumType>\r
397 <DefaultValue>1000000</DefaultValue>\r
398 </PcdEntry>\r
aa0bf4f4 400 \r
4028) Declare a new Library Class:\r
403 - This release requires manual editing of the SPD file to include the new\r
64fcaead 404 Library Class. New Library Class entries are added to the \r
405 LibraryClassDeclarations seection of the <PackageName>.spd file using\r
406 the following example for the format:\r
e3f236c8 409 <LibraryClass Name="BaseLib">\r
64fcaead 410 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>\r
e3f236c8 411 <HelpText/>\r
412 </LibraryClass>\r
413 <LibraryClass Name="BaseMemoryLib">\r
414 <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>\r
415 <HelpText/>\r
416 </LibraryClass>\r
64fcaead 417</LibraryClassDeclarations>\r
aa0bf4f4 418\r
aa0bf4f4 419=======================================================\r
13421853 422The EDK II represents significant changes in the structure of the EDK.\r
aa0bf4f4 423Therefore it is very difficult to isolate all of the changes of this version of\r
424the EDK with the previous (EDK 1.0) version.\r
426Of particular note:\r
13421853 4281) EDK II contains new hardware feature support for the ICH SMBUS Libraries.\r
aa0bf4f4 429 These libraries are provided to make Memory Reference Code (MRC) development\r
430 easier.\r
1465cc8b 4312) The MDE Libraries - The MDE libraries represent significant changes in source\r
aa0bf4f4 432 (with only limited changes in functionality.) These new libraries conform\r
433 to the "MDE Library Specification". \r
4343) The Fat Binary and the EDK Shell Binary Packages are functionally identical\r
435 to the EDK 1.0 version.\r
4364) The EDK tools directory has been expanded to include more tools and more\r
437 tool functionality.\r
4385) The EDK NT32 section has been ported to the new build process, but\r
439 functionally remains the same as the EDK 1.0 version.\r
13421853 4406) The Application "HelloWorld" has been ported to EDK II as well.\r
aa0bf4f4 441\r
443Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no\r
444virus detected.\r