blob: 4f1c784e44f634016153b3ff4f0a1b7d3b652b95 [file] [log] [blame]
Richard Purdie808db4a2006-10-06 18:20:14 +02001/*
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
Kuninori Morimotocb470082013-09-10 17:39:56 -070016#include <linux/of.h>
Richard Purdie808db4a2006-10-06 18:20:14 +020017#include <linux/platform_device.h>
18#include <linux/types.h>
Mark Brownd5021ec2010-03-22 12:06:30 +000019#include <linux/notifier.h>
Andrew Morton4484bb22006-12-15 09:30:07 +010020#include <linux/workqueue.h>
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -060021#include <linux/interrupt.h>
22#include <linux/kernel.h>
Mark Brownbe3ea3b2011-06-13 19:35:29 +010023#include <linux/regmap.h>
Lars-Peter Clausen86767b72012-09-14 13:57:27 +020024#include <linux/log2.h>
Richard Purdie808db4a2006-10-06 18:20:14 +020025#include <sound/core.h>
26#include <sound/pcm.h>
Vinod Koul49681072012-08-16 17:10:40 +053027#include <sound/compress_driver.h>
Richard Purdie808db4a2006-10-06 18:20:14 +020028#include <sound/control.h>
29#include <sound/ac97_codec.h>
30
Richard Purdie808db4a2006-10-06 18:20:14 +020031/*
32 * Convenience kcontrol builders
33 */
Lars-Peter Clausen57295072013-08-05 11:27:31 +020034#define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
Jon Smirl4eaa9812008-07-29 11:42:26 +010035 ((unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusi30d86ba2011-10-05 10:29:22 +030036 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
37 .rshift = shift_right, .max = xmax, .platform_max = xmax, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +020038 .invert = xinvert, .autodisable = xautodisable})
Lars-Peter Clausenc1b4d1c2014-10-25 20:25:56 +020039#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})
Lars-Peter Clausen57295072013-08-05 11:27:31 +020044#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
45 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
Jon Smirl4eaa9812008-07-29 11:42:26 +010046#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
47 ((unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030048 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
Peter Ujfalusicdffa772011-10-04 14:39:39 +030049#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})
Markus Pargmanncd21b122014-01-16 16:02:11 +010053#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})
Mark Brown229e3fd2012-06-22 11:40:55 +010058#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})
Philipp Zabela7a4ac82008-01-10 14:37:42 +010062#define SOC_SINGLE(xname, reg, shift, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020063{ .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, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +020066 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
Adam Thomson6c9d8cf2012-05-31 15:18:01 +010067#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) \
Mark Brown9bde4f02012-12-19 16:05:00 +000072 {.reg = xreg, .rreg = xreg, .shift = xshift, \
73 .rshift = xshift, .min = xmin, .max = xmax, \
74 .platform_max = xmax, .invert = xinvert} }
Philipp Zabela7a4ac82008-01-10 14:37:42 +010075#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, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +020082 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
Brian Austin1d99f242012-03-30 10:43:55 -050083#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),\
Charles Keepax34198712015-10-14 13:31:24 +010088 .info = snd_soc_info_volsw_sx, \
Brian Austin1d99f242012-03-30 10:43:55 -050089 .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} }
Adam Thomson6c9d8cf2012-05-31 15:18:01 +010095#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) \
Mark Brown9bde4f02012-12-19 16:05:00 +0000103 {.reg = xreg, .rreg = xreg, .shift = xshift, \
104 .rshift = xshift, .min = xmin, .max = xmax, \
105 .platform_max = xmax, .invert = xinvert} }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300106#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +0200107{ .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, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300110 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200111 max, invert, 0) }
Damien.Horsleyd13871b2015-12-08 15:58:58 +0000112#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) }
Jon Smirl4eaa9812008-07-29 11:42:26 +0100120#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
Richard Purdie808db4a2006-10-06 18:20:14 +0200121{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300122 .info = snd_soc_info_volsw, \
Peter Ujfalusi974815b2011-10-05 10:29:25 +0300123 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300124 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
125 xmax, xinvert) }
Mark Brown229e3fd2012-06-22 11:40:55 +0100126#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) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300133#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100134{ .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, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300140 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200141 max, invert, 0) }
Jon Smirl4eaa9812008-07-29 11:42:26 +0100142#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100143{ .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), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300147 .info = snd_soc_info_volsw, \
Peter Ujfalusi974815b2011-10-05 10:29:25 +0300148 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300149 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
150 xmax, xinvert) }
Mark Brown229e3fd2012-06-22 11:40:55 +0100151#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) }
Brian Austin1d99f242012-03-30 10:43:55 -0500161#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), \
Charles Keepax34198712015-10-14 13:31:24 +0100166 .info = snd_soc_info_volsw_sx, \
Brian Austin1d99f242012-03-30 10:43:55 -0500167 .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} }
Markus Pargmanncd21b122014-01-16 16:02:11 +0100173#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) }
Srinivas Kandagatladcc07992016-05-27 14:45:45 +0100182#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,} }
Jon Smirl4eaa9812008-07-29 11:42:26 +0100193#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
Mark Browne13ac2e2008-05-28 17:58:05 +0100194{ .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), \
Lars-Peter Clausenc1b4d1c2014-10-25 20:25:56 +0200198 .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) }
Takashi Iwai9a8d38d2014-02-18 08:11:42 +0100201#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
Richard Purdie808db4a2006-10-06 18:20:14 +0200202{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
Takashi Iwai9a8d38d2014-02-18 08:11:42 +0100203 .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) \
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200210{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
Takashi Iwai9a8d38d2014-02-18 08:11:42 +0100211 .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
Charles Keepax5967cb32015-05-01 12:37:23 +0100212#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
213 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
Charles Keepax561ed682015-05-01 12:37:26 +0100214#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}
Lars-Peter Clausenb9488372014-02-28 08:31:05 +0100218#define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
219 SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
Richard Purdie808db4a2006-10-06 18:20:14 +0200220#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 }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100225#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
Richard Purdie808db4a2006-10-06 18:20:14 +0200226 xhandler_get, xhandler_put) \
227{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100228 .info = snd_soc_info_volsw, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200229 .get = xhandler_get, .put = xhandler_put, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200230 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300231#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
Daniel Mack7629ad22009-04-24 16:37:44 +0200232 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, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300236 .private_value = \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200237 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
Adam Thomsonc25c79b2015-09-29 16:43:56 +0100238#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) }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100245#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
Mike Montour10144c02008-06-11 13:47:13 +0100246 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, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200253 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
Charles Keepaxa54e22f2015-09-16 13:59:42 +0100254#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} }
Joonyoung Shimd0af93d2009-07-15 20:33:47 +0900266#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, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300274 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200275 xmax, xinvert, 0) }
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900276#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), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300282 .info = snd_soc_info_volsw, \
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900283 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300284 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
285 xmax, xinvert) }
Richard Purdie808db4a2006-10-06 18:20:14 +0200286#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, \
Lars-Peter Clausen9a953e62013-08-10 21:33:10 +0200293 .info = snd_soc_info_enum_double, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200294 .get = xhandler_get, .put = xhandler_put, \
295 .private_value = (unsigned long)&xenum }
Richard Fitzgerald1e4c0d72014-07-07 13:16:54 +0100296#define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
297 SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
Richard Purdie808db4a2006-10-06 18:20:14 +0200298
Mark Brown71d08512011-10-10 18:31:26 +0100299#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 }) }
apatard@mandriva.comb6f4bb32010-05-15 17:30:01 +0200305
Mark Brownf831b052012-02-17 16:20:33 -0800306#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
Vinod Koul50a4f982015-11-23 21:22:29 +0530314/*
315 * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead
316 */
Vinod Kould9881202014-05-02 10:58:11 +0530317#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} }
Omair Mohammed Abdullah7523a272014-07-15 21:34:48 +0530323#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), \
Subhransu S. Prusty4d61b392014-08-18 14:53:03 +0530328 .info = snd_soc_bytes_info_ext, \
Omair Mohammed Abdullah7523a272014-07-15 21:34:48 +0530329 .private_value = (unsigned long)&(struct soc_bytes_ext) \
330 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
Kristoffer KARLSSON4183eed22012-04-20 11:32:13 +0200331#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
Kristoffer KARLSSONdd7b10b2012-04-20 11:32:44 +0200340#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
Richard Purdie808db4a2006-10-06 18:20:14 +0200344/*
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100345 * 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) \
Takashi Iwai2e7e1992014-02-18 09:08:51 +0100349 const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100350 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) \
Takashi Iwai2e7e1992014-02-18 09:08:51 +0100354 const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100355#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
Takashi Iwai2e7e1992014-02-18 09:08:51 +0100356 const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100357 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)
Charles Keepax561ed682015-05-01 12:37:26 +0100360
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
Lars-Peter Clausenb9488372014-02-28 08:31:05 +0100365#define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
366 const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100367
368/*
Liam Girdwood0168bf02011-06-07 16:08:05 +0100369 * 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/*
Mark Brown0be98982008-05-19 12:31:28 +0200379 * 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 */
389enum snd_soc_bias_level {
Mark Brown56fba412011-06-04 11:25:10 +0100390 SND_SOC_BIAS_OFF = 0,
391 SND_SOC_BIAS_STANDBY = 1,
392 SND_SOC_BIAS_PREPARE = 2,
393 SND_SOC_BIAS_ON = 3,
Mark Brown0be98982008-05-19 12:31:28 +0200394};
395
Stephen Warren5a504962011-12-21 10:40:59 -0700396struct device_node;
Mark Brown8a2cd612009-01-07 17:31:10 +0000397struct snd_jack;
398struct snd_soc_card;
Richard Purdie808db4a2006-10-06 18:20:14 +0200399struct snd_soc_pcm_stream;
400struct snd_soc_ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200401struct snd_soc_pcm_runtime;
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100402struct snd_soc_dai;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000403struct snd_soc_dai_driver;
Mark Brown12a48a8c2008-12-03 19:40:30 +0000404struct snd_soc_platform;
jassi brard273ebe2010-02-22 15:58:04 +0900405struct snd_soc_dai_link;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000406struct snd_soc_platform_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200407struct snd_soc_codec;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000408struct snd_soc_codec_driver;
Kuninori Morimoto030e79f2013-03-11 18:27:21 -0700409struct snd_soc_component;
410struct snd_soc_component_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200411struct soc_enum;
Mark Brown8a2cd612009-01-07 17:31:10 +0000412struct snd_soc_jack;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530413struct snd_soc_jack_zone;
Mark Brown8a2cd612009-01-07 17:31:10 +0000414struct snd_soc_jack_pin;
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200415#include <sound/soc-dapm.h>
Liam Girdwood01d75842012-04-25 12:12:49 +0100416#include <sound/soc-dpcm.h>
Mengdong Lin64527e82016-01-15 16:13:28 +0800417#include <sound/soc-topology.h>
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000418
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600419struct snd_soc_jack_gpio;
Richard Purdie808db4a2006-10-06 18:20:14 +0200420
421typedef int (*hw_write_t)(void *,const char* ,int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200422
Liam Girdwoodb8c0dab2011-06-09 17:04:39 +0100423enum snd_soc_pcm_subclass {
424 SND_SOC_PCM_CLASS_PCM = 0,
425 SND_SOC_PCM_CLASS_BE = 1,
426};
427
Liam Girdwood01b9d992012-03-07 10:38:25 +0000428enum snd_soc_card_subclass {
Liam Girdwood6874a912012-03-09 12:02:07 +0000429 SND_SOC_CARD_CLASS_INIT = 0,
430 SND_SOC_CARD_CLASS_RUNTIME = 1,
Liam Girdwood01b9d992012-03-07 10:38:25 +0000431};
432
Mark Brownec4ee522011-03-07 20:58:11 +0000433int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
Mark Brownda1c6ea2011-08-24 20:09:01 +0100434 int source, unsigned int freq, int dir);
Mark Brownec4ee522011-03-07 20:58:11 +0000435int 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
Vinod Koul70a7ca32011-01-14 19:22:48 +0530438int snd_soc_register_card(struct snd_soc_card *card);
439int snd_soc_unregister_card(struct snd_soc_card *card);
Mark Brown0e4ff5c2013-09-16 18:02:05 +0100440int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
Jie Yangaae013d2015-04-19 09:45:48 +0800441#ifdef CONFIG_PM_SLEEP
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000442int snd_soc_suspend(struct device *dev);
443int snd_soc_resume(struct device *dev);
Jie Yangaae013d2015-04-19 09:45:48 +0800444#else
445static inline int snd_soc_suspend(struct device *dev)
446{
447 return 0;
448}
449
450static inline int snd_soc_resume(struct device *dev)
451{
452 return 0;
453}
454#endif
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000455int snd_soc_poweroff(struct device *dev);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000456int snd_soc_register_platform(struct device *dev,
Lars-Peter Clausend79e57d2013-03-27 12:02:22 +0100457 const struct snd_soc_platform_driver *platform_drv);
Peter Ujfalusi8931bf62014-04-16 15:46:11 +0300458int devm_snd_soc_register_platform(struct device *dev,
459 const struct snd_soc_platform_driver *platform_drv);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000460void snd_soc_unregister_platform(struct device *dev);
Lars-Peter Clausen71a45cd2013-04-15 19:19:49 +0200461int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
462 const struct snd_soc_platform_driver *platform_drv);
463void snd_soc_remove_platform(struct snd_soc_platform *platform);
464struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000465int snd_soc_register_codec(struct device *dev,
Mark Brown001ae4c2010-12-02 16:21:08 +0000466 const struct snd_soc_codec_driver *codec_drv,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000467 struct snd_soc_dai_driver *dai_drv, int num_dai);
468void snd_soc_unregister_codec(struct device *dev);
Kuninori Morimoto030e79f2013-03-11 18:27:21 -0700469int snd_soc_register_component(struct device *dev,
470 const struct snd_soc_component_driver *cmpnt_drv,
471 struct snd_soc_dai_driver *dai_drv, int num_dai);
Mark Browna0b03a62013-09-04 20:37:34 +0100472int devm_snd_soc_register_component(struct device *dev,
473 const struct snd_soc_component_driver *cmpnt_drv,
474 struct snd_soc_dai_driver *dai_drv, int num_dai);
Kuninori Morimoto030e79f2013-03-11 18:27:21 -0700475void snd_soc_unregister_component(struct device *dev);
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000476int snd_soc_cache_init(struct snd_soc_codec *codec);
477int snd_soc_cache_exit(struct snd_soc_codec *codec);
Lars-Peter Clausen427d2042014-11-08 16:38:07 +0100478
Liam Girdwoodf1442bc2011-07-04 11:10:15 +0100479int snd_soc_platform_read(struct snd_soc_platform *platform,
480 unsigned int reg);
481int snd_soc_platform_write(struct snd_soc_platform *platform,
482 unsigned int reg, unsigned int val);
Mark Brown354a2142011-12-22 12:16:39 +0000483int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
Jie Yang6f0c4222015-10-13 23:41:00 +0800484#ifdef CONFIG_SND_SOC_COMPRESS
485int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
486#endif
Mark Brown12a48a8c2008-12-03 19:40:30 +0000487
Liam Girdwood47c88ff2012-04-25 12:12:53 +0100488struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
489 const char *dai_link, int stream);
490struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
491 const char *dai_link);
492
Lars-Peter Clausen208a1582014-03-05 13:17:42 +0100493bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
Lars-Peter Clausen24894b72014-03-05 13:17:43 +0100494void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
495void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
Lars-Peter Clausen208a1582014-03-05 13:17:42 +0100496
Lars-Peter Clausence64c8b2015-01-06 15:17:20 +0100497int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
498 unsigned int dai_fmt);
499
Mark Brown7aae8162009-11-10 16:08:04 +0000500/* Utility functions to get clock rates from various things */
501int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
502int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
Mark Brownc0fa59d2009-11-19 11:36:10 +0000503int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
Mark Brown7aae8162009-11-10 16:08:04 +0000504int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
505
Richard Purdie808db4a2006-10-06 18:20:14 +0200506/* set runtime hw params */
507int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
508 const struct snd_pcm_hardware *hw);
Richard Purdie808db4a2006-10-06 18:20:14 +0200509
Liam Girdwood07bf84a2012-04-25 12:12:52 +0100510int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
511 int cmd, struct snd_soc_platform *platform);
512
Benoit Cousson93e69582014-07-08 23:19:38 +0200513int soc_dai_hw_params(struct snd_pcm_substream *substream,
514 struct snd_pcm_hw_params *params,
515 struct snd_soc_dai *dai);
516
Mark Brown8a2cd612009-01-07 17:31:10 +0000517/* Jack reporting */
Lars-Peter Clausen97093992015-03-04 10:33:17 +0100518int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
519 struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
520 unsigned int num_pins);
521
Mark Brown8a2cd612009-01-07 17:31:10 +0000522void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
523int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
524 struct snd_soc_jack_pin *pins);
Mark Brownd5021ec2010-03-22 12:06:30 +0000525void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
526 struct notifier_block *nb);
527void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
528 struct notifier_block *nb);
Vinod Koulfa9879e2011-02-09 14:44:17 +0530529int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
530 struct snd_soc_jack_zone *zones);
531int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600532#ifdef CONFIG_GPIOLIB
533int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
534 struct snd_soc_jack_gpio *gpios);
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300535int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
536 struct snd_soc_jack *jack,
537 int count, struct snd_soc_jack_gpio *gpios);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600538void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
539 struct snd_soc_jack_gpio *gpios);
Takashi Iwai8778ac62013-11-21 15:55:06 +0100540#else
541static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
542 struct snd_soc_jack_gpio *gpios)
543{
544 return 0;
545}
546
Jarkko Nikulae6674872014-05-27 10:39:57 +0300547static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
548 struct snd_soc_jack *jack,
549 int count,
550 struct snd_soc_jack_gpio *gpios)
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300551{
552 return 0;
553}
554
Takashi Iwai8778ac62013-11-21 15:55:06 +0100555static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
556 struct snd_soc_jack_gpio *gpios)
557{
558}
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600559#endif
Mark Brown8a2cd612009-01-07 17:31:10 +0000560
Richard Purdie808db4a2006-10-06 18:20:14 +0200561/* codec register bit access */
Bard Liao1a390192014-04-08 11:18:10 +0800562int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300563 unsigned int mask, unsigned int value);
Mark Browndd1b3d52009-12-04 14:22:03 +0000564int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
Bard Liao1a390192014-04-08 11:18:10 +0800565 unsigned int reg, unsigned int mask,
Mark Browndd1b3d52009-12-04 14:22:03 +0000566 unsigned int value);
Bard Liao1a390192014-04-08 11:18:10 +0800567int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300568 unsigned int mask, unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200569
Lars-Peter Clausen336b8422014-11-10 22:41:46 +0100570#ifdef CONFIG_SND_SOC_AC97_BUS
Lars-Peter Clausen47e03942015-01-23 16:21:36 +0100571struct snd_ac97 *snd_soc_alloc_ac97_codec(struct snd_soc_codec *codec);
Lars-Peter Clausen7361fbe2015-07-21 21:53:01 +0200572struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
573 unsigned int id, unsigned int id_mask);
Lars-Peter Clausen358a8bb2014-11-10 22:41:53 +0100574void snd_soc_free_ac97_codec(struct snd_ac97 *ac97);
Richard Purdie808db4a2006-10-06 18:20:14 +0200575
Mark Brownb047e1c2013-06-26 12:45:59 +0100576int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
Markus Pargmann741a5092013-08-19 17:05:55 +0200577int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
578 struct platform_device *pdev);
Mark Brownb047e1c2013-06-26 12:45:59 +0100579
Lars-Peter Clausen336b8422014-11-10 22:41:46 +0100580extern struct snd_ac97_bus_ops *soc_ac97_ops;
Lars-Peter Clausen336b8422014-11-10 22:41:46 +0100581#else
Lars-Peter Clausen336b8422014-11-10 22:41:46 +0100582static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
583 struct platform_device *pdev)
584{
585 return 0;
586}
587
588static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
589{
590 return 0;
591}
592#endif
593
Richard Purdie808db4a2006-10-06 18:20:14 +0200594/*
595 *Controls
596 */
597struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
Mark Brown30565572012-02-16 17:07:42 -0800598 void *data, const char *long_name,
Mark Brownefb7ac32011-03-08 17:23:24 +0000599 const char *prefix);
Dimitris Papastamos4fefd692013-07-29 13:51:58 +0100600struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
601 const char *name);
Lars-Peter Clausen0f2780a2014-07-17 22:01:08 +0200602int snd_soc_add_component_controls(struct snd_soc_component *component,
603 const struct snd_kcontrol_new *controls, unsigned int num_controls);
Liam Girdwood022658b2012-02-03 17:43:09 +0000604int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
Lars-Peter Clausen0f2780a2014-07-17 22:01:08 +0200605 const struct snd_kcontrol_new *controls, unsigned int num_controls);
Liam Girdwooda491a5c2011-07-04 22:10:51 +0100606int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
Lars-Peter Clausen0f2780a2014-07-17 22:01:08 +0200607 const struct snd_kcontrol_new *controls, unsigned int num_controls);
Liam Girdwood022658b2012-02-03 17:43:09 +0000608int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
609 const struct snd_kcontrol_new *controls, int num_controls);
610int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
611 const struct snd_kcontrol_new *controls, int num_controls);
Richard Purdie808db4a2006-10-06 18:20:14 +0200612int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
613 struct snd_ctl_elem_info *uinfo);
Richard Purdie808db4a2006-10-06 18:20:14 +0200614int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
615 struct snd_ctl_elem_value *ucontrol);
616int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
617 struct snd_ctl_elem_value *ucontrol);
618int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
619 struct snd_ctl_elem_info *uinfo);
Charles Keepax34198712015-10-14 13:31:24 +0100620int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
621 struct snd_ctl_elem_info *uinfo);
Philipp Zabel392abe92008-05-13 14:03:40 +0200622#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
Richard Purdie808db4a2006-10-06 18:20:14 +0200623int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
624 struct snd_ctl_elem_value *ucontrol);
625int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
626 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusia92f1392011-10-06 07:43:21 +0300627#define snd_soc_get_volsw_2r snd_soc_get_volsw
628#define snd_soc_put_volsw_2r snd_soc_put_volsw
Brian Austin1d99f242012-03-30 10:43:55 -0500629int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
630 struct snd_ctl_elem_value *ucontrol);
631int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
632 struct snd_ctl_elem_value *ucontrol);
Adam Thomson6c9d8cf2012-05-31 15:18:01 +0100633int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
634 struct snd_ctl_elem_info *uinfo);
635int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
636 struct snd_ctl_elem_value *ucontrol);
637int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
638 struct snd_ctl_elem_value *ucontrol);
Lars-Peter Clausen26d9ca32015-10-18 17:04:33 +0200639int snd_soc_limit_volume(struct snd_soc_card *card,
Peter Ujfalusi637d3842010-05-07 14:05:49 +0300640 const char *name, int max);
Mark Brown71d08512011-10-10 18:31:26 +0100641int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
642 struct snd_ctl_elem_info *uinfo);
643int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
644 struct snd_ctl_elem_value *ucontrol);
645int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
646 struct snd_ctl_elem_value *ucontrol);
Vinod Kould9881202014-05-02 10:58:11 +0530647int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
648 struct snd_ctl_elem_info *ucontrol);
Omair Mohammed Abdullah7523a272014-07-15 21:34:48 +0530649int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
650 unsigned int size, unsigned int __user *tlv);
Kristoffer KARLSSON4183eed22012-04-20 11:32:13 +0200651int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
652 struct snd_ctl_elem_info *uinfo);
653int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
654 struct snd_ctl_elem_value *ucontrol);
655int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
656 struct snd_ctl_elem_value *ucontrol);
Kristoffer KARLSSONdd7b10b2012-04-20 11:32:44 +0200657int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
658 struct snd_ctl_elem_value *ucontrol);
659int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
660 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200661
Mark Brown8a2cd612009-01-07 17:31:10 +0000662/**
663 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
664 *
665 * @pin: name of the pin to update
666 * @mask: bits to check for in reported jack status
667 * @invert: if non-zero then pin is enabled when status is not reported
Jonathan Corbet628536e2015-08-25 01:14:48 -0600668 * @list: internal list entry
Mark Brown8a2cd612009-01-07 17:31:10 +0000669 */
670struct snd_soc_jack_pin {
671 struct list_head list;
672 const char *pin;
673 int mask;
674 bool invert;
675};
676
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600677/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530678 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
679 *
680 * @min_mv: start voltage in mv
681 * @max_mv: end voltage in mv
682 * @jack_type: type of jack that is expected for this voltage
683 * @debounce_time: debounce_time for jack, codec driver should wait for this
684 * duration before reading the adc for voltages
Jonathan Corbet628536e2015-08-25 01:14:48 -0600685 * @list: internal list entry
Vinod Koulfa9879e2011-02-09 14:44:17 +0530686 */
687struct snd_soc_jack_zone {
688 unsigned int min_mv;
689 unsigned int max_mv;
690 unsigned int jack_type;
691 unsigned int debounce_time;
692 struct list_head list;
693};
694
695/**
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600696 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
697 *
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300698 * @gpio: legacy gpio number
Jarkko Nikula83ad1522014-05-27 13:54:18 +0300699 * @idx: gpio descriptor index within the function of the GPIO
700 * consumer device
Jonathan Corbet628536e2015-08-25 01:14:48 -0600701 * @gpiod_dev: GPIO consumer device
Jarkko Nikula83ad1522014-05-27 13:54:18 +0300702 * @name: gpio name. Also as connection ID for the GPIO consumer
703 * device function name lookup
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600704 * @report: value to report when jack detected
705 * @invert: report presence in low state
Jonathan Corbet628536e2015-08-25 01:14:48 -0600706 * @debounce_time: debounce time in ms
Mark Brown7887ab32011-02-17 16:35:55 -0800707 * @wake: enable as wake source
Mark Brownfadddc82011-02-17 16:41:42 -0800708 * @jack_status_check: callback function which overrides the detection
709 * to provide more complex checks (eg, reading an
710 * ADC).
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600711 */
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600712struct snd_soc_jack_gpio {
713 unsigned int gpio;
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300714 unsigned int idx;
715 struct device *gpiod_dev;
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600716 const char *name;
717 int report;
718 int invert;
719 int debounce_time;
Mark Brown7887ab32011-02-17 16:35:55 -0800720 bool wake;
721
Jonathan Corbet628536e2015-08-25 01:14:48 -0600722 /* private: */
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600723 struct snd_soc_jack *jack;
Mark Brown4c14d782010-10-06 15:54:28 -0700724 struct delayed_work work;
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300725 struct gpio_desc *desc;
Joonyoung Shimc871a052009-11-12 17:14:04 +0900726
xiangxiaocb29d7b2014-02-23 14:40:44 +0800727 void *data;
Jonathan Corbet628536e2015-08-25 01:14:48 -0600728 /* public: */
xiangxiaocb29d7b2014-02-23 14:40:44 +0800729 int (*jack_status_check)(void *data);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600730};
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600731
Mark Brown8a2cd612009-01-07 17:31:10 +0000732struct snd_soc_jack {
Mark Brown2667b4b2012-03-12 14:07:49 +0000733 struct mutex mutex;
Mark Brown8a2cd612009-01-07 17:31:10 +0000734 struct snd_jack *jack;
Lars-Peter Clausen97093992015-03-04 10:33:17 +0100735 struct snd_soc_card *card;
Mark Brown8a2cd612009-01-07 17:31:10 +0000736 struct list_head pins;
737 int status;
Mark Brownd5021ec2010-03-22 12:06:30 +0000738 struct blocking_notifier_head notifier;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530739 struct list_head jack_zones;
Mark Brown8a2cd612009-01-07 17:31:10 +0000740};
741
Richard Purdie808db4a2006-10-06 18:20:14 +0200742/* SoC PCM stream information */
743struct snd_soc_pcm_stream {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000744 const char *stream_name;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100745 u64 formats; /* SNDRV_PCM_FMTBIT_* */
746 unsigned int rates; /* SNDRV_PCM_RATE_* */
Richard Purdie808db4a2006-10-06 18:20:14 +0200747 unsigned int rate_min; /* min rate */
748 unsigned int rate_max; /* max rate */
749 unsigned int channels_min; /* min channels */
750 unsigned int channels_max; /* max channels */
Mark Brown58ba9b22012-01-16 18:38:51 +0000751 unsigned int sig_bits; /* number of bits of content */
Richard Purdie808db4a2006-10-06 18:20:14 +0200752};
753
754/* SoC audio ops */
755struct snd_soc_ops {
756 int (*startup)(struct snd_pcm_substream *);
757 void (*shutdown)(struct snd_pcm_substream *);
758 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
759 int (*hw_free)(struct snd_pcm_substream *);
760 int (*prepare)(struct snd_pcm_substream *);
761 int (*trigger)(struct snd_pcm_substream *, int);
762};
763
Vinod Koul49681072012-08-16 17:10:40 +0530764struct snd_soc_compr_ops {
765 int (*startup)(struct snd_compr_stream *);
766 void (*shutdown)(struct snd_compr_stream *);
767 int (*set_params)(struct snd_compr_stream *);
768 int (*trigger)(struct snd_compr_stream *);
769};
770
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700771/* component interface */
772struct snd_soc_component_driver {
773 const char *name;
Kuninori Morimotocb470082013-09-10 17:39:56 -0700774
Lars-Peter Clausen61aca562014-08-19 15:51:21 +0200775 /* Default control and setup, added after probe() is run */
776 const struct snd_kcontrol_new *controls;
777 unsigned int num_controls;
778 const struct snd_soc_dapm_widget *dapm_widgets;
779 unsigned int num_dapm_widgets;
780 const struct snd_soc_dapm_route *dapm_routes;
781 unsigned int num_dapm_routes;
782
783 int (*probe)(struct snd_soc_component *);
784 void (*remove)(struct snd_soc_component *);
785
Kuninori Morimotocb470082013-09-10 17:39:56 -0700786 /* DT */
787 int (*of_xlate_dai_name)(struct snd_soc_component *component,
788 struct of_phandle_args *args,
789 const char **dai_name);
Lars-Peter Clausen14e8bde2014-06-16 18:13:08 +0200790 void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
791 int subseq);
792 int (*stream_event)(struct snd_soc_component *, int event);
Lars-Peter Clausenf1d45cc32014-08-19 15:51:19 +0200793
794 /* probe ordering - for components with runtime dependencies */
795 int probe_order;
796 int remove_order;
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700797};
798
799struct snd_soc_component {
800 const char *name;
801 int id;
Lars-Peter Clausen94f99c82014-06-16 18:13:01 +0200802 const char *name_prefix;
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700803 struct device *dev;
Lars-Peter Clausen00200102014-07-17 22:01:07 +0200804 struct snd_soc_card *card;
Lars-Peter Clausencdde4cc2014-03-05 13:17:47 +0100805
806 unsigned int active;
807
Lars-Peter Clausen3d594002014-03-05 13:17:48 +0100808 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
Lars-Peter Clausen98e639f2014-03-18 09:02:11 +0100809 unsigned int registered_as_component:1;
Lars-Peter Clausen3d594002014-03-05 13:17:48 +0100810
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700811 struct list_head list;
Mengdong Linf2ed6b02016-01-06 13:29:31 +0800812 struct list_head list_aux; /* for auxiliary component of the card */
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700813
Kuninori Morimoto6833c452013-10-16 22:05:26 -0700814 struct snd_soc_dai_driver *dai_drv;
815 int num_dai;
816
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700817 const struct snd_soc_component_driver *driver;
Lars-Peter Clausen1438c2f2014-03-09 17:41:47 +0100818
819 struct list_head dai_list;
Lars-Peter Clausene2c330b2014-04-22 13:23:13 +0200820
821 int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
822 int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
823
824 struct regmap *regmap;
825 int val_bytes;
826
827 struct mutex io_mutex;
Lars-Peter Clausence0fc932014-06-16 18:13:06 +0200828
Liam Girdwood8a978232015-05-29 19:06:14 +0100829 /* attached dynamic objects */
830 struct list_head dobj_list;
831
Lars-Peter Clausen81c7cfd2014-08-19 15:51:18 +0200832#ifdef CONFIG_DEBUG_FS
833 struct dentry *debugfs_root;
834#endif
835
836 /*
837 * DO NOT use any of the fields below in drivers, they are temporary and
838 * are going to be removed again soon. If you use them in driver code the
839 * driver will be marked as BROKEN when these fields are removed.
840 */
841
Lars-Peter Clausence0fc932014-06-16 18:13:06 +0200842 /* Don't use these, use snd_soc_component_get_dapm() */
843 struct snd_soc_dapm_context dapm;
Lars-Peter Clausen81c7cfd2014-08-19 15:51:18 +0200844
Lars-Peter Clausenf1d45cc32014-08-19 15:51:19 +0200845 const struct snd_kcontrol_new *controls;
846 unsigned int num_controls;
847 const struct snd_soc_dapm_widget *dapm_widgets;
848 unsigned int num_dapm_widgets;
849 const struct snd_soc_dapm_route *dapm_routes;
850 unsigned int num_dapm_routes;
Lars-Peter Clausenf1d45cc32014-08-19 15:51:19 +0200851 struct snd_soc_codec *codec;
852
853 int (*probe)(struct snd_soc_component *);
854 void (*remove)(struct snd_soc_component *);
855
Mengdong Linf2ed6b02016-01-06 13:29:31 +0800856 /* machine specific init */
857 int (*init)(struct snd_soc_component *component);
858
Lars-Peter Clausen81c7cfd2014-08-19 15:51:18 +0200859#ifdef CONFIG_DEBUG_FS
860 void (*init_debugfs)(struct snd_soc_component *component);
861 const char *debugfs_prefix;
862#endif
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700863};
864
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000865/* SoC Audio Codec device */
Richard Purdie808db4a2006-10-06 18:20:14 +0200866struct snd_soc_codec {
Mark Brown0d0cf002008-12-10 14:32:45 +0000867 struct device *dev;
Mark Brown001ae4c2010-12-02 16:21:08 +0000868 const struct snd_soc_codec_driver *driver;
Mark Brown0d0cf002008-12-10 14:32:45 +0000869
870 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000871 struct list_head card_list;
Richard Purdie808db4a2006-10-06 18:20:14 +0200872
873 /* runtime */
Dimitris Papastamosdad8e7a2011-01-19 14:53:36 +0000874 unsigned int cache_bypass:1; /* Suppress access to the cache */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000875 unsigned int suspended:1; /* Codec is in suspend PM state */
Dimitris Papastamosfdf0f542010-12-02 16:11:06 +0000876 unsigned int cache_init:1; /* codec cache has been initialized */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000877
878 /* codec IO */
879 void *control_data; /* codec control (i2c/3wire) data */
880 hw_write_t hw_write;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000881 void *reg_cache;
Mark Browna96ca332010-01-19 22:49:43 +0000882
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700883 /* component */
884 struct snd_soc_component component;
885
Mark Brown384c89e2008-12-03 17:34:03 +0000886#ifdef CONFIG_DEBUG_FS
887 struct dentry *debugfs_reg;
Mark Brown384c89e2008-12-03 17:34:03 +0000888#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200889};
890
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000891/* codec driver */
892struct snd_soc_codec_driver {
893
894 /* driver ops */
895 int (*probe)(struct snd_soc_codec *);
896 int (*remove)(struct snd_soc_codec *);
Lars-Peter Clausen84b315e2011-12-02 10:18:28 +0100897 int (*suspend)(struct snd_soc_codec *);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000898 int (*resume)(struct snd_soc_codec *);
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700899 struct snd_soc_component_driver component_driver;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000900
Mark Brownec4ee522011-03-07 20:58:11 +0000901 /* codec wide operations */
902 int (*set_sysclk)(struct snd_soc_codec *codec,
Mark Brownda1c6ea2011-08-24 20:09:01 +0100903 int clk_id, int source, unsigned int freq, int dir);
Mark Brownec4ee522011-03-07 20:58:11 +0000904 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
905 unsigned int freq_in, unsigned int freq_out);
906
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000907 /* codec IO */
Xiubo Lia39f75f2014-03-26 13:40:23 +0800908 struct regmap *(*get_regmap)(struct device *);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000909 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
910 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
Mark Brown4a8923b2011-08-24 19:12:49 +0100911 unsigned int reg_cache_size;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000912 short reg_cache_step;
913 short reg_word_size;
914 const void *reg_cache_default;
915
916 /* codec bias level */
917 int (*set_bias_level)(struct snd_soc_codec *,
918 enum snd_soc_bias_level level);
Mark Brown33c5f962011-08-22 18:40:30 +0100919 bool idle_bias_off;
Lars-Peter Clausen86dbf2a2014-09-04 19:44:06 +0200920 bool suspend_bias_off;
Mark Brown474b62d2011-01-18 16:14:44 +0000921
922 void (*seq_notifier)(struct snd_soc_dapm_context *,
Mark Brownf85a9e02011-01-26 21:41:28 +0000923 enum snd_soc_dapm_type, int);
Liam Girdwood0168bf02011-06-07 16:08:05 +0100924
Mark Brown5124e692012-02-08 13:20:50 +0000925 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */
Richard Purdie808db4a2006-10-06 18:20:14 +0200926};
927
928/* SoC platform interface */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000929struct snd_soc_platform_driver {
Richard Purdie808db4a2006-10-06 18:20:14 +0200930
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000931 int (*probe)(struct snd_soc_platform *);
932 int (*remove)(struct snd_soc_platform *);
Lars-Peter Clausenb37f1d12014-03-18 09:02:12 +0100933 struct snd_soc_component_driver component_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200934
935 /* pcm creation and destruction */
Liam Girdwood552d1ef2011-06-07 16:08:33 +0100936 int (*pcm_new)(struct snd_soc_pcm_runtime *);
Richard Purdie808db4a2006-10-06 18:20:14 +0200937 void (*pcm_free)(struct snd_pcm *);
938
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200939 /*
940 * For platform caused delay reporting.
941 * Optional.
942 */
943 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
944 struct snd_soc_dai *);
945
Vinod Koul49681072012-08-16 17:10:40 +0530946 /* platform stream pcm ops */
Lars-Peter Clausen1f03f552013-03-27 12:02:23 +0100947 const struct snd_pcm_ops *ops;
Liam Girdwood0168bf02011-06-07 16:08:05 +0100948
Vinod Koul49681072012-08-16 17:10:40 +0530949 /* platform stream compress ops */
Lars-Peter Clausenef03c9a2013-03-27 12:02:24 +0100950 const struct snd_compr_ops *compr_ops;
Vinod Koul49681072012-08-16 17:10:40 +0530951
Liam Girdwood07bf84a2012-04-25 12:12:52 +0100952 int (*bespoke_trigger)(struct snd_pcm_substream *, int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200953};
954
Benoit Cousson88bd8702014-07-08 23:19:34 +0200955struct snd_soc_dai_link_component {
956 const char *name;
Jean-Francois Moinec362eff2014-11-25 12:14:48 +0100957 struct device_node *of_node;
Benoit Cousson88bd8702014-07-08 23:19:34 +0200958 const char *dai_name;
959};
960
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000961struct snd_soc_platform {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000962 struct device *dev;
Lars-Peter Clausend79e57d2013-03-27 12:02:22 +0100963 const struct snd_soc_platform_driver *driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200964
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000965 struct list_head list;
Liam Girdwoodb7950642011-07-04 22:10:52 +0100966
Lars-Peter Clausenb37f1d12014-03-18 09:02:12 +0100967 struct snd_soc_component component;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000968};
Richard Purdie808db4a2006-10-06 18:20:14 +0200969
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000970struct snd_soc_dai_link {
971 /* config - must be set by machine driver */
972 const char *name; /* Codec name */
973 const char *stream_name; /* Stream name */
Stephen Warrenbc926572012-05-25 18:22:11 -0600974 /*
975 * You MAY specify the link's CPU-side device, either by device name,
976 * or by DT/OF node, but not both. If this information is omitted,
977 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
978 * must be globally unique. These fields are currently typically used
979 * only for codec to codec links, or systems using device tree.
980 */
981 const char *cpu_name;
Sylwester Nawrocki8ad9f9e2014-06-16 16:33:46 +0200982 struct device_node *cpu_of_node;
Stephen Warrenbc926572012-05-25 18:22:11 -0600983 /*
984 * You MAY specify the DAI name of the CPU DAI. If this information is
985 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
986 * only, which only works well when that device exposes a single DAI.
987 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000988 const char *cpu_dai_name;
Stephen Warrenbc926572012-05-25 18:22:11 -0600989 /*
990 * You MUST specify the link's codec, either by device name, or by
991 * DT/OF node, but not both.
992 */
993 const char *codec_name;
Sylwester Nawrocki8ad9f9e2014-06-16 16:33:46 +0200994 struct device_node *codec_of_node;
Stephen Warrenbc926572012-05-25 18:22:11 -0600995 /* You MUST specify the DAI name within the codec */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000996 const char *codec_dai_name;
Benoit Cousson88bd8702014-07-08 23:19:34 +0200997
998 struct snd_soc_dai_link_component *codecs;
999 unsigned int num_codecs;
1000
Stephen Warrenbc926572012-05-25 18:22:11 -06001001 /*
1002 * You MAY specify the link's platform/PCM/DMA driver, either by
1003 * device name, or by DT/OF node, but not both. Some forms of link
1004 * do not need a platform.
1005 */
1006 const char *platform_name;
Sylwester Nawrocki8ad9f9e2014-06-16 16:33:46 +02001007 struct device_node *platform_of_node;
Mengdong Lin2f0ad492016-04-19 13:12:35 +08001008 int id; /* optional ID for machine driver link identification */
Liam Girdwood4ccab3e2008-01-10 14:39:01 +01001009
Mark Brownc74184e2012-04-04 22:12:09 +01001010 const struct snd_soc_pcm_stream *params;
Nikesh Oswalc6615082015-02-02 17:06:44 +00001011 unsigned int num_params;
Mark Brownc74184e2012-04-04 22:12:09 +01001012
Mark Brown75d9ac42011-09-27 16:41:01 +01001013 unsigned int dai_fmt; /* format to set on init */
1014
Liam Girdwood01d75842012-04-25 12:12:49 +01001015 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
1016
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001017 /* codec/machine specific init - e.g. add machine controls */
1018 int (*init)(struct snd_soc_pcm_runtime *rtd);
Mark Brown06f409d2009-04-07 18:10:13 +01001019
Liam Girdwood01d75842012-04-25 12:12:49 +01001020 /* optional hw_params re-writing for BE and FE sync */
1021 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
1022 struct snd_pcm_hw_params *params);
1023
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001024 /* machine stream operations */
Lars-Peter Clausen13aec722013-01-10 17:06:15 +01001025 const struct snd_soc_ops *ops;
1026 const struct snd_soc_compr_ops *compr_ops;
Fabio Estevamd6bead02013-08-29 10:32:13 -03001027
1028 /* For unidirectional dai links */
1029 bool playback_only;
1030 bool capture_only;
Kuninori Morimoto2dc0f162015-04-21 07:02:34 +00001031
1032 /* Mark this pcm with non atomic ops */
1033 bool nonatomic;
1034
1035 /* Keep DAI active over suspend */
1036 unsigned int ignore_suspend:1;
1037
1038 /* Symmetry requirements */
1039 unsigned int symmetric_rates:1;
1040 unsigned int symmetric_channels:1;
1041 unsigned int symmetric_samplebits:1;
1042
1043 /* Do not create a PCM for this DAI link (Backend link) */
1044 unsigned int no_pcm:1;
1045
1046 /* This DAI link can route to other DAI links at runtime (Frontend)*/
1047 unsigned int dynamic:1;
1048
1049 /* DPCM capture and Playback support */
1050 unsigned int dpcm_capture:1;
1051 unsigned int dpcm_playback:1;
1052
Kuninori Morimotob073ed42015-05-12 02:03:33 +00001053 /* DPCM used FE & BE merged format */
1054 unsigned int dpcm_merged_format:1;
1055
Kuninori Morimoto2dc0f162015-04-21 07:02:34 +00001056 /* pmdown_time is ignored at stop */
1057 unsigned int ignore_pmdown_time:1;
Mengdong Linf8f80362015-12-02 14:11:22 +08001058
1059 struct list_head list; /* DAI link list of the soc card */
1060 struct snd_soc_dobj dobj; /* For topology */
Richard Purdie808db4a2006-10-06 18:20:14 +02001061};
1062
Dimitris Papastamosff819b82010-12-02 14:53:03 +00001063struct snd_soc_codec_conf {
Sebastian Reichel3ca041e2014-04-28 16:07:22 +02001064 /*
1065 * specify device either by device name, or by
1066 * DT/OF node, but not both.
1067 */
Jarkko Nikulaead9b912010-11-13 20:40:44 +02001068 const char *dev_name;
Jean-Francois Moinec362eff2014-11-25 12:14:48 +01001069 struct device_node *of_node;
Dimitris Papastamosff819b82010-12-02 14:53:03 +00001070
1071 /*
1072 * optional map of kcontrol, widget and path name prefixes that are
1073 * associated per device
1074 */
Jarkko Nikulaead9b912010-11-13 20:40:44 +02001075 const char *name_prefix;
1076};
1077
Jarkko Nikula2eea3922010-11-25 17:47:38 +02001078struct snd_soc_aux_dev {
1079 const char *name; /* Codec name */
Sebastian Reichel3ca041e2014-04-28 16:07:22 +02001080
1081 /*
1082 * specify multi-codec either by device name, or by
1083 * DT/OF node, but not both.
1084 */
1085 const char *codec_name;
Jean-Francois Moinec362eff2014-11-25 12:14:48 +01001086 struct device_node *codec_of_node;
Jarkko Nikula2eea3922010-11-25 17:47:38 +02001087
1088 /* codec/machine specific init - e.g. add machine controls */
Lars-Peter Clausen57bf7722014-08-19 15:51:23 +02001089 int (*init)(struct snd_soc_component *component);
Jarkko Nikula2eea3922010-11-25 17:47:38 +02001090};
1091
Mark Brown87506542008-11-18 20:50:34 +00001092/* SoC card */
1093struct snd_soc_card {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001094 const char *name;
Liam Girdwood22de71b2011-05-12 16:14:04 +01001095 const char *long_name;
1096 const char *driver_name;
Mark Brownc5af3a22008-11-28 13:29:45 +00001097 struct device *dev;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001098 struct snd_card *snd_card;
1099 struct module *owner;
Mark Brownc5af3a22008-11-28 13:29:45 +00001100
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001101 struct mutex mutex;
Liam Girdwooda73fb2d2012-03-07 10:38:26 +00001102 struct mutex dapm_mutex;
Mark Brownc5af3a22008-11-28 13:29:45 +00001103
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001104 bool instantiated;
Richard Purdie808db4a2006-10-06 18:20:14 +02001105
Mark Browne7361ec2011-01-26 14:17:20 +00001106 int (*probe)(struct snd_soc_card *card);
Mark Brown28e9ad92011-03-02 18:36:34 +00001107 int (*late_probe)(struct snd_soc_card *card);
Mark Browne7361ec2011-01-26 14:17:20 +00001108 int (*remove)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +02001109
1110 /* the pre and post PM functions are used to do any PM work before and
1111 * after the codec and DAI's do any PM work. */
Mark Brown70b2ac12011-01-26 14:05:25 +00001112 int (*suspend_pre)(struct snd_soc_card *card);
1113 int (*suspend_post)(struct snd_soc_card *card);
1114 int (*resume_pre)(struct snd_soc_card *card);
1115 int (*resume_post)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +02001116
Liam Girdwood0b4d2212008-01-10 14:36:20 +01001117 /* callbacks */
Mark Brown87506542008-11-18 20:50:34 +00001118 int (*set_bias_level)(struct snd_soc_card *,
Mark Brownd4c60052011-06-06 19:13:23 +01001119 struct snd_soc_dapm_context *dapm,
Mark Brown0be98982008-05-19 12:31:28 +02001120 enum snd_soc_bias_level level);
Mark Brown1badabd2010-12-04 12:41:04 +00001121 int (*set_bias_level_post)(struct snd_soc_card *,
Mark Brownd4c60052011-06-06 19:13:23 +01001122 struct snd_soc_dapm_context *dapm,
Mark Brown1badabd2010-12-04 12:41:04 +00001123 enum snd_soc_bias_level level);
Liam Girdwood0b4d2212008-01-10 14:36:20 +01001124
Mengdong Lind6f220e2015-12-02 14:11:32 +08001125 int (*add_dai_link)(struct snd_soc_card *,
1126 struct snd_soc_dai_link *link);
1127 void (*remove_dai_link)(struct snd_soc_card *,
1128 struct snd_soc_dai_link *link);
1129
Mark Brown6c5f1fe2010-02-17 14:30:44 +00001130 long pmdown_time;
Mark Brown96dd3622010-02-12 11:05:44 +00001131
Richard Purdie808db4a2006-10-06 18:20:14 +02001132 /* CPU <--> Codec DAI links */
Mengdong Linf8f80362015-12-02 14:11:22 +08001133 struct snd_soc_dai_link *dai_link; /* predefined links only */
1134 int num_links; /* predefined links only */
1135 struct list_head dai_link_list; /* all links */
1136 int num_dai_links;
1137
Mengdong Lin1a497982015-11-18 02:34:11 -05001138 struct list_head rtd_list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001139 int num_rtd;
Mark Brown63084192008-12-02 15:08:03 +00001140
Dimitris Papastamosff819b82010-12-02 14:53:03 +00001141 /* optional codec specific configuration */
1142 struct snd_soc_codec_conf *codec_conf;
1143 int num_configs;
Jarkko Nikulaead9b912010-11-13 20:40:44 +02001144
Jarkko Nikula2eea3922010-11-25 17:47:38 +02001145 /*
1146 * optional auxiliary devices such as amplifiers or codecs with DAI
1147 * link unused
1148 */
1149 struct snd_soc_aux_dev *aux_dev;
1150 int num_aux_devs;
Mengdong Linf2ed6b02016-01-06 13:29:31 +08001151 struct list_head aux_comp_list;
Jarkko Nikula2eea3922010-11-25 17:47:38 +02001152
Mark Brownb7af1da2011-04-07 19:18:44 +09001153 const struct snd_kcontrol_new *controls;
1154 int num_controls;
1155
Mark Brownb8ad29d2011-03-02 18:35:51 +00001156 /*
1157 * Card-specific routes and widgets.
Nicolin Chenf23e8602015-02-14 17:22:49 -08001158 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
Mark Brownb8ad29d2011-03-02 18:35:51 +00001159 */
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +02001160 const struct snd_soc_dapm_widget *dapm_widgets;
Mark Brownb8ad29d2011-03-02 18:35:51 +00001161 int num_dapm_widgets;
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +02001162 const struct snd_soc_dapm_route *dapm_routes;
Mark Brownb8ad29d2011-03-02 18:35:51 +00001163 int num_dapm_routes;
Nicolin Chenf23e8602015-02-14 17:22:49 -08001164 const struct snd_soc_dapm_widget *of_dapm_widgets;
1165 int num_of_dapm_widgets;
1166 const struct snd_soc_dapm_route *of_dapm_routes;
1167 int num_of_dapm_routes;
Stephen Warren16332812011-11-23 12:42:04 -07001168 bool fully_routed;
Mark Brownb8ad29d2011-03-02 18:35:51 +00001169
Mark Brown63084192008-12-02 15:08:03 +00001170 struct work_struct deferred_resume_work;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001171
1172 /* lists of probed devices belonging to this card */
1173 struct list_head codec_dev_list;
Jarkko Nikulaa6052152010-11-05 20:35:19 +02001174
Jarkko Nikula97c866d2010-12-14 12:18:31 +02001175 struct list_head widgets;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +02001176 struct list_head paths;
Jarkko Nikula7be31be82010-12-14 12:18:32 +02001177 struct list_head dapm_list;
Mark Browndb432b42011-10-03 21:06:40 +01001178 struct list_head dapm_dirty;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +02001179
Liam Girdwood8a978232015-05-29 19:06:14 +01001180 /* attached dynamic objects */
1181 struct list_head dobj_list;
1182
Mark Browne37a4972011-03-02 18:21:57 +00001183 /* Generic DAPM context for the card */
1184 struct snd_soc_dapm_context dapm;
Mark Brownde02d072011-09-20 21:43:24 +01001185 struct snd_soc_dapm_stats dapm_stats;
Lars-Peter Clausen564c65042013-07-29 17:13:55 +02001186 struct snd_soc_dapm_update *update;
Mark Browne37a4972011-03-02 18:21:57 +00001187
Jarkko Nikulaa6052152010-11-05 20:35:19 +02001188#ifdef CONFIG_DEBUG_FS
1189 struct dentry *debugfs_card_root;
Jarkko Nikula3a45b862010-11-05 20:35:21 +02001190 struct dentry *debugfs_pop_time;
Jarkko Nikulaa6052152010-11-05 20:35:19 +02001191#endif
Jarkko Nikula3a45b862010-11-05 20:35:21 +02001192 u32 pop_time;
Mark Browndddf3e42011-01-28 13:11:47 +00001193
1194 void *drvdata;
Richard Purdie808db4a2006-10-06 18:20:14 +02001195};
1196
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001197/* SoC machine DAI configuration, glues a codec and cpu DAI together */
Mark Brownd66a3272011-11-10 11:46:13 +00001198struct snd_soc_pcm_runtime {
Mark Brown36ae1a92012-01-06 17:12:45 -08001199 struct device *dev;
Mark Brown87506542008-11-18 20:50:34 +00001200 struct snd_soc_card *card;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001201 struct snd_soc_dai_link *dai_link;
Liam Girdwoodb8c0dab2011-06-09 17:04:39 +01001202 struct mutex pcm_mutex;
1203 enum snd_soc_pcm_subclass pcm_subclass;
1204 struct snd_pcm_ops ops;
Richard Purdie808db4a2006-10-06 18:20:14 +02001205
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001206 unsigned int dev_registered:1;
1207
Liam Girdwood01d75842012-04-25 12:12:49 +01001208 /* Dynamic PCM BE runtime data */
1209 struct snd_soc_dpcm_runtime dpcm[2];
Liam Girdwood2a99ef02014-01-17 17:03:56 +00001210 int fe_compr;
Liam Girdwood01d75842012-04-25 12:12:49 +01001211
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001212 long pmdown_time;
Misael Lopez Cruz9bffb1f2012-12-13 12:23:05 -06001213 unsigned char pop_wait:1;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001214
1215 /* runtime devices */
1216 struct snd_pcm *pcm;
Vinod Koul49681072012-08-16 17:10:40 +05301217 struct snd_compr *compr;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001218 struct snd_soc_codec *codec;
1219 struct snd_soc_platform *platform;
1220 struct snd_soc_dai *codec_dai;
1221 struct snd_soc_dai *cpu_dai;
Lars-Peter Clausen65d93612014-08-19 15:51:22 +02001222 struct snd_soc_component *component; /* Only valid for AUX dev rtds */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001223
Benoit Cousson88bd8702014-07-08 23:19:34 +02001224 struct snd_soc_dai **codec_dais;
1225 unsigned int num_codecs;
1226
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001227 struct delayed_work delayed_work;
Liam Girdwoodf86dcef2012-04-25 12:12:50 +01001228#ifdef CONFIG_DEBUG_FS
1229 struct dentry *debugfs_dpcm_root;
1230 struct dentry *debugfs_dpcm_state;
1231#endif
Mengdong Lin1a497982015-11-18 02:34:11 -05001232
1233 unsigned int num; /* 0-based and monotonic increasing */
1234 struct list_head list; /* rtd list of the soc card */
Richard Purdie808db4a2006-10-06 18:20:14 +02001235};
1236
Jon Smirl4eaa9812008-07-29 11:42:26 +01001237/* mixer control */
1238struct soc_mixer_control {
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +03001239 int min, max, platform_max;
Lars-Peter Clausen249ce132013-10-06 13:43:49 +02001240 int reg, rreg;
1241 unsigned int shift, rshift;
Markus Pargmannf227b882014-01-16 16:02:10 +01001242 unsigned int sign_bit;
Lars-Peter Clausen57295072013-08-05 11:27:31 +02001243 unsigned int invert:1;
1244 unsigned int autodisable:1;
Liam Girdwood8a978232015-05-29 19:06:14 +01001245 struct snd_soc_dobj dobj;
Jon Smirl4eaa9812008-07-29 11:42:26 +01001246};
1247
Mark Brown71d08512011-10-10 18:31:26 +01001248struct soc_bytes {
1249 int base;
1250 int num_regs;
Mark Brownf831b052012-02-17 16:20:33 -08001251 u32 mask;
Mark Brown71d08512011-10-10 18:31:26 +01001252};
1253
Vinod Kould9881202014-05-02 10:58:11 +05301254struct soc_bytes_ext {
1255 int max;
Liam Girdwood8a978232015-05-29 19:06:14 +01001256 struct snd_soc_dobj dobj;
1257
Omair Mohammed Abdullah7523a272014-07-15 21:34:48 +05301258 /* used for TLV byte control */
Mythri P Ka1e5e7e92015-11-09 23:20:00 +05301259 int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1260 unsigned int size);
1261 int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1262 unsigned int size);
Vinod Kould9881202014-05-02 10:58:11 +05301263};
1264
Kristoffer KARLSSON4183eed22012-04-20 11:32:13 +02001265/* multi register control */
1266struct soc_mreg_control {
1267 long min, max;
1268 unsigned int regbase, regcount, nbits, invert;
1269};
1270
Richard Purdie808db4a2006-10-06 18:20:14 +02001271/* enumerated kcontrol */
1272struct soc_enum {
Lars-Peter Clausenb9488372014-02-28 08:31:05 +01001273 int reg;
Richard Purdie808db4a2006-10-06 18:20:14 +02001274 unsigned char shift_l;
1275 unsigned char shift_r;
Takashi Iwai9a8d38d2014-02-18 08:11:42 +01001276 unsigned int items;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +02001277 unsigned int mask;
Takashi Iwai87023ff2011-05-03 12:50:29 +02001278 const char * const *texts;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +02001279 const unsigned int *values;
Charles Keepax561ed682015-05-01 12:37:26 +01001280 unsigned int autodisable:1;
Liam Girdwood8a978232015-05-29 19:06:14 +01001281 struct snd_soc_dobj dobj;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +02001282};
1283
Lars-Peter Clausen28d6d172014-03-18 09:02:10 +01001284/**
1285 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1286 * @component: The component to cast to a CODEC
1287 *
1288 * This function must only be used on components that are known to be CODECs.
1289 * Otherwise the behavior is undefined.
1290 */
1291static inline struct snd_soc_codec *snd_soc_component_to_codec(
1292 struct snd_soc_component *component)
1293{
1294 return container_of(component, struct snd_soc_codec, component);
1295}
1296
Lars-Peter Clausenb37f1d12014-03-18 09:02:12 +01001297/**
1298 * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1299 * @component: The component to cast to a platform
1300 *
1301 * This function must only be used on components that are known to be platforms.
1302 * Otherwise the behavior is undefined.
1303 */
1304static inline struct snd_soc_platform *snd_soc_component_to_platform(
1305 struct snd_soc_component *component)
1306{
1307 return container_of(component, struct snd_soc_platform, component);
1308}
1309
Lars-Peter Clausen24089e02014-05-18 14:24:12 +02001310/**
Lars-Peter Clausence0fc932014-06-16 18:13:06 +02001311 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1312 * embedded in
1313 * @dapm: The DAPM context to cast to the component
1314 *
1315 * This function must only be used on DAPM contexts that are known to be part of
1316 * a component (e.g. in a component driver). Otherwise the behavior is
1317 * undefined.
1318 */
1319static inline struct snd_soc_component *snd_soc_dapm_to_component(
1320 struct snd_soc_dapm_context *dapm)
1321{
1322 return container_of(dapm, struct snd_soc_component, dapm);
1323}
1324
1325/**
Lars-Peter Clausen24089e02014-05-18 14:24:12 +02001326 * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1327 * @dapm: The DAPM context to cast to the CODEC
1328 *
1329 * This function must only be used on DAPM contexts that are known to be part of
1330 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1331 */
1332static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1333 struct snd_soc_dapm_context *dapm)
1334{
Lars-Peter Clausen48901402015-07-06 15:38:11 +02001335 return snd_soc_component_to_codec(snd_soc_dapm_to_component(dapm));
Lars-Peter Clausen24089e02014-05-18 14:24:12 +02001336}
1337
1338/**
1339 * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1340 * embedded in
1341 * @dapm: The DAPM context to cast to the platform.
1342 *
1343 * This function must only be used on DAPM contexts that are known to be part of
1344 * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1345 */
1346static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1347 struct snd_soc_dapm_context *dapm)
1348{
Lars-Peter Clausenbc9af9f2014-06-16 18:13:07 +02001349 return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
Lars-Peter Clausen24089e02014-05-18 14:24:12 +02001350}
1351
Lars-Peter Clausence0fc932014-06-16 18:13:06 +02001352/**
1353 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1354 * component
1355 * @component: The component for which to get the DAPM context
1356 */
1357static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1358 struct snd_soc_component *component)
1359{
Lars-Peter Clausen48901402015-07-06 15:38:11 +02001360 return &component->dapm;
Lars-Peter Clausence0fc932014-06-16 18:13:06 +02001361}
1362
Lars-Peter Clausen6b5b0422015-03-15 10:27:20 +01001363/**
Lars-Peter Clausen39ed68c2015-04-27 22:13:22 +02001364 * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC
1365 * @codec: The CODEC for which to get the DAPM context
1366 *
1367 * Note: Use this function instead of directly accessing the CODEC's dapm field
1368 */
1369static inline struct snd_soc_dapm_context *snd_soc_codec_get_dapm(
1370 struct snd_soc_codec *codec)
1371{
Lars-Peter Clausen48901402015-07-06 15:38:11 +02001372 return snd_soc_component_get_dapm(&codec->component);
Lars-Peter Clausen39ed68c2015-04-27 22:13:22 +02001373}
1374
1375/**
Lars-Peter Clausenfa880772015-04-27 22:13:23 +02001376 * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level
Jonathan Corbet628536e2015-08-25 01:14:48 -06001377 * @codec: The CODEC for which to initialize the DAPM bias level
Lars-Peter Clausenfa880772015-04-27 22:13:23 +02001378 * @level: The DAPM level to initialize to
1379 *
1380 * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level().
1381 */
1382static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec *codec,
1383 enum snd_soc_bias_level level)
1384{
1385 snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec), level);
1386}
1387
1388/**
1389 * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level
1390 * @codec: The CODEC for which to get the DAPM bias level
1391 *
1392 * Returns: The current DAPM bias level of the CODEC.
1393 */
1394static inline enum snd_soc_bias_level snd_soc_codec_get_bias_level(
1395 struct snd_soc_codec *codec)
1396{
1397 return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec));
1398}
1399
1400/**
1401 * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level
1402 * @codec: The CODEC for which to set the level
1403 * @level: The level to set to
1404 *
1405 * Forces the CODEC bias level to a specific state. See
1406 * snd_soc_dapm_force_bias_level().
1407 */
1408static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec *codec,
1409 enum snd_soc_bias_level level)
1410{
1411 return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec),
1412 level);
1413}
1414
1415/**
Lars-Peter Clausen6b5b0422015-03-15 10:27:20 +01001416 * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1417 * @kcontrol: The kcontrol
1418 *
1419 * This function must only be used on DAPM contexts that are known to be part of
1420 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1421 */
1422static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(
1423 struct snd_kcontrol *kcontrol)
1424{
1425 return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol));
1426}
1427
Mark Brown5c82f562009-05-22 09:41:30 +01001428/* codec IO */
Mark Brownc3753702010-11-01 15:41:57 -04001429unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
Lars-Peter Clausenab2874a2014-04-19 10:43:57 +02001430int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1431 unsigned int val);
Mark Brown5c82f562009-05-22 09:41:30 +01001432
Lars-Peter Clausen427d2042014-11-08 16:38:07 +01001433/**
1434 * snd_soc_cache_sync() - Sync the register cache with the hardware
1435 * @codec: CODEC to sync
1436 *
1437 * Note: This function will call regcache_sync()
1438 */
1439static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1440{
1441 return regcache_sync(codec->component.regmap);
1442}
1443
Lars-Peter Clausene2c330b2014-04-22 13:23:13 +02001444/* component IO */
1445int snd_soc_component_read(struct snd_soc_component *component,
1446 unsigned int reg, unsigned int *val);
1447int snd_soc_component_write(struct snd_soc_component *component,
1448 unsigned int reg, unsigned int val);
1449int snd_soc_component_update_bits(struct snd_soc_component *component,
1450 unsigned int reg, unsigned int mask, unsigned int val);
1451int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1452 unsigned int reg, unsigned int mask, unsigned int val);
1453void snd_soc_component_async_complete(struct snd_soc_component *component);
1454int snd_soc_component_test_bits(struct snd_soc_component *component,
1455 unsigned int reg, unsigned int mask, unsigned int value);
1456
Lars-Peter Clausene874bf52014-11-25 21:41:03 +01001457#ifdef CONFIG_REGMAP
1458
Lars-Peter Clausen20feb882014-11-18 19:45:52 +01001459void snd_soc_component_init_regmap(struct snd_soc_component *component,
1460 struct regmap *regmap);
1461void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1462
1463/**
1464 * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1465 * @codec: The CODEC for which to initialize the regmap instance
1466 * @regmap: The regmap instance that should be used by the CODEC
1467 *
1468 * This function allows deferred assignment of the regmap instance that is
1469 * associated with the CODEC. Only use this if the regmap instance is not yet
1470 * ready when the CODEC is registered. The function must also be called before
1471 * the first IO attempt of the CODEC.
1472 */
1473static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1474 struct regmap *regmap)
1475{
1476 snd_soc_component_init_regmap(&codec->component, regmap);
1477}
1478
1479/**
1480 * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1481 * @codec: The CODEC for which to de-initialize the regmap instance
1482 *
1483 * Calls regmap_exit() on the regmap instance associated to the CODEC and
1484 * removes the regmap instance from the CODEC.
1485 *
1486 * This function should only be used if snd_soc_codec_init_regmap() was used to
1487 * initialize the regmap instance.
1488 */
1489static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1490{
1491 snd_soc_component_exit_regmap(&codec->component);
1492}
1493
Lars-Peter Clausene874bf52014-11-25 21:41:03 +01001494#endif
1495
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001496/* device driver data */
1497
Mark Browndddf3e42011-01-28 13:11:47 +00001498static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1499 void *data)
1500{
1501 card->drvdata = data;
1502}
1503
1504static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1505{
1506 return card->drvdata;
1507}
1508
Lars-Peter Clausenc815dbb2014-08-20 13:08:46 +02001509static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1510 void *data)
1511{
1512 dev_set_drvdata(c->dev, data);
1513}
1514
1515static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1516{
1517 return dev_get_drvdata(c->dev);
1518}
1519
Mark Brownb2c812e2010-04-14 15:35:19 +09001520static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001521 void *data)
Mark Brownb2c812e2010-04-14 15:35:19 +09001522{
Lars-Peter Clausenc815dbb2014-08-20 13:08:46 +02001523 snd_soc_component_set_drvdata(&codec->component, data);
Mark Brownb2c812e2010-04-14 15:35:19 +09001524}
1525
1526static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1527{
Lars-Peter Clausenc815dbb2014-08-20 13:08:46 +02001528 return snd_soc_component_get_drvdata(&codec->component);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001529}
1530
1531static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1532 void *data)
1533{
Lars-Peter Clausenc815dbb2014-08-20 13:08:46 +02001534 snd_soc_component_set_drvdata(&platform->component, data);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001535}
1536
1537static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1538{
Lars-Peter Clausenc815dbb2014-08-20 13:08:46 +02001539 return snd_soc_component_get_drvdata(&platform->component);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001540}
1541
Vinod Koul4e10bda2011-01-13 22:48:52 +05301542static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1543{
Vinod Koul4e10bda2011-01-13 22:48:52 +05301544 INIT_LIST_HEAD(&card->codec_dev_list);
Vinod Koul4e10bda2011-01-13 22:48:52 +05301545 INIT_LIST_HEAD(&card->widgets);
1546 INIT_LIST_HEAD(&card->paths);
1547 INIT_LIST_HEAD(&card->dapm_list);
Mengdong Linf2ed6b02016-01-06 13:29:31 +08001548 INIT_LIST_HEAD(&card->aux_comp_list);
Vinod Koul4e10bda2011-01-13 22:48:52 +05301549}
1550
Peter Ujfalusi30d86ba2011-10-05 10:29:22 +03001551static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1552{
1553 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1554 return 0;
1555 /*
1556 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1557 * mc->reg != mc->rreg means that the control is
1558 * stereo (bits in one register or in two registers)
1559 */
1560 return 1;
1561}
1562
Lars-Peter Clausen29ae2fa2014-02-28 08:31:03 +01001563static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1564 unsigned int val)
1565{
1566 unsigned int i;
1567
1568 if (!e->values)
1569 return val;
1570
1571 for (i = 0; i < e->items; i++)
1572 if (val == e->values[i])
1573 return i;
1574
1575 return 0;
1576}
1577
1578static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1579 unsigned int item)
1580{
1581 if (!e->values)
1582 return item;
1583
1584 return e->values[item];
1585}
1586
Lars-Peter Clausencdde4cc2014-03-05 13:17:47 +01001587static inline bool snd_soc_component_is_active(
1588 struct snd_soc_component *component)
1589{
1590 return component->active != 0;
1591}
1592
Lars-Peter Clausen5c898e72014-03-05 13:17:45 +01001593static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1594{
Lars-Peter Clausencdde4cc2014-03-05 13:17:47 +01001595 return snd_soc_component_is_active(&codec->component);
Lars-Peter Clausen5c898e72014-03-05 13:17:45 +01001596}
1597
Lars-Peter Clausenea53bf72014-03-18 09:02:04 +01001598/**
Lars-Peter Clausen907fe362014-04-22 13:23:14 +02001599 * snd_soc_kcontrol_component() - Returns the component that registered the
1600 * control
1601 * @kcontrol: The control for which to get the component
1602 *
1603 * Note: This function will work correctly if the control has been registered
1604 * for a component. Either with snd_soc_add_codec_controls() or
1605 * snd_soc_add_platform_controls() or via table based setup for either a
1606 * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1607 */
1608static inline struct snd_soc_component *snd_soc_kcontrol_component(
1609 struct snd_kcontrol *kcontrol)
1610{
1611 return snd_kcontrol_chip(kcontrol);
1612}
1613
1614/**
Lars-Peter Clausenea53bf72014-03-18 09:02:04 +01001615 * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1616 * @kcontrol: The control for which to get the CODEC
1617 *
1618 * Note: This function will only work correctly if the control has been
1619 * registered with snd_soc_add_codec_controls() or via table based setup of
1620 * snd_soc_codec_driver. Otherwise the behavior is undefined.
1621 */
1622static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1623 struct snd_kcontrol *kcontrol)
1624{
Lars-Peter Clausen907fe362014-04-22 13:23:14 +02001625 return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
Lars-Peter Clausenea53bf72014-03-18 09:02:04 +01001626}
1627
Lars-Peter Clausenf6272ff2014-03-18 09:02:05 +01001628/**
Masanari Iida1a6ab462015-03-04 10:56:13 +09001629 * snd_soc_kcontrol_platform() - Returns the platform that registered the control
Lars-Peter Clausenf6272ff2014-03-18 09:02:05 +01001630 * @kcontrol: The control for which to get the platform
1631 *
1632 * Note: This function will only work correctly if the control has been
1633 * registered with snd_soc_add_platform_controls() or via table based setup of
1634 * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1635 */
Lars-Peter Clausen66097ca2014-04-15 22:24:21 +02001636static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
Lars-Peter Clausenf6272ff2014-03-18 09:02:05 +01001637 struct snd_kcontrol *kcontrol)
1638{
Lars-Peter Clausen907fe362014-04-22 13:23:14 +02001639 return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
Lars-Peter Clausenf6272ff2014-03-18 09:02:05 +01001640}
1641
Mark Brownfb257892011-04-28 10:57:54 +01001642int snd_soc_util_init(void);
1643void snd_soc_util_exit(void);
1644
Stephen Warrenbec4fa02011-12-12 15:55:34 -07001645int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1646 const char *propname);
Xiubo Li9a6d4862014-02-08 15:59:52 +08001647int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1648 const char *propname);
Xiubo Li89c67852014-02-14 09:34:35 +08001649int snd_soc_of_parse_tdm_slot(struct device_node *np,
Jyri Sarha61310842015-09-09 21:27:43 +03001650 unsigned int *tx_mask,
1651 unsigned int *rx_mask,
Xiubo Li89c67852014-02-14 09:34:35 +08001652 unsigned int *slots,
1653 unsigned int *slot_width);
Kuninori Morimoto5e3cdaa2015-07-15 07:07:42 +00001654void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1655 struct snd_soc_codec_conf *codec_conf,
1656 struct device_node *of_node,
1657 const char *propname);
Stephen Warrena4a54dd2011-12-12 15:55:35 -07001658int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1659 const char *propname);
Kuninori Morimotoa7930ed2013-01-14 18:36:04 -08001660unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
Jyri Sarha389cb832014-03-24 12:15:24 +02001661 const char *prefix,
1662 struct device_node **bitclkmaster,
1663 struct device_node **framemaster);
Kuninori Morimotocb470082013-09-10 17:39:56 -07001664int snd_soc_of_get_dai_name(struct device_node *of_node,
1665 const char **dai_name);
Jean-Francois Moine93b0f3e2014-11-25 13:16:12 +01001666int snd_soc_of_get_dai_link_codecs(struct device *dev,
1667 struct device_node *of_node,
1668 struct snd_soc_dai_link *dai_link);
Stephen Warrenbec4fa02011-12-12 15:55:34 -07001669
Mengdong Linf8f80362015-12-02 14:11:22 +08001670int snd_soc_add_dai_link(struct snd_soc_card *card,
1671 struct snd_soc_dai_link *dai_link);
1672void snd_soc_remove_dai_link(struct snd_soc_card *card,
1673 struct snd_soc_dai_link *dai_link);
1674
Mengdong Lin68003e62015-12-31 16:40:43 +08001675int snd_soc_register_dai(struct snd_soc_component *component,
1676 struct snd_soc_dai_driver *dai_drv);
1677
Mengdong Lin305e9022016-04-19 13:12:25 +08001678struct snd_soc_dai *snd_soc_find_dai(
1679 const struct snd_soc_dai_link_component *dlc);
1680
Mark Browna47cbe72008-07-23 14:03:07 +01001681#include <sound/soc-dai.h>
1682
Stephen Warrenfaff4bb2011-01-07 22:36:11 -07001683#ifdef CONFIG_DEBUG_FS
Mark Brown8a9dab12011-01-10 22:25:21 +00001684extern struct dentry *snd_soc_debugfs_root;
Stephen Warrenfaff4bb2011-01-07 22:36:11 -07001685#endif
1686
Mark Brown6f8ab4a2011-01-26 14:59:27 +00001687extern const struct dev_pm_ops snd_soc_pm_ops;
1688
Charles Keepaxf6d5e582014-02-18 15:22:13 +00001689/* Helper functions */
1690static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1691{
Charles Keepax783513e2015-12-29 16:25:13 +00001692 mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
Charles Keepaxf6d5e582014-02-18 15:22:13 +00001693}
1694
1695static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1696{
1697 mutex_unlock(&dapm->card->dapm_mutex);
1698}
1699
Richard Purdie808db4a2006-10-06 18:20:14 +02001700#endif