feat(iob): improve iob_interface README #675
Conversation
- update interface names (`valid_i` instead of `avalid_i`) - add missing `rvalid_o` signal - add example for write transactions - small introduction text in README - simple makefile to generate .png from .drom files
|  | ||
| The IOb-interface has the following signals: | ||
| - `clk_i`: interface clock | ||
| - `valid_i`: source signal valid transaction |
There was a problem hiding this comment.
valid transaction from master input.
|
|
||
|  | ||
| The IOb-interface has the following signals: | ||
| - `clk_i`: interface clock |
|
|
||
|  | ||
| The IOb-interface has the following signals: |
There was a problem hiding this comment.
The IOb Native Interface, or IOb interface shortly, has the following signals from the slave perspective. (Note that the _i and _o suffixes denote input and output, respectively.)
| The IOb-interface has the following signals: | ||
| - `clk_i`: interface clock | ||
| - `valid_i`: source signal valid transaction | ||
| - `addr_i`: address for access |
There was a problem hiding this comment.
address for read or write access input.
| - `valid_i`: source signal valid transaction | ||
| - `addr_i`: address for access | ||
| - `wdata_i`: data to write | ||
| - `wstrb_i`: write strobe |
| - `wstrb_i`: write strobe | ||
| - `rdata_o`: read data | ||
| - `rvalid_o`: valid read data | ||
| - `ready_o`: destination ready to accept transactions |
There was a problem hiding this comment.
slave ready for transaction output.
| period. | ||
|
|
||
| Use `wstrb_i` to distinguish between READ and WRITE operations. READ operations | ||
| occur when all `wstrb_i` bits are LOW. |
There was a problem hiding this comment.
Byte i is written if wstrb[i] is HIGH and not otherwise.
|
|
||
| ## Read Transaction | ||
| For READ operations: when `valid_i` and `ready_o` are HIGH, read `addr_i` | ||
| address. The `rdata_o` is available when `rvalid_o` is HIGH. |
There was a problem hiding this comment.
For READ operations: when valid_i and ready_o are HIGH, address addr_i is read. The data on rdata_o is available when rvalid_o is HIGH.
|
|
||
| ## Write Transaction | ||
| For WRITE operations: when `valid_i` and `ready_o` are HIGH, write `wdata_i` | ||
| bytes with corresponding `wstrb_i` bit HIGH to `addr_i` address. |
There was a problem hiding this comment.
For WRITE operations: when valid_i and ready_o are HIGH, the bytes in wdata_i
validated by wstrb_i are written to address addr_i.
There was a problem hiding this comment.
This PR is ready for merging after the comments are addressed.
- address comments in IObundle#675
|
comments addressed in #676 |
valid_iinstead ofavalid_i)rvalid_osignal