Cell

Object
- com.xilinx.rapidwright.design.Cell

All Implemented Interfaces:

Serializable, Comparable<Cell>
```
public class Cell
extends Object
implements Serializable, Comparable<Cell>
```
A cell corresponds to the leaf cell within the logical netlist EDIFCellInst and provides a mapping to a physical location BEL on the device. It could also be called a BELInst.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FF_ROUTETHRU_TYPE` Sentinel type for library field "type" to identify FF routethrus
`static String`	`LOCKED` Cell name sentinel used when the cell represented is a locked BEL location
`static String`	`PORT_TYPE` Sentinel type for library field "type" to identify ports
`static String`	`SENTINEL_DEFAULT`

Constructor Summary

Constructors
Constructor and Description
`Cell(String name)` Cell constructor that creates a new physical cell
`Cell(String name, BEL bel)` Creates a new physical cell and places it on the designated bel
`Cell(String name, SiteInst siteInst, BEL bel)` Physical cell constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAltPinMapping(String physicalPin, AltPinMapping logicalPin)` Adds an alternate pin mapping for the provided physical pin.
`void`	`addPinMapping(String physicalPin, String logicalPin)` Maps together a logical and physical pin on the cell and BEL respectively.
`EDIFPropertyValue`	`addProperty(String key, boolean value)` Helper method to add a boolean-valued property to the logical cell instance in the netlist.
`EDIFPropertyValue`	`addProperty(String key, int value)` Helper method to add an int-valued property to the logical cell instance in the netlist.
`EDIFPropertyValue`	`addProperty(String key, String value)` Helper method to add a string-valued property to the logical cell instance in the netlist.
`EDIFPropertyValue`	`addProperty(String key, String value, EDIFValueType type)` Helper method to add a property to the logical cell instance in the netlist.
`int`	`compareTo(Cell o)`
`void`	`connectStaticSourceToPin(NetType type, String logicalPinName)` Convenience method to quickly connect a cell pin to VDD or GND.
`void`	`connectStaticSourceToPins(NetType type, String... myPins)` Convenience method to quickly connect a set of cell pins to VDD or GND.
`Cell`	`copyCell(String name, EDIFHierCellInst inst)` Copies this cell except instance name and EDIFCellInst reference
`Cell`	`copyCell(String name, EDIFHierCellInst inst, SiteInst i)` Copies this cell except instance name, EDIFCellInst and SiteInst reference
`String`	`debugToString()`
`boolean`	`equals(Object obj)`
`void`	`fixPin(String physicalPin)` Marks a pin on the cell as fixed by its physical name.
`List<String>`	`getAllCorrespondingSitePinNames(String logicalPinName)` Finds all the corresponding site pin names of the site to be used to drive/source from the logical pin name provided on this cell.
`List<String>`	`getAllCorrespondingSitePinNames(String logicalPinName, boolean considerLutRoutethru)` Finds all the corresponding site pin names of the site to be used to drive/source from the logical pin name provided on this cell.
`List<String>`	`getAllCorrespondingSitePinNames(String logicalPinName, List<String> siteWires, boolean considerLutRoutethru)` Finds all the corresponding site pin names of the site to be used to drive/source from the logical pin name provided on this cell.
`Set<String>`	`getAllPhysicalPinMappings(String logicalPin)` Gets all corresponding physical pins that are mapped to by the given logical pin.
`List<SitePinInst>`	`getAllSitePinsFromLogicalPin(String logicalPinName, List<String> siteWires)` Attempts to get all the physical net pin from this cell's logical pin name.
`List<SitePinInst>`	`getAllSitePinsFromPortInst(EDIFPortInst p, List<String> siteWires)` Attempts to get the list of physical net pins from this cell's port ref.
`SiteTypeEnum`	`getAltBlockedSiteType()` Gets (if any) alternative site type if this cell's current site is blocked.
`AltPinMapping`	`getAltPinMapping(String physicalPin)` Gets (if exists) an alternative pin mapping for the provided physical pin name.
`Map<String,AltPinMapping>`	`getAltPinMappings()` Gets a map containing all alternate pin mappings for the cell.
`BEL`	`getBEL()` Gets the element type object onto which this cell is placed.
`String`	`getBELName()` The name of the BEL onto which this cell is placed.
`BELPin`	`getBELPin(EDIFHierPortInst p)` Attempts to get the physical BEL pin from the logical EDIFPortInst.
`BELPin`	`getBELPin(EDIFPortInst p)` Attempts to get the physical BEL pin from the logical EDIFPortInst.
`Map<SiteTypeEnum,Set<String>>`	`getCompatiblePlacements(Device device)` Provides a map of site type and bel names that support the specified unisim.
`String`	`getCorrespondingSitePinName(String logicalPinName)` Finds the corresponding site pin name of the site to be used to drive/source from the logical pin name provided on this cell.
`String`	`getCorrespondingSitePinName(String logicalPinName, String physPinName, List<String> siteWires)` Finds the corresponding site pin name of the site to be used to drive/source from the logical pin name provided on this cell.
`String`	`getDefaultPinMapping(String logicalPinName)` Gets the default physical pin mapping for specified logical pin mapping on this cell
`EDIFCellInst`	`getEDIFCellInst()` Gets the logical netlist cell instance corresponding to this cell.
`EDIFHierCellInst`	`getEDIFHierCellInst()` Gets the hierarchical logical netlist cell instance corresponding to this cell.
`String`	`getLogicalPinMapping(String physicalPin)` Gets the corresponding logical pin mapping for the provided physical pin.
`String`	`getName()` Gets the full hierarchical name of the cell
`EDIFCell`	`getParentCell()` Gets the parent logical cell of this cell instance.
`String`	`getParentHierarchicalInstName()` Gets this cell's hierarchical parent instance name.
`String`	`getPhysicalPinMapping(String logicalPin)` Gets the corresponding logical pin mapping for the provided logical pin.
`Map<String,Set<String>>`	`getPinMappingsL2P()` Gets the map representing the logical to physical pin mappings for the cell.
`Map<String,String>`	`getPinMappingsP2L()` Gets the map representing the physical to logical pin mappings for the cell.
`Map<String,EDIFPropertyValue>`	`getProperties()` Helper method to get the properties on the underlying logical cell (`EDIFCellInst`) corresponding to this cell.
`EDIFPropertyValue`	`getProperty(String key)` Helper method to get a property from the logical cell instance corresponding to this cell
`String`	`getPropertyValueString(String key)` Helper method to get the actual string value of a property if one exists.
`Cell`	`getReferenceCopy()` Creates a reference copy of this cell--a deep copy of the cell without this new instance being referenced in the design object.
`Site`	`getSite()` Gets the site on which this cell is placed.
`SiteInst`	`getSiteInst()` Gets the site instance this cell belongs to.
`String`	`getSiteName()` Gets the site name onto which this cell is placed.
`SitePinInst`	`getSitePinFromLogicalPin(String logicalPinName, List<String> siteWires)` Attempts to get the physical net pin from this cell's logical pin name.
`SitePinInst`	`getSitePinFromPortInst(EDIFPortInst p, List<String> siteWires)` Attempts to get the physical net pin from this cell's port ref.
`String`	`getSiteWireNameFromLogicalPin(String logicalPinName)` Uses the logical pin name to lookup the site wire name from the physical mapping pin on the cell.
`String`	`getSiteWireNameFromPhysicalPin(String physicalPinName)` Gets the name of the site wire immediately connected to the physical pin specified.
`Tile`	`getTile()` Gets the tile on which this cell is placed.
`String`	`getType()` Gets the EDIFCell cell type (Unisim library cell name).
`boolean`	`hasAltPinMappings()` Checks if this cell has any alternative pin mappings on any pins.
`int`	`hashCode()`
`boolean`	`isBELFixed()` Checks if the cell is fixed to the BEL
`boolean`	`isFFRoutethruCell()` Checks if this cell is a sentinel placeholder object for a FF routethru.
`boolean`	`isLocked()` Checks if this cell is locked.
`boolean`	`isNullBEL()` Checks if this cell has a null BEL/element.
`boolean`	`isPinFixed(String physicalPin)` Checks if the provided pin is set as fixed.
`boolean`	`isPlaced()` Checks if the cell is placed.
`boolean`	`isPlacedOn(SiteTypeEnum type, String bel)` Compares the placement of the cell with the provided site type and BEL.
`boolean`	`isPlacedOn(String fullBelName)` Checks if this cell is placed
`boolean`	`isPortCell()` Checks if this cell is a sentinel placeholder object for a port.
`boolean`	`isRoutethru()` Checks if this cell is a routethru.
`boolean`	`isSiteFixed()` Checks if the site is fixed.
`String`	`removePinMapping(String physicalPin)` Removes the pin mapping based on the physical pin name
`void`	`setAltBlockedSiteType(SiteTypeEnum typeEnum)` Set the alternative SiteTypeEnum for a blocked site
`void`	`setBELFixed(boolean isBELFixed)` Sets if the cell is fixed to the BEL or not.
`void`	`setEDIFHierCellInst(EDIFHierCellInst inst)` Sets the hierarchical logical netlist cell to the one provided.
`void`	`setLocked(boolean isLocked)` Mark this cell as locked.
`void`	`setNullBEL(boolean b)` Set this cell has a null BEL/element.
`void`	`setPropertiesMap(Map<String,EDIFPropertyValue> properties)` Helper method to set the properties on the underlying logical cell (`EDIFCellInst`)
`void`	`setRoutethru(boolean isRoutethru)` Sets flag that this cell represents a routethru.
`void`	`setSiteFixed(boolean isSiteFixed)` Sets the fixed site flag for the cell.
`void`	`setSiteInst(SiteInst instance)` Sets the site instance where this cell resides.
`void`	`setType(String type)` Explicitly set the type of this cell.
`String`	`toString()`
`void`	`unFixPin(String physicalPin)` Unmarks a pin on the cell as fixed by its physical name.
`void`	`unplace()` Unplaces this cell.
`SitePinInst`	`unrouteLogicalPinInSite(String logicalPinName)` Unroutes the site routing of the provided logical pin.
`boolean`	`updateName(String newCellName)` Updates the cell name, such as when instantiating this cell in a larger design to add a prefix.

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SENTINEL_DEFAULT
```
public static final String SENTINEL_DEFAULT
```
    See Also:
    
    Constant Field Values
  - LOCKED
