Adding the ReleaseNotes.txt file.
[mirror_edk2.git] / ReleaseNotes.txt
aa0bf4f4 1Intel(R) Platform Innovation Framework for EFI\r
2EFI Development Kit 2.0 (EDK 2.0) \r
3Alpha Release\r
6Copyright (c) 2006, Intel Corporation\r
8This document provides updates to documentation, along with a description on \r
9how to install and build the Edk 2.0.\r
11Package Contents\r
13 ReleaseNote.txt- These release notes for the package.\r
14 MdePkg - A package containing Industry Standard headers and libraries\r
15 Tools - A package containing Build Specific tools which are designed\r
16 to help the developer create and modify drivers and\r
17 libraries\r
18 EdkModulePkg - A package containing reference drivers\r
19 EdkFatBinPkg - A package containing binary DXE drivers for the Fat 32 file\r
20 system\r
21 EdkShellBinPkg - A package containing binary Shell applications and commands\r
22 EdkNt32Pkg - A package containing the NT32 Emulation platform reference\r
24Note: MDE and MDK that appear in other documentation refer to the MdePkg and\r
25Tools packages. These two packages are the minimum requirement for developing\r
26EDK 2.0 Packages. It is also recommended that the top level files included\r
27with the EDK be downloaded in conjunction with these two packages.\r
29Note: Documents have the following filenames:\r
30 EDK 2.0 Module Development Environment Library Specification v0.50 \r
31 (MDE_Library_Spec_0_50.rtf)\r
32 EDK 2.0 Build and Packaging Architecture Specification v0.50\r
33 (Build_Packaging_Spec_0_50.rtf)\r
34 EDK 2.0 Platform Configuration Database Infrastructure Description v0.51\r
35 (PCD_Infrastructure_0_51.rtf)\r
36 EDK 2.0 Module Surface Area v0.50\r
37 (Module_Surface_Area_0_50.rtf)\r
38 EDK 2.0 Module Development Environment (MDE) Package Specification v0.50\r
39 (MDE_Package_Spec_0_50.rtf)\r
40 EDK 2.0 C Coding Standards Specification v0.50\r
41 (C_Coding_Standards_Specification_ 0_50.rtf)\r
45The following list of tools must be installed on the development workstation\r
46prior to using the Edk 2.0.\r
48Compiler Tool Chain\r
49 Microsoft* Visual Studio .NET 2003* (\r
50 or\r
51 GCC version 4.x or later (\r
53Assembler Tool Chain\r
54 Microsoft Macro Assembler, version 6.15 or later\r
55 or\r
56 GCC version 4.x or later\r
58Java Development Kit ( Java 5.0 or later)\r
59 Sun* jdk-1.5.0_04 or later (\r
60 or\r
61 Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (\r
63Java Tools\r
64 Apache-ANT, version 1.6.5 or later (\r
65 Ant-contrib, version 1.0b2 or later (\r
66 Saxon8, version 8.1.1\r
67 (\r
68 XMLBeans, version 2.1.0 or later ( \r
70Other Tools\r
71 TortoiseSVN version 1.3.3. (\r
73Optional Tools\r
75Compiler Tool Chains:\r
76 Intel C++ Compiler for Windows, ver. 9.0 or later (,com)\r
77 Intel C Compiler for EFI Byte Code, ver. 1.2 or later\r
78 Microsoft Driver Development Kit, version 3790.1830 or later\r
79 Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later\r
80 Intel ACPI Component Architecture, version 20060113\r
83Notes On Required Tools (Source Control System)\r
85The EDK 2.0 is being managed by the Subversion Source Control on\r
86This software package provides speed, security, and additional features. The\r
87recommended client is TortoiseSVN version 1.3.3. \r
88 (Available at\r
90There are instructions for the use of Subversion Source Control on the\r website, as part of the checkout procedures.\r
93The URL of the EDK 2.0 repository is:\r
97Notes On Documentation\r
99The documents are being managed by the Subversion Source Control on\r The document repository is "docs" and must be checked out\r
101separately from the EDK 2.0 source tree. Refer to the checkout procedures on\r
102the website for EDK 2.0.\r
104The URL of the document repository is:\r
109Notes On Required Tools (MS Windows environment example)\r
111Software Installation Order:\r
112 After installing the compiler tools and your Subversion client, the following\r
113 required tools should be installed in order: \r
114 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8\r
116Java Development Kit:\r
117 \r
118 The Java Environment Variable must be set before attempting to build.\r
119 i.e. For Sun JDK (see note below*):\r
120 set JAVA_HOME=c:\ Java\jdk1.5.0_06 \r
121 i.e. For Bea Systems:\r
122 set JAVA_HOME=c:\Program Files\Java\jrockit-R26.0.0-jdk1.5.0_04\r
123 \r
124 *When using the Sun JDK5.0\r
125 During installation, you should specify the install directory as C:\Java\r
126 instead of C:\Program Files\(or some other drive letter.) While installing\r
127 to this non-standard location is not required. In use, it seems to work \r
128 more reliably. \r
129 For the JDK, the install path would be C:\Java\jdk1.5.0_06\r
130 For the JRE, the install path would be C:\Java\jre1.5.0_06\r
131 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.\r
132 NOTE: You cannot combine the location for the JDK and the JRE, as the JRE\r
133 install removes most of the binaries and libraries installed by the JDK\r
134 install.\r
136Java Tools:\r
137 The Apache-ANT requires the ANT_HOME environment variable to be set before\r
138 attempting to build:\r
139 i.e. set ANT_HOME=c:\ant\r
141 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib \r
142 directory.\r
144 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
145 before attempting to build:\r
148 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.\r
150 The Ant and XMLBean tools are required to be in the path.\r
151 MS system example:\r
152 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin\r
153 Linux/OS X bash shell example:\r
154 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin\r
155 \r
157Quick Start\r
159Edit the text file, tools_def.txt, located in the Tools/Conf directory. This\r
160file contains the names of the compiler tool chains and the location of the\r
161compiler binaries. It has been pre-populated with the standard location for\r
162the Microsoft tool chains and includes the standard location of the Intel C \r
163Compiler for EFI Byte Code (EBC)\r
164 \r
165Follow the instructions at to\r
166checkout the entire EDK 2.0 source tree.\r
168In a command window, change to the top level directory of the Edk 2.0 sources.\r
169 Set the WORKSPACE environment variable, e.g.:\r
171 c:\> set WORKSPACE=C:\MyWork\Edk2.0\r
173To test your tool chain setup and to build the Supplied Tools, execute:\r
174 c:\MyWork\Edk2.0\> edksetup\r
176(This command will be referred to as the setup command throughout the rest of\r
177this document.)\r
178 NOTE: You should run the setup command at the start of every session.\r
179 This configures the environment to include the TianoTools and the\r
180 Java applications and libraries.\r
182Once this is completed, you are ready to test the Build, by executing:\r
183 c:\MyWork\Edk2.0\> ant\r
185This command builds all of the packages, including the NT32 reference platform.\r
188Individual Package Builds\r
190After running the setup command, you can build individual packages.\r
191 In the command window, cd to the package that you want to build, and just\r
192 type:\r
193 c:\MyWork\Edk2.0\EdkNt32Pkg\> ant\r
195The EdkNt32Pkg has a special target; "run" that will execute the Nt32 emulation\r
196platform under Microsoft Windows.\r
199Individual Module Builds\r
201After running the setup command, you can build individual modules.\r
202 In the command window, cd to the module that you want to build, and just\r
203 type:\r
204 c:\MyWork\Edk2.0\MdePkg\Library\BaseLib\> ant\r
207A Word on Apache-ANT\r
209The Apache-ANT program is a build tool that uses XML-based project files.\r
210Similar to Makefiles, these project files may contain multiple targets. Most\r
211build.xml files in Edk2.0 are auto-generated; any edits performed on the\r
212build.xml files will be overwritten the next time ant is executed.\r
214Pre-defined targets in the build.xml files include:\r
215 all - This target builds binaries for defined architectures\r
216 clean - This target removes object files generated by commands\r
217 cleanall - This target removes all generated files and directories.\r
219A Word on GCC tool chain\r
221You will find a script in the tree that will download, configure, compile, and\r
222install a gcc 4.0.2 tool chain for development. It has support for the ia32\r
223architecture. It can be built and run on Cygwin, Linux, and many other POSIX\r
224compliant host environments. There are a few tools that you will need on your\r
225host computer in order to compile the tool chain. Among them are bash, gcc,\r
226gmake, curl (or wget).\r
230General Information:\r
231=============================================================== \r
234A quick understanding:\r
236A) Surface Area Package Description (SPD) file contains information about the\r
237modules that the package contains, including the location of all MSA files, and\r
238public library names and headers that might be provided by a module in the\r
239package. Packages are defined by SPD files. (Found in the root of the Package\r
240subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "Build \r
241Packaging Specification" document.\r
242 \r
243B) Module Surface Area Definition (MSA) files. A description of a module's \r
244surface area, with all module specific default flags and features specified.\r
245Refer to the "Module Surface Area Architecture Specification" for additional\r
246details. The MSA is further explained in the "Build Packaging Specification"\r
248 \r
249C) Module Build Description (MDB). The "as-built" definition file that contains\r
250only the changes to the default flags defined in the MSA. The MSA and MDB are\r
251further explained in the "Build Packaging Specification" document.\r
253D) Platform Configuration Database (PCD). A platform database which contains a\r
254variety of current platform settings or directives by which a driver or\r
255application can interact with. The PCD is defined by the PCD_Protocol (This is\r
256further explained in the "Platform Configuration Database Infrastructure \r
257Description" document.\r
259E) Library Class. A library class is a logical grouping of similar functions.\r
260When developing components, the module surface area declares the class of\r
261libraries that can be used by the component. The MBD file specifies the\r
262instance(s) of the library that will be used during compilation/linking. All\r
263library type modules must include header files in their distribution package,\r
264as well as their surface area and module build description files. Components,\r
265on the other hand, need only provide the binary and build description files\r
266when distributing BINARY packages. The Library Classes are further explained\r
267in the "Build Packaging Specification" document.\r
270The common operations by developers of new modules are:\r
2731) How to manually create a new module in a package:\r
274 - The module source code must first be created in an appropriate directory\r
275 (under the package the module is to be a part of.) \r
276 - An MSA file must be created, spelling out all aspects of the module.\r
277 - The MSA must be added to the SPD for the package to include the module.\r
2802) Add/Remove module(s) to/from a package:\r
282 - Setup environment as Build\r
283 - Add a module to a package\r
284 * Generate the module SurfaceArea description file and build description\r
285 file\r
286 * Run GenBuildFile.bat under <PackageDir> to generate an entrance\r
287 build.xml for the module\r
288 * Add a new <MsaFile> element under <MsaFiles> into\r
289 <PackageDir>\<PackageName>.spd, using relative path to package\r
290 * Add a new <ModuleSA> entry under each <TianoImage> into\r
291 <PackageDir>\<PackageName>.fpd file\r
293 - Remove a module from a package\r
294 * Comment out or remove corresponding <MsaFile> element under <MsaFiles>\r
295 from <PackageDir>\<PackageName>.spd\r
296 * Comment out or remove corresponding <ModuleSA> entry under each\r
297 <TianoImage> from <PackageDir>\<PackageName>.fpd\r
3003) How to manually create a package:\r
301 - Identify the modules that are to be members of the project.\r
302 - Identify the Variables and Guids required in and of the Package (including\r
303 consumption/production information).\r
304 - Create an SPD file defining these modules and calling out their MSA files.\r
3074) Declare a new Protocol in a package: \r
308 - This release requires manual editing of the SPD file, adding the protocol\r
309 to the ProtocolDeclarations section of the file. \r
310 - Add the Protocol .h file to the Include\Protocol directory.\r
311 - Add an entry to the file\r
312 * Each line contains Protocol base name then the global variable name and\r
313 then the hex value of the Protocol GUID.\r
315Example file (2 lines):\r
316UnicodeCollation gEfiUnicodeCollationProtocolGuid\r
317 { 0x1d85cd7f, 0xf43d, 0x11d2, 0x9a, 0xc, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \r
318UsbHc gEfiUsbHcProtocolGuid\r
319 { 0xf5089266, 0x1aa0, 0x4953, 0x97, 0xd8, 0x56, 0x2f, 0x8a, 0x73, 0xb5, 0x19 }\r
3225) Declare a new PPI in a package:\r
323 - This release requires manual editing of the SPD file\r
324 - Add the PPI .h file to the Include\Ppi directory.\r
325 - Add an entry to the file\r
326 * Each line contains PPI base name then the global variable name and then\r
327 the hex value of the PPI GUID.\r
329Example file (2 lines):\r
330NtPeiLoadFile gNtPeiLoadFilePpiGuid\r
331 { 0xfd0c65eb, 0x405, 0x4cd2, 0x8a, 0xee, 0xf4, 0x0, 0xef, 0x13, 0xba, 0xc2 }\r
332NtThunk gPeiNtThunkPpiGuid\r
333 { 0x98c281e5, 0xf906, 0x43dd, 0xa9, 0x2b, 0xb0, 0x3, 0xbf, 0x27, 0x65, 0xda }\r
3366) Declare a new GUID in a package:\r
337 - This release requires manual editing of the SPD file to include the new\r
338 Guid.\r
340--------------------------------------- \r
3417) Declare a new PCD entry in a package:\r
342 - This release requires manual editing of the SPD file to include the new\r
343 PCD.\r
344 \r
3468) Declare a new Library Class:\r
347 - This release requires manual editing of the SPD file to include the new\r
348 Library Class.\r
3519) Add a library instance to a package:\r
352 - This requires manual MSA and MBD file.\r
35510) Add a module to a package:\r
356 - This requires manual MSA and MBD editing\r
362The EDK 2.0 represents significant changes in the structure of the EDK.\r
363Therefore it is very difficult to isolate all of the changes of this version of\r
364the EDK with the previous (EDK 1.0) version.\r
366Of particular note:\r
3681) EDK 2.0 contains new hardware feature support for the ICH SMBUS Libraries.\r
369 These libraries are provided to make Memory Reference Code (MRC) development\r
370 easier.\r
3712) The MDE Libraries - The MDE libraries resent significant changes in source\r
372 (with only limited changes in functionality.) These new libraries conform\r
373 to the "MDE Library Specification". \r
3743) The Fat Binary and the EDK Shell Binary Packages are functionally identical\r
375 to the EDK 1.0 version.\r
3764) The EDK tools directory has been expanded to include more tools and more\r
377 tool functionality.\r
3785) The EDK NT32 section has been ported to the new build process, but\r
379 functionally remains the same as the EDK 1.0 version.\r
3806) The Application "HelloWorld" has been ported to EDK 2.0 as well.\r
383Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no\r
384virus detected.\r