projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ALSA: core: keep track of boundary wrap-around
[deliverable/linux.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 31#include <linux/bitops.h>
e8db0be1 32#include <linux/pm_qos.h>
1da177e4 33
1da177e4
LT		 34#define snd_pcm_substream_chip(substream) ((substream)->private_data)
35#define snd_pcm_chip(pcm) ((pcm)->private_data)
36
1da177e4 37#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
a1ce3928 38#include <sound/pcm_oss.h>
1da177e4
LT		 39#endif
40
41/*
42 * Hardware (lowlevel) section
43 */
44
877211f5 45struct snd_pcm_hardware {
1da177e4
LT		 46 unsigned int info; /* SNDRV_PCM_INFO_* */
47 u64 formats; /* SNDRV_PCM_FMTBIT_* */
48 unsigned int rates; /* SNDRV_PCM_RATE_* */
49 unsigned int rate_min; /* min rate */
50 unsigned int rate_max; /* max rate */
51 unsigned int channels_min; /* min channels */
52 unsigned int channels_max; /* max channels */
53 size_t buffer_bytes_max; /* max buffer size */
54 size_t period_bytes_min; /* min period size */
55 size_t period_bytes_max; /* max period size */
56 unsigned int periods_min; /* min # of periods */
57 unsigned int periods_max; /* max # of periods */
58 size_t fifo_size; /* fifo size in bytes */
877211f5 59};
1da177e4 60
e0e6ce03
RD		 61struct snd_pcm_substream;
62
877211f5
TI		 63struct snd_pcm_ops {
64 int (*open)(struct snd_pcm_substream *substream);
65 int (*close)(struct snd_pcm_substream *substream);
66 int (*ioctl)(struct snd_pcm_substream * substream,
1da177e4 67 unsigned int cmd, void *arg);
877211f5
TI		 68 int (*hw_params)(struct snd_pcm_substream *substream,
69 struct snd_pcm_hw_params *params);
70 int (*hw_free)(struct snd_pcm_substream *substream);
71 int (*prepare)(struct snd_pcm_substream *substream);
72 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
73 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
74 int (*copy)(struct snd_pcm_substream *substream, int channel,
75 snd_pcm_uframes_t pos,
1da177e4 76 void __user *buf, snd_pcm_uframes_t count);
877211f5 77 int (*silence)(struct snd_pcm_substream *substream, int channel,
1da177e4 78 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
877211f5
TI		 79 struct page *(*page)(struct snd_pcm_substream *substream,
80 unsigned long offset);
81 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
82 int (*ack)(struct snd_pcm_substream *substream);
83};
1da177e4
LT		 84
85/*
86 *
87 */
88
f90c06a2
PM		 89#if defined(CONFIG_SND_DYNAMIC_MINORS)
90#define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
91#else
92#define SNDRV_PCM_DEVICES 8
93#endif
896e6cc2 94
1da177e4
LT		 95#define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
96#define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
97
98#define SNDRV_PCM_IOCTL1_RESET 0
99#define SNDRV_PCM_IOCTL1_INFO 1
100#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
101#define SNDRV_PCM_IOCTL1_GSTATE 3
8bea869c 102#define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
1da177e4
LT		 103
104#define SNDRV_PCM_TRIGGER_STOP 0
105#define SNDRV_PCM_TRIGGER_START 1
106#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
107#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
108#define SNDRV_PCM_TRIGGER_SUSPEND 5
109#define SNDRV_PCM_TRIGGER_RESUME 6
110
111#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
112
113/* If you change this don't forget to change rates[] table in pcm_native.c */
114#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
115#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
116#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
117#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
118#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
119#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
120#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
121#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
122#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
123#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
124#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
125#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
126#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
127
128#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
129#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
130
131#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
132 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
133 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
134#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
135#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
136 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
137#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
138 SNDRV_PCM_RATE_192000)
fea952e5
CL		 139#define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
140#define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
141#define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
142#define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
143#define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
144#define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
145#define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
146#define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
147#define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
148#define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
149#define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
150#define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE)
151#define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE)
152#define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE)
153#define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE)
154#define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE)
155#define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE)
156#define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE)
157#define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE)
158#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
159#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
160#define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW)
161#define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW)
162#define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM)
163#define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG)
164#define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM)
165#define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
166#define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
167#define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
168#define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
169#define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
170#define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
171#define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
172#define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
173#define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
174#define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
175#define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
176#define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
177#define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
178#define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
179#define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
180#define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
181#define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
1da177e4
LT		 182
183#ifdef SNDRV_LITTLE_ENDIAN
184#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
185#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
186#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
187#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
188#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
189#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
190#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
191#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
192#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
193#endif
194#ifdef SNDRV_BIG_ENDIAN
195#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
196#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
197#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
198#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
199#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
200#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
201#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
202#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
203#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
204#endif
205
877211f5
TI		 206struct snd_pcm_file {
207 struct snd_pcm_substream *substream;
548a648b 208 int no_compat_mmap;
1da177e4
LT		 209};
210
877211f5
TI		 211struct snd_pcm_hw_rule;
212typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
213 struct snd_pcm_hw_rule *rule);
1da177e4 214
877211f5 215struct snd_pcm_hw_rule {
1da177e4
LT		 216 unsigned int cond;
217 snd_pcm_hw_rule_func_t func;
218 int var;
219 int deps[4];
220 void *private;
221};
222
877211f5
TI		 223struct snd_pcm_hw_constraints {
224 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
1da177e4 225 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
877211f5 226 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
1da177e4
LT		 227 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
228 unsigned int rules_num;
229 unsigned int rules_all;
877211f5
TI		 230 struct snd_pcm_hw_rule *rules;
231};
1da177e4 232
877211f5
TI		 233static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
234 snd_pcm_hw_param_t var)
1da177e4
LT		 235{
236 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
237}
238
877211f5
TI		 239static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
240 snd_pcm_hw_param_t var)
1da177e4
LT		 241{
242 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
243}
244
877211f5 245struct snd_ratnum {
1da177e4
LT		 246 unsigned int num;
247 unsigned int den_min, den_max, den_step;
877211f5 248};
1da177e4 249
877211f5 250struct snd_ratden {
1da177e4
LT		 251 unsigned int num_min, num_max, num_step;
252 unsigned int den;
877211f5 253};
1da177e4 254
877211f5 255struct snd_pcm_hw_constraint_ratnums {
1da177e4 256 int nrats;
877211f5
TI		 257 struct snd_ratnum *rats;
258};
1da177e4 259
877211f5 260struct snd_pcm_hw_constraint_ratdens {
1da177e4 261 int nrats;
877211f5
TI		 262 struct snd_ratden *rats;
263};
1da177e4 264
877211f5 265struct snd_pcm_hw_constraint_list {
1da177e4 266 unsigned int count;
4af87a93 267 const unsigned int *list;
1da177e4 268 unsigned int mask;
877211f5 269};
1da177e4 270
4d96eb25
JK		 271struct snd_pcm_hwptr_log;
272
877211f5 273struct snd_pcm_runtime {
1da177e4 274 /* -- Status -- */
877211f5 275 struct snd_pcm_substream *trigger_master;
07799e75 276 struct timespec trigger_tstamp; /* trigger timestamp */
1da177e4
LT		 277 int overrange;
278 snd_pcm_uframes_t avail_max;
279 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
e7636925 280 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
bbf6ad13 281 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
bd76af0f 282 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
4bbe1ddf 283 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
0e8014d7 284 u64 hw_ptr_wrap; /* offset for hw_ptr due to boundary wrap-around */
1da177e4
LT		 285
286 /* -- HW params -- */
287 snd_pcm_access_t access; /* access mode */
288 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
289 snd_pcm_subformat_t subformat; /* subformat */
290 unsigned int rate; /* rate in Hz */
291 unsigned int channels; /* channels */
292 snd_pcm_uframes_t period_size; /* period size */
293 unsigned int periods; /* periods */
294 snd_pcm_uframes_t buffer_size; /* buffer size */
1da177e4
LT		 295 snd_pcm_uframes_t min_align; /* Min alignment for the format */
296 size_t byte_align;
297 unsigned int frame_bits;
298 unsigned int sample_bits;
299 unsigned int info;
300 unsigned int rate_num;
301 unsigned int rate_den;
ab69a490 302 unsigned int no_period_wakeup: 1;
1da177e4
LT		 303
304 /* -- SW params -- */
877211f5 305 int tstamp_mode; /* mmap timestamp is updated */
1da177e4 306 unsigned int period_step;
1da177e4
LT		 307 snd_pcm_uframes_t start_threshold;
308 snd_pcm_uframes_t stop_threshold;
309 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
310 noise is nearest than this */
311 snd_pcm_uframes_t silence_size; /* Silence filling size */
312 snd_pcm_uframes_t boundary; /* pointers wrap point */
313
314 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
315 snd_pcm_uframes_t silence_filled; /* size filled with silence */
316
877211f5 317 union snd_pcm_sync_id sync; /* hardware synchronization ID */
1da177e4
LT		 318
319 /* -- mmap -- */
503fc85a
TI		 320 struct snd_pcm_mmap_status *status;
321 struct snd_pcm_mmap_control *control;
1da177e4
LT		 322
323 /* -- locking / scheduling -- */
5daeba34 324 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
c91a988d
JK		 325 wait_queue_head_t sleep; /* poll sleep */
326 wait_queue_head_t tsleep; /* transfer sleep */
1da177e4
LT		 327 struct fasync_struct *fasync;
328
329 /* -- private section -- */
330 void *private_data;
877211f5 331 void (*private_free)(struct snd_pcm_runtime *runtime);
1da177e4
LT		 332
333 /* -- hardware description -- */
877211f5
TI		 334 struct snd_pcm_hardware hw;
335 struct snd_pcm_hw_constraints hw_constraints;
1da177e4
LT		 336
337 /* -- interrupt callbacks -- */
877211f5
TI		 338 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
339 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
1da177e4
LT		 340
341 /* -- timer -- */
342 unsigned int timer_resolution; /* timer resolution */
b751eef1 343 int tstamp_type; /* timestamp type */
1da177e4
LT		 344
345 /* -- DMA -- */
346 unsigned char *dma_area; /* DMA area */
347 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
348 size_t dma_bytes; /* size of DMA area */
349
350 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
351
352#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
353 /* -- OSS things -- */
877211f5 354 struct snd_pcm_oss_runtime oss;
1da177e4 355#endif
4d96eb25
JK		 356
357#ifdef CONFIG_SND_PCM_XRUN_DEBUG
358 struct snd_pcm_hwptr_log *hwptr_log;
359#endif
1da177e4
LT		 360};
361
877211f5 362struct snd_pcm_group { /* keep linked substreams */
1da177e4
LT		 363 spinlock_t lock;
364 struct list_head substreams;
365 int count;
877211f5 366};
1da177e4 367
e7373b70
CL		 368struct pid;
369
877211f5
TI		 370struct snd_pcm_substream {
371 struct snd_pcm *pcm;
372 struct snd_pcm_str *pstr;
1da177e4
LT		 373 void *private_data; /* copied from pcm->private_data */
374 int number;
375 char name[32]; /* substream name */
376 int stream; /* stream (direction) */
cc749986 377 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
1da177e4
LT		 378 size_t buffer_bytes_max; /* limit ring buffer size */
379 struct snd_dma_buffer dma_buffer;
380 unsigned int dma_buf_id;
381 size_t dma_max;
382 /* -- hardware operations -- */
877211f5 383 struct snd_pcm_ops *ops;
1da177e4 384 /* -- runtime information -- */
877211f5 385 struct snd_pcm_runtime *runtime;
1da177e4 386 /* -- timer section -- */
877211f5 387 struct snd_timer *timer; /* timer */
1da177e4 388 unsigned timer_running: 1; /* time is running */
1da177e4 389 /* -- next substream -- */
877211f5 390 struct snd_pcm_substream *next;
1da177e4
LT		 391 /* -- linked substreams -- */
392 struct list_head link_list; /* linked list member */
877211f5
TI		 393 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
394 struct snd_pcm_group *group; /* pointer to current group */
1da177e4 395 /* -- assigned files -- */
1576274d 396 void *file;
0df63e44 397 int ref_count;
9c323fcb 398 atomic_t mmap_count;
0df63e44 399 unsigned int f_flags;
3bf75f9b 400 void (*pcm_release)(struct snd_pcm_substream *);
e7373b70 401 struct pid *pid;
1da177e4
LT		 402#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
403 /* -- OSS things -- */
877211f5 404 struct snd_pcm_oss_substream 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;
409 struct snd_info_entry *proc_hw_params_entry;
410 struct snd_info_entry *proc_sw_params_entry;
411 struct snd_info_entry *proc_status_entry;
412 struct snd_info_entry *proc_prealloc_entry;
c7132aeb 413 struct snd_info_entry *proc_prealloc_max_entry;
b7d90a35 414#endif
1da177e4 415 /* misc flags */
3bf75f9b 416 unsigned int hw_opened: 1;
1da177e4
LT		 417};
418
0df63e44 419#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
1da177e4
LT		 420
421
877211f5 422struct snd_pcm_str {
1da177e4 423 int stream; /* stream (direction) */
877211f5 424 struct snd_pcm *pcm;
1da177e4
LT		 425 /* -- substreams -- */
426 unsigned int substream_count;
427 unsigned int substream_opened;
877211f5 428 struct snd_pcm_substream *substream;
1da177e4
LT		 429#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
430 /* -- OSS things -- */
877211f5 431 struct snd_pcm_oss_stream oss;
1da177e4 432#endif
b7d90a35 433#ifdef CONFIG_SND_VERBOSE_PROCFS
877211f5
TI		 434 struct snd_info_entry *proc_root;
435 struct snd_info_entry *proc_info_entry;
b7d90a35 436#ifdef CONFIG_SND_PCM_XRUN_DEBUG
1da177e4 437 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
877211f5 438 struct snd_info_entry *proc_xrun_debug_entry;
1da177e4 439#endif
b7d90a35 440#endif
2d3391ec 441 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
1da177e4
LT		 442};
443
877211f5
TI		 444struct snd_pcm {
445 struct snd_card *card;
f87135f5 446 struct list_head list;
f90c06a2 447 int device; /* device number */
1da177e4
LT		 448 unsigned int info_flags;
449 unsigned short dev_class;
450 unsigned short dev_subclass;
451 char id[64];
452 char name[80];
877211f5 453 struct snd_pcm_str streams[2];
1a60d4c5 454 struct mutex open_mutex;
1da177e4
LT		 455 wait_queue_head_t open_wait;
456 void *private_data;
877211f5 457 void (*private_free) (struct snd_pcm *pcm);
c78085fc 458 struct device *dev; /* actual hw device this belongs to */
945e5038 459 bool internal; /* pcm is for internal use only */
1da177e4 460#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
877211f5 461 struct snd_pcm_oss oss;
1da177e4
LT		 462#endif
463};
464
877211f5
TI		 465struct snd_pcm_notify {
466 int (*n_register) (struct snd_pcm * pcm);
467 int (*n_disconnect) (struct snd_pcm * pcm);
468 int (*n_unregister) (struct snd_pcm * pcm);
1da177e4 469 struct list_head list;
877211f5 470};
1da177e4
LT		 471
472/*
473 * Registering
474 */
475
54047320 476extern const struct file_operations snd_pcm_f_ops[2];
1da177e4 477
e6161653 478int snd_pcm_new(struct snd_card *card, const char *id, int device,
1da177e4 479 int playback_count, int capture_count,
877211f5 480 struct snd_pcm **rpcm);
945e5038
LG		 481int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
482 int playback_count, int capture_count,
483 struct snd_pcm **rpcm);
877211f5 484int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
1da177e4 485
877211f5 486int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
1da177e4
LT		 487
488/*
489 * Native I/O
490 */
491
492extern rwlock_t snd_pcm_link_rwlock;
493
877211f5
TI		 494int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
495int snd_pcm_info_user(struct snd_pcm_substream *substream,
496 struct snd_pcm_info __user *info);
497int snd_pcm_status(struct snd_pcm_substream *substream,
498 struct snd_pcm_status *status);
877211f5 499int snd_pcm_start(struct snd_pcm_substream *substream);
fea952e5 500int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
877211f5 501int snd_pcm_drain_done(struct snd_pcm_substream *substream);
1da177e4 502#ifdef CONFIG_PM
877211f5
TI		 503int snd_pcm_suspend(struct snd_pcm_substream *substream);
504int snd_pcm_suspend_all(struct snd_pcm *pcm);
1da177e4 505#endif
877211f5 506int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
3bf75f9b
TI		 507int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
508 struct snd_pcm_substream **rsubstream);
877211f5 509void snd_pcm_release_substream(struct snd_pcm_substream *substream);
3bf75f9b
TI		 510int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
511 struct snd_pcm_substream **rsubstream);
512void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
1da177e4 513void snd_pcm_vma_notify_data(void *client, void *data);
877211f5 514int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
1da177e4 515
acb03d44
EB		 516
517#ifdef CONFIG_SND_DEBUG
518void snd_pcm_debug_name(struct snd_pcm_substream *substream,
519 char *name, size_t len);
520#else
521static inline void
522snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
523{
524 *buf = 0;
525}
526#endif
527
1da177e4
LT		 528/*
529 * PCM library
530 */
531
877211f5 532static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
1da177e4
LT		 533{
534 return substream->group != &substream->self_group;
535}
536
877211f5 537static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
1da177e4
LT		 538{
539 read_lock(&snd_pcm_link_rwlock);
540 spin_lock(&substream->self_group.lock);
541}
542
877211f5 543static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
1da177e4
LT		 544{
545 spin_unlock(&substream->self_group.lock);
546 read_unlock(&snd_pcm_link_rwlock);
547}
548
877211f5 549static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
1da177e4
LT		 550{
551 read_lock_irq(&snd_pcm_link_rwlock);
552 spin_lock(&substream->self_group.lock);
553}
554
877211f5 555static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
1da177e4
LT		 556{
557 spin_unlock(&substream->self_group.lock);
558 read_unlock_irq(&snd_pcm_link_rwlock);
559}
560
561#define snd_pcm_stream_lock_irqsave(substream, flags) \
562do { \
563 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
564 spin_lock(&substream->self_group.lock); \
565} while (0)
566
567#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
568do { \
569 spin_unlock(&substream->self_group.lock); \
570 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
571} while (0)
572
ef991b95
TI		 573#define snd_pcm_group_for_each_entry(s, substream) \
574 list_for_each_entry(s, &substream->group->substreams, link_list)
1da177e4 575
877211f5 576static inline int snd_pcm_running(struct snd_pcm_substream *substream)
1da177e4
LT		 577{
578 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
579 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
580 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
581}
582
877211f5 583static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT		 584{
585 return size * 8 / runtime->sample_bits;
586}
587
877211f5 588static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT		 589{
590 return size * 8 / runtime->frame_bits;
591}
592
877211f5 593static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT		 594{
595 return size * runtime->sample_bits / 8;
596}
597
877211f5 598static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
1da177e4
LT		 599{
600 return size * runtime->frame_bits / 8;
601}
602
877211f5 603static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
1da177e4
LT		 604{
605 return bytes % runtime->byte_align == 0;
606}
607
877211f5 608static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
1da177e4 609{
877211f5 610 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 611 return frames_to_bytes(runtime, runtime->buffer_size);
612}
613
877211f5 614static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
1da177e4 615{
877211f5 616 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 617 return frames_to_bytes(runtime, runtime->period_size);
618}
619
620/*
621 * result is: 0 ... (boundary - 1)
622 */
877211f5 623static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 624{
625 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
626 if (avail < 0)
627 avail += runtime->boundary;
628 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
629 avail -= runtime->boundary;
630 return avail;
631}
632
633/*
634 * result is: 0 ... (boundary - 1)
635 */
877211f5 636static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 637{
638 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
639 if (avail < 0)
640 avail += runtime->boundary;
641 return avail;
642}
643
877211f5 644static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 645{
646 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
647}
648
877211f5 649static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 650{
651 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
652}
653
654/**
655 * snd_pcm_playback_ready - check whether the playback buffer is available
656 * @substream: the pcm substream instance
657 *
658 * Checks whether enough free space is available on the playback buffer.
659 *
660 * Returns non-zero if available, or zero if not.
661 */
877211f5 662static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
1da177e4 663{
877211f5 664 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 665 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
666}
667
668/**
669 * snd_pcm_capture_ready - check whether the capture buffer is available
670 * @substream: the pcm substream instance
671 *
672 * Checks whether enough capture data is available on the capture buffer.
673 *
674 * Returns non-zero if available, or zero if not.
675 */
877211f5 676static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
1da177e4 677{
877211f5 678 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 679 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
680}
681
682/**
683 * snd_pcm_playback_data - check whether any data exists on the playback buffer
684 * @substream: the pcm substream instance
685 *
686 * Checks whether any data exists on the playback buffer. If stop_threshold
687 * is bigger or equal to boundary, then this function returns always non-zero.
688 *
689 * Returns non-zero if exists, or zero if not.
690 */
877211f5 691static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
1da177e4 692{
877211f5 693 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 694
695 if (runtime->stop_threshold >= runtime->boundary)
696 return 1;
697 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
698}
699
700/**
701 * snd_pcm_playback_empty - check whether the playback buffer is empty
702 * @substream: the pcm substream instance
703 *
704 * Checks whether the playback buffer is empty.
705 *
706 * Returns non-zero if empty, or zero if not.
707 */
877211f5 708static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
1da177e4 709{
877211f5 710 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 711 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
712}
713
714/**
715 * snd_pcm_capture_empty - check whether the capture buffer is empty
716 * @substream: the pcm substream instance
717 *
718 * Checks whether the capture buffer is empty.
719 *
720 * Returns non-zero if empty, or zero if not.
721 */
877211f5 722static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
1da177e4 723{
877211f5 724 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 725 return snd_pcm_capture_avail(runtime) == 0;
726}
727
877211f5
TI		 728static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
729 struct snd_pcm_substream *master)
1da177e4
LT		 730{
731 substream->runtime->trigger_master = master;
732}
733
734static inline int hw_is_mask(int var)
735{
736 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
737 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
738}
739
740static inline int hw_is_interval(int var)
741{
742 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
743 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
744}
745
877211f5 746static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
1da177e4
LT		 747 snd_pcm_hw_param_t var)
748{
749 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
750}
751
877211f5 752static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
1da177e4
LT		 753 snd_pcm_hw_param_t var)
754{
755 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
756}
757
877211f5 758static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
1da177e4
LT		 759 snd_pcm_hw_param_t var)
760{
b9f09a48 761 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
1da177e4
LT		 762}
763
877211f5 764static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
1da177e4
LT		 765 snd_pcm_hw_param_t var)
766{
b9f09a48 767 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
1da177e4
LT		 768}
769
b51beb75
TI		 770#define params_channels(p) \
771 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min)
772#define params_rate(p) \
773 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min)
774#define params_period_size(p) \
775 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min)
776#define params_periods(p) \
777 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min)
778#define params_buffer_size(p) \
779 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min)
780#define params_buffer_bytes(p) \
781 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min)
1da177e4 782
877211f5
TI		 783int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
784void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
785void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
786void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
787 unsigned int k, struct snd_interval *c);
788void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
789 const struct snd_interval *b, struct snd_interval *c);
4af87a93
MB		 790int snd_interval_list(struct snd_interval *i, unsigned int count,
791 const unsigned int *list, unsigned int mask);
877211f5
TI		 792int snd_interval_ratnum(struct snd_interval *i,
793 unsigned int rats_count, struct snd_ratnum *rats,
1da177e4
LT		 794 unsigned int *nump, unsigned int *denp);
795
877211f5
TI		 796void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
797void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
877211f5 798int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1da177e4 799
877211f5 800int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1da177e4 801
877211f5
TI		 802int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
803int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
1da177e4 804
877211f5 805int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 806 u_int32_t mask);
877211f5 807int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 808 u_int64_t mask);
877211f5 809int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 810 unsigned int min, unsigned int max);
877211f5
TI		 811int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
812int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
1da177e4
LT		 813 unsigned int cond,
814 snd_pcm_hw_param_t var,
1464189f 815 const struct snd_pcm_hw_constraint_list *l);
877211f5 816int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
1da177e4
LT		 817 unsigned int cond,
818 snd_pcm_hw_param_t var,
877211f5
TI		 819 struct snd_pcm_hw_constraint_ratnums *r);
820int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
1da177e4
LT		 821 unsigned int cond,
822 snd_pcm_hw_param_t var,
877211f5
TI		 823 struct snd_pcm_hw_constraint_ratdens *r);
824int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1da177e4
LT		 825 unsigned int cond,
826 unsigned int width,
827 unsigned int msbits);
877211f5 828int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1da177e4
LT		 829 unsigned int cond,
830 snd_pcm_hw_param_t var,
831 unsigned long step);
877211f5 832int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1da177e4
LT		 833 unsigned int cond,
834 snd_pcm_hw_param_t var);
d5b702a6
CL		 835int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
836 unsigned int base_rate);
877211f5 837int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
1da177e4
LT		 838 unsigned int cond,
839 int var,
840 snd_pcm_hw_rule_func_t func, void *private,
841 int dep, ...);
842
843int snd_pcm_format_signed(snd_pcm_format_t format);
844int snd_pcm_format_unsigned(snd_pcm_format_t format);
845int snd_pcm_format_linear(snd_pcm_format_t format);
846int snd_pcm_format_little_endian(snd_pcm_format_t format);
847int snd_pcm_format_big_endian(snd_pcm_format_t format);
1b44c28d
TI		 848#if 0 /* just for DocBook */
849/**
9502dcad
TI		 850 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
851 * @format: the format to check
852 *
853 * Returns 1 if the given PCM format is CPU-endian, 0 if
854 * opposite, or a negative error code if endian not specified.
855 */
8cdfd251 856int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1b44c28d 857#endif /* DocBook */
9502dcad 858#ifdef SNDRV_LITTLE_ENDIAN
9d01a82e 859#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
9502dcad 860#else
9d01a82e 861#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
9502dcad 862#endif
1da177e4
LT		 863int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
864int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
9502dcad 865ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1da177e4
LT		 866const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
867int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
868snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
1da177e4 869
877211f5
TI		 870void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
871void snd_pcm_set_sync(struct snd_pcm_substream *substream);
872int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
873int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1da177e4 874 unsigned int cmd, void *arg);
1250932e
JK		 875int snd_pcm_update_state(struct snd_pcm_substream *substream,
876 struct snd_pcm_runtime *runtime);
877211f5
TI		 877int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
878int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
879int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
880int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
881int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
882void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
877211f5
TI		 883void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
884snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
1da177e4
LT		 885 const void __user *buf,
886 snd_pcm_uframes_t frames);
877211f5 887snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
1da177e4 888 void __user *buf, snd_pcm_uframes_t frames);
877211f5 889snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1da177e4 890 void __user **bufs, snd_pcm_uframes_t frames);
877211f5 891snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1da177e4
LT		 892 void __user **bufs, snd_pcm_uframes_t frames);
893
7653d557
CL		 894extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
895
877211f5 896int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
918f3a0e 897unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
4be77a53 898unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
1da177e4 899
877211f5 900static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1da177e4
LT		 901 struct snd_dma_buffer *bufp)
902{
877211f5 903 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 904 if (bufp) {
905 runtime->dma_buffer_p = bufp;
906 runtime->dma_area = bufp->area;
907 runtime->dma_addr = bufp->addr;
908 runtime->dma_bytes = bufp->bytes;
909 } else {
910 runtime->dma_buffer_p = NULL;
911 runtime->dma_area = NULL;
912 runtime->dma_addr = 0;
913 runtime->dma_bytes = 0;
914 }
915}
916
917/*
918 * Timer interface
919 */
920
877211f5
TI		 921void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
922void snd_pcm_timer_init(struct snd_pcm_substream *substream);
923void snd_pcm_timer_done(struct snd_pcm_substream *substream);
1da177e4 924
b751eef1
JK		 925static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
926 struct timespec *tv)
927{
928 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
929 do_posix_clock_monotonic_gettime(tv);
930 else
931 getnstimeofday(tv);
932}
933
1da177e4
LT		 934/*
935 * Memory
936 */
937
877211f5
TI		 938int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
939int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
940int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1da177e4
LT		 941 int type, struct device *data,
942 size_t size, size_t max);
877211f5 943int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1da177e4
LT		 944 int type, void *data,
945 size_t size, size_t max);
877211f5
TI		 946int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
947int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1da177e4 948
681b84e1
CL		 949int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
950 size_t size, gfp_t gfp_flags);
951int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
952struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
953 unsigned long offset);
954#if 0 /* for kernel-doc */
955/**
956 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
957 * @substream: the substream to allocate the buffer to
958 * @size: the requested buffer size, in bytes
959 *
960 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
961 * contiguous in kernel virtual space, but not in physical memory. Use this
962 * if the buffer is accessed by kernel code but not by device DMA.
963 *
964 * Returns 1 if the buffer was changed, 0 if not changed, or a negative error
965 * code.
966 */
967static int snd_pcm_lib_alloc_vmalloc_buffer
968 (struct snd_pcm_substream *substream, size_t size);
969/**
970 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
971 * @substream: the substream to allocate the buffer to
972 * @size: the requested buffer size, in bytes
973 *
974 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
975 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
976 */
977static int snd_pcm_lib_alloc_vmalloc_32_buffer
978 (struct snd_pcm_substream *substream, size_t size);
979#endif
980#define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
981 _snd_pcm_lib_alloc_vmalloc_buffer \
982 (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
983#define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
984 _snd_pcm_lib_alloc_vmalloc_buffer \
985 (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
986
9d069dc0
TI		 987#define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
988
cc6a8acd 989#ifdef CONFIG_SND_DMA_SGBUF
77a23f26
TI		 990/*
991 * SG-buffer handling
992 */
993#define snd_pcm_substream_sgbuf(substream) \
9d069dc0 994 snd_pcm_get_dma_buf(substream)->private_data
77a23f26
TI		 995
996struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
997 unsigned long offset);
cc6a8acd
TI		 998#else /* !SND_DMA_SGBUF */
999/*
1000 * fake using a continuous buffer
1001 */
9d069dc0
TI		 1002#define snd_pcm_sgbuf_ops_page NULL
1003#endif /* SND_DMA_SGBUF */
1004
cc6a8acd
TI		 1005static inline dma_addr_t
1006snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1007{
9d069dc0 1008 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
cc6a8acd
TI		 1009}
1010
1011static inline void *
1012snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1013{
9d069dc0 1014 return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
cc6a8acd
TI		 1015}
1016
9d069dc0
TI		 1017static inline unsigned int
1018snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1019 unsigned int ofs, unsigned int size)
1020{
1021 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1022}
cc6a8acd 1023
1da177e4
LT		 1024/* handle mmap counter - PCM mmap callback should handle this counter properly */
1025static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1026{
877211f5 1027 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
9c323fcb 1028 atomic_inc(&substream->mmap_count);
1da177e4
LT		 1029}
1030
1031static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1032{
877211f5 1033 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
9c323fcb 1034 atomic_dec(&substream->mmap_count);
1da177e4
LT		 1035}
1036
18a2b962
TI		 1037int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1038 struct vm_area_struct *area);
1da177e4
LT		 1039/* mmap for io-memory area */
1040#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1041#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
877211f5 1042int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1da177e4
LT		 1043#else
1044#define SNDRV_PCM_INFO_MMAP_IOMEM 0
1045#define snd_pcm_lib_mmap_iomem NULL
1046#endif
1047
3674f19d 1048#define snd_pcm_lib_mmap_vmalloc NULL
c32d977b 1049
1da177e4
LT		 1050static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1051{
1052 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1053}
1054
1055/*
1056 * Misc
1057 */
1058
1059#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1060 (IEC958_AES1_CON_ORIGINAL<<8)|\
1061 (IEC958_AES1_CON_PCM_CODER<<8)|\
1062 (IEC958_AES3_CON_FS_48000<<24))
1063
7eaa943c
TI		 1064#define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1065
6e5265ec
TI		 1066const char *snd_pcm_format_name(snd_pcm_format_t format);
1067
1aad779f 1068/**
8513915a
RD		 1069 * snd_pcm_stream_str - Get a string naming the direction of a stream
1070 * @substream: the pcm substream instance
1aad779f
OL		 1071 */
1072static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1073{
1074 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1075 return "Playback";
1076 else
1077 return "Capture";
1078}
1079
2d3391ec
TI		 1080/*
1081 * PCM channel-mapping control API
1082 */
1083/* array element of channel maps */
1084struct snd_pcm_chmap_elem {
1085 unsigned char channels;
1086 unsigned char map[15];
1087};
1088
1089/* channel map information; retrieved via snd_kcontrol_chip() */
1090struct snd_pcm_chmap {
1091 struct snd_pcm *pcm; /* assigned PCM instance */
1092 int stream; /* PLAYBACK or CAPTURE */
1093 struct snd_kcontrol *kctl;
1094 const struct snd_pcm_chmap_elem *chmap;
1095 unsigned int max_channels;
1096 unsigned int channel_mask; /* optional: active channels bitmask */
1097 void *private_data; /* optional: private data pointer */
1098};
1099
1100/* get the PCM substream assigned to the given chmap info */
1101static inline struct snd_pcm_substream *
1102snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1103{
1104 struct snd_pcm_substream *s;
1105 for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1106 if (s->number == idx)
1107 return s;
1108 return NULL;
1109}
1110
1111/* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1112extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1113/* Other world's standard channel maps (C/LFE prior to RL/RR) */
1114extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1115
1116/* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1117#define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1118#define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1119#define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1120
1121int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1122 const struct snd_pcm_chmap_elem *chmap,
1123 int max_channels,
1124 unsigned long private_value,
1125 struct snd_pcm_chmap **info_ret);
1126
1da177e4 1127#endif /* __SOUND_PCM_H */
Linux kernel - Deliverables
This page took 0.750735 seconds and 5 git commands to generate.