com.xilinx.rapidwright.design

Class ModuleInst

Object

com.xilinx.rapidwright.design.AbstractModuleInst<Module,Site,ModuleInst>

com.xilinx.rapidwright.design.ModuleInst

Direct Known Subclasses:

HardMacro

public class ModuleInst
extends AbstractModuleInst<Module,Site,ModuleInst>

There is no direct representation of a module instance in Vivado. Each member of a module instance is referenced in a particular way back to the module instance. This class attempts to collect all the module instance information into a single class.

Constructor Summary

Constructors

Constructor and Description
ModuleInst(ModuleInst moduleInst) This will initialize this module instance to the same attributes as the module instance passed in.
ModuleInst(String name, Design design) Constructor initializing instance module name

Method Summary

Modifier and Type	Method and Description
void	addInst(SiteInst inst) Adds the instance inst to the instances list that are members of the module instance.
void	addNet(Net net) Adds the net to the net list that are members of the module instance.
void	addNOCClient(NOCClient nc)
void	connect(String portName, int busIndex0, ModuleInst other, String otherPortName, int busIndex1) Connects two signals by port name between this module instance and another.
ArrayList<Site>	getAllValidPlacements() Does a brute force search to find all valid locations of where this module instance can be placed.
SiteInst	getAnchor() Gets and returns the anchor instance for this module instance.
RelocatableTileRectangle	getBoundingBox()
Net	getCorrespondingNet(Port p) Gets (if it exists), the corresponding net within the module instance of the port.
Set<SitePinInst>	getCorrespondingPins(Port port) Gets the corresponding port pins (SitePinInst) on this module instance that corresponds to the module's port.
Tile	getCorrespondingTile(Tile templateTile, Tile newAnchorTile) This method will calculate and return the corresponding tile of a module instance.
Design	getDesign()
Site	getLowerLeftPlacement() Get's the current lower left site as used for a placement directive for an implementation guide.
Site	getLowerLeftPlacement(SiteTypeEnum type) Get's the current lower left site as used for a placement directive for an implementation guide.
Tile	getLowerLeftTile(SiteTypeEnum type) Chooses a lower left reference tile in a module instance for the purpose of placement.
Module	getModule()
ArrayList<Net>	getNets() Gets the list of physical nets in the module instance.
List<NOCClient>	getNOCClients()
Site	getPlacement()
Port	getPort(String name) Gets the corresponding port on the module by name.
SitePinInst	getSingleCorrespondingPin(Port port) Gets the single corresponding port pin (SitePinInst) on this module instance that corresponds to the module's port.
List<SiteInst>	getSiteInsts() Gets the site instance that belong to this module instance.
Set<PIP>	getUsedStaticPIPs(Net staticNet) Gets the current set of used GND/VCC PIPs by this ModuleInst.
boolean	isPlaced()
boolean	overlaps(ModuleInst hm)
boolean	place(Site newAnchorSite) Places the module instance anchor at the newAnchorSite as well as all other instances and nets within the module instance at their relative offsets of the new site.
boolean	place(Site newAnchorSite, boolean skipIncompatible) Places the module instance anchor at the newAnchorSite as well as all other instances and nets within the module instance at their relative offsets of the new site.
boolean	place(Site newAnchorSite, boolean skipIncompatible, boolean allowOverlap) Places the module instance anchor at the newAnchorSite as well as all other instances and nets within the module instance at their relative offsets of the new site.
boolean	placeMINearTile(Tile ipTile, SiteTypeEnum type) Attempts to place the module instance such that it's lower left tile falls on the specified IP tile (CLB,DSP,BRAM,...)
boolean	placeOnOriginalAnchor() Places the module instance on the module's anchor site (original location of the module).
void	removeInst(SiteInst inst)
void	setAnchor(SiteInst anchor) Sets the anchor instance for this module instance.
void	setDesign(Design design)
void	setInsts(ArrayList<SiteInst> instances)
void	setModule(Module module)
void	unplace() Removes all placement information and unroutes all nets of the module instance.

Methods inherited from class com.xilinx.rapidwright.design.AbstractModuleInst

connect, connect, connect, connect, equals, getCellInst, getName, getNewNetName, hashCode, setCellInst, setName, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModuleInst

public ModuleInst(String name,
                  Design design)

Constructor initializing instance module name

Parameters:

name - Name of the module instance

ModuleInst

public ModuleInst(ModuleInst moduleInst)

