2 * linux/sound/soc.h -- ALSA SoC Layer
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #ifndef __LINUX_SND_SOC_H
14 #define __LINUX_SND_SOC_H
16 #include <linux/platform_device.h>
17 #include <linux/types.h>
18 #include <linux/workqueue.h>
19 #include <sound/core.h>
20 #include <sound/pcm.h>
21 #include <sound/control.h>
22 #include <sound/ac97_codec.h>
25 * Convenience kcontrol builders
27 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
28 ((unsigned long)&(struct soc_mixer_control) \
29 {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
31 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
32 ((unsigned long)&(struct soc_mixer_control) \
33 {.reg = xreg, .max = xmax, .invert = xinvert})
34 #define SOC_SINGLE(xname, reg, shift, max, invert) \
35 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
36 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
37 .put = snd_soc_put_volsw, \
38 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
39 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
40 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
41 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
42 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
43 .tlv.p = (tlv_array), \
44 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
45 .put = snd_soc_put_volsw, \
46 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
47 #define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
48 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
49 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
50 .put = snd_soc_put_volsw, \
51 .private_value = (unsigned long)&(struct soc_mixer_control) \
52 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
53 .max = xmax, .invert = xinvert} }
54 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
55 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
56 .info = snd_soc_info_volsw_2r, \
57 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
58 .private_value = (unsigned long)&(struct soc_mixer_control) \
59 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
60 .max = xmax, .invert = xinvert} }
61 #define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
62 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
63 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
64 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
65 .tlv.p = (tlv_array), \
66 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
67 .put = snd_soc_put_volsw, \
68 .private_value = (unsigned long)&(struct soc_mixer_control) \
69 {.reg = xreg, .shift = shift_left, .rshift = shift_right,\
70 .max = xmax, .invert = xinvert} }
71 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
72 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
73 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
74 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
75 .tlv.p = (tlv_array), \
76 .info = snd_soc_info_volsw_2r, \
77 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
78 .private_value = (unsigned long)&(struct soc_mixer_control) \
79 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
80 .max = xmax, .invert = xinvert} }
81 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
82 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
83 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
84 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
85 .tlv.p = (tlv_array), \
86 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
87 .put = snd_soc_put_volsw_s8, \
88 .private_value = (unsigned long)&(struct soc_mixer_control) \
89 {.reg = xreg, .min = xmin, .max = xmax} }
90 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
91 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
92 .max = xmax, .texts = xtexts }
93 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
94 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
95 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
96 { .max = xmax, .texts = xtexts }
97 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
98 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
99 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
100 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
101 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
102 #define SOC_ENUM(xname, xenum) \
103 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
104 .info = snd_soc_info_enum_double, \
105 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
106 .private_value = (unsigned long)&xenum }
107 #define SOC_VALUE_ENUM(xname, xenum) \
108 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
109 .info = snd_soc_info_enum_double, \
110 .get = snd_soc_get_value_enum_double, \
111 .put = snd_soc_put_value_enum_double, \
112 .private_value = (unsigned long)&xenum }
113 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
114 xhandler_get, xhandler_put) \
115 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
116 .info = snd_soc_info_volsw, \
117 .get = xhandler_get, .put = xhandler_put, \
118 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
119 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
120 xhandler_get, xhandler_put, tlv_array) \
121 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
122 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
123 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
124 .tlv.p = (tlv_array), \
125 .info = snd_soc_info_volsw, \
126 .get = xhandler_get, .put = xhandler_put, \
127 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
128 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
129 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
130 .info = snd_soc_info_bool_ext, \
131 .get = xhandler_get, .put = xhandler_put, \
132 .private_value = xdata }
133 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
134 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
135 .info = snd_soc_info_enum_ext, \
136 .get = xhandler_get, .put = xhandler_put, \
137 .private_value = (unsigned long)&xenum }
142 * @ON: Bias is fully on for audio playback and capture operations.
143 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
144 * stream start and stop operations.
145 * @STANDBY: Low power standby state when no playback/capture operations are
146 * in progress. NOTE: The transition time between STANDBY and ON
147 * should be as fast as possible and no longer than 10ms.
148 * @OFF: Power Off. No restrictions on transition times.
150 enum snd_soc_bias_level
{
152 SND_SOC_BIAS_PREPARE
,
153 SND_SOC_BIAS_STANDBY
,
159 struct snd_soc_device
;
160 struct snd_soc_pcm_stream
;
162 struct snd_soc_dai_mode
;
163 struct snd_soc_pcm_runtime
;
165 struct snd_soc_platform
;
166 struct snd_soc_codec
;
168 struct snd_soc_ac97_ops
;
170 struct snd_soc_jack_pin
;
172 typedef int (*hw_write_t
)(void *,const char* ,int);
173 typedef int (*hw_read_t
)(void *,char* ,int);
175 extern struct snd_ac97_bus_ops soc_ac97_ops
;
177 int snd_soc_register_platform(struct snd_soc_platform
*platform
);
178 void snd_soc_unregister_platform(struct snd_soc_platform
*platform
);
179 int snd_soc_register_codec(struct snd_soc_codec
*codec
);
180 void snd_soc_unregister_codec(struct snd_soc_codec
*codec
);
182 /* pcm <-> DAI connect */
183 void snd_soc_free_pcms(struct snd_soc_device
*socdev
);
184 int snd_soc_new_pcms(struct snd_soc_device
*socdev
, int idx
, const char *xid
);
185 int snd_soc_init_card(struct snd_soc_device
*socdev
);
187 /* set runtime hw params */
188 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream
*substream
,
189 const struct snd_pcm_hardware
*hw
);
192 int snd_soc_jack_new(struct snd_soc_card
*card
, const char *id
, int type
,
193 struct snd_soc_jack
*jack
);
194 void snd_soc_jack_report(struct snd_soc_jack
*jack
, int status
, int mask
);
195 int snd_soc_jack_add_pins(struct snd_soc_jack
*jack
, int count
,
196 struct snd_soc_jack_pin
*pins
);
199 #define snd_soc_read(codec, reg) codec->read(codec, reg)
200 #define snd_soc_write(codec, reg, value) codec->write(codec, reg, value)
202 /* codec register bit access */
203 int snd_soc_update_bits(struct snd_soc_codec
*codec
, unsigned short reg
,
204 unsigned short mask
, unsigned short value
);
205 int snd_soc_test_bits(struct snd_soc_codec
*codec
, unsigned short reg
,
206 unsigned short mask
, unsigned short value
);
208 int snd_soc_new_ac97_codec(struct snd_soc_codec
*codec
,
209 struct snd_ac97_bus_ops
*ops
, int num
);
210 void snd_soc_free_ac97_codec(struct snd_soc_codec
*codec
);
215 struct snd_kcontrol
*snd_soc_cnew(const struct snd_kcontrol_new
*_template
,
216 void *data
, char *long_name
);
217 int snd_soc_add_controls(struct snd_soc_codec
*codec
,
218 const struct snd_kcontrol_new
*controls
, int num_controls
);
219 int snd_soc_info_enum_double(struct snd_kcontrol
*kcontrol
,
220 struct snd_ctl_elem_info
*uinfo
);
221 int snd_soc_info_enum_ext(struct snd_kcontrol
*kcontrol
,
222 struct snd_ctl_elem_info
*uinfo
);
223 int snd_soc_get_enum_double(struct snd_kcontrol
*kcontrol
,
224 struct snd_ctl_elem_value
*ucontrol
);
225 int snd_soc_put_enum_double(struct snd_kcontrol
*kcontrol
,
226 struct snd_ctl_elem_value
*ucontrol
);
227 int snd_soc_get_value_enum_double(struct snd_kcontrol
*kcontrol
,
228 struct snd_ctl_elem_value
*ucontrol
);
229 int snd_soc_put_value_enum_double(struct snd_kcontrol
*kcontrol
,
230 struct snd_ctl_elem_value
*ucontrol
);
231 int snd_soc_info_volsw(struct snd_kcontrol
*kcontrol
,
232 struct snd_ctl_elem_info
*uinfo
);
233 int snd_soc_info_volsw_ext(struct snd_kcontrol
*kcontrol
,
234 struct snd_ctl_elem_info
*uinfo
);
235 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
236 int snd_soc_get_volsw(struct snd_kcontrol
*kcontrol
,
237 struct snd_ctl_elem_value
*ucontrol
);
238 int snd_soc_put_volsw(struct snd_kcontrol
*kcontrol
,
239 struct snd_ctl_elem_value
*ucontrol
);
240 int snd_soc_info_volsw_2r(struct snd_kcontrol
*kcontrol
,
241 struct snd_ctl_elem_info
*uinfo
);
242 int snd_soc_get_volsw_2r(struct snd_kcontrol
*kcontrol
,
243 struct snd_ctl_elem_value
*ucontrol
);
244 int snd_soc_put_volsw_2r(struct snd_kcontrol
*kcontrol
,
245 struct snd_ctl_elem_value
*ucontrol
);
246 int snd_soc_info_volsw_s8(struct snd_kcontrol
*kcontrol
,
247 struct snd_ctl_elem_info
*uinfo
);
248 int snd_soc_get_volsw_s8(struct snd_kcontrol
*kcontrol
,
249 struct snd_ctl_elem_value
*ucontrol
);
250 int snd_soc_put_volsw_s8(struct snd_kcontrol
*kcontrol
,
251 struct snd_ctl_elem_value
*ucontrol
);
254 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
256 * @pin: name of the pin to update
257 * @mask: bits to check for in reported jack status
258 * @invert: if non-zero then pin is enabled when status is not reported
260 struct snd_soc_jack_pin
{
261 struct list_head list
;
267 struct snd_soc_jack
{
268 struct snd_jack
*jack
;
269 struct snd_soc_card
*card
;
270 struct list_head pins
;
274 /* SoC PCM stream information */
275 struct snd_soc_pcm_stream
{
277 u64 formats
; /* SNDRV_PCM_FMTBIT_* */
278 unsigned int rates
; /* SNDRV_PCM_RATE_* */
279 unsigned int rate_min
; /* min rate */
280 unsigned int rate_max
; /* max rate */
281 unsigned int channels_min
; /* min channels */
282 unsigned int channels_max
; /* max channels */
283 unsigned int active
:1; /* stream is in use */
288 int (*startup
)(struct snd_pcm_substream
*);
289 void (*shutdown
)(struct snd_pcm_substream
*);
290 int (*hw_params
)(struct snd_pcm_substream
*, struct snd_pcm_hw_params
*);
291 int (*hw_free
)(struct snd_pcm_substream
*);
292 int (*prepare
)(struct snd_pcm_substream
*);
293 int (*trigger
)(struct snd_pcm_substream
*, int);
296 /* SoC Audio Codec */
297 struct snd_soc_codec
{
299 struct module
*owner
;
303 struct list_head list
;
306 int (*set_bias_level
)(struct snd_soc_codec
*,
307 enum snd_soc_bias_level level
);
310 struct snd_card
*card
;
311 struct snd_ac97
*ac97
; /* for ad-hoc ac97 devices */
313 unsigned int pcm_devs
;
317 void *control_data
; /* codec control (i2c/3wire) data */
318 unsigned int (*read
)(struct snd_soc_codec
*, unsigned int);
319 int (*write
)(struct snd_soc_codec
*, unsigned int, unsigned int);
320 int (*display_register
)(struct snd_soc_codec
*, char *,
321 size_t, unsigned int);
325 short reg_cache_size
;
326 short reg_cache_step
;
330 struct list_head dapm_widgets
;
331 struct list_head dapm_paths
;
332 enum snd_soc_bias_level bias_level
;
333 enum snd_soc_bias_level suspend_bias_level
;
334 struct delayed_work delayed_work
;
337 struct snd_soc_dai
*dai
;
338 unsigned int num_dai
;
340 #ifdef CONFIG_DEBUG_FS
341 struct dentry
*debugfs_reg
;
342 struct dentry
*debugfs_pop_time
;
347 struct snd_soc_codec_device
{
348 int (*probe
)(struct platform_device
*pdev
);
349 int (*remove
)(struct platform_device
*pdev
);
350 int (*suspend
)(struct platform_device
*pdev
, pm_message_t state
);
351 int (*resume
)(struct platform_device
*pdev
);
354 /* SoC platform interface */
355 struct snd_soc_platform
{
357 struct list_head list
;
359 int (*probe
)(struct platform_device
*pdev
);
360 int (*remove
)(struct platform_device
*pdev
);
361 int (*suspend
)(struct snd_soc_dai
*dai
);
362 int (*resume
)(struct snd_soc_dai
*dai
);
364 /* pcm creation and destruction */
365 int (*pcm_new
)(struct snd_card
*, struct snd_soc_dai
*,
367 void (*pcm_free
)(struct snd_pcm
*);
369 /* platform stream ops */
370 struct snd_pcm_ops
*pcm_ops
;
373 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
374 struct snd_soc_dai_link
{
375 char *name
; /* Codec name */
376 char *stream_name
; /* Stream name */
379 struct snd_soc_dai
*codec_dai
;
380 struct snd_soc_dai
*cpu_dai
;
382 /* machine stream operations */
383 struct snd_soc_ops
*ops
;
385 /* codec/machine specific init - e.g. add machine controls */
386 int (*init
)(struct snd_soc_codec
*codec
);
393 struct snd_soc_card
{
397 struct list_head list
;
401 int (*probe
)(struct platform_device
*pdev
);
402 int (*remove
)(struct platform_device
*pdev
);
404 /* the pre and post PM functions are used to do any PM work before and
405 * after the codec and DAI's do any PM work. */
406 int (*suspend_pre
)(struct platform_device
*pdev
, pm_message_t state
);
407 int (*suspend_post
)(struct platform_device
*pdev
, pm_message_t state
);
408 int (*resume_pre
)(struct platform_device
*pdev
);
409 int (*resume_post
)(struct platform_device
*pdev
);
412 int (*set_bias_level
)(struct snd_soc_card
*,
413 enum snd_soc_bias_level level
);
415 /* CPU <--> Codec DAI links */
416 struct snd_soc_dai_link
*dai_link
;
419 struct snd_soc_device
*socdev
;
421 struct snd_soc_platform
*platform
;
422 struct delayed_work delayed_work
;
423 struct work_struct deferred_resume_work
;
426 /* SoC Device - the audio subsystem */
427 struct snd_soc_device
{
429 struct snd_soc_card
*card
;
430 struct snd_soc_codec
*codec
;
431 struct snd_soc_codec_device
*codec_dev
;
435 /* runtime channel data */
436 struct snd_soc_pcm_runtime
{
437 struct snd_soc_dai_link
*dai
;
438 struct snd_soc_device
*socdev
;
442 struct soc_mixer_control
{
444 unsigned int reg
, rreg
, shift
, rshift
, invert
;
447 /* enumerated kcontrol */
451 unsigned char shift_l
;
452 unsigned char shift_r
;
456 const unsigned int *values
;
460 #include <sound/soc-dai.h>