com.xilinx.rapidwright.eco

Class ECOTools

Object

com.xilinx.rapidwright.eco.ECOTools

public class ECOTools
extends Object

A collection of methods for performing ECO operations. NOTE: These methods assume the EDIF (logical) netlist is unfolded. A folded netlist containing two instances of the 'foo' cell with instances names 'u1' and 'u2' would have the following hierarchy: 'top/u1(foo)' and 'top/u2(foo)'. Further, assume that 'foo' contains two leaf cell instances 'lut1' and 'lut2' for a total of four leaf cells in the netlist. Modifying (e.g. connecting, disconnecting, removing, etc.) instance 'top/u1(foo)/lut1' would cause the 'lut1' instance from cell 'foo' to be modified, which would have the un-obvious effect of also modifying 'top/u2(foo)/lut1' from the netlist too. With an unfolded netlist, the 'foo' cell would be expected to be replaced by two (identical) cells 'foo1' and 'foo2', each instantiated once. Here, modifying 'top/u1(foo1)/lut1' would no longer affect 'top/u2(foo2)/lut1'.

Constructor Summary

Constructors

Constructor and Description
ECOTools()

Method Summary

Modifier and Type	Method and Description
static void	connectNet(Design d, Cell cell, String logPin, Net net) Convenience wrapper method to connectNet() that allows for minimal specification of a single connection to be made.
static void	connectNet(Design design, List<String> netPinList) Given a list of strings containing one net path followed by one or more pin paths separated by spaces (in line with Tcl convention) connect the latter pins to the former net.
static void	connectNet(Design design, List<String> netPinList, Map<Net,Set<SitePinInst>> deferredRemovals) Given a list of strings containing one net path followed by one or more pin paths separated by spaces (in line with Tcl convention) connect the latter pins to the former net.
static void	connectNet(Design design, Map<EDIFHierNet,List<EDIFHierPortInst>> netToPortInsts, Map<Net,Set<SitePinInst>> deferredRemovals) Given a map of EDIFHierNet to list of EDIFHierPortInst object(s), connect the latter pins to the former net.
static Cell	createAndPlaceInlineCellOnInputPin(Design design, EDIFHierPortInst input, Unisim reference, Site site, BEL bel, String logInput, String logOutput) Creates and places a new primitive cell inline from the existing net driving the input pin provided and connects its output to the existing input.
static void	createCell(Design design, EDIFCell reference, List<String> paths) Given a EDIFCell object and a list of instance paths, create these cell instantiations in the design.
static SitePinInst	createExitSitePinInst(Design design, EDIFHierPortInst ehpi, Net net) Creates a new SitePinInst source or sink for the physical net provided.
static void	createNet(Design design, List<String> paths) Given list of net paths, create these nets in the design.
static void	disconnectNet(Design design, EDIFHierPortInst... pins) Given a list of EDIFHierPortInst objects, disconnect these pins from their current nets.
static void	disconnectNet(Design design, List<EDIFHierPortInst> pins) Given a list of EDIFHierPortInst objects, disconnect these pins from their current nets.
static void	disconnectNet(Design design, List<EDIFHierPortInst> pins, Map<Net,Set<SitePinInst>> deferredRemovals) Given a list of EDIFHierPortInst objects, disconnect these pins from their current nets.
static void	disconnectNetPath(Design design, List<String> pins) Given a list of strings with one more space-separated pins, disconnect these pins from their current nets.
static void	disconnectNetPath(Design design, List<String> pins, Map<Net,Set<SitePinInst>> deferredRemovals) Given a list of strings with one more space-separated pins, disconnect these pins from their current nets.
static void	removeCell(Design design, List<EDIFHierCellInst> insts, Map<Net,Set<SitePinInst>> deferredRemovals) Given a list of EDIFHierCellInst objects, remove these cell instances from the design.
static void	removeCellPath(Design design, List<String> paths, Map<Net,Set<SitePinInst>> deferredRemovals) Given a list of strings containing the hierarchical path to cell instances, remove these instances from the design.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ECOTools

public ECOTools()

Method Detail

disconnectNet

public static void disconnectNet(Design design,
                                 EDIFHierPortInst... pins)

Given a list of EDIFHierPortInst objects, disconnect these pins from their current nets. This method modifies the EDIF (logical) netlist as well as the place-and-route (physical) state, and is modelled on Vivado's disconnect_net -pinlist command.

Parameters:

design - The design where the pin(s) are instantiated.

