Packages

class NodeMirror extends NodeApi

Linear Supertypes
NodeApi, NodeBaseApi, AnyRef, Any
Known Subclasses
InsertArea, Area
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NodeMirror
  2. NodeApi
  3. NodeBaseApi
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new NodeMirror(node: Node)

Type Members

  1. class BundlePimper[T <: Bundle] extends AnyRef
    Definition Classes
    NodeBaseApi

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(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
  5. 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
  6. def apply(key: NamedTypeKey): Data
    Definition Classes
    NodeApi → NodeBaseApi
  7. 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
  8. def arbitrateFrom[T <: Data](that: Flow[T]): Unit
    Definition Classes
    NodeApi
  9. def arbitrateFrom[T <: Data](that: Stream[T]): Unit
    Definition Classes
    NodeApi
  10. def arbitrateTo[T <: Data](that: Flow[T]): Unit
    Definition Classes
    NodeApi
  11. def arbitrateTo[T <: Data](that: Stream[T]): Unit
    Definition Classes
    NodeApi
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. implicit def bundlePimper[T <: Bundle](stageable: Payload[T]): BundlePimper[T]
    Definition Classes
    NodeBaseApi
  14. 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

  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  16. def defaultKey: Any
    Definition Classes
    NodeApi
  17. def driveFrom[T <: Data](that: Flow[T])(con: (Node, T) => Unit): Unit
    Definition Classes
    NodeApi
  18. def driveFrom[T <: Data](that: Stream[T])(con: (Node, T) => Unit): Unit
    Definition Classes
    NodeApi
  19. def driveTo[T <: Data](that: Flow[T])(con: (T, Node) => Unit): Unit
    Definition Classes
    NodeApi
  20. def driveTo[T <: Data](that: Stream[T])(con: (T, Node) => Unit): Unit
    Definition Classes
    NodeApi
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. def getNode: Node
    Definition Classes
    NodeMirror → NodeApi
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  26. 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
  27. def isCancel: Bool

    Read-only accessor of cancel

    Read-only accessor of cancel

    Definition Classes
    NodeApi → NodeBaseApi
  28. 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
  29. 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
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. 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
  32. def isReady: Bool

    Read-only accessor of ready

    Read-only accessor of ready

    Definition Classes
    NodeApi → NodeBaseApi
  33. def isValid: Bool

    Read-only accessor of valid

    Read-only accessor of valid

    Definition Classes
    NodeApi → NodeBaseApi
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  37. 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

  38. implicit def stageablePiped2[T <: Data](stageable: Payload[T]): T
    Definition Classes
    NodeBaseApi
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def toFlow[T <: Data](con: (Node) => T): Flow[T]
    Definition Classes
    NodeApi
  41. def toStream[T <: Data](con: (Node) => T): Stream[T]
    Definition Classes
    NodeApi
  42. def toString(): String
    Definition Classes
    AnyRef → Any
  43. 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

  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from NodeApi

Inherited from NodeBaseApi

Inherited from AnyRef

Inherited from Any

Ungrouped