com.xilinx.rapidwright.rwroute

Class RWRoute

Object

com.xilinx.rapidwright.rwroute.RWRoute

Direct Known Subclasses:

PartialRouter

public class RWRoute
extends Object

RWRoute class provides the main methods for routing a design. Creating a RWRoute Object needs a Design Object and a RWRouteConfig Object.

Field Summary

Fields

Modifier and Type	Field and Description
static EnumSet<Series>	SUPPORTED_SERIES

Constructor Summary

Constructors

Constructor and Description
RWRoute(Design design, RWRouteConfig config)

Method Summary

Modifier and Type	Method and Description
void	addClkNet(Net clk) Adds a clock net to the clock net routing targets.
static ClkRouteTiming	createClkTimingData(RWRouteConfig config) Creates clock routing related inputs based on the RWRouteConfig instance.
Design	getDesign()
static void	main(String[] args) The main interface of RWRoute that reads in a Design design (DCP or FPGA Interchange), and parses the arguments for the RWRouteConfig object of the router.
static void	preprocess(Design design) Pre-process the design to ensure that only the physical Net-s corresponding to the parent logical EDIFHierNet exists, and that such Net-s contain all necessary SitePinInst objects.
static void	printNodeTypeUsageAndWirelength(boolean verbose, Map<IntentCode,Long> nodeTypeUsage, Map<IntentCode,Long> nodeTypeLength)
void	route() Routes the design in a few routing phases and times those phases.
static Design	routeDesignFullNonTimingDriven(Design design) Routes a design in the full non-timing-driven routing mode.
static Design	routeDesignFullTimingDriven(Design design) Routes a design in the full timing-driven routing mode.
static Design	routeDesignWithUserDefinedArguments(Design design, String[] args) Routes a Design instance.
void	routeIndirectConnections() Routes indirect connections iteratively.

Methods inherited from class Object

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

Field Detail

SUPPORTED_SERIES

public static final EnumSet<Series> SUPPORTED_SERIES

Constructor Detail

RWRoute

public RWRoute(Design design,
               RWRouteConfig config)

Method Detail

preprocess

public static void preprocess(Design design)

Pre-process the design to ensure that only the physical Net-s corresponding to the parent logical EDIFHierNet exists, and that such Net-s contain all necessary SitePinInst objects.

Parameters:

design - Design to preprocess

createClkTimingData

public static ClkRouteTiming createClkTimingData(RWRouteConfig config)

Creates clock routing related inputs based on the RWRouteConfig instance.

Parameters:

config - The RWRouteConfig instance to use.

route

public void route()

Routes the design in a few routing phases and times those phases.

routeIndirectConnections

public void routeIndirectConnections()

Routes indirect connections iteratively.

addClkNet

public void addClkNet(Net clk)

Adds a clock net to the clock net routing targets.

Parameters:

clk - The clock net to be added.

getDesign

public Design getDesign()

printNodeTypeUsageAndWirelength

public static void printNodeTypeUsageAndWirelength(boolean verbose,
                                                   Map<IntentCode,Long> nodeTypeUsage,
                                                   Map<IntentCode,Long> nodeTypeLength)

routeDesignFullTimingDriven

public static Design routeDesignFullTimingDriven(Design design)

Routes a design in the full timing-driven routing mode.

Parameters:

design - The Design instance to be routed.

routeDesignFullNonTimingDriven

public static Design routeDesignFullNonTimingDriven(Design design)

Routes a design in the full non-timing-driven routing mode.

Parameters:

design - The Design instance to be routed.

routeDesignWithUserDefinedArguments

public static Design routeDesignWithUserDefinedArguments(Design design,
                                                         String[] args)

Routes a Design instance.

Parameters:

design - The Design instance to be routed.

args - An array of string arguments, can be null. If null, the design will be routed in the full timing-driven routing mode with default a RWRouteConfig instance. For more options of the configuration, please refer to the RWRouteConfig class.

Returns:

Routed design.

main

public static void main(String[] args)

The main interface of RWRoute that reads in a Design design (DCP or FPGA Interchange), and parses the arguments for the RWRouteConfig object of the router.

Parameters:

args - An array of strings that are used to create a RWRouteConfig object for the router.