xref: /openbmc/linux/include/sound/pcm.h (revision ff6defa6)
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.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 <sound/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 (*wall_clock)(struct snd_pcm_substream *substream,
75 			  struct timespec *audio_ts);
76 	int (*copy)(struct snd_pcm_substream *substream, int channel,
77 		    snd_pcm_uframes_t pos,
78 		    void __user *buf, snd_pcm_uframes_t count);
79 	int (*silence)(struct snd_pcm_substream *substream, int channel,
80 		       snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
81 	struct page *(*page)(struct snd_pcm_substream *substream,
82 			     unsigned long offset);
83 	int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
84 	int (*ack)(struct snd_pcm_substream *substream);
85 };
86 
87 /*
88  *
89  */
90 
91 #if defined(CONFIG_SND_DYNAMIC_MINORS)
92 #define SNDRV_PCM_DEVICES	(SNDRV_OS_MINORS-2)
93 #else
94 #define SNDRV_PCM_DEVICES	8
95 #endif
96 
97 #define SNDRV_PCM_IOCTL1_RESET		0
98 #define SNDRV_PCM_IOCTL1_INFO		1
99 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO	2
100 #define SNDRV_PCM_IOCTL1_GSTATE		3
101 #define SNDRV_PCM_IOCTL1_FIFO_SIZE	4
102 
103 #define SNDRV_PCM_TRIGGER_STOP		0
104 #define SNDRV_PCM_TRIGGER_START		1
105 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH	3
106 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE	4
107 #define SNDRV_PCM_TRIGGER_SUSPEND	5
108 #define SNDRV_PCM_TRIGGER_RESUME	6
109 #define SNDRV_PCM_TRIGGER_DRAIN		7
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 #define SNDRV_PCM_FMTBIT_DSD_U8		_SNDRV_PCM_FMTBIT(DSD_U8)
183 #define SNDRV_PCM_FMTBIT_DSD_U16_LE	_SNDRV_PCM_FMTBIT(DSD_U16_LE)
184 #define SNDRV_PCM_FMTBIT_DSD_U32_LE	_SNDRV_PCM_FMTBIT(DSD_U32_LE)
185 #define SNDRV_PCM_FMTBIT_DSD_U16_BE	_SNDRV_PCM_FMTBIT(DSD_U16_BE)
186 #define SNDRV_PCM_FMTBIT_DSD_U32_BE	_SNDRV_PCM_FMTBIT(DSD_U32_BE)
187 
188 #ifdef SNDRV_LITTLE_ENDIAN
189 #define SNDRV_PCM_FMTBIT_S16		SNDRV_PCM_FMTBIT_S16_LE
190 #define SNDRV_PCM_FMTBIT_U16		SNDRV_PCM_FMTBIT_U16_LE
191 #define SNDRV_PCM_FMTBIT_S24		SNDRV_PCM_FMTBIT_S24_LE
192 #define SNDRV_PCM_FMTBIT_U24		SNDRV_PCM_FMTBIT_U24_LE
193 #define SNDRV_PCM_FMTBIT_S32		SNDRV_PCM_FMTBIT_S32_LE
194 #define SNDRV_PCM_FMTBIT_U32		SNDRV_PCM_FMTBIT_U32_LE
195 #define SNDRV_PCM_FMTBIT_FLOAT		SNDRV_PCM_FMTBIT_FLOAT_LE
196 #define SNDRV_PCM_FMTBIT_FLOAT64	SNDRV_PCM_FMTBIT_FLOAT64_LE
197 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
198 #endif
199 #ifdef SNDRV_BIG_ENDIAN
200 #define SNDRV_PCM_FMTBIT_S16		SNDRV_PCM_FMTBIT_S16_BE
201 #define SNDRV_PCM_FMTBIT_U16		SNDRV_PCM_FMTBIT_U16_BE
202 #define SNDRV_PCM_FMTBIT_S24		SNDRV_PCM_FMTBIT_S24_BE
203 #define SNDRV_PCM_FMTBIT_U24		SNDRV_PCM_FMTBIT_U24_BE
204 #define SNDRV_PCM_FMTBIT_S32		SNDRV_PCM_FMTBIT_S32_BE
205 #define SNDRV_PCM_FMTBIT_U32		SNDRV_PCM_FMTBIT_U32_BE
206 #define SNDRV_PCM_FMTBIT_FLOAT		SNDRV_PCM_FMTBIT_FLOAT_BE
207 #define SNDRV_PCM_FMTBIT_FLOAT64	SNDRV_PCM_FMTBIT_FLOAT64_BE
208 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
209 #endif
210 
211 struct snd_pcm_file {
212 	struct snd_pcm_substream *substream;
213 	int no_compat_mmap;
214 };
215 
216 struct snd_pcm_hw_rule;
217 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
218 				      struct snd_pcm_hw_rule *rule);
219 
220 struct snd_pcm_hw_rule {
221 	unsigned int cond;
222 	snd_pcm_hw_rule_func_t func;
223 	int var;
224 	int deps[4];
225 	void *private;
226 };
227 
228 struct snd_pcm_hw_constraints {
229 	struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
230 			 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
231 	struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
232 			     SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
233 	unsigned int rules_num;
234 	unsigned int rules_all;
235 	struct snd_pcm_hw_rule *rules;
236 };
237 
238 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
239 					    snd_pcm_hw_param_t var)
240 {
241 	return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
242 }
243 
244 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
245 						    snd_pcm_hw_param_t var)
246 {
247 	return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
248 }
249 
250 struct snd_ratnum {
251 	unsigned int num;
252 	unsigned int den_min, den_max, den_step;
253 };
254 
255 struct snd_ratden {
256 	unsigned int num_min, num_max, num_step;
257 	unsigned int den;
258 };
259 
260 struct snd_pcm_hw_constraint_ratnums {
261 	int nrats;
262 	struct snd_ratnum *rats;
263 };
264 
265 struct snd_pcm_hw_constraint_ratdens {
266 	int nrats;
267 	struct snd_ratden *rats;
268 };
269 
270 struct snd_pcm_hw_constraint_list {
271 	unsigned int count;
272 	const unsigned int *list;
273 	unsigned int mask;
274 };
275 
276 struct snd_pcm_hwptr_log;
277 
278 struct snd_pcm_runtime {
279 	/* -- Status -- */
280 	struct snd_pcm_substream *trigger_master;
281 	struct timespec trigger_tstamp;	/* trigger timestamp */
282 	int overrange;
283 	snd_pcm_uframes_t avail_max;
284 	snd_pcm_uframes_t hw_ptr_base;	/* Position at buffer restart */
285 	snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
286 	unsigned long hw_ptr_jiffies;	/* Time when hw_ptr is updated */
287 	unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
288 	snd_pcm_sframes_t delay;	/* extra delay; typically FIFO size */
289 	u64 hw_ptr_wrap;                /* offset for hw_ptr due to boundary wrap-around */
290 
291 	/* -- HW params -- */
292 	snd_pcm_access_t access;	/* access mode */
293 	snd_pcm_format_t format;	/* SNDRV_PCM_FORMAT_* */
294 	snd_pcm_subformat_t subformat;	/* subformat */
295 	unsigned int rate;		/* rate in Hz */
296 	unsigned int channels;		/* channels */
297 	snd_pcm_uframes_t period_size;	/* period size */
298 	unsigned int periods;		/* periods */
299 	snd_pcm_uframes_t buffer_size;	/* buffer size */
300 	snd_pcm_uframes_t min_align;	/* Min alignment for the format */
301 	size_t byte_align;
302 	unsigned int frame_bits;
303 	unsigned int sample_bits;
304 	unsigned int info;
305 	unsigned int rate_num;
306 	unsigned int rate_den;
307 	unsigned int no_period_wakeup: 1;
308 
309 	/* -- SW params -- */
310 	int tstamp_mode;		/* mmap timestamp is updated */
311   	unsigned int period_step;
312 	snd_pcm_uframes_t start_threshold;
313 	snd_pcm_uframes_t stop_threshold;
314 	snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
315 						noise is nearest than this */
316 	snd_pcm_uframes_t silence_size;	/* Silence filling size */
317 	snd_pcm_uframes_t boundary;	/* pointers wrap point */
318 
319 	snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
320 	snd_pcm_uframes_t silence_filled; /* size filled with silence */
321 
322 	union snd_pcm_sync_id sync;	/* hardware synchronization ID */
323 
324 	/* -- mmap -- */
325 	struct snd_pcm_mmap_status *status;
326 	struct snd_pcm_mmap_control *control;
327 
328 	/* -- locking / scheduling -- */
329 	snd_pcm_uframes_t twake; 	/* do transfer (!poll) wakeup if non-zero */
330 	wait_queue_head_t sleep;	/* poll sleep */
331 	wait_queue_head_t tsleep;	/* transfer sleep */
332 	struct fasync_struct *fasync;
333 
334 	/* -- private section -- */
335 	void *private_data;
336 	void (*private_free)(struct snd_pcm_runtime *runtime);
337 
338 	/* -- hardware description -- */
339 	struct snd_pcm_hardware hw;
340 	struct snd_pcm_hw_constraints hw_constraints;
341 
342 	/* -- interrupt callbacks -- */
343 	void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
344 	void (*transfer_ack_end)(struct snd_pcm_substream *substream);
345 
346 	/* -- timer -- */
347 	unsigned int timer_resolution;	/* timer resolution */
348 	int tstamp_type;		/* timestamp type */
349 
350 	/* -- DMA -- */
351 	unsigned char *dma_area;	/* DMA area */
352 	dma_addr_t dma_addr;		/* physical bus address (not accessible from main CPU) */
353 	size_t dma_bytes;		/* size of DMA area */
354 
355 	struct snd_dma_buffer *dma_buffer_p;	/* allocated buffer */
356 
357 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
358 	/* -- OSS things -- */
359 	struct snd_pcm_oss_runtime oss;
360 #endif
361 
362 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
363 	struct snd_pcm_hwptr_log *hwptr_log;
364 #endif
365 };
366 
367 struct snd_pcm_group {		/* keep linked substreams */
368 	spinlock_t lock;
369 	struct mutex mutex;
370 	struct list_head substreams;
371 	int count;
372 };
373 
374 struct pid;
375 
376 struct snd_pcm_substream {
377 	struct snd_pcm *pcm;
378 	struct snd_pcm_str *pstr;
379 	void *private_data;		/* copied from pcm->private_data */
380 	int number;
381 	char name[32];			/* substream name */
382 	int stream;			/* stream (direction) */
383 	struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
384 	size_t buffer_bytes_max;	/* limit ring buffer size */
385 	struct snd_dma_buffer dma_buffer;
386 	size_t dma_max;
387 	/* -- hardware operations -- */
388 	const struct snd_pcm_ops *ops;
389 	/* -- runtime information -- */
390 	struct snd_pcm_runtime *runtime;
391         /* -- timer section -- */
392 	struct snd_timer *timer;		/* timer */
393 	unsigned timer_running: 1;	/* time is running */
394 	/* -- next substream -- */
395 	struct snd_pcm_substream *next;
396 	/* -- linked substreams -- */
397 	struct list_head link_list;	/* linked list member */
398 	struct snd_pcm_group self_group;	/* fake group for non linked substream (with substream lock inside) */
399 	struct snd_pcm_group *group;		/* pointer to current group */
400 	/* -- assigned files -- */
401 	void *file;
402 	int ref_count;
403 	atomic_t mmap_count;
404 	unsigned int f_flags;
405 	void (*pcm_release)(struct snd_pcm_substream *);
406 	struct pid *pid;
407 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
408 	/* -- OSS things -- */
409 	struct snd_pcm_oss_substream oss;
410 #endif
411 #ifdef CONFIG_SND_VERBOSE_PROCFS
412 	struct snd_info_entry *proc_root;
413 	struct snd_info_entry *proc_info_entry;
414 	struct snd_info_entry *proc_hw_params_entry;
415 	struct snd_info_entry *proc_sw_params_entry;
416 	struct snd_info_entry *proc_status_entry;
417 	struct snd_info_entry *proc_prealloc_entry;
418 	struct snd_info_entry *proc_prealloc_max_entry;
419 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
420 	struct snd_info_entry *proc_xrun_injection_entry;
421 #endif
422 #endif /* CONFIG_SND_VERBOSE_PROCFS */
423 	/* misc flags */
424 	unsigned int hw_opened: 1;
425 };
426 
427 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
428 
429 
430 struct snd_pcm_str {
431 	int stream;				/* stream (direction) */
432 	struct snd_pcm *pcm;
433 	/* -- substreams -- */
434 	unsigned int substream_count;
435 	unsigned int substream_opened;
436 	struct snd_pcm_substream *substream;
437 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
438 	/* -- OSS things -- */
439 	struct snd_pcm_oss_stream oss;
440 #endif
441 #ifdef CONFIG_SND_VERBOSE_PROCFS
442 	struct snd_info_entry *proc_root;
443 	struct snd_info_entry *proc_info_entry;
444 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
445 	unsigned int xrun_debug;	/* 0 = disabled, 1 = verbose, 2 = stacktrace */
446 	struct snd_info_entry *proc_xrun_debug_entry;
447 #endif
448 #endif
449 	struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
450 };
451 
452 struct snd_pcm {
453 	struct snd_card *card;
454 	struct list_head list;
455 	int device; /* device number */
456 	unsigned int info_flags;
457 	unsigned short dev_class;
458 	unsigned short dev_subclass;
459 	char id[64];
460 	char name[80];
461 	struct snd_pcm_str streams[2];
462 	struct mutex open_mutex;
463 	wait_queue_head_t open_wait;
464 	void *private_data;
465 	void (*private_free) (struct snd_pcm *pcm);
466 	struct device *dev; /* actual hw device this belongs to */
467 	bool internal; /* pcm is for internal use only */
468 	bool nonatomic; /* whole PCM operations are in non-atomic context */
469 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
470 	struct snd_pcm_oss oss;
471 #endif
472 };
473 
474 struct snd_pcm_notify {
475 	int (*n_register) (struct snd_pcm * pcm);
476 	int (*n_disconnect) (struct snd_pcm * pcm);
477 	int (*n_unregister) (struct snd_pcm * pcm);
478 	struct list_head list;
479 };
480 
481 /*
482  *  Registering
483  */
484 
485 extern const struct file_operations snd_pcm_f_ops[2];
486 
487 int snd_pcm_new(struct snd_card *card, const char *id, int device,
488 		int playback_count, int capture_count,
489 		struct snd_pcm **rpcm);
490 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
491 		int playback_count, int capture_count,
492 		struct snd_pcm **rpcm);
493 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
494 
495 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
496 
497 /*
498  *  Native I/O
499  */
500 
501 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
502 int snd_pcm_info_user(struct snd_pcm_substream *substream,
503 		      struct snd_pcm_info __user *info);
504 int snd_pcm_status(struct snd_pcm_substream *substream,
505 		   struct snd_pcm_status *status);
506 int snd_pcm_start(struct snd_pcm_substream *substream);
507 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
508 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
509 int snd_pcm_stop_xrun(struct snd_pcm_substream *substream);
510 #ifdef CONFIG_PM
511 int snd_pcm_suspend(struct snd_pcm_substream *substream);
512 int snd_pcm_suspend_all(struct snd_pcm *pcm);
513 #endif
514 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
515 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
516 			   struct snd_pcm_substream **rsubstream);
517 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
518 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
519 			     struct snd_pcm_substream **rsubstream);
520 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
521 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
522 
523 
524 #ifdef CONFIG_SND_DEBUG
525 void snd_pcm_debug_name(struct snd_pcm_substream *substream,
526 			   char *name, size_t len);
527 #else
528 static inline void
529 snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
530 {
531 	*buf = 0;
532 }
533 #endif
534 
535 /*
536  *  PCM library
537  */
538 
539 /**
540  * snd_pcm_stream_linked - Check whether the substream is linked with others
541  * @substream: substream to check
542  *
543  * Returns true if the given substream is being linked with others.
544  */
545 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
546 {
547 	return substream->group != &substream->self_group;
548 }
549 
550 void snd_pcm_stream_lock(struct snd_pcm_substream *substream);
551 void snd_pcm_stream_unlock(struct snd_pcm_substream *substream);
552 void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream);
553 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream);
554 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream);
555 
556 /**
557  * snd_pcm_stream_lock_irqsave - Lock the PCM stream
558  * @substream: PCM substream
559  * @flags: irq flags
560  *
561  * This locks the PCM stream like snd_pcm_stream_lock() but with the local
562  * IRQ (only when nonatomic is false).  In nonatomic case, this is identical
563  * as snd_pcm_stream_lock().
564  */
565 #define snd_pcm_stream_lock_irqsave(substream, flags)		 \
566 	do {							 \
567 		typecheck(unsigned long, flags);		 \
568 		flags = _snd_pcm_stream_lock_irqsave(substream); \
569 	} while (0)
570 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
571 				      unsigned long flags);
572 
573 /**
574  * snd_pcm_group_for_each_entry - iterate over the linked substreams
575  * @s: the iterator
576  * @substream: the substream
577  *
578  * Iterate over the all linked substreams to the given @substream.
579  * When @substream isn't linked with any others, this gives returns @substream
580  * itself once.
581  */
582 #define snd_pcm_group_for_each_entry(s, substream) \
583 	list_for_each_entry(s, &substream->group->substreams, link_list)
584 
585 /**
586  * snd_pcm_running - Check whether the substream is in a running state
587  * @substream: substream to check
588  *
589  * Returns true if the given substream is in the state RUNNING, or in the
590  * state DRAINING for playback.
591  */
592 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
593 {
594 	return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
595 		(substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
596 		 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
597 }
598 
599 /**
600  * bytes_to_samples - Unit conversion of the size from bytes to samples
601  * @runtime: PCM runtime instance
602  * @size: size in bytes
603  */
604 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
605 {
606 	return size * 8 / runtime->sample_bits;
607 }
608 
609 /**
610  * bytes_to_frames - Unit conversion of the size from bytes to frames
611  * @runtime: PCM runtime instance
612  * @size: size in bytes
613  */
614 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
615 {
616 	return size * 8 / runtime->frame_bits;
617 }
618 
619 /**
620  * samples_to_bytes - Unit conversion of the size from samples to bytes
621  * @runtime: PCM runtime instance
622  * @size: size in samples
623  */
624 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
625 {
626 	return size * runtime->sample_bits / 8;
627 }
628 
629 /**
630  * frames_to_bytes - Unit conversion of the size from frames to bytes
631  * @runtime: PCM runtime instance
632  * @size: size in frames
633  */
634 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
635 {
636 	return size * runtime->frame_bits / 8;
637 }
638 
639 /**
640  * frame_aligned - Check whether the byte size is aligned to frames
641  * @runtime: PCM runtime instance
642  * @bytes: size in bytes
643  */
644 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
645 {
646 	return bytes % runtime->byte_align == 0;
647 }
648 
649 /**
650  * snd_pcm_lib_buffer_bytes - Get the buffer size of the current PCM in bytes
651  * @substream: PCM substream
652  */
653 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
654 {
655 	struct snd_pcm_runtime *runtime = substream->runtime;
656 	return frames_to_bytes(runtime, runtime->buffer_size);
657 }
658 
659 /**
660  * snd_pcm_lib_period_bytes - Get the period size of the current PCM in bytes
661  * @substream: PCM substream
662  */
663 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
664 {
665 	struct snd_pcm_runtime *runtime = substream->runtime;
666 	return frames_to_bytes(runtime, runtime->period_size);
667 }
668 
669 /**
670  * snd_pcm_playback_avail - Get the available (writable) space for playback
671  * @runtime: PCM runtime instance
672  *
673  * Result is between 0 ... (boundary - 1)
674  */
675 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
676 {
677 	snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
678 	if (avail < 0)
679 		avail += runtime->boundary;
680 	else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
681 		avail -= runtime->boundary;
682 	return avail;
683 }
684 
685 /**
686  * snd_pcm_playback_avail - Get the available (readable) space for capture
687  * @runtime: PCM runtime instance
688  *
689  * Result is between 0 ... (boundary - 1)
690  */
691 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
692 {
693 	snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
694 	if (avail < 0)
695 		avail += runtime->boundary;
696 	return avail;
697 }
698 
699 /**
700  * snd_pcm_playback_hw_avail - Get the queued space for playback
701  * @runtime: PCM runtime instance
702  */
703 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
704 {
705 	return runtime->buffer_size - snd_pcm_playback_avail(runtime);
706 }
707 
708 /**
709  * snd_pcm_capture_hw_avail - Get the free space for capture
710  * @runtime: PCM runtime instance
711  */
712 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
713 {
714 	return runtime->buffer_size - snd_pcm_capture_avail(runtime);
715 }
716 
717 /**
718  * snd_pcm_playback_ready - check whether the playback buffer is available
719  * @substream: the pcm substream instance
720  *
721  * Checks whether enough free space is available on the playback buffer.
722  *
723  * Return: Non-zero if available, or zero if not.
724  */
725 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
726 {
727 	struct snd_pcm_runtime *runtime = substream->runtime;
728 	return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
729 }
730 
731 /**
732  * snd_pcm_capture_ready - check whether the capture buffer is available
733  * @substream: the pcm substream instance
734  *
735  * Checks whether enough capture data is available on the capture buffer.
736  *
737  * Return: Non-zero if available, or zero if not.
738  */
739 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
740 {
741 	struct snd_pcm_runtime *runtime = substream->runtime;
742 	return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
743 }
744 
745 /**
746  * snd_pcm_playback_data - check whether any data exists on the playback buffer
747  * @substream: the pcm substream instance
748  *
749  * Checks whether any data exists on the playback buffer.
750  *
751  * Return: Non-zero if any data exists, or zero if not. If stop_threshold
752  * is bigger or equal to boundary, then this function returns always non-zero.
753  */
754 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
755 {
756 	struct snd_pcm_runtime *runtime = substream->runtime;
757 
758 	if (runtime->stop_threshold >= runtime->boundary)
759 		return 1;
760 	return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
761 }
762 
763 /**
764  * snd_pcm_playback_empty - check whether the playback buffer is empty
765  * @substream: the pcm substream instance
766  *
767  * Checks whether the playback buffer is empty.
768  *
769  * Return: Non-zero if empty, or zero if not.
770  */
771 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
772 {
773 	struct snd_pcm_runtime *runtime = substream->runtime;
774 	return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
775 }
776 
777 /**
778  * snd_pcm_capture_empty - check whether the capture buffer is empty
779  * @substream: the pcm substream instance
780  *
781  * Checks whether the capture buffer is empty.
782  *
783  * Return: Non-zero if empty, or zero if not.
784  */
785 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
786 {
787 	struct snd_pcm_runtime *runtime = substream->runtime;
788 	return snd_pcm_capture_avail(runtime) == 0;
789 }
790 
791 /**
792  * snd_pcm_trigger_done - Mark the master substream
793  * @substream: the pcm substream instance
794  * @master: the linked master substream
795  *
796  * When multiple substreams of the same card are linked and the hardware
797  * supports the single-shot operation, the driver calls this in the loop
798  * in snd_pcm_group_for_each_entry() for marking the substream as "done".
799  * Then most of trigger operations are performed only to the given master
800  * substream.
801  *
802  * The trigger_master mark is cleared at timestamp updates at the end
803  * of trigger operations.
804  */
805 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
806 					struct snd_pcm_substream *master)
807 {
808 	substream->runtime->trigger_master = master;
809 }
810 
811 static inline int hw_is_mask(int var)
812 {
813 	return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
814 		var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
815 }
816 
817 static inline int hw_is_interval(int var)
818 {
819 	return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
820 		var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
821 }
822 
823 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
824 				     snd_pcm_hw_param_t var)
825 {
826 	return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
827 }
828 
829 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
830 					     snd_pcm_hw_param_t var)
831 {
832 	return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
833 }
834 
835 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
836 					     snd_pcm_hw_param_t var)
837 {
838 	return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
839 }
840 
841 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
842 						     snd_pcm_hw_param_t var)
843 {
844 	return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
845 }
846 
847 /**
848  * params_channels - Get the number of channels from the hw params
849  * @p: hw params
850  */
851 static inline unsigned int params_channels(const struct snd_pcm_hw_params *p)
852 {
853 	return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_CHANNELS)->min;
854 }
855 
856 /**
857  * params_rate - Get the sample rate from the hw params
858  * @p: hw params
859  */
860 static inline unsigned int params_rate(const struct snd_pcm_hw_params *p)
861 {
862 	return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_RATE)->min;
863 }
864 
865 /**
866  * params_period_size - Get the period size (in frames) from the hw params
867  * @p: hw params
868  */
869 static inline unsigned int params_period_size(const struct snd_pcm_hw_params *p)
870 {
871 	return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min;
872 }
873 
874 /**
875  * params_periods - Get the number of periods from the hw params
876  * @p: hw params
877  */
878 static inline unsigned int params_periods(const struct snd_pcm_hw_params *p)
879 {
880 	return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIODS)->min;
881 }
882 
883 /**
884  * params_buffer_size - Get the buffer size (in frames) from the hw params
885  * @p: hw params
886  */
887 static inline unsigned int params_buffer_size(const struct snd_pcm_hw_params *p)
888 {
889 	return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min;
890 }
891 
892 /**
893  * params_buffer_bytes - Get the buffer size (in bytes) from the hw params
894  * @p: hw params
895  */
896 static inline unsigned int params_buffer_bytes(const struct snd_pcm_hw_params *p)
897 {
898 	return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min;
899 }
900 
901 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
902 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
903 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
904 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
905 			  unsigned int k, struct snd_interval *c);
906 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
907 			  const struct snd_interval *b, struct snd_interval *c);
908 int snd_interval_list(struct snd_interval *i, unsigned int count,
909 		      const unsigned int *list, unsigned int mask);
910 int snd_interval_ratnum(struct snd_interval *i,
911 			unsigned int rats_count, struct snd_ratnum *rats,
912 			unsigned int *nump, unsigned int *denp);
913 
914 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
915 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
916 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
917 
918 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
919 
920 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
921 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
922 
923 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
924 			       u_int32_t mask);
925 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
926 				 u_int64_t mask);
927 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
928 				 unsigned int min, unsigned int max);
929 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
930 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
931 			       unsigned int cond,
932 			       snd_pcm_hw_param_t var,
933 			       const struct snd_pcm_hw_constraint_list *l);
934 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
935 				  unsigned int cond,
936 				  snd_pcm_hw_param_t var,
937 				  struct snd_pcm_hw_constraint_ratnums *r);
938 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
939 				  unsigned int cond,
940 				  snd_pcm_hw_param_t var,
941 				  struct snd_pcm_hw_constraint_ratdens *r);
942 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
943 				 unsigned int cond,
944 				 unsigned int width,
945 				 unsigned int msbits);
946 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
947 			       unsigned int cond,
948 			       snd_pcm_hw_param_t var,
949 			       unsigned long step);
950 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
951 			       unsigned int cond,
952 			       snd_pcm_hw_param_t var);
953 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
954 			       unsigned int base_rate);
955 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
956 			unsigned int cond,
957 			int var,
958 			snd_pcm_hw_rule_func_t func, void *private,
959 			int dep, ...);
960 
961 int snd_pcm_format_signed(snd_pcm_format_t format);
962 int snd_pcm_format_unsigned(snd_pcm_format_t format);
963 int snd_pcm_format_linear(snd_pcm_format_t format);
964 int snd_pcm_format_little_endian(snd_pcm_format_t format);
965 int snd_pcm_format_big_endian(snd_pcm_format_t format);
966 #if 0 /* just for DocBook */
967 /**
968  * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
969  * @format: the format to check
970  *
971  * Return: 1 if the given PCM format is CPU-endian, 0 if
972  * opposite, or a negative error code if endian not specified.
973  */
974 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
975 #endif /* DocBook */
976 #ifdef SNDRV_LITTLE_ENDIAN
977 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
978 #else
979 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
980 #endif
981 int snd_pcm_format_width(snd_pcm_format_t format);			/* in bits */
982 int snd_pcm_format_physical_width(snd_pcm_format_t format);		/* in bits */
983 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
984 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
985 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
986 
987 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
988 		     const struct snd_pcm_ops *ops);
989 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
990 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
991 		      unsigned int cmd, void *arg);
992 int snd_pcm_update_state(struct snd_pcm_substream *substream,
993 			 struct snd_pcm_runtime *runtime);
994 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
995 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
996 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
997 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
998 				    const void __user *buf,
999 				    snd_pcm_uframes_t frames);
1000 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
1001 				   void __user *buf, snd_pcm_uframes_t frames);
1002 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1003 				     void __user **bufs, snd_pcm_uframes_t frames);
1004 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1005 				    void __user **bufs, snd_pcm_uframes_t frames);
1006 
1007 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
1008 
1009 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
1010 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
1011 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
1012 unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
1013 					 unsigned int rates_b);
1014 
1015 /**
1016  * snd_pcm_set_runtime_buffer - Set the PCM runtime buffer
1017  * @substream: PCM substream to set
1018  * @bufp: the buffer information, NULL to clear
1019  *
1020  * Copy the buffer information to runtime->dma_buffer when @bufp is non-NULL.
1021  * Otherwise it clears the current buffer information.
1022  */
1023 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1024 					      struct snd_dma_buffer *bufp)
1025 {
1026 	struct snd_pcm_runtime *runtime = substream->runtime;
1027 	if (bufp) {
1028 		runtime->dma_buffer_p = bufp;
1029 		runtime->dma_area = bufp->area;
1030 		runtime->dma_addr = bufp->addr;
1031 		runtime->dma_bytes = bufp->bytes;
1032 	} else {
1033 		runtime->dma_buffer_p = NULL;
1034 		runtime->dma_area = NULL;
1035 		runtime->dma_addr = 0;
1036 		runtime->dma_bytes = 0;
1037 	}
1038 }
1039 
1040 /*
1041  *  Timer interface
1042  */
1043 
1044 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
1045 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
1046 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
1047 
1048 /**
1049  * snd_pcm_gettime - Fill the timespec depending on the timestamp mode
1050  * @runtime: PCM runtime instance
1051  * @tv: timespec to fill
1052  */
1053 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
1054 				   struct timespec *tv)
1055 {
1056 	switch (runtime->tstamp_type) {
1057 	case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC:
1058 		ktime_get_ts(tv);
1059 		break;
1060 	case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW:
1061 		getrawmonotonic(tv);
1062 		break;
1063 	default:
1064 		getnstimeofday(tv);
1065 		break;
1066 	}
1067 }
1068 
1069 /*
1070  *  Memory
1071  */
1072 
1073 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
1074 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
1075 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1076 				  int type, struct device *data,
1077 				  size_t size, size_t max);
1078 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1079 					  int type, void *data,
1080 					  size_t size, size_t max);
1081 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
1082 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1083 
1084 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
1085 				      size_t size, gfp_t gfp_flags);
1086 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
1087 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
1088 					  unsigned long offset);
1089 /**
1090  * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
1091  * @substream: the substream to allocate the buffer to
1092  * @size: the requested buffer size, in bytes
1093  *
1094  * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
1095  * contiguous in kernel virtual space, but not in physical memory.  Use this
1096  * if the buffer is accessed by kernel code but not by device DMA.
1097  *
1098  * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1099  * code.
1100  */
1101 static inline int snd_pcm_lib_alloc_vmalloc_buffer
1102 			(struct snd_pcm_substream *substream, size_t size)
1103 {
1104 	return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1105 						 GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO);
1106 }
1107 
1108 /**
1109  * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
1110  * @substream: the substream to allocate the buffer to
1111  * @size: the requested buffer size, in bytes
1112  *
1113  * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
1114  * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
1115  *
1116  * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1117  * code.
1118  */
1119 static inline int snd_pcm_lib_alloc_vmalloc_32_buffer
1120 			(struct snd_pcm_substream *substream, size_t size)
1121 {
1122 	return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1123 						 GFP_KERNEL | GFP_DMA32 | __GFP_ZERO);
1124 }
1125 
1126 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
1127 
1128 #ifdef CONFIG_SND_DMA_SGBUF
1129 /*
1130  * SG-buffer handling
1131  */
1132 #define snd_pcm_substream_sgbuf(substream) \
1133 	snd_pcm_get_dma_buf(substream)->private_data
1134 
1135 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
1136 				    unsigned long offset);
1137 #else /* !SND_DMA_SGBUF */
1138 /*
1139  * fake using a continuous buffer
1140  */
1141 #define snd_pcm_sgbuf_ops_page	NULL
1142 #endif /* SND_DMA_SGBUF */
1143 
1144 /**
1145  * snd_pcm_sgbuf_get_addr - Get the DMA address at the corresponding offset
1146  * @substream: PCM substream
1147  * @ofs: byte offset
1148  */
1149 static inline dma_addr_t
1150 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1151 {
1152 	return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
1153 }
1154 
1155 /**
1156  * snd_pcm_sgbuf_get_ptr - Get the virtual address at the corresponding offset
1157  * @substream: PCM substream
1158  * @ofs: byte offset
1159  */
1160 static inline void *
1161 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1162 {
1163 	return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
1164 }
1165 
1166 /**
1167  * snd_pcm_sgbuf_chunk_size - Compute the max size that fits within the contig.
1168  * page from the given size
1169  * @substream: PCM substream
1170  * @ofs: byte offset
1171  * @size: byte size to examine
1172  */
1173 static inline unsigned int
1174 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1175 			     unsigned int ofs, unsigned int size)
1176 {
1177 	return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1178 }
1179 
1180 /**
1181  * snd_pcm_mmap_data_open - increase the mmap counter
1182  * @area: VMA
1183  *
1184  * PCM mmap callback should handle this counter properly
1185  */
1186 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1187 {
1188 	struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1189 	atomic_inc(&substream->mmap_count);
1190 }
1191 
1192 /**
1193  * snd_pcm_mmap_data_close - decrease the mmap counter
1194  * @area: VMA
1195  *
1196  * PCM mmap callback should handle this counter properly
1197  */
1198 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1199 {
1200 	struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1201 	atomic_dec(&substream->mmap_count);
1202 }
1203 
1204 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1205 			     struct vm_area_struct *area);
1206 /* mmap for io-memory area */
1207 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1208 #define SNDRV_PCM_INFO_MMAP_IOMEM	SNDRV_PCM_INFO_MMAP
1209 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1210 #else
1211 #define SNDRV_PCM_INFO_MMAP_IOMEM	0
1212 #define snd_pcm_lib_mmap_iomem	NULL
1213 #endif
1214 
1215 #define snd_pcm_lib_mmap_vmalloc NULL
1216 
1217 /**
1218  * snd_pcm_limit_isa_dma_size - Get the max size fitting with ISA DMA transfer
1219  * @dma: DMA number
1220  * @max: pointer to store the max size
1221  */
1222 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1223 {
1224 	*max = dma < 4 ? 64 * 1024 : 128 * 1024;
1225 }
1226 
1227 /*
1228  *  Misc
1229  */
1230 
1231 #define SNDRV_PCM_DEFAULT_CON_SPDIF	(IEC958_AES0_CON_EMPHASIS_NONE|\
1232 					 (IEC958_AES1_CON_ORIGINAL<<8)|\
1233 					 (IEC958_AES1_CON_PCM_CODER<<8)|\
1234 					 (IEC958_AES3_CON_FS_48000<<24))
1235 
1236 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1237 
1238 const char *snd_pcm_format_name(snd_pcm_format_t format);
1239 
1240 /**
1241  * snd_pcm_stream_str - Get a string naming the direction of a stream
1242  * @substream: the pcm substream instance
1243  *
1244  * Return: A string naming the direction of the stream.
1245  */
1246 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1247 {
1248 	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1249 		return "Playback";
1250 	else
1251 		return "Capture";
1252 }
1253 
1254 /*
1255  * PCM channel-mapping control API
1256  */
1257 /* array element of channel maps */
1258 struct snd_pcm_chmap_elem {
1259 	unsigned char channels;
1260 	unsigned char map[15];
1261 };
1262 
1263 /* channel map information; retrieved via snd_kcontrol_chip() */
1264 struct snd_pcm_chmap {
1265 	struct snd_pcm *pcm;	/* assigned PCM instance */
1266 	int stream;		/* PLAYBACK or CAPTURE */
1267 	struct snd_kcontrol *kctl;
1268 	const struct snd_pcm_chmap_elem *chmap;
1269 	unsigned int max_channels;
1270 	unsigned int channel_mask;	/* optional: active channels bitmask */
1271 	void *private_data;	/* optional: private data pointer */
1272 };
1273 
1274 /**
1275  * snd_pcm_chmap_substream - get the PCM substream assigned to the given chmap info
1276  * @info: chmap information
1277  * @idx: the substream number index
1278  */
1279 static inline struct snd_pcm_substream *
1280 snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1281 {
1282 	struct snd_pcm_substream *s;
1283 	for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1284 		if (s->number == idx)
1285 			return s;
1286 	return NULL;
1287 }
1288 
1289 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1290 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1291 /* Other world's standard channel maps (C/LFE prior to RL/RR) */
1292 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1293 
1294 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1295 #define SND_PCM_CHMAP_MASK_24	((1U << 2) | (1U << 4))
1296 #define SND_PCM_CHMAP_MASK_246	(SND_PCM_CHMAP_MASK_24 | (1U << 6))
1297 #define SND_PCM_CHMAP_MASK_2468	(SND_PCM_CHMAP_MASK_246 | (1U << 8))
1298 
1299 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1300 			   const struct snd_pcm_chmap_elem *chmap,
1301 			   int max_channels,
1302 			   unsigned long private_value,
1303 			   struct snd_pcm_chmap **info_ret);
1304 
1305 /**
1306  * pcm_format_to_bits - Strong-typed conversion of pcm_format to bitwise
1307  * @pcm_format: PCM format
1308  */
1309 static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1310 {
1311 	return 1ULL << (__force int) pcm_format;
1312 }
1313 
1314 /* printk helpers */
1315 #define pcm_err(pcm, fmt, args...) \
1316 	dev_err((pcm)->card->dev, fmt, ##args)
1317 #define pcm_warn(pcm, fmt, args...) \
1318 	dev_warn((pcm)->card->dev, fmt, ##args)
1319 #define pcm_dbg(pcm, fmt, args...) \
1320 	dev_dbg((pcm)->card->dev, fmt, ##args)
1321 
1322 #endif /* __SOUND_PCM_H */
1323