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-5.2.0.tar.gz (103.8 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-5.2.0-py3-none-any.whl (162.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hdl_registers-5.2.0.tar.gz
  • Upload date:
  • Size: 103.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for hdl_registers-5.2.0.tar.gz
Algorithm Hash digest
SHA256 0052e93433418ff3b988fb137a43f2c39c4cd726e75143b1e97b0d12cbb3d469
MD5 903e324f0c592d901bacb8d4e3523770
BLAKE2b-256 9e1192c0e65e633ac8819e96e23aa431067b27c974bd29699c17d16bf931f1ea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hdl_registers-5.2.0-py3-none-any.whl
  • Upload date:
  • Size: 162.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for hdl_registers-5.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 887bed329d164027f88714e269486ecd1513b0168d566358aabadde0f03f4934
MD5 fa28cd8e1cb167ba960900b15e4a1eb3
BLAKE2b-256 5399b27a4e6410e9b197885cf7479b7e92977c6abdfb74b5e0bf5ce586129969

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