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