FPGA Firmware Documentation

General Information

Welcome to the central documentation repository for the MSK FPGA Group. This platform serves as the comprehensive resource hub for all facets of our open-source initiatives, including detailed documentation on IPs, tools, and entire projects.

Aligned with the Documentation as Code methodology, each piece of documentation is integrated within its corresponding Git repository living along side the source code. Each documentation piece comes together withing the same git repository. This ensures that with each Git release, the associated documentation is readily available. Use the sidebar to select the specific release version.

The documentation of each repository is written with the Asciidoctor and static websites generated with the Antora tool.

In order to access the entire closed-source documentation please visit: fwdocu.msktools.desy.de/ (Internal DESY Users only)

Firmware Framework (fwk)

The documentation of the FPGA firmware framework (FWK). This is the main tool which all projects are build with.
This documentation explains all the details of FWK as well as provides tutorials for beginners.

Yocto (FwkLinux)

All the topics related to Yocto and Embedded Linux distro - FwkLinux

Firmware Projects

List of all FPGA projects

Firmware Modules

List of all the firmware modules/IPs

Firmware Libraries

List of all the HDL libraries documentation pages.

Firmware Tools

List of all the tools used within the build flow