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