Skip to main content

An open-source HDL register interface code generator fast enough to run in real time

Project description

Project banner

Website Repository pypi License Chat CI status Python line coverage

The hdl-registers project is an open-source HDL register interface code generator fast enough to run in real time. It makes FPGA/ASIC development more fun by automating a lot of time-consuming manual work. It also minimizes the risk of bugs by removing the need for duplicate information. Read more

See documentation on the website: https://hdl-registers.com

Check out the source code on GitHub: https://github.com/hdl-registers/hdl-registers

The following features are supported:

Registers can be defined using a TOML/JSON/YAML data file or the Python API. The following code can be generated:

  • VHDL

    • AXI-Lite register file wrapper using records and native VHDL types for values.

    • Simulation support packages for compact read/write/wait/checking of register and field values.

  • SystemVerilog

    • AXI-Lite register file using structures and native types to represent field values.

  • C++

    • Complete class with setters and getters for registers and fields. Uses structs and native C++ representation of values.

    • Includes an abstract interface header for unit test mocking.

  • C header with register addresses and field information.

  • HTML website with documentation of registers and fields.

  • Python class with methods to read/write/print each register and field on a target device.

The tool can also be extended by writing your own code generator using a simple but powerful API.

This project is mature and used in many production environments. The maintainers place high focus on quality, with everything having good unit test coverage and a thought-out structure.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hdl_registers-8.0.0.tar.gz (128.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hdl_registers-8.0.0-py3-none-any.whl (194.0 kB view details)

Uploaded Python 3

File details

Details for the file hdl_registers-8.0.0.tar.gz.

File metadata

  • Download URL: hdl_registers-8.0.0.tar.gz
  • Upload date:
  • Size: 128.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hdl_registers-8.0.0.tar.gz
Algorithm Hash digest
SHA256 2555f629a54dc210e6f6742541861b0621fcc23c855787e56bbd07b9b0b4dad7
MD5 80aaed305e959ea0cc2e771637158a35
BLAKE2b-256 113a5e8eb416c72fd3b94ca40dc1948847bfe5dc1cbdc8ec9c002cf20e42ead2

See more details on using hashes here.

File details

Details for the file hdl_registers-8.0.0-py3-none-any.whl.

File metadata

  • Download URL: hdl_registers-8.0.0-py3-none-any.whl
  • Upload date:
  • Size: 194.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hdl_registers-8.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d4ca98abcca1cae24f9e2f5820d98b6a4651fe25a732e3ca6dd278422858acbe
MD5 885a57f253e370f0299edb99aa177088
BLAKE2b-256 5f698dee7065f5b203a4d7e6cdd62b76948af0c1466cb1eadf685d406869c43e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page