X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=BaseTools%2FReadMe.txt;h=be9ff2af856673b193e2e75d51a99f45438e06f9;hp=fb098902daea8be0d39264fb44d6e9238264dcf8;hb=3e1d93c32efc7d716baeaa0d5d0ef96528141060;hpb=6f5554bd58d3279422ed75f570f584d02ce14282 diff --git a/BaseTools/ReadMe.txt b/BaseTools/ReadMe.txt index fb098902da..be9ff2af85 100644 --- a/BaseTools/ReadMe.txt +++ b/BaseTools/ReadMe.txt @@ -1,95 +1,48 @@ This directory contains the next generation of EDK II build tools and template files. Templates are located in the Conf directory, while the tools executables for -Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory. +Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory, other +directory contatins tools source. -The binary tools will be updated only after passing developer testing. +1. Build step to generate the binary tools. -The BaseTools package will be updated with new tools only after all testing on a set -of binary tools has successfully completed. +=== Windows/Visual Studio Notes === -Current state of the tools is Proto-Type - not all tool functions have been implemented -and there may be bugs in these tools. These tools are under constant development at -this time. +To build the BaseTools, you should run the standard vsvars32.bat script +from your preferred Visual Studio installation or you can run get_vsvars.bat +to use latest automatically detected version. -BaseTools Simple Usage: -1) Change the directory to the EDK2 root directory, where the edksetup.bat is -2) Run "edksetup.bat NewBuild" -3) Set the ACTIVE_PLATFORM to your desired platform description file - (%WORKSPACE%\Conf\target.txt) -4) To build platform, run "build" command in non-module directory -5) To build module individually, run "build" command in module directory, i.e. where the - *.inf file is +In addition to this, you should set the following environment variables: -Notes: -1) Only *.efi files can be generated. Flash image cannot be generated at present. -2) Only "clean" and "cleanall" build target are supported, in both top level - makefile and module's makefile. -3) Not all tool chains and target architectures are tested. Due to both tools - and source code limitations, ther must be bugs in it. Please report any issue - ASAP so we can fix it soon. -4) The tree structure generated by build tools is similar to Ant build system. -5) Makefile can be called directly by nmake for both top level platform and module. But - after you call "nmake cleanall", you have to call "build" command to rebuild platform - or modules because the AutoGen.* files have been be removed. The "makefile" itself - cannot generate AutoGen.* files. Only "build" command can. + * EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree + * BASE_TOOLS_PATH - The directory where the BaseTools source is located. + (It is the same directory where this README.txt is located.) + * PYTHON_FREEZER_PATH - Path to where the python freezer tool is installed +After this, you can run the toolsetup.bat file, which is in the same +directory as this file. It should setup the remainder of the environment, +and build the tools if necessary. -Brief usage for Migration Tool MigrationMsa2Inf.exe: -1. Command line format: - MigrationMsa2Inf [options] -2. Input Files: - A syntactically valid MSA file -3. Output Files: - An extended INF file with possible auto-generated EntryPoint.c, CommonHeader.h/CommonHeader.txt, depending on options and module contents. -4. Prerequisite: - a. The workspace directory must be specified either by environment variable or -w option. - b. The Framework Database file must exist to specify the available packages in current workspace. - Two possible locations are: (The first location overrides the second) - $(WORKSPACE)\Tools\Conf\FrameworkDatabase.db - $(WORKSPACE)\Conf\FrameworkDatabase.db. - The field in FrameworkDatabase.db lists all available packages in current workspace. - One example: - - MdePkg/MdePkg.nspd - MdeModulePkg/MdeModulePkg.spd - IntelFrameworkPkg/IntelFrameworkPkg.spd - - The package list in FrameworkDatabase.db is important to the final quality of migration: - (1) It suggests the new package location: Translate package dependency Guid in MSA to Workspace relative path. - If the package dependency Guid cannot be found in current workspace a warning message is raised. - (2) It collects the Protocol/Guid/Ppi GuidCName a package contains. - The GuidCName acts as "clue" to add e.g. #include in CommonHeader.h - -5. Example: - WORKSAPCE has already been set: $(WORKSPACE) = c:\work\EdkII. - - a. MigrationMsa2Inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -o c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.inf - b. MigrationMsa2Inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -a - Example a & b are equivalent to migrate WinNtThunk driver from EDKII to EDKII' code base. - - c. MigrationMsa2Inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -a -c - The extra "-c" option performs several hardcode mapping due to the naming change in EDKII': - OldMdePkg Guid -> MdePkgGuid, - EdkModulePkg Guid -> MdeModulePkgGuid, - EdkGraphicsLib -> GraphicsLib - HiiLib -> HiiLibFramework - ... - - d. MigrationMsa2Inf -f c:\work\EdkII\Nt32Pkg\WinNtThunkDxe\WinNtThunk.msa -m - The extra "-m" option suppresses the generation of "CommonHeader.h" and leave all C files intact. - Instead, it generates "CommonHeader.txt". Developers can manually copy its content to a local common header file in a module. - -6. Known Limitations: - a. Tool does not handle Exit Boot Services Callback & Virtual Address Changed Event. Developers need to handle it manually. - b. The #include is based on library class naming convention: The header filename for "AbcLib" class are "AbcLib.h" by convention. - c. The #include , and are added based on gGuidCName listed in MSA. - If a GuidCName cannot map to a package Guid/Protocol/Ppi header file, a warning message is raised. - 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. - d. The [Depex] sections are generated from DXS files with Guid Macro translated to Guid CName by naming convention, etc. - If tool fails to "guess" the Guid CName from Guid Macro, it will leave the GuidMacro in [Depex] section for manual resolution. - e. When tool generates [Sources] section, the modifiers for source files are lost. (Need to add proper tool chain, etc) - f. When tool generates [LibraryClasses] section, the recommended library instances are lost. (No impact to build) - +Please also refer to the 'BuildNotes.txt' file for more information on +building under Windows. - -13-August-2007 +=== Unix-like operating systems === + +To build on Unix-like operating systems, you only need to type 'make' in +the base directory of the project. + +=== Ubuntu Notes === + +On Ubuntu, the following command should install all the necessary build +packages to build all the C BaseTools: + + sudo apt-get install build-essential uuid-dev + +=== Python sqlite3 module === +On Windows, the cx_freeze will not copy the sqlite3.dll to the frozen +binary directory (the same directory as build.exe and GenFds.exe). +Please copy it manually from \DLLs. + +The Python distributed with most recent Linux will have sqlite3 module +built in. If not, please install sqlit3 package separately. + +26-OCT-2011