Design

Object
- com.xilinx.rapidwright.design.Design

All Implemented Interfaces:

Serializable
```
public class Design
extends Object
implements Serializable
```
The Design class is the central location that maintains the physical netlist and has hooks and references into the logical netlist. Ideally, this class holds all the information necessary to reproduce a design in Vivado.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String RW_AUTO_GENERATE_READABLE_EDIF
Name of the environment variable that controls the auto generation of readable EDIF mechanism.

Fields
Modifier and Type	Field and Description
`static String`	`RW_AUTO_GENERATE_READABLE_EDIF` Name of the environment variable that controls the auto generation of readable EDIF mechanism.

Constructor Summary

Constructors
Constructor and Description
`Design()` Constructor which initializes all member data structures.
`Design(EDIFNetlist n)` Creates a new design and populates the logical netlist from the provided EDIFNetlist.
`Design(String designName, String partName)` Creates a new design and populates it with the given design name and part name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BELAttr`	`addBELAttr(Net net, Site site, SiteTypeEnum type, BEL bel, String name, String value)` Adds a BEL attribute on the net provided
`Cell`	`addCell(Cell c)` Adds the cell to the design.
`void`	`addManuallyRoutedSite(String siteName)`
`boolean`	`addModifiedNet(Net net)` Adds the Net to the set of modified Nets for this design.
`boolean`	`addModifiedSiteInst(SiteInst siteInst)` Adds the SiteInst to the set of modified SiteInsts for this design.
`void`	`addModule(Module module)` Adds a module to the design, including copying the module's netlist into the current design's netlist (using `EDIFNetlist.copyCellAndSubCells(com.xilinx.rapidwright.edif.EDIFCell)`).
`void`	`addModuleImpls(ModuleImpls modImpls)` Adds a list of modules with different implementations (ModuleImpls) to preserve order
`EDIFCellInst`	`addModuleInstNetlist(ModuleInst mi, EDIFNetlist edifGuts)` Adds the EDIF netlist guts to the existing netlist for a particular module instance.
`Net`	`addNet(Net net)` Attaches a net to the design by mapping the hierarchical name to the Net object.
`boolean`	`addPartitionPin(PartitionPin pin)` Adds a partition pin to this design
`void`	`addSiteInst(SiteInst inst)` Adds a site instance to the design.
`void`	`addXDCConstraint(ConstraintGroup cg, String... xdc)` Adds the XDC command(s) to the list of the provided `ConstraintGroup`.
`void`	`addXDCConstraint(String... xdc)` Adds the XDC command to the list of (Normal, see `ConstraintGroup`) XDC commands for this design.
`void`	`clearTrackedChanges()` Clears (empties) all tracked sets (logical cells, SiteInsts and Nets)
`void`	`clearUsedSites()` Clears out all the used sites in the design.
`Cell`	`copyCell(Cell c, String instName)` Copies the cell c into this design (c should originate from a different design).
`void`	`copyPartitionPins(Design source, ModuleInst dest, Map<EDIFPort,EDIFPort> portMap)` Copy PartitionPins from a design to its ModuleInst in this design.
`Cell`	`createAndPlaceCell(EDIFCell parent, String name, Unisim cellType, Site site, BEL bel)` Convenience function to create and place a new cell.
`Cell`	`createAndPlaceCell(EDIFCell parent, String name, Unisim cellType, Site site, BEL bel, String... params)` Convenience function to create and place a new cell.
`Cell`	`createAndPlaceCell(EDIFCell parent, String name, Unisim cellType, String location)` Creates a new cell from scratch in the logical and physical netlists and places it at the location specified.
`Cell`	`createAndPlaceCell(EDIFCell parent, String name, Unisim cellType, String location, String... params)` Creates a new cell from scratch in the logical and physical netlists and places it at the location specified.
`Cell`	`createAndPlaceCell(String name, Unisim cellType, String location)` Creates a new cell from scratch in the logical and physical netlists and places it at the location specified.
`Cell`	`createAndPlaceCell(String name, Unisim cellType, String location, String... params)` Creates a new cell from scratch in the logical and physical netlists and places it at the location specified.
`Cell`	`createAndPlaceIOB(String name, PinType dir, String pkgPin, String ioStandard)` Creates either an IBUF or OBUF in the netlist and places according to the provided package pin.
`Cell`	`createAndPlaceIOB(String name, PinType dir, String pkgPin, String ioStandard, Net portNet, EDIFNet logNet)` Creates either an IBUF or OBUF in the netlist and places according to the provided package pin.
`Cell`	`createBUFGCE(EDIFCell parent, String name, Site location)` Creates a new BUFGCE instance in the parent cell provided and places it at location.
`Cell`	`createCell(String instName, EDIFCell reference)` Creates and adds a new cell instance to the top level of the design.
`Cell`	`createCell(String instName, EDIFCellInst instance)` Creates a physical cell object from an existing logical cell instance in the netlist.
`Cell`	`createCell(String instName, Unisim unisim)` Creates and adds a new cell instance to the top level of the design.
`EDIFCellInst`	`createIBUFDS(String portNameP, String portNameN, Site siteP, Site siteN, Net portNet, EDIFNet logNet, String ioStandard)` This method will create a generic IBUFDS instance (DIFFINBUF+IBUFCTRL) at the top level of a design.
`ModuleInst`	`createModuleInst(String name, Module module)` Creates, adds to design, and returns a new ModuleInst called name and based on module.
`ModuleInst`	`createModuleInst(String name, Module module, boolean includePortRouting)` Creates, adds to design, and returns a new ModuleInst called name and based on module.
`Net`	`createNet(EDIFHierNet net)` Creates a physical net from a logical hierarchical net.
`Net`	`createNet(String netName)` Creates both the logical and physical net objects for the given name.
`EDIFCellInst`	`createOrFindEDIFCellInst(String name, EDIFCell cell)` Create or find a EDIFCellInst of the specified name.
`PartitionPin`	`createPartitionPin(EDIFHierPortInst pin, Node node)` Creates a new partition pin and adds it to the design
`PartitionPin`	`createPartitionPin(EDIFPort port, int index, Node node)` Creates a new partition pin from a top cell port and adds it to the design
`PartitionPin`	`createPartitionPin(EDIFPort port, Node node)` Creates a new partition pin from a top cell port and adds it to the design
`SiteInst`	`createSiteInst(Site site)` Convenience site instance creator for a given site.
`SiteInst`	`createSiteInst(String siteName)` Convenience site instance creator for a given site.
`SiteInst`	`createSiteInst(String name, SiteTypeEnum type, Site placement)` Creates a new site instance in the design.
`static EDIFCellInst`	`createUnisimInst(EDIFCell parent, String name, Unisim cellType)` Create a unisim EDIF cell instance.
`void`	`detachNetlist()` Removes all references to the EDIFNetlist.
`void`	`detachNetlist(Predicate<Cell> preserveCellProperties)` Removes all references to the EDIFNetlist.
`void`	`flattenDesign()` If there are any module instances in the design, this flattens them so there are no references to modules or module instances.
`Map<Site,SiteConfig>`	`getBELAttrs()` Get the BEL attribute mappings for this design
`Cell`	`getCell(String name)` Gets a cell by name from the instance
`Collection<Cell>`	`getCells()` Gets all the cells in the design (unlike @link{SiteInst#getCells()}, routethrus are not included)
`static Map<String,VivadoProp>`	`getDefaultCellProperties(Series series, String cellTypeName)` Returns a map of all default cell properties for the specified cell.
`static VivadoProp`	`getDefaultProperty(Series series, String cellTypeName, String propName)` Gets the default property (type and value) for the specified cell and property name.
`Device`	`getDevice()` Gets the device specific to this part and returns it.
`Net`	`getGndNet()` Get the global ground net called
`static EDIFLibrary`	`getMacroPrimitives(Series s)` Gets the logical (EDIF) representation of the macro primitives supported by this architecture.
`Set<String>`	`getManuallyRoutedSites()`
`Set<Net>`	`getModifiedNets()` Gets the set of modified Nets for this design.
`Set<SiteInst>`	`getModifiedSiteInsts()` Gets the set of modified SiteInsts for this design.
`Module`	`getModule(String name)` Get a module by name.
`Module`	`getModule(String name, int implementationIndex)` Get's a specific implementation of a module
`ModuleInst`	`getModuleInst(String name)` Gets and returns the moduleInst called name.
`HashMap<String,ModuleInst>`	`getModuleInstMap()` Gets and returns the HashMap of all of the module instance members separated by module instance name.
`Collection<ModuleInst>`	`getModuleInsts()` Gets and returns the Collection of all of the module instances in this design.
`Set<String>`	`getModuleNames()` Get all module names
`Collection<ModuleImpls>`	`getModules()` Gets and returns all of the modules of the design.
`String`	`getName()` Gets and returns the current name of the design.
`Net`	`getNet(String name)` Get a net by name.
`EDIFNetlist`	`getNetlist()` Get the logical netlist object corresponding to this design.
`Collection<Net>`	`getNets()` Gets and returns all of the nets of the design.
`NOCDesign`	`getNOCDesign()` Gets the current NOC Design for this design
`Map<String,List<PIP>>`	`getOriginalNetRouting()` Gets a map of all the original net routing PIPs of nets that have been modified since `Design.isCopyingOriginalNetsRouting()` returns true.
`Map<String,SiteInst>`	`getOriginalSiteInsts()` Gets a map of all the original SiteInst objects that have been modified since `Design.isCopyingOriginalSiteInsts()` returns true.
`Part`	`getPart()` Gets the part object this design is targeting.
`List<PartitionPin>`	`getPartitionPins()` Gets the partition pins associated with this design
`String`	`getPartName()` This will return the canonical part name used within Vivado.
`static String`	`getPartNameFromDCP(Path dcpFileName)` Gets the part name of the design in the DCP file specified without loading the entire DCP or the associated device.
`static String`	`getPartNameFromDCP(String dcpFileName)` Gets the part name of the design in the DCP file specified without loading the entire DCP or the associated device.
`static EDIFLibrary`	`getPrimitivesLibrary()` Gets the set of all unisim primitives as an EDIF library.
`static EDIFLibrary`	`getPrimitivesLibrary(String deviceName)` Gets the set of compatible unisim primitives for the specified device as an EDIF Library.
`Series`	`getSeries()` Gets the Series of this design by looking at the target device.
`SiteInst`	`getSiteInst(String name)` Get an instance by name.
`SiteInst`	`getSiteInstFromSite(Site site)` Gets and returns the site instance placed on the specified site.
`SiteInst`	`getSiteInstFromSiteName(String siteName)` Gets and returns the site instance at the specified site.
`Collection<SiteInst>`	`getSiteInsts()` Gets and returns all of the instance in the design.
`Net`	`getStaticNet(NetType type)` Get the global static net or based on the `NetType`.
`EDIFCell`	`getTopEDIFCell()` Gets the top logical cell from the netlist.
`static EDIFCell`	`getUnisimCell(Unisim cell)` Gets the Unisim primitive cell.
`Net`	`getVccNet()` Get the global power net called
`List<String>`	`getXDCConstraints(ConstraintGroup cg)` Gets a list of strings that correspond to lines of an XDC file for the design.
`static boolean`	`isAutoGenerateReadableEdif()` Check if Vivado should be automatically run during `Design.readCheckpoint(Path)` to generate readable EDIFs.
`boolean`	`isAutoIOBuffersSet()` Checks the setting on this design for its behavior related auto I/O buffer instantiation when the design is loaded in Vivado.
`boolean`	`isCopyingOriginalNetsRouting()` Gets and returns the flag indicating if the design is keeping a copy of a net's PIPs before it is modified.
`boolean`	`isCopyingOriginalSiteInsts()` Gets and returns the flag indicating if the design is keeping a copy of a SiteInst before it is modified.
`boolean`	`isDesignOutOfContext()` Checks if the design is labeled as an out-of-context design for Vivado.
`boolean`	`isSiteUsed(Site site)` Checks if the site is used in this design.
`boolean`	`isTrackingNetChanges()` Checks a flag indicating if this design is currently tracking changes to its Nets.
`boolean`	`isTrackingSiteInstChanges()` Checks a flag indicating if this design is currently tracking changes to its SiteInsts.
`void`	`movePinsToNewNetDeleteOldNet(Net oldNet, Net newNet, boolean keepRouting)` The method will take the pins on the oldNet and move them to the newNet.
`boolean`	`placeCell(Cell c, Site site, BEL bel)` This is a limited checking placement method for placing a cell on a BEL site.
`boolean`	`placeCell(Cell c, Site site, BEL bel, Map<String,String> pinMappings)` This is a limited checking placement method for placing a cell on a BEL site.
`boolean`	`placeCells(Map<String,String> desiredCellPlacements)` Places a set of cells according to the map provided.
`Cell`	`placeIOB(EDIFCellInst bufInst, String pkgPin, String ioStandard)` Places an existing IBUF or OBUF in the netlist according to the provided package pin.
`static Design`	`readCheckpoint(Path dcpFileName)` Reads a design checkpoint file into a new design object.
`static Design`	`readCheckpoint(Path dcpFileName, boolean skipXdef)` Reads a design checkpoint file into a new design object.
`static Design`	`readCheckpoint(Path dcpFileName, CodePerfTracker t)` Reads a design checkpoint file into a new design object.
`static Design`	`readCheckpoint(Path dcpFileName, Path edfFileName)` Reads a design checkpoint file into a new design object.
`static Design`	`readCheckpoint(Path dcpFileName, Path edfFileName, boolean skipXdef, CodePerfTracker t)` Reads a design checkpoint file into a new design object.
`static Design`	`readCheckpoint(Path dcpFileName, Path edfFileName, CodePerfTracker t)` Reads a design checkpoint file into a new design object.
`static Design`	`readCheckpoint(String dcpFileName)` Reads a design checkpoint file into a new design object.
`static Design`	`readCheckpoint(String dcpFileName, boolean skipXdef)` Reads a design checkpoint file into a new design object.
`static Design`	`readCheckpoint(String dcpFileName, CodePerfTracker t)` Reads a design checkpoint file into a new design object.
`static Design`	`readCheckpoint(String dcpFileName, String edfFileName)` Reads a design checkpoint file into a new design object.
`static Design`	`readCheckpoint(String dcpFileName, String edfFileName, CodePerfTracker t)` Reads a design checkpoint file into a new design object.
`static boolean`	`readEdifAndXdefInParallel()` Check if `Design.readCheckpoint(Path)` is encouraged to read Edif and XDEF (placement and routing information) in parallel.
`Cell`	`removeCell(Cell c)` Removes the cell of the same name
`Cell`	`removeCell(String name)` Removes the cell by its hierarchical name.
`Net`	`removeNet(Net net)` Removes a net from the design and associated routing.
`Net`	`removeNet(String name)` Removes a net from the design
`boolean`	`removePartitionPin(PartitionPin pin)` Removes a partition pin from this design
`boolean`	`removeSiteInst(SiteInst instance)` This method carefully removes an instance in a design with its pins and possibly nets.
`boolean`	`removeSiteInst(SiteInst instance, boolean keepSitePinRouting)` This method carefully removes an instance in a design with its pins and possibly nets.
`boolean`	`renameSiteInst(SiteInst inst, String newName)` Renames a SiteInst, checks if an existing site already has the new desired name.
`static boolean`	`replaceEDIFinDCP(String dcpFileName, String edfFileName)` Replaces the existing EDIF file inside a DCP with the one provided and ensures that it will be loaded when the DCP is read by Vivado.
`static boolean`	`replaceEDIFinDCP(String inDcpFileName, String edfFileName, String outDcpFileName)` Create a new DCP but overwriting the EDIF file from the input DCP with the one provided and ensures that it will be loaded when the DCP is read by Vivado.
`void`	`repopulateNetlistOfModuleInst(ModuleInst modInst, EDIFNetlist edifGuts)` For a module instance, inserts the logical netlist into the main EDIF netlist.
`void`	`repopulateNetlistOfModuleInst(String modInstName, EDIFNetlist edifGuts)` For a module instance, inserts the logical netlist into the main EDIF netlist.
`boolean`	`retargetPart(Part targetPart, int tileXOffset, int tileYOffset)` Changes the current target part to another compatible part and updates all device-related references accordingly.
`void`	`routeSites()` Iterates through all non-empty site instances and invokes the routeSite() method on each one.
`static void`	`setAutoGenerateReadableEdif(boolean autoGenerateReadableEdif)` Set whether to automatically run Vivado during `Design.readCheckpoint(Path)` to generate readable EDIFs
`void`	`setAutoIOBuffers(boolean val)` Updates the design such that if a DCP is created and read into Vivado, if it is to automatically instantiate I/Os for top level ports not already connected to I/Os.
`void`	`setCopyingOriginalNetsRouting(boolean copyOrigNets)` Sets the flag indicating if the design is to keep a copy of a net's routing before it is modified.
`void`	`setCopyingOriginalSiteInsts(boolean copyOrigSiteInsts)` Sets the flag indicating if the design is to keep a copy of a net's routing before it is modified.
`void`	`setDesignOutOfContext(boolean val)` Updates the design to be set or unset as out of context for Vivado.
`void`	`setName(String name)` Sets the name of the design
`void`	`setNetlist(EDIFNetlist netlist)` Sets the logical netlist for this design.
`void`	`setNOCDesign(NOCDesign nocDesign)` Sets the NOC Design for this design
`void`	`setPartName(String partName)` Sets the part name (see `Part`), for the design.
`static void`	`setReadEdifAndXdefInParallel(boolean readEdifAndXdefInParallel)` Set whether `Design.readCheckpoint(Path)` is encouraged to read Edif and XDEF (placement and routing information) in parallel.
`void`	`setTrackingChanges(boolean trackChanges)` Global design setting that enables or disable tracking of modified EDIFCells, SiteInsts and physical Nets.
`void`	`setTrackNetChanges(boolean trackNetChanges)` Flag to track changes to Nets in this design.
`void`	`setTrackSiteInstChanges(boolean trackSiteInstChanges)` Flag to track changes to SiteInst in this design.
`List<String>`	`setXDCConstraints(List<String> xdc, ConstraintGroup cg)` Sets (overwrites) the XDC commands for this design with those provided.
`String`	`toString()`
`void`	`trimPartitionPins(Pair<Tile,Tile> range)` Remove excess routing from all Partition pins beyond the first node within a tile range.
`void`	`unplaceDesign()` Will unroute and unplace the design, no site information will be retained.
`void`	`unrouteDesign()` Unroutes the current design by removing all PIPs.
`void`	`unrouteSites()` Removes all site routing from all instantiated sites in the design.
`void`	`updateDesignWithCheckpointPlaceAndRoute(Path dcpFileName)` Applies the placement and routing of the provided DCP to the netlist given in this design.
`void`	`updateDesignWithCheckpointPlaceAndRoute(String dcpFileName)` Applies the placement and routing of the provided DCP to the netlist given in this design.
`void`	`writeCheckpoint(Path dcpFileName)` Writes a design checkpoint file from the current state of the design.
`void`	`writeCheckpoint(Path dcpFileName, CodePerfTracker t)` Writes a design checkpoint file from the current state of the design.
`void`	`writeCheckpoint(Path dcpFileName, Path edfFileName, CodePerfTracker t)` Writes a design checkpoint file from the current state of the design, but optionally using a previously-written EDIF netlist file rather than creating a new one.
`void`	`writeCheckpoint(String dcpFileName)` Writes a design checkpoint file from the current state of the design.
`void`	`writeCheckpoint(String dcpFileName, CodePerfTracker t)` Writes a design checkpoint file from the current state of the design.
`void`	`writeCheckpoint(String dcpFileName, String edfFileName, CodePerfTracker t)` Writes a design checkpoint file from the current state of the design, but optionally using a previously-written EDIF netlist file rather than creating a new one.

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

- Field Detail
  - RW_AUTO_GENERATE_READABLE_EDIF
```
public static final String RW_AUTO_GENERATE_READABLE_EDIF
```
    Name of the environment variable that controls the auto generation of readable EDIF mechanism. By default, RapidWright will automatically invoke Vivado (the one found on the current PATH) and attempt to create a readable EDIF by loading the provided DCP. If set to '0' ("RW_AUTO_GENERATE_READABLE_EDIF=0"), RapidWright will fail if a non-encrypted EDIF file to cannot be found alongside a loaded DCP.
    
    Since:
    
    2021.1.2
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Design
```
public Design()
```
    Constructor which initializes all member data structures. Name is set to null.
    
    Since:
    
    2018.2.0
  - Design
```
public Design(String designName,
              String partName)
