Changed the ant-contrib download address to sync with the website;
[mirror_edk2.git] / ReleaseNotes.txt
CommitLineData
aa0bf4f4 1Intel(R) Platform Innovation Framework for EFI\r
362271d6 2EFI Development Kit II (EDK II) \r
3Root Package 1.00\r
42006-07-06\r
aa0bf4f4 5\r
6Copyright (c) 2006, Intel Corporation\r
7\r
8This document provides updates to documentation, along with a description on \r
362271d6 9how to install and build the EDK II.\r
aa0bf4f4 10\r
11Package Contents\r
12----------------\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
362271d6 21 EdkFatPkg - A package containing source DXE drivers for the Fat 32 file\r
22 system\r
aa0bf4f4 23 EdkShellBinPkg - A package containing binary Shell applications and commands\r
24 EdkNt32Pkg - A package containing the NT32 Emulation platform reference\r
25\r
26Note: MDE and MDK that appear in other documentation refer to the MdePkg and\r
27Tools packages. These two packages are the minimum requirement for developing\r
13421853 28EDK II Packages. It is also recommended that the top level files included\r
aa0bf4f4 29with the EDK be downloaded in conjunction with these two packages.\r
30\r
31Note: Documents have the following filenames:\r
13421853 32 EDK II Module Development Environment Library Specification v0.50 \r
aa0bf4f4 33 (MDE_Library_Spec_0_50.rtf)\r
13421853 34 EDK II Build and Packaging Architecture Specification v0.50\r
aa0bf4f4 35 (Build_Packaging_Spec_0_50.rtf)\r
13421853 36 EDK II Platform Configuration Database Infrastructure Description v0.51\r
aa0bf4f4 37 (PCD_Infrastructure_0_51.rtf)\r
13421853 38 EDK II Module Surface Area v0.50\r
aa0bf4f4 39 (Module_Surface_Area_0_50.rtf)\r
13421853 40 EDK II Module Development Environment (MDE) Package Specification v0.50\r
aa0bf4f4 41 (MDE_Package_Spec_0_50.rtf)\r
13421853 42 EDK II C Coding Standards Specification v0.50\r
aa0bf4f4 43 (C_Coding_Standards_Specification_ 0_50.rtf)\r
44\r
45Pre-Requisites\r
46--------------\r
47The following list of tools must be installed on the development workstation\r
e3f236c8 48prior to using the Edk II.\r
aa0bf4f4 49\r
50Compiler Tool Chain\r
51 Microsoft* Visual Studio .NET 2003* (http://www.microsoft.com)\r
52 or\r
43475442 53 A special GCC version 4.x or later (http://gcc.gnu.org). See below.\r
aa0bf4f4 54\r
55Assembler Tool Chain\r
56 Microsoft Macro Assembler, version 6.15 or later\r
57 or\r
8fb9e6b8 58 GNU binutils 2.16.1 or later\r
aa0bf4f4 59\r
60Java Development Kit ( Java 5.0 or later)\r
61 Sun* jdk-1.5.0_04 or later (http://java.sun.com)\r
62 or\r
63 Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com)\r
64\r
65Java Tools\r
66 Apache-ANT, version 1.6.5 or later (http://ant.apache.org)\r
50518883 67 Ant-contrib, version 1.0b2 or later\r
782eb168 68 (http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download)\r
aa0bf4f4 69 Saxon8, version 8.1.1\r
70 (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)\r
782eb168 71 XMLBeans, version 2.1.0 (http://xmlbeans.apache.org)\r
72 DO NOT download the latest XMLBeans, version 2.2.0. It cannot work with\r
73 Saxon8, version 8.1.1.\r
aa0bf4f4 74\r
75Other Tools\r
76 TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)\r
77\r
78Optional Tools\r
79--------------\r
80Compiler Tool Chains:\r
50518883 81 Intel C++ Compiler for Windows, ver. 9.0 or later (http://www.intel.com)\r
8fb9e6b8 82 Intel C Compiler for EFI Byte Code, ver. 1.2 or later \r
83 (http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm)\r
aa0bf4f4 84 Microsoft Driver Development Kit, version 3790.1830 or later\r
8fb9e6b8 85 (http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx)\r
aa0bf4f4 86 Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later\r
87 Intel ACPI Component Architecture, version 20060113\r
88\r
89-----------------------\r
90Notes On Required Tools (Source Control System)\r
91-----------------------\r
13421853 92The EDK II is being managed by the Subversion Source Control on Tianocore.org.\r
aa0bf4f4 93This software package provides speed, security, and additional features. The\r
94recommended client is TortoiseSVN version 1.3.3. \r
95 (Available at http://tortoisesvn.tigris.org/)\r
96\r
97There are instructions for the use of Subversion Source Control on the\r
98Tianocore.org website, as part of the checkout procedures.\r
99\r
13421853 100The URL of the EDK II repository is:\r
aa0bf4f4 101 https://edk2.tianocore.org/svn/edk2/trunk/edk2\r
102\r
103-----------------------\r
104Notes On Documentation\r
105-----------------------\r
106The documents are being managed by the Subversion Source Control on\r
107Tianocore.org. The document repository is "docs" and must be checked out\r
13421853 108separately from the EDK II source tree. Refer to the checkout procedures on\r
109the Tianocore.org website for EDK II.\r
aa0bf4f4 110\r
111The URL of the document repository is:\r
112 https://edk2.tianocore.org/svn/edk2/trunk/docs\r
113\r
114\r
115-----------------------\r
116Notes On Required Tools (MS Windows environment example)\r
117-----------------------\r
118Software Installation Order:\r
119 After installing the compiler tools and your Subversion client, the following\r
120 required tools should be installed in order: \r
121 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8\r
122\r
123Java Development Kit:\r
124 \r
125 The Java Environment Variable must be set before attempting to build.\r
126 i.e. For Sun JDK (see note below*):\r
782eb168 127 set JAVA_HOME=c:\Java\jdk1.5.0_06 \r
aa0bf4f4 128 i.e. For Bea Systems:\r
782eb168 129 set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04\r
aa0bf4f4 130 \r
131 *When using the Sun JDK5.0\r
132 During installation, you should specify the install directory as C:\Java\r
133 instead of C:\Program Files\(or some other drive letter.) While installing\r
134 to this non-standard location is not required. In use, it seems to work \r
135 more reliably. \r
136 For the JDK, the install path would be C:\Java\jdk1.5.0_06\r
137 For the JRE, the install path would be C:\Java\jre1.5.0_06\r
138 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.\r
01d2ed5e 139\r
aa0bf4f4 140 NOTE: You cannot combine the location for the JDK and the JRE, as the JRE\r
141 install removes most of the binaries and libraries installed by the JDK\r
142 install.\r
143\r
144Java Tools:\r
145 The Apache-ANT requires the ANT_HOME environment variable to be set before\r
146 attempting to build:\r
01d2ed5e 147 i.e. set ANT_HOME=c:\<full path to where ant was installed>\r
aa0bf4f4 148\r
149 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib \r
150 directory.\r
151\r
152 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
153 before attempting to build:\r
782eb168 154 i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
aa0bf4f4 155\r
156 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.\r
157\r
158 The Ant and XMLBean tools are required to be in the path.\r
159 MS system example:\r
160 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin\r
161 Linux/OS X bash shell example:\r
162 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin\r
163 \r
164-------------------------------------------------------------------------------\r
165Quick Start\r
166-----------\r
a032fb4d 167Copy the target.template file in the Tools/Conf directory to target.txt, which\r
168must also be in the Tools/Conf directory.\r
169\r
e3f236c8 170Edit the text file, target.txt, located in the Tools/Conf directory. This \r
a032fb4d 171file contains options for setting the active platform and restricting the build. \r
172The restictions are used to limit the build output by specifying build target(s), \r
173tagname(s) and architecture(s) to less than the full set of possible options. \r
174\r
73da4c04 175The ACTIVE_PLATFORM must be set unless the current working directory contains one\r
176or more FPD files. All other options need not be set, however by unsetting these\r
177options (by removing the line from the file, or leaving the Value empty) will \r
178result in all available build possibilites when typing build. By default EDK II\r
179can build a matrix of binaries, using different target types, tool chain tags and \r
180architectures. Options to target.txt file are as follows:\r
a032fb4d 181\r
182ACTIVE_PLATFORM = Value REQUIRED\r
183 Where Value is the WORKSPACE relative path and filename of a Framework Platform \r
184 Definition (FPD) File. Example:\r
185\r
186ACTIVE_PLATFORM = MdePkg/MdePkg.fpd\r
187\r
188TARGET = Value OPTIONAL\r
189 Where Value is a list of one or more of the following: DEBUG, RELEASE or a User\r
190 Defined Target type, such as PERF. Example: \r
191\r
192TARGET = DEBUG RELEASE\r
193\r
194TARGET_ARCH = Value OPTIONAL\r
195 Where Value is a list of one or more supported Architectures: IA32, X64, IPF or\r
196 EBC. Example: \r
197\r
198TARGET_ARCH = IA32 X64 EBC\r
199\r
200TOOL_CHAIN_CONF = Value OPTIONAL\r
201 Where Value is the Filename of an alternate tools_def.txt file created by the\r
202 user. The alternate tools_def.txt files must be in the Tools/Conf directory.\r
203 These tool definitions are scoped to the WORKSPACE (location of the EDK \r
204 installation) and cannot be shared between WORKSPACES. (You can copy the files\r
205 from one workspace to another.) Example: \r
206\r
207TOOL_CHAIN_CONF = alfred.txt\r
208\r
209TOOL_CHAIN_TAG = Value OPTIONAL\r
210 Where Value is a list of TagName entries as defined in the tools_def.txt file.\r
211 The TagName can be used to specify different versions of a compiler, i.e., \r
212 gcc 4.0 and gcc 4.1 which will allow you to build binaries with both tool chains \r
213 during the same build - useful during testing of a new compiler tool chain, or \r
214 for changing compiler flags to check out performance with a different set of \r
215 flags than flags used for production. Example:\r
216\r
217TOOL_CHAIN_TAG = GCC40 GCC41\r
218\r
219To clear a restriction, just remove any data after the equal sign. To clear\r
220the TARGET_ARCH limitation that was set above, enter: \r
221\r
222TARGET_ARCH =\r
223\r
224-----------\r
225Copy the tools_def.template file in Tools/Conf to tools_def.txt in the same\r
226directory.\r
e3f236c8 227\r
228Edit the tools definition file, tools_def.txt, also located in the Tools/Conf \r
229directory. This file contains the names of the compiler tool chains and the \r
230location of the compiler binaries. It has been pre-populated with the standard \r
231location for the Microsoft tool chains and includes the standard location of \r
a032fb4d 232the Intel C Compiler for EFI Byte Code (EBC.) In addition, EDK II provides\r
233support for Cygwin, Linux and OS X GCC compiler tool chains. A script has been\r
234provided in the Tools/gcc directory as well as instructions in obtaining and\r
235building a version of GCC that has been tested. The tools_def.txt file has\r
236the GCC binary locations that are created using this script.\r
237\r
238Both target.txt and tools_def.txt files are formatted as Property = Value, \r
239which must appear on a single line. Spanning a Value entry over multiple\r
240lines is not supported at this time. In the target.txt file, the Property is\r
241a single, uppercase word with underscore characters. These Property names are\r
242fixed by the build system. The tools_def.txt file's Property is an underscore\r
243delimited coding, which supports some user defined values. The coding for\r
244the Property is: TARGET_TAGNAME_ARCH_COMMAND_ATTR The Value, is either a \r
245full path, full path and filename or a reserved word.\r
246\r
247TARGET - DEBUG and RELEASE are predefined, however the user may define one or\r
248 more of their own TARGET types in this file.\r
249\r
250TAGNAME - HOST, MSFT, GCC, INTC are predefined, however the user may define \r
251 one or more of their own TAGNAME keywords in this file.\r
252\r
253ARCH - EDK II supports IA32, X64, IPF and EBC at this time.\r
254\r
255COMMAND - Predefined command codes are listed in the tools_def.txt file, however\r
256 the user can specify additional command codes for their one, non-\r
257 standard tools.\r
258\r
259ATTR - Predefined Attributes are listed in the tools_def.txt file.\r
260\r
261NOTE: The TAGNAME: HOST is reserved and MUST be defined in order to build the\r
262 included Tiano tools from their C source files. These tools have been\r
263 built and tested using both Microsoft and GCC tool chains.\r
264NOTE: The "*" symbol may be used as a wildcard character in most of these\r
265 fields, refer to the tools_def.txt and the "EDK II Build and Packaging\r
266 Architecture Specification" for more details.\r
267\r
268\r
269-----------\r
aa0bf4f4 270Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
13421853 271checkout the entire EDK II source tree.\r
aa0bf4f4 272\r
e3f236c8 273In a command window, change to the top level directory of the Edk II sources.\r
aa0bf4f4 274 Set the WORKSPACE environment variable, e.g.:\r
275\r
a032fb4d 276 c:\> set WORKSPACE=C:\MyWork\Edk2\r
aa0bf4f4 277\r
278To test your tool chain setup and to build the Supplied Tools, execute:\r
a032fb4d 279 c:\MyWork\Edk2\> edksetup\r
aa0bf4f4 280\r
281(This command will be referred to as the setup command throughout the rest of\r
282this document.)\r
283 NOTE: You should run the setup command at the start of every session.\r
284 This configures the environment to include the TianoTools and the\r
285 Java applications and libraries.\r
286\r
a032fb4d 287If you are confident that none of the tool tool sources have changed, and you\r
288only want to set up the workspace environment you may execute:\r
289 c:\MyWork\Edk2\> edksetup skip\r
290\r
aa0bf4f4 291Once this is completed, you are ready to test the Build, by executing:\r
a032fb4d 292 c:\MyWork\Edk2\> build\r
aa0bf4f4 293\r
e3f236c8 294This command builds active platform specified in text file target.txt. If \r
295active platform is not specified, go to sub-directory which contains FPD files and\r
296type build. More information about active platform policy reference to specification\r
297<<EDK II Build and Packaging Architecture Specification>>.\r
90f7b6a8 298\r
aa0bf4f4 299-------------------------\r
e3f236c8 300Individual Platform Builds\r
aa0bf4f4 301-------------------------\r
e3f236c8 302After running the setup command, you can build individual platforms.\r
303 In the command window, \r
304 1. Set active platform in target.txt, and type "build" in whatever directory;\r
305 2. or cd to the platform (FPD file) that you want to build, and just type:\r
a032fb4d 306 c:\MyWork\Edk2\EdkNt32Pkg\> build\r
e3f236c8 307\r
308 Note that active platform with the high priority to build, that means active \r
309 platform will be built even if exists FPD file under current directory. More \r
310 information about active platform policy reference to specification\r
311 <<EDK II Build and Packaging Architecture Specification>>. \r
aa0bf4f4 312\r
a032fb4d 313Go to <full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe\r
e3f236c8 314to run the Nt32 emulation platform under Microsoft Windows.\r
aa0bf4f4 315\r
03fed93e 316To exit the Nt32 emulation platform, you may type reset at the EFI Shell>\r
317command prompt. Alternately, you may use the Graphical interface, Boot\r
318Maintenance Manager screen's Reset System command.\r
319\r
aa0bf4f4 320------------------------\r
321Individual Module Builds\r
322------------------------\r
323After running the setup command, you can build individual modules.\r
324 In the command window, cd to the module that you want to build, and just\r
325 type:\r
a032fb4d 326 c:\MyWork\Edk2\MdePkg\Library\BaseLib\> build\r
e3f236c8 327\r
328 Note active platform must be set for individual module build. \r
aa0bf4f4 329\r
330-------------------------------------------------------------------------------\r
331A Word on Apache-ANT\r
332--------------------\r
333The Apache-ANT program is a build tool that uses XML-based project files.\r
334Similar to Makefiles, these project files may contain multiple targets. Most\r
a032fb4d 335build.xml files in EDK II are auto-generated; any edits performed on the\r
336build.xml files will be overwritten the next time build is executed.\r
aa0bf4f4 337\r
a032fb4d 338Pre-defined targets in the build.xml file include:\r
aa0bf4f4 339 all - This target builds binaries for defined architectures\r
340 clean - This target removes object files generated by commands\r
341 cleanall - This target removes all generated files and directories.\r
342\r
343A Word on GCC tool chain\r
344------------------------\r
a032fb4d 345EDK II will not compile with a standard Linux gcc tool chain. While Linux\r
346distributions are usually based on ELF, EDK II requires a version of gcc \r
347that is configured to produce PE-COFF images. You will find a script in \r
348edk2/Tools/gcc that will download, configure, compile, and install a gcc \r
3494.X cross-compile tool chain for EDK II development. It has support for \r
350the IA32 architecture. It can be built and run on Cygwin, Linux, and many \r
351other POSIX compliant host operating environments. There are a few tools\r
352that you will need on your host computer in order to compile the tool \r
353chain. Among them are bash, gcc, gmake, curl (or wget).\r
aa0bf4f4 354\r
355-------------------------------------------------------------------------------\r
356\r
357General Information:\r
358=============================================================== \r
359Mechanisms:\r
360----------\r
8fb9e6b8 361A brief overview:\r
aa0bf4f4 362\r
363A) Surface Area Package Description (SPD) file contains information about the\r
364modules that the package contains, including the location of all MSA files, and\r
365public library names and headers that might be provided by a module in the\r
366package. Packages are defined by SPD files. (Found in the root of the Package\r
a032fb4d 367subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "EDK Build \r
368and Packaging Architecture Specification" document.\r
aa0bf4f4 369 \r
370B) Module Surface Area Definition (MSA) files. A description of a module's \r
371surface area, with all module specific default flags and features specified.\r
372Refer to the "Module Surface Area Architecture Specification" for additional\r
a032fb4d 373details. The MSA is further explained in the "EDK II Build Packaging Architecture \r
374Specification" document.\r
375\r
376C) Framework Platform Description (FPD) files. A description of a platform's\r
377surface are, including a list of modules that are needed by the platform. To\r
378support individual module builds, developers are not required to provide\r
379information about specific flash devices, nor flash device layout. There are\r
380specific sections in the FPD file that do control aspects of the build, such \r
381as the Supported Architectures and Build Targets, as well as the tool flags \r
382that are used to create the binary files. A valid platform file can specify \r
383zero or more modules, so individual modules can be compiled within the context\r
384of a platform (FPD) definition.\r
385\r
386D) Platform Configuration Database (PCD). A platform database which contains a\r
aa0bf4f4 387variety of current platform settings or directives by which a driver or\r
388application can interact with. The PCD is defined by the PCD_Protocol (This is\r
389further explained in the "Platform Configuration Database Infrastructure \r
390Description" document.\r
391\r
a032fb4d 392E) Library Class. A library class is a logical grouping of similar functions.\r
aa0bf4f4 393When developing components, the module surface area declares the class of\r
a032fb4d 394libraries that can be used by the component. The MSA and SPD files can specify\r
395a recommended instance of the library that a platform integrator may select,\r
396however this is only a recommendation. The PI may choose to select a different\r
397library instance to be used during compilation/linking. All library type modules \r
398must include header files in their distribution package, as well as their MSA\r
399files. Components, on the other hand, need only provide an MSA and either source\r
400or binary files when distributing packages. The Library Classes are further \r
401explained in the "EDK II Build and Packaging Architecture Specification" \r
402document.\r
aa0bf4f4 403\r
404=========================================================================\r
405The common operations by developers of new modules are:\r
406-------------------------------------------------------\r
407\r
4081) How to manually create a new module in a package:\r
409 - The module source code must first be created in an appropriate directory\r
410 (under the package the module is to be a part of.) \r
411 - An MSA file must be created, spelling out all aspects of the module.\r
412 - The MSA must be added to the SPD for the package to include the module.\r
413\r
414-----------------------------------------\r
4152) Add/Remove module(s) to/from a package:\r
416\r
417 - Setup environment as Build\r
418 - Add a module to a package\r
e3f236c8 419 * Generate the module SurfaceArea description file\r
420 * Add a new <Filename> element under <MsaFiles> into\r
aa0bf4f4 421 <PackageDir>\<PackageName>.spd, using relative path to package\r
e3f236c8 422 * Add a new <ModuleSA> entry under each <FrameworkModules> into\r
423 <PackageDir>\<PackageName>.fpd file if necessary. \r
aa0bf4f4 424\r
425 - Remove a module from a package\r
e3f236c8 426 * Comment out or remove corresponding <Filename> element under <MsaFiles>\r
aa0bf4f4 427 from <PackageDir>\<PackageName>.spd\r
428 * Comment out or remove corresponding <ModuleSA> entry under each\r
e3f236c8 429 <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary. \r
aa0bf4f4 430\r
431-----------------------------------\r
4323) How to manually create a package:\r
433 - Identify the modules that are to be members of the project.\r
434 - Identify the Variables and Guids required in and of the Package (including\r
435 consumption/production information).\r
436 - Create an SPD file defining these modules and calling out their MSA files.\r
e3f236c8 437 - add a new <Filename> element under <PackageList> into \r
438 Tools\Conf\FrameworkDatabase.db, using the relative path to workspace. \r
aa0bf4f4 439\r
440--------------------------------------\r
4414) Declare a new Protocol in a package: \r
442 - This release requires manual editing of the SPD file, adding the protocol\r
443 to the ProtocolDeclarations section of the file. \r
444 - Add the Protocol .h file to the Include\Protocol directory.\r
64fcaead 445 - Add an <Entry> to the <ProtocolDeclarations> element in the \r
446 <PackageName>.spd file\r
aa0bf4f4 447 * Each line contains Protocol base name then the global variable name and\r
448 then the hex value of the Protocol GUID.\r
449\r
64fcaead 450Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):\r
451<ProtocolDeclarations>\r
e3f236c8 452 <Entry Name="Bds">\r
453 <C_Name>gEfiBdsArchProtocolGuid</C_Name>\r
454 <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>\r
455 <HelpText/>\r
456 </Entry>\r
457 <Entry Name="Cpu">\r
458 <C_Name>gEfiCpuArchProtocolGuid</C_Name>\r
459 <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>\r
460 <HelpText/>\r
461 </Entry>\r
462</ProtocolDeclarations>\r
aa0bf4f4 463\r
464---------------------------------\r
4655) Declare a new PPI in a package:\r
466 - This release requires manual editing of the SPD file\r
467 - Add the PPI .h file to the Include\Ppi directory.\r
64fcaead 468 - Add an <Entry> to the package <PpiDeclarations> element in the \r
469 <PackageName>.spd file\r
aa0bf4f4 470 * Each line contains PPI base name then the global variable name and then\r
471 the hex value of the PPI GUID.\r
472\r
64fcaead 473Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):\r
474<PpiDeclarations>\r
e3f236c8 475 <Entry Name="BootInRecoveryMode">\r
476 <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>\r
477 <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>\r
478 <HelpText/>\r
64fcaead 479 </Entry>\r
e3f236c8 480 <Entry Name="CpuIo">\r
481 <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>\r
482 <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>\r
483 <HelpText/>\r
64fcaead 484 </Entry>\r
485</PpiDeclarations>\r
486\r
aa0bf4f4 487----------------------------------\r
4886) Declare a new GUID in a package:\r
489 - This release requires manual editing of the SPD file to include the new\r
64fcaead 490 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration\r
491 element as described above.\r
aa0bf4f4 492\r
493--------------------------------------- \r
54c9f9ed 4947) Declare a new PCD entry in a package:\r
aa0bf4f4 495 - This release requires manual editing of the SPD file to include the new\r
64fcaead 496 PCD. New Pcd entries are added to the PcdDefinitions section of the\r
497 <PackageName>.spd file using the following example for the format:\r
498 NOTE: The hex <Token> value must be unique.\r
499\r
54c9f9ed 500<PcdDeclarations>\r
64fcaead 501 <PcdEntry ItemType="FIXED_AT_BUILD">\r
502 <C_Name>PcdMaximumUnicodeStringLength</C_Name>\r
503 <Token>0x00000001</Token>\r
54c9f9ed 504 <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
64fcaead 505 <DatumType>UINT32</DatumType>\r
54c9f9ed 506 <ValidUsage>FIXED_AT_BUILD</ValidUsage>\r
64fcaead 507 <DefaultValue>1000000</DefaultValue>\r
54c9f9ed 508 <HelpText>The maximum lengh for unicode string.</HelpText>\r
64fcaead 509 </PcdEntry>\r
54c9f9ed 510</PcdDeclarations>\r
aa0bf4f4 511 \r
512------------------------------\r
5138) Declare a new Library Class:\r
514 - This release requires manual editing of the SPD file to include the new\r
64fcaead 515 Library Class. New Library Class entries are added to the \r
516 LibraryClassDeclarations seection of the <PackageName>.spd file using\r
517 the following example for the format:\r
518\r
519<LibraryClassDeclarations>\r
e3f236c8 520 <LibraryClass Name="BaseLib">\r
64fcaead 521 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>\r
e3f236c8 522 <HelpText/>\r
523 </LibraryClass>\r
524 <LibraryClass Name="BaseMemoryLib">\r
525 <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>\r
526 <HelpText/>\r
527 </LibraryClass>\r
64fcaead 528</LibraryClassDeclarations>\r
aa0bf4f4 529\r
aa0bf4f4 530=======================================================\r
531Notes:\r
532------\r
13421853 533The EDK II represents significant changes in the structure of the EDK.\r
aa0bf4f4 534Therefore it is very difficult to isolate all of the changes of this version of\r
535the EDK with the previous (EDK 1.0) version.\r
536\r
537Of particular note:\r
538\r
13421853 5391) EDK II contains new hardware feature support for the ICH SMBUS Libraries.\r
aa0bf4f4 540 These libraries are provided to make Memory Reference Code (MRC) development\r
541 easier.\r
1465cc8b 5422) The MDE Libraries - The MDE libraries represent significant changes in source\r
aa0bf4f4 543 (with only limited changes in functionality.) These new libraries conform\r
544 to the "MDE Library Specification". \r
5453) The Fat Binary and the EDK Shell Binary Packages are functionally identical\r
546 to the EDK 1.0 version.\r
5474) The EDK tools directory has been expanded to include more tools and more\r
548 tool functionality.\r
5495) The EDK NT32 section has been ported to the new build process, but\r
550 functionally remains the same as the EDK 1.0 version.\r
13421853 5516) The Application "HelloWorld" has been ported to EDK II as well.\r
aa0bf4f4 552\r
553=======================================================\r
554Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no\r
555virus detected.\r
556\r