circt::firtool::FirtoolOptions Class Reference

Set of options used to control the behavior of the firtool pipeline. More...

#include <Firtool.h>

Collaboration diagram for circt::firtool::FirtoolOptions:

Public Types
enum	BuildMode { BuildModeDefault , BuildModeDebug , BuildModeRelease }
enum class	RandomKind { None , Mem , Reg , All }
enum class	DomainMode { Disable , Check , Infer , InferAll }

Public Member Functions
	FirtoolOptions ()
bool	isRandomEnabled (RandomKind kind) const
FirtoolOptions &	mergeDisableRandom (RandomKind kind)
firrtl::PreserveValues::PreserveMode	getPreserveMode () const
StringRef	getOutputFilename () const
StringRef	getBlackBoxRootPath () const
StringRef	getReplaceSequentialMemoriesFile () const
StringRef	getOutputAnnotationFilename () const
firrtl::PreserveAggregate::PreserveMode	getPreserveAggregate () const
firrtl::CompanionMode	getCompanionMode () const
bool	getNoViews () const
seq::ExternalizeClockGateOptions	getClockGateOptions () const
FirtoolOptions &	setClockGateOptions (seq::ExternalizeClockGateOptions &opts)
bool	isDefaultOutputFilename () const
bool	shouldDisableUnknownAnnotations () const
bool	shouldDisableClasslessAnnotations () const
bool	shouldLowerNoRefTypePortAnnotations () const
bool	shouldConvertProbesToSignals () const
bool	shouldReplaceSequentialMemories () const
bool	shouldDisableLayerSink () const
bool	shouldDisableOptimization () const
bool	shouldLowerMemories () const
bool	shouldDedup () const
bool	shouldDedupClasses () const
bool	shouldEnableDebugInfo () const
bool	shouldIgnoreReadEnableMemories () const
bool	shouldConvertVecOfBundle () const
bool	shouldStripDebugInfo () const
bool	shouldStripFirDebugInfo () const
bool	shouldExportModuleHierarchy () const
bool	shouldDisableAggressiveMergeConnections () const
bool	shouldEnableAnnotationWarning () const
bool	shouldWarnOnTruncation () const
bool	shouldLowerToCore () const
auto	getVerificationFlavor () const
bool	shouldEmitSeparateAlwaysBlocks () const
bool	shouldAddMuxPragmas () const
bool	shouldAddVivadoRAMAddressConflictSynthesisBugWorkaround () const
bool	shouldFixupEICGWrapper () const
bool	shouldDisableCSEinClasses () const
bool	shouldSelectDefaultInstanceChoice () const
verif::SymbolicValueLowering	getSymbolicValueLowering () const
bool	shouldDisableWireElimination () const
bool	getLintStaticAsserts () const
bool	getLintXmrsInDesign () const
bool	getEmitAllBindFiles () const
bool	shouldInlineInputOnlyModules () const
DomainMode	getDomainMode () const
bool	shouldStripDomain () const
ArrayRef< std::string >	getSkippedDomains () const
FirtoolOptions &	setOutputFilename (StringRef name)
FirtoolOptions &	setDisableUnknownAnnotations (bool disable)
FirtoolOptions &	setDisableAnnotationsClassless (bool value)
FirtoolOptions &	setLowerAnnotationsNoRefTypePorts (bool value)
FirtoolOptions &	setConvertProbesToSignals (bool value)
FirtoolOptions &	setPreserveAggregate (firrtl::PreserveAggregate::PreserveMode value)
FirtoolOptions &	setPreserveValues (firrtl::PreserveValues::PreserveMode value)
FirtoolOptions &	setEnableDebugInfo (bool value)
FirtoolOptions &	setBuildMode (BuildMode value)
FirtoolOptions &	setDisableLayerSink (bool value)
FirtoolOptions &	setDisableOptimization (bool value)
FirtoolOptions &	setVbToBV (bool value)
FirtoolOptions &	setNoDedup (bool value)
FirtoolOptions &	setDedupClasses (bool value)
FirtoolOptions &	setCompanionMode (firrtl::CompanionMode value)
FirtoolOptions &	setNoViews (bool value)
FirtoolOptions &	setDisableAggressiveMergeConnections (bool value)
FirtoolOptions &	setLowerMemories (bool value)
FirtoolOptions &	setBlackBoxRootPath (StringRef value)
FirtoolOptions &	setReplSeqMem (bool value)
FirtoolOptions &	setReplSeqMemFile (StringRef value)
FirtoolOptions &	setIgnoreReadEnableMem (bool value)
FirtoolOptions &	setOutputAnnotationFilename (StringRef value)
FirtoolOptions &	setEnableAnnotationWarning (bool value)
FirtoolOptions &	setWarnOnTruncation (bool value)
FirtoolOptions &	setLowerToCore (bool value)
FirtoolOptions &	setAddMuxPragmas (bool value)
FirtoolOptions &	setVerificationFlavor (firrtl::VerificationFlavor value)
FirtoolOptions &	setEmitSeparateAlwaysBlocks (bool value)
FirtoolOptions &	setAddVivadoRAMAddressConflictSynthesisBugWorkaround (bool value)
FirtoolOptions &	setCkgModuleName (StringRef value)
FirtoolOptions &	setCkgInputName (StringRef value)
FirtoolOptions &	setCkgOutputName (StringRef value)
FirtoolOptions &	setCkgEnableName (StringRef value)
FirtoolOptions &	setCkgTestEnableName (StringRef value)
FirtoolOptions &	setExportModuleHierarchy (bool value)
FirtoolOptions &	setStripFirDebugInfo (bool value)
FirtoolOptions &	setStripDebugInfo (bool value)
FirtoolOptions &	setFixupEICGWrapper (bool value)
FirtoolOptions &	setDisableCSEinClasses (bool value)
FirtoolOptions &	setSelectDefaultInstanceChoice (bool value)
FirtoolOptions &	setSymbolicValueLowering (verif::SymbolicValueLowering mode)
FirtoolOptions &	setDisableWireElimination (bool value)
FirtoolOptions &	setLintStaticAsserts (bool value)
FirtoolOptions &	setLintXmrsInDesign (bool value)
FirtoolOptions &	setEmitAllBindFiles (bool value)
FirtoolOptions &	setInlineInputOnlyModules (bool value)
FirtoolOptions &	setDomainMode (DomainMode value)
FirtoolOptions &	setStripDomain (bool value)

