Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added missing signals to rvfi_mem documentation. #948

Merged

Conversation

silabs-oysteink
Copy link
Contributor

Added signals rvfi_mem_atop, rvfi_mem_err, rvfi_mem_exokay and rvfi_mem_memtype to the RVFI chapter of the user manual.

…em_memtype to the RVFI chapter of the user manual.

Signed-off-by: Oystein Knauserud <Oystein.Knauserud@silabs.com>
@silabs-oysteink silabs-oysteink added the Component:Doc For issues in the Documentation (e.g. for User Manual, README.md files) label Sep 14, 2023

Instructions will populate the ``rvfi_mem`` outputs with incrementing ``NMEM``, starting at ``NMEM=1``.

Instructions with a single memory operation (e.g. all RV32I instructions), including split misaligned transfers, will only use NMEM = 1.
Instructions with multiple memory operations (e.g. the push and pop instructions from Zcmp) use NMEM > 1 in case multiple memory operations actually occur.
``rvfi_mem_prot`` indicates the value of OBI prot used for the memory access or accesses. Note that this will be undefined upon access faults.

``rvfi_mem_memtype`` indicates the memory type attributes associated with each memory operation (i.e cacheable or bufferable).
``rvfi_mem_atop`` indicates the type of atomic transaction as specified in [OPENHW-OBI]_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And how about rvfi_mem_err and rvfi_mem_okay? What are they for and for what transactions do they actually carry valid information? See also #947 and my comments on that one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added explanation for err and exokay as suggested in #947.

Signed-off-by: Oystein Knauserud <Oystein.Knauserud@silabs.com>
@Silabs-ArjanB Silabs-ArjanB merged commit bfb9640 into openhwgroup:master Sep 15, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component:Doc For issues in the Documentation (e.g. for User Manual, README.md files)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants