soc.h 40.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 * 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

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

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

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

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

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

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

269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
/*
 * 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)

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

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

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

337 338 339
#ifdef CONFIG_GPIOLIB
struct snd_soc_jack_gpio;
#endif
340 341 342

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

343
extern struct snd_ac97_bus_ops *soc_ac97_ops;
344

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

351
enum snd_soc_compress_type {
352
	SND_SOC_FLAT_COMPRESSION = 1,
353 354
};

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

360
enum snd_soc_card_subclass {
361 362
	SND_SOC_CARD_CLASS_INIT		= 0,
	SND_SOC_CARD_CLASS_RUNTIME	= 1,
363 364
};

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

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

419 420 421 422 423
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);

424 425 426
/* 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);
427
int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
428 429
int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);

430 431 432 433
/* set runtime hw params */
int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
	const struct snd_pcm_hardware *hw);

434 435 436
int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
		int cmd, struct snd_soc_platform *platform);

M
Mark Brown 已提交
437
/* Jack reporting */
438
int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
M
Mark Brown 已提交
439 440 441 442
		     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);
443 444 445 446
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);
447 448 449
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);
450 451 452 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);
void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
			struct snd_soc_jack_gpio *gpios);
#endif
M
Mark Brown 已提交
456

457 458
/* codec register bit access */
int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
459
				unsigned int mask, unsigned int value);
460 461 462
int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
			       unsigned short reg, unsigned int mask,
			       unsigned int value);
463
int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
464
				unsigned int mask, unsigned int value);
465 466 467 468 469

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

470 471
int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);

472 473 474 475
/*
 *Controls
 */
struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
476
				  void *data, const char *long_name,
477
				  const char *prefix);
478
int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
I
Ian Molton 已提交
479
	const struct snd_kcontrol_new *controls, int num_controls);
480 481
int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
	const struct snd_kcontrol_new *controls, int num_controls);
482 483 484 485
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);
486 487 488 489 490 491 492 493
int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
int snd_soc_info_enum_ext(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 已提交
494 495 496 497
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);
498 499
int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
	struct snd_ctl_elem_info *uinfo);
500
#define snd_soc_info_bool_ext		snd_ctl_boolean_mono_info
501 502 503 504
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);
505 506
#define snd_soc_get_volsw_2r snd_soc_get_volsw
#define snd_soc_put_volsw_2r snd_soc_put_volsw
507 508 509 510
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);
511 512 513 514 515 516
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);
517 518 519 520 521 522
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);
523 524
int snd_soc_limit_volume(struct snd_soc_codec *codec,
	const char *name, int max);
525 526 527 528 529 530
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);
531 532 533 534 535 536
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);
537 538 539 540
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);
541

542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
/**
 * struct snd_soc_reg_access - Describes whether a given register is
 * readable, writable or volatile.
 *
 * @reg: the register number
 * @read: whether this register is readable
 * @write: whether this register is writable
 * @vol: whether this register is volatile
 */
struct snd_soc_reg_access {
	u16 reg;
	u16 read;
	u16 write;
	u16 vol;
};

M
Mark Brown 已提交
558 559 560 561 562 563 564 565 566 567 568 569 570 571
/**
 * 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;
};

572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
/**
 * 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;
};

590 591 592 593 594 595 596 597
/**
 * 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
598
 * @wake:	  enable as wake source
599 600 601
 * @jack_status_check: callback function which overrides the detection
 *		       to provide more complex checks (eg, reading an
 *		       ADC).
602 603 604 605 606 607 608 609
 */
#ifdef CONFIG_GPIOLIB
struct snd_soc_jack_gpio {
	unsigned int gpio;
	const char *name;
	int report;
	int invert;
	int debounce_time;
610 611
	bool wake;

612
	struct snd_soc_jack *jack;
613
	struct delayed_work work;
614 615

	int (*jack_status_check)(void);
616 617 618
};
#endif

M
Mark Brown 已提交
619
struct snd_soc_jack {
620
	struct mutex mutex;
M
Mark Brown 已提交
621
	struct snd_jack *jack;
622
	struct snd_soc_codec *codec;
M
Mark Brown 已提交
623 624
	struct list_head pins;
	int status;
625
	struct blocking_notifier_head notifier;
626
	struct list_head jack_zones;
M
Mark Brown 已提交
627 628
};

629 630
/* SoC PCM stream information */
struct snd_soc_pcm_stream {
631
	const char *stream_name;
G
Graeme Gregory 已提交
632 633
	u64 formats;			/* SNDRV_PCM_FMTBIT_* */
	unsigned int rates;		/* SNDRV_PCM_RATE_* */
634 635 636 637
	unsigned int rate_min;		/* min rate */
	unsigned int rate_max;		/* max rate */
	unsigned int channels_min;	/* min channels */
	unsigned int channels_max;	/* max channels */
638
	unsigned int sig_bits;		/* number of bits of content */
639 640 641 642 643 644 645 646 647 648 649 650
};

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

