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