Zephyr Project API 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
i2s_driver_api Struct Reference

@def_driverbackendgroup{I2S,i2s_interface} More...

#include <i2s.h>

Data Fields

int(* configure )(const struct device *dev, enum i2s_dir dir, const struct i2s_config *cfg)
 @driver_ops_mandatory Configure operation of a host I2S controller. See i2s_configure() for arguments description.
const struct i2s_config *(* config_get )(const struct device *dev, enum i2s_dir dir)
 @driver_ops_mandatory Fetch configuration information of a host I2S controller. See i2s_config_get() for arguments description.
int(* read )(const struct device *dev, void **mem_block, size_t *size)
 @driver_ops_mandatory Read data from the RX queue. See i2s_read() for arguments description.
int(* write )(const struct device *dev, void *mem_block, size_t size)
 @driver_ops_mandatory Write data to the TX queue. See i2s_write() for arguments description.
int(* trigger )(const struct device *dev, enum i2s_dir dir, enum i2s_trigger_cmd cmd)
 @driver_ops_mandatory Send a trigger command. See i2s_trigger() for arguments description.

Detailed Description

@def_driverbackendgroup{I2S,i2s_interface}

@driver_ops{I2S}

Field Documentation

◆ config_get

const struct i2s_config *(* i2s_driver_api::config_get) (const struct device *dev, enum i2s_dir dir)

@driver_ops_mandatory Fetch configuration information of a host I2S controller. See i2s_config_get() for arguments description.

◆ configure

int(* i2s_driver_api::configure) (const struct device *dev, enum i2s_dir dir, const struct i2s_config *cfg)

@driver_ops_mandatory Configure operation of a host I2S controller. See i2s_configure() for arguments description.

◆ read

int(* i2s_driver_api::read) (const struct device *dev, void **mem_block, size_t *size)

@driver_ops_mandatory Read data from the RX queue. See i2s_read() for arguments description.

◆ trigger

int(* i2s_driver_api::trigger) (const struct device *dev, enum i2s_dir dir, enum i2s_trigger_cmd cmd)

@driver_ops_mandatory Send a trigger command. See i2s_trigger() for arguments description.

◆ write

int(* i2s_driver_api::write) (const struct device *dev, void *mem_block, size_t size)

@driver_ops_mandatory Write data to the TX queue. See i2s_write() for arguments description.


The documentation for this struct was generated from the following file:
  • include/zephyr/drivers/i2s.h