Add more instructions for OS X and Linux.
[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
6132429e 116Notes On Required Tools (With examples for Windows, OS X, and Linux) \r
aa0bf4f4 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
6132429e 126 For Sun JDK (see note below*):\r
127 set JAVA_HOME=c:\Java\jdk1.5.0_06 (Windows example)\r
128 export JAVA_HOME=/Library/Java/Home/ (OS X example)\r
129 export JAVA_HOME=/usr/lib/j2sdk1.5-sun/ (Linux example)\r
130 For Bea Systems:\r
782eb168 131 set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04\r
aa0bf4f4 132 \r
133 *When using the Sun JDK5.0\r
134 During installation, you should specify the install directory as C:\Java\r
135 instead of C:\Program Files\(or some other drive letter.) While installing\r
136 to this non-standard location is not required. In use, it seems to work \r
137 more reliably. \r
138 For the JDK, the install path would be C:\Java\jdk1.5.0_06\r
139 For the JRE, the install path would be C:\Java\jre1.5.0_06\r
140 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.\r
01d2ed5e 141\r
aa0bf4f4 142 NOTE: You cannot combine the location for the JDK and the JRE, as the JRE\r
143 install removes most of the binaries and libraries installed by the JDK\r
144 install.\r
145\r
146Java Tools:\r
147 The Apache-ANT requires the ANT_HOME environment variable to be set before\r
148 attempting to build:\r
01d2ed5e 149 i.e. set ANT_HOME=c:\<full path to where ant was installed>\r
6132429e 150 export ANT_HOME=~/ExternalTools/apache-ant (OS X and Linux example)\r
aa0bf4f4 151\r
152 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib \r
153 directory.\r
154\r
155 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
156 before attempting to build:\r
782eb168 157 i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
6132429e 158 export XMLBEANS_HOME=~/ExternalTools/xmlbeans (OS X and Linux example)\r
aa0bf4f4 159\r
160 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.\r
161\r
162 The Ant and XMLBean tools are required to be in the path.\r
163 MS system example:\r
164 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin\r
165 Linux/OS X bash shell example:\r
166 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin\r
167 \r
168-------------------------------------------------------------------------------\r
169Quick Start\r
170-----------\r
a032fb4d 171Copy the target.template file in the Tools/Conf directory to target.txt, which\r
172must also be in the Tools/Conf directory.\r
173\r
e3f236c8 174Edit the text file, target.txt, located in the Tools/Conf directory. This \r
a032fb4d 175file contains options for setting the active platform and restricting the build. \r
176The restictions are used to limit the build output by specifying build target(s), \r
177tagname(s) and architecture(s) to less than the full set of possible options. \r
178\r
73da4c04 179The ACTIVE_PLATFORM must be set unless the current working directory contains one\r
180or more FPD files. All other options need not be set, however by unsetting these\r
181options (by removing the line from the file, or leaving the Value empty) will \r
182result in all available build possibilites when typing build. By default EDK II\r
183can build a matrix of binaries, using different target types, tool chain tags and \r
184architectures. Options to target.txt file are as follows:\r
a032fb4d 185\r
186ACTIVE_PLATFORM = Value REQUIRED\r
187 Where Value is the WORKSPACE relative path and filename of a Framework Platform \r
188 Definition (FPD) File. Example:\r
189\r
190ACTIVE_PLATFORM = MdePkg/MdePkg.fpd\r
191\r
192TARGET = Value OPTIONAL\r
193 Where Value is a list of one or more of the following: DEBUG, RELEASE or a User\r
194 Defined Target type, such as PERF. Example: \r
195\r
196TARGET = DEBUG RELEASE\r
197\r
198TARGET_ARCH = Value OPTIONAL\r
199 Where Value is a list of one or more supported Architectures: IA32, X64, IPF or\r
200 EBC. Example: \r
201\r
202TARGET_ARCH = IA32 X64 EBC\r
203\r
204TOOL_CHAIN_CONF = Value OPTIONAL\r
205 Where Value is the Filename of an alternate tools_def.txt file created by the\r
206 user. The alternate tools_def.txt files must be in the Tools/Conf directory.\r
207 These tool definitions are scoped to the WORKSPACE (location of the EDK \r
208 installation) and cannot be shared between WORKSPACES. (You can copy the files\r
209 from one workspace to another.) Example: \r
210\r
211TOOL_CHAIN_CONF = alfred.txt\r
212\r
213TOOL_CHAIN_TAG = Value OPTIONAL\r
214 Where Value is a list of TagName entries as defined in the tools_def.txt file.\r
215 The TagName can be used to specify different versions of a compiler, i.e., \r
216 gcc 4.0 and gcc 4.1 which will allow you to build binaries with both tool chains \r
217 during the same build - useful during testing of a new compiler tool chain, or \r
218 for changing compiler flags to check out performance with a different set of \r
219 flags than flags used for production. Example:\r
220\r
221TOOL_CHAIN_TAG = GCC40 GCC41\r
222\r
223To clear a restriction, just remove any data after the equal sign. To clear\r
224the TARGET_ARCH limitation that was set above, enter: \r
225\r
226TARGET_ARCH =\r
227\r
228-----------\r
229Copy the tools_def.template file in Tools/Conf to tools_def.txt in the same\r
230directory.\r
e3f236c8 231\r
232Edit the tools definition file, tools_def.txt, also located in the Tools/Conf \r
233directory. This file contains the names of the compiler tool chains and the \r
234location of the compiler binaries. It has been pre-populated with the standard \r
235location for the Microsoft tool chains and includes the standard location of \r
a032fb4d 236the Intel C Compiler for EFI Byte Code (EBC.) In addition, EDK II provides\r
237support for Cygwin, Linux and OS X GCC compiler tool chains. A script has been\r
238provided in the Tools/gcc directory as well as instructions in obtaining and\r
239building a version of GCC that has been tested. The tools_def.txt file has\r
240the GCC binary locations that are created using this script.\r
241\r
242Both target.txt and tools_def.txt files are formatted as Property = Value, \r
243which must appear on a single line. Spanning a Value entry over multiple\r
244lines is not supported at this time. In the target.txt file, the Property is\r
245a single, uppercase word with underscore characters. These Property names are\r
246fixed by the build system. The tools_def.txt file's Property is an underscore\r
247delimited coding, which supports some user defined values. The coding for\r
248the Property is: TARGET_TAGNAME_ARCH_COMMAND_ATTR The Value, is either a \r
249full path, full path and filename or a reserved word.\r
250\r
251TARGET - DEBUG and RELEASE are predefined, however the user may define one or\r
252 more of their own TARGET types in this file.\r
253\r
254TAGNAME - HOST, MSFT, GCC, INTC are predefined, however the user may define \r
255 one or more of their own TAGNAME keywords in this file.\r
256\r
257ARCH - EDK II supports IA32, X64, IPF and EBC at this time.\r
258\r
259COMMAND - Predefined command codes are listed in the tools_def.txt file, however\r
260 the user can specify additional command codes for their one, non-\r
261 standard tools.\r
262\r
263ATTR - Predefined Attributes are listed in the tools_def.txt file.\r
264\r
265NOTE: The TAGNAME: HOST is reserved and MUST be defined in order to build the\r
266 included Tiano tools from their C source files. These tools have been\r
267 built and tested using both Microsoft and GCC tool chains.\r
268NOTE: The "*" symbol may be used as a wildcard character in most of these\r
269 fields, refer to the tools_def.txt and the "EDK II Build and Packaging\r
270 Architecture Specification" for more details.\r
271\r
272\r
273-----------\r
aa0bf4f4 274Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
13421853 275checkout the entire EDK II source tree.\r
aa0bf4f4 276\r
e3f236c8 277In a command window, change to the top level directory of the Edk II sources.\r
aa0bf4f4 278 Set the WORKSPACE environment variable, e.g.:\r
279\r
a032fb4d 280 c:\> set WORKSPACE=C:\MyWork\Edk2\r
aa0bf4f4 281\r
282To test your tool chain setup and to build the Supplied Tools, execute:\r
a032fb4d 283 c:\MyWork\Edk2\> edksetup\r
aa0bf4f4 284\r
6132429e 285On Unix systems you must source the edksetup.sh file to load the correct\r
286settings into your shell.\r
287\r
288 . edksetup.sh # Note the dot.\r
289\r
aa0bf4f4 290(This command will be referred to as the setup command throughout the rest of\r
291this document.)\r
292 NOTE: You should run the setup command at the start of every session.\r
293 This configures the environment to include the TianoTools and the\r
294 Java applications and libraries.\r
295\r
a032fb4d 296If you are confident that none of the tool tool sources have changed, and you\r
297only want to set up the workspace environment you may execute:\r
298 c:\MyWork\Edk2\> edksetup skip\r
299\r
aa0bf4f4 300Once this is completed, you are ready to test the Build, by executing:\r
a032fb4d 301 c:\MyWork\Edk2\> build\r
aa0bf4f4 302\r
e3f236c8 303This command builds active platform specified in text file target.txt. If \r
304active platform is not specified, go to sub-directory which contains FPD files and\r
305type build. More information about active platform policy reference to specification\r
306<<EDK II Build and Packaging Architecture Specification>>.\r
90f7b6a8 307\r
aa0bf4f4 308-------------------------\r
e3f236c8 309Individual Platform Builds\r
aa0bf4f4 310-------------------------\r
e3f236c8 311After running the setup command, you can build individual platforms.\r
312 In the command window, \r
313 1. Set active platform in target.txt, and type "build" in whatever directory;\r
314 2. or cd to the platform (FPD file) that you want to build, and just type:\r
a032fb4d 315 c:\MyWork\Edk2\EdkNt32Pkg\> build\r
e3f236c8 316\r
317 Note that active platform with the high priority to build, that means active \r
318 platform will be built even if exists FPD file under current directory. More \r
319 information about active platform policy reference to specification\r
320 <<EDK II Build and Packaging Architecture Specification>>. \r
aa0bf4f4 321\r
a032fb4d 322Go to <full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe\r
e3f236c8 323to run the Nt32 emulation platform under Microsoft Windows.\r
aa0bf4f4 324\r
03fed93e 325To exit the Nt32 emulation platform, you may type reset at the EFI Shell>\r
326command prompt. Alternately, you may use the Graphical interface, Boot\r
327Maintenance Manager screen's Reset System command.\r
328\r
aa0bf4f4 329------------------------\r
330Individual Module Builds\r
331------------------------\r
332After running the setup command, you can build individual modules.\r
333 In the command window, cd to the module that you want to build, and just\r
334 type:\r
a032fb4d 335 c:\MyWork\Edk2\MdePkg\Library\BaseLib\> build\r
e3f236c8 336\r
337 Note active platform must be set for individual module build. \r
aa0bf4f4 338\r
339-------------------------------------------------------------------------------\r
340A Word on Apache-ANT\r
341--------------------\r
342The Apache-ANT program is a build tool that uses XML-based project files.\r
343Similar to Makefiles, these project files may contain multiple targets. Most\r
a032fb4d 344build.xml files in EDK II are auto-generated; any edits performed on the\r
345build.xml files will be overwritten the next time build is executed.\r
aa0bf4f4 346\r
a032fb4d 347Pre-defined targets in the build.xml file include:\r
aa0bf4f4 348 all - This target builds binaries for defined architectures\r
349 clean - This target removes object files generated by commands\r
350 cleanall - This target removes all generated files and directories.\r
351\r
352A Word on GCC tool chain\r
353------------------------\r
a032fb4d 354EDK II will not compile with a standard Linux gcc tool chain. While Linux\r
355distributions are usually based on ELF, EDK II requires a version of gcc \r
356that is configured to produce PE-COFF images. You will find a script in \r
357edk2/Tools/gcc that will download, configure, compile, and install a gcc \r
3584.X cross-compile tool chain for EDK II development. It has support for \r
359the IA32 architecture. It can be built and run on Cygwin, Linux, and many \r
360other POSIX compliant host operating environments. There are a few tools\r
361that you will need on your host computer in order to compile the tool \r
362chain. Among them are bash, gcc, gmake, curl (or wget).\r
aa0bf4f4 363\r
364-------------------------------------------------------------------------------\r
365\r
366General Information:\r
367=============================================================== \r
368Mechanisms:\r
369----------\r
8fb9e6b8 370A brief overview:\r
aa0bf4f4 371\r
372A) Surface Area Package Description (SPD) file contains information about the\r
373modules that the package contains, including the location of all MSA files, and\r
374public library names and headers that might be provided by a module in the\r
375package. Packages are defined by SPD files. (Found in the root of the Package\r
a032fb4d 376subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "EDK Build \r
377and Packaging Architecture Specification" document.\r
aa0bf4f4 378 \r
379B) Module Surface Area Definition (MSA) files. A description of a module's \r
380surface area, with all module specific default flags and features specified.\r
381Refer to the "Module Surface Area Architecture Specification" for additional\r
a032fb4d 382details. The MSA is further explained in the "EDK II Build Packaging Architecture \r
383Specification" document.\r
384\r
385C) Framework Platform Description (FPD) files. A description of a platform's\r
386surface are, including a list of modules that are needed by the platform. To\r
387support individual module builds, developers are not required to provide\r
388information about specific flash devices, nor flash device layout. There are\r
389specific sections in the FPD file that do control aspects of the build, such \r
390as the Supported Architectures and Build Targets, as well as the tool flags \r
391that are used to create the binary files. A valid platform file can specify \r
392zero or more modules, so individual modules can be compiled within the context\r
393of a platform (FPD) definition.\r
394\r
395D) Platform Configuration Database (PCD). A platform database which contains a\r
aa0bf4f4 396variety of current platform settings or directives by which a driver or\r
397application can interact with. The PCD is defined by the PCD_Protocol (This is\r
398further explained in the "Platform Configuration Database Infrastructure \r
399Description" document.\r
400\r
a032fb4d 401E) Library Class. A library class is a logical grouping of similar functions.\r
aa0bf4f4 402When developing components, the module surface area declares the class of\r
a032fb4d 403libraries that can be used by the component. The MSA and SPD files can specify\r
404a recommended instance of the library that a platform integrator may select,\r
405however this is only a recommendation. The PI may choose to select a different\r
406library instance to be used during compilation/linking. All library type modules \r
407must include header files in their distribution package, as well as their MSA\r
408files. Components, on the other hand, need only provide an MSA and either source\r
409or binary files when distributing packages. The Library Classes are further \r
410explained in the "EDK II Build and Packaging Architecture Specification" \r
411document.\r
aa0bf4f4 412\r
413=========================================================================\r
414The common operations by developers of new modules are:\r
415-------------------------------------------------------\r
416\r
4171) How to manually create a new module in a package:\r
418 - The module source code must first be created in an appropriate directory\r
419 (under the package the module is to be a part of.) \r
420 - An MSA file must be created, spelling out all aspects of the module.\r
421 - The MSA must be added to the SPD for the package to include the module.\r
422\r
423-----------------------------------------\r
4242) Add/Remove module(s) to/from a package:\r
425\r
426 - Setup environment as Build\r
427 - Add a module to a package\r
e3f236c8 428 * Generate the module SurfaceArea description file\r
429 * Add a new <Filename> element under <MsaFiles> into\r
aa0bf4f4 430 <PackageDir>\<PackageName>.spd, using relative path to package\r
e3f236c8 431 * Add a new <ModuleSA> entry under each <FrameworkModules> into\r
432 <PackageDir>\<PackageName>.fpd file if necessary. \r
aa0bf4f4 433\r
434 - Remove a module from a package\r
e3f236c8 435 * Comment out or remove corresponding <Filename> element under <MsaFiles>\r
aa0bf4f4 436 from <PackageDir>\<PackageName>.spd\r
437 * Comment out or remove corresponding <ModuleSA> entry under each\r
e3f236c8 438 <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary. \r
aa0bf4f4 439\r
440-----------------------------------\r
4413) How to manually create a package:\r
442 - Identify the modules that are to be members of the project.\r
443 - Identify the Variables and Guids required in and of the Package (including\r
444 consumption/production information).\r
445 - Create an SPD file defining these modules and calling out their MSA files.\r
e3f236c8 446 - add a new <Filename> element under <PackageList> into \r
447 Tools\Conf\FrameworkDatabase.db, using the relative path to workspace. \r
aa0bf4f4 448\r
449--------------------------------------\r
4504) Declare a new Protocol in a package: \r
451 - This release requires manual editing of the SPD file, adding the protocol\r
452 to the ProtocolDeclarations section of the file. \r
453 - Add the Protocol .h file to the Include\Protocol directory.\r
64fcaead 454 - Add an <Entry> to the <ProtocolDeclarations> element in the \r
455 <PackageName>.spd file\r
aa0bf4f4 456 * Each line contains Protocol base name then the global variable name and\r
457 then the hex value of the Protocol GUID.\r
458\r
64fcaead 459Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):\r
460<ProtocolDeclarations>\r
e3f236c8 461 <Entry Name="Bds">\r
462 <C_Name>gEfiBdsArchProtocolGuid</C_Name>\r
463 <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>\r
464 <HelpText/>\r
465 </Entry>\r
466 <Entry Name="Cpu">\r
467 <C_Name>gEfiCpuArchProtocolGuid</C_Name>\r
468 <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>\r
469 <HelpText/>\r
470 </Entry>\r
471</ProtocolDeclarations>\r
aa0bf4f4 472\r
473---------------------------------\r
4745) Declare a new PPI in a package:\r
475 - This release requires manual editing of the SPD file\r
476 - Add the PPI .h file to the Include\Ppi directory.\r
64fcaead 477 - Add an <Entry> to the package <PpiDeclarations> element in the \r
478 <PackageName>.spd file\r
aa0bf4f4 479 * Each line contains PPI base name then the global variable name and then\r
480 the hex value of the PPI GUID.\r
481\r
64fcaead 482Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):\r
483<PpiDeclarations>\r
e3f236c8 484 <Entry Name="BootInRecoveryMode">\r
485 <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>\r
486 <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>\r
487 <HelpText/>\r
64fcaead 488 </Entry>\r
e3f236c8 489 <Entry Name="CpuIo">\r
490 <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>\r
491 <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>\r
492 <HelpText/>\r
64fcaead 493 </Entry>\r
494</PpiDeclarations>\r
495\r
aa0bf4f4 496----------------------------------\r
4976) Declare a new GUID in a package:\r
498 - This release requires manual editing of the SPD file to include the new\r
64fcaead 499 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration\r
500 element as described above.\r
aa0bf4f4 501\r
502--------------------------------------- \r
54c9f9ed 5037) Declare a new PCD entry in a package:\r
aa0bf4f4 504 - This release requires manual editing of the SPD file to include the new\r
64fcaead 505 PCD. New Pcd entries are added to the PcdDefinitions section of the\r
506 <PackageName>.spd file using the following example for the format:\r
507 NOTE: The hex <Token> value must be unique.\r
508\r
54c9f9ed 509<PcdDeclarations>\r
64fcaead 510 <PcdEntry ItemType="FIXED_AT_BUILD">\r
511 <C_Name>PcdMaximumUnicodeStringLength</C_Name>\r
512 <Token>0x00000001</Token>\r
54c9f9ed 513 <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
64fcaead 514 <DatumType>UINT32</DatumType>\r
54c9f9ed 515 <ValidUsage>FIXED_AT_BUILD</ValidUsage>\r
64fcaead 516 <DefaultValue>1000000</DefaultValue>\r
54c9f9ed 517 <HelpText>The maximum lengh for unicode string.</HelpText>\r
64fcaead 518 </PcdEntry>\r
54c9f9ed 519</PcdDeclarations>\r
aa0bf4f4 520 \r
521------------------------------\r
5228) Declare a new Library Class:\r
523 - This release requires manual editing of the SPD file to include the new\r
64fcaead 524 Library Class. New Library Class entries are added to the \r
525 LibraryClassDeclarations seection of the <PackageName>.spd file using\r
526 the following example for the format:\r
527\r
528<LibraryClassDeclarations>\r
e3f236c8 529 <LibraryClass Name="BaseLib">\r
64fcaead 530 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>\r
e3f236c8 531 <HelpText/>\r
532 </LibraryClass>\r
533 <LibraryClass Name="BaseMemoryLib">\r
534 <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>\r
535 <HelpText/>\r
536 </LibraryClass>\r
64fcaead 537</LibraryClassDeclarations>\r
aa0bf4f4 538\r
aa0bf4f4 539=======================================================\r
540Notes:\r
541------\r
13421853 542The EDK II represents significant changes in the structure of the EDK.\r
aa0bf4f4 543Therefore it is very difficult to isolate all of the changes of this version of\r
544the EDK with the previous (EDK 1.0) version.\r
545\r
546Of particular note:\r
547\r
13421853 5481) EDK II contains new hardware feature support for the ICH SMBUS Libraries.\r
aa0bf4f4 549 These libraries are provided to make Memory Reference Code (MRC) development\r
550 easier.\r
1465cc8b 5512) The MDE Libraries - The MDE libraries represent significant changes in source\r
aa0bf4f4 552 (with only limited changes in functionality.) These new libraries conform\r
553 to the "MDE Library Specification". \r
5543) The Fat Binary and the EDK Shell Binary Packages are functionally identical\r
555 to the EDK 1.0 version.\r
5564) The EDK tools directory has been expanded to include more tools and more\r
557 tool functionality.\r
5585) The EDK NT32 section has been ported to the new build process, but\r
559 functionally remains the same as the EDK 1.0 version.\r
13421853 5606) The Application "HelloWorld" has been ported to EDK II as well.\r
aa0bf4f4 561\r
562=======================================================\r
563Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no\r
564virus detected.\r
565\r