[mirror_ubuntu-jammy-kernel.git] / include / sound / soc-dai.h

/* SPDX-License-Identifier: GPL-2.0
 *
 * linux/sound/soc-dai.h -- ALSA SoC Layer
 *
 * Copyright:	2005-2008 Wolfson Microelectronics. PLC.
 *
 * Digital Audio Interface (DAI) API.
 */

#ifndef __LINUX_SND_SOC_DAI_H
#define __LINUX_SND_SOC_DAI_H


#include <linux/list.h>
#include <sound/asoc.h>

struct snd_pcm_substream;
struct snd_soc_dapm_widget;
struct snd_compr_stream;

/*
 * DAI hardware audio formats.
 *
 * Describes the physical PCM data formating and clocking. Add new formats
 * to the end.
 */
#define SND_SOC_DAIFMT_I2S		SND_SOC_DAI_FORMAT_I2S
#define SND_SOC_DAIFMT_RIGHT_J		SND_SOC_DAI_FORMAT_RIGHT_J
#define SND_SOC_DAIFMT_LEFT_J		SND_SOC_DAI_FORMAT_LEFT_J
#define SND_SOC_DAIFMT_DSP_A		SND_SOC_DAI_FORMAT_DSP_A
#define SND_SOC_DAIFMT_DSP_B		SND_SOC_DAI_FORMAT_DSP_B
#define SND_SOC_DAIFMT_AC97		SND_SOC_DAI_FORMAT_AC97
#define SND_SOC_DAIFMT_PDM		SND_SOC_DAI_FORMAT_PDM

/* left and right justified also known as MSB and LSB respectively */
#define SND_SOC_DAIFMT_MSB		SND_SOC_DAIFMT_LEFT_J
#define SND_SOC_DAIFMT_LSB		SND_SOC_DAIFMT_RIGHT_J

/*
 * DAI Clock gating.
 *
 * DAI bit clocks can be gated (disabled) when the DAI is not
 * sending or receiving PCM data in a frame. This can be used to save power.
 */
#define SND_SOC_DAIFMT_CONT		(1 << 4) /* continuous clock */
#define SND_SOC_DAIFMT_GATED		(0 << 4) /* clock is gated */

/*
 * DAI hardware signal polarity.
 *
 * Specifies whether the DAI can also support inverted clocks for the specified
 * format.
 *
 * BCLK:
 * - "normal" polarity means signal is available at rising edge of BCLK
 * - "inverted" polarity means signal is available at falling edge of BCLK
 *
 * FSYNC "normal" polarity depends on the frame format:
 * - I2S: frame consists of left then right channel data. Left channel starts
 *      with falling FSYNC edge, right channel starts with rising FSYNC edge.
 * - Left/Right Justified: frame consists of left then right channel data.
 *      Left channel starts with rising FSYNC edge, right channel starts with
 *      falling FSYNC edge.
 * - DSP A/B: Frame starts with rising FSYNC edge.
 * - AC97: Frame starts with rising FSYNC edge.
 *
 * "Negative" FSYNC polarity is the one opposite of "normal" polarity.
 */
#define SND_SOC_DAIFMT_NB_NF		(0 << 8) /* normal bit clock + frame */
#define SND_SOC_DAIFMT_NB_IF		(2 << 8) /* normal BCLK + inv FRM */
#define SND_SOC_DAIFMT_IB_NF		(3 << 8) /* invert BCLK + nor FRM */
#define SND_SOC_DAIFMT_IB_IF		(4 << 8) /* invert BCLK + FRM */

/*
 * DAI hardware clock masters.
 *
 * This is wrt the codec, the inverse is true for the interface
 * i.e. if the codec is clk and FRM master then the interface is
 * clk and frame secondary.
 */
#define SND_SOC_DAIFMT_CBM_CFM		(1 << 12) /* codec clk & FRM master */
#define SND_SOC_DAIFMT_CBS_CFM		(2 << 12) /* codec clk secondary & FRM master */
#define SND_SOC_DAIFMT_CBM_CFS		(3 << 12) /* codec clk master & frame secondary */
#define SND_SOC_DAIFMT_CBS_CFS		(4 << 12) /* codec clk & FRM secondary */

#define SND_SOC_DAIFMT_FORMAT_MASK	0x000f
#define SND_SOC_DAIFMT_CLOCK_MASK	0x00f0
#define SND_SOC_DAIFMT_INV_MASK		0x0f00
#define SND_SOC_DAIFMT_MASTER_MASK	0xf000

/*
 * Master Clock Directions
 */
#define SND_SOC_CLOCK_IN		0
#define SND_SOC_CLOCK_OUT		1

#define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\
			       SNDRV_PCM_FMTBIT_S16_LE |\
			       SNDRV_PCM_FMTBIT_S16_BE |\
			       SNDRV_PCM_FMTBIT_S20_3LE |\
			       SNDRV_PCM_FMTBIT_S20_3BE |\
			       SNDRV_PCM_FMTBIT_S20_LE |\
			       SNDRV_PCM_FMTBIT_S20_BE |\
			       SNDRV_PCM_FMTBIT_S24_3LE |\
			       SNDRV_PCM_FMTBIT_S24_3BE |\
                               SNDRV_PCM_FMTBIT_S32_LE |\
                               SNDRV_PCM_FMTBIT_S32_BE)

struct snd_soc_dai_driver;
struct snd_soc_dai;
struct snd_ac97_bus_ops;

/* Digital Audio Interface clocking API.*/
int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
	unsigned int freq, int dir);

