2 * linux/sound/soc-dai.h -- ALSA SoC Layer
4 * Copyright: 2005-2008 Wolfson Microelectronics. PLC.
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.
10 * Digital Audio Interface (DAI) API.
13 #ifndef __LINUX_SND_SOC_DAI_H
14 #define __LINUX_SND_SOC_DAI_H
17 #include <linux/list.h>
19 struct snd_pcm_substream;
20 struct snd_soc_dapm_widget;
21 struct snd_compr_stream;
24 * DAI hardware audio formats.
26 * Describes the physical PCM data formating and clocking. Add new formats
29 #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 */
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
44 * DAI bit clocks can be be gated (disabled) when the DAI is not
45 * sending or receiving PCM data in a frame. This can be used to save power.
47 #define SND_SOC_DAIFMT_CONT (1 << 4) /* continuous clock */
48 #define SND_SOC_DAIFMT_GATED (0 << 4) /* clock is gated */
51 * DAI hardware signal polarity.
53 * Specifies whether the DAI can also support inverted clocks for the specified
57 * - "normal" polarity means signal is available at rising edge of BCLK
58 * - "inverted" polarity means signal is available at falling edge of BCLK
60 * FSYNC "normal" polarity depends on the frame format:
61 * - I2S: frame consists of left then right channel data. Left channel starts
62 * with falling FSYNC edge, right channel starts with rising FSYNC edge.
63 * - Left/Right Justified: frame consists of left then right channel data.
64 * Left channel starts with rising FSYNC edge, right channel starts with
66 * - DSP A/B: Frame starts with rising FSYNC edge.
67 * - AC97: Frame starts with rising FSYNC edge.
69 * "Negative" FSYNC polarity is the one opposite of "normal" polarity.
71 #define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */
72 #define SND_SOC_DAIFMT_NB_IF (2 << 8) /* normal BCLK + inv FRM */
73 #define SND_SOC_DAIFMT_IB_NF (3 << 8) /* invert BCLK + nor FRM */
74 #define SND_SOC_DAIFMT_IB_IF (4 << 8) /* invert BCLK + FRM */
77 * DAI hardware clock masters.
79 * This is wrt the codec, the inverse is true for the interface
80 * i.e. if the codec is clk and FRM master then the interface is
81 * clk and frame slave.
83 #define SND_SOC_DAIFMT_CBM_CFM (1 << 12) /* codec clk & FRM master */
84 #define SND_SOC_DAIFMT_CBS_CFM (2 << 12) /* codec clk slave & FRM master */
85 #define SND_SOC_DAIFMT_CBM_CFS (3 << 12) /* codec clk master & frame slave */
86 #define SND_SOC_DAIFMT_CBS_CFS (4 << 12) /* codec clk & FRM slave */
88 #define SND_SOC_DAIFMT_FORMAT_MASK 0x000f
89 #define SND_SOC_DAIFMT_CLOCK_MASK 0x00f0
90 #define SND_SOC_DAIFMT_INV_MASK 0x0f00
91 #define SND_SOC_DAIFMT_MASTER_MASK 0xf000
94 * Master Clock Directions
96 #define SND_SOC_CLOCK_IN 0
97 #define SND_SOC_CLOCK_OUT 1
99 #define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\
100 SNDRV_PCM_FMTBIT_S16_LE |\
101 SNDRV_PCM_FMTBIT_S16_BE |\
102 SNDRV_PCM_FMTBIT_S20_3LE |\
103 SNDRV_PCM_FMTBIT_S20_3BE |\
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,
141 int snd_soc_dai_get_channel_map(struct snd_soc_dai *dai,
142 unsigned int *tx_num, unsigned int *tx_slot,
143 unsigned int *rx_num, unsigned int *rx_slot);
145 int snd_soc_dai_is_dummy(struct snd_soc_dai *dai);
147 struct snd_soc_dai_ops {
149 * DAI clocking configuration, all optional.
150 * Called by soc_card drivers, normally in their hw_params.
152 int (*set_sysclk)(struct snd_soc_dai *dai,
153 int clk_id, unsigned int freq, int dir);
154 int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
155 unsigned int freq_in, unsigned int freq_out);
156 int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
157 int (*set_bclk_ratio)(struct snd_soc_dai *dai, unsigned int ratio);
160 * DAI format configuration
161 * Called by soc_card drivers, normally in their hw_params.
163 int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
164 int (*xlate_tdm_slot_mask)(unsigned int slots,
165 unsigned int *tx_mask, unsigned int *rx_mask);
166 int (*set_tdm_slot)(struct snd_soc_dai *dai,
167 unsigned int tx_mask, unsigned int rx_mask,
168 int slots, int slot_width);
169 int (*set_channel_map)(struct snd_soc_dai *dai,
170 unsigned int tx_num, unsigned int *tx_slot,
171 unsigned int rx_num, unsigned int *rx_slot);
172 int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
173 int (*get_channel_map)(struct snd_soc_dai *dai,
174 unsigned int *tx_num, unsigned int *tx_slot,
175 unsigned int *rx_num, unsigned int *rx_slot);
178 * DAI digital mute - optional.
179 * Called by soc-core to minimise any pops.
181 int (*digital_mute)(struct snd_soc_dai *dai, int mute);
182 int (*mute_stream)(struct snd_soc_dai *dai, int mute, int stream);
185 * ALSA PCM audio operations - all optional.
186 * Called by soc-core during audio PCM operations.
188 int (*startup)(struct snd_pcm_substream *,
189 struct snd_soc_dai *);
190 void (*shutdown)(struct snd_pcm_substream *,
191 struct snd_soc_dai *);
192 int (*hw_params)(struct snd_pcm_substream *,
193 struct snd_pcm_hw_params *, struct snd_soc_dai *);
194 int (*hw_free)(struct snd_pcm_substream *,
195 struct snd_soc_dai *);
196 int (*prepare)(struct snd_pcm_substream *,
197 struct snd_soc_dai *);
199 * NOTE: Commands passed to the trigger function are not necessarily
200 * compatible with the current state of the dai. For example this
201 * sequence of commands is possible: START STOP STOP.
202 * So do not unconditionally use refcounting functions in the trigger
203 * function, e.g. clk_enable/disable.
205 int (*trigger)(struct snd_pcm_substream *, int,
206 struct snd_soc_dai *);
207 int (*bespoke_trigger)(struct snd_pcm_substream *, int,
208 struct snd_soc_dai *);
210 * For hardware based FIFO caused delay reporting.
213 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
214 struct snd_soc_dai *);
218 * Digital Audio Interface Driver.
220 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
221 * operations and capabilities. Codec and platform drivers will register this
222 * structure for every DAI they have.
224 * This structure covers the clocking, formating and ALSA operations for each
227 struct snd_soc_dai_driver {
228 /* DAI description */
233 /* DAI driver callbacks */
234 int (*probe)(struct snd_soc_dai *dai);
235 int (*remove)(struct snd_soc_dai *dai);
236 int (*suspend)(struct snd_soc_dai *dai);
237 int (*resume)(struct snd_soc_dai *dai);
239 int (*compress_new)(struct snd_soc_pcm_runtime *rtd, int num);
240 /* DAI is also used for the control bus */
244 const struct snd_soc_dai_ops *ops;
246 /* DAI capabilities */
247 struct snd_soc_pcm_stream capture;
248 struct snd_soc_pcm_stream playback;
249 unsigned int symmetric_rates:1;
250 unsigned int symmetric_channels:1;
251 unsigned int symmetric_samplebits:1;
253 /* probe ordering - for components with runtime dependencies */
259 * Digital Audio Interface runtime data.
261 * Holds runtime data for a DAI.
269 struct snd_soc_dai_driver *driver;
271 /* DAI runtime info */
272 unsigned int capture_active; /* stream is in use */
273 unsigned int playback_active; /* stream is in use */
274 unsigned int symmetric_rates:1;
275 unsigned int symmetric_channels:1;
276 unsigned int symmetric_samplebits:1;
278 unsigned char probed:1;
280 struct snd_soc_dapm_widget *playback_widget;
281 struct snd_soc_dapm_widget *capture_widget;
284 void *playback_dma_data;
285 void *capture_dma_data;
287 /* Symmetry data - only valid if symmetry is being enforced */
289 unsigned int channels;
290 unsigned int sample_bits;
292 /* parent platform/codec */
293 struct snd_soc_codec *codec;
294 struct snd_soc_component *component;
296 /* CODEC TDM slot masks and params (for fixup) */
297 unsigned int tx_mask;
298 unsigned int rx_mask;
300 struct list_head list;
303 static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
304 const struct snd_pcm_substream *ss)
306 return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
307 dai->playback_dma_data : dai->capture_dma_data;
310 static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
311 const struct snd_pcm_substream *ss,
314 if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
315 dai->playback_dma_data = data;
317 dai->capture_dma_data = data;
320 static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai,
321 void *playback, void *capture)
323 dai->playback_dma_data = playback;
324 dai->capture_dma_data = capture;
327 static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
330 dev_set_drvdata(dai->dev, data);
333 static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
335 return dev_get_drvdata(dai->dev);