This will initialize this module instance to the same attributes as the module instance passed in. This is primarily used for classes which extend ModuleInst. This performs a shallow copy of the original Module Instance. It will point to the same cell and instances as the original module.

Parameters:

moduleInst - The module instance to mimic.

Method Detail

addInst

public void addInst(SiteInst inst)

Adds the instance inst to the instances list that are members of the module instance.

Parameters:

inst - The instance to add.

removeInst

public void removeInst(SiteInst inst)

addNet

public void addNet(Net net)

Adds the net to the net list that are members of the module instance.

Parameters:

net - The net to add.

setDesign

public void setDesign(Design design)

Parameters:

design - the design to set

getDesign

public Design getDesign()

Returns:

the design

getModule

public Module getModule()

Specified by:

getModule in class AbstractModuleInst<Module,Site,ModuleInst>

Returns:

the moduleType

setModule

public void setModule(Module module)

Parameters:

module - the module to set.

getSiteInsts

public List<SiteInst> getSiteInsts()

Gets the site instance that belong to this module instance.

Returns:

The list of site instances that belong to this module instance.

setInsts

public void setInsts(ArrayList<SiteInst> instances)

Parameters:

instances - the instances to set

getNets

public ArrayList<Net> getNets()

Gets the list of physical nets in the module instance.

Returns:

Full list of physical nets in this module instance.

setAnchor

public void setAnchor(SiteInst anchor)

Sets the anchor instance for this module instance.

Parameters:

anchor - The new anchor instance for this module instance.

getAnchor

public SiteInst getAnchor()

Gets and returns the anchor instance for this module instance.

Returns:

The anchor instance for this module instance.

isPlaced

public boolean isPlaced()

addNOCClient

public void addNOCClient(NOCClient nc)

getNOCClients

public List<NOCClient> getNOCClients()

getAllValidPlacements

public ArrayList<Site> getAllValidPlacements()

Does a brute force search to find all valid locations of where this module instance can be placed. It returns the module instance to its original location.

Returns:

A list of valid anchor sites for the module instance to be placed.

place

public boolean place(Site newAnchorSite)

Places the module instance anchor at the newAnchorSite as well as all other instances and nets within the module instance at their relative offsets of the new site. Note that this method allows placement overlap by default. See ModuleInst.place(Site, boolean, boolean) to disallow module overlap.

Parameters:

newAnchorSite - The new site for the anchor of the module instance.

Returns:

True if placement was successful, false otherwise.

placeOnOriginalAnchor

public boolean placeOnOriginalAnchor()

Places the module instance on the module's anchor site (original location of the module). This is the same as place(getModule().getAnchor().getSite()). Note that this method allows placement overlap by default. See ModuleInst.place(Site, boolean, boolean) to disallow module overlap.

Returns:

True if the placement was successful, false otherwise.

place

public boolean place(Site newAnchorSite,
                     boolean skipIncompatible)

Places the module instance anchor at the newAnchorSite as well as all other instances and nets within the module instance at their relative offsets of the new site. Note that this method allows placement overlap by default. See ModuleInst.place(Site, boolean, boolean) to disallow module overlap.

Parameters:

newAnchorSite - The new site for the anchor of the module instance.

skipIncompatible - Flag telling the placement checks to skip any incompatible site that does not match the floorplan according to the original module and simply leave it unplaced. Setting to false will cause placement to fail on first mismatch of floorplan placement attempt.

Returns:

True if placement was successful, false otherwise.

place

public boolean place(Site newAnchorSite,
                     boolean skipIncompatible,
                     boolean allowOverlap)

Places the module instance anchor at the newAnchorSite as well as all other instances and nets within the module instance at their relative offsets of the new site.

Parameters:

newAnchorSite - The new site for the anchor of the module instance.

skipIncompatible - Flag telling the placement checks to skip any incompatible site that does not match the floorplan according to the original module and simply leave it unplaced. Setting to false will cause placement to fail on first mismatch of floorplan placement attempt.

allowOverlap - True if the module instance is allowed to overlap with existing placed logic.

Returns:

True if placement was successful, false otherwise.

unplace

public void unplace()

Removes all placement information and unroutes all nets of the module instance.

Specified by:

unplace in class AbstractModuleInst<Module,Site,ModuleInst>

getCorrespondingTile

public Tile getCorrespondingTile(Tile templateTile,
                                 Tile newAnchorTile)

