Struct capsules_extra::nonvolatile_storage_driver::NonvolatileStorage

pub struct NonvolatileStorage<'a> { /* private fields */ }

Implementations

impl<'a> NonvolatileStorage<'a>

pub fn new( driver: &'a dyn NonvolatileStorage<'a>, grant: Grant<App, UpcallCount<{ upcall::COUNT }>, AllowRoCount<{ ro_allow::COUNT }>, AllowRwCount<{ rw_allow::COUNT }>>, userspace_start_address: usize, userspace_length: usize, kernel_start_address: usize, kernel_length: usize, buffer: &'static mut [u8], ) -> NonvolatileStorage<'a>

Trait Implementations

impl<'a> NonvolatileStorage<'a> for NonvolatileStorage<'a>

Provide an interface for the kernel.

fn set_client(&self, client: &'a dyn NonvolatileStorageClient)

fn read( &self, buffer: &'static mut [u8], address: usize, length: usize, ) -> Result<(), ErrorCode>

Read length bytes starting at address address in to the provided buffer. The buffer must be at least length bytes long. The address must be in the address space of the physical storage.

fn write( &self, buffer: &'static mut [u8], address: usize, length: usize, ) -> Result<(), ErrorCode>

Write length bytes starting at address address from the provided buffer. The buffer must be at least length bytes long. This address must be in the address space of the physical storage.

impl NonvolatileStorageClient for NonvolatileStorage<'_>

This is the callback client for the underlying physical storage driver.

fn read_done(&self, buffer: &'static mut [u8], length: usize)

read_done is called when the implementor is finished reading in to the buffer. The callback returns the buffer and the number of bytes that were actually read.

fn write_done(&self, buffer: &'static mut [u8], length: usize)

write_done is called when the implementor is finished writing from the buffer. The callback returns the buffer and the number of bytes that were actually written.

impl SyscallDriver for NonvolatileStorage<'_>

Provide an interface for userland.

fn command( &self, command_num: usize, offset: usize, length: usize, processid: ProcessId, ) -> CommandReturn

Command interface.

Commands are selected by the lowest 8 bits of the first argument.

command_num

• 0: Return Ok(()) if this driver is included on the platform.
• 1: Return the number of bytes available to userspace.
• 2: Start a read from the nonvolatile storage.
• 3: Start a write to the nonvolatile_storage.

fn allocate_grant(&self, processid: ProcessId) -> Result<(), Error>

Request to allocate a capsule’s grant for a specific process.

fn allow_userspace_readable( &self, app: ProcessId, which: usize, slice: ReadWriteProcessBuffer, ) -> Result<ReadWriteProcessBuffer, (ReadWriteProcessBuffer, ErrorCode)>

System call for a process to pass a buffer (a UserspaceReadableProcessBuffer) to the kernel that the kernel can either read or write. The kernel calls this method only after it checks that the entire buffer is within memory the process can both read and write.