]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/sound/pcm.h
projects / mirror_ubuntu-zesty-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge branch 'eseries' into pxa
[mirror_ubuntu-zesty-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>
28#include <linux/poll.h>
f23f6e08 29#include <linux/mm.h>
1da177e4
LT		 30#include <linux/bitops.h>
31
1da177e4
LT		 32#define snd_pcm_substream_chip(substream) ((substream)->private_data)
33#define snd_pcm_chip(pcm) ((pcm)->private_data)
34
1da177e4
LT		 35#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
36#include "pcm_oss.h"
37#endif
38
39/*
40 * Hardware (lowlevel) section
41 */
42
877211f5 43struct snd_pcm_hardware {
1da177e4
LT		 44 unsigned int info; /* SNDRV_PCM_INFO_* */
45 u64 formats; /* SNDRV_PCM_FMTBIT_* */
46 unsigned int rates; /* SNDRV_PCM_RATE_* */
47 unsigned int rate_min; /* min rate */
48 unsigned int rate_max; /* max rate */
49 unsigned int channels_min; /* min channels */
50 unsigned int channels_max; /* max channels */
51 size_t buffer_bytes_max; /* max buffer size */
52 size_t period_bytes_min; /* min period size */
53 size_t period_bytes_max; /* max period size */
54 unsigned int periods_min; /* min # of periods */
55 unsigned int periods_max; /* max # of periods */
56 size_t fifo_size; /* fifo size in bytes */
877211f5 57};
1da177e4 58
e0e6ce03
RD		 59struct snd_pcm_substream;
60
877211f5
TI		 61struct snd_pcm_ops {
62 int (*open)(struct snd_pcm_substream *substream);
63 int (*close)(struct snd_pcm_substream *substream);
64 int (*ioctl)(struct snd_pcm_substream * substream,
1da177e4 65 unsigned int cmd, void *arg);
877211f5
TI		 66 int (*hw_params)(struct snd_pcm_substream *substream,
67 struct snd_pcm_hw_params *params);
68 int (*hw_free)(struct snd_pcm_substream *substream);
69 int (*prepare)(struct snd_pcm_substream *substream);
70 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
71 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
72 int (*copy)(struct snd_pcm_substream *substream, int channel,
73 snd_pcm_uframes_t pos,
1da177e4 74 void __user *buf, snd_pcm_uframes_t count);
877211f5 75 int (*silence)(struct snd_pcm_substream *substream, int channel,
1da177e4 76 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
877211f5
TI		 77 struct page *(*page)(struct snd_pcm_substream *substream,
78 unsigned long offset);
79 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
80 int (*ack)(struct snd_pcm_substream *substream);
81};
1da177e4
LT		 82
83/*
84 *
85 */
86
87#define SNDRV_PCM_DEVICES 8
88
89#define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
90#define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
91
92#define SNDRV_PCM_IOCTL1_RESET 0
93#define SNDRV_PCM_IOCTL1_INFO 1
94#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
95#define SNDRV_PCM_IOCTL1_GSTATE 3
96
97#define SNDRV_PCM_TRIGGER_STOP 0
98#define SNDRV_PCM_TRIGGER_START 1
99#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
100#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
101#define SNDRV_PCM_TRIGGER_SUSPEND 5
102#define SNDRV_PCM_TRIGGER_RESUME 6
103
104#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
105
106/* If you change this don't forget to change rates[] table in pcm_native.c */
107#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
108#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
109#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
110#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
111#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
112#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
113#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
114#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
115#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
116#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
117#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
118#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
119#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
120
121#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
122#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
123
124#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
125 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
126 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
127#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
128#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
129 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
130#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
131 SNDRV_PCM_RATE_192000)
132#define SNDRV_PCM_FMTBIT_S8 (1ULL << SNDRV_PCM_FORMAT_S8)
133#define SNDRV_PCM_FMTBIT_U8 (1ULL << SNDRV_PCM_FORMAT_U8)
134#define SNDRV_PCM_FMTBIT_S16_LE (1ULL << SNDRV_PCM_FORMAT_S16_LE)
135#define SNDRV_PCM_FMTBIT_S16_BE (1ULL << SNDRV_PCM_FORMAT_S16_BE)
136#define SNDRV_PCM_FMTBIT_U16_LE (1ULL << SNDRV_PCM_FORMAT_U16_LE)
137#define SNDRV_PCM_FMTBIT_U16_BE (1ULL << SNDRV_PCM_FORMAT_U16_BE)
138#define SNDRV_PCM_FMTBIT_S24_LE (1ULL << SNDRV_PCM_FORMAT_S24_LE)
139#define SNDRV_PCM_FMTBIT_S24_BE (1ULL << SNDRV_PCM_FORMAT_S24_BE)
140#define SNDRV_PCM_FMTBIT_U24_LE (1ULL << SNDRV_PCM_FORMAT_U24_LE)
141#define SNDRV_PCM_FMTBIT_U24_BE (1ULL << SNDRV_PCM_FORMAT_U24_BE)
142#define SNDRV_PCM_FMTBIT_S32_LE (1ULL << SNDRV_PCM_FORMAT_S32_LE)
143#define SNDRV_PCM_FMTBIT_S32_BE (1ULL << SNDRV_PCM_FORMAT_S32_BE)
144#define SNDRV_PCM_FMTBIT_U32_LE (1ULL << SNDRV_PCM_FORMAT_U32_LE)
145#define SNDRV_PCM_FMTBIT_U32_BE (1ULL << SNDRV_PCM_FORMAT_U32_BE)
146#define SNDRV_PCM_FMTBIT_FLOAT_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
147#define SNDRV_PCM_FMTBIT_FLOAT_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
148#define SNDRV_PCM_FMTBIT_FLOAT64_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
149#define SNDRV_PCM_FMTBIT_FLOAT64_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
150#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
151#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
152#define SNDRV_PCM_FMTBIT_MU_LAW (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
153#define SNDRV_PCM_FMTBIT_A_LAW (1ULL << SNDRV_PCM_FORMAT_A_LAW)
154#define SNDRV_PCM_FMTBIT_IMA_ADPCM (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
155#define SNDRV_PCM_FMTBIT_MPEG (1ULL << SNDRV_PCM_FORMAT_MPEG)
156#define SNDRV_PCM_FMTBIT_GSM (1ULL << SNDRV_PCM_FORMAT_GSM)
157#define SNDRV_PCM_FMTBIT_SPECIAL (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
158#define SNDRV_PCM_FMTBIT_S24_3LE (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
159#define SNDRV_PCM_FMTBIT_U24_3LE (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
160#define SNDRV_PCM_FMTBIT_S24_3BE (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
161#define SNDRV_PCM_FMTBIT_U24_3BE (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
162#define SNDRV_PCM_FMTBIT_S20_3LE (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
163#define SNDRV_PCM_FMTBIT_U20_3LE (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
164#define SNDRV_PCM_FMTBIT_S20_3BE (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
165#define SNDRV_PCM_FMTBIT_U20_3BE (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
166#define SNDRV_PCM_FMTBIT_S18_3LE (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
167#define SNDRV_PCM_FMTBIT_U18_3LE (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
168#define SNDRV_PCM_FMTBIT_S18_3BE (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
169#define SNDRV_PCM_FMTBIT_U18_3BE (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
170
171#ifdef SNDRV_LITTLE_ENDIAN
172#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
173#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
174#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
175#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
176#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
177#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
178#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
179#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
180#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
181#endif
182#ifdef SNDRV_BIG_ENDIAN
183#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
184#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
185#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
186#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
187#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
188#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
189#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
190#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
191#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
192#endif
193
877211f5
TI		 194struct snd_pcm_file {
195 struct snd_pcm_substream *substream;
548a648b 196 int no_compat_mmap;
1da177e4
LT		 197};
198
877211f5
TI		 199struct snd_pcm_hw_rule;
200typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
201 struct snd_pcm_hw_rule *rule);
1da177e4 202
877211f5 203struct snd_pcm_hw_rule {
1da177e4
LT		 204 unsigned int cond;
205 snd_pcm_hw_rule_func_t func;
206 int var;
207 int deps[4];
208 void *private;
209};
210
877211f5
TI		 211struct snd_pcm_hw_constraints {
212 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
1da177e4 213 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
877211f5 214 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
1da177e4
LT		 215 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
216 unsigned int rules_num;
217 unsigned int rules_all;
877211f5
TI		 218 struct snd_pcm_hw_rule *rules;
219};
1da177e4 220
877211f5
TI		 221static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
222 snd_pcm_hw_param_t var)
1da177e4
LT		 223{
224 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
225}
226
877211f5
TI		 227static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
228 snd_pcm_hw_param_t var)
1da177e4
LT		 229{
230 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
231}
232
877211f5 233struct snd_ratnum {
1da177e4
LT		 234 unsigned int num;
235 unsigned int den_min, den_max, den_step;
877211f5 236};
1da177e4 237
877211f5 238struct snd_ratden {
1da177e4
LT		 239 unsigned int num_min, num_max, num_step;
240 unsigned int den;
877211f5 241};
1da177e4 242
877211f5 243struct snd_pcm_hw_constraint_ratnums {
1da177e4 244 int nrats;
877211f5
TI		 245 struct snd_ratnum *rats;
246};
1da177e4 247
877211f5 248struct snd_pcm_hw_constraint_ratdens {
1da177e4 249 int nrats;
877211f5
TI		 250 struct snd_ratden *rats;
251};
1da177e4 252
877211f5 253struct snd_pcm_hw_constraint_list {
1da177e4
LT		 254 unsigned int count;
255 unsigned int *list;
256 unsigned int mask;
877211f5 257};
1da177e4 258
877211f5 259struct snd_pcm_runtime {
1da177e4 260 /* -- Status -- */
877211f5 261 struct snd_pcm_substream *trigger_master;
07799e75 262 struct timespec trigger_tstamp; /* trigger timestamp */
1da177e4
LT		 263 int overrange;
264 snd_pcm_uframes_t avail_max;
265 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
266 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time*/
267
268 /* -- HW params -- */
269 snd_pcm_access_t access; /* access mode */
270 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
271 snd_pcm_subformat_t subformat; /* subformat */
272 unsigned int rate; /* rate in Hz */
273 unsigned int channels; /* channels */
274 snd_pcm_uframes_t period_size; /* period size */
275 unsigned int periods; /* periods */
276 snd_pcm_uframes_t buffer_size; /* buffer size */
1da177e4
LT		 277 snd_pcm_uframes_t min_align; /* Min alignment for the format */
278 size_t byte_align;
279 unsigned int frame_bits;
280 unsigned int sample_bits;
281 unsigned int info;
282 unsigned int rate_num;
283 unsigned int rate_den;
284
285 /* -- SW params -- */
877211f5 286 int tstamp_mode; /* mmap timestamp is updated */
1da177e4 287 unsigned int period_step;
1da177e4
LT		 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 */
294
295 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
296 snd_pcm_uframes_t silence_filled; /* size filled with silence */
297
877211f5 298 union snd_pcm_sync_id sync; /* hardware synchronization ID */
1da177e4
LT		 299
300 /* -- mmap -- */
503fc85a
TI		 301 struct snd_pcm_mmap_status *status;
302 struct snd_pcm_mmap_control *control;
1da177e4
LT		 303
304 /* -- locking / scheduling -- */
305 wait_queue_head_t sleep;
1da177e4
LT		 306 struct fasync_struct *fasync;
307
308 /* -- private section -- */
309 void *private_data;
877211f5 310 void (*private_free)(struct snd_pcm_runtime *runtime);
1da177e4
LT		 311
312 /* -- hardware description -- */
877211f5
TI		 313 struct snd_pcm_hardware hw;
314 struct snd_pcm_hw_constraints hw_constraints;
1da177e4
LT		 315
316 /* -- interrupt callbacks -- */
877211f5
TI		 317 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
318 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
1da177e4
LT		 319
320 /* -- timer -- */
321 unsigned int timer_resolution; /* timer resolution */
b751eef1 322 int tstamp_type; /* timestamp type */
1da177e4
LT		 323
324 /* -- DMA -- */
325 unsigned char *dma_area; /* DMA area */
326 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
327 size_t dma_bytes; /* size of DMA area */
328
329 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
330
331#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
332 /* -- OSS things -- */
877211f5 333 struct snd_pcm_oss_runtime oss;
1da177e4
LT		 334#endif
335};
336
877211f5 337struct snd_pcm_group { /* keep linked substreams */
1da177e4
LT		 338 spinlock_t lock;
339 struct list_head substreams;
340 int count;
877211f5 341};
1da177e4 342
877211f5
TI		 343struct snd_pcm_substream {
344 struct snd_pcm *pcm;
345 struct snd_pcm_str *pstr;
1da177e4
LT		 346 void *private_data; /* copied from pcm->private_data */
347 int number;
348 char name[32]; /* substream name */
349 int stream; /* stream (direction) */
9442e691 350 char latency_id[20]; /* latency identifier */
1da177e4
LT		 351 size_t buffer_bytes_max; /* limit ring buffer size */
352 struct snd_dma_buffer dma_buffer;
353 unsigned int dma_buf_id;
354 size_t dma_max;
355 /* -- hardware operations -- */
877211f5 356 struct snd_pcm_ops *ops;
1da177e4 357 /* -- runtime information -- */
877211f5 358 struct snd_pcm_runtime *runtime;
1da177e4 359 /* -- timer section -- */
877211f5 360 struct snd_timer *timer; /* timer */
1da177e4
LT		 361 unsigned timer_running: 1; /* time is running */
362 spinlock_t timer_lock;
363 /* -- next substream -- */
877211f5 364 struct snd_pcm_substream *next;
1da177e4
LT		 365 /* -- linked substreams -- */
366 struct list_head link_list; /* linked list member */
877211f5
TI		 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 */
1da177e4 369 /* -- assigned files -- */
1576274d 370 void *file;
0df63e44 371 int ref_count;
9c323fcb 372 atomic_t mmap_count;
0df63e44 373 unsigned int f_flags;
3bf75f9b 374 void (*pcm_release)(struct snd_pcm_substream *);
1da177e4
LT		 375#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
376 /* -- OSS things -- */
877211f5 377 struct snd_pcm_oss_substream oss;
1da177e4 378#endif
b7d90a35 379#ifdef CONFIG_SND_VERBOSE_PROCFS
877211f5
TI		 380 struct snd_info_entry *proc_root;
381 struct snd_info_entry *proc_info_entry;
382 struct snd_info_entry *proc_hw_params_entry;
383 struct snd_info_entry *proc_sw_params_entry;
384 struct snd_info_entry *proc_status_entry;
385 struct snd_info_entry *proc_prealloc_entry;
c7132aeb 386 struct snd_info_entry *proc_prealloc_max_entry;
b7d90a35 387#endif
1da177e4 388 /* misc flags */
3bf75f9b 389 unsigned int hw_opened: 1;
1da177e4
LT		 390};
391
0df63e44 392#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
1da177e4
LT		 393
394
877211f5 395struct snd_pcm_str {
1da177e4 396 int stream; /* stream (direction) */
877211f5 397 struct snd_pcm *pcm;
1da177e4
LT		 398 /* -- substreams -- */
399 unsigned int substream_count;
400 unsigned int substream_opened;
877211f5 401 struct snd_pcm_substream *substream;
1da177e4
LT		 402#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
403 /* -- OSS things -- */
877211f5 404 struct snd_pcm_oss_stream oss;
1da177e4 405#endif
b7d90a35 406#ifdef CONFIG_SND_VERBOSE_PROCFS
877211f5
TI		 407 struct snd_info_entry *proc_root;
408 struct snd_info_entry *proc_info_entry;
b7d90a35 409#ifdef CONFIG_SND_PCM_XRUN_DEBUG
1da177e4 410 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
877211f5 411 struct snd_info_entry *proc_xrun_debug_entry;
1da177e4 412#endif
b7d90a35 413#endif
1da177e4
LT		 414};
415
877211f5
TI		 416struct snd_pcm {
417 struct snd_card *card;
f87135f5 418 struct list_head list;
1da177e4
LT		 419 unsigned int device; /* device number */
420 unsigned int info_flags;
421 unsigned short dev_class;
422 unsigned short dev_subclass;
423 char id[64];
424 char name[80];
877211f5 425 struct snd_pcm_str streams[2];
1a60d4c5 426 struct mutex open_mutex;
1da177e4
LT		 427 wait_queue_head_t open_wait;
428 void *private_data;
877211f5 429 void (*private_free) (struct snd_pcm *pcm);
c78085fc 430 struct device *dev; /* actual hw device this belongs to */
1da177e4 431#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
877211f5 432 struct snd_pcm_oss oss;
1da177e4
LT		 433#endif
434};
435
877211f5
TI		 436struct snd_pcm_notify {
437 int (*n_register) (struct snd_pcm * pcm);
438 int (*n_disconnect) (struct snd_pcm * pcm);
439 int (*n_unregister) (struct snd_pcm * pcm);
1da177e4 440 struct list_head list;
877211f5 441};
1da177e4
LT		 442
443/*
444 * Registering
445 */
446
54047320 447extern const struct file_operations snd_pcm_f_ops[2];
1da177e4 448
877211f5 449int snd_pcm_new(struct snd_card *card, char *id, int device,
1da177e4 450 int playback_count, int capture_count,
877211f5
TI		 451 struct snd_pcm **rpcm);
452int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
1da177e4 453
877211f5 454int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
1da177e4
LT		 455
456/*
457 * Native I/O
458 */
459
460extern rwlock_t snd_pcm_link_rwlock;
461
877211f5
TI		 462int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
463int snd_pcm_info_user(struct snd_pcm_substream *substream,
464 struct snd_pcm_info __user *info);
465int snd_pcm_status(struct snd_pcm_substream *substream,
466 struct snd_pcm_status *status);
877211f5
TI		 467int snd_pcm_start(struct snd_pcm_substream *substream);
468int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
469int snd_pcm_drain_done(struct snd_pcm_substream *substream);
1da177e4 470#ifdef CONFIG_PM
877211f5
TI		 471int snd_pcm_suspend(struct snd_pcm_substream *substream);
472int snd_pcm_suspend_all(struct snd_pcm *pcm);
1da177e4 473#endif
877211f5 474int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
3bf75f9b
TI		 475int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
476 struct snd_pcm_substream **rsubstream);
877211f5 477void snd_pcm_release_substream(struct snd_pcm_substream *substream);
3bf75f9b
TI		 478int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
479 struct snd_pcm_substream **rsubstream);
480void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
1da177e4 481void snd_pcm_vma_notify_data(void *client, void *data);
877211f5 482int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
1da177e4
LT		 483
484#if BITS_PER_LONG >= 64
485
486static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
487{
488 *rem = *n % div;
489 *n /= div;
490}
491
492#elif defined(i386)
493
494static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
495{
496 u_int32_t low, high;
497 low = *n & 0xffffffff;
498 high = *n >> 32;
499 if (high) {
500 u_int32_t high1 = high % div;
501 high /= div;
502 asm("divl %2":"=a" (low), "=d" (*rem):"rm" (div), "a" (low), "d" (high1));
503 *n = (u_int64_t)high << 32 | low;
504 } else {
505 *n = low / div;
506 *rem = low % div;
507 }
508}
509#else
510
511static inline void divl(u_int32_t high, u_int32_t low,
512 u_int32_t div,
513 u_int32_t *q, u_int32_t *r)
514{
515 u_int64_t n = (u_int64_t)high << 32 | low;
516 u_int64_t d = (u_int64_t)div << 31;
517 u_int32_t q1 = 0;
518 int c = 32;
519 while (n > 0xffffffffU) {
520 q1 <<= 1;
521 if (n >= d) {
522 n -= d;
523 q1 |= 1;
524 }
525 d >>= 1;
526 c--;
527 }
528 q1 <<= c;
529 if (n) {
530 low = n;
531 *q = q1 | (low / div);
532 *r = low % div;
533 } else {
534 *r = 0;
535 *q = q1;
536 }
537 return;
538}
539
540static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
541{
542 u_int32_t low, high;
543 low = *n & 0xffffffff;
544 high = *n >> 32;
545 if (high) {
546 u_int32_t high1 = high % div;
547 u_int32_t low1 = low;
548 high /= div;
549 divl(high1, low1, div, &low, rem);
550 *n = (u_int64_t)high << 32 | low;
551 } else {
552 *n = low / div;
553 *rem = low % div;
554 }
555}
556#endif
557
558/*
559 * PCM library
560 */
561
877211f5 562static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
1da177e4
LT		 563{
564 return substream->group != &substream->self_group;
565}
566
877211f5 567static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
1da177e4
LT		 568{
569 read_lock(&snd_pcm_link_rwlock);
570 spin_lock(&substream->self_group.lock);
571}
572
877211f5 573static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
1da177e4
LT		 574{
575 spin_unlock(&substream->self_group.lock);
576 read_unlock(&snd_pcm_link_rwlock);
577}
578
877211f5 579static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
1da177e4
LT		 580{
581 read_lock_irq(&snd_pcm_link_rwlock);
582 spin_lock(&substream->self_group.lock);
583}
584
877211f5 585static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
1da177e4
LT		 586{
587 spin_unlock(&substream->self_group.lock);
588 read_unlock_irq(&snd_pcm_link_rwlock);
589}
590
591#define snd_pcm_stream_lock_irqsave(substream, flags) \
592do { \
593 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
594 spin_lock(&substream->self_group.lock); \
595} while (0)
596
597#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
598do { \
599 spin_unlock(&substream->self_group.lock); \
600 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
601} while (0)
602
ef991b95
TI		 603#define snd_pcm_group_for_each_entry(s, substream) \
604 list_for_each_entry(s, &substream->group->substreams, link_list)
1da177e4 605
877211f5 606static inline int snd_pcm_running(struct snd_pcm_substream *substream)
1da177e4
LT		 607{
608 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
609 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
610 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
611}
612
877211f5 613static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT		 614{
615 return size * 8 / runtime->sample_bits;
616}
617
877211f5 618static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT		 619{
620 return size * 8 / runtime->frame_bits;
621}
622
877211f5 623static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT		 624{
625 return size * runtime->sample_bits / 8;
626}
627
877211f5 628static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
1da177e4
LT		 629{
630 return size * runtime->frame_bits / 8;
631}
632
877211f5 633static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
1da177e4
LT		 634{
635 return bytes % runtime->byte_align == 0;
636}
637
877211f5 638static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
1da177e4 639{
877211f5 640 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 641 return frames_to_bytes(runtime, runtime->buffer_size);
642}
643
877211f5 644static inline size_t snd_pcm_lib_period_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->period_size);
648}
649
650/*
651 * result is: 0 ... (boundary - 1)
652 */
877211f5 653static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 654{
655 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
656 if (avail < 0)
657 avail += runtime->boundary;
658 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
659 avail -= runtime->boundary;
660 return avail;
661}
662
663/*
664 * result is: 0 ... (boundary - 1)
665 */
877211f5 666static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 667{
668 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
669 if (avail < 0)
670 avail += runtime->boundary;
671 return avail;
672}
673
877211f5 674static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 675{
676 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
677}
678
877211f5 679static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 680{
681 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
682}
683
684/**
685 * snd_pcm_playback_ready - check whether the playback buffer is available
686 * @substream: the pcm substream instance
687 *
688 * Checks whether enough free space is available on the playback buffer.
689 *
690 * Returns non-zero if available, or zero if not.
691 */
877211f5 692static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
1da177e4 693{
877211f5 694 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 695 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
696}
697
698/**
699 * snd_pcm_capture_ready - check whether the capture buffer is available
700 * @substream: the pcm substream instance
701 *
702 * Checks whether enough capture data is available on the capture buffer.
703 *
704 * Returns non-zero if available, or zero if not.
705 */
877211f5 706static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
1da177e4 707{
877211f5 708 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 709 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
710}
711
712/**
713 * snd_pcm_playback_data - check whether any data exists on the playback buffer
714 * @substream: the pcm substream instance
715 *
716 * Checks whether any data exists on the playback buffer. If stop_threshold
717 * is bigger or equal to boundary, then this function returns always non-zero.
718 *
719 * Returns non-zero if exists, or zero if not.
720 */
877211f5 721static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
1da177e4 722{
877211f5 723 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 724
725 if (runtime->stop_threshold >= runtime->boundary)
726 return 1;
727 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
728}
729
730/**
731 * snd_pcm_playback_empty - check whether the playback buffer is empty
732 * @substream: the pcm substream instance
733 *
734 * Checks whether the playback buffer is empty.
735 *
736 * Returns non-zero if empty, or zero if not.
737 */
877211f5 738static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
1da177e4 739{
877211f5 740 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 741 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
742}
743
744/**
745 * snd_pcm_capture_empty - check whether the capture buffer is empty
746 * @substream: the pcm substream instance
747 *
748 * Checks whether the capture buffer is empty.
749 *
750 * Returns non-zero if empty, or zero if not.
751 */
877211f5 752static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
1da177e4 753{
877211f5 754 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 755 return snd_pcm_capture_avail(runtime) == 0;
756}
757
877211f5
TI		 758static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
759 struct snd_pcm_substream *master)
1da177e4
LT		 760{
761 substream->runtime->trigger_master = master;
762}
763
764static inline int hw_is_mask(int var)
765{
766 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
767 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
768}
769
770static inline int hw_is_interval(int var)
771{
772 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
773 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
774}
775
877211f5 776static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
1da177e4
LT		 777 snd_pcm_hw_param_t var)
778{
779 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
780}
781
877211f5 782static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
1da177e4
LT		 783 snd_pcm_hw_param_t var)
784{
785 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
786}
787
877211f5 788static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
1da177e4
LT		 789 snd_pcm_hw_param_t var)
790{
b9f09a48 791 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
1da177e4
LT		 792}
793
877211f5 794static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
1da177e4
LT		 795 snd_pcm_hw_param_t var)
796{
b9f09a48 797 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
1da177e4
LT		 798}
799
800#define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
801#define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
802#define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
803#define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
804#define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
805#define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
806#define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
807#define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
808#define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
809#define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
1da177e4
LT		 810
811
877211f5
TI		 812int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
813void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
814void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
815void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
816 unsigned int k, struct snd_interval *c);
817void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
818 const struct snd_interval *b, struct snd_interval *c);
819int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
820int snd_interval_ratnum(struct snd_interval *i,
821 unsigned int rats_count, struct snd_ratnum *rats,
1da177e4
LT		 822 unsigned int *nump, unsigned int *denp);
823
877211f5
TI		 824void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
825void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
877211f5 826int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1da177e4 827
877211f5 828int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1da177e4 829
877211f5
TI		 830int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
831int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
1da177e4 832
877211f5 833int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 834 u_int32_t mask);
877211f5 835int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 836 u_int64_t mask);
877211f5 837int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 838 unsigned int min, unsigned int max);
877211f5
TI		 839int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
840int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
1da177e4
LT		 841 unsigned int cond,
842 snd_pcm_hw_param_t var,
877211f5
TI		 843 struct snd_pcm_hw_constraint_list *l);
844int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
1da177e4
LT		 845 unsigned int cond,
846 snd_pcm_hw_param_t var,
877211f5
TI		 847 struct snd_pcm_hw_constraint_ratnums *r);
848int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
1da177e4
LT		 849 unsigned int cond,
850 snd_pcm_hw_param_t var,
877211f5
TI		 851 struct snd_pcm_hw_constraint_ratdens *r);
852int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1da177e4
LT		 853 unsigned int cond,
854 unsigned int width,
855 unsigned int msbits);
877211f5 856int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1da177e4
LT		 857 unsigned int cond,
858 snd_pcm_hw_param_t var,
859 unsigned long step);
877211f5 860int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1da177e4
LT		 861 unsigned int cond,
862 snd_pcm_hw_param_t var);
877211f5 863int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
1da177e4
LT		 864 unsigned int cond,
865 int var,
866 snd_pcm_hw_rule_func_t func, void *private,
867 int dep, ...);
868
869int snd_pcm_format_signed(snd_pcm_format_t format);
870int snd_pcm_format_unsigned(snd_pcm_format_t format);
871int snd_pcm_format_linear(snd_pcm_format_t format);
872int snd_pcm_format_little_endian(snd_pcm_format_t format);
873int snd_pcm_format_big_endian(snd_pcm_format_t format);
1b44c28d
TI		 874#if 0 /* just for DocBook */
875/**
9502dcad
TI		 876 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
877 * @format: the format to check
878 *
879 * Returns 1 if the given PCM format is CPU-endian, 0 if
880 * opposite, or a negative error code if endian not specified.
881 */
8cdfd251 882int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1b44c28d 883#endif /* DocBook */
9502dcad 884#ifdef SNDRV_LITTLE_ENDIAN
9d01a82e 885#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
9502dcad 886#else
9d01a82e 887#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
9502dcad 888#endif
1da177e4
LT		 889int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
890int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
9502dcad 891ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1da177e4
LT		 892const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
893int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
894snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
1da177e4 895
877211f5
TI		 896void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
897void snd_pcm_set_sync(struct snd_pcm_substream *substream);
898int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
899int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1da177e4 900 unsigned int cmd, void *arg);
877211f5
TI		 901int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
902int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
903int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
904int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
905int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
906void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
877211f5
TI		 907void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
908snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
1da177e4
LT		 909 const void __user *buf,
910 snd_pcm_uframes_t frames);
877211f5 911snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
1da177e4 912 void __user *buf, snd_pcm_uframes_t frames);
877211f5 913snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1da177e4 914 void __user **bufs, snd_pcm_uframes_t frames);
877211f5 915snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1da177e4
LT		 916 void __user **bufs, snd_pcm_uframes_t frames);
917
7653d557
CL		 918extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
919
877211f5 920int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
918f3a0e 921unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
1da177e4 922
877211f5 923static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1da177e4
LT		 924 struct snd_dma_buffer *bufp)
925{
877211f5 926 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 927 if (bufp) {
928 runtime->dma_buffer_p = bufp;
929 runtime->dma_area = bufp->area;
930 runtime->dma_addr = bufp->addr;
931 runtime->dma_bytes = bufp->bytes;
932 } else {
933 runtime->dma_buffer_p = NULL;
934 runtime->dma_area = NULL;
935 runtime->dma_addr = 0;
936 runtime->dma_bytes = 0;
937 }
938}
939
940/*
941 * Timer interface
942 */
943
877211f5
TI		 944void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
945void snd_pcm_timer_init(struct snd_pcm_substream *substream);
946void snd_pcm_timer_done(struct snd_pcm_substream *substream);
1da177e4 947
b751eef1
JK		 948static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
949 struct timespec *tv)
950{
951 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
952 do_posix_clock_monotonic_gettime(tv);
953 else
954 getnstimeofday(tv);
955}
956
1da177e4
LT		 957/*
958 * Memory
959 */
960
877211f5
TI		 961int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
962int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
963int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1da177e4
LT		 964 int type, struct device *data,
965 size_t size, size_t max);
877211f5 966int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1da177e4
LT		 967 int type, void *data,
968 size_t size, size_t max);
877211f5
TI		 969int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
970int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1da177e4
LT		 971
972#define snd_pcm_substream_sgbuf(substream) ((substream)->runtime->dma_buffer_p->private_data)
973#define snd_pcm_sgbuf_pages(size) snd_sgbuf_aligned_pages(size)
974#define snd_pcm_sgbuf_get_addr(sgbuf,ofs) snd_sgbuf_get_addr(sgbuf,ofs)
877211f5 975struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, unsigned long offset);
1da177e4
LT		 976
977/* handle mmap counter - PCM mmap callback should handle this counter properly */
978static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
979{
877211f5 980 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
9c323fcb 981 atomic_inc(&substream->mmap_count);
1da177e4
LT		 982}
983
984static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
985{
877211f5 986 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
9c323fcb 987 atomic_dec(&substream->mmap_count);
1da177e4
LT		 988}
989
990/* mmap for io-memory area */
991#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
992#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
877211f5 993int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1da177e4
LT		 994#else
995#define SNDRV_PCM_INFO_MMAP_IOMEM 0
996#define snd_pcm_lib_mmap_iomem NULL
997#endif
998
999static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1000{
1001 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1002}
1003
1004/*
1005 * Misc
1006 */
1007
1008#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1009 (IEC958_AES1_CON_ORIGINAL<<8)|\
1010 (IEC958_AES1_CON_PCM_CODER<<8)|\
1011 (IEC958_AES3_CON_FS_48000<<24))
1012
1013#endif /* __SOUND_PCM_H */
ubuntu-zesty-kernel mirror