com.xilinx.rapidwright.design.tools

Class RegisterInitTools

Object

com.xilinx.rapidwright.design.tools.RegisterInitTools

public class RegisterInitTools
extends Object

Utility methods for updating flip-flop initial values after place and route. This is useful to change the INIT value of registers without re-running implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INIT_PROPERTY

Constructor Summary

Constructors

Constructor and Description
RegisterInitTools()

Method Summary

Modifier and Type	Method and Description
static BigInteger	getRegisterValue(Design design, String registerBaseName, int width) Reads the current value of a multi-bit register.
static void	main(String[] args)
static int	setRegisterValue(Design design, String registerBaseName, BigInteger value, int width) Updates the INIT values of a multi-bit register given a BigInteger value.
static int	setRegisterValue(Design design, String registerBaseName, long value, int width) Updates the INIT values of a multi-bit register given a long value.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INIT_PROPERTY

public static final String INIT_PROPERTY

See Also:

Constant Field Values

Constructor Detail

RegisterInitTools

public RegisterInitTools()

Method Detail

setRegisterValue

public static int setRegisterValue(Design design,
                                   String registerBaseName,
                                   long value,
                                   int width)

Updates the INIT values of a multi-bit register given a long value. Assumes register bits are named with bus notation, e.g., "my_reg_reg[0]", "my_reg_reg[1]", etc.

Parameters:

design - The design containing the register

registerBaseName - The base name of the register without bus index (e.g., "my_reg_reg")

value - The new value to set

width - The width of the register in bits

Returns:

The number of flip-flops updated

setRegisterValue

public static int setRegisterValue(Design design,
                                   String registerBaseName,
                                   BigInteger value,
                                   int width)

Updates the INIT values of a multi-bit register given a BigInteger value. Assumes register bits are named with bus notation, e.g., "my_reg_reg[0]", "my_reg_reg[1]", etc.

Parameters:

design - The design containing the register

registerBaseName - The base name of the register without bus index (e.g., "my_reg_reg")

value - The new value to set

width - The width of the register in bits

Returns:

The number of flip-flops updated

getRegisterValue

public static BigInteger getRegisterValue(Design design,
                                          String registerBaseName,
                                          int width)

Reads the current value of a multi-bit register.

Parameters:

design - The design containing the register

registerBaseName - The base name of the register without bus index

width - The width of the register in bits

Returns:

The current value as a BigInteger, or throws a runtime exception if register not found

main

public static void main(String[] args)