include/sound/soc-dai.h

   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_link_set_capabilities(struct snd_soc_dai_link *dai_link);
 165 void snd_soc_dai_action(struct snd_soc_dai *dai,
 166                         int stream, int action);
 167 static inline void snd_soc_dai_activate(struct snd_soc_dai *dai,
 168                                         int stream)
 169 {
 170         snd_soc_dai_action(dai, stream,  1);
 171 }
 172 static inline void snd_soc_dai_deactivate(struct snd_soc_dai *dai,
 173                                           int stream)
 174 {
 175         snd_soc_dai_action(dai, stream, -1);
 176 }
 177 int snd_soc_dai_active(struct snd_soc_dai *dai);
 178
 179 int snd_soc_pcm_dai_probe(struct snd_soc_pcm_runtime *rtd, int order);
 180 int snd_soc_pcm_dai_remove(struct snd_soc_pcm_runtime *rtd, int order);
 181 int snd_soc_pcm_dai_new(struct snd_soc_pcm_runtime *rtd);
 182 int snd_soc_pcm_dai_prepare(struct snd_pcm_substream *substream);
 183 int snd_soc_pcm_dai_trigger(struct snd_pcm_substream *substream, int cmd);
 184 int snd_soc_pcm_dai_bespoke_trigger(struct snd_pcm_substream *substream,
 185                                     int cmd);
 186
 187 int snd_soc_dai_compr_startup(struct snd_soc_dai *dai,
 188                               struct snd_compr_stream *cstream);
 189 void snd_soc_dai_compr_shutdown(struct snd_soc_dai *dai,
 190                                 struct snd_compr_stream *cstream);
 191 int snd_soc_dai_compr_trigger(struct snd_soc_dai *dai,
 192                               struct snd_compr_stream *cstream, int cmd);
 193 int snd_soc_dai_compr_set_params(struct snd_soc_dai *dai,
 194                                  struct snd_compr_stream *cstream,
 195                                  struct snd_compr_params *params);
 196 int snd_soc_dai_compr_get_params(struct snd_soc_dai *dai,
 197                                  struct snd_compr_stream *cstream,
 198                                  struct snd_codec *params);
 199 int snd_soc_dai_compr_ack(struct snd_soc_dai *dai,
 200                           struct snd_compr_stream *cstream,
 201                           size_t bytes);
 202 int snd_soc_dai_compr_pointer(struct snd_soc_dai *dai,
 203                               struct snd_compr_stream *cstream,
 204                               struct snd_compr_tstamp *tstamp);
 205 int snd_soc_dai_compr_set_metadata(struct snd_soc_dai *dai,
 206                                    struct snd_compr_stream *cstream,
 207                                    struct snd_compr_metadata *metadata);
 208 int snd_soc_dai_compr_get_metadata(struct snd_soc_dai *dai,
 209                                    struct snd_compr_stream *cstream,
 210                                    struct snd_compr_metadata *metadata);
 211
 212 struct snd_soc_dai_ops {
 213         /*
 214          * DAI clocking configuration, all optional.
 215          * Called by soc_card drivers, normally in their hw_params.
 216          */
 217         int (*set_sysclk)(struct snd_soc_dai *dai,
 218                 int clk_id, unsigned int freq, int dir);
 219         int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
 220                 unsigned int freq_in, unsigned int freq_out);
 221         int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
 222         int (*set_bclk_ratio)(struct snd_soc_dai *dai, unsigned int ratio);
 223
 224         /*
 225          * DAI format configuration
 226          * Called by soc_card drivers, normally in their hw_params.
 227          */
 228         int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
 229         int (*xlate_tdm_slot_mask)(unsigned int slots,
 230                 unsigned int *tx_mask, unsigned int *rx_mask);
 231         int (*set_tdm_slot)(struct snd_soc_dai *dai,
 232                 unsigned int tx_mask, unsigned int rx_mask,
 233                 int slots, int slot_width);
 234         int (*set_channel_map)(struct snd_soc_dai *dai,
 235                 unsigned int tx_num, unsigned int *tx_slot,
 236                 unsigned int rx_num, unsigned int *rx_slot);
 237         int (*get_channel_map)(struct snd_soc_dai *dai,
 238                         unsigned int *tx_num, unsigned int *tx_slot,
 239                         unsigned int *rx_num, unsigned int *rx_slot);
 240         int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
 241
 242         int (*set_sdw_stream)(struct snd_soc_dai *dai,
 243                         void *stream, int direction);
 244         void *(*get_sdw_stream)(struct snd_soc_dai *dai, int direction);
 245
 246         /*
 247          * DAI digital mute - optional.
 248          * Called by soc-core to minimise any pops.
 249          */
 250         int (*digital_mute)(struct snd_soc_dai *dai, int mute);
 251         int (*mute_stream)(struct snd_soc_dai *dai, int mute, int stream);
 252
 253         /*
 254          * ALSA PCM audio operations - all optional.
 255          * Called by soc-core during audio PCM operations.
 256          */
 257         int (*startup)(struct snd_pcm_substream *,
 258                 struct snd_soc_dai *);
 259         void (*shutdown)(struct snd_pcm_substream *,
 260                 struct snd_soc_dai *);
 261         int (*hw_params)(struct snd_pcm_substream *,
 262                 struct snd_pcm_hw_params *, struct snd_soc_dai *);
 263         int (*hw_free)(struct snd_pcm_substream *,
 264                 struct snd_soc_dai *);
 265         int (*prepare)(struct snd_pcm_substream *,
 266                 struct snd_soc_dai *);
 267         /*
 268          * NOTE: Commands passed to the trigger function are not necessarily
 269          * compatible with the current state of the dai. For example this
 270          * sequence of commands is possible: START STOP STOP.
 271          * So do not unconditionally use refcounting functions in the trigger
 272          * function, e.g. clk_enable/disable.
 273          */
 274         int (*trigger)(struct snd_pcm_substream *, int,
 275                 struct snd_soc_dai *);
 276         int (*bespoke_trigger)(struct snd_pcm_substream *, int,
 277                 struct snd_soc_dai *);
 278         /*
 279          * For hardware based FIFO caused delay reporting.
 280          * Optional.
 281          */
 282         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 283                 struct snd_soc_dai *);
 284 };
 285
 286 struct snd_soc_cdai_ops {
 287         /*
 288          * for compress ops
 289          */
 290         int (*startup)(struct snd_compr_stream *,
 291                         struct snd_soc_dai *);
 292         int (*shutdown)(struct snd_compr_stream *,
 293                         struct snd_soc_dai *);
 294         int (*set_params)(struct snd_compr_stream *,
 295                         struct snd_compr_params *, struct snd_soc_dai *);
 296         int (*get_params)(struct snd_compr_stream *,
 297                         struct snd_codec *, struct snd_soc_dai *);
 298         int (*set_metadata)(struct snd_compr_stream *,
 299                         struct snd_compr_metadata *, struct snd_soc_dai *);
 300         int (*get_metadata)(struct snd_compr_stream *,
 301                         struct snd_compr_metadata *, struct snd_soc_dai *);
 302         int (*trigger)(struct snd_compr_stream *, int,
 303                         struct snd_soc_dai *);
 304         int (*pointer)(struct snd_compr_stream *,
 305                         struct snd_compr_tstamp *, struct snd_soc_dai *);
 306         int (*ack)(struct snd_compr_stream *, size_t,
 307                         struct snd_soc_dai *);
 308 };
 309
 310 /*
 311  * Digital Audio Interface Driver.
 312  *
 313  * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
 314  * operations and capabilities. Codec and platform drivers will register this
 315  * structure for every DAI they have.
 316  *
 317  * This structure covers the clocking, formating and ALSA operations for each
 318  * interface.
 319  */
 320 struct snd_soc_dai_driver {
 321         /* DAI description */
 322         const char *name;
 323         unsigned int id;
 324         unsigned int base;
 325         struct snd_soc_dobj dobj;
 326
 327         /* DAI driver callbacks */
 328         int (*probe)(struct snd_soc_dai *dai);
 329         int (*remove)(struct snd_soc_dai *dai);
 330         /* compress dai */
 331         int (*compress_new)(struct snd_soc_pcm_runtime *rtd, int num);
 332         /* Optional Callback used at pcm creation*/
 333         int (*pcm_new)(struct snd_soc_pcm_runtime *rtd,
 334                        struct snd_soc_dai *dai);
 335
 336         /* ops */
 337         const struct snd_soc_dai_ops *ops;
 338         const struct snd_soc_cdai_ops *cops;
 339
 340         /* DAI capabilities */
 341         struct snd_soc_pcm_stream capture;
 342         struct snd_soc_pcm_stream playback;
 343         unsigned int symmetric_rates:1;
 344         unsigned int symmetric_channels:1;
 345         unsigned int symmetric_samplebits:1;
 346
 347         /* probe ordering - for components with runtime dependencies */
 348         int probe_order;
 349         int remove_order;
 350 };
 351
 352 /*
 353  * Digital Audio Interface runtime data.
 354  *
 355  * Holds runtime data for a DAI.
 356  */
 357 struct snd_soc_dai {
 358         const char *name;
 359         int id;
 360         struct device *dev;
 361
 362         /* driver ops */
 363         struct snd_soc_dai_driver *driver;
 364
 365         /* DAI runtime info */
 366         unsigned int stream_active[SNDRV_PCM_STREAM_LAST + 1]; /* usage count */
 367
 368         struct snd_soc_dapm_widget *playback_widget;
 369         struct snd_soc_dapm_widget *capture_widget;
 370
 371         /* DAI DMA data */
 372         void *playback_dma_data;
 373         void *capture_dma_data;
 374
 375         /* Symmetry data - only valid if symmetry is being enforced */
 376         unsigned int rate;
 377         unsigned int channels;
 378         unsigned int sample_bits;
 379
 380         /* parent platform/codec */
 381         struct snd_soc_component *component;
 382
 383         /* CODEC TDM slot masks and params (for fixup) */
 384         unsigned int tx_mask;
 385         unsigned int rx_mask;
 386
 387         struct list_head list;
 388
 389         /* bit field */
 390         unsigned int probed:1;
 391 };
 392
 393 static inline struct snd_soc_pcm_stream *
 394 snd_soc_dai_get_pcm_stream(const struct snd_soc_dai *dai, int stream)
 395 {
 396         return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
 397                 &dai->driver->playback : &dai->driver->capture;
 398 }
 399
 400 static inline
 401 struct snd_soc_dapm_widget *snd_soc_dai_get_widget(
 402         struct snd_soc_dai *dai, int stream)
 403 {
 404         return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
 405                 dai->playback_widget : dai->capture_widget;
 406 }
 407
 408 static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
 409                                              const struct snd_pcm_substream *ss)
 410 {
 411         return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
 412                 dai->playback_dma_data : dai->capture_dma_data;
 413 }
 414
 415 static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
 416                                             const struct snd_pcm_substream *ss,
 417                                             void *data)
 418 {
 419         if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
 420                 dai->playback_dma_data = data;
 421         else
 422                 dai->capture_dma_data = data;
 423 }
 424
 425 static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai,
 426                                              void *playback, void *capture)
 427 {
 428         dai->playback_dma_data = playback;
 429         dai->capture_dma_data = capture;
 430 }
 431
 432 static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
 433                 void *data)
 434 {
 435         dev_set_drvdata(dai->dev, data);
 436 }
 437
 438 static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
 439 {
 440         return dev_get_drvdata(dai->dev);
 441 }
 442
 443 /**
 444  * snd_soc_dai_set_sdw_stream() - Configures a DAI for SDW stream operation
 445  * @dai: DAI
 446  * @stream: STREAM
 447  * @direction: Stream direction(Playback/Capture)
 448  * SoundWire subsystem doesn't have a notion of direction and we reuse
 449  * the ASoC stream direction to configure sink/source ports.
 450  * Playback maps to source ports and Capture for sink ports.
 451  *
 452  * This should be invoked with NULL to clear the stream set previously.
 453  * Returns 0 on success, a negative error code otherwise.
 454  */
 455 static inline int snd_soc_dai_set_sdw_stream(struct snd_soc_dai *dai,
 456                                 void *stream, int direction)
 457 {
 458         if (dai->driver->ops->set_sdw_stream)
 459                 return dai->driver->ops->set_sdw_stream(dai, stream, direction);
 460         else
 461                 return -ENOTSUPP;
 462 }
 463
 464 /**
 465  * snd_soc_dai_get_sdw_stream() - Retrieves SDW stream from DAI
 466  * @dai: DAI
 467  * @direction: Stream direction(Playback/Capture)
 468  *
 469  * This routine only retrieves that was previously configured
 470  * with snd_soc_dai_get_sdw_stream()
 471  *
 472  * Returns pointer to stream or -ENOTSUPP if callback is not supported;
 473  */
 474 static inline void *snd_soc_dai_get_sdw_stream(struct snd_soc_dai *dai,
 475                                                int direction)
 476 {
 477         if (dai->driver->ops->get_sdw_stream)
 478                 return dai->driver->ops->get_sdw_stream(dai, direction);
 479         else
 480                 return ERR_PTR(-ENOTSUPP);
 481 }
 482
 483 static inline unsigned int
 484 snd_soc_dai_stream_active(struct snd_soc_dai *dai, int stream)
 485 {
 486         return dai->stream_active[stream];
 487 }
 488
 489 #endif