int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
	int div_id, int div);

int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
	int pll_id, int source, unsigned int freq_in, unsigned int freq_out);

int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio);

/* Digital Audio interface formatting */
int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);

int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
	unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);

int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
	unsigned int tx_num, unsigned int *tx_slot,
	unsigned int rx_num, unsigned int *rx_slot);

int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);

/* Digital Audio Interface mute */
int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
			     int direction);


int snd_soc_dai_get_channel_map(struct snd_soc_dai *dai,
		unsigned int *tx_num, unsigned int *tx_slot,
		unsigned int *rx_num, unsigned int *rx_slot);

int snd_soc_dai_is_dummy(struct snd_soc_dai *dai);

int snd_soc_dai_hw_params(struct snd_soc_dai *dai,
			  struct snd_pcm_substream *substream,
			  struct snd_pcm_hw_params *params);
void snd_soc_dai_hw_free(struct snd_soc_dai *dai,
			 struct snd_pcm_substream *substream);
int snd_soc_dai_startup(struct snd_soc_dai *dai,
			struct snd_pcm_substream *substream);
void snd_soc_dai_shutdown(struct snd_soc_dai *dai,
			  struct snd_pcm_substream *substream);
snd_pcm_sframes_t snd_soc_dai_delay(struct snd_soc_dai *dai,
				    struct snd_pcm_substream *substream);
void snd_soc_dai_suspend(struct snd_soc_dai *dai);
void snd_soc_dai_resume(struct snd_soc_dai *dai);
int snd_soc_dai_compress_new(struct snd_soc_dai *dai,
			     struct snd_soc_pcm_runtime *rtd, int num);
bool snd_soc_dai_stream_valid(struct snd_soc_dai *dai, int stream);
void snd_soc_dai_link_set_capabilities(struct snd_soc_dai_link *dai_link);
void snd_soc_dai_action(struct snd_soc_dai *dai,
			int stream, int action);
static inline void snd_soc_dai_activate(struct snd_soc_dai *dai,
					int stream)
{
	snd_soc_dai_action(dai, stream,  1);
}
static inline void snd_soc_dai_deactivate(struct snd_soc_dai *dai,
					  int stream)
{
	snd_soc_dai_action(dai, stream, -1);
}
int snd_soc_dai_active(struct snd_soc_dai *dai);

int snd_soc_pcm_dai_probe(struct snd_soc_pcm_runtime *rtd, int order);
int snd_soc_pcm_dai_remove(struct snd_soc_pcm_runtime *rtd, int order);
int snd_soc_pcm_dai_new(struct snd_soc_pcm_runtime *rtd);
int snd_soc_pcm_dai_prepare(struct snd_pcm_substream *substream);
int snd_soc_pcm_dai_trigger(struct snd_pcm_substream *substream, int cmd);
int snd_soc_pcm_dai_bespoke_trigger(struct snd_pcm_substream *substream,
				    int cmd);

int snd_soc_dai_compr_startup(struct snd_soc_dai *dai,
			      struct snd_compr_stream *cstream);
void snd_soc_dai_compr_shutdown(struct snd_soc_dai *dai,
				struct snd_compr_stream *cstream);
int snd_soc_dai_compr_trigger(struct snd_soc_dai *dai,
			      struct snd_compr_stream *cstream, int cmd);
int snd_soc_dai_compr_set_params(struct snd_soc_dai *dai,
				 struct snd_compr_stream *cstream,
				 struct snd_compr_params *params);
int snd_soc_dai_compr_get_params(struct snd_soc_dai *dai,
				 struct snd_compr_stream *cstream,
				 struct snd_codec *params);
int snd_soc_dai_compr_ack(struct snd_soc_dai *dai,
			  struct snd_compr_stream *cstream,
			  size_t bytes);
int snd_soc_dai_compr_pointer(struct snd_soc_dai *dai,
			      struct snd_compr_stream *cstream,
			      struct snd_compr_tstamp *tstamp);
int snd_soc_dai_compr_set_metadata(struct snd_soc_dai *dai,
				   struct snd_compr_stream *cstream,
				   struct snd_compr_metadata *metadata);
int snd_soc_dai_compr_get_metadata(struct snd_soc_dai *dai,
				   struct snd_compr_stream *cstream,
				   struct snd_compr_metadata *metadata);

