class Node extends pipeline.Node
- Alphabetic
- By Inheritance
- Node
- Node
- NodeApi
- NodeBaseApi
- Area
- OverridedEqualsHashCode
- ValCallbackRec
- ValCallback
- NameableByComponent
- Nameable
- ContextUser
- ScalaLocated
- GlobalDataUser
- OwnableRef
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Node()
Type Members
- class Area extends core.Area with NodeApi
- Definition Classes
- Node
- class BundlePimper[T <: Bundle] extends AnyRef
- Definition Classes
- NodeBaseApi
- abstract type RefOwnerType
- Definition Classes
- OwnableRef
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
- val _context: Capture
- Definition Classes
- Area
- 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.
- 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
Intid 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
- def build(): Unit
- Definition Classes
- Node
- 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
- Node → NodeApi → NodeBaseApi
- See also
- def childNamePriority: Byte
- Definition Classes
- Area
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def component: Component
- Definition Classes
- ContextUser
- val ctrl: AnyRef { ... /* 12 definitions in type refinement */ }
- Definition Classes
- Node
- def defaultKey: Any
- Definition Classes
- NodeApi
- var down: Link
- Definition Classes
- Node
- def driveFrom[T <: Data](that: Flow[T])(con: (pipeline.Node, T) => Unit): Unit
- Definition Classes
- NodeApi
- def driveFrom[T <: Data](that: Stream[T])(con: (pipeline.Node, T) => Unit): Unit
- Definition Classes
- NodeApi
- def driveTo[T <: Data](that: Flow[T])(con: (T, pipeline.Node) => Unit): Unit
- Definition Classes
- NodeApi
- def driveTo[T <: Data](that: Stream[T])(con: (T, pipeline.Node) => Unit): Unit
- Definition Classes
- NodeApi
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: Any): Boolean
- Definition Classes
- OverridedEqualsHashCode → AnyRef → Any
- def foreachReflectableNameables(doThat: (Any) => Unit): Unit
- Definition Classes
- Nameable
- val fromDown: FromDown
- Definition Classes
- Node
- val fromUp: FromUp
- Definition Classes
- Node
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def getDisplayName(): String
- Definition Classes
- Nameable
- def getInstanceCounter: Int
- Definition Classes
- ContextUser
- def getMode: Byte
- Attributes
- protected
- Definition Classes
- Nameable
- def getName(default: String): String
- Definition Classes
- NameableByComponent → Nameable
- def getName(): String
- Definition Classes
- NameableByComponent → Nameable
- def getNode: pipeline.Node
- def getPartialName(): String
- Definition Classes
- Nameable
- def getPath(from: Component, to: Component): Seq[Component]
- Definition Classes
- NameableByComponent
- def getRefOwnersChain(): List[Any]
- Definition Classes
- OwnableRef
- def getScalaLocationLong: String
- Definition Classes
- ScalaLocated
- def getScalaLocationShort: String
- Definition Classes
- ScalaLocated
- def getScalaTrace(): Throwable
- Definition Classes
- ScalaLocated
- val globalData: GlobalData
- Definition Classes
- GlobalDataUser
- def hashCode(): Int
- Definition Classes
- OverridedEqualsHashCode → AnyRef → Any
- def insert[T <: Data](that: T): Payload[T]
Return a new Payload which is connected to the given
Datahardware signal starting from this Node in the pipeline.Return a new Payload which is connected to the given
Datahardware 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
Truewhen the node transaction is being cleaned up.Truewhen 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 isCompletelyUnnamed: Boolean
- Definition Classes
- Nameable
- def isFiring: Bool
Truewhen the current transaction is successfully moving forward (isReady && !isRemoved).Truewhen 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,
Truewhen 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
- final def isNamed: Boolean
- Definition Classes
- Nameable
- def isPriorityApplicable(namePriority: Byte): Boolean
- Definition Classes
- Nameable
- def isReady: Bool
Read-only accessor of ready
Read-only accessor of ready
- Definition Classes
- NodeApi → NodeBaseApi
- def isUnnamed: Boolean
- Definition Classes
- NameableByComponent → Nameable
- def isValid: Bool
Read-only accessor of valid
Read-only accessor of valid
- Definition Classes
- NodeApi → NodeBaseApi
- val keyToData: LinkedHashMap[NamedTypeKey, Data]
- Definition Classes
- Node
- val name: String
- Definition Classes
- Nameable
- val nameableRef: Nameable
- Attributes
- protected
- Definition Classes
- Nameable
- Annotations
- @DontName()
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def overrideLocalName(name: String): Node.this.type
- Definition Classes
- Nameable
- val parentScope: ScopeStatement
- Definition Classes
- ContextUser
- 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
- Node → NodeApi → NodeBaseApi
- See also
- val refOwner: RefOwnerType
- Definition Classes
- OwnableRef
- Annotations
- @DontName()
- def reflectNames(): Unit
- Definition Classes
- Nameable
- def rework[T](body: => T): T
- Definition Classes
- Area
- val scalaTrace: Throwable
- Definition Classes
- ScalaLocated
- def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Node.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Node.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, postfix: String): Node.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, namePriority: Byte): Node.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, weak: Boolean): Node.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable): Node.this.type
- Definition Classes
- Nameable
- def setLambdaName(isNameBody: => Boolean)(nameGen: => String): Node.this.type
- Definition Classes
- Nameable
- def setName(name: String, namePriority: Byte): Node.this.type
- Definition Classes
- Nameable
- def setName(name: String, weak: Boolean): Node.this.type
- Definition Classes
- Nameable
- def setName(name: String): Node.this.type
- Definition Classes
- Nameable
- def setNameAsWeak(): Node.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String, namePriority: Byte, owner: Any): Node.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String, namePriority: Byte): Node.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String, weak: Boolean): Node.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable, name: String, namePriority: Byte): Node.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable, name: String, weak: Boolean): Node.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String): Node.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable, name: String): Node.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable): Node.this.type
- Definition Classes
- Nameable
- def setRefOwner(that: Any): Unit
- Definition Classes
- OwnableRef
- def setScalaLocated(source: ScalaLocated): Node.this.type
- Definition Classes
- ScalaLocated
- def setWeakName(name: String): Node.this.type
- Definition Classes
- Nameable
- implicit def stageablePiped2[T <: Data](stageable: Payload[T]): T
- Definition Classes
- NodeBaseApi
- val status: AnyRef { ... /* 12 definitions in type refinement */ }
- Definition Classes
- Node
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toFlow[T <: Data](con: (pipeline.Node) => T): Flow[T]
- Definition Classes
- NodeApi
- def toStream[T <: Data](con: (pipeline.Node) => T): Stream[T]
- Definition Classes
- NodeApi
- def toString(): String
- Definition Classes
- Area → Nameable → AnyRef → Any
- def unsetName(): Node.this.type
- Definition Classes
- Nameable
- var up: Link
- Definition Classes
- Node
- def valCallback[T](ref: T, name: String): T
- Definition Classes
- ValCallbackRec → ValCallback
- def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
- Definition Classes
- ValCallbackRec
- def valCallbackRec(obj: Any, name: String): Unit
- Definition Classes
- Area → ValCallbackRec
- 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
- Node → NodeApi → NodeBaseApi
- See also
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)