blob: bc56738cb1091b8319b2413fe7e6b2f105ba0ac8 [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
16#include <linux/platform_device.h>
17#include <linux/types.h>
Mark Brownd5021ec2010-03-22 12:06:30 +000018#include <linux/notifier.h>
Andrew Morton4484bb22006-12-15 09:30:07 +010019#include <linux/workqueue.h>
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -060020#include <linux/interrupt.h>
21#include <linux/kernel.h>
Mark Brownbe3ea3b2011-06-13 19:35:29 +010022#include <linux/regmap.h>
Lars-Peter Clausen86767b72012-09-14 13:57:27 +020023#include <linux/log2.h>
Richard Purdie808db4a2006-10-06 18:20:14 +020024#include <sound/core.h>
25#include <sound/pcm.h>
Vinod Koul49681072012-08-16 17:10:40 +053026#include <sound/compress_driver.h>
Richard Purdie808db4a2006-10-06 18:20:14 +020027#include <sound/control.h>
28#include <sound/ac97_codec.h>
29
Richard Purdie808db4a2006-10-06 18:20:14 +020030/*
31 * Convenience kcontrol builders
32 */
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030033#define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert) \
Jon Smirl4eaa9812008-07-29 11:42:26 +010034 ((unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusi30d86ba2011-10-05 10:29:22 +030035 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
36 .rshift = shift_right, .max = xmax, .platform_max = xmax, \
37 .invert = xinvert})
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030038#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
39 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert)
Jon Smirl4eaa9812008-07-29 11:42:26 +010040#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
41 ((unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030042 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
Peter Ujfalusicdffa772011-10-04 14:39:39 +030043#define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
44 ((unsigned long)&(struct soc_mixer_control) \
45 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
46 .max = xmax, .platform_max = xmax, .invert = xinvert})
Mark Brown229e3fd2012-06-22 11:40:55 +010047#define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
48 ((unsigned long)&(struct soc_mixer_control) \
49 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
50 .min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
Philipp Zabela7a4ac82008-01-10 14:37:42 +010051#define SOC_SINGLE(xname, reg, shift, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020052{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
53 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
54 .put = snd_soc_put_volsw, \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010055 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
Adam Thomson6c9d8cf2012-05-31 15:18:01 +010056#define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
57{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
58 .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
59 .put = snd_soc_put_volsw_range, \
60 .private_value = (unsigned long)&(struct soc_mixer_control) \
Mark Brown9bde4f02012-12-19 16:05:00 +000061 {.reg = xreg, .rreg = xreg, .shift = xshift, \
62 .rshift = xshift, .min = xmin, .max = xmax, \
63 .platform_max = xmax, .invert = xinvert} }
Philipp Zabela7a4ac82008-01-10 14:37:42 +010064#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
65{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
66 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
67 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
68 .tlv.p = (tlv_array), \
69 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
70 .put = snd_soc_put_volsw, \
71 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
Brian Austin1d99f242012-03-30 10:43:55 -050072#define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
73{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
74 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
75 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
76 .tlv.p = (tlv_array),\
77 .info = snd_soc_info_volsw, \
78 .get = snd_soc_get_volsw_sx,\
79 .put = snd_soc_put_volsw_sx, \
80 .private_value = (unsigned long)&(struct soc_mixer_control) \
81 {.reg = xreg, .rreg = xreg, \
82 .shift = xshift, .rshift = xshift, \
83 .max = xmax, .min = xmin} }
Adam Thomson6c9d8cf2012-05-31 15:18:01 +010084#define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, 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_range, \
90 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
91 .private_value = (unsigned long)&(struct soc_mixer_control) \
Mark Brown9bde4f02012-12-19 16:05:00 +000092 {.reg = xreg, .rreg = xreg, .shift = xshift, \
93 .rshift = xshift, .min = xmin, .max = xmax, \
94 .platform_max = xmax, .invert = xinvert} }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030095#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020096{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
97 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
98 .put = snd_soc_put_volsw, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030099 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
100 max, invert) }
Jon Smirl4eaa9812008-07-29 11:42:26 +0100101#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
Richard Purdie808db4a2006-10-06 18:20:14 +0200102{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300103 .info = snd_soc_info_volsw, \
Peter Ujfalusi974815b2011-10-05 10:29:25 +0300104 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300105 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
106 xmax, xinvert) }
Mark Brown229e3fd2012-06-22 11:40:55 +0100107#define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
108 xmax, xinvert) \
109{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
110 .info = snd_soc_info_volsw_range, \
111 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
112 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
113 xshift, xmin, xmax, xinvert) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300114#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100115{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
116 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
117 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
118 .tlv.p = (tlv_array), \
119 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
120 .put = snd_soc_put_volsw, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300121 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
122 max, invert) }
Jon Smirl4eaa9812008-07-29 11:42:26 +0100123#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +0100124{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
125 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
126 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
127 .tlv.p = (tlv_array), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300128 .info = snd_soc_info_volsw, \
Peter Ujfalusi974815b2011-10-05 10:29:25 +0300129 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300130 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
131 xmax, xinvert) }
Mark Brown229e3fd2012-06-22 11:40:55 +0100132#define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
133 xmax, xinvert, tlv_array) \
134{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
135 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
136 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
137 .tlv.p = (tlv_array), \
138 .info = snd_soc_info_volsw_range, \
139 .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
140 .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
141 xshift, xmin, xmax, xinvert) }
Brian Austin1d99f242012-03-30 10:43:55 -0500142#define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
143{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
144 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
145 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
146 .tlv.p = (tlv_array), \
147 .info = snd_soc_info_volsw, \
148 .get = snd_soc_get_volsw_sx, \
149 .put = snd_soc_put_volsw_sx, \
150 .private_value = (unsigned long)&(struct soc_mixer_control) \
151 {.reg = xreg, .rreg = xrreg, \
152 .shift = xshift, .rshift = xshift, \
153 .max = xmax, .min = xmin} }
Jon Smirl4eaa9812008-07-29 11:42:26 +0100154#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
Mark Browne13ac2e2008-05-28 17:58:05 +0100155{ .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_s8, .get = snd_soc_get_volsw_s8, \
160 .put = snd_soc_put_volsw_s8, \
Jon Smirl4eaa9812008-07-29 11:42:26 +0100161 .private_value = (unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300162 {.reg = xreg, .min = xmin, .max = xmax, \
163 .platform_max = xmax} }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100164#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
Richard Purdie808db4a2006-10-06 18:20:14 +0200165{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
Lars-Peter Clausen86767b72012-09-14 13:57:27 +0200166 .max = xmax, .texts = xtexts, \
167 .mask = xmax ? roundup_pow_of_two(xmax) - 1 : 0}
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100168#define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
169 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
170#define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
171{ .max = xmax, .texts = xtexts }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200172#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
173{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
174 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
175#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
176 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
Richard Purdie808db4a2006-10-06 18:20:14 +0200177#define SOC_ENUM(xname, xenum) \
178{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
179 .info = snd_soc_info_enum_double, \
180 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
181 .private_value = (unsigned long)&xenum }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200182#define SOC_VALUE_ENUM(xname, xenum) \
183{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
Peter Ujfalusi74155552009-01-08 13:34:29 +0200184 .info = snd_soc_info_enum_double, \
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200185 .get = snd_soc_get_value_enum_double, \
186 .put = snd_soc_put_value_enum_double, \
187 .private_value = (unsigned long)&xenum }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100188#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
Richard Purdie808db4a2006-10-06 18:20:14 +0200189 xhandler_get, xhandler_put) \
190{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100191 .info = snd_soc_info_volsw, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200192 .get = xhandler_get, .put = xhandler_put, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100193 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300194#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
Daniel Mack7629ad22009-04-24 16:37:44 +0200195 xhandler_get, xhandler_put) \
196{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
197 .info = snd_soc_info_volsw, \
198 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300199 .private_value = \
200 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert) }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100201#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
Mike Montour10144c02008-06-11 13:47:13 +0100202 xhandler_get, xhandler_put, tlv_array) \
203{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
204 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
205 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
206 .tlv.p = (tlv_array), \
207 .info = snd_soc_info_volsw, \
208 .get = xhandler_get, .put = xhandler_put, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100209 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
Joonyoung Shimd0af93d2009-07-15 20:33:47 +0900210#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
211 xhandler_get, xhandler_put, tlv_array) \
212{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
213 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
214 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
215 .tlv.p = (tlv_array), \
216 .info = snd_soc_info_volsw, \
217 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300218 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
219 xmax, xinvert) }
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900220#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
221 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), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300226 .info = snd_soc_info_volsw, \
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900227 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300228 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
229 xmax, xinvert) }
Richard Purdie808db4a2006-10-06 18:20:14 +0200230#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
231{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
232 .info = snd_soc_info_bool_ext, \
233 .get = xhandler_get, .put = xhandler_put, \
234 .private_value = xdata }
235#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
236{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
237 .info = snd_soc_info_enum_ext, \
238 .get = xhandler_get, .put = xhandler_put, \
239 .private_value = (unsigned long)&xenum }
240
Mark Brown71d08512011-10-10 18:31:26 +0100241#define SND_SOC_BYTES(xname, xbase, xregs) \
242{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
243 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
244 .put = snd_soc_bytes_put, .private_value = \
245 ((unsigned long)&(struct soc_bytes) \
246 {.base = xbase, .num_regs = xregs }) }
apatard@mandriva.comb6f4bb32010-05-15 17:30:01 +0200247
Mark Brownf831b052012-02-17 16:20:33 -0800248#define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask) \
249{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
250 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
251 .put = snd_soc_bytes_put, .private_value = \
252 ((unsigned long)&(struct soc_bytes) \
253 {.base = xbase, .num_regs = xregs, \
254 .mask = xmask }) }
255
Kristoffer KARLSSON4183eed22012-04-20 11:32:13 +0200256#define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
257 xmin, xmax, xinvert) \
258{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
259 .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
260 .put = snd_soc_put_xr_sx, \
261 .private_value = (unsigned long)&(struct soc_mreg_control) \
262 {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
263 .invert = xinvert, .min = xmin, .max = xmax} }
264
Kristoffer KARLSSONdd7b10b2012-04-20 11:32:44 +0200265#define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
266 SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
267 snd_soc_get_strobe, snd_soc_put_strobe)
268
Richard Purdie808db4a2006-10-06 18:20:14 +0200269/*
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100270 * Simplified versions of above macros, declaring a struct and calculating
271 * ARRAY_SIZE internally
272 */
273#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
274 struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
275 ARRAY_SIZE(xtexts), xtexts)
276#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
277 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
278#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
279 struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
280#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
281 struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
282 ARRAY_SIZE(xtexts), xtexts, xvalues)
283#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
284 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
285
286/*
Liam Girdwood0168bf02011-06-07 16:08:05 +0100287 * Component probe and remove ordering levels for components with runtime
288 * dependencies.
289 */
290#define SND_SOC_COMP_ORDER_FIRST -2
291#define SND_SOC_COMP_ORDER_EARLY -1
292#define SND_SOC_COMP_ORDER_NORMAL 0
293#define SND_SOC_COMP_ORDER_LATE 1
294#define SND_SOC_COMP_ORDER_LAST 2
295
296/*
Mark Brown0be98982008-05-19 12:31:28 +0200297 * Bias levels
298 *
299 * @ON: Bias is fully on for audio playback and capture operations.
300 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
301 * stream start and stop operations.
302 * @STANDBY: Low power standby state when no playback/capture operations are
303 * in progress. NOTE: The transition time between STANDBY and ON
304 * should be as fast as possible and no longer than 10ms.
305 * @OFF: Power Off. No restrictions on transition times.
306 */
307enum snd_soc_bias_level {
Mark Brown56fba412011-06-04 11:25:10 +0100308 SND_SOC_BIAS_OFF = 0,
309 SND_SOC_BIAS_STANDBY = 1,
310 SND_SOC_BIAS_PREPARE = 2,
311 SND_SOC_BIAS_ON = 3,
Mark Brown0be98982008-05-19 12:31:28 +0200312};
313
Stephen Warren5a504962011-12-21 10:40:59 -0700314struct device_node;
Mark Brown8a2cd612009-01-07 17:31:10 +0000315struct snd_jack;
316struct snd_soc_card;
Richard Purdie808db4a2006-10-06 18:20:14 +0200317struct snd_soc_pcm_stream;
318struct snd_soc_ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200319struct snd_soc_pcm_runtime;
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100320struct snd_soc_dai;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000321struct snd_soc_dai_driver;
Mark Brown12a48a8c2008-12-03 19:40:30 +0000322struct snd_soc_platform;
jassi brard273ebe2010-02-22 15:58:04 +0900323struct snd_soc_dai_link;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000324struct snd_soc_platform_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200325struct snd_soc_codec;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000326struct snd_soc_codec_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200327struct soc_enum;
Mark Brown8a2cd612009-01-07 17:31:10 +0000328struct snd_soc_jack;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530329struct snd_soc_jack_zone;
Mark Brown8a2cd612009-01-07 17:31:10 +0000330struct snd_soc_jack_pin;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000331struct snd_soc_cache_ops;
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200332#include <sound/soc-dapm.h>
Liam Girdwood01d75842012-04-25 12:12:49 +0100333#include <sound/soc-dpcm.h>
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000334
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600335#ifdef CONFIG_GPIOLIB
336struct snd_soc_jack_gpio;
337#endif
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
341extern struct snd_ac97_bus_ops soc_ac97_ops;
342
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
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000349enum snd_soc_compress_type {
Dimitris Papastamos119bd782010-12-02 14:53:02 +0000350 SND_SOC_FLAT_COMPRESSION = 1,
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000351};
352
Liam Girdwoodb8c0dab2011-06-09 17:04:39 +0100353enum snd_soc_pcm_subclass {
354 SND_SOC_PCM_CLASS_PCM = 0,
355 SND_SOC_PCM_CLASS_BE = 1,
356};
357
Liam Girdwood01b9d992012-03-07 10:38:25 +0000358enum snd_soc_card_subclass {
Liam Girdwood6874a912012-03-09 12:02:07 +0000359 SND_SOC_CARD_CLASS_INIT = 0,
360 SND_SOC_CARD_CLASS_RUNTIME = 1,
Liam Girdwood01b9d992012-03-07 10:38:25 +0000361};
362
Mark Brownec4ee522011-03-07 20:58:11 +0000363int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
Mark Brownda1c6ea2011-08-24 20:09:01 +0100364 int source, unsigned int freq, int dir);
Mark Brownec4ee522011-03-07 20:58:11 +0000365int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
366 unsigned int freq_in, unsigned int freq_out);
367
Vinod Koul70a7ca32011-01-14 19:22:48 +0530368int snd_soc_register_card(struct snd_soc_card *card);
369int snd_soc_unregister_card(struct snd_soc_card *card);
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000370int snd_soc_suspend(struct device *dev);
371int snd_soc_resume(struct device *dev);
372int snd_soc_poweroff(struct device *dev);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000373int snd_soc_register_platform(struct device *dev,
374 struct snd_soc_platform_driver *platform_drv);
375void snd_soc_unregister_platform(struct device *dev);
376int snd_soc_register_codec(struct device *dev,
Mark Brown001ae4c2010-12-02 16:21:08 +0000377 const struct snd_soc_codec_driver *codec_drv,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000378 struct snd_soc_dai_driver *dai_drv, int num_dai);
379void snd_soc_unregister_codec(struct device *dev);
Mark Brown181e0552011-01-24 14:05:25 +0000380int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
381 unsigned int reg);
Dimitris Papastamos239c9702011-03-24 13:45:18 +0000382int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
383 unsigned int reg);
384int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
385 unsigned int reg);
Mark Brown17a52fd2009-07-05 17:24:50 +0100386int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
Mark Brown7084a422009-07-10 22:24:27 +0100387 int addr_bits, int data_bits,
388 enum snd_soc_control_type control);
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000389int snd_soc_cache_sync(struct snd_soc_codec *codec);
390int snd_soc_cache_init(struct snd_soc_codec *codec);
391int snd_soc_cache_exit(struct snd_soc_codec *codec);
392int snd_soc_cache_write(struct snd_soc_codec *codec,
393 unsigned int reg, unsigned int value);
394int snd_soc_cache_read(struct snd_soc_codec *codec,
395 unsigned int reg, unsigned int *value);
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000396int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
397 unsigned int reg);
398int snd_soc_default_readable_register(struct snd_soc_codec *codec,
399 unsigned int reg);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000400int snd_soc_default_writable_register(struct snd_soc_codec *codec,
401 unsigned int reg);
Liam Girdwoodf1442bc2011-07-04 11:10:15 +0100402int snd_soc_platform_read(struct snd_soc_platform *platform,
403 unsigned int reg);
404int snd_soc_platform_write(struct snd_soc_platform *platform,
405 unsigned int reg, unsigned int val);
Mark Brown354a2142011-12-22 12:16:39 +0000406int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
Vinod Koul49681072012-08-16 17:10:40 +0530407int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
Mark Brown12a48a8c2008-12-03 19:40:30 +0000408
Liam Girdwood47c88ff2012-04-25 12:12:53 +0100409struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
410 const char *dai_link, int stream);
411struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
412 const char *dai_link);
413
Mark Brown7aae8162009-11-10 16:08:04 +0000414/* Utility functions to get clock rates from various things */
415int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
416int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
Mark Brownc0fa59d2009-11-19 11:36:10 +0000417int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
Mark Brown7aae8162009-11-10 16:08:04 +0000418int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
419
Richard Purdie808db4a2006-10-06 18:20:14 +0200420/* set runtime hw params */
421int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
422 const struct snd_pcm_hardware *hw);
Richard Purdie808db4a2006-10-06 18:20:14 +0200423
Liam Girdwood07bf84a2012-04-25 12:12:52 +0100424int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
425 int cmd, struct snd_soc_platform *platform);
426
Mark Brown8a2cd612009-01-07 17:31:10 +0000427/* Jack reporting */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000428int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
Mark Brown8a2cd612009-01-07 17:31:10 +0000429 struct snd_soc_jack *jack);
430void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
431int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
432 struct snd_soc_jack_pin *pins);
Mark Brownd5021ec2010-03-22 12:06:30 +0000433void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
434 struct notifier_block *nb);
435void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
436 struct notifier_block *nb);
Vinod Koulfa9879e2011-02-09 14:44:17 +0530437int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
438 struct snd_soc_jack_zone *zones);
439int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600440#ifdef CONFIG_GPIOLIB
441int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
442 struct snd_soc_jack_gpio *gpios);
443void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
444 struct snd_soc_jack_gpio *gpios);
445#endif
Mark Brown8a2cd612009-01-07 17:31:10 +0000446
Richard Purdie808db4a2006-10-06 18:20:14 +0200447/* codec register bit access */
448int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300449 unsigned int mask, unsigned int value);
Mark Browndd1b3d52009-12-04 14:22:03 +0000450int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
451 unsigned short reg, unsigned int mask,
452 unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200453int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300454 unsigned int mask, unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200455
456int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
457 struct snd_ac97_bus_ops *ops, int num);
458void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
459
460/*
461 *Controls
462 */
463struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
Mark Brown30565572012-02-16 17:07:42 -0800464 void *data, const char *long_name,
Mark Brownefb7ac32011-03-08 17:23:24 +0000465 const char *prefix);
Liam Girdwood022658b2012-02-03 17:43:09 +0000466int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
Ian Molton3e8e1952009-01-09 00:23:21 +0000467 const struct snd_kcontrol_new *controls, int num_controls);
Liam Girdwooda491a5c2011-07-04 22:10:51 +0100468int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
469 const struct snd_kcontrol_new *controls, int num_controls);
Liam Girdwood022658b2012-02-03 17:43:09 +0000470int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
471 const struct snd_kcontrol_new *controls, int num_controls);
472int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
473 const struct snd_kcontrol_new *controls, int num_controls);
Richard Purdie808db4a2006-10-06 18:20:14 +0200474int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
475 struct snd_ctl_elem_info *uinfo);
476int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
477 struct snd_ctl_elem_info *uinfo);
478int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
479 struct snd_ctl_elem_value *ucontrol);
480int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
481 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200482int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
483 struct snd_ctl_elem_value *ucontrol);
484int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
485 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200486int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
487 struct snd_ctl_elem_info *uinfo);
488int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
489 struct snd_ctl_elem_info *uinfo);
Philipp Zabel392abe92008-05-13 14:03:40 +0200490#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
Richard Purdie808db4a2006-10-06 18:20:14 +0200491int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
492 struct snd_ctl_elem_value *ucontrol);
493int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
494 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusia92f1392011-10-06 07:43:21 +0300495#define snd_soc_get_volsw_2r snd_soc_get_volsw
496#define snd_soc_put_volsw_2r snd_soc_put_volsw
Brian Austin1d99f242012-03-30 10:43:55 -0500497int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
498 struct snd_ctl_elem_value *ucontrol);
499int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
500 struct snd_ctl_elem_value *ucontrol);
Mark Browne13ac2e2008-05-28 17:58:05 +0100501int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
502 struct snd_ctl_elem_info *uinfo);
503int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
504 struct snd_ctl_elem_value *ucontrol);
505int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
506 struct snd_ctl_elem_value *ucontrol);
Adam Thomson6c9d8cf2012-05-31 15:18:01 +0100507int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
508 struct snd_ctl_elem_info *uinfo);
509int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
510 struct snd_ctl_elem_value *ucontrol);
511int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
512 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi637d3842010-05-07 14:05:49 +0300513int snd_soc_limit_volume(struct snd_soc_codec *codec,
514 const char *name, int max);
Mark Brown71d08512011-10-10 18:31:26 +0100515int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
516 struct snd_ctl_elem_info *uinfo);
517int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
518 struct snd_ctl_elem_value *ucontrol);
519int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
520 struct snd_ctl_elem_value *ucontrol);
Kristoffer KARLSSON4183eed22012-04-20 11:32:13 +0200521int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
522 struct snd_ctl_elem_info *uinfo);
523int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
524 struct snd_ctl_elem_value *ucontrol);
525int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
526 struct snd_ctl_elem_value *ucontrol);
Kristoffer KARLSSONdd7b10b2012-04-20 11:32:44 +0200527int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
528 struct snd_ctl_elem_value *ucontrol);
529int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
530 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200531
Mark Brown8a2cd612009-01-07 17:31:10 +0000532/**
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000533 * struct snd_soc_reg_access - Describes whether a given register is
534 * readable, writable or volatile.
535 *
536 * @reg: the register number
537 * @read: whether this register is readable
538 * @write: whether this register is writable
539 * @vol: whether this register is volatile
540 */
541struct snd_soc_reg_access {
542 u16 reg;
543 u16 read;
544 u16 write;
545 u16 vol;
546};
547
548/**
Mark Brown8a2cd612009-01-07 17:31:10 +0000549 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
550 *
551 * @pin: name of the pin to update
552 * @mask: bits to check for in reported jack status
553 * @invert: if non-zero then pin is enabled when status is not reported
554 */
555struct snd_soc_jack_pin {
556 struct list_head list;
557 const char *pin;
558 int mask;
559 bool invert;
560};
561
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600562/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530563 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
564 *
565 * @min_mv: start voltage in mv
566 * @max_mv: end voltage in mv
567 * @jack_type: type of jack that is expected for this voltage
568 * @debounce_time: debounce_time for jack, codec driver should wait for this
569 * duration before reading the adc for voltages
570 * @:list: list container
571 */
572struct snd_soc_jack_zone {
573 unsigned int min_mv;
574 unsigned int max_mv;
575 unsigned int jack_type;
576 unsigned int debounce_time;
577 struct list_head list;
578};
579
580/**
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600581 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
582 *
583 * @gpio: gpio number
584 * @name: gpio name
585 * @report: value to report when jack detected
586 * @invert: report presence in low state
587 * @debouce_time: debouce time in ms
Mark Brown7887ab32011-02-17 16:35:55 -0800588 * @wake: enable as wake source
Mark Brownfadddc82011-02-17 16:41:42 -0800589 * @jack_status_check: callback function which overrides the detection
590 * to provide more complex checks (eg, reading an
591 * ADC).
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600592 */
593#ifdef CONFIG_GPIOLIB
594struct snd_soc_jack_gpio {
595 unsigned int gpio;
596 const char *name;
597 int report;
598 int invert;
599 int debounce_time;
Mark Brown7887ab32011-02-17 16:35:55 -0800600 bool wake;
601
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600602 struct snd_soc_jack *jack;
Mark Brown4c14d782010-10-06 15:54:28 -0700603 struct delayed_work work;
Joonyoung Shimc871a052009-11-12 17:14:04 +0900604
605 int (*jack_status_check)(void);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600606};
607#endif
608
Mark Brown8a2cd612009-01-07 17:31:10 +0000609struct snd_soc_jack {
Mark Brown2667b4b2012-03-12 14:07:49 +0000610 struct mutex mutex;
Mark Brown8a2cd612009-01-07 17:31:10 +0000611 struct snd_jack *jack;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000612 struct snd_soc_codec *codec;
Mark Brown8a2cd612009-01-07 17:31:10 +0000613 struct list_head pins;
614 int status;
Mark Brownd5021ec2010-03-22 12:06:30 +0000615 struct blocking_notifier_head notifier;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530616 struct list_head jack_zones;
Mark Brown8a2cd612009-01-07 17:31:10 +0000617};
618
Richard Purdie808db4a2006-10-06 18:20:14 +0200619/* SoC PCM stream information */
620struct snd_soc_pcm_stream {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000621 const char *stream_name;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100622 u64 formats; /* SNDRV_PCM_FMTBIT_* */
623 unsigned int rates; /* SNDRV_PCM_RATE_* */
Richard Purdie808db4a2006-10-06 18:20:14 +0200624 unsigned int rate_min; /* min rate */
625 unsigned int rate_max; /* max rate */
626 unsigned int channels_min; /* min channels */
627 unsigned int channels_max; /* max channels */
Mark Brown58ba9b22012-01-16 18:38:51 +0000628 unsigned int sig_bits; /* number of bits of content */
Richard Purdie808db4a2006-10-06 18:20:14 +0200629};
630
631/* SoC audio ops */
632struct snd_soc_ops {
633 int (*startup)(struct snd_pcm_substream *);
634 void (*shutdown)(struct snd_pcm_substream *);
635 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
636 int (*hw_free)(struct snd_pcm_substream *);
637 int (*prepare)(struct snd_pcm_substream *);
638 int (*trigger)(struct snd_pcm_substream *, int);
639};
640
Vinod Koul49681072012-08-16 17:10:40 +0530641struct snd_soc_compr_ops {
642 int (*startup)(struct snd_compr_stream *);
643 void (*shutdown)(struct snd_compr_stream *);
644 int (*set_params)(struct snd_compr_stream *);
645 int (*trigger)(struct snd_compr_stream *);
646};
647
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000648/* SoC cache ops */
649struct snd_soc_cache_ops {
Dimitris Papastamos0d735ea2010-12-06 09:51:57 +0000650 const char *name;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000651 enum snd_soc_compress_type id;
652 int (*init)(struct snd_soc_codec *codec);
653 int (*exit)(struct snd_soc_codec *codec);
654 int (*read)(struct snd_soc_codec *codec, unsigned int reg,
655 unsigned int *value);
656 int (*write)(struct snd_soc_codec *codec, unsigned int reg,
657 unsigned int value);
658 int (*sync)(struct snd_soc_codec *codec);
659};
660
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000661/* SoC Audio Codec device */
Richard Purdie808db4a2006-10-06 18:20:14 +0200662struct snd_soc_codec {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000663 const char *name;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200664 const char *name_prefix;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000665 int id;
Mark Brown0d0cf002008-12-10 14:32:45 +0000666 struct device *dev;
Mark Brown001ae4c2010-12-02 16:21:08 +0000667 const struct snd_soc_codec_driver *driver;
Mark Brown0d0cf002008-12-10 14:32:45 +0000668
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000669 struct mutex mutex;
670 struct snd_soc_card *card;
Mark Brown0d0cf002008-12-10 14:32:45 +0000671 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000672 struct list_head card_list;
673 int num_dai;
Dimitris Papastamos23bbce32010-12-02 14:53:01 +0000674 enum snd_soc_compress_type compress_type;
Dimitris Papastamosaea170a2011-01-12 10:38:58 +0000675 size_t reg_size; /* reg_cache_size * reg_word_size */
Dimitris Papastamos1500b7b2011-01-13 12:20:38 +0000676 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
677 int (*readable_register)(struct snd_soc_codec *, unsigned int);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000678 int (*writable_register)(struct snd_soc_codec *, unsigned int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200679
680 /* runtime */
Richard Purdie808db4a2006-10-06 18:20:14 +0200681 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
682 unsigned int active;
Dimitris Papastamosdad8e7a2011-01-19 14:53:36 +0000683 unsigned int cache_bypass:1; /* Suppress access to the cache */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000684 unsigned int suspended:1; /* Codec is in suspend PM state */
685 unsigned int probed:1; /* Codec has been probed */
686 unsigned int ac97_registered:1; /* Codec has been AC97 registered */
Mika Westerberg0562f782010-10-13 11:30:32 +0300687 unsigned int ac97_created:1; /* Codec has been created by SoC */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000688 unsigned int sysfs_registered:1; /* codec has been sysfs registered */
Dimitris Papastamosfdf0f542010-12-02 16:11:06 +0000689 unsigned int cache_init:1; /* codec cache has been initialized */
Mark Brown8a713da2011-12-03 12:33:55 +0000690 unsigned int using_regmap:1; /* using regmap access */
Mark Brownaaee8ef2011-01-26 20:53:50 +0000691 u32 cache_only; /* Suppress writes to hardware */
692 u32 cache_sync; /* Cache needs to be synced to hardware */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000693
694 /* codec IO */
695 void *control_data; /* codec control (i2c/3wire) data */
Dimitris Papastamos67850a82011-03-22 10:36:57 +0000696 enum snd_soc_control_type control_type;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000697 hw_write_t hw_write;
698 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
Mark Brownc3acec22010-12-02 16:15:29 +0000699 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
700 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
Dimitris Papastamos5fb609d2011-03-22 10:37:03 +0000701 int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000702 void *reg_cache;
Dimitris Papastamos3335ddc2010-12-02 16:11:05 +0000703 const void *reg_def_copy;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000704 const struct snd_soc_cache_ops *cache_ops;
705 struct mutex cache_rw_mutex;
Mark Brownbe3ea3b2011-06-13 19:35:29 +0100706 int val_bytes;
Mark Browna96ca332010-01-19 22:49:43 +0000707
Richard Purdie808db4a2006-10-06 18:20:14 +0200708 /* dapm */
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200709 struct snd_soc_dapm_context dapm;
Peter Ujfalusi1d69c5c2011-10-14 14:43:33 +0300710 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
Richard Purdie808db4a2006-10-06 18:20:14 +0200711
Mark Brown384c89e2008-12-03 17:34:03 +0000712#ifdef CONFIG_DEBUG_FS
Peter Ujfalusi88439ac2009-10-01 10:32:47 +0300713 struct dentry *debugfs_codec_root;
Mark Brown384c89e2008-12-03 17:34:03 +0000714 struct dentry *debugfs_reg;
Mark Brown79fb9382009-08-21 16:38:13 +0100715 struct dentry *debugfs_dapm;
Mark Brown384c89e2008-12-03 17:34:03 +0000716#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200717};
718
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000719/* codec driver */
720struct snd_soc_codec_driver {
721
722 /* driver ops */
723 int (*probe)(struct snd_soc_codec *);
724 int (*remove)(struct snd_soc_codec *);
Lars-Peter Clausen84b315e2011-12-02 10:18:28 +0100725 int (*suspend)(struct snd_soc_codec *);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000726 int (*resume)(struct snd_soc_codec *);
727
Mark Brownb7af1da2011-04-07 19:18:44 +0900728 /* Default control and setup, added after probe() is run */
729 const struct snd_kcontrol_new *controls;
730 int num_controls;
Mark Brown89b95ac02011-03-07 16:38:44 +0000731 const struct snd_soc_dapm_widget *dapm_widgets;
732 int num_dapm_widgets;
733 const struct snd_soc_dapm_route *dapm_routes;
734 int num_dapm_routes;
735
Mark Brownec4ee522011-03-07 20:58:11 +0000736 /* codec wide operations */
737 int (*set_sysclk)(struct snd_soc_codec *codec,
Mark Brownda1c6ea2011-08-24 20:09:01 +0100738 int clk_id, int source, unsigned int freq, int dir);
Mark Brownec4ee522011-03-07 20:58:11 +0000739 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
740 unsigned int freq_in, unsigned int freq_out);
741
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000742 /* codec IO */
743 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
744 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
745 int (*display_register)(struct snd_soc_codec *, char *,
746 size_t, unsigned int);
Dimitris Papastamosd4754ec2011-01-13 12:20:37 +0000747 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
748 int (*readable_register)(struct snd_soc_codec *, unsigned int);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000749 int (*writable_register)(struct snd_soc_codec *, unsigned int);
Mark Brown4a8923b2011-08-24 19:12:49 +0100750 unsigned int reg_cache_size;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000751 short reg_cache_step;
752 short reg_word_size;
753 const void *reg_cache_default;
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000754 short reg_access_size;
755 const struct snd_soc_reg_access *reg_access_default;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000756 enum snd_soc_compress_type compress_type;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000757
758 /* codec bias level */
759 int (*set_bias_level)(struct snd_soc_codec *,
760 enum snd_soc_bias_level level);
Mark Brown33c5f962011-08-22 18:40:30 +0100761 bool idle_bias_off;
Mark Brown474b62d2011-01-18 16:14:44 +0000762
763 void (*seq_notifier)(struct snd_soc_dapm_context *,
Mark Brownf85a9e02011-01-26 21:41:28 +0000764 enum snd_soc_dapm_type, int);
Liam Girdwood0168bf02011-06-07 16:08:05 +0100765
Liam Girdwood64a648c2011-07-25 11:15:15 +0100766 /* codec stream completion event */
767 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
768
Mark Brown5124e692012-02-08 13:20:50 +0000769 bool ignore_pmdown_time; /* Doesn't benefit from pmdown delay */
770
Liam Girdwood0168bf02011-06-07 16:08:05 +0100771 /* probe ordering - for components with runtime dependencies */
772 int probe_order;
773 int remove_order;
Richard Purdie808db4a2006-10-06 18:20:14 +0200774};
775
776/* SoC platform interface */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000777struct snd_soc_platform_driver {
Richard Purdie808db4a2006-10-06 18:20:14 +0200778
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000779 int (*probe)(struct snd_soc_platform *);
780 int (*remove)(struct snd_soc_platform *);
781 int (*suspend)(struct snd_soc_dai *dai);
782 int (*resume)(struct snd_soc_dai *dai);
Richard Purdie808db4a2006-10-06 18:20:14 +0200783
784 /* pcm creation and destruction */
Liam Girdwood552d1ef2011-06-07 16:08:33 +0100785 int (*pcm_new)(struct snd_soc_pcm_runtime *);
Richard Purdie808db4a2006-10-06 18:20:14 +0200786 void (*pcm_free)(struct snd_pcm *);
787
Liam Girdwoodcb2cf612011-07-04 22:10:53 +0100788 /* Default control and setup, added after probe() is run */
789 const struct snd_kcontrol_new *controls;
790 int num_controls;
791 const struct snd_soc_dapm_widget *dapm_widgets;
792 int num_dapm_widgets;
793 const struct snd_soc_dapm_route *dapm_routes;
794 int num_dapm_routes;
795
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200796 /*
797 * For platform caused delay reporting.
798 * Optional.
799 */
800 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
801 struct snd_soc_dai *);
802
Vinod Koul49681072012-08-16 17:10:40 +0530803 /* platform stream pcm ops */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000804 struct snd_pcm_ops *ops;
Liam Girdwood0168bf02011-06-07 16:08:05 +0100805
Vinod Koul49681072012-08-16 17:10:40 +0530806 /* platform stream compress ops */
807 struct snd_compr_ops *compr_ops;
808
Liam Girdwood64a648c2011-07-25 11:15:15 +0100809 /* platform stream completion event */
810 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
811
Liam Girdwood0168bf02011-06-07 16:08:05 +0100812 /* probe ordering - for components with runtime dependencies */
813 int probe_order;
814 int remove_order;
Liam Girdwoodf1442bc2011-07-04 11:10:15 +0100815
816 /* platform IO - used for platform DAPM */
817 unsigned int (*read)(struct snd_soc_platform *, unsigned int);
818 int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
Liam Girdwood07bf84a2012-04-25 12:12:52 +0100819 int (*bespoke_trigger)(struct snd_pcm_substream *, int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200820};
821
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000822struct snd_soc_platform {
823 const char *name;
824 int id;
825 struct device *dev;
826 struct snd_soc_platform_driver *driver;
Liam Girdwoodcc22d372012-03-06 18:16:18 +0000827 struct mutex mutex;
Richard Purdie808db4a2006-10-06 18:20:14 +0200828
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000829 unsigned int suspended:1; /* platform is suspended */
830 unsigned int probed:1;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100831
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000832 struct snd_soc_card *card;
833 struct list_head list;
834 struct list_head card_list;
Liam Girdwoodb7950642011-07-04 22:10:52 +0100835
836 struct snd_soc_dapm_context dapm;
Sebastien Guiriec731f1ab2012-02-15 15:25:31 +0000837
838#ifdef CONFIG_DEBUG_FS
839 struct dentry *debugfs_platform_root;
840 struct dentry *debugfs_dapm;
841#endif
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000842};
Richard Purdie808db4a2006-10-06 18:20:14 +0200843
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000844struct snd_soc_dai_link {
845 /* config - must be set by machine driver */
846 const char *name; /* Codec name */
847 const char *stream_name; /* Stream name */
Stephen Warrenbc926572012-05-25 18:22:11 -0600848 /*
849 * You MAY specify the link's CPU-side device, either by device name,
850 * or by DT/OF node, but not both. If this information is omitted,
851 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
852 * must be globally unique. These fields are currently typically used
853 * only for codec to codec links, or systems using device tree.
854 */
855 const char *cpu_name;
856 const struct device_node *cpu_of_node;
857 /*
858 * You MAY specify the DAI name of the CPU DAI. If this information is
859 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
860 * only, which only works well when that device exposes a single DAI.
861 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000862 const char *cpu_dai_name;
Stephen Warrenbc926572012-05-25 18:22:11 -0600863 /*
864 * You MUST specify the link's codec, either by device name, or by
865 * DT/OF node, but not both.
866 */
867 const char *codec_name;
868 const struct device_node *codec_of_node;
869 /* You MUST specify the DAI name within the codec */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000870 const char *codec_dai_name;
Stephen Warrenbc926572012-05-25 18:22:11 -0600871 /*
872 * You MAY specify the link's platform/PCM/DMA driver, either by
873 * device name, or by DT/OF node, but not both. Some forms of link
874 * do not need a platform.
875 */
876 const char *platform_name;
877 const struct device_node *platform_of_node;
Liam Girdwood01d75842012-04-25 12:12:49 +0100878 int be_id; /* optional ID for machine driver BE identification */
Liam Girdwood4ccab3e2008-01-10 14:39:01 +0100879
Mark Brownc74184e2012-04-04 22:12:09 +0100880 const struct snd_soc_pcm_stream *params;
881
Mark Brown75d9ac42011-09-27 16:41:01 +0100882 unsigned int dai_fmt; /* format to set on init */
883
Liam Girdwood01d75842012-04-25 12:12:49 +0100884 enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
885
Mark Brown3efab7d2010-05-09 13:25:43 +0100886 /* Keep DAI active over suspend */
887 unsigned int ignore_suspend:1;
888
Mark Brown06f409d2009-04-07 18:10:13 +0100889 /* Symmetry requirements */
890 unsigned int symmetric_rates:1;
891
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
ramesh.babu@linux.intel.come50fad42011-10-27 12:12:33 +0530898 /* pmdown_time is ignored at stop */
899 unsigned int ignore_pmdown_time:1;
900
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000901 /* codec/machine specific init - e.g. add machine controls */
902 int (*init)(struct snd_soc_pcm_runtime *rtd);
Mark Brown06f409d2009-04-07 18:10:13 +0100903
Liam Girdwood01d75842012-04-25 12:12:49 +0100904 /* optional hw_params re-writing for BE and FE sync */
905 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
906 struct snd_pcm_hw_params *params);
907
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000908 /* machine stream operations */
909 struct snd_soc_ops *ops;
Vinod Koul49681072012-08-16 17:10:40 +0530910 struct snd_soc_compr_ops *compr_ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200911};
912
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000913struct snd_soc_codec_conf {
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200914 const char *dev_name;
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000915
916 /*
917 * optional map of kcontrol, widget and path name prefixes that are
918 * associated per device
919 */
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200920 const char *name_prefix;
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000921
922 /*
923 * set this to the desired compression type if you want to
924 * override the one supplied in codec->driver->compress_type
925 */
926 enum snd_soc_compress_type compress_type;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200927};
928
Jarkko Nikula2eea3922010-11-25 17:47:38 +0200929struct snd_soc_aux_dev {
930 const char *name; /* Codec name */
931 const char *codec_name; /* for multi-codec */
932
933 /* codec/machine specific init - e.g. add machine controls */
934 int (*init)(struct snd_soc_dapm_context *dapm);
935};
936
Mark Brown87506542008-11-18 20:50:34 +0000937/* SoC card */
938struct snd_soc_card {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000939 const char *name;
Liam Girdwood22de71b2011-05-12 16:14:04 +0100940 const char *long_name;
941 const char *driver_name;
Mark Brownc5af3a22008-11-28 13:29:45 +0000942 struct device *dev;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000943 struct snd_card *snd_card;
944 struct module *owner;
Mark Brownc5af3a22008-11-28 13:29:45 +0000945
946 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000947 struct mutex mutex;
Liam Girdwooda73fb2df2012-03-07 10:38:26 +0000948 struct mutex dapm_mutex;
Mark Brownc5af3a22008-11-28 13:29:45 +0000949
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000950 bool instantiated;
Richard Purdie808db4a2006-10-06 18:20:14 +0200951
Mark Browne7361ec2011-01-26 14:17:20 +0000952 int (*probe)(struct snd_soc_card *card);
Mark Brown28e9ad92011-03-02 18:36:34 +0000953 int (*late_probe)(struct snd_soc_card *card);
Mark Browne7361ec2011-01-26 14:17:20 +0000954 int (*remove)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200955
956 /* the pre and post PM functions are used to do any PM work before and
957 * after the codec and DAI's do any PM work. */
Mark Brown70b2ac12011-01-26 14:05:25 +0000958 int (*suspend_pre)(struct snd_soc_card *card);
959 int (*suspend_post)(struct snd_soc_card *card);
960 int (*resume_pre)(struct snd_soc_card *card);
961 int (*resume_post)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200962
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100963 /* callbacks */
Mark Brown87506542008-11-18 20:50:34 +0000964 int (*set_bias_level)(struct snd_soc_card *,
Mark Brownd4c60052011-06-06 19:13:23 +0100965 struct snd_soc_dapm_context *dapm,
Mark Brown0be98982008-05-19 12:31:28 +0200966 enum snd_soc_bias_level level);
Mark Brown1badabd2010-12-04 12:41:04 +0000967 int (*set_bias_level_post)(struct snd_soc_card *,
Mark Brownd4c60052011-06-06 19:13:23 +0100968 struct snd_soc_dapm_context *dapm,
Mark Brown1badabd2010-12-04 12:41:04 +0000969 enum snd_soc_bias_level level);
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100970
Mark Brown6c5f1fe2010-02-17 14:30:44 +0000971 long pmdown_time;
Mark Brown96dd3622010-02-12 11:05:44 +0000972
Richard Purdie808db4a2006-10-06 18:20:14 +0200973 /* CPU <--> Codec DAI links */
974 struct snd_soc_dai_link *dai_link;
975 int num_links;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000976 struct snd_soc_pcm_runtime *rtd;
977 int num_rtd;
Mark Brown63084192008-12-02 15:08:03 +0000978
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000979 /* optional codec specific configuration */
980 struct snd_soc_codec_conf *codec_conf;
981 int num_configs;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200982
Jarkko Nikula2eea3922010-11-25 17:47:38 +0200983 /*
984 * optional auxiliary devices such as amplifiers or codecs with DAI
985 * link unused
986 */
987 struct snd_soc_aux_dev *aux_dev;
988 int num_aux_devs;
989 struct snd_soc_pcm_runtime *rtd_aux;
990 int num_aux_rtd;
991
Mark Brownb7af1da2011-04-07 19:18:44 +0900992 const struct snd_kcontrol_new *controls;
993 int num_controls;
994
Mark Brownb8ad29d2011-03-02 18:35:51 +0000995 /*
996 * Card-specific routes and widgets.
997 */
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +0200998 const struct snd_soc_dapm_widget *dapm_widgets;
Mark Brownb8ad29d2011-03-02 18:35:51 +0000999 int num_dapm_widgets;
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +02001000 const struct snd_soc_dapm_route *dapm_routes;
Mark Brownb8ad29d2011-03-02 18:35:51 +00001001 int num_dapm_routes;
Stephen Warren16332812011-11-23 12:42:04 -07001002 bool fully_routed;
Mark Brownb8ad29d2011-03-02 18:35:51 +00001003
Mark Brown63084192008-12-02 15:08:03 +00001004 struct work_struct deferred_resume_work;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001005
1006 /* lists of probed devices belonging to this card */
1007 struct list_head codec_dev_list;
1008 struct list_head platform_dev_list;
1009 struct list_head dai_dev_list;
Jarkko Nikulaa6052152010-11-05 20:35:19 +02001010
Jarkko Nikula97c866d2010-12-14 12:18:31 +02001011 struct list_head widgets;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +02001012 struct list_head paths;
Jarkko Nikula7be31be82010-12-14 12:18:32 +02001013 struct list_head dapm_list;
Mark Browndb432b42011-10-03 21:06:40 +01001014 struct list_head dapm_dirty;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +02001015
Mark Browne37a4972011-03-02 18:21:57 +00001016 /* Generic DAPM context for the card */
1017 struct snd_soc_dapm_context dapm;
Mark Brownde02d072011-09-20 21:43:24 +01001018 struct snd_soc_dapm_stats dapm_stats;
Mark Browne37a4972011-03-02 18:21:57 +00001019
Jarkko Nikulaa6052152010-11-05 20:35:19 +02001020#ifdef CONFIG_DEBUG_FS
1021 struct dentry *debugfs_card_root;
Jarkko Nikula3a45b862010-11-05 20:35:21 +02001022 struct dentry *debugfs_pop_time;
Jarkko Nikulaa6052152010-11-05 20:35:19 +02001023#endif
Jarkko Nikula3a45b862010-11-05 20:35:21 +02001024 u32 pop_time;
Mark Browndddf3e42011-01-28 13:11:47 +00001025
1026 void *drvdata;
Richard Purdie808db4a2006-10-06 18:20:14 +02001027};
1028
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001029/* SoC machine DAI configuration, glues a codec and cpu DAI together */
Mark Brownd66a3272011-11-10 11:46:13 +00001030struct snd_soc_pcm_runtime {
Mark Brown36ae1a92012-01-06 17:12:45 -08001031 struct device *dev;
Mark Brown87506542008-11-18 20:50:34 +00001032 struct snd_soc_card *card;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001033 struct snd_soc_dai_link *dai_link;
Liam Girdwoodb8c0dab2011-06-09 17:04:39 +01001034 struct mutex pcm_mutex;
1035 enum snd_soc_pcm_subclass pcm_subclass;
1036 struct snd_pcm_ops ops;
Richard Purdie808db4a2006-10-06 18:20:14 +02001037
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001038 unsigned int dev_registered:1;
1039
Liam Girdwood01d75842012-04-25 12:12:49 +01001040 /* Dynamic PCM BE runtime data */
1041 struct snd_soc_dpcm_runtime dpcm[2];
1042
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001043 long pmdown_time;
Misael Lopez Cruz9bffb1f2012-12-13 12:23:05 -06001044 unsigned char pop_wait:1;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001045
1046 /* runtime devices */
1047 struct snd_pcm *pcm;
Vinod Koul49681072012-08-16 17:10:40 +05301048 struct snd_compr *compr;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001049 struct snd_soc_codec *codec;
1050 struct snd_soc_platform *platform;
1051 struct snd_soc_dai *codec_dai;
1052 struct snd_soc_dai *cpu_dai;
1053
1054 struct delayed_work delayed_work;
Liam Girdwoodf86dcef2012-04-25 12:12:50 +01001055#ifdef CONFIG_DEBUG_FS
1056 struct dentry *debugfs_dpcm_root;
1057 struct dentry *debugfs_dpcm_state;
1058#endif
Richard Purdie808db4a2006-10-06 18:20:14 +02001059};
1060
Jon Smirl4eaa9812008-07-29 11:42:26 +01001061/* mixer control */
1062struct soc_mixer_control {
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +03001063 int min, max, platform_max;
Jon Smirl815ecf8d2008-07-29 10:22:24 -04001064 unsigned int reg, rreg, shift, rshift, invert;
Jon Smirl4eaa9812008-07-29 11:42:26 +01001065};
1066
Mark Brown71d08512011-10-10 18:31:26 +01001067struct soc_bytes {
1068 int base;
1069 int num_regs;
Mark Brownf831b052012-02-17 16:20:33 -08001070 u32 mask;
Mark Brown71d08512011-10-10 18:31:26 +01001071};
1072
Kristoffer KARLSSON4183eed22012-04-20 11:32:13 +02001073/* multi register control */
1074struct soc_mreg_control {
1075 long min, max;
1076 unsigned int regbase, regcount, nbits, invert;
1077};
1078
Richard Purdie808db4a2006-10-06 18:20:14 +02001079/* enumerated kcontrol */
1080struct soc_enum {
1081 unsigned short reg;
1082 unsigned short reg2;
1083 unsigned char shift_l;
1084 unsigned char shift_r;
Jon Smirlf8ba0b72008-07-29 11:42:27 +01001085 unsigned int max;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +02001086 unsigned int mask;
Takashi Iwai87023ff2011-05-03 12:50:29 +02001087 const char * const *texts;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +02001088 const unsigned int *values;
1089 void *dapm;
1090};
1091
Mark Brown5c82f562009-05-22 09:41:30 +01001092/* codec IO */
Mark Brownc3753702010-11-01 15:41:57 -04001093unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1094unsigned int snd_soc_write(struct snd_soc_codec *codec,
1095 unsigned int reg, unsigned int val);
Dimitris Papastamos5fb609d2011-03-22 10:37:03 +00001096unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
1097 unsigned int reg, const void *data, size_t len);
Mark Brown5c82f562009-05-22 09:41:30 +01001098
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001099/* device driver data */
1100
Mark Browndddf3e42011-01-28 13:11:47 +00001101static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1102 void *data)
1103{
1104 card->drvdata = data;
1105}
1106
1107static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1108{
1109 return card->drvdata;
1110}
1111
Mark Brownb2c812e2010-04-14 15:35:19 +09001112static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001113 void *data)
Mark Brownb2c812e2010-04-14 15:35:19 +09001114{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001115 dev_set_drvdata(codec->dev, data);
Mark Brownb2c812e2010-04-14 15:35:19 +09001116}
1117
1118static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1119{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001120 return dev_get_drvdata(codec->dev);
1121}
1122
1123static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1124 void *data)
1125{
1126 dev_set_drvdata(platform->dev, data);
1127}
1128
1129static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1130{
1131 return dev_get_drvdata(platform->dev);
1132}
1133
1134static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1135 void *data)
1136{
Mark Brown36ae1a92012-01-06 17:12:45 -08001137 dev_set_drvdata(rtd->dev, data);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00001138}
1139
1140static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1141{
Mark Brown36ae1a92012-01-06 17:12:45 -08001142 return dev_get_drvdata(rtd->dev);
Mark Brownb2c812e2010-04-14 15:35:19 +09001143}
1144
Vinod Koul4e10bda2011-01-13 22:48:52 +05301145static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1146{
1147 INIT_LIST_HEAD(&card->dai_dev_list);
1148 INIT_LIST_HEAD(&card->codec_dev_list);
1149 INIT_LIST_HEAD(&card->platform_dev_list);
1150 INIT_LIST_HEAD(&card->widgets);
1151 INIT_LIST_HEAD(&card->paths);
1152 INIT_LIST_HEAD(&card->dapm_list);
1153}
1154
Peter Ujfalusi30d86ba2011-10-05 10:29:22 +03001155static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1156{
1157 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1158 return 0;
1159 /*
1160 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1161 * mc->reg != mc->rreg means that the control is
1162 * stereo (bits in one register or in two registers)
1163 */
1164 return 1;
1165}
1166
Mark Brownfb257892011-04-28 10:57:54 +01001167int snd_soc_util_init(void);
1168void snd_soc_util_exit(void);
1169
Stephen Warrenbec4fa02011-12-12 15:55:34 -07001170int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1171 const char *propname);
Stephen Warrena4a54dd2011-12-12 15:55:35 -07001172int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1173 const char *propname);
Stephen Warrenbec4fa02011-12-12 15:55:34 -07001174
Mark Browna47cbe72008-07-23 14:03:07 +01001175#include <sound/soc-dai.h>
1176
Stephen Warrenfaff4bb2011-01-07 22:36:11 -07001177#ifdef CONFIG_DEBUG_FS
Mark Brown8a9dab12011-01-10 22:25:21 +00001178extern struct dentry *snd_soc_debugfs_root;
Stephen Warrenfaff4bb2011-01-07 22:36:11 -07001179#endif
1180
Mark Brown6f8ab4a2011-01-26 14:59:27 +00001181extern const struct dev_pm_ops snd_soc_pm_ops;
1182
Richard Purdie808db4a2006-10-06 18:20:14 +02001183#endif