com.xilinx.rapidwright.edif

Class YosysTools

Object

com.xilinx.rapidwright.edif.YosysTools

public class YosysTools
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYNTH_XILINX
static String	SYNTH_XILINX_FLAG_EDIF
static String	SYNTH_XILINX_FLAG_FAMILY_XCUP
static String	SYNTH_XILINX_FLAG_FLATTEN
static String	SYNTH_XILINX_FLAG_OUT_OF_CONTEXT
static String	yosysExec

Constructor Summary

Constructors

Constructor and Description
YosysTools()

Method Summary

Modifier and Type	Method and Description
static boolean	isYosysOnPath() Checks if yosys is available on current PATH (uses unix 'which' or windows 'where').
static void	run(String command, Path workDir, Path... paths) Run the given command string in Yosys, on the files given.
static EDIFNetlist	synthXilinx(Path... paths) Call Yosys' 'synth_xilinx' command with the default flags '-family xcvup -flatten -edif /output.edf' on the files given.
static EDIFNetlist	synthXilinx(String flags, Path... paths) Call Yosys' 'synth_xilinx' command with the given flags on the files given.
static EDIFNetlist	synthXilinxWithWorkDir(Path workDir, Path... paths) Call Yosys' 'synth_xilinx' command with the default flags '-family xcvup -flatten -edif /output.edf' on the files given.
static EDIFNetlist	synthXilinxWithWorkDir(String flags, Path workDir, Path... paths) Call Yosys' 'synth_xilinx' command with the given flags on the files given.

Methods inherited from class Object

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

Field Detail

yosysExec

public static final String yosysExec

See Also:

Constant Field Values

SYNTH_XILINX

public static final String SYNTH_XILINX

See Also:

Constant Field Values

SYNTH_XILINX_FLAG_FAMILY_XCUP

public static final String SYNTH_XILINX_FLAG_FAMILY_XCUP

See Also:

Constant Field Values

SYNTH_XILINX_FLAG_EDIF

public static final String SYNTH_XILINX_FLAG_EDIF

See Also:

Constant Field Values

SYNTH_XILINX_FLAG_FLATTEN

public static final String SYNTH_XILINX_FLAG_FLATTEN

See Also:

Constant Field Values

SYNTH_XILINX_FLAG_OUT_OF_CONTEXT

public static final String SYNTH_XILINX_FLAG_OUT_OF_CONTEXT

See Also:

Constant Field Values

Constructor Detail

YosysTools

public YosysTools()

Method Detail

run

public static void run(String command,
                       Path workDir,
                       Path... paths)

Run the given command string in Yosys, on the files given.

Parameters:

command - Yosys command(s), separated by ';'

workDir - Working directory

paths - Path objects of input files

synthXilinxWithWorkDir

public static EDIFNetlist synthXilinxWithWorkDir(String flags,
                                                 Path workDir,
                                                 Path... paths)

Call Yosys' 'synth_xilinx' command with the given flags on the files given.

Parameters:

flags - String with flags to be provided to 'synth_xilinx', in addition to '-edif /output.edf'.

workDir - Working directory

paths - Path objects of input files

Returns:

EDIFNetlist object of Yosys' result

synthXilinxWithWorkDir

public static EDIFNetlist synthXilinxWithWorkDir(Path workDir,
                                                 Path... paths)

Call Yosys' 'synth_xilinx' command with the default flags '-family xcvup -flatten -edif /output.edf' on the files given.

Parameters:

workDir - Working directory

paths - Path objects of input files

Returns:

EDIFNetlist object of Yosys' result

synthXilinx

public static EDIFNetlist synthXilinx(String flags,
                                      Path... paths)

Call Yosys' 'synth_xilinx' command with the given flags on the files given.

Parameters:

flags - String with flags to be provided to 'synth_xilinx', in addition to '-edif /output.edf'.

paths - Path objects of input files

Returns:

EDIFNetlist object of Yosys' result

synthXilinx

public static EDIFNetlist synthXilinx(Path... paths)

Call Yosys' 'synth_xilinx' command with the default flags '-family xcvup -flatten -edif /output.edf' on the files given.

Parameters:

paths - Path objects of input files

Returns:

EDIFNetlist object of Yosys' result

isYosysOnPath

public static boolean isYosysOnPath()

Checks if yosys is available on current PATH (uses unix 'which' or windows 'where').

Returns:

true if yosys is on current PATH, false otherwise.