Open Source Access

FELIX firmware and software (including device drivers) are available in open source form under the Apache 2.0 licence.

This page contains links to code repositories and technical documentation.
Practical information can be found in the User Manual. For any inquiry, please contact us.

Hardware

Three FELIX PCIe cards have been developed, FLX-712 (PCIe Gen3), FLX-182 (PCIe Gen4) and FLX-155 (PCIe Gen5).
All cards are produced for physics experiments and are not commercially available.

Card Production Years Documents
FLX-712 2019-2020 Manual, Schematics
FLX-182-1B 2024-2025 Specification, Schematics
FLX-155 2026-2027 N/A

Firmware

Firmware source, including build instructions, is available at:

https://gitlab.cern.ch/atlas-tdaq-felix/firmware

Open IP cores used by FELIX are:.

IP Core Description Links
Wupper PCIe engine Source, Documentation
Core1990 Implementation of Interlaken protocol Repo and Documentation

Device drivers

Driver source, build instructions and documentation are available at https://gitlab.cern.ch/atlas-tdaq-felix/felix-tdaq-drivers

Software

Software releases are built using the repository

https://gitlab.cern.ch/atlas-tdaq-felix/felix-distribution

FELIX software requires the CVMS file system to be installed on the local host.
The main software packages are listed below.

Package Description Links
flxcard Low-level library to interface with the card drivers. Source, Documentation (HTML, PDF)
ftools Low-level tools. Source, Documentation in User Manual
felix-direct-readout Simple interface to read out data from FELIX ToHost DMA buffers Source of implementation, Source of interface
felix-star Suite of applications that interface the FELIX card to the network using the netio3 library Source, Documentation
felix-client Client library to communicate with felix-star Source
netio3 Network library front-end implementing data coalescence and publish/subscribe pattern. Source, Documentation
netio3-backend Network library back-end that provides support for RDMA (libfabric verbs) and TCP/IP (boost asio). Source, Documentation
felix-io REST web server to remotely access FELIX card registers and I2C devices Source

ATLAS TDAQ Software

As part of ATLAS operation, FELIX integrates with the TDAQ software infrastructure.
TDAQ software is also open source and can be found at https://gitlab.cern.ch/atlas-tdaq-software
FELIX software releases are independent from ATLAS TDAQ software.