07a756b9 |
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 |
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 |
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 |
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 |
fba25bdd |
29 | 3) All .exe binary file including C and python tools are generated from:\r |
30 | r1623 <buildtools_project>\BaseTools\Source\Python\\r |
07a756b9 |
31 | \r |
32 | Brief usage for Migration Tool MigrationMsa2Inf.exe:\r |
33 | 1. Command line format:\r |
34 | MigrationMsa2Inf [options]\r |
35 | 2. Input Files:\r |
36 | A syntactically valid MSA file\r |
37 | 3. Output Files:\r |
38 | An extended INF file with possible auto-generated EntryPoint.c, CommonHeader.h/CommonHeader.txt, depending on options and module contents.\r |
39 | 4. Prerequisite:\r |
40 | a. The workspace directory must be specified either by environment variable or -w option. \r |
41 | b. The Framework Database file must exist to specify the available packages in current workspace. \r |
42 | Two possible locations are: (The first location overrides the second)\r |
43 | $(WORKSPACE)\Tools\Conf\FrameworkDatabase.db\r |
44 | $(WORKSPACE)\Conf\FrameworkDatabase.db. \r |
45 | The <PackageList> field in FrameworkDatabase.db lists all available packages in current workspace. \r |
46 | One example:\r |
47 | <PackageList>\r |
48 | <Filename>MdePkg/MdePkg.nspd</Filename>\r |
49 | <Filename>MdeModulePkg/MdeModulePkg.spd</Filename>\r |
50 | <Filename>IntelFrameworkPkg/IntelFrameworkPkg.spd</Filename>\r |
51 | </PackageList>\r |
52 | The package list in FrameworkDatabase.db is important to the final quality of migration:\r |
53 | (1) It suggests the new package location: Translate package dependency Guid in MSA to Workspace relative path. \r |
54 | If the package dependency Guid cannot be found in current workspace a warning message is raised. \r |
55 | (2) It collects the Protocol/Guid/Ppi GuidCName a package contains. \r |
56 | The GuidCName acts as "clue" to add e.g. #include <Protocol/DiskIo.h> in CommonHeader.h\r |
57 | \r |
58 | 5. Example:\r |
59 | WORKSAPCE has already been set: $(WORKSPACE) = c:\work\EdkII. \r |
60 | \r |
61 | a. MigrationMsa2Inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -o c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.inf\r |
62 | b. MigrationMsa2Inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -a\r |
63 | Example a & b are equivalent to migrate WinNtThunk driver from EDKII to EDKII' code base.\r |
64 | \r |
65 | c. MigrationMsa2Inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -a -c\r |
66 | The extra "-c" option performs several hardcode mapping due to the naming change in EDKII': \r |
67 | OldMdePkg Guid -> MdePkgGuid, \r |
68 | EdkModulePkg Guid -> MdeModulePkgGuid, \r |
69 | EdkGraphicsLib -> GraphicsLib\r |
70 | HiiLib -> HiiLibFramework\r |
71 | ...\r |
72 | \r |
73 | d. MigrationMsa2Inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -m\r |
74 | The extra "-m" option suppresses the generation of "CommonHeader.h" and leave all C files intact. \r |
75 | Instead, it generates "CommonHeader.txt". Developers can manually copy its content to a local common header file in a module. \r |
76 | \r |
77 | 6. Known Limitations:\r |
78 | a. Tool does not handle Exit Boot Services Callback & Virtual Address Changed Event. Developers need to handle it manually.\r |
79 | 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 |
80 | c. The #include <Guid/Xyz.h>, <Protocol/Xyz.h> and <Ppi/Xyz.h> are added based on gGuidCName listed in MSA. \r |
81 | If a GuidCName cannot map to a package Guid/Protocol/Ppi header file, a warning message is raised.\r |
82 | 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 |
83 | d. The [Depex] sections are generated from DXS files with Guid Macro translated to Guid CName by naming convention, etc.\r |
84 | If tool fails to "guess" the Guid CName from Guid Macro, it will leave the GuidMacro in [Depex] section for manual resolution.\r |
85 | e. When tool generates [Sources] section, the modifiers for source files are lost. (Need to add proper tool chain, etc)\r |
86 | f. When tool generates [LibraryClasses] section, the recommended library instances are lost. (No impact to build)\r |
87 | \r |
88 | 7. Pyton Source\r |
89 | r682 <buildtools_project>\BaseTools\Source\Python\MigrationMsa2Inf\r |
90 | \r |
91 | \r |
92 | Brief Usage for PcdSyntax Update:\r |
93 | Usage:\r |
94 | PcdSyntaxUpdate.exe <directory_name>\r |
95 | It searches all INF, DEC and DSC file under <directory_name> and update them with the following rules:\r |
96 | 1. Update INF files to conform to INF spec 0.44: \r |
97 | a. Rename PCD section name: e.g. [PcdsFeatureFlag] -> [FeaturePcd]\r |
98 | b. Adjust PCD section item format: e.g. PcdDebugClearMemoryValue|gEfiMdePkgTokenSpaceGuid -> gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue\r |
99 | c. Update the syntax of binary INF file (not PCD related) \r |
100 | 2. Update DEC files to confirm to DEC spec 0.36\r |
101 | Adjust PCD section item format: e.g. PcdWinNtPhysicalDisk|0x00001000|gEfiNt32PkgTokenSpaceGuid|VOID*|L"E:RW;245760;512"-> gEfiNt32PkgTokenSpaceGuid.PcdWinNtFlashFvRecoverySize|0x0|UINT32|0x00001011\r |
102 | 3. Update DSC files to confirm to DSC spec \r |
103 | a. Adjust string/array typed PCD item format: e.g. PcdWinNtMemorySizeForSecMain|gEfiNt32PkgTokenSpaceGuid|L"64!64"|12 -> gEfiNt32PkgTokenSpaceGuid.PcdWinNtMemorySizeForSecMain|L"64!64"|VOID*|12\r |
104 | b. Adjust non-string/array typed PCD item format: e.g. PcdWinNtBootMode|gEfiNt32PkgTokenSpaceGuid|1 -> gEfiNt32PkgTokenSpaceGuid.PcdWinNtBootMode|1\r |
105 | c. Update the override library class in [Components] section: e.g.\r |
106 | <LibraryClass> {\r |
107 | PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf\r |
108 | }\r |
109 | To \r |
110 | <LibraryClasses> {\r |
111 | PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf\r |
112 | }\r |
113 | \r |
114 | Brief usage for Migration Tool Spd2Dec.exe:\r |
115 | 1. Command line format:\r |
116 | Spd2Dec [options] input_filename\r |
117 | 2. Input File:\r |
118 | A syntactically valid SPD file\r |
119 | 3. Output Files:\r |
120 | A DEC file whose syntax confirms to DEC spec.\r |
121 | \r |
122 | 4. Example:\r |
123 | a. Spd2Dec -o c:\work\EdkII\Nt32Pkg\Nt32.spd c:\work\EdkII\Nt32Pkg\Nt32.dec\r |
124 | b. Spd2Dec -a c:\work\EdkII\Nt32Pkg\Nt32.spd\r |
125 | Example a & b are equivalent to migrate Nt32 package SPD file from EDKII to EDKII' snytax.\r |
126 | \r |
127 | 6. Pyton Source\r |
128 | r777 <buildtools_project>\BaseTools\Source\Python\spd2Dec\r |
129 | \r |
130 | Brief usage for Migration Tool Fpd2Dsc.exe:\r |
131 | 1. Command line format:\r |
132 | Fpd2Dsc [options] input_filename\r |
133 | 2. Input File:\r |
134 | A syntactically valid FPD file\r |
135 | 3. Output Files:\r |
136 | A DSC file which syntax confirms to DSC spec.\r |
137 | 4. Prerequisite:\r |
138 | a. The workspace directory must be specified either by environment variable or -w option.\r |
139 | \r |
140 | 5. Example:\r |
141 | WORKSAPCE has already been set: $(WORKSPACE) = c:\work\EdkII. \r |
142 | \r |
143 | a. Fpd2Dsc -o c:\work\EdkII\Nt32Pkg\Nt32.dsc c:\work\EdkII\Nt32Pkg\Nt32.fpd\r |
144 | b. Fpd2Dsc -a c:\work\EdkII\Nt32Pkg\Nt32.fpd\r |
145 | Example a & b are equivalent to migrate Nt32 platform description file from EDKII to EDKII' snytax.\r |
146 | \r |
147 | 6. Known Limitations:\r |
148 | a. Tool does not handle Libraries Section since no related info in original FPD file. Developers need to handle it manually in the output DSC file.\r |
149 | b. If MSA file which is corresponds to module guid could not be found in currect workspace, tool will dump the module guid.\r |
150 | \r |
151 | 7. Pyton Source\r |
152 | r767 <buildtools_project>\BaseTools\Source\Python\Fpd2Dsc\r |
153 | \r |
154 | 27-September-2007\r |