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