soc.h 43.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/*
 * linux/sound/soc.h -- ALSA SoC Layer
 *
 * Author:		Liam Girdwood
 * Created:		Aug 11th 2005
 * Copyright:	Wolfson Microelectronics. PLC.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef __LINUX_SND_SOC_H
#define __LINUX_SND_SOC_H

16
#include <linux/of.h>
17 18
#include <linux/platform_device.h>
#include <linux/types.h>
19
#include <linux/notifier.h>
20
#include <linux/workqueue.h>
21 22
#include <linux/interrupt.h>
#include <linux/kernel.h>
23
#include <linux/regmap.h>
24
#include <linux/log2.h>
25 26
#include <sound/core.h>
#include <sound/pcm.h>
27
#include <sound/compress_driver.h>
28 29 30 31 32 33
#include <sound/control.h>
#include <sound/ac97_codec.h>

/*
 * Convenience kcontrol builders
 */
34
#define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
35
	((unsigned long)&(struct soc_mixer_control) \
36 37
	{.reg = xreg, .rreg = xreg, .shift = shift_left, \
	.rshift = shift_right, .max = xmax, .platform_max = xmax, \
38 39 40
	.invert = xinvert, .autodisable = xautodisable})
#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
	SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
41 42
#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
	((unsigned long)&(struct soc_mixer_control) \
43
	{.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
44 45 46 47
#define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
	((unsigned long)&(struct soc_mixer_control) \
	{.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
	.max = xmax, .platform_max = xmax, .invert = xinvert})
48 49 50 51 52
#define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
	((unsigned long)&(struct soc_mixer_control) \
	{.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
	.max = xmax, .min = xmin, .platform_max = xmax, .sign_bit = xsign_bit, \
	.invert = xinvert})
53 54 55 56
#define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
	((unsigned long)&(struct soc_mixer_control) \
	{.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
	.min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
P
Philipp Zabel 已提交
57
#define SOC_SINGLE(xname, reg, shift, max, invert) \
58 59 60
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
	.put = snd_soc_put_volsw, \
61
	.private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
62 63 64 65 66
#define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
	.put = snd_soc_put_volsw_range, \
	.private_value = (unsigned long)&(struct soc_mixer_control) \
67 68 69
		{.reg = xreg, .rreg = xreg, .shift = xshift, \
		 .rshift = xshift,  .min = xmin, .max = xmax, \
		 .platform_max = xmax, .invert = xinvert} }
P
Philipp Zabel 已提交
70 71 72 73 74 75 76
#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	.tlv.p = (tlv_array), \
	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
	.put = snd_soc_put_volsw, \
77
	.private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
78 79 80 81 82 83 84 85 86 87 88 89
#define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
	SNDRV_CTL_ELEM_ACCESS_READWRITE, \
	.tlv.p  = (tlv_array),\
	.info = snd_soc_info_volsw, \
	.get = snd_soc_get_volsw_sx,\
	.put = snd_soc_put_volsw_sx, \
	.private_value = (unsigned long)&(struct soc_mixer_control) \
		{.reg = xreg, .rreg = xreg, \
		.shift = xshift, .rshift = xshift, \
		.max = xmax, .min = xmin} }
90 91 92 93 94 95 96 97
#define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	.tlv.p = (tlv_array), \
	.info = snd_soc_info_volsw_range, \
	.get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
	.private_value = (unsigned long)&(struct soc_mixer_control) \
98 99 100
		{.reg = xreg, .rreg = xreg, .shift = xshift, \
		 .rshift = xshift, .min = xmin, .max = xmax, \
		 .platform_max = xmax, .invert = xinvert} }
101
#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
102 103 104
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
	.put = snd_soc_put_volsw, \
105
	.private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
106
					  max, invert, 0) }
107
#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
108
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
109
	.info = snd_soc_info_volsw, \
110
	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
111 112
	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
					    xmax, xinvert) }
113 114 115 116 117 118 119
#define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
			   xmax, xinvert)		\
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.info = snd_soc_info_volsw_range, \
	.get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
	.private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
					    xshift, xmin, xmax, xinvert) }
120
#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
P
Philipp Zabel 已提交
121 122 123 124 125 126
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	.tlv.p = (tlv_array), \
	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
	.put = snd_soc_put_volsw, \
127
	.private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
128
					  max, invert, 0) }
129
#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
P
Philipp Zabel 已提交
130 131 132 133
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	.tlv.p = (tlv_array), \
134
	.info = snd_soc_info_volsw, \
135
	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
136 137
	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
					    xmax, xinvert) }
138 139 140 141 142 143 144 145 146 147
#define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
			       xmax, xinvert, tlv_array)		\
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	.tlv.p = (tlv_array), \
	.info = snd_soc_info_volsw_range, \
	.get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
	.private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
					    xshift, xmin, xmax, xinvert) }
148 149 150 151 152 153 154 155 156 157 158 159
#define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
	SNDRV_CTL_ELEM_ACCESS_READWRITE, \
	.tlv.p  = (tlv_array), \
	.info = snd_soc_info_volsw, \
	.get = snd_soc_get_volsw_sx, \
	.put = snd_soc_put_volsw_sx, \
	.private_value = (unsigned long)&(struct soc_mixer_control) \
		{.reg = xreg, .rreg = xrreg, \
		.shift = xshift, .rshift = xshift, \
		.max = xmax, .min = xmin} }
