com.xilinx.rapidwright.device

Class BEL

Object

com.xilinx.rapidwright.device.BooleanFlagHelper

com.xilinx.rapidwright.device.BEL

public class BEL
extends BooleanFlagHelper

This class represents the canonical representation of a BEL (Basic Element of Logic), or a RBEL (Routing BEL), or a site port. These are the indivisible elements present in a site. Created on: Oct 1, 2015

Method Summary

Modifier and Type	Method and Description
boolean	canInvert() Checks if the BEL can invert input signals.
boolean	equals(Object obj)
static BEL	getBEL(Device device, SiteTypeEnum siteTypeEnum, String belName) Gets a BEL object, given its Device, and name.
BELClass	getBELClass() Gets the classification of this BEL
String	getBELType() The prototypical name of the element type.
int	getHighestInputIndex() Gets the highest index of an input pin on the BEL.
BELPin	getInvertingPin() For an inverting BEL (see BEL.canInvert()), returns the input BEL pin used to invert an incoming signal.
String	getName() Gets the name of the BEL.
BELPin	getNonInvertingPin() For an inverting BEL (see BEL.canInvert()), returns the input BEL pin used to not invert an incoming signal.
BELPin	getPin(int index) Gets the pin at the requested index.
BELPin	getPin(String name) Gets the pin on the element by name.
HashMap<String,BELPin>	getPinMap() Gets a map keyed by name of all bel pins on this BEL.
BELPin[]	getPins() Gets the list of all pins on this BEL.
SiteTypeEnum	getSiteTypeEnum() Gets the site type of this BEL.
int	hashCode()
boolean	isCarry() Checks if this BEL is a Carry block, getBELType().contains("CARRY")
boolean	isFF() Checks if this BEL is a Flip Flop, same as getBELType().contains("FF")
boolean	isGndSource() Checks if the BEL can provide a GND source on its output.
boolean	isLUT() Checks if this BEL is a LUT, same as getBELType().contains("LUT")
boolean	isSliceFFClkMod() Checks if this BEL is a Versal SLICE_FF_CLK_MOD, getBELType().equals("SLICE_FF_CLK_MOD")
boolean	isSRIMR() Checks if this BEL is a Versal SR_IMR Register, getBELType().equals("SR_IMR")
boolean	isStaticSource() Checks if the BEL can provide a GND or VCC source on its output.
boolean	isVccSource() Checks if the BEL can provide a VCC source on its output.
String	toString() Gets the name of the BEL with its classification in parenthesis.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

Gets the name of the BEL.

Vivado Tcl:

set n [get_property NAME $this];string range $n [string last "/" $n]+1 [string length $n]

Returns:

The name of the BEL.

Since:

2018.2.0

getBELClass

public BELClass getBELClass()

Gets the classification of this BEL

Returns:

the classification

Since:

2018.2.0

getPins

public BELPin[] getPins()

Gets the list of all pins on this BEL.

Vivado Tcl:

get_bel_pins -of $this

Returns:

An array of all pins on this BEL.

Since:

2018.2.0

getPinMap

public HashMap<String,BELPin> getPinMap()

Gets a map keyed by name of all bel pins on this BEL.

Vivado Tcl:

get_bel_pins -of $this

Returns:

A map of all pins on this BEL.

Since:

2018.2.0

getSiteTypeEnum

public SiteTypeEnum getSiteTypeEnum()

Gets the site type of this BEL.

Vivado Tcl:

get_property SITE_TYPE [get_sites -of $this]

Returns:

The site type to which this BEL belongs.

Since:

2018.2.0

getPin

public BELPin getPin(String name)

Gets the pin on the element by name.

Vivado Tcl:

get_bel_pins -filter NAME==$this/$name -of $this

Parameters:

name - Name of the pin to get.

Returns:

The pin if it exists, null otherwise.

Since:

2018.2.0

getPin

public BELPin getPin(int index)

Gets the pin at the requested index.

Vivado Tcl:

lindex [get_bel_pins -of $bel] $index

Parameters:

index - Index of the pin to get.

Returns:

The pin at the requested index

Since:

2018.2.0

getBELType

public String getBELType()

The prototypical name of the element type.

Vivado Tcl:

get_property TYPE $this

Returns:

Name of the BEL type.

Since:

2018.2.0

isGndSource

public boolean isGndSource()

Checks if the BEL can provide a GND source on its output.

Returns:

True if its output supplies GND, false otherwise.

Since:

2020.1.6

isVccSource

public boolean isVccSource()

Checks if the BEL can provide a VCC source on its output.

Returns:

True if its output supplies VCC, false otherwise.

Since:

2020.1.6

isStaticSource

public boolean isStaticSource()

Checks if the BEL can provide a GND or VCC source on its output.

Returns:

True if its output supplies GND or VCC, false otherwise.

Since:

2020.2.2

canInvert

public boolean canInvert()

Checks if the BEL can invert input signals.

Returns:

True if it can invert, false otherwise

Since:

2020.1.6

getInvertingPin

public BELPin getInvertingPin()

For an inverting BEL (see BEL.canInvert()), returns the input BEL pin used to invert an incoming signal.

Returns:

Returns this BEL's input pin used for inverting, or null if it does not invert.

Since:

2020.2.0

getNonInvertingPin

public BELPin getNonInvertingPin()

For an inverting BEL (see BEL.canInvert()), returns the input BEL pin used to not invert an incoming signal.

Returns:

Returns this BEL's input pin used for passing a signal directly (non-inverting), or null if this BEL does not invert.

Since:

2020.2.0

getHighestInputIndex

public int getHighestInputIndex()

Gets the highest index of an input pin on the BEL. The pins are organized in an array with inputs first than outputs.

Vivado Tcl:

expr [get_property NUM_INPUTS $this] - 1

Returns:

Highest input index.

Since:

2018.2.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Gets the name of the BEL with its classification in parenthesis.

Overrides:

toString in class Object

isLUT

public boolean isLUT()

Checks if this BEL is a LUT, same as getBELType().contains("LUT")

Returns:

True if this BEL is a LUT, false otherwise.

Since:

2021.2.0

isFF

public boolean isFF()

Checks if this BEL is a Flip Flop, same as getBELType().contains("FF")

Returns:

True if this BEL is a FF, false otherwise.

Since:

2021.2.0

isCarry

public boolean isCarry()

Checks if this BEL is a Carry block, getBELType().contains("CARRY")

Returns:

True if this BEL is a Carry, false otherwise.

Since:

2021.2.0

isSRIMR

public boolean isSRIMR()

Checks if this BEL is a Versal SR_IMR Register, getBELType().equals("SR_IMR")

Returns:

True if this BEL is a Carry, false otherwise.

Since:

2021.2.0

isSliceFFClkMod

public boolean isSliceFFClkMod()

Checks if this BEL is a Versal SLICE_FF_CLK_MOD, getBELType().equals("SLICE_FF_CLK_MOD")

Returns:

True if this BEL is a SLICE_FF_CLK_MOD, false otherwise.

Since:

2021.2.0

getBEL

public static BEL getBEL(Device device,
                         SiteTypeEnum siteTypeEnum,
                         String belName)

Gets a BEL object, given its Device, and name.

Returns:

BEL object.

Since:

2023.2.2