Audio Driver API Definitions. More...

Macros
#define	AUDIO_DRV_CONTROL_TX_ENABLE (1UL << 0)
	Enable Transmitter.

#define	AUDIO_DRV_CONTROL_RX_ENABLE (1UL << 1)
	Enable Receiver.

#define	AUDIO_DRV_CONTROL_TX_DISABLE (1UL << 2)
	Disable Transmitter.

#define	AUDIO_DRV_CONTROL_RX_DISABLE (1UL << 3)
	Disable Receiver.

#define	AUDIO_DRV_INTERFACE_RX (2U)
	Receiver.

#define	AUDIO_DRV_INTERFACE_TX (1U)
	Transmitter.

#define	AUDIO_DRV_OK (0)
	Operation succeeded.

#define	AUDIO_DRV_ERROR (-1)
	Unspecified error.

#define	AUDIO_DRV_ERROR_BUSY (-2)
	Driver is busy.

#define	AUDIO_DRV_ERROR_TIMEOUT (-3)
	Timeout occurred.

#define	AUDIO_DRV_ERROR_UNSUPPORTED (-4)
	Operation not supported.

#define	AUDIO_DRV_ERROR_PARAMETER (-5)
	Parameter error.

#define	AUDIO_DRV_EVENT_RX_DATA (1UL << 1)
	Data block received.

#define	AUDIO_DRV_EVENT_TX_DATA (1UL << 0)
	Data block transmitted.

Description

Audio Driver API Definitions.

Audio driver provides various definitions to simplify use of its Audio Driver API Functions :

Control parameter definitions (AUDIO_DRV_CONTROL_...) can be used in AudioDrv_Control function.
Interface definitions (AUDIO_DRV_INTERFACE_...) can be used in AudioDrv_Configure, AudioDrv_SetBuf functions.
Error codes definitions (AUDIO_DRV_OK,AUDIO_DRV_ERROR_...) map the status results that can be returned by Audio Driver API Functions.
Event definitions AUDIO_DRV_EVENT_... list the events that can be reported via callback function AudioDrv_Event_t.

Macro Definition Documentation

#define AUDIO_DRV_EVENT_RX_DATA (1UL << 1)

Data block received.

Triggered to indicate that all the data has been received. The driver is ready to receive next data block.

#define AUDIO_DRV_EVENT_TX_DATA (1UL << 0)

Data block transmitted.

Triggered to indicate that all the data has been sent (or queued in transmit buffers). The driver is ready for the next transmission.