160 161 162 163 164 165 166 167 168
#define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	.tlv.p = (tlv_array), \
	.info = snd_soc_info_volsw, \
	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
	.private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
					    xmin, xmax, xsign_bit, xinvert) }
169
#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
170 171 172 173 174 175
{	.iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
		  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
	.tlv.p  = (tlv_array), \
	.info   = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
	.put    = snd_soc_put_volsw_s8, \
176
	.private_value = (unsigned long)&(struct soc_mixer_control) \
177 178
		{.reg = xreg, .min = xmin, .max = xmax, \
		 .platform_max = xmax} }
179
#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
180
{	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
181 182 183 184 185 186 187
	.items = xitems, .texts = xtexts, \
	.mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
#define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
	SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
#define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
{	.items = xitems, .texts = xtexts }
#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
P
Peter Ujfalusi 已提交
188
{	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
189 190 191
	.mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xnitmes, xtexts, xvalues) \
	SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xnitmes, xtexts, xvalues)
192 193
#define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
	SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
194 195 196 197 198
#define SOC_ENUM(xname, xenum) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
	.info = snd_soc_info_enum_double, \
	.get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
	.private_value = (unsigned long)&xenum }
P
Peter Ujfalusi 已提交
199
#define SOC_VALUE_ENUM(xname, xenum) \
200
	SOC_ENUM(xname, xenum)
201
#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
202 203
	 xhandler_get, xhandler_put) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
G
Graeme Gregory 已提交
204
	.info = snd_soc_info_volsw, \
205
	.get = xhandler_get, .put = xhandler_put, \
206
	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
207
#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
D
Daniel Mack 已提交
208 209 210 211
	 xhandler_get, xhandler_put) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.info = snd_soc_info_volsw, \
	.get = xhandler_get, .put = xhandler_put, \
212
	.private_value = \
213
		SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
214
#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
215 216 217 218 219 220 221
	 xhandler_get, xhandler_put, tlv_array) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	.tlv.p = (tlv_array), \
	.info = snd_soc_info_volsw, \
	.get = xhandler_get, .put = xhandler_put, \
222
	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
223 224 225 226 227 228 229 230
#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
	 xhandler_get, xhandler_put, tlv_array) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
		 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
	.tlv.p = (tlv_array), \
	.info = snd_soc_info_volsw, \
	.get = xhandler_get, .put = xhandler_put, \
231
	.private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
232
					  xmax, xinvert, 0) }
233 234 235 236 237 238
#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
	 xhandler_get, xhandler_put, tlv_array) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
		 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
	.tlv.p = (tlv_array), \
239
	.info = snd_soc_info_volsw, \
240
	.get = xhandler_get, .put = xhandler_put, \
241 242
	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
					    xmax, xinvert) }
243 244 245 246 247 248 249
#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.info = snd_soc_info_bool_ext, \
	.get = xhandler_get, .put = xhandler_put, \
	.private_value = xdata }
#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
250
	.info = snd_soc_info_enum_double, \
251 252 253
	.get = xhandler_get, .put = xhandler_put, \
	.private_value = (unsigned long)&xenum }

254 255 256 257 258 259
#define SND_SOC_BYTES(xname, xbase, xregs)		      \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
	.put = snd_soc_bytes_put, .private_value =	      \
		((unsigned long)&(struct soc_bytes)           \
		{.base = xbase, .num_regs = xregs }) }
260

261 262 263 264 265 266 267 268
#define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)	      \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
	.put = snd_soc_bytes_put, .private_value =	      \
		((unsigned long)&(struct soc_bytes)           \
		{.base = xbase, .num_regs = xregs,	      \
		 .mask = xmask }) }

269 270 271 272 273 274 275 276 277
#define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
		xmin, xmax, xinvert) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
	.info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
	.put = snd_soc_put_xr_sx, \
	.private_value = (unsigned long)&(struct soc_mreg_control) \
		{.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
		.invert = xinvert, .min = xmin, .max = xmax} }

278 279 280 281
#define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
	SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
		snd_soc_get_strobe, snd_soc_put_strobe)

282 283 284 285 286
/*
 * Simplified versions of above macros, declaring a struct and calculating
 * ARRAY_SIZE internally
 */
#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
287
	const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
288 289 290 291
						ARRAY_SIZE(xtexts), xtexts)
#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
	SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
292
	const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
293
#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
294
	const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
295 296 297
							ARRAY_SIZE(xtexts), xtexts, xvalues)
#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
	SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
298 299
#define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
	const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
300

301 302 303 304 305 306 307 308 309 310
/*
 * Component probe and remove ordering levels for components with runtime
 * dependencies.
 */
#define SND_SOC_COMP_ORDER_FIRST		-2
#define SND_SOC_COMP_ORDER_EARLY		-1
#define SND_SOC_COMP_ORDER_NORMAL		0
#define SND_SOC_COMP_ORDER_LATE		1
#define SND_SOC_COMP_ORDER_LAST		2

311 312 313 314 315 316 317 318 319 320 321 322
/*
 * Bias levels
 *
 * @ON:      Bias is fully on for audio playback and capture operations.
 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 *           stream start and stop operations.
 * @STANDBY: Low power standby state when no playback/capture operations are
 *           in progress. NOTE: The transition time between STANDBY and ON
 *           should be as fast as possible and no longer than 10ms.
 * @OFF:     Power Off. No restrictions on transition times.
 */
