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

[top/doc] Autogenerated tables for top-specific IP #12848

Open
msfschaffner opened this issue May 24, 2022 · 6 comments
Open

[top/doc] Autogenerated tables for top-specific IP #12848

msfschaffner opened this issue May 24, 2022 · 6 comments
Assignees
Labels
Component:Doc Documentation issue Earlgrey-PROD Triaged Temporary label to triage issues into Earlgrey-PROD Milestones IP:alert_handler IP:clkmgr IP:pinmux IP:pwrmgr IP:rstmgr IP:rv_plic Triaging:MultipleBlocks Issue is relevant for the triage of multiple HW blocks Type:Cleanup Cleanup tasks Type:FutureRelease Not relevant to currently planned releases/milestones Type:Icebox Changes deferred to future milestones

Comments

@msfschaffner
Copy link
Contributor

msfschaffner commented May 24, 2022

We have several top-level specific IPs for which the configuration is not evident from the technical IP specification alone.
Examples are the plic, alert handler, pinmux, pwrmgr, rstmgr, clkmgr.

For some of these, we do already generate top-level specific documentation, such as for example the pinout and pinmux configuration tables here for the block and here for the top-level (both with different scripts, which is another thing that may be unified at some point).

It would probably be good to enhance documentation for the IPs mentioned above to follow this example so that SW developers can find that information more readily.

@andreaskurth
Copy link
Contributor

Triaged for pwrmgr. Assigning Type:Icebox Changes deferred to future milestones as I think this is not needed for M2.5.

@andreaskurth andreaskurth added Type:Icebox Changes deferred to future milestones Triaged labels Feb 22, 2023
@GregAC GregAC added the Type:FutureRelease Not relevant to currently planned releases/milestones label Feb 23, 2023
@GregAC
Copy link
Contributor

GregAC commented Feb 23, 2023

Triaged for rstmgr, added Type:FutureRelease Not relevant to currently planned releases/milestones

@andreaskurth andreaskurth added Triaging:MultipleBlocks Issue is relevant for the triage of multiple HW blocks and removed Triaged labels Feb 23, 2023
@GregAC
Copy link
Contributor

GregAC commented Feb 24, 2023

Triaged for pinmux same conclusion as above

@andreaskurth
Copy link
Contributor

andreaskurth commented Feb 27, 2023

Triaged for clkmgr and rv_plic, ditto.

@moidx moidx removed the Priority:P3 Priority: low label Mar 17, 2023
@msfschaffner msfschaffner added the Earlgrey-PROD Candidate Temporary label to triage issues into Earlgrey-PROD Milestones label Oct 6, 2023
@msfschaffner msfschaffner added Earlgrey-PROD Triaged Temporary label to triage issues into Earlgrey-PROD Milestones and removed Earlgrey-PROD Candidate Temporary label to triage issues into Earlgrey-PROD Milestones labels Nov 7, 2023
@matutem
Copy link
Contributor

matutem commented Feb 17, 2024

The description of this issue is vague, and the link meant to show an example of the desired tables is broken. Please update so we can determine what really needs to be done.

@msfschaffner
Copy link
Contributor Author

msfschaffner commented Feb 20, 2024

I fixed the link. The issue has been left open intentionally since it's not fully clear what we want to generate yet, and we can discuss what would be useful. Information that I think could be useful (especially for the top-level documentation):

  • table of reset requests and associated indices
  • table of wakeup requests and associated indices
  • map of alert IDs
  • map of IRQ IDs
  • pinmux configuration
  • pinout (already exists to some degree)
  • memory map (already exists to some degree)

etc

msfschaffner added a commit to msfschaffner/opentitan that referenced this issue Feb 26, 2024
This is a short term fix and addresses lowRISC#18585 and lowRISC#19425.

Longer term, we should align how top-level documentation is generated,
see lowRISC#12848.

Signed-off-by: Michael Schaffner <[email protected]>
msfschaffner added a commit to msfschaffner/opentitan that referenced this issue Feb 26, 2024
This is a short term fix and addresses lowRISC#18585 and lowRISC#19425.

Longer term, we should align how top-level documentation is generated,
see lowRISC#12848.

Signed-off-by: Michael Schaffner <[email protected]>
This was referenced Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component:Doc Documentation issue Earlgrey-PROD Triaged Temporary label to triage issues into Earlgrey-PROD Milestones IP:alert_handler IP:clkmgr IP:pinmux IP:pwrmgr IP:rstmgr IP:rv_plic Triaging:MultipleBlocks Issue is relevant for the triage of multiple HW blocks Type:Cleanup Cleanup tasks Type:FutureRelease Not relevant to currently planned releases/milestones Type:Icebox Changes deferred to future milestones
Projects
None yet
Development

No branches or pull requests

7 participants