Chisel

Queue

class Queue[T <: Data] extends Module

A hardware module implementing a Queue

T

the type of data to queue

Source
ChiselUtil.scala
Example:
  1. val q = new Queue(UInt(), 16)
    q.io.enq <> producer.io.out
    consumer.io.in <> q.io.deq
Linear Supertypes
Module, Nameable, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Queue
  2. Module
  3. Nameable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Queue(gen: T, entries: Int, pipe: Boolean = false, flow: Boolean = false, _reset: Option[Bool] = scala.None)

    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.

    _reset

    The reset signal to pass to this queue

Type Members

  1. type neededWireWraps = HashMap[StackTraceElement, ArrayBuffer[Data]]

    verifyWireWrap (Chisel3) - verify assignment semantics (type-only nodes must be wire-wrapped)

    verifyWireWrap (Chisel3) - verify assignment semantics (type-only nodes must be wire-wrapped)

    returns

    - HashMap of source lines (and associated nodes) requiring Wire() wrapping.

    Definition Classes
    Module

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def <>(src: Module): Unit

    Connect io with matching names for two modules

    Connect io with matching names for two modules

    Definition Classes
    Module
  5. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  6. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  7. def IO[T <: Data](iodef: T): iodef.type

    Definition Classes
    Module
  8. var _clock: Option[Clock]

    Definition Classes
    Module
  9. def addClock(clock: Clock): Unit

    Add a clock to the module

    Add a clock to the module

    clock

    the clock to add

    Definition Classes
    Module
  10. def addDefaultReset: Unit

    Add a default reset to the module

    Add a default reset to the module

    Definition Classes
    Module
  11. def addModule[T <: Module](c: ⇒ T)(implicit p: Parameters = params): T

    Add a submodule to this module

    Add a submodule to this module

    Definition Classes
    Module
  12. def addModule[T <: Module](c: ⇒ T, f: PartialFunction[Any, Any]): T

    Add a submodule to this module

    Add a submodule to this module

    Definition Classes
    Module
  13. def addNode[T <: Node](node: T): T

    Definition Classes
    Module
  14. def addPin[T <: Data](pin: T, name: String = ""): T

    Add a pin with a name to the module

    Add a pin with a name to the module

    pin

    the I/O to add

    name

    A name for the pin

    Definition Classes
    Module
  15. def addResetPin(r: Bool): Bool

    returns

    the pin connected to the reset signal or creates a new one if no such pin exists

    Definition Classes
    Module
  16. def apply(name: String): Data

    Definition Classes
    Module
  17. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  18. def assert(cond: Bool, message: String = ""): Unit

    Add an assertion in the code generated by a backend.

    Add an assertion in the code generated by a backend.

    Definition Classes
    Module
  19. def bfs(visit: (Node) ⇒ Unit): Unit

    A breadth first search of the graph of nodes

    A breadth first search of the graph of nodes

    Definition Classes
    Module
  20. val children: ArrayBuffer[Module]

    Definition Classes
    Module
  21. def clock: Clock

    returns

    the implied clock for this module

    Definition Classes
    Module
  22. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. def debug(data: Aggregate): Unit

    Definition Classes
    Module
  24. def debug(x: Node): Unit

    Insures a backend does not remove a signal because it is unreachable from the outputs.

    Insures a backend does not remove a signal because it is unreachable from the outputs.

    Definition Classes
    Module
  25. val deq_ptr: Counter

  26. def dfs(visit: (Node) ⇒ Unit): Unit

    A depth first search of the graph of nodes

    A depth first search of the graph of nodes

    Definition Classes
    Module
  27. val do_deq: Bool

  28. val do_enq: Bool

  29. val do_flow: Bool

  30. val empty: Bool

  31. val enq_ptr: Counter

  32. val entries: Int

    The max number of entries in the queue

  33. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  34. def equals(that: Any): Boolean

    Definition Classes
    Module → AnyRef → Any
  35. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  36. def findBinding(m: Node): Option[Binding]

    A method to trace the graph of nodes backwards looking at inputs

    A method to trace the graph of nodes backwards looking at inputs

    m

    Node to find bindings for

    returns

    nodes which have node m binded as their input

    Definition Classes
    Module
  37. val full: Bool

  38. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  39. def getPathName(separator: String = "_"): String

    separator

    The separator to use for the path name

    returns

    the absolute path to a component instance from toplevel

    Definition Classes
    Module
  40. def getPathName: String

    returns

    the absolute path to a component instance from toplevel

    Definition Classes
    Module
  41. val hashCode: Int

    Definition Classes
    Module → AnyRef → Any
  42. val io: QueueIO[T]

    The I/O for this queue

    The I/O for this queue

    Definition Classes
    QueueModule
  43. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  44. val maybe_flow: Bool

  45. val maybe_full: Bool

  46. var moduleName: String

    Name of the module this component generates (defaults to class name).

    Name of the module this component generates (defaults to class name).

    Definition Classes
    Module
  47. var name: String

    Name of the instance.

    Name of the instance.

    Definition Classes
    Nameable
  48. var named: Boolean

    named is used to indicate that name was set explicitly and should not be overriden

    named is used to indicate that name was set explicitly and should not be overriden

    Definition Classes
    Nameable
  49. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  50. def nextIndex: Int

    Definition Classes
    Module
  51. final def notify(): Unit

    Definition Classes
    AnyRef
  52. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  53. lazy val params: Parameters

    Definition Classes
    Module
  54. var parent: Module

    Definition Classes
    Module
  55. def printf(message: String, args: Node*): Unit

    Adds a printf to the module called each clock cycle

    Adds a printf to the module called each clock cycle

    message

    A c style sting to print out eg) %d, %x

    args

    Nodes whos data values should be printed

    Definition Classes
    Module
  56. val ptr_diff: UInt

  57. val ptr_match: Bool

  58. val ram: Mem[T]

  59. def reset: Bool

    returns

    the implied reset for this module

    Definition Classes
    Module
  60. def setModuleName(n: String): Unit

    Set the declaration name of the module to be string 'n'

    Set the declaration name of the module to be string 'n'

    Definition Classes
    Module
  61. def setName(n: String): Unit

    Set the name of this module to the string 'n'

    Set the name of this module to the string 'n'

    Definition Classes
    Nameable
    Example:
    1. my.io.node.setName("MY_IO_NODE")
  62. def stripComponent(s: String): String

    Definition Classes
    Module
  63. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  64. def toString(): String

    Definition Classes
    Module → AnyRef → Any
  65. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. def wires: Array[(String, Bits)]

    Get the I/O names and connections

    Get the I/O names and connections

    Definition Classes
    Module

Inherited from Module

Inherited from Nameable

Inherited from AnyRef

Inherited from Any

Ungrouped