Optimized methods for performance for data transaction. More...

Functions
uint16_t	HardwareSPI_O::transfer (uint16_t data, bool lastByte=false) override
	SPI transfer is based on a simultaneous send and receive data. More...

uint16_t	HardwareSPI_O::transfer16 (uint16_t data, bool lastByte=false) override
	SPI transfer is based on a simultaneous send and receive data. More...

uint32_t	HardwareSPI_O::transfer32 (uint32_t data, bool lastByte=false) override
	SPI transfer is based on a simultaneous send and receive data. More...

bool	HardwareSPI_O::write (uint16_t data, bool lastByte=false) override
	Sends data using SPI periphery. More...

bool	HardwareSPI_O::write16 (uint16_t data, bool lastByte=false) override
	Sends data using SPI periphery. More...

bool	HardwareSPI_O::write32 (uint32_t data, bool lastByte=false) override
	Sends data using SPI periphery. More...

uint16_t	HardwareSPI_O::receive (bool lastByte=false) override
	Receives data from SPI periphery. More...

uint16_t	HardwareSPI_O::receive16 (bool lastByte=false) override
	Receives data from SPI periphery. More...

uint32_t	HardwareSPI_O::receive32 (bool lastByte=false) override
	Receives data from SPI periphery. More...

bool	HardwareSPI_O::transferBytes (const uint8_t out, uint8_t in, uint32_t size, bool lastByte=false) override
	Transfers data using SPI periphery in blocking mode, it is sending and receiving data simultaneously. More...

bool	HardwareSPI_O::writeBytes (const uint8_t *data, uint32_t size, bool lastByte=false) override
	Sends data using SPI periphery in blocking mode. More...

bool	HardwareSPI_O::receiveBytes (uint8_t *data, uint32_t size, bool lastByte=false) override
	Receives data from SPI periphery in blocking mode. More...

bool	HardwareSPI_O::transfer (void *buf, uint16_t count, bool lastByte=false) override
	SPI transfer is based on a simultaneous send and receive data. More...

Detailed Description

Optimized methods for performance for data transaction.

Three types of transaction methods

One word methods
- Those methods can transact only one 8-bit, 16-bit and two 16-bits acting like one 32-bit.
- Main advantage is, that they are significantly faster than HardwareSPI class methods.
- Methods: transfer(), transfer16(), transfer32(), write(), write16(), write32(), receive(), receive16(), receive32()
Array methods
- Those methods can transact whole array splitted to 8-bit or 16-bit words (depends on setting setDataBits()) in polling mode.
- As fast as possible.
- Methods: transfer(void*, uint16_t, bool), transferBytes(), writeBytes(), receiveBytes()
NonBlocking methods (from base HardwareSPI class)
- Those methods can transact whole array splitted to 8-bit or 16-bit words (depends on setting setDataBits()) in non-blocking mode using DMA or IT(interrupts).
- As fast as possible, without blocking processor.
- Methods: transferBytesNonBlocking(), writeBytesNonBlocking(), receiveBytesNonBlocking()

Note: In class HardwareSPI_O, methods beginTransaction() and endTransaction() have to be called before using Optimized transaction methods, else they will be disabled. There is also an exception, array optimized transaction methods can be called without calling beginTransaction() or endTransaction().

See also: Base transaction methods

Function Documentation

◆ transfer() [1/2]

uint16_t HardwareSPI_O::transfer	(	uint16_t	data,
		bool	lastByte = `false`
	)

overridevirtual

SPI transfer is based on a simultaneous send and receive data.

Parameters

data	8-bit data to send. When data size (using setDataBits()) is set to 16 bits, 16-bit data are sent.
lastByte	Set to true, if this will be last transfered byte before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() have to be called before using this method one or multiple time, then endTransaction has to be called to disable SPI.; When you have changed bit order to MSBFIRST, not only bits, but also bytes will be swapped.

Returns: Returns received 8-bit (or when data size is set to 16, then 16-bit) data.

Reimplemented from HardwareSPI.

◆ transfer16()

uint16_t HardwareSPI_O::transfer16	(	uint16_t	data,
		bool	lastByte = `false`
	)

overridevirtual

SPI transfer is based on a simultaneous send and receive data.

Parameters

data	16-bit data to send.
lastByte	Set to true, if this will be last transfered byte before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() have to be called before using this method one or multiple time, then endTransaction has to be called to disable SPI.; When you have changed bit order to MSBFIRST, not only bits, but also bytes will be swapped.