struct snd_soc_dai_ops {
	/*
	 * DAI clocking configuration, all optional.
	 * Called by soc_card drivers, normally in their hw_params.
	 */
	int (*set_sysclk)(struct snd_soc_dai *dai,
		int clk_id, unsigned int freq, int dir);
	int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
		unsigned int freq_in, unsigned int freq_out);
	int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
	int (*set_bclk_ratio)(struct snd_soc_dai *dai, unsigned int ratio);

	/*
	 * DAI format configuration
	 * Called by soc_card drivers, normally in their hw_params.
	 */
	int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
	int (*xlate_tdm_slot_mask)(unsigned int slots,
		unsigned int *tx_mask, unsigned int *rx_mask);
	int (*set_tdm_slot)(struct snd_soc_dai *dai,
		unsigned int tx_mask, unsigned int rx_mask,
		int slots, int slot_width);
	int (*set_channel_map)(struct snd_soc_dai *dai,
		unsigned int tx_num, unsigned int *tx_slot,
		unsigned int rx_num, unsigned int *rx_slot);
	int (*get_channel_map)(struct snd_soc_dai *dai,
			unsigned int *tx_num, unsigned int *tx_slot,
			unsigned int *rx_num, unsigned int *rx_slot);
	int (*set_tristate)(struct snd_soc_dai *dai, int tristate);

	int (*set_sdw_stream)(struct snd_soc_dai *dai,
			void *stream, int direction);
	void *(*get_sdw_stream)(struct snd_soc_dai *dai, int direction);

	/*
	 * DAI digital mute - optional.
	 * Called by soc-core to minimise any pops.
	 */
	int (*mute_stream)(struct snd_soc_dai *dai, int mute, int stream);

	/*
	 * ALSA PCM audio operations - all optional.
	 * Called by soc-core during audio PCM operations.
	 */
	int (*startup)(struct snd_pcm_substream *,
		struct snd_soc_dai *);
	void (*shutdown)(struct snd_pcm_substream *,
		struct snd_soc_dai *);
	int (*hw_params)(struct snd_pcm_substream *,
		struct snd_pcm_hw_params *, struct snd_soc_dai *);
	int (*hw_free)(struct snd_pcm_substream *,
		struct snd_soc_dai *);
	int (*prepare)(struct snd_pcm_substream *,
		struct snd_soc_dai *);
	/*
	 * NOTE: Commands passed to the trigger function are not necessarily
	 * compatible with the current state of the dai. For example this
	 * sequence of commands is possible: START STOP STOP.
	 * So do not unconditionally use refcounting functions in the trigger
	 * function, e.g. clk_enable/disable.
	 */
	int (*trigger)(struct snd_pcm_substream *, int,
		struct snd_soc_dai *);
	int (*bespoke_trigger)(struct snd_pcm_substream *, int,
		struct snd_soc_dai *);
	/*
	 * For hardware based FIFO caused delay reporting.
	 * Optional.
	 */
	snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
		struct snd_soc_dai *);

	/* bit field */
	unsigned int no_capture_mute:1;
};

struct snd_soc_cdai_ops {
	/*
	 * for compress ops
	 */
	int (*startup)(struct snd_compr_stream *,
			struct snd_soc_dai *);
	int (*shutdown)(struct snd_compr_stream *,
			struct snd_soc_dai *);
	int (*set_params)(struct snd_compr_stream *,
			struct snd_compr_params *, struct snd_soc_dai *);
	int (*get_params)(struct snd_compr_stream *,
			struct snd_codec *, struct snd_soc_dai *);
	int (*set_metadata)(struct snd_compr_stream *,
			struct snd_compr_metadata *, struct snd_soc_dai *);
	int (*get_metadata)(struct snd_compr_stream *,
			struct snd_compr_metadata *, struct snd_soc_dai *);
	int (*trigger)(struct snd_compr_stream *, int,
			struct snd_soc_dai *);
	int (*pointer)(struct snd_compr_stream *,
			struct snd_compr_tstamp *, struct snd_soc_dai *);
	int (*ack)(struct snd_compr_stream *, size_t,
			struct snd_soc_dai *);
};

/*
 * Digital Audio Interface Driver.
 *
 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
 * operations and capabilities. Codec and platform drivers will register this
 * structure for every DAI they have.
 *
 * This structure covers the clocking, formating and ALSA operations for each
 * interface.
 */
struct snd_soc_dai_driver {
	/* DAI description */
	const char *name;
	unsigned int id;
	unsigned int base;
	struct snd_soc_dobj dobj;

	/* DAI driver callbacks */
	int (*probe)(struct snd_soc_dai *dai);
	int (*remove)(struct snd_soc_dai *dai);
	/* compress dai */
	int (*compress_new)(struct snd_soc_pcm_runtime *rtd, int num);
	/* Optional Callback used at pcm creation*/
	int (*pcm_new)(struct snd_soc_pcm_runtime *rtd,
		       struct snd_soc_dai *dai);

	/* ops */
	const struct snd_soc_dai_ops *ops;
	const struct snd_soc_cdai_ops *cops;

	/* DAI capabilities */
	struct snd_soc_pcm_stream capture;
	struct snd_soc_pcm_stream playback;
	unsigned int symmetric_rates:1;
	unsigned int symmetric_channels:1;
	unsigned int symmetric_samplebits:1;

	/* probe ordering - for components with runtime dependencies */
	int probe_order;
	int remove_order;
};

/*
 * Digital Audio Interface runtime data.
 *
 * Holds runtime data for a DAI.
 */
struct snd_soc_dai {
	const char *name;
	int id;
	struct device *dev;

	/* driver ops */
	struct snd_soc_dai_driver *driver;

	/* DAI runtime info */
	unsigned int stream_active[SNDRV_PCM_STREAM_LAST + 1]; /* usage count */

	struct snd_soc_dapm_widget *playback_widget;
	struct snd_soc_dapm_widget *capture_widget;

	/* DAI DMA data */
	void *playback_dma_data;
	void *capture_dma_data;

	/* Symmetry data - only valid if symmetry is being enforced */
	unsigned int rate;
	unsigned int channels;
	unsigned int sample_bits;

	/* parent platform/codec */
	struct snd_soc_component *component;

	/* CODEC TDM slot masks and params (for fixup) */
	unsigned int tx_mask;
	unsigned int rx_mask;

	struct list_head list;

	/* bit field */
	unsigned int probed:1;
};

static inline struct snd_soc_pcm_stream *
snd_soc_dai_get_pcm_stream(const struct snd_soc_dai *dai, int stream)
{
	return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
		&dai->driver->playback : &dai->driver->capture;
}

static inline
struct snd_soc_dapm_widget *snd_soc_dai_get_widget(
	struct snd_soc_dai *dai, int stream)
{
	return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
		dai->playback_widget : dai->capture_widget;
}

