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
{
265 enum snd_soc_compress_type
{
266 SND_SOC_FLAT_COMPRESSION
= 1,
267 SND_SOC_LZO_COMPRESSION
,
268 SND_SOC_RBTREE_COMPRESSION
271 enum snd_soc_pcm_subclass
{
272 SND_SOC_PCM_CLASS_PCM
= 0,
273 SND_SOC_PCM_CLASS_BE
= 1,
276 int snd_soc_codec_set_sysclk(struct snd_soc_codec
*codec
, int clk_id
,
277 unsigned int freq
, int dir
);
278 int snd_soc_codec_set_pll(struct snd_soc_codec
*codec
, int pll_id
, int source
,
279 unsigned int freq_in
, unsigned int freq_out
);
281 int snd_soc_register_card(struct snd_soc_card
*card
);
282 int snd_soc_unregister_card(struct snd_soc_card
*card
);
283 int snd_soc_suspend(struct device
*dev
);
284 int snd_soc_resume(struct device
*dev
);
285 int snd_soc_poweroff(struct device
*dev
);
286 int snd_soc_register_platform(struct device
*dev
,
287 struct snd_soc_platform_driver
*platform_drv
);
288 void snd_soc_unregister_platform(struct device
*dev
);
289 int snd_soc_register_codec(struct device
*dev
,
290 const struct snd_soc_codec_driver
*codec_drv
,
291 struct snd_soc_dai_driver
*dai_drv
, int num_dai
);
292 void snd_soc_unregister_codec(struct device
*dev
);
293 int snd_soc_codec_volatile_register(struct snd_soc_codec
*codec
,
295 int snd_soc_codec_readable_register(struct snd_soc_codec
*codec
,
297 int snd_soc_codec_writable_register(struct snd_soc_codec
*codec
,
299 int snd_soc_codec_set_cache_io(struct snd_soc_codec
*codec
,
300 int addr_bits
, int data_bits
,
301 enum snd_soc_control_type control
);
302 int snd_soc_cache_sync(struct snd_soc_codec
*codec
);
303 int snd_soc_cache_init(struct snd_soc_codec
*codec
);
304 int snd_soc_cache_exit(struct snd_soc_codec
*codec
);
305 int snd_soc_cache_write(struct snd_soc_codec
*codec
,
306 unsigned int reg
, unsigned int value
);
307 int snd_soc_cache_read(struct snd_soc_codec
*codec
,
308 unsigned int reg
, unsigned int *value
);
309 int snd_soc_default_volatile_register(struct snd_soc_codec
*codec
,
311 int snd_soc_default_readable_register(struct snd_soc_codec
*codec
,
313 int snd_soc_default_writable_register(struct snd_soc_codec
*codec
,
315 int snd_soc_platform_read(struct snd_soc_platform
*platform
,
317 int snd_soc_platform_write(struct snd_soc_platform
*platform
,
318 unsigned int reg
, unsigned int val
);
320 /* Utility functions to get clock rates from various things */
321 int snd_soc_calc_frame_size(int sample_size
, int channels
, int tdm_slots
);
322 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params
*params
);
323 int snd_soc_calc_bclk(int fs
, int sample_size
, int channels
, int tdm_slots
);
324 int snd_soc_params_to_bclk(struct snd_pcm_hw_params
*parms
);
326 /* set runtime hw params */
327 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream
*substream
,
328 const struct snd_pcm_hardware
*hw
);
331 int snd_soc_jack_new(struct snd_soc_codec
*codec
, const char *id
, int type
,
332 struct snd_soc_jack
*jack
);
333 void snd_soc_jack_report(struct snd_soc_jack
*jack
, int status
, int mask
);
334 int snd_soc_jack_add_pins(struct snd_soc_jack
*jack
, int count
,
335 struct snd_soc_jack_pin
*pins
);
336 void snd_soc_jack_notifier_register(struct snd_soc_jack
*jack
,
337 struct notifier_block
*nb
);
338 void snd_soc_jack_notifier_unregister(struct snd_soc_jack
*jack
,
339 struct notifier_block
*nb
);
340 int snd_soc_jack_add_zones(struct snd_soc_jack
*jack
, int count
,
341 struct snd_soc_jack_zone
*zones
);
342 int snd_soc_jack_get_type(struct snd_soc_jack
*jack
, int micbias_voltage
);
343 #ifdef CONFIG_GPIOLIB
344 int snd_soc_jack_add_gpios(struct snd_soc_jack
*jack
, int count
,
345 struct snd_soc_jack_gpio
*gpios
);
346 void snd_soc_jack_free_gpios(struct snd_soc_jack
*jack
, int count
,
347 struct snd_soc_jack_gpio
*gpios
);
350 /* codec register bit access */
351 int snd_soc_update_bits(struct snd_soc_codec
*codec
, unsigned short reg
,
352 unsigned int mask
, unsigned int value
);
353 int snd_soc_update_bits_locked(struct snd_soc_codec
*codec
,
354 unsigned short reg
, unsigned int mask
,
356 int snd_soc_test_bits(struct snd_soc_codec
*codec
, unsigned short reg
,
357 unsigned int mask
, unsigned int value
);
359 int snd_soc_new_ac97_codec(struct snd_soc_codec
*codec
,
360 struct snd_ac97_bus_ops
*ops
, int num
);
361 void snd_soc_free_ac97_codec(struct snd_soc_codec
*codec
);
366 struct snd_kcontrol
*snd_soc_cnew(const struct snd_kcontrol_new
*_template
,
367 void *data
, char *long_name
,
369 int snd_soc_add_controls(struct snd_soc_codec
*codec
,
370 const struct snd_kcontrol_new
*controls
, int num_controls
);
371 int snd_soc_info_enum_double(struct snd_kcontrol
*kcontrol
,
372 struct snd_ctl_elem_info
*uinfo
);
373 int snd_soc_info_enum_ext(struct snd_kcontrol
*kcontrol
,
374 struct snd_ctl_elem_info
*uinfo
);
375 int snd_soc_get_enum_double(struct snd_kcontrol
*kcontrol
,
376 struct snd_ctl_elem_value
*ucontrol
);
377 int snd_soc_put_enum_double(struct snd_kcontrol
*kcontrol
,
378 struct snd_ctl_elem_value
*ucontrol
);
379 int snd_soc_get_value_enum_double(struct snd_kcontrol
*kcontrol
,
380 struct snd_ctl_elem_value
*ucontrol
);
381 int snd_soc_put_value_enum_double(struct snd_kcontrol
*kcontrol
,
382 struct snd_ctl_elem_value
*ucontrol
);
383 int snd_soc_info_volsw(struct snd_kcontrol
*kcontrol
,
384 struct snd_ctl_elem_info
*uinfo
);
385 int snd_soc_info_volsw_ext(struct snd_kcontrol
*kcontrol
,
386 struct snd_ctl_elem_info
*uinfo
);
387 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
388 int snd_soc_get_volsw(struct snd_kcontrol
*kcontrol
,
389 struct snd_ctl_elem_value
*ucontrol
);
390 int snd_soc_put_volsw(struct snd_kcontrol
*kcontrol
,
391 struct snd_ctl_elem_value
*ucontrol
);
392 int snd_soc_info_volsw_2r(struct snd_kcontrol
*kcontrol
,
393 struct snd_ctl_elem_info
*uinfo
);
394 int snd_soc_get_volsw_2r(struct snd_kcontrol
*kcontrol
,
395 struct snd_ctl_elem_value
*ucontrol
);
396 int snd_soc_put_volsw_2r(struct snd_kcontrol
*kcontrol
,
397 struct snd_ctl_elem_value
*ucontrol
);
398 int snd_soc_info_volsw_s8(struct snd_kcontrol
*kcontrol
,
399 struct snd_ctl_elem_info
*uinfo
);
400 int snd_soc_get_volsw_s8(struct snd_kcontrol
*kcontrol
,
401 struct snd_ctl_elem_value
*ucontrol
);
402 int snd_soc_put_volsw_s8(struct snd_kcontrol
*kcontrol
,
403 struct snd_ctl_elem_value
*ucontrol
);
404 int snd_soc_limit_volume(struct snd_soc_codec
*codec
,
405 const char *name
, int max
);
406 int snd_soc_info_volsw_2r_sx(struct snd_kcontrol
*kcontrol
,
407 struct snd_ctl_elem_info
*uinfo
);
408 int snd_soc_get_volsw_2r_sx(struct snd_kcontrol
*kcontrol
,
409 struct snd_ctl_elem_value
*ucontrol
);
410 int snd_soc_put_volsw_2r_sx(struct snd_kcontrol
*kcontrol
,
411 struct snd_ctl_elem_value
*ucontrol
);
414 * struct snd_soc_reg_access - Describes whether a given register is
415 * readable, writable or volatile.
417 * @reg: the register number
418 * @read: whether this register is readable
419 * @write: whether this register is writable
420 * @vol: whether this register is volatile
422 struct snd_soc_reg_access
{
430 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
432 * @pin: name of the pin to update
433 * @mask: bits to check for in reported jack status
434 * @invert: if non-zero then pin is enabled when status is not reported
436 struct snd_soc_jack_pin
{
437 struct list_head list
;
444 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
446 * @min_mv: start voltage in mv
447 * @max_mv: end voltage in mv
448 * @jack_type: type of jack that is expected for this voltage
449 * @debounce_time: debounce_time for jack, codec driver should wait for this
450 * duration before reading the adc for voltages
451 * @:list: list container
453 struct snd_soc_jack_zone
{
456 unsigned int jack_type
;
457 unsigned int debounce_time
;
458 struct list_head list
;
462 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
466 * @report: value to report when jack detected
467 * @invert: report presence in low state
468 * @debouce_time: debouce time in ms
469 * @wake: enable as wake source
470 * @jack_status_check: callback function which overrides the detection
471 * to provide more complex checks (eg, reading an
474 #ifdef CONFIG_GPIOLIB
475 struct snd_soc_jack_gpio
{
483 struct snd_soc_jack
*jack
;
484 struct delayed_work work
;
486 int (*jack_status_check
)(void);
490 struct snd_soc_jack
{
491 struct snd_jack
*jack
;
492 struct snd_soc_codec
*codec
;
493 struct list_head pins
;
495 struct blocking_notifier_head notifier
;
496 struct list_head jack_zones
;
499 /* SoC PCM stream information */
500 struct snd_soc_pcm_stream
{
501 const char *stream_name
;
502 u64 formats
; /* SNDRV_PCM_FMTBIT_* */
503 unsigned int rates
; /* SNDRV_PCM_RATE_* */
504 unsigned int rate_min
; /* min rate */
505 unsigned int rate_max
; /* max rate */
506 unsigned int channels_min
; /* min channels */
507 unsigned int channels_max
; /* max channels */
512 int (*startup
)(struct snd_pcm_substream
*);
513 void (*shutdown
)(struct snd_pcm_substream
*);
514 int (*hw_params
)(struct snd_pcm_substream
*, struct snd_pcm_hw_params
*);
515 int (*hw_free
)(struct snd_pcm_substream
*);
516 int (*prepare
)(struct snd_pcm_substream
*);
517 int (*trigger
)(struct snd_pcm_substream
*, int);
521 struct snd_soc_cache_ops
{
523 enum snd_soc_compress_type id
;
524 int (*init
)(struct snd_soc_codec
*codec
);
525 int (*exit
)(struct snd_soc_codec
*codec
);
526 int (*read
)(struct snd_soc_codec
*codec
, unsigned int reg
,
527 unsigned int *value
);
528 int (*write
)(struct snd_soc_codec
*codec
, unsigned int reg
,
530 int (*sync
)(struct snd_soc_codec
*codec
);
533 /* SoC Audio Codec device */
534 struct snd_soc_codec
{
536 const char *name_prefix
;
539 const struct snd_soc_codec_driver
*driver
;
542 struct snd_soc_card
*card
;
543 struct list_head list
;
544 struct list_head card_list
;
546 enum snd_soc_compress_type compress_type
;
547 size_t reg_size
; /* reg_cache_size * reg_word_size */
548 int (*volatile_register
)(struct snd_soc_codec
*, unsigned int);
549 int (*readable_register
)(struct snd_soc_codec
*, unsigned int);
550 int (*writable_register
)(struct snd_soc_codec
*, unsigned int);
553 struct snd_ac97
*ac97
; /* for ad-hoc ac97 devices */
555 unsigned int cache_bypass
:1; /* Suppress access to the cache */
556 unsigned int suspended
:1; /* Codec is in suspend PM state */
557 unsigned int probed
:1; /* Codec has been probed */
558 unsigned int ac97_registered
:1; /* Codec has been AC97 registered */
559 unsigned int ac97_created
:1; /* Codec has been created by SoC */
560 unsigned int sysfs_registered
:1; /* codec has been sysfs registered */
561 unsigned int cache_init
:1; /* codec cache has been initialized */
562 u32 cache_only
; /* Suppress writes to hardware */
563 u32 cache_sync
; /* Cache needs to be synced to hardware */
566 void *control_data
; /* codec control (i2c/3wire) data */
567 enum snd_soc_control_type control_type
;
569 unsigned int (*hw_read
)(struct snd_soc_codec
*, unsigned int);
570 unsigned int (*read
)(struct snd_soc_codec
*, unsigned int);
571 int (*write
)(struct snd_soc_codec
*, unsigned int, unsigned int);
572 int (*bulk_write_raw
)(struct snd_soc_codec
*, unsigned int, const void *, size_t);
574 const void *reg_def_copy
;
575 const struct snd_soc_cache_ops
*cache_ops
;
576 struct mutex cache_rw_mutex
;
579 struct snd_soc_dapm_context dapm
;
581 #ifdef CONFIG_DEBUG_FS
582 struct dentry
*debugfs_codec_root
;
583 struct dentry
*debugfs_reg
;
584 struct dentry
*debugfs_dapm
;
589 struct snd_soc_codec_driver
{
592 int (*probe
)(struct snd_soc_codec
*);
593 int (*remove
)(struct snd_soc_codec
*);
594 int (*suspend
)(struct snd_soc_codec
*,
596 int (*resume
)(struct snd_soc_codec
*);
598 /* Default control and setup, added after probe() is run */
599 const struct snd_kcontrol_new
*controls
;
601 const struct snd_soc_dapm_widget
*dapm_widgets
;
602 int num_dapm_widgets
;
603 const struct snd_soc_dapm_route
*dapm_routes
;
606 /* codec wide operations */
607 int (*set_sysclk
)(struct snd_soc_codec
*codec
,
608 int clk_id
, unsigned int freq
, int dir
);
609 int (*set_pll
)(struct snd_soc_codec
*codec
, int pll_id
, int source
,
610 unsigned int freq_in
, unsigned int freq_out
);
613 unsigned int (*read
)(struct snd_soc_codec
*, unsigned int);
614 int (*write
)(struct snd_soc_codec
*, unsigned int, unsigned int);
615 int (*display_register
)(struct snd_soc_codec
*, char *,
616 size_t, unsigned int);
617 int (*volatile_register
)(struct snd_soc_codec
*, unsigned int);
618 int (*readable_register
)(struct snd_soc_codec
*, unsigned int);
619 int (*writable_register
)(struct snd_soc_codec
*, unsigned int);
620 short reg_cache_size
;
621 short reg_cache_step
;
623 const void *reg_cache_default
;
624 short reg_access_size
;
625 const struct snd_soc_reg_access
*reg_access_default
;
626 enum snd_soc_compress_type compress_type
;
628 /* codec bias level */
629 int (*set_bias_level
)(struct snd_soc_codec
*,
630 enum snd_soc_bias_level level
);
632 void (*seq_notifier
)(struct snd_soc_dapm_context
*,
633 enum snd_soc_dapm_type
, int);
635 /* probe ordering - for components with runtime dependencies */
640 /* SoC platform interface */
641 struct snd_soc_platform_driver
{
643 int (*probe
)(struct snd_soc_platform
*);
644 int (*remove
)(struct snd_soc_platform
*);
645 int (*suspend
)(struct snd_soc_dai
*dai
);
646 int (*resume
)(struct snd_soc_dai
*dai
);
648 /* pcm creation and destruction */
649 int (*pcm_new
)(struct snd_soc_pcm_runtime
*);
650 void (*pcm_free
)(struct snd_pcm
*);
653 * For platform caused delay reporting.
656 snd_pcm_sframes_t (*delay
)(struct snd_pcm_substream
*,
657 struct snd_soc_dai
*);
659 /* platform stream ops */
660 struct snd_pcm_ops
*ops
;
662 /* probe ordering - for components with runtime dependencies */
666 /* platform IO - used for platform DAPM */
667 unsigned int (*read
)(struct snd_soc_platform
*, unsigned int);
668 int (*write
)(struct snd_soc_platform
*, unsigned int, unsigned int);
671 struct snd_soc_platform
{
675 struct snd_soc_platform_driver
*driver
;
677 unsigned int suspended
:1; /* platform is suspended */
678 unsigned int probed
:1;
680 struct snd_soc_card
*card
;
681 struct list_head list
;
682 struct list_head card_list
;
685 struct snd_soc_dai_link
{
686 /* config - must be set by machine driver */
687 const char *name
; /* Codec name */
688 const char *stream_name
; /* Stream name */
689 const char *codec_name
; /* for multi-codec */
690 const char *platform_name
; /* for multi-platform */
691 const char *cpu_dai_name
;
692 const char *codec_dai_name
;
694 /* Keep DAI active over suspend */
695 unsigned int ignore_suspend
:1;
697 /* Symmetry requirements */
698 unsigned int symmetric_rates
:1;
700 /* codec/machine specific init - e.g. add machine controls */
701 int (*init
)(struct snd_soc_pcm_runtime
*rtd
);
703 /* machine stream operations */
704 struct snd_soc_ops
*ops
;
707 struct snd_soc_codec_conf
{
708 const char *dev_name
;
711 * optional map of kcontrol, widget and path name prefixes that are
712 * associated per device
714 const char *name_prefix
;
717 * set this to the desired compression type if you want to
718 * override the one supplied in codec->driver->compress_type
720 enum snd_soc_compress_type compress_type
;
723 struct snd_soc_aux_dev
{
724 const char *name
; /* Codec name */
725 const char *codec_name
; /* for multi-codec */
727 /* codec/machine specific init - e.g. add machine controls */
728 int (*init
)(struct snd_soc_dapm_context
*dapm
);
732 struct snd_soc_card
{
734 const char *long_name
;
735 const char *driver_name
;
737 struct snd_card
*snd_card
;
738 struct module
*owner
;
740 struct list_head list
;
745 int (*probe
)(struct snd_soc_card
*card
);
746 int (*late_probe
)(struct snd_soc_card
*card
);
747 int (*remove
)(struct snd_soc_card
*card
);
749 /* the pre and post PM functions are used to do any PM work before and
750 * after the codec and DAI's do any PM work. */
751 int (*suspend_pre
)(struct snd_soc_card
*card
);
752 int (*suspend_post
)(struct snd_soc_card
*card
);
753 int (*resume_pre
)(struct snd_soc_card
*card
);
754 int (*resume_post
)(struct snd_soc_card
*card
);
757 int (*set_bias_level
)(struct snd_soc_card
*,
758 struct snd_soc_dapm_context
*dapm
,
759 enum snd_soc_bias_level level
);
760 int (*set_bias_level_post
)(struct snd_soc_card
*,
761 struct snd_soc_dapm_context
*dapm
,
762 enum snd_soc_bias_level level
);
766 /* CPU <--> Codec DAI links */
767 struct snd_soc_dai_link
*dai_link
;
769 struct snd_soc_pcm_runtime
*rtd
;
772 /* optional codec specific configuration */
773 struct snd_soc_codec_conf
*codec_conf
;
777 * optional auxiliary devices such as amplifiers or codecs with DAI
780 struct snd_soc_aux_dev
*aux_dev
;
782 struct snd_soc_pcm_runtime
*rtd_aux
;
785 const struct snd_kcontrol_new
*controls
;
789 * Card-specific routes and widgets.
791 const struct snd_soc_dapm_widget
*dapm_widgets
;
792 int num_dapm_widgets
;
793 const struct snd_soc_dapm_route
*dapm_routes
;
796 struct work_struct deferred_resume_work
;
798 /* lists of probed devices belonging to this card */
799 struct list_head codec_dev_list
;
800 struct list_head platform_dev_list
;
801 struct list_head dai_dev_list
;
803 struct list_head widgets
;
804 struct list_head paths
;
805 struct list_head dapm_list
;
807 /* Generic DAPM context for the card */
808 struct snd_soc_dapm_context dapm
;
810 #ifdef CONFIG_DEBUG_FS
811 struct dentry
*debugfs_card_root
;
812 struct dentry
*debugfs_pop_time
;
819 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
820 struct snd_soc_pcm_runtime
{
822 struct snd_soc_card
*card
;
823 struct snd_soc_dai_link
*dai_link
;
824 struct mutex pcm_mutex
;
825 enum snd_soc_pcm_subclass pcm_subclass
;
826 struct snd_pcm_ops ops
;
828 unsigned int complete
:1;
829 unsigned int dev_registered
:1;
831 /* Symmetry data - only valid if symmetry is being enforced */
835 /* runtime devices */
837 struct snd_soc_codec
*codec
;
838 struct snd_soc_platform
*platform
;
839 struct snd_soc_dai
*codec_dai
;
840 struct snd_soc_dai
*cpu_dai
;
842 struct delayed_work delayed_work
;
846 struct soc_mixer_control
{
847 int min
, max
, platform_max
;
848 unsigned int reg
, rreg
, shift
, rshift
, invert
;
851 /* enumerated kcontrol */
855 unsigned char shift_l
;
856 unsigned char shift_r
;
859 const char * const *texts
;
860 const unsigned int *values
;
865 unsigned int snd_soc_read(struct snd_soc_codec
*codec
, unsigned int reg
);
866 unsigned int snd_soc_write(struct snd_soc_codec
*codec
,
867 unsigned int reg
, unsigned int val
);
868 unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec
*codec
,
869 unsigned int reg
, const void *data
, size_t len
);
871 /* device driver data */
873 static inline void snd_soc_card_set_drvdata(struct snd_soc_card
*card
,
876 card
->drvdata
= data
;
879 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card
*card
)
881 return card
->drvdata
;
884 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec
*codec
,
887 dev_set_drvdata(codec
->dev
, data
);
890 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec
*codec
)
892 return dev_get_drvdata(codec
->dev
);
895 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform
*platform
,
898 dev_set_drvdata(platform
->dev
, data
);
901 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform
*platform
)
903 return dev_get_drvdata(platform
->dev
);
906 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime
*rtd
,
909 dev_set_drvdata(&rtd
->dev
, data
);
912 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime
*rtd
)
914 return dev_get_drvdata(&rtd
->dev
);
917 static inline void snd_soc_initialize_card_lists(struct snd_soc_card
*card
)
919 INIT_LIST_HEAD(&card
->dai_dev_list
);
920 INIT_LIST_HEAD(&card
->codec_dev_list
);
921 INIT_LIST_HEAD(&card
->platform_dev_list
);
922 INIT_LIST_HEAD(&card
->widgets
);
923 INIT_LIST_HEAD(&card
->paths
);
924 INIT_LIST_HEAD(&card
->dapm_list
);
927 int snd_soc_util_init(void);
928 void snd_soc_util_exit(void);
930 #include <sound/soc-dai.h>
932 #ifdef CONFIG_DEBUG_FS
933 extern struct dentry
*snd_soc_debugfs_root
;
936 extern const struct dev_pm_ops snd_soc_pm_ops
;