circt::firtool Namespace Reference

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

Functions
void	registerFirtoolCLOptions ()
	Register a set of useful command-line options that can be used to configure various flags within the MLIRContext.
LogicalResult	populatePreprocessTransforms (mlir::PassManager &pm, const FirtoolOptions &opt)
LogicalResult	populateCHIRRTLToLowFIRRTL (mlir::PassManager &pm, const FirtoolOptions &opt)
LogicalResult	populateLowFIRRTLToHW (mlir::PassManager &pm, const FirtoolOptions &opt, StringRef inputFilename)
LogicalResult	populateHWToSV (mlir::PassManager &pm, const FirtoolOptions &opt)
LogicalResult	populateExportVerilog (mlir::PassManager &pm, const FirtoolOptions &opt, std::unique_ptr< llvm::raw_ostream > os)
LogicalResult	populateExportVerilog (mlir::PassManager &pm, const FirtoolOptions &opt, llvm::raw_ostream &os)
LogicalResult	populateExportSplitVerilog (mlir::PassManager &pm, const FirtoolOptions &opt, llvm::StringRef directory)
LogicalResult	populateFinalizeIR (mlir::PassManager &pm, const FirtoolOptions &opt)
LogicalResult	populateHWToBTOR2 (mlir::PassManager &pm, const FirtoolOptions &opt, llvm::raw_ostream &os)
	BTOR2 emission pipeline, triggered with --btor2 flag.

Function Documentation

populateCHIRRTLToLowFIRRTL()

LogicalResult circt::firtool::populateCHIRRTLToLowFIRRTL	(	mlir::PassManager &	pm,
		const FirtoolOptions &	opt )

Definition at line 54 of file Firtool.cpp.

References circt::firrtl::PreserveAggregate::All, circt::createSimpleCanonicalizerPass(), circt::firtool::FirtoolOptions::getDomainMode(), circt::firtool::FirtoolOptions::getPreserveAggregate(), circt::firtool::FirtoolOptions::getPreserveMode(), circt::firtool::FirtoolOptions::getReplaceSequentialMemoriesFile(), circt::firtool::FirtoolOptions::getSkippedDomains(), circt::firtool::FirtoolOptions::isRandomEnabled(), circt::firrtl::PreserveAggregate::None, circt::firtool::FirtoolOptions::Reg, circt::firtool::FirtoolOptions::shouldConvertProbesToSignals(), circt::firtool::FirtoolOptions::shouldConvertVecOfBundle(), circt::firtool::FirtoolOptions::shouldDedup(), circt::firtool::FirtoolOptions::shouldDisableAggressiveMergeConnections(), circt::firtool::FirtoolOptions::shouldDisableCSEinClasses(), circt::firtool::FirtoolOptions::shouldDisableOptimization(), circt::firtool::FirtoolOptions::shouldDisableWireElimination(), circt::firtool::FirtoolOptions::shouldInlineInputOnlyModules(), circt::firtool::FirtoolOptions::shouldLowerMemories(), circt::firtool::FirtoolOptions::shouldReplaceSequentialMemories(), circt::firtool::FirtoolOptions::shouldSelectDefaultInstanceChoice(), circt::firtool::FirtoolOptions::shouldStripDomain(), circt::firtool::FirtoolOptions::shouldWarnOnTruncation(), success(), and circt::firtool::FirtoolOptions::toInferDomainsPassMode().

Referenced by circtFirtoolPopulateCHIRRTLToLowFIRRTL().

populateExportSplitVerilog()

LogicalResult circt::firtool::populateExportSplitVerilog	(	mlir::PassManager &	pm,
		const FirtoolOptions &	opt,
		llvm::StringRef	directory )

Definition at line 433 of file Firtool.cpp.

References circt::createExportSplitVerilogPass(), failure(), detail::populatePrepareForExportVerilog(), and success().

Referenced by circtFirtoolPopulateExportSplitVerilog().

populateExportVerilog() [1/2]

LogicalResult circt::firtool::populateExportVerilog	(	mlir::PassManager &	pm,
		const FirtoolOptions &	opt,
		llvm::raw_ostream &	os )

Definition at line 423 of file Firtool.cpp.

References circt::createExportVerilogPass(), failure(), detail::populatePrepareForExportVerilog(), and success().

populateExportVerilog() [2/2]

LogicalResult circt::firtool::populateExportVerilog	(	mlir::PassManager &	pm,
		const FirtoolOptions &	opt,
		std::unique_ptr< llvm::raw_ostream >	os )

Definition at line 414 of file Firtool.cpp.

References circt::createExportVerilogPass(), failure(), detail::populatePrepareForExportVerilog(), and success().

