ToolChain.Intel.Quartus

Exceptions

Classes

  • Configuration: Base class for all tool Configuration classes.
  • Quartus: Undocumented.
  • Map: Represent an executable.
exception ToolChain.Intel.Quartus.QuartusException(message='')[source]

Inheritance

Inheritance diagram of QuartusException

Members

__init__(message='')

Exception initializer

Parameters:message (str) – The exception message.
__str__()

Returns the exception’s message text.

args
class ToolChain.Intel.Quartus.Configuration(host: Base.IHost)[source]

Inheritance

Inheritance diagram of Configuration

Members

_vendor = 'Intel'

The name of the tools vendor.

_toolName = 'Intel Quartus'

The name of the tool.

_section = 'INSTALL.Intel.Quartus'

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

_multiVersionSupport = True

Intel Quartus supports multiple versions installed on the same system.

_template = {'Windows': {'INSTALL.Intel.Quartus': {'Version': '16.1', 'SectionName': ('%{PathWithRoot}#${Version}', None), 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '${INSTALL.Intel:InstallationDirectory}/${Version}/quartus'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/bin64')}}, 'Linux': {'INSTALL.Intel.Quartus': {'Version': '16.1', 'SectionName': ('%{PathWithRoot}#${Version}', None), 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '${INSTALL.Intel:InstallationDirectory}/${Version}/quartus'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/bin')}}}

The template for the configuration sections represented as nested dictionaries.

CheckDependency()[source]

Check if general Intel 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__CheckQuartusVersion(binPath, version)
_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.Intel.Quartus.Quartus(platform, dryrun, binaryDirectoryPath, version, logger=None)[source]

Inheritance

Inheritance diagram of Quartus

Members

GetMap()[source]
GetTclShell()[source]
class ToolChain.Intel.Quartus.Map(toolchain: ToolChain.ToolMixIn)[source]

Inheritance

Inheritance diagram of Map

Members

class ArgProjectName[source]
Map.Compile()[source]
class Map.Executable[source]
Map.GetReader()
Map.HasErrors

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

Map.HasWarnings

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

Map.Log(entry, condition=True)

Write an entry to the local logger.

Map.LogDebug(*args, condition=True, **kwargs)
Map.LogDryRun(*args, condition=True, **kwargs)
Map.LogError(*args, condition=True, **kwargs)
Map.LogFatal(*args, condition=True, **kwargs)
Map.LogInfo(*args, condition=True, **kwargs)
Map.LogNormal(*args, condition=True, **kwargs)
Map.LogQuiet(*args, condition=True, **kwargs)
Map.LogVerbose(*args, condition=True, **kwargs)
Map.LogWarning(*args, condition=True, **kwargs)
Map.Logger

Return the local logger instance.

Map.Parameters = [<class 'ToolChain.Altera.Quartus.Map.Executable'>, <class 'ToolChain.Altera.Quartus.Map.ArgProjectName'>, <class 'ToolChain.Altera.Quartus.Map.SwitchArgumentFile'>, <class 'ToolChain.Altera.Quartus.Map.SwitchDeviceFamily'>, <class 'ToolChain.Altera.Quartus.Map.SwitchDevicePart'>]
Map.Path
Map.ReadUntilBoundary(indent=0)
Map.Send(line, end='\n')
Map.SendBoundary()
Map.StartProcess(parameterList)
class Map.SwitchArgumentFile[source]
_name = 'f'
class Map.SwitchDeviceFamily[source]
_name = 'family'
class Map.SwitchDevicePart[source]
_name = 'part'
Map.Terminate()
Map._POC_BOUNDARY = '====== POC BOUNDARY ======'
Map._TryLog(*args, condition=True, **kwargs)