tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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
19#include <sound/soc.h>
20
21struct snd_pcm_substream;
22
23/*
24 * DAI hardware audio formats.
25 *
26 * Describes the physical PCM data formating and clocking. Add new formats
27 * to the end.
28 */
29#define SND_SOC_DAIFMT_I2S 0 /* I2S mode */
30#define SND_SOC_DAIFMT_RIGHT_J 1 /* Right Justified mode */
31#define SND_SOC_DAIFMT_LEFT_J 2 /* Left Justified mode */
32#define SND_SOC_DAIFMT_DSP_A 3 /* L data MSB after FRM LRC */
33#define SND_SOC_DAIFMT_DSP_B 4 /* L data MSB during FRM LRC */
34#define SND_SOC_DAIFMT_AC97 5 /* AC97 */
35#define SND_SOC_DAIFMT_PDM 6 /* Pulse density modulation */
36
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 *
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.
46 */
47#define SND_SOC_DAIFMT_CONT (0 << 4) /* continuous clock */
48#define SND_SOC_DAIFMT_GATED (1 << 4) /* clock is gated */
49
50/*
51 * DAI hardware signal inversions.
52 *
53 * Specifies whether the DAI can also support inverted clocks for the specified
54 * format.
55 */
56#define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */
57#define SND_SOC_DAIFMT_NB_IF (1 << 8) /* normal BCLK + inv FRM */
58#define SND_SOC_DAIFMT_IB_NF (2 << 8) /* invert BCLK + nor FRM */
59#define SND_SOC_DAIFMT_IB_IF (3 << 8) /* invert BCLK + FRM */
60
61/*
62 * DAI hardware clock masters.
63 *
64 * This is wrt the codec, the inverse is true for the interface
65 * i.e. if the codec is clk and FRM master then the interface is
66 * clk and frame slave.
67 */
68#define SND_SOC_DAIFMT_CBM_CFM (0 << 12) /* codec clk & FRM master */
69#define SND_SOC_DAIFMT_CBS_CFM (1 << 12) /* codec clk slave & FRM master */
70#define SND_SOC_DAIFMT_CBM_CFS (2 << 12) /* codec clk master & frame slave */
71#define SND_SOC_DAIFMT_CBS_CFS (3 << 12) /* codec clk & FRM slave */
72
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
84#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 |\
91 SNDRV_PCM_FMTBIT_S32_LE |\
92 SNDRV_PCM_FMTBIT_S32_BE)
93
94struct snd_soc_dai_driver;
95struct snd_soc_dai;
96struct snd_ac97_bus_ops;
97
98/* Digital Audio Interface registration */
99int snd_soc_register_dai(struct device *dev,
100 struct snd_soc_dai_driver *dai_drv);
101void snd_soc_unregister_dai(struct device *dev);
102int snd_soc_register_dais(struct device *dev,
103 struct snd_soc_dai_driver *dai_drv, size_t count);
104void snd_soc_unregister_dais(struct device *dev, size_t count);
105
106/* Digital Audio Interface clocking API.*/
107int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
108 unsigned int freq, int dir);
109
110int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
111 int div_id, int div);
112
113int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
114 int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
115
116/* Digital Audio interface formatting */
117int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
118
119int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
120 unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
121
122int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
123 unsigned int tx_num, unsigned int *tx_slot,
124 unsigned int rx_num, unsigned int *rx_slot);
125
126int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
127
128/* Digital Audio Interface mute */
129int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute);
130
131struct snd_soc_dai_ops {
132 /*
133 * DAI clocking configuration, all optional.
134 * Called by soc_card drivers, normally in their hw_params.
135 */
136 int (*set_sysclk)(struct snd_soc_dai *dai,
137 int clk_id, unsigned int freq, int dir);
138 int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
139 unsigned int freq_in, unsigned int freq_out);
140 int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
141
142 /*
143 * DAI format configuration
144 * Called by soc_card drivers, normally in their hw_params.
145 */
146 int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
147 int (*set_tdm_slot)(struct snd_soc_dai *dai,
148 unsigned int tx_mask, unsigned int rx_mask,
149 int slots, int slot_width);
150 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);
153 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);
160
161 /*
162 * ALSA PCM audio operations - all optional.
163 * Called by soc-core during audio PCM operations.
164 */
165 int (*startup)(struct snd_pcm_substream *,
166 struct snd_soc_dai *);
167 void (*shutdown)(struct snd_pcm_substream *,
168 struct snd_soc_dai *);
169 int (*hw_params)(struct snd_pcm_substream *,
170 struct snd_pcm_hw_params *, struct snd_soc_dai *);
171 int (*hw_free)(struct snd_pcm_substream *,
172 struct snd_soc_dai *);
173 int (*prepare)(struct snd_pcm_substream *,
174 struct snd_soc_dai *);
175 int (*trigger)(struct snd_pcm_substream *, int,
176 struct snd_soc_dai *);
177 /*
178 * For hardware based FIFO caused delay reporting.
179 * Optional.
180 */
181 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
182 struct snd_soc_dai *);
183};
184
185/*
186 * Digital Audio Interface Driver.
187 *
188 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
189 * operations and capabilities. Codec and platform drivers will register this
190 * structure for every DAI they have.
191 *
192 * This structure covers the clocking, formating and ALSA operations for each
193 * interface.
194 */
195struct snd_soc_dai_driver {
196 /* DAI description */
197 const char *name;
198 unsigned int id;
199 int ac97_control;
200
201 /* DAI driver callbacks */
202 int (*probe)(struct snd_soc_dai *dai);
203 int (*remove)(struct snd_soc_dai *dai);
204 int (*suspend)(struct snd_soc_dai *dai);
205 int (*resume)(struct snd_soc_dai *dai);
206
207 /* ops */
208 struct snd_soc_dai_ops *ops;
209
210 /* DAI capabilities */
211 struct snd_soc_pcm_stream capture;
212 struct snd_soc_pcm_stream playback;
213 unsigned int symmetric_rates:1;
214};
215
216/*
217 * Digital Audio Interface runtime data.
218 *
219 * Holds runtime data for a DAI.
220 */
221struct snd_soc_dai {
222 const char *name;
223 int id;
224 struct device *dev;
225 void *ac97_pdata; /* platform_data for the ac97 codec */
226
227 /* driver ops */
228 struct snd_soc_dai_driver *driver;
229
230 /* DAI runtime info */
231 unsigned int capture_active:1; /* stream is in use */
232 unsigned int playback_active:1; /* stream is in use */
233 unsigned int symmetric_rates:1;
234 struct snd_pcm_runtime *runtime;
235 unsigned int active;
236 unsigned char pop_wait:1;
237 unsigned char probed:1;
238
239 /* DAI DMA data */
240 void *playback_dma_data;
241 void *capture_dma_data;
242
243 /* parent platform/codec */
244 union {
245 struct snd_soc_platform *platform;
246 struct snd_soc_codec *codec;
247 };
248 struct snd_soc_card *card;
249
250 struct list_head list;
251 struct list_head card_list;
252};
253
254static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
255 const struct snd_pcm_substream *ss)
256{
257 return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
258 dai->playback_dma_data : dai->capture_dma_data;
259}
260
261static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
262 const struct snd_pcm_substream *ss,
263 void *data)
264{
265 if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
266 dai->playback_dma_data = data;
267 else
268 dai->capture_dma_data = data;
269}
270
271static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
272 void *data)
273{
274 dev_set_drvdata(dai->dev, data);
275}
276
277static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
278{
279 return dev_get_drvdata(dai->dev);
280}
281
282#endif