static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
					     const struct snd_pcm_substream *ss)
{
	return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
		dai->playback_dma_data : dai->capture_dma_data;
}

static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
					    const struct snd_pcm_substream *ss,
					    void *data)
{
	if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
		dai->playback_dma_data = data;
	else
		dai->capture_dma_data = data;
}

static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai,
					     void *playback, void *capture)
{
	dai->playback_dma_data = playback;
	dai->capture_dma_data = capture;
}

static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
		void *data)
{
	dev_set_drvdata(dai->dev, data);
}

static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
{
	return dev_get_drvdata(dai->dev);
}

/**
 * snd_soc_dai_set_sdw_stream() - Configures a DAI for SDW stream operation
 * @dai: DAI
 * @stream: STREAM
 * @direction: Stream direction(Playback/Capture)
 * SoundWire subsystem doesn't have a notion of direction and we reuse
 * the ASoC stream direction to configure sink/source ports.
 * Playback maps to source ports and Capture for sink ports.
 *
 * This should be invoked with NULL to clear the stream set previously.
 * Returns 0 on success, a negative error code otherwise.
 */
static inline int snd_soc_dai_set_sdw_stream(struct snd_soc_dai *dai,
				void *stream, int direction)
{
	if (dai->driver->ops->set_sdw_stream)
		return dai->driver->ops->set_sdw_stream(dai, stream, direction);
	else
		return -ENOTSUPP;
}

/**
 * snd_soc_dai_get_sdw_stream() - Retrieves SDW stream from DAI
 * @dai: DAI
 * @direction: Stream direction(Playback/Capture)
 *
 * This routine only retrieves that was previously configured
 * with snd_soc_dai_get_sdw_stream()
 *
 * Returns pointer to stream or -ENOTSUPP if callback is not supported;
 */
static inline void *snd_soc_dai_get_sdw_stream(struct snd_soc_dai *dai,
					       int direction)
{
	if (dai->driver->ops->get_sdw_stream)
		return dai->driver->ops->get_sdw_stream(dai, direction);
	else
		return ERR_PTR(-ENOTSUPP);
}

static inline unsigned int
snd_soc_dai_stream_active(struct snd_soc_dai *dai, int stream)
{
	return dai->stream_active[stream];
}

#endif
Commit	Line	Data
e2cfd2c9 KM	1	/* SPDX-License-Identifier: GPL-2.0
e2cfd2c9 KM	2	*
a47cbe72 MB	3	* linux/sound/soc-dai.h -- ALSA SoC Layer
	4	*
	5	* Copyright: 2005-2008 Wolfson Microelectronics. PLC.
	6	*
a47cbe72 MB	7	* Digital Audio Interface (DAI) API.
	8	*/
	9
	10	#ifndef __LINUX_SND_SOC_DAI_H
	11	#define __LINUX_SND_SOC_DAI_H
	12
	13
	14	#include <linux/list.h>
d2e3cb85	15	#include <sound/asoc.h>
a47cbe72 MB	16
a47cbe72 MB	17	struct snd_pcm_substream;
888df395	18	struct snd_soc_dapm_widget;
49681077	19	struct snd_compr_stream;
a47cbe72 MB	20
	21	/*
	22	* DAI hardware audio formats.
	23	*
	24	* Describes the physical PCM data formating and clocking. Add new formats
	25	* to the end.
	26	*/
d2e3cb85 ML	27	#define SND_SOC_DAIFMT_I2S SND_SOC_DAI_FORMAT_I2S
	28	#define SND_SOC_DAIFMT_RIGHT_J SND_SOC_DAI_FORMAT_RIGHT_J
	29	#define SND_SOC_DAIFMT_LEFT_J SND_SOC_DAI_FORMAT_LEFT_J
	30	#define SND_SOC_DAIFMT_DSP_A SND_SOC_DAI_FORMAT_DSP_A
	31	#define SND_SOC_DAIFMT_DSP_B SND_SOC_DAI_FORMAT_DSP_B
	32	#define SND_SOC_DAIFMT_AC97 SND_SOC_DAI_FORMAT_AC97
	33	#define SND_SOC_DAIFMT_PDM SND_SOC_DAI_FORMAT_PDM
a47cbe72 MB	34
	35	/* left and right justified also known as MSB and LSB respectively */
	36	#define SND_SOC_DAIFMT_MSB SND_SOC_DAIFMT_LEFT_J
	37	#define SND_SOC_DAIFMT_LSB SND_SOC_DAIFMT_RIGHT_J
	38
	39	/*
	40	* DAI Clock gating.
	41	*
fc926a7c	42	* DAI bit clocks can be gated (disabled) when the DAI is not
a47cbe72 MB	43	* sending or receiving PCM data in a frame. This can be used to save power.
a47cbe72 MB	44	*/
75d9ac46	45	#define SND_SOC_DAIFMT_CONT (1 << 4) /* continuous clock */
eef28e10	46	#define SND_SOC_DAIFMT_GATED (0 << 4) /* clock is gated */
a47cbe72	47
a47cbe72	48	/*
1d387a3f	49	* DAI hardware signal polarity.
a47cbe72 MB	50	*
	51	* Specifies whether the DAI can also support inverted clocks for the specified
	52	* format.
1d387a3f AP	53	*
	54	* BCLK:
	55	* - "normal" polarity means signal is available at rising edge of BCLK
	56	* - "inverted" polarity means signal is available at falling edge of BCLK
	57	*
	58	* FSYNC "normal" polarity depends on the frame format:
	59	* - I2S: frame consists of left then right channel data. Left channel starts
	60	* with falling FSYNC edge, right channel starts with rising FSYNC edge.
	61	* - Left/Right Justified: frame consists of left then right channel data.
	62	* Left channel starts with rising FSYNC edge, right channel starts with
	63	* falling FSYNC edge.
	64	* - DSP A/B: Frame starts with rising FSYNC edge.
	65	* - AC97: Frame starts with rising FSYNC edge.
	66	*
	67	* "Negative" FSYNC polarity is the one opposite of "normal" polarity.
a47cbe72	68	*/
5d163336	69	#define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */
75d9ac46 MB	70	#define SND_SOC_DAIFMT_NB_IF (2 << 8) /* normal BCLK + inv FRM */
	71	#define SND_SOC_DAIFMT_IB_NF (3 << 8) /* invert BCLK + nor FRM */
	72	#define SND_SOC_DAIFMT_IB_IF (4 << 8) /* invert BCLK + FRM */
