Docs for SDT API?
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.2k
- Forks
- 1.1k
- PR merge metrics
- No merged PRs in 30d
Description
I am trying to get a basic timer working and I was quite confused why my code was crashing until I realized that there are two separate APIs for the timer (and presumably other things) depending on the SDT preprocessor directive. The docs still use the old format (https://xilinx.github.io/embeddedsw.github.io/scutimer/doc/html/api/group__scutimer.html#ga1e7db0f5795151c2d6538dae1fd07a16), and changes like deviceIds turning into BaseAddr can fail silently because they are both integer types. Is there any documentation for this new API?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked scutimer API documentation and compare its old format with the SDT preprocessor variant, focusing on deviceIds versus BaseAddr. Determine where the SDT-specific API documentation belongs, then document the differences and usage needed to prevent silent configuration mistakes.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100