Driver configuration structure. More...

#include <hal_spi_v1.h>

Collaboration diagram for hal_spi_config:

Data Fields
bool	circular
	Enables the circular buffer mode.
spicallback_t	end_cb
	Operation complete callback or `NULL`.
ioline_t	ssline
	The chip select line.
ioportid_t	ssport
	The chip select port.
ioportmask_t	ssmask
	The chip select port mask.
uint_fast8_t	sspad
	The chip select pad number.
bool	slave
	Enables the slave mode.
spicb_t	data_cb
	Operation data callback or `NULL`.
spicb_t	error_cb
	Operation error callback or `NULL`.

Detailed Description

Driver configuration structure.

Definition at line 139 of file hal_spi_v1.h.

Field Documentation

◆ circular

bool hal_spi_config::circular

Enables the circular buffer mode.

Definition at line 144 of file hal_spi_v1.h.

Referenced by spiExchange(), spiIgnore(), spiReceive(), spiSend(), spiStartExchangeI(), spiStartIgnoreI(), spiStartReceiveI(), and spiStartSendI().

◆ end_cb

spicallback_t hal_spi_config::end_cb

Operation complete callback or NULL.

In linear mode the callback is invoked after the driver returns to the SPI_READY state, this allows chaining another transfer using I-Class APIs. In circular mode the callback is invoked in either SPI_ACTIVE state (half buffer) or SPI_COMPLETE state (full buffer).

Note: If a synchronous API is waiting for completion then starting a follow-on transfer from this callback is undefined.

Definition at line 156 of file hal_spi_v1.h.

◆ ssline

ioline_t hal_spi_config::ssline

The chip select line.

Note: Only used in master mode.

Definition at line 161 of file hal_spi_v1.h.

◆ ssport

ioportid_t hal_spi_config::ssport

The chip select port.

Definition at line 167 of file hal_spi_v1.h.

◆ ssmask

ioportmask_t hal_spi_config::ssmask

The chip select port mask.

Definition at line 171 of file hal_spi_v1.h.

◆ sspad

uint_fast8_t hal_spi_config::sspad

The chip select pad number.

Definition at line 181 of file hal_spi_v1.h.

◆ slave

bool hal_spi_config::slave

Enables the slave mode.

Definition at line 169 of file hal_spi_v2.h.

◆ data_cb

spicb_t hal_spi_config::data_cb

Operation data callback or NULL.

In linear mode the callback is invoked after the driver returns to the SPI_READY state, this allows chaining another transfer using I-Class APIs. In circular mode the callback is invoked in either SPI_ACTIVE state (half buffer) or SPI_COMPLETE state (full buffer).

Note: If a synchronous API is waiting for completion then starting a follow-on transfer from this callback is undefined.

Definition at line 181 of file hal_spi_v2.h.

◆ error_cb

spicb_t hal_spi_config::error_cb

Operation error callback or NULL.

Definition at line 185 of file hal_spi_v2.h.

Data Fields