Skip to content

Corsair

⚠️🚨⚠️ PROJECT'S VERSION 2.X IS UNDER ACTIVE DEVELOPMENT. ⚠️🚨⚠️

logo

Corsair navigates you through the CSR seas.
No more mismatches between hardware, software, and documentation.

Devcontainer Documentation Tests & Checks

Documentation | Repository

Corsair is a CLI tool and Python library designed to define and manage Control and Status Register (CSR) maps for HDL projects. It generates code and documentation from a single CSR description file, effectively eliminating any mismatches between different representations of registers.

Features

  • Single Source of Truth: Define CSR maps in a single file (e.g., YAML, JSON) and generate various outputs from it.
  • Code Generation: Automatically generate HDL, software sources, and documentation from the CSR map.
  • CLI and API: Offers both a command-line interface for quick operations and a Python API for more complex, custom workflows.
  • Customizable Workflows: Supports user-side extensions for attributes, configurations, templates, and input/output formats.

Check out the Concepts section to understand the core concepts of Corsair.