com.xilinx.rapidwright.util

Class VivadoTools

Object

com.xilinx.rapidwright.util.VivadoTools

public class VivadoTools
extends Object

Utility methods to provide access to vivado and parse logs

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLACE_DESIGN
static String	REPORT_ROUTE_STATUS
static String	ROUTE_DESIGN
static String	WRITE_CHECKPOINT
static String	WRITE_EDIF

Constructor Summary

Constructors

Constructor and Description
VivadoTools()

Method Summary

Modifier and Type	Method and Description
static float	getWorstSetupSlack(Path dcp, Path workdir, boolean encrypted) Run Vivado's `get_timing_paths -setup` command on the provided DCP path (to find its worst setup timing path) and return its SLACK property as a float.
static Design	placeDesign(Path dcp, Path workdir, boolean encrypted) Run Vivado's `place_design` command on the provided DCP path and return the placed result as a new Design object.
static ReportRouteStatusResult	reportRouteStatus(Design design) Run Vivado's `report_route_status` command on the provided Design object and return its result as a ReportRouteStatusResult object.
static String	reportRouteStatus(Design design, String netName) Run Vivado's `report_route_status` command on the named net inside the provided Design object and return its specific route status (e.g.
static ReportRouteStatusResult	reportRouteStatus(Path dcp) Run Vivado's `report_route_status` command on the provided DCP.
static ReportRouteStatusResult	reportRouteStatus(Path dcp, boolean encrypted) Run Vivado's `report_route_status` command on the provided DCP path and return its result as a ReportRouteStatusResult object.
static ReportRouteStatusResult	reportRouteStatus(Path dcp, Path workdir, boolean encrypted) Run Vivado's `report_route_status` command on the provided DCP path and return its result as a ReportRouteStatusResult object.
static String	reportRouteStatus(String netName, Path dcp, Path workdir, boolean encrypted) Run Vivado's `report_route_status` command on the named net inside the provided DCP path and return its route status.
static ReportRouteStatusResult	routeDesignAndGetStatus(Design design, Path workdir) Run Vivado's `route_design` command on the design provided and get the `report_route_status` results.
static ReportRouteStatusResult	routeDesignAndGetStatus(Path dcp, Path workdir, boolean encrypted) Run Vivado's `route_design` command on the provided DCP path and return the `report_route_status` results.
static List<String>	runTcl(Path outputLog, Path tclScript, boolean verbose) method to run a Tcl script in vivado
static List<String>	runTcl(Path outputLog, Path tclScript, boolean verbose, String[] environ, File runDir) method to run a Tcl script in vivado
static List<String>	runTcl(Path outputLog, String tclCmd, boolean verbose) method to run a single Tcl command in vivado
static List<String>	searchVivadoLog(List<String> log, String key) method to search a vivado log for a specific key phrase
static List<String>	writeBitstream(Design design, Path bitFile) Run Vivado's `write_bitstream` on the provided design to generate a bit file at the specified location.
static List<String>	writeBitstream(Path dcp, Path bitFile, boolean hasEncryptedIP) Run Vivado's `write_bitstream` on the provided DCP file to generate a bit file at the specified location.
static List<String>	writeBitstream(Path dcp, Path bitFile, boolean hasEncryptedIP, String tclPremable) Run Vivado's `write_bitstream` on the provided DCP file to generate a bit file at the specified location.

Methods inherited from class Object

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

Field Detail

REPORT_ROUTE_STATUS

public static final String REPORT_ROUTE_STATUS

See Also:

Constant Field Values

PLACE_DESIGN

public static final String PLACE_DESIGN

See Also:

Constant Field Values

ROUTE_DESIGN

public static final String ROUTE_DESIGN

See Also:

Constant Field Values

WRITE_CHECKPOINT

public static final String WRITE_CHECKPOINT

See Also:

Constant Field Values

WRITE_EDIF

public static final String WRITE_EDIF

See Also:

Constant Field Values

Constructor Detail

VivadoTools

public VivadoTools()

Method Detail

searchVivadoLog

public static List<String> searchVivadoLog(List<String> log,
                                           String key)

method to search a vivado log for a specific key phrase

Parameters:

log - Vivado log as list of strings

key - Key phrase to search for

Returns:

List of lines that contain the key phrase

runTcl

public static List<String> runTcl(Path outputLog,
                                  String tclCmd,
                                  boolean verbose)

method to run a single Tcl command in vivado

Parameters:

outputLog - Path to the log file that vivado will generate

tclCmd - Tcl command to run

verbose - If true vivado command line and std.out/err will be printed to std.out

Returns:

the contents of the log file as a list of strings

runTcl

public static List<String> runTcl(Path outputLog,
                                  Path tclScript,
                                  boolean verbose)

method to run a Tcl script in vivado

Parameters:

outputLog - Path to the log file that vivado will generate

tclScript - Path to the Tcl script that will be run

verbose - If true vivado command line and std.out/err will be printed to std.out

Returns:

the contents of the log file as a list of strings

runTcl

public static List<String> runTcl(Path outputLog,
                                  Path tclScript,
                                  boolean verbose,
                                  String[] environ,
                                  File runDir)

method to run a Tcl script in vivado

Parameters:

outputLog - Path to the log file that vivado will generate

tclScript - Path to the Tcl script that will be run

verbose - If true vivado command line and std.out/err will be printed to std.out

environ - array of strings, each element of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.

runDir - the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.

Returns:

the contents of the log file as a list of strings

reportRouteStatus

