#include <Firtool.h>

Collaboration diagram for circt::firtool::FirtoolOptions:

[legend]

Public Types
enum	BuildMode { BuildModeDebug , BuildModeRelease }

enum class	RandomKind { None , Mem , Reg , All }

Public Member Functions
bool	isRandomEnabled (RandomKind kind) const

firrtl::PreserveValues::PreserveMode	getPreserveMode () const

	FirtoolOptions (llvm::cl::OptionCategory &category)

Public Attributes
llvm::cl::OptionCategory &	category

llvm::cl::opt< std::string >	outputFilename

llvm::cl::opt< bool >	disableAnnotationsUnknown

llvm::cl::opt< bool >	disableAnnotationsClassless

llvm::cl::opt< bool >	lowerAnnotationsNoRefTypePorts

llvm::cl::opt< circt::firrtl::PreserveAggregate::PreserveMode >	preserveAggregate

llvm::cl::opt< firrtl::PreserveValues::PreserveMode >	preserveMode

llvm::cl::opt< bool >	enableDebugInfo

llvm::cl::opt< BuildMode >	buildMode

llvm::cl::opt< bool >	disableOptimization

llvm::cl::opt< bool >	exportChiselInterface

llvm::cl::opt< std::string >	chiselInterfaceOutDirectory

llvm::cl::opt< bool >	vbToBV

llvm::cl::opt< bool >	dedup

llvm::cl::opt< bool >	noDedup

llvm::cl::opt< firrtl::CompanionMode >	companionMode

llvm::cl::opt< bool >	disableAggressiveMergeConnections

llvm::cl::opt< bool >	disableHoistingHWPassthrough

llvm::cl::opt< bool >	emitOMIR

llvm::cl::opt< std::string >	omirOutFile

llvm::cl::opt< bool >	lowerMemories

llvm::cl::opt< std::string >	blackBoxRootPath

llvm::cl::opt< bool >	replSeqMem

llvm::cl::opt< std::string >	replSeqMemFile

llvm::cl::opt< bool >	extractTestCode

llvm::cl::opt< bool >	ignoreReadEnableMem

llvm::cl::opt< RandomKind >	disableRandom

llvm::cl::opt< std::string >	outputAnnotationFilename

llvm::cl::opt< bool >	enableAnnotationWarning

llvm::cl::opt< bool >	addMuxPragmas

llvm::cl::opt< bool >	emitChiselAssertsAsSVA

llvm::cl::opt< bool >	emitSeparateAlwaysBlocks

llvm::cl::opt< bool >	etcDisableInstanceExtraction

llvm::cl::opt< bool >	etcDisableRegisterExtraction

llvm::cl::opt< bool >	etcDisableModuleInlining

llvm::cl::opt< bool >	addVivadoRAMAddressConflictSynthesisBugWorkaround

seq::ExternalizeClockGateOptions	clockGateOpts

llvm::cl::opt< std::string, true >	ckgModuleName

llvm::cl::opt< std::string, true >	ckgInputName

llvm::cl::opt< std::string, true >	ckgOutputName

llvm::cl::opt< std::string, true >	ckgEnableName

llvm::cl::opt< std::string, true >	ckgTestEnableName

llvm::cl::opt< bool >	exportModuleHierarchy

llvm::cl::opt< bool >	stripFirDebugInfo

llvm::cl::opt< bool >	stripDebugInfo

Detailed Description

Definition at line 25 of file Firtool.h.

Member Enumeration Documentation

◆ BuildMode

enum circt::firtool::FirtoolOptions::BuildMode

Enumerator
BuildModeDebug
BuildModeRelease

Definition at line 84 of file Firtool.h.

◆ RandomKind

enum circt::firtool::FirtoolOptions::RandomKind

strong

Enumerator
None
Mem
Reg
All

Definition at line 190 of file Firtool.h.

Constructor & Destructor Documentation

◆ FirtoolOptions()

circt::firtool::FirtoolOptions::FirtoolOptions ( llvm::cl::OptionCategory & category )

inline

Definition at line 321 of file Firtool.h.

Member Function Documentation

◆ getPreserveMode()

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

inline

Definition at line 309 of file Firtool.h.

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

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

◆ isRandomEnabled()

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

inline

Definition at line 305 of file Firtool.h.

References All, and disableRandom.

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

Member Data Documentation

◆ addMuxPragmas

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::addMuxPragmas

Initial value:

