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