linux/include/sound/soc.h
<<
>>
Prefs
   1/*
   2 * linux/sound/soc.h -- ALSA SoC Layer
   3 *
   4 * Author:              Liam Girdwood
   5 * Created:             Aug 11th 2005
   6 * Copyright:   Wolfson Microelectronics. PLC.
   7 *
   8 * This program is free software; you can redistribute it and/or modify
   9 * it under the terms of the GNU General Public License version 2 as
  10 * published by the Free Software Foundation.
  11 */
  12
  13#ifndef __LINUX_SND_SOC_H
  14#define __LINUX_SND_SOC_H
  15
  16#include <linux/platform_device.h>
  17#include <linux/types.h>
  18#include <linux/notifier.h>
  19#include <linux/workqueue.h>
  20#include <linux/interrupt.h>
  21#include <linux/kernel.h>
  22#include <linux/regmap.h>
  23#include <linux/log2.h>
  24#include <sound/core.h>
  25#include <sound/pcm.h>
  26#include <sound/compress_driver.h>
  27#include <sound/control.h>
  28#include <sound/ac97_codec.h>
  29
  30/*
  31 * Convenience kcontrol builders
  32 */
  33#define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert) \
  34        ((unsigned long)&(struct soc_mixer_control) \
  35        {.reg = xreg, .rreg = xreg, .shift = shift_left, \
  36        .rshift = shift_right, .max = xmax, .platform_max = xmax, \
  37        .invert = xinvert})
  38#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
  39        SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert)
  40#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
  41        ((unsigned long)&(struct soc_mixer_control) \
  42        {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
  43#define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
  44        ((unsigned long)&(struct soc_mixer_control) \
  45        {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  46        .max = xmax, .platform_max = xmax, .invert = xinvert})
  47#define SOC_DOUBLE_R_RANGE_VALUE(xlreg, xrreg, xshift, xmin, xmax, xinvert) \
  48        ((unsigned long)&(struct soc_mixer_control) \
  49        {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
  50        .min = xmin, .max = xmax, .platform_max = xmax, .invert = xinvert})
  51#define SOC_SINGLE(xname, reg, shift, max, invert) \
  52{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  53        .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  54        .put = snd_soc_put_volsw, \
  55        .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
  56#define SOC_SINGLE_RANGE(xname, xreg, xshift, xmin, xmax, xinvert) \
  57{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  58        .info = snd_soc_info_volsw_range, .get = snd_soc_get_volsw_range, \
  59        .put = snd_soc_put_volsw_range, \
  60        .private_value = (unsigned long)&(struct soc_mixer_control) \
  61                {.reg = xreg, .shift = xshift, .min = xmin,\
  62                 .max = xmax, .platform_max = xmax, .invert = xinvert} }
  63#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
  64{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  65        .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  66                 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  67        .tlv.p = (tlv_array), \
  68        .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  69        .put = snd_soc_put_volsw, \
  70        .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
  71#define SOC_SINGLE_SX_TLV(xname, xreg, xshift, xmin, xmax, tlv_array) \
  72{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  73        .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
  74        SNDRV_CTL_ELEM_ACCESS_READWRITE, \
  75        .tlv.p  = (tlv_array),\
  76        .info = snd_soc_info_volsw, \
  77        .get = snd_soc_get_volsw_sx,\
  78        .put = snd_soc_put_volsw_sx, \
  79        .private_value = (unsigned long)&(struct soc_mixer_control) \
  80                {.reg = xreg, .rreg = xreg, \
  81                .shift = xshift, .rshift = xshift, \
  82                .max = xmax, .min = xmin} }
  83#define SOC_SINGLE_RANGE_TLV(xname, xreg, xshift, xmin, xmax, xinvert, tlv_array) \
  84{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  85        .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  86                 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  87        .tlv.p = (tlv_array), \
  88        .info = snd_soc_info_volsw_range, \
  89        .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
  90        .private_value = (unsigned long)&(struct soc_mixer_control) \
  91                {.reg = xreg, .shift = xshift, .min = xmin,\
  92                 .max = xmax, .platform_max = xmax, .invert = xinvert} }
  93#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
  94{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  95        .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
  96        .put = snd_soc_put_volsw, \
  97        .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
  98                                          max, invert) }
  99#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
 100{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 101        .info = snd_soc_info_volsw, \
 102        .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 103        .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 104                                            xmax, xinvert) }
 105#define SOC_DOUBLE_R_RANGE(xname, reg_left, reg_right, xshift, xmin, \
 106                           xmax, xinvert)               \
 107{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 108        .info = snd_soc_info_volsw_range, \
 109        .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 110        .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
 111                                            xshift, xmin, xmax, xinvert) }
 112#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
 113{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 114        .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 115                 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 116        .tlv.p = (tlv_array), \
 117        .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
 118        .put = snd_soc_put_volsw, \
 119        .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
 120                                          max, invert) }
 121#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
 122{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 123        .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 124                 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 125        .tlv.p = (tlv_array), \
 126        .info = snd_soc_info_volsw, \
 127        .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
 128        .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 129                                            xmax, xinvert) }
 130#define SOC_DOUBLE_R_RANGE_TLV(xname, reg_left, reg_right, xshift, xmin, \
 131                               xmax, xinvert, tlv_array)                \
 132{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 133        .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 134                 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 135        .tlv.p = (tlv_array), \
 136        .info = snd_soc_info_volsw_range, \
 137        .get = snd_soc_get_volsw_range, .put = snd_soc_put_volsw_range, \
 138        .private_value = SOC_DOUBLE_R_RANGE_VALUE(reg_left, reg_right, \
 139                                            xshift, xmin, xmax, xinvert) }
 140#define SOC_DOUBLE_R_SX_TLV(xname, xreg, xrreg, xshift, xmin, xmax, tlv_array) \
 141{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 142        .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 143        SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 144        .tlv.p  = (tlv_array), \
 145        .info = snd_soc_info_volsw, \
 146        .get = snd_soc_get_volsw_sx, \
 147        .put = snd_soc_put_volsw_sx, \
 148        .private_value = (unsigned long)&(struct soc_mixer_control) \
 149                {.reg = xreg, .rreg = xrreg, \
 150                .shift = xshift, .rshift = xshift, \
 151                .max = xmax, .min = xmin} }
 152#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
 153{       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 154        .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 155                  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 156        .tlv.p  = (tlv_array), \
 157        .info   = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
 158        .put    = snd_soc_put_volsw_s8, \
 159        .private_value = (unsigned long)&(struct soc_mixer_control) \
 160                {.reg = xreg, .min = xmin, .max = xmax, \
 161                 .platform_max = xmax} }
 162#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
 163{       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 164        .max = xmax, .texts = xtexts, \
 165        .mask = xmax ? roundup_pow_of_two(xmax) - 1 : 0}
 166#define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
 167        SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
 168#define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
 169{       .max = xmax, .texts = xtexts }
 170#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
 171{       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
 172        .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
 173#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
 174        SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
 175#define SOC_ENUM(xname, xenum) \
 176{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 177        .info = snd_soc_info_enum_double, \
 178        .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
 179        .private_value = (unsigned long)&xenum }
 180#define SOC_VALUE_ENUM(xname, xenum) \
 181{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
 182        .info = snd_soc_info_enum_double, \
 183        .get = snd_soc_get_value_enum_double, \
 184        .put = snd_soc_put_value_enum_double, \
 185        .private_value = (unsigned long)&xenum }
 186#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 187         xhandler_get, xhandler_put) \
 188{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 189        .info = snd_soc_info_volsw, \
 190        .get = xhandler_get, .put = xhandler_put, \
 191        .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
 192#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
 193         xhandler_get, xhandler_put) \
 194{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
 195        .info = snd_soc_info_volsw, \
 196        .get = xhandler_get, .put = xhandler_put, \
 197        .private_value = \
 198                SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert) }
 199#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 200         xhandler_get, xhandler_put, tlv_array) \
 201{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 202        .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 203                 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 204        .tlv.p = (tlv_array), \
 205        .info = snd_soc_info_volsw, \
 206        .get = xhandler_get, .put = xhandler_put, \
 207        .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
 208#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
 209         xhandler_get, xhandler_put, tlv_array) \
 210{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 211        .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 212                 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 213        .tlv.p = (tlv_array), \
 214        .info = snd_soc_info_volsw, \
 215        .get = xhandler_get, .put = xhandler_put, \
 216        .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
 217                                          xmax, xinvert) }
 218#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
 219         xhandler_get, xhandler_put, tlv_array) \
 220{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 221        .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
 222                 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
 223        .tlv.p = (tlv_array), \
 224        .info = snd_soc_info_volsw, \
 225        .get = xhandler_get, .put = xhandler_put, \
 226        .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
 227                                            xmax, xinvert) }
 228#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
 229{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 230        .info = snd_soc_info_bool_ext, \
 231        .get = xhandler_get, .put = xhandler_put, \
 232        .private_value = xdata }
 233#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 234{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 235        .info = snd_soc_info_enum_ext, \
 236        .get = xhandler_get, .put = xhandler_put, \
 237        .private_value = (unsigned long)&xenum }
 238
 239#define SND_SOC_BYTES(xname, xbase, xregs)                    \
 240{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 241        .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 242        .put = snd_soc_bytes_put, .private_value =            \
 243                ((unsigned long)&(struct soc_bytes)           \
 244                {.base = xbase, .num_regs = xregs }) }
 245
 246#define SND_SOC_BYTES_MASK(xname, xbase, xregs, xmask)        \
 247{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
 248        .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
 249        .put = snd_soc_bytes_put, .private_value =            \
 250                ((unsigned long)&(struct soc_bytes)           \
 251                {.base = xbase, .num_regs = xregs,            \
 252                 .mask = xmask }) }
 253
 254#define SOC_SINGLE_XR_SX(xname, xregbase, xregcount, xnbits, \
 255                xmin, xmax, xinvert) \
 256{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
 257        .info = snd_soc_info_xr_sx, .get = snd_soc_get_xr_sx, \
 258        .put = snd_soc_put_xr_sx, \
 259        .private_value = (unsigned long)&(struct soc_mreg_control) \
 260                {.regbase = xregbase, .regcount = xregcount, .nbits = xnbits, \
 261                .invert = xinvert, .min = xmin, .max = xmax} }
 262
 263#define SOC_SINGLE_STROBE(xname, xreg, xshift, xinvert) \
 264        SOC_SINGLE_EXT(xname, xreg, xshift, 1, xinvert, \
 265                snd_soc_get_strobe, snd_soc_put_strobe)
 266
 267/*
 268 * Simplified versions of above macros, declaring a struct and calculating
 269 * ARRAY_SIZE internally
 270 */
 271#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
 272        struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
 273                                                ARRAY_SIZE(xtexts), xtexts)
 274#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
 275        SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
 276#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
 277        struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
 278#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
 279        struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
 280                                                        ARRAY_SIZE(xtexts), xtexts, xvalues)
 281#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
 282        SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
 283
 284/*
 285 * Component probe and remove ordering levels for components with runtime
 286 * dependencies.
 287 */
 288#define SND_SOC_COMP_ORDER_FIRST                -2
 289#define SND_SOC_COMP_ORDER_EARLY                -1
 290#define SND_SOC_COMP_ORDER_NORMAL               0
 291#define SND_SOC_COMP_ORDER_LATE         1
 292#define SND_SOC_COMP_ORDER_LAST         2
 293
 294/*
 295 * Bias levels
 296 *
 297 * @ON:      Bias is fully on for audio playback and capture operations.
 298 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 299 *           stream start and stop operations.
 300 * @STANDBY: Low power standby state when no playback/capture operations are
 301 *           in progress. NOTE: The transition time between STANDBY and ON
 302 *           should be as fast as possible and no longer than 10ms.
 303 * @OFF:     Power Off. No restrictions on transition times.
 304 */
 305enum snd_soc_bias_level {
 306        SND_SOC_BIAS_OFF = 0,
 307        SND_SOC_BIAS_STANDBY = 1,
 308        SND_SOC_BIAS_PREPARE = 2,
 309        SND_SOC_BIAS_ON = 3,
 310};
 311
 312struct device_node;
 313struct snd_jack;
 314struct snd_soc_card;
 315struct snd_soc_pcm_stream;
 316struct snd_soc_ops;
 317struct snd_soc_pcm_runtime;
 318struct snd_soc_dai;
 319struct snd_soc_dai_driver;
 320struct snd_soc_platform;
 321struct snd_soc_dai_link;
 322struct snd_soc_platform_driver;
 323struct snd_soc_codec;
 324struct snd_soc_codec_driver;
 325struct soc_enum;
 326struct snd_soc_jack;
 327struct snd_soc_jack_zone;
 328struct snd_soc_jack_pin;
 329struct snd_soc_cache_ops;
 330#include <sound/soc-dapm.h>
 331#include <sound/soc-dpcm.h>
 332
 333#ifdef CONFIG_GPIOLIB
 334struct snd_soc_jack_gpio;
 335#endif
 336
 337typedef int (*hw_write_t)(void *,const char* ,int);
 338
 339extern struct snd_ac97_bus_ops soc_ac97_ops;
 340
 341enum snd_soc_control_type {
 342        SND_SOC_I2C = 1,
 343        SND_SOC_SPI,
 344        SND_SOC_REGMAP,
 345};
 346
 347enum snd_soc_compress_type {
 348        SND_SOC_FLAT_COMPRESSION = 1,
 349};
 350
 351enum snd_soc_pcm_subclass {
 352        SND_SOC_PCM_CLASS_PCM   = 0,
 353        SND_SOC_PCM_CLASS_BE    = 1,
 354};
 355
 356enum snd_soc_card_subclass {
 357        SND_SOC_CARD_CLASS_INIT         = 0,
 358        SND_SOC_CARD_CLASS_RUNTIME      = 1,
 359};
 360
 361int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
 362                             int source, unsigned int freq, int dir);
 363int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
 364                          unsigned int freq_in, unsigned int freq_out);
 365
 366int snd_soc_register_card(struct snd_soc_card *card);
 367int snd_soc_unregister_card(struct snd_soc_card *card);
 368int snd_soc_suspend(struct device *dev);
 369int snd_soc_resume(struct device *dev);
 370int snd_soc_poweroff(struct device *dev);
 371int snd_soc_register_platform(struct device *dev,
 372                struct snd_soc_platform_driver *platform_drv);
 373void snd_soc_unregister_platform(struct device *dev);
 374int snd_soc_register_codec(struct device *dev,
 375                const struct snd_soc_codec_driver *codec_drv,
 376                struct snd_soc_dai_driver *dai_drv, int num_dai);
 377void snd_soc_unregister_codec(struct device *dev);
 378int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
 379                                    unsigned int reg);
 380int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
 381                                    unsigned int reg);
 382int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
 383                                    unsigned int reg);
 384int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
 385                               int addr_bits, int data_bits,
 386                               enum snd_soc_control_type control);
 387int snd_soc_cache_sync(struct snd_soc_codec *codec);
 388int snd_soc_cache_init(struct snd_soc_codec *codec);
 389int snd_soc_cache_exit(struct snd_soc_codec *codec);
 390int snd_soc_cache_write(struct snd_soc_codec *codec,
 391                        unsigned int reg, unsigned int value);
 392int snd_soc_cache_read(struct snd_soc_codec *codec,
 393                       unsigned int reg, unsigned int *value);
 394int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
 395                                      unsigned int reg);
 396int snd_soc_default_readable_register(struct snd_soc_codec *codec,
 397                                      unsigned int reg);
 398int snd_soc_default_writable_register(struct snd_soc_codec *codec,
 399                                      unsigned int reg);
 400int snd_soc_platform_read(struct snd_soc_platform *platform,
 401                                        unsigned int reg);
 402int snd_soc_platform_write(struct snd_soc_platform *platform,
 403                                        unsigned int reg, unsigned int val);
 404int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
 405int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num);
 406
 407struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
 408                const char *dai_link, int stream);
 409struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 410                const char *dai_link);
 411
 412/* Utility functions to get clock rates from various things */
 413int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
 414int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
 415int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
 416int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
 417
 418/* set runtime hw params */
 419int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 420        const struct snd_pcm_hardware *hw);
 421
 422int snd_soc_platform_trigger(struct snd_pcm_substream *substream,
 423                int cmd, struct snd_soc_platform *platform);
 424
 425/* Jack reporting */
 426int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
 427                     struct snd_soc_jack *jack);
 428void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
 429int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
 430                          struct snd_soc_jack_pin *pins);
 431void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
 432                                    struct notifier_block *nb);
 433void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
 434                                      struct notifier_block *nb);
 435int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
 436                          struct snd_soc_jack_zone *zones);
 437int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
 438#ifdef CONFIG_GPIOLIB
 439int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
 440                        struct snd_soc_jack_gpio *gpios);
 441void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
 442                        struct snd_soc_jack_gpio *gpios);
 443#endif
 444
 445/* codec register bit access */
 446int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
 447                                unsigned int mask, unsigned int value);
 448int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
 449                               unsigned short reg, unsigned int mask,
 450                               unsigned int value);
 451int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
 452                                unsigned int mask, unsigned int value);
 453
 454int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 455        struct snd_ac97_bus_ops *ops, int num);
 456void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 457
 458/*
 459 *Controls
 460 */
 461struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 462                                  void *data, const char *long_name,
 463                                  const char *prefix);
 464int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
 465        const struct snd_kcontrol_new *controls, int num_controls);
 466int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
 467        const struct snd_kcontrol_new *controls, int num_controls);
 468int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
 469        const struct snd_kcontrol_new *controls, int num_controls);
 470int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
 471        const struct snd_kcontrol_new *controls, int num_controls);
 472int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 473        struct snd_ctl_elem_info *uinfo);
 474int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
 475        struct snd_ctl_elem_info *uinfo);
 476int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 477        struct snd_ctl_elem_value *ucontrol);
 478int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 479        struct snd_ctl_elem_value *ucontrol);
 480int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
 481        struct snd_ctl_elem_value *ucontrol);
 482int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
 483        struct snd_ctl_elem_value *ucontrol);
 484int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 485        struct snd_ctl_elem_info *uinfo);
 486int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
 487        struct snd_ctl_elem_info *uinfo);
 488#define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 489int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 490        struct snd_ctl_elem_value *ucontrol);
 491int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 492        struct snd_ctl_elem_value *ucontrol);
 493#define snd_soc_get_volsw_2r snd_soc_get_volsw
 494#define snd_soc_put_volsw_2r snd_soc_put_volsw
 495int snd_soc_get_volsw_sx(struct snd_kcontrol *kcontrol,
 496        struct snd_ctl_elem_value *ucontrol);
 497int snd_soc_put_volsw_sx(struct snd_kcontrol *kcontrol,
 498        struct snd_ctl_elem_value *ucontrol);
 499int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 500        struct snd_ctl_elem_info *uinfo);
 501int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 502        struct snd_ctl_elem_value *ucontrol);
 503int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 504        struct snd_ctl_elem_value *ucontrol);
 505int snd_soc_info_volsw_range(struct snd_kcontrol *kcontrol,
 506        struct snd_ctl_elem_info *uinfo);
 507int snd_soc_put_volsw_range(struct snd_kcontrol *kcontrol,
 508        struct snd_ctl_elem_value *ucontrol);
 509int snd_soc_get_volsw_range(struct snd_kcontrol *kcontrol,
 510        struct snd_ctl_elem_value *ucontrol);
 511int snd_soc_limit_volume(struct snd_soc_codec *codec,
 512        const char *name, int max);
 513int snd_soc_bytes_info(struct snd_kcontrol *kcontrol,
 514                       struct snd_ctl_elem_info *uinfo);
 515int snd_soc_bytes_get(struct snd_kcontrol *kcontrol,
 516                      struct snd_ctl_elem_value *ucontrol);
 517int snd_soc_bytes_put(struct snd_kcontrol *kcontrol,
 518                      struct snd_ctl_elem_value *ucontrol);
 519int snd_soc_info_xr_sx(struct snd_kcontrol *kcontrol,
 520        struct snd_ctl_elem_info *uinfo);
 521int snd_soc_get_xr_sx(struct snd_kcontrol *kcontrol,
 522        struct snd_ctl_elem_value *ucontrol);
 523int snd_soc_put_xr_sx(struct snd_kcontrol *kcontrol,
 524        struct snd_ctl_elem_value *ucontrol);
 525int snd_soc_get_strobe(struct snd_kcontrol *kcontrol,
 526        struct snd_ctl_elem_value *ucontrol);
 527int snd_soc_put_strobe(struct snd_kcontrol *kcontrol,
 528        struct snd_ctl_elem_value *ucontrol);
 529
 530/**
 531 * struct snd_soc_reg_access - Describes whether a given register is
 532 * readable, writable or volatile.
 533 *
 534 * @reg: the register number
 535 * @read: whether this register is readable
 536 * @write: whether this register is writable
 537 * @vol: whether this register is volatile
 538 */
 539struct snd_soc_reg_access {
 540        u16 reg;
 541        u16 read;
 542        u16 write;
 543        u16 vol;
 544};
 545
 546/**
 547 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
 548 *
 549 * @pin:    name of the pin to update
 550 * @mask:   bits to check for in reported jack status
 551 * @invert: if non-zero then pin is enabled when status is not reported
 552 */
 553struct snd_soc_jack_pin {
 554        struct list_head list;
 555        const char *pin;
 556        int mask;
 557        bool invert;
 558};
 559
 560/**
 561 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
 562 *
 563 * @min_mv: start voltage in mv
 564 * @max_mv: end voltage in mv
 565 * @jack_type: type of jack that is expected for this voltage
 566 * @debounce_time: debounce_time for jack, codec driver should wait for this
 567 *              duration before reading the adc for voltages
 568 * @:list: list container
 569 */
 570struct snd_soc_jack_zone {
 571        unsigned int min_mv;
 572        unsigned int max_mv;
 573        unsigned int jack_type;
 574        unsigned int debounce_time;
 575        struct list_head list;
 576};
 577
 578/**
 579 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
 580 *
 581 * @gpio:         gpio number
 582 * @name:         gpio name
 583 * @report:       value to report when jack detected
 584 * @invert:       report presence in low state
 585 * @debouce_time: debouce time in ms
 586 * @wake:         enable as wake source
 587 * @jack_status_check: callback function which overrides the detection
 588 *                     to provide more complex checks (eg, reading an
 589 *                     ADC).
 590 */
 591#ifdef CONFIG_GPIOLIB
 592struct snd_soc_jack_gpio {
 593        unsigned int gpio;
 594        const char *name;
 595        int report;
 596        int invert;
 597        int debounce_time;
 598        bool wake;
 599
 600        struct snd_soc_jack *jack;
 601        struct delayed_work work;
 602
 603        int (*jack_status_check)(void);
 604};
 605#endif
 606
 607struct snd_soc_jack {
 608        struct mutex mutex;
 609        struct snd_jack *jack;
 610        struct snd_soc_codec *codec;
 611        struct list_head pins;
 612        int status;
 613        struct blocking_notifier_head notifier;
 614        struct list_head jack_zones;
 615};
 616
 617/* SoC PCM stream information */
 618struct snd_soc_pcm_stream {
 619        const char *stream_name;
 620        u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 621        unsigned int rates;             /* SNDRV_PCM_RATE_* */
 622        unsigned int rate_min;          /* min rate */
 623        unsigned int rate_max;          /* max rate */
 624        unsigned int channels_min;      /* min channels */
 625        unsigned int channels_max;      /* max channels */
 626        unsigned int sig_bits;          /* number of bits of content */
 627};
 628
 629/* SoC audio ops */
 630struct snd_soc_ops {
 631        int (*startup)(struct snd_pcm_substream *);
 632        void (*shutdown)(struct snd_pcm_substream *);
 633        int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 634        int (*hw_free)(struct snd_pcm_substream *);
 635        int (*prepare)(struct snd_pcm_substream *);
 636        int (*trigger)(struct snd_pcm_substream *, int);
 637};
 638
 639struct snd_soc_compr_ops {
 640        int (*startup)(struct snd_compr_stream *);
 641        void (*shutdown)(struct snd_compr_stream *);
 642        int (*set_params)(struct snd_compr_stream *);
 643        int (*trigger)(struct snd_compr_stream *);
 644};
 645
 646/* SoC cache ops */
 647struct snd_soc_cache_ops {
 648        const char *name;
 649        enum snd_soc_compress_type id;
 650        int (*init)(struct snd_soc_codec *codec);
 651        int (*exit)(struct snd_soc_codec *codec);
 652        int (*read)(struct snd_soc_codec *codec, unsigned int reg,
 653                unsigned int *value);
 654        int (*write)(struct snd_soc_codec *codec, unsigned int reg,
 655                unsigned int value);
 656        int (*sync)(struct snd_soc_codec *codec);
 657};
 658
 659/* SoC Audio Codec device */
 660struct snd_soc_codec {
 661        const char *name;
 662        const char *name_prefix;
 663        int id;
 664        struct device *dev;
 665        const struct snd_soc_codec_driver *driver;
 666
 667        struct mutex mutex;
 668        struct snd_soc_card *card;
 669        struct list_head list;
 670        struct list_head card_list;
 671        int num_dai;
 672        enum snd_soc_compress_type compress_type;
 673        size_t reg_size;        /* reg_cache_size * reg_word_size */
 674        int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 675        int (*readable_register)(struct snd_soc_codec *, unsigned int);
 676        int (*writable_register)(struct snd_soc_codec *, unsigned int);
 677
 678        /* runtime */
 679        struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 680        unsigned int active;
 681        unsigned int cache_bypass:1; /* Suppress access to the cache */
 682        unsigned int suspended:1; /* Codec is in suspend PM state */
 683        unsigned int probed:1; /* Codec has been probed */
 684        unsigned int ac97_registered:1; /* Codec has been AC97 registered */
 685        unsigned int ac97_created:1; /* Codec has been created by SoC */
 686        unsigned int sysfs_registered:1; /* codec has been sysfs registered */
 687        unsigned int cache_init:1; /* codec cache has been initialized */
 688        unsigned int using_regmap:1; /* using regmap access */
 689        u32 cache_only;  /* Suppress writes to hardware */
 690        u32 cache_sync; /* Cache needs to be synced to hardware */
 691
 692        /* codec IO */
 693        void *control_data; /* codec control (i2c/3wire) data */
 694        enum snd_soc_control_type control_type;
 695        hw_write_t hw_write;
 696        unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
 697        unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 698        int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 699        int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
 700        void *reg_cache;
 701        const void *reg_def_copy;
 702        const struct snd_soc_cache_ops *cache_ops;
 703        struct mutex cache_rw_mutex;
 704        int val_bytes;
 705
 706        /* dapm */
 707        struct snd_soc_dapm_context dapm;
 708        unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
 709
 710#ifdef CONFIG_DEBUG_FS
 711        struct dentry *debugfs_codec_root;
 712        struct dentry *debugfs_reg;
 713        struct dentry *debugfs_dapm;
 714#endif
 715};
 716
 717/* codec driver */
 718struct snd_soc_codec_driver {
 719
 720        /* driver ops */
 721        int (*probe)(struct snd_soc_codec *);
 722        int (*remove)(struct snd_soc_codec *);
 723        int (*suspend)(struct snd_soc_codec *);
 724        int (*resume)(struct snd_soc_codec *);
 725
 726        /* Default control and setup, added after probe() is run */
 727        const struct snd_kcontrol_new *controls;
 728        int num_controls;
 729        const struct snd_soc_dapm_widget *dapm_widgets;
 730        int num_dapm_widgets;
 731        const struct snd_soc_dapm_route *dapm_routes;
 732        int num_dapm_routes;
 733
 734        /* codec wide operations */
 735        int (*set_sysclk)(struct snd_soc_codec *codec,
 736                          int clk_id, int source, unsigned int freq, int dir);
 737        int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
 738                unsigned int freq_in, unsigned int freq_out);
 739
 740        /* codec IO */
 741        unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 742        int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 743        int (*display_register)(struct snd_soc_codec *, char *,
 744                                size_t, unsigned int);
 745        int (*volatile_register)(struct snd_soc_codec *, unsigned int);
 746        int (*readable_register)(struct snd_soc_codec *, unsigned int);
 747        int (*writable_register)(struct snd_soc_codec *, unsigned int);
 748        unsigned int reg_cache_size;
 749        short reg_cache_step;
 750        short reg_word_size;
 751        const void *reg_cache_default;
 752        short reg_access_size;
 753        const struct snd_soc_reg_access *reg_access_default;
 754        enum snd_soc_compress_type compress_type;
 755
 756        /* codec bias level */
 757        int (*set_bias_level)(struct snd_soc_codec *,
 758                              enum snd_soc_bias_level level);
 759        bool idle_bias_off;
 760
 761        void (*seq_notifier)(struct snd_soc_dapm_context *,
 762                             enum snd_soc_dapm_type, int);
 763
 764        /* codec stream completion event */
 765        int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 766
 767        bool ignore_pmdown_time;  /* Doesn't benefit from pmdown delay */
 768
 769        /* probe ordering - for components with runtime dependencies */
 770        int probe_order;
 771        int remove_order;
 772};
 773
 774/* SoC platform interface */
 775struct snd_soc_platform_driver {
 776
 777        int (*probe)(struct snd_soc_platform *);
 778        int (*remove)(struct snd_soc_platform *);
 779        int (*suspend)(struct snd_soc_dai *dai);
 780        int (*resume)(struct snd_soc_dai *dai);
 781
 782        /* pcm creation and destruction */
 783        int (*pcm_new)(struct snd_soc_pcm_runtime *);
 784        void (*pcm_free)(struct snd_pcm *);
 785
 786        /* Default control and setup, added after probe() is run */
 787        const struct snd_kcontrol_new *controls;
 788        int num_controls;
 789        const struct snd_soc_dapm_widget *dapm_widgets;
 790        int num_dapm_widgets;
 791        const struct snd_soc_dapm_route *dapm_routes;
 792        int num_dapm_routes;
 793
 794        /*
 795         * For platform caused delay reporting.
 796         * Optional.
 797         */
 798        snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 799                struct snd_soc_dai *);
 800
 801        /* platform stream pcm ops */
 802        struct snd_pcm_ops *ops;
 803
 804        /* platform stream compress ops */
 805        struct snd_compr_ops *compr_ops;
 806
 807        /* platform stream completion event */
 808        int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
 809
 810        /* probe ordering - for components with runtime dependencies */
 811        int probe_order;
 812        int remove_order;
 813
 814        /* platform IO - used for platform DAPM */
 815        unsigned int (*read)(struct snd_soc_platform *, unsigned int);
 816        int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
 817        int (*bespoke_trigger)(struct snd_pcm_substream *, int);
 818};
 819
 820struct snd_soc_platform {
 821        const char *name;
 822        int id;
 823        struct device *dev;
 824        struct snd_soc_platform_driver *driver;
 825        struct mutex mutex;
 826
 827        unsigned int suspended:1; /* platform is suspended */
 828        unsigned int probed:1;
 829
 830        struct snd_soc_card *card;
 831        struct list_head list;
 832        struct list_head card_list;
 833
 834        struct snd_soc_dapm_context dapm;
 835
 836#ifdef CONFIG_DEBUG_FS
 837        struct dentry *debugfs_platform_root;
 838        struct dentry *debugfs_dapm;
 839#endif
 840};
 841
 842struct snd_soc_dai_link {
 843        /* config - must be set by machine driver */
 844        const char *name;                       /* Codec name */
 845        const char *stream_name;                /* Stream name */
 846        /*
 847         * You MAY specify the link's CPU-side device, either by device name,
 848         * or by DT/OF node, but not both. If this information is omitted,
 849         * the CPU-side DAI is matched using .cpu_dai_name only, which hence
 850         * must be globally unique. These fields are currently typically used
 851         * only for codec to codec links, or systems using device tree.
 852         */
 853        const char *cpu_name;
 854        const struct device_node *cpu_of_node;
 855        /*
 856         * You MAY specify the DAI name of the CPU DAI. If this information is
 857         * omitted, the CPU-side DAI is matched using .cpu_name/.cpu_of_node
 858         * only, which only works well when that device exposes a single DAI.
 859         */
 860        const char *cpu_dai_name;
 861        /*
 862         * You MUST specify the link's codec, either by device name, or by
 863         * DT/OF node, but not both.
 864         */
 865        const char *codec_name;
 866        const struct device_node *codec_of_node;
 867        /* You MUST specify the DAI name within the codec */
 868        const char *codec_dai_name;
 869        /*
 870         * You MAY specify the link's platform/PCM/DMA driver, either by
 871         * device name, or by DT/OF node, but not both. Some forms of link
 872         * do not need a platform.
 873         */
 874        const char *platform_name;
 875        const struct device_node *platform_of_node;
 876        int be_id;      /* optional ID for machine driver BE identification */
 877
 878        const struct snd_soc_pcm_stream *params;
 879
 880        unsigned int dai_fmt;           /* format to set on init */
 881
 882        enum snd_soc_dpcm_trigger trigger[2]; /* trigger type for DPCM */
 883
 884        /* Keep DAI active over suspend */
 885        unsigned int ignore_suspend:1;
 886
 887        /* Symmetry requirements */
 888        unsigned int symmetric_rates:1;
 889
 890        /* Do not create a PCM for this DAI link (Backend link) */
 891        unsigned int no_pcm:1;
 892
 893        /* This DAI link can route to other DAI links at runtime (Frontend)*/
 894        unsigned int dynamic:1;
 895
 896        /* pmdown_time is ignored at stop */
 897        unsigned int ignore_pmdown_time:1;
 898
 899        /* codec/machine specific init - e.g. add machine controls */
 900        int (*init)(struct snd_soc_pcm_runtime *rtd);
 901
 902        /* optional hw_params re-writing for BE and FE sync */
 903        int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
 904                        struct snd_pcm_hw_params *params);
 905
 906        /* machine stream operations */
 907        struct snd_soc_ops *ops;
 908        struct snd_soc_compr_ops *compr_ops;
 909};
 910
 911struct snd_soc_codec_conf {
 912        const char *dev_name;
 913
 914        /*
 915         * optional map of kcontrol, widget and path name prefixes that are
 916         * associated per device
 917         */
 918        const char *name_prefix;
 919
 920        /*
 921         * set this to the desired compression type if you want to
 922         * override the one supplied in codec->driver->compress_type
 923         */
 924        enum snd_soc_compress_type compress_type;
 925};
 926
 927struct snd_soc_aux_dev {
 928        const char *name;               /* Codec name */
 929        const char *codec_name;         /* for multi-codec */
 930
 931        /* codec/machine specific init - e.g. add machine controls */
 932        int (*init)(struct snd_soc_dapm_context *dapm);
 933};
 934
 935/* SoC card */
 936struct snd_soc_card {
 937        const char *name;
 938        const char *long_name;
 939        const char *driver_name;
 940        struct device *dev;
 941        struct snd_card *snd_card;
 942        struct module *owner;
 943
 944        struct list_head list;
 945        struct mutex mutex;
 946        struct mutex dapm_mutex;
 947
 948        bool instantiated;
 949
 950        int (*probe)(struct snd_soc_card *card);
 951        int (*late_probe)(struct snd_soc_card *card);
 952        int (*remove)(struct snd_soc_card *card);
 953
 954        /* the pre and post PM functions are used to do any PM work before and
 955         * after the codec and DAI's do any PM work. */
 956        int (*suspend_pre)(struct snd_soc_card *card);
 957        int (*suspend_post)(struct snd_soc_card *card);
 958        int (*resume_pre)(struct snd_soc_card *card);
 959        int (*resume_post)(struct snd_soc_card *card);
 960
 961        /* callbacks */
 962        int (*set_bias_level)(struct snd_soc_card *,
 963                              struct snd_soc_dapm_context *dapm,
 964                              enum snd_soc_bias_level level);
 965        int (*set_bias_level_post)(struct snd_soc_card *,
 966                                   struct snd_soc_dapm_context *dapm,
 967                                   enum snd_soc_bias_level level);
 968
 969        long pmdown_time;
 970
 971        /* CPU <--> Codec DAI links  */
 972        struct snd_soc_dai_link *dai_link;
 973        int num_links;
 974        struct snd_soc_pcm_runtime *rtd;
 975        int num_rtd;
 976
 977        /* optional codec specific configuration */
 978        struct snd_soc_codec_conf *codec_conf;
 979        int num_configs;
 980
 981        /*
 982         * optional auxiliary devices such as amplifiers or codecs with DAI
 983         * link unused
 984         */
 985        struct snd_soc_aux_dev *aux_dev;
 986        int num_aux_devs;
 987        struct snd_soc_pcm_runtime *rtd_aux;
 988        int num_aux_rtd;
 989
 990        const struct snd_kcontrol_new *controls;
 991        int num_controls;
 992
 993        /*
 994         * Card-specific routes and widgets.
 995         */
 996        const struct snd_soc_dapm_widget *dapm_widgets;
 997        int num_dapm_widgets;
 998        const struct snd_soc_dapm_route *dapm_routes;
 999        int num_dapm_routes;
1000        bool fully_routed;
1001
1002        struct work_struct deferred_resume_work;
1003
1004        /* lists of probed devices belonging to this card */
1005        struct list_head codec_dev_list;
1006        struct list_head platform_dev_list;
1007        struct list_head dai_dev_list;
1008
1009        struct list_head widgets;
1010        struct list_head paths;
1011        struct list_head dapm_list;
1012        struct list_head dapm_dirty;
1013
1014        /* Generic DAPM context for the card */
1015        struct snd_soc_dapm_context dapm;
1016        struct snd_soc_dapm_stats dapm_stats;
1017
1018#ifdef CONFIG_DEBUG_FS
1019        struct dentry *debugfs_card_root;
1020        struct dentry *debugfs_pop_time;
1021#endif
1022        u32 pop_time;
1023
1024        void *drvdata;
1025};
1026
1027/* SoC machine DAI configuration, glues a codec and cpu DAI together */
1028struct snd_soc_pcm_runtime {
1029        struct device *dev;
1030        struct snd_soc_card *card;
1031        struct snd_soc_dai_link *dai_link;
1032        struct mutex pcm_mutex;
1033        enum snd_soc_pcm_subclass pcm_subclass;
1034        struct snd_pcm_ops ops;
1035
1036        unsigned int dev_registered:1;
1037
1038        /* Dynamic PCM BE runtime data */
1039        struct snd_soc_dpcm_runtime dpcm[2];
1040
1041        long pmdown_time;
1042
1043        /* runtime devices */
1044        struct snd_pcm *pcm;
1045        struct snd_compr *compr;
1046        struct snd_soc_codec *codec;
1047        struct snd_soc_platform *platform;
1048        struct snd_soc_dai *codec_dai;
1049        struct snd_soc_dai *cpu_dai;
1050
1051        struct delayed_work delayed_work;
1052#ifdef CONFIG_DEBUG_FS
1053        struct dentry *debugfs_dpcm_root;
1054        struct dentry *debugfs_dpcm_state;
1055#endif
1056};
1057
1058/* mixer control */
1059struct soc_mixer_control {
1060        int min, max, platform_max;
1061        unsigned int reg, rreg, shift, rshift, invert;
1062};
1063
1064struct soc_bytes {
1065        int base;
1066        int num_regs;
1067        u32 mask;
1068};
1069
1070/* multi register control */
1071struct soc_mreg_control {
1072        long min, max;
1073        unsigned int regbase, regcount, nbits, invert;
1074};
1075
1076/* enumerated kcontrol */
1077struct soc_enum {
1078        unsigned short reg;
1079        unsigned short reg2;
1080        unsigned char shift_l;
1081        unsigned char shift_r;
1082        unsigned int max;
1083        unsigned int mask;
1084        const char * const *texts;
1085        const unsigned int *values;
1086        void *dapm;
1087};
1088
1089/* codec IO */
1090unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
1091unsigned int snd_soc_write(struct snd_soc_codec *codec,
1092                           unsigned int reg, unsigned int val);
1093unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
1094                                    unsigned int reg, const void *data, size_t len);
1095
1096/* device driver data */
1097
1098static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
1099                void *data)
1100{
1101        card->drvdata = data;
1102}
1103
1104static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
1105{
1106        return card->drvdata;
1107}
1108
1109static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
1110                void *data)
1111{
1112        dev_set_drvdata(codec->dev, data);
1113}
1114
1115static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
1116{
1117        return dev_get_drvdata(codec->dev);
1118}
1119
1120static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
1121                void *data)
1122{
1123        dev_set_drvdata(platform->dev, data);
1124}
1125
1126static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
1127{
1128        return dev_get_drvdata(platform->dev);
1129}
1130
1131static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
1132                void *data)
1133{
1134        dev_set_drvdata(rtd->dev, data);
1135}
1136
1137static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
1138{
1139        return dev_get_drvdata(rtd->dev);
1140}
1141
1142static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
1143{
1144        INIT_LIST_HEAD(&card->dai_dev_list);
1145        INIT_LIST_HEAD(&card->codec_dev_list);
1146        INIT_LIST_HEAD(&card->platform_dev_list);
1147        INIT_LIST_HEAD(&card->widgets);
1148        INIT_LIST_HEAD(&card->paths);
1149        INIT_LIST_HEAD(&card->dapm_list);
1150}
1151
1152static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
1153{
1154        if (mc->reg == mc->rreg && mc->shift == mc->rshift)
1155                return 0;
1156        /*
1157         * mc->reg == mc->rreg && mc->shift != mc->rshift, or
1158         * mc->reg != mc->rreg means that the control is
1159         * stereo (bits in one register or in two registers)
1160         */
1161        return 1;
1162}
1163
1164int snd_soc_util_init(void);
1165void snd_soc_util_exit(void);
1166
1167int snd_soc_of_parse_card_name(struct snd_soc_card *card,
1168                               const char *propname);
1169int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
1170                                   const char *propname);
1171
1172#include <sound/soc-dai.h>
1173
1174#ifdef CONFIG_DEBUG_FS
1175extern struct dentry *snd_soc_debugfs_root;
1176#endif
1177
1178extern const struct dev_pm_ops snd_soc_pm_ops;
1179
1180#endif
1181
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.