```
public static final String LOCKED
```
    Cell name sentinel used when the cell represented is a locked BEL location
    
    Since:
    
    2023.2.2
    
    See Also:
    
    Constant Field Values
  - PORT_TYPE
```
public static final String PORT_TYPE
```
    Sentinel type for library field "type" to identify ports
    
    Since:
    
    2023.2.2
    
    See Also:
    
    Constant Field Values
  - FF_ROUTETHRU_TYPE
```
public static final String FF_ROUTETHRU_TYPE
```
    Sentinel type for library field "type" to identify FF routethrus
    
    Since:
    
    2023.1.3
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Cell
```
public Cell(String name)
```
    Cell constructor that creates a new physical cell
    
    Parameters:
    
    name - Full hierarchical name of the cell
  - Cell
```
public Cell(String name,
            BEL bel)
```
    Creates a new physical cell and places it on the designated bel
    
    Parameters:
    
    name - Full hierarchical name of the cell
    
    bel - The BEL on which the cell should be placed
  - Cell
```
public Cell(String name,
            SiteInst siteInst,
            BEL bel)
```
    Physical cell constructor.
    
    Parameters:
    
    name - Full hierarchical name of the cell
    
    siteInst - The site instance on which the cell should be placed
    
    bel - The BEL on which the cell should be placed
