ToolChain.Xilinx.ISE¶

Exceptions

• ISEException: Base class for all tool specific exceptions

Classes

• Configuration: Base class for all tool Configuration classes.
• ISE: Undocumented.
• Fuse: Represent an executable.
• ISESimulator: Represent an executable.
• Xst: Represent an executable.
• CoreGenerator: Represent an executable.
• ISEProject: Undocumented.
• ISEProjectFile: Undocumented.
• UserConstraintFile: Undocumented.

Functions

• VhCompFilter(): Undocumented.
• FuseFilter(): Undocumented.
• SimulatorFilter(): Undocumented.
• XstFilter(): Undocumented.
• CoreGeneratorFilter(): Undocumented.

exception ToolChain.Xilinx.ISE.ISEException(message='')[source]¶

Inheritance

Members

__init__(message='')¶

Exception initializer

Parameters:	message (str) – The exception message.

__str__()¶

Returns the exception’s message text.

args¶

class ToolChain.Xilinx.ISE.Configuration(host: Base.IHost)[source]¶

Inheritance

Members

_vendor = 'Xilinx'¶

The name of the tools vendor.

_toolName = 'Xilinx ISE'¶

The name of the tool.

_section = 'INSTALL.Xilinx.ISE'¶

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

_multiVersionSupport = True¶

Xilinx ISE supports multiple versions installed on the same system.

_template = {'Windows': {'INSTALL.Xilinx.ISE': {'Version': '14.7', 'SectionName': ('%{PathWithRoot}#${Version}', None), 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '${INSTALL.Xilinx:InstallationDirectory}/${Version}/ISE_DS'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/ISE/bin/nt64')}}, 'Linux': {'INSTALL.Xilinx.ISE': {'Version': '14.7', 'SectionName': ('%{PathWithRoot}#${Version}', None), 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '${INSTALL.Xilinx:InstallationDirectory}/${Version}/ISE_DS'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/ISE/bin/lin64')}}}¶

The template for the configuration sections represented as nested dictionaries.

CheckDependency()[source]¶

Check if general Xilinx support is configured in PoC.

ConfigureForAll()[source]¶

ClearSection(writeWarnings=False)[source]¶

Clear the configuration section associated to this Configuration class.

ConfigureForDarwin()[source]¶

Start the configuration procedure for Darwin.

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

ConfigureForLinux()[source]¶

Start the configuration procedure for Linux.

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

ConfigureForWindows()[source]¶

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)[source]¶

Return all section names for this configuration.

Host¶

Return the hosting object.

IsConfigured()[source]¶

Return true if the configurations section is configured

IsSupportedPlatform()[source]¶

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)[source]¶

PrepareSections(warningWasWritten, writeWarnings=True)[source]¶

PrepareVersionedSections(writeWarnings=False)¶

RunPostConfigurationTasks()[source]¶

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)[source]¶

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__CheckISEVersion(binPath)¶

_ConfigureBinaryDirectory()¶

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

_ConfigureEdition(editions, defaultEdition)¶

_ConfigureInstallationDirectory()[source]¶

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()[source]¶

Return unresolved default installation directory (str) from template.

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

_GetDefaultOptionValue(optionName)[source]¶

_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)[source]¶

Helper function for automatic search of installation directory.

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

class ToolChain.Xilinx.ISE.ISE(platform, dryrun, binaryDirectoryPath, version, logger=None)[source]¶

Inheritance

Members

PreparseEnvironment(installationDirectory)[source]¶

GetVHDLCompiler()[source]¶

GetFuse()[source]¶

GetXst()[source]¶

GetCoreGenerator()[source]¶

class ToolChain.Xilinx.ISE.Fuse(toolchain: ToolChain.ToolMixIn)[source]¶

Inheritance

Members

class Executable[source]¶

class Fuse.FlagIncremental[source]¶

_name = 'incremental'¶

class Fuse.FlagRangeCheck[source]¶

_name = 'rangecheck'¶

class Fuse.SwitchMultiThreading[source]¶

_name = 'mt'¶

class Fuse.SwitchTimeResolution[source]¶

_name = 'timeprecision_vhdl'¶

class Fuse.SwitchProjectFile[source]¶

_name = 'prj'¶

class Fuse.SwitchOutputFile[source]¶

_name = 'o'¶

class Fuse.ArgTopLevel[source]¶

Fuse.Parameters = [<class 'ToolChain.Xilinx.ISE.Fuse.Executable'>, <class 'ToolChain.Xilinx.ISE.Fuse.FlagIncremental'>, <class 'ToolChain.Xilinx.ISE.Fuse.FlagRangeCheck'>, <class 'ToolChain.Xilinx.ISE.Fuse.SwitchMultiThreading'>, <class 'ToolChain.Xilinx.ISE.Fuse.SwitchTimeResolution'>, <class 'ToolChain.Xilinx.ISE.Fuse.SwitchProjectFile'>, <class 'ToolChain.Xilinx.ISE.Fuse.SwitchOutputFile'>, <class 'ToolChain.Xilinx.ISE.Fuse.ArgTopLevel'>]¶

