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