2 * linux/sound/soc.h -- ALSA SoC Layer
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
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.
13 #ifndef __LINUX_SND_SOC_H
14 #define __LINUX_SND_SOC_H
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>
27 * Convenience kcontrol builders
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, \
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 }
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.
182 enum snd_soc_bias_level {
184 SND_SOC_BIAS_PREPARE,
185 SND_SOC_BIAS_STANDBY,
191 struct snd_soc_device;
192 struct snd_soc_pcm_stream;
194 struct snd_soc_dai_mode;
195 struct snd_soc_pcm_runtime;
197 struct snd_soc_platform;
198 struct snd_soc_codec;
200 struct snd_soc_ac97_ops;
202 struct snd_soc_jack_pin;
203 #ifdef CONFIG_GPIOLIB
204 struct snd_soc_jack_gpio;
207 typedef int (*hw_write_t)(void *,const char* ,int);
208 typedef int (*hw_read_t)(void *,char* ,int);
210 extern struct snd_ac97_bus_ops soc_ac97_ops;
212 int snd_soc_register_platform(struct snd_soc_platform *platform);
213 void snd_soc_unregister_platform(struct snd_soc_platform *platform);
214 int snd_soc_register_codec(struct snd_soc_codec *codec);
215 void snd_soc_unregister_codec(struct snd_soc_codec *codec);
216 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
219 int snd_soc_suspend_device(struct device *dev);
220 int snd_soc_resume_device(struct device *dev);
223 /* pcm <-> DAI connect */
224 void snd_soc_free_pcms(struct snd_soc_device *socdev);
225 int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
226 int snd_soc_init_card(struct snd_soc_device *socdev);
228 /* set runtime hw params */
229 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
230 const struct snd_pcm_hardware *hw);
233 int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
234 struct snd_soc_jack *jack);
235 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
236 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
237 struct snd_soc_jack_pin *pins);
238 #ifdef CONFIG_GPIOLIB
239 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
240 struct snd_soc_jack_gpio *gpios);
241 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
242 struct snd_soc_jack_gpio *gpios);
245 /* codec register bit access */
246 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
247 unsigned int mask, unsigned int value);
248 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
249 unsigned int mask, unsigned int value);
251 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
252 struct snd_ac97_bus_ops *ops, int num);
253 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
258 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
259 void *data, char *long_name);
260 int snd_soc_add_controls(struct snd_soc_codec *codec,
261 const struct snd_kcontrol_new *controls, int num_controls);
262 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
263 struct snd_ctl_elem_info *uinfo);
264 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
265 struct snd_ctl_elem_info *uinfo);
266 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
267 struct snd_ctl_elem_value *ucontrol);
268 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
269 struct snd_ctl_elem_value *ucontrol);
270 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
271 struct snd_ctl_elem_value *ucontrol);
272 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
273 struct snd_ctl_elem_value *ucontrol);
274 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
275 struct snd_ctl_elem_info *uinfo);
276 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
277 struct snd_ctl_elem_info *uinfo);
278 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
279 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
280 struct snd_ctl_elem_value *ucontrol);
281 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
282 struct snd_ctl_elem_value *ucontrol);
283 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
284 struct snd_ctl_elem_info *uinfo);
285 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
286 struct snd_ctl_elem_value *ucontrol);
287 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
288 struct snd_ctl_elem_value *ucontrol);
289 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
290 struct snd_ctl_elem_info *uinfo);
291 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
292 struct snd_ctl_elem_value *ucontrol);
293 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
294 struct snd_ctl_elem_value *ucontrol);
297 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
299 * @pin: name of the pin to update
300 * @mask: bits to check for in reported jack status
301 * @invert: if non-zero then pin is enabled when status is not reported
303 struct snd_soc_jack_pin {
304 struct list_head list;
311 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
315 * @report: value to report when jack detected
316 * @invert: report presence in low state
317 * @debouce_time: debouce time in ms
319 #ifdef CONFIG_GPIOLIB
320 struct snd_soc_jack_gpio {
326 struct snd_soc_jack *jack;
327 struct work_struct work;
331 struct snd_soc_jack {
332 struct snd_jack *jack;
333 struct snd_soc_card *card;
334 struct list_head pins;
338 /* SoC PCM stream information */
339 struct snd_soc_pcm_stream {
341 u64 formats; /* SNDRV_PCM_FMTBIT_* */
342 unsigned int rates; /* SNDRV_PCM_RATE_* */
343 unsigned int rate_min; /* min rate */
344 unsigned int rate_max; /* max rate */
345 unsigned int channels_min; /* min channels */
346 unsigned int channels_max; /* max channels */
347 unsigned int active:1; /* stream is in use */
352 int (*startup)(struct snd_pcm_substream *);
353 void (*shutdown)(struct snd_pcm_substream *);
354 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
355 int (*hw_free)(struct snd_pcm_substream *);
356 int (*prepare)(struct snd_pcm_substream *);
357 int (*trigger)(struct snd_pcm_substream *, int);
360 /* SoC Audio Codec */
361 struct snd_soc_codec {
363 struct module *owner;
366 struct snd_soc_device *socdev;
368 struct list_head list;
371 int (*set_bias_level)(struct snd_soc_codec *,
372 enum snd_soc_bias_level level);
375 struct snd_card *card;
376 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
378 unsigned int pcm_devs;
382 void *control_data; /* codec control (i2c/3wire) data */
383 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
384 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
385 int (*display_register)(struct snd_soc_codec *, char *,
386 size_t, unsigned int);
387 int (*volatile_register)(unsigned int);
388 int (*readable_register)(unsigned int);
392 short reg_cache_size;
393 short reg_cache_step;
397 struct list_head dapm_widgets;
398 struct list_head dapm_paths;
399 enum snd_soc_bias_level bias_level;
400 enum snd_soc_bias_level suspend_bias_level;
401 struct delayed_work delayed_work;
404 struct snd_soc_dai *dai;
405 unsigned int num_dai;
407 #ifdef CONFIG_DEBUG_FS
408 struct dentry *debugfs_reg;
409 struct dentry *debugfs_pop_time;
414 struct snd_soc_codec_device {
415 int (*probe)(struct platform_device *pdev);
416 int (*remove)(struct platform_device *pdev);
417 int (*suspend)(struct platform_device *pdev, pm_message_t state);
418 int (*resume)(struct platform_device *pdev);
421 /* SoC platform interface */
422 struct snd_soc_platform {
424 struct list_head list;
426 int (*probe)(struct platform_device *pdev);
427 int (*remove)(struct platform_device *pdev);
428 int (*suspend)(struct snd_soc_dai *dai);
429 int (*resume)(struct snd_soc_dai *dai);
431 /* pcm creation and destruction */
432 int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
434 void (*pcm_free)(struct snd_pcm *);
436 /* platform stream ops */
437 struct snd_pcm_ops *pcm_ops;
440 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
441 struct snd_soc_dai_link {
442 char *name; /* Codec name */
443 char *stream_name; /* Stream name */
446 struct snd_soc_dai *codec_dai;
447 struct snd_soc_dai *cpu_dai;
449 /* machine stream operations */
450 struct snd_soc_ops *ops;
452 /* codec/machine specific init - e.g. add machine controls */
453 int (*init)(struct snd_soc_codec *codec);
455 /* Symmetry requirements */
456 unsigned int symmetric_rates:1;
458 /* Symmetry data - only valid if symmetry is being enforced */
466 struct snd_soc_card {
470 struct list_head list;
474 int (*probe)(struct platform_device *pdev);
475 int (*remove)(struct platform_device *pdev);
477 /* the pre and post PM functions are used to do any PM work before and
478 * after the codec and DAI's do any PM work. */
479 int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
480 int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
481 int (*resume_pre)(struct platform_device *pdev);
482 int (*resume_post)(struct platform_device *pdev);
485 int (*set_bias_level)(struct snd_soc_card *,
486 enum snd_soc_bias_level level);
488 /* CPU <--> Codec DAI links */
489 struct snd_soc_dai_link *dai_link;
492 struct snd_soc_device *socdev;
494 struct snd_soc_codec *codec;
496 struct snd_soc_platform *platform;
497 struct delayed_work delayed_work;
498 struct work_struct deferred_resume_work;
501 /* SoC Device - the audio subsystem */
502 struct snd_soc_device {
504 struct snd_soc_card *card;
505 struct snd_soc_codec_device *codec_dev;
509 /* runtime channel data */
510 struct snd_soc_pcm_runtime {
511 struct snd_soc_dai_link *dai;
512 struct snd_soc_device *socdev;
516 struct soc_mixer_control {
518 unsigned int reg, rreg, shift, rshift, invert;
521 /* enumerated kcontrol */
525 unsigned char shift_l;
526 unsigned char shift_r;
530 const unsigned int *values;
535 static inline unsigned int snd_soc_read(struct snd_soc_codec *codec,
538 return codec->read(codec, reg);
541 static inline unsigned int snd_soc_write(struct snd_soc_codec *codec,
542 unsigned int reg, unsigned int val)
544 return codec->write(codec, reg, val);
547 #include <sound/soc-dai.h>