Referenced by circtFirtoolPopulateExportVerilog().

populateFinalizeIR()

LogicalResult circt::firtool::populateFinalizeIR	(	mlir::PassManager &	pm,
		const FirtoolOptions &	opt )

Definition at line 443 of file Firtool.cpp.

References circt::om::createFreezePathsPass(), and success().

Referenced by circtFirtoolPopulateFinalizeIR().

populateHWToBTOR2()

LogicalResult circt::firtool::populateHWToBTOR2	(	mlir::PassManager &	pm,
		const FirtoolOptions &	opt,
		llvm::raw_ostream &	os )

BTOR2 emission pipeline, triggered with --btor2 flag.

Definition at line 458 of file Firtool.cpp.

References circt::createConvertHWToBTOR2Pass(), circt::createLowerLTLToCorePass(), and success().

Referenced by circtFirtoolpopulateHWToBTOR2().

populateHWToSV()

LogicalResult circt::firtool::populateHWToSV	(	mlir::PassManager &	pm,
		const FirtoolOptions &	opt )

Definition at line 330 of file Firtool.cpp.

References circt::createLowerSeqToSVPass(), circt::createLowerSimToSVPass(), circt::createLowerVerifToSVPass(), circt::createSimpleCanonicalizerPass(), circt::firtool::FirtoolOptions::getClockGateOptions(), circt::firtool::FirtoolOptions::getSymbolicValueLowering(), circt::seq::Ignore, circt::firtool::FirtoolOptions::isRandomEnabled(), circt::firtool::FirtoolOptions::Mem, circt::firtool::FirtoolOptions::Reg, circt::firtool::FirtoolOptions::shouldAddMuxPragmas(), circt::firtool::FirtoolOptions::shouldAddVivadoRAMAddressConflictSynthesisBugWorkaround(), circt::firtool::FirtoolOptions::shouldDisableOptimization(), circt::firtool::FirtoolOptions::shouldEmitSeparateAlwaysBlocks(), circt::firtool::FirtoolOptions::shouldIgnoreReadEnableMemories(), circt::firtool::FirtoolOptions::shouldReplaceSequentialMemories(), success(), and circt::seq::Undefined.

Referenced by circtFirtoolPopulateHWToSV().

populateLowFIRRTLToHW()

LogicalResult circt::firtool::populateLowFIRRTLToHW	(	mlir::PassManager &	pm,
		const FirtoolOptions &	opt,
		StringRef	inputFilename )

Definition at line 241 of file Firtool.cpp.

References circt::createLowerFIRRTLToHWPass(), circt::createSimpleCanonicalizerPass(), circt::firtool::FirtoolOptions::getBlackBoxRootPath(), circt::firtool::FirtoolOptions::getCompanionMode(), circt::firtool::FirtoolOptions::getEmitAllBindFiles(), circt::firtool::FirtoolOptions::getLintStaticAsserts(), circt::firtool::FirtoolOptions::getLintXmrsInDesign(), circt::firtool::FirtoolOptions::getNoViews(), circt::firtool::FirtoolOptions::getOutputAnnotationFilename(), circt::firtool::FirtoolOptions::getOutputFilename(), circt::firtool::FirtoolOptions::getVerificationFlavor(), circt::firtool::FirtoolOptions::shouldDisableLayerSink(), circt::firtool::FirtoolOptions::shouldDisableOptimization(), circt::firtool::FirtoolOptions::shouldEnableAnnotationWarning(), circt::firtool::FirtoolOptions::shouldLowerToCore(), and success().

Referenced by circtFirtoolPopulateLowFIRRTLToHW().

populatePreprocessTransforms()

LogicalResult circt::firtool::populatePreprocessTransforms	(	mlir::PassManager &	pm,
		const FirtoolOptions &	opt )

Definition at line 27 of file Firtool.cpp.

References circt::firtool::FirtoolOptions::shouldDisableClasslessAnnotations(), circt::firtool::FirtoolOptions::shouldDisableUnknownAnnotations(), circt::firtool::FirtoolOptions::shouldEnableDebugInfo(), circt::firtool::FirtoolOptions::shouldFixupEICGWrapper(), circt::firtool::FirtoolOptions::shouldLowerNoRefTypePortAnnotations(), and success().

Referenced by circtFirtoolPopulatePreprocessTransforms().

registerFirtoolCLOptions()

void circt::firtool::registerFirtoolCLOptions

(

)

Register a set of useful command-line options that can be used to configure various flags within the MLIRContext.

These flags are used when constructing an MLIR context for initialization.

Definition at line 855 of file Firtool.cpp.

References clOptions.