projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag 'io_uring-6.16-20250630' of git://git.kernel.dk/linux
[linux-2.6-block.git] / include / sound / soc-dai.h
CommitLineData
e2cfd2c9
KM		 1/* SPDX-License-Identifier: GPL-2.0
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
17struct snd_pcm_substream;
888df395 18struct snd_soc_dapm_widget;
49681077 19struct 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
ba9e82a1
KM		 39/* 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
a47cbe72
MB		 55/*
56 * DAI Clock gating.
57 *
fc926a7c 58 * DAI bit clocks can be gated (disabled) when the DAI is not
a47cbe72
MB		 59 * sending or receiving PCM data in a frame. This can be used to save power.
60 */
75d9ac46 61#define SND_SOC_DAIFMT_CONT (1 << 4) /* continuous clock */
eef28e10 62#define SND_SOC_DAIFMT_GATED (0 << 4) /* clock is gated */
a47cbe72 63
ba9e82a1
KM		 64/* 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
a47cbe72 75/*
1d387a3f 76 * DAI hardware signal polarity.
a47cbe72
MB		 77 *
78 * Specifies whether the DAI can also support inverted clocks for the specified
79 * format.
1d387a3f
AP		 80 *
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.
a47cbe72 95 */
5d163336 96#define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */
75d9ac46
MB		 97#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 */
a47cbe72 100
ba9e82a1
KM		 101/* 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
a47cbe72 109/*
f026c123 110 * DAI hardware clock providers/consumers
a47cbe72
MB		 111 *
112 * This is wrt the codec, the inverse is true for the interface
f026c123
PLB		 113 * i.e. if the codec is clk and FRM provider then the interface is
114 * clk and frame consumer.
a47cbe72 115 */
f026c123
PLB		 116#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 */
47c11316 119#define SND_SOC_DAIFMT_CBC_CFC (4 << 12) /* codec clk consumer & frame consumer */
f026c123 120
905f3a04
CK		 121/* when passed to set_fmt directly indicate if the device is provider or consumer */
122#define SND_SOC_DAIFMT_BP_FP SND_SOC_DAIFMT_CBP_CFP
123#define SND_SOC_DAIFMT_BC_FP SND_SOC_DAIFMT_CBC_CFP
124#define SND_SOC_DAIFMT_BP_FC SND_SOC_DAIFMT_CBP_CFC
125#define SND_SOC_DAIFMT_BC_FC SND_SOC_DAIFMT_CBC_CFC
126
ba9e82a1
KM		 127/* 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
f026c123
PLB		 135#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
a47cbe72
MB		 141
142/*
143 * Master Clock Directions
144 */
145#define SND_SOC_CLOCK_IN 0
146#define SND_SOC_CLOCK_OUT 1
147
8f738d58
MB		 148#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 |\
823dbb6e
MS		 153 SNDRV_PCM_FMTBIT_S20_LE |\
154 SNDRV_PCM_FMTBIT_S20_BE |\
8f738d58
MB		 155 SNDRV_PCM_FMTBIT_S24_3LE |\
156 SNDRV_PCM_FMTBIT_S24_3BE |\
d34c4307
JS		 157 SNDRV_PCM_FMTBIT_S32_LE |\
158 SNDRV_PCM_FMTBIT_S32_BE)
33f503c9 159
f0fba2ad 160struct snd_soc_dai_driver;
a47cbe72
MB		 161struct 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,
85488037 172 int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
a47cbe72 173
e54cf76b
LG		 174int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio);
175
a47cbe72 176/* Digital Audio interface formatting */
f3ac3da7
KK		 177int snd_soc_dai_get_fmt_max_priority(const struct snd_soc_pcm_runtime *rtd);
178u64 snd_soc_dai_get_fmt(const struct snd_soc_dai *dai, int priority);
a47cbe72
MB		 179int 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,
a5479e38 182 unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
a47cbe72 183
472df3cb 184int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
965cc040
KK		 185 unsigned int tx_num, const unsigned int *tx_slot,
186 unsigned int rx_num, const unsigned int *rx_slot);
472df3cb 187
a47cbe72
MB		 188int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
189
d4e91adf
MB		 190int snd_soc_dai_prepare(struct snd_soc_dai *dai,
191 struct snd_pcm_substream *substream);
192
a47cbe72 193/* Digital Audio Interface mute */
da18396f
MB		 194int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
195 int direction);
5d5eceb9 196int snd_soc_dai_mute_is_ctrled_at_trigger(struct snd_soc_dai *dai);
467b061f 197
785d64c4 198int snd_soc_dai_get_channel_map(const struct snd_soc_dai *dai,
467b061f
SK		 199 unsigned int *tx_num, unsigned int *tx_slot,
200 unsigned int *rx_num, unsigned int *rx_slot);
201
f3ac3da7 202int snd_soc_dai_is_dummy(const struct snd_soc_dai *dai);
bece9e95 203
aa6166c2
KM		 204int snd_soc_dai_hw_params(struct snd_soc_dai *dai,
205 struct snd_pcm_substream *substream,
206 struct snd_pcm_hw_params *params);
846faaed 207void snd_soc_dai_hw_free(struct snd_soc_dai *dai,
c304c9ac
KM		 208 struct snd_pcm_substream *substream,
209 int rollback);
5a52a045
KM		 210int snd_soc_dai_startup(struct snd_soc_dai *dai,
211 struct snd_pcm_substream *substream);
330fcb51 212void snd_soc_dai_shutdown(struct snd_soc_dai *dai,
00a0b46c 213 struct snd_pcm_substream *substream, int rollback);
e0f22622 214void snd_soc_dai_suspend(struct snd_soc_dai *dai);
24b09d05 215void snd_soc_dai_resume(struct snd_soc_dai *dai);
8b12da9a 216int snd_soc_dai_compress_new(struct snd_soc_dai *dai, struct snd_soc_pcm_runtime *rtd);
f3ac3da7 217bool snd_soc_dai_stream_valid(const struct snd_soc_dai *dai, int stream);
dc829106
KM		 218void snd_soc_dai_action(struct snd_soc_dai *dai,
219 int stream, int action);
220static inline void snd_soc_dai_activate(struct snd_soc_dai *dai,
221 int stream)
222{
223 snd_soc_dai_action(dai, stream, 1);
224}
225static inline void snd_soc_dai_deactivate(struct snd_soc_dai *dai,
226 int stream)
227{
228 snd_soc_dai_action(dai, stream, -1);
229}
f3ac3da7 230int snd_soc_dai_active(const struct snd_soc_dai *dai);
aa6166c2 231
51801aea 232int snd_soc_pcm_dai_probe(struct snd_soc_pcm_runtime *rtd, int order);
7eaa313b 233int snd_soc_pcm_dai_remove(struct snd_soc_pcm_runtime *rtd, int order);
0b73ba55 234int snd_soc_pcm_dai_new(struct snd_soc_pcm_runtime *rtd);
d108c7fd 235int snd_soc_pcm_dai_prepare(struct snd_pcm_substream *substream);
6374f493
KM		 236int snd_soc_pcm_dai_trigger(struct snd_pcm_substream *substream, int cmd,
237 int rollback);
8544f08c
KM		 238void snd_soc_pcm_dai_delay(struct snd_pcm_substream *substream,
239 snd_pcm_sframes_t *cpu_delay, snd_pcm_sframes_t *codec_delay);
0b73ba55 240
b5ae4cce
KM		 241int snd_soc_dai_compr_startup(struct snd_soc_dai *dai,
242 struct snd_compr_stream *cstream);
2b25f81d 243void snd_soc_dai_compr_shutdown(struct snd_soc_dai *dai,
1e6a93cf
KM		 244 struct snd_compr_stream *cstream,
245 int rollback);
eb08411b
KM		 246int snd_soc_dai_compr_trigger(struct snd_soc_dai *dai,
247 struct snd_compr_stream *cstream, int cmd);
8dfedafb
KM		 248int snd_soc_dai_compr_set_params(struct snd_soc_dai *dai,
249 struct snd_compr_stream *cstream,
250 struct snd_compr_params *params);
adbef543
KM		 251int snd_soc_dai_compr_get_params(struct snd_soc_dai *dai,
252 struct snd_compr_stream *cstream,
253 struct snd_codec *params);
53294353
KM		 254int snd_soc_dai_compr_ack(struct snd_soc_dai *dai,
255 struct snd_compr_stream *cstream,
256 size_t bytes);
ed38cc59
KM		 257int snd_soc_dai_compr_pointer(struct snd_soc_dai *dai,
258 struct snd_compr_stream *cstream,
259 struct snd_compr_tstamp *tstamp);
88b3a7df
KM		 260int snd_soc_dai_compr_set_metadata(struct snd_soc_dai *dai,
261 struct snd_compr_stream *cstream,
262 struct snd_compr_metadata *metadata);
94d72819
KM		 263int snd_soc_dai_compr_get_metadata(struct snd_soc_dai *dai,
264 struct snd_compr_stream *cstream,
265 struct snd_compr_metadata *metadata);
b5ae4cce 266
f3ac3da7 267const char *snd_soc_dai_name_get(const struct snd_soc_dai *dai);
09f75f09 268
a47cbe72 269struct snd_soc_dai_ops {
624fee45
KM		 270 /* DAI driver callbacks */
271 int (*probe)(struct snd_soc_dai *dai);
272 int (*remove)(struct snd_soc_dai *dai);
273 /* compress dai */
8b12da9a 274 int (*compress_new)(struct snd_soc_pcm_runtime *rtd);
624fee45
KM		 275 /* Optional Callback used at pcm creation*/
276 int (*pcm_new)(struct snd_soc_pcm_runtime *rtd,
277 struct snd_soc_dai *dai);
278
a47cbe72
MB		 279 /*
280 * DAI clocking configuration, all optional.
281 * Called by soc_card drivers, normally in their hw_params.
282 */
283 int (*set_sysclk)(struct snd_soc_dai *dai,
284 int clk_id, unsigned int freq, int dir);
85488037
MB		 285 int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
286 unsigned int freq_in, unsigned int freq_out);
a47cbe72 287 int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
e54cf76b 288 int (*set_bclk_ratio)(struct snd_soc_dai *dai, unsigned int ratio);
a47cbe72
MB		 289
290 /*
291 * DAI format configuration
292 * Called by soc_card drivers, normally in their hw_params.
293 */
294 int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
e5c21514 295 int (*xlate_tdm_slot_mask)(unsigned int slots,
89c67857 296 unsigned int *tx_mask, unsigned int *rx_mask);
a47cbe72 297 int (*set_tdm_slot)(struct snd_soc_dai *dai,
a5479e38
DR		 298 unsigned int tx_mask, unsigned int rx_mask,
299 int slots, int slot_width);
472df3cb 300 int (*set_channel_map)(struct snd_soc_dai *dai,
965cc040
KK		 301 unsigned int tx_num, const unsigned int *tx_slot,
302 unsigned int rx_num, const unsigned int *rx_slot);
785d64c4 303 int (*get_channel_map)(const struct snd_soc_dai *dai,
467b061f
SK		 304 unsigned int *tx_num, unsigned int *tx_slot,
305 unsigned int *rx_num, unsigned int *rx_slot);
a47cbe72
MB		 306 int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
307
e8444560
PLB		 308 int (*set_stream)(struct snd_soc_dai *dai,
309 void *stream, int direction);
310 void *(*get_stream)(struct snd_soc_dai *dai, int direction);
36d73c4a 311
a47cbe72
MB		 312 /*
313 * DAI digital mute - optional.
314 * Called by soc-core to minimise any pops.
315 */
da18396f 316 int (*mute_stream)(struct snd_soc_dai *dai, int mute, int stream);
dee89c4d
MB		 317
318 /*
319 * ALSA PCM audio operations - all optional.
320 * Called by soc-core during audio PCM operations.
321 */
322 int (*startup)(struct snd_pcm_substream *,
323 struct snd_soc_dai *);
324 void (*shutdown)(struct snd_pcm_substream *,
325 struct snd_soc_dai *);
326 int (*hw_params)(struct snd_pcm_substream *,
327 struct snd_pcm_hw_params *, struct snd_soc_dai *);
328 int (*hw_free)(struct snd_pcm_substream *,
329 struct snd_soc_dai *);
330 int (*prepare)(struct snd_pcm_substream *,
331 struct snd_soc_dai *);
9f1614aa
MP		 332 /*
333 * NOTE: Commands passed to the trigger function are not necessarily
334 * compatible with the current state of the dai. For example this
335 * sequence of commands is possible: START STOP STOP.
336 * So do not unconditionally use refcounting functions in the trigger
337 * function, e.g. clk_enable/disable.
338 */
dee89c4d
MB		 339 int (*trigger)(struct snd_pcm_substream *, int,
340 struct snd_soc_dai *);
7d2fb381 341
258020d0
PU		 342 /*
343 * For hardware based FIFO caused delay reporting.
344 * Optional.
345 */
346 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
347 struct snd_soc_dai *);
350d9935 348
ba9e82a1
KM		 349 /*
350 * Format list for auto selection.
351 * Format will be increased if priority format was
352 * not selected.
353 * see
354 * snd_soc_dai_get_fmt()
355 */
d4a7d067 356 const u64 *auto_selectable_formats;
ba9e82a1
KM		 357 int num_auto_selectable_formats;
358
624fee45
KM		 359 /* probe ordering - for components with runtime dependencies */
360 int probe_order;
361 int remove_order;
362
350d9935
KM		 363 /* bit field */
364 unsigned int no_capture_mute:1;
f0220575 365 unsigned int mute_unmute_on_trigger:1;
a47cbe72
MB		 366};
367
2e622ae4
VK		 368struct snd_soc_cdai_ops {
369 /*
370 * for compress ops
371 */
372 int (*startup)(struct snd_compr_stream *,
373 struct snd_soc_dai *);
374 int (*shutdown)(struct snd_compr_stream *,
375 struct snd_soc_dai *);
376 int (*set_params)(struct snd_compr_stream *,
377 struct snd_compr_params *, struct snd_soc_dai *);
378 int (*get_params)(struct snd_compr_stream *,
379 struct snd_codec *, struct snd_soc_dai *);
380 int (*set_metadata)(struct snd_compr_stream *,
381 struct snd_compr_metadata *, struct snd_soc_dai *);
382 int (*get_metadata)(struct snd_compr_stream *,
383 struct snd_compr_metadata *, struct snd_soc_dai *);
384 int (*trigger)(struct snd_compr_stream *, int,
385 struct snd_soc_dai *);
386 int (*pointer)(struct snd_compr_stream *,
387 struct snd_compr_tstamp *, struct snd_soc_dai *);
388 int (*ack)(struct snd_compr_stream *, size_t,
389 struct snd_soc_dai *);
390};
391
a47cbe72 392/*
f0fba2ad 393 * Digital Audio Interface Driver.
a47cbe72 394 *
f0fba2ad
LG		 395 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
396 * operations and capabilities. Codec and platform drivers will register this
397 * structure for every DAI they have.
398 *
399 * This structure covers the clocking, formating and ALSA operations for each
400 * interface.
a47cbe72 401 */
f0fba2ad 402struct snd_soc_dai_driver {
a47cbe72 403 /* DAI description */
f0fba2ad 404 const char *name;
a47cbe72 405 unsigned int id;
62368294 406 unsigned int base;
68003e6c 407 struct snd_soc_dobj dobj;
2fbafecb 408 const struct of_phandle_args *dai_args;
a47cbe72 409
a47cbe72 410 /* ops */
1ee46ebd 411 const struct snd_soc_dai_ops *ops;
2e622ae4 412 const struct snd_soc_cdai_ops *cops;
a47cbe72
MB		 413
414 /* DAI capabilities */
415 struct snd_soc_pcm_stream capture;
416 struct snd_soc_pcm_stream playback;
f14654dd 417 unsigned int symmetric_rate:1;
3635bf09 418 unsigned int symmetric_channels:1;
f14654dd 419 unsigned int symmetric_sample_bits:1;
f0fba2ad
LG		 420};
421
3653480c
KM		 422/* for Playback/Capture */
423struct snd_soc_dai_stream {
424 struct snd_soc_dapm_widget *widget;
425
426 unsigned int active; /* usage count */
427 unsigned int tdm_mask; /* CODEC TDM slot masks and params (for fixup) */
428
429 void *dma_data; /* DAI DMA data */
430};
431
f0fba2ad
LG		 432/*
433 * Digital Audio Interface runtime data.
434 *
435 * Holds runtime data for a DAI.
436 */
437struct snd_soc_dai {
438 const char *name;
439 int id;
440 struct device *dev;
f0fba2ad
LG		 441
442 /* driver ops */
443 struct snd_soc_dai_driver *driver;
a47cbe72
MB		 444
445 /* DAI runtime info */
3653480c 446 struct snd_soc_dai_stream stream[SNDRV_PCM_STREAM_LAST + 1];
a47cbe72 447
17841020 448 /* Symmetry data - only valid if symmetry is being enforced */
1bd775da
KM		 449 unsigned int symmetric_rate;
450 unsigned int symmetric_channels;
451 unsigned int symmetric_sample_bits;
17841020 452
f0fba2ad 453 /* parent platform/codec */
6106d129 454 struct snd_soc_component *component;
2466ab97 455
a47cbe72 456 struct list_head list;
b56be800 457
00a0b46c
KM		 458 /* function mark */
459 struct snd_pcm_substream *mark_startup;
c304c9ac 460 struct snd_pcm_substream *mark_hw_params;
6374f493 461 struct snd_pcm_substream *mark_trigger;
1e6a93cf 462 struct snd_compr_stream *mark_compr_startup;
00a0b46c 463
b56be800
KM		 464 /* bit field */
465 unsigned int probed:1;
a47cbe72
MB		 466};
467
de267e7a 468static inline const struct snd_soc_pcm_stream *
acf253c1
KM		 469snd_soc_dai_get_pcm_stream(const struct snd_soc_dai *dai, int stream)
470{
471 return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
472 &dai->driver->playback : &dai->driver->capture;
473}
474
944d721e
KM		 475#define snd_soc_dai_get_widget_playback(dai) snd_soc_dai_get_widget(dai, SNDRV_PCM_STREAM_PLAYBACK)
476#define snd_soc_dai_get_widget_capture(dai) snd_soc_dai_get_widget(dai, SNDRV_PCM_STREAM_CAPTURE)
0c01f6ca 477static inline
37ed1236 478struct snd_soc_dapm_widget *snd_soc_dai_get_widget(struct snd_soc_dai *dai, int stream)
0c01f6ca 479{
3653480c 480 return dai->stream[stream].widget;
0c01f6ca
KM		 481}
482
944d721e
KM		 483#define snd_soc_dai_set_widget_playback(dai, widget) snd_soc_dai_set_widget(dai, SNDRV_PCM_STREAM_PLAYBACK, widget)
484#define snd_soc_dai_set_widget_capture(dai, widget) snd_soc_dai_set_widget(dai, SNDRV_PCM_STREAM_CAPTURE, widget)
37ed1236
KM		 485static inline
486void snd_soc_dai_set_widget(struct snd_soc_dai *dai, int stream, struct snd_soc_dapm_widget *widget)
487{
3653480c 488 dai->stream[stream].widget = widget;
37ed1236
KM		 489}
490
60df5935
KM		 491#define snd_soc_dai_dma_data_get_playback(dai) snd_soc_dai_dma_data_get(dai, SNDRV_PCM_STREAM_PLAYBACK)
492#define snd_soc_dai_dma_data_get_capture(dai) snd_soc_dai_dma_data_get(dai, SNDRV_PCM_STREAM_CAPTURE)
493#define snd_soc_dai_get_dma_data(dai, ss) snd_soc_dai_dma_data_get(dai, ss->stream)
494static inline void *snd_soc_dai_dma_data_get(const struct snd_soc_dai *dai, int stream)
fd23b7de 495{
3653480c 496 return dai->stream[stream].dma_data;
fd23b7de
DM		 497}
498
60df5935
KM		 499#define snd_soc_dai_dma_data_set_playback(dai, data) snd_soc_dai_dma_data_set(dai, SNDRV_PCM_STREAM_PLAYBACK, data)
500#define snd_soc_dai_dma_data_set_capture(dai, data) snd_soc_dai_dma_data_set(dai, SNDRV_PCM_STREAM_CAPTURE, data)
501#define snd_soc_dai_set_dma_data(dai, ss, data) snd_soc_dai_dma_data_set(dai, ss->stream, data)
502static inline void snd_soc_dai_dma_data_set(struct snd_soc_dai *dai, int stream, void *data)
fd23b7de 503{
3653480c 504 dai->stream[stream].dma_data = data;
f0fba2ad
LG		 505}
506
3653480c 507static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai, void *playback, void *capture)
ecfc0c04 508{
3653480c
KM		 509 snd_soc_dai_dma_data_set_playback(dai, playback);
510 snd_soc_dai_dma_data_set_capture(dai, capture);
ecfc0c04
MB		 511}
512
f3ac3da7
KK		 513static inline unsigned int snd_soc_dai_tdm_mask_get(const struct snd_soc_dai *dai,
514 int stream)
d4c0326e 515{
3653480c 516 return dai->stream[stream].tdm_mask;
d4c0326e
KM		 517}
518
519static inline void snd_soc_dai_tdm_mask_set(struct snd_soc_dai *dai, int stream,
520 unsigned int tdm_mask)
521{
3653480c
KM		 522 dai->stream[stream].tdm_mask = tdm_mask;
523}
524
f3ac3da7
KK		 525static inline unsigned int snd_soc_dai_stream_active(const struct snd_soc_dai *dai,
526 int stream)
3653480c
KM		 527{
528 /* see snd_soc_dai_action() for setup */
529 return dai->stream[stream].active;
d4c0326e
KM		 530}
531
f0fba2ad
LG		 532static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
533 void *data)
534{
535 dev_set_drvdata(dai->dev, data);
536}
537
538static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
539{
540 return dev_get_drvdata(dai->dev);
fd23b7de
DM		 541}
542
97349b60 543/**
e8444560 544 * snd_soc_dai_set_stream() - Configures a DAI for stream operation
97349b60 545 * @dai: DAI
e8444560 546 * @stream: STREAM (opaque structure depending on DAI type)
97349b60 547 * @direction: Stream direction(Playback/Capture)
e8444560 548 * Some subsystems, such as SoundWire, don't have a notion of direction and we reuse
97349b60
SN		 549 * the ASoC stream direction to configure sink/source ports.
550 * Playback maps to source ports and Capture for sink ports.
551 *
552 * This should be invoked with NULL to clear the stream set previously.
553 * Returns 0 on success, a negative error code otherwise.
554 */
e8444560
PLB		 555static inline int snd_soc_dai_set_stream(struct snd_soc_dai *dai,
556 void *stream, int direction)
97349b60 557{
e8444560
PLB		 558 if (dai->driver->ops->set_stream)
559 return dai->driver->ops->set_stream(dai, stream, direction);
97349b60
SN		 560 else
561 return -ENOTSUPP;
562}
563
36d73c4a 564/**
e8444560 565 * snd_soc_dai_get_stream() - Retrieves stream from DAI
36d73c4a
PLB		 566 * @dai: DAI
567 * @direction: Stream direction(Playback/Capture)
568 *
569 * This routine only retrieves that was previously configured
e8444560 570 * with snd_soc_dai_get_stream()
36d73c4a 571 *
d20e834e
PLB		 572 * Returns pointer to stream or an ERR_PTR value, e.g.
573 * ERR_PTR(-ENOTSUPP) if callback is not supported;
36d73c4a 574 */
e8444560
PLB		 575static inline void *snd_soc_dai_get_stream(struct snd_soc_dai *dai,
576 int direction)
36d73c4a 577{
e8444560
PLB		 578 if (dai->driver->ops->get_stream)
579 return dai->driver->ops->get_stream(dai, direction);
36d73c4a 580 else
308811a3 581 return ERR_PTR(-ENOTSUPP);
36d73c4a
PLB		 582}
583
a47cbe72 584#endif
Linux 6.x block layer and io_uring tree(s)