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