Packages

  • package root

    This is the documentation for Chisel.

    This is the documentation for Chisel.

    Package structure

    The chisel3 package presents the public API of Chisel. It contains the concrete core types UInt, SInt, Bool, Clock, and Reg, the abstract types Bits, Aggregate, and Data, and the aggregate types Bundle and Vec.

    The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.

    Utility objects and methods are found in the util package.

    The testers package defines the basic interface for chisel testers.

    Definition Classes
    root
  • package chisel3

    This package contains the main chisel3 API.

    This package contains the main chisel3 API.

    Definition Classes
    root
  • package util

    The util package provides extensions to core chisel for common hardware components and utility functions

    The util package provides extensions to core chisel for common hardware components and utility functions

    Definition Classes
    chisel3
  • object Queue

    Factory for a generic hardware queue.

    Factory for a generic hardware queue.

    Definition Classes
    util
  • ShadowFactory
c

chisel3.util.Queue

ShadowFactory

class ShadowFactory extends AnyRef

A factory for creating shadow queues. This is created using the withShadow method.

Source
Queue.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShadowFactory
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  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. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ShadowFactory toany2stringadd[ShadowFactory] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ShadowFactory, B)
    Implicit
    This member is added by an implicit conversion from ShadowFactory toArrowAssoc[ShadowFactory] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def apply[A <: Data](data: A, layer: Layer): Valid[A]

    Create a "shadow" Queue in a specific layer that will be queued and dequeued in lockstep with an original Queue.

    Create a "shadow" Queue in a specific layer that will be queued and dequeued in lockstep with an original Queue. Connections are made using BoringUtils.tapAndRead which allows this method to be called anywhere in the hierarchy.

    An intended use case of this is as a building block of a "shadow" design verification datapath which augments an existing design datapath with additional information. E.g., a shadow datapath that tracks transations in an interconnect.

    data

    a hardware data that should be enqueued together with the original Queue's data

    layer

    the Layer in which this queue should be created

    returns

    a layer-colored Valid interface of probe type

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def ensuring(cond: (ShadowFactory) => Boolean, msg: => Any): ShadowFactory
    Implicit
    This member is added by an implicit conversion from ShadowFactory toEnsuring[ShadowFactory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (ShadowFactory) => Boolean): ShadowFactory
    Implicit
    This member is added by an implicit conversion from ShadowFactory toEnsuring[ShadowFactory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): ShadowFactory
    Implicit
    This member is added by an implicit conversion from ShadowFactory toEnsuring[ShadowFactory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): ShadowFactory
    Implicit
    This member is added by an implicit conversion from ShadowFactory toEnsuring[ShadowFactory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ShadowFactory toStringFormat[ShadowFactory] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (ShadowFactory, B)
    Implicit
    This member is added by an implicit conversion from ShadowFactory toArrowAssoc[ShadowFactory] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromShadowFactory to any2stringadd[ShadowFactory]

Inherited by implicit conversion StringFormat fromShadowFactory to StringFormat[ShadowFactory]

Inherited by implicit conversion Ensuring fromShadowFactory to Ensuring[ShadowFactory]

Inherited by implicit conversion ArrowAssoc fromShadowFactory to ArrowAssoc[ShadowFactory]

Ungrouped