ToolChains.Xilinx.Vivado

Exceptions

• VivadoException: Base class for all tool specific exceptions

Classes

• Configuration: Base class for all tool Configuration classes.
• ToolMixIn: Undocumented.
• Vivado: Undocumented.
• XElab: Represent an executable.
• XSim: Represent an executable.
• Synth: Represent an executable.
• VivadoProject: Undocumented.
• VivadoProjectFile: Undocumented.
• XilinxDesignConstraintFile: Undocumented.

Functions

• ElaborationFilter(): Undocumented.
• SimulatorFilter(): Undocumented.
• CompilerFilter(): Undocumented.

exception ToolChains.Xilinx.Vivado.VivadoException(message='')

Inheritance

Members

__init__(message='')

Exception initializer

Parameters:message (str) – The exception message.

__str__()

Returns the exception’s message text.

args

class ToolChains.Xilinx.Vivado.Configuration(host: Base.IHost)

Inheritance

Members

_vendor = 'Xilinx'

The name of the tools vendor.

_toolName = 'Xilinx Vivado'

The name of the tool.

_section = 'INSTALL.Xilinx.Vivado'

The name of the configuration section. Pattern: INSTALL.Vendor.ToolName.

_multiVersionSupport = True

Xilinx Vivado supports multiple versions installed on the same system.

