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