include/sound/soc.h

   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/workqueue.h>
  19 #include <sound/core.h>
  20 #include <sound/pcm.h>
  21 #include <sound/control.h>
  22 #include <sound/ac97_codec.h>
  23
  24 /*
  25  * Convenience kcontrol builders
  26  */
  27 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
  28         ((unsigned long)&(struct soc_mixer_control) \
  29         {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
  30         .invert = xinvert})
  31 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
  32         ((unsigned long)&(struct soc_mixer_control) \
  33         {.reg = xreg, .max = xmax, .invert = xinvert})
  34 #define SOC_SINGLE(xname, reg, shift, max, invert) \
  35 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  36         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  37         .put = snd_soc_put_volsw, \
  38         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
  39 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
  40 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  41         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  42                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  43         .tlv.p = (tlv_array), \
  44         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
  45         .put = snd_soc_put_volsw, \
  46         .private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
  47 #define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
  48 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  49         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
  50         .put = snd_soc_put_volsw, \
  51         .private_value = (unsigned long)&(struct soc_mixer_control) \
  52                 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
  53                  .max = xmax, .invert = xinvert} }
  54 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
  55 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
  56         .info = snd_soc_info_volsw_2r, \
  57         .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
  58         .private_value = (unsigned long)&(struct soc_mixer_control) \
  59                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
  60                 .max = xmax, .invert = xinvert} }
  61 #define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
  62 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
  63         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
  64                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  65         .tlv.p = (tlv_array), \
  66         .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
  67         .put = snd_soc_put_volsw, \
  68         .private_value = (unsigned long)&(struct soc_mixer_control) \
  69                 {.reg = xreg, .shift = shift_left, .rshift = shift_right,\
  70                  .max = xmax, .invert = xinvert} }
  71 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, 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_2r, \
  77         .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
  78         .private_value = (unsigned long)&(struct soc_mixer_control) \
  79                 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
  80                 .max = xmax, .invert = xinvert} }
  81 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
  82 {       .iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
  83         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
  84                   SNDRV_CTL_ELEM_ACCESS_READWRITE, \
  85         .tlv.p  = (tlv_array), \
  86         .info   = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
  87         .put    = snd_soc_put_volsw_s8, \
  88         .private_value = (unsigned long)&(struct soc_mixer_control) \
  89                 {.reg = xreg, .min = xmin, .max = xmax} }
  90 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
  91 {       .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
  92         .max = xmax, .texts = xtexts }
  93 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
  94         SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
  95 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
  96 {       .max = xmax, .texts = xtexts }
  97 #define SOC_ENUM(xname, xenum) \
  98 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
  99         .info = snd_soc_info_enum_double, \
 100         .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
 101         .private_value = (unsigned long)&xenum }
 102 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
 103          xhandler_get, xhandler_put) \
 104 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 105         .info = snd_soc_info_volsw, \
 106         .get = xhandler_get, .put = xhandler_put, \
 107         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
 108 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
 109          xhandler_get, xhandler_put, tlv_array) \
 110 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 111         .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
 112                  SNDRV_CTL_ELEM_ACCESS_READWRITE,\
 113         .tlv.p = (tlv_array), \
 114         .info = snd_soc_info_volsw, \
 115         .get = xhandler_get, .put = xhandler_put, \
 116         .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
 117 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
 118 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 119         .info = snd_soc_info_bool_ext, \
 120         .get = xhandler_get, .put = xhandler_put, \
 121         .private_value = xdata }
 122 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
 123 {       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
 124         .info = snd_soc_info_enum_ext, \
 125         .get = xhandler_get, .put = xhandler_put, \
 126         .private_value = (unsigned long)&xenum }
 127
 128 /*
 129  * Bias levels
 130  *
 131  * @ON:      Bias is fully on for audio playback and capture operations.
 132  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
 133  *           stream start and stop operations.
 134  * @STANDBY: Low power standby state when no playback/capture operations are
 135  *           in progress. NOTE: The transition time between STANDBY and ON
 136  *           should be as fast as possible and no longer than 10ms.
 137  * @OFF:     Power Off. No restrictions on transition times.
 138  */
 139 enum snd_soc_bias_level {
 140         SND_SOC_BIAS_ON,
 141         SND_SOC_BIAS_PREPARE,
 142         SND_SOC_BIAS_STANDBY,
 143         SND_SOC_BIAS_OFF,
 144 };
 145
 146 /*
 147  * Digital Audio Interface (DAI) types
 148  */
 149 #define SND_SOC_DAI_AC97        0x1
 150 #define SND_SOC_DAI_I2S         0x2
 151 #define SND_SOC_DAI_PCM         0x4
 152 #define SND_SOC_DAI_AC97_BUS    0x8     /* for custom i.e. non ac97_codec.c */
 153
 154 struct snd_soc_device;
 155 struct snd_soc_pcm_stream;
 156 struct snd_soc_ops;
 157 struct snd_soc_dai_mode;
 158 struct snd_soc_pcm_runtime;
 159 struct snd_soc_dai;
 160 struct snd_soc_codec;
 161 struct soc_enum;
 162 struct snd_soc_ac97_ops;
 163 struct snd_soc_clock_info;
 164
 165 typedef int (*hw_write_t)(void *,const char* ,int);
 166 typedef int (*hw_read_t)(void *,char* ,int);
 167
 168 extern struct snd_ac97_bus_ops soc_ac97_ops;
 169
 170 /* pcm <-> DAI connect */
 171 void snd_soc_free_pcms(struct snd_soc_device *socdev);
 172 int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
 173 int snd_soc_register_card(struct snd_soc_device *socdev);
 174
 175 /* set runtime hw params */
 176 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
 177         const struct snd_pcm_hardware *hw);
 178
 179 /* codec IO */
 180 #define snd_soc_read(codec, reg) codec->read(codec, reg)
 181 #define snd_soc_write(codec, reg, value) codec->write(codec, reg, value)
 182
 183 /* codec register bit access */
 184 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
 185                                 unsigned short mask, unsigned short value);
 186 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
 187                                 unsigned short mask, unsigned short value);
 188
 189 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
 190         struct snd_ac97_bus_ops *ops, int num);
 191 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
 192
 193 /*
 194  *Controls
 195  */
 196 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
 197         void *data, char *long_name);
 198 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
 199         struct snd_ctl_elem_info *uinfo);
 200 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
 201         struct snd_ctl_elem_info *uinfo);
 202 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
 203         struct snd_ctl_elem_value *ucontrol);
 204 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
 205         struct snd_ctl_elem_value *ucontrol);
 206 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
 207         struct snd_ctl_elem_info *uinfo);
 208 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
 209         struct snd_ctl_elem_info *uinfo);
 210 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
 211 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
 212         struct snd_ctl_elem_value *ucontrol);
 213 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
 214         struct snd_ctl_elem_value *ucontrol);
 215 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
 216         struct snd_ctl_elem_info *uinfo);
 217 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
 218         struct snd_ctl_elem_value *ucontrol);
 219 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
 220         struct snd_ctl_elem_value *ucontrol);
 221 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
 222         struct snd_ctl_elem_info *uinfo);
 223 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
 224         struct snd_ctl_elem_value *ucontrol);
 225 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
 226         struct snd_ctl_elem_value *ucontrol);
 227
 228 /* SoC PCM stream information */
 229 struct snd_soc_pcm_stream {
 230         char *stream_name;
 231         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
 232         unsigned int rates;             /* SNDRV_PCM_RATE_* */
 233         unsigned int rate_min;          /* min rate */
 234         unsigned int rate_max;          /* max rate */
 235         unsigned int channels_min;      /* min channels */
 236         unsigned int channels_max;      /* max channels */
 237         unsigned int active:1;          /* stream is in use */
 238 };
 239
 240 /* SoC audio ops */
 241 struct snd_soc_ops {
 242         int (*startup)(struct snd_pcm_substream *);
 243         void (*shutdown)(struct snd_pcm_substream *);
 244         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 245         int (*hw_free)(struct snd_pcm_substream *);
 246         int (*prepare)(struct snd_pcm_substream *);
 247         int (*trigger)(struct snd_pcm_substream *, int);
 248 };
 249
 250 /* SoC Audio Codec */
 251 struct snd_soc_codec {
 252         char *name;
 253         struct module *owner;
 254         struct mutex mutex;
 255
 256         /* callbacks */
 257         int (*set_bias_level)(struct snd_soc_codec *,
 258                               enum snd_soc_bias_level level);
 259
 260         /* runtime */
 261         struct snd_card *card;
 262         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
 263         unsigned int active;
 264         unsigned int pcm_devs;
 265         void *private_data;
 266
 267         /* codec IO */
 268         void *control_data; /* codec control (i2c/3wire) data */
 269         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
 270         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
 271         int (*display_register)(struct snd_soc_codec *, char *,
 272                                 size_t, unsigned int);
 273         hw_write_t hw_write;
 274         hw_read_t hw_read;
 275         void *reg_cache;
 276         short reg_cache_size;
 277         short reg_cache_step;
 278
 279         /* dapm */
 280         u32 pop_time;
 281         struct list_head dapm_widgets;
 282         struct list_head dapm_paths;
 283         enum snd_soc_bias_level bias_level;
 284         enum snd_soc_bias_level suspend_bias_level;
 285         struct delayed_work delayed_work;
 286
 287         /* codec DAI's */
 288         struct snd_soc_dai *dai;
 289         unsigned int num_dai;
 290 };
 291
 292 /* codec device */
 293 struct snd_soc_codec_device {
 294         int (*probe)(struct platform_device *pdev);
 295         int (*remove)(struct platform_device *pdev);
 296         int (*suspend)(struct platform_device *pdev, pm_message_t state);
 297         int (*resume)(struct platform_device *pdev);
 298 };
 299
 300 /* SoC platform interface */
 301 struct snd_soc_platform {
 302         char *name;
 303
 304         int (*probe)(struct platform_device *pdev);
 305         int (*remove)(struct platform_device *pdev);
 306         int (*suspend)(struct platform_device *pdev,
 307                 struct snd_soc_dai *dai);
 308         int (*resume)(struct platform_device *pdev,
 309                 struct snd_soc_dai *dai);
 310
 311         /* pcm creation and destruction */
 312         int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
 313                 struct snd_pcm *);
 314         void (*pcm_free)(struct snd_pcm *);
 315
 316         /* platform stream ops */
 317         struct snd_pcm_ops *pcm_ops;
 318 };
 319
 320 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
 321 struct snd_soc_dai_link  {
 322         char *name;                     /* Codec name */
 323         char *stream_name;              /* Stream name */
 324
 325         /* DAI */
 326         struct snd_soc_dai *codec_dai;
 327         struct snd_soc_dai *cpu_dai;
 328
 329         /* machine stream operations */
 330         struct snd_soc_ops *ops;
 331
 332         /* codec/machine specific init - e.g. add machine controls */
 333         int (*init)(struct snd_soc_codec *codec);
 334
 335         /* DAI pcm */
 336         struct snd_pcm *pcm;
 337 };
 338
 339 /* SoC card */
 340 struct snd_soc_card {
 341         char *name;
 342
 343         int (*probe)(struct platform_device *pdev);
 344         int (*remove)(struct platform_device *pdev);
 345
 346         /* the pre and post PM functions are used to do any PM work before and
 347          * after the codec and DAI's do any PM work. */
 348         int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
 349         int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
 350         int (*resume_pre)(struct platform_device *pdev);
 351         int (*resume_post)(struct platform_device *pdev);
 352
 353         /* callbacks */
 354         int (*set_bias_level)(struct snd_soc_card *,
 355                               enum snd_soc_bias_level level);
 356
 357         /* CPU <--> Codec DAI links  */
 358         struct snd_soc_dai_link *dai_link;
 359         int num_links;
 360 };
 361
 362 /* SoC Device - the audio subsystem */
 363 struct snd_soc_device {
 364         struct device *dev;
 365         struct snd_soc_card *card;
 366         struct snd_soc_platform *platform;
 367         struct snd_soc_codec *codec;
 368         struct snd_soc_codec_device *codec_dev;
 369         struct delayed_work delayed_work;
 370         struct work_struct deferred_resume_work;
 371         void *codec_data;
 372 #ifdef CONFIG_DEBUG_FS
 373         struct dentry   *debugfs_root;
 374 #endif
 375 };
 376
 377 /* runtime channel data */
 378 struct snd_soc_pcm_runtime {
 379         struct snd_soc_dai_link *dai;
 380         struct snd_soc_device *socdev;
 381 };
 382
 383 /* mixer control */
 384 struct soc_mixer_control {
 385         int min, max;
 386         unsigned int reg, rreg, shift, rshift, invert;
 387 };
 388
 389 /* enumerated kcontrol */
 390 struct soc_enum {
 391         unsigned short reg;
 392         unsigned short reg2;
 393         unsigned char shift_l;
 394         unsigned char shift_r;
 395         unsigned int max;
 396         const char **texts;
 397         void *dapm;
 398 };
 399
 400 #include <sound/soc-dai.h>
 401
 402 #endif