Espressif ESP32 Joybus backend. More...

Data Structures
struct	joybus_esp32_data
struct	joybus_esp32
	An ESP32 Joybus instance. More...
struct	joybus_esp32_config
	Configuration for an ESP32 Joybus instance. More...

Macros
#define	JOYBUS_ESP32(bus)
	Macro to cast a generic Joybus instance to an ESP32 Joybus instance.
#define	JOYBUS_ESP32_ISR_IRAM_SAFE 0
	Whether the application's Joybus callbacks are safe to run with the cache disabled.

Functions
static struct joybus_esp32_config	joybus_esp32_config_default (gpio_num_t gpio)
	Build an ESP32 config with default values.
int	joybus_esp32_init (struct joybus_esp32 *esp32_bus, struct joybus_esp32_config config)
	Initialize an ESP32 Joybus instance.

Detailed Description

Espressif ESP32 Joybus backend.

Macro Definition Documentation

◆ JOYBUS_ESP32

#define JOYBUS_ESP32 ( bus )

Value:

((struct joybus_esp32 *)(bus))

joybus_esp32

An ESP32 Joybus instance.

Definition esp32.h:86

Macro to cast a generic Joybus instance to an ESP32 Joybus instance.

◆ JOYBUS_ESP32_ISR_IRAM_SAFE

#define JOYBUS_ESP32_ISR_IRAM_SAFE 0

Whether the application's Joybus callbacks are safe to run with the cache disabled.

Disabled by default. Define as 1 to keep the Joybus interrupt live during a flash write, which otherwise masks it for the whole operation. Every callback the bus invokes must then be marked JOYBUS_RAM_FUNC, or it faults the first time one runs with the cache off.

Function Documentation

◆ joybus_esp32_config_default()

struct joybus_esp32_config joybus_esp32_config_default ( gpio_num_t gpio )

inlinestatic

Build an ESP32 config with default values.

Parameters

gpio	the GPIO pin to use for the Joybus data line

Returns: a config with the given GPIO and a nominal frequency

◆ joybus_esp32_init()

int joybus_esp32_init	(	struct joybus_esp32 *	esp32_bus,
		struct joybus_esp32_config	config )

Initialize an ESP32 Joybus instance.