ASoC: Add a cache_sync bit to the CODEC structure
[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/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  * Simplified versions of above macros, declaring a struct and calculating
173  * ARRAY_SIZE internally
174  */
175 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
176         struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
177                                                 ARRAY_SIZE(xtexts), xtexts)
178 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
179         SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
180 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
181         struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
182 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
183         struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
184                                                         ARRAY_SIZE(xtexts), xtexts, xvalues)
185 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
186         SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
187
188 /*
189  * Bias levels
190  *
191  * @ON:      Bias is fully on for audio playback and capture operations.
192  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
193  *           stream start and stop operations.
194  * @STANDBY: Low power standby state when no playback/capture operations are
195  *           in progress. NOTE: The transition time between STANDBY and ON
196  *           should be as fast as possible and no longer than 10ms.
197  * @OFF:     Power Off. No restrictions on transition times.
198  */
199 enum snd_soc_bias_level {
200         SND_SOC_BIAS_ON,
201         SND_SOC_BIAS_PREPARE,
202         SND_SOC_BIAS_STANDBY,
203         SND_SOC_BIAS_OFF,
204 };
205
206 struct snd_jack;
207 struct snd_soc_card;
208 struct snd_soc_device;
209 struct snd_soc_pcm_stream;
210 struct snd_soc_ops;
211 struct snd_soc_dai_mode;
212 struct snd_soc_pcm_runtime;
213 struct snd_soc_dai;
214 struct snd_soc_platform;
215 struct snd_soc_codec;
216 struct soc_enum;
217 struct snd_soc_ac97_ops;
218 struct snd_soc_jack;
219 struct snd_soc_jack_pin;
220 #ifdef CONFIG_GPIOLIB
221 struct snd_soc_jack_gpio;
222 #endif
223
224 typedef int (*hw_write_t)(void *,const char* ,int);
225
226 extern struct snd_ac97_bus_ops soc_ac97_ops;
227
228 enum snd_soc_control_type {
229         SND_SOC_CUSTOM,
230         SND_SOC_I2C,
231         SND_SOC_SPI,
232 };
233
234 int snd_soc_register_platform(struct snd_soc_platform *platform);
235 void snd_soc_unregister_platform(struct snd_soc_platform *platform);
236 int snd_soc_register_codec(struct snd_soc_codec *codec);
237 void snd_soc_unregister_codec(struct snd_soc_codec *codec);
238 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
239 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
240                                int addr_bits, int data_bits,
241                                enum snd_soc_control_type control);
242
243 /* pcm <-> DAI connect */
244 void snd_soc_free_pcms(struct snd_soc_device *socdev);
245 int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
246
247 /* Utility functions to get clock rates from various things */
248 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
249 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
250 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
251 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
252
253 /* set runtime hw params */
254 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
255         const struct snd_pcm_hardware *hw);
256
257 /* Jack reporting */
258 int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
259                      struct snd_soc_jack *jack);
260 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
261 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
262                           struct snd_soc_jack_pin *pins);
263 #ifdef CONFIG_GPIOLIB
264 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
265                         struct snd_soc_jack_gpio *gpios);
266 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
267                         struct snd_soc_jack_gpio *gpios);
268 #endif
269
270 /* codec register bit access */
271 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
272                                 unsigned int mask, unsigned int value);
273 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
274                                unsigned short reg, unsigned int mask,
275                                unsigned int value);
276 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
277                                 unsigned int mask, unsigned int value);
278
279 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
280         struct snd_ac97_bus_ops *ops, int num);
281 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
282
283 /*
284  *Controls
285  */
286 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
287         void *data, char *long_name);
288 int snd_soc_add_controls(struct snd_soc_codec *codec,
289         const struct snd_kcontrol_new *controls, int num_controls);
290 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
291         struct snd_ctl_elem_info *uinfo);
292 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
293         struct snd_ctl_elem_info *uinfo);
294 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
295         struct snd_ctl_elem_value *ucontrol);
296 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
297         struct snd_ctl_elem_value *ucontrol);
298 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
299         struct snd_ctl_elem_value *ucontrol);
300 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
301         struct snd_ctl_elem_value *ucontrol);
302 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
303         struct snd_ctl_elem_info *uinfo);
304 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
305         struct snd_ctl_elem_info *uinfo);
306 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
307 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
308         struct snd_ctl_elem_value *ucontrol);
309 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
310         struct snd_ctl_elem_value *ucontrol);
311 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
312         struct snd_ctl_elem_info *uinfo);
313 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
314         struct snd_ctl_elem_value *ucontrol);
315 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
316         struct snd_ctl_elem_value *ucontrol);
317 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
318         struct snd_ctl_elem_info *uinfo);
319 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
320         struct snd_ctl_elem_value *ucontrol);
321 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
322         struct snd_ctl_elem_value *ucontrol);
323
324 /**
325  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
326  *
327  * @pin:    name of the pin to update
328  * @mask:   bits to check for in reported jack status
329  * @invert: if non-zero then pin is enabled when status is not reported
330  */
331 struct snd_soc_jack_pin {
332         struct list_head list;
333         const char *pin;
334         int mask;
335         bool invert;
336 };
337
338 /**
339  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
340  *
341  * @gpio:         gpio number
342  * @name:         gpio name
343  * @report:       value to report when jack detected
344  * @invert:       report presence in low state
345  * @debouce_time: debouce time in ms
346  */
347 #ifdef CONFIG_GPIOLIB
348 struct snd_soc_jack_gpio {
349         unsigned int gpio;
350         const char *name;
351         int report;
352         int invert;
353         int debounce_time;
354         struct snd_soc_jack *jack;
355         struct work_struct work;
356
357         int (*jack_status_check)(void);
358 };
359 #endif
360
361 struct snd_soc_jack {
362         struct snd_jack *jack;
363         struct snd_soc_card *card;
364         struct list_head pins;
365         int status;
366 };
367
368 /* SoC PCM stream information */
369 struct snd_soc_pcm_stream {
370         char *stream_name;
371         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
372         unsigned int rates;             /* SNDRV_PCM_RATE_* */
373         unsigned int rate_min;          /* min rate */
374         unsigned int rate_max;          /* max rate */
375         unsigned int channels_min;      /* min channels */
376         unsigned int channels_max;      /* max channels */
377         unsigned int active:1;          /* stream is in use */
378 };
379
380 /* SoC audio ops */
381 struct snd_soc_ops {
382         int (*startup)(struct snd_pcm_substream *);
383         void (*shutdown)(struct snd_pcm_substream *);
384         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
385         int (*hw_free)(struct snd_pcm_substream *);
386         int (*prepare)(struct snd_pcm_substream *);
387         int (*trigger)(struct snd_pcm_substream *, int);
388 };
389
390 /* SoC Audio Codec */
391 struct snd_soc_codec {
392         char *name;
393         struct module *owner;
394         struct mutex mutex;
395         struct device *dev;
396         struct snd_soc_device *socdev;
397
398         struct list_head list;
399
400         /* callbacks */
401         int (*set_bias_level)(struct snd_soc_codec *,
402                               enum snd_soc_bias_level level);
403
404         /* runtime */
405         struct snd_card *card;
406         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
407         unsigned int active;
408         unsigned int pcm_devs;
409         void *private_data;
410
411         /* codec IO */
412         void *control_data; /* codec control (i2c/3wire) data */
413         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
414         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
415         int (*display_register)(struct snd_soc_codec *, char *,
416                                 size_t, unsigned int);
417         int (*volatile_register)(unsigned int);
418         int (*readable_register)(unsigned int);
419         hw_write_t hw_write;
420         unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
421         void *reg_cache;
422         short reg_cache_size;
423         short reg_cache_step;
424
425         unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
426         unsigned int cache_only:1;  /* Suppress writes to hardware */
427         unsigned int cache_sync:1; /* Cache needs to be synced to hardware */
428
429         /* dapm */
430         u32 pop_time;
431         struct list_head dapm_widgets;
432         struct list_head dapm_paths;
433         enum snd_soc_bias_level bias_level;
434         enum snd_soc_bias_level suspend_bias_level;
435         struct delayed_work delayed_work;
436
437         /* codec DAI's */
438         struct snd_soc_dai *dai;
439         unsigned int num_dai;
440
441 #ifdef CONFIG_DEBUG_FS
442         struct dentry *debugfs_codec_root;
443         struct dentry *debugfs_reg;
444         struct dentry *debugfs_pop_time;
445         struct dentry *debugfs_dapm;
446 #endif
447 };
448
449 /* codec device */
450 struct snd_soc_codec_device {
451         int (*probe)(struct platform_device *pdev);
452         int (*remove)(struct platform_device *pdev);
453         int (*suspend)(struct platform_device *pdev, pm_message_t state);
454         int (*resume)(struct platform_device *pdev);
455 };
456
457 /* SoC platform interface */
458 struct snd_soc_platform {
459         char *name;
460         struct list_head list;
461
462         int (*probe)(struct platform_device *pdev);
463         int (*remove)(struct platform_device *pdev);
464         int (*suspend)(struct snd_soc_dai *dai);
465         int (*resume)(struct snd_soc_dai *dai);
466
467         /* pcm creation and destruction */
468         int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
469                 struct snd_pcm *);
470         void (*pcm_free)(struct snd_pcm *);
471
472         /* platform stream ops */
473         struct snd_pcm_ops *pcm_ops;
474 };
475
476 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
477 struct snd_soc_dai_link  {
478         char *name;                     /* Codec name */
479         char *stream_name;              /* Stream name */
480
481         /* DAI */
482         struct snd_soc_dai *codec_dai;
483         struct snd_soc_dai *cpu_dai;
484
485         /* machine stream operations */
486         struct snd_soc_ops *ops;
487
488         /* codec/machine specific init - e.g. add machine controls */
489         int (*init)(struct snd_soc_codec *codec);
490
491         /* Symmetry requirements */
492         unsigned int symmetric_rates:1;
493
494         /* Symmetry data - only valid if symmetry is being enforced */
495         unsigned int rate;
496
497         /* DAI pcm */
498         struct snd_pcm *pcm;
499 };
500
501 /* SoC card */
502 struct snd_soc_card {
503         char *name;
504         struct device *dev;
505
506         struct list_head list;
507
508         int instantiated;
509
510         int (*probe)(struct platform_device *pdev);
511         int (*remove)(struct platform_device *pdev);
512
513         /* the pre and post PM functions are used to do any PM work before and
514          * after the codec and DAI's do any PM work. */
515         int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
516         int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
517         int (*resume_pre)(struct platform_device *pdev);
518         int (*resume_post)(struct platform_device *pdev);
519
520         /* callbacks */
521         int (*set_bias_level)(struct snd_soc_card *,
522                               enum snd_soc_bias_level level);
523
524         /* CPU <--> Codec DAI links  */
525         struct snd_soc_dai_link *dai_link;
526         int num_links;
527
528         struct snd_soc_device *socdev;
529
530         struct snd_soc_codec *codec;
531
532         struct snd_soc_platform *platform;
533         struct delayed_work delayed_work;
534         struct work_struct deferred_resume_work;
535 };
536
537 /* SoC Device - the audio subsystem */
538 struct snd_soc_device {
539         struct device *dev;
540         struct snd_soc_card *card;
541         struct snd_soc_codec_device *codec_dev;
542         void *codec_data;
543 };
544
545 /* runtime channel data */
546 struct snd_soc_pcm_runtime {
547         struct snd_soc_dai_link *dai;
548         struct snd_soc_device *socdev;
549 };
550
551 /* mixer control */
552 struct soc_mixer_control {
553         int min, max;
554         unsigned int reg, rreg, shift, rshift, invert;
555 };
556
557 /* enumerated kcontrol */
558 struct soc_enum {
559         unsigned short reg;
560         unsigned short reg2;
561         unsigned char shift_l;
562         unsigned char shift_r;
563         unsigned int max;
564         unsigned int mask;
565         const char **texts;
566         const unsigned int *values;
567         void *dapm;
568 };
569
570 /* codec IO */
571 static inline unsigned int snd_soc_read(struct snd_soc_codec *codec,
572                                         unsigned int reg)
573 {
574         return codec->read(codec, reg);
575 }
576
577 static inline unsigned int snd_soc_write(struct snd_soc_codec *codec,
578                                          unsigned int reg, unsigned int val)
579 {
580         return codec->write(codec, reg, val);
581 }
582
583 #include <sound/soc-dai.h>
584
585 #endif