Abstraction for audio codecs. More...

Data Structures
struct	pcm_config
	PCM configuration options. More...
union	audio_dai_cfg_t
	Digital Audio Interface Configuration. More...
struct	audio_codec_cfg
	Codec configuration parameters. More...
union	audio_property_value_t
	Codec property values. More...

Macros
#define	AUDIO_DAI_DIR_TX BIT(0)
	Transmit data.
#define	AUDIO_DAI_DIR_RX BIT(1)
	Receive data.
#define	AUDIO_DAI_DIR_TXRX (AUDIO_DAI_DIR_TX \| AUDIO_DAI_DIR_RX)
	Both receive and transmit data.

Typedefs
typedef uint8_t	audio_dai_dir_t
	DAI Direction Bitmap.
typedef void(*	audio_codec_error_callback_t) (const struct device *dev, uint32_t errors)
	Callback for error interrupt.
typedef void(*	audio_codec_tx_done_callback_t) (const struct device dev, void user_data)
	Callback for one frame(block memory) size data transmitted.
typedef void(*	audio_codec_rx_done_callback_t) (const struct device dev, uint8_t buf, uint32_t len, void *user_data)
	Callback for coming one frame size data.

Enumerations
enum	audio_pcm_rate_t { AUDIO_PCM_RATE_8K = 8000 , AUDIO_PCM_RATE_11P025K = 11025 , AUDIO_PCM_RATE_16K = 16000 , AUDIO_PCM_RATE_22P05K = 22050 , AUDIO_PCM_RATE_24K = 24000 , AUDIO_PCM_RATE_32K = 32000 , AUDIO_PCM_RATE_44P1K = 44100 , AUDIO_PCM_RATE_48K = 48000 , AUDIO_PCM_RATE_96K = 96000 , AUDIO_PCM_RATE_192K = 192000 }
	PCM audio sample rates. More...
enum	audio_pcm_width_t { AUDIO_PCM_WIDTH_16_BITS = 16 , AUDIO_PCM_WIDTH_20_BITS = 20 , AUDIO_PCM_WIDTH_24_BITS = 24 , AUDIO_PCM_WIDTH_32_BITS = 32 }
	PCM audio sample bit widths. More...
enum	audio_dai_type_t { AUDIO_DAI_TYPE_I2S , AUDIO_DAI_TYPE_LEFT_JUSTIFIED , AUDIO_DAI_TYPE_RIGHT_JUSTIFIED , AUDIO_DAI_TYPE_PCMA , AUDIO_DAI_TYPE_PCMB , AUDIO_DAI_TYPE_PCM , AUDIO_DAI_TYPE_INVALID }
	Digital Audio Interface (DAI) type. More...
enum	audio_property_t { AUDIO_PROPERTY_OUTPUT_VOLUME , AUDIO_PROPERTY_OUTPUT_MUTE , AUDIO_PROPERTY_INPUT_VOLUME , AUDIO_PROPERTY_INPUT_MUTE }
	Codec properties that can be set by audio_codec_set_property(). More...
enum	audio_channel_t { AUDIO_CHANNEL_FRONT_LEFT , AUDIO_CHANNEL_FRONT_RIGHT , AUDIO_CHANNEL_LFE , AUDIO_CHANNEL_FRONT_CENTER , AUDIO_CHANNEL_REAR_LEFT , AUDIO_CHANNEL_REAR_RIGHT , AUDIO_CHANNEL_REAR_CENTER , AUDIO_CHANNEL_SIDE_LEFT , AUDIO_CHANNEL_SIDE_RIGHT , AUDIO_CHANNEL_HEADPHONE_LEFT , AUDIO_CHANNEL_HEADPHONE_RIGHT , AUDIO_CHANNEL_ALL , AUDIO_CHANNEL_COMMON_COUNT , AUDIO_CHANNEL_PRIV_START = AUDIO_CHANNEL_COMMON_COUNT , AUDIO_CHANNEL_MAX = INT16_MAX }
	Audio channel identifiers to use in audio_codec_set_property(). More...
