ASoC: Move widgets from DAPM context to snd_soc_card
[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_pin;
238 struct snd_soc_cache_ops;
239 #include <sound/soc-dapm.h>
240
241 #ifdef CONFIG_GPIOLIB
242 struct snd_soc_jack_gpio;
243 #endif
244
245 typedef int (*hw_write_t)(void *,const char* ,int);
246
247 extern struct snd_ac97_bus_ops soc_ac97_ops;
248
249 enum snd_soc_control_type {
250         SND_SOC_CUSTOM,
251         SND_SOC_I2C,
252         SND_SOC_SPI,
253 };
254
255 enum snd_soc_compress_type {
256         SND_SOC_FLAT_COMPRESSION = 1,
257         SND_SOC_LZO_COMPRESSION,
258         SND_SOC_RBTREE_COMPRESSION
259 };
260
261 int snd_soc_register_platform(struct device *dev,
262                 struct snd_soc_platform_driver *platform_drv);
263 void snd_soc_unregister_platform(struct device *dev);
264 int snd_soc_register_codec(struct device *dev,
265                 const struct snd_soc_codec_driver *codec_drv,
266                 struct snd_soc_dai_driver *dai_drv, int num_dai);
267 void snd_soc_unregister_codec(struct device *dev);
268 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
269 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
270                                int addr_bits, int data_bits,
271                                enum snd_soc_control_type control);
272 int snd_soc_cache_sync(struct snd_soc_codec *codec);
273 int snd_soc_cache_init(struct snd_soc_codec *codec);
274 int snd_soc_cache_exit(struct snd_soc_codec *codec);
275 int snd_soc_cache_write(struct snd_soc_codec *codec,
276                         unsigned int reg, unsigned int value);
277 int snd_soc_cache_read(struct snd_soc_codec *codec,
278                        unsigned int reg, unsigned int *value);
279
280 /* Utility functions to get clock rates from various things */
281 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
282 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
283 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
284 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
285
286 /* set runtime hw params */
287 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
288         const struct snd_pcm_hardware *hw);
289
290 /* Jack reporting */
291 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
292                      struct snd_soc_jack *jack);
293 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
294 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
295                           struct snd_soc_jack_pin *pins);
296 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
297                                     struct notifier_block *nb);
298 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
299                                       struct notifier_block *nb);
300 #ifdef CONFIG_GPIOLIB
301 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
302                         struct snd_soc_jack_gpio *gpios);
303 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
304                         struct snd_soc_jack_gpio *gpios);
305 #endif
306
307 /* codec register bit access */
308 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
309                                 unsigned int mask, unsigned int value);
310 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
311                                unsigned short reg, unsigned int mask,
312                                unsigned int value);
313 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
314                                 unsigned int mask, unsigned int value);
315
316 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
317         struct snd_ac97_bus_ops *ops, int num);
318 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
319
320 /*
321  *Controls
322  */
323 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
324         void *data, char *long_name);
325 int snd_soc_add_controls(struct snd_soc_codec *codec,
326         const struct snd_kcontrol_new *controls, int num_controls);
327 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
328         struct snd_ctl_elem_info *uinfo);
329 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
330         struct snd_ctl_elem_info *uinfo);
331 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
332         struct snd_ctl_elem_value *ucontrol);
333 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
334         struct snd_ctl_elem_value *ucontrol);
335 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
336         struct snd_ctl_elem_value *ucontrol);
337 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
338         struct snd_ctl_elem_value *ucontrol);
339 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
340         struct snd_ctl_elem_info *uinfo);
341 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
342         struct snd_ctl_elem_info *uinfo);
343 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
344 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
345         struct snd_ctl_elem_value *ucontrol);
346 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
347         struct snd_ctl_elem_value *ucontrol);
348 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
349         struct snd_ctl_elem_info *uinfo);
350 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
351         struct snd_ctl_elem_value *ucontrol);
352 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
353         struct snd_ctl_elem_value *ucontrol);
354 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
355         struct snd_ctl_elem_info *uinfo);
356 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
357         struct snd_ctl_elem_value *ucontrol);
358 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
359         struct snd_ctl_elem_value *ucontrol);
360 int snd_soc_limit_volume(struct snd_soc_codec *codec,
361         const char *name, int max);
362 int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
363         struct snd_ctl_elem_info *uinfo);
364 int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
365         struct snd_ctl_elem_value *ucontrol);
366 int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
367         struct snd_ctl_elem_value *ucontrol);
368
369 /**
370  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
371  *
372  * @pin:    name of the pin to update
373  * @mask:   bits to check for in reported jack status
374  * @invert: if non-zero then pin is enabled when status is not reported
375  */
376 struct snd_soc_jack_pin {
377         struct list_head list;
378         const char *pin;
379         int mask;
380         bool invert;
381 };
382
383 /**
384  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
385  *
386  * @gpio:         gpio number
387  * @name:         gpio name
388  * @report:       value to report when jack detected
389  * @invert:       report presence in low state
390  * @debouce_time: debouce time in ms
391  */
392 #ifdef CONFIG_GPIOLIB
393 struct snd_soc_jack_gpio {
394         unsigned int gpio;
395         const char *name;
396         int report;
397         int invert;
398         int debounce_time;
399         struct snd_soc_jack *jack;
400         struct delayed_work work;
401
402         int (*jack_status_check)(void);
403 };
404 #endif
405
406 struct snd_soc_jack {
407         struct snd_jack *jack;
408         struct snd_soc_codec *codec;
409         struct list_head pins;
410         int status;
411         struct blocking_notifier_head notifier;
412 };
413
414 /* SoC PCM stream information */
415 struct snd_soc_pcm_stream {
416         const char *stream_name;
417         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
418         unsigned int rates;             /* SNDRV_PCM_RATE_* */
419         unsigned int rate_min;          /* min rate */
420         unsigned int rate_max;          /* max rate */
421         unsigned int channels_min;      /* min channels */
422         unsigned int channels_max;      /* max channels */
423 };
424
425 /* SoC audio ops */
426 struct snd_soc_ops {
427         int (*startup)(struct snd_pcm_substream *);
428         void (*shutdown)(struct snd_pcm_substream *);
429         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
430         int (*hw_free)(struct snd_pcm_substream *);
431         int (*prepare)(struct snd_pcm_substream *);
432         int (*trigger)(struct snd_pcm_substream *, int);
433 };
434
435 /* SoC cache ops */
436 struct snd_soc_cache_ops {
437         const char *name;
438         enum snd_soc_compress_type id;
439         int (*init)(struct snd_soc_codec *codec);
440         int (*exit)(struct snd_soc_codec *codec);
441         int (*read)(struct snd_soc_codec *codec, unsigned int reg,
442                 unsigned int *value);
443         int (*write)(struct snd_soc_codec *codec, unsigned int reg,
444                 unsigned int value);
445         int (*sync)(struct snd_soc_codec *codec);
446 };
447
448 /* SoC Audio Codec device */
449 struct snd_soc_codec {
450         const char *name;
451         const char *name_prefix;
452         int id;
453         struct device *dev;
454         const struct snd_soc_codec_driver *driver;
455
456         struct mutex mutex;
457         struct snd_soc_card *card;
458         struct list_head list;
459         struct list_head card_list;
460         int num_dai;
461         enum snd_soc_compress_type compress_type;
462
463         /* runtime */
464         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
465         unsigned int active;
466         unsigned int cache_only:1;  /* Suppress writes to hardware */
467         unsigned int cache_sync:1; /* Cache needs to be synced to hardware */
468         unsigned int suspended:1; /* Codec is in suspend PM state */
469         unsigned int probed:1; /* Codec has been probed */
470         unsigned int ac97_registered:1; /* Codec has been AC97 registered */
471         unsigned int ac97_created:1; /* Codec has been created by SoC */
472         unsigned int sysfs_registered:1; /* codec has been sysfs registered */
473         unsigned int cache_init:1; /* codec cache has been initialized */
474
475         /* codec IO */
476         void *control_data; /* codec control (i2c/3wire) data */
477         hw_write_t hw_write;
478         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
479         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
480         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
481         void *reg_cache;
482         const void *reg_def_copy;
483         const struct snd_soc_cache_ops *cache_ops;
484         struct mutex cache_rw_mutex;
485
486         /* dapm */
487         struct snd_soc_dapm_context dapm;
488
489 #ifdef CONFIG_DEBUG_FS
490         struct dentry *debugfs_codec_root;
491         struct dentry *debugfs_reg;
492         struct dentry *debugfs_dapm;
493 #endif
494 };
495
496 /* codec driver */
497 struct snd_soc_codec_driver {
498
499         /* driver ops */
500         int (*probe)(struct snd_soc_codec *);
501         int (*remove)(struct snd_soc_codec *);
502         int (*suspend)(struct snd_soc_codec *,
503                         pm_message_t state);
504         int (*resume)(struct snd_soc_codec *);
505
506         /* codec IO */
507         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
508         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
509         int (*display_register)(struct snd_soc_codec *, char *,
510                                 size_t, unsigned int);
511         int (*volatile_register)(unsigned int);
512         int (*readable_register)(unsigned int);
513         short reg_cache_size;
514         short reg_cache_step;
515         short reg_word_size;
516         const void *reg_cache_default;
517         enum snd_soc_compress_type compress_type;
518
519         /* codec bias level */
520         int (*set_bias_level)(struct snd_soc_codec *,
521                               enum snd_soc_bias_level level);
522 };
523
524 /* SoC platform interface */
525 struct snd_soc_platform_driver {
526
527         int (*probe)(struct snd_soc_platform *);
528         int (*remove)(struct snd_soc_platform *);
529         int (*suspend)(struct snd_soc_dai *dai);
530         int (*resume)(struct snd_soc_dai *dai);
531
532         /* pcm creation and destruction */
533         int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
534                 struct snd_pcm *);
535         void (*pcm_free)(struct snd_pcm *);
536
537         /*
538          * For platform caused delay reporting.
539          * Optional.
540          */
541         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
542                 struct snd_soc_dai *);
543
544         /* platform stream ops */
545         struct snd_pcm_ops *ops;
546 };
547
548 struct snd_soc_platform {
549         const char *name;
550         int id;
551         struct device *dev;
552         struct snd_soc_platform_driver *driver;
553
554         unsigned int suspended:1; /* platform is suspended */
555         unsigned int probed:1;
556
557         struct snd_soc_card *card;
558         struct list_head list;
559         struct list_head card_list;
560 };
561
562 struct snd_soc_dai_link {
563         /* config - must be set by machine driver */
564         const char *name;                       /* Codec name */
565         const char *stream_name;                /* Stream name */
566         const char *codec_name;         /* for multi-codec */
567         const char *platform_name;      /* for multi-platform */
568         const char *cpu_dai_name;
569         const char *codec_dai_name;
570
571         /* Keep DAI active over suspend */
572         unsigned int ignore_suspend:1;
573
574         /* Symmetry requirements */
575         unsigned int symmetric_rates:1;
576
577         /* codec/machine specific init - e.g. add machine controls */
578         int (*init)(struct snd_soc_pcm_runtime *rtd);
579
580         /* machine stream operations */
581         struct snd_soc_ops *ops;
582 };
583
584 struct snd_soc_codec_conf {
585         const char *dev_name;
586
587         /*
588          * optional map of kcontrol, widget and path name prefixes that are
589          * associated per device
590          */
591         const char *name_prefix;
592
593         /*
594          * set this to the desired compression type if you want to
595          * override the one supplied in codec->driver->compress_type
596          */
597         enum snd_soc_compress_type compress_type;
598 };
599
600 struct snd_soc_aux_dev {
601         const char *name;               /* Codec name */
602         const char *codec_name;         /* for multi-codec */
603
604         /* codec/machine specific init - e.g. add machine controls */
605         int (*init)(struct snd_soc_dapm_context *dapm);
606 };
607
608 /* SoC card */
609 struct snd_soc_card {
610         const char *name;
611         struct device *dev;
612         struct snd_card *snd_card;
613         struct module *owner;
614
615         struct list_head list;
616         struct mutex mutex;
617
618         bool instantiated;
619
620         int (*probe)(struct platform_device *pdev);
621         int (*remove)(struct platform_device *pdev);
622
623         /* the pre and post PM functions are used to do any PM work before and
624          * after the codec and DAI's do any PM work. */
625         int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
626         int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
627         int (*resume_pre)(struct platform_device *pdev);
628         int (*resume_post)(struct platform_device *pdev);
629
630         /* callbacks */
631         int (*set_bias_level)(struct snd_soc_card *,
632                               enum snd_soc_bias_level level);
633         int (*set_bias_level_post)(struct snd_soc_card *,
634                                    enum snd_soc_bias_level level);
635
636         long pmdown_time;
637
638         /* CPU <--> Codec DAI links  */
639         struct snd_soc_dai_link *dai_link;
640         int num_links;
641         struct snd_soc_pcm_runtime *rtd;
642         int num_rtd;
643
644         /* optional codec specific configuration */
645         struct snd_soc_codec_conf *codec_conf;
646         int num_configs;
647
648         /*
649          * optional auxiliary devices such as amplifiers or codecs with DAI
650          * link unused
651          */
652         struct snd_soc_aux_dev *aux_dev;
653         int num_aux_devs;
654         struct snd_soc_pcm_runtime *rtd_aux;
655         int num_aux_rtd;
656
657         struct work_struct deferred_resume_work;
658
659         /* lists of probed devices belonging to this card */
660         struct list_head codec_dev_list;
661         struct list_head platform_dev_list;
662         struct list_head dai_dev_list;
663
664         struct list_head widgets;
665         struct list_head paths;
666
667 #ifdef CONFIG_DEBUG_FS
668         struct dentry *debugfs_card_root;
669         struct dentry *debugfs_pop_time;
670 #endif
671         u32 pop_time;
672 };
673
674 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
675 struct snd_soc_pcm_runtime  {
676         struct device dev;
677         struct snd_soc_card *card;
678         struct snd_soc_dai_link *dai_link;
679
680         unsigned int complete:1;
681         unsigned int dev_registered:1;
682
683         /* Symmetry data - only valid if symmetry is being enforced */
684         unsigned int rate;
685         long pmdown_time;
686
687         /* runtime devices */
688         struct snd_pcm *pcm;
689         struct snd_soc_codec *codec;
690         struct snd_soc_platform *platform;
691         struct snd_soc_dai *codec_dai;
692         struct snd_soc_dai *cpu_dai;
693
694         struct delayed_work delayed_work;
695 };
696
697 /* mixer control */
698 struct soc_mixer_control {
699         int min, max, platform_max;
700         unsigned int reg, rreg, shift, rshift, invert;
701 };
702
703 /* enumerated kcontrol */
704 struct soc_enum {
705         unsigned short reg;
706         unsigned short reg2;
707         unsigned char shift_l;
708         unsigned char shift_r;
709         unsigned int max;
710         unsigned int mask;
711         const char **texts;
712         const unsigned int *values;
713         void *dapm;
714 };
715
716 /* codec IO */
717 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
718 unsigned int snd_soc_write(struct snd_soc_codec *codec,
719                            unsigned int reg, unsigned int val);
720
721 /* device driver data */
722
723 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
724                 void *data)
725 {
726         dev_set_drvdata(codec->dev, data);
727 }
728
729 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
730 {
731         return dev_get_drvdata(codec->dev);
732 }
733
734 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
735                 void *data)
736 {
737         dev_set_drvdata(platform->dev, data);
738 }
739
740 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
741 {
742         return dev_get_drvdata(platform->dev);
743 }
744
745 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
746                 void *data)
747 {
748         dev_set_drvdata(&rtd->dev, data);
749 }
750
751 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
752 {
753         return dev_get_drvdata(&rtd->dev);
754 }
755
756 #include <sound/soc-dai.h>
757
758 #endif