BaseTools:Update mailing list address in BaseTools error messages

[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 - 2018, Intel Corporation. All rights reserved.<BR>\r
@REM (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
@REM\r
@REM SPDX-License-Identifier: BSD-2-Clause-Patent\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
    if /I "%2" == "X64" (\r
      shift\r
    )\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
  if not defined EDK_TOOLS_BIN (\r
    set EDK_TOOLS_BIN=%EDK_TOOLS_PATH%\Bin\Win32\r
    if not exist %EDK_TOOLS_PATH%\Bin\Win32 (\r
      echo.\r
      echo !!! ERROR !!! Cannot find BaseTools Bin Win32!!!\r
      echo Please check the directory %EDK_TOOLS_PATH%\Bin\Win32\r
      echo Or configure EDK_TOOLS_BIN env to point Win32 directory.\r
      echo.\r
    )\r
  )\r
  set PATH=%EDK_TOOLS_BIN%;%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
  if not defined EDK_TOOLS_BIN (\r
    set EDK_TOOLS_BIN=%EDK_TOOLS_PATH%\Bin\Win32\r
    if not exist %EDK_TOOLS_PATH%\Bin\Win32 (\r
      echo.\r
      echo !!! ERROR !!! Cannot find BaseTools Bin Win32!!!\r
      echo Please check the directory %EDK_TOOLS_PATH%\Bin\Win32\r
      echo Or configure EDK_TOOLS_BIN env to point Win32 directory.\r
      echo.\r
    )\r
  )\r
  set PATH=%EDK_TOOLS_BIN%;%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
REM\r
REM copy *.template to %CONF_PATH%\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 "%EDK_TOOLS_PATH%\set_vsprefix_envs.bat" (\r
  @echo.\r
  @echo !!! ERROR !!! The set_vsprefix_envs.bat was not found !!!\r
  @echo.\r
  goto end\r
)\r
call %EDK_TOOLS_PATH%\set_vsprefix_envs.bat\r
\r
if not defined CONF_PATH (\r
  set CONF_PATH=%WORKSPACE%\Conf\r
)\r
\r
if NOT exist %CONF_PATH% (\r
  if defined PACKAGES_PATH (\r
    for %%i IN (%PACKAGES_PATH%) DO (\r
      if exist %%~fi\Conf (\r
        set CONF_PATH=%%i\Conf\r
        goto CopyConf\r
      )\r
    )\r
  )\r
)\r
\r
:CopyConf\r
if NOT exist %CONF_PATH% (\r
  mkdir %CONF_PATH%\r
) else (\r
  if defined RECONFIG (\r
    echo.\r
    echo  Over-writing the files in the CONF_PATH directory\r
    echo  using the default template files\r
    echo.\r
  )\r
)\r
\r
if NOT exist %CONF_PATH%\target.txt (\r
  echo copying ... target.template to %CONF_PATH%\target.txt\r
  if NOT exist %EDK_TOOLS_PATH%\Conf\target.template (\r
    echo Error: target.template is missing at folder %EDK_TOOLS_PATH%\Conf\\r
  )\r
  copy %EDK_TOOLS_PATH%\Conf\target.template %CONF_PATH%\target.txt > nul\r
) else (\r
  if defined RECONFIG echo over-write ... target.template to %CONF_PATH%\target.txt\r
  if defined RECONFIG copy /Y %EDK_TOOLS_PATH%\Conf\target.template %CONF_PATH%\target.txt > nul\r
)\r
\r
if NOT exist %CONF_PATH%\tools_def.txt (\r
  echo copying ... tools_def.template to %CONF_PATH%\tools_def.txt\r
  if NOT exist %EDK_TOOLS_PATH%\Conf\tools_def.template (\r
    echo Error: tools_def.template is missing at folder %EDK_TOOLS_PATH%\Conf\\r
  )\r
  copy %EDK_TOOLS_PATH%\Conf\tools_def.template %CONF_PATH%\tools_def.txt > nul\r
) else (\r
  if defined RECONFIG echo over-write ... tools_def.template to %CONF_PATH%\tools_def.txt\r
  if defined RECONFIG copy /Y %EDK_TOOLS_PATH%\Conf\tools_def.template %CONF_PATH%\tools_def.txt > nul\r
)\r
\r
if NOT exist %CONF_PATH%\build_rule.txt (\r
  echo copying ... build_rule.template to %CONF_PATH%\build_rule.txt\r
  if NOT exist %EDK_TOOLS_PATH%\Conf\build_rule.template (\r
    echo Error: build_rule.template is missing at folder %EDK_TOOLS_PATH%\Conf\\r
  )\r
  copy %EDK_TOOLS_PATH%\Conf\build_rule.template %CONF_PATH%\build_rule.txt > nul\r
) else (\r
  if defined RECONFIG echo over-write ... build_rule.template to %CONF_PATH%\build_rule.txt\r
  if defined RECONFIG copy /Y %EDK_TOOLS_PATH%\Conf\build_rule.template %CONF_PATH%\build_rule.txt > nul\r
)\r
\r
echo           PATH      = %PATH%\r
echo.\r
if defined WORKSPACE (\r
  echo      WORKSPACE      = %WORKSPACE%\r
)\r
if defined PACKAGES_PATH (\r
  echo  PACKAGES_PATH      = %PACKAGES_PATH%\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
if defined EDK_TOOLS_BIN (\r
  echo  EDK_TOOLS_BIN      = %EDK_TOOLS_BIN%\r
)\r
echo      CONF_PATH      = %CONF_PATH%\r
echo.\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%" goto check_build_environment\r
if not exist "%EDK_TOOLS_BIN%"  goto check_build_environment\r
\r
IF NOT EXIST "%EDK_TOOLS_BIN%\EfiRom.exe" goto check_c_tools\r
IF NOT EXIST "%EDK_TOOLS_BIN%\GenFfs.exe" goto check_c_tools\r
IF NOT EXIST "%EDK_TOOLS_BIN%\GenFv.exe" goto check_c_tools\r
IF NOT EXIST "%EDK_TOOLS_BIN%\GenFw.exe" goto check_c_tools\r
IF NOT EXIST "%EDK_TOOLS_BIN%\GenSec.exe" goto check_c_tools\r
IF NOT EXIST "%EDK_TOOLS_BIN%\Split.exe" goto check_c_tools\r
IF NOT EXIST "%EDK_TOOLS_BIN%\TianoCompress.exe" goto check_c_tools\r
IF NOT EXIST "%EDK_TOOLS_BIN%\VfrCompile.exe" goto check_c_tools\r
IF NOT EXIST "%EDK_TOOLS_BIN%\VolInfo.exe" goto check_c_tools\r
\r
goto check_build_environment\r
\r
:check_c_tools\r
  echo.\r
  echo !!! ERROR !!! Binary C tools are missing. They are required to be built from BaseTools Source.\r
  echo.\r
\r
:check_build_environment\r
  set PYTHONHASHSEED=1\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
\r
:defined_python\r
if defined PYTHON_COMMAND if not defined PYTHON3_ENABLE (\r
  goto check_python_available\r
)\r
if defined PYTHON3_ENABLE (\r
  if "%PYTHON3_ENABLE%" EQU "TRUE" (\r
    set PYTHON_COMMAND=py -3\r
    goto check_python_available\r
  ) else (\r
    goto check_python2\r
  )\r
)\r
if not defined PYTHON_COMMAND if not defined PYTHON3_ENABLE (\r
  set PYTHON_COMMAND=py -3\r
  py -3 %BASE_TOOLS_PATH%\Tests\PythonTest.py >PythonCheck.txt 2>&1\r
  setlocal enabledelayedexpansion\r
  set /p PythonCheck=<"PythonCheck.txt"\r
  del PythonCheck.txt\r
  if "!PythonCheck!" NEQ "TRUE" (\r
    if not defined PYTHON_HOME if not defined PYTHONHOME (\r
      endlocal\r
      set PYTHON_COMMAND=\r
      echo.\r
      echo !!! ERROR !!! Binary python tools are missing.\r
      echo PYTHON_COMMAND, PYTHON3_ENABLE or PYTHON_HOME\r
      echo Environment variable is not set successfully.\r
      echo They is required to build or execute the python tools.\r
      echo.\r
      goto end\r
    ) else (\r
      goto check_python2\r
    )\r
  ) else (\r
    goto check_freezer_path\r
  )\r
)\r
\r
:check_python2\r
endlocal\r
if defined PYTHON_HOME (\r
  if EXIST "%PYTHON_HOME%" (\r
    set PYTHON_COMMAND=%PYTHON_HOME%\python.exe\r
    goto check_python_available\r
  )\r
)\r
if defined PYTHONHOME (\r
  if EXIST "%PYTHONHOME%" (\r
    set PYTHON_HOME=%PYTHONHOME%\r
    set PYTHON_COMMAND=%PYTHON_HOME%\python.exe\r
    goto check_python_available\r
  )\r
)\r
echo.\r
echo !!! ERROR !!!  PYTHON_HOME is not defined or The value of this variable does not exist\r
echo.\r
goto end\r
:check_python_available\r
%PYTHON_COMMAND% %BASE_TOOLS_PATH%\Tests\PythonTest.py >PythonCheck.txt 2>&1\r
  setlocal enabledelayedexpansion\r
  set /p PythonCheck=<"PythonCheck.txt"\r
  del PythonCheck.txt\r
  if "!PythonCheck!" NEQ "TRUE" (\r
    echo.\r
    echo ! ERROR !  "%PYTHON_COMMAND%" is not installed or added to environment variables\r
    echo.\r
    goto end\r
  ) else (\r
    goto check_freezer_path\r
  )\r
\r
:check_freezer_path\r
  endlocal\r
  if defined BASETOOLS_PYTHON_SOURCE goto print_python_info\r
  set "PATH=%BASE_TOOLS_PATH%\BinWrappers\WindowsLike;%PATH%"\r
  set BASETOOLS_PYTHON_SOURCE=%BASE_TOOLS_PATH%\Source\Python\r
  set PYTHONPATH=%BASETOOLS_PYTHON_SOURCE%;%PYTHONPATH%\r
\r
:print_python_info\r
  echo                PATH = %PATH%\r
  if defined PYTHON3_ENABLE if "%PYTHON3_ENABLE%" EQU "TRUE" (\r
    echo      PYTHON3_ENABLE = %PYTHON3_ENABLE%\r
    echo             PYTHON3 = %PYTHON_COMMAND%\r
  ) else (\r
    echo      PYTHON3_ENABLE = FALSE\r
    echo      PYTHON_COMMAND = %PYTHON_COMMAND%\r
  )\r
  echo          PYTHONPATH = %PYTHONPATH%\r
  echo.\r
\r
:VisualStudioAvailable\r
  if not defined FORCE_REBUILD (\r
    if not defined REBUILD (\r
      goto end\r
    )\r
  )\r
  call "%EDK_TOOLS_PATH%\get_vsvars.bat"\r
  if not defined VCINSTALLDIR (\r
    @echo.\r
    @echo !!! ERROR !!!! Cannot find Visual Studio, required to build C tools !!!\r
    @echo.\r
    goto end\r
  )\r
  if not defined FORCE_REBUILD 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
  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