ElaboratedCircuit

chisel3.ElaboratedCircuit
See theElaboratedCircuit companion object
sealed trait ElaboratedCircuit

The result of running Chisel elaboration

Provides limited APIs for inspection of the resulting circuit.

Attributes

Companion
object
Source
ElaboratedCircuit.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def annotations: Iterable[Annotation]

The annotations created during elaboration of this circuit

The annotations created during elaboration of this circuit

This does not include annotations passed to elaboration.

Attributes

Source
ElaboratedCircuit.scala
def lazilySerialize: Iterable[String]

The circuit and annotations as a lazy buffer of strings of FIRRTL IR

The circuit and annotations as a lazy buffer of strings of FIRRTL IR

This will include annotations passed to Chisel to build the circuit and those created during elaboration. Serialized lazily to reduce peak memory use and support cicuits larger than 2 GiB.

Attributes

Source
ElaboratedCircuit.scala
def lazilySerialize(annotations: Iterable[Annotation]): Iterable[String]

The circuit and annotations as a lazy buffer of strings of FIRRTL IR

The circuit and annotations as a lazy buffer of strings of FIRRTL IR

Serialized lazily to reduce peak memory use and support cicuits larger than 2 GiB.

Value parameters

annotations

annotations to include in the FIRRTL IR. No other annotations will be included.

Attributes

Source
ElaboratedCircuit.scala
def name: String

The name of the circuit, also the name of the top public module

The name of the circuit, also the name of the top public module

Attributes

Source
ElaboratedCircuit.scala
def serialize: String

The circuit and annotations as a string of FIRRTL IR

The circuit and annotations as a string of FIRRTL IR

This will include annotations passed to Chisel to build the circuit and those created during elaboration. For large circuits (> 2 GiB of text) use lazilySerialize.

Attributes

Source
ElaboratedCircuit.scala
def serialize(annotations: Iterable[Annotation]): String

The circuit and annotations as a string of FIRRTL IR

The circuit and annotations as a string of FIRRTL IR

For large circuits (> 2 GiB of text) use lazilySerialize

Value parameters

annotations

annotations to include in the FIRRTL IR. No other annotations will be included.

Attributes

Source
ElaboratedCircuit.scala

The Definition of the top module in the elaborated circuit

The Definition of the top module in the elaborated circuit

Attributes

Source
ElaboratedCircuit.scala