Skip to content

sys/crypto: improve doxygen markup, add ACCESS() attribute, ...#22380

Open
maribu wants to merge 1 commit into
RIOT-OS:masterfrom
maribu:sys/crypto/cleanup
Open

sys/crypto: improve doxygen markup, add ACCESS() attribute, ...#22380
maribu wants to merge 1 commit into
RIOT-OS:masterfrom
maribu:sys/crypto/cleanup

Conversation

@maribu

@maribu maribu commented Jun 14, 2026

Copy link
Copy Markdown
Member

Contribution description

  • clean up and extend the doxygen markup
  • use ACCESS() macro to annotate functions to allow GCC to provide better -Wstringop-overflow diagnostics
  • encode size information into APIs using uint8_t param[size] instead of uint8_t *param where possible
  • use idomatic types in API, e.g. consistently size_t for size of in-memory structures and ssize_t for when that is mixed with in-band error signaling
  • fix style issues pointed out by the linter

Testing procedure

  • make -C tests/sys/crypto flash test -j32
  • build tests

(Both done by Murdock)

Issues/PRs references

None

Declaration of AI-Tools / LLMs usage:

AI-Tools / LLMs that were used are:

  • used Qwen Coder 30B A3B to crunch over function signatures in header files and list signatures that might be annotated
  • No AI tools were used for actual code changes

@maribu maribu requested a review from leandrolanzieri as a code owner June 14, 2026 21:58
@maribu maribu added the Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation label Jun 14, 2026
@maribu maribu added Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Jun 14, 2026
@github-actions github-actions Bot added Area: tests Area: tests and testing framework Area: sys Area: System labels Jun 14, 2026
@riot-ci

riot-ci commented Jun 14, 2026

Copy link
Copy Markdown

Murdock results

FAILED

109680b sys/crypto: improve doxygen markup, add ACCESS() attribute, ...

Success Failures Total Runtime
1698 0 10260 03m:30s

Artifacts

- clean up and extend the doxygen markup
- use `ACCESS()` macro to annotate functions to allow GCC to provide
  better `-Wstringop-overflow` diagnostics
- encode size information into APIs using `uint8_t param[size]` instead
  of `uint8_t *param` where possible
- use idomatic types in API, e.g. consistently `size_t` for size of
  in-memory structures and `ssize_t` for when that is mixed with in-band
  error signaling
- fix style issues pointed out by the linter
@maribu maribu force-pushed the sys/crypto/cleanup branch from 3e3402d to 109680b Compare June 15, 2026 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: sys Area: System Area: tests Area: tests and testing framework CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants