com.xilinx.rapidwright.design.tools

Class InlineFlopTools

Object

com.xilinx.rapidwright.design.tools.InlineFlopTools

public class InlineFlopTools
extends Object

Set of tools to add/remove flip flops inline to top level port connections. This is targeted at kernel replication preparation prior to routing to ensure that connections are routed outside of the pblock of the out-of-context kernel.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INLINE_SUFFIX

Constructor Summary

Constructors

Constructor and Description
InlineFlopTools()

Method Summary

Modifier and Type	Method and Description
static Cell	createAndPlaceFlopInlineOnTopPortInst(Design design, EDIFPortInst portInst, Pair<Site,BEL> loc, EDIFHierNet clk) Add flip-flop inline on the specified top-level port of an out-of-context design.
static void	createAndPlaceFlopsInlineOnTopPortsArbitrarily(Design design, String clkNet, PBlock keepOut) Add flip-flops inline on all the top-level ports of an out-of-context design.
static void	createAndPlaceFlopsInlineOnTopPortsNearPins(Design design, String clkNet, PBlock keepOut) Add flip-flops inline on all the top-level ports of an out-of-context design.
static void	createAndPlacePortFlopsOnSide(Design design, String clkNet, PBlock keepOut, Map<EDIFPort,PBlockSide> portSideMap) Add flip-flops inline on all the top-level ports of an out-of-context design.
static void	main(String[] args)
static Map<EDIFPort,PBlockSide>	parseSideMap(EDIFNetlist netlist, String filename) Parses the PBlock side map into a map from EDIFPorts to PBlockSide enums.
static void	removeInlineFlops(Design design) Removes the inline flops added by InlineFlopTools.createAndPlaceFlopsInlineOnTopPorts(Design, String, PBlock, boolean)

Methods inherited from class Object

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

Field Detail

INLINE_SUFFIX

public static final String INLINE_SUFFIX

See Also:

Constant Field Values

Constructor Detail

InlineFlopTools

public InlineFlopTools()

Method Detail

createAndPlaceFlopsInlineOnTopPortsArbitrarily

public static void createAndPlaceFlopsInlineOnTopPortsArbitrarily(Design design,
                                                                  String clkNet,
                                                                  PBlock keepOut)

Add flip-flops inline on all the top-level ports of an out-of-context design. This is useful for out-of-context kernels prior to placement and routing so that after the flops have been placed, the router is forced to route connections of each of the ports to each of the flops. This can help alleviate congestion when the kernels are placed/relocated in context. Note this assumes the design is not implemented as in most contexts it will be placed and routed immediately following this modification.

Parameters:

design - The design to modify

clkNet - Name of the clock net to use for the flops

keepOut - The pblock used to contain the kernel and the added flops will not be placed inside this area.

createAndPlaceFlopsInlineOnTopPortsNearPins

public static void createAndPlaceFlopsInlineOnTopPortsNearPins(Design design,
                                                               String clkNet,
                                                               PBlock keepOut)

Add flip-flops inline on all the top-level ports of an out-of-context design. Flip-flop placements are chosen based on the centroid of net pins for each top-level I/O. This is useful for out-of-context kernels prior to final routing so that after the flops have been placed, the router is forced to route connections of each of the ports to each of the flops. Note this assumes the design is placed and potentially partially routed.

Parameters:

design - The design to modify

clkNet - Name of the clock net to use for the flops

keepOut - The pblock used to contain the kernel and the added flops will not be placed inside this area.

createAndPlacePortFlopsOnSide

public static void createAndPlacePortFlopsOnSide(Design design,
                                                 String clkNet,
                                                 PBlock keepOut,
                                                 Map<EDIFPort,PBlockSide> portSideMap)

Add flip-flops inline on all the top-level ports of an out-of-context design. This is useful for out-of-context kernels so that after the flops have been placed, the router is forced to route connections of each of the ports to each of the flops. This can help alleviate congestion when the kernels are placed/relocated in context.

Parameters:

design - The design to modify

clkNet - Name of the clock net to use for the flops

keepOut - The pblock used to contain the kernel and the added flops will not be placed inside this area.

portSideMap - Map from ports to side of the pblock the flop should be placed on

createAndPlaceFlopInlineOnTopPortInst

public static Cell createAndPlaceFlopInlineOnTopPortInst(Design design,
                                                         EDIFPortInst portInst,
                                                         Pair<Site,BEL> loc,
                                                         EDIFHierNet clk)

Add flip-flop inline on the specified top-level port of an out-of-context design. This is useful for out-of-context kernels so that after the flop has been placed, the router is forced to route connections of the port to the flop. This can help alleviate congestion when the kernels are placed/relocated in context.

Parameters:

design - The design to modify

portInst - The port to place an inline flip-flop on

loc - A pair of the site and BEL to place the flip-flop at

clk - The clock net to use for the inline flip-flop

removeInlineFlops

public static void removeInlineFlops(Design design)

Removes the inline flops added by InlineFlopTools.createAndPlaceFlopsInlineOnTopPorts(Design, String, PBlock, boolean)

Parameters:

design - The current design from which to remove the flops

parseSideMap

public static Map<EDIFPort,PBlockSide> parseSideMap(EDIFNetlist netlist,
                                                    String filename)

Parses the PBlock side map into a map from EDIFPorts to PBlockSide enums. The input file should be made up of some number of lines where each line contains a port name regex and a PBlockSide separated by a space. An example file:

 example_inputs.* TOP
 reset LEFT
 example_outputs.* BOTTOM
 

Parameters:

netlist - The netlist that the side map will be created for.

filename - The name of the input side map file.

Returns:

A map from EDIFPort to the PBlockSide the inline flop should be placed on.

main

public static void main(String[] args)