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 fasync_struct *fasync;
 403         bool stop_operating;            /* sync_stop will be called */
 404
 405         /* -- private section -- */
 406         void *private_data;
 407         void (*private_free)(struct snd_pcm_runtime *runtime);
 408
 409         /* -- hardware description -- */
 410         struct snd_pcm_hardware hw;
 411         struct snd_pcm_hw_constraints hw_constraints;
 412
 413         /* -- timer -- */
 414         unsigned int timer_resolution;  /* timer resolution */
 415         int tstamp_type;                /* timestamp type */
 416
 417         /* -- DMA -- */
 418         unsigned char *dma_area;        /* DMA area */
 419         dma_addr_t dma_addr;            /* physical bus address (not accessible from main CPU) */
 420         size_t dma_bytes;               /* size of DMA area */
 421
 422         struct snd_dma_buffer *dma_buffer_p;    /* allocated buffer */
 423         unsigned int buffer_changed:1;  /* buffer allocation changed; set only in managed mode */
 424
 425         /* -- audio timestamp config -- */
 426         struct snd_pcm_audio_tstamp_config audio_tstamp_config;
 427         struct snd_pcm_audio_tstamp_report audio_tstamp_report;
 428         struct timespec64 driver_tstamp;
 429
 430 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 431         /* -- OSS things -- */
 432         struct snd_pcm_oss_runtime oss;
 433 #endif
 434 };
 435
 436 struct snd_pcm_group {          /* keep linked substreams */
 437         spinlock_t lock;
 438         struct mutex mutex;
 439         struct list_head substreams;
 440         refcount_t refs;
 441 };
 442
 443 struct pid;
 444
 445 struct snd_pcm_substream {
 446         struct snd_pcm *pcm;
 447         struct snd_pcm_str *pstr;
 448         void *private_data;             /* copied from pcm->private_data */
 449         int number;
 450         char name[32];                  /* substream name */
 451         int stream;                     /* stream (direction) */
 452         struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
 453         size_t buffer_bytes_max;        /* limit ring buffer size */
 454         struct snd_dma_buffer dma_buffer;
 455         size_t dma_max;
 456         /* -- hardware operations -- */
 457         const struct snd_pcm_ops *ops;
 458         /* -- runtime information -- */
 459         struct snd_pcm_runtime *runtime;
 460         /* -- timer section -- */
 461         struct snd_timer *timer;                /* timer */
 462         unsigned timer_running: 1;      /* time is running */
 463         long wait_time; /* time in ms for R/W to wait for avail */
 464         /* -- next substream -- */
 465         struct snd_pcm_substream *next;
 466         /* -- linked substreams -- */
 467         struct list_head link_list;     /* linked list member */
 468         struct snd_pcm_group self_group;        /* fake group for non linked substream (with substream lock inside) */
 469         struct snd_pcm_group *group;            /* pointer to current group */
 470         /* -- assigned files -- */
 471         int ref_count;
 472         atomic_t mmap_count;
 473         unsigned int f_flags;
 474         void (*pcm_release)(struct snd_pcm_substream *);
 475         struct pid *pid;
 476 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 477         /* -- OSS things -- */
 478         struct snd_pcm_oss_substream oss;
 479 #endif
 480 #ifdef CONFIG_SND_VERBOSE_PROCFS
 481         struct snd_info_entry *proc_root;
 482 #endif /* CONFIG_SND_VERBOSE_PROCFS */
 483         /* misc flags */
 484         unsigned int hw_opened: 1;
 485         unsigned int managed_buffer_alloc:1;
 486 };
 487
 488 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
 489
 490
 491 struct snd_pcm_str {
 492         int stream;                             /* stream (direction) */
 493         struct snd_pcm *pcm;
 494         /* -- substreams -- */
 495         unsigned int substream_count;
 496         unsigned int substream_opened;
 497         struct snd_pcm_substream *substream;
 498 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 499         /* -- OSS things -- */
 500         struct snd_pcm_oss_stream oss;
 501 #endif
 502 #ifdef CONFIG_SND_VERBOSE_PROCFS
 503         struct snd_info_entry *proc_root;
 504 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
 505         unsigned int xrun_debug;        /* 0 = disabled, 1 = verbose, 2 = stacktrace */
 506 #endif
 507 #endif
 508         struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
 509         struct device dev;
 510 };
 511
 512 struct snd_pcm {
 513         struct snd_card *card;
 514         struct list_head list;
 515         int device; /* device number */
 516         unsigned int info_flags;
 517         unsigned short dev_class;
 518         unsigned short dev_subclass;
 519         char id[64];
 520         char name[80];
 521         struct snd_pcm_str streams[2];
 522         struct mutex open_mutex;
 523         wait_queue_head_t open_wait;
 524         void *private_data;
 525         void (*private_free) (struct snd_pcm *pcm);
 526         bool internal; /* pcm is for internal use only */
 527         bool nonatomic; /* whole PCM operations are in non-atomic context */
 528         bool no_device_suspend; /* don't invoke device PM suspend */
 529 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 530         struct snd_pcm_oss oss;
 531 #endif
 532 };
 533
 534 /*
 535  *  Registering
 536  */
 537
 538 extern const struct file_operations snd_pcm_f_ops[2];
 539
 540 int snd_pcm_new(struct snd_card *card, const char *id, int device,
 541                 int playback_count, int capture_count,
 542                 struct snd_pcm **rpcm);
 543 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
 544                 int playback_count, int capture_count,
 545                 struct snd_pcm **rpcm);
 546 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
 547
 548 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 549 struct snd_pcm_notify {
 550         int (*n_register) (struct snd_pcm * pcm);
 551         int (*n_disconnect) (struct snd_pcm * pcm);
 552         int (*n_unregister) (struct snd_pcm * pcm);
 553         struct list_head list;
 554 };
 555 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
 556 #endif
 557
 558 /*
 559  *  Native I/O
 560  */
 561
 562 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
 563 int snd_pcm_info_user(struct snd_pcm_substream *substream,
 564                       struct snd_pcm_info __user *info);
 565 int snd_pcm_status64(struct snd_pcm_substream *substream,
 566                      struct snd_pcm_status64 *status);
 567 int snd_pcm_start(struct snd_pcm_substream *substream);
 568 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
 569 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
 570 int snd_pcm_stop_xrun(struct snd_pcm_substream *substream);
 571 #ifdef CONFIG_PM
 572 int snd_pcm_suspend_all(struct snd_pcm *pcm);
 573 #else
 574 static inline int snd_pcm_suspend_all(struct snd_pcm *pcm)
 575 {
 576         return 0;
 577 }
 578 #endif
 579 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
 580 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
 581                            struct snd_pcm_substream **rsubstream);
 582 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
 583 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
 584                              struct snd_pcm_substream **rsubstream);
 585 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
 586 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
 587
 588
 589 #ifdef CONFIG_SND_DEBUG
 590 void snd_pcm_debug_name(struct snd_pcm_substream *substream,
 591                            char *name, size_t len);
 592 #else
 593 static inline void
 594 snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
 595 {
 596         *buf = 0;
 597 }
 598 #endif
 599
 600 /*
 601  *  PCM library
 602  */
 603
 604 /**
 605  * snd_pcm_stream_linked - Check whether the substream is linked with others
 606  * @substream: substream to check
 607  *
 608  * Returns true if the given substream is being linked with others.
 609  */
 610 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
 611 {
 612         return substream->group != &substream->self_group;
 613 }
 614
 615 void snd_pcm_stream_lock(struct snd_pcm_substream *substream);
 616 void snd_pcm_stream_unlock(struct snd_pcm_substream *substream);
 617 void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream);
 618 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream);
 619 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream);
 620 unsigned long _snd_pcm_stream_lock_irqsave_nested(struct snd_pcm_substream *substream);
 621
 622 /**
 623  * snd_pcm_stream_lock_irqsave - Lock the PCM stream
 624  * @substream: PCM substream
 625  * @flags: irq flags
 626  *
 627  * This locks the PCM stream like snd_pcm_stream_lock() but with the local
 628  * IRQ (only when nonatomic is false).  In nonatomic case, this is identical
 629  * as snd_pcm_stream_lock().
 630  */
 631 #define snd_pcm_stream_lock_irqsave(substream, flags)            \
 632         do {                                                     \
 633                 typecheck(unsigned long, flags);                 \
 634                 flags = _snd_pcm_stream_lock_irqsave(substream); \
 635         } while (0)
 636 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
 637                                       unsigned long flags);
 638
 639 /**
 640  * snd_pcm_stream_lock_irqsave_nested - Single-nested PCM stream locking
 641  * @substream: PCM substream
 642  * @flags: irq flags
 643  *
 644  * This locks the PCM stream like snd_pcm_stream_lock_irqsave() but with
 645  * the single-depth lockdep subclass.
 646  */
 647 #define snd_pcm_stream_lock_irqsave_nested(substream, flags)            \
 648         do {                                                            \
 649                 typecheck(unsigned long, flags);                        \
 650                 flags = _snd_pcm_stream_lock_irqsave_nested(substream); \
 651         } while (0)
 652
 653 /**
 654  * snd_pcm_group_for_each_entry - iterate over the linked substreams
 655  * @s: the iterator
 656  * @substream: the substream
 657  *
 658  * Iterate over the all linked substreams to the given @substream.
 659  * When @substream isn't linked with any others, this gives returns @substream
 660  * itself once.
 661  */
 662 #define snd_pcm_group_for_each_entry(s, substream) \
 663         list_for_each_entry(s, &substream->group->substreams, link_list)
 664
 665 #define for_each_pcm_streams(stream)                    \
 666         for (stream  = SNDRV_PCM_STREAM_PLAYBACK;       \
 667              stream <= SNDRV_PCM_STREAM_LAST;           \
 668              stream++)
 669
 670 /**
 671  * snd_pcm_running - Check whether the substream is in a running state
 672  * @substream: substream to check
 673  *
 674  * Returns true if the given substream is in the state RUNNING, or in the
 675  * state DRAINING for playback.
 676  */
 677 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
 678 {
 679         return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
 680                 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
 681                  substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
 682 }
 683
 684 /**
 685  * bytes_to_samples - Unit conversion of the size from bytes to samples
 686  * @runtime: PCM runtime instance
 687  * @size: size in bytes
 688  */
 689 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
 690 {
 691         return size * 8 / runtime->sample_bits;
 692 }
 693
 694 /**
 695  * bytes_to_frames - Unit conversion of the size from bytes to frames
 696  * @runtime: PCM runtime instance
 697  * @size: size in bytes
 698  */
 699 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
 700 {
 701         return size * 8 / runtime->frame_bits;
 702 }
 703
 704 /**
 705  * samples_to_bytes - Unit conversion of the size from samples to bytes
 706  * @runtime: PCM runtime instance
 707  * @size: size in samples
 708  */
 709 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
 710 {
 711         return size * runtime->sample_bits / 8;
 712 }
 713
 714 /**
 715  * frames_to_bytes - Unit conversion of the size from frames to bytes
 716  * @runtime: PCM runtime instance
 717  * @size: size in frames
 718  */
 719 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
 720 {
 721         return size * runtime->frame_bits / 8;
 722 }
 723
 724 /**
 725  * frame_aligned - Check whether the byte size is aligned to frames
 726  * @runtime: PCM runtime instance
 727  * @bytes: size in bytes
 728  */
 729 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
 730 {
 731         return bytes % runtime->byte_align == 0;
 732 }
 733
 734 /**
 735  * snd_pcm_lib_buffer_bytes - Get the buffer size of the current PCM in bytes
 736  * @substream: PCM substream
 737  */
 738 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
 739 {
 740         struct snd_pcm_runtime *runtime = substream->runtime;
 741         return frames_to_bytes(runtime, runtime->buffer_size);
 742 }
 743
 744 /**
 745  * snd_pcm_lib_period_bytes - Get the period size of the current PCM in bytes
 746  * @substream: PCM substream
 747  */
 748 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
 749 {
 750         struct snd_pcm_runtime *runtime = substream->runtime;
 751         return frames_to_bytes(runtime, runtime->period_size);
 752 }
 753
 754 /**
 755  * snd_pcm_playback_avail - Get the available (writable) space for playback
 756  * @runtime: PCM runtime instance
 757  *
 758  * Result is between 0 ... (boundary - 1)
 759  */
 760 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
 761 {
 762         snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
 763         if (avail < 0)
 764                 avail += runtime->boundary;
 765         else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
 766                 avail -= runtime->boundary;
 767         return avail;
 768 }
 769
 770 /**
 771  * snd_pcm_capture_avail - Get the available (readable) space for capture
 772  * @runtime: PCM runtime instance
 773  *
 774  * Result is between 0 ... (boundary - 1)
 775  */
 776 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
 777 {
 778         snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
 779         if (avail < 0)
 780                 avail += runtime->boundary;
 781         return avail;
 782 }
 783
 784 /**
 785  * snd_pcm_playback_hw_avail - Get the queued space for playback
 786  * @runtime: PCM runtime instance
 787  */
 788 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
 789 {
 790         return runtime->buffer_size - snd_pcm_playback_avail(runtime);
 791 }
 792
 793 /**
 794  * snd_pcm_capture_hw_avail - Get the free space for capture
 795  * @runtime: PCM runtime instance
 796  */
 797 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
 798 {
 799         return runtime->buffer_size - snd_pcm_capture_avail(runtime);
 800 }
 801
 802 /**
 803  * snd_pcm_playback_ready - check whether the playback buffer is available
 804  * @substream: the pcm substream instance
 805  *
 806  * Checks whether enough free space is available on the playback buffer.
 807  *
 808  * Return: Non-zero if available, or zero if not.
 809  */
 810 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
 811 {
 812         struct snd_pcm_runtime *runtime = substream->runtime;
 813         return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
 814 }
 815
 816 /**
 817  * snd_pcm_capture_ready - check whether the capture buffer is available
 818  * @substream: the pcm substream instance
 819  *
 820  * Checks whether enough capture data is available on the capture buffer.
 821  *
 822  * Return: Non-zero if available, or zero if not.
 823  */
 824 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
 825 {
 826         struct snd_pcm_runtime *runtime = substream->runtime;
 827         return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
 828 }
 829
 830 /**
 831  * snd_pcm_playback_data - check whether any data exists on the playback buffer
 832  * @substream: the pcm substream instance
 833  *
 834  * Checks whether any data exists on the playback buffer.
 835  *
 836  * Return: Non-zero if any data exists, or zero if not. If stop_threshold
 837  * is bigger or equal to boundary, then this function returns always non-zero.
 838  */
 839 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
 840 {
 841         struct snd_pcm_runtime *runtime = substream->runtime;
 842
 843         if (runtime->stop_threshold >= runtime->boundary)
 844                 return 1;
 845         return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
 846 }
 847
 848 /**
 849  * snd_pcm_playback_empty - check whether the playback buffer is empty
 850  * @substream: the pcm substream instance
 851  *
 852  * Checks whether the playback buffer is empty.
 853  *
 854  * Return: Non-zero if empty, or zero if not.
 855  */
 856 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
 857 {
 858         struct snd_pcm_runtime *runtime = substream->runtime;
 859         return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
 860 }
 861
 862 /**
 863  * snd_pcm_capture_empty - check whether the capture buffer is empty
 864  * @substream: the pcm substream instance
 865  *
 866  * Checks whether the capture buffer is empty.
 867  *
 868  * Return: Non-zero if empty, or zero if not.
 869  */
 870 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
 871 {
 872         struct snd_pcm_runtime *runtime = substream->runtime;
 873         return snd_pcm_capture_avail(runtime) == 0;
 874 }
 875
 876 /**
 877  * snd_pcm_trigger_done - Mark the master substream
 878  * @substream: the pcm substream instance
 879  * @master: the linked master substream
 880  *
 881  * When multiple substreams of the same card are linked and the hardware
 882  * supports the single-shot operation, the driver calls this in the loop
 883  * in snd_pcm_group_for_each_entry() for marking the substream as "done".
 884  * Then most of trigger operations are performed only to the given master
 885  * substream.
 886  *
 887  * The trigger_master mark is cleared at timestamp updates at the end
 888  * of trigger operations.
 889  */
 890 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
 891                                         struct snd_pcm_substream *master)
 892 {
 893         substream->runtime->trigger_master = master;
 894 }
 895
 896 static inline int hw_is_mask(int var)
 897 {
 898         return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
 899                 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
 900 }
 901
 902 static inline int hw_is_interval(int var)
 903 {
 904         return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
 905                 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
 906 }
 907
 908 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
 909                                      snd_pcm_hw_param_t var)
 910 {
 911         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 912 }
 913
 914 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
 915                                              snd_pcm_hw_param_t var)
 916 {
 917         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 918 }
 919
 920 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
 921                                              snd_pcm_hw_param_t var)
 922 {
 923         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 924 }
 925
 926 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
 927                                                      snd_pcm_hw_param_t var)
 928 {
 929         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 930 }
 931
 932 /**
 933  * params_channels - Get the number of channels from the hw params
 934  * @p: hw params
 935  */
 936 static inline unsigned int params_channels(const struct snd_pcm_hw_params *p)
 937 {
 938         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_CHANNELS)->min;
 939 }
 940
 941 /**
 942  * params_rate - Get the sample rate from the hw params
 943  * @p: hw params
 944  */
 945 static inline unsigned int params_rate(const struct snd_pcm_hw_params *p)
 946 {
 947         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_RATE)->min;
 948 }
 949
 950 /**
 951  * params_period_size - Get the period size (in frames) from the hw params
 952  * @p: hw params
 953  */
 954 static inline unsigned int params_period_size(const struct snd_pcm_hw_params *p)
 955 {
 956         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min;
 957 }
 958
 959 /**
 960  * params_periods - Get the number of periods from the hw params
 961  * @p: hw params
 962  */
 963 static inline unsigned int params_periods(const struct snd_pcm_hw_params *p)
 964 {
 965         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIODS)->min;
 966 }
 967
 968 /**
 969  * params_buffer_size - Get the buffer size (in frames) from the hw params
 970  * @p: hw params
 971  */
 972 static inline unsigned int params_buffer_size(const struct snd_pcm_hw_params *p)
 973 {
 974         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min;
 975 }
 976
 977 /**
 978  * params_buffer_bytes - Get the buffer size (in bytes) from the hw params
 979  * @p: hw params
 980  */
 981 static inline unsigned int params_buffer_bytes(const struct snd_pcm_hw_params *p)
 982 {
 983         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min;
 984 }
 985
 986 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
 987 int snd_interval_list(struct snd_interval *i, unsigned int count,
 988                       const unsigned int *list, unsigned int mask);
 989 int snd_interval_ranges(struct snd_interval *i, unsigned int count,
 990                         const struct snd_interval *list, unsigned int mask);
 991 int snd_interval_ratnum(struct snd_interval *i,
 992                         unsigned int rats_count, const struct snd_ratnum *rats,
 993                         unsigned int *nump, unsigned int *denp);
 994
 995 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
 996 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
 997
 998 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
 999
