com.xilinx.rapidwright.bitstream

Class Block

Object

com.xilinx.rapidwright.bitstream.Block

public class Block
extends Object

Represents a configuration block in the configuration array of the device. After frames, a block is the smallest configurable region of a device.

Since:

2020.2.1

Constructor Summary

Constructors

Constructor and Description
Block(Block orig) Copy constructor used as a convenience to duplicate a block.
Block(int blockAddress) Creates a new config block initialized with the provided address

Method Summary

Modifier and Type	Method and Description
boolean	copyFrameData(Block block) Copies all frame data from the provided block into the corresponding frames of this block.
int	getAddress() Gets the configuration block address as used in the Frame Address Register (FAR).
int	getBit(BitLocation bit, Tile tile) Gets the bit at the specified location for the provided tile
static Integer	getBlockHeight(Series series) Gets a configuration block height in terms of CLEs based on the provided series
int	getBlockType(Series series) Gets the integer value block type of this block, see BlockType
Tile	getBottomTile() Gets the bottom tile that is covered by this configuration block
ClockRegion	getClockRegion() Gets the corresponding clock region to which this configuration block belongs
int	getColumn(Series series) Gets the column address of this block in the Frame Address Register (FAR).
Frame	getFrame(int index) Gets the frame within the block at the specified offset.
int	getFrameCount() Gets the number of frames in this configuration block.
Frame[]	getFrames() Gets the array of frames corresponding to this block.
int	getRow(Series series) Gets the row address of this block in the Frame Address Register (FAR).
Series	getSeries() Gets the series of this block based on the sub block type.
BlockSubType	getSubType() Gets the block's sub type, see BlockSubType TileTypeEnum
int	getTileColumn() Gets the tile column index associated with this configuration block
int	getTopBotBit(Series series) Gets the top/bottom bit of this block's address in the Frame Address Register (FAR).
Tile	getTopTile() Gets the top tile that is covered by this configuration block
void	setAddress(int address) Updates the configuration block address as used in the Frame Address Register (FAR).
Frame	setFrame(int index, Frame frame) Sets (overwrites) the frame at the specified index within the block.
void	setSubType(BlockSubType subType) Updates the block's sub type, see BlockSubType TileTypeEnum
String	toString()
boolean	updateBit(BitLocation bit, Tile tile, int value) For the given bit location, it updates the bit to value and returns the previous value.
boolean	updateBit(BitLocation bit, Tile tile, int value, Block golden) For the given bit location, it updates the bit to value and returns the previous value.

Methods inherited from class Object

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

Constructor Detail

Block

public Block(int blockAddress)

Creates a new config block initialized with the provided address

Parameters:

blockAddress - The address of the config block

Since:

2020.2.1

Block

public Block(Block orig)

Copy constructor used as a convenience to duplicate a block. This is useful duplicating configuration or when creating BRAM content blocks.

Parameters:

orig - The original block to copy and use as a template

Since:

2020.2.1

Method Detail

getBlockHeight

public static Integer getBlockHeight(Series series)

Gets a configuration block height in terms of CLEs based on the provided series

Parameters:

series - The device series

Returns:

The height of a configuration block in the provided series in CLEs

Since:

2020.2.1

getAddress

public int getAddress()

Gets the configuration block address as used in the Frame Address Register (FAR).

Returns:

The configuration block address.

Since:

2020.2.1

setAddress

public void setAddress(int address)

Updates the configuration block address as used in the Frame Address Register (FAR).

Parameters:

address - The new configuration block address.

Since:

2020.2.1

getSubType

public BlockSubType getSubType()

Gets the block's sub type, see BlockSubType TileTypeEnum

Returns:

The block's sub type

Since:

2020.2.1

setSubType

public void setSubType(BlockSubType subType)

Updates the block's sub type, see BlockSubType TileTypeEnum

Parameters:

subType - The new block's sub type

Since:

2020.2.1

getColumn

