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 int snd_soc_dai_prepare(struct snd_soc_dai *dai,
 197                         struct snd_pcm_substream *substream);
 198
 199 /* Digital Audio Interface mute */
 200 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
 201                              int direction);
 202
 203
 204 int snd_soc_dai_get_channel_map(const struct snd_soc_dai *dai,
 205                 unsigned int *tx_num, unsigned int *tx_slot,
 206                 unsigned int *rx_num, unsigned int *rx_slot);
 207
 208 int snd_soc_dai_is_dummy(const struct snd_soc_dai *dai);
 209
 210 int snd_soc_dai_hw_params(struct snd_soc_dai *dai,
 211                           struct snd_pcm_substream *substream,
 212                           struct snd_pcm_hw_params *params);
 213 void snd_soc_dai_hw_free(struct snd_soc_dai *dai,
 214                          struct snd_pcm_substream *substream,
 215                          int rollback);
 216 int snd_soc_dai_startup(struct snd_soc_dai *dai,
 217                         struct snd_pcm_substream *substream);
 218 void snd_soc_dai_shutdown(struct snd_soc_dai *dai,
 219                           struct snd_pcm_substream *substream, int rollback);
 220 void snd_soc_dai_suspend(struct snd_soc_dai *dai);
 221 void snd_soc_dai_resume(struct snd_soc_dai *dai);
 222 int snd_soc_dai_compress_new(struct snd_soc_dai *dai, struct snd_soc_pcm_runtime *rtd);
 223 bool snd_soc_dai_stream_valid(const struct snd_soc_dai *dai, int stream);
 224 void snd_soc_dai_action(struct snd_soc_dai *dai,
 225                         int stream, int action);
 226 static inline void snd_soc_dai_activate(struct snd_soc_dai *dai,
 227                                         int stream)
 228 {
 229         snd_soc_dai_action(dai, stream,  1);
 230 }
 231 static inline void snd_soc_dai_deactivate(struct snd_soc_dai *dai,
 232                                           int stream)
 233 {
 234         snd_soc_dai_action(dai, stream, -1);
 235 }
 236 int snd_soc_dai_active(const struct snd_soc_dai *dai);
 237
 238 int snd_soc_pcm_dai_probe(struct snd_soc_pcm_runtime *rtd, int order);
 239 int snd_soc_pcm_dai_remove(struct snd_soc_pcm_runtime *rtd, int order);
 240 int snd_soc_pcm_dai_new(struct snd_soc_pcm_runtime *rtd);
 241 int snd_soc_pcm_dai_prepare(struct snd_pcm_substream *substream);
 242 int snd_soc_pcm_dai_trigger(struct snd_pcm_substream *substream, int cmd,
 243                             int rollback);
 244 void snd_soc_pcm_dai_delay(struct snd_pcm_substream *substream,
 245                            snd_pcm_sframes_t *cpu_delay, snd_pcm_sframes_t *codec_delay);
 246
 247 int snd_soc_dai_compr_startup(struct snd_soc_dai *dai,
 248                               struct snd_compr_stream *cstream);
 249 void snd_soc_dai_compr_shutdown(struct snd_soc_dai *dai,
 250                                 struct snd_compr_stream *cstream,
 251                                 int rollback);
 252 int snd_soc_dai_compr_trigger(struct snd_soc_dai *dai,
 253                               struct snd_compr_stream *cstream, int cmd);
 254 int snd_soc_dai_compr_set_params(struct snd_soc_dai *dai,
 255                                  struct snd_compr_stream *cstream,
 256                                  struct snd_compr_params *params);
 257 int snd_soc_dai_compr_get_params(struct snd_soc_dai *dai,
 258                                  struct snd_compr_stream *cstream,
 259                                  struct snd_codec *params);
 260 int snd_soc_dai_compr_ack(struct snd_soc_dai *dai,
 261                           struct snd_compr_stream *cstream,
 262                           size_t bytes);
 263 int snd_soc_dai_compr_pointer(struct snd_soc_dai *dai,
 264                               struct snd_compr_stream *cstream,
 265                               struct snd_compr_tstamp *tstamp);
 266 int snd_soc_dai_compr_set_metadata(struct snd_soc_dai *dai,
 267                                    struct snd_compr_stream *cstream,
 268                                    struct snd_compr_metadata *metadata);
 269 int snd_soc_dai_compr_get_metadata(struct snd_soc_dai *dai,
 270                                    struct snd_compr_stream *cstream,
 271                                    struct snd_compr_metadata *metadata);
 272
 273 const char *snd_soc_dai_name_get(const struct snd_soc_dai *dai);
 274
 275 struct snd_soc_dai_ops {
 276         /* DAI driver callbacks */
 277         int (*probe)(struct snd_soc_dai *dai);
 278         int (*remove)(struct snd_soc_dai *dai);
 279         /* compress dai */
 280         int (*compress_new)(struct snd_soc_pcm_runtime *rtd);
 281         /* Optional Callback used at pcm creation*/
 282         int (*pcm_new)(struct snd_soc_pcm_runtime *rtd,
 283                        struct snd_soc_dai *dai);
 284
 285         /*
 286          * DAI clocking configuration, all optional.
 287          * Called by soc_card drivers, normally in their hw_params.
 288          */
 289         int (*set_sysclk)(struct snd_soc_dai *dai,
 290                 int clk_id, unsigned int freq, int dir);
 291         int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
 292                 unsigned int freq_in, unsigned int freq_out);
 293         int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
 294         int (*set_bclk_ratio)(struct snd_soc_dai *dai, unsigned int ratio);
 295
 296         /*
 297          * DAI format configuration
 298          * Called by soc_card drivers, normally in their hw_params.
 299          */
 300         int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
 301         int (*xlate_tdm_slot_mask)(unsigned int slots,
 302                 unsigned int *tx_mask, unsigned int *rx_mask);
 303         int (*set_tdm_slot)(struct snd_soc_dai *dai,
 304                 unsigned int tx_mask, unsigned int rx_mask,
 305                 int slots, int slot_width);
 306         int (*set_channel_map)(struct snd_soc_dai *dai,
 307                 unsigned int tx_num, const unsigned int *tx_slot,
 308                 unsigned int rx_num, const unsigned int *rx_slot);
 309         int (*get_channel_map)(const struct snd_soc_dai *dai,
 310                         unsigned int *tx_num, unsigned int *tx_slot,
 311                         unsigned int *rx_num, unsigned int *rx_slot);
 312         int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
 313
 314         int (*set_stream)(struct snd_soc_dai *dai,
 315                           void *stream, int direction);
 316         void *(*get_stream)(struct snd_soc_dai *dai, int direction);
 317
 318         /*
 319          * DAI digital mute - optional.
 320          * Called by soc-core to minimise any pops.
 321          */
 322         int (*mute_stream)(struct snd_soc_dai *dai, int mute, int stream);
 323
 324         /*
 325          * ALSA PCM audio operations - all optional.
 326          * Called by soc-core during audio PCM operations.
 327          */
 328         int (*startup)(struct snd_pcm_substream *,
 329                 struct snd_soc_dai *);
 330         void (*shutdown)(struct snd_pcm_substream *,
 331                 struct snd_soc_dai *);
 332         int (*hw_params)(struct snd_pcm_substream *,
 333                 struct snd_pcm_hw_params *, struct snd_soc_dai *);
 334         int (*hw_free)(struct snd_pcm_substream *,
 335                 struct snd_soc_dai *);
 336         int (*prepare)(struct snd_pcm_substream *,
 337                 struct snd_soc_dai *);
 338         /*
 339          * NOTE: Commands passed to the trigger function are not necessarily
 340          * compatible with the current state of the dai. For example this
 341          * sequence of commands is possible: START STOP STOP.
 342          * So do not unconditionally use refcounting functions in the trigger
 343          * function, e.g. clk_enable/disable.
 344          */
 345         int (*trigger)(struct snd_pcm_substream *, int,
 346                 struct snd_soc_dai *);
 347
 348         /*
 349          * For hardware based FIFO caused delay reporting.
 350          * Optional.
 351          */
 352         snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
 353                 struct snd_soc_dai *);
 354
 355         /*
 356          * Format list for auto selection.
 357          * Format will be increased if priority format was
 358          * not selected.
 359          * see
 360          *      snd_soc_dai_get_fmt()
 361          */
 362         const u64 *auto_selectable_formats;
 363         int num_auto_selectable_formats;
 364
 365         /* probe ordering - for components with runtime dependencies */
 366         int probe_order;
 367         int remove_order;
 368
 369         /* bit field */
 370         unsigned int no_capture_mute:1;
 371         unsigned int mute_unmute_on_trigger:1;
 372 };
 373
 374 struct snd_soc_cdai_ops {
 375         /*
 376          * for compress ops
 377          */
 378         int (*startup)(struct snd_compr_stream *,
 379                         struct snd_soc_dai *);
 380         int (*shutdown)(struct snd_compr_stream *,
 381                         struct snd_soc_dai *);
 382         int (*set_params)(struct snd_compr_stream *,
 383                         struct snd_compr_params *, struct snd_soc_dai *);
 384         int (*get_params)(struct snd_compr_stream *,
 385                         struct snd_codec *, struct snd_soc_dai *);
 386         int (*set_metadata)(struct snd_compr_stream *,
 387                         struct snd_compr_metadata *, struct snd_soc_dai *);
 388         int (*get_metadata)(struct snd_compr_stream *,
 389                         struct snd_compr_metadata *, struct snd_soc_dai *);
 390         int (*trigger)(struct snd_compr_stream *, int,
 391                         struct snd_soc_dai *);
 392         int (*pointer)(struct snd_compr_stream *,
 393                         struct snd_compr_tstamp *, struct snd_soc_dai *);
 394         int (*ack)(struct snd_compr_stream *, size_t,
 395                         struct snd_soc_dai *);
 396 };
 397
 398 /*
 399  * Digital Audio Interface Driver.
 400  *
 401  * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
 402  * operations and capabilities. Codec and platform drivers will register this
 403  * structure for every DAI they have.
 404  *
 405  * This structure covers the clocking, formating and ALSA operations for each
 406  * interface.
 407  */
 408 struct snd_soc_dai_driver {
 409         /* DAI description */
 410         const char *name;
 411         unsigned int id;
 412         unsigned int base;
 413         struct snd_soc_dobj dobj;
 414         const struct of_phandle_args *dai_args;
 415
 416         /* ops */
 417         const struct snd_soc_dai_ops *ops;
 418         const struct snd_soc_cdai_ops *cops;
 419
 420         /* DAI capabilities */
 421         struct snd_soc_pcm_stream capture;
 422         struct snd_soc_pcm_stream playback;
 423         unsigned int symmetric_rate:1;
 424         unsigned int symmetric_channels:1;
 425         unsigned int symmetric_sample_bits:1;
 426 };
 427
 428 /* for Playback/Capture */
 429 struct snd_soc_dai_stream {
 430         struct snd_soc_dapm_widget *widget;
 431
 432         unsigned int active;    /* usage count */
 433         unsigned int tdm_mask;  /* CODEC TDM slot masks and params (for fixup) */
 434
 435         void *dma_data;         /* DAI DMA data */
 436 };
 437
 438 /*
 439  * Digital Audio Interface runtime data.
 440  *
 441  * Holds runtime data for a DAI.
 442  */
 443 struct snd_soc_dai {
 444         const char *name;
 445         int id;
 446         struct device *dev;
 447
 448         /* driver ops */
 449         struct snd_soc_dai_driver *driver;
 450
 451         /* DAI runtime info */
 452         struct snd_soc_dai_stream stream[SNDRV_PCM_STREAM_LAST + 1];
 453
 454         /* Symmetry data - only valid if symmetry is being enforced */
 455         unsigned int symmetric_rate;
 456         unsigned int symmetric_channels;
 457         unsigned int symmetric_sample_bits;
 458
 459         /* parent platform/codec */
 460         struct snd_soc_component *component;
 461
 462         struct list_head list;
 463
 464         /* function mark */
 465         struct snd_pcm_substream *mark_startup;
 466         struct snd_pcm_substream *mark_hw_params;
 467         struct snd_pcm_substream *mark_trigger;
 468         struct snd_compr_stream  *mark_compr_startup;
 469
 470         /* bit field */
 471         unsigned int probed:1;
 472 };
 473
 474 static inline const struct snd_soc_pcm_stream *
 475 snd_soc_dai_get_pcm_stream(const struct snd_soc_dai *dai, int stream)
 476 {
 477         return (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
 478                 &dai->driver->playback : &dai->driver->capture;
 479 }
 480
 481 #define snd_soc_dai_get_widget_playback(dai)    snd_soc_dai_get_widget(dai, SNDRV_PCM_STREAM_PLAYBACK)
 482 #define snd_soc_dai_get_widget_capture(dai)     snd_soc_dai_get_widget(dai, SNDRV_PCM_STREAM_CAPTURE)
 483 static inline
 484 struct snd_soc_dapm_widget *snd_soc_dai_get_widget(struct snd_soc_dai *dai, int stream)
 485 {
 486         return dai->stream[stream].widget;
 487 }
 488
 489 #define snd_soc_dai_set_widget_playback(dai, widget)    snd_soc_dai_set_widget(dai, SNDRV_PCM_STREAM_PLAYBACK, widget)
 490 #define snd_soc_dai_set_widget_capture(dai,  widget)    snd_soc_dai_set_widget(dai, SNDRV_PCM_STREAM_CAPTURE,  widget)
 491 static inline
 492 void snd_soc_dai_set_widget(struct snd_soc_dai *dai, int stream, struct snd_soc_dapm_widget *widget)
 493 {
 494         dai->stream[stream].widget = widget;
 495 }
 496
 497 #define snd_soc_dai_dma_data_get_playback(dai)  snd_soc_dai_dma_data_get(dai, SNDRV_PCM_STREAM_PLAYBACK)
 498 #define snd_soc_dai_dma_data_get_capture(dai)   snd_soc_dai_dma_data_get(dai, SNDRV_PCM_STREAM_CAPTURE)
 499 #define snd_soc_dai_get_dma_data(dai, ss)       snd_soc_dai_dma_data_get(dai, ss->stream)
 500 static inline void *snd_soc_dai_dma_data_get(const struct snd_soc_dai *dai, int stream)
 501 {
 502         return dai->stream[stream].dma_data;
 503 }
 504
 505 #define snd_soc_dai_dma_data_set_playback(dai, data)    snd_soc_dai_dma_data_set(dai, SNDRV_PCM_STREAM_PLAYBACK, data)
 506 #define snd_soc_dai_dma_data_set_capture(dai,  data)    snd_soc_dai_dma_data_set(dai, SNDRV_PCM_STREAM_CAPTURE,  data)
 507 #define snd_soc_dai_set_dma_data(dai, ss, data)         snd_soc_dai_dma_data_set(dai, ss->stream, data)
 508 static inline void snd_soc_dai_dma_data_set(struct snd_soc_dai *dai, int stream, void *data)
 509 {
 510         dai->stream[stream].dma_data = data;
 511 }
 512
 513 static inline void snd_soc_dai_init_dma_data(struct snd_soc_dai *dai, void *playback, void *capture)
 514 {
 515         snd_soc_dai_dma_data_set_playback(dai, playback);
 516         snd_soc_dai_dma_data_set_capture(dai,  capture);
 517 }
 518
 519 static inline unsigned int snd_soc_dai_tdm_mask_get(const struct snd_soc_dai *dai,
 520                                                     int stream)
 521 {
 522         return dai->stream[stream].tdm_mask;
 523 }
 524
 525 static inline void snd_soc_dai_tdm_mask_set(struct snd_soc_dai *dai, int stream,
 526                                             unsigned int tdm_mask)
 527 {
 528         dai->stream[stream].tdm_mask = tdm_mask;
 529 }
 530
 531 static inline unsigned int snd_soc_dai_stream_active(const struct snd_soc_dai *dai,
 532                                                      int stream)
 533 {
 534         /* see snd_soc_dai_action() for setup */
 535         return dai->stream[stream].active;
 536 }
 537
 538 static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai,
 539                 void *data)
 540 {
 541         dev_set_drvdata(dai->dev, data);
 542 }
 543
 544 static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai)
 545 {
 546         return dev_get_drvdata(dai->dev);
 547 }
 548
 549 /**
 550  * snd_soc_dai_set_stream() - Configures a DAI for stream operation
 551  * @dai: DAI
 552  * @stream: STREAM (opaque structure depending on DAI type)
 553  * @direction: Stream direction(Playback/Capture)
 554  * Some subsystems, such as SoundWire, don't have a notion of direction and we reuse
 555  * the ASoC stream direction to configure sink/source ports.
 556  * Playback maps to source ports and Capture for sink ports.
 557  *
 558  * This should be invoked with NULL to clear the stream set previously.
 559  * Returns 0 on success, a negative error code otherwise.
 560  */
 561 static inline int snd_soc_dai_set_stream(struct snd_soc_dai *dai,
 562                                          void *stream, int direction)
 563 {
 564         if (dai->driver->ops->set_stream)
 565                 return dai->driver->ops->set_stream(dai, stream, direction);
 566         else
 567                 return -ENOTSUPP;
 568 }
 569
 570 /**
 571  * snd_soc_dai_get_stream() - Retrieves stream from DAI
 572  * @dai: DAI
 573  * @direction: Stream direction(Playback/Capture)
 574  *
 575  * This routine only retrieves that was previously configured
 576  * with snd_soc_dai_get_stream()
 577  *
 578  * Returns pointer to stream or an ERR_PTR value, e.g.
 579  * ERR_PTR(-ENOTSUPP) if callback is not supported;
 580  */
 581 static inline void *snd_soc_dai_get_stream(struct snd_soc_dai *dai,
 582                                            int direction)
 583 {
 584         if (dai->driver->ops->get_stream)
 585                 return dai->driver->ops->get_stream(dai, direction);
 586         else
 587                 return ERR_PTR(-ENOTSUPP);
 588 }
 589
 590 #endif