This class implements the Non-volatile storage driver using a collection of NV drivers to provide a 'flat address' space that spans multiple discrete storage chips/media. More...

Detailed Description

This class implements the Non-volatile storage driver using a collection of NV drivers to provide a 'flat address' space that spans multiple discrete storage chips/media.

The individual drivers/nv-storage-instance can be different sizes and different physical media.

The interface itself is NOT thread safe. It is the responsibility of the users/clients of the driver to handle any threading issues.

#include <Gang.h>

Inheritance diagram for Driver::NV::Gang:

[legend]

Collaboration diagram for Driver::NV::Gang:

[legend]

Public Member Functions
	Gang (Api *drivers[])
	Constructor.

bool	start () noexcept
	See Driver::NV::Api.

void	stop () noexcept
	See Driver::NV::Api.

bool	write (size_t dstOffset, const void *srcData, size_t numBytesToWrite) noexcept
	See Driver::NV::Api.

bool	read (size_t srcOffset, void *dstData, size_t numBytesToRead) noexcept
	See Driver::NV::Api.

size_t	getNumPages () const noexcept
	See Driver::NV::Api.

size_t	getPageSize () const noexcept
	See Driver::NV::Api.

size_t	getTotalSize () const noexcept
	See Driver::NV::Api.

Public Member Functions inherited from Driver::NV::Api
virtual	~Api ()
	Virtual destructor.

Protected Member Functions
bool	driverRead (Api *drivers, size_t normalizedSrcOffset, uint8_t &dstData, size_t &numBytesToRead) noexcept
	Helper method to read data.

bool	driverWrite (Api *drivers, size_t normalizedDstOffset, const uint8_t &srcData, size_t &numBytesToWrite) noexcept
	Helper method to write data.

Protected Attributes
Api **	m_drivers
	List of drivers.

size_t	m_numPages
	Number of pages.

size_t	m_pageSize
	Page size.

size_t	m_totalSize
	Total size.

bool	m_started
	Started state.

Constructor & Destructor Documentation

◆ Gang()

Driver::NV::Gang::Gang ( Api * drivers[] )

Constructor.

The 'drivers' argument is a variable length array of pointers to a concrete NV drivers. The last entry in the array must be a nullptr (i.e. end-of-list marker)

Member Function Documentation

◆ driverRead()

bool Driver::NV::Gang::driverRead	(	Api **	drivers,
		size_t	normalizedSrcOffset,
		uint8_t *&	dstData,
		size_t &	numBytesToRead
	)

protectednoexcept

Helper method to read data.

◆ driverWrite()

bool Driver::NV::Gang::driverWrite	(	Api **	drivers,
		size_t	normalizedDstOffset,
		const uint8_t *&	srcData,
		size_t &	numBytesToWrite
	)

protectednoexcept

Helper method to write data.

◆ getNumPages()

size_t Driver::NV::Gang::getNumPages ( ) const

virtualnoexcept

See Driver::NV::Api.

The number of pages is based on the smallest page size from the various ganged drivers that fits within the total available space. When the ganged drivers have pages size that are not multiples of each other, the returned value can be just approximate number of pages.

Implements Driver::NV::Api.