Fuse.Link()[source]¶

Fuse.GetReader()¶

Fuse.HasErrors¶

True if errors or fatals errors were found while processing the output stream.

Fuse.HasWarnings¶

True if errors or fatals errors were found while processing the output stream.

Fuse.Log(entry, condition=True)¶

Write an entry to the local logger.

Fuse.LogDebug(*args, condition=True, **kwargs)¶

Fuse.LogDryRun(*args, condition=True, **kwargs)¶

Fuse.LogError(*args, condition=True, **kwargs)¶

Fuse.LogFatal(*args, condition=True, **kwargs)¶

Fuse.LogInfo(*args, condition=True, **kwargs)¶

Fuse.LogNormal(*args, condition=True, **kwargs)¶

Fuse.LogQuiet(*args, condition=True, **kwargs)¶

Fuse.LogVerbose(*args, condition=True, **kwargs)¶

Fuse.LogWarning(*args, condition=True, **kwargs)¶

Fuse.Logger¶

Return the local logger instance.

Fuse.Path¶

Fuse.ReadUntilBoundary(indent=0)¶

Fuse.Send(line, end='\n')¶

Fuse.SendBoundary()¶

Fuse.StartProcess(parameterList)¶

Fuse.Terminate()¶

Fuse._POC_BOUNDARY = '====== POC BOUNDARY ======'¶

Fuse._TryLog(*args, condition=True, **kwargs)¶

class ToolChain.Xilinx.ISE.ISESimulator(platform, dryrun, executablePath, environment, logger=None)[source]¶

Inheritance

Members

class Executable[source]¶

class ISESimulator.SwitchLogFile[source]¶

_name = 'log'¶

class ISESimulator.FlagGuiMode[source]¶

_name = 'gui'¶

class ISESimulator.SwitchTclBatchFile[source]¶

_name = 'tclbatch'¶

class ISESimulator.SwitchWaveformFile[source]¶

_name = 'view'¶

ISESimulator.Parameters = [<class 'ToolChain.Xilinx.ISE.ISESimulator.Executable'>, <class 'ToolChain.Xilinx.ISE.ISESimulator.SwitchLogFile'>, <class 'ToolChain.Xilinx.ISE.ISESimulator.FlagGuiMode'>, <class 'ToolChain.Xilinx.ISE.ISESimulator.SwitchTclBatchFile'>, <class 'ToolChain.Xilinx.ISE.ISESimulator.SwitchWaveformFile'>]¶

ISESimulator.Simulate()[source]¶

ISESimulator.GetReader()¶

ISESimulator.HasErrors¶

True if errors or fatals errors were found while processing the output stream.

ISESimulator.HasWarnings¶

True if errors or fatals errors were found while processing the output stream.

ISESimulator.Log(entry, condition=True)¶

Write an entry to the local logger.

ISESimulator.LogDebug(*args, condition=True, **kwargs)¶

ISESimulator.LogDryRun(*args, condition=True, **kwargs)¶

ISESimulator.LogError(*args, condition=True, **kwargs)¶

ISESimulator.LogFatal(*args, condition=True, **kwargs)¶

ISESimulator.LogInfo(*args, condition=True, **kwargs)¶

ISESimulator.LogNormal(*args, condition=True, **kwargs)¶

ISESimulator.LogQuiet(*args, condition=True, **kwargs)¶

ISESimulator.LogVerbose(*args, condition=True, **kwargs)¶

ISESimulator.LogWarning(*args, condition=True, **kwargs)¶

ISESimulator.Logger¶

Return the local logger instance.

ISESimulator.Path¶

ISESimulator.ReadUntilBoundary(indent=0)¶

ISESimulator.Send(line, end='\n')¶

ISESimulator.SendBoundary()¶

ISESimulator.StartProcess(parameterList)¶

ISESimulator.Terminate()¶

ISESimulator._POC_BOUNDARY = '====== POC BOUNDARY ======'¶

ISESimulator._TryLog(*args, condition=True, **kwargs)¶

class ToolChain.Xilinx.ISE.Xst(toolchain: ToolChain.ToolMixIn)[source]¶

Inheritance

Members

class Executable[source]¶

class Xst.SwitchIntStyle[source]¶

_name = 'intstyle'¶

class Xst.SwitchXstFile[source]¶

_name = 'ifn'¶

class Xst.SwitchReportFile[source]¶

_name = 'ofn'¶

Xst.Parameters = [<class 'ToolChain.Xilinx.ISE.Xst.Executable'>, <class 'ToolChain.Xilinx.ISE.Xst.SwitchIntStyle'>, <class 'ToolChain.Xilinx.ISE.Xst.SwitchXstFile'>, <class 'ToolChain.Xilinx.ISE.Xst.SwitchReportFile'>]¶

