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