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.

  • C++

    • Complete class with setters and getters for registers and fields.

    • 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-7.0.0.tar.gz (113.0 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-7.0.0-py3-none-any.whl (178.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hdl_registers-7.0.0.tar.gz
  • Upload date:
  • Size: 113.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for hdl_registers-7.0.0.tar.gz
Algorithm Hash digest
SHA256 171024756a21d5afbf55b3be8c41cd7bd6f0df4148e04f5770c768cfd6d76a28
MD5 5695e52fc8c39703154377e357812f84
BLAKE2b-256 a14c4e5ec0474d3750b2430490ee12110853aace36d99efb5c8be006aa1ab1f5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hdl_registers-7.0.0-py3-none-any.whl
  • Upload date:
  • Size: 178.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for hdl_registers-7.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1812621a92865e5c8bfdb524cd7bc9b54a1dd472d10dd01599cd5e64a1932e53
MD5 11073f2ea3c43c9054a5c3ad725ef73e
BLAKE2b-256 e5194ee99741fe93713c07b40deb1b5c95c650ca308d9a3c3e50520293782ab5

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