include/sound/pcm.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 #ifndef __SOUND_PCM_H
   3 #define __SOUND_PCM_H
   4
   5 /*
   6  *  Digital Audio (PCM) abstract layer
   7  *  Copyright (c) by Jaroslav Kysela <[email protected]>
   8  *                   Abramo Bagnara <[email protected]>
   9  */
  10
  11 #include <sound/asound.h>
  12 #include <sound/memalloc.h>
  13 #include <sound/minors.h>
  14 #include <linux/poll.h>
  15 #include <linux/mm.h>
  16 #include <linux/bitops.h>
  17 #include <linux/pm_qos.h>
  18 #include <linux/refcount.h>
  19 #include <linux/uio.h>
  20
  21 #define snd_pcm_substream_chip(substream) ((substream)->private_data)
  22 #define snd_pcm_chip(pcm) ((pcm)->private_data)
  23
  24 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
  25 #include <sound/pcm_oss.h>
  26 #endif
  27
  28 /*
  29  *  Hardware (lowlevel) section
  30  */
  31
  32 struct snd_pcm_hardware {
  33         unsigned int info;              /* SNDRV_PCM_INFO_* */
  34         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
  35         u32 subformats;                 /* for S32_LE, SNDRV_PCM_SUBFMTBIT_* */
  36         unsigned int rates;             /* SNDRV_PCM_RATE_* */
  37         unsigned int rate_min;          /* min rate */
  38         unsigned int rate_max;          /* max rate */
  39         unsigned int channels_min;      /* min channels */
  40         unsigned int channels_max;      /* max channels */
  41         size_t buffer_bytes_max;        /* max buffer size */
  42         size_t period_bytes_min;        /* min period size */
  43         size_t period_bytes_max;        /* max period size */
  44         unsigned int periods_min;       /* min # of periods */
  45         unsigned int periods_max;       /* max # of periods */
  46         size_t fifo_size;               /* fifo size in bytes */
  47 };
  48
  49 struct snd_pcm_status64;
  50 struct snd_pcm_substream;
  51
  52 struct snd_pcm_audio_tstamp_config; /* definitions further down */
  53 struct snd_pcm_audio_tstamp_report;
  54
  55 struct snd_pcm_ops {
  56         int (*open)(struct snd_pcm_substream *substream);
  57         int (*close)(struct snd_pcm_substream *substream);
  58         int (*ioctl)(struct snd_pcm_substream * substream,
  59                      unsigned int cmd, void *arg);
  60         int (*hw_params)(struct snd_pcm_substream *substream,
  61                          struct snd_pcm_hw_params *params);
  62         int (*hw_free)(struct snd_pcm_substream *substream);
  63         int (*prepare)(struct snd_pcm_substream *substream);
  64         int (*trigger)(struct snd_pcm_substream *substream, int cmd);
  65         int (*sync_stop)(struct snd_pcm_substream *substream);
  66         snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
  67         int (*get_time_info)(struct snd_pcm_substream *substream,
  68                         struct timespec64 *system_ts, struct timespec64 *audio_ts,
  69                         struct snd_pcm_audio_tstamp_config *audio_tstamp_config,
  70                         struct snd_pcm_audio_tstamp_report *audio_tstamp_report);
  71         int (*fill_silence)(struct snd_pcm_substream *substream, int channel,
  72                             unsigned long pos, unsigned long bytes);
  73         int (*copy)(struct snd_pcm_substream *substream, int channel,
  74                     unsigned long pos, struct iov_iter *iter, unsigned long bytes);
  75         struct page *(*page)(struct snd_pcm_substream *substream,
  76                              unsigned long offset);
  77         int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
  78         int (*ack)(struct snd_pcm_substream *substream);
  79 };
  80
  81 /*
  82  *
  83  */
  84
  85 #if defined(CONFIG_SND_DYNAMIC_MINORS)
  86 #define SNDRV_PCM_DEVICES       (SNDRV_OS_MINORS-2)
  87 #else
  88 #define SNDRV_PCM_DEVICES       8
  89 #endif
  90
  91 #define SNDRV_PCM_IOCTL1_RESET          0
  92 /* 1 is absent slot. */
  93 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO   2
  94 /* 3 is absent slot. */
  95 #define SNDRV_PCM_IOCTL1_FIFO_SIZE      4
  96
  97 #define SNDRV_PCM_TRIGGER_STOP          0
  98 #define SNDRV_PCM_TRIGGER_START         1
  99 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH    3
 100 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
 101 #define SNDRV_PCM_TRIGGER_SUSPEND       5
 102 #define SNDRV_PCM_TRIGGER_RESUME        6
 103 #define SNDRV_PCM_TRIGGER_DRAIN         7
 104
 105 #define SNDRV_PCM_POS_XRUN              ((snd_pcm_uframes_t)-1)
 106
 107 /* If you change this don't forget to change rates[] table in pcm_native.c */
 108 #define SNDRV_PCM_RATE_5512             (1U<<0)         /* 5512Hz */
 109 #define SNDRV_PCM_RATE_8000             (1U<<1)         /* 8000Hz */
 110 #define SNDRV_PCM_RATE_11025            (1U<<2)         /* 11025Hz */
 111 #define SNDRV_PCM_RATE_16000            (1U<<3)         /* 16000Hz */
 112 #define SNDRV_PCM_RATE_22050            (1U<<4)         /* 22050Hz */
 113 #define SNDRV_PCM_RATE_32000            (1U<<5)         /* 32000Hz */
 114 #define SNDRV_PCM_RATE_44100            (1U<<6)         /* 44100Hz */
 115 #define SNDRV_PCM_RATE_48000            (1U<<7)         /* 48000Hz */
 116 #define SNDRV_PCM_RATE_64000            (1U<<8)         /* 64000Hz */
 117 #define SNDRV_PCM_RATE_88200            (1U<<9)         /* 88200Hz */
 118 #define SNDRV_PCM_RATE_96000            (1U<<10)        /* 96000Hz */
 119 #define SNDRV_PCM_RATE_176400           (1U<<11)        /* 176400Hz */
 120 #define SNDRV_PCM_RATE_192000           (1U<<12)        /* 192000Hz */
 121 #define SNDRV_PCM_RATE_352800           (1U<<13)        /* 352800Hz */
 122 #define SNDRV_PCM_RATE_384000           (1U<<14)        /* 384000Hz */
 123 #define SNDRV_PCM_RATE_705600           (1U<<15)        /* 705600Hz */
 124 #define SNDRV_PCM_RATE_768000           (1U<<16)        /* 768000Hz */
 125
 126 #define SNDRV_PCM_RATE_CONTINUOUS       (1U<<30)        /* continuous range */
 127 #define SNDRV_PCM_RATE_KNOT             (1U<<31)        /* supports more non-continuous rates */
 128
 129 #define SNDRV_PCM_RATE_8000_44100       (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
 130                                          SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
 131                                          SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
 132 #define SNDRV_PCM_RATE_8000_48000       (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
 133 #define SNDRV_PCM_RATE_8000_96000       (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
 134                                          SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
 135 #define SNDRV_PCM_RATE_8000_192000      (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
 136                                          SNDRV_PCM_RATE_192000)
 137 #define SNDRV_PCM_RATE_8000_384000      (SNDRV_PCM_RATE_8000_192000|\
 138                                          SNDRV_PCM_RATE_352800|\
 139                                          SNDRV_PCM_RATE_384000)
 140 #define SNDRV_PCM_RATE_8000_768000      (SNDRV_PCM_RATE_8000_384000|\
 141                                          SNDRV_PCM_RATE_705600|\
 142                                          SNDRV_PCM_RATE_768000)
 143 #define _SNDRV_PCM_FMTBIT(fmt)          (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
 144 #define SNDRV_PCM_FMTBIT_S8             _SNDRV_PCM_FMTBIT(S8)
 145 #define SNDRV_PCM_FMTBIT_U8             _SNDRV_PCM_FMTBIT(U8)
 146 #define SNDRV_PCM_FMTBIT_S16_LE         _SNDRV_PCM_FMTBIT(S16_LE)
 147 #define SNDRV_PCM_FMTBIT_S16_BE         _SNDRV_PCM_FMTBIT(S16_BE)
 148 #define SNDRV_PCM_FMTBIT_U16_LE         _SNDRV_PCM_FMTBIT(U16_LE)
 149 #define SNDRV_PCM_FMTBIT_U16_BE         _SNDRV_PCM_FMTBIT(U16_BE)
 150 #define SNDRV_PCM_FMTBIT_S24_LE         _SNDRV_PCM_FMTBIT(S24_LE)
 151 #define SNDRV_PCM_FMTBIT_S24_BE         _SNDRV_PCM_FMTBIT(S24_BE)
 152 #define SNDRV_PCM_FMTBIT_U24_LE         _SNDRV_PCM_FMTBIT(U24_LE)
 153 #define SNDRV_PCM_FMTBIT_U24_BE         _SNDRV_PCM_FMTBIT(U24_BE)
 154 // For S32/U32 formats, 'msbits' hardware parameter is often used to deliver information about the
 155 // available bit count in most significant bit. It's for the case of so-called 'left-justified' or
 156 // `right-padding` sample which has less width than 32 bit.
 157 #define SNDRV_PCM_FMTBIT_S32_LE         _SNDRV_PCM_FMTBIT(S32_LE)
 158 #define SNDRV_PCM_FMTBIT_S32_BE         _SNDRV_PCM_FMTBIT(S32_BE)
 159 #define SNDRV_PCM_FMTBIT_U32_LE         _SNDRV_PCM_FMTBIT(U32_LE)
 160 #define SNDRV_PCM_FMTBIT_U32_BE         _SNDRV_PCM_FMTBIT(U32_BE)
 161 #define SNDRV_PCM_FMTBIT_FLOAT_LE       _SNDRV_PCM_FMTBIT(FLOAT_LE)
 162 #define SNDRV_PCM_FMTBIT_FLOAT_BE       _SNDRV_PCM_FMTBIT(FLOAT_BE)
 163 #define SNDRV_PCM_FMTBIT_FLOAT64_LE     _SNDRV_PCM_FMTBIT(FLOAT64_LE)
 164 #define SNDRV_PCM_FMTBIT_FLOAT64_BE     _SNDRV_PCM_FMTBIT(FLOAT64_BE)
 165 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
 166 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
 167 #define SNDRV_PCM_FMTBIT_MU_LAW         _SNDRV_PCM_FMTBIT(MU_LAW)
 168 #define SNDRV_PCM_FMTBIT_A_LAW          _SNDRV_PCM_FMTBIT(A_LAW)
 169 #define SNDRV_PCM_FMTBIT_IMA_ADPCM      _SNDRV_PCM_FMTBIT(IMA_ADPCM)
 170 #define SNDRV_PCM_FMTBIT_MPEG           _SNDRV_PCM_FMTBIT(MPEG)
 171 #define SNDRV_PCM_FMTBIT_GSM            _SNDRV_PCM_FMTBIT(GSM)
 172 #define SNDRV_PCM_FMTBIT_S20_LE _SNDRV_PCM_FMTBIT(S20_LE)
 173 #define SNDRV_PCM_FMTBIT_U20_LE _SNDRV_PCM_FMTBIT(U20_LE)
 174 #define SNDRV_PCM_FMTBIT_S20_BE _SNDRV_PCM_FMTBIT(S20_BE)
 175 #define SNDRV_PCM_FMTBIT_U20_BE _SNDRV_PCM_FMTBIT(U20_BE)
 176 #define SNDRV_PCM_FMTBIT_SPECIAL        _SNDRV_PCM_FMTBIT(SPECIAL)
 177 #define SNDRV_PCM_FMTBIT_S24_3LE        _SNDRV_PCM_FMTBIT(S24_3LE)
 178 #define SNDRV_PCM_FMTBIT_U24_3LE        _SNDRV_PCM_FMTBIT(U24_3LE)
 179 #define SNDRV_PCM_FMTBIT_S24_3BE        _SNDRV_PCM_FMTBIT(S24_3BE)
 180 #define SNDRV_PCM_FMTBIT_U24_3BE        _SNDRV_PCM_FMTBIT(U24_3BE)
 181 #define SNDRV_PCM_FMTBIT_S20_3LE        _SNDRV_PCM_FMTBIT(S20_3LE)
 182 #define SNDRV_PCM_FMTBIT_U20_3LE        _SNDRV_PCM_FMTBIT(U20_3LE)
 183 #define SNDRV_PCM_FMTBIT_S20_3BE        _SNDRV_PCM_FMTBIT(S20_3BE)
 184 #define SNDRV_PCM_FMTBIT_U20_3BE        _SNDRV_PCM_FMTBIT(U20_3BE)
 185 #define SNDRV_PCM_FMTBIT_S18_3LE        _SNDRV_PCM_FMTBIT(S18_3LE)
 186 #define SNDRV_PCM_FMTBIT_U18_3LE        _SNDRV_PCM_FMTBIT(U18_3LE)
 187 #define SNDRV_PCM_FMTBIT_S18_3BE        _SNDRV_PCM_FMTBIT(S18_3BE)
 188 #define SNDRV_PCM_FMTBIT_U18_3BE        _SNDRV_PCM_FMTBIT(U18_3BE)
 189 #define SNDRV_PCM_FMTBIT_G723_24        _SNDRV_PCM_FMTBIT(G723_24)
 190 #define SNDRV_PCM_FMTBIT_G723_24_1B     _SNDRV_PCM_FMTBIT(G723_24_1B)
 191 #define SNDRV_PCM_FMTBIT_G723_40        _SNDRV_PCM_FMTBIT(G723_40)
 192 #define SNDRV_PCM_FMTBIT_G723_40_1B     _SNDRV_PCM_FMTBIT(G723_40_1B)
 193 #define SNDRV_PCM_FMTBIT_DSD_U8         _SNDRV_PCM_FMTBIT(DSD_U8)
 194 #define SNDRV_PCM_FMTBIT_DSD_U16_LE     _SNDRV_PCM_FMTBIT(DSD_U16_LE)
 195 #define SNDRV_PCM_FMTBIT_DSD_U32_LE     _SNDRV_PCM_FMTBIT(DSD_U32_LE)
 196 #define SNDRV_PCM_FMTBIT_DSD_U16_BE     _SNDRV_PCM_FMTBIT(DSD_U16_BE)
 197 #define SNDRV_PCM_FMTBIT_DSD_U32_BE     _SNDRV_PCM_FMTBIT(DSD_U32_BE)
 198
 199 #ifdef SNDRV_LITTLE_ENDIAN
 200 #define SNDRV_PCM_FMTBIT_S16            SNDRV_PCM_FMTBIT_S16_LE
 201 #define SNDRV_PCM_FMTBIT_U16            SNDRV_PCM_FMTBIT_U16_LE
 202 #define SNDRV_PCM_FMTBIT_S24            SNDRV_PCM_FMTBIT_S24_LE
 203 #define SNDRV_PCM_FMTBIT_U24            SNDRV_PCM_FMTBIT_U24_LE
 204 #define SNDRV_PCM_FMTBIT_S32            SNDRV_PCM_FMTBIT_S32_LE
 205 #define SNDRV_PCM_FMTBIT_U32            SNDRV_PCM_FMTBIT_U32_LE
 206 #define SNDRV_PCM_FMTBIT_FLOAT          SNDRV_PCM_FMTBIT_FLOAT_LE
 207 #define SNDRV_PCM_FMTBIT_FLOAT64        SNDRV_PCM_FMTBIT_FLOAT64_LE
 208 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
 209 #define SNDRV_PCM_FMTBIT_S20            SNDRV_PCM_FMTBIT_S20_LE
 210 #define SNDRV_PCM_FMTBIT_U20            SNDRV_PCM_FMTBIT_U20_LE
 211 #endif
 212 #ifdef SNDRV_BIG_ENDIAN
 213 #define SNDRV_PCM_FMTBIT_S16            SNDRV_PCM_FMTBIT_S16_BE
 214 #define SNDRV_PCM_FMTBIT_U16            SNDRV_PCM_FMTBIT_U16_BE
 215 #define SNDRV_PCM_FMTBIT_S24            SNDRV_PCM_FMTBIT_S24_BE
 216 #define SNDRV_PCM_FMTBIT_U24            SNDRV_PCM_FMTBIT_U24_BE
 217 #define SNDRV_PCM_FMTBIT_S32            SNDRV_PCM_FMTBIT_S32_BE
 218 #define SNDRV_PCM_FMTBIT_U32            SNDRV_PCM_FMTBIT_U32_BE
 219 #define SNDRV_PCM_FMTBIT_FLOAT          SNDRV_PCM_FMTBIT_FLOAT_BE
 220 #define SNDRV_PCM_FMTBIT_FLOAT64        SNDRV_PCM_FMTBIT_FLOAT64_BE
 221 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
 222 #define SNDRV_PCM_FMTBIT_S20            SNDRV_PCM_FMTBIT_S20_BE
 223 #define SNDRV_PCM_FMTBIT_U20            SNDRV_PCM_FMTBIT_U20_BE
 224 #endif
 225
 226 #define _SNDRV_PCM_SUBFMTBIT(fmt)       BIT((__force int)SNDRV_PCM_SUBFORMAT_##fmt)
 227 #define SNDRV_PCM_SUBFMTBIT_STD         _SNDRV_PCM_SUBFMTBIT(STD)
 228 #define SNDRV_PCM_SUBFMTBIT_MSBITS_MAX  _SNDRV_PCM_SUBFMTBIT(MSBITS_MAX)
 229 #define SNDRV_PCM_SUBFMTBIT_MSBITS_20   _SNDRV_PCM_SUBFMTBIT(MSBITS_20)
 230 #define SNDRV_PCM_SUBFMTBIT_MSBITS_24   _SNDRV_PCM_SUBFMTBIT(MSBITS_24)
 231
 232 struct snd_pcm_file {
 233         struct snd_pcm_substream *substream;
 234         int no_compat_mmap;
 235         unsigned int user_pversion;     /* supported protocol version */
 236 };
 237
 238 struct snd_pcm_hw_rule;
 239 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
 240                                       struct snd_pcm_hw_rule *rule);
 241
 242 struct snd_pcm_hw_rule {
 243         unsigned int cond;
 244         int var;
 245         int deps[5];
 246
 247         snd_pcm_hw_rule_func_t func;
 248         void *private;
 249 };
 250
 251 struct snd_pcm_hw_constraints {
 252         struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
 253                          SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
 254         struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
 255                              SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
 256         unsigned int rules_num;
 257         unsigned int rules_all;
 258         struct snd_pcm_hw_rule *rules;
 259 };
 260
 261 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
 262                                             snd_pcm_hw_param_t var)
 263 {
 264         return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 265 }
 266
 267 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
 268                                                     snd_pcm_hw_param_t var)
 269 {
 270         return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 271 }
 272
 273 struct snd_ratnum {
 274         unsigned int num;
 275         unsigned int den_min, den_max, den_step;
 276 };
 277
 278 struct snd_ratden {
 279         unsigned int num_min, num_max, num_step;
 280         unsigned int den;
 281 };
 282
 283 struct snd_pcm_hw_constraint_ratnums {
 284         int nrats;
 285         const struct snd_ratnum *rats;
 286 };
 287
 288 struct snd_pcm_hw_constraint_ratdens {
 289         int nrats;
 290         const struct snd_ratden *rats;
 291 };
 292
 293 struct snd_pcm_hw_constraint_list {
 294         const unsigned int *list;
 295         unsigned int count;
 296         unsigned int mask;
 297 };
 298
 299 struct snd_pcm_hw_constraint_ranges {
 300         unsigned int count;
 301         const struct snd_interval *ranges;
 302         unsigned int mask;
 303 };
 304
 305 /*
 306  * userspace-provided audio timestamp config to kernel,
 307  * structure is for internal use only and filled with dedicated unpack routine
 308  */
 309 struct snd_pcm_audio_tstamp_config {
 310         /* 5 of max 16 bits used */
 311         u32 type_requested:4;
 312         u32 report_delay:1; /* add total delay to A/D or D/A */
 313 };
 314
 315 static inline void snd_pcm_unpack_audio_tstamp_config(__u32 data,
 316                                                 struct snd_pcm_audio_tstamp_config *config)
 317 {
 318         config->type_requested = data & 0xF;
 319         config->report_delay = (data >> 4) & 1;
 320 }
 321
 322 /*
 323  * kernel-provided audio timestamp report to user-space
 324  * structure is for internal use only and read by dedicated pack routine
 325  */
 326 struct snd_pcm_audio_tstamp_report {
 327         /* 6 of max 16 bits used for bit-fields */
 328
 329         /* for backwards compatibility */
 330         u32 valid:1;
 331
 332         /* actual type if hardware could not support requested timestamp */
 333         u32 actual_type:4;
 334
 335         /* accuracy represented in ns units */
 336         u32 accuracy_report:1; /* 0 if accuracy unknown, 1 if accuracy field is valid */
 337         u32 accuracy; /* up to 4.29s, will be packed in separate field  */
 338 };
 339
 340 static inline void snd_pcm_pack_audio_tstamp_report(__u32 *data, __u32 *accuracy,
 341                                                 const struct snd_pcm_audio_tstamp_report *report)
 342 {
 343         u32 tmp;
 344
 345         tmp = report->accuracy_report;
 346         tmp <<= 4;
 347         tmp |= report->actual_type;
 348         tmp <<= 1;
 349         tmp |= report->valid;
 350
 351         *data &= 0xffff; /* zero-clear MSBs */
 352         *data |= (tmp << 16);
 353         *accuracy = report->accuracy;
 354 }
 355
 356
 357 struct snd_pcm_runtime {
 358         /* -- Status -- */
 359         snd_pcm_state_t state;          /* stream state */
 360         snd_pcm_state_t suspended_state; /* suspended stream state */
 361         struct snd_pcm_substream *trigger_master;
 362         struct timespec64 trigger_tstamp;       /* trigger timestamp */
 363         bool trigger_tstamp_latched;     /* trigger timestamp latched in low-level driver/hardware */
 364         int overrange;
 365         snd_pcm_uframes_t avail_max;
 366         snd_pcm_uframes_t hw_ptr_base;  /* Position at buffer restart */
 367         snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
 368         unsigned long hw_ptr_jiffies;   /* Time when hw_ptr is updated */
 369         unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
 370         snd_pcm_sframes_t delay;        /* extra delay; typically FIFO size */
 371         u64 hw_ptr_wrap;                /* offset for hw_ptr due to boundary wrap-around */
 372
 373         /* -- HW params -- */
 374         snd_pcm_access_t access;        /* access mode */
 375         snd_pcm_format_t format;        /* SNDRV_PCM_FORMAT_* */
 376         snd_pcm_subformat_t subformat;  /* subformat */
 377         unsigned int rate;              /* rate in Hz */
 378         unsigned int channels;          /* channels */
 379         snd_pcm_uframes_t period_size;  /* period size */
 380         unsigned int periods;           /* periods */
 381         snd_pcm_uframes_t buffer_size;  /* buffer size */
 382         snd_pcm_uframes_t min_align;    /* Min alignment for the format */
 383         size_t byte_align;
 384         unsigned int frame_bits;
 385         unsigned int sample_bits;
 386         unsigned int info;
 387         unsigned int rate_num;
 388         unsigned int rate_den;
 389         unsigned int no_period_wakeup: 1;
 390
 391         /* -- SW params; see struct snd_pcm_sw_params for comments -- */
 392         int tstamp_mode;
 393         unsigned int period_step;
 394         snd_pcm_uframes_t start_threshold;
 395         snd_pcm_uframes_t stop_threshold;
 396         snd_pcm_uframes_t silence_threshold;
 397         snd_pcm_uframes_t silence_size;
 398         snd_pcm_uframes_t boundary;
 399
 400         /* internal data of auto-silencer */
 401         snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
 402         snd_pcm_uframes_t silence_filled; /* already filled part of silence area */
 403
 404         union snd_pcm_sync_id sync;     /* hardware synchronization ID */
 405
 406         /* -- mmap -- */
 407         struct snd_pcm_mmap_status *status;
 408         struct snd_pcm_mmap_control *control;
 409
 410         /* -- locking / scheduling -- */
 411         snd_pcm_uframes_t twake;        /* do transfer (!poll) wakeup if non-zero */
 412         wait_queue_head_t sleep;        /* poll sleep */
 413         wait_queue_head_t tsleep;       /* transfer sleep */
 414         struct snd_fasync *fasync;
 415         bool stop_operating;            /* sync_stop will be called */
 416         struct mutex buffer_mutex;      /* protect for buffer changes */
 417         atomic_t buffer_accessing;      /* >0: in r/w operation, <0: blocked */
 418
 419         /* -- private section -- */
 420         void *private_data;
 421         void (*private_free)(struct snd_pcm_runtime *runtime);
 422
 423         /* -- hardware description -- */
 424         struct snd_pcm_hardware hw;
 425         struct snd_pcm_hw_constraints hw_constraints;
 426
 427         /* -- timer -- */
 428         unsigned int timer_resolution;  /* timer resolution */
 429         int tstamp_type;                /* timestamp type */
 430
 431         /* -- DMA -- */
 432         unsigned char *dma_area;        /* DMA area */
 433         dma_addr_t dma_addr;            /* physical bus address (not accessible from main CPU) */
 434         size_t dma_bytes;               /* size of DMA area */
 435
 436         struct snd_dma_buffer *dma_buffer_p;    /* allocated buffer */
 437         unsigned int buffer_changed:1;  /* buffer allocation changed; set only in managed mode */
 438
 439         /* -- audio timestamp config -- */
 440         struct snd_pcm_audio_tstamp_config audio_tstamp_config;
 441         struct snd_pcm_audio_tstamp_report audio_tstamp_report;
 442         struct timespec64 driver_tstamp;
 443
 444 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 445         /* -- OSS things -- */
 446         struct snd_pcm_oss_runtime oss;
 447 #endif
 448 };
 449
 450 struct snd_pcm_group {          /* keep linked substreams */
 451         spinlock_t lock;
 452         struct mutex mutex;
 453         struct list_head substreams;
 454         refcount_t refs;
 455 };
 456
 457 struct pid;
 458
 459 struct snd_pcm_substream {
 460         struct snd_pcm *pcm;
 461         struct snd_pcm_str *pstr;
 462         void *private_data;             /* copied from pcm->private_data */
 463         int number;
 464         char name[32];                  /* substream name */
 465         int stream;                     /* stream (direction) */
 466         struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
 467         size_t buffer_bytes_max;        /* limit ring buffer size */
 468         struct snd_dma_buffer dma_buffer;
 469         size_t dma_max;
 470         /* -- hardware operations -- */
 471         const struct snd_pcm_ops *ops;
 472         /* -- runtime information -- */
 473         struct snd_pcm_runtime *runtime;
 474         /* -- timer section -- */
 475         struct snd_timer *timer;                /* timer */
 476         unsigned timer_running: 1;      /* time is running */
 477         long wait_time; /* time in ms for R/W to wait for avail */
 478         /* -- next substream -- */
 479         struct snd_pcm_substream *next;
 480         /* -- linked substreams -- */
 481         struct list_head link_list;     /* linked list member */
 482         struct snd_pcm_group self_group;        /* fake group for non linked substream (with substream lock inside) */
 483         struct snd_pcm_group *group;            /* pointer to current group */
 484         /* -- assigned files -- */
 485         int ref_count;
 486         atomic_t mmap_count;
 487         unsigned int f_flags;
 488         void (*pcm_release)(struct snd_pcm_substream *);
 489         struct pid *pid;
 490 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 491         /* -- OSS things -- */
 492         struct snd_pcm_oss_substream oss;
 493 #endif
 494 #ifdef CONFIG_SND_VERBOSE_PROCFS
 495         struct snd_info_entry *proc_root;
 496 #endif /* CONFIG_SND_VERBOSE_PROCFS */
 497         /* misc flags */
 498         unsigned int hw_opened: 1;
 499         unsigned int managed_buffer_alloc:1;
 500 };
 501
 502 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
 503
 504
 505 struct snd_pcm_str {
 506         int stream;                             /* stream (direction) */
 507         struct snd_pcm *pcm;
 508         /* -- substreams -- */
 509         unsigned int substream_count;
 510         unsigned int substream_opened;
 511         struct snd_pcm_substream *substream;
 512 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 513         /* -- OSS things -- */
 514         struct snd_pcm_oss_stream oss;
 515 #endif
 516 #ifdef CONFIG_SND_VERBOSE_PROCFS
 517         struct snd_info_entry *proc_root;
 518 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
 519         unsigned int xrun_debug;        /* 0 = disabled, 1 = verbose, 2 = stacktrace */
 520 #endif
 521 #endif
 522         struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
 523         struct device *dev;
 524 };
 525
 526 struct snd_pcm {
 527         struct snd_card *card;
 528         struct list_head list;
 529         int device; /* device number */
 530         unsigned int info_flags;
 531         unsigned short dev_class;
 532         unsigned short dev_subclass;
 533         char id[64];
 534         char name[80];
 535         struct snd_pcm_str streams[2];
 536         struct mutex open_mutex;
 537         wait_queue_head_t open_wait;
 538         void *private_data;
 539         void (*private_free) (struct snd_pcm *pcm);
 540         bool internal; /* pcm is for internal use only */
 541         bool nonatomic; /* whole PCM operations are in non-atomic context */
 542         bool no_device_suspend; /* don't invoke device PM suspend */
 543 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 544         struct snd_pcm_oss oss;
 545 #endif
 546 };
 547
 548 /*
 549  *  Registering
 550  */
 551
 552 extern const struct file_operations snd_pcm_f_ops[2];
 553
 554 int snd_pcm_new(struct snd_card *card, const char *id, int device,
 555                 int playback_count, int capture_count,
 556                 struct snd_pcm **rpcm);
 557 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
 558                 int playback_count, int capture_count,
 559                 struct snd_pcm **rpcm);
 560 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
 561
 562 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 563 struct snd_pcm_notify {
 564         int (*n_register) (struct snd_pcm * pcm);
 565         int (*n_disconnect) (struct snd_pcm * pcm);
 566         int (*n_unregister) (struct snd_pcm * pcm);
 567         struct list_head list;
 568 };
 569 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
 570 #endif
 571
 572 /*
 573  *  Native I/O
 574  */
 575
 576 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
 577 int snd_pcm_info_user(struct snd_pcm_substream *substream,
 578                       struct snd_pcm_info __user *info);
 579 int snd_pcm_status64(struct snd_pcm_substream *substream,
 580                      struct snd_pcm_status64 *status);
 581 int snd_pcm_start(struct snd_pcm_substream *substream);
 582 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
 583 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
 584 int snd_pcm_stop_xrun(struct snd_pcm_substream *substream);
 585 #ifdef CONFIG_PM
 586 int snd_pcm_suspend_all(struct snd_pcm *pcm);
 587 #else
 588 static inline int snd_pcm_suspend_all(struct snd_pcm *pcm)
 589 {
 590         return 0;
 591 }
 592 #endif
 593 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
 594 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
 595                            struct snd_pcm_substream **rsubstream);
 596 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
 597 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
 598                              struct snd_pcm_substream **rsubstream);
 599 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
 600 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
 601
 602
 603 #ifdef CONFIG_SND_DEBUG
 604 void snd_pcm_debug_name(struct snd_pcm_substream *substream,
 605                            char *name, size_t len);
 606 #else
 607 static inline void
 608 snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
 609 {
 610         *buf = 0;
 611 }
 612 #endif
 613
 614 /*
 615  *  PCM library
 616  */
 617
 618 /**
 619  * snd_pcm_stream_linked - Check whether the substream is linked with others
 620  * @substream: substream to check
 621  *
 622  * Return: true if the given substream is being linked with others
 623  */
 624 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
 625 {
 626         return substream->group != &substream->self_group;
 627 }
 628
 629 void snd_pcm_stream_lock(struct snd_pcm_substream *substream);
 630 void snd_pcm_stream_unlock(struct snd_pcm_substream *substream);
 631 void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream);
 632 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream);
 633 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream);
 634 unsigned long _snd_pcm_stream_lock_irqsave_nested(struct snd_pcm_substream *substream);
 635
 636 /**
 637  * snd_pcm_stream_lock_irqsave - Lock the PCM stream
 638  * @substream: PCM substream
 639  * @flags: irq flags
 640  *
 641  * This locks the PCM stream like snd_pcm_stream_lock() but with the local
 642  * IRQ (only when nonatomic is false).  In nonatomic case, this is identical
 643  * as snd_pcm_stream_lock().
 644  */
 645 #define snd_pcm_stream_lock_irqsave(substream, flags)            \
 646         do {                                                     \
 647                 typecheck(unsigned long, flags);                 \
 648                 flags = _snd_pcm_stream_lock_irqsave(substream); \
 649         } while (0)
 650 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
 651                                       unsigned long flags);
 652
 653 /**
 654  * snd_pcm_stream_lock_irqsave_nested - Single-nested PCM stream locking
 655  * @substream: PCM substream
 656  * @flags: irq flags
 657  *
 658  * This locks the PCM stream like snd_pcm_stream_lock_irqsave() but with
 659  * the single-depth lockdep subclass.
 660  */
 661 #define snd_pcm_stream_lock_irqsave_nested(substream, flags)            \
 662         do {                                                            \
 663                 typecheck(unsigned long, flags);                        \
 664                 flags = _snd_pcm_stream_lock_irqsave_nested(substream); \
 665         } while (0)
 666
 667 /* definitions for guard(); use like guard(pcm_stream_lock) */
 668 DEFINE_LOCK_GUARD_1(pcm_stream_lock, struct snd_pcm_substream,
 669                     snd_pcm_stream_lock(_T->lock),
 670                     snd_pcm_stream_unlock(_T->lock))
 671 DEFINE_LOCK_GUARD_1(pcm_stream_lock_irq, struct snd_pcm_substream,
 672                     snd_pcm_stream_lock_irq(_T->lock),
 673                     snd_pcm_stream_unlock_irq(_T->lock))
 674 DEFINE_LOCK_GUARD_1(pcm_stream_lock_irqsave, struct snd_pcm_substream,
 675                     snd_pcm_stream_lock_irqsave(_T->lock, _T->flags),
 676                     snd_pcm_stream_unlock_irqrestore(_T->lock, _T->flags),
 677                     unsigned long flags)
 678
 679 /**
 680  * snd_pcm_group_for_each_entry - iterate over the linked substreams
 681  * @s: the iterator
 682  * @substream: the substream
 683  *
 684  * Iterate over the all linked substreams to the given @substream.
 685  * When @substream isn't linked with any others, this gives returns @substream
 686  * itself once.
 687  */
 688 #define snd_pcm_group_for_each_entry(s, substream) \
 689         list_for_each_entry(s, &substream->group->substreams, link_list)
 690
 691 #define for_each_pcm_streams(stream)                    \
 692         for (stream  = SNDRV_PCM_STREAM_PLAYBACK;       \
 693              stream <= SNDRV_PCM_STREAM_LAST;           \
 694              stream++)
 695
 696 /**
 697  * snd_pcm_running - Check whether the substream is in a running state
 698  * @substream: substream to check
 699  *
 700  * Return: true if the given substream is in the state RUNNING, or in the
 701  * state DRAINING for playback.
 702  */
 703 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
 704 {
 705         return (substream->runtime->state == SNDRV_PCM_STATE_RUNNING ||
 706                 (substream->runtime->state == SNDRV_PCM_STATE_DRAINING &&
 707                  substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
 708 }
 709
 710 /**
 711  * __snd_pcm_set_state - Change the current PCM state
 712  * @runtime: PCM runtime to set
 713  * @state: the current state to set
 714  *
 715  * Call within the stream lock
 716  */
 717 static inline void __snd_pcm_set_state(struct snd_pcm_runtime *runtime,
 718                                        snd_pcm_state_t state)
 719 {
 720         runtime->state = state;
 721         runtime->status->state = state; /* copy for mmap */
 722 }
 723
 724 /**
 725  * bytes_to_samples - Unit conversion of the size from bytes to samples
 726  * @runtime: PCM runtime instance
 727  * @size: size in bytes
 728  *
 729  * Return: the size in samples
 730  */
 731 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
 732 {
 733         return size * 8 / runtime->sample_bits;
 734 }
 735
 736 /**
 737  * bytes_to_frames - Unit conversion of the size from bytes to frames
 738  * @runtime: PCM runtime instance
 739  * @size: size in bytes
 740  *
 741  * Return: the size in frames
 742  */
 743 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
 744 {
 745         return size * 8 / runtime->frame_bits;
 746 }
 747
 748 /**
 749  * samples_to_bytes - Unit conversion of the size from samples to bytes
 750  * @runtime: PCM runtime instance
 751  * @size: size in samples
 752  *
 753  * Return: the byte size
 754  */
 755 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
 756 {
 757         return size * runtime->sample_bits / 8;
 758 }
 759
 760 /**
 761  * frames_to_bytes - Unit conversion of the size from frames to bytes
 762  * @runtime: PCM runtime instance
 763  * @size: size in frames
 764  *
 765  * Return: the byte size
 766  */
 767 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
 768 {
 769         return size * runtime->frame_bits / 8;
 770 }
 771
 772 /**
 773  * frame_aligned - Check whether the byte size is aligned to frames
 774  * @runtime: PCM runtime instance
 775  * @bytes: size in bytes
 776  *
 777  * Return: true if aligned, or false if not
 778  */
 779 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
 780 {
 781         return bytes % runtime->byte_align == 0;
 782 }
 783
 784 /**
 785  * snd_pcm_lib_buffer_bytes - Get the buffer size of the current PCM in bytes
 786  * @substream: PCM substream
 787  *
 788  * Return: buffer byte size
 789  */
 790 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
 791 {
 792         struct snd_pcm_runtime *runtime = substream->runtime;
 793         return frames_to_bytes(runtime, runtime->buffer_size);
 794 }
 795
 796 /**
 797  * snd_pcm_lib_period_bytes - Get the period size of the current PCM in bytes
 798  * @substream: PCM substream
 799  *
 800  * Return: period byte size
 801  */
 802 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
 803 {
 804         struct snd_pcm_runtime *runtime = substream->runtime;
 805         return frames_to_bytes(runtime, runtime->period_size);
 806 }
 807
 808 /**
 809  * snd_pcm_playback_avail - Get the available (writable) space for playback
 810  * @runtime: PCM runtime instance
 811  *
 812  * Result is between 0 ... (boundary - 1)
 813  *
 814  * Return: available frame size
 815  */
 816 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
 817 {
 818         snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
 819         if (avail < 0)
 820                 avail += runtime->boundary;
 821         else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
 822                 avail -= runtime->boundary;
 823         return avail;
 824 }
 825
 826 /**
 827  * snd_pcm_capture_avail - Get the available (readable) space for capture
 828  * @runtime: PCM runtime instance
 829  *
 830  * Result is between 0 ... (boundary - 1)
 831  *
 832  * Return: available frame size
 833  */
 834 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
 835 {
 836         snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
 837         if (avail < 0)
 838                 avail += runtime->boundary;
 839         return avail;
 840 }
 841
 842 /**
 843  * snd_pcm_playback_hw_avail - Get the queued space for playback
 844  * @runtime: PCM runtime instance
 845  *
 846  * Return: available frame size
 847  */
 848 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
 849 {
 850         return runtime->buffer_size - snd_pcm_playback_avail(runtime);
 851 }
 852
 853 /**
 854  * snd_pcm_capture_hw_avail - Get the free space for capture
 855  * @runtime: PCM runtime instance
 856  *
 857  * Return: available frame size
 858  */
 859 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
 860 {
 861         return runtime->buffer_size - snd_pcm_capture_avail(runtime);
 862 }
 863
 864 /**
 865  * snd_pcm_playback_ready - check whether the playback buffer is available
 866  * @substream: the pcm substream instance
 867  *
 868  * Checks whether enough free space is available on the playback buffer.
 869  *
 870  * Return: Non-zero if available, or zero if not.
 871  */
 872 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
 873 {
 874         struct snd_pcm_runtime *runtime = substream->runtime;
 875         return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
 876 }
 877
 878 /**
 879  * snd_pcm_capture_ready - check whether the capture buffer is available
 880  * @substream: the pcm substream instance
 881  *
 882  * Checks whether enough capture data is available on the capture buffer.
 883  *
 884  * Return: Non-zero if available, or zero if not.
 885  */
 886 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
 887 {
 888         struct snd_pcm_runtime *runtime = substream->runtime;
 889         return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
 890 }
 891
 892 /**
 893  * snd_pcm_playback_data - check whether any data exists on the playback buffer
 894  * @substream: the pcm substream instance
 895  *
 896  * Checks whether any data exists on the playback buffer.
 897  *
 898  * Return: Non-zero if any data exists, or zero if not. If stop_threshold
 899  * is bigger or equal to boundary, then this function returns always non-zero.
 900  */
 901 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
 902 {
 903         struct snd_pcm_runtime *runtime = substream->runtime;
 904
 905         if (runtime->stop_threshold >= runtime->boundary)
 906                 return 1;
 907         return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
 908 }
 909
 910 /**
 911  * snd_pcm_playback_empty - check whether the playback buffer is empty
 912  * @substream: the pcm substream instance
 913  *
 914  * Checks whether the playback buffer is empty.
 915  *
 916  * Return: Non-zero if empty, or zero if not.
 917  */
 918 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
 919 {
 920         struct snd_pcm_runtime *runtime = substream->runtime;
 921         return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
 922 }
 923
 924 /**
 925  * snd_pcm_capture_empty - check whether the capture buffer is empty
 926  * @substream: the pcm substream instance
 927  *
 928  * Checks whether the capture buffer is empty.
 929  *
 930  * Return: Non-zero if empty, or zero if not.
 931  */
 932 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
 933 {
 934         struct snd_pcm_runtime *runtime = substream->runtime;
 935         return snd_pcm_capture_avail(runtime) == 0;
 936 }
 937
 938 /**
 939  * snd_pcm_trigger_done - Mark the master substream
 940  * @substream: the pcm substream instance
 941  * @master: the linked master substream
 942  *
 943  * When multiple substreams of the same card are linked and the hardware
 944  * supports the single-shot operation, the driver calls this in the loop
 945  * in snd_pcm_group_for_each_entry() for marking the substream as "done".
 946  * Then most of trigger operations are performed only to the given master
 947  * substream.
 948  *
 949  * The trigger_master mark is cleared at timestamp updates at the end
 950  * of trigger operations.
 951  */
 952 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
 953                                         struct snd_pcm_substream *master)
 954 {
 955         substream->runtime->trigger_master = master;
 956 }
 957
 958 static inline int hw_is_mask(int var)
 959 {
 960         return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
 961                 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
 962 }
 963
 964 static inline int hw_is_interval(int var)
 965 {
 966         return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
 967                 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
 968 }
 969
 970 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
 971                                      snd_pcm_hw_param_t var)
 972 {
 973         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 974 }
 975
 976 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
 977                                              snd_pcm_hw_param_t var)
 978 {
 979         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 980 }
 981
 982 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
 983                                              snd_pcm_hw_param_t var)
 984 {
 985         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 986 }
 987
 988 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
 989                                                      snd_pcm_hw_param_t var)
 990 {
 991         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 992 }
 993
 994 /**
 995  * params_channels - Get the number of channels from the hw params
 996  * @p: hw params
 997  *
 998  * Return: the number of channels
 999  */
