1 /* SPDX-License-Identifier: GPL-2.0 2 * 3 * linux/sound/soc-dai.h -- ALSA SoC Layer 4 * 5 * Copyright: 2005-2008 Wolfson Microelectronics. PLC. 6 * 7 * Digital Audio Interface (DAI) API. 8 */ 9 10 #ifndef __LINUX_SND_SOC_DAI_H 11 #define __LINUX_SND_SOC_DAI_H 12 13 14 #include <linux/list.h> 15 #include <sound/asoc.h> 16 17 struct snd_pcm_substream; 18 struct snd_soc_dapm_widget; 19 struct snd_compr_stream; 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 SND_SOC_DAI_FORMAT_I2S 28 #define SND_SOC_DAIFMT_RIGHT_J SND_SOC_DAI_FORMAT_RIGHT_J 29 #define SND_SOC_DAIFMT_LEFT_J SND_SOC_DAI_FORMAT_LEFT_J 30 #define SND_SOC_DAIFMT_DSP_A SND_SOC_DAI_FORMAT_DSP_A 31 #define SND_SOC_DAIFMT_DSP_B SND_SOC_DAI_FORMAT_DSP_B 32 #define SND_SOC_DAIFMT_AC97 SND_SOC_DAI_FORMAT_AC97 33 #define SND_SOC_DAIFMT_PDM SND_SOC_DAI_FORMAT_PDM 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 (1 << 4) /* continuous clock */ 46 #define SND_SOC_DAIFMT_GATED (0 << 4) /* clock is gated */ 47 48 /* 49 * DAI hardware signal polarity. 50 * 51 * Specifies whether the DAI can also support inverted clocks for the specified 52 * format. 53 * 54 * BCLK: 55 * - "normal" polarity means signal is available at rising edge of BCLK 56 * - "inverted" polarity means signal is available at falling edge of BCLK 57 * 58 * FSYNC "normal" polarity depends on the frame format: 59 * - I2S: frame consists of left then right channel data. Left channel starts 60 * with falling FSYNC edge, right channel starts with rising FSYNC edge. 61 * - Left/Right Justified: frame consists of left then right channel data. 62 * Left channel starts with rising FSYNC edge, right channel starts with 63 * falling FSYNC edge. 64 * - DSP A/B: Frame starts with rising FSYNC edge. 65 * - AC97: Frame starts with rising FSYNC edge. 66 * 67 * "Negative" FSYNC polarity is the one opposite of "normal" polarity. 68 */ 69 #define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */ 70 #define SND_SOC_DAIFMT_NB_IF (2 << 8) /* normal BCLK + inv FRM */ 71 #define SND_SOC_DAIFMT_IB_NF (3 << 8) /* invert BCLK + nor FRM */ 72 #define SND_SOC_DAIFMT_IB_IF (4 << 8) /* invert BCLK + FRM */ 73 74 /* 75 * DAI hardware clock masters. 76 * 77 * This is wrt the codec, the inverse is true for the interface 78 * i.e. if the codec is clk and FRM master then the interface is 79 * clk and frame slave. 80 */ 81 #define SND_SOC_DAIFMT_CBM_CFM (1 << 12) /* codec clk & FRM master */ 82 #define SND_SOC_DAIFMT_CBS_CFM (2 << 12) /* codec clk slave & FRM master */ 83 #define SND_SOC_DAIFMT_CBM_CFS (3 << 12) /* codec clk master & frame slave */ 84 #define SND_SOC_DAIFMT_CBS_CFS (4 << 12) /* codec clk & FRM slave */ 85 86 #define SND_SOC_DAIFMT_FORMAT_MASK 0x000f 87 #define SND_SOC_DAIFMT_CLOCK_MASK 0x00f0 88 #define SND_SOC_DAIFMT_INV_MASK 0x0f00 89 #define SND_SOC_DAIFMT_MASTER_MASK 0xf000 90 91 /* 92 * Master Clock Directions 93 */ 94 #define SND_SOC_CLOCK_IN 0 95 #define SND_SOC_CLOCK_OUT 1 96 97 #define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\ 98 SNDRV_PCM_FMTBIT_S16_LE |\ 99 SNDRV_PCM_FMTBIT_S16_BE |\ 100 SNDRV_PCM_FMTBIT_S20_3LE |\ 101 SNDRV_PCM_FMTBIT_S20_3BE |\ 102 SNDRV_PCM_FMTBIT_S20_LE |\ 103 SNDRV_PCM_FMTBIT_S20_BE |\ 104 SNDRV_PCM_FMTBIT_S24_3LE |\ 105 SNDRV_PCM_FMTBIT_S24_3BE |\ 106 SNDRV_PCM_FMTBIT_S32_LE |\ 107 SNDRV_PCM_FMTBIT_S32_BE) 108 109 struct snd_soc_dai_driver; 110 struct snd_soc_dai; 111 struct snd_ac97_bus_ops; 112 113 /* Digital Audio Interface clocking API.*/ 114 int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id, 115 unsigned int freq, int dir); 116 117 int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai, 118 int div_id, int div); 119 120 int snd_soc_dai_set_pll(struct snd_soc_dai *dai, 121 int pll_id, int source, unsigned int freq_in, unsigned int freq_out); 122 123 int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio); 124 125 /* Digital Audio interface formatting */ 126 int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt); 127 128 int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai, 129 unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width); 130 131 int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai, 132 unsigned int tx_num, unsigned int *tx_slot, 133 unsigned int rx_num, unsigned int *rx_slot); 134 135 int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate); 136 137 /* Digital Audio Interface mute */ 138 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute, 139 int direction); 140 141 142 int snd_soc_dai_get_channel_map(struct snd_soc_dai *dai, 143 unsigned int *tx_num, unsigned int *tx_slot, 144 unsigned int *rx_num, unsigned int *rx_slot); 145 146 int snd_soc_dai_is_dummy(struct snd_soc_dai *dai); 147 148 int snd_soc_dai_hw_params(struct snd_soc_dai *dai, 149 struct snd_pcm_substream *substream, 150 struct snd_pcm_hw_params *params); 151 void snd_soc_dai_hw_free(struct snd_soc_dai *dai, 152 struct snd_pcm_substream *substream); 153 int snd_soc_dai_startup(struct snd_soc_dai *dai, 154 struct snd_pcm_substream *substream); 155 void snd_soc_dai_shutdown(struct snd_soc_dai *dai, 156 struct snd_pcm_substream *substream); 157 snd_pcm_sframes_t snd_soc_dai_delay(struct snd_soc_dai *dai, 158 struct snd_pcm_substream *substream); 159 void snd_soc_dai_suspend(struct snd_soc_dai *dai); 160 void snd_soc_dai_resume(struct snd_soc_dai *dai); 161 int snd_soc_dai_compress_new(struct snd_soc_dai *dai, 162 struct snd_soc_pcm_runtime *rtd, int num); 163 bool snd_soc_dai_stream_valid(struct snd_soc_dai *dai, int stream); 164 void snd_soc_dai_action(struct snd_soc_dai *dai, 165 int stream, int action); 166 static inline void snd_soc_dai_activate(struct snd_soc_dai *dai, 167 int stream) 168 { 169 snd_soc_dai_action(dai, stream, 1); 170 } 171 static inline void snd_soc_dai_deactivate(struct snd_soc_dai *dai, 172 int stream) 173 { 174 snd_soc_dai_action(dai, stream, -1); 175 } 176 int snd_soc_dai_active(struct snd_soc_dai *dai); 177 178 int snd_soc_pcm_dai_probe(struct snd_soc_pcm_runtime *rtd, int order); 179 int snd_soc_pcm_dai_remove(struct snd_soc_pcm_runtime *rtd, int order); 180 int snd_soc_pcm_dai_new(struct snd_soc_pcm_runtime *rtd); 181 int snd_soc_pcm_dai_prepare(struct snd_pcm_substream *substream); 182 int snd_soc_pcm_dai_trigger(struct snd_pcm_substream *substream, int cmd); 183 int snd_soc_pcm_dai_bespoke_trigger(struct snd_pcm_substream *substream, 184 int cmd); 185 186 int snd_soc_dai_compr_startup(struct snd_soc_dai *dai, 187 struct snd_compr_stream *cstream); 188 void snd_soc_dai_compr_shutdown(struct snd_soc_dai *dai, 189 struct snd_compr_stream *cstream); 190 int snd_soc_dai_compr_trigger(struct snd_soc_dai *dai, 191 struct snd_compr_stream *cstream, int cmd); 192 int snd_soc_dai_compr_set_params(struct snd_soc_dai *dai, 193 struct snd_compr_stream *cstream, 194 struct snd_compr_params *params); 195 int snd_soc_dai_compr_get_params(struct snd_soc_dai *dai, 196 struct snd_compr_stream *cstream, 197 struct snd_codec *params); 198 int snd_soc_dai_compr_ack(struct snd_soc_dai *dai, 199 struct snd_compr_stream *cstream, 200 size_t bytes); 201 int snd_soc_dai_compr_pointer(struct snd_soc_dai *dai, 202 struct snd_compr_stream *cstream, 203 struct snd_compr_tstamp *tstamp); 204 int snd_soc_dai_compr_set_metadata(struct snd_soc_dai *dai, 205 struct snd_compr_stream *cstream, 206 struct snd_compr_metadata *metadata); 207 int snd_soc_dai_compr_get_metadata(struct snd_soc_dai *dai, 208 struct snd_compr_stream *cstream, 209 struct snd_compr_metadata *metadata); 210 211 struct snd_soc_dai_ops { 212 /* 213 * DAI clocking configuration, all optional. 214 * Called by soc_card drivers, normally in their hw_params. 215 */ 216 int (*set_sysclk)(struct snd_soc_dai *dai, 217 int clk_id, unsigned int freq, int dir); 218 int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source, 219 unsigned int freq_in, unsigned int freq_out); 220 int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div); 221 int (*set_bclk_ratio)(struct snd_soc_dai *dai, unsigned int ratio); 222 223 /* 224 * DAI format configuration 225 * Called by soc_card drivers, normally in their hw_params. 226 */ 227 int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt); 228 int (*xlate_tdm_slot_mask)(unsigned int slots, 229 unsigned int *tx_mask, unsigned int *rx_mask); 230 int (*set_tdm_slot)(struct snd_soc_dai *dai, 231 unsigned int tx_mask, unsigned int rx_mask, 232 int slots, int slot_width); 233 int (*set_channel_map)(struct snd_soc_dai *dai, 234 unsigned int tx_num, unsigned int *tx_slot, 235 unsigned int rx_num, unsigned int *rx_slot); 236 int (*get_channel_map)(struct snd_soc_dai *dai, 237 unsigned int *tx_num, unsigned int *tx_slot, 238 unsigned int *rx_num, unsigned int *rx_slot); 239 int (*set_tristate)(struct snd_soc_dai *dai, int tristate); 240 241 int (*set_sdw_stream)(struct snd_soc_dai *dai, 242 void *stream, int direction); 243 void *(*get_sdw_stream)(struct snd_soc_dai *dai, int direction); 244 245 /* 246 * DAI digital mute - optional. 247 * Called by soc-core to minimise any pops. 248 */ 249 int (*digital_mute)(struct snd_soc_dai *dai, int mute); 250 int (*mute_stream)(struct snd_soc_dai *dai, int mute, int stream); 251 252 /* 253 * ALSA PCM audio operations - all optional. 254 * Called by soc-core during audio PCM operations. 255 */ 256 int (*startup)(struct snd_pcm_substream *, 257 struct snd_soc_dai *); 258 void (*shutdown)(struct snd_pcm_substream *, 259 struct snd_soc_dai *); 260 int (*hw_params)(struct snd_pcm_substream *, 261 struct snd_pcm_hw_params *, struct snd_soc_dai *); 262 int (*hw_free)(struct snd_pcm_substream *, 263 struct snd_soc_dai *); 264 int (*prepare)(struct snd_pcm_substream *, 265 struct snd_soc_dai *); 266 /* 267 * NOTE: Commands passed to the trigger function are not necessarily 268 * compatible with the current state of the dai. For example this 269 * sequence of commands is possible: START STOP STOP. 270 * So do not unconditionally use refcounting functions in the trigger 271 * function, e.g. clk_enable/disable. 272 */ 273 int (*trigger)(struct snd_pcm_substream *, int, 274 struct snd_soc_dai *); 275 int (*bespoke_trigger)(struct snd_pcm_substream *, int, 276 struct snd_soc_dai *); 277 /* 278 * For hardware based FIFO caused delay reporting. 279 * Optional. 280 */ 281 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *, 282 struct snd_soc_dai *); 283 }; 284 285 struct snd_soc_cdai_ops { 286 /* 287 * for compress ops 288 */ 289 int (*startup)(struct snd_compr_stream *, 290 struct snd_soc_dai *); 291 int (*shutdown)(struct snd_compr_stream *, 292 struct snd_soc_dai *); 293 int (*set_params)(struct snd_compr_stream *, 294 struct snd_compr_params *, struct snd_soc_dai *); 295 int (*get_params)(struct snd_compr_stream *, 296 struct snd_codec *, struct snd_soc_dai *); 297 int (*set_metadata)(struct snd_compr_stream *, 298 struct snd_compr_metadata *, struct snd_soc_dai *); 299 int (*get_metadata)(struct snd_compr_stream *, 300 struct snd_compr_metadata *, struct snd_soc_dai *); 301 int (*trigger)(struct snd_compr_stream *, int, 302 struct snd_soc_dai *); 303 int (*pointer)(struct snd_compr_stream *, 304 struct snd_compr_tstamp *, struct snd_soc_dai *); 305 int (*ack)(struct snd_compr_stream *, size_t, 306 struct snd_soc_dai *); 307 }; 308 309 /* 310 * Digital Audio Interface Driver. 311 * 312 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97 313 * operations and capabilities. Codec and platform drivers will register this 314 * structure for every DAI they have. 315 * 316 * This structure covers the clocking, formating and ALSA operations for each 317 * interface. 318 */ 319 struct snd_soc_dai_driver { 320 /* DAI description */ 321 const char *name; 322 unsigned int id; 323 unsigned int base; 324 struct snd_soc_dobj dobj; 325 326 /* DAI driver callbacks */ 327 int (*probe)(struct snd_soc_dai *dai); 328 int (*remove)(struct snd_soc_dai *dai); 329 /* compress dai */ 330 int (*compress_new)(struct snd_soc_pcm_runtime *rtd, int num); 331 /* Optional Callback used at pcm creation*/ 332 int (*pcm_new)(struct snd_soc_pcm_runtime *rtd, 333 struct snd_soc_dai *dai); 334 335 /* ops */ 336 const struct snd_soc_dai_ops *ops; 337 const struct snd_soc_cdai_ops *cops; 338 339 /* DAI capabilities */ 340 struct snd_soc_pcm_stream capture; 341 struct snd_soc_pcm_stream playback; 342 unsigned int symmetric_rates:1; 343 unsigned int symmetric_channels:1; 344 unsigned int symmetric_samplebits:1; 345 346 /* probe ordering - for components with runtime dependencies */ 347 int probe_order; 348 int remove_order; 349 }; 350 351 /* 352 * Digital Audio Interface runtime data. 353 * 354 * Holds runtime data for a DAI. 355 */ 356 struct snd_soc_dai { 357 const char *name; 358 int id; 359 struct device *dev; 360 361 /* driver ops */ 362 struct snd_soc_dai_driver *driver; 363 364 /* DAI runtime info */ 365 unsigned int stream_active[SNDRV_PCM_STREAM_LAST + 1]; /* usage count */ 366 367 struct snd_soc_dapm_widget *playback_widget; 368 struct snd_soc_dapm_widget *capture_widget; 369 370 /* DAI DMA data */ 371 void *playback_dma_data; 372 void *capture_dma_data; 373 374 /* Symmetry data - only valid if symmetry is being enforced */ 375 unsigned int rate; 376 unsigned int channels; 377 unsigned int sample_bits; 378 379 /* parent platform/codec */ 380 struct snd_soc_component *component; 381 382 /* CODEC TDM slot masks and params (for fixup) */ 383 unsigned int tx_mask; 384 unsigned int rx_mask; 385 386 struct list_head list; 387 388 /* bit field */ 389 unsigned int probed:1; 390 }; 391 392 static inline struct snd_soc_pcm_stream * 393 snd_soc_dai_get_pcm_stream(const struct snd_soc_dai *dai, int stream) 394 { 395 return (stream == SNDRV_PCM_STREAM_PLAYBACK) ? 396 &dai->driver->playback : &dai->driver->capture; 397 } 398 399 static inline 400 struct snd_soc_dapm_widget *snd_soc_dai_get_widget( 401 struct snd_soc_dai *dai, int stream) 402 { 403 return (stream == SNDRV_PCM_STREAM_PLAYBACK) ? 404 dai->playback_widget : dai->capture_widget; 405 } 406 407 static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai, 408 const struct snd_pcm_substream *ss) 409 { 410 return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ? 411 dai->playback_dma_data : dai->capture_dma_data; 412 } 413 414 static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai, 415 const struct snd_pcm_substream *ss, 416 void *data) 417 { 418 if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) 419 dai->playback_dma_data = data; 420 else 421 dai->capture_dma_data = data; 422 } 423 424 static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai, 425 void *playback, void *capture) 426 { 427 dai->playback_dma_data = playback; 428 dai->capture_dma_data = capture; 429 } 430 431 static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai, 432 void *data) 433 { 434 dev_set_drvdata(dai->dev, data); 435 } 436 437 static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai) 438 { 439 return dev_get_drvdata(dai->dev); 440 } 441 442 /** 443 * snd_soc_dai_set_sdw_stream() - Configures a DAI for SDW stream operation 444 * @dai: DAI 445 * @stream: STREAM 446 * @direction: Stream direction(Playback/Capture) 447 * SoundWire subsystem doesn't have a notion of direction and we reuse 448 * the ASoC stream direction to configure sink/source ports. 449 * Playback maps to source ports and Capture for sink ports. 450 * 451 * This should be invoked with NULL to clear the stream set previously. 452 * Returns 0 on success, a negative error code otherwise. 453 */ 454 static inline int snd_soc_dai_set_sdw_stream(struct snd_soc_dai *dai, 455 void *stream, int direction) 456 { 457 if (dai->driver->ops->set_sdw_stream) 458 return dai->driver->ops->set_sdw_stream(dai, stream, direction); 459 else 460 return -ENOTSUPP; 461 } 462 463 /** 464 * snd_soc_dai_get_sdw_stream() - Retrieves SDW stream from DAI 465 * @dai: DAI 466 * @direction: Stream direction(Playback/Capture) 467 * 468 * This routine only retrieves that was previously configured 469 * with snd_soc_dai_get_sdw_stream() 470 * 471 * Returns pointer to stream or -ENOTSUPP if callback is not supported; 472 */ 473 static inline void *snd_soc_dai_get_sdw_stream(struct snd_soc_dai *dai, 474 int direction) 475 { 476 if (dai->driver->ops->get_sdw_stream) 477 return dai->driver->ops->get_sdw_stream(dai, direction); 478 else 479 return ERR_PTR(-ENOTSUPP); 480 } 481 482 static inline unsigned int 483 snd_soc_dai_stream_active(struct snd_soc_dai *dai, int stream) 484 { 485 return dai->stream_active[stream]; 486 } 487 488 #endif 489