blob: 1f69e0af2941803ac4452ec509baccbbd2f05f92 [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;
Mark Browna47cbe72008-07-23 14:03:07 +010021
22/*
23 * DAI hardware audio formats.
24 *
25 * Describes the physical PCM data formating and clocking. Add new formats
26 * to the end.
27 */
Mark Brown75d9ac42011-09-27 16:41:01 +010028#define SND_SOC_DAIFMT_I2S 1 /* I2S mode */
29#define SND_SOC_DAIFMT_RIGHT_J 2 /* Right Justified mode */
30#define SND_SOC_DAIFMT_LEFT_J 3 /* Left Justified mode */
31#define SND_SOC_DAIFMT_DSP_A 4 /* L data MSB after FRM LRC */
32#define SND_SOC_DAIFMT_DSP_B 5 /* L data MSB during FRM LRC */
33#define SND_SOC_DAIFMT_AC97 6 /* AC97 */
34#define SND_SOC_DAIFMT_PDM 7 /* Pulse density modulation */
Mark Browna47cbe72008-07-23 14:03:07 +010035
36/* left and right justified also known as MSB and LSB respectively */
37#define SND_SOC_DAIFMT_MSB SND_SOC_DAIFMT_LEFT_J
38#define SND_SOC_DAIFMT_LSB SND_SOC_DAIFMT_RIGHT_J
39
40/*
41 * DAI Clock gating.
42 *
Peter Meerwald47db8e82009-07-13 23:05:11 +010043 * DAI bit clocks can be be gated (disabled) when the DAI is not
Mark Browna47cbe72008-07-23 14:03:07 +010044 * sending or receiving PCM data in a frame. This can be used to save power.
45 */
Mark Brown75d9ac42011-09-27 16:41:01 +010046#define SND_SOC_DAIFMT_CONT (1 << 4) /* continuous clock */
47#define SND_SOC_DAIFMT_GATED (2 << 4) /* clock is gated */
Mark Browna47cbe72008-07-23 14:03:07 +010048
49/*
Mark Browna47cbe72008-07-23 14:03:07 +010050 * DAI hardware signal inversions.
51 *
52 * Specifies whether the DAI can also support inverted clocks for the specified
53 * format.
54 */
Mark Brown75d9ac42011-09-27 16:41:01 +010055#define SND_SOC_DAIFMT_NB_NF (1 << 8) /* normal bit clock + frame */
56#define SND_SOC_DAIFMT_NB_IF (2 << 8) /* normal BCLK + inv FRM */
57#define SND_SOC_DAIFMT_IB_NF (3 << 8) /* invert BCLK + nor FRM */
58#define SND_SOC_DAIFMT_IB_IF (4 << 8) /* invert BCLK + FRM */
Mark Browna47cbe72008-07-23 14:03:07 +010059
60/*
61 * DAI hardware clock masters.
62 *
63 * This is wrt the codec, the inverse is true for the interface
Peter Meerwald47db8e82009-07-13 23:05:11 +010064 * i.e. if the codec is clk and FRM master then the interface is
Mark Browna47cbe72008-07-23 14:03:07 +010065 * clk and frame slave.
66 */
Mark Brown75d9ac42011-09-27 16:41:01 +010067#define SND_SOC_DAIFMT_CBM_CFM (1 << 12) /* codec clk & FRM master */
68#define SND_SOC_DAIFMT_CBS_CFM (2 << 12) /* codec clk slave & FRM master */
69#define SND_SOC_DAIFMT_CBM_CFS (3 << 12) /* codec clk master & frame slave */
70#define SND_SOC_DAIFMT_CBS_CFS (4 << 12) /* codec clk & FRM slave */
Mark Browna47cbe72008-07-23 14:03:07 +010071
72#define SND_SOC_DAIFMT_FORMAT_MASK 0x000f
73#define SND_SOC_DAIFMT_CLOCK_MASK 0x00f0
74#define SND_SOC_DAIFMT_INV_MASK 0x0f00
75#define SND_SOC_DAIFMT_MASTER_MASK 0xf000
76
77/*
78 * Master Clock Directions
79 */
80#define SND_SOC_CLOCK_IN 0
81#define SND_SOC_CLOCK_OUT 1
82
Mark Brown8f738d52009-08-09 20:08:31 +010083#define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\
84 SNDRV_PCM_FMTBIT_S16_LE |\
85 SNDRV_PCM_FMTBIT_S16_BE |\
86 SNDRV_PCM_FMTBIT_S20_3LE |\
87 SNDRV_PCM_FMTBIT_S20_3BE |\
88 SNDRV_PCM_FMTBIT_S24_3LE |\
89 SNDRV_PCM_FMTBIT_S24_3BE |\
Jon Smirld34c4302009-05-13 21:59:14 -040090 SNDRV_PCM_FMTBIT_S32_LE |\
91 SNDRV_PCM_FMTBIT_S32_BE)
Mark Brown33f503c2009-05-02 12:24:55 +010092
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000093struct snd_soc_dai_driver;
Mark Browna47cbe72008-07-23 14:03:07 +010094struct snd_soc_dai;
95struct snd_ac97_bus_ops;
96
Mark Brown91151712008-11-30 23:31:24 +000097/* Digital Audio Interface registration */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000098int snd_soc_register_dai(struct device *dev,
99 struct snd_soc_dai_driver *dai_drv);
100void snd_soc_unregister_dai(struct device *dev);
101int snd_soc_register_dais(struct device *dev,
102 struct snd_soc_dai_driver *dai_drv, size_t count);
103void snd_soc_unregister_dais(struct device *dev, size_t count);
Mark Brown91151712008-11-30 23:31:24 +0000104
Mark Browna47cbe72008-07-23 14:03:07 +0100105/* Digital Audio Interface clocking API.*/
106int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
107 unsigned int freq, int dir);
108
109int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
110 int div_id, int div);
111
112int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
Mark Brown85488032009-09-05 18:52:16 +0100113 int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
Mark Browna47cbe72008-07-23 14:03:07 +0100114
115/* Digital Audio interface formatting */
116int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
117
118int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
Daniel Ribeiroa5479e32009-06-15 21:44:31 -0300119 unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
Mark Browna47cbe72008-07-23 14:03:07 +0100120
Barry Song472df3c2009-09-12 01:16:29 +0800121int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
122 unsigned int tx_num, unsigned int *tx_slot,
123 unsigned int rx_num, unsigned int *rx_slot);
124
Mark Browna47cbe72008-07-23 14:03:07 +0100125int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
126
127/* Digital Audio Interface mute */
128int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute);
129
Mark Browna47cbe72008-07-23 14:03:07 +0100130struct snd_soc_dai_ops {
131 /*
132 * DAI clocking configuration, all optional.
133 * Called by soc_card drivers, normally in their hw_params.
134 */
135 int (*set_sysclk)(struct snd_soc_dai *dai,
136 int clk_id, unsigned int freq, int dir);
Mark Brown85488032009-09-05 18:52:16 +0100137 int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
138 unsigned int freq_in, unsigned int freq_out);
Mark Browna47cbe72008-07-23 14:03:07 +0100139 int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
140
141 /*
142 * DAI format configuration
143 * Called by soc_card drivers, normally in their hw_params.
144 */
145 int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
146 int (*set_tdm_slot)(struct snd_soc_dai *dai,
Daniel Ribeiroa5479e32009-06-15 21:44:31 -0300147 unsigned int tx_mask, unsigned int rx_mask,
148 int slots, int slot_width);
Barry Song472df3c2009-09-12 01:16:29 +0800149 int (*set_channel_map)(struct snd_soc_dai *dai,
150 unsigned int tx_num, unsigned int *tx_slot,
151 unsigned int rx_num, unsigned int *rx_slot);
Mark Browna47cbe72008-07-23 14:03:07 +0100152 int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
153
154 /*
155 * DAI digital mute - optional.
156 * Called by soc-core to minimise any pops.
157 */
158 int (*digital_mute)(struct snd_soc_dai *dai, int mute);
Mark Browndee89c42008-11-18 22:11:38 +0000159
160 /*
161 * ALSA PCM audio operations - all optional.
162 * Called by soc-core during audio PCM operations.
163 */
164 int (*startup)(struct snd_pcm_substream *,
165 struct snd_soc_dai *);
166 void (*shutdown)(struct snd_pcm_substream *,
167 struct snd_soc_dai *);
168 int (*hw_params)(struct snd_pcm_substream *,
169 struct snd_pcm_hw_params *, struct snd_soc_dai *);
170 int (*hw_free)(struct snd_pcm_substream *,
171 struct snd_soc_dai *);
172 int (*prepare)(struct snd_pcm_substream *,
173 struct snd_soc_dai *);
174 int (*trigger)(struct snd_pcm_substream *, int,
175 struct snd_soc_dai *);
Liam Girdwood07bf84a2012-04-25 12:12:52 +0100176 int (*bespoke_trigger)(struct snd_pcm_substream *, int,
177 struct snd_soc_dai *);
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200178 /*
179 * For hardware based FIFO caused delay reporting.
180 * Optional.
181 */
182 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
183 struct snd_soc_dai *);
Mark Browna47cbe72008-07-23 14:03:07 +0100184};
185
186/*
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000187 * Digital Audio Interface Driver.
Mark Browna47cbe72008-07-23 14:03:07 +0100188 *
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000189 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
190 * operations and capabilities. Codec and platform drivers will register this
191 * structure for every DAI they have.
192 *
193 * This structure covers the clocking, formating and ALSA operations for each
194 * interface.
Mark Browna47cbe72008-07-23 14:03:07 +0100195 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000196struct snd_soc_dai_driver {
Mark Browna47cbe72008-07-23 14:03:07 +0100197 /* DAI description */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000198 const char *name;
Mark Browna47cbe72008-07-23 14:03:07 +0100199 unsigned int id;
Mark Brown3ba9e10a2008-11-24 18:01:05 +0000200 int ac97_control;
Mark Brown62368292012-05-01 20:03:32 +0100201 unsigned int base;
Mark Browna47cbe72008-07-23 14:03:07 +0100202
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000203 /* DAI driver callbacks */
204 int (*probe)(struct snd_soc_dai *dai);
205 int (*remove)(struct snd_soc_dai *dai);
Mark Browndc7d7b82008-12-03 18:21:52 +0000206 int (*suspend)(struct snd_soc_dai *dai);
207 int (*resume)(struct snd_soc_dai *dai);
Mark Browna47cbe72008-07-23 14:03:07 +0100208
209 /* ops */
Mark Brown1ee46eb2010-12-02 16:10:09 +0000210 const struct snd_soc_dai_ops *ops;
Mark Browna47cbe72008-07-23 14:03:07 +0100211
212 /* DAI capabilities */
213 struct snd_soc_pcm_stream capture;
214 struct snd_soc_pcm_stream playback;
Mark Brown06f409d2009-04-07 18:10:13 +0100215 unsigned int symmetric_rates:1;
Liam Girdwood0168bf02011-06-07 16:08:05 +0100216
217 /* probe ordering - for components with runtime dependencies */
218 int probe_order;
219 int remove_order;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000220};
221
222/*
223 * Digital Audio Interface runtime data.
224 *
225 * Holds runtime data for a DAI.
226 */
227struct snd_soc_dai {
228 const char *name;
229 int id;
230 struct device *dev;
231 void *ac97_pdata; /* platform_data for the ac97 codec */
232
233 /* driver ops */
234 struct snd_soc_dai_driver *driver;
Mark Browna47cbe72008-07-23 14:03:07 +0100235
236 /* DAI runtime info */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000237 unsigned int capture_active:1; /* stream is in use */
238 unsigned int playback_active:1; /* stream is in use */
239 unsigned int symmetric_rates:1;
240 struct snd_pcm_runtime *runtime;
Mark Browna47cbe72008-07-23 14:03:07 +0100241 unsigned int active;
242 unsigned char pop_wait:1;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000243 unsigned char probed:1;
Mark Browna47cbe72008-07-23 14:03:07 +0100244
Mark Brown888df392012-02-16 19:37:51 -0800245 struct snd_soc_dapm_widget *playback_widget;
246 struct snd_soc_dapm_widget *capture_widget;
Liam Girdwoodbe09ad92012-03-07 11:47:41 +0000247 struct snd_soc_dapm_context dapm;
Mark Brown888df392012-02-16 19:37:51 -0800248
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000249 /* DAI DMA data */
250 void *playback_dma_data;
251 void *capture_dma_data;
Mark Browna47cbe72008-07-23 14:03:07 +0100252
Dong Aisheng17841022011-08-29 17:15:14 +0800253 /* Symmetry data - only valid if symmetry is being enforced */
254 unsigned int rate;
255
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000256 /* parent platform/codec */
Mark Brown2466ab92012-03-02 16:18:30 +0000257 struct snd_soc_platform *platform;
258 struct snd_soc_codec *codec;
259
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000260 struct snd_soc_card *card;
Mark Browna47cbe72008-07-23 14:03:07 +0100261
262 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000263 struct list_head card_list;
Mark Browna47cbe72008-07-23 14:03:07 +0100264};
265
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000266static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
267 const struct snd_pcm_substream *ss)
268{
269 return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000270 dai->playback_dma_data : dai->capture_dma_data;
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000271}
272
273static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
274 const struct snd_pcm_substream *ss,
275 void *data)
276{
277 if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000278 dai->playback_dma_data = data;
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000279 else
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000280 dai->capture_dma_data = data;
281}
282
283static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
284 void *data)
285{
286 dev_set_drvdata(dai->dev, data);
287}
288
289static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
290{
291 return dev_get_drvdata(dai->dev);
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000292}
293
Mark Browna47cbe72008-07-23 14:03:07 +0100294#endif