Meta-data reviewed.

[mirror_edk2.git] / BaseTools / toolsetup.bat

@REM @file\r
@REM   This stand-alone program is typically called by the edksetup.bat file, \r
@REM   however it may be executed directly from the BaseTools project folder\r
@REM   if the file is not executed within a WORKSPACE\BaseTools folder.\r
@REM\r
@REM Copyright (c) 2006 - 2008, Intel Corporation.  All rights reserved.\r
@REM\r
@REM This program and the accompanying materials are licensed and made available\r
@REM under the terms and conditions of the BSD Licensewhich accompanies this \r
@REM distribution.  The full text of the license may be found at:\r
@REM   http://opensource.org/licenses/bsd-license.php\r
@REM\r
@REM THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
@REM WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR \r
@REM IMPLIED.\r
@REM\r
\r
@echo off\r
pushd .\r
\r
@REM ##############################################################\r
@REM # You should not have to modify anything below this line\r
@REM #\r
\r
@if /I "%1"=="-h" goto Usage\r
@if /I "%1"=="-help" goto Usage\r
@if /I "%1"=="--help" goto Usage\r
@if /I "%1"=="/h" goto Usage\r
@if /I "%1"=="/help" goto Usage\r
@if /I "%1"=="/?" goto Usage\r
\r
\r
:loop\r
  @if "%1"=="" goto setup_workspace\r
  @if /I "%1"=="--nt32" (\r
    @REM Ignore --nt32 flag\r
    shift\r
    goto loop\r
  )\r
  @if /I "%1"=="Reconfig" (\r
    shift\r
    set RECONFIG=TRUE\r
    goto loop\r
  )\r
  @if /I "%1"=="Rebuild" (\r
    shift\r
    set REBUILD=TRUE\r
    goto loop\r
  )\r
  @if /I "%1"=="ForceRebuild" (\r
    shift\r
    set FORCE_REBUILD=TRUE\r
    goto loop\r
  )\r
  if "%1"=="" goto setup_workspace\r
  if exist %1 (\r
    if not defined BASE_TOOLS_PATH (\r
      if exist %1\Source set BASE_TOOLS_PATH=%1\r
      shift\r
      goto loop\r
    )\r
    if not defined EDK_TOOLS_PATH (\r
      if exist %1\Bin\Win32 set EDK_TOOLS_PATH=%1\r
      shift\r
      goto loop\r
    )\r
    echo.\r
    echo !!! ERROR !!! Unknown argument, %1 !!!\r
    echo.\r
    goto end\r
  ) else (\r
    echo.\r
    echo !!! ERROR !!! Unknown argument, %1 !!!\r
    echo.\r
    goto end\r
  )\r
  goto loop\r
\r
\r
@REM\r
@REM Check the required system environment variables\r
@REM\r
\r
:setup_workspace\r
  REM\r
  REM check the EDK_TOOLS_PATH\r
  REM\r
  if not defined EDK_TOOLS_PATH goto no_EDK_TOOLS_PATH\r
  if exist %EDK_TOOLS_PATH% goto set_PATH\r
\r
:no_EDK_TOOLS_PATH\r
  if not defined WORKSPACE (\r
    if defined BASE_TOOLS_PATH (\r
      set EDK_TOOLS_PATH=%BASE_TOOLS_PATH%\r
      goto set_PATH\r
    ) else (\r
      echo.\r
      echo !!! ERROR !!! Neither BASE_TOOLS_PATH nor EDK_TOOLS_PATH are set. !!!\r
      echo.\r
      goto end\r
    )\r
  ) else (\r
    if exist %WORKSPACE%\BaseTools\Bin (\r
      set EDK_TOOLS_PATH=%WORKSPACE%\BaseTools\r
      goto set_PATH\r
    ) else (\r
      echo.\r
      echo !!! ERROR !!! No tools path available. Please set EDK_TOOLS_PATH !!!\r
      echo.\r
      goto end\r
    )\r
  )\r
\r
:set_PATH\r
  if defined WORKSPACE_TOOLS_PATH goto check_PATH\r
  set PATH=%EDK_TOOLS_PATH%\Bin;%EDK_TOOLS_PATH%\Bin\Win32;%PATH%\r
  set WORKSPACE_TOOLS_PATH=%EDK_TOOLS_PATH%\r
  goto PATH_ok\r
\r
:check_PATH\r
  if "%EDK_TOOLS_PATH%"=="%WORKSPACE_TOOLS_PATH%" goto PATH_ok\r
  set PATH=%EDK_TOOLS_PATH%\Bin;%EDK_TOOLS_PATH%\Bin\Win32;%PATH%\r
  set WORKSPACE_TOOLS_PATH=%EDK_TOOLS_PATH%\r
  echo Resetting the PATH variable to include the EDK_TOOLS_PATH for this session.\r
\r
:PATH_ok\r
  echo           PATH      = %PATH%\r
  echo.\r
  if defined WORKSPACE (\r
    echo      WORKSPACE      = %WORKSPACE%\r
  )\r
  echo EDK_TOOLS_PATH      = %EDK_TOOLS_PATH%\r
  if defined BASE_TOOLS_PATH (\r
    echo BASE_TOOLS_PATH     = %BASE_TOOLS_PATH%\r
  )\r
  echo.\r
