NodeMirror

Instance Constructors

new NodeMirror(node: Node)

Type Members

class BundlePimper[T <: Bundle] extends AnyRef

Definition Classes
NodeBaseApi

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 apply(subKey: Seq[Any]): OffsetApi

Allows converting a list of key into values.
Allows converting a list of key into values. ex : node(1 to 2)(MY_STAGEABLE)

Definition Classes
NodeApi → NodeBaseApi
def apply[T <: Data](key: Payload[T]): T

Return the hardware signal for this Payload key at the point of this Node in the pipeline.
Return the hardware signal for this Payload key at the point of this Node in the pipeline.

Definition Classes
NodeApi → NodeBaseApi
def apply(key: NamedTypeKey): Data

Definition Classes
NodeApi → NodeBaseApi
def apply[T <: Data](key: Payload[T], subKey: Any): T

Return the hardware signal for this (Payload, subKey) key at the point of this Node in the pipeline.
Return the hardware signal for this (Payload, subKey) key at the point of this Node in the pipeline.
This eases the construction of multi-lane hardware. For instance, when you have a multi-issue CPU pipeline, you can use the lane Int id as secondary key.

Definition Classes
NodeBaseApi
def arbitrateFrom[T <: Data](that: Flow[T]): Unit

Definition Classes
NodeApi
def arbitrateFrom[T <: Data](that: Stream[T]): Unit

Definition Classes
NodeApi
def arbitrateTo[T <: Data](that: Flow[T]): Unit

Definition Classes
NodeApi
def arbitrateTo[T <: Data](that: Stream[T]): Unit

Definition Classes
NodeApi
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit def bundlePimper[T <: Bundle](stageable: Payload[T]): BundlePimper[T]

Definition Classes
NodeBaseApi
def cancel: Bool

The signal which specifies if the node’s transaction in being canceled from the pipeline.
The signal which specifies if the node’s transaction in being canceled from the pipeline.
It is driven by the downstream. The signal has no meaning when there is no transaction (valid being deasserted).
Created on demand, thus it's important to use isReady to get the signal value.

Definition Classes
NodeApi → NodeBaseApi
See also
Node documentation
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def defaultKey: Any

Definition Classes
NodeApi
def driveFrom[T <: Data](that: Flow[T])(con: (Node, T) ⇒ Unit): Unit

Definition Classes
NodeApi
def driveFrom[T <: Data](that: Stream[T])(con: (Node, T) ⇒ Unit): Unit

Definition Classes
NodeApi
def driveTo[T <: Data](that: Flow[T])(con: (T, Node) ⇒ Unit): Unit

Definition Classes
NodeApi
def driveTo[T <: Data](that: Stream[T])(con: (T, Node) ⇒ Unit): Unit

Definition Classes
NodeApi
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def getNode: Node

Definition Classes
NodeMirror → NodeApi
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def insert[T <: Data](that: T): Payload[T]

Return a new Payload which is connected to the given Data hardware signal starting from this Node in the pipeline.
Return a new Payload which is connected to the given Data hardware signal starting from this Node in the pipeline.

Definition Classes
NodeBaseApi
def isCancel: Bool

Read-only accessor of cancel
Read-only accessor of cancel

Definition Classes
NodeApi → NodeBaseApi
def isCanceling: Bool

True when the node transaction is being cleaned up.
True when the node transaction is being cleaned up.
Meaning that it will not appear anywhere in the pipeline in future cycles. It is equivalent to isValid && isCancel.

Definition Classes
NodeApi → NodeBaseApi
def isFiring: Bool

True when the current transaction is successfully moving forward (isReady && !isRemoved).
True when the current transaction is successfully moving forward (isReady && !isRemoved).
Useful to validate state changes.

Definition Classes
NodeApi → NodeBaseApi
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isMoving: Bool

