chiptools.wrappers.simulators.vivado module

class chiptools.wrappers.simulators.vivado.Vivado(project, user_paths)

Bases: chiptools.wrappers.simulator.Simulator

add_library(library)

Create a new source file library for compiling design files into. For example on ModelSim this would invoke the vlib command with the supplied library name.

compile(file_object, cwd=None)

Compile the supplied file_object into the current working library.

executables: List[str] = ['xvhdl', 'xvlog', 'xelab', 'xsim']

library_exists(libname, workdir)

Return True if the given libname exists in the workdir.

name = 'vivado'

platform_suffix = ''

set_library_path(library, path, cwd=None)

set_working_library(library, cwd=None)

Set the current working library where source files are to be compiled to when using the ‘compile’ method.

sim_ini_name = 'xsim.ini'

sim_tcl_name = 'xsim.tcl'

simulate(library, entity, gui=False, generics={}, includes={}, args=[], duration=None)

Invoke the simulator and target the given entity in the given library. If the optional argument gui is set to False the simulator will execute as a console application (where supported) otherwise it will run as a GUI. This function is blocking and will only continue when the simulator terminates. The optional argument generics provides a dictionary of generic name/generic value key, value pairs that are passed to the simulator as a command line argument. This allows you to set generics present on the entity being simulated. The optional argument do can be used to supply a string argument to be interpreted by the simulator as a script to execute after loading.

write_includes()

Write the includes dictionary to the xsim.ini file in the simulation directory, which is required by xvlog, xvhdl and xelab to locate existing compiled libraries.

xelab_name = 'xelab'

xsim_name = 'xsim'

xvhdl_name = 'xvhdl'

xvlog_name = 'xvlog'