\r
REM\r
REM copy *.template to %WORKSPACE%\Conf\r
REM\r
if not defined WORKSPACE (\r
   if defined RECONFIG (\r
     echo.\r
     echo !!! WARNING !!! WORKSPACE environment variable was not set, cannot Reconfig !!!\r
     echo.\r
   )\r
   goto skip_reconfig\r
)\r
\r
if NOT exist %WORKSPACE%\Conf (\r
  mkdir %WORKSPACE%\Conf\r
) else (\r
  if defined RECONFIG (\r
    echo.\r
    echo  Over-writing the files in the WORKSPACE\Conf directory\r
    echo  using the default template files\r
    echo.\r
  )\r
)\r
\r
if NOT exist %WORKSPACE%\Conf\FrameworkDatabase.db (\r
  if defined RECONFIG echo copying ... FrameworkDatabase.template to %WORKSPACE%\Conf\FrameworkDatabase.db\r
  copy %EDK_TOOLS_PATH%\Conf\FrameworkDatabase.template %WORKSPACE%\Conf\FrameworkDatabase.db > nul\r
) else (\r
  if defined RECONFIG echo over-write ... FrameworkDatabase.template to %WORKSPACE%\Conf\FrameworkDatabase.db\r
  if defined RECONFIG copy /Y %EDK_TOOLS_PATH%\Conf\FrameworkDatabase.template %WORKSPACE%\Conf\FrameworkDatabase.db > nul\r
)\r
\r
if NOT exist %WORKSPACE%\Conf\target.txt (\r
  echo copying ... target.template to %WORKSPACE%\Conf\target.txt\r
  copy %EDK_TOOLS_PATH%\Conf\target.template %WORKSPACE%\Conf\target.txt > nul\r
) else (\r
  if defined RECONFIG echo over-write ... target.template to %WORKSPACE%\Conf\target.txt\r
  if defined RECONFIG copy /Y %EDK_TOOLS_PATH%\Conf\target.template %WORKSPACE%\Conf\target.txt > nul\r
)\r
\r
if NOT exist %WORKSPACE%\Conf\tools_def.txt (\r
  echo copying ... tools_def.template to %WORKSPACE%\Conf\tools_def.txt\r
  copy %EDK_TOOLS_PATH%\Conf\tools_def.template %WORKSPACE%\Conf\tools_def.txt > nul\r
) else (\r
  if defined RECONFIG echo over-write ... tools_def.template to %WORKSPACE%\Conf\tools_def.txt\r
  if defined RECONFIG copy /Y %EDK_TOOLS_PATH%\Conf\tools_def.template %WORKSPACE%\Conf\tools_def.txt > nul\r
)\r
\r
if NOT exist %WORKSPACE%\Conf\build_rule.txt (\r
  echo copying ... build_rule.template to %WORKSPACE%\Conf\build_rule.txt\r
  copy %EDK_TOOLS_PATH%\Conf\build_rule.template %WORKSPACE%\Conf\build_rule.txt > nul\r
) else (\r
  if defined RECONFIG echo over-write ... build_rule.template to %WORKSPACE%\Conf\build_rule.txt\r
  if defined RECONFIG copy /Y %EDK_TOOLS_PATH%\Conf\build_rule.template %WORKSPACE%\Conf\build_rule.txt > nul\r
)\r
\r
:skip_reconfig\r
\r
@REM\r
@REM Test if we are going to have to do a build\r
@REM\r
if defined FORCE_REBUILD goto check_build_environment\r
if defined REBUILD goto check_build_environment\r
if not exist "%EDK_TOOLS_PATH%\Bin" goto check_build_environment\r
\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\BootSectImage.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\build.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\EfiLdrImage.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\EfiRom.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\GenBootSector.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\GenFds.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\GenFfs.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\GenFv.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\GenFw.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\GenPage.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\GenSec.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\GenVtf.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\MigrationMsa2Inf.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\Split.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\TargetTool.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\TianoCompress.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\Trim.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\VfrCompile.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\Fpd2Dsc.exe" goto check_build_environment\r
IF NOT EXIST "%EDK_TOOLS_PATH%\Bin\Win32\VolInfo.exe" goto check_build_environment\r
\r
goto end\r
\r
:check_build_environment\r
\r
  if not defined FORCE_REBUILD (\r
    echo.\r
    echo Rebuilding of tools is not required.  Binaries of the latest,\r
    echo tested versions of the tools have been tested and included in the\r
    echo EDK II repository.\r
    echo.\r
    echo If you really want to build the tools, use the ForceRebuild option.\r
    echo.\r
    goto end\r
  )\r
\r
  if not defined BASE_TOOLS_PATH (\r
     if not exist "Source\C\Makefile" (\r
       if not exist "%EDK_TOOLS_PATH%\Source\C\Makefile" goto no_source_files\r
       set BASE_TOOLS_PATH=%EDK_TOOLS_PATH%\r
     ) else (\r
       set BASE_TOOLS_PATH=%CD%\r
     )\r
  )\r
  set PATH=%BASE_TOOLS_PATH%\Bin\Win32;%PATH%\r
