and there may be bugs in these tools. These tools are under constant development at\r
this time.\r
\r
-20-Jun-2007\r
+BaseTools Simple Usage:\r
+1) Change the directory to the EDK2 root directory, where the edksetup.bat is\r
+2) Run "edksetup.bat NewBuild"\r
+3) Set the ACTIVE_PLATFORM to your desired platform description file \r
+ (%WORKSPACE%\Conf\target.txt)\r
+4) To build platform, run "build" command in non-module directory\r
+5) To build module individually, run "build" command in module directory, i.e. where the \r
+ *.inf file is\r
+\r
+Notes:\r
+1) Only *.efi files can be generated. Flash image cannot be generated at present.\r
+2) Only "clean" and "cleanall" build target are supported, in both top level \r
+ makefile and module's makefile. \r
+3) Not all tool chains and target architectures are tested. Due to both tools \r
+ and source code limitations, ther must be bugs in it. Please report any issue \r
+ ASAP so we can fix it soon.\r
+4) The tree structure generated by build tools is similar to Ant build system.\r
+5) Makefile can be called directly by nmake for both top level platform and module. But\r
+ after you call "nmake cleanall", you have to call "build" command to rebuild platform\r
+ or modules because the AutoGen.* files have been be removed. The "makefile" itself\r
+ cannot generate AutoGen.* files. Only "build" command can.\r
+\r
+\r
+Brief usage for Module Migration Tool msa2inf.exe:\r
+1. Command line format:\r
+ msa2inf [options]\r
+2. Input Files:\r
+ A syntactically valid MSA file\r
+3. Output Files:\r
+ An extended INF file with possible auto-generated EntryPoint.c, CommonHeader.h/CommonHeader.txt, depending on options and module contents.\r
+4. Prerequisite:\r
+ a. The workspace directory must be specified either by environment variable or -w option. \r
+ b. The Framework Database file must exist to specify the available packages in current workspace. \r
+ Two possible locations are: (The first location overrides the second)\r
+ $(WORKSPACE)\Tools\Conf\FrameworkDatabase.db\r
+ $(WORKSPACE)\Conf\FrameworkDatabase.db. \r
+ The <PackageList> field in FrameworkDatabase.db lists all available packages in current workspace. \r
+ One example:\r
+ <PackageList>\r
+ <Filename>MdePkg/MdePkg.nspd</Filename>\r
+ <Filename>MdeModulePkg/MdeModulePkg.spd</Filename>\r
+ <Filename>IntelFrameworkPkg/IntelFrameworkPkg.spd</Filename>\r
+ </PackageList>\r
+ The package list in FrameworkDatabase.db is important to the final quality of migration:\r
+ (1) It suggests the new package location: Translate package dependency Guid in MSA to Workspace relative path. \r
+ If the package dependency Guid cannot be found in current workspace a warning message is raised. \r
+ (2) It collects the Protocol/Guid/Ppi GuidCName a package contains. \r
+ The GuidCName acts as "clue" to add e.g. #include <Protocol/DiskIo.h> in CommonHeader.h\r
+ \r
+5. Example:\r
+ WORKSAPCE has already been set: $(WORKSPACE) = c:\work\EdkII. \r
+ \r
+ a. msa2inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -o c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.inf\r
+ b. msa2inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -a\r
+ Example a & b are equivalent to migrate WinNtThunk driver from EDKII to EDKII' code base.\r
+ \r
+ c. msa2inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -a -c\r
+ The extra "-c" option performs several hardcode mapping due to the naming change in EDKII': \r
+ OldMdePkg Guid -> MdePkgGuid, \r
+ EdkModulePkg Guid -> MdeModulePkgGuid, \r
+ EdkGraphicsLib -> GraphicsLib\r
+ HiiLib -> HiiLibFramework\r
+ ...\r
+ \r
+ d. msa2inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -m\r
+ The extra "-m" option suppresses the generation of "CommonHeader.h" and leave all C files intact. \r
+ Instead, it generates "CommonHeader.txt". Developers can manually copy its content to a local common header file in a module. \r
+ \r
+6. Known Limitations:\r
+ a. Tool does not handle Exit Boot Services Callback & Virtual Address Changed Event. Developers need to handle it manually.\r
+ 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
+ c. The #include <Guid/Xyz.h>, <Protocol/Xyz.h> and <Ppi/Xyz.h> are added based on gGuidCName listed in MSA. \r
+ If a GuidCName cannot map to a package Guid/Protocol/Ppi header file, a warning message is raised.\r
+ 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
+ d. The [Depex] sections are generated from DXS files with Guid Macro translated to Guid CName by naming convention, etc.\r
+ If tool fails to "guess" the Guid CName from Guid Macro, it will leave the GuidMacro in [Depex] section for manual resolution.\r
+ e. When tool generates [Sources] section, the modifiers for source files are lost. (Need to add proper tool chain, etc)\r
+ f. When tool generates [LibraryClasses] section, the recommended library instances are lost. (No impact to build)\r
+ \r
+\r
+ \r
+13-August-2007\r
projects / mirror_edk2.git / blobdiff