651 652 653 654 655 656 657
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 *);
};

658 659
/* SoC cache ops */
struct snd_soc_cache_ops {
660
	const char *name;
661 662 663 664 665 666 667 668 669 670
	enum snd_soc_compress_type id;
	int (*init)(struct snd_soc_codec *codec);
	int (*exit)(struct snd_soc_codec *codec);
	int (*read)(struct snd_soc_codec *codec, unsigned int reg,
		unsigned int *value);
	int (*write)(struct snd_soc_codec *codec, unsigned int reg,
		unsigned int value);
	int (*sync)(struct snd_soc_codec *codec);
};

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
	enum snd_soc_compress_type compress_type;
685
	size_t reg_size;	/* reg_cache_size * reg_word_size */
686 687
	int (*volatile_register)(struct snd_soc_codec *, unsigned int);
	int (*readable_register)(struct snd_soc_codec *, unsigned int);
688
	int (*writable_register)(struct snd_soc_codec *, unsigned int);
689 690 691 692

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

	/* codec IO */
	void *control_data; /* codec control (i2c/3wire) data */
706
	enum snd_soc_control_type control_type;
707
	hw_write_t hw_write;
708
	unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
709 710
	unsigned int (*read)(struct snd_soc_codec *, unsigned int);
	int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
711
	int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
712
	void *reg_cache;
713
	const void *reg_def_copy;
714 715
	const struct snd_soc_cache_ops *cache_ops;
	struct mutex cache_rw_mutex;
716
	int val_bytes;
717

718
	/* dapm */
L
Liam Girdwood 已提交
719
	struct snd_soc_dapm_context dapm;
720
	unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
721

722
#ifdef CONFIG_DEBUG_FS
723
	struct dentry *debugfs_codec_root;
724
	struct dentry *debugfs_reg;
725
	struct dentry *debugfs_dapm;
726
#endif
727 728
};

729 730 731 732 733 734
/* codec driver */
struct snd_soc_codec_driver {

	/* driver ops */
	int (*probe)(struct snd_soc_codec *);
	int (*remove)(struct snd_soc_codec *);
735
	int (*suspend)(struct snd_soc_codec *);
736 737
	int (*resume)(struct snd_soc_codec *);

738 739 740
	/* Default control and setup, added after probe() is run */
	const struct snd_kcontrol_new *controls;
	int num_controls;
741 742 743 744 745
	const struct snd_soc_dapm_widget *dapm_widgets;
	int num_dapm_widgets;
	const struct snd_soc_dapm_route *dapm_routes;
	int num_dapm_routes;

746 747
	/* codec wide operations */
	int (*set_sysclk)(struct snd_soc_codec *codec,
748
			  int clk_id, int source, unsigned int freq, int dir);
749 750 751
	int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
		unsigned int freq_in, unsigned int freq_out);

752 753 754 755 756
	/* 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);
757 758
	int (*volatile_register)(struct snd_soc_codec *, unsigned int);
	int (*readable_register)(struct snd_soc_codec *, unsigned int);
759
	int (*writable_register)(struct snd_soc_codec *, unsigned int);
760
	unsigned int reg_cache_size;
761 762 763
	short reg_cache_step;
	short reg_word_size;
	const void *reg_cache_default;
764 765
	short reg_access_size;
	const struct snd_soc_reg_access *reg_access_default;
766
	enum snd_soc_compress_type compress_type;
767 768 769 770

	/* codec bias level */
	int (*set_bias_level)(struct snd_soc_codec *,
			      enum snd_soc_bias_level level);
771
	bool idle_bias_off;
772 773

	void (*seq_notifier)(struct snd_soc_dapm_context *,
774
			     enum snd_soc_dapm_type, int);
775

776 777 778
	/* codec stream completion event */
	int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);

779 780
	bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */

781 782 783
	/* probe ordering - for components with runtime dependencies */
	int probe_order;
	int remove_order;
784 785 786
};

/* SoC platform interface */
787
struct snd_soc_platform_driver {
788

789 790 791 792
	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);
793 794

	/* pcm creation and destruction */
795
	int (*pcm_new)(struct snd_soc_pcm_runtime *);
796 797
	void (*pcm_free)(struct snd_pcm *);

798 799 800 801 802 803 804 805
	/* 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;

806 807 808 809 810 811 812
	/*
	 * For platform caused delay reporting.
	 * Optional.
	 */
	snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
		struct snd_soc_dai *);