enum snd_soc_bias_level {
323 324 325 326
	SND_SOC_BIAS_OFF = 0,
	SND_SOC_BIAS_STANDBY = 1,
	SND_SOC_BIAS_PREPARE = 2,
	SND_SOC_BIAS_ON = 3,
327 328
};

329
struct device_node;
M
Mark Brown 已提交
330 331
struct snd_jack;
struct snd_soc_card;
332 333 334
struct snd_soc_pcm_stream;
struct snd_soc_ops;
struct snd_soc_pcm_runtime;
335
struct snd_soc_dai;
336
struct snd_soc_dai_driver;
M
Mark Brown 已提交
337
struct snd_soc_platform;
338
struct snd_soc_dai_link;
339
struct snd_soc_platform_driver;
340
struct snd_soc_codec;
341
struct snd_soc_codec_driver;
342 343
struct snd_soc_component;
struct snd_soc_component_driver;
344
struct soc_enum;
M
Mark Brown 已提交
345
struct snd_soc_jack;
346
struct snd_soc_jack_zone;
M
Mark Brown 已提交
347
struct snd_soc_jack_pin;
L
Liam Girdwood 已提交
348
#include <sound/soc-dapm.h>
349
#include <sound/soc-dpcm.h>
350

351
struct snd_soc_jack_gpio;
352 353 354

typedef int (*hw_write_t)(void *,const char* ,int);

355
extern struct snd_ac97_bus_ops *soc_ac97_ops;
356

L
Liam Girdwood 已提交
357 358 359 360 361
enum snd_soc_pcm_subclass {
	SND_SOC_PCM_CLASS_PCM	= 0,
	SND_SOC_PCM_CLASS_BE	= 1,
};

362
enum snd_soc_card_subclass {
363 364
	SND_SOC_CARD_CLASS_INIT		= 0,
	SND_SOC_CARD_CLASS_RUNTIME	= 1,
365 366
};

367
int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
368
			     int source, unsigned int freq, int dir);
369 370 371
int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
			  unsigned int freq_in, unsigned int freq_out);

372 373
int snd_soc_register_card(struct snd_soc_card *card);
int snd_soc_unregister_card(struct snd_soc_card *card);
374
int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
375 376 377
int snd_soc_suspend(struct device *dev);
int snd_soc_resume(struct device *dev);
int snd_soc_poweroff(struct device *dev);
378
int snd_soc_register_platform(struct device *dev,
379
		const struct snd_soc_platform_driver *platform_drv);
380
void snd_soc_unregister_platform(struct device *dev);
381 382 383 384
int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
		const struct snd_soc_platform_driver *platform_drv);
void snd_soc_remove_platform(struct snd_soc_platform *platform);
struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev);
385
int snd_soc_register_codec(struct device *dev,
386
		const struct snd_soc_codec_driver *codec_drv,
387 388
		struct snd_soc_dai_driver *dai_drv, int num_dai);
void snd_soc_unregister_codec(struct device *dev);
389 390 391
int snd_soc_register_component(struct device *dev,
			 const struct snd_soc_component_driver *cmpnt_drv,
			 struct snd_soc_dai_driver *dai_drv, int num_dai);
392 393 394
int devm_snd_soc_register_component(struct device *dev,
			 const struct snd_soc_component_driver *cmpnt_drv,
			 struct snd_soc_dai_driver *dai_drv, int num_dai);
395
void snd_soc_unregister_component(struct device *dev);
396 397
int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
				    unsigned int reg);
398 399 400 401
int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
				    unsigned int reg);
int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
				    unsigned int reg);
402
int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
403
			       struct regmap *regmap);
404 405 406 407 408 409 410
int snd_soc_cache_sync(struct snd_soc_codec *codec);
int snd_soc_cache_init(struct snd_soc_codec *codec);
int snd_soc_cache_exit(struct snd_soc_codec *codec);
int snd_soc_cache_write(struct snd_soc_codec *codec,
			unsigned int reg, unsigned int value);
int snd_soc_cache_read(struct snd_soc_codec *codec,
		       unsigned int reg, unsigned int *value);
411 412 413 414
int snd_soc_platform_read(struct snd_soc_platform *platform,
					unsigned int reg);
int snd_soc_platform_write(struct snd_soc_platform *platform,
					unsigned int reg, unsigned int val);
M
Mark Brown 已提交
415
int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
416
int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
M
Mark Brown 已提交
417

418 419 420 421 422
struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
		const char *dai_link, int stream);
struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
		const char *dai_link);

423
bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
424 425
void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
426

427 428 429
/* Utility functions to get clock rates from various things */
int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
430
int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
431 432
int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);

433 434 435 436
/* set runtime hw params */
int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
	const struct snd_pcm_hardware *hw);

437 438 439
int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
		int cmd, struct snd_soc_platform *platform);

M
Mark Brown 已提交
440
/* Jack reporting */
441
int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
M
Mark Brown 已提交
442 443 444 445
		     struct snd_soc_jack *jack);
void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
			  struct snd_soc_jack_pin *pins);
446 447 448 449
void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
				    struct notifier_block *nb);
void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
				      struct notifier_block *nb);
450 451 452
int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
			  struct snd_soc_jack_zone *zones);
int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
453 454 455
#ifdef CONFIG_GPIOLIB
int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
			struct snd_soc_jack_gpio *gpios);
456 457 458
int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
			    struct snd_soc_jack *jack,
			    int count, struct snd_soc_jack_gpio *gpios);
459 460
void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
			struct snd_soc_jack_gpio *gpios);
461 462 463 464 465 466 467
#else
static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
					 struct snd_soc_jack_gpio *gpios)
{
	return 0;
}

468 469 470 471 472 473 474
int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
			    struct snd_soc_jack *jack,
			    int count, struct snd_soc_jack_gpio *gpios)
{
	return 0;
}

475 476 477 478
static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
					   struct snd_soc_jack_gpio *gpios)
{
}
479
#endif
M
Mark Brown 已提交
480

481 482
/* codec register bit access */
int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
483
				unsigned int mask, unsigned int value);
484 485 486
int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
			       unsigned short reg, unsigned int mask,
			       unsigned int value);
487
int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
488
				unsigned int mask, unsigned int value);
489 490 491 492 493

int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
	struct snd_ac97_bus_ops *ops, int num);
void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);

494
int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
495 496
int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
		struct platform_device *pdev);
497

498 499 500 501
/*
 *Controls
 */
struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
502
				  void *data, const char *long_name,
503
				  const char *prefix);
504 505
struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
					       const char *name);
506
int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
I
Ian Molton 已提交
507
	const struct snd_kcontrol_new *controls, int num_controls);
508 509
int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
	const struct snd_kcontrol_new *controls, int num_controls);
510 511 512 513
int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
	const struct snd_kcontrol_new *controls, int num_controls);
int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
	const struct snd_kcontrol_new *controls, int num_controls);
514 515 516 517 518 519 520 521
int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
522
#define snd_soc_info_bool_ext		snd_ctl_boolean_mono_info
523 524 525 526
int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
527 528
#define snd_soc_get_volsw_2r snd_soc_get_volsw
#define snd_soc_put_volsw_2r snd_soc_put_volsw
529 530 531 532
int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
533 534 535 536 537 538
int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
539 540 541 542 543 544
int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
545 546
int snd_soc_limit_volume(struct snd_soc_codec *codec,
	const char *name, int max);
547 548 549 550 551 552
int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
		       struct snd_ctl_elem_info *uinfo);
int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
		      struct snd_ctl_elem_value *ucontrol);
int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
		      struct snd_ctl_elem_value *ucontrol);
553 554 555 556 557 558
int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
559 560 561 562
int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
563

M
Mark Brown 已提交
564 565 566 567 568 569 570 571 572 573 574 575 576 577
/**
 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 *
 * @pin:    name of the pin to update
 * @mask:   bits to check for in reported jack status
 * @invert: if non-zero then pin is enabled when status is not reported
 */
struct snd_soc_jack_pin {
	struct list_head list;
	const char *pin;
	int mask;
	bool invert;
};

578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
/**
 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 *
 * @min_mv: start voltage in mv
 * @max_mv: end voltage in mv
 * @jack_type: type of jack that is expected for this voltage
 * @debounce_time: debounce_time for jack, codec driver should wait for this
 *		duration before reading the adc for voltages
 * @:list: list container
 */
struct snd_soc_jack_zone {
	unsigned int min_mv;
	unsigned int max_mv;
	unsigned int jack_type;
	unsigned int debounce_time;
	struct list_head list;
};

596 597 598
/**
 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 *
599
 * @gpio:         legacy gpio number
600 601
 * @idx:          gpio descriptor index within the function of the GPIO
 *                consumer device
602
 * @gpiod_dev     GPIO consumer device
603 604
 * @name:         gpio name. Also as connection ID for the GPIO consumer
 *                device function name lookup
605 606 607
 * @report:       value to report when jack detected
 * @invert:       report presence in low state
 * @debouce_time: debouce time in ms
608
 * @wake:	  enable as wake source
609 610 611
 * @jack_status_check: callback function which overrides the detection
 *		       to provide more complex checks (eg, reading an
 *		       ADC).
612 613 614
 */
struct snd_soc_jack_gpio {
	unsigned int gpio;
615 616
	unsigned int idx;
	struct device *gpiod_dev;
617 618 619 620
	const char *name;
	int report;
	int invert;
	int debounce_time;
621 622
	bool wake;

623
	struct snd_soc_jack *jack;
624
	struct delayed_work work;
625
	struct gpio_desc *desc;
626

627 628
	void *data;
	int (*jack_status_check)(void *data);
629 630
};

M
Mark Brown 已提交
631
struct snd_soc_jack {
632
	struct mutex mutex;
M
Mark Brown 已提交
633
	struct snd_jack *jack;
634
	struct snd_soc_codec *codec;
M
Mark Brown 已提交
635 636
	struct list_head pins;
	int status;
637
	struct blocking_notifier_head notifier;
638
	struct list_head jack_zones;
M
Mark Brown 已提交
639 640
};

