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

Move register layout definitions into wavedrom #414

Closed
christian-herber-nxp opened this issue Sep 17, 2024 · 6 comments · Fixed by #431
Closed

Move register layout definitions into wavedrom #414

christian-herber-nxp opened this issue Sep 17, 2024 · 6 comments · Fixed by #431
Assignees
Labels
v1.0 resolve for 1.0

Comments

@christian-herber-nxp
Copy link
Collaborator

The privileged spec defines the CSR layouts using wavedrom. The CLIC spec doesn't. This should be aligned.
The layout diagrams do not include descriptions, while the CLIC tables do.

Proposed Resolution:
Move CLIC CSR layouts to wavedrom. Merge the description text with from the layout table with the rest. There might be redundancies, in which the text that doesn't come from the table should take presedence.

@wmat
Copy link
Contributor

wmat commented Sep 23, 2024

Can you point me at a CSR diagram from the Privileged spec that you would expect the CSRs here to look like?

@wmat
Copy link
Contributor

wmat commented Sep 23, 2024

Maybe mnstatus from the rnmi chapter 8.3?

@christian-herber-nxp
Copy link
Collaborator Author

I think we are open to whatever is the preferred presentation by the documentation team. I was looking at the privileged spec itself, i.e. definition of machine mode.

@wmat
Copy link
Contributor

wmat commented Oct 1, 2024

Can you let me know if the content of this diagram is correct? I've left the textual description above the diagram for reference:
Screenshot from 2024-10-01 15-54-46

@christian-herber-nxp
Copy link
Collaborator Author

Can you let me know if the content of this diagram is correct? I've left the textual description above the diagram for reference: Screenshot from 2024-10-01 15-54-46

looks fine

@jb-brelot-nxp
Copy link
Collaborator

looks ok from my side

@jb-brelot-nxp jb-brelot-nxp added the v1.0 resolve for 1.0 label Oct 7, 2024
@jb-brelot-nxp jb-brelot-nxp self-assigned this Oct 7, 2024
wmat added a commit that referenced this issue Nov 11, 2024
Before issuing PR this adds issue #414 to move register layout definitions to be diagrams.
@wmat wmat linked a pull request Nov 11, 2024 that will close this issue
jb-brelot-nxp pushed a commit that referenced this issue Jan 6, 2025
* Move clicintaddr register to wavedrom

Move clicintaddr register to wavedrom diagram

* Add register diagram for clicinittrig

Add the register diagram for clickinittrig as a bytefield-svg
diagram to accomodate long names.

* Adding xtvec register.

Adds the xtvec register diagram using bytefield-svg to accommodate
long register names.

* Add clicintattr register layout diagram.

Adds the clicintattr register diagram.  This uses wavedrom as the
register names are short.

* Fix clicintattr diagrams

Fix the clicintattr diagrams.

* Add mcliccfg and scliccfg register diagrams

Add the mcliccfg and scliccfg register diagrams as bytefield-svg to accomodate long
register names.

* Delete text based register description.

Delete several of the text based descriptions of register diagrams.

* Add issue #414 to revision history

Before issuing PR this adds issue #414 to move register layout definitions to be diagrams.

* Grabbing latest docs-resources so PDF builds on PR.

Grabbing the latest docs-resources so the PDF builds for the PR.

---------

Signed-off-by: Bill Traynor <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v1.0 resolve for 1.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants