search

Xilinx / embeddedsw

Xilinx Embedded Software (embeddedsw) Development
Other
952 stars 1.07k forks source link

Docs for SDT API? #288

Open atyshka opened 9 months ago

atyshka commented 9 months ago

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?

sivadur commented 9 months ago

Thanks @atyshka for reporting, we will get this document updated with this API change. Incase if you wnat to more about this change in API and SDT , please refer to our porting guide to this SDT flow document UG1647 at https://docs.xilinx.com/r/en-US/ug1647-porting-embeddedsw-components/Introduction