enum	audio_route_t { AUDIO_ROUTE_BYPASS , AUDIO_ROUTE_PLAYBACK , AUDIO_ROUTE_PLAYBACK_CAPTURE , AUDIO_ROUTE_CAPTURE }
enum	audio_codec_error_type { AUDIO_CODEC_ERROR_OVERCURRENT = (1UL << (0)) , AUDIO_CODEC_ERROR_OVERTEMPERATURE = (1UL << (1)) , AUDIO_CODEC_ERROR_UNDERVOLTAGE = (1UL << (2)) , AUDIO_CODEC_ERROR_OVERVOLTAGE = (1UL << (3)) , AUDIO_CODEC_ERROR_DC = (1UL << (4)) }
	Codec error type. More...

Functions
static int	audio_codec_configure (const struct device dev, struct audio_codec_cfg cfg)
	Configure the audio codec.
static void	audio_codec_start_output (const struct device *dev)
	Set codec to start output audio playback.
static void	audio_codec_stop_output (const struct device *dev)
	Set codec to stop output audio playback.
static int	audio_codec_set_property (const struct device *dev, audio_property_t property, audio_channel_t channel, audio_property_value_t val)
	Set a codec property defined by audio_property_t.
static int	audio_codec_apply_properties (const struct device *dev)
	Atomically apply any cached properties.
static int	audio_codec_clear_errors (const struct device *dev)
	Clear any codec errors.
static int	audio_codec_register_error_callback (const struct device *dev, audio_codec_error_callback_t cb)
	Register a callback function for codec error.
static int	audio_codec_route_input (const struct device *dev, audio_channel_t channel, uint32_t input)
	Sets up signal routing for a given input channel.
static int	audio_codec_route_output (const struct device *dev, audio_channel_t channel, uint32_t output)
	Sets up signal routing for a given output channel.
static int	audio_codec_start (const struct device *dev, audio_dai_dir_t dir)
	Set codec to start audio playback or capture.
static int	audio_codec_stop (const struct device *dev, audio_dai_dir_t dir)
	Set codec to stop audio playback or capture.
static int	audio_codec_write (const struct device dev, uint8_t data, size_t data_size)
	write one block size data for audio playback.
static int	audio_codec_register_done_callback (const struct device dev, audio_codec_tx_done_callback_t tx_cb, void tx_cb_user_data, audio_codec_rx_done_callback_t rx_cb, void *rx_cb_user_data)
	Register a callback function for codec one frame data tx/rx done.

Detailed Description

Abstraction for audio codecs.

Since: 1.13

Version: 0.2.0

Macro Definition Documentation

◆ AUDIO_DAI_DIR_RX

#define AUDIO_DAI_DIR_RX BIT(1)

#include <zephyr/audio/codec.h>

Receive data.

◆ AUDIO_DAI_DIR_TX

#define AUDIO_DAI_DIR_TX BIT(0)

#include <zephyr/audio/codec.h>

Transmit data.

◆ AUDIO_DAI_DIR_TXRX

#define AUDIO_DAI_DIR_TXRX (AUDIO_DAI_DIR_TX | AUDIO_DAI_DIR_RX)

#include <zephyr/audio/codec.h>

Both receive and transmit data.

Typedef Documentation

◆ audio_codec_error_callback_t

typedef void(* audio_codec_error_callback_t) (const struct device *dev, uint32_t errors)

#include <zephyr/audio/codec.h>

Callback for error interrupt.

Parameters

dev	Pointer to the codec device
errors	Device errors (bitmask of audio_codec_error_type values)

◆ audio_codec_rx_done_callback_t

typedef void(* audio_codec_rx_done_callback_t) (const struct device *dev, uint8_t *buf, uint32_t len, void *user_data)

#include <zephyr/audio/codec.h>

Callback for coming one frame size data.

Parameters

dev	Pointer to the codec device
buf	Pointer to received data
len	received data size in bytes
user_data	Pointer to user data

◆ audio_codec_tx_done_callback_t

typedef void(* audio_codec_tx_done_callback_t) (const struct device *dev, void *user_data)

#include <zephyr/audio/codec.h>

Callback for one frame(block memory) size data transmitted.

Parameters

dev	Pointer to the codec device
user_data	Pointer to user data

◆ audio_dai_dir_t

typedef uint8_t audio_dai_dir_t

#include <zephyr/audio/codec.h>

DAI Direction Bitmap.

Enumeration Type Documentation

◆ audio_channel_t

enum audio_channel_t

