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