openhwgroup / core-v-mcu

This is the CORE-V MCU project, hosting CORE-V's embedded-class cores.
https://docs.openhwgroup.org/projects/core-v-mcu
Other
158 stars 50 forks source link

Complete the APB Advance Timer chapter of the User Manual #287

Open MikeOpenHWGroup opened 1 year ago

MikeOpenHWGroup commented 1 year ago

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:

Additional Information

A certain amount of this task will involve reverse engineering and hunting for information from disparate sources. A few suggestions:

DBees commented 1 year ago

@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?

MikeOpenHWGroup commented 1 year ago

That is a good point @DBees. I'll add something about that in "background information".