#include <zephyr/audio/codec.h>

Audio channel identifiers to use in audio_codec_set_property().

Enumerator
AUDIO_CHANNEL_FRONT_LEFT	Front left channel.
AUDIO_CHANNEL_FRONT_RIGHT	Front right channel.
AUDIO_CHANNEL_LFE	Low frequency effect channel.
AUDIO_CHANNEL_FRONT_CENTER	Front center channel.
AUDIO_CHANNEL_REAR_LEFT	Rear left channel.
AUDIO_CHANNEL_REAR_RIGHT	Rear right channel.
AUDIO_CHANNEL_REAR_CENTER	Rear center channel.
AUDIO_CHANNEL_SIDE_LEFT	Side left channel.
AUDIO_CHANNEL_SIDE_RIGHT	Side right channel.
AUDIO_CHANNEL_HEADPHONE_LEFT	Headphone left.
AUDIO_CHANNEL_HEADPHONE_RIGHT	Headphone right.
AUDIO_CHANNEL_ALL	All channels.
AUDIO_CHANNEL_COMMON_COUNT	Number of all common channel identifiers.
AUDIO_CHANNEL_PRIV_START	This and higher values are codec specific. Refer to the codec's header file.
AUDIO_CHANNEL_MAX	Maximum value describing an audio codec channel identifier.

◆ audio_codec_error_type

enum audio_codec_error_type

#include <zephyr/audio/codec.h>

Codec error type.

Enumerator
AUDIO_CODEC_ERROR_OVERCURRENT	Output over-current.
AUDIO_CODEC_ERROR_OVERTEMPERATURE	Codec over-temperature.
AUDIO_CODEC_ERROR_UNDERVOLTAGE	Power low voltage.
AUDIO_CODEC_ERROR_OVERVOLTAGE	Power high voltage.
AUDIO_CODEC_ERROR_DC	Output direct-current.

◆ audio_dai_type_t

enum audio_dai_type_t

#include <zephyr/audio/codec.h>

Digital Audio Interface (DAI) type.

Enumerator
AUDIO_DAI_TYPE_I2S	I2S Interface.
AUDIO_DAI_TYPE_LEFT_JUSTIFIED	I2S Interface, left justified.
AUDIO_DAI_TYPE_RIGHT_JUSTIFIED	I2S Interface, right justified.
AUDIO_DAI_TYPE_PCMA	PCM Interface, variant A.
AUDIO_DAI_TYPE_PCMB	PCM Interface, variant B.
AUDIO_DAI_TYPE_PCM	PCM Interface.
AUDIO_DAI_TYPE_INVALID	Other interfaces can be added here.

◆ audio_pcm_rate_t

enum audio_pcm_rate_t

#include <zephyr/audio/codec.h>

PCM audio sample rates.

Enumerator
AUDIO_PCM_RATE_8K	8 kHz sample rate
AUDIO_PCM_RATE_11P025K	11.025 kHz sample rate
AUDIO_PCM_RATE_16K	16 kHz sample rate
AUDIO_PCM_RATE_22P05K	22.05 kHz sample rate
AUDIO_PCM_RATE_24K	24 kHz sample rate
AUDIO_PCM_RATE_32K	32 kHz sample rate
AUDIO_PCM_RATE_44P1K	44.1 kHz sample rate
AUDIO_PCM_RATE_48K	48 kHz sample rate
AUDIO_PCM_RATE_96K	96 kHz sample rate
AUDIO_PCM_RATE_192K	192 kHz sample rate

◆ audio_pcm_width_t

enum audio_pcm_width_t

#include <zephyr/audio/codec.h>

PCM audio sample bit widths.

Enumerator
AUDIO_PCM_WIDTH_16_BITS	16-bit sample width
AUDIO_PCM_WIDTH_20_BITS	20-bit sample width
AUDIO_PCM_WIDTH_24_BITS	24-bit sample width
AUDIO_PCM_WIDTH_32_BITS	32-bit sample width

◆ audio_property_t

enum audio_property_t

#include <zephyr/audio/codec.h>

Codec properties that can be set by audio_codec_set_property().

