blob: 93df8bf9d54a9e1b9502836faec752b4c6aa20b0 [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>
Liam Girdwood8a978232015-05-29 19:06:14 +010030#include <sound/soc-topology.h>
Richard Purdie808db4a2006-10-06 18:20:14 +020031
Richard Purdie808db4a2006-10-06 18:20:14 +020032/*
33 * Convenience kcontrol builders
34 */
Lars-Peter Clausen57295072013-08-05 11:27:31 +020035#define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
Jon Smirl4eaa9812008-07-29 11:42:26 +010036 ((unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusi30d86ba2011-10-05 10:29:22 +030037 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
38 .rshift = shift_right, .max = xmax, .platform_max = xmax, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +020039 .invert = xinvert, .autodisable = xautodisable})
Lars-Peter Clausenc1b4d1c2014-10-25 20:25:56 +020040#define SOC_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, xsign_bit, xinvert, xautodisable) \
41 ((unsigned long)&(struct soc_mixer_control) \
42 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
43 .rshift = shift_right, .min = xmin, .max = xmax, .platform_max = xmax, \
44 .sign_bit = xsign_bit, .invert = xinvert, .autodisable = xautodisable})
Lars-Peter Clausen57295072013-08-05 11:27:31 +020045#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
46 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
Jon Smirl4eaa9812008-07-29 11:42:26 +010047#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
48 ((unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030049 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
Peter Ujfalusicdffa772011-10-04 14:39:39 +030050#define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
51 ((unsigned long)&(struct soc_mixer_control) \
52 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
53 .max = xmax, .platform_max = xmax, .invert = xinvert})
Markus Pargmanncd21b122014-01-16 16:02:11 +010054#define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
55 ((unsigned long)&(struct soc_mixer_control) \
56 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
57 .max = xmax, .min = xmin, .platform_max = xmax, .sign_bit = xsign_bit, \
58 .invert = xinvert})
Mark Brown229e3fd2012-06-22 11:40:55 +010059#define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
60 ((unsigned long)&(struct soc_mixer_control) \
61 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
62 .min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
Philipp Zabela7a4ac82008-01-10 14:37:42 +010063#define SOC_SINGLE(xname, reg, shift, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020064{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
65 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
66 .put = snd_soc_put_volsw, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +020067 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
Adam Thomson6c9d8cf2012-05-31 15:18:01 +010068#define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
69{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
70 .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
71 .put = snd_soc_put_volsw_range, \
72 .private_value = (unsigned long)&(struct soc_mixer_control) \
Mark Brown9bde4f02012-12-19 16:05:00 +000073 {.reg = xreg, .rreg = xreg, .shift = xshift, \
74 .rshift = xshift, .min = xmin, .max = xmax, \
75 .platform_max = xmax, .invert = xinvert} }
Philipp Zabela7a4ac82008-01-10 14:37:42 +010076#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
77{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
78 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
79 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
80 .tlv.p = (tlv_array), \
81 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
82 .put = snd_soc_put_volsw, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +020083 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
Brian Austin1d99f242012-03-30 10:43:55 -050084#define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
85{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
86 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
87 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
88 .tlv.p = (tlv_array),\
89 .info = snd_soc_info_volsw, \
90 .get = snd_soc_get_volsw_sx,\
91 .put = snd_soc_put_volsw_sx, \
92 .private_value = (unsigned long)&(struct soc_mixer_control) \
93 {.reg = xreg, .rreg = xreg, \
94 .shift = xshift, .rshift = xshift, \
95 .max = xmax, .min = xmin} }
Adam Thomson6c9d8cf2012-05-31 15:18:01 +010096#define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
97{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
98 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
99 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
100 .tlv.p = (tlv_array), \
101 .info = snd_soc_info_volsw_range, \
102 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
103 .private_value = (unsigned long)&(struct soc_mixer_control) \
Mark Brown9bde4f02012-12-19 16:05:00 +0000104 {.reg = xreg, .rreg = xreg, .shift = xshift, \
105 .rshift = xshift, .min = xmin, .max = xmax, \
106 .platform_max = xmax, .invert = xinvert} }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300107#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +0200108{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
109 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
110 .put = snd_soc_put_volsw, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300111 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200112 max, invert, 0) }
Jon Smirl4eaa9812008-07-29 11:42:26 +0100113#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
Richard Purdie808db4a2006-10-06 18:20:14 +0200114{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300115 .info = snd_soc_info_volsw, \
Peter Ujfalusi974815b2011-10-05 10:29:25 +0300116 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300117 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
118 xmax, xinvert) }
Mark Brown229e3fd2012-06-22 11:40:55 +0100119#define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
120 xmax, xinvert) \
121{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
122 .info = snd_soc_info_volsw_range, \
123 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
124 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
125 xshift, xmin, xmax, xinvert) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300126#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100127{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
128 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
129 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
130 .tlv.p = (tlv_array), \
131 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
132 .put = snd_soc_put_volsw, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300133 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200134 max, invert, 0) }
Jon Smirl4eaa9812008-07-29 11:42:26 +0100135#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100136{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
137 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
138 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
139 .tlv.p = (tlv_array), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300140 .info = snd_soc_info_volsw, \
Peter Ujfalusi974815b2011-10-05 10:29:25 +0300141 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300142 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
143 xmax, xinvert) }
Mark Brown229e3fd2012-06-22 11:40:55 +0100144#define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
145 xmax, xinvert, tlv_array) \
146{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
147 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
148 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
149 .tlv.p = (tlv_array), \
150 .info = snd_soc_info_volsw_range, \
151 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
152 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
153 xshift, xmin, xmax, xinvert) }
Brian Austin1d99f242012-03-30 10:43:55 -0500154#define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
155{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
156 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
157 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
158 .tlv.p = (tlv_array), \
159 .info = snd_soc_info_volsw, \
160 .get = snd_soc_get_volsw_sx, \
161 .put = snd_soc_put_volsw_sx, \
162 .private_value = (unsigned long)&(struct soc_mixer_control) \
163 {.reg = xreg, .rreg = xrreg, \
164 .shift = xshift, .rshift = xshift, \
165 .max = xmax, .min = xmin} }
Markus Pargmanncd21b122014-01-16 16:02:11 +0100166#define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
167{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
168 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
169 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
170 .tlv.p = (tlv_array), \
171 .info = snd_soc_info_volsw, \
172 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
173 .private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
174 xmin, xmax, xsign_bit, xinvert) }
Jon Smirl4eaa9812008-07-29 11:42:26 +0100175#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
Mark Browne13ac2e2008-05-28 17:58:05 +0100176{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
177 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
178 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
179 .tlv.p = (tlv_array), \
Lars-Peter Clausenc1b4d1c2014-10-25 20:25:56 +0200180 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
181 .put = snd_soc_put_volsw, \
182 .private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
Takashi Iwai9a8d38d2014-02-18 08:11:42 +0100183#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
Richard Purdie808db4a2006-10-06 18:20:14 +0200184{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
Takashi Iwai9a8d38d2014-02-18 08:11:42 +0100185 .items = xitems, .texts = xtexts, \
186 .mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
187#define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
188 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
189#define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
190{ .items = xitems, .texts = xtexts }
191#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200192{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
Takashi Iwai9a8d38d2014-02-18 08:11:42 +0100193 .mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
Charles Keepax5967cb32015-05-01 12:37:23 +0100194#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
195 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
Charles Keepax561ed682015-05-01 12:37:26 +0100196#define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
197{ .reg = xreg, .shift_l = xshift, .shift_r = xshift, \
198 .mask = xmask, .items = xitems, .texts = xtexts, \
199 .values = xvalues, .autodisable = 1}
Lars-Peter Clausenb9488372014-02-28 08:31:05 +0100200#define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
201 SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
Richard Purdie808db4a2006-10-06 18:20:14 +0200202#define SOC_ENUM(xname, xenum) \
203{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
204 .info = snd_soc_info_enum_double, \
205 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
206 .private_value = (unsigned long)&xenum }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100207#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
Richard Purdie808db4a2006-10-06 18:20:14 +0200208 xhandler_get, xhandler_put) \
209{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100210 .info = snd_soc_info_volsw, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200211 .get = xhandler_get, .put = xhandler_put, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200212 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300213#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
Daniel Mack7629ad22009-04-24 16:37:44 +0200214 xhandler_get, xhandler_put) \
215{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
216 .info = snd_soc_info_volsw, \
217 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300218 .private_value = \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200219 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100220#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
Mike Montour10144c02008-06-11 13:47:13 +0100221 xhandler_get, xhandler_put, tlv_array) \
222{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
223 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
224 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
225 .tlv.p = (tlv_array), \
226 .info = snd_soc_info_volsw, \
227 .get = xhandler_get, .put = xhandler_put, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200228 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
Joonyoung Shimd0af93d2009-07-15 20:33:47 +0900229#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
230 xhandler_get, xhandler_put, tlv_array) \
231{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
232 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
233 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
234 .tlv.p = (tlv_array), \
235 .info = snd_soc_info_volsw, \
236 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300237 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200238 xmax, xinvert, 0) }
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900239#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
240 xhandler_get, xhandler_put, tlv_array) \
241{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
242 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
243 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
244 .tlv.p = (tlv_array), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300245 .info = snd_soc_info_volsw, \
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900246 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300247 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
248 xmax, xinvert) }
Richard Purdie808db4a2006-10-06 18:20:14 +0200249#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
250{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
251 .info = snd_soc_info_bool_ext, \
252 .get = xhandler_get, .put = xhandler_put, \
253 .private_value = xdata }
254#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
255{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
Lars-Peter Clausen9a953e62013-08-10 21:33:10 +0200256 .info = snd_soc_info_enum_double, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200257 .get = xhandler_get, .put = xhandler_put, \
258 .private_value = (unsigned long)&xenum }
Richard Fitzgerald1e4c0d72014-07-07 13:16:54 +0100259#define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
260 SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
Richard Purdie808db4a2006-10-06 18:20:14 +0200261
Mark Brown71d08512011-10-10 18:31:26 +0100262#define SND_SOC_BYTES(xname, xbase, xregs) \
263{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
264 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
265 .put = snd_soc_bytes_put, .private_value = \
266 ((unsigned long)&(struct soc_bytes) \
267 {.base = xbase, .num_regs = xregs }) }
apatard@mandriva.comb6f4bb32010-05-15 17:30:01 +0200268
Mark Brownf831b052012-02-17 16:20:33 -0800269#define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \
270{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
271 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
272 .put = snd_soc_bytes_put, .private_value = \
273 ((unsigned long)&(struct soc_bytes) \
274 {.base = xbase, .num_regs = xregs, \
275 .mask = xmask }) }
276
Vinod Kould9881202014-05-02 10:58:11 +0530277#define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
278{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
279 .info = snd_soc_bytes_info_ext, \
280 .get = xhandler_get, .put = xhandler_put, \
281 .private_value = (unsigned long)&(struct soc_bytes_ext) \
282 {.max = xcount} }
Omair Mohammed Abdullah7523a272014-07-15 21:34:48 +0530283#define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
284{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
285 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
286 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
287 .tlv.c = (snd_soc_bytes_tlv_callback), \
Subhransu S. Prusty4d61b392014-08-18 14:53:03 +0530288 .info = snd_soc_bytes_info_ext, \
Omair Mohammed Abdullah7523a272014-07-15 21:34:48 +0530289 .private_value = (unsigned long)&(struct soc_bytes_ext) \
290 {.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
Kristoffer KARLSSON4183eed22012-04-20 11:32:13 +0200291#define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
292 xmin, xmax, xinvert) \
293{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
294 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
295 .put = snd_soc_put_xr_sx, \
296 .private_value = (unsigned long)&(struct soc_mreg_control) \
297 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
298 .invert = xinvert, .min = xmin, .max = xmax} }
299
Kristoffer KARLSSONdd7b10b2012-04-20 11:32:44 +0200300#define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
301 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
302 snd_soc_get_strobe, snd_soc_put_strobe)
303
Richard Purdie808db4a2006-10-06 18:20:14 +0200304/*
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100305 * Simplified versions of above macros, declaring a struct and calculating
306 * ARRAY_SIZE internally
307 */
308#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
Takashi Iwai2e7e1992014-02-18 09:08:51 +0100309 const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100310 ARRAY_SIZE(xtexts), xtexts)
311#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
312 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
313#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
Takashi Iwai2e7e1992014-02-18 09:08:51 +0100314 const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100315#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
Takashi Iwai2e7e1992014-02-18 09:08:51 +0100316 const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100317 ARRAY_SIZE(xtexts), xtexts, xvalues)
318#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
319 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
Charles Keepax561ed682015-05-01 12:37:26 +0100320
321#define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
322 const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
323 xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
324
Lars-Peter Clausenb9488372014-02-28 08:31:05 +0100325#define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
326 const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100327
328/*
Liam Girdwood0168bf02011-06-07 16:08:05 +0100329 * Component probe and remove ordering levels for components with runtime
330 * dependencies.
331 */
332#define SND_SOC_COMP_ORDER_FIRST -2
333#define SND_SOC_COMP_ORDER_EARLY -1
334#define SND_SOC_COMP_ORDER_NORMAL 0
335#define SND_SOC_COMP_ORDER_LATE 1
336#define SND_SOC_COMP_ORDER_LAST 2
337
338/*
Mark Brown0be98982008-05-19 12:31:28 +0200339 * Bias levels
340 *
341 * @ON: Bias is fully on for audio playback and capture operations.
342 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
343 * stream start and stop operations.
344 * @STANDBY: Low power standby state when no playback/capture operations are
345 * in progress. NOTE: The transition time between STANDBY and ON
346 * should be as fast as possible and no longer than 10ms.
347 * @OFF: Power Off. No restrictions on transition times.
348 */
349enum snd_soc_bias_level {
Mark Brown56fba412011-06-04 11:25:10 +0100350 SND_SOC_BIAS_OFF = 0,
351 SND_SOC_BIAS_STANDBY = 1,
352 SND_SOC_BIAS_PREPARE = 2,
353 SND_SOC_BIAS_ON = 3,
Mark Brown0be98982008-05-19 12:31:28 +0200354};
355
Stephen Warren5a504962011-12-21 10:40:59 -0700356struct device_node;
Mark Brown8a2cd612009-01-07 17:31:10 +0000357struct snd_jack;
358struct snd_soc_card;
Richard Purdie808db4a2006-10-06 18:20:14 +0200359struct snd_soc_pcm_stream;
360struct snd_soc_ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200361struct snd_soc_pcm_runtime;
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100362struct snd_soc_dai;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000363struct snd_soc_dai_driver;
Mark Brown12a48a8c2008-12-03 19:40:30 +0000364struct snd_soc_platform;
jassi brard273ebe2010-02-22 15:58:04 +0900365struct snd_soc_dai_link;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000366struct snd_soc_platform_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200367struct snd_soc_codec;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000368struct snd_soc_codec_driver;
Kuninori Morimoto030e79f2013-03-11 18:27:21 -0700369struct snd_soc_component;
370struct snd_soc_component_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200371struct soc_enum;
Mark Brown8a2cd612009-01-07 17:31:10 +0000372struct snd_soc_jack;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530373struct snd_soc_jack_zone;
Mark Brown8a2cd612009-01-07 17:31:10 +0000374struct snd_soc_jack_pin;
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200375#include <sound/soc-dapm.h>
Liam Girdwood01d75842012-04-25 12:12:49 +0100376#include <sound/soc-dpcm.h>
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000377
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600378struct snd_soc_jack_gpio;
Richard Purdie808db4a2006-10-06 18:20:14 +0200379
380typedef int (*hw_write_t)(void *,const char* ,int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200381
Liam Girdwoodb8c0dab2011-06-09 17:04:39 +0100382enum snd_soc_pcm_subclass {
383 SND_SOC_PCM_CLASS_PCM = 0,
384 SND_SOC_PCM_CLASS_BE = 1,
385};
386
Liam Girdwood01b9d992012-03-07 10:38:25 +0000387enum snd_soc_card_subclass {
Liam Girdwood6874a912012-03-09 12:02:07 +0000388 SND_SOC_CARD_CLASS_INIT = 0,
389 SND_SOC_CARD_CLASS_RUNTIME = 1,
Liam Girdwood01b9d992012-03-07 10:38:25 +0000390};
391
Mark Brownec4ee522011-03-07 20:58:11 +0000392int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
Mark Brownda1c6ea2011-08-24 20:09:01 +0100393 int source, unsigned int freq, int dir);
Mark Brownec4ee522011-03-07 20:58:11 +0000394int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
395 unsigned int freq_in, unsigned int freq_out);
396
Vinod Koul70a7ca32011-01-14 19:22:48 +0530397int snd_soc_register_card(struct snd_soc_card *card);
398int snd_soc_unregister_card(struct snd_soc_card *card);
Mark Brown0e4ff5c2013-09-16 18:02:05 +0100399int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
Jie Yangaae013d2015-04-19 09:45:48 +0800400#ifdef CONFIG_PM_SLEEP
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000401int snd_soc_suspend(struct device *dev);
402int snd_soc_resume(struct device *dev);
Jie Yangaae013d2015-04-19 09:45:48 +0800403#else
404static inline int snd_soc_suspend(struct device *dev)
405{
406 return 0;
407}
408
409static inline int snd_soc_resume(struct device *dev)
410{
411 return 0;
412}
413#endif
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000414int snd_soc_poweroff(struct device *dev);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000415int snd_soc_register_platform(struct device *dev,
Lars-Peter Clausend79e57d2013-03-27 12:02:22 +0100416 const struct snd_soc_platform_driver *platform_drv);
Peter Ujfalusi8931bf62014-04-16 15:46:11 +0300417int devm_snd_soc_register_platform(struct device *dev,
418 const struct snd_soc_platform_driver *platform_drv);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000419void snd_soc_unregister_platform(struct device *dev);
Lars-Peter Clausen71a45cd2013-04-15 19:19:49 +0200420int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
421 const struct snd_soc_platform_driver *platform_drv);
422void snd_soc_remove_platform(struct snd_soc_platform *platform);
423struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000424int snd_soc_register_codec(struct device *dev,
Mark Brown001ae4c2010-12-02 16:21:08 +0000425 const struct snd_soc_codec_driver *codec_drv,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000426 struct snd_soc_dai_driver *dai_drv, int num_dai);
427void snd_soc_unregister_codec(struct device *dev);
Kuninori Morimoto030e79f2013-03-11 18:27:21 -0700428int snd_soc_register_component(struct device *dev,
429 const struct snd_soc_component_driver *cmpnt_drv,
430 struct snd_soc_dai_driver *dai_drv, int num_dai);
Mark Browna0b03a62013-09-04 20:37:34 +0100431int devm_snd_soc_register_component(struct device *dev,
432 const struct snd_soc_component_driver *cmpnt_drv,
433 struct snd_soc_dai_driver *dai_drv, int num_dai);
Kuninori Morimoto030e79f2013-03-11 18:27:21 -0700434void snd_soc_unregister_component(struct device *dev);
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000435int snd_soc_cache_init(struct snd_soc_codec *codec);
436int snd_soc_cache_exit(struct snd_soc_codec *codec);
Lars-Peter Clausen427d2042014-11-08 16:38:07 +0100437
Liam Girdwoodf1442bc2011-07-04 11:10:15 +0100438int snd_soc_platform_read(struct snd_soc_platform *platform,
439 unsigned int reg);
440int snd_soc_platform_write(struct snd_soc_platform *platform,
441 unsigned int reg, unsigned int val);
Mark Brown354a2142011-12-22 12:16:39 +0000442int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
Vinod Koul49681072012-08-16 17:10:40 +0530443int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
Mark Brown12a48a8c2008-12-03 19:40:30 +0000444
Liam Girdwood47c88ff2012-04-25 12:12:53 +0100445struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
446 const char *dai_link, int stream);
447struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
448 const char *dai_link);
449
Lars-Peter Clausen208a1582014-03-05 13:17:42 +0100450bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
Lars-Peter Clausen24894b72014-03-05 13:17:43 +0100451void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
452void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
Lars-Peter Clausen208a1582014-03-05 13:17:42 +0100453
Lars-Peter Clausence64c8b2015-01-06 15:17:20 +0100454int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
455 unsigned int dai_fmt);
456
Mark Brown7aae8162009-11-10 16:08:04 +0000457/* Utility functions to get clock rates from various things */
458int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
459int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
Mark Brownc0fa59d2009-11-19 11:36:10 +0000460int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
Mark Brown7aae8162009-11-10 16:08:04 +0000461int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
462
Richard Purdie808db4a2006-10-06 18:20:14 +0200463/* set runtime hw params */
464int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
465 const struct snd_pcm_hardware *hw);
Richard Purdie808db4a2006-10-06 18:20:14 +0200466
Liam Girdwood07bf84a2012-04-25 12:12:52 +0100467int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
468 int cmd, struct snd_soc_platform *platform);
469
Benoit Cousson93e69582014-07-08 23:19:38 +0200470int soc_dai_hw_params(struct snd_pcm_substream *substream,
471 struct snd_pcm_hw_params *params,
472 struct snd_soc_dai *dai);
473
Mark Brown8a2cd612009-01-07 17:31:10 +0000474/* Jack reporting */
Lars-Peter Clausen97093992015-03-04 10:33:17 +0100475int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
476 struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
477 unsigned int num_pins);
478
Mark Brown8a2cd612009-01-07 17:31:10 +0000479void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
480int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
481 struct snd_soc_jack_pin *pins);
Mark Brownd5021ec2010-03-22 12:06:30 +0000482void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
483 struct notifier_block *nb);
484void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
485 struct notifier_block *nb);
Vinod Koulfa9879e2011-02-09 14:44:17 +0530486int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
487 struct snd_soc_jack_zone *zones);
488int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600489#ifdef CONFIG_GPIOLIB
490int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
491 struct snd_soc_jack_gpio *gpios);
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300492int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
493 struct snd_soc_jack *jack,
494 int count, struct snd_soc_jack_gpio *gpios);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600495void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
496 struct snd_soc_jack_gpio *gpios);
Takashi Iwai8778ac62013-11-21 15:55:06 +0100497#else
498static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
499 struct snd_soc_jack_gpio *gpios)
500{
501 return 0;
502}
503
Jarkko Nikulae6674872014-05-27 10:39:57 +0300504static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
505 struct snd_soc_jack *jack,
506 int count,
507 struct snd_soc_jack_gpio *gpios)
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300508{
509 return 0;
510}
511
Takashi Iwai8778ac62013-11-21 15:55:06 +0100512static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
513 struct snd_soc_jack_gpio *gpios)
514{
515}
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600516#endif
Mark Brown8a2cd612009-01-07 17:31:10 +0000517
Richard Purdie808db4a2006-10-06 18:20:14 +0200518/* codec register bit access */
Bard Liao1a390192014-04-08 11:18:10 +0800519int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned int reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300520 unsigned int mask, unsigned int value);
Mark Browndd1b3d52009-12-04 14:22:03 +0000521int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
Bard Liao1a390192014-04-08 11:18:10 +0800522 unsigned int reg, unsigned int mask,
Mark Browndd1b3d52009-12-04 14:22:03 +0000523 unsigned int value);
Bard Liao1a390192014-04-08 11:18:10 +0800524int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned int reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300525 unsigned int mask, unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200526
Lars-Peter Clausen336b8422014-11-10 22:41:46 +0100527#ifdef CONFIG_SND_SOC_AC97_BUS
Lars-Peter Clausen47e03942015-01-23 16:21:36 +0100528struct snd_ac97 *snd_soc_alloc_ac97_codec(struct snd_soc_codec *codec);
Lars-Peter Clausen358a8bb2014-11-10 22:41:53 +0100529struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec);
530void snd_soc_free_ac97_codec(struct snd_ac97 *ac97);
Richard Purdie808db4a2006-10-06 18:20:14 +0200531
Mark Brownb047e1c2013-06-26 12:45:59 +0100532int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
Markus Pargmann741a5092013-08-19 17:05:55 +0200533int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
534 struct platform_device *pdev);
Mark Brownb047e1c2013-06-26 12:45:59 +0100535
Lars-Peter Clausen336b8422014-11-10 22:41:46 +0100536extern struct snd_ac97_bus_ops *soc_ac97_ops;
Lars-Peter Clausen336b8422014-11-10 22:41:46 +0100537#else
Lars-Peter Clausen336b8422014-11-10 22:41:46 +0100538static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
539 struct platform_device *pdev)
540{
541 return 0;
542}
543
544static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
545{
546 return 0;
547}
548#endif
549
Richard Purdie808db4a2006-10-06 18:20:14 +0200550/*
551 *Controls
552 */
553struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
Mark Brown30565572012-02-16 17:07:42 -0800554 void *data, const char *long_name,
Mark Brownefb7ac32011-03-08 17:23:24 +0000555 const char *prefix);
Dimitris Papastamos4fefd692013-07-29 13:51:58 +0100556struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
557 const char *name);
Lars-Peter Clausen0f2780a2014-07-17 22:01:08 +0200558int snd_soc_add_component_controls(struct snd_soc_component *component,
559 const struct snd_kcontrol_new *controls, unsigned int num_controls);
Liam Girdwood022658b2012-02-03 17:43:09 +0000560int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
Lars-Peter Clausen0f2780a2014-07-17 22:01:08 +0200561 const struct snd_kcontrol_new *controls, unsigned int num_controls);
Liam Girdwooda491a5c2011-07-04 22:10:51 +0100562int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
Lars-Peter Clausen0f2780a2014-07-17 22:01:08 +0200563 const struct snd_kcontrol_new *controls, unsigned int num_controls);
Liam Girdwood022658b2012-02-03 17:43:09 +0000564int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
565 const struct snd_kcontrol_new *controls, int num_controls);
566int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
567 const struct snd_kcontrol_new *controls, int num_controls);
Richard Purdie808db4a2006-10-06 18:20:14 +0200568int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
569 struct snd_ctl_elem_info *uinfo);
Richard Purdie808db4a2006-10-06 18:20:14 +0200570int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
571 struct snd_ctl_elem_value *ucontrol);
572int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
573 struct snd_ctl_elem_value *ucontrol);
574int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
575 struct snd_ctl_elem_info *uinfo);
Philipp Zabel392abe92008-05-13 14:03:40 +0200576#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
Richard Purdie808db4a2006-10-06 18:20:14 +0200577int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
578 struct snd_ctl_elem_value *ucontrol);
579int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
580 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusia92f1392011-10-06 07:43:21 +0300581#define snd_soc_get_volsw_2r snd_soc_get_volsw
582#define snd_soc_put_volsw_2r snd_soc_put_volsw
Brian Austin1d99f242012-03-30 10:43:55 -0500583int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
584 struct snd_ctl_elem_value *ucontrol);
585int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
586 struct snd_ctl_elem_value *ucontrol);
Adam Thomson6c9d8cf2012-05-31 15:18:01 +0100587int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
588 struct snd_ctl_elem_info *uinfo);
589int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
590 struct snd_ctl_elem_value *ucontrol);
591int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
592 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi637d3842010-05-07 14:05:49 +0300593int snd_soc_limit_volume(struct snd_soc_codec *codec,
594 const char *name, int max);
Mark Brown71d08512011-10-10 18:31:26 +0100595int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
596 struct snd_ctl_elem_info *uinfo);
597int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
598 struct snd_ctl_elem_value *ucontrol);
599int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
600 struct snd_ctl_elem_value *ucontrol);
Vinod Kould9881202014-05-02 10:58:11 +0530601int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
602 struct snd_ctl_elem_info *ucontrol);
Omair Mohammed Abdullah7523a272014-07-15 21:34:48 +0530603int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
604 unsigned int size, unsigned int __user *tlv);
Kristoffer KARLSSON4183eed22012-04-20 11:32:13 +0200605int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
606 struct snd_ctl_elem_info *uinfo);
607int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
608 struct snd_ctl_elem_value *ucontrol);
609int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
610 struct snd_ctl_elem_value *ucontrol);
Kristoffer KARLSSONdd7b10b2012-04-20 11:32:44 +0200611int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
612 struct snd_ctl_elem_value *ucontrol);
613int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
614 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200615
Mark Brown8a2cd612009-01-07 17:31:10 +0000616/**
617 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
618 *
619 * @pin: name of the pin to update
620 * @mask: bits to check for in reported jack status
621 * @invert: if non-zero then pin is enabled when status is not reported
622 */
623struct snd_soc_jack_pin {
624 struct list_head list;
625 const char *pin;
626 int mask;
627 bool invert;
628};
629
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600630/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530631 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
632 *
633 * @min_mv: start voltage in mv
634 * @max_mv: end voltage in mv
635 * @jack_type: type of jack that is expected for this voltage
636 * @debounce_time: debounce_time for jack, codec driver should wait for this
637 * duration before reading the adc for voltages
638 * @:list: list container
639 */
640struct snd_soc_jack_zone {
641 unsigned int min_mv;
642 unsigned int max_mv;
643 unsigned int jack_type;
644 unsigned int debounce_time;
645 struct list_head list;
646};
647
648/**
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600649 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
650 *
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300651 * @gpio: legacy gpio number
Jarkko Nikula83ad1522014-05-27 13:54:18 +0300652 * @idx: gpio descriptor index within the function of the GPIO
653 * consumer device
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300654 * @gpiod_dev GPIO consumer device
Jarkko Nikula83ad1522014-05-27 13:54:18 +0300655 * @name: gpio name. Also as connection ID for the GPIO consumer
656 * device function name lookup
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600657 * @report: value to report when jack detected
658 * @invert: report presence in low state
659 * @debouce_time: debouce time in ms
Mark Brown7887ab32011-02-17 16:35:55 -0800660 * @wake: enable as wake source
Mark Brownfadddc82011-02-17 16:41:42 -0800661 * @jack_status_check: callback function which overrides the detection
662 * to provide more complex checks (eg, reading an
663 * ADC).
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600664 */
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600665struct snd_soc_jack_gpio {
666 unsigned int gpio;
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300667 unsigned int idx;
668 struct device *gpiod_dev;
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600669 const char *name;
670 int report;
671 int invert;
672 int debounce_time;
Mark Brown7887ab32011-02-17 16:35:55 -0800673 bool wake;
674
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600675 struct snd_soc_jack *jack;
Mark Brown4c14d782010-10-06 15:54:28 -0700676 struct delayed_work work;
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300677 struct gpio_desc *desc;
Joonyoung Shimc871a052009-11-12 17:14:04 +0900678
xiangxiaocb29d7b2014-02-23 14:40:44 +0800679 void *data;
680 int (*jack_status_check)(void *data);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600681};
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600682
Mark Brown8a2cd612009-01-07 17:31:10 +0000683struct snd_soc_jack {
Mark Brown2667b4b2012-03-12 14:07:49 +0000684 struct mutex mutex;
Mark Brown8a2cd612009-01-07 17:31:10 +0000685 struct snd_jack *jack;
Lars-Peter Clausen97093992015-03-04 10:33:17 +0100686 struct snd_soc_card *card;
Mark Brown8a2cd612009-01-07 17:31:10 +0000687 struct list_head pins;
688 int status;
Mark Brownd5021ec2010-03-22 12:06:30 +0000689 struct blocking_notifier_head notifier;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530690 struct list_head jack_zones;
Mark Brown8a2cd612009-01-07 17:31:10 +0000691};
692
Richard Purdie808db4a2006-10-06 18:20:14 +0200693/* SoC PCM stream information */
694struct snd_soc_pcm_stream {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000695 const char *stream_name;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100696 u64 formats; /* SNDRV_PCM_FMTBIT_* */
697 unsigned int rates; /* SNDRV_PCM_RATE_* */
Richard Purdie808db4a2006-10-06 18:20:14 +0200698 unsigned int rate_min; /* min rate */
699 unsigned int rate_max; /* max rate */
700 unsigned int channels_min; /* min channels */
701 unsigned int channels_max; /* max channels */
Mark Brown58ba9b22012-01-16 18:38:51 +0000702 unsigned int sig_bits; /* number of bits of content */
Richard Purdie808db4a2006-10-06 18:20:14 +0200703};
704
705/* SoC audio ops */
706struct snd_soc_ops {
707 int (*startup)(struct snd_pcm_substream *);
708 void (*shutdown)(struct snd_pcm_substream *);
709 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
710 int (*hw_free)(struct snd_pcm_substream *);
711 int (*prepare)(struct snd_pcm_substream *);
712 int (*trigger)(struct snd_pcm_substream *, int);
713};
714
Vinod Koul49681072012-08-16 17:10:40 +0530715struct snd_soc_compr_ops {
716 int (*startup)(struct snd_compr_stream *);
717 void (*shutdown)(struct snd_compr_stream *);
718 int (*set_params)(struct snd_compr_stream *);
719 int (*trigger)(struct snd_compr_stream *);
720};
721
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700722/* component interface */
723struct snd_soc_component_driver {
724 const char *name;
Kuninori Morimotocb470082013-09-10 17:39:56 -0700725
Lars-Peter Clausen61aca562014-08-19 15:51:21 +0200726 /* Default control and setup, added after probe() is run */
727 const struct snd_kcontrol_new *controls;
728 unsigned int num_controls;
729 const struct snd_soc_dapm_widget *dapm_widgets;
730 unsigned int num_dapm_widgets;
731 const struct snd_soc_dapm_route *dapm_routes;
732 unsigned int num_dapm_routes;
733
734 int (*probe)(struct snd_soc_component *);
735 void (*remove)(struct snd_soc_component *);
736
Kuninori Morimotocb470082013-09-10 17:39:56 -0700737 /* DT */
738 int (*of_xlate_dai_name)(struct snd_soc_component *component,
739 struct of_phandle_args *args,
740 const char **dai_name);
Lars-Peter Clausen14e8bde2014-06-16 18:13:08 +0200741 void (*seq_notifier)(struct snd_soc_component *, enum snd_soc_dapm_type,
742 int subseq);
743 int (*stream_event)(struct snd_soc_component *, int event);
Lars-Peter Clausenf1d45cc32014-08-19 15:51:19 +0200744
745 /* probe ordering - for components with runtime dependencies */
746 int probe_order;
747 int remove_order;
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700748};
749
750struct snd_soc_component {
751 const char *name;
752 int id;
Lars-Peter Clausen94f99c82014-06-16 18:13:01 +0200753 const char *name_prefix;
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700754 struct device *dev;
Lars-Peter Clausen00200102014-07-17 22:01:07 +0200755 struct snd_soc_card *card;
Lars-Peter Clausencdde4cc2014-03-05 13:17:47 +0100756
757 unsigned int active;
758
Lars-Peter Clausen3d594002014-03-05 13:17:48 +0100759 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
Lars-Peter Clausen98e639f2014-03-18 09:02:11 +0100760 unsigned int registered_as_component:1;
Lars-Peter Clausenf1d45cc32014-08-19 15:51:19 +0200761 unsigned int probed:1;
Lars-Peter Clausen3d594002014-03-05 13:17:48 +0100762
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700763 struct list_head list;
764
Kuninori Morimoto6833c452013-10-16 22:05:26 -0700765 struct snd_soc_dai_driver *dai_drv;
766 int num_dai;
767
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700768 const struct snd_soc_component_driver *driver;
Lars-Peter Clausen1438c2f2014-03-09 17:41:47 +0100769
770 struct list_head dai_list;
Lars-Peter Clausene2c330b2014-04-22 13:23:13 +0200771
772 int (*read)(struct snd_soc_component *, unsigned int, unsigned int *);
773 int (*write)(struct snd_soc_component *, unsigned int, unsigned int);
774
775 struct regmap *regmap;
776 int val_bytes;
777
778 struct mutex io_mutex;
Lars-Peter Clausence0fc932014-06-16 18:13:06 +0200779
Liam Girdwood8a978232015-05-29 19:06:14 +0100780 /* attached dynamic objects */
781 struct list_head dobj_list;
782
Lars-Peter Clausen81c7cfd2014-08-19 15:51:18 +0200783#ifdef CONFIG_DEBUG_FS
784 struct dentry *debugfs_root;
785#endif
786
787 /*
788 * DO NOT use any of the fields below in drivers, they are temporary and
789 * are going to be removed again soon. If you use them in driver code the
790 * driver will be marked as BROKEN when these fields are removed.
791 */
792
Lars-Peter Clausence0fc932014-06-16 18:13:06 +0200793 /* Don't use these, use snd_soc_component_get_dapm() */
794 struct snd_soc_dapm_context dapm;
795 struct snd_soc_dapm_context *dapm_ptr;
Lars-Peter Clausen81c7cfd2014-08-19 15:51:18 +0200796
Lars-Peter Clausenf1d45cc32014-08-19 15:51:19 +0200797 const struct snd_kcontrol_new *controls;
798 unsigned int num_controls;
799 const struct snd_soc_dapm_widget *dapm_widgets;
800 unsigned int num_dapm_widgets;
801 const struct snd_soc_dapm_route *dapm_routes;
802 unsigned int num_dapm_routes;
Lars-Peter Clausenf1d45cc32014-08-19 15:51:19 +0200803 struct snd_soc_codec *codec;
804
805 int (*probe)(struct snd_soc_component *);
806 void (*remove)(struct snd_soc_component *);
807
Lars-Peter Clausen81c7cfd2014-08-19 15:51:18 +0200808#ifdef CONFIG_DEBUG_FS
809 void (*init_debugfs)(struct snd_soc_component *component);
810 const char *debugfs_prefix;
811#endif
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700812};
813
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000814/* SoC Audio Codec device */
Richard Purdie808db4a2006-10-06 18:20:14 +0200815struct snd_soc_codec {
Mark Brown0d0cf002008-12-10 14:32:45 +0000816 struct device *dev;
Mark Brown001ae4c2010-12-02 16:21:08 +0000817 const struct snd_soc_codec_driver *driver;
Mark Brown0d0cf002008-12-10 14:32:45 +0000818
819 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000820 struct list_head card_list;
Richard Purdie808db4a2006-10-06 18:20:14 +0200821
822 /* runtime */
Dimitris Papastamosdad8e7a2011-01-19 14:53:36 +0000823 unsigned int cache_bypass:1; /* Suppress access to the cache */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000824 unsigned int suspended:1; /* Codec is in suspend PM state */
Dimitris Papastamosfdf0f542010-12-02 16:11:06 +0000825 unsigned int cache_init:1; /* codec cache has been initialized */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000826
827 /* codec IO */
828 void *control_data; /* codec control (i2c/3wire) data */
829 hw_write_t hw_write;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000830 void *reg_cache;
Mark Browna96ca332010-01-19 22:49:43 +0000831
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700832 /* component */
833 struct snd_soc_component component;
834
Lars-Peter Clausen39ed68c2015-04-27 22:13:22 +0200835 /* Don't access this directly, use snd_soc_codec_get_dapm() */
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200836 struct snd_soc_dapm_context dapm;
Richard Purdie808db4a2006-10-06 18:20:14 +0200837
Mark Brown384c89e2008-12-03 17:34:03 +0000838#ifdef CONFIG_DEBUG_FS
839 struct dentry *debugfs_reg;
Mark Brown384c89e2008-12-03 17:34:03 +0000840#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200841};
842
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000843/* codec driver */
844struct snd_soc_codec_driver {
845
846 /* driver ops */
847 int (*probe)(struct snd_soc_codec *);
848 int (*remove)(struct snd_soc_codec *);
Lars-Peter Clausen84b315e2011-12-02 10:18:28 +0100849 int (*suspend)(struct snd_soc_codec *);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000850 int (*resume)(struct snd_soc_codec *);
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700851 struct snd_soc_component_driver component_driver;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000852
Mark Brownb7af1da2011-04-07 19:18:44 +0900853 /* Default control and setup, added after probe() is run */
854 const struct snd_kcontrol_new *controls;
855 int num_controls;
Mark Brown89b95ac02011-03-07 16:38:44 +0000856 const struct snd_soc_dapm_widget *dapm_widgets;
857 int num_dapm_widgets;
858 const struct snd_soc_dapm_route *dapm_routes;
859 int num_dapm_routes;
860
Mark Brownec4ee522011-03-07 20:58:11 +0000861 /* codec wide operations */
862 int (*set_sysclk)(struct snd_soc_codec *codec,
Mark Brownda1c6ea2011-08-24 20:09:01 +0100863 int clk_id, int source, unsigned int freq, int dir);
Mark Brownec4ee522011-03-07 20:58:11 +0000864 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
865 unsigned int freq_in, unsigned int freq_out);
866
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000867 /* codec IO */
Xiubo Lia39f75f2014-03-26 13:40:23 +0800868 struct regmap *(*get_regmap)(struct device *);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000869 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
870 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
Mark Brown4a8923b2011-08-24 19:12:49 +0100871 unsigned int reg_cache_size;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000872 short reg_cache_step;
873 short reg_word_size;
874 const void *reg_cache_default;
875
876 /* codec bias level */
877 int (*set_bias_level)(struct snd_soc_codec *,
878 enum snd_soc_bias_level level);
Mark Brown33c5f962011-08-22 18:40:30 +0100879 bool idle_bias_off;
Lars-Peter Clausen86dbf2a2014-09-04 19:44:06 +0200880 bool suspend_bias_off;
Mark Brown474b62d2011-01-18 16:14:44 +0000881
882 void (*seq_notifier)(struct snd_soc_dapm_context *,
Mark Brownf85a9e02011-01-26 21:41:28 +0000883 enum snd_soc_dapm_type, int);
Liam Girdwood0168bf02011-06-07 16:08:05 +0100884
Mark Brown5124e692012-02-08 13:20:50 +0000885 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */
Richard Purdie808db4a2006-10-06 18:20:14 +0200886};
887
888/* SoC platform interface */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000889struct snd_soc_platform_driver {
Richard Purdie808db4a2006-10-06 18:20:14 +0200890
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000891 int (*probe)(struct snd_soc_platform *);
892 int (*remove)(struct snd_soc_platform *);
Lars-Peter Clausenb37f1d12014-03-18 09:02:12 +0100893 struct snd_soc_component_driver component_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200894
895 /* pcm creation and destruction */
Liam Girdwood552d1ef2011-06-07 16:08:33 +0100896 int (*pcm_new)(struct snd_soc_pcm_runtime *);
Richard Purdie808db4a2006-10-06 18:20:14 +0200897 void (*pcm_free)(struct snd_pcm *);
898
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200899 /*
900 * For platform caused delay reporting.
901 * Optional.
902 */
903 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
904 struct snd_soc_dai *);
905
Vinod Koul49681072012-08-16 17:10:40 +0530906 /* platform stream pcm ops */
Lars-Peter Clausen1f03f552013-03-27 12:02:23 +0100907 const struct snd_pcm_ops *ops;
Liam Girdwood0168bf02011-06-07 16:08:05 +0100908
Vinod Koul49681072012-08-16 17:10:40 +0530909 /* platform stream compress ops */
Lars-Peter Clausenef03c9a2013-03-27 12:02:24 +0100910 const struct snd_compr_ops *compr_ops;
Vinod Koul49681072012-08-16 17:10:40 +0530911
Liam Girdwood07bf84a2012-04-25 12:12:52 +0100912 int (*bespoke_trigger)(struct snd_pcm_substream *, int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200913};
914
Benoit Cousson88bd8702014-07-08 23:19:34 +0200915struct snd_soc_dai_link_component {
916 const char *name;
Jean-Francois Moinec362eff2014-11-25 12:14:48 +0100917 struct device_node *of_node;
Benoit Cousson88bd8702014-07-08 23:19:34 +0200918 const char *dai_name;
919};
920
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000921struct snd_soc_platform {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000922 struct device *dev;
Lars-Peter Clausend79e57d2013-03-27 12:02:22 +0100923 const struct snd_soc_platform_driver *driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200924
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000925 struct list_head list;
Liam Girdwoodb7950642011-07-04 22:10:52 +0100926
Lars-Peter Clausenb37f1d12014-03-18 09:02:12 +0100927 struct snd_soc_component component;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000928};
Richard Purdie808db4a2006-10-06 18:20:14 +0200929
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000930struct snd_soc_dai_link {
931 /* config - must be set by machine driver */
932 const char *name; /* Codec name */
933 const char *stream_name; /* Stream name */
Stephen Warrenbc926572012-05-25 18:22:11 -0600934 /*
935 * You MAY specify the link's CPU-side device, either by device name,
936 * or by DT/OF node, but not both. If this information is omitted,
937 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
938 * must be globally unique. These fields are currently typically used
939 * only for codec to codec links, or systems using device tree.
940 */
941 const char *cpu_name;
Sylwester Nawrocki8ad9f9e2014-06-16 16:33:46 +0200942 struct device_node *cpu_of_node;
Stephen Warrenbc926572012-05-25 18:22:11 -0600943 /*
944 * You MAY specify the DAI name of the CPU DAI. If this information is
945 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
946 * only, which only works well when that device exposes a single DAI.
947 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000948 const char *cpu_dai_name;
Stephen Warrenbc926572012-05-25 18:22:11 -0600949 /*
950 * You MUST specify the link's codec, either by device name, or by
951 * DT/OF node, but not both.
952 */
953 const char *codec_name;
Sylwester Nawrocki8ad9f9e2014-06-16 16:33:46 +0200954 struct device_node *codec_of_node;
Stephen Warrenbc926572012-05-25 18:22:11 -0600955 /* You MUST specify the DAI name within the codec */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000956 const char *codec_dai_name;
Benoit Cousson88bd8702014-07-08 23:19:34 +0200957
958 struct snd_soc_dai_link_component *codecs;
959 unsigned int num_codecs;
960
Stephen Warrenbc926572012-05-25 18:22:11 -0600961 /*
962 * You MAY specify the link's platform/PCM/DMA driver, either by
963 * device name, or by DT/OF node, but not both. Some forms of link
964 * do not need a platform.
965 */
966 const char *platform_name;
Sylwester Nawrocki8ad9f9e2014-06-16 16:33:46 +0200967 struct device_node *platform_of_node;
Liam Girdwood01d75842012-04-25 12:12:49 +0100968 int be_id; /* optional ID for machine driver BE identification */
Liam Girdwood4ccab3e2008-01-10 14:39:01 +0100969
Mark Brownc74184e2012-04-04 22:12:09 +0100970 const struct snd_soc_pcm_stream *params;
Nikesh Oswalc6615082015-02-02 17:06:44 +0000971 unsigned int num_params;
Mark Brownc74184e2012-04-04 22:12:09 +0100972
Mark Brown75d9ac42011-09-27 16:41:01 +0100973 unsigned int dai_fmt; /* format to set on init */
974
Liam Girdwood01d75842012-04-25 12:12:49 +0100975 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
976
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000977 /* codec/machine specific init - e.g. add machine controls */
978 int (*init)(struct snd_soc_pcm_runtime *rtd);
Mark Brown06f409d2009-04-07 18:10:13 +0100979
Liam Girdwood01d75842012-04-25 12:12:49 +0100980 /* optional hw_params re-writing for BE and FE sync */
981 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
982 struct snd_pcm_hw_params *params);
983
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000984 /* machine stream operations */
Lars-Peter Clausen13aec722013-01-10 17:06:15 +0100985 const struct snd_soc_ops *ops;
986 const struct snd_soc_compr_ops *compr_ops;
Fabio Estevamd6bead02013-08-29 10:32:13 -0300987
988 /* For unidirectional dai links */
989 bool playback_only;
990 bool capture_only;
Kuninori Morimoto2dc0f162015-04-21 07:02:34 +0000991
992 /* Mark this pcm with non atomic ops */
993 bool nonatomic;
994
995 /* Keep DAI active over suspend */
996 unsigned int ignore_suspend:1;
997
998 /* Symmetry requirements */
999 unsigned int symmetric_rates:1;
1000 unsigned int symmetric_channels:1;
1001 unsigned int symmetric_samplebits:1;
1002
1003 /* Do not create a PCM for this DAI link (Backend link) */
1004 unsigned int no_pcm:1;
1005
1006 /* This DAI link can route to other DAI links at runtime (Frontend)*/
1007 unsigned int dynamic:1;
1008
1009 /* DPCM capture and Playback support */
1010 unsigned int dpcm_capture:1;
1011 unsigned int dpcm_playback:1;
1012
Kuninori Morimotob073ed42015-05-12 02:03:33 +00001013 /* DPCM used FE & BE merged format */
1014 unsigned int dpcm_merged_format:1;
1015
Kuninori Morimoto2dc0f162015-04-21 07:02:34 +00001016 /* pmdown_time is ignored at stop */
1017 unsigned int ignore_pmdown_time:1;
Richard Purdie808db4a2006-10-06 18:20:14 +02001018};
1019
Dimitris Papastamosff819b82010-12-02 14:53:03 +00001020struct snd_soc_codec_conf {
Sebastian Reichel3ca041e2014-04-28 16:07:22 +02001021 /*
1022 * specify device either by device name, or by
1023 * DT/OF node, but not both.
1024 */
Jarkko Nikulaead9b912010-11-13 20:40:44 +02001025 const char *dev_name;
Jean-Francois Moinec362eff2014-11-25 12:14:48 +01001026 struct device_node *of_node;
Dimitris Papastamosff819b82010-12-02 14:53:03 +00001027
1028 /*
1029 * optional map of kcontrol, widget and path name prefixes that are
1030 * associated per device
1031 */
Jarkko Nikulaead9b912010-11-13 20:40:44 +02001032 const char *name_prefix;
1033};
1034
Jarkko Nikula2eea3922010-11-25 17:47:38 +02001035struct snd_soc_aux_dev {
1036 const char *name; /* Codec name */
Sebastian Reichel3ca041e2014-04-28 16:07:22 +02001037
1038 /*
1039 * specify multi-codec either by device name, or by
1040 * DT/OF node, but not both.
1041 */
1042 const char *codec_name;
Jean-Francois Moinec362eff2014-11-25 12:14:48 +01001043 struct device_node *codec_of_node;
Jarkko Nikula2eea3922010-11-25 17:47:38 +02001044
1045 /* codec/machine specific init - e.g. add machine controls */
Lars-Peter Clausen57bf7722014-08-19 15:51:23 +02001046 int (*init)(struct snd_soc_component *component);
Jarkko Nikula2eea3922010-11-25 17:47:38 +02001047};
1048
Mark Brown87506542008-11-18 20:50:34 +00001049/* SoC card */
1050struct snd_soc_card {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001051 const char *name;
Liam Girdwood22de71b2011-05-12 16:14:04 +01001052 const char *long_name;
1053 const char *driver_name;
Mark Brownc5af3a22008-11-28 13:29:45 +00001054 struct device *dev;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001055 struct snd_card *snd_card;
1056 struct module *owner;
Mark Brownc5af3a22008-11-28 13:29:45 +00001057
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001058 struct mutex mutex;
Liam Girdwooda73fb2df2012-03-07 10:38:26 +00001059 struct mutex dapm_mutex;
Mark Brownc5af3a22008-11-28 13:29:45 +00001060
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001061 bool instantiated;
Richard Purdie808db4a2006-10-06 18:20:14 +02001062
Mark Browne7361ec2011-01-26 14:17:20 +00001063 int (*probe)(struct snd_soc_card *card);
Mark Brown28e9ad92011-03-02 18:36:34 +00001064 int (*late_probe)(struct snd_soc_card *card);
Mark Browne7361ec2011-01-26 14:17:20 +00001065 int (*remove)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +02001066
1067 /* the pre and post PM functions are used to do any PM work before and
1068 * after the codec and DAI's do any PM work. */
Mark Brown70b2ac12011-01-26 14:05:25 +00001069 int (*suspend_pre)(struct snd_soc_card *card);
1070 int (*suspend_post)(struct snd_soc_card *card);
1071 int (*resume_pre)(struct snd_soc_card *card);
1072 int (*resume_post)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +02001073
Liam Girdwood0b4d2212008-01-10 14:36:20 +01001074 /* callbacks */
Mark Brown87506542008-11-18 20:50:34 +00001075 int (*set_bias_level)(struct snd_soc_card *,
Mark Brownd4c60052011-06-06 19:13:23 +01001076 struct snd_soc_dapm_context *dapm,
Mark Brown0be98982008-05-19 12:31:28 +02001077 enum snd_soc_bias_level level);
Mark Brown1badabd2010-12-04 12:41:04 +00001078 int (*set_bias_level_post)(struct snd_soc_card *,
Mark Brownd4c60052011-06-06 19:13:23 +01001079 struct snd_soc_dapm_context *dapm,
Mark Brown1badabd2010-12-04 12:41:04 +00001080 enum snd_soc_bias_level level);
Liam Girdwood0b4d2212008-01-10 14:36:20 +01001081
Mark Brown6c5f1fe2010-02-17 14:30:44 +00001082 long pmdown_time;
Mark Brown96dd3622010-02-12 11:05:44 +00001083
Richard Purdie808db4a2006-10-06 18:20:14 +02001084 /* CPU <--> Codec DAI links */
1085 struct snd_soc_dai_link *dai_link;
1086 int num_links;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001087 struct snd_soc_pcm_runtime *rtd;
1088 int num_rtd;
Mark Brown63084192008-12-02 15:08:03 +00001089
Dimitris Papastamosff819b82010-12-02 14:53:03 +00001090 /* optional codec specific configuration */
1091 struct snd_soc_codec_conf *codec_conf;
1092 int num_configs;
Jarkko Nikulaead9b912010-11-13 20:40:44 +02001093
Jarkko Nikula2eea3922010-11-25 17:47:38 +02001094 /*
1095 * optional auxiliary devices such as amplifiers or codecs with DAI
1096 * link unused
1097 */
1098 struct snd_soc_aux_dev *aux_dev;
1099 int num_aux_devs;
1100 struct snd_soc_pcm_runtime *rtd_aux;
1101 int num_aux_rtd;
1102
Mark Brownb7af1da2011-04-07 19:18:44 +09001103 const struct snd_kcontrol_new *controls;
1104 int num_controls;
1105
Mark Brownb8ad29d2011-03-02 18:35:51 +00001106 /*
1107 * Card-specific routes and widgets.
Nicolin Chenf23e8602015-02-14 17:22:49 -08001108 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
Mark Brownb8ad29d2011-03-02 18:35:51 +00001109 */
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +02001110 const struct snd_soc_dapm_widget *dapm_widgets;
Mark Brownb8ad29d2011-03-02 18:35:51 +00001111 int num_dapm_widgets;
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +02001112 const struct snd_soc_dapm_route *dapm_routes;
Mark Brownb8ad29d2011-03-02 18:35:51 +00001113 int num_dapm_routes;
Nicolin Chenf23e8602015-02-14 17:22:49 -08001114 const struct snd_soc_dapm_widget *of_dapm_widgets;
1115 int num_of_dapm_widgets;
1116 const struct snd_soc_dapm_route *of_dapm_routes;
1117 int num_of_dapm_routes;
Stephen Warren16332812011-11-23 12:42:04 -07001118 bool fully_routed;
Mark Brownb8ad29d2011-03-02 18:35:51 +00001119
Mark Brown63084192008-12-02 15:08:03 +00001120 struct work_struct deferred_resume_work;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001121
1122 /* lists of probed devices belonging to this card */
1123 struct list_head codec_dev_list;
Jarkko Nikulaa6052152010-11-05 20:35:19 +02001124
Jarkko Nikula97c866d2010-12-14 12:18:31 +02001125 struct list_head widgets;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +02001126 struct list_head paths;
Jarkko Nikula7be31be82010-12-14 12:18:32 +02001127 struct list_head dapm_list;
Mark Browndb432b42011-10-03 21:06:40 +01001128 struct list_head dapm_dirty;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +02001129
Liam Girdwood8a978232015-05-29 19:06:14 +01001130 /* attached dynamic objects */
1131 struct list_head dobj_list;
1132
Mark Browne37a4972011-03-02 18:21:57 +00001133 /* Generic DAPM context for the card */
1134 struct snd_soc_dapm_context dapm;
Mark Brownde02d072011-09-20 21:43:24 +01001135 struct snd_soc_dapm_stats dapm_stats;
Lars-Peter Clausen564c65042013-07-29 17:13:55 +02001136 struct snd_soc_dapm_update *update;
Mark Browne37a4972011-03-02 18:21:57 +00001137
Jarkko Nikulaa6052152010-11-05 20:35:19 +02001138#ifdef CONFIG_DEBUG_FS
1139 struct dentry *debugfs_card_root;
Jarkko Nikula3a45b862010-11-05 20:35:21 +02001140 struct dentry *debugfs_pop_time;
Jarkko Nikulaa6052152010-11-05 20:35:19 +02001141#endif
Jarkko Nikula3a45b862010-11-05 20:35:21 +02001142 u32 pop_time;
Mark Browndddf3e42011-01-28 13:11:47 +00001143
1144 void *drvdata;
Richard Purdie808db4a2006-10-06 18:20:14 +02001145};
1146
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001147/* SoC machine DAI configuration, glues a codec and cpu DAI together */
Mark Brownd66a3272011-11-10 11:46:13 +00001148struct snd_soc_pcm_runtime {
Mark Brown36ae1a92012-01-06 17:12:45 -08001149 struct device *dev;
Mark Brown87506542008-11-18 20:50:34 +00001150 struct snd_soc_card *card;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001151 struct snd_soc_dai_link *dai_link;
Liam Girdwoodb8c0dab2011-06-09 17:04:39 +01001152 struct mutex pcm_mutex;
1153 enum snd_soc_pcm_subclass pcm_subclass;
1154 struct snd_pcm_ops ops;
Richard Purdie808db4a2006-10-06 18:20:14 +02001155
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001156 unsigned int dev_registered:1;
1157
Liam Girdwood01d75842012-04-25 12:12:49 +01001158 /* Dynamic PCM BE runtime data */
1159 struct snd_soc_dpcm_runtime dpcm[2];
Liam Girdwood2a99ef02014-01-17 17:03:56 +00001160 int fe_compr;
Liam Girdwood01d75842012-04-25 12:12:49 +01001161
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001162 long pmdown_time;
Misael Lopez Cruz9bffb1f2012-12-13 12:23:05 -06001163 unsigned char pop_wait:1;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001164
1165 /* runtime devices */
1166 struct snd_pcm *pcm;
Vinod Koul49681072012-08-16 17:10:40 +05301167 struct snd_compr *compr;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001168 struct snd_soc_codec *codec;
1169 struct snd_soc_platform *platform;
1170 struct snd_soc_dai *codec_dai;
1171 struct snd_soc_dai *cpu_dai;
Lars-Peter Clausen65d93612014-08-19 15:51:22 +02001172 struct snd_soc_component *component; /* Only valid for AUX dev rtds */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001173
Benoit Cousson88bd8702014-07-08 23:19:34 +02001174 struct snd_soc_dai **codec_dais;
1175 unsigned int num_codecs;
1176
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001177 struct delayed_work delayed_work;
Liam Girdwoodf86dcef2012-04-25 12:12:50 +01001178#ifdef CONFIG_DEBUG_FS
1179 struct dentry *debugfs_dpcm_root;
1180 struct dentry *debugfs_dpcm_state;
1181#endif
Richard Purdie808db4a2006-10-06 18:20:14 +02001182};
1183
Jon Smirl4eaa9812008-07-29 11:42:26 +01001184/* mixer control */
1185struct soc_mixer_control {
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +03001186 int min, max, platform_max;
Lars-Peter Clausen249ce132013-10-06 13:43:49 +02001187 int reg, rreg;
1188 unsigned int shift, rshift;
Markus Pargmannf227b882014-01-16 16:02:10 +01001189 unsigned int sign_bit;
Lars-Peter Clausen57295072013-08-05 11:27:31 +02001190 unsigned int invert:1;
1191 unsigned int autodisable:1;
Liam Girdwood8a978232015-05-29 19:06:14 +01001192 struct snd_soc_dobj dobj;
Jon Smirl4eaa9812008-07-29 11:42:26 +01001193};
1194
Mark Brown71d08512011-10-10 18:31:26 +01001195struct soc_bytes {
1196 int base;
1197 int num_regs;
Mark Brownf831b052012-02-17 16:20:33 -08001198 u32 mask;
Mark Brown71d08512011-10-10 18:31:26 +01001199};
1200
Vinod Kould9881202014-05-02 10:58:11 +05301201struct soc_bytes_ext {
1202 int max;
Liam Girdwood8a978232015-05-29 19:06:14 +01001203 struct snd_soc_dobj dobj;
1204
Omair Mohammed Abdullah7523a272014-07-15 21:34:48 +05301205 /* used for TLV byte control */
1206 int (*get)(unsigned int __user *bytes, unsigned int size);
1207 int (*put)(const unsigned int __user *bytes, unsigned int size);
Vinod Kould9881202014-05-02 10:58:11 +05301208};
1209
Kristoffer KARLSSON4183eed22012-04-20 11:32:13 +02001210/* multi register control */
1211struct soc_mreg_control {
1212 long min, max;
1213 unsigned int regbase, regcount, nbits, invert;
1214};
1215
Richard Purdie808db4a2006-10-06 18:20:14 +02001216/* enumerated kcontrol */
1217struct soc_enum {
Lars-Peter Clausenb9488372014-02-28 08:31:05 +01001218 int reg;
Richard Purdie808db4a2006-10-06 18:20:14 +02001219 unsigned char shift_l;
1220 unsigned char shift_r;
Takashi Iwai9a8d38d2014-02-18 08:11:42 +01001221 unsigned int items;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +02001222 unsigned int mask;
Takashi Iwai87023ff2011-05-03 12:50:29 +02001223 const char * const *texts;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +02001224 const unsigned int *values;
Charles Keepax561ed682015-05-01 12:37:26 +01001225 unsigned int autodisable:1;
Liam Girdwood8a978232015-05-29 19:06:14 +01001226 struct snd_soc_dobj dobj;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +02001227};
1228
Lars-Peter Clausen28d6d172014-03-18 09:02:10 +01001229/**
1230 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
1231 * @component: The component to cast to a CODEC
1232 *
1233 * This function must only be used on components that are known to be CODECs.
1234 * Otherwise the behavior is undefined.
1235 */
1236static inline struct snd_soc_codec *snd_soc_component_to_codec(
1237 struct snd_soc_component *component)
1238{
1239 return container_of(component, struct snd_soc_codec, component);
1240}
1241
Lars-Peter Clausenb37f1d12014-03-18 09:02:12 +01001242/**
1243 * snd_soc_component_to_platform() - Casts a component to the platform it is embedded in
1244 * @component: The component to cast to a platform
1245 *
1246 * This function must only be used on components that are known to be platforms.
1247 * Otherwise the behavior is undefined.
1248 */
1249static inline struct snd_soc_platform *snd_soc_component_to_platform(
1250 struct snd_soc_component *component)
1251{
1252 return container_of(component, struct snd_soc_platform, component);
1253}
1254
Lars-Peter Clausen24089e02014-05-18 14:24:12 +02001255/**
Lars-Peter Clausence0fc932014-06-16 18:13:06 +02001256 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
1257 * embedded in
1258 * @dapm: The DAPM context to cast to the component
1259 *
1260 * This function must only be used on DAPM contexts that are known to be part of
1261 * a component (e.g. in a component driver). Otherwise the behavior is
1262 * undefined.
1263 */
1264static inline struct snd_soc_component *snd_soc_dapm_to_component(
1265 struct snd_soc_dapm_context *dapm)
1266{
1267 return container_of(dapm, struct snd_soc_component, dapm);
1268}
1269
1270/**
Lars-Peter Clausen24089e02014-05-18 14:24:12 +02001271 * snd_soc_dapm_to_codec() - Casts a DAPM context to the CODEC it is embedded in
1272 * @dapm: The DAPM context to cast to the CODEC
1273 *
1274 * This function must only be used on DAPM contexts that are known to be part of
1275 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1276 */
1277static inline struct snd_soc_codec *snd_soc_dapm_to_codec(
1278 struct snd_soc_dapm_context *dapm)
1279{
1280 return container_of(dapm, struct snd_soc_codec, dapm);
1281}
1282
1283/**
1284 * snd_soc_dapm_to_platform() - Casts a DAPM context to the platform it is
1285 * embedded in
1286 * @dapm: The DAPM context to cast to the platform.
1287 *
1288 * This function must only be used on DAPM contexts that are known to be part of
1289 * a platform (e.g. in a platform driver). Otherwise the behavior is undefined.
1290 */
1291static inline struct snd_soc_platform *snd_soc_dapm_to_platform(
1292 struct snd_soc_dapm_context *dapm)
1293{
Lars-Peter Clausenbc9af9f2014-06-16 18:13:07 +02001294 return snd_soc_component_to_platform(snd_soc_dapm_to_component(dapm));
Lars-Peter Clausen24089e02014-05-18 14:24:12 +02001295}
1296
Lars-Peter Clausence0fc932014-06-16 18:13:06 +02001297/**
1298 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
1299 * component
1300 * @component: The component for which to get the DAPM context
1301 */
1302static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
1303 struct snd_soc_component *component)
1304{
1305 return component->dapm_ptr;
1306}
1307
Lars-Peter Clausen6b5b0422015-03-15 10:27:20 +01001308/**
Lars-Peter Clausen39ed68c2015-04-27 22:13:22 +02001309 * snd_soc_codec_get_dapm() - Returns the DAPM context for the CODEC
1310 * @codec: The CODEC for which to get the DAPM context
1311 *
1312 * Note: Use this function instead of directly accessing the CODEC's dapm field
1313 */
1314static inline struct snd_soc_dapm_context *snd_soc_codec_get_dapm(
1315 struct snd_soc_codec *codec)
1316{
1317 return &codec->dapm;
1318}
1319
1320/**
Lars-Peter Clausenfa880772015-04-27 22:13:23 +02001321 * snd_soc_dapm_init_bias_level() - Initialize CODEC DAPM bias level
1322 * @dapm: The CODEC for which to initialize the DAPM bias level
1323 * @level: The DAPM level to initialize to
1324 *
1325 * Initializes the CODEC DAPM bias level. See snd_soc_dapm_init_bias_level().
1326 */
1327static inline void snd_soc_codec_init_bias_level(struct snd_soc_codec *codec,
1328 enum snd_soc_bias_level level)
1329{
1330 snd_soc_dapm_init_bias_level(snd_soc_codec_get_dapm(codec), level);
1331}
1332
1333/**
1334 * snd_soc_dapm_get_bias_level() - Get current CODEC DAPM bias level
1335 * @codec: The CODEC for which to get the DAPM bias level
1336 *
1337 * Returns: The current DAPM bias level of the CODEC.
1338 */
1339static inline enum snd_soc_bias_level snd_soc_codec_get_bias_level(
1340 struct snd_soc_codec *codec)
1341{
1342 return snd_soc_dapm_get_bias_level(snd_soc_codec_get_dapm(codec));
1343}
1344
1345/**
1346 * snd_soc_codec_force_bias_level() - Set the CODEC DAPM bias level
1347 * @codec: The CODEC for which to set the level
1348 * @level: The level to set to
1349 *
1350 * Forces the CODEC bias level to a specific state. See
1351 * snd_soc_dapm_force_bias_level().
1352 */
1353static inline int snd_soc_codec_force_bias_level(struct snd_soc_codec *codec,
1354 enum snd_soc_bias_level level)
1355{
1356 return snd_soc_dapm_force_bias_level(snd_soc_codec_get_dapm(codec),
1357 level);
1358}
1359
1360/**
Lars-Peter Clausen6b5b0422015-03-15 10:27:20 +01001361 * snd_soc_dapm_kcontrol_codec() - Returns the codec associated to a kcontrol
1362 * @kcontrol: The kcontrol
1363 *
1364 * This function must only be used on DAPM contexts that are known to be part of
1365 * a CODEC (e.g. in a CODEC driver). Otherwise the behavior is undefined.
1366 */
1367static inline struct snd_soc_codec *snd_soc_dapm_kcontrol_codec(
1368 struct snd_kcontrol *kcontrol)
1369{
1370 return snd_soc_dapm_to_codec(snd_soc_dapm_kcontrol_dapm(kcontrol));
1371}
1372
Mark Brown5c82f562009-05-22 09:41:30 +01001373/* codec IO */
Mark Brownc3753702010-11-01 15:41:57 -04001374unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
Lars-Peter Clausenab2874a2014-04-19 10:43:57 +02001375int snd_soc_write(struct snd_soc_codec *codec, unsigned int reg,
1376 unsigned int val);
Mark Brown5c82f562009-05-22 09:41:30 +01001377
Lars-Peter Clausen427d2042014-11-08 16:38:07 +01001378/**
1379 * snd_soc_cache_sync() - Sync the register cache with the hardware
1380 * @codec: CODEC to sync
1381 *
1382 * Note: This function will call regcache_sync()
1383 */
1384static inline int snd_soc_cache_sync(struct snd_soc_codec *codec)
1385{
1386 return regcache_sync(codec->component.regmap);
1387}
1388
Lars-Peter Clausene2c330b2014-04-22 13:23:13 +02001389/* component IO */
1390int snd_soc_component_read(struct snd_soc_component *component,
1391 unsigned int reg, unsigned int *val);
1392int snd_soc_component_write(struct snd_soc_component *component,
1393 unsigned int reg, unsigned int val);
1394int snd_soc_component_update_bits(struct snd_soc_component *component,
1395 unsigned int reg, unsigned int mask, unsigned int val);
1396int snd_soc_component_update_bits_async(struct snd_soc_component *component,
1397 unsigned int reg, unsigned int mask, unsigned int val);
1398void snd_soc_component_async_complete(struct snd_soc_component *component);
1399int snd_soc_component_test_bits(struct snd_soc_component *component,
1400 unsigned int reg, unsigned int mask, unsigned int value);
1401
Lars-Peter Clausene874bf52014-11-25 21:41:03 +01001402#ifdef CONFIG_REGMAP
1403
Lars-Peter Clausen20feb882014-11-18 19:45:52 +01001404void snd_soc_component_init_regmap(struct snd_soc_component *component,
1405 struct regmap *regmap);
1406void snd_soc_component_exit_regmap(struct snd_soc_component *component);
1407
1408/**
1409 * snd_soc_codec_init_regmap() - Initialize regmap instance for the CODEC
1410 * @codec: The CODEC for which to initialize the regmap instance
1411 * @regmap: The regmap instance that should be used by the CODEC
1412 *
1413 * This function allows deferred assignment of the regmap instance that is
1414 * associated with the CODEC. Only use this if the regmap instance is not yet
1415 * ready when the CODEC is registered. The function must also be called before
1416 * the first IO attempt of the CODEC.
1417 */
1418static inline void snd_soc_codec_init_regmap(struct snd_soc_codec *codec,
1419 struct regmap *regmap)
1420{
1421 snd_soc_component_init_regmap(&codec->component, regmap);
1422}
1423
1424/**
1425 * snd_soc_codec_exit_regmap() - De-initialize regmap instance for the CODEC
1426 * @codec: The CODEC for which to de-initialize the regmap instance
1427 *
1428 * Calls regmap_exit() on the regmap instance associated to the CODEC and
1429 * removes the regmap instance from the CODEC.
1430 *
1431 * This function should only be used if snd_soc_codec_init_regmap() was used to
1432 * initialize the regmap instance.
1433 */
1434static inline void snd_soc_codec_exit_regmap(struct snd_soc_codec *codec)
1435{
1436 snd_soc_component_exit_regmap(&codec->component);
1437}
1438
Lars-Peter Clausene874bf52014-11-25 21:41:03 +01001439#endif
1440
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001441/* device driver data */
1442
Mark Browndddf3e42011-01-28 13:11:47 +00001443static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1444 void *data)
1445{
1446 card->drvdata = data;
1447}
1448
1449static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1450{
1451 return card->drvdata;
1452}
1453
Lars-Peter Clausenc815dbb2014-08-20 13:08:46 +02001454static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
1455 void *data)
1456{
1457 dev_set_drvdata(c->dev, data);
1458}
1459
1460static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
1461{
1462 return dev_get_drvdata(c->dev);
1463}
1464
Mark Brownb2c812e2010-04-14 15:35:19 +09001465static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001466 void *data)
Mark Brownb2c812e2010-04-14 15:35:19 +09001467{
Lars-Peter Clausenc815dbb2014-08-20 13:08:46 +02001468 snd_soc_component_set_drvdata(&codec->component, data);
Mark Brownb2c812e2010-04-14 15:35:19 +09001469}
1470
1471static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1472{
Lars-Peter Clausenc815dbb2014-08-20 13:08:46 +02001473 return snd_soc_component_get_drvdata(&codec->component);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001474}
1475
1476static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1477 void *data)
1478{
Lars-Peter Clausenc815dbb2014-08-20 13:08:46 +02001479 snd_soc_component_set_drvdata(&platform->component, data);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001480}
1481
1482static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1483{
Lars-Peter Clausenc815dbb2014-08-20 13:08:46 +02001484 return snd_soc_component_get_drvdata(&platform->component);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001485}
1486
1487static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1488 void *data)
1489{
Mark Brown36ae1a92012-01-06 17:12:45 -08001490 dev_set_drvdata(rtd->dev, data);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001491}
1492
1493static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1494{
Mark Brown36ae1a92012-01-06 17:12:45 -08001495 return dev_get_drvdata(rtd->dev);
Mark Brownb2c812e2010-04-14 15:35:19 +09001496}
1497
Vinod Koul4e10bda2011-01-13 22:48:52 +05301498static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1499{
Vinod Koul4e10bda2011-01-13 22:48:52 +05301500 INIT_LIST_HEAD(&card->codec_dev_list);
Vinod Koul4e10bda2011-01-13 22:48:52 +05301501 INIT_LIST_HEAD(&card->widgets);
1502 INIT_LIST_HEAD(&card->paths);
1503 INIT_LIST_HEAD(&card->dapm_list);
1504}
1505
Peter Ujfalusi30d86ba2011-10-05 10:29:22 +03001506static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1507{
1508 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1509 return 0;
1510 /*
1511 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1512 * mc->reg != mc->rreg means that the control is
1513 * stereo (bits in one register or in two registers)
1514 */
1515 return 1;
1516}
1517
Lars-Peter Clausen29ae2fa2014-02-28 08:31:03 +01001518static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1519 unsigned int val)
1520{
1521 unsigned int i;
1522
1523 if (!e->values)
1524 return val;
1525
1526 for (i = 0; i < e->items; i++)
1527 if (val == e->values[i])
1528 return i;
1529
1530 return 0;
1531}
1532
1533static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1534 unsigned int item)
1535{
1536 if (!e->values)
1537 return item;
1538
1539 return e->values[item];
1540}
1541
Lars-Peter Clausencdde4cc2014-03-05 13:17:47 +01001542static inline bool snd_soc_component_is_active(
1543 struct snd_soc_component *component)
1544{
1545 return component->active != 0;
1546}
1547
Lars-Peter Clausen5c898e72014-03-05 13:17:45 +01001548static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
1549{
Lars-Peter Clausencdde4cc2014-03-05 13:17:47 +01001550 return snd_soc_component_is_active(&codec->component);
Lars-Peter Clausen5c898e72014-03-05 13:17:45 +01001551}
1552
Lars-Peter Clausenea53bf72014-03-18 09:02:04 +01001553/**
Lars-Peter Clausen907fe362014-04-22 13:23:14 +02001554 * snd_soc_kcontrol_component() - Returns the component that registered the
1555 * control
1556 * @kcontrol: The control for which to get the component
1557 *
1558 * Note: This function will work correctly if the control has been registered
1559 * for a component. Either with snd_soc_add_codec_controls() or
1560 * snd_soc_add_platform_controls() or via table based setup for either a
1561 * CODEC, a platform or component driver. Otherwise the behavior is undefined.
1562 */
1563static inline struct snd_soc_component *snd_soc_kcontrol_component(
1564 struct snd_kcontrol *kcontrol)
1565{
1566 return snd_kcontrol_chip(kcontrol);
1567}
1568
1569/**
Lars-Peter Clausenea53bf72014-03-18 09:02:04 +01001570 * snd_soc_kcontrol_codec() - Returns the CODEC that registered the control
1571 * @kcontrol: The control for which to get the CODEC
1572 *
1573 * Note: This function will only work correctly if the control has been
1574 * registered with snd_soc_add_codec_controls() or via table based setup of
1575 * snd_soc_codec_driver. Otherwise the behavior is undefined.
1576 */
1577static inline struct snd_soc_codec *snd_soc_kcontrol_codec(
1578 struct snd_kcontrol *kcontrol)
1579{
Lars-Peter Clausen907fe362014-04-22 13:23:14 +02001580 return snd_soc_component_to_codec(snd_soc_kcontrol_component(kcontrol));
Lars-Peter Clausenea53bf72014-03-18 09:02:04 +01001581}
1582
Lars-Peter Clausenf6272ff2014-03-18 09:02:05 +01001583/**
Masanari Iida1a6ab462015-03-04 10:56:13 +09001584 * snd_soc_kcontrol_platform() - Returns the platform that registered the control
Lars-Peter Clausenf6272ff2014-03-18 09:02:05 +01001585 * @kcontrol: The control for which to get the platform
1586 *
1587 * Note: This function will only work correctly if the control has been
1588 * registered with snd_soc_add_platform_controls() or via table based setup of
1589 * a snd_soc_platform_driver. Otherwise the behavior is undefined.
1590 */
Lars-Peter Clausen66097ca2014-04-15 22:24:21 +02001591static inline struct snd_soc_platform *snd_soc_kcontrol_platform(
Lars-Peter Clausenf6272ff2014-03-18 09:02:05 +01001592 struct snd_kcontrol *kcontrol)
1593{
Lars-Peter Clausen907fe362014-04-22 13:23:14 +02001594 return snd_soc_component_to_platform(snd_soc_kcontrol_component(kcontrol));
Lars-Peter Clausenf6272ff2014-03-18 09:02:05 +01001595}
1596
Mark Brownfb257892011-04-28 10:57:54 +01001597int snd_soc_util_init(void);
1598void snd_soc_util_exit(void);
1599
Stephen Warrenbec4fa02011-12-12 15:55:34 -07001600int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1601 const char *propname);
Xiubo Li9a6d4862014-02-08 15:59:52 +08001602int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1603 const char *propname);
Xiubo Li89c67852014-02-14 09:34:35 +08001604int snd_soc_of_parse_tdm_slot(struct device_node *np,
1605 unsigned int *slots,
1606 unsigned int *slot_width);
Stephen Warrena4a54dd2011-12-12 15:55:35 -07001607int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1608 const char *propname);
Kuninori Morimotoa7930ed2013-01-14 18:36:04 -08001609unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
Jyri Sarha389cb832014-03-24 12:15:24 +02001610 const char *prefix,
1611 struct device_node **bitclkmaster,
1612 struct device_node **framemaster);
Kuninori Morimotocb470082013-09-10 17:39:56 -07001613int snd_soc_of_get_dai_name(struct device_node *of_node,
1614 const char **dai_name);
Jean-Francois Moine93b0f3e2014-11-25 13:16:12 +01001615int snd_soc_of_get_dai_link_codecs(struct device *dev,
1616 struct device_node *of_node,
1617 struct snd_soc_dai_link *dai_link);
Stephen Warrenbec4fa02011-12-12 15:55:34 -07001618
Mark Browna47cbe72008-07-23 14:03:07 +01001619#include <sound/soc-dai.h>
1620
Stephen Warrenfaff4bb2011-01-07 22:36:11 -07001621#ifdef CONFIG_DEBUG_FS
Mark Brown8a9dab12011-01-10 22:25:21 +00001622extern struct dentry *snd_soc_debugfs_root;
Stephen Warrenfaff4bb2011-01-07 22:36:11 -07001623#endif
1624
Mark Brown6f8ab4a2011-01-26 14:59:27 +00001625extern const struct dev_pm_ops snd_soc_pm_ops;
1626
Charles Keepaxf6d5e582014-02-18 15:22:13 +00001627/* Helper functions */
1628static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1629{
1630 mutex_lock(&dapm->card->dapm_mutex);
1631}
1632
1633static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1634{
1635 mutex_unlock(&dapm->card->dapm_mutex);
1636}
1637
Richard Purdie808db4a2006-10-06 18:20:14 +02001638#endif