Struct capsules::virtual_flash::FlashUser

pub struct FlashUser<'a, F: Flash + 'static> {
    mux: &'a MuxFlash<'a, F>,
    buffer: TakeCell<'static, F::Page>,
    operation: Cell<Op>,
    next: ListLink<'a, FlashUser<'a, F>>,
    client: Cell<Option<&'a Client<FlashUser<'a, F>>>>,
}

Keep state for each flash user. All uses of the virtualized flash interface need to create one of these to be a user of the flash. The new() function handles most of the work, a user only has to pass in a reference to the MuxFlash object.

Fields

mux: &'a MuxFlash<'a, F>

buffer: TakeCell<'static, F::Page>

operation: Cell<Op>

next: ListLink<'a, FlashUser<'a, F>>

client: Cell<Option<&'a Client<FlashUser<'a, F>>>>

Methods

impl<'a, F: Flash + 'a> FlashUser<'a, F>

pub const fn new(mux: &'a MuxFlash<'a, F>) -> FlashUser<'a, F>

Trait Implementations

impl<'a, F: Flash + 'a, C: Client<Self>> HasClient<'a, C> for FlashUser<'a, F>

fn set_client(&'a self, client: &'a C)

Set the client for this flash peripheral. The client will be called when operations complete.

impl<'a, F: Flash + 'a> Client<F> for FlashUser<'a, F>

fn read_complete(&self, pagebuffer: &'static mut F::Page, error: Error)

Flash read complete.

fn write_complete(&self, pagebuffer: &'static mut F::Page, error: Error)

Flash write complete.

fn erase_complete(&self, error: Error)

Flash erase complete.

impl<'a, F: Flash + 'a> ListNode<'a, FlashUser<'a, F>> for FlashUser<'a, F>

fn next(&'a self) -> &'a ListLink<'a, FlashUser<'a, F>>

impl<'a, F: Flash + 'a> Flash for FlashUser<'a, F>

type Page = F::Page

Type of a single flash page for the given implementation.

fn read_page(
    &self,
    page_number: usize,
    buf: &'static mut Self::Page
) -> ReturnCode

Read a page of flash into the buffer.

fn write_page(
    &self,
    page_number: usize,
    buf: &'static mut Self::Page
) -> ReturnCode

Write a page of flash from the buffer.

fn erase_page(&self, page_number: usize) -> ReturnCode

Erase a page of flash.