Class/Object

spinal.lib.misc.pipeline

Node

Related Docs: object Node | package pipeline

Permalink

class Node extends Area with NodeApi

Linear Supertypes
NodeApi, NodeBaseApi, core.Area, OverridedEqualsHashCode, ValCallbackRec, ValCallback, NameableByComponent, Nameable, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Node
  2. NodeApi
  3. NodeBaseApi
  4. Area
  5. OverridedEqualsHashCode
  6. ValCallbackRec
  7. ValCallback
  8. NameableByComponent
  9. Nameable
  10. ContextUser
  11. ScalaLocated
  12. GlobalDataUser
  13. OwnableRef
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Node()

    Permalink

Type Members

  1. class Area extends core.Area with NodeApi

    Permalink
  2. class BundlePimper[T <: Bundle] extends AnyRef

    Permalink
    Definition Classes
    NodeBaseApi
  3. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. val _context: Capture

    Permalink
    Definition Classes
    Area
  5. def apply(subKey: Seq[Any]): OffsetApi

    Permalink

    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
    NodeApiNodeBaseApi
  6. def apply[T <: Data](key: Payload[T]): T

    Permalink

    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
    NodeApiNodeBaseApi
  7. def apply(key: NamedTypeKey): Data

    Permalink
    Definition Classes
    NodeApiNodeBaseApi
  8. def apply[T <: Data](key: Payload[T], subKey: Any): T

    Permalink

    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
  9. def arbitrateFrom[T <: Data](that: Flow[T]): Unit

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

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

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

    Permalink
    Definition Classes
    NodeApi
  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  14. def build(): Unit

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

    Permalink
    Definition Classes
    NodeBaseApi
  16. def cancel: Bool

    Permalink

    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
    NodeNodeApiNodeBaseApi
    See also

    Node documentation

  17. def childNamePriority: Byte

    Permalink
    Definition Classes
    Area
  18. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  19. def component: Component

    Permalink
    Definition Classes
    ContextUser
  20. val ctrl: AnyRef { ... /* 12 definitions in type refinement */ }

    Permalink
  21. def defaultKey: Any

    Permalink
    Definition Classes
    NodeApi
  22. var down: Link

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  28. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  29. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  30. val fromDown: FromDown

    Permalink
  31. val fromUp: FromUp

    Permalink
  32. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  33. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  34. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  35. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  36. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  37. def getName(): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  38. def getNode: Node

    Permalink
    Definition Classes
    NodeNodeApi
  39. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  40. def getPath(from: Component, to: Component): Seq[Component]

    Permalink
    Definition Classes
    NameableByComponent
  41. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  42. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  43. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated
  44. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated
  45. var globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  46. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  47. def insert[T <: Data](that: T): Payload[T]

    Permalink

    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
  48. def isCancel: Bool

    Permalink

    Read-only accessor of cancel

    Read-only accessor of cancel

    Definition Classes
    NodeApiNodeBaseApi
  49. def isCanceling: Bool

    Permalink

    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
    NodeApiNodeBaseApi
  50. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  51. def isFiring: Bool

    Permalink

    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
    NodeApiNodeBaseApi
  52. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  53. def isMoving: Bool

    Permalink

    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
    NodeApiNodeBaseApi
  54. final def isNamed: Boolean

    Permalink
    Definition Classes
    Nameable
  55. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  56. def isReady: Bool

    Permalink

    Read-only accessor of ready

    Read-only accessor of ready

    Definition Classes
    NodeApiNodeBaseApi
  57. def isUnnamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  58. def isValid: Bool

    Permalink

    Read-only accessor of valid

    Read-only accessor of valid

    Definition Classes
    NodeApiNodeBaseApi
  59. val keyToData: LinkedHashMap[NamedTypeKey, Data]

    Permalink
  60. var name: String

    Permalink
    Definition Classes
    Nameable
  61. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  62. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  63. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  65. def overrideLocalName(name: String): Node.this.type

    Permalink
    Definition Classes
    Nameable
  66. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  67. def ready: Bool

    Permalink

    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
    NodeNodeApiNodeBaseApi
    See also

    Node documentation

  68. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  69. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  70. def rework[T](body: ⇒ T): T

    Permalink
    Definition Classes
    Area
  71. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  72. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Node.this.type

    Permalink
    Definition Classes
    Nameable
  73. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Node.this.type

    Permalink
    Definition Classes
    Nameable
  74. def setCompositeName(nameable: Nameable, postfix: String): Node.this.type

    Permalink
    Definition Classes
    Nameable
  75. def setCompositeName(nameable: Nameable, namePriority: Byte): Node.this.type

    Permalink
    Definition Classes
    Nameable
  76. def setCompositeName(nameable: Nameable, weak: Boolean): Node.this.type

    Permalink
    Definition Classes
    Nameable
  77. def setCompositeName(nameable: Nameable): Node.this.type

    Permalink
    Definition Classes
    Nameable
  78. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): Node.this.type

    Permalink
    Definition Classes
    Nameable
  79. def setName(name: String, namePriority: Byte): Node.this.type

    Permalink
    Definition Classes
    Nameable
  80. def setName(name: String, weak: Boolean): Node.this.type

    Permalink
    Definition Classes
    Nameable
  81. def setName(name: String): Node.this.type

    Permalink
    Definition Classes
    Nameable
  82. def setNameAsWeak(): Node.this.type

    Permalink
    Definition Classes
    Nameable
  83. def setPartialName(name: String, namePriority: Byte, owner: Any): Node.this.type

    Permalink
    Definition Classes
    Nameable
  84. def setPartialName(name: String, namePriority: Byte): Node.this.type

    Permalink
    Definition Classes
    Nameable
  85. def setPartialName(name: String, weak: Boolean): Node.this.type

    Permalink
    Definition Classes
    Nameable
  86. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Node.this.type

    Permalink
    Definition Classes
    Nameable
  87. def setPartialName(owner: Nameable, name: String, weak: Boolean): Node.this.type

    Permalink
    Definition Classes
    Nameable
  88. def setPartialName(name: String): Node.this.type

    Permalink
    Definition Classes
    Nameable
  89. def setPartialName(owner: Nameable, name: String): Node.this.type

    Permalink
    Definition Classes
    Nameable
  90. def setPartialName(owner: Nameable): Node.this.type

    Permalink
    Definition Classes
    Nameable
  91. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef
  92. def setScalaLocated(source: ScalaLocated): Node.this.type

    Permalink
    Definition Classes
    ScalaLocated
  93. def setWeakName(name: String): Node.this.type

    Permalink
    Definition Classes
    Nameable
  94. implicit def stageablePiped2[T <: Data](stageable: Payload[T]): T

    Permalink
    Definition Classes
    NodeBaseApi
  95. val status: AnyRef { ... /* 12 definitions in type refinement */ }

    Permalink
  96. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Permalink
    Definition Classes
    NodeApi
  99. def toString(): String

    Permalink
    Definition Classes
    Area → Nameable → AnyRef → Any
  100. def unsetName(): Node.this.type

    Permalink
    Definition Classes
    Nameable
  101. var up: Link

    Permalink
  102. def valCallback[T](ref: T, name: String): T

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback
  103. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit

    Permalink
    Definition Classes
    ValCallbackRec
  104. def valCallbackRec(obj: Any, name: String): Unit

    Permalink
    Definition Classes
    Area → ValCallbackRec
  105. def valid: Bool

    Permalink

    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
    NodeNodeApiNodeBaseApi
    See also

    Node documentation

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from NodeApi

Inherited from NodeBaseApi

Inherited from core.Area

Inherited from OverridedEqualsHashCode

Inherited from ValCallbackRec

Inherited from ValCallback

Inherited from NameableByComponent

Inherited from Nameable

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped