soc.h 40.5 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
#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 已提交
52
#define SOC_SINGLE(xname, reg, shift, max, invert) \
53 54 55
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
	.put = snd_soc_put_volsw, \
56
	.private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
57 58 59 60 61
#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) \
62 63 64
		{.reg = xreg, .rreg = xreg, .shift = xshift, \
		 .rshift = xshift,  .min = xmin, .max = xmax, \
		 .platform_max = xmax, .invert = xinvert} }
P
Philipp Zabel 已提交
65 66 67 68 69 70 71
#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, \
72
	.private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
73 74 75 76 77 78 79 80 81 82 83 84
#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} }
85 86 87 88 89 90 91 92
#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) \
93 94 95
		{.reg = xreg, .rreg = xreg, .shift = xshift, \
		 .rshift = xshift, .min = xmin, .max = xmax, \
		 .platform_max = xmax, .invert = xinvert} }
96
#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
97 98 99
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
	.put = snd_soc_put_volsw, \
100
	.private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
101
					  max, invert, 0) }
102
#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
103
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
104
	.info = snd_soc_info_volsw, \
105
	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
106 107
	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
					    xmax, xinvert) }
108 109 110 111 112 113 114
#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) }
115
#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
P
Philipp Zabel 已提交
116 117 118 119 120 121
{	.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, \
122
	.private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
123
					  max, invert, 0) }
124
#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
P
Philipp Zabel 已提交
125 126 127 128
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
	.tlv.p = (tlv_array), \
129
	.info = snd_soc_info_volsw, \
130
	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
131 132
	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
					    xmax, xinvert) }
133 134 135 136 137 138 139 140 141 142
#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) }
143 144 145 146 147 148 149 150 151 152 153 154
#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} }
155
#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
156 157 158 159 160 161
{	.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, \
162
	.private_value = (unsigned long)&(struct soc_mixer_control) \
163 164
		{.reg = xreg, .min = xmin, .max = xmax, \
		 .platform_max = xmax} }
165
#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
166
{	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
167 168
	.max = xmax, .texts = xtexts, \
	.mask = xmax ? roundup_pow_of_two(xmax) - 1 : 0}
169 170 171 172
#define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
	SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
#define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
{	.max = xmax, .texts = xtexts }
P
Peter Ujfalusi 已提交
173 174 175 176 177
#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
{	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
	.mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
	SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
178 179 180 181 182
#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 已提交
183 184
#define SOC_VALUE_ENUM(xname, xenum) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
185
	.info = snd_soc_info_enum_double, \
P
Peter Ujfalusi 已提交
186 187 188
	.get = snd_soc_get_value_enum_double, \
	.put = snd_soc_put_value_enum_double, \
	.private_value = (unsigned long)&xenum }
189
#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
190 191
	 xhandler_get, xhandler_put) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
G
Graeme Gregory 已提交
192
	.info = snd_soc_info_volsw, \
193
	.get = xhandler_get, .put = xhandler_put, \
194
	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
195
#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
D
Daniel Mack 已提交
196 197 198 199
	 xhandler_get, xhandler_put) \
{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
	.info = snd_soc_info_volsw, \
	.get = xhandler_get, .put = xhandler_put, \
200
	.private_value = \
201
		SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
202
#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
203 204 205 206 207 208 209
	 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, \
210
	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
211 212 213 214 215 216 217 218
#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, \
219
	.private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
220
					  xmax, xinvert, 0) }
221 222 223 224 225 226
#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), \
227
	.info = snd_soc_info_volsw, \
228
	.get = xhandler_get, .put = xhandler_put, \
229 230
	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
					    xmax, xinvert) }
231 232 233 234 235 236 237
#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, \
238
	.info = snd_soc_info_enum_double, \
239 240 241
	.get = xhandler_get, .put = xhandler_put, \
	.private_value = (unsigned long)&xenum }

242 243 244 245 246 247
#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 }) }
248

249 250 251 252 253 254 255 256
#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 }) }

257 258 259 260 261 262 263 264 265
#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} }

266 267 268 269
#define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
	SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
		snd_soc_get_strobe, snd_soc_put_strobe)

270 271 272 273 274 275 276 277 278 279 280 281 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) \
	struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
						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) \
	struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
	struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
							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)

287 288 289 290 291 292 293 294 295 296
/*
 * 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

297 298 299 300 301 302 303 304 305 306 307 308
/*
 * 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 {
309 310 311 312
	SND_SOC_BIAS_OFF = 0,
	SND_SOC_BIAS_STANDBY = 1,
	SND_SOC_BIAS_PREPARE = 2,
	SND_SOC_BIAS_ON = 3,
313 314
};

315
struct device_node;
M
Mark Brown 已提交
316 317
struct snd_jack;
struct snd_soc_card;
318 319 320
struct snd_soc_pcm_stream;
struct snd_soc_ops;
struct snd_soc_pcm_runtime;
321
struct snd_soc_dai;
322
struct snd_soc_dai_driver;
M
Mark Brown 已提交
323
struct snd_soc_platform;
324
struct snd_soc_dai_link;
325
struct snd_soc_platform_driver;
326
struct snd_soc_codec;
327
struct snd_soc_codec_driver;
328 329
struct snd_soc_component;
struct snd_soc_component_driver;
330
struct soc_enum;
M
Mark Brown 已提交
331
struct snd_soc_jack;
332
struct snd_soc_jack_zone;
M
Mark Brown 已提交
333
struct snd_soc_jack_pin;
L
Liam Girdwood 已提交
334
#include <sound/soc-dapm.h>
335
#include <sound/soc-dpcm.h>
336

337
struct snd_soc_jack_gpio;
338 339 340

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

341
extern struct snd_ac97_bus_ops *soc_ac97_ops;
342

343
enum snd_soc_control_type {
344
	SND_SOC_I2C = 1,
345
	SND_SOC_SPI,
M
Mark Brown 已提交
346
	SND_SOC_REGMAP,
347 348
};

L
Liam Girdwood 已提交
349 350 351 352 353
enum snd_soc_pcm_subclass {
	SND_SOC_PCM_CLASS_PCM	= 0,
	SND_SOC_PCM_CLASS_BE	= 1,
};

354
enum snd_soc_card_subclass {
355 356
	SND_SOC_CARD_CLASS_INIT		= 0,
	SND_SOC_CARD_CLASS_RUNTIME	= 1,
357 358
};

359
int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
360
			     int source, unsigned int freq, int dir);
361 362 363
int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
			  unsigned int freq_in, unsigned int freq_out);

364 365
int snd_soc_register_card(struct snd_soc_card *card);
int snd_soc_unregister_card(struct snd_soc_card *card);
366
int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
367 368 369
int snd_soc_suspend(struct device *dev);
int snd_soc_resume(struct device *dev);
int snd_soc_poweroff(struct device *dev);
370
int snd_soc_register_platform(struct device *dev,
371
		const struct snd_soc_platform_driver *platform_drv);
372
void snd_soc_unregister_platform(struct device *dev);
373 374 375 376
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);
377
int snd_soc_register_codec(struct device *dev,
378
		const struct snd_soc_codec_driver *codec_drv,
379 380
		struct snd_soc_dai_driver *dai_drv, int num_dai);
void snd_soc_unregister_codec(struct device *dev);
381 382 383
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);
384 385 386
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);
387
void snd_soc_unregister_component(struct device *dev);
388 389
int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
				    unsigned int reg);
390 391 392 393
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);
394
int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
395 396
			       int addr_bits, int data_bits,
			       enum snd_soc_control_type control);
397 398 399 400 401 402 403
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);
404 405 406 407
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 已提交
408
int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
409
int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
M
Mark Brown 已提交
410

411 412 413 414 415
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);

416
bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
417 418
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);
419

420 421 422
/* 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);
423
int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
424 425
int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);

426 427 428 429
/* set runtime hw params */
int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
	const struct snd_pcm_hardware *hw);

430 431 432
int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
		int cmd, struct snd_soc_platform *platform);

M
Mark Brown 已提交
433
/* Jack reporting */
434
int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
M
Mark Brown 已提交
435 436 437 438
		     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);
439 440 441 442
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);
443 444 445
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);
446 447 448 449 450
#ifdef CONFIG_GPIOLIB
int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
			struct snd_soc_jack_gpio *gpios);
void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
			struct snd_soc_jack_gpio *gpios);
451 452 453 454 455 456 457 458 459 460 461
#else
static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
					 struct snd_soc_jack_gpio *gpios)
{
	return 0;
}

static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
					   struct snd_soc_jack_gpio *gpios)
{
}
462
#endif
M
Mark Brown 已提交
463

464 465
/* codec register bit access */
int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
466
				unsigned int mask, unsigned int value);
