Storage device to access system memory, e.g. RAM. More...

#include <SysMem.h>

Inheritance diagram for Storage::SysMem:

Collaboration diagram for Storage::SysMem:

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...

size_t	getSize () const override
	Obtain addressable size of this device. More...

Type	getType () const override
	Obtain device type. More...

bool	read (uint32_t address, void *buffer, size_t len) override
	Read data from the storage device. More...

bool	write (uint32_t address, const void *data, size_t len) override
	Write data to the storage device. More...

bool	erase_range (uint32_t address, size_t len) override
	Erase a region of storage in preparation for writing. More...

Partition	createPartition (const String &name, const FSTR::ObjectBase &fstr, Partition::Type type, uint8_t subtype)
	Create partition for FlashString data access. More...

template<typename T >
Partition	createPartition (const String &name, const FSTR::ObjectBase &fstr, T subType)

Public Member Functions inherited from Storage::CustomDevice
Partition	createPartition (const Partition::Info &info)

Partition	createPartition (const String &name, Partition::Type type, uint8_t subtype, uint32_t offset, size_t size, Partition::Flags flags=0)

template<typename SubType >
Partition	createPartition (const String &name, SubType subtype, uint32_t offset, size_t size, Partition::Flags flags=0)

Public Member Functions inherited from Storage::Device
	Device ()

	~Device ()

bool	operator== (const String &name) const

PartitionTable &	partitions ()

const PartitionTable &	partitions () const

bool	loadPartitions (uint32_t tableOffset)
	Load partition table entries 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...

Public Member Functions inherited from LinkedObjectTemplate< Device >
Device *	getNext () const

Iterator	begin () const

Iterator	end () const

Iterator	cbegin () const

Iterator	cend () const

Public Member Functions inherited from LinkedObject
virtual	~LinkedObject ()

virtual LinkedObject *	next () const

LinkedObject *	getNext () const

bool	operator== (const LinkedObject &other) const

bool	operator!= (const LinkedObject &other) const

Additional Inherited Members
Public Types inherited from Storage::Device
enum	Type : uint8_t { Type::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 &>

Protected Attributes inherited from Storage::Device
PartitionTable	mPartitions

Detailed Description

Storage device to access system memory, e.g. RAM.

Member Function Documentation

◆ createPartition() [1/2]

Partition Storage::SysMem::createPartition	(	const String &	name,
		const FSTR::ObjectBase &	fstr,
		Partition::Type	type,
		uint8_t	subtype
	)

Create partition for FlashString data access.

◆ createPartition() [2/2]

template<typename T >

Partition Storage::SysMem::createPartition	(	const String &	name,
		const FSTR::ObjectBase &	fstr,
		T	subType
	)

inline

◆ erase_range()

bool Storage::SysMem::erase_range	(	uint32_t	address,
		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::SysMem::getBlockSize ( ) const

inlineoverridevirtual

Obtain smallest allocation unit for erase operations.

Implements Storage::Device.

◆ getName()

String Storage::SysMem::getName ( ) const

inlineoverridevirtual

Obtain unique device name.

Implements Storage::Device.

◆ getSize()

size_t Storage::SysMem::getSize ( ) const

inlineoverridevirtual

Obtain addressable size of this device.

Return values

size_t Must be at least as large as the value declared in the partition table

Implements Storage::Device.

◆ getType()

Type Storage::SysMem::getType ( ) const

inlineoverridevirtual

Obtain device type.

Implements Storage::Device.

◆ read()

bool Storage::SysMem::read	(	uint32_t	address,
		void *	dst,
		size_t	size
	)

inlineoverridevirtual

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::SysMem::write	(	uint32_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:

SysMem.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createPartition() [1/2]

◆ createPartition() [2/2]

◆ erase_range()

◆ getBlockSize()

◆ getName()

◆ getSize()

◆ getType()

◆ read()

◆ write()