include/sound/soc-dai.h

   1 /*
   2  * linux/sound/soc-dai.h -- ALSA SoC Layer
   3  *
   4  * Copyright:   2005-2008 Wolfson Microelectronics. PLC.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  *
  10  * Digital Audio Interface (DAI) API.
  11  */
  12
  13 #ifndef __LINUX_SND_SOC_DAI_H
  14 #define __LINUX_SND_SOC_DAI_H
  15
  16
  17 #include <linux/list.h>
  18
  19 struct snd_pcm_substream;
  20
  21 /*
  22  * DAI hardware audio formats.
  23  *
  24  * Describes the physical PCM data formating and clocking. Add new formats
  25  * to the end.
  26  */
  27 #define SND_SOC_DAIFMT_I2S              0 /* I2S mode */
  28 #define SND_SOC_DAIFMT_RIGHT_J          1 /* Right Justified mode */
  29 #define SND_SOC_DAIFMT_LEFT_J           2 /* Left Justified mode */
  30 #define SND_SOC_DAIFMT_DSP_A            3 /* L data MSB after FRM LRC */
  31 #define SND_SOC_DAIFMT_DSP_B            4 /* L data MSB during FRM LRC */
  32 #define SND_SOC_DAIFMT_AC97             5 /* AC97 */
  33 #define SND_SOC_DAIFMT_PDM              6 /* Pulse density modulation */
  34
  35 /* left and right justified also known as MSB and LSB respectively */
  36 #define SND_SOC_DAIFMT_MSB              SND_SOC_DAIFMT_LEFT_J
  37 #define SND_SOC_DAIFMT_LSB              SND_SOC_DAIFMT_RIGHT_J
  38
  39 /*
  40  * DAI Clock gating.
  41  *
  42  * DAI bit clocks can be be gated (disabled) when the DAI is not
  43  * sending or receiving PCM data in a frame. This can be used to save power.
  44  */
  45 #define SND_SOC_DAIFMT_CONT             (0 << 4) /* continuous clock */
  46 #define SND_SOC_DAIFMT_GATED            (1 << 4) /* clock is gated */
  47
  48 /*
  49  * DAI hardware signal inversions.
  50  *
  51  * Specifies whether the DAI can also support inverted clocks for the specified
  52  * format.
  53  */
  54 #define SND_SOC_DAIFMT_NB_NF            (0 << 8) /* normal bit clock + frame */
  55 #define SND_SOC_DAIFMT_NB_IF            (1 << 8) /* normal BCLK + inv FRM */
  56 #define SND_SOC_DAIFMT_IB_NF            (2 << 8) /* invert BCLK + nor FRM */
  57 #define SND_SOC_DAIFMT_IB_IF            (3 << 8) /* invert BCLK + FRM */
  58
  59 /*
  60  * DAI hardware clock masters.
  61  *
  62  * This is wrt the codec, the inverse is true for the interface
  63  * i.e. if the codec is clk and FRM master then the interface is
  64  * clk and frame slave.
  65  */
  66 #define SND_SOC_DAIFMT_CBM_CFM          (0 << 12) /* codec clk & FRM master */
  67 #define SND_SOC_DAIFMT_CBS_CFM          (1 << 12) /* codec clk slave & FRM master */
  68 #define SND_SOC_DAIFMT_CBM_CFS          (2 << 12) /* codec clk master & frame slave */
  69 #define SND_SOC_DAIFMT_CBS_CFS          (3 << 12) /* codec clk & FRM slave */
  70
  71 #define SND_SOC_DAIFMT_FORMAT_MASK      0x000f
  72 #define SND_SOC_DAIFMT_CLOCK_MASK       0x00f0
  73 #define SND_SOC_DAIFMT_INV_MASK         0x0f00
  74 #define SND_SOC_DAIFMT_MASTER_MASK      0xf000
  75
  76 /*
  77  * Master Clock Directions
  78  */
  79 #define SND_SOC_CLOCK_IN                0
  80 #define SND_SOC_CLOCK_OUT               1
  81
  82 #define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\
  83                                SNDRV_PCM_FMTBIT_S16_LE |\
  84                                SNDRV_PCM_FMTBIT_S16_BE |\
  85                                SNDRV_PCM_FMTBIT_S20_3LE |\
  86                                SNDRV_PCM_FMTBIT_S20_3BE |\
  87                                SNDRV_PCM_FMTBIT_S24_3LE |\
  88                                SNDRV_PCM_FMTBIT_S24_3BE |\
  89                                SNDRV_PCM_FMTBIT_S32_LE |\
  90                                SNDRV_PCM_FMTBIT_S32_BE)
  91
  92 struct snd_soc_dai_driver;
  93 struct snd_soc_dai;
  94 struct snd_ac97_bus_ops;
  95
  96 /* Digital Audio Interface registration */
  97 int snd_soc_register_dai(struct device *dev,
  98                 struct snd_soc_dai_driver *dai_drv);
  99 void snd_soc_unregister_dai(struct device *dev);
 100 int snd_soc_register_dais(struct device *dev,
 101                 struct snd_soc_dai_driver *dai_drv, size_t count);
 102 void snd_soc_unregister_dais(struct device *dev, size_t count);
 103
 104 /* Digital Audio Interface clocking API.*/
 105 int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
 106         unsigned int freq, int dir);
 107
 108 int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
 109         int div_id, int div);
 110
 111 int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
 112         int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
 113
 114 /* Digital Audio interface formatting */
 115 int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
 116
 117 int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
 118         unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
 119
 120 int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
 121         unsigned int tx_num, unsigned int *tx_slot,
 122         unsigned int rx_num, unsigned int *rx_slot);
 123
 124 int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
 125
 126 /* Digital Audio Interface mute */
 127 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute);
 128
 129 struct snd_soc_dai_ops {
 130         /*
 131          * DAI clocking configuration, all optional.
 132          * Called by soc_card drivers, normally in their hw_params.
 133          */
 134         int (*set_sysclk)(struct snd_soc_dai *dai,
 135                 int clk_id, unsigned int freq, int dir);
 136         int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
 137                 unsigned int freq_in, unsigned int freq_out);
 138         int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
 139
 140         /*
 141          * DAI format configuration
 142          * Called by soc_card drivers, normally in their hw_params.
 143          */
 144         int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
 145         int (*set_tdm_slot)(struct snd_soc_dai *dai,
 146                 unsigned int tx_mask, unsigned int rx_mask,
 147                 int slots, int slot_width);
 148         int (*set_channel_map)(struct snd_soc_dai *dai,
 149                 unsigned int tx_num, unsigned int *tx_slot,
 150                 unsigned int rx_num, unsigned int *rx_slot);
 151         int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
 152
 153         /*
 154          * DAI digital mute - optional.
 155          * Called by soc-core to minimise any pops.
 156          */
 157         int (*digital_mute)(struct snd_soc_dai *dai, int mute);
 158
 159         /*
 160          * ALSA PCM audio operations - all optional.
 161          * Called by soc-core during audio PCM operations.
 162          */
 163         int (*startup)(struct snd_pcm_substream *,
 164                 struct snd_soc_dai *);
 165         void (*shutdown)(struct snd_pcm_substream *,
 166                 struct snd_soc_dai *);
 167         int (*hw_params)(struct snd_pcm_substream *,
 168                 struct snd_pcm_hw_params *, struct snd_soc_dai *);
 169         int (*hw_free)(struct snd_pcm_substream *,
 170                 struct snd_soc_dai *);
 171         int (*prepare)(struct snd_pcm_substream *,
 172                 struct snd_soc_dai *);
 173         int (*trigger)(struct snd_pcm_substream *, int,
 174                 struct snd_soc_dai *);
 175         int (*bespoke_trigger)(struct snd_pcm_substream *, int,
 176                 struct snd_soc_dai *);
 177         /*
 178          * For hardware based FIFO caused delay reporting.
 179          * Optional.
 180          */
 181         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 182                 struct snd_soc_dai *);
 183 };
 184
 185 /*
 186  * Digital Audio Interface Driver.
 187  *
 188  * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
 189  * operations and capabilities. Codec and platform drivers will register this
 190  * structure for every DAI they have.
 191  *
 192  * This structure covers the clocking, formating and ALSA operations for each
 193  * interface.
 194  */
 195 struct snd_soc_dai_driver {
 196         /* DAI description */
 197         const char *name;
 198         unsigned int id;
 199         int ac97_control;
 200
 201         /* DAI driver callbacks */
 202         int (*probe)(struct snd_soc_dai *dai);
 203         int (*remove)(struct snd_soc_dai *dai);
 204         int (*suspend)(struct snd_soc_dai *dai);
 205         int (*resume)(struct snd_soc_dai *dai);
 206
 207         /* ops */
 208         const struct snd_soc_dai_ops *ops;
 209
 210         /* DAI capabilities */
 211         struct snd_soc_pcm_stream capture;
 212         struct snd_soc_pcm_stream playback;
 213         unsigned int symmetric_rates:1;
 214
 215         /* probe ordering - for components with runtime dependencies */
 216         int probe_order;
 217         int remove_order;
 218 };
 219
 220 /*
 221  * Digital Audio Interface runtime data.
 222  *
 223  * Holds runtime data for a DAI.
 224  */
 225 struct snd_soc_dai {
 226         const char *name;
 227         int id;
 228         struct device *dev;
 229         void *ac97_pdata;       /* platform_data for the ac97 codec */
 230
 231         /* driver ops */
 232         struct snd_soc_dai_driver *driver;
 233
 234         /* DAI runtime info */
 235         unsigned int capture_active:1;          /* stream is in use */
 236         unsigned int playback_active:1;         /* stream is in use */
 237         unsigned int symmetric_rates:1;
 238         struct snd_pcm_runtime *runtime;
 239         unsigned int active;
 240         unsigned char pop_wait:1;
 241         unsigned char probed:1;
 242
 243         /* DAI DMA data */
 244         void *playback_dma_data;
 245         void *capture_dma_data;
 246
 247         /* parent platform/codec */
 248         union {
 249                 struct snd_soc_platform *platform;
 250                 struct snd_soc_codec *codec;
 251         };
 252         struct snd_soc_card *card;
 253
 254         struct list_head list;
 255         struct list_head card_list;
 256 };
 257
 258 static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
 259                                              const struct snd_pcm_substream *ss)
 260 {
 261         return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
 262                 dai->playback_dma_data : dai->capture_dma_data;
 263 }
 264
 265 static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
 266                                             const struct snd_pcm_substream *ss,
 267                                             void *data)
 268 {
 269         if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
 270                 dai->playback_dma_data = data;
 271         else
 272                 dai->capture_dma_data = data;
 273 }
 274
 275 static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
 276                 void *data)
 277 {
 278         dev_set_drvdata(dai->dev, data);
 279 }
 280
 281 static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
 282 {
 283         return dev_get_drvdata(dai->dev);
 284 }
 285
 286 /* Backend DAI PCM ops */
 287 static inline int snd_soc_dai_startup(struct snd_pcm_substream *substream,
 288         struct snd_soc_dai *dai)
 289 {
 290         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 291         int ret = 0;
 292
 293         mutex_lock(&rtd->pcm_mutex);
 294
 295         if (dai->driver->ops->startup)
 296                 ret = dai->driver->ops->startup(substream, dai);
 297
 298         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
 299                 dai->playback_active++;
 300         else
 301                 dai->capture_active++;
 302
 303         dai->active++;
 304
 305         mutex_unlock(&rtd->pcm_mutex);
 306         return ret;
 307 }
 308
 309 static inline void snd_soc_dai_shutdown(struct snd_pcm_substream *substream,
 310         struct snd_soc_dai *dai)
 311 {
 312         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 313
 314         mutex_lock(&rtd->pcm_mutex);
 315
 316         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
 317                 dai->playback_active--;
 318         else
 319                 dai->capture_active--;
 320
 321         dai->active--;
 322
 323         if (dai->driver->ops->shutdown)
 324                 dai->driver->ops->shutdown(substream, dai);
 325         mutex_unlock(&rtd->pcm_mutex);
 326 }
 327
 328 static inline int snd_soc_dai_hw_params(struct snd_pcm_substream * substream,
 329                 struct snd_pcm_hw_params *hw_params, struct snd_soc_dai *dai)
 330 {
 331         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 332         int ret = 0;
 333
 334         mutex_lock(&rtd->pcm_mutex);
 335
 336         if (dai->driver->ops->hw_params)
 337                 ret = dai->driver->ops->hw_params(substream, hw_params, dai);
 338
 339         mutex_unlock(&rtd->pcm_mutex);
 340         return ret;
 341 }
 342
 343 static inline int snd_soc_dai_hw_free(struct snd_pcm_substream *substream,
 344         struct snd_soc_dai *dai)
 345 {
 346         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 347         int ret = 0;
 348
 349         mutex_lock(&rtd->pcm_mutex);
 350
 351         if (dai->driver->ops->hw_free)
 352                 ret = dai->driver->ops->hw_free(substream, dai);
 353
 354         mutex_unlock(&rtd->pcm_mutex);
 355         return ret;
 356 }
 357
 358 static inline int snd_soc_dai_prepare(struct snd_pcm_substream *substream,
 359         struct snd_soc_dai *dai)
 360 {
 361         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 362         int ret = 0;
 363
 364         mutex_lock(&rtd->pcm_mutex);
 365
 366         if (dai->driver->ops->prepare)
 367                 ret = dai->driver->ops->prepare(substream, dai);
 368
 369         mutex_unlock(&rtd->pcm_mutex);
 370         return ret;
 371 }
 372
 373 static inline int snd_soc_dai_trigger(struct snd_pcm_substream *substream,
 374         int cmd, struct snd_soc_dai *dai)
 375 {
 376         if (dai->driver->ops->trigger)
 377                 return dai->driver->ops->trigger(substream, cmd, dai);
 378         return 0;
 379 }
 380 #endif