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