This class defines a non-platform specific interface for an SPI master device driver using HALF-DUPLEX data transfers, i.e, only transmit data or receive data. More...

Detailed Description

This class defines a non-platform specific interface for an SPI master device driver using HALF-DUPLEX data transfers, i.e, only transmit data or receive data.

The intended usage is to create ONE driver per physical SPI bus, i.e. the driver instance can be shared with multiple clients.

The class does NOT manage the chip/slave select signal, i.e. the client is responsible for asserting and de-asserting the chip/slave select before and after a transaction.

The driver is NOT thread safe. It is the responsibility of the Application to ensure thread safety when driver is used and/or shared with multiple clients.

#include <MasterHalfDuplex.h>

Inheritance diagram for Driver::SPI::MasterHalfDuplex:

[legend]

Public Member Functions
virtual bool	start (size_t newBaudRateHz=0) noexcept=0
	This method is used initialize/start the driver.

virtual void	stop () noexcept=0
	This method is used to stop/shutdown the driver.

virtual bool	transmit (size_t numBytes, const void *srcData) noexcept=0
	This method writes 'numBytes' to the peripheral device.

virtual bool	receive (size_t numBytes, void *dstData) noexcept=0
	This method reads 'numBytes' from the peripheral device.

virtual	~MasterHalfDuplex ()
	Virtual destructor.

Constructor & Destructor Documentation

◆ ~MasterHalfDuplex()

virtual Driver::SPI::MasterHalfDuplex::~MasterHalfDuplex ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ receive()

virtual bool Driver::SPI::MasterHalfDuplex::receive	(	size_t	numBytes,
		void *	dstData
	)

pure virtualnoexcept

This method reads 'numBytes' from the peripheral device.

The buffer pointed to by 'dstData' must be at least 'numBytes' in size. Returns true if successful; else false is returned.

Implemented in Driver::SPI::STM32::MasterHalfDuplex.

◆ start()

virtual bool Driver::SPI::MasterHalfDuplex::start ( size_t newBaudRateHz = 0 )

pure virtualnoexcept

This method is used initialize/start the driver.

To 'restart' the driver, the application must call stop(), then start().

When 'newBaudRateHz' is non-zero, the SPI's transfer frequency is updated (from what was provided in the constructor). When the driver is stopped and restarted, the default baudrate on restart will be the value provided in the constructor.

The method returns true if successful; else false is returned when an error occurred. If false is returned, future read/write calls will always return a failure.

Implemented in Driver::SPI::STM32::MasterHalfDuplex.