core-v-mcu
core-v-mcu copied to clipboard
Complete the APB Advance Timer chapter of the User Manual
A (mostly empty) shell of the APB Advanced Timer peripheral exists at docs/doc-src/ip-blocks/apb_adv_timer.rst
. This chapter needs to be updated such that the Reader understands what the peripheral does, a high-level description of how it works, and a description of how software should use the peripheral's CSRs to control its operation.
You are free to edit the chapter as you see fit, but a template has been provided with the following structure:
- Features: short description (can be a bullet list) of what the peripheral does.
- Theory of Operation: high-level description of the implementation (RTL).
- Programming Model: this section should answer the question: what does software need to do in order to configure/control/monitor the peripheral's function.
- CSRs: one table per CSR. An example is provided.
Additional Information
A certain amount of this task will involve reverse engineering and hunting for information from disparate sources. A few suggestions:
- The Pulp Platform project and its associated GitHub repos.
- Device driver code in core-v-mcu-cli-test.
- The RTL source code on GitHub (link).
@MikeOpenHWGroup The task is clearly laid out, thank you. Is the assignee expected to reverse engineer the code or is there any documentation we can find from ETH?
That is a good point @DBees. I'll add something about that in "background information".