CMS Ph2 ACF (Acquisition & Control Framework)

Contains:

• A middleware API layer, implemented in C++, which wraps the firmware calls and handshakes into abstracted functions
• A C++ object-based library describing the system components (CBCs, RD53, Hybrids, Boards) and their properties (values, status)

A short guide to write the GoldenImage to the SD card

1. Connect the SD card
2. Download the golden firmware from the cms-tracker-daq webpage
3. sudo fdisk -l - find the name of the SD card (for example, /dev/mmcblk0)
4. sudo chmod 744 /dev/sd_card_name - to be able to play with it
5. Go to the folder were you saved the sdgoldenimage.img file
6. dd if=sdgoldenimage.img of=/dev/sd_card_name bs=512 - to write the image to the SD card. If the SD card is partitioned (formatted), pay attention to write on the block device (e.g. /dev/mmcblk0) and not inside the partition (e.g. /dev/mmcblk0p1)
7. Once the previous command is done, you can list the SD card: ./imgtool /dev/sd_card_name list - there should be a GoldenImage.bin, with 20MB block size
8. Insert the SD card into the FC7

Alternatively, instead of the dd command above, to only copy the needed bytes you can do:

imageName=sdgoldenimage.img
dd if=$imageName bs=512 iflag=count_bytes of=somefile_or_device count=$(ls -s --block-size=1 $imageName | awk '{print $1}')

If you installed the command pv (sudo yum install -y pv), then the best way is the following (replacing /dev/mmcblk0 with your target device):

pv sdgoldenimage.img | sudo dd of=/dev/mmcblk0

Middleware for the Inner-Tracker (IT) system

+ Last change made to this section: 25/07/2022

Suggested software and firmware versions:

• Software git branch / tag : Dev / v4-06
• Firmware tag: 4.5

Important webpages:

• Mattermost forum: cms-it-daq
• DAQ web page: https://cms-tracker-daq.web.cern.ch/cms-tracker-daq/
• Detailed description of the various calibrations: https://cernbox.cern.ch/index.php/s/O07UiVaX3wKiZ78

FC7 setup:

1. Install wireshark in order to figure out which is the MAC address of your FC7 board (sudo yum install wireshark, then run sudo tshark -i ethernet_card, where ethernet_card is the name of the ethernet card of your PC to which the FC7 is connected to)
2. In /etc/ethers put mac_address fc7.board.1 and in /etc/hosts put 192.168.1.80 fc7.board.1
3. Restart the network: sudo /etc/init.d/network restart
4. Install the rarpd daemon (version for CENTOS6 should work just fine even for CENTOS7): sudo yum install rarp_file_name.rpm from here
5. Start the rarpd daemon: sudo systemctl start rarpd or sudo rarp -e -A (to start rarpd automatically after bootstrap: sudo systemctl enable rarpd)

More details on the hardware needed to setup the system can be found here

Firmware setup:

1. Check whether the DIP switches on FC7 board are setup for the use of a microSD card (out-in-in-in-out-in-in-in)
2. Insert a microSD card in the PC and run /sbin/fdisk -l to understand to which dev it's attached to (/dev/sd_card_name)
3. Upload a golden firmware on the microSD card (read FC7 manual or run dd if=sdgoldenimage.img of=/dev/sd_card_name bs=512)
4. Download the proper IT firmware version from here
5. Plug the microSD card in the FC7
6. From Ph2_ACF use the command fpgaconfig to upload the proper IT firmware (see instructions: IT-DAQ setup and run before running this command)

N.B.: a golden firmware is any stable firmware either from IT or OT, and it's needed just to initialize the IPbus communication at bootstrap (in order to create and image of the microSD card you can use the command: dd if=/dev/sd_card_name conv=sync,noerror bs=128K | gzip -c > sdgoldenimage.img.gz)
A golden firmware can be downloaded from the cms-tracker-daq webpage
A detailed manual about the firmware can be found here

IT-DAQ setup and run:

