tj-monopix2-daq

Data acquisition system for the TJ-Monopix2 pixel detector.

Installation

Clone the repository and install the required dependencies with

pip install basil-daq coloredlogs GitPython matplotlib numba numpy pyyaml pyzmq scipy tables tqdm 

Afterwards install the package (editable) by running

pip install -e .

from the root folder.

Firmware compilation

Clone basil to any location and install it by running pip install -e . from its root folder.

If you want to download SiTCP and patch it for yourself, click here

Grab a copy of SiTCP and move the *.V and *.ngc files to a newly created firmware/SiTCP folder in the cloned tj-monopix2-daq repository. Add a line `default_nettype wire in all of the *.V files right below the copyright notice in the beginning and before the first module declaration. This ensures compatibility with the rest of the verilog code.

Using firmware manager

This is the recommended method to compile firmware. Simply run

python manage_firmware.py --compile <platform>

where <platform> is either BDAQ53, BDAQ53_KX1 or MIO3. Make sure to have a Vivado binary in the current PATH.

Using Vivado CLI

Run

vivado -mode batch -source run.tcl

from the firmware/vivado folder. The resulting bit files will be written to firmware/bit. This will build the firmware for multiple supported hardware platforms. If you want to build it for only one, pass the arguments that you can find in run.tcl as command line arguments, e.g.

vivado -mode batch -source run.tcl -tclargs xc7k160tffg676-2 bdaq53_kx2.xdc 64

Firmware flashing

The easiest way to flash the firmware to the FPGA is again the firmware manager. Run

python manage_firmware.py --firmware <path-to-bit-or-mcs-file>

and specify the path to the firmware file. The file type determines if it is written to FPGA (.bit) or persistent flash memory (.mcs).

Hardware configuration

Connecting a module

BDAQ53 hardware platform: The DisplayPort cable has to be connected between the DP1 (Data) plug on the carrier PCB and the DP_ML on the short side of the readout board. The second DisplayPort plug on the carrier PCB is not required for operation and transmits only HitOr data. If needed, it has to be connected to the DP_SL close to the DP_ML on the long side of the readout board.

Readout board IP address configuration

To support multiple readout boards on one PC, different IP addresses have to be used. The IP address can be changed using jumpers on the PMOD connector on both supported hardware platforms. The PMOD connector is located between the power connector and the USB port.

The default IP address (when using the firmware manager) is 192.168.10.23, but you can set the subnet in a range between 192.168.10.23 and 192.168.25.23.

Procedure:

1. Make sure, the readout system is not powered.

2. Locate PMOD Pin1 (indicated by a white dot on the PCB).

3. The IP is set by putting jumpers on the PMOD connector, which short pin 1+2, 3+4, 5+6 and 7+8. Standard binary counting is used:

   PMOD_7+8	PMOD_5+6	PMOD_3+4	PMOD_1+2	IP_ADDRESS
   0	0	0	0	192.168.10.23
   0	0	0	1	192.168.11.23
   ...	...	...	...	...
   1	1	1	0	192.168.24.23
   1	1	1	1	192.168.25.23

4. Double check, that you did not place the jumper in the wrong place!

5. Turn the readout system on and verify the setting by a ping to the new IP address.

Usage

A testbench.yaml file containing information on the individual setup is required for operation. It is located in the tjmonopix2 folder and contains an extensive list of configuration options that are documented there.

Contributing

The master branch contains stable and well-tested code for reading out TJ-Monopix2. The development branch is not guaranteed to have stable and working code. If you want to contribute, create a feature branch off either of the mentioned branches and make a pull request against the respective branch when you have made progress on ongoing work or implemented a new feature.