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