com.xilinx.rapidwright.router

Class Router

Object

com.xilinx.rapidwright.router.AbstractRouter

com.xilinx.rapidwright.router.Router

public class Router
extends AbstractRouter

Basic router for routing inter-site nets. Created on: Aug 13, 2015

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ENABLE_LUT_INPUT_SWAP
static boolean	ENABLE_RIPUP
static int	LONG_LINE_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
Router(Design design)

Method Summary

Modifier and Type	Method and Description
ClockRegion	calcClockTreeCentroid()
boolean	checkClkResource(RouteNode clkNode)
Wire	checkSink(RouteNode myNode)
RouteNode	clkBufToClkRoutes(RouteNode src, boolean debug)
RouteNode	clkToSink(RouteNode clkHDistNode, boolean debug)
void	elaboratePhysicalNets() Assumes design is fully placed and that all site nets are routed but that not all physical nets (Net) or physical pins (SitePinInst) have been created.
static ArrayList<RouteNode>	findInputPinFeed(SitePinInst p) Attempts to find a switch box wire that will drive the site pin provided.
RouteNode	findSwitchBoxInput(RouteNode src)
static List<String>	getAlternativeLUTInputs(SitePinInst currSink) Checks the current sink LUT to see if there are any alternative LUT input pins that could be used instead
int	getClkNumber(RouteNode clkNode)
RouteNode	getHDfromBUF(RouteNode routeNode, boolean debug)
RouteNode	getHDISTRCol(RouteNode hDistr, boolean debug)
RouteNode	getHDISTRfromVHROUTE(RouteNode clkRoute, boolean debug)
RouteNode	getRAMSink(RouteNode sink)
PBlock	getRoutingPblock()
HashSet<RouteNode>	getSourcesFromPIPs(List<PIP> pips, HashSet<RouteNode> sources) Creates sources from a list of PIPs
void	identifyMissingPins()
boolean	isClockResource(RouteNode tmpRoute)
boolean	isRoutable(RouteNode rn, int depth) Looks backwards from an input pin depth number of hops to see if there exists at least one free path.
boolean	isSupressWarningsErrors()
static boolean	isSwitchBox(Tile t)
static void	main(String[] args)
void	markAndUpdateNetPIPsAsUsed()
void	markExistingRouteResourcesUsed() This router will preserve all existing routes (even partials) intact.
void	prepareSinkPinsForRouting(SitePinInst currSource, SitePinInst currPin) Updates class members with the current route information
void	printClkNodeInfo(RouteNode myNode, String myString)
void	reserveCriticalNodes() Certain input pins in a switch box can also serve as a bounce.
void	reserveCriticalNodes(ArrayList<SitePinInst> sitePinInsts)
RouteNode	routeCentroidToSinkClkRegion(RouteNode clkRoute, boolean debug)
void	routeClockNet()
void	routeClockTrees(boolean debug, SitePinInst currSource)
Design	routeDesign() This the central method for routing the design in this class.
void	routeNet() This method routes all the connections within a net.
void	routePinsReEntrant(ArrayList<SitePinInst> sitePinInsts, boolean routeUnroutedNets) This is a specialized routing function that will only route the pins given.
void	routeStaticNet()
void	routeStaticNets()
RouteNode	routeToCentroid(RouteNode clkRoute, boolean debug)
void	setClkCostDistance(RouteNode src, RouteNode sink)
void	setClkCostLevel(RouteNode src)
void	setRoutingPblock(PBlock routingPblock)
void	setSupressWarningsErrors(boolean supressWarningsErrors)
static void	swapLUTInputPins(SitePinInst lutInput, String newPinName) Changes the physical pin mapping of lutInput to an alternate physical pin on a LUT in provide for an alternative routing solution.
void	swapLUTPinForUnused(SitePinInst p)

Methods inherited from class com.xilinx.rapidwright.router.AbstractRouter

addInitialSourceForRouting, getDesign, getReservedNodes, getReservedNodesForNet, getSourcesFromPIPs, isClkPin, isNodeUsed, isNodeUsed, markNodeUsed, markPIPsAsUsed, setCost

Methods inherited from class Object

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

Field Detail

ENABLE_RIPUP

public static boolean ENABLE_RIPUP

ENABLE_LUT_INPUT_SWAP

public static boolean ENABLE_LUT_INPUT_SWAP

LONG_LINE_THRESHOLD

public static final int LONG_LINE_THRESHOLD

See Also:

Constant Field Values

Constructor Detail

Router

public Router(Design design)

Method Detail

getRoutingPblock

public PBlock getRoutingPblock()

setRoutingPblock

public void setRoutingPblock(PBlock routingPblock)

findSwitchBoxInput

public RouteNode findSwitchBoxInput(RouteNode src)

prepareSinkPinsForRouting

public void prepareSinkPinsForRouting(SitePinInst currSource,
                                      SitePinInst currPin)

Updates class members with the current route information

Parameters:

currSource - The source pin for this net

currPin - The current sink pin to be routed

isRoutable

public boolean isRoutable(RouteNode rn,
                          int depth)

