Integer constants

Register constants can be of type integer. This page will show you how the set up integer constants, as well as showcase all the code that can be generated from it.

Usage in TOML

The TOML file below shows how to set up a register list with two integer constants. Note that in the TOML, the type of the constant is determined by the type of the literal value.

TOML that sets up a register list with integer constants.

# This will allocate a register constant with the name "axi_data_width" of data type integer.
[axi_data_width]

# The "type" property MUST be present and set to "constant".
type = "constant"

# The "value" property MUST be present for an integer constant.
# The value specified MUST be an integer.
value = 64

# The "description" property is OPTIONAL for a constant.
# Will default to "" if not specified.
# The value specified MUST be a string.
description = "Data width of the AXI port used by this module."


[burst_length_beats]

type = "constant"
value = 256

Note that the second constant does not have a description specified, meaning it will default to an empty string.

Below you will see how you can parse this TOML file and generate artifacts from it.

Usage with Python API

The Python code below shows

1. How to parse the TOML file listed above.

2. How to create an identical register list when instead using the Python API.

3. How to generate register artifacts.

Note that the result of the create_from_api call is identical to that of the parse_toml call. Meaning that using a TOML file or using the Python API is completely equivalent. You choose yourself which method you want to use in your code base.

Python code that sets up a register list with integer constants.

# Standard libraries
import sys
from pathlib import Path

# First party libraries
from hdl_registers.generator.c.header import CHeaderGenerator
from hdl_registers.generator.cpp.interface import CppInterfaceGenerator
from hdl_registers.generator.html.page import HtmlPageGenerator
from hdl_registers.generator.vhdl.register_package import VhdlRegisterPackageGenerator
from hdl_registers.parser.toml import from_toml
from hdl_registers.register_list import RegisterList

THIS_DIR = Path(__file__).parent


def parse_toml() -> RegisterList:
    """
    Create the register list by parsing a TOML data file.
    """
    return from_toml(name="caesar", toml_file=THIS_DIR.parent / "toml" / "constant_integer.toml")


def create_from_api() -> RegisterList:
    """
    Alternative method: Create the register list by using the Python API.
    """
    register_list = RegisterList(name="caesar")

    register_list.add_constant(
        name="axi_data_width",
        value=64,
        description="Data width of the AXI port used by this module.",
    )

    register_list.add_constant(
        name="burst_length_beats",
        value=256,
        description="",
    )

    return register_list


def generate(register_list: RegisterList, output_folder: Path):
    """
    Generate the artifacts that we are interested in.
    """
    CHeaderGenerator(register_list=register_list, output_folder=output_folder).create()
    CppInterfaceGenerator(register_list=register_list, output_folder=output_folder).create()
    HtmlPageGenerator(register_list=register_list, output_folder=output_folder).create()
    VhdlRegisterPackageGenerator(register_list=register_list, output_folder=output_folder).create()


def main(output_folder: Path):
    generate(register_list=parse_toml(), output_folder=output_folder / "toml")
    generate(register_list=create_from_api(), output_folder=output_folder / "api")


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

See RegisterList.add_constant() for more Python API details.

Generated code

See below for a description of the code that can be generated with these constants.

Note that the examples on this page set up a register list with only constants, no registers. This allowed of course, but albeit a little bit rare.

HTML page

See HTML file below for the human-readable documentation that is produced by the generate() call in the Python example above.

HTML page

VHDL package

The VHDL code below is produced by the generate() call in the Python example above. Click the button to expand and view the code.

Click to expand/collapse code.

Generated VHDL code.

-- This file is automatically generated by hdl-registers version 6.1.1-dev.
-- Code generator VhdlRegisterPackageGenerator version 1.0.0.
-- Generated 2024-11-20 20:51 at commit 547d42cf1aaa5f86.
-- Register hash 4fc928c3ecfeb4682c3468952959c4763ee5636e.

library ieee;
use ieee.std_logic_1164.all;
use ieee.numeric_std.all;
use ieee.fixed_pkg.all;

library reg_file;
use reg_file.reg_file_pkg.all;


package caesar_regs_pkg is

  -- ---------------------------------------------------------------------------
  -- Values of register constants.
  constant caesar_constant_axi_data_width : integer := 64;
  constant caesar_constant_burst_length_beats : integer := 256;

end package;

C++ interface

The C++ interface header code below is produced by the generate() call in the Python example above. Click the button to expand and view the code.

Click to expand/collapse code.

Generated C++ interface class code.

// This file is automatically generated by hdl-registers version 6.1.1-dev.
// Code generator CppInterfaceGenerator version 1.0.0.
// Generated 2024-11-20 20:51 at commit 547d42cf1aaa5f86.
// Register hash 4fc928c3ecfeb4682c3468952959c4763ee5636e.

#pragma once

#include <cassert>
#include <cstdint>
#include <cstdlib>

namespace fpga_regs
{

  class ICaesar
  {
  public:
    // Register constant.
    static const int axi_data_width = 64;
    // Register constant.
    static const int burst_length_beats = 256;

    // Number of registers within this register map.
    static const size_t num_registers = 0uL;

    virtual ~ICaesar() {}

  };

} /* namespace fpga_regs */

C header

The C code below is produced by the generate() call in the Python example above.

Click to expand/collapse code.

Generated C code.

// This file is automatically generated by hdl-registers version 6.1.1-dev.
// Code generator CHeaderGenerator version 1.0.0.
// Generated 2024-11-20 20:51 at commit 547d42cf1aaa5f86.
// Register hash 4fc928c3ecfeb4682c3468952959c4763ee5636e.

#ifndef CAESAR_REGS_H
#define CAESAR_REGS_H

// Value of register constant 'axi_data_width'.
#define CAESAR_AXI_DATA_WIDTH (64)
// Value of register constant 'burst_length_beats'.
#define CAESAR_BURST_LENGTH_BEATS (256)

// Number of registers within this register map.
#define CAESAR_NUM_REGS (0u)

// Type for this register map.
typedef struct caesar_regs_t
{
} caesar_regs_t;

#endif // CAESAR_REGS_H