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