Enumerator
AUDIO_PROPERTY_OUTPUT_VOLUME	Output volume.
AUDIO_PROPERTY_OUTPUT_MUTE	Output mute/unmute.
AUDIO_PROPERTY_INPUT_VOLUME	Input volume.
AUDIO_PROPERTY_INPUT_MUTE	Input mute/unmute.

◆ audio_route_t

enum audio_route_t

#include <zephyr/audio/codec.h>

Enumerator
AUDIO_ROUTE_BYPASS
AUDIO_ROUTE_PLAYBACK
AUDIO_ROUTE_PLAYBACK_CAPTURE
AUDIO_ROUTE_CAPTURE

Function Documentation

◆ audio_codec_apply_properties()

int audio_codec_apply_properties ( const struct device * dev )

inlinestatic

#include <zephyr/audio/codec.h>

Atomically apply any cached properties.

Following one or more invocations of audio_codec_set_property, that may have been cached by the driver, audio_codec_apply_properties can be invoked to apply all the properties as atomic as possible

Parameters

dev	Pointer to the device structure for codec driver instance.

Returns: 0 on success, negative error code on failure

◆ audio_codec_clear_errors()

int audio_codec_clear_errors ( const struct device * dev )

inlinestatic

#include <zephyr/audio/codec.h>

Clear any codec errors.

Clear all codec errors. If an error interrupt exists, it will be de-asserted.

Parameters

dev	Pointer to the device structure for codec driver instance.

Returns: 0 on success, negative error code on failure

< Function not implemented

◆ audio_codec_configure()

int audio_codec_configure	(	const struct device *	dev,
		struct audio_codec_cfg *	cfg )

inlinestatic

#include <zephyr/audio/codec.h>

Configure the audio codec.

Configure the audio codec device according to the configuration parameters provided as input

Parameters

dev	Pointer to the device structure for codec driver instance.
cfg	Pointer to the structure containing the codec configuration.

Returns: 0 on success, negative error code on failure

◆ audio_codec_register_done_callback()

int audio_codec_register_done_callback	(	const struct device *	dev,
		audio_codec_tx_done_callback_t	tx_cb,
		void *	tx_cb_user_data,
		audio_codec_rx_done_callback_t	rx_cb,
		void *	rx_cb_user_data )

inlinestatic

#include <zephyr/audio/codec.h>

Register a callback function for codec one frame data tx/rx done.

The callback will be called from a DMA ISR (interrupt) context. Callbacks must therefore:

Be very short and avoid deep call stacks or large stack allocations, since the ISR stack is limited.
Do not sleep or block (do not wait on semaphores, mutexes, queues, etc.).
Only call APIs that are explicitly documented as IRQ/ISR-safe.
Avoid heavy processing or extensive logging; instead, defer such work to thread or workqueue context (for example, by submitting a work item).

Parameters

dev	Pointer to the audio codec device
tx_cb	The function that should be called when an DMA frame transmitted
tx_cb_user_data	The user data that will be passed to tx_cb
rx_cb	The function that should be called when an DMA frame received
rx_cb_user_data	The user data that will be passed to rx_cb

Returns: 0 if successful, negative errno code if failure.

< Function not implemented

◆ audio_codec_register_error_callback()

int audio_codec_register_error_callback	(	const struct device *	dev,
		audio_codec_error_callback_t	cb )

inlinestatic

#include <zephyr/audio/codec.h>

Register a callback function for codec error.

The callback will be called from a thread, so I2C or SPI operations are safe. However, the thread's stack is limited and defined by the driver. It is currently up to the caller to ensure that the callback does not overflow the stack.

Parameters

dev	Pointer to the audio codec device
cb	The function that should be called when an error is detected fires

Returns: 0 if successful, negative errno code if failure.

< Function not implemented

◆ audio_codec_route_input()

int audio_codec_route_input	(	const struct device *	dev,
		audio_channel_t	channel,
		uint32_t	input )

inlinestatic

#include <zephyr/audio/codec.h>

Sets up signal routing for a given input channel.

Some codecs can do input routing (multiplexing) from a chosen set of physical inputs. This function maps a given audio (stream) channel to a given physical input terminal.

Parameters

dev	Pointer to the audio codec device
channel	The channel to map
input	The input terminal index, codec-specific

Returns: 0 if successful, negative errno code if failure.

< Function not implemented

◆ audio_codec_route_output()

