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.1.0.tar.gz (130.9 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-8.1.0-py3-none-any.whl (196.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hdl_registers-8.1.0.tar.gz
Algorithm Hash digest
SHA256 9e31794698dc113df87392a1e6fa7ac6b4c182b2ee81bce038ee1555d5770812
MD5 d39a24001ef31999097f2f2ce82771fe
BLAKE2b-256 d7014fda8bd7cf6d7b8bd16a00a19df434cf2522982cfb2764034c7b4faad250

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for hdl_registers-8.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 35c67cb2743ce1828e3020b9f0ae5516ecafd92198d43a27ebb3f16f2fd068ce
MD5 3ad9d482a7c7b89eb7cad5fa8370d1d2
BLAKE2b-256 6f480acdb4a77cc461af77d81e9173599d794d1395edf319a3377e4865725127

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