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.0.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.0-py3-none-any.whl (178.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hdl_registers-7.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 f5fc05ce25da0ceb04503960b2a4d616ad64d24221cba4c85214e828f2580ad6
MD5 31e22ccb81d6695e3febe32c54237078
BLAKE2b-256 0eed34d5dab3308132efcdc0d627bea85fd70fbcbdb17590b76088fea8be05ed

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hdl_registers-7.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b8c20b4ae8691527d1ed18de23ad0f91b7d7fb477127f6c12071fbeac32c3c11
MD5 c8c3aebb57c8e7fa10580f6244f0788d
BLAKE2b-256 f707b0246e8b47b022b189f88d5484ce95c40669795fbd4bb579ac778efc3953

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