641 642
/* SoC PCM stream information */
struct snd_soc_pcm_stream {
643
	const char *stream_name;
G
Graeme Gregory 已提交
644 645
	u64 formats;			/* SNDRV_PCM_FMTBIT_* */
	unsigned int rates;		/* SNDRV_PCM_RATE_* */
646 647 648 649
	unsigned int rate_min;		/* min rate */
	unsigned int rate_max;		/* max rate */
	unsigned int channels_min;	/* min channels */
	unsigned int channels_max;	/* max channels */
650
	unsigned int sig_bits;		/* number of bits of content */
651 652 653 654 655 656 657 658 659 660 661 662
};

/* SoC audio ops */
struct snd_soc_ops {
	int (*startup)(struct snd_pcm_substream *);
	void (*shutdown)(struct snd_pcm_substream *);
	int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
	int (*hw_free)(struct snd_pcm_substream *);
	int (*prepare)(struct snd_pcm_substream *);
	int (*trigger)(struct snd_pcm_substream *, int);
};

663 664 665 666 667 668 669
struct snd_soc_compr_ops {
	int (*startup)(struct snd_compr_stream *);
	void (*shutdown)(struct snd_compr_stream *);
	int (*set_params)(struct snd_compr_stream *);
	int (*trigger)(struct snd_compr_stream *);
};

670 671 672
/* component interface */
struct snd_soc_component_driver {
	const char *name;
673 674 675 676 677

	/* DT */
	int (*of_xlate_dai_name)(struct snd_soc_component *component,
				 struct of_phandle_args *args,
				 const char **dai_name);
678 679 680 681 682 683
};

struct snd_soc_component {
	const char *name;
	int id;
	struct device *dev;
684 685 686

	unsigned int active;

687 688
	unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */

689 690
	struct list_head list;

691 692 693
	struct snd_soc_dai_driver *dai_drv;
	int num_dai;

694
	const struct snd_soc_component_driver *driver;
695 696

	struct list_head dai_list;
697 698
};

699
/* SoC Audio Codec device */
700
struct snd_soc_codec {
701
	const char *name;
702
	const char *name_prefix;
703
	int id;
M
Mark Brown 已提交
704
	struct device *dev;
705
	const struct snd_soc_codec_driver *driver;
M
Mark Brown 已提交
706

707 708
	struct mutex mutex;
	struct snd_soc_card *card;
M
Mark Brown 已提交
709
	struct list_head list;
710 711
	struct list_head card_list;
	int num_dai;
712 713
	int (*volatile_register)(struct snd_soc_codec *, unsigned int);
	int (*readable_register)(struct snd_soc_codec *, unsigned int);
714
	int (*writable_register)(struct snd_soc_codec *, unsigned int);
715 716 717

	/* runtime */
	struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
718
	unsigned int cache_bypass:1; /* Suppress access to the cache */
719 720 721
	unsigned int suspended:1; /* Codec is in suspend PM state */
	unsigned int probed:1; /* Codec has been probed */
	unsigned int ac97_registered:1; /* Codec has been AC97 registered */
722
	unsigned int ac97_created:1; /* Codec has been created by SoC */
723
	unsigned int cache_init:1; /* codec cache has been initialized */
724
	unsigned int using_regmap:1; /* using regmap access */
725 726
	u32 cache_only;  /* Suppress writes to hardware */
	u32 cache_sync; /* Cache needs to be synced to hardware */
727 728 729 730

	/* codec IO */
	void *control_data; /* codec control (i2c/3wire) data */
	hw_write_t hw_write;
731 732
	unsigned int (*read)(struct snd_soc_codec *, unsigned int);
	int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
733
	void *reg_cache;
734
	struct mutex cache_rw_mutex;
735
	int val_bytes;
736

737 738 739
	/* component */
	struct snd_soc_component component;

740
	/* dapm */
L
Liam Girdwood 已提交
741
	struct snd_soc_dapm_context dapm;
742

743
#ifdef CONFIG_DEBUG_FS
744
	struct dentry *debugfs_codec_root;
745 746
	struct dentry *debugfs_reg;
#endif
747 748
};

749 750 751 752 753 754
/* codec driver */
struct snd_soc_codec_driver {

	/* driver ops */
	int (*probe)(struct snd_soc_codec *);
	int (*remove)(struct snd_soc_codec *);
755
	int (*suspend)(struct snd_soc_codec *);
756
	int (*resume)(struct snd_soc_codec *);
757
	struct snd_soc_component_driver component_driver;
758

759 760 761
	/* Default control and setup, added after probe() is run */
	const struct snd_kcontrol_new *controls;
	int num_controls;
762 763 764 765 766
	const struct snd_soc_dapm_widget *dapm_widgets;
	int num_dapm_widgets;
	const struct snd_soc_dapm_route *dapm_routes;
	int num_dapm_routes;

767 768
	/* codec wide operations */
	int (*set_sysclk)(struct snd_soc_codec *codec,
769
			  int clk_id, int source, unsigned int freq, int dir);
770 771 772
	int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
		unsigned int freq_in, unsigned int freq_out);

773 774 775 776 777
	/* codec IO */
	unsigned int (*read)(struct snd_soc_codec *, unsigned int);
	int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
	int (*display_register)(struct snd_soc_codec *, char *,
				size_t, unsigned int);
778 779
	int (*volatile_register)(struct snd_soc_codec *, unsigned int);
	int (*readable_register)(struct snd_soc_codec *, unsigned int);
780
	int (*writable_register)(struct snd_soc_codec *, unsigned int);
781
	unsigned int reg_cache_size;