Looks backwards from an input pin depth number of hops to see if there exists at least one free path.

Parameters:

rn - Input pin to check routability

depth - Number of PIP hops to check

Returns:

True if there exists at least one path depth PIP hops free, false otherwise.

swapLUTPinForUnused

public void swapLUTPinForUnused(SitePinInst p)

getAlternativeLUTInputs

public static List<String> getAlternativeLUTInputs(SitePinInst currSink)

Checks the current sink LUT to see if there are any alternative LUT input pins that could be used instead

Returns:

A list of available lut input pins that can be swapped

swapLUTInputPins

public static void swapLUTInputPins(SitePinInst lutInput,
                                    String newPinName)

Changes the physical pin mapping of lutInput to an alternate physical pin on a LUT in provide for an alternative routing solution.

Parameters:

lutInput - The physical pin on the site to be swapped

newPinName - The new physical BEL pin on the lut to serve as the new input.

routeNet

public void routeNet()

This method routes all the connections within a net.

isSupressWarningsErrors

public boolean isSupressWarningsErrors()

setSupressWarningsErrors

public void setSupressWarningsErrors(boolean supressWarningsErrors)

getSourcesFromPIPs

public HashSet<RouteNode> getSourcesFromPIPs(List<PIP> pips,
                                             HashSet<RouteNode> sources)

Creates sources from a list of PIPs

Parameters:

pips - The pips of the net to examine.

Returns:

The list of sources gathered from the pips list.

isSwitchBox

public static boolean isSwitchBox(Tile t)

reserveCriticalNodes

public void reserveCriticalNodes()

Certain input pins in a switch box can also serve as a bounce. We need to prevent the usage of the bounce if the pin will be need to route an input pin. This method reserves those wires by marking them used. They are later released as the routing for that particular net is starting.

reserveCriticalNodes

public void reserveCriticalNodes(ArrayList<SitePinInst> sitePinInsts)

markExistingRouteResourcesUsed

public void markExistingRouteResourcesUsed()

This router will preserve all existing routes (even partials) intact. This method will mark them as used to avoid route conflicts.

identifyMissingPins

public void identifyMissingPins()

markAndUpdateNetPIPsAsUsed

public void markAndUpdateNetPIPsAsUsed()

getRAMSink

public RouteNode getRAMSink(RouteNode sink)

clkToSink

public RouteNode clkToSink(RouteNode clkHDistNode,
                           boolean debug)

checkClkResource

public boolean checkClkResource(RouteNode clkNode)

getClkNumber

public int getClkNumber(RouteNode clkNode)

clkBufToClkRoutes

public RouteNode clkBufToClkRoutes(RouteNode src,
                                   boolean debug)

isClockResource

public boolean isClockResource(RouteNode tmpRoute)

routeToCentroid

public RouteNode routeToCentroid(RouteNode clkRoute,
                                 boolean debug)

getHDfromBUF

public RouteNode getHDfromBUF(RouteNode routeNode,
                              boolean debug)

getHDISTRfromVHROUTE

public RouteNode getHDISTRfromVHROUTE(RouteNode clkRoute,
                                      boolean debug)

getHDISTRCol

public RouteNode getHDISTRCol(RouteNode hDistr,
                              boolean debug)

routeCentroidToSinkClkRegion

public RouteNode routeCentroidToSinkClkRegion(RouteNode clkRoute,
                                              boolean debug)

calcClockTreeCentroid

public ClockRegion calcClockTreeCentroid()

checkSink

public Wire checkSink(RouteNode myNode)

setClkCostLevel

public void setClkCostLevel(RouteNode src)

setClkCostDistance

public void setClkCostDistance(RouteNode src,
                               RouteNode sink)

printClkNodeInfo

public void printClkNodeInfo(RouteNode myNode,
                             String myString)

routeClockTrees

public void routeClockTrees(boolean debug,
                            SitePinInst currSource)

routeClockNet

public void routeClockNet()

routeStaticNet

public void routeStaticNet()

routePinsReEntrant

public void routePinsReEntrant(ArrayList<SitePinInst> sitePinInsts,
                               boolean routeUnroutedNets)

This is a specialized routing function that will only route the pins given. It is assumed that each pin provided already belongs to a net. If any PIPs have already been used on the net, they can be leveraged on this route.

Parameters:

sitePinInsts - The sink pins to be routed.

routeStaticNets

public void routeStaticNets()

elaboratePhysicalNets

public void elaboratePhysicalNets()

Assumes design is fully placed and that all site nets are routed but that not all physical nets (Net) or physical pins (SitePinInst) have been created. TODO - Experimental stage

routeDesign

public Design routeDesign()

This the central method for routing the design in this class. This prepares the nets for routing.

Returns:

The final routed design.

findInputPinFeed

public static ArrayList<RouteNode> findInputPinFeed(SitePinInst p)

Attempts to find a switch box wire that will drive the site pin provided.

Parameters:

p - The pin to start from

Returns:

A wire (tile and wire) of a switch box that can drive the site pin, or null if none could be found.

main

public static void main(String[] args)