Struct capsules_extra::tickv::TickFSFlashCtrl

pub struct TickFSFlashCtrl<'a, F: Flash + 'static> { /* private fields */ }

Wrapper object that provides the flash interface TicKV expects using the Tock flash HIL.

Note, TicKV expects a synchronous flash implementation, but the Tock flash HIL is asynchronous. To mediate this, this wrapper starts a flash read/write/erase, but returns without the requested operation having completed. To signal TicKV that this is what happened, this implementation returns NotReady errors. When the underlying flash operation has completed the TicKVSystem object will get the callback and then notify TicKV that the requested operation is now ready.

Implementations

impl<'a, F: Flash> TickFSFlashCtrl<'a, F>

pub fn new( flash: &'a F, flash_read_buffer: &'static mut F::Page, region_offset: usize, ) -> TickFSFlashCtrl<'a, F>

Trait Implementations

impl<'a, F: Flash, const PAGE_SIZE: usize> FlashController<PAGE_SIZE> for TickFSFlashCtrl<'a, F>

fn read_region( &self, region_number: usize, _buf: &mut [u8; PAGE_SIZE], ) -> Result<(), ErrorCode>

This function must read the data from the flash region specified by region_number into buf. The length of the data read should be the same length as buf.

fn write(&self, address: usize, buf: &[u8]) -> Result<(), ErrorCode>

This function must write the length of buf to the specified address in flash. If the length of buf is smaller then the minimum supported write size the implementation can write a larger value. This should be done by first reading the value, making the changed from buf and then writing it back.

fn erase_region(&self, region_number: usize) -> Result<(), ErrorCode>

This function must erase the region specified by region_number.