Returns: Returns received 16-bit data.

Reimplemented from HardwareSPI.

◆ transfer32()

uint32_t HardwareSPI_O::transfer32	(	uint32_t	data,
		bool	lastByte = `false`
	)

overridevirtual

SPI transfer is based on a simultaneous send and receive data.

Parameters

data	32-bit data to send.
lastByte	Set to true, if this will be last transfered byte before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() have to be called before using this method one or multiple time, then endTransaction has to be called to disable SPI.; When you have changed bit order to MSBFIRST, not only bits, but also bytes will be swapped.

Returns: Returns received 32-bit data.

Reimplemented from HardwareSPI.

◆ write()

bool HardwareSPI_O::write	(	uint16_t	data,
		bool	lastByte = `false`
	)

overridevirtual

Sends data using SPI periphery.

If any data was received, they will be discarded. This method is faster than transfer method.

Parameters

data	8-bit data to send. When data size (using setDataBits()) is set to 16 bits, 16-bit data are sent.
lastByte	Set to true, if this will be last transfered byte before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() have to be called before using this method one or multiple time, then endTransaction has to be called to disable SPI.; When you have changed bit order to MSBFIRST, not only bits, but also bytes will be swapped.

Returns: Returns true when data has been written.

Reimplemented from HardwareSPI.

◆ write16()

bool HardwareSPI_O::write16	(	uint16_t	data,
		bool	lastByte = `false`
	)

overridevirtual

Sends data using SPI periphery.

If any data was received, they will be discarded. This method is faster than transfer method. data 16-bit data to send.

Parameters

lastByte Set to true, if this will be last transfered byte before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() have to be called before using this method one or multiple time, then endTransaction has to be called to disable SPI.; When you have changed bit order to MSBFIRST, not only bits, but also bytes will be swapped.

Returns: Returns true when data has been written.

Reimplemented from HardwareSPI.

◆ write32()

bool HardwareSPI_O::write32	(	uint32_t	data,
		bool	lastByte = `false`
	)

overridevirtual

Sends data using SPI periphery.

If any data was received, they will be discarded. This method is faster than transfer method. data 32-bit data to send.

Parameters

lastByte Set to true, if this will be last transfered byte before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() have to be called before using this method one or multiple time, then endTransaction has to be called to disable SPI.; When you have changed bit order to MSBFIRST, not only bits, but also bytes will be swapped.

Returns: Returns true when data has been written.

Reimplemented from HardwareSPI.

◆ receive()

uint16_t HardwareSPI_O::receive ( bool lastByte = false )

overridevirtual

Receives data from SPI periphery.

During receiving zeros will be sent when mode is set to Master. It is recommended to use available() method to check, if any data are available in FIFO buffer, else this method will wait until timeout or until receiving data. To check, if timeout elapsed, use lastTransactionStatus() method.

Parameters

lastByte Set to true, if this will be last transfered byte before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() have to be called before using this method one or multiple time, then endTransaction has to be called to disable SPI.; When you have changed bit order to MSBFIRST, not only bits, but also bytes will be swapped.

Returns: Returns received 8-bit (or when data size is set to 16, then 16-bit) data.

Reimplemented from HardwareSPI.

◆ receive16()

uint16_t HardwareSPI_O::receive16 ( bool lastByte = false )

overridevirtual

Receives data from SPI periphery.

During receiving zeros will be sent when mode is set to Master. It is recommended to use available() method to check, if any data are available in FIFO buffer, else this method will wait until timeout or until receiving data. To check, if timeout elapsed, use lastTransactionStatus() method.

Parameters

lastByte Set to true, if this will be last transfered byte before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() have to be called before using this method one or multiple time, then endTransaction has to be called to disable SPI.; When you have changed bit order to MSBFIRST, not only bits, but also bytes will be swapped.

Returns: Returns received 16-bit data.

Reimplemented from HardwareSPI.

◆ receive32()

uint32_t HardwareSPI_O::receive32 ( bool lastByte = false )

overridevirtual

Receives data from SPI periphery.

During receiving zeros will be sent when mode is set to Master. It is recommended to use available() method to check, if any data are available in FIFO buffer, else this method will wait until timeout or until receiving data. To check, if timeout elapsed, use lastTransactionStatus() method.

Parameters

lastByte Set to true, if this will be last transfered byte before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() have to be called before using this method one or multiple time, then endTransaction has to be called to disable SPI.; When you have changed bit order to MSBFIRST, not only bits, but also bytes will be swapped.

