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_ops { 64 int (*open)(struct snd_pcm_substream *substream); 65 int (*close)(struct snd_pcm_substream *substream); 66 int (*ioctl)(struct snd_pcm_substream * substream, 67 unsigned int cmd, void *arg); 68 int (*hw_params)(struct snd_pcm_substream *substream, 69 struct snd_pcm_hw_params *params); 70 int (*hw_free)(struct snd_pcm_substream *substream); 71 int (*prepare)(struct snd_pcm_substream *substream); 72 int (*trigger)(struct snd_pcm_substream *substream, int cmd); 73 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream); 74 int (*wall_clock)(struct snd_pcm_substream *substream, 75 struct timespec *audio_ts); 76 int (*copy)(struct snd_pcm_substream *substream, int channel, 77 snd_pcm_uframes_t pos, 78 void __user *buf, snd_pcm_uframes_t count); 79 int (*silence)(struct snd_pcm_substream *substream, int channel, 80 snd_pcm_uframes_t pos, snd_pcm_uframes_t count); 81 struct page *(*page)(struct snd_pcm_substream *substream, 82 unsigned long offset); 83 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma); 84 int (*ack)(struct snd_pcm_substream *substream); 85 }; 86 87 /* 88 * 89 */ 90 91 #if defined(CONFIG_SND_DYNAMIC_MINORS) 92 #define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2) 93 #else 94 #define SNDRV_PCM_DEVICES 8 95 #endif 96 97 #define SNDRV_PCM_IOCTL1_FALSE ((void *)0) 98 #define SNDRV_PCM_IOCTL1_TRUE ((void *)1) 99 100 #define SNDRV_PCM_IOCTL1_RESET 0 101 #define SNDRV_PCM_IOCTL1_INFO 1 102 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2 103 #define SNDRV_PCM_IOCTL1_GSTATE 3 104 #define SNDRV_PCM_IOCTL1_FIFO_SIZE 4 105 106 #define SNDRV_PCM_TRIGGER_STOP 0 107 #define SNDRV_PCM_TRIGGER_START 1 108 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3 109 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4 110 #define SNDRV_PCM_TRIGGER_SUSPEND 5 111 #define SNDRV_PCM_TRIGGER_RESUME 6 112 113 #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1) 114 115 /* If you change this don't forget to change rates[] table in pcm_native.c */ 116 #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */ 117 #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */ 118 #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */ 119 #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */ 120 #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */ 121 #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */ 122 #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */ 123 #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */ 124 #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */ 125 #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */ 126 #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */ 127 #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */ 128 #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */ 129 130 #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */ 131 #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */ 132 133 #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\ 134 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\ 135 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100) 136 #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000) 137 #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\ 138 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000) 139 #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\ 140 SNDRV_PCM_RATE_192000) 141 #define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt) 142 #define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8) 143 #define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8) 144 #define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE) 145 #define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE) 146 #define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE) 147 #define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE) 148 #define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE) 149 #define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE) 150 #define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE) 151 #define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE) 152 #define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE) 153 #define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE) 154 #define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE) 155 #define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE) 156 #define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE) 157 #define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE) 158 #define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE) 159 #define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE) 160 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE) 161 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE) 162 #define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW) 163 #define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW) 164 #define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM) 165 #define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG) 166 #define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM) 167 #define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL) 168 #define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE) 169 #define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE) 170 #define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE) 171 #define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE) 172 #define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE) 173 #define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE) 174 #define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE) 175 #define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE) 176 #define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE) 177 #define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE) 178 #define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE) 179 #define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE) 180 #define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24) 181 #define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B) 182 #define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40) 183 #define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B) 184 #define SNDRV_PCM_FMTBIT_DSD_U8 _SNDRV_PCM_FMTBIT(DSD_U8) 185 #define SNDRV_PCM_FMTBIT_DSD_U16_LE _SNDRV_PCM_FMTBIT(DSD_U16_LE) 186 187 #ifdef SNDRV_LITTLE_ENDIAN 188 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE 189 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE 190 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE 191 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE 192 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE 193 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE 194 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE 195 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE 196 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE 197 #endif 198 #ifdef SNDRV_BIG_ENDIAN 199 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE 200 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE 201 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE 202 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE 203 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE 204 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE 205 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE 206 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE 207 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE 208 #endif 209 210 struct snd_pcm_file { 211 struct snd_pcm_substream *substream; 212 int no_compat_mmap; 213 }; 214 215 struct snd_pcm_hw_rule; 216 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params, 217 struct snd_pcm_hw_rule *rule); 218 219 struct snd_pcm_hw_rule { 220 unsigned int cond; 221 snd_pcm_hw_rule_func_t func; 222 int var; 223 int deps[4]; 224 void *private; 225 }; 226 227 struct snd_pcm_hw_constraints { 228 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK - 229 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1]; 230 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL - 231 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1]; 232 unsigned int rules_num; 233 unsigned int rules_all; 234 struct snd_pcm_hw_rule *rules; 235 }; 236 237 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs, 238 snd_pcm_hw_param_t var) 239 { 240 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK]; 241 } 242 243 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs, 244 snd_pcm_hw_param_t var) 245 { 246 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL]; 247 } 248 249 struct snd_ratnum { 250 unsigned int num; 251 unsigned int den_min, den_max, den_step; 252 }; 253 254 struct snd_ratden { 255 unsigned int num_min, num_max, num_step; 256 unsigned int den; 257 }; 258 259 struct snd_pcm_hw_constraint_ratnums { 260 int nrats; 261 struct snd_ratnum *rats; 262 }; 263 264 struct snd_pcm_hw_constraint_ratdens { 265 int nrats; 266 struct snd_ratden *rats; 267 }; 268 269 struct snd_pcm_hw_constraint_list { 270 unsigned int count; 271 const unsigned int *list; 272 unsigned int mask; 273 }; 274 275 struct snd_pcm_hwptr_log; 276 277 struct snd_pcm_runtime { 278 /* -- Status -- */ 279 struct snd_pcm_substream *trigger_master; 280 struct timespec trigger_tstamp; /* trigger timestamp */ 281 int overrange; 282 snd_pcm_uframes_t avail_max; 283 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */ 284 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */ 285 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */ 286 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */ 287 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */ 288 u64 hw_ptr_wrap; /* offset for hw_ptr due to boundary wrap-around */ 289 290 /* -- HW params -- */ 291 snd_pcm_access_t access; /* access mode */ 292 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */ 293 snd_pcm_subformat_t subformat; /* subformat */ 294 unsigned int rate; /* rate in Hz */ 295 unsigned int channels; /* channels */ 296 snd_pcm_uframes_t period_size; /* period size */ 297 unsigned int periods; /* periods */ 298 snd_pcm_uframes_t buffer_size; /* buffer size */ 299 snd_pcm_uframes_t min_align; /* Min alignment for the format */ 300 size_t byte_align; 301 unsigned int frame_bits; 302 unsigned int sample_bits; 303 unsigned int info; 304 unsigned int rate_num; 305 unsigned int rate_den; 306 unsigned int no_period_wakeup: 1; 307 308 /* -- SW params -- */ 309 int tstamp_mode; /* mmap timestamp is updated */ 310 unsigned int period_step; 311 snd_pcm_uframes_t start_threshold; 312 snd_pcm_uframes_t stop_threshold; 313 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when 314 noise is nearest than this */ 315 snd_pcm_uframes_t silence_size; /* Silence filling size */ 316 snd_pcm_uframes_t boundary; /* pointers wrap point */ 317 318 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */ 319 snd_pcm_uframes_t silence_filled; /* size filled with silence */ 320 321 union snd_pcm_sync_id sync; /* hardware synchronization ID */ 322 323 /* -- mmap -- */ 324 struct snd_pcm_mmap_status *status; 325 struct snd_pcm_mmap_control *control; 326 327 /* -- locking / scheduling -- */ 328 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */ 329 wait_queue_head_t sleep; /* poll sleep */ 330 wait_queue_head_t tsleep; /* transfer sleep */ 331 struct fasync_struct *fasync; 332 333 /* -- private section -- */ 334 void *private_data; 335 void (*private_free)(struct snd_pcm_runtime *runtime); 336 337 /* -- hardware description -- */ 338 struct snd_pcm_hardware hw; 339 struct snd_pcm_hw_constraints hw_constraints; 340 341 /* -- interrupt callbacks -- */ 342 void (*transfer_ack_begin)(struct snd_pcm_substream *substream); 343 void (*transfer_ack_end)(struct snd_pcm_substream *substream); 344 345 /* -- timer -- */ 346 unsigned int timer_resolution; /* timer resolution */ 347 int tstamp_type; /* timestamp type */ 348 349 /* -- DMA -- */ 350 unsigned char *dma_area; /* DMA area */ 351 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */ 352 size_t dma_bytes; /* size of DMA area */ 353 354 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */ 355 356 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE) 357 /* -- OSS things -- */ 358 struct snd_pcm_oss_runtime oss; 359 #endif 360 361 #ifdef CONFIG_SND_PCM_XRUN_DEBUG 362 struct snd_pcm_hwptr_log *hwptr_log; 363 #endif 364 }; 365 366 struct snd_pcm_group { /* keep linked substreams */ 367 spinlock_t lock; 368 struct list_head substreams; 369 int count; 370 }; 371 372 struct pid; 373 374 struct snd_pcm_substream { 375 struct snd_pcm *pcm; 376 struct snd_pcm_str *pstr; 377 void *private_data; /* copied from pcm->private_data */ 378 int number; 379 char name[32]; /* substream name */ 380 int stream; /* stream (direction) */ 381 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */ 382 size_t buffer_bytes_max; /* limit ring buffer size */ 383 struct snd_dma_buffer dma_buffer; 384 size_t dma_max; 385 /* -- hardware operations -- */ 386 const struct snd_pcm_ops *ops; 387 /* -- runtime information -- */ 388 struct snd_pcm_runtime *runtime; 389 /* -- timer section -- */ 390 struct snd_timer *timer; /* timer */ 391 unsigned timer_running: 1; /* time is running */ 392 /* -- next substream -- */ 393 struct snd_pcm_substream *next; 394 /* -- linked substreams -- */ 395 struct list_head link_list; /* linked list member */ 396 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */ 397 struct snd_pcm_group *group; /* pointer to current group */ 398 /* -- assigned files -- */ 399 void *file; 400 int ref_count; 401 atomic_t mmap_count; 402 unsigned int f_flags; 403 void (*pcm_release)(struct snd_pcm_substream *); 404 struct pid *pid; 405 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE) 406 /* -- OSS things -- */ 407 struct snd_pcm_oss_substream oss; 408 #endif 409 #ifdef CONFIG_SND_VERBOSE_PROCFS 410 struct snd_info_entry *proc_root; 411 struct snd_info_entry *proc_info_entry; 412 struct snd_info_entry *proc_hw_params_entry; 413 struct snd_info_entry *proc_sw_params_entry; 414 struct snd_info_entry *proc_status_entry; 415 struct snd_info_entry *proc_prealloc_entry; 416 struct snd_info_entry *proc_prealloc_max_entry; 417 #endif 418 /* misc flags */ 419 unsigned int hw_opened: 1; 420 }; 421 422 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0) 423 424 425 struct snd_pcm_str { 426 int stream; /* stream (direction) */ 427 struct snd_pcm *pcm; 428 /* -- substreams -- */ 429 unsigned int substream_count; 430 unsigned int substream_opened; 431 struct snd_pcm_substream *substream; 432 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE) 433 /* -- OSS things -- */ 434 struct snd_pcm_oss_stream oss; 435 #endif 436 #ifdef CONFIG_SND_VERBOSE_PROCFS 437 struct snd_info_entry *proc_root; 438 struct snd_info_entry *proc_info_entry; 439 #ifdef CONFIG_SND_PCM_XRUN_DEBUG 440 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */ 441 struct snd_info_entry *proc_xrun_debug_entry; 442 #endif 443 #endif 444 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */ 445 }; 446 447 struct snd_pcm { 448 struct snd_card *card; 449 struct list_head list; 450 int device; /* device number */ 451 unsigned int info_flags; 452 unsigned short dev_class; 453 unsigned short dev_subclass; 454 char id[64]; 455 char name[80]; 456 struct snd_pcm_str streams[2]; 457 struct mutex open_mutex; 458 wait_queue_head_t open_wait; 459 void *private_data; 460 void (*private_free) (struct snd_pcm *pcm); 461 struct device *dev; /* actual hw device this belongs to */ 462 bool internal; /* pcm is for internal use only */ 463 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE) 464 struct snd_pcm_oss oss; 465 #endif 466 }; 467 468 struct snd_pcm_notify { 469 int (*n_register) (struct snd_pcm * pcm); 470 int (*n_disconnect) (struct snd_pcm * pcm); 471 int (*n_unregister) (struct snd_pcm * pcm); 472 struct list_head list; 473 }; 474 475 /* 476 * Registering 477 */ 478 479 extern const struct file_operations snd_pcm_f_ops[2]; 480 481 int snd_pcm_new(struct snd_card *card, const char *id, int device, 482 int playback_count, int capture_count, 483 struct snd_pcm **rpcm); 484 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device, 485 int playback_count, int capture_count, 486 struct snd_pcm **rpcm); 487 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count); 488 489 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree); 490 491 /* 492 * Native I/O 493 */ 494 495 extern rwlock_t snd_pcm_link_rwlock; 496 497 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info); 498 int snd_pcm_info_user(struct snd_pcm_substream *substream, 499 struct snd_pcm_info __user *info); 500 int snd_pcm_status(struct snd_pcm_substream *substream, 501 struct snd_pcm_status *status); 502 int snd_pcm_start(struct snd_pcm_substream *substream); 503 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status); 504 int snd_pcm_drain_done(struct snd_pcm_substream *substream); 505 #ifdef CONFIG_PM 506 int snd_pcm_suspend(struct snd_pcm_substream *substream); 507 int snd_pcm_suspend_all(struct snd_pcm *pcm); 508 #endif 509 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg); 510 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file, 511 struct snd_pcm_substream **rsubstream); 512 void snd_pcm_release_substream(struct snd_pcm_substream *substream); 513 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file, 514 struct snd_pcm_substream **rsubstream); 515 void snd_pcm_detach_substream(struct snd_pcm_substream *substream); 516 void snd_pcm_vma_notify_data(void *client, void *data); 517 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area); 518 519 520 #ifdef CONFIG_SND_DEBUG 521 void snd_pcm_debug_name(struct snd_pcm_substream *substream, 522 char *name, size_t len); 523 #else 524 static inline void 525 snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size) 526 { 527 *buf = 0; 528 } 529 #endif 530 531 /* 532 * PCM library 533 */ 534 535 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream) 536 { 537 return substream->group != &substream->self_group; 538 } 539 540 static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream) 541 { 542 read_lock(&snd_pcm_link_rwlock); 543 spin_lock(&substream->self_group.lock); 544 } 545 546 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream) 547 { 548 spin_unlock(&substream->self_group.lock); 549 read_unlock(&snd_pcm_link_rwlock); 550 } 551 552 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream) 553 { 554 read_lock_irq(&snd_pcm_link_rwlock); 555 spin_lock(&substream->self_group.lock); 556 } 557 558 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream) 559 { 560 spin_unlock(&substream->self_group.lock); 561 read_unlock_irq(&snd_pcm_link_rwlock); 562 } 563 564 #define snd_pcm_stream_lock_irqsave(substream, flags) \ 565 do { \ 566 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \ 567 spin_lock(&substream->self_group.lock); \ 568 } while (0) 569 570 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \ 571 do { \ 572 spin_unlock(&substream->self_group.lock); \ 573 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \ 574 } while (0) 575 576 #define snd_pcm_group_for_each_entry(s, substream) \ 577 list_for_each_entry(s, &substream->group->substreams, link_list) 578 579 static inline int snd_pcm_running(struct snd_pcm_substream *substream) 580 { 581 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING || 582 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING && 583 substream->stream == SNDRV_PCM_STREAM_PLAYBACK)); 584 } 585 586 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size) 587 { 588 return size * 8 / runtime->sample_bits; 589 } 590 591 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size) 592 { 593 return size * 8 / runtime->frame_bits; 594 } 595 596 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size) 597 { 598 return size * runtime->sample_bits / 8; 599 } 600 601 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size) 602 { 603 return size * runtime->frame_bits / 8; 604 } 605 606 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes) 607 { 608 return bytes % runtime->byte_align == 0; 609 } 610 611 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream) 612 { 613 struct snd_pcm_runtime *runtime = substream->runtime; 614 return frames_to_bytes(runtime, runtime->buffer_size); 615 } 616 617 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream) 618 { 619 struct snd_pcm_runtime *runtime = substream->runtime; 620 return frames_to_bytes(runtime, runtime->period_size); 621 } 622 623 /* 624 * result is: 0 ... (boundary - 1) 625 */ 626 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime) 627 { 628 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr; 629 if (avail < 0) 630 avail += runtime->boundary; 631 else if ((snd_pcm_uframes_t) avail >= runtime->boundary) 632 avail -= runtime->boundary; 633 return avail; 634 } 635 636 /* 637 * result is: 0 ... (boundary - 1) 638 */ 639 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime) 640 { 641 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr; 642 if (avail < 0) 643 avail += runtime->boundary; 644 return avail; 645 } 646 647 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime) 648 { 649 return runtime->buffer_size - snd_pcm_playback_avail(runtime); 650 } 651 652 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime) 653 { 654 return runtime->buffer_size - snd_pcm_capture_avail(runtime); 655 } 656 657 /** 658 * snd_pcm_playback_ready - check whether the playback buffer is available 659 * @substream: the pcm substream instance 660 * 661 * Checks whether enough free space is available on the playback buffer. 662 * 663 * Return: Non-zero if available, or zero if not. 664 */ 665 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream) 666 { 667 struct snd_pcm_runtime *runtime = substream->runtime; 668 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min; 669 } 670 671 /** 672 * snd_pcm_capture_ready - check whether the capture buffer is available 673 * @substream: the pcm substream instance 674 * 675 * Checks whether enough capture data is available on the capture buffer. 676 * 677 * Return: Non-zero if available, or zero if not. 678 */ 679 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream) 680 { 681 struct snd_pcm_runtime *runtime = substream->runtime; 682 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min; 683 } 684 685 /** 686 * snd_pcm_playback_data - check whether any data exists on the playback buffer 687 * @substream: the pcm substream instance 688 * 689 * Checks whether any data exists on the playback buffer. 690 * 691 * Return: Non-zero if any data exists, or zero if not. If stop_threshold 692 * is bigger or equal to boundary, then this function returns always non-zero. 693 */ 694 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream) 695 { 696 struct snd_pcm_runtime *runtime = substream->runtime; 697 698 if (runtime->stop_threshold >= runtime->boundary) 699 return 1; 700 return snd_pcm_playback_avail(runtime) < runtime->buffer_size; 701 } 702 703 /** 704 * snd_pcm_playback_empty - check whether the playback buffer is empty 705 * @substream: the pcm substream instance 706 * 707 * Checks whether the playback buffer is empty. 708 * 709 * Return: Non-zero if empty, or zero if not. 710 */ 711 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream) 712 { 713 struct snd_pcm_runtime *runtime = substream->runtime; 714 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size; 715 } 716 717 /** 718 * snd_pcm_capture_empty - check whether the capture buffer is empty 719 * @substream: the pcm substream instance 720 * 721 * Checks whether the capture buffer is empty. 722 * 723 * Return: Non-zero if empty, or zero if not. 724 */ 725 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream) 726 { 727 struct snd_pcm_runtime *runtime = substream->runtime; 728 return snd_pcm_capture_avail(runtime) == 0; 729 } 730 731 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream, 732 struct snd_pcm_substream *master) 733 { 734 substream->runtime->trigger_master = master; 735 } 736 737 static inline int hw_is_mask(int var) 738 { 739 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK && 740 var <= SNDRV_PCM_HW_PARAM_LAST_MASK; 741 } 742 743 static inline int hw_is_interval(int var) 744 { 745 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL && 746 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; 747 } 748 749 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params, 750 snd_pcm_hw_param_t var) 751 { 752 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK]; 753 } 754 755 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params, 756 snd_pcm_hw_param_t var) 757 { 758 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL]; 759 } 760 761 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params, 762 snd_pcm_hw_param_t var) 763 { 764 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK]; 765 } 766 767 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params, 768 snd_pcm_hw_param_t var) 769 { 770 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL]; 771 } 772 773 #define params_channels(p) \ 774 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min) 775 #define params_rate(p) \ 776 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min) 777 #define params_period_size(p) \ 778 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min) 779 #define params_periods(p) \ 780 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min) 781 #define params_buffer_size(p) \ 782 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min) 783 #define params_buffer_bytes(p) \ 784 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min) 785 786 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v); 787 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c); 788 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c); 789 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b, 790 unsigned int k, struct snd_interval *c); 791 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k, 792 const struct snd_interval *b, struct snd_interval *c); 793 int snd_interval_list(struct snd_interval *i, unsigned int count, 794 const unsigned int *list, unsigned int mask); 795 int snd_interval_ratnum(struct snd_interval *i, 796 unsigned int rats_count, struct snd_ratnum *rats, 797 unsigned int *nump, unsigned int *denp); 798 799 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params); 800 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var); 801 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params); 802 803 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params); 804 805 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream); 806 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream); 807 808 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var, 809 u_int32_t mask); 810 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var, 811 u_int64_t mask); 812 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var, 813 unsigned int min, unsigned int max); 814 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var); 815 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime, 816 unsigned int cond, 817 snd_pcm_hw_param_t var, 818 const struct snd_pcm_hw_constraint_list *l); 819 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime, 820 unsigned int cond, 821 snd_pcm_hw_param_t var, 822 struct snd_pcm_hw_constraint_ratnums *r); 823 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime, 824 unsigned int cond, 825 snd_pcm_hw_param_t var, 826 struct snd_pcm_hw_constraint_ratdens *r); 827 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime, 828 unsigned int cond, 829 unsigned int width, 830 unsigned int msbits); 831 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime, 832 unsigned int cond, 833 snd_pcm_hw_param_t var, 834 unsigned long step); 835 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime, 836 unsigned int cond, 837 snd_pcm_hw_param_t var); 838 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime, 839 unsigned int base_rate); 840 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime, 841 unsigned int cond, 842 int var, 843 snd_pcm_hw_rule_func_t func, void *private, 844 int dep, ...); 845 846 int snd_pcm_format_signed(snd_pcm_format_t format); 847 int snd_pcm_format_unsigned(snd_pcm_format_t format); 848 int snd_pcm_format_linear(snd_pcm_format_t format); 849 int snd_pcm_format_little_endian(snd_pcm_format_t format); 850 int snd_pcm_format_big_endian(snd_pcm_format_t format); 851 #if 0 /* just for DocBook */ 852 /** 853 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian 854 * @format: the format to check 855 * 856 * Return: 1 if the given PCM format is CPU-endian, 0 if 857 * opposite, or a negative error code if endian not specified. 858 */ 859 int snd_pcm_format_cpu_endian(snd_pcm_format_t format); 860 #endif /* DocBook */ 861 #ifdef SNDRV_LITTLE_ENDIAN 862 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format) 863 #else 864 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format) 865 #endif 866 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */ 867 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */ 868 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples); 869 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format); 870 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames); 871 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsigned, int big_endian); 872 873 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, 874 const struct snd_pcm_ops *ops); 875 void snd_pcm_set_sync(struct snd_pcm_substream *substream); 876 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream); 877 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream, 878 unsigned int cmd, void *arg); 879 int snd_pcm_update_state(struct snd_pcm_substream *substream, 880 struct snd_pcm_runtime *runtime); 881 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream); 882 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream); 883 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream); 884 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream); 885 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream); 886 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr); 887 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream); 888 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream, 889 const void __user *buf, 890 snd_pcm_uframes_t frames); 891 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream, 892 void __user *buf, snd_pcm_uframes_t frames); 893 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream, 894 void __user **bufs, snd_pcm_uframes_t frames); 895 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream, 896 void __user **bufs, snd_pcm_uframes_t frames); 897 898 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates; 899 900 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime); 901 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate); 902 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit); 903 unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a, 904 unsigned int rates_b); 905 906 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream, 907 struct snd_dma_buffer *bufp) 908 { 909 struct snd_pcm_runtime *runtime = substream->runtime; 910 if (bufp) { 911 runtime->dma_buffer_p = bufp; 912 runtime->dma_area = bufp->area; 913 runtime->dma_addr = bufp->addr; 914 runtime->dma_bytes = bufp->bytes; 915 } else { 916 runtime->dma_buffer_p = NULL; 917 runtime->dma_area = NULL; 918 runtime->dma_addr = 0; 919 runtime->dma_bytes = 0; 920 } 921 } 922 923 /* 924 * Timer interface 925 */ 926 927 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream); 928 void snd_pcm_timer_init(struct snd_pcm_substream *substream); 929 void snd_pcm_timer_done(struct snd_pcm_substream *substream); 930 931 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime, 932 struct timespec *tv) 933 { 934 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC) 935 ktime_get_ts(tv); 936 else 937 getnstimeofday(tv); 938 } 939 940 /* 941 * Memory 942 */ 943 944 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream); 945 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm); 946 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream, 947 int type, struct device *data, 948 size_t size, size_t max); 949 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm, 950 int type, void *data, 951 size_t size, size_t max); 952 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size); 953 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream); 954 955 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream, 956 size_t size, gfp_t gfp_flags); 957 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream); 958 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream, 959 unsigned long offset); 960 #if 0 /* for kernel-doc */ 961 /** 962 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer 963 * @substream: the substream to allocate the buffer to 964 * @size: the requested buffer size, in bytes 965 * 966 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is 967 * contiguous in kernel virtual space, but not in physical memory. Use this 968 * if the buffer is accessed by kernel code but not by device DMA. 969 * 970 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error 971 * code. 972 */ 973 static int snd_pcm_lib_alloc_vmalloc_buffer 974 (struct snd_pcm_substream *substream, size_t size); 975 /** 976 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer 977 * @substream: the substream to allocate the buffer to 978 * @size: the requested buffer size, in bytes 979 * 980 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses 981 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory. 982 * 983 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error 984 * code. 985 */ 986 static int snd_pcm_lib_alloc_vmalloc_32_buffer 987 (struct snd_pcm_substream *substream, size_t size); 988 #endif 989 #define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \ 990 _snd_pcm_lib_alloc_vmalloc_buffer \ 991 (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO) 992 #define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \ 993 _snd_pcm_lib_alloc_vmalloc_buffer \ 994 (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO) 995 996 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p) 997 998 #ifdef CONFIG_SND_DMA_SGBUF 999 /* 1000 * SG-buffer handling 1001 */ 1002 #define snd_pcm_substream_sgbuf(substream) \ 1003 snd_pcm_get_dma_buf(substream)->private_data 1004 1005 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, 1006 unsigned long offset); 1007 #else /* !SND_DMA_SGBUF */ 1008 /* 1009 * fake using a continuous buffer 1010 */ 1011 #define snd_pcm_sgbuf_ops_page NULL 1012 #endif /* SND_DMA_SGBUF */ 1013 1014 static inline dma_addr_t 1015 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs) 1016 { 1017 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs); 1018 } 1019 1020 static inline void * 1021 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs) 1022 { 1023 return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs); 1024 } 1025 1026 static inline unsigned int 1027 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream, 1028 unsigned int ofs, unsigned int size) 1029 { 1030 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size); 1031 } 1032 1033 /* handle mmap counter - PCM mmap callback should handle this counter properly */ 1034 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area) 1035 { 1036 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data; 1037 atomic_inc(&substream->mmap_count); 1038 } 1039 1040 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area) 1041 { 1042 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data; 1043 atomic_dec(&substream->mmap_count); 1044 } 1045 1046 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream, 1047 struct vm_area_struct *area); 1048 /* mmap for io-memory area */ 1049 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA) 1050 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP 1051 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area); 1052 #else 1053 #define SNDRV_PCM_INFO_MMAP_IOMEM 0 1054 #define snd_pcm_lib_mmap_iomem NULL 1055 #endif 1056 1057 #define snd_pcm_lib_mmap_vmalloc NULL 1058 1059 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max) 1060 { 1061 *max = dma < 4 ? 64 * 1024 : 128 * 1024; 1062 } 1063 1064 /* 1065 * Misc 1066 */ 1067 1068 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\ 1069 (IEC958_AES1_CON_ORIGINAL<<8)|\ 1070 (IEC958_AES1_CON_PCM_CODER<<8)|\ 1071 (IEC958_AES3_CON_FS_48000<<24)) 1072 1073 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime) 1074 1075 const char *snd_pcm_format_name(snd_pcm_format_t format); 1076 1077 /** 1078 * snd_pcm_stream_str - Get a string naming the direction of a stream 1079 * @substream: the pcm substream instance 1080 * 1081 * Return: A string naming the direction of the stream. 1082 */ 1083 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream) 1084 { 1085 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) 1086 return "Playback"; 1087 else 1088 return "Capture"; 1089 } 1090 1091 /* 1092 * PCM channel-mapping control API 1093 */ 1094 /* array element of channel maps */ 1095 struct snd_pcm_chmap_elem { 1096 unsigned char channels; 1097 unsigned char map[15]; 1098 }; 1099 1100 /* channel map information; retrieved via snd_kcontrol_chip() */ 1101 struct snd_pcm_chmap { 1102 struct snd_pcm *pcm; /* assigned PCM instance */ 1103 int stream; /* PLAYBACK or CAPTURE */ 1104 struct snd_kcontrol *kctl; 1105 const struct snd_pcm_chmap_elem *chmap; 1106 unsigned int max_channels; 1107 unsigned int channel_mask; /* optional: active channels bitmask */ 1108 void *private_data; /* optional: private data pointer */ 1109 }; 1110 1111 /* get the PCM substream assigned to the given chmap info */ 1112 static inline struct snd_pcm_substream * 1113 snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx) 1114 { 1115 struct snd_pcm_substream *s; 1116 for (s = info->pcm->streams[info->stream].substream; s; s = s->next) 1117 if (s->number == idx) 1118 return s; 1119 return NULL; 1120 } 1121 1122 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */ 1123 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[]; 1124 /* Other world's standard channel maps (C/LFE prior to RL/RR) */ 1125 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[]; 1126 1127 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */ 1128 #define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4)) 1129 #define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6)) 1130 #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8)) 1131 1132 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream, 1133 const struct snd_pcm_chmap_elem *chmap, 1134 int max_channels, 1135 unsigned long private_value, 1136 struct snd_pcm_chmap **info_ret); 1137 1138 /* Strong-typed conversion of pcm_format to bitwise */ 1139 static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format) 1140 { 1141 return 1ULL << (__force int) pcm_format; 1142 } 1143 1144 /* printk helpers */ 1145 #define pcm_err(pcm, fmt, args...) \ 1146 dev_err((pcm)->card->dev, fmt, ##args) 1147 #define pcm_warn(pcm, fmt, args...) \ 1148 dev_warn((pcm)->card->dev, fmt, ##args) 1149 #define pcm_dbg(pcm, fmt, args...) \ 1150 dev_dbg((pcm)->card->dev, fmt, ##args) 1151 1152 #endif /* __SOUND_PCM_H */ 1153