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