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 }

Public Member Functions
	FirtoolOptions ()
bool	isRandomEnabled (RandomKind kind) const
firrtl::PreserveValues::PreserveMode	getPreserveMode () const
StringRef	getOutputFilename () const
StringRef	getOmirOutputFile () const
StringRef	getBlackBoxRootPath () const
StringRef	getChiselInterfaceOutputDirectory () const
StringRef	getReplaceSequentialMemoriesFile () const
StringRef	getOutputAnnotationFilename () const
firrtl::PreserveAggregate::PreserveMode	getPreserveAggregate () const
firrtl::CompanionMode	getCompanionMode () const
seq::ExternalizeClockGateOptions	getClockGateOptions () const
FirtoolOptions &	setClockGateOptions (seq::ExternalizeClockGateOptions &opts)
bool	isDefaultOutputFilename () const
bool	shouldDisableUnknownAnnotations () const
bool	shouldDisableClasslessAnnotations () const
bool	shouldLowerNoRefTypePortAnnotations () const
bool	shouldAllowAddingPortsOnPublic () const
bool	shouldConvertProbesToSignals () const
bool	shouldReplaceSequentialMemories () const
bool	shouldDisableOptimization () const
bool	shouldAdvancedLayerSink () const
bool	shouldLowerMemories () const
bool	shouldDedup () const
bool	shouldEnableDebugInfo () const
bool	shouldIgnoreReadEnableMemories () const
bool	shouldEmitOMIR () const
bool	shouldExportChiselInterface () const
bool	shouldConvertVecOfBundle () const
bool	shouldEtcDisableInstanceExtraction () const
bool	shouldEtcDisableRegisterExtraction () const
bool	shouldEtcDisableModuleInlining () const
bool	shouldStripDebugInfo () const
bool	shouldStripFirDebugInfo () const
bool	shouldExportModuleHierarchy () const
bool	shouldDisableAggressiveMergeConnections () const
bool	shouldEnableAnnotationWarning () const
auto	getVerificationFlavor () const
bool	shouldEmitSeparateAlwaysBlocks () const
bool	shouldAddMuxPragmas () const
bool	shouldAddVivadoRAMAddressConflictSynthesisBugWorkaround () const
bool	shouldExtractTestCode () const
bool	shouldFixupEICGWrapper () const
bool	shouldAddCompanionAssume () const
FirtoolOptions &	setOutputFilename (StringRef name)
FirtoolOptions &	setDisableUnknownAnnotations (bool disable)
FirtoolOptions &	setDisableAnnotationsClassless (bool value)
FirtoolOptions &	setLowerAnnotationsNoRefTypePorts (bool value)
FirtoolOptions &	setAllowAddingPortsOnPublic (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 &	setDisableOptimization (bool value)
FirtoolOptions &	setExportChiselInterface (bool value)
FirtoolOptions &	setChiselInterfaceOutDirectory (StringRef value)
FirtoolOptions &	setVbToBV (bool value)
FirtoolOptions &	setNoDedup (bool value)
FirtoolOptions &	setCompanionMode (firrtl::CompanionMode value)
FirtoolOptions &	setDisableAggressiveMergeConnections (bool value)
FirtoolOptions &	setEmitOMIR (bool value)
FirtoolOptions &	setOmirOutFile (StringRef value)
FirtoolOptions &	setAdvancedLayerSink (bool value)
FirtoolOptions &	setLowerMemories (bool value)
FirtoolOptions &	setBlackBoxRootPath (StringRef value)
FirtoolOptions &	setReplSeqMem (bool value)
FirtoolOptions &	setReplSeqMemFile (StringRef value)
FirtoolOptions &	setExtractTestCode (bool value)
FirtoolOptions &	setIgnoreReadEnableMem (bool value)
FirtoolOptions &	setDisableRandom (RandomKind value)
FirtoolOptions &	setOutputAnnotationFilename (StringRef value)
FirtoolOptions &	setEnableAnnotationWarning (bool value)
FirtoolOptions &	setAddMuxPragmas (bool value)
FirtoolOptions &	setVerificationFlavor (firrtl::VerificationFlavor value)
FirtoolOptions &	setEmitSeparateAlwaysBlocks (bool value)
FirtoolOptions &	setEtcDisableInstanceExtraction (bool value)
FirtoolOptions &	setEtcDisableRegisterExtraction (bool value)
FirtoolOptions &	setEtcDisableModuleInlining (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 &	setAddCompanionAssume (bool value)

Private Attributes
std::string	outputFilename
bool	disableAnnotationsUnknown
bool	disableAnnotationsClassless
bool	lowerAnnotationsNoRefTypePorts
bool	allowAddingPortsOnPublic
bool	probesToSignals
firrtl::PreserveAggregate::PreserveMode	preserveAggregate
firrtl::PreserveValues::PreserveMode	preserveMode
bool	enableDebugInfo
BuildMode	buildMode
bool	disableOptimization
bool	exportChiselInterface
std::string	chiselInterfaceOutDirectory
bool	vbToBV
bool	noDedup
firrtl::CompanionMode	companionMode
bool	disableAggressiveMergeConnections
bool	emitOMIR
std::string	omirOutFile
bool	advancedLayerSink
bool	lowerMemories
std::string	blackBoxRootPath
bool	replSeqMem
std::string	replSeqMemFile
bool	extractTestCode
bool	ignoreReadEnableMem
RandomKind	disableRandom
std::string	outputAnnotationFilename
bool	enableAnnotationWarning
bool	addMuxPragmas
firrtl::VerificationFlavor	verificationFlavor
bool	emitSeparateAlwaysBlocks
bool	etcDisableInstanceExtraction
bool	etcDisableRegisterExtraction
bool	etcDisableModuleInlining
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	addCompanionAssume

Detailed Description

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

Definition at line 30 of file Firtool.h.

Member Enumeration Documentation

BuildMode

enum circt::firtool::FirtoolOptions::BuildMode

Enumerator
BuildModeDefault
BuildModeDebug
BuildModeRelease

Definition at line 35 of file Firtool.h.

RandomKind

enum circt::firtool::FirtoolOptions::RandomKind

strong

Enumerator
None
Mem
Reg
All

Definition at line 36 of file Firtool.h.

Constructor & Destructor Documentation

FirtoolOptions()

circt::firtool::FirtoolOptions::FirtoolOptions

(

)

Definition at line 748 of file Firtool.cpp.

References addCompanionAssume, addMuxPragmas, addVivadoRAMAddressConflictSynthesisBugWorkaround, advancedLayerSink, allowAddingPortsOnPublic, blackBoxRootPath, buildMode, chiselInterfaceOutDirectory, ckgEnableName, ckgInputName, ckgModuleName, ckgOutputName, ckgTestEnableName, clOptions, companionMode, disableAggressiveMergeConnections, disableAnnotationsClassless, disableAnnotationsUnknown, disableOptimization, disableRandom, emitOMIR, emitSeparateAlwaysBlocks, enableAnnotationWarning, enableDebugInfo, etcDisableInstanceExtraction, etcDisableModuleInlining, etcDisableRegisterExtraction, exportChiselInterface, exportModuleHierarchy, extractTestCode, fixupEICGWrapper, ignoreReadEnableMem, lowerAnnotationsNoRefTypePorts, lowerMemories, noDedup, omirOutFile, outputAnnotationFilename, outputFilename, preserveAggregate, preserveMode, probesToSignals, replSeqMem, replSeqMemFile, stripDebugInfo, stripFirDebugInfo, vbToBV, and verificationFlavor.

Member Function Documentation

getBlackBoxRootPath()

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

inline

Definition at line 56 of file Firtool.h.

References blackBoxRootPath.

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

getChiselInterfaceOutputDirectory()

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

inline

Definition at line 57 of file Firtool.h.

References chiselInterfaceOutDirectory.

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

getClockGateOptions()

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

inline

Definition at line 70 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 68 of file Firtool.h.

References companionMode.

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

getOmirOutputFile()

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

inline

Definition at line 55 of file Firtool.h.

References omirOutFile.

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

getOutputAnnotationFilename()

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

inline

Definition at line 61 of file Firtool.h.

References outputAnnotationFilename.

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

getOutputFilename()

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

inline

Definition at line 54 of file Firtool.h.

References outputFilename.

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

getPreserveAggregate()

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

inline

Definition at line 65 of file Firtool.h.

References preserveAggregate.

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

getPreserveMode()

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

inline

Definition at line 42 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 60 of file Firtool.h.

References replSeqMemFile.

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

getVerificationFlavor()

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

inline

Definition at line 125 of file Firtool.h.

References verificationFlavor.

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

isDefaultOutputFilename()

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

inline

Definition at line 85 of file Firtool.h.

References outputFilename.

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

isRandomEnabled()

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

inline

Definition at line 38 of file Firtool.h.

References All, and disableRandom.

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

setAddCompanionAssume()

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

inline

Definition at line 366 of file Firtool.h.

References addCompanionAssume.

setAddMuxPragmas()

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

inline

Definition at line 285 of file Firtool.h.

References addMuxPragmas.

setAddVivadoRAMAddressConflictSynthesisBugWorkaround()

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

inline

Definition at line 316 of file Firtool.h.

References addVivadoRAMAddressConflictSynthesisBugWorkaround.

setAdvancedLayerSink()

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

inline

Definition at line 235 of file Firtool.h.

References advancedLayerSink.

setAllowAddingPortsOnPublic()

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

inline

Definition at line 158 of file Firtool.h.

References allowAddingPortsOnPublic.

setBlackBoxRootPath()

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

inline

Definition at line 245 of file Firtool.h.

References blackBoxRootPath.

setBuildMode()

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

inline

Definition at line 185 of file Firtool.h.

References buildMode.

setChiselInterfaceOutDirectory()

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

inline

Definition at line 200 of file Firtool.h.

References chiselInterfaceOutDirectory.

setCkgEnableName()

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

inline

Definition at line 336 of file Firtool.h.

References ckgEnableName.

setCkgInputName()

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

inline

Definition at line 326 of file Firtool.h.

References ckgInputName.

setCkgModuleName()

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

inline

Definition at line 321 of file Firtool.h.

References ckgModuleName.

setCkgOutputName()

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

inline

Definition at line 331 of file Firtool.h.

References ckgOutputName.

setCkgTestEnableName()

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

inline

Definition at line 341 of file Firtool.h.

References ckgTestEnableName.

setClockGateOptions()

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

inline

Definition at line 75 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 215 of file Firtool.h.

References companionMode.

setConvertProbesToSignals()

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

inline

Definition at line 163 of file Firtool.h.

References probesToSignals.

setDisableAggressiveMergeConnections()

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

inline

Definition at line 220 of file Firtool.h.

References disableAggressiveMergeConnections.

setDisableAnnotationsClassless()

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

inline

Definition at line 148 of file Firtool.h.

References disableAnnotationsClassless.

setDisableOptimization()

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

inline

Definition at line 190 of file Firtool.h.

References disableOptimization.

setDisableRandom()

FirtoolOptions& circt::firtool::FirtoolOptions::setDisableRandom ( RandomKind  value )

inline

Definition at line 270 of file Firtool.h.

References disableRandom.

setDisableUnknownAnnotations()

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

inline

Definition at line 143 of file Firtool.h.

References disableAnnotationsUnknown.

setEmitOMIR()

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

inline

Definition at line 225 of file Firtool.h.

References emitOMIR.

setEmitSeparateAlwaysBlocks()

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

inline

Definition at line 295 of file Firtool.h.

References emitSeparateAlwaysBlocks.

setEnableAnnotationWarning()

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

inline

Definition at line 280 of file Firtool.h.

References enableAnnotationWarning.

setEnableDebugInfo()

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

inline

Definition at line 180 of file Firtool.h.

References enableDebugInfo.

setEtcDisableInstanceExtraction()

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

inline

Definition at line 300 of file Firtool.h.

References etcDisableInstanceExtraction.

setEtcDisableModuleInlining()

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

inline

Definition at line 310 of file Firtool.h.

References etcDisableModuleInlining.

setEtcDisableRegisterExtraction()

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

inline

Definition at line 305 of file Firtool.h.

References etcDisableRegisterExtraction.

setExportChiselInterface()

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

inline

Definition at line 195 of file Firtool.h.

References exportChiselInterface.

setExportModuleHierarchy()

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

inline

Definition at line 346 of file Firtool.h.

References exportModuleHierarchy.

setExtractTestCode()

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

inline

Definition at line 260 of file Firtool.h.

References extractTestCode.

setFixupEICGWrapper()

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

inline

Definition at line 361 of file Firtool.h.

References fixupEICGWrapper.

setIgnoreReadEnableMem()

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

inline

Definition at line 265 of file Firtool.h.

References ignoreReadEnableMem.

setLowerAnnotationsNoRefTypePorts()

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

inline

Definition at line 153 of file Firtool.h.

References lowerAnnotationsNoRefTypePorts.

setLowerMemories()

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

inline

Definition at line 240 of file Firtool.h.

References lowerMemories.

setNoDedup()

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

inline

Definition at line 210 of file Firtool.h.

References noDedup.

setOmirOutFile()

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

inline

Definition at line 230 of file Firtool.h.

References omirOutFile.

setOutputAnnotationFilename()

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

inline

Definition at line 275 of file Firtool.h.

References outputAnnotationFilename.

setOutputFilename()

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

inline

Definition at line 138 of file Firtool.h.

References outputFilename.

setPreserveAggregate()

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

inline

Definition at line 169 of file Firtool.h.

References preserveAggregate.

setPreserveValues()

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

inline

Definition at line 175 of file Firtool.h.

References preserveMode.

setReplSeqMem()

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

inline

Definition at line 250 of file Firtool.h.

References replSeqMem.

setReplSeqMemFile()

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

inline

Definition at line 255 of file Firtool.h.

References replSeqMemFile.

setStripDebugInfo()

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

inline

Definition at line 356 of file Firtool.h.

References stripDebugInfo.

setStripFirDebugInfo()

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

inline

Definition at line 351 of file Firtool.h.

References stripFirDebugInfo.

setVbToBV()

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

inline

Definition at line 205 of file Firtool.h.

References vbToBV.

setVerificationFlavor()

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

inline

Definition at line 290 of file Firtool.h.

References verificationFlavor.

shouldAddCompanionAssume()

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

inline

Definition at line 135 of file Firtool.h.

References addCompanionAssume.

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

shouldAddMuxPragmas()

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

inline

Definition at line 129 of file Firtool.h.

References addMuxPragmas.

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

shouldAddVivadoRAMAddressConflictSynthesisBugWorkaround()

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

inline

Definition at line 130 of file Firtool.h.

References addVivadoRAMAddressConflictSynthesisBugWorkaround.

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

shouldAdvancedLayerSink()

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

inline

Definition at line 101 of file Firtool.h.

References advancedLayerSink.

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

shouldAllowAddingPortsOnPublic()

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

inline

Definition at line 95 of file Firtool.h.

References allowAddingPortsOnPublic.

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

shouldConvertProbesToSignals()

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

inline

Definition at line 98 of file Firtool.h.

References probesToSignals.

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

shouldConvertVecOfBundle()

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

inline

Definition at line 108 of file Firtool.h.

References vbToBV.

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

shouldDedup()

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

inline

Definition at line 103 of file Firtool.h.

References noDedup.

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

shouldDisableAggressiveMergeConnections()

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

inline

Definition at line 121 of file Firtool.h.

References disableAggressiveMergeConnections.

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

shouldDisableClasslessAnnotations()

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

inline

Definition at line 89 of file Firtool.h.

References disableAnnotationsClassless.

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

shouldDisableOptimization()

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

inline

Definition at line 100 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 86 of file Firtool.h.

References disableAnnotationsUnknown.

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

shouldEmitOMIR()

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

inline

Definition at line 106 of file Firtool.h.

References emitOMIR.

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

shouldEmitSeparateAlwaysBlocks()

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

inline

Definition at line 126 of file Firtool.h.

References emitSeparateAlwaysBlocks.

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

shouldEnableAnnotationWarning()

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

inline

Definition at line 124 of file Firtool.h.

References enableAnnotationWarning.

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

shouldEnableDebugInfo()

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

inline

Definition at line 104 of file Firtool.h.

References enableDebugInfo.

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

shouldEtcDisableInstanceExtraction()

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

inline

Definition at line 109 of file Firtool.h.

References etcDisableInstanceExtraction.

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

shouldEtcDisableModuleInlining()

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

inline

Definition at line 115 of file Firtool.h.

References etcDisableModuleInlining.

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

shouldEtcDisableRegisterExtraction()

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

inline

Definition at line 112 of file Firtool.h.

References etcDisableRegisterExtraction.

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

shouldExportChiselInterface()

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

inline

Definition at line 107 of file Firtool.h.

References exportChiselInterface.

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

shouldExportModuleHierarchy()

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

inline

Definition at line 120 of file Firtool.h.

References exportModuleHierarchy.

Referenced by detail::populatePrepareForExportVerilog().

shouldExtractTestCode()

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

inline

Definition at line 133 of file Firtool.h.

References extractTestCode.

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

shouldFixupEICGWrapper()

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

inline

Definition at line 134 of file Firtool.h.

References fixupEICGWrapper.

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

shouldIgnoreReadEnableMemories()

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

inline

Definition at line 105 of file Firtool.h.

References ignoreReadEnableMem.

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

shouldLowerMemories()

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

inline

Definition at line 102 of file Firtool.h.

References lowerMemories.

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

shouldLowerNoRefTypePortAnnotations()

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

inline

Definition at line 92 of file Firtool.h.

References lowerAnnotationsNoRefTypePorts.

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

shouldReplaceSequentialMemories()

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

inline

Definition at line 99 of file Firtool.h.

References replSeqMem.

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

shouldStripDebugInfo()

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

inline

Definition at line 118 of file Firtool.h.

References stripDebugInfo.

Referenced by detail::populatePrepareForExportVerilog().

shouldStripFirDebugInfo()

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

inline

Definition at line 119 of file Firtool.h.

References stripFirDebugInfo.

Referenced by detail::populatePrepareForExportVerilog().

Member Data Documentation

addCompanionAssume

bool circt::firtool::FirtoolOptions::addCompanionAssume

private

Definition at line 418 of file Firtool.h.

Referenced by FirtoolOptions(), setAddCompanionAssume(), and shouldAddCompanionAssume().

addMuxPragmas

bool circt::firtool::FirtoolOptions::addMuxPragmas

private

Definition at line 401 of file Firtool.h.

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

addVivadoRAMAddressConflictSynthesisBugWorkaround

bool circt::firtool::FirtoolOptions::addVivadoRAMAddressConflictSynthesisBugWorkaround

private

Definition at line 407 of file Firtool.h.

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

advancedLayerSink

bool circt::firtool::FirtoolOptions::advancedLayerSink

private

Definition at line 391 of file Firtool.h.

Referenced by FirtoolOptions(), setAdvancedLayerSink(), and shouldAdvancedLayerSink().

allowAddingPortsOnPublic

bool circt::firtool::FirtoolOptions::allowAddingPortsOnPublic

private

Definition at line 376 of file Firtool.h.

Referenced by FirtoolOptions(), setAllowAddingPortsOnPublic(), and shouldAllowAddingPortsOnPublic().

blackBoxRootPath

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

private

Definition at line 393 of file Firtool.h.

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

buildMode

BuildMode circt::firtool::FirtoolOptions::buildMode

private

Definition at line 381 of file Firtool.h.

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

chiselInterfaceOutDirectory

std::string circt::firtool::FirtoolOptions::chiselInterfaceOutDirectory

private

Definition at line 384 of file Firtool.h.

Referenced by FirtoolOptions(), getChiselInterfaceOutputDirectory(), and setChiselInterfaceOutDirectory().

ckgEnableName

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

private

Definition at line 411 of file Firtool.h.

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

ckgInputName

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

private

Definition at line 409 of file Firtool.h.

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

ckgInstName

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

private

Definition at line 413 of file Firtool.h.

Referenced by getClockGateOptions(), and setClockGateOptions().

ckgModuleName

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

private

Definition at line 408 of file Firtool.h.

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

ckgOutputName

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

private

Definition at line 410 of file Firtool.h.

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

ckgTestEnableName

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

private

Definition at line 412 of file Firtool.h.

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

companionMode

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

private

Definition at line 387 of file Firtool.h.

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

disableAggressiveMergeConnections

bool circt::firtool::FirtoolOptions::disableAggressiveMergeConnections

private

Definition at line 388 of file Firtool.h.

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

disableAnnotationsClassless

bool circt::firtool::FirtoolOptions::disableAnnotationsClassless

private

Definition at line 374 of file Firtool.h.

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

disableAnnotationsUnknown

bool circt::firtool::FirtoolOptions::disableAnnotationsUnknown

private

Definition at line 373 of file Firtool.h.

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

disableOptimization

bool circt::firtool::FirtoolOptions::disableOptimization

private

Definition at line 382 of file Firtool.h.

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

disableRandom

RandomKind circt::firtool::FirtoolOptions::disableRandom

private

Definition at line 398 of file Firtool.h.

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

emitOMIR

bool circt::firtool::FirtoolOptions::emitOMIR

private

Definition at line 389 of file Firtool.h.

Referenced by FirtoolOptions(), setEmitOMIR(), and shouldEmitOMIR().

emitSeparateAlwaysBlocks

bool circt::firtool::FirtoolOptions::emitSeparateAlwaysBlocks

private

Definition at line 403 of file Firtool.h.

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

enableAnnotationWarning

bool circt::firtool::FirtoolOptions::enableAnnotationWarning

private

Definition at line 400 of file Firtool.h.

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

enableDebugInfo

bool circt::firtool::FirtoolOptions::enableDebugInfo

private

Definition at line 380 of file Firtool.h.

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

etcDisableInstanceExtraction

bool circt::firtool::FirtoolOptions::etcDisableInstanceExtraction

private

Definition at line 404 of file Firtool.h.

Referenced by FirtoolOptions(), setEtcDisableInstanceExtraction(), and shouldEtcDisableInstanceExtraction().

etcDisableModuleInlining

bool circt::firtool::FirtoolOptions::etcDisableModuleInlining

private

Definition at line 406 of file Firtool.h.

Referenced by FirtoolOptions(), setEtcDisableModuleInlining(), and shouldEtcDisableModuleInlining().

etcDisableRegisterExtraction

bool circt::firtool::FirtoolOptions::etcDisableRegisterExtraction

private

Definition at line 405 of file Firtool.h.

Referenced by FirtoolOptions(), setEtcDisableRegisterExtraction(), and shouldEtcDisableRegisterExtraction().

exportChiselInterface

bool circt::firtool::FirtoolOptions::exportChiselInterface

private

Definition at line 383 of file Firtool.h.

Referenced by FirtoolOptions(), setExportChiselInterface(), and shouldExportChiselInterface().

exportModuleHierarchy

bool circt::firtool::FirtoolOptions::exportModuleHierarchy

private

Definition at line 414 of file Firtool.h.

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

extractTestCode

bool circt::firtool::FirtoolOptions::extractTestCode

private

Definition at line 396 of file Firtool.h.

Referenced by FirtoolOptions(), setExtractTestCode(), and shouldExtractTestCode().

fixupEICGWrapper

bool circt::firtool::FirtoolOptions::fixupEICGWrapper

private

Definition at line 417 of file Firtool.h.

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

ignoreReadEnableMem

bool circt::firtool::FirtoolOptions::ignoreReadEnableMem

private

Definition at line 397 of file Firtool.h.

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

lowerAnnotationsNoRefTypePorts

bool circt::firtool::FirtoolOptions::lowerAnnotationsNoRefTypePorts

private

Definition at line 375 of file Firtool.h.

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

lowerMemories

bool circt::firtool::FirtoolOptions::lowerMemories

private

Definition at line 392 of file Firtool.h.

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

noDedup

bool circt::firtool::FirtoolOptions::noDedup

private

Definition at line 386 of file Firtool.h.

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

omirOutFile

std::string circt::firtool::FirtoolOptions::omirOutFile

private

Definition at line 390 of file Firtool.h.

Referenced by FirtoolOptions(), getOmirOutputFile(), and setOmirOutFile().

outputAnnotationFilename

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

private

Definition at line 399 of file Firtool.h.

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

outputFilename

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

private

Definition at line 372 of file Firtool.h.

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

preserveAggregate

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

private

Definition at line 378 of file Firtool.h.

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

preserveMode

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

private

Definition at line 379 of file Firtool.h.

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

probesToSignals

bool circt::firtool::FirtoolOptions::probesToSignals

private

Definition at line 377 of file Firtool.h.

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

replSeqMem

bool circt::firtool::FirtoolOptions::replSeqMem

private

Definition at line 394 of file Firtool.h.

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

replSeqMemFile

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

private

Definition at line 395 of file Firtool.h.

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

stripDebugInfo

bool circt::firtool::FirtoolOptions::stripDebugInfo

private

Definition at line 416 of file Firtool.h.

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

stripFirDebugInfo

bool circt::firtool::FirtoolOptions::stripFirDebugInfo

private

Definition at line 415 of file Firtool.h.

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

vbToBV

bool circt::firtool::FirtoolOptions::vbToBV

private

Definition at line 385 of file Firtool.h.

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

verificationFlavor

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

private

Definition at line 402 of file Firtool.h.

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

---

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