\r
  set PYTHONPATH=%BASE_TOOLS_PATH%\Source\Python\r
\r
  if not defined PYTHON_HOME (\r
    if defined PYTHONHOME (\r
      set PYTHON_HOME=%PYTHONHOME%\r
    ) else (\r
      echo.\r
      echo  !!! ERROR !!! PYTHON is required to build or execute the tools !!!\r
      echo.\r
      goto end\r
    )\r
  )\r
\r
  @REM We have Python, now test for FreezePython application\r
  if not defined PYTHON_FREEZER_PATH (\r
    @REM see if we can find FreezePython.ex\r
    if exist "%PYTHON_HOME%\Tools\cx_Freeze-3.0.3\FreezePython.exe" (\r
      set PYTHON_FREEZER_PATH=%PYTHON_HOME%\Tools\cx_Freeze-3.0.3\r
    ) \r
    if exist "%PYTHON_HOME%\Tools\cx_Freeze\FreezePython.exe" (\r
      set PYTHON_FREEZER_PATH=%PYTHON_HOME%\Tools\cx_Freeze\r
    ) \r
    if exist "C:\cx_Freeze\FreezePython.exe" (\r
        set PYTHON_FREEZER_PATH=C:\cx_Freeze\r
    )\r
    if exist "C:\cx_Freeze-3.0.3" (\r
        set PYTHON_FREEZER_PATH=C:\cx_Freeze-3.0.3\r
    )\r
    if not defined PYTHON_FREEZER_PATH (\r
      echo.\r
      echo !!! WARNING !!! Will not be able to compile Python programs to .exe\r
      echo Will setup environment to run Python scripts directly.\r
      echo.\r
      set PYTHONPATH=%BASE_TOOLS_PATH%\Source\Python\r
      set PATH=%PYTHONPATH%\build;%PYTHONPATH%\GenFds;%PYTHONPATH%\Trim;%PATH%\r
      set PATHEXT=%PATHEXT%;.py\r
    )\r
  )\r
  \r
  echo BASE_TOOLS_PATH     = %BASE_TOOLS_PATH%\r
  echo     PYTHON_PATH     = %PYTHON_PATH%\r
  echo PYTHON_FREEZER_PATH = %PYTHON_FREEZER_PATH%\r
  echo.\r
\r
  if defined VCINSTALLDIR goto VisualStudioAvailable\r
  if defined VS71COMNTOOLS (\r
    call "%VS71COMNTOOLS%\vsvars32.bat"\r
  ) else (\r
    if defined VS80COMNTOOLS (\r
      call "%VS80COMNTOOLS%\vsvars32.bat"\r
    ) else (\r
      echo.\r
      echo !!! ERROR !!!! Cannot find Visual Studio, required to build C tools !!!\r
      echo.\r
      goto end\r
    )\r
  )\r
\r
:VisualStudioAvailable\r
  if defined FORCE_REBUILD goto CleanAndBuild\r
  goto IncrementalBuild\r
\r
:CleanAndBuild\r
  pushd .\r
  cd %BASE_TOOLS_PATH%\r
  call nmake cleanall\r
  del /f /q %BASE_TOOLS_PATH%\Bin\Win32\*.*\r
  popd\r
  @REM Let CleanAndBuild fall through to IncrementalBuild\r
\r
\r
:IncrementalBuild\r
  pushd .\r
  cd %BASE_TOOLS_PATH%\r
  call nmake c\r
  popd\r
\r
  if defined PYTHON_FREEZER_PATH (\r
    echo BUILDING PYTHON TOOLS\r
    pushd .\r
    cd %BASE_TOOLS_PATH%\r
    call nmake python\r
    popd\r
  ) else (\r
    echo.\r
    echo !!! WARNING !!! Cannot make executable from Python code, executing python scripts instead !!!\r
    echo.\r
  )\r
  goto end\r
\r
\r
:no_source_files\r
  echo.\r
  echo !!! ERROR !!! Cannot build BaseTools applications - no source directory located !!!\r
  echo.\r
  goto end\r
\r
:Usage\r
  echo.\r
  echo  Usage: "%0 [-h | -help | --help | /h | /help | /?] [ Rebuild | ForceRebuild ] [Reconfig] [base_tools_path [edk_tools_path]]"\r
  echo.\r
  echo         base_tools_path   BaseTools project path, BASE_TOOLS_PATH will be set to this path. \r
  echo         edk_tools_path    EDK_TOOLS_PATH will be set to this path.\r
  echo         Rebuild           If sources are available perform an Incremental build, only \r
  echo                           build those updated tools.\r
  echo         ForceRebuild      If sources are available, rebuild all tools regardless of \r
  echo                           whether they have been updated or not.\r
  echo         Reconfig          Reinstall target.txt, tools_def.txt and build_rule.txt.\r
echo.\r
\r
:end\r
set REBUILD=\r
set FORCE_REBUILD=\r
set RECONFIG=\r
popd\r
\r
@echo on\r
\r