Removed DEFAULT Usage type - it is not valid, and should have been removed a while...
[people/mcb30/edk2.git] / edk2 / ReleaseNotes.txt
1 Intel(R) Platform Innovation Framework for EFI\r
2 EFI Development Kit II (EDK II) \r
3 Root Package 1.00\r
4 2006-07-18\r
5 \r
6 Intel is a trademark or registered trademark of Intel Corporation or its \r
7 subsidiaries in the United States and other countries.\r
8 * Other names and brands may be claimed as the property of others.\r
9 Copyright (c) 2006, Intel Corporation\r
10 \r
11 This document provides updates to documentation, along with a description on \r
12 how to install and build the EDK II.\r
13 \r
14 Package Contents\r
15 ----------------\r
16   ReleaseNote.txt- These release notes for the package.\r
17   MdePkg         - Industry-standard headers and libraries\r
18   Tools          - Build -specific tools that are designed to help the \r
19                    developer create and modify drivers and libraries\r
20   EdkModulePkg   - Reference drivers\r
21   EdkFatBinPkg   - Binary DXE drivers for the Fat 32 file system\r
22   EdkShellBinPkg - Binary Shell applications and commands\r
23   EdkNt32Pkg     - NT32 Emulation platform reference\r
24 \r
25 Note: MDE and MDK that appear in other documentation refer to the MdePkg and\r
26 Tools packages, respectively.  While, these two packages are the minimum \r
27 requirement for developing EDK II Packageswe recommend that you download all \r
28 of the top-level files listed above.\r
29 \r
30 The following package is available as a separate project, under a separate \r
31 license, on the TianoCore.org website: https://fat-driver2.tianocore.org\r
32 \r
33   EdkFatPkg      - A package containing source DXE drivers for the Fat 32 file\r
34                    system\r
35 \r
36 Documents have the following filenames (to download these documents, see \93Notes \r
37 on Documentation\94 later in these Release Notes):\r
38   EDK II Module Development Environment Library Specification, v0.58 \r
39       (MDE_Library_Spec_0_58.rtf)\r
40   EDK II Build and Packaging Architecture Specification, v0.53\r
41       (Build_Packaging_Spec_0_53.rtf)\r
42   EDK II Platform Configuration Database Infrastructure Description, v0.54\r
43       (PCD_Infrastructure_0_54.rtf)\r
44   EDK II Module Surface Area Specification, v0.51\r
45       (Module_Surface_Area_0_50.rtf)\r
46   EDK II Module Development Environment Package Specification, v0.51\r
47       (MDE_Package_Spec_0_51.rtf)\r
48   EDK II C Coding Standards Specification v0.51\r
49       (C_Coding_Standards_Specification_ 0_51.rtf)\r
50   EDK II Subversion Setup Guide\r
51       (edk2-subversion-setup.rtf)\r
52 \r
53 Pre-Requisites\r
54 --------------\r
55 The following list of tools must be installed on the development workstation\r
56 prior to using the EDK II.\r
57 \r
58 Compiler Tool Chain\r
59       Microsoft* Visual Studio .NET 2003*  (http://www.microsoft.com)\r
60     or\r
61       A special GCC version 4.x or later (http://gcc.gnu.org). See below.\r
62 \r
63 Assembler Tool Chain\r
64       Microsoft Macro Assembler, version 6.15 or later\r
65     or\r
66       GNU binutils 2.16.1 or later\r
67 \r
68 Java Development Kit ( Java 5.0 or later)\r
69       Sun* jdk-1.5.0_06 or later (http://java.sun.com)\r
70     or\r
71       Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com)\r
72 \r
73 Java Tools\r
74     Apache-ANT, version 1.6.5 or later (http://ant.apache.org)\r
75     Ant-contrib, version 1.0b2 or later\r
76       (http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download)\r
77     Saxon8, version 8.1.1\r
78       (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)\r
79     XMLBeans, version 2.1.0 (http://xmlbeans.apache.org)\r
80       DO NOT download the latest XMLBeans, version 2.2.0. It is not compatible \r
81       with Saxon8, version 8.1.1.\r
82 \r
83 Other Tools\r
84     TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)\r
85 \r
86 Optional Tools\r
87 --------------\r
88 Compiler Tool Chains:\r
89     Intel(R) C++ Compiler for Windows*, ver. 9.0 or later (http://www.intel.com)\r
90     Intel(R) C Compiler for EFI Byte Code, ver. 1.2 or later \r
91       (http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm)\r
92     Microsoft Driver Development Kit, version 3790.1830 or later\r
93       (http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx)\r
94     Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later\r
95     Intel ACPI Component Architecture, version 20060113\r
96 \r
97 -----------------------------------------------\r
98 Notes on Required Tools (Source Control System)\r
99 -----------------------------------------------\r
100 The EDK II is being managed by the Subversion Source Control on Tianocore.org.\r
101 Subversion provides speed, security, and additional features. The\r
102 recommended client is TortoiseSVN version 1.3.3. \r
103  (Available at http://tortoisesvn.tigris.org/)\r
104 \r
105 The checkout procedures on the Tianocore.org Web site include\r
106 instructions for the use of Subversion Source Control.\r
107 \r
108 The URL of the EDK II repository is:\r
109   https://edk2.tianocore.org/svn/edk2/trunk/edk2\r
110 \r
111 \r
112 --------------------------------------------------------------------\r
113 Notes On Required Tools (With examples for Windows, OS X, and Linux*) \r
114 --------------------------------------------------------------------\r
115 Software Installation Order:\r
116   After installing the compiler tools and your Subversion client, install the \r
117   following required tools in this order: \r
118     1. Java JDK\r
119     2. Apache-Ant\r
120     3. ant-contrib\r
121     4. xmlbeans\r
122     5. saxon8\r
123 \r
124 Java Development Kit:\r
125  \r
126    The Java Environment Variable must be set before attempting to build.\r
127        For Sun JDK (see note below\86):\r
128               set JAVA_HOME=c:\Java\jdk1.5.0_06  (Windows example)\r
129               export JAVA_HOME=/Library/Java/Home/ (OS X example)\r
130               export JAVA_HOME=/usr/lib/j2sdk1.5-sun/ (Linux example)\r
131        For Bea Systems:\r
132               set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04\r
133  \r
134   \86 When using the Sun JDK5.0:\r
135     During installation, you should specify the install directory as C:\Java\r
136     instead of C:\Program Files\(or some other drive letter.)  While installing\r
137     to this non-standard location is not required, in practice, it seems to work \r
138     more reliably. \r
139     For the JDK, the install path is C:\Java\jdk1.5.0_06\r
140     For the JRE, the install path is C:\Java\jre1.5.0_06\r
141     Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.\r
142 \r
143     NOTE: You cannot combine the location for the JDK and the JRE, because the \r
144     JRE install removes most of the binaries and libraries installed by the JDK\r
145     install.\r
146 \r
147 Java Tools:\r
148     The Apache-ANT requires the ANT_HOME environment variable to be set before\r
149     attempting to build:\r
150          set ANT_HOME=c:\<full path to where ant was installed>\r
151           export ANT_HOME=~/ExternalTools/apache-ant (OS X and Linux example)\r
152 \r
153     The ant-contrib.jar file should be installed in the %ANT_HOME%\lib \r
154     directory.\r
155 \r
156     XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
157     before attempting to build:\r
158          set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
159           export XMLBEANS_HOME=~/ExternalTools/xmlbeans (OS X and Linux example)\r
160 \r
161     Copy the saxon8.jar file to the %XMLBEANS_HOME%\lib directory.\r
162 \r
163    The Ant and XMLBean tools must be in the path.\r
164      MS system example:\r
165         set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin\r
166      Linux/OS X bash shell example:\r
167         export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin\r
168 \r
169 --------------------\r
170 A Word on Apache-ANT\r
171 --------------------\r
172 The Apache-ANT program is a build tool that uses XML-based project files.\r
173 Similar to Makefiles, these project files may contain multiple targets.  Most\r
174 build.xml files in EDK II are auto-generated; any edits performed on the\r
175 build.xml files will be overwritten by the next build.\r
176 \r
177 Pre-defined targets in the build.xml file include:\r
178     all      - This target builds binaries for defined architectures.\r
179     clean    - This target removes object files generated by commands.\r
180     cleanall - This target removes all generated files and directories.\r
181 \r
182 ----------------------------\r
183 A Word on the GCC Tool Chain\r
184 ----------------------------\r
185 EDK II will not compile with a standard Linux gcc tool chain. While Linux\r
186 distributions are usually based on ELF, EDK II requires a version of gcc \r
187 that is configured to produce PE-COFF images. You will find a script in \r
188 edk2/Tools/gcc that will download, configure, compile, and install a gcc \r
189 4.X cross-compile tool chain for EDK II development. This custom tool chain \r
190 supports the IA-32 architecture. It can be built and run on Cygwin, Linux, and \r
191 many other POSIX-compliant host operating environments. To compile the custom \r
192 gcc tool chain, you need the following tools on your host computer: bash, gcc, \r
193 gmake, curl (or wget).\r
194 \r
195 Only the MdePkg and EdkModulePkg are currently supported by gcc builds. Other\r
196 builds, such as the EdkNt32Pkg, will not compile with gcc. By default, the edk2\r
197 will try to build the NT32.fpd, which is not supported by gcc. So, you need to\r
198 change the Tools/Conf/target.txt.\r
199 \r
200 The platform to be built is identified by the Tools/Conf/target.txt file:\r
201 \r
202 #\r
203 #  PROPERTY              Type       Use         Description\r
204 #  ----------------      --------   --------    -----------------------------------------------------------\r
205 #  ACTIVE_PLATFORM       Filename   Recommended Specify the WORKSPACE relative Path and Filename \r
206 #                                               of the platform FPD file that will be used for the build\r
207 #                                               This line is required if and only if the current working\r
208 #                                               directory does not contain one or more FPD files.\r
209 \r
210 ACTIVE_PLATFORM       =\r
211  \r
212 You can leave it black, as above, or set it to any .fpd file in the workspace.\r
213 If you leave it blank, then you just cd to the dir that contains the .fpd that\r
214 you would like to build (MdePkg/ or EdkModulePkg/) and then type build.\r
215 \r
216 ----------------------------\r
217 A Word on compiling on Linux\r
218 ----------------------------\r
219 \r
220 In order to compile on Linux, you will need to have the e2fsprogs-dev package\r
221 installed.  Check your distribution for the rpm, deb or other package format.\r
222 This package contains the uuid library and header that are used by some of the\r
223 host tools.\r
224 \r
225 If you are running on x86_64 Linux, then you should install a 64 bit version of\r
226 the Java JDK. The version that was used was jdk-1_5_0_07-linux-amd64-rpm.bin.\r
227 It may be downloaded from sun.com.\r
228 \r
229 -----------------------------------------\r
230 A Word on compiling under Cygwin with gcc\r
231 -----------------------------------------\r
232 \r
233 Cygwin is a POSIX style operating environment for Windows. It is possible to\r
234 compile the EDK 2 using gcc and cygwin. Compiling under cygwin is slow, because \r
235 the underlying file accesses are slow in cygwin. For this reason, we do not \r
236 encourage the use of cygwin. A true unix system will be a superior choice for \r
237 those wishing to compile with gcc.\r
238 \r
239 Make sure that you select the e2fsprogs development package when you install\r
240 cygwin. It is necessary for the GenFvImage tool.\r
241 \r
242 ----------------------------------------\r
243 A Word on gcc for Processor Architectures\r
244 ----------------------------------------\r
245 \r
246 Currently gcc support is limited to IA-32 builds, generating IA-32 PE32 images. \r
247 \r
248 The X64 bit (Intel 64, etc.) support under the gcc compiler does not support the EFIAPI \r
249 calling convention (as defined in the UEFI 2.0 specification Chapter 2), so it is not \r
250 possible to build a working EFI image for an X64 environment.  Since the x64 gcc does \r
251 not support the EFIAPI calling convention the x64 tools do not support generating a \r
252 PE32+ image.  The EFIAPI calling convention is very similar to the Microsoft x64 \r
253 calling convention.\r
254 \r
255 On ItaniumĀ® Processors the gcc compiler does not support generating a PE32+ image.\r
256 \r
257 -----------------------\r
258 Notes on Documentation\r
259 -----------------------\r
260 The documents are being managed by the Subversion Source Control on\r
261 Tianocore.org.  The document repository is "docs" and must be checked out\r
262 separately from the EDK II source tree. Refer to the checkout procedures on\r
263 the Tianocore.org Web site for EDK II.\r
264 \r
265 The URL of the document repository is:\r
266   https://edk2.tianocore.org/svn/edk2/trunk/docs\r
267 \r
268  \r
269 -------------------------------------------------------------------------------\r
270 Quick Start\r
271 -----------\r
272 (assumes Microsoft Tools and OS environment, for GCC Tools or Linux, see \r
273 "Detailed Starting Instructions" below)\r
274 \r
275 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
276 check out the entire EDK II source tree.\r
277 \r
278 In a command window, change to the top-level directory of the EDK II source.\r
279 \r
280 To test your tool chain setup and to build the supplied tools, execute:\r
281     c:\MyWork\edk2\> edksetup ForceRebuild\r
282 \r
283 (The edksetup script is referred to as the setup command throughout the \r
284 rest of this document.)\r
285       NOTE: You should run the setup command at the start of every session.\r
286             This configures the environment to include the TianoTools and the\r
287             Java applications and libraries.\r
288 \r
289 You will need to set the WORKSPACE environment variable, or run the edksetup\r
290 script (without any arguments), any time you want to build.\r
291 \r
292   Set the WORKSPACE environment variable, e.g.:\r
293 \r
294     c:\> set WORKSPACE=C:\MyWork\edk2\r
295 \r
296 You may need to edit the text files Tools/Conf/target.txt and\r
297 Tools/Conf/tools_def.txt (created by edksetup) using your favorite \r
298 text editor to ensure that the paths to the tools you want to use \r
299 to build EDK II binaries are correct.  These files contain the default \r
300 paths (as per the default installation of the tools), so a customized \r
301 install may require this manual process.\r
302 \r
303 Once this is completed, you are ready to test the build, by executing:\r
304     c:\MyWork\edk2\> build\r
305 \r
306 This command builds the active platform specified in text file target.txt. If \r
307 the active platform is not specified target.txt, you must execute the build \r
308 command from the sub-directory that contains FPD files. For more information \r
309 about the active platform policy, see the \93EDK II Build and Packaging \r
310 Architecture Specification.\94\r
311 \r
312 -------------------------------------------------------------------------------\r
313 Detailed Starting Instructions\r
314 ------------------------------\r
315 \r
316 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
317 check out the entire EDK II source tree.\r
318 \r
319 In a command window, change to the top-level directory of the EDK II source.\r
320 \r
321 If the active compiler tool chain is GCC, you must set the\r
322 environment variable, TOOL_CHAIN to "gcc" before running the\r
323 edksetup script.  Example: export TOOL_CHAIN=gcc\r
324 \r
325 To test your tool chain setup and to build the supplied tools, execute:\r
326     c:\MyWork\edk2\> edksetup ForceRebuild\r
327 \r
328 On Linux systems, you must source the edksetup.sh file to load the correct\r
329 settings into your shell.\r
330 \r
331     . edksetup.sh # Note the dot.\r
332 \r
333 If you have recently updated your code from subversion, the tools will need to\r
334 be rebuilt if there were any code changes made to them. You can request that\r
335 the tools get rebuilt by typing:\r
336 \r
337     . edksetup.sh Rebuild # Unix-like systems\r
338     edksetup.bat Rebuild  # Windows\r
339 \r
340 The edksetup script is referred to as the setup command throughout the \r
341 rest of this document.\r
342       NOTE: You should run the setup command at the start of every session.\r
343             This configures the environment to include the TianoTools and the\r
344             Java applications and libraries.\r
345 \r
346 Any changes to the tool source code or XML Schema documents require that\r
347 you execute the following:\r
348    c:\MyWork\edk2\> edksetup ForceRebuild\r
349 \r
350 You must set the WORKSPACE environment variable, or run the edksetup\r
351 script (without any arguments), any time you want to build.\r
352 \r
353   Set the WORKSPACE environment variable, e.g.:\r
354 \r
355     c:\> set WORKSPACE=C:\MyWork\edk2\r
356 \r
357 You may need to edit the text files Tools/Conf/target.txt and\r
358 Tools/Conf/tools_def.txt (created by edksetup) using your favorite \r
359 text editor to ensure that the paths to the tools you want to use \r
360 to build EDK II binaries are correct.  These files contain the default \r
361 paths (as per the default installation of the tools), so a customized \r
362 tool installation may require this manual process.\r
363 \r
364 Once this is completed, you are ready to test the build, by executing:\r
365     c:\MyWork\edk2\> build\r
366 \r
367 This command builds the active platform specified in text file target.txt. If \r
368 the active platform is not specified, go to the sub-directory that contains FPD \r
369 files and execute the build command. For more information about the active \r
370 platform policy, see the \93EDK II Build and Packaging Architecture \r
371 Specification.\94\r
372 \r
373 --------------------------\r
374 Individual Platform Builds\r
375 --------------------------\r
376 After running the setup command, you can build individual platforms.\r
377 In the command window:\r
378   Set the active platform in target.txt, and execute this command:\r
379     c:\<directory>\> build\r
380 or\r
381   cd to the platform (FPD file) that you want to build and execute this command:\r
382     c:\MyWork\edk2\EdkNt32Pkg\> build\r
383 \r
384   Note that the active platform specified in target.txt overrides the platform \r
385   specified by any FPD file in the current directory. For more   information \r
386   about active platform policy, see the \93EDK II Build and Packaging Architecture\r
387   Specification.\94 \r
388 \r
389 To run the Nt32 emulation platform under Microsoft Windows, go to \r
390 <full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe\r
391 \r
392 To exit the Nt32 emulation platform, type \93reset\94 at the EFI Shell>\r
393 command prompt.  Alternatively, from the graphical interface, select the Boot\r
394 Maintenance Manager's \93Reset System\94 command.\r
395 \r
396       NOTE: When creating a new platform, the Platform Name is restricted\r
397       to a single word containing alphanumeric characters, underscore, dash, \r
398       and period.  The space character and other special characters are \r
399       not allowed.\r
400 \r
401 -----------------------\r
402 Notes on Symbolic Debug\r
403 -----------------------\r
404 To enable EFI Symbolic Debugging, make sure the target output is set to DEBUG\r
405 in the text file Tools/Conf/target.txt and then modify the FPD <BuildOptions>\r
406 <Options><Option BuildTargets="DEBUG" ToolCode="CC"> and append the following\r
407 compiler options to the string:\r
408 "/D EFI_GENERATE_SYM_FILE", "/D EFI_SYMBOLIC_DEBUG"\r
409 \r
410 (If the Option line does not contain "/D EFI_DEBUG", you must add that\r
411 option as well.)\r
412 \r
413 ------------------------\r
414 Individual Module Builds\r
415 ------------------------\r
416 After running the setup command, you can build individual modules.\r
417   In the command window, cd to the module that you want to build, and\r
418   execute the build command:\r
419     c:\MyWork\edk2\MdePkg\Library\BaseLib\> build\r
420 \r
421   You must set the active platform in target.txt for individual module builds. \r
422 \r
423 -------------------------------------------------------------------------------\r
424 \r
425 General Information:\r
426 ===============================================================    \r
427 Mechanisms\r
428 ----------\r
429 A brief overview:\r
430 \r
431 A) The Surface Area Package Description (SPD) file contains information about \r
432 the modules that the package contains, including the location of all MSA files, \r
433 and public library names and headers that might be provided by a module in the\r
434 package.  Packages are defined by SPD files.  (Found in the root of the Package\r
435 subdirectory (i.e. EdkNt32Pkg).) The SPD file is further explained in \93EDK II \r
436 Build and Packaging Architecture Specification.\94\r
437  \r
438 B) Module Surface Area Definition (MSA) files.  A description of a module's \r
439 surface area, with all module specific default flags and features specified.\r
440 For additional details, see the "EDK II Module Surface Area Specification" and \r
441 the "EDK II Build and Packaging Architecture Specification."\r
442 \r
443 C) Framework Platform Description (FPD) files.  A description of a platform's\r
444 surface are, including a list of modules that are needed by the platform.  To\r
445 support individual module builds, developers are not required to provide\r
446 information about specific flash devices, nor flash device layout.  \r
447 Specific sections in the FPD file control aspects of the build, such \r
448 as the Supported Architectures and Build Targets, as well as the tool flags \r
449 that are used to create the binary files.  A valid platform file can specify \r
450 zero or more modules, so individual modules can be compiled within the context\r
451 of a platform (FPD) definition.\r
452 \r
453 D) Platform Configuration Database (PCD).  A platform database that contains a\r
454 variety of current platform settings or directives that can be accessed by a \r
455 driver or application.  The PCD is defined by the PCD_Protocol (This is\r
456 further explained in the "EDK II Platform Configuration Database Infrastructure \r
457 Description."\r
458 \r
459 E) Library Class.  A library class is a logical grouping of similar functions.\r
460 When developing components, the module surface area declares the class of\r
461 libraries that can be used by the component. The MSA and SPD files can specify\r
462 a recommended instance of the library that a platform integrator (PI) may \r
463 select, however this is only a recommendation.  The PI may choose to select a \r
464 different library instance to be used during compilation and linking. All \r
465 library type modules must include header files in their distribution package, \r
466 as well as their MSA files. Components, on the other hand, need provide only an \r
467 MSA file and either source or binary files when distributing packages.  The \r
468 Library Classes are further explained in the "EDK II Build and Packaging \r
469 Architecture Specification."\r
470 \r
471 =========================================================================\r
472 The common operations by developers of new modules are:\r
473 -----------------------------------------------\r
474 1) Manually creating a new module in a package:\r
475   - The module source code must first be created in an appropriate directory\r
476     (under the package the module is to be a part of.)  \r
477   - An MSA file must be created, spelling out all aspects of the module.\r
478   - The MSA must be added to the SPD for the package to include the module.\r
479 \r
480 -----------------------------------------------------\r
481 2) Adding and Removing modules to and from a package:\r
482 \r
483   - Set up environment as Build\r
484   - Adding a module to a package:\r
485      - Generate the MSA file\r
486      - Add a new <Filename> element under <MsaFiles> into\r
487        <PackageDir>\<PackageName>.spd, using arelative path to the package\r
488      - Add a new <ModuleSA> entry under each <FrameworkModules> into the\r
489        <PackageDir>\<PackageName>.fpd file if necessary. \r
490 \r
491    - Removing a module from a package:\r
492      - Comment out or remove the corresponding <Filename> element under \r
493        <MsaFiles> from <PackageDir>\<PackageName>.spd\r
494      - Comment out or remove the corresponding <ModuleSA> entry under each\r
495        <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary. \r
496 \r
497 -------------------------------\r
498 3) Manually creating a package:\r
499   - Identify the modules that are to be members of the project.\r
500   - Identify the Variables and Guids required in and of the Package (including\r
501     consumption and production information).\r
502   - Create an SPD file defining these modules and calling out their MSA files.\r
503   - Add a new <Filename> element under <PackageList> into \r
504     Tools\Conf\FrameworkDatabase.db, using the relative path to the workspace. \r
505 \r
506 -----------------------------------------\r
507 4) Declaring a new Protocol in a package: \r
508   - This release requires manual editing of the SPD file, adding the protocol\r
509     to the ProtocolDeclarations section of the file. \r
510   - Add the Protocol .h file to the Include\Protocol directory.\r
511   - Add an <Entry> to the <ProtocolDeclarations> element in the \r
512     <PackageName>.spd file\r
513      - Each line contains Protocol base name, followed by the global variable \r
514        name, and        the hex value of the Protocol GUID.\r
515 \r
516 Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD \r
517 file):\r
518 <ProtocolDeclarations>\r
519   <Entry Name="Bds">\r
520     <C_Name>gEfiBdsArchProtocolGuid</C_Name>\r
521     <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>\r
522     <HelpText/>\r
523   </Entry>\r
524   <Entry Name="Cpu">\r
525     <C_Name>gEfiCpuArchProtocolGuid</C_Name>\r
526     <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>\r
527     <HelpText/>\r
528   </Entry>\r
529 </ProtocolDeclarations>\r
530 \r
531 ------------------------------------\r
532 5) Declaring a new PPI in a package:\r
533   - This release requires manual editing of the SPD file\r
534   - Add the PPI .h file to the Include\Ppi directory.\r
535   - Add an <Entry> to the package <PpiDeclarations> element in the \r
536     <PackageName>.spd file\r
537      - Each line contains the PPI base name, followed by the global variable \r
538        name and        the hex value of the PPI GUID.\r
539 \r
540 Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):\r
541 <PpiDeclarations>\r
542   <Entry Name="BootInRecoveryMode">\r
543     <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>\r
544     <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>\r
545     <HelpText/>\r
546   </Entry>\r
547   <Entry Name="CpuIo">\r
548     <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>\r
549     <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>\r
550     <HelpText/>\r
551   </Entry>\r
552 </PpiDeclarations>\r
553 \r
554 -------------------------------------\r
555 6) Declaring a new GUID in a package:\r
556   - This release requires manual editing of the SPD file to include the new\r
557     Guid.  This is identical to adding a ProtocolDeclaration or PpiDeclaration\r
558     element, as described above.\r
559 \r
560 ------------------------------------------\r
561 7) Declaring a new PCD entry in a package:\r
562   - This release requires manual editing of the SPD file to include the new\r
563     PCD.  New Pcd entries are added to the PcdDefinitions section of the\r
564     <PackageName>.spd file using the following example for the format\r
565     (NOTE: The hex <Token> value must be unique):\r
566 \r
567 <PcdDeclarations>\r
568   <PcdEntry ItemType="FIXED_AT_BUILD">\r
569     <C_Name>PcdMaximumUnicodeStringLength</C_Name>\r
570     <Token>0x00000001</Token>\r
571     <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
572     <DatumType>UINT32</DatumType>\r
573     <ValidUsage>FIXED_AT_BUILD</ValidUsage>\r
574     <DefaultValue>1000000</DefaultValue>\r
575     <HelpText>The maximum lengh for unicode string.</HelpText>\r
576   </PcdEntry>\r
577 </PcdDeclarations>\r
578   \r
579 ------------------------------\r
580 8) Declaring a new Library Class:\r
581   - This release requires manual editing of the SPD file to include the new\r
582     Library Class.  New Library Class entries are added to the \r
583     LibraryClassDeclarations section of the <PackageName>.spd file using\r
584     the following example for the format:\r
585 \r
586 <LibraryClassDeclarations>\r
587   <LibraryClass Name="BaseLib">\r
588     <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>\r
589     <HelpText/>\r
590   </LibraryClass>\r
591   <LibraryClass Name="BaseMemoryLib">\r
592     <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>\r
593     <HelpText/>\r
594   </LibraryClass>\r
595 </LibraryClassDeclarations>\r
596 \r
597 =======================================================\r
598 EDK II Changes Relative to the original EDK:\r
599 --------------------------------------------\r
600 The EDK II represents significant changes in the structure of the EDK.\r
601 Therefore, it is very difficult to isolate all of the changes of this version of\r
602 the EDK with the original EDK.\r
603 \r
604 Of particular note:\r
605 \r
606 1) EDK II contains new hardware feature support for the ICH SMBUS Libraries.\r
607    These libraries are provided to make Memory Reference Code (MRC) development\r
608    easier.\r
609 2) The MDE libraries represent significant changes in source\r
610    (with only limited changes in functionality.)  These new libraries conform\r
611    to the "EDK II Module Development Environment Library Specification.\94 \r
612 3) The Fat Binary and the EDK Shell Binary Packages are functionally identical\r
613    to the original EDK.\r
614 4) The EDK tools directory has been expanded to include more tools and more\r
615    tool functionality.\r
616 5) The EDK NT32 section has been ported to the new build process, but\r
617    functionally remains the same as the original EDK.\r
618 6) The Application "HelloWorld" has been ported to EDK II as well.\r
619 \r
620 =======================================================\r
621 Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no\r
622 virus detected.\r
623 \r