lowRISC / opentitan

OpenTitan: Open source silicon root of trust
https://www.opentitan.org
Apache License 2.0
2.52k stars 748 forks source link

[doc] Add human-readable names and descriptions to remaining blocks #17307

Open andreaskurth opened 1 year ago

andreaskurth commented 1 year ago

Add a human-readable name as well as one-line and one-paragraph descriptions to the remaining hardware blocks, including those specific to a top (ast, sensor_ctrl, alert_handler, and rv_plic).

Draft document here: https://docs.google.com/document/d/1nX0GiXE6W5PEEGGwiCCToCwq19nCBpVRDtmN5f_0paQ/edit

What about primitives? And what about TL-UL?

johngt commented 1 year ago

@HU90m - I believe that this has now been superseded and can now be closed?

HU90m commented 1 year ago

I had a quick look for one_line_desc in the top specific blocks and they didn't have them.

They appear to exist in the internal doc: https://docs.google.com/document/d/1nX0GiXE6W5PEEGGwiCCToCwq19nCBpVRDtmN5f_0paQ. It looks like the red and purple ones have been put in the repo and the others have not.

andreaskurth commented 1 year ago

This is still current, but I don't think it's currently top prio