]>
Commit | Line | Data |
---|---|---|
a47cbe72 MB |
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 | struct snd_pcm_substream; | |
888df395 | 20 | struct snd_soc_dapm_widget; |
a47cbe72 MB |
21 | |
22 | /* | |
23 | * DAI hardware audio formats. | |
24 | * | |
25 | * Describes the physical PCM data formating and clocking. Add new formats | |
26 | * to the end. | |
27 | */ | |
75d9ac46 MB |
28 | #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 */ | |
a47cbe72 MB |
35 | |
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 | * | |
47db8e89 | 43 | * DAI bit clocks can be be gated (disabled) when the DAI is not |
a47cbe72 MB |
44 | * sending or receiving PCM data in a frame. This can be used to save power. |
45 | */ | |
75d9ac46 MB |
46 | #define SND_SOC_DAIFMT_CONT (1 << 4) /* continuous clock */ |
47 | #define SND_SOC_DAIFMT_GATED (2 << 4) /* clock is gated */ | |
a47cbe72 | 48 | |
a47cbe72 MB |
49 | /* |
50 | * DAI hardware signal inversions. | |
51 | * | |
52 | * Specifies whether the DAI can also support inverted clocks for the specified | |
53 | * format. | |
54 | */ | |
75d9ac46 MB |
55 | #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 */ | |
a47cbe72 MB |
59 | |
60 | /* | |
61 | * DAI hardware clock masters. | |
62 | * | |
63 | * This is wrt the codec, the inverse is true for the interface | |
47db8e89 | 64 | * i.e. if the codec is clk and FRM master then the interface is |
a47cbe72 MB |
65 | * clk and frame slave. |
66 | */ | |
75d9ac46 MB |
67 | #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 */ | |
a47cbe72 MB |
71 | |
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 | ||
8f738d58 MB |
83 | #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 |\ | |
d34c4307 JS |
90 | SNDRV_PCM_FMTBIT_S32_LE |\ |
91 | SNDRV_PCM_FMTBIT_S32_BE) | |
33f503c9 | 92 | |
f0fba2ad | 93 | struct snd_soc_dai_driver; |
a47cbe72 MB |
94 | struct snd_soc_dai; |
95 | struct snd_ac97_bus_ops; | |
96 | ||
9115171a | 97 | /* Digital Audio Interface registration */ |
f0fba2ad LG |
98 | int snd_soc_register_dai(struct device *dev, |
99 | struct snd_soc_dai_driver *dai_drv); | |
100 | void snd_soc_unregister_dai(struct device *dev); | |
101 | int snd_soc_register_dais(struct device *dev, | |
102 | struct snd_soc_dai_driver *dai_drv, size_t count); | |
103 | void snd_soc_unregister_dais(struct device *dev, size_t count); | |
9115171a | 104 | |
a47cbe72 MB |
105 | /* Digital Audio Interface clocking API.*/ |
106 | int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id, | |
107 | unsigned int freq, int dir); | |
108 | ||
109 | int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai, | |
110 | int div_id, int div); | |
111 | ||
112 | int snd_soc_dai_set_pll(struct snd_soc_dai *dai, | |
85488037 | 113 | int pll_id, int source, unsigned int freq_in, unsigned int freq_out); |
a47cbe72 MB |
114 | |
115 | /* Digital Audio interface formatting */ | |
116 | int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt); | |
117 | ||
118 | int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai, | |
a5479e38 | 119 | unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width); |
a47cbe72 | 120 | |
472df3cb BS |
121 | int 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 | ||
a47cbe72 MB |
125 | int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate); |
126 | ||
127 | /* Digital Audio Interface mute */ | |
128 | int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute); | |
129 | ||
a47cbe72 MB |
130 | struct 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); | |
85488037 MB |
137 | int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source, |
138 | unsigned int freq_in, unsigned int freq_out); | |
a47cbe72 MB |
139 | 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, | |
a5479e38 DR |
147 | unsigned int tx_mask, unsigned int rx_mask, |
148 | int slots, int slot_width); | |
472df3cb BS |
149 | 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); | |
a47cbe72 MB |
152 | 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); | |
dee89c4d MB |
159 | |
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 *); | |
07bf84aa LG |
176 | int (*bespoke_trigger)(struct snd_pcm_substream *, int, |
177 | struct snd_soc_dai *); | |
258020d0 PU |
178 | /* |
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 *); | |
a47cbe72 MB |
184 | }; |
185 | ||
186 | /* | |
f0fba2ad | 187 | * Digital Audio Interface Driver. |
a47cbe72 | 188 | * |
f0fba2ad LG |
189 | * 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. | |
a47cbe72 | 195 | */ |
f0fba2ad | 196 | struct snd_soc_dai_driver { |
a47cbe72 | 197 | /* DAI description */ |
f0fba2ad | 198 | const char *name; |
a47cbe72 | 199 | unsigned int id; |
3ba9e10a | 200 | int ac97_control; |
a47cbe72 | 201 | |
f0fba2ad LG |
202 | /* DAI driver callbacks */ |
203 | int (*probe)(struct snd_soc_dai *dai); | |
204 | int (*remove)(struct snd_soc_dai *dai); | |
dc7d7b83 MB |
205 | int (*suspend)(struct snd_soc_dai *dai); |
206 | int (*resume)(struct snd_soc_dai *dai); | |
a47cbe72 MB |
207 | |
208 | /* ops */ | |
1ee46ebd | 209 | const struct snd_soc_dai_ops *ops; |
a47cbe72 MB |
210 | |
211 | /* DAI capabilities */ | |
212 | struct snd_soc_pcm_stream capture; | |
213 | struct snd_soc_pcm_stream playback; | |
06f409d7 | 214 | unsigned int symmetric_rates:1; |
0168bf0d LG |
215 | |
216 | /* probe ordering - for components with runtime dependencies */ | |
217 | int probe_order; | |
218 | int remove_order; | |
f0fba2ad LG |
219 | }; |
220 | ||
221 | /* | |
222 | * Digital Audio Interface runtime data. | |
223 | * | |
224 | * Holds runtime data for a DAI. | |
225 | */ | |
226 | struct snd_soc_dai { | |
227 | const char *name; | |
228 | int id; | |
229 | struct device *dev; | |
230 | void *ac97_pdata; /* platform_data for the ac97 codec */ | |
231 | ||
232 | /* driver ops */ | |
233 | struct snd_soc_dai_driver *driver; | |
a47cbe72 MB |
234 | |
235 | /* DAI runtime info */ | |
f0fba2ad LG |
236 | unsigned int capture_active:1; /* stream is in use */ |
237 | unsigned int playback_active:1; /* stream is in use */ | |
238 | unsigned int symmetric_rates:1; | |
239 | struct snd_pcm_runtime *runtime; | |
a47cbe72 MB |
240 | unsigned int active; |
241 | unsigned char pop_wait:1; | |
f0fba2ad | 242 | unsigned char probed:1; |
a47cbe72 | 243 | |
888df395 MB |
244 | struct snd_soc_dapm_widget *playback_widget; |
245 | struct snd_soc_dapm_widget *capture_widget; | |
be09ad90 | 246 | struct snd_soc_dapm_context dapm; |
888df395 | 247 | |
f0fba2ad LG |
248 | /* DAI DMA data */ |
249 | void *playback_dma_data; | |
250 | void *capture_dma_data; | |
a47cbe72 | 251 | |
17841020 DA |
252 | /* Symmetry data - only valid if symmetry is being enforced */ |
253 | unsigned int rate; | |
254 | ||
f0fba2ad | 255 | /* parent platform/codec */ |
2466ab97 MB |
256 | struct snd_soc_platform *platform; |
257 | struct snd_soc_codec *codec; | |
258 | ||
f0fba2ad | 259 | struct snd_soc_card *card; |
a47cbe72 MB |
260 | |
261 | struct list_head list; | |
f0fba2ad | 262 | struct list_head card_list; |
a47cbe72 MB |
263 | }; |
264 | ||
fd23b7de DM |
265 | static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai, |
266 | const struct snd_pcm_substream *ss) | |
267 | { | |
268 | return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ? | |
f0fba2ad | 269 | dai->playback_dma_data : dai->capture_dma_data; |
fd23b7de DM |
270 | } |
271 | ||
272 | static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai, | |
273 | const struct snd_pcm_substream *ss, | |
274 | void *data) | |
275 | { | |
276 | if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) | |
f0fba2ad | 277 | dai->playback_dma_data = data; |
fd23b7de | 278 | else |
f0fba2ad LG |
279 | dai->capture_dma_data = data; |
280 | } | |
281 | ||
282 | static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai, | |
283 | void *data) | |
284 | { | |
285 | dev_set_drvdata(dai->dev, data); | |
286 | } | |
287 | ||
288 | static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai) | |
289 | { | |
290 | return dev_get_drvdata(dai->dev); | |
fd23b7de DM |
291 | } |
292 | ||
a47cbe72 | 293 | #endif |