782 783 784 785 786 787 788
	short reg_cache_step;
	short reg_word_size;
	const void *reg_cache_default;

	/* codec bias level */
	int (*set_bias_level)(struct snd_soc_codec *,
			      enum snd_soc_bias_level level);
789
	bool idle_bias_off;
790 791

	void (*seq_notifier)(struct snd_soc_dapm_context *,
792
			     enum snd_soc_dapm_type, int);
793

794 795 796
	/* codec stream completion event */
	int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);

797 798
	bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */

799 800 801
	/* probe ordering - for components with runtime dependencies */
	int probe_order;
	int remove_order;
802 803 804
};

/* SoC platform interface */
805
struct snd_soc_platform_driver {
806

807 808 809 810
	int (*probe)(struct snd_soc_platform *);
	int (*remove)(struct snd_soc_platform *);
	int (*suspend)(struct snd_soc_dai *dai);
	int (*resume)(struct snd_soc_dai *dai);
811 812

	/* pcm creation and destruction */
813
	int (*pcm_new)(struct snd_soc_pcm_runtime *);
814 815
	void (*pcm_free)(struct snd_pcm *);

816 817 818 819 820 821 822 823
	/* Default control and setup, added after probe() is run */
	const struct snd_kcontrol_new *controls;
	int num_controls;
	const struct snd_soc_dapm_widget *dapm_widgets;
	int num_dapm_widgets;
	const struct snd_soc_dapm_route *dapm_routes;
	int num_dapm_routes;

824 825 826 827 828 829 830
	/*
	 * For platform caused delay reporting.
	 * Optional.
	 */
	snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
		struct snd_soc_dai *);

831
	/* platform stream pcm ops */
832
	const struct snd_pcm_ops *ops;
833

834
	/* platform stream compress ops */
835
	const struct snd_compr_ops *compr_ops;
836

837 838 839
	/* platform stream completion event */
	int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);

840 841 842
	/* probe ordering - for components with runtime dependencies */
	int probe_order;
	int remove_order;
843 844 845 846

	/* platform IO - used for platform DAPM */
	unsigned int (*read)(struct snd_soc_platform *, unsigned int);
	int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
847
	int (*bespoke_trigger)(struct snd_pcm_substream *, int);
848 849
};

850 851 852 853
struct snd_soc_platform {
	const char *name;
	int id;
	struct device *dev;
854
	const struct snd_soc_platform_driver *driver;
855
	struct mutex mutex;
856

857 858
	unsigned int suspended:1; /* platform is suspended */
	unsigned int probed:1;
G
Graeme Gregory 已提交
859

860 861 862
	struct snd_soc_card *card;
	struct list_head list;
	struct list_head card_list;
863 864

	struct snd_soc_dapm_context dapm;
865 866 867 868

#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs_platform_root;
#endif
869
};
870

871 872 873 874
struct snd_soc_dai_link {
	/* config - must be set by machine driver */
	const char *name;			/* Codec name */
	const char *stream_name;		/* Stream name */
875 876 877 878 879 880 881 882 883 884 885 886 887 888
	/*
	 * You MAY specify the link's CPU-side device, either by device name,
	 * or by DT/OF node, but not both. If this information is omitted,
	 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
	 * must be globally unique. These fields are currently typically used
	 * only for codec to codec links, or systems using device tree.
	 */
	const char *cpu_name;
	const struct device_node *cpu_of_node;
	/*
	 * You MAY specify the DAI name of the CPU DAI. If this information is
	 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
	 * only, which only works well when that device exposes a single DAI.
	 */
889
	const char *cpu_dai_name;
890 891 892 893 894 895 896
	/*
	 * You MUST specify the link's codec, either by device name, or by
	 * DT/OF node, but not both.
	 */
	const char *codec_name;
	const struct device_node *codec_of_node;
	/* You MUST specify the DAI name within the codec */
897
	const char *codec_dai_name;
898 899 900 901 902 903 904
	/*
	 * You MAY specify the link's platform/PCM/DMA driver, either by
	 * device name, or by DT/OF node, but not both. Some forms of link
	 * do not need a platform.
	 */
	const char *platform_name;
	const struct device_node *platform_of_node;
905
	int be_id;	/* optional ID for machine driver BE identification */
906

907 908
	const struct snd_soc_pcm_stream *params;

909 910
	unsigned int dai_fmt;           /* format to set on init */

911 912
	enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */

913 914 915
	/* Keep DAI active over suspend */
	unsigned int ignore_suspend:1;

916 917
	/* Symmetry requirements */
	unsigned int symmetric_rates:1;
918 919
	unsigned int symmetric_channels:1;
	unsigned int symmetric_samplebits:1;
920

921 922 923 924 925 926
	/* Do not create a PCM for this DAI link (Backend link) */
	unsigned int no_pcm:1;

	/* This DAI link can route to other DAI links at runtime (Frontend)*/
	unsigned int dynamic:1;

927 928 929 930
	/* DPCM capture and Playback support */
	unsigned int dpcm_capture:1;
	unsigned int dpcm_playback:1;

931 932 933
	/* pmdown_time is ignored at stop */
	unsigned int ignore_pmdown_time:1;

934 935
	/* codec/machine specific init - e.g. add machine controls */
	int (*init)(struct snd_soc_pcm_runtime *rtd);
936

937 938 939 940
	/* optional hw_params re-writing for BE and FE sync */
	int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
			struct snd_pcm_hw_params *params);

941
	/* machine stream operations */
942 943
	const struct snd_soc_ops *ops;
	const struct snd_soc_compr_ops *compr_ops;
944 945 946 947

	/* For unidirectional dai links */
	bool playback_only;
	bool capture_only;
948 949
};

950
struct snd_soc_codec_conf {
951
	const char *dev_name;
952 953 954 955 956

	/*
	 * optional map of kcontrol, widget and path name prefixes that are
	 * associated per device
	 */
957 958 959
	const char *name_prefix;
};

960 961 962 963 964 965 966 967
struct snd_soc_aux_dev {
	const char *name;		/* Codec name */
	const char *codec_name;		/* for multi-codec */

	/* codec/machine specific init - e.g. add machine controls */
	int (*init)(struct snd_soc_dapm_context *dapm);
};

968 969
/* SoC card */
struct snd_soc_card {
970
	const char *name;
971 972
	const char *long_name;
	const char *driver_name;
M
Mark Brown 已提交
973
	struct device *dev;
974 975
	struct snd_card *snd_card;
	struct module *owner;
M
Mark Brown 已提交
976 977

	struct list_head list;
978
	struct mutex mutex;
979
	struct mutex dapm_mutex;
M
Mark Brown 已提交
980

981
	bool instantiated;
982

983
	int (*probe)(struct snd_soc_card *card);
984
	int (*late_probe)(struct snd_soc_card *card);
985
	int (*remove)(struct snd_soc_card *card);
986 987 988

	/* the pre and post PM functions are used to do any PM work before and
	 * after the codec and DAI's do any PM work. */
989 990 991 992
	int (*suspend_pre)(struct snd_soc_card *card);
	int (*suspend_post)(struct snd_soc_card *card);
	int (*resume_pre)(struct snd_soc_card *card);
	int (*resume_post)(struct snd_soc_card *card);
993

994
	/* callbacks */
995
	int (*set_bias_level)(struct snd_soc_card *,
996
			      struct snd_soc_dapm_context *dapm,
997
			      enum snd_soc_bias_level level);
998
	int (*set_bias_level_post)(struct snd_soc_card *,
999
				   struct snd_soc_dapm_context *dapm,
1000
				   enum snd_soc_bias_level level);
1001

M
Mark Brown 已提交
1002
	long pmdown_time;
1003

1004 1005 1006
	/* CPU <--> Codec DAI links  */
	struct snd_soc_dai_link *dai_link;
	int num_links;
1007 1008
	struct snd_soc_pcm_runtime *rtd;
	int num_rtd;
1009

1010 1011 1012
	/* optional codec specific configuration */
	struct snd_soc_codec_conf *codec_conf;
	int num_configs;
1013

1014 1015 1016 1017 1018 1019 1020 1021 1022
	/*
	 * optional auxiliary devices such as amplifiers or codecs with DAI
	 * link unused
	 */
	struct snd_soc_aux_dev *aux_dev;
	int num_aux_devs;
	struct snd_soc_pcm_runtime *rtd_aux;
	int num_aux_rtd;

1023 1024 1025
	const struct snd_kcontrol_new *controls;
	int num_controls;

1026 1027 1028
	/*
	 * Card-specific routes and widgets.
	 */
1029
	const struct snd_soc_dapm_widget *dapm_widgets;
1030
	int num_dapm_widgets;
1031
	const struct snd_soc_dapm_route *dapm_routes;
1032
	int num_dapm_routes;
1033
	bool fully_routed;
1034

1035
	struct work_struct deferred_resume_work;
1036 1037 1038 1039 1040

	/* lists of probed devices belonging to this card */
	struct list_head codec_dev_list;
	struct list_head platform_dev_list;
	struct list_head dai_dev_list;
1041

1042
	struct list_head widgets;
1043
	struct list_head paths;
1044
	struct list_head dapm_list;
1045
	struct list_head dapm_dirty;
1046

M
Mark Brown 已提交
1047 1048
	/* Generic DAPM context for the card */
	struct snd_soc_dapm_context dapm;
1049
	struct snd_soc_dapm_stats dapm_stats;
1050
	struct snd_soc_dapm_update *update;
M
Mark Brown 已提交
1051

1052 1053
#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs_card_root;
1054
	struct dentry *debugfs_pop_time;
1055
#endif
1056
	u32 pop_time;
M
Mark Brown 已提交
1057 1058

	void *drvdata;
1059 1060
};

1061
/* SoC machine DAI configuration, glues a codec and cpu DAI together */
1062
struct snd_soc_pcm_runtime {
1063
	struct device *dev;
1064
	struct snd_soc_card *card;
1065
	struct snd_soc_dai_link *dai_link;
L
Liam Girdwood 已提交
1066 1067 1068
	struct mutex pcm_mutex;
	enum snd_soc_pcm_subclass pcm_subclass;
	struct snd_pcm_ops ops;
1069 1070

	unsigned int dev_registered:1;
1071

1072 1073
	/* Dynamic PCM BE runtime data */
	struct snd_soc_dpcm_runtime dpcm[2];
1074
	int fe_compr;
1075

1076
	long pmdown_time;
1077
	unsigned char pop_wait:1;
1078 1079 1080

