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.1.0.tar.gz (110.7 kB view details)

Uploaded Source

Built Distribution

hdl_registers-6.1.0-py3-none-any.whl (175.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hdl_registers-6.1.0.tar.gz
Algorithm Hash digest
SHA256 036ff6e20758086675e64555511e4c6682126b938e5bcdb3ef589a0b0794949a
MD5 9559ddb4c081a05696f30249d8b7c2ab
BLAKE2b-256 261d86ed56693f9727926d8081f3517d05790fb64cc9921e1299316cb569452e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hdl_registers-6.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1e9876eb549ba33989c8b9ecf0492993db877074234ada8ae334ed321d68be4e
MD5 5166e06652ff30eaa5d67f59c7527118
BLAKE2b-256 1f9fa25b0f8ea49afc26219eb9f9af90ce62db79dd21d8f3eb872fadc916abe0

See more details on using hashes here.

Supported by

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