com.xilinx.rapidwright.interchange

Class Interchange

Object

com.xilinx.rapidwright.interchange.Interchange

public class Interchange
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	IS_GZIPPED Flag indicating that files are gzipped on output
static boolean	IS_PACKED Flag indicating use of Packed Cap'n Proto Serialization
static String	LOG_NETLIST_EXT Standard file extension for a logical netlist in the FPGA Interchange Format
static String	PHYS_NETLIST_EXT Standard file extension for a physical netlist in the FPGA Interchange Format

Constructor Summary

Constructors

Constructor and Description
Interchange()

Method Summary

Modifier and Type	Method and Description
static Path	benchmarkDCPvsInterchange(Path dcpPath, Path edifPath, Path workingPath)
static boolean	isInterchangeFile(String fileName) Checks if the provided file name is a logical or physical FPGA Interchange file.
static void	main(String[] args)
static Design	readInterchangeDesign(Path filePath) Reads an FPGA Interchange Format design from a specified file.
static Design	readInterchangeDesign(String fileName) Reads an FPGA Interchange Format design from a specified file.
static Design	readInterchangeDesign(String logFileName, String physFileName, String xdcFileName, boolean isOutOfContext, CodePerfTracker t) Reads a set of existing FPGA Interchange files and returns a new design.
static org.capnproto.MessageReader	readInterchangeFile(String fileName, org.capnproto.ReaderOptions readOptions) Common method used to read Interchange files
static void	writeDesignToInterchange(Design design, String rootFileName) Writes out a set of Interchange files for the given design.
static void	writeInterchangeFile(String fileName, org.capnproto.MessageBuilder message) Common method to write out Interchange files

Methods inherited from class Object

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

Field Detail

IS_PACKED

public static boolean IS_PACKED

Flag indicating use of Packed Cap'n Proto Serialization

IS_GZIPPED

public static boolean IS_GZIPPED

Flag indicating that files are gzipped on output

LOG_NETLIST_EXT

public static final String LOG_NETLIST_EXT

Standard file extension for a logical netlist in the FPGA Interchange Format

See Also:

Constant Field Values

PHYS_NETLIST_EXT

public static final String PHYS_NETLIST_EXT

Standard file extension for a physical netlist in the FPGA Interchange Format

See Also:

Constant Field Values

Constructor Detail

Interchange

public Interchange()

Method Detail

readInterchangeDesign

public static Design readInterchangeDesign(String fileName)

Reads an FPGA Interchange Format design from a specified file. The file could be a logical netlist or physical netlist and this method will assume the corresponding file with the same root name to load as a companion. If the provided name is a logical netlist and no physical netlist is found, it will only load the logical netlist. It will also load any XDC file with the same root name.

Parameters:

fileName - The name of the logical or physical netlist file.

Returns:

The loaded design.

readInterchangeDesign

public static Design readInterchangeDesign(Path filePath)

Reads an FPGA Interchange Format design from a specified file. The file could be a logical netlist or physical netlist and this method will assume the corresponding file with the same root name to load as a companion. If the provided name is a logical netlist and no physical netlist is found, it will only load the logical netlist. It will also load any XDC file with the same root name.

Parameters:

filePath - The path to the logical or physical netlist file.

Returns:

The loaded design.

readInterchangeDesign

public static Design readInterchangeDesign(String logFileName,
                                           String physFileName,
                                           String xdcFileName,
                                           boolean isOutOfContext,
                                           CodePerfTracker t)

Reads a set of existing FPGA Interchange files and returns a new design.

Parameters:

logFileName - The logical netlist file to be loaded.

physFileName - The physical netlist file to be loaded, this can be null for no placement or routing information.

xdcFileName - The constraints to associate with the design, this can be null for no constraints.

isOutOfContext - A flag indicating if the design should be marked out of context.

t - If using an existing CodePerfTracker, this allows continuity otherwise the default is null (an instance will be created each time) and will track runtime of each loading step. To silence this measurement, provide CodePerfTracker.SILENT).

Returns:

The newly created design based on the provided files.

writeDesignToInterchange

public static void writeDesignToInterchange(Design design,
                                            String rootFileName)

Writes out a set of Interchange files for the given design. It will write up to 3 files with the logical netlist always being written out. The two optional files are the physical netlist and XDC (constraints) file.

Parameters:

design - The design in memory to write out.

rootFileName - The root or common name among the output files.

isInterchangeFile

public static boolean isInterchangeFile(String fileName)

Checks if the provided file name is a logical or physical FPGA Interchange file.

Parameters:

fileName - The file name in question.

Returns:

True if the file name matches the logical or physical netlist file name type.

writeInterchangeFile

public static void writeInterchangeFile(String fileName,
                                        org.capnproto.MessageBuilder message)
                                 throws IOException

Common method to write out Interchange files

Parameters:

fileName - Name of the output file to write

message - The message to write to the file

Throws:

IOException

readInterchangeFile

public static org.capnproto.MessageReader readInterchangeFile(String fileName,
                                                              org.capnproto.ReaderOptions readOptions)
                                                       throws IOException

Common method used to read Interchange files

Parameters:

fileName - Name of the file to read

readOptions - The reader options

Returns:

The read message from the file

Throws:

IOException

benchmarkDCPvsInterchange

public static Path benchmarkDCPvsInterchange(Path dcpPath,
                                             Path edifPath,
                                             Path workingPath)
                                      throws IOException

Throws:

IOException

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException