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