1. Folow instructions below to install all needed software packages (like pugixml, boost, python. etc ...)
2. mkdir choose_a_name
3. cp settings/RD53Files/CMSIT_RD53.txt choose_a_name
4. cp settings/CMSIT.xml choose_a_name
5. cd choose_a_name
6. Edit the file CMSIT.xml in case you want to change some parameters needed for the calibrations or for configuring the chip
7. Run the command: CMSITminiDAQ -f CMSIT.xml -r to reset the FC7 (just once)
8. Run the command: CMSITminiDAQ -f CMSIT.xml -c name_of_the_calibration (or CMSITminiDAQ --help for help)

N.B.: to speed up the IPbus communication you can implement this trick

Basic list of commands for the fpgaconfig program (run from the choose_a_name directory):

• Run the command: fpgaconfig -c CMSIT.xml -l to check which firmware is on the microSD card
• Run the command: fpgaconfig -c CMSIT.xml -f firmware_file_name_on_the_PC -i firmware_file_name_on_the_microSD to upload a new firmware to the microSD card
• Run the command: fpgaconfig -c CMSIT.xml -i firmware_file_name_on_the_microSD to load a new firmware from the microSD card to the FPGA
• Run the command: fpgaconfig --help for help

The program CMSITminiDAQ is the portal for all calibrations and for data taking. Through CMSITminiDAQ, and with the right command line option, you can run the following scans/ calibrations/ operation mode:

1. Latency scan
2. PixelAlive
3. Noise scan
4. SCurve scan
5. Gain scan
6. Threshold equalization
7. Gain optimization
8. Threshold minimization
9. Threshold adjustment
10. Injection delay scan
11. Clock delay scan
12. Bit Error Rate test
13. Data read back optimisation
14. Chip internal voltage tuning
15. Generic DAC-DAC scan
16. Physics

It might be useful to create one CMSIT.xml file for each "set" of calibrations. In the following it's reported the suggested sequence of calibrations, implemented in bash shell script:

#!/bin/bash
if [ $# -ne 1 ]
then
    echo "You should provide one, and only one, argument [step1, step2, step3, step4, step5, help]"
elif [ $1 == "step1" ]
then
    CMSITminiDAQ -f CMSIT_noise.xml -c noise # Masks noisy pixels
    echo "noise" >> calibDone.txt

    CMSITminiDAQ -f CMSIT_scurve.xml -c pixelalive # Masks dead pixels
    echo "pixelalive" >> calibDone.txt

    CMSITminiDAQ -f CMSIT_noise.xml -c thrmin
    echo "thrmin" >> calibDone.txt

    echo "Choose whether to accept new threshold (i.e. copy it into the xml file(s))"
    read -p "Press any key to continue... " -n1 -s
    echo
elif [ $1 == "step2" ]
then
    CMSITminiDAQ -f CMSIT_scurve.xml -c threqu
    echo "scurve" >> calibDone.txt
    echo "threqu" >> calibDone.txt

    CMSITminiDAQ -f CMSIT_scurve.xml -c scurve
    echo "scurve" >> calibDone.txt

    CMSITminiDAQ -f CMSIT_noise.xml -c noise # Masks noisy pixels @ new threshold
    echo "noise" >> calibDone.txt

    CMSITminiDAQ -f CMSIT_noise.xml -c thrmin
    echo "thrmin" >> calibDone.txt

    echo "Choose whether to accept new threshold (i.e. copy it into the xml file(s))"
    read -p "Press any key to continue... " -n1 -s
    echo
elif [ $1 == "step3" ]
then
    CMSITminiDAQ -f CMSIT_scurve.xml -c scurve
    echo "scurve" >> calibDone.txt

    CMSITminiDAQ -f CMSIT_gain.xml -c gain
    echo "gain" >> calibDone.txt

    CMSITminiDAQ -f CMSIT_gain.xml -c gainopt
    echo "gainopt" >> calibDone.txt

    echo "Choose whether to accept new Krummenacher current (i.e. copy it into the xml file(s))"
    echo "- Set nTRIGxEvent = 1 and DoOnlyNGroups = 1 in the xml file(s)"
    echo "- Set VCAL_HIGH to MIP value in the xml file(s)"
    read -p "Press any key to continue... " -n1 -s
    echo
elif [ $1 == "step4" ]
then
    CMSITminiDAQ -f CMSIT_scurve.xml -c injdelay
    echo "latency" >> calibDone.txt
    echo "injdelay" >> calibDone.txt

    echo "Choose whether to accept new LATENCY_CONFIG and INJECTION_SELECT (i.e. copy them into the xml file(s))"
    echo "- Set DoOnlyNGroups to 0 in the xml files(s)"
    read -p "Press any key to continue... " -n1 -s
    echo
elif [ $1 == "step5" ]
then
    CMSITminiDAQ -f CMSIT_scurve.xml -c scurve
    echo "scurve" >> calibDone.txt
elif [ $1 == "help" ]
then
    echo "Available options are:"
    echo "- step1 [noise + pixelalive + thrmin]"
    echo "- step2 [(pixelalive)threqu + scurve + noise + thrmin]"
    echo "- step3 [scurve + gain + gainopt]"
    echo "- step4 [(latency)injdelay]"
    echo "- step5 [scurve]"
else
    echo "Argument not recognized: $1"
fi

N.B.: steps 4 and 5 are meant to measure the so called "in-time threshold", to be compared with the threshold measured at step 3, which is the so called "absoulte threshold"

=-= End of Inner-Tracker section =-=

Setup

Firmware for the FC7 can be found in /firmware. Since the "old" FMC flavour is deprecated, only new FMCs (both connectors on the same side) are supported. You'll need Xilinx Vivado and a Xilinx Platform Cable USB II (http://uk.farnell.com/xilinx/hw-usb-ii-g/platform-cable-configuration-prog/dp/1649384). For more information on the firmware, please check the doc directory of https://gitlab.cern.ch/cms_tk_ph2/d19c-firmware

Gitlab CI setup for Developers (required to submit merge requests!!!)

1. Make sure you are subscribed to the cms-tracker-phase2-DAQ e-group

2. Add predefined variables

   i. from your fork go to Ph2_ACF > settings > CI/CD

   ii. expand the Variables section

   iii. click the Add variable button

    - add key: USER_NAME and value: <your CERN user name>

   iv. click the Add variable button

    - select the flag `Mask variable`
    - add key: USER_PASS and value: <your CERN password encoded to base64>
      e.g encode "thisword": printf "thisword" | base64

3. Enable shared Runners (if not enabled)

   i. from settings > CI/CD expand the Runners section

   ii. click the Allow shared Runners button

Setup on CentOs8

The following procedure will install (in order):

1. the boost and pugixml libraries
2. the cactus libraries for ipBus (using these instructions)
3. root with all its needed libraries
4. cmake, tools for clang, including clang-format and git-extras

# Libraries needed by Ph2_ACF
sudo yum install -y boost-devel pugixml-devel json-devel

# uHAL libraries (cactus)
sudo curl https://ipbus.web.cern.ch/doc/user/html/_downloads/ipbus-sw.centos8.x86_64.repo \
  -o /etc/yum.repos.d/ipbus-sw.repo
sudo yum-config-manager --enable powertools
sudo yum clean all
sudo yum groupinstall uhal

# ROOT
sudo yum install -y root root-net-http root-net-httpsniff root-graf3d-gl root-physics \
  root-montecarlo-eg root-graf3d-eve root-geom libusb-devel xorg-x11-xauth.x86_64

# Build tools and some nice git extras
sudo yum install -y cmake3
sudo yum install -y clang-tools-extra
sudo yum install -y git-extras

Install devtoolset 10

    $> sudo yum makecache --refresh
    $> sudo yum -y install gcc-toolset-10-gcc

Install python3

    $> sudo yum install -y python3 python3-devel

Install protobuf:

    Follow instructions to install protobuf from (Just install section is needed)
    https://gitlab.cern.ch/cms_tk_ph2/MessageUtils/-/blob/master/README.md

Install pybind11 (if installed in the same directoory when you plan to install the Ph2_ACF, the setup.sh will point to the correct location)

    $> wget https://github.com/pybind/pybind11/archive/refs/tags/v2.9.2.tar.gz
    $> tar zxvf v2.9.2.tar.gz

clang-format (required to submit merge requests!!!)

1. install 7.0 llvm toolset:

    $> yum install centos-release-scl
    $> yum install llvm-toolset-7.0

2. if you already sourced the environment, you should be able to run the command to format the Ph2_ACF (to be done before each merge request!!!):

    $> formatAll

Setup on CC7 (scroll down for instructions on setting up on SLC6)

1. Install devtoolset 10

    $> sudo yum install -y centos-release-scl-rh
    $> sudo yum install -y devtoolset-10

2. On CC7 you also need to install boost v1.53 headers (default on this system) and pugixml as they don't ship with uHAL any more:

    $> sudo yum install -y boost-devel pugixml-devel json-devel

3. Install uHAL. SW tested with uHAL version up to 2.7.1

    Follow instructions from 
    https://ipbus.web.cern.ch/ipbus/doc/user/html/software/install/yum.html

4. Install CERN ROOT

    $> sudo yum install -y root
    $> sudo yum install -y root-net-http root-net-httpsniff  root-graf3d-gl root-physics root-montecarlo-eg root-graf3d-eve root-geom libusb-devel xorg-x11-xauth.x86_64

5. Install CMAKE3 > 3.0:

    $> sudo yum install -y cmake3

6. Install python3

    $> sudo yum install -y python3 python3-devel

7. Install protobuf:

    Follow instructions from
    https://gitlab.cern.ch/cms_tk_ph2/MessageUtils/-/blob/master/README.md

8. Install pybind11 (if installed in the same directoory when you plan to install the Ph2_ACF, the setup.sh will point to the correct location)

    $> wget https://github.com/pybind/pybind11/archive/refs/tags/v2.9.2.tar.gz
    $> tar zxvf v2.9.2.tar.gz

Run in docker container

Docker container are provided to facilitate users and developers in setting up the framework.

All docker containers can be found here:
https://gitlab.cern.ch/cms_tk_ph2/docker_exploration/container_registry

Do run using one of the container, use the command:
$> docker run --rm -ti -v $PWD:$PWD -w $PWD <image>

Suggested emages are:
For users (comes with Ph2_ACF of Dev branch installed): `gitlab-registry.cern.ch/cms_tk_ph2/docker_exploration/cmstkph2_udaq_c7:latest`
For developers (no Ph2_ACF, just environment and libraries): `gitlab-registry.cern.ch/cms_tk_ph2/docker_exploration/cmstkph2_user_c7:latest`

Specific tags can be pulled substituting `latest` with `ph2_acf_<Ph2_ACF tag>` (i.e. `ph2_acf_v4-05`)

The Ph2_ACF software

Follow these instructions to install and compile the libraries: (provided you installed the latest version of gcc, µHal, mentioned above).

1. Clone the GitHub repo and run cmake

    $> git clone --recurse-submodules https://gitlab.cern.ch/cms_tk_ph2/Ph2_ACF.git # **N.B.** to syncrhonize only the submodule: `git submodule sync; git submodule update --init --recursive --remote`
    $> cd Ph2_ACF
    $> source setup.sh
    $> mkdir build 
    $> cd build 
    $> cmake .. # add -DCMAKE_BUILD_TYPE=Debug if you plan to use gdb for debugging, if you yum-instanlled `cmake3`, you might need to tall it `cmake3 ..`

2. Do a make -jN in the build/ directory or alternatively do make -C build/ -jN in the Ph2_ACF root directory.

3. Don't forget to source setup.sh to set all the environment variables correctly.

4. Launch

    $> systemtest --help

   command if you want to test the parsing of the HWDescription.xml file.

5. Launch

    $> datatest --help

   command if you want to test if you can correctly read data

6. Launch

    $> calibrate --help

   to calibrate a hybrid,

    $> hybridtest --help

   to test a hybird's I2C registers and input channel connectivity

      $> cmtest --help

   to run the CM noise study

      $> pulseshape --help

   to measure the analog pulseshape of the cbc

      $> configure --help

   to apply a configuration to the CBCs

7. Launch

      $> commission --help

   to do latency & threshold scans

8. Launch

      $> fpgaconfig --help

   to upload a new FW image to the GLIB

9. Launch

      $> miniDAQ --help

   to save binary data from the GLIB to file

10. Launch

      $> miniDQM --help

    to run the DQM code from the June '15 beamtest

Nota Bene

When you write a register in the Glib or the Cbc, the corresponding map of the HWDescription object in memory is also updated, so that you always have an exact replica of the HW Status in the memory.

Register values are:

• 8-bit unsigend integers for the CBCs that should be edited in hex notation, i.e. '0xFF'
• 32-bit unsigned integers for the GLIB: decimal values

For debugging purpose, you can activate DEV_FLAG in the sources or in the Makefile and also activate the uHal log in RegManager.cc.

External clock and trigger

Please see the D19C FW documentation for instructions on how to use external clock and trigger with the various FMCs (DIO5 and CBC3 FMC)

Example HWDescription.xml file with DIO5 support

<?xml version="1.0" encoding="utf-8"?>
<HwDescription>
  <BeBoard Id="0" boardType="D19C" eventType="VR">
      <connection id="board" uri="chtcp-2.0://localhost:10203?target=192.168.1.81:50001" address_table="file://settings/address_tables/d19c_address_table.xml" />

    <Hybrid FeId="0" FMCId="0" HybridId="0" Status="1">
        <Global>
            <Settings threshold="550" latency="26"/>
            <TestPulse enable="0" polarity="0" amplitude="0xFF" channelgroup="0" delay="0" groundothers="1"/>
            <ClusterStub clusterwidth="4" ptwidth="3" layerswap="0" off1="0" off2="0" off3="0" off4="0"/>
            <Misc analogmux="0b00000" pipelogic="0" stublogic="0" or254="1" tpgclock="1" testclock="1" dll="4"/>
            <ChannelMask disable=""/>
        </Global>
        <CBC_Files path="./settings/CbcFiles/" />
        <CBC Id="0" configfile="CBC3_default.txt" />
        <CBC Id="1" configfile="CBC3_default.txt" />
    </Hybrid>

    <SLink>
        <DebugMode type="FULL"/>
        <ConditionData type="I2C" Register="VCth1" FeId="0" CbcId="0"/>
        <ConditionData type="User" UID="0x80" FeId="0" CbcId="0"> 0x22 </ConditionData>
        <ConditionData type="HV" FeId="0" Sensor="2"> 250 </ConditionData>
        <ConditionData type="TDC" FeId="0xFF"/>
    </SLink>

    <!--CONFIG-->
    <Register name="clock_source">3</Register> <!-- 3 - default (internal oscillator), 2 - backplane, 0 - AMC13 -->
    <Register name="fc7_daq_cnfg">
	<!-- Clock control -->
	<Register name="clock">
	    <Register name="ext_clk_en"> 0 </Register>
	</Register>
        <!-- TTC -->
        <Register name="ttc">
            <Register name="ttc_enable"> 0 </Register>
        </Register>
        <!-- Fast Command Block -->
        <Register name="fast_command_block">
		<Register name="triggers_to_accept"> 0 </Register>
		<Register name="trigger_source"> 3 </Register>
		<Register name="user_trigger_frequency"> 1 </Register>
		<Register name="stubs_mask"> 1 </Register>
                <!--this is the delay for the stub trigger-->
		<Register name="stub_trigger_delay_value"> 0 </Register>
                <Register name="stub_trigger_veto_length"> 0 </Register>
		<Register name="test_pulse">
			<Register name="delay_after_fast_reset"> 50 </Register>
			<Register name="delay_after_test_pulse"> 200 </Register>
			<Register name="delay_before_next_pulse"> 400 </Register>
			<Register name="en_fast_reset"> 1 </Register>
			<Register name="en_test_pulse"> 1 </Register>
			<Register name="en_l1a"> 1 </Register>
		</Register>
                <Register name="ext_trigger_delay_value"> 50 </Register>
                <Register name="antenna_trigger_delay_value"> 200 </Register>
                <Register name="delay_between_two_consecutive"> 10 </Register>
                <Register name="misc">
                        <Register name="backpressure_enable"> 1 </Register>
                        <Register name="stubOR"> 1 </Register>
                        <Register name="initial_fast_reset_enable"> 0 </Register>
                </Register>
        </Register>
	<!-- I2C manager -->
        <Register name="command_processor_block">
	</Register>
	<!-- Phy Block -->
	<Register name="physical_interface_block">
		<Register name="i2c">
                	<Register name="frequency"> 4 </Register>
		</Register>
	</Register>
	<!-- Readout Block -->
    	<Register name="readout_block">
            <Register name="packet_nbr"> 99 </Register>
            <Register name="global">
		    <Register name="data_handshake_enable"> 1 </Register>
                    <Register name="int_trig_enable"> 0 </Register>
                    <Register name="int_trig_rate"> 0 </Register>
                    <Register name="trigger_type"> 0 </Register>
                    <Register name="data_type"> 0 </Register>
                    <!--this is what is commonly known as stub latency-->
                    <Register name="common_stubdata_delay"> 194 </Register>
            </Register>
    	</Register>
	<!-- DIO5 Block -->
	<Register name="dio5_block">
	    <Register name="dio5_en"> 0 </Register>
            <Register name="ch1">
                <Register name="out_enable"> 1 </Register>
                <Register name="term_enable"> 0 </Register>
                <Register name="threshold"> 0 </Register>
            </Register>
	    <Register name="ch2">
                <Register name="out_enable"> 0 </Register>
                <Register name="term_enable"> 1 </Register>
                <Register name="threshold"> 50 </Register>
            </Register>
	    <Register name="ch3">
                <Register name="out_enable"> 1 </Register>
                <Register name="term_enable"> 0 </Register>
                <Register name="threshold"> 0 </Register>
            </Register>
	    <Register name="ch4">
                <Register name="out_enable"> 0 </Register>
                <Register name="term_enable"> 1 </Register>
                <Register name="threshold"> 50 </Register>
            </Register>
	    <Register name="ch5">
                <Register name="out_enable"> 0 </Register>
                <Register name="term_enable"> 1 </Register>
                <Register name="threshold"> 50 </Register>
            </Register>
	</Register>
	<!-- TLU Block -->
	<Register name="tlu_block">
		<Register name="handshake_mode"> 2 </Register>
		<Register name="tlu_enabled"> 0 </Register>
	</Register>
    </Register>
  </BeBoard>

<Settings>

    <!--[>Calibration<]-->
    <Setting name="TargetVcth">0x78</Setting>
    <Setting name="TargetOffset">0x50</Setting>
    <Setting name="Nevents">50</Setting>
    <Setting name="TestPulsePotentiometer">0x00</Setting>
    <Setting name="HoleMode">0</Setting>
    <Setting name="VerificationLoop">1</Setting>

    <!--Signal Scan Fit-->
	  <Setting name="InitialVcth">0x78</Setting>
	  <Setting name="SignalScanStep">2</Setting>
    <Setting name="FitSignal">0</Setting>

</Settings>
</HwDescription>

Known issues

uHAL exceptions and UDP timeouts when reading larger packet sizes from the GLIB board: this can happen for some users (cause not yet identified) but can be circumvented by changing the line

"ipbusudp-2.0://192.168.000.175:50001"

in the connections.xml file to

"chtcp-2.0://localhost:10203?target=192.168.000.175:50001"

and then launching the CACTUS control hub by the command:

/opt/cactus/bin/controlhub_start

This uses TCP protocol instead of UDP which accounts for packet loss but decreases the performance.

Support, suggestions?

For any support/suggestions, mail to fabio.raveraSPAMNOT@cern.ch, mauro.dinardoSPAMNOT@cern.ch

Firmware repository for OT tracker

https://udtc-ot-firmware.web.cern.ch/