Fix a typo BaseLib.msa and add the missing file in BaseSmbusLib.
[mirror_edk2.git] / ReleaseNotes.txt
aa0bf4f4 1Intel(R) Platform Innovation Framework for EFI\r
362271d6 2EFI Development Kit II (EDK II) \r
3Root Package 1.00\r
aa0bf4f4 5\r
6Copyright (c) 2006, Intel Corporation\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
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
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
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
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* (\r
52 or\r
43475442 53 A special GCC version 4.x or later ( 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 (\r
62 or\r
63 Bea Systems* jrockit-25.2.0-jdk1.5.0_03 or later (\r
65Java Tools\r
66 Apache-ANT, version 1.6.5 or later (\r
50518883 67 Ant-contrib, version 1.0b2 or later\r
782eb168 68 (\r
aa0bf4f4 69 Saxon8, version 8.1.1\r
70 (\r
782eb168 71 XMLBeans, version 2.1.0 (\r
72 DO NOT download the latest XMLBeans, version 2.2.0. It cannot work with\r
73 Saxon8, version 8.1.1.\r
aa0bf4f4 74\r
75Other Tools\r
76 TortoiseSVN version 1.3.3. (\r
78Optional Tools\r
80Compiler Tool Chains:\r
50518883 81 Intel C++ Compiler for Windows, ver. 9.0 or later (\r
8fb9e6b8 82 Intel C Compiler for EFI Byte Code, ver. 1.2 or later \r
83 (\r
aa0bf4f4 84 Microsoft Driver Development Kit, version 3790.1830 or later\r
8fb9e6b8 85 (\r
aa0bf4f4 86 Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later\r
87 Intel ACPI Component Architecture, version 20060113\r
90Notes On Required Tools (Source Control System)\r
13421853 92The EDK II is being managed by the Subversion Source Control on\r
aa0bf4f4 93This software package provides speed, security, and additional features. The\r
94recommended client is TortoiseSVN version 1.3.3. \r
95 (Available at\r
97There are instructions for the use of Subversion Source Control on the\r website, as part of the checkout procedures.\r
13421853 100The URL of the EDK II repository is:\r
aa0bf4f4 101\r
104Notes On Documentation\r
106The documents are being managed by the Subversion Source Control on\r The document repository is "docs" and must be checked out\r
13421853 108separately from the EDK II source tree. Refer to the checkout procedures on\r
109the website for EDK II.\r
aa0bf4f4 110\r
111The URL of the document repository is:\r
6132429e 116Notes On Required Tools (With examples for Windows, OS X, and Linux) \r
aa0bf4f4 117-----------------------\r
118Software Installation Order:\r
119 After installing the compiler tools and your Subversion client, the following\r
120 required tools should be installed in order: \r
121 Java JDK, Apache-Ant, ant-contrib, xmlbeans, saxon8\r
123Java Development Kit:\r
124 \r
125 The Java Environment Variable must be set before attempting to build.\r
6132429e 126 For Sun JDK (see note below*):\r
127 set JAVA_HOME=c:\Java\jdk1.5.0_06 (Windows example)\r
128 export JAVA_HOME=/Library/Java/Home/ (OS X example)\r
129 export JAVA_HOME=/usr/lib/j2sdk1.5-sun/ (Linux example)\r
130 For Bea Systems:\r
782eb168 131 set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04\r
aa0bf4f4 132 \r
133 *When using the Sun JDK5.0\r
134 During installation, you should specify the install directory as C:\Java\r
135 instead of C:\Program Files\(or some other drive letter.) While installing\r
136 to this non-standard location is not required. In use, it seems to work \r
137 more reliably. \r
138 For the JDK, the install path would be C:\Java\jdk1.5.0_06\r
139 For the JRE, the install path would be C:\Java\jre1.5.0_06\r
140 Alternatively, you can specify C:\sunjavajdk and C:\sunjavajre.\r
01d2ed5e 141\r
aa0bf4f4 142 NOTE: You cannot combine the location for the JDK and the JRE, as the JRE\r
143 install removes most of the binaries and libraries installed by the JDK\r
144 install.\r
146Java Tools:\r
147 The Apache-ANT requires the ANT_HOME environment variable to be set before\r
148 attempting to build:\r
01d2ed5e 149 i.e. set ANT_HOME=c:\<full path to where ant was installed>\r
6132429e 150 export ANT_HOME=~/ExternalTools/apache-ant (OS X and Linux example)\r
aa0bf4f4 151\r
152 The ant-contrib.jar file should be installed in the %ANT_HOME%\lib \r
153 directory.\r
155 The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
156 before attempting to build:\r
782eb168 157 i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
6132429e 158 export XMLBEANS_HOME=~/ExternalTools/xmlbeans (OS X and Linux example)\r
aa0bf4f4 159\r
160 The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.\r
162 The Ant and XMLBean tools are required to be in the path.\r
163 MS system example:\r
164 set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin\r
165 Linux/OS X bash shell example:\r
166 export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin\r
167 \r
169Quick Start\r
a032fb4d 170-----------\r
aa0bf4f4 171Follow the instructions at to\r
13421853 172checkout the entire EDK II source tree.\r
aa0bf4f4 173\r
e3f236c8 174In a command window, change to the top level directory of the Edk II sources.\r
aa0bf4f4 175\r
65a1d8a9 176If the active compiler tool chain is GCC, you must set the\r
177environment variable, TOOL_CHAIN to "gcc" before running the\r
178edksetup script. Example: export TOOL_CHAIN=gcc\r
aa0bf4f4 179\r
180To test your tool chain setup and to build the Supplied Tools, execute:\r
65a1d8a9 181 c:\MyWork\edkii\> edksetup ForceBuild\r
aa0bf4f4 182\r
6132429e 183On Unix systems you must source the file to load the correct\r
184settings into your shell.\r
186 . # Note the dot.\r
aa0bf4f4 188(This command will be referred to as the setup command throughout the rest of\r
189this document.)\r
190 NOTE: You should run the setup command at the start of every session.\r
191 This configures the environment to include the TianoTools and the\r
192 Java applications and libraries.\r
65a1d8a9 194Any changes to the tool source code or XML Schema documents will require that\r
195you run:\r
196 c:\MyWork\edkii\> edksetup ForceBuild\r
198You will need to set the WORKSPACE environment variable, or run the edksetup\r
199script (without any arguments) any time you want to build.\r
201 Set the WORKSPACE environment variable, e.g.:\r
203 c:\> set WORKSPACE=C:\MyWork\edkii\r
205You may need to edit the text files, Tools/Conf/target.txt and/or\r
206Tools/Conf/tools_def.txt (created by edksetup,) using your favorite \r
207text editor to point to the tools you want to use to build EDK II binaries.\r
a032fb4d 208\r
aa0bf4f4 209Once this is completed, you are ready to test the Build, by executing:\r
65a1d8a9 210 c:\MyWork\edkii\> build\r
aa0bf4f4 211\r
e3f236c8 212This command builds active platform specified in text file target.txt. If \r
213active platform is not specified, go to sub-directory which contains FPD files and\r
214type build. More information about active platform policy reference to specification\r
215<<EDK II Build and Packaging Architecture Specification>>.\r
90f7b6a8 216\r
aa0bf4f4 217-------------------------\r
e3f236c8 218Individual Platform Builds\r
aa0bf4f4 219-------------------------\r
e3f236c8 220After running the setup command, you can build individual platforms.\r
221 In the command window, \r
222 1. Set active platform in target.txt, and type "build" in whatever directory;\r
223 2. or cd to the platform (FPD file) that you want to build, and just type:\r
65a1d8a9 224 c:\MyWork\edkii\EdkNt32Pkg\> build\r
e3f236c8 225\r
226 Note that active platform with the high priority to build, that means active \r
227 platform will be built even if exists FPD file under current directory. More \r
228 information about active platform policy reference to specification\r
229 <<EDK II Build and Packaging Architecture Specification>>. \r
aa0bf4f4 230\r
a032fb4d 231Go to <full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe\r
e3f236c8 232to run the Nt32 emulation platform under Microsoft Windows.\r
aa0bf4f4 233\r
03fed93e 234To exit the Nt32 emulation platform, you may type reset at the EFI Shell>\r
235command prompt. Alternately, you may use the Graphical interface, Boot\r
236Maintenance Manager screen's Reset System command.\r
aa0bf4f4 238------------------------\r
239Individual Module Builds\r
241After running the setup command, you can build individual modules.\r
242 In the command window, cd to the module that you want to build, and just\r
243 type:\r
65a1d8a9 244 c:\MyWork\edkii\MdePkg\Library\BaseLib\> build\r
e3f236c8 245\r
246 Note active platform must be set for individual module build. \r
aa0bf4f4 247\r
249A Word on Apache-ANT\r
251The Apache-ANT program is a build tool that uses XML-based project files.\r
252Similar to Makefiles, these project files may contain multiple targets. Most\r
a032fb4d 253build.xml files in EDK II are auto-generated; any edits performed on the\r
254build.xml files will be overwritten the next time build is executed.\r
aa0bf4f4 255\r
a032fb4d 256Pre-defined targets in the build.xml file include:\r
aa0bf4f4 257 all - This target builds binaries for defined architectures\r
258 clean - This target removes object files generated by commands\r
259 cleanall - This target removes all generated files and directories.\r
261A Word on GCC tool chain\r
a032fb4d 263EDK II will not compile with a standard Linux gcc tool chain. While Linux\r
264distributions are usually based on ELF, EDK II requires a version of gcc \r
265that is configured to produce PE-COFF images. You will find a script in \r
266edk2/Tools/gcc that will download, configure, compile, and install a gcc \r
2674.X cross-compile tool chain for EDK II development. It has support for \r
268the IA32 architecture. It can be built and run on Cygwin, Linux, and many \r
269other POSIX compliant host operating environments. There are a few tools\r
270that you will need on your host computer in order to compile the tool \r
271chain. Among them are bash, gcc, gmake, curl (or wget).\r
aa0bf4f4 272\r
275General Information:\r
276=============================================================== \r
8fb9e6b8 279A brief overview:\r
aa0bf4f4 280\r
281A) Surface Area Package Description (SPD) file contains information about the\r
282modules that the package contains, including the location of all MSA files, and\r
283public library names and headers that might be provided by a module in the\r
284package. Packages are defined by SPD files. (Found in the root of the Package\r
a032fb4d 285subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "EDK Build \r
286and Packaging Architecture Specification" document.\r
aa0bf4f4 287 \r
288B) Module Surface Area Definition (MSA) files. A description of a module's \r
289surface area, with all module specific default flags and features specified.\r
290Refer to the "Module Surface Area Architecture Specification" for additional\r
a032fb4d 291details. The MSA is further explained in the "EDK II Build Packaging Architecture \r
292Specification" document.\r
294C) Framework Platform Description (FPD) files. A description of a platform's\r
295surface are, including a list of modules that are needed by the platform. To\r
296support individual module builds, developers are not required to provide\r
297information about specific flash devices, nor flash device layout. There are\r
298specific sections in the FPD file that do control aspects of the build, such \r
299as the Supported Architectures and Build Targets, as well as the tool flags \r
300that are used to create the binary files. A valid platform file can specify \r
301zero or more modules, so individual modules can be compiled within the context\r
302of a platform (FPD) definition.\r
304D) Platform Configuration Database (PCD). A platform database which contains a\r
aa0bf4f4 305variety of current platform settings or directives by which a driver or\r
306application can interact with. The PCD is defined by the PCD_Protocol (This is\r
307further explained in the "Platform Configuration Database Infrastructure \r
308Description" document.\r
a032fb4d 310E) Library Class. A library class is a logical grouping of similar functions.\r
aa0bf4f4 311When developing components, the module surface area declares the class of\r
a032fb4d 312libraries that can be used by the component. The MSA and SPD files can specify\r
313a recommended instance of the library that a platform integrator may select,\r
314however this is only a recommendation. The PI may choose to select a different\r
315library instance to be used during compilation/linking. All library type modules \r
316must include header files in their distribution package, as well as their MSA\r
317files. Components, on the other hand, need only provide an MSA and either source\r
318or binary files when distributing packages. The Library Classes are further \r
319explained in the "EDK II Build and Packaging Architecture Specification" \r
aa0bf4f4 321\r
323The common operations by developers of new modules are:\r
3261) How to manually create a new module in a package:\r
327 - The module source code must first be created in an appropriate directory\r
328 (under the package the module is to be a part of.) \r
329 - An MSA file must be created, spelling out all aspects of the module.\r
330 - The MSA must be added to the SPD for the package to include the module.\r
3332) Add/Remove module(s) to/from a package:\r
335 - Setup environment as Build\r
336 - Add a module to a package\r
e3f236c8 337 * Generate the module SurfaceArea description file\r
338 * Add a new <Filename> element under <MsaFiles> into\r
aa0bf4f4 339 <PackageDir>\<PackageName>.spd, using relative path to package\r
e3f236c8 340 * Add a new <ModuleSA> entry under each <FrameworkModules> into\r
341 <PackageDir>\<PackageName>.fpd file if necessary. \r
aa0bf4f4 342\r
343 - Remove a module from a package\r
e3f236c8 344 * Comment out or remove corresponding <Filename> element under <MsaFiles>\r
aa0bf4f4 345 from <PackageDir>\<PackageName>.spd\r
346 * Comment out or remove corresponding <ModuleSA> entry under each\r
e3f236c8 347 <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary. \r
aa0bf4f4 348\r
3503) How to manually create a package:\r
351 - Identify the modules that are to be members of the project.\r
352 - Identify the Variables and Guids required in and of the Package (including\r
353 consumption/production information).\r
354 - Create an SPD file defining these modules and calling out their MSA files.\r
e3f236c8 355 - add a new <Filename> element under <PackageList> into \r
356 Tools\Conf\FrameworkDatabase.db, using the relative path to workspace. \r
aa0bf4f4 357\r
3594) Declare a new Protocol in a package: \r
360 - This release requires manual editing of the SPD file, adding the protocol\r
361 to the ProtocolDeclarations section of the file. \r
362 - Add the Protocol .h file to the Include\Protocol directory.\r
64fcaead 363 - Add an <Entry> to the <ProtocolDeclarations> element in the \r
364 <PackageName>.spd file\r
aa0bf4f4 365 * Each line contains Protocol base name then the global variable name and\r
366 then the hex value of the Protocol GUID.\r
64fcaead 368Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):\r
e3f236c8 370 <Entry Name="Bds">\r
371 <C_Name>gEfiBdsArchProtocolGuid</C_Name>\r
372 <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>\r
373 <HelpText/>\r
374 </Entry>\r
375 <Entry Name="Cpu">\r
376 <C_Name>gEfiCpuArchProtocolGuid</C_Name>\r
377 <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>\r
378 <HelpText/>\r
379 </Entry>\r
aa0bf4f4 381\r
3835) Declare a new PPI in a package:\r
384 - This release requires manual editing of the SPD file\r
385 - Add the PPI .h file to the Include\Ppi directory.\r
64fcaead 386 - Add an <Entry> to the package <PpiDeclarations> element in the \r
387 <PackageName>.spd file\r
aa0bf4f4 388 * Each line contains PPI base name then the global variable name and then\r
389 the hex value of the PPI GUID.\r
64fcaead 391Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):\r
e3f236c8 393 <Entry Name="BootInRecoveryMode">\r
394 <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>\r
395 <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>\r
396 <HelpText/>\r
64fcaead 397 </Entry>\r
e3f236c8 398 <Entry Name="CpuIo">\r
399 <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>\r
400 <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>\r
401 <HelpText/>\r
64fcaead 402 </Entry>\r
aa0bf4f4 405----------------------------------\r
4066) Declare a new GUID in a package:\r
407 - This release requires manual editing of the SPD file to include the new\r
64fcaead 408 Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration\r
409 element as described above.\r
aa0bf4f4 410\r
411--------------------------------------- \r
54c9f9ed 4127) Declare a new PCD entry in a package:\r
aa0bf4f4 413 - This release requires manual editing of the SPD file to include the new\r
64fcaead 414 PCD. New Pcd entries are added to the PcdDefinitions section of the\r
415 <PackageName>.spd file using the following example for the format:\r
416 NOTE: The hex <Token> value must be unique.\r
54c9f9ed 418<PcdDeclarations>\r
64fcaead 419 <PcdEntry ItemType="FIXED_AT_BUILD">\r
420 <C_Name>PcdMaximumUnicodeStringLength</C_Name>\r
421 <Token>0x00000001</Token>\r
54c9f9ed 422 <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
64fcaead 423 <DatumType>UINT32</DatumType>\r
54c9f9ed 424 <ValidUsage>FIXED_AT_BUILD</ValidUsage>\r
64fcaead 425 <DefaultValue>1000000</DefaultValue>\r
54c9f9ed 426 <HelpText>The maximum lengh for unicode string.</HelpText>\r
64fcaead 427 </PcdEntry>\r
54c9f9ed 428</PcdDeclarations>\r
aa0bf4f4 429 \r
4318) Declare a new Library Class:\r
432 - This release requires manual editing of the SPD file to include the new\r
64fcaead 433 Library Class. New Library Class entries are added to the \r
434 LibraryClassDeclarations seection of the <PackageName>.spd file using\r
435 the following example for the format:\r
e3f236c8 438 <LibraryClass Name="BaseLib">\r
64fcaead 439 <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>\r
e3f236c8 440 <HelpText/>\r
441 </LibraryClass>\r
442 <LibraryClass Name="BaseMemoryLib">\r
443 <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>\r
444 <HelpText/>\r
445 </LibraryClass>\r
64fcaead 446</LibraryClassDeclarations>\r
aa0bf4f4 447\r
aa0bf4f4 448=======================================================\r
13421853 451The EDK II represents significant changes in the structure of the EDK.\r
aa0bf4f4 452Therefore it is very difficult to isolate all of the changes of this version of\r
453the EDK with the previous (EDK 1.0) version.\r
455Of particular note:\r
13421853 4571) EDK II contains new hardware feature support for the ICH SMBUS Libraries.\r
aa0bf4f4 458 These libraries are provided to make Memory Reference Code (MRC) development\r
459 easier.\r
1465cc8b 4602) The MDE Libraries - The MDE libraries represent significant changes in source\r
aa0bf4f4 461 (with only limited changes in functionality.) These new libraries conform\r
462 to the "MDE Library Specification". \r
4633) The Fat Binary and the EDK Shell Binary Packages are functionally identical\r
464 to the EDK 1.0 version.\r
4654) The EDK tools directory has been expanded to include more tools and more\r
466 tool functionality.\r
4675) The EDK NT32 section has been ported to the new build process, but\r
468 functionally remains the same as the EDK 1.0 version.\r
13421853 4696) The Application "HelloWorld" has been ported to EDK II as well.\r
aa0bf4f4 470\r
472Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no\r
473virus detected.\r