Modified the quick start section. Change all EDK 2.0 to EDK II. Update Individual...
[mirror_edk2.git] / ReleaseNotes.txt
1 Intel(R) Platform Innovation Framework for EFI
2 EFI Development Kit 2.0 (EDK II)
3 Alpha Release
4 2006-04-26
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 Note: Documents have the following filenames:
30 EDK II Module Development Environment Library Specification v0.50
31 (MDE_Library_Spec_0_50.rtf)
32 EDK II Build and Packaging Architecture Specification v0.50
33 (Build_Packaging_Spec_0_50.rtf)
34 EDK II Platform Configuration Database Infrastructure Description v0.51
35 (PCD_Infrastructure_0_51.rtf)
36 EDK II Module Surface Area v0.50
37 (Module_Surface_Area_0_50.rtf)
38 EDK II Module Development Environment (MDE) Package Specification v0.50
39 (MDE_Package_Spec_0_50.rtf)
40 EDK II C Coding Standards Specification v0.50
41 (C_Coding_Standards_Specification_ 0_50.rtf)
42
43 Pre-Requisites
44 --------------
45 The following list of tools must be installed on the development workstation
46 prior to using the Edk II.
47
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.
52
53 Assembler Tool Chain
54 Microsoft Macro Assembler, version 6.15 or later
55 or
56 GNU binutils 2.16.1 or later
57
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)
62
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)
70
71 Other Tools
72 TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)
73
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
84
85 -----------------------
86 Notes On Required Tools (Source Control System)
87 -----------------------
88 The EDK II 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/)
92
93 There are instructions for the use of Subversion Source Control on the
94 Tianocore.org website, as part of the checkout procedures.
95
96 The URL of the EDK II repository is:
97 https://edk2.tianocore.org/svn/edk2/trunk/edk2
98
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 II source tree. Refer to the checkout procedures on
105 the Tianocore.org website for EDK II.
106
107 The URL of the document repository is:
108 https://edk2.tianocore.org/svn/edk2/trunk/docs
109
110
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
118
119 Java Development Kit:
120
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
126
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.
135
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.
139
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>
144
145 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib
146 directory.
147
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>
151
152 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.
153
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
159
160 -------------------------------------------------------------------------------
161 Quick Start
162 -----------
163 Edit the text file, target.txt, located in the Tools/Conf directory. This
164 file contains the tools defintion file and ative platform. It can also restrict
165 current build target(s), tagname(s) and arch(s). Uncomment the line ACTIVE_PLATFORM
166 which is commented out by default.
167
168 Edit the tools definition file, tools_def.txt, also located in the Tools/Conf
169 directory. This file contains the names of the compiler tool chains and the
170 location of the compiler binaries. It has been pre-populated with the standard
171 location for the Microsoft tool chains and includes the standard location of
172 the Intel C Compiler for EFI Byte Code (EBC)
173
174 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to
175 checkout the entire EDK II source tree.
176
177 In a command window, change to the top level directory of the Edk II sources.
178 Set the WORKSPACE environment variable, e.g.:
179
180 c:\> set WORKSPACE=C:\MyWork\Edk2.0
181
182 To test your tool chain setup and to build the Supplied Tools, execute:
183 c:\MyWork\Edk2.0\> edksetup
184
185 (This command will be referred to as the setup command throughout the rest of
186 this document.)
187 NOTE: You should run the setup command at the start of every session.
188 This configures the environment to include the TianoTools and the
189 Java applications and libraries.
190
191 Once this is completed, you are ready to test the Build, by executing:
192 c:\MyWork\Edk2.0\> build
193
194 This command builds active platform specified in text file target.txt. If
195 active platform is not specified, go to sub-directory which contains FPD files and
196 type build. More information about active platform policy reference to specification
197 <<EDK II Build and Packaging Architecture Specification>>.
198
199 -------------------------
200 Individual Platform Builds
201 -------------------------
202 After running the setup command, you can build individual platforms.
203 In the command window,
204 1. Set active platform in target.txt, and type "build" in whatever directory;
205 2. or cd to the platform (FPD file) that you want to build, and just type:
206 c:\MyWork\Edk2.0\EdkNt32Pkg\> build
207
208 Note that active platform with the high priority to build, that means active
209 platform will be built even if exists FPD file under current directory. More
210 information about active platform policy reference to specification
211 <<EDK II Build and Packaging Architecture Specification>>.
212
213 Go to <full build path>\Debug\MSFT\IA32 and execute SecMain.exe
214 to run the Nt32 emulation platform under Microsoft Windows.
215
216 To exit the Nt32 emulation platform, you may type reset at the EFI Shell>
217 command prompt. Alternately, you may use the Graphical interface, Boot
218 Maintenance Manager screen's Reset System command.
219
220 ------------------------
221 Individual Module Builds
222 ------------------------
223 After running the setup command, you can build individual modules.
224 In the command window, cd to the module that you want to build, and just
225 type:
226 c:\MyWork\Edk2.0\MdePkg\Library\BaseLib\> build
227
228 Note active platform must be set for individual module build.
229
230 -------------------------------------------------------------------------------
231 A Word on Apache-ANT
232 --------------------
233 The Apache-ANT program is a build tool that uses XML-based project files.
234 Similar to Makefiles, these project files may contain multiple targets. Most
235 build.xml files in Edk2.0 are auto-generated; any edits performed on the
236 build.xml files will be overwritten the next time ant is executed.
237
238 Pre-defined targets in the build.xml files include:
239 all - This target builds binaries for defined architectures
240 clean - This target removes object files generated by commands
241 cleanall - This target removes all generated files and directories.
242
243 A Word on GCC tool chain
244 ------------------------
245 EDK2 will not compile with a standard Linux gcc tool chain. While Linux
246 distributions are usually based on ELF, EDK2 requires a version of gcc that is
247 configured to produce PE-COFF images. You will find a script in edk2/Tools/gcc
248 that will download, configure, compile, and install a gcc 4.X cross-compile
249 tool chain for EDK2 development. It has support for the ia32 architecture. It
250 can be built and run on Cygwin, Linux, and many other POSIX compliant host
251 operating environments. There are a few tools that you will need on your host
252 computer in order to compile the tool chain. Among them are bash, gcc, gmake,
253 curl (or wget).
254
255 -------------------------------------------------------------------------------
256
257 General Information:
258 ===============================================================
259 Mechanisms:
260 ----------
261 A brief overview:
262
263 A) Surface Area Package Description (SPD) file contains information about the
264 modules that the package contains, including the location of all MSA files, and
265 public library names and headers that might be provided by a module in the
266 package. Packages are defined by SPD files. (Found in the root of the Package
267 subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "Build
268 Packaging Specification" document.
269
270 B) Module Surface Area Definition (MSA) files. A description of a module's
271 surface area, with all module specific default flags and features specified.
272 Refer to the "Module Surface Area Architecture Specification" for additional
273 details. The MSA is further explained in the "Build Packaging Specification"
274 document.
275
276 C) Module Build Description (MDB). The "as-built" definition file that contains
277 only the changes to the default flags defined in the MSA. The MSA and MDB are
278 further explained in the "Build Packaging Specification" document.
279
280 D) Platform Configuration Database (PCD). A platform database which contains a
281 variety of current platform settings or directives by which a driver or
282 application can interact with. The PCD is defined by the PCD_Protocol (This is
283 further explained in the "Platform Configuration Database Infrastructure
284 Description" document.
285
286 E) Library Class. A library class is a logical grouping of similar functions.
287 When developing components, the module surface area declares the class of
288 libraries that can be used by the component. The MBD file specifies the
289 instance(s) of the library that will be used during compilation/linking. All
290 library type modules must include header files in their distribution package,
291 as well as their surface area and module build description files. Components,
292 on the other hand, need only provide the binary and build description files
293 when distributing BINARY packages. The Library Classes are further explained
294 in the "Build Packaging Specification" document.
295
296 =========================================================================
297 The common operations by developers of new modules are:
298 -------------------------------------------------------
299
300 1) How to manually create a new module in a package:
301 - The module source code must first be created in an appropriate directory
302 (under the package the module is to be a part of.)
303 - An MSA file must be created, spelling out all aspects of the module.
304 - The MSA must be added to the SPD for the package to include the module.
305
306 -----------------------------------------
307 2) Add/Remove module(s) to/from a package:
308
309 - Setup environment as Build
310 - Add a module to a package
311 * Generate the module SurfaceArea description file
312 * Add a new <Filename> element under <MsaFiles> into
313 <PackageDir>\<PackageName>.spd, using relative path to package
314 * Add a new <ModuleSA> entry under each <FrameworkModules> into
315 <PackageDir>\<PackageName>.fpd file if necessary.
316
317 - Remove a module from a package
318 * Comment out or remove corresponding <Filename> element under <MsaFiles>
319 from <PackageDir>\<PackageName>.spd
320 * Comment out or remove corresponding <ModuleSA> entry under each
321 <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary.
322
323 -----------------------------------
324 3) How to manually create a package:
325 - Identify the modules that are to be members of the project.
326 - Identify the Variables and Guids required in and of the Package (including
327 consumption/production information).
328 - Create an SPD file defining these modules and calling out their MSA files.
329 - add a new <Filename> element under <PackageList> into
330 Tools\Conf\FrameworkDatabase.db, using the relative path to workspace.
331
332 --------------------------------------
333 4) Declare a new Protocol in a package:
334 - This release requires manual editing of the SPD file, adding the protocol
335 to the ProtocolDeclarations section of the file.
336 - Add the Protocol .h file to the Include\Protocol directory.
337 - Add an <Entry> to the <ProtocolDeclarations> element in the
338 <PackageName>.spd file
339 * Each line contains Protocol base name then the global variable name and
340 then the hex value of the Protocol GUID.
341
342 Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):
343 <ProtocolDeclarations>
344 <Entry Name="Bds">
345 <C_Name>gEfiBdsArchProtocolGuid</C_Name>
346 <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>
347 <HelpText/>
348 </Entry>
349 <Entry Name="Cpu">
350 <C_Name>gEfiCpuArchProtocolGuid</C_Name>
351 <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>
352 <HelpText/>
353 </Entry>
354 </ProtocolDeclarations>
355
356 ---------------------------------
357 5) Declare a new PPI in a package:
358 - This release requires manual editing of the SPD file
359 - Add the PPI .h file to the Include\Ppi directory.
360 - Add an <Entry> to the package <PpiDeclarations> element in the
361 <PackageName>.spd file
362 * Each line contains PPI base name then the global variable name and then
363 the hex value of the PPI GUID.
364
365 Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):
366 <PpiDeclarations>
367 <Entry Name="BootInRecoveryMode">
368 <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>
369 <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>
370 <HelpText/>
371 </Entry>
372 <Entry Name="CpuIo">
373 <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>
374 <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>
375 <HelpText/>
376 </Entry>
377 </PpiDeclarations>
378
379 ----------------------------------
380 6) Declare a new GUID in a package:
381 - This release requires manual editing of the SPD file to include the new
382 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration
383 element as described above.
384
385 ---------------------------------------
386 7) Define a new PCD entry in a package:
387 - This release requires manual editing of the SPD file to include the new
388 PCD. New Pcd entries are added to the PcdDefinitions section of the
389 <PackageName>.spd file using the following example for the format:
390 NOTE: The hex <Token> value must be unique.
391
392 <PcdDefinitions>
393 <PcdEntry ItemType="FIXED_AT_BUILD">
394 <C_Name>PcdMaximumUnicodeStringLength</C_Name>
395 <Token>0x00000001</Token>
396 <DatumType>UINT32</DatumType>
397 <DefaultValue>1000000</DefaultValue>
398 </PcdEntry>
399 </PcdDefinition>
400
401 ------------------------------
402 8) Declare a new Library Class:
403 - This release requires manual editing of the SPD file to include the new
404 Library Class. New Library Class entries are added to the
405 LibraryClassDeclarations seection of the <PackageName>.spd file using
406 the following example for the format:
407
408 <LibraryClassDeclarations>
409 <LibraryClass Name="BaseLib">
410 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>
411 <HelpText/>
412 </LibraryClass>
413 <LibraryClass Name="BaseMemoryLib">
414 <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>
415 <HelpText/>
416 </LibraryClass>
417 </LibraryClassDeclarations>
418
419 =======================================================
420 Notes:
421 ------
422 The EDK II represents significant changes in the structure of the EDK.
423 Therefore it is very difficult to isolate all of the changes of this version of
424 the EDK with the previous (EDK 1.0) version.
425
426 Of particular note:
427
428 1) EDK II contains new hardware feature support for the ICH SMBUS Libraries.
429 These libraries are provided to make Memory Reference Code (MRC) development
430 easier.
431 2) The MDE Libraries - The MDE libraries represent significant changes in source
432 (with only limited changes in functionality.) These new libraries conform
433 to the "MDE Library Specification".
434 3) The Fat Binary and the EDK Shell Binary Packages are functionally identical
435 to the EDK 1.0 version.
436 4) The EDK tools directory has been expanded to include more tools and more
437 tool functionality.
438 5) The EDK NT32 section has been ported to the new build process, but
439 functionally remains the same as the EDK 1.0 version.
440 6) The Application "HelloWorld" has been ported to EDK II as well.
441
442 =======================================================
443 Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no
444 virus detected.
445