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.

  • SystemVerilog

    • AXI-Lite register file using structures and native types to represent field values.

  • C++

    • Complete class with setters and getters for registers and fields. Uses structs and native C++ representation of values.

    • 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-8.0.1.tar.gz (128.2 kB view details)

Uploaded Source

Built Distribution

hdl_registers-8.0.1-py3-none-any.whl (194.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hdl_registers-8.0.1.tar.gz
Algorithm Hash digest
SHA256 43a9e7b27e405d3bf5c8831a3ffc5bf720788dee1c2887d6792d0f829414dc7a
MD5 7c05636e5af72049f9afc4da2315ec7b
BLAKE2b-256 65570e6976c8d8b0a393d1de2db5596939d9c115f81856a091e9de293a805304

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hdl_registers-8.0.1-py3-none-any.whl
  • Upload date:
  • Size: 194.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hdl_registers-8.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bf07b5f1851fbb10484c6e5c0e69746a420c8ba30aff5a93b8effbd51e1fb036
MD5 20486299e203b2243d2b4cf0f28ec8f7
BLAKE2b-256 bcb7f0d830fe1b203e2b44db9fc9663657274c706641a22a173c8338556c7bae

See more details on using hashes here.

Supported by

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