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