com.xilinx.rapidwright.device

Class PIP

Object

com.xilinx.rapidwright.device.PIP

All Implemented Interfaces:

Serializable, Comparable<Object>

public class PIP
extends Object
implements Comparable<Object>, Serializable

This class represents the programmable-interconnect-points (PIPs) as found in Vivado designs. The wire names are stored as integers using their index within the Tile.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	NULL_END_WIRE_IDX Sentinel index for a partial PIP where only the start node is valid.
static char	PIP_TILE_SEPARATOR Character used in Vivado string representation of PIP
static char	PIP_TILETYPE_SEPARATOR Character used in Vivado string representation of PIP

Constructor Summary

Constructors

Constructor and Description
PIP(Device d, String tileName, String startWireName, String endWireName) Creates a new PIP from names of the tile and wires
PIP(PIP p) Copy constructor
PIP(PIP prototype, Tile newTile) Copy constructor and translate to new tile.
PIP(String pipName, Device dev) Constructs a PIP object based on its toString() representation.
PIP(Tile tile, int startWire, int endWire) Constructor that creates a new PIP from parameters.
PIP(Tile tile, String startWireName, String endWireName) Constructor that creates a new PIP from parameters.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) Compares this PIP to another PIP (for sorting purposes).
boolean	deepEquals(Object obj) Include flags on PIPs as part of equality check
int	deepHashCode() Includes flags set on PIP as part of hash
boolean	equals(Object obj)
List<Wire>	getAllPossibleEndWires() This method will return an array of all possible wire connections that can be made from the start wire of this PIP.
static PIP	getArbitraryPIP(Node startNode, Node endNode) Gets an arbitrary PIP between two nodes, if at least one exists.
Node	getEndNode() Creates and returns the end node associated with the start wire of this PIP.
RouteNode	getEndRouteNode() Creates and returns the end node associated with the start wire of this PIP.
Wire	getEndWire() Creates a new Wire object to represent the end wire of this PIP.
int	getEndWireIndex() Gets and returns the end wire id of this PIP.
String	getEndWireName() Gets the name of the end wire of the PIP.
PIPType	getPIPType() Gets the PIP type (denoted by the arrow string between start and end wire).
Node	getStartNode() Creates and returns the start node associated with the start wire of this PIP.
RouteNode	getStartRouteNode() Creates and returns the start node associated with the start wire of this PIP.
Wire	getStartWire() Creates a new Wire object to represent the start wire of this PIP.
int	getStartWireIndex() Gets the index of the start wire of this PIP.
String	getStartWireName() Gets the name of the start wire of the PIP.
Tile	getTile() Gets and returns the tile of this PIP.
int	hashCode()
boolean	isArcInverted() If the PIP is inverting the signal.
boolean	isBidirectional() Checks if the PIP is bidirectional
boolean	isEndWireNull() Checks if the end wire is null, which should only happen in a PIP marked as a GAP PIP
boolean	isGapArc() If this PIP(or Node) is driven by a GAP.
boolean	isLogicalDriver() Check if this PIP is a logical driver (nets with multiple site pin sources)
boolean	isPIPFixed() Checks if this PIP (in the context of a routed net) is fixed, such that Vivado cannot re-route it.
boolean	isReversed() A small number of PIPs are bi-directional, in those cases, sometimes the the signal flows in the opposite direction (EndWire-->StartWire).
boolean	isRouteThru() Flag indicating if this PIP is actually an abstracted route thru on a site.
boolean	isStub()
void	setIsLogicalDriver(boolean isLogicalDriver) Sets a flag on this PIP to denote that it is the logical driver when more than one output site pins exist on a net that are driven from the same source.
void	setIsPIPFixed(boolean isFixed) Sets this PIP as fixed such that Vivado cannot re-route it.
void	setIsReversed(boolean isReversed) Sets a flag on the PIP to keep track if the PIP is being used in a reversed direction (relevant for bi-directional PIPs only).
void	setTile(Tile tile) Sets the tile where this PIP resides.
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NULL_END_WIRE_IDX

public static final int NULL_END_WIRE_IDX

Sentinel index for a partial PIP where only the start node is valid.

Since:

2020.1.4

See Also:

Constant Field Values

PIP_TILE_SEPARATOR

public static final char PIP_TILE_SEPARATOR

Character used in Vivado string representation of PIP

Since:

2018.2.0

See Also:

Constant Field Values

PIP_TILETYPE_SEPARATOR

public static final char PIP_TILETYPE_SEPARATOR

Character used in Vivado string representation of PIP

Since:

2018.2.0

See Also:

Constant Field Values

Constructor Detail

PIP

public PIP(PIP p)

Copy constructor

Parameters:

p - The PIP to copy

Since:

2018.2.0

PIP

public PIP(Device d,
           String tileName,
           String startWireName,
           String endWireName)

Creates a new PIP from names of the tile and wires

Vivado Tcl:

foreach p [get_pips -downhill -of [get_wires -of $tile -filter NAME==$startWireName]] {if {$endWireName == [get_property NAME [lindex [get_wires -of $p] 1]]} {$p} }

Parameters:

d - The device from which to get the PIP

tileName - Name of the tile

startWireName - Name of the start wire

endWireName - Name of the end wire

Since:

2018.2.0

PIP

public PIP(Tile tile,
           int startWire,
           int endWire)

Constructor that creates a new PIP from parameters.

Vivado Tcl:

foreach p [get_pips -downhill -of [get_wires -of $tile -filter ID_IN_TILE_TYPE==$startWire]] {if {$endWire == [get_property ID_IN_TILE_TYPE [lindex [get_wires -of $p] 1]]} {$p} }

Parameters:

tile - The tile of the PIP.

startWire - The start wire of the PIP.

endWire - The end wire of the PIP.

Since:

2018.2.0

PIP

public PIP(Tile tile,
           String startWireName,
           String endWireName)

Constructor that creates a new PIP from parameters.

Vivado Tcl:

foreach p [get_pips -downhill -of [get_wires -of $tile -filter NAME==$tile/$startWireName]] {if {$tile/$endWireName == [get_property NAME [lindex [get_wires -of $p] 1]]} {$p} }

Parameters:

tile - The tile of the PIP.

startWireName - The start wire name of the PIP.

endWireName - The end wire name of the PIP.

Since:

2018.2.0

PIP

public PIP(String pipName,
           Device dev)

Constructs a PIP object based on its toString() representation. For example: 'INT_X3Y86/INT.LOGIC_OUTS_W20->INT_NODE_SDQ_75_INT_OUT1'

Vivado Tcl:

get_pips $pipName

Parameters:

pipName - The full name of the PIP (as used in Vivado)

dev - A reference to the device where the PIP exists

Since:

2018.2.0

PIP

public PIP(PIP prototype,
           Tile newTile)

Copy constructor and translate to new tile. Duplicates the PIP but translates it to a different tile.

Parameters:

prototype - The existing PIP to copy.

newTile - The new tile of the PIP to create

Method Detail

getTile

public Tile getTile()

Gets and returns the tile of this PIP.

Vivado Tcl:

get_tiles -of $this

Returns:

The tile where this PIP resides.

Since:

2018.2.0

setTile

public void setTile(Tile tile)

Sets the tile where this PIP resides. Useful for moving the PIP.

Parameters:

tile - The new tile of this PIP.

Since:

2018.2.0

getStartWireIndex

public int getStartWireIndex()

Gets the index of the start wire of this PIP.

Vivado Tcl:

get_property ID_IN_TILE_TYPE [lindex [get_wires -of $this] 0]

Returns:

The integer start wire.

Since:

2018.2.0

getStartWire

public Wire getStartWire()

Creates a new Wire object to represent the start wire of this PIP.

Vivado Tcl:

lindex [get_wires -of $this] 0

Returns:

The start wire of this PIP

Since:

2018.2.0

getEndWire

public Wire getEndWire()

Creates a new Wire object to represent the end wire of this PIP.

Vivado Tcl:

lindex [get_wires -of $this] 1

Returns:

The end wire of this PIP

Since:

2018.2.0

getPIPType

public PIPType getPIPType()

Gets the PIP type (denoted by the arrow string between start and end wire).

Vivado Tcl:

get_property NAME $this

Returns:

The associated PIPType for this PIP.

Since:

2018.2.0

getStartWireName

public String getStartWireName()

Gets the name of the start wire of the PIP.

Vivado Tcl:

get_property NAME [lindex [get_wires -of $this] 0]

Returns:

The name of the start wire of this PIP or null if invalid.

Since:

2018.2.0

getEndWireName

public String getEndWireName()

Gets the name of the end wire of the PIP.

Vivado Tcl:

get_property NAME [lindex [get_wires -of $this] 1]

Returns:

The name of the end wire of this PIP or null if invalid.

Since:

2018.2.0

getEndWireIndex

public int getEndWireIndex()

Gets and returns the end wire id of this PIP.

Vivado Tcl:

get_property ID_IN_TILE_TYPE [lindex [get_wires -of $this] 1]

Returns:

the endWire of this PIP.

Since:

2018.2.0

getStartNode

public Node getStartNode()

Creates and returns the start node associated with the start wire of this PIP.

Returns:

The start node of the PIP

Since:

2018.3.3

getEndNode

public Node getEndNode()

Creates and returns the end node associated with the start wire of this PIP.

Returns:

The end node of the PIP

Since:

2018.3.3

getStartRouteNode

public RouteNode getStartRouteNode()

Creates and returns the start node associated with the start wire of this PIP.

Returns:

The start node of the PIP

Since:

2018.3.3

getEndRouteNode

public RouteNode getEndRouteNode()

Creates and returns the end node associated with the start wire of this PIP.

Returns:

The end node of the PIP

Since:

2018.3.3

getAllPossibleEndWires

public List<Wire> getAllPossibleEndWires()

This method will return an array of all possible wire connections that can be made from the start wire of this PIP. Keep in mind that some of the wire connections that leave the tile are not PIPs.

Vivado Tcl:

set s "$tile/[get_property TILE_TYPE $tile].$startWireName*";get_pips -of $tile -filter NAME=~$s

Returns:

An array of all possible end wire connections from the PIP's start wire.

Since:

2018.2.0

isEndWireNull

public boolean isEndWireNull()

Checks if the end wire is null, which should only happen in a PIP marked as a GAP PIP

Returns:

True if the end node is null, false otherwise.

Since:

2020.1.4

isRouteThru

public boolean isRouteThru()

Flag indicating if this PIP is actually an abstracted route thru on a site.

Vivado Tcl:

get_property IS_PSEUDO $this

Returns:

True if the PIP is a route thru and both pins connect to site pins, false otherwise.

Since:

2018.2.2

deepHashCode

public int deepHashCode()

Includes flags set on PIP as part of hash

Returns:

Hash code that takes flags set on PIP as part of result.

Since:

2020.1.0

deepEquals

public boolean deepEquals(Object obj)

Include flags on PIPs as part of equality check

Parameters:

obj - The other object to check

Returns:

True if equal, false otherwise.

Since:

2020.1.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Object o)
              throws ClassCastException

Compares this PIP to another PIP (for sorting purposes).

Specified by:

compareTo in interface Comparable<Object>

Throws:

ClassCastException

Since:

2018.2.0

toString

public String toString()

Overrides:

toString in class Object

isStub

public boolean isStub()

Returns:

True if this PIP is a STUB.

Since:

2022.2.3

isLogicalDriver

public boolean isLogicalDriver()

Check if this PIP is a logical driver (nets with multiple site pin sources)

Returns:

True if this PIP is a logical driver, false otherwise.

Since:

2023.1.2

isGapArc

public boolean isGapArc()

If this PIP(or Node) is driven by a GAP. This PIP could be a partial PIP where only the start wire is valid.

Returns:

True if this PIP begins with a GAP.

Since:

2020.1.4

isArcInverted

public boolean isArcInverted()

If the PIP is inverting the signal.

Returns:

True if the PIP is inverting, false otherwise.

Since:

2023.2.2

isPIPFixed

public boolean isPIPFixed()

Checks if this PIP (in the context of a routed net) is fixed, such that Vivado cannot re-route it.

Vivado Tcl:

[get_property FIXED_ROUTE $net] != {}

Returns:

True if fixed, false otherwise.

Since:

2018.2.0

setIsLogicalDriver

public void setIsLogicalDriver(boolean isLogicalDriver)

Sets a flag on this PIP to denote that it is the logical driver when more than one output site pins exist on a net that are driven from the same source. This is a relatively rare condition, but should be set in order for the Vivado timer to correctly time the path. A common example of where this is needed is in the UltraScale SLICE architecture where a LUT can drive two outputs simultaneously (A_O and AMUX, for example). Without this properly being set, the route tree of nodes will be divided into two or more subtrees which is an incorrect representation.

Parameters:

isLogicalDriver -

Since:

2023.2.2

setIsPIPFixed

public void setIsPIPFixed(boolean isFixed)

Sets this PIP as fixed such that Vivado cannot re-route it.

Vivado Tcl:

set_property FIXED_ROUTE $this $net

Parameters:

isFixed - Fixed == true, unfixed == false

isBidirectional

public boolean isBidirectional()

Checks if the PIP is bidirectional

Vivado Tcl:

expr ![get_property IS_DIRECTIONAL $this]

Returns:

Since:

2018.2.0

isReversed

public boolean isReversed()

A small number of PIPs are bi-directional, in those cases, sometimes the the signal flows in the opposite direction (EndWire-->StartWire). This method returns the flag that can be set to indicate if the PIP is indeed being used in that direction.

Returns:

true if the PIP is bi-directional and being used in reverse, false otherwise.

Since:

2020.1.0

setIsReversed

public void setIsReversed(boolean isReversed)

Sets a flag on the PIP to keep track if the PIP is being used in a reversed direction (relevant for bi-directional PIPs only).

Parameters:

isReversed - The desired flag to be set on the PIP to indicate if it is being used in a reversed direction (EndWire-->StartWire)

Since:

2020.1.0

getArbitraryPIP

public static PIP getArbitraryPIP(Node startNode,
                                  Node endNode)

Gets an arbitrary PIP between two nodes, if at least one exists. Note some pairs of nodes can have multiple PIPs, this method gets an arbitrary one. Also note that in a few instances there are PIPs that don't always have two nodes and providing null for a node will not find those PIPs. For those instances, please use Node.getAllDownhillPIPs() or {@link Node#getAllUphillPIPs().

Parameters:

startNode - The matching start node or first node of the PIP to query

endNode - The matching end node or second node of the PIP to query

Returns:

An arbitrary PIP that connects the startNode and endNode together. Returns null if either of the input nodes are null or no such PIP connecting them exists.

Since:

2022.1.0