Skip to content

[doc] Update documentation to align with recent RTL changes - #2484

Open
SamuelRiedel wants to merge 2 commits into
lowRISC:masterfrom
SamuelRiedel:doc
Open

[doc] Update documentation to align with recent RTL changes#2484
SamuelRiedel wants to merge 2 commits into
lowRISC:masterfrom
SamuelRiedel:doc

Conversation

@SamuelRiedel

@SamuelRiedel SamuelRiedel commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Some new changes to Ibex were not reflected in the documentation. This PR updates it:

  • add new ibex_top parameters
  • add cross-refs throughout the parameter list to explain what they do without duplication
  • add missing ports and their description
  • udpate instantiation snippet updated to match current RTL
  • add missing CSRs
  • add pipeline details for pipeline flush on CSR writes
  • expand explanation on Zcmp behavior concerning interrupts

The CHERIoT documentation is deferred to a separate PR

@SamuelRiedel
SamuelRiedel marked this pull request as ready for review August 28, 2026 14:39

@nasahlpa nasahlpa left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM apart from one question.

Comment thread doc/02_user/integration.rst Outdated
| | | | (only relevant when ICacheScramble == 1) |
+----------------------------------+---------------------+-------------------------+----------------------------------------------------------------------------------------------+
| ``ICacheTweakInfection`` | bit | SecureIbex | Enable :ref:`icache-tweak-infection` |
| | | | (only relevant when ICacheScramble == 1) |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is that correct? As far as I remember, it is only useful when having SecureIbex enabled (because then ECC errors are flagged by a wrong un-XOR operation) and when we have an icache available.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

You're right. That was a copy-paste error.

Signed-off-by: Samuel Riedel <sriedel@lowrisc.org>
We check all incoming valid responses, not just load data

Fixes lowRISC#2200

Signed-off-by: Samuel Riedel <sriedel@lowrisc.org>
@andreaskurth andreaskurth changed the title [doc] Update documentation to align with recent RTL chagnes [doc] Update documentation to align with recent RTL changes Aug 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants