Installation Guide¶

Introduction¶

This document describes the steps should be followed to install С++TESK Testing ToolKit (hereinafter C++TESK). In addition to C++TESK, Icarus Verilog and VeriTool (hereinafter Verilog tools) are recommended to be installed (they are used for generating C/C++ API for Verilog modules).

Before installing the toolkit make sure that System Requirements are met.

Installation¶

Basic Installation (Recommended)¶

To install C++TESK, pass the following steps:

1. Download the latest version of the C++TESK package (cpptesk-toolkit-src-*.tar.gz) from the Files page.
2. Unzip the downloaded archive:
   

   % tar xf cpptesk-toolkit-src-*.tar.gz
   

3. Run the install.sh script as follows.

• To install C++TESK without installing the Verilog tools, run:
  

  % install.sh
  

• To install C++TESK together with the Verilog tools not reinstalling the Verilog tools if they have been already installed, run:
  

  % install.sh --install-veritool
  

• To install C++TESK and (re)install the Verilog tools, run:
  

  % install.sh --force-install-veritool
  

Home directories for the tools are chosen according to the following rules:

1. If the environment variable $ISPRAS_HOME is not set, it will be assigned to the user’s home directory (usually, /home/<user>).
2. If the environment variable $CPPTESK_HOME is not set, it will be assigned to the value $ISPRAS_HOME/tools/cpptesk-toolkit.
3. If the environment variable $ICARUS_HOME is not set, it will be assigned to the value $ISPRAS_HOME/tools/verilog.
4. It the environment variable $VERITOOL_HOME is not set, it will be assigned to the value $ISPRAS_HOME/tools/veritool.

C++TESK is installed into the directory $CPPTESK_HOME.

Icarus Verilog (if it is required) is installed into the directory $ICARUS_HOME.

VeriTool (if it is required) is installed into the directory $VERITOOL_HOME.

Manual Installation of the Verilog Tools¶

The Verilog tools can be installed manually.

To install Icarus Verilog, pass the following steps:

1. Download the Icarus Verilog package from here.
2. If the environment variable $ICARUS_HOME is not set, it should be assigned:
   

   % export ICARUS_HOME=<path_to_icarus_verilog_installation_directory>
   % echo "export ICARUS_HOME=$ICARUS_HOME" >> "$HOME/.profile" 
   % echo "export ICARUS_HOME=$ICARUS_HOME" >> "$HOME/.bashrc" 
   

3. Create the $ICARUS_HOME directory if it does not exist:
   

   mkdir -p "$ICARUS_HOME" 
   

4. Unzip the downloaded archive and make it:
   

   tar xf verilog-0.9.4.tar.gz
   cd verilog-0.9.4
   ./configure --prefix="$ICARUS_HOME" 
   make && make install
   

To install VeriTool, pass the following steps:

1. http://forge.ispras.ru/projects/veritool/files.
2. If the system variable $VERITOOL_HOME is not set, it should be assigned. E.g., the following command sequence can help:
   

   export VERITOOL_HOME=< _path_for_VeriTool_installation_ >
   echo "export VERITOOL_HOME=$VERITOOL_HOME">>"$HOME/.profile" 
   echo "export VERITOOL_HOME=$VERITOOL_HOME">>"$HOME/.bashrc" 
   

3. It the folder $VERITOOL_HOME does not exist, it should be created:
   

   mkdir -p "$VERITOOL_HOME" 
   

4. Having changed the directory to the one with installation package of VeriTool, it is necessary to apply the following command sequence:
   

   tar xf veritool-0.2.1-beta-20110702.tar.gz
   cd veritool-0.2.1-beta-20110702
   ./configure --prefix="$VERITOOL_HOME" 
   make all && make install