int audio_codec_route_output	(	const struct device *	dev,
		audio_channel_t	channel,
		uint32_t	output )

inlinestatic

#include <zephyr/audio/codec.h>

Sets up signal routing for a given output channel.

Some codecs can do output routing (multiplexing) from a chosen set of physical output. This function maps a given audio (stream) channel to a given physical output terminal.

Parameters

dev	Pointer to the audio codec device
channel	The channel to map
output	The output terminal index, codec-specific

Returns: 0 if successful, negative errno code if failure.

< Function not implemented

◆ audio_codec_set_property()

int audio_codec_set_property	(	const struct device *	dev,
		audio_property_t	property,
		audio_channel_t	channel,
		audio_property_value_t	val )

inlinestatic

#include <zephyr/audio/codec.h>

Set a codec property defined by audio_property_t.

Set a property such as volume level, clock configuration etc.

Parameters

dev	Pointer to the device structure for codec driver instance.
property	The codec property to set
channel	The audio channel for which the property has to be set
val	pointer to a property value of type audio_codec_property_value_t

Returns: 0 on success, negative error code on failure

◆ audio_codec_start()

int audio_codec_start	(	const struct device *	dev,
		audio_dai_dir_t	dir )

inlinestatic

#include <zephyr/audio/codec.h>

Set codec to start audio playback or capture.

Setup the audio codec device to start the audio playback or capture

Parameters

dev	Pointer to the device structure for codec driver instance.
dir	device audio playback and capture selection.

Returns: 0 if successful, negative errno code if failure.

< Function not implemented

◆ audio_codec_start_output()

void audio_codec_start_output ( const struct device * dev )

inlinestatic

#include <zephyr/audio/codec.h>

Set codec to start output audio playback.

Setup the audio codec device to start the audio playback

Parameters

dev	Pointer to the device structure for codec driver instance.

◆ audio_codec_stop()

int audio_codec_stop	(	const struct device *	dev,
		audio_dai_dir_t	dir )

inlinestatic

#include <zephyr/audio/codec.h>

Set codec to stop audio playback or capture.

Setup the audio codec device to stop the audio playback or capture.

Parameters

dev	Pointer to the device structure for codec driver instance.
dir	device audio playback and capture selection.

Returns: 0 if successful, negative errno code if failure.

< Function not implemented

◆ audio_codec_stop_output()

void audio_codec_stop_output ( const struct device * dev )

inlinestatic

#include <zephyr/audio/codec.h>

Set codec to stop output audio playback.

Setup the audio codec device to stop the audio playback

Parameters

dev	Pointer to the device structure for codec driver instance.

◆ audio_codec_write()

int audio_codec_write	(	const struct device *	dev,
		uint8_t *	data,
		size_t	data_size )

inlinestatic

#include <zephyr/audio/codec.h>

write one block size data for audio playback.

Write audio data to the device for audio playback without waiting for the data to be transmitted. This is a non-blocking API: the function returns as soon as the driver has accepted (or rejected) the buffer, not when the audio data has actually been played out.

Parameters

dev	Pointer to the device structure for codec driver instance.
data	Pointer to data.
data_size	data size in bytes.

Returns: 0 if successful, negative errno code if failure.

< Function not implemented

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ AUDIO_DAI_DIR_RX

◆ AUDIO_DAI_DIR_TX

◆ AUDIO_DAI_DIR_TXRX

Typedef Documentation

◆ audio_codec_error_callback_t

◆ audio_codec_rx_done_callback_t

◆ audio_codec_tx_done_callback_t

◆ audio_dai_dir_t

Enumeration Type Documentation

◆ audio_channel_t

◆ audio_codec_error_type

◆ audio_dai_type_t

◆ audio_pcm_rate_t

◆ audio_pcm_width_t

◆ audio_property_t

◆ audio_route_t

Function Documentation

◆ audio_codec_apply_properties()

◆ audio_codec_clear_errors()

◆ audio_codec_configure()

◆ audio_codec_register_done_callback()

◆ audio_codec_register_error_callback()

◆ audio_codec_route_input()

◆ audio_codec_route_output()

◆ audio_codec_set_property()

◆ audio_codec_start()

◆ audio_codec_start_output()

◆ audio_codec_stop()

◆ audio_codec_stop_output()

◆ audio_codec_write()