1/* SPDX-License-Identifier: GPL-2.0
   2 *
   3 * linux/sound/soc.h -- ALSA SoC Layer
   4 *
   5 * Author:	Liam Girdwood
   6 * Created:	Aug 11th 2005
   7 * Copyright:	Wolfson Microelectronics. PLC.
   8 */
   9
  10#ifndef __LINUX_SND_SOC_H
  11#define __LINUX_SND_SOC_H
  12
  13#include <linux/of.h>
  14#include <linux/platform_device.h>
  15#include <linux/types.h>
  16#include <linux/notifier.h>
  17#include <linux/workqueue.h>
  18#include <linux/interrupt.h>
  19#include <linux/kernel.h>
  20#include <linux/regmap.h>
  21#include <linux/log2.h>
  22#include <sound/core.h>
  23#include <sound/pcm.h>
  24#include <sound/compress_driver.h>
  25#include <sound/control.h>
  26#include <sound/ac97_codec.h>
  27
  28/*
  29 * Convenience kcontrol builders
  30 */
  31#define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert, xautodisable) \
  32	((unsigned long)&(struct soc_mixer_control) \
  33	{.reg = xreg, .rreg = xreg, .shift = shift_left, \
  34	.rshift = shift_right, .max = xmax, .platform_max = xmax, \
  35	.invert = xinvert, .autodisable = xautodisable})
  36#define SOC_DOUBLE_S_VALUE(xreg, shift_left, shift_right, xmin, xmax, xsign_bit, xinvert, xautodisable) \
  37	((unsigned long)&(struct soc_mixer_control) \
  38	{.reg = xreg, .rreg = xreg, .shift = shift_left, \
  39	.rshift = shift_right, .min = xmin, .max = xmax, .platform_max = xmax, \
  40	.sign_bit = xsign_bit, .invert = xinvert, .autodisable = xautodisable})
  41#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, xautodisable) \
  42	SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert, xautodisable)
  43#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
  44	((unsigned long)&(struct soc_mixer_control) \
  45	{.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
  46#define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
  47	((unsigned long)&(struct soc_mixer_control) \
  48	{.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  49	.max = xmax, .platform_max = xmax, .invert = xinvert})
  50#define SOC_DOUBLE_R_S_VALUE(xlreg, xrreg, xshift, xmin, xmax, xsign_bit, xinvert) \
  51	((unsigned long)&(struct soc_mixer_control) \
  52	{.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  53	.max = xmax, .min = xmin, .platform_max = xmax, .sign_bit = xsign_bit, \
  54	.invert = xinvert})
  55#define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
  56	((unsigned long)&(struct soc_mixer_control) \
  57	{.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  58	.min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
  59#define SOC_SINGLE(xname, reg, shift, max, invert) \
  60{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  61	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  62	.put = snd_soc_put_volsw, \
  63	.private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
  64#define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
  65{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  66	.info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
  67	.put = snd_soc_put_volsw_range, \
  68	.private_value = (unsigned long)&(struct soc_mixer_control) \
  69		{.reg = xreg, .rreg = xreg, .shift = xshift, \
  70		 .rshift = xshift,  .min = xmin, .max = xmax, \
  71		 .platform_max = xmax, .invert = xinvert} }
  72#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
  73{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  74	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  75		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  76	.tlv.p = (tlv_array), \
  77	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  78	.put = snd_soc_put_volsw, \
  79	.private_value = SOC_SINGLE_VALUE(reg, shift, max, invert, 0) }
  80#define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
  81{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  82	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
  83	SNDRV_CTL_ELEM_ACCESS_READWRITE, \
  84	.tlv.p  = (tlv_array),\
  85	.info = snd_soc_info_volsw_sx, \
  86	.get = snd_soc_get_volsw_sx,\
  87	.put = snd_soc_put_volsw_sx, \
  88	.private_value = (unsigned long)&(struct soc_mixer_control) \
  89		{.reg = xreg, .rreg = xreg, \
  90		.shift = xshift, .rshift = xshift, \
  91		.max = xmax, .min = xmin} }
  92#define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
  93{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  94	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  95		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  96	.tlv.p = (tlv_array), \
  97	.info = snd_soc_info_volsw_range, \
  98	.get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
  99	.private_value = (unsigned long)&(struct soc_mixer_control) \
 100		{.reg = xreg, .rreg = xreg, .shift = xshift, \
 101		 .rshift = xshift, .min = xmin, .max = xmax, \
 102		 .platform_max = xmax, .invert = xinvert} }
 103#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
 104{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 105	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
 106	.put = snd_soc_put_volsw, \
 107	.private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 108					  max, invert, 0) }
 109#define SOC_DOUBLE_STS(xname, reg, shift_left, shift_right, max, invert) \
 110{									\
 111	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),		\
 112	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,		\
 113	.access = SNDRV_CTL_ELEM_ACCESS_READ |				\
 114		SNDRV_CTL_ELEM_ACCESS_VOLATILE,				\
 115	.private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right,	\
 116					  max, invert, 0) }
 117#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
 118{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 119	.info = snd_soc_info_volsw, \
 120	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 121	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 122					    xmax, xinvert) }
 123#define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
 124			   xmax, xinvert)		\
 125{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 126	.info = snd_soc_info_volsw_range, \
 127	.get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 128	.private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
 129					    xshift, xmin, xmax, xinvert) }
 130#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
 131{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 132	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 133		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 134	.tlv.p = (tlv_array), \
 135	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
 136	.put = snd_soc_put_volsw, \
 137	.private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 138					  max, invert, 0) }
 139#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
 140{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 141	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 142		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 143	.tlv.p = (tlv_array), \
 144	.info = snd_soc_info_volsw, \
 145	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 146	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 147					    xmax, xinvert) }
 148#define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
 149			       xmax, xinvert, tlv_array)		\
 150{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 151	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 152		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 153	.tlv.p = (tlv_array), \
 154	.info = snd_soc_info_volsw_range, \
 155	.get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 156	.private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
 157					    xshift, xmin, xmax, xinvert) }
 158#define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
 159{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 160	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 161	SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 162	.tlv.p  = (tlv_array), \
 163	.info = snd_soc_info_volsw_sx, \
 164	.get = snd_soc_get_volsw_sx, \
 165	.put = snd_soc_put_volsw_sx, \
 166	.private_value = (unsigned long)&(struct soc_mixer_control) \
 167		{.reg = xreg, .rreg = xrreg, \
 168		.shift = xshift, .rshift = xshift, \
 169		.max = xmax, .min = xmin} }
 170#define SOC_DOUBLE_R_S_TLV(xname, reg_left, reg_right, xshift, xmin, xmax, xsign_bit, xinvert, tlv_array) \
 171{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 172	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 173		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 174	.tlv.p = (tlv_array), \
 175	.info = snd_soc_info_volsw, \
 176	.get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 177	.private_value = SOC_DOUBLE_R_S_VALUE(reg_left, reg_right, xshift, \
 178					    xmin, xmax, xsign_bit, xinvert) }
 179#define SOC_SINGLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
 180{	.iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 181	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 182		  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 183	.tlv.p  = (tlv_array), \
 184	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
 185	.put = snd_soc_put_volsw, \
 186	.private_value = (unsigned long)&(struct soc_mixer_control) \
 187	{.reg = xreg, .rreg = xreg,  \
 188	 .min = xmin, .max = xmax, .platform_max = xmax, \
 189	.sign_bit = 7,} }
 190#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
 191{	.iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 192	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 193		  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 194	.tlv.p  = (tlv_array), \
 195	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
 196	.put = snd_soc_put_volsw, \
 197	.private_value = SOC_DOUBLE_S_VALUE(xreg, 0, 8, xmin, xmax, 7, 0, 0) }
 198#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xitems, xtexts) \
 199{	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 200	.items = xitems, .texts = xtexts, \
 201	.mask = xitems ? roundup_pow_of_two(xitems) - 1 : 0}
 202#define SOC_ENUM_SINGLE(xreg, xshift, xitems, xtexts) \
 203	SOC_ENUM_DOUBLE(xreg, xshift, xshift, xitems, xtexts)
 204#define SOC_ENUM_SINGLE_EXT(xitems, xtexts) \
 205{	.items = xitems, .texts = xtexts }
 206#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xitems, xtexts, xvalues) \
 207{	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 208	.mask = xmask, .items = xitems, .texts = xtexts, .values = xvalues}
 209#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
 210	SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xitems, xtexts, xvalues)
 211#define SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, xshift, xmask, xitems, xtexts, xvalues) \
 212{	.reg = xreg, .shift_l = xshift, .shift_r = xshift, \
 213	.mask = xmask, .items = xitems, .texts = xtexts, \
 214	.values = xvalues, .autodisable = 1}
 215#define SOC_ENUM_SINGLE_VIRT(xitems, xtexts) \
 216	SOC_ENUM_SINGLE(SND_SOC_NOPM, 0, xitems, xtexts)
 217#define SOC_ENUM(xname, xenum) \
 218{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 219	.info = snd_soc_info_enum_double, \
 220	.get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
 221	.private_value = (unsigned long)&xenum }
 222#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 223	 xhandler_get, xhandler_put) \
 224{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 225	.info = snd_soc_info_volsw, \
 226	.get = xhandler_get, .put = xhandler_put, \
 227	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 228#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
 229	 xhandler_get, xhandler_put) \
 230{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 231	.info = snd_soc_info_volsw, \
 232	.get = xhandler_get, .put = xhandler_put, \
 233	.private_value = \
 234		SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert, 0) }
 235#define SOC_DOUBLE_R_EXT(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 236	 xhandler_get, xhandler_put) \
 237{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 238	.info = snd_soc_info_volsw, \
 239	.get = xhandler_get, .put = xhandler_put, \
 240	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 241					    xmax, xinvert) }
 242#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 243	 xhandler_get, xhandler_put, tlv_array) \
 244{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 245	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 246		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 247	.tlv.p = (tlv_array), \
 248	.info = snd_soc_info_volsw, \
 249	.get = xhandler_get, .put = xhandler_put, \
 250	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert, 0) }
 251#define SOC_SINGLE_RANGE_EXT_TLV(xname, xreg, xshift, xmin, xmax, xinvert, \
 252				 xhandler_get, xhandler_put, tlv_array) \
 253{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 254	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 255		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 256	.tlv.p = (tlv_array), \
 257	.info = snd_soc_info_volsw_range, \
 258	.get = xhandler_get, .put = xhandler_put, \
 259	.private_value = (unsigned long)&(struct soc_mixer_control) \
 260		{.reg = xreg, .rreg = xreg, .shift = xshift, \
 261		 .rshift = xshift, .min = xmin, .max = xmax, \
 262		 .platform_max = xmax, .invert = xinvert} }
 263#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 264	 xhandler_get, xhandler_put, tlv_array) \
 265{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 266	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 267		 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 268	.tlv.p = (tlv_array), \
 269	.info = snd_soc_info_volsw, \
 270	.get = xhandler_get, .put = xhandler_put, \
 271	.private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
 272					  xmax, xinvert, 0) }
 273#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 274	 xhandler_get, xhandler_put, tlv_array) \
 275{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 276	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 277		 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 278	.tlv.p = (tlv_array), \
 279	.info = snd_soc_info_volsw, \
 280	.get = xhandler_get, .put = xhandler_put, \
 281	.private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 282					    xmax, xinvert) }
 283#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
 284{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 285	.info = snd_soc_info_bool_ext, \
 286	.get = xhandler_get, .put = xhandler_put, \
 287	.private_value = xdata }
 288#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 289{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 290	.info = snd_soc_info_enum_double, \
 291	.get = xhandler_get, .put = xhandler_put, \
 292	.private_value = (unsigned long)&xenum }
 293#define SOC_VALUE_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 294	SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put)
 295
 296#define SND_SOC_BYTES(xname, xbase, xregs)		      \
 297{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 298	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 299	.put = snd_soc_bytes_put, .private_value =	      \
 300		((unsigned long)&(struct soc_bytes)           \
 301		{.base = xbase, .num_regs = xregs }) }
 
 
 
 
 
 
 302
 303#define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)	      \
 304{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 305	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 306	.put = snd_soc_bytes_put, .private_value =	      \
 307		((unsigned long)&(struct soc_bytes)           \
 308		{.base = xbase, .num_regs = xregs,	      \
 309		 .mask = xmask }) }
 310
 311/*
 312 * SND_SOC_BYTES_EXT is deprecated, please USE SND_SOC_BYTES_TLV instead
 313 */
 314#define SND_SOC_BYTES_EXT(xname, xcount, xhandler_get, xhandler_put) \
 315{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 316	.info = snd_soc_bytes_info_ext, \
 317	.get = xhandler_get, .put = xhandler_put, \
 318	.private_value = (unsigned long)&(struct soc_bytes_ext) \
 319		{.max = xcount} }
 320#define SND_SOC_BYTES_TLV(xname, xcount, xhandler_get, xhandler_put) \
 321{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 322	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE | \
 323		  SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
 324	.tlv.c = (snd_soc_bytes_tlv_callback), \
 325	.info = snd_soc_bytes_info_ext, \
 326	.private_value = (unsigned long)&(struct soc_bytes_ext) \
 327		{.max = xcount, .get = xhandler_get, .put = xhandler_put, } }
 328#define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
 329		xmin, xmax, xinvert) \
 330{	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 331	.info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
 332	.put = snd_soc_put_xr_sx, \
 333	.private_value = (unsigned long)&(struct soc_mreg_control) \
 334		{.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
 335		.invert = xinvert, .min = xmin, .max = xmax} }
 336
 337#define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
 338	SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
 339		snd_soc_get_strobe, snd_soc_put_strobe)
 340
 341/*
 342 * Simplified versions of above macros, declaring a struct and calculating
 343 * ARRAY_SIZE internally
 344 */
 345#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
 346	const struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
 347						ARRAY_SIZE(xtexts), xtexts)
 348#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
 349	SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
 350#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
 351	const struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
 352#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
 353	const struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
 354							ARRAY_SIZE(xtexts), xtexts, xvalues)
 355#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 356	SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
 357
 358#define SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 359	const struct soc_enum name = SOC_VALUE_ENUM_SINGLE_AUTODISABLE(xreg, \
 360		xshift, xmask, ARRAY_SIZE(xtexts), xtexts, xvalues)
 361
 362#define SOC_ENUM_SINGLE_VIRT_DECL(name, xtexts) \
 363	const struct soc_enum name = SOC_ENUM_SINGLE_VIRT(ARRAY_SIZE(xtexts), xtexts)
 364
 365/*
 366 * Bias levels
 367 *
 368 * @ON:      Bias is fully on for audio playback and capture operations.
 369 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 370 *           stream start and stop operations.
 371 * @STANDBY: Low power standby state when no playback/capture operations are
 372 *           in progress. NOTE: The transition time between STANDBY and ON
 373 *           should be as fast as possible and no longer than 10ms.
 374 * @OFF:     Power Off. No restrictions on transition times.
 375 */
 376enum snd_soc_bias_level {
 377	SND_SOC_BIAS_OFF = 0,
 378	SND_SOC_BIAS_STANDBY = 1,
 379	SND_SOC_BIAS_PREPARE = 2,
 380	SND_SOC_BIAS_ON = 3,
 381};
 382
 383struct device_node;
 384struct snd_jack;
 385struct snd_soc_card;
 386struct snd_soc_pcm_stream;
 387struct snd_soc_ops;
 388struct snd_soc_pcm_runtime;
 389struct snd_soc_dai;
 390struct snd_soc_dai_driver;
 391struct snd_soc_dai_link;
 392struct snd_soc_component;
 393struct snd_soc_component_driver;
 394struct soc_enum;
 395struct snd_soc_jack;
 396struct snd_soc_jack_zone;
 397struct snd_soc_jack_pin;
 398#include <sound/soc-dapm.h>
 399#include <sound/soc-dpcm.h>
 400#include <sound/soc-topology.h>
 401
 402struct snd_soc_jack_gpio;
 403
 404typedef int (*hw_write_t)(void *,const char* ,int);
 405
 406enum snd_soc_pcm_subclass {
 407	SND_SOC_PCM_CLASS_PCM	= 0,
 408	SND_SOC_PCM_CLASS_BE	= 1,
 409};
 410
 411enum snd_soc_card_subclass {
 412	SND_SOC_CARD_CLASS_INIT		= 0,
 413	SND_SOC_CARD_CLASS_RUNTIME	= 1,
 414};
 415
 416int snd_soc_register_card(struct snd_soc_card *card);
 417int snd_soc_unregister_card(struct snd_soc_card *card);
 418int devm_snd_soc_register_card(struct device *dev, struct snd_soc_card *card);
 419#ifdef CONFIG_PM_SLEEP
 420int snd_soc_suspend(struct device *dev);
 421int snd_soc_resume(struct device *dev);
 422#else
 423static inline int snd_soc_suspend(struct device *dev)
 424{
 425	return 0;
 426}
 427
 428static inline int snd_soc_resume(struct device *dev)
 429{
 430	return 0;
 431}
 432#endif
 433int snd_soc_poweroff(struct device *dev);
 434int snd_soc_add_component(struct device *dev,
 435		struct snd_soc_component *component,
 436		const struct snd_soc_component_driver *component_driver,
 437		struct snd_soc_dai_driver *dai_drv,
 438		int num_dai);
 
 439int snd_soc_register_component(struct device *dev,
 440			 const struct snd_soc_component_driver *component_driver,
 441			 struct snd_soc_dai_driver *dai_drv, int num_dai);
 442int devm_snd_soc_register_component(struct device *dev,
 443			 const struct snd_soc_component_driver *component_driver,
 444			 struct snd_soc_dai_driver *dai_drv, int num_dai);
 445void snd_soc_unregister_component(struct device *dev);
 
 
 
 
 446struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
 447						   const char *driver_name);
 448
 449int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
 450#ifdef CONFIG_SND_SOC_COMPRESS
 451int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
 452#else
 453static inline int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num)
 454{
 455	return 0;
 456}
 457#endif
 458
 459void snd_soc_disconnect_sync(struct device *dev);
 460
 461struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
 462		const char *dai_link, int stream);
 463struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 464		const char *dai_link);
 465
 466bool snd_soc_runtime_ignore_pmdown_time(struct snd_soc_pcm_runtime *rtd);
 467void snd_soc_runtime_activate(struct snd_soc_pcm_runtime *rtd, int stream);
 468void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 469
 470int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
 471	unsigned int dai_fmt);
 472
 473#ifdef CONFIG_DMI
 474int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour);
 475#else
 476static inline int snd_soc_set_dmi_name(struct snd_soc_card *card,
 477				       const char *flavour)
 478{
 479	return 0;
 480}
 481#endif
 482
 483/* Utility functions to get clock rates from various things */
 484int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 485int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 486int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 487int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 488
 489/* set runtime hw params */
 490int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 491	const struct snd_pcm_hardware *hw);
 492
 493/* Jack reporting */
 494int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
 495	struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
 496	unsigned int num_pins);
 497
 498void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 499int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 500			  struct snd_soc_jack_pin *pins);
 501void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 502				    struct notifier_block *nb);
 503void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 504				      struct notifier_block *nb);
 505int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 506			  struct snd_soc_jack_zone *zones);
 507int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 508#ifdef CONFIG_GPIOLIB
 509int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 510			struct snd_soc_jack_gpio *gpios);
 511int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
 512			    struct snd_soc_jack *jack,
 513			    int count, struct snd_soc_jack_gpio *gpios);
 514void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 515			struct snd_soc_jack_gpio *gpios);
 516#else
 517static inline int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 518					 struct snd_soc_jack_gpio *gpios)
 519{
 520	return 0;
 521}
 522
 523static inline int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
 524					  struct snd_soc_jack *jack,
 525					  int count,
 526					  struct snd_soc_jack_gpio *gpios)
 527{
 528	return 0;
 529}
 530
 531static inline void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 532					   struct snd_soc_jack_gpio *gpios)
 533{
 534}
 535#endif
 536
 537struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component);
 538struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component,
 539	unsigned int id, unsigned int id_mask);
 540void snd_soc_free_ac97_component(struct snd_ac97 *ac97);
 541
 542#ifdef CONFIG_SND_SOC_AC97_BUS
 543int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops);
 544int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 545		struct platform_device *pdev);
 546
 547extern struct snd_ac97_bus_ops *soc_ac97_ops;
 548#else
 549static inline int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
 550	struct platform_device *pdev)
 551{
 552	return 0;
 553}
 554
 555static inline int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
 556{
 557	return 0;
 558}
 559#endif
 560
 561/*
 562 *Controls
 563 */
 564struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 565				  void *data, const char *long_name,
 566				  const char *prefix);
 567struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
 568					       const char *name);
 569int snd_soc_add_component_controls(struct snd_soc_component *component,
 570	const struct snd_kcontrol_new *controls, unsigned int num_controls);
 571int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 572	const struct snd_kcontrol_new *controls, int num_controls);
 573int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 574	const struct snd_kcontrol_new *controls, int num_controls);
 575int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 576	struct snd_ctl_elem_info *uinfo);
 577int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 578	struct snd_ctl_elem_value *ucontrol);
 579int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 580	struct snd_ctl_elem_value *ucontrol);
 581int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 582	struct snd_ctl_elem_info *uinfo);
 583int snd_soc_info_volsw_sx(struct snd_kcontrol *kcontrol,
 584			  struct snd_ctl_elem_info *uinfo);
 585#define snd_soc_info_bool_ext		snd_ctl_boolean_mono_info
 586int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 587	struct snd_ctl_elem_value *ucontrol);
 588int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 589	struct snd_ctl_elem_value *ucontrol);
 590#define snd_soc_get_volsw_2r snd_soc_get_volsw
 591#define snd_soc_put_volsw_2r snd_soc_put_volsw
 592int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
 593	struct snd_ctl_elem_value *ucontrol);
 594int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
 595	struct snd_ctl_elem_value *ucontrol);
 596int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
 597	struct snd_ctl_elem_info *uinfo);
 598int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
 599	struct snd_ctl_elem_value *ucontrol);
 600int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
 601	struct snd_ctl_elem_value *ucontrol);
 602int snd_soc_limit_volume(struct snd_soc_card *card,
 603	const char *name, int max);
 604int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
 605		       struct snd_ctl_elem_info *uinfo);
 606int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
 607		      struct snd_ctl_elem_value *ucontrol);
 608int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
 609		      struct snd_ctl_elem_value *ucontrol);
 610int snd_soc_bytes_info_ext(struct snd_kcontrol *kcontrol,
 611	struct snd_ctl_elem_info *ucontrol);
 612int snd_soc_bytes_tlv_callback(struct snd_kcontrol *kcontrol, int op_flag,
 613	unsigned int size, unsigned int __user *tlv);
 614int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
 615	struct snd_ctl_elem_info *uinfo);
 616int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
 617	struct snd_ctl_elem_value *ucontrol);
 618int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
 619	struct snd_ctl_elem_value *ucontrol);
 620int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
 621	struct snd_ctl_elem_value *ucontrol);
 622int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
 623	struct snd_ctl_elem_value *ucontrol);
 624
 625/**
 626 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 627 *
 628 * @pin:    name of the pin to update
 629 * @mask:   bits to check for in reported jack status
 630 * @invert: if non-zero then pin is enabled when status is not reported
 631 * @list:   internal list entry
 632 */
 633struct snd_soc_jack_pin {
 634	struct list_head list;
 635	const char *pin;
 636	int mask;
 637	bool invert;
 638};
 639
 640/**
 641 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 642 *
 643 * @min_mv: start voltage in mv
 644 * @max_mv: end voltage in mv
 645 * @jack_type: type of jack that is expected for this voltage
 646 * @debounce_time: debounce_time for jack, codec driver should wait for this
 647 *		duration before reading the adc for voltages
 648 * @list:   internal list entry
 649 */
 650struct snd_soc_jack_zone {
 651	unsigned int min_mv;
 652	unsigned int max_mv;
 653	unsigned int jack_type;
 654	unsigned int debounce_time;
 655	struct list_head list;
 656};
 657
 658/**
 659 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 660 *
 661 * @gpio:         legacy gpio number
 662 * @idx:          gpio descriptor index within the function of the GPIO
 663 *                consumer device
 664 * @gpiod_dev:    GPIO consumer device
 665 * @name:         gpio name. Also as connection ID for the GPIO consumer
 666 *                device function name lookup
 667 * @report:       value to report when jack detected
 668 * @invert:       report presence in low state
 669 * @debounce_time: debounce time in ms
 670 * @wake:	  enable as wake source
 671 * @jack_status_check: callback function which overrides the detection
 672 *		       to provide more complex checks (eg, reading an
 673 *		       ADC).
 674 */
 675struct snd_soc_jack_gpio {
 676	unsigned int gpio;
 677	unsigned int idx;
 678	struct device *gpiod_dev;
 679	const char *name;
 680	int report;
 681	int invert;
 682	int debounce_time;
 683	bool wake;
 684
 685	/* private: */
 686	struct snd_soc_jack *jack;
 687	struct delayed_work work;
 688	struct notifier_block pm_notifier;
 689	struct gpio_desc *desc;
 690
 691	void *data;
 692	/* public: */
 693	int (*jack_status_check)(void *data);
 694};
 695
 696struct snd_soc_jack {
 697	struct mutex mutex;
 698	struct snd_jack *jack;
 699	struct snd_soc_card *card;
 700	struct list_head pins;
 701	int status;
 702	struct blocking_notifier_head notifier;
 703	struct list_head jack_zones;
 704};
 705
 706/* SoC PCM stream information */
 707struct snd_soc_pcm_stream {
 708	const char *stream_name;
 709	u64 formats;			/* SNDRV_PCM_FMTBIT_* */
 710	unsigned int rates;		/* SNDRV_PCM_RATE_* */
 711	unsigned int rate_min;		/* min rate */
 712	unsigned int rate_max;		/* max rate */
 713	unsigned int channels_min;	/* min channels */
 714	unsigned int channels_max;	/* max channels */
 715	unsigned int sig_bits;		/* number of bits of content */
 716};
 717
 718/* SoC audio ops */
 719struct snd_soc_ops {
 720	int (*startup)(struct snd_pcm_substream *);
 721	void (*shutdown)(struct snd_pcm_substream *);
 722	int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 723	int (*hw_free)(struct snd_pcm_substream *);
 724	int (*prepare)(struct snd_pcm_substream *);
 725	int (*trigger)(struct snd_pcm_substream *, int);
 726};
 727
 728struct snd_soc_compr_ops {
 729	int (*startup)(struct snd_compr_stream *);
 730	void (*shutdown)(struct snd_compr_stream *);
 731	int (*set_params)(struct snd_compr_stream *);
 732	int (*trigger)(struct snd_compr_stream *);
 733};
 734
 735struct snd_soc_rtdcom_list {
 736	struct snd_soc_component *component;
 737	struct list_head list; /* rtd::component_list */
 738};
 739struct snd_soc_component*
 740snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
 741		       const char *driver_name);
 742#define for_each_rtdcom(rtd, rtdcom) \
 743	list_for_each_entry(rtdcom, &(rtd)->component_list, list)
 744#define for_each_rtdcom_safe(rtd, rtdcom1, rtdcom2) \
 745	list_for_each_entry_safe(rtdcom1, rtdcom2, &(rtd)->component_list, list)
 746
 747struct snd_soc_dai_link_component {
 748	const char *name;
 749	struct device_node *of_node;
 750	const char *dai_name;
 751};
 752
 753struct snd_soc_dai_link {
 754	/* config - must be set by machine driver */
 755	const char *name;			/* Codec name */
 756	const char *stream_name;		/* Stream name */
 757
 758	/*
 759	 * You MAY specify the link's CPU-side device, either by device name,
 760	 * or by DT/OF node, but not both. If this information is omitted,
 761	 * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 762	 * must be globally unique. These fields are currently typically used
 763	 * only for codec to codec links, or systems using device tree.
 764	 */
 765	/*
 766	 * You MAY specify the DAI name of the CPU DAI. If this information is
 767	 * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 768	 * only, which only works well when that device exposes a single DAI.
 769	 */
 770	struct snd_soc_dai_link_component *cpus;
 771	unsigned int num_cpus;
 772
 773	/*
 774	 * You MUST specify the link's codec, either by device name, or by
 775	 * DT/OF node, but not both.
 776	 */
 777	/* You MUST specify the DAI name within the codec */
 778	struct snd_soc_dai_link_component *codecs;
 779	unsigned int num_codecs;
 780
 781	/*
 782	 * You MAY specify the link's platform/PCM/DMA driver, either by
 783	 * device name, or by DT/OF node, but not both. Some forms of link
 784	 * do not need a platform. In such case, platforms are not mandatory.
 785	 */
 786	struct snd_soc_dai_link_component *platforms;
 787	unsigned int num_platforms;
 788
 789	int id;	/* optional ID for machine driver link identification */
 790
 791	const struct snd_soc_pcm_stream *params;
 792	unsigned int num_params;
 793
 794	unsigned int dai_fmt;           /* format to set on init */
 795
 796	enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 797
 798	/* codec/machine specific init - e.g. add machine controls */
 799	int (*init)(struct snd_soc_pcm_runtime *rtd);
 800
 
 
 
 801	/* optional hw_params re-writing for BE and FE sync */
 802	int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 803			struct snd_pcm_hw_params *params);
 804
 805	/* machine stream operations */
 806	const struct snd_soc_ops *ops;
 807	const struct snd_soc_compr_ops *compr_ops;
 808
 809	/* Mark this pcm with non atomic ops */
 810	bool nonatomic;
 811
 812	/* For unidirectional dai links */
 813	unsigned int playback_only:1;
 814	unsigned int capture_only:1;
 815
 816	/* Keep DAI active over suspend */
 817	unsigned int ignore_suspend:1;
 818
 819	/* Symmetry requirements */
 820	unsigned int symmetric_rates:1;
 821	unsigned int symmetric_channels:1;
 822	unsigned int symmetric_samplebits:1;
 823
 824	/* Do not create a PCM for this DAI link (Backend link) */
 825	unsigned int no_pcm:1;
 826
 827	/* This DAI link can route to other DAI links at runtime (Frontend)*/
 828	unsigned int dynamic:1;
 829
 830	/* DPCM capture and Playback support */
 831	unsigned int dpcm_capture:1;
 832	unsigned int dpcm_playback:1;
 833
 834	/* DPCM used FE & BE merged format */
 835	unsigned int dpcm_merged_format:1;
 836	/* DPCM used FE & BE merged channel */
 837	unsigned int dpcm_merged_chan:1;
 838	/* DPCM used FE & BE merged rate */
 839	unsigned int dpcm_merged_rate:1;
 840
 841	/* pmdown_time is ignored at stop */
 842	unsigned int ignore_pmdown_time:1;
 843
 844	/* Do not create a PCM for this DAI link (Backend link) */
 845	unsigned int ignore:1;
 846
 847	struct list_head list; /* DAI link list of the soc card */
 
 
 
 
 
 
 848	struct snd_soc_dobj dobj; /* For topology */
 
 849};
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 850#define for_each_link_codecs(link, i, codec)				\
 851	for ((i) = 0;							\
 852	     ((i) < link->num_codecs) && ((codec) = &link->codecs[i]);	\
 
 853	     (i)++)
 854
 855#define for_each_link_platforms(link, i, platform)			\
 856	for ((i) = 0;							\
 857	     ((i) < link->num_platforms) &&				\
 858	     ((platform) = &link->platforms[i]);			\
 
 
 
 
 
 
 859	     (i)++)
 860
 861/*
 862 * Sample 1 : Single CPU/Codec/Platform
 863 *
 864 * SND_SOC_DAILINK_DEFS(test,
 865 *	DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai")),
 866 *	DAILINK_COMP_ARRAY(COMP_CODEC("codec", "codec_dai")),
 867 *	DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
 868 *
 869 * struct snd_soc_dai_link link = {
 870 *	...
 871 *	SND_SOC_DAILINK_REG(test),
 872 * };
 873 *
 874 * Sample 2 : Multi CPU/Codec, no Platform
 875 *
 876 * SND_SOC_DAILINK_DEFS(test,
 877 *	DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
 878 *			   COMP_CPU("cpu_dai2")),
 879 *	DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
 880 *			   COMP_CODEC("codec2", "codec_dai2")));
 881 *
 882 * struct snd_soc_dai_link link = {
 883 *	...
 884 *	SND_SOC_DAILINK_REG(test),
 885 * };
 886 *
 887 * Sample 3 : Define each CPU/Codec/Platform manually
 888 *
 889 * SND_SOC_DAILINK_DEF(test_cpu,
 890 *		DAILINK_COMP_ARRAY(COMP_CPU("cpu_dai1"),
 891 *				   COMP_CPU("cpu_dai2")));
 892 * SND_SOC_DAILINK_DEF(test_codec,
 893 *		DAILINK_COMP_ARRAY(COMP_CODEC("codec1", "codec_dai1"),
 894 *				   COMP_CODEC("codec2", "codec_dai2")));
 895 * SND_SOC_DAILINK_DEF(test_platform,
 896 *		DAILINK_COMP_ARRAY(COMP_PLATFORM("platform")));
 897 *
 898 * struct snd_soc_dai_link link = {
 899 *	...
 900 *	SND_SOC_DAILINK_REG(test_cpu,
 901 *			    test_codec,
 902 *			    test_platform),
 903 * };
 904 *
 905 * Sample 4 : Sample3 without platform
 906 *
 907 * struct snd_soc_dai_link link = {
 908 *	...
 909 *	SND_SOC_DAILINK_REG(test_cpu,
 910 *			    test_codec);
 911 * };
 912 */
 913
 914#define SND_SOC_DAILINK_REG1(name)	 SND_SOC_DAILINK_REG3(name##_cpus, name##_codecs, name##_platforms)
 915#define SND_SOC_DAILINK_REG2(cpu, codec) SND_SOC_DAILINK_REG3(cpu, codec, null_dailink_component)
 916#define SND_SOC_DAILINK_REG3(cpu, codec, platform)	\
 917	.cpus		= cpu,				\
 918	.num_cpus	= ARRAY_SIZE(cpu),		\
 919	.codecs		= codec,			\
 920	.num_codecs	= ARRAY_SIZE(codec),		\
 921	.platforms	= platform,			\
 922	.num_platforms	= ARRAY_SIZE(platform)
 923
 924#define SND_SOC_DAILINK_REGx(_1, _2, _3, func, ...) func
 925#define SND_SOC_DAILINK_REG(...) \
 926	SND_SOC_DAILINK_REGx(__VA_ARGS__,		\
 927			SND_SOC_DAILINK_REG3,	\
 928			SND_SOC_DAILINK_REG2,	\
 929			SND_SOC_DAILINK_REG1)(__VA_ARGS__)
 930
 931#define SND_SOC_DAILINK_DEF(name, def...)		\
 932	static struct snd_soc_dai_link_component name[]	= { def }
 933
 934#define SND_SOC_DAILINK_DEFS(name, cpu, codec, platform...)	\
 935	SND_SOC_DAILINK_DEF(name##_cpus, cpu);			\
 936	SND_SOC_DAILINK_DEF(name##_codecs, codec);		\
 937	SND_SOC_DAILINK_DEF(name##_platforms, platform)
 938
 939#define DAILINK_COMP_ARRAY(param...)	param
 940#define COMP_EMPTY()			{ }
 941#define COMP_CPU(_dai)			{ .dai_name = _dai, }
 942#define COMP_CODEC(_name, _dai)		{ .name = _name, .dai_name = _dai, }
 943#define COMP_PLATFORM(_name)		{ .name = _name }
 944#define COMP_AUX(_name)			{ .name = _name }
 
 945#define COMP_DUMMY()			{ .name = "snd-soc-dummy", .dai_name = "snd-soc-dummy-dai", }
 946
 947extern struct snd_soc_dai_link_component null_dailink_component[0];
 948
 949
 950struct snd_soc_codec_conf {
 951	/*
 952	 * specify device either by device name, or by
 953	 * DT/OF node, but not both.
 954	 */
 955	const char *dev_name;
 956	struct device_node *of_node;
 957
 958	/*
 959	 * optional map of kcontrol, widget and path name prefixes that are
 960	 * associated per device
 961	 */
 962	const char *name_prefix;
 963};
 964
 965struct snd_soc_aux_dev {
 966	/*
 967	 * specify multi-codec either by device name, or by
 968	 * DT/OF node, but not both.
 969	 */
 970	struct snd_soc_dai_link_component dlc;
 971
 972	/* codec/machine specific init - e.g. add machine controls */
 973	int (*init)(struct snd_soc_component *component);
 974};
 975
 976/* SoC card */
 977struct snd_soc_card {
 978	const char *name;
 979	const char *long_name;
 980	const char *driver_name;
 
 
 981	char dmi_longname[80];
 
 982	char topology_shortname[32];
 983
 984	struct device *dev;
 985	struct snd_card *snd_card;
 986	struct module *owner;
 987
 988	struct mutex mutex;
 989	struct mutex dapm_mutex;
 990
 991	/* Mutex for PCM operations */
 992	struct mutex pcm_mutex;
 993	enum snd_soc_pcm_subclass pcm_subclass;
 994
 995	spinlock_t dpcm_lock;
 996
 997	bool instantiated;
 998	bool topology_shortname_created;
 999
1000	int (*probe)(struct snd_soc_card *card);
1001	int (*late_probe)(struct snd_soc_card *card);
1002	int (*remove)(struct snd_soc_card *card);
1003
1004	/* the pre and post PM functions are used to do any PM work before and
1005	 * after the codec and DAI's do any PM work. */
1006	int (*suspend_pre)(struct snd_soc_card *card);
1007	int (*suspend_post)(struct snd_soc_card *card);
1008	int (*resume_pre)(struct snd_soc_card *card);
1009	int (*resume_post)(struct snd_soc_card *card);
1010
1011	/* callbacks */
1012	int (*set_bias_level)(struct snd_soc_card *,
1013			      struct snd_soc_dapm_context *dapm,
1014			      enum snd_soc_bias_level level);
1015	int (*set_bias_level_post)(struct snd_soc_card *,
1016				   struct snd_soc_dapm_context *dapm,
1017				   enum snd_soc_bias_level level);
1018
1019	int (*add_dai_link)(struct snd_soc_card *,
1020			    struct snd_soc_dai_link *link);
1021	void (*remove_dai_link)(struct snd_soc_card *,
1022			    struct snd_soc_dai_link *link);
1023
1024	long pmdown_time;
1025
1026	/* CPU <--> Codec DAI links  */
1027	struct snd_soc_dai_link *dai_link;  /* predefined links only */
1028	int num_links;  /* predefined links only */
1029	struct list_head dai_link_list; /* all links */
1030
1031	struct list_head rtd_list;
1032	int num_rtd;
1033
1034	/* optional codec specific configuration */
1035	struct snd_soc_codec_conf *codec_conf;
1036	int num_configs;
1037
1038	/*
1039	 * optional auxiliary devices such as amplifiers or codecs with DAI
1040	 * link unused
1041	 */
1042	struct snd_soc_aux_dev *aux_dev;
1043	int num_aux_devs;
1044	struct list_head aux_comp_list;
1045
1046	const struct snd_kcontrol_new *controls;
1047	int num_controls;
1048
1049	/*
1050	 * Card-specific routes and widgets.
1051	 * Note: of_dapm_xxx for Device Tree; Otherwise for driver build-in.
1052	 */
1053	const struct snd_soc_dapm_widget *dapm_widgets;
1054	int num_dapm_widgets;
1055	const struct snd_soc_dapm_route *dapm_routes;
1056	int num_dapm_routes;
1057	const struct snd_soc_dapm_widget *of_dapm_widgets;
1058	int num_of_dapm_widgets;
1059	const struct snd_soc_dapm_route *of_dapm_routes;
1060	int num_of_dapm_routes;
1061	bool fully_routed;
1062
1063	/* lists of probed devices belonging to this card */
1064	struct list_head component_dev_list;
1065	struct list_head list;
1066
1067	struct list_head widgets;
1068	struct list_head paths;
1069	struct list_head dapm_list;
1070	struct list_head dapm_dirty;
1071
1072	/* attached dynamic objects */
1073	struct list_head dobj_list;
1074
1075	/* Generic DAPM context for the card */
1076	struct snd_soc_dapm_context dapm;
1077	struct snd_soc_dapm_stats dapm_stats;
1078	struct snd_soc_dapm_update *update;
1079
1080#ifdef CONFIG_DEBUG_FS
1081	struct dentry *debugfs_card_root;
1082#endif
1083#ifdef CONFIG_PM_SLEEP
1084	struct work_struct deferred_resume_work;
1085#endif
1086	u32 pop_time;
1087
 
 
 
 
 
 
 
 
1088	void *drvdata;
1089};
1090#define for_each_card_prelinks(card, i, link)				\
1091	for ((i) = 0;							\
1092	     ((i) < (card)->num_links) && ((link) = &(card)->dai_link[i]); \
1093	     (i)++)
1094#define for_each_card_pre_auxs(card, i, aux)				\
1095	for ((i) = 0;							\
1096	     ((i) < (card)->num_aux_devs) && ((aux) = &(card)->aux_dev[i]); \
1097	     (i)++)
1098
1099#define for_each_card_links(card, link)				\
1100	list_for_each_entry(link, &(card)->dai_link_list, list)
1101#define for_each_card_links_safe(card, link, _link)			\
1102	list_for_each_entry_safe(link, _link, &(card)->dai_link_list, list)
1103
1104#define for_each_card_rtds(card, rtd)			\
1105	list_for_each_entry(rtd, &(card)->rtd_list, list)
1106#define for_each_card_rtds_safe(card, rtd, _rtd)	\
1107	list_for_each_entry_safe(rtd, _rtd, &(card)->rtd_list, list)
1108
1109#define for_each_card_auxs(card, component)			\
1110	list_for_each_entry(component, &card->aux_comp_list, card_aux_list)
1111#define for_each_card_auxs_safe(card, component, _comp)	\
1112	list_for_each_entry_safe(component, _comp,	\
1113				 &card->aux_comp_list, card_aux_list)
1114
1115#define for_each_card_components(card, component)			\
1116	list_for_each_entry(component, &(card)->component_dev_list, card_list)
1117
 
 
 
 
 
 
 
 
1118/* SoC machine DAI configuration, glues a codec and cpu DAI together */
1119struct snd_soc_pcm_runtime {
1120	struct device *dev;
1121	struct snd_soc_card *card;
1122	struct snd_soc_dai_link *dai_link;
1123	struct snd_pcm_ops ops;
1124
1125	unsigned int params_select; /* currently selected param for dai link */
1126
1127	/* Dynamic PCM BE runtime data */
1128	struct snd_soc_dpcm_runtime dpcm[2];
1129
1130	long pmdown_time;
1131
1132	/* runtime devices */
1133	struct snd_pcm *pcm;
1134	struct snd_compr *compr;
1135	struct snd_soc_dai *codec_dai;
1136	struct snd_soc_dai *cpu_dai;
1137
1138	struct snd_soc_dai **codec_dais;
 
 
 
 
 
 
 
1139	unsigned int num_codecs;
 
 
 
 
1140
1141	struct delayed_work delayed_work;
 
1142#ifdef CONFIG_DEBUG_FS
1143	struct dentry *debugfs_dpcm_root;
1144#endif
1145
1146	unsigned int num; /* 0-based and monotonic increasing */
1147	struct list_head list; /* rtd list of the soc card */
1148	struct list_head component_list; /* list of connected components */
 
 
 
 
 
1149
1150	/* bit field */
1151	unsigned int dev_registered:1;
1152	unsigned int pop_wait:1;
1153	unsigned int fe_compr:1; /* for Dynamic PCM */
 
 
 
1154};
1155#define for_each_rtd_codec_dai(rtd, i, dai)\
1156	for ((i) = 0;						       \
1157	     ((i) < rtd->num_codecs) && ((dai) = rtd->codec_dais[i]); \
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1158	     (i)++)
1159#define for_each_rtd_codec_dai_rollback(rtd, i, dai)		\
1160	for (; ((--i) >= 0) && ((dai) = rtd->codec_dais[i]);)
1161
 
1162
1163/* mixer control */
1164struct soc_mixer_control {
1165	int min, max, platform_max;
1166	int reg, rreg;
1167	unsigned int shift, rshift;
1168	unsigned int sign_bit;
1169	unsigned int invert:1;
1170	unsigned int autodisable:1;
 
1171	struct snd_soc_dobj dobj;
 
1172};
1173
1174struct soc_bytes {
1175	int base;
1176	int num_regs;
1177	u32 mask;
1178};
1179
1180struct soc_bytes_ext {
1181	int max;
 
1182	struct snd_soc_dobj dobj;
1183
1184	/* used for TLV byte control */
1185	int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
1186			unsigned int size);
1187	int (*put)(struct snd_kcontrol *kcontrol, const unsigned int __user *bytes,
1188			unsigned int size);
1189};
1190
1191/* multi register control */
1192struct soc_mreg_control {
1193	long min, max;
1194	unsigned int regbase, regcount, nbits, invert;
1195};
1196
1197/* enumerated kcontrol */
1198struct soc_enum {
1199	int reg;
1200	unsigned char shift_l;
1201	unsigned char shift_r;
1202	unsigned int items;
1203	unsigned int mask;
1204	const char * const *texts;
1205	const unsigned int *values;
1206	unsigned int autodisable:1;
 
1207	struct snd_soc_dobj dobj;
 
1208};
1209
1210/* device driver data */
1211
1212static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1213		void *data)
1214{
1215	card->drvdata = data;
1216}
1217
1218static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1219{
1220	return card->drvdata;
1221}
1222
1223static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1224{
1225	if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1226		return 0;
1227	/*
1228	 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1229	 * mc->reg != mc->rreg means that the control is
1230	 * stereo (bits in one register or in two registers)
1231	 */
1232	return 1;
1233}
1234
1235static inline unsigned int snd_soc_enum_val_to_item(struct soc_enum *e,
1236	unsigned int val)
1237{
1238	unsigned int i;
1239
1240	if (!e->values)
1241		return val;
1242
1243	for (i = 0; i < e->items; i++)
1244		if (val == e->values[i])
1245			return i;
1246
1247	return 0;
1248}
1249
1250static inline unsigned int snd_soc_enum_item_to_val(struct soc_enum *e,
1251	unsigned int item)
1252{
1253	if (!e->values)
1254		return item;
1255
1256	return e->values[item];
1257}
1258
1259/**
1260 * snd_soc_kcontrol_component() - Returns the component that registered the
1261 *  control
1262 * @kcontrol: The control for which to get the component
1263 *
1264 * Note: This function will work correctly if the control has been registered
1265 * for a component. With snd_soc_add_codec_controls() or via table based
1266 * setup for either a CODEC or component driver. Otherwise the behavior is
1267 * undefined.
1268 */
1269static inline struct snd_soc_component *snd_soc_kcontrol_component(
1270	struct snd_kcontrol *kcontrol)
1271{
1272	return snd_kcontrol_chip(kcontrol);
1273}
1274
1275int snd_soc_util_init(void);
1276void snd_soc_util_exit(void);
1277
1278int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1279			       const char *propname);
1280int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
1281					  const char *propname);
1282int snd_soc_of_get_slot_mask(struct device_node *np,
1283			     const char *prop_name,
1284			     unsigned int *mask);
1285int snd_soc_of_parse_tdm_slot(struct device_node *np,
1286			      unsigned int *tx_mask,
1287			      unsigned int *rx_mask,
1288			      unsigned int *slots,
1289			      unsigned int *slot_width);
1290void snd_soc_of_parse_node_prefix(struct device_node *np,
1291				   struct snd_soc_codec_conf *codec_conf,
1292				   struct device_node *of_node,
1293				   const char *propname);
1294static inline
1295void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
1296				   struct snd_soc_codec_conf *codec_conf,
1297				   struct device_node *of_node,
1298				   const char *propname)
1299{
1300	snd_soc_of_parse_node_prefix(card->dev->of_node,
1301				     codec_conf, of_node, propname);
1302}
1303
1304int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1305				   const char *propname);
1306unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
1307				     const char *prefix,
1308				     struct device_node **bitclkmaster,
1309				     struct device_node **framemaster);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1310int snd_soc_get_dai_id(struct device_node *ep);
1311int snd_soc_get_dai_name(struct of_phandle_args *args,
1312			 const char **dai_name);
1313int snd_soc_of_get_dai_name(struct device_node *of_node,
1314			    const char **dai_name);
1315int snd_soc_of_get_dai_link_codecs(struct device *dev,
1316				   struct device_node *of_node,
1317				   struct snd_soc_dai_link *dai_link);
1318void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link);
1319
1320int snd_soc_add_dai_link(struct snd_soc_card *card,
1321				struct snd_soc_dai_link *dai_link);
1322void snd_soc_remove_dai_link(struct snd_soc_card *card,
1323			     struct snd_soc_dai_link *dai_link);
1324struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
1325					       int id, const char *name,
1326					       const char *stream_name);
1327
1328int snd_soc_register_dai(struct snd_soc_component *component,
1329	struct snd_soc_dai_driver *dai_drv);
 
 
 
