The Pretty Fine Libary (pflib) encapsulates library functionality for communicating with the HGCROC on the HCAL and ECAL front ends and provides a simple user frontend for use with the ZCU102-based readouts (both direct readout and via lpGBT).
The library is separated from the rest of the development for efficiency at this time.
We assume you have the YAML parser yaml-cpp and at least one of the communication methods below installed.
git clone https://github.com/LDMX-Software/pflib.git
cd pflib
git tag # see tags, pick latest
git checkout v1.11 # or whatever is latest
cmake -B build -S . # may need to provide paths to dependencies
cd build
make
./pftool -h # print help
Versions 1 and 2 were designed with a different board setup where we were connecting to
an intermediate PolarFire board (hence the pf in the name) that connected to the HGCROC.
This mode was used for a preliminary testbeam and a lot of additional development was done
on top of the basic setup.
We have now switched to a connection where we SSH to a ZCU board which then connects to
the HGCROC directly. This connection has been enabled after branching off of v2.0.6
and is the new main branch which has led to a weird branch structure.
v2.0.6 tag
|
--o--o--o--o--o--o--o--o--o--o--o <- `main` branch where releases v3 and above will be
\
\o--o--o--o--o--o <- `v2` branch with releases >v2.0.6 and <v3
We (Jeremy and Tom) have decided to do this so that we can pick and choose which features that were developed for the testbeam to copy over to the new connection structure. Some of them rely on the old connection structure and so do not work with the new structure.
The more detailed documentation for this compilation can be found in the pflib/Compile.h file. The \hgcrocmanual is also a decent reference since that is where most of the parameter names are pulled from. The documentation of \dataformats is helpful for learning how to decode the raw files.
Translating YAML files containing named settings and their values into actual register values that can be written to the chip requires a (you guessed it) YAML parser. I have chosen to use yaml-cpp which is very light and easy to install. v0.6.3 is installed in the ZCU image Jeremy has shared.
Note: Make sure to build yaml-cpp with the YAML_BUILD_SHARED_LIBS=ON cmake option so that we can link it properly to our code.
An outline of the terminal commands necessary to install yaml-cpp is given below.
mkdir yaml-cpp
wget -q -O - \
https://github.com/jbeder/yaml-cpp/archive/refs/tags/yaml-cpp-0.7.0.tar.gz |\
tar xz --strip-components=1 --directory yaml-cpp
cd yaml-cpp
cmake -B build -S . -DYAML_BUILD_SHARED_LIBS=ON
cd build
make install
This software can communicate with the HGCROC and other front-end items using several different methods.
This mode of operation is used for the HCAL HGCROC board tester. It has no external dependencies as it uses /dev/i2c character devices for communication.
Besides these two "larger" dependencies, we simply use some C++14 as well as the GNU readline library for the pftool.
This effectively restricts us to relatively new Linux systems; we haven't tested this library on a large set of potentional options.
For HGCROC tester setups, we connect to the HGCROV directly over I2C from a ZCU with a standardized image Jeremy has shared via Google Drive.
| Layer | Description |
|---|---|
| OS | AlmaLinux 9.4 |
| gcc | 11.4.1 |
| cmake | 3.26.5 |
| readline | 8.1 |
| yaml-cpp | 0.6.3 |
| Layer | Description |
|---|---|
| OS | CentOS Stream 8 |
| gcc | 8.5.0 |
| cmake | 3.20.2 |
| yaml-cpp | 0.7.0 |
| readline | 7.0 |
| Layer | Description |
|---|---|
| OS | openSUSE Leap 15.3 |
| gcc | 7.5.0 |
| cmake | 3.17.0 |
| yaml-cpp | 0.7.0 |
| readline | 7.0 |
| Rogue | NA |
| uHAL | 2.8.1 |
- config : helpful HGC ROC YAML parameter settings to load onto chips
- docs : documentation generation and helpful PDF manuals
- include : header files
- src : implementation files
- tool : executables and supporting source files
- uhal : XML files used for configuring uHAL connection