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