1330
1331struct snd_soc_dai *snd_soc_find_dai(
1332	const struct snd_soc_dai_link_component *dlc);
 
 
1333
1334#include <sound/soc-dai.h>
1335
1336static inline
1337struct snd_soc_dai *snd_soc_card_get_codec_dai(struct snd_soc_card *card,
1338					       const char *dai_name)
1339{
1340	struct snd_soc_pcm_runtime *rtd;
1341
1342	list_for_each_entry(rtd, &card->rtd_list, list) {
1343		if (!strcmp(rtd->codec_dai->name, dai_name))
1344			return rtd->codec_dai;
1345	}
1346
1347	return NULL;
1348}
1349
1350static inline
1351int snd_soc_fixup_dai_links_platform_name(struct snd_soc_card *card,
1352					  const char *platform_name)
1353{
1354	struct snd_soc_dai_link *dai_link;
1355	const char *name;
1356	int i;
1357
1358	if (!platform_name) /* nothing to do */
1359		return 0;
1360
1361	/* set platform name for each dailink */
1362	for_each_card_prelinks(card, i, dai_link) {
1363		name = devm_kstrdup(card->dev, platform_name, GFP_KERNEL);
1364		if (!name)
1365			return -ENOMEM;
1366
1367		if (!dai_link->platforms)
1368			return -EINVAL;
1369
 
 
 
 
1370		/* only single platform is supported for now */
1371		dai_link->platforms->name = name;
1372	}
1373
1374	return 0;
1375}
1376
1377#ifdef CONFIG_DEBUG_FS
1378extern struct dentry *snd_soc_debugfs_root;
1379#endif
1380
1381extern const struct dev_pm_ops snd_soc_pm_ops;
1382
1383/* Helper functions */
1384static inline void snd_soc_dapm_mutex_lock(struct snd_soc_dapm_context *dapm)
1385{
1386	mutex_lock_nested(&dapm->card->dapm_mutex, SND_SOC_DAPM_CLASS_RUNTIME);
1387}
1388
1389static inline void snd_soc_dapm_mutex_unlock(struct snd_soc_dapm_context *dapm)
1390{
1391	mutex_unlock(&dapm->card->dapm_mutex);
1392}
1393
1394#include <sound/soc-component.h>
 
 
1395
1396#endif