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