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