public static ReportRouteStatusResult reportRouteStatus(Design design)

Run Vivado's `report_route_status` command on the provided Design object and return its result as a ReportRouteStatusResult object.

Parameters:

design - Design object to report on.

Returns:

ReportRouteStatusResult object.

reportRouteStatus

public static String reportRouteStatus(Design design,
                                       String netName)

Run Vivado's `report_route_status` command on the named net inside the provided Design object and return its specific route status (e.g. ROUTED).

Parameters:

design - Design object to report on.

Returns:

String containing net's specific route status.

writeBitstream

public static List<String> writeBitstream(Path dcp,
                                          Path bitFile,
                                          boolean hasEncryptedIP,
                                          String tclPremable)

Run Vivado's `write_bitstream` on the provided DCP file to generate a bit file at the specified location.

Parameters:

dcp - The DCP file from which to generate a bitstream.

bitFile - The location of the bit file to generate

hasEncryptedIP - Flag indicating if the provided DCP contains encrypted IP and was written by RapidWright such that it needs to be loaded with a Tcl script.

tclPremable - String of Tcl commands to run before write_bitstream (null for no preamble).

Returns:

The output of Vivado as a list of Strings

writeBitstream

public static List<String> writeBitstream(Path dcp,
                                          Path bitFile,
                                          boolean hasEncryptedIP)

Run Vivado's `write_bitstream` on the provided DCP file to generate a bit file at the specified location.

Parameters:

dcp - The DCP file from which to generate a bitstream.

bitFile - The location of the bit file to generate

hasEncryptedIP - Flag indicating if the provided DCP contains encrypted IP and was written by RapidWright such that it needs to be loaded with a Tcl script.

Returns:

The output of Vivado as a list of Strings

writeBitstream

public static List<String> writeBitstream(Design design,
                                          Path bitFile)

Run Vivado's `write_bitstream` on the provided design to generate a bit file at the specified location.

Parameters:

design - The design from which to generate a bitstream.

bitFile - The location of the bit file to generate

Returns:

The output of Vivado as a list of Strings

reportRouteStatus

public static ReportRouteStatusResult reportRouteStatus(Path dcp)

Run Vivado's `report_route_status` command on the provided DCP. Assume the given DCP is encrypted if, given /.dcp, /_load.tcl exists. Return report as a ReportRouteStatusResult object.

Parameters:

dcp - Path to DCP to report on.

Returns:

ReportRouteStatusResult object.

reportRouteStatus

public static ReportRouteStatusResult reportRouteStatus(Path dcp,
                                                        boolean encrypted)

Run Vivado's `report_route_status` command on the provided DCP path and return its result as a ReportRouteStatusResult object.

Parameters:

dcp - Path to DCP to report on.

encrypted - Indicates whether DCP contains encrypted EDIF cells.

Returns:

ReportRouteStatusResult object.

reportRouteStatus

public static ReportRouteStatusResult reportRouteStatus(Path dcp,
                                                        Path workdir,
                                                        boolean encrypted)

Run Vivado's `report_route_status` command on the provided DCP path and return its result as a ReportRouteStatusResult object.

Parameters:

dcp - Path to DCP to report on.

workdir - Directory to work within.

encrypted - Indicates whether DCP contains encrypted EDIF cells.

Returns:

ReportRouteStatusResult object.

reportRouteStatus

public static String reportRouteStatus(String netName,
                                       Path dcp,
                                       Path workdir,
                                       boolean encrypted)

Run Vivado's `report_route_status` command on the named net inside the provided DCP path and return its route status.

Parameters:

netName - Net name.

dcp - Path to DCP to report on.

workdir - Directory to work within.

encrypted - Indicates whether DCP contains encrypted EDIF cells.

Returns:

True if net was fully routed.

placeDesign

public static Design placeDesign(Path dcp,
                                 Path workdir,
                                 boolean encrypted)

Run Vivado's `place_design` command on the provided DCP path and return the placed result as a new Design object.

Parameters:

dcp - Path to DCP to report on.

workdir - Directory to work within.

encrypted - Indicates whether DCP contains encrypted EDIF cells.

Returns:

Design object.

routeDesignAndGetStatus

public static ReportRouteStatusResult routeDesignAndGetStatus(Design design,
                                                              Path workdir)

Run Vivado's `route_design` command on the design provided and get the `report_route_status` results. Note: this method does not preserve the routed output from Vivado.

Parameters:

design - The design to route and report on.

workdir - Directory to work within.

Returns:

The results of `report_route_status`.

routeDesignAndGetStatus

public static ReportRouteStatusResult routeDesignAndGetStatus(Path dcp,
                                                              Path workdir,
                                                              boolean encrypted)

Run Vivado's `route_design` command on the provided DCP path and return the `report_route_status` results. Note: this method does not preserve the routed output from Vivado.

Parameters:

dcp - Path to DCP to route and report on.

workdir - Directory to work within.

encrypted - Indicates whether DCP contains encrypted EDIF cells.

Returns:

The results of `report_route_status`.

getWorstSetupSlack

public static float getWorstSetupSlack(Path dcp,
                                       Path workdir,
                                       boolean encrypted)

Run Vivado's `get_timing_paths -setup` command on the provided DCP path (to find its worst setup timing path) and return its SLACK property as a float.

Parameters:

dcp - Path to DCP to report on.

workdir - Directory to work within.

encrypted - Indicates whether DCP contains encrypted EDIF cells.

Returns:

Worst slack of design as float.