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