467 468 469
int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
			       unsigned short reg, unsigned int mask,
			       unsigned int value);
470
int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
471
				unsigned int mask, unsigned int value);
472 473 474 475 476

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);

477
int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
478 479
int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
		struct platform_device *pdev);
480

481 482 483 484
/*
 *Controls
 */
struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
485
				  void *data, const char *long_name,
486
				  const char *prefix);
487 488
struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
					       const char *name);
489
int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
I
Ian Molton 已提交
490
	const struct snd_kcontrol_new *controls, int num_controls);
491 492
int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
	const struct snd_kcontrol_new *controls, int num_controls);
493 494 495 496
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);
497 498 499 500 501 502
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);
P
Peter Ujfalusi 已提交
503 504 505 506
int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_value *ucontrol);
507 508
int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
509
#define snd_soc_info_bool_ext		snd_ctl_boolean_mono_info
510 511 512 513
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);
514 515
#define snd_soc_get_volsw_2r snd_soc_get_volsw
#define snd_soc_put_volsw_2r snd_soc_put_volsw
516 517 518 519
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);
520 521 522 523 524 525
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);
526 527 528 529 530 531
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);
532 533
int snd_soc_limit_volume(struct snd_soc_codec *codec,
	const char *name, int max);
534 535 536 537 538 539
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);
540 541 542 543 544 545
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);
546 547 548 549
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);
550

M
Mark Brown 已提交
551 552 553 554 555 556 557 558 559 560 561 562 563 564
/**
 * 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;
};

565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
/**
 * 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;
};

583 584 585 586 587 588 589 590
/**
 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 *
 * @gpio:         gpio number
 * @name:         gpio name
 * @report:       value to report when jack detected
 * @invert:       report presence in low state
 * @debouce_time: debouce time in ms
591
 * @wake:	  enable as wake source
592 593 594
 * @jack_status_check: callback function which overrides the detection
 *		       to provide more complex checks (eg, reading an
 *		       ADC).
595 596 597 598 599 600 601
 */
struct snd_soc_jack_gpio {
	unsigned int gpio;
	const char *name;
	int report;
	int invert;
	int debounce_time;
602 603
	bool wake;

604
	struct snd_soc_jack *jack;
605
	struct delayed_work work;
606 607

	int (*jack_status_check)(void);
608 609
};

M
Mark Brown 已提交
610
struct snd_soc_jack {
611
	struct mutex mutex;
M
Mark Brown 已提交
612
	struct snd_jack *jack;
613
	struct snd_soc_codec *codec;
M
Mark Brown 已提交
614 615
	struct list_head pins;
	int status;
616
	struct blocking_notifier_head notifier;
617
	struct list_head jack_zones;
M
Mark Brown 已提交
618 619
};

620 621
/* SoC PCM stream information */
struct snd_soc_pcm_stream {
622
	const char *stream_name;
G
Graeme Gregory 已提交
623 624
	u64 formats;			/* SNDRV_PCM_FMTBIT_* */
	unsigned int rates;		/* SNDRV_PCM_RATE_* */
625 626 627 628
	unsigned int rate_min;		/* min rate */
	unsigned int rate_max;		/* max rate */
	unsigned int channels_min;	/* min channels */
	unsigned int channels_max;	/* max channels */
629
	unsigned int sig_bits;		/* number of bits of content */
630 631 632 633 634 635 636 637 638 639 640 641
};

/* 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);
};

642 643 644 645 646 647 648
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 *);
};

649 650 651
/* component interface */
struct snd_soc_component_driver {
	const char *name;
652 653 654 655 656

	/* DT */
	int (*of_xlate_dai_name)(struct snd_soc_component *component,
				 struct of_phandle_args *args,
				 const char **dai_name);
657 658 659 660 661 662 663 664
};

struct snd_soc_component {
	const char *name;
	int id;
	struct device *dev;
	struct list_head list;

665 666 667
	struct snd_soc_dai_driver *dai_drv;
	int num_dai;

668 669 670
	const struct snd_soc_component_driver *driver;
};