Returns: Returns received 32-bit data.

Reimplemented from HardwareSPI.

◆ transferBytes()

bool HardwareSPI_O::transferBytes	(	const uint8_t *	out,
		uint8_t *	in,
		uint32_t	size,
		bool	lastByte = `false`
	)

overridevirtual

Transfers data using SPI periphery in blocking mode, it is sending and receiving data simultaneously.

Parameters

out	Pointer to data, that have to be sent in blocking mode.
in	Pointer to array, where will be stored received data. It can also pointing same address as out parameter without any error.
size	The size of data in bytes (8-bits). Out and in parameter must have same size.
lastByte	Set to true, if this is last transaction method before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() and endTransaction() don't have to be called before, HardwareSPI methods will be called instead, but if you call it before, modified code will be called.; When you have changed bit order to MSBFIRST, only bits will be swapped. Bytes will be sent from array begin also in MSBFIST mode.; When data size (using setDataBits()) is set to 16 and count value is odd, the real count will be then count+1 and the last byte will contain random value.

Returns: Returns true when data has been transfered.

Reimplemented from HardwareSPI.

◆ writeBytes()

bool HardwareSPI_O::writeBytes	(	const uint8_t *	data,
		uint32_t	size,
		bool	lastByte = `false`
	)

overridevirtual

Sends data using SPI periphery in blocking mode.

If any data was received, they will be discarded. This method is faster than transfer method.

Parameters

data	Pointer to data, that have to be sent in blocking mode.
size	The size of data in bytes (8-bits).
lastByte	Set to true, if this is last transaction method before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() and endTransaction() don't have to be called before, HardwareSPI methods will be called instead, but if you call it before, modified code will be called.; When you have changed bit order to MSBFIRST, only bits will be swapped. Bytes will be sent from array begin also in MSBFIST mode.; When data size (using setDataBits()) is set to 16 and count value is odd, the real count will be then count+1 and the last byte will contain random value.

Returns: Returns true when data has been written.

Reimplemented from HardwareSPI.

◆ receiveBytes()

bool HardwareSPI_O::receiveBytes	(	uint8_t *	data,
		uint32_t	size,
		bool	lastByte = `false`
	)

overridevirtual

Receives data from SPI periphery in blocking mode.

During receiving zeros will be sent when mode is set to Master. It is recommended to use available() method to check, if any data are available in FIFO buffer, else this method will wait until timeout or until receiving data. To check, if timeout elapsed, use lastTransactionStatus() method.

Parameters

data	Pointer to array, where will be stored received data.
size	The size of data in bytes (8-bits).
lastByte	Set to true, if this is last transaction method before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() and endTransaction() don't have to be called before, HardwareSPI methods will be called instead, but if you call it before, modified code will be called.; When you have changed bit order to MSBFIRST, only bits will be swapped. Bytes will be sent from array begin also in MSBFIST mode.

Returns: Returns true when data has been received.

Reimplemented from HardwareSPI.

◆ transfer() [2/2]

bool HardwareSPI_O::transfer	(	void *	buf,
		uint16_t	count,
		bool	lastByte = `false`
	)

overridevirtual

SPI transfer is based on a simultaneous send and receive data.

Data are transfered in blocking mode.

Parameters

buf	Pointer to data, that have to be sent in blocking mode.
count	The size of data in bytes (8-bits). If you are sending whole array uint32_t[5], the count parameter have to be set to 4*5 = 20.
lastByte	Set to true, if this is last transaction method before calling endTransaction(). It is important to set this parameter when CRC is enabled, because CRC calculation hardware have to be noticed, that it have to check or send CRC.

Note: beginTransaction() and endTransaction() don't have to be called before, HardwareSPI methods will be called instead, but if you call it before, modified code will be called.; When you have changed bit order to MSBFIRST, only bits will be swapped. Bytes will be sent from array begin also in MSBFIST mode.; When data size (using setDataBits()) is set to 16 and count value is odd, the real count will be then count+1 and the last byte will contain random value.

Returns: Returns received 32-bit data.

Reimplemented from HardwareSPI.

Functions

Detailed Description

Three types of transaction methods

Function Documentation

◆ transfer() [1/2]

◆ transfer16()

◆ transfer32()

◆ write()

◆ write16()

◆ write32()

◆ receive()

◆ receive16()

◆ receive32()

◆ transferBytes()

◆ writeBytes()

◆ receiveBytes()

◆ transfer() [2/2]