Add an Integration chapter documenting all parameters and all pins
Created by: Silabs-ArjanB
The CV32E40P User Manual does not have a documentation chapter as is present in e.g. the Ibex User Manual.
Task is to add an Integration chapter documenting all parameters and all pins. The chapter will refer to other sections for the description of groups of pins (e.g. the instruction fetch interface or the interrupt interface). As a side effect of this task pin names and parameters might slightly change if agreed so in the sub-tasks. No new functionality will be added, but there will be a proposal to no longer support NMI (see TBD for details). So, in this case the proposed documentation changes (if accepted) will drive RTL changes.
Here is the list of task that must be closed before this task can be closed:
- #46 (Pinout: rename test_en_i to scan_cg_en_i). Status: Closed.
- #47 (Pinout: Replace core_id_i and cluster_id_i by hart_id_i). Status: Closed.
- #48 (Pinout: Document Auxiliary Processing Unit (APU) interface). Status: Further updates required by
@davideschiavone. - #49 (Pinout: Document PULP Cluster pins). Status: Initial pull request made in https://github.com/openhwgroup/core-v-docs/pull/55. Content is to be reviewed and pin names are under discussion. Agreed to change the pin name of core_clock_en_i to pulp_core_clock_en_i. The 'busy' and 'sleep pin' will get consolidated into 1 pin (
@Silabs-ArjanBwill write a documentation proposal for this) - #50 (Pinout: Document IRQ interface). Status: Ongoing discussion in Mattermost.
- #51 (Module: Rename riscv_core to cv32e40p _core). Status: Closed.
- #52 (Pinout: Replace DM_HALTADDRESS parameter by dm_halt_addr_i pin): Status: Closed.
- #58 (Pinout: Document usage of fregfile_disable_i). Status: Closed
- #62 (Pinout: Add dm_exception_addr_i pin). Status: Closed
Here is a list of RTL pull request that must be closed before this task can be closed (more might get added if above proposals get accepted):
Note: The documentation for instruction and load-store-unit interfaces has already been updated earlier. Its pull request https://github.com/openhwgroup/core-v-docs/pull/37 is awaiting approval. It is kept out of this ticket as the related RTL changes are relatively large and we do not want to delay the adoption of above (relatively low impact) documentation/RTL updates.