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 /* Describes the possible PCM format */
  40 /*
  41  * use SND_SOC_DAI_FORMAT_xx as eash shift.
  42  * see
  43  *      snd_soc_runtime_get_dai_fmt()
  44  */
  45 #define SND_SOC_POSSIBLE_DAIFMT_FORMAT_SHIFT    0
  46 #define SND_SOC_POSSIBLE_DAIFMT_FORMAT_MASK     (0xFFFF << SND_SOC_POSSIBLE_DAIFMT_FORMAT_SHIFT)
  47 #define SND_SOC_POSSIBLE_DAIFMT_I2S             (1 << SND_SOC_DAI_FORMAT_I2S)
  48 #define SND_SOC_POSSIBLE_DAIFMT_RIGHT_J         (1 << SND_SOC_DAI_FORMAT_RIGHT_J)
  49 #define SND_SOC_POSSIBLE_DAIFMT_LEFT_J          (1 << SND_SOC_DAI_FORMAT_LEFT_J)
  50 #define SND_SOC_POSSIBLE_DAIFMT_DSP_A           (1 << SND_SOC_DAI_FORMAT_DSP_A)
  51 #define SND_SOC_POSSIBLE_DAIFMT_DSP_B           (1 << SND_SOC_DAI_FORMAT_DSP_B)
  52 #define SND_SOC_POSSIBLE_DAIFMT_AC97            (1 << SND_SOC_DAI_FORMAT_AC97)
  53 #define SND_SOC_POSSIBLE_DAIFMT_PDM             (1 << SND_SOC_DAI_FORMAT_PDM)
  54
  55 /*
  56  * DAI Clock gating.
  57  *
  58  * DAI bit clocks can be gated (disabled) when the DAI is not
  59  * sending or receiving PCM data in a frame. This can be used to save power.
  60  */
  61 #define SND_SOC_DAIFMT_CONT             (1 << 4) /* continuous clock */
  62 #define SND_SOC_DAIFMT_GATED            (0 << 4) /* clock is gated */
  63
  64 /* Describes the possible PCM format */
  65 /*
  66  * define GATED -> CONT. GATED will be selected if both are selected.
  67  * see
  68  *      snd_soc_runtime_get_dai_fmt()
  69  */
  70 #define SND_SOC_POSSIBLE_DAIFMT_CLOCK_SHIFT     16
  71 #define SND_SOC_POSSIBLE_DAIFMT_CLOCK_MASK      (0xFFFF << SND_SOC_POSSIBLE_DAIFMT_CLOCK_SHIFT)
  72 #define SND_SOC_POSSIBLE_DAIFMT_GATED           (0x1ULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_SHIFT)
  73 #define SND_SOC_POSSIBLE_DAIFMT_CONT            (0x2ULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_SHIFT)
  74
  75 /*
  76  * DAI hardware signal polarity.
  77  *
  78  * Specifies whether the DAI can also support inverted clocks for the specified
  79  * format.
  80  *
  81  * BCLK:
  82  * - "normal" polarity means signal is available at rising edge of BCLK
  83  * - "inverted" polarity means signal is available at falling edge of BCLK
  84  *
  85  * FSYNC "normal" polarity depends on the frame format:
  86  * - I2S: frame consists of left then right channel data. Left channel starts
  87  *      with falling FSYNC edge, right channel starts with rising FSYNC edge.
  88  * - Left/Right Justified: frame consists of left then right channel data.
  89  *      Left channel starts with rising FSYNC edge, right channel starts with
  90  *      falling FSYNC edge.
  91  * - DSP A/B: Frame starts with rising FSYNC edge.
  92  * - AC97: Frame starts with rising FSYNC edge.
  93  *
  94  * "Negative" FSYNC polarity is the one opposite of "normal" polarity.
  95  */
  96 #define SND_SOC_DAIFMT_NB_NF            (0 << 8) /* normal bit clock + frame */
  97 #define SND_SOC_DAIFMT_NB_IF            (2 << 8) /* normal BCLK + inv FRM */
  98 #define SND_SOC_DAIFMT_IB_NF            (3 << 8) /* invert BCLK + nor FRM */
  99 #define SND_SOC_DAIFMT_IB_IF            (4 << 8) /* invert BCLK + FRM */
 100
 101 /* Describes the possible PCM format */
 102 #define SND_SOC_POSSIBLE_DAIFMT_INV_SHIFT       32
 103 #define SND_SOC_POSSIBLE_DAIFMT_INV_MASK        (0xFFFFULL << SND_SOC_POSSIBLE_DAIFMT_INV_SHIFT)
 104 #define SND_SOC_POSSIBLE_DAIFMT_NB_NF           (0x1ULL    << SND_SOC_POSSIBLE_DAIFMT_INV_SHIFT)
 105 #define SND_SOC_POSSIBLE_DAIFMT_NB_IF           (0x2ULL    << SND_SOC_POSSIBLE_DAIFMT_INV_SHIFT)
 106 #define SND_SOC_POSSIBLE_DAIFMT_IB_NF           (0x4ULL    << SND_SOC_POSSIBLE_DAIFMT_INV_SHIFT)
 107 #define SND_SOC_POSSIBLE_DAIFMT_IB_IF           (0x8ULL    << SND_SOC_POSSIBLE_DAIFMT_INV_SHIFT)
 108
 109 /*
 110  * DAI hardware clock providers/consumers
 111  *
 112  * This is wrt the codec, the inverse is true for the interface
 113  * i.e. if the codec is clk and FRM provider then the interface is
 114  * clk and frame consumer.
 115  */
 116 #define SND_SOC_DAIFMT_CBP_CFP          (1 << 12) /* codec clk provider & frame provider */
 117 #define SND_SOC_DAIFMT_CBC_CFP          (2 << 12) /* codec clk consumer & frame provider */
 118 #define SND_SOC_DAIFMT_CBP_CFC          (3 << 12) /* codec clk provider & frame consumer */
 119 #define SND_SOC_DAIFMT_CBC_CFC          (4 << 12) /* codec clk consumer & frame consumer */
 120
 121 /* previous definitions kept for backwards-compatibility, do not use in new contributions */
 122 #define SND_SOC_DAIFMT_CBM_CFM          SND_SOC_DAIFMT_CBP_CFP
 123 #define SND_SOC_DAIFMT_CBS_CFM          SND_SOC_DAIFMT_CBC_CFP
 124 #define SND_SOC_DAIFMT_CBM_CFS          SND_SOC_DAIFMT_CBP_CFC
 125 #define SND_SOC_DAIFMT_CBS_CFS          SND_SOC_DAIFMT_CBC_CFC
 126
 127 /* when passed to set_fmt directly indicate if the device is provider or consumer */
 128 #define SND_SOC_DAIFMT_BP_FP            SND_SOC_DAIFMT_CBP_CFP
 129 #define SND_SOC_DAIFMT_BC_FP            SND_SOC_DAIFMT_CBC_CFP
 130 #define SND_SOC_DAIFMT_BP_FC            SND_SOC_DAIFMT_CBP_CFC
 131 #define SND_SOC_DAIFMT_BC_FC            SND_SOC_DAIFMT_CBC_CFC
 132
 133 /* Describes the possible PCM format */
 134 #define SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT    48
 135 #define SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_MASK     (0xFFFFULL << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
 136 #define SND_SOC_POSSIBLE_DAIFMT_CBP_CFP                 (0x1ULL    << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
 137 #define SND_SOC_POSSIBLE_DAIFMT_CBC_CFP                 (0x2ULL    << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
 138 #define SND_SOC_POSSIBLE_DAIFMT_CBP_CFC                 (0x4ULL    << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
 139 #define SND_SOC_POSSIBLE_DAIFMT_CBC_CFC                 (0x8ULL    << SND_SOC_POSSIBLE_DAIFMT_CLOCK_PROVIDER_SHIFT)
 140
 141 #define SND_SOC_DAIFMT_FORMAT_MASK              0x000f
 142 #define SND_SOC_DAIFMT_CLOCK_MASK               0x00f0
 143 #define SND_SOC_DAIFMT_INV_MASK                 0x0f00
 144 #define SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK      0xf000
 145
 146 #define SND_SOC_DAIFMT_MASTER_MASK      SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK
 147
 148 /*
 149  * Master Clock Directions
 150  */
 151 #define SND_SOC_CLOCK_IN                0
 152 #define SND_SOC_CLOCK_OUT               1
 153
 154 #define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\
 155                                SNDRV_PCM_FMTBIT_S16_LE |\
 156                                SNDRV_PCM_FMTBIT_S16_BE |\
 157                                SNDRV_PCM_FMTBIT_S20_3LE |\
 158                                SNDRV_PCM_FMTBIT_S20_3BE |\
 159                                SNDRV_PCM_FMTBIT_S20_LE |\
 160                                SNDRV_PCM_FMTBIT_S20_BE |\
 161                                SNDRV_PCM_FMTBIT_S24_3LE |\
 162                                SNDRV_PCM_FMTBIT_S24_3BE |\
 163                                SNDRV_PCM_FMTBIT_S32_LE |\
 164                                SNDRV_PCM_FMTBIT_S32_BE)
 165
 166 struct snd_soc_dai_driver;
 167 struct snd_soc_dai;
 168 struct snd_ac97_bus_ops;
 169
 170 /* Digital Audio Interface clocking API.*/
 171 int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
 172         unsigned int freq, int dir);
 173
 174 int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
 175         int div_id, int div);
 176
 177 int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
 178         int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
 179
 180 int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio);
 181
 182 /* Digital Audio interface formatting */
 183 int snd_soc_dai_get_fmt_max_priority(const struct snd_soc_pcm_runtime *rtd);
 184 u64 snd_soc_dai_get_fmt(const struct snd_soc_dai *dai, int priority);
 185 int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
 186
 187 int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
 188         unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
 189
 190 int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
 191         unsigned int tx_num, const unsigned int *tx_slot,
 192         unsigned int rx_num, const unsigned int *rx_slot);
 193
 194 int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
 195
 196 /* Digital Audio Interface mute */
 197 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
 198                              int direction);
 199
 200
 201 int snd_soc_dai_get_channel_map(const struct snd_soc_dai *dai,
 202                 unsigned int *tx_num, unsigned int *tx_slot,
 203                 unsigned int *rx_num, unsigned int *rx_slot);
 204
 205 int snd_soc_dai_is_dummy(const struct snd_soc_dai *dai);
 206
 207 int snd_soc_dai_hw_params(struct snd_soc_dai *dai,
 208                           struct snd_pcm_substream *substream,
 209                           struct snd_pcm_hw_params *params);
 210 void snd_soc_dai_hw_free(struct snd_soc_dai *dai,
 211                          struct snd_pcm_substream *substream,
 212                          int rollback);
 213 int snd_soc_dai_startup(struct snd_soc_dai *dai,
 214                         struct snd_pcm_substream *substream);
 215 void snd_soc_dai_shutdown(struct snd_soc_dai *dai,
 216                           struct snd_pcm_substream *substream, int rollback);
 217 void snd_soc_dai_suspend(struct snd_soc_dai *dai);
 218 void snd_soc_dai_resume(struct snd_soc_dai *dai);
 219 int snd_soc_dai_compress_new(struct snd_soc_dai *dai, struct snd_soc_pcm_runtime *rtd);
 220 bool snd_soc_dai_stream_valid(const struct snd_soc_dai *dai, int stream);
 221 void snd_soc_dai_action(struct snd_soc_dai *dai,
 222                         int stream, int action);
 223 static inline void snd_soc_dai_activate(struct snd_soc_dai *dai,
 224                                         int stream)
 225 {
 226         snd_soc_dai_action(dai, stream,  1);
 227 }
 228 static inline void snd_soc_dai_deactivate(struct snd_soc_dai *dai,
 229                                           int stream)
 230 {
 231         snd_soc_dai_action(dai, stream, -1);
 232 }
 233 int snd_soc_dai_active(const struct snd_soc_dai *dai);
 234
 235 int snd_soc_pcm_dai_probe(struct snd_soc_pcm_runtime *rtd, int order);
 236 int snd_soc_pcm_dai_remove(struct snd_soc_pcm_runtime *rtd, int order);
 237 int snd_soc_pcm_dai_new(struct snd_soc_pcm_runtime *rtd);
 238 int snd_soc_pcm_dai_prepare(struct snd_pcm_substream *substream);
 239 int snd_soc_pcm_dai_trigger(struct snd_pcm_substream *substream, int cmd,
 240                             int rollback);
 241 void snd_soc_pcm_dai_delay(struct snd_pcm_substream *substream,
 242                            snd_pcm_sframes_t *cpu_delay, snd_pcm_sframes_t *codec_delay);
 243
 244 int snd_soc_dai_compr_startup(struct snd_soc_dai *dai,
 245                               struct snd_compr_stream *cstream);
 246 void snd_soc_dai_compr_shutdown(struct snd_soc_dai *dai,
 247                                 struct snd_compr_stream *cstream,
 248                                 int rollback);
 249 int snd_soc_dai_compr_trigger(struct snd_soc_dai *dai,
 250                               struct snd_compr_stream *cstream, int cmd);
 251 int snd_soc_dai_compr_set_params(struct snd_soc_dai *dai,
 252                                  struct snd_compr_stream *cstream,
 253                                  struct snd_compr_params *params);
 254 int snd_soc_dai_compr_get_params(struct snd_soc_dai *dai,
 255                                  struct snd_compr_stream *cstream,
 256                                  struct snd_codec *params);
 257 int snd_soc_dai_compr_ack(struct snd_soc_dai *dai,
 258                           struct snd_compr_stream *cstream,
 259                           size_t bytes);
 260 int snd_soc_dai_compr_pointer(struct snd_soc_dai *dai,
 261                               struct snd_compr_stream *cstream,
 262                               struct snd_compr_tstamp *tstamp);
 263 int snd_soc_dai_compr_set_metadata(struct snd_soc_dai *dai,
 264                                    struct snd_compr_stream *cstream,
 265                                    struct snd_compr_metadata *metadata);
 266 int snd_soc_dai_compr_get_metadata(struct snd_soc_dai *dai,
 267                                    struct snd_compr_stream *cstream,
 268                                    struct snd_compr_metadata *metadata);
 269
 270 const char *snd_soc_dai_name_get(const struct snd_soc_dai *dai);
 271
 272 struct snd_soc_dai_ops {
 273         /* DAI driver callbacks */
 274         int (*probe)(struct snd_soc_dai *dai);
 275         int (*remove)(struct snd_soc_dai *dai);
 276         /* compress dai */
 277         int (*compress_new)(struct snd_soc_pcm_runtime *rtd);
 278         /* Optional Callback used at pcm creation*/
 279         int (*pcm_new)(struct snd_soc_pcm_runtime *rtd,
 280                        struct snd_soc_dai *dai);
 281
 282         /*
 283          * DAI clocking configuration, all optional.
 284          * Called by soc_card drivers, normally in their hw_params.
 285          */
 286         int (*set_sysclk)(struct snd_soc_dai *dai,
 287                 int clk_id, unsigned int freq, int dir);
 288         int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
 289                 unsigned int freq_in, unsigned int freq_out);
 290         int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
 291         int (*set_bclk_ratio)(struct snd_soc_dai *dai, unsigned int ratio);
 292
 293         /*
 294          * DAI format configuration
 295          * Called by soc_card drivers, normally in their hw_params.
 296          */
 297         int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
 298         int (*xlate_tdm_slot_mask)(unsigned int slots,
 299                 unsigned int *tx_mask, unsigned int *rx_mask);
 300         int (*set_tdm_slot)(struct snd_soc_dai *dai,
 301                 unsigned int tx_mask, unsigned int rx_mask,
 302                 int slots, int slot_width);
 303         int (*set_channel_map)(struct snd_soc_dai *dai,
 304                 unsigned int tx_num, const unsigned int *tx_slot,
 305                 unsigned int rx_num, const unsigned int *rx_slot);
 306         int (*get_channel_map)(const struct snd_soc_dai *dai,
 307                         unsigned int *tx_num, unsigned int *tx_slot,
 308                         unsigned int *rx_num, unsigned int *rx_slot);
 309         int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
 310
 311         int (*set_stream)(struct snd_soc_dai *dai,
 312                           void *stream, int direction);
 313         void *(*get_stream)(struct snd_soc_dai *dai, int direction);
 314
 315         /*
 316          * DAI digital mute - optional.
 317          * Called by soc-core to minimise any pops.
 318          */
 319         int (*mute_stream)(struct snd_soc_dai *dai, int mute, int stream);
 320
 321         /*
 322          * ALSA PCM audio operations - all optional.
 323          * Called by soc-core during audio PCM operations.
 324          */
 325         int (*startup)(struct snd_pcm_substream *,
 326                 struct snd_soc_dai *);
 327         void (*shutdown)(struct snd_pcm_substream *,
 328                 struct snd_soc_dai *);
 329         int (*hw_params)(struct snd_pcm_substream *,
 330                 struct snd_pcm_hw_params *, struct snd_soc_dai *);
 331         int (*hw_free)(struct snd_pcm_substream *,
 332                 struct snd_soc_dai *);
 333         int (*prepare)(struct snd_pcm_substream *,
 334                 struct snd_soc_dai *);
 335         /*
 336          * NOTE: Commands passed to the trigger function are not necessarily
 337          * compatible with the current state of the dai. For example this
 338          * sequence of commands is possible: START STOP STOP.
 339          * So do not unconditionally use refcounting functions in the trigger
 340          * function, e.g. clk_enable/disable.
 341          */
 342         int (*trigger)(struct snd_pcm_substream *, int,
 343                 struct snd_soc_dai *);
 344
 345         /*
 346          * For hardware based FIFO caused delay reporting.
 347          * Optional.
 348          */
 349         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 350                 struct snd_soc_dai *);
 351
 352         /*
 353          * Format list for auto selection.
 354          * Format will be increased if priority format was
 355          * not selected.
 356          * see
 357          *      snd_soc_dai_get_fmt()
 358          */
 359         const u64 *auto_selectable_formats;
 360         int num_auto_selectable_formats;
 361
 362         /* probe ordering - for components with runtime dependencies */
 363         int probe_order;
 364         int remove_order;
 365
 366         /* bit field */
 367         unsigned int no_capture_mute:1;
 368         unsigned int mute_unmute_on_trigger:1;
 369 };
 370
 371 struct snd_soc_cdai_ops {
 372         /*
 373          * for compress ops
 374          */
 375         int (*startup)(struct snd_compr_stream *,
 376                         struct snd_soc_dai *);
 377         int (*shutdown)(struct snd_compr_stream *,
 378                         struct snd_soc_dai *);
 379         int (*set_params)(struct snd_compr_stream *,
 380                         struct snd_compr_params *, struct snd_soc_dai *);
 381         int (*get_params)(struct snd_compr_stream *,
 382                         struct snd_codec *, struct snd_soc_dai *);
 383         int (*set_metadata)(struct snd_compr_stream *,
 384                         struct snd_compr_metadata *, struct snd_soc_dai *);
 385         int (*get_metadata)(struct snd_compr_stream *,
 386                         struct snd_compr_metadata *, struct snd_soc_dai *);
 387         int (*trigger)(struct snd_compr_stream *, int,
 388                         struct snd_soc_dai *);
 389         int (*pointer)(struct snd_compr_stream *,
 390                         struct snd_compr_tstamp *, struct snd_soc_dai *);
 391         int (*ack)(struct snd_compr_stream *, size_t,
 392                         struct snd_soc_dai *);
 393 };
 394
 395 /*
 396  * Digital Audio Interface Driver.
 397  *
 398  * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
 399  * operations and capabilities. Codec and platform drivers will register this
 400  * structure for every DAI they have.
 401  *
 402  * This structure covers the clocking, formating and ALSA operations for each
 403  * interface.
 404  */
 405 struct snd_soc_dai_driver {
 406         /* DAI description */
 407         const char *name;
 408         unsigned int id;
 409         unsigned int base;
 410         struct snd_soc_dobj dobj;
 411         const struct of_phandle_args *dai_args;
 412
 413         /* ops */
 414         const struct snd_soc_dai_ops *ops;
 415         const struct snd_soc_cdai_ops *cops;
 416
 417         /* DAI capabilities */
 418         struct snd_soc_pcm_stream capture;
 419         struct snd_soc_pcm_stream playback;
 420         unsigned int symmetric_rate:1;
 421         unsigned int symmetric_channels:1;
 422         unsigned int symmetric_sample_bits:1;
 423 };
 424
 425 /* for Playback/Capture */
 426 struct snd_soc_dai_stream {
 427         struct snd_soc_dapm_widget *widget;
 428
 429         unsigned int active;    /* usage count */
 430         unsigned int tdm_mask;  /* CODEC TDM slot masks and params (for fixup) */
 431
 432         void *dma_data;         /* DAI DMA data */
 433 };
 434
 435 /*
 436  * Digital Audio Interface runtime data.
 437  *
 438  * Holds runtime data for a DAI.
 439  */
 440 struct snd_soc_dai {
 441         const char *name;
 442         int id;
 443         struct device *dev;
 444
 445         /* driver ops */
 446         struct snd_soc_dai_driver *driver;
 447
 448         /* DAI runtime info */
 449         struct snd_soc_dai_stream stream[SNDRV_PCM_STREAM_LAST + 1];
 450
 451         /* Symmetry data - only valid if symmetry is being enforced */
 452         unsigned int symmetric_rate;
 453         unsigned int symmetric_channels;
 454         unsigned int symmetric_sample_bits;
 455
 456         /* parent platform/codec */
 457         struct snd_soc_component *component;
 458
 459         struct list_head list;
 460
 461         /* function mark */
 462         struct snd_pcm_substream *mark_startup;
 463         struct snd_pcm_substream *mark_hw_params;
 464         struct snd_pcm_substream *mark_trigger;
 465         struct snd_compr_stream  *mark_compr_startup;
 466
 467         /* bit field */
 468         unsigned int probed:1;
 469 };
 470
 471 static inline const struct snd_soc_pcm_stream *
 472 snd_soc_dai_get_pcm_stream(const struct snd_soc_dai *dai, int stream)
 473 {
 474         return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
 475                 &dai->driver->playback : &dai->driver->capture;
 476 }
 477
 478 #define snd_soc_dai_get_widget_playback(dai)    snd_soc_dai_get_widget(dai, SNDRV_PCM_STREAM_PLAYBACK)
 479 #define snd_soc_dai_get_widget_capture(dai)     snd_soc_dai_get_widget(dai, SNDRV_PCM_STREAM_CAPTURE)
 480 static inline
 481 struct snd_soc_dapm_widget *snd_soc_dai_get_widget(struct snd_soc_dai *dai, int stream)
 482 {
 483         return dai->stream[stream].widget;
 484 }
 485
 486 #define snd_soc_dai_set_widget_playback(dai, widget)    snd_soc_dai_set_widget(dai, SNDRV_PCM_STREAM_PLAYBACK, widget)
 487 #define snd_soc_dai_set_widget_capture(dai,  widget)    snd_soc_dai_set_widget(dai, SNDRV_PCM_STREAM_CAPTURE,  widget)
 488 static inline
 489 void snd_soc_dai_set_widget(struct snd_soc_dai *dai, int stream, struct snd_soc_dapm_widget *widget)
 490 {
 491         dai->stream[stream].widget = widget;
 492 }
 493
 494 #define snd_soc_dai_dma_data_get_playback(dai)  snd_soc_dai_dma_data_get(dai, SNDRV_PCM_STREAM_PLAYBACK)
 495 #define snd_soc_dai_dma_data_get_capture(dai)   snd_soc_dai_dma_data_get(dai, SNDRV_PCM_STREAM_CAPTURE)
 496 #define snd_soc_dai_get_dma_data(dai, ss)       snd_soc_dai_dma_data_get(dai, ss->stream)
 497 static inline void *snd_soc_dai_dma_data_get(const struct snd_soc_dai *dai, int stream)
 498 {
 499         return dai->stream[stream].dma_data;
 500 }
 501
 502 #define snd_soc_dai_dma_data_set_playback(dai, data)    snd_soc_dai_dma_data_set(dai, SNDRV_PCM_STREAM_PLAYBACK, data)
 503 #define snd_soc_dai_dma_data_set_capture(dai,  data)    snd_soc_dai_dma_data_set(dai, SNDRV_PCM_STREAM_CAPTURE,  data)
 504 #define snd_soc_dai_set_dma_data(dai, ss, data)         snd_soc_dai_dma_data_set(dai, ss->stream, data)
 505 static inline void snd_soc_dai_dma_data_set(struct snd_soc_dai *dai, int stream, void *data)
 506 {
 507         dai->stream[stream].dma_data = data;
 508 }
 509
 510 static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai, void *playback, void *capture)
 511 {
 512         snd_soc_dai_dma_data_set_playback(dai, playback);
 513         snd_soc_dai_dma_data_set_capture(dai,  capture);
 514 }
 515
 516 static inline unsigned int snd_soc_dai_tdm_mask_get(const struct snd_soc_dai *dai,
 517                                                     int stream)
 518 {
 519         return dai->stream[stream].tdm_mask;
 520 }
 521
 522 static inline void snd_soc_dai_tdm_mask_set(struct snd_soc_dai *dai, int stream,
 523                                             unsigned int tdm_mask)
 524 {
 525         dai->stream[stream].tdm_mask = tdm_mask;
 526 }
 527
 528 static inline unsigned int snd_soc_dai_stream_active(const struct snd_soc_dai *dai,
 529                                                      int stream)
 530 {
 531         /* see snd_soc_dai_action() for setup */
 532         return dai->stream[stream].active;
 533 }
 534
 535 static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
 536                 void *data)
 537 {
 538         dev_set_drvdata(dai->dev, data);
 539 }
 540
 541 static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
 542 {
 543         return dev_get_drvdata(dai->dev);
 544 }
 545
 546 /**
 547  * snd_soc_dai_set_stream() - Configures a DAI for stream operation
 548  * @dai: DAI
 549  * @stream: STREAM (opaque structure depending on DAI type)
 550  * @direction: Stream direction(Playback/Capture)
 551  * Some subsystems, such as SoundWire, don't have a notion of direction and we reuse
 552  * the ASoC stream direction to configure sink/source ports.
 553  * Playback maps to source ports and Capture for sink ports.
 554  *
 555  * This should be invoked with NULL to clear the stream set previously.
 556  * Returns 0 on success, a negative error code otherwise.
 557  */
 558 static inline int snd_soc_dai_set_stream(struct snd_soc_dai *dai,
 559                                          void *stream, int direction)
 560 {
 561         if (dai->driver->ops->set_stream)
 562                 return dai->driver->ops->set_stream(dai, stream, direction);
 563         else
 564                 return -ENOTSUPP;
 565 }
 566
 567 /**
 568  * snd_soc_dai_get_stream() - Retrieves stream from DAI
 569  * @dai: DAI
 570  * @direction: Stream direction(Playback/Capture)
 571  *
 572  * This routine only retrieves that was previously configured
 573  * with snd_soc_dai_get_stream()
 574  *
 575  * Returns pointer to stream or an ERR_PTR value, e.g.
 576  * ERR_PTR(-ENOTSUPP) if callback is not supported;
 577  */
 578 static inline void *snd_soc_dai_get_stream(struct snd_soc_dai *dai,
 579                                            int direction)
 580 {
 581         if (dai->driver->ops->get_stream)
 582                 return dai->driver->ops->get_stream(dai, direction);
 583         else
 584                 return ERR_PTR(-ENOTSUPP);
 585 }
 586
 587 #endif