1000 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1001                                  u_int64_t mask);
1002 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1003                                  unsigned int min, unsigned int max);
1004 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
1005 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
1006                                unsigned int cond,
1007                                snd_pcm_hw_param_t var,
1008                                const struct snd_pcm_hw_constraint_list *l);
1009 int snd_pcm_hw_constraint_ranges(struct snd_pcm_runtime *runtime,
1010                                  unsigned int cond,
1011                                  snd_pcm_hw_param_t var,
1012                                  const struct snd_pcm_hw_constraint_ranges *r);
1013 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
1014                                   unsigned int cond,
1015                                   snd_pcm_hw_param_t var,
1016                                   const struct snd_pcm_hw_constraint_ratnums *r);
1017 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
1018                                   unsigned int cond,
1019                                   snd_pcm_hw_param_t var,
1020                                   const struct snd_pcm_hw_constraint_ratdens *r);
1021 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1022                                  unsigned int cond,
1023                                  unsigned int width,
1024                                  unsigned int msbits);
1025 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1026                                unsigned int cond,
1027                                snd_pcm_hw_param_t var,
1028                                unsigned long step);
1029 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1030                                unsigned int cond,
1031                                snd_pcm_hw_param_t var);
1032 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
1033                                unsigned int base_rate);
1034 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
1035                         unsigned int cond,
1036                         int var,
1037                         snd_pcm_hw_rule_func_t func, void *private,
1038                         int dep, ...);
1039
1040 /**
1041  * snd_pcm_hw_constraint_single() - Constrain parameter to a single value
1042  * @runtime: PCM runtime instance
1043  * @var: The hw_params variable to constrain
1044  * @val: The value to constrain to
1045  *
1046  * Return: Positive if the value is changed, zero if it's not changed, or a
1047  * negative error code.
1048  */
1049 static inline int snd_pcm_hw_constraint_single(
1050         struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1051         unsigned int val)
1052 {
1053         return snd_pcm_hw_constraint_minmax(runtime, var, val, val);
1054 }
1055
1056 int snd_pcm_format_signed(snd_pcm_format_t format);
1057 int snd_pcm_format_unsigned(snd_pcm_format_t format);
1058 int snd_pcm_format_linear(snd_pcm_format_t format);
1059 int snd_pcm_format_little_endian(snd_pcm_format_t format);
1060 int snd_pcm_format_big_endian(snd_pcm_format_t format);
1061 #if 0 /* just for kernel-doc */
1062 /**
1063  * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
1064  * @format: the format to check
1065  *
1066  * Return: 1 if the given PCM format is CPU-endian, 0 if
1067  * opposite, or a negative error code if endian not specified.
1068  */
1069 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1070 #endif /* DocBook */
1071 #ifdef SNDRV_LITTLE_ENDIAN
1072 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
1073 #else
1074 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
1075 #endif
1076 int snd_pcm_format_width(snd_pcm_format_t format);                      /* in bits */
1077 int snd_pcm_format_physical_width(snd_pcm_format_t format);             /* in bits */
1078 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1079 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
1080 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
1081
1082 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
1083                      const struct snd_pcm_ops *ops);
1084 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
1085 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1086                       unsigned int cmd, void *arg);
1087 void snd_pcm_period_elapsed_under_stream_lock(struct snd_pcm_substream *substream);
1088 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
1089 snd_pcm_sframes_t __snd_pcm_lib_xfer(struct snd_pcm_substream *substream,
1090                                      void *buf, bool interleaved,
1091                                      snd_pcm_uframes_t frames, bool in_kernel);
1092
1093 static inline snd_pcm_sframes_t
1094 snd_pcm_lib_write(struct snd_pcm_substream *substream,
1095                   const void __user *buf, snd_pcm_uframes_t frames)
1096 {
1097         return __snd_pcm_lib_xfer(substream, (void __force *)buf, true, frames, false);
1098 }
1099
1100 static inline snd_pcm_sframes_t
1101 snd_pcm_lib_read(struct snd_pcm_substream *substream,
1102                  void __user *buf, snd_pcm_uframes_t frames)
1103 {
1104         return __snd_pcm_lib_xfer(substream, (void __force *)buf, true, frames, false);
1105 }
1106
1107 static inline snd_pcm_sframes_t
1108 snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1109                    void __user **bufs, snd_pcm_uframes_t frames)
1110 {
1111         return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames, false);
1112 }
1113
1114 static inline snd_pcm_sframes_t
1115 snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1116                   void __user **bufs, snd_pcm_uframes_t frames)
1117 {
1118         return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames, false);
1119 }
1120
1121 static inline snd_pcm_sframes_t
1122 snd_pcm_kernel_write(struct snd_pcm_substream *substream,
1123                      const void *buf, snd_pcm_uframes_t frames)
1124 {
1125         return __snd_pcm_lib_xfer(substream, (void *)buf, true, frames, true);
1126 }
1127
1128 static inline snd_pcm_sframes_t
1129 snd_pcm_kernel_read(struct snd_pcm_substream *substream,
1130                     void *buf, snd_pcm_uframes_t frames)
1131 {
1132         return __snd_pcm_lib_xfer(substream, buf, true, frames, true);
1133 }
1134
1135 static inline snd_pcm_sframes_t
1136 snd_pcm_kernel_writev(struct snd_pcm_substream *substream,
1137                       void **bufs, snd_pcm_uframes_t frames)
1138 {
1139         return __snd_pcm_lib_xfer(substream, bufs, false, frames, true);
1140 }
1141
1142 static inline snd_pcm_sframes_t
1143 snd_pcm_kernel_readv(struct snd_pcm_substream *substream,
1144                      void **bufs, snd_pcm_uframes_t frames)
1145 {
1146         return __snd_pcm_lib_xfer(substream, bufs, false, frames, true);
1147 }
1148
1149 int snd_pcm_hw_limit_rates(struct snd_pcm_hardware *hw);
1150
1151 static inline int
1152 snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime)
1153 {
1154         return snd_pcm_hw_limit_rates(&runtime->hw);
1155 }
1156
1157 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
1158 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
1159 unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
1160                                          unsigned int rates_b);
1161 unsigned int snd_pcm_rate_range_to_bits(unsigned int rate_min,
1162                                         unsigned int rate_max);
1163
1164 /**
1165  * snd_pcm_set_runtime_buffer - Set the PCM runtime buffer
1166  * @substream: PCM substream to set
1167  * @bufp: the buffer information, NULL to clear
1168  *
1169  * Copy the buffer information to runtime->dma_buffer when @bufp is non-NULL.
1170  * Otherwise it clears the current buffer information.
1171  */
1172 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1173                                               struct snd_dma_buffer *bufp)
1174 {
1175         struct snd_pcm_runtime *runtime = substream->runtime;
1176         if (bufp) {
1177                 runtime->dma_buffer_p = bufp;
1178                 runtime->dma_area = bufp->area;
1179                 runtime->dma_addr = bufp->addr;
1180                 runtime->dma_bytes = bufp->bytes;
1181         } else {
1182                 runtime->dma_buffer_p = NULL;
1183                 runtime->dma_area = NULL;
1184                 runtime->dma_addr = 0;
1185                 runtime->dma_bytes = 0;
1186         }
1187 }
1188
1189 /**
1190  * snd_pcm_gettime - Fill the timespec64 depending on the timestamp mode
1191  * @runtime: PCM runtime instance
1192  * @tv: timespec64 to fill
1193  */
1194 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
1195                                    struct timespec64 *tv)
1196 {
1197         switch (runtime->tstamp_type) {
1198         case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC:
1199                 ktime_get_ts64(tv);
1200                 break;
1201         case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW:
1202                 ktime_get_raw_ts64(tv);
1203                 break;
1204         default:
1205                 ktime_get_real_ts64(tv);
1206                 break;
1207         }
1208 }
1209
1210 /*
1211  *  Memory
1212  */
1213
1214 void snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
1215 void snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
1216 void snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1217                                   int type, struct device *data,
1218                                   size_t size, size_t max);
1219 void snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1220                                           int type, void *data,
1221                                           size_t size, size_t max);
1222 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
1223 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1224
1225 int snd_pcm_set_managed_buffer(struct snd_pcm_substream *substream, int type,
1226                                struct device *data, size_t size, size_t max);
1227 int snd_pcm_set_managed_buffer_all(struct snd_pcm *pcm, int type,
1228                                    struct device *data,
1229                                    size_t size, size_t max);
1230
1231 /**
1232  * snd_pcm_set_fixed_buffer - Preallocate and set up the fixed size PCM buffer
1233  * @substream: the pcm substream instance
1234  * @type: DMA type (SNDRV_DMA_TYPE_*)
1235  * @data: DMA type dependent data
1236  * @size: the requested pre-allocation size in bytes
1237  *
1238  * This is a variant of snd_pcm_set_managed_buffer(), but this pre-allocates
1239  * only the given sized buffer and doesn't allow re-allocation nor dynamic
1240  * allocation of a larger buffer unlike the standard one.
1241  * The function may return -ENOMEM error, hence the caller must check it.
1242  */
1243 static inline int __must_check
1244 snd_pcm_set_fixed_buffer(struct snd_pcm_substream *substream, int type,
1245                                  struct device *data, size_t size)
1246 {
1247         return snd_pcm_set_managed_buffer(substream, type, data, size, 0);
1248 }
1249
1250 /**
1251  * snd_pcm_set_fixed_buffer_all - Preallocate and set up the fixed size PCM buffer
1252  * @pcm: the pcm instance
1253  * @type: DMA type (SNDRV_DMA_TYPE_*)
1254  * @data: DMA type dependent data
1255  * @size: the requested pre-allocation size in bytes
1256  *
1257  * Apply the set up of the fixed buffer via snd_pcm_set_fixed_buffer() for
1258  * all substream.  If any of allocation fails, it returns -ENOMEM, hence the
1259  * caller must check the return value.
1260  */
1261 static inline int __must_check
1262 snd_pcm_set_fixed_buffer_all(struct snd_pcm *pcm, int type,
1263                              struct device *data, size_t size)
1264 {
1265         return snd_pcm_set_managed_buffer_all(pcm, type, data, size, 0);
1266 }
1267
1268 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
1269                                       size_t size, gfp_t gfp_flags);
1270 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
1271 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
1272                                           unsigned long offset);
1273 /**
1274  * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
1275  * @substream: the substream to allocate the buffer to
1276  * @size: the requested buffer size, in bytes
1277  *
1278  * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
1279  * contiguous in kernel virtual space, but not in physical memory.  Use this
1280  * if the buffer is accessed by kernel code but not by device DMA.
1281  *
1282  * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1283  * code.
1284  */
1285 static inline int snd_pcm_lib_alloc_vmalloc_buffer
1286                         (struct snd_pcm_substream *substream, size_t size)
1287 {
1288         return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1289                                                  GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO);
1290 }
1291
1292 /**
1293  * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
1294  * @substream: the substream to allocate the buffer to
1295  * @size: the requested buffer size, in bytes
1296  *
1297  * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
1298  * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
1299  *
1300  * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1301  * code.
1302  */
1303 static inline int snd_pcm_lib_alloc_vmalloc_32_buffer
1304                         (struct snd_pcm_substream *substream, size_t size)
1305 {
1306         return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1307                                                  GFP_KERNEL | GFP_DMA32 | __GFP_ZERO);
1308 }
1309
1310 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
1311
1312 /**
1313  * snd_pcm_sgbuf_get_addr - Get the DMA address at the corresponding offset
1314  * @substream: PCM substream
1315  * @ofs: byte offset
1316  */
1317 static inline dma_addr_t
1318 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1319 {
1320         return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
1321 }
1322
1323 /**
1324  * snd_pcm_sgbuf_get_chunk_size - Compute the max size that fits within the
1325  * contig. page from the given size
1326  * @substream: PCM substream
1327  * @ofs: byte offset
1328  * @size: byte size to examine
1329  */
1330 static inline unsigned int
1331 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1332                              unsigned int ofs, unsigned int size)
1333 {
1334         return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1335 }
1336
1337 /**
1338  * snd_pcm_mmap_data_open - increase the mmap counter
1339  * @area: VMA
1340  *
1341  * PCM mmap callback should handle this counter properly
1342  */
1343 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1344 {
1345         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1346         atomic_inc(&substream->mmap_count);
1347 }
1348
1349 /**
1350  * snd_pcm_mmap_data_close - decrease the mmap counter
1351  * @area: VMA
1352  *
1353  * PCM mmap callback should handle this counter properly
1354  */
1355 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1356 {
1357         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1358         atomic_dec(&substream->mmap_count);
1359 }
1360
1361 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1362                              struct vm_area_struct *area);
1363 /* mmap for io-memory area */
1364 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1365 #define SNDRV_PCM_INFO_MMAP_IOMEM       SNDRV_PCM_INFO_MMAP
1366 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1367 #else
1368 #define SNDRV_PCM_INFO_MMAP_IOMEM       0
1369 #define snd_pcm_lib_mmap_iomem  NULL
1370 #endif
1371
1372 /**
1373  * snd_pcm_limit_isa_dma_size - Get the max size fitting with ISA DMA transfer
1374  * @dma: DMA number
1375  * @max: pointer to store the max size
1376  */
1377 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1378 {
1379         *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1380 }
1381
1382 /*
1383  *  Misc
1384  */
1385
1386 #define SNDRV_PCM_DEFAULT_CON_SPDIF     (IEC958_AES0_CON_EMPHASIS_NONE|\
1387                                          (IEC958_AES1_CON_ORIGINAL<<8)|\
1388                                          (IEC958_AES1_CON_PCM_CODER<<8)|\
1389                                          (IEC958_AES3_CON_FS_48000<<24))
1390
1391 const char *snd_pcm_format_name(snd_pcm_format_t format);
1392
1393 /**
1394  * snd_pcm_stream_str - Get a string naming the direction of a stream
1395  * @substream: the pcm substream instance
1396  *
1397  * Return: A string naming the direction of the stream.
1398  */
1399 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1400 {
1401         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1402                 return "Playback";
1403         else
1404                 return "Capture";
1405 }
1406
1407 /*
1408  * PCM channel-mapping control API
1409  */
1410 /* array element of channel maps */
1411 struct snd_pcm_chmap_elem {
1412         unsigned char channels;
1413         unsigned char map[15];
1414 };
1415
1416 /* channel map information; retrieved via snd_kcontrol_chip() */
1417 struct snd_pcm_chmap {
1418         struct snd_pcm *pcm;    /* assigned PCM instance */
1419         int stream;             /* PLAYBACK or CAPTURE */
1420         struct snd_kcontrol *kctl;
1421         const struct snd_pcm_chmap_elem *chmap;
1422         unsigned int max_channels;
1423         unsigned int channel_mask;      /* optional: active channels bitmask */
1424         void *private_data;     /* optional: private data pointer */
1425 };
1426
1427 /**
1428  * snd_pcm_chmap_substream - get the PCM substream assigned to the given chmap info
1429  * @info: chmap information
1430  * @idx: the substream number index
1431  */
1432 static inline struct snd_pcm_substream *
1433 snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1434 {
1435         struct snd_pcm_substream *s;
1436         for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1437                 if (s->number == idx)
1438                         return s;
1439         return NULL;
1440 }
1441
1442 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1443 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1444 /* Other world's standard channel maps (C/LFE prior to RL/RR) */
1445 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1446
1447 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1448 #define SND_PCM_CHMAP_MASK_24   ((1U << 2) | (1U << 4))
1449 #define SND_PCM_CHMAP_MASK_246  (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1450 #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1451
1452 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1453                            const struct snd_pcm_chmap_elem *chmap,
1454                            int max_channels,
1455                            unsigned long private_value,
1456                            struct snd_pcm_chmap **info_ret);
1457
1458 /**
1459  * pcm_format_to_bits - Strong-typed conversion of pcm_format to bitwise
1460  * @pcm_format: PCM format
1461  */
1462 static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1463 {
1464         return 1ULL << (__force int) pcm_format;
1465 }
1466
1467 /**
1468  * pcm_for_each_format - helper to iterate for each format type
1469  * @f: the iterator variable in snd_pcm_format_t type
1470  */
1471 #define pcm_for_each_format(f)                                          \
1472         for ((f) = SNDRV_PCM_FORMAT_FIRST;                              \
1473              (__force int)(f) <= (__force int)SNDRV_PCM_FORMAT_LAST;    \
1474              (f) = (__force snd_pcm_format_t)((__force int)(f) + 1))
1475
1476 /* printk helpers */
1477 #define pcm_err(pcm, fmt, args...) \
1478         dev_err((pcm)->card->dev, fmt, ##args)
1479 #define pcm_warn(pcm, fmt, args...) \
1480         dev_warn((pcm)->card->dev, fmt, ##args)
1481 #define pcm_dbg(pcm, fmt, args...) \
1482         dev_dbg((pcm)->card->dev, fmt, ##args)
1483
1484 struct snd_pcm_status64 {
1485         snd_pcm_state_t state;          /* stream state */
1486         u8 rsvd[4];
1487         s64 trigger_tstamp_sec;         /* time when stream was started/stopped/paused */
1488         s64 trigger_tstamp_nsec;
1489         s64 tstamp_sec;                 /* reference timestamp */
1490         s64 tstamp_nsec;
1491         snd_pcm_uframes_t appl_ptr;     /* appl ptr */
1492         snd_pcm_uframes_t hw_ptr;       /* hw ptr */
1493         snd_pcm_sframes_t delay;        /* current delay in frames */
1494         snd_pcm_uframes_t avail;        /* number of frames available */
1495         snd_pcm_uframes_t avail_max;    /* max frames available on hw since last status */
1496         snd_pcm_uframes_t overrange;    /* count of ADC (capture) overrange detections from last status */
1497         snd_pcm_state_t suspended_state; /* suspended stream state */
1498         __u32 audio_tstamp_data;         /* needed for 64-bit alignment, used for configs/report to/from userspace */
1499         s64 audio_tstamp_sec;           /* sample counter, wall clock, PHC or on-demand sync'ed */
1500         s64 audio_tstamp_nsec;
1501         s64 driver_tstamp_sec;          /* useful in case reference system tstamp is reported with delay */
1502         s64 driver_tstamp_nsec;
1503         __u32 audio_tstamp_accuracy;    /* in ns units, only valid if indicated in audio_tstamp_data */
1504         unsigned char reserved[52-4*sizeof(s64)]; /* must be filled with zero */
1505 };
1506
1507 #define SNDRV_PCM_IOCTL_STATUS64        _IOR('A', 0x20, struct snd_pcm_status64)
1508 #define SNDRV_PCM_IOCTL_STATUS_EXT64    _IOWR('A', 0x24, struct snd_pcm_status64)
1509
1510 struct snd_pcm_status32 {
1511         snd_pcm_state_t state;          /* stream state */
1512         s32 trigger_tstamp_sec; /* time when stream was started/stopped/paused */
1513         s32 trigger_tstamp_nsec;
1514         s32 tstamp_sec;         /* reference timestamp */
1515         s32 tstamp_nsec;
1516         u32 appl_ptr;           /* appl ptr */
1517         u32 hw_ptr;             /* hw ptr */
1518         s32 delay;              /* current delay in frames */
1519         u32 avail;              /* number of frames available */
1520         u32 avail_max;          /* max frames available on hw since last status */
1521         u32 overrange;          /* count of ADC (capture) overrange detections from last status */
1522         snd_pcm_state_t suspended_state;        /* suspended stream state */
1523         u32 audio_tstamp_data;  /* needed for 64-bit alignment, used for configs/report to/from userspace */
1524         s32 audio_tstamp_sec;   /* sample counter, wall clock, PHC or on-demand sync'ed */
1525         s32 audio_tstamp_nsec;
1526         s32 driver_tstamp_sec;  /* useful in case reference system tstamp is reported with delay */
1527         s32 driver_tstamp_nsec;
1528         u32 audio_tstamp_accuracy;      /* in ns units, only valid if indicated in audio_tstamp_data */
1529         unsigned char reserved[52-4*sizeof(s32)]; /* must be filled with zero */
1530 };
1531
1532 #define SNDRV_PCM_IOCTL_STATUS32        _IOR('A', 0x20, struct snd_pcm_status32)
1533 #define SNDRV_PCM_IOCTL_STATUS_EXT32    _IOWR('A', 0x24, struct snd_pcm_status32)
1534
1535 #endif /* __SOUND_PCM_H */