Storage::ProgMem Class Reference

Storage device to access PROGMEM using flash API. More...

#include <ProgMem.h>

Inheritance diagram for Storage::ProgMem:

Collaboration diagram for Storage::ProgMem:

Classes
class	ProgMemPartitionTable

Public Member Functions
String	getName () const override
	Obtain unique device name. More...
size_t	getBlockSize () const override
	Obtain smallest allocation unit for erase operations. More...
storage_size_t	getSize () const override
	Obtain addressable size of this device. More...
Type	getType () const override
	Obtain device type. More...
bool	read (storage_size_t address, void *dst, size_t size) override
	Read data from the storage device. More...
bool	write (storage_size_t address, const void *src, size_t size) override
	Write data to the storage device. More...
bool	erase_range (storage_size_t address, storage_size_t size) override
	Erase a region of storage in preparation for writing. More...
ProgMemPartitionTable &	editablePartitions ()
Public Member Functions inherited from Storage::Device
	Device ()
	~Device ()
bool	operator== (const String &name) const
const PartitionTable &	partitions () const
	Provide read-only access to partition table. More...
PartitionTable &	editablePartitions ()
	Provide full access to partition table. More...
bool	loadPartitions (uint32_t tableOffset)
	Load partition table entries @tableOffset Location of partition table to read. More...
bool	loadPartitions (Device &source, uint32_t tableOffset)
	Load partition table entries from another table. More...
virtual uint32_t	getId () const
	Obtain device ID. More...
virtual uint16_t	getSectorSize () const
	Get sector size, the unit of allocation for block-access devices. More...
virtual storage_size_t	getSectorCount () const
	Obtain total number of sectors on this device. More...
virtual bool	sync ()
	Flush any pending writes to the physical media. More...
size_t	printTo (Print &p) const
Public Member Functions inherited from LinkedObjectTemplate< Device >
Device *	getNext () const
bool	insertAfter (Device *object)
Iterator	begin () const
Iterator	end () const
Iterator	cbegin () const
Iterator	cend () const
Public Member Functions inherited from LinkedObject
virtual	~LinkedObject ()
virtual LinkedObject *	next () const
bool	insertAfter (LinkedObject *object)
bool	operator== (const LinkedObject &other) const
bool	operator!= (const LinkedObject &other) const

Additional Inherited Members
Public Types inherited from Storage::Device
enum class	Type : uint8_t { partitionType = uint8_t(Partition::Type::storage) , XX }
	Storage type. More...
using	List = LinkedObjectListTemplate< Device >
using	OwnedList = OwnedLinkedObjectListTemplate< Device >
Public Types inherited from LinkedObjectTemplate< Device >
using	Iterator = IteratorTemplate< Device, Device *, Device & >
using	ConstIterator = IteratorTemplate< const Device, const Device *, const Device & >
Static Public Attributes inherited from Storage::Device
static constexpr uint16_t	defaultSectorSize {512}
Protected Attributes inherited from Storage::Device
PartitionTable	mPartitions

Detailed Description

Storage device to access PROGMEM using flash API.

Member Function Documentation

editablePartitions()

ProgMemPartitionTable& Storage::ProgMem::editablePartitions ( )

inline

erase_range()

bool Storage::ProgMem::erase_range ( storage_size_t  address, storage_size_t  size  )

inlineoverridevirtual

Erase a region of storage in preparation for writing.

Parameters

address	Where to start erasing
size	Size of region to erase, in bytes

Return values

bool	true on success, false on error

Implements Storage::Device.

getBlockSize()

size_t Storage::ProgMem::getBlockSize ( ) const

inlineoverridevirtual

Obtain smallest allocation unit for erase operations.

Implements Storage::Device.

getName()

String Storage::ProgMem::getName ( ) const

inlineoverridevirtual

Obtain unique device name.

Implements Storage::Device.

getSize()

storage_size_t Storage::ProgMem::getSize ( ) const

inlineoverridevirtual

Obtain addressable size of this device.

Return values

storage_size_t

Must be at least as large as the value declared in the hardware configuration

Implements Storage::Device.

getType()

Type Storage::ProgMem::getType ( ) const

inlineoverridevirtual

Obtain device type.

Implements Storage::Device.

read()

bool Storage::ProgMem::read ( storage_size_t  address, void *  dst, size_t  size  )

overridevirtual

Read data from the storage device.

Parameters

address	Where to start reading
dst	Buffer to store data
size	Size of data to be read, in bytes.

Return values

bool	true on success, false on error

Implements Storage::Device.

write()

bool Storage::ProgMem::write ( storage_size_t  address, const void *  src, size_t  size  )

inlineoverridevirtual

Write data to the storage device.

Parameters

address	Where to start writing
src	Data to write
size	Size of data to be written, in bytes.

Return values

bool	true on success, false on error

Implements Storage::Device.

---

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

• ProgMem.h