pins - A variable array of hierarchical pins for disconnection.

disconnectNet

public static void disconnectNet(Design design,
                                 List<EDIFHierPortInst> pins)

Given a list of EDIFHierPortInst objects, disconnect these pins from their current nets. This method modifies the EDIF (logical) netlist as well as the place-and-route (physical) state, and is modelled on Vivado's disconnect_net -pinlist command.

Parameters:

design - The design where the pin(s) are instantiated.

pins - A list of hierarchical pins for disconnection.

disconnectNet

public static void disconnectNet(Design design,
                                 List<EDIFHierPortInst> pins,
                                 Map<Net,Set<SitePinInst>> deferredRemovals)

Given a list of EDIFHierPortInst objects, disconnect these pins from their current nets. This method modifies the EDIF (logical) netlist as well as the place-and-route (physical) state, and is modelled on Vivado's disconnect_net -pinlist command.

Parameters:

design - The design where the pin(s) are instantiated.

pins - A list of hierarchical pins for disconnection.

deferredRemovals - An optional map that, if passed in non-null will be populated with site pins marked for removal. The map allows for persistent tracking if this method is called many times as the process is expensive without batching. This map can also allow SitePinInst objects to be reused by ECOTools.connectNet(Design, Map, Map).

disconnectNetPath

public static void disconnectNetPath(Design design,
                                     List<String> pins)

Given a list of strings with one more space-separated pins, disconnect these pins from their current nets. This method modifies the EDIF (logical) netlist as well as the place-and-route (physical) state, and is modelled on Vivado's disconnect_net -pinlist command.

Parameters:

design - The design where the pin(s) are instantiated.

pins - A list of hierarchical pins for disconnection.

disconnectNetPath

public static void disconnectNetPath(Design design,
                                     List<String> pins,
                                     Map<Net,Set<SitePinInst>> deferredRemovals)

Given a list of strings with one more space-separated pins, disconnect these pins from their current nets. This method modifies the EDIF (logical) netlist as well as the place-and-route (physical) state, and is modelled on Vivado's disconnect_net -pinlist command.

Parameters:

design - The design where the pin(s) are instantiated.

pins - A list of hierarchical pins for disconnection.

deferredRemovals - An optional map that, if passed in non-null will be populated with site pins marked for removal. The map allows for persistent tracking if this method is called many times as the process is expensive without batching. This map can also allow SitePinInst objects to be reused by ECOTools.connectNet(Design, Map, Map).

connectNet

public static void connectNet(Design design,
                              Map<EDIFHierNet,List<EDIFHierPortInst>> netToPortInsts,
                              Map<Net,Set<SitePinInst>> deferredRemovals)

Given a map of EDIFHierNet to list of EDIFHierPortInst object(s), connect the latter pins to the former net. This method modifies the EDIF (logical) netlist as well as the place-and-route (physical) state, and is modelled on Vivado's connect_net -hier -net_object_list command.

Parameters:

design - The design where the net(s) and pin(s) are instantiated.

netToPortInsts - A map of hierarchical nets and pins for connection.

deferredRemovals - An optional map that, if passed in non-null will allow any SitePinInst objects deferred previously for removal to be reused for new connections. See ECOTools.disconnectNet(Design, List, Map). By default, this method will throw a RuntimeException if there is a mismatch between the net connected to logical pins (EDIFHierPortInst) and the net connected to its physical pin (SitePinInst). The Java property "rapidwright.ecotools.connectNet.warnIfCellInstStartsWith" allows such pins with an EDIFCellInst name that start with its value to be demoted from an RuntimeException to a printed warning. An example use case for this feature would be if it is known that the conflicting logical pin will be removed later.

connectNet

public static void connectNet(Design d,
                              Cell cell,
                              String logPin,
                              Net net)

Convenience wrapper method to connectNet() that allows for minimal specification of a single connection to be made.

Parameters:

d - The design where the net exists.

cell - The cell on which the pin to be connected exists

logPin - The logical name on the cell to connect

net - The physical net to connect the logical pin to

connectNet

public static void connectNet(Design design,
                              List<String> netPinList)

Given a list of strings containing one net path followed by one or more pin paths separated by spaces (in line with Tcl convention) connect the latter pins to the former net. This method modifies the EDIF (logical) netlist as well as the place-and-route (physical) state, and is modelled on Vivado's connect_net -hier -net_object_list command.

Parameters:

design - The design where the net(s) and pin(s) are instantiated.

netPinList - A list of strings containing net and pin paths.

connectNet

public static void connectNet(Design design,
                              List<String> netPinList,
                              Map<Net,Set<SitePinInst>> deferredRemovals)

Given a list of strings containing one net path followed by one or more pin paths separated by spaces (in line with Tcl convention) connect the latter pins to the former net. This method modifies the EDIF (logical) netlist as well as the place-and-route (physical) state, and is modelled on Vivado's connect_net -hier -net_object_list command.

Parameters:

design - The design where the net(s) and pin(s) are instantiated.

netPinList - A list of strings containing net and pin paths.

deferredRemovals - An optional map that, if passed in non-null will allow any SitePinInst objects deferred previously for removal to be reused for new connections. See ECOTools.disconnectNet(Design, List, Map).

createExitSitePinInst

public static SitePinInst createExitSitePinInst(Design design,
                                                EDIFHierPortInst ehpi,
                                                Net net)

Creates a new SitePinInst source or sink for the physical net provided. It will route out an EDIFHierPortInst input/output pin to a corresponding SitePinInst.

Parameters:

design - The current design.

ehpi - The hierarchical pin.

net - The net to add the new SitePinInst to.

Returns:

The newly created SitePinInst.

removeCell

public static void removeCell(Design design,
                              List<EDIFHierCellInst> insts,
                              Map<Net,Set<SitePinInst>> deferredRemovals)

Given a list of EDIFHierCellInst objects, remove these cell instances from the design. This method removes and disconnects cells from the EDIF (logical) netlist as well as the place-and-route (physical) state, and is modelled on Vivado's remove_cell command.

Parameters:

design - The current design.

insts - A list of hierarchical cell instances for removal.

deferredRemovals - An optional map that, if passed in non-null will be populated with site pins marked for removal. The map allows for persistent tracking if this method is called many times as the process is expensive without batching.

removeCellPath

public static void removeCellPath(Design design,
                                  List<String> paths,
                                  Map<Net,Set<SitePinInst>> deferredRemovals)

Given a list of strings containing the hierarchical path to cell instances, remove these instances from the design. This method removes and disconnects cells from the EDIF (logical) netlist as well as the place-and-route (physical) state, and is modelled on Vivado's remove_cell command.

Parameters:

design - The current design.

paths - A list of instance paths for removal.

deferredRemovals - An optional map that, if passed in non-null will be populated with site pins marked for removal. The map allows for persistent tracking if this method is called many times as the process is expensive without batching.

createCell

public static void createCell(Design design,
                              EDIFCell reference,
                              List<String> paths)

Given a EDIFCell object and a list of instance paths, create these cell instantiations in the design. This method inserts cells in the EDIF (logical) netlist as well as corresponding leaf cells into the physical state (unplaced), and is modelled on Vivado's create_cell command.

Parameters:

design - The current design.

reference - The cell to be instantiated.

paths - A list of instance paths for creation.

createAndPlaceInlineCellOnInputPin

public static Cell createAndPlaceInlineCellOnInputPin(Design design,
                                                      EDIFHierPortInst input,
                                                      Unisim reference,
                                                      Site site,
                                                      BEL bel,
                                                      String logInput,
                                                      String logOutput)

Creates and places a new primitive cell inline from the existing net driving the input pin provided and connects its output to the existing input. The cell will be created as a sibling to the instance of the provided input pin and will be named with the prefix 'inline_insertion_'. For example, if input is 'FF/D' and reference is a LUT1, this will create a new cell instance of type LUT1 where its input 'I0' will replace the connection 'D' on 'FF' and a new net will be created that will connect 'LUT1/O' to 'FF/D'. This is useful for scenarios like inserting a LUT1 inline when routethru instances are not possible.

Parameters:

design - The existing design.

input - The reference logical input pin on which the new inline cell should be created and connected.

reference - The primitive cell type to create.

site - The site on which the new cell should be placed.

bel - The BEL within the provided site onto which the cell should be placed.

logInput - The logical cell's input pin that should connect to the existing input's net.

logOutput - The logical cell's output pin that should connect to the existing input.

Returns:

A hierarchical reference to the newly created cell instance.

createNet

public static void createNet(Design design,
                             List<String> paths)

Given list of net paths, create these nets in the design. This method inserts nets into the EDIF (logical) netlist as well as corresponding nets into the physical state (unplaced), and is modelled on Vivado's create_net command.

Parameters:

design - The current design.

paths - A list of net paths for creation.