Enum kernel::syscall::SyscallReturn

source ·
pub enum SyscallReturn {
Show 19 variants Failure(ErrorCode), FailureU32(ErrorCode, u32), FailureU32U32(ErrorCode, u32, u32), FailureU64(ErrorCode, u64), Success, SuccessU32(u32), SuccessU32U32(u32, u32), SuccessU32U32U32(u32, u32, u32), SuccessU64(u64), SuccessU32U64(u32, u64), AllowReadWriteSuccess(*mut u8, usize), AllowReadWriteFailure(ErrorCode, *mut u8, usize), UserspaceReadableAllowSuccess(*mut u8, usize), UserspaceReadableAllowFailure(ErrorCode, *mut u8, usize), AllowReadOnlySuccess(*const u8, usize), AllowReadOnlyFailure(ErrorCode, *const u8, usize), SubscribeSuccess(*const (), usize), SubscribeFailure(ErrorCode, *const (), usize), YieldWaitFor(usize, usize, usize),
}
Expand description

Enumeration of the possible system call return variants specified in TRD104.

This struct operates over primitive types such as integers of fixed length and pointers. It is constructed by the scheduler and passed down to the architecture to be encoded into registers, using the provided encode_syscall_return method.

Capsules do not use this struct. Capsules use higher level Rust types (e.g. ReadWriteProcessBuffer and GrantKernelData) or wrappers around this struct ([CommandReturn]) which limit the available constructors to safely constructable variants.

Variants§

§

Failure(ErrorCode)

Generic error case

§

FailureU32(ErrorCode, u32)

Generic error case, with an additional 32-bit data field

§

FailureU32U32(ErrorCode, u32, u32)

Generic error case, with two additional 32-bit data fields

§

FailureU64(ErrorCode, u64)

Generic error case, with an additional 64-bit data field

§

Success

Generic success case

§

SuccessU32(u32)

Generic success case, with an additional 32-bit data field

§

SuccessU32U32(u32, u32)

Generic success case, with two additional 32-bit data fields

§

SuccessU32U32U32(u32, u32, u32)

Generic success case, with three additional 32-bit data fields

§

SuccessU64(u64)

Generic success case, with an additional 64-bit data field

§

SuccessU32U64(u32, u64)

Generic success case, with an additional 32-bit and 64-bit data field

§

AllowReadWriteSuccess(*mut u8, usize)

Read/Write allow success case, returns the previous allowed buffer and size to the process.

§

AllowReadWriteFailure(ErrorCode, *mut u8, usize)

Read/Write allow failure case, returns the passed allowed buffer and size to the process.

§

UserspaceReadableAllowSuccess(*mut u8, usize)

Shared Read/Write allow success case, returns the previous allowed buffer and size to the process.

§

UserspaceReadableAllowFailure(ErrorCode, *mut u8, usize)

Shared Read/Write allow failure case, returns the passed allowed buffer and size to the process.

§

AllowReadOnlySuccess(*const u8, usize)

Read only allow success case, returns the previous allowed buffer and size to the process.

§

AllowReadOnlyFailure(ErrorCode, *const u8, usize)

Read only allow failure case, returns the passed allowed buffer and size to the process.

§

SubscribeSuccess(*const (), usize)

Subscribe success case, returns the previous upcall function pointer and application data.

§

SubscribeFailure(ErrorCode, *const (), usize)

Subscribe failure case, returns the passed upcall function pointer and application data.

§

YieldWaitFor(usize, usize, usize)

YieldWaitFor return value. These arguments match the arguments to an upcall, where the kernel does not define an error field. Therefore this does not have success/failure versions because the kernel cannot know if the upcall (i.e. YieldWaitFor return value) represents success or failure.

Implementations§

source§

impl SyscallReturn

source

pub fn encode_syscall_return( &self, a0: &mut u32, a1: &mut u32, a2: &mut u32, a3: &mut u32 )

Encode the system call return value into 4 registers, following the encoding specified in TRD104. Architectures which do not follow TRD104 are free to define their own encoding.

Trait Implementations§

source§

impl Clone for SyscallReturn

source§

fn clone(&self) -> SyscallReturn

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SyscallReturn

source§

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

Formats the value using the given formatter. Read more
source§

impl Copy for SyscallReturn

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> SizedTypeProperties for T

source§

#[doc(hidden)] const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Printable for T
where T: Copy + Debug,