{
      "add-mux-pragmas",
      llvm::cl::desc("Annotate mux pragmas for memory array access"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 216 of file Firtool.h.

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

◆ addVivadoRAMAddressConflictSynthesisBugWorkaround

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::addVivadoRAMAddressConflictSynthesisBugWorkaround

Initial value:

{
      "add-vivado-ram-address-conflict-synthesis-bug-workaround",
      llvm::cl::desc(
          "Add a vivado specific SV attribute (* ram_style = "
          "\"distributed\" *) to unpacked array registers as a workaronud "
          "for a vivado synthesis bug that incorrectly modifies "
          "address conflict behavivor of combinational memories"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 248 of file Firtool.h.

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

◆ blackBoxRootPath

llvm::cl::opt<std::string> circt::firtool::FirtoolOptions::blackBoxRootPath

Initial value:

{
      "blackbox-path",
      llvm::cl::desc(
          "Optional path to use as the root of black box annotations"),
      llvm::cl::value_desc("path"), llvm::cl::init(""),
      llvm::cl::cat(category)}

Definition at line 163 of file Firtool.h.

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

◆ buildMode

llvm::cl::opt<BuildMode> circt::firtool::FirtoolOptions::buildMode

Initial value:

{
      "O", llvm::cl::desc("Controls how much optimization should be performed"),
      llvm::cl::values(clEnumValN(BuildModeDebug, "debug",
                                  "Compile with only necessary optimizations"),
                       clEnumValN(BuildModeRelease, "release",
                                  "Compile with optimizations")),
      llvm::cl::cat(category)}

Definition at line 85 of file Firtool.h.

Referenced by getPreserveMode().

◆ category

llvm::cl::OptionCategory& circt::firtool::FirtoolOptions::category

Definition at line 26 of file Firtool.h.

◆ chiselInterfaceOutDirectory

llvm::cl::opt<std::string> circt::firtool::FirtoolOptions::chiselInterfaceOutDirectory

Initial value:

{
      "chisel-interface-out-dir",
      llvm::cl::desc(
          "The output directory for generated Chisel interface files"),
      llvm::cl::init(""), llvm::cl::cat(category)}

Definition at line 103 of file Firtool.h.

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

◆ ckgEnableName

llvm::cl::opt<std::string, true> circt::firtool::FirtoolOptions::ckgEnableName

Initial value:

{
      "ckg-enable", llvm::cl::desc("Clock gate enable port name"),
      llvm::cl::location(clockGateOpts.enableName), llvm::cl::init("en"),
      llvm::cl::cat(category)}

Definition at line 278 of file Firtool.h.

◆ ckgInputName

llvm::cl::opt<std::string, true> circt::firtool::FirtoolOptions::ckgInputName

Initial value:

{
      "ckg-input", llvm::cl::desc("Clock gate input port name"),
      llvm::cl::location(clockGateOpts.inputName), llvm::cl::init("in"),
      llvm::cl::cat(category)}

Definition at line 268 of file Firtool.h.

◆ ckgModuleName

llvm::cl::opt<std::string, true> circt::firtool::FirtoolOptions::ckgModuleName

Initial value:

{
      "ckg-name", llvm::cl::desc("Clock gate module name"),
      llvm::cl::location(clockGateOpts.moduleName),
      llvm::cl::init("EICG_wrapper"), llvm::cl::cat(category)}

Definition at line 263 of file Firtool.h.

◆ ckgOutputName

llvm::cl::opt<std::string, true> circt::firtool::FirtoolOptions::ckgOutputName

Initial value:

{
      "ckg-output", llvm::cl::desc("Clock gate output port name"),
      llvm::cl::location(clockGateOpts.outputName), llvm::cl::init("out"),
      llvm::cl::cat(category)}

Definition at line 273 of file Firtool.h.

◆ ckgTestEnableName

llvm::cl::opt<std::string, true> circt::firtool::FirtoolOptions::ckgTestEnableName

Initial value:

{
      "ckg-test-enable",
      llvm::cl::desc("Clock gate test enable port name (optional)"),
      llvm::cl::location(clockGateOpts.testEnableName),
      llvm::cl::init("test_en"), llvm::cl::cat(category)}

Definition at line 283 of file Firtool.h.

◆ clockGateOpts

seq::ExternalizeClockGateOptions circt::firtool::FirtoolOptions::clockGateOpts

Definition at line 261 of file Firtool.h.

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

◆ companionMode

llvm::cl::opt<firrtl::CompanionMode> circt::firtool::FirtoolOptions::companionMode

Initial value:

{
      "grand-central-companion-mode",
      llvm::cl::desc("Specifies the handling of Grand Central companions"),
      ::llvm::cl::values(
          clEnumValN(firrtl::CompanionMode::Bind, "bind",
                     "Lower companion instances to SystemVerilog binds"),
          clEnumValN(firrtl::CompanionMode::Instantiate, "instantiate",
                     "Instantiate companions in the design"),
          clEnumValN(firrtl::CompanionMode::Drop, "drop",
                     "Remove companions from the design")),
      llvm::cl::init(firrtl::CompanionMode::Bind),
      llvm::cl::Hidden,
      llvm::cl::cat(category)}

Definition at line 123 of file Firtool.h.

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

◆ dedup

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::dedup

Initial value:

{
      "dedup", llvm::cl::desc("Deduplicate structurally identical modules"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 114 of file Firtool.h.

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

◆ disableAggressiveMergeConnections

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::disableAggressiveMergeConnections

Initial value:

{
      "disable-aggressive-merge-connections",
      llvm::cl::desc(
          "Disable aggressive merge connections (i.e. merge all field-level "
          "connections into bulk connections)"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 137 of file Firtool.h.

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

◆ disableAnnotationsClassless

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::disableAnnotationsClassless

Initial value:

{
      "disable-annotation-classless",
      llvm::cl::desc("Ignore annotations without a class when parsing"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 38 of file Firtool.h.

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

◆ disableAnnotationsUnknown

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::disableAnnotationsUnknown

Initial value:

{
      "disable-annotation-unknown",
      llvm::cl::desc("Ignore unknown annotations when parsing"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 33 of file Firtool.h.

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

◆ disableHoistingHWPassthrough

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::disableHoistingHWPassthrough

Initial value:

{
      "disable-hoisting-hw-passthrough",
      llvm::cl::desc("Disable hoisting HW passthrough signals"),
      llvm::cl::init(true), llvm::cl::Hidden, llvm::cl::cat(category)}

Definition at line 144 of file Firtool.h.

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

◆ disableOptimization

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::disableOptimization

Initial value:

{
      "disable-opt", llvm::cl::desc("Disable optimizations"),
      llvm::cl::cat(category)}

Definition at line 93 of file Firtool.h.

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

◆ disableRandom

llvm::cl::opt<RandomKind> circt::firtool::FirtoolOptions::disableRandom

Initial value:

{
      llvm::cl::desc(
          "Disable random initialization code (may break semantics!)"),
      llvm::cl::values(
          clEnumValN(RandomKind::Mem, "disable-mem-randomization",
                     "Disable emission of memory randomization code"),
          clEnumValN(RandomKind::Reg, "disable-reg-randomization",
                     "Disable emission of register randomization code"),
          clEnumValN(RandomKind::All, "disable-all-randomization",
                     "Disable emission of all randomization code")),
      llvm::cl::init(RandomKind::None), llvm::cl::cat(category)}

Definition at line 192 of file Firtool.h.

Referenced by isRandomEnabled().

◆ emitChiselAssertsAsSVA

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::emitChiselAssertsAsSVA

Initial value:

{
      "emit-chisel-asserts-as-sva",
      llvm::cl::desc("Convert all chisel asserts into SVA"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 221 of file Firtool.h.

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

◆ emitOMIR

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::emitOMIR

Initial value:

{
      "emit-omir", llvm::cl::desc("Emit OMIR annotations to a JSON file"),
      llvm::cl::init(true), llvm::cl::cat(category)}

Definition at line 149 of file Firtool.h.

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

◆ emitSeparateAlwaysBlocks

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::emitSeparateAlwaysBlocks

Initial value:

{
      "emit-separate-always-blocks",
      llvm::cl::desc(
          "Prevent always blocks from being merged and emit constructs into "
          "separate always blocks whenever possible"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 226 of file Firtool.h.

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

◆ enableAnnotationWarning

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::enableAnnotationWarning

Initial value:

{
      "warn-on-unprocessed-annotations",
      llvm::cl::desc(
          "Warn about annotations that were not removed by lower-to-hw"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 210 of file Firtool.h.

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

◆ enableDebugInfo

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::enableDebugInfo

Initial value:

{
      "g", llvm::cl::desc("Enable the generation of debug information"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 79 of file Firtool.h.

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

◆ etcDisableInstanceExtraction

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::etcDisableInstanceExtraction

Initial value:

{
      "etc-disable-instance-extraction",
      llvm::cl::desc("Disable extracting instances only that feed test code"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 233 of file Firtool.h.

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

◆ etcDisableModuleInlining

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::etcDisableModuleInlining

Initial value:

{
      "etc-disable-module-inlining",
      llvm::cl::desc("Disable inlining modules that only feed test code"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 243 of file Firtool.h.

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

◆ etcDisableRegisterExtraction

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::etcDisableRegisterExtraction

Initial value:

{
      "etc-disable-register-extraction",
      llvm::cl::desc("Disable extracting registers that only feed test code"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 238 of file Firtool.h.

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

◆ exportChiselInterface

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::exportChiselInterface

Initial value:

{
      "export-chisel-interface",
      llvm::cl::desc("Generate a Scala Chisel interface to the top level "
                     "module of the firrtl circuit"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 97 of file Firtool.h.

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

◆ exportModuleHierarchy

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::exportModuleHierarchy

Initial value:

{
      "export-module-hierarchy",
      llvm::cl::desc("Export module and instance hierarchy as JSON"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 289 of file Firtool.h.

Referenced by detail::populatePrepareForExportVerilog().

◆ extractTestCode

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::extractTestCode

Initial value:

{
      "extract-test-code", llvm::cl::desc("Run the extract test code pass"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 180 of file Firtool.h.

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

◆ ignoreReadEnableMem

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::ignoreReadEnableMem

Initial value:

{
      "ignore-read-enable-mem",
      llvm::cl::desc("Ignore the read enable signal, instead of "
                     "assigning X on read disable"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 184 of file Firtool.h.

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

◆ lowerAnnotationsNoRefTypePorts

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::lowerAnnotationsNoRefTypePorts

Initial value:

{
      "lower-annotations-no-ref-type-ports",
      llvm::cl::desc(
          "Create real ports instead of ref type ports when resolving "
          "wiring problems inside the LowerAnnotations pass"),
      llvm::cl::init(false), llvm::cl::Hidden, llvm::cl::cat(category)}

Definition at line 43 of file Firtool.h.

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

◆ lowerMemories

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::lowerMemories

Initial value:

{
      "lower-memories",
      llvm::cl::desc("Lower memories to have memories with masks as an "
                     "array with one memory per ground type"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 157 of file Firtool.h.

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

◆ noDedup

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::noDedup

Initial value:

{
      "no-dedup",
      llvm::cl::desc("Disable deduplication of structurally identical modules"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 118 of file Firtool.h.

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

◆ omirOutFile

llvm::cl::opt<std::string> circt::firtool::FirtoolOptions::omirOutFile

Initial value:

{
      "output-omir", llvm::cl::desc("File name for the output omir"),
      llvm::cl::init(""), llvm::cl::cat(category)}

Definition at line 153 of file Firtool.h.

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

◆ outputAnnotationFilename

llvm::cl::opt<std::string> circt::firtool::FirtoolOptions::outputAnnotationFilename

Initial value:

{
      "output-annotation-file",
      llvm::cl::desc("Optional output annotation file"),
      llvm::cl::CommaSeparated, llvm::cl::value_desc("filename"),
      llvm::cl::cat(category)}

Definition at line 204 of file Firtool.h.

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

◆ outputFilename

llvm::cl::opt<std::string> circt::firtool::FirtoolOptions::outputFilename

Initial value:

{
      "o", llvm::cl::desc("Output filename, or directory for split output"),
      llvm::cl::value_desc("filename"), llvm::cl::init("-"),
      llvm::cl::cat(category)}

Definition at line 28 of file Firtool.h.

Referenced by detail::populatePrepareForExportVerilog().

◆ preserveAggregate

llvm::cl::opt<circt::firrtl::PreserveAggregate::PreserveMode> circt::firtool::FirtoolOptions::preserveAggregate

Initial value:

{
          "preserve-aggregate", llvm::cl::desc("Specify input file format:"),
          llvm::cl::values(
              clEnumValN(circt::firrtl::PreserveAggregate::None, "none",
                         "Preserve no aggregate"),
              clEnumValN(circt::firrtl::PreserveAggregate::OneDimVec, "1d-vec",
                         "Preserve only 1d vectors of ground type"),
              clEnumValN(circt::firrtl::PreserveAggregate::Vec, "vec",
                         "Preserve only vectors"),
              clEnumValN(circt::firrtl::PreserveAggregate::All, "all",
                         "Preserve vectors and bundles")),
          llvm::cl::init(circt::firrtl::PreserveAggregate::None),
          llvm::cl::cat(category)}

Definition at line 51 of file Firtool.h.

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

◆ preserveMode

llvm::cl::opt<firrtl::PreserveValues::PreserveMode> circt::firtool::FirtoolOptions::preserveMode

Initial value:

{
      "preserve-values",
      llvm::cl::desc("Specify the values which can be optimized away"),
      llvm::cl::values(
          clEnumValN(firrtl::PreserveValues::Strip, "strip",
                     "Strip all names. No name is preserved"),
          clEnumValN(firrtl::PreserveValues::None, "none",
                     "Names could be preserved by best-effort unlike `strip`"),
          clEnumValN(firrtl::PreserveValues::Named, "named",
                     "Preserve values with meaningful names"),
          clEnumValN(firrtl::PreserveValues::All, "all",
                     "Preserve all values")),
      llvm::cl::init(firrtl::PreserveValues::None), llvm::cl::cat(category)}

Definition at line 65 of file Firtool.h.

Referenced by getPreserveMode().

◆ replSeqMem

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::replSeqMem

Initial value:

{
      "repl-seq-mem",
      llvm::cl::desc("Replace the seq mem for macro replacement and emit "
                     "relevant metadata"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 170 of file Firtool.h.

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

◆ replSeqMemFile

llvm::cl::opt<std::string> circt::firtool::FirtoolOptions::replSeqMemFile

Initial value:

{
      "repl-seq-mem-file", llvm::cl::desc("File name for seq mem metadata"),
      llvm::cl::init(""), llvm::cl::cat(category)}

Definition at line 176 of file Firtool.h.

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

◆ stripDebugInfo

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::stripDebugInfo

Initial value:

{
      "strip-debug-info",
      llvm::cl::desc("Disable source locator information in output Verilog"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 300 of file Firtool.h.

Referenced by detail::populatePrepareForExportVerilog().

◆ stripFirDebugInfo

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::stripFirDebugInfo

Initial value:

{
      "strip-fir-debug-info",
      llvm::cl::desc(
          "Disable source fir locator information in output Verilog"),
      llvm::cl::init(true), llvm::cl::cat(category)}

Definition at line 294 of file Firtool.h.

Referenced by detail::populatePrepareForExportVerilog().

◆ vbToBV

llvm::cl::opt<bool> circt::firtool::FirtoolOptions::vbToBV

Initial value:

{
      "vb-to-bv",
      llvm::cl::desc("Transform vectors of bundles to bundles of vectors"),
      llvm::cl::init(false), llvm::cl::cat(category)}

Definition at line 109 of file Firtool.h.

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

The documentation for this struct was generated from the following file:

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

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ BuildMode

◆ RandomKind

Constructor & Destructor Documentation

◆ FirtoolOptions()

Member Function Documentation

◆ getPreserveMode()

◆ isRandomEnabled()

Member Data Documentation

◆ addMuxPragmas

◆ addVivadoRAMAddressConflictSynthesisBugWorkaround

◆ blackBoxRootPath

◆ buildMode

◆ category

◆ chiselInterfaceOutDirectory

◆ ckgEnableName

◆ ckgInputName

◆ ckgModuleName

◆ ckgOutputName

◆ ckgTestEnableName

◆ clockGateOpts

◆ companionMode

◆ dedup

◆ disableAggressiveMergeConnections

◆ disableAnnotationsClassless

◆ disableAnnotationsUnknown

◆ disableHoistingHWPassthrough

◆ disableOptimization

◆ disableRandom

◆ emitChiselAssertsAsSVA

◆ emitOMIR

◆ emitSeparateAlwaysBlocks

◆ enableAnnotationWarning

◆ enableDebugInfo

◆ etcDisableInstanceExtraction

◆ etcDisableModuleInlining

◆ etcDisableRegisterExtraction

◆ exportChiselInterface

◆ exportModuleHierarchy

◆ extractTestCode

◆ ignoreReadEnableMem

◆ lowerAnnotationsNoRefTypePorts

◆ lowerMemories

◆ noDedup

◆ omirOutFile

◆ outputAnnotationFilename

◆ outputFilename

◆ preserveAggregate

◆ preserveMode

◆ replSeqMem

◆ replSeqMemFile

◆ stripDebugInfo

◆ stripFirDebugInfo

◆ vbToBV