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