5 * Digital Audio (PCM) abstract layer
6 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
7 * Abramo Bagnara <abramo@alsa-project.org>
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.
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.
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
26 #include <sound/asound.h>
27 #include <sound/memalloc.h>
28 #include <sound/minors.h>
29 #include <linux/poll.h>
31 #include <linux/bitops.h>
33 #define snd_pcm_substream_chip(substream) ((substream)->private_data)
34 #define snd_pcm_chip(pcm) ((pcm)->private_data)
36 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
41 * Hardware (lowlevel) section
44 struct snd_pcm_hardware
{
45 unsigned int info
; /* SNDRV_PCM_INFO_* */
46 u64 formats
; /* SNDRV_PCM_FMTBIT_* */
47 unsigned int rates
; /* SNDRV_PCM_RATE_* */
48 unsigned int rate_min
; /* min rate */
49 unsigned int rate_max
; /* max rate */
50 unsigned int channels_min
; /* min channels */
51 unsigned int channels_max
; /* max channels */
52 size_t buffer_bytes_max
; /* max buffer size */
53 size_t period_bytes_min
; /* min period size */
54 size_t period_bytes_max
; /* max period size */
55 unsigned int periods_min
; /* min # of periods */
56 unsigned int periods_max
; /* max # of periods */
57 size_t fifo_size
; /* fifo size in bytes */
60 struct snd_pcm_substream
;
63 int (*open
)(struct snd_pcm_substream
*substream
);
64 int (*close
)(struct snd_pcm_substream
*substream
);
65 int (*ioctl
)(struct snd_pcm_substream
* substream
,
66 unsigned int cmd
, void *arg
);
67 int (*hw_params
)(struct snd_pcm_substream
*substream
,
68 struct snd_pcm_hw_params
*params
);
69 int (*hw_free
)(struct snd_pcm_substream
*substream
);
70 int (*prepare
)(struct snd_pcm_substream
*substream
);
71 int (*trigger
)(struct snd_pcm_substream
*substream
, int cmd
);
72 snd_pcm_uframes_t (*pointer
)(struct snd_pcm_substream
*substream
);
73 int (*copy
)(struct snd_pcm_substream
*substream
, int channel
,
74 snd_pcm_uframes_t pos
,
75 void __user
*buf
, snd_pcm_uframes_t count
);
76 int (*silence
)(struct snd_pcm_substream
*substream
, int channel
,
77 snd_pcm_uframes_t pos
, snd_pcm_uframes_t count
);
78 struct page
*(*page
)(struct snd_pcm_substream
*substream
,
79 unsigned long offset
);
80 int (*mmap
)(struct snd_pcm_substream
*substream
, struct vm_area_struct
*vma
);
81 int (*ack
)(struct snd_pcm_substream
*substream
);
88 #if defined(CONFIG_SND_DYNAMIC_MINORS)
89 #define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
91 #define SNDRV_PCM_DEVICES 8
94 #define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
95 #define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
97 #define SNDRV_PCM_IOCTL1_RESET 0
98 #define SNDRV_PCM_IOCTL1_INFO 1
99 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
100 #define SNDRV_PCM_IOCTL1_GSTATE 3
102 #define SNDRV_PCM_TRIGGER_STOP 0
103 #define SNDRV_PCM_TRIGGER_START 1
104 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
105 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
106 #define SNDRV_PCM_TRIGGER_SUSPEND 5
107 #define SNDRV_PCM_TRIGGER_RESUME 6
109 #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
111 /* If you change this don't forget to change rates[] table in pcm_native.c */
112 #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
113 #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
114 #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
115 #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
116 #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
117 #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
118 #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
119 #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
120 #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
121 #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
122 #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
123 #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
124 #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
126 #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
127 #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
129 #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
130 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
131 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
132 #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
133 #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
134 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
135 #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
136 SNDRV_PCM_RATE_192000)
137 #define SNDRV_PCM_FMTBIT_S8 (1ULL << SNDRV_PCM_FORMAT_S8)
138 #define SNDRV_PCM_FMTBIT_U8 (1ULL << SNDRV_PCM_FORMAT_U8)
139 #define SNDRV_PCM_FMTBIT_S16_LE (1ULL << SNDRV_PCM_FORMAT_S16_LE)
140 #define SNDRV_PCM_FMTBIT_S16_BE (1ULL << SNDRV_PCM_FORMAT_S16_BE)
141 #define SNDRV_PCM_FMTBIT_U16_LE (1ULL << SNDRV_PCM_FORMAT_U16_LE)
142 #define SNDRV_PCM_FMTBIT_U16_BE (1ULL << SNDRV_PCM_FORMAT_U16_BE)
143 #define SNDRV_PCM_FMTBIT_S24_LE (1ULL << SNDRV_PCM_FORMAT_S24_LE)
144 #define SNDRV_PCM_FMTBIT_S24_BE (1ULL << SNDRV_PCM_FORMAT_S24_BE)
145 #define SNDRV_PCM_FMTBIT_U24_LE (1ULL << SNDRV_PCM_FORMAT_U24_LE)
146 #define SNDRV_PCM_FMTBIT_U24_BE (1ULL << SNDRV_PCM_FORMAT_U24_BE)
147 #define SNDRV_PCM_FMTBIT_S32_LE (1ULL << SNDRV_PCM_FORMAT_S32_LE)
148 #define SNDRV_PCM_FMTBIT_S32_BE (1ULL << SNDRV_PCM_FORMAT_S32_BE)
149 #define SNDRV_PCM_FMTBIT_U32_LE (1ULL << SNDRV_PCM_FORMAT_U32_LE)
150 #define SNDRV_PCM_FMTBIT_U32_BE (1ULL << SNDRV_PCM_FORMAT_U32_BE)
151 #define SNDRV_PCM_FMTBIT_FLOAT_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
152 #define SNDRV_PCM_FMTBIT_FLOAT_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
153 #define SNDRV_PCM_FMTBIT_FLOAT64_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
154 #define SNDRV_PCM_FMTBIT_FLOAT64_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
155 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
156 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
157 #define SNDRV_PCM_FMTBIT_MU_LAW (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
158 #define SNDRV_PCM_FMTBIT_A_LAW (1ULL << SNDRV_PCM_FORMAT_A_LAW)
159 #define SNDRV_PCM_FMTBIT_IMA_ADPCM (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
160 #define SNDRV_PCM_FMTBIT_MPEG (1ULL << SNDRV_PCM_FORMAT_MPEG)
161 #define SNDRV_PCM_FMTBIT_GSM (1ULL << SNDRV_PCM_FORMAT_GSM)
162 #define SNDRV_PCM_FMTBIT_SPECIAL (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
163 #define SNDRV_PCM_FMTBIT_S24_3LE (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
164 #define SNDRV_PCM_FMTBIT_U24_3LE (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
165 #define SNDRV_PCM_FMTBIT_S24_3BE (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
166 #define SNDRV_PCM_FMTBIT_U24_3BE (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
167 #define SNDRV_PCM_FMTBIT_S20_3LE (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
168 #define SNDRV_PCM_FMTBIT_U20_3LE (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
169 #define SNDRV_PCM_FMTBIT_S20_3BE (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
170 #define SNDRV_PCM_FMTBIT_U20_3BE (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
171 #define SNDRV_PCM_FMTBIT_S18_3LE (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
172 #define SNDRV_PCM_FMTBIT_U18_3LE (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
173 #define SNDRV_PCM_FMTBIT_S18_3BE (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
174 #define SNDRV_PCM_FMTBIT_U18_3BE (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
176 #ifdef SNDRV_LITTLE_ENDIAN
177 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
178 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
179 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
180 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
181 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
182 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
183 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
184 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
185 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
187 #ifdef SNDRV_BIG_ENDIAN
188 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
189 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
190 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
191 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
192 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
193 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
194 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
195 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
196 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
199 struct snd_pcm_file
{
200 struct snd_pcm_substream
*substream
;
204 struct snd_pcm_hw_rule
;
205 typedef int (*snd_pcm_hw_rule_func_t
)(struct snd_pcm_hw_params
*params
,
206 struct snd_pcm_hw_rule
*rule
);
208 struct snd_pcm_hw_rule
{
210 snd_pcm_hw_rule_func_t func
;
216 struct snd_pcm_hw_constraints
{
217 struct snd_mask masks
[SNDRV_PCM_HW_PARAM_LAST_MASK
-
218 SNDRV_PCM_HW_PARAM_FIRST_MASK
+ 1];
219 struct snd_interval intervals
[SNDRV_PCM_HW_PARAM_LAST_INTERVAL
-
220 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
+ 1];
221 unsigned int rules_num
;
222 unsigned int rules_all
;
223 struct snd_pcm_hw_rule
*rules
;
226 static inline struct snd_mask
*constrs_mask(struct snd_pcm_hw_constraints
*constrs
,
227 snd_pcm_hw_param_t var
)
229 return &constrs
->masks
[var
- SNDRV_PCM_HW_PARAM_FIRST_MASK
];
232 static inline struct snd_interval
*constrs_interval(struct snd_pcm_hw_constraints
*constrs
,
233 snd_pcm_hw_param_t var
)
235 return &constrs
->intervals
[var
- SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
];
240 unsigned int den_min
, den_max
, den_step
;
244 unsigned int num_min
, num_max
, num_step
;
248 struct snd_pcm_hw_constraint_ratnums
{
250 struct snd_ratnum
*rats
;
253 struct snd_pcm_hw_constraint_ratdens
{
255 struct snd_ratden
*rats
;
258 struct snd_pcm_hw_constraint_list
{
264 struct snd_pcm_runtime
{
266 struct snd_pcm_substream
*trigger_master
;
267 struct timespec trigger_tstamp
; /* trigger timestamp */
269 snd_pcm_uframes_t avail_max
;
270 snd_pcm_uframes_t hw_ptr_base
; /* Position at buffer restart */
271 snd_pcm_uframes_t hw_ptr_interrupt
; /* Position at interrupt time */
272 unsigned long hw_ptr_jiffies
; /* Time when hw_ptr is updated */
274 /* -- HW params -- */
275 snd_pcm_access_t access
; /* access mode */
276 snd_pcm_format_t format
; /* SNDRV_PCM_FORMAT_* */
277 snd_pcm_subformat_t subformat
; /* subformat */
278 unsigned int rate
; /* rate in Hz */
279 unsigned int channels
; /* channels */
280 snd_pcm_uframes_t period_size
; /* period size */
281 unsigned int periods
; /* periods */
282 snd_pcm_uframes_t buffer_size
; /* buffer size */
283 snd_pcm_uframes_t min_align
; /* Min alignment for the format */
285 unsigned int frame_bits
;
286 unsigned int sample_bits
;
288 unsigned int rate_num
;
289 unsigned int rate_den
;
291 /* -- SW params -- */
292 int tstamp_mode
; /* mmap timestamp is updated */
293 unsigned int period_step
;
294 snd_pcm_uframes_t start_threshold
;
295 snd_pcm_uframes_t stop_threshold
;
296 snd_pcm_uframes_t silence_threshold
; /* Silence filling happens when
297 noise is nearest than this */
298 snd_pcm_uframes_t silence_size
; /* Silence filling size */
299 snd_pcm_uframes_t boundary
; /* pointers wrap point */
301 snd_pcm_uframes_t silence_start
; /* starting pointer to silence area */
302 snd_pcm_uframes_t silence_filled
; /* size filled with silence */
304 union snd_pcm_sync_id sync
; /* hardware synchronization ID */
307 struct snd_pcm_mmap_status
*status
;
308 struct snd_pcm_mmap_control
*control
;
310 /* -- locking / scheduling -- */
311 wait_queue_head_t sleep
;
312 struct fasync_struct
*fasync
;
314 /* -- private section -- */
316 void (*private_free
)(struct snd_pcm_runtime
*runtime
);
318 /* -- hardware description -- */
319 struct snd_pcm_hardware hw
;
320 struct snd_pcm_hw_constraints hw_constraints
;
322 /* -- interrupt callbacks -- */
323 void (*transfer_ack_begin
)(struct snd_pcm_substream
*substream
);
324 void (*transfer_ack_end
)(struct snd_pcm_substream
*substream
);
327 unsigned int timer_resolution
; /* timer resolution */
328 int tstamp_type
; /* timestamp type */
331 unsigned char *dma_area
; /* DMA area */
332 dma_addr_t dma_addr
; /* physical bus address (not accessible from main CPU) */
333 size_t dma_bytes
; /* size of DMA area */
335 struct snd_dma_buffer
*dma_buffer_p
; /* allocated buffer */
337 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
338 /* -- OSS things -- */
339 struct snd_pcm_oss_runtime oss
;
343 struct snd_pcm_group
{ /* keep linked substreams */
345 struct list_head substreams
;
349 struct snd_pcm_substream
{
351 struct snd_pcm_str
*pstr
;
352 void *private_data
; /* copied from pcm->private_data */
354 char name
[32]; /* substream name */
355 int stream
; /* stream (direction) */
356 char latency_id
[20]; /* latency identifier */
357 size_t buffer_bytes_max
; /* limit ring buffer size */
358 struct snd_dma_buffer dma_buffer
;
359 unsigned int dma_buf_id
;
361 /* -- hardware operations -- */
362 struct snd_pcm_ops
*ops
;
363 /* -- runtime information -- */
364 struct snd_pcm_runtime
*runtime
;
365 /* -- timer section -- */
366 struct snd_timer
*timer
; /* timer */
367 unsigned timer_running
: 1; /* time is running */
368 /* -- next substream -- */
369 struct snd_pcm_substream
*next
;
370 /* -- linked substreams -- */
371 struct list_head link_list
; /* linked list member */
372 struct snd_pcm_group self_group
; /* fake group for non linked substream (with substream lock inside) */
373 struct snd_pcm_group
*group
; /* pointer to current group */
374 /* -- assigned files -- */
378 unsigned int f_flags
;
379 void (*pcm_release
)(struct snd_pcm_substream
*);
380 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
381 /* -- OSS things -- */
382 struct snd_pcm_oss_substream oss
;
384 #ifdef CONFIG_SND_VERBOSE_PROCFS
385 struct snd_info_entry
*proc_root
;
386 struct snd_info_entry
*proc_info_entry
;
387 struct snd_info_entry
*proc_hw_params_entry
;
388 struct snd_info_entry
*proc_sw_params_entry
;
389 struct snd_info_entry
*proc_status_entry
;
390 struct snd_info_entry
*proc_prealloc_entry
;
391 struct snd_info_entry
*proc_prealloc_max_entry
;
394 unsigned int hw_opened
: 1;
397 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
401 int stream
; /* stream (direction) */
403 /* -- substreams -- */
404 unsigned int substream_count
;
405 unsigned int substream_opened
;
406 struct snd_pcm_substream
*substream
;
407 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
408 /* -- OSS things -- */
409 struct snd_pcm_oss_stream oss
;
411 #ifdef CONFIG_SND_VERBOSE_PROCFS
412 struct snd_info_entry
*proc_root
;
413 struct snd_info_entry
*proc_info_entry
;
414 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
415 unsigned int xrun_debug
; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
416 struct snd_info_entry
*proc_xrun_debug_entry
;
422 struct snd_card
*card
;
423 struct list_head list
;
424 int device
; /* device number */
425 unsigned int info_flags
;
426 unsigned short dev_class
;
427 unsigned short dev_subclass
;
430 struct snd_pcm_str streams
[2];
431 struct mutex open_mutex
;
432 wait_queue_head_t open_wait
;
434 void (*private_free
) (struct snd_pcm
*pcm
);
435 struct device
*dev
; /* actual hw device this belongs to */
436 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
437 struct snd_pcm_oss oss
;
441 struct snd_pcm_notify
{
442 int (*n_register
) (struct snd_pcm
* pcm
);
443 int (*n_disconnect
) (struct snd_pcm
* pcm
);
444 int (*n_unregister
) (struct snd_pcm
* pcm
);
445 struct list_head list
;
452 extern const struct file_operations snd_pcm_f_ops
[2];
454 int snd_pcm_new(struct snd_card
*card
, const char *id
, int device
,
455 int playback_count
, int capture_count
,
456 struct snd_pcm
**rpcm
);
457 int snd_pcm_new_stream(struct snd_pcm
*pcm
, int stream
, int substream_count
);
459 int snd_pcm_notify(struct snd_pcm_notify
*notify
, int nfree
);
465 extern rwlock_t snd_pcm_link_rwlock
;
467 int snd_pcm_info(struct snd_pcm_substream
*substream
, struct snd_pcm_info
*info
);
468 int snd_pcm_info_user(struct snd_pcm_substream
*substream
,
469 struct snd_pcm_info __user
*info
);
470 int snd_pcm_status(struct snd_pcm_substream
*substream
,
471 struct snd_pcm_status
*status
);
472 int snd_pcm_start(struct snd_pcm_substream
*substream
);
473 int snd_pcm_stop(struct snd_pcm_substream
*substream
, int status
);
474 int snd_pcm_drain_done(struct snd_pcm_substream
*substream
);
476 int snd_pcm_suspend(struct snd_pcm_substream
*substream
);
477 int snd_pcm_suspend_all(struct snd_pcm
*pcm
);
479 int snd_pcm_kernel_ioctl(struct snd_pcm_substream
*substream
, unsigned int cmd
, void *arg
);
480 int snd_pcm_open_substream(struct snd_pcm
*pcm
, int stream
, struct file
*file
,
481 struct snd_pcm_substream
**rsubstream
);
482 void snd_pcm_release_substream(struct snd_pcm_substream
*substream
);
483 int snd_pcm_attach_substream(struct snd_pcm
*pcm
, int stream
, struct file
*file
,
484 struct snd_pcm_substream
**rsubstream
);
485 void snd_pcm_detach_substream(struct snd_pcm_substream
*substream
);
486 void snd_pcm_vma_notify_data(void *client
, void *data
);
487 int snd_pcm_mmap_data(struct snd_pcm_substream
*substream
, struct file
*file
, struct vm_area_struct
*area
);
489 #if BITS_PER_LONG >= 64
491 static inline void div64_32(u_int64_t
*n
, u_int32_t div
, u_int32_t
*rem
)
499 static inline void div64_32(u_int64_t
*n
, u_int32_t div
, u_int32_t
*rem
)
502 low
= *n
& 0xffffffff;
505 u_int32_t high1
= high
% div
;
507 asm("divl %2":"=a" (low
), "=d" (*rem
):"rm" (div
), "a" (low
), "d" (high1
));
508 *n
= (u_int64_t
)high
<< 32 | low
;
516 static inline void divl(u_int32_t high
, u_int32_t low
,
518 u_int32_t
*q
, u_int32_t
*r
)
520 u_int64_t n
= (u_int64_t
)high
<< 32 | low
;
521 u_int64_t d
= (u_int64_t
)div
<< 31;
524 while (n
> 0xffffffffU
) {
536 *q
= q1
| (low
/ div
);
545 static inline void div64_32(u_int64_t
*n
, u_int32_t div
, u_int32_t
*rem
)
548 low
= *n
& 0xffffffff;
551 u_int32_t high1
= high
% div
;
552 u_int32_t low1
= low
;
554 divl(high1
, low1
, div
, &low
, rem
);
555 *n
= (u_int64_t
)high
<< 32 | low
;
567 static inline int snd_pcm_stream_linked(struct snd_pcm_substream
*substream
)
569 return substream
->group
!= &substream
->self_group
;
572 static inline void snd_pcm_stream_lock(struct snd_pcm_substream
*substream
)
574 read_lock(&snd_pcm_link_rwlock
);
575 spin_lock(&substream
->self_group
.lock
);
578 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream
*substream
)
580 spin_unlock(&substream
->self_group
.lock
);
581 read_unlock(&snd_pcm_link_rwlock
);
584 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream
*substream
)
586 read_lock_irq(&snd_pcm_link_rwlock
);
587 spin_lock(&substream
->self_group
.lock
);
590 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream
*substream
)
592 spin_unlock(&substream
->self_group
.lock
);
593 read_unlock_irq(&snd_pcm_link_rwlock
);
596 #define snd_pcm_stream_lock_irqsave(substream, flags) \
598 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
599 spin_lock(&substream->self_group.lock); \
602 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
604 spin_unlock(&substream->self_group.lock); \
605 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
608 #define snd_pcm_group_for_each_entry(s, substream) \
609 list_for_each_entry(s, &substream->group->substreams, link_list)
611 static inline int snd_pcm_running(struct snd_pcm_substream
*substream
)
613 return (substream
->runtime
->status
->state
== SNDRV_PCM_STATE_RUNNING
||
614 (substream
->runtime
->status
->state
== SNDRV_PCM_STATE_DRAINING
&&
615 substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
));
618 static inline ssize_t
bytes_to_samples(struct snd_pcm_runtime
*runtime
, ssize_t size
)
620 return size
* 8 / runtime
->sample_bits
;
623 static inline snd_pcm_sframes_t
bytes_to_frames(struct snd_pcm_runtime
*runtime
, ssize_t size
)
625 return size
* 8 / runtime
->frame_bits
;
628 static inline ssize_t
samples_to_bytes(struct snd_pcm_runtime
*runtime
, ssize_t size
)
630 return size
* runtime
->sample_bits
/ 8;
633 static inline ssize_t
frames_to_bytes(struct snd_pcm_runtime
*runtime
, snd_pcm_sframes_t size
)
635 return size
* runtime
->frame_bits
/ 8;
638 static inline int frame_aligned(struct snd_pcm_runtime
*runtime
, ssize_t bytes
)
640 return bytes
% runtime
->byte_align
== 0;
643 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream
*substream
)
645 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
646 return frames_to_bytes(runtime
, runtime
->buffer_size
);
649 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream
*substream
)
651 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
652 return frames_to_bytes(runtime
, runtime
->period_size
);
656 * result is: 0 ... (boundary - 1)
658 static inline snd_pcm_uframes_t
snd_pcm_playback_avail(struct snd_pcm_runtime
*runtime
)
660 snd_pcm_sframes_t avail
= runtime
->status
->hw_ptr
+ runtime
->buffer_size
- runtime
->control
->appl_ptr
;
662 avail
+= runtime
->boundary
;
663 else if ((snd_pcm_uframes_t
) avail
>= runtime
->boundary
)
664 avail
-= runtime
->boundary
;
669 * result is: 0 ... (boundary - 1)
671 static inline snd_pcm_uframes_t
snd_pcm_capture_avail(struct snd_pcm_runtime
*runtime
)
673 snd_pcm_sframes_t avail
= runtime
->status
->hw_ptr
- runtime
->control
->appl_ptr
;
675 avail
+= runtime
->boundary
;
679 static inline snd_pcm_sframes_t
snd_pcm_playback_hw_avail(struct snd_pcm_runtime
*runtime
)
681 return runtime
->buffer_size
- snd_pcm_playback_avail(runtime
);
684 static inline snd_pcm_sframes_t
snd_pcm_capture_hw_avail(struct snd_pcm_runtime
*runtime
)
686 return runtime
->buffer_size
- snd_pcm_capture_avail(runtime
);
690 * snd_pcm_playback_ready - check whether the playback buffer is available
691 * @substream: the pcm substream instance
693 * Checks whether enough free space is available on the playback buffer.
695 * Returns non-zero if available, or zero if not.
697 static inline int snd_pcm_playback_ready(struct snd_pcm_substream
*substream
)
699 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
700 return snd_pcm_playback_avail(runtime
) >= runtime
->control
->avail_min
;
704 * snd_pcm_capture_ready - check whether the capture buffer is available
705 * @substream: the pcm substream instance
707 * Checks whether enough capture data is available on the capture buffer.
709 * Returns non-zero if available, or zero if not.
711 static inline int snd_pcm_capture_ready(struct snd_pcm_substream
*substream
)
713 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
714 return snd_pcm_capture_avail(runtime
) >= runtime
->control
->avail_min
;
718 * snd_pcm_playback_data - check whether any data exists on the playback buffer
719 * @substream: the pcm substream instance
721 * Checks whether any data exists on the playback buffer. If stop_threshold
722 * is bigger or equal to boundary, then this function returns always non-zero.
724 * Returns non-zero if exists, or zero if not.
726 static inline int snd_pcm_playback_data(struct snd_pcm_substream
*substream
)
728 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
730 if (runtime
->stop_threshold
>= runtime
->boundary
)
732 return snd_pcm_playback_avail(runtime
) < runtime
->buffer_size
;
736 * snd_pcm_playback_empty - check whether the playback buffer is empty
737 * @substream: the pcm substream instance
739 * Checks whether the playback buffer is empty.
741 * Returns non-zero if empty, or zero if not.
743 static inline int snd_pcm_playback_empty(struct snd_pcm_substream
*substream
)
745 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
746 return snd_pcm_playback_avail(runtime
) >= runtime
->buffer_size
;
750 * snd_pcm_capture_empty - check whether the capture buffer is empty
751 * @substream: the pcm substream instance
753 * Checks whether the capture buffer is empty.
755 * Returns non-zero if empty, or zero if not.
757 static inline int snd_pcm_capture_empty(struct snd_pcm_substream
*substream
)
759 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
760 return snd_pcm_capture_avail(runtime
) == 0;
763 static inline void snd_pcm_trigger_done(struct snd_pcm_substream
*substream
,
764 struct snd_pcm_substream
*master
)
766 substream
->runtime
->trigger_master
= master
;
769 static inline int hw_is_mask(int var
)
771 return var
>= SNDRV_PCM_HW_PARAM_FIRST_MASK
&&
772 var
<= SNDRV_PCM_HW_PARAM_LAST_MASK
;
775 static inline int hw_is_interval(int var
)
777 return var
>= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
&&
778 var
<= SNDRV_PCM_HW_PARAM_LAST_INTERVAL
;
781 static inline struct snd_mask
*hw_param_mask(struct snd_pcm_hw_params
*params
,
782 snd_pcm_hw_param_t var
)
784 return ¶ms
->masks
[var
- SNDRV_PCM_HW_PARAM_FIRST_MASK
];
787 static inline struct snd_interval
*hw_param_interval(struct snd_pcm_hw_params
*params
,
788 snd_pcm_hw_param_t var
)
790 return ¶ms
->intervals
[var
- SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
];
793 static inline const struct snd_mask
*hw_param_mask_c(const struct snd_pcm_hw_params
*params
,
794 snd_pcm_hw_param_t var
)
796 return ¶ms
->masks
[var
- SNDRV_PCM_HW_PARAM_FIRST_MASK
];
799 static inline const struct snd_interval
*hw_param_interval_c(const struct snd_pcm_hw_params
*params
,
800 snd_pcm_hw_param_t var
)
802 return ¶ms
->intervals
[var
- SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
];
805 #define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
806 #define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
807 #define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
808 #define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
809 #define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
810 #define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
811 #define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
812 #define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
813 #define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
814 #define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
817 int snd_interval_refine(struct snd_interval
*i
, const struct snd_interval
*v
);
818 void snd_interval_mul(const struct snd_interval
*a
, const struct snd_interval
*b
, struct snd_interval
*c
);
819 void snd_interval_div(const struct snd_interval
*a
, const struct snd_interval
*b
, struct snd_interval
*c
);
820 void snd_interval_muldivk(const struct snd_interval
*a
, const struct snd_interval
*b
,
821 unsigned int k
, struct snd_interval
*c
);
822 void snd_interval_mulkdiv(const struct snd_interval
*a
, unsigned int k
,
823 const struct snd_interval
*b
, struct snd_interval
*c
);
824 int snd_interval_list(struct snd_interval
*i
, unsigned int count
, unsigned int *list
, unsigned int mask
);
825 int snd_interval_ratnum(struct snd_interval
*i
,
826 unsigned int rats_count
, struct snd_ratnum
*rats
,
827 unsigned int *nump
, unsigned int *denp
);
829 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params
*params
);
830 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params
*params
, snd_pcm_hw_param_t var
);
831 int snd_pcm_hw_params_choose(struct snd_pcm_substream
*substream
, struct snd_pcm_hw_params
*params
);
833 int snd_pcm_hw_refine(struct snd_pcm_substream
*substream
, struct snd_pcm_hw_params
*params
);
835 int snd_pcm_hw_constraints_init(struct snd_pcm_substream
*substream
);
836 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream
*substream
);
838 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime
*runtime
, snd_pcm_hw_param_t var
,
840 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime
*runtime
, snd_pcm_hw_param_t var
,
842 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime
*runtime
, snd_pcm_hw_param_t var
,
843 unsigned int min
, unsigned int max
);
844 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime
*runtime
, snd_pcm_hw_param_t var
);
845 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime
*runtime
,
847 snd_pcm_hw_param_t var
,
848 struct snd_pcm_hw_constraint_list
*l
);
849 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime
*runtime
,
851 snd_pcm_hw_param_t var
,
852 struct snd_pcm_hw_constraint_ratnums
*r
);
853 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime
*runtime
,
855 snd_pcm_hw_param_t var
,
856 struct snd_pcm_hw_constraint_ratdens
*r
);
857 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime
*runtime
,
860 unsigned int msbits
);
861 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime
*runtime
,
863 snd_pcm_hw_param_t var
,
865 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime
*runtime
,
867 snd_pcm_hw_param_t var
);
868 int snd_pcm_hw_rule_add(struct snd_pcm_runtime
*runtime
,
871 snd_pcm_hw_rule_func_t func
, void *private,
874 int snd_pcm_format_signed(snd_pcm_format_t format
);
875 int snd_pcm_format_unsigned(snd_pcm_format_t format
);
876 int snd_pcm_format_linear(snd_pcm_format_t format
);
877 int snd_pcm_format_little_endian(snd_pcm_format_t format
);
878 int snd_pcm_format_big_endian(snd_pcm_format_t format
);
879 #if 0 /* just for DocBook */
881 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
882 * @format: the format to check
884 * Returns 1 if the given PCM format is CPU-endian, 0 if
885 * opposite, or a negative error code if endian not specified.
887 int snd_pcm_format_cpu_endian(snd_pcm_format_t format
);
889 #ifdef SNDRV_LITTLE_ENDIAN
890 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
892 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
894 int snd_pcm_format_width(snd_pcm_format_t format
); /* in bits */
895 int snd_pcm_format_physical_width(snd_pcm_format_t format
); /* in bits */
896 ssize_t
snd_pcm_format_size(snd_pcm_format_t format
, size_t samples
);
897 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format
);
898 int snd_pcm_format_set_silence(snd_pcm_format_t format
, void *buf
, unsigned int frames
);
899 snd_pcm_format_t
snd_pcm_build_linear_format(int width
, int unsignd
, int big_endian
);
901 void snd_pcm_set_ops(struct snd_pcm
* pcm
, int direction
, struct snd_pcm_ops
*ops
);
902 void snd_pcm_set_sync(struct snd_pcm_substream
*substream
);
903 int snd_pcm_lib_interleave_len(struct snd_pcm_substream
*substream
);
904 int snd_pcm_lib_ioctl(struct snd_pcm_substream
*substream
,
905 unsigned int cmd
, void *arg
);
906 int snd_pcm_update_hw_ptr(struct snd_pcm_substream
*substream
);
907 int snd_pcm_playback_xrun_check(struct snd_pcm_substream
*substream
);
908 int snd_pcm_capture_xrun_check(struct snd_pcm_substream
*substream
);
909 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream
*substream
);
910 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream
*substream
);
911 void snd_pcm_playback_silence(struct snd_pcm_substream
*substream
, snd_pcm_uframes_t new_hw_ptr
);
912 void snd_pcm_period_elapsed(struct snd_pcm_substream
*substream
);
913 snd_pcm_sframes_t
snd_pcm_lib_write(struct snd_pcm_substream
*substream
,
914 const void __user
*buf
,
915 snd_pcm_uframes_t frames
);
916 snd_pcm_sframes_t
snd_pcm_lib_read(struct snd_pcm_substream
*substream
,
917 void __user
*buf
, snd_pcm_uframes_t frames
);
918 snd_pcm_sframes_t
snd_pcm_lib_writev(struct snd_pcm_substream
*substream
,
919 void __user
**bufs
, snd_pcm_uframes_t frames
);
920 snd_pcm_sframes_t
snd_pcm_lib_readv(struct snd_pcm_substream
*substream
,
921 void __user
**bufs
, snd_pcm_uframes_t frames
);
923 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates
;
925 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime
*runtime
);
926 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate
);
928 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream
*substream
,
929 struct snd_dma_buffer
*bufp
)
931 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
933 runtime
->dma_buffer_p
= bufp
;
934 runtime
->dma_area
= bufp
->area
;
935 runtime
->dma_addr
= bufp
->addr
;
936 runtime
->dma_bytes
= bufp
->bytes
;
938 runtime
->dma_buffer_p
= NULL
;
939 runtime
->dma_area
= NULL
;
940 runtime
->dma_addr
= 0;
941 runtime
->dma_bytes
= 0;
949 void snd_pcm_timer_resolution_change(struct snd_pcm_substream
*substream
);
950 void snd_pcm_timer_init(struct snd_pcm_substream
*substream
);
951 void snd_pcm_timer_done(struct snd_pcm_substream
*substream
);
953 static inline void snd_pcm_gettime(struct snd_pcm_runtime
*runtime
,
956 if (runtime
->tstamp_type
== SNDRV_PCM_TSTAMP_TYPE_MONOTONIC
)
957 do_posix_clock_monotonic_gettime(tv
);
966 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream
*substream
);
967 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm
*pcm
);
968 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream
*substream
,
969 int type
, struct device
*data
,
970 size_t size
, size_t max
);
971 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm
*pcm
,
972 int type
, void *data
,
973 size_t size
, size_t max
);
974 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream
*substream
, size_t size
);
975 int snd_pcm_lib_free_pages(struct snd_pcm_substream
*substream
);
980 #define snd_pcm_substream_sgbuf(substream) \
981 ((substream)->runtime->dma_buffer_p->private_data)
983 static inline dma_addr_t
984 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream
*substream
, unsigned int ofs
)
986 struct snd_sg_buf
*sg
= snd_pcm_substream_sgbuf(substream
);
987 return snd_sgbuf_get_addr(sg
, ofs
);
991 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream
*substream
, unsigned int ofs
)
993 struct snd_sg_buf
*sg
= snd_pcm_substream_sgbuf(substream
);
994 return snd_sgbuf_get_ptr(sg
, ofs
);
997 struct page
*snd_pcm_sgbuf_ops_page(struct snd_pcm_substream
*substream
,
998 unsigned long offset
);
999 unsigned int snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream
*substream
,
1000 unsigned int ofs
, unsigned int size
);
1002 /* handle mmap counter - PCM mmap callback should handle this counter properly */
1003 static inline void snd_pcm_mmap_data_open(struct vm_area_struct
*area
)
1005 struct snd_pcm_substream
*substream
= (struct snd_pcm_substream
*)area
->vm_private_data
;
1006 atomic_inc(&substream
->mmap_count
);
1009 static inline void snd_pcm_mmap_data_close(struct vm_area_struct
*area
)
1011 struct snd_pcm_substream
*substream
= (struct snd_pcm_substream
*)area
->vm_private_data
;
1012 atomic_dec(&substream
->mmap_count
);
1015 /* mmap for io-memory area */
1016 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1017 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
1018 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream
*substream
, struct vm_area_struct
*area
);
1020 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
1021 #define snd_pcm_lib_mmap_iomem NULL
1024 static inline void snd_pcm_limit_isa_dma_size(int dma
, size_t *max
)
1026 *max
= dma
< 4 ? 64 * 1024 : 128 * 1024;
1033 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1034 (IEC958_AES1_CON_ORIGINAL<<8)|\
1035 (IEC958_AES1_CON_PCM_CODER<<8)|\
1036 (IEC958_AES3_CON_FS_48000<<24))
1038 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1040 #endif /* __SOUND_PCM_H */