- Method Detail
  - copyCell
```
public Cell copyCell(String name,
                     EDIFHierCellInst inst)
```
    Copies this cell except instance name and EDIFCellInst reference
    
    Parameters:
    
    name - New instance name of the cell
    
    inst - The logical cell instance that corresponds to this physical cell.
    
    Since:
    
    2022.2.0
  - copyCell
```
public Cell copyCell(String name,
                     EDIFHierCellInst inst,
                     SiteInst i)
```
    Copies this cell except instance name, EDIFCellInst and SiteInst reference
    
    Parameters:
    
    name - New instance name of the cell
    
    inst - The logical cell instance that corresponds to this physical cell.
    
    i - New site instance
    
    Since:
    
    2022.2.0
  - getReferenceCopy
```
public Cell getReferenceCopy()
```
    Creates a reference copy of this cell--a deep copy of the cell without this new instance being referenced in the design object.
    
    Returns:
    
    The newly created reference copy of the cell.
    
    Since:
    
    2023.1.3
  - isPortCell
```
public boolean isPortCell()
```
    Checks if this cell is a sentinel placeholder object for a port.
    
    Returns:
    
    True if this cell is a port cell, false otherwise.
    
    Since:
    
    2023.2.2
  - isFFRoutethruCell
```
public boolean isFFRoutethruCell()
```
    Checks if this cell is a sentinel placeholder object for a FF routethru.
    
    Returns:
    
    True if this cell is a FF routethru cell, false otherwise.
    
    Since:
    
    2023.1.3
  - isPlacedOn
