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

Uploaded Python 3

File details

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

File metadata

  • Download URL: hdl_registers-6.2.0.tar.gz
  • Upload date:
  • Size: 110.8 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.2.0.tar.gz
Algorithm Hash digest
SHA256 b959b6563975f25510a6606bc92d310fcddfe066cfbdb4dcd3ba92dd95744933
MD5 e6f0f9a198b392ebfc4dfd7b1ef1096f
BLAKE2b-256 55c635bf10d7f9d36b16e99fd6ee8e8010ce7b298ab4d5f258b7ccc0f8a11e7b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hdl_registers-6.2.0-py3-none-any.whl
  • Upload date:
  • Size: 175.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for hdl_registers-6.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee8b9ffde8b240af672572dfd9ca3c6d4a43182e5bed644e58f22bb9cf16352c
MD5 16b0fae15c67638a12f057c364954ef5
BLAKE2b-256 86e7c309877b33190b71aea28109618831fe79c01b1151a29337f74f3110c4da

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