com.xilinx.rapidwright.device

Class ClockRegion

Object

com.xilinx.rapidwright.device.ClockRegion

All Implemented Interfaces:

PBlockCorner, Serializable

public class ClockRegion
extends Object
implements Serializable, PBlockCorner

Represents a clock region (a rectangular group of tiles on a device) that has shared clocking resources. Clock regions are numbered starting at the lower left of the device and moving right and up (X0Y0, X1Y0, ..., X0Y1, ...) Created on: Mar 1, 2016

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	containsTile(Tile tile) Checks if this clock region contains the specified tile.
boolean	equals(Object obj)
Tile	getApproximateCenter() Calculates the approximate tile in the center of the clock region.
int	getColumn() Gets the column (X coordinate) to which this clock regions belongs.
int	getConfigRowIndex() Gets the configuration row index for this clock region.
Device	getDevice() Gets the corresponding device parent for this clock region
int	getInstanceX() Gets the X coordinate (column) of this clock region
int	getInstanceY() Gets the Y coordinate (row) of this clock region
Tile	getLowerLeft() Gets the bottom left most tile based on the TOP_LEFT_TILE and BOTTOM_RIGHT_TILE designations.
Tile	getLowerRight() Gets the bottom right most tile that belongs to the clock region
int	getManhattanDistance(ClockRegion clockRegion) Calculated the Manhattan distance between this clock region and another clock region in terms of clock region indices.
String	getName() Gets the name of the clock region (for example: X0Y0)
ClockRegion	getNeighborClockRegion(int rowOffset, int colOffset) Gets a neighbor clock region using an offset approach.
int	getRow() Gets the row (Y coordinate) to which this clock regions belongs.
SLR	getSLR() Gets the SLR to which this clock region belongs.
Tile	getUpperLeft() Gets the top left most tile that belongs to the clock region
Tile	getUpperRight() Gets the top right most tile based on the TOP_LEFT_TILE and BOTTOM_RIGHT_TILE designations.
int	hashCode()
boolean	hasTileColumn(int colIndex) Checks if a particular tile column is within the boundaries of the clock region.
boolean	hasTileType(TileTypeEnum type) Checks if the clock region has any tiles of a particular type by scanning horizontally across the bottom row.
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getRow

public int getRow()

Gets the row (Y coordinate) to which this clock regions belongs.

Vivado Tcl:

get_property ROW_INDEX [get_clock_regions $cr]

Returns:

the row

Since:

2018.2.0

getColumn

public int getColumn()

Gets the column (X coordinate) to which this clock regions belongs.

Vivado Tcl:

get_property COLUMN_INDEX [get_clock_regions $cr]

Returns:

the column

Since:

2018.2.0

getName

public String getName()

Gets the name of the clock region (for example: X0Y0)

Vivado Tcl:

get_property NAME [get_clock_regions $cr]

Specified by:

getName in interface PBlockCorner

Returns:

the name

Since:

2018.2.0

getUpperLeft

public Tile getUpperLeft()

Gets the top left most tile that belongs to the clock region

Vivado Tcl:

get_property TOP_LEFT_TILE [get_clock_regions $cr]

Returns:

Upper left-most tile of the clock region

Since:

2018.2.0

getLowerRight

public Tile getLowerRight()

Gets the bottom right most tile that belongs to the clock region

Vivado Tcl:

get_property BOTTOM_RIGHT_TILE [get_clock_regions $cr]

Returns:

Bottom right-most tile of the clock region

Since:

2018.2.0

getLowerLeft

public Tile getLowerLeft()

Gets the bottom left most tile based on the TOP_LEFT_TILE and BOTTOM_RIGHT_TILE designations.

Returns:

The bottom left most tile based on the left-most column and bottom-most row.

Since:

2022.1.0

getUpperRight

public Tile getUpperRight()

Gets the top right most tile based on the TOP_LEFT_TILE and BOTTOM_RIGHT_TILE designations.

Returns:

The top right most tile based on the right-most column and top-most row.

Since:

2022.1.0

getApproximateCenter

public Tile getApproximateCenter()

Calculates the approximate tile in the center of the clock region.

Vivado Tcl:

set br [get_tiles [get_property BOTTOM_RIGHT_TILE $cr]]; set tl [get_tiles [get_property TOP_LEFT_TILE $cr]]; set c [expr (([get_property COLUMN $br] - [get_property COLUMN $tl])/2) + [get_property COLUMN $tl]]; set r [expr (([get_property ROW $br] - [get_property ROW $tl])/2) + [get_property ROW $tl]]; get_tiles -filter {ROW==$r && COLUMN==$c}

Returns:

The approximate center tile of the clock region.

Since:

2018.2.0

getNeighborClockRegion

public ClockRegion getNeighborClockRegion(int rowOffset,
                                          int colOffset)

Gets a neighbor clock region using an offset approach.

Vivado Tcl:

get_clock_region "X[expr [get_property COLUMN_INDEX $cr] + $colOffset]Y[expr [get_property ROW_INDEX $cr] + $rowOffset]"

Parameters:

rowOffset - Row offset from this clock region to get.

colOffset - Column offset from this clock region to get.

Returns:

The clock region at the specified offset from this instance.

Since:

2018.2.0

getManhattanDistance

public int getManhattanDistance(ClockRegion clockRegion)

Calculated the Manhattan distance between this clock region and another clock region in terms of clock region indices.

Parameters:

clockRegion - The other clock region to calculate distance.

Returns:

Clock region grid Manhattan distance

Since:

2019.1.0

hasTileColumn

public boolean hasTileColumn(int colIndex)

Checks if a particular tile column is within the boundaries of the clock region.

Parameters:

colIndex - The tile column index (see Tile.getColumn().

Returns:

True if the index falls within this clock region's boundaries, false otherwise.

Since:

2019.2.1

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hasTileType

public boolean hasTileType(TileTypeEnum type)

Checks if the clock region has any tiles of a particular type by scanning horizontally across the bottom row.

Vivado Tcl:

[llength [get_tiles -of_objects [get_clock_regions $cr] -filter TYPE==$type]] > 0

Parameters:

type - The tile type to query.

Returns:

True if a tile of type type exists within the clock region, false otherwise.

Since:

2018.2.0

getConfigRowIndex

public int getConfigRowIndex()

Gets the configuration row index for this clock region.

Returns:

The configuration (order) index for this clock region.

Since:

2019.1.3

getInstanceX

public int getInstanceX()

Gets the X coordinate (column) of this clock region

Specified by:

getInstanceX in interface PBlockCorner

Since:

2018.2.0

getInstanceY

public int getInstanceY()

Gets the Y coordinate (row) of this clock region

Specified by:

getInstanceY in interface PBlockCorner

Since:

2018.2.0

getDevice

public Device getDevice()

Gets the corresponding device parent for this clock region

Specified by:

getDevice in interface PBlockCorner

Since:

2018.2.0

getSLR

public SLR getSLR()

Gets the SLR to which this clock region belongs.

Returns:

This clock region's SLR

Since:

2019.2.0

containsTile

public boolean containsTile(Tile tile)

Checks if this clock region contains the specified tile. (Note there are some tiles that do not belong to a specific clock region that exist between clock region borders)

Parameters:

tile - The tile to query

Returns:

True if this tile is within the clock region boundaries, false otherwise.

Since:

2019.2.0