Skip to content
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

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

Open
MikeOpenHWGroup opened this issue Jan 13, 2023 · 2 comments
Open

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

MikeOpenHWGroup opened this issue Jan 13, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation task Project related task to do

Comments

@MikeOpenHWGroup
Copy link
Member

MikeOpenHWGroup commented Jan 13, 2023

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:

@MikeOpenHWGroup MikeOpenHWGroup added documentation Improvements or additions to documentation task Project related task to do labels Jan 13, 2023
@DBees
Copy link
Contributor

DBees commented Jan 16, 2023

@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
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation task Project related task to do
Projects
Status: Not Started
Development

No branches or pull requests

3 participants