com.xilinx.rapidwright.router

Class UltraScaleClockRouting

Object

com.xilinx.rapidwright.router.UltraScaleClockRouting

public class UltraScaleClockRouting
extends Object

A collection of utility methods for routing clocks on the UltraScale architecture. Created on: Feb 1, 2018

Constructor Summary

Constructors

Constructor and Description
UltraScaleClockRouting()

Method Summary

Modifier and Type	Method and Description
static Map<ClockRegion,Set<RouteNode>>	getStartingPoints(List<RouteNode> distLines)
static void	incrementalClockRouter(Design design, Net clkNet, Function<Node,NodeStatus> getNodeStatus) Routes a partially routed clock.
static void	incrementalClockRouter(Net clkNet, List<SitePinInst> clkPins, Function<Node,NodeStatus> getNodeStatus) Routes a list of unrouted pins from a partially routed clock.
static RouteNode	routeBUFGToNearestRoutingTrack(Net clk)
static Map<ClockRegion,RouteNode>	routeCentroidToVerticalDistributionLines(Net clk, RouteNode centroidDistNode, Collection<ClockRegion> clockRegions, Function<Node,NodeStatus> getNodeStatus) Routes the vertical distribution path and generates a map between each target clock region and the vertical distribution line to start from.
static void	routeDistributionToLCBs(Net clk, List<RouteNode> distLines, Set<RouteNode> lcbTargets) Routes from distribution lines to the leaf clock buffers (LCBs)
static void	routeLCBsToSinks(Net clk, Map<RouteNode,List<SitePinInst>> lcbMappings, Function<Node,NodeStatus> getNodeStatus)
static RouteNode	routeToCentroid(Net clk, RouteNode clkRoutingLine, ClockRegion centroid) Routes a clock from a routing track to a transition point called the centroid where the clock fans out and transitions from clock routing tracks to clock distribution tracks
static RouteNode	routeToCentroid(Net clk, RouteNode startingRouteNode, ClockRegion clockRegion, boolean adjusted, boolean findCentroidHroute) Routes a clock from a routing track to a transition point where the clock.
static RouteNode	routeToCentroidNode(Net clk, RouteNode startingRouteNode, Node centroid) Routes a clock from a routing track to a given transition point called the centroid
static List<RouteNode>	routeToHorizontalDistributionLines(Net clk, RouteNode vroute, Collection<ClockRegion> clockRegions, boolean down, Function<Node,NodeStatus> getNodeStatus) Routes from a GLOBAL_VERTICAL_ROUTE to horizontal distribution lines.
static void	routeToLCBs(Net clk, Map<ClockRegion,Set<RouteNode>> startingPoints, Set<RouteNode> lcbTargets)
static List<RouteNode>	routeVerticalToHorizontalDistributionLines(Net clk, Map<ClockRegion,RouteNode> crMap, Function<Node,NodeStatus> getNodeStatus) Routes from a vertical distribution centroid to destination horizontal distribution lines in the clock regions provided.
static RouteNode	transitionCentroidToDistributionLine(Net clk, RouteNode centroidRouteLine) Routes the centroid route track to a vertical distribution track to realize the centroid and root of the clock.
static RouteNode	transitionCentroidToDistributionLine(Net clk, RouteNode centroidRouteLine, ClockRegion cr)
static RouteNode	transitionCentroidToVerticalDistributionLine(Net clk, RouteNode centroidRouteLine, boolean down)

Methods inherited from class Object

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

Constructor Detail

UltraScaleClockRouting

public UltraScaleClockRouting()

Method Detail

routeBUFGToNearestRoutingTrack

public static RouteNode routeBUFGToNearestRoutingTrack(Net clk)

routeToCentroid

public static RouteNode routeToCentroid(Net clk,
                                        RouteNode clkRoutingLine,
                                        ClockRegion centroid)

Routes a clock from a routing track to a transition point called the centroid where the clock fans out and transitions from clock routing tracks to clock distribution tracks

Parameters:

clk - The current clock net to contribute routing

clkRoutingLine - The intermediate start point of the clock route

centroid - ClockRegion/FSR considered to be the centroid target

routeToCentroid

public static RouteNode routeToCentroid(Net clk,
                                        RouteNode startingRouteNode,
                                        ClockRegion clockRegion,
                                        boolean adjusted,
                                        boolean findCentroidHroute)

Routes a clock from a routing track to a transition point where the clock. fans out and transitions from clock routing tracks to clock distribution.

Parameters:

clk - The current clock net to contribute routing.

startingRouteNode - The intermediate start point of the clock route.

clockRegion - The center clock region or the clock region that is one row above or below the center.

adjusted - A flag to guard the default functionality when routing to centroid clock region.

findCentroidHroute - The flag to indicate the returned RouteNode should be HROUTE in the center or VROUTE going up or down.

routeToCentroidNode

public static RouteNode routeToCentroidNode(Net clk,
                                            RouteNode startingRouteNode,
                                            Node centroid)