813
	/* platform stream pcm ops */
814
	const struct snd_pcm_ops *ops;
815

816
	/* platform stream compress ops */
817
	const struct snd_compr_ops *compr_ops;
818

819 820 821
	/* platform stream completion event */
	int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);

822 823 824
	/* probe ordering - for components with runtime dependencies */
	int probe_order;
	int remove_order;
825 826 827 828

	/* 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);
829
	int (*bespoke_trigger)(struct snd_pcm_substream *, int);
830 831
};

832 833 834 835
struct snd_soc_platform {
	const char *name;
	int id;
	struct device *dev;
836
	const struct snd_soc_platform_driver *driver;
837
	struct mutex mutex;
838

839 840
	unsigned int suspended:1; /* platform is suspended */
	unsigned int probed:1;
G
Graeme Gregory 已提交
841

842 843 844
	struct snd_soc_card *card;
	struct list_head list;
	struct list_head card_list;
845 846

	struct snd_soc_dapm_context dapm;
847 848 849 850 851

#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs_platform_root;
	struct dentry *debugfs_dapm;
#endif
852
};
853

854
struct snd_soc_component_driver {
855
	const char *name;
856 857 858 859 860 861 862 863 864 865 866 867
};

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

	const struct snd_soc_component_driver *driver;
};

868 869 870 871
struct snd_soc_dai_link {
	/* config - must be set by machine driver */
	const char *name;			/* Codec name */
	const char *stream_name;		/* Stream name */
872 873 874 875 876 877 878 879 880 881 882 883 884 885
	/*
	 * 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.
	 */
886
	const char *cpu_dai_name;
887 888 889 890 891 892 893
	/*
	 * 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 */
894
	const char *codec_dai_name;
895 896 897 898 899 900 901
	/*
	 * 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;
902
	int be_id;	/* optional ID for machine driver BE identification */
903

904 905
	const struct snd_soc_pcm_stream *params;

906 907
	unsigned int dai_fmt;           /* format to set on init */

908 909
	enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */

910 911 912
	/* Keep DAI active over suspend */
	unsigned int ignore_suspend:1;

913 914 915
	/* Symmetry requirements */
	unsigned int symmetric_rates:1;

916 917 918 919 920 921
	/* 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;

922 923 924
	/* pmdown_time is ignored at stop */
	unsigned int ignore_pmdown_time:1;

925 926
	/* codec/machine specific init - e.g. add machine controls */
	int (*init)(struct snd_soc_pcm_runtime *rtd);
927

928 929 930 931
	/* 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);

932
	/* machine stream operations */
933 934
	const struct snd_soc_ops *ops;
	const struct snd_soc_compr_ops *compr_ops;
935 936
};

937
struct snd_soc_codec_conf {
938
	const char *dev_name;
939 940 941 942 943

	/*
	 * optional map of kcontrol, widget and path name prefixes that are
	 * associated per device
	 */
944
	const char *name_prefix;
945 946 947 948 949 950

	/*
	 * set this to the desired compression type if you want to
	 * override the one supplied in codec->driver->compress_type
	 */
	enum snd_soc_compress_type compress_type;
951 952
};

953 954 955 956 957 958 959 960
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);
};

961 962
/* SoC card */
struct snd_soc_card {
963
	const char *name;
964 965
	const char *long_name;
	const char *driver_name;
M
Mark Brown 已提交
966
	struct device *dev;
967 968
	struct snd_card *snd_card;
	struct module *owner;
M
Mark Brown 已提交
969 970

	struct list_head list;
971
	struct mutex mutex;
972
	struct mutex dapm_mutex;
M
Mark Brown 已提交
973

974
	bool instantiated;
975

976
	int (*probe)(struct snd_soc_card *card);
977
	int (*late_probe)(struct snd_soc_card *card);
978
	int (*remove)(struct snd_soc_card *card);
979 980 981

	/* 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. */
982 983 984 985
	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);
986

987
	/* callbacks */
988
	int (*set_bias_level)(struct snd_soc_card *,
989
			      struct snd_soc_dapm_context *dapm,
990
			      enum snd_soc_bias_level level);
991
	int (*set_bias_level_post)(struct snd_soc_card *,
992
				   struct snd_soc_dapm_context *dapm,
993
				   enum snd_soc_bias_level level);
994

M
Mark Brown 已提交
995
	long pmdown_time;
996

997 998 999
	/* CPU <--> Codec DAI links  */
	struct snd_soc_dai_link *dai_link;
	int num_links;
1000 1001
	struct snd_soc_pcm_runtime *rtd;
	int num_rtd;