_template = {'Linux': {'INSTALL.Xilinx.Vivado': {'Version': '2016.3', 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/bin'), 'SectionName': ('%{PathWithRoot}#${Version}', None), 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '${INSTALL.Xilinx:InstallationDirectory}/Vivado/${Version}')}}, 'Windows': {'INSTALL.Xilinx.Vivado': {'Version': '2016.3', 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/bin'), 'SectionName': ('%{PathWithRoot}#${Version}', None), 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '${INSTALL.Xilinx:InstallationDirectory}/Vivado/${Version}')}}}

The template for the configuration sections represented as nested dictionaries.

CheckDependency()

Check if general Xilinx support is configured in PoC.

ConfigureForAll()

ClearSection(writeWarnings=False)

Clear the configuration section associated to this Configuration class.

ConfigureForDarwin()

Start the configuration procedure for Darwin.

This method is a wrapper for ConfigureForAll(). Overwrite this method to implement a Darwin specific configuration routine.

ConfigureForLinux()

Start the configuration procedure for Linux.

This method is a wrapper for ConfigureForAll(). Overwrite this method to implement a Linux specific configuration routine.

ConfigureForWindows()

Start the configuration procedure for Windows.

This method is a wrapper for ConfigureForAll(). Overwrite this method to implement a Windows specific configuration routine.

GetSections(platform)

Return all section names for this configuration.

Host

Return the hosting object.

IsConfigured()

Return true if the configurations section is configured

IsSupportedPlatform()

Return true if the given platform is supported by this configuration routine.

Log(entry, condition=True)

Write an entry to the local logger.

LogDebug(*args, condition=True, **kwargs)

LogDryRun(*args, condition=True, **kwargs)

LogError(*args, condition=True, **kwargs)

LogFatal(*args, condition=True, **kwargs)

LogInfo(*args, condition=True, **kwargs)

LogNormal(*args, condition=True, **kwargs)

LogQuiet(*args, condition=True, **kwargs)

LogVerbose(*args, condition=True, **kwargs)

LogWarning(*args, condition=True, **kwargs)

Logger

Return the local logger instance.

PrepareOptions(writeWarnings=True)

PrepareSections(warningWasWritten, writeWarnings=True)

PrepareVersionedSections(writeWarnings=False)

RunPostConfigurationTasks()

Virtual method. Overwrite to execute post-configuration tasks.

SectionName

Return the configuration’s section name.

State

Return the configuration state.

_Ask(question, default, beforeDefault='', afterDefault='', indent=1)

_AskInstalled(question)

Ask a Yes/No/Pass question.

_AskYes_NoPass(question, indent=1)

Ask a yes/NO/pass question.

_Ask_YesNoPass(question, indent=1)

Ask a YES/no/pass question.

_Configuration__CheckVivadoVersion(binPath, version)

_ConfigureBinaryDirectory()

Updates section with value from _template and returns directory as Path object.

_ConfigureEdition(editions, defaultEdition)

_ConfigureInstallationDirectory()

Asks for installation directory and updates section. Checks if entered directory exists and returns Path object. If no installation directory was configured before, then _GetDefaultInstallationDir is called.

_ConfigureVersion()

If no version was configured before, then _GetDefaultVersion is called. Asks for version and updates section. Returns version as string.

_GetDefaultEdition()

Returns unresolved default edition (str) from template.

Overwrite this method in a sub-class for automatic search of editions.

_GetDefaultInstallationDirectory()

Return unresolved default installation directory (str) from template.

Overwrite function in sub-class for automatic search of installation directory.

_GetDefaultOptionValue(optionName)

_GetDefaultVersion()

Returns unresolved default version (str) from template.

Overwrite this method in a sub-class for automatic search of version.

_PrintAvailableEditions(editions, selectedEdition)

Print all available editions and return the selected index.

_TestDefaultInstallPath(defaults)

Helper function for automatic search of installation directory.

_TryLog(*args, condition=True, **kwargs)

class ToolChains.Xilinx.Vivado.ToolMixIn(platform, dryrun, binaryDirectoryPath, version, logger=None)

Inheritance

Members

class ToolChains.Xilinx.Vivado.Vivado(platform, dryrun, binaryDirectoryPath, version, logger=None)

Inheritance

Members

GetElaborator()

GetSimulator()

GetSynthesizer()

class ToolChains.Xilinx.Vivado.XElab(toolchain: ToolChains.ToolMixIn)

Inheritance

Members

HasWarnings

HasErrors

class Executable

_value = None

class XElab.FlagRangeCheck

_name = 'rangecheck'

_value = None

class XElab.SwitchMultiThreading

_name = 'mt'

_value = None

class XElab.SwitchVerbose

_name = 'verbose'

_value = None

class XElab.SwitchDebug

_name = 'debug'

_value = None

class XElab.SwitchOptimization

_pattern = '--{0}{1}'

_name = 'O'

_value = None

class XElab.SwitchTimeResolution

_name = 'timeprecision_vhdl'

_value = None

class XElab.SwitchProjectFile

_name = 'prj'

_value = None

class XElab.SwitchLogFile

_name = 'log'

_value = None

class XElab.SwitchSnapshot

_name = 's'

_value = None

class XElab.ArgTopLevel

_value = None

XElab.Parameters = [<class 'ToolChains.Xilinx.Vivado.XElab.Executable'>, <class 'ToolChains.Xilinx.Vivado.XElab.FlagRangeCheck'>, <class 'ToolChains.Xilinx.Vivado.XElab.SwitchMultiThreading'>, <class 'ToolChains.Xilinx.Vivado.XElab.SwitchTimeResolution'>, <class 'ToolChains.Xilinx.Vivado.XElab.SwitchVerbose'>, <class 'ToolChains.Xilinx.Vivado.XElab.SwitchDebug'>, <class 'ToolChains.Xilinx.Vivado.XElab.SwitchOptimization'>, <class 'ToolChains.Xilinx.Vivado.XElab.SwitchProjectFile'>, <class 'ToolChains.Xilinx.Vivado.XElab.SwitchLogFile'>, <class 'ToolChains.Xilinx.Vivado.XElab.SwitchSnapshot'>, <class 'ToolChains.Xilinx.Vivado.XElab.ArgTopLevel'>]

XElab.Link()

XElab.GetReader()

XElab.Log(entry, condition=True)

Write an entry to the local logger.

XElab.LogDebug(*args, condition=True, **kwargs)

XElab.LogDryRun(*args, condition=True, **kwargs)

XElab.LogError(*args, condition=True, **kwargs)

XElab.LogFatal(*args, condition=True, **kwargs)

XElab.LogInfo(*args, condition=True, **kwargs)

XElab.LogNormal(*args, condition=True, **kwargs)

XElab.LogQuiet(*args, condition=True, **kwargs)

XElab.LogVerbose(*args, condition=True, **kwargs)

XElab.LogWarning(*args, condition=True, **kwargs)

XElab.Logger

Return the local logger instance.

XElab.Path

XElab.ReadUntilBoundary(indent=0)

XElab.Send(line, end='\n')

XElab.SendBoundary()

XElab.StartProcess(parameterList)

XElab.Terminate()

XElab._POC_BOUNDARY = '====== POC BOUNDARY ======'

XElab._TryLog(*args, condition=True, **kwargs)

class ToolChains.Xilinx.Vivado.XSim(toolchain: ToolChains.ToolMixIn)

Inheritance

Members

HasWarnings

HasErrors

class Executable

_value = None

class XSim.SwitchLogFile

_name = '-log'

_value = None

class XSim.FlagGuiMode

_name = '-gui'

_value = None

class XSim.SwitchTclBatchFile

_name = '-tclbatch'

_value = None

class XSim.SwitchWaveformFile

_name = '-view'

_value = None

class XSim.SwitchSnapshot

_value = None

XSim.Parameters = [<class 'ToolChains.Xilinx.Vivado.XSim.Executable'>, <class 'ToolChains.Xilinx.Vivado.XSim.SwitchLogFile'>, <class 'ToolChains.Xilinx.Vivado.XSim.FlagGuiMode'>, <class 'ToolChains.Xilinx.Vivado.XSim.SwitchTclBatchFile'>, <class 'ToolChains.Xilinx.Vivado.XSim.SwitchWaveformFile'>, <class 'ToolChains.Xilinx.Vivado.XSim.SwitchSnapshot'>]

XSim.Simulate()

XSim.GetReader()

XSim.Log(entry, condition=True)

Write an entry to the local logger.

XSim.LogDebug(*args, condition=True, **kwargs)

XSim.LogDryRun(*args, condition=True, **kwargs)

XSim.LogError(*args, condition=True, **kwargs)

XSim.LogFatal(*args, condition=True, **kwargs)

XSim.LogInfo(*args, condition=True, **kwargs)

XSim.LogNormal(*args, condition=True, **kwargs)

XSim.LogQuiet(*args, condition=True, **kwargs)

XSim.LogVerbose(*args, condition=True, **kwargs)

XSim.LogWarning(*args, condition=True, **kwargs)

XSim.Logger

Return the local logger instance.

XSim.Path

XSim.ReadUntilBoundary(indent=0)

XSim.Send(line, end='\n')

XSim.SendBoundary()

XSim.StartProcess(parameterList)

XSim.Terminate()

XSim._POC_BOUNDARY = '====== POC BOUNDARY ======'

XSim._TryLog(*args, condition=True, **kwargs)

class ToolChains.Xilinx.Vivado.Synth(toolchain: ToolChains.ToolMixIn)

Inheritance

Members

HasWarnings

HasErrors

class Executable

_value = None

class Synth.SwitchLogFile

_name = 'log'

_value = None

class Synth.SwitchSourceFile

_name = 'source'

_value = None

class Synth.SwitchMode

_name = 'mode'

_value = 'batch'

Synth.Parameters = [<class 'ToolChains.Xilinx.Vivado.Synth.Executable'>, <class 'ToolChains.Xilinx.Vivado.Synth.SwitchLogFile'>, <class 'ToolChains.Xilinx.Vivado.Synth.SwitchSourceFile'>, <class 'ToolChains.Xilinx.Vivado.Synth.SwitchMode'>]

Synth.Compile()

Synth.GetReader()

Synth.Log(entry, condition=True)

Write an entry to the local logger.

Synth.LogDebug(*args, condition=True, **kwargs)

Synth.LogDryRun(*args, condition=True, **kwargs)

Synth.LogError(*args, condition=True, **kwargs)

Synth.LogFatal(*args, condition=True, **kwargs)

Synth.LogInfo(*args, condition=True, **kwargs)

Synth.LogNormal(*args, condition=True, **kwargs)

Synth.LogQuiet(*args, condition=True, **kwargs)

Synth.LogVerbose(*args, condition=True, **kwargs)

Synth.LogWarning(*args, condition=True, **kwargs)

Synth.Logger

Return the local logger instance.

Synth.Path

Synth.ReadUntilBoundary(indent=0)

Synth.Send(line, end='\n')

Synth.SendBoundary()

Synth.StartProcess(parameterList)

Synth.Terminate()

Synth._POC_BOUNDARY = '====== POC BOUNDARY ======'

Synth._TryLog(*args, condition=True, **kwargs)

class ToolChains.Xilinx.Vivado.VivadoProject(name)

Inheritance

Members

AddExternalVHDLLibraries(library)

AddFile(file, fileSet=None)

AddFileSet(fileSet)

AddSourceFile(file, fileSet=None)

Board

CreateFileSet(name, setDefault=True)

DefaultFileSet

Device

Environment

ExternalVHDLLibraries

ExtractVHDLLibrariesFromVHDLSourceFiles()

FileSets

Files(fileType=<FileTypes(Text|ProjectFile|FileListFile|RulesFile|SourceFile|VHDLSourceFile|VerilogSourceFile|PythonSourceFile|CocotbSourceFile|ConstraintFile|UcfConstraintFile|XdcConstraintFile|SdcConstraintFile|LdcConstraintFile|SettingsFile|QuartusSettingsFile) bits=0xFFFF>, fileSet=None)

GetVariables()

Name

RootDirectory

Tool

ToolChain

VHDLLibraries

VHDLVersion

pprint(indent=0)

class ToolChains.Xilinx.Vivado.VivadoProjectFile(file)

Inheritance

Members

FileName

FileSet

FileType

Open()

Path

Project

ReadFile()

_FileType = <FileTypes.ProjectFile bits=0x0002 data=UNDEFINED>

_ReadContent()

class ToolChains.Xilinx.Vivado.XilinxDesignConstraintFile(file, project=None, fileSet=None)

Inheritance

Members

FileName

FileSet

FileType

Open()

Path

Project

ReadFile()

_ReadContent()

_FileType = <FileTypes.XdcConstraintFile bits=0x0800 data=UNDEFINED>

Functions

ToolChains.Xilinx.Vivado.ElaborationFilter(gen)

ToolChains.Xilinx.Vivado.SimulatorFilter(gen)

ToolChains.Xilinx.Vivado.CompilerFilter(gen)