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