modm API documentation
Public Typedefs | Public Member Functions | Static Public Attributes | List of all members
modm::BdHeap< DeviceSize_, externalMemory > Class Template Reference
External Device Drivers » Block Devices » Heap Block Device

Block device using heap (RAM) More...

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

Inheritance diagram for modm::BdHeap< DeviceSize_, externalMemory >:
modm::BlockDevice

Public Typedefs

using bd_address_t = uint32_t
 
using bd_size_t = uint32_t
 

Public Member Functions

bool initialize ()
 Initializes the memory with zeros.
 
bool initialize (uint8_t *externalMemoryAddress)
 Data will be stored at externalMemoryAddress.
 
bool deinitialize ()
 Deinitializes nothing.
 
bool read (uint8_t *buffer, bd_address_t address, bd_size_t size)
 
bool program (const uint8_t *buffer, bd_address_t address, bd_size_t size)
 
bool erase (bd_address_t address, bd_size_t size)
 
bool write (const uint8_t *buffer, bd_address_t address, bd_size_t size)
 
void setMemoryAddress (uint8_t *memory)
 

Static Public Attributes

static constexpr bd_size_t BlockSizeRead = 1
 
static constexpr bd_size_t BlockSizeWrite = 1
 
static constexpr bd_size_t BlockSizeErase = 1
 
static constexpr bd_size_t DeviceSize = DeviceSize_
 

Detailed Description

template<size_t DeviceSize_, bool externalMemory = false>
class modm::BdHeap< DeviceSize_, externalMemory >

Block device using heap (RAM)

Usually not persistant, but at least useful for testing. This is also useful for battery backed SRAM, some STM32 have up to 4kB of this stuff.

Template Parameters
DeviceSizeThe size of the block device
externalMemorySet to true to use an external supplied memory block (see initialize(uint8_t*))
Author
Raphael Lehmann

Member Function Documentation

template<size_t DeviceSize_, bool externalMemory = false>
bool modm::BdHeap< DeviceSize_, externalMemory >::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
template<size_t DeviceSize_, bool externalMemory = false>
bool modm::BdHeap< DeviceSize_, externalMemory >::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
template<size_t DeviceSize_, bool externalMemory = false>
bool modm::BdHeap< DeviceSize_, externalMemory >::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
template<size_t DeviceSize_, bool externalMemory = false>
bool modm::BdHeap< DeviceSize_, externalMemory >::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
The documentation for this class was generated from the following file: