1 /* SPDX-License-Identifier: GPL-2.0
3 * linux/sound/soc-dai.h -- ALSA SoC Layer
5 * Copyright: 2005-2008 Wolfson Microelectronics. PLC.
7 * Digital Audio Interface (DAI) API.
10 #ifndef __LINUX_SND_SOC_DAI_H
11 #define __LINUX_SND_SOC_DAI_H
14 #include <linux/list.h>
15 #include <sound/asoc.h>
17 struct snd_pcm_substream;
18 struct snd_soc_dapm_widget;
19 struct snd_compr_stream;
22 * DAI hardware audio formats.
24 * Describes the physical PCM data formating and clocking. Add new formats
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
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
42 * DAI bit clocks can be be gated (disabled) when the DAI is not
43 * sending or receiving PCM data in a frame. This can be used to save power.
45 #define SND_SOC_DAIFMT_CONT (1 << 4) /* continuous clock */
46 #define SND_SOC_DAIFMT_GATED (0 << 4) /* clock is gated */
49 * DAI hardware signal polarity.
51 * Specifies whether the DAI can also support inverted clocks for the specified
55 * - "normal" polarity means signal is available at rising edge of BCLK
56 * - "inverted" polarity means signal is available at falling edge of BCLK
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
64 * - DSP A/B: Frame starts with rising FSYNC edge.
65 * - AC97: Frame starts with rising FSYNC edge.
67 * "Negative" FSYNC polarity is the one opposite of "normal" polarity.
69 #define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */
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 */
75 * DAI hardware clock masters.
77 * This is wrt the codec, the inverse is true for the interface
78 * i.e. if the codec is clk and FRM master then the interface is
79 * clk and frame slave.
81 #define SND_SOC_DAIFMT_CBM_CFM (1 << 12) /* codec clk & FRM master */
82 #define SND_SOC_DAIFMT_CBS_CFM (2 << 12) /* codec clk slave & FRM master */
83 #define SND_SOC_DAIFMT_CBM_CFS (3 << 12) /* codec clk master & frame slave */
84 #define SND_SOC_DAIFMT_CBS_CFS (4 << 12) /* codec clk & FRM slave */
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
92 * Master Clock Directions
94 #define SND_SOC_CLOCK_IN 0
95 #define SND_SOC_CLOCK_OUT 1
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 |\
102 SNDRV_PCM_FMTBIT_S20_LE |\
103 SNDRV_PCM_FMTBIT_S20_BE |\
104 SNDRV_PCM_FMTBIT_S24_3LE |\
105 SNDRV_PCM_FMTBIT_S24_3BE |\
106 SNDRV_PCM_FMTBIT_S32_LE |\
107 SNDRV_PCM_FMTBIT_S32_BE)
109 struct snd_soc_dai_driver;
111 struct snd_ac97_bus_ops;
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);
117 int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
118 int div_id, int div);
120 int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
121 int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
123 int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio);
125 /* Digital Audio interface formatting */
126 int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
128 int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
129 unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
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);
135 int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
137 /* Digital Audio Interface mute */
138 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
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);
146 int snd_soc_dai_is_dummy(struct snd_soc_dai *dai);
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);
151 void snd_soc_dai_hw_free(struct snd_soc_dai *dai,
152 struct snd_pcm_substream *substream);
153 int snd_soc_dai_startup(struct snd_soc_dai *dai,
154 struct snd_pcm_substream *substream);
155 void snd_soc_dai_shutdown(struct snd_soc_dai *dai,
156 struct snd_pcm_substream *substream);
157 snd_pcm_sframes_t snd_soc_dai_delay(struct snd_soc_dai *dai,
158 struct snd_pcm_substream *substream);
159 void snd_soc_dai_suspend(struct snd_soc_dai *dai);
160 void snd_soc_dai_resume(struct snd_soc_dai *dai);
161 int snd_soc_dai_compress_new(struct snd_soc_dai *dai,
162 struct snd_soc_pcm_runtime *rtd, int num);
163 bool snd_soc_dai_stream_valid(struct snd_soc_dai *dai, int stream);
165 int snd_soc_pcm_dai_probe(struct snd_soc_pcm_runtime *rtd, int order);
166 int snd_soc_pcm_dai_remove(struct snd_soc_pcm_runtime *rtd, int order);
167 int snd_soc_pcm_dai_new(struct snd_soc_pcm_runtime *rtd);
168 int snd_soc_pcm_dai_prepare(struct snd_pcm_substream *substream);
169 int snd_soc_pcm_dai_trigger(struct snd_pcm_substream *substream, int cmd);
170 int snd_soc_pcm_dai_bespoke_trigger(struct snd_pcm_substream *substream,
173 int snd_soc_dai_compr_startup(struct snd_soc_dai *dai,
174 struct snd_compr_stream *cstream);
175 void snd_soc_dai_compr_shutdown(struct snd_soc_dai *dai,
176 struct snd_compr_stream *cstream);
177 int snd_soc_dai_compr_trigger(struct snd_soc_dai *dai,
178 struct snd_compr_stream *cstream, int cmd);
179 int snd_soc_dai_compr_set_params(struct snd_soc_dai *dai,
180 struct snd_compr_stream *cstream,
181 struct snd_compr_params *params);
182 int snd_soc_dai_compr_get_params(struct snd_soc_dai *dai,
183 struct snd_compr_stream *cstream,
184 struct snd_codec *params);
185 int snd_soc_dai_compr_ack(struct snd_soc_dai *dai,
186 struct snd_compr_stream *cstream,
189 struct snd_soc_dai_ops {
191 * DAI clocking configuration, all optional.
192 * Called by soc_card drivers, normally in their hw_params.
194 int (*set_sysclk)(struct snd_soc_dai *dai,
195 int clk_id, unsigned int freq, int dir);
196 int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
197 unsigned int freq_in, unsigned int freq_out);
198 int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
199 int (*set_bclk_ratio)(struct snd_soc_dai *dai, unsigned int ratio);
202 * DAI format configuration
203 * Called by soc_card drivers, normally in their hw_params.
205 int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
206 int (*xlate_tdm_slot_mask)(unsigned int slots,
207 unsigned int *tx_mask, unsigned int *rx_mask);
208 int (*set_tdm_slot)(struct snd_soc_dai *dai,
209 unsigned int tx_mask, unsigned int rx_mask,
210 int slots, int slot_width);
211 int (*set_channel_map)(struct snd_soc_dai *dai,
212 unsigned int tx_num, unsigned int *tx_slot,
213 unsigned int rx_num, unsigned int *rx_slot);
214 int (*get_channel_map)(struct snd_soc_dai *dai,
215 unsigned int *tx_num, unsigned int *tx_slot,
216 unsigned int *rx_num, unsigned int *rx_slot);
217 int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
219 int (*set_sdw_stream)(struct snd_soc_dai *dai,
220 void *stream, int direction);
221 void *(*get_sdw_stream)(struct snd_soc_dai *dai, int direction);
224 * DAI digital mute - optional.
225 * Called by soc-core to minimise any pops.
227 int (*digital_mute)(struct snd_soc_dai *dai, int mute);
228 int (*mute_stream)(struct snd_soc_dai *dai, int mute, int stream);
231 * ALSA PCM audio operations - all optional.
232 * Called by soc-core during audio PCM operations.
234 int (*startup)(struct snd_pcm_substream *,
235 struct snd_soc_dai *);
236 void (*shutdown)(struct snd_pcm_substream *,
237 struct snd_soc_dai *);
238 int (*hw_params)(struct snd_pcm_substream *,
239 struct snd_pcm_hw_params *, struct snd_soc_dai *);
240 int (*hw_free)(struct snd_pcm_substream *,
241 struct snd_soc_dai *);
242 int (*prepare)(struct snd_pcm_substream *,
243 struct snd_soc_dai *);
245 * NOTE: Commands passed to the trigger function are not necessarily
246 * compatible with the current state of the dai. For example this
247 * sequence of commands is possible: START STOP STOP.
248 * So do not unconditionally use refcounting functions in the trigger
249 * function, e.g. clk_enable/disable.
251 int (*trigger)(struct snd_pcm_substream *, int,
252 struct snd_soc_dai *);
253 int (*bespoke_trigger)(struct snd_pcm_substream *, int,
254 struct snd_soc_dai *);
256 * For hardware based FIFO caused delay reporting.
259 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
260 struct snd_soc_dai *);
263 struct snd_soc_cdai_ops {
267 int (*startup)(struct snd_compr_stream *,
268 struct snd_soc_dai *);
269 int (*shutdown)(struct snd_compr_stream *,
270 struct snd_soc_dai *);
271 int (*set_params)(struct snd_compr_stream *,
272 struct snd_compr_params *, struct snd_soc_dai *);
273 int (*get_params)(struct snd_compr_stream *,
274 struct snd_codec *, struct snd_soc_dai *);
275 int (*set_metadata)(struct snd_compr_stream *,
276 struct snd_compr_metadata *, struct snd_soc_dai *);
277 int (*get_metadata)(struct snd_compr_stream *,
278 struct snd_compr_metadata *, struct snd_soc_dai *);
279 int (*trigger)(struct snd_compr_stream *, int,
280 struct snd_soc_dai *);
281 int (*pointer)(struct snd_compr_stream *,
282 struct snd_compr_tstamp *, struct snd_soc_dai *);
283 int (*ack)(struct snd_compr_stream *, size_t,
284 struct snd_soc_dai *);
288 * Digital Audio Interface Driver.
290 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
291 * operations and capabilities. Codec and platform drivers will register this
292 * structure for every DAI they have.
294 * This structure covers the clocking, formating and ALSA operations for each
297 struct snd_soc_dai_driver {
298 /* DAI description */
302 struct snd_soc_dobj dobj;
304 /* DAI driver callbacks */
305 int (*probe)(struct snd_soc_dai *dai);
306 int (*remove)(struct snd_soc_dai *dai);
308 int (*compress_new)(struct snd_soc_pcm_runtime *rtd, int num);
309 /* Optional Callback used at pcm creation*/
310 int (*pcm_new)(struct snd_soc_pcm_runtime *rtd,
311 struct snd_soc_dai *dai);
314 const struct snd_soc_dai_ops *ops;
315 const struct snd_soc_cdai_ops *cops;
317 /* DAI capabilities */
318 struct snd_soc_pcm_stream capture;
319 struct snd_soc_pcm_stream playback;
320 unsigned int symmetric_rates:1;
321 unsigned int symmetric_channels:1;
322 unsigned int symmetric_samplebits:1;
324 /* probe ordering - for components with runtime dependencies */
330 * Digital Audio Interface runtime data.
332 * Holds runtime data for a DAI.
340 struct snd_soc_dai_driver *driver;
342 /* DAI runtime info */
343 unsigned int stream_active[SNDRV_PCM_STREAM_LAST + 1]; /* usage count */
347 struct snd_soc_dapm_widget *playback_widget;
348 struct snd_soc_dapm_widget *capture_widget;
351 void *playback_dma_data;
352 void *capture_dma_data;
354 /* Symmetry data - only valid if symmetry is being enforced */
356 unsigned int channels;
357 unsigned int sample_bits;
359 /* parent platform/codec */
360 struct snd_soc_component *component;
362 /* CODEC TDM slot masks and params (for fixup) */
363 unsigned int tx_mask;
364 unsigned int rx_mask;
366 struct list_head list;
369 unsigned int probed:1;
372 static inline struct snd_soc_pcm_stream *
373 snd_soc_dai_get_pcm_stream(const struct snd_soc_dai *dai, int stream)
375 return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
376 &dai->driver->playback : &dai->driver->capture;
380 struct snd_soc_dapm_widget *snd_soc_dai_get_widget(
381 struct snd_soc_dai *dai, int stream)
383 return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
384 dai->playback_widget : dai->capture_widget;
387 static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
388 const struct snd_pcm_substream *ss)
390 return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
391 dai->playback_dma_data : dai->capture_dma_data;
394 static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
395 const struct snd_pcm_substream *ss,
398 if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
399 dai->playback_dma_data = data;
401 dai->capture_dma_data = data;
404 static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai,
405 void *playback, void *capture)
407 dai->playback_dma_data = playback;
408 dai->capture_dma_data = capture;
411 static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
414 dev_set_drvdata(dai->dev, data);
417 static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
419 return dev_get_drvdata(dai->dev);
423 * snd_soc_dai_set_sdw_stream() - Configures a DAI for SDW stream operation
426 * @direction: Stream direction(Playback/Capture)
427 * SoundWire subsystem doesn't have a notion of direction and we reuse
428 * the ASoC stream direction to configure sink/source ports.
429 * Playback maps to source ports and Capture for sink ports.
431 * This should be invoked with NULL to clear the stream set previously.
432 * Returns 0 on success, a negative error code otherwise.
434 static inline int snd_soc_dai_set_sdw_stream(struct snd_soc_dai *dai,
435 void *stream, int direction)
437 if (dai->driver->ops->set_sdw_stream)
438 return dai->driver->ops->set_sdw_stream(dai, stream, direction);
444 * snd_soc_dai_get_sdw_stream() - Retrieves SDW stream from DAI
446 * @direction: Stream direction(Playback/Capture)
448 * This routine only retrieves that was previously configured
449 * with snd_soc_dai_get_sdw_stream()
451 * Returns pointer to stream or -ENOTSUPP if callback is not supported;
453 static inline void *snd_soc_dai_get_sdw_stream(struct snd_soc_dai *dai,
456 if (dai->driver->ops->get_sdw_stream)
457 return dai->driver->ops->get_sdw_stream(dai, direction);
459 return ERR_PTR(-ENOTSUPP);