spi_buf_set Struct Reference

SPI scatter-gather buffer array structure. More...

#include <spi.h>

Data Fields
const struct spi_buf *	buffers
	Pointer to an array of spi_buf, or NULL.
size_t	count
	Number of buffers in the array pointed to: by buffers.

Detailed Description

SPI scatter-gather buffer array structure.

A spi_buf_set is a flexible description of a whole single SPI bus transfer.

Since the set is an array of pointers to buffers, it means that pieces of a spi transfer definition can be re-used across different transfers, without having to redefine or allocate new memory for them each time. This accomplishes what is called "scatter-gather" buffer management at the driver level with user-provided buffers.

Field Documentation

buffers

const struct spi_buf* spi_buf_set::buffers

Pointer to an array of spi_buf, or NULL.

count

size_t spi_buf_set::count

Number of buffers in the array pointed to: by buffers.

---

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

• zephyr/drivers/spi.h