671
/* SoC Audio Codec device */
672
struct snd_soc_codec {
673
	const char *name;
674
	const char *name_prefix;
675
	int id;
M
Mark Brown 已提交
676
	struct device *dev;
677
	const struct snd_soc_codec_driver *driver;
M
Mark Brown 已提交
678

679 680
	struct mutex mutex;
	struct snd_soc_card *card;
M
Mark Brown 已提交
681
	struct list_head list;
682 683
	struct list_head card_list;
	int num_dai;
684 685
	int (*volatile_register)(struct snd_soc_codec *, unsigned int);
	int (*readable_register)(struct snd_soc_codec *, unsigned int);
686
	int (*writable_register)(struct snd_soc_codec *, unsigned int);
687 688 689 690

	/* runtime */
	struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
	unsigned int active;
691
	unsigned int cache_bypass:1; /* Suppress access to the cache */
692 693 694
	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 */
695
	unsigned int ac97_created:1; /* Codec has been created by SoC */
696
	unsigned int cache_init:1; /* codec cache has been initialized */
697
	unsigned int using_regmap:1; /* using regmap access */
698 699
	u32 cache_only;  /* Suppress writes to hardware */
	u32 cache_sync; /* Cache needs to be synced to hardware */
700 701 702 703

	/* codec IO */
	void *control_data; /* codec control (i2c/3wire) data */
	hw_write_t hw_write;
704
	unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
705 706
	unsigned int (*read)(struct snd_soc_codec *, unsigned int);
	int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
707
	void *reg_cache;
708
	struct mutex cache_rw_mutex;
709
	int val_bytes;
710

711 712 713
	/* component */
	struct snd_soc_component component;

714
	/* dapm */
L
Liam Girdwood 已提交
715
	struct snd_soc_dapm_context dapm;
716
	unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
717

718
#ifdef CONFIG_DEBUG_FS
719
	struct dentry *debugfs_codec_root;
720 721
	struct dentry *debugfs_reg;
#endif
722 723
};

724 725 726 727 728 729
/* codec driver */
struct snd_soc_codec_driver {

	/* driver ops */
	int (*probe)(struct snd_soc_codec *);
	int (*remove)(struct snd_soc_codec *);
730
	int (*suspend)(struct snd_soc_codec *);
731
	int (*resume)(struct snd_soc_codec *);
732
	struct snd_soc_component_driver component_driver;
733

734 735 736
	/* Default control and setup, added after probe() is run */
	const struct snd_kcontrol_new *controls;
	int num_controls;
737 738 739 740 741
	const struct snd_soc_dapm_widget *dapm_widgets;
	int num_dapm_widgets;
	const struct snd_soc_dapm_route *dapm_routes;
	int num_dapm_routes;

742 743
	/* codec wide operations */
	int (*set_sysclk)(struct snd_soc_codec *codec,
744
			  int clk_id, int source, unsigned int freq, int dir);
745 746 747
	int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
		unsigned int freq_in, unsigned int freq_out);

748 749 750 751 752
	/* 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);
753 754
	int (*volatile_register)(struct snd_soc_codec *, unsigned int);
	int (*readable_register)(struct snd_soc_codec *, unsigned int);
755
	int (*writable_register)(struct snd_soc_codec *, unsigned int);
756
	unsigned int reg_cache_size;
757 758 759 760 761 762 763
	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);
764
	bool idle_bias_off;
765 766

	void (*seq_notifier)(struct snd_soc_dapm_context *,
767
			     enum snd_soc_dapm_type, int);
768

769 770 771
	/* codec stream completion event */
	int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);

772 773
	bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */

774 775 776
	/* probe ordering - for components with runtime dependencies */
	int probe_order;
	int remove_order;
777 778 779
};

/* SoC platform interface */
780
struct snd_soc_platform_driver {
781

782 783 784 785
	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);
786 787

	/* pcm creation and destruction */
788
	int (*pcm_new)(struct snd_soc_pcm_runtime *);
789 790
	void (*pcm_free)(struct snd_pcm *);

791 792 793 794 795 796 797 798
	/* 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;

799 800 801 802 803 804 805
	/*
	 * For platform caused delay reporting.
	 * Optional.
	 */
	snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
		struct snd_soc_dai *);

806
	/* platform stream pcm ops */
807
	const struct snd_pcm_ops *ops;
808

809
	/* platform stream compress ops */
810
	const struct snd_compr_ops *compr_ops;
811

812 813 814
	/* platform stream completion event */
	int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);

815 816 817
	/* probe ordering - for components with runtime dependencies */
	int probe_order;
	int remove_order;
