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.0.1.tar.gz (110.0 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.0.1-py3-none-any.whl (174.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hdl_registers-6.0.1.tar.gz
  • Upload date:
  • Size: 110.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for hdl_registers-6.0.1.tar.gz
Algorithm Hash digest
SHA256 1a77eefe8105e4303b2082ec824e0bf7332e2ba540fb88d9d4280298895dc7e4
MD5 2bcb40abf3491a5d14a01128ea85772a
BLAKE2b-256 f24f7fb71b7ab81d108bc4f5dc8115efed490bd4bd3dd25230ed6ffa4302b96b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hdl_registers-6.0.1-py3-none-any.whl
  • Upload date:
  • Size: 174.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for hdl_registers-6.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 663529ade16f110949b58c450acab1c415c3b8a202efec4c49c6ed20718ed60c
MD5 3b566377305c6f2cb44c9308d3962f01
BLAKE2b-256 8e6b827e2eb4c1bd96538933f834f75da606a4c0e71cb0309a7d576bca16c809

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