Enum Syscall

pub enum Syscall {
    Yield {
        which: usize,
        param_a: usize,
        param_b: usize,
    },
    Subscribe {
        driver_number: usize,
        subdriver_number: usize,
        upcall_ptr: CapabilityPtr,
        appdata: MachineRegister,
    },
    Command {
        driver_number: usize,
        subdriver_number: usize,
        arg0: usize,
        arg1: usize,
    },
    ReadWriteAllow {
        driver_number: usize,
        subdriver_number: usize,
        allow_address: *mut u8,
        allow_size: usize,
    },
    UserspaceReadableAllow {
        driver_number: usize,
        subdriver_number: usize,
        allow_address: *mut u8,
        allow_size: usize,
    },
    ReadOnlyAllow {
        driver_number: usize,
        subdriver_number: usize,
        allow_address: *const u8,
        allow_size: usize,
    },
    Memop {
        operand: usize,
        arg0: usize,
    },
    Exit {
        which: usize,
        completion_code: usize,
    },
}

Decoded system calls as defined in TRD104.

Variants

Yield

Structure representing an invocation of the SyscallClass::Yield system call class. which is the Yield identifier value and address is the no wait field.

Fields

which: usize

param_a: usize

param_b: usize

Subscribe

Structure representing an invocation of the Subscribe system call class.

Fields

driver_number: usize

The driver identifier.

subdriver_number: usize

The subscribe identifier.

upcall_ptr: CapabilityPtr

Upcall pointer to the upcall function.

appdata: MachineRegister

Userspace application data.

Command

Structure representing an invocation of the Command system call class.

Fields

driver_number: usize

The driver identifier.

subdriver_number: usize

The command identifier.

arg0: usize

Value passed to the Command implementation.

arg1: usize

Value passed to the Command implementation.

ReadWriteAllow

Structure representing an invocation of the ReadWriteAllow system call class.

Fields

driver_number: usize

The driver identifier.

subdriver_number: usize

The buffer identifier.

allow_address: *mut u8

The address where the buffer starts.

allow_size: usize

The size of the buffer in bytes.

UserspaceReadableAllow

Structure representing an invocation of the UserspaceReadableAllow system call class that allows shared kernel and app access.

Fields

driver_number: usize

The driver identifier.

subdriver_number: usize

The buffer identifier.

allow_address: *mut u8

The address where the buffer starts.

allow_size: usize

The size of the buffer in bytes.

ReadOnlyAllow

Structure representing an invocation of the ReadOnlyAllow system call class.

Fields

driver_number: usize

The driver identifier.

subdriver_number: usize

The buffer identifier.

allow_address: *const u8

The address where the buffer starts.

allow_size: usize

The size of the buffer in bytes.

Memop

Structure representing an invocation of the Memop system call class.

Fields

operand: usize

The operation.

arg0: usize

The operation argument.

Exit

Structure representing an invocation of the Exit system call class.

Fields

which: usize

The exit identifier.

completion_code: usize

The completion code passed into the kernel.

Implementations

impl Syscall

pub fn from_register_arguments( syscall_number: u8, r0: usize, r1: MachineRegister, r2: MachineRegister, r3: MachineRegister, ) -> Option<Syscall>

Helper function for converting raw values passed back from an application into a Syscall type in Tock, representing an typed version of a system call invocation. The method returns None if the values do not specify a valid system call.

Different architectures have different ABIs for a process and the kernel to exchange data. The 32-bit ABI for CortexM and RISCV microcontrollers is specified in TRD104.

pub fn driver_number(&self) -> Option<usize>

Get the driver_number for the syscall classes that use driver numbers.

pub fn subdriver_number(&self) -> Option<usize>

Get the subdriver_number for the syscall classes that use sub driver numbers.

Trait Implementations

impl Clone for Syscall

fn clone(&self) -> Syscall

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Syscall

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Syscall

fn eq(&self, other: &Syscall) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Syscall

impl StructuralPartialEq for Syscall