Added dependency of AutoGen.h for .c file generated from unicode file
[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
225 C:\cygwin\bin on /usr/bin type user (binmode)
226 C:\cygwin\lib on /usr/lib type user (binmode)
227 c:\workspace on /workspace type system (binmode)
228 C:\cygwin on / type user (binmode)
229
230 If you use textmode, it is likely that the build will fail in a way that is
231 hard to debug.
232
233 Cygwin is pretty slow, so it is not recommended for large builds.
234
235
236
237
238
239 The platform to be built is identified by the Tools/Conf/target.txt file:
240
241 #
242 # PROPERTY Type Use Description
243 # ---------------- -------- -------- -----------------------------------------------------------
244 # ACTIVE_PLATFORM Filename Recommended Specify the WORKSPACE relative Path and Filename
245 # of the platform FPD file that will be used for the build
246 # This line is required if and only if the current working
247 # directory does not contain one or more FPD files.
248
249 ACTIVE_PLATFORM =
250
251 You can leave it black, as above, or set it to any .fpd file in the workspace.
252 If you leave it blank, then you just cd to the dir that contains the .fpd that
253 you would like to build (MdePkg/ or EdkModulePkg/) and then type build.
254
255 ----------------------------
256 A Word on compiling on Linux
257 ----------------------------
258
259 In order to compile on Linux, you will need to have the e2fsprogs-dev package
260 installed. Check your distribution for the rpm, deb or other package format.
261 This package contains the uuid library and header that are used by some of the
262 host tools.
263
264 If you are running on x86_64 Linux, then you should install a 64 bit version of
265 the Java JDK. The version that was used was jdk-1_5_0_07-linux-amd64-rpm.bin.
266 It may be downloaded from sun.com.
267
268 -----------------------------------------
269 A Word on compiling under Cygwin with gcc
270 -----------------------------------------
271
272 Cygwin is a POSIX style operating environment for Windows. It is possible to
273 compile the EDK 2 using gcc and cygwin. Compiling under cygwin is slow, because
274 the underlying file accesses are slow in cygwin. For this reason, we do not
275 encourage the use of cygwin. A true unix system will be a superior choice for
276 those wishing to compile with gcc.
277
278 Make sure that you select the e2fsprogs development package when you install
279 cygwin. It is necessary for the GenFvImage tool.
280
281 ----------------------------------------
282 A Word on gcc for Processor Architectures
283 ----------------------------------------
284
285 Currently gcc support is limited to IA-32 builds, generating IA-32 PE32 images.
286
287 The X64 bit (Intel 64, etc.) support under the gcc compiler does not support the EFIAPI
288 calling convention (as defined in the UEFI 2.0 specification Chapter 2), so it is not
289 possible to build a working EFI image for an X64 environment. Since the x64 gcc does
290 not support the EFIAPI calling convention the x64 tools do not support generating a
291 PE32+ image. The EFIAPI calling convention is very similar to the Microsoft x64
292 calling convention.
293
294 On ItaniumĀ® Processors the gcc compiler does not support generating a PE32+ image.
295
296 -----------------------
297 Notes on Documentation
298 -----------------------
299 The documents are being managed by the Subversion Source Control on
300 Tianocore.org. The document repository is "docs" and must be checked out
301 separately from the EDK II source tree. Refer to the checkout procedures on
302 the Tianocore.org Web site for EDK II.
303
304 The URL of the document repository is:
305 https://edk2.tianocore.org/svn/edk2/trunk/docs
306
307
308 -------------------------------------------------------------------------------
309 Quick Start
310 -----------
311 (assumes Microsoft Tools and OS environment, for GCC Tools or Linux, see
312 "Detailed Starting Instructions" below)
313
314 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to
315 check out the entire EDK II source tree.
316
317 In a command window, change to the top-level directory of the EDK II source.
318
319 To test your tool chain setup and to build the supplied tools, execute:
320 c:\MyWork\edk2\> edksetup ForceRebuild
321
322 (The edksetup script is referred to as the setup command throughout the
323 rest of this document.)
324 NOTE: You should run the setup command at the start of every session.
325 This configures the environment to include the TianoTools and the
326 Java applications and libraries.
327
328 You will need to set the WORKSPACE environment variable, or run the edksetup
329 script (without any arguments), any time you want to build.
330
331 Set the WORKSPACE environment variable, e.g.:
332
333 c:\> set WORKSPACE=C:\MyWork\edk2
334
335 You may need to edit the text files Tools/Conf/target.txt and
336 Tools/Conf/tools_def.txt (created by edksetup) using your favorite
337 text editor to ensure that the paths to the tools you want to use
338 to build EDK II binaries are correct. These files contain the default
339 paths (as per the default installation of the tools), so a customized
340 install may require this manual process.
341
342 Once this is completed, you are ready to test the build, by executing:
343 c:\MyWork\edk2\> build
344
345 This command builds the active platform specified in text file target.txt. If
346 the active platform is not specified target.txt, you must execute the build
347 command from the sub-directory that contains FPD files. For more information
348 about the active platform policy, see the \93EDK II Build and Packaging
349 Architecture Specification.\94
350
351 -------------------------------------------------------------------------------
352 Detailed Starting Instructions
353 ------------------------------
354
355 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to
356 check out the entire EDK II source tree.
357
358 In a command window, change to the top-level directory of the EDK II source.
359
360 If the active compiler tool chain is GCC, you must set the
361 environment variable, TOOL_CHAIN to "gcc" before running the
362 edksetup script. Example: export TOOL_CHAIN=gcc
363
364 To test your tool chain setup and to build the supplied tools, execute:
365 c:\MyWork\edk2\> edksetup ForceRebuild
366
367 On Linux systems, you must source the edksetup.sh file to load the correct
368 settings into your shell.
369
370 . edksetup.sh # Note the dot.
371
372 If you have recently updated your code from subversion, the tools will need to
373 be rebuilt if there were any code changes made to them. You can request that
374 the tools get rebuilt by typing:
375
376 . edksetup.sh Rebuild # Unix-like systems
377 edksetup.bat Rebuild # Windows
378
379 The edksetup script is referred to as the setup command throughout the
380 rest of this document.
381 NOTE: You should run the setup command at the start of every session.
382 This configures the environment to include the TianoTools and the
383 Java applications and libraries.
384
385 Any changes to the tool source code or XML Schema documents require that
386 you execute the following:
387 c:\MyWork\edk2\> edksetup ForceRebuild
388
389 You must set the WORKSPACE environment variable, or run the edksetup
390 script (without any arguments), any time you want to build.
391
392 Set the WORKSPACE environment variable, e.g.:
393
394 c:\> set WORKSPACE=C:\MyWork\edk2
395
396 You may need to edit the text files Tools/Conf/target.txt and
397 Tools/Conf/tools_def.txt (created by edksetup) using your favorite
398 text editor to ensure that the paths to the tools you want to use
399 to build EDK II binaries are correct. These files contain the default
400 paths (as per the default installation of the tools), so a customized
401 tool installation may require this manual process.
402
403 Once this is completed, you are ready to test the build, by executing:
404 c:\MyWork\edk2\> build
405
406 This command builds the active platform specified in text file target.txt. If
407 the active platform is not specified, go to the sub-directory that contains FPD
408 files and execute the build command. For more information about the active
409 platform policy, see the \93EDK II Build and Packaging Architecture
410 Specification.\94
411
412 --------------------------
413 Individual Platform Builds
414 --------------------------
415 After running the setup command, you can build individual platforms.
416 In the command window:
417 Set the active platform in target.txt, and execute this command:
418 c:\<directory>\> build
419 or
420 cd to the platform (FPD file) that you want to build and execute this command:
421 c:\MyWork\edk2\EdkNt32Pkg\> build
422
423 Note that the active platform specified in target.txt overrides the platform
424 specified by any FPD file in the current directory. For more information
425 about active platform policy, see the \93EDK II Build and Packaging Architecture
426 Specification.\94
427
428 To run the Nt32 emulation platform under Microsoft Windows, go to
429 <full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe
430
431 To exit the Nt32 emulation platform, type \93reset\94 at the EFI Shell>
432 command prompt. Alternatively, from the graphical interface, select the Boot
433 Maintenance Manager's \93Reset System\94 command.
434
435 NOTE: When creating a new platform, the Platform Name is restricted
436 to a single word containing alphanumeric characters, underscore, dash,
437 and period. The space character and other special characters are
438 not allowed.
439
440 -----------------------
441 Notes on Symbolic Debug
442 -----------------------
443 To enable EFI Symbolic Debugging, make sure the target output is set to DEBUG
444 in the text file Tools/Conf/target.txt and then modify the FPD <BuildOptions>
445 <Options><Option BuildTargets="DEBUG" ToolCode="CC"> and append the following
446 compiler options to the string:
447 "/D EFI_GENERATE_SYM_FILE", "/D EFI_SYMBOLIC_DEBUG"
448
449 (If the Option line does not contain "/D EFI_DEBUG", you must add that
450 option as well.)
451
452 ------------------------
453 Individual Module Builds
454 ------------------------
455 After running the setup command, you can build individual modules.
456 In the command window, cd to the module that you want to build, and
457 execute the build command:
458 c:\MyWork\edk2\MdePkg\Library\BaseLib\> build
459
460 You must set the active platform in target.txt for individual module builds.
461
462 -------------------------------------------------------------------------------
463
464 General Information:
465 ===============================================================
466 Mechanisms
467 ----------
468 A brief overview:
469
470 A) The Surface Area Package Description (SPD) file contains information about
471 the modules that the package contains, including the location of all MSA files,
472 and public library names and headers that might be provided by a module in the
473 package. Packages are defined by SPD files. (Found in the root of the Package
474 subdirectory (i.e. EdkNt32Pkg).) The SPD file is further explained in \93EDK II
475 Build and Packaging Architecture Specification.\94
476
477 B) Module Surface Area Definition (MSA) files. A description of a module's
478 surface area, with all module specific default flags and features specified.
479 For additional details, see the "EDK II Module Surface Area Specification" and
480 the "EDK II Build and Packaging Architecture Specification."
481
482 C) Framework Platform Description (FPD) files. A description of a platform's
483 surface are, including a list of modules that are needed by the platform. To
484 support individual module builds, developers are not required to provide
485 information about specific flash devices, nor flash device layout.
486 Specific sections in the FPD file control aspects of the build, such
487 as the Supported Architectures and Build Targets, as well as the tool flags
488 that are used to create the binary files. A valid platform file can specify
489 zero or more modules, so individual modules can be compiled within the context
490 of a platform (FPD) definition.
491
492 D) Platform Configuration Database (PCD). A platform database that contains a
493 variety of current platform settings or directives that can be accessed by a
494 driver or application. The PCD is defined by the PCD_Protocol (This is
495 further explained in the "EDK II Platform Configuration Database Infrastructure
496 Description."
497
498 E) Library Class. A library class is a logical grouping of similar functions.
499 When developing components, the module surface area declares the class of
500 libraries that can be used by the component. The MSA and SPD files can specify
501 a recommended instance of the library that a platform integrator (PI) may
502 select, however this is only a recommendation. The PI may choose to select a
503 different library instance to be used during compilation and linking. All
504 library type modules must include header files in their distribution package,
505 as well as their MSA files. Components, on the other hand, need provide only an
506 MSA file and either source or binary files when distributing packages. The
507 Library Classes are further explained in the "EDK II Build and Packaging
508 Architecture Specification."
509
510 =========================================================================
511 The common operations by developers of new modules are:
512 -----------------------------------------------
513 1) Manually creating a new module in a package:
514 - The module source code must first be created in an appropriate directory
515 (under the package the module is to be a part of.)
516 - An MSA file must be created, spelling out all aspects of the module.
517 - The MSA must be added to the SPD for the package to include the module.
518
519 -----------------------------------------------------
520 2) Adding and Removing modules to and from a package:
521
522 - Set up environment as Build
523 - Adding a module to a package:
524 - Generate the MSA file
525 - Add a new <Filename> element under <MsaFiles> into
526 <PackageDir>\<PackageName>.spd, using arelative path to the package
527 - Add a new <ModuleSA> entry under each <FrameworkModules> into the
528 <PackageDir>\<PackageName>.fpd file if necessary.
529
530 - Removing a module from a package:
531 - Comment out or remove the corresponding <Filename> element under
532 <MsaFiles> from <PackageDir>\<PackageName>.spd
533 - Comment out or remove the corresponding <ModuleSA> entry under each
534 <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary.
535
536 -------------------------------
537 3) Manually creating a package:
538 - Identify the modules that are to be members of the project.
539 - Identify the Variables and Guids required in and of the Package (including
540 consumption and production information).
541 - Create an SPD file defining these modules and calling out their MSA files.
542 - Add a new <Filename> element under <PackageList> into
543 Tools\Conf\FrameworkDatabase.db, using the relative path to the workspace.
544
545 -----------------------------------------
546 4) Declaring a new Protocol in a package:
547 - This release requires manual editing of the SPD file, adding the protocol
548 to the ProtocolDeclarations section of the file.
549 - Add the Protocol .h file to the Include\Protocol directory.
550 - Add an <Entry> to the <ProtocolDeclarations> element in the
551 <PackageName>.spd file
552 - Each line contains Protocol base name, followed by the global variable
553 name, and the hex value of the Protocol GUID.
554
555 Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD
556 file):
557 <ProtocolDeclarations>
558 <Entry Name="Bds">
559 <C_Name>gEfiBdsArchProtocolGuid</C_Name>
560 <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>
561 <HelpText/>
562 </Entry>
563 <Entry Name="Cpu">
564 <C_Name>gEfiCpuArchProtocolGuid</C_Name>
565 <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>
566 <HelpText/>
567 </Entry>
568 </ProtocolDeclarations>
569
570 ------------------------------------
571 5) Declaring a new PPI in a package:
572 - This release requires manual editing of the SPD file
573 - Add the PPI .h file to the Include\Ppi directory.
574 - Add an <Entry> to the package <PpiDeclarations> element in the
575 <PackageName>.spd file
576 - Each line contains the PPI base name, followed by the global variable
577 name and the hex value of the PPI GUID.
578
579 Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):
580 <PpiDeclarations>
581 <Entry Name="BootInRecoveryMode">
582 <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>
583 <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>
584 <HelpText/>
585 </Entry>
586 <Entry Name="CpuIo">
587 <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>
588 <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>
589 <HelpText/>
590 </Entry>
591 </PpiDeclarations>
592
593 -------------------------------------
594 6) Declaring a new GUID in a package:
595 - This release requires manual editing of the SPD file to include the new
596 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration
597 element, as described above.
598
599 ------------------------------------------
600 7) Declaring a new PCD entry in a package:
601 - This release requires manual editing of the SPD file to include the new
602 PCD. New Pcd entries are added to the PcdDefinitions section of the
603 <PackageName>.spd file using the following example for the format
604 (NOTE: The hex <Token> value must be unique):
605
606 <PcdDeclarations>
607 <PcdEntry ItemType="FIXED_AT_BUILD">
608 <C_Name>PcdMaximumUnicodeStringLength</C_Name>
609 <Token>0x00000001</Token>
610 <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
611 <DatumType>UINT32</DatumType>
612 <ValidUsage>FIXED_AT_BUILD</ValidUsage>
613 <DefaultValue>1000000</DefaultValue>
614 <HelpText>The maximum lengh for unicode string.</HelpText>
615 </PcdEntry>
616 </PcdDeclarations>
617
618 ------------------------------
619 8) Declaring a new Library Class:
620 - This release requires manual editing of the SPD file to include the new
621 Library Class. New Library Class entries are added to the
622 LibraryClassDeclarations section of the <PackageName>.spd file using
623 the following example for the format:
624
625 <LibraryClassDeclarations>
626 <LibraryClass Name="BaseLib">
627 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>
628 <HelpText/>
629 </LibraryClass>
630 <LibraryClass Name="BaseMemoryLib">
631 <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>
632 <HelpText/>
633 </LibraryClass>
634 </LibraryClassDeclarations>
635
636 =======================================================
637 EDK II Changes Relative to the original EDK:
638 --------------------------------------------
639 The EDK II represents significant changes in the structure of the EDK.
640 Therefore, it is very difficult to isolate all of the changes of this version of
641 the EDK with the original EDK.
642
643 Of particular note:
644
645 1) EDK II contains new hardware feature support for the ICH SMBUS Libraries.
646 These libraries are provided to make Memory Reference Code (MRC) development
647 easier.
648 2) The MDE libraries represent significant changes in source
649 (with only limited changes in functionality.) These new libraries conform
650 to the "EDK II Module Development Environment Library Specification.\94
651 3) The Fat Binary and the EDK Shell Binary Packages are functionally identical
652 to the original EDK.
653 4) The EDK tools directory has been expanded to include more tools and more
654 tool functionality.
655 5) The EDK NT32 section has been ported to the new build process, but
656 functionally remains the same as the original EDK.
657 6) The Application "HelloWorld" has been ported to EDK II as well.
658
659 =======================================================
660 Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no
661 virus detected.
662