]>
Commit | Line | Data |
---|---|---|
53ca26a2 | 1 | This directory contains the next generation of EDK II build tools and template files.\r |
2 | Templates are located in the Conf directory, while the tools executables for\r | |
3 | Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory.\r | |
4 | \r | |
5 | The binary tools will be updated only after passing developer testing.\r | |
6 | \r | |
7 | The BaseTools package will be updated with new tools only after all testing on a set\r | |
8 | of binary tools has successfully completed.\r | |
9 | \r | |
10 | Current state of the tools is Proto-Type - not all tool functions have been implemented\r | |
11 | and there may be bugs in these tools. These tools are under constant development at\r | |
12 | this time.\r | |
13 | \r | |
c7f7ef1e | 14 | BaseTools Simple Usage:\r |
15 | 1) Change the directory to the EDK2 root directory, where the edksetup.bat is\r | |
16 | 2) Run "edksetup.bat NewBuild"\r | |
17 | 3) Set the ACTIVE_PLATFORM to your desired platform description file \r | |
18 | (%WORKSPACE%\Conf\target.txt)\r | |
19 | 4) To build platform, run "build" command in non-module directory\r | |
20 | 5) To build module individually, run "build" command in module directory, i.e. where the \r | |
21 | *.inf file is\r | |
22 | \r | |
23 | Notes:\r | |
5157f1d7 | 24 | 1) The tree structure generated by build tools is similar to Ant build system.\r |
25 | 2) Makefile can be called directly by nmake for both top level platform and module. But\r | |
c7f7ef1e | 26 | after you call "nmake cleanall", you have to call "build" command to rebuild platform\r |
27 | or modules because the AutoGen.* files have been be removed. The "makefile" itself\r | |
28 | cannot generate AutoGen.* files. Only "build" command can.\r | |
5157f1d7 | 29 | 3) build.exe in %WORKSPACE%\BaseTools\Bin\Win32 is generated from following revision of\r |
30 | Python source code:\r | |
4a8f7cce | 31 | r620 <buildtools_project>\BaseTools\Source\Python\Autogen\r |
5157f1d7 | 32 | r601 <buildtools_project>\BaseTools\Source\Python\Python\build\r |
33 | r569 <buildtools_project>\BaseTools\Source\Python\Python\Common\r | |
34 | r564 <buildtools_project>\BaseTools\Source\Python\Python\CommonDataClass\r | |
2b3b50f9 | 35 | \r |
6f5554bd | 36 | Brief usage for Migration Tool MigrationMsa2Inf.exe:\r |
2b3b50f9 | 37 | 1. Command line format:\r |
6f5554bd | 38 | MigrationMsa2Inf [options]\r |
2b3b50f9 | 39 | 2. Input Files:\r |
40 | A syntactically valid MSA file\r | |
41 | 3. Output Files:\r | |
42 | An extended INF file with possible auto-generated EntryPoint.c, CommonHeader.h/CommonHeader.txt, depending on options and module contents.\r | |
43 | 4. Prerequisite:\r | |
dfb780e3 | 44 | a. The workspace directory must be specified either by environment variable or -w option. \r |
2b3b50f9 | 45 | b. The Framework Database file must exist to specify the available packages in current workspace. \r |
46 | Two possible locations are: (The first location overrides the second)\r | |
47 | $(WORKSPACE)\Tools\Conf\FrameworkDatabase.db\r | |
48 | $(WORKSPACE)\Conf\FrameworkDatabase.db. \r | |
49 | The <PackageList> field in FrameworkDatabase.db lists all available packages in current workspace. \r | |
50 | One example:\r | |
51 | <PackageList>\r | |
52 | <Filename>MdePkg/MdePkg.nspd</Filename>\r | |
53 | <Filename>MdeModulePkg/MdeModulePkg.spd</Filename>\r | |
54 | <Filename>IntelFrameworkPkg/IntelFrameworkPkg.spd</Filename>\r | |
55 | </PackageList>\r | |
56 | The package list in FrameworkDatabase.db is important to the final quality of migration:\r | |
57 | (1) It suggests the new package location: Translate package dependency Guid in MSA to Workspace relative path. \r | |
58 | If the package dependency Guid cannot be found in current workspace a warning message is raised. \r | |
59 | (2) It collects the Protocol/Guid/Ppi GuidCName a package contains. \r | |
60 | The GuidCName acts as "clue" to add e.g. #include <Protocol/DiskIo.h> in CommonHeader.h\r | |
61 | \r | |
62 | 5. Example:\r | |
63 | WORKSAPCE has already been set: $(WORKSPACE) = c:\work\EdkII. \r | |
64 | \r | |
6f5554bd | 65 | a. MigrationMsa2Inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -o c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.inf\r |
66 | b. MigrationMsa2Inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -a\r | |
2b3b50f9 | 67 | Example a & b are equivalent to migrate WinNtThunk driver from EDKII to EDKII' code base.\r |
68 | \r | |
6f5554bd | 69 | c. MigrationMsa2Inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -a -c\r |
dfb780e3 | 70 | The extra "-c" option performs several hardcode mapping due to the naming change in EDKII': \r |
2b3b50f9 | 71 | OldMdePkg Guid -> MdePkgGuid, \r |
72 | EdkModulePkg Guid -> MdeModulePkgGuid, \r | |
73 | EdkGraphicsLib -> GraphicsLib\r | |
74 | HiiLib -> HiiLibFramework\r | |
75 | ...\r | |
76 | \r | |
6f5554bd | 77 | d. MigrationMsa2Inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -m\r |
2b3b50f9 | 78 | The extra "-m" option suppresses the generation of "CommonHeader.h" and leave all C files intact. \r |
79 | Instead, it generates "CommonHeader.txt". Developers can manually copy its content to a local common header file in a module. \r | |
80 | \r | |
81 | 6. Known Limitations:\r | |
dfb780e3 | 82 | a. Tool does not handle Exit Boot Services Callback & Virtual Address Changed Event. Developers need to handle it manually.\r |
2b3b50f9 | 83 | b. The #include <Library/AbcLib.h> is based on library class naming convention: The header filename for "AbcLib" class are "AbcLib.h" by convention.\r |
84 | c. The #include <Guid/Xyz.h>, <Protocol/Xyz.h> and <Ppi/Xyz.h> are added based on gGuidCName listed in MSA. \r | |
85 | If a GuidCName cannot map to a package Guid/Protocol/Ppi header file, a warning message is raised.\r | |
86 | If a module uses the definition in a pakcage Guid/Protocol/Ppi header file without list its associative GuidCName, the build will beak. Developer needs to manually add the include statement.\r | |
87 | d. The [Depex] sections are generated from DXS files with Guid Macro translated to Guid CName by naming convention, etc.\r | |
88 | If tool fails to "guess" the Guid CName from Guid Macro, it will leave the GuidMacro in [Depex] section for manual resolution.\r | |
89 | e. When tool generates [Sources] section, the modifiers for source files are lost. (Need to add proper tool chain, etc)\r | |
90 | f. When tool generates [LibraryClasses] section, the recommended library instances are lost. (No impact to build)\r | |
91 | \r | |
92 | \r | |
93 | \r | |
5157f1d7 | 94 | 20-August-2007\r |