modm API documentation
modm::BdSpiStackFlash< SpiBlockDevice, DieCount > Class Template Reference

SpiStack homogenoues memory. More...

#include <modm/driver/storage/block_device_spistack_flash.hpp>

Inheritance diagram for modm::BdSpiStackFlash< SpiBlockDevice, DieCount >:
modm::BlockDevice modm::NestedResumable< 3 >

Public Typedefs

using bd_address_t = uint32_t
 
using bd_size_t = uint32_t
 

Public Member Functions

modm::ResumableResult< bool > initialize ()
 Initializes the storage hardware.
 
modm::ResumableResult< bool > deinitialize ()
 Deinitializes the storage hardware.
 
modm::ResumableResult< bool > read (uint8_t *buffer, bd_address_t address, bd_size_t size)
 
modm::ResumableResult< bool > program (const uint8_t *buffer, bd_address_t address, bd_size_t size)
 
modm::ResumableResult< bool > erase (bd_address_t address, bd_size_t size)
 
modm::ResumableResult< bool > write (const uint8_t *buffer, bd_address_t address, bd_size_t size)
 
modm::ResumableResult< bool > isBusy ()
 
modm::ResumableResult< void > waitWhileBusy ()
 
modm::ResumableResult< bool > deinitialize ()
 Deinitializes the storage hardware.
 
modm::ResumableResult< bool > erase (bd_address_t address, bd_size_t size)
 
modm::ResumableResult< bool > initialize ()
 Initializes the storage hardware.
 
modm::ResumableResult< bool > program (const uint8_t *buffer, bd_address_t address, bd_size_t size)
 
modm::ResumableResult< bool > read (uint8_t *buffer, bd_address_t address, bd_size_t size)
 
modm::ResumableResult< bool > write (const uint8_t *buffer, bd_address_t address, bd_size_t size)
 

Static Public Attributes

static constexpr bd_size_t BlockSizeRead = SpiBlockDevice::BlockSizeRead
 
static constexpr bd_size_t BlockSizeWrite = SpiBlockDevice::BlockSizeWrite
 
static constexpr bd_size_t BlockSizeErase = SpiBlockDevice::BlockSizeErase
 
static constexpr bd_size_t DieSize = SpiBlockDevice::DeviceSize
 
static constexpr bd_size_t DeviceSize = DieCount * DieSize
 
static constexpr bd_size_t BlockSizeErase = 1
 
static constexpr bd_size_t BlockSizeRead = 1
 
static constexpr bd_size_t BlockSizeWrite = 1
 

Protected Member Functions

modm::ResumableResult< ReturnType > resumable function (...)
 
int8_t getResumableDepth () const
 
bool isResumableRunning () const
 
void stopResumable ()
 Force all resumable functions to stop running at the current nesting level.
 

Detailed Description

template<typename SpiBlockDevice, uint8_t DieCount>
class modm::BdSpiStackFlash< SpiBlockDevice, DieCount >

SpiStack homogenoues memory.

The read(), erase(),program() and write() methodes wait for the chip to finish writing to the flash.

Template Parameters
SpiBlockDeviceBase SPI block device of the homogenous stack
Author
Rasmus Kleist Hørlyck Sørensen

Member Function Documentation

template<typename SpiBlockDevice , uint8_t DieCount>
modm::ResumableResult<bool> modm::BdSpiStackFlash< SpiBlockDevice, DieCount >::erase ( bd_address_t  address,
bd_size_t  size 
)

Erase blocks

The state of an erased block is undefined until it has been programmed

Parameters
addressAddress of block to begin erasing
sizeSize to erase in bytes (multiple of read block size)
Returns
True on success
modm::ResumableResult<bool> modm::BlockDevice::erase ( bd_address_t  address,
bd_size_t  size 
)
inherited

Erase blocks

The state of an erased block is undefined until it has been programmed

Parameters
addressAddress of block to begin erasing
sizeSize to erase in bytes (multiple of read block size)
Returns
True on success
modm::ResumableResult< ReturnType > resumable modm::NestedResumable< 1 >::function (   ...)
inherited

