Packages

object Queue

Factory for a generic hardware queue.

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

Type Members

  1. class ShadowFactory extends AnyRef

    A factory for creating shadow queues.

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

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 apply[T <: Data](enq: ReadyValidIO[T], entries: Int = 2, pipe: Boolean = false, flow: Boolean = false, useSyncReadMem: Boolean = false, flush: Option[Bool] = None): DecoupledIO[T]

    Create a Queue and supply a DecoupledIO containing the product.

    Create a Queue and supply a DecoupledIO containing the product.

    enq

    input (enqueue) interface to the queue, also determines type of queue elements.

    entries

    depth (number of elements) of 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.

    flush

    Optional Bool signal, if defined, the Queue.hasFlush will be true, and connect correspond signal to Queue instance.

    returns

    output (dequeue) interface from the queue.

    Example:

    1. consumer.io.in <> Queue(producer.io.out, 16)
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def irrevocable[T <: Data](enq: ReadyValidIO[T], entries: Int = 2, pipe: Boolean = false, flow: Boolean = false, useSyncReadMem: Boolean = false, flush: Option[Bool] = None): IrrevocableIO[T]

    Create a queue and supply a IrrevocableIO containing the product.

    Create a queue and supply a IrrevocableIO containing the product. Casting from DecoupledIO is safe here because we know the Queue has Irrevocable semantics. we didn't want to change the return type of apply() for backwards compatibility reasons.

    enq

    DecoupledIO signal to enqueue.

    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.

    flush

    Optional Bool signal, if defined, the Queue.hasFlush will be true, and connect correspond signal to Queue instance.

    returns

    a DecoupledIO signal which should connect to the dequeue signal.

    Example:

    1. consumer.io.in <> Queue(producer.io.out, 16)
  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. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. def withShadow[T <: Data](enq: ReadyValidIO[T], entries: Int = 2, pipe: Boolean = false, flow: Boolean = false, useSyncReadMem: Boolean = false, flush: Option[Bool] = None): (DecoupledIO[T], ShadowFactory)

    Create a Queue and supply a DecoupledIO containing the product.

    Create a Queue and supply a DecoupledIO containing the product. This additionally returns a ShadowFactory which can be used to build shadow datapaths that work in lockstep with this Queue.

    enq

    input (enqueue) interface to the queue, also determines type of queue elements.

    entries

    depth (number of elements) of 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.

    flush

    Optional Bool signal, if defined, the Queue.hasFlush will be true, and connect correspond signal to Queue instance.

    returns

    output (dequeue) interface from the queue and a ShadowFactory for creating shadow Queues

Inherited from AnyRef

Inherited from Any

Ungrouped