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/notifier.h>
19 #include <linux/workqueue.h>
20 #include <linux/interrupt.h>
21 #include <linux/kernel.h>
22 #include <linux/regmap.h>
23 #include <sound/core.h>
24 #include <sound/pcm.h>
25 #include <sound/control.h>
26 #include <sound/ac97_codec.h>
29 * Convenience kcontrol builders
31 #define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert) \
32 ((unsigned long)&(struct soc_mixer_control) \
33 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
34 .rshift = shift_right, .max = xmax, .platform_max = xmax, \
36 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
37 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert)
38 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
39 ((unsigned long)&(struct soc_mixer_control) \
40 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
41 #define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
42 ((unsigned long)&(struct soc_mixer_control) \
43 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
44 .max = xmax, .platform_max = xmax, .invert = xinvert})
45 #define SOC_SINGLE(xname, reg, shift, max, invert) \
46 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
47 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
48 .put = snd_soc_put_volsw, \
49 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
50 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
51 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
52 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
53 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
54 .tlv.p = (tlv_array), \
55 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
56 .put = snd_soc_put_volsw, \
57 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
58 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
59 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
60 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
61 .put = snd_soc_put_volsw, \
62 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
64 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
65 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
66 .info = snd_soc_info_volsw, \
67 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
68 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
70 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
71 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
72 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
73 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
74 .tlv.p = (tlv_array), \
75 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
76 .put = snd_soc_put_volsw, \
77 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
79 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
80 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
81 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
82 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
83 .tlv.p = (tlv_array), \
84 .info = snd_soc_info_volsw, \
85 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
86 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
88 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
89 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
90 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
91 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
92 .tlv.p = (tlv_array), \
93 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
94 .put = snd_soc_put_volsw_s8, \
95 .private_value = (unsigned long)&(struct soc_mixer_control) \
96 {.reg = xreg, .min = xmin, .max = xmax, \
97 .platform_max = xmax} }
98 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
99 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
100 .max = xmax, .texts = xtexts }
101 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
102 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
103 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
104 { .max = xmax, .texts = xtexts }
105 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
106 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
107 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
108 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
109 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
110 #define SOC_ENUM(xname, xenum) \
111 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
112 .info = snd_soc_info_enum_double, \
113 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
114 .private_value = (unsigned long)&xenum }
115 #define SOC_VALUE_ENUM(xname, xenum) \
116 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
117 .info = snd_soc_info_enum_double, \
118 .get = snd_soc_get_value_enum_double, \
119 .put = snd_soc_put_value_enum_double, \
120 .private_value = (unsigned long)&xenum }
121 #define SOC_SINGLE_EXT(xname, xreg, xshift, 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 = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
127 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
128 xhandler_get, xhandler_put) \
129 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
130 .info = snd_soc_info_volsw, \
131 .get = xhandler_get, .put = xhandler_put, \
133 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert) }
134 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
135 xhandler_get, xhandler_put, tlv_array) \
136 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
137 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
138 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
139 .tlv.p = (tlv_array), \
140 .info = snd_soc_info_volsw, \
141 .get = xhandler_get, .put = xhandler_put, \
142 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
143 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
144 xhandler_get, xhandler_put, tlv_array) \
145 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
146 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
147 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
148 .tlv.p = (tlv_array), \
149 .info = snd_soc_info_volsw, \
150 .get = xhandler_get, .put = xhandler_put, \
151 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
153 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
154 xhandler_get, xhandler_put, tlv_array) \
155 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
156 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
157 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
158 .tlv.p = (tlv_array), \
159 .info = snd_soc_info_volsw, \
160 .get = xhandler_get, .put = xhandler_put, \
161 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
163 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
164 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
165 .info = snd_soc_info_bool_ext, \
166 .get = xhandler_get, .put = xhandler_put, \
167 .private_value = xdata }
168 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
169 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
170 .info = snd_soc_info_enum_ext, \
171 .get = xhandler_get, .put = xhandler_put, \
172 .private_value = (unsigned long)&xenum }
174 #define SOC_DOUBLE_R_SX_TLV(xname, xreg_left, xreg_right, xshift,\
175 xmin, xmax, tlv_array) \
176 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
177 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
178 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
179 .tlv.p = (tlv_array), \
180 .info = snd_soc_info_volsw_2r_sx, \
181 .get = snd_soc_get_volsw_2r_sx, \
182 .put = snd_soc_put_volsw_2r_sx, \
183 .private_value = (unsigned long)&(struct soc_mixer_control) \
185 .rreg = xreg_right, .shift = xshift, \
186 .min = xmin, .max = xmax} }
190 * Simplified versions of above macros, declaring a struct and calculating
191 * ARRAY_SIZE internally
193 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
194 struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
195 ARRAY_SIZE(xtexts), xtexts)
196 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
197 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
198 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
199 struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
200 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
201 struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
202 ARRAY_SIZE(xtexts), xtexts, xvalues)
203 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
204 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
207 * Component probe and remove ordering levels for components with runtime
210 #define SND_SOC_COMP_ORDER_FIRST -2
211 #define SND_SOC_COMP_ORDER_EARLY -1
212 #define SND_SOC_COMP_ORDER_NORMAL 0
213 #define SND_SOC_COMP_ORDER_LATE 1
214 #define SND_SOC_COMP_ORDER_LAST 2
219 * @ON: Bias is fully on for audio playback and capture operations.
220 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
221 * stream start and stop operations.
222 * @STANDBY: Low power standby state when no playback/capture operations are
223 * in progress. NOTE: The transition time between STANDBY and ON
224 * should be as fast as possible and no longer than 10ms.
225 * @OFF: Power Off. No restrictions on transition times.
227 enum snd_soc_bias_level {
228 SND_SOC_BIAS_OFF = 0,
229 SND_SOC_BIAS_STANDBY = 1,
230 SND_SOC_BIAS_PREPARE = 2,
236 struct snd_soc_pcm_stream;
238 struct snd_soc_pcm_runtime;
240 struct snd_soc_dai_driver;
241 struct snd_soc_platform;
242 struct snd_soc_dai_link;
243 struct snd_soc_platform_driver;
244 struct snd_soc_codec;
245 struct snd_soc_codec_driver;
248 struct snd_soc_jack_zone;
249 struct snd_soc_jack_pin;
250 struct snd_soc_cache_ops;
251 #include <sound/soc-dapm.h>
253 #ifdef CONFIG_GPIOLIB
254 struct snd_soc_jack_gpio;
257 typedef int (*hw_write_t)(void *,const char* ,int);
259 extern struct snd_ac97_bus_ops soc_ac97_ops;
261 enum snd_soc_control_type {
267 enum snd_soc_compress_type {
268 SND_SOC_FLAT_COMPRESSION = 1,
269 SND_SOC_RBTREE_COMPRESSION
272 enum snd_soc_pcm_subclass {
273 SND_SOC_PCM_CLASS_PCM = 0,
274 SND_SOC_PCM_CLASS_BE = 1,
277 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
278 int source, unsigned int freq, int dir);
279 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
280 unsigned int freq_in, unsigned int freq_out);
282 int snd_soc_register_card(struct snd_soc_card *card);
283 int snd_soc_unregister_card(struct snd_soc_card *card);
284 int snd_soc_suspend(struct device *dev);
285 int snd_soc_resume(struct device *dev);
286 int snd_soc_poweroff(struct device *dev);
287 int snd_soc_register_platform(struct device *dev,
288 struct snd_soc_platform_driver *platform_drv);
289 void snd_soc_unregister_platform(struct device *dev);
290 int snd_soc_register_codec(struct device *dev,
291 const struct snd_soc_codec_driver *codec_drv,
292 struct snd_soc_dai_driver *dai_drv, int num_dai);
293 void snd_soc_unregister_codec(struct device *dev);
294 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
296 int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
298 int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
300 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
301 int addr_bits, int data_bits,
302 enum snd_soc_control_type control);
303 int snd_soc_cache_sync(struct snd_soc_codec *codec);
304 int snd_soc_cache_init(struct snd_soc_codec *codec);
305 int snd_soc_cache_exit(struct snd_soc_codec *codec);
306 int snd_soc_cache_write(struct snd_soc_codec *codec,
307 unsigned int reg, unsigned int value);
308 int snd_soc_cache_read(struct snd_soc_codec *codec,
309 unsigned int reg, unsigned int *value);
310 int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
312 int snd_soc_default_readable_register(struct snd_soc_codec *codec,
314 int snd_soc_default_writable_register(struct snd_soc_codec *codec,
316 int snd_soc_platform_read(struct snd_soc_platform *platform,
318 int snd_soc_platform_write(struct snd_soc_platform *platform,
319 unsigned int reg, unsigned int val);
321 /* Utility functions to get clock rates from various things */
322 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
323 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
324 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
325 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
327 /* set runtime hw params */
328 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
329 const struct snd_pcm_hardware *hw);
332 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
333 struct snd_soc_jack *jack);
334 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
335 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
336 struct snd_soc_jack_pin *pins);
337 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
338 struct notifier_block *nb);
339 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
340 struct notifier_block *nb);
341 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
342 struct snd_soc_jack_zone *zones);
343 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
344 #ifdef CONFIG_GPIOLIB
345 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
346 struct snd_soc_jack_gpio *gpios);
347 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
348 struct snd_soc_jack_gpio *gpios);
351 /* codec register bit access */
352 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
353 unsigned int mask, unsigned int value);
354 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
355 unsigned short reg, unsigned int mask,
357 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
358 unsigned int mask, unsigned int value);
360 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
361 struct snd_ac97_bus_ops *ops, int num);
362 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
367 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
368 void *data, char *long_name,
370 int snd_soc_add_controls(struct snd_soc_codec *codec,
371 const struct snd_kcontrol_new *controls, int num_controls);
372 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
373 const struct snd_kcontrol_new *controls, int num_controls);
374 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
375 struct snd_ctl_elem_info *uinfo);
376 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
377 struct snd_ctl_elem_info *uinfo);
378 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
379 struct snd_ctl_elem_value *ucontrol);
380 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
381 struct snd_ctl_elem_value *ucontrol);
382 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
383 struct snd_ctl_elem_value *ucontrol);
384 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
385 struct snd_ctl_elem_value *ucontrol);
386 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
387 struct snd_ctl_elem_info *uinfo);
388 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
389 struct snd_ctl_elem_info *uinfo);
390 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
391 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
392 struct snd_ctl_elem_value *ucontrol);
393 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
394 struct snd_ctl_elem_value *ucontrol);
395 #define snd_soc_get_volsw_2r snd_soc_get_volsw
396 #define snd_soc_put_volsw_2r snd_soc_put_volsw
397 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
398 struct snd_ctl_elem_info *uinfo);
399 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
400 struct snd_ctl_elem_value *ucontrol);
401 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
402 struct snd_ctl_elem_value *ucontrol);
403 int snd_soc_limit_volume(struct snd_soc_codec *codec,
404 const char *name, int max);
405 int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
406 struct snd_ctl_elem_info *uinfo);
407 int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
408 struct snd_ctl_elem_value *ucontrol);
409 int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
410 struct snd_ctl_elem_value *ucontrol);
413 * struct snd_soc_reg_access - Describes whether a given register is
414 * readable, writable or volatile.
416 * @reg: the register number
417 * @read: whether this register is readable
418 * @write: whether this register is writable
419 * @vol: whether this register is volatile
421 struct snd_soc_reg_access {
429 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
431 * @pin: name of the pin to update
432 * @mask: bits to check for in reported jack status
433 * @invert: if non-zero then pin is enabled when status is not reported
435 struct snd_soc_jack_pin {
436 struct list_head list;
443 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
445 * @min_mv: start voltage in mv
446 * @max_mv: end voltage in mv
447 * @jack_type: type of jack that is expected for this voltage
448 * @debounce_time: debounce_time for jack, codec driver should wait for this
449 * duration before reading the adc for voltages
450 * @:list: list container
452 struct snd_soc_jack_zone {
455 unsigned int jack_type;
456 unsigned int debounce_time;
457 struct list_head list;
461 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
465 * @report: value to report when jack detected
466 * @invert: report presence in low state
467 * @debouce_time: debouce time in ms
468 * @wake: enable as wake source
469 * @jack_status_check: callback function which overrides the detection
470 * to provide more complex checks (eg, reading an
473 #ifdef CONFIG_GPIOLIB
474 struct snd_soc_jack_gpio {
482 struct snd_soc_jack *jack;
483 struct delayed_work work;
485 int (*jack_status_check)(void);
489 struct snd_soc_jack {
490 struct snd_jack *jack;
491 struct snd_soc_codec *codec;
492 struct list_head pins;
494 struct blocking_notifier_head notifier;
495 struct list_head jack_zones;
498 /* SoC PCM stream information */
499 struct snd_soc_pcm_stream {
500 const char *stream_name;
501 u64 formats; /* SNDRV_PCM_FMTBIT_* */
502 unsigned int rates; /* SNDRV_PCM_RATE_* */
503 unsigned int rate_min; /* min rate */
504 unsigned int rate_max; /* max rate */
505 unsigned int channels_min; /* min channels */
506 unsigned int channels_max; /* max channels */
511 int (*startup)(struct snd_pcm_substream *);
512 void (*shutdown)(struct snd_pcm_substream *);
513 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
514 int (*hw_free)(struct snd_pcm_substream *);
515 int (*prepare)(struct snd_pcm_substream *);
516 int (*trigger)(struct snd_pcm_substream *, int);
520 struct snd_soc_cache_ops {
522 enum snd_soc_compress_type id;
523 int (*init)(struct snd_soc_codec *codec);
524 int (*exit)(struct snd_soc_codec *codec);
525 int (*read)(struct snd_soc_codec *codec, unsigned int reg,
526 unsigned int *value);
527 int (*write)(struct snd_soc_codec *codec, unsigned int reg,
529 int (*sync)(struct snd_soc_codec *codec);
532 /* SoC Audio Codec device */
533 struct snd_soc_codec {
535 const char *name_prefix;
538 const struct snd_soc_codec_driver *driver;
541 struct snd_soc_card *card;
542 struct list_head list;
543 struct list_head card_list;
545 enum snd_soc_compress_type compress_type;
546 size_t reg_size; /* reg_cache_size * reg_word_size */
547 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
548 int (*readable_register)(struct snd_soc_codec *, unsigned int);
549 int (*writable_register)(struct snd_soc_codec *, unsigned int);
552 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
554 unsigned int cache_bypass:1; /* Suppress access to the cache */
555 unsigned int suspended:1; /* Codec is in suspend PM state */
556 unsigned int probed:1; /* Codec has been probed */
557 unsigned int ac97_registered:1; /* Codec has been AC97 registered */
558 unsigned int ac97_created:1; /* Codec has been created by SoC */
559 unsigned int sysfs_registered:1; /* codec has been sysfs registered */
560 unsigned int cache_init:1; /* codec cache has been initialized */
561 u32 cache_only; /* Suppress writes to hardware */
562 u32 cache_sync; /* Cache needs to be synced to hardware */
565 void *control_data; /* codec control (i2c/3wire) data */
566 enum snd_soc_control_type control_type;
568 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
569 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
570 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
571 int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
573 const void *reg_def_copy;
574 const struct snd_soc_cache_ops *cache_ops;
575 struct mutex cache_rw_mutex;
579 struct snd_soc_dapm_context dapm;
580 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
582 #ifdef CONFIG_DEBUG_FS
583 struct dentry *debugfs_codec_root;
584 struct dentry *debugfs_reg;
585 struct dentry *debugfs_dapm;
590 struct snd_soc_codec_driver {
593 int (*probe)(struct snd_soc_codec *);
594 int (*remove)(struct snd_soc_codec *);
595 int (*suspend)(struct snd_soc_codec *,
597 int (*resume)(struct snd_soc_codec *);
599 /* Default control and setup, added after probe() is run */
600 const struct snd_kcontrol_new *controls;
602 const struct snd_soc_dapm_widget *dapm_widgets;
603 int num_dapm_widgets;
604 const struct snd_soc_dapm_route *dapm_routes;
607 /* codec wide operations */
608 int (*set_sysclk)(struct snd_soc_codec *codec,
609 int clk_id, int source, unsigned int freq, int dir);
610 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
611 unsigned int freq_in, unsigned int freq_out);
614 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
615 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
616 int (*display_register)(struct snd_soc_codec *, char *,
617 size_t, unsigned int);
618 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
619 int (*readable_register)(struct snd_soc_codec *, unsigned int);
620 int (*writable_register)(struct snd_soc_codec *, unsigned int);
621 unsigned int reg_cache_size;
622 short reg_cache_step;
624 const void *reg_cache_default;
625 short reg_access_size;
626 const struct snd_soc_reg_access *reg_access_default;
627 enum snd_soc_compress_type compress_type;
629 /* codec bias level */
630 int (*set_bias_level)(struct snd_soc_codec *,
631 enum snd_soc_bias_level level);
634 void (*seq_notifier)(struct snd_soc_dapm_context *,
635 enum snd_soc_dapm_type, int);
637 /* codec stream completion event */
638 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
640 /* probe ordering - for components with runtime dependencies */
645 /* SoC platform interface */
646 struct snd_soc_platform_driver {
648 int (*probe)(struct snd_soc_platform *);
649 int (*remove)(struct snd_soc_platform *);
650 int (*suspend)(struct snd_soc_dai *dai);
651 int (*resume)(struct snd_soc_dai *dai);
653 /* pcm creation and destruction */
654 int (*pcm_new)(struct snd_soc_pcm_runtime *);
655 void (*pcm_free)(struct snd_pcm *);
657 /* Default control and setup, added after probe() is run */
658 const struct snd_kcontrol_new *controls;
660 const struct snd_soc_dapm_widget *dapm_widgets;
661 int num_dapm_widgets;
662 const struct snd_soc_dapm_route *dapm_routes;
666 * For platform caused delay reporting.
669 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
670 struct snd_soc_dai *);
672 /* platform stream ops */
673 struct snd_pcm_ops *ops;
675 /* platform stream completion event */
676 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
678 /* probe ordering - for components with runtime dependencies */
682 /* platform IO - used for platform DAPM */
683 unsigned int (*read)(struct snd_soc_platform *, unsigned int);
684 int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
687 struct snd_soc_platform {
691 struct snd_soc_platform_driver *driver;
693 unsigned int suspended:1; /* platform is suspended */
694 unsigned int probed:1;
696 struct snd_soc_card *card;
697 struct list_head list;
698 struct list_head card_list;
700 struct snd_soc_dapm_context dapm;
703 struct snd_soc_dai_link {
704 /* config - must be set by machine driver */
705 const char *name; /* Codec name */
706 const char *stream_name; /* Stream name */
707 const char *codec_name; /* for multi-codec */
708 const char *platform_name; /* for multi-platform */
709 const char *cpu_dai_name;
710 const char *codec_dai_name;
712 unsigned int dai_fmt; /* format to set on init */
714 /* Keep DAI active over suspend */
715 unsigned int ignore_suspend:1;
717 /* Symmetry requirements */
718 unsigned int symmetric_rates:1;
720 /* pmdown_time is ignored at stop */
721 unsigned int ignore_pmdown_time:1;
723 /* codec/machine specific init - e.g. add machine controls */
724 int (*init)(struct snd_soc_pcm_runtime *rtd);
726 /* machine stream operations */
727 struct snd_soc_ops *ops;
730 struct snd_soc_codec_conf {
731 const char *dev_name;
734 * optional map of kcontrol, widget and path name prefixes that are
735 * associated per device
737 const char *name_prefix;
740 * set this to the desired compression type if you want to
741 * override the one supplied in codec->driver->compress_type
743 enum snd_soc_compress_type compress_type;
746 struct snd_soc_aux_dev {
747 const char *name; /* Codec name */
748 const char *codec_name; /* for multi-codec */
750 /* codec/machine specific init - e.g. add machine controls */
751 int (*init)(struct snd_soc_dapm_context *dapm);
755 struct snd_soc_card {
757 const char *long_name;
758 const char *driver_name;
760 struct snd_card *snd_card;
761 struct module *owner;
763 struct list_head list;
768 int (*probe)(struct snd_soc_card *card);
769 int (*late_probe)(struct snd_soc_card *card);
770 int (*remove)(struct snd_soc_card *card);
772 /* the pre and post PM functions are used to do any PM work before and
773 * after the codec and DAI's do any PM work. */
774 int (*suspend_pre)(struct snd_soc_card *card);
775 int (*suspend_post)(struct snd_soc_card *card);
776 int (*resume_pre)(struct snd_soc_card *card);
777 int (*resume_post)(struct snd_soc_card *card);
780 int (*set_bias_level)(struct snd_soc_card *,
781 struct snd_soc_dapm_context *dapm,
782 enum snd_soc_bias_level level);
783 int (*set_bias_level_post)(struct snd_soc_card *,
784 struct snd_soc_dapm_context *dapm,
785 enum snd_soc_bias_level level);
789 /* CPU <--> Codec DAI links */
790 struct snd_soc_dai_link *dai_link;
792 struct snd_soc_pcm_runtime *rtd;
795 /* optional codec specific configuration */
796 struct snd_soc_codec_conf *codec_conf;
800 * optional auxiliary devices such as amplifiers or codecs with DAI
803 struct snd_soc_aux_dev *aux_dev;
805 struct snd_soc_pcm_runtime *rtd_aux;
808 const struct snd_kcontrol_new *controls;
812 * Card-specific routes and widgets.
814 const struct snd_soc_dapm_widget *dapm_widgets;
815 int num_dapm_widgets;
816 const struct snd_soc_dapm_route *dapm_routes;
820 struct work_struct deferred_resume_work;
822 /* lists of probed devices belonging to this card */
823 struct list_head codec_dev_list;
824 struct list_head platform_dev_list;
825 struct list_head dai_dev_list;
827 struct list_head widgets;
828 struct list_head paths;
829 struct list_head dapm_list;
830 struct list_head dapm_dirty;
832 /* Generic DAPM context for the card */
833 struct snd_soc_dapm_context dapm;
834 struct snd_soc_dapm_stats dapm_stats;
836 #ifdef CONFIG_DEBUG_FS
837 struct dentry *debugfs_card_root;
838 struct dentry *debugfs_pop_time;
845 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
846 struct snd_soc_pcm_runtime {
848 struct snd_soc_card *card;
849 struct snd_soc_dai_link *dai_link;
850 struct mutex pcm_mutex;
851 enum snd_soc_pcm_subclass pcm_subclass;
852 struct snd_pcm_ops ops;
854 unsigned int complete:1;
855 unsigned int dev_registered:1;
859 /* runtime devices */
861 struct snd_soc_codec *codec;
862 struct snd_soc_platform *platform;
863 struct snd_soc_dai *codec_dai;
864 struct snd_soc_dai *cpu_dai;
866 struct delayed_work delayed_work;
870 struct soc_mixer_control {
871 int min, max, platform_max;
872 unsigned int reg, rreg, shift, rshift, invert;
875 /* enumerated kcontrol */
879 unsigned char shift_l;
880 unsigned char shift_r;
883 const char * const *texts;
884 const unsigned int *values;
889 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
890 unsigned int snd_soc_write(struct snd_soc_codec *codec,
891 unsigned int reg, unsigned int val);
892 unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
893 unsigned int reg, const void *data, size_t len);
895 /* device driver data */
897 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
900 card->drvdata = data;
903 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
905 return card->drvdata;
908 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
911 dev_set_drvdata(codec->dev, data);
914 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
916 return dev_get_drvdata(codec->dev);
919 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
922 dev_set_drvdata(platform->dev, data);
925 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
927 return dev_get_drvdata(platform->dev);
930 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
933 dev_set_drvdata(&rtd->dev, data);
936 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
938 return dev_get_drvdata(&rtd->dev);
941 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
943 INIT_LIST_HEAD(&card->dai_dev_list);
944 INIT_LIST_HEAD(&card->codec_dev_list);
945 INIT_LIST_HEAD(&card->platform_dev_list);
946 INIT_LIST_HEAD(&card->widgets);
947 INIT_LIST_HEAD(&card->paths);
948 INIT_LIST_HEAD(&card->dapm_list);
951 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
953 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
956 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
957 * mc->reg != mc->rreg means that the control is
958 * stereo (bits in one register or in two registers)
963 int snd_soc_util_init(void);
964 void snd_soc_util_exit(void);
966 #include <sound/soc-dai.h>
968 #ifdef CONFIG_DEBUG_FS
969 extern struct dentry *snd_soc_debugfs_root;
972 extern const struct dev_pm_ops snd_soc_pm_ops;