[rom_ctrl,doc] Updates and tidy-ups #26071
Merged
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
martin-velay
approved these changes
Jan 31, 2025
rswarbrick
force-pushed
the
rom-ctrl-doc-update
branch
from
98fcb47 to
e19126f
Compare
The idea is that this now better explains what the ROM controller is and what it's used for. Signed-off-by: Rupert Swarbrick <[email protected]>
This text got copied to interfaces.md, which is a much better place for it! Drop the old copy and add a link instead. Signed-off-by: Rupert Swarbrick <[email protected]>
I think the (intended) interface has actually changed since I wrote that text years ago! Tweak it so that it's actually correct. Signed-off-by: Rupert Swarbrick <[email protected]>
This now lists all the parameters that get passed into the block and describes things a bit more helpfully. Signed-off-by: Rupert Swarbrick <[email protected]>
This second S&P layer was removed in commit 803d9ae. Update the documentation to describe the design properly. While updating the block diagram, I also sort out the legends for the rdata paths. In the programmer's guide, I change the text so that it's true (talking about scrambled addresses as opposed to scrambled data), but the behaviour seen by the programmer does not change. Signed-off-by: Rupert Swarbrick <[email protected]>
Signed-off-by: Rupert Swarbrick <[email protected]>
This document is actually linked a couple of sentences earlier but I just got a little surprised about things when reading the text. This should make things a bit clearer. Signed-off-by: Rupert Swarbrick <[email protected]>
rswarbrick
force-pushed
the
rom-ctrl-doc-update
branch
from
e19126f to
66d4fd3
Compare
|
Force push doesn't add anything (except for a couple of missing backticks) but it rebases onto the latest master. |
|
LGTM, thanks Rupert! |
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.
These commits are trying to tidy up the block documentation so that things are more fully specified. It might hopefully feed into a verification plan for the block. (But documenting what on earth it's supposed to do seems like it's sensible either way!)