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-6.0.0.tar.gz (110.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-6.0.0-py3-none-any.whl (174.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hdl_registers-6.0.0.tar.gz
  • Upload date:
  • Size: 110.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for hdl_registers-6.0.0.tar.gz
Algorithm Hash digest
SHA256 6a575fcc2de58d96de97ad04be4b3a75d06b12005b197f11a62918a434697b31
MD5 6bff25b3514ee56e7687029515ecf81c
BLAKE2b-256 92c6e408bf14e395454edfc85eb13c65915f8f6885fd5103216c5ae9c7e681bd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hdl_registers-6.0.0-py3-none-any.whl
  • Upload date:
  • Size: 174.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for hdl_registers-6.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 131502a898e2b205bbf2bbd65432d8cabcfb6c56d01512762d6df29bca734ee2
MD5 9f77fd42a75787f41ebed4d476bba6db
BLAKE2b-256 f22f28b681410094bcb56204ba5dbf014f0eb538263de3c33626edbf757ca6e6

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