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