I refined some names, added description for FAT source package, and removed the descr...
[mirror_edk2.git] / ReleaseNotes.txt
CommitLineData
aa0bf4f4 1Intel(R) Platform Innovation Framework for EFI\r
362271d6 2EFI Development Kit II (EDK II) \r
3Root Package 1.00\r
42006-07-06\r
aa0bf4f4 5\r
6Copyright (c) 2006, Intel Corporation\r
7\r
8This document provides updates to documentation, along with a description on \r
362271d6 9how to install and build the EDK II.\r
aa0bf4f4 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
362271d6 21 EdkFatPkg - A package containing source DXE drivers for the Fat 32 file\r
22 system\r
aa0bf4f4 23 EdkShellBinPkg - A package containing binary Shell applications and commands\r
24 EdkNt32Pkg - A package containing the NT32 Emulation platform reference\r
25\r
26Note: MDE and MDK that appear in other documentation refer to the MdePkg and\r
27Tools packages. These two packages are the minimum requirement for developing\r
13421853 28EDK II Packages. It is also recommended that the top level files included\r
aa0bf4f4 29with the EDK be downloaded in conjunction with these two packages.\r
30\r
31Note: Documents have the following filenames:\r
13421853 32 EDK II Module Development Environment Library Specification v0.50 \r
aa0bf4f4 33 (MDE_Library_Spec_0_50.rtf)\r
13421853 34 EDK II Build and Packaging Architecture Specification v0.50\r
aa0bf4f4 35 (Build_Packaging_Spec_0_50.rtf)\r
13421853 36 EDK II Platform Configuration Database Infrastructure Description v0.51\r
aa0bf4f4 37 (PCD_Infrastructure_0_51.rtf)\r
13421853 38 EDK II Module Surface Area v0.50\r
aa0bf4f4 39 (Module_Surface_Area_0_50.rtf)\r
13421853 40 EDK II Module Development Environment (MDE) Package Specification v0.50\r
aa0bf4f4 41 (MDE_Package_Spec_0_50.rtf)\r
13421853 42 EDK II C Coding Standards Specification v0.50\r
aa0bf4f4 43 (C_Coding_Standards_Specification_ 0_50.rtf)\r
44\r
45Pre-Requisites\r
46--------------\r
47The following list of tools must be installed on the development workstation\r
e3f236c8 48prior to using the Edk II.\r
aa0bf4f4 49\r
50Compiler Tool Chain\r
51 Microsoft* Visual Studio .NET 2003* (http://www.microsoft.com)\r
52 or\r
43475442 53 A special GCC version 4.x or later (http://gcc.gnu.org). See below.\r
aa0bf4f4 54\r
55Assembler Tool Chain\r
56 Microsoft Macro Assembler, version 6.15 or later\r
57 or\r
8fb9e6b8 58 GNU binutils 2.16.1 or later\r
aa0bf4f4 59\r
60Java Development Kit ( Java 5.0 or later)\r
61 Sun* jdk-1.5.0_04 or later (http://java.sun.com)\r
62 or\r
63 Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (http://www.bea.com)\r
64\r
65Java Tools\r
66 Apache-ANT, version 1.6.5 or later (http://ant.apache.org)\r
50518883 67 Ant-contrib, version 1.0b2 or later\r
68 (http://sourceforge.net/project/showfiles.php?group_id=36177)\r
aa0bf4f4 69 Saxon8, version 8.1.1\r
70 (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)\r
71 XMLBeans, version 2.1.0 or later (http://xmlbeans.apache.org) \r
72\r
73Other Tools\r
74 TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)\r
75\r
76Optional Tools\r
77--------------\r
78Compiler Tool Chains:\r
50518883 79 Intel C++ Compiler for Windows, ver. 9.0 or later (http://www.intel.com)\r
8fb9e6b8 80 Intel C Compiler for EFI Byte Code, ver. 1.2 or later \r
81 (http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm)\r
aa0bf4f4 82 Microsoft Driver Development Kit, version 3790.1830 or later\r
8fb9e6b8 83 (http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx)\r
aa0bf4f4 84 Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later\r
85 Intel ACPI Component Architecture, version 20060113\r
86\r
87-----------------------\r
88Notes On Required Tools (Source Control System)\r
89-----------------------\r
13421853 90The EDK II is being managed by the Subversion Source Control on Tianocore.org.\r
aa0bf4f4 91This software package provides speed, security, and additional features. The\r
92recommended client is TortoiseSVN version 1.3.3. \r
93 (Available at http://tortoisesvn.tigris.org/)\r
94\r
95There are instructions for the use of Subversion Source Control on the\r
96Tianocore.org website, as part of the checkout procedures.\r
97\r
13421853 98The URL of the EDK II repository is:\r
aa0bf4f4 99 https://edk2.tianocore.org/svn/edk2/trunk/edk2\r
100\r
101-----------------------\r
102Notes On Documentation\r
103-----------------------\r
104The documents are being managed by the Subversion Source Control on\r
105Tianocore.org. The document repository is "docs" and must be checked out\r
13421853 106separately from the EDK II source tree. Refer to the checkout procedures on\r
107the Tianocore.org website for EDK II.\r
aa0bf4f4 108\r
109The URL of the document repository is:\r
110 https://edk2.tianocore.org/svn/edk2/trunk/docs\r
111\r
112\r
113-----------------------\r
114Notes On Required Tools (MS Windows environment example)\r
115-----------------------\r
116Software Installation Order:\r
117 After installing the compiler tools and your Subversion client, the following\r
118 required tools should be installed in order: \r
119 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8\r
120\r
121Java Development Kit:\r
122 \r
123 The Java Environment Variable must be set before attempting to build.\r
124 i.e. For Sun JDK (see note below*):\r
125 set JAVA_HOME=c:\ Java\jdk1.5.0_06 \r
126 i.e. For Bea Systems:\r
127 set JAVA_HOME=c:\Program Files\Java\jrockit-R26.0.0-jdk1.5.0_04\r
128 \r
129 *When using the Sun JDK5.0\r
130 During installation, you should specify the install directory as C:\Java\r
131 instead of C:\Program Files\(or some other drive letter.) While installing\r
132 to this non-standard location is not required. In use, it seems to work \r
133 more reliably. \r
134 For the JDK, the install path would be C:\Java\jdk1.5.0_06\r
135 For the JRE, the install path would be C:\Java\jre1.5.0_06\r
136 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.\r
01d2ed5e 137\r
aa0bf4f4 138 NOTE: You cannot combine the location for the JDK and the JRE, as the JRE\r
139 install removes most of the binaries and libraries installed by the JDK\r
140 install.\r
141\r
142Java Tools:\r
143 The Apache-ANT requires the ANT_HOME environment variable to be set before\r
144 attempting to build:\r
01d2ed5e 145 i.e. set ANT_HOME=c:\<full path to where ant was installed>\r
aa0bf4f4 146\r
147 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib \r
148 directory.\r
149\r
150 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
151 before attempting to build:\r
01d2ed5e 152 i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
aa0bf4f4 153\r
154 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.\r
155\r
156 The Ant and XMLBean tools are required to be in the path.\r
157 MS system example:\r
158 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin\r
159 Linux/OS X bash shell example:\r
160 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin\r
161 \r
162-------------------------------------------------------------------------------\r
163Quick Start\r
164-----------\r
e3f236c8 165Edit the text file, target.txt, located in the Tools/Conf directory. This \r
166file contains the tools defintion file and ative platform. It can also restrict\r
167current build target(s), tagname(s) and arch(s). Uncomment the line ACTIVE_PLATFORM\r
168which is commented out by default. \r
169\r
170Edit the tools definition file, tools_def.txt, also located in the Tools/Conf \r
171directory. This file contains the names of the compiler tool chains and the \r
172location of the compiler binaries. It has been pre-populated with the standard \r
173location for the Microsoft tool chains and includes the standard location of \r
174the Intel C Compiler for EFI Byte Code (EBC)\r
aa0bf4f4 175 \r
176Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
13421853 177checkout the entire EDK II source tree.\r
aa0bf4f4 178\r
e3f236c8 179In a command window, change to the top level directory of the Edk II sources.\r
aa0bf4f4 180 Set the WORKSPACE environment variable, e.g.:\r
181\r
182 c:\> set WORKSPACE=C:\MyWork\Edk2.0\r
183\r
184To test your tool chain setup and to build the Supplied Tools, execute:\r
185 c:\MyWork\Edk2.0\> edksetup\r
186\r
187(This command will be referred to as the setup command throughout the rest of\r
188this document.)\r
189 NOTE: You should run the setup command at the start of every session.\r
190 This configures the environment to include the TianoTools and the\r
191 Java applications and libraries.\r
192\r
193Once this is completed, you are ready to test the Build, by executing:\r
e3f236c8 194 c:\MyWork\Edk2.0\> build\r
aa0bf4f4 195\r
e3f236c8 196This command builds active platform specified in text file target.txt. If \r
197active platform is not specified, go to sub-directory which contains FPD files and\r
198type build. More information about active platform policy reference to specification\r
199<<EDK II Build and Packaging Architecture Specification>>.\r
90f7b6a8 200\r
aa0bf4f4 201-------------------------\r
e3f236c8 202Individual Platform Builds\r
aa0bf4f4 203-------------------------\r
e3f236c8 204After running the setup command, you can build individual platforms.\r
205 In the command window, \r
206 1. Set active platform in target.txt, and type "build" in whatever directory;\r
207 2. or cd to the platform (FPD file) that you want to build, and just type:\r
208 c:\MyWork\Edk2.0\EdkNt32Pkg\> build\r
209\r
210 Note that active platform with the high priority to build, that means active \r
211 platform will be built even if exists FPD file under current directory. More \r
212 information about active platform policy reference to specification\r
213 <<EDK II Build and Packaging Architecture Specification>>. \r
aa0bf4f4 214\r
e3f236c8 215Go to <full build path>\Debug\MSFT\IA32 and execute SecMain.exe\r
216to run the Nt32 emulation platform under Microsoft Windows.\r
aa0bf4f4 217\r
03fed93e 218To exit the Nt32 emulation platform, you may type reset at the EFI Shell>\r
219command prompt. Alternately, you may use the Graphical interface, Boot\r
220Maintenance Manager screen's Reset System command.\r
221\r
aa0bf4f4 222------------------------\r
223Individual Module Builds\r
224------------------------\r
225After running the setup command, you can build individual modules.\r
226 In the command window, cd to the module that you want to build, and just\r
227 type:\r
e3f236c8 228 c:\MyWork\Edk2.0\MdePkg\Library\BaseLib\> build\r
229\r
230 Note active platform must be set for individual module build. \r
aa0bf4f4 231\r
232-------------------------------------------------------------------------------\r
233A Word on Apache-ANT\r
234--------------------\r
235The Apache-ANT program is a build tool that uses XML-based project files.\r
236Similar to Makefiles, these project files may contain multiple targets. Most\r
e3f236c8 237build.xml files in Edk2.0 are auto-generated; any edits performed on the\r
aa0bf4f4 238build.xml files will be overwritten the next time ant is executed.\r
239\r
240Pre-defined targets in the build.xml files include:\r
241 all - This target builds binaries for defined architectures\r
242 clean - This target removes object files generated by commands\r
243 cleanall - This target removes all generated files and directories.\r
244\r
245A Word on GCC tool chain\r
246------------------------\r
e3f236c8 247EDK2 will not compile with a standard Linux gcc tool chain. While Linux\r
248distributions are usually based on ELF, EDK2 requires a version of gcc that is\r
43475442 249configured to produce PE-COFF images. You will find a script in edk2/Tools/gcc\r
250that will download, configure, compile, and install a gcc 4.X cross-compile\r
e3f236c8 251tool chain for EDK2 development. It has support for the ia32 architecture. It\r
43475442 252can be built and run on Cygwin, Linux, and many other POSIX compliant host\r
253operating environments. There are a few tools that you will need on your host\r
254computer in order to compile the tool chain. Among them are bash, gcc, gmake,\r
255curl (or wget).\r
aa0bf4f4 256\r
257-------------------------------------------------------------------------------\r
258\r
259General Information:\r
260=============================================================== \r
261Mechanisms:\r
262----------\r
8fb9e6b8 263A brief overview:\r
aa0bf4f4 264\r
265A) Surface Area Package Description (SPD) file contains information about the\r
266modules that the package contains, including the location of all MSA files, and\r
267public library names and headers that might be provided by a module in the\r
268package. Packages are defined by SPD files. (Found in the root of the Package\r
269subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "Build \r
270Packaging Specification" document.\r
271 \r
272B) Module Surface Area Definition (MSA) files. A description of a module's \r
273surface area, with all module specific default flags and features specified.\r
274Refer to the "Module Surface Area Architecture Specification" for additional\r
275details. The MSA is further explained in the "Build Packaging Specification"\r
276document.\r
277 \r
362271d6 278C) Platform Configuration Database (PCD). A platform database which contains a\r
aa0bf4f4 279variety of current platform settings or directives by which a driver or\r
280application can interact with. The PCD is defined by the PCD_Protocol (This is\r
281further explained in the "Platform Configuration Database Infrastructure \r
282Description" document.\r
283\r
362271d6 284D) Library Class. A library class is a logical grouping of similar functions.\r
aa0bf4f4 285When developing components, the module surface area declares the class of\r
286libraries that can be used by the component. The MBD file specifies the\r
287instance(s) of the library that will be used during compilation/linking. All\r
288library type modules must include header files in their distribution package,\r
289as well as their surface area and module build description files. Components,\r
290on the other hand, need only provide the binary and build description files\r
291when distributing BINARY packages. The Library Classes are further explained\r
292in the "Build Packaging Specification" document.\r
293\r
294=========================================================================\r
295The common operations by developers of new modules are:\r
296-------------------------------------------------------\r
297\r
2981) How to manually create a new module in a package:\r
299 - The module source code must first be created in an appropriate directory\r
300 (under the package the module is to be a part of.) \r
301 - An MSA file must be created, spelling out all aspects of the module.\r
302 - The MSA must be added to the SPD for the package to include the module.\r
303\r
304-----------------------------------------\r
3052) Add/Remove module(s) to/from a package:\r
306\r
307 - Setup environment as Build\r
308 - Add a module to a package\r
e3f236c8 309 * Generate the module SurfaceArea description file\r
310 * Add a new <Filename> element under <MsaFiles> into\r
aa0bf4f4 311 <PackageDir>\<PackageName>.spd, using relative path to package\r
e3f236c8 312 * Add a new <ModuleSA> entry under each <FrameworkModules> into\r
313 <PackageDir>\<PackageName>.fpd file if necessary. \r
aa0bf4f4 314\r
315 - Remove a module from a package\r
e3f236c8 316 * Comment out or remove corresponding <Filename> element under <MsaFiles>\r
aa0bf4f4 317 from <PackageDir>\<PackageName>.spd\r
318 * Comment out or remove corresponding <ModuleSA> entry under each\r
e3f236c8 319 <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary. \r
aa0bf4f4 320\r
321-----------------------------------\r
3223) How to manually create a package:\r
323 - Identify the modules that are to be members of the project.\r
324 - Identify the Variables and Guids required in and of the Package (including\r
325 consumption/production information).\r
326 - Create an SPD file defining these modules and calling out their MSA files.\r
e3f236c8 327 - add a new <Filename> element under <PackageList> into \r
328 Tools\Conf\FrameworkDatabase.db, using the relative path to workspace. \r
aa0bf4f4 329\r
330--------------------------------------\r
3314) Declare a new Protocol in a package: \r
332 - This release requires manual editing of the SPD file, adding the protocol\r
333 to the ProtocolDeclarations section of the file. \r
334 - Add the Protocol .h file to the Include\Protocol directory.\r
64fcaead 335 - Add an <Entry> to the <ProtocolDeclarations> element in the \r
336 <PackageName>.spd file\r
aa0bf4f4 337 * Each line contains Protocol base name then the global variable name and\r
338 then the hex value of the Protocol GUID.\r
339\r
64fcaead 340Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):\r
341<ProtocolDeclarations>\r
e3f236c8 342 <Entry Name="Bds">\r
343 <C_Name>gEfiBdsArchProtocolGuid</C_Name>\r
344 <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>\r
345 <HelpText/>\r
346 </Entry>\r
347 <Entry Name="Cpu">\r
348 <C_Name>gEfiCpuArchProtocolGuid</C_Name>\r
349 <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>\r
350 <HelpText/>\r
351 </Entry>\r
352</ProtocolDeclarations>\r
aa0bf4f4 353\r
354---------------------------------\r
3555) Declare a new PPI in a package:\r
356 - This release requires manual editing of the SPD file\r
357 - Add the PPI .h file to the Include\Ppi directory.\r
64fcaead 358 - Add an <Entry> to the package <PpiDeclarations> element in the \r
359 <PackageName>.spd file\r
aa0bf4f4 360 * Each line contains PPI base name then the global variable name and then\r
361 the hex value of the PPI GUID.\r
362\r
64fcaead 363Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):\r
364<PpiDeclarations>\r
e3f236c8 365 <Entry Name="BootInRecoveryMode">\r
366 <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>\r
367 <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>\r
368 <HelpText/>\r
64fcaead 369 </Entry>\r
e3f236c8 370 <Entry Name="CpuIo">\r
371 <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>\r
372 <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>\r
373 <HelpText/>\r
64fcaead 374 </Entry>\r
375</PpiDeclarations>\r
376\r
aa0bf4f4 377----------------------------------\r
3786) Declare a new GUID in a package:\r
379 - This release requires manual editing of the SPD file to include the new\r
64fcaead 380 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration\r
381 element as described above.\r
aa0bf4f4 382\r
383--------------------------------------- \r
64fcaead 3847) Define a new PCD entry in a package:\r
aa0bf4f4 385 - This release requires manual editing of the SPD file to include the new\r
64fcaead 386 PCD. New Pcd entries are added to the PcdDefinitions section of the\r
387 <PackageName>.spd file using the following example for the format:\r
388 NOTE: The hex <Token> value must be unique.\r
389\r
390<PcdDefinitions>\r
391 <PcdEntry ItemType="FIXED_AT_BUILD">\r
392 <C_Name>PcdMaximumUnicodeStringLength</C_Name>\r
393 <Token>0x00000001</Token>\r
394 <DatumType>UINT32</DatumType>\r
395 <DefaultValue>1000000</DefaultValue>\r
396 </PcdEntry>\r
397</PcdDefinition>\r
aa0bf4f4 398 \r
399------------------------------\r
4008) Declare a new Library Class:\r
401 - This release requires manual editing of the SPD file to include the new\r
64fcaead 402 Library Class. New Library Class entries are added to the \r
403 LibraryClassDeclarations seection of the <PackageName>.spd file using\r
404 the following example for the format:\r
405\r
406<LibraryClassDeclarations>\r
e3f236c8 407 <LibraryClass Name="BaseLib">\r
64fcaead 408 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>\r
e3f236c8 409 <HelpText/>\r
410 </LibraryClass>\r
411 <LibraryClass Name="BaseMemoryLib">\r
412 <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>\r
413 <HelpText/>\r
414 </LibraryClass>\r
64fcaead 415</LibraryClassDeclarations>\r
aa0bf4f4 416\r
aa0bf4f4 417=======================================================\r
418Notes:\r
419------\r
13421853 420The EDK II represents significant changes in the structure of the EDK.\r
aa0bf4f4 421Therefore it is very difficult to isolate all of the changes of this version of\r
422the EDK with the previous (EDK 1.0) version.\r
423\r
424Of particular note:\r
425\r
13421853 4261) EDK II contains new hardware feature support for the ICH SMBUS Libraries.\r
aa0bf4f4 427 These libraries are provided to make Memory Reference Code (MRC) development\r
428 easier.\r
1465cc8b 4292) The MDE Libraries - The MDE libraries represent significant changes in source\r
aa0bf4f4 430 (with only limited changes in functionality.) These new libraries conform\r
431 to the "MDE Library Specification". \r
4323) The Fat Binary and the EDK Shell Binary Packages are functionally identical\r
433 to the EDK 1.0 version.\r
4344) The EDK tools directory has been expanded to include more tools and more\r
435 tool functionality.\r
4365) The EDK NT32 section has been ported to the new build process, but\r
437 functionally remains the same as the EDK 1.0 version.\r
13421853 4386) The Application "HelloWorld" has been ported to EDK II as well.\r
aa0bf4f4 439\r
440=======================================================\r
441Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no\r
442virus detected.\r
443\r