This method will calculate and return the corresponding tile of a module instance. for a new anchor location.

Parameters:

templateTile - The tile in the module which acts as a template.

newAnchorTile - This is the tile of the new anchor instance of the module instance.

Returns:

The new tile of the module instance which corresponds to the templateTile, or null if none exists.

getCorrespondingPins

public Set<SitePinInst> getCorrespondingPins(Port port)

Gets the corresponding port pins (SitePinInst) on this module instance that corresponds to the module's port.

Parameters:

port - The port on the prototype module.

Returns:

The corresponding port pins on this module instance

getSingleCorrespondingPin

public SitePinInst getSingleCorrespondingPin(Port port)

Gets the single corresponding port pin (SitePinInst) on this module instance that corresponds to the module's port. If the module port has multiple pins, this will throw an Exception.

Parameters:

port - The port on the prototype module.

Returns:

The corresponding port pin on this module instance, or null if could not be found.

getCorrespondingNet

public Net getCorrespondingNet(Port p)

Gets (if it exists), the corresponding net within the module instance of the port.

Parameters:

p - The port on the module of interest

Returns:

The corresponding net on the module instance.

getPort

public Port getPort(String name)

Gets the corresponding port on the module by name.

Parameters:

name -

Returns:

Port object.

getLowerLeftPlacement

public Site getLowerLeftPlacement()

Get's the current lower left site as used for a placement directive for an implementation guide. If a pblock was used and is presently annotated on the Module, it will use the lower left most corner of the pblock.

Returns:

The current lower left site used for placement.

getLowerLeftPlacement

public Site getLowerLeftPlacement(SiteTypeEnum type)

Get's the current lower left site as used for a placement directive for an implementation guide. If a pblock was used and is presently annotated on the Module, it will use the lower left most corner of the pblock.

Parameters:

type - If a desired type is requested for the corner, otherwise it will search for the most lower left corner site

Returns:

The current lower left site used for placement.

getLowerLeftTile

public Tile getLowerLeftTile(SiteTypeEnum type)

Chooses a lower left reference tile in a module instance for the purpose of placement. The tile chosen is from the context of the original module, not the module instance's current location.

Parameters:

type - The site type space in which to reference.

Returns:

A lower left tile from the module's original footprint.

placeMINearTile

public boolean placeMINearTile(Tile ipTile,
                               SiteTypeEnum type)

Attempts to place the module instance such that it's lower left tile falls on the specified IP tile (CLB,DSP,BRAM,...)

Parameters:

ipTile - The specific tile onto which the lower left tile of the ModuleInst should be placed.

type - The specific site type in the tile.

Returns:

True if the placement succeeded, false otherwise.

connect

public void connect(String portName,
                    int busIndex0,
                    ModuleInst other,
                    String otherPortName,
                    int busIndex1)

Connects two signals by port name between this module instance and another. This method will create a new net for the connection handling adding both a logical net (EDIFNet) and physical net (Net). In the case of a top level connection, the physical net will not be created.

Overrides:

connect in class AbstractModuleInst<Module,Site,ModuleInst>

Parameters:

portName - This module instance's port name to connect.

busIndex0 - If the assigned port of this module instance is multi-bit, specify the index to connect or -1 if single bit bus.

other - The other module instance to connect to. If this is null, it will connect it to an existing parent cell port named otherPortName. When null, this is presumed an out of context design where there might not be a source/sink.

otherPortName - The port name on the other module instance to connect to or the top-level port of the the cell instance.

busIndex1 - If the port (of the other module instance or the existing parent cell) is multi-bit, specify the index to connect or -1 if single bit bus.

getBoundingBox

public RelocatableTileRectangle getBoundingBox()

Specified by:

getBoundingBox in class AbstractModuleInst<Module,Site,ModuleInst>

getPlacement

public Site getPlacement()

Specified by:

getPlacement in class AbstractModuleInst<Module,Site,ModuleInst>

overlaps

public boolean overlaps(ModuleInst hm)

Specified by:

overlaps in class AbstractModuleInst<Module,Site,ModuleInst>

getUsedStaticPIPs

public Set<PIP> getUsedStaticPIPs(Net staticNet)

Gets the current set of used GND/VCC PIPs by this ModuleInst. If the module instance is not placed, the set will be empty.

Parameters:

staticNet - A static net of the type to get.

Returns:

The set of PIPs used by this module instance if placed, null if the net provided is not a static net.