Static Public Member Functions
static constexpr std::optional< firrtl::InferDomainsMode >	toInferDomainsPassMode (DomainMode mode)
	Convert the "domain mode" firtool option to a "firrtl::InferDomainsMode", the configuration for a pass.
static RandomKind	mergeRandomKind (RandomKind current, RandomKind incoming)
	Advance the disabled-randomization lattice.

Private Attributes
std::string	outputFilename
bool	disableAnnotationsUnknown
bool	disableAnnotationsClassless
bool	lowerAnnotationsNoRefTypePorts
bool	probesToSignals
firrtl::PreserveAggregate::PreserveMode	preserveAggregate
firrtl::PreserveValues::PreserveMode	preserveMode
bool	enableDebugInfo
BuildMode	buildMode
bool	disableLayerSink
bool	disableOptimization
bool	vbToBV
bool	noDedup
bool	dedupClasses
firrtl::CompanionMode	companionMode
bool	noViews
bool	disableAggressiveMergeConnections
bool	lowerMemories
std::string	blackBoxRootPath
bool	replSeqMem
std::string	replSeqMemFile
bool	ignoreReadEnableMem
RandomKind	disableRandom
std::string	outputAnnotationFilename
bool	enableAnnotationWarning
bool	warnOnTruncation
bool	lowerToCore
bool	addMuxPragmas
firrtl::VerificationFlavor	verificationFlavor
bool	emitSeparateAlwaysBlocks
bool	addVivadoRAMAddressConflictSynthesisBugWorkaround
std::string	ckgModuleName
std::string	ckgInputName
std::string	ckgOutputName
std::string	ckgEnableName
std::string	ckgTestEnableName
std::string	ckgInstName
bool	exportModuleHierarchy
bool	stripFirDebugInfo
bool	stripDebugInfo
bool	fixupEICGWrapper
bool	disableCSEinClasses
bool	selectDefaultInstanceChoice
verif::SymbolicValueLowering	symbolicValueLowering
bool	disableWireElimination
bool	lintStaticAsserts
bool	lintXmrsInDesign
bool	emitAllBindFiles
bool	inlineInputOnlyModules
DomainMode	domainMode
bool	stripDomain
SmallVector< std::string >	skippedDomains

Detailed Description

Set of options used to control the behavior of the firtool pipeline.

Definition at line 32 of file Firtool.h.

Member Enumeration Documentation

BuildMode

enum circt::firtool::FirtoolOptions::BuildMode

Enumerator
BuildModeDefault
BuildModeDebug
BuildModeRelease

Definition at line 37 of file Firtool.h.

DomainMode

enum class circt::firtool::FirtoolOptions::DomainMode

strong

Enumerator
Disable	Disable domain checking.
Check	Check domains without inference.
Infer	Check domains with inference for private modules.
InferAll	Check domains with inference for both public and private modules.

Definition at line 40 of file Firtool.h.

RandomKind

enum class circt::firtool::FirtoolOptions::RandomKind

strong

Enumerator
None
Mem
Reg
All

Definition at line 38 of file Firtool.h.

Constructor & Destructor Documentation

FirtoolOptions()

circt::firtool::FirtoolOptions::FirtoolOptions

(

)

Definition at line 865 of file Firtool.cpp.

References addMuxPragmas, addVivadoRAMAddressConflictSynthesisBugWorkaround, blackBoxRootPath, buildMode, ckgEnableName, ckgInputName, ckgModuleName, ckgOutputName, ckgTestEnableName, clOptions, companionMode, dedupClasses, disableAggressiveMergeConnections, disableAnnotationsClassless, disableAnnotationsUnknown, disableLayerSink, disableOptimization, disableRandom, disableWireElimination, domainMode, emitAllBindFiles, emitSeparateAlwaysBlocks, enableAnnotationWarning, enableDebugInfo, exportModuleHierarchy, fixupEICGWrapper, ignoreReadEnableMem, inlineInputOnlyModules, lintStaticAsserts, lintXmrsInDesign, lowerAnnotationsNoRefTypePorts, lowerMemories, lowerToCore, noDedup, noViews, outputAnnotationFilename, outputFilename, preserveAggregate, preserveMode, probesToSignals, replSeqMem, replSeqMemFile, selectDefaultInstanceChoice, skippedDomains, stripDebugInfo, stripDomain, stripFirDebugInfo, symbolicValueLowering, vbToBV, verificationFlavor, and warnOnTruncation.

Member Function Documentation

getBlackBoxRootPath()

StringRef circt::firtool::FirtoolOptions::getBlackBoxRootPath ( ) const

inline

Definition at line 99 of file Firtool.h.

References blackBoxRootPath.

Referenced by circt::firtool::populateLowFIRRTLToHW().

getClockGateOptions()

seq::ExternalizeClockGateOptions circt::firtool::FirtoolOptions::getClockGateOptions ( ) const

inline

Definition at line 112 of file Firtool.h.

References ckgEnableName, ckgInputName, ckgInstName, ckgModuleName, ckgOutputName, and ckgTestEnableName.

Referenced by circt::firtool::populateHWToSV().

getCompanionMode()

firrtl::CompanionMode circt::firtool::FirtoolOptions::getCompanionMode ( ) const

inline

Definition at line 108 of file Firtool.h.

References companionMode.

Referenced by circt::firtool::populateLowFIRRTLToHW().

getDomainMode()

DomainMode circt::firtool::FirtoolOptions::getDomainMode ( ) const

inline

Definition at line 183 of file Firtool.h.

References domainMode.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

getEmitAllBindFiles()

bool circt::firtool::FirtoolOptions::getEmitAllBindFiles ( ) const

inline

Definition at line 179 of file Firtool.h.

References emitAllBindFiles.

Referenced by circt::firtool::populateLowFIRRTLToHW().

getLintStaticAsserts()

bool circt::firtool::FirtoolOptions::getLintStaticAsserts ( ) const

inline

Definition at line 175 of file Firtool.h.

References lintStaticAsserts.

Referenced by circt::firtool::populateLowFIRRTLToHW().

getLintXmrsInDesign()

bool circt::firtool::FirtoolOptions::getLintXmrsInDesign ( ) const

inline

Definition at line 177 of file Firtool.h.

References lintXmrsInDesign.

Referenced by circt::firtool::populateLowFIRRTLToHW().

getNoViews()

bool circt::firtool::FirtoolOptions::getNoViews ( ) const

inline

Definition at line 110 of file Firtool.h.

References noViews.

Referenced by circt::firtool::populateLowFIRRTLToHW().

getOutputAnnotationFilename()

StringRef circt::firtool::FirtoolOptions::getOutputAnnotationFilename ( ) const

inline

Definition at line 101 of file Firtool.h.

References outputAnnotationFilename.

Referenced by circt::firtool::populateLowFIRRTLToHW().

getOutputFilename()

StringRef circt::firtool::FirtoolOptions::getOutputFilename ( ) const

inline

Definition at line 98 of file Firtool.h.

References outputFilename.

Referenced by circt::firtool::populateLowFIRRTLToHW().

getPreserveAggregate()

firrtl::PreserveAggregate::PreserveMode circt::firtool::FirtoolOptions::getPreserveAggregate ( ) const

inline

Definition at line 105 of file Firtool.h.

References preserveAggregate.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

getPreserveMode()

firrtl::PreserveValues::PreserveMode circt::firtool::FirtoolOptions::getPreserveMode ( ) const

inline

Definition at line 86 of file Firtool.h.

References buildMode, BuildModeDebug, BuildModeDefault, BuildModeRelease, circt::firrtl::PreserveValues::Named, circt::firrtl::PreserveValues::None, and preserveMode.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

getReplaceSequentialMemoriesFile()

StringRef circt::firtool::FirtoolOptions::getReplaceSequentialMemoriesFile ( ) const

inline

Definition at line 100 of file Firtool.h.

References replSeqMemFile.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

getSkippedDomains()

ArrayRef< std::string > circt::firtool::FirtoolOptions::getSkippedDomains ( ) const

inline

Definition at line 187 of file Firtool.h.

References skippedDomains.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

getSymbolicValueLowering()

verif::SymbolicValueLowering circt::firtool::FirtoolOptions::getSymbolicValueLowering ( ) const

inline

Definition at line 170 of file Firtool.h.

References symbolicValueLowering.

Referenced by circt::firtool::populateHWToSV().

getVerificationFlavor()

auto circt::firtool::FirtoolOptions::getVerificationFlavor ( ) const

inline

Definition at line 156 of file Firtool.h.

References verificationFlavor.

Referenced by circt::firtool::populateLowFIRRTLToHW().

isDefaultOutputFilename()

bool circt::firtool::FirtoolOptions::isDefaultOutputFilename ( ) const

inline

Definition at line 127 of file Firtool.h.

References outputFilename.

isRandomEnabled()

bool circt::firtool::FirtoolOptions::isRandomEnabled ( RandomKind  kind ) const

inline

Definition at line 67 of file Firtool.h.

References All, and disableRandom.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL(), and circt::firtool::populateHWToSV().

mergeDisableRandom()

FirtoolOptions & circt::firtool::FirtoolOptions::mergeDisableRandom ( RandomKind  kind )

inline

Definition at line 81 of file Firtool.h.

References disableRandom, and mergeRandomKind().

mergeRandomKind()

static RandomKind circt::firtool::FirtoolOptions::mergeRandomKind ( RandomKind  current, RandomKind  incoming  )

inlinestatic

Advance the disabled-randomization lattice.

Calling this twice with the two individual kinds is equivalent to calling it once with All.

Definition at line 73 of file Firtool.h.

References All, and None.

Referenced by mergeDisableRandom().

setAddMuxPragmas()

FirtoolOptions & circt::firtool::FirtoolOptions::setAddMuxPragmas ( bool  value )

inline

Definition at line 322 of file Firtool.h.

References addMuxPragmas.

setAddVivadoRAMAddressConflictSynthesisBugWorkaround()

FirtoolOptions & circt::firtool::FirtoolOptions::setAddVivadoRAMAddressConflictSynthesisBugWorkaround ( bool  value )

inline

Definition at line 338 of file Firtool.h.

References addVivadoRAMAddressConflictSynthesisBugWorkaround.

setBlackBoxRootPath()

FirtoolOptions & circt::firtool::FirtoolOptions::setBlackBoxRootPath ( StringRef  value )

inline

Definition at line 282 of file Firtool.h.

References blackBoxRootPath.

setBuildMode()

FirtoolOptions & circt::firtool::FirtoolOptions::setBuildMode ( BuildMode  value )

inline

Definition at line 232 of file Firtool.h.

References buildMode.

setCkgEnableName()

FirtoolOptions & circt::firtool::FirtoolOptions::setCkgEnableName ( StringRef  value )

inline

Definition at line 358 of file Firtool.h.

References ckgEnableName.

setCkgInputName()

FirtoolOptions & circt::firtool::FirtoolOptions::setCkgInputName ( StringRef  value )

inline

Definition at line 348 of file Firtool.h.

References ckgInputName.

setCkgModuleName()

FirtoolOptions & circt::firtool::FirtoolOptions::setCkgModuleName ( StringRef  value )

inline

Definition at line 343 of file Firtool.h.

References ckgModuleName.

setCkgOutputName()

FirtoolOptions & circt::firtool::FirtoolOptions::setCkgOutputName ( StringRef  value )

inline

Definition at line 353 of file Firtool.h.

References ckgOutputName.

setCkgTestEnableName()

FirtoolOptions & circt::firtool::FirtoolOptions::setCkgTestEnableName ( StringRef  value )

inline

Definition at line 363 of file Firtool.h.

References ckgTestEnableName.

setClockGateOptions()

