blob: 2df96b1384c718fdecc2a26d423a484dc5a9d727 [file] [log] [blame]
Mark Browna47cbe72008-07-23 14:03:07 +01001/*
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;
Mark Brown888df392012-02-16 19:37:51 -080020struct snd_soc_dapm_widget;
Vinod Koul49681072012-08-16 17:10:40 +053021struct snd_compr_stream;
Mark Browna47cbe72008-07-23 14:03:07 +010022
23/*
24 * DAI hardware audio formats.
25 *
26 * Describes the physical PCM data formating and clocking. Add new formats
27 * to the end.
28 */
Mark Brown75d9ac42011-09-27 16:41:01 +010029#define SND_SOC_DAIFMT_I2S 1 /* I2S mode */
30#define SND_SOC_DAIFMT_RIGHT_J 2 /* Right Justified mode */
31#define SND_SOC_DAIFMT_LEFT_J 3 /* Left Justified mode */
32#define SND_SOC_DAIFMT_DSP_A 4 /* L data MSB after FRM LRC */
33#define SND_SOC_DAIFMT_DSP_B 5 /* L data MSB during FRM LRC */
34#define SND_SOC_DAIFMT_AC97 6 /* AC97 */
35#define SND_SOC_DAIFMT_PDM 7 /* Pulse density modulation */
Mark Browna47cbe72008-07-23 14:03:07 +010036
37/* left and right justified also known as MSB and LSB respectively */
38#define SND_SOC_DAIFMT_MSB SND_SOC_DAIFMT_LEFT_J
39#define SND_SOC_DAIFMT_LSB SND_SOC_DAIFMT_RIGHT_J
40
41/*
42 * DAI Clock gating.
43 *
Peter Meerwald47db8e82009-07-13 23:05:11 +010044 * DAI bit clocks can be be gated (disabled) when the DAI is not
Mark Browna47cbe72008-07-23 14:03:07 +010045 * sending or receiving PCM data in a frame. This can be used to save power.
46 */
Mark Brown75d9ac42011-09-27 16:41:01 +010047#define SND_SOC_DAIFMT_CONT (1 << 4) /* continuous clock */
Kuninori Morimotoeef28e102013-01-29 21:03:13 -080048#define SND_SOC_DAIFMT_GATED (0 << 4) /* clock is gated */
Mark Browna47cbe72008-07-23 14:03:07 +010049
50/*
Mark Browna47cbe72008-07-23 14:03:07 +010051 * DAI hardware signal inversions.
52 *
53 * Specifies whether the DAI can also support inverted clocks for the specified
54 * format.
55 */
Kuninori Morimoto5d163332013-01-15 20:18:23 -080056#define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */
Mark Brown75d9ac42011-09-27 16:41:01 +010057#define SND_SOC_DAIFMT_NB_IF (2 << 8) /* normal BCLK + inv FRM */
58#define SND_SOC_DAIFMT_IB_NF (3 << 8) /* invert BCLK + nor FRM */
59#define SND_SOC_DAIFMT_IB_IF (4 << 8) /* invert BCLK + FRM */
Mark Browna47cbe72008-07-23 14:03:07 +010060
61/*
62 * DAI hardware clock masters.
63 *
64 * This is wrt the codec, the inverse is true for the interface
Peter Meerwald47db8e82009-07-13 23:05:11 +010065 * i.e. if the codec is clk and FRM master then the interface is
Mark Browna47cbe72008-07-23 14:03:07 +010066 * clk and frame slave.
67 */
Mark Brown75d9ac42011-09-27 16:41:01 +010068#define SND_SOC_DAIFMT_CBM_CFM (1 << 12) /* codec clk & FRM master */
69#define SND_SOC_DAIFMT_CBS_CFM (2 << 12) /* codec clk slave & FRM master */
70#define SND_SOC_DAIFMT_CBM_CFS (3 << 12) /* codec clk master & frame slave */
71#define SND_SOC_DAIFMT_CBS_CFS (4 << 12) /* codec clk & FRM slave */
Mark Browna47cbe72008-07-23 14:03:07 +010072
73#define SND_SOC_DAIFMT_FORMAT_MASK 0x000f
74#define SND_SOC_DAIFMT_CLOCK_MASK 0x00f0
75#define SND_SOC_DAIFMT_INV_MASK 0x0f00
76#define SND_SOC_DAIFMT_MASTER_MASK 0xf000
77
78/*
79 * Master Clock Directions
80 */
81#define SND_SOC_CLOCK_IN 0
82#define SND_SOC_CLOCK_OUT 1
83
Mark Brown8f738d52009-08-09 20:08:31 +010084#define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\
85 SNDRV_PCM_FMTBIT_S16_LE |\
86 SNDRV_PCM_FMTBIT_S16_BE |\
87 SNDRV_PCM_FMTBIT_S20_3LE |\
88 SNDRV_PCM_FMTBIT_S20_3BE |\
89 SNDRV_PCM_FMTBIT_S24_3LE |\
90 SNDRV_PCM_FMTBIT_S24_3BE |\
Jon Smirld34c4302009-05-13 21:59:14 -040091 SNDRV_PCM_FMTBIT_S32_LE |\
92 SNDRV_PCM_FMTBIT_S32_BE)
Mark Brown33f503c2009-05-02 12:24:55 +010093
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000094struct snd_soc_dai_driver;
Mark Browna47cbe72008-07-23 14:03:07 +010095struct snd_soc_dai;
96struct snd_ac97_bus_ops;
97
98/* Digital Audio Interface clocking API.*/
99int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
100 unsigned int freq, int dir);
101
102int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
103 int div_id, int div);
104
105int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
Mark Brown85488032009-09-05 18:52:16 +0100106 int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
Mark Browna47cbe72008-07-23 14:03:07 +0100107
Liam Girdwoode54cf762013-09-16 13:01:46 +0100108int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio);
109
Mark Browna47cbe72008-07-23 14:03:07 +0100110/* Digital Audio interface formatting */
111int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
112
113int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
Daniel Ribeiroa5479e32009-06-15 21:44:31 -0300114 unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
Mark Browna47cbe72008-07-23 14:03:07 +0100115
Barry Song472df3c2009-09-12 01:16:29 +0800116int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
117 unsigned int tx_num, unsigned int *tx_slot,
118 unsigned int rx_num, unsigned int *rx_slot);
119
Mark Browna47cbe72008-07-23 14:03:07 +0100120int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
121
122/* Digital Audio Interface mute */
Mark Brownda183962013-02-06 15:44:07 +0000123int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
124 int direction);
Mark Browna47cbe72008-07-23 14:03:07 +0100125
Liam Girdwoodbece9e92014-01-08 10:40:18 +0000126int snd_soc_dai_is_dummy(struct snd_soc_dai *dai);
127
Mark Browna47cbe72008-07-23 14:03:07 +0100128struct snd_soc_dai_ops {
129 /*
130 * DAI clocking configuration, all optional.
131 * Called by soc_card drivers, normally in their hw_params.
132 */
133 int (*set_sysclk)(struct snd_soc_dai *dai,
134 int clk_id, unsigned int freq, int dir);
Mark Brown85488032009-09-05 18:52:16 +0100135 int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
136 unsigned int freq_in, unsigned int freq_out);
Mark Browna47cbe72008-07-23 14:03:07 +0100137 int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
Liam Girdwoode54cf762013-09-16 13:01:46 +0100138 int (*set_bclk_ratio)(struct snd_soc_dai *dai, unsigned int ratio);
Mark Browna47cbe72008-07-23 14:03:07 +0100139
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);
Xiubo Lie5c21512014-03-21 14:17:12 +0800145 int (*xlate_tdm_slot_mask)(unsigned int slots,
Xiubo Li89c67852014-02-14 09:34:35 +0800146 unsigned int *tx_mask, unsigned int *rx_mask);
Mark Browna47cbe72008-07-23 14:03:07 +0100147 int (*set_tdm_slot)(struct snd_soc_dai *dai,
Daniel Ribeiroa5479e32009-06-15 21:44:31 -0300148 unsigned int tx_mask, unsigned int rx_mask,
149 int slots, int slot_width);
Barry Song472df3c2009-09-12 01:16:29 +0800150 int (*set_channel_map)(struct snd_soc_dai *dai,
151 unsigned int tx_num, unsigned int *tx_slot,
152 unsigned int rx_num, unsigned int *rx_slot);
Mark Browna47cbe72008-07-23 14:03:07 +0100153 int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
154
155 /*
156 * DAI digital mute - optional.
157 * Called by soc-core to minimise any pops.
158 */
159 int (*digital_mute)(struct snd_soc_dai *dai, int mute);
Mark Brownda183962013-02-06 15:44:07 +0000160 int (*mute_stream)(struct snd_soc_dai *dai, int mute, int stream);
Mark Browndee89c42008-11-18 22:11:38 +0000161
162 /*
163 * ALSA PCM audio operations - all optional.
164 * Called by soc-core during audio PCM operations.
165 */
166 int (*startup)(struct snd_pcm_substream *,
167 struct snd_soc_dai *);
168 void (*shutdown)(struct snd_pcm_substream *,
169 struct snd_soc_dai *);
170 int (*hw_params)(struct snd_pcm_substream *,
171 struct snd_pcm_hw_params *, struct snd_soc_dai *);
172 int (*hw_free)(struct snd_pcm_substream *,
173 struct snd_soc_dai *);
174 int (*prepare)(struct snd_pcm_substream *,
175 struct snd_soc_dai *);
Markus Pargmann9f1614a2013-10-11 12:11:02 +0200176 /*
177 * NOTE: Commands passed to the trigger function are not necessarily
178 * compatible with the current state of the dai. For example this
179 * sequence of commands is possible: START STOP STOP.
180 * So do not unconditionally use refcounting functions in the trigger
181 * function, e.g. clk_enable/disable.
182 */
Mark Browndee89c42008-11-18 22:11:38 +0000183 int (*trigger)(struct snd_pcm_substream *, int,
184 struct snd_soc_dai *);
Liam Girdwood07bf84a2012-04-25 12:12:52 +0100185 int (*bespoke_trigger)(struct snd_pcm_substream *, int,
186 struct snd_soc_dai *);
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200187 /*
188 * For hardware based FIFO caused delay reporting.
189 * Optional.
190 */
191 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
192 struct snd_soc_dai *);
Mark Browna47cbe72008-07-23 14:03:07 +0100193};
194
195/*
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000196 * Digital Audio Interface Driver.
Mark Browna47cbe72008-07-23 14:03:07 +0100197 *
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000198 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
199 * operations and capabilities. Codec and platform drivers will register this
200 * structure for every DAI they have.
201 *
202 * This structure covers the clocking, formating and ALSA operations for each
203 * interface.
Mark Browna47cbe72008-07-23 14:03:07 +0100204 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000205struct snd_soc_dai_driver {
Mark Browna47cbe72008-07-23 14:03:07 +0100206 /* DAI description */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000207 const char *name;
Mark Browna47cbe72008-07-23 14:03:07 +0100208 unsigned int id;
Mark Brown62368292012-05-01 20:03:32 +0100209 unsigned int base;
Mark Browna47cbe72008-07-23 14:03:07 +0100210
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000211 /* DAI driver callbacks */
212 int (*probe)(struct snd_soc_dai *dai);
213 int (*remove)(struct snd_soc_dai *dai);
Mark Browndc7d7b82008-12-03 18:21:52 +0000214 int (*suspend)(struct snd_soc_dai *dai);
215 int (*resume)(struct snd_soc_dai *dai);
Vinod Koul49681072012-08-16 17:10:40 +0530216 /* compress dai */
217 bool compress_dai;
Lars-Peter Clausenbc263212014-11-10 22:41:52 +0100218 /* DAI is also used for the control bus */
219 bool bus_control;
Mark Browna47cbe72008-07-23 14:03:07 +0100220
221 /* ops */
Mark Brown1ee46eb2010-12-02 16:10:09 +0000222 const struct snd_soc_dai_ops *ops;
Mark Browna47cbe72008-07-23 14:03:07 +0100223
224 /* DAI capabilities */
225 struct snd_soc_pcm_stream capture;
226 struct snd_soc_pcm_stream playback;
Mark Brown06f409d2009-04-07 18:10:13 +0100227 unsigned int symmetric_rates:1;
Nicolin Chen3635bf02013-11-13 18:56:24 +0800228 unsigned int symmetric_channels:1;
229 unsigned int symmetric_samplebits:1;
Liam Girdwood0168bf02011-06-07 16:08:05 +0100230
231 /* probe ordering - for components with runtime dependencies */
232 int probe_order;
233 int remove_order;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000234};
235
236/*
237 * Digital Audio Interface runtime data.
238 *
239 * Holds runtime data for a DAI.
240 */
241struct snd_soc_dai {
242 const char *name;
243 int id;
244 struct device *dev;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000245
246 /* driver ops */
247 struct snd_soc_dai_driver *driver;
Mark Browna47cbe72008-07-23 14:03:07 +0100248
249 /* DAI runtime info */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000250 unsigned int capture_active:1; /* stream is in use */
251 unsigned int playback_active:1; /* stream is in use */
252 unsigned int symmetric_rates:1;
Nicolin Chen3635bf02013-11-13 18:56:24 +0800253 unsigned int symmetric_channels:1;
254 unsigned int symmetric_samplebits:1;
Mark Browna47cbe72008-07-23 14:03:07 +0100255 unsigned int active;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000256 unsigned char probed:1;
Mark Browna47cbe72008-07-23 14:03:07 +0100257
Mark Brown888df392012-02-16 19:37:51 -0800258 struct snd_soc_dapm_widget *playback_widget;
259 struct snd_soc_dapm_widget *capture_widget;
260
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000261 /* DAI DMA data */
262 void *playback_dma_data;
263 void *capture_dma_data;
Mark Browna47cbe72008-07-23 14:03:07 +0100264
Dong Aisheng17841022011-08-29 17:15:14 +0800265 /* Symmetry data - only valid if symmetry is being enforced */
266 unsigned int rate;
Nicolin Chen3635bf02013-11-13 18:56:24 +0800267 unsigned int channels;
268 unsigned int sample_bits;
Dong Aisheng17841022011-08-29 17:15:14 +0800269
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000270 /* parent platform/codec */
Mark Brown2466ab92012-03-02 16:18:30 +0000271 struct snd_soc_codec *codec;
Lars-Peter Clausen6106d122014-03-05 13:17:46 +0100272 struct snd_soc_component *component;
Mark Brown2466ab92012-03-02 16:18:30 +0000273
Benoit Cousson88bd8702014-07-08 23:19:34 +0200274 /* CODEC TDM slot masks and params (for fixup) */
275 unsigned int tx_mask;
276 unsigned int rx_mask;
277
Mark Browna47cbe72008-07-23 14:03:07 +0100278 struct list_head list;
279};
280
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000281static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
282 const struct snd_pcm_substream *ss)
283{
284 return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000285 dai->playback_dma_data : dai->capture_dma_data;
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000286}
287
288static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
289 const struct snd_pcm_substream *ss,
290 void *data)
291{
292 if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000293 dai->playback_dma_data = data;
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000294 else
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000295 dai->capture_dma_data = data;
296}
297
Mark Brownecfc0c02013-10-17 21:13:19 +0100298static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai,
299 void *playback, void *capture)
300{
301 dai->playback_dma_data = playback;
302 dai->capture_dma_data = capture;
303}
304
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000305static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
306 void *data)
307{
308 dev_set_drvdata(dai->dev, data);
309}
310
311static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
312{
313 return dev_get_drvdata(dai->dev);
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000314}
315
Mark Browna47cbe72008-07-23 14:03:07 +0100316#endif