Packages

p

firrtl2

package firrtl2

Source
package.scala
Linear Supertypes
AnyRef, Any
Content Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. firrtl2
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package analyses
  2. package annotations
  3. package backends
  4. package benchmark
  5. package checks
  6. package constraint
  7. package features
  8. package graph
  9. package ir
  10. package logger
  11. package options
  12. package passes
  13. package renamemap
  14. package stage

    The stage package provides an implementation of the FIRRTL compiler using the firrtl2.options package.

    The stage package provides an implementation of the FIRRTL compiler using the firrtl2.options package. This primarily consists of:

  15. package transforms
  16. package traversals
  17. package util

Type Members

  1. class AddDescriptionNodes extends Transform

    Wraps modules or statements with their respective described nodes.

    Wraps modules or statements with their respective described nodes. Descriptions come from DescriptionAnnotation. Describing a module or any of its ports will turn it into a DescribedMod. Describing a Statement will turn it into a (private) DescribedStmt.

    Note

    should only be used by VerilogEmitter, described nodes will break other transforms.

  2. type AnnotationSeq = Seq[Annotation]

    Container of all annotations for a Firrtl compiler

  3. case class Attribute(string: StringLit) extends FirrtlNode with Description with Product with Serializable

    A Verilog-style attribute.

    A Verilog-style attribute.

    string

    the attribute

  4. case class AttributeAnnotation(target: Target, description: String) extends DescriptionAnnotation with Product with Serializable

    An Verilog-style attribute.

    An Verilog-style attribute.

    target

    the object being given an attribute

    description

    the attribute

  5. case class CDefMPort(info: Info, name: String, tpe: Type, mem: String, exps: Seq[Expression], direction: MPortDir) extends Statement with HasInfo with CanBeReferenced with UseSerializer with Product with Serializable
  6. case class CDefMemory(info: Info, name: String, tpe: Type, size: BigInt, seq: Boolean, readUnderWrite: ir.ReadUnderWrite.Value = ReadUnderWrite.Undefined) extends Statement with HasInfo with CanBeReferenced with UseSerializer with Product with Serializable
  7. class ChirrtlEmitter extends FirrtlEmitter
  8. case class CircuitState(circuit: Circuit, annotations: AnnotationSeq, renames: Option[RenameMap]) extends Product with Serializable

    Current State of the Circuit

    Current State of the Circuit

    circuit

    The current state of the Firrtl AST

    annotations

    The current collection of Annotation

    renames

    A map of Named things that have been renamed. Generally only a return value from Transforms

  9. trait ConnectEmissionOption extends EmissionOption

    Emission customization options for connect

  10. case class CustomDefaultMemoryEmission(initValue: MemoryInitValue) extends MemoryEmissionOption with NoTargetAnnotation with Product with Serializable

    Customize how memory initialization code is emitted

  11. case class CustomDefaultRegisterEmission(useInitAsPreset: Boolean, disableRandomization: Boolean) extends RegisterEmissionOption with NoTargetAnnotation with Product with Serializable

    Control how register initialization code is emitted

  12. case class CustomTransformException(cause: Throwable) extends Exception with Product with Serializable

    Wraps exceptions from CustomTransforms so they can be reported appropriately

  13. sealed trait Description extends FirrtlNode

    Base trait for a description that gives some information about a FirrtlNode.

    Base trait for a description that gives some information about a FirrtlNode. Usually, we would like to emit these descriptions in some way.

  14. sealed trait DescriptionAnnotation extends Annotation

    A base trait for Annotations that describe a FirrtlNode.

    A base trait for Annotations that describe a FirrtlNode. Usually, we would like to emit these descriptions in some way.

  15. case class DocString(string: StringLit) extends FirrtlNode with Description with Product with Serializable

    A docstring description (a comment)

    A docstring description (a comment)

    string

    a comment

  16. case class DocStringAnnotation(target: Target, description: String) extends DescriptionAnnotation with Product with Serializable

    A docstring description (a comment).

    A docstring description (a comment).

    target

    the object being described

    description

    the docstring describing the object

  17. trait EmissionOption extends AnyRef

    Base type for emission customization options NOTE: all the following traits must be mixed with SingleTargetAnnotation[T <: Named] in order to be taken into account in the Emitter

  18. case class EmitAllModulesAnnotation(emitter: Class[_ <: Emitter]) extends EmitAnnotation with Product with Serializable
  19. sealed trait EmitAnnotation extends NoTargetAnnotation
  20. case class EmitCircuitAnnotation(emitter: Class[_ <: Emitter]) extends EmitAnnotation with Product with Serializable
  21. trait EmittedAnnotation[T <: EmittedComponent] extends NoTargetAnnotation with CustomFileEmission

    Traits for Annotations containing emitted components

  22. sealed abstract class EmittedCircuit extends EmittedComponent
  23. sealed trait EmittedCircuitAnnotation[T <: EmittedCircuit] extends EmittedAnnotation[T]
  24. sealed abstract class EmittedComponent extends AnyRef
  25. final case class EmittedFirrtlCircuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit with Product with Serializable
  26. case class EmittedFirrtlCircuitAnnotation(value: EmittedFirrtlCircuit) extends EmittedCircuitAnnotation[EmittedFirrtlCircuit] with Product with Serializable
  27. final case class EmittedFirrtlModule(name: String, value: String, outputSuffix: String) extends EmittedModule with Product with Serializable
  28. case class EmittedFirrtlModuleAnnotation(value: EmittedFirrtlModule) extends EmittedModuleAnnotation[EmittedFirrtlModule] with Product with Serializable
  29. sealed abstract class EmittedModule extends EmittedComponent
  30. sealed trait EmittedModuleAnnotation[T <: EmittedModule] extends EmittedAnnotation[T]
  31. final case class EmittedVerilogCircuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit with Product with Serializable
  32. case class EmittedVerilogCircuitAnnotation(value: EmittedVerilogCircuit) extends EmittedCircuitAnnotation[EmittedVerilogCircuit] with Product with Serializable
  33. final case class EmittedVerilogModule(name: String, value: String, outputSuffix: String) extends EmittedModule with Product with Serializable
  34. case class EmittedVerilogModuleAnnotation(value: EmittedVerilogModule) extends EmittedModuleAnnotation[EmittedVerilogModule] with Product with Serializable
  35. trait Emitter extends Transform

    Defines old API for Emission.

    Defines old API for Emission. Deprecated

  36. case class EmitterException(message: String) extends PassException with Product with Serializable
  37. sealed abstract class FirrtlEmitter extends Transform with Emitter
  38. class FirrtlUserException extends RuntimeException with NoStackTrace

    Exception indicating user error

    Exception indicating user error

    These exceptions indicate a problem due to bad input and thus do not include a stack trace. This can be extended by custom transform writers.

  39. trait Flow extends AnyRef
  40. class HighFirrtlEmitter extends FirrtlEmitter
  41. case class InvalidEscapeCharException(message: String) extends ParserException with Product with Serializable
  42. case class InvalidStringLitException(message: String) extends ParserException with Product with Serializable
  43. trait Kind extends AnyRef
  44. abstract class LexerHelper extends AnyRef
  45. class LowFirrtlEmitter extends FirrtlEmitter
  46. abstract class MPortDir extends FirrtlNode
  47. class MemoizedHash[T] extends AnyRef
  48. case class MemoryArrayInit(values: Seq[BigInt]) extends MemoryInitValue with Product with Serializable
  49. trait MemoryEmissionOption extends EmissionOption

    Emission customization options for memories

  50. case class MemoryFileInlineInit(filename: String, hexOrBinary: FileType) extends MemoryInitValue with Product with Serializable
  51. sealed trait MemoryInitValue extends AnyRef

    Emission customization option for memory initialization

  52. case class MemoryScalarInit(value: BigInt) extends MemoryInitValue with Product with Serializable
  53. class MiddleFirrtlEmitter extends FirrtlEmitter
  54. class MinimumHighFirrtlEmitter extends FirrtlEmitter
  55. class MinimumVerilogEmitter extends VerilogEmitter with Emitter
  56. class ModuleGraph extends AnyRef

    Maintains a one to many graph of each modules instantiated child module.

    Maintains a one to many graph of each modules instantiated child module. This graph can be searched for a path from a child module back to one of it's parents. If one is found a recursive loop has happened The graph is a map between the name of a node to set of names of that nodes children

  57. class Namespace extends AnyRef
  58. trait NodeEmissionOption extends EmissionOption

    Emission customization options for nodes

  59. case class ParameterNotSpecifiedException(message: String) extends ParserException with Product with Serializable
  60. case class ParameterRedefinedException(message: String) extends ParserException with Product with Serializable
  61. class ParserException extends FirrtlUserException
  62. trait PortEmissionOption extends EmissionOption

    Emission customization options for IO ports

  63. trait RegisterEmissionOption extends EmissionOption

    Emission customization options for registers

  64. sealed trait RenameMap extends AnyRef

    Map old names to new names

    Map old names to new names

    Transforms that modify names should return a RenameMap with the CircuitState These are mutable datastructures for convenience

  65. trait ResolvedAnnotationPaths extends AnyRef

    Extend for transforms that require resolved targets in their annotations Ensures all targets in annotations of a class in annotationClasses are resolved before the execute method

  66. abstract class SeqTransform extends Transform with SeqTransformBased

    For transformations that are simply a sequence of transforms

  67. trait SeqTransformBased extends AnyRef
  68. case class SyntaxErrorsException(message: String) extends ParserException with Product with Serializable
  69. class SystemVerilogEmitter extends VerilogEmitter
  70. trait Transform extends TransformLike[CircuitState] with DependencyAPI[Transform]

    The basic unit of operating on a Firrtl AST

  71. case class UnsupportedVersionException(message: String) extends ParserException with Product with Serializable
  72. case class VRandom(width: BigInt) extends Expression with Product with Serializable
  73. class VerilogEmitter extends SeqTransform with Emitter
  74. class Visitor extends AbstractParseTreeVisitor[FirrtlNode] with ParseTreeVisitor[FirrtlNode]
  75. type WDefInstance = DefInstance
  76. case class WDefInstanceConnector(info: Info, name: String, module: String, tpe: Type, portCons: Seq[(Expression, Expression)]) extends Statement with IsDeclaration with CanBeReferenced with UseSerializer with Product with Serializable
  77. type WRef = Reference
  78. type WSubAccess = SubAccess
  79. type WSubField = SubField
  80. type WSubIndex = SubIndex
  81. trait WireEmissionOption extends EmissionOption

    Emission customization options for wires

  82. class WrappedExpression extends AnyRef
  83. case class WrappedInt(value: BigInt) extends Product with Serializable
  84. class WrappedType extends AnyRef
  85. class WrappedWidth extends AnyRef