a47cbe72 MB	73
	74	/*
	75	* DAI hardware clock masters.
	76	*
	77	* This is wrt the codec, the inverse is true for the interface
47db8e89	78	* i.e. if the codec is clk and FRM master then the interface is
ca00e66c	79	* clk and frame secondary.
a47cbe72	80	*/
75d9ac46	81	#define SND_SOC_DAIFMT_CBM_CFM (1 << 12) /* codec clk & FRM master */
ca00e66c KM	82	#define SND_SOC_DAIFMT_CBS_CFM (2 << 12) /* codec clk secondary & FRM master */
	83	#define SND_SOC_DAIFMT_CBM_CFS (3 << 12) /* codec clk master & frame secondary */
	84	#define SND_SOC_DAIFMT_CBS_CFS (4 << 12) /* codec clk & FRM secondary */
a47cbe72 MB	85
	86	#define SND_SOC_DAIFMT_FORMAT_MASK 0x000f
	87	#define SND_SOC_DAIFMT_CLOCK_MASK 0x00f0
	88	#define SND_SOC_DAIFMT_INV_MASK 0x0f00
	89	#define SND_SOC_DAIFMT_MASTER_MASK 0xf000
	90
	91	/*
	92	* Master Clock Directions
	93	*/
	94	#define SND_SOC_CLOCK_IN 0
	95	#define SND_SOC_CLOCK_OUT 1
	96
8f738d58 MB	97	#define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 \|\
	98	SNDRV_PCM_FMTBIT_S16_LE \|\
	99	SNDRV_PCM_FMTBIT_S16_BE \|\
	100	SNDRV_PCM_FMTBIT_S20_3LE \|\
	101	SNDRV_PCM_FMTBIT_S20_3BE \|\
823dbb6e MS	102	SNDRV_PCM_FMTBIT_S20_LE \|\
823dbb6e MS	103	SNDRV_PCM_FMTBIT_S20_BE \|\
8f738d58 MB	104	SNDRV_PCM_FMTBIT_S24_3LE \|\
8f738d58 MB	105	SNDRV_PCM_FMTBIT_S24_3BE \|\
d34c4307 JS	106	SNDRV_PCM_FMTBIT_S32_LE \|\
d34c4307 JS	107	SNDRV_PCM_FMTBIT_S32_BE)
33f503c9	108
f0fba2ad	109	struct snd_soc_dai_driver;
a47cbe72 MB	110	struct snd_soc_dai;
	111	struct snd_ac97_bus_ops;
	112
	113	/* Digital Audio Interface clocking API.*/
	114	int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
	115	unsigned int freq, int dir);
	116
	117	int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
	118	int div_id, int div);
	119
	120	int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
85488037	121	int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
a47cbe72	122
e54cf76b LG	123	int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio);
e54cf76b LG	124
a47cbe72 MB	125	/* Digital Audio interface formatting */
	126	int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
	127
	128	int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
a5479e38	129	unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
a47cbe72	130
472df3cb BS	131	int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
	132	unsigned int tx_num, unsigned int *tx_slot,
	133	unsigned int rx_num, unsigned int *rx_slot);
	134
a47cbe72 MB	135	int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
	136
	137	/* Digital Audio Interface mute */
da18396f MB	138	int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
da18396f MB	139	int direction);
a47cbe72	140
467b061f SK	141
	142	int snd_soc_dai_get_channel_map(struct snd_soc_dai *dai,
	143	unsigned int tx_num, unsigned int tx_slot,
	144	unsigned int rx_num, unsigned int rx_slot);
	145
bece9e95 LG	146	int snd_soc_dai_is_dummy(struct snd_soc_dai *dai);
bece9e95 LG	147
aa6166c2 KM	148	int snd_soc_dai_hw_params(struct snd_soc_dai *dai,
	149	struct snd_pcm_substream *substream,
	150	struct snd_pcm_hw_params *params);
