com.xilinx.rapidwright.router

Class VersalClockRouting

Object

com.xilinx.rapidwright.router.VersalClockRouting

public class VersalClockRouting
extends Object

A collection of utility methods for routing clocks on the Versal architecture. Created on: Nov 1, 2024

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VersalClockRouting.NodeWithPrevAndCost

Constructor Summary

Constructors

Constructor and Description
VersalClockRouting()

Method Summary

Modifier and Type	Method and Description
static Map<ClockRegion,Set<VersalClockRouting.NodeWithPrevAndCost>>	getStartingPoints(Map<ClockRegion,Node> 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 Node	routeBUFGToNearestRoutingTrack(Net clk)
static void	routeDistributionToLCBs(Net clk, Map<ClockRegion,Node> distLines, Set<Node> lcbTargets) Routes from distribution lines to the leaf clock buffers (LCBs)
static Map<Node,List<SitePinInst>>	routeLCBsToSinks(Net clk, Function<Node,NodeStatus> getNodeStatus)
static Node	routeToCentroid(Net clk, Node startingNode, ClockRegion clockRegion, boolean findCentroidHroute) Routes a clock from a routing track to a transition point where the clock.
static Map<ClockRegion,Node>	routeToHorizontalDistributionLines(Net clk, Node 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<VersalClockRouting.NodeWithPrevAndCost>> startingPoints, Set<Node> lcbTargets)
static Map<ClockRegion,Node>	routeVerticalToHorizontalDistributionLines(Net clk, Map<ClockRegion,Node> crMap, Function<Node,NodeStatus> getNodeStatus) For each target clock region, route from the provided vertical distribution line to a horizontal distribution line that has a GLOBAL_GLK child node in this clock region.
static Map<ClockRegion,Node>	routeVrouteToVerticalDistributionLines(Net clk, Node vroute, Collection<ClockRegion> clockRegions, Function<Node,NodeStatus> getNodeStatus)

Methods inherited from class Object

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

Constructor Detail

VersalClockRouting

public VersalClockRouting()

Method Detail

routeBUFGToNearestRoutingTrack

public static Node routeBUFGToNearestRoutingTrack(Net clk)

routeToCentroid

public static Node routeToCentroid(Net clk,
                                   Node startingNode,
                                   ClockRegion clockRegion,
                                   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.

startingNode - 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.

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

routeVrouteToVerticalDistributionLines

public static Map<ClockRegion,Node> routeVrouteToVerticalDistributionLines(Net clk,
                                                                           Node vroute,
                                                                           Collection<ClockRegion> clockRegions,
                                                                           Function<Node,NodeStatus> getNodeStatus)

routeVerticalToHorizontalDistributionLines

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

For each target clock region, route from the provided vertical distribution line to a horizontal distribution line that has a GLOBAL_GLK child node in this clock region. This simulates the behavior of Vivado.

Parameters:

clk - The current clock net

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

Returns:

The map of target clock regions and their respective horizontal distribution lines.

routeDistributionToLCBs

public static void routeDistributionToLCBs(Net clk,
                                           Map<ClockRegion,Node> distLines,
                                           Set<Node> lcbTargets)

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

Parameters:

clk - The current clock net

distLines - A map of target clock regions and their respective horizontal distribution lines

lcbTargets - The target LCB nodes to route the clock

getStartingPoints

public static Map<ClockRegion,Set<VersalClockRouting.NodeWithPrevAndCost>> getStartingPoints(Map<ClockRegion,Node> distLines)

routeToLCBs

public static void routeToLCBs(Net clk,
                               Map<ClockRegion,Set<VersalClockRouting.NodeWithPrevAndCost>> startingPoints,
                               Set<Node> lcbTargets)

routeToHorizontalDistributionLines

public static Map<ClockRegion,Node> routeToHorizontalDistributionLines(Net clk,
                                                                       Node 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:

The map of target clock regions and their respective 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).

routeLCBsToSinks

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