BaseTools/toolsetup.bat

   1 @REM @file
   2 @REM   This stand-alone program is typically called by the edksetup.bat file,
   3 @REM   however it may be executed directly from the BaseTools project folder
   4 @REM   if the file is not executed within a WORKSPACE\BaseTools folder.
   5 @REM
   6 @REM Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
   7 @REM (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
   8 @REM
   9 @REM This program and the accompanying materials are licensed and made available
  10 @REM under the terms and conditions of the BSD License which accompanies this
  11 @REM distribution.  The full text of the license may be found at:
  12 @REM   http://opensource.org/licenses/bsd-license.php
  13 @REM
  14 @REM THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  15 @REM WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR
  16 @REM IMPLIED.
  17 @REM
  18
  19 @echo off
  20 pushd .
  21
  22 @REM ##############################################################
  23 @REM # You should not have to modify anything below this line
  24 @REM #
  25
  26 if /I "%1"=="-h" goto Usage
  27 if /I "%1"=="-help" goto Usage
  28 if /I "%1"=="--help" goto Usage
  29 if /I "%1"=="/h" goto Usage
  30 if /I "%1"=="/help" goto Usage
  31 if /I "%1"=="/?" goto Usage
  32
  33
  34 :loop
  35   if "%1"=="" goto setup_workspace
  36   if /I "%1"=="--nt32" (
  37     if /I "%2" == "X64" (
  38       shift
  39     )
  40     @REM Ignore --nt32 flag
  41     shift
  42     goto loop
  43   )
  44   if /I "%1"=="Reconfig" (
  45     shift
  46     set RECONFIG=TRUE
  47     goto loop
  48   )
  49   if /I "%1"=="Rebuild" (
  50     shift
  51     set REBUILD=TRUE
  52     goto loop
  53   )
  54   if /I "%1"=="ForceRebuild" (
  55     shift
  56     set FORCE_REBUILD=TRUE
  57     goto loop
  58   )
  59   if "%1"=="" goto setup_workspace
  60   if exist %1 (
  61     if not defined BASE_TOOLS_PATH (
  62       if exist %1\Source set BASE_TOOLS_PATH=%1
  63       shift
  64       goto loop
  65     )
  66     if not defined EDK_TOOLS_PATH (
  67       if exist %1\Bin\Win32 set EDK_TOOLS_PATH=%1
  68       shift
  69       goto loop
  70     )
  71     echo.
  72     echo !!! ERROR !!! Unknown argument, %1 !!!
  73     echo.
  74     goto end
  75   ) else (
  76     echo.
  77     echo !!! ERROR !!! Unknown argument, %1 !!!
  78     echo.
  79     goto end
  80   )
  81   goto loop
  82
  83
  84 @REM
  85 @REM Check the required system environment variables
  86 @REM
  87
  88 :setup_workspace
  89   REM
  90   REM check the EDK_TOOLS_PATH
  91   REM
  92   if not defined EDK_TOOLS_PATH goto no_EDK_TOOLS_PATH
  93   if exist %EDK_TOOLS_PATH% goto set_PATH
  94
  95 :no_EDK_TOOLS_PATH
  96   if not defined WORKSPACE (
  97     if defined BASE_TOOLS_PATH (
  98       set EDK_TOOLS_PATH=%BASE_TOOLS_PATH%
  99       goto set_PATH
 100     ) else (
 101       echo.
 102       echo !!! ERROR !!! Neither BASE_TOOLS_PATH nor EDK_TOOLS_PATH are set. !!!
 103       echo.
 104       goto end
 105     )
 106   ) else (
 107     if exist %WORKSPACE%\BaseTools\Bin (
 108       set EDK_TOOLS_PATH=%WORKSPACE%\BaseTools
 109       goto set_PATH
 110     ) else (
 111       echo.
 112       echo !!! ERROR !!! No tools path available. Please set EDK_TOOLS_PATH !!!
 113       echo.
 114       goto end
 115     )
 116   )
 117
 118 :set_PATH
 119   if defined WORKSPACE_TOOLS_PATH goto check_PATH
 120   if not defined EDK_TOOLS_BIN (
 121     if exist %EDK_TOOLS_PATH%\Bin\Win32 (
 122       set EDK_TOOLS_BIN=%EDK_TOOLS_PATH%\Bin\Win32
 123     ) else (
 124       echo.
 125       echo !!! ERROR !!! Cannot find BaseTools Bin Win32!!!
 126       echo Please check the directory %EDK_TOOLS_PATH%\Bin\Win32
 127       echo Or configure EDK_TOOLS_BIN env to point Win32 directory.
 128       echo.
 129       goto end
 130     )
 131   )
 132   set PATH=%EDK_TOOLS_BIN%;%PATH%
 133   set WORKSPACE_TOOLS_PATH=%EDK_TOOLS_PATH%
 134   goto PATH_ok
 135
 136 :check_PATH
 137   if "%EDK_TOOLS_PATH%"=="%WORKSPACE_TOOLS_PATH%" goto PATH_ok
 138   if not defined EDK_TOOLS_BIN (
 139     if exist %EDK_TOOLS_PATH%\Bin\Win32 (
 140       set EDK_TOOLS_BIN=%EDK_TOOLS_PATH%\Bin\Win32
 141     ) else (
 142       echo.
 143       echo !!! ERROR !!! Cannot find BaseTools Bin Win32!!!
 144       echo Please check the directory %EDK_TOOLS_PATH%\Bin\Win32
 145       echo Or configure EDK_TOOLS_BIN env to point Win32 directory.
 146       echo.
 147       goto end
 148     )
 149   )
 150   set PATH=%EDK_TOOLS_BIN%;%PATH%
 151   set WORKSPACE_TOOLS_PATH=%EDK_TOOLS_PATH%
 152   echo Resetting the PATH variable to include the EDK_TOOLS_PATH for this session.
 153
 154 :PATH_ok
 155 REM
 156 REM copy *.template to %CONF_PATH%
 157 REM
 158 if not defined WORKSPACE (
 159    if defined RECONFIG (
 160      echo.
 161      echo !!! WARNING !!! WORKSPACE environment variable was not set, cannot Reconfig !!!
 162      echo.
 163    )
 164    goto skip_reconfig
 165 )
 166
 167 IF NOT exist "%EDK_TOOLS_PATH%\set_vsprefix_envs.bat" (
 168   @echo.
 169   @echo !!! ERROR !!! The set_vsprefix_envs.bat was not found !!!
 170   @echo.
 171   goto end
 172 )
 173 call %EDK_TOOLS_PATH%\set_vsprefix_envs.bat
 174
 175 if not defined CONF_PATH (
 176   set CONF_PATH=%WORKSPACE%\Conf
 177 )
 178
 179 if NOT exist %CONF_PATH% (
 180   if defined PACKAGES_PATH (
 181     for %%i IN (%PACKAGES_PATH%) DO (
 182       if exist %%~fi\Conf (
 183         set CONF_PATH=%%i\Conf
 184         goto CopyConf
 185       )
 186     )
 187   )
 188 )
 189
 190 :CopyConf
 191 if NOT exist %CONF_PATH% (
 192   mkdir %CONF_PATH%
 193 ) else (
 194   if defined RECONFIG (
 195     echo.
 196     echo  Over-writing the files in the CONF_PATH directory
 197     echo  using the default template files
 198     echo.
 199   )
 200 )
 201
 202 if NOT exist %CONF_PATH%\target.txt (
 203   echo copying ... target.template to %CONF_PATH%\target.txt
 204   if NOT exist %EDK_TOOLS_PATH%\Conf\target.template (
 205     echo Error: target.template is missing at folder %EDK_TOOLS_PATH%\Conf\
 206   )
 207   copy %EDK_TOOLS_PATH%\Conf\target.template %CONF_PATH%\target.txt > nul
 208 ) else (
 209   if defined RECONFIG echo over-write ... target.template to %CONF_PATH%\target.txt
 210   if defined RECONFIG copy /Y %EDK_TOOLS_PATH%\Conf\target.template %CONF_PATH%\target.txt > nul
 211 )
 212
 213 if NOT exist %CONF_PATH%\tools_def.txt (
 214   echo copying ... tools_def.template to %CONF_PATH%\tools_def.txt
 215   if NOT exist %EDK_TOOLS_PATH%\Conf\tools_def.template (
 216     echo Error: tools_def.template is missing at folder %EDK_TOOLS_PATH%\Conf\
 217   )
 218   copy %EDK_TOOLS_PATH%\Conf\tools_def.template %CONF_PATH%\tools_def.txt > nul
 219 ) else (
 220   if defined RECONFIG echo over-write ... tools_def.template to %CONF_PATH%\tools_def.txt
 221   if defined RECONFIG copy /Y %EDK_TOOLS_PATH%\Conf\tools_def.template %CONF_PATH%\tools_def.txt > nul
 222 )
 223
 224 if NOT exist %CONF_PATH%\build_rule.txt (
 225   echo copying ... build_rule.template to %CONF_PATH%\build_rule.txt
 226   if NOT exist %EDK_TOOLS_PATH%\Conf\build_rule.template (
 227     echo Error: build_rule.template is missing at folder %EDK_TOOLS_PATH%\Conf\
 228   )
 229   copy %EDK_TOOLS_PATH%\Conf\build_rule.template %CONF_PATH%\build_rule.txt > nul
 230 ) else (
 231   if defined RECONFIG echo over-write ... build_rule.template to %CONF_PATH%\build_rule.txt
 232   if defined RECONFIG copy /Y %EDK_TOOLS_PATH%\Conf\build_rule.template %CONF_PATH%\build_rule.txt > nul
 233 )
 234
 235 echo           PATH      = %PATH%
 236 echo.
 237 if defined WORKSPACE (
 238   echo      WORKSPACE      = %WORKSPACE%
 239 )
 240 if defined PACKAGES_PATH (
 241   echo  PACKAGES_PATH      = %PACKAGES_PATH%
 242 )
 243 echo EDK_TOOLS_PATH      = %EDK_TOOLS_PATH%
 244 if defined BASE_TOOLS_PATH (
 245   echo BASE_TOOLS_PATH     = %BASE_TOOLS_PATH%
 246 )
 247 if defined EDK_TOOLS_BIN (
 248   echo  EDK_TOOLS_BIN      = %EDK_TOOLS_BIN%
 249 )
 250 echo      CONF_PATH      = %CONF_PATH%
 251 echo.
 252
 253 :skip_reconfig
 254
 255 @REM
 256 @REM Test if we are going to have to do a build
 257 @REM
 258 if defined FORCE_REBUILD goto check_build_environment
 259 if defined REBUILD goto check_build_environment
 260 if not exist "%EDK_TOOLS_PATH%" goto check_build_environment
 261
 262 IF NOT EXIST "%EDK_TOOLS_BIN%\BootSectImage.exe" goto check_c_tools
 263 IF NOT EXIST "%EDK_TOOLS_BIN%\EfiLdrImage.exe" goto check_c_tools
 264 IF NOT EXIST "%EDK_TOOLS_BIN%\EfiRom.exe" goto check_c_tools
 265 IF NOT EXIST "%EDK_TOOLS_BIN%\GenBootSector.exe" goto check_c_tools
 266 IF NOT EXIST "%EDK_TOOLS_BIN%\GenFfs.exe" goto check_c_tools
 267 IF NOT EXIST "%EDK_TOOLS_BIN%\GenFv.exe" goto check_c_tools
 268 IF NOT EXIST "%EDK_TOOLS_BIN%\GenFw.exe" goto check_c_tools
 269 IF NOT EXIST "%EDK_TOOLS_BIN%\GenPage.exe" goto check_c_tools
 270 IF NOT EXIST "%EDK_TOOLS_BIN%\GenSec.exe" goto check_c_tools
 271 IF NOT EXIST "%EDK_TOOLS_BIN%\GenVtf.exe" goto check_c_tools
 272 IF NOT EXIST "%EDK_TOOLS_BIN%\Split.exe" goto check_c_tools
 273 IF NOT EXIST "%EDK_TOOLS_BIN%\TianoCompress.exe" goto check_c_tools
 274 IF NOT EXIST "%EDK_TOOLS_BIN%\VfrCompile.exe" goto check_c_tools
 275 IF NOT EXIST "%EDK_TOOLS_BIN%\VolInfo.exe" goto check_c_tools
 276
 277 goto check_python_tools
 278
 279 :check_c_tools
 280   echo.
 281   echo !!! ERROR !!! Binary C tools are missing. They are requried to be built from BaseTools Source.
 282   echo.
 283   goto end
 284
 285 :check_python_tools
 286 IF NOT EXIST "%EDK_TOOLS_BIN%\build.exe" goto check_build_environment
 287 IF NOT EXIST "%EDK_TOOLS_BIN%\GenFds.exe" goto check_build_environment
 288 IF NOT EXIST "%EDK_TOOLS_BIN%\TargetTool.exe" goto check_build_environment
 289 IF NOT EXIST "%EDK_TOOLS_BIN%\Trim.exe" goto check_build_environment
 290
 291 goto end
 292
 293 :check_build_environment
 294   if defined BASETOOLS_PYTHON_SOURCE goto VisualStudioAvailable
 295
 296   if not defined BASE_TOOLS_PATH (
 297      if not exist "Source\C\Makefile" (
 298        if not exist "%EDK_TOOLS_PATH%\Source\C\Makefile" goto no_source_files
 299        set BASE_TOOLS_PATH=%EDK_TOOLS_PATH%
 300      ) else (
 301        set BASE_TOOLS_PATH=%CD%
 302      )
 303   )
 304
 305   if not defined PYTHON_HOME (
 306     if defined PYTHONHOME (
 307       set PYTHON_HOME=%PYTHONHOME%
 308     ) else (
 309       echo.
 310       echo  !!! ERROR !!! Binary python tools are missing. PYTHON_HOME environment variable is not set.
 311       echo PYTHON_HOME is required to build or execute the python tools.
 312       echo.
 313       goto end
 314     )
 315   )
 316
 317   @REM We have Python, now test for FreezePython application
 318   if not defined PYTHON_FREEZER_PATH (
 319     echo.
 320     echo !!! WARNING !!! PYTHON_FREEZER_PATH environment variable is not set.
 321     echo Setup environment to run Python scripts directly.
 322     echo.
 323     set "PATH=%PATH%;%BASE_TOOLS_PATH%\BinWrappers\WindowsLike"
 324   )
 325
 326   set BASETOOLS_PYTHON_SOURCE=%BASE_TOOLS_PATH%\Source\Python
 327   set PYTHONPATH=%BASETOOLS_PYTHON_SOURCE%;%PYTHONPATH%
 328
 329   echo                PATH = %PATH%
 330   echo         PYTHON_HOME = %PYTHON_HOME%
 331   echo          PYTHONPATH = %PYTHONPATH%
 332   if defined PYTHON_FREEZER_PATH (
 333     echo PYTHON_FREEZER_PATH = %PYTHON_FREEZER_PATH%
 334   )
 335   echo.
 336
 337 :VisualStudioAvailable
 338   if not defined FORCE_REBUILD (
 339     if not defined REBUILD (
 340       goto end
 341     )
 342   )
 343   call "%EDK_TOOLS_PATH%\get_vsvars.bat"
 344   if not defined VCINSTALLDIR (
 345     @echo.
 346     @echo !!! ERROR !!!! Cannot find Visual Studio, required to build C tools !!!
 347     @echo.
 348     goto end
 349   )
 350   if not defined FORCE_REBUILD goto IncrementalBuild
 351
 352 :CleanAndBuild
 353   pushd .
 354   cd %BASE_TOOLS_PATH%
 355   call nmake cleanall
 356   del /f /q %BASE_TOOLS_PATH%\Bin\Win32\*.*
 357   popd
 358   @REM Let CleanAndBuild fall through to IncrementalBuild
 359
 360
 361 :IncrementalBuild
 362   pushd .
 363   cd %BASE_TOOLS_PATH%
 364   call nmake c
 365   popd
 366
 367   if defined PYTHON_FREEZER_PATH (
 368     echo BUILDING PYTHON TOOLS
 369     pushd .
 370     cd %BASE_TOOLS_PATH%
 371     call nmake python
 372     popd
 373   ) else (
 374     echo.
 375     echo !!! WARNING !!! Cannot make executable from Python code, executing python scripts instead !!!
 376     echo.
 377   )
 378   goto end
 379
 380
 381 :no_source_files
 382   echo.
 383   echo !!! ERROR !!! Cannot build BaseTools applications - no source directory located !!!
 384   echo.
 385   goto end
 386
 387 :Usage
 388   @echo.
 389   echo  Usage: "%0 [-h | -help | --help | /h | /help | /?] [ Rebuild | ForceRebuild ] [Reconfig] [base_tools_path [edk_tools_path]]"
 390   @echo.
 391   @echo         base_tools_path   BaseTools project path, BASE_TOOLS_PATH will be set to this path.
 392   @echo         edk_tools_path    EDK_TOOLS_PATH will be set to this path.
 393   @echo         Rebuild           If sources are available perform an Incremental build, only
 394   @echo                           build those updated tools.
 395   @echo         ForceRebuild      If sources are available, rebuild all tools regardless of
 396   @echo                           whether they have been updated or not.
 397   @echo         Reconfig          Reinstall target.txt, tools_def.txt and build_rule.txt.
 398   @echo.
 399
 400 :end
 401 set REBUILD=
 402 set FORCE_REBUILD=
 403 set RECONFIG=
 404 popd
 405