```
public boolean isPlacedOn(SiteTypeEnum type,
                          String bel)
```
    Compares the placement of the cell with the provided site type and BEL.
    Vivado Tcl:
    if [expr {[get_property BEL $this] eq "$type.$bel}] {1} else {0}
    Parameters: type - The type of site to check if this cell is placed on. bel - The BEL to check if this cell is placed on. Returns: True if the site type and BEL match this cell's placement, false otherwise. Since: 2018.2.0
  isPlacedOn public boolean isPlacedOn(String fullBelName) Checks if this cell is placed Vivado Tcl: if [expr {[get_property BEL $this] eq "$fullBelName}] {1} else {0} Parameters: fullBelName - SiteType name and element name separated by '.', for example: SLICEL.AFF Returns: True if this cell is placed on a sitetype.bel of the provided type, false otherwise. Since: 2018.2.0 getName public String getName() Gets the full hierarchical name of the cell Vivado Tcl: get_property NAME $this Returns: The full hierarchical name of the cell Since: 2018.2.0 updateName public boolean updateName(String newCellName) Updates the cell name, such as when instantiating this cell in a larger design to add a prefix. Returns: True if the name was updated, false otherwise Since: 2018.3.2 isPlaced public boolean isPlaced() Checks if the cell is placed. Returns: True if the cell is placed, false otherwise Since: 2018.3.2 getBEL public BEL getBEL() Gets the element type object onto which this cell is placed. Vivado Tcl: get_bels [get_property BEL $this] Returns: the element Since: 2018.2.0 getSiteName public String getSiteName() Gets the site name onto which this cell is placed. Vivado Tcl: get_property LOC $this Returns: The site name onto which this cell is placed Since: 2018.2.0 getBELName public String getBELName() The name of the BEL onto which this cell is placed. Vivado Tcl: set n [get_property BEL $this];string range $n [string last "." $n]+1 [string length $n] Returns: The BEL name onto which this cell is placed. Since: 2018.2.0 getSiteInst public SiteInst getSiteInst() Gets the site instance this cell belongs to. Returns: the instance Since: 2018.2.0 setSiteInst public void setSiteInst(SiteInst instance) Sets the site instance where this cell resides. Parameters: instance - the instance to set Since: 2018.2.0 getSite public Site getSite() Gets the site on which this cell is placed. Vivado Tcl: get_sites -of $this Returns: The current site this cell is placed on. Since: 2018.2.0 getTile public Tile getTile() Gets the tile on which this cell is placed. Returns: The tile on which this cell is placed or null if not placed. Since: 2019.2.0 getEDIFCellInst public EDIFCellInst getEDIFCellInst() Gets the logical netlist cell instance corresponding to this cell. Returns: the edifCellInst Logical netlist cell instance for this cell. Since: 2018.2.0 getEDIFHierCellInst public EDIFHierCellInst getEDIFHierCellInst() Gets the hierarchical logical netlist cell instance corresponding to this cell. Returns: the hierarchical logical netlist cell instance for this cell. Since: 2022.1.2 setEDIFHierCellInst public void setEDIFHierCellInst(EDIFHierCellInst inst) Sets the hierarchical logical netlist cell to the one provided. This overrides the default one as found in the netlist. Parameters: inst - The instance to set Since: 2022.1.4 getParentHierarchicalInstName public String getParentHierarchicalInstName() Gets this cell's hierarchical parent instance name. If it is the top cell in the design, it returns an empty string. Vivado Tcl: get_property NAME [get_property PARENT $this] Returns: Empty string if this cell belongs to the top cell, otherwise the full hierarchical instance name of the parent cell. Since: 2018.2.0 fixPin public void fixPin(String physicalPin) Marks a pin on the cell as fixed by its physical name. A fixed pin cannot be swapped by Vivado. Vivado Tcl: foreach p [get_pins -of $this] {if [expr {get_bel_pins -of $p eq ""}] {set_property IS_LOC_FIXED 1 $p} Parameters: physicalPin - Physical name that maps to the logical pin of a cell that is to be fixed. Since: 2018.2.0 unFixPin public void unFixPin(String physicalPin) Unmarks a pin on the cell as fixed by its physical name. Unfixed pins can be swapped by Vivado. Vivado Tcl: foreach p [get_pins -of $this] {if [expr {get_bel_pins -of $p eq ""}] {set_property IS_LOC_FIXED 0 $p} Parameters: physicalPin - Physical name that maps to the logical pin of a cell to set as unfixed. Since: 2018.2.0 isPinFixed public boolean isPinFixed(String physicalPin) Checks if the provided pin is set as fixed. Vivado Tcl: foreach p [get_pins -of $this] {if [expr {get_bel_pins -of $p eq ""}] {get_property IS_LOC_FIXED $p} Parameters: physicalPin - Name of the physical pin that corresponds to the logical pin on the cell to check if fixed. Returns: True if the pins is fixed, false otherwise. Since: 2018.2.0 compareTo public int compareTo(Cell o) Specified by: compareTo in interface Comparable<Cell> addPinMapping public void addPinMapping(String physicalPin, String logicalPin) Maps together a logical and physical pin on the cell and BEL respectively. Vivado Tcl: set_property LOCK_PINS $logicalPin:$physcialPin $this Parameters: physicalPin - Name of the physical pin on the BEL to be mapped. logicalPin - Name of the logical pin on the cell to be mapped. Since: 2018.2.0 removePinMapping public String removePinMapping(String physicalPin) Removes the pin mapping based on the physical pin name Vivado Tcl: set p [get_property LOCK_PINS $this]; set_property LOCK_PINS [string map {$logicalPin:$physicalPin ""} $p] $this Parameters: physicalPin - Name of the physical pin from which to remove the mapping Returns: The associated logical mapping that is removed Since: 2018.2.0 getPinMappingsP2L public Map<String,String> getPinMappingsP2L() Gets the map representing the physical to logical pin mappings for the cell. Vivado Tcl: foreach p [get_pins -of $this] {puts "[get_bel_pins -of $p]:$p"} Returns: The map containing physical to logical pin mappings. Since: 2018.2.0 getPinMappingsL2P public Map<String,Set<String>> getPinMappingsL2P() Gets the map representing the logical to physical pin mappings for the cell. Returns: The map containing logical to physical pin mappings. Since: 2019.2.1 getLogicalPinMapping public String getLogicalPinMapping(String physicalPin) Gets the corresponding logical pin mapping for the provided physical pin. Vivado Tcl: get_pins -of [get_bel_pins $site/$bel/$physicalPin] Parameters: physicalPin - Name of the physical pin. Returns: The name of the corresponding logical pin mapping for the provided physical pin. Since: 2018.2.0 getPhysicalPinMapping public String getPhysicalPinMapping(String logicalPin) Gets the corresponding logical pin mapping for the provided logical pin. If there are multiple mappings, this only retrieves one of them. Vivado Tcl: set n [get_bel_pins -of [get_pins $this/$logicalPin]]; string range $n [string last "/" $n]+1 [string length $n] Parameters: logicalPin - Name of the logical pin. Returns: The name of the corresponding physical pin mapping for the provided logical pin. Since: 2018.2.0 See Also: Cell.getAllPhysicalPinMappings(String) getAllPhysicalPinMappings public Set<String> getAllPhysicalPinMappings(String logicalPin) Gets all corresponding physical pins that are mapped to by the given logical pin. In less common circumstances, there can actually be multiple physical pins occupied by the logical pin of a cell. Parameters: logicalPin - Returns: The list of physical pins mapped to by the logical pin. Since: 2019.1.0 getAltPinMapping public AltPinMapping getAltPinMapping(String physicalPin) Gets (if exists) an alternative pin mapping for the provided physical pin name. Parameters: physicalPin - Name of the physical pin of interest. Returns: The alternate pin mapping for the physical pin named, null if none exists. Since: 2020.1.2 addAltPinMapping public void addAltPinMapping(String physicalPin, AltPinMapping logicalPin) Adds an alternate pin mapping for the provided physical pin. Parameters: physicalPin - Name of the physical pin to receive the additional mapping. logicalPin - The alternative pin mapping Since: 2020.1.2 hasAltPinMappings public boolean hasAltPinMappings() Checks if this cell has any alternative pin mappings on any pins. Returns: True if any pin has alternate mapping, false if none have any. Since: 2020.1.2 getAltPinMappings public Map<String,AltPinMapping> getAltPinMappings() Gets a map containing all alternate pin mappings for the cell. Returns: The map containing alternate pin mappings. Since: 2020.1.2 getParentCell public EDIFCell getParentCell() Gets the parent logical cell of this cell instance. Vivado Tcl: get_property PARENT $this Returns: The parent (the cell which instantiates this cell) logical cell of this cell instance. Since: 2018.2.0 isLocked public boolean isLocked() Checks if this cell is locked. Returns: True if the cell is locked, false otherwise. Since: 2020.1.2 setNullBEL public void setNullBEL(boolean b) Set this cell has a null BEL/element. Parameters: b - True for a null BEL/element, false otherwise. Since: 2020.1.2 isNullBEL public boolean isNullBEL() Checks if this cell has a null BEL/element. Returns: True for a null BEL/element, false otherwise. Since: 2020.1.2 setLocked public void setLocked(boolean isLocked) Mark this cell as locked. Parameters: isLocked - True to mark this cell as locked, false as unlocked. Since: 2020.1.2 isBELFixed public boolean isBELFixed() Checks if the cell is fixed to the BEL Vivado Tcl: get_property IS_BEL_FIXED $this Returns: True if the cell is fixed to the BEL Since: 2018.2.0 setBELFixed public void setBELFixed(boolean isBELFixed) Sets if the cell is fixed to the BEL or not. Vivado Tcl: set_property IS_BEL_FIXED $isBELFIXED $this Parameters: isBELFixed - The desired value for IS_BEL_FIXED Since: 2018.2.0 isSiteFixed public boolean isSiteFixed() Checks if the site is fixed. Vivado Tcl: get_property IS_LOC_FIXED $this Returns: True if the site is fixed. Since: 2018.2.0 setSiteFixed public void setSiteFixed(boolean isSiteFixed) Sets the fixed site flag for the cell. Vivado Tcl: set_property IS_LOC_FIXED $isSiteFixed $this Parameters: isSiteFixed - The desired value for IS_LOC_FIXED Since: 2018.2.0 isRoutethru public boolean isRoutethru() Checks if this cell is a routethru. Vivado GUI: Select the BEL, it will be lightly colored, but no logical cell will be placed there. Returns: True if cell is configured as a routethru, false otherwise. Since: 2018.2.0 setRoutethru public void setRoutethru(boolean isRoutethru) Sets flag that this cell represents a routethru. Parameters: isRoutethru - True for routethru, false if not. Since: 2020.1.2 debugToString public String debugToString() toString public String toString() Overrides: toString in class Object getType public String getType() Gets the EDIFCell cell type (Unisim library cell name). Vivado Tcl: get_property REF_NAME $this Returns: Name of the cell type Since: 2018.2.0 setType public void setType(String type) Explicitly set the type of this cell. Parameters: type - the type to set Since: 2020.1.2 setAltBlockedSiteType public void setAltBlockedSiteType(SiteTypeEnum typeEnum) Set the alternative SiteTypeEnum for a blocked site Parameters: typeEnum - The alternate type to set Since: 2020.1.2 getAltBlockedSiteType public SiteTypeEnum getAltBlockedSiteType() Gets (if any) alternative site type if this cell's current site is blocked. Returns: The alternate block site type, or null if none. Since: 2020.1.2 getSiteWireNameFromLogicalPin public String getSiteWireNameFromLogicalPin(String logicalPinName) Uses the logical pin name to lookup the site wire name from the physical mapping pin on the cell. Vivado GUI: Select cell in GUI, highlight each pin until cell pin matches, select connecting site wire Parameters: logicalPinName - The logical pin name of interest. Returns: The site wire name connected to the physical pin corresponding to the logical pin, or null if none exists. Since: 2018.2.0 getSiteWireNameFromPhysicalPin public String getSiteWireNameFromPhysicalPin(String physicalPinName) Gets the name of the site wire immediately connected to the physical pin specified. Vivado GUI: Select cell in GUI, highlight each pin until BEL pin matches, select connecting site wire Parameters: physicalPinName - Name of the physical BEL pin used by the cell. Returns: Site wire name immediately connected to the physical BEL pin. Since: 2018.2.0 unplace public void unplace() Unplaces this cell. Does not unroute nets connected to cell. Vivado Tcl: unplace_cell $this Since: 2018.2.0 addProperty public EDIFPropertyValue addProperty(String key, String value, EDIFValueType type) Helper method to add a property to the logical cell instance in the netlist. Vivado Tcl: set_property $key $value $this Parameters: key - Name of the property value - The value type - The EDIF value type Returns: The existing value for the provided key or null if none. Since: 2018.2.0 addProperty public EDIFPropertyValue addProperty(String key, String value) Helper method to add a string-valued property to the logical cell instance in the netlist. Vivado Tcl: set_property $key $value $this Parameters: key - Name of the property value - The EDIF value as a string. Returns: The existing value for the provided key or null if none. Since: 2018.2.0 addProperty public EDIFPropertyValue addProperty(String key, boolean value) Helper method to add a boolean-valued property to the logical cell instance in the netlist. Vivado Tcl: set_property $key $value $this Parameters: key - Name of the property value - The EDIF value as a boolean. Returns: The existing value for the provided key or null if none. Since: 2018.2.0 addProperty public EDIFPropertyValue addProperty(String key, int value) Helper method to add an int-valued property to the logical cell instance in the netlist. Vivado Tcl: set_property $key $value $this Parameters: key - Name of the property value - The EDIF value as an int. Returns: The existing value for the provided key or null if none. Since: 2018.2.0 getProperty public EDIFPropertyValue getProperty(String key) Helper method to get a property from the logical cell instance corresponding to this cell Vivado Tcl: get_property $key $this Parameters: key - The name of the property key to get Returns: The value wrapped with the type in an EDIFPropertyValue. Since: 2018.2.0 getPropertyValueString public String getPropertyValueString(String key) Helper method to get the actual string value of a property if one exists. If not present, it returns null. Parameters: key - The name of the property to get Returns: The value of the property as a string if it exists, otherwise null. Since: 2023.2.2 getProperties public Map<String,EDIFPropertyValue> getProperties() Helper method to get the properties on the underlying logical cell (EDIFCellInst) corresponding to this cell. Returns: The map of properties for the logical instance of this cell. Since: 2022.2.0 setPropertiesMap public void setPropertiesMap(Map<String,EDIFPropertyValue> properties) Helper method to set the properties on the underlying logical cell (EDIFCellInst) Parameters: properties - Map of EDIF key/value pairs to set Since: 2022.1.3 connectStaticSourceToPins public void connectStaticSourceToPins(NetType type, String... myPins) Convenience method to quickly connect a set of cell pins to VDD or GND. Vivado Tcl: route_design -net [get_nets $type] Parameters: type - Static net type (VDD or GND). myPins - One or more logical pin names desired to connect to the provided static net. Since: 2018.2.0 connectStaticSourceToPin public void connectStaticSourceToPin(NetType type, String logicalPinName) Convenience method to quickly connect a cell pin to VDD or GND. Vivado Tcl: route_design -net [get_nets $type] Parameters: type - Static net type (VDD or GND). logicalPinName - Name of the logical cell pin to connect to the provided static net. Since: 2018.2.0 getSitePinFromPortInst public SitePinInst getSitePinFromPortInst(EDIFPortInst p, List<String> siteWires) Attempts to get the physical net pin from this cell's port ref. Parameters: p - The port inst on the logical cell to trace from. siteWires - To be passed an empty list if the caller wants a list of site wire names occupied by the path from the logical pin to the site pin. Returns: The physical net pin connected to the port ref. Since: 2018.2.0 getAllSitePinsFromPortInst public List<SitePinInst> getAllSitePinsFromPortInst(EDIFPortInst p, List<String> siteWires) Attempts to get the list of physical net pins from this cell's port ref. Parameters: p - The port inst on the logical cell to trace from. siteWires - To be passed an empty list if the caller wants a list of site wire names occupied by the path from the logical pin to the site pin. Returns: The physical net pins connected to the port ref. Since: 2020.2.2 getBELPin public BELPin getBELPin(EDIFHierPortInst p) Attempts to get the physical BEL pin from the logical EDIFPortInst. Parameters: p - The port inst of the pin of interest on the cell. Returns: The physical BELPin to which the port inst is mapped or null if it could not be found. Since: 2020.1.7 getBELPin public BELPin getBELPin(EDIFPortInst p) Attempts to get the physical BEL pin from the logical EDIFPortInst. Parameters: p - The port inst of the pin of interest on the cell. Returns: The physical BELPin to which the port inst is mapped or null if it could not be found. Since: 2020.1.7 getSitePinFromLogicalPin public SitePinInst getSitePinFromLogicalPin(String logicalPinName, List<String> siteWires) Attempts to get the physical net pin from this cell's logical pin name. Parameters: logicalPinName - Name of the logical pin on the cell to trace. siteWires - To be passed an empty list if the caller wants a list of site wire names occupied by the path from the logical pin to the site pin. Returns: The physical net pin connected to the cell's logical pin Since: 2018.2.0 getAllSitePinsFromLogicalPin public List<SitePinInst> getAllSitePinsFromLogicalPin(String logicalPinName, List<String> siteWires) Attempts to get all the physical net pin from this cell's logical pin name. Parameters: logicalPinName - Name of the logical pin on the cell to trace. siteWires - To be passed an empty list if the caller wants a list of site wire names occupied by the path from the logical pin to the site pin. Returns: The list of physical net pins connected to the cell's logical pin Since: 2020.2.2 getDefaultPinMapping public String getDefaultPinMapping(String logicalPinName) Gets the default physical pin mapping for specified logical pin mapping on this cell Parameters: logicalPin - Name of the logical pin on the cell to be mapped. Returns: The default physical pin name that this cell maps to. Since: 2020.2.2 getAllCorrespondingSitePinNames public List<String> getAllCorrespondingSitePinNames(String logicalPinName, List<String> siteWires, boolean considerLutRoutethru) Finds all the corresponding site pin names of the site to be used to drive/source from the logical pin name provided on this cell. Parameters: logicalPinName - siteWires - Pass as an optional empty list to accumulate the site wires used in getting from the logical pin to a site pin. Returns: The list of names of site pins found or empty list if none could be found. Since: 2022.2.0 getCorrespondingSitePinName public String getCorrespondingSitePinName(String logicalPinName, String physPinName, List<String> siteWires) Finds the corresponding site pin name of the site to be used to drive/source from the logical pin name provided on this cell. Parameters: logicalPinName - physPinName - siteWires - Pass as an optional empty list to accumulate the site wires used in getting from the logical pin to a site pin. Returns: The name of the site pin found or null if no legal connection could be made. Since: 2023.1.2 getCompatiblePlacements public Map<SiteTypeEnum,Set<String>> getCompatiblePlacements(Device device) Provides a map of site type and bel names that support the specified unisim. Parameters: device - Device object. Returns: A map of site type enums which map to their set of bel names that can allow placement of the unisim specified. Returns an empty map if no valid placements found. Since: 2019.1.2 getCorrespondingSitePinName public String getCorrespondingSitePinName(String logicalPinName) Finds the corresponding site pin name of the site to be used to drive/source from the logical pin name provided on this cell. Vivado GUI: Select cell in GUI, select cell pin, select connecting site wire Parameters: logicalPinName - Returns: The name of the site pin found or null if no legal connection could be made. Since: 2018.2.0 getAllCorrespondingSitePinNames public List<String> getAllCorrespondingSitePinNames(String logicalPinName) Finds all the corresponding site pin names of the site to be used to drive/source from the logical pin name provided on this cell. Vivado GUI: Select cell in GUI, select cell pin, select connecting site wire Parameters: logicalPinName - Returns: The list of names of site pins found or null if no legal connection could be made. Since: 2020.2.2 getAllCorrespondingSitePinNames public List<String> getAllCorrespondingSitePinNames(String logicalPinName, boolean considerLutRoutethru) Finds all the corresponding site pin names of the site to be used to drive/source from the logical pin name provided on this cell. Vivado GUI: Select cell in GUI, select cell pin, select connecting site wire Parameters: logicalPinName - considerLutRoutethru - Returns: The list of names of site pins found or null if no legal connection could be made. Since: 2022.1.3 unrouteLogicalPinInSite public SitePinInst unrouteLogicalPinInSite(String logicalPinName) Unroutes the site routing of the provided logical pin. Vivado Tcl: route_design -unroute [get_nets -of [get_pins $cell/$logicalPinName] Parameters: logicalPinName - Name of the logical pin to unroute Returns: The corresponding site pin that was unrouted Since: 2018.2.0 hashCode public int hashCode() Overrides: hashCode in class Object equals public boolean equals(Object obj) Overrides: equals in class Object

Class Cell

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

SENTINEL_DEFAULT

LOCKED

PORT_TYPE

FF_ROUTETHRU_TYPE

Constructor Detail

Cell

Cell

Cell

Method Detail

copyCell

copyCell

getReferenceCopy

isPortCell

isFFRoutethruCell

isPlacedOn

isPlacedOn

getName

updateName

isPlaced

getBEL

getSiteName

getBELName

getSiteInst

setSiteInst

getSite

getTile

getEDIFCellInst

getEDIFHierCellInst

setEDIFHierCellInst

getParentHierarchicalInstName

fixPin

unFixPin

isPinFixed

compareTo

addPinMapping

removePinMapping

getPinMappingsP2L

getPinMappingsL2P

getLogicalPinMapping

getPhysicalPinMapping

getAllPhysicalPinMappings

getAltPinMapping

addAltPinMapping

hasAltPinMappings

getAltPinMappings

getParentCell

isLocked

setNullBEL

isNullBEL

setLocked

isBELFixed

setBELFixed

isSiteFixed

setSiteFixed

isRoutethru

setRoutethru

debugToString

toString

getType

setType

setAltBlockedSiteType

getAltBlockedSiteType

getSiteWireNameFromLogicalPin

getSiteWireNameFromPhysicalPin

unplace

addProperty

addProperty

addProperty

addProperty

getProperty

getPropertyValueString

getProperties

setPropertiesMap

connectStaticSourceToPins