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