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