846faaed KM	151	void snd_soc_dai_hw_free(struct snd_soc_dai *dai,
846faaed KM	152	struct snd_pcm_substream *substream);
5a52a045 KM	153	int snd_soc_dai_startup(struct snd_soc_dai *dai,
5a52a045 KM	154	struct snd_pcm_substream *substream);
330fcb51 KM	155	void snd_soc_dai_shutdown(struct snd_soc_dai *dai,
330fcb51 KM	156	struct snd_pcm_substream *substream);
1dea80d4 KM	157	snd_pcm_sframes_t snd_soc_dai_delay(struct snd_soc_dai *dai,
1dea80d4 KM	158	struct snd_pcm_substream *substream);
e0f22622	159	void snd_soc_dai_suspend(struct snd_soc_dai *dai);
24b09d05	160	void snd_soc_dai_resume(struct snd_soc_dai *dai);
b423c420 KM	161	int snd_soc_dai_compress_new(struct snd_soc_dai *dai,
b423c420 KM	162	struct snd_soc_pcm_runtime *rtd, int num);
467fece8	163	bool snd_soc_dai_stream_valid(struct snd_soc_dai *dai, int stream);
25612477	164	void snd_soc_dai_link_set_capabilities(struct snd_soc_dai_link *dai_link);
dc829106 KM	165	void snd_soc_dai_action(struct snd_soc_dai *dai,
	166	int stream, int action);
	167	static inline void snd_soc_dai_activate(struct snd_soc_dai *dai,
	168	int stream)
	169	{
	170	snd_soc_dai_action(dai, stream, 1);
	171	}
	172	static inline void snd_soc_dai_deactivate(struct snd_soc_dai *dai,
	173	int stream)
	174	{
	175	snd_soc_dai_action(dai, stream, -1);
	176	}
efffd9b3	177	int snd_soc_dai_active(struct snd_soc_dai *dai);
aa6166c2	178
51801aea	179	int snd_soc_pcm_dai_probe(struct snd_soc_pcm_runtime *rtd, int order);
7eaa313b	180	int snd_soc_pcm_dai_remove(struct snd_soc_pcm_runtime *rtd, int order);
0b73ba55	181	int snd_soc_pcm_dai_new(struct snd_soc_pcm_runtime *rtd);
d108c7fd	182	int snd_soc_pcm_dai_prepare(struct snd_pcm_substream *substream);
42f2472d	183	int snd_soc_pcm_dai_trigger(struct snd_pcm_substream *substream, int cmd);
30819358 KM	184	int snd_soc_pcm_dai_bespoke_trigger(struct snd_pcm_substream *substream,
30819358 KM	185	int cmd);
0b73ba55	186
b5ae4cce KM	187	int snd_soc_dai_compr_startup(struct snd_soc_dai *dai,
b5ae4cce KM	188	struct snd_compr_stream *cstream);
2b25f81d KM	189	void snd_soc_dai_compr_shutdown(struct snd_soc_dai *dai,
2b25f81d KM	190	struct snd_compr_stream *cstream);
eb08411b KM	191	int snd_soc_dai_compr_trigger(struct snd_soc_dai *dai,
eb08411b KM	192	struct snd_compr_stream *cstream, int cmd);
8dfedafb KM	193	int snd_soc_dai_compr_set_params(struct snd_soc_dai *dai,
	194	struct snd_compr_stream *cstream,
	195	struct snd_compr_params *params);
adbef543 KM	196	int snd_soc_dai_compr_get_params(struct snd_soc_dai *dai,
	197	struct snd_compr_stream *cstream,
	198	struct snd_codec *params);
53294353 KM	199	int snd_soc_dai_compr_ack(struct snd_soc_dai *dai,
	200	struct snd_compr_stream *cstream,
	201	size_t bytes);
ed38cc59 KM	202	int snd_soc_dai_compr_pointer(struct snd_soc_dai *dai,
	203	struct snd_compr_stream *cstream,
	204	struct snd_compr_tstamp *tstamp);
88b3a7df KM	205	int snd_soc_dai_compr_set_metadata(struct snd_soc_dai *dai,
	206	struct snd_compr_stream *cstream,
	207	struct snd_compr_metadata *metadata);
94d72819 KM	208	int snd_soc_dai_compr_get_metadata(struct snd_soc_dai *dai,
	209	struct snd_compr_stream *cstream,
	210	struct snd_compr_metadata *metadata);
