chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package chisel3

  This package contains the main chisel3 API.

  This package contains the main chisel3 API.

  Definition Classes
    root
-  package experimental

  Package for experimental features, which may have their API changed, be removed, etc.

  Package for experimental features, which may have their API changed, be removed, etc.

  Because its contents won't necessarily have the same level of stability and support as non-experimental, you must explicitly import this package to use its contents.

  Definition Classes
    chisel3
-  package dataview
  Definition Classes
    experimental
-  package hierarchy
  Definition Classes
    experimental
- AffectsChiselPrefix
- Analog
- BaseModule
- BundleLiteralException
- BundleLiterals
- ChiselAnnotation
- ChiselMultiAnnotation
- ChiselSubtypeOf
- CloneModuleAsRecord
- DeprecatedSourceInfo
- DoubleParam
- EnumAnnotations
- ExtModule
- HWTuple10
- HWTuple2
- HWTuple3
- HWTuple4
- HWTuple5
- HWTuple6
- HWTuple7
- HWTuple8
- HWTuple9
- HasAutoTypename
- HasTypeAlias
- IntParam
- IntrinsicModule
- NoSourceInfo
- OpaqueType
- Param
- RawParam
- RecordAlias
- SerializableModule
- SerializableModuleGenerator
- SerializableModuleParameter
- SourceInfo
- SourceLine
- StringParam
- Trace
- UnlocatableSourceInfo
- VecLiteralException
- VecLiterals
- annotate
- attach
- dedupGroup
- doNotDedup
- dump
- noPrefix
- prefix
- requireIsAnnotatable
- requireIsChiselType
- requireIsHardware
- skipPrefix
- treedump

o

chisel3.experimental

# Trace

###

#### object Trace

The util that records the reference map from original Data/Module annotated in Chisel and final FIRRTL.

Source
  Trace.scala
Example:

1.     class Dut extends Module {
         val a = WireDefault(Bool())
         Trace.traceName(a)
       }
       val annos = (new ChiselStage).execute(Seq(ChiselGeneratorAnnotation(() => new Dut)))
       val dut = annos.collectFirst { case DesignAnnotation(dut) => dut }.get.asInstanceOf[CollideModule]
       // get final reference of `a` Seq(ReferenceTarget("Dut", "Dut", Seq.empty, "a", Seq.empty))
       val firrtlReferenceOfDutA = finalTarget(annos)(dut.a)

Linear Supertypes
AnyRef, Any

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Trace
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
6.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
7.  def equals(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef → Any
8.  def finalTarget(annos: AnnotationSeq)(x: HasId): Seq[CompleteTarget]

   Get `CompleteTarget` of the target `x` for `annos`.

   Get `CompleteTarget` of the target `x` for `annos`. This API can be used to find the final reference to a signal or module which is marked by `traceName`

9.  def finalTargetMap(annos: AnnotationSeq): Map[CompleteTarget, Seq[CompleteTarget]]

   Get all traced signal/module for `annos` This API can be used to gather all final reference to the signal or module which is marked by `traceName`

10.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
11.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
12.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
13.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
14.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
15.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
16.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
17.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
18.  def toString(): String
    Definition Classes
      AnyRef → Any
19.  def traceName(x: Data): Unit

    Trace a Data name.

    Trace a Data name. This does NOT add "don't touch" semantics to the traced data. If you want this behavior, use an explicit chisel3.dontTouch.

20.  def traceName(x: RawModule): Unit

    Trace a Instance name.

21.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
22.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
23.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Inherited from AnyRef

### Inherited from Any

### Ungrouped