Packages

class Queue[T <: Data] extends Module

A hardware module implementing a Queue

Source
Decoupled.scala
Example: 

  1. val q = Module(new Queue(UInt(), 16))
q.io.enq <> producer.io.out
consumer.io.in <> q.io.deq
Linear Supertypes
Module, RawModule, BaseModule, IsInstantiable, HasId, internal.InstanceId, AnyRef, Any
Known Subclasses
QueueCompatibility
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Queue
  2. Module
  3. RawModule
  4. BaseModule
  5. IsInstantiable
  6. HasId
  7. InstanceId
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Queue(gen: T, entries: Int, pipe: Boolean = false, flow: Boolean = false, useSyncReadMem: Boolean = false, hasFlush: Boolean = false)(implicit compileOptions: CompileOptions)

    gen

    The type of data to queue

    entries

    The max number of entries in the queue

    pipe

    True if a single entry queue can run at full throughput (like a pipeline). The ready signals are combinationally coupled.

    flow

    True if the inputs can be consumed on the same cycle (the inputs "flow" through the queue immediately). The valid signals are coupled.

    useSyncReadMem

    True uses SyncReadMem instead of Mem as an internal memory element.

    hasFlush

    True if generated queue requires a flush feature

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. def IO[T <: Data](iodef: T): T
    Attributes
    protected
    Definition Classes
    BaseModule
  5. def _bindIoInPlace(iodef: Data): Unit
    Attributes
    protected
    Definition Classes
    BaseModule
  6. var _closed: Boolean
    Attributes
    protected
    Definition Classes
    BaseModule
  7. def _compatAutoWrapPorts(): Unit
    Definition Classes
    BaseModule
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def circuitName: String
    Attributes
    protected
    Definition Classes
    HasId
  10. final val clock: Clock
    Definition Classes
    Module
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  12. val compileOptions: CompileOptions
    Definition Classes
    RawModule
  13. val deq_ptr: Counter
  14. def desiredName: String
    Definition Classes
    BaseModule
  15. val do_deq: Bool
  16. val do_enq: Bool
  17. val empty: Bool
  18. val enq_ptr: Counter
  19. val entries: Int
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(that: Any): Boolean
    Definition Classes
    HasId → AnyRef → Any
  22. val flow: Boolean
  23. val flush: Bool
  24. val full: Bool
  25. val gen: T
  26. val genType: T
  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def getCommands: Seq[Command]
    Attributes
    protected
    Definition Classes
    RawModule
  29. def getModulePorts: Seq[Data]
    Attributes
    protected[chisel3]
    Definition Classes
    BaseModule
  30. val hasFlush: Boolean
  31. def hasSeed: Boolean
    Definition Classes
    HasId
  32. def hashCode(): Int
    Definition Classes
    HasId → AnyRef → Any
  33. def instanceName: String
    Definition Classes
    BaseModule → HasId → InstanceId
  34. val io: QueueIO[T]
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. val maybe_full: Bool
  37. final lazy val name: String
    Definition Classes
    BaseModule
  38. def nameIds(rootClass: Class[_]): HashMap[HasId, String]
    Attributes
    protected
    Definition Classes
    BaseModule
  39. val namingContext$macro$8: NamingContextInterface
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. def parentModName: String
    Definition Classes
    HasId → InstanceId
  44. def parentPathName: String
    Definition Classes
    HasId → InstanceId
  45. def pathName: String
    Definition Classes
    HasId → InstanceId
  46. val pipe: Boolean
  47. def portsContains(elem: Data): Boolean
    Attributes
    protected
    Definition Classes
    BaseModule
  48. def portsSize: Int
    Attributes
    protected
    Definition Classes
    BaseModule
  49. val ptr_diff: UInt
  50. val ptr_match: Bool
  51. val ram: MemBase[T]
  52. final val reset: Reset
    Definition Classes
    Module
  53. def suggestName(seed: ⇒ String): Queue.this.type
    Definition Classes
    HasId
  54. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  55. final def toAbsoluteTarget: IsModule
    Definition Classes
    BaseModule → InstanceId
  56. final def toNamed: ModuleName
    Definition Classes
    BaseModule → InstanceId
  57. def toString(): String
    Definition Classes
    AnyRef → Any
  58. final def toTarget: ModuleTarget
    Definition Classes
    BaseModule → InstanceId
  59. val useSyncReadMem: Boolean
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. lazy val getPorts: Seq[Port]
    Definition Classes
    RawModule
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Use DataMirror.modulePorts instead. this API will be removed in Chisel 3.6

  3. def override_clock: Option[Clock]
    Attributes
    protected
    Definition Classes
    Module
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Use withClock at Module instantiation

  4. def override_clock_=(rhs: Option[Clock]): Unit
    Attributes
    protected
    Definition Classes
    Module
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Use withClock at Module instantiation

  5. def override_reset: Option[Bool]
    Attributes
    protected
    Definition Classes
    Module
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Use withClock at Module instantiation

  6. def override_reset_=(rhs: Option[Bool]): Unit
    Attributes
    protected
    Definition Classes
    Module
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Use withClock at Module instantiation

Inherited from Module

Inherited from RawModule

Inherited from BaseModule

Inherited from IsInstantiable

Inherited from HasId

Inherited from internal.InstanceId

Inherited from AnyRef

Inherited from Any

Ungrouped