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