1002

1003 1004 1005
	/* optional codec specific configuration */
	struct snd_soc_codec_conf *codec_conf;
	int num_configs;
1006

1007 1008 1009 1010 1011 1012 1013 1014 1015
	/*
	 * 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;

1016 1017 1018
	const struct snd_kcontrol_new *controls;
	int num_controls;

1019 1020 1021
	/*
	 * Card-specific routes and widgets.
	 */
1022
	const struct snd_soc_dapm_widget *dapm_widgets;
1023
	int num_dapm_widgets;
1024
	const struct snd_soc_dapm_route *dapm_routes;
1025
	int num_dapm_routes;
1026
	bool fully_routed;
1027

1028
	struct work_struct deferred_resume_work;
1029 1030 1031 1032 1033

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

1035
	struct list_head widgets;
1036
	struct list_head paths;
1037
	struct list_head dapm_list;
1038
	struct list_head dapm_dirty;
1039

M
Mark Brown 已提交
1040 1041
	/* Generic DAPM context for the card */
	struct snd_soc_dapm_context dapm;
1042
	struct snd_soc_dapm_stats dapm_stats;
M
Mark Brown 已提交
1043

1044 1045
#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs_card_root;
1046
	struct dentry *debugfs_pop_time;
1047
#endif
1048
	u32 pop_time;
M
Mark Brown 已提交
1049 1050

	void *drvdata;
1051 1052
};

1053
/* SoC machine DAI configuration, glues a codec and cpu DAI together */
1054
struct snd_soc_pcm_runtime {
1055
	struct device *dev;
1056
	struct snd_soc_card *card;
1057
	struct snd_soc_dai_link *dai_link;
L
Liam Girdwood 已提交
1058 1059 1060
	struct mutex pcm_mutex;
	enum snd_soc_pcm_subclass pcm_subclass;
	struct snd_pcm_ops ops;
1061 1062

	unsigned int dev_registered:1;
1063

1064 1065 1066
	/* Dynamic PCM BE runtime data */
	struct snd_soc_dpcm_runtime dpcm[2];

1067
	long pmdown_time;
1068
	unsigned char pop_wait:1;
1069 1070 1071

	/* runtime devices */
	struct snd_pcm *pcm;
1072
	struct snd_compr *compr;
1073 1074 1075 1076 1077 1078
	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;
1079 1080 1081 1082
#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs_dpcm_root;
	struct dentry *debugfs_dpcm_state;
#endif
1083 1084
};

1085 1086
/* mixer control */
struct soc_mixer_control {
1087
	int min, max, platform_max;
1088
	unsigned int reg, rreg, shift, rshift, invert;
1089 1090
};

1091 1092 1093
struct soc_bytes {
	int base;
	int num_regs;
1094
	u32 mask;
1095 1096
};

1097 1098 1099 1100 1101 1102
/* multi register control */
struct soc_mreg_control {
	long min, max;
	unsigned int regbase, regcount, nbits, invert;
};

1103 1104
/* enumerated kcontrol */
struct soc_enum {
P
Peter Ujfalusi 已提交
1105 1106 1107 1108 1109 1110
	unsigned short reg;
	unsigned short reg2;
	unsigned char shift_l;
	unsigned char shift_r;
	unsigned int max;
	unsigned int mask;
1111
	const char * const *texts;
P
Peter Ujfalusi 已提交
1112 1113 1114
	const unsigned int *values;
};

1115
/* codec IO */
1116 1117 1118
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);
1119 1120
unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
				    unsigned int reg, const void *data, size_t len);
1121

1122 1123
/* device driver data */

M
Mark Brown 已提交
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
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;
}

1135
static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1136
		void *data)
1137
{
1138
	dev_set_drvdata(codec->dev, data);
1139 1140 1141 1142
}

static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
{
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
	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)
{
1160
	dev_set_drvdata(rtd->dev, data);
1161 1162 1163 1164
}

static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
{
1165
	return dev_get_drvdata(rtd->dev);
1166 1167
}

1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
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);
}

1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
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;
}

1190 1191 1192
int snd_soc_util_init(void);
void snd_soc_util_exit(void);

1193 1194
int snd_soc_of_parse_card_name(struct snd_soc_card *card,
			       const char *propname);
1195 1196
int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
				   const char *propname);
1197 1198
unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
				     const char *prefix);
1199

1200 1201
#include <sound/soc-dai.h>

1202
#ifdef CONFIG_DEBUG_FS
1203
extern struct dentry *snd_soc_debugfs_root;
1204 1205
#endif

1206 1207
extern const struct dev_pm_ops snd_soc_pm_ops;

1208
#endif