-
Notifications
You must be signed in to change notification settings - Fork 779
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
Comments
Triaged for |
Triaged for |
Triaged for |
Triaged for |
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. |
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):
etc |
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 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]>
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.
The text was updated successfully, but these errors were encountered: