]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/sound/pcm.h
projects / mirror_ubuntu-artful-kernel.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Safer ABI for O_TMPFILE
[mirror_ubuntu-artful-kernel.git] / include / sound / pcm.h
1 #ifndef __SOUND_PCM_H
2 #define __SOUND_PCM_H
3
4 /*
5 * Digital Audio (PCM) abstract layer
6 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
7 * Abramo Bagnara <abramo@alsa-project.org>
8 *
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 *
24 */
25
26 #include <sound/asound.h>
27 #include <sound/memalloc.h>
28 #include <sound/minors.h>
29 #include <linux/poll.h>
30 #include <linux/mm.h>
31 #include <linux/bitops.h>
32 #include <linux/pm_qos.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_FALSE ((void *)0)
98 #define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
99
100 #define SNDRV_PCM_IOCTL1_RESET 0
101 #define SNDRV_PCM_IOCTL1_INFO 1
102 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
103 #define SNDRV_PCM_IOCTL1_GSTATE 3
104 #define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
105
106 #define SNDRV_PCM_TRIGGER_STOP 0
107 #define SNDRV_PCM_TRIGGER_START 1
108 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
109 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
110 #define SNDRV_PCM_TRIGGER_SUSPEND 5
111 #define SNDRV_PCM_TRIGGER_RESUME 6
112
113 #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
114
115 /* If you change this don't forget to change rates[] table in pcm_native.c */
116 #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
117 #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
118 #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
119 #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
120 #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
121 #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
122 #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
123 #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
124 #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
125 #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
126 #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
127 #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
128 #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
129
130 #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
131 #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
132
133 #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
134 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
135 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
136 #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
137 #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
138 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
139 #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
140 SNDRV_PCM_RATE_192000)
141 #define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
142 #define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
143 #define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
144 #define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
145 #define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
146 #define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
147 #define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
148 #define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
149 #define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
150 #define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
151 #define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
152 #define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE)
153 #define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE)
154 #define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE)
155 #define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE)
156 #define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE)
157 #define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE)
158 #define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE)
159 #define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE)
160 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
161 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
162 #define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW)
163 #define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW)
164 #define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM)
165 #define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG)
166 #define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM)
167 #define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
168 #define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
169 #define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
170 #define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
171 #define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
172 #define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
173 #define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
174 #define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
175 #define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
176 #define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
177 #define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
178 #define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
179 #define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
180 #define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
181 #define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
182 #define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
183 #define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
184 #define SNDRV_PCM_FMTBIT_DSD_U8 _SNDRV_PCM_FMTBIT(DSD_U8)
185 #define SNDRV_PCM_FMTBIT_DSD_U16_LE _SNDRV_PCM_FMTBIT(DSD_U16_LE)
186
187 #ifdef SNDRV_LITTLE_ENDIAN
188 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
189 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
190 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
191 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
192 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
193 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
194 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
195 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
196 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
197 #endif
198 #ifdef SNDRV_BIG_ENDIAN
199 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
200 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
201 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
202 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
203 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
204 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
205 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
206 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
207 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
208 #endif
209
210 struct snd_pcm_file {
211 struct snd_pcm_substream *substream;
212 int no_compat_mmap;
213 };
214
215 struct snd_pcm_hw_rule;
216 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
217 struct snd_pcm_hw_rule *rule);
218
219 struct snd_pcm_hw_rule {
220 unsigned int cond;
221 snd_pcm_hw_rule_func_t func;
222 int var;
223 int deps[4];
224 void *private;
225 };
226
227 struct snd_pcm_hw_constraints {
228 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
229 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
230 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
231 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
232 unsigned int rules_num;
233 unsigned int rules_all;
234 struct snd_pcm_hw_rule *rules;
235 };
236
237 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
238 snd_pcm_hw_param_t var)
239 {
240 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
241 }
242
243 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
244 snd_pcm_hw_param_t var)
245 {
246 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
247 }
248
249 struct snd_ratnum {
250 unsigned int num;
251 unsigned int den_min, den_max, den_step;
252 };
253
254 struct snd_ratden {
255 unsigned int num_min, num_max, num_step;
256 unsigned int den;
257 };
258
259 struct snd_pcm_hw_constraint_ratnums {
260 int nrats;
261 struct snd_ratnum *rats;
262 };
263
264 struct snd_pcm_hw_constraint_ratdens {
265 int nrats;
266 struct snd_ratden *rats;
267 };
268
269 struct snd_pcm_hw_constraint_list {
270 unsigned int count;
271 const unsigned int *list;
272 unsigned int mask;
273 };
274
275 struct snd_pcm_hwptr_log;
276
277 struct snd_pcm_runtime {
278 /* -- Status -- */
279 struct snd_pcm_substream *trigger_master;
280 struct timespec trigger_tstamp; /* trigger timestamp */
281 int overrange;
282 snd_pcm_uframes_t avail_max;
283 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
284 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
285 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
286 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
287 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
288 u64 hw_ptr_wrap; /* offset for hw_ptr due to boundary wrap-around */
289
290 /* -- HW params -- */
291 snd_pcm_access_t access; /* access mode */
292 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
293 snd_pcm_subformat_t subformat; /* subformat */
294 unsigned int rate; /* rate in Hz */
295 unsigned int channels; /* channels */
296 snd_pcm_uframes_t period_size; /* period size */
297 unsigned int periods; /* periods */
298 snd_pcm_uframes_t buffer_size; /* buffer size */
299 snd_pcm_uframes_t min_align; /* Min alignment for the format */
300 size_t byte_align;
301 unsigned int frame_bits;
302 unsigned int sample_bits;
303 unsigned int info;
304 unsigned int rate_num;
305 unsigned int rate_den;
306 unsigned int no_period_wakeup: 1;
307
308 /* -- SW params -- */
309 int tstamp_mode; /* mmap timestamp is updated */
310 unsigned int period_step;
311 snd_pcm_uframes_t start_threshold;
312 snd_pcm_uframes_t stop_threshold;
313 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
314 noise is nearest than this */
315 snd_pcm_uframes_t silence_size; /* Silence filling size */
316 snd_pcm_uframes_t boundary; /* pointers wrap point */
317
318 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
319 snd_pcm_uframes_t silence_filled; /* size filled with silence */
320
321 union snd_pcm_sync_id sync; /* hardware synchronization ID */
322
323 /* -- mmap -- */
324 struct snd_pcm_mmap_status *status;
325 struct snd_pcm_mmap_control *control;
326
327 /* -- locking / scheduling -- */
328 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
329 wait_queue_head_t sleep; /* poll sleep */
330 wait_queue_head_t tsleep; /* transfer sleep */
331 struct fasync_struct *fasync;
332
333 /* -- private section -- */
334 void *private_data;
335 void (*private_free)(struct snd_pcm_runtime *runtime);
336
337 /* -- hardware description -- */
338 struct snd_pcm_hardware hw;
339 struct snd_pcm_hw_constraints hw_constraints;
340
341 /* -- interrupt callbacks -- */
342 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
343 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
344
345 /* -- timer -- */
346 unsigned int timer_resolution; /* timer resolution */
347 int tstamp_type; /* timestamp type */
348
349 /* -- DMA -- */
350 unsigned char *dma_area; /* DMA area */
351 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
352 size_t dma_bytes; /* size of DMA area */
353
354 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
355
356 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
357 /* -- OSS things -- */
358 struct snd_pcm_oss_runtime oss;
359 #endif
360
361 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
362 struct snd_pcm_hwptr_log *hwptr_log;
363 #endif
364 };
365
366 struct snd_pcm_group { /* keep linked substreams */
367 spinlock_t lock;
368 struct list_head substreams;
369 int count;
370 };
371
372 struct pid;
373
374 struct snd_pcm_substream {
375 struct snd_pcm *pcm;
376 struct snd_pcm_str *pstr;
377 void *private_data; /* copied from pcm->private_data */
378 int number;
379 char name[32]; /* substream name */
380 int stream; /* stream (direction) */
381 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
382 size_t buffer_bytes_max; /* limit ring buffer size */
383 struct snd_dma_buffer dma_buffer;
384 unsigned int dma_buf_id;
385 size_t dma_max;
386 /* -- hardware operations -- */
387 const struct snd_pcm_ops *ops;
388 /* -- runtime information -- */
389 struct snd_pcm_runtime *runtime;
390 /* -- timer section -- */
391 struct snd_timer *timer; /* timer */
392 unsigned timer_running: 1; /* time is running */
393 /* -- next substream -- */
394 struct snd_pcm_substream *next;
395 /* -- linked substreams -- */
396 struct list_head link_list; /* linked list member */
397 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
398 struct snd_pcm_group *group; /* pointer to current group */
399 /* -- assigned files -- */
400 void *file;
401 int ref_count;
402 atomic_t mmap_count;
403 unsigned int f_flags;
404 void (*pcm_release)(struct snd_pcm_substream *);
405 struct pid *pid;
406 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
407 /* -- OSS things -- */
408 struct snd_pcm_oss_substream oss;
409 #endif
410 #ifdef CONFIG_SND_VERBOSE_PROCFS
411 struct snd_info_entry *proc_root;
412 struct snd_info_entry *proc_info_entry;
413 struct snd_info_entry *proc_hw_params_entry;
414 struct snd_info_entry *proc_sw_params_entry;
415 struct snd_info_entry *proc_status_entry;
416 struct snd_info_entry *proc_prealloc_entry;
417 struct snd_info_entry *proc_prealloc_max_entry;
418 #endif
419 /* misc flags */
420 unsigned int hw_opened: 1;
421 };
422
423 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
424
425
426 struct snd_pcm_str {
427 int stream; /* stream (direction) */
428 struct snd_pcm *pcm;
429 /* -- substreams -- */
430 unsigned int substream_count;
431 unsigned int substream_opened;
432 struct snd_pcm_substream *substream;
433 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
434 /* -- OSS things -- */
435 struct snd_pcm_oss_stream oss;
436 #endif
437 #ifdef CONFIG_SND_VERBOSE_PROCFS
438 struct snd_info_entry *proc_root;
439 struct snd_info_entry *proc_info_entry;
440 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
441 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
442 struct snd_info_entry *proc_xrun_debug_entry;
443 #endif
444 #endif
445 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
446 };
447
448 struct snd_pcm {
449 struct snd_card *card;
450 struct list_head list;
451 int device; /* device number */
452 unsigned int info_flags;
453 unsigned short dev_class;
454 unsigned short dev_subclass;
455 char id[64];
456 char name[80];
457 struct snd_pcm_str streams[2];
458 struct mutex open_mutex;
459 wait_queue_head_t open_wait;
460 void *private_data;
461 void (*private_free) (struct snd_pcm *pcm);
462 struct device *dev; /* actual hw device this belongs to */
463 bool internal; /* pcm is for internal use only */
464 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
465 struct snd_pcm_oss oss;
466 #endif
467 };
468
469 struct snd_pcm_notify {
470 int (*n_register) (struct snd_pcm * pcm);
471 int (*n_disconnect) (struct snd_pcm * pcm);
472 int (*n_unregister) (struct snd_pcm * pcm);
473 struct list_head list;
474 };
475
476 /*
477 * Registering
478 */
479
480 extern const struct file_operations snd_pcm_f_ops[2];
481
482 int snd_pcm_new(struct snd_card *card, const char *id, int device,
483 int playback_count, int capture_count,
484 struct snd_pcm **rpcm);
485 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
486 int playback_count, int capture_count,
487 struct snd_pcm **rpcm);
488 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
489
490 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
491
492 /*
493 * Native I/O
494 */
495
496 extern rwlock_t snd_pcm_link_rwlock;
497
498 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
499 int snd_pcm_info_user(struct snd_pcm_substream *substream,
500 struct snd_pcm_info __user *info);
501 int snd_pcm_status(struct snd_pcm_substream *substream,
502 struct snd_pcm_status *status);
503 int snd_pcm_start(struct snd_pcm_substream *substream);
504 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
505 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
506 #ifdef CONFIG_PM
507 int snd_pcm_suspend(struct snd_pcm_substream *substream);
508 int snd_pcm_suspend_all(struct snd_pcm *pcm);
509 #endif
510 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
511 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
512 struct snd_pcm_substream **rsubstream);
513 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
514 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
515 struct snd_pcm_substream **rsubstream);
516 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
517 void snd_pcm_vma_notify_data(void *client, void *data);
518 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
519
520
521 #ifdef CONFIG_SND_DEBUG
522 void snd_pcm_debug_name(struct snd_pcm_substream *substream,
523 char *name, size_t len);
524 #else
525 static inline void
526 snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
527 {
528 *buf = 0;
529 }
530 #endif
531
532 /*
533 * PCM library
534 */
535
536 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
537 {
538 return substream->group != &substream->self_group;
539 }
540
541 static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
542 {
543 read_lock(&snd_pcm_link_rwlock);
544 spin_lock(&substream->self_group.lock);
545 }
546
547 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
548 {
549 spin_unlock(&substream->self_group.lock);
550 read_unlock(&snd_pcm_link_rwlock);
551 }
552
553 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
554 {
555 read_lock_irq(&snd_pcm_link_rwlock);
556 spin_lock(&substream->self_group.lock);
557 }
558
559 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
560 {
561 spin_unlock(&substream->self_group.lock);
562 read_unlock_irq(&snd_pcm_link_rwlock);
563 }
564
565 #define snd_pcm_stream_lock_irqsave(substream, flags) \
566 do { \
567 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
568 spin_lock(&substream->self_group.lock); \
569 } while (0)
570
571 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
572 do { \
573 spin_unlock(&substream->self_group.lock); \
574 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
575 } while (0)
576
577 #define snd_pcm_group_for_each_entry(s, substream) \
578 list_for_each_entry(s, &substream->group->substreams, link_list)
579
580 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
581 {
582 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
583 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
584 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
585 }
586
587 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
588 {
589 return size * 8 / runtime->sample_bits;
590 }
591
592 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
593 {
594 return size * 8 / runtime->frame_bits;
595 }
596
597 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
598 {
599 return size * runtime->sample_bits / 8;
600 }
601
602 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
603 {
604 return size * runtime->frame_bits / 8;
605 }
606
607 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
608 {
609 return bytes % runtime->byte_align == 0;
610 }
611
612 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
613 {
614 struct snd_pcm_runtime *runtime = substream->runtime;
615 return frames_to_bytes(runtime, runtime->buffer_size);
616 }
617
618 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
619 {
620 struct snd_pcm_runtime *runtime = substream->runtime;
621 return frames_to_bytes(runtime, runtime->period_size);
622 }
623
624 /*
625 * result is: 0 ... (boundary - 1)
626 */
627 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
628 {
629 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
630 if (avail < 0)
631 avail += runtime->boundary;
632 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
633 avail -= runtime->boundary;
634 return avail;
635 }
636
637 /*
638 * result is: 0 ... (boundary - 1)
639 */
640 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
641 {
642 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
643 if (avail < 0)
644 avail += runtime->boundary;
645 return avail;
646 }
647
648 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
649 {
650 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
651 }
652
653 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
654 {
655 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
656 }
657
658 /**
659 * snd_pcm_playback_ready - check whether the playback buffer is available
660 * @substream: the pcm substream instance
661 *
662 * Checks whether enough free space is available on the playback buffer.
663 *
664 * Return: Non-zero if available, or zero if not.
665 */
666 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
667 {
668 struct snd_pcm_runtime *runtime = substream->runtime;
669 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
670 }
671
672 /**
673 * snd_pcm_capture_ready - check whether the capture buffer is available
674 * @substream: the pcm substream instance
675 *
676 * Checks whether enough capture data is available on the capture buffer.
677 *
678 * Return: Non-zero if available, or zero if not.
679 */
680 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
681 {
682 struct snd_pcm_runtime *runtime = substream->runtime;
683 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
684 }
685
686 /**
687 * snd_pcm_playback_data - check whether any data exists on the playback buffer
688 * @substream: the pcm substream instance
689 *
690 * Checks whether any data exists on the playback buffer.
691 *
692 * Return: Non-zero if any data exists, or zero if not. If stop_threshold
693 * is bigger or equal to boundary, then this function returns always non-zero.
694 */
695 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
696 {
697 struct snd_pcm_runtime *runtime = substream->runtime;
698
699 if (runtime->stop_threshold >= runtime->boundary)
700 return 1;
701 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
702 }
703
704 /**
705 * snd_pcm_playback_empty - check whether the playback buffer is empty
706 * @substream: the pcm substream instance
707 *
708 * Checks whether the playback buffer is empty.
709 *
710 * Return: Non-zero if empty, or zero if not.
711 */
712 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
713 {
714 struct snd_pcm_runtime *runtime = substream->runtime;
715 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
716 }
717
718 /**
719 * snd_pcm_capture_empty - check whether the capture buffer is empty
720 * @substream: the pcm substream instance
721 *
722 * Checks whether the capture buffer is empty.
723 *
724 * Return: Non-zero if empty, or zero if not.
725 */
726 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
727 {
728 struct snd_pcm_runtime *runtime = substream->runtime;
729 return snd_pcm_capture_avail(runtime) == 0;
730 }
731
732 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
733 struct snd_pcm_substream *master)
734 {
735 substream->runtime->trigger_master = master;
736 }
737
738 static inline int hw_is_mask(int var)
739 {
740 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
741 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
742 }
743
744 static inline int hw_is_interval(int var)
745 {
746 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
747 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
748 }
749
750 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
751 snd_pcm_hw_param_t var)
752 {
753 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
754 }
755
756 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
757 snd_pcm_hw_param_t var)
758 {
759 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
760 }
761
762 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
763 snd_pcm_hw_param_t var)
764 {
765 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
766 }
767
768 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
769 snd_pcm_hw_param_t var)
770 {
771 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
772 }
773
774 #define params_channels(p) \
775 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min)
776 #define params_rate(p) \
777 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min)
778 #define params_period_size(p) \
779 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min)
780 #define params_periods(p) \
781 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min)
782 #define params_buffer_size(p) \
783 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min)
784 #define params_buffer_bytes(p) \
785 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min)
786
787 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
788 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
789 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
790 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
791 unsigned int k, struct snd_interval *c);
792 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
793 const struct snd_interval *b, struct snd_interval *c);
794 int snd_interval_list(struct snd_interval *i, unsigned int count,
795 const unsigned int *list, unsigned int mask);
796 int snd_interval_ratnum(struct snd_interval *i,
797 unsigned int rats_count, struct snd_ratnum *rats,
798 unsigned int *nump, unsigned int *denp);
799
800 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
801 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
802 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
803
804 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
805
806 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
807 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
808
809 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
810 u_int32_t mask);
811 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
812 u_int64_t mask);
813 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
814 unsigned int min, unsigned int max);
815 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
816 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
817 unsigned int cond,
818 snd_pcm_hw_param_t var,
819 const struct snd_pcm_hw_constraint_list *l);
820 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
821 unsigned int cond,
822 snd_pcm_hw_param_t var,
823 struct snd_pcm_hw_constraint_ratnums *r);
824 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
825 unsigned int cond,
826 snd_pcm_hw_param_t var,
827 struct snd_pcm_hw_constraint_ratdens *r);
828 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
829 unsigned int cond,
830 unsigned int width,
831 unsigned int msbits);
832 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
833 unsigned int cond,
834 snd_pcm_hw_param_t var,
835 unsigned long step);
836 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
837 unsigned int cond,
838 snd_pcm_hw_param_t var);
839 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
840 unsigned int base_rate);
841 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
842 unsigned int cond,
843 int var,
844 snd_pcm_hw_rule_func_t func, void *private,
845 int dep, ...);
846
847 int snd_pcm_format_signed(snd_pcm_format_t format);
848 int snd_pcm_format_unsigned(snd_pcm_format_t format);
849 int snd_pcm_format_linear(snd_pcm_format_t format);
850 int snd_pcm_format_little_endian(snd_pcm_format_t format);
851 int snd_pcm_format_big_endian(snd_pcm_format_t format);
852 #if 0 /* just for DocBook */
853 /**
854 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
855 * @format: the format to check
856 *
857 * Return: 1 if the given PCM format is CPU-endian, 0 if
858 * opposite, or a negative error code if endian not specified.
859 */
860 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
861 #endif /* DocBook */
862 #ifdef SNDRV_LITTLE_ENDIAN
863 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
864 #else
865 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
866 #endif
867 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
868 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
869 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
870 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
871 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
872 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsigned, int big_endian);
873
874 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
875 const struct snd_pcm_ops *ops);
876 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
877 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
878 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
879 unsigned int cmd, void *arg);
880 int snd_pcm_update_state(struct snd_pcm_substream *substream,
881 struct snd_pcm_runtime *runtime);
882 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
883 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
884 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
885 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
886 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
887 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
888 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
889 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
890 const void __user *buf,
891 snd_pcm_uframes_t frames);
892 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
893 void __user *buf, snd_pcm_uframes_t frames);
894 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
895 void __user **bufs, snd_pcm_uframes_t frames);
896 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
897 void __user **bufs, snd_pcm_uframes_t frames);
898
899 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
900
901 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
902 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
903 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
904
905 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
906 struct snd_dma_buffer *bufp)
907 {
908 struct snd_pcm_runtime *runtime = substream->runtime;
909 if (bufp) {
910 runtime->dma_buffer_p = bufp;
911 runtime->dma_area = bufp->area;
912 runtime->dma_addr = bufp->addr;
913 runtime->dma_bytes = bufp->bytes;
914 } else {
915 runtime->dma_buffer_p = NULL;
916 runtime->dma_area = NULL;
917 runtime->dma_addr = 0;
918 runtime->dma_bytes = 0;
919 }
920 }
921
922 /*
923 * Timer interface
924 */
925
926 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
927 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
928 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
929
930 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
931 struct timespec *tv)
932 {
933 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
934 do_posix_clock_monotonic_gettime(tv);
935 else
936 getnstimeofday(tv);
937 }
938
939 /*
940 * Memory
941 */
942
943 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
944 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
945 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
946 int type, struct device *data,
947 size_t size, size_t max);
948 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
949 int type, void *data,
950 size_t size, size_t max);
951 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
952 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
953
954 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
955 size_t size, gfp_t gfp_flags);
956 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
957 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
958 unsigned long offset);
959 #if 0 /* for kernel-doc */
960 /**
961 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
962 * @substream: the substream to allocate the buffer to
963 * @size: the requested buffer size, in bytes
964 *
965 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
966 * contiguous in kernel virtual space, but not in physical memory. Use this
967 * if the buffer is accessed by kernel code but not by device DMA.
968 *
969 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
970 * code.
971 */
972 static int snd_pcm_lib_alloc_vmalloc_buffer
973 (struct snd_pcm_substream *substream, size_t size);
974 /**
975 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
976 * @substream: the substream to allocate the buffer to
977 * @size: the requested buffer size, in bytes
978 *
979 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
980 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
981 *
982 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
983 * code.
984 */
985 static int snd_pcm_lib_alloc_vmalloc_32_buffer
986 (struct snd_pcm_substream *substream, size_t size);
987 #endif
988 #define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
989 _snd_pcm_lib_alloc_vmalloc_buffer \
990 (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
991 #define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
992 _snd_pcm_lib_alloc_vmalloc_buffer \
993 (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
994
995 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
996
997 #ifdef CONFIG_SND_DMA_SGBUF
998 /*
999 * SG-buffer handling
1000 */
1001 #define snd_pcm_substream_sgbuf(substream) \
1002 snd_pcm_get_dma_buf(substream)->private_data
1003
1004 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
1005 unsigned long offset);
1006 #else /* !SND_DMA_SGBUF */
1007 /*
1008 * fake using a continuous buffer
1009 */
1010 #define snd_pcm_sgbuf_ops_page NULL
1011 #endif /* SND_DMA_SGBUF */
1012
1013 static inline dma_addr_t
1014 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1015 {
1016 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
1017 }
1018
1019 static inline void *
1020 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1021 {
1022 return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
1023 }
1024
1025 static inline unsigned int
1026 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1027 unsigned int ofs, unsigned int size)
1028 {
1029 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1030 }
1031
1032 /* handle mmap counter - PCM mmap callback should handle this counter properly */
1033 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1034 {
1035 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1036 atomic_inc(&substream->mmap_count);
1037 }
1038
1039 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1040 {
1041 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1042 atomic_dec(&substream->mmap_count);
1043 }
1044
1045 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1046 struct vm_area_struct *area);
1047 /* mmap for io-memory area */
1048 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1049 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
1050 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1051 #else
1052 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
1053 #define snd_pcm_lib_mmap_iomem NULL
1054 #endif
1055
1056 #define snd_pcm_lib_mmap_vmalloc NULL
1057
1058 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1059 {
1060 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1061 }
1062
1063 /*
1064 * Misc
1065 */
1066
1067 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1068 (IEC958_AES1_CON_ORIGINAL<<8)|\
1069 (IEC958_AES1_CON_PCM_CODER<<8)|\
1070 (IEC958_AES3_CON_FS_48000<<24))
1071
1072 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1073
1074 const char *snd_pcm_format_name(snd_pcm_format_t format);
1075
1076 /**
1077 * snd_pcm_stream_str - Get a string naming the direction of a stream
1078 * @substream: the pcm substream instance
1079 *
1080 * Return: A string naming the direction of the stream.
1081 */
1082 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1083 {
1084 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1085 return "Playback";
1086 else
1087 return "Capture";
1088 }
1089
1090 /*
1091 * PCM channel-mapping control API
1092 */
1093 /* array element of channel maps */
1094 struct snd_pcm_chmap_elem {
1095 unsigned char channels;
1096 unsigned char map[15];
1097 };
1098
1099 /* channel map information; retrieved via snd_kcontrol_chip() */
1100 struct snd_pcm_chmap {
1101 struct snd_pcm *pcm; /* assigned PCM instance */
1102 int stream; /* PLAYBACK or CAPTURE */
1103 struct snd_kcontrol *kctl;
1104 const struct snd_pcm_chmap_elem *chmap;
1105 unsigned int max_channels;
1106 unsigned int channel_mask; /* optional: active channels bitmask */
1107 void *private_data; /* optional: private data pointer */
1108 };
1109
1110 /* get the PCM substream assigned to the given chmap info */
1111 static inline struct snd_pcm_substream *
1112 snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1113 {
1114 struct snd_pcm_substream *s;
1115 for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1116 if (s->number == idx)
1117 return s;
1118 return NULL;
1119 }
1120
1121 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1122 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1123 /* Other world's standard channel maps (C/LFE prior to RL/RR) */
1124 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1125
1126 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1127 #define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1128 #define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1129 #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1130
1131 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1132 const struct snd_pcm_chmap_elem *chmap,
1133 int max_channels,
1134 unsigned long private_value,
1135 struct snd_pcm_chmap **info_ret);
1136
1137 /* Strong-typed conversion of pcm_format to bitwise */
1138 static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1139 {
1140 return 1ULL << (__force int) pcm_format;
1141 }
1142
1143 #endif /* __SOUND_PCM_H */
Ubuntu Artful kernel mirror