Working with Python API

The recommended way of defining your registers and fields is to use a .toml data file. However depending on your needs it might make sense to define them directly in Python instead. This page will showcase a simple example of how to get started with this.

The Python code below sets up a RegisterList with two Registers and some fields. After this it performs a VHDL code generation.

Register TOML format example.

# Standard libraries
import sys
from pathlib import Path

# First party libraries
from hdl_registers.generator.vhdl.register_package import VhdlRegisterPackageGenerator
from hdl_registers.register_list import RegisterList


def main(output_folder: Path):
    """
    Set up some dummy registers and fields using the Python API.
    """
    register_list = RegisterList(name="caesar")

    register = register_list.append_register(
        name="config", mode="r_w", description="Configuration register."
    )

    register.append_bit_vector(
        name="tuser",
        description="Value to set for **TUSER** in the data stream.",
        width=4,
        default_value="0101",
    )

    register.append_integer(
        name="increment",
        description="Offset that will be added to data.",
        min_value=-4,
        max_value=3,
        default_value=0,
    )

    register = register_list.append_register(
        name="status", mode="r", description="General status register."
    )

    VhdlRegisterPackageGenerator(register_list=register_list, output_folder=output_folder).create()


if __name__ == "__main__":
    main(output_folder=Path(sys.argv[1]))

The articles in the the menubar on the left all showcase how to utilize the different features using the Python API as well as a TOML file. Please read these articles for further information.