Loading...
1/*
2 * linux/sound/soc.h -- ALSA SoC Layer
3 *
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
7 *
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.
11 */
12
13#ifndef __LINUX_SND_SOC_H
14#define __LINUX_SND_SOC_H
15
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>
26
27/*
28 * Convenience kcontrol builders
29 */
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 }
172
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) \
183 {.reg = xreg_left, \
184 .rreg = xreg_right, .shift = xshift, \
185 .min = xmin, .max = xmax} }
186
187
188/*
189 * Simplified versions of above macros, declaring a struct and calculating
190 * ARRAY_SIZE internally
191 */
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)
204
205/*
206 * Component probe and remove ordering levels for components with runtime
207 * dependencies.
208 */
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
214
215/*
216 * Bias levels
217 *
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.
225 */
226enum snd_soc_bias_level {
227 SND_SOC_BIAS_OFF = 0,
228 SND_SOC_BIAS_STANDBY = 1,
229 SND_SOC_BIAS_PREPARE = 2,
230 SND_SOC_BIAS_ON = 3,
231};
232
233struct snd_jack;
234struct snd_soc_card;
235struct snd_soc_pcm_stream;
236struct snd_soc_ops;
237struct snd_soc_pcm_runtime;
238struct snd_soc_dai;
239struct snd_soc_dai_driver;
240struct snd_soc_platform;
241struct snd_soc_dai_link;
242struct snd_soc_platform_driver;
243struct snd_soc_codec;
244struct snd_soc_codec_driver;
245struct soc_enum;
246struct snd_soc_jack;
247struct snd_soc_jack_zone;
248struct snd_soc_jack_pin;
249struct snd_soc_cache_ops;
250#include <sound/soc-dapm.h>
251
252#ifdef CONFIG_GPIOLIB
253struct snd_soc_jack_gpio;
254#endif
255
256typedef int (*hw_write_t)(void *,const char* ,int);
257
258extern struct snd_ac97_bus_ops soc_ac97_ops;
259
260enum snd_soc_control_type {
261 SND_SOC_I2C = 1,
262 SND_SOC_SPI,
263};
264
265enum snd_soc_compress_type {
266 SND_SOC_FLAT_COMPRESSION = 1,
267 SND_SOC_LZO_COMPRESSION,
268 SND_SOC_RBTREE_COMPRESSION
269};
270
271enum snd_soc_pcm_subclass {
272 SND_SOC_PCM_CLASS_PCM = 0,
273 SND_SOC_PCM_CLASS_BE = 1,
274};
275
276int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
277 unsigned int freq, int dir);
278int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
279 unsigned int freq_in, unsigned int freq_out);
280
281int snd_soc_register_card(struct snd_soc_card *card);
282int snd_soc_unregister_card(struct snd_soc_card *card);
283int snd_soc_suspend(struct device *dev);
284int snd_soc_resume(struct device *dev);
285int snd_soc_poweroff(struct device *dev);
286int snd_soc_register_platform(struct device *dev,
287 struct snd_soc_platform_driver *platform_drv);
288void snd_soc_unregister_platform(struct device *dev);
289int 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);
292void snd_soc_unregister_codec(struct device *dev);
293int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
294 unsigned int reg);
295int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
296 unsigned int reg);
297int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
298 unsigned int reg);
299int 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);
302int snd_soc_cache_sync(struct snd_soc_codec *codec);
303int snd_soc_cache_init(struct snd_soc_codec *codec);
304int snd_soc_cache_exit(struct snd_soc_codec *codec);
305int snd_soc_cache_write(struct snd_soc_codec *codec,
306 unsigned int reg, unsigned int value);
307int snd_soc_cache_read(struct snd_soc_codec *codec,
308 unsigned int reg, unsigned int *value);
309int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
310 unsigned int reg);
311int snd_soc_default_readable_register(struct snd_soc_codec *codec,
312 unsigned int reg);
313int snd_soc_default_writable_register(struct snd_soc_codec *codec,
314 unsigned int reg);
315int snd_soc_platform_read(struct snd_soc_platform *platform,
316 unsigned int reg);
317int snd_soc_platform_write(struct snd_soc_platform *platform,
318 unsigned int reg, unsigned int val);
319
320/* Utility functions to get clock rates from various things */
321int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
322int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
323int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
324int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
325
326/* set runtime hw params */
327int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
328 const struct snd_pcm_hardware *hw);
329
330/* Jack reporting */
331int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
332 struct snd_soc_jack *jack);
333void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
334int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
335 struct snd_soc_jack_pin *pins);
336void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
337 struct notifier_block *nb);
338void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
339 struct notifier_block *nb);
340int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
341 struct snd_soc_jack_zone *zones);
342int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
343#ifdef CONFIG_GPIOLIB
344int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
345 struct snd_soc_jack_gpio *gpios);
346void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
347 struct snd_soc_jack_gpio *gpios);
348#endif
349
350/* codec register bit access */
351int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
352 unsigned int mask, unsigned int value);
353int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
354 unsigned short reg, unsigned int mask,
355 unsigned int value);
356int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
357 unsigned int mask, unsigned int value);
358
359int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
360 struct snd_ac97_bus_ops *ops, int num);
361void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
362
363/*
364 *Controls
365 */
366struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
367 void *data, char *long_name,
368 const char *prefix);
369int snd_soc_add_controls(struct snd_soc_codec *codec,
370 const struct snd_kcontrol_new *controls, int num_controls);
371int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
372 const struct snd_kcontrol_new *controls, int num_controls);
373int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
374 struct snd_ctl_elem_info *uinfo);
375int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
376 struct snd_ctl_elem_info *uinfo);
377int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
378 struct snd_ctl_elem_value *ucontrol);
379int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
380 struct snd_ctl_elem_value *ucontrol);
381int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
382 struct snd_ctl_elem_value *ucontrol);
383int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
384 struct snd_ctl_elem_value *ucontrol);
385int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
386 struct snd_ctl_elem_info *uinfo);
387int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
388 struct snd_ctl_elem_info *uinfo);
389#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
390int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
391 struct snd_ctl_elem_value *ucontrol);
392int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
393 struct snd_ctl_elem_value *ucontrol);
394int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
395 struct snd_ctl_elem_info *uinfo);
396int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
397 struct snd_ctl_elem_value *ucontrol);
398int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
399 struct snd_ctl_elem_value *ucontrol);
400int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
401 struct snd_ctl_elem_info *uinfo);
402int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
403 struct snd_ctl_elem_value *ucontrol);
404int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
405 struct snd_ctl_elem_value *ucontrol);
406int snd_soc_limit_volume(struct snd_soc_codec *codec,
407 const char *name, int max);
408int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
409 struct snd_ctl_elem_info *uinfo);
410int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
411 struct snd_ctl_elem_value *ucontrol);
412int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
413 struct snd_ctl_elem_value *ucontrol);
414
415/**
416 * struct snd_soc_reg_access - Describes whether a given register is
417 * readable, writable or volatile.
418 *
419 * @reg: the register number
420 * @read: whether this register is readable
421 * @write: whether this register is writable
422 * @vol: whether this register is volatile
423 */
424struct snd_soc_reg_access {
425 u16 reg;
426 u16 read;
427 u16 write;
428 u16 vol;
429};
430
431/**
432 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
433 *
434 * @pin: name of the pin to update
435 * @mask: bits to check for in reported jack status
436 * @invert: if non-zero then pin is enabled when status is not reported
437 */
438struct snd_soc_jack_pin {
439 struct list_head list;
440 const char *pin;
441 int mask;
442 bool invert;
443};
444
445/**
446 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
447 *
448 * @min_mv: start voltage in mv
449 * @max_mv: end voltage in mv
450 * @jack_type: type of jack that is expected for this voltage
451 * @debounce_time: debounce_time for jack, codec driver should wait for this
452 * duration before reading the adc for voltages
453 * @:list: list container
454 */
455struct snd_soc_jack_zone {
456 unsigned int min_mv;
457 unsigned int max_mv;
458 unsigned int jack_type;
459 unsigned int debounce_time;
460 struct list_head list;
461};
462
463/**
464 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
465 *
466 * @gpio: gpio number
467 * @name: gpio name
468 * @report: value to report when jack detected
469 * @invert: report presence in low state
470 * @debouce_time: debouce time in ms
471 * @wake: enable as wake source
472 * @jack_status_check: callback function which overrides the detection
473 * to provide more complex checks (eg, reading an
474 * ADC).
475 */
476#ifdef CONFIG_GPIOLIB
477struct snd_soc_jack_gpio {
478 unsigned int gpio;
479 const char *name;
480 int report;
481 int invert;
482 int debounce_time;
483 bool wake;
484
485 struct snd_soc_jack *jack;
486 struct delayed_work work;
487
488 int (*jack_status_check)(void);
489};
490#endif
491
492struct snd_soc_jack {
493 struct snd_jack *jack;
494 struct snd_soc_codec *codec;
495 struct list_head pins;
496 int status;
497 struct blocking_notifier_head notifier;
498 struct list_head jack_zones;
499};
500
501/* SoC PCM stream information */
502struct snd_soc_pcm_stream {
503 const char *stream_name;
504 u64 formats; /* SNDRV_PCM_FMTBIT_* */
505 unsigned int rates; /* SNDRV_PCM_RATE_* */
506 unsigned int rate_min; /* min rate */
507 unsigned int rate_max; /* max rate */
508 unsigned int channels_min; /* min channels */
509 unsigned int channels_max; /* max channels */
510};
511
512/* SoC audio ops */
513struct snd_soc_ops {
514 int (*startup)(struct snd_pcm_substream *);
515 void (*shutdown)(struct snd_pcm_substream *);
516 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
517 int (*hw_free)(struct snd_pcm_substream *);
518 int (*prepare)(struct snd_pcm_substream *);
519 int (*trigger)(struct snd_pcm_substream *, int);
520};
521
522/* SoC cache ops */
523struct snd_soc_cache_ops {
524 const char *name;
525 enum snd_soc_compress_type id;
526 int (*init)(struct snd_soc_codec *codec);
527 int (*exit)(struct snd_soc_codec *codec);
528 int (*read)(struct snd_soc_codec *codec, unsigned int reg,
529 unsigned int *value);
530 int (*write)(struct snd_soc_codec *codec, unsigned int reg,
531 unsigned int value);
532 int (*sync)(struct snd_soc_codec *codec);
533};
534
535/* SoC Audio Codec device */
536struct snd_soc_codec {
537 const char *name;
538 const char *name_prefix;
539 int id;
540 struct device *dev;
541 const struct snd_soc_codec_driver *driver;
542
543 struct mutex mutex;
544 struct snd_soc_card *card;
545 struct list_head list;
546 struct list_head card_list;
547 int num_dai;
548 enum snd_soc_compress_type compress_type;
549 size_t reg_size; /* reg_cache_size * reg_word_size */
550 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
551 int (*readable_register)(struct snd_soc_codec *, unsigned int);
552 int (*writable_register)(struct snd_soc_codec *, unsigned int);
553
554 /* runtime */
555 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
556 unsigned int active;
557 unsigned int cache_bypass:1; /* Suppress access to the cache */
558 unsigned int suspended:1; /* Codec is in suspend PM state */
559 unsigned int probed:1; /* Codec has been probed */
560 unsigned int ac97_registered:1; /* Codec has been AC97 registered */
561 unsigned int ac97_created:1; /* Codec has been created by SoC */
562 unsigned int sysfs_registered:1; /* codec has been sysfs registered */
563 unsigned int cache_init:1; /* codec cache has been initialized */
564 u32 cache_only; /* Suppress writes to hardware */
565 u32 cache_sync; /* Cache needs to be synced to hardware */
566
567 /* codec IO */
568 void *control_data; /* codec control (i2c/3wire) data */
569 enum snd_soc_control_type control_type;
570 hw_write_t hw_write;
571 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
572 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
573 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
574 int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
575 void *reg_cache;
576 const void *reg_def_copy;
577 const struct snd_soc_cache_ops *cache_ops;
578 struct mutex cache_rw_mutex;
579
580 /* dapm */
581 struct snd_soc_dapm_context dapm;
582
583#ifdef CONFIG_DEBUG_FS
584 struct dentry *debugfs_codec_root;
585 struct dentry *debugfs_reg;
586 struct dentry *debugfs_dapm;
587#endif
588};
589
590/* codec driver */
591struct snd_soc_codec_driver {
592
593 /* driver ops */
594 int (*probe)(struct snd_soc_codec *);
595 int (*remove)(struct snd_soc_codec *);
596 int (*suspend)(struct snd_soc_codec *,
597 pm_message_t state);
598 int (*resume)(struct snd_soc_codec *);
599
600 /* Default control and setup, added after probe() is run */
601 const struct snd_kcontrol_new *controls;
602 int num_controls;
603 const struct snd_soc_dapm_widget *dapm_widgets;
604 int num_dapm_widgets;
605 const struct snd_soc_dapm_route *dapm_routes;
606 int num_dapm_routes;
607
608 /* codec wide operations */
609 int (*set_sysclk)(struct snd_soc_codec *codec,
610 int clk_id, unsigned int freq, int dir);
611 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
612 unsigned int freq_in, unsigned int freq_out);
613
614 /* codec IO */
615 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
616 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
617 int (*display_register)(struct snd_soc_codec *, char *,
618 size_t, unsigned int);
619 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
620 int (*readable_register)(struct snd_soc_codec *, unsigned int);
621 int (*writable_register)(struct snd_soc_codec *, unsigned int);
622 short reg_cache_size;
623 short reg_cache_step;
624 short reg_word_size;
625 const void *reg_cache_default;
626 short reg_access_size;
627 const struct snd_soc_reg_access *reg_access_default;
628 enum snd_soc_compress_type compress_type;
629
630 /* codec bias level */
631 int (*set_bias_level)(struct snd_soc_codec *,
632 enum snd_soc_bias_level level);
633
634 void (*seq_notifier)(struct snd_soc_dapm_context *,
635 enum snd_soc_dapm_type, int);
636
637 /* probe ordering - for components with runtime dependencies */
638 int probe_order;
639 int remove_order;
640};
641
642/* SoC platform interface */
643struct snd_soc_platform_driver {
644
645 int (*probe)(struct snd_soc_platform *);
646 int (*remove)(struct snd_soc_platform *);
647 int (*suspend)(struct snd_soc_dai *dai);
648 int (*resume)(struct snd_soc_dai *dai);
649
650 /* pcm creation and destruction */
651 int (*pcm_new)(struct snd_soc_pcm_runtime *);
652 void (*pcm_free)(struct snd_pcm *);
653
654 /* Default control and setup, added after probe() is run */
655 const struct snd_kcontrol_new *controls;
656 int num_controls;
657 const struct snd_soc_dapm_widget *dapm_widgets;
658 int num_dapm_widgets;
659 const struct snd_soc_dapm_route *dapm_routes;
660 int num_dapm_routes;
661
662 /*
663 * For platform caused delay reporting.
664 * Optional.
665 */
666 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
667 struct snd_soc_dai *);
668
669 /* platform stream ops */
670 struct snd_pcm_ops *ops;
671
672 /* probe ordering - for components with runtime dependencies */
673 int probe_order;
674 int remove_order;
675
676 /* platform IO - used for platform DAPM */
677 unsigned int (*read)(struct snd_soc_platform *, unsigned int);
678 int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
679};
680
681struct snd_soc_platform {
682 const char *name;
683 int id;
684 struct device *dev;
685 struct snd_soc_platform_driver *driver;
686
687 unsigned int suspended:1; /* platform is suspended */
688 unsigned int probed:1;
689
690 struct snd_soc_card *card;
691 struct list_head list;
692 struct list_head card_list;
693
694 struct snd_soc_dapm_context dapm;
695};
696
697struct snd_soc_dai_link {
698 /* config - must be set by machine driver */
699 const char *name; /* Codec name */
700 const char *stream_name; /* Stream name */
701 const char *codec_name; /* for multi-codec */
702 const char *platform_name; /* for multi-platform */
703 const char *cpu_dai_name;
704 const char *codec_dai_name;
705
706 /* Keep DAI active over suspend */
707 unsigned int ignore_suspend:1;
708
709 /* Symmetry requirements */
710 unsigned int symmetric_rates:1;
711
712 /* codec/machine specific init - e.g. add machine controls */
713 int (*init)(struct snd_soc_pcm_runtime *rtd);
714
715 /* machine stream operations */
716 struct snd_soc_ops *ops;
717};
718
719struct snd_soc_codec_conf {
720 const char *dev_name;
721
722 /*
723 * optional map of kcontrol, widget and path name prefixes that are
724 * associated per device
725 */
726 const char *name_prefix;
727
728 /*
729 * set this to the desired compression type if you want to
730 * override the one supplied in codec->driver->compress_type
731 */
732 enum snd_soc_compress_type compress_type;
733};
734
735struct snd_soc_aux_dev {
736 const char *name; /* Codec name */
737 const char *codec_name; /* for multi-codec */
738
739 /* codec/machine specific init - e.g. add machine controls */
740 int (*init)(struct snd_soc_dapm_context *dapm);
741};
742
743/* SoC card */
744struct snd_soc_card {
745 const char *name;
746 const char *long_name;
747 const char *driver_name;
748 struct device *dev;
749 struct snd_card *snd_card;
750 struct module *owner;
751
752 struct list_head list;
753 struct mutex mutex;
754
755 bool instantiated;
756
757 int (*probe)(struct snd_soc_card *card);
758 int (*late_probe)(struct snd_soc_card *card);
759 int (*remove)(struct snd_soc_card *card);
760
761 /* the pre and post PM functions are used to do any PM work before and
762 * after the codec and DAI's do any PM work. */
763 int (*suspend_pre)(struct snd_soc_card *card);
764 int (*suspend_post)(struct snd_soc_card *card);
765 int (*resume_pre)(struct snd_soc_card *card);
766 int (*resume_post)(struct snd_soc_card *card);
767
768 /* callbacks */
769 int (*set_bias_level)(struct snd_soc_card *,
770 struct snd_soc_dapm_context *dapm,
771 enum snd_soc_bias_level level);
772 int (*set_bias_level_post)(struct snd_soc_card *,
773 struct snd_soc_dapm_context *dapm,
774 enum snd_soc_bias_level level);
775
776 long pmdown_time;
777
778 /* CPU <--> Codec DAI links */
779 struct snd_soc_dai_link *dai_link;
780 int num_links;
781 struct snd_soc_pcm_runtime *rtd;
782 int num_rtd;
783
784 /* optional codec specific configuration */
785 struct snd_soc_codec_conf *codec_conf;
786 int num_configs;
787
788 /*
789 * optional auxiliary devices such as amplifiers or codecs with DAI
790 * link unused
791 */
792 struct snd_soc_aux_dev *aux_dev;
793 int num_aux_devs;
794 struct snd_soc_pcm_runtime *rtd_aux;
795 int num_aux_rtd;
796
797 const struct snd_kcontrol_new *controls;
798 int num_controls;
799
800 /*
801 * Card-specific routes and widgets.
802 */
803 const struct snd_soc_dapm_widget *dapm_widgets;
804 int num_dapm_widgets;
805 const struct snd_soc_dapm_route *dapm_routes;
806 int num_dapm_routes;
807
808 struct work_struct deferred_resume_work;
809
810 /* lists of probed devices belonging to this card */
811 struct list_head codec_dev_list;
812 struct list_head platform_dev_list;
813 struct list_head dai_dev_list;
814
815 struct list_head widgets;
816 struct list_head paths;
817 struct list_head dapm_list;
818
819 /* Generic DAPM context for the card */
820 struct snd_soc_dapm_context dapm;
821
822#ifdef CONFIG_DEBUG_FS
823 struct dentry *debugfs_card_root;
824 struct dentry *debugfs_pop_time;
825#endif
826 u32 pop_time;
827
828 void *drvdata;
829};
830
831/* SoC machine DAI configuration, glues a codec and cpu DAI together */
832struct snd_soc_pcm_runtime {
833 struct device dev;
834 struct snd_soc_card *card;
835 struct snd_soc_dai_link *dai_link;
836 struct mutex pcm_mutex;
837 enum snd_soc_pcm_subclass pcm_subclass;
838 struct snd_pcm_ops ops;
839
840 unsigned int complete:1;
841 unsigned int dev_registered:1;
842
843 /* Symmetry data - only valid if symmetry is being enforced */
844 unsigned int rate;
845 long pmdown_time;
846
847 /* runtime devices */
848 struct snd_pcm *pcm;
849 struct snd_soc_codec *codec;
850 struct snd_soc_platform *platform;
851 struct snd_soc_dai *codec_dai;
852 struct snd_soc_dai *cpu_dai;
853
854 struct delayed_work delayed_work;
855};
856
857/* mixer control */
858struct soc_mixer_control {
859 int min, max, platform_max;
860 unsigned int reg, rreg, shift, rshift, invert;
861};
862
863/* enumerated kcontrol */
864struct soc_enum {
865 unsigned short reg;
866 unsigned short reg2;
867 unsigned char shift_l;
868 unsigned char shift_r;
869 unsigned int max;
870 unsigned int mask;
871 const char * const *texts;
872 const unsigned int *values;
873 void *dapm;
874};
875
876/* codec IO */
877unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
878unsigned int snd_soc_write(struct snd_soc_codec *codec,
879 unsigned int reg, unsigned int val);
880unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
881 unsigned int reg, const void *data, size_t len);
882
883/* device driver data */
884
885static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
886 void *data)
887{
888 card->drvdata = data;
889}
890
891static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
892{
893 return card->drvdata;
894}
895
896static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
897 void *data)
898{
899 dev_set_drvdata(codec->dev, data);
900}
901
902static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
903{
904 return dev_get_drvdata(codec->dev);
905}
906
907static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
908 void *data)
909{
910 dev_set_drvdata(platform->dev, data);
911}
912
913static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
914{
915 return dev_get_drvdata(platform->dev);
916}
917
918static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
919 void *data)
920{
921 dev_set_drvdata(&rtd->dev, data);
922}
923
924static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
925{
926 return dev_get_drvdata(&rtd->dev);
927}
928
929static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
930{
931 INIT_LIST_HEAD(&card->dai_dev_list);
932 INIT_LIST_HEAD(&card->codec_dev_list);
933 INIT_LIST_HEAD(&card->platform_dev_list);
934 INIT_LIST_HEAD(&card->widgets);
935 INIT_LIST_HEAD(&card->paths);
936 INIT_LIST_HEAD(&card->dapm_list);
937}
938
939int snd_soc_util_init(void);
940void snd_soc_util_exit(void);
941
942#include <sound/soc-dai.h>
943
944#ifdef CONFIG_DEBUG_FS
945extern struct dentry *snd_soc_debugfs_root;
946#endif
947
948extern const struct dev_pm_ops snd_soc_pm_ops;
949
950#endif
1/*
2 * linux/sound/soc.h -- ALSA SoC Layer
3 *
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
7 *
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.
11 */
12
13#ifndef __LINUX_SND_SOC_H
14#define __LINUX_SND_SOC_H
15
16#include <linux/of.h>
17#include <linux/platform_device.h>
18#include <linux/types.h>
19#include <linux/notifier.h>
20#include <linux/workqueue.h>
21#include <linux/interrupt.h>
22#include <linux/kernel.h>
23#include <linux/regmap.h>
24#include <linux/log2.h>
25#include <sound/core.h>
26#include <sound/pcm.h>
27#include <sound/compress_driver.h>
28#include <sound/control.h>
29#include <sound/ac97_codec.h>
30
31/*
32 * Convenience kcontrol builders
33 */
34#define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
35 ((unsigned long)&(struct soc_mixer_control) \
36 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
37 .rshift = shift_right, .max = xmax, .platform_max = xmax, \
38 .invert = xinvert, .autodisable = xautodisable})
39#define SOC_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, xsign_bit, xinvert, xautodisable) \
40 ((unsigned long)&(struct soc_mixer_control) \
41 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
42 .rshift = shift_right, .min = xmin, .max = xmax, .platform_max = xmax, \
43 .sign_bit = xsign_bit, .invert = xinvert, .autodisable = xautodisable})
44#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
45 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
46#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
47 ((unsigned long)&(struct soc_mixer_control) \
48 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
49#define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
50 ((unsigned long)&(struct soc_mixer_control) \
51 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
52 .max = xmax, .platform_max = xmax, .invert = xinvert})
53#define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
54 ((unsigned long)&(struct soc_mixer_control) \
55 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
56 .max = xmax, .min = xmin, .platform_max = xmax, .sign_bit = xsign_bit, \
57 .invert = xinvert})
58#define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
59 ((unsigned long)&(struct soc_mixer_control) \
60 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
61 .min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
62#define SOC_SINGLE(xname, reg, shift, max, invert) \
63{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
64 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
65 .put = snd_soc_put_volsw, \
66 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
67#define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
68{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
69 .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
70 .put = snd_soc_put_volsw_range, \
71 .private_value = (unsigned long)&(struct soc_mixer_control) \
72 {.reg = xreg, .rreg = xreg, .shift = xshift, \
73 .rshift = xshift, .min = xmin, .max = xmax, \
74 .platform_max = xmax, .invert = xinvert} }
75#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
76{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
77 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
78 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
79 .tlv.p = (tlv_array), \
80 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
81 .put = snd_soc_put_volsw, \
82 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
83#define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
84{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
85 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
86 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
87 .tlv.p = (tlv_array),\
88 .info = snd_soc_info_volsw_sx, \
89 .get = snd_soc_get_volsw_sx,\
90 .put = snd_soc_put_volsw_sx, \
91 .private_value = (unsigned long)&(struct soc_mixer_control) \
92 {.reg = xreg, .rreg = xreg, \
93 .shift = xshift, .rshift = xshift, \
94 .max = xmax, .min = xmin} }
95#define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
96{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
97 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
98 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
99 .tlv.p = (tlv_array), \
100 .info = snd_soc_info_volsw_range, \
101 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
102 .private_value = (unsigned long)&(struct soc_mixer_control) \
103 {.reg = xreg, .rreg = xreg, .shift = xshift, \
104 .rshift = xshift, .min = xmin, .max = xmax, \
105 .platform_max = xmax, .invert = xinvert} }
106#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
107{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
108 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
109 .put = snd_soc_put_volsw, \
110 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
111 max, invert, 0) }
112#define SOC_DOUBLE_STS(xname, reg, shift_left, shift_right, max, invert) \
113{ \
114 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
115 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
116 .access = SNDRV_CTL_ELEM_ACCESS_READ | \
117 SNDRV_CTL_ELEM_ACCESS_VOLATILE, \
118 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
119 max, invert, 0) }
120#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
121{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
122 .info = snd_soc_info_volsw, \
123 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
124 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
125 xmax, xinvert) }
126#define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
127 xmax, xinvert) \
128{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
129 .info = snd_soc_info_volsw_range, \
130 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
131 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
132 xshift, xmin, xmax, xinvert) }
133#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
134{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
135 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
136 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
137 .tlv.p = (tlv_array), \
138 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
139 .put = snd_soc_put_volsw, \
140 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
141 max, invert, 0) }
142#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
143{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
144 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
145 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
146 .tlv.p = (tlv_array), \
147 .info = snd_soc_info_volsw, \
148 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
149 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
150 xmax, xinvert) }
151#define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
152 xmax, xinvert, 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_range, \
158 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
159 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
160 xshift, xmin, xmax, xinvert) }
161#define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
162{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
163 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
164 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
165 .tlv.p = (tlv_array), \
166 .info = snd_soc_info_volsw_sx, \
167 .get = snd_soc_get_volsw_sx, \
168 .put = snd_soc_put_volsw_sx, \
169 .private_value = (unsigned long)&(struct soc_mixer_control) \
170 {.reg = xreg, .rreg = xrreg, \
171 .shift = xshift, .rshift = xshift, \
172 .max = xmax, .min = xmin} }
173#define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
174{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
175 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
176 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
177 .tlv.p = (tlv_array), \
178 .info = snd_soc_info_volsw, \
179 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
180 .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
181 xmin, xmax, xsign_bit, xinvert) }
182#define SOC_SINGLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
183{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
184 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
185 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
186 .tlv.p = (tlv_array), \
187 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
188 .put = snd_soc_put_volsw, \
189 .private_value = (unsigned long)&(struct soc_mixer_control) \
190 {.reg = xreg, .rreg = xreg, \
191 .min = xmin, .max = xmax, .platform_max = xmax, \
192 .sign_bit = 7,} }
193#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
194{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
195 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
196 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
197 .tlv.p = (tlv_array), \
198 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
199 .put = snd_soc_put_volsw, \
200 .private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
201#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
202{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
203 .items = xitems, .texts = xtexts, \
204 .mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
205#define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
206 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
207#define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
208{ .items = xitems, .texts = xtexts }
209#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
210{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
211 .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
212#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
213 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
214#define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
215{ .reg = xreg, .shift_l = xshift, .shift_r = xshift, \
216 .mask = xmask, .items = xitems, .texts = xtexts, \
217 .values = xvalues, .autodisable = 1}
218#define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
219 SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
220#define SOC_ENUM(xname, xenum) \
221{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
222 .info = snd_soc_info_enum_double, \
223 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
224 .private_value = (unsigned long)&xenum }
225#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
226 xhandler_get, xhandler_put) \
227{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
228 .info = snd_soc_info_volsw, \
229 .get = xhandler_get, .put = xhandler_put, \
230 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
231#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
232 xhandler_get, xhandler_put) \
233{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
234 .info = snd_soc_info_volsw, \
235 .get = xhandler_get, .put = xhandler_put, \
236 .private_value = \
237 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
238#define SOC_DOUBLE_R_EXT(xname, reg_left, reg_right, xshift, xmax, xinvert,\
239 xhandler_get, xhandler_put) \
240{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
241 .info = snd_soc_info_volsw, \
242 .get = xhandler_get, .put = xhandler_put, \
243 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
244 xmax, xinvert) }
245#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
246 xhandler_get, xhandler_put, tlv_array) \
247{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
248 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
249 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
250 .tlv.p = (tlv_array), \
251 .info = snd_soc_info_volsw, \
252 .get = xhandler_get, .put = xhandler_put, \
253 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
254#define SOC_SINGLE_RANGE_EXT_TLV(xname, xreg, xshift, xmin, xmax, xinvert, \
255 xhandler_get, xhandler_put, tlv_array) \
256{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
257 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
258 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
259 .tlv.p = (tlv_array), \
260 .info = snd_soc_info_volsw_range, \
261 .get = xhandler_get, .put = xhandler_put, \
262 .private_value = (unsigned long)&(struct soc_mixer_control) \
263 {.reg = xreg, .rreg = xreg, .shift = xshift, \
264 .rshift = xshift, .min = xmin, .max = xmax, \
265 .platform_max = xmax, .invert = xinvert} }
266#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
267 xhandler_get, xhandler_put, tlv_array) \
268{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
269 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
270 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
271 .tlv.p = (tlv_array), \
272 .info = snd_soc_info_volsw, \
273 .get = xhandler_get, .put = xhandler_put, \
274 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
275 xmax, xinvert, 0) }
276#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
277 xhandler_get, xhandler_put, tlv_array) \
278{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
279 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
280 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
281 .tlv.p = (tlv_array), \
282 .info = snd_soc_info_volsw, \
283 .get = xhandler_get, .put = xhandler_put, \
284 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
285 xmax, xinvert) }
286#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
287{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
288 .info = snd_soc_info_bool_ext, \
289 .get = xhandler_get, .put = xhandler_put, \
290 .private_value = xdata }
291#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
292{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
293 .info = snd_soc_info_enum_double, \
294 .get = xhandler_get, .put = xhandler_put, \
295 .private_value = (unsigned long)&xenum }
296#define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
297 SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
298
299#define SND_SOC_BYTES(xname, xbase, xregs) \
300{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
301 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
302 .put = snd_soc_bytes_put, .private_value = \
303 ((unsigned long)&(struct soc_bytes) \
304 {.base = xbase, .num_regs = xregs }) }
305
306#define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \
307{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
308 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
309 .put = snd_soc_bytes_put, .private_value = \
310 ((unsigned long)&(struct soc_bytes) \
311 {.base = xbase, .num_regs = xregs, \
312 .mask = xmask }) }
313
314/*
315 * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead
316 */
317#define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
318{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
319 .info = snd_soc_bytes_info_ext, \
320 .get = xhandler_get, .put = xhandler_put, \
321 .private_value = (unsigned long)&(struct soc_bytes_ext) \
322 {.max = xcount} }
323#define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
324{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
325 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
326 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
327 .tlv.c = (snd_soc_bytes_tlv_callback), \
328 .info = snd_soc_bytes_info_ext, \
329 .private_value = (unsigned long)&(struct soc_bytes_ext) \
330 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
331#define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
332 xmin, xmax, xinvert) \
333{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
334 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
335 .put = snd_soc_put_xr_sx, \
336 .private_value = (unsigned long)&(struct soc_mreg_control) \
337 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
338 .invert = xinvert, .min = xmin, .max = xmax} }
339
340#define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
341 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
342 snd_soc_get_strobe, snd_soc_put_strobe)
343
344/*
345 * Simplified versions of above macros, declaring a struct and calculating
346 * ARRAY_SIZE internally
347 */
348#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
349 const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
350 ARRAY_SIZE(xtexts), xtexts)
351#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
352 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
353#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
354 const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
355#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
356 const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
357 ARRAY_SIZE(xtexts), xtexts, xvalues)
358#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
359 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
360
361#define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
362 const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
363 xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
364
365#define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
366 const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
367
368/*
369 * Component probe and remove ordering levels for components with runtime
370 * dependencies.
371 */
372#define SND_SOC_COMP_ORDER_FIRST -2
373#define SND_SOC_COMP_ORDER_EARLY -1
374#define SND_SOC_COMP_ORDER_NORMAL 0
375#define SND_SOC_COMP_ORDER_LATE 1
376#define SND_SOC_COMP_ORDER_LAST 2
377
378/*
379 * Bias levels
380 *
381 * @ON: Bias is fully on for audio playback and capture operations.
382 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
383 * stream start and stop operations.
384 * @STANDBY: Low power standby state when no playback/capture operations are
385 * in progress. NOTE: The transition time between STANDBY and ON
386 * should be as fast as possible and no longer than 10ms.
387 * @OFF: Power Off. No restrictions on transition times.
388 */
389enum snd_soc_bias_level {
390 SND_SOC_BIAS_OFF = 0,
391 SND_SOC_BIAS_STANDBY = 1,
392 SND_SOC_BIAS_PREPARE = 2,
393 SND_SOC_BIAS_ON = 3,
394};
395
396struct device_node;
397struct snd_jack;
398struct snd_soc_card;
399struct snd_soc_pcm_stream;
400struct snd_soc_ops;
401struct snd_soc_pcm_runtime;
402struct snd_soc_dai;
403struct snd_soc_dai_driver;
404struct snd_soc_platform;
405struct snd_soc_dai_link;
406struct snd_soc_platform_driver;
407struct snd_soc_codec;
408struct snd_soc_codec_driver;
409struct snd_soc_component;
410struct snd_soc_component_driver;
411struct soc_enum;
412struct snd_soc_jack;
413struct snd_soc_jack_zone;
414struct snd_soc_jack_pin;
415#include <sound/soc-dapm.h>
416#include <sound/soc-dpcm.h>
417#include <sound/soc-topology.h>
418
419struct snd_soc_jack_gpio;
420
421typedef int (*hw_write_t)(void *,const char* ,int);
422
423enum snd_soc_pcm_subclass {
424 SND_SOC_PCM_CLASS_PCM = 0,
425 SND_SOC_PCM_CLASS_BE = 1,
426};
427
428enum snd_soc_card_subclass {
429 SND_SOC_CARD_CLASS_INIT = 0,
430 SND_SOC_CARD_CLASS_RUNTIME = 1,
431};
432
433int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
434 int source, unsigned int freq, int dir);
435int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
436 unsigned int freq_in, unsigned int freq_out);
437
438int snd_soc_register_card(struct snd_soc_card *card);
439int snd_soc_unregister_card(struct snd_soc_card *card);
440int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
441#ifdef CONFIG_PM_SLEEP
442int snd_soc_suspend(struct device *dev);
443int snd_soc_resume(struct device *dev);
444#else
445static inline int snd_soc_suspend(struct device *dev)
446{
447 return 0;
448}
449
450static inline int snd_soc_resume(struct device *dev)
451{
452 return 0;
453}
454#endif
455int snd_soc_poweroff(struct device *dev);
456int snd_soc_register_platform(struct device *dev,
457 const struct snd_soc_platform_driver *platform_drv);
458int devm_snd_soc_register_platform(struct device *dev,
459 const struct snd_soc_platform_driver *platform_drv);
460void snd_soc_unregister_platform(struct device *dev);
461int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
462 const struct snd_soc_platform_driver *platform_drv);
463void snd_soc_remove_platform(struct snd_soc_platform *platform);
464struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
465int snd_soc_register_codec(struct device *dev,
466 const struct snd_soc_codec_driver *codec_drv,
467 struct snd_soc_dai_driver *dai_drv, int num_dai);
468void snd_soc_unregister_codec(struct device *dev);
469int snd_soc_register_component(struct device *dev,
470 const struct snd_soc_component_driver *cmpnt_drv,
471 struct snd_soc_dai_driver *dai_drv, int num_dai);
472int devm_snd_soc_register_component(struct device *dev,
473 const struct snd_soc_component_driver *cmpnt_drv,
474 struct snd_soc_dai_driver *dai_drv, int num_dai);
475void snd_soc_unregister_component(struct device *dev);
476int snd_soc_cache_init(struct snd_soc_codec *codec);
477int snd_soc_cache_exit(struct snd_soc_codec *codec);
478
479int snd_soc_platform_read(struct snd_soc_platform *platform,
480 unsigned int reg);
481int snd_soc_platform_write(struct snd_soc_platform *platform,
482 unsigned int reg, unsigned int val);
483int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
484#ifdef CONFIG_SND_SOC_COMPRESS
485int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
486#endif
487
488struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
489 const char *dai_link, int stream);
490struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
491 const char *dai_link);
492
493bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
494void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
495void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
496
497int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
498 unsigned int dai_fmt);
499
500/* Utility functions to get clock rates from various things */
501int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
502int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
503int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
504int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
505
506/* set runtime hw params */
507int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
508 const struct snd_pcm_hardware *hw);
509
510int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
511 int cmd, struct snd_soc_platform *platform);
512
513int soc_dai_hw_params(struct snd_pcm_substream *substream,
514 struct snd_pcm_hw_params *params,
515 struct snd_soc_dai *dai);
516
517/* Jack reporting */
518int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
519 struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
520 unsigned int num_pins);
521
522void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
523int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
524 struct snd_soc_jack_pin *pins);
525void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
526 struct notifier_block *nb);
527void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
528 struct notifier_block *nb);
529int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
530 struct snd_soc_jack_zone *zones);
531int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
532#ifdef CONFIG_GPIOLIB
533int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
534 struct snd_soc_jack_gpio *gpios);
535int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
536 struct snd_soc_jack *jack,
537 int count, struct snd_soc_jack_gpio *gpios);
538void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
539 struct snd_soc_jack_gpio *gpios);
540#else
541static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
542 struct snd_soc_jack_gpio *gpios)
543{
544 return 0;
545}
546
547static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
548 struct snd_soc_jack *jack,
549 int count,
550 struct snd_soc_jack_gpio *gpios)
551{
552 return 0;
553}
554
555static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
556 struct snd_soc_jack_gpio *gpios)
557{
558}
559#endif
560
561/* codec register bit access */
562int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg,
563 unsigned int mask, unsigned int value);
564int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
565 unsigned int reg, unsigned int mask,
566 unsigned int value);
567int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg,
568 unsigned int mask, unsigned int value);
569
570#ifdef CONFIG_SND_SOC_AC97_BUS
571struct snd_ac97 *snd_soc_alloc_ac97_codec(struct snd_soc_codec *codec);
572struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
573 unsigned int id, unsigned int id_mask);
574void snd_soc_free_ac97_codec(struct snd_ac97 *ac97);
575
576int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
577int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
578 struct platform_device *pdev);
579
580extern struct snd_ac97_bus_ops *soc_ac97_ops;
581#else
582static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
583 struct platform_device *pdev)
584{
585 return 0;
586}
587
588static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
589{
590 return 0;
591}
592#endif
593
594/*
595 *Controls
596 */
597struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
598 void *data, const char *long_name,
599 const char *prefix);
600struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
601 const char *name);
602int snd_soc_add_component_controls(struct snd_soc_component *component,
603 const struct snd_kcontrol_new *controls, unsigned int num_controls);
604int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
605 const struct snd_kcontrol_new *controls, unsigned int num_controls);
606int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
607 const struct snd_kcontrol_new *controls, unsigned int num_controls);
608int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
609 const struct snd_kcontrol_new *controls, int num_controls);
610int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
611 const struct snd_kcontrol_new *controls, int num_controls);
612int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
613 struct snd_ctl_elem_info *uinfo);
614int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
615 struct snd_ctl_elem_value *ucontrol);
616int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
617 struct snd_ctl_elem_value *ucontrol);
618int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
619 struct snd_ctl_elem_info *uinfo);
620int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
621 struct snd_ctl_elem_info *uinfo);
622#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
623int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
624 struct snd_ctl_elem_value *ucontrol);
625int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
626 struct snd_ctl_elem_value *ucontrol);
627#define snd_soc_get_volsw_2r snd_soc_get_volsw
628#define snd_soc_put_volsw_2r snd_soc_put_volsw
629int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
630 struct snd_ctl_elem_value *ucontrol);
631int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
632 struct snd_ctl_elem_value *ucontrol);
633int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
634 struct snd_ctl_elem_info *uinfo);
635int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
636 struct snd_ctl_elem_value *ucontrol);
637int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
638 struct snd_ctl_elem_value *ucontrol);
639int snd_soc_limit_volume(struct snd_soc_card *card,
640 const char *name, int max);
641int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
642 struct snd_ctl_elem_info *uinfo);
643int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
644 struct snd_ctl_elem_value *ucontrol);
645int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
646 struct snd_ctl_elem_value *ucontrol);
647int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
648 struct snd_ctl_elem_info *ucontrol);
649int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
650 unsigned int size, unsigned int __user *tlv);
651int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
652 struct snd_ctl_elem_info *uinfo);
653int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
654 struct snd_ctl_elem_value *ucontrol);
655int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
656 struct snd_ctl_elem_value *ucontrol);
657int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
658 struct snd_ctl_elem_value *ucontrol);
659int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
660 struct snd_ctl_elem_value *ucontrol);
661
662/**
663 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
664 *
665 * @pin: name of the pin to update
666 * @mask: bits to check for in reported jack status
667 * @invert: if non-zero then pin is enabled when status is not reported
668 * @list: internal list entry
669 */
670struct snd_soc_jack_pin {
671 struct list_head list;
672 const char *pin;
673 int mask;
674 bool invert;
675};
676
677/**
678 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
679 *
680 * @min_mv: start voltage in mv
681 * @max_mv: end voltage in mv
682 * @jack_type: type of jack that is expected for this voltage
683 * @debounce_time: debounce_time for jack, codec driver should wait for this
684 * duration before reading the adc for voltages
685 * @list: internal list entry
686 */
687struct snd_soc_jack_zone {
688 unsigned int min_mv;
689 unsigned int max_mv;
690 unsigned int jack_type;
691 unsigned int debounce_time;
692 struct list_head list;
693};
694
695/**
696 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
697 *
698 * @gpio: legacy gpio number
699 * @idx: gpio descriptor index within the function of the GPIO
700 * consumer device
701 * @gpiod_dev: GPIO consumer device
702 * @name: gpio name. Also as connection ID for the GPIO consumer
703 * device function name lookup
704 * @report: value to report when jack detected
705 * @invert: report presence in low state
706 * @debounce_time: debounce time in ms
707 * @wake: enable as wake source
708 * @jack_status_check: callback function which overrides the detection
709 * to provide more complex checks (eg, reading an
710 * ADC).
711 */
712struct snd_soc_jack_gpio {
713 unsigned int gpio;
714 unsigned int idx;
715 struct device *gpiod_dev;
716 const char *name;
717 int report;
718 int invert;
719 int debounce_time;
720 bool wake;
721
722 /* private: */
723 struct snd_soc_jack *jack;
724 struct delayed_work work;
725 struct gpio_desc *desc;
726
727 void *data;
728 /* public: */
729 int (*jack_status_check)(void *data);
730};
731
732struct snd_soc_jack {
733 struct mutex mutex;
734 struct snd_jack *jack;
735 struct snd_soc_card *card;
736 struct list_head pins;
737 int status;
738 struct blocking_notifier_head notifier;
739 struct list_head jack_zones;
740};
741
742/* SoC PCM stream information */
743struct snd_soc_pcm_stream {
744 const char *stream_name;
745 u64 formats; /* SNDRV_PCM_FMTBIT_* */
746 unsigned int rates; /* SNDRV_PCM_RATE_* */
747 unsigned int rate_min; /* min rate */
748 unsigned int rate_max; /* max rate */
749 unsigned int channels_min; /* min channels */
750 unsigned int channels_max; /* max channels */
751 unsigned int sig_bits; /* number of bits of content */
752};
753
754/* SoC audio ops */
755struct snd_soc_ops {
756 int (*startup)(struct snd_pcm_substream *);
757 void (*shutdown)(struct snd_pcm_substream *);
758 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
759 int (*hw_free)(struct snd_pcm_substream *);
760 int (*prepare)(struct snd_pcm_substream *);
761 int (*trigger)(struct snd_pcm_substream *, int);
762};
763
764struct snd_soc_compr_ops {
765 int (*startup)(struct snd_compr_stream *);
766 void (*shutdown)(struct snd_compr_stream *);
767 int (*set_params)(struct snd_compr_stream *);
768 int (*trigger)(struct snd_compr_stream *);
769};
770
771/* component interface */
772struct snd_soc_component_driver {
773 const char *name;
774
775 /* Default control and setup, added after probe() is run */
776 const struct snd_kcontrol_new *controls;
777 unsigned int num_controls;
778 const struct snd_soc_dapm_widget *dapm_widgets;
779 unsigned int num_dapm_widgets;
780 const struct snd_soc_dapm_route *dapm_routes;
781 unsigned int num_dapm_routes;
782
783 int (*probe)(struct snd_soc_component *);
784 void (*remove)(struct snd_soc_component *);
785 int (*suspend)(struct snd_soc_component *);
786 int (*resume)(struct snd_soc_component *);
787
788 /* DT */
789 int (*of_xlate_dai_name)(struct snd_soc_component *component,
790 struct of_phandle_args *args,
791 const char **dai_name);
792 void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
793 int subseq);
794 int (*stream_event)(struct snd_soc_component *, int event);
795
796 /* probe ordering - for components with runtime dependencies */
797 int probe_order;
798 int remove_order;
799};
800
801struct snd_soc_component {
802 const char *name;
803 int id;
804 const char *name_prefix;
805 struct device *dev;
806 struct snd_soc_card *card;
807
808 unsigned int active;
809
810 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
811 unsigned int registered_as_component:1;
812 unsigned int auxiliary:1; /* for auxiliary component of the card */
813 unsigned int suspended:1; /* is in suspend PM state */
814
815 struct list_head list;
816 struct list_head card_aux_list; /* for auxiliary bound components */
817 struct list_head card_list;
818
819 struct snd_soc_dai_driver *dai_drv;
820 int num_dai;
821
822 const struct snd_soc_component_driver *driver;
823
824 struct list_head dai_list;
825
826 int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
827 int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
828
829 struct regmap *regmap;
830 int val_bytes;
831
832 struct mutex io_mutex;
833
834 /* attached dynamic objects */
835 struct list_head dobj_list;
836
837#ifdef CONFIG_DEBUG_FS
838 struct dentry *debugfs_root;
839#endif
840
841 /*
842 * DO NOT use any of the fields below in drivers, they are temporary and
843 * are going to be removed again soon. If you use them in driver code the
844 * driver will be marked as BROKEN when these fields are removed.
845 */
846
847 /* Don't use these, use snd_soc_component_get_dapm() */
848 struct snd_soc_dapm_context dapm;
849
850 const struct snd_kcontrol_new *controls;
851 unsigned int num_controls;
852 const struct snd_soc_dapm_widget *dapm_widgets;
853 unsigned int num_dapm_widgets;
854 const struct snd_soc_dapm_route *dapm_routes;
855 unsigned int num_dapm_routes;
856 struct snd_soc_codec *codec;
857
858 int (*probe)(struct snd_soc_component *);
859 void (*remove)(struct snd_soc_component *);
860 int (*suspend)(struct snd_soc_component *);
861 int (*resume)(struct snd_soc_component *);
862
863 /* machine specific init */
864 int (*init)(struct snd_soc_component *component);
865
866#ifdef CONFIG_DEBUG_FS
867 void (*init_debugfs)(struct snd_soc_component *component);
868 const char *debugfs_prefix;
869#endif
870};
871
872/* SoC Audio Codec device */
873struct snd_soc_codec {
874 struct device *dev;
875 const struct snd_soc_codec_driver *driver;
876
877 struct list_head list;
878
879 /* runtime */
880 unsigned int cache_bypass:1; /* Suppress access to the cache */
881 unsigned int cache_init:1; /* codec cache has been initialized */
882
883 /* codec IO */
884 void *control_data; /* codec control (i2c/3wire) data */
885 hw_write_t hw_write;
886 void *reg_cache;
887
888 /* component */
889 struct snd_soc_component component;
890
891#ifdef CONFIG_DEBUG_FS
892 struct dentry *debugfs_reg;
893#endif
894};
895
896/* codec driver */
897struct snd_soc_codec_driver {
898
899 /* driver ops */
900 int (*probe)(struct snd_soc_codec *);
901 int (*remove)(struct snd_soc_codec *);
902 int (*suspend)(struct snd_soc_codec *);
903 int (*resume)(struct snd_soc_codec *);
904 struct snd_soc_component_driver component_driver;
905
906 /* codec wide operations */
907 int (*set_sysclk)(struct snd_soc_codec *codec,
908 int clk_id, int source, unsigned int freq, int dir);
909 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
910 unsigned int freq_in, unsigned int freq_out);
911
912 /* codec IO */
913 struct regmap *(*get_regmap)(struct device *);
914 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
915 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
916 unsigned int reg_cache_size;
917 short reg_cache_step;
918 short reg_word_size;
919 const void *reg_cache_default;
920
921 /* codec bias level */
922 int (*set_bias_level)(struct snd_soc_codec *,
923 enum snd_soc_bias_level level);
924 bool idle_bias_off;
925 bool suspend_bias_off;
926
927 void (*seq_notifier)(struct snd_soc_dapm_context *,
928 enum snd_soc_dapm_type, int);
929
930 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */
931};
932
933/* SoC platform interface */
934struct snd_soc_platform_driver {
935
936 int (*probe)(struct snd_soc_platform *);
937 int (*remove)(struct snd_soc_platform *);
938 struct snd_soc_component_driver component_driver;
939
940 /* pcm creation and destruction */
941 int (*pcm_new)(struct snd_soc_pcm_runtime *);
942 void (*pcm_free)(struct snd_pcm *);
943
944 /*
945 * For platform caused delay reporting.
946 * Optional.
947 */
948 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
949 struct snd_soc_dai *);
950
951 /* platform stream pcm ops */
952 const struct snd_pcm_ops *ops;
953
954 /* platform stream compress ops */
955 const struct snd_compr_ops *compr_ops;
956
957 int (*bespoke_trigger)(struct snd_pcm_substream *, int);
958};
959
960struct snd_soc_dai_link_component {
961 const char *name;
962 struct device_node *of_node;
963 const char *dai_name;
964};
965
966struct snd_soc_platform {
967 struct device *dev;
968 const struct snd_soc_platform_driver *driver;
969
970 struct list_head list;
971
972 struct snd_soc_component component;
973};
974
975struct snd_soc_dai_link {
976 /* config - must be set by machine driver */
977 const char *name; /* Codec name */
978 const char *stream_name; /* Stream name */
979 /*
980 * You MAY specify the link's CPU-side device, either by device name,
981 * or by DT/OF node, but not both. If this information is omitted,
982 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
983 * must be globally unique. These fields are currently typically used
984 * only for codec to codec links, or systems using device tree.
985 */
986 const char *cpu_name;
987 struct device_node *cpu_of_node;
988 /*
989 * You MAY specify the DAI name of the CPU DAI. If this information is
990 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
991 * only, which only works well when that device exposes a single DAI.
992 */
993 const char *cpu_dai_name;
994 /*
995 * You MUST specify the link's codec, either by device name, or by
996 * DT/OF node, but not both.
997 */
998 const char *codec_name;
999 struct device_node *codec_of_node;
1000 /* You MUST specify the DAI name within the codec */
1001 const char *codec_dai_name;
1002
1003 struct snd_soc_dai_link_component *codecs;
1004 unsigned int num_codecs;
1005
1006 /*
1007 * You MAY specify the link's platform/PCM/DMA driver, either by
1008 * device name, or by DT/OF node, but not both. Some forms of link
1009 * do not need a platform.
1010 */
1011 const char *platform_name;
1012 struct device_node *platform_of_node;
1013 int id; /* optional ID for machine driver link identification */
1014
1015 const struct snd_soc_pcm_stream *params;
1016 unsigned int num_params;
1017
1018 unsigned int dai_fmt; /* format to set on init */
1019
1020 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
1021
1022 /* codec/machine specific init - e.g. add machine controls */
1023 int (*init)(struct snd_soc_pcm_runtime *rtd);
1024
1025 /* optional hw_params re-writing for BE and FE sync */
1026 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
1027 struct snd_pcm_hw_params *params);
1028
1029 /* machine stream operations */
1030 const struct snd_soc_ops *ops;
1031 const struct snd_soc_compr_ops *compr_ops;
1032
1033 /* Mark this pcm with non atomic ops */
1034 bool nonatomic;
1035
1036 /* For unidirectional dai links */
1037 unsigned int playback_only:1;
1038 unsigned int capture_only:1;
1039
1040 /* Keep DAI active over suspend */
1041 unsigned int ignore_suspend:1;
1042
1043 /* Symmetry requirements */
1044 unsigned int symmetric_rates:1;
1045 unsigned int symmetric_channels:1;
1046 unsigned int symmetric_samplebits:1;
1047
1048 /* Do not create a PCM for this DAI link (Backend link) */
1049 unsigned int no_pcm:1;
1050
1051 /* This DAI link can route to other DAI links at runtime (Frontend)*/
1052 unsigned int dynamic:1;
1053
1054 /* DPCM capture and Playback support */
1055 unsigned int dpcm_capture:1;
1056 unsigned int dpcm_playback:1;
1057
1058 /* DPCM used FE & BE merged format */
1059 unsigned int dpcm_merged_format:1;
1060
1061 /* pmdown_time is ignored at stop */
1062 unsigned int ignore_pmdown_time:1;
1063
1064 struct list_head list; /* DAI link list of the soc card */
1065 struct snd_soc_dobj dobj; /* For topology */
1066};
1067
1068struct snd_soc_codec_conf {
1069 /*
1070 * specify device either by device name, or by
1071 * DT/OF node, but not both.
1072 */
1073 const char *dev_name;
1074 struct device_node *of_node;
1075
1076 /*
1077 * optional map of kcontrol, widget and path name prefixes that are
1078 * associated per device
1079 */
1080 const char *name_prefix;
1081};
1082
1083struct snd_soc_aux_dev {
1084 const char *name; /* Codec name */
1085
1086 /*
1087 * specify multi-codec either by device name, or by
1088 * DT/OF node, but not both.
1089 */
1090 const char *codec_name;
1091 struct device_node *codec_of_node;
1092
1093 /* codec/machine specific init - e.g. add machine controls */
1094 int (*init)(struct snd_soc_component *component);
1095};
1096
1097/* SoC card */
1098struct snd_soc_card {
1099 const char *name;
1100 const char *long_name;
1101 const char *driver_name;
1102 struct device *dev;
1103 struct snd_card *snd_card;
1104 struct module *owner;
1105
1106 struct mutex mutex;
1107 struct mutex dapm_mutex;
1108
1109 bool instantiated;
1110
1111 int (*probe)(struct snd_soc_card *card);
1112 int (*late_probe)(struct snd_soc_card *card);
1113 int (*remove)(struct snd_soc_card *card);
1114
1115 /* the pre and post PM functions are used to do any PM work before and
1116 * after the codec and DAI's do any PM work. */
1117 int (*suspend_pre)(struct snd_soc_card *card);
1118 int (*suspend_post)(struct snd_soc_card *card);
1119 int (*resume_pre)(struct snd_soc_card *card);
1120 int (*resume_post)(struct snd_soc_card *card);
1121
1122 /* callbacks */
1123 int (*set_bias_level)(struct snd_soc_card *,
1124 struct snd_soc_dapm_context *dapm,
1125 enum snd_soc_bias_level level);
1126 int (*set_bias_level_post)(struct snd_soc_card *,
1127 struct snd_soc_dapm_context *dapm,
1128 enum snd_soc_bias_level level);
1129
1130 int (*add_dai_link)(struct snd_soc_card *,
1131 struct snd_soc_dai_link *link);
1132 void (*remove_dai_link)(struct snd_soc_card *,
1133 struct snd_soc_dai_link *link);
1134
1135 long pmdown_time;
1136
1137 /* CPU <--> Codec DAI links */
1138 struct snd_soc_dai_link *dai_link; /* predefined links only */
1139 int num_links; /* predefined links only */
1140 struct list_head dai_link_list; /* all links */
1141 int num_dai_links;
1142
1143 struct list_head rtd_list;
1144 int num_rtd;
1145
1146 /* optional codec specific configuration */
1147 struct snd_soc_codec_conf *codec_conf;
1148 int num_configs;
1149
1150 /*
1151 * optional auxiliary devices such as amplifiers or codecs with DAI
1152 * link unused
1153 */
1154 struct snd_soc_aux_dev *aux_dev;
1155 int num_aux_devs;
1156 struct list_head aux_comp_list;
1157
1158 const struct snd_kcontrol_new *controls;
1159 int num_controls;
1160
1161 /*
1162 * Card-specific routes and widgets.
1163 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1164 */
1165 const struct snd_soc_dapm_widget *dapm_widgets;
1166 int num_dapm_widgets;
1167 const struct snd_soc_dapm_route *dapm_routes;
1168 int num_dapm_routes;
1169 const struct snd_soc_dapm_widget *of_dapm_widgets;
1170 int num_of_dapm_widgets;
1171 const struct snd_soc_dapm_route *of_dapm_routes;
1172 int num_of_dapm_routes;
1173 bool fully_routed;
1174
1175 struct work_struct deferred_resume_work;
1176
1177 /* lists of probed devices belonging to this card */
1178 struct list_head component_dev_list;
1179
1180 struct list_head widgets;
1181 struct list_head paths;
1182 struct list_head dapm_list;
1183 struct list_head dapm_dirty;
1184
1185 /* attached dynamic objects */
1186 struct list_head dobj_list;
1187
1188 /* Generic DAPM context for the card */
1189 struct snd_soc_dapm_context dapm;
1190 struct snd_soc_dapm_stats dapm_stats;
1191 struct snd_soc_dapm_update *update;
1192
1193#ifdef CONFIG_DEBUG_FS
1194 struct dentry *debugfs_card_root;
1195 struct dentry *debugfs_pop_time;
1196#endif
1197 u32 pop_time;
1198
1199 void *drvdata;
1200};
1201
1202/* SoC machine DAI configuration, glues a codec and cpu DAI together */
1203struct snd_soc_pcm_runtime {
1204 struct device *dev;
1205 struct snd_soc_card *card;
1206 struct snd_soc_dai_link *dai_link;
1207 struct mutex pcm_mutex;
1208 enum snd_soc_pcm_subclass pcm_subclass;
1209 struct snd_pcm_ops ops;
1210
1211 /* Dynamic PCM BE runtime data */
1212 struct snd_soc_dpcm_runtime dpcm[2];
1213 int fe_compr;
1214
1215 long pmdown_time;
1216
1217 /* runtime devices */
1218 struct snd_pcm *pcm;
1219 struct snd_compr *compr;
1220 struct snd_soc_codec *codec;
1221 struct snd_soc_platform *platform;
1222 struct snd_soc_dai *codec_dai;
1223 struct snd_soc_dai *cpu_dai;
1224
1225 struct snd_soc_dai **codec_dais;
1226 unsigned int num_codecs;
1227
1228 struct delayed_work delayed_work;
1229#ifdef CONFIG_DEBUG_FS
1230 struct dentry *debugfs_dpcm_root;
1231 struct dentry *debugfs_dpcm_state;
1232#endif
1233
1234 unsigned int num; /* 0-based and monotonic increasing */
1235 struct list_head list; /* rtd list of the soc card */
1236
1237 /* bit field */
1238 unsigned int dev_registered:1;
1239 unsigned int pop_wait:1;
1240};
1241
1242/* mixer control */
1243struct soc_mixer_control {
1244 int min, max, platform_max;
1245 int reg, rreg;
1246 unsigned int shift, rshift;
1247 unsigned int sign_bit;
1248 unsigned int invert:1;
1249 unsigned int autodisable:1;
1250 struct snd_soc_dobj dobj;
1251};
1252
1253struct soc_bytes {
1254 int base;
1255 int num_regs;
1256 u32 mask;
1257};
1258
1259struct soc_bytes_ext {
1260 int max;
1261 struct snd_soc_dobj dobj;
1262
1263 /* used for TLV byte control */
1264 int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1265 unsigned int size);
1266 int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1267 unsigned int size);
1268};
1269
1270/* multi register control */
1271struct soc_mreg_control {
1272 long min, max;
1273 unsigned int regbase, regcount, nbits, invert;
1274};
1275
1276/* enumerated kcontrol */
1277struct soc_enum {
1278 int reg;
1279 unsigned char shift_l;
1280 unsigned char shift_r;
1281 unsigned int items;
1282 unsigned int mask;
1283 const char * const *texts;
1284 const unsigned int *values;
1285 unsigned int autodisable:1;
1286 struct snd_soc_dobj dobj;
1287};
1288
1289/**
1290 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1291 * @component: The component to cast to a CODEC
1292 *
1293 * This function must only be used on components that are known to be CODECs.
1294 * Otherwise the behavior is undefined.
1295 */
1296static inline struct snd_soc_codec *snd_soc_component_to_codec(
1297 struct snd_soc_component *component)
1298{
1299 return container_of(component, struct snd_soc_codec, component);
1300}
1301
1302/**
1303 * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1304 * @component: The component to cast to a platform
1305 *
1306 * This function must only be used on components that are known to be platforms.
1307 * Otherwise the behavior is undefined.
1308 */
1309static inline struct snd_soc_platform *snd_soc_component_to_platform(
1310 struct snd_soc_component *component)
1311{
1312 return container_of(component, struct snd_soc_platform, component);
1313}
1314
1315/**
1316 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1317 * embedded in
1318 * @dapm: The DAPM context to cast to the component
1319 *
1320 * This function must only be used on DAPM contexts that are known to be part of
1321 * a component (e.g. in a component driver). Otherwise the behavior is
1322 * undefined.
1323 */
1324static inline struct snd_soc_component *snd_soc_dapm_to_component(
1325 struct snd_soc_dapm_context *dapm)
1326{
1327 return container_of(dapm, struct snd_soc_component, dapm);
1328}
1329
1330/**
1331 * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1332 * @dapm: The DAPM context to cast to the CODEC
1333 *
1334 * This function must only be used on DAPM contexts that are known to be part of
1335 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1336 */
1337static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1338 struct snd_soc_dapm_context *dapm)
1339{
1340 return snd_soc_component_to_codec(snd_soc_dapm_to_component(dapm));
1341}
1342
1343/**
1344 * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1345 * embedded in
1346 * @dapm: The DAPM context to cast to the platform.
1347 *
1348 * This function must only be used on DAPM contexts that are known to be part of
1349 * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1350 */
1351static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1352 struct snd_soc_dapm_context *dapm)
1353{
1354 return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
1355}
1356
1357/**
1358 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1359 * component
1360 * @component: The component for which to get the DAPM context
1361 */
1362static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1363 struct snd_soc_component *component)
1364{
1365 return &component->dapm;
1366}
1367
1368/**
1369 * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC
1370 * @codec: The CODEC for which to get the DAPM context
1371 *
1372 * Note: Use this function instead of directly accessing the CODEC's dapm field
1373 */
1374static inline struct snd_soc_dapm_context *snd_soc_codec_get_dapm(
1375 struct snd_soc_codec *codec)
1376{
1377 return snd_soc_component_get_dapm(&codec->component);
1378}
1379
1380/**
1381 * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level
1382 * @codec: The CODEC for which to initialize the DAPM bias level
1383 * @level: The DAPM level to initialize to
1384 *
1385 * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level().
1386 */
1387static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec *codec,
1388 enum snd_soc_bias_level level)
1389{
1390 snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec), level);
1391}
1392
1393/**
1394 * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level
1395 * @codec: The CODEC for which to get the DAPM bias level
1396 *
1397 * Returns: The current DAPM bias level of the CODEC.
1398 */
1399static inline enum snd_soc_bias_level snd_soc_codec_get_bias_level(
1400 struct snd_soc_codec *codec)
1401{
1402 return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec));
1403}
1404
1405/**
1406 * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level
1407 * @codec: The CODEC for which to set the level
1408 * @level: The level to set to
1409 *
1410 * Forces the CODEC bias level to a specific state. See
1411 * snd_soc_dapm_force_bias_level().
1412 */
1413static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec *codec,
1414 enum snd_soc_bias_level level)
1415{
1416 return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec),
1417 level);
1418}
1419
1420/**
1421 * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1422 * @kcontrol: The kcontrol
1423 *
1424 * This function must only be used on DAPM contexts that are known to be part of
1425 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1426 */
1427static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(
1428 struct snd_kcontrol *kcontrol)
1429{
1430 return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol));
1431}
1432
1433/* codec IO */
1434unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1435int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1436 unsigned int val);
1437
1438/**
1439 * snd_soc_cache_sync() - Sync the register cache with the hardware
1440 * @codec: CODEC to sync
1441 *
1442 * Note: This function will call regcache_sync()
1443 */
1444static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1445{
1446 return regcache_sync(codec->component.regmap);
1447}
1448
1449/* component IO */
1450int snd_soc_component_read(struct snd_soc_component *component,
1451 unsigned int reg, unsigned int *val);
1452int snd_soc_component_write(struct snd_soc_component *component,
1453 unsigned int reg, unsigned int val);
1454int snd_soc_component_update_bits(struct snd_soc_component *component,
1455 unsigned int reg, unsigned int mask, unsigned int val);
1456int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1457 unsigned int reg, unsigned int mask, unsigned int val);
1458void snd_soc_component_async_complete(struct snd_soc_component *component);
1459int snd_soc_component_test_bits(struct snd_soc_component *component,
1460 unsigned int reg, unsigned int mask, unsigned int value);
1461
1462#ifdef CONFIG_REGMAP
1463
1464void snd_soc_component_init_regmap(struct snd_soc_component *component,
1465 struct regmap *regmap);
1466void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1467
1468/**
1469 * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1470 * @codec: The CODEC for which to initialize the regmap instance
1471 * @regmap: The regmap instance that should be used by the CODEC
1472 *
1473 * This function allows deferred assignment of the regmap instance that is
1474 * associated with the CODEC. Only use this if the regmap instance is not yet
1475 * ready when the CODEC is registered. The function must also be called before
1476 * the first IO attempt of the CODEC.
1477 */
1478static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1479 struct regmap *regmap)
1480{
1481 snd_soc_component_init_regmap(&codec->component, regmap);
1482}
1483
1484/**
1485 * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1486 * @codec: The CODEC for which to de-initialize the regmap instance
1487 *
1488 * Calls regmap_exit() on the regmap instance associated to the CODEC and
1489 * removes the regmap instance from the CODEC.
1490 *
1491 * This function should only be used if snd_soc_codec_init_regmap() was used to
1492 * initialize the regmap instance.
1493 */
1494static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1495{
1496 snd_soc_component_exit_regmap(&codec->component);
1497}
1498
1499#endif
1500
1501/* device driver data */
1502
1503static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1504 void *data)
1505{
1506 card->drvdata = data;
1507}
1508
1509static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1510{
1511 return card->drvdata;
1512}
1513
1514static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1515 void *data)
1516{
1517 dev_set_drvdata(c->dev, data);
1518}
1519
1520static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1521{
1522 return dev_get_drvdata(c->dev);
1523}
1524
1525static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1526 void *data)
1527{
1528 snd_soc_component_set_drvdata(&codec->component, data);
1529}
1530
1531static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1532{
1533 return snd_soc_component_get_drvdata(&codec->component);
1534}
1535
1536static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1537 void *data)
1538{
1539 snd_soc_component_set_drvdata(&platform->component, data);
1540}
1541
1542static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1543{
1544 return snd_soc_component_get_drvdata(&platform->component);
1545}
1546
1547static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1548{
1549 INIT_LIST_HEAD(&card->widgets);
1550 INIT_LIST_HEAD(&card->paths);
1551 INIT_LIST_HEAD(&card->dapm_list);
1552 INIT_LIST_HEAD(&card->aux_comp_list);
1553 INIT_LIST_HEAD(&card->component_dev_list);
1554}
1555
1556static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1557{
1558 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1559 return 0;
1560 /*
1561 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1562 * mc->reg != mc->rreg means that the control is
1563 * stereo (bits in one register or in two registers)
1564 */
1565 return 1;
1566}
1567
1568static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1569 unsigned int val)
1570{
1571 unsigned int i;
1572
1573 if (!e->values)
1574 return val;
1575
1576 for (i = 0; i < e->items; i++)
1577 if (val == e->values[i])
1578 return i;
1579
1580 return 0;
1581}
1582
1583static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1584 unsigned int item)
1585{
1586 if (!e->values)
1587 return item;
1588
1589 return e->values[item];
1590}
1591
1592static inline bool snd_soc_component_is_active(
1593 struct snd_soc_component *component)
1594{
1595 return component->active != 0;
1596}
1597
1598static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1599{
1600 return snd_soc_component_is_active(&codec->component);
1601}
1602
1603/**
1604 * snd_soc_kcontrol_component() - Returns the component that registered the
1605 * control
1606 * @kcontrol: The control for which to get the component
1607 *
1608 * Note: This function will work correctly if the control has been registered
1609 * for a component. Either with snd_soc_add_codec_controls() or
1610 * snd_soc_add_platform_controls() or via table based setup for either a
1611 * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1612 */
1613static inline struct snd_soc_component *snd_soc_kcontrol_component(
1614 struct snd_kcontrol *kcontrol)
1615{
1616 return snd_kcontrol_chip(kcontrol);
1617}
1618
1619/**
1620 * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1621 * @kcontrol: The control for which to get the CODEC
1622 *
1623 * Note: This function will only work correctly if the control has been
1624 * registered with snd_soc_add_codec_controls() or via table based setup of
1625 * snd_soc_codec_driver. Otherwise the behavior is undefined.
1626 */
1627static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1628 struct snd_kcontrol *kcontrol)
1629{
1630 return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1631}
1632
1633/**
1634 * snd_soc_kcontrol_platform() - Returns the platform that registered the control
1635 * @kcontrol: The control for which to get the platform
1636 *
1637 * Note: This function will only work correctly if the control has been
1638 * registered with snd_soc_add_platform_controls() or via table based setup of
1639 * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1640 */
1641static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1642 struct snd_kcontrol *kcontrol)
1643{
1644 return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1645}
1646
1647int snd_soc_util_init(void);
1648void snd_soc_util_exit(void);
1649
1650#define snd_soc_of_parse_card_name(card, propname) \
1651 snd_soc_of_parse_card_name_from_node(card, NULL, propname)
1652int snd_soc_of_parse_card_name_from_node(struct snd_soc_card *card,
1653 struct device_node *np,
1654 const char *propname);
1655#define snd_soc_of_parse_audio_simple_widgets(card, propname)\
1656 snd_soc_of_parse_audio_simple_widgets_from_node(card, NULL, propname)
1657int snd_soc_of_parse_audio_simple_widgets_from_node(struct snd_soc_card *card,
1658 struct device_node *np,
1659 const char *propname);
1660
1661int snd_soc_of_parse_tdm_slot(struct device_node *np,
1662 unsigned int *tx_mask,
1663 unsigned int *rx_mask,
1664 unsigned int *slots,
1665 unsigned int *slot_width);
1666#define snd_soc_of_parse_audio_prefix(card, codec_conf, of_node, propname) \
1667 snd_soc_of_parse_audio_prefix_from_node(card, NULL, codec_conf, \
1668 of_node, propname)
1669void snd_soc_of_parse_audio_prefix_from_node(struct snd_soc_card *card,
1670 struct device_node *np,
1671 struct snd_soc_codec_conf *codec_conf,
1672 struct device_node *of_node,
1673 const char *propname);
1674
1675#define snd_soc_of_parse_audio_routing(card, propname) \
1676 snd_soc_of_parse_audio_routing_from_node(card, NULL, propname)
1677int snd_soc_of_parse_audio_routing_from_node(struct snd_soc_card *card,
1678 struct device_node *np,
1679 const char *propname);
1680
1681unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1682 const char *prefix,
1683 struct device_node **bitclkmaster,
1684 struct device_node **framemaster);
1685int snd_soc_get_dai_name(struct of_phandle_args *args,
1686 const char **dai_name);
1687int snd_soc_of_get_dai_name(struct device_node *of_node,
1688 const char **dai_name);
1689int snd_soc_of_get_dai_link_codecs(struct device *dev,
1690 struct device_node *of_node,
1691 struct snd_soc_dai_link *dai_link);
1692
1693int snd_soc_add_dai_link(struct snd_soc_card *card,
1694 struct snd_soc_dai_link *dai_link);
1695void snd_soc_remove_dai_link(struct snd_soc_card *card,
1696 struct snd_soc_dai_link *dai_link);
1697struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
1698 int id, const char *name,
1699 const char *stream_name);
1700
1701int snd_soc_register_dai(struct snd_soc_component *component,
1702 struct snd_soc_dai_driver *dai_drv);
1703
1704struct snd_soc_dai *snd_soc_find_dai(
1705 const struct snd_soc_dai_link_component *dlc);
1706
1707#include <sound/soc-dai.h>
1708
1709#ifdef CONFIG_DEBUG_FS
1710extern struct dentry *snd_soc_debugfs_root;
1711#endif
1712
1713extern const struct dev_pm_ops snd_soc_pm_ops;
1714
1715/* Helper functions */
1716static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1717{
1718 mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1719}
1720
1721static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1722{
1723 mutex_unlock(&dapm->card->dapm_mutex);
1724}
1725
1726int snd_soc_component_enable_pin(struct snd_soc_component *component,
1727 const char *pin);
1728int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component,
1729 const char *pin);
1730int snd_soc_component_disable_pin(struct snd_soc_component *component,
1731 const char *pin);
1732int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component,
1733 const char *pin);
1734int snd_soc_component_nc_pin(struct snd_soc_component *component,
1735 const char *pin);
1736int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component,
1737 const char *pin);
1738int snd_soc_component_get_pin_status(struct snd_soc_component *component,
1739 const char *pin);
1740int snd_soc_component_force_enable_pin(struct snd_soc_component *component,
1741 const char *pin);
1742int snd_soc_component_force_enable_pin_unlocked(
1743 struct snd_soc_component *component,
1744 const char *pin);
1745
1746#endif