Firtool.cpp File Reference

#include "circt-c/Firtool/Firtool.h"
#include "circt/Firtool/Firtool.h"
#include "mlir/CAPI/IR.h"
#include "mlir/CAPI/Pass.h"
#include "mlir/CAPI/Support.h"
#include "mlir/CAPI/Utils.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/raw_ostream.h"

Include dependency graph for Firtool.cpp:

Go to the source code of this file.

Functions
	DEFINE_C_API_PTR_METHODS (CirctFirtoolFirtoolOptions, circt::firtool::FirtoolOptions) CirctFirtoolFirtoolOptions circtFirtoolOptionsCreateDefault()
void	circtFirtoolOptionsDestroy (CirctFirtoolFirtoolOptions options)
void	circtFirtoolOptionsSetOutputFilename (CirctFirtoolFirtoolOptions options, MlirStringRef filename)
void	circtFirtoolOptionsSetDisableUnknownAnnotations (CirctFirtoolFirtoolOptions options, bool disable)
void	circtFirtoolOptionsSetDisableAnnotationsClassless (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetLowerAnnotationsNoRefTypePorts (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetPreserveAggregate (CirctFirtoolFirtoolOptions options, CirctFirtoolPreserveAggregateMode value)
void	circtFirtoolOptionsSetPreserveValues (CirctFirtoolFirtoolOptions options, CirctFirtoolPreserveValuesMode value)
void	circtFirtoolOptionsSetEnableDebugInfo (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetBuildMode (CirctFirtoolFirtoolOptions options, CirctFirtoolBuildMode value)
void	circtFirtoolOptionsSetDisableLayerSink (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetDisableOptimization (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetVbToBv (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetNoDedup (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetCompanionMode (CirctFirtoolFirtoolOptions options, CirctFirtoolCompanionMode value)
void	circtFirtoolOptionsSetNoViews (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetDisableAggressiveMergeConnections (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetLowerMemories (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetBlackBoxRootPath (CirctFirtoolFirtoolOptions options, MlirStringRef value)
void	circtFirtoolOptionsSetReplSeqMem (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetReplSeqMemFile (CirctFirtoolFirtoolOptions options, MlirStringRef value)
void	circtFirtoolOptionsSetIgnoreReadEnableMem (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetDisableRandom (CirctFirtoolFirtoolOptions options, CirctFirtoolRandomKind value)
void	circtFirtoolOptionsSetOutputAnnotationFilename (CirctFirtoolFirtoolOptions options, MlirStringRef value)
void	circtFirtoolOptionsSetEnableAnnotationWarning (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetWarnOnTruncation (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetLowerToCore (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetAddMuxPragmas (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetVerificationFlavor (CirctFirtoolFirtoolOptions options, firrtl::VerificationFlavor value)
void	circtFirtoolOptionsSetEmitSeparateAlwaysBlocks (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetAddVivadoRAMAddressConflictSynthesisBugWorkaround (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetCkgModuleName (CirctFirtoolFirtoolOptions options, MlirStringRef value)
void	circtFirtoolOptionsSetCkgInputName (CirctFirtoolFirtoolOptions options, MlirStringRef value)
void	circtFirtoolOptionsSetCkgOutputName (CirctFirtoolFirtoolOptions options, MlirStringRef value)
void	circtFirtoolOptionsSetCkgEnableName (CirctFirtoolFirtoolOptions options, MlirStringRef value)
void	circtFirtoolOptionsSetCkgTestEnableName (CirctFirtoolFirtoolOptions options, MlirStringRef value)
void	circtFirtoolOptionsSetExportModuleHierarchy (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetStripFirDebugInfo (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetStripDebugInfo (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetDisableCSEinClasses (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetSelectDefaultInstanceChoice (CirctFirtoolFirtoolOptions options, bool value)
void	circtFirtoolOptionsSetDomainMode (CirctFirtoolFirtoolOptions options, CirctFirtoolDomainMode value)
void	circtFirtoolOptionsSetStripDomain (CirctFirtoolFirtoolOptions options, bool value)
	Erase all domain information after inference and checking.
MlirLogicalResult	circtFirtoolPopulatePreprocessTransforms (MlirPassManager pm, CirctFirtoolFirtoolOptions options)
MlirLogicalResult	circtFirtoolPopulateCHIRRTLToLowFIRRTL (MlirPassManager pm, CirctFirtoolFirtoolOptions options)
MlirLogicalResult	circtFirtoolPopulateLowFIRRTLToHW (MlirPassManager pm, CirctFirtoolFirtoolOptions options, MlirStringRef inputFilename)
MlirLogicalResult	circtFirtoolPopulateHWToSV (MlirPassManager pm, CirctFirtoolFirtoolOptions options)
MlirLogicalResult	circtFirtoolPopulateExportVerilog (MlirPassManager pm, CirctFirtoolFirtoolOptions options, MlirStringCallback callback, void *userData)
MlirLogicalResult	circtFirtoolPopulateExportSplitVerilog (MlirPassManager pm, CirctFirtoolFirtoolOptions options, MlirStringRef directory)
MlirLogicalResult	circtFirtoolPopulateFinalizeIR (MlirPassManager pm, CirctFirtoolFirtoolOptions options)
MlirLogicalResult	circtFirtoolpopulateHWToBTOR2 (MlirPassManager pm, CirctFirtoolFirtoolOptions options, MlirStringCallback callback, void *userData)

Function Documentation

circtFirtoolOptionsDestroy()

void circtFirtoolOptionsDestroy

(

CirctFirtoolFirtoolOptions

options

)

Definition at line 30 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetAddMuxPragmas()

void circtFirtoolOptionsSetAddMuxPragmas	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 235 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetAddVivadoRAMAddressConflictSynthesisBugWorkaround()

void circtFirtoolOptionsSetAddVivadoRAMAddressConflictSynthesisBugWorkaround	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 250 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetBlackBoxRootPath()

void circtFirtoolOptionsSetBlackBoxRootPath	(	CirctFirtoolFirtoolOptions	options,
		MlirStringRef	value )

Definition at line 177 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetBuildMode()

void circtFirtoolOptionsSetBuildMode	(	CirctFirtoolFirtoolOptions	options,
		CirctFirtoolBuildMode	value )

Definition at line 104 of file Firtool.cpp.

References circt::firtool::FirtoolOptions::BuildModeDebug, circt::firtool::FirtoolOptions::BuildModeDefault, circt::firtool::FirtoolOptions::BuildModeRelease, CIRCT_FIRTOOL_BUILD_MODE_DEBUG, CIRCT_FIRTOOL_BUILD_MODE_DEFAULT, CIRCT_FIRTOOL_BUILD_MODE_RELEASE, and unwrap().

circtFirtoolOptionsSetCkgEnableName()

void circtFirtoolOptionsSetCkgEnableName	(	CirctFirtoolFirtoolOptions	options,
		MlirStringRef	value )

Definition at line 270 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetCkgInputName()

void circtFirtoolOptionsSetCkgInputName	(	CirctFirtoolFirtoolOptions	options,
		MlirStringRef	value )

Definition at line 260 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetCkgModuleName()

void circtFirtoolOptionsSetCkgModuleName	(	CirctFirtoolFirtoolOptions	options,
		MlirStringRef	value )

Definition at line 255 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetCkgOutputName()

void circtFirtoolOptionsSetCkgOutputName	(	CirctFirtoolFirtoolOptions	options,
		MlirStringRef	value )

Definition at line 265 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetCkgTestEnableName()

void circtFirtoolOptionsSetCkgTestEnableName	(	CirctFirtoolFirtoolOptions	options,
		MlirStringRef	value )

Definition at line 275 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetCompanionMode()

void circtFirtoolOptionsSetCompanionMode	(	CirctFirtoolFirtoolOptions	options,
		CirctFirtoolCompanionMode	value )

Definition at line 143 of file Firtool.cpp.

References circt::firrtl::Bind, CIRCT_FIRTOOL_COMPANION_MODE_BIND, CIRCT_FIRTOOL_COMPANION_MODE_DROP, CIRCT_FIRTOOL_COMPANION_MODE_INSTANTIATE, circt::firrtl::Drop, circt::firrtl::Instantiate, and unwrap().

circtFirtoolOptionsSetDisableAggressiveMergeConnections()

void circtFirtoolOptionsSetDisableAggressiveMergeConnections	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 167 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetDisableAnnotationsClassless()

void circtFirtoolOptionsSetDisableAnnotationsClassless	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 44 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetDisableCSEinClasses()

void circtFirtoolOptionsSetDisableCSEinClasses	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 295 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetDisableLayerSink()

void circtFirtoolOptionsSetDisableLayerSink	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 123 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetDisableOptimization()

void circtFirtoolOptionsSetDisableOptimization	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 128 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetDisableRandom()

void circtFirtoolOptionsSetDisableRandom	(	CirctFirtoolFirtoolOptions	options,
		CirctFirtoolRandomKind	value )

Definition at line 197 of file Firtool.cpp.

References circt::firtool::FirtoolOptions::All, CIRCT_FIRTOOL_RANDOM_KIND_ALL, CIRCT_FIRTOOL_RANDOM_KIND_MEM, CIRCT_FIRTOOL_RANDOM_KIND_NONE, CIRCT_FIRTOOL_RANDOM_KIND_REG, circt::firtool::FirtoolOptions::Mem, circt::firtool::FirtoolOptions::Reg, and unwrap().

circtFirtoolOptionsSetDisableUnknownAnnotations()

void circtFirtoolOptionsSetDisableUnknownAnnotations	(	CirctFirtoolFirtoolOptions	options,
		bool	disable )

Definition at line 39 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetDomainMode()

void circtFirtoolOptionsSetDomainMode	(	CirctFirtoolFirtoolOptions	options,
		CirctFirtoolDomainMode	value )

Definition at line 306 of file Firtool.cpp.

References circt::firtool::FirtoolOptions::Check, CIRCT_FIRTOOL_DOMAIN_MODE_CHECK, CIRCT_FIRTOOL_DOMAIN_MODE_DISABLE, CIRCT_FIRTOOL_DOMAIN_MODE_INFER, CIRCT_FIRTOOL_DOMAIN_MODE_INFER_ALL, circt::firtool::FirtoolOptions::Disable, circt::firtool::FirtoolOptions::Infer, circt::firtool::FirtoolOptions::InferAll, and unwrap().

circtFirtoolOptionsSetEmitSeparateAlwaysBlocks()

void circtFirtoolOptionsSetEmitSeparateAlwaysBlocks	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 245 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetEnableAnnotationWarning()

void circtFirtoolOptionsSetEnableAnnotationWarning	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 220 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetEnableDebugInfo()

void circtFirtoolOptionsSetEnableDebugInfo	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 99 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetExportModuleHierarchy()

void circtFirtoolOptionsSetExportModuleHierarchy	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 280 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetIgnoreReadEnableMem()

void circtFirtoolOptionsSetIgnoreReadEnableMem	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 192 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetLowerAnnotationsNoRefTypePorts()

void circtFirtoolOptionsSetLowerAnnotationsNoRefTypePorts	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 49 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetLowerMemories()

void circtFirtoolOptionsSetLowerMemories	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 172 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetLowerToCore()

void circtFirtoolOptionsSetLowerToCore	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 230 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetNoDedup()

void circtFirtoolOptionsSetNoDedup	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 138 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetNoViews()

void circtFirtoolOptionsSetNoViews	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 162 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetOutputAnnotationFilename()

void circtFirtoolOptionsSetOutputAnnotationFilename	(	CirctFirtoolFirtoolOptions	options,
		MlirStringRef	value )

Definition at line 215 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetOutputFilename()

void circtFirtoolOptionsSetOutputFilename	(	CirctFirtoolFirtoolOptions	options,
		MlirStringRef	filename )

Definition at line 34 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetPreserveAggregate()

void circtFirtoolOptionsSetPreserveAggregate	(	CirctFirtoolFirtoolOptions	options,
		CirctFirtoolPreserveAggregateMode	value )

Definition at line 54 of file Firtool.cpp.

References circt::firrtl::PreserveAggregate::All, CIRCT_FIRTOOL_PRESERVE_AGGREGATE_MODE_ALL, CIRCT_FIRTOOL_PRESERVE_AGGREGATE_MODE_NONE, CIRCT_FIRTOOL_PRESERVE_AGGREGATE_MODE_ONE_DIM_VEC, CIRCT_FIRTOOL_PRESERVE_AGGREGATE_MODE_VEC, circt::firrtl::PreserveAggregate::None, circt::firrtl::PreserveAggregate::OneDimVec, unwrap(), and circt::firrtl::PreserveAggregate::Vec.

circtFirtoolOptionsSetPreserveValues()

void circtFirtoolOptionsSetPreserveValues	(	CirctFirtoolFirtoolOptions	options,
		CirctFirtoolPreserveValuesMode	value )

Definition at line 77 of file Firtool.cpp.

References circt::firrtl::PreserveValues::All, CIRCT_FIRTOOL_PRESERVE_VALUES_MODE_ALL, CIRCT_FIRTOOL_PRESERVE_VALUES_MODE_NAMED, CIRCT_FIRTOOL_PRESERVE_VALUES_MODE_NONE, CIRCT_FIRTOOL_PRESERVE_VALUES_MODE_STRIP, circt::firrtl::PreserveValues::Named, circt::firrtl::PreserveValues::None, circt::firrtl::PreserveValues::Strip, and unwrap().

circtFirtoolOptionsSetReplSeqMem()

void circtFirtoolOptionsSetReplSeqMem	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 182 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetReplSeqMemFile()

void circtFirtoolOptionsSetReplSeqMemFile	(	CirctFirtoolFirtoolOptions	options,
		MlirStringRef	value )

Definition at line 187 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetSelectDefaultInstanceChoice()

void circtFirtoolOptionsSetSelectDefaultInstanceChoice	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 301 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetStripDebugInfo()

void circtFirtoolOptionsSetStripDebugInfo	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 290 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetStripDomain()

void circtFirtoolOptionsSetStripDomain	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Erase all domain information after inference and checking.

Definition at line 326 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetStripFirDebugInfo()

void circtFirtoolOptionsSetStripFirDebugInfo	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 285 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetVbToBv()

void circtFirtoolOptionsSetVbToBv	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 133 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetVerificationFlavor()

void circtFirtoolOptionsSetVerificationFlavor	(	CirctFirtoolFirtoolOptions	options,
		firrtl::VerificationFlavor	value )

Definition at line 240 of file Firtool.cpp.

References unwrap().

circtFirtoolOptionsSetWarnOnTruncation()

void circtFirtoolOptionsSetWarnOnTruncation	(	CirctFirtoolFirtoolOptions	options,
		bool	value )

Definition at line 225 of file Firtool.cpp.

References unwrap().

circtFirtoolPopulateCHIRRTLToLowFIRRTL()

MlirLogicalResult circtFirtoolPopulateCHIRRTLToLowFIRRTL	(	MlirPassManager	pm,
		CirctFirtoolFirtoolOptions	options )

Definition at line 343 of file Firtool.cpp.

References circt::firtool::populateCHIRRTLToLowFIRRTL(), unwrap(), and wrap().

circtFirtoolPopulateExportSplitVerilog()

MlirLogicalResult circtFirtoolPopulateExportSplitVerilog	(	MlirPassManager	pm,
		CirctFirtoolFirtoolOptions	options,
		MlirStringRef	directory )

Definition at line 374 of file Firtool.cpp.

References circt::firtool::populateExportSplitVerilog(), unwrap(), and wrap().

circtFirtoolPopulateExportVerilog()

MlirLogicalResult circtFirtoolPopulateExportVerilog	(	MlirPassManager	pm,
		CirctFirtoolFirtoolOptions	options,
		MlirStringCallback	callback,
		void *	userData )

Definition at line 364 of file Firtool.cpp.

References circt::firtool::populateExportVerilog(), unwrap(), and wrap().

circtFirtoolPopulateFinalizeIR()

MlirLogicalResult circtFirtoolPopulateFinalizeIR	(	MlirPassManager	pm,
		CirctFirtoolFirtoolOptions	options )

Definition at line 382 of file Firtool.cpp.

References circt::firtool::populateFinalizeIR(), unwrap(), and wrap().

circtFirtoolpopulateHWToBTOR2()

MlirLogicalResult circtFirtoolpopulateHWToBTOR2	(	MlirPassManager	pm,
		CirctFirtoolFirtoolOptions	options,
		MlirStringCallback	callback,
		void *	userData )

Definition at line 388 of file Firtool.cpp.

References circt::firtool::populateHWToBTOR2(), unwrap(), and wrap().

circtFirtoolPopulateHWToSV()

MlirLogicalResult circtFirtoolPopulateHWToSV	(	MlirPassManager	pm,
		CirctFirtoolFirtoolOptions	options )

Definition at line 358 of file Firtool.cpp.

References circt::firtool::populateHWToSV(), unwrap(), and wrap().

circtFirtoolPopulateLowFIRRTLToHW()

MlirLogicalResult circtFirtoolPopulateLowFIRRTLToHW	(	MlirPassManager	pm,
		CirctFirtoolFirtoolOptions	options,
		MlirStringRef	inputFilename )

Definition at line 350 of file Firtool.cpp.

References circt::firtool::populateLowFIRRTLToHW(), unwrap(), and wrap().

circtFirtoolPopulatePreprocessTransforms()

MlirLogicalResult circtFirtoolPopulatePreprocessTransforms	(	MlirPassManager	pm,
		CirctFirtoolFirtoolOptions	options )

Definition at line 336 of file Firtool.cpp.

References circt::firtool::populatePreprocessTransforms(), unwrap(), and wrap().

DEFINE_C_API_PTR_METHODS()

DEFINE_C_API_PTR_METHODS	(	CirctFirtoolFirtoolOptions	,
		circt::firtool::FirtoolOptions	)

Definition at line 18 of file Firtool.cpp.

References wrap().