microsoft / microsoft/litebox

specify the meaning of registers in `OpteeSmcArgsPage`

Open
#590 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
2.7k
Forks
144
Avg merge
12h 21m
Merged PRs (30d)
146

Description

Seems like SMCCC uses r0-r7 for the first eight args and r8 as an extra parameter and to return.

Would be nice to document a similar convention here as well.

_Originally posted by @praveen-pk in https://github.com/microsoft/litebox/pull/555#discussion_r2714108117_

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the Rust definition of `OpteeSmcArgsPage` and read the surrounding comments and its uses. Document the intended meaning and convention for its registers, using the SMCCC r0–r8 convention described in the issue as context; the issue is done when the register roles are clear to readers.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
operating-systems
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.