LXR linux/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
  17struct snd_pcm_substream;
  18struct snd_soc_dapm_widget;
  19struct 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 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 secondary.
  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 secondary & FRM master */
  83#define SND_SOC_DAIFMT_CBM_CFS          (3 << 12) /* codec clk master & frame secondary */
  84#define SND_SOC_DAIFMT_CBS_CFS          (4 << 12) /* codec clk & FRM secondary */
  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
 109struct snd_soc_dai_driver;
 110struct snd_soc_dai;
 111struct snd_ac97_bus_ops;
 112
 113/* Digital Audio Interface clocking API.*/
 114int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
 115        unsigned int freq, int dir);
 116
 117int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
 118        int div_id, int div);
 119
 120int 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
 123int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio);
 124
 125/* Digital Audio interface formatting */
 126int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
 127
 128int 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
 131int 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
 135int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
 136
 137/* Digital Audio Interface mute */
 138int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
 139                             int direction);
 140
 141
 142int 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
 146int snd_soc_dai_is_dummy(struct snd_soc_dai *dai);
 147
 148int snd_soc_dai_hw_params(struct snd_soc_dai *dai,
 149                          struct snd_pcm_substream *substream,
 150                          struct snd_pcm_hw_params *params);
 151void snd_soc_dai_hw_free(struct snd_soc_dai *dai,
 152                         struct snd_pcm_substream *substream);
 153int snd_soc_dai_startup(struct snd_soc_dai *dai,
 154                        struct snd_pcm_substream *substream);
 155void snd_soc_dai_shutdown(struct snd_soc_dai *dai,
 156                          struct snd_pcm_substream *substream);
 157snd_pcm_sframes_t snd_soc_dai_delay(struct snd_soc_dai *dai,
 158                                    struct snd_pcm_substream *substream);
 159void snd_soc_dai_suspend(struct snd_soc_dai *dai);
 160void snd_soc_dai_resume(struct snd_soc_dai *dai);
 161int snd_soc_dai_compress_new(struct snd_soc_dai *dai,
 162                             struct snd_soc_pcm_runtime *rtd, int num);
 163bool snd_soc_dai_stream_valid(struct snd_soc_dai *dai, int stream);
 164void snd_soc_dai_link_set_capabilities(struct snd_soc_dai_link *dai_link);
 165void snd_soc_dai_action(struct snd_soc_dai *dai,
 166                        int stream, int action);
 167static inline void snd_soc_dai_activate(struct snd_soc_dai *dai,
 168                                        int stream)
 169{
 170        snd_soc_dai_action(dai, stream,  1);
 171}
 172static inline void snd_soc_dai_deactivate(struct snd_soc_dai *dai,
 173                                          int stream)
 174{
 175        snd_soc_dai_action(dai, stream, -1);
 176}
 177int snd_soc_dai_active(struct snd_soc_dai *dai);
 178
 179int snd_soc_pcm_dai_probe(struct snd_soc_pcm_runtime *rtd, int order);
 180int snd_soc_pcm_dai_remove(struct snd_soc_pcm_runtime *rtd, int order);
 181int snd_soc_pcm_dai_new(struct snd_soc_pcm_runtime *rtd);
 182int snd_soc_pcm_dai_prepare(struct snd_pcm_substream *substream);
 183int snd_soc_pcm_dai_trigger(struct snd_pcm_substream *substream, int cmd);
 184int snd_soc_pcm_dai_bespoke_trigger(struct snd_pcm_substream *substream,
 185                                    int cmd);
 186
 187int snd_soc_dai_compr_startup(struct snd_soc_dai *dai,
 188                              struct snd_compr_stream *cstream);
 189void snd_soc_dai_compr_shutdown(struct snd_soc_dai *dai,
 190                                struct snd_compr_stream *cstream);
 191int snd_soc_dai_compr_trigger(struct snd_soc_dai *dai,
 192                              struct snd_compr_stream *cstream, int cmd);
 193int snd_soc_dai_compr_set_params(struct snd_soc_dai *dai,
 194                                 struct snd_compr_stream *cstream,
 195                                 struct snd_compr_params *params);
 196int snd_soc_dai_compr_get_params(struct snd_soc_dai *dai,
 197                                 struct snd_compr_stream *cstream,
 198                                 struct snd_codec *params);
 199int snd_soc_dai_compr_ack(struct snd_soc_dai *dai,
 200                          struct snd_compr_stream *cstream,
 201                          size_t bytes);
 202int snd_soc_dai_compr_pointer(struct snd_soc_dai *dai,
 203                              struct snd_compr_stream *cstream,
 204                              struct snd_compr_tstamp *tstamp);
 205int snd_soc_dai_compr_set_metadata(struct snd_soc_dai *dai,
 206                                   struct snd_compr_stream *cstream,
 207                                   struct snd_compr_metadata *metadata);
 208int snd_soc_dai_compr_get_metadata(struct snd_soc_dai *dai,
 209                                   struct snd_compr_stream *cstream,
 210                                   struct snd_compr_metadata *metadata);
 211
 212struct 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 (*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        /* bit field */
 285        unsigned int no_capture_mute:1;
 286};
 287
 288struct snd_soc_cdai_ops {
 289        /*
 290         * for compress ops
 291         */
 292        int (*startup)(struct snd_compr_stream *,
 293                        struct snd_soc_dai *);
 294        int (*shutdown)(struct snd_compr_stream *,
 295                        struct snd_soc_dai *);
 296        int (*set_params)(struct snd_compr_stream *,
 297                        struct snd_compr_params *, struct snd_soc_dai *);
 298        int (*get_params)(struct snd_compr_stream *,
 299                        struct snd_codec *, struct snd_soc_dai *);
 300        int (*set_metadata)(struct snd_compr_stream *,
 301                        struct snd_compr_metadata *, struct snd_soc_dai *);
 302        int (*get_metadata)(struct snd_compr_stream *,
 303                        struct snd_compr_metadata *, struct snd_soc_dai *);
 304        int (*trigger)(struct snd_compr_stream *, int,
 305                        struct snd_soc_dai *);
 306        int (*pointer)(struct snd_compr_stream *,
 307                        struct snd_compr_tstamp *, struct snd_soc_dai *);
 308        int (*ack)(struct snd_compr_stream *, size_t,
 309                        struct snd_soc_dai *);
 310};
 311
 312/*
 313 * Digital Audio Interface Driver.
 314 *
 315 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
 316 * operations and capabilities. Codec and platform drivers will register this
 317 * structure for every DAI they have.
 318 *
 319 * This structure covers the clocking, formating and ALSA operations for each
 320 * interface.
 321 */
 322struct snd_soc_dai_driver {
 323        /* DAI description */
 324        const char *name;
 325        unsigned int id;
 326        unsigned int base;
 327        struct snd_soc_dobj dobj;
 328
 329        /* DAI driver callbacks */
 330        int (*probe)(struct snd_soc_dai *dai);
 331        int (*remove)(struct snd_soc_dai *dai);
 332        /* compress dai */
 333        int (*compress_new)(struct snd_soc_pcm_runtime *rtd, int num);
 334        /* Optional Callback used at pcm creation*/
 335        int (*pcm_new)(struct snd_soc_pcm_runtime *rtd,
 336                       struct snd_soc_dai *dai);
 337
 338        /* ops */
 339        const struct snd_soc_dai_ops *ops;
 340        const struct snd_soc_cdai_ops *cops;
 341
 342        /* DAI capabilities */
 343        struct snd_soc_pcm_stream capture;
 344        struct snd_soc_pcm_stream playback;
 345        unsigned int symmetric_rates:1;
 346        unsigned int symmetric_channels:1;
 347        unsigned int symmetric_samplebits:1;
 348
 349        /* probe ordering - for components with runtime dependencies */
 350        int probe_order;
 351        int remove_order;
 352};
 353
 354/*
 355 * Digital Audio Interface runtime data.
 356 *
 357 * Holds runtime data for a DAI.
 358 */
 359struct snd_soc_dai {
 360        const char *name;
 361        int id;
 362        struct device *dev;
 363
 364        /* driver ops */
 365        struct snd_soc_dai_driver *driver;
 366
 367        /* DAI runtime info */
 368        unsigned int stream_active[SNDRV_PCM_STREAM_LAST + 1]; /* usage count */
 369
 370        struct snd_soc_dapm_widget *playback_widget;
 371        struct snd_soc_dapm_widget *capture_widget;
 372
 373        /* DAI DMA data */
 374        void *playback_dma_data;
 375        void *capture_dma_data;
 376
 377        /* Symmetry data - only valid if symmetry is being enforced */
 378        unsigned int rate;
 379        unsigned int channels;
 380        unsigned int sample_bits;
 381
 382        /* parent platform/codec */
 383        struct snd_soc_component *component;
 384
 385        /* CODEC TDM slot masks and params (for fixup) */
 386        unsigned int tx_mask;
 387        unsigned int rx_mask;
 388
 389        struct list_head list;
 390
 391        /* bit field */
 392        unsigned int probed:1;
 393};
 394
 395static inline struct snd_soc_pcm_stream *
 396snd_soc_dai_get_pcm_stream(const struct snd_soc_dai *dai, int stream)
 397{
 398        return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
 399                &dai->driver->playback : &dai->driver->capture;
 400}
 401
 402static inline
 403struct snd_soc_dapm_widget *snd_soc_dai_get_widget(
 404        struct snd_soc_dai *dai, int stream)
 405{
 406        return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
 407                dai->playback_widget : dai->capture_widget;
 408}
 409
 410static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai,
 411                                             const struct snd_pcm_substream *ss)
 412{
 413        return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
 414                dai->playback_dma_data : dai->capture_dma_data;
 415}
 416
 417static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai,
 418                                            const struct snd_pcm_substream *ss,
 419                                            void *data)
 420{
 421        if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK)
 422                dai->playback_dma_data = data;
 423        else
 424                dai->capture_dma_data = data;
 425}
 426
 427static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai,
 428                                             void *playback, void *capture)
 429{
 430        dai->playback_dma_data = playback;
 431        dai->capture_dma_data = capture;
 432}
 433
 434static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
 435                void *data)
 436{
 437        dev_set_drvdata(dai->dev, data);
 438}
 439
 440static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
 441{
 442        return dev_get_drvdata(dai->dev);
 443}
 444
 445/**
 446 * snd_soc_dai_set_sdw_stream() - Configures a DAI for SDW stream operation
 447 * @dai: DAI
 448 * @stream: STREAM
 449 * @direction: Stream direction(Playback/Capture)
 450 * SoundWire subsystem doesn't have a notion of direction and we reuse
 451 * the ASoC stream direction to configure sink/source ports.
 452 * Playback maps to source ports and Capture for sink ports.
 453 *
 454 * This should be invoked with NULL to clear the stream set previously.
 455 * Returns 0 on success, a negative error code otherwise.
 456 */
 457static inline int snd_soc_dai_set_sdw_stream(struct snd_soc_dai *dai,
 458                                void *stream, int direction)
 459{
 460        if (dai->driver->ops->set_sdw_stream)
 461                return dai->driver->ops->set_sdw_stream(dai, stream, direction);
 462        else
 463                return -ENOTSUPP;
 464}
 465
 466/**
 467 * snd_soc_dai_get_sdw_stream() - Retrieves SDW stream from DAI
 468 * @dai: DAI
 469 * @direction: Stream direction(Playback/Capture)
 470 *
 471 * This routine only retrieves that was previously configured
 472 * with snd_soc_dai_get_sdw_stream()
 473 *
 474 * Returns pointer to stream or -ENOTSUPP if callback is not supported;
 475 */
 476static inline void *snd_soc_dai_get_sdw_stream(struct snd_soc_dai *dai,
 477                                               int direction)
 478{
 479        if (dai->driver->ops->get_sdw_stream)
 480                return dai->driver->ops->get_sdw_stream(dai, direction);
 481        else
 482                return ERR_PTR(-ENOTSUPP);
 483}
 484
 485static inline unsigned int
 486snd_soc_dai_stream_active(struct snd_soc_dai *dai, int stream)
 487{
 488        return dai->stream_active[stream];
 489}
 490
 491#endif
 492