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_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
59 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
60 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
61 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
62 .tlv.p = (tlv_array),\
63 .info = snd_soc_info_volsw, \
64 .get = snd_soc_get_volsw_sx,\
65 .put = snd_soc_put_volsw_sx, \
66 .private_value = (unsigned long)&(struct soc_mixer_control) \
67 {.reg = xreg, .rreg = xreg, \
68 .shift = xshift, .rshift = xshift, \
69 .max = xmax, .min = xmin} }
70 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
71 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
72 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
73 .put = snd_soc_put_volsw, \
74 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
76 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
77 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
78 .info = snd_soc_info_volsw, \
79 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
80 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
82 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
83 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
84 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
85 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
86 .tlv.p = (tlv_array), \
87 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
88 .put = snd_soc_put_volsw, \
89 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
91 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
92 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
93 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
94 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
95 .tlv.p = (tlv_array), \
96 .info = snd_soc_info_volsw, \
97 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
98 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
100 #define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
101 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
102 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
103 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
104 .tlv.p = (tlv_array), \
105 .info = snd_soc_info_volsw, \
106 .get = snd_soc_get_volsw_sx, \
107 .put = snd_soc_put_volsw_sx, \
108 .private_value = (unsigned long)&(struct soc_mixer_control) \
109 {.reg = xreg, .rreg = xrreg, \
110 .shift = xshift, .rshift = xshift, \
111 .max = xmax, .min = xmin} }
112 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
113 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
114 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
115 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
116 .tlv.p = (tlv_array), \
117 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
118 .put = snd_soc_put_volsw_s8, \
119 .private_value = (unsigned long)&(struct soc_mixer_control) \
120 {.reg = xreg, .min = xmin, .max = xmax, \
121 .platform_max = xmax} }
122 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
123 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
124 .max = xmax, .texts = xtexts }
125 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
126 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
127 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
128 { .max = xmax, .texts = xtexts }
129 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
130 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
131 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
132 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
133 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
134 #define SOC_ENUM(xname, xenum) \
135 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
136 .info = snd_soc_info_enum_double, \
137 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
138 .private_value = (unsigned long)&xenum }
139 #define SOC_VALUE_ENUM(xname, xenum) \
140 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
141 .info = snd_soc_info_enum_double, \
142 .get = snd_soc_get_value_enum_double, \
143 .put = snd_soc_put_value_enum_double, \
144 .private_value = (unsigned long)&xenum }
145 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
146 xhandler_get, xhandler_put) \
147 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
148 .info = snd_soc_info_volsw, \
149 .get = xhandler_get, .put = xhandler_put, \
150 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
151 #define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
152 xhandler_get, xhandler_put) \
153 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
154 .info = snd_soc_info_volsw, \
155 .get = xhandler_get, .put = xhandler_put, \
157 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert) }
158 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
159 xhandler_get, xhandler_put, tlv_array) \
160 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
161 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
162 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
163 .tlv.p = (tlv_array), \
164 .info = snd_soc_info_volsw, \
165 .get = xhandler_get, .put = xhandler_put, \
166 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
167 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
168 xhandler_get, xhandler_put, tlv_array) \
169 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
170 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
171 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
172 .tlv.p = (tlv_array), \
173 .info = snd_soc_info_volsw, \
174 .get = xhandler_get, .put = xhandler_put, \
175 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
177 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
178 xhandler_get, xhandler_put, tlv_array) \
179 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
180 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
181 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
182 .tlv.p = (tlv_array), \
183 .info = snd_soc_info_volsw, \
184 .get = xhandler_get, .put = xhandler_put, \
185 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
187 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
188 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
189 .info = snd_soc_info_bool_ext, \
190 .get = xhandler_get, .put = xhandler_put, \
191 .private_value = xdata }
192 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
193 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
194 .info = snd_soc_info_enum_ext, \
195 .get = xhandler_get, .put = xhandler_put, \
196 .private_value = (unsigned long)&xenum }
198 #define SND_SOC_BYTES(xname, xbase, xregs) \
199 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
200 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
201 .put = snd_soc_bytes_put, .private_value = \
202 ((unsigned long)&(struct soc_bytes) \
203 {.base = xbase, .num_regs = xregs }) }
205 #define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \
206 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
207 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
208 .put = snd_soc_bytes_put, .private_value = \
209 ((unsigned long)&(struct soc_bytes) \
210 {.base = xbase, .num_regs = xregs, \
213 #define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
214 xmin, xmax, xinvert) \
215 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
216 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
217 .put = snd_soc_put_xr_sx, \
218 .private_value = (unsigned long)&(struct soc_mreg_control) \
219 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
220 .invert = xinvert, .min = xmin, .max = xmax} }
223 * Simplified versions of above macros, declaring a struct and calculating
224 * ARRAY_SIZE internally
226 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
227 struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
228 ARRAY_SIZE(xtexts), xtexts)
229 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
230 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
231 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
232 struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
233 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
234 struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
235 ARRAY_SIZE(xtexts), xtexts, xvalues)
236 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
237 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
240 * Component probe and remove ordering levels for components with runtime
243 #define SND_SOC_COMP_ORDER_FIRST -2
244 #define SND_SOC_COMP_ORDER_EARLY -1
245 #define SND_SOC_COMP_ORDER_NORMAL 0
246 #define SND_SOC_COMP_ORDER_LATE 1
247 #define SND_SOC_COMP_ORDER_LAST 2
252 * @ON: Bias is fully on for audio playback and capture operations.
253 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
254 * stream start and stop operations.
255 * @STANDBY: Low power standby state when no playback/capture operations are
256 * in progress. NOTE: The transition time between STANDBY and ON
257 * should be as fast as possible and no longer than 10ms.
258 * @OFF: Power Off. No restrictions on transition times.
260 enum snd_soc_bias_level
{
261 SND_SOC_BIAS_OFF
= 0,
262 SND_SOC_BIAS_STANDBY
= 1,
263 SND_SOC_BIAS_PREPARE
= 2,
270 struct snd_soc_pcm_stream
;
272 struct snd_soc_pcm_runtime
;
274 struct snd_soc_dai_driver
;
275 struct snd_soc_platform
;
276 struct snd_soc_dai_link
;
277 struct snd_soc_platform_driver
;
278 struct snd_soc_codec
;
279 struct snd_soc_codec_driver
;
282 struct snd_soc_jack_zone
;
283 struct snd_soc_jack_pin
;
284 struct snd_soc_cache_ops
;
285 #include <sound/soc-dapm.h>
287 #ifdef CONFIG_GPIOLIB
288 struct snd_soc_jack_gpio
;
291 typedef int (*hw_write_t
)(void *,const char* ,int);
293 extern struct snd_ac97_bus_ops soc_ac97_ops
;
295 enum snd_soc_control_type
{
301 enum snd_soc_compress_type
{
302 SND_SOC_FLAT_COMPRESSION
= 1,
305 enum snd_soc_pcm_subclass
{
306 SND_SOC_PCM_CLASS_PCM
= 0,
307 SND_SOC_PCM_CLASS_BE
= 1,
310 enum snd_soc_card_subclass
{
311 SND_SOC_CARD_CLASS_INIT
= 0,
312 SND_SOC_CARD_CLASS_RUNTIME
= 1,
315 int snd_soc_codec_set_sysclk(struct snd_soc_codec
*codec
, int clk_id
,
316 int source
, unsigned int freq
, int dir
);
317 int snd_soc_codec_set_pll(struct snd_soc_codec
*codec
, int pll_id
, int source
,
318 unsigned int freq_in
, unsigned int freq_out
);
320 int snd_soc_register_card(struct snd_soc_card
*card
);
321 int snd_soc_unregister_card(struct snd_soc_card
*card
);
322 int snd_soc_suspend(struct device
*dev
);
323 int snd_soc_resume(struct device
*dev
);
324 int snd_soc_poweroff(struct device
*dev
);
325 int snd_soc_register_platform(struct device
*dev
,
326 struct snd_soc_platform_driver
*platform_drv
);
327 void snd_soc_unregister_platform(struct device
*dev
);
328 int snd_soc_register_codec(struct device
*dev
,
329 const struct snd_soc_codec_driver
*codec_drv
,
330 struct snd_soc_dai_driver
*dai_drv
, int num_dai
);
331 void snd_soc_unregister_codec(struct device
*dev
);
332 int snd_soc_codec_volatile_register(struct snd_soc_codec
*codec
,
334 int snd_soc_codec_readable_register(struct snd_soc_codec
*codec
,
336 int snd_soc_codec_writable_register(struct snd_soc_codec
*codec
,
338 int snd_soc_codec_set_cache_io(struct snd_soc_codec
*codec
,
339 int addr_bits
, int data_bits
,
340 enum snd_soc_control_type control
);
341 int snd_soc_cache_sync(struct snd_soc_codec
*codec
);
342 int snd_soc_cache_init(struct snd_soc_codec
*codec
);
343 int snd_soc_cache_exit(struct snd_soc_codec
*codec
);
344 int snd_soc_cache_write(struct snd_soc_codec
*codec
,
345 unsigned int reg
, unsigned int value
);
346 int snd_soc_cache_read(struct snd_soc_codec
*codec
,
347 unsigned int reg
, unsigned int *value
);
348 int snd_soc_default_volatile_register(struct snd_soc_codec
*codec
,
350 int snd_soc_default_readable_register(struct snd_soc_codec
*codec
,
352 int snd_soc_default_writable_register(struct snd_soc_codec
*codec
,
354 int snd_soc_platform_read(struct snd_soc_platform
*platform
,
356 int snd_soc_platform_write(struct snd_soc_platform
*platform
,
357 unsigned int reg
, unsigned int val
);
358 int soc_new_pcm(struct snd_soc_pcm_runtime
*rtd
, int num
);
360 /* Utility functions to get clock rates from various things */
361 int snd_soc_calc_frame_size(int sample_size
, int channels
, int tdm_slots
);
362 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params
*params
);
363 int snd_soc_calc_bclk(int fs
, int sample_size
, int channels
, int tdm_slots
);
364 int snd_soc_params_to_bclk(struct snd_pcm_hw_params
*parms
);
366 /* set runtime hw params */
367 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream
*substream
,
368 const struct snd_pcm_hardware
*hw
);
371 int snd_soc_jack_new(struct snd_soc_codec
*codec
, const char *id
, int type
,
372 struct snd_soc_jack
*jack
);
373 void snd_soc_jack_report(struct snd_soc_jack
*jack
, int status
, int mask
);
374 int snd_soc_jack_add_pins(struct snd_soc_jack
*jack
, int count
,
375 struct snd_soc_jack_pin
*pins
);
376 void snd_soc_jack_notifier_register(struct snd_soc_jack
*jack
,
377 struct notifier_block
*nb
);
378 void snd_soc_jack_notifier_unregister(struct snd_soc_jack
*jack
,
379 struct notifier_block
*nb
);
380 int snd_soc_jack_add_zones(struct snd_soc_jack
*jack
, int count
,
381 struct snd_soc_jack_zone
*zones
);
382 int snd_soc_jack_get_type(struct snd_soc_jack
*jack
, int micbias_voltage
);
383 #ifdef CONFIG_GPIOLIB
384 int snd_soc_jack_add_gpios(struct snd_soc_jack
*jack
, int count
,
385 struct snd_soc_jack_gpio
*gpios
);
386 void snd_soc_jack_free_gpios(struct snd_soc_jack
*jack
, int count
,
387 struct snd_soc_jack_gpio
*gpios
);
390 /* codec register bit access */
391 int snd_soc_update_bits(struct snd_soc_codec
*codec
, unsigned short reg
,
392 unsigned int mask
, unsigned int value
);
393 int snd_soc_update_bits_locked(struct snd_soc_codec
*codec
,
394 unsigned short reg
, unsigned int mask
,
396 int snd_soc_test_bits(struct snd_soc_codec
*codec
, unsigned short reg
,
397 unsigned int mask
, unsigned int value
);
399 int snd_soc_new_ac97_codec(struct snd_soc_codec
*codec
,
400 struct snd_ac97_bus_ops
*ops
, int num
);
401 void snd_soc_free_ac97_codec(struct snd_soc_codec
*codec
);
406 struct snd_kcontrol
*snd_soc_cnew(const struct snd_kcontrol_new
*_template
,
407 void *data
, const char *long_name
,
409 int snd_soc_add_codec_controls(struct snd_soc_codec
*codec
,
410 const struct snd_kcontrol_new
*controls
, int num_controls
);
411 int snd_soc_add_platform_controls(struct snd_soc_platform
*platform
,
412 const struct snd_kcontrol_new
*controls
, int num_controls
);
413 int snd_soc_add_card_controls(struct snd_soc_card
*soc_card
,
414 const struct snd_kcontrol_new
*controls
, int num_controls
);
415 int snd_soc_add_dai_controls(struct snd_soc_dai
*dai
,
416 const struct snd_kcontrol_new
*controls
, int num_controls
);
417 int snd_soc_info_enum_double(struct snd_kcontrol
*kcontrol
,
418 struct snd_ctl_elem_info
*uinfo
);
419 int snd_soc_info_enum_ext(struct snd_kcontrol
*kcontrol
,
420 struct snd_ctl_elem_info
*uinfo
);
421 int snd_soc_get_enum_double(struct snd_kcontrol
*kcontrol
,
422 struct snd_ctl_elem_value
*ucontrol
);
423 int snd_soc_put_enum_double(struct snd_kcontrol
*kcontrol
,
424 struct snd_ctl_elem_value
*ucontrol
);
425 int snd_soc_get_value_enum_double(struct snd_kcontrol
*kcontrol
,
426 struct snd_ctl_elem_value
*ucontrol
);
427 int snd_soc_put_value_enum_double(struct snd_kcontrol
*kcontrol
,
428 struct snd_ctl_elem_value
*ucontrol
);
429 int snd_soc_info_volsw(struct snd_kcontrol
*kcontrol
,
430 struct snd_ctl_elem_info
*uinfo
);
431 int snd_soc_info_volsw_ext(struct snd_kcontrol
*kcontrol
,
432 struct snd_ctl_elem_info
*uinfo
);
433 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
434 int snd_soc_get_volsw(struct snd_kcontrol
*kcontrol
,
435 struct snd_ctl_elem_value
*ucontrol
);
436 int snd_soc_put_volsw(struct snd_kcontrol
*kcontrol
,
437 struct snd_ctl_elem_value
*ucontrol
);
438 #define snd_soc_get_volsw_2r snd_soc_get_volsw
439 #define snd_soc_put_volsw_2r snd_soc_put_volsw
440 int snd_soc_get_volsw_sx(struct snd_kcontrol
*kcontrol
,
441 struct snd_ctl_elem_value
*ucontrol
);
442 int snd_soc_put_volsw_sx(struct snd_kcontrol
*kcontrol
,
443 struct snd_ctl_elem_value
*ucontrol
);
444 int snd_soc_info_volsw_s8(struct snd_kcontrol
*kcontrol
,
445 struct snd_ctl_elem_info
*uinfo
);
446 int snd_soc_get_volsw_s8(struct snd_kcontrol
*kcontrol
,
447 struct snd_ctl_elem_value
*ucontrol
);
448 int snd_soc_put_volsw_s8(struct snd_kcontrol
*kcontrol
,
449 struct snd_ctl_elem_value
*ucontrol
);
450 int snd_soc_limit_volume(struct snd_soc_codec
*codec
,
451 const char *name
, int max
);
452 int snd_soc_bytes_info(struct snd_kcontrol
*kcontrol
,
453 struct snd_ctl_elem_info
*uinfo
);
454 int snd_soc_bytes_get(struct snd_kcontrol
*kcontrol
,
455 struct snd_ctl_elem_value
*ucontrol
);
456 int snd_soc_bytes_put(struct snd_kcontrol
*kcontrol
,
457 struct snd_ctl_elem_value
*ucontrol
);
458 int snd_soc_info_xr_sx(struct snd_kcontrol
*kcontrol
,
459 struct snd_ctl_elem_info
*uinfo
);
460 int snd_soc_get_xr_sx(struct snd_kcontrol
*kcontrol
,
461 struct snd_ctl_elem_value
*ucontrol
);
462 int snd_soc_put_xr_sx(struct snd_kcontrol
*kcontrol
,
463 struct snd_ctl_elem_value
*ucontrol
);
466 * struct snd_soc_reg_access - Describes whether a given register is
467 * readable, writable or volatile.
469 * @reg: the register number
470 * @read: whether this register is readable
471 * @write: whether this register is writable
472 * @vol: whether this register is volatile
474 struct snd_soc_reg_access
{
482 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
484 * @pin: name of the pin to update
485 * @mask: bits to check for in reported jack status
486 * @invert: if non-zero then pin is enabled when status is not reported
488 struct snd_soc_jack_pin
{
489 struct list_head list
;
496 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
498 * @min_mv: start voltage in mv
499 * @max_mv: end voltage in mv
500 * @jack_type: type of jack that is expected for this voltage
501 * @debounce_time: debounce_time for jack, codec driver should wait for this
502 * duration before reading the adc for voltages
503 * @:list: list container
505 struct snd_soc_jack_zone
{
508 unsigned int jack_type
;
509 unsigned int debounce_time
;
510 struct list_head list
;
514 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
518 * @report: value to report when jack detected
519 * @invert: report presence in low state
520 * @debouce_time: debouce time in ms
521 * @wake: enable as wake source
522 * @jack_status_check: callback function which overrides the detection
523 * to provide more complex checks (eg, reading an
526 #ifdef CONFIG_GPIOLIB
527 struct snd_soc_jack_gpio
{
535 struct snd_soc_jack
*jack
;
536 struct delayed_work work
;
538 int (*jack_status_check
)(void);
542 struct snd_soc_jack
{
544 struct snd_jack
*jack
;
545 struct snd_soc_codec
*codec
;
546 struct list_head pins
;
548 struct blocking_notifier_head notifier
;
549 struct list_head jack_zones
;
552 /* SoC PCM stream information */
553 struct snd_soc_pcm_stream
{
554 const char *stream_name
;
555 u64 formats
; /* SNDRV_PCM_FMTBIT_* */
556 unsigned int rates
; /* SNDRV_PCM_RATE_* */
557 unsigned int rate_min
; /* min rate */
558 unsigned int rate_max
; /* max rate */
559 unsigned int channels_min
; /* min channels */
560 unsigned int channels_max
; /* max channels */
561 unsigned int sig_bits
; /* number of bits of content */
566 int (*startup
)(struct snd_pcm_substream
*);
567 void (*shutdown
)(struct snd_pcm_substream
*);
568 int (*hw_params
)(struct snd_pcm_substream
*, struct snd_pcm_hw_params
*);
569 int (*hw_free
)(struct snd_pcm_substream
*);
570 int (*prepare
)(struct snd_pcm_substream
*);
571 int (*trigger
)(struct snd_pcm_substream
*, int);
575 struct snd_soc_cache_ops
{
577 enum snd_soc_compress_type id
;
578 int (*init
)(struct snd_soc_codec
*codec
);
579 int (*exit
)(struct snd_soc_codec
*codec
);
580 int (*read
)(struct snd_soc_codec
*codec
, unsigned int reg
,
581 unsigned int *value
);
582 int (*write
)(struct snd_soc_codec
*codec
, unsigned int reg
,
584 int (*sync
)(struct snd_soc_codec
*codec
);
587 /* SoC Audio Codec device */
588 struct snd_soc_codec
{
590 const char *name_prefix
;
593 const struct snd_soc_codec_driver
*driver
;
596 struct snd_soc_card
*card
;
597 struct list_head list
;
598 struct list_head card_list
;
600 enum snd_soc_compress_type compress_type
;
601 size_t reg_size
; /* reg_cache_size * reg_word_size */
602 int (*volatile_register
)(struct snd_soc_codec
*, unsigned int);
603 int (*readable_register
)(struct snd_soc_codec
*, unsigned int);
604 int (*writable_register
)(struct snd_soc_codec
*, unsigned int);
607 struct snd_ac97
*ac97
; /* for ad-hoc ac97 devices */
609 unsigned int cache_bypass
:1; /* Suppress access to the cache */
610 unsigned int suspended
:1; /* Codec is in suspend PM state */
611 unsigned int probed
:1; /* Codec has been probed */
612 unsigned int ac97_registered
:1; /* Codec has been AC97 registered */
613 unsigned int ac97_created
:1; /* Codec has been created by SoC */
614 unsigned int sysfs_registered
:1; /* codec has been sysfs registered */
615 unsigned int cache_init
:1; /* codec cache has been initialized */
616 unsigned int using_regmap
:1; /* using regmap access */
617 u32 cache_only
; /* Suppress writes to hardware */
618 u32 cache_sync
; /* Cache needs to be synced to hardware */
621 void *control_data
; /* codec control (i2c/3wire) data */
622 enum snd_soc_control_type control_type
;
624 unsigned int (*hw_read
)(struct snd_soc_codec
*, unsigned int);
625 unsigned int (*read
)(struct snd_soc_codec
*, unsigned int);
626 int (*write
)(struct snd_soc_codec
*, unsigned int, unsigned int);
627 int (*bulk_write_raw
)(struct snd_soc_codec
*, unsigned int, const void *, size_t);
629 const void *reg_def_copy
;
630 const struct snd_soc_cache_ops
*cache_ops
;
631 struct mutex cache_rw_mutex
;
635 struct snd_soc_dapm_context dapm
;
636 unsigned int ignore_pmdown_time
:1; /* pmdown_time is ignored at stop */
638 #ifdef CONFIG_DEBUG_FS
639 struct dentry
*debugfs_codec_root
;
640 struct dentry
*debugfs_reg
;
641 struct dentry
*debugfs_dapm
;
646 struct snd_soc_codec_driver
{
649 int (*probe
)(struct snd_soc_codec
*);
650 int (*remove
)(struct snd_soc_codec
*);
651 int (*suspend
)(struct snd_soc_codec
*);
652 int (*resume
)(struct snd_soc_codec
*);
654 /* Default control and setup, added after probe() is run */
655 const struct snd_kcontrol_new
*controls
;
657 const struct snd_soc_dapm_widget
*dapm_widgets
;
658 int num_dapm_widgets
;
659 const struct snd_soc_dapm_route
*dapm_routes
;
662 /* codec wide operations */
663 int (*set_sysclk
)(struct snd_soc_codec
*codec
,
664 int clk_id
, int source
, unsigned int freq
, int dir
);
665 int (*set_pll
)(struct snd_soc_codec
*codec
, int pll_id
, int source
,
666 unsigned int freq_in
, unsigned int freq_out
);
669 unsigned int (*read
)(struct snd_soc_codec
*, unsigned int);
670 int (*write
)(struct snd_soc_codec
*, unsigned int, unsigned int);
671 int (*display_register
)(struct snd_soc_codec
*, char *,
672 size_t, unsigned int);
673 int (*volatile_register
)(struct snd_soc_codec
*, unsigned int);
674 int (*readable_register
)(struct snd_soc_codec
*, unsigned int);
675 int (*writable_register
)(struct snd_soc_codec
*, unsigned int);
676 unsigned int reg_cache_size
;
677 short reg_cache_step
;
679 const void *reg_cache_default
;
680 short reg_access_size
;
681 const struct snd_soc_reg_access
*reg_access_default
;
682 enum snd_soc_compress_type compress_type
;
684 /* codec bias level */
685 int (*set_bias_level
)(struct snd_soc_codec
*,
686 enum snd_soc_bias_level level
);
689 void (*seq_notifier
)(struct snd_soc_dapm_context
*,
690 enum snd_soc_dapm_type
, int);
692 /* codec stream completion event */
693 int (*stream_event
)(struct snd_soc_dapm_context
*dapm
, int event
);
695 bool ignore_pmdown_time
; /* Doesn't benefit from pmdown delay */
697 /* probe ordering - for components with runtime dependencies */
702 /* SoC platform interface */
703 struct snd_soc_platform_driver
{
705 int (*probe
)(struct snd_soc_platform
*);
706 int (*remove
)(struct snd_soc_platform
*);
707 int (*suspend
)(struct snd_soc_dai
*dai
);
708 int (*resume
)(struct snd_soc_dai
*dai
);
710 /* pcm creation and destruction */
711 int (*pcm_new
)(struct snd_soc_pcm_runtime
*);
712 void (*pcm_free
)(struct snd_pcm
*);
714 /* Default control and setup, added after probe() is run */
715 const struct snd_kcontrol_new
*controls
;
717 const struct snd_soc_dapm_widget
*dapm_widgets
;
718 int num_dapm_widgets
;
719 const struct snd_soc_dapm_route
*dapm_routes
;
723 * For platform caused delay reporting.
726 snd_pcm_sframes_t (*delay
)(struct snd_pcm_substream
*,
727 struct snd_soc_dai
*);
729 /* platform stream ops */
730 struct snd_pcm_ops
*ops
;
732 /* platform stream completion event */
733 int (*stream_event
)(struct snd_soc_dapm_context
*dapm
, int event
);
735 /* probe ordering - for components with runtime dependencies */
739 /* platform IO - used for platform DAPM */
740 unsigned int (*read
)(struct snd_soc_platform
*, unsigned int);
741 int (*write
)(struct snd_soc_platform
*, unsigned int, unsigned int);
744 struct snd_soc_platform
{
748 struct snd_soc_platform_driver
*driver
;
751 unsigned int suspended
:1; /* platform is suspended */
752 unsigned int probed
:1;
754 struct snd_soc_card
*card
;
755 struct list_head list
;
756 struct list_head card_list
;
758 struct snd_soc_dapm_context dapm
;
760 #ifdef CONFIG_DEBUG_FS
761 struct dentry
*debugfs_platform_root
;
762 struct dentry
*debugfs_dapm
;
766 struct snd_soc_dai_link
{
767 /* config - must be set by machine driver */
768 const char *name
; /* Codec name */
769 const char *stream_name
; /* Stream name */
770 const char *codec_name
; /* for multi-codec */
771 const struct device_node
*codec_of_node
;
772 const char *platform_name
; /* for multi-platform */
773 const struct device_node
*platform_of_node
;
774 const char *cpu_dai_name
;
775 const struct device_node
*cpu_dai_of_node
;
776 const char *codec_dai_name
;
778 const struct snd_soc_pcm_stream
*params
;
780 unsigned int dai_fmt
; /* format to set on init */
782 /* Keep DAI active over suspend */
783 unsigned int ignore_suspend
:1;
785 /* Symmetry requirements */
786 unsigned int symmetric_rates
:1;
788 /* pmdown_time is ignored at stop */
789 unsigned int ignore_pmdown_time
:1;
791 /* codec/machine specific init - e.g. add machine controls */
792 int (*init
)(struct snd_soc_pcm_runtime
*rtd
);
794 /* machine stream operations */
795 struct snd_soc_ops
*ops
;
798 struct snd_soc_codec_conf
{
799 const char *dev_name
;
802 * optional map of kcontrol, widget and path name prefixes that are
803 * associated per device
805 const char *name_prefix
;
808 * set this to the desired compression type if you want to
809 * override the one supplied in codec->driver->compress_type
811 enum snd_soc_compress_type compress_type
;
814 struct snd_soc_aux_dev
{
815 const char *name
; /* Codec name */
816 const char *codec_name
; /* for multi-codec */
818 /* codec/machine specific init - e.g. add machine controls */
819 int (*init
)(struct snd_soc_dapm_context
*dapm
);
823 struct snd_soc_card
{
825 const char *long_name
;
826 const char *driver_name
;
828 struct snd_card
*snd_card
;
829 struct module
*owner
;
831 struct list_head list
;
833 struct mutex dapm_mutex
;
837 int (*probe
)(struct snd_soc_card
*card
);
838 int (*late_probe
)(struct snd_soc_card
*card
);
839 int (*remove
)(struct snd_soc_card
*card
);
841 /* the pre and post PM functions are used to do any PM work before and
842 * after the codec and DAI's do any PM work. */
843 int (*suspend_pre
)(struct snd_soc_card
*card
);
844 int (*suspend_post
)(struct snd_soc_card
*card
);
845 int (*resume_pre
)(struct snd_soc_card
*card
);
846 int (*resume_post
)(struct snd_soc_card
*card
);
849 int (*set_bias_level
)(struct snd_soc_card
*,
850 struct snd_soc_dapm_context
*dapm
,
851 enum snd_soc_bias_level level
);
852 int (*set_bias_level_post
)(struct snd_soc_card
*,
853 struct snd_soc_dapm_context
*dapm
,
854 enum snd_soc_bias_level level
);
858 /* CPU <--> Codec DAI links */
859 struct snd_soc_dai_link
*dai_link
;
861 struct snd_soc_pcm_runtime
*rtd
;
864 /* optional codec specific configuration */
865 struct snd_soc_codec_conf
*codec_conf
;
869 * optional auxiliary devices such as amplifiers or codecs with DAI
872 struct snd_soc_aux_dev
*aux_dev
;
874 struct snd_soc_pcm_runtime
*rtd_aux
;
877 const struct snd_kcontrol_new
*controls
;
881 * Card-specific routes and widgets.
883 const struct snd_soc_dapm_widget
*dapm_widgets
;
884 int num_dapm_widgets
;
885 const struct snd_soc_dapm_route
*dapm_routes
;
889 struct work_struct deferred_resume_work
;
891 /* lists of probed devices belonging to this card */
892 struct list_head codec_dev_list
;
893 struct list_head platform_dev_list
;
894 struct list_head dai_dev_list
;
896 struct list_head widgets
;
897 struct list_head paths
;
898 struct list_head dapm_list
;
899 struct list_head dapm_dirty
;
901 /* Generic DAPM context for the card */
902 struct snd_soc_dapm_context dapm
;
903 struct snd_soc_dapm_stats dapm_stats
;
905 #ifdef CONFIG_DEBUG_FS
906 struct dentry
*debugfs_card_root
;
907 struct dentry
*debugfs_pop_time
;
914 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
915 struct snd_soc_pcm_runtime
{
917 struct snd_soc_card
*card
;
918 struct snd_soc_dai_link
*dai_link
;
919 struct mutex pcm_mutex
;
920 enum snd_soc_pcm_subclass pcm_subclass
;
921 struct snd_pcm_ops ops
;
923 unsigned int dev_registered
:1;
927 /* runtime devices */
929 struct snd_soc_codec
*codec
;
930 struct snd_soc_platform
*platform
;
931 struct snd_soc_dai
*codec_dai
;
932 struct snd_soc_dai
*cpu_dai
;
934 struct delayed_work delayed_work
;
938 struct soc_mixer_control
{
939 int min
, max
, platform_max
;
940 unsigned int reg
, rreg
, shift
, rshift
, invert
;
949 /* multi register control */
950 struct soc_mreg_control
{
952 unsigned int regbase
, regcount
, nbits
, invert
;
955 /* enumerated kcontrol */
959 unsigned char shift_l
;
960 unsigned char shift_r
;
963 const char * const *texts
;
964 const unsigned int *values
;
969 unsigned int snd_soc_read(struct snd_soc_codec
*codec
, unsigned int reg
);
970 unsigned int snd_soc_write(struct snd_soc_codec
*codec
,
971 unsigned int reg
, unsigned int val
);
972 unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec
*codec
,
973 unsigned int reg
, const void *data
, size_t len
);
975 /* device driver data */
977 static inline void snd_soc_card_set_drvdata(struct snd_soc_card
*card
,
980 card
->drvdata
= data
;
983 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card
*card
)
985 return card
->drvdata
;
988 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec
*codec
,
991 dev_set_drvdata(codec
->dev
, data
);
994 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec
*codec
)
996 return dev_get_drvdata(codec
->dev
);
999 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform
*platform
,
1002 dev_set_drvdata(platform
->dev
, data
);
1005 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform
*platform
)
1007 return dev_get_drvdata(platform
->dev
);
1010 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime
*rtd
,
1013 dev_set_drvdata(rtd
->dev
, data
);
1016 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime
*rtd
)
1018 return dev_get_drvdata(rtd
->dev
);
1021 static inline void snd_soc_initialize_card_lists(struct snd_soc_card
*card
)
1023 INIT_LIST_HEAD(&card
->dai_dev_list
);
1024 INIT_LIST_HEAD(&card
->codec_dev_list
);
1025 INIT_LIST_HEAD(&card
->platform_dev_list
);
1026 INIT_LIST_HEAD(&card
->widgets
);
1027 INIT_LIST_HEAD(&card
->paths
);
1028 INIT_LIST_HEAD(&card
->dapm_list
);
1031 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control
*mc
)
1033 if (mc
->reg
== mc
->rreg
&& mc
->shift
== mc
->rshift
)
1036 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1037 * mc->reg != mc->rreg means that the control is
1038 * stereo (bits in one register or in two registers)
1043 int snd_soc_util_init(void);
1044 void snd_soc_util_exit(void);
1046 int snd_soc_of_parse_card_name(struct snd_soc_card
*card
,
1047 const char *propname
);
1048 int snd_soc_of_parse_audio_routing(struct snd_soc_card
*card
,
1049 const char *propname
);
1051 #include <sound/soc-dai.h>
1053 #ifdef CONFIG_DEBUG_FS
1054 extern struct dentry
*snd_soc_debugfs_root
;
1057 extern const struct dev_pm_ops snd_soc_pm_ops
;