Updated the SPD and MSA files for Tools - created some new MSA files as well.
[mirror_edk2.git] / ReleaseNotes.txt
1 Intel(R) Platform Innovation Framework for EFI
2 EFI Development Kit 2.0 (EDK 2.0)
3 Alpha Release
4 2006-04-26
6 Copyright (c) 2006, Intel Corporation
8 This document provides updates to documentation, along with a description on
9 how to install and build the Edk 2.0.
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
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 2.0 Packages. It is also recommended that the top level files included
27 with the EDK be downloaded in conjunction with these two packages.
29 Note: Documents have the following filenames:
30 EDK 2.0 Module Development Environment Library Specification v0.50
31 (MDE_Library_Spec_0_50.rtf)
32 EDK 2.0 Build and Packaging Architecture Specification v0.50
33 (Build_Packaging_Spec_0_50.rtf)
34 EDK 2.0 Platform Configuration Database Infrastructure Description v0.51
35 (PCD_Infrastructure_0_51.rtf)
36 EDK 2.0 Module Surface Area v0.50
37 (Module_Surface_Area_0_50.rtf)
38 EDK 2.0 Module Development Environment (MDE) Package Specification v0.50
39 (MDE_Package_Spec_0_50.rtf)
40 EDK 2.0 C Coding Standards Specification v0.50
41 (C_Coding_Standards_Specification_ 0_50.rtf)
43 Pre-Requisites
44 --------------
45 The following list of tools must be installed on the development workstation
46 prior to using the Edk 2.0.
48 Compiler Tool Chain
49 Microsoft* Visual Studio .NET 2003* (http://www.microsoft.com)
50 or
51 A special GCC version 4.x or later (http://gcc.gnu.org). See below.
53 Assembler Tool Chain
54 Microsoft Macro Assembler, version 6.15 or later
55 or
56 GNU binutils 2.16.1 or later
58 Java Development Kit ( Java 5.0 or later)
59 Sun* jdk-1.5.0_04 or later (http://java.sun.com)
60 or
61 Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com)
63 Java Tools
64 Apache-ANT, version 1.6.5 or later (http://ant.apache.org)
65 Ant-contrib, version 1.0b2 or later
66 (http://sourceforge.net/project/showfiles.php?group_id=36177)
67 Saxon8, version 8.1.1
68 (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)
69 XMLBeans, version 2.1.0 or later (http://xmlbeans.apache.org)
71 Other Tools
72 TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)
74 Optional Tools
75 --------------
76 Compiler Tool Chains:
77 Intel C++ Compiler for Windows, ver. 9.0 or later (http://www.intel.com)
78 Intel C Compiler for EFI Byte Code, ver. 1.2 or later
79 (http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm)
80 Microsoft Driver Development Kit, version 3790.1830 or later
81 (http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx)
82 Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later
83 Intel ACPI Component Architecture, version 20060113
85 -----------------------
86 Notes On Required Tools (Source Control System)
87 -----------------------
88 The EDK 2.0 is being managed by the Subversion Source Control on Tianocore.org.
89 This software package provides speed, security, and additional features. The
90 recommended client is TortoiseSVN version 1.3.3.
91 (Available at http://tortoisesvn.tigris.org/)
93 There are instructions for the use of Subversion Source Control on the
94 Tianocore.org website, as part of the checkout procedures.
96 The URL of the EDK 2.0 repository is:
97 https://edk2.tianocore.org/svn/edk2/trunk/edk2
99 -----------------------
100 Notes On Documentation
101 -----------------------
102 The documents are being managed by the Subversion Source Control on
103 Tianocore.org. The document repository is "docs" and must be checked out
104 separately from the EDK 2.0 source tree. Refer to the checkout procedures on
105 the Tianocore.org website for EDK 2.0.
107 The URL of the document repository is:
108 https://edk2.tianocore.org/svn/edk2/trunk/docs
111 -----------------------
112 Notes On Required Tools (MS Windows environment example)
113 -----------------------
114 Software Installation Order:
115 After installing the compiler tools and your Subversion client, the following
116 required tools should be installed in order:
117 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8
119 Java Development Kit:
121 The Java Environment Variable must be set before attempting to build.
122 i.e. For Sun JDK (see note below*):
123 set JAVA_HOME=c:\ Java\jdk1.5.0_06
124 i.e. For Bea Systems:
125 set JAVA_HOME=c:\Program Files\Java\jrockit-R26.0.0-jdk1.5.0_04
127 *When using the Sun JDK5.0
128 During installation, you should specify the install directory as C:\Java
129 instead of C:\Program Files\(or some other drive letter.) While installing
130 to this non-standard location is not required. In use, it seems to work
131 more reliably.
132 For the JDK, the install path would be C:\Java\jdk1.5.0_06
133 For the JRE, the install path would be C:\Java\jre1.5.0_06
134 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.
136 NOTE: You cannot combine the location for the JDK and the JRE, as the JRE
137 install removes most of the binaries and libraries installed by the JDK
138 install.
140 Java Tools:
141 The Apache-ANT requires the ANT_HOME environment variable to be set before
142 attempting to build:
143 i.e. set ANT_HOME=c:\<full path to where ant was installed>
145 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib
146 directory.
148 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set
149 before attempting to build:
150 i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>
152 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.
154 The Ant and XMLBean tools are required to be in the path.
155 MS system example:
156 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin
157 Linux/OS X bash shell example:
158 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin
160 -------------------------------------------------------------------------------
161 Quick Start
162 -----------
163 Edit the text file, msft_tools_def.txt, located in the Tools/Conf directory.
164 This file contains the names of the compiler tool chains and the location of
165 the compiler binaries. It has been pre-populated with the standard location
166 for the Microsoft tool chains and includes the standard location of the Intel C
167 Compiler for EFI Byte Code (EBC)
169 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to
170 checkout the entire EDK 2.0 source tree.
172 In a command window, change to the top level directory of the Edk 2.0 sources.
173 Set the WORKSPACE environment variable, e.g.:
175 c:\> set WORKSPACE=C:\MyWork\Edk2.0
177 To test your tool chain setup and to build the Supplied Tools, execute:
178 c:\MyWork\Edk2.0\> edksetup
180 (This command will be referred to as the setup command throughout the rest of
181 this document.)
182 NOTE: You should run the setup command at the start of every session.
183 This configures the environment to include the TianoTools and the
184 Java applications and libraries.
186 Once this is completed, you are ready to test the Build, by executing:
187 c:\MyWork\Edk2.0\> ant
189 This command builds all of the packages, including the NT32 reference platform.
191 ------------------------------------
192 Build Architectures other than IA32.
193 ------------------------------------
195 By default, we are set up to build the ia32 architecture. If you would like to
196 build for IPF, x64 and EBC, please copy MdePkg/MdePkg-All-Arch.fpd to
197 MdePkg/MdePkg.fpd. For EdkModulePkg, copy EdkModulePkg-All-Archs.fpd to
198 EdkModulePkg.fpd. Note, you may also add only the architecture you want from
199 the -All-Archs files to the main fpd file. This is preferred if you do not have
200 all the compilers installed.
202 Optionally, you may modify the path to the compiler in
203 Tools/Conf/msft_tools_def.txt. The flags for the ARCH tool chain are set in the
204 file names by Tools/Conf/VENDOR_tools.txt, where VENDOR is set in
205 Tools/Conf/msft_tools.txt.
207 For example, if IPF_VENDOR = WINDDK, then the flags for the IPF DDK compiler
208 will be specified in Tools/Conf/winddk_tools.txt.
210 -------------------------
211 Individual Package Builds
212 -------------------------
213 After running the setup command, you can build individual packages.
214 In the command window, cd to the package that you want to build, and just
215 type:
216 c:\MyWork\Edk2.0\EdkNt32Pkg\> ant
218 The EdkNt32Pkg has a special target; "run" that will execute the Nt32 emulation
219 platform under Microsoft Windows.
221 To exit the Nt32 emulation platform, you may type reset at the EFI Shell>
222 command prompt. Alternately, you may use the Graphical interface, Boot
223 Maintenance Manager screen's Reset System command.
225 ------------------------
226 Individual Module Builds
227 ------------------------
228 After running the setup command, you can build individual modules.
229 In the command window, cd to the module that you want to build, and just
230 type:
231 c:\MyWork\Edk2.0\MdePkg\Library\BaseLib\> ant
233 -------------------------------------------------------------------------------
234 A Word on Apache-ANT
235 --------------------
236 The Apache-ANT program is a build tool that uses XML-based project files.
237 Similar to Makefiles, these project files may contain multiple targets. Most
238 build.xml files in Edk2.0 are auto-generated; any edits performed on the
239 build.xml files will be overwritten the next time ant is executed.
241 Pre-defined targets in the build.xml files include:
242 all - This target builds binaries for defined architectures
243 clean - This target removes object files generated by commands
244 cleanall - This target removes all generated files and directories.
246 A Word on GCC tool chain
247 ------------------------
248 EDK2 will not compile with a standard Linux gcc tool chain. While Linux
249 distributions are usually based on ELF, EDK2 requires a version of gcc that is
250 configured to produce PE-COFF images. You will find a script in edk2/Tools/gcc
251 that will download, configure, compile, and install a gcc 4.X cross-compile
252 tool chain for EDK2 development. It has support for the ia32 architecture. It
253 can be built and run on Cygwin, Linux, and many other POSIX compliant host
254 operating environments. There are a few tools that you will need on your host
255 computer in order to compile the tool chain. Among them are bash, gcc, gmake,
256 curl (or wget).
258 -------------------------------------------------------------------------------
260 General Information:
261 ===============================================================
262 Mechanisms:
263 ----------
264 A brief overview:
266 A) Surface Area Package Description (SPD) file contains information about the
267 modules that the package contains, including the location of all MSA files, and
268 public library names and headers that might be provided by a module in the
269 package. Packages are defined by SPD files. (Found in the root of the Package
270 subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "Build
271 Packaging Specification" document.
273 B) Module Surface Area Definition (MSA) files. A description of a module's
274 surface area, with all module specific default flags and features specified.
275 Refer to the "Module Surface Area Architecture Specification" for additional
276 details. The MSA is further explained in the "Build Packaging Specification"
277 document.
279 C) Module Build Description (MDB). The "as-built" definition file that contains
280 only the changes to the default flags defined in the MSA. The MSA and MDB are
281 further explained in the "Build Packaging Specification" document.
283 D) Platform Configuration Database (PCD). A platform database which contains a
284 variety of current platform settings or directives by which a driver or
285 application can interact with. The PCD is defined by the PCD_Protocol (This is
286 further explained in the "Platform Configuration Database Infrastructure
287 Description" document.
289 E) Library Class. A library class is a logical grouping of similar functions.
290 When developing components, the module surface area declares the class of
291 libraries that can be used by the component. The MBD file specifies the
292 instance(s) of the library that will be used during compilation/linking. All
293 library type modules must include header files in their distribution package,
294 as well as their surface area and module build description files. Components,
295 on the other hand, need only provide the binary and build description files
296 when distributing BINARY packages. The Library Classes are further explained
297 in the "Build Packaging Specification" document.
299 =========================================================================
300 The common operations by developers of new modules are:
301 -------------------------------------------------------
303 1) How to manually create a new module in a package:
304 - The module source code must first be created in an appropriate directory
305 (under the package the module is to be a part of.)
306 - An MSA file must be created, spelling out all aspects of the module.
307 - The MSA must be added to the SPD for the package to include the module.
309 -----------------------------------------
310 2) Add/Remove module(s) to/from a package:
312 - Setup environment as Build
313 - Add a module to a package
314 * Generate the module SurfaceArea description file and build description
315 file
316 * Run GenBuildFile.bat under <PackageDir> to generate an entrance
317 build.xml for the module
318 * Add a new <MsaFile> element under <MsaFiles> into
319 <PackageDir>\<PackageName>.spd, using relative path to package
320 * Add a new <ModuleSA> entry under each <TianoImage> into
321 <PackageDir>\<PackageName>.fpd file
323 - Remove a module from a package
324 * Comment out or remove corresponding <MsaFile> element under <MsaFiles>
325 from <PackageDir>\<PackageName>.spd
326 * Comment out or remove corresponding <ModuleSA> entry under each
327 <TianoImage> from <PackageDir>\<PackageName>.fpd
329 -----------------------------------
330 3) How to manually create a package:
331 - Identify the modules that are to be members of the project.
332 - Identify the Variables and Guids required in and of the Package (including
333 consumption/production information).
334 - Create an SPD file defining these modules and calling out their MSA files.
336 --------------------------------------
337 4) Declare a new Protocol in a package:
338 - This release requires manual editing of the SPD file, adding the protocol
339 to the ProtocolDeclarations section of the file.
340 - Add the Protocol .h file to the Include\Protocol directory.
341 - Add an <Entry> to the <ProtocolDeclarations> element in the
342 <PackageName>.spd file
343 * Each line contains Protocol base name then the global variable name and
344 then the hex value of the Protocol GUID.
346 Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):
347 <ProtocolDeclarations>
348 <Entry Name="UnicodeCollation">
349 <C_Name>gEfiUnicodeCollationProtocolGuid</C_Name>
350 <Guid>{ 0x1d85cd7f, 0xf43d, 0x11d2, 0x9a, 0xc, 0x0, 0x90, 0x27,
351 0x3f, 0xc1, 0x4d }</Guid>
352 <Entry Name="UsbHc">
353 <C_Name>gEfiUsbHcProtocolGuid</C_Name>
354 <Guid>{ 0xf5089266, 0x1aa0, 0x4953, 0x97, 0xd8, 0x56, 0x2f, 0x8a,
355 0x73, 0xb5, 0x19 }</Guid>
357 ---------------------------------
358 5) Declare a new PPI in a package:
359 - This release requires manual editing of the SPD file
360 - Add the PPI .h file to the Include\Ppi directory.
361 - Add an <Entry> to the package <PpiDeclarations> element in the
362 <PackageName>.spd file
363 * Each line contains PPI base name then the global variable name and then
364 the hex value of the PPI GUID.
366 Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):
367 <PpiDeclarations>
368 <Entry Name="NtPeiLoadFile">
369 <C_Name>gNtPeiLoadFilePpiGuid</C_Name>
370 <Guid>{ 0xfd0c65eb, 0x405, 0x4cd2, 0x8a, 0xee, 0xf4, 0x0, 0xef, 0x13,
371 0xba, 0xc2 }</Guid>
372 </Entry>
373 <Entry Name="NtThunk">
374 <C_Name>gPeiNtThunkPpiGuid</C_Name>
375 <Guid>{ 0x98c281e5, 0xf906, 0x43dd, 0xa9, 0x2b, 0xb0, 0x3, 0xbf,
376 0x27, 0x65, 0xda }</Guid>
377 </Entry>
378 </PpiDeclarations>
381 ----------------------------------
382 6) Declare a new GUID in a package:
383 - This release requires manual editing of the SPD file to include the new
384 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration
385 element as described above.
387 ---------------------------------------
388 7) Define a new PCD entry in a package:
389 - This release requires manual editing of the SPD file to include the new
390 PCD. New Pcd entries are added to the PcdDefinitions section of the
391 <PackageName>.spd file using the following example for the format:
392 NOTE: The hex <Token> value must be unique.
394 <PcdDefinitions>
395 <PcdEntry ItemType="FIXED_AT_BUILD">
396 <C_Name>PcdMaximumUnicodeStringLength</C_Name>
397 <Token>0x00000001</Token>
398 <DatumType>UINT32</DatumType>
399 <DefaultValue>1000000</DefaultValue>
400 </PcdEntry>
401 </PcdDefinition>
403 ------------------------------
404 8) Declare a new Library Class:
405 - This release requires manual editing of the SPD file to include the new
406 Library Class. New Library Class entries are added to the
407 LibraryClassDeclarations seection of the <PackageName>.spd file using
408 the following example for the format:
410 <LibraryClassDeclarations>
411 <LibraryClassDeclaration>
412 <LibraryClass>BaseLib</LibraryClass>
413 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>
414 </LibraryClassDeclaration>
415 </LibraryClassDeclarations>
417 --------------------------------------
418 9) Add a library instance to a package:
419 - This requires manual MSA and MBD file.
421 -----------------------------
422 10) Add a module to a package:
423 - This requires manual MSA and MBD editing
426 =======================================================
427 Notes:
428 ------
429 The EDK 2.0 represents significant changes in the structure of the EDK.
430 Therefore it is very difficult to isolate all of the changes of this version of
431 the EDK with the previous (EDK 1.0) version.
433 Of particular note:
435 1) EDK 2.0 contains new hardware feature support for the ICH SMBUS Libraries.
436 These libraries are provided to make Memory Reference Code (MRC) development
437 easier.
438 2) The MDE Libraries - The MDE libraries represent significant changes in source
439 (with only limited changes in functionality.) These new libraries conform
440 to the "MDE Library Specification".
441 3) The Fat Binary and the EDK Shell Binary Packages are functionally identical
442 to the EDK 1.0 version.
443 4) The EDK tools directory has been expanded to include more tools and more
444 tool functionality.
445 5) The EDK NT32 section has been ported to the new build process, but
446 functionally remains the same as the EDK 1.0 version.
447 6) The Application "HelloWorld" has been ported to EDK 2.0 as well.
449 =======================================================
450 Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no
451 virus detected.