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