This repository holds the source code for several of the firmware blocks of the Trigger Processor (TP) of the ATLAS Hardware Tracking for the Trigger (HTT) project. It also houses the associated testbench infrastructure, based around the cocotb framework testing framework.
The repository is laid out following a directory structure illustrated here:
tp-fw/
├── src/
│ ├── board2board_switching/
│ ├── evt_sync/
│ └── SpyBuffer/
├── tb/
│ ├── default_makefiles/
│ ├── schema/
│ ├── src/
│ └── test_config/
└── top/
└── tp/
Below, a brief description of each (sub-)directory is given.
Contains HDL description of TP firmware blocks. Separate firmware blocks each have
their own sub-directory. In the above, we see three such sub-directories for
three different blocks: board2board_switching, evt_sync, and SpyBuffer.
The structure of each of these block-specific sub-directories is specific to that
block and up to the developer.
Complete documentation for the testbench infrastructure is located in the tb/ directory.
This directory contains the cocotb-based testbench infrastructure.
default_makefiles/: Default CocoTB makefiles for simulators, etc...schema/: Files describing the enforced schema for testbench configuration, results, etc...test_config/: Where users place their testbench configuration files, which are used to run specific testbenchessrc/: Implementation of the testbench infrastructure and firmware testbenches
Standalone firmware blocks and top-level for testbench creation.