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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hdl_registers-7.0.1.tar.gz
Algorithm Hash digest
SHA256 ff9734c78ca32e1c7f6243cebc3a7a6a1ef5ec85167f71102282635dd8d9749a
MD5 766be479a11f2f5d19c383dfa5f24156
BLAKE2b-256 30728fe861c2ac979fc44a6ab529b2cb74b6532f191b9482447dcde6875ade80

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for hdl_registers-7.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fb0842cb6a0ed7ad030c3905b7e6fe9ba9b3c45094b1e3fcb5e641623e45c4a3
MD5 83a6c5cf6d8a6aec628476379755ae7e
BLAKE2b-256 c95a0aa9a40b1f2f0cdc4c85aaf9724d183cf9bbc808582b92901341fe1e42c3

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