Deprecated Type Members

  1. type TargetDirAnnotation = firrtl2.options.TargetDirAnnotation
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.2) Use firrtl.options.TargetDirAnnotation

Value Members

  1. implicit def annoSeqToSeq(as: AnnotationSeq): Seq[Annotation]
  2. implicit def seqToAnnoSeq(xs: Seq[Annotation]): AnnotationSeq
  3. case object Addw extends PrimOp with Product with Serializable
  4. object AnnotationSeq
  5. case object BuildInfo extends Product with Serializable

    This object was generated by sbt-buildinfo.

  6. object CircuitState extends Serializable
  7. case object ConnectEmissionOptionDefault extends ConnectEmissionOption with Product with Serializable

    default Emitter behavior for connect

  8. case object Dshlw extends PrimOp with Product with Serializable
  9. case object DuplexFlow extends Flow with Product with Serializable
  10. object EmitAllModulesAnnotation extends HasShellOptions with Serializable
  11. object EmitCircuitAnnotation extends HasShellOptions with Serializable
  12. case object EmptyExpression extends Expression with UseSerializer with Product with Serializable
  13. case object ExpKind extends Kind with Product with Serializable
  14. object FileUtils
  15. object Implicits
  16. case object InstanceKind extends Kind with Product with Serializable
  17. object LowFirrtlOptimizedEmitter extends FirrtlEmitter
  18. case object MInfer extends MPortDir with Product with Serializable
  19. case object MRead extends MPortDir with Product with Serializable
  20. case object MReadWrite extends MPortDir with Product with Serializable
  21. case object MWrite extends MPortDir with Product with Serializable
  22. object Mappers
  23. case object MemKind extends Kind with Product with Serializable
  24. object MemoizedHash
  25. case object MemoryEmissionOptionDefault extends MemoryEmissionOption with Product with Serializable

    default Emitter behavior for memories

  26. case object MemoryNoInit extends MemoryInitValue with Product with Serializable
  27. case object MemoryRandomInit extends MemoryInitValue with Product with Serializable
  28. object Namespace
  29. case object NodeEmissionOptionDefault extends NodeEmissionOption with Product with Serializable

    default Emitter behavior for nodes

  30. case object NodeKind extends Kind with Product with Serializable
  31. object Parser extends LazyLogging
  32. case object PoisonKind extends Kind with Product with Serializable
  33. case object PortEmissionOptionDefault extends PortEmissionOption with Product with Serializable

    default Emitter behavior for IO ports

  34. case object PortKind extends Kind with Product with Serializable
  35. object PrimOps extends LazyLogging

    Definitions and Utility functions for ir.PrimOps

  36. case object RandomKind extends Kind with Product with Serializable
  37. case object RegKind extends Kind with Product with Serializable
  38. case object RegisterEmissionOptionDefault extends RegisterEmissionOption with Product with Serializable

    default Emitter behavior for registers

  39. object RenameMap
  40. case object SinkFlow extends Flow with Product with Serializable
  41. case object SourceFlow extends Flow with Product with Serializable
  42. case object Subw extends PrimOp with Product with Serializable
  43. case object UnknownFlow extends Flow with Product with Serializable
  44. case object UnknownKind extends Kind with Product with Serializable
  45. object Utils extends LazyLogging
  46. object VerilogEmitter
  47. object WDefInstance
  48. case object WInvalid extends Expression with UseSerializer with Product with Serializable
  49. object WRef
  50. object WSubAccess
  51. object WSubField
  52. object WSubIndex
  53. case object WVoid extends Expression with UseSerializer with Product with Serializable
  54. case object WireEmissionOptionDefault extends WireEmissionOption with Product with Serializable

    default Emitter behavior for wires

  55. case object WireKind extends Kind with Product with Serializable
  56. object WrappedExpression
  57. object WrappedType
  58. object WrappedWidth
  59. object bitWidth

    Helper object for computing the width of a firrtl type.

  60. object castRhs
  61. object connectFields
  62. object flattenType
  63. object fromBits
  64. object getWidth
  65. object seqCat
  66. object toBits

    Given an expression, return an expression consisting of all sub-expressions concatenated (or flattened).

Deprecated Value Members

  1. val TargetDirAnnotation: firrtl2.options.TargetDirAnnotation.type
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.2) Use firrtl.options.TargetDirAnnotation

Inherited from AnyRef

Inherited from Any

Ungrouped