com.xilinx.rapidwright.bitstream

Class ConfigArray

Object

com.xilinx.rapidwright.bitstream.ConfigArray

public class ConfigArray
extends Object

Represents the array of configuration blocks that configures the device. It is composed of an array of ConfigRows, each of which is an array of config Blocks.

Since:

2020.2.1

Field Summary

Fields

Modifier and Type	Field and Description
static int	FRAME_OVERHEAD_COUNT_PER_ROW The number of extra frames at the end of a configuration row

Constructor Summary

Constructors

Constructor and Description
ConfigArray(Device device) Creates a new config array based on the provided device

Method Summary

Modifier and Type	Method and Description
boolean	addConfigRow(ConfigRow configRow) Adds a config row to the array (at the end of the list)
void	createConfigArray() Creates a configuration array from the device specified in the object.
Block	getConfigBlock(Tile tile) Get the configuration block that corresponds to the provided tile.
Block	getConfigBlock(Tile tile, BlockType blockType) Gets the configuration block that corresponds to the provided tile and block type.
ConfigRow	getConfigRow(int blockType, int topBot, int row) Gets the configuration row based on blockType (CLB vs.
ConfigRow	getConfigRow(int blockType, int topBot, int farRow, int slrCfgOrder) Gets the configuration row based on blockType (CLB vs.
List<ConfigRow>	getConfigRows() Gets the rows in the config array (in config order)
static int[]	getCRIndicesInConfigRowOrder(Device d) Returns an array of clock region indices that correspond to the order in which they appear in the contiguous FAR address space.
Device	getDevice() Gets the device associated with this config array
Frame	getFrame(FAR far) Gets the frame in SLR0 (or monolithic devices) by default at the frame address register specified.
Frame	getFrame(FAR far, int slrCfgOrder) For multi-SLR devices, the FAR has the same addresses as other, so all config rows must use an offset for the SLR.
int	getNumOfConfigRows() Gets the total number of config rows in the config array
List<Packet>	getPackets() Creates the list of packets that correspond to the current state of this configuration array.
int	getWordSize() Gets the total number of words in the config array.
void	updateUserStateBits(Cell... cells) Updates the users state bits of the provided cells within this config array.

Methods inherited from class Object

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

Field Detail

FRAME_OVERHEAD_COUNT_PER_ROW

public static final int FRAME_OVERHEAD_COUNT_PER_ROW

The number of extra frames at the end of a configuration row

Since:

2021.2.2

See Also:

Constant Field Values

Constructor Detail

ConfigArray

public ConfigArray(Device device)

Creates a new config array based on the provided device

Parameters:

device - The target device of the config array

Since:

2020.2.1

Method Detail

getDevice

public Device getDevice()

Gets the device associated with this config array

Returns:

The device of this config array

Since:

2020.2.1

getCRIndicesInConfigRowOrder

public static int[] getCRIndicesInConfigRowOrder(Device d)

Returns an array of clock region indices that correspond to the order in which they appear in the contiguous FAR address space. This compensates for Series 7 top and bottom half. For multi-SLR devices, only provides the rows for one SLR.

Parameters:

d - The target device

Returns:

Clock region indices in the order of their configuration.

Since:

2020.2.1

getPackets

public List<Packet> getPackets()

Creates the list of packets that correspond to the current state of this configuration array.

Returns:

Conventional packet list with configuration array applied.

Since:

2020.2.1

createConfigArray

public void createConfigArray()

Creates a configuration array from the device specified in the object.

Since:

2020.2.1

getWordSize

public int getWordSize()

Gets the total number of words in the config array.

Returns:

Number of config words used in the config array

Since:

2020.2.1

getFrame

public Frame getFrame(FAR far)

Gets the frame in SLR0 (or monolithic devices) by default at the frame address register specified.

Parameters:

far - The FAR object set to the address being requested

Returns:

The frame at the specified address in SLR0 or null otherwise.

Since:

2020.2.1

getFrame

public Frame getFrame(FAR far,
                      int slrCfgOrder)

For multi-SLR devices, the FAR has the same addresses as other, so all config rows must use an offset for the SLR. This gets the frame

Parameters:

far - The FAR object set to the address being requested in the context of the SLR

slrCfgOrder - The frame from which SLR to get. In multi-SLR devices, each SLR has its own context.

Returns:

The frame at the FAR location specified and in the SLR specified.

Since:

2020.2.1

getConfigRow

public ConfigRow getConfigRow(int blockType,
                              int topBot,
                              int row)

Gets the configuration row based on blockType (CLB vs. BRAM_CONTENT), top or bottom half (Series 7 devices) and the actual row index.

Parameters:

blockType - The integer value of enum BlockType.

topBot - The Series 7 top bottom flag (Top=0, Bottom=1), by default all other architectures are Top=0

row - The row index encoded in the frame address (see FAR)

Returns:

The configuration row specified.

Since:

2020.2.1

getConfigRow

public ConfigRow getConfigRow(int blockType,
                              int topBot,
                              int farRow,
                              int slrCfgOrder)

Gets the configuration row based on blockType (CLB vs. BRAM_CONTENT), top or bottom half (Series 7 devices, FAR row index and the SLR.

Parameters:

blockType - The integer value of enum BlockType.

topBot - The Series 7 top bottom flag (Top=0, Bottom=1), by default all other architectures are Top=0

farRow - The row index encoded in the frame address (see FAR)

slrCfgOrder - Configuration order index of the SLR to get the config row. The FAR does not span multiple SLRs and requires context of the SLR to properly get the global row.

Returns:

The configuration row specified.

Since:

2020.2.1

getConfigBlock

public Block getConfigBlock(Tile tile)

Get the configuration block that corresponds to the provided tile. The block type is assumed to be CLB.

Parameters:

tile - The tile of interest

Returns:

The configuration block that corresponds to the provided tile, or null if none could be found.

Since:

2020.2.1

getConfigBlock

public Block getConfigBlock(Tile tile,
                            BlockType blockType)

Gets the configuration block that corresponds to the provided tile and block type.

Parameters:

tile - The tile of interest

blockType - Valid block types are CLB and BRAM_CONTENT

Returns:

The configuration block that corresponds to the provided tile, or null if none could be found.

Since:

2020.2.1

getNumOfConfigRows

public int getNumOfConfigRows()

Gets the total number of config rows in the config array

Returns:

Total number of config rows in the array

Since:

2020.2.1

getConfigRows

public List<ConfigRow> getConfigRows()

Gets the rows in the config array (in config order)

Returns:

The list of rows in the config array

Since:

2020.2.1

addConfigRow

public boolean addConfigRow(ConfigRow configRow)

Adds a config row to the array (at the end of the list)

Parameters:

configRow - The new row to add

Returns:

True if the operation succeeded, false otherwise

Since:

2020.2.1

updateUserStateBits

public void updateUserStateBits(Cell... cells)

Updates the users state bits of the provided cells within this config array. This supports updating user state bits (such as flip-flop INIT, LUTRAM INIT and BRAM INIT). These bits are described using the 'write_bitstream -logic_location_file' command in Vivado. If cells that do not affect state bits are provided to the method, no changes will take place in the ConfigArray.

Parameters:

cells - The cell(s) containing the updated state settings, see EDIFPropertyObject

Since:

2020.2.1