Fixed the MUST set ACTIVE_PLATFORM to be required IFF the current working directory...
[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-06
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
45 Pre-Requisites
46 --------------
47 The following list of tools must be installed on the development workstation
48 prior to using the Edk II.
49
50 Compiler Tool Chain
51 Microsoft* Visual Studio .NET 2003* (http://www.microsoft.com)
52 or
53 A special GCC version 4.x or later (http://gcc.gnu.org). See below.
54
55 Assembler Tool Chain
56 Microsoft Macro Assembler, version 6.15 or later
57 or
58 GNU binutils 2.16.1 or later
59
60 Java Development Kit ( Java 5.0 or later)
61 Sun* jdk-1.5.0_04 or later (http://java.sun.com)
62 or
63 Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com)
64
65 Java Tools
66 Apache-ANT, version 1.6.5 or later (http://ant.apache.org)
67 Ant-contrib, version 1.0b2 or later
68 (http://sourceforge.net/project/showfiles.php?group_id=36177)
69 Saxon8, version 8.1.1
70 (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)
71 XMLBeans, version 2.1.0 or later (http://xmlbeans.apache.org)
72
73 Other Tools
74 TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)
75
76 Optional Tools
77 --------------
78 Compiler Tool Chains:
79 Intel C++ Compiler for Windows, ver. 9.0 or later (http://www.intel.com)
80 Intel C Compiler for EFI Byte Code, ver. 1.2 or later
81 (http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm)
82 Microsoft Driver Development Kit, version 3790.1830 or later
83 (http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx)
84 Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later
85 Intel ACPI Component Architecture, version 20060113
86
87 -----------------------
88 Notes On Required Tools (Source Control System)
89 -----------------------
90 The EDK II is being managed by the Subversion Source Control on Tianocore.org.
91 This software package provides speed, security, and additional features. The
92 recommended client is TortoiseSVN version 1.3.3.
93 (Available at http://tortoisesvn.tigris.org/)
94
95 There are instructions for the use of Subversion Source Control on the
96 Tianocore.org website, as part of the checkout procedures.
97
98 The URL of the EDK II repository is:
99 https://edk2.tianocore.org/svn/edk2/trunk/edk2
100
101 -----------------------
102 Notes On Documentation
103 -----------------------
104 The documents are being managed by the Subversion Source Control on
105 Tianocore.org. The document repository is "docs" and must be checked out
106 separately from the EDK II source tree. Refer to the checkout procedures on
107 the Tianocore.org website for EDK II.
108
109 The URL of the document repository is:
110 https://edk2.tianocore.org/svn/edk2/trunk/docs
111
112
113 -----------------------
114 Notes On Required Tools (MS Windows environment example)
115 -----------------------
116 Software Installation Order:
117 After installing the compiler tools and your Subversion client, the following
118 required tools should be installed in order:
119 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8
120
121 Java Development Kit:
122
123 The Java Environment Variable must be set before attempting to build.
124 i.e. For Sun JDK (see note below*):
125 set JAVA_HOME=c:\ Java\jdk1.5.0_06
126 i.e. For Bea Systems:
127 set JAVA_HOME=c:\Program Files\Java\jrockit-R26.0.0-jdk1.5.0_04
128
129 *When using the Sun JDK5.0
130 During installation, you should specify the install directory as C:\Java
131 instead of C:\Program Files\(or some other drive letter.) While installing
132 to this non-standard location is not required. In use, it seems to work
133 more reliably.
134 For the JDK, the install path would be C:\Java\jdk1.5.0_06
135 For the JRE, the install path would be C:\Java\jre1.5.0_06
136 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.
137
138 NOTE: You cannot combine the location for the JDK and the JRE, as the JRE
139 install removes most of the binaries and libraries installed by the JDK
140 install.
141
142 Java Tools:
143 The Apache-ANT requires the ANT_HOME environment variable to be set before
144 attempting to build:
145 i.e. set ANT_HOME=c:\<full path to where ant was installed>
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
154 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.
155
156 The Ant and XMLBean tools are required to be in the path.
157 MS system example:
158 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin
159 Linux/OS X bash shell example:
160 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin
161
162 -------------------------------------------------------------------------------
163 Quick Start
164 -----------
165 Copy the target.template file in the Tools/Conf directory to target.txt, which
166 must also be in the Tools/Conf directory.
167
168 Edit the text file, target.txt, located in the Tools/Conf directory. This
169 file contains options for setting the active platform and restricting the build.
170 The restictions are used to limit the build output by specifying build target(s),
171 tagname(s) and architecture(s) to less than the full set of possible options.
172
173 The ACTIVE_PLATFORM must be set unless the current working directory contains one
174 or more FPD files. All other options need not be set, however by unsetting these
175 options (by removing the line from the file, or leaving the Value empty) will
176 result in all available build possibilites when typing build. By default EDK II
177 can build a matrix of binaries, using different target types, tool chain tags and
178 architectures. Options to target.txt file are as follows:
179
180 ACTIVE_PLATFORM = Value REQUIRED
181 Where Value is the WORKSPACE relative path and filename of a Framework Platform
182 Definition (FPD) File. Example:
183
184 ACTIVE_PLATFORM = MdePkg/MdePkg.fpd
185
186 TARGET = Value OPTIONAL
187 Where Value is a list of one or more of the following: DEBUG, RELEASE or a User
188 Defined Target type, such as PERF. Example:
189
190 TARGET = DEBUG RELEASE
191
192 TARGET_ARCH = Value OPTIONAL
193 Where Value is a list of one or more supported Architectures: IA32, X64, IPF or
194 EBC. Example:
195
196 TARGET_ARCH = IA32 X64 EBC
197
198 TOOL_CHAIN_CONF = Value OPTIONAL
199 Where Value is the Filename of an alternate tools_def.txt file created by the
200 user. The alternate tools_def.txt files must be in the Tools/Conf directory.
201 These tool definitions are scoped to the WORKSPACE (location of the EDK
202 installation) and cannot be shared between WORKSPACES. (You can copy the files
203 from one workspace to another.) Example:
204
205 TOOL_CHAIN_CONF = alfred.txt
206
207 TOOL_CHAIN_TAG = Value OPTIONAL
208 Where Value is a list of TagName entries as defined in the tools_def.txt file.
209 The TagName can be used to specify different versions of a compiler, i.e.,
210 gcc 4.0 and gcc 4.1 which will allow you to build binaries with both tool chains
211 during the same build - useful during testing of a new compiler tool chain, or
212 for changing compiler flags to check out performance with a different set of
213 flags than flags used for production. Example:
214
215 TOOL_CHAIN_TAG = GCC40 GCC41
216
217 To clear a restriction, just remove any data after the equal sign. To clear
218 the TARGET_ARCH limitation that was set above, enter:
219
220 TARGET_ARCH =
221
222 -----------
223 Copy the tools_def.template file in Tools/Conf to tools_def.txt in the same
224 directory.
225
226 Edit the tools definition file, tools_def.txt, also located in the Tools/Conf
227 directory. This file contains the names of the compiler tool chains and the
228 location of the compiler binaries. It has been pre-populated with the standard
229 location for the Microsoft tool chains and includes the standard location of
230 the Intel C Compiler for EFI Byte Code (EBC.) In addition, EDK II provides
231 support for Cygwin, Linux and OS X GCC compiler tool chains. A script has been
232 provided in the Tools/gcc directory as well as instructions in obtaining and
233 building a version of GCC that has been tested. The tools_def.txt file has
234 the GCC binary locations that are created using this script.
235
236 Both target.txt and tools_def.txt files are formatted as Property = Value,
237 which must appear on a single line. Spanning a Value entry over multiple
238 lines is not supported at this time. In the target.txt file, the Property is
239 a single, uppercase word with underscore characters. These Property names are
240 fixed by the build system. The tools_def.txt file's Property is an underscore
241 delimited coding, which supports some user defined values. The coding for
242 the Property is: TARGET_TAGNAME_ARCH_COMMAND_ATTR The Value, is either a
243 full path, full path and filename or a reserved word.
244
245 TARGET - DEBUG and RELEASE are predefined, however the user may define one or
246 more of their own TARGET types in this file.
247
248 TAGNAME - HOST, MSFT, GCC, INTC are predefined, however the user may define
249 one or more of their own TAGNAME keywords in this file.
250
251 ARCH - EDK II supports IA32, X64, IPF and EBC at this time.
252
253 COMMAND - Predefined command codes are listed in the tools_def.txt file, however
254 the user can specify additional command codes for their one, non-
255 standard tools.
256
257 ATTR - Predefined Attributes are listed in the tools_def.txt file.
258
259 NOTE: The TAGNAME: HOST is reserved and MUST be defined in order to build the
260 included Tiano tools from their C source files. These tools have been
261 built and tested using both Microsoft and GCC tool chains.
262 NOTE: The "*" symbol may be used as a wildcard character in most of these
263 fields, refer to the tools_def.txt and the "EDK II Build and Packaging
264 Architecture Specification" for more details.
265
266
267 -----------
268 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to
269 checkout the entire EDK II source tree.
270
271 In a command window, change to the top level directory of the Edk II sources.
272 Set the WORKSPACE environment variable, e.g.:
273
274 c:\> set WORKSPACE=C:\MyWork\Edk2
275
276 To test your tool chain setup and to build the Supplied Tools, execute:
277 c:\MyWork\Edk2\> edksetup
278
279 (This command will be referred to as the setup command throughout the rest of
280 this document.)
281 NOTE: You should run the setup command at the start of every session.
282 This configures the environment to include the TianoTools and the
283 Java applications and libraries.
284
285 If you are confident that none of the tool tool sources have changed, and you
286 only want to set up the workspace environment you may execute:
287 c:\MyWork\Edk2\> edksetup skip
288
289 Once this is completed, you are ready to test the Build, by executing:
290 c:\MyWork\Edk2\> 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\Edk2\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\Edk2\MdePkg\Library\BaseLib\> build
325
326 Note active platform must be set for individual module build.
327
328 -------------------------------------------------------------------------------
329 A Word on Apache-ANT
330 --------------------
331 The Apache-ANT program is a build tool that uses XML-based project files.
332 Similar to Makefiles, these project files may contain multiple targets. Most
333 build.xml files in EDK II are auto-generated; any edits performed on the
334 build.xml files will be overwritten the next time build is executed.
335
336 Pre-defined targets in the build.xml file include:
337 all - This target builds binaries for defined architectures
338 clean - This target removes object files generated by commands
339 cleanall - This target removes all generated files and directories.
340
341 A Word on GCC tool chain
342 ------------------------
343 EDK II will not compile with a standard Linux gcc tool chain. While Linux
344 distributions are usually based on ELF, EDK II requires a version of gcc
345 that is configured to produce PE-COFF images. You will find a script in
346 edk2/Tools/gcc that will download, configure, compile, and install a gcc
347 4.X cross-compile tool chain for EDK II development. It has support for
348 the IA32 architecture. It can be built and run on Cygwin, Linux, and many
349 other POSIX compliant host operating environments. There are a few tools
350 that you will need on your host computer in order to compile the tool
351 chain. Among them are bash, gcc, gmake, curl (or wget).
352
353 -------------------------------------------------------------------------------
354
355 General Information:
356 ===============================================================
357 Mechanisms:
358 ----------
359 A brief overview:
360
361 A) Surface Area Package Description (SPD) file contains information about the
362 modules that the package contains, including the location of all MSA files, and
363 public library names and headers that might be provided by a module in the
364 package. Packages are defined by SPD files. (Found in the root of the Package
365 subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "EDK Build
366 and Packaging Architecture Specification" document.
367
368 B) Module Surface Area Definition (MSA) files. A description of a module's
369 surface area, with all module specific default flags and features specified.
370 Refer to the "Module Surface Area Architecture Specification" for additional
371 details. The MSA is further explained in the "EDK II Build Packaging Architecture
372 Specification" document.
373
374 C) Framework Platform Description (FPD) files. A description of a platform's
375 surface are, including a list of modules that are needed by the platform. To
376 support individual module builds, developers are not required to provide
377 information about specific flash devices, nor flash device layout. There are
378 specific sections in the FPD file that do control aspects of the build, such
379 as the Supported Architectures and Build Targets, as well as the tool flags
380 that are used to create the binary files. A valid platform file can specify
381 zero or more modules, so individual modules can be compiled within the context
382 of a platform (FPD) definition.
383
384 D) Platform Configuration Database (PCD). A platform database which contains a
385 variety of current platform settings or directives by which a driver or
386 application can interact with. The PCD is defined by the PCD_Protocol (This is
387 further explained in the "Platform Configuration Database Infrastructure
388 Description" document.
389
390 E) Library Class. A library class is a logical grouping of similar functions.
391 When developing components, the module surface area declares the class of
392 libraries that can be used by the component. The MSA and SPD files can specify
393 a recommended instance of the library that a platform integrator may select,
394 however this is only a recommendation. The PI may choose to select a different
395 library instance to be used during compilation/linking. All library type modules
396 must include header files in their distribution package, as well as their MSA
397 files. Components, on the other hand, need only provide an MSA and either source
398 or binary files when distributing packages. The Library Classes are further
399 explained in the "EDK II Build and Packaging Architecture Specification"
400 document.
401
402 =========================================================================
403 The common operations by developers of new modules are:
404 -------------------------------------------------------
405
406 1) How to manually create 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) Add/Remove module(s) to/from a package:
414
415 - Setup environment as Build
416 - Add a module to a package
417 * Generate the module SurfaceArea description file
418 * Add a new <Filename> element under <MsaFiles> into
419 <PackageDir>\<PackageName>.spd, using relative path to package
420 * Add a new <ModuleSA> entry under each <FrameworkModules> into
421 <PackageDir>\<PackageName>.fpd file if necessary.
422
423 - Remove a module from a package
424 * Comment out or remove corresponding <Filename> element under <MsaFiles>
425 from <PackageDir>\<PackageName>.spd
426 * Comment out or remove corresponding <ModuleSA> entry under each
427 <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary.
428
429 -----------------------------------
430 3) How to manually create 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/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 workspace.
437
438 --------------------------------------
439 4) Declare 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 then the global variable name and
446 then the hex value of the Protocol GUID.
447
448 Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):
449 <ProtocolDeclarations>
450 <Entry Name="Bds">
451 <C_Name>gEfiBdsArchProtocolGuid</C_Name>
452 <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>
453 <HelpText/>
454 </Entry>
455 <Entry Name="Cpu">
456 <C_Name>gEfiCpuArchProtocolGuid</C_Name>
457 <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>
458 <HelpText/>
459 </Entry>
460 </ProtocolDeclarations>
461
462 ---------------------------------
463 5) Declare a new PPI in a package:
464 - This release requires manual editing of the SPD file
465 - Add the PPI .h file to the Include\Ppi directory.
466 - Add an <Entry> to the package <PpiDeclarations> element in the
467 <PackageName>.spd file
468 * Each line contains PPI base name then the global variable name and then
469 the hex value of the PPI GUID.
470
471 Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):
472 <PpiDeclarations>
473 <Entry Name="BootInRecoveryMode">
474 <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>
475 <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>
476 <HelpText/>
477 </Entry>
478 <Entry Name="CpuIo">
479 <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>
480 <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>
481 <HelpText/>
482 </Entry>
483 </PpiDeclarations>
484
485 ----------------------------------
486 6) Declare a new GUID in a package:
487 - This release requires manual editing of the SPD file to include the new
488 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration
489 element as described above.
490
491 ---------------------------------------
492 7) Declare a new PCD entry in a package:
493 - This release requires manual editing of the SPD file to include the new
494 PCD. New Pcd entries are added to the PcdDefinitions section of the
495 <PackageName>.spd file using the following example for the format:
496 NOTE: The hex <Token> value must be unique.
497
498 <PcdDeclarations>
499 <PcdEntry ItemType="FIXED_AT_BUILD">
500 <C_Name>PcdMaximumUnicodeStringLength</C_Name>
501 <Token>0x00000001</Token>
502 <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
503 <DatumType>UINT32</DatumType>
504 <ValidUsage>FIXED_AT_BUILD</ValidUsage>
505 <DefaultValue>1000000</DefaultValue>
506 <HelpText>The maximum lengh for unicode string.</HelpText>
507 </PcdEntry>
508 </PcdDeclarations>
509
510 ------------------------------
511 8) Declare a new Library Class:
512 - This release requires manual editing of the SPD file to include the new
513 Library Class. New Library Class entries are added to the
514 LibraryClassDeclarations seection of the <PackageName>.spd file using
515 the following example for the format:
516
517 <LibraryClassDeclarations>
518 <LibraryClass Name="BaseLib">
519 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>
520 <HelpText/>
521 </LibraryClass>
522 <LibraryClass Name="BaseMemoryLib">
523 <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>
524 <HelpText/>
525 </LibraryClass>
526 </LibraryClassDeclarations>
527
528 =======================================================
529 Notes:
530 ------
531 The EDK II represents significant changes in the structure of the EDK.
532 Therefore it is very difficult to isolate all of the changes of this version of
533 the EDK with the previous (EDK 1.0) version.
534
535 Of particular note:
536
537 1) EDK II contains new hardware feature support for the ICH SMBUS Libraries.
538 These libraries are provided to make Memory Reference Code (MRC) development
539 easier.
540 2) The MDE Libraries - The MDE libraries represent significant changes in source
541 (with only limited changes in functionality.) These new libraries conform
542 to the "MDE Library Specification".
543 3) The Fat Binary and the EDK Shell Binary Packages are functionally identical
544 to the EDK 1.0 version.
545 4) The EDK tools directory has been expanded to include more tools and more
546 tool functionality.
547 5) The EDK NT32 section has been ported to the new build process, but
548 functionally remains the same as the EDK 1.0 version.
549 6) The Application "HelloWorld" has been ported to EDK II as well.
550
551 =======================================================
552 Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no
553 virus detected.
554