e4d8dbc9 |
1 | Intel(R) Platform Innovation Framework for EFI\r |
a64823fb |
2 | EFI Development Kit II (EDK II)\r |
caf30469 |
3 | 2010-03-31\r |
e4d8dbc9 |
4 | \r |
5 | Intel is a trademark or registered trademark of Intel Corporation or its\r |
6 | subsidiaries in the United States and other countries.\r |
7 | * Other names and brands may be claimed as the property of others.\r |
caf30469 |
8 | Copyright (c) 2007 - 2010, Intel Corporation All rights reserved.\r |
e4d8dbc9 |
9 | \r |
caf30469 |
10 | EDK II packages can be checked out from the following SVN address:\r |
11 | http://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2 \r |
e4d8dbc9 |
12 | \r |
caf30469 |
13 | The detailed introduction of these packages can be found in each package\r |
14 | description file. (The *.dec file under the package directory)\r |
1f4c44ad |
15 | \r |
e4d8dbc9 |
16 | \r |
17 | -------------------------------------------------------------------------------\r |
1f4c44ad |
18 | The most recent version of the setup instructions is available on the EDK II\r |
19 | web-site:\r |
caf30469 |
20 | http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=Step-by-step_instructions\r |
1f4c44ad |
21 | \r |
22 | \r |
23 | -------------------------------------------------------------------------------\r |
24 | Quick Start (Windows Development Platform)\r |
e4d8dbc9 |
25 | -----------\r |
26 | \r |
1f4c44ad |
27 | In a command prompt window, change to the top-level directory of the EDK II \r |
28 | source.\r |
e4d8dbc9 |
29 | \r |
1f4c44ad |
30 | Note:\r |
31 | The first time the edksetup script is executed, it creates three files in the\r |
32 | %WORKSPACE%\Conf directory. The files: tools_def.txt, target.txt and\r |
33 | build_rule.txt, are only created if they do not exist, if they exist, they\r |
34 | are not touched.\r |
35 | \r |
36 | First, set up your project workspace. If you have previously initialized this\r |
37 | WORKSPACE, and a newer version of the *.template files in\r |
38 | WORKSPACE\BaseTools\Conf exists, remove the *.txt files in the WORKSPACE\Conf\r |
39 | directory prior to running the edksetup script.\r |
40 | \r |
41 | For the reference build of the Nt32 Platform emulation environment, use the \r |
42 | edksetup.bat option: --nt32. For building other platforms or modules, this\r |
43 | option is not required, as Visual Studio standard includes, libraries and/or\r |
44 | dlls are not required for normal development.\r |
8014e7ce |
45 | \r |
46 | c:\MyWork\edk2\> edksetup --nt32\r |
e4d8dbc9 |
47 | \r |
1f4c44ad |
48 | The default tool chain (named MYTOOLS) is pre-configured to use VS2005 for IA32\r |
49 | and X64 target architectures and the DDK for IPF target architectures. To use a\r |
50 | different tool chain, either modify the tools_def.txt file's MYTOOLS entries,\r |
51 | or modify the %WORKSPACE%\Conf\target.txt file's TOOL_CHAIN_TAG. The pre-defined\r |
52 | tags are listed near the top of the %WORKSPACE%\Conf\tools_def.txt file, below\r |
53 | the Supported Tool Chains comment.\r |
54 | Alternatively, you may use the build command's -t option to specify a different\r |
55 | tool chain tag name: build -t VS2003 ... , for example. Using this method will\r |
56 | require that you always use the build command's -t option.\r |
57 | \r |
58 | \r |
59 | Next, go to the module directory and begin to build. This example is for the\r |
60 | HelloWorld application.\r |
61 | \r |
e4d8dbc9 |
62 | c:\MyWork\edk2\> cd MdeModulePkg\Application\HelloWorld\r |
63 | c:\MyWork\edk2\> build\r |
64 | \r |
1f4c44ad |
65 | If you want to build the a module in another package (for example, \r |
66 | MdePkg\Library\BaseLib\BaseLib.inf), please edit the file,\r |
67 | %WORKSPACE%\Conf\Target.txt, first.\r |
e4d8dbc9 |
68 | \r |
1f4c44ad |
69 | Change the following line\r |
e4d8dbc9 |
70 | ACTIVE_PLATFORM = MdeModulePkg/MdeModulePkg.dsc\r |
71 | to\r |
72 | ACTIVE_PLATFORM = MdePkg/MdePkg.dsc\r |
73 | \r |
1f4c44ad |
74 | Then go to MdePkg\Library\BaseLib directory and type build:\r |
e4d8dbc9 |
75 | c:\MyWork\edk2\> cd MdePkg\Library\BaseLib\r |
76 | c:\MyWork\edk2\> build\r |
77 | \r |
1f4c44ad |
78 | If you want build a platform, ACTIVE_PLATFORM must be set to your desired\r |
79 | platform dsc file, go to directory which must be not a module's directory, and\r |
80 | run "build" command.\r |
11dd6c39 |
81 | \r |
1f4c44ad |
82 | Instead of changing Target.txt, you can specify platform, module and/or\r |
83 | architecture on command line.\r |
183bc309 |
84 | For example, if you want to build NT32 platform, you can just type \r |
85 | \r |
1f4c44ad |
86 | c:\MyWork\edk2\> build -p Nt32Pkg\Nt32Pkg.dsc -a IA32\r |
183bc309 |
87 | \r |
88 | and if you want to build HelloWorld module, you can just type\r |
89 | \r |
1f4c44ad |
90 | c:\MyWork\edk2\> build -p Nt32Pkg\Nt32Pkg.dsc -a IA32 -m MdeModulePkg\Application\HelloWorld\HelloWorld.inf\r |
183bc309 |
91 | \r |
1f4c44ad |
92 | Other helpful command line options of build tool include "-v" and "-d".\r |
93 | The "-v" option is used to turn on the verbose build, which provide more\r |
94 | information during the build. "-d <debug level 0-9>" option is used to\r |
183bc309 |
95 | turn on the debug information which is helpful debugging build tools.\r |
96 | \r |
1f4c44ad |
97 | For more information on build options, please try "build -h" on command line.\r |
98 | \r |
99 | Note:\r |
100 | The Windows style help option "/?" is not a valid option for the build\r |
101 | command.\r |
183bc309 |
102 | \r |
103 | \r |
104 | -------------------------------------------------------------------------------\r |
105 | Supported build targets\r |
106 | -----------------------\r |
107 | \r |
0c71bc32 |
108 | all - Build whole platform or module. It can be ignored.\r |
109 | genc - Generate AutoGen.c, AutoGen.h and <ModuleName>.depex files only.\r |
110 | genmake - Generate makefiles in addition to files generated by "genc" target.\r |
183bc309 |
111 | clean - Clean intermediate files\r |
1f4c44ad |
112 | cleanall - Clean all generated files and directories during build, except the\r |
113 | generated Makefile files (top level and module makefiles)\r |
183bc309 |
114 | cleanlib - Clean all generated files and directories during library build\r |
0c71bc32 |
115 | run - Launch NT32 shell (only valid for NT32 platform)\r |
183bc309 |
116 | \r |
11dd6c39 |
117 | -------------------------------------------------------------------------------\r |
118 | Tools in Python\r |
119 | ---------------\r |
120 | \r |
121 | * Run buld tool written in Python from source\r |
1f4c44ad |
122 | The build tool written in Python can be executed from its source directly as\r |
123 | long as you have the Python interpreter (version 2.5) installed. The source\r |
124 | of Python code is locating at:\r |
125 | \r |
caf30469 |
126 | http://edk2-buildtools.svn.sourceforge.net/svnroot/edk2-buildtools/trunk/BaseTools\r |
1f4c44ad |
127 | \r |
128 | where:\r |
129 | \r |
130 | build/build.py - The entry tool of build tools\r |
1f4c44ad |
131 | \r |
132 | "build.py" steps:\r |
133 | 1. Run "edksetup.bat"\r |
134 | 2. set PYTHONPATH to the local directory of above source\r |
135 | (BaseTools/Source/Python)\r |
136 | 3. Set ACTIVE_PLATFORM in WORKSPACE\Conf\r |
137 | 4. Go to platform or module directory\r |
138 | 5. Run "<python_interpreter.exe> <python_source_dir>/build/build.py" or\r |
139 | "<python_source_dir>/build/build.py" directly.\r |
140 | \r |
11dd6c39 |
141 | * Convert Python source to exe file\r |
1f4c44ad |
142 | The tools written in Python can be coverted into executable program which can\r |
143 | be executed without Python interpreter. One of the conversion tools is called\r |
144 | cx_Freeze, available at: \r |
11dd6c39 |
145 | \r |
1f4c44ad |
146 | http://sourceforge.net/projects/cx-freeze/\r |
11dd6c39 |
147 | \r |
1f4c44ad |
148 | If you have installed cx_Freeze at c:\cx_Freeze-3.0.3. Use the following\r |
149 | command lines to convert MyBuild.py to a Windows executable.\r |
11dd6c39 |
150 | \r |
0c71bc32 |
151 | set PYTHONPATH=<buildtools>\BaseTools\Source\Python\r |
1f4c44ad |
152 | c:\cx_Freeze-3.0.3\FreezePython.exe --include-modules=encodings.cp437,encodings.gbk,encodings.utf_16,encodings.utf_8 --install-dir=.\mybuild MyBuild.py\r |
11dd6c39 |
153 | \r |
1f4c44ad |
154 | The generated .exe files are put in "mybuild" subdirectory.\r |
e4d8dbc9 |
155 | \r |