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
  34 /* left and right justified also known as MSB and LSB respectively */
  35 #define SND_SOC_DAIFMT_MSB              SND_SOC_DAIFMT_LEFT_J
  36 #define SND_SOC_DAIFMT_LSB              SND_SOC_DAIFMT_RIGHT_J
  37
  38 /*
  39  * DAI Clock gating.
  40  *
  41  * DAI bit clocks can be be gated (disabled) when not the DAI is not
  42  * sending or receiving PCM data in a frame. This can be used to save power.
  43  */
  44 #define SND_SOC_DAIFMT_CONT             (0 << 4) /* continuous clock */
  45 #define SND_SOC_DAIFMT_GATED            (1 << 4) /* clock is gated */
  46
  47 /*
  48  * DAI hardware signal inversions.
  49  *
  50  * Specifies whether the DAI can also support inverted clocks for the specified
  51  * format.
  52  */
  53 #define SND_SOC_DAIFMT_NB_NF            (0 << 8) /* normal bit clock + frame */
  54 #define SND_SOC_DAIFMT_NB_IF            (1 << 8) /* normal bclk + inv frm */
  55 #define SND_SOC_DAIFMT_IB_NF            (2 << 8) /* invert bclk + nor frm */
  56 #define SND_SOC_DAIFMT_IB_IF            (3 << 8) /* invert bclk + frm */
  57
  58 /*
  59  * DAI hardware clock masters.
  60  *
  61  * This is wrt the codec, the inverse is true for the interface
  62  * i.e. if the codec is clk and frm master then the interface is
  63  * clk and frame slave.
  64  */
  65 #define SND_SOC_DAIFMT_CBM_CFM          (0 << 12) /* codec clk & frm master */
  66 #define SND_SOC_DAIFMT_CBS_CFM          (1 << 12) /* codec clk slave & frm master */
  67 #define SND_SOC_DAIFMT_CBM_CFS          (2 << 12) /* codec clk master & frame slave */
  68 #define SND_SOC_DAIFMT_CBS_CFS          (3 << 12) /* codec clk & frm slave */
  69
  70 #define SND_SOC_DAIFMT_FORMAT_MASK      0x000f
  71 #define SND_SOC_DAIFMT_CLOCK_MASK       0x00f0
  72 #define SND_SOC_DAIFMT_INV_MASK         0x0f00
  73 #define SND_SOC_DAIFMT_MASTER_MASK      0xf000
  74
  75 /*
  76  * Master Clock Directions
  77  */
  78 #define SND_SOC_CLOCK_IN                0
  79 #define SND_SOC_CLOCK_OUT               1
  80
  81 #define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S16_LE |\
  82                                SNDRV_PCM_FMTBIT_S32_LE |\
  83                                SNDRV_PCM_FMTBIT_S32_BE)
  84
  85 struct snd_soc_dai_ops;
  86 struct snd_soc_dai;
  87 struct snd_ac97_bus_ops;
  88
  89 /* Digital Audio Interface registration */
  90 int snd_soc_register_dai(struct snd_soc_dai *dai);
  91 void snd_soc_unregister_dai(struct snd_soc_dai *dai);
  92 int snd_soc_register_dais(struct snd_soc_dai *dai, size_t count);
  93 void snd_soc_unregister_dais(struct snd_soc_dai *dai, size_t count);
  94
  95 /* Digital Audio Interface clocking API.*/
  96 int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
  97         unsigned int freq, int dir);
  98
  99 int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
 100         int div_id, int div);
 101
 102 int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
 103         int pll_id, unsigned int freq_in, unsigned int freq_out);
 104
 105 /* Digital Audio interface formatting */
 106 int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
 107
 108 int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
 109         unsigned int mask, int slots);
 110
 111 int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
 112
 113 /* Digital Audio Interface mute */
 114 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute);
 115
 116 /*
 117  * Digital Audio Interface.
 118  *
 119  * Describes the Digital Audio Interface in terms of it's ALSA, DAI and AC97
 120  * operations an capabilities. Codec and platfom drivers will register a this
 121  * structure for every DAI they have.
 122  *
 123  * This structure covers the clocking, formating and ALSA operations for each
 124  * interface a
 125  */
 126 struct snd_soc_dai_ops {
 127         /*
 128          * DAI clocking configuration, all optional.
 129          * Called by soc_card drivers, normally in their hw_params.
 130          */
 131         int (*set_sysclk)(struct snd_soc_dai *dai,
 132                 int clk_id, unsigned int freq, int dir);
 133         int (*set_pll)(struct snd_soc_dai *dai,
 134                 int pll_id, unsigned int freq_in, unsigned int freq_out);
 135         int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
 136
 137         /*
 138          * DAI format configuration
 139          * Called by soc_card drivers, normally in their hw_params.
 140          */
 141         int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
 142         int (*set_tdm_slot)(struct snd_soc_dai *dai,
 143                 unsigned int mask, int slots);
 144         int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
 145
 146         /*
 147          * DAI digital mute - optional.
 148          * Called by soc-core to minimise any pops.
 149          */
 150         int (*digital_mute)(struct snd_soc_dai *dai, int mute);
 151
 152         /*
 153          * ALSA PCM audio operations - all optional.
 154          * Called by soc-core during audio PCM operations.
 155          */
 156         int (*startup)(struct snd_pcm_substream *,
 157                 struct snd_soc_dai *);
 158         void (*shutdown)(struct snd_pcm_substream *,
 159                 struct snd_soc_dai *);
 160         int (*hw_params)(struct snd_pcm_substream *,
 161                 struct snd_pcm_hw_params *, struct snd_soc_dai *);
 162         int (*hw_free)(struct snd_pcm_substream *,
 163                 struct snd_soc_dai *);
 164         int (*prepare)(struct snd_pcm_substream *,
 165                 struct snd_soc_dai *);
 166         int (*trigger)(struct snd_pcm_substream *, int,
 167                 struct snd_soc_dai *);
 168 };
 169
 170 /*
 171  * Digital Audio Interface runtime data.
 172  *
 173  * Holds runtime data for a DAI.
 174  */
 175 struct snd_soc_dai {
 176         /* DAI description */
 177         char *name;
 178         unsigned int id;
 179         int ac97_control;
 180
 181         struct device *dev;
 182
 183         /* DAI callbacks */
 184         int (*probe)(struct platform_device *pdev,
 185                      struct snd_soc_dai *dai);
 186         void (*remove)(struct platform_device *pdev,
 187                        struct snd_soc_dai *dai);
 188         int (*suspend)(struct snd_soc_dai *dai);
 189         int (*resume)(struct snd_soc_dai *dai);
 190
 191         /* ops */
 192         struct snd_soc_dai_ops *ops;
 193
 194         /* DAI capabilities */
 195         struct snd_soc_pcm_stream capture;
 196         struct snd_soc_pcm_stream playback;
 197         unsigned int symmetric_rates:1;
 198
 199         /* DAI runtime info */
 200         struct snd_pcm_runtime *runtime;
 201         struct snd_soc_codec *codec;
 202         unsigned int active;
 203         unsigned char pop_wait:1;
 204         void *dma_data;
 205
 206         /* DAI private data */
 207         void *private_data;
 208
 209         /* parent platform */
 210         struct snd_soc_platform *platform;
 211
 212         struct list_head list;
 213 };
 214
 215 #endif