tbengy Python Tool for UVM Testbench Generation. The tool uses newly available capability of Vivado tool by Xilinx (WebPack Version) to compile and run UVM Testbench

• Python 3.x
• Xilinx Vivado 2020.x
• GNU Make

• Download Python3 from https://www.python.org/downloads/
• Install Python3 in your system
• Check Python version in Terminal/Console/Command-Prompt/Powershell

python --version

Or

python3 --version

Python 3.8.1

• Download Vivado from https://www.xilinx.com/support/download.html
• Install Vivado WebPack in your system
• Set Xilinx Vivado bin folder path to User/System Environment Variables

export PATH="$PATH:/home/<path_to_xilinx_installation>/Xilinx/Vivado/2020.1/bin"

Note: Put the above line with your path in ~/.bashrc, so the tool can load everytime you open terminal

• Once you set the path in ~/.bashrc, open new terminal and execute command below

vivado

• If your path and setup is correct, Vivado GUI will open
• You can close it as we will be working from terminal for the tbengy

Open Command-Prompt as administrator

setx path "%path%;<path_to>Xilinx\Vivado\2020.1\bin"

Example: setx path "%path%;C:\Xilinx\Vivado\2020.1\bin"

You can also set the path from System Properties. Search online for this method.

• Once you set the path in Windows, open new command-prompt/Powershell and execute command below

vivado

• If your path and setup is correct, Vivado GUI will open
• You can close it as we will be working from command-prompt/Powershell for the tbengy

• Most Linux come with GNU Make so no need to do this step if you are running using Linux
• For Windows, download GNU Make and install it from http://gnuwin32.sourceforge.net/packages/make.htm
• After installation in Windows, we need to add the bin path of Make in system path variable as we did for Vivado

setx path "%path%;<path_to>Program Files (x86)\GnuWin32\bin\"

Example: setx path "%path%;C:\Program Files (x86)\GnuWin32\bin"

• After adding the path, open new command-prompt/Powershell window and run

make

• If you see make getting executed, you are good to go

• Run the command below if you are using Git to clone the repository anywhere you wish

git clone https://github.com/prasadp4009/tbengy.git

Or

• Download from link - https://github.com/prasadp4009/tbengy/archive/master.zip

• Unzip the master.zip if downloaded and then go to tbengy directory

• Open new Terminal/Console/Command-Prompt/Powershell in that directory

• Run the command below to generate UVM TB

python tbengy.py

Or

python3 tbengy.py

tbengy help can be accessed with:

python tbengy.py -h

Or

python3 tbengy.py -h

You should get the following output

usage: tbengy.py [-h] [-v] -m <module_name> [-d <dir_path>]

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         Show tbengy version and exit
  -m <module_name>, --modulename <module_name>
                        Module name for which TB to be generated. Ex. -m my_design
  -d <dir_path>, --dirpath <dir_path>
                        Directory under which TB should be generated. Ex. -d ./myProjects/TB. Default is present working dir.

• Enter you module name with '-m <module_name>', the tool will generate a complete UVM testbench

python tbengy.py -m my_design

Or

python3 tbengy.py -m my_design

• You can enter desired directory where you want to generate TB by passing '-d <directory_path>'

python tbengy.py -m my_design -d ./myProjects/

Or

python3 tbengy.py -m my_design -d ./myProjects/

• Go to your generated module folder
• You can read the generated README.md to understand directory structure
• To run the testbench, go to scripts directory and run command below

make run_all

make run_all_gui

Contact me on [email protected] for any questions.

Hope the tool helps. Thanks!

• Generation of UVM Testbench with RTL Example and ready to compile and run
• Add simple RAM RTL and simple sanity test
• Create a seperate template file for configuring generated code
• Code CLI for tbengy
• Add support for simple SV TB with Modelsim compilation instruction in Makefile
• Add support for Vivado wdb wave dump to Modelsim WLF dump conversion for debugging waves generated by Vivado in Modelsim