New structure of Global Trigger firmware on MP7

Clone of CERN gitlab ugt firmware.

Top hierarchy module of ugt firmware mp7_payload.vhd, which is embedded in the MP7 firmware framework, contains two main parts:

• Control of ugt firmware (gt_control.vhd)
• Data of ugt firmware (gt_data.vhd), which contains
  • Global Trigger Logic (GTL) version 2.x.y for new structure of GTL logic with 3 stages:
    • conversions and calculations
    • comparisons
    • conditions and algos
  • Final Decision Logic (FDL)

Simulation of gtl_fdl_wrapper with Questa simulator for 6 ugt modules

• This is a description running script "run_simulation_questa.py" for simulation.
• If Questa sim libraries for Vivado do not exist in $HOME/questasimlibs_xxx, they will be created for the selected Questa sim and Vivado versions.

Workflow

# Clone git repositories
git clone https://gitlab.cern.ch/hbergaue/mp7.git <local path>/mp7
cd <local path>/mp7
git checkout mp7fw_v2_4_1_mp7_ugt
git clone https://github.com/cms-l1-globaltrigger/mp7_ugt.git <local path>/mp7_ugt
cd <local path>/mp7_ugt
git checkout master

# Run simulation
cd <local path>/mp7_ugt
python scripts/run_simulation_questa.py <L1Menu name> --mp7_tag <path local mp7>

# Example
cd ~/github/cms-l1-globaltrigger/mp7_ugt
python scripts/run_simulation_questa.py L1Menu_test_compare_gtl_struct_v4-d3 --mp7_tag ~/gitlab/hbergaue/mp7

Build mp7_ugt firmware with IPBB

• This is a draft description with branches of MP7 and ugt repos.

• A fork of MP7 firmware is available with three branches:

  • branch "mp7fw_v2_4_1_mp7_ugt" created from tag mp7fw_v2_4_1.
  • branch "mp7fw_v2_4_3_mp7_ugt" created from tag mp7fw_v2_4_3.
  • branch "mp7fw_master_mp7_ugt" created from master.

• These branches contain modified MP7 files for mp7_ugt:

  • area_constraints.tcl
  • mp7_brd_decl.vhd
  • mp7xe_690.vhd

• One of these branches can be used for build (see below).

Setup

• The ugt repo is a fork of svn2git ugt repo. Following modifications are done in the branch:
  • added ugt_strategy.tcl for ugt specific strategy and inserted it into top.dep.
  • modified uGT_algo.dep: removed "doubled" commands (these commnads are in MP7 dep files).
  • added script runIpbbSynth.py for IPBB synthesis (all 6 mp7_ugt modules) with possibility of simulation.
  • added script checkIpbbSynth.py for checking IPBB synthesis results.
  • added script fwpackerIpbb.py for packing firware files in a tar file.

Setup using script

# Run kerberos for outside of CERN network
kinit username@CERN.CH

# Make local clone of ugt repositiory
git clone https://github.com/cms-l1-globaltrigger/mp7_ugt.git <local path>/mp7_ugt
cd <local path>/mp7_ugt

# Run synthesis script (for all 6 modules)
[Note: default values for some arguments, see
python scripts/runIpbbSynth.py -h]
python scripts/runIpbbSynth.py <L1Menu name> --mp7url <URL MP7 git repo> --mp7tag <MP7 tag> -p <work dir> --build <build version> --ugturl <URL ugt git repo> -ugt <ugt tag in repo> --vivado <vivado version> --tme <tme version>

# Example
python scripts/runIpbbSynth.py L1Menu_test_compare_gtl_struct_v4-d3 --mp7url https://:@gitlab.cern.ch:8443/hbergaue/mp7.git --mp7tag mp7fw_v2_4_1 -p ~/work_compare_gtl_struct --build 0x0123 --ugturl https://github.com/cms-l1-globaltrigger/mp7_ugt.git --ugt master --vivado 2019.2 --tme 0.9.0

# Run synthesis script (for all 6 modules) with simulation (Questasim)
git clone https://gitlab.cern.ch/hbergaue/mp7.git <local MP7 repo path>
git clone https://github.com/cms-l1-globaltrigger/mp7_ugt.git <local path>/mp7_ugt
cd <local path>
python scripts/runIpbbSynth.py <L1Menu name> --mp7url <URL MP7 git repo> --mp7tag <MP7 tag> -p <work dir> --build <build version> --ugturl <URL ugt git repo> -u <ugt tag in repo> --sim --simmp7path <local MP7 repo path>

# Example
python scripts/runIpbbSynth.py L1Menu_test_compare_gtl_struct_v4-d3 --mp7url https://:@gitlab.cern.ch:8443/hbergaue/mp7.git --mp7tag mp7fw_v2_4_1 -p ~/work_compare_gtl_struct --build 0x0123 --ugturl https://:@gitlab.cern.ch:8443/hbergaue/ugt.git --ugt master --sim --simmp7path ~/gitlab/hbergaue/mp7 --vivado 2019.2 --tme 0.9.0

Setup (commands for one module)

# Run kerberos for outside of CERN network
kinit username@CERN.CH

# Download and install ipbb
curl -L https://github.com/ipbus/ipbb/archive/v0.2.8.tar.gz | tar xvz
source ipbb-0.2.8/env.sh

# Create a local working area
ipbb init <build_name>
cd <build_name>
ipbb add git https://github.com/ipbus/ipbus-firmware.git -b master
ipbb add git https://:@gitlab.cern.ch:8443/hbergaue/mp7.git -b mp7fw_v2_4_1_ugt
ipbb add git https://github.com/cms-l1-globaltrigger/mp7_ugt.git -b master

# Proposed to create l1menu.vhd and l1menu_pkg.vhd by VHDL Producer and copy
# to src/../firmware/l1menu directory. Patch top_decl.vhd and copy to 
# src/../firmware/packages, all should be done by script.

ipbb init <work dir>/mp7_ugt/<mp7fw version>/<menu version>/<build version>/module_<module number>
cd <work dir>/mp7_ugt/<mp7fw version>/<menu version>/<build version>/module_<module number>
ipbb add git https://github.com/ipbus/ipbus-firmware.git -b master
ipbb add git https://:@gitlab.cern.ch:8443/hbergaue/mp7.git -b mp7fw_v2_4_1_mp7_ugt
ipbb add git https://github.com/cms-l1-globaltrigger/mp7_ugt.git -b <master or branch name or tag name>

# Copy VHDL producer output and patched files to mp7_ugt (gtl_module.vhd, gtl_pkg.vhd,
algo_mapping_rop.vhd and gt_mp7_top_pkg.vhd)

# Source Vivado

# Create project 
ipbb proj create vivado module_<module_nr> mp7:../mp7_ugt
cd proj/module_<module_nr>
ipbb vivado project

# Run implementation, synthesis
ipbb vivado synth
ipbb vivado impl

# Generate a bitfile
ipbb vivado package
deactivate