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 struct snd_soc_dapm_widget;
  21 struct snd_compr_stream;
  22
  23 /*
  24  * DAI hardware audio formats.
  25  *
  26  * Describes the physical PCM data formating and clocking. Add new formats
  27  * to the end.
  28  */
  29 #define SND_SOC_DAIFMT_I2S              1 /* I2S mode */
  30 #define SND_SOC_DAIFMT_RIGHT_J          2 /* Right Justified mode */
  31 #define SND_SOC_DAIFMT_LEFT_J           3 /* Left Justified mode */
  32 #define SND_SOC_DAIFMT_DSP_A            4 /* L data MSB after FRM LRC */
  33 #define SND_SOC_DAIFMT_DSP_B            5 /* L data MSB during FRM LRC */
  34 #define SND_SOC_DAIFMT_AC97             6 /* AC97 */
  35 #define SND_SOC_DAIFMT_PDM              7 /* Pulse density modulation */
  36 #define SND_SOC_DAIFMT_SPDIF            8 /* SPDIF */
  37
  38 /* left and right justified also known as MSB and LSB respectively */
  39 #define SND_SOC_DAIFMT_MSB              SND_SOC_DAIFMT_LEFT_J
  40 #define SND_SOC_DAIFMT_LSB              SND_SOC_DAIFMT_RIGHT_J
  41
  42 /*
  43  * DAI Clock gating.
  44  *
  45  * DAI bit clocks can be be gated (disabled) when the DAI is not
  46  * sending or receiving PCM data in a frame. This can be used to save power.
  47  */
  48 #define SND_SOC_DAIFMT_CONT             (1 << 4) /* continuous clock */
  49 #define SND_SOC_DAIFMT_GATED            (0 << 4) /* clock is gated */
  50
  51 /*
  52  * DAI hardware signal inversions.
  53  *
  54  * Specifies whether the DAI can also support inverted clocks for the specified
  55  * format.
  56  */
  57 #define SND_SOC_DAIFMT_NB_NF            (0 << 8) /* normal bit clock + frame */
  58 #define SND_SOC_DAIFMT_NB_IF            (2 << 8) /* normal BCLK + inv FRM */
  59 #define SND_SOC_DAIFMT_IB_NF            (3 << 8) /* invert BCLK + nor FRM */
  60 #define SND_SOC_DAIFMT_IB_IF            (4 << 8) /* invert BCLK + FRM */
  61
  62 /*
  63  * DAI hardware clock masters.
  64  *
  65  * This is wrt the codec, the inverse is true for the interface
  66  * i.e. if the codec is clk and FRM master then the interface is
  67  * clk and frame slave.
  68  */
  69 #define SND_SOC_DAIFMT_CBM_CFM          (1 << 12) /* codec clk & FRM master */
  70 #define SND_SOC_DAIFMT_CBS_CFM          (2 << 12) /* codec clk slave & FRM master */
  71 #define SND_SOC_DAIFMT_CBM_CFS          (3 << 12) /* codec clk master & frame slave */
  72 #define SND_SOC_DAIFMT_CBS_CFS          (4 << 12) /* codec clk & FRM slave */
  73
  74 #define SND_SOC_DAIFMT_FORMAT_MASK      0x000f
  75 #define SND_SOC_DAIFMT_CLOCK_MASK       0x00f0
  76 #define SND_SOC_DAIFMT_INV_MASK         0x0f00
  77 #define SND_SOC_DAIFMT_MASTER_MASK      0xf000
  78
  79 /*
  80  * Master Clock Directions
  81  */
  82 #define SND_SOC_CLOCK_IN                0
  83 #define SND_SOC_CLOCK_OUT               1
  84
  85 #define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\
  86                                SNDRV_PCM_FMTBIT_S16_LE |\
  87                                SNDRV_PCM_FMTBIT_S16_BE |\
  88                                SNDRV_PCM_FMTBIT_S20_3LE |\
  89                                SNDRV_PCM_FMTBIT_S20_3BE |\
  90                                SNDRV_PCM_FMTBIT_S24_3LE |\
  91                                SNDRV_PCM_FMTBIT_S24_3BE |\
  92                                SNDRV_PCM_FMTBIT_S32_LE |\
  93                                SNDRV_PCM_FMTBIT_S32_BE)
  94
  95 struct snd_soc_dai_driver;
  96 struct snd_soc_dai;
  97 struct snd_ac97_bus_ops;
  98
  99 /* Digital Audio Interface clocking API.*/
 100 int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
 101         unsigned int freq, int dir);
 102
 103 int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
 104         int div_id, int div);
 105
 106 int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
 107         int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
 108
 109 /* Digital Audio interface formatting */
 110 int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
 111
 112 int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
 113         unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
 114
 115 int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
 116         unsigned int tx_num, unsigned int *tx_slot,
 117         unsigned int rx_num, unsigned int *rx_slot);
 118
 119 int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
 120
 121 /* Digital Audio Interface mute */
 122 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
 123                              int direction);
 124
 125 struct snd_soc_dai_ops {
 126         /*
 127          * DAI clocking configuration, all optional.
 128          * Called by soc_card drivers, normally in their hw_params.
 129          */
 130         int (*set_sysclk)(struct snd_soc_dai *dai,
 131                 int clk_id, unsigned int freq, int dir);
 132         int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
 133                 unsigned int freq_in, unsigned int freq_out);
 134         int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
 135
 136         /*
 137          * DAI format configuration
 138          * Called by soc_card drivers, normally in their hw_params.
 139          */
 140         int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
 141         int (*set_tdm_slot)(struct snd_soc_dai *dai,
 142                 unsigned int tx_mask, unsigned int rx_mask,
 143                 int slots, int slot_width);
 144         int (*set_channel_map)(struct snd_soc_dai *dai,
 145                 unsigned int tx_num, unsigned int *tx_slot,
 146                 unsigned int rx_num, unsigned int *rx_slot);
 147         int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
 148
 149         /*
 150          * DAI digital mute - optional.
 151          * Called by soc-core to minimise any pops.
 152          */
 153         int (*digital_mute)(struct snd_soc_dai *dai, int mute);
 154         int (*mute_stream)(struct snd_soc_dai *dai, int mute, int stream);
 155
 156         /*
 157          * ALSA PCM audio operations - all optional.
 158          * Called by soc-core during audio PCM operations.
 159          */
 160         int (*startup)(struct snd_pcm_substream *,
 161                 struct snd_soc_dai *);
 162         void (*shutdown)(struct snd_pcm_substream *,
 163                 struct snd_soc_dai *);
 164         int (*hw_params)(struct snd_pcm_substream *,
 165                 struct snd_pcm_hw_params *, struct snd_soc_dai *);
 166         int (*hw_free)(struct snd_pcm_substream *,
 167                 struct snd_soc_dai *);
 168         int (*prepare)(struct snd_pcm_substream *,
 169                 struct snd_soc_dai *);
 170         int (*trigger)(struct snd_pcm_substream *, int,
 171                 struct snd_soc_dai *);
 172         int (*bespoke_trigger)(struct snd_pcm_substream *, int,
 173                 struct snd_soc_dai *);
 174         /*
 175          * For hardware based FIFO caused delay reporting.
 176          * Optional.
 177          */
 178         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 179                 struct snd_soc_dai *);
 180 };
 181
 182 /*
 183  * Digital Audio Interface Driver.
 184  *
 185  * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
 186  * operations and capabilities. Codec and platform drivers will register this
 187  * structure for every DAI they have.
 188  *
 189  * This structure covers the clocking, formating and ALSA operations for each
 190  * interface.
 191  */
 192 struct snd_soc_dai_driver {
 193         /* DAI description */
 194         const char *name;
 195         unsigned int id;
 196         int ac97_control;
 197         unsigned int base;
 198
 199         /* DAI driver callbacks */
 200         int (*probe)(struct snd_soc_dai *dai);
 201         int (*remove)(struct snd_soc_dai *dai);
 202         int (*suspend)(struct snd_soc_dai *dai);
 203         int (*resume)(struct snd_soc_dai *dai);
 204         /* compress dai */
 205         bool compress_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 probed:1;
 241
 242         struct snd_soc_dapm_widget *playback_widget;
 243         struct snd_soc_dapm_widget *capture_widget;
 244         struct snd_soc_dapm_context dapm;
 245
 246         /* DAI DMA data */
 247         void *playback_dma_data;
 248         void *capture_dma_data;
 249
 250         /* Symmetry data - only valid if symmetry is being enforced */
 251         unsigned int rate;
 252
 253         /* parent platform/codec */
 254         struct snd_soc_platform *platform;
 255         struct snd_soc_codec *codec;
 256
 257         struct snd_soc_card *card;
 258
 259         struct list_head list;
 260         struct list_head card_list;
 261 };
 262
 263 static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
 264                                              const struct snd_pcm_substream *ss)
 265 {
 266         return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
 267                 dai->playback_dma_data : dai->capture_dma_data;
 268 }
 269
 270 static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
 271                                             const struct snd_pcm_substream *ss,
 272                                             void *data)
 273 {
 274         if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
 275                 dai->playback_dma_data = data;
 276         else
 277                 dai->capture_dma_data = data;
 278 }
 279
 280 static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
 281                 void *data)
 282 {
 283         dev_set_drvdata(dai->dev, data);
 284 }
 285
 286 static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
 287 {
 288         return dev_get_drvdata(dai->dev);
 289 }
 290
 291 #endif