SPlatformSpiConfig Struct Reference

Structure describes spi platform configuration. More...

#include <interface.h>

Public Attributes
int8_t	busId
	bus id number. More...
union {
int8_t   cs
int8_t   devId
};
	parameter is optional for all platforms, except Linux. More...
int8_t	dc
	Data command control pin number. More...
uint32_t	frequency
	Frequency in HZ to run spi bus at. More...
int8_t	scl
	Optional - spi clock pin number. More...
int8_t	sda
	Optional - spi data MOSI pin number. More...

Detailed Description

Structure describes spi platform configuration.

Warning

Not all fields are used by specific platforms

Definition at line 80 of file interface.h.

Member Data Documentation

@6

union { ... }

parameter is optional for all platforms, except Linux.

If chip select pin is not used, it should be set to -1 For Linux platform devId should be pointed, if -1, it defaults to spidevX.0

busId

int8_t SPlatformSpiConfig::busId

bus id number.

this parameter is valid for Linux, ESP32. If -1 is pointed, it defaults to platform specific i2c bus (Linux spidev1.X, esp32 VSPI_HOST).

Definition at line 86 of file interface.h.

dc

int8_t SPlatformSpiConfig::dc

Data command control pin number.

This pin assignment is mandatory

Definition at line 102 of file interface.h.

frequency

uint32_t SPlatformSpiConfig::frequency

Frequency in HZ to run spi bus at.

If 0, it defaults to max frequency, supported by platform

Definition at line 108 of file interface.h.

scl

int8_t SPlatformSpiConfig::scl

Optional - spi clock pin number.

-1 if to use default spi clock pin. This is required for ESP32 platform only.

Definition at line 114 of file interface.h.

sda

int8_t SPlatformSpiConfig::sda

Optional - spi data MOSI pin number.

-1 if to use default spi MOSI pin. This is required for ESP32 platform only.

Definition at line 120 of file interface.h.

---

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

• src/lcd_hal/interface.h