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