FirtoolOptions & circt::firtool::FirtoolOptions::setClockGateOptions ( seq::ExternalizeClockGateOptions &  opts )

inline

Definition at line 117 of file Firtool.h.

References ckgEnableName, ckgInputName, ckgInstName, ckgModuleName, ckgOutputName, and ckgTestEnableName.

setCompanionMode()

FirtoolOptions & circt::firtool::FirtoolOptions::setCompanionMode ( firrtl::CompanionMode  value )

inline

Definition at line 262 of file Firtool.h.

References companionMode.

setConvertProbesToSignals()

FirtoolOptions & circt::firtool::FirtoolOptions::setConvertProbesToSignals ( bool  value )

inline

Definition at line 210 of file Firtool.h.

References probesToSignals.

setDedupClasses()

FirtoolOptions & circt::firtool::FirtoolOptions::setDedupClasses ( bool  value )

inline

Definition at line 257 of file Firtool.h.

References dedupClasses.

setDisableAggressiveMergeConnections()

FirtoolOptions & circt::firtool::FirtoolOptions::setDisableAggressiveMergeConnections ( bool  value )

inline

Definition at line 272 of file Firtool.h.

References disableAggressiveMergeConnections.

setDisableAnnotationsClassless()

FirtoolOptions & circt::firtool::FirtoolOptions::setDisableAnnotationsClassless ( bool  value )

inline

Definition at line 200 of file Firtool.h.

References disableAnnotationsClassless.

setDisableCSEinClasses()

FirtoolOptions & circt::firtool::FirtoolOptions::setDisableCSEinClasses ( bool  value )

inline

Definition at line 388 of file Firtool.h.

References disableCSEinClasses.

setDisableLayerSink()

FirtoolOptions & circt::firtool::FirtoolOptions::setDisableLayerSink ( bool  value )

inline

Definition at line 237 of file Firtool.h.

References disableLayerSink.

setDisableOptimization()

FirtoolOptions & circt::firtool::FirtoolOptions::setDisableOptimization ( bool  value )

inline

Definition at line 242 of file Firtool.h.

References disableOptimization.

setDisableUnknownAnnotations()

FirtoolOptions & circt::firtool::FirtoolOptions::setDisableUnknownAnnotations ( bool  disable )

inline

Definition at line 195 of file Firtool.h.

References disableAnnotationsUnknown.

setDisableWireElimination()

FirtoolOptions & circt::firtool::FirtoolOptions::setDisableWireElimination ( bool  value )

inline

Definition at line 403 of file Firtool.h.

References disableWireElimination.

setDomainMode()

FirtoolOptions & circt::firtool::FirtoolOptions::setDomainMode ( DomainMode  value )

inline

Definition at line 428 of file Firtool.h.

References domainMode.

setEmitAllBindFiles()

FirtoolOptions & circt::firtool::FirtoolOptions::setEmitAllBindFiles ( bool  value )

inline

Definition at line 418 of file Firtool.h.

References emitAllBindFiles.

setEmitSeparateAlwaysBlocks()

FirtoolOptions & circt::firtool::FirtoolOptions::setEmitSeparateAlwaysBlocks ( bool  value )

inline

Definition at line 332 of file Firtool.h.

References emitSeparateAlwaysBlocks.

setEnableAnnotationWarning()

FirtoolOptions & circt::firtool::FirtoolOptions::setEnableAnnotationWarning ( bool  value )

inline

Definition at line 307 of file Firtool.h.

References enableAnnotationWarning.

setEnableDebugInfo()

FirtoolOptions & circt::firtool::FirtoolOptions::setEnableDebugInfo ( bool  value )

inline

Definition at line 227 of file Firtool.h.

References enableDebugInfo.

setExportModuleHierarchy()

FirtoolOptions & circt::firtool::FirtoolOptions::setExportModuleHierarchy ( bool  value )

inline

Definition at line 368 of file Firtool.h.

References exportModuleHierarchy.

setFixupEICGWrapper()

FirtoolOptions & circt::firtool::FirtoolOptions::setFixupEICGWrapper ( bool  value )

inline

Definition at line 383 of file Firtool.h.

References fixupEICGWrapper.

setIgnoreReadEnableMem()

FirtoolOptions & circt::firtool::FirtoolOptions::setIgnoreReadEnableMem ( bool  value )

inline

Definition at line 297 of file Firtool.h.

References ignoreReadEnableMem.

setInlineInputOnlyModules()

FirtoolOptions & circt::firtool::FirtoolOptions::setInlineInputOnlyModules ( bool  value )

inline

Definition at line 423 of file Firtool.h.

References inlineInputOnlyModules.

setLintStaticAsserts()

FirtoolOptions & circt::firtool::FirtoolOptions::setLintStaticAsserts ( bool  value )

inline

Definition at line 408 of file Firtool.h.

References lintStaticAsserts.

setLintXmrsInDesign()

FirtoolOptions & circt::firtool::FirtoolOptions::setLintXmrsInDesign ( bool  value )

inline

Definition at line 413 of file Firtool.h.

References lintXmrsInDesign.

setLowerAnnotationsNoRefTypePorts()

FirtoolOptions & circt::firtool::FirtoolOptions::setLowerAnnotationsNoRefTypePorts ( bool  value )

inline

Definition at line 205 of file Firtool.h.

References lowerAnnotationsNoRefTypePorts.

setLowerMemories()

FirtoolOptions & circt::firtool::FirtoolOptions::setLowerMemories ( bool  value )

inline

Definition at line 277 of file Firtool.h.

References lowerMemories.

setLowerToCore()

FirtoolOptions & circt::firtool::FirtoolOptions::setLowerToCore ( bool  value )

inline

Definition at line 317 of file Firtool.h.

References lowerToCore.

setNoDedup()

FirtoolOptions & circt::firtool::FirtoolOptions::setNoDedup ( bool  value )

inline

Definition at line 252 of file Firtool.h.

References noDedup.

setNoViews()

FirtoolOptions & circt::firtool::FirtoolOptions::setNoViews ( bool  value )

inline

Definition at line 267 of file Firtool.h.

References noViews.

setOutputAnnotationFilename()

