# 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](overview.md): high-level overview of the FIREQ firmware platform.
- [Architecture](architecture.md): system architecture and integration structure.
- [Modules](modules.md): descriptions of the main firmware modules.
- [Interfaces](interfaces.md): interfaces used to connect and control the modules.
- [Drivers](drivers.md): software drivers and hardware control interfaces.
- [Build](build.md): project setup and firmware build flow.
- [Style guidelines](style_guidelines.md): conventions for contributing to the firmware.

```{toctree}
:maxdepth: 2
:caption: Index

overview
architecture
modules
interfaces
drivers
build
style_guidelines
```

# Contributing and Support

Contributions to FIREQ are welcome, before making your contribution:

- open an [issue](https://github.com/vlsi-nanocomputing/FIREQ/issues) 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.

- [GitHub repository](https://github.com/vlsi-nanocomputing/FIREQ)
- [Issues](https://github.com/vlsi-nanocomputing/FIREQ/issues)