b5ae4cce	211
a47cbe72 MB	212	struct snd_soc_dai_ops {
	213	/*
	214	* DAI clocking configuration, all optional.
	215	* Called by soc_card drivers, normally in their hw_params.
	216	*/
	217	int (set_sysclk)(struct snd_soc_dai dai,
	218	int clk_id, unsigned int freq, int dir);
85488037 MB	219	int (set_pll)(struct snd_soc_dai dai, int pll_id, int source,
85488037 MB	220	unsigned int freq_in, unsigned int freq_out);
a47cbe72	221	int (set_clkdiv)(struct snd_soc_dai dai, int div_id, int div);
e54cf76b	222	int (set_bclk_ratio)(struct snd_soc_dai dai, unsigned int ratio);
a47cbe72 MB	223
	224	/*
	225	* DAI format configuration
	226	* Called by soc_card drivers, normally in their hw_params.
	227	*/
	228	int (set_fmt)(struct snd_soc_dai dai, unsigned int fmt);
e5c21514	229	int (*xlate_tdm_slot_mask)(unsigned int slots,
89c67857	230	unsigned int tx_mask, unsigned int rx_mask);
a47cbe72	231	int (set_tdm_slot)(struct snd_soc_dai dai,
a5479e38 DR	232	unsigned int tx_mask, unsigned int rx_mask,
a5479e38 DR	233	int slots, int slot_width);
472df3cb BS	234	int (set_channel_map)(struct snd_soc_dai dai,
	235	unsigned int tx_num, unsigned int *tx_slot,
	236	unsigned int rx_num, unsigned int *rx_slot);
467b061f SK	237	int (get_channel_map)(struct snd_soc_dai dai,
	238	unsigned int tx_num, unsigned int tx_slot,
	239	unsigned int rx_num, unsigned int rx_slot);
a47cbe72 MB	240	int (set_tristate)(struct snd_soc_dai dai, int tristate);
a47cbe72 MB	241
97349b60 SN	242	int (set_sdw_stream)(struct snd_soc_dai dai,
97349b60 SN	243	void *stream, int direction);
36d73c4a PLB	244	void (get_sdw_stream)(struct snd_soc_dai *dai, int direction);
36d73c4a PLB	245
a47cbe72 MB	246	/*
	247	* DAI digital mute - optional.
	248	* Called by soc-core to minimise any pops.
	249	*/
da18396f	250	int (mute_stream)(struct snd_soc_dai dai, int mute, int stream);
dee89c4d MB	251
	252	/*
	253	* ALSA PCM audio operations - all optional.
	254	* Called by soc-core during audio PCM operations.
	255	*/
	256	int (startup)(struct snd_pcm_substream ,
	257	struct snd_soc_dai *);
	258	void (shutdown)(struct snd_pcm_substream ,
	259	struct snd_soc_dai *);
	260	int (hw_params)(struct snd_pcm_substream ,
	261	struct snd_pcm_hw_params , struct snd_soc_dai );
	262	int (hw_free)(struct snd_pcm_substream ,
	263	struct snd_soc_dai *);
	264	int (prepare)(struct snd_pcm_substream ,
	265	struct snd_soc_dai *);
9f1614aa MP	266	/*
	267	* NOTE: Commands passed to the trigger function are not necessarily
	268	* compatible with the current state of the dai. For example this
	269	* sequence of commands is possible: START STOP STOP.
	270	* So do not unconditionally use refcounting functions in the trigger
	271	* function, e.g. clk_enable/disable.
	272	*/
dee89c4d MB	273	int (trigger)(struct snd_pcm_substream , int,
dee89c4d MB	274	struct snd_soc_dai *);
07bf84aa LG	275	int (bespoke_trigger)(struct snd_pcm_substream , int,
07bf84aa LG	276	struct snd_soc_dai *);
258020d0 PU	277	/*
	278	* For hardware based FIFO caused delay reporting.
	279	* Optional.
	280	*/
	281	snd_pcm_sframes_t (delay)(struct snd_pcm_substream ,
	282	struct snd_soc_dai *);
350d9935 KM	283
	284	/* bit field */
	285	unsigned int no_capture_mute:1;
a47cbe72 MB	286	};
a47cbe72 MB	287
2e622ae4 VK	288	struct snd_soc_cdai_ops {
	289	/*
	290	* for compress ops
	291	*/
	292	int (startup)(struct snd_compr_stream ,
	293	struct snd_soc_dai *);
	294	int (shutdown)(struct snd_compr_stream ,
	295	struct snd_soc_dai *);
	296	int (set_params)(struct snd_compr_stream ,
	297	struct snd_compr_params , struct snd_soc_dai );
	298	int (get_params)(struct snd_compr_stream ,
	299	struct snd_codec , struct snd_soc_dai );
	300	int (set_metadata)(struct snd_compr_stream ,
	301	struct snd_compr_metadata , struct snd_soc_dai );
	302	int (get_metadata)(struct snd_compr_stream ,
	303	struct snd_compr_metadata , struct snd_soc_dai );
	304	int (trigger)(struct snd_compr_stream , int,
	305	struct snd_soc_dai *);
	306	int (pointer)(struct snd_compr_stream ,
	307	struct snd_compr_tstamp , struct snd_soc_dai );
	308	int (ack)(struct snd_compr_stream , size_t,
	309	struct snd_soc_dai *);
	310	};
	311
