lowRISC / ibex

Ibex is a small 32 bit RISC-V CPU core, previously known as zero-riscy.
https://www.lowrisc.org
Apache License 2.0
1.33k stars 518 forks source link

[doc] Disambiguate doc around ECC detection on the data interface #2200

Open vogelpi opened 1 month ago

vogelpi commented 1 month ago

The Ibex documentation currently specifies: https://ibex-core.readthedocs.io/en/latest/03_reference/security.html#bus-integrity-checking

When the SecureIbex parameter is set, incoming data will be checked against the supplied checkbits.

https://ibex-core.readthedocs.io/en/latest/03_reference/load_store_unit.html#bus-integrity-checking

The core can optionally generate and verify check bits sent alongside the data for memory accesses.

The former statement suggests that all received data is checked (also when no load/store is going on) which is what is really happening. While the latter suggests that only response data of actual load/store instructions is checked. We should correct the second statement to disambiguate the documentation here.

This got flagged by Yin Mengyuan and @KatCe .

KatCe commented 1 month ago

The unspecified behavior was found by @Mengyuan410

vogelpi commented 1 month ago

Thanks for your feedback and for sharing Mengyuan's GitHub handle @KatCe .