com.xilinx.rapidwright.device

Class BELPin

Object

com.xilinx.rapidwright.device.BooleanFlagHelper

com.xilinx.rapidwright.device.BELPin

public class BELPin
extends BooleanFlagHelper

Represents a pin on an element, including a site port where this pin corresponds to a site pin. Created on: Oct 1, 2015

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BELPin.Direction BEL Pin directions

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BEL	getBEL() Gets the parent BEL of this pin
String	getBELName() Gets the name of the parent BEL of this pin
BELPin	getConnectedInputPinOnBEL(BEL bel) Examines this pin and all pins connected on its site wire for an input pin on the provided BEL.
String	getConnectedSitePinName() Gets the site pin name of the site pin connected to this element pin.
BELPin.Direction	getDir() Gets the direction of the BEL pin
Node	getExternalNode(Site site) If this BELPin corresponds to a Site pin, it gets the connected Node from the inter-site routing network and returns it.
int	getIndex() Gets the index of the pin within the BEL.
String	getName() Gets the name of the BEL pin
ArrayList<BELPin>	getSiteConns()
SitePin	getSitePin(Site site) If the site wire to which this BELPin corresponds connects to a site pin, it returns the relevant SitePin.
ArrayList<SitePIP>	getSitePIPs()
int	getSiteWireIndex()
String	getSiteWireName() Gets the site wire name connected to this pin.
BELPin	getSourcePin() Examines all the BEL pins on the site wire and returns the first source (output pin).
int	hashCode()
boolean	isBidir() Is the pin bi-directional?
boolean	isClock() Checks if this pin is a clock pin.
boolean	isData() Checks if this pin is a data pin.
boolean	isDedicatedSitePin() Checks if this pin connects to a dedicate route site pin (such as COUT on SLICEs).
boolean	isEnable() Checks if this pin is an enable pin.
boolean	isGndSource() Checks if this pin provides a GND
boolean	isInput() Is the pin an input?
boolean	isOutput() Is the pin an output?
boolean	isPartOfBus() Checks if this pin is part of a bus.
boolean	isReset() Checks if this pin is a reset pin.
boolean	isSet() Checks if this pin is a set pin.
boolean	isSitePort() Checks if the pin is a site port pin.
boolean	isStaticSource() Checks if this pin provides a static source (GND or VCC)
boolean	isVccSource() Checks if this pin provides a VCC
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

Gets the name of the BEL pin

Vivado Tcl:

set p [get_property NAME $belPin];string range $p [string last "/" $p]+1 [string length $p]

Returns:

Name of the BEL pin

Since:

2018.2.0

getDir

public BELPin.Direction getDir()

Gets the direction of the BEL pin

Vivado Tcl:

get_property DIRECTION $belPin

Returns:

the dir

Since:

2018.2.0

getBEL

public BEL getBEL()

Gets the parent BEL of this pin

Vivado Tcl:

get_bels [string range $belPin 0 [string last "/" $belPin]-1]

Returns:

the BEL

Since:

2018.2.0

getBELName

public String getBELName()

Gets the name of the parent BEL of this pin

Vivado Tcl:

get_bels [string range $belPin 0 [string last "/" $belPin]-1]

Returns:

the BEL

Since:

2020.2.2

getSitePIPs

public ArrayList<SitePIP> getSitePIPs()

Returns:

the sitePIPs

Since:

2018.2.0

getSiteConns

public ArrayList<BELPin> getSiteConns()

Returns:

the siteConns

Since:

2018.2.0

getSourcePin

public BELPin getSourcePin()

Examines all the BEL pins on the site wire and returns the first source (output pin). If this pin is an output, it returns itself (this). If no dedicated output pins are found, but the site wire has a bi-directional pin, it will return the bi-directional pin.

Returns:

The output pin on the attached site wire, or null if none could be found.

Since:

2019.2.1

getConnectedInputPinOnBEL

public BELPin getConnectedInputPinOnBEL(BEL bel)

Examines this pin and all pins connected on its site wire for an input pin on the provided BEL.

Parameters:

bel - The matching BEL of interested

Returns:

An input BELPin on the provided BEL that is connected to this BELPin or null if none was found.

Since:

2022.1.2

getSiteWireIndex

public int getSiteWireIndex()

Returns:

the siteWire index or -1 if this BELPin does not connect to a site wire.

Since:

2018.2.0

getSiteWireName

public String getSiteWireName()

Gets the site wire name connected to this pin.

Returns:

Name of the site wire to which this pin connects.

Since:

2018.2.0

getConnectedSitePinName

public String getConnectedSitePinName()

Gets the site pin name of the site pin connected to this element pin.

Returns:

The name of the connected site pin or null if none exists.

Since:

2018.2.0

isSitePort

public boolean isSitePort()

Checks if the pin is a site port pin.

Returns:

True if this is a site port pin, false otherwise.

Since:

2018.2.0

toString

public String toString()

Overrides:

toString in class Object

isInput

public boolean isInput()

Is the pin an input?

Returns:

True if an input, false otherwise.

Since:

2018.2.0

isOutput

public boolean isOutput()

Is the pin an output?

Returns:

True if pin is output, false otherwise.

Since:

2018.2.0

isBidir

public boolean isBidir()

Is the pin bi-directional?

Returns:

True if the pin is bi-directional, false otherwise.

Since:

2018.2.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getIndex

public int getIndex()

Gets the index of the pin within the BEL.

Returns:

Pin index in the BEL.

Since:

2018.2.0

isDedicatedSitePin

public boolean isDedicatedSitePin()

Checks if this pin connects to a dedicate route site pin (such as COUT on SLICEs).

Returns:

True if this BELPin connects to a dedicated route site pin

Since:

2018.2.0

getSitePin

public SitePin getSitePin(Site site)

If the site wire to which this BELPin corresponds connects to a site pin, it returns the relevant SitePin.

Parameters:

site - The current site.

Returns:

The SitePin corresponding to this BELPin's site wire or null if none exists.

Since:

2020.1.0

getExternalNode

public Node getExternalNode(Site site)

If this BELPin corresponds to a Site pin, it gets the connected Node from the inter-site routing network and returns it.

Parameters:

site - The current site.

Returns:

The external Node connected to this BELPin's site pin, or null if none exists.

Since:

2020.1.0

isStaticSource

public boolean isStaticSource()

Checks if this pin provides a static source (GND or VCC)

Returns:

True if it is drives GND or VCC, false otherwise

Since:

2020.2.2

isGndSource

public boolean isGndSource()

Checks if this pin provides a GND

Returns:

True if it is drives VCC, false otherwise

Since:

2020.2.2

isVccSource

public boolean isVccSource()

Checks if this pin provides a VCC

Returns:

True if it is drives VCC, false otherwise

Since:

2020.2.2

isPartOfBus

public boolean isPartOfBus()

Checks if this pin is part of a bus.

Vivado Tcl:

get_property IS_PART_OF_BUS $belPin

Returns:

True if this pin is part of a bus, false otherwise.

Since:

2021.2.0

isData

public boolean isData()

Checks if this pin is a data pin.

Vivado Tcl:

get_property IS_DATA $belPin

Returns:

True if this pin is a data pin, false otherwise.

Since:

2021.2.0

isClock

public boolean isClock()

Checks if this pin is a clock pin.

Vivado Tcl:

get_property IS_CLOCK $belPin

Returns:

True if this pin is a clock pin, false otherwise.

Since:

2021.2.0

isEnable

public boolean isEnable()

Checks if this pin is an enable pin.

Vivado Tcl:

get_property IS_ENABLE $belPin

Returns:

True if this pin is an enable pin, false otherwise.

Since:

2021.2.0

isSet

public boolean isSet()

Checks if this pin is a set pin.

Vivado Tcl:

get_property IS_SET $belPin

Returns:

True if this pin is a set pin, false otherwise.

Since:

2021.2.0

isReset

public boolean isReset()

Checks if this pin is a reset pin.

Vivado Tcl:

get_property IS_RESET $belPin

Returns:

True if this pin is a reset pin, false otherwise.

Since:

2021.2.0