Run the resumable function.

You need to implement this method in you subclass yourself.

Returns
>NestingError if still running, <=NestingError if it has finished.
int8_t modm::NestedResumable< 1 >::getResumableDepth ( ) const
inheritedinline
Returns
the nesting depth in the current resumable function, or -1 if called outside any resumable function
template<typename SpiBlockDevice , uint8_t DieCount>
modm::ResumableResult<bool> modm::BdSpiStackFlash< SpiBlockDevice, DieCount >::isBusy ( )

Check if device is busy

Returns
True if any die in the stack is busy.
bool modm::NestedResumable< 1 >::isResumableRunning ( ) const
inheritedinline
Returns
true if a resumable function is running at the current nesting level, else false
template<typename SpiBlockDevice , uint8_t DieCount>
modm::ResumableResult<bool> modm::BdSpiStackFlash< SpiBlockDevice, DieCount >::program ( const uint8_t *  buffer,
bd_address_t  address,
bd_size_t  size 
)

Program blocks with data

Any block has to be erased prior to being programmed

Parameters
bufferBuffer of data to write to blocks
addressAddress of first block to begin writing to
sizeSize to write in bytes (multiple of read block size)
Returns
True on success
modm::ResumableResult<bool> modm::BlockDevice::program ( const uint8_t *  buffer,
bd_address_t  address,
bd_size_t  size 
)
inherited

Program blocks with data

Any block has to be erased prior to being programmed

Parameters
bufferBuffer of data to write to blocks
addressAddress of first block to begin writing to
sizeSize to write in bytes (multiple of read block size)
Returns
True on success
template<typename SpiBlockDevice , uint8_t DieCount>
modm::ResumableResult<bool> modm::BdSpiStackFlash< SpiBlockDevice, DieCount >::read ( uint8_t *  buffer,
bd_address_t  address,
bd_size_t  size 
)

Read data from one or more blocks

Parameters
bufferBuffer to read data into
addressAddress to begin reading from
sizeSize to read in bytes (multiple of read block size)
Returns
True on success
modm::ResumableResult<bool> modm::BlockDevice::read ( uint8_t *  buffer,
bd_address_t  address,
bd_size_t  size 
)
inherited

Read data from one or more blocks

Parameters
bufferBuffer to read data into
addressAddress to begin reading from
sizeSize to read in bytes (multiple of read block size)
Returns
True on success
template<typename SpiBlockDevice , uint8_t DieCount>
modm::ResumableResult<void> modm::BdSpiStackFlash< SpiBlockDevice, DieCount >::waitWhileBusy ( )

This function can be used in another resumable function to wait until the flash operation is finished.

template<typename SpiBlockDevice , uint8_t DieCount>
modm::ResumableResult<bool> modm::BdSpiStackFlash< SpiBlockDevice, DieCount >::write ( const uint8_t *  buffer,
bd_address_t  address,
bd_size_t  size 
)

Writes data to one or more blocks after erasing them

The blocks are erased prior to being programmed

Parameters
bufferBuffer of data to write to blocks
addressAddress of first block to begin writing to
sizeSize to write in bytes (multiple of read block size)
Returns
True on success
modm::ResumableResult<bool> modm::BlockDevice::write ( const uint8_t *  buffer,
bd_address_t  address,
bd_size_t  size 
)
inherited

Writes data to one or more blocks after erasing them

The blocks are erased proir to being programmed

Parameters
bufferBuffer of data to write to blocks
addressAddress of first block to begin writing to
sizeSize to write in bytes (multiple of read block size)
Returns
True on success

Member Data Documentation

constexpr bd_size_t modm::BlockDevice::BlockSizeRead = 1
inheritedstaticconstexpr

Minimum block sizes for block device operations

Most persistent storage devices require program(), erase() and sometimes read() operations to be executed on fixed sized blocks.


The documentation for this class was generated from the following file: