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