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)
208 * @ON: Bias is fully on for audio playback and capture operations.
209 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
210 * stream start and stop operations.
211 * @STANDBY: Low power standby state when no playback/capture operations are
212 * in progress. NOTE: The transition time between STANDBY and ON
213 * should be as fast as possible and no longer than 10ms.
214 * @OFF: Power Off. No restrictions on transition times.
216 enum snd_soc_bias_level {
218 SND_SOC_BIAS_STANDBY,
219 SND_SOC_BIAS_PREPARE,
225 struct snd_soc_pcm_stream;
227 struct snd_soc_pcm_runtime;
229 struct snd_soc_dai_driver;
230 struct snd_soc_platform;
231 struct snd_soc_dai_link;
232 struct snd_soc_platform_driver;
233 struct snd_soc_codec;
234 struct snd_soc_codec_driver;
237 struct snd_soc_jack_pin;
238 struct snd_soc_cache_ops;
239 #include <sound/soc-dapm.h>
241 #ifdef CONFIG_GPIOLIB
242 struct snd_soc_jack_gpio;
245 typedef int (*hw_write_t)(void *,const char* ,int);
247 extern struct snd_ac97_bus_ops soc_ac97_ops;
249 enum snd_soc_control_type {
255 enum snd_soc_compress_type {
256 SND_SOC_FLAT_COMPRESSION = 1,
257 SND_SOC_LZO_COMPRESSION,
258 SND_SOC_RBTREE_COMPRESSION
261 int snd_soc_register_card(struct snd_soc_card *card);
262 int snd_soc_unregister_card(struct snd_soc_card *card);
263 int snd_soc_register_platform(struct device *dev,
264 struct snd_soc_platform_driver *platform_drv);
265 void snd_soc_unregister_platform(struct device *dev);
266 int snd_soc_register_codec(struct device *dev,
267 const struct snd_soc_codec_driver *codec_drv,
268 struct snd_soc_dai_driver *dai_drv, int num_dai);
269 void snd_soc_unregister_codec(struct device *dev);
270 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
271 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
272 int addr_bits, int data_bits,
273 enum snd_soc_control_type control);
274 int snd_soc_cache_sync(struct snd_soc_codec *codec);
275 int snd_soc_cache_init(struct snd_soc_codec *codec);
276 int snd_soc_cache_exit(struct snd_soc_codec *codec);
277 int snd_soc_cache_write(struct snd_soc_codec *codec,
278 unsigned int reg, unsigned int value);
279 int snd_soc_cache_read(struct snd_soc_codec *codec,
280 unsigned int reg, unsigned int *value);
281 int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
283 int snd_soc_default_readable_register(struct snd_soc_codec *codec,
286 /* Utility functions to get clock rates from various things */
287 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
288 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
289 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
290 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
292 /* set runtime hw params */
293 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
294 const struct snd_pcm_hardware *hw);
297 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
298 struct snd_soc_jack *jack);
299 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
300 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
301 struct snd_soc_jack_pin *pins);
302 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
303 struct notifier_block *nb);
304 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
305 struct notifier_block *nb);
306 #ifdef CONFIG_GPIOLIB
307 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
308 struct snd_soc_jack_gpio *gpios);
309 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
310 struct snd_soc_jack_gpio *gpios);
313 /* codec register bit access */
314 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
315 unsigned int mask, unsigned int value);
316 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
317 unsigned short reg, unsigned int mask,
319 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
320 unsigned int mask, unsigned int value);
322 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
323 struct snd_ac97_bus_ops *ops, int num);
324 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
329 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
330 void *data, char *long_name);
331 int snd_soc_add_controls(struct snd_soc_codec *codec,
332 const struct snd_kcontrol_new *controls, int num_controls);
333 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
334 struct snd_ctl_elem_info *uinfo);
335 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
336 struct snd_ctl_elem_info *uinfo);
337 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
338 struct snd_ctl_elem_value *ucontrol);
339 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
340 struct snd_ctl_elem_value *ucontrol);
341 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
342 struct snd_ctl_elem_value *ucontrol);
343 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
344 struct snd_ctl_elem_value *ucontrol);
345 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
346 struct snd_ctl_elem_info *uinfo);
347 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
348 struct snd_ctl_elem_info *uinfo);
349 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
350 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
351 struct snd_ctl_elem_value *ucontrol);
352 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
353 struct snd_ctl_elem_value *ucontrol);
354 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
355 struct snd_ctl_elem_info *uinfo);
356 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
357 struct snd_ctl_elem_value *ucontrol);
358 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
359 struct snd_ctl_elem_value *ucontrol);
360 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
361 struct snd_ctl_elem_info *uinfo);
362 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
363 struct snd_ctl_elem_value *ucontrol);
364 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
365 struct snd_ctl_elem_value *ucontrol);
366 int snd_soc_limit_volume(struct snd_soc_codec *codec,
367 const char *name, int max);
368 int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
369 struct snd_ctl_elem_info *uinfo);
370 int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
371 struct snd_ctl_elem_value *ucontrol);
372 int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
373 struct snd_ctl_elem_value *ucontrol);
376 * struct snd_soc_reg_access - Describes whether a given register is
377 * readable, writable or volatile.
379 * @reg: the register number
380 * @read: whether this register is readable
381 * @write: whether this register is writable
382 * @vol: whether this register is volatile
384 struct snd_soc_reg_access {
392 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
394 * @pin: name of the pin to update
395 * @mask: bits to check for in reported jack status
396 * @invert: if non-zero then pin is enabled when status is not reported
398 struct snd_soc_jack_pin {
399 struct list_head list;
406 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
410 * @report: value to report when jack detected
411 * @invert: report presence in low state
412 * @debouce_time: debouce time in ms
414 #ifdef CONFIG_GPIOLIB
415 struct snd_soc_jack_gpio {
421 struct snd_soc_jack *jack;
422 struct delayed_work work;
424 int (*jack_status_check)(void);
428 struct snd_soc_jack {
429 struct snd_jack *jack;
430 struct snd_soc_codec *codec;
431 struct list_head pins;
433 struct blocking_notifier_head notifier;
436 /* SoC PCM stream information */
437 struct snd_soc_pcm_stream {
438 const char *stream_name;
439 u64 formats; /* SNDRV_PCM_FMTBIT_* */
440 unsigned int rates; /* SNDRV_PCM_RATE_* */
441 unsigned int rate_min; /* min rate */
442 unsigned int rate_max; /* max rate */
443 unsigned int channels_min; /* min channels */
444 unsigned int channels_max; /* max channels */
449 int (*startup)(struct snd_pcm_substream *);
450 void (*shutdown)(struct snd_pcm_substream *);
451 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
452 int (*hw_free)(struct snd_pcm_substream *);
453 int (*prepare)(struct snd_pcm_substream *);
454 int (*trigger)(struct snd_pcm_substream *, int);
458 struct snd_soc_cache_ops {
460 enum snd_soc_compress_type id;
461 int (*init)(struct snd_soc_codec *codec);
462 int (*exit)(struct snd_soc_codec *codec);
463 int (*read)(struct snd_soc_codec *codec, unsigned int reg,
464 unsigned int *value);
465 int (*write)(struct snd_soc_codec *codec, unsigned int reg,
467 int (*sync)(struct snd_soc_codec *codec);
470 /* SoC Audio Codec device */
471 struct snd_soc_codec {
473 const char *name_prefix;
476 const struct snd_soc_codec_driver *driver;
479 struct snd_soc_card *card;
480 struct list_head list;
481 struct list_head card_list;
483 enum snd_soc_compress_type compress_type;
484 size_t reg_size; /* reg_cache_size * reg_word_size */
485 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
486 int (*readable_register)(struct snd_soc_codec *, unsigned int);
489 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
491 unsigned int cache_only:1; /* Suppress writes to hardware */
492 unsigned int cache_sync:1; /* Cache needs to be synced to hardware */
493 unsigned int suspended:1; /* Codec is in suspend PM state */
494 unsigned int probed:1; /* Codec has been probed */
495 unsigned int ac97_registered:1; /* Codec has been AC97 registered */
496 unsigned int ac97_created:1; /* Codec has been created by SoC */
497 unsigned int sysfs_registered:1; /* codec has been sysfs registered */
498 unsigned int cache_init:1; /* codec cache has been initialized */
501 void *control_data; /* codec control (i2c/3wire) data */
503 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
504 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
505 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
507 const void *reg_def_copy;
508 const struct snd_soc_cache_ops *cache_ops;
509 struct mutex cache_rw_mutex;
512 struct snd_soc_dapm_context dapm;
514 #ifdef CONFIG_DEBUG_FS
515 struct dentry *debugfs_codec_root;
516 struct dentry *debugfs_reg;
517 struct dentry *debugfs_dapm;
522 struct snd_soc_codec_driver {
525 int (*probe)(struct snd_soc_codec *);
526 int (*remove)(struct snd_soc_codec *);
527 int (*suspend)(struct snd_soc_codec *,
529 int (*resume)(struct snd_soc_codec *);
532 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
533 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
534 int (*display_register)(struct snd_soc_codec *, char *,
535 size_t, unsigned int);
536 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
537 int (*readable_register)(struct snd_soc_codec *, unsigned int);
538 short reg_cache_size;
539 short reg_cache_step;
541 const void *reg_cache_default;
542 short reg_access_size;
543 const struct snd_soc_reg_access *reg_access_default;
544 enum snd_soc_compress_type compress_type;
546 /* codec bias level */
547 int (*set_bias_level)(struct snd_soc_codec *,
548 enum snd_soc_bias_level level);
551 /* SoC platform interface */
552 struct snd_soc_platform_driver {
554 int (*probe)(struct snd_soc_platform *);
555 int (*remove)(struct snd_soc_platform *);
556 int (*suspend)(struct snd_soc_dai *dai);
557 int (*resume)(struct snd_soc_dai *dai);
559 /* pcm creation and destruction */
560 int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
562 void (*pcm_free)(struct snd_pcm *);
565 * For platform caused delay reporting.
568 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
569 struct snd_soc_dai *);
571 /* platform stream ops */
572 struct snd_pcm_ops *ops;
575 struct snd_soc_platform {
579 struct snd_soc_platform_driver *driver;
581 unsigned int suspended:1; /* platform is suspended */
582 unsigned int probed:1;
584 struct snd_soc_card *card;
585 struct list_head list;
586 struct list_head card_list;
589 struct snd_soc_dai_link {
590 /* config - must be set by machine driver */
591 const char *name; /* Codec name */
592 const char *stream_name; /* Stream name */
593 const char *codec_name; /* for multi-codec */
594 const char *platform_name; /* for multi-platform */
595 const char *cpu_dai_name;
596 const char *codec_dai_name;
598 /* Keep DAI active over suspend */
599 unsigned int ignore_suspend:1;
601 /* Symmetry requirements */
602 unsigned int symmetric_rates:1;
604 /* codec/machine specific init - e.g. add machine controls */
605 int (*init)(struct snd_soc_pcm_runtime *rtd);
607 /* machine stream operations */
608 struct snd_soc_ops *ops;
611 struct snd_soc_codec_conf {
612 const char *dev_name;
615 * optional map of kcontrol, widget and path name prefixes that are
616 * associated per device
618 const char *name_prefix;
621 * set this to the desired compression type if you want to
622 * override the one supplied in codec->driver->compress_type
624 enum snd_soc_compress_type compress_type;
627 struct snd_soc_aux_dev {
628 const char *name; /* Codec name */
629 const char *codec_name; /* for multi-codec */
631 /* codec/machine specific init - e.g. add machine controls */
632 int (*init)(struct snd_soc_dapm_context *dapm);
636 struct snd_soc_card {
639 struct snd_card *snd_card;
640 struct module *owner;
642 struct list_head list;
647 int (*probe)(struct platform_device *pdev);
648 int (*remove)(struct platform_device *pdev);
650 /* the pre and post PM functions are used to do any PM work before and
651 * after the codec and DAI's do any PM work. */
652 int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
653 int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
654 int (*resume_pre)(struct platform_device *pdev);
655 int (*resume_post)(struct platform_device *pdev);
658 int (*set_bias_level)(struct snd_soc_card *,
659 enum snd_soc_bias_level level);
660 int (*set_bias_level_post)(struct snd_soc_card *,
661 enum snd_soc_bias_level level);
665 /* CPU <--> Codec DAI links */
666 struct snd_soc_dai_link *dai_link;
668 struct snd_soc_pcm_runtime *rtd;
671 /* optional codec specific configuration */
672 struct snd_soc_codec_conf *codec_conf;
676 * optional auxiliary devices such as amplifiers or codecs with DAI
679 struct snd_soc_aux_dev *aux_dev;
681 struct snd_soc_pcm_runtime *rtd_aux;
684 struct work_struct deferred_resume_work;
686 /* lists of probed devices belonging to this card */
687 struct list_head codec_dev_list;
688 struct list_head platform_dev_list;
689 struct list_head dai_dev_list;
691 struct list_head widgets;
692 struct list_head paths;
693 struct list_head dapm_list;
695 #ifdef CONFIG_DEBUG_FS
696 struct dentry *debugfs_card_root;
697 struct dentry *debugfs_pop_time;
702 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
703 struct snd_soc_pcm_runtime {
705 struct snd_soc_card *card;
706 struct snd_soc_dai_link *dai_link;
708 unsigned int complete:1;
709 unsigned int dev_registered:1;
711 /* Symmetry data - only valid if symmetry is being enforced */
715 /* runtime devices */
717 struct snd_soc_codec *codec;
718 struct snd_soc_platform *platform;
719 struct snd_soc_dai *codec_dai;
720 struct snd_soc_dai *cpu_dai;
722 struct delayed_work delayed_work;
726 struct soc_mixer_control {
727 int min, max, platform_max;
728 unsigned int reg, rreg, shift, rshift, invert;
731 /* enumerated kcontrol */
735 unsigned char shift_l;
736 unsigned char shift_r;
740 const unsigned int *values;
745 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
746 unsigned int snd_soc_write(struct snd_soc_codec *codec,
747 unsigned int reg, unsigned int val);
749 /* device driver data */
751 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
754 dev_set_drvdata(codec->dev, data);
757 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
759 return dev_get_drvdata(codec->dev);
762 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
765 dev_set_drvdata(platform->dev, data);
768 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
770 return dev_get_drvdata(platform->dev);
773 static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
776 dev_set_drvdata(&rtd->dev, data);
779 static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
781 return dev_get_drvdata(&rtd->dev);
784 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
786 INIT_LIST_HEAD(&card->dai_dev_list);
787 INIT_LIST_HEAD(&card->codec_dev_list);
788 INIT_LIST_HEAD(&card->platform_dev_list);
789 INIT_LIST_HEAD(&card->widgets);
790 INIT_LIST_HEAD(&card->paths);
791 INIT_LIST_HEAD(&card->dapm_list);
794 #include <sound/soc-dai.h>
796 #ifdef CONFIG_DEBUG_FS
797 extern struct dentry *snd_soc_debugfs_root;