Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Digital Microphone Driver Backend API

Data Structures

struct  dmic_driver_api
  Driver Operations Digital Microphone driver operations More...

Typedefs

typedef int(* dmic_configure_t) (const struct device *dev, struct dmic_cfg *config)
 Callback API to configure a DMIC device.
typedef int(* dmic_trigger_t) (const struct device *dev, enum dmic_trigger cmd)
 Callback API to send a command to a DMIC device.
typedef int(* dmic_read_t) (const struct device *dev, uint8_t stream, void **buffer, size_t *size, int32_t timeout)
 Callback API to read PCM data from a DMIC device.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a Digital Microphone driver.

Typedef Documentation

◆ dmic_configure_t

typedef int(* dmic_configure_t) (const struct device *dev, struct dmic_cfg *config)

#include <zephyr/audio/dmic.h>

Callback API to configure a DMIC device.

See dmic_configure() for argument descriptions.

◆ dmic_read_t

typedef int(* dmic_read_t) (const struct device *dev, uint8_t stream, void **buffer, size_t *size, int32_t timeout)

#include <zephyr/audio/dmic.h>

Callback API to read PCM data from a DMIC device.

See dmic_read() for argument descriptions.

◆ dmic_trigger_t

typedef int(* dmic_trigger_t) (const struct device *dev, enum dmic_trigger cmd)

#include <zephyr/audio/dmic.h>

Callback API to send a command to a DMIC device.

See dmic_trigger() for argument descriptions.