public int getColumn(Series series)

Gets the column address of this block in the Frame Address Register (FAR).

Parameters:

series - The series of the current device

Returns:

the column address of this block

Since:

2020.2.1

getRow

public int getRow(Series series)

Gets the row address of this block in the Frame Address Register (FAR).

Parameters:

series - The series of the current device

Returns:

the column address of this block

Since:

2020.2.1

getTopBotBit

public int getTopBotBit(Series series)

Gets the top/bottom bit of this block's address in the Frame Address Register (FAR).

Parameters:

series - The series of the current device.

Returns:

The top/bottom bit (1 or 0) for the given block.

getBlockType

public int getBlockType(Series series)

Gets the integer value block type of this block, see BlockType

Parameters:

series - The series of the current device.

Returns:

The integer value block type of this block

Since:

2020.2.1

getClockRegion

public ClockRegion getClockRegion()

Gets the corresponding clock region to which this configuration block belongs

Returns:

The block's clock region

Since:

2020.2.1

getTileColumn

public int getTileColumn()

Gets the tile column index associated with this configuration block

Returns:

Tile column index of this block

Since:

2020.2.1

getSeries

public Series getSeries()

Gets the series of this block based on the sub block type.

Returns:

The series of this block

Since:

2020.2.1

getBottomTile

public Tile getBottomTile()

Gets the bottom tile that is covered by this configuration block

Returns:

The bottom tile in the block

Since:

2020.2.1

getTopTile

public Tile getTopTile()

Gets the top tile that is covered by this configuration block

Returns:

The top tile in the block

Since:

2020.2.1

getFrames

public Frame[] getFrames()

Gets the array of frames corresponding to this block. Note, this requires that the subtype of the block be set on block beforehand.

Returns:

The array of frames corresponding to this block.

Since:

2020.2.1

getFrame

public Frame getFrame(int index)

Gets the frame within the block at the specified offset. Note, this requires that the subtype of the block be set on block beforehand.

Parameters:

index - Index within the block.

Returns:

The specified frame at the provided index.

Since:

2020.2.1

getFrameCount

public int getFrameCount()

Gets the number of frames in this configuration block. Note, this requires that the subtype of the block be set on block beforehand.

Returns:

Number of frames in this configuration block.

Since:

2020.2.1

setFrame

public Frame setFrame(int index,
                      Frame frame)

Sets (overwrites) the frame at the specified index within the block. Note, this requires that the subtype of the block be set on block beforehand.

Parameters:

index - Index of the frame to set within the block

frame - The new frame to set into the specified index.

Returns:

The old frame (or null if none) previously associated with the index.

Since:

2020.2.1

copyFrameData

public boolean copyFrameData(Block block)

Copies all frame data from the provided block into the corresponding frames of this block.

Parameters:

block - The source block from which to copy the data

Returns:

True if the operation succeeded, false otherwise.

Since:

2021.1.1

getBit

public int getBit(BitLocation bit,
                  Tile tile)

Gets the bit at the specified location for the provided tile

Parameters:

bit - The bit location

tile - The reference tile

Returns:

The value of the bit at the specified location.

Since:

2023.1.3

updateBit

public boolean updateBit(BitLocation bit,
                         Tile tile,
                         int value)

For the given bit location, it updates the bit to value and returns the previous value.

Parameters:

bit - The bit location within the block

value - Desired value to set in the bit location

Returns:

True if the bit was changed, false otherwise.

Since:

2020.2.1

updateBit

public boolean updateBit(BitLocation bit,
                         Tile tile,
                         int value,
                         Block golden)

For the given bit location, it updates the bit to value and returns the previous value.

Parameters:

bit - The bit location within the block

value - Desired value to set in the bit location

golden - A reference configuration block that is checked with the value to be set and prints an error message if there is a mismatch.

Returns:

True if the bit was changed, false otherwise.

Since:

2023.1.3

toString

public String toString()

Overrides:

toString in class Object