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