ugt-fwtools

Firmware build tools for Phase-1 uGT

Prerequisites

Note: this section will be subject to changes.

The tools require following environment variables to be set, eg. by sourcing a bash script.

export UGT_QUESTASIM_SIM_PATH=/opt/mentor/questa/2021.1_2
export UGT_QUESTASIM_LIBS_PATH=$HOME/.questasimlibs
export UGT_VIVADO_BASE_DIR=/opt/Xilinx/Vivado
export UGT_VIVADO_VERSION=2021.2
source ${UGT_VIVADO_BASE_DIR}/${UGT_VIVADO_VERSION}/settings64.sh

Install

pip install git+https://github.com/cms-l1-globaltrigger/ugt-fwtools.git@0.6.0

Simulation

ugt-simulate sample.xml --tv sample_ttbar.txt

Use command line option --ugttag <tag> to run with a different ugt tag or branch.

To persist the simulation results use option --output <dir>.

Synthesis

ugt-synthesize sample.xml --build 0x1160

Use command line option --ugttag <tag> to run with a different ugt tag or branch.

Check results

ugt-checksynth build_0x1160.cfg

Build report

Print textile formatted information to be inserted in redmine issues and wiki.

ugt-buildreport build_0x1160.cfg

Bundle firmware

ugt-fwpacker build_0x1160.cfg

Vivado archives

Create Vivado archives of all modules.

ugt-archive build_0x1160.cfg

Create Vivado archive of individual module.

ugt-archive build_0x1160.cfg -m 1  # module_1