Loading...
1/*
2 * linux/sound/soc-dai.h -- ALSA SoC Layer
3 *
4 * Copyright: 2005-2008 Wolfson Microelectronics. PLC.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 *
10 * Digital Audio Interface (DAI) API.
11 */
12
13#ifndef __LINUX_SND_SOC_DAI_H
14#define __LINUX_SND_SOC_DAI_H
15
16
17#include <linux/list.h>
18
19struct snd_pcm_substream;
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 */
27#define SND_SOC_DAIFMT_I2S 0 /* I2S mode */
28#define SND_SOC_DAIFMT_RIGHT_J 1 /* Right Justified mode */
29#define SND_SOC_DAIFMT_LEFT_J 2 /* Left Justified mode */
30#define SND_SOC_DAIFMT_DSP_A 3 /* L data MSB after FRM LRC */
31#define SND_SOC_DAIFMT_DSP_B 4 /* L data MSB during FRM LRC */
32#define SND_SOC_DAIFMT_AC97 5 /* AC97 */
33#define SND_SOC_DAIFMT_PDM 6 /* Pulse density modulation */
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 *
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.
44 */
45#define SND_SOC_DAIFMT_CONT (0 << 4) /* continuous clock */
46#define SND_SOC_DAIFMT_GATED (1 << 4) /* clock is gated */
47
48/*
49 * DAI hardware signal inversions.
50 *
51 * Specifies whether the DAI can also support inverted clocks for the specified
52 * format.
53 */
54#define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */
55#define SND_SOC_DAIFMT_NB_IF (1 << 8) /* normal BCLK + inv FRM */
56#define SND_SOC_DAIFMT_IB_NF (2 << 8) /* invert BCLK + nor FRM */
57#define SND_SOC_DAIFMT_IB_IF (3 << 8) /* invert BCLK + FRM */
58
59/*
60 * DAI hardware clock masters.
61 *
62 * This is wrt the codec, the inverse is true for the interface
63 * i.e. if the codec is clk and FRM master then the interface is
64 * clk and frame slave.
65 */
66#define SND_SOC_DAIFMT_CBM_CFM (0 << 12) /* codec clk & FRM master */
67#define SND_SOC_DAIFMT_CBS_CFM (1 << 12) /* codec clk slave & FRM master */
68#define SND_SOC_DAIFMT_CBM_CFS (2 << 12) /* codec clk master & frame slave */
69#define SND_SOC_DAIFMT_CBS_CFS (3 << 12) /* codec clk & FRM slave */
70
71#define SND_SOC_DAIFMT_FORMAT_MASK 0x000f
72#define SND_SOC_DAIFMT_CLOCK_MASK 0x00f0
73#define SND_SOC_DAIFMT_INV_MASK 0x0f00
74#define SND_SOC_DAIFMT_MASTER_MASK 0xf000
75
76/*
77 * Master Clock Directions
78 */
79#define SND_SOC_CLOCK_IN 0
80#define SND_SOC_CLOCK_OUT 1
81
82#define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\
83 SNDRV_PCM_FMTBIT_S16_LE |\
84 SNDRV_PCM_FMTBIT_S16_BE |\
85 SNDRV_PCM_FMTBIT_S20_3LE |\
86 SNDRV_PCM_FMTBIT_S20_3BE |\
87 SNDRV_PCM_FMTBIT_S24_3LE |\
88 SNDRV_PCM_FMTBIT_S24_3BE |\
89 SNDRV_PCM_FMTBIT_S32_LE |\
90 SNDRV_PCM_FMTBIT_S32_BE)
91
92struct snd_soc_dai_driver;
93struct snd_soc_dai;
94struct snd_ac97_bus_ops;
95
96/* Digital Audio Interface registration */
97int snd_soc_register_dai(struct device *dev,
98 struct snd_soc_dai_driver *dai_drv);
99void snd_soc_unregister_dai(struct device *dev);
100int snd_soc_register_dais(struct device *dev,
101 struct snd_soc_dai_driver *dai_drv, size_t count);
102void snd_soc_unregister_dais(struct device *dev, size_t count);
103
104/* Digital Audio Interface clocking API.*/
105int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
106 unsigned int freq, int dir);
107
108int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
109 int div_id, int div);
110
111int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
112 int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
113
114/* Digital Audio interface formatting */
115int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
116
117int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
118 unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
119
120int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
121 unsigned int tx_num, unsigned int *tx_slot,
122 unsigned int rx_num, unsigned int *rx_slot);
123
124int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
125
126/* Digital Audio Interface mute */
127int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute);
128
129struct snd_soc_dai_ops {
130 /*
131 * DAI clocking configuration, all optional.
132 * Called by soc_card drivers, normally in their hw_params.
133 */
134 int (*set_sysclk)(struct snd_soc_dai *dai,
135 int clk_id, unsigned int freq, int dir);
136 int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
137 unsigned int freq_in, unsigned int freq_out);
138 int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
139
140 /*
141 * DAI format configuration
142 * Called by soc_card drivers, normally in their hw_params.
143 */
144 int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
145 int (*set_tdm_slot)(struct snd_soc_dai *dai,
146 unsigned int tx_mask, unsigned int rx_mask,
147 int slots, int slot_width);
148 int (*set_channel_map)(struct snd_soc_dai *dai,
149 unsigned int tx_num, unsigned int *tx_slot,
150 unsigned int rx_num, unsigned int *rx_slot);
151 int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
152
153 /*
154 * DAI digital mute - optional.
155 * Called by soc-core to minimise any pops.
156 */
157 int (*digital_mute)(struct snd_soc_dai *dai, int mute);
158
159 /*
160 * ALSA PCM audio operations - all optional.
161 * Called by soc-core during audio PCM operations.
162 */
163 int (*startup)(struct snd_pcm_substream *,
164 struct snd_soc_dai *);
165 void (*shutdown)(struct snd_pcm_substream *,
166 struct snd_soc_dai *);
167 int (*hw_params)(struct snd_pcm_substream *,
168 struct snd_pcm_hw_params *, struct snd_soc_dai *);
169 int (*hw_free)(struct snd_pcm_substream *,
170 struct snd_soc_dai *);
171 int (*prepare)(struct snd_pcm_substream *,
172 struct snd_soc_dai *);
173 int (*trigger)(struct snd_pcm_substream *, int,
174 struct snd_soc_dai *);
175 /*
176 * For hardware based FIFO caused delay reporting.
177 * Optional.
178 */
179 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
180 struct snd_soc_dai *);
181};
182
183/*
184 * Digital Audio Interface Driver.
185 *
186 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
187 * operations and capabilities. Codec and platform drivers will register this
188 * structure for every DAI they have.
189 *
190 * This structure covers the clocking, formating and ALSA operations for each
191 * interface.
192 */
193struct snd_soc_dai_driver {
194 /* DAI description */
195 const char *name;
196 unsigned int id;
197 int ac97_control;
198
199 /* DAI driver callbacks */
200 int (*probe)(struct snd_soc_dai *dai);
201 int (*remove)(struct snd_soc_dai *dai);
202 int (*suspend)(struct snd_soc_dai *dai);
203 int (*resume)(struct snd_soc_dai *dai);
204
205 /* ops */
206 const struct snd_soc_dai_ops *ops;
207
208 /* DAI capabilities */
209 struct snd_soc_pcm_stream capture;
210 struct snd_soc_pcm_stream playback;
211 unsigned int symmetric_rates:1;
212
213 /* probe ordering - for components with runtime dependencies */
214 int probe_order;
215 int remove_order;
216};
217
218/*
219 * Digital Audio Interface runtime data.
220 *
221 * Holds runtime data for a DAI.
222 */
223struct snd_soc_dai {
224 const char *name;
225 int id;
226 struct device *dev;
227 void *ac97_pdata; /* platform_data for the ac97 codec */
228
229 /* driver ops */
230 struct snd_soc_dai_driver *driver;
231
232 /* DAI runtime info */
233 unsigned int capture_active:1; /* stream is in use */
234 unsigned int playback_active:1; /* stream is in use */
235 unsigned int symmetric_rates:1;
236 struct snd_pcm_runtime *runtime;
237 unsigned int active;
238 unsigned char pop_wait:1;
239 unsigned char probed:1;
240
241 /* DAI DMA data */
242 void *playback_dma_data;
243 void *capture_dma_data;
244
245 /* parent platform/codec */
246 union {
247 struct snd_soc_platform *platform;
248 struct snd_soc_codec *codec;
249 };
250 struct snd_soc_card *card;
251
252 struct list_head list;
253 struct list_head card_list;
254};
255
256static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
257 const struct snd_pcm_substream *ss)
258{
259 return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
260 dai->playback_dma_data : dai->capture_dma_data;
261}
262
263static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
264 const struct snd_pcm_substream *ss,
265 void *data)
266{
267 if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
268 dai->playback_dma_data = data;
269 else
270 dai->capture_dma_data = data;
271}
272
273static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
274 void *data)
275{
276 dev_set_drvdata(dai->dev, data);
277}
278
279static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
280{
281 return dev_get_drvdata(dai->dev);
282}
283
284#endif
1/* SPDX-License-Identifier: GPL-2.0
2 *
3 * linux/sound/soc-dai.h -- ALSA SoC Layer
4 *
5 * Copyright: 2005-2008 Wolfson Microelectronics. PLC.
6 *
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>
15#include <sound/asoc.h>
16
17struct snd_pcm_substream;
18struct snd_soc_dapm_widget;
19struct snd_compr_stream;
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 */
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
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/* 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
55/*
56 * DAI Clock gating.
57 *
58 * DAI bit clocks can be gated (disabled) when the DAI is not
59 * sending or receiving PCM data in a frame. This can be used to save power.
60 */
61#define SND_SOC_DAIFMT_CONT (1 << 4) /* continuous clock */
62#define SND_SOC_DAIFMT_GATED (0 << 4) /* clock is gated */
63
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
75/*
76 * DAI hardware signal polarity.
77 *
78 * Specifies whether the DAI can also support inverted clocks for the specified
79 * format.
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.
95 */
96#define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */
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 */
100
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
109/*
110 * DAI hardware clock providers/consumers
111 *
112 * This is wrt the codec, the inverse is true for the interface
113 * i.e. if the codec is clk and FRM provider then the interface is
114 * clk and frame consumer.
115 */
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 */
119#define SND_SOC_DAIFMT_CBC_CFC (4 << 12) /* codec clk consumer & frame consumer */
120
121/* 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
127/* when passed to set_fmt directly indicate if the device is provider or consumer */
128#define SND_SOC_DAIFMT_BP_FP SND_SOC_DAIFMT_CBP_CFP
129#define SND_SOC_DAIFMT_BC_FP SND_SOC_DAIFMT_CBC_CFP
130#define SND_SOC_DAIFMT_BP_FC SND_SOC_DAIFMT_CBP_CFC
131#define SND_SOC_DAIFMT_BC_FC SND_SOC_DAIFMT_CBC_CFC
132
133/* Describes the possible PCM format */
134#define SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT 48
135#define SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_MASK (0xFFFFULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
136#define SND_SOC_POSSIBLE_DAIFMT_CBP_CFP (0x1ULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
137#define SND_SOC_POSSIBLE_DAIFMT_CBC_CFP (0x2ULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
138#define SND_SOC_POSSIBLE_DAIFMT_CBP_CFC (0x4ULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
139#define SND_SOC_POSSIBLE_DAIFMT_CBC_CFC (0x8ULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
140
141#define SND_SOC_DAIFMT_FORMAT_MASK 0x000f
142#define SND_SOC_DAIFMT_CLOCK_MASK 0x00f0
143#define SND_SOC_DAIFMT_INV_MASK 0x0f00
144#define SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK 0xf000
145
146#define SND_SOC_DAIFMT_MASTER_MASK SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK
147
148/*
149 * Master Clock Directions
150 */
151#define SND_SOC_CLOCK_IN 0
152#define SND_SOC_CLOCK_OUT 1
153
154#define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\
155 SNDRV_PCM_FMTBIT_S16_LE |\
156 SNDRV_PCM_FMTBIT_S16_BE |\
157 SNDRV_PCM_FMTBIT_S20_3LE |\
158 SNDRV_PCM_FMTBIT_S20_3BE |\
159 SNDRV_PCM_FMTBIT_S20_LE |\
160 SNDRV_PCM_FMTBIT_S20_BE |\
161 SNDRV_PCM_FMTBIT_S24_3LE |\
162 SNDRV_PCM_FMTBIT_S24_3BE |\
163 SNDRV_PCM_FMTBIT_S32_LE |\
164 SNDRV_PCM_FMTBIT_S32_BE)
165
166struct snd_soc_dai_driver;
167struct snd_soc_dai;
168struct snd_ac97_bus_ops;
169
170/* Digital Audio Interface clocking API.*/
171int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
172 unsigned int freq, int dir);
173
174int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
175 int div_id, int div);
176
177int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
178 int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
179
180int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio);
181
182/* Digital Audio interface formatting */
183int snd_soc_dai_get_fmt_max_priority(struct snd_soc_pcm_runtime *rtd);
184u64 snd_soc_dai_get_fmt(struct snd_soc_dai *dai, int priority);
185int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
186
187int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
188 unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
189
190int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
191 unsigned int tx_num, unsigned int *tx_slot,
192 unsigned int rx_num, unsigned int *rx_slot);
193
194int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
195
196/* Digital Audio Interface mute */
197int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
198 int direction);
199
200
201int snd_soc_dai_get_channel_map(struct snd_soc_dai *dai,
202 unsigned int *tx_num, unsigned int *tx_slot,
203 unsigned int *rx_num, unsigned int *rx_slot);
204
205int snd_soc_dai_is_dummy(struct snd_soc_dai *dai);
206
207int snd_soc_dai_hw_params(struct snd_soc_dai *dai,
208 struct snd_pcm_substream *substream,
209 struct snd_pcm_hw_params *params);
210void snd_soc_dai_hw_free(struct snd_soc_dai *dai,
211 struct snd_pcm_substream *substream,
212 int rollback);
213int snd_soc_dai_startup(struct snd_soc_dai *dai,
214 struct snd_pcm_substream *substream);
215void snd_soc_dai_shutdown(struct snd_soc_dai *dai,
216 struct snd_pcm_substream *substream, int rollback);
217void snd_soc_dai_suspend(struct snd_soc_dai *dai);
218void snd_soc_dai_resume(struct snd_soc_dai *dai);
219int snd_soc_dai_compress_new(struct snd_soc_dai *dai,
220 struct snd_soc_pcm_runtime *rtd, int num);
221bool snd_soc_dai_stream_valid(struct snd_soc_dai *dai, int stream);
222void snd_soc_dai_link_set_capabilities(struct snd_soc_dai_link *dai_link);
223void snd_soc_dai_action(struct snd_soc_dai *dai,
224 int stream, int action);
225static inline void snd_soc_dai_activate(struct snd_soc_dai *dai,
226 int stream)
227{
228 snd_soc_dai_action(dai, stream, 1);
229}
230static inline void snd_soc_dai_deactivate(struct snd_soc_dai *dai,
231 int stream)
232{
233 snd_soc_dai_action(dai, stream, -1);
234}
235int snd_soc_dai_active(struct snd_soc_dai *dai);
236
237int snd_soc_pcm_dai_probe(struct snd_soc_pcm_runtime *rtd, int order);
238int snd_soc_pcm_dai_remove(struct snd_soc_pcm_runtime *rtd, int order);
239int snd_soc_pcm_dai_new(struct snd_soc_pcm_runtime *rtd);
240int snd_soc_pcm_dai_prepare(struct snd_pcm_substream *substream);
241int snd_soc_pcm_dai_trigger(struct snd_pcm_substream *substream, int cmd,
242 int rollback);
243int snd_soc_pcm_dai_bespoke_trigger(struct snd_pcm_substream *substream,
244 int cmd);
245void snd_soc_pcm_dai_delay(struct snd_pcm_substream *substream,
246 snd_pcm_sframes_t *cpu_delay, snd_pcm_sframes_t *codec_delay);
247
248int snd_soc_dai_compr_startup(struct snd_soc_dai *dai,
249 struct snd_compr_stream *cstream);
250void snd_soc_dai_compr_shutdown(struct snd_soc_dai *dai,
251 struct snd_compr_stream *cstream,
252 int rollback);
253int snd_soc_dai_compr_trigger(struct snd_soc_dai *dai,
254 struct snd_compr_stream *cstream, int cmd);
255int snd_soc_dai_compr_set_params(struct snd_soc_dai *dai,
256 struct snd_compr_stream *cstream,
257 struct snd_compr_params *params);
258int snd_soc_dai_compr_get_params(struct snd_soc_dai *dai,
259 struct snd_compr_stream *cstream,
260 struct snd_codec *params);
261int snd_soc_dai_compr_ack(struct snd_soc_dai *dai,
262 struct snd_compr_stream *cstream,
263 size_t bytes);
264int snd_soc_dai_compr_pointer(struct snd_soc_dai *dai,
265 struct snd_compr_stream *cstream,
266 struct snd_compr_tstamp *tstamp);
267int snd_soc_dai_compr_set_metadata(struct snd_soc_dai *dai,
268 struct snd_compr_stream *cstream,
269 struct snd_compr_metadata *metadata);
270int snd_soc_dai_compr_get_metadata(struct snd_soc_dai *dai,
271 struct snd_compr_stream *cstream,
272 struct snd_compr_metadata *metadata);
273
274struct snd_soc_dai_ops {
275 /*
276 * DAI clocking configuration, all optional.
277 * Called by soc_card drivers, normally in their hw_params.
278 */
279 int (*set_sysclk)(struct snd_soc_dai *dai,
280 int clk_id, unsigned int freq, int dir);
281 int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
282 unsigned int freq_in, unsigned int freq_out);
283 int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
284 int (*set_bclk_ratio)(struct snd_soc_dai *dai, unsigned int ratio);
285
286 /*
287 * DAI format configuration
288 * Called by soc_card drivers, normally in their hw_params.
289 */
290 int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
291 int (*xlate_tdm_slot_mask)(unsigned int slots,
292 unsigned int *tx_mask, unsigned int *rx_mask);
293 int (*set_tdm_slot)(struct snd_soc_dai *dai,
294 unsigned int tx_mask, unsigned int rx_mask,
295 int slots, int slot_width);
296 int (*set_channel_map)(struct snd_soc_dai *dai,
297 unsigned int tx_num, unsigned int *tx_slot,
298 unsigned int rx_num, unsigned int *rx_slot);
299 int (*get_channel_map)(struct snd_soc_dai *dai,
300 unsigned int *tx_num, unsigned int *tx_slot,
301 unsigned int *rx_num, unsigned int *rx_slot);
302 int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
303
304 int (*set_stream)(struct snd_soc_dai *dai,
305 void *stream, int direction);
306 void *(*get_stream)(struct snd_soc_dai *dai, int direction);
307
308 /*
309 * DAI digital mute - optional.
310 * Called by soc-core to minimise any pops.
311 */
312 int (*mute_stream)(struct snd_soc_dai *dai, int mute, int stream);
313
314 /*
315 * ALSA PCM audio operations - all optional.
316 * Called by soc-core during audio PCM operations.
317 */
318 int (*startup)(struct snd_pcm_substream *,
319 struct snd_soc_dai *);
320 void (*shutdown)(struct snd_pcm_substream *,
321 struct snd_soc_dai *);
322 int (*hw_params)(struct snd_pcm_substream *,
323 struct snd_pcm_hw_params *, struct snd_soc_dai *);
324 int (*hw_free)(struct snd_pcm_substream *,
325 struct snd_soc_dai *);
326 int (*prepare)(struct snd_pcm_substream *,
327 struct snd_soc_dai *);
328 /*
329 * NOTE: Commands passed to the trigger function are not necessarily
330 * compatible with the current state of the dai. For example this
331 * sequence of commands is possible: START STOP STOP.
332 * So do not unconditionally use refcounting functions in the trigger
333 * function, e.g. clk_enable/disable.
334 */
335 int (*trigger)(struct snd_pcm_substream *, int,
336 struct snd_soc_dai *);
337 int (*bespoke_trigger)(struct snd_pcm_substream *, int,
338 struct snd_soc_dai *);
339 /*
340 * For hardware based FIFO caused delay reporting.
341 * Optional.
342 */
343 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
344 struct snd_soc_dai *);
345
346 /*
347 * Format list for auto selection.
348 * Format will be increased if priority format was
349 * not selected.
350 * see
351 * snd_soc_dai_get_fmt()
352 */
353 u64 *auto_selectable_formats;
354 int num_auto_selectable_formats;
355
356 /* bit field */
357 unsigned int no_capture_mute:1;
358};
359
360struct snd_soc_cdai_ops {
361 /*
362 * for compress ops
363 */
364 int (*startup)(struct snd_compr_stream *,
365 struct snd_soc_dai *);
366 int (*shutdown)(struct snd_compr_stream *,
367 struct snd_soc_dai *);
368 int (*set_params)(struct snd_compr_stream *,
369 struct snd_compr_params *, struct snd_soc_dai *);
370 int (*get_params)(struct snd_compr_stream *,
371 struct snd_codec *, struct snd_soc_dai *);
372 int (*set_metadata)(struct snd_compr_stream *,
373 struct snd_compr_metadata *, struct snd_soc_dai *);
374 int (*get_metadata)(struct snd_compr_stream *,
375 struct snd_compr_metadata *, struct snd_soc_dai *);
376 int (*trigger)(struct snd_compr_stream *, int,
377 struct snd_soc_dai *);
378 int (*pointer)(struct snd_compr_stream *,
379 struct snd_compr_tstamp *, struct snd_soc_dai *);
380 int (*ack)(struct snd_compr_stream *, size_t,
381 struct snd_soc_dai *);
382};
383
384/*
385 * Digital Audio Interface Driver.
386 *
387 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
388 * operations and capabilities. Codec and platform drivers will register this
389 * structure for every DAI they have.
390 *
391 * This structure covers the clocking, formating and ALSA operations for each
392 * interface.
393 */
394struct snd_soc_dai_driver {
395 /* DAI description */
396 const char *name;
397 unsigned int id;
398 unsigned int base;
399 struct snd_soc_dobj dobj;
400
401 /* DAI driver callbacks */
402 int (*probe)(struct snd_soc_dai *dai);
403 int (*remove)(struct snd_soc_dai *dai);
404 /* compress dai */
405 int (*compress_new)(struct snd_soc_pcm_runtime *rtd, int num);
406 /* Optional Callback used at pcm creation*/
407 int (*pcm_new)(struct snd_soc_pcm_runtime *rtd,
408 struct snd_soc_dai *dai);
409
410 /* ops */
411 const struct snd_soc_dai_ops *ops;
412 const struct snd_soc_cdai_ops *cops;
413
414 /* DAI capabilities */
415 struct snd_soc_pcm_stream capture;
416 struct snd_soc_pcm_stream playback;
417 unsigned int symmetric_rate:1;
418 unsigned int symmetric_channels:1;
419 unsigned int symmetric_sample_bits:1;
420
421 /* probe ordering - for components with runtime dependencies */
422 int probe_order;
423 int remove_order;
424};
425
426/*
427 * Digital Audio Interface runtime data.
428 *
429 * Holds runtime data for a DAI.
430 */
431struct snd_soc_dai {
432 const char *name;
433 int id;
434 struct device *dev;
435
436 /* driver ops */
437 struct snd_soc_dai_driver *driver;
438
439 /* DAI runtime info */
440 unsigned int stream_active[SNDRV_PCM_STREAM_LAST + 1]; /* usage count */
441
442 struct snd_soc_dapm_widget *playback_widget;
443 struct snd_soc_dapm_widget *capture_widget;
444
445 /* DAI DMA data */
446 void *playback_dma_data;
447 void *capture_dma_data;
448
449 /* Symmetry data - only valid if symmetry is being enforced */
450 unsigned int rate;
451 unsigned int channels;
452 unsigned int sample_bits;
453
454 /* parent platform/codec */
455 struct snd_soc_component *component;
456
457 /* CODEC TDM slot masks and params (for fixup) */
458 unsigned int tx_mask;
459 unsigned int rx_mask;
460
461 struct list_head list;
462
463 /* function mark */
464 struct snd_pcm_substream *mark_startup;
465 struct snd_pcm_substream *mark_hw_params;
466 struct snd_pcm_substream *mark_trigger;
467 struct snd_compr_stream *mark_compr_startup;
468
469 /* bit field */
470 unsigned int probed:1;
471};
472
473static inline struct snd_soc_pcm_stream *
474snd_soc_dai_get_pcm_stream(const struct snd_soc_dai *dai, int stream)
475{
476 return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
477 &dai->driver->playback : &dai->driver->capture;
478}
479
480static inline
481struct snd_soc_dapm_widget *snd_soc_dai_get_widget(
482 struct snd_soc_dai *dai, int stream)
483{
484 return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
485 dai->playback_widget : dai->capture_widget;
486}
487
488static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
489 const struct snd_pcm_substream *ss)
490{
491 return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
492 dai->playback_dma_data : dai->capture_dma_data;
493}
494
495static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
496 const struct snd_pcm_substream *ss,
497 void *data)
498{
499 if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
500 dai->playback_dma_data = data;
501 else
502 dai->capture_dma_data = data;
503}
504
505static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai,
506 void *playback, void *capture)
507{
508 dai->playback_dma_data = playback;
509 dai->capture_dma_data = capture;
510}
511
512static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
513 void *data)
514{
515 dev_set_drvdata(dai->dev, data);
516}
517
518static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
519{
520 return dev_get_drvdata(dai->dev);
521}
522
523/**
524 * snd_soc_dai_set_stream() - Configures a DAI for stream operation
525 * @dai: DAI
526 * @stream: STREAM (opaque structure depending on DAI type)
527 * @direction: Stream direction(Playback/Capture)
528 * Some subsystems, such as SoundWire, don't have a notion of direction and we reuse
529 * the ASoC stream direction to configure sink/source ports.
530 * Playback maps to source ports and Capture for sink ports.
531 *
532 * This should be invoked with NULL to clear the stream set previously.
533 * Returns 0 on success, a negative error code otherwise.
534 */
535static inline int snd_soc_dai_set_stream(struct snd_soc_dai *dai,
536 void *stream, int direction)
537{
538 if (dai->driver->ops->set_stream)
539 return dai->driver->ops->set_stream(dai, stream, direction);
540 else
541 return -ENOTSUPP;
542}
543
544/**
545 * snd_soc_dai_get_stream() - Retrieves stream from DAI
546 * @dai: DAI
547 * @direction: Stream direction(Playback/Capture)
548 *
549 * This routine only retrieves that was previously configured
550 * with snd_soc_dai_get_stream()
551 *
552 * Returns pointer to stream or an ERR_PTR value, e.g.
553 * ERR_PTR(-ENOTSUPP) if callback is not supported;
554 */
555static inline void *snd_soc_dai_get_stream(struct snd_soc_dai *dai,
556 int direction)
557{
558 if (dai->driver->ops->get_stream)
559 return dai->driver->ops->get_stream(dai, direction);
560 else
561 return ERR_PTR(-ENOTSUPP);
562}
563
564static inline unsigned int
565snd_soc_dai_stream_active(struct snd_soc_dai *dai, int stream)
566{
567 return dai->stream_active[stream];
568}
569
570#endif