com.xilinx.rapidwright.util

Class CodeGenerator

Object

com.xilinx.rapidwright.util.CodeGenerator

public class CodeGenerator
extends Object

This utility class is used to create RapidWright code from a DCP file that is tedious to create by hand.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEST_SITE_INST_CLASS_NAME
static String	TEST_SITE_INST_METHOD_NAME

Constructor Summary

Constructors

Constructor and Description
CodeGenerator()

Method Summary

Modifier and Type	Method and Description
static void	addPIPs(Net net, String[] pips)
static void	addSitePIPs(SiteInst si, String... sitePIPs) Shorthand method for turning on site PIPs in a site instance.
static Net	createTestNet(Design design, String netName, String[] pips)
static Cell	genCell(SiteInst si, String name, boolean isRoutethru, String type, String bel, String... pinMaps) Shorthand method for creating a placed cell inside a site instance.
static void	genCodeForTestSite(SiteInst inst, PrintStream ps, boolean includeRouting) Creates boilerplate code for a test by re-creating a SiteInst's configuration from scratch in RapidWright APIs.
static void	routeSiteNet(SiteInst si, Net n, String... siteWires) Shorthand method to route site wires with a particular net in a site instance.
static String	testNetGenerator(Design design, Collection<String> nets, Collection<String> siteInsts) Generates RapidWright test code from a provided checkpoint that instantiates the provided nets and siteInsts, and adds the associated PIPs to each of the nets.
static String	testNetGenerator(Net net) Convenience method to take a net and return a String the generates the routed net for an example test case in RapidWright code
static String	testNetGenerator(String dcp, Collection<String> nets, Collection<String> siteInsts) Generates RapidWright test code from a provided checkpoint that instantiates the provided nets and siteInsts, and adds the associated PIPs to each of the nets.
static String	testNetGenerator(String dcp, String edif, Collection<String> nets, Collection<String> siteInsts) Generates RapidWright test code from a provided checkpoint that instantiates the provided nets and siteInsts, and adds the associated PIPs to each of the nets.

Methods inherited from class Object

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

Field Detail

TEST_SITE_INST_CLASS_NAME

public static String TEST_SITE_INST_CLASS_NAME

TEST_SITE_INST_METHOD_NAME

public static String TEST_SITE_INST_METHOD_NAME

Constructor Detail

CodeGenerator

public CodeGenerator()

Method Detail

testNetGenerator

public static String testNetGenerator(Net net)

Convenience method to take a net and return a String the generates the routed net for an example test case in RapidWright code

Parameters:

net - The net to extract routing and SiteInst from

Returns:

The RapidWright code string

testNetGenerator

public static String testNetGenerator(String dcp,
                                      Collection<String> nets,
                                      Collection<String> siteInsts)

Generates RapidWright test code from a provided checkpoint that instantiates the provided nets and siteInsts, and adds the associated PIPs to each of the nets.

Parameters:

dcp - The path to the desired DCP to generate code from.

nets - A collection of nets to generate code for.

siteInsts - A collection of site instances to generate code for.

Returns:

The resulting code.

testNetGenerator

public static String testNetGenerator(String dcp,
                                      String edif,
                                      Collection<String> nets,
                                      Collection<String> siteInsts)

Generates RapidWright test code from a provided checkpoint that instantiates the provided nets and siteInsts, and adds the associated PIPs to each of the nets.

Parameters:

dcp - The path to the desired DCP to generate code from.

edif - The path to the external EDIF file to load (in case of an encrypted DCP file).

nets - A collection of nets to generate code for.

siteInsts - A collection of site instances to generate code for.

Returns:

The resulting code.

testNetGenerator

public static String testNetGenerator(Design design,
                                      Collection<String> nets,
                                      Collection<String> siteInsts)

Generates RapidWright test code from a provided checkpoint that instantiates the provided nets and siteInsts, and adds the associated PIPs to each of the nets.

Parameters:

design - The design to generate code from.

nets - A collection of nets to generate code for.

siteInsts - A collection of site instances to generate code for.

Returns:

The resulting code.

createTestNet

public static Net createTestNet(Design design,
                                String netName,
                                String[] pips)

addPIPs

public static void addPIPs(Net net,
                           String[] pips)

routeSiteNet

public static void routeSiteNet(SiteInst si,
                                Net n,
                                String... siteWires)

Shorthand method to route site wires with a particular net in a site instance.

Parameters:

si - The site instance to target

n - The net to be site routed

siteWires - The list of site wire names to route

addSitePIPs

public static void addSitePIPs(SiteInst si,
                               String... sitePIPs)

Shorthand method for turning on site PIPs in a site instance.

Parameters:

si - The target site instance.

sitePIPs - The list of site PIPs (of the format :) to turn on.

genCell

public static Cell genCell(SiteInst si,
                           String name,
                           boolean isRoutethru,
                           String type,
                           String bel,
                           String... pinMaps)

Shorthand method for creating a placed cell inside a site instance. This is mostly useful for constructing test case scenarios.

Parameters:

si - The target site instance

name - Name of the cell to create

isRoutethru - Flag indicating if the cell should be a routethru

type - The type of the cell (Unisim or special field)

bel - The name of the BEL where the cell should be placed

pinMaps - A variable number of pin mappings for the cell where each string is of the format :

Returns:

The created cell.

genCodeForTestSite

public static void genCodeForTestSite(SiteInst inst,
                                      PrintStream ps,
                                      boolean includeRouting)

Creates boilerplate code for a test by re-creating a SiteInst's configuration from scratch in RapidWright APIs. This is useful for testing when only a small context is necessary to reproduce a specific scenario.

Parameters:

inst - The instance to replicate in the test

ps - The PrintStream (System.out, or a file-based PrintStream, for example).

includeRouting - Flag indicating that the code example should include inter-site routing (PIPs).