Routes a clock from a routing track to a given transition point called the centroid

Parameters:

clk - The clock net to be routed

startingRouteNode - The starting routing track

centroid - The given centroid node

Returns:

transitionCentroidToDistributionLine

public static RouteNode transitionCentroidToDistributionLine(Net clk,
                                                             RouteNode centroidRouteLine)

Routes the centroid route track to a vertical distribution track to realize the centroid and root of the clock.

Parameters:

clk - Clock net to route

centroidRouteLine - The current routing track found in the centroid

Returns:

The vertical distribution track for the centroid clock region

transitionCentroidToVerticalDistributionLine

public static RouteNode transitionCentroidToVerticalDistributionLine(Net clk,
                                                                     RouteNode centroidRouteLine,
                                                                     boolean down)

transitionCentroidToDistributionLine

public static RouteNode transitionCentroidToDistributionLine(Net clk,
                                                             RouteNode centroidRouteLine,
                                                             ClockRegion cr)

routeCentroidToVerticalDistributionLines

public static Map<ClockRegion,RouteNode> routeCentroidToVerticalDistributionLines(Net clk,
                                                                                  RouteNode centroidDistNode,
                                                                                  Collection<ClockRegion> clockRegions,
                                                                                  Function<Node,NodeStatus> getNodeStatus)

Routes the vertical distribution path and generates a map between each target clock region and the vertical distribution line to start from.

Parameters:

clk - The clock net.

centroidDistNode - Starting point vertical distribution line

clockRegions - The target clock regions.

Returns:

A map of target clock regions and their respective vertical distribution lines

routeVerticalToHorizontalDistributionLines

public static List<RouteNode> routeVerticalToHorizontalDistributionLines(Net clk,
                                                                         Map<ClockRegion,RouteNode> crMap,
                                                                         Function<Node,NodeStatus> getNodeStatus)

Routes from a vertical distribution centroid to destination horizontal distribution lines in the clock regions provided.

Parameters:

clk - The current clock net

crMap - A map that provides a RouteNode reference for each ClockRegion

Returns:

The List of nodes from the centroid to the horizontal distribution line.

routeDistributionToLCBs

public static void routeDistributionToLCBs(Net clk,
                                           List<RouteNode> distLines,
                                           Set<RouteNode> lcbTargets)

Routes from distribution lines to the leaf clock buffers (LCBs)

Parameters:

clk - The current clock net

lcbTargets - The target LCB nodes to route the clock

getStartingPoints

public static Map<ClockRegion,Set<RouteNode>> getStartingPoints(List<RouteNode> distLines)

routeToLCBs

public static void routeToLCBs(Net clk,
                               Map<ClockRegion,Set<RouteNode>> startingPoints,
                               Set<RouteNode> lcbTargets)

routeLCBsToSinks

public static void routeLCBsToSinks(Net clk,
                                    Map<RouteNode,List<SitePinInst>> lcbMappings,
                                    Function<Node,NodeStatus> getNodeStatus)

Parameters:

clk -

lcbMappings -

getNodeStatus - Lambda for indicating the status of a Node: available, in-use (preserved for same net as we're routing), or unavailable (preserved for other net).

routeToHorizontalDistributionLines

public static List<RouteNode> routeToHorizontalDistributionLines(Net clk,
                                                                 RouteNode vroute,
                                                                 Collection<ClockRegion> clockRegions,
                                                                 boolean down,
                                                                 Function<Node,NodeStatus> getNodeStatus)

Routes from a GLOBAL_VERTICAL_ROUTE to horizontal distribution lines.

Parameters:

clk - The clock net to be routed.

vroute - The node to start the route.

clockRegions - Target clock regions.

down - To indicate if it is routing to the group of top clock regions.

Returns:

A list of RouteNodes indicating the reached horizontal distribution lines.

incrementalClockRouter

public static void incrementalClockRouter(Design design,
                                          Net clkNet,
                                          Function<Node,NodeStatus> getNodeStatus)

Routes a partially routed clock. It will examine the clock net for SitePinInsts and assumes any present are already routed. It then invokes DesignTools.createMissingSitePinInsts(Design, Net) to discover those not yet routed.

Parameters:

design - The current design

clkNet - The partially routed clock net to make fully routed

getNodeStatus - Lambda for indicating the status of a Node: available, in-use (preserved for same net as we're routing), or unavailable (preserved for other net).

incrementalClockRouter

public static void incrementalClockRouter(Net clkNet,
                                          List<SitePinInst> clkPins,
                                          Function<Node,NodeStatus> getNodeStatus)

Routes a list of unrouted pins from a partially routed clock.

Parameters:

clkNet - The partially routed clock net to make fully routed

clkPins - A list of unrouted pins on the clock net to route

getNodeStatus - Lambda for indicating the status of a Node: available, in-use (preserved for same net as we're routing), or unavailable (preserved for other net).