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.

Sign up for GitHub

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

Jump to bottom

Create sequence diagrams / usage instructions for sdsread/write #68

Open
ReinhardKeil opened this issue Mar 3, 2025 · 1 comment
Open

Create sequence diagrams / usage instructions for sdsread/write #68

ReinhardKeil opened this issue Mar 3, 2025 · 1 comment
Assignees
@ReinhardKeil @DavidLesnjak
Labels
documentation Improvements or additions to documentation sds-core Belongs to SDS-Framework/sds

Comments

@ReinhardKeil
Copy link
Contributor

ReinhardKeil commented Mar 3, 2025 •
edited
Loading

For the section https://arm-software.github.io/SDS-Framework/main/theory/.

  1. There should be sequence diagrams that explain how the sdsio operations are protected for multi-threading.

    • what does a user need to consider to implement own sdsio functions?

  2. Clear usage instructions for multi-threading applications.

  3. Document maximum execution timing of Open Read/Write Close
@ReinhardKeil ReinhardKeil changed the title Create sequence diagrams Create sequence diagrams / usage instructions for sdsread/write Mar 3, 2025
@ReinhardKeil ReinhardKeil added documentation Improvements or additions to documentation sds-example Belongs to arm-examples/sds-examples labels Mar 3, 2025
@MiloradCvjetkovic MiloradCvjetkovic moved this to In progress in SDS Framework Mar 4, 2025
@MiloradCvjetkovic MiloradCvjetkovic added sds-core Belongs to SDS-Framework/sds and removed sds-example Belongs to arm-examples/sds-examples labels Mar 4, 2025
@ReinhardKeil
Copy link
Contributor Author

SDSIO Server commands are covered here https://github.com/ARM-software/SDS-Framework/blob/main/sds/source/sdsio/serial/usart/sdsio_serial.c

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ReinhardKeil ReinhardKeil

@DavidLesnjak DavidLesnjak

Labels
documentation Improvements or additions to documentation sds-core Belongs to SDS-Framework/sds
Projects
SDS Framework
Status: In progress
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ReinhardKeil @MiloradCvjetkovic @DavidLesnjak