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