ASoC: Support turning off bias when the CODEC is idle
[safe/jmp/linux-2.6] / 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/workqueue.h>
19 #include <linux/interrupt.h>
20 #include <linux/kernel.h>
21 #include <sound/core.h>
22 #include <sound/pcm.h>
23 #include <sound/control.h>
24 #include <sound/ac97_codec.h>
25
26 /*
27  * Convenience kcontrol builders
28  */
29 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
30         ((unsigned long)&(struct soc_mixer_control) \
31         {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
32         .invert = xinvert})
33 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
34         ((unsigned long)&(struct soc_mixer_control) \
35         {.reg = xreg, .max = xmax, .invert = xinvert})
36 #define SOC_SINGLE(xname, reg, shift, max, invert) \
37 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
38         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
39         .put = snd_soc_put_volsw, \
40         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
41 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
42 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
43         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
44                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
45         .tlv.p = (tlv_array), \
46         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
47         .put = snd_soc_put_volsw, \
48         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
49 #define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
50 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
51         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
52         .put = snd_soc_put_volsw, \
53         .private_value = (unsigned long)&(struct soc_mixer_control) \
54                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
55                  .max = xmax, .invert = xinvert} }
56 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
57 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
58         .info = snd_soc_info_volsw_2r, \
59         .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
60         .private_value = (unsigned long)&(struct soc_mixer_control) \
61                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
62                 .max = xmax, .invert = xinvert} }
63 #define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
64 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
65         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
66                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
67         .tlv.p = (tlv_array), \
68         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
69         .put = snd_soc_put_volsw, \
70         .private_value = (unsigned long)&(struct soc_mixer_control) \
71                 {.reg = xreg, .shift = shift_left, .rshift = shift_right,\
72                  .max = xmax, .invert = xinvert} }
73 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
74 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
75         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
76                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
77         .tlv.p = (tlv_array), \
78         .info = snd_soc_info_volsw_2r, \
79         .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
80         .private_value = (unsigned long)&(struct soc_mixer_control) \
81                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
82                 .max = xmax, .invert = xinvert} }
83 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
84 {       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
85         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
86                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
87         .tlv.p  = (tlv_array), \
88         .info   = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
89         .put    = snd_soc_put_volsw_s8, \
90         .private_value = (unsigned long)&(struct soc_mixer_control) \
91                 {.reg = xreg, .min = xmin, .max = xmax} }
92 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
93 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
94         .max = xmax, .texts = xtexts }
95 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
96         SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
97 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
98 {       .max = xmax, .texts = xtexts }
99 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
100 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
101         .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
102 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
103         SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
104 #define SOC_ENUM(xname, xenum) \
105 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
106         .info = snd_soc_info_enum_double, \
107         .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
108         .private_value = (unsigned long)&xenum }
109 #define SOC_VALUE_ENUM(xname, xenum) \
110 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
111         .info = snd_soc_info_enum_double, \
112         .get = snd_soc_get_value_enum_double, \
113         .put = snd_soc_put_value_enum_double, \
114         .private_value = (unsigned long)&xenum }
115 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
116          xhandler_get, xhandler_put) \
117 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
118         .info = snd_soc_info_volsw, \
119         .get = xhandler_get, .put = xhandler_put, \
120         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
121 #define SOC_DOUBLE_EXT(xname, xreg, shift_left, shift_right, xmax, xinvert,\
122          xhandler_get, xhandler_put) \
123 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
124         .info = snd_soc_info_volsw, \
125         .get = xhandler_get, .put = xhandler_put, \
126         .private_value = (unsigned long)&(struct soc_mixer_control) \
127                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
128                  .max = xmax, .invert = xinvert} }
129 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
130          xhandler_get, xhandler_put, tlv_array) \
131 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
132         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
133                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
134         .tlv.p = (tlv_array), \
135         .info = snd_soc_info_volsw, \
136         .get = xhandler_get, .put = xhandler_put, \
137         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
138 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
139          xhandler_get, xhandler_put, tlv_array) \
140 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
141         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
142                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
143         .tlv.p = (tlv_array), \
144         .info = snd_soc_info_volsw, \
145         .get = xhandler_get, .put = xhandler_put, \
146         .private_value = (unsigned long)&(struct soc_mixer_control) \
147                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
148                 .max = xmax, .invert = xinvert} }
149 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
150          xhandler_get, xhandler_put, tlv_array) \
151 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
152         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
153                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
154         .tlv.p = (tlv_array), \
155         .info = snd_soc_info_volsw_2r, \
156         .get = xhandler_get, .put = xhandler_put, \
157         .private_value = (unsigned long)&(struct soc_mixer_control) \
158                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
159                 .max = xmax, .invert = xinvert} }
160 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
161 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
162         .info = snd_soc_info_bool_ext, \
163         .get = xhandler_get, .put = xhandler_put, \
164         .private_value = xdata }
165 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
166 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
167         .info = snd_soc_info_enum_ext, \
168         .get = xhandler_get, .put = xhandler_put, \
169         .private_value = (unsigned long)&xenum }
170
171 /*
172  * Bias levels
173  *
174  * @ON:      Bias is fully on for audio playback and capture operations.
175  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
176  *           stream start and stop operations.
177  * @STANDBY: Low power standby state when no playback/capture operations are
178  *           in progress. NOTE: The transition time between STANDBY and ON
179  *           should be as fast as possible and no longer than 10ms.
180  * @OFF:     Power Off. No restrictions on transition times.
181  */
182 enum snd_soc_bias_level {
183         SND_SOC_BIAS_ON,
184         SND_SOC_BIAS_PREPARE,
185         SND_SOC_BIAS_STANDBY,
186         SND_SOC_BIAS_OFF,
187 };
188
189 struct snd_jack;
190 struct snd_soc_card;
191 struct snd_soc_device;
192 struct snd_soc_pcm_stream;
193 struct snd_soc_ops;
194 struct snd_soc_dai_mode;
195 struct snd_soc_pcm_runtime;
196 struct snd_soc_dai;
197 struct snd_soc_platform;
198 struct snd_soc_codec;
199 struct soc_enum;
200 struct snd_soc_ac97_ops;
201 struct snd_soc_jack;
202 struct snd_soc_jack_pin;
203 #ifdef CONFIG_GPIOLIB
204 struct snd_soc_jack_gpio;
205 #endif
206
207 typedef int (*hw_write_t)(void *,const char* ,int);
208
209 extern struct snd_ac97_bus_ops soc_ac97_ops;
210
211 enum snd_soc_control_type {
212         SND_SOC_CUSTOM,
213         SND_SOC_I2C,
214         SND_SOC_SPI,
215 };
216
217 int snd_soc_register_platform(struct snd_soc_platform *platform);
218 void snd_soc_unregister_platform(struct snd_soc_platform *platform);
219 int snd_soc_register_codec(struct snd_soc_codec *codec);
220 void snd_soc_unregister_codec(struct snd_soc_codec *codec);
221 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
222 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
223                                int addr_bits, int data_bits,
224                                enum snd_soc_control_type control);
225
226 /* pcm <-> DAI connect */
227 void snd_soc_free_pcms(struct snd_soc_device *socdev);
228 int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
229
230 /* Utility functions to get clock rates from various things */
231 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
232 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
233 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
234 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
235
236 /* set runtime hw params */
237 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
238         const struct snd_pcm_hardware *hw);
239
240 /* Jack reporting */
241 int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
242                      struct snd_soc_jack *jack);
243 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
244 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
245                           struct snd_soc_jack_pin *pins);
246 #ifdef CONFIG_GPIOLIB
247 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
248                         struct snd_soc_jack_gpio *gpios);
249 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
250                         struct snd_soc_jack_gpio *gpios);
251 #endif
252
253 /* codec register bit access */
254 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
255                                 unsigned int mask, unsigned int value);
256 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
257                                unsigned short reg, unsigned int mask,
258                                unsigned int value);
259 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
260                                 unsigned int mask, unsigned int value);
261
262 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
263         struct snd_ac97_bus_ops *ops, int num);
264 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
265
266 /*
267  *Controls
268  */
269 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
270         void *data, char *long_name);
271 int snd_soc_add_controls(struct snd_soc_codec *codec,
272         const struct snd_kcontrol_new *controls, int num_controls);
273 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
274         struct snd_ctl_elem_info *uinfo);
275 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
276         struct snd_ctl_elem_info *uinfo);
277 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
278         struct snd_ctl_elem_value *ucontrol);
279 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
280         struct snd_ctl_elem_value *ucontrol);
281 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
282         struct snd_ctl_elem_value *ucontrol);
283 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
284         struct snd_ctl_elem_value *ucontrol);
285 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
286         struct snd_ctl_elem_info *uinfo);
287 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
288         struct snd_ctl_elem_info *uinfo);
289 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
290 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
291         struct snd_ctl_elem_value *ucontrol);
292 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
293         struct snd_ctl_elem_value *ucontrol);
294 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
295         struct snd_ctl_elem_info *uinfo);
296 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
297         struct snd_ctl_elem_value *ucontrol);
298 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
299         struct snd_ctl_elem_value *ucontrol);
300 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
301         struct snd_ctl_elem_info *uinfo);
302 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
303         struct snd_ctl_elem_value *ucontrol);
304 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
305         struct snd_ctl_elem_value *ucontrol);
306
307 /**
308  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
309  *
310  * @pin:    name of the pin to update
311  * @mask:   bits to check for in reported jack status
312  * @invert: if non-zero then pin is enabled when status is not reported
313  */
314 struct snd_soc_jack_pin {
315         struct list_head list;
316         const char *pin;
317         int mask;
318         bool invert;
319 };
320
321 /**
322  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
323  *
324  * @gpio:         gpio number
325  * @name:         gpio name
326  * @report:       value to report when jack detected
327  * @invert:       report presence in low state
328  * @debouce_time: debouce time in ms
329  */
330 #ifdef CONFIG_GPIOLIB
331 struct snd_soc_jack_gpio {
332         unsigned int gpio;
333         const char *name;
334         int report;
335         int invert;
336         int debounce_time;
337         struct snd_soc_jack *jack;
338         struct work_struct work;
339
340         int (*jack_status_check)(void);
341 };
342 #endif
343
344 struct snd_soc_jack {
345         struct snd_jack *jack;
346         struct snd_soc_card *card;
347         struct list_head pins;
348         int status;
349 };
350
351 /* SoC PCM stream information */
352 struct snd_soc_pcm_stream {
353         char *stream_name;
354         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
355         unsigned int rates;             /* SNDRV_PCM_RATE_* */
356         unsigned int rate_min;          /* min rate */
357         unsigned int rate_max;          /* max rate */
358         unsigned int channels_min;      /* min channels */
359         unsigned int channels_max;      /* max channels */
360         unsigned int active:1;          /* stream is in use */
361 };
362
363 /* SoC audio ops */
364 struct snd_soc_ops {
365         int (*startup)(struct snd_pcm_substream *);
366         void (*shutdown)(struct snd_pcm_substream *);
367         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
368         int (*hw_free)(struct snd_pcm_substream *);
369         int (*prepare)(struct snd_pcm_substream *);
370         int (*trigger)(struct snd_pcm_substream *, int);
371 };
372
373 /* SoC Audio Codec */
374 struct snd_soc_codec {
375         char *name;
376         struct module *owner;
377         struct mutex mutex;
378         struct device *dev;
379         struct snd_soc_device *socdev;
380
381         struct list_head list;
382
383         /* callbacks */
384         int (*set_bias_level)(struct snd_soc_codec *,
385                               enum snd_soc_bias_level level);
386
387         /* runtime */
388         struct snd_card *card;
389         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
390         unsigned int active;
391         unsigned int pcm_devs;
392         void *private_data;
393
394         /* codec IO */
395         void *control_data; /* codec control (i2c/3wire) data */
396         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
397         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
398         int (*display_register)(struct snd_soc_codec *, char *,
399                                 size_t, unsigned int);
400         int (*volatile_register)(unsigned int);
401         int (*readable_register)(unsigned int);
402         hw_write_t hw_write;
403         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
404         void *reg_cache;
405         short reg_cache_size;
406         short reg_cache_step;
407
408         unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
409
410         /* dapm */
411         u32 pop_time;
412         struct list_head dapm_widgets;
413         struct list_head dapm_paths;
414         enum snd_soc_bias_level bias_level;
415         enum snd_soc_bias_level suspend_bias_level;
416         struct delayed_work delayed_work;
417
418         /* codec DAI's */
419         struct snd_soc_dai *dai;
420         unsigned int num_dai;
421
422 #ifdef CONFIG_DEBUG_FS
423         struct dentry *debugfs_codec_root;
424         struct dentry *debugfs_reg;
425         struct dentry *debugfs_pop_time;
426         struct dentry *debugfs_dapm;
427 #endif
428 };
429
430 /* codec device */
431 struct snd_soc_codec_device {
432         int (*probe)(struct platform_device *pdev);
433         int (*remove)(struct platform_device *pdev);
434         int (*suspend)(struct platform_device *pdev, pm_message_t state);
435         int (*resume)(struct platform_device *pdev);
436 };
437
438 /* SoC platform interface */
439 struct snd_soc_platform {
440         char *name;
441         struct list_head list;
442
443         int (*probe)(struct platform_device *pdev);
444         int (*remove)(struct platform_device *pdev);
445         int (*suspend)(struct snd_soc_dai *dai);
446         int (*resume)(struct snd_soc_dai *dai);
447
448         /* pcm creation and destruction */
449         int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
450                 struct snd_pcm *);
451         void (*pcm_free)(struct snd_pcm *);
452
453         /* platform stream ops */
454         struct snd_pcm_ops *pcm_ops;
455 };
456
457 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
458 struct snd_soc_dai_link  {
459         char *name;                     /* Codec name */
460         char *stream_name;              /* Stream name */
461
462         /* DAI */
463         struct snd_soc_dai *codec_dai;
464         struct snd_soc_dai *cpu_dai;
465
466         /* machine stream operations */
467         struct snd_soc_ops *ops;
468
469         /* codec/machine specific init - e.g. add machine controls */
470         int (*init)(struct snd_soc_codec *codec);
471
472         /* Symmetry requirements */
473         unsigned int symmetric_rates:1;
474
475         /* Symmetry data - only valid if symmetry is being enforced */
476         unsigned int rate;
477
478         /* DAI pcm */
479         struct snd_pcm *pcm;
480 };
481
482 /* SoC card */
483 struct snd_soc_card {
484         char *name;
485         struct device *dev;
486
487         struct list_head list;
488
489         int instantiated;
490
491         int (*probe)(struct platform_device *pdev);
492         int (*remove)(struct platform_device *pdev);
493
494         /* the pre and post PM functions are used to do any PM work before and
495          * after the codec and DAI's do any PM work. */
496         int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
497         int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
498         int (*resume_pre)(struct platform_device *pdev);
499         int (*resume_post)(struct platform_device *pdev);
500
501         /* callbacks */
502         int (*set_bias_level)(struct snd_soc_card *,
503                               enum snd_soc_bias_level level);
504
505         /* CPU <--> Codec DAI links  */
506         struct snd_soc_dai_link *dai_link;
507         int num_links;
508
509         struct snd_soc_device *socdev;
510
511         struct snd_soc_codec *codec;
512
513         struct snd_soc_platform *platform;
514         struct delayed_work delayed_work;
515         struct work_struct deferred_resume_work;
516 };
517
518 /* SoC Device - the audio subsystem */
519 struct snd_soc_device {
520         struct device *dev;
521         struct snd_soc_card *card;
522         struct snd_soc_codec_device *codec_dev;
523         void *codec_data;
524 };
525
526 /* runtime channel data */
527 struct snd_soc_pcm_runtime {
528         struct snd_soc_dai_link *dai;
529         struct snd_soc_device *socdev;
530 };
531
532 /* mixer control */
533 struct soc_mixer_control {
534         int min, max;
535         unsigned int reg, rreg, shift, rshift, invert;
536 };
537
538 /* enumerated kcontrol */
539 struct soc_enum {
540         unsigned short reg;
541         unsigned short reg2;
542         unsigned char shift_l;
543         unsigned char shift_r;
544         unsigned int max;
545         unsigned int mask;
546         const char **texts;
547         const unsigned int *values;
548         void *dapm;
549 };
550
551 /* codec IO */
552 static inline unsigned int snd_soc_read(struct snd_soc_codec *codec,
553                                         unsigned int reg)
554 {
555         return codec->read(codec, reg);
556 }
557
558 static inline unsigned int snd_soc_write(struct snd_soc_codec *codec,
559                                          unsigned int reg, unsigned int val)
560 {
561         return codec->write(codec, reg, val);
562 }
563
564 #include <sound/soc-dai.h>
565
566 #endif