Queue

Instance Constructors

new Queue(gen: T, entries: Int, pipe: Boolean = false, flow: Boolean = false)

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.
new Queue(gen: T, entries: Int, pipe: Boolean, flow: Boolean, _reset: Bool)

Annotations
@deprecated
Deprecated
(Since version chisel3) Module constructor with override _reset deprecated, use withReset
new Queue(gen: T, entries: Int, pipe: Boolean, flow: Boolean, override_reset: Option[Bool])

Annotations
@deprecated
Deprecated
(Since version chisel3) Module constructor with override _reset deprecated, use withReset

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

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

This must wrap the datatype used to set the io field of any Module.
This must wrap the datatype used to set the io field of any Module. i.e. All concrete modules must have defined io in this form: [lazy] val io[: io type] = IO(...[: io type])
Items in [] are optional.
The granted iodef WILL NOT be cloned (to allow for more seamless use of anonymous Bundles in the IO) and thus CANNOT have been bound to any logic. This will error if any node is bound (e.g. due to logic in a Bundle constructor, which is considered improper).
Also registers a Data as a port, also performing bindings. Cannot be called once ports are requested (so that all calls to ports will return the same information). Internal API.
TODO(twigg): Specifically walk the Data definition to call out which nodes are problematic.

Attributes
protected
Definition Classes
BaseModule
def _autoWrapPorts(): Unit

Compatibility function.
Compatibility function. Allows Chisel2 code which had ports without the IO wrapper to compile under Bindings checks. Does nothing in non-compatibility mode.
Should NOT be used elsewhere. This API will NOT last.
TODO: remove this, perhaps by removing Bindings checks in compatibility mode.

Definition Classes
BaseModule
var _closed: Boolean

Attributes
protected
Definition Classes
BaseModule
def _ioPortBound(): Boolean

Attributes
protected
Definition Classes
LegacyModule
def annotate(annotation: ChiselAnnotation): Unit

Attributes
protected
Definition Classes
BaseModule
final def asInstanceOf[T0]: T0

Definition Classes
Any
val clock: core.Clock

Definition Classes
ImplicitModule
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val compileOptions: CompileOptions

Definition Classes
UserModule
def desiredName: String

Desired name of this module.
Desired name of this module. Override this to give this module a custom, perhaps parametric, name.

Definition Classes
BaseModule
val entries: Int

The max number of entries in the queue
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
HasId → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getCommands: Seq[Command]

Attributes
protected
Definition Classes
UserModule
def getIds: Seq[HasId]

Attributes
protected
Definition Classes
BaseModule
def getModulePorts: Seq[core.Data]

Attributes
protected
Definition Classes
BaseModule
lazy val getPorts: Seq[Port]

Definition Classes
UserModule
def hashCode(): Int

Definition Classes
HasId → AnyRef → Any
def instanceName: String

Signal name (for simulation).
Signal name (for simulation).

Definition Classes
BaseModule → HasId → InstanceId
val io: QueueIO[T]

Definition Classes
Queue → LegacyModule
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final val name: String

Legalized name of this module.
Legalized name of this module.

Definition Classes
BaseModule
def nameIds(rootClass: Class[_]): HashMap[HasId, String]

Called at the Module.apply(...) level after this Module has finished elaborating.
Called at the Module.apply(...) level after this Module has finished elaborating. Returns a map of nodes -> names, for named nodes.
Helper method.

Attributes
protected
Definition Classes
LegacyModule → BaseModule
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
var override_clock: Option[core.Clock]

Attributes
protected
Definition Classes
LegacyModule
var override_reset: Option[core.Bool]

Attributes
protected
Definition Classes
LegacyModule
def parentModName: String

Definition Classes
HasId → InstanceId
def parentPathName: String

Definition Classes
HasId → InstanceId
def pathName: String

Definition Classes
HasId → InstanceId
def portsContains(elem: core.Data): Boolean

Attributes
protected
Definition Classes
BaseModule
def portsSize: Int

Attributes
protected
Definition Classes
BaseModule
val reset: core.Bool

Definition Classes
ImplicitModule
def suggestName(name: ⇒ String): Queue.this.type

Definition Classes
HasId
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Queue | package util

class Queue[T <: Data] extends Module

Instance Constructors

new Queue(gen: T, entries: Int, pipe: Boolean = false, flow: Boolean = false)

new Queue(gen: T, entries: Int, pipe: Boolean, flow: Boolean, _reset: Bool)

new Queue(gen: T, entries: Int, pipe: Boolean, flow: Boolean, override_reset: Option[Bool])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def IO[T <: core.Data](iodef: T): iodef.type

def _autoWrapPorts(): Unit

var _closed: Boolean

def _ioPortBound(): Boolean

def annotate(annotation: ChiselAnnotation): Unit

final def asInstanceOf[T0]: T0

val clock: core.Clock

def clone(): AnyRef

val compileOptions: CompileOptions

def desiredName: String

val entries: Int

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getCommands: Seq[Command]

def getIds: Seq[HasId]

def getModulePorts: Seq[core.Data]

lazy val getPorts: Seq[Port]

def hashCode(): Int

def instanceName: String

val io: QueueIO[T]

final def isInstanceOf[T0]: Boolean

final val name: String

def nameIds(rootClass: Class[_]): HashMap[HasId, String]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

var override_clock: Option[core.Clock]

var override_reset: Option[core.Bool]

def parentModName: String

def parentPathName: String

def pathName: String

def portsContains(elem: core.Data): Boolean

def portsSize: Int

val reset: core.Bool

def suggestName(name: ⇒ String): Queue.this.type

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from LegacyModule

Inherited from ImplicitModule

Inherited from UserModule

Inherited from BaseModule

Inherited from HasId

Inherited from InstanceId

Inherited from AnyRef

Inherited from Any

Ungrouped