a47cbe72	312	/*
f0fba2ad	313	* Digital Audio Interface Driver.
a47cbe72	314	*
f0fba2ad LG	315	* Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
	316	* operations and capabilities. Codec and platform drivers will register this
	317	* structure for every DAI they have.
	318	*
	319	* This structure covers the clocking, formating and ALSA operations for each
	320	* interface.
a47cbe72	321	*/
f0fba2ad	322	struct snd_soc_dai_driver {
a47cbe72	323	/* DAI description */
f0fba2ad	324	const char *name;
a47cbe72	325	unsigned int id;
62368294	326	unsigned int base;
68003e6c	327	struct snd_soc_dobj dobj;
a47cbe72	328
f0fba2ad LG	329	/* DAI driver callbacks */
	330	int (probe)(struct snd_soc_dai dai);
	331	int (remove)(struct snd_soc_dai dai);
49681077	332	/* compress dai */
6f0c4226	333	int (compress_new)(struct snd_soc_pcm_runtime rtd, int num);
25f7b701 AP	334	/* Optional Callback used at pcm creation*/
	335	int (pcm_new)(struct snd_soc_pcm_runtime rtd,
	336	struct snd_soc_dai *dai);
a47cbe72 MB	337
a47cbe72 MB	338	/* ops */
1ee46ebd	339	const struct snd_soc_dai_ops *ops;
2e622ae4	340	const struct snd_soc_cdai_ops *cops;
a47cbe72 MB	341
	342	/* DAI capabilities */
	343	struct snd_soc_pcm_stream capture;
	344	struct snd_soc_pcm_stream playback;
06f409d7	345	unsigned int symmetric_rates:1;
3635bf09 NC	346	unsigned int symmetric_channels:1;
3635bf09 NC	347	unsigned int symmetric_samplebits:1;
0168bf0d LG	348
	349	/* probe ordering - for components with runtime dependencies */
	350	int probe_order;
	351	int remove_order;
f0fba2ad LG	352	};
	353
	354	/*
	355	* Digital Audio Interface runtime data.
	356	*
	357	* Holds runtime data for a DAI.
	358	*/
	359	struct snd_soc_dai {
	360	const char *name;
	361	int id;
	362	struct device *dev;
f0fba2ad LG	363
	364	/* driver ops */
	365	struct snd_soc_dai_driver *driver;
a47cbe72 MB	366
a47cbe72 MB	367	/* DAI runtime info */
0f6011fd	368	unsigned int stream_active[SNDRV_PCM_STREAM_LAST + 1]; /* usage count */
39b2238e	369
888df395 MB	370	struct snd_soc_dapm_widget *playback_widget;
	371	struct snd_soc_dapm_widget *capture_widget;
	372
f0fba2ad LG	373	/* DAI DMA data */
	374	void *playback_dma_data;
	375	void *capture_dma_data;
a47cbe72	376
17841020 DA	377	/* Symmetry data - only valid if symmetry is being enforced */
17841020 DA	378	unsigned int rate;
3635bf09 NC	379	unsigned int channels;
3635bf09 NC	380	unsigned int sample_bits;
17841020	381
f0fba2ad	382	/* parent platform/codec */
6106d129	383	struct snd_soc_component *component;
2466ab97	384
88bd870f BC	385	/* CODEC TDM slot masks and params (for fixup) */
	386	unsigned int tx_mask;
	387	unsigned int rx_mask;
	388
a47cbe72	389	struct list_head list;
b56be800 KM	390
	391	/* bit field */
	392	unsigned int probed:1;
a47cbe72 MB	393	};
a47cbe72 MB	394
acf253c1 KM	395	static inline struct snd_soc_pcm_stream *
	396	snd_soc_dai_get_pcm_stream(const struct snd_soc_dai *dai, int stream)
	397	{
	398	return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
	399	&dai->driver->playback : &dai->driver->capture;
	400	}
	401
0c01f6ca KM	402	static inline
	403	struct snd_soc_dapm_widget *snd_soc_dai_get_widget(
	404	struct snd_soc_dai *dai, int stream)
	405	{
	406	return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
	407	dai->playback_widget : dai->capture_widget;
	408	}
	409
fd23b7de DM	410	static inline void snd_soc_dai_get_dma_data(const struct snd_soc_dai dai,
	411	const struct snd_pcm_substream *ss)
	412	{
	413	return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
f0fba2ad	414	dai->playback_dma_data : dai->capture_dma_data;
fd23b7de DM	415	}
	416
	417	static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
	418	const struct snd_pcm_substream *ss,
	419	void *data)
	420	{
	421	if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
f0fba2ad	422	dai->playback_dma_data = data;
fd23b7de	423	else
f0fba2ad LG	424	dai->capture_dma_data = data;
	425	}
	426
ecfc0c04 MB	427	static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai,
	428	void playback, void capture)
	429	{
	430	dai->playback_dma_data = playback;
	431	dai->capture_dma_data = capture;
	432	}
	433
f0fba2ad LG	434	static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
	435	void *data)
	436	{
	437	dev_set_drvdata(dai->dev, data);
	438	}
	439
	440	static inline void snd_soc_dai_get_drvdata(struct snd_soc_dai dai)
	441	{
	442	return dev_get_drvdata(dai->dev);
fd23b7de DM	443	}
fd23b7de DM	444
97349b60 SN	445	/**
	446	* snd_soc_dai_set_sdw_stream() - Configures a DAI for SDW stream operation
	447	* @dai: DAI
	448	* @stream: STREAM
	449	* @direction: Stream direction(Playback/Capture)
	450	* SoundWire subsystem doesn't have a notion of direction and we reuse
	451	* the ASoC stream direction to configure sink/source ports.
	452	* Playback maps to source ports and Capture for sink ports.
	453	*
	454	* This should be invoked with NULL to clear the stream set previously.
	455	* Returns 0 on success, a negative error code otherwise.
	456	*/
	457	static inline int snd_soc_dai_set_sdw_stream(struct snd_soc_dai *dai,
	458	void *stream, int direction)
	459	{
	460	if (dai->driver->ops->set_sdw_stream)
	461	return dai->driver->ops->set_sdw_stream(dai, stream, direction);
	462	else
	463	return -ENOTSUPP;
	464	}
	465
36d73c4a PLB	466	/**
	467	* snd_soc_dai_get_sdw_stream() - Retrieves SDW stream from DAI
	468	* @dai: DAI
	469	* @direction: Stream direction(Playback/Capture)
	470	*
	471	* This routine only retrieves that was previously configured
	472	* with snd_soc_dai_get_sdw_stream()
	473	*
308811a3	474	* Returns pointer to stream or -ENOTSUPP if callback is not supported;
36d73c4a PLB	475	*/
	476	static inline void snd_soc_dai_get_sdw_stream(struct snd_soc_dai dai,
	477	int direction)
	478	{
	479	if (dai->driver->ops->get_sdw_stream)
	480	return dai->driver->ops->get_sdw_stream(dai, direction);
	481	else
308811a3	482	return ERR_PTR(-ENOTSUPP);
36d73c4a PLB	483	}
36d73c4a PLB	484
5552f8d7 KM	485	static inline unsigned int
	486	snd_soc_dai_stream_active(struct snd_soc_dai *dai, int stream)
	487	{
	488	return dai->stream_active[stream];
	489	}
	490
a47cbe72	491	#endif