]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/sound/pcm.h
ALSA: Add extra delay count in PCM
[mirror_ubuntu-artful-kernel.git] / include / sound / pcm.h
CommitLineData
1da177e4
LT
1#ifndef __SOUND_PCM_H
2#define __SOUND_PCM_H
3
4/*
5 * Digital Audio (PCM) abstract layer
c1017a4c 6 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
1da177e4
LT
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>
f90c06a2 28#include <sound/minors.h>
1da177e4 29#include <linux/poll.h>
f23f6e08 30#include <linux/mm.h>
1da177e4
LT
31#include <linux/bitops.h>
32
1da177e4
LT
33#define snd_pcm_substream_chip(substream) ((substream)->private_data)
34#define snd_pcm_chip(pcm) ((pcm)->private_data)
35
1da177e4
LT
36#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
37#include "pcm_oss.h"
38#endif
39
40/*
41 * Hardware (lowlevel) section
42 */
43
877211f5 44struct snd_pcm_hardware {
1da177e4
LT
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 */
877211f5 58};
1da177e4 59
e0e6ce03
RD
60struct snd_pcm_substream;
61
877211f5
TI
62struct snd_pcm_ops {
63 int (*open)(struct snd_pcm_substream *substream);
64 int (*close)(struct snd_pcm_substream *substream);
65 int (*ioctl)(struct snd_pcm_substream * substream,
1da177e4 66 unsigned int cmd, void *arg);
877211f5
TI
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,
1da177e4 75 void __user *buf, snd_pcm_uframes_t count);
877211f5 76 int (*silence)(struct snd_pcm_substream *substream, int channel,
1da177e4 77 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
877211f5
TI
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);
82};
1da177e4
LT
83
84/*
85 *
86 */
87
f90c06a2
PM
88#if defined(CONFIG_SND_DYNAMIC_MINORS)
89#define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
90#else
91#define SNDRV_PCM_DEVICES 8
92#endif
896e6cc2 93
1da177e4
LT
94#define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
95#define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
96
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
101
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
108
109#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
110
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 */
125
126#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
127#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
128
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)
175
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
186#endif
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
197#endif
198
877211f5
TI
199struct snd_pcm_file {
200 struct snd_pcm_substream *substream;
548a648b 201 int no_compat_mmap;
1da177e4
LT
202};
203
877211f5
TI
204struct snd_pcm_hw_rule;
205typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
206 struct snd_pcm_hw_rule *rule);
1da177e4 207
877211f5 208struct snd_pcm_hw_rule {
1da177e4
LT
209 unsigned int cond;
210 snd_pcm_hw_rule_func_t func;
211 int var;
212 int deps[4];
213 void *private;
214};
215
877211f5
TI
216struct snd_pcm_hw_constraints {
217 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
1da177e4 218 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
877211f5 219 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
1da177e4
LT
220 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
221 unsigned int rules_num;
222 unsigned int rules_all;
877211f5
TI
223 struct snd_pcm_hw_rule *rules;
224};
1da177e4 225
877211f5
TI
226static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
227 snd_pcm_hw_param_t var)
1da177e4
LT
228{
229 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
230}
231
877211f5
TI
232static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
233 snd_pcm_hw_param_t var)
1da177e4
LT
234{
235 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
236}
237
877211f5 238struct snd_ratnum {
1da177e4
LT
239 unsigned int num;
240 unsigned int den_min, den_max, den_step;
877211f5 241};
1da177e4 242
877211f5 243struct snd_ratden {
1da177e4
LT
244 unsigned int num_min, num_max, num_step;
245 unsigned int den;
877211f5 246};
1da177e4 247
877211f5 248struct snd_pcm_hw_constraint_ratnums {
1da177e4 249 int nrats;
877211f5
TI
250 struct snd_ratnum *rats;
251};
1da177e4 252
877211f5 253struct snd_pcm_hw_constraint_ratdens {
1da177e4 254 int nrats;
877211f5
TI
255 struct snd_ratden *rats;
256};
1da177e4 257
877211f5 258struct snd_pcm_hw_constraint_list {
1da177e4
LT
259 unsigned int count;
260 unsigned int *list;
261 unsigned int mask;
877211f5 262};
1da177e4 263
877211f5 264struct snd_pcm_runtime {
1da177e4 265 /* -- Status -- */
877211f5 266 struct snd_pcm_substream *trigger_master;
07799e75 267 struct timespec trigger_tstamp; /* trigger timestamp */
1da177e4
LT
268 int overrange;
269 snd_pcm_uframes_t avail_max;
270 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
bbf6ad13
JK
271 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
272 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
4bbe1ddf 273 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
1da177e4
LT
274
275 /* -- HW params -- */
276 snd_pcm_access_t access; /* access mode */
277 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
278 snd_pcm_subformat_t subformat; /* subformat */
279 unsigned int rate; /* rate in Hz */
280 unsigned int channels; /* channels */
281 snd_pcm_uframes_t period_size; /* period size */
282 unsigned int periods; /* periods */
283 snd_pcm_uframes_t buffer_size; /* buffer size */
1da177e4
LT
284 snd_pcm_uframes_t min_align; /* Min alignment for the format */
285 size_t byte_align;
286 unsigned int frame_bits;
287 unsigned int sample_bits;
288 unsigned int info;
289 unsigned int rate_num;
290 unsigned int rate_den;
291
292 /* -- SW params -- */
877211f5 293 int tstamp_mode; /* mmap timestamp is updated */
1da177e4 294 unsigned int period_step;
1da177e4
LT
295 snd_pcm_uframes_t start_threshold;
296 snd_pcm_uframes_t stop_threshold;
297 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
298 noise is nearest than this */
299 snd_pcm_uframes_t silence_size; /* Silence filling size */
300 snd_pcm_uframes_t boundary; /* pointers wrap point */
301
302 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
303 snd_pcm_uframes_t silence_filled; /* size filled with silence */
304
877211f5 305 union snd_pcm_sync_id sync; /* hardware synchronization ID */
1da177e4
LT
306
307 /* -- mmap -- */
503fc85a
TI
308 struct snd_pcm_mmap_status *status;
309 struct snd_pcm_mmap_control *control;
1da177e4
LT
310
311 /* -- locking / scheduling -- */
312 wait_queue_head_t sleep;
1da177e4
LT
313 struct fasync_struct *fasync;
314
315 /* -- private section -- */
316 void *private_data;
877211f5 317 void (*private_free)(struct snd_pcm_runtime *runtime);
1da177e4
LT
318
319 /* -- hardware description -- */
877211f5
TI
320 struct snd_pcm_hardware hw;
321 struct snd_pcm_hw_constraints hw_constraints;
1da177e4
LT
322
323 /* -- interrupt callbacks -- */
877211f5
TI
324 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
325 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
1da177e4
LT
326
327 /* -- timer -- */
328 unsigned int timer_resolution; /* timer resolution */
b751eef1 329 int tstamp_type; /* timestamp type */
1da177e4
LT
330
331 /* -- DMA -- */
332 unsigned char *dma_area; /* DMA area */
333 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
334 size_t dma_bytes; /* size of DMA area */
335
336 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
337
338#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
339 /* -- OSS things -- */
877211f5 340 struct snd_pcm_oss_runtime oss;
1da177e4
LT
341#endif
342};
343
877211f5 344struct snd_pcm_group { /* keep linked substreams */
1da177e4
LT
345 spinlock_t lock;
346 struct list_head substreams;
347 int count;
877211f5 348};
1da177e4 349
877211f5
TI
350struct snd_pcm_substream {
351 struct snd_pcm *pcm;
352 struct snd_pcm_str *pstr;
1da177e4
LT
353 void *private_data; /* copied from pcm->private_data */
354 int number;
355 char name[32]; /* substream name */
356 int stream; /* stream (direction) */
9442e691 357 char latency_id[20]; /* latency identifier */
1da177e4
LT
358 size_t buffer_bytes_max; /* limit ring buffer size */
359 struct snd_dma_buffer dma_buffer;
360 unsigned int dma_buf_id;
361 size_t dma_max;
362 /* -- hardware operations -- */
877211f5 363 struct snd_pcm_ops *ops;
1da177e4 364 /* -- runtime information -- */
877211f5 365 struct snd_pcm_runtime *runtime;
1da177e4 366 /* -- timer section -- */
877211f5 367 struct snd_timer *timer; /* timer */
1da177e4 368 unsigned timer_running: 1; /* time is running */
1da177e4 369 /* -- next substream -- */
877211f5 370 struct snd_pcm_substream *next;
1da177e4
LT
371 /* -- linked substreams -- */
372 struct list_head link_list; /* linked list member */
877211f5
TI
373 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
374 struct snd_pcm_group *group; /* pointer to current group */
1da177e4 375 /* -- assigned files -- */
1576274d 376 void *file;
0df63e44 377 int ref_count;
9c323fcb 378 atomic_t mmap_count;
0df63e44 379 unsigned int f_flags;
3bf75f9b 380 void (*pcm_release)(struct snd_pcm_substream *);
1da177e4
LT
381#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
382 /* -- OSS things -- */
877211f5 383 struct snd_pcm_oss_substream oss;
1da177e4 384#endif
b7d90a35 385#ifdef CONFIG_SND_VERBOSE_PROCFS
877211f5
TI
386 struct snd_info_entry *proc_root;
387 struct snd_info_entry *proc_info_entry;
388 struct snd_info_entry *proc_hw_params_entry;
389 struct snd_info_entry *proc_sw_params_entry;
390 struct snd_info_entry *proc_status_entry;
391 struct snd_info_entry *proc_prealloc_entry;
c7132aeb 392 struct snd_info_entry *proc_prealloc_max_entry;
b7d90a35 393#endif
1da177e4 394 /* misc flags */
3bf75f9b 395 unsigned int hw_opened: 1;
1da177e4
LT
396};
397
0df63e44 398#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
1da177e4
LT
399
400
877211f5 401struct snd_pcm_str {
1da177e4 402 int stream; /* stream (direction) */
877211f5 403 struct snd_pcm *pcm;
1da177e4
LT
404 /* -- substreams -- */
405 unsigned int substream_count;
406 unsigned int substream_opened;
877211f5 407 struct snd_pcm_substream *substream;
1da177e4
LT
408#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
409 /* -- OSS things -- */
877211f5 410 struct snd_pcm_oss_stream oss;
1da177e4 411#endif
b7d90a35 412#ifdef CONFIG_SND_VERBOSE_PROCFS
877211f5
TI
413 struct snd_info_entry *proc_root;
414 struct snd_info_entry *proc_info_entry;
b7d90a35 415#ifdef CONFIG_SND_PCM_XRUN_DEBUG
1da177e4 416 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
877211f5 417 struct snd_info_entry *proc_xrun_debug_entry;
1da177e4 418#endif
b7d90a35 419#endif
1da177e4
LT
420};
421
877211f5
TI
422struct snd_pcm {
423 struct snd_card *card;
f87135f5 424 struct list_head list;
f90c06a2 425 int device; /* device number */
1da177e4
LT
426 unsigned int info_flags;
427 unsigned short dev_class;
428 unsigned short dev_subclass;
429 char id[64];
430 char name[80];
877211f5 431 struct snd_pcm_str streams[2];
1a60d4c5 432 struct mutex open_mutex;
1da177e4
LT
433 wait_queue_head_t open_wait;
434 void *private_data;
877211f5 435 void (*private_free) (struct snd_pcm *pcm);
c78085fc 436 struct device *dev; /* actual hw device this belongs to */
1da177e4 437#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
877211f5 438 struct snd_pcm_oss oss;
1da177e4
LT
439#endif
440};
441
877211f5
TI
442struct snd_pcm_notify {
443 int (*n_register) (struct snd_pcm * pcm);
444 int (*n_disconnect) (struct snd_pcm * pcm);
445 int (*n_unregister) (struct snd_pcm * pcm);
1da177e4 446 struct list_head list;
877211f5 447};
1da177e4
LT
448
449/*
450 * Registering
451 */
452
54047320 453extern const struct file_operations snd_pcm_f_ops[2];
1da177e4 454
e6161653 455int snd_pcm_new(struct snd_card *card, const char *id, int device,
1da177e4 456 int playback_count, int capture_count,
877211f5
TI
457 struct snd_pcm **rpcm);
458int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
1da177e4 459
877211f5 460int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
1da177e4
LT
461
462/*
463 * Native I/O
464 */
465
466extern rwlock_t snd_pcm_link_rwlock;
467
877211f5
TI
468int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
469int snd_pcm_info_user(struct snd_pcm_substream *substream,
470 struct snd_pcm_info __user *info);
471int snd_pcm_status(struct snd_pcm_substream *substream,
472 struct snd_pcm_status *status);
877211f5
TI
473int snd_pcm_start(struct snd_pcm_substream *substream);
474int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
475int snd_pcm_drain_done(struct snd_pcm_substream *substream);
1da177e4 476#ifdef CONFIG_PM
877211f5
TI
477int snd_pcm_suspend(struct snd_pcm_substream *substream);
478int snd_pcm_suspend_all(struct snd_pcm *pcm);
1da177e4 479#endif
877211f5 480int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
3bf75f9b
TI
481int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
482 struct snd_pcm_substream **rsubstream);
877211f5 483void snd_pcm_release_substream(struct snd_pcm_substream *substream);
3bf75f9b
TI
484int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
485 struct snd_pcm_substream **rsubstream);
486void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
1da177e4 487void snd_pcm_vma_notify_data(void *client, void *data);
877211f5 488int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
1da177e4
LT
489
490#if BITS_PER_LONG >= 64
491
492static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
493{
494 *rem = *n % div;
495 *n /= div;
496}
497
498#elif defined(i386)
499
500static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
501{
502 u_int32_t low, high;
503 low = *n & 0xffffffff;
504 high = *n >> 32;
505 if (high) {
506 u_int32_t high1 = high % div;
507 high /= div;
508 asm("divl %2":"=a" (low), "=d" (*rem):"rm" (div), "a" (low), "d" (high1));
509 *n = (u_int64_t)high << 32 | low;
510 } else {
511 *n = low / div;
512 *rem = low % div;
513 }
514}
515#else
516
517static inline void divl(u_int32_t high, u_int32_t low,
518 u_int32_t div,
519 u_int32_t *q, u_int32_t *r)
520{
521 u_int64_t n = (u_int64_t)high << 32 | low;
522 u_int64_t d = (u_int64_t)div << 31;
523 u_int32_t q1 = 0;
524 int c = 32;
525 while (n > 0xffffffffU) {
526 q1 <<= 1;
527 if (n >= d) {
528 n -= d;
529 q1 |= 1;
530 }
531 d >>= 1;
532 c--;
533 }
534 q1 <<= c;
535 if (n) {
536 low = n;
537 *q = q1 | (low / div);
538 *r = low % div;
539 } else {
540 *r = 0;
541 *q = q1;
542 }
543 return;
544}
545
546static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
547{
548 u_int32_t low, high;
549 low = *n & 0xffffffff;
550 high = *n >> 32;
551 if (high) {
552 u_int32_t high1 = high % div;
553 u_int32_t low1 = low;
554 high /= div;
555 divl(high1, low1, div, &low, rem);
556 *n = (u_int64_t)high << 32 | low;
557 } else {
558 *n = low / div;
559 *rem = low % div;
560 }
561}
562#endif
563
564/*
565 * PCM library
566 */
567
877211f5 568static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
1da177e4
LT
569{
570 return substream->group != &substream->self_group;
571}
572
877211f5 573static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
1da177e4
LT
574{
575 read_lock(&snd_pcm_link_rwlock);
576 spin_lock(&substream->self_group.lock);
577}
578
877211f5 579static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
1da177e4
LT
580{
581 spin_unlock(&substream->self_group.lock);
582 read_unlock(&snd_pcm_link_rwlock);
583}
584
877211f5 585static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
1da177e4
LT
586{
587 read_lock_irq(&snd_pcm_link_rwlock);
588 spin_lock(&substream->self_group.lock);
589}
590
877211f5 591static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
1da177e4
LT
592{
593 spin_unlock(&substream->self_group.lock);
594 read_unlock_irq(&snd_pcm_link_rwlock);
595}
596
597#define snd_pcm_stream_lock_irqsave(substream, flags) \
598do { \
599 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
600 spin_lock(&substream->self_group.lock); \
601} while (0)
602
603#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
604do { \
605 spin_unlock(&substream->self_group.lock); \
606 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
607} while (0)
608
ef991b95
TI
609#define snd_pcm_group_for_each_entry(s, substream) \
610 list_for_each_entry(s, &substream->group->substreams, link_list)
1da177e4 611
877211f5 612static inline int snd_pcm_running(struct snd_pcm_substream *substream)
1da177e4
LT
613{
614 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
615 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
616 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
617}
618
877211f5 619static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT
620{
621 return size * 8 / runtime->sample_bits;
622}
623
877211f5 624static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT
625{
626 return size * 8 / runtime->frame_bits;
627}
628
877211f5 629static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT
630{
631 return size * runtime->sample_bits / 8;
632}
633
877211f5 634static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
1da177e4
LT
635{
636 return size * runtime->frame_bits / 8;
637}
638
877211f5 639static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
1da177e4
LT
640{
641 return bytes % runtime->byte_align == 0;
642}
643
877211f5 644static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
1da177e4 645{
877211f5 646 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
647 return frames_to_bytes(runtime, runtime->buffer_size);
648}
649
877211f5 650static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
1da177e4 651{
877211f5 652 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
653 return frames_to_bytes(runtime, runtime->period_size);
654}
655
656/*
657 * result is: 0 ... (boundary - 1)
658 */
877211f5 659static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT
660{
661 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
662 if (avail < 0)
663 avail += runtime->boundary;
664 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
665 avail -= runtime->boundary;
666 return avail;
667}
668
669/*
670 * result is: 0 ... (boundary - 1)
671 */
877211f5 672static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT
673{
674 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
675 if (avail < 0)
676 avail += runtime->boundary;
677 return avail;
678}
679
877211f5 680static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT
681{
682 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
683}
684
877211f5 685static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT
686{
687 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
688}
689
690/**
691 * snd_pcm_playback_ready - check whether the playback buffer is available
692 * @substream: the pcm substream instance
693 *
694 * Checks whether enough free space is available on the playback buffer.
695 *
696 * Returns non-zero if available, or zero if not.
697 */
877211f5 698static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
1da177e4 699{
877211f5 700 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
701 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
702}
703
704/**
705 * snd_pcm_capture_ready - check whether the capture buffer is available
706 * @substream: the pcm substream instance
707 *
708 * Checks whether enough capture data is available on the capture buffer.
709 *
710 * Returns non-zero if available, or zero if not.
711 */
877211f5 712static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
1da177e4 713{
877211f5 714 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
715 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
716}
717
718/**
719 * snd_pcm_playback_data - check whether any data exists on the playback buffer
720 * @substream: the pcm substream instance
721 *
722 * Checks whether any data exists on the playback buffer. If stop_threshold
723 * is bigger or equal to boundary, then this function returns always non-zero.
724 *
725 * Returns non-zero if exists, or zero if not.
726 */
877211f5 727static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
1da177e4 728{
877211f5 729 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
730
731 if (runtime->stop_threshold >= runtime->boundary)
732 return 1;
733 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
734}
735
736/**
737 * snd_pcm_playback_empty - check whether the playback buffer is empty
738 * @substream: the pcm substream instance
739 *
740 * Checks whether the playback buffer is empty.
741 *
742 * Returns non-zero if empty, or zero if not.
743 */
877211f5 744static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
1da177e4 745{
877211f5 746 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
747 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
748}
749
750/**
751 * snd_pcm_capture_empty - check whether the capture buffer is empty
752 * @substream: the pcm substream instance
753 *
754 * Checks whether the capture buffer is empty.
755 *
756 * Returns non-zero if empty, or zero if not.
757 */
877211f5 758static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
1da177e4 759{
877211f5 760 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
761 return snd_pcm_capture_avail(runtime) == 0;
762}
763
877211f5
TI
764static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
765 struct snd_pcm_substream *master)
1da177e4
LT
766{
767 substream->runtime->trigger_master = master;
768}
769
770static inline int hw_is_mask(int var)
771{
772 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
773 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
774}
775
776static inline int hw_is_interval(int var)
777{
778 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
779 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
780}
781
877211f5 782static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
1da177e4
LT
783 snd_pcm_hw_param_t var)
784{
785 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
786}
787
877211f5 788static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
1da177e4
LT
789 snd_pcm_hw_param_t var)
790{
791 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
792}
793
877211f5 794static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
1da177e4
LT
795 snd_pcm_hw_param_t var)
796{
b9f09a48 797 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
1da177e4
LT
798}
799
877211f5 800static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
1da177e4
LT
801 snd_pcm_hw_param_t var)
802{
b9f09a48 803 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
1da177e4
LT
804}
805
806#define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
807#define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
808#define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
809#define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
810#define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
811#define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
812#define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
813#define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
814#define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
815#define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
1da177e4
LT
816
817
877211f5
TI
818int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
819void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
820void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
821void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
822 unsigned int k, struct snd_interval *c);
823void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
824 const struct snd_interval *b, struct snd_interval *c);
825int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
826int snd_interval_ratnum(struct snd_interval *i,
827 unsigned int rats_count, struct snd_ratnum *rats,
1da177e4
LT
828 unsigned int *nump, unsigned int *denp);
829
877211f5
TI
830void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
831void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
877211f5 832int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1da177e4 833
877211f5 834int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1da177e4 835
877211f5
TI
836int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
837int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
1da177e4 838
877211f5 839int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 840 u_int32_t mask);
877211f5 841int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 842 u_int64_t mask);
877211f5 843int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 844 unsigned int min, unsigned int max);
877211f5
TI
845int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
846int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
1da177e4
LT
847 unsigned int cond,
848 snd_pcm_hw_param_t var,
877211f5
TI
849 struct snd_pcm_hw_constraint_list *l);
850int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
1da177e4
LT
851 unsigned int cond,
852 snd_pcm_hw_param_t var,
877211f5
TI
853 struct snd_pcm_hw_constraint_ratnums *r);
854int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
1da177e4
LT
855 unsigned int cond,
856 snd_pcm_hw_param_t var,
877211f5
TI
857 struct snd_pcm_hw_constraint_ratdens *r);
858int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1da177e4
LT
859 unsigned int cond,
860 unsigned int width,
861 unsigned int msbits);
877211f5 862int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1da177e4
LT
863 unsigned int cond,
864 snd_pcm_hw_param_t var,
865 unsigned long step);
877211f5 866int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1da177e4
LT
867 unsigned int cond,
868 snd_pcm_hw_param_t var);
877211f5 869int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
1da177e4
LT
870 unsigned int cond,
871 int var,
872 snd_pcm_hw_rule_func_t func, void *private,
873 int dep, ...);
874
875int snd_pcm_format_signed(snd_pcm_format_t format);
876int snd_pcm_format_unsigned(snd_pcm_format_t format);
877int snd_pcm_format_linear(snd_pcm_format_t format);
878int snd_pcm_format_little_endian(snd_pcm_format_t format);
879int snd_pcm_format_big_endian(snd_pcm_format_t format);
1b44c28d
TI
880#if 0 /* just for DocBook */
881/**
9502dcad
TI
882 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
883 * @format: the format to check
884 *
885 * Returns 1 if the given PCM format is CPU-endian, 0 if
886 * opposite, or a negative error code if endian not specified.
887 */
8cdfd251 888int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1b44c28d 889#endif /* DocBook */
9502dcad 890#ifdef SNDRV_LITTLE_ENDIAN
9d01a82e 891#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
9502dcad 892#else
9d01a82e 893#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
9502dcad 894#endif
1da177e4
LT
895int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
896int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
9502dcad 897ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1da177e4
LT
898const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
899int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
900snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
1da177e4 901
877211f5
TI
902void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
903void snd_pcm_set_sync(struct snd_pcm_substream *substream);
904int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
905int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1da177e4 906 unsigned int cmd, void *arg);
877211f5
TI
907int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
908int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
909int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
910int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
911int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
912void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
877211f5
TI
913void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
914snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
1da177e4
LT
915 const void __user *buf,
916 snd_pcm_uframes_t frames);
877211f5 917snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
1da177e4 918 void __user *buf, snd_pcm_uframes_t frames);
877211f5 919snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1da177e4 920 void __user **bufs, snd_pcm_uframes_t frames);
877211f5 921snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1da177e4
LT
922 void __user **bufs, snd_pcm_uframes_t frames);
923
7653d557
CL
924extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
925
877211f5 926int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
918f3a0e 927unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
1da177e4 928
877211f5 929static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1da177e4
LT
930 struct snd_dma_buffer *bufp)
931{
877211f5 932 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
933 if (bufp) {
934 runtime->dma_buffer_p = bufp;
935 runtime->dma_area = bufp->area;
936 runtime->dma_addr = bufp->addr;
937 runtime->dma_bytes = bufp->bytes;
938 } else {
939 runtime->dma_buffer_p = NULL;
940 runtime->dma_area = NULL;
941 runtime->dma_addr = 0;
942 runtime->dma_bytes = 0;
943 }
944}
945
946/*
947 * Timer interface
948 */
949
877211f5
TI
950void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
951void snd_pcm_timer_init(struct snd_pcm_substream *substream);
952void snd_pcm_timer_done(struct snd_pcm_substream *substream);
1da177e4 953
b751eef1
JK
954static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
955 struct timespec *tv)
956{
957 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
958 do_posix_clock_monotonic_gettime(tv);
959 else
960 getnstimeofday(tv);
961}
962
1da177e4
LT
963/*
964 * Memory
965 */
966
877211f5
TI
967int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
968int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
969int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1da177e4
LT
970 int type, struct device *data,
971 size_t size, size_t max);
877211f5 972int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1da177e4
LT
973 int type, void *data,
974 size_t size, size_t max);
877211f5
TI
975int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
976int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1da177e4 977
77a23f26
TI
978/*
979 * SG-buffer handling
980 */
981#define snd_pcm_substream_sgbuf(substream) \
982 ((substream)->runtime->dma_buffer_p->private_data)
983
984static inline dma_addr_t
985snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
986{
987 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
988 return snd_sgbuf_get_addr(sg, ofs);
989}
990
991static inline void *
992snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
993{
994 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
995 return snd_sgbuf_get_ptr(sg, ofs);
996}
997
998struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
999 unsigned long offset);
51e9f2e6
TI
1000unsigned int snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1001 unsigned int ofs, unsigned int size);
1da177e4
LT
1002
1003/* handle mmap counter - PCM mmap callback should handle this counter properly */
1004static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1005{
877211f5 1006 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
9c323fcb 1007 atomic_inc(&substream->mmap_count);
1da177e4
LT
1008}
1009
1010static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1011{
877211f5 1012 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
9c323fcb 1013 atomic_dec(&substream->mmap_count);
1da177e4
LT
1014}
1015
1016/* mmap for io-memory area */
1017#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1018#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
877211f5 1019int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1da177e4
LT
1020#else
1021#define SNDRV_PCM_INFO_MMAP_IOMEM 0
1022#define snd_pcm_lib_mmap_iomem NULL
1023#endif
1024
1025static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1026{
1027 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1028}
1029
1030/*
1031 * Misc
1032 */
1033
1034#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1035 (IEC958_AES1_CON_ORIGINAL<<8)|\
1036 (IEC958_AES1_CON_PCM_CODER<<8)|\
1037 (IEC958_AES3_CON_FS_48000<<24))
1038
7eaa943c
TI
1039#define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1040
1da177e4 1041#endif /* __SOUND_PCM_H */