Merge branch 'for-2.6.40' of git://git.kernel.org/pub/scm/linux/kernel/git/lrg/asoc...
[linux-2.6.git] / include / sound / soc.h
1 /*
2  * linux/sound/soc.h -- ALSA SoC Layer
3  *
4  * Author:              Liam Girdwood
5  * Created:             Aug 11th 2005
6  * Copyright:   Wolfson Microelectronics. PLC.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  */
12
13 #ifndef __LINUX_SND_SOC_H
14 #define __LINUX_SND_SOC_H
15
16 #include <linux/platform_device.h>
17 #include <linux/types.h>
18 #include <linux/notifier.h>
19 #include <linux/workqueue.h>
20 #include <linux/interrupt.h>
21 #include <linux/kernel.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/control.h>
25 #include <sound/ac97_codec.h>
26
27 /*
28  * Convenience kcontrol builders
29  */
30 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
31         ((unsigned long)&(struct soc_mixer_control) \
32         {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
33         .platform_max = xmax, .invert = xinvert})
34 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
35         ((unsigned long)&(struct soc_mixer_control) \
36         {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
37 #define SOC_SINGLE(xname, reg, shift, max, invert) \
38 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
39         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
40         .put = snd_soc_put_volsw, \
41         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
42 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
43 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
44         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
45                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
46         .tlv.p = (tlv_array), \
47         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
48         .put = snd_soc_put_volsw, \
49         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
50 #define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
51 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
52         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
53         .put = snd_soc_put_volsw, \
54         .private_value = (unsigned long)&(struct soc_mixer_control) \
55                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
56                  .max = xmax, .platform_max = xmax, .invert = xinvert} }
57 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
58 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
59         .info = snd_soc_info_volsw_2r, \
60         .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
61         .private_value = (unsigned long)&(struct soc_mixer_control) \
62                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
63                 .max = xmax, .platform_max = xmax, .invert = xinvert} }
64 #define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
65 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
66         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
67                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
68         .tlv.p = (tlv_array), \
69         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
70         .put = snd_soc_put_volsw, \
71         .private_value = (unsigned long)&(struct soc_mixer_control) \
72                 {.reg = xreg, .shift = shift_left, .rshift = shift_right,\
73                  .max = xmax, .platform_max = xmax, .invert = xinvert} }
74 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
75 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
76         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
77                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
78         .tlv.p = (tlv_array), \
79         .info = snd_soc_info_volsw_2r, \
80         .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
81         .private_value = (unsigned long)&(struct soc_mixer_control) \
82                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
83                 .max = xmax, .platform_max = xmax, .invert = xinvert} }
84 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
85 {       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
86         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
87                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
88         .tlv.p  = (tlv_array), \
89         .info   = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
90         .put    = snd_soc_put_volsw_s8, \
91         .private_value = (unsigned long)&(struct soc_mixer_control) \
92                 {.reg = xreg, .min = xmin, .max = xmax, \
93                  .platform_max = xmax} }
94 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
95 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
96         .max = xmax, .texts = xtexts }
97 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
98         SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
99 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
100 {       .max = xmax, .texts = xtexts }
101 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
102 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
103         .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
104 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
105         SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
106 #define SOC_ENUM(xname, xenum) \
107 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
108         .info = snd_soc_info_enum_double, \
109         .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
110         .private_value = (unsigned long)&xenum }
111 #define SOC_VALUE_ENUM(xname, xenum) \
112 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
113         .info = snd_soc_info_enum_double, \
114         .get = snd_soc_get_value_enum_double, \
115         .put = snd_soc_put_value_enum_double, \
116         .private_value = (unsigned long)&xenum }
117 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
118          xhandler_get, xhandler_put) \
119 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
120         .info = snd_soc_info_volsw, \
121         .get = xhandler_get, .put = xhandler_put, \
122         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
123 #define SOC_DOUBLE_EXT(xname, xreg, shift_left, shift_right, xmax, xinvert,\
124          xhandler_get, xhandler_put) \
125 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
126         .info = snd_soc_info_volsw, \
127         .get = xhandler_get, .put = xhandler_put, \
128         .private_value = (unsigned long)&(struct soc_mixer_control) \
129                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
130                  .max = xmax, .platform_max = xmax, .invert = xinvert} }
131 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
132          xhandler_get, xhandler_put, tlv_array) \
133 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
134         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
135                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
136         .tlv.p = (tlv_array), \
137         .info = snd_soc_info_volsw, \
138         .get = xhandler_get, .put = xhandler_put, \
139         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
140 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
141          xhandler_get, xhandler_put, tlv_array) \
142 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
143         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
144                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
145         .tlv.p = (tlv_array), \
146         .info = snd_soc_info_volsw, \
147         .get = xhandler_get, .put = xhandler_put, \
148         .private_value = (unsigned long)&(struct soc_mixer_control) \
149                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
150                 .max = xmax, .platform_max = xmax, .invert = xinvert} }
151 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
152          xhandler_get, xhandler_put, tlv_array) \
153 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
154         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
155                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
156         .tlv.p = (tlv_array), \
157         .info = snd_soc_info_volsw_2r, \
158         .get = xhandler_get, .put = xhandler_put, \
159         .private_value = (unsigned long)&(struct soc_mixer_control) \
160                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
161                 .max = xmax, .platform_max = xmax, .invert = xinvert} }
162 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
163 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
164         .info = snd_soc_info_bool_ext, \
165         .get = xhandler_get, .put = xhandler_put, \
166         .private_value = xdata }
167 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
168 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
169         .info = snd_soc_info_enum_ext, \
170         .get = xhandler_get, .put = xhandler_put, \
171         .private_value = (unsigned long)&xenum }
172
173 #define SOC_DOUBLE_R_SX_TLV(xname, xreg_left, xreg_right, xshift,\
174                 xmin, xmax, tlv_array) \
175 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
176         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
177                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
178         .tlv.p = (tlv_array), \
179         .info = snd_soc_info_volsw_2r_sx, \
180         .get = snd_soc_get_volsw_2r_sx, \
181         .put = snd_soc_put_volsw_2r_sx, \
182         .private_value = (unsigned long)&(struct soc_mixer_control) \
183                 {.reg = xreg_left, \
184                  .rreg = xreg_right, .shift = xshift, \
185                  .min = xmin, .max = xmax} }
186
187
188 /*
189  * Simplified versions of above macros, declaring a struct and calculating
190  * ARRAY_SIZE internally
191  */
192 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
193         struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
194                                                 ARRAY_SIZE(xtexts), xtexts)
195 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
196         SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
197 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
198         struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
199 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
200         struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
201                                                         ARRAY_SIZE(xtexts), xtexts, xvalues)
202 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
203         SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
204
205 /*
206  * Bias levels
207  *
208  * @ON:      Bias is fully on for audio playback and capture operations.
209  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
210  *           stream start and stop operations.
211  * @STANDBY: Low power standby state when no playback/capture operations are
212  *           in progress. NOTE: The transition time between STANDBY and ON
213  *           should be as fast as possible and no longer than 10ms.
214  * @OFF:     Power Off. No restrictions on transition times.
215  */
216 enum snd_soc_bias_level {
217         SND_SOC_BIAS_OFF,
218         SND_SOC_BIAS_STANDBY,
219         SND_SOC_BIAS_PREPARE,
220         SND_SOC_BIAS_ON,
221 };
222
223 struct snd_jack;
224 struct snd_soc_card;
225 struct snd_soc_pcm_stream;
226 struct snd_soc_ops;
227 struct snd_soc_pcm_runtime;
228 struct snd_soc_dai;
229 struct snd_soc_dai_driver;
230 struct snd_soc_platform;
231 struct snd_soc_dai_link;
232 struct snd_soc_platform_driver;
233 struct snd_soc_codec;
234 struct snd_soc_codec_driver;
235 struct soc_enum;
236 struct snd_soc_jack;
237 struct snd_soc_jack_zone;
238 struct snd_soc_jack_pin;
239 struct snd_soc_cache_ops;
240 #include <sound/soc-dapm.h>
241
242 #ifdef CONFIG_GPIOLIB
243 struct snd_soc_jack_gpio;
244 #endif
245
246 typedef int (*hw_write_t)(void *,const char* ,int);
247
248 extern struct snd_ac97_bus_ops soc_ac97_ops;
249
250 enum snd_soc_control_type {
251         SND_SOC_CUSTOM = 1,
252         SND_SOC_I2C,
253         SND_SOC_SPI,
254 };
255
256 enum snd_soc_compress_type {
257         SND_SOC_FLAT_COMPRESSION = 1,
258         SND_SOC_LZO_COMPRESSION,
259         SND_SOC_RBTREE_COMPRESSION
260 };
261
262 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
263                              unsigned int freq, int dir);
264 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
265                           unsigned int freq_in, unsigned int freq_out);
266
267 int snd_soc_register_card(struct snd_soc_card *card);
268 int snd_soc_unregister_card(struct snd_soc_card *card);
269 int snd_soc_suspend(struct device *dev);
270 int snd_soc_resume(struct device *dev);
271 int snd_soc_poweroff(struct device *dev);
272 int snd_soc_register_platform(struct device *dev,
273                 struct snd_soc_platform_driver *platform_drv);
274 void snd_soc_unregister_platform(struct device *dev);
275 int snd_soc_register_codec(struct device *dev,
276                 const struct snd_soc_codec_driver *codec_drv,
277                 struct snd_soc_dai_driver *dai_drv, int num_dai);
278 void snd_soc_unregister_codec(struct device *dev);
279 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
280                                     unsigned int reg);
281 int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
282                                     unsigned int reg);
283 int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
284                                     unsigned int reg);
285 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
286                                int addr_bits, int data_bits,
287                                enum snd_soc_control_type control);
288 int snd_soc_cache_sync(struct snd_soc_codec *codec);
289 int snd_soc_cache_init(struct snd_soc_codec *codec);
290 int snd_soc_cache_exit(struct snd_soc_codec *codec);
291 int snd_soc_cache_write(struct snd_soc_codec *codec,
292                         unsigned int reg, unsigned int value);
293 int snd_soc_cache_read(struct snd_soc_codec *codec,
294                        unsigned int reg, unsigned int *value);
295 int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
296                                       unsigned int reg);
297 int snd_soc_default_readable_register(struct snd_soc_codec *codec,
298                                       unsigned int reg);
299 int snd_soc_default_writable_register(struct snd_soc_codec *codec,
300                                       unsigned int reg);
301
302 /* Utility functions to get clock rates from various things */
303 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
304 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
305 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
306 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
307
308 /* set runtime hw params */
309 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
310         const struct snd_pcm_hardware *hw);
311
312 /* Jack reporting */
313 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
314                      struct snd_soc_jack *jack);
315 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
316 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
317                           struct snd_soc_jack_pin *pins);
318 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
319                                     struct notifier_block *nb);
320 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
321                                       struct notifier_block *nb);
322 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
323                           struct snd_soc_jack_zone *zones);
324 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
325 #ifdef CONFIG_GPIOLIB
326 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
327                         struct snd_soc_jack_gpio *gpios);
328 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
329                         struct snd_soc_jack_gpio *gpios);
330 #endif
331
332 /* codec register bit access */
333 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
334                                 unsigned int mask, unsigned int value);
335 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
336                                unsigned short reg, unsigned int mask,
337                                unsigned int value);
338 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
339                                 unsigned int mask, unsigned int value);
340
341 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
342         struct snd_ac97_bus_ops *ops, int num);
343 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
344
345 /*
346  *Controls
347  */
348 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
349                                   void *data, char *long_name,
350                                   const char *prefix);
351 int snd_soc_add_controls(struct snd_soc_codec *codec,
352         const struct snd_kcontrol_new *controls, int num_controls);
353 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
354         struct snd_ctl_elem_info *uinfo);
355 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
356         struct snd_ctl_elem_info *uinfo);
357 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
358         struct snd_ctl_elem_value *ucontrol);
359 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
360         struct snd_ctl_elem_value *ucontrol);
361 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
362         struct snd_ctl_elem_value *ucontrol);
363 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
364         struct snd_ctl_elem_value *ucontrol);
365 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
366         struct snd_ctl_elem_info *uinfo);
367 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
368         struct snd_ctl_elem_info *uinfo);
369 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
370 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
371         struct snd_ctl_elem_value *ucontrol);
372 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
373         struct snd_ctl_elem_value *ucontrol);
374 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
375         struct snd_ctl_elem_info *uinfo);
376 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
377         struct snd_ctl_elem_value *ucontrol);
378 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
379         struct snd_ctl_elem_value *ucontrol);
380 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
381         struct snd_ctl_elem_info *uinfo);
382 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
383         struct snd_ctl_elem_value *ucontrol);
384 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
385         struct snd_ctl_elem_value *ucontrol);
386 int snd_soc_limit_volume(struct snd_soc_codec *codec,
387         const char *name, int max);
388 int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
389         struct snd_ctl_elem_info *uinfo);
390 int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
391         struct snd_ctl_elem_value *ucontrol);
392 int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
393         struct snd_ctl_elem_value *ucontrol);
394
395 /**
396  * struct snd_soc_reg_access - Describes whether a given register is
397  * readable, writable or volatile.
398  *
399  * @reg: the register number
400  * @read: whether this register is readable
401  * @write: whether this register is writable
402  * @vol: whether this register is volatile
403  */
404 struct snd_soc_reg_access {
405         u16 reg;
406         u16 read;
407         u16 write;
408         u16 vol;
409 };
410
411 /**
412  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
413  *
414  * @pin:    name of the pin to update
415  * @mask:   bits to check for in reported jack status
416  * @invert: if non-zero then pin is enabled when status is not reported
417  */
418 struct snd_soc_jack_pin {
419         struct list_head list;
420         const char *pin;
421         int mask;
422         bool invert;
423 };
424
425 /**
426  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
427  *
428  * @min_mv: start voltage in mv
429  * @max_mv: end voltage in mv
430  * @jack_type: type of jack that is expected for this voltage
431  * @debounce_time: debounce_time for jack, codec driver should wait for this
432  *              duration before reading the adc for voltages
433  * @:list: list container
434  */
435 struct snd_soc_jack_zone {
436         unsigned int min_mv;
437         unsigned int max_mv;
438         unsigned int jack_type;
439         unsigned int debounce_time;
440         struct list_head list;
441 };
442
443 /**
444  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
445  *
446  * @gpio:         gpio number
447  * @name:         gpio name
448  * @report:       value to report when jack detected
449  * @invert:       report presence in low state
450  * @debouce_time: debouce time in ms
451  * @wake:         enable as wake source
452  * @jack_status_check: callback function which overrides the detection
453  *                     to provide more complex checks (eg, reading an
454  *                     ADC).
455  */
456 #ifdef CONFIG_GPIOLIB
457 struct snd_soc_jack_gpio {
458         unsigned int gpio;
459         const char *name;
460         int report;
461         int invert;
462         int debounce_time;
463         bool wake;
464
465         struct snd_soc_jack *jack;
466         struct delayed_work work;
467
468         int (*jack_status_check)(void);
469 };
470 #endif
471
472 struct snd_soc_jack {
473         struct snd_jack *jack;
474         struct snd_soc_codec *codec;
475         struct list_head pins;
476         int status;
477         struct blocking_notifier_head notifier;
478         struct list_head jack_zones;
479 };
480
481 /* SoC PCM stream information */
482 struct snd_soc_pcm_stream {
483         const char *stream_name;
484         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
485         unsigned int rates;             /* SNDRV_PCM_RATE_* */
486         unsigned int rate_min;          /* min rate */
487         unsigned int rate_max;          /* max rate */
488         unsigned int channels_min;      /* min channels */
489         unsigned int channels_max;      /* max channels */
490 };
491
492 /* SoC audio ops */
493 struct snd_soc_ops {
494         int (*startup)(struct snd_pcm_substream *);
495         void (*shutdown)(struct snd_pcm_substream *);
496         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
497         int (*hw_free)(struct snd_pcm_substream *);
498         int (*prepare)(struct snd_pcm_substream *);
499         int (*trigger)(struct snd_pcm_substream *, int);
500 };
501
502 /* SoC cache ops */
503 struct snd_soc_cache_ops {
504         const char *name;
505         enum snd_soc_compress_type id;
506         int (*init)(struct snd_soc_codec *codec);
507         int (*exit)(struct snd_soc_codec *codec);
508         int (*read)(struct snd_soc_codec *codec, unsigned int reg,
509                 unsigned int *value);
510         int (*write)(struct snd_soc_codec *codec, unsigned int reg,
511                 unsigned int value);
512         int (*sync)(struct snd_soc_codec *codec);
513 };
514
515 /* SoC Audio Codec device */
516 struct snd_soc_codec {
517         const char *name;
518         const char *name_prefix;
519         int id;
520         struct device *dev;
521         const struct snd_soc_codec_driver *driver;
522
523         struct mutex mutex;
524         struct snd_soc_card *card;
525         struct list_head list;
526         struct list_head card_list;
527         int num_dai;
528         enum snd_soc_compress_type compress_type;
529         size_t reg_size;        /* reg_cache_size * reg_word_size */
530         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
531         int (*readable_register)(struct snd_soc_codec *, unsigned int);
532         int (*writable_register)(struct snd_soc_codec *, unsigned int);
533
534         /* runtime */
535         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
536         unsigned int active;
537         unsigned int cache_bypass:1; /* Suppress access to the cache */
538         unsigned int suspended:1; /* Codec is in suspend PM state */
539         unsigned int probed:1; /* Codec has been probed */
540         unsigned int ac97_registered:1; /* Codec has been AC97 registered */
541         unsigned int ac97_created:1; /* Codec has been created by SoC */
542         unsigned int sysfs_registered:1; /* codec has been sysfs registered */
543         unsigned int cache_init:1; /* codec cache has been initialized */
544         u32 cache_only;  /* Suppress writes to hardware */
545         u32 cache_sync; /* Cache needs to be synced to hardware */
546
547         /* codec IO */
548         void *control_data; /* codec control (i2c/3wire) data */
549         enum snd_soc_control_type control_type;
550         hw_write_t hw_write;
551         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
552         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
553         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
554         int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
555         void *reg_cache;
556         const void *reg_def_copy;
557         const struct snd_soc_cache_ops *cache_ops;
558         struct mutex cache_rw_mutex;
559
560         /* dapm */
561         struct snd_soc_dapm_context dapm;
562
563 #ifdef CONFIG_DEBUG_FS
564         struct dentry *debugfs_codec_root;
565         struct dentry *debugfs_reg;
566         struct dentry *debugfs_dapm;
567 #endif
568 };
569
570 /* codec driver */
571 struct snd_soc_codec_driver {
572
573         /* driver ops */
574         int (*probe)(struct snd_soc_codec *);
575         int (*remove)(struct snd_soc_codec *);
576         int (*suspend)(struct snd_soc_codec *,
577                         pm_message_t state);
578         int (*resume)(struct snd_soc_codec *);
579
580         /* Default control and setup, added after probe() is run */
581         const struct snd_kcontrol_new *controls;
582         int num_controls;
583         const struct snd_soc_dapm_widget *dapm_widgets;
584         int num_dapm_widgets;
585         const struct snd_soc_dapm_route *dapm_routes;
586         int num_dapm_routes;
587
588         /* codec wide operations */
589         int (*set_sysclk)(struct snd_soc_codec *codec,
590                           int clk_id, unsigned int freq, int dir);
591         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
592                 unsigned int freq_in, unsigned int freq_out);
593
594         /* codec IO */
595         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
596         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
597         int (*display_register)(struct snd_soc_codec *, char *,
598                                 size_t, unsigned int);
599         int (*volatile_register)(struct snd_soc_codec *, unsigned int);
600         int (*readable_register)(struct snd_soc_codec *, unsigned int);
601         int (*writable_register)(struct snd_soc_codec *, unsigned int);
602         short reg_cache_size;
603         short reg_cache_step;
604         short reg_word_size;
605         const void *reg_cache_default;
606         short reg_access_size;
607         const struct snd_soc_reg_access *reg_access_default;
608         enum snd_soc_compress_type compress_type;
609
610         /* codec bias level */
611         int (*set_bias_level)(struct snd_soc_codec *,
612                               enum snd_soc_bias_level level);
613
614         void (*seq_notifier)(struct snd_soc_dapm_context *,
615                              enum snd_soc_dapm_type, int);
616 };
617
618 /* SoC platform interface */
619 struct snd_soc_platform_driver {
620
621         int (*probe)(struct snd_soc_platform *);
622         int (*remove)(struct snd_soc_platform *);
623         int (*suspend)(struct snd_soc_dai *dai);
624         int (*resume)(struct snd_soc_dai *dai);
625
626         /* pcm creation and destruction */
627         int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
628                 struct snd_pcm *);
629         void (*pcm_free)(struct snd_pcm *);
630
631         /*
632          * For platform caused delay reporting.
633          * Optional.
634          */
635         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
636                 struct snd_soc_dai *);
637
638         /* platform stream ops */
639         struct snd_pcm_ops *ops;
640 };
641
642 struct snd_soc_platform {
643         const char *name;
644         int id;
645         struct device *dev;
646         struct snd_soc_platform_driver *driver;
647
648         unsigned int suspended:1; /* platform is suspended */
649         unsigned int probed:1;
650
651         struct snd_soc_card *card;
652         struct list_head list;
653         struct list_head card_list;
654 };
655
656 struct snd_soc_dai_link {
657         /* config - must be set by machine driver */
658         const char *name;                       /* Codec name */
659         const char *stream_name;                /* Stream name */
660         const char *codec_name;         /* for multi-codec */
661         const char *platform_name;      /* for multi-platform */
662         const char *cpu_dai_name;
663         const char *codec_dai_name;
664
665         /* Keep DAI active over suspend */
666         unsigned int ignore_suspend:1;
667
668         /* Symmetry requirements */
669         unsigned int symmetric_rates:1;
670
671         /* codec/machine specific init - e.g. add machine controls */
672         int (*init)(struct snd_soc_pcm_runtime *rtd);
673
674         /* machine stream operations */
675         struct snd_soc_ops *ops;
676 };
677
678 struct snd_soc_codec_conf {
679         const char *dev_name;
680
681         /*
682          * optional map of kcontrol, widget and path name prefixes that are
683          * associated per device
684          */
685         const char *name_prefix;
686
687         /*
688          * set this to the desired compression type if you want to
689          * override the one supplied in codec->driver->compress_type
690          */
691         enum snd_soc_compress_type compress_type;
692 };
693
694 struct snd_soc_aux_dev {
695         const char *name;               /* Codec name */
696         const char *codec_name;         /* for multi-codec */
697
698         /* codec/machine specific init - e.g. add machine controls */
699         int (*init)(struct snd_soc_dapm_context *dapm);
700 };
701
702 /* SoC card */
703 struct snd_soc_card {
704         const char *name;
705         const char *long_name;
706         const char *driver_name;
707         struct device *dev;
708         struct snd_card *snd_card;
709         struct module *owner;
710
711         struct list_head list;
712         struct mutex mutex;
713
714         bool instantiated;
715
716         int (*probe)(struct snd_soc_card *card);
717         int (*late_probe)(struct snd_soc_card *card);
718         int (*remove)(struct snd_soc_card *card);
719
720         /* the pre and post PM functions are used to do any PM work before and
721          * after the codec and DAI's do any PM work. */
722         int (*suspend_pre)(struct snd_soc_card *card);
723         int (*suspend_post)(struct snd_soc_card *card);
724         int (*resume_pre)(struct snd_soc_card *card);
725         int (*resume_post)(struct snd_soc_card *card);
726
727         /* callbacks */
728         int (*set_bias_level)(struct snd_soc_card *,
729                               enum snd_soc_bias_level level);
730         int (*set_bias_level_post)(struct snd_soc_card *,
731                                    enum snd_soc_bias_level level);
732
733         long pmdown_time;
734
735         /* CPU <--> Codec DAI links  */
736         struct snd_soc_dai_link *dai_link;
737         int num_links;
738         struct snd_soc_pcm_runtime *rtd;
739         int num_rtd;
740
741         /* optional codec specific configuration */
742         struct snd_soc_codec_conf *codec_conf;
743         int num_configs;
744
745         /*
746          * optional auxiliary devices such as amplifiers or codecs with DAI
747          * link unused
748          */
749         struct snd_soc_aux_dev *aux_dev;
750         int num_aux_devs;
751         struct snd_soc_pcm_runtime *rtd_aux;
752         int num_aux_rtd;
753
754         const struct snd_kcontrol_new *controls;
755         int num_controls;
756
757         /*
758          * Card-specific routes and widgets.
759          */
760         const struct snd_soc_dapm_widget *dapm_widgets;
761         int num_dapm_widgets;
762         const struct snd_soc_dapm_route *dapm_routes;
763         int num_dapm_routes;
764
765         struct work_struct deferred_resume_work;
766
767         /* lists of probed devices belonging to this card */
768         struct list_head codec_dev_list;
769         struct list_head platform_dev_list;
770         struct list_head dai_dev_list;
771
772         struct list_head widgets;
773         struct list_head paths;
774         struct list_head dapm_list;
775
776         /* Generic DAPM context for the card */
777         struct snd_soc_dapm_context dapm;
778
779 #ifdef CONFIG_DEBUG_FS
780         struct dentry *debugfs_card_root;
781         struct dentry *debugfs_pop_time;
782 #endif
783         u32 pop_time;
784
785         void *drvdata;
786 };
787
788 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
789 struct snd_soc_pcm_runtime  {
790         struct device dev;
791         struct snd_soc_card *card;
792         struct snd_soc_dai_link *dai_link;
793
794         unsigned int complete:1;
795         unsigned int dev_registered:1;
796
797         /* Symmetry data - only valid if symmetry is being enforced */
798         unsigned int rate;
799         long pmdown_time;
800
801         /* runtime devices */
802         struct snd_pcm *pcm;
803         struct snd_soc_codec *codec;
804         struct snd_soc_platform *platform;
805         struct snd_soc_dai *codec_dai;
806         struct snd_soc_dai *cpu_dai;
807
808         struct delayed_work delayed_work;
809 };
810
811 /* mixer control */
812 struct soc_mixer_control {
813         int min, max, platform_max;
814         unsigned int reg, rreg, shift, rshift, invert;
815 };
816
817 /* enumerated kcontrol */
818 struct soc_enum {
819         unsigned short reg;
820         unsigned short reg2;
821         unsigned char shift_l;
822         unsigned char shift_r;
823         unsigned int max;
824         unsigned int mask;
825         const char * const *texts;
826         const unsigned int *values;
827         void *dapm;
828 };
829
830 /* codec IO */
831 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
832 unsigned int snd_soc_write(struct snd_soc_codec *codec,
833                            unsigned int reg, unsigned int val);
834 unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
835                                     unsigned int reg, const void *data, size_t len);
836
837 /* device driver data */
838
839 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
840                 void *data)
841 {
842         card->drvdata = data;
843 }
844
845 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
846 {
847         return card->drvdata;
848 }
849
850 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
851                 void *data)
852 {
853         dev_set_drvdata(codec->dev, data);
854 }
855
856 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
857 {
858         return dev_get_drvdata(codec->dev);
859 }
860
861 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
862                 void *data)
863 {
864         dev_set_drvdata(platform->dev, data);
865 }
866
867 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
868 {
869         return dev_get_drvdata(platform->dev);
870 }
871
872 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
873                 void *data)
874 {
875         dev_set_drvdata(&rtd->dev, data);
876 }
877
878 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
879 {
880         return dev_get_drvdata(&rtd->dev);
881 }
882
883 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
884 {
885         INIT_LIST_HEAD(&card->dai_dev_list);
886         INIT_LIST_HEAD(&card->codec_dev_list);
887         INIT_LIST_HEAD(&card->platform_dev_list);
888         INIT_LIST_HEAD(&card->widgets);
889         INIT_LIST_HEAD(&card->paths);
890         INIT_LIST_HEAD(&card->dapm_list);
891 }
892
893 int snd_soc_util_init(void);
894 void snd_soc_util_exit(void);
895
896 #include <sound/soc-dai.h>
897
898 #ifdef CONFIG_DEBUG_FS
899 extern struct dentry *snd_soc_debugfs_root;
900 #endif
901
902 extern const struct dev_pm_ops snd_soc_pm_ops;
903
904 #endif