FirtoolOptions & circt::firtool::FirtoolOptions::setOutputAnnotationFilename ( StringRef  value )

inline

Definition at line 302 of file Firtool.h.

References outputAnnotationFilename.

setOutputFilename()

FirtoolOptions & circt::firtool::FirtoolOptions::setOutputFilename ( StringRef  name )

inline

Definition at line 190 of file Firtool.h.

References outputFilename.

setPreserveAggregate()

FirtoolOptions & circt::firtool::FirtoolOptions::setPreserveAggregate ( firrtl::PreserveAggregate::PreserveMode  value )

inline

Definition at line 216 of file Firtool.h.

References preserveAggregate.

setPreserveValues()

FirtoolOptions & circt::firtool::FirtoolOptions::setPreserveValues ( firrtl::PreserveValues::PreserveMode  value )

inline

Definition at line 222 of file Firtool.h.

References preserveMode.

setReplSeqMem()

FirtoolOptions & circt::firtool::FirtoolOptions::setReplSeqMem ( bool  value )

inline

Definition at line 287 of file Firtool.h.

References replSeqMem.

setReplSeqMemFile()

FirtoolOptions & circt::firtool::FirtoolOptions::setReplSeqMemFile ( StringRef  value )

inline

Definition at line 292 of file Firtool.h.

References replSeqMemFile.

setSelectDefaultInstanceChoice()

FirtoolOptions & circt::firtool::FirtoolOptions::setSelectDefaultInstanceChoice ( bool  value )

inline

Definition at line 393 of file Firtool.h.

References selectDefaultInstanceChoice.

setStripDebugInfo()

FirtoolOptions & circt::firtool::FirtoolOptions::setStripDebugInfo ( bool  value )

inline

Definition at line 378 of file Firtool.h.

References stripDebugInfo.

setStripDomain()

FirtoolOptions & circt::firtool::FirtoolOptions::setStripDomain ( bool  value )

inline

Definition at line 433 of file Firtool.h.

References stripDomain.

setStripFirDebugInfo()

FirtoolOptions & circt::firtool::FirtoolOptions::setStripFirDebugInfo ( bool  value )

inline

Definition at line 373 of file Firtool.h.

References stripFirDebugInfo.

setSymbolicValueLowering()

FirtoolOptions & circt::firtool::FirtoolOptions::setSymbolicValueLowering ( verif::SymbolicValueLowering  mode )

inline

Definition at line 398 of file Firtool.h.

References symbolicValueLowering.

setVbToBV()

FirtoolOptions & circt::firtool::FirtoolOptions::setVbToBV ( bool  value )

inline

Definition at line 247 of file Firtool.h.

References vbToBV.

setVerificationFlavor()

FirtoolOptions & circt::firtool::FirtoolOptions::setVerificationFlavor ( firrtl::VerificationFlavor  value )

inline

Definition at line 327 of file Firtool.h.

References verificationFlavor.

setWarnOnTruncation()

FirtoolOptions & circt::firtool::FirtoolOptions::setWarnOnTruncation ( bool  value )

inline

Definition at line 312 of file Firtool.h.

References warnOnTruncation.

shouldAddMuxPragmas()

bool circt::firtool::FirtoolOptions::shouldAddMuxPragmas ( ) const

inline

Definition at line 160 of file Firtool.h.

References addMuxPragmas.

Referenced by circt::firtool::populateHWToSV().

shouldAddVivadoRAMAddressConflictSynthesisBugWorkaround()

bool circt::firtool::FirtoolOptions::shouldAddVivadoRAMAddressConflictSynthesisBugWorkaround ( ) const

inline

Definition at line 161 of file Firtool.h.

References addVivadoRAMAddressConflictSynthesisBugWorkaround.

Referenced by circt::firtool::populateHWToSV().

shouldConvertProbesToSignals()

bool circt::firtool::FirtoolOptions::shouldConvertProbesToSignals ( ) const

inline

Definition at line 137 of file Firtool.h.

References probesToSignals.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

shouldConvertVecOfBundle()

bool circt::firtool::FirtoolOptions::shouldConvertVecOfBundle ( ) const

inline

Definition at line 146 of file Firtool.h.

References vbToBV.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

shouldDedup()

bool circt::firtool::FirtoolOptions::shouldDedup ( ) const

inline

Definition at line 142 of file Firtool.h.

References noDedup.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

shouldDedupClasses()

bool circt::firtool::FirtoolOptions::shouldDedupClasses ( ) const

inline

Definition at line 143 of file Firtool.h.

References dedupClasses.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

shouldDisableAggressiveMergeConnections()

bool circt::firtool::FirtoolOptions::shouldDisableAggressiveMergeConnections ( ) const

inline

Definition at line 150 of file Firtool.h.

References disableAggressiveMergeConnections.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

shouldDisableClasslessAnnotations()

bool circt::firtool::FirtoolOptions::shouldDisableClasslessAnnotations ( ) const

inline

Definition at line 131 of file Firtool.h.

References disableAnnotationsClassless.

Referenced by circt::firtool::populatePreprocessTransforms().

shouldDisableCSEinClasses()

bool circt::firtool::FirtoolOptions::shouldDisableCSEinClasses ( ) const

inline

Definition at line 165 of file Firtool.h.

References disableCSEinClasses.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

shouldDisableLayerSink()

bool circt::firtool::FirtoolOptions::shouldDisableLayerSink ( ) const

inline

Definition at line 139 of file Firtool.h.

References disableLayerSink.

Referenced by circt::firtool::populateLowFIRRTLToHW().

shouldDisableOptimization()

bool circt::firtool::FirtoolOptions::shouldDisableOptimization ( ) const

inline

Definition at line 140 of file Firtool.h.

References disableOptimization.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL(), circt::firtool::populateHWToSV(), circt::firtool::populateLowFIRRTLToHW(), and detail::populatePrepareForExportVerilog().

shouldDisableUnknownAnnotations()

bool circt::firtool::FirtoolOptions::shouldDisableUnknownAnnotations ( ) const

inline

Definition at line 128 of file Firtool.h.

References disableAnnotationsUnknown.

