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