Skip to content

Fix out-of-sync text and code in syscall implementation guide #84

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

Merged
lschuermann merged 2 commits into from
Feb 12, 2026
Merged

Fix out-of-sync text and code in syscall implementation guide #84

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
818811c
Fix out-of-sync text and code in syscall implementation guide
pjhades Feb 4, 2026
d16b73d
Replace `which` with `command_num` in syscall implementation guide
pjhades Feb 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/development/syscall.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,20 +197,20 @@ The steps from the overview are elaborated on here.
fn allow_readwrite(
&self,
appid: AppId,
which, usize,
command_num, usize,
slice: ReadWriteAppSlice,
) -> Result<ReadWriteAppSlice, (ReadWriteAppSlice, ErrorCode)> { }

fn allow_readonly(
&self,
app: AppId,
which: usize,
command_num: usize,
slice: ReadOnlyAppSlice,
) -> Result<ReadOnlyAppSlice, (ReadOnlyAppSlice, ErrorCode)> { }

fn command(
&self,
which: usize,
command_num: usize,
r2: usize,
r3: usize,
caller_id: AppId) -> CommandReturn { }
Expand All @@ -233,7 +233,7 @@ The steps from the overview are elaborated on here.
`allow_readonly` calls.

By Tock convention, every syscall interface must at least support the command
call with `which == 0`. This allows applications to check if the syscall
call with `command_num == 0`. This allows applications to check if the syscall
interface is supported on the current platform. The command must return a
`CommandReturn::success()`. If the command is not present, then the kernel
automatically has it return a failure with an error code of
Expand All @@ -243,7 +243,7 @@ The steps from the overview are elaborated on here.
impl SyscallDriver for WS00123 {
fn command(
&self,
which: usize,
command_num: usize,
r2: usize,
r3: usize,
caller_id: AppId) -> CommandReturn {
Expand Down Expand Up @@ -290,7 +290,7 @@ The steps from the overview are elaborated on here.
/// height to set as the the threshold for detection.
fn command(
&self,
which: usize,
command_num: usize,
r2: usize,
r3: usize,
caller_id: AppId) -> CommandReturn {
Expand Down