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