[hw,rv_core_ibex,doc] Sync Rom Patching docs to master (indegrated_dev to master) #24508
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a mostly-automated conversion from a Google document to Markdown. I've exported images as SVGs Signed-off-by: Rupert Swarbrick <[email protected]>
This drops the document organization section from boot rom document. That was probably needed in the initial RFC, but isn't really needed now that this is a manual/document. Similarly, we drop some in-document layout text. This comes from when the text was a proposal, rather than a document about what exists. We probably don't need the structure notes in the document's new form. Signed-off-by: Rupert Swarbrick <[email protected]>
This was a note saying that we might want opt-in support for PQC signatures. It's sensible, but doesn't really belong in a document that describes what OpenTitan integrated is at the moment. Signed-off-by: Rupert Swarbrick <[email protected]>
This now matches the image that it's describing and I think it's probably a bit clearer. If we go with "body", I think we need some extra text explaining what "body" means in this context. Signed-off-by: Rupert Swarbrick <[email protected]>
This no longer looks like the "few KB" text refers to patches that redirect program execution, which is how I read it at first. Signed-off-by: Rupert Swarbrick <[email protected]>
Non-trivial changes: - Dropped the text about what OpenTitan "impacts" at a SoC level in the Overview section. I didn't really understand what this was trying to say, and I'm not sure it's really necessary here anyway. - Lots of full stops / periods added. Especially in bulleted lists, where the final sentence was ended by a newline instead of a dot. Signed-off-by: Rupert Swarbrick <[email protected]>
The "latest" patch region is a little short on details. Clarify that latest means the patch region with the highest revision number, amond all regions that have been fully programmed. Signed-off-by: Samuel Ortiz <[email protected]>
When Lock Valid is set for a patch region, base ROM can skip the OTP patch region verification. It still must compare the SRAM load code section and match registers values against the OTP stored signature. When Lock Valid is not set, base ROM must verify the OTP patch region signature and if the verification passes, it should toggle the Lock Valid bit. Signed-off-by: Samuel Ortiz <[email protected]>
As we only have one sections for all redirections, it can only be loaded from one single base address in SRAM. This base address should be the first redirection register r_base value. Signed-off-by: Samuel Ortiz <[email protected]>
The only tweaked meaning is that the text no longer looks like it's suggesting the patch SRAM be lockable if we're using part of the main SRAM to implement it. This change also gets rid of some text that isn't really needed in this document (OT's address space layout) and some text that doesn't convey much information (size of patch RAM is TBD; address region has a start and end). Signed-off-by: Rupert Swarbrick <[email protected]>
The original text took me a while to properly understand. I think that this version is equivalent, but a little easier to follow. Signed-off-by: Rupert Swarbrick <[email protected]>
…fterFenceI_A Signed-off-by: Robert Schilling <[email protected]>
…be in OTP Signed-off-by: Samuel Ortiz <[email protected]>
The specification defines, describes and document patch match registers that seem to be Ibex CSRs. None of those exist, neither in Ibex itself nor in the OT wrapper. In order to stop relying and documenting non existing registers, this PR modifies the ROM patch table documentation and defines simpler, CSR agnostic descriptors for the matching and remapping configuration for ROM patch regions. This descriptors allow for configuring the existing Ibex wrapper address translation registers and could also be used for configuring Ibex CSRs when and if they are implemented. These descriptors are 2x32 bits words including the base ROM region address, the patched ROM region size and the SRAM destination base address. It is up to the patch loader to translate those descriptors into Ibex wrapper register settings (for now) and potentially Ibex CSR writes in the future. Signed-off-by: Samuel Ortiz <[email protected]>
Pending comments from lowRISC#21070 Signed-off-by: Samuel Ortiz <[email protected]>
Razer6
changed the title
Razer6
added
Component:Doc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR syncs the Rom Patching documentation back from integrated_dev to master. It further increases the bounds of IbexIcacheScrambleKeyRequestAfterFence_i. The PMP configuration has not yet been changed since the configuration will be done differently after lowRISC/ibex#2147 is merged and vendored.