1000 static inline unsigned int params_channels(const struct snd_pcm_hw_params *p)
1001 {
1002         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_CHANNELS)->min;
1003 }
1004
1005 /**
1006  * params_rate - Get the sample rate from the hw params
1007  * @p: hw params
1008  *
1009  * Return: the sample rate
1010  */
1011 static inline unsigned int params_rate(const struct snd_pcm_hw_params *p)
1012 {
1013         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_RATE)->min;
1014 }
1015
1016 /**
1017  * params_period_size - Get the period size (in frames) from the hw params
1018  * @p: hw params
1019  *
1020  * Return: the period size in frames
1021  */
1022 static inline unsigned int params_period_size(const struct snd_pcm_hw_params *p)
1023 {
1024         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min;
1025 }
1026
1027 /**
1028  * params_periods - Get the number of periods from the hw params
1029  * @p: hw params
1030  *
1031  * Return: the number of periods
1032  */
1033 static inline unsigned int params_periods(const struct snd_pcm_hw_params *p)
1034 {
1035         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIODS)->min;
1036 }
1037
1038 /**
1039  * params_buffer_size - Get the buffer size (in frames) from the hw params
1040  * @p: hw params
1041  *
1042  * Return: the buffer size in frames
1043  */
1044 static inline unsigned int params_buffer_size(const struct snd_pcm_hw_params *p)
1045 {
1046         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min;
1047 }
1048
1049 /**
1050  * params_buffer_bytes - Get the buffer size (in bytes) from the hw params
1051  * @p: hw params
1052  *
1053  * Return: the buffer size in bytes
1054  */
1055 static inline unsigned int params_buffer_bytes(const struct snd_pcm_hw_params *p)
1056 {
1057         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min;
1058 }
1059
1060 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
1061 int snd_interval_list(struct snd_interval *i, unsigned int count,
1062                       const unsigned int *list, unsigned int mask);
1063 int snd_interval_ranges(struct snd_interval *i, unsigned int count,
1064                         const struct snd_interval *list, unsigned int mask);
1065 int snd_interval_ratnum(struct snd_interval *i,
1066                         unsigned int rats_count, const struct snd_ratnum *rats,
1067                         unsigned int *nump, unsigned int *denp);
1068
1069 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
1070 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
1071
1072 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1073
1074 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1075                                  u_int64_t mask);
1076 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1077                                  unsigned int min, unsigned int max);
1078 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
1079 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
1080                                unsigned int cond,
1081                                snd_pcm_hw_param_t var,
1082                                const struct snd_pcm_hw_constraint_list *l);
1083 int snd_pcm_hw_constraint_ranges(struct snd_pcm_runtime *runtime,
1084                                  unsigned int cond,
1085                                  snd_pcm_hw_param_t var,
1086                                  const struct snd_pcm_hw_constraint_ranges *r);
1087 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
1088                                   unsigned int cond,
1089                                   snd_pcm_hw_param_t var,
1090                                   const struct snd_pcm_hw_constraint_ratnums *r);
1091 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
1092                                   unsigned int cond,
1093                                   snd_pcm_hw_param_t var,
1094                                   const struct snd_pcm_hw_constraint_ratdens *r);
1095 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1096                                  unsigned int cond,
1097                                  unsigned int width,
1098                                  unsigned int msbits);
1099 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1100                                unsigned int cond,
1101                                snd_pcm_hw_param_t var,
1102                                unsigned long step);
1103 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1104                                unsigned int cond,
1105                                snd_pcm_hw_param_t var);
1106 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
1107                                unsigned int base_rate);
1108 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
1109                         unsigned int cond,
1110                         int var,
1111                         snd_pcm_hw_rule_func_t func, void *private,
1112                         int dep, ...);
1113
1114 /**
1115  * snd_pcm_hw_constraint_single() - Constrain parameter to a single value
1116  * @runtime: PCM runtime instance
1117  * @var: The hw_params variable to constrain
1118  * @val: The value to constrain to
1119  *
1120  * Return: Positive if the value is changed, zero if it's not changed, or a
1121  * negative error code.
1122  */
1123 static inline int snd_pcm_hw_constraint_single(
1124         struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1125         unsigned int val)
1126 {
1127         return snd_pcm_hw_constraint_minmax(runtime, var, val, val);
1128 }
1129
1130 int snd_pcm_format_signed(snd_pcm_format_t format);
1131 int snd_pcm_format_unsigned(snd_pcm_format_t format);
1132 int snd_pcm_format_linear(snd_pcm_format_t format);
1133 int snd_pcm_format_little_endian(snd_pcm_format_t format);
1134 int snd_pcm_format_big_endian(snd_pcm_format_t format);
1135 #if 0 /* just for kernel-doc */
1136 /**
1137  * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
1138  * @format: the format to check
1139  *
1140  * Return: 1 if the given PCM format is CPU-endian, 0 if
1141  * opposite, or a negative error code if endian not specified.
1142  */
1143 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1144 #endif /* DocBook */
1145 #ifdef SNDRV_LITTLE_ENDIAN
1146 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
1147 #else
1148 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
1149 #endif
1150 int snd_pcm_format_width(snd_pcm_format_t format);                      /* in bits */
1151 int snd_pcm_format_physical_width(snd_pcm_format_t format);             /* in bits */
1152 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1153 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
1154 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
1155
1156 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
1157                      const struct snd_pcm_ops *ops);
1158 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
1159 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1160                       unsigned int cmd, void *arg);
1161 void snd_pcm_period_elapsed_under_stream_lock(struct snd_pcm_substream *substream);
1162 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
1163 snd_pcm_sframes_t __snd_pcm_lib_xfer(struct snd_pcm_substream *substream,
1164                                      void *buf, bool interleaved,
1165                                      snd_pcm_uframes_t frames, bool in_kernel);
1166
1167 static inline snd_pcm_sframes_t
1168 snd_pcm_lib_write(struct snd_pcm_substream *substream,
1169                   const void __user *buf, snd_pcm_uframes_t frames)
1170 {
1171         return __snd_pcm_lib_xfer(substream, (void __force *)buf, true, frames, false);
1172 }
1173
1174 static inline snd_pcm_sframes_t
1175 snd_pcm_lib_read(struct snd_pcm_substream *substream,
1176                  void __user *buf, snd_pcm_uframes_t frames)
1177 {
1178         return __snd_pcm_lib_xfer(substream, (void __force *)buf, true, frames, false);
1179 }
1180
1181 static inline snd_pcm_sframes_t
1182 snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1183                    void __user **bufs, snd_pcm_uframes_t frames)
1184 {
1185         return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames, false);
1186 }
1187
1188 static inline snd_pcm_sframes_t
1189 snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1190                   void __user **bufs, snd_pcm_uframes_t frames)
1191 {
1192         return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames, false);
1193 }
1194
1195 static inline snd_pcm_sframes_t
1196 snd_pcm_kernel_write(struct snd_pcm_substream *substream,
1197                      const void *buf, snd_pcm_uframes_t frames)
1198 {
1199         return __snd_pcm_lib_xfer(substream, (void *)buf, true, frames, true);
1200 }
1201
1202 static inline snd_pcm_sframes_t
1203 snd_pcm_kernel_read(struct snd_pcm_substream *substream,
1204                     void *buf, snd_pcm_uframes_t frames)
1205 {
1206         return __snd_pcm_lib_xfer(substream, buf, true, frames, true);
1207 }
1208
1209 static inline snd_pcm_sframes_t
1210 snd_pcm_kernel_writev(struct snd_pcm_substream *substream,
1211                       void **bufs, snd_pcm_uframes_t frames)
1212 {
1213         return __snd_pcm_lib_xfer(substream, bufs, false, frames, true);
1214 }
1215
1216 static inline snd_pcm_sframes_t
1217 snd_pcm_kernel_readv(struct snd_pcm_substream *substream,
1218                      void **bufs, snd_pcm_uframes_t frames)
1219 {
1220         return __snd_pcm_lib_xfer(substream, bufs, false, frames, true);
1221 }
1222
1223 int snd_pcm_hw_limit_rates(struct snd_pcm_hardware *hw);
1224
1225 static inline int
1226 snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime)
1227 {
1228         return snd_pcm_hw_limit_rates(&runtime->hw);
1229 }
1230
1231 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
1232 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
1233 unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
1234                                          unsigned int rates_b);
1235 unsigned int snd_pcm_rate_range_to_bits(unsigned int rate_min,
1236                                         unsigned int rate_max);
1237
1238 /**
1239  * snd_pcm_set_runtime_buffer - Set the PCM runtime buffer
1240  * @substream: PCM substream to set
1241  * @bufp: the buffer information, NULL to clear
1242  *
1243  * Copy the buffer information to runtime->dma_buffer when @bufp is non-NULL.
1244  * Otherwise it clears the current buffer information.
1245  */
1246 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1247                                               struct snd_dma_buffer *bufp)
1248 {
1249         struct snd_pcm_runtime *runtime = substream->runtime;
1250         if (bufp) {
1251                 runtime->dma_buffer_p = bufp;
1252                 runtime->dma_area = bufp->area;
1253                 runtime->dma_addr = bufp->addr;
1254                 runtime->dma_bytes = bufp->bytes;
1255         } else {
1256                 runtime->dma_buffer_p = NULL;
1257                 runtime->dma_area = NULL;
1258                 runtime->dma_addr = 0;
1259                 runtime->dma_bytes = 0;
1260         }
1261 }
1262
1263 /**
1264  * snd_pcm_gettime - Fill the timespec64 depending on the timestamp mode
1265  * @runtime: PCM runtime instance
1266  * @tv: timespec64 to fill
1267  */
1268 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
1269                                    struct timespec64 *tv)
1270 {
1271         switch (runtime->tstamp_type) {
1272         case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC:
1273                 ktime_get_ts64(tv);
1274                 break;
1275         case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW:
1276                 ktime_get_raw_ts64(tv);
1277                 break;
1278         default:
1279                 ktime_get_real_ts64(tv);
1280                 break;
1281         }
1282 }
1283
1284 /*
1285  *  Memory
1286  */
1287
1288 void snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
1289 void snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
1290 void snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1291                                   int type, struct device *data,
1292                                   size_t size, size_t max);
1293 void snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1294                                           int type, void *data,
1295                                           size_t size, size_t max);
1296 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
1297 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1298
1299 int snd_pcm_set_managed_buffer(struct snd_pcm_substream *substream, int type,
1300                                struct device *data, size_t size, size_t max);
1301 int snd_pcm_set_managed_buffer_all(struct snd_pcm *pcm, int type,
1302                                    struct device *data,
1303                                    size_t size, size_t max);
1304
1305 /**
1306  * snd_pcm_set_fixed_buffer - Preallocate and set up the fixed size PCM buffer
1307  * @substream: the pcm substream instance
1308  * @type: DMA type (SNDRV_DMA_TYPE_*)
1309  * @data: DMA type dependent data
1310  * @size: the requested pre-allocation size in bytes
1311  *
1312  * This is a variant of snd_pcm_set_managed_buffer(), but this pre-allocates
1313  * only the given sized buffer and doesn't allow re-allocation nor dynamic
1314  * allocation of a larger buffer unlike the standard one.
1315  * The function may return -ENOMEM error, hence the caller must check it.
1316  *
1317  * Return: zero if successful, or a negative error code
1318  */
1319 static inline int __must_check
1320 snd_pcm_set_fixed_buffer(struct snd_pcm_substream *substream, int type,
1321                                  struct device *data, size_t size)
1322 {
1323         return snd_pcm_set_managed_buffer(substream, type, data, size, 0);
1324 }
1325
1326 /**
1327  * snd_pcm_set_fixed_buffer_all - Preallocate and set up the fixed size PCM buffer
1328  * @pcm: the pcm instance
1329  * @type: DMA type (SNDRV_DMA_TYPE_*)
1330  * @data: DMA type dependent data
1331  * @size: the requested pre-allocation size in bytes
1332  *
1333  * Apply the set up of the fixed buffer via snd_pcm_set_fixed_buffer() for
1334  * all substream.  If any of allocation fails, it returns -ENOMEM, hence the
1335  * caller must check the return value.
1336  *
1337  * Return: zero if successful, or a negative error code
1338  */
1339 static inline int __must_check
1340 snd_pcm_set_fixed_buffer_all(struct snd_pcm *pcm, int type,
1341                              struct device *data, size_t size)
1342 {
1343         return snd_pcm_set_managed_buffer_all(pcm, type, data, size, 0);
1344 }
1345
1346 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
1347                                       size_t size, gfp_t gfp_flags);
1348 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
1349 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
1350                                           unsigned long offset);
1351 /**
1352  * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
1353  * @substream: the substream to allocate the buffer to
1354  * @size: the requested buffer size, in bytes
1355  *
1356  * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
1357  * contiguous in kernel virtual space, but not in physical memory.  Use this
1358  * if the buffer is accessed by kernel code but not by device DMA.
1359  *
1360  * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1361  * code.
1362  */
1363 static inline int snd_pcm_lib_alloc_vmalloc_buffer
1364                         (struct snd_pcm_substream *substream, size_t size)
1365 {
1366         return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1367                                                  GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO);
1368 }
1369
1370 /**
1371  * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
1372  * @substream: the substream to allocate the buffer to
1373  * @size: the requested buffer size, in bytes
1374  *
1375  * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
1376  * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
1377  *
1378  * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1379  * code.
1380  */
1381 static inline int snd_pcm_lib_alloc_vmalloc_32_buffer
1382                         (struct snd_pcm_substream *substream, size_t size)
1383 {
1384         return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1385                                                  GFP_KERNEL | GFP_DMA32 | __GFP_ZERO);
1386 }
1387
1388 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
1389
1390 /**
1391  * snd_pcm_sgbuf_get_addr - Get the DMA address at the corresponding offset
1392  * @substream: PCM substream
1393  * @ofs: byte offset
1394  *
1395  * Return: DMA address
1396  */
1397 static inline dma_addr_t
1398 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1399 {
1400         return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
1401 }
1402
1403 /**
1404  * snd_pcm_sgbuf_get_chunk_size - Compute the max size that fits within the
1405  * contig. page from the given size
1406  * @substream: PCM substream
1407  * @ofs: byte offset
1408  * @size: byte size to examine
1409  *
1410  * Return: chunk size
1411  */
1412 static inline unsigned int
1413 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1414                              unsigned int ofs, unsigned int size)
1415 {
1416         return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1417 }
1418
1419 /**
1420  * snd_pcm_mmap_data_open - increase the mmap counter
1421  * @area: VMA
1422  *
1423  * PCM mmap callback should handle this counter properly
1424  */
1425 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1426 {
1427         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1428         atomic_inc(&substream->mmap_count);
1429 }
1430
1431 /**
1432  * snd_pcm_mmap_data_close - decrease the mmap counter
1433  * @area: VMA
1434  *
1435  * PCM mmap callback should handle this counter properly
1436  */
1437 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1438 {
1439         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1440         atomic_dec(&substream->mmap_count);
1441 }
1442
1443 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1444                              struct vm_area_struct *area);
1445 /* mmap for io-memory area */
1446 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1447 #define SNDRV_PCM_INFO_MMAP_IOMEM       SNDRV_PCM_INFO_MMAP
1448 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1449 #else
1450 #define SNDRV_PCM_INFO_MMAP_IOMEM       0
1451 #define snd_pcm_lib_mmap_iomem  NULL
1452 #endif
1453
1454 /**
1455  * snd_pcm_limit_isa_dma_size - Get the max size fitting with ISA DMA transfer
1456  * @dma: DMA number
1457  * @max: pointer to store the max size
1458  */
1459 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1460 {
1461         *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1462 }
1463
1464 /*
1465  *  Misc
1466  */
1467
1468 #define SNDRV_PCM_DEFAULT_CON_SPDIF     (IEC958_AES0_CON_EMPHASIS_NONE|\
1469                                          (IEC958_AES1_CON_ORIGINAL<<8)|\
1470                                          (IEC958_AES1_CON_PCM_CODER<<8)|\
1471                                          (IEC958_AES3_CON_FS_48000<<24))
1472
1473 const char *snd_pcm_format_name(snd_pcm_format_t format);
1474
1475 /**
1476  * snd_pcm_direction_name - Get a string naming the direction of a stream
1477  * @direction: Stream's direction, one of SNDRV_PCM_STREAM_XXX
1478  *
1479  * Returns a string naming the direction of the stream.
1480  */
1481 static inline const char *snd_pcm_direction_name(int direction)
1482 {
1483         if (direction == SNDRV_PCM_STREAM_PLAYBACK)
1484                 return "Playback";
1485         else
1486                 return "Capture";
1487 }
1488
1489 /**
1490  * snd_pcm_stream_str - Get a string naming the direction of a stream
1491  * @substream: the pcm substream instance
1492  *
1493  * Return: A string naming the direction of the stream.
1494  */
1495 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1496 {
1497         return snd_pcm_direction_name(substream->stream);
1498 }
1499
1500 /*
1501  * PCM channel-mapping control API
1502  */
1503 /* array element of channel maps */
1504 struct snd_pcm_chmap_elem {
1505         unsigned char channels;
1506         unsigned char map[15];
1507 };
1508
1509 /* channel map information; retrieved via snd_kcontrol_chip() */
1510 struct snd_pcm_chmap {
1511         struct snd_pcm *pcm;    /* assigned PCM instance */
1512         int stream;             /* PLAYBACK or CAPTURE */
1513         struct snd_kcontrol *kctl;
1514         const struct snd_pcm_chmap_elem *chmap;
1515         unsigned int max_channels;
1516         unsigned int channel_mask;      /* optional: active channels bitmask */
1517         void *private_data;     /* optional: private data pointer */
1518 };
1519
1520 /**
1521  * snd_pcm_chmap_substream - get the PCM substream assigned to the given chmap info
1522  * @info: chmap information
1523  * @idx: the substream number index
1524  *
1525  * Return: the matched PCM substream, or NULL if not found
1526  */
1527 static inline struct snd_pcm_substream *
1528 snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1529 {
1530         struct snd_pcm_substream *s;
1531         for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1532                 if (s->number == idx)
1533                         return s;
1534         return NULL;
1535 }
1536
1537 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1538 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1539 /* Other world's standard channel maps (C/LFE prior to RL/RR) */
1540 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1541
1542 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1543 #define SND_PCM_CHMAP_MASK_24   ((1U << 2) | (1U << 4))
1544 #define SND_PCM_CHMAP_MASK_246  (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1545 #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1546
1547 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1548                            const struct snd_pcm_chmap_elem *chmap,
1549                            int max_channels,
1550                            unsigned long private_value,
1551                            struct snd_pcm_chmap **info_ret);
1552
1553 /**
1554  * pcm_format_to_bits - Strong-typed conversion of pcm_format to bitwise
1555  * @pcm_format: PCM format
1556  *
1557  * Return: 64bit mask corresponding to the given PCM format
1558  */
1559 static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1560 {
1561         return 1ULL << (__force int) pcm_format;
1562 }
1563
1564 /**
1565  * pcm_for_each_format - helper to iterate for each format type
1566  * @f: the iterator variable in snd_pcm_format_t type
1567  */
1568 #define pcm_for_each_format(f)                                          \
1569         for ((f) = SNDRV_PCM_FORMAT_FIRST;                              \
1570              (__force int)(f) <= (__force int)SNDRV_PCM_FORMAT_LAST;    \
1571              (f) = (__force snd_pcm_format_t)((__force int)(f) + 1))
1572
1573 /* printk helpers */
1574 #define pcm_err(pcm, fmt, args...) \
1575         dev_err((pcm)->card->dev, fmt, ##args)
1576 #define pcm_warn(pcm, fmt, args...) \
1577         dev_warn((pcm)->card->dev, fmt, ##args)
1578 #define pcm_dbg(pcm, fmt, args...) \
1579         dev_dbg((pcm)->card->dev, fmt, ##args)
1580
1581 /* helpers for copying between iov_iter and iomem */
1582 int copy_to_iter_fromio(struct iov_iter *itert, const void __iomem *src,
1583                         size_t count);
1584 int copy_from_iter_toio(void __iomem *dst, struct iov_iter *iter, size_t count);
1585
1586 struct snd_pcm_status64 {
1587         snd_pcm_state_t state;          /* stream state */
1588         u8 rsvd[4];
1589         s64 trigger_tstamp_sec;         /* time when stream was started/stopped/paused */
1590         s64 trigger_tstamp_nsec;
1591         s64 tstamp_sec;                 /* reference timestamp */
1592         s64 tstamp_nsec;
1593         snd_pcm_uframes_t appl_ptr;     /* appl ptr */
1594         snd_pcm_uframes_t hw_ptr;       /* hw ptr */
1595         snd_pcm_sframes_t delay;        /* current delay in frames */
1596         snd_pcm_uframes_t avail;        /* number of frames available */
1597         snd_pcm_uframes_t avail_max;    /* max frames available on hw since last status */
1598         snd_pcm_uframes_t overrange;    /* count of ADC (capture) overrange detections from last status */
1599         snd_pcm_state_t suspended_state; /* suspended stream state */
1600         __u32 audio_tstamp_data;         /* needed for 64-bit alignment, used for configs/report to/from userspace */
1601         s64 audio_tstamp_sec;           /* sample counter, wall clock, PHC or on-demand sync'ed */
1602         s64 audio_tstamp_nsec;
1603         s64 driver_tstamp_sec;          /* useful in case reference system tstamp is reported with delay */
1604         s64 driver_tstamp_nsec;
1605         __u32 audio_tstamp_accuracy;    /* in ns units, only valid if indicated in audio_tstamp_data */
1606         unsigned char reserved[52-4*sizeof(s64)]; /* must be filled with zero */
1607 };
1608
1609 #define SNDRV_PCM_IOCTL_STATUS64        _IOR('A', 0x20, struct snd_pcm_status64)
1610 #define SNDRV_PCM_IOCTL_STATUS_EXT64    _IOWR('A', 0x24, struct snd_pcm_status64)
1611
1612 struct snd_pcm_status32 {
1613         snd_pcm_state_t state;          /* stream state */
1614         s32 trigger_tstamp_sec; /* time when stream was started/stopped/paused */
1615         s32 trigger_tstamp_nsec;
1616         s32 tstamp_sec;         /* reference timestamp */
1617         s32 tstamp_nsec;
1618         u32 appl_ptr;           /* appl ptr */
1619         u32 hw_ptr;             /* hw ptr */
1620         s32 delay;              /* current delay in frames */
1621         u32 avail;              /* number of frames available */
1622         u32 avail_max;          /* max frames available on hw since last status */
1623         u32 overrange;          /* count of ADC (capture) overrange detections from last status */
1624         snd_pcm_state_t suspended_state;        /* suspended stream state */
1625         u32 audio_tstamp_data;  /* needed for 64-bit alignment, used for configs/report to/from userspace */
1626         s32 audio_tstamp_sec;   /* sample counter, wall clock, PHC or on-demand sync'ed */
1627         s32 audio_tstamp_nsec;
1628         s32 driver_tstamp_sec;  /* useful in case reference system tstamp is reported with delay */
1629         s32 driver_tstamp_nsec;
1630         u32 audio_tstamp_accuracy;      /* in ns units, only valid if indicated in audio_tstamp_data */
1631         unsigned char reserved[52-4*sizeof(s32)]; /* must be filled with zero */
1632 };
1633
1634 #define SNDRV_PCM_IOCTL_STATUS32        _IOR('A', 0x20, struct snd_pcm_status32)
1635 #define SNDRV_PCM_IOCTL_STATUS_EXT32    _IOWR('A', 0x24, struct snd_pcm_status32)
1636
1637 #endif /* __SOUND_PCM_H */