	/* runtime devices */
	struct snd_pcm *pcm;
1081
	struct snd_compr *compr;
1082 1083 1084 1085 1086 1087
	struct snd_soc_codec *codec;
	struct snd_soc_platform *platform;
	struct snd_soc_dai *codec_dai;
	struct snd_soc_dai *cpu_dai;

	struct delayed_work delayed_work;
1088 1089 1090 1091
#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs_dpcm_root;
	struct dentry *debugfs_dpcm_state;
#endif
1092 1093
};

1094 1095
/* mixer control */
struct soc_mixer_control {
1096
	int min, max, platform_max;
1097 1098
	int reg, rreg;
	unsigned int shift, rshift;
1099
	unsigned int sign_bit;
1100 1101
	unsigned int invert:1;
	unsigned int autodisable:1;
1102 1103
};

1104 1105 1106
struct soc_bytes {
	int base;
	int num_regs;
1107
	u32 mask;
1108 1109
};

1110 1111 1112 1113 1114 1115
/* multi register control */
struct soc_mreg_control {
	long min, max;
	unsigned int regbase, regcount, nbits, invert;
};

1116 1117
/* enumerated kcontrol */
struct soc_enum {
1118
	int reg;
P
Peter Ujfalusi 已提交
1119 1120
	unsigned char shift_l;
	unsigned char shift_r;
1121
	unsigned int items;
P
Peter Ujfalusi 已提交
1122
	unsigned int mask;
1123
	const char * const *texts;
P
Peter Ujfalusi 已提交
1124 1125 1126
	const unsigned int *values;
};

1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
/**
 * snd_soc_component_to_codec() - Casts a component to the CODEC it is embedded in
 * @component: The component to cast to a CODEC
 *
 * This function must only be used on components that are known to be CODECs.
 * Otherwise the behavior is undefined.
 */
static inline struct snd_soc_codec *snd_soc_component_to_codec(
	struct snd_soc_component *component)
{
	return container_of(component, struct snd_soc_codec, component);
}

1140
/* codec IO */
1141 1142 1143
unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
unsigned int snd_soc_write(struct snd_soc_codec *codec,
			   unsigned int reg, unsigned int val);
1144

1145 1146
/* device driver data */

M
Mark Brown 已提交
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
		void *data)
{
	card->drvdata = data;
}

static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
{
	return card->drvdata;
}

1158
static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1159
		void *data)
1160
{
1161
	dev_set_drvdata(codec->dev, data);
1162 1163 1164 1165
}

static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
{
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
	return dev_get_drvdata(codec->dev);
}

static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
		void *data)
{
	dev_set_drvdata(platform->dev, data);
}

static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
{
	return dev_get_drvdata(platform->dev);
}

static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
		void *data)
{
1183
	dev_set_drvdata(rtd->dev, data);
1184 1185 1186 1187
}

static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
{
1188
	return dev_get_drvdata(rtd->dev);
1189 1190
}

1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
{
	INIT_LIST_HEAD(&card->dai_dev_list);
	INIT_LIST_HEAD(&card->codec_dev_list);
	INIT_LIST_HEAD(&card->platform_dev_list);
	INIT_LIST_HEAD(&card->widgets);
	INIT_LIST_HEAD(&card->paths);
	INIT_LIST_HEAD(&card->dapm_list);
}

1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
{
	if (mc->reg == mc->rreg && mc->shift == mc->rshift)
		return 0;
	/*
	 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
	 * mc->reg != mc->rreg means that the control is
	 * stereo (bits in one register or in two registers)
	 */
	return 1;
}

1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
	unsigned int val)
{
	unsigned int i;

	if (!e->values)
		return val;

	for (i = 0; i < e->items; i++)
		if (val == e->values[i])
			return i;

	return 0;
}

static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
	unsigned int item)
{
	if (!e->values)
		return item;

	return e->values[item];
}

1237 1238 1239 1240 1241 1242
static inline bool snd_soc_component_is_active(
	struct snd_soc_component *component)
{
	return component->active != 0;
}

1243 1244
static inline bool snd_soc_codec_is_active(struct snd_soc_codec *codec)
{
1245
	return snd_soc_component_is_active(&codec->component);
1246 1247
}

1248 1249 1250
int snd_soc_util_init(void);
void snd_soc_util_exit(void);

1251 1252
int snd_soc_of_parse_card_name(struct snd_soc_card *card,
			       const char *propname);
1253 1254
int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
					  const char *propname);
1255 1256 1257
int snd_soc_of_parse_tdm_slot(struct device_node *np,
			      unsigned int *slots,
			      unsigned int *slot_width);
1258 1259
int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
				   const char *propname);
1260 1261
unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
				     const char *prefix);
1262 1263
int snd_soc_of_get_dai_name(struct device_node *of_node,
			    const char **dai_name);
1264

1265 1266
#include <sound/soc-dai.h>

1267
#ifdef CONFIG_DEBUG_FS
1268
extern struct dentry *snd_soc_debugfs_root;
1269 1270
#endif

1271 1272
extern const struct dev_pm_ops snd_soc_pm_ops;

1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
/* Helper functions */
static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
{
	mutex_lock(&dapm->card->dapm_mutex);
}

static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
{
	mutex_unlock(&dapm->card->dapm_mutex);
}

1284
#endif