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_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 }
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.
160 enum snd_soc_bias_level {
162 SND_SOC_BIAS_PREPARE,
163 SND_SOC_BIAS_STANDBY,
169 struct snd_soc_device;
170 struct snd_soc_pcm_stream;
172 struct snd_soc_dai_mode;
173 struct snd_soc_pcm_runtime;
175 struct snd_soc_platform;
176 struct snd_soc_codec;
178 struct snd_soc_ac97_ops;
180 struct snd_soc_jack_pin;
181 #ifdef CONFIG_GPIOLIB
182 struct snd_soc_jack_gpio;
185 typedef int (*hw_write_t)(void *,const char* ,int);
186 typedef int (*hw_read_t)(void *,char* ,int);
188 extern struct snd_ac97_bus_ops soc_ac97_ops;
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);
197 int snd_soc_suspend_device(struct device *dev);
198 int snd_soc_resume_device(struct device *dev);
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);
206 /* set runtime hw params */
207 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
208 const struct snd_pcm_hardware *hw);
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);
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);
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);
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);
275 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
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
281 struct snd_soc_jack_pin {
282 struct list_head list;
289 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
293 * @report: value to report when jack detected
294 * @invert: report presence in low state
295 * @debouce_time: debouce time in ms
297 #ifdef CONFIG_GPIOLIB
298 struct snd_soc_jack_gpio {
304 struct snd_soc_jack *jack;
305 struct work_struct work;
309 struct snd_soc_jack {
310 struct snd_jack *jack;
311 struct snd_soc_card *card;
312 struct list_head pins;
316 /* SoC PCM stream information */
317 struct snd_soc_pcm_stream {
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 */
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);
338 /* SoC Audio Codec */
339 struct snd_soc_codec {
341 struct module *owner;
344 struct snd_soc_device *socdev;
346 struct list_head list;
349 int (*set_bias_level)(struct snd_soc_codec *,
350 enum snd_soc_bias_level level);
353 struct snd_card *card;
354 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
356 unsigned int pcm_devs;
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);
369 short reg_cache_size;
370 short reg_cache_step;
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;
381 struct snd_soc_dai *dai;
382 unsigned int num_dai;
384 #ifdef CONFIG_DEBUG_FS
385 struct dentry *debugfs_reg;
386 struct dentry *debugfs_pop_time;
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);
398 /* SoC platform interface */
399 struct snd_soc_platform {
401 struct list_head list;
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);
408 /* pcm creation and destruction */
409 int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
411 void (*pcm_free)(struct snd_pcm *);
413 /* platform stream ops */
414 struct snd_pcm_ops *pcm_ops;
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 */
423 struct snd_soc_dai *codec_dai;
424 struct snd_soc_dai *cpu_dai;
426 /* machine stream operations */
427 struct snd_soc_ops *ops;
429 /* codec/machine specific init - e.g. add machine controls */
430 int (*init)(struct snd_soc_codec *codec);
432 /* Symmetry requirements */
433 unsigned int symmetric_rates:1;
435 /* Symmetry data - only valid if symmetry is being enforced */
443 struct snd_soc_card {
447 struct list_head list;
451 int (*probe)(struct platform_device *pdev);
452 int (*remove)(struct platform_device *pdev);
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);
462 int (*set_bias_level)(struct snd_soc_card *,
463 enum snd_soc_bias_level level);
465 /* CPU <--> Codec DAI links */
466 struct snd_soc_dai_link *dai_link;
469 struct snd_soc_device *socdev;
471 struct snd_soc_codec *codec;
473 struct snd_soc_platform *platform;
474 struct delayed_work delayed_work;
475 struct work_struct deferred_resume_work;
478 /* SoC Device - the audio subsystem */
479 struct snd_soc_device {
481 struct snd_soc_card *card;
482 struct snd_soc_codec_device *codec_dev;
486 /* runtime channel data */
487 struct snd_soc_pcm_runtime {
488 struct snd_soc_dai_link *dai;
489 struct snd_soc_device *socdev;
493 struct soc_mixer_control {
495 unsigned int reg, rreg, shift, rshift, invert;
498 /* enumerated kcontrol */
502 unsigned char shift_l;
503 unsigned char shift_r;
507 const unsigned int *values;
512 static inline unsigned int snd_soc_read(struct snd_soc_codec *codec,
515 return codec->read(codec, reg);
518 static inline unsigned int snd_soc_write(struct snd_soc_codec *codec,
519 unsigned int reg, unsigned int val)
521 return codec->write(codec, reg, val);
524 #include <sound/soc-dai.h>