aa0bf4f4 |
1 | Intel(R) Platform Innovation Framework for EFI\r |
362271d6 |
2 | EFI Development Kit II (EDK II) \r |
3 | Root Package 1.00\r |
4 | 2006-07-06\r |
aa0bf4f4 |
5 | \r |
6 | Copyright (c) 2006, Intel Corporation\r |
7 | \r |
8 | This document provides updates to documentation, along with a description on \r |
362271d6 |
9 | how to install and build the EDK II.\r |
aa0bf4f4 |
10 | \r |
11 | Package 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 |
26 | Note: MDE and MDK that appear in other documentation refer to the MdePkg and\r |
27 | Tools packages. These two packages are the minimum requirement for developing\r |
13421853 |
28 | EDK II Packages. It is also recommended that the top level files included\r |
aa0bf4f4 |
29 | with the EDK be downloaded in conjunction with these two packages.\r |
30 | \r |
31 | Note: 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 |
45 | Pre-Requisites\r |
46 | --------------\r |
47 | The following list of tools must be installed on the development workstation\r |
e3f236c8 |
48 | prior to using the Edk II.\r |
aa0bf4f4 |
49 | \r |
50 | Compiler 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 |
55 | Assembler 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 |
60 | Java 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 |
65 | Java 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 |
782eb168 |
68 | (http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download)\r |
aa0bf4f4 |
69 | Saxon8, version 8.1.1\r |
70 | (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)\r |
782eb168 |
71 | XMLBeans, version 2.1.0 (http://xmlbeans.apache.org)\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 |
75 | Other Tools\r |
76 | TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)\r |
77 | \r |
78 | Optional Tools\r |
79 | --------------\r |
80 | Compiler Tool Chains:\r |
50518883 |
81 | Intel C++ Compiler for Windows, ver. 9.0 or later (http://www.intel.com)\r |
8fb9e6b8 |
82 | Intel C Compiler for EFI Byte Code, ver. 1.2 or later \r |
83 | (http://www.intel.com/cd/software/products/asmo-na/eng/compilers/efibc/index.htm)\r |
aa0bf4f4 |
84 | Microsoft Driver Development Kit, version 3790.1830 or later\r |
8fb9e6b8 |
85 | (http://www.microsoft.com/whdc/devtools/ddk/orderddkcd.mspx)\r |
aa0bf4f4 |
86 | Microsoft ACPI Source Language Assembler, Version 1.0.13NT or later\r |
87 | Intel ACPI Component Architecture, version 20060113\r |
88 | \r |
89 | -----------------------\r |
90 | Notes On Required Tools (Source Control System)\r |
91 | -----------------------\r |
13421853 |
92 | The EDK II is being managed by the Subversion Source Control on Tianocore.org.\r |
aa0bf4f4 |
93 | This software package provides speed, security, and additional features. The\r |
94 | recommended client is TortoiseSVN version 1.3.3. \r |
95 | (Available at http://tortoisesvn.tigris.org/)\r |
96 | \r |
97 | There are instructions for the use of Subversion Source Control on the\r |
98 | Tianocore.org website, as part of the checkout procedures.\r |
99 | \r |
13421853 |
100 | The URL of the EDK II repository is:\r |
aa0bf4f4 |
101 | https://edk2.tianocore.org/svn/edk2/trunk/edk2\r |
102 | \r |
103 | -----------------------\r |
104 | Notes On Documentation\r |
105 | -----------------------\r |
106 | The documents are being managed by the Subversion Source Control on\r |
107 | Tianocore.org. The document repository is "docs" and must be checked out\r |
13421853 |
108 | separately from the EDK II source tree. Refer to the checkout procedures on\r |
109 | the Tianocore.org website for EDK II.\r |
aa0bf4f4 |
110 | \r |
111 | The URL of the document repository is:\r |
112 | https://edk2.tianocore.org/svn/edk2/trunk/docs\r |
113 | \r |
114 | \r |
115 | -----------------------\r |
6132429e |
116 | Notes On Required Tools (With examples for Windows, OS X, and Linux) \r |
aa0bf4f4 |
117 | -----------------------\r |
118 | Software 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 |
122 | \r |
123 | Java 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 |
145 | \r |
146 | Java 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 |
154 | \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 |
161 | \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 |
168 | -------------------------------------------------------------------------------\r |
169 | Quick Start\r |
170 | -----------\r |
3c367f9d |
171 | For editing text files under Windows, use the Wordpad application. Notepad\r |
172 | does not handle UNIX style newline characters properly.\r |
173 | \r |
a032fb4d |
174 | Copy the target.template file in the Tools/Conf directory to target.txt, which\r |
175 | must also be in the Tools/Conf directory.\r |
176 | \r |
e3f236c8 |
177 | Edit the text file, target.txt, located in the Tools/Conf directory. This \r |
a032fb4d |
178 | file contains options for setting the active platform and restricting the build. \r |
179 | The restictions are used to limit the build output by specifying build target(s), \r |
180 | tagname(s) and architecture(s) to less than the full set of possible options. \r |
181 | \r |
73da4c04 |
182 | The ACTIVE_PLATFORM must be set unless the current working directory contains one\r |
183 | or more FPD files. All other options need not be set, however by unsetting these\r |
184 | options (by removing the line from the file, or leaving the Value empty) will \r |
185 | result in all available build possibilites when typing build. By default EDK II\r |
186 | can build a matrix of binaries, using different target types, tool chain tags and \r |
187 | architectures. Options to target.txt file are as follows:\r |
a032fb4d |
188 | \r |
3c367f9d |
189 | ACTIVE_PLATFORM = Value RECOMMENDED\r |
a032fb4d |
190 | Where Value is the WORKSPACE relative path and filename of a Framework Platform \r |
191 | Definition (FPD) File. Example:\r |
192 | \r |
193 | ACTIVE_PLATFORM = MdePkg/MdePkg.fpd\r |
194 | \r |
195 | TARGET = Value OPTIONAL\r |
196 | Where Value is a list of one or more of the following: DEBUG, RELEASE or a User\r |
197 | Defined Target type, such as PERF. Example: \r |
198 | \r |
199 | TARGET = DEBUG RELEASE\r |
200 | \r |
201 | TARGET_ARCH = Value OPTIONAL\r |
202 | Where Value is a list of one or more supported Architectures: IA32, X64, IPF or\r |
203 | EBC. Example: \r |
204 | \r |
205 | TARGET_ARCH = IA32 X64 EBC\r |
206 | \r |
207 | TOOL_CHAIN_CONF = Value OPTIONAL\r |
208 | Where Value is the Filename of an alternate tools_def.txt file created by the\r |
209 | user. The alternate tools_def.txt files must be in the Tools/Conf directory.\r |
210 | These tool definitions are scoped to the WORKSPACE (location of the EDK \r |
211 | installation) and cannot be shared between WORKSPACES. (You can copy the files\r |
212 | from one workspace to another.) Example: \r |
213 | \r |
214 | TOOL_CHAIN_CONF = alfred.txt\r |
215 | \r |
216 | TOOL_CHAIN_TAG = Value OPTIONAL\r |
217 | Where Value is a list of TagName entries as defined in the tools_def.txt file.\r |
218 | The TagName can be used to specify different versions of a compiler, i.e., \r |
219 | gcc 4.0 and gcc 4.1 which will allow you to build binaries with both tool chains \r |
220 | during the same build - useful during testing of a new compiler tool chain, or \r |
221 | for changing compiler flags to check out performance with a different set of \r |
222 | flags than flags used for production. Example:\r |
223 | \r |
224 | TOOL_CHAIN_TAG = GCC40 GCC41\r |
225 | \r |
226 | To clear a restriction, just remove any data after the equal sign. To clear\r |
227 | the TARGET_ARCH limitation that was set above, enter: \r |
228 | \r |
229 | TARGET_ARCH =\r |
230 | \r |
231 | -----------\r |
232 | Copy the tools_def.template file in Tools/Conf to tools_def.txt in the same\r |
233 | directory.\r |
e3f236c8 |
234 | \r |
235 | Edit the tools definition file, tools_def.txt, also located in the Tools/Conf \r |
236 | directory. This file contains the names of the compiler tool chains and the \r |
237 | location of the compiler binaries. It has been pre-populated with the standard \r |
238 | location for the Microsoft tool chains and includes the standard location of \r |
a032fb4d |
239 | the Intel C Compiler for EFI Byte Code (EBC.) In addition, EDK II provides\r |
240 | support for Cygwin, Linux and OS X GCC compiler tool chains. A script has been\r |
241 | provided in the Tools/gcc directory as well as instructions in obtaining and\r |
242 | building a version of GCC that has been tested. The tools_def.txt file has\r |
243 | the GCC binary locations that are created using this script.\r |
244 | \r |
245 | Both target.txt and tools_def.txt files are formatted as Property = Value, \r |
246 | which must appear on a single line. Spanning a Value entry over multiple\r |
247 | lines is not supported at this time. In the target.txt file, the Property is\r |
248 | a single, uppercase word with underscore characters. These Property names are\r |
249 | fixed by the build system. The tools_def.txt file's Property is an underscore\r |
250 | delimited coding, which supports some user defined values. The coding for\r |
251 | the Property is: TARGET_TAGNAME_ARCH_COMMAND_ATTR The Value, is either a \r |
252 | full path, full path and filename or a reserved word.\r |
253 | \r |
254 | TARGET - DEBUG and RELEASE are predefined, however the user may define one or\r |
255 | more of their own TARGET types in this file.\r |
256 | \r |
257 | TAGNAME - HOST, MSFT, GCC, INTC are predefined, however the user may define \r |
258 | one or more of their own TAGNAME keywords in this file.\r |
259 | \r |
260 | ARCH - EDK II supports IA32, X64, IPF and EBC at this time.\r |
261 | \r |
262 | COMMAND - Predefined command codes are listed in the tools_def.txt file, however\r |
263 | the user can specify additional command codes for their one, non-\r |
264 | standard tools.\r |
265 | \r |
266 | ATTR - Predefined Attributes are listed in the tools_def.txt file.\r |
267 | \r |
268 | NOTE: The TAGNAME: HOST is reserved and MUST be defined in order to build the\r |
269 | included Tiano tools from their C source files. These tools have been\r |
270 | built and tested using both Microsoft and GCC tool chains.\r |
271 | NOTE: The "*" symbol may be used as a wildcard character in most of these\r |
272 | fields, refer to the tools_def.txt and the "EDK II Build and Packaging\r |
273 | Architecture Specification" for more details.\r |
274 | \r |
275 | \r |
276 | -----------\r |
aa0bf4f4 |
277 | Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r |
13421853 |
278 | checkout the entire EDK II source tree.\r |
aa0bf4f4 |
279 | \r |
e3f236c8 |
280 | In a command window, change to the top level directory of the Edk II sources.\r |
aa0bf4f4 |
281 | Set the WORKSPACE environment variable, e.g.:\r |
282 | \r |
a032fb4d |
283 | c:\> set WORKSPACE=C:\MyWork\Edk2\r |
aa0bf4f4 |
284 | \r |
285 | To test your tool chain setup and to build the Supplied Tools, execute:\r |
a032fb4d |
286 | c:\MyWork\Edk2\> edksetup\r |
aa0bf4f4 |
287 | \r |
6132429e |
288 | On Unix systems you must source the edksetup.sh file to load the correct\r |
289 | settings into your shell.\r |
290 | \r |
291 | . edksetup.sh # Note the dot.\r |
292 | \r |
aa0bf4f4 |
293 | (This command will be referred to as the setup command throughout the rest of\r |
294 | this document.)\r |
295 | NOTE: You should run the setup command at the start of every session.\r |
296 | This configures the environment to include the TianoTools and the\r |
297 | Java applications and libraries.\r |
298 | \r |
a032fb4d |
299 | If you are confident that none of the tool tool sources have changed, and you\r |
300 | only want to set up the workspace environment you may execute:\r |
301 | c:\MyWork\Edk2\> edksetup skip\r |
302 | \r |
aa0bf4f4 |
303 | Once this is completed, you are ready to test the Build, by executing:\r |
a032fb4d |
304 | c:\MyWork\Edk2\> build\r |
aa0bf4f4 |
305 | \r |
e3f236c8 |
306 | This command builds active platform specified in text file target.txt. If \r |
307 | active platform is not specified, go to sub-directory which contains FPD files and\r |
308 | type build. More information about active platform policy reference to specification\r |
309 | <<EDK II Build and Packaging Architecture Specification>>.\r |
90f7b6a8 |
310 | \r |
aa0bf4f4 |
311 | -------------------------\r |
e3f236c8 |
312 | Individual Platform Builds\r |
aa0bf4f4 |
313 | -------------------------\r |
e3f236c8 |
314 | After running the setup command, you can build individual platforms.\r |
315 | In the command window, \r |
316 | 1. Set active platform in target.txt, and type "build" in whatever directory;\r |
317 | 2. or cd to the platform (FPD file) that you want to build, and just type:\r |
a032fb4d |
318 | c:\MyWork\Edk2\EdkNt32Pkg\> build\r |
e3f236c8 |
319 | \r |
320 | Note that active platform with the high priority to build, that means active \r |
321 | platform will be built even if exists FPD file under current directory. More \r |
322 | information about active platform policy reference to specification\r |
323 | <<EDK II Build and Packaging Architecture Specification>>. \r |
aa0bf4f4 |
324 | \r |
a032fb4d |
325 | Go to <full build path>\DEBUG\MSFT\IA32 and execute SecMain.exe\r |
e3f236c8 |
326 | to run the Nt32 emulation platform under Microsoft Windows.\r |
aa0bf4f4 |
327 | \r |
03fed93e |
328 | To exit the Nt32 emulation platform, you may type reset at the EFI Shell>\r |
329 | command prompt. Alternately, you may use the Graphical interface, Boot\r |
330 | Maintenance Manager screen's Reset System command.\r |
331 | \r |
aa0bf4f4 |
332 | ------------------------\r |
333 | Individual Module Builds\r |
334 | ------------------------\r |
335 | After running the setup command, you can build individual modules.\r |
336 | In the command window, cd to the module that you want to build, and just\r |
337 | type:\r |
a032fb4d |
338 | c:\MyWork\Edk2\MdePkg\Library\BaseLib\> build\r |
e3f236c8 |
339 | \r |
340 | Note active platform must be set for individual module build. \r |
aa0bf4f4 |
341 | \r |
342 | -------------------------------------------------------------------------------\r |
343 | A Word on Apache-ANT\r |
344 | --------------------\r |
345 | The Apache-ANT program is a build tool that uses XML-based project files.\r |
346 | Similar to Makefiles, these project files may contain multiple targets. Most\r |
a032fb4d |
347 | build.xml files in EDK II are auto-generated; any edits performed on the\r |
348 | build.xml files will be overwritten the next time build is executed.\r |
aa0bf4f4 |
349 | \r |
a032fb4d |
350 | Pre-defined targets in the build.xml file include:\r |
aa0bf4f4 |
351 | all - This target builds binaries for defined architectures\r |
352 | clean - This target removes object files generated by commands\r |
353 | cleanall - This target removes all generated files and directories.\r |
354 | \r |
355 | A Word on GCC tool chain\r |
356 | ------------------------\r |
a032fb4d |
357 | EDK II will not compile with a standard Linux gcc tool chain. While Linux\r |
358 | distributions are usually based on ELF, EDK II requires a version of gcc \r |
359 | that is configured to produce PE-COFF images. You will find a script in \r |
360 | edk2/Tools/gcc that will download, configure, compile, and install a gcc \r |
361 | 4.X cross-compile tool chain for EDK II development. It has support for \r |
362 | the IA32 architecture. It can be built and run on Cygwin, Linux, and many \r |
363 | other POSIX compliant host operating environments. There are a few tools\r |
364 | that you will need on your host computer in order to compile the tool \r |
365 | chain. Among them are bash, gcc, gmake, curl (or wget).\r |
aa0bf4f4 |
366 | \r |
367 | -------------------------------------------------------------------------------\r |
368 | \r |
369 | General Information:\r |
370 | =============================================================== \r |
371 | Mechanisms:\r |
372 | ----------\r |
8fb9e6b8 |
373 | A brief overview:\r |
aa0bf4f4 |
374 | \r |
375 | A) Surface Area Package Description (SPD) file contains information about the\r |
376 | modules that the package contains, including the location of all MSA files, and\r |
377 | public library names and headers that might be provided by a module in the\r |
378 | package. Packages are defined by SPD files. (Found in the root of the Package\r |
a032fb4d |
379 | subdirectory (i.e. EdkNt32Pkg)) The SPD is further explained in the "EDK Build \r |
380 | and Packaging Architecture Specification" document.\r |
aa0bf4f4 |
381 | \r |
382 | B) Module Surface Area Definition (MSA) files. A description of a module's \r |
383 | surface area, with all module specific default flags and features specified.\r |
384 | Refer to the "Module Surface Area Architecture Specification" for additional\r |
a032fb4d |
385 | details. The MSA is further explained in the "EDK II Build Packaging Architecture \r |
386 | Specification" document.\r |
387 | \r |
388 | C) Framework Platform Description (FPD) files. A description of a platform's\r |
389 | surface are, including a list of modules that are needed by the platform. To\r |
390 | support individual module builds, developers are not required to provide\r |
391 | information about specific flash devices, nor flash device layout. There are\r |
392 | specific sections in the FPD file that do control aspects of the build, such \r |
393 | as the Supported Architectures and Build Targets, as well as the tool flags \r |
394 | that are used to create the binary files. A valid platform file can specify \r |
395 | zero or more modules, so individual modules can be compiled within the context\r |
396 | of a platform (FPD) definition.\r |
397 | \r |
398 | D) Platform Configuration Database (PCD). A platform database which contains a\r |
aa0bf4f4 |
399 | variety of current platform settings or directives by which a driver or\r |
400 | application can interact with. The PCD is defined by the PCD_Protocol (This is\r |
401 | further explained in the "Platform Configuration Database Infrastructure \r |
402 | Description" document.\r |
403 | \r |
a032fb4d |
404 | E) Library Class. A library class is a logical grouping of similar functions.\r |
aa0bf4f4 |
405 | When developing components, the module surface area declares the class of\r |
a032fb4d |
406 | libraries that can be used by the component. The MSA and SPD files can specify\r |
407 | a recommended instance of the library that a platform integrator may select,\r |
408 | however this is only a recommendation. The PI may choose to select a different\r |
409 | library instance to be used during compilation/linking. All library type modules \r |
410 | must include header files in their distribution package, as well as their MSA\r |
411 | files. Components, on the other hand, need only provide an MSA and either source\r |
412 | or binary files when distributing packages. The Library Classes are further \r |
413 | explained in the "EDK II Build and Packaging Architecture Specification" \r |
414 | document.\r |
aa0bf4f4 |
415 | \r |
416 | =========================================================================\r |
417 | The common operations by developers of new modules are:\r |
418 | -------------------------------------------------------\r |
419 | \r |
420 | 1) How to manually create a new module in a package:\r |
421 | - The module source code must first be created in an appropriate directory\r |
422 | (under the package the module is to be a part of.) \r |
423 | - An MSA file must be created, spelling out all aspects of the module.\r |
424 | - The MSA must be added to the SPD for the package to include the module.\r |
425 | \r |
426 | -----------------------------------------\r |
427 | 2) Add/Remove module(s) to/from a package:\r |
428 | \r |
429 | - Setup environment as Build\r |
430 | - Add a module to a package\r |
e3f236c8 |
431 | * Generate the module SurfaceArea description file\r |
432 | * Add a new <Filename> element under <MsaFiles> into\r |
aa0bf4f4 |
433 | <PackageDir>\<PackageName>.spd, using relative path to package\r |
e3f236c8 |
434 | * Add a new <ModuleSA> entry under each <FrameworkModules> into\r |
435 | <PackageDir>\<PackageName>.fpd file if necessary. \r |
aa0bf4f4 |
436 | \r |
437 | - Remove a module from a package\r |
e3f236c8 |
438 | * Comment out or remove corresponding <Filename> element under <MsaFiles>\r |
aa0bf4f4 |
439 | from <PackageDir>\<PackageName>.spd\r |
440 | * Comment out or remove corresponding <ModuleSA> entry under each\r |
e3f236c8 |
441 | <FrameworkModules> from <PackageDir>\<PackageName>.fpd if necessary. \r |
aa0bf4f4 |
442 | \r |
443 | -----------------------------------\r |
444 | 3) How to manually create a package:\r |
445 | - Identify the modules that are to be members of the project.\r |
446 | - Identify the Variables and Guids required in and of the Package (including\r |
447 | consumption/production information).\r |
448 | - Create an SPD file defining these modules and calling out their MSA files.\r |
e3f236c8 |
449 | - add a new <Filename> element under <PackageList> into \r |
450 | Tools\Conf\FrameworkDatabase.db, using the relative path to workspace. \r |
aa0bf4f4 |
451 | \r |
452 | --------------------------------------\r |
453 | 4) Declare a new Protocol in a package: \r |
454 | - This release requires manual editing of the SPD file, adding the protocol\r |
455 | to the ProtocolDeclarations section of the file. \r |
456 | - Add the Protocol .h file to the Include\Protocol directory.\r |
64fcaead |
457 | - Add an <Entry> to the <ProtocolDeclarations> element in the \r |
458 | <PackageName>.spd file\r |
aa0bf4f4 |
459 | * Each line contains Protocol base name then the global variable name and\r |
460 | then the hex value of the Protocol GUID.\r |
461 | \r |
64fcaead |
462 | Example Protocol Entries (NOTE: The Guid entry is a single line in the SPD file):\r |
463 | <ProtocolDeclarations>\r |
e3f236c8 |
464 | <Entry Name="Bds">\r |
465 | <C_Name>gEfiBdsArchProtocolGuid</C_Name>\r |
466 | <GuidValue>665E3FF6-46CC-11D4-9A38-0090273FC14D</GuidValue>\r |
467 | <HelpText/>\r |
468 | </Entry>\r |
469 | <Entry Name="Cpu">\r |
470 | <C_Name>gEfiCpuArchProtocolGuid</C_Name>\r |
471 | <GuidValue>26BACCB1-6F42-11D4-BCE7-0080C73C8881</GuidValue>\r |
472 | <HelpText/>\r |
473 | </Entry>\r |
474 | </ProtocolDeclarations>\r |
aa0bf4f4 |
475 | \r |
476 | ---------------------------------\r |
477 | 5) Declare a new PPI in a package:\r |
478 | - This release requires manual editing of the SPD file\r |
479 | - Add the PPI .h file to the Include\Ppi directory.\r |
64fcaead |
480 | - Add an <Entry> to the package <PpiDeclarations> element in the \r |
481 | <PackageName>.spd file\r |
aa0bf4f4 |
482 | * Each line contains PPI base name then the global variable name and then\r |
483 | the hex value of the PPI GUID.\r |
484 | \r |
64fcaead |
485 | Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):\r |
486 | <PpiDeclarations>\r |
e3f236c8 |
487 | <Entry Name="BootInRecoveryMode">\r |
488 | <C_Name>gEfiPeiBootInRecoveryModePpiGuid</C_Name>\r |
489 | <GuidValue>17EE496A-D8E4-4B9A-94D1-CE8272300850</GuidValue>\r |
490 | <HelpText/>\r |
64fcaead |
491 | </Entry>\r |
e3f236c8 |
492 | <Entry Name="CpuIo">\r |
493 | <C_Name>gEfiPeiCpuIoPpiInServiceTableGuid</C_Name>\r |
494 | <GuidValue>E6AF1F7B-FC3F-46DA-A828-A3B457A44282</GuidValue>\r |
495 | <HelpText/>\r |
64fcaead |
496 | </Entry>\r |
497 | </PpiDeclarations>\r |
498 | \r |
aa0bf4f4 |
499 | ----------------------------------\r |
500 | 6) Declare a new GUID in a package:\r |
501 | - This release requires manual editing of the SPD file to include the new\r |
64fcaead |
502 | Guid. This is identical to adding a ProtocolDeclaration or PpiDeclaration\r |
503 | element as described above.\r |
aa0bf4f4 |
504 | \r |
505 | --------------------------------------- \r |
54c9f9ed |
506 | 7) Declare a new PCD entry in a package:\r |
aa0bf4f4 |
507 | - This release requires manual editing of the SPD file to include the new\r |
64fcaead |
508 | PCD. New Pcd entries are added to the PcdDefinitions section of the\r |
509 | <PackageName>.spd file using the following example for the format:\r |
510 | NOTE: The hex <Token> value must be unique.\r |
511 | \r |
54c9f9ed |
512 | <PcdDeclarations>\r |
64fcaead |
513 | <PcdEntry ItemType="FIXED_AT_BUILD">\r |
514 | <C_Name>PcdMaximumUnicodeStringLength</C_Name>\r |
515 | <Token>0x00000001</Token>\r |
54c9f9ed |
516 | <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r |
64fcaead |
517 | <DatumType>UINT32</DatumType>\r |
54c9f9ed |
518 | <ValidUsage>FIXED_AT_BUILD</ValidUsage>\r |
64fcaead |
519 | <DefaultValue>1000000</DefaultValue>\r |
54c9f9ed |
520 | <HelpText>The maximum lengh for unicode string.</HelpText>\r |
64fcaead |
521 | </PcdEntry>\r |
54c9f9ed |
522 | </PcdDeclarations>\r |
aa0bf4f4 |
523 | \r |
524 | ------------------------------\r |
525 | 8) Declare a new Library Class:\r |
526 | - This release requires manual editing of the SPD file to include the new\r |
64fcaead |
527 | Library Class. New Library Class entries are added to the \r |
528 | LibraryClassDeclarations seection of the <PackageName>.spd file using\r |
529 | the following example for the format:\r |
530 | \r |
531 | <LibraryClassDeclarations>\r |
e3f236c8 |
532 | <LibraryClass Name="BaseLib">\r |
64fcaead |
533 | <IncludeHeader>Include/Library/BaseLib.h</IncludeHeader>\r |
e3f236c8 |
534 | <HelpText/>\r |
535 | </LibraryClass>\r |
536 | <LibraryClass Name="BaseMemoryLib">\r |
537 | <IncludeHeader>Include/Library/BaseMemoryLib.h</IncludeHeader>\r |
538 | <HelpText/>\r |
539 | </LibraryClass>\r |
64fcaead |
540 | </LibraryClassDeclarations>\r |
aa0bf4f4 |
541 | \r |
aa0bf4f4 |
542 | =======================================================\r |
543 | Notes:\r |
544 | ------\r |
13421853 |
545 | The EDK II represents significant changes in the structure of the EDK.\r |
aa0bf4f4 |
546 | Therefore it is very difficult to isolate all of the changes of this version of\r |
547 | the EDK with the previous (EDK 1.0) version.\r |
548 | \r |
549 | Of particular note:\r |
550 | \r |
13421853 |
551 | 1) EDK II contains new hardware feature support for the ICH SMBUS Libraries.\r |
aa0bf4f4 |
552 | These libraries are provided to make Memory Reference Code (MRC) development\r |
553 | easier.\r |
1465cc8b |
554 | 2) The MDE Libraries - The MDE libraries represent significant changes in source\r |
aa0bf4f4 |
555 | (with only limited changes in functionality.) These new libraries conform\r |
556 | to the "MDE Library Specification". \r |
557 | 3) The Fat Binary and the EDK Shell Binary Packages are functionally identical\r |
558 | to the EDK 1.0 version.\r |
559 | 4) The EDK tools directory has been expanded to include more tools and more\r |
560 | tool functionality.\r |
561 | 5) The EDK NT32 section has been ported to the new build process, but\r |
562 | functionally remains the same as the EDK 1.0 version.\r |
13421853 |
563 | 6) The Application "HelloWorld" has been ported to EDK II as well.\r |
aa0bf4f4 |
564 | \r |
565 | =======================================================\r |
566 | Virus scanned by McAfee VirusScan Enterprise 8.0.0, Virus Definitions 4718, no\r |
567 | virus detected.\r |
568 | \r |