blob: 9a001472b96a4bf8a11c8c129543060fdb75c869 [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})
39#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
40 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
Jon Smirl4eaa9812008-07-29 11:42:26 +010041#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
42 ((unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030043 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
Peter Ujfalusicdffa772011-10-04 14:39:39 +030044#define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
45 ((unsigned long)&(struct soc_mixer_control) \
46 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
47 .max = xmax, .platform_max = xmax, .invert = xinvert})
Mark Brown229e3fd2012-06-22 11:40:55 +010048#define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
49 ((unsigned long)&(struct soc_mixer_control) \
50 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
51 .min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
Philipp Zabela7a4ac82008-01-10 14:37:42 +010052#define SOC_SINGLE(xname, reg, shift, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020053{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
54 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
55 .put = snd_soc_put_volsw, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +020056 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
Adam Thomson6c9d8cf2012-05-31 15:18:01 +010057#define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
58{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
59 .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
60 .put = snd_soc_put_volsw_range, \
61 .private_value = (unsigned long)&(struct soc_mixer_control) \
Mark Brown9bde4f02012-12-19 16:05:00 +000062 {.reg = xreg, .rreg = xreg, .shift = xshift, \
63 .rshift = xshift, .min = xmin, .max = xmax, \
64 .platform_max = xmax, .invert = xinvert} }
Philipp Zabela7a4ac82008-01-10 14:37:42 +010065#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
66{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
67 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
68 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
69 .tlv.p = (tlv_array), \
70 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
71 .put = snd_soc_put_volsw, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +020072 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
Brian Austin1d99f242012-03-30 10:43:55 -050073#define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
74{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
75 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
76 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
77 .tlv.p = (tlv_array),\
78 .info = snd_soc_info_volsw, \
79 .get = snd_soc_get_volsw_sx,\
80 .put = snd_soc_put_volsw_sx, \
81 .private_value = (unsigned long)&(struct soc_mixer_control) \
82 {.reg = xreg, .rreg = xreg, \
83 .shift = xshift, .rshift = xshift, \
84 .max = xmax, .min = xmin} }
Adam Thomson6c9d8cf2012-05-31 15:18:01 +010085#define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
86{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
87 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
88 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
89 .tlv.p = (tlv_array), \
90 .info = snd_soc_info_volsw_range, \
91 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
92 .private_value = (unsigned long)&(struct soc_mixer_control) \
Mark Brown9bde4f02012-12-19 16:05:00 +000093 {.reg = xreg, .rreg = xreg, .shift = xshift, \
94 .rshift = xshift, .min = xmin, .max = xmax, \
95 .platform_max = xmax, .invert = xinvert} }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030096#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020097{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
98 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
99 .put = snd_soc_put_volsw, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300100 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200101 max, invert, 0) }
Jon Smirl4eaa9812008-07-29 11:42:26 +0100102#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
Richard Purdie808db4a2006-10-06 18:20:14 +0200103{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300104 .info = snd_soc_info_volsw, \
Peter Ujfalusi974815b2011-10-05 10:29:25 +0300105 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300106 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
107 xmax, xinvert) }
Mark Brown229e3fd2012-06-22 11:40:55 +0100108#define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
109 xmax, xinvert) \
110{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
111 .info = snd_soc_info_volsw_range, \
112 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
113 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
114 xshift, xmin, xmax, xinvert) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300115#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100116{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
117 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
118 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
119 .tlv.p = (tlv_array), \
120 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
121 .put = snd_soc_put_volsw, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300122 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200123 max, invert, 0) }
Jon Smirl4eaa9812008-07-29 11:42:26 +0100124#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100125{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
126 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
127 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
128 .tlv.p = (tlv_array), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300129 .info = snd_soc_info_volsw, \
Peter Ujfalusi974815b2011-10-05 10:29:25 +0300130 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300131 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
132 xmax, xinvert) }
Mark Brown229e3fd2012-06-22 11:40:55 +0100133#define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
134 xmax, xinvert, tlv_array) \
135{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
136 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
137 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
138 .tlv.p = (tlv_array), \
139 .info = snd_soc_info_volsw_range, \
140 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
141 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
142 xshift, xmin, xmax, xinvert) }
Brian Austin1d99f242012-03-30 10:43:55 -0500143#define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
144{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
145 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
146 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
147 .tlv.p = (tlv_array), \
148 .info = snd_soc_info_volsw, \
149 .get = snd_soc_get_volsw_sx, \
150 .put = snd_soc_put_volsw_sx, \
151 .private_value = (unsigned long)&(struct soc_mixer_control) \
152 {.reg = xreg, .rreg = xrreg, \
153 .shift = xshift, .rshift = xshift, \
154 .max = xmax, .min = xmin} }
Jon Smirl4eaa9812008-07-29 11:42:26 +0100155#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
Mark Browne13ac2e2008-05-28 17:58:05 +0100156{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
157 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
158 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
159 .tlv.p = (tlv_array), \
160 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
161 .put = snd_soc_put_volsw_s8, \
Jon Smirl4eaa9812008-07-29 11:42:26 +0100162 .private_value = (unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300163 {.reg = xreg, .min = xmin, .max = xmax, \
164 .platform_max = xmax} }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100165#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
Richard Purdie808db4a2006-10-06 18:20:14 +0200166{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
Lars-Peter Clausen86767b72012-09-14 13:57:27 +0200167 .max = xmax, .texts = xtexts, \
168 .mask = xmax ? roundup_pow_of_two(xmax) - 1 : 0}
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100169#define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
170 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
171#define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
172{ .max = xmax, .texts = xtexts }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200173#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
174{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
175 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
176#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
177 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
Richard Purdie808db4a2006-10-06 18:20:14 +0200178#define SOC_ENUM(xname, xenum) \
179{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
180 .info = snd_soc_info_enum_double, \
181 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
182 .private_value = (unsigned long)&xenum }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200183#define SOC_VALUE_ENUM(xname, xenum) \
184{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
Peter Ujfalusi74155552009-01-08 13:34:29 +0200185 .info = snd_soc_info_enum_double, \
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200186 .get = snd_soc_get_value_enum_double, \
187 .put = snd_soc_put_value_enum_double, \
188 .private_value = (unsigned long)&xenum }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100189#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
Richard Purdie808db4a2006-10-06 18:20:14 +0200190 xhandler_get, xhandler_put) \
191{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100192 .info = snd_soc_info_volsw, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200193 .get = xhandler_get, .put = xhandler_put, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200194 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300195#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
Daniel Mack7629ad22009-04-24 16:37:44 +0200196 xhandler_get, xhandler_put) \
197{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
198 .info = snd_soc_info_volsw, \
199 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300200 .private_value = \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200201 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100202#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
Mike Montour10144c02008-06-11 13:47:13 +0100203 xhandler_get, xhandler_put, tlv_array) \
204{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
205 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
206 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
207 .tlv.p = (tlv_array), \
208 .info = snd_soc_info_volsw, \
209 .get = xhandler_get, .put = xhandler_put, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200210 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
Joonyoung Shimd0af93d2009-07-15 20:33:47 +0900211#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
212 xhandler_get, xhandler_put, tlv_array) \
213{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
214 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
215 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
216 .tlv.p = (tlv_array), \
217 .info = snd_soc_info_volsw, \
218 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300219 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
Lars-Peter Clausen57295072013-08-05 11:27:31 +0200220 xmax, xinvert, 0) }
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900221#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
222 xhandler_get, xhandler_put, tlv_array) \
223{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
224 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
225 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
226 .tlv.p = (tlv_array), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300227 .info = snd_soc_info_volsw, \
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900228 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300229 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
230 xmax, xinvert) }
Richard Purdie808db4a2006-10-06 18:20:14 +0200231#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
232{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
233 .info = snd_soc_info_bool_ext, \
234 .get = xhandler_get, .put = xhandler_put, \
235 .private_value = xdata }
236#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
237{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
Lars-Peter Clausen9a953e62013-08-10 21:33:10 +0200238 .info = snd_soc_info_enum_double, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200239 .get = xhandler_get, .put = xhandler_put, \
240 .private_value = (unsigned long)&xenum }
241
Mark Brown71d08512011-10-10 18:31:26 +0100242#define SND_SOC_BYTES(xname, xbase, xregs) \
243{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
244 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
245 .put = snd_soc_bytes_put, .private_value = \
246 ((unsigned long)&(struct soc_bytes) \
247 {.base = xbase, .num_regs = xregs }) }
apatard@mandriva.comb6f4bb32010-05-15 17:30:01 +0200248
Mark Brownf831b052012-02-17 16:20:33 -0800249#define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \
250{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
251 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
252 .put = snd_soc_bytes_put, .private_value = \
253 ((unsigned long)&(struct soc_bytes) \
254 {.base = xbase, .num_regs = xregs, \
255 .mask = xmask }) }
256
Kristoffer KARLSSON4183eed22012-04-20 11:32:13 +0200257#define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
258 xmin, xmax, xinvert) \
259{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
260 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
261 .put = snd_soc_put_xr_sx, \
262 .private_value = (unsigned long)&(struct soc_mreg_control) \
263 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
264 .invert = xinvert, .min = xmin, .max = xmax} }
265
Kristoffer KARLSSONdd7b10b2012-04-20 11:32:44 +0200266#define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
267 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
268 snd_soc_get_strobe, snd_soc_put_strobe)
269
Richard Purdie808db4a2006-10-06 18:20:14 +0200270/*
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100271 * Simplified versions of above macros, declaring a struct and calculating
272 * ARRAY_SIZE internally
273 */
274#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
275 struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
276 ARRAY_SIZE(xtexts), xtexts)
277#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
278 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
279#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
280 struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
281#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
282 struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
283 ARRAY_SIZE(xtexts), xtexts, xvalues)
284#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
285 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
286
287/*
Liam Girdwood0168bf02011-06-07 16:08:05 +0100288 * Component probe and remove ordering levels for components with runtime
289 * dependencies.
290 */
291#define SND_SOC_COMP_ORDER_FIRST -2
292#define SND_SOC_COMP_ORDER_EARLY -1
293#define SND_SOC_COMP_ORDER_NORMAL 0
294#define SND_SOC_COMP_ORDER_LATE 1
295#define SND_SOC_COMP_ORDER_LAST 2
296
297/*
Mark Brown0be98982008-05-19 12:31:28 +0200298 * Bias levels
299 *
300 * @ON: Bias is fully on for audio playback and capture operations.
301 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
302 * stream start and stop operations.
303 * @STANDBY: Low power standby state when no playback/capture operations are
304 * in progress. NOTE: The transition time between STANDBY and ON
305 * should be as fast as possible and no longer than 10ms.
306 * @OFF: Power Off. No restrictions on transition times.
307 */
308enum snd_soc_bias_level {
Mark Brown56fba412011-06-04 11:25:10 +0100309 SND_SOC_BIAS_OFF = 0,
310 SND_SOC_BIAS_STANDBY = 1,
311 SND_SOC_BIAS_PREPARE = 2,
312 SND_SOC_BIAS_ON = 3,
Mark Brown0be98982008-05-19 12:31:28 +0200313};
314
Stephen Warren5a504962011-12-21 10:40:59 -0700315struct device_node;
Mark Brown8a2cd612009-01-07 17:31:10 +0000316struct snd_jack;
317struct snd_soc_card;
Richard Purdie808db4a2006-10-06 18:20:14 +0200318struct snd_soc_pcm_stream;
319struct snd_soc_ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200320struct snd_soc_pcm_runtime;
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100321struct snd_soc_dai;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000322struct snd_soc_dai_driver;
Mark Brown12a48a8c2008-12-03 19:40:30 +0000323struct snd_soc_platform;
jassi brard273ebe2010-02-22 15:58:04 +0900324struct snd_soc_dai_link;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000325struct snd_soc_platform_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200326struct snd_soc_codec;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000327struct snd_soc_codec_driver;
Kuninori Morimoto030e79f2013-03-11 18:27:21 -0700328struct snd_soc_component;
329struct snd_soc_component_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200330struct soc_enum;
Mark Brown8a2cd612009-01-07 17:31:10 +0000331struct snd_soc_jack;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530332struct snd_soc_jack_zone;
Mark Brown8a2cd612009-01-07 17:31:10 +0000333struct snd_soc_jack_pin;
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200334#include <sound/soc-dapm.h>
Liam Girdwood01d75842012-04-25 12:12:49 +0100335#include <sound/soc-dpcm.h>
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000336
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600337struct snd_soc_jack_gpio;
Richard Purdie808db4a2006-10-06 18:20:14 +0200338
339typedef int (*hw_write_t)(void *,const char* ,int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200340
Mark Brownb047e1c2013-06-26 12:45:59 +0100341extern struct snd_ac97_bus_ops *soc_ac97_ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200342
Mark Brown7084a422009-07-10 22:24:27 +0100343enum snd_soc_control_type {
Mark Browne9c03902011-06-13 19:05:58 +0100344 SND_SOC_I2C = 1,
Mark Brown7084a422009-07-10 22:24:27 +0100345 SND_SOC_SPI,
Mark Brown0671da12011-07-24 12:23:37 +0100346 SND_SOC_REGMAP,
Mark Brown7084a422009-07-10 22:24:27 +0100347};
348
Liam Girdwoodb8c0dab2011-06-09 17:04:39 +0100349enum snd_soc_pcm_subclass {
350 SND_SOC_PCM_CLASS_PCM = 0,
351 SND_SOC_PCM_CLASS_BE = 1,
352};
353
Liam Girdwood01b9d992012-03-07 10:38:25 +0000354enum snd_soc_card_subclass {
Liam Girdwood6874a912012-03-09 12:02:07 +0000355 SND_SOC_CARD_CLASS_INIT = 0,
356 SND_SOC_CARD_CLASS_RUNTIME = 1,
Liam Girdwood01b9d992012-03-07 10:38:25 +0000357};
358
Mark Brownec4ee522011-03-07 20:58:11 +0000359int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
Mark Brownda1c6ea2011-08-24 20:09:01 +0100360 int source, unsigned int freq, int dir);
Mark Brownec4ee522011-03-07 20:58:11 +0000361int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
362 unsigned int freq_in, unsigned int freq_out);
363
Vinod Koul70a7ca32011-01-14 19:22:48 +0530364int snd_soc_register_card(struct snd_soc_card *card);
365int snd_soc_unregister_card(struct snd_soc_card *card);
Mark Brown0e4ff5c2013-09-16 18:02:05 +0100366int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000367int snd_soc_suspend(struct device *dev);
368int snd_soc_resume(struct device *dev);
369int snd_soc_poweroff(struct device *dev);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000370int snd_soc_register_platform(struct device *dev,
Lars-Peter Clausend79e57d2013-03-27 12:02:22 +0100371 const struct snd_soc_platform_driver *platform_drv);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000372void snd_soc_unregister_platform(struct device *dev);
Lars-Peter Clausen71a45cd2013-04-15 19:19:49 +0200373int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
374 const struct snd_soc_platform_driver *platform_drv);
375void snd_soc_remove_platform(struct snd_soc_platform *platform);
376struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000377int snd_soc_register_codec(struct device *dev,
Mark Brown001ae4c2010-12-02 16:21:08 +0000378 const struct snd_soc_codec_driver *codec_drv,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000379 struct snd_soc_dai_driver *dai_drv, int num_dai);
380void snd_soc_unregister_codec(struct device *dev);
Kuninori Morimoto030e79f2013-03-11 18:27:21 -0700381int snd_soc_register_component(struct device *dev,
382 const struct snd_soc_component_driver *cmpnt_drv,
383 struct snd_soc_dai_driver *dai_drv, int num_dai);
Mark Browna0b03a62013-09-04 20:37:34 +0100384int devm_snd_soc_register_component(struct device *dev,
385 const struct snd_soc_component_driver *cmpnt_drv,
386 struct snd_soc_dai_driver *dai_drv, int num_dai);
Kuninori Morimoto030e79f2013-03-11 18:27:21 -0700387void snd_soc_unregister_component(struct device *dev);
Mark Brown181e0552011-01-24 14:05:25 +0000388int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
389 unsigned int reg);
Dimitris Papastamos239c9702011-03-24 13:45:18 +0000390int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
391 unsigned int reg);
392int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
393 unsigned int reg);
Mark Brown17a52fd2009-07-05 17:24:50 +0100394int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
Mark Brown7084a422009-07-10 22:24:27 +0100395 int addr_bits, int data_bits,
396 enum snd_soc_control_type control);
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000397int snd_soc_cache_sync(struct snd_soc_codec *codec);
398int snd_soc_cache_init(struct snd_soc_codec *codec);
399int snd_soc_cache_exit(struct snd_soc_codec *codec);
400int snd_soc_cache_write(struct snd_soc_codec *codec,
401 unsigned int reg, unsigned int value);
402int snd_soc_cache_read(struct snd_soc_codec *codec,
403 unsigned int reg, unsigned int *value);
Liam Girdwoodf1442bc2011-07-04 11:10:15 +0100404int snd_soc_platform_read(struct snd_soc_platform *platform,
405 unsigned int reg);
406int snd_soc_platform_write(struct snd_soc_platform *platform,
407 unsigned int reg, unsigned int val);
Mark Brown354a2142011-12-22 12:16:39 +0000408int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
Vinod Koul49681072012-08-16 17:10:40 +0530409int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
Mark Brown12a48a8c2008-12-03 19:40:30 +0000410
Liam Girdwood47c88ff2012-04-25 12:12:53 +0100411struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
412 const char *dai_link, int stream);
413struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
414 const char *dai_link);
415
Mark Brown7aae8162009-11-10 16:08:04 +0000416/* Utility functions to get clock rates from various things */
417int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
418int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
Mark Brownc0fa59d2009-11-19 11:36:10 +0000419int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
Mark Brown7aae8162009-11-10 16:08:04 +0000420int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
421
Richard Purdie808db4a2006-10-06 18:20:14 +0200422/* set runtime hw params */
423int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
424 const struct snd_pcm_hardware *hw);
Richard Purdie808db4a2006-10-06 18:20:14 +0200425
Liam Girdwood07bf84a2012-04-25 12:12:52 +0100426int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
427 int cmd, struct snd_soc_platform *platform);
428
Mark Brown8a2cd612009-01-07 17:31:10 +0000429/* Jack reporting */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000430int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
Mark Brown8a2cd612009-01-07 17:31:10 +0000431 struct snd_soc_jack *jack);
432void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
433int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
434 struct snd_soc_jack_pin *pins);
Mark Brownd5021ec2010-03-22 12:06:30 +0000435void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
436 struct notifier_block *nb);
437void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
438 struct notifier_block *nb);
Vinod Koulfa9879e2011-02-09 14:44:17 +0530439int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
440 struct snd_soc_jack_zone *zones);
441int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600442#ifdef CONFIG_GPIOLIB
443int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
444 struct snd_soc_jack_gpio *gpios);
445void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
446 struct snd_soc_jack_gpio *gpios);
Takashi Iwai8778ac62013-11-21 15:55:06 +0100447#else
448static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
449 struct snd_soc_jack_gpio *gpios)
450{
451 return 0;
452}
453
454static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
455 struct snd_soc_jack_gpio *gpios)
456{
457}
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600458#endif
Mark Brown8a2cd612009-01-07 17:31:10 +0000459
Richard Purdie808db4a2006-10-06 18:20:14 +0200460/* codec register bit access */
461int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300462 unsigned int mask, unsigned int value);
Mark Browndd1b3d52009-12-04 14:22:03 +0000463int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
464 unsigned short reg, unsigned int mask,
465 unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200466int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300467 unsigned int mask, unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200468
469int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
470 struct snd_ac97_bus_ops *ops, int num);
471void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
472
Mark Brownb047e1c2013-06-26 12:45:59 +0100473int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
Markus Pargmann741a5092013-08-19 17:05:55 +0200474int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
475 struct platform_device *pdev);
Mark Brownb047e1c2013-06-26 12:45:59 +0100476
Richard Purdie808db4a2006-10-06 18:20:14 +0200477/*
478 *Controls
479 */
480struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
Mark Brown30565572012-02-16 17:07:42 -0800481 void *data, const char *long_name,
Mark Brownefb7ac32011-03-08 17:23:24 +0000482 const char *prefix);
Dimitris Papastamos4fefd692013-07-29 13:51:58 +0100483struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
484 const char *name);
Liam Girdwood022658b2012-02-03 17:43:09 +0000485int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
Ian Molton3e8e1952009-01-09 00:23:21 +0000486 const struct snd_kcontrol_new *controls, int num_controls);
Liam Girdwooda491a5c2011-07-04 22:10:51 +0100487int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
488 const struct snd_kcontrol_new *controls, int num_controls);
Liam Girdwood022658b2012-02-03 17:43:09 +0000489int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
490 const struct snd_kcontrol_new *controls, int num_controls);
491int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
492 const struct snd_kcontrol_new *controls, int num_controls);
Richard Purdie808db4a2006-10-06 18:20:14 +0200493int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
494 struct snd_ctl_elem_info *uinfo);
Richard Purdie808db4a2006-10-06 18:20:14 +0200495int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
496 struct snd_ctl_elem_value *ucontrol);
497int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
498 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200499int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
500 struct snd_ctl_elem_value *ucontrol);
501int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
502 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200503int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
504 struct snd_ctl_elem_info *uinfo);
Philipp Zabel392abe92008-05-13 14:03:40 +0200505#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
Richard Purdie808db4a2006-10-06 18:20:14 +0200506int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
507 struct snd_ctl_elem_value *ucontrol);
508int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
509 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusia92f1392011-10-06 07:43:21 +0300510#define snd_soc_get_volsw_2r snd_soc_get_volsw
511#define snd_soc_put_volsw_2r snd_soc_put_volsw
Brian Austin1d99f242012-03-30 10:43:55 -0500512int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
513 struct snd_ctl_elem_value *ucontrol);
514int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
515 struct snd_ctl_elem_value *ucontrol);
Mark Browne13ac2e2008-05-28 17:58:05 +0100516int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
517 struct snd_ctl_elem_info *uinfo);
518int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
519 struct snd_ctl_elem_value *ucontrol);
520int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
521 struct snd_ctl_elem_value *ucontrol);
Adam Thomson6c9d8cf2012-05-31 15:18:01 +0100522int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
523 struct snd_ctl_elem_info *uinfo);
524int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
525 struct snd_ctl_elem_value *ucontrol);
526int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
527 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi637d3842010-05-07 14:05:49 +0300528int snd_soc_limit_volume(struct snd_soc_codec *codec,
529 const char *name, int max);
Mark Brown71d08512011-10-10 18:31:26 +0100530int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
531 struct snd_ctl_elem_info *uinfo);
532int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
533 struct snd_ctl_elem_value *ucontrol);
534int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
535 struct snd_ctl_elem_value *ucontrol);
Kristoffer KARLSSON4183eed22012-04-20 11:32:13 +0200536int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
537 struct snd_ctl_elem_info *uinfo);
538int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
539 struct snd_ctl_elem_value *ucontrol);
540int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
541 struct snd_ctl_elem_value *ucontrol);
Kristoffer KARLSSONdd7b10b2012-04-20 11:32:44 +0200542int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
543 struct snd_ctl_elem_value *ucontrol);
544int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
545 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200546
Mark Brown8a2cd612009-01-07 17:31:10 +0000547/**
548 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
549 *
550 * @pin: name of the pin to update
551 * @mask: bits to check for in reported jack status
552 * @invert: if non-zero then pin is enabled when status is not reported
553 */
554struct snd_soc_jack_pin {
555 struct list_head list;
556 const char *pin;
557 int mask;
558 bool invert;
559};
560
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600561/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530562 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
563 *
564 * @min_mv: start voltage in mv
565 * @max_mv: end voltage in mv
566 * @jack_type: type of jack that is expected for this voltage
567 * @debounce_time: debounce_time for jack, codec driver should wait for this
568 * duration before reading the adc for voltages
569 * @:list: list container
570 */
571struct snd_soc_jack_zone {
572 unsigned int min_mv;
573 unsigned int max_mv;
574 unsigned int jack_type;
575 unsigned int debounce_time;
576 struct list_head list;
577};
578
579/**
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600580 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
581 *
582 * @gpio: gpio number
583 * @name: gpio name
584 * @report: value to report when jack detected
585 * @invert: report presence in low state
586 * @debouce_time: debouce time in ms
Mark Brown7887ab32011-02-17 16:35:55 -0800587 * @wake: enable as wake source
Mark Brownfadddc82011-02-17 16:41:42 -0800588 * @jack_status_check: callback function which overrides the detection
589 * to provide more complex checks (eg, reading an
590 * ADC).
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600591 */
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600592struct snd_soc_jack_gpio {
593 unsigned int gpio;
594 const char *name;
595 int report;
596 int invert;
597 int debounce_time;
Mark Brown7887ab32011-02-17 16:35:55 -0800598 bool wake;
599
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600600 struct snd_soc_jack *jack;
Mark Brown4c14d782010-10-06 15:54:28 -0700601 struct delayed_work work;
Joonyoung Shimc871a052009-11-12 17:14:04 +0900602
603 int (*jack_status_check)(void);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600604};
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600605
Mark Brown8a2cd612009-01-07 17:31:10 +0000606struct snd_soc_jack {
Mark Brown2667b4b2012-03-12 14:07:49 +0000607 struct mutex mutex;
Mark Brown8a2cd612009-01-07 17:31:10 +0000608 struct snd_jack *jack;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000609 struct snd_soc_codec *codec;
Mark Brown8a2cd612009-01-07 17:31:10 +0000610 struct list_head pins;
611 int status;
Mark Brownd5021ec2010-03-22 12:06:30 +0000612 struct blocking_notifier_head notifier;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530613 struct list_head jack_zones;
Mark Brown8a2cd612009-01-07 17:31:10 +0000614};
615
Richard Purdie808db4a2006-10-06 18:20:14 +0200616/* SoC PCM stream information */
617struct snd_soc_pcm_stream {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000618 const char *stream_name;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100619 u64 formats; /* SNDRV_PCM_FMTBIT_* */
620 unsigned int rates; /* SNDRV_PCM_RATE_* */
Richard Purdie808db4a2006-10-06 18:20:14 +0200621 unsigned int rate_min; /* min rate */
622 unsigned int rate_max; /* max rate */
623 unsigned int channels_min; /* min channels */
624 unsigned int channels_max; /* max channels */
Mark Brown58ba9b22012-01-16 18:38:51 +0000625 unsigned int sig_bits; /* number of bits of content */
Richard Purdie808db4a2006-10-06 18:20:14 +0200626};
627
628/* SoC audio ops */
629struct snd_soc_ops {
630 int (*startup)(struct snd_pcm_substream *);
631 void (*shutdown)(struct snd_pcm_substream *);
632 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
633 int (*hw_free)(struct snd_pcm_substream *);
634 int (*prepare)(struct snd_pcm_substream *);
635 int (*trigger)(struct snd_pcm_substream *, int);
636};
637
Vinod Koul49681072012-08-16 17:10:40 +0530638struct snd_soc_compr_ops {
639 int (*startup)(struct snd_compr_stream *);
640 void (*shutdown)(struct snd_compr_stream *);
641 int (*set_params)(struct snd_compr_stream *);
642 int (*trigger)(struct snd_compr_stream *);
643};
644
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700645/* component interface */
646struct snd_soc_component_driver {
647 const char *name;
Kuninori Morimotocb470082013-09-10 17:39:56 -0700648
649 /* DT */
650 int (*of_xlate_dai_name)(struct snd_soc_component *component,
651 struct of_phandle_args *args,
652 const char **dai_name);
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700653};
654
655struct snd_soc_component {
656 const char *name;
657 int id;
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700658 struct device *dev;
659 struct list_head list;
660
Kuninori Morimoto6833c452013-10-16 22:05:26 -0700661 struct snd_soc_dai_driver *dai_drv;
662 int num_dai;
663
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700664 const struct snd_soc_component_driver *driver;
665};
666
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000667/* SoC Audio Codec device */
Richard Purdie808db4a2006-10-06 18:20:14 +0200668struct snd_soc_codec {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000669 const char *name;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200670 const char *name_prefix;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000671 int id;
Mark Brown0d0cf002008-12-10 14:32:45 +0000672 struct device *dev;
Mark Brown001ae4c2010-12-02 16:21:08 +0000673 const struct snd_soc_codec_driver *driver;
Mark Brown0d0cf002008-12-10 14:32:45 +0000674
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000675 struct mutex mutex;
676 struct snd_soc_card *card;
Mark Brown0d0cf002008-12-10 14:32:45 +0000677 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000678 struct list_head card_list;
679 int num_dai;
Dimitris Papastamos1500b7b2011-01-13 12:20:38 +0000680 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
681 int (*readable_register)(struct snd_soc_codec *, unsigned int);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000682 int (*writable_register)(struct snd_soc_codec *, unsigned int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200683
684 /* runtime */
Richard Purdie808db4a2006-10-06 18:20:14 +0200685 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
686 unsigned int active;
Dimitris Papastamosdad8e7a2011-01-19 14:53:36 +0000687 unsigned int cache_bypass:1; /* Suppress access to the cache */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000688 unsigned int suspended:1; /* Codec is in suspend PM state */
689 unsigned int probed:1; /* Codec has been probed */
690 unsigned int ac97_registered:1; /* Codec has been AC97 registered */
Mika Westerberg0562f782010-10-13 11:30:32 +0300691 unsigned int ac97_created:1; /* Codec has been created by SoC */
Dimitris Papastamosfdf0f542010-12-02 16:11:06 +0000692 unsigned int cache_init:1; /* codec cache has been initialized */
Mark Brown8a713da2011-12-03 12:33:55 +0000693 unsigned int using_regmap:1; /* using regmap access */
Mark Brownaaee8ef2011-01-26 20:53:50 +0000694 u32 cache_only; /* Suppress writes to hardware */
695 u32 cache_sync; /* Cache needs to be synced to hardware */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000696
697 /* codec IO */
698 void *control_data; /* codec control (i2c/3wire) data */
699 hw_write_t hw_write;
700 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
Mark Brownc3acec22010-12-02 16:15:29 +0000701 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
702 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000703 void *reg_cache;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000704 struct mutex cache_rw_mutex;
Mark Brownbe3ea3b2011-06-13 19:35:29 +0100705 int val_bytes;
Mark Browna96ca332010-01-19 22:49:43 +0000706
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700707 /* component */
708 struct snd_soc_component component;
709
Richard Purdie808db4a2006-10-06 18:20:14 +0200710 /* dapm */
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200711 struct snd_soc_dapm_context dapm;
Peter Ujfalusi1d69c5c2011-10-14 14:43:33 +0300712 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
Richard Purdie808db4a2006-10-06 18:20:14 +0200713
Mark Brown384c89e2008-12-03 17:34:03 +0000714#ifdef CONFIG_DEBUG_FS
Peter Ujfalusi88439ac2009-10-01 10:32:47 +0300715 struct dentry *debugfs_codec_root;
Mark Brown384c89e2008-12-03 17:34:03 +0000716 struct dentry *debugfs_reg;
Mark Brown384c89e2008-12-03 17:34:03 +0000717#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200718};
719
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000720/* codec driver */
721struct snd_soc_codec_driver {
722
723 /* driver ops */
724 int (*probe)(struct snd_soc_codec *);
725 int (*remove)(struct snd_soc_codec *);
Lars-Peter Clausen84b315e2011-12-02 10:18:28 +0100726 int (*suspend)(struct snd_soc_codec *);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000727 int (*resume)(struct snd_soc_codec *);
Kuninori Morimotod191bd82013-09-04 19:39:03 -0700728 struct snd_soc_component_driver component_driver;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000729
Mark Brownb7af1da2011-04-07 19:18:44 +0900730 /* Default control and setup, added after probe() is run */
731 const struct snd_kcontrol_new *controls;
732 int num_controls;
Mark Brown89b95ac02011-03-07 16:38:44 +0000733 const struct snd_soc_dapm_widget *dapm_widgets;
734 int num_dapm_widgets;
735 const struct snd_soc_dapm_route *dapm_routes;
736 int num_dapm_routes;
737
Mark Brownec4ee522011-03-07 20:58:11 +0000738 /* codec wide operations */
739 int (*set_sysclk)(struct snd_soc_codec *codec,
Mark Brownda1c6ea2011-08-24 20:09:01 +0100740 int clk_id, int source, unsigned int freq, int dir);
Mark Brownec4ee522011-03-07 20:58:11 +0000741 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
742 unsigned int freq_in, unsigned int freq_out);
743
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000744 /* codec IO */
745 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
746 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
747 int (*display_register)(struct snd_soc_codec *, char *,
748 size_t, unsigned int);
Dimitris Papastamosd4754ec2011-01-13 12:20:37 +0000749 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
750 int (*readable_register)(struct snd_soc_codec *, unsigned int);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000751 int (*writable_register)(struct snd_soc_codec *, unsigned int);
Mark Brown4a8923b2011-08-24 19:12:49 +0100752 unsigned int reg_cache_size;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000753 short reg_cache_step;
754 short reg_word_size;
755 const void *reg_cache_default;
756
757 /* codec bias level */
758 int (*set_bias_level)(struct snd_soc_codec *,
759 enum snd_soc_bias_level level);
Mark Brown33c5f962011-08-22 18:40:30 +0100760 bool idle_bias_off;
Mark Brown474b62d2011-01-18 16:14:44 +0000761
762 void (*seq_notifier)(struct snd_soc_dapm_context *,
Mark Brownf85a9e02011-01-26 21:41:28 +0000763 enum snd_soc_dapm_type, int);
Liam Girdwood0168bf02011-06-07 16:08:05 +0100764
Liam Girdwood64a648c2011-07-25 11:15:15 +0100765 /* codec stream completion event */
766 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
767
Mark Brown5124e692012-02-08 13:20:50 +0000768 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */
769
Liam Girdwood0168bf02011-06-07 16:08:05 +0100770 /* probe ordering - for components with runtime dependencies */
771 int probe_order;
772 int remove_order;
Richard Purdie808db4a2006-10-06 18:20:14 +0200773};
774
775/* SoC platform interface */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000776struct snd_soc_platform_driver {
Richard Purdie808db4a2006-10-06 18:20:14 +0200777
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000778 int (*probe)(struct snd_soc_platform *);
779 int (*remove)(struct snd_soc_platform *);
780 int (*suspend)(struct snd_soc_dai *dai);
781 int (*resume)(struct snd_soc_dai *dai);
Richard Purdie808db4a2006-10-06 18:20:14 +0200782
783 /* pcm creation and destruction */
Liam Girdwood552d1ef2011-06-07 16:08:33 +0100784 int (*pcm_new)(struct snd_soc_pcm_runtime *);
Richard Purdie808db4a2006-10-06 18:20:14 +0200785 void (*pcm_free)(struct snd_pcm *);
786
Liam Girdwoodcb2cf612011-07-04 22:10:53 +0100787 /* Default control and setup, added after probe() is run */
788 const struct snd_kcontrol_new *controls;
789 int num_controls;
790 const struct snd_soc_dapm_widget *dapm_widgets;
791 int num_dapm_widgets;
792 const struct snd_soc_dapm_route *dapm_routes;
793 int num_dapm_routes;
794
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200795 /*
796 * For platform caused delay reporting.
797 * Optional.
798 */
799 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
800 struct snd_soc_dai *);
801
Vinod Koul49681072012-08-16 17:10:40 +0530802 /* platform stream pcm ops */
Lars-Peter Clausen1f03f552013-03-27 12:02:23 +0100803 const struct snd_pcm_ops *ops;
Liam Girdwood0168bf02011-06-07 16:08:05 +0100804
Vinod Koul49681072012-08-16 17:10:40 +0530805 /* platform stream compress ops */
Lars-Peter Clausenef03c9a2013-03-27 12:02:24 +0100806 const struct snd_compr_ops *compr_ops;
Vinod Koul49681072012-08-16 17:10:40 +0530807
Liam Girdwood64a648c2011-07-25 11:15:15 +0100808 /* platform stream completion event */
809 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
810
Liam Girdwood0168bf02011-06-07 16:08:05 +0100811 /* probe ordering - for components with runtime dependencies */
812 int probe_order;
813 int remove_order;
Liam Girdwoodf1442bc2011-07-04 11:10:15 +0100814
815 /* platform IO - used for platform DAPM */
816 unsigned int (*read)(struct snd_soc_platform *, unsigned int);
817 int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
Liam Girdwood07bf84a2012-04-25 12:12:52 +0100818 int (*bespoke_trigger)(struct snd_pcm_substream *, int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200819};
820
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000821struct snd_soc_platform {
822 const char *name;
823 int id;
824 struct device *dev;
Lars-Peter Clausend79e57d2013-03-27 12:02:22 +0100825 const struct snd_soc_platform_driver *driver;
Liam Girdwoodcc22d372012-03-06 18:16:18 +0000826 struct mutex mutex;
Richard Purdie808db4a2006-10-06 18:20:14 +0200827
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000828 unsigned int suspended:1; /* platform is suspended */
829 unsigned int probed:1;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100830
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000831 struct snd_soc_card *card;
832 struct list_head list;
833 struct list_head card_list;
Liam Girdwoodb7950642011-07-04 22:10:52 +0100834
835 struct snd_soc_dapm_context dapm;
Sebastien Guiriec731f1ab2012-02-15 15:25:31 +0000836
837#ifdef CONFIG_DEBUG_FS
838 struct dentry *debugfs_platform_root;
Sebastien Guiriec731f1ab2012-02-15 15:25:31 +0000839#endif
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000840};
Richard Purdie808db4a2006-10-06 18:20:14 +0200841
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000842struct snd_soc_dai_link {
843 /* config - must be set by machine driver */
844 const char *name; /* Codec name */
845 const char *stream_name; /* Stream name */
Stephen Warrenbc926572012-05-25 18:22:11 -0600846 /*
847 * You MAY specify the link's CPU-side device, either by device name,
848 * or by DT/OF node, but not both. If this information is omitted,
849 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
850 * must be globally unique. These fields are currently typically used
851 * only for codec to codec links, or systems using device tree.
852 */
853 const char *cpu_name;
854 const struct device_node *cpu_of_node;
855 /*
856 * You MAY specify the DAI name of the CPU DAI. If this information is
857 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
858 * only, which only works well when that device exposes a single DAI.
859 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000860 const char *cpu_dai_name;
Stephen Warrenbc926572012-05-25 18:22:11 -0600861 /*
862 * You MUST specify the link's codec, either by device name, or by
863 * DT/OF node, but not both.
864 */
865 const char *codec_name;
866 const struct device_node *codec_of_node;
867 /* You MUST specify the DAI name within the codec */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000868 const char *codec_dai_name;
Stephen Warrenbc926572012-05-25 18:22:11 -0600869 /*
870 * You MAY specify the link's platform/PCM/DMA driver, either by
871 * device name, or by DT/OF node, but not both. Some forms of link
872 * do not need a platform.
873 */
874 const char *platform_name;
875 const struct device_node *platform_of_node;
Liam Girdwood01d75842012-04-25 12:12:49 +0100876 int be_id; /* optional ID for machine driver BE identification */
Liam Girdwood4ccab3e2008-01-10 14:39:01 +0100877
Mark Brownc74184e2012-04-04 22:12:09 +0100878 const struct snd_soc_pcm_stream *params;
879
Mark Brown75d9ac42011-09-27 16:41:01 +0100880 unsigned int dai_fmt; /* format to set on init */
881
Liam Girdwood01d75842012-04-25 12:12:49 +0100882 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
883
Mark Brown3efab7d2010-05-09 13:25:43 +0100884 /* Keep DAI active over suspend */
885 unsigned int ignore_suspend:1;
886
Mark Brown06f409d2009-04-07 18:10:13 +0100887 /* Symmetry requirements */
888 unsigned int symmetric_rates:1;
Nicolin Chen3635bf02013-11-13 18:56:24 +0800889 unsigned int symmetric_channels:1;
890 unsigned int symmetric_samplebits:1;
Mark Brown06f409d2009-04-07 18:10:13 +0100891
Liam Girdwood01d75842012-04-25 12:12:49 +0100892 /* Do not create a PCM for this DAI link (Backend link) */
893 unsigned int no_pcm:1;
894
895 /* This DAI link can route to other DAI links at runtime (Frontend)*/
896 unsigned int dynamic:1;
897
Liam Girdwood1e9de422014-01-07 17:51:42 +0000898 /* DPCM capture and Playback support */
899 unsigned int dpcm_capture:1;
900 unsigned int dpcm_playback:1;
901
ramesh.babu@linux.intel.come50fad42011-10-27 12:12:33 +0530902 /* pmdown_time is ignored at stop */
903 unsigned int ignore_pmdown_time:1;
904
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000905 /* codec/machine specific init - e.g. add machine controls */
906 int (*init)(struct snd_soc_pcm_runtime *rtd);
Mark Brown06f409d2009-04-07 18:10:13 +0100907
Liam Girdwood01d75842012-04-25 12:12:49 +0100908 /* optional hw_params re-writing for BE and FE sync */
909 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
910 struct snd_pcm_hw_params *params);
911
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000912 /* machine stream operations */
Lars-Peter Clausen13aec722013-01-10 17:06:15 +0100913 const struct snd_soc_ops *ops;
914 const struct snd_soc_compr_ops *compr_ops;
Fabio Estevamd6bead02013-08-29 10:32:13 -0300915
916 /* For unidirectional dai links */
917 bool playback_only;
918 bool capture_only;
Richard Purdie808db4a2006-10-06 18:20:14 +0200919};
920
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000921struct snd_soc_codec_conf {
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200922 const char *dev_name;
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000923
924 /*
925 * optional map of kcontrol, widget and path name prefixes that are
926 * associated per device
927 */
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200928 const char *name_prefix;
929};
930
Jarkko Nikula2eea3922010-11-25 17:47:38 +0200931struct snd_soc_aux_dev {
932 const char *name; /* Codec name */
933 const char *codec_name; /* for multi-codec */
934
935 /* codec/machine specific init - e.g. add machine controls */
936 int (*init)(struct snd_soc_dapm_context *dapm);
937};
938
Mark Brown87506542008-11-18 20:50:34 +0000939/* SoC card */
940struct snd_soc_card {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000941 const char *name;
Liam Girdwood22de71b2011-05-12 16:14:04 +0100942 const char *long_name;
943 const char *driver_name;
Mark Brownc5af3a22008-11-28 13:29:45 +0000944 struct device *dev;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000945 struct snd_card *snd_card;
946 struct module *owner;
Mark Brownc5af3a22008-11-28 13:29:45 +0000947
948 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000949 struct mutex mutex;
Liam Girdwooda73fb2d2012-03-07 10:38:26 +0000950 struct mutex dapm_mutex;
Mark Brownc5af3a22008-11-28 13:29:45 +0000951
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000952 bool instantiated;
Richard Purdie808db4a2006-10-06 18:20:14 +0200953
Mark Browne7361ec2011-01-26 14:17:20 +0000954 int (*probe)(struct snd_soc_card *card);
Mark Brown28e9ad92011-03-02 18:36:34 +0000955 int (*late_probe)(struct snd_soc_card *card);
Mark Browne7361ec2011-01-26 14:17:20 +0000956 int (*remove)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200957
958 /* the pre and post PM functions are used to do any PM work before and
959 * after the codec and DAI's do any PM work. */
Mark Brown70b2ac12011-01-26 14:05:25 +0000960 int (*suspend_pre)(struct snd_soc_card *card);
961 int (*suspend_post)(struct snd_soc_card *card);
962 int (*resume_pre)(struct snd_soc_card *card);
963 int (*resume_post)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200964
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100965 /* callbacks */
Mark Brown87506542008-11-18 20:50:34 +0000966 int (*set_bias_level)(struct snd_soc_card *,
Mark Brownd4c60052011-06-06 19:13:23 +0100967 struct snd_soc_dapm_context *dapm,
Mark Brown0be98982008-05-19 12:31:28 +0200968 enum snd_soc_bias_level level);
Mark Brown1badabd2010-12-04 12:41:04 +0000969 int (*set_bias_level_post)(struct snd_soc_card *,
Mark Brownd4c60052011-06-06 19:13:23 +0100970 struct snd_soc_dapm_context *dapm,
Mark Brown1badabd2010-12-04 12:41:04 +0000971 enum snd_soc_bias_level level);
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100972
Mark Brown6c5f1fe2010-02-17 14:30:44 +0000973 long pmdown_time;
Mark Brown96dd3622010-02-12 11:05:44 +0000974
Richard Purdie808db4a2006-10-06 18:20:14 +0200975 /* CPU <--> Codec DAI links */
976 struct snd_soc_dai_link *dai_link;
977 int num_links;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000978 struct snd_soc_pcm_runtime *rtd;
979 int num_rtd;
Mark Brown63084192008-12-02 15:08:03 +0000980
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000981 /* optional codec specific configuration */
982 struct snd_soc_codec_conf *codec_conf;
983 int num_configs;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200984
Jarkko Nikula2eea3922010-11-25 17:47:38 +0200985 /*
986 * optional auxiliary devices such as amplifiers or codecs with DAI
987 * link unused
988 */
989 struct snd_soc_aux_dev *aux_dev;
990 int num_aux_devs;
991 struct snd_soc_pcm_runtime *rtd_aux;
992 int num_aux_rtd;
993
Mark Brownb7af1da2011-04-07 19:18:44 +0900994 const struct snd_kcontrol_new *controls;
995 int num_controls;
996
Mark Brownb8ad29d2011-03-02 18:35:51 +0000997 /*
998 * Card-specific routes and widgets.
999 */
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +02001000 const struct snd_soc_dapm_widget *dapm_widgets;
Mark Brownb8ad29d2011-03-02 18:35:51 +00001001 int num_dapm_widgets;
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +02001002 const struct snd_soc_dapm_route *dapm_routes;
Mark Brownb8ad29d2011-03-02 18:35:51 +00001003 int num_dapm_routes;
Stephen Warren16332812011-11-23 12:42:04 -07001004 bool fully_routed;
Mark Brownb8ad29d2011-03-02 18:35:51 +00001005
Mark Brown63084192008-12-02 15:08:03 +00001006 struct work_struct deferred_resume_work;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001007
1008 /* lists of probed devices belonging to this card */
1009 struct list_head codec_dev_list;
1010 struct list_head platform_dev_list;
1011 struct list_head dai_dev_list;
Jarkko Nikulaa6052152010-11-05 20:35:19 +02001012
Jarkko Nikula97c866d2010-12-14 12:18:31 +02001013 struct list_head widgets;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +02001014 struct list_head paths;
Jarkko Nikula7be31be82010-12-14 12:18:32 +02001015 struct list_head dapm_list;
Mark Browndb432b42011-10-03 21:06:40 +01001016 struct list_head dapm_dirty;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +02001017
Mark Browne37a4972011-03-02 18:21:57 +00001018 /* Generic DAPM context for the card */
1019 struct snd_soc_dapm_context dapm;
Mark Brownde02d072011-09-20 21:43:24 +01001020 struct snd_soc_dapm_stats dapm_stats;
Lars-Peter Clausen564c65042013-07-29 17:13:55 +02001021 struct snd_soc_dapm_update *update;
Mark Browne37a4972011-03-02 18:21:57 +00001022
Jarkko Nikulaa6052152010-11-05 20:35:19 +02001023#ifdef CONFIG_DEBUG_FS
1024 struct dentry *debugfs_card_root;
Jarkko Nikula3a45b862010-11-05 20:35:21 +02001025 struct dentry *debugfs_pop_time;
Jarkko Nikulaa6052152010-11-05 20:35:19 +02001026#endif
Jarkko Nikula3a45b862010-11-05 20:35:21 +02001027 u32 pop_time;
Mark Browndddf3e42011-01-28 13:11:47 +00001028
1029 void *drvdata;
Richard Purdie808db4a2006-10-06 18:20:14 +02001030};
1031
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001032/* SoC machine DAI configuration, glues a codec and cpu DAI together */
Mark Brownd66a3272011-11-10 11:46:13 +00001033struct snd_soc_pcm_runtime {
Mark Brown36ae1a92012-01-06 17:12:45 -08001034 struct device *dev;
Mark Brown87506542008-11-18 20:50:34 +00001035 struct snd_soc_card *card;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001036 struct snd_soc_dai_link *dai_link;
Liam Girdwoodb8c0dab2011-06-09 17:04:39 +01001037 struct mutex pcm_mutex;
1038 enum snd_soc_pcm_subclass pcm_subclass;
1039 struct snd_pcm_ops ops;
Richard Purdie808db4a2006-10-06 18:20:14 +02001040
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001041 unsigned int dev_registered:1;
1042
Liam Girdwood01d75842012-04-25 12:12:49 +01001043 /* Dynamic PCM BE runtime data */
1044 struct snd_soc_dpcm_runtime dpcm[2];
Liam Girdwood2a99ef02014-01-17 17:03:56 +00001045 int fe_compr;
Liam Girdwood01d75842012-04-25 12:12:49 +01001046
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001047 long pmdown_time;
Misael Lopez Cruz9bffb1f2012-12-13 12:23:05 -06001048 unsigned char pop_wait:1;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001049
1050 /* runtime devices */
1051 struct snd_pcm *pcm;
Vinod Koul49681072012-08-16 17:10:40 +05301052 struct snd_compr *compr;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001053 struct snd_soc_codec *codec;
1054 struct snd_soc_platform *platform;
1055 struct snd_soc_dai *codec_dai;
1056 struct snd_soc_dai *cpu_dai;
1057
1058 struct delayed_work delayed_work;
Liam Girdwoodf86dcef2012-04-25 12:12:50 +01001059#ifdef CONFIG_DEBUG_FS
1060 struct dentry *debugfs_dpcm_root;
1061 struct dentry *debugfs_dpcm_state;
1062#endif
Richard Purdie808db4a2006-10-06 18:20:14 +02001063};
1064
Jon Smirl4eaa9812008-07-29 11:42:26 +01001065/* mixer control */
1066struct soc_mixer_control {
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +03001067 int min, max, platform_max;
Lars-Peter Clausen249ce132013-10-06 13:43:49 +02001068 int reg, rreg;
1069 unsigned int shift, rshift;
Lars-Peter Clausen57295072013-08-05 11:27:31 +02001070 unsigned int invert:1;
1071 unsigned int autodisable:1;
Jon Smirl4eaa9812008-07-29 11:42:26 +01001072};
1073
Mark Brown71d08512011-10-10 18:31:26 +01001074struct soc_bytes {
1075 int base;
1076 int num_regs;
Mark Brownf831b052012-02-17 16:20:33 -08001077 u32 mask;
Mark Brown71d08512011-10-10 18:31:26 +01001078};
1079
Kristoffer KARLSSON4183eed22012-04-20 11:32:13 +02001080/* multi register control */
1081struct soc_mreg_control {
1082 long min, max;
1083 unsigned int regbase, regcount, nbits, invert;
1084};
1085
Richard Purdie808db4a2006-10-06 18:20:14 +02001086/* enumerated kcontrol */
1087struct soc_enum {
1088 unsigned short reg;
1089 unsigned short reg2;
1090 unsigned char shift_l;
1091 unsigned char shift_r;
Jon Smirlf8ba0b72008-07-29 11:42:27 +01001092 unsigned int max;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +02001093 unsigned int mask;
Takashi Iwai87023ff2011-05-03 12:50:29 +02001094 const char * const *texts;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +02001095 const unsigned int *values;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +02001096};
1097
Mark Brown5c82f562009-05-22 09:41:30 +01001098/* codec IO */
Mark Brownc3753702010-11-01 15:41:57 -04001099unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1100unsigned int snd_soc_write(struct snd_soc_codec *codec,
1101 unsigned int reg, unsigned int val);
Mark Brown5c82f562009-05-22 09:41:30 +01001102
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001103/* device driver data */
1104
Mark Browndddf3e42011-01-28 13:11:47 +00001105static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1106 void *data)
1107{
1108 card->drvdata = data;
1109}
1110
1111static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1112{
1113 return card->drvdata;
1114}
1115
Mark Brownb2c812e2010-04-14 15:35:19 +09001116static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001117 void *data)
Mark Brownb2c812e2010-04-14 15:35:19 +09001118{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001119 dev_set_drvdata(codec->dev, data);
Mark Brownb2c812e2010-04-14 15:35:19 +09001120}
1121
1122static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1123{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001124 return dev_get_drvdata(codec->dev);
1125}
1126
1127static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1128 void *data)
1129{
1130 dev_set_drvdata(platform->dev, data);
1131}
1132
1133static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1134{
1135 return dev_get_drvdata(platform->dev);
1136}
1137
1138static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1139 void *data)
1140{
Mark Brown36ae1a92012-01-06 17:12:45 -08001141 dev_set_drvdata(rtd->dev, data);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001142}
1143
1144static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1145{
Mark Brown36ae1a92012-01-06 17:12:45 -08001146 return dev_get_drvdata(rtd->dev);
Mark Brownb2c812e2010-04-14 15:35:19 +09001147}
1148
Vinod Koul4e10bda2011-01-13 22:48:52 +05301149static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1150{
1151 INIT_LIST_HEAD(&card->dai_dev_list);
1152 INIT_LIST_HEAD(&card->codec_dev_list);
1153 INIT_LIST_HEAD(&card->platform_dev_list);
1154 INIT_LIST_HEAD(&card->widgets);
1155 INIT_LIST_HEAD(&card->paths);
1156 INIT_LIST_HEAD(&card->dapm_list);
1157}
1158
Peter Ujfalusi30d86ba2011-10-05 10:29:22 +03001159static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1160{
1161 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1162 return 0;
1163 /*
1164 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1165 * mc->reg != mc->rreg means that the control is
1166 * stereo (bits in one register or in two registers)
1167 */
1168 return 1;
1169}
1170
Mark Brownfb257892011-04-28 10:57:54 +01001171int snd_soc_util_init(void);
1172void snd_soc_util_exit(void);
1173
Stephen Warrenbec4fa02011-12-12 15:55:34 -07001174int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1175 const char *propname);
Stephen Warrena4a54dd2011-12-12 15:55:35 -07001176int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1177 const char *propname);
Kuninori Morimotoa7930ed2013-01-14 18:36:04 -08001178unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1179 const char *prefix);
Kuninori Morimotocb470082013-09-10 17:39:56 -07001180int snd_soc_of_get_dai_name(struct device_node *of_node,
1181 const char **dai_name);
Stephen Warrenbec4fa02011-12-12 15:55:34 -07001182
Mark Browna47cbe72008-07-23 14:03:07 +01001183#include <sound/soc-dai.h>
1184
Stephen Warrenfaff4bb2011-01-07 22:36:11 -07001185#ifdef CONFIG_DEBUG_FS
Mark Brown8a9dab12011-01-10 22:25:21 +00001186extern struct dentry *snd_soc_debugfs_root;
Stephen Warrenfaff4bb2011-01-07 22:36:11 -07001187#endif
1188
Mark Brown6f8ab4a2011-01-26 14:59:27 +00001189extern const struct dev_pm_ops snd_soc_pm_ops;
1190
Richard Purdie808db4a2006-10-06 18:20:14 +02001191#endif