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 <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/control.h>
25 #include <sound/ac97_codec.h>
28 * Convenience kcontrol builders
30 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
31 ((unsigned long)&(struct soc_mixer_control) \
32 {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
33 .platform_max = xmax, .invert = xinvert})
34 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
35 ((unsigned long)&(struct soc_mixer_control) \
36 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
37 #define SOC_SINGLE(xname, reg, shift, max, invert) \
38 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
39 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
40 .put = snd_soc_put_volsw, \
41 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
42 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
43 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
44 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
45 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
46 .tlv.p = (tlv_array), \
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_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
51 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
52 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
53 .put = snd_soc_put_volsw, \
54 .private_value = (unsigned long)&(struct soc_mixer_control) \
55 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
56 .max = xmax, .platform_max = xmax, .invert = xinvert} }
57 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
58 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
59 .info = snd_soc_info_volsw_2r, \
60 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
61 .private_value = (unsigned long)&(struct soc_mixer_control) \
62 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
63 .max = xmax, .platform_max = xmax, .invert = xinvert} }
64 #define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
65 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
66 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
67 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
68 .tlv.p = (tlv_array), \
69 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
70 .put = snd_soc_put_volsw, \
71 .private_value = (unsigned long)&(struct soc_mixer_control) \
72 {.reg = xreg, .shift = shift_left, .rshift = shift_right,\
73 .max = xmax, .platform_max = xmax, .invert = xinvert} }
74 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
75 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
76 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
77 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
78 .tlv.p = (tlv_array), \
79 .info = snd_soc_info_volsw_2r, \
80 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
81 .private_value = (unsigned long)&(struct soc_mixer_control) \
82 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
83 .max = xmax, .platform_max = xmax, .invert = xinvert} }
84 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
85 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
86 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
87 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
88 .tlv.p = (tlv_array), \
89 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
90 .put = snd_soc_put_volsw_s8, \
91 .private_value = (unsigned long)&(struct soc_mixer_control) \
92 {.reg = xreg, .min = xmin, .max = xmax, \
93 .platform_max = xmax} }
94 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
95 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
96 .max = xmax, .texts = xtexts }
97 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
98 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
99 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
100 { .max = xmax, .texts = xtexts }
101 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
102 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
103 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
104 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
105 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
106 #define SOC_ENUM(xname, xenum) \
107 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
108 .info = snd_soc_info_enum_double, \
109 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
110 .private_value = (unsigned long)&xenum }
111 #define SOC_VALUE_ENUM(xname, xenum) \
112 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
113 .info = snd_soc_info_enum_double, \
114 .get = snd_soc_get_value_enum_double, \
115 .put = snd_soc_put_value_enum_double, \
116 .private_value = (unsigned long)&xenum }
117 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
118 xhandler_get, xhandler_put) \
119 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
120 .info = snd_soc_info_volsw, \
121 .get = xhandler_get, .put = xhandler_put, \
122 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
123 #define SOC_DOUBLE_EXT(xname, xreg, shift_left, shift_right, xmax, xinvert,\
124 xhandler_get, xhandler_put) \
125 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
126 .info = snd_soc_info_volsw, \
127 .get = xhandler_get, .put = xhandler_put, \
128 .private_value = (unsigned long)&(struct soc_mixer_control) \
129 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
130 .max = xmax, .platform_max = xmax, .invert = xinvert} }
131 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
132 xhandler_get, xhandler_put, tlv_array) \
133 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
134 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
135 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
136 .tlv.p = (tlv_array), \
137 .info = snd_soc_info_volsw, \
138 .get = xhandler_get, .put = xhandler_put, \
139 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
140 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
141 xhandler_get, xhandler_put, tlv_array) \
142 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
143 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
144 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
145 .tlv.p = (tlv_array), \
146 .info = snd_soc_info_volsw, \
147 .get = xhandler_get, .put = xhandler_put, \
148 .private_value = (unsigned long)&(struct soc_mixer_control) \
149 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
150 .max = xmax, .platform_max = xmax, .invert = xinvert} }
151 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
152 xhandler_get, xhandler_put, tlv_array) \
153 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
154 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
155 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
156 .tlv.p = (tlv_array), \
157 .info = snd_soc_info_volsw_2r, \
158 .get = xhandler_get, .put = xhandler_put, \
159 .private_value = (unsigned long)&(struct soc_mixer_control) \
160 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
161 .max = xmax, .platform_max = xmax, .invert = xinvert} }
162 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
163 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
164 .info = snd_soc_info_bool_ext, \
165 .get = xhandler_get, .put = xhandler_put, \
166 .private_value = xdata }
167 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
168 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
169 .info = snd_soc_info_enum_ext, \
170 .get = xhandler_get, .put = xhandler_put, \
171 .private_value = (unsigned long)&xenum }
173 #define SOC_DOUBLE_R_SX_TLV(xname, xreg_left, xreg_right, xshift,\
174 xmin, xmax, tlv_array) \
175 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
176 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
177 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
178 .tlv.p = (tlv_array), \
179 .info = snd_soc_info_volsw_2r_sx, \
180 .get = snd_soc_get_volsw_2r_sx, \
181 .put = snd_soc_put_volsw_2r_sx, \
182 .private_value = (unsigned long)&(struct soc_mixer_control) \
184 .rreg = xreg_right, .shift = xshift, \
185 .min = xmin, .max = xmax} }
189 * Simplified versions of above macros, declaring a struct and calculating
190 * ARRAY_SIZE internally
192 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
193 struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
194 ARRAY_SIZE(xtexts), xtexts)
195 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
196 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
197 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
198 struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
199 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
200 struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
201 ARRAY_SIZE(xtexts), xtexts, xvalues)
202 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
203 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
206 * Component probe and remove ordering levels for components with runtime
209 #define SND_SOC_COMP_ORDER_FIRST -2
210 #define SND_SOC_COMP_ORDER_EARLY -1
211 #define SND_SOC_COMP_ORDER_NORMAL 0
212 #define SND_SOC_COMP_ORDER_LATE 1
213 #define SND_SOC_COMP_ORDER_LAST 2
218 * @ON: Bias is fully on for audio playback and capture operations.
219 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
220 * stream start and stop operations.
221 * @STANDBY: Low power standby state when no playback/capture operations are
222 * in progress. NOTE: The transition time between STANDBY and ON
223 * should be as fast as possible and no longer than 10ms.
224 * @OFF: Power Off. No restrictions on transition times.
226 enum snd_soc_bias_level
{
227 SND_SOC_BIAS_OFF
= 0,
228 SND_SOC_BIAS_STANDBY
= 1,
229 SND_SOC_BIAS_PREPARE
= 2,
235 struct snd_soc_pcm_stream
;
237 struct snd_soc_pcm_runtime
;
239 struct snd_soc_dai_driver
;
240 struct snd_soc_platform
;
241 struct snd_soc_dai_link
;
242 struct snd_soc_platform_driver
;
243 struct snd_soc_codec
;
244 struct snd_soc_codec_driver
;
247 struct snd_soc_jack_zone
;
248 struct snd_soc_jack_pin
;
249 struct snd_soc_cache_ops
;
250 #include <sound/soc-dapm.h>
252 #ifdef CONFIG_GPIOLIB
253 struct snd_soc_jack_gpio
;
256 typedef int (*hw_write_t
)(void *,const char* ,int);
258 extern struct snd_ac97_bus_ops soc_ac97_ops
;
260 enum snd_soc_control_type
{
266 enum snd_soc_compress_type
{
267 SND_SOC_FLAT_COMPRESSION
= 1,
268 SND_SOC_LZO_COMPRESSION
,
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 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
,
317 /* Utility functions to get clock rates from various things */
318 int snd_soc_calc_frame_size(int sample_size
, int channels
, int tdm_slots
);
319 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params
*params
);
320 int snd_soc_calc_bclk(int fs
, int sample_size
, int channels
, int tdm_slots
);
321 int snd_soc_params_to_bclk(struct snd_pcm_hw_params
*parms
);
323 /* set runtime hw params */
324 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream
*substream
,
325 const struct snd_pcm_hardware
*hw
);
328 int snd_soc_jack_new(struct snd_soc_codec
*codec
, const char *id
, int type
,
329 struct snd_soc_jack
*jack
);
330 void snd_soc_jack_report(struct snd_soc_jack
*jack
, int status
, int mask
);
331 int snd_soc_jack_add_pins(struct snd_soc_jack
*jack
, int count
,
332 struct snd_soc_jack_pin
*pins
);
333 void snd_soc_jack_notifier_register(struct snd_soc_jack
*jack
,
334 struct notifier_block
*nb
);
335 void snd_soc_jack_notifier_unregister(struct snd_soc_jack
*jack
,
336 struct notifier_block
*nb
);
337 int snd_soc_jack_add_zones(struct snd_soc_jack
*jack
, int count
,
338 struct snd_soc_jack_zone
*zones
);
339 int snd_soc_jack_get_type(struct snd_soc_jack
*jack
, int micbias_voltage
);
340 #ifdef CONFIG_GPIOLIB
341 int snd_soc_jack_add_gpios(struct snd_soc_jack
*jack
, int count
,
342 struct snd_soc_jack_gpio
*gpios
);
343 void snd_soc_jack_free_gpios(struct snd_soc_jack
*jack
, int count
,
344 struct snd_soc_jack_gpio
*gpios
);
347 /* codec register bit access */
348 int snd_soc_update_bits(struct snd_soc_codec
*codec
, unsigned short reg
,
349 unsigned int mask
, unsigned int value
);
350 int snd_soc_update_bits_locked(struct snd_soc_codec
*codec
,
351 unsigned short reg
, unsigned int mask
,
353 int snd_soc_test_bits(struct snd_soc_codec
*codec
, unsigned short reg
,
354 unsigned int mask
, unsigned int value
);
356 int snd_soc_new_ac97_codec(struct snd_soc_codec
*codec
,
357 struct snd_ac97_bus_ops
*ops
, int num
);
358 void snd_soc_free_ac97_codec(struct snd_soc_codec
*codec
);
363 struct snd_kcontrol
*snd_soc_cnew(const struct snd_kcontrol_new
*_template
,
364 void *data
, char *long_name
,
366 int snd_soc_add_controls(struct snd_soc_codec
*codec
,
367 const struct snd_kcontrol_new
*controls
, int num_controls
);
368 int snd_soc_info_enum_double(struct snd_kcontrol
*kcontrol
,
369 struct snd_ctl_elem_info
*uinfo
);
370 int snd_soc_info_enum_ext(struct snd_kcontrol
*kcontrol
,
371 struct snd_ctl_elem_info
*uinfo
);
372 int snd_soc_get_enum_double(struct snd_kcontrol
*kcontrol
,
373 struct snd_ctl_elem_value
*ucontrol
);
374 int snd_soc_put_enum_double(struct snd_kcontrol
*kcontrol
,
375 struct snd_ctl_elem_value
*ucontrol
);
376 int snd_soc_get_value_enum_double(struct snd_kcontrol
*kcontrol
,
377 struct snd_ctl_elem_value
*ucontrol
);
378 int snd_soc_put_value_enum_double(struct snd_kcontrol
*kcontrol
,
379 struct snd_ctl_elem_value
*ucontrol
);
380 int snd_soc_info_volsw(struct snd_kcontrol
*kcontrol
,
381 struct snd_ctl_elem_info
*uinfo
);
382 int snd_soc_info_volsw_ext(struct snd_kcontrol
*kcontrol
,
383 struct snd_ctl_elem_info
*uinfo
);
384 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
385 int snd_soc_get_volsw(struct snd_kcontrol
*kcontrol
,
386 struct snd_ctl_elem_value
*ucontrol
);
387 int snd_soc_put_volsw(struct snd_kcontrol
*kcontrol
,
388 struct snd_ctl_elem_value
*ucontrol
);
389 int snd_soc_info_volsw_2r(struct snd_kcontrol
*kcontrol
,
390 struct snd_ctl_elem_info
*uinfo
);
391 int snd_soc_get_volsw_2r(struct snd_kcontrol
*kcontrol
,
392 struct snd_ctl_elem_value
*ucontrol
);
393 int snd_soc_put_volsw_2r(struct snd_kcontrol
*kcontrol
,
394 struct snd_ctl_elem_value
*ucontrol
);
395 int snd_soc_info_volsw_s8(struct snd_kcontrol
*kcontrol
,
396 struct snd_ctl_elem_info
*uinfo
);
397 int snd_soc_get_volsw_s8(struct snd_kcontrol
*kcontrol
,
398 struct snd_ctl_elem_value
*ucontrol
);
399 int snd_soc_put_volsw_s8(struct snd_kcontrol
*kcontrol
,
400 struct snd_ctl_elem_value
*ucontrol
);
401 int snd_soc_limit_volume(struct snd_soc_codec
*codec
,
402 const char *name
, int max
);
403 int snd_soc_info_volsw_2r_sx(struct snd_kcontrol
*kcontrol
,
404 struct snd_ctl_elem_info
*uinfo
);
405 int snd_soc_get_volsw_2r_sx(struct snd_kcontrol
*kcontrol
,
406 struct snd_ctl_elem_value
*ucontrol
);
407 int snd_soc_put_volsw_2r_sx(struct snd_kcontrol
*kcontrol
,
408 struct snd_ctl_elem_value
*ucontrol
);
411 * struct snd_soc_reg_access - Describes whether a given register is
412 * readable, writable or volatile.
414 * @reg: the register number
415 * @read: whether this register is readable
416 * @write: whether this register is writable
417 * @vol: whether this register is volatile
419 struct snd_soc_reg_access
{
427 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
429 * @pin: name of the pin to update
430 * @mask: bits to check for in reported jack status
431 * @invert: if non-zero then pin is enabled when status is not reported
433 struct snd_soc_jack_pin
{
434 struct list_head list
;
441 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
443 * @min_mv: start voltage in mv
444 * @max_mv: end voltage in mv
445 * @jack_type: type of jack that is expected for this voltage
446 * @debounce_time: debounce_time for jack, codec driver should wait for this
447 * duration before reading the adc for voltages
448 * @:list: list container
450 struct snd_soc_jack_zone
{
453 unsigned int jack_type
;
454 unsigned int debounce_time
;
455 struct list_head list
;
459 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
463 * @report: value to report when jack detected
464 * @invert: report presence in low state
465 * @debouce_time: debouce time in ms
466 * @wake: enable as wake source
467 * @jack_status_check: callback function which overrides the detection
468 * to provide more complex checks (eg, reading an
471 #ifdef CONFIG_GPIOLIB
472 struct snd_soc_jack_gpio
{
480 struct snd_soc_jack
*jack
;
481 struct delayed_work work
;
483 int (*jack_status_check
)(void);
487 struct snd_soc_jack
{
488 struct snd_jack
*jack
;
489 struct snd_soc_codec
*codec
;
490 struct list_head pins
;
492 struct blocking_notifier_head notifier
;
493 struct list_head jack_zones
;
496 /* SoC PCM stream information */
497 struct snd_soc_pcm_stream
{
498 const char *stream_name
;
499 u64 formats
; /* SNDRV_PCM_FMTBIT_* */
500 unsigned int rates
; /* SNDRV_PCM_RATE_* */
501 unsigned int rate_min
; /* min rate */
502 unsigned int rate_max
; /* max rate */
503 unsigned int channels_min
; /* min channels */
504 unsigned int channels_max
; /* max channels */
509 int (*startup
)(struct snd_pcm_substream
*);
510 void (*shutdown
)(struct snd_pcm_substream
*);
511 int (*hw_params
)(struct snd_pcm_substream
*, struct snd_pcm_hw_params
*);
512 int (*hw_free
)(struct snd_pcm_substream
*);
513 int (*prepare
)(struct snd_pcm_substream
*);
514 int (*trigger
)(struct snd_pcm_substream
*, int);
518 struct snd_soc_cache_ops
{
520 enum snd_soc_compress_type id
;
521 int (*init
)(struct snd_soc_codec
*codec
);
522 int (*exit
)(struct snd_soc_codec
*codec
);
523 int (*read
)(struct snd_soc_codec
*codec
, unsigned int reg
,
524 unsigned int *value
);
525 int (*write
)(struct snd_soc_codec
*codec
, unsigned int reg
,
527 int (*sync
)(struct snd_soc_codec
*codec
);
530 /* SoC Audio Codec device */
531 struct snd_soc_codec
{
533 const char *name_prefix
;
536 const struct snd_soc_codec_driver
*driver
;
539 struct snd_soc_card
*card
;
540 struct list_head list
;
541 struct list_head card_list
;
543 enum snd_soc_compress_type compress_type
;
544 size_t reg_size
; /* reg_cache_size * reg_word_size */
545 int (*volatile_register
)(struct snd_soc_codec
*, unsigned int);
546 int (*readable_register
)(struct snd_soc_codec
*, unsigned int);
547 int (*writable_register
)(struct snd_soc_codec
*, unsigned int);
550 struct snd_ac97
*ac97
; /* for ad-hoc ac97 devices */
552 unsigned int cache_bypass
:1; /* Suppress access to the cache */
553 unsigned int suspended
:1; /* Codec is in suspend PM state */
554 unsigned int probed
:1; /* Codec has been probed */
555 unsigned int ac97_registered
:1; /* Codec has been AC97 registered */
556 unsigned int ac97_created
:1; /* Codec has been created by SoC */
557 unsigned int sysfs_registered
:1; /* codec has been sysfs registered */
558 unsigned int cache_init
:1; /* codec cache has been initialized */
559 u32 cache_only
; /* Suppress writes to hardware */
560 u32 cache_sync
; /* Cache needs to be synced to hardware */
563 void *control_data
; /* codec control (i2c/3wire) data */
564 enum snd_soc_control_type control_type
;
566 unsigned int (*hw_read
)(struct snd_soc_codec
*, unsigned int);
567 unsigned int (*read
)(struct snd_soc_codec
*, unsigned int);
568 int (*write
)(struct snd_soc_codec
*, unsigned int, unsigned int);
569 int (*bulk_write_raw
)(struct snd_soc_codec
*, unsigned int, const void *, size_t);
571 const void *reg_def_copy
;
572 const struct snd_soc_cache_ops
*cache_ops
;
573 struct mutex cache_rw_mutex
;
576 struct snd_soc_dapm_context dapm
;
578 #ifdef CONFIG_DEBUG_FS
579 struct dentry
*debugfs_codec_root
;
580 struct dentry
*debugfs_reg
;
581 struct dentry
*debugfs_dapm
;
586 struct snd_soc_codec_driver
{
589 int (*probe
)(struct snd_soc_codec
*);
590 int (*remove
)(struct snd_soc_codec
*);
591 int (*suspend
)(struct snd_soc_codec
*,
593 int (*resume
)(struct snd_soc_codec
*);
595 /* Default control and setup, added after probe() is run */
596 const struct snd_kcontrol_new
*controls
;
598 const struct snd_soc_dapm_widget
*dapm_widgets
;
599 int num_dapm_widgets
;
600 const struct snd_soc_dapm_route
*dapm_routes
;
603 /* codec wide operations */
604 int (*set_sysclk
)(struct snd_soc_codec
*codec
,
605 int clk_id
, unsigned int freq
, int dir
);
606 int (*set_pll
)(struct snd_soc_codec
*codec
, int pll_id
, int source
,
607 unsigned int freq_in
, unsigned int freq_out
);
610 unsigned int (*read
)(struct snd_soc_codec
*, unsigned int);
611 int (*write
)(struct snd_soc_codec
*, unsigned int, unsigned int);
612 int (*display_register
)(struct snd_soc_codec
*, char *,
613 size_t, unsigned int);
614 int (*volatile_register
)(struct snd_soc_codec
*, unsigned int);
615 int (*readable_register
)(struct snd_soc_codec
*, unsigned int);
616 int (*writable_register
)(struct snd_soc_codec
*, unsigned int);
617 short reg_cache_size
;
618 short reg_cache_step
;
620 const void *reg_cache_default
;
621 short reg_access_size
;
622 const struct snd_soc_reg_access
*reg_access_default
;
623 enum snd_soc_compress_type compress_type
;
625 /* codec bias level */
626 int (*set_bias_level
)(struct snd_soc_codec
*,
627 enum snd_soc_bias_level level
);
629 void (*seq_notifier
)(struct snd_soc_dapm_context
*,
630 enum snd_soc_dapm_type
, int);
632 /* probe ordering - for components with runtime dependencies */
637 /* SoC platform interface */
638 struct snd_soc_platform_driver
{
640 int (*probe
)(struct snd_soc_platform
*);
641 int (*remove
)(struct snd_soc_platform
*);
642 int (*suspend
)(struct snd_soc_dai
*dai
);
643 int (*resume
)(struct snd_soc_dai
*dai
);
645 /* pcm creation and destruction */
646 int (*pcm_new
)(struct snd_soc_pcm_runtime
*);
647 void (*pcm_free
)(struct snd_pcm
*);
650 * For platform caused delay reporting.
653 snd_pcm_sframes_t (*delay
)(struct snd_pcm_substream
*,
654 struct snd_soc_dai
*);
656 /* platform stream ops */
657 struct snd_pcm_ops
*ops
;
659 /* probe ordering - for components with runtime dependencies */
664 struct snd_soc_platform
{
668 struct snd_soc_platform_driver
*driver
;
670 unsigned int suspended
:1; /* platform is suspended */
671 unsigned int probed
:1;
673 struct snd_soc_card
*card
;
674 struct list_head list
;
675 struct list_head card_list
;
678 struct snd_soc_dai_link
{
679 /* config - must be set by machine driver */
680 const char *name
; /* Codec name */
681 const char *stream_name
; /* Stream name */
682 const char *codec_name
; /* for multi-codec */
683 const char *platform_name
; /* for multi-platform */
684 const char *cpu_dai_name
;
685 const char *codec_dai_name
;
687 /* Keep DAI active over suspend */
688 unsigned int ignore_suspend
:1;
690 /* Symmetry requirements */
691 unsigned int symmetric_rates
:1;
693 /* codec/machine specific init - e.g. add machine controls */
694 int (*init
)(struct snd_soc_pcm_runtime
*rtd
);
696 /* machine stream operations */
697 struct snd_soc_ops
*ops
;
700 struct snd_soc_codec_conf
{
701 const char *dev_name
;
704 * optional map of kcontrol, widget and path name prefixes that are
705 * associated per device
707 const char *name_prefix
;
710 * set this to the desired compression type if you want to
711 * override the one supplied in codec->driver->compress_type
713 enum snd_soc_compress_type compress_type
;
716 struct snd_soc_aux_dev
{
717 const char *name
; /* Codec name */
718 const char *codec_name
; /* for multi-codec */
720 /* codec/machine specific init - e.g. add machine controls */
721 int (*init
)(struct snd_soc_dapm_context
*dapm
);
725 struct snd_soc_card
{
727 const char *long_name
;
728 const char *driver_name
;
730 struct snd_card
*snd_card
;
731 struct module
*owner
;
733 struct list_head list
;
738 int (*probe
)(struct snd_soc_card
*card
);
739 int (*late_probe
)(struct snd_soc_card
*card
);
740 int (*remove
)(struct snd_soc_card
*card
);
742 /* the pre and post PM functions are used to do any PM work before and
743 * after the codec and DAI's do any PM work. */
744 int (*suspend_pre
)(struct snd_soc_card
*card
);
745 int (*suspend_post
)(struct snd_soc_card
*card
);
746 int (*resume_pre
)(struct snd_soc_card
*card
);
747 int (*resume_post
)(struct snd_soc_card
*card
);
750 int (*set_bias_level
)(struct snd_soc_card
*,
751 struct snd_soc_dapm_context
*dapm
,
752 enum snd_soc_bias_level level
);
753 int (*set_bias_level_post
)(struct snd_soc_card
*,
754 struct snd_soc_dapm_context
*dapm
,
755 enum snd_soc_bias_level level
);
759 /* CPU <--> Codec DAI links */
760 struct snd_soc_dai_link
*dai_link
;
762 struct snd_soc_pcm_runtime
*rtd
;
765 /* optional codec specific configuration */
766 struct snd_soc_codec_conf
*codec_conf
;
770 * optional auxiliary devices such as amplifiers or codecs with DAI
773 struct snd_soc_aux_dev
*aux_dev
;
775 struct snd_soc_pcm_runtime
*rtd_aux
;
778 const struct snd_kcontrol_new
*controls
;
782 * Card-specific routes and widgets.
784 const struct snd_soc_dapm_widget
*dapm_widgets
;
785 int num_dapm_widgets
;
786 const struct snd_soc_dapm_route
*dapm_routes
;
789 struct work_struct deferred_resume_work
;
791 /* lists of probed devices belonging to this card */
792 struct list_head codec_dev_list
;
793 struct list_head platform_dev_list
;
794 struct list_head dai_dev_list
;
796 struct list_head widgets
;
797 struct list_head paths
;
798 struct list_head dapm_list
;
800 /* Generic DAPM context for the card */
801 struct snd_soc_dapm_context dapm
;
803 #ifdef CONFIG_DEBUG_FS
804 struct dentry
*debugfs_card_root
;
805 struct dentry
*debugfs_pop_time
;
812 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
813 struct snd_soc_pcm_runtime
{
815 struct snd_soc_card
*card
;
816 struct snd_soc_dai_link
*dai_link
;
817 struct mutex pcm_mutex
;
818 enum snd_soc_pcm_subclass pcm_subclass
;
819 struct snd_pcm_ops ops
;
821 unsigned int complete
:1;
822 unsigned int dev_registered
:1;
824 /* Symmetry data - only valid if symmetry is being enforced */
828 /* runtime devices */
830 struct snd_soc_codec
*codec
;
831 struct snd_soc_platform
*platform
;
832 struct snd_soc_dai
*codec_dai
;
833 struct snd_soc_dai
*cpu_dai
;
835 struct delayed_work delayed_work
;
839 struct soc_mixer_control
{
840 int min
, max
, platform_max
;
841 unsigned int reg
, rreg
, shift
, rshift
, invert
;
844 /* enumerated kcontrol */
848 unsigned char shift_l
;
849 unsigned char shift_r
;
852 const char * const *texts
;
853 const unsigned int *values
;
858 unsigned int snd_soc_read(struct snd_soc_codec
*codec
, unsigned int reg
);
859 unsigned int snd_soc_write(struct snd_soc_codec
*codec
,
860 unsigned int reg
, unsigned int val
);
861 unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec
*codec
,
862 unsigned int reg
, const void *data
, size_t len
);
864 /* device driver data */
866 static inline void snd_soc_card_set_drvdata(struct snd_soc_card
*card
,
869 card
->drvdata
= data
;
872 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card
*card
)
874 return card
->drvdata
;
877 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec
*codec
,
880 dev_set_drvdata(codec
->dev
, data
);
883 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec
*codec
)
885 return dev_get_drvdata(codec
->dev
);
888 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform
*platform
,
891 dev_set_drvdata(platform
->dev
, data
);
894 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform
*platform
)
896 return dev_get_drvdata(platform
->dev
);
899 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime
*rtd
,
902 dev_set_drvdata(&rtd
->dev
, data
);
905 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime
*rtd
)
907 return dev_get_drvdata(&rtd
->dev
);
910 static inline void snd_soc_initialize_card_lists(struct snd_soc_card
*card
)
912 INIT_LIST_HEAD(&card
->dai_dev_list
);
913 INIT_LIST_HEAD(&card
->codec_dev_list
);
914 INIT_LIST_HEAD(&card
->platform_dev_list
);
915 INIT_LIST_HEAD(&card
->widgets
);
916 INIT_LIST_HEAD(&card
->paths
);
917 INIT_LIST_HEAD(&card
->dapm_list
);
920 int snd_soc_util_init(void);
921 void snd_soc_util_exit(void);
923 #include <sound/soc-dai.h>
925 #ifdef CONFIG_DEBUG_FS
926 extern struct dentry
*snd_soc_debugfs_root
;
929 extern const struct dev_pm_ops snd_soc_pm_ops
;