Remove the workspace reference.
[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
50518883 65 Ant-contrib, version 1.0b2 or later\r
66 (\r
aa0bf4f4 67 Saxon8, version 8.1.1\r
68 (\r
69 XMLBeans, version 2.1.0 or later ( \r
71Other Tools\r
72 TortoiseSVN version 1.3.3. (\r
74Optional Tools\r
76Compiler Tool Chains:\r
50518883 77 Intel C++ Compiler for Windows, ver. 9.0 or later (\r
aa0bf4f4 78 Intel C Compiler for EFI Byte Code, ver. 1.2 or later\r
79 Microsoft Driver Development Kit, version 3790.1830 or later\r
80 Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later\r
81 Intel ACPI Component Architecture, version 20060113\r
84Notes On Required Tools (Source Control System)\r
86The EDK 2.0 is being managed by the Subversion Source Control on\r
87This software package provides speed, security, and additional features. The\r
88recommended client is TortoiseSVN version 1.3.3. \r
89 (Available at\r
91There are instructions for the use of Subversion Source Control on the\r website, as part of the checkout procedures.\r
94The URL of the EDK 2.0 repository is:\r
98Notes On Documentation\r
100The documents are being managed by the Subversion Source Control on\r The document repository is "docs" and must be checked out\r
102separately from the EDK 2.0 source tree. Refer to the checkout procedures on\r
103the website for EDK 2.0.\r
105The URL of the document repository is:\r
110Notes On Required Tools (MS Windows environment example)\r
112Software Installation Order:\r
113 After installing the compiler tools and your Subversion client, the following\r
114 required tools should be installed in order: \r
115 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8\r
117Java Development Kit:\r
118 \r
119 The Java Environment Variable must be set before attempting to build.\r
120 i.e. For Sun JDK (see note below*):\r
121 set JAVA_HOME=c:\ Java\jdk1.5.0_06 \r
122 i.e. For Bea Systems:\r
123 set JAVA_HOME=c:\Program Files\Java\jrockit-R26.0.0-jdk1.5.0_04\r
124 \r
125 *When using the Sun JDK5.0\r
126 During installation, you should specify the install directory as C:\Java\r
127 instead of C:\Program Files\(or some other drive letter.) While installing\r
128 to this non-standard location is not required. In use, it seems to work \r
129 more reliably. \r
130 For the JDK, the install path would be C:\Java\jdk1.5.0_06\r
131 For the JRE, the install path would be C:\Java\jre1.5.0_06\r
132 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.\r
01d2ed5e 133\r
aa0bf4f4 134 NOTE: You cannot combine the location for the JDK and the JRE, as the JRE\r
135 install removes most of the binaries and libraries installed by the JDK\r
136 install.\r
138Java Tools:\r
139 The Apache-ANT requires the ANT_HOME environment variable to be set before\r
140 attempting to build:\r
01d2ed5e 141 i.e. set ANT_HOME=c:\<full path to where ant was installed>\r
aa0bf4f4 142\r
143 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib \r
144 directory.\r
146 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
147 before attempting to build:\r
01d2ed5e 148 i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
aa0bf4f4 149\r
150 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.\r
152 The Ant and XMLBean tools are required to be in the path.\r
153 MS system example:\r
154 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin\r
155 Linux/OS X bash shell example:\r
156 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin\r
157 \r
159Quick Start\r
54a1ec66 161Edit the text file, msft_tools_def.txt, located in the Tools/Conf directory.\r
162This file contains the names of the compiler tool chains and the location of\r
163the compiler binaries. It has been pre-populated with the standard location\r
164for the Microsoft tool chains and includes the standard location of the Intel C\r
aa0bf4f4 165Compiler for EFI Byte Code (EBC)\r
166 \r
167Follow the instructions at to\r
168checkout the entire EDK 2.0 source tree.\r
170In a command window, change to the top level directory of the Edk 2.0 sources.\r
171 Set the WORKSPACE environment variable, e.g.:\r
173 c:\> set WORKSPACE=C:\MyWork\Edk2.0\r
175To test your tool chain setup and to build the Supplied Tools, execute:\r
176 c:\MyWork\Edk2.0\> edksetup\r
178(This command will be referred to as the setup command throughout the rest of\r
179this document.)\r
180 NOTE: You should run the setup command at the start of every session.\r
181 This configures the environment to include the TianoTools and the\r
182 Java applications and libraries.\r
184Once this is completed, you are ready to test the Build, by executing:\r
185 c:\MyWork\Edk2.0\> ant\r
187This command builds all of the packages, including the NT32 reference platform.\r
190Individual Package Builds\r
192After running the setup command, you can build individual packages.\r
193 In the command window, cd to the package that you want to build, and just\r
194 type:\r
195 c:\MyWork\Edk2.0\EdkNt32Pkg\> ant\r
197The EdkNt32Pkg has a special target; "run" that will execute the Nt32 emulation\r
198platform under Microsoft Windows.\r
201Individual Module Builds\r
203After running the setup command, you can build individual modules.\r
204 In the command window, cd to the module that you want to build, and just\r
205 type:\r
206 c:\MyWork\Edk2.0\MdePkg\Library\BaseLib\> ant\r
209A Word on Apache-ANT\r
211The Apache-ANT program is a build tool that uses XML-based project files.\r
212Similar to Makefiles, these project files may contain multiple targets. Most\r
213build.xml files in Edk2.0 are auto-generated; any edits performed on the\r
214build.xml files will be overwritten the next time ant is executed.\r
216Pre-defined targets in the build.xml files include:\r
217 all - This target builds binaries for defined architectures\r
218 clean - This target removes object files generated by commands\r
219 cleanall - This target removes all generated files and directories.\r
221A Word on GCC tool chain\r
223You will find a script in the tree that will download, configure, compile, and\r
224install a gcc 4.0.2 tool chain for development. It has support for the ia32\r
225architecture. It can be built and run on Cygwin, Linux, and many other POSIX\r
226compliant host environments. There are a few tools that you will need on your\r
227host computer in order to compile the tool chain. Among them are bash, gcc,\r
228gmake, curl (or wget).\r
232General Information:\r
233=============================================================== \r
236A quick understanding:\r
238A) Surface Area Package Description (SPD) file contains information about the\r
239modules that the package contains, including the location of all MSA files, and\r
240public library names and headers that might be provided by a module in the\r
241package. Packages are defined by SPD files. (Found in the root of the Package\r
242subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "Build \r
243Packaging Specification" document.\r
244 \r
245B) Module Surface Area Definition (MSA) files. A description of a module's \r
246surface area, with all module specific default flags and features specified.\r
247Refer to the "Module Surface Area Architecture Specification" for additional\r
248details. The MSA is further explained in the "Build Packaging Specification"\r
250 \r
251C) Module Build Description (MDB). The "as-built" definition file that contains\r
252only the changes to the default flags defined in the MSA. The MSA and MDB are\r
253further explained in the "Build Packaging Specification" document.\r
255D) Platform Configuration Database (PCD). A platform database which contains a\r
256variety of current platform settings or directives by which a driver or\r
257application can interact with. The PCD is defined by the PCD_Protocol (This is\r
258further explained in the "Platform Configuration Database Infrastructure \r
259Description" document.\r
261E) Library Class. A library class is a logical grouping of similar functions.\r
262When developing components, the module surface area declares the class of\r
263libraries that can be used by the component. The MBD file specifies the\r
264instance(s) of the library that will be used during compilation/linking. All\r
265library type modules must include header files in their distribution package,\r
266as well as their surface area and module build description files. Components,\r
267on the other hand, need only provide the binary and build description files\r
268when distributing BINARY packages. The Library Classes are further explained\r
269in the "Build Packaging Specification" document.\r
272The common operations by developers of new modules are:\r
2751) How to manually create a new module in a package:\r
276 - The module source code must first be created in an appropriate directory\r
277 (under the package the module is to be a part of.) \r
278 - An MSA file must be created, spelling out all aspects of the module.\r
279 - The MSA must be added to the SPD for the package to include the module.\r
2822) Add/Remove module(s) to/from a package:\r
284 - Setup environment as Build\r
285 - Add a module to a package\r
286 * Generate the module SurfaceArea description file and build description\r
287 file\r
288 * Run GenBuildFile.bat under <PackageDir> to generate an entrance\r
289 build.xml for the module\r
290 * Add a new <MsaFile> element under <MsaFiles> into\r
291 <PackageDir>\<PackageName>.spd, using relative path to package\r
292 * Add a new <ModuleSA> entry under each <TianoImage> into\r
293 <PackageDir>\<PackageName>.fpd file\r
295 - Remove a module from a package\r
296 * Comment out or remove corresponding <MsaFile> element under <MsaFiles>\r
297 from <PackageDir>\<PackageName>.spd\r
298 * Comment out or remove corresponding <ModuleSA> entry under each\r
299 <TianoImage> from <PackageDir>\<PackageName>.fpd\r
3023) How to manually create a package:\r
303 - Identify the modules that are to be members of the project.\r
304 - Identify the Variables and Guids required in and of the Package (including\r
305 consumption/production information).\r
306 - Create an SPD file defining these modules and calling out their MSA files.\r
3094) Declare a new Protocol in a package: \r
310 - This release requires manual editing of the SPD file, adding the protocol\r
311 to the ProtocolDeclarations section of the file. \r
312 - Add the Protocol .h file to the Include\Protocol directory.\r
64fcaead 313 - Add an <Entry> to the <ProtocolDeclarations> element in the \r
314 <PackageName>.spd file\r
aa0bf4f4 315 * Each line contains Protocol base name then the global variable name and\r
316 then the hex value of the Protocol GUID.\r
64fcaead 318Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):\r
320 <Entry Name="UnicodeCollation">\r
321 <C_Name>gEfiUnicodeCollationProtocolGuid</C_Name>\r
322 <Guid>{ 0x1d85cd7f, 0xf43d, 0x11d2, 0x9a, 0xc, 0x0, 0x90, 0x27,\r
323 0x3f, 0xc1, 0x4d }</Guid>\r
324 <Entry Name="UsbHc">\r
325 <C_Name>gEfiUsbHcProtocolGuid</C_Name>\r
326 <Guid>{ 0xf5089266, 0x1aa0, 0x4953, 0x97, 0xd8, 0x56, 0x2f, 0x8a,\r
327 0x73, 0xb5, 0x19 }</Guid>\r
aa0bf4f4 328\r
3305) Declare a new PPI in a package:\r
331 - This release requires manual editing of the SPD file\r
332 - Add the PPI .h file to the Include\Ppi directory.\r
64fcaead 333 - Add an <Entry> to the package <PpiDeclarations> element in the \r
334 <PackageName>.spd file\r
aa0bf4f4 335 * Each line contains PPI base name then the global variable name and then\r
336 the hex value of the PPI GUID.\r
64fcaead 338Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):\r
340 <Entry Name="NtPeiLoadFile">\r
341 <C_Name>gNtPeiLoadFilePpiGuid</C_Name>\r
342 <Guid>{ 0xfd0c65eb, 0x405, 0x4cd2, 0x8a, 0xee, 0xf4, 0x0, 0xef, 0x13,\r
343 0xba, 0xc2 }</Guid>\r
344 </Entry>\r
345 <Entry Name="NtThunk">\r
346 <C_Name>gPeiNtThunkPpiGuid</C_Name>\r
347 <Guid>{ 0x98c281e5, 0xf906, 0x43dd, 0xa9, 0x2b, 0xb0, 0x3, 0xbf,\r
348 0x27, 0x65, 0xda }</Guid>\r
349 </Entry>\r
aa0bf4f4 352\r
3546) Declare a new GUID in a package:\r
355 - This release requires manual editing of the SPD file to include the new\r
64fcaead 356 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration\r
357 element as described above.\r
aa0bf4f4 358\r
359--------------------------------------- \r
64fcaead 3607) Define a new PCD entry in a package:\r
aa0bf4f4 361 - This release requires manual editing of the SPD file to include the new\r
64fcaead 362 PCD. New Pcd entries are added to the PcdDefinitions section of the\r
363 <PackageName>.spd file using the following example for the format:\r
364 NOTE: The hex <Token> value must be unique.\r
367 <PcdEntry ItemType="FIXED_AT_BUILD">\r
368 <C_Name>PcdMaximumUnicodeStringLength</C_Name>\r
369 <Token>0x00000001</Token>\r
370 <DatumType>UINT32</DatumType>\r
371 <DefaultValue>1000000</DefaultValue>\r
372 </PcdEntry>\r
aa0bf4f4 374 \r
3768) Declare a new Library Class:\r
377 - This release requires manual editing of the SPD file to include the new\r
64fcaead 378 Library Class. New Library Class entries are added to the \r
379 LibraryClassDeclarations seection of the <PackageName>.spd file using\r
380 the following example for the format:\r
383 <LibraryClassDeclaration>\r
384 <LibraryClass>BaseLib</LibraryClass>\r
385 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>\r
386 </LibraryClassDeclaration>\r
aa0bf4f4 388\r
3909) Add a library instance to a package:\r
391 - This requires manual MSA and MBD file.\r
39410) Add a module to a package:\r
395 - This requires manual MSA and MBD editing\r
401The EDK 2.0 represents significant changes in the structure of the EDK.\r
402Therefore it is very difficult to isolate all of the changes of this version of\r
403the EDK with the previous (EDK 1.0) version.\r
405Of particular note:\r
4071) EDK 2.0 contains new hardware feature support for the ICH SMBUS Libraries.\r
408 These libraries are provided to make Memory Reference Code (MRC) development\r
409 easier.\r
1465cc8b 4102) The MDE Libraries - The MDE libraries represent significant changes in source\r
aa0bf4f4 411 (with only limited changes in functionality.) These new libraries conform\r
412 to the "MDE Library Specification". \r
4133) The Fat Binary and the EDK Shell Binary Packages are functionally identical\r
414 to the EDK 1.0 version.\r
4154) The EDK tools directory has been expanded to include more tools and more\r
416 tool functionality.\r
4175) The EDK NT32 section has been ported to the new build process, but\r
418 functionally remains the same as the EDK 1.0 version.\r
4196) The Application "HelloWorld" has been ported to EDK 2.0 as well.\r
422Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no\r
423virus detected.\r