```
    Creates a new design and populates it with the given design name and part name.
    
    Parameters:
    
    designName - The name of the newly created design.
    
    deviceName - The target part name of the newly created design.
    
    Since:
    
    2018.2.0
  - Design
```
public Design(EDIFNetlist n)
```
    Creates a new design and populates the logical netlist from the provided EDIFNetlist. The name of the design is taken from the EDIFNetlist.
    
    Parameters:
    
    n - The netlist to populate the new design object.
    
    Since:
    
    2018.2.0
- Method Detail
  - isAutoGenerateReadableEdif
```
public static boolean isAutoGenerateReadableEdif()
```
    Check if Vivado should be automatically run during Design.readCheckpoint(Path) to generate readable EDIFs. True by default.
    
    Since:
    
    2021.1.0
  - setAutoGenerateReadableEdif
```
public static void setAutoGenerateReadableEdif(boolean autoGenerateReadableEdif)
```
    Set whether to automatically run Vivado during Design.readCheckpoint(Path) to generate readable EDIFs
    
    Since:
    
    2021.1.0
  - readEdifAndXdefInParallel
```
public static boolean readEdifAndXdefInParallel()
```
    Check if Design.readCheckpoint(Path) is encouraged to read Edif and XDEF (placement and routing information) in parallel. True by default. Parallelism within the Edif or XDEF parsers are unaffected by this setting; this controls whether both parsers are allowed to be run simultaneously.
    
    Since:
    
    2022.2.3
  - setReadEdifAndXdefInParallel
```
public static void setReadEdifAndXdefInParallel(boolean readEdifAndXdefInParallel)
```
    Set whether Design.readCheckpoint(Path) is encouraged to read Edif and XDEF (placement and routing information) in parallel. Parallelism within the Edif or XDEF parsers are unaffected by this setting; this controls whether both parsers are allowed to be run simultaneously.
    
    Since:
    
    2022.2.3
  - readCheckpoint
```
public static Design readCheckpoint(Path dcpFileName)
```
    Reads a design checkpoint file into a new design object. It will attempt to get a readable EDIF from the following sources:
    - The EDIF inside the Checkpoint if it is not encrypted
    - An EDIF file of the same name in the same directory as the DCP (ex: mydcp.dcp --> look for mydcp.edf) if it exists
    - If () is set, Run Vivado to create a readable EDIF file of the same name in the same directory as the DCP
    Vivado Tcl:
    open_checkpoint $dcpFileName
    Parameters: dcpFileName - Name of the DCP to load. Returns: A new design object of the design loaded from the DCP. Since: 2020.2.4
  readCheckpoint public static Design readCheckpoint(String dcpFileName) Reads a design checkpoint file into a new design object. It will attempt to get a readable EDIF from the following sources: The EDIF inside the Checkpoint if it is not encrypted An EDIF file of the same name in the same directory as the DCP (ex: mydcp.dcp --> look for mydcp.edf) if it exists If () is set, Run Vivado to create a readable EDIF file of the same name in the same directory as the DCP Vivado Tcl: open_checkpoint $dcpFileName Parameters: dcpFileName - Name of the DCP to load. Returns: A new design object of the design loaded from the DCP. Since: 2018.2.0 readCheckpoint public static Design readCheckpoint(Path dcpFileName, CodePerfTracker t) Reads a design checkpoint file into a new design object. It will attempt to get a readable EDIF from the following sources: The EDIF inside the Checkpoint if it is not encrypted An EDIF file of the same name in the same directory as the DCP (ex: mydcp.dcp --> look for mydcp.edf) if it exists If () is set, Run Vivado to create a readable EDIF file of the same name in the same directory as the DCP Performs the same as Design.readCheckpoint(Path) except allows you to control the CodePerfTracker that is used during the DCP loading process. Vivado Tcl: open_checkpoint $dcpFileName Parameters: dcpFileName - Name of the DCP file. t - The CodePerfTracker instance to use, can be null and a unique one will be created. Returns: A new design object populated by the DCP file. Since: 2020.2.4 readCheckpoint public static Design readCheckpoint(String dcpFileName, CodePerfTracker t) Reads a design checkpoint file into a new design object. It will attempt to get a readable EDIF from the following sources: The EDIF inside the Checkpoint if it is not encrypted An EDIF file of the same name in the same directory as the DCP (ex: mydcp.dcp --> look for mydcp.edf) if it exists If () is set, Run Vivado to create a readable EDIF file of the same name in the same directory as the DCP Performs the same as Design.readCheckpoint(String) except allows you to control the CodePerfTracker that is used during the DCP loading process. Vivado Tcl: open_checkpoint $dcpFileName Parameters: dcpFileName - Name of the DCP file. t - The CodePerfTracker instance to use, can be null and a unique one will be created. Returns: A new design object populated by the DCP file. Since: 2018.2.0 readCheckpoint public static Design readCheckpoint(Path dcpFileName, Path edfFileName, CodePerfTracker t) Reads a design checkpoint file into a new design object. It will use the provided edfFileName to parse the netlist and ignore the EDIF file inside the DCP. It will attempt to get a readable EDIF from the following sources: The edif file provided via edfFileName if it exists If () is set, Run Vivado to create a readable EDIF file at edfFileName Vivado Tcl: open_checkpoint $dcpFileName Parameters: dcpFileName - Name of the DCP file to load. edfFileName - Name of the external EDIF file to load/create. t - The CodePerfTracker instance to use, can be null and a unique one will be created. Returns: A design object loaded from the provided files. Since: 2020.2.4 readCheckpoint public static Design readCheckpoint(String dcpFileName, String edfFileName, CodePerfTracker t) Reads a design checkpoint file into a new design object. It will use the provided edfFileName to parse the netlist and ignore the EDIF file inside the DCP. It will attempt to get a readable EDIF from the following sources: The edif file provided via edfFileName if it exists If () is set, Run Vivado to create a readable EDIF file at edfFileName Vivado Tcl: open_checkpoint $dcpFileName Parameters: dcpFileName - Name of the DCP file to load. edfFileName - Name of the external EDIF file to load/create. t - The CodePerfTracker instance to use, can be null and a unique one will be created. Returns: A design object loaded from the provided files. Since: 2020.1.1 readCheckpoint public static Design readCheckpoint(Path dcpFileName, Path edfFileName) Reads a design checkpoint file into a new design object. It will use the provided edfFileName to parse the netlist and ignore the EDIF file inside the DCP. It will attempt the following steps in order to get a readable EDIF: The edif file provided via edfFileName if it exists If () is set, Run Vivado to create a readable EDIF file at edfFileName Vivado Tcl: open_checkpoint $dcpFileName Parameters: dcpFileName - Name of the DCP file to load. edfFileName - Name of the external EDIF file to load. Returns: A design object loaded from the provided files. Since: 2020.2.4 readCheckpoint public static Design readCheckpoint(String dcpFileName, String edfFileName) Reads a design checkpoint file into a new design object. It will use the provided edfFileName to parse the netlist and ignore the EDIF file inside the DCP. It will attempt the following steps in order to get a readable EDIF: The edif file provided via edfFileName if it exists If () is set, Run Vivado to create a readable EDIF file at edfFileName Vivado Tcl: open_checkpoint $dcpFileName Parameters: dcpFileName - Name of the DCP file to load. edfFileName - Name of the external EDIF file to load. Returns: A design object loaded from the provided files. Since: 2018.2.0 readCheckpoint public static Design readCheckpoint(Path dcpFileName, boolean skipXdef) Reads a design checkpoint file into a new design object. It will attempt to get a readable EDIF from the following sources: The EDIF inside the Checkpoint if it is not encrypted An EDIF file of the same name in the same directory as the DCP (ex: mydcp.dcp --> look for mydcp.edf) if it exists If () is set, Run Vivado to create a readable EDIF file of the same name in the same directory as the DCP Vivado Tcl: open_checkpoint $dcpFileName Parameters: dcpFileName - Name of the DCP to load. skipXdef - Flag to indicate if the XDEF (placement and routing information) file should be loaded. Returns: A new design object of the design loaded from the DCP. Since: 2020.2.4 readCheckpoint public static Design readCheckpoint(String dcpFileName, boolean skipXdef) Reads a design checkpoint file into a new design object. It will attempt to get a readable EDIF from the following sources: The EDIF inside the Checkpoint if it is not encrypted An EDIF file of the same name in the same directory as the DCP (ex: mydcp.dcp --> look for mydcp.edf) if it exists If () is set, Run Vivado to create a readable EDIF file of the same name in the same directory as the DCP Vivado Tcl: open_checkpoint $dcpFileName Parameters: dcpFileName - Name of the DCP to load. skipXdef - Flag to indicate if the XDEF (placement and routing information) file should be loaded. Returns: A new design object of the design loaded from the DCP. Since: 2018.2.0 readCheckpoint public static Design readCheckpoint(Path dcpFileName, Path edfFileName, boolean skipXdef, CodePerfTracker t) Reads a design checkpoint file into a new design object. It will use the provided edfFileName to parse the netlist and ignore the EDIF file inside the DCP. It will attempt to get a readable EDIF from the following sources: The edif file provided via edfFileName if it exists If () is set, Run Vivado to create a readable EDIF file at edfFileName Vivado Tcl: open_checkpoint $dcpFileName Parameters: dcpFileName - Name of the DCP file to load. edfFileName - Name of the external EDIF file to load/create. skipXdef - Flag to indicate if the XDEF (placement and routing information) file should be loaded. t - The CodePerfTracker instance to use, can be null and a unique one will be created. Returns: A design object loaded from the provided files. Since: 2020.2.4 writeCheckpoint public void writeCheckpoint(Path dcpFileName) Writes a design checkpoint file from the current state of the design. Vivado Tcl: write_checkpoint $dcpFileName Parameters: dcpFileName - Name of the dcp file to write. Since: 2020.2.4 writeCheckpoint public void writeCheckpoint(String dcpFileName) Writes a design checkpoint file from the current state of the design. Vivado Tcl: write_checkpoint $dcpFileName Parameters: dcpFileName - Name of the dcp file to write. Since: 2018.2.0 writeCheckpoint public void writeCheckpoint(Path dcpFileName, CodePerfTracker t) Writes a design checkpoint file from the current state of the design. Performs the same as Design.writeCheckpoint(Path) with the added option of providing a custom instance of CodePerfTracker. Vivado Tcl: write_checkpoint $dcpFileName Parameters: dcpFileName - Name of the DCP file to write. t - The CodePerfTracker instance to use, can be null and a unique one will be created. Since: 2020.2.4 writeCheckpoint public void writeCheckpoint(String dcpFileName, CodePerfTracker t) Writes a design checkpoint file from the current state of the design. Performs the same as Design.writeCheckpoint(String) with the added option of providing a custom instance of CodePerfTracker. Vivado Tcl: write_checkpoint $dcpFileName Parameters: dcpFileName - Name of the DCP file to write. t - The CodePerfTracker instance to use, can be null and a unique one will be created. Since: 2018.2.0 writeCheckpoint public void writeCheckpoint(String dcpFileName, String edfFileName, CodePerfTracker t) Writes a design checkpoint file from the current state of the design, but optionally using a previously-written EDIF netlist file rather than creating a new one. This option is useful for Designs which have had their netlists detached. Parameters: dcpFileName - Name of the DCP file to write. edfFileName - Name of the EDIF file to use for the dcp, null to write out a new netlist. t - The CodePerfTracker instance to use, can be null and a unique one will be created. Since: 2023.2.2 writeCheckpoint public void writeCheckpoint(Path dcpFileName, Path edfFileName, CodePerfTracker t) Writes a design checkpoint file from the current state of the design, but optionally using a previously-written EDIF netlist file rather than creating a new one. This option is useful for Designs which have had their netlists detached. Parameters: dcpFileName - Name of the DCP file to write. edfFileName - Name of the EDIF file to use for the dcp, null to write out a new netlist. t - The CodePerfTracker instance to use, can be null and a unique one will be created. Since: 2023.2.2 updateDesignWithCheckpointPlaceAndRoute public void updateDesignWithCheckpointPlaceAndRoute(Path dcpFileName) Applies the placement and routing of the provided DCP to the netlist given in this design. Note that the netlist of both DCPs must match. This is useful if you have a large netlist in memory already and want to more easily swap in/out different placement and routing implementations. Parameters: dcpFileName - Name of the DCP with the placement and routing information of interest to apply to this design's netlist. Since: 2020.2.4 updateDesignWithCheckpointPlaceAndRoute public void updateDesignWithCheckpointPlaceAndRoute(String dcpFileName) Applies the placement and routing of the provided DCP to the netlist given in this design. Note that the netlist of both DCPs must match. This is useful if you have a large netlist in memory already and want to more easily swap in/out different placement and routing implementations. Parameters: dcpFileName - Name of the DCP with the placement and routing information of interest to apply to this design's netlist. Since: 2018.2.0 getPartNameFromDCP public static String getPartNameFromDCP(Path dcpFileName) Gets the part name of the design in the DCP file specified without loading the entire DCP or the associated device. Vivado Tcl: read_checkpoint $dcpFileName;get_property PART [current_project] Parameters: dcpFileName - Name of the DCP from which to get the part name. Returns: Name of the part used in the DCP specified, or null if it couldn't be determined. Since: 2020.2.4 getPartNameFromDCP public static String getPartNameFromDCP(String dcpFileName) Gets the part name of the design in the DCP file specified without loading the entire DCP or the associated device. Vivado Tcl: read_checkpoint $dcpFileName;get_property PART [current_project] Parameters: dcpFileName - Name of the DCP from which to get the part name. Returns: Name of the part used in the DCP specified, or null if it couldn't be determined. Since: 2019.1.0 replaceEDIFinDCP public static boolean replaceEDIFinDCP(String dcpFileName, String edfFileName) Replaces the existing EDIF file inside a DCP with the one provided and ensures that it will be loaded when the DCP is read by Vivado. Parameters: dcpFileName - DCP file name to be updated edfFileName - The file name of the EDIF file to be inserted into the DCP replacing the existing one Returns: True if the operation was successful, false otherwise Since: 2021.1.2 replaceEDIFinDCP public static boolean replaceEDIFinDCP(String inDcpFileName, String edfFileName, String outDcpFileName) Create a new DCP but overwriting the EDIF file from the input DCP with the one provided and ensures that it will be loaded when the DCP is read by Vivado. Parameters: inDcpFileName - Input DCP file name edfFileName - The file name of the EDIF file to replace the one inside the input DCP outDcpFileName - Output DCP file name Returns: True if the operation was successful, false otherwise Since: 2022.1.2 getPart public Part getPart() Gets the part object this design is targeting. Vivado Tcl: get_property PART [current_project] Returns: The part object. Since: 2018.2.0 getSeries public Series getSeries() Gets the Series of this design by looking at the target device. Returns: The series of this design. Since: 2024.1.2 isSiteUsed public boolean isSiteUsed(Site site) Checks if the site is used in this design. Vivado Tcl: if [expr [llength [get_cells -of $site]] > 0] 1 else 0 Parameters: site - The site to check if occupied. Returns: True if this design uses site, false otherwise. Since: 2018.2.0 getSiteInstFromSite public SiteInst getSiteInstFromSite(Site site) Gets and returns the site instance placed on the specified site. Parameters: site - The site of the desired site instance. Returns: The instance at site, or null if the primitive site is unoccupied. Since: 2018.2.0 getSiteInstFromSiteName public SiteInst getSiteInstFromSiteName(String siteName) Gets and returns the site instance at the specified site. Parameters: siteName - Name of the site from which to retrieve the site instance. Returns: The SiteInst occupying the site specified or null if invalid site or none exists. Since: 2018.2.0 getModuleInst public ModuleInst getModuleInst(String name) Gets and returns the moduleInst called name. Parameters: name - The name of the moduleInst to get. Returns: The moduleInst name, or null if it does not exist. Since: 2018.2.0 addModuleInstNetlist public EDIFCellInst addModuleInstNetlist(ModuleInst mi, EDIFNetlist edifGuts) Adds the EDIF netlist guts to the existing netlist for a particular module instance. Parameters: mi - The ModuleInst to have recently been added. edifGuts - The corresponding EDIF netlist internals for the ModuleInst. Returns: The new instance within the parent EDIFNetlist Since: 2018.2.0 repopulateNetlistOfModuleInst public void repopulateNetlistOfModuleInst(ModuleInst modInst, EDIFNetlist edifGuts) For a module instance, inserts the logical netlist into the main EDIF netlist. This method assumes the destination netlist already has a blackbox cell instance that needs the guts populated. The caller must connect top level connections Parameters: modInst - The newly added module instance edifGuts - The corresponding logical netlist (EDIF guts) of the module instance Since: 2018.2.0 repopulateNetlistOfModuleInst public void repopulateNetlistOfModuleInst(String modInstName, EDIFNetlist edifGuts) For a module instance, inserts the logical netlist into the main EDIF netlist. This method assumes the destination netlist already has a blackbox cell instance that needs the guts populated. The caller must connect top level connections Parameters: modInstName - The name of the newly added module instance edifGuts - The corresponding logical netlist (EDIF guts) of the module instance Since: 2020.2.5 createOrFindEDIFCellInst public EDIFCellInst createOrFindEDIFCellInst(String name, EDIFCell cell) Create or find a EDIFCellInst of the specified name. If the cell already exists, its cell type is set to moduleTopCell. Otherwise, it will be created. Parameters: name - The name of the new EDIFCellInst to create / find. cell - The cell type for the EDIFCellInst Returns: A found or newly created EDIFCellInst, or null if there is no netlist in the design. Since: 2020.2.4 createModuleInst public ModuleInst createModuleInst(String name, Module module) Creates, adds to design, and returns a new ModuleInst called name and based on module. The module is also added to the design if not already present (see Design.addModule(com.xilinx.rapidwright.design.Module)). Parameters: name - The name of the new ModuleInst created. module - The Module that the new ModuleInst instances. Returns: A new ModuleInst Since: 2018.2.0 createModuleInst public ModuleInst createModuleInst(String name, Module module, boolean includePortRouting) Creates, adds to design, and returns a new ModuleInst called name and based on module. The module is also added to the design if not already present (see Design.addModule(com.xilinx.rapidwright.design.Module)). Parameters: name - The name of the new ModuleInst created. module - The Module that the new ModuleInst instances. includePortRouting - Enables inclusion of top-level port routing. Returns: A new ModuleInst Since: 2020.1.0 renameSiteInst public boolean renameSiteInst(SiteInst inst, String newName) Renames a SiteInst, checks if an existing site already has the new desired name. Parameters: inst - The site instance to rename newName - The newly desired name Returns: True if the operation completed successfully, false if a site instance with the new name already exists Since: 2019.2.1 getName public String getName() Gets and returns the current name of the design. Vivado Tcl: get_property NAME [current_project] Returns: The current name of the design. Since: 2018.2.0 getModuleInsts public Collection<ModuleInst> getModuleInsts() Gets and returns the Collection of all of the module instances in this design. Returns: All the module instances in this design. Since: 2018.2.0 getModuleInstMap public HashMap<String,ModuleInst> getModuleInstMap() Gets and returns the HashMap of all of the module instance members separated by module instance name. Returns: The HashMap containing all current module instances. Since: 2018.2.0 getPartName public String getPartName() This will return the canonical part name used within Vivado. For example: xcku060-ffva1156-2-e. Vivado Tcl: get_property PART [current_project] Returns: The part name with package and speed grade information and temperature (on UltraScale and above). Since: 2018.2.0 addModule public void addModule(Module module) Adds a module to the design, including copying the module's netlist into the current design's netlist (using EDIFNetlist.copyCellAndSubCells(com.xilinx.rapidwright.edif.EDIFCell)). Updates the implementation index accordingly. Parameters: module - The module to add. Since: 2018.2.0 addModuleImpls public void addModuleImpls(ModuleImpls modImpls) Adds a list of modules with different implementations (ModuleImpls) to preserve order Parameters: modImpls - The list of modules with different implementations Since: 2019.2.1 addSiteInst public void addSiteInst(SiteInst inst) Adds a site instance to the design. Useful when merging two implementations together. Also consider Design.createSiteInst(Site). Parameters: inst - The instance to add. Since: 2018.3.2 addNet public Net addNet(Net net) Attaches a net to the design by mapping the hierarchical name to the Net object. Useful when merging designs together. Also consider Design.createNet(String). Parameters: net - The net to add. Returns: The previously associated Net with the same name. Since: 2018.3.2 removeNet public Net removeNet(String name) Removes a net from the design Vivado Tcl: remove_net [get_nets $name] Parameters: name - The name of the net to remove. Returns: The removed net, or null if unsuccessful. Since: 2018.2.0 removeNet public Net removeNet(Net net) Removes a net from the design and associated routing. Vivado Tcl: remove_net $net Parameters: net - The net to remove from the design. Returns: The removed net, or null if unsuccessful. Since: 2018.2.0 movePinsToNewNetDeleteOldNet public void movePinsToNewNetDeleteOldNet(Net oldNet, Net newNet, boolean keepRouting) The method will take the pins on the oldNet and move them to the newNet. Finally, it will remove the oldNet from the design. Among both nets, there should be one or less source pins. Vivado Tcl: connect_net -net_object_list [get_pins -of $oldNet] -net $newNet;remove_net $oldNet Parameters: oldNet - Net to have pins moved to newNet and be deleted from design. newNet - Net to receive pins from oldNet. keepRouting - A flag indicating if any existing inter-site routing on the new net should be maintained. Since: 2018.2.0 removeSiteInst public boolean removeSiteInst(SiteInst instance) This method carefully removes an instance in a design with its pins and possibly nets. Nets are only removed if they are empty after removal of the instance's pins. This method CANNOT remove instances that are part of a ModuleInst. Vivado Tcl: foreach c [get_cells -of $site] {remove_cell $c} Parameters: instance - The instance in the design to remove. Returns: True if the operation was successful, false otherwise. Since: 2018.2.0 removeSiteInst public boolean removeSiteInst(SiteInst instance, boolean keepSitePinRouting) This method carefully removes an instance in a design with its pins and possibly nets. Nets are only removed if they are empty after removal of the instance's pins. This method CANNOT remove instances that are part of a ModuleInst. Parameters: instance - The instance in the design to remove. keepSitePinRouting - If true, all routing on nets connected to site pins will be kept. Returns: True if the operation was successful, false otherwise. Since: 2019.1.1 getModule public Module getModule(String name) Get a module by name. Get's the 0th implementation as a default. Parameters: name - The name of the module to get. Returns: The module called name, if it exists, null otherwise. Since: 2018.2.0 getModule public Module getModule(String name, int implementationIndex) Get's a specific implementation of a module Parameters: name - The name of the module to get implementationIndex - The implementation index within the design. Returns: The module implementation or null if none exists. Since: 2018.2.0 getSiteInst public SiteInst getSiteInst(String name) Get an instance by name. Parameters: name - Name of the instance to get. Returns: The instance name, or null if it does not exist. Since: 2018.2.0 getNet public Net getNet(String name) Get a net by name. Vivado Tcl: get_nets $name Parameters: name - Name of the net to get. Returns: The net name, or null if it does not exist. Since: 2018.2.0 getGndNet public Net getGndNet() Get the global ground net called Returns: The Net object called Since: 2018.2.0 getVccNet public Net getVccNet() Get the global power net called Returns: The Net object called Since: 2018.2.0 getStaticNet public Net getStaticNet(NetType type) Get the global static net or based on the NetType. Returns: If NetType == NetType.VCC if returns the power net, otherwise the ground net. Since: 2018.2.0 getSiteInsts public Collection<SiteInst> getSiteInsts() Gets and returns all of the instance in the design. Returns: All the instances of the design. Since: 2018.2.0 clearUsedSites public void clearUsedSites() Clears out all the used sites in the design. This will enable site insts to be 'unplaced' without destroying the objects. Since: 2018.2.0 getModules public Collection<ModuleImpls> getModules() Gets and returns all of the modules of the design. Returns: All the modules of the design. Since: 2018.2.0 getModuleNames public Set<String> getModuleNames() Get all module names Returns: Since: 2018.2.0 getNets public Collection<Net> getNets() Gets and returns all of the nets of the design. Vivado Tcl: get_nets -hierarchical Returns: The hash map of nets. Since: 2018.2.0 getDevice public Device getDevice() Gets the device specific to this part and returns it. Returns: The device specific to this part. Since: 2018.2.0 setName public void setName(String name) Sets the name of the design Parameters: name - New name for the design Since: 2021.2.1 setPartName public void setPartName(String partName) Sets the part name (see Part), for the design. Cannot change the part once it has already been set. Parameters: partName - Full Xilinx part name for the intended design. Since: 2018.2.0 getNetlist public EDIFNetlist getNetlist() Get the logical netlist object corresponding to this design. Returns: The logical netlist of this design. Since: 2018.2.0 setNetlist public void setNetlist(EDIFNetlist netlist) Sets the logical netlist for this design. Parameters: netlist - The netlist to apply to this design. Since: 2018.2.0 setNOCDesign public void setNOCDesign(NOCDesign nocDesign) Sets the NOC Design for this design Parameters: nocDesign - The new NOC Design Since: 2022.1.0 getNOCDesign public NOCDesign getNOCDesign() Gets the current NOC Design for this design Returns: Current NOC Design Since: 2022.1.0 getTopEDIFCell public EDIFCell getTopEDIFCell() Gets the top logical cell from the netlist. Returns: The top logical cell of the netlist, or null if none could be found. Since: 2018.2.0 unrouteDesign public void unrouteDesign() Unroutes the current design by removing all PIPs. Will leave internal site routes intact. Vivado Tcl: route_design -unroute Since: 2018.2.0 unplaceDesign public void unplaceDesign() Will unroute and unplace the design, no site information will be retained. Sites will also become unrouted. Vivado Tcl: place_design -unplace Since: 2018.2.0 flattenDesign public void flattenDesign() If there are any module instances in the design, this flattens them so there are no references to modules or module instances. Since: 2018.2.0 createSiteInst public SiteInst createSiteInst(String name, SiteTypeEnum type, Site placement) Creates a new site instance in the design. This essentially combines the constructor call in SiteInst and the Design.addSiteInst(SiteInst) methods into one command and checks for collisions in name and placement. Parameters: name - Name of the new site instance. type - The SiteType of the new site instance. placement - The desired placement of the new site instance. Returns: The site instance that is created in the design, or null if there was a problem (collision in placement or name). Since: 2018.3.1 createSiteInst public SiteInst createSiteInst(Site site) Convenience site instance creator for a given site. Defaults to the primary site type of the site. Parameters: site - The site instance name, type and placement to create. Returns: The newly create site instance. Throws a runtime exception if fails. Since: 2018.3.1 createSiteInst public SiteInst createSiteInst(String siteName) Convenience site instance creator for a given site. Defaults to the primary site type of the site. Parameters: siteName - The site name onto which this instance should be placed and named. Returns: The newly create site instance. Throws a runtime exception if fails. Since: 2018.3.1 createCell public Cell createCell(String instName, EDIFCell reference) Creates and adds a new cell instance to the top level of the design. The new cell instance will have the name instName and instantiates the EDIFCell reference. Vivado Tcl: create_cell -reference $reference $instName Parameters: instName - Name of the cell instance to create and add to the design at the top level. reference - The EDIFCell reference this cell should instantiate. This is generally a primitive cell. Returns: The newly created cell. Since: 2018.2.0 createCell public Cell createCell(String instName, Unisim unisim) Creates and adds a new cell instance to the top level of the design. The new cell instance will have the name instName and is created with the unisim type specified. Vivado Tcl: create_cell -reference $reference $instName Parameters: instName - Name of the cell instance to create and add to the design at the top level. unisim - The Unisim reference this cell should instantiate. This is generally a primitive cell. Returns: The newly created cell. Since: 2019.1.2 createCell public Cell createCell(String instName, EDIFCellInst instance) Creates a physical cell object from an existing logical cell instance in the netlist. This is necessary if the cell is not placed. Vivado Tcl: create_cell -reference $reference $instName Parameters: instName - Name of the existing cell. This method does not create a logical cell in the netlist, it should already exist. instance - The existing logical cell in the netlist. This is only used for setting the cell type, a reference to it is not stored in the cell. Returns: The newly created cell. Since: 2018.2.0 createAndPlaceCell public Cell createAndPlaceCell(String name, Unisim cellType, String location) Creates a new cell from scratch in the logical and physical netlists and places it at the location specified. The cell is added to the top level cell of the netlist. Vivado Tcl: create_cell -reference $cellType $name; place_cell $location Parameters: name - Name of the cell cellType - The Unisim library cell type location - The Vivado name of the site/BEL location (i.e. SLICE_X45Y42/AFF) Returns: The newly created cell or null if it could not be created or placed. Since: 2018.2.0 createAndPlaceCell public Cell createAndPlaceCell(String name, Unisim cellType, String location, String... params) Creates a new cell from scratch in the logical and physical netlists and places it at the location specified. The cell is added to the top level cell of the netlist. Vivado Tcl: create_cell -reference $cellType $name; place_cell $location Parameters: name - Name of the cell cellType - The Unisim library cell type location - The Vivado name of the site/BEL location (i.e. SLICE_X45Y42/AFF) params - Key=Value parameters to set on the cell during creation. Returns: The newly created cell or null if it could not be created or placed. Since: 2019.2.1 createAndPlaceCell public Cell createAndPlaceCell(EDIFCell parent, String name, Unisim cellType, String location) Creates a new cell from scratch in the logical and physical netlists and places it at the location specified. Vivado Tcl: current_instance $parent;create_cell -reference $cellType $name; place_cell $location Parameters: parent - The parent cell to which to add this cell name - Name of the cell cellType - The Unisim library cell type location - The Vivado name of the site/BEL location (i.e. SLICE_X45Y42/AFF) Returns: The newly created cell or null if it could not be created or placed. Since: 2018.2.0 createAndPlaceCell public Cell createAndPlaceCell(EDIFCell parent, String name, Unisim cellType, String location, String... params) Creates a new cell from scratch in the logical and physical netlists and places it at the location specified. Vivado Tcl: current_instance $parent;create_cell -reference $cellType $name; place_cell $location Parameters: parent - The parent cell to which to add this cell name - Name of the cell cellType - The Unisim library cell type location - The Vivado name of the site/BEL location (i.e. SLICE_X45Y42/AFF) params - Key=Value parameters to set on the cell during creation. Returns: The newly created cell or null if it could not be created or placed. Since: 2019.2.1 createAndPlaceCell public Cell createAndPlaceCell(EDIFCell parent, String name, Unisim cellType, Site site, BEL bel) Convenience function to create and place a new cell. Vivado Tcl: current_instance $parent;create_cell -reference $cellType $name; place_cell $site/$bel Parameters: parent - If set to null, the EDIFCellInst will not reference the netlist. name - Name of the cell cellType - The Unisim library cell site - The site onto which to place this cell bel - The BEL site onto which to place this cell Returns: the newly created cell. Since: 2018.2.0 createAndPlaceCell public Cell createAndPlaceCell(EDIFCell parent, String name, Unisim cellType, Site site, BEL bel, String... params) Convenience function to create and place a new cell. Vivado Tcl: current_instance $parent;create_cell -reference $cellType $name; place_cell $site/$bel Parameters: parent - If set to null, the EDIFCellInst will not reference the netlist. name - Name of the cell cellType - The Unisim library cell site - The site onto which to place this cell bel - The BEL site onto which to place this cell params - Key=Value parameters to set on the cell during creation. Returns: the newly created cell. Since: 2019.2.1 createAndPlaceIOB public Cell createAndPlaceIOB(String name, PinType dir, String pkgPin, String ioStandard) Creates either an IBUF or OBUF in the netlist and places according to the provided package pin. Does not support IOBUF. Adds IO at the top level of the design and creates a top level port of the provided name (if it doesn't already exist). Vivado Tcl: create_cell -reference IBUF/OBUF $name; set_property PACKAGE_PIN $pkgPin [get_ports $name];set_property IOSTANDARD $ioStandard [get_ports $name] Parameters: name - Name of the IO buffer and port it connects to. dir - Is it an input or output pin (inout is not supported). pkgPin - The letter/number package pin name on the device. ioStandard - The voltage standard to assign to the IO. Returns: The freshly created IOB cell added/placed in the design. Since: 2018.2.0 createAndPlaceIOB public Cell createAndPlaceIOB(String name, PinType dir, String pkgPin, String ioStandard, Net portNet, EDIFNet logNet) Creates either an IBUF or OBUF in the netlist and places according to the provided package pin. Does not support IOBUF. Adds IO at the top level of the design and creates a top level port of the provided name (if it doesn't already exist) and connects it to the appropriate pin in the netlist (doesn't route the net). Vivado Tcl: create_cell -reference IBUF/OBUF $name; set_property PACKAGE_PIN $pkgPin [get_ports $name];set_property IOSTANDARD $ioStandard [get_ports $name] Parameters: name - Name of the IO buffer and port it connects to. dir - Is it an input or output pin (inout is not supported). pkgPin - The letter/number package pin name on the device. ioStandard - The voltage standard to assign to the IO. portNet - Physical net to connect from IO to fabric logNet - Logical net that connects from IO to fabric Returns: The freshly created IOB cell added/placed in the design. Since: 2018.2.3 placeIOB public Cell placeIOB(EDIFCellInst bufInst, String pkgPin, String ioStandard) Places an existing IBUF or OBUF in the netlist according to the provided package pin. Does not support IOBUF. Assumes IO at the top level of the design already exists. Vivado Tcl: set_property PACKAGE_PIN $pkgPin [get_ports $name];set_property IOSTANDARD $ioStandard [get_ports $name] Parameters: bufInst - Existing IBUF or OBUF instance in the netlist (note for IBUF, this is not the leaf-level cell, but the hierarchical parent). pkgPin - The letter/number package pin name on the device. ioStandard - The voltage standard to assign to the IO. Returns: The freshly created IOB cell added/placed in the design. Since: 2018.2.3 createUnisimInst public static EDIFCellInst createUnisimInst(EDIFCell parent, String name, Unisim cellType) Create a unisim EDIF cell instance. Creates a leaf cell instance from the Unisim library without creating a Cell object. Parameters: parent - The parent cell of the instance name - Name of the instance cellType - The Unisim type Returns: The new instance. Since: 2018.2.0 getUnisimCell public static EDIFCell getUnisimCell(Unisim cell) Gets the Unisim primitive cell. Vivado Tcl: get_primitives -filter NAME==$cell Parameters: cell - The cell type to get Returns: A cell of the Unisim type provided. Since: 2018.2.0 createBUFGCE public Cell createBUFGCE(EDIFCell parent, String name, Site location) Creates a new BUFGCE instance in the parent cell provided and places it at location. It will automatically connect the CE pin to VCC. Vivado Tcl: set c [create_cell -reference BUFGCE $name]; place_cell $c $location Parameters: parent - The parent cell (logical netlist EDIF) to which this BUFGCE instance belongs. name - Name of the BUGFGCE instance. location - The site on the device to place this BUFGCE. Returns: The newly created cell. Since: 2018.2.0 createIBUFDS public EDIFCellInst createIBUFDS(String portNameP, String portNameN, Site siteP, Site siteN, Net portNet, EDIFNet logNet, String ioStandard) This method will create a generic IBUFDS instance (DIFFINBUF+IBUFCTRL) at the top level of a design. Vivado Tcl: set c [create_cell -reference IBUFDS $name]; place_cell $c $location Parameters: portNameP - Positive Name of the port at the top level portNameN - Negative Name of the port at the top level siteP - Positive IO site to place the IBUFDS siteN - Negative IO site to place the IBUFDS portNet - Physical net of the port logNet - Logical net of the port ioStandard - IO standard to configure the IBUF Returns: The cell instance of the IBUF with INBUF and IBUFCTRL as children Since: 2018.2.0 createNet public Net createNet(EDIFHierNet net) Creates a physical net from a logical hierarchical net. Vivado Tcl: create_net $net Parameters: net - The logical hierarchical net from which to create the net from. Returns: The newly created physical net. Since: 2022.1.2 createNet public Net createNet(String netName) Creates both the logical and physical net objects for the given name. The logical net (EDIFNet can be accessed by Net.getLogicalNet(). Vivado Tcl: create_net $netName Parameters: netName - Full hierarchical name of the net to create. Returns: The newly created physical net Since: 2018.2.0 placeCell public boolean placeCell(Cell c, Site site, BEL bel) This is a limited checking placement method for placing a cell on a BEL site. The rule set is somewhat complicated to place a cell into a site and this function does not address many of those rules. The caller is responsible for checking/updating appropriate pin mappings from cell pins to BEL site pins. Only a generic set of pin mappings is provided via the UnisimManager. Vivado Tcl: place_cell $c $site/$bel Parameters: c - The cell to be placed. site - The site containing the BEL to be placed. bel - The BEL site onto which the cell placement is attempted. Returns: True if the placement was successful, false otherwise. Since: 2018.2.0 placeCell public boolean placeCell(Cell c, Site site, BEL bel, Map<String,String> pinMappings) This is a limited checking placement method for placing a cell on a BEL site. The rule set is somewhat complicated to place a cell into a site and this function does not address many of those rules. The caller is responsible for providing pinMappings. Vivado Tcl: place_cell $c $site/$bel;set_property LOCK_PINS $pinMappings $c Parameters: c - The cell to be placed. site - The site containing the BEL to be placed. bel - The BEL site onto which the cell placement is attempted. pinMappings - The physical to logical pin mappings for the cell. Returns: True if placement was successful, false otherwise. Since: 2018.2.0 copyCell public Cell copyCell(Cell c, String instName) Copies the cell c into this design (c should originate from a different design). The new cell will have the same attributes, library entry and placement Parameters: c - The prototype cell from a different design to copy. instName - Returns: the newly copied cell Since: 2018.2.0 addCell public Cell addCell(Cell c) Adds the cell to the design. Specifically, it maps the cell to its hierarchical name in the design. Does not update SiteInst. Also consider Design.createCell(String, EDIFCellInst) or Design.createAndPlaceCell(EDIFCell, String, Unisim, Site, BEL) or their variants. Parameters: c - The cell to add. Returns: The previous cell of the same name, or null if it is unique. Since: 2018.3.2 getCell public Cell getCell(String name) Gets a cell by name from the instance Parameters: name - The name of the cell to get Returns: The cell, or null if none exists Since: 2018.2.0 removeCell public Cell removeCell(String name) Removes the cell by its hierarchical name. It doesn't remove the logical cell (EDIFCellInst). Parameters: name - Hierarchical name of the cell. Returns: The removed cell or null if none found. Since: 2018.2.0 removeCell public Cell removeCell(Cell c) Removes the cell of the same name Parameters: c - The cell to remove, or a cell with the same name to remove Returns: The removed cell, or null if not found Since: 2018.2.0 getCells public Collection<Cell> getCells() Gets all the cells in the design (unlike @link{SiteInst#getCells()}, routethrus are not included) Vivado Tcl: get_cells Returns: A collection of all cells in the design Since: 2018.2.0 getMacroPrimitives public static EDIFLibrary getMacroPrimitives(Series s) Gets the logical (EDIF) representation of the macro primitives supported by this architecture. Parameters: s - The architectural series from which to get the macro primitives Returns: The library of all macro primitives for a given series. Since: 2019.1.2 getPrimitivesLibrary public static EDIFLibrary getPrimitivesLibrary() Gets the set of all unisim primitives as an EDIF library. Returns: The set of all unisim primitives Since: 2020.1.3 getPrimitivesLibrary public static EDIFLibrary getPrimitivesLibrary(String deviceName) Gets the set of compatible unisim primitives for the specified device as an EDIF Library. Parameters: deviceName - The name of the device from which to get the compatible primitives Returns: An EDIFLibrary with all compatible unisim primitives for the specified device Since: 2020.1.5 getDefaultProperty public static VivadoProp getDefaultProperty(Series series, String cellTypeName, String propName) Gets the default property (type and value) for the specified cell and property name. Parameters: series - Series to which the cell targets cellTypeName - Name of the cell type (often Unisims) propName - Name of the property attached to the cell Returns: The default Vivado property containing both type and value Since: 2020.1.3 getDefaultCellProperties public static Map<String,VivadoProp> getDefaultCellProperties(Series series, String cellTypeName) Returns a map of all default cell properties for the specified cell. Parameters: series - Target series of the cell celTypeName - Name of the cell type (often a Unisim) Returns: A map between property names and their value/type object. Since: 2020.1.3 getXDCConstraints public List<String> getXDCConstraints(ConstraintGroup cg) Gets a list of strings that correspond to lines of an XDC file for the design. Parameters: cg - The specific constraint group from which to get XDC constraints. Returns: List of strings of XDC commands Since: 2018.2.0 setXDCConstraints public List<String> setXDCConstraints(List<String> xdc, ConstraintGroup cg) Sets (overwrites) the XDC commands for this design with those provided. Parameters: xdc - New XDC commands to use for this design cg - The constraint group to set. Returns: Any previous XDC commands in the given constraint group. Since: 2018.2.0 addXDCConstraint public void addXDCConstraint(String... xdc) Adds the XDC command to the list of (Normal, see ConstraintGroup) XDC commands for this design. Parameters: xdc - One or more of the XDC command to be added Since: 2018.2.0 addXDCConstraint public void addXDCConstraint(ConstraintGroup cg, String... xdc) Adds the XDC command(s) to the list of the provided ConstraintGroup. Parameters: cg - The constraint group to which the XDC command should be added. xdc - One or more of the XDC command to be added Since: 2018.2.0 addPartitionPin public boolean addPartitionPin(PartitionPin pin) Adds a partition pin to this design Parameters: pin - The pin to add Returns: True if the pin was added correctly, false otherwise Since: 2022.1.3 removePartitionPin public boolean removePartitionPin(PartitionPin pin) Removes a partition pin from this design Parameters: pin - The pin to remove Returns: True if the pin was removed successfully, false otherwise. Since: 2022.1.3 getPartitionPins public List<PartitionPin> getPartitionPins() Gets the partition pins associated with this design Returns: the partitionPins in this design Since: 2022.1.3 createPartitionPin public PartitionPin createPartitionPin(EDIFHierPortInst pin, Node node) Creates a new partition pin and adds it to the design Parameters: pin - The hierarchical port instance as the logical reference of the pin node - The physical reference point on the device for the pin Returns: The newly created partition pin Since: 2022.1.3 createPartitionPin public PartitionPin createPartitionPin(EDIFPort port, int index, Node node) Creates a new partition pin from a top cell port and adds it to the design Parameters: port - The top cell port index - The index within the port if bussed node - The node to target Returns: The newly created partition pin Since: 2022.1.3 createPartitionPin public PartitionPin createPartitionPin(EDIFPort port, Node node) Creates a new partition pin from a top cell port and adds it to the design Parameters: port - The top cell port node - The node to target Returns: The newly created partition pin Since: 2022.1.3 copyPartitionPins public void copyPartitionPins(Design source, ModuleInst dest, Map<EDIFPort,EDIFPort> portMap) Copy PartitionPins from a design to its ModuleInst in this design. Parameters: source - The Design object used to create a ModuleInst in this Design. dest - The ModuleInst in this Design. portMap - Map of ports to have their partition pins copied from the source design to dest design. Since: 2020.1.0 trimPartitionPins public void trimPartitionPins(Pair<Tile,Tile> range) Remove excess routing from all Partition pins beyond the first node within a tile range. Parameters: range - A pair of tiles representing opposite corners of the routing range. Since: 2020.1.0 toString public String toString() Overrides: toString in class Object setAutoIOBuffers public void setAutoIOBuffers(boolean val) Updates the design such that if a DCP is created and read into Vivado, if it is to automatically instantiate I/Os for top level ports not already connected to I/Os. This is commonly used in out-of-context DCPs. Parameters: val - Set to true (default) to automatically instantiate I/Os when the design is loaded in Vivado, false to disable this behavior. Since: 2018.2.0 isAutoIOBuffersSet public boolean isAutoIOBuffersSet() Checks the setting on this design for its behavior related auto I/O buffer instantiation when the design is loaded in Vivado. Returns: True if Auto IO Buffers is enabled, false otherwise. Since: 2018.2.0 isDesignOutOfContext public boolean isDesignOutOfContext() Checks if the design is labeled as an out-of-context design for Vivado. Returns: True if design is marked out of context, false otherwise. Since: 2018.2.0 setDesignOutOfContext public void setDesignOutOfContext(boolean val) Updates the design to be set or unset as out of context for Vivado. Parameters: val - True to make the design labeled as out of context, false to be unlabeled out-of-context. Since: 2018.2.0 routeSites public void routeSites() Iterates through all non-empty site instances and invokes the routeSite() method on each one. Vivado Tcl: route_design Since: 2018.2.0 unrouteSites public void unrouteSites() Removes all site routing from all instantiated sites in the design. Since: 2022.1.3 placeCells public boolean placeCells(Map<String,String> desiredCellPlacements) Places a set of cells according to the map provided. Attempts to 'route' the touched sites after all placements are made (still WIP). Vivado Tcl: place_cells $desiredCellPlacements Parameters: desiredCellPlacements - Map of cell placements where the key is full hierarchical name of the cell and value is the full bel site name (ex: SLICE_X0Y0/AFF). Returns: True if all placements succeeded, false otherwise Since: 2018.2.0 clearTrackedChanges public void clearTrackedChanges() Clears (empties) all tracked sets (logical cells, SiteInsts and Nets) Since: 2022.1.0 setTrackingChanges public void setTrackingChanges(boolean trackChanges) Global design setting that enables or disable tracking of modified EDIFCells, SiteInsts and physical Nets. See EDIFNetlist.isTrackingCellChanges(), Design.isTrackingNetChanges(), Design.isTrackingNetChanges() Parameters: trackChanges - True to begin tracking changes, false to stop tracking changes Since: 2022.1.0 isTrackingSiteInstChanges public boolean isTrackingSiteInstChanges() Checks a flag indicating if this design is currently tracking changes to its SiteInsts. Modified SiteInsts are tracked in a set which can be queried with Design.getModifiedSiteInsts(). SiteInsts are determined as modified if (1) a mapping between a Net and SiteWire has changed, (2) the status of a SitePIP has changed, or (3) a cell has been placed or unplaced on a BEL corresponding to the site where this SiteInst is placed. Returns: True if this design is tracking SiteInsts, false otherwise. Since: 2022.1.0 setTrackSiteInstChanges public void setTrackSiteInstChanges(boolean trackSiteInstChanges) Flag to track changes to SiteInst in this design. See Design.isTrackingSiteInstChanges() Parameters: trackSiteInstChanges - True to enable tracking of SiteInsts, false to stop tracking Since: 2022.1.0 isTrackingNetChanges public boolean isTrackingNetChanges() Checks a flag indicating if this design is currently tracking changes to its Nets. Modified Nets are tracked in a set which can be queried with Design.getModifiedNets(). Nets are determined as modified if the PIPs on the net change, including if a PIP is set as fixed or not. Returns: True if this design is tracking Nets, false otherwise. Since: 2022.1.0 isCopyingOriginalNetsRouting public boolean isCopyingOriginalNetsRouting() Gets and returns the flag indicating if the design is keeping a copy of a net's PIPs before it is modified. See also Design.setCopyingOriginalNetsRouting(boolean). Returns: True if the design is copying a net's PIPs before they are modified, False otherwise. Since: 2023.1.3 setCopyingOriginalNetsRouting public void setCopyingOriginalNetsRouting(boolean copyOrigNets) Sets the flag indicating if the design is to keep a copy of a net's routing before it is modified. See also Design.isCopyingOriginalNetsRouting() Parameters: copyOrigNets - The desired value of the flag Since: 2023.1.3 getOriginalNetRouting public Map<String,List<PIP>> getOriginalNetRouting() Gets a map of all the original net routing PIPs of nets that have been modified since Design.isCopyingOriginalNetsRouting() returns true. Returns: A map keyed by the net name and the value being a list of PIPs of the net prior to being modified. Since: 2023.1.3 isCopyingOriginalSiteInsts public boolean isCopyingOriginalSiteInsts() Gets and returns the flag indicating if the design is keeping a copy of a SiteInst before it is modified. See also Design.setCopyingOriginalSiteInsts(boolean). Returns: True if the design is copying a SiteInst before it is modified, False otherwise. Since: 2023.1.3 setCopyingOriginalSiteInsts public void setCopyingOriginalSiteInsts(boolean copyOrigSiteInsts) Sets the flag indicating if the design is to keep a copy of a net's routing before it is modified. See also Design.isCopyingOriginalNetsRouting() Parameters: copyOrigSiteInsts - The desired value of the flag Since: 2023.1.3 getOriginalSiteInsts public Map<String,SiteInst> getOriginalSiteInsts() Gets a map of all the original SiteInst objects that have been modified since Design.isCopyingOriginalSiteInsts() returns true. Returns: A map keyed by the site inst name and the value is the copy of the SiteInst prior to being modified. Since: 2023.1.3 setTrackNetChanges public void setTrackNetChanges(boolean trackNetChanges) Flag to track changes to Nets in this design. See Design.isTrackingNetChanges() Parameters: trackNetChanges - True to enable tracking of Nets, false to stop tracking Since: 2022.1.0 getModifiedSiteInsts public Set<SiteInst> getModifiedSiteInsts() Gets the set of modified SiteInsts for this design. These are accumulated when changes are made to a SiteInst and Design.isTrackingSiteInstChanges() returns true. Returns: The set of modified SiteInsts Since: 2022.1.0 getModifiedNets public Set<Net> getModifiedNets() Gets the set of modified Nets for this design. These are accumulated when changes are made to a Net and Design.isTrackingNetChanges() returns true. Returns: The set of modified Nets Since: 2022.1.0 addModifiedNet public boolean addModifiedNet(Net net) Adds the Net to the set of modified Nets for this design. Parameters: net - The net to add Returns: True if the net was added to the set, false if the net was already in the set. Since: 2022.1.0 addModifiedSiteInst public boolean addModifiedSiteInst(SiteInst siteInst) Adds the SiteInst to the set of modified SiteInsts for this design. Parameters: siteInst - The siteInst to add Returns: True if the siteInst was added to the set, false if the siteInst was already in the set. Since: 2022.1.0 addManuallyRoutedSite public void addManuallyRoutedSite(String siteName) getManuallyRoutedSites public Set<String> getManuallyRoutedSites() detachNetlist public void detachNetlist() Removes all references to the EDIFNetlist. Since: 2022.1.4 detachNetlist public void detachNetlist(Predicate<Cell> preserveCellProperties) Removes all references to the EDIFNetlist. Parameters: preserveCellProperties - Predicate lambda to decide which Cell objects (from Design.getSiteInsts(), Design.getModifiedSiteInsts(), and Design.getOriginalSiteInsts()) should have their EDIFHierCellInst properties (accessible through Cell.getProperty(String)) preserved. Set to null to not preserve any properties. Since: 2023.2.2 getBELAttrs public Map<Site,SiteConfig> getBELAttrs() Get the BEL attribute mappings for this design Returns: A map of the BEL attribute mappings of this design Since: 2022.2.1 addBELAttr public BELAttr addBELAttr(Net net, Site site, SiteTypeEnum type, BEL bel, String name, String value) Adds a BEL attribute on the net provided Parameters: net - The net associated with the BEL attribute site - The site where the BEL attribute resides type - The selected site type of the site where the BEL attribute resides bel - The BEL to annotate with the attribute name - The name of the attribute value - The value of the attribute Returns: The old value associated with the named attribute or null if no previous value existed. Since: 2022.2.1 retargetPart public boolean retargetPart(Part targetPart, int tileXOffset, int tileYOffset) Changes the current target part to another compatible part and updates all device-related references accordingly. If the target part doesn't have compatible placement and/or routing, the incompatible portion of the implementation will be removed. If this design uses the NOC (Versal) or contains modules or module instances, it will not attempt to retarget and will return false. Parameters: targetPart - The new target part for this design. tileXOffset - The offset in tile X coordinate of the destination implementation tileYOffset - The offset in tile Y coordinate of the destination implementation Returns: True if the retargeting operation was successful, false otherwise. Since: 2024.1.3

Class Design

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

RW_AUTO_GENERATE_READABLE_EDIF

Constructor Detail

Design

Design

Design

Method Detail

isAutoGenerateReadableEdif

setAutoGenerateReadableEdif

readEdifAndXdefInParallel

setReadEdifAndXdefInParallel

readCheckpoint

readCheckpoint

readCheckpoint

readCheckpoint

readCheckpoint

readCheckpoint

readCheckpoint

readCheckpoint

readCheckpoint

readCheckpoint

readCheckpoint

writeCheckpoint

writeCheckpoint

writeCheckpoint

writeCheckpoint

writeCheckpoint

writeCheckpoint

updateDesignWithCheckpointPlaceAndRoute

updateDesignWithCheckpointPlaceAndRoute

getPartNameFromDCP

getPartNameFromDCP

replaceEDIFinDCP

replaceEDIFinDCP

getPart

getSeries

isSiteUsed

getSiteInstFromSite

getSiteInstFromSiteName

getModuleInst

addModuleInstNetlist

repopulateNetlistOfModuleInst

repopulateNetlistOfModuleInst

createOrFindEDIFCellInst

createModuleInst

createModuleInst

renameSiteInst

getName

getModuleInsts

getModuleInstMap

getPartName

addModule

addModuleImpls

addSiteInst

addNet

removeNet

removeNet

movePinsToNewNetDeleteOldNet

removeSiteInst

removeSiteInst

getModule

getModule

getSiteInst

getNet

getGndNet

getVccNet

getStaticNet

getSiteInsts

clearUsedSites

getModules

getModuleNames

getNets

getDevice

setName

setPartName