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

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_CLOCK_VTREE_TYPE

Constructor Summary

Constructors

Constructor and Description
VersalClockRouting()

Method Summary

Modifier and Type	Method and Description
static Integer	getPreferredClockRootYCoord(Device device, int minY, int maxY) Given a range of occupied clock region Y coordinates, get the preferred clock root Y coordinate.
static Integer	getPreferredClockRootYCoord(Device device, int minY, int maxY, VTreeType vtreeType)
static Integer	getPreferredClockRootYCoord(Net clk, Device device, int minY, int maxY)
static Integer	getRoutingTrackIndex(Node node)
static Map<ClockRegion,Set<VersalClockRouting.NodeWithPrevAndCost>>	getStartingPoints(Map<ClockRegion,Node> distLines)
static VTreeType	getUserClockVTreeType(Net clk)
static VersalClockTree	getVersalClockTree(Device device, int minY, int maxY)
static VersalClockTree	getVersalClockTree(Device device, int minY, int maxY, VTreeType vtreeType)
static VersalClockTree	getVersalClockTree(Net clk, Device device, int minY, int maxY)
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 Map<String,Map<Integer,VersalClockTree>>	readVersalVDistrTrees()
static Node	routeBUFGToNearestRoutingTrack(Net clk, Function<Node,NodeStatus> getNodeStatus)
static void	routeDistributionToLCBs(Net clk, Map<ClockRegion,Node> distLines, Map<Node,List<SitePinInst>> lcbTargets, Function<Node,NodeStatus> getNodeStatus) Routes from distribution lines to the leaf clock buffers (LCBs)
static Map<Node,List<SitePinInst>>	routeLCBsToSinks(Net clk, Function<Node,NodeStatus> getNodeStatus)
static void	routeNonLCBPins(Net clk, List<SitePinInst> sinks, Function<Node,NodeStatus> getNodeStatus)
static Node	routeToCentroid(Net clk, Node startingNode, ClockRegion targetCR, boolean findCentroidHroute, Function<Node,NodeStatus> getNodeStatus, Set<Integer> unavailableTracks) 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, Map<Node,List<SitePinInst>> lcbTargets, Function<Node,NodeStatus> getNodeStatus)
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)
static void	writeVersalVDistrTreesFile()

Methods inherited from class Object

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

Field Detail

USER_CLOCK_VTREE_TYPE

public static final String USER_CLOCK_VTREE_TYPE

See Also:

Constant Field Values

Constructor Detail

VersalClockRouting

public VersalClockRouting()

Method Detail

routeBUFGToNearestRoutingTrack

public static Node routeBUFGToNearestRoutingTrack(Net clk,
                                                  Function<Node,NodeStatus> getNodeStatus)

getRoutingTrackIndex

public static Integer getRoutingTrackIndex(Node node)

routeToCentroid

public static Node routeToCentroid(Net clk,
                                   Node startingNode,
                                   ClockRegion targetCR,
                                   boolean findCentroidHroute,
                                   Function<Node,NodeStatus> getNodeStatus,
                                   Set<Integer> unavailableTracks)

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.

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

getNodeStatus - Function to call to check if a node is available

usedRoutingTracks - A map to keep track of which routing tracks are used for each region

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,
                                           Map<Node,List<SitePinInst>> lcbTargets,
                                           Function<Node,NodeStatus> getNodeStatus)

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,
                               Map<Node,List<SitePinInst>> lcbTargets,
                               Function<Node,NodeStatus> getNodeStatus)

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)

routeNonLCBPins

public static void routeNonLCBPins(Net clk,
                                   List<SitePinInst> sinks,
                                   Function<Node,NodeStatus> getNodeStatus)

readVersalVDistrTrees

public static Map<String,Map<Integer,VersalClockTree>> readVersalVDistrTrees()

writeVersalVDistrTreesFile

public static void writeVersalVDistrTreesFile()

getVersalClockTree

public static VersalClockTree getVersalClockTree(Device device,
                                                 int minY,
                                                 int maxY)

getVersalClockTree

public static VersalClockTree getVersalClockTree(Device device,
                                                 int minY,
                                                 int maxY,
                                                 VTreeType vtreeType)

getVersalClockTree

public static VersalClockTree getVersalClockTree(Net clk,
                                                 Device device,
                                                 int minY,
                                                 int maxY)

getPreferredClockRootYCoord

public static Integer getPreferredClockRootYCoord(Device device,
                                                  int minY,
                                                  int maxY)

Given a range of occupied clock region Y coordinates, get the preferred clock root Y coordinate.

Parameters:

device - The current device to target.

minY - The smallest Y coordinate of the clock region range.

maxY - The largest Y coordinate of the clock region range.

Returns:

The preferred clock region Y coordinate for the given range or null if none could be found.

getPreferredClockRootYCoord

public static Integer getPreferredClockRootYCoord(Device device,
                                                  int minY,
                                                  int maxY,
                                                  VTreeType vtreeType)

getPreferredClockRootYCoord

public static Integer getPreferredClockRootYCoord(Net clk,
                                                  Device device,
                                                  int minY,
                                                  int maxY)

getUserClockVTreeType

public static VTreeType getUserClockVTreeType(Net clk)