Skip to content

Commit

Permalink
Add doc about isMoving / isRemoved
Browse files Browse the repository at this point in the history
  • Loading branch information
Dolu1990 committed Nov 8, 2023
1 parent 6cb3049 commit 779aaa8
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions source/SpinalHDL/Libraries/Pipeline/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Here is the same example but using more of the API :
val VALUE = Stageable(UInt(16 bits))
val io = new Bundle{
val up = slave Stream(VALUE) //VALUE can also be used as a HardType
val up = slave Stream(VALUE) // Stageable can also be used as a HardType
val down = master Stream(VALUE)
}
Expand Down Expand Up @@ -142,11 +142,29 @@ Node

Node mostly host the valid/ready arbitration signal, and the hardware signal required for all the Stageable values going through it.

You can access its arbitration signals via :
You can access its arbitration via :

- node.valid / node.isValid
- node.ready / node.isReady
- node.isFireing which is a shortcut for `valid && ready`

.. list-table::
:header-rows: 1
:widths: 1 5

* - API
- Description
* - node.valid
- Is the signal which specify if a transaction is present on the node
* - node.ready
- Is the signal which specify if the node transaction can move away.
* - node.isValid
- node.valid's read only accessor
* - node.isReady
- node.ready's read only accessor
* - node.isFireing
- True when the node transaction is successfuly moving futher (isValid && isReady && !isRemoved). Usefull to commit state changes
* - node.isMoving
- True when the node transaction is moving (isValid && (isReady || isRemoved)). Usefull to "reset" states
* - node.isRemoved
- True when the node is being flushed

You can access its stageable's signals via :

Expand Down

0 comments on commit 779aaa8

Please sign in to comment.