5 * Digital Audio (PCM) abstract layer
6 * Copyright (c) by Jaroslav Kysela <perex@suse.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 <linux/poll.h>
29 #include <linux/bitops.h>
31 #define snd_pcm_substream_chip(substream) ((substream)->private_data)
32 #define snd_pcm_chip(pcm) ((pcm)->private_data)
34 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
39 * Hardware (lowlevel) section
42 struct snd_pcm_hardware
{
43 unsigned int info
; /* SNDRV_PCM_INFO_* */
44 u64 formats
; /* SNDRV_PCM_FMTBIT_* */
45 unsigned int rates
; /* SNDRV_PCM_RATE_* */
46 unsigned int rate_min
; /* min rate */
47 unsigned int rate_max
; /* max rate */
48 unsigned int channels_min
; /* min channels */
49 unsigned int channels_max
; /* max channels */
50 size_t buffer_bytes_max
; /* max buffer size */
51 size_t period_bytes_min
; /* min period size */
52 size_t period_bytes_max
; /* max period size */
53 unsigned int periods_min
; /* min # of periods */
54 unsigned int periods_max
; /* max # of periods */
55 size_t fifo_size
; /* fifo size in bytes */
59 int (*open
)(struct snd_pcm_substream
*substream
);
60 int (*close
)(struct snd_pcm_substream
*substream
);
61 int (*ioctl
)(struct snd_pcm_substream
* substream
,
62 unsigned int cmd
, void *arg
);
63 int (*hw_params
)(struct snd_pcm_substream
*substream
,
64 struct snd_pcm_hw_params
*params
);
65 int (*hw_free
)(struct snd_pcm_substream
*substream
);
66 int (*prepare
)(struct snd_pcm_substream
*substream
);
67 int (*trigger
)(struct snd_pcm_substream
*substream
, int cmd
);
68 snd_pcm_uframes_t (*pointer
)(struct snd_pcm_substream
*substream
);
69 int (*copy
)(struct snd_pcm_substream
*substream
, int channel
,
70 snd_pcm_uframes_t pos
,
71 void __user
*buf
, snd_pcm_uframes_t count
);
72 int (*silence
)(struct snd_pcm_substream
*substream
, int channel
,
73 snd_pcm_uframes_t pos
, snd_pcm_uframes_t count
);
74 struct page
*(*page
)(struct snd_pcm_substream
*substream
,
75 unsigned long offset
);
76 int (*mmap
)(struct snd_pcm_substream
*substream
, struct vm_area_struct
*vma
);
77 int (*ack
)(struct snd_pcm_substream
*substream
);
84 #define SNDRV_PCM_DEVICES 8
86 #define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
87 #define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
89 #define SNDRV_PCM_IOCTL1_RESET 0
90 #define SNDRV_PCM_IOCTL1_INFO 1
91 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
92 #define SNDRV_PCM_IOCTL1_GSTATE 3
94 #define SNDRV_PCM_TRIGGER_STOP 0
95 #define SNDRV_PCM_TRIGGER_START 1
96 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
97 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
98 #define SNDRV_PCM_TRIGGER_SUSPEND 5
99 #define SNDRV_PCM_TRIGGER_RESUME 6
101 #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
103 /* If you change this don't forget to change rates[] table in pcm_native.c */
104 #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
105 #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
106 #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
107 #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
108 #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
109 #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
110 #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
111 #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
112 #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
113 #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
114 #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
115 #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
116 #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
118 #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
119 #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
121 #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
122 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
123 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
124 #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
125 #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
126 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
127 #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
128 SNDRV_PCM_RATE_192000)
129 #define SNDRV_PCM_FMTBIT_S8 (1ULL << SNDRV_PCM_FORMAT_S8)
130 #define SNDRV_PCM_FMTBIT_U8 (1ULL << SNDRV_PCM_FORMAT_U8)
131 #define SNDRV_PCM_FMTBIT_S16_LE (1ULL << SNDRV_PCM_FORMAT_S16_LE)
132 #define SNDRV_PCM_FMTBIT_S16_BE (1ULL << SNDRV_PCM_FORMAT_S16_BE)
133 #define SNDRV_PCM_FMTBIT_U16_LE (1ULL << SNDRV_PCM_FORMAT_U16_LE)
134 #define SNDRV_PCM_FMTBIT_U16_BE (1ULL << SNDRV_PCM_FORMAT_U16_BE)
135 #define SNDRV_PCM_FMTBIT_S24_LE (1ULL << SNDRV_PCM_FORMAT_S24_LE)
136 #define SNDRV_PCM_FMTBIT_S24_BE (1ULL << SNDRV_PCM_FORMAT_S24_BE)
137 #define SNDRV_PCM_FMTBIT_U24_LE (1ULL << SNDRV_PCM_FORMAT_U24_LE)
138 #define SNDRV_PCM_FMTBIT_U24_BE (1ULL << SNDRV_PCM_FORMAT_U24_BE)
139 #define SNDRV_PCM_FMTBIT_S32_LE (1ULL << SNDRV_PCM_FORMAT_S32_LE)
140 #define SNDRV_PCM_FMTBIT_S32_BE (1ULL << SNDRV_PCM_FORMAT_S32_BE)
141 #define SNDRV_PCM_FMTBIT_U32_LE (1ULL << SNDRV_PCM_FORMAT_U32_LE)
142 #define SNDRV_PCM_FMTBIT_U32_BE (1ULL << SNDRV_PCM_FORMAT_U32_BE)
143 #define SNDRV_PCM_FMTBIT_FLOAT_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
144 #define SNDRV_PCM_FMTBIT_FLOAT_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
145 #define SNDRV_PCM_FMTBIT_FLOAT64_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
146 #define SNDRV_PCM_FMTBIT_FLOAT64_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
147 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
148 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
149 #define SNDRV_PCM_FMTBIT_MU_LAW (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
150 #define SNDRV_PCM_FMTBIT_A_LAW (1ULL << SNDRV_PCM_FORMAT_A_LAW)
151 #define SNDRV_PCM_FMTBIT_IMA_ADPCM (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
152 #define SNDRV_PCM_FMTBIT_MPEG (1ULL << SNDRV_PCM_FORMAT_MPEG)
153 #define SNDRV_PCM_FMTBIT_GSM (1ULL << SNDRV_PCM_FORMAT_GSM)
154 #define SNDRV_PCM_FMTBIT_SPECIAL (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
155 #define SNDRV_PCM_FMTBIT_S24_3LE (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
156 #define SNDRV_PCM_FMTBIT_U24_3LE (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
157 #define SNDRV_PCM_FMTBIT_S24_3BE (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
158 #define SNDRV_PCM_FMTBIT_U24_3BE (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
159 #define SNDRV_PCM_FMTBIT_S20_3LE (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
160 #define SNDRV_PCM_FMTBIT_U20_3LE (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
161 #define SNDRV_PCM_FMTBIT_S20_3BE (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
162 #define SNDRV_PCM_FMTBIT_U20_3BE (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
163 #define SNDRV_PCM_FMTBIT_S18_3LE (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
164 #define SNDRV_PCM_FMTBIT_U18_3LE (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
165 #define SNDRV_PCM_FMTBIT_S18_3BE (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
166 #define SNDRV_PCM_FMTBIT_U18_3BE (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
168 #ifdef SNDRV_LITTLE_ENDIAN
169 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
170 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
171 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
172 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
173 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
174 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
175 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
176 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
177 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
179 #ifdef SNDRV_BIG_ENDIAN
180 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
181 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
182 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
183 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
184 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
185 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
186 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
187 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
188 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
191 struct snd_pcm_file
{
192 struct snd_pcm_substream
*substream
;
193 struct snd_pcm_file
*next
;
196 struct snd_pcm_hw_rule
;
197 typedef int (*snd_pcm_hw_rule_func_t
)(struct snd_pcm_hw_params
*params
,
198 struct snd_pcm_hw_rule
*rule
);
200 struct snd_pcm_hw_rule
{
202 snd_pcm_hw_rule_func_t func
;
208 struct snd_pcm_hw_constraints
{
209 struct snd_mask masks
[SNDRV_PCM_HW_PARAM_LAST_MASK
-
210 SNDRV_PCM_HW_PARAM_FIRST_MASK
+ 1];
211 struct snd_interval intervals
[SNDRV_PCM_HW_PARAM_LAST_INTERVAL
-
212 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
+ 1];
213 unsigned int rules_num
;
214 unsigned int rules_all
;
215 struct snd_pcm_hw_rule
*rules
;
218 static inline struct snd_mask
*constrs_mask(struct snd_pcm_hw_constraints
*constrs
,
219 snd_pcm_hw_param_t var
)
221 return &constrs
->masks
[var
- SNDRV_PCM_HW_PARAM_FIRST_MASK
];
224 static inline struct snd_interval
*constrs_interval(struct snd_pcm_hw_constraints
*constrs
,
225 snd_pcm_hw_param_t var
)
227 return &constrs
->intervals
[var
- SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
];
232 unsigned int den_min
, den_max
, den_step
;
236 unsigned int num_min
, num_max
, num_step
;
240 struct snd_pcm_hw_constraint_ratnums
{
242 struct snd_ratnum
*rats
;
245 struct snd_pcm_hw_constraint_ratdens
{
247 struct snd_ratden
*rats
;
250 struct snd_pcm_hw_constraint_list
{
256 struct snd_pcm_runtime
{
258 struct snd_pcm_substream
*trigger_master
;
259 struct timespec trigger_tstamp
; /* trigger timestamp */
261 snd_pcm_uframes_t avail_max
;
262 snd_pcm_uframes_t hw_ptr_base
; /* Position at buffer restart */
263 snd_pcm_uframes_t hw_ptr_interrupt
; /* Position at interrupt time*/
265 /* -- HW params -- */
266 snd_pcm_access_t access
; /* access mode */
267 snd_pcm_format_t format
; /* SNDRV_PCM_FORMAT_* */
268 snd_pcm_subformat_t subformat
; /* subformat */
269 unsigned int rate
; /* rate in Hz */
270 unsigned int channels
; /* channels */
271 snd_pcm_uframes_t period_size
; /* period size */
272 unsigned int periods
; /* periods */
273 snd_pcm_uframes_t buffer_size
; /* buffer size */
274 unsigned int tick_time
; /* tick time */
275 snd_pcm_uframes_t min_align
; /* Min alignment for the format */
277 unsigned int frame_bits
;
278 unsigned int sample_bits
;
280 unsigned int rate_num
;
281 unsigned int rate_den
;
283 /* -- SW params -- */
284 int tstamp_mode
; /* mmap timestamp is updated */
285 unsigned int period_step
;
286 unsigned int sleep_min
; /* min ticks to sleep */
287 snd_pcm_uframes_t xfer_align
; /* xfer size need to be a multiple */
288 snd_pcm_uframes_t start_threshold
;
289 snd_pcm_uframes_t stop_threshold
;
290 snd_pcm_uframes_t silence_threshold
; /* Silence filling happens when
291 noise is nearest than this */
292 snd_pcm_uframes_t silence_size
; /* Silence filling size */
293 snd_pcm_uframes_t boundary
; /* pointers wrap point */
295 snd_pcm_uframes_t silence_start
; /* starting pointer to silence area */
296 snd_pcm_uframes_t silence_filled
; /* size filled with silence */
298 union snd_pcm_sync_id sync
; /* hardware synchronization ID */
301 volatile struct snd_pcm_mmap_status
*status
;
302 volatile struct snd_pcm_mmap_control
*control
;
305 /* -- locking / scheduling -- */
306 wait_queue_head_t sleep
;
307 struct timer_list tick_timer
;
308 struct fasync_struct
*fasync
;
310 /* -- private section -- */
312 void (*private_free
)(struct snd_pcm_runtime
*runtime
);
314 /* -- hardware description -- */
315 struct snd_pcm_hardware hw
;
316 struct snd_pcm_hw_constraints hw_constraints
;
318 /* -- interrupt callbacks -- */
319 void (*transfer_ack_begin
)(struct snd_pcm_substream
*substream
);
320 void (*transfer_ack_end
)(struct snd_pcm_substream
*substream
);
323 unsigned int timer_resolution
; /* timer resolution */
326 unsigned char *dma_area
; /* DMA area */
327 dma_addr_t dma_addr
; /* physical bus address (not accessible from main CPU) */
328 size_t dma_bytes
; /* size of DMA area */
330 struct snd_dma_buffer
*dma_buffer_p
; /* allocated buffer */
332 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
333 /* -- OSS things -- */
334 struct snd_pcm_oss_runtime oss
;
338 struct snd_pcm_group
{ /* keep linked substreams */
340 struct list_head substreams
;
344 struct snd_pcm_substream
{
346 struct snd_pcm_str
*pstr
;
347 void *private_data
; /* copied from pcm->private_data */
349 char name
[32]; /* substream name */
350 int stream
; /* stream (direction) */
351 size_t buffer_bytes_max
; /* limit ring buffer size */
352 struct snd_dma_buffer dma_buffer
;
353 unsigned int dma_buf_id
;
355 /* -- hardware operations -- */
356 struct snd_pcm_ops
*ops
;
357 /* -- runtime information -- */
358 struct snd_pcm_runtime
*runtime
;
359 /* -- timer section -- */
360 struct snd_timer
*timer
; /* timer */
361 unsigned timer_running
: 1; /* time is running */
362 spinlock_t timer_lock
;
363 /* -- next substream -- */
364 struct snd_pcm_substream
*next
;
365 /* -- linked substreams -- */
366 struct list_head link_list
; /* linked list member */
367 struct snd_pcm_group self_group
; /* fake group for non linked substream (with substream lock inside) */
368 struct snd_pcm_group
*group
; /* pointer to current group */
369 /* -- assigned files -- */
372 void (*pcm_release
)(struct snd_pcm_substream
*);
373 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
374 /* -- OSS things -- */
375 struct snd_pcm_oss_substream oss
;
377 struct snd_info_entry
*proc_root
;
378 struct snd_info_entry
*proc_info_entry
;
379 struct snd_info_entry
*proc_hw_params_entry
;
380 struct snd_info_entry
*proc_sw_params_entry
;
381 struct snd_info_entry
*proc_status_entry
;
382 struct snd_info_entry
*proc_prealloc_entry
;
384 unsigned int no_mmap_ctrl
: 1;
385 unsigned int hw_opened
: 1;
388 #define SUBSTREAM_BUSY(substream) ((substream)->file != NULL)
392 int stream
; /* stream (direction) */
394 /* -- substreams -- */
395 unsigned int substream_count
;
396 unsigned int substream_opened
;
397 struct snd_pcm_substream
*substream
;
398 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
399 /* -- OSS things -- */
400 struct snd_pcm_oss_stream oss
;
402 struct snd_pcm_file
*files
;
403 struct snd_info_entry
*proc_root
;
404 struct snd_info_entry
*proc_info_entry
;
405 #ifdef CONFIG_SND_DEBUG
406 unsigned int xrun_debug
; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
407 struct snd_info_entry
*proc_xrun_debug_entry
;
412 struct snd_card
*card
;
413 struct list_head list
;
414 unsigned int device
; /* device number */
415 unsigned int info_flags
;
416 unsigned short dev_class
;
417 unsigned short dev_subclass
;
420 struct snd_pcm_str streams
[2];
421 struct mutex open_mutex
;
422 wait_queue_head_t open_wait
;
424 void (*private_free
) (struct snd_pcm
*pcm
);
425 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
426 struct snd_pcm_oss oss
;
430 struct snd_pcm_notify
{
431 int (*n_register
) (struct snd_pcm
* pcm
);
432 int (*n_disconnect
) (struct snd_pcm
* pcm
);
433 int (*n_unregister
) (struct snd_pcm
* pcm
);
434 struct list_head list
;
441 extern struct file_operations snd_pcm_f_ops
[2];
443 int snd_pcm_new(struct snd_card
*card
, char *id
, int device
,
444 int playback_count
, int capture_count
,
445 struct snd_pcm
**rpcm
);
446 int snd_pcm_new_stream(struct snd_pcm
*pcm
, int stream
, int substream_count
);
448 int snd_pcm_notify(struct snd_pcm_notify
*notify
, int nfree
);
454 extern rwlock_t snd_pcm_link_rwlock
;
456 int snd_pcm_info(struct snd_pcm_substream
*substream
, struct snd_pcm_info
*info
);
457 int snd_pcm_info_user(struct snd_pcm_substream
*substream
,
458 struct snd_pcm_info __user
*info
);
459 int snd_pcm_status(struct snd_pcm_substream
*substream
,
460 struct snd_pcm_status
*status
);
461 int snd_pcm_start(struct snd_pcm_substream
*substream
);
462 int snd_pcm_stop(struct snd_pcm_substream
*substream
, int status
);
463 int snd_pcm_drain_done(struct snd_pcm_substream
*substream
);
465 int snd_pcm_suspend(struct snd_pcm_substream
*substream
);
466 int snd_pcm_suspend_all(struct snd_pcm
*pcm
);
468 int snd_pcm_kernel_ioctl(struct snd_pcm_substream
*substream
, unsigned int cmd
, void *arg
);
469 int snd_pcm_open_substream(struct snd_pcm
*pcm
, int stream
, struct file
*file
,
470 struct snd_pcm_substream
**rsubstream
);
471 void snd_pcm_release_substream(struct snd_pcm_substream
*substream
);
472 int snd_pcm_attach_substream(struct snd_pcm
*pcm
, int stream
, struct file
*file
,
473 struct snd_pcm_substream
**rsubstream
);
474 void snd_pcm_detach_substream(struct snd_pcm_substream
*substream
);
475 void snd_pcm_vma_notify_data(void *client
, void *data
);
476 int snd_pcm_mmap_data(struct snd_pcm_substream
*substream
, struct file
*file
, struct vm_area_struct
*area
);
478 #if BITS_PER_LONG >= 64
480 static inline void div64_32(u_int64_t
*n
, u_int32_t div
, u_int32_t
*rem
)
488 static inline void div64_32(u_int64_t
*n
, u_int32_t div
, u_int32_t
*rem
)
491 low
= *n
& 0xffffffff;
494 u_int32_t high1
= high
% div
;
496 asm("divl %2":"=a" (low
), "=d" (*rem
):"rm" (div
), "a" (low
), "d" (high1
));
497 *n
= (u_int64_t
)high
<< 32 | low
;
505 static inline void divl(u_int32_t high
, u_int32_t low
,
507 u_int32_t
*q
, u_int32_t
*r
)
509 u_int64_t n
= (u_int64_t
)high
<< 32 | low
;
510 u_int64_t d
= (u_int64_t
)div
<< 31;
513 while (n
> 0xffffffffU
) {
525 *q
= q1
| (low
/ div
);
534 static inline void div64_32(u_int64_t
*n
, u_int32_t div
, u_int32_t
*rem
)
537 low
= *n
& 0xffffffff;
540 u_int32_t high1
= high
% div
;
541 u_int32_t low1
= low
;
543 divl(high1
, low1
, div
, &low
, rem
);
544 *n
= (u_int64_t
)high
<< 32 | low
;
556 static inline int snd_pcm_stream_linked(struct snd_pcm_substream
*substream
)
558 return substream
->group
!= &substream
->self_group
;
561 static inline void snd_pcm_stream_lock(struct snd_pcm_substream
*substream
)
563 read_lock(&snd_pcm_link_rwlock
);
564 spin_lock(&substream
->self_group
.lock
);
567 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream
*substream
)
569 spin_unlock(&substream
->self_group
.lock
);
570 read_unlock(&snd_pcm_link_rwlock
);
573 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream
*substream
)
575 read_lock_irq(&snd_pcm_link_rwlock
);
576 spin_lock(&substream
->self_group
.lock
);
579 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream
*substream
)
581 spin_unlock(&substream
->self_group
.lock
);
582 read_unlock_irq(&snd_pcm_link_rwlock
);
585 #define snd_pcm_stream_lock_irqsave(substream, flags) \
587 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
588 spin_lock(&substream->self_group.lock); \
591 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
593 spin_unlock(&substream->self_group.lock); \
594 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
597 #define snd_pcm_group_for_each(pos, substream) \
598 list_for_each(pos, &substream->group->substreams)
600 #define snd_pcm_group_substream_entry(pos) \
601 list_entry(pos, struct snd_pcm_substream, link_list)
603 static inline int snd_pcm_running(struct snd_pcm_substream
*substream
)
605 return (substream
->runtime
->status
->state
== SNDRV_PCM_STATE_RUNNING
||
606 (substream
->runtime
->status
->state
== SNDRV_PCM_STATE_DRAINING
&&
607 substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
));
610 static inline ssize_t
bytes_to_samples(struct snd_pcm_runtime
*runtime
, ssize_t size
)
612 return size
* 8 / runtime
->sample_bits
;
615 static inline snd_pcm_sframes_t
bytes_to_frames(struct snd_pcm_runtime
*runtime
, ssize_t size
)
617 return size
* 8 / runtime
->frame_bits
;
620 static inline ssize_t
samples_to_bytes(struct snd_pcm_runtime
*runtime
, ssize_t size
)
622 return size
* runtime
->sample_bits
/ 8;
625 static inline ssize_t
frames_to_bytes(struct snd_pcm_runtime
*runtime
, snd_pcm_sframes_t size
)
627 return size
* runtime
->frame_bits
/ 8;
630 static inline int frame_aligned(struct snd_pcm_runtime
*runtime
, ssize_t bytes
)
632 return bytes
% runtime
->byte_align
== 0;
635 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream
*substream
)
637 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
638 return frames_to_bytes(runtime
, runtime
->buffer_size
);
641 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream
*substream
)
643 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
644 return frames_to_bytes(runtime
, runtime
->period_size
);
648 * result is: 0 ... (boundary - 1)
650 static inline snd_pcm_uframes_t
snd_pcm_playback_avail(struct snd_pcm_runtime
*runtime
)
652 snd_pcm_sframes_t avail
= runtime
->status
->hw_ptr
+ runtime
->buffer_size
- runtime
->control
->appl_ptr
;
654 avail
+= runtime
->boundary
;
655 else if ((snd_pcm_uframes_t
) avail
>= runtime
->boundary
)
656 avail
-= runtime
->boundary
;
661 * result is: 0 ... (boundary - 1)
663 static inline snd_pcm_uframes_t
snd_pcm_capture_avail(struct snd_pcm_runtime
*runtime
)
665 snd_pcm_sframes_t avail
= runtime
->status
->hw_ptr
- runtime
->control
->appl_ptr
;
667 avail
+= runtime
->boundary
;
671 static inline snd_pcm_sframes_t
snd_pcm_playback_hw_avail(struct snd_pcm_runtime
*runtime
)
673 return runtime
->buffer_size
- snd_pcm_playback_avail(runtime
);
676 static inline snd_pcm_sframes_t
snd_pcm_capture_hw_avail(struct snd_pcm_runtime
*runtime
)
678 return runtime
->buffer_size
- snd_pcm_capture_avail(runtime
);
682 * snd_pcm_playback_ready - check whether the playback buffer is available
683 * @substream: the pcm substream instance
685 * Checks whether enough free space is available on the playback buffer.
687 * Returns non-zero if available, or zero if not.
689 static inline int snd_pcm_playback_ready(struct snd_pcm_substream
*substream
)
691 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
692 return snd_pcm_playback_avail(runtime
) >= runtime
->control
->avail_min
;
696 * snd_pcm_capture_ready - check whether the capture buffer is available
697 * @substream: the pcm substream instance
699 * Checks whether enough capture data is available on the capture buffer.
701 * Returns non-zero if available, or zero if not.
703 static inline int snd_pcm_capture_ready(struct snd_pcm_substream
*substream
)
705 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
706 return snd_pcm_capture_avail(runtime
) >= runtime
->control
->avail_min
;
710 * snd_pcm_playback_data - check whether any data exists on the playback buffer
711 * @substream: the pcm substream instance
713 * Checks whether any data exists on the playback buffer. If stop_threshold
714 * is bigger or equal to boundary, then this function returns always non-zero.
716 * Returns non-zero if exists, or zero if not.
718 static inline int snd_pcm_playback_data(struct snd_pcm_substream
*substream
)
720 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
722 if (runtime
->stop_threshold
>= runtime
->boundary
)
724 return snd_pcm_playback_avail(runtime
) < runtime
->buffer_size
;
728 * snd_pcm_playback_empty - check whether the playback buffer is empty
729 * @substream: the pcm substream instance
731 * Checks whether the playback buffer is empty.
733 * Returns non-zero if empty, or zero if not.
735 static inline int snd_pcm_playback_empty(struct snd_pcm_substream
*substream
)
737 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
738 return snd_pcm_playback_avail(runtime
) >= runtime
->buffer_size
;
742 * snd_pcm_capture_empty - check whether the capture buffer is empty
743 * @substream: the pcm substream instance
745 * Checks whether the capture buffer is empty.
747 * Returns non-zero if empty, or zero if not.
749 static inline int snd_pcm_capture_empty(struct snd_pcm_substream
*substream
)
751 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
752 return snd_pcm_capture_avail(runtime
) == 0;
755 static inline void snd_pcm_trigger_done(struct snd_pcm_substream
*substream
,
756 struct snd_pcm_substream
*master
)
758 substream
->runtime
->trigger_master
= master
;
761 static inline int hw_is_mask(int var
)
763 return var
>= SNDRV_PCM_HW_PARAM_FIRST_MASK
&&
764 var
<= SNDRV_PCM_HW_PARAM_LAST_MASK
;
767 static inline int hw_is_interval(int var
)
769 return var
>= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
&&
770 var
<= SNDRV_PCM_HW_PARAM_LAST_INTERVAL
;
773 static inline struct snd_mask
*hw_param_mask(struct snd_pcm_hw_params
*params
,
774 snd_pcm_hw_param_t var
)
776 return ¶ms
->masks
[var
- SNDRV_PCM_HW_PARAM_FIRST_MASK
];
779 static inline struct snd_interval
*hw_param_interval(struct snd_pcm_hw_params
*params
,
780 snd_pcm_hw_param_t var
)
782 return ¶ms
->intervals
[var
- SNDRV_PCM_HW_PARAM_FIRST_INTERVAL
];
785 static inline const struct snd_mask
*hw_param_mask_c(const struct snd_pcm_hw_params
*params
,
786 snd_pcm_hw_param_t var
)
788 return (const struct snd_mask
*)hw_param_mask((struct snd_pcm_hw_params
*) params
, var
);
791 static inline const struct snd_interval
*hw_param_interval_c(const struct snd_pcm_hw_params
*params
,
792 snd_pcm_hw_param_t var
)
794 return (const struct snd_interval
*)hw_param_interval((struct snd_pcm_hw_params
*) params
, var
);
797 #define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
798 #define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
799 #define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
800 #define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
801 #define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
802 #define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
803 #define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
804 #define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
805 #define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
806 #define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
807 #define params_tick_time(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_TICK_TIME)->min
810 int snd_interval_refine(struct snd_interval
*i
, const struct snd_interval
*v
);
811 void snd_interval_mul(const struct snd_interval
*a
, const struct snd_interval
*b
, struct snd_interval
*c
);
812 void snd_interval_div(const struct snd_interval
*a
, const struct snd_interval
*b
, struct snd_interval
*c
);
813 void snd_interval_muldivk(const struct snd_interval
*a
, const struct snd_interval
*b
,
814 unsigned int k
, struct snd_interval
*c
);
815 void snd_interval_mulkdiv(const struct snd_interval
*a
, unsigned int k
,
816 const struct snd_interval
*b
, struct snd_interval
*c
);
817 int snd_interval_list(struct snd_interval
*i
, unsigned int count
, unsigned int *list
, unsigned int mask
);
818 int snd_interval_ratnum(struct snd_interval
*i
,
819 unsigned int rats_count
, struct snd_ratnum
*rats
,
820 unsigned int *nump
, unsigned int *denp
);
822 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params
*params
);
823 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params
*params
, snd_pcm_hw_param_t var
);
824 int snd_pcm_hw_param_near(struct snd_pcm_substream
*substream
,
825 struct snd_pcm_hw_params
*params
,
826 snd_pcm_hw_param_t var
,
827 unsigned int val
, int *dir
);
828 int snd_pcm_hw_param_set(struct snd_pcm_substream
*pcm
,
829 struct snd_pcm_hw_params
*params
,
830 snd_pcm_hw_param_t var
,
831 unsigned int val
, int dir
);
832 int snd_pcm_hw_params_choose(struct snd_pcm_substream
*substream
, struct snd_pcm_hw_params
*params
);
834 int snd_pcm_hw_refine(struct snd_pcm_substream
*substream
, struct snd_pcm_hw_params
*params
);
836 int snd_pcm_hw_constraints_init(struct snd_pcm_substream
*substream
);
837 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream
*substream
);
839 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime
*runtime
, snd_pcm_hw_param_t var
,
841 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime
*runtime
, snd_pcm_hw_param_t var
,
843 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime
*runtime
, snd_pcm_hw_param_t var
,
844 unsigned int min
, unsigned int max
);
845 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime
*runtime
, snd_pcm_hw_param_t var
);
846 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime
*runtime
,
848 snd_pcm_hw_param_t var
,
849 struct snd_pcm_hw_constraint_list
*l
);
850 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime
*runtime
,
852 snd_pcm_hw_param_t var
,
853 struct snd_pcm_hw_constraint_ratnums
*r
);
854 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime
*runtime
,
856 snd_pcm_hw_param_t var
,
857 struct snd_pcm_hw_constraint_ratdens
*r
);
858 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime
*runtime
,
861 unsigned int msbits
);
862 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime
*runtime
,
864 snd_pcm_hw_param_t var
,
866 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime
*runtime
,
868 snd_pcm_hw_param_t var
);
869 int snd_pcm_hw_rule_add(struct snd_pcm_runtime
*runtime
,
872 snd_pcm_hw_rule_func_t func
, void *private,
875 int snd_pcm_format_signed(snd_pcm_format_t format
);
876 int snd_pcm_format_unsigned(snd_pcm_format_t format
);
877 int snd_pcm_format_linear(snd_pcm_format_t format
);
878 int snd_pcm_format_little_endian(snd_pcm_format_t format
);
879 int snd_pcm_format_big_endian(snd_pcm_format_t format
);
880 #if 0 /* just for DocBook */
882 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
883 * @format: the format to check
885 * Returns 1 if the given PCM format is CPU-endian, 0 if
886 * opposite, or a negative error code if endian not specified.
888 int snd_pcm_format_cpu_endian(snd_pcm_format_t format
);
890 #ifdef SNDRV_LITTLE_ENDIAN
891 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
893 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
895 int snd_pcm_format_width(snd_pcm_format_t format
); /* in bits */
896 int snd_pcm_format_physical_width(snd_pcm_format_t format
); /* in bits */
897 ssize_t
snd_pcm_format_size(snd_pcm_format_t format
, size_t samples
);
898 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format
);
899 int snd_pcm_format_set_silence(snd_pcm_format_t format
, void *buf
, unsigned int frames
);
900 snd_pcm_format_t
snd_pcm_build_linear_format(int width
, int unsignd
, int big_endian
);
902 void snd_pcm_set_ops(struct snd_pcm
* pcm
, int direction
, struct snd_pcm_ops
*ops
);
903 void snd_pcm_set_sync(struct snd_pcm_substream
*substream
);
904 int snd_pcm_lib_interleave_len(struct snd_pcm_substream
*substream
);
905 int snd_pcm_lib_ioctl(struct snd_pcm_substream
*substream
,
906 unsigned int cmd
, void *arg
);
907 int snd_pcm_update_hw_ptr(struct snd_pcm_substream
*substream
);
908 int snd_pcm_playback_xrun_check(struct snd_pcm_substream
*substream
);
909 int snd_pcm_capture_xrun_check(struct snd_pcm_substream
*substream
);
910 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream
*substream
);
911 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream
*substream
);
912 void snd_pcm_playback_silence(struct snd_pcm_substream
*substream
, snd_pcm_uframes_t new_hw_ptr
);
913 void snd_pcm_tick_prepare(struct snd_pcm_substream
*substream
);
914 void snd_pcm_tick_set(struct snd_pcm_substream
*substream
, unsigned long ticks
);
915 void snd_pcm_tick_elapsed(struct snd_pcm_substream
*substream
);
916 void snd_pcm_period_elapsed(struct snd_pcm_substream
*substream
);
917 snd_pcm_sframes_t
snd_pcm_lib_write(struct snd_pcm_substream
*substream
,
918 const void __user
*buf
,
919 snd_pcm_uframes_t frames
);
920 snd_pcm_sframes_t
snd_pcm_lib_read(struct snd_pcm_substream
*substream
,
921 void __user
*buf
, snd_pcm_uframes_t frames
);
922 snd_pcm_sframes_t
snd_pcm_lib_writev(struct snd_pcm_substream
*substream
,
923 void __user
**bufs
, snd_pcm_uframes_t frames
);
924 snd_pcm_sframes_t
snd_pcm_lib_readv(struct snd_pcm_substream
*substream
,
925 void __user
**bufs
, snd_pcm_uframes_t frames
);
927 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime
*runtime
);
929 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream
*substream
,
930 struct snd_dma_buffer
*bufp
)
932 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
934 runtime
->dma_buffer_p
= bufp
;
935 runtime
->dma_area
= bufp
->area
;
936 runtime
->dma_addr
= bufp
->addr
;
937 runtime
->dma_bytes
= bufp
->bytes
;
939 runtime
->dma_buffer_p
= NULL
;
940 runtime
->dma_area
= NULL
;
941 runtime
->dma_addr
= 0;
942 runtime
->dma_bytes
= 0;
950 void snd_pcm_timer_resolution_change(struct snd_pcm_substream
*substream
);
951 void snd_pcm_timer_init(struct snd_pcm_substream
*substream
);
952 void snd_pcm_timer_done(struct snd_pcm_substream
*substream
);
958 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream
*substream
);
959 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm
*pcm
);
960 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream
*substream
,
961 int type
, struct device
*data
,
962 size_t size
, size_t max
);
963 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm
*pcm
,
964 int type
, void *data
,
965 size_t size
, size_t max
);
966 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream
*substream
, size_t size
);
967 int snd_pcm_lib_free_pages(struct snd_pcm_substream
*substream
);
969 #define snd_pcm_substream_sgbuf(substream) ((substream)->runtime->dma_buffer_p->private_data)
970 #define snd_pcm_sgbuf_pages(size) snd_sgbuf_aligned_pages(size)
971 #define snd_pcm_sgbuf_get_addr(sgbuf,ofs) snd_sgbuf_get_addr(sgbuf,ofs)
972 struct page
*snd_pcm_sgbuf_ops_page(struct snd_pcm_substream
*substream
, unsigned long offset
);
974 /* handle mmap counter - PCM mmap callback should handle this counter properly */
975 static inline void snd_pcm_mmap_data_open(struct vm_area_struct
*area
)
977 struct snd_pcm_substream
*substream
= (struct snd_pcm_substream
*)area
->vm_private_data
;
978 atomic_inc(&substream
->runtime
->mmap_count
);
981 static inline void snd_pcm_mmap_data_close(struct vm_area_struct
*area
)
983 struct snd_pcm_substream
*substream
= (struct snd_pcm_substream
*)area
->vm_private_data
;
984 atomic_dec(&substream
->runtime
->mmap_count
);
987 /* mmap for io-memory area */
988 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
989 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
990 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream
*substream
, struct vm_area_struct
*area
);
992 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
993 #define snd_pcm_lib_mmap_iomem NULL
996 static inline void snd_pcm_limit_isa_dma_size(int dma
, size_t *max
)
998 *max
= dma
< 4 ? 64 * 1024 : 128 * 1024;
1005 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1006 (IEC958_AES1_CON_ORIGINAL<<8)|\
1007 (IEC958_AES1_CON_PCM_CODER<<8)|\
1008 (IEC958_AES3_CON_FS_48000<<24))
1010 #endif /* __SOUND_PCM_H */