Xst.Compile()[source]¶

Xst.GetReader()¶

Xst.HasErrors¶

True if errors or fatals errors were found while processing the output stream.

Xst.HasWarnings¶

True if errors or fatals errors were found while processing the output stream.

Xst.Log(entry, condition=True)¶

Write an entry to the local logger.

Xst.LogDebug(*args, condition=True, **kwargs)¶

Xst.LogDryRun(*args, condition=True, **kwargs)¶

Xst.LogError(*args, condition=True, **kwargs)¶

Xst.LogFatal(*args, condition=True, **kwargs)¶

Xst.LogInfo(*args, condition=True, **kwargs)¶

Xst.LogNormal(*args, condition=True, **kwargs)¶

Xst.LogQuiet(*args, condition=True, **kwargs)¶

Xst.LogVerbose(*args, condition=True, **kwargs)¶

Xst.LogWarning(*args, condition=True, **kwargs)¶

Xst.Logger¶

Return the local logger instance.

Xst.Path¶

Xst.ReadUntilBoundary(indent=0)¶

Xst.Send(line, end='\n')¶

Xst.SendBoundary()¶

Xst.StartProcess(parameterList)¶

Xst.Terminate()¶

Xst._POC_BOUNDARY = '====== POC BOUNDARY ======'¶

Xst._TryLog(*args, condition=True, **kwargs)¶

class ToolChain.Xilinx.ISE.CoreGenerator(toolchain: ToolChain.ToolMixIn)[source]¶

Inheritance

Members

class Executable[source]¶

class CoreGenerator.FlagRegenerate[source]¶

_name = 'r'¶

class CoreGenerator.SwitchProjectFile[source]¶

_name = 'p'¶

class CoreGenerator.SwitchBatchFile[source]¶

_name = 'b'¶

CoreGenerator.Parameters = [<class 'ToolChain.Xilinx.ISE.CoreGenerator.Executable'>, <class 'ToolChain.Xilinx.ISE.CoreGenerator.FlagRegenerate'>, <class 'ToolChain.Xilinx.ISE.CoreGenerator.SwitchProjectFile'>, <class 'ToolChain.Xilinx.ISE.CoreGenerator.SwitchBatchFile'>]¶

CoreGenerator.Generate()[source]¶

CoreGenerator.GetReader()¶

CoreGenerator.HasErrors¶

True if errors or fatals errors were found while processing the output stream.

CoreGenerator.HasWarnings¶

True if errors or fatals errors were found while processing the output stream.

CoreGenerator.Log(entry, condition=True)¶

Write an entry to the local logger.

CoreGenerator.LogDebug(*args, condition=True, **kwargs)¶

CoreGenerator.LogDryRun(*args, condition=True, **kwargs)¶

CoreGenerator.LogError(*args, condition=True, **kwargs)¶

CoreGenerator.LogFatal(*args, condition=True, **kwargs)¶

CoreGenerator.LogInfo(*args, condition=True, **kwargs)¶

CoreGenerator.LogNormal(*args, condition=True, **kwargs)¶

CoreGenerator.LogQuiet(*args, condition=True, **kwargs)¶

CoreGenerator.LogVerbose(*args, condition=True, **kwargs)¶

CoreGenerator.LogWarning(*args, condition=True, **kwargs)¶

CoreGenerator.Logger¶

Return the local logger instance.

CoreGenerator.Path¶

CoreGenerator.ReadUntilBoundary(indent=0)¶

CoreGenerator.Send(line, end='\n')¶

CoreGenerator.SendBoundary()¶

CoreGenerator.StartProcess(parameterList)¶

CoreGenerator.Terminate()¶

CoreGenerator._POC_BOUNDARY = '====== POC BOUNDARY ======'¶

CoreGenerator._TryLog(*args, condition=True, **kwargs)¶

class ToolChain.Xilinx.ISE.ISEProject(name)[source]¶

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 ToolChain.Xilinx.ISE.ISEProjectFile(file)[source]¶

Inheritance

Members

FileName¶

FileSet¶

FileType¶

Open()¶

Path¶

Project¶

ReadFile()¶

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

_ReadContent()¶

class ToolChain.Xilinx.ISE.UserConstraintFile(file, project=None, fileSet=None)[source]¶

Inheritance

Members

FileName¶

FileSet¶

FileType¶

Open()¶

Path¶

Project¶

ReadFile()¶

_ReadContent()¶

_FileType = <FileTypes.UcfConstraintFile bits=0x0400 data=UNDEFINED>¶

Functions

ToolChain.Xilinx.ISE.VhCompFilter(gen)[source]¶

ToolChain.Xilinx.ISE.FuseFilter(gen)[source]¶

ToolChain.Xilinx.ISE.SimulatorFilter(gen)[source]¶

ToolChain.Xilinx.ISE.XstFilter(gen)[source]¶

ToolChain.Xilinx.ISE.CoreGeneratorFilter(gen)[source]¶