818 819 820 821

	/* 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);
822
	int (*bespoke_trigger)(struct snd_pcm_substream *, int);
823 824
};

825 826 827 828
struct snd_soc_platform {
	const char *name;
	int id;
	struct device *dev;
829
	const struct snd_soc_platform_driver *driver;
830
	struct mutex mutex;
831

832 833
	unsigned int suspended:1; /* platform is suspended */
	unsigned int probed:1;
G
Graeme Gregory 已提交
834

835 836 837
	struct snd_soc_card *card;
	struct list_head list;
	struct list_head card_list;
838 839

	struct snd_soc_dapm_context dapm;
840 841 842 843

#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs_platform_root;
#endif
844
};
845

846 847 848 849
struct snd_soc_dai_link {
	/* config - must be set by machine driver */
	const char *name;			/* Codec name */
	const char *stream_name;		/* Stream name */
850 851 852 853 854 855 856 857 858 859 860 861 862 863
	/*
	 * 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.
	 */
864
	const char *cpu_dai_name;
865 866 867 868 869 870 871
	/*
	 * 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 */
872
	const char *codec_dai_name;
873 874 875 876 877 878 879
	/*
	 * 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;
880
	int be_id;	/* optional ID for machine driver BE identification */
881

882 883
	const struct snd_soc_pcm_stream *params;

884 885
	unsigned int dai_fmt;           /* format to set on init */

886 887
	enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */

888 889 890
	/* Keep DAI active over suspend */
	unsigned int ignore_suspend:1;

891 892
	/* Symmetry requirements */
	unsigned int symmetric_rates:1;
893 894
	unsigned int symmetric_channels:1;
	unsigned int symmetric_samplebits:1;
895

896 897 898 899 900 901
	/* 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;

902 903 904 905
	/* DPCM capture and Playback support */
	unsigned int dpcm_capture:1;
	unsigned int dpcm_playback:1;

906 907 908
	/* pmdown_time is ignored at stop */
	unsigned int ignore_pmdown_time:1;

909 910
	/* codec/machine specific init - e.g. add machine controls */
	int (*init)(struct snd_soc_pcm_runtime *rtd);
911

912 913 914 915
	/* 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);

916
	/* machine stream operations */
917 918
	const struct snd_soc_ops *ops;
	const struct snd_soc_compr_ops *compr_ops;
919 920 921 922

	/* For unidirectional dai links */
	bool playback_only;
	bool capture_only;
923 924
};

925
struct snd_soc_codec_conf {
926
	const char *dev_name;
927 928 929 930 931

	/*
	 * optional map of kcontrol, widget and path name prefixes that are
	 * associated per device
	 */
932 933 934
	const char *name_prefix;
};

935 936 937 938 939 940 941 942
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);
};

943 944
/* SoC card */
struct snd_soc_card {
945
	const char *name;
946 947
	const char *long_name;
	const char *driver_name;
M
Mark Brown 已提交
948
	struct device *dev;
949 950
	struct snd_card *snd_card;
	struct module *owner;
M
Mark Brown 已提交
951 952

	struct list_head list;
953
	struct mutex mutex;
954
	struct mutex dapm_mutex;
M
Mark Brown 已提交
955

956
	bool instantiated;
957

958
	int (*probe)(struct snd_soc_card *card);
959
	int (*late_probe)(struct snd_soc_card *card);
960
	int (*remove)(struct snd_soc_card *card);
961 962 963

	/* 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. */
964 965 966 967
	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);
968

969
	/* callbacks */
970
	int (*set_bias_level)(struct snd_soc_card *,
971
			      struct snd_soc_dapm_context *dapm,
972
			      enum snd_soc_bias_level level);
973
	int (*set_bias_level_post)(struct snd_soc_card *,
974
				   struct snd_soc_dapm_context *dapm,
975
				   enum snd_soc_bias_level level);
976

M
Mark Brown 已提交
977
	long pmdown_time;
978

979 980 981
	/* CPU <--> Codec DAI links  */
	struct snd_soc_dai_link *dai_link;
	int num_links;
982 983
	struct snd_soc_pcm_runtime *rtd;
	int num_rtd;
984

985 986 987
	/* optional codec specific configuration */
	struct snd_soc_codec_conf *codec_conf;
	int num_configs;
988

989 990 991 992 993 994 995 996 997
	/*
	 * 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;

998 999 1000
	const struct snd_kcontrol_new *controls;
	int num_controls;

1001 1002 1003
	/*
	 * Card-specific routes and widgets.
	 */
