eea3007a28f1a4592a1a482d48fc33bc137a0098
[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         /* probe ordering - for components with runtime dependencies */
830         int probe_order;
831         int remove_order;
832
833         /* bits */
834         unsigned int idle_bias_on:1;
835         unsigned int suspend_bias_off:1;
836 };
837
838 struct snd_soc_component {
839         const char *name;
840         int id;
841         const char *name_prefix;
842         struct device *dev;
843         struct snd_soc_card *card;
844
845         unsigned int active;
846
847         unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
848         unsigned int registered_as_component:1;
849         unsigned int suspended:1; /* is in suspend PM state */
850
851         struct list_head list;
852         struct list_head card_aux_list; /* for auxiliary bound components */
853         struct list_head card_list;
854
855         struct snd_soc_dai_driver *dai_drv;
856         int num_dai;
857
858         const struct snd_soc_component_driver *driver;
859
860         struct list_head dai_list;
861
862         int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
863         int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
864
865         struct regmap *regmap;
866         int val_bytes;
867
868         struct mutex io_mutex;
869
870         /* attached dynamic objects */
871         struct list_head dobj_list;
872
873 #ifdef CONFIG_DEBUG_FS
874         struct dentry *debugfs_root;
875 #endif
876
877         /*
878         * DO NOT use any of the fields below in drivers, they are temporary and
879         * are going to be removed again soon. If you use them in driver code the
880         * driver will be marked as BROKEN when these fields are removed.
881         */
882
883         /* Don't use these, use snd_soc_component_get_dapm() */
884         struct snd_soc_dapm_context dapm;
885
886         struct snd_soc_codec *codec;
887
888         int (*probe)(struct snd_soc_component *);
889         void (*remove)(struct snd_soc_component *);
890         int (*suspend)(struct snd_soc_component *);
891         int (*resume)(struct snd_soc_component *);
892         int (*pcm_new)(struct snd_soc_component *, struct snd_soc_pcm_runtime *);
893         void (*pcm_free)(struct snd_soc_component *, struct snd_pcm *);
894
895         int (*set_sysclk)(struct snd_soc_component *component,
896                           int clk_id, int source, unsigned int freq, int dir);
897         int (*set_pll)(struct snd_soc_component *component, int pll_id,
898                        int source, unsigned int freq_in, unsigned int freq_out);
899         int (*set_jack)(struct snd_soc_component *component,
900                         struct snd_soc_jack *jack,  void *data);
901         int (*set_bias_level)(struct snd_soc_component *component,
902                               enum snd_soc_bias_level level);
903
904         /* machine specific init */
905         int (*init)(struct snd_soc_component *component);
906
907 #ifdef CONFIG_DEBUG_FS
908         void (*init_debugfs)(struct snd_soc_component *component);
909         const char *debugfs_prefix;
910 #endif
911 };
912
913 struct snd_soc_rtdcom_list {
914         struct snd_soc_component *component;
915         struct list_head list; /* rtd::component_list */
916 };
917 struct snd_soc_component*
918 snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
919                        const char *driver_name);
920 #define for_each_rtdcom(rtd, rtdcom) \
921         list_for_each_entry(rtdcom, &(rtd)->component_list, list)
922 #define for_each_rtdcom_safe(rtd, rtdcom1, rtdcom2) \
923         list_for_each_entry_safe(rtdcom1, rtdcom2, &(rtd)->component_list, list)
924
925 /* SoC Audio Codec device */
926 struct snd_soc_codec {
927         struct device *dev;
928         const struct snd_soc_codec_driver *driver;
929
930         struct list_head list;
931
932         /* runtime */
933         unsigned int cache_init:1; /* codec cache has been initialized */
934
935         /* codec IO */
936         void *control_data; /* codec control (i2c/3wire) data */
937         hw_write_t hw_write;
938         void *reg_cache;
939
940         /* component */
941         struct snd_soc_component component;
942 };
943
944 /* codec driver */
945 struct snd_soc_codec_driver {
946
947         /* driver ops */
948         int (*probe)(struct snd_soc_codec *);
949         int (*remove)(struct snd_soc_codec *);
950         int (*suspend)(struct snd_soc_codec *);
951         int (*resume)(struct snd_soc_codec *);
952         struct snd_soc_component_driver component_driver;
953
954         /* codec wide operations */
955         int (*set_sysclk)(struct snd_soc_codec *codec,
956                           int clk_id, int source, unsigned int freq, int dir);
957         int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
958                 unsigned int freq_in, unsigned int freq_out);
959         int (*set_jack)(struct snd_soc_codec *codec,
960                         struct snd_soc_jack *jack,  void *data);
961
962         /* codec IO */
963         struct regmap *(*get_regmap)(struct device *);
964         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
965         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
966         unsigned int reg_cache_size;
967         short reg_cache_step;
968         short reg_word_size;
969         const void *reg_cache_default;
970
971         /* codec bias level */
972         int (*set_bias_level)(struct snd_soc_codec *,
973                               enum snd_soc_bias_level level);
974         bool idle_bias_off;
975         bool suspend_bias_off;
976
977         void (*seq_notifier)(struct snd_soc_dapm_context *,
978                              enum snd_soc_dapm_type, int);
979
980         bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
981 };
982
983 /* SoC platform interface */
984 struct snd_soc_platform_driver {
985
986         int (*probe)(struct snd_soc_platform *);
987         int (*remove)(struct snd_soc_platform *);
988         struct snd_soc_component_driver component_driver;
989
990         /* pcm creation and destruction */
991         int (*pcm_new)(struct snd_soc_pcm_runtime *);
992         void (*pcm_free)(struct snd_pcm *);
993
994         /* platform stream pcm ops */
995         const struct snd_pcm_ops *ops;
996
997         /* platform stream compress ops */
998         const struct snd_compr_ops *compr_ops;
999 };
1000
1001 struct snd_soc_dai_link_component {
1002         const char *name;
1003         struct device_node *of_node;
1004         const char *dai_name;
1005 };
1006
1007 struct snd_soc_platform {
1008         struct device *dev;
1009         const struct snd_soc_platform_driver *driver;
1010
1011         struct list_head list;
1012
1013         struct snd_soc_component component;
1014 };
1015
1016 struct snd_soc_dai_link {
1017         /* config - must be set by machine driver */
1018         const char *name;                       /* Codec name */
1019         const char *stream_name;                /* Stream name */
1020         /*
1021          * You MAY specify the link's CPU-side device, either by device name,
1022          * or by DT/OF node, but not both. If this information is omitted,
1023          * the CPU-side DAI is matched using .cpu_dai_name only, which hence
1024          * must be globally unique. These fields are currently typically used
1025          * only for codec to codec links, or systems using device tree.
1026          */
1027         const char *cpu_name;
1028         struct device_node *cpu_of_node;
1029         /*
1030          * You MAY specify the DAI name of the CPU DAI. If this information is
1031          * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
1032          * only, which only works well when that device exposes a single DAI.
1033          */
1034         const char *cpu_dai_name;
1035         /*
1036          * You MUST specify the link's codec, either by device name, or by
1037          * DT/OF node, but not both.
1038          */
1039         const char *codec_name;
1040         struct device_node *codec_of_node;
1041         /* You MUST specify the DAI name within the codec */
1042         const char *codec_dai_name;
1043
1044         struct snd_soc_dai_link_component *codecs;
1045         unsigned int num_codecs;
1046
1047         /*
1048          * You MAY specify the link's platform/PCM/DMA driver, either by
1049          * device name, or by DT/OF node, but not both. Some forms of link
1050          * do not need a platform.
1051          */
1052         const char *platform_name;
1053         struct device_node *platform_of_node;
1054         int id; /* optional ID for machine driver link identification */
1055
1056         const struct snd_soc_pcm_stream *params;
1057         unsigned int num_params;
1058
1059         unsigned int dai_fmt;           /* format to set on init */
1060
1061         enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
1062
1063         /* codec/machine specific init - e.g. add machine controls */
1064         int (*init)(struct snd_soc_pcm_runtime *rtd);
1065
1066         /* optional hw_params re-writing for BE and FE sync */
1067         int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
1068                         struct snd_pcm_hw_params *params);
1069
1070         /* machine stream operations */
1071         const struct snd_soc_ops *ops;
1072         const struct snd_soc_compr_ops *compr_ops;
1073
1074         /* Mark this pcm with non atomic ops */
1075         bool nonatomic;
1076
1077         /* For unidirectional dai links */
1078         unsigned int playback_only:1;
1079         unsigned int capture_only:1;
1080
1081         /* Keep DAI active over suspend */
1082         unsigned int ignore_suspend:1;
1083
1084         /* Symmetry requirements */
1085         unsigned int symmetric_rates:1;
1086         unsigned int symmetric_channels:1;
1087         unsigned int symmetric_samplebits:1;
1088
1089         /* Do not create a PCM for this DAI link (Backend link) */
1090         unsigned int no_pcm:1;
1091
1092         /* This DAI link can route to other DAI links at runtime (Frontend)*/
1093         unsigned int dynamic:1;
1094
1095         /* DPCM capture and Playback support */
1096         unsigned int dpcm_capture:1;
1097         unsigned int dpcm_playback:1;
1098
1099         /* DPCM used FE & BE merged format */
1100         unsigned int dpcm_merged_format:1;
1101
1102         /* pmdown_time is ignored at stop */
1103         unsigned int ignore_pmdown_time:1;
1104
1105         struct list_head list; /* DAI link list of the soc card */
1106         struct snd_soc_dobj dobj; /* For topology */
1107 };
1108
1109 struct snd_soc_codec_conf {
1110         /*
1111          * specify device either by device name, or by
1112          * DT/OF node, but not both.
1113          */
1114         const char *dev_name;
1115         struct device_node *of_node;
1116
1117         /*
1118          * optional map of kcontrol, widget and path name prefixes that are
1119          * associated per device
1120          */
1121         const char *name_prefix;
1122 };
1123
1124 struct snd_soc_aux_dev {
1125         const char *name;               /* Codec name */
1126
1127         /*
1128          * specify multi-codec either by device name, or by
1129          * DT/OF node, but not both.
1130          */
1131         const char *codec_name;
1132         struct device_node *codec_of_node;
1133
1134         /* codec/machine specific init - e.g. add machine controls */
1135         int (*init)(struct snd_soc_component *component);
1136 };
1137
1138 /* SoC card */
1139 struct snd_soc_card {
1140         const char *name;
1141         const char *long_name;
1142         const char *driver_name;
1143         char dmi_longname[80];
1144
1145         struct device *dev;
1146         struct snd_card *snd_card;
1147         struct module *owner;
1148
1149         struct mutex mutex;
1150         struct mutex dapm_mutex;
1151
1152         bool instantiated;
1153
1154         int (*probe)(struct snd_soc_card *card);
1155         int (*late_probe)(struct snd_soc_card *card);
1156         int (*remove)(struct snd_soc_card *card);
1157
1158         /* the pre and post PM functions are used to do any PM work before and
1159          * after the codec and DAI's do any PM work. */
1160         int (*suspend_pre)(struct snd_soc_card *card);
1161         int (*suspend_post)(struct snd_soc_card *card);
1162         int (*resume_pre)(struct snd_soc_card *card);
1163         int (*resume_post)(struct snd_soc_card *card);
1164
1165         /* callbacks */
1166         int (*set_bias_level)(struct snd_soc_card *,
1167                               struct snd_soc_dapm_context *dapm,
1168                               enum snd_soc_bias_level level);
1169         int (*set_bias_level_post)(struct snd_soc_card *,
1170                                    struct snd_soc_dapm_context *dapm,
1171                                    enum snd_soc_bias_level level);
1172
1173         int (*add_dai_link)(struct snd_soc_card *,
1174                             struct snd_soc_dai_link *link);
1175         void (*remove_dai_link)(struct snd_soc_card *,
1176                             struct snd_soc_dai_link *link);
1177
1178         long pmdown_time;
1179
1180         /* CPU <--> Codec DAI links  */
1181         struct snd_soc_dai_link *dai_link;  /* predefined links only */
1182         int num_links;  /* predefined links only */
1183         struct list_head dai_link_list; /* all links */
1184         int num_dai_links;
1185
1186         struct list_head rtd_list;
1187         int num_rtd;
1188
1189         /* optional codec specific configuration */
1190         struct snd_soc_codec_conf *codec_conf;
1191         int num_configs;
1192
1193         /*
1194          * optional auxiliary devices such as amplifiers or codecs with DAI
1195          * link unused
1196          */
1197         struct snd_soc_aux_dev *aux_dev;
1198         int num_aux_devs;
1199         struct list_head aux_comp_list;
1200
1201         const struct snd_kcontrol_new *controls;
1202         int num_controls;
1203
1204         /*
1205          * Card-specific routes and widgets.
1206          * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1207          */
1208         const struct snd_soc_dapm_widget *dapm_widgets;
1209         int num_dapm_widgets;
1210         const struct snd_soc_dapm_route *dapm_routes;
1211         int num_dapm_routes;
1212         const struct snd_soc_dapm_widget *of_dapm_widgets;
1213         int num_of_dapm_widgets;
1214         const struct snd_soc_dapm_route *of_dapm_routes;
1215         int num_of_dapm_routes;
1216         bool fully_routed;
1217
1218         struct work_struct deferred_resume_work;
1219
1220         /* lists of probed devices belonging to this card */
1221         struct list_head component_dev_list;
1222
1223         struct list_head widgets;
1224         struct list_head paths;
1225         struct list_head dapm_list;
1226         struct list_head dapm_dirty;
1227
1228         /* attached dynamic objects */
1229         struct list_head dobj_list;
1230
1231         /* Generic DAPM context for the card */
1232         struct snd_soc_dapm_context dapm;
1233         struct snd_soc_dapm_stats dapm_stats;
1234         struct snd_soc_dapm_update *update;
1235
1236 #ifdef CONFIG_DEBUG_FS
1237         struct dentry *debugfs_card_root;
1238         struct dentry *debugfs_pop_time;
1239 #endif
1240         u32 pop_time;
1241
1242         void *drvdata;
1243 };
1244
1245 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
1246 struct snd_soc_pcm_runtime {
1247         struct device *dev;
1248         struct snd_soc_card *card;
1249         struct snd_soc_dai_link *dai_link;
1250         struct mutex pcm_mutex;
1251         enum snd_soc_pcm_subclass pcm_subclass;
1252         struct snd_pcm_ops ops;
1253
1254         /* Dynamic PCM BE runtime data */
1255         struct snd_soc_dpcm_runtime dpcm[2];
1256         int fe_compr;
1257
1258         long pmdown_time;
1259
1260         /* runtime devices */
1261         struct snd_pcm *pcm;
1262         struct snd_compr *compr;
1263         struct snd_soc_codec *codec;
1264         struct snd_soc_platform *platform; /* will be removed */
1265         struct snd_soc_dai *codec_dai;
1266         struct snd_soc_dai *cpu_dai;
1267
1268         struct snd_soc_dai **codec_dais;
1269         unsigned int num_codecs;
1270
1271         struct delayed_work delayed_work;
1272 #ifdef CONFIG_DEBUG_FS
1273         struct dentry *debugfs_dpcm_root;
1274 #endif
1275
1276         unsigned int num; /* 0-based and monotonic increasing */
1277         struct list_head list; /* rtd list of the soc card */
1278         struct list_head component_list; /* list of connected components */
1279
1280         /* bit field */
1281         unsigned int dev_registered:1;
1282         unsigned int pop_wait:1;
1283 };
1284
1285 /* mixer control */
1286 struct soc_mixer_control {
1287         int min, max, platform_max;
1288         int reg, rreg;
1289         unsigned int shift, rshift;
1290         unsigned int sign_bit;
1291         unsigned int invert:1;
1292         unsigned int autodisable:1;
1293         struct snd_soc_dobj dobj;
1294 };
1295
1296 struct soc_bytes {
1297         int base;
1298         int num_regs;
1299         u32 mask;
1300 };
1301
1302 struct soc_bytes_ext {
1303         int max;
1304         struct snd_soc_dobj dobj;
1305
1306         /* used for TLV byte control */
1307         int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1308                         unsigned int size);
1309         int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1310                         unsigned int size);
1311 };
1312
1313 /* multi register control */
1314 struct soc_mreg_control {
1315         long min, max;
1316         unsigned int regbase, regcount, nbits, invert;
1317 };
1318
1319 /* enumerated kcontrol */
1320 struct soc_enum {
1321         int reg;
1322         unsigned char shift_l;
1323         unsigned char shift_r;
1324         unsigned int items;
1325         unsigned int mask;
1326         const char * const *texts;
1327         const unsigned int *values;
1328         unsigned int autodisable:1;
1329         struct snd_soc_dobj dobj;
1330 };
1331
1332 /**
1333  * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1334  * @component: The component to cast to a CODEC
1335  *
1336  * This function must only be used on components that are known to be CODECs.
1337  * Otherwise the behavior is undefined.
1338  */
1339 static inline struct snd_soc_codec *snd_soc_component_to_codec(
1340         struct snd_soc_component *component)
1341 {
1342         return container_of(component, struct snd_soc_codec, component);
1343 }
1344
1345 /**
1346  * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1347  * @component: The component to cast to a platform
1348  *
1349  * This function must only be used on components that are known to be platforms.
1350  * Otherwise the behavior is undefined.
1351  */
1352 static inline struct snd_soc_platform *snd_soc_component_to_platform(
1353         struct snd_soc_component *component)
1354 {
1355         return container_of(component, struct snd_soc_platform, component);
1356 }
1357
1358 /**
1359  * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1360  *  embedded in
1361  * @dapm: The DAPM context to cast to the component
1362  *
1363  * This function must only be used on DAPM contexts that are known to be part of
1364  * a component (e.g. in a component driver). Otherwise the behavior is
1365  * undefined.
1366  */
1367 static inline struct snd_soc_component *snd_soc_dapm_to_component(
1368         struct snd_soc_dapm_context *dapm)
1369 {
1370         return container_of(dapm, struct snd_soc_component, dapm);
1371 }
1372
1373 /**
1374  * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1375  * @dapm: The DAPM context to cast to the CODEC
1376  *
1377  * This function must only be used on DAPM contexts that are known to be part of
1378  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1379  */
1380 static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1381         struct snd_soc_dapm_context *dapm)
1382 {
1383         return snd_soc_component_to_codec(snd_soc_dapm_to_component(dapm));
1384 }
1385
1386 /**
1387  * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1388  *  embedded in
1389  * @dapm: The DAPM context to cast to the platform.
1390  *
1391  * This function must only be used on DAPM contexts that are known to be part of
1392  * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1393  */
1394 static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1395         struct snd_soc_dapm_context *dapm)
1396 {
1397         return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
1398 }
1399
1400 /**
1401  * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1402  *  component
1403  * @component: The component for which to get the DAPM context
1404  */
1405 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1406         struct snd_soc_component *component)
1407 {
1408         return &component->dapm;
1409 }
1410
1411 /**
1412  * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC
1413  * @codec: The CODEC for which to get the DAPM context
1414  *
1415  * Note: Use this function instead of directly accessing the CODEC's dapm field
1416  */
1417 static inline struct snd_soc_dapm_context *snd_soc_codec_get_dapm(
1418         struct snd_soc_codec *codec)
1419 {
1420         return snd_soc_component_get_dapm(&codec->component);
1421 }
1422
1423 /**
1424  * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level
1425  * @codec: The CODEC for which to initialize the DAPM bias level
1426  * @level: The DAPM level to initialize to
1427  *
1428  * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level().
1429  */
1430 static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec *codec,
1431         enum snd_soc_bias_level level)
1432 {
1433         snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec), level);
1434 }
1435
1436 /**
1437  * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level
1438  * @codec: The CODEC for which to get the DAPM bias level
1439  *
1440  * Returns: The current DAPM bias level of the CODEC.
1441  */
1442 static inline enum snd_soc_bias_level snd_soc_codec_get_bias_level(
1443         struct snd_soc_codec *codec)
1444 {
1445         return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec));
1446 }
1447
1448 /**
1449  * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level
1450  * @codec: The CODEC for which to set the level
1451  * @level: The level to set to
1452  *
1453  * Forces the CODEC bias level to a specific state. See
1454  * snd_soc_dapm_force_bias_level().
1455  */
1456 static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec *codec,
1457         enum snd_soc_bias_level level)
1458 {
1459         return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec),
1460                 level);
1461 }
1462
1463 /**
1464  * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1465  * @kcontrol: The kcontrol
1466  *
1467  * This function must only be used on DAPM contexts that are known to be part of
1468  * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1469  */
1470 static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(
1471         struct snd_kcontrol *kcontrol)
1472 {
1473         return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol));
1474 }
1475
1476 /* codec IO */
1477 unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1478 int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1479         unsigned int val);
1480
1481 /**
1482  * snd_soc_cache_sync() - Sync the register cache with the hardware
1483  * @codec: CODEC to sync
1484  *
1485  * Note: This function will call regcache_sync()
1486  */
1487 static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1488 {
1489         return regcache_sync(codec->component.regmap);
1490 }
1491
1492 /* component IO */
1493 int snd_soc_component_read(struct snd_soc_component *component,
1494         unsigned int reg, unsigned int *val);
1495 int snd_soc_component_write(struct snd_soc_component *component,
1496         unsigned int reg, unsigned int val);
1497 int snd_soc_component_update_bits(struct snd_soc_component *component,
1498         unsigned int reg, unsigned int mask, unsigned int val);
1499 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1500         unsigned int reg, unsigned int mask, unsigned int val);
1501 void snd_soc_component_async_complete(struct snd_soc_component *component);
1502 int snd_soc_component_test_bits(struct snd_soc_component *component,
1503         unsigned int reg, unsigned int mask, unsigned int value);
1504
1505 /* component wide operations */
1506 int snd_soc_component_set_sysclk(struct snd_soc_component *component,
1507                         int clk_id, int source, unsigned int freq, int dir);
1508 int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id,
1509                               int source, unsigned int freq_in,
1510                               unsigned int freq_out);
1511 int snd_soc_component_set_jack(struct snd_soc_component *component,
1512                                struct snd_soc_jack *jack, void *data);
1513
1514 #ifdef CONFIG_REGMAP
1515
1516 void snd_soc_component_init_regmap(struct snd_soc_component *component,
1517         struct regmap *regmap);
1518 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1519
1520 /**
1521  * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1522  * @codec: The CODEC for which to initialize the regmap instance
1523  * @regmap: The regmap instance that should be used by the CODEC
1524  *
1525  * This function allows deferred assignment of the regmap instance that is
1526  * associated with the CODEC. Only use this if the regmap instance is not yet
1527  * ready when the CODEC is registered. The function must also be called before
1528  * the first IO attempt of the CODEC.
1529  */
1530 static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1531         struct regmap *regmap)
1532 {
1533         snd_soc_component_init_regmap(&codec->component, regmap);
1534 }
1535
1536 /**
1537  * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1538  * @codec: The CODEC for which to de-initialize the regmap instance
1539  *
1540  * Calls regmap_exit() on the regmap instance associated to the CODEC and
1541  * removes the regmap instance from the CODEC.
1542  *
1543  * This function should only be used if snd_soc_codec_init_regmap() was used to
1544  * initialize the regmap instance.
1545  */
1546 static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1547 {
1548         snd_soc_component_exit_regmap(&codec->component);
1549 }
1550
1551 #endif
1552
1553 /* device driver data */
1554
1555 static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1556                 void *data)
1557 {
1558         card->drvdata = data;
1559 }
1560
1561 static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1562 {
1563         return card->drvdata;
1564 }
1565
1566 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1567                 void *data)
1568 {
1569         dev_set_drvdata(c->dev, data);
1570 }
1571
1572 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1573 {
1574         return dev_get_drvdata(c->dev);
1575 }
1576
1577 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1578                 void *data)
1579 {
1580         snd_soc_component_set_drvdata(&codec->component, data);
1581 }
1582
1583 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1584 {
1585         return snd_soc_component_get_drvdata(&codec->component);
1586 }
1587
1588 static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1589                 void *data)
1590 {
1591         snd_soc_component_set_drvdata(&platform->component, data);
1592 }
1593
1594 static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1595 {
1596         return snd_soc_component_get_drvdata(&platform->component);
1597 }
1598
1599 static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1600 {
1601         INIT_LIST_HEAD(&card->widgets);
1602         INIT_LIST_HEAD(&card->paths);
1603         INIT_LIST_HEAD(&card->dapm_list);
1604         INIT_LIST_HEAD(&card->aux_comp_list);
1605         INIT_LIST_HEAD(&card->component_dev_list);
1606 }
1607
1608 static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1609 {
1610         if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1611                 return 0;
1612         /*
1613          * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1614          * mc->reg != mc->rreg means that the control is
1615          * stereo (bits in one register or in two registers)
1616          */
1617         return 1;
1618 }
1619
1620 static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1621         unsigned int val)
1622 {
1623         unsigned int i;
1624
1625         if (!e->values)
1626                 return val;
1627
1628         for (i = 0; i < e->items; i++)
1629                 if (val == e->values[i])
1630                         return i;
1631
1632         return 0;
1633 }
1634
1635 static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1636         unsigned int item)
1637 {
1638         if (!e->values)
1639                 return item;
1640
1641         return e->values[item];
1642 }
1643
1644 static inline bool snd_soc_component_is_active(
1645         struct snd_soc_component *component)
1646 {
1647         return component->active != 0;
1648 }
1649
1650 static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1651 {
1652         return snd_soc_component_is_active(&codec->component);
1653 }
1654
1655 /**
1656  * snd_soc_kcontrol_component() - Returns the component that registered the
1657  *  control
1658  * @kcontrol: The control for which to get the component
1659  *
1660  * Note: This function will work correctly if the control has been registered
1661  * for a component. Either with snd_soc_add_codec_controls() or
1662  * snd_soc_add_platform_controls() or via  table based setup for either a
1663  * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1664  */
1665 static inline struct snd_soc_component *snd_soc_kcontrol_component(
1666         struct snd_kcontrol *kcontrol)
1667 {
1668         return snd_kcontrol_chip(kcontrol);
1669 }
1670
1671 /**
1672  * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1673  * @kcontrol: The control for which to get the CODEC
1674  *
1675  * Note: This function will only work correctly if the control has been
1676  * registered with snd_soc_add_codec_controls() or via table based setup of
1677  * snd_soc_codec_driver. Otherwise the behavior is undefined.
1678  */
1679 static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1680         struct snd_kcontrol *kcontrol)
1681 {
1682         return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
1683 }
1684
1685 /**
1686  * snd_soc_kcontrol_platform() - Returns the platform that registered the control
1687  * @kcontrol: The control for which to get the platform
1688  *
1689  * Note: This function will only work correctly if the control has been
1690  * registered with snd_soc_add_platform_controls() or via table based setup of
1691  * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1692  */
1693 static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
1694         struct snd_kcontrol *kcontrol)
1695 {
1696         return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
1697 }
1698
1699 int snd_soc_util_init(void);
1700 void snd_soc_util_exit(void);
1701
1702 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1703                                const char *propname);
1704 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1705                                           const char *propname);
1706 int snd_soc_of_parse_tdm_slot(struct device_node *np,
1707                               unsigned int *tx_mask,
1708                               unsigned int *rx_mask,
1709                               unsigned int *slots,
1710                               unsigned int *slot_width);
1711 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1712                                    struct snd_soc_codec_conf *codec_conf,
1713                                    struct device_node *of_node,
1714                                    const char *propname);
1715 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1716                                    const char *propname);
1717 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1718                                      const char *prefix,
1719                                      struct device_node **bitclkmaster,
1720                                      struct device_node **framemaster);
1721 int snd_soc_get_dai_id(struct device_node *ep);
1722 int snd_soc_get_dai_name(struct of_phandle_args *args,
1723                          const char **dai_name);
1724 int snd_soc_of_get_dai_name(struct device_node *of_node,
1725                             const char **dai_name);
1726 int snd_soc_of_get_dai_link_codecs(struct device *dev,
1727                                    struct device_node *of_node,
1728                                    struct snd_soc_dai_link *dai_link);
1729
1730 int snd_soc_add_dai_link(struct snd_soc_card *card,
1731                                 struct snd_soc_dai_link *dai_link);
1732 void snd_soc_remove_dai_link(struct snd_soc_card *card,
1733                              struct snd_soc_dai_link *dai_link);
1734 struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
1735                                                int id, const char *name,
1736                                                const char *stream_name);
1737
1738 int snd_soc_register_dai(struct snd_soc_component *component,
1739         struct snd_soc_dai_driver *dai_drv);
1740
1741 struct snd_soc_dai *snd_soc_find_dai(
1742         const struct snd_soc_dai_link_component *dlc);
1743
1744 #include <sound/soc-dai.h>
1745
1746 #ifdef CONFIG_DEBUG_FS
1747 extern struct dentry *snd_soc_debugfs_root;
1748 #endif
1749
1750 extern const struct dev_pm_ops snd_soc_pm_ops;
1751
1752 /* Helper functions */
1753 static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1754 {
1755         mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1756 }
1757
1758 static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1759 {
1760         mutex_unlock(&dapm->card->dapm_mutex);
1761 }
1762
1763 int snd_soc_component_enable_pin(struct snd_soc_component *component,
1764                                  const char *pin);
1765 int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component,
1766                                           const char *pin);
1767 int snd_soc_component_disable_pin(struct snd_soc_component *component,
1768                                   const char *pin);
1769 int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component,
1770                                            const char *pin);
1771 int snd_soc_component_nc_pin(struct snd_soc_component *component,
1772                              const char *pin);
1773 int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component,
1774                                       const char *pin);
1775 int snd_soc_component_get_pin_status(struct snd_soc_component *component,
1776                                      const char *pin);
1777 int snd_soc_component_force_enable_pin(struct snd_soc_component *component,
1778                                        const char *pin);
1779 int snd_soc_component_force_enable_pin_unlocked(
1780                                         struct snd_soc_component *component,
1781                                         const char *pin);
1782
1783 #endif