added function header
[mirror_edk2.git] / ReleaseNotes.txt
CommitLineData
aa0bf4f4 1Intel(R) Platform Innovation Framework for EFI\r
362271d6 2EFI Development Kit II (EDK II) \r
3Root Package 1.00\r
dcfa7b15 42006-07-12\r
aa0bf4f4 5\r
6Copyright (c) 2006, Intel Corporation\r
7\r
8This document provides updates to documentation, along with a description on \r
362271d6 9how to install and build the EDK II.\r
aa0bf4f4 10\r
11Package Contents\r
12----------------\r
13 ReleaseNote.txt- These release notes for the package.\r
14 MdePkg - A package containing Industry Standard headers and libraries\r
15 Tools - A package containing Build Specific tools which are designed\r
16 to help the developer create and modify drivers and\r
17 libraries\r
18 EdkModulePkg - A package containing reference drivers\r
19 EdkFatBinPkg - A package containing binary DXE drivers for the Fat 32 file\r
20 system\r
362271d6 21 EdkFatPkg - A package containing source DXE drivers for the Fat 32 file\r
22 system\r
aa0bf4f4 23 EdkShellBinPkg - A package containing binary Shell applications and commands\r
24 EdkNt32Pkg - A package containing the NT32 Emulation platform reference\r
25\r
26Note: MDE and MDK that appear in other documentation refer to the MdePkg and\r
27Tools packages. These two packages are the minimum requirement for developing\r
13421853 28EDK II Packages. It is also recommended that the top level files included\r
aa0bf4f4 29with the EDK be downloaded in conjunction with these two packages.\r
30\r
31Note: Documents have the following filenames:\r
13421853 32 EDK II Module Development Environment Library Specification v0.50 \r
aa0bf4f4 33 (MDE_Library_Spec_0_50.rtf)\r
13421853 34 EDK II Build and Packaging Architecture Specification v0.50\r
aa0bf4f4 35 (Build_Packaging_Spec_0_50.rtf)\r
13421853 36 EDK II Platform Configuration Database Infrastructure Description v0.51\r
aa0bf4f4 37 (PCD_Infrastructure_0_51.rtf)\r
13421853 38 EDK II Module Surface Area v0.50\r
aa0bf4f4 39 (Module_Surface_Area_0_50.rtf)\r
13421853 40 EDK II Module Development Environment (MDE) Package Specification v0.50\r
aa0bf4f4 41 (MDE_Package_Spec_0_50.rtf)\r
13421853 42 EDK II C Coding Standards Specification v0.50\r
aa0bf4f4 43 (C_Coding_Standards_Specification_ 0_50.rtf)\r
dcfa7b15 44 EDK II Subversion Setup Guide\r
45 (edk2-subversion-setup.rtf)\r
aa0bf4f4 46\r
47Pre-Requisites\r
48--------------\r
49The following list of tools must be installed on the development workstation\r
e3f236c8 50prior to using the Edk II.\r
aa0bf4f4 51\r
52Compiler Tool Chain\r
53 Microsoft* Visual Studio .NET 2003* (http://www.microsoft.com)\r
54 or\r
43475442 55 A special GCC version 4.x or later (http://gcc.gnu.org). See below.\r
aa0bf4f4 56\r
57Assembler Tool Chain\r
58 Microsoft Macro Assembler, version 6.15 or later\r
59 or\r
8fb9e6b8 60 GNU binutils 2.16.1 or later\r
aa0bf4f4 61\r
62Java Development Kit ( Java 5.0 or later)\r
63 Sun* jdk-1.5.0_04 or later (http://java.sun.com)\r
64 or\r
65 Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com)\r
66\r
67Java Tools\r
68 Apache-ANT, version 1.6.5 or later (http://ant.apache.org)\r
50518883 69 Ant-contrib, version 1.0b2 or later\r
782eb168 70 (http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download)\r
aa0bf4f4 71 Saxon8, version 8.1.1\r
72 (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)\r
782eb168 73 XMLBeans, version 2.1.0 (http://xmlbeans.apache.org)\r
74 DO NOT download the latest XMLBeans, version 2.2.0. It cannot work with\r
75 Saxon8, version 8.1.1.\r
aa0bf4f4 76\r
77Other Tools\r
78 TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)\r
79\r
80Optional Tools\r
81--------------\r
82Compiler Tool Chains:\r
50518883 83 Intel C++ Compiler for Windows, ver. 9.0 or later (http://www.intel.com)\r
8fb9e6b8 84 Intel C Compiler for EFI Byte Code, ver. 1.2 or later \r
85 (http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm)\r
aa0bf4f4 86 Microsoft Driver Development Kit, version 3790.1830 or later\r
8fb9e6b8 87 (http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx)\r
aa0bf4f4 88 Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later\r
89 Intel ACPI Component Architecture, version 20060113\r
90\r
91-----------------------\r
92Notes On Required Tools (Source Control System)\r
93-----------------------\r
13421853 94The EDK II is being managed by the Subversion Source Control on Tianocore.org.\r
aa0bf4f4 95This software package provides speed, security, and additional features. The\r
96recommended client is TortoiseSVN version 1.3.3. \r
97 (Available at http://tortoisesvn.tigris.org/)\r
98\r
99There are instructions for the use of Subversion Source Control on the\r
100Tianocore.org website, as part of the checkout procedures.\r
101\r
13421853 102The URL of the EDK II repository is:\r
aa0bf4f4 103 https://edk2.tianocore.org/svn/edk2/trunk/edk2\r
104\r
aa0bf4f4 105\r
106-----------------------\r
6132429e 107Notes On Required Tools (With examples for Windows, OS X, and Linux) \r
aa0bf4f4 108-----------------------\r
109Software Installation Order:\r
110 After installing the compiler tools and your Subversion client, the following\r
111 required tools should be installed in order: \r
112 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8\r
113\r
114Java Development Kit:\r
115 \r
116 The Java Environment Variable must be set before attempting to build.\r
6132429e 117 For Sun JDK (see note below*):\r
118 set JAVA_HOME=c:\Java\jdk1.5.0_06 (Windows example)\r
119 export JAVA_HOME=/Library/Java/Home/ (OS X example)\r
120 export JAVA_HOME=/usr/lib/j2sdk1.5-sun/ (Linux example)\r
121 For Bea Systems:\r
782eb168 122 set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04\r
aa0bf4f4 123 \r
124 *When using the Sun JDK5.0\r
125 During installation, you should specify the install directory as C:\Java\r
126 instead of C:\Program Files\(or some other drive letter.) While installing\r
127 to this non-standard location is not required. In use, it seems to work \r
128 more reliably. \r
129 For the JDK, the install path would be C:\Java\jdk1.5.0_06\r
130 For the JRE, the install path would be C:\Java\jre1.5.0_06\r
131 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.\r
01d2ed5e 132\r
aa0bf4f4 133 NOTE: You cannot combine the location for the JDK and the JRE, as the JRE\r
134 install removes most of the binaries and libraries installed by the JDK\r
135 install.\r
136\r
137Java Tools:\r
138 The Apache-ANT requires the ANT_HOME environment variable to be set before\r
139 attempting to build:\r
01d2ed5e 140 i.e. set ANT_HOME=c:\<full path to where ant was installed>\r
6132429e 141 export ANT_HOME=~/ExternalTools/apache-ant (OS X and Linux example)\r
aa0bf4f4 142\r
143 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib \r
144 directory.\r
145\r
146 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
147 before attempting to build:\r
782eb168 148 i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
6132429e 149 export XMLBEANS_HOME=~/ExternalTools/xmlbeans (OS X and Linux example)\r
aa0bf4f4 150\r
151 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.\r
152\r
153 The Ant and XMLBean tools are required to be in the path.\r
154 MS system example:\r
155 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin\r
156 Linux/OS X bash shell example:\r
157 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin\r
dcfa7b15 158\r
159--------------------\r
160A Word on Apache-ANT\r
161--------------------\r
162The Apache-ANT program is a build tool that uses XML-based project files.\r
163Similar to Makefiles, these project files may contain multiple targets. Most\r
164build.xml files in EDK II are auto-generated; any edits performed on the\r
165build.xml files will be overwritten the next time build is executed.\r
166\r
167Pre-defined targets in the build.xml file include:\r
168 all - This target builds binaries for defined architectures\r
169 clean - This target removes object files generated by commands\r
170 cleanall - This target removes all generated files and directories.\r
171\r
172------------------------\r
173A Word on GCC tool chain\r
174------------------------\r
175EDK II will not compile with a standard Linux gcc tool chain. While Linux\r
176distributions are usually based on ELF, EDK II requires a version of gcc \r
177that is configured to produce PE-COFF images. You will find a script in \r
178edk2/Tools/gcc that will download, configure, compile, and install a gcc \r
1794.X cross-compile tool chain for EDK II development. It has support for \r
180the IA32 architecture. It can be built and run on Cygwin, Linux, and many \r
181other POSIX compliant host operating environments. There are a few tools\r
182that you will need on your host computer in order to compile the tool \r
183chain. Among them are bash, gcc, gmake, curl (or wget).\r
184\r
185\r
186-----------------------\r
187Notes On Documentation\r
188-----------------------\r
189The documents are being managed by the Subversion Source Control on\r
190Tianocore.org. The document repository is "docs" and must be checked out\r
191separately from the EDK II source tree. Refer to the checkout procedures on\r
192the Tianocore.org website for EDK II.\r
193\r
194The URL of the document repository is:\r
195 https://edk2.tianocore.org/svn/edk2/trunk/docs\r
196\r
aa0bf4f4 197 \r
198-------------------------------------------------------------------------------\r
dcfa7b15 199Quick Start \r
a032fb4d 200-----------\r
dcfa7b15 201(assumes Microsoft Tools and OS Environment, for GCC Tools or Unix, please see \r
202"Detailed Starting Instructions" below)\r
203\r
204Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
205checkout the entire EDK II source tree.\r
206\r
207In a command window, change to the top level directory of the Edk II sources.\r
208\r
209To test your tool chain setup and to build the Supplied Tools, execute:\r
210 c:\MyWork\edkii\> edksetup ForceBuild\r
211\r
212(The edksetup command will be referred to as the setup command throughout the \r
213rest of this document.)\r
214 NOTE: You should run the setup command at the start of every session.\r
215 This configures the environment to include the TianoTools and the\r
216 Java applications and libraries.\r
217\r
218You will need to set the WORKSPACE environment variable, or run the edksetup\r
219script (without any arguments) any time you want to build.\r
220\r
221 Set the WORKSPACE environment variable, e.g.:\r
222\r
223 c:\> set WORKSPACE=C:\MyWork\edkii\r
224\r
225You may need to edit the text files, Tools/Conf/target.txt and\r
226Tools/Conf/tools_def.txt (created by edksetup,) using your favorite \r
227text editor to ensure that the paths to the tools you want to use \r
228to build EDK II binaries are correct. These files contain the default \r
229paths (as per the default installation of the tools), so a customized \r
230install may require this manual process.\r
231\r
232Once this is completed, you are ready to test the Build, by executing:\r
233 c:\MyWork\edkii\> build\r
234\r
235This command builds active platform specified in text file target.txt. If \r
236active platform is not specified, go to sub-directory which contains FPD files and\r
237type build. More information about active platform policy reference to specification\r
238<<EDK II Build and Packaging Architecture Specification>>.\r
239\r
240-------------------------------------------------------------------------------\r
241Detailed Start Instructions\r
242---------------------------\r
243\r
aa0bf4f4 244Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
13421853 245checkout the entire EDK II source tree.\r
aa0bf4f4 246\r
e3f236c8 247In a command window, change to the top level directory of the Edk II sources.\r
aa0bf4f4 248\r
65a1d8a9 249If the active compiler tool chain is GCC, you must set the\r
250environment variable, TOOL_CHAIN to "gcc" before running the\r
251edksetup script. Example: export TOOL_CHAIN=gcc\r
aa0bf4f4 252\r
253To test your tool chain setup and to build the Supplied Tools, execute:\r
65a1d8a9 254 c:\MyWork\edkii\> edksetup ForceBuild\r
aa0bf4f4 255\r
6132429e 256On Unix systems you must source the edksetup.sh file to load the correct\r
257settings into your shell.\r
258\r
259 . edksetup.sh # Note the dot.\r
260\r
dcfa7b15 261The edksetup command will be referred to as the setup command throughout the \r
262rest of this document.)\r
aa0bf4f4 263 NOTE: You should run the setup command at the start of every session.\r
264 This configures the environment to include the TianoTools and the\r
265 Java applications and libraries.\r
266\r
65a1d8a9 267Any changes to the tool source code or XML Schema documents will require that\r
268you run:\r
269 c:\MyWork\edkii\> edksetup ForceBuild\r
270\r
271You will need to set the WORKSPACE environment variable, or run the edksetup\r
272script (without any arguments) any time you want to build.\r
273\r
274 Set the WORKSPACE environment variable, e.g.:\r
275\r
276 c:\> set WORKSPACE=C:\MyWork\edkii\r
277\r
dcfa7b15 278You may need to edit the text files, Tools/Conf/target.txt and\r
65a1d8a9 279Tools/Conf/tools_def.txt (created by edksetup,) using your favorite \r
dcfa7b15 280text editor to ensure that the paths to the tools you want to use \r
281to build EDK II binaries are correct. These files contain the default \r
282paths (as per the default installation of the tools), so a customized \r
283tool installation may require this manual process.\r
a032fb4d 284\r
aa0bf4f4 285Once this is completed, you are ready to test the Build, by executing:\r
65a1d8a9 286 c:\MyWork\edkii\> build\r
aa0bf4f4 287\r
e3f236c8 288This command builds active platform specified in text file target.txt. If \r
289active platform is not specified, go to sub-directory which contains FPD files and\r
290type build. More information about active platform policy reference to specification\r
291<<EDK II Build and Packaging Architecture Specification>>.\r
90f7b6a8 292\r
aa0bf4f4 293-------------------------\r
e3f236c8 294Individual Platform Builds\r
aa0bf4f4 295-------------------------\r
e3f236c8 296After running the setup command, you can build individual platforms.\r
297 In the command window, \r
298 1. Set active platform in target.txt, and type "build" in whatever directory;\r
299 2. or cd to the platform (FPD file) that you want to build, and just type:\r
65a1d8a9 300 c:\MyWork\edkii\EdkNt32Pkg\> build\r
e3f236c8 301\r
302 Note that active platform with the high priority to build, that means active \r
303 platform will be built even if exists FPD file under current directory. More \r
304 information about active platform policy reference to specification\r
305 <<EDK II Build and Packaging Architecture Specification>>. \r
aa0bf4f4 306\r
a032fb4d 307Go to <full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe\r
e3f236c8 308to run the Nt32 emulation platform under Microsoft Windows.\r
aa0bf4f4 309\r
03fed93e 310To exit the Nt32 emulation platform, you may type reset at the EFI Shell>\r
311command prompt. Alternately, you may use the Graphical interface, Boot\r
312Maintenance Manager screen's Reset System command.\r
313\r
aa0bf4f4 314------------------------\r
315Individual Module Builds\r
316------------------------\r
317After running the setup command, you can build individual modules.\r
318 In the command window, cd to the module that you want to build, and just\r
319 type:\r
65a1d8a9 320 c:\MyWork\edkii\MdePkg\Library\BaseLib\> build\r
e3f236c8 321\r
322 Note active platform must be set for individual module build. \r
aa0bf4f4 323\r
aa0bf4f4 324-------------------------------------------------------------------------------\r
325\r
326General Information:\r
327=============================================================== \r
328Mechanisms:\r
329----------\r
8fb9e6b8 330A brief overview:\r
aa0bf4f4 331\r
332A) Surface Area Package Description (SPD) file contains information about the\r
333modules that the package contains, including the location of all MSA files, and\r
334public library names and headers that might be provided by a module in the\r
335package. Packages are defined by SPD files. (Found in the root of the Package\r
a032fb4d 336subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "EDK Build \r
337and Packaging Architecture Specification" document.\r
aa0bf4f4 338 \r
339B) Module Surface Area Definition (MSA) files. A description of a module's \r
340surface area, with all module specific default flags and features specified.\r
341Refer to the "Module Surface Area Architecture Specification" for additional\r
a032fb4d 342details. The MSA is further explained in the "EDK II Build Packaging Architecture \r
343Specification" document.\r
344\r
345C) Framework Platform Description (FPD) files. A description of a platform's\r
346surface are, including a list of modules that are needed by the platform. To\r
347support individual module builds, developers are not required to provide\r
348information about specific flash devices, nor flash device layout. There are\r
349specific sections in the FPD file that do control aspects of the build, such \r
350as the Supported Architectures and Build Targets, as well as the tool flags \r
351that are used to create the binary files. A valid platform file can specify \r
352zero or more modules, so individual modules can be compiled within the context\r
353of a platform (FPD) definition.\r
354\r
355D) Platform Configuration Database (PCD). A platform database which contains a\r
aa0bf4f4 356variety of current platform settings or directives by which a driver or\r
357application can interact with. The PCD is defined by the PCD_Protocol (This is\r
358further explained in the "Platform Configuration Database Infrastructure \r
359Description" document.\r
360\r
a032fb4d 361E) Library Class. A library class is a logical grouping of similar functions.\r
aa0bf4f4 362When developing components, the module surface area declares the class of\r
a032fb4d 363libraries that can be used by the component. The MSA and SPD files can specify\r
364a recommended instance of the library that a platform integrator may select,\r
365however this is only a recommendation. The PI may choose to select a different\r
366library instance to be used during compilation/linking. All library type modules \r
367must include header files in their distribution package, as well as their MSA\r
368files. Components, on the other hand, need only provide an MSA and either source\r
369or binary files when distributing packages. The Library Classes are further \r
370explained in the "EDK II Build and Packaging Architecture Specification" \r
371document.\r
aa0bf4f4 372\r
373=========================================================================\r
374The common operations by developers of new modules are:\r
375-------------------------------------------------------\r
376\r
3771) How to manually create a new module in a package:\r
378 - The module source code must first be created in an appropriate directory\r
379 (under the package the module is to be a part of.) \r
380 - An MSA file must be created, spelling out all aspects of the module.\r
381 - The MSA must be added to the SPD for the package to include the module.\r
382\r
383-----------------------------------------\r
3842) Add/Remove module(s) to/from a package:\r
385\r
386 - Setup environment as Build\r
387 - Add a module to a package\r
e3f236c8 388 * Generate the module SurfaceArea description file\r
389 * Add a new <Filename> element under <MsaFiles> into\r
aa0bf4f4 390 <PackageDir>\<PackageName>.spd, using relative path to package\r
e3f236c8 391 * Add a new <ModuleSA> entry under each <FrameworkModules> into\r
392 <PackageDir>\<PackageName>.fpd file if necessary. \r
aa0bf4f4 393\r
394 - Remove a module from a package\r
e3f236c8 395 * Comment out or remove corresponding <Filename> element under <MsaFiles>\r
aa0bf4f4 396 from <PackageDir>\<PackageName>.spd\r
397 * Comment out or remove corresponding <ModuleSA> entry under each\r
e3f236c8 398 <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary. \r
aa0bf4f4 399\r
400-----------------------------------\r
4013) How to manually create a package:\r
402 - Identify the modules that are to be members of the project.\r
403 - Identify the Variables and Guids required in and of the Package (including\r
404 consumption/production information).\r
405 - Create an SPD file defining these modules and calling out their MSA files.\r
e3f236c8 406 - add a new <Filename> element under <PackageList> into \r
407 Tools\Conf\FrameworkDatabase.db, using the relative path to workspace. \r
aa0bf4f4 408\r
409--------------------------------------\r
4104) Declare a new Protocol in a package: \r
411 - This release requires manual editing of the SPD file, adding the protocol\r
412 to the ProtocolDeclarations section of the file. \r
413 - Add the Protocol .h file to the Include\Protocol directory.\r
64fcaead 414 - Add an <Entry> to the <ProtocolDeclarations> element in the \r
415 <PackageName>.spd file\r
aa0bf4f4 416 * Each line contains Protocol base name then the global variable name and\r
417 then the hex value of the Protocol GUID.\r
418\r
64fcaead 419Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):\r
420<ProtocolDeclarations>\r
e3f236c8 421 <Entry Name="Bds">\r
422 <C_Name>gEfiBdsArchProtocolGuid</C_Name>\r
423 <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>\r
424 <HelpText/>\r
425 </Entry>\r
426 <Entry Name="Cpu">\r
427 <C_Name>gEfiCpuArchProtocolGuid</C_Name>\r
428 <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>\r
429 <HelpText/>\r
430 </Entry>\r
431</ProtocolDeclarations>\r
aa0bf4f4 432\r
433---------------------------------\r
4345) Declare a new PPI in a package:\r
435 - This release requires manual editing of the SPD file\r
436 - Add the PPI .h file to the Include\Ppi directory.\r
64fcaead 437 - Add an <Entry> to the package <PpiDeclarations> element in the \r
438 <PackageName>.spd file\r
aa0bf4f4 439 * Each line contains PPI base name then the global variable name and then\r
440 the hex value of the PPI GUID.\r
441\r
64fcaead 442Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):\r
443<PpiDeclarations>\r
e3f236c8 444 <Entry Name="BootInRecoveryMode">\r
445 <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>\r
446 <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>\r
447 <HelpText/>\r
64fcaead 448 </Entry>\r
e3f236c8 449 <Entry Name="CpuIo">\r
450 <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>\r
451 <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>\r
452 <HelpText/>\r
64fcaead 453 </Entry>\r
454</PpiDeclarations>\r
455\r
aa0bf4f4 456----------------------------------\r
4576) Declare a new GUID in a package:\r
458 - This release requires manual editing of the SPD file to include the new\r
64fcaead 459 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration\r
460 element as described above.\r
aa0bf4f4 461\r
462--------------------------------------- \r
54c9f9ed 4637) Declare a new PCD entry in a package:\r
aa0bf4f4 464 - This release requires manual editing of the SPD file to include the new\r
64fcaead 465 PCD. New Pcd entries are added to the PcdDefinitions section of the\r
466 <PackageName>.spd file using the following example for the format:\r
467 NOTE: The hex <Token> value must be unique.\r
468\r
54c9f9ed 469<PcdDeclarations>\r
64fcaead 470 <PcdEntry ItemType="FIXED_AT_BUILD">\r
471 <C_Name>PcdMaximumUnicodeStringLength</C_Name>\r
472 <Token>0x00000001</Token>\r
54c9f9ed 473 <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
64fcaead 474 <DatumType>UINT32</DatumType>\r
54c9f9ed 475 <ValidUsage>FIXED_AT_BUILD</ValidUsage>\r
64fcaead 476 <DefaultValue>1000000</DefaultValue>\r
54c9f9ed 477 <HelpText>The maximum lengh for unicode string.</HelpText>\r
64fcaead 478 </PcdEntry>\r
54c9f9ed 479</PcdDeclarations>\r
aa0bf4f4 480 \r
481------------------------------\r
4828) Declare a new Library Class:\r
483 - This release requires manual editing of the SPD file to include the new\r
64fcaead 484 Library Class. New Library Class entries are added to the \r
485 LibraryClassDeclarations seection of the <PackageName>.spd file using\r
486 the following example for the format:\r
487\r
488<LibraryClassDeclarations>\r
e3f236c8 489 <LibraryClass Name="BaseLib">\r
64fcaead 490 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>\r
e3f236c8 491 <HelpText/>\r
492 </LibraryClass>\r
493 <LibraryClass Name="BaseMemoryLib">\r
494 <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>\r
495 <HelpText/>\r
496 </LibraryClass>\r
64fcaead 497</LibraryClassDeclarations>\r
aa0bf4f4 498\r
aa0bf4f4 499=======================================================\r
500Notes:\r
501------\r
13421853 502The EDK II represents significant changes in the structure of the EDK.\r
aa0bf4f4 503Therefore it is very difficult to isolate all of the changes of this version of\r
504the EDK with the previous (EDK 1.0) version.\r
505\r
506Of particular note:\r
507\r
13421853 5081) EDK II contains new hardware feature support for the ICH SMBUS Libraries.\r
aa0bf4f4 509 These libraries are provided to make Memory Reference Code (MRC) development\r
510 easier.\r
1465cc8b 5112) The MDE Libraries - The MDE libraries represent significant changes in source\r
aa0bf4f4 512 (with only limited changes in functionality.) These new libraries conform\r
513 to the "MDE Library Specification". \r
5143) The Fat Binary and the EDK Shell Binary Packages are functionally identical\r
515 to the EDK 1.0 version.\r
5164) The EDK tools directory has been expanded to include more tools and more\r
517 tool functionality.\r
5185) The EDK NT32 section has been ported to the new build process, but\r
519 functionally remains the same as the EDK 1.0 version.\r
13421853 5206) The Application "HelloWorld" has been ported to EDK II as well.\r
aa0bf4f4 521\r
522=======================================================\r
523Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no\r
524virus detected.\r
525\r