firrtl
package firrtl
- Alphabetic
- By Inheritance
- firrtl
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- final case class OneFilePerModule(targetDir: String) extends OutputConfig with Product with Serializable
-
sealed abstract
class
OutputConfig extends AnyRef
Firrtl output configuration specified by FirrtlExecutionOptions
Firrtl output configuration specified by FirrtlExecutionOptions
Derived from the fields of the execution options
- final case class SingleFile(targetFile: String) extends OutputConfig with Product with Serializable
- type WDefInstance = DefInstance
- type WRef = Reference
- type WSubAccess = SubAccess
- type WSubField = SubField
- type WSubIndex = SubIndex
-
case class
CommonOptions(topName: String = "", targetDirName: String = ".", globalLogLevel: logger.LogLevel.Value = LogLevel.None, logToFile: Boolean = false, logClassNames: Boolean = false, classLogLevels: Map[String, logger.LogLevel.Value] = Map.empty, programArgs: Seq[String] = Seq.empty) extends ComposableOptions with Product with Serializable
Most of the chisel toolchain components require a topName which defines a circuit or a device under test.
Most of the chisel toolchain components require a topName which defines a circuit or a device under test. Much of the work that is done takes place in a directory. It would be simplest to require topName to be defined but in practice it is preferred to defer this. For example, in chisel, by deferring this it is possible for the execute there to first elaborate the circuit and then set the topName from that if it has not already been set.
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use a FirrtlOptionsView, LoggerOptionsView, or construct your own view of an AnnotationSeq
-
trait
ComposableOptions extends AnyRef
Use this trait to define an options class that can add its private command line options to a externally declared parser.
Use this trait to define an options class that can add its private command line options to a externally declared parser. NOTE In all derived trait/classes, if you intend on maintaining backwards compatibility, be sure to add new options at the end of the current ones and don't remove any existing ones.
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use firrtl.options.HasScoptOptions and/or library/transform registration
-
class
ExecutionOptionsManager extends HasParser with HasCommonOptions
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use new FirrtlStage infrastructure
-
case class
FirrtlExecutionFailure(message: String) extends FirrtlExecutionResult with Product with Serializable
The firrtl compilation failed.
The firrtl compilation failed.
- message
Some kind of hint as to what went wrong.
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use FirrtlStage and examine the output AnnotationSeq directly
-
case class
FirrtlExecutionOptions(inputFileNameOverride: String = "", outputFileNameOverride: String = "", compilerName: String = "verilog", infoModeName: String = "append", inferRW: Seq[String] = Seq.empty, firrtlSource: Option[String] = None, customTransforms: Seq[Transform] = List.empty, annotations: List[Annotation] = List.empty, annotationFileNameOverride: String = "", outputAnnotationFileName: String = "", emitOneFilePerModule: Boolean = false, dontCheckCombLoops: Boolean = false, noDCE: Boolean = false, annotationFileNames: List[String] = List.empty, firrtlCircuit: Option[Circuit] = None) extends ComposableOptions with Product with Serializable
The options that firrtl supports in callable component sense
The options that firrtl supports in callable component sense
- inputFileNameOverride
default is targetDir/topName.fir
- outputFileNameOverride
default is targetDir/topName.v the .v is based on the compilerName parameter
- compilerName
which compiler to use
- annotations
annotations to pass to compiler
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use a FirrtlOptionsView or construct your own view of an AnnotationSeq
-
sealed
trait
FirrtlExecutionResult extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use FirrtlStage and examine the output AnnotationSeq directly
-
class
FirrtlExecutionSuccess extends FirrtlExecutionResult
Indicates a successful execution of the firrtl compiler, returning the compiled result and the type of compile
Indicates a successful execution of the firrtl compiler, returning the compiled result and the type of compile
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use FirrtlStage and examine the output AnnotationSeq directly
-
trait
HasCommonOptions extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Specify command line arguments in an Annotation mixing in HasScoptOptions
-
trait
HasFirrtlOptions extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Specify command line arguments in an Annotation mixing in HasScoptOptions
-
abstract
class
HasParser extends AnyRef
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use firrtl.options.{ExecutionOptionsManager, TerminateOnExit, DuplicateHandling}
-
type
TargetDirAnnotation = firrtl.options.TargetDirAnnotation
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use firrtl.options.TargetDirAnnotation
Value Members
Deprecated Value Members
-
val
TargetDirAnnotation: firrtl.options.TargetDirAnnotation.type
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use firrtl.options.TargetDirAnnotation
-
object
Driver
The driver provides methods to access the firrtl compiler.
The driver provides methods to access the firrtl compiler. Invoke the compiler with either a FirrtlExecutionOption
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use firrtl.stage.FirrtlStage
val optionsManager = new ExecutionOptionsManager("firrtl") optionsManager.register( FirrtlExecutionOptionsKey -> new FirrtlExecutionOptions(topName = "Dummy", compilerName = "verilog")) firrtl.Driver.execute(optionsManager)
or a series of command line arguments
, firrtl.Driver.execute(Array("--top-name Dummy --compiler verilog".split(" +"))
each approach has its own endearing aspects
- See also
firrtlTests/DriverSpec.scala in the test directory for a lot more examples
CompilerUtils.mergeTransforms to see how customTransformations are inserted
Examples: -
object
FirrtlExecutionSuccess
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use FirrtlStage and examine the output AnnotationSeq directly