Referenced by circt::firtool::populatePreprocessTransforms().

shouldDisableWireElimination()

bool circt::firtool::FirtoolOptions::shouldDisableWireElimination ( ) const

inline

Definition at line 173 of file Firtool.h.

References disableWireElimination.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

shouldEmitSeparateAlwaysBlocks()

bool circt::firtool::FirtoolOptions::shouldEmitSeparateAlwaysBlocks ( ) const

inline

Definition at line 157 of file Firtool.h.

References emitSeparateAlwaysBlocks.

Referenced by circt::firtool::populateHWToSV().

shouldEnableAnnotationWarning()

bool circt::firtool::FirtoolOptions::shouldEnableAnnotationWarning ( ) const

inline

Definition at line 153 of file Firtool.h.

References enableAnnotationWarning.

Referenced by circt::firtool::populateLowFIRRTLToHW().

shouldEnableDebugInfo()

bool circt::firtool::FirtoolOptions::shouldEnableDebugInfo ( ) const

inline

Definition at line 144 of file Firtool.h.

References enableDebugInfo.

Referenced by circt::firtool::populatePreprocessTransforms().

shouldExportModuleHierarchy()

bool circt::firtool::FirtoolOptions::shouldExportModuleHierarchy ( ) const

inline

Definition at line 149 of file Firtool.h.

References exportModuleHierarchy.

Referenced by detail::populatePrepareForExportVerilog().

shouldFixupEICGWrapper()

bool circt::firtool::FirtoolOptions::shouldFixupEICGWrapper ( ) const

inline

Definition at line 164 of file Firtool.h.

References fixupEICGWrapper.

Referenced by circt::firtool::populatePreprocessTransforms().

shouldIgnoreReadEnableMemories()

bool circt::firtool::FirtoolOptions::shouldIgnoreReadEnableMemories ( ) const

inline

Definition at line 145 of file Firtool.h.

References ignoreReadEnableMem.

Referenced by circt::firtool::populateHWToSV().

shouldInlineInputOnlyModules()

bool circt::firtool::FirtoolOptions::shouldInlineInputOnlyModules ( ) const

inline

Definition at line 181 of file Firtool.h.

References inlineInputOnlyModules.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

shouldLowerMemories()

bool circt::firtool::FirtoolOptions::shouldLowerMemories ( ) const

inline

Definition at line 141 of file Firtool.h.

References lowerMemories.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

shouldLowerNoRefTypePortAnnotations()

bool circt::firtool::FirtoolOptions::shouldLowerNoRefTypePortAnnotations ( ) const

inline

Definition at line 134 of file Firtool.h.

References lowerAnnotationsNoRefTypePorts.

Referenced by circt::firtool::populatePreprocessTransforms().

shouldLowerToCore()

bool circt::firtool::FirtoolOptions::shouldLowerToCore ( ) const

inline

Definition at line 155 of file Firtool.h.

References lowerToCore.

Referenced by circt::firtool::populateLowFIRRTLToHW().

shouldReplaceSequentialMemories()

bool circt::firtool::FirtoolOptions::shouldReplaceSequentialMemories ( ) const

inline

Definition at line 138 of file Firtool.h.

References replSeqMem.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL(), and circt::firtool::populateHWToSV().

shouldSelectDefaultInstanceChoice()

bool circt::firtool::FirtoolOptions::shouldSelectDefaultInstanceChoice ( ) const

inline

Definition at line 166 of file Firtool.h.

References selectDefaultInstanceChoice.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

shouldStripDebugInfo()

bool circt::firtool::FirtoolOptions::shouldStripDebugInfo ( ) const

inline

Definition at line 147 of file Firtool.h.

References stripDebugInfo.

Referenced by detail::populatePrepareForExportVerilog().

shouldStripDomain()

bool circt::firtool::FirtoolOptions::shouldStripDomain ( ) const

inline

Definition at line 185 of file Firtool.h.

References stripDomain.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

shouldStripFirDebugInfo()

bool circt::firtool::FirtoolOptions::shouldStripFirDebugInfo ( ) const

inline

Definition at line 148 of file Firtool.h.

References stripFirDebugInfo.

Referenced by detail::populatePrepareForExportVerilog().

shouldWarnOnTruncation()

bool circt::firtool::FirtoolOptions::shouldWarnOnTruncation ( ) const

inline

Definition at line 154 of file Firtool.h.

References warnOnTruncation.

Referenced by circt::firtool::populateCHIRRTLToLowFIRRTL().

toInferDomainsPassMode()

static constexpr std::optional< firrtl::InferDomainsMode > circt::firtool::FirtoolOptions::toInferDomainsPassMode ( DomainMode  mode )

inlinestaticconstexpr

Convert the "domain mode" firtool option to a "firrtl::InferDomainsMode", the configuration for a pass.

Definition at line 54 of file Firtool.h.

References circt::firrtl::Check, Check, Disable, circt::firrtl::Infer, Infer, circt::firrtl::InferAll, and InferAll.

Member Data Documentation

addMuxPragmas

bool circt::firtool::FirtoolOptions::addMuxPragmas

private

Definition at line 469 of file Firtool.h.

Referenced by FirtoolOptions(), setAddMuxPragmas(), and shouldAddMuxPragmas().

addVivadoRAMAddressConflictSynthesisBugWorkaround

bool circt::firtool::FirtoolOptions::addVivadoRAMAddressConflictSynthesisBugWorkaround

private

Definition at line 472 of file Firtool.h.

Referenced by FirtoolOptions(), setAddVivadoRAMAddressConflictSynthesisBugWorkaround(), and shouldAddVivadoRAMAddressConflictSynthesisBugWorkaround().

blackBoxRootPath

std::string circt::firtool::FirtoolOptions::blackBoxRootPath

private

Definition at line 460 of file Firtool.h.

Referenced by FirtoolOptions(), getBlackBoxRootPath(), and setBlackBoxRootPath().

buildMode

BuildMode circt::firtool::FirtoolOptions::buildMode

private

Definition at line 450 of file Firtool.h.

Referenced by FirtoolOptions(), getPreserveMode(), and setBuildMode().

