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-7.1.1.tar.gz (115.5 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-7.1.1-py3-none-any.whl (178.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hdl_registers-7.1.1.tar.gz
Algorithm Hash digest
SHA256 b160919eeeb2b2409a0e7566044b9b9db0b30c584041947f39d3a3336a693ca6
MD5 f955c7cd67d0cfd1e07d8ce8a623270a
BLAKE2b-256 dfe1b9f63129cc64430fd1d511d638d83ba028df9dbc43d366ce86d6eb29a715

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hdl_registers-7.1.1-py3-none-any.whl
  • Upload date:
  • Size: 178.3 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-7.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5b8ec11506d65c9e21c401df08d895530a7e2859dfbd5a1066a1037316e438d0
MD5 729801f5c923bb2f7441cce4d546d6f1
BLAKE2b-256 d74c7017f103b18baa357bc8475fe990a7a4c04d907b10b7004cd8e6a78e873a

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