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