True when it is the last cycle that the current transaction is present on this node.
True when it is the last cycle that the current transaction is present on this node.
More precisely, True when the node transaction will not be present anymore on the node (starting from the next cycle), either because downstream is ready to take the transaction, or because the transaction is canceled from the pipeline. (valid && (ready || cancel)).
Useful to “reset” states.

Definition Classes
NodeApi → NodeBaseApi
def isReady: Bool

Read-only accessor of ready
Read-only accessor of ready

Definition Classes
NodeApi → NodeBaseApi
def isValid: Bool

Read-only accessor of valid
Read-only accessor of valid

Definition Classes
NodeApi → NodeBaseApi
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def ready: Bool

The signal which specifies if the node’s transaction can proceed downstream.
The signal which specifies if the node’s transaction can proceed downstream.
It is driven by the downstream to create backpressure. The signal has no meaning when there is no transaction (valid being deasserted).
Created on demand, thus it's important to use isReady to get the signal value.

Definition Classes
NodeApi → NodeBaseApi
See also
Node documentation
implicit def stageablePiped2[T <: Data](stageable: Payload[T]): T

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

Definition Classes
AnyRef
def toFlow[T <: Data](con: (Node) ⇒ T): Flow[T]

Definition Classes
NodeApi
def toStream[T <: Data](con: (Node) ⇒ T): Stream[T]

Definition Classes
NodeApi
def toString(): String

Definition Classes
AnyRef → Any
def valid: Bool

The signal which specifies if a transaction is present on the node.
The signal which specifies if a transaction is present on the node.
It is driven by the upstream. Once asserted, it must only be de-asserted the cycle after which either both valid and ready or cancel are high. valid must not depend on ready.
Created on demand, thus it's important to use isValid to get the signal value.

Definition Classes
NodeApi → NodeBaseApi
See also
Node documentation
final def wait(arg0: Long, arg1: Int): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package pipeline

class NodeMirror extends NodeApi

Instance Constructors

new NodeMirror(node: Node)

Type Members

class BundlePimper[T <: Bundle] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply(subKey: Seq[Any]): OffsetApi

def apply[T <: Data](key: Payload[T]): T

def apply(key: NamedTypeKey): Data

def apply[T <: Data](key: Payload[T], subKey: Any): T

def arbitrateFrom[T <: Data](that: Flow[T]): Unit

def arbitrateFrom[T <: Data](that: Stream[T]): Unit

def arbitrateTo[T <: Data](that: Flow[T]): Unit

def arbitrateTo[T <: Data](that: Stream[T]): Unit

final def asInstanceOf[T0]: T0

implicit def bundlePimper[T <: Bundle](stageable: Payload[T]): BundlePimper[T]

def cancel: Bool

def clone(): AnyRef

def defaultKey: Any

def driveFrom[T <: Data](that: Flow[T])(con: (Node, T) ⇒ Unit): Unit

def driveFrom[T <: Data](that: Stream[T])(con: (Node, T) ⇒ Unit): Unit

def driveTo[T <: Data](that: Flow[T])(con: (T, Node) ⇒ Unit): Unit

def driveTo[T <: Data](that: Stream[T])(con: (T, Node) ⇒ Unit): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def getClass(): Class[_]

def getNode: Node

def hashCode(): Int

def insert[T <: Data](that: T): Payload[T]

def isCancel: Bool

def isCanceling: Bool

def isFiring: Bool

final def isInstanceOf[T0]: Boolean

def isMoving: Bool

def isReady: Bool

def isValid: Bool

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def ready: Bool

implicit def stageablePiped2[T <: Data](stageable: Payload[T]): T

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

def toFlow[T <: Data](con: (Node) ⇒ T): Flow[T]

def toStream[T <: Data](con: (Node) ⇒ T): Stream[T]

def toString(): String

def valid: Bool

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

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from NodeApi

Inherited from NodeBaseApi

Inherited from AnyRef

Inherited from Any

Ungrouped