pub enum SyscallReturn {
Show 18 variants Failure(ErrorCode), FailureU32(ErrorCodeu32), FailureU32U32(ErrorCodeu32u32), FailureU64(ErrorCodeu64), Success, SuccessU32(u32), SuccessU32U32(u32u32), SuccessU32U32U32(u32u32u32), SuccessU64(u64), SuccessU64U32(u64u32), AllowReadWriteSuccess(*mut u8usize), AllowReadWriteFailure(ErrorCode*mut u8usize), UserspaceReadableAllowSuccess(*mut u8usize), UserspaceReadableAllowFailure(ErrorCode*mut u8usize), AllowReadOnlySuccess(*const u8usize), AllowReadOnlyFailure(ErrorCode*const u8usize), SubscribeSuccess(*const ()usize), SubscribeFailure(ErrorCode*const ()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(ErrorCodeu32)

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

FailureU32U32(ErrorCodeu32u32)

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

FailureU64(ErrorCodeu64)

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(u32u32)

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

SuccessU32U32U32(u32u32u32)

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

SuccessU64(u64)

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

SuccessU64U32(u64u32)

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

AllowReadWriteSuccess(*mut u8usize)

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

AllowReadWriteFailure(ErrorCode*mut u8usize)

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

UserspaceReadableAllowSuccess(*mut u8usize)

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

UserspaceReadableAllowFailure(ErrorCode*mut u8usize)

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

AllowReadOnlySuccess(*const u8usize)

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

AllowReadOnlyFailure(ErrorCode*const u8usize)

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.

Implementations

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.