ckgEnableName

std::string circt::firtool::FirtoolOptions::ckgEnableName

private

Definition at line 476 of file Firtool.h.

Referenced by FirtoolOptions(), getClockGateOptions(), setCkgEnableName(), and setClockGateOptions().

ckgInputName

std::string circt::firtool::FirtoolOptions::ckgInputName

private

Definition at line 474 of file Firtool.h.

Referenced by FirtoolOptions(), getClockGateOptions(), setCkgInputName(), and setClockGateOptions().

ckgInstName

std::string circt::firtool::FirtoolOptions::ckgInstName

private

Definition at line 478 of file Firtool.h.

Referenced by getClockGateOptions(), and setClockGateOptions().

ckgModuleName

std::string circt::firtool::FirtoolOptions::ckgModuleName

private

Definition at line 473 of file Firtool.h.

Referenced by FirtoolOptions(), getClockGateOptions(), setCkgModuleName(), and setClockGateOptions().

ckgOutputName

std::string circt::firtool::FirtoolOptions::ckgOutputName

private

Definition at line 475 of file Firtool.h.

Referenced by FirtoolOptions(), getClockGateOptions(), setCkgOutputName(), and setClockGateOptions().

ckgTestEnableName

std::string circt::firtool::FirtoolOptions::ckgTestEnableName

private

Definition at line 477 of file Firtool.h.

Referenced by FirtoolOptions(), getClockGateOptions(), setCkgTestEnableName(), and setClockGateOptions().

companionMode

firrtl::CompanionMode circt::firtool::FirtoolOptions::companionMode

private

Definition at line 456 of file Firtool.h.

Referenced by FirtoolOptions(), getCompanionMode(), and setCompanionMode().

dedupClasses

bool circt::firtool::FirtoolOptions::dedupClasses

private

Definition at line 455 of file Firtool.h.

Referenced by FirtoolOptions(), setDedupClasses(), and shouldDedupClasses().

disableAggressiveMergeConnections

bool circt::firtool::FirtoolOptions::disableAggressiveMergeConnections

private

Definition at line 458 of file Firtool.h.

Referenced by FirtoolOptions(), setDisableAggressiveMergeConnections(), and shouldDisableAggressiveMergeConnections().

disableAnnotationsClassless

bool circt::firtool::FirtoolOptions::disableAnnotationsClassless

private

Definition at line 443 of file Firtool.h.

Referenced by FirtoolOptions(), setDisableAnnotationsClassless(), and shouldDisableClasslessAnnotations().

disableAnnotationsUnknown

bool circt::firtool::FirtoolOptions::disableAnnotationsUnknown

private

Definition at line 442 of file Firtool.h.

Referenced by FirtoolOptions(), setDisableUnknownAnnotations(), and shouldDisableUnknownAnnotations().

disableCSEinClasses

bool circt::firtool::FirtoolOptions::disableCSEinClasses

private

Definition at line 483 of file Firtool.h.

Referenced by setDisableCSEinClasses(), and shouldDisableCSEinClasses().

disableLayerSink

bool circt::firtool::FirtoolOptions::disableLayerSink

private

Definition at line 451 of file Firtool.h.

Referenced by FirtoolOptions(), setDisableLayerSink(), and shouldDisableLayerSink().

disableOptimization

bool circt::firtool::FirtoolOptions::disableOptimization

private

Definition at line 452 of file Firtool.h.

Referenced by FirtoolOptions(), setDisableOptimization(), and shouldDisableOptimization().

disableRandom

RandomKind circt::firtool::FirtoolOptions::disableRandom

private

Definition at line 464 of file Firtool.h.

Referenced by FirtoolOptions(), isRandomEnabled(), and mergeDisableRandom().

disableWireElimination

bool circt::firtool::FirtoolOptions::disableWireElimination

private

Definition at line 486 of file Firtool.h.

Referenced by FirtoolOptions(), setDisableWireElimination(), and shouldDisableWireElimination().

domainMode

DomainMode circt::firtool::FirtoolOptions::domainMode

private

Definition at line 491 of file Firtool.h.

Referenced by FirtoolOptions(), getDomainMode(), and setDomainMode().

emitAllBindFiles

bool circt::firtool::FirtoolOptions::emitAllBindFiles

private

Definition at line 489 of file Firtool.h.

Referenced by FirtoolOptions(), getEmitAllBindFiles(), and setEmitAllBindFiles().

emitSeparateAlwaysBlocks

bool circt::firtool::FirtoolOptions::emitSeparateAlwaysBlocks

private

Definition at line 471 of file Firtool.h.

Referenced by FirtoolOptions(), setEmitSeparateAlwaysBlocks(), and shouldEmitSeparateAlwaysBlocks().

enableAnnotationWarning

bool circt::firtool::FirtoolOptions::enableAnnotationWarning

private

Definition at line 466 of file Firtool.h.

Referenced by FirtoolOptions(), setEnableAnnotationWarning(), and shouldEnableAnnotationWarning().

enableDebugInfo

bool circt::firtool::FirtoolOptions::enableDebugInfo

private

Definition at line 449 of file Firtool.h.

Referenced by FirtoolOptions(), setEnableDebugInfo(), and shouldEnableDebugInfo().

exportModuleHierarchy

bool circt::firtool::FirtoolOptions::exportModuleHierarchy

private

Definition at line 479 of file Firtool.h.

Referenced by FirtoolOptions(), setExportModuleHierarchy(), and shouldExportModuleHierarchy().

fixupEICGWrapper

bool circt::firtool::FirtoolOptions::fixupEICGWrapper

private

Definition at line 482 of file Firtool.h.

Referenced by FirtoolOptions(), setFixupEICGWrapper(), and shouldFixupEICGWrapper().

ignoreReadEnableMem

bool circt::firtool::FirtoolOptions::ignoreReadEnableMem

private

Definition at line 463 of file Firtool.h.

Referenced by FirtoolOptions(), setIgnoreReadEnableMem(), and shouldIgnoreReadEnableMemories().

inlineInputOnlyModules

bool circt::firtool::FirtoolOptions::inlineInputOnlyModules

private

Definition at line 490 of file Firtool.h.

Referenced by FirtoolOptions(), setInlineInputOnlyModules(), and shouldInlineInputOnlyModules().

lintStaticAsserts

bool circt::firtool::FirtoolOptions::lintStaticAsserts

private

Definition at line 487 of file Firtool.h.

Referenced by FirtoolOptions(), getLintStaticAsserts(), and setLintStaticAsserts().

lintXmrsInDesign

bool circt::firtool::FirtoolOptions::lintXmrsInDesign

private

Definition at line 488 of file Firtool.h.

Referenced by FirtoolOptions(), getLintXmrsInDesign(), and setLintXmrsInDesign().

lowerAnnotationsNoRefTypePorts

bool circt::firtool::FirtoolOptions::lowerAnnotationsNoRefTypePorts

private

Definition at line 444 of file Firtool.h.

Referenced by FirtoolOptions(), setLowerAnnotationsNoRefTypePorts(), and shouldLowerNoRefTypePortAnnotations().

lowerMemories

bool circt::firtool::FirtoolOptions::lowerMemories

private

Definition at line 459 of file Firtool.h.

Referenced by FirtoolOptions(), setLowerMemories(), and shouldLowerMemories().

lowerToCore

bool circt::firtool::FirtoolOptions::lowerToCore

private

Definition at line 468 of file Firtool.h.

Referenced by FirtoolOptions(), setLowerToCore(), and shouldLowerToCore().

noDedup

bool circt::firtool::FirtoolOptions::noDedup

private

Definition at line 454 of file Firtool.h.

Referenced by FirtoolOptions(), setNoDedup(), and shouldDedup().

noViews

bool circt::firtool::FirtoolOptions::noViews

private

Definition at line 457 of file Firtool.h.

Referenced by FirtoolOptions(), getNoViews(), and setNoViews().

outputAnnotationFilename

std::string circt::firtool::FirtoolOptions::outputAnnotationFilename

private

Definition at line 465 of file Firtool.h.

Referenced by FirtoolOptions(), getOutputAnnotationFilename(), and setOutputAnnotationFilename().

outputFilename

std::string circt::firtool::FirtoolOptions::outputFilename

private

Definition at line 439 of file Firtool.h.

Referenced by FirtoolOptions(), getOutputFilename(), isDefaultOutputFilename(), and setOutputFilename().

preserveAggregate

firrtl::PreserveAggregate::PreserveMode circt::firtool::FirtoolOptions::preserveAggregate

private

Definition at line 447 of file Firtool.h.

Referenced by FirtoolOptions(), getPreserveAggregate(), and setPreserveAggregate().

preserveMode

firrtl::PreserveValues::PreserveMode circt::firtool::FirtoolOptions::preserveMode

private

Definition at line 448 of file Firtool.h.

Referenced by FirtoolOptions(), getPreserveMode(), and setPreserveValues().

probesToSignals

bool circt::firtool::FirtoolOptions::probesToSignals

private

Definition at line 446 of file Firtool.h.

Referenced by FirtoolOptions(), setConvertProbesToSignals(), and shouldConvertProbesToSignals().

replSeqMem

bool circt::firtool::FirtoolOptions::replSeqMem

private

Definition at line 461 of file Firtool.h.

Referenced by FirtoolOptions(), setReplSeqMem(), and shouldReplaceSequentialMemories().

replSeqMemFile

std::string circt::firtool::FirtoolOptions::replSeqMemFile

private

Definition at line 462 of file Firtool.h.

Referenced by FirtoolOptions(), getReplaceSequentialMemoriesFile(), and setReplSeqMemFile().

selectDefaultInstanceChoice

bool circt::firtool::FirtoolOptions::selectDefaultInstanceChoice

private

Definition at line 484 of file Firtool.h.

Referenced by FirtoolOptions(), setSelectDefaultInstanceChoice(), and shouldSelectDefaultInstanceChoice().

skippedDomains

SmallVector<std::string> circt::firtool::FirtoolOptions::skippedDomains

private

Definition at line 493 of file Firtool.h.

Referenced by FirtoolOptions(), and getSkippedDomains().

stripDebugInfo

bool circt::firtool::FirtoolOptions::stripDebugInfo

private

Definition at line 481 of file Firtool.h.

Referenced by FirtoolOptions(), setStripDebugInfo(), and shouldStripDebugInfo().

stripDomain

bool circt::firtool::FirtoolOptions::stripDomain

private

Definition at line 492 of file Firtool.h.

Referenced by FirtoolOptions(), setStripDomain(), and shouldStripDomain().

stripFirDebugInfo

bool circt::firtool::FirtoolOptions::stripFirDebugInfo

private

Definition at line 480 of file Firtool.h.

Referenced by FirtoolOptions(), setStripFirDebugInfo(), and shouldStripFirDebugInfo().

symbolicValueLowering

verif::SymbolicValueLowering circt::firtool::FirtoolOptions::symbolicValueLowering

private

Definition at line 485 of file Firtool.h.

Referenced by FirtoolOptions(), getSymbolicValueLowering(), and setSymbolicValueLowering().

vbToBV

bool circt::firtool::FirtoolOptions::vbToBV

private

Definition at line 453 of file Firtool.h.

Referenced by FirtoolOptions(), setVbToBV(), and shouldConvertVecOfBundle().

verificationFlavor

firrtl::VerificationFlavor circt::firtool::FirtoolOptions::verificationFlavor

private

Definition at line 470 of file Firtool.h.

Referenced by FirtoolOptions(), getVerificationFlavor(), and setVerificationFlavor().

warnOnTruncation

bool circt::firtool::FirtoolOptions::warnOnTruncation

private

Definition at line 467 of file Firtool.h.

Referenced by FirtoolOptions(), setWarnOnTruncation(), and shouldWarnOnTruncation().

---

The documentation for this class was generated from the following files:

• /home/runner/work/circt-www/circt-www/circt_src/include/circt/Firtool/Firtool.h
• /home/runner/work/circt-www/circt-www/circt_src/lib/Firtool/Firtool.cpp