FIREQ Firmware#

FIREQ firmware contains the HDL, board-level logic, and integration assets of the FIREQ platform for RFSoC-based instrumentation and control.

The documentation is organized to guide you from the high-level architecture and module overview to the build flow and interfaces used by the implementation.

Quick navigation#

For a more detailed explanation, see:

  • Overview: high-level overview of the FIREQ firmware platform.

  • Architecture: system architecture and integration structure.

  • Modules: descriptions of the main firmware modules.

  • Interfaces: interfaces used to connect and control the modules.

  • Drivers: software drivers and hardware control interfaces.

  • Build: project setup and firmware build flow.

  • Style guidelines: conventions for contributing to the firmware.

Index

Contributing and Support#

Contributions to FIREQ are welcome, before making your contribution:

  • open an issue detailing the problem or enhancement (optional but highly recommended).

  • create a new branch for your feature.

  • make your modifications following the style guidelines.

  • once you are done, create a merge request.

Contacts#

For questions, bug reports, or contributions, please use the GitHub repository for the firmware project.