Merge remote-tracking branch 'asoc/topic/component' into asoc-next
[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_add_component(struct device *dev,
472                 struct snd_soc_component *component,
473                 const struct snd_soc_component_driver *component_driver,
474                 struct snd_soc_dai_driver *dai_drv,
475                 int num_dai);
476 int snd_soc_register_component(struct device *dev,
477                          const struct snd_soc_component_driver *component_driver,
478                          struct snd_soc_dai_driver *dai_drv, int num_dai);
479 int devm_snd_soc_register_component(struct device *dev,
480                          const struct snd_soc_component_driver *component_driver,
481                          struct snd_soc_dai_driver *dai_drv, int num_dai);
482 void snd_soc_unregister_component(struct device *dev);
483 int snd_soc_cache_init(struct snd_soc_codec *codec);
484 int snd_soc_cache_exit(struct snd_soc_codec *codec);
485
486 int snd_soc_platform_read(struct snd_soc_platform *platform,
487                                         unsigned int reg);
488 int snd_soc_platform_write(struct snd_soc_platform *platform,
489                                         unsigned int reg, unsigned int val);
490 int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
491 #ifdef CONFIG_SND_SOC_COMPRESS
492 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
493 #endif
494
495 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
496                 const char *dai_link, int stream);
497 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
498                 const char *dai_link);
499
500 bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
501 void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
502 void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
503
504 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
505         unsigned int dai_fmt);
506
507 #ifdef CONFIG_DMI
508 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour);
509 #else
510 static inline int snd_soc_set_dmi_name(struct snd_soc_card *card,
511                                        const char *flavour)
512 {
513         return 0;
514 }
515 #endif
516
517 /* Utility functions to get clock rates from various things */
518 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
519 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
520 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
521 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
522
523 /* set runtime hw params */
524 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
525         const struct snd_pcm_hardware *hw);
526
527 int soc_dai_hw_params(struct snd_pcm_substream *substream,
528                       struct snd_pcm_hw_params *params,
529                       struct snd_soc_dai *dai);
530
531 /* Jack reporting */
532 int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
533         struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
534         unsigned int num_pins);
535
536 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
537 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
538                           struct snd_soc_jack_pin *pins);
539 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
540                                     struct notifier_block *nb);
541 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
542                                       struct notifier_block *nb);
543 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
544                           struct snd_soc_jack_zone *zones);
545 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
546 #ifdef CONFIG_GPIOLIB
547 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
548                         struct snd_soc_jack_gpio *gpios);
549 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
550                             struct snd_soc_jack *jack,
551                             int count, struct snd_soc_jack_gpio *gpios);
552 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
553                         struct snd_soc_jack_gpio *gpios);
554 #else
555 static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
556                                          struct snd_soc_jack_gpio *gpios)
557 {
558         return 0;
559 }
560
561 static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
562                                           struct snd_soc_jack *jack,
563                                           int count,
564                                           struct snd_soc_jack_gpio *gpios)
565 {
566         return 0;
567 }
568
569 static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
570                                            struct snd_soc_jack_gpio *gpios)
571 {
572 }
573 #endif
574
575 /* codec register bit access */
576 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg,
577                                 unsigned int mask, unsigned int value);
578 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
579                                unsigned int reg, unsigned int mask,
580                                unsigned int value);
581 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg,
582                                 unsigned int mask, unsigned int value);
583
584 #ifdef CONFIG_SND_SOC_AC97_BUS
585 struct snd_ac97 *snd_soc_alloc_ac97_codec(struct snd_soc_codec *codec);
586 struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
587         unsigned int id, unsigned int id_mask);
588 void snd_soc_free_ac97_codec(struct snd_ac97 *ac97);
589
590 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
591 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
592                 struct platform_device *pdev);
593
594 extern struct snd_ac97_bus_ops *soc_ac97_ops;
595 #else
596 static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
597         struct platform_device *pdev)
598 {
599         return 0;
600 }
601
602 static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
603 {
604         return 0;
605 }
606 #endif
607
608 /*
609  *Controls
610  */
611 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
612                                   void *data, const char *long_name,
613                                   const char *prefix);
614 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
615                                                const char *name);
616 int snd_soc_add_component_controls(struct snd_soc_component *component,
617         const struct snd_kcontrol_new *controls, unsigned int num_controls);
618 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
619         const struct snd_kcontrol_new *controls, unsigned int num_controls);
620 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
621         const struct snd_kcontrol_new *controls, unsigned int num_controls);
622 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
623         const struct snd_kcontrol_new *controls, int num_controls);
624 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
625         const struct snd_kcontrol_new *controls, int num_controls);
626 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
627         struct snd_ctl_elem_info *uinfo);
628 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
629         struct snd_ctl_elem_value *ucontrol);
630 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
631         struct snd_ctl_elem_value *ucontrol);
632 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
633         struct snd_ctl_elem_info *uinfo);
634 int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
635                           struct snd_ctl_elem_info *uinfo);
636 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
637 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
638         struct snd_ctl_elem_value *ucontrol);
639 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
640         struct snd_ctl_elem_value *ucontrol);
641 #define snd_soc_get_volsw_2r snd_soc_get_volsw
642 #define snd_soc_put_volsw_2r snd_soc_put_volsw
643 int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
644         struct snd_ctl_elem_value *ucontrol);
645 int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
646         struct snd_ctl_elem_value *ucontrol);
647 int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
648         struct snd_ctl_elem_info *uinfo);
649 int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
650         struct snd_ctl_elem_value *ucontrol);
651 int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
652         struct snd_ctl_elem_value *ucontrol);
653 int snd_soc_limit_volume(struct snd_soc_card *card,
654         const char *name, int max);
655 int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
656                        struct snd_ctl_elem_info *uinfo);
657 int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
658                       struct snd_ctl_elem_value *ucontrol);
659 int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
660                       struct snd_ctl_elem_value *ucontrol);
661 int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
662         struct snd_ctl_elem_info *ucontrol);
663 int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
664         unsigned int size, unsigned int __user *tlv);
665 int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
666         struct snd_ctl_elem_info *uinfo);
667 int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
668         struct snd_ctl_elem_value *ucontrol);
669 int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
670         struct snd_ctl_elem_value *ucontrol);
671 int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
672         struct snd_ctl_elem_value *ucontrol);
673 int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
674         struct snd_ctl_elem_value *ucontrol);
675
676 /**
677  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
678  *
679  * @pin:    name of the pin to update
680  * @mask:   bits to check for in reported jack status
681  * @invert: if non-zero then pin is enabled when status is not reported
682  * @list:   internal list entry
683  */
684 struct snd_soc_jack_pin {
685         struct list_head list;
686         const char *pin;
687         int mask;
688         bool invert;
689 };
690
691 /**
692  * struct snd_soc_jack_zone - Describes voltage zones of jack detection
693  *
694  * @min_mv: start voltage in mv
695  * @max_mv: end voltage in mv
696  * @jack_type: type of jack that is expected for this voltage
697  * @debounce_time: debounce_time for jack, codec driver should wait for this
698  *              duration before reading the adc for voltages
699  * @list:   internal list entry
700  */
701 struct snd_soc_jack_zone {
702         unsigned int min_mv;
703         unsigned int max_mv;
704         unsigned int jack_type;
705         unsigned int debounce_time;
706         struct list_head list;
707 };
708
709 /**
710  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
711  *
712  * @gpio:         legacy gpio number
713  * @idx:          gpio descriptor index within the function of the GPIO
714  *                consumer device
715  * @gpiod_dev:    GPIO consumer device
716  * @name:         gpio name. Also as connection ID for the GPIO consumer
717  *                device function name lookup
718  * @report:       value to report when jack detected
719  * @invert:       report presence in low state
720  * @debounce_time: debounce time in ms
721  * @wake:         enable as wake source
722  * @jack_status_check: callback function which overrides the detection
723  *                     to provide more complex checks (eg, reading an
724  *                     ADC).
725  */
726 struct snd_soc_jack_gpio {
727         unsigned int gpio;
728         unsigned int idx;
729         struct device *gpiod_dev;
730         const char *name;
731         int report;
732         int invert;
733         int debounce_time;
734         bool wake;
735
736         /* private: */
737         struct snd_soc_jack *jack;
738         struct delayed_work work;
739         struct notifier_block pm_notifier;
740         struct gpio_desc *desc;
741
742         void *data;
743         /* public: */
744         int (*jack_status_check)(void *data);
745 };
746
747 struct snd_soc_jack {
748         struct mutex mutex;
749         struct snd_jack *jack;
750         struct snd_soc_card *card;
751         struct list_head pins;
752         int status;
753         struct blocking_notifier_head notifier;
754         struct list_head jack_zones;
755 };
756
757 /* SoC PCM stream information */
758 struct snd_soc_pcm_stream {
759         const char *stream_name;
760         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
761         unsigned int rates;             /* SNDRV_PCM_RATE_* */
762         unsigned int rate_min;          /* min rate */
763         unsigned int rate_max;          /* max rate */
764         unsigned int channels_min;      /* min channels */
765         unsigned int channels_max;      /* max channels */
766         unsigned int sig_bits;          /* number of bits of content */
767 };
768
769 /* SoC audio ops */
770 struct snd_soc_ops {
771         int (*startup)(struct snd_pcm_substream *);
772         void (*shutdown)(struct snd_pcm_substream *);
773         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
774         int (*hw_free)(struct snd_pcm_substream *);
775         int (*prepare)(struct snd_pcm_substream *);
776         int (*trigger)(struct snd_pcm_substream *, int);
777 };
778
779 struct snd_soc_compr_ops {
780         int (*startup)(struct snd_compr_stream *);
781         void (*shutdown)(struct snd_compr_stream *);
782         int (*set_params)(struct snd_compr_stream *);
783         int (*trigger)(struct snd_compr_stream *);
784 };
785
786 /* component interface */
787 struct snd_soc_component_driver {
788         const char *name;
789
790         /* Default control and setup, added after probe() is run */
791         const struct snd_kcontrol_new *controls;
792         unsigned int num_controls;
793         const struct snd_soc_dapm_widget *dapm_widgets;
794         unsigned int num_dapm_widgets;
795         const struct snd_soc_dapm_route *dapm_routes;
796         unsigned int num_dapm_routes;
797
798         int (*probe)(struct snd_soc_component *);
799         void (*remove)(struct snd_soc_component *);
800         int (*suspend)(struct snd_soc_component *);
801         int (*resume)(struct snd_soc_component *);
802
803         /* component wide operations */
804         int (*set_sysclk)(struct snd_soc_component *component,
805                           int clk_id, int source, unsigned int freq, int dir);
806         int (*set_pll)(struct snd_soc_component *component, int pll_id,
807                        int source, unsigned int freq_in, unsigned int freq_out);
808         int (*set_jack)(struct snd_soc_component *component,
809                         struct snd_soc_jack *jack,  void *data);
810
811         /* DT */
812         int (*of_xlate_dai_name)(struct snd_soc_component *component,
813                                  struct of_phandle_args *args,
814                                  const char **dai_name);
815         int (*of_xlate_dai_id)(struct snd_soc_component *comment,
816                                struct device_node *endpoint);
817         void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
818                 int subseq);
819         int (*stream_event)(struct snd_soc_component *, int event);
820
821         /* probe ordering - for components with runtime dependencies */
822         int probe_order;
823         int remove_order;
824 };
825
826 struct snd_soc_component {
827         const char *name;
828         int id;
829         const char *name_prefix;
830         struct device *dev;
831         struct snd_soc_card *card;
832
833         unsigned int active;
834
835         unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
836         unsigned int registered_as_component:1;
837         unsigned int suspended:1; /* is in suspend PM state */
838
839         struct list_head list;
840         struct list_head card_aux_list; /* for auxiliary bound components */
841         struct list_head card_list;
842
843         struct snd_soc_dai_driver *dai_drv;
844         int num_dai;
845
846         const struct snd_soc_component_driver *driver;
847
848         struct list_head dai_list;
849
850         int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
851         int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
852
853         struct regmap *regmap;
854         int val_bytes;
855
856         struct mutex io_mutex;
857
858         /* attached dynamic objects */
859         struct list_head dobj_list;
860
861 #ifdef CONFIG_DEBUG_FS
862         struct dentry *debugfs_root;
863 #endif
864
865         /*
866         * DO NOT use any of the fields below in drivers, they are temporary and
867         * are going to be removed again soon. If you use them in driver code the
868         * driver will be marked as BROKEN when these fields are removed.
869         */
870
871         /* Don't use these, use snd_soc_component_get_dapm() */
872         struct snd_soc_dapm_context dapm;
873
874         struct snd_soc_codec *codec;
875
876         int (*probe)(struct snd_soc_component *);
877         void (*remove)(struct snd_soc_component *);
878         int (*suspend)(struct snd_soc_component *);
879         int (*resume)(struct snd_soc_component *);
880
881         int (*set_sysclk)(struct snd_soc_component *component,
882                           int clk_id, int source, unsigned int freq, int dir);
883         int (*set_pll)(struct snd_soc_component *component, int pll_id,
884                        int source, unsigned int freq_in, unsigned int freq_out);
885         int (*set_jack)(struct snd_soc_component *component,
886                         struct snd_soc_jack *jack,  void *data);
887
888         /* machine specific init */
889         int (*init)(struct snd_soc_component *component);
890
891 #ifdef CONFIG_DEBUG_FS
892         void (*init_debugfs)(struct snd_soc_component *component);
893         const char *debugfs_prefix;
894 #endif
895 };
896
897 struct snd_soc_rtdcom_list {
898         struct snd_soc_component *component;
899         struct list_head list; /* rtd::component_list */
900 };
901 struct snd_soc_component*
902 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
903                        const char *driver_name);
904 #define for_each_rtdcom(rtd, rtdcom) \
905         list_for_each_entry(rtdcom, &(rtd)->component_list, list)
906 #define for_each_rtdcom_safe(rtd, rtdcom1, rtdcom2) \
907         list_for_each_entry_safe(rtdcom1, rtdcom2, &(rtd)->component_list, list)
908
909 /* SoC Audio Codec device */
910 struct snd_soc_codec {
911         struct device *dev;
912         const struct snd_soc_codec_driver *driver;
913
914         struct list_head list;
915
916         /* runtime */
917         unsigned int cache_init:1; /* codec cache has been initialized */
918
919         /* codec IO */
920         void *control_data; /* codec control (i2c/3wire) data */
921         hw_write_t hw_write;
922         void *reg_cache;
923
924         /* component */
925         struct snd_soc_component component;
926 };
927
928 /* codec driver */
929 struct snd_soc_codec_driver {
930
931         /* driver ops */
932         int (*probe)(struct snd_soc_codec *);
933         int (*remove)(struct snd_soc_codec *);
934         int (*suspend)(struct snd_soc_codec *);
935         int (*resume)(struct snd_soc_codec *);
936         struct snd_soc_component_driver component_driver;
937
938         /* codec wide operations */
939         int (*set_sysclk)(struct snd_soc_codec *codec,
940                           int clk_id, int source, unsigned int freq, int dir);
941         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
942                 unsigned int freq_in, unsigned int freq_out);
943         int (*set_jack)(struct snd_soc_codec *codec,
944                         struct snd_soc_jack *jack,  void *data);
945
946         /* codec IO */
947         struct regmap *(*get_regmap)(struct device *);
948         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
949         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
950         unsigned int reg_cache_size;
951         short reg_cache_step;
952         short reg_word_size;
953         const void *reg_cache_default;
954
955         /* codec bias level */
956         int (*set_bias_level)(struct snd_soc_codec *,
957                               enum snd_soc_bias_level level);
958         bool idle_bias_off;
959         bool suspend_bias_off;
960
961         void (*seq_notifier)(struct snd_soc_dapm_context *,
962                              enum snd_soc_dapm_type, int);
963
964         bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
965 };
966
967 /* SoC platform interface */
968 struct snd_soc_platform_driver {
969
970         int (*probe)(struct snd_soc_platform *);
971         int (*remove)(struct snd_soc_platform *);
972         struct snd_soc_component_driver component_driver;
973
974         /* pcm creation and destruction */
975         int (*pcm_new)(struct snd_soc_pcm_runtime *);
976         void (*pcm_free)(struct snd_pcm *);
977
978         /* platform stream pcm ops */
979         const struct snd_pcm_ops *ops;
980
981         /* platform stream compress ops */
982         const struct snd_compr_ops *compr_ops;
983 };
984
985 struct snd_soc_dai_link_component {
986         const char *name;
987         struct device_node *of_node;
988         const char *dai_name;
989 };
990
991 struct snd_soc_platform {
992         struct device *dev;
993         const struct snd_soc_platform_driver *driver;
994
995         struct list_head list;
996
997         struct snd_soc_component component;
998 };
999
1000 struct snd_soc_dai_link {
1001         /* config - must be set by machine driver */
1002         const char *name;                       /* Codec name */
1003         const char *stream_name;                /* Stream name */
1004         /*
1005          * You MAY specify the link's CPU-side device, either by device name,
1006          * or by DT/OF node, but not both. If this information is omitted,
1007          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
1008          * must be globally unique. These fields are currently typically used
1009          * only for codec to codec links, or systems using device tree.
1010          */
1011         const char *cpu_name;
1012         struct device_node *cpu_of_node;
1013         /*
1014          * You MAY specify the DAI name of the CPU DAI. If this information is
1015          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
1016          * only, which only works well when that device exposes a single DAI.
1017          */
1018         const char *cpu_dai_name;
1019         /*
1020          * You MUST specify the link's codec, either by device name, or by
1021          * DT/OF node, but not both.
1022          */
1023         const char *codec_name;
1024         struct device_node *codec_of_node;
1025         /* You MUST specify the DAI name within the codec */
1026         const char *codec_dai_name;
1027
1028         struct snd_soc_dai_link_component *codecs;
1029         unsigned int num_codecs;
1030
1031         /*
1032          * You MAY specify the link's platform/PCM/DMA driver, either by
1033          * device name, or by DT/OF node, but not both. Some forms of link
1034          * do not need a platform.
1035          */
1036         const char *platform_name;
1037         struct device_node *platform_of_node;
1038         int id; /* optional ID for machine driver link identification */
1039
1040         const struct snd_soc_pcm_stream *params;
1041         unsigned int num_params;
1042
1043         unsigned int dai_fmt;           /* format to set on init */
1044
1045         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
1046
1047         /* codec/machine specific init - e.g. add machine controls */
1048         int (*init)(struct snd_soc_pcm_runtime *rtd);
1049
1050         /* optional hw_params re-writing for BE and FE sync */
1051         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
1052                         struct snd_pcm_hw_params *params);
1053
1054         /* machine stream operations */
1055         const struct snd_soc_ops *ops;
1056         const struct snd_soc_compr_ops *compr_ops;
1057
1058         /* Mark this pcm with non atomic ops */
1059         bool nonatomic;
1060
1061         /* For unidirectional dai links */
1062         unsigned int playback_only:1;
1063         unsigned int capture_only:1;
1064
1065         /* Keep DAI active over suspend */
1066         unsigned int ignore_suspend:1;
1067
1068         /* Symmetry requirements */
1069         unsigned int symmetric_rates:1;
1070         unsigned int symmetric_channels:1;
1071         unsigned int symmetric_samplebits:1;
1072
1073         /* Do not create a PCM for this DAI link (Backend link) */
1074         unsigned int no_pcm:1;
1075
1076         /* This DAI link can route to other DAI links at runtime (Frontend)*/
1077         unsigned int dynamic:1;
1078
1079         /* DPCM capture and Playback support */
1080         unsigned int dpcm_capture:1;
1081         unsigned int dpcm_playback:1;
1082
1083         /* DPCM used FE & BE merged format */
1084         unsigned int dpcm_merged_format:1;
1085
1086         /* pmdown_time is ignored at stop */
1087         unsigned int ignore_pmdown_time:1;
1088
1089         struct list_head list; /* DAI link list of the soc card */
1090         struct snd_soc_dobj dobj; /* For topology */
1091 };
1092
1093 struct snd_soc_codec_conf {
1094         /*
1095          * specify device either by device name, or by
1096          * DT/OF node, but not both.
1097          */
1098         const char *dev_name;
1099         struct device_node *of_node;
1100
1101         /*
1102          * optional map of kcontrol, widget and path name prefixes that are
1103          * associated per device
1104          */
1105         const char *name_prefix;
1106 };
1107
1108 struct snd_soc_aux_dev {
1109         const char *name;               /* Codec name */
1110
1111         /*
1112          * specify multi-codec either by device name, or by
1113          * DT/OF node, but not both.
1114          */
1115         const char *codec_name;
1116         struct device_node *codec_of_node;
1117
1118         /* codec/machine specific init - e.g. add machine controls */
1119         int (*init)(struct snd_soc_component *component);
1120 };
1121
1122 /* SoC card */
1123 struct snd_soc_card {
1124         const char *name;
1125         const char *long_name;
1126         const char *driver_name;
1127         char dmi_longname[80];
1128
1129         struct device *dev;
1130         struct snd_card *snd_card;
1131         struct module *owner;
1132
1133         struct mutex mutex;
1134         struct mutex dapm_mutex;
1135
1136         bool instantiated;
1137
1138         int (*probe)(struct snd_soc_card *card);
1139         int (*late_probe)(struct snd_soc_card *card);
1140         int (*remove)(struct snd_soc_card *card);
1141
1142         /* the pre and post PM functions are used to do any PM work before and
1143          * after the codec and DAI's do any PM work. */
1144         int (*suspend_pre)(struct snd_soc_card *card);
1145         int (*suspend_post)(struct snd_soc_card *card);
1146         int (*resume_pre)(struct snd_soc_card *card);
1147         int (*resume_post)(struct snd_soc_card *card);
1148
1149         /* callbacks */
1150         int (*set_bias_level)(struct snd_soc_card *,
1151                               struct snd_soc_dapm_context *dapm,
1152                               enum snd_soc_bias_level level);
1153         int (*set_bias_level_post)(struct snd_soc_card *,
1154                                    struct snd_soc_dapm_context *dapm,
1155                                    enum snd_soc_bias_level level);
1156
1157         int (*add_dai_link)(struct snd_soc_card *,
1158                             struct snd_soc_dai_link *link);
1159         void (*remove_dai_link)(struct snd_soc_card *,
1160                             struct snd_soc_dai_link *link);
1161
1162         long pmdown_time;
1163
1164         /* CPU <--> Codec DAI links  */
1165         struct snd_soc_dai_link *dai_link;  /* predefined links only */
1166         int num_links;  /* predefined links only */
1167         struct list_head dai_link_list; /* all links */
1168         int num_dai_links;
1169
1170         struct list_head rtd_list;
1171         int num_rtd;
1172
1173         /* optional codec specific configuration */
1174         struct snd_soc_codec_conf *codec_conf;
1175         int num_configs;
1176
1177         /*
1178          * optional auxiliary devices such as amplifiers or codecs with DAI
1179          * link unused
1180          */
1181         struct snd_soc_aux_dev *aux_dev;
1182         int num_aux_devs;
1183         struct list_head aux_comp_list;
1184
1185         const struct snd_kcontrol_new *controls;
1186         int num_controls;
1187
1188         /*
1189          * Card-specific routes and widgets.
1190          * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1191          */
1192         const struct snd_soc_dapm_widget *dapm_widgets;
1193         int num_dapm_widgets;
1194         const struct snd_soc_dapm_route *dapm_routes;
1195         int num_dapm_routes;
1196         const struct snd_soc_dapm_widget *of_dapm_widgets;
1197         int num_of_dapm_widgets;
1198         const struct snd_soc_dapm_route *of_dapm_routes;
1199         int num_of_dapm_routes;
1200         bool fully_routed;
1201
1202         struct work_struct deferred_resume_work;
1203
1204         /* lists of probed devices belonging to this card */
1205         struct list_head component_dev_list;
1206
1207         struct list_head widgets;
1208         struct list_head paths;
1209         struct list_head dapm_list;
1210         struct list_head dapm_dirty;
1211
1212         /* attached dynamic objects */
1213         struct list_head dobj_list;
1214
1215         /* Generic DAPM context for the card */
1216         struct snd_soc_dapm_context dapm;
1217         struct snd_soc_dapm_stats dapm_stats;
1218         struct snd_soc_dapm_update *update;
1219
1220 #ifdef CONFIG_DEBUG_FS
1221         struct dentry *debugfs_card_root;
1222         struct dentry *debugfs_pop_time;
1223 #endif
1224         u32 pop_time;
1225
1226         void *drvdata;
1227 };
1228
1229 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1230 struct snd_soc_pcm_runtime {
1231         struct device *dev;
1232         struct snd_soc_card *card;
1233         struct snd_soc_dai_link *dai_link;
1234         struct mutex pcm_mutex;
1235         enum snd_soc_pcm_subclass pcm_subclass;
1236         struct snd_pcm_ops ops;
1237
1238         /* Dynamic PCM BE runtime data */
1239         struct snd_soc_dpcm_runtime dpcm[2];
1240         int fe_compr;
1241
1242         long pmdown_time;
1243
1244         /* runtime devices */
1245         struct snd_pcm *pcm;
1246         struct snd_compr *compr;
1247         struct snd_soc_codec *codec;
1248         struct snd_soc_platform *platform; /* will be removed */
1249         struct snd_soc_dai *codec_dai;
1250         struct snd_soc_dai *cpu_dai;
1251
1252         struct snd_soc_dai **codec_dais;
1253         unsigned int num_codecs;
1254
1255         struct delayed_work delayed_work;
1256 #ifdef CONFIG_DEBUG_FS
1257         struct dentry *debugfs_dpcm_root;
1258 #endif
1259
1260         unsigned int num; /* 0-based and monotonic increasing */
1261         struct list_head list; /* rtd list of the soc card */
1262         struct list_head component_list; /* list of connected components */
1263
1264         /* bit field */
1265         unsigned int dev_registered:1;
1266         unsigned int pop_wait:1;
1267 };
1268
1269 /* mixer control */
1270 struct soc_mixer_control {
1271         int min, max, platform_max;
1272         int reg, rreg;
1273         unsigned int shift, rshift;
1274         unsigned int sign_bit;
1275         unsigned int invert:1;
1276         unsigned int autodisable:1;
1277         struct snd_soc_dobj dobj;
1278 };
1279
1280 struct soc_bytes {
1281         int base;
1282         int num_regs;
1283         u32 mask;
1284 };
1285
1286 struct soc_bytes_ext {
1287         int max;
1288         struct snd_soc_dobj dobj;
1289
1290         /* used for TLV byte control */
1291         int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1292                         unsigned int size);
1293         int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1294                         unsigned int size);
1295 };
1296
1297 /* multi register control */
1298 struct soc_mreg_control {
1299         long min, max;
1300         unsigned int regbase, regcount, nbits, invert;
1301 };
1302
1303 /* enumerated kcontrol */
1304 struct soc_enum {
1305         int reg;
1306         unsigned char shift_l;
1307         unsigned char shift_r;
1308         unsigned int items;
1309         unsigned int mask;
1310         const char * const *texts;
1311         const unsigned int *values;
1312         unsigned int autodisable:1;
1313         struct snd_soc_dobj dobj;
1314 };
1315
1316 /**
1317  * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1318  * @component: The component to cast to a CODEC
1319  *
1320  * This function must only be used on components that are known to be CODECs.
1321  * Otherwise the behavior is undefined.
1322  */
1323 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1324         struct snd_soc_component *component)
1325 {
1326         return container_of(component, struct snd_soc_codec, component);
1327 }
1328
1329 /**
1330  * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1331  * @component: The component to cast to a platform
1332  *
1333  * This function must only be used on components that are known to be platforms.
1334  * Otherwise the behavior is undefined.
1335  */
1336 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1337         struct snd_soc_component *component)
1338 {
1339         return container_of(component, struct snd_soc_platform, component);
1340 }
1341
1342 /**
1343  * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1344  *  embedded in
1345  * @dapm: The DAPM context to cast to the component
1346  *
1347  * This function must only be used on DAPM contexts that are known to be part of
1348  * a component (e.g. in a component driver). Otherwise the behavior is
1349  * undefined.
1350  */
1351 static inline struct snd_soc_component *snd_soc_dapm_to_component(
1352         struct snd_soc_dapm_context *dapm)
1353 {
1354         return container_of(dapm, struct snd_soc_component, dapm);
1355 }
1356
1357 /**
1358  * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1359  * @dapm: The DAPM context to cast to the CODEC
1360  *
1361  * This function must only be used on DAPM contexts that are known to be part of
1362  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1363  */
1364 static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1365         struct snd_soc_dapm_context *dapm)
1366 {
1367         return snd_soc_component_to_codec(snd_soc_dapm_to_component(dapm));
1368 }
1369
1370 /**
1371  * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1372  *  embedded in
1373  * @dapm: The DAPM context to cast to the platform.
1374  *
1375  * This function must only be used on DAPM contexts that are known to be part of
1376  * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1377  */
1378 static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1379         struct snd_soc_dapm_context *dapm)
1380 {
1381         return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
1382 }
1383
1384 /**
1385  * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1386  *  component
1387  * @component: The component for which to get the DAPM context
1388  */
1389 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1390         struct snd_soc_component *component)
1391 {
1392         return &component->dapm;
1393 }
1394
1395 /**
1396  * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC
1397  * @codec: The CODEC for which to get the DAPM context
1398  *
1399  * Note: Use this function instead of directly accessing the CODEC's dapm field
1400  */
1401 static inline struct snd_soc_dapm_context *snd_soc_codec_get_dapm(
1402         struct snd_soc_codec *codec)
1403 {
1404         return snd_soc_component_get_dapm(&codec->component);
1405 }
1406
1407 /**
1408  * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level
1409  * @codec: The CODEC for which to initialize the DAPM bias level
1410  * @level: The DAPM level to initialize to
1411  *
1412  * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level().
1413  */
1414 static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec *codec,
1415         enum snd_soc_bias_level level)
1416 {
1417         snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec), level);
1418 }
1419
1420 /**
1421  * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level
1422  * @codec: The CODEC for which to get the DAPM bias level
1423  *
1424  * Returns: The current DAPM bias level of the CODEC.
1425  */
1426 static inline enum snd_soc_bias_level snd_soc_codec_get_bias_level(
1427         struct snd_soc_codec *codec)
1428 {
1429         return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec));
1430 }
1431
1432 /**
1433  * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level
1434  * @codec: The CODEC for which to set the level
1435  * @level: The level to set to
1436  *
1437  * Forces the CODEC bias level to a specific state. See
1438  * snd_soc_dapm_force_bias_level().
1439  */
1440 static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec *codec,
1441         enum snd_soc_bias_level level)
1442 {
1443         return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec),
1444                 level);
1445 }
1446
1447 /**
1448  * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1449  * @kcontrol: The kcontrol
1450  *
1451  * This function must only be used on DAPM contexts that are known to be part of
1452  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1453  */
1454 static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(
1455         struct snd_kcontrol *kcontrol)
1456 {
1457         return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol));
1458 }
1459
1460 /* codec IO */
1461 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1462 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1463         unsigned int val);
1464
1465 /**
1466  * snd_soc_cache_sync() - Sync the register cache with the hardware
1467  * @codec: CODEC to sync
1468  *
1469  * Note: This function will call regcache_sync()
1470  */
1471 static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1472 {
1473         return regcache_sync(codec->component.regmap);
1474 }
1475
1476 /* component IO */
1477 int snd_soc_component_read(struct snd_soc_component *component,
1478         unsigned int reg, unsigned int *val);
1479 int snd_soc_component_write(struct snd_soc_component *component,
1480         unsigned int reg, unsigned int val);
1481 int snd_soc_component_update_bits(struct snd_soc_component *component,
1482         unsigned int reg, unsigned int mask, unsigned int val);
1483 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1484         unsigned int reg, unsigned int mask, unsigned int val);
1485 void snd_soc_component_async_complete(struct snd_soc_component *component);
1486 int snd_soc_component_test_bits(struct snd_soc_component *component,
1487         unsigned int reg, unsigned int mask, unsigned int value);
1488
1489 /* component wide operations */
1490 int snd_soc_component_set_sysclk(struct snd_soc_component *component,
1491                         int clk_id, int source, unsigned int freq, int dir);
1492 int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id,
1493                               int source, unsigned int freq_in,
1494                               unsigned int freq_out);
1495 int snd_soc_component_set_jack(struct snd_soc_component *component,
1496                                struct snd_soc_jack *jack, void *data);
1497
1498 #ifdef CONFIG_REGMAP
1499
1500 void snd_soc_component_init_regmap(struct snd_soc_component *component,
1501         struct regmap *regmap);
1502 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1503
1504 /**
1505  * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1506  * @codec: The CODEC for which to initialize the regmap instance
1507  * @regmap: The regmap instance that should be used by the CODEC
1508  *
1509  * This function allows deferred assignment of the regmap instance that is
1510  * associated with the CODEC. Only use this if the regmap instance is not yet
1511  * ready when the CODEC is registered. The function must also be called before
1512  * the first IO attempt of the CODEC.
1513  */
1514 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1515         struct regmap *regmap)
1516 {
1517         snd_soc_component_init_regmap(&codec->component, regmap);
1518 }
1519
1520 /**
1521  * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1522  * @codec: The CODEC for which to de-initialize the regmap instance
1523  *
1524  * Calls regmap_exit() on the regmap instance associated to the CODEC and
1525  * removes the regmap instance from the CODEC.
1526  *
1527  * This function should only be used if snd_soc_codec_init_regmap() was used to
1528  * initialize the regmap instance.
1529  */
1530 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1531 {
1532         snd_soc_component_exit_regmap(&codec->component);
1533 }
1534
1535 #endif
1536
1537 /* device driver data */
1538
1539 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1540                 void *data)
1541 {
1542         card->drvdata = data;
1543 }
1544
1545 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1546 {
1547         return card->drvdata;
1548 }
1549
1550 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1551                 void *data)
1552 {
1553         dev_set_drvdata(c->dev, data);
1554 }
1555
1556 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1557 {
1558         return dev_get_drvdata(c->dev);
1559 }
1560
1561 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1562                 void *data)
1563 {
1564         snd_soc_component_set_drvdata(&codec->component, data);
1565 }
1566
1567 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1568 {
1569         return snd_soc_component_get_drvdata(&codec->component);
1570 }
1571
1572 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1573                 void *data)
1574 {
1575         snd_soc_component_set_drvdata(&platform->component, data);
1576 }
1577
1578 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1579 {
1580         return snd_soc_component_get_drvdata(&platform->component);
1581 }
1582
1583 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1584 {
1585         INIT_LIST_HEAD(&card->widgets);
1586         INIT_LIST_HEAD(&card->paths);
1587         INIT_LIST_HEAD(&card->dapm_list);
1588         INIT_LIST_HEAD(&card->aux_comp_list);
1589         INIT_LIST_HEAD(&card->component_dev_list);
1590 }
1591
1592 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1593 {
1594         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1595                 return 0;
1596         /*
1597          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1598          * mc->reg != mc->rreg means that the control is
1599          * stereo (bits in one register or in two registers)
1600          */
1601         return 1;
1602 }
1603
1604 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1605         unsigned int val)
1606 {
1607         unsigned int i;
1608
1609         if (!e->values)
1610                 return val;
1611
1612         for (i = 0; i < e->items; i++)
1613                 if (val == e->values[i])
1614                         return i;
1615
1616         return 0;
1617 }
1618
1619 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1620         unsigned int item)
1621 {
1622         if (!e->values)
1623                 return item;
1624
1625         return e->values[item];
1626 }
1627
1628 static inline bool snd_soc_component_is_active(
1629         struct snd_soc_component *component)
1630 {
1631         return component->active != 0;
1632 }
1633
1634 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1635 {
1636         return snd_soc_component_is_active(&codec->component);
1637 }
1638
1639 /**
1640  * snd_soc_kcontrol_component() - Returns the component that registered the
1641  *  control
1642  * @kcontrol: The control for which to get the component
1643  *
1644  * Note: This function will work correctly if the control has been registered
1645  * for a component. Either with snd_soc_add_codec_controls() or
1646  * snd_soc_add_platform_controls() or via  table based setup for either a
1647  * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1648  */
1649 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1650         struct snd_kcontrol *kcontrol)
1651 {
1652         return snd_kcontrol_chip(kcontrol);
1653 }
1654
1655 /**
1656  * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1657  * @kcontrol: The control for which to get the CODEC
1658  *
1659  * Note: This function will only work correctly if the control has been
1660  * registered with snd_soc_add_codec_controls() or via table based setup of
1661  * snd_soc_codec_driver. Otherwise the behavior is undefined.
1662  */
1663 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1664         struct snd_kcontrol *kcontrol)
1665 {
1666         return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1667 }
1668
1669 /**
1670  * snd_soc_kcontrol_platform() - Returns the platform that registered the control
1671  * @kcontrol: The control for which to get the platform
1672  *
1673  * Note: This function will only work correctly if the control has been
1674  * registered with snd_soc_add_platform_controls() or via table based setup of
1675  * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1676  */
1677 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1678         struct snd_kcontrol *kcontrol)
1679 {
1680         return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1681 }
1682
1683 int snd_soc_util_init(void);
1684 void snd_soc_util_exit(void);
1685
1686 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1687                                const char *propname);
1688 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1689                                           const char *propname);
1690 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1691                               unsigned int *tx_mask,
1692                               unsigned int *rx_mask,
1693                               unsigned int *slots,
1694                               unsigned int *slot_width);
1695 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1696                                    struct snd_soc_codec_conf *codec_conf,
1697                                    struct device_node *of_node,
1698                                    const char *propname);
1699 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1700                                    const char *propname);
1701 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1702                                      const char *prefix,
1703                                      struct device_node **bitclkmaster,
1704                                      struct device_node **framemaster);
1705 int snd_soc_get_dai_id(struct device_node *ep);
1706 int snd_soc_get_dai_name(struct of_phandle_args *args,
1707                          const char **dai_name);
1708 int snd_soc_of_get_dai_name(struct device_node *of_node,
1709                             const char **dai_name);
1710 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1711                                    struct device_node *of_node,
1712                                    struct snd_soc_dai_link *dai_link);
1713
1714 int snd_soc_add_dai_link(struct snd_soc_card *card,
1715                                 struct snd_soc_dai_link *dai_link);
1716 void snd_soc_remove_dai_link(struct snd_soc_card *card,
1717                              struct snd_soc_dai_link *dai_link);
1718 struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
1719                                                int id, const char *name,
1720                                                const char *stream_name);
1721
1722 int snd_soc_register_dai(struct snd_soc_component *component,
1723         struct snd_soc_dai_driver *dai_drv);
1724
1725 struct snd_soc_dai *snd_soc_find_dai(
1726         const struct snd_soc_dai_link_component *dlc);
1727
1728 #include <sound/soc-dai.h>
1729
1730 #ifdef CONFIG_DEBUG_FS
1731 extern struct dentry *snd_soc_debugfs_root;
1732 #endif
1733
1734 extern const struct dev_pm_ops snd_soc_pm_ops;
1735
1736 /* Helper functions */
1737 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1738 {
1739         mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1740 }
1741
1742 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1743 {
1744         mutex_unlock(&dapm->card->dapm_mutex);
1745 }
1746
1747 int snd_soc_component_enable_pin(struct snd_soc_component *component,
1748                                  const char *pin);
1749 int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component,
1750                                           const char *pin);
1751 int snd_soc_component_disable_pin(struct snd_soc_component *component,
1752                                   const char *pin);
1753 int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component,
1754                                            const char *pin);
1755 int snd_soc_component_nc_pin(struct snd_soc_component *component,
1756                              const char *pin);
1757 int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component,
1758                                       const char *pin);
1759 int snd_soc_component_get_pin_status(struct snd_soc_component *component,
1760                                      const char *pin);
1761 int snd_soc_component_force_enable_pin(struct snd_soc_component *component,
1762                                        const char *pin);
1763 int snd_soc_component_force_enable_pin_unlocked(
1764                                         struct snd_soc_component *component,
1765                                         const char *pin);
1766
1767 #endif