1004
	const struct snd_soc_dapm_widget *dapm_widgets;
1005
	int num_dapm_widgets;
1006
	const struct snd_soc_dapm_route *dapm_routes;
1007
	int num_dapm_routes;
1008
	bool fully_routed;
1009

1010
	struct work_struct deferred_resume_work;
1011 1012 1013 1014 1015

	/* 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;
1016

1017
	struct list_head widgets;
1018
	struct list_head paths;
1019
	struct list_head dapm_list;
1020
	struct list_head dapm_dirty;
1021

M
Mark Brown 已提交
1022 1023
	/* Generic DAPM context for the card */
	struct snd_soc_dapm_context dapm;
1024
	struct snd_soc_dapm_stats dapm_stats;
1025
	struct snd_soc_dapm_update *update;
M
Mark Brown 已提交
1026

1027 1028
#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs_card_root;
1029
	struct dentry *debugfs_pop_time;
1030
#endif
1031
	u32 pop_time;
M
Mark Brown 已提交
1032 1033

	void *drvdata;
1034 1035
};

1036
/* SoC machine DAI configuration, glues a codec and cpu DAI together */
1037
struct snd_soc_pcm_runtime {
1038
	struct device *dev;
1039
	struct snd_soc_card *card;
1040
	struct snd_soc_dai_link *dai_link;
L
Liam Girdwood 已提交
1041 1042 1043
	struct mutex pcm_mutex;
	enum snd_soc_pcm_subclass pcm_subclass;
	struct snd_pcm_ops ops;
1044 1045

	unsigned int dev_registered:1;
1046

1047 1048
	/* Dynamic PCM BE runtime data */
	struct snd_soc_dpcm_runtime dpcm[2];
1049
	int fe_compr;
1050

1051
	long pmdown_time;
1052
	unsigned char pop_wait:1;
1053 1054 1055

	/* runtime devices */
	struct snd_pcm *pcm;
1056
	struct snd_compr *compr;
1057 1058 1059 1060 1061 1062
	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;
1063 1064 1065 1066
#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs_dpcm_root;
	struct dentry *debugfs_dpcm_state;
#endif
1067 1068
};

1069 1070
/* mixer control */
struct soc_mixer_control {
1071
	int min, max, platform_max;
1072 1073
	int reg, rreg;
	unsigned int shift, rshift;
1074 1075
	unsigned int invert:1;
	unsigned int autodisable:1;
1076 1077
};

1078 1079 1080
struct soc_bytes {
	int base;
	int num_regs;
1081
	u32 mask;
1082 1083
};

1084 1085 1086 1087 1088 1089
/* multi register control */
struct soc_mreg_control {
	long min, max;
	unsigned int regbase, regcount, nbits, invert;
};

1090 1091
/* enumerated kcontrol */
struct soc_enum {
P
Peter Ujfalusi 已提交
1092 1093 1094 1095 1096 1097
	unsigned short reg;
	unsigned short reg2;
	unsigned char shift_l;
	unsigned char shift_r;
	unsigned int max;
	unsigned int mask;
1098
	const char * const *texts;
P
Peter Ujfalusi 已提交
1099 1100 1101
	const unsigned int *values;
};

1102
/* codec IO */
1103 1104 1105
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);
1106

1107 1108
/* device driver data */

M
Mark Brown 已提交
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
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;
}

1120
static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1121
		void *data)
1122
{
1123
	dev_set_drvdata(codec->dev, data);
1124 1125 1126 1127
}

static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
{
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
	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)
{
1145
	dev_set_drvdata(rtd->dev, data);
1146 1147 1148 1149
}

static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
{
1150
	return dev_get_drvdata(rtd->dev);
1151 1152
}

1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
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);
}

1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
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;
}

1175 1176 1177
int snd_soc_util_init(void);
void snd_soc_util_exit(void);

1178 1179
int snd_soc_of_parse_card_name(struct snd_soc_card *card,
			       const char *propname);
1180 1181
int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
				   const char *propname);
1182 1183
unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
				     const char *prefix);
1184 1185
int snd_soc_of_get_dai_name(struct device_node *of_node,
			    const char **dai_name);
1186

1187 1188
#include <sound/soc-dai.h>

1189
#ifdef CONFIG_DEBUG_FS
1190
extern struct dentry *snd_soc_debugfs_root;
1191 1192
#endif

1193 1194
extern const struct dev_pm_ops snd_soc_pm_ops;

1195
#endif