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