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