blob: 0dcb361a98bb34ec78f2bb4863419d9f94fc7670 [file] [log] [blame]
Kuninori Morimotoe2cfd2c2018-07-02 06:22:15 +00001/* SPDX-License-Identifier: GPL-2.0
2 *
Mark Browna47cbe72008-07-23 14:03:07 +01003 * linux/sound/soc-dai.h -- ALSA SoC Layer
4 *
5 * Copyright: 2005-2008 Wolfson Microelectronics. PLC.
6 *
Mark Browna47cbe72008-07-23 14:03:07 +01007 * 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>
Mengdong Lind2e3cb82016-09-29 14:09:14 +080015#include <sound/asoc.h>
Mark Browna47cbe72008-07-23 14:03:07 +010016
17struct snd_pcm_substream;
Mark Brown888df392012-02-16 19:37:51 -080018struct snd_soc_dapm_widget;
Vinod Koul49681072012-08-16 17:10:40 +053019struct snd_compr_stream;
Mark Browna47cbe72008-07-23 14:03:07 +010020
21/*
22 * DAI hardware audio formats.
23 *
24 * Describes the physical PCM data formating and clocking. Add new formats
25 * to the end.
26 */
Mengdong Lind2e3cb82016-09-29 14:09:14 +080027#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
Mark Browna47cbe72008-07-23 14:03:07 +010034
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
Kuninori Morimotoba9e82a2021-05-27 11:26:12 +090039/* Describes the possible PCM format */
40/*
41 * use SND_SOC_DAI_FORMAT_xx as eash shift.
42 * see
43 * snd_soc_runtime_get_dai_fmt()
44 */
45#define SND_SOC_POSSIBLE_DAIFMT_FORMAT_SHIFT 0
46#define SND_SOC_POSSIBLE_DAIFMT_FORMAT_MASK (0xFFFF << SND_SOC_POSSIBLE_DAIFMT_FORMAT_SHIFT)
47#define SND_SOC_POSSIBLE_DAIFMT_I2S (1 << SND_SOC_DAI_FORMAT_I2S)
48#define SND_SOC_POSSIBLE_DAIFMT_RIGHT_J (1 << SND_SOC_DAI_FORMAT_RIGHT_J)
49#define SND_SOC_POSSIBLE_DAIFMT_LEFT_J (1 << SND_SOC_DAI_FORMAT_LEFT_J)
50#define SND_SOC_POSSIBLE_DAIFMT_DSP_A (1 << SND_SOC_DAI_FORMAT_DSP_A)
51#define SND_SOC_POSSIBLE_DAIFMT_DSP_B (1 << SND_SOC_DAI_FORMAT_DSP_B)
52#define SND_SOC_POSSIBLE_DAIFMT_AC97 (1 << SND_SOC_DAI_FORMAT_AC97)
53#define SND_SOC_POSSIBLE_DAIFMT_PDM (1 << SND_SOC_DAI_FORMAT_PDM)
54
Mark Browna47cbe72008-07-23 14:03:07 +010055/*
56 * DAI Clock gating.
57 *
Randy Dunlapfc926a72020-07-18 17:33:07 -070058 * DAI bit clocks can be gated (disabled) when the DAI is not
Mark Browna47cbe72008-07-23 14:03:07 +010059 * sending or receiving PCM data in a frame. This can be used to save power.
60 */
Mark Brown75d9ac42011-09-27 16:41:01 +010061#define SND_SOC_DAIFMT_CONT (1 << 4) /* continuous clock */
Kuninori Morimotoeef28e102013-01-29 21:03:13 -080062#define SND_SOC_DAIFMT_GATED (0 << 4) /* clock is gated */
Mark Browna47cbe72008-07-23 14:03:07 +010063
Kuninori Morimotoba9e82a2021-05-27 11:26:12 +090064/* Describes the possible PCM format */
65/*
66 * define GATED -> CONT. GATED will be selected if both are selected.
67 * see
68 * snd_soc_runtime_get_dai_fmt()
69 */
70#define SND_SOC_POSSIBLE_DAIFMT_CLOCK_SHIFT 16
71#define SND_SOC_POSSIBLE_DAIFMT_CLOCK_MASK (0xFFFF << SND_SOC_POSSIBLE_DAIFMT_CLOCK_SHIFT)
72#define SND_SOC_POSSIBLE_DAIFMT_GATED (0x1ULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_SHIFT)
73#define SND_SOC_POSSIBLE_DAIFMT_CONT (0x2ULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_SHIFT)
74
Mark Browna47cbe72008-07-23 14:03:07 +010075/*
Anatol Pomozov1d387a32015-10-08 09:37:51 -070076 * DAI hardware signal polarity.
Mark Browna47cbe72008-07-23 14:03:07 +010077 *
78 * Specifies whether the DAI can also support inverted clocks for the specified
79 * format.
Anatol Pomozov1d387a32015-10-08 09:37:51 -070080 *
81 * BCLK:
82 * - "normal" polarity means signal is available at rising edge of BCLK
83 * - "inverted" polarity means signal is available at falling edge of BCLK
84 *
85 * FSYNC "normal" polarity depends on the frame format:
86 * - I2S: frame consists of left then right channel data. Left channel starts
87 * with falling FSYNC edge, right channel starts with rising FSYNC edge.
88 * - Left/Right Justified: frame consists of left then right channel data.
89 * Left channel starts with rising FSYNC edge, right channel starts with
90 * falling FSYNC edge.
91 * - DSP A/B: Frame starts with rising FSYNC edge.
92 * - AC97: Frame starts with rising FSYNC edge.
93 *
94 * "Negative" FSYNC polarity is the one opposite of "normal" polarity.
Mark Browna47cbe72008-07-23 14:03:07 +010095 */
Kuninori Morimoto5d163332013-01-15 20:18:23 -080096#define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */
Mark Brown75d9ac42011-09-27 16:41:01 +010097#define SND_SOC_DAIFMT_NB_IF (2 << 8) /* normal BCLK + inv FRM */
98#define SND_SOC_DAIFMT_IB_NF (3 << 8) /* invert BCLK + nor FRM */
99#define SND_SOC_DAIFMT_IB_IF (4 << 8) /* invert BCLK + FRM */
Mark Browna47cbe72008-07-23 14:03:07 +0100100
Kuninori Morimotoba9e82a2021-05-27 11:26:12 +0900101/* Describes the possible PCM format */
102#define SND_SOC_POSSIBLE_DAIFMT_INV_SHIFT 32
103#define SND_SOC_POSSIBLE_DAIFMT_INV_MASK (0xFFFFULL << SND_SOC_POSSIBLE_DAIFMT_INV_SHIFT)
104#define SND_SOC_POSSIBLE_DAIFMT_NB_NF (0x1ULL << SND_SOC_POSSIBLE_DAIFMT_INV_SHIFT)
105#define SND_SOC_POSSIBLE_DAIFMT_NB_IF (0x2ULL << SND_SOC_POSSIBLE_DAIFMT_INV_SHIFT)
106#define SND_SOC_POSSIBLE_DAIFMT_IB_NF (0x4ULL << SND_SOC_POSSIBLE_DAIFMT_INV_SHIFT)
107#define SND_SOC_POSSIBLE_DAIFMT_IB_IF (0x8ULL << SND_SOC_POSSIBLE_DAIFMT_INV_SHIFT)
108
Mark Browna47cbe72008-07-23 14:03:07 +0100109/*
Pierre-Louis Bossartf026c122020-11-12 10:30:57 -0600110 * DAI hardware clock providers/consumers
Mark Browna47cbe72008-07-23 14:03:07 +0100111 *
112 * This is wrt the codec, the inverse is true for the interface
Pierre-Louis Bossartf026c122020-11-12 10:30:57 -0600113 * i.e. if the codec is clk and FRM provider then the interface is
114 * clk and frame consumer.
Mark Browna47cbe72008-07-23 14:03:07 +0100115 */
Pierre-Louis Bossartf026c122020-11-12 10:30:57 -0600116#define SND_SOC_DAIFMT_CBP_CFP (1 << 12) /* codec clk provider & frame provider */
117#define SND_SOC_DAIFMT_CBC_CFP (2 << 12) /* codec clk consumer & frame provider */
118#define SND_SOC_DAIFMT_CBP_CFC (3 << 12) /* codec clk provider & frame consumer */
Kuninori Morimoto47c11312021-05-12 08:09:08 +0900119#define SND_SOC_DAIFMT_CBC_CFC (4 << 12) /* codec clk consumer & frame consumer */
Mark Browna47cbe72008-07-23 14:03:07 +0100120
Pierre-Louis Bossartf026c122020-11-12 10:30:57 -0600121/* previous definitions kept for backwards-compatibility, do not use in new contributions */
122#define SND_SOC_DAIFMT_CBM_CFM SND_SOC_DAIFMT_CBP_CFP
123#define SND_SOC_DAIFMT_CBS_CFM SND_SOC_DAIFMT_CBC_CFP
124#define SND_SOC_DAIFMT_CBM_CFS SND_SOC_DAIFMT_CBP_CFC
125#define SND_SOC_DAIFMT_CBS_CFS SND_SOC_DAIFMT_CBC_CFC
126
Kuninori Morimotoba9e82a2021-05-27 11:26:12 +0900127/* Describes the possible PCM format */
128#define SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT 48
129#define SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_MASK (0xFFFFULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
130#define SND_SOC_POSSIBLE_DAIFMT_CBP_CFP (0x1ULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
131#define SND_SOC_POSSIBLE_DAIFMT_CBC_CFP (0x2ULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
132#define SND_SOC_POSSIBLE_DAIFMT_CBP_CFC (0x4ULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
133#define SND_SOC_POSSIBLE_DAIFMT_CBC_CFC (0x8ULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
134
Pierre-Louis Bossartf026c122020-11-12 10:30:57 -0600135#define SND_SOC_DAIFMT_FORMAT_MASK 0x000f
136#define SND_SOC_DAIFMT_CLOCK_MASK 0x00f0
137#define SND_SOC_DAIFMT_INV_MASK 0x0f00
138#define SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK 0xf000
139
140#define SND_SOC_DAIFMT_MASTER_MASK SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK
Mark Browna47cbe72008-07-23 14:03:07 +0100141
142/*
143 * Master Clock Directions
144 */
145#define SND_SOC_CLOCK_IN 0
146#define SND_SOC_CLOCK_OUT 1
147
Mark Brown8f738d52009-08-09 20:08:31 +0100148#define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\
149 SNDRV_PCM_FMTBIT_S16_LE |\
150 SNDRV_PCM_FMTBIT_S16_BE |\
151 SNDRV_PCM_FMTBIT_S20_3LE |\
152 SNDRV_PCM_FMTBIT_S20_3BE |\
Maciej S. Szmigiero823dbb62017-11-27 23:33:29 +0100153 SNDRV_PCM_FMTBIT_S20_LE |\
154 SNDRV_PCM_FMTBIT_S20_BE |\
Mark Brown8f738d52009-08-09 20:08:31 +0100155 SNDRV_PCM_FMTBIT_S24_3LE |\
156 SNDRV_PCM_FMTBIT_S24_3BE |\
Jon Smirld34c4302009-05-13 21:59:14 -0400157 SNDRV_PCM_FMTBIT_S32_LE |\
158 SNDRV_PCM_FMTBIT_S32_BE)
Mark Brown33f503c2009-05-02 12:24:55 +0100159
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000160struct snd_soc_dai_driver;
Mark Browna47cbe72008-07-23 14:03:07 +0100161struct snd_soc_dai;
162struct snd_ac97_bus_ops;
163
164/* Digital Audio Interface clocking API.*/
165int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
166 unsigned int freq, int dir);
167
168int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
169 int div_id, int div);
170
171int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
Mark Brown85488032009-09-05 18:52:16 +0100172 int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
Mark Browna47cbe72008-07-23 14:03:07 +0100173
Liam Girdwoode54cf762013-09-16 13:01:46 +0100174int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio);
175
Mark Browna47cbe72008-07-23 14:03:07 +0100176/* Digital Audio interface formatting */
Kuninori Morimotoba9e82a2021-05-27 11:26:12 +0900177int snd_soc_dai_get_fmt_max_priority(struct snd_soc_pcm_runtime *rtd);
178u64 snd_soc_dai_get_fmt(struct snd_soc_dai *dai, int priority);
Mark Browna47cbe72008-07-23 14:03:07 +0100179int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
180
181int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
Daniel Ribeiroa5479e32009-06-15 21:44:31 -0300182 unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
Mark Browna47cbe72008-07-23 14:03:07 +0100183
Barry Song472df3c2009-09-12 01:16:29 +0800184int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
185 unsigned int tx_num, unsigned int *tx_slot,
186 unsigned int rx_num, unsigned int *rx_slot);
187
Mark Browna47cbe72008-07-23 14:03:07 +0100188int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
189
190/* Digital Audio Interface mute */
Mark Brownda183962013-02-06 15:44:07 +0000191int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
192 int direction);
Mark Browna47cbe72008-07-23 14:03:07 +0100193
Srinivas Kandagatla467b0612018-07-23 16:54:03 +0100194
195int snd_soc_dai_get_channel_map(struct snd_soc_dai *dai,
196 unsigned int *tx_num, unsigned int *tx_slot,
197 unsigned int *rx_num, unsigned int *rx_slot);
198
Liam Girdwoodbece9e92014-01-08 10:40:18 +0000199int snd_soc_dai_is_dummy(struct snd_soc_dai *dai);
200
Kuninori Morimotoaa6166c2019-07-22 10:33:04 +0900201int snd_soc_dai_hw_params(struct snd_soc_dai *dai,
202 struct snd_pcm_substream *substream,
203 struct snd_pcm_hw_params *params);
Kuninori Morimoto846faae2019-07-22 10:33:19 +0900204void snd_soc_dai_hw_free(struct snd_soc_dai *dai,
Kuninori Morimotoc304c9a2020-09-29 13:31:53 +0900205 struct snd_pcm_substream *substream,
206 int rollback);
Kuninori Morimoto5a52a042019-07-22 10:33:32 +0900207int snd_soc_dai_startup(struct snd_soc_dai *dai,
208 struct snd_pcm_substream *substream);
Kuninori Morimoto330fcb52019-07-22 10:33:39 +0900209void snd_soc_dai_shutdown(struct snd_soc_dai *dai,
Kuninori Morimoto00a0b462020-09-28 09:00:40 +0900210 struct snd_pcm_substream *substream, int rollback);
Kuninori Morimoto1dea80d2019-07-22 10:34:09 +0900211snd_pcm_sframes_t snd_soc_dai_delay(struct snd_soc_dai *dai,
212 struct snd_pcm_substream *substream);
Kuninori Morimotoe0f22622019-07-22 10:34:29 +0900213void snd_soc_dai_suspend(struct snd_soc_dai *dai);
Kuninori Morimoto24b09d02019-07-22 10:34:43 +0900214void snd_soc_dai_resume(struct snd_soc_dai *dai);
Kuninori Morimotob423c422019-07-22 10:35:29 +0900215int snd_soc_dai_compress_new(struct snd_soc_dai *dai,
216 struct snd_soc_pcm_runtime *rtd, int num);
Kuninori Morimoto467fece2019-07-22 10:36:16 +0900217bool snd_soc_dai_stream_valid(struct snd_soc_dai *dai, int stream);
Pierre-Louis Bossart25612472020-07-07 16:04:37 -0500218void snd_soc_dai_link_set_capabilities(struct snd_soc_dai_link *dai_link);
Kuninori Morimotodc829102020-05-15 09:46:27 +0900219void snd_soc_dai_action(struct snd_soc_dai *dai,
220 int stream, int action);
221static inline void snd_soc_dai_activate(struct snd_soc_dai *dai,
222 int stream)
223{
224 snd_soc_dai_action(dai, stream, 1);
225}
226static inline void snd_soc_dai_deactivate(struct snd_soc_dai *dai,
227 int stream)
228{
229 snd_soc_dai_action(dai, stream, -1);
230}
Kuninori Morimotoefffd9b2020-05-15 09:46:37 +0900231int snd_soc_dai_active(struct snd_soc_dai *dai);
Kuninori Morimotoaa6166c2019-07-22 10:33:04 +0900232
Kuninori Morimoto51801ae2020-04-24 08:15:15 +0900233int snd_soc_pcm_dai_probe(struct snd_soc_pcm_runtime *rtd, int order);
Kuninori Morimoto7eaa3132020-04-24 08:15:20 +0900234int snd_soc_pcm_dai_remove(struct snd_soc_pcm_runtime *rtd, int order);
Kuninori Morimoto0b73ba52020-04-24 08:14:48 +0900235int snd_soc_pcm_dai_new(struct snd_soc_pcm_runtime *rtd);
Kuninori Morimotod108c7f2020-04-24 08:14:53 +0900236int snd_soc_pcm_dai_prepare(struct snd_pcm_substream *substream);
Kuninori Morimoto6374f492020-12-01 08:51:33 +0900237int snd_soc_pcm_dai_trigger(struct snd_pcm_substream *substream, int cmd,
238 int rollback);
Kuninori Morimoto308193582020-04-24 08:15:09 +0900239int snd_soc_pcm_dai_bespoke_trigger(struct snd_pcm_substream *substream,
240 int cmd);
Kuninori Morimoto0b73ba52020-04-24 08:14:48 +0900241
Kuninori Morimotob5ae4cc2020-04-24 08:15:24 +0900242int snd_soc_dai_compr_startup(struct snd_soc_dai *dai,
243 struct snd_compr_stream *cstream);
Kuninori Morimoto2b25f812020-04-24 08:15:28 +0900244void snd_soc_dai_compr_shutdown(struct snd_soc_dai *dai,
Kuninori Morimoto1e6a93c2020-11-19 08:50:04 +0900245 struct snd_compr_stream *cstream,
246 int rollback);
Kuninori Morimotoeb084112020-04-24 08:15:32 +0900247int snd_soc_dai_compr_trigger(struct snd_soc_dai *dai,
248 struct snd_compr_stream *cstream, int cmd);
Kuninori Morimoto8dfedaf2020-04-24 08:15:36 +0900249int snd_soc_dai_compr_set_params(struct snd_soc_dai *dai,
250 struct snd_compr_stream *cstream,
251 struct snd_compr_params *params);
Kuninori Morimotoadbef5432020-04-24 08:15:40 +0900252int snd_soc_dai_compr_get_params(struct snd_soc_dai *dai,
253 struct snd_compr_stream *cstream,
254 struct snd_codec *params);
Kuninori Morimoto53294352020-04-24 08:15:45 +0900255int snd_soc_dai_compr_ack(struct snd_soc_dai *dai,
256 struct snd_compr_stream *cstream,
257 size_t bytes);
Kuninori Morimotoed38cc52020-04-24 08:15:49 +0900258int snd_soc_dai_compr_pointer(struct snd_soc_dai *dai,
259 struct snd_compr_stream *cstream,
260 struct snd_compr_tstamp *tstamp);
Kuninori Morimoto88b3a7d2020-04-24 08:15:54 +0900261int snd_soc_dai_compr_set_metadata(struct snd_soc_dai *dai,
262 struct snd_compr_stream *cstream,
263 struct snd_compr_metadata *metadata);
Kuninori Morimoto94d72812020-04-24 08:15:59 +0900264int snd_soc_dai_compr_get_metadata(struct snd_soc_dai *dai,
265 struct snd_compr_stream *cstream,
266 struct snd_compr_metadata *metadata);
Kuninori Morimotob5ae4cc2020-04-24 08:15:24 +0900267
Mark Browna47cbe72008-07-23 14:03:07 +0100268struct snd_soc_dai_ops {
269 /*
270 * DAI clocking configuration, all optional.
271 * Called by soc_card drivers, normally in their hw_params.
272 */
273 int (*set_sysclk)(struct snd_soc_dai *dai,
274 int clk_id, unsigned int freq, int dir);
Mark Brown85488032009-09-05 18:52:16 +0100275 int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
276 unsigned int freq_in, unsigned int freq_out);
Mark Browna47cbe72008-07-23 14:03:07 +0100277 int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
Liam Girdwoode54cf762013-09-16 13:01:46 +0100278 int (*set_bclk_ratio)(struct snd_soc_dai *dai, unsigned int ratio);
Mark Browna47cbe72008-07-23 14:03:07 +0100279
280 /*
281 * DAI format configuration
282 * Called by soc_card drivers, normally in their hw_params.
283 */
284 int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
Xiubo Lie5c21512014-03-21 14:17:12 +0800285 int (*xlate_tdm_slot_mask)(unsigned int slots,
Xiubo Li89c67852014-02-14 09:34:35 +0800286 unsigned int *tx_mask, unsigned int *rx_mask);
Mark Browna47cbe72008-07-23 14:03:07 +0100287 int (*set_tdm_slot)(struct snd_soc_dai *dai,
Daniel Ribeiroa5479e32009-06-15 21:44:31 -0300288 unsigned int tx_mask, unsigned int rx_mask,
289 int slots, int slot_width);
Barry Song472df3c2009-09-12 01:16:29 +0800290 int (*set_channel_map)(struct snd_soc_dai *dai,
291 unsigned int tx_num, unsigned int *tx_slot,
292 unsigned int rx_num, unsigned int *rx_slot);
Srinivas Kandagatla467b0612018-07-23 16:54:03 +0100293 int (*get_channel_map)(struct snd_soc_dai *dai,
294 unsigned int *tx_num, unsigned int *tx_slot,
295 unsigned int *rx_num, unsigned int *rx_slot);
Mark Browna47cbe72008-07-23 14:03:07 +0100296 int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
297
Shreyas NC97349b62018-04-26 18:38:38 +0530298 int (*set_sdw_stream)(struct snd_soc_dai *dai,
299 void *stream, int direction);
Pierre-Louis Bossart36d73c42020-02-25 11:00:40 -0600300 void *(*get_sdw_stream)(struct snd_soc_dai *dai, int direction);
301
Mark Browna47cbe72008-07-23 14:03:07 +0100302 /*
303 * DAI digital mute - optional.
304 * Called by soc-core to minimise any pops.
305 */
Mark Brownda183962013-02-06 15:44:07 +0000306 int (*mute_stream)(struct snd_soc_dai *dai, int mute, int stream);
Mark Browndee89c42008-11-18 22:11:38 +0000307
308 /*
309 * ALSA PCM audio operations - all optional.
310 * Called by soc-core during audio PCM operations.
311 */
312 int (*startup)(struct snd_pcm_substream *,
313 struct snd_soc_dai *);
314 void (*shutdown)(struct snd_pcm_substream *,
315 struct snd_soc_dai *);
316 int (*hw_params)(struct snd_pcm_substream *,
317 struct snd_pcm_hw_params *, struct snd_soc_dai *);
318 int (*hw_free)(struct snd_pcm_substream *,
319 struct snd_soc_dai *);
320 int (*prepare)(struct snd_pcm_substream *,
321 struct snd_soc_dai *);
Markus Pargmann9f1614a2013-10-11 12:11:02 +0200322 /*
323 * NOTE: Commands passed to the trigger function are not necessarily
324 * compatible with the current state of the dai. For example this
325 * sequence of commands is possible: START STOP STOP.
326 * So do not unconditionally use refcounting functions in the trigger
327 * function, e.g. clk_enable/disable.
328 */
Mark Browndee89c42008-11-18 22:11:38 +0000329 int (*trigger)(struct snd_pcm_substream *, int,
330 struct snd_soc_dai *);
Liam Girdwood07bf84a2012-04-25 12:12:52 +0100331 int (*bespoke_trigger)(struct snd_pcm_substream *, int,
332 struct snd_soc_dai *);
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200333 /*
334 * For hardware based FIFO caused delay reporting.
335 * Optional.
336 */
337 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
338 struct snd_soc_dai *);
Kuninori Morimoto350d9932020-07-09 10:55:41 +0900339
Kuninori Morimotoba9e82a2021-05-27 11:26:12 +0900340 /*
341 * Format list for auto selection.
342 * Format will be increased if priority format was
343 * not selected.
344 * see
345 * snd_soc_dai_get_fmt()
346 */
347 u64 *auto_selectable_formats;
348 int num_auto_selectable_formats;
349
Kuninori Morimoto350d9932020-07-09 10:55:41 +0900350 /* bit field */
351 unsigned int no_capture_mute:1;
Mark Browna47cbe72008-07-23 14:03:07 +0100352};
353
Vinod Koul2e622ae2016-11-13 12:10:02 +0530354struct snd_soc_cdai_ops {
355 /*
356 * for compress ops
357 */
358 int (*startup)(struct snd_compr_stream *,
359 struct snd_soc_dai *);
360 int (*shutdown)(struct snd_compr_stream *,
361 struct snd_soc_dai *);
362 int (*set_params)(struct snd_compr_stream *,
363 struct snd_compr_params *, struct snd_soc_dai *);
364 int (*get_params)(struct snd_compr_stream *,
365 struct snd_codec *, struct snd_soc_dai *);
366 int (*set_metadata)(struct snd_compr_stream *,
367 struct snd_compr_metadata *, struct snd_soc_dai *);
368 int (*get_metadata)(struct snd_compr_stream *,
369 struct snd_compr_metadata *, struct snd_soc_dai *);
370 int (*trigger)(struct snd_compr_stream *, int,
371 struct snd_soc_dai *);
372 int (*pointer)(struct snd_compr_stream *,
373 struct snd_compr_tstamp *, struct snd_soc_dai *);
374 int (*ack)(struct snd_compr_stream *, size_t,
375 struct snd_soc_dai *);
376};
377
Mark Browna47cbe72008-07-23 14:03:07 +0100378/*
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000379 * Digital Audio Interface Driver.
Mark Browna47cbe72008-07-23 14:03:07 +0100380 *
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000381 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
382 * operations and capabilities. Codec and platform drivers will register this
383 * structure for every DAI they have.
384 *
385 * This structure covers the clocking, formating and ALSA operations for each
386 * interface.
Mark Browna47cbe72008-07-23 14:03:07 +0100387 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000388struct snd_soc_dai_driver {
Mark Browna47cbe72008-07-23 14:03:07 +0100389 /* DAI description */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000390 const char *name;
Mark Browna47cbe72008-07-23 14:03:07 +0100391 unsigned int id;
Mark Brown62368292012-05-01 20:03:32 +0100392 unsigned int base;
Mengdong Lin68003e62015-12-31 16:40:43 +0800393 struct snd_soc_dobj dobj;
Mark Browna47cbe72008-07-23 14:03:07 +0100394
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000395 /* DAI driver callbacks */
396 int (*probe)(struct snd_soc_dai *dai);
397 int (*remove)(struct snd_soc_dai *dai);
Vinod Koul49681072012-08-16 17:10:40 +0530398 /* compress dai */
Jie Yang6f0c4222015-10-13 23:41:00 +0800399 int (*compress_new)(struct snd_soc_pcm_runtime *rtd, int num);
Arnaud Pouliquen25f7b702017-01-03 16:52:51 +0100400 /* Optional Callback used at pcm creation*/
401 int (*pcm_new)(struct snd_soc_pcm_runtime *rtd,
402 struct snd_soc_dai *dai);
Mark Browna47cbe72008-07-23 14:03:07 +0100403
404 /* ops */
Mark Brown1ee46eb2010-12-02 16:10:09 +0000405 const struct snd_soc_dai_ops *ops;
Vinod Koul2e622ae2016-11-13 12:10:02 +0530406 const struct snd_soc_cdai_ops *cops;
Mark Browna47cbe72008-07-23 14:03:07 +0100407
408 /* DAI capabilities */
409 struct snd_soc_pcm_stream capture;
410 struct snd_soc_pcm_stream playback;
Kuninori Morimotof14654d2021-01-15 13:52:54 +0900411 unsigned int symmetric_rate:1;
Nicolin Chen3635bf02013-11-13 18:56:24 +0800412 unsigned int symmetric_channels:1;
Kuninori Morimotof14654d2021-01-15 13:52:54 +0900413 unsigned int symmetric_sample_bits:1;
Liam Girdwood0168bf02011-06-07 16:08:05 +0100414
415 /* probe ordering - for components with runtime dependencies */
416 int probe_order;
417 int remove_order;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000418};
419
420/*
421 * Digital Audio Interface runtime data.
422 *
423 * Holds runtime data for a DAI.
424 */
425struct snd_soc_dai {
426 const char *name;
427 int id;
428 struct device *dev;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000429
430 /* driver ops */
431 struct snd_soc_dai_driver *driver;
Mark Browna47cbe72008-07-23 14:03:07 +0100432
433 /* DAI runtime info */
Kuninori Morimoto0f6011f2020-02-17 17:28:15 +0900434 unsigned int stream_active[SNDRV_PCM_STREAM_LAST + 1]; /* usage count */
Kuninori Morimoto39b22382016-10-24 05:25:19 +0000435
Mark Brown888df392012-02-16 19:37:51 -0800436 struct snd_soc_dapm_widget *playback_widget;
437 struct snd_soc_dapm_widget *capture_widget;
438
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000439 /* DAI DMA data */
440 void *playback_dma_data;
441 void *capture_dma_data;
Mark Browna47cbe72008-07-23 14:03:07 +0100442
Dong Aisheng17841022011-08-29 17:15:14 +0800443 /* Symmetry data - only valid if symmetry is being enforced */
444 unsigned int rate;
Nicolin Chen3635bf02013-11-13 18:56:24 +0800445 unsigned int channels;
446 unsigned int sample_bits;
Dong Aisheng17841022011-08-29 17:15:14 +0800447
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000448 /* parent platform/codec */
Lars-Peter Clausen6106d122014-03-05 13:17:46 +0100449 struct snd_soc_component *component;
Mark Brown2466ab92012-03-02 16:18:30 +0000450
Benoit Cousson88bd8702014-07-08 23:19:34 +0200451 /* CODEC TDM slot masks and params (for fixup) */
452 unsigned int tx_mask;
453 unsigned int rx_mask;
454
Mark Browna47cbe72008-07-23 14:03:07 +0100455 struct list_head list;
Kuninori Morimotob56be802020-02-10 12:14:33 +0900456
Kuninori Morimoto00a0b462020-09-28 09:00:40 +0900457 /* function mark */
458 struct snd_pcm_substream *mark_startup;
Kuninori Morimotoc304c9a2020-09-29 13:31:53 +0900459 struct snd_pcm_substream *mark_hw_params;
Kuninori Morimoto6374f492020-12-01 08:51:33 +0900460 struct snd_pcm_substream *mark_trigger;
Kuninori Morimoto1e6a93c2020-11-19 08:50:04 +0900461 struct snd_compr_stream *mark_compr_startup;
Kuninori Morimoto00a0b462020-09-28 09:00:40 +0900462
Kuninori Morimotob56be802020-02-10 12:14:33 +0900463 /* bit field */
464 unsigned int probed:1;
Mark Browna47cbe72008-07-23 14:03:07 +0100465};
466
Kuninori Morimotoacf253c2020-02-19 15:56:30 +0900467static inline struct snd_soc_pcm_stream *
468snd_soc_dai_get_pcm_stream(const struct snd_soc_dai *dai, int stream)
469{
470 return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
471 &dai->driver->playback : &dai->driver->capture;
472}
473
Kuninori Morimoto0c01f6c2020-02-19 15:56:41 +0900474static inline
475struct snd_soc_dapm_widget *snd_soc_dai_get_widget(
476 struct snd_soc_dai *dai, int stream)
477{
478 return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
479 dai->playback_widget : dai->capture_widget;
480}
481
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000482static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
483 const struct snd_pcm_substream *ss)
484{
485 return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000486 dai->playback_dma_data : dai->capture_dma_data;
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000487}
488
489static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
490 const struct snd_pcm_substream *ss,
491 void *data)
492{
493 if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000494 dai->playback_dma_data = data;
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000495 else
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000496 dai->capture_dma_data = data;
497}
498
Mark Brownecfc0c02013-10-17 21:13:19 +0100499static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai,
500 void *playback, void *capture)
501{
502 dai->playback_dma_data = playback;
503 dai->capture_dma_data = capture;
504}
505
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000506static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
507 void *data)
508{
509 dev_set_drvdata(dai->dev, data);
510}
511
512static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
513{
514 return dev_get_drvdata(dai->dev);
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000515}
516
Shreyas NC97349b62018-04-26 18:38:38 +0530517/**
518 * snd_soc_dai_set_sdw_stream() - Configures a DAI for SDW stream operation
519 * @dai: DAI
520 * @stream: STREAM
521 * @direction: Stream direction(Playback/Capture)
522 * SoundWire subsystem doesn't have a notion of direction and we reuse
523 * the ASoC stream direction to configure sink/source ports.
524 * Playback maps to source ports and Capture for sink ports.
525 *
526 * This should be invoked with NULL to clear the stream set previously.
527 * Returns 0 on success, a negative error code otherwise.
528 */
529static inline int snd_soc_dai_set_sdw_stream(struct snd_soc_dai *dai,
530 void *stream, int direction)
531{
532 if (dai->driver->ops->set_sdw_stream)
533 return dai->driver->ops->set_sdw_stream(dai, stream, direction);
534 else
535 return -ENOTSUPP;
536}
537
Pierre-Louis Bossart36d73c42020-02-25 11:00:40 -0600538/**
539 * snd_soc_dai_get_sdw_stream() - Retrieves SDW stream from DAI
540 * @dai: DAI
541 * @direction: Stream direction(Playback/Capture)
542 *
543 * This routine only retrieves that was previously configured
544 * with snd_soc_dai_get_sdw_stream()
545 *
Pierre-Louis Bossartd20e8342020-09-05 02:28:52 +0800546 * Returns pointer to stream or an ERR_PTR value, e.g.
547 * ERR_PTR(-ENOTSUPP) if callback is not supported;
Pierre-Louis Bossart36d73c42020-02-25 11:00:40 -0600548 */
549static inline void *snd_soc_dai_get_sdw_stream(struct snd_soc_dai *dai,
550 int direction)
551{
552 if (dai->driver->ops->get_sdw_stream)
553 return dai->driver->ops->get_sdw_stream(dai, direction);
554 else
Srinivas Kandagatla308811a2020-03-16 15:11:10 +0000555 return ERR_PTR(-ENOTSUPP);
Pierre-Louis Bossart36d73c42020-02-25 11:00:40 -0600556}
557
Kuninori Morimoto5552f8d2020-05-15 09:46:47 +0900558static inline unsigned int
559snd_soc_dai_stream_active(struct snd_soc_dai *dai, int stream)
560{
561 return dai->stream_active[stream];
562}
563
Mark Browna47cbe72008-07-23 14:03:07 +0100564#endif