as5047u::SpiInterface< Derived > Class Template Reference

#include <as5047u_spi_interface.hpp>

Public Member Functions
bool	transfer (const uint8_t *tx, uint8_t *rx, std::size_t len)
	Perform a full-duplex SPI data transfer.
	SpiInterface (const SpiInterface &)=delete
SpiInterface &	operator= (const SpiInterface &)=delete

Protected Member Functions
	SpiInterface ()=default
	Protected constructor to prevent direct instantiation.
	SpiInterface (SpiInterface &&)=default
SpiInterface &	operator= (SpiInterface &&)=default
	~SpiInterface ()=default
	Protected destructor.

Constructor & Destructor Documentation

SpiInterface() [1/3]

template<typename Derived >

as5047u::SpiInterface< Derived >::SpiInterface ( const SpiInterface< Derived > &  )

delete

SpiInterface() [2/3]

template<typename Derived >

as5047u::SpiInterface< Derived >::SpiInterface ( )

protecteddefault

Protected constructor to prevent direct instantiation.

SpiInterface() [3/3]

template<typename Derived >

as5047u::SpiInterface< Derived >::SpiInterface ( SpiInterface< Derived > &&  )

protecteddefault

~SpiInterface()

template<typename Derived >

as5047u::SpiInterface< Derived >::~SpiInterface ( )

protecteddefault

Protected destructor.

Note

Derived classes can have public destructors

Member Function Documentation

operator=() [1/2]

template<typename Derived >

SpiInterface & as5047u::SpiInterface< Derived >::operator= ( const SpiInterface< Derived > &  )

delete

operator=() [2/2]

template<typename Derived >

SpiInterface & as5047u::SpiInterface< Derived >::operator= ( SpiInterface< Derived > &&  )

protecteddefault

transfer()

template<typename Derived >

bool as5047u::SpiInterface< Derived >::transfer ( const uint8_t *  tx, uint8_t *  rx, std::size_t  len  )

inline

Perform a full-duplex SPI data transfer.

Sends len bytes from tx and simultaneously receives len bytes into rx. Implementations should assert the device's chip select for the duration of the transfer.

Parameters

tx	Pointer to data to transmit (len bytes). If nullptr, zeros can be sent.
rx	Pointer to buffer for received data (len bytes). If nullptr, received data can be ignored.
len	Number of bytes to transfer.

Returns

true when the frame was transferred, false on a bus error.

---

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

• as5047u_spi_interface.hpp