]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/sound/pcm.h
projects / mirror_ubuntu-bionic-kernel.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
ALSA: pcm: add new DSD sampleformat for native DSD playback on XMOS based devices
[mirror_ubuntu-bionic-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 #define SNDRV_PCM_FMTBIT_DSD_U32_LE _SNDRV_PCM_FMTBIT(DSD_U32_LE)
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 #endif
420 /* misc flags */
421 unsigned int hw_opened: 1;
422 };
423
424 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
425
426
427 struct snd_pcm_str {
428 int stream; /* stream (direction) */
429 struct snd_pcm *pcm;
430 /* -- substreams -- */
431 unsigned int substream_count;
432 unsigned int substream_opened;
433 struct snd_pcm_substream *substream;
434 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
435 /* -- OSS things -- */
436 struct snd_pcm_oss_stream oss;
437 #endif
438 #ifdef CONFIG_SND_VERBOSE_PROCFS
439 struct snd_info_entry *proc_root;
440 struct snd_info_entry *proc_info_entry;
441 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
442 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
443 struct snd_info_entry *proc_xrun_debug_entry;
444 #endif
445 #endif
446 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
447 };
448
449 struct snd_pcm {
450 struct snd_card *card;
451 struct list_head list;
452 int device; /* device number */
453 unsigned int info_flags;
454 unsigned short dev_class;
455 unsigned short dev_subclass;
456 char id[64];
457 char name[80];
458 struct snd_pcm_str streams[2];
459 struct mutex open_mutex;
460 wait_queue_head_t open_wait;
461 void *private_data;
462 void (*private_free) (struct snd_pcm *pcm);
463 struct device *dev; /* actual hw device this belongs to */
464 bool internal; /* pcm is for internal use only */
465 bool nonatomic; /* whole PCM operations are in non-atomic context */
466 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
467 struct snd_pcm_oss oss;
468 #endif
469 };
470
471 struct snd_pcm_notify {
472 int (*n_register) (struct snd_pcm * pcm);
473 int (*n_disconnect) (struct snd_pcm * pcm);
474 int (*n_unregister) (struct snd_pcm * pcm);
475 struct list_head list;
476 };
477
478 /*
479 * Registering
480 */
481
482 extern const struct file_operations snd_pcm_f_ops[2];
483
484 int snd_pcm_new(struct snd_card *card, const char *id, int device,
485 int playback_count, int capture_count,
486 struct snd_pcm **rpcm);
487 int snd_pcm_new_internal(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_stream(struct snd_pcm *pcm, int stream, int substream_count);
491
492 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
493
494 /*
495 * Native I/O
496 */
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 void snd_pcm_stream_lock(struct snd_pcm_substream *substream);
542 void snd_pcm_stream_unlock(struct snd_pcm_substream *substream);
543 void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream);
544 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream);
545 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream);
546 #define snd_pcm_stream_lock_irqsave(substream, flags) \
547 do { \
548 typecheck(unsigned long, flags); \
549 flags = _snd_pcm_stream_lock_irqsave(substream); \
550 } while (0)
551 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
552 unsigned long flags);
553
554 #define snd_pcm_group_for_each_entry(s, substream) \
555 list_for_each_entry(s, &substream->group->substreams, link_list)
556
557 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
558 {
559 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
560 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
561 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
562 }
563
564 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
565 {
566 return size * 8 / runtime->sample_bits;
567 }
568
569 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
570 {
571 return size * 8 / runtime->frame_bits;
572 }
573
574 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
575 {
576 return size * runtime->sample_bits / 8;
577 }
578
579 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
580 {
581 return size * runtime->frame_bits / 8;
582 }
583
584 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
585 {
586 return bytes % runtime->byte_align == 0;
587 }
588
589 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
590 {
591 struct snd_pcm_runtime *runtime = substream->runtime;
592 return frames_to_bytes(runtime, runtime->buffer_size);
593 }
594
595 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
596 {
597 struct snd_pcm_runtime *runtime = substream->runtime;
598 return frames_to_bytes(runtime, runtime->period_size);
599 }
600
601 /*
602 * result is: 0 ... (boundary - 1)
603 */
604 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
605 {
606 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
607 if (avail < 0)
608 avail += runtime->boundary;
609 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
610 avail -= runtime->boundary;
611 return avail;
612 }
613
614 /*
615 * result is: 0 ... (boundary - 1)
616 */
617 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
618 {
619 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
620 if (avail < 0)
621 avail += runtime->boundary;
622 return avail;
623 }
624
625 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
626 {
627 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
628 }
629
630 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
631 {
632 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
633 }
634
635 /**
636 * snd_pcm_playback_ready - check whether the playback buffer is available
637 * @substream: the pcm substream instance
638 *
639 * Checks whether enough free space is available on the playback buffer.
640 *
641 * Return: Non-zero if available, or zero if not.
642 */
643 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
644 {
645 struct snd_pcm_runtime *runtime = substream->runtime;
646 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
647 }
648
649 /**
650 * snd_pcm_capture_ready - check whether the capture buffer is available
651 * @substream: the pcm substream instance
652 *
653 * Checks whether enough capture data is available on the capture buffer.
654 *
655 * Return: Non-zero if available, or zero if not.
656 */
657 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
658 {
659 struct snd_pcm_runtime *runtime = substream->runtime;
660 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
661 }
662
663 /**
664 * snd_pcm_playback_data - check whether any data exists on the playback buffer
665 * @substream: the pcm substream instance
666 *
667 * Checks whether any data exists on the playback buffer.
668 *
669 * Return: Non-zero if any data exists, or zero if not. If stop_threshold
670 * is bigger or equal to boundary, then this function returns always non-zero.
671 */
672 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
673 {
674 struct snd_pcm_runtime *runtime = substream->runtime;
675
676 if (runtime->stop_threshold >= runtime->boundary)
677 return 1;
678 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
679 }
680
681 /**
682 * snd_pcm_playback_empty - check whether the playback buffer is empty
683 * @substream: the pcm substream instance
684 *
685 * Checks whether the playback buffer is empty.
686 *
687 * Return: Non-zero if empty, or zero if not.
688 */
689 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
690 {
691 struct snd_pcm_runtime *runtime = substream->runtime;
692 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
693 }
694
695 /**
696 * snd_pcm_capture_empty - check whether the capture buffer is empty
697 * @substream: the pcm substream instance
698 *
699 * Checks whether the capture buffer is empty.
700 *
701 * Return: Non-zero if empty, or zero if not.
702 */
703 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
704 {
705 struct snd_pcm_runtime *runtime = substream->runtime;
706 return snd_pcm_capture_avail(runtime) == 0;
707 }
708
709 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
710 struct snd_pcm_substream *master)
711 {
712 substream->runtime->trigger_master = master;
713 }
714
715 static inline int hw_is_mask(int var)
716 {
717 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
718 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
719 }
720
721 static inline int hw_is_interval(int var)
722 {
723 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
724 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
725 }
726
727 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
728 snd_pcm_hw_param_t var)
729 {
730 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
731 }
732
733 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
734 snd_pcm_hw_param_t var)
735 {
736 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
737 }
738
739 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
740 snd_pcm_hw_param_t var)
741 {
742 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
743 }
744
745 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
746 snd_pcm_hw_param_t var)
747 {
748 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
749 }
750
751 #define params_channels(p) \
752 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min)
753 #define params_rate(p) \
754 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min)
755 #define params_period_size(p) \
756 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min)
757 #define params_periods(p) \
758 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min)
759 #define params_buffer_size(p) \
760 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min)
761 #define params_buffer_bytes(p) \
762 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min)
763
764 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
765 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
766 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
767 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
768 unsigned int k, struct snd_interval *c);
769 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
770 const struct snd_interval *b, struct snd_interval *c);
771 int snd_interval_list(struct snd_interval *i, unsigned int count,
772 const unsigned int *list, unsigned int mask);
773 int snd_interval_ratnum(struct snd_interval *i,
774 unsigned int rats_count, struct snd_ratnum *rats,
775 unsigned int *nump, unsigned int *denp);
776
777 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
778 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
779 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
780
781 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
782
783 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
784 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
785
786 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
787 u_int32_t mask);
788 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
789 u_int64_t mask);
790 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
791 unsigned int min, unsigned int max);
792 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
793 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
794 unsigned int cond,
795 snd_pcm_hw_param_t var,
796 const struct snd_pcm_hw_constraint_list *l);
797 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
798 unsigned int cond,
799 snd_pcm_hw_param_t var,
800 struct snd_pcm_hw_constraint_ratnums *r);
801 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
802 unsigned int cond,
803 snd_pcm_hw_param_t var,
804 struct snd_pcm_hw_constraint_ratdens *r);
805 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
806 unsigned int cond,
807 unsigned int width,
808 unsigned int msbits);
809 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
810 unsigned int cond,
811 snd_pcm_hw_param_t var,
812 unsigned long step);
813 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
814 unsigned int cond,
815 snd_pcm_hw_param_t var);
816 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
817 unsigned int base_rate);
818 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
819 unsigned int cond,
820 int var,
821 snd_pcm_hw_rule_func_t func, void *private,
822 int dep, ...);
823
824 int snd_pcm_format_signed(snd_pcm_format_t format);
825 int snd_pcm_format_unsigned(snd_pcm_format_t format);
826 int snd_pcm_format_linear(snd_pcm_format_t format);
827 int snd_pcm_format_little_endian(snd_pcm_format_t format);
828 int snd_pcm_format_big_endian(snd_pcm_format_t format);
829 #if 0 /* just for DocBook */
830 /**
831 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
832 * @format: the format to check
833 *
834 * Return: 1 if the given PCM format is CPU-endian, 0 if
835 * opposite, or a negative error code if endian not specified.
836 */
837 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
838 #endif /* DocBook */
839 #ifdef SNDRV_LITTLE_ENDIAN
840 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
841 #else
842 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
843 #endif
844 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
845 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
846 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
847 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
848 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
849 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsigned, int big_endian);
850
851 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
852 const struct snd_pcm_ops *ops);
853 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
854 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
855 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
856 unsigned int cmd, void *arg);
857 int snd_pcm_update_state(struct snd_pcm_substream *substream,
858 struct snd_pcm_runtime *runtime);
859 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
860 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
861 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
862 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
863 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
864 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
865 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
866 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
867 const void __user *buf,
868 snd_pcm_uframes_t frames);
869 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
870 void __user *buf, snd_pcm_uframes_t frames);
871 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
872 void __user **bufs, snd_pcm_uframes_t frames);
873 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
874 void __user **bufs, snd_pcm_uframes_t frames);
875
876 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
877
878 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
879 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
880 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
881 unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
882 unsigned int rates_b);
883
884 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
885 struct snd_dma_buffer *bufp)
886 {
887 struct snd_pcm_runtime *runtime = substream->runtime;
888 if (bufp) {
889 runtime->dma_buffer_p = bufp;
890 runtime->dma_area = bufp->area;
891 runtime->dma_addr = bufp->addr;
892 runtime->dma_bytes = bufp->bytes;
893 } else {
894 runtime->dma_buffer_p = NULL;
895 runtime->dma_area = NULL;
896 runtime->dma_addr = 0;
897 runtime->dma_bytes = 0;
898 }
899 }
900
901 /*
902 * Timer interface
903 */
904
905 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
906 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
907 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
908
909 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
910 struct timespec *tv)
911 {
912 switch (runtime->tstamp_type) {
913 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC:
914 ktime_get_ts(tv);
915 break;
916 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW:
917 getrawmonotonic(tv);
918 break;
919 default:
920 getnstimeofday(tv);
921 break;
922 }
923 }
924
925 /*
926 * Memory
927 */
928
929 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
930 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
931 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
932 int type, struct device *data,
933 size_t size, size_t max);
934 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
935 int type, void *data,
936 size_t size, size_t max);
937 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
938 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
939
940 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
941 size_t size, gfp_t gfp_flags);
942 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
943 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
944 unsigned long offset);
945 #if 0 /* for kernel-doc */
946 /**
947 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
948 * @substream: the substream to allocate the buffer to
949 * @size: the requested buffer size, in bytes
950 *
951 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
952 * contiguous in kernel virtual space, but not in physical memory. Use this
953 * if the buffer is accessed by kernel code but not by device DMA.
954 *
955 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
956 * code.
957 */
958 static int snd_pcm_lib_alloc_vmalloc_buffer
959 (struct snd_pcm_substream *substream, size_t size);
960 /**
961 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
962 * @substream: the substream to allocate the buffer to
963 * @size: the requested buffer size, in bytes
964 *
965 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
966 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
967 *
968 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
969 * code.
970 */
971 static int snd_pcm_lib_alloc_vmalloc_32_buffer
972 (struct snd_pcm_substream *substream, size_t size);
973 #endif
974 #define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
975 _snd_pcm_lib_alloc_vmalloc_buffer \
976 (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
977 #define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
978 _snd_pcm_lib_alloc_vmalloc_buffer \
979 (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
980
981 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
982
983 #ifdef CONFIG_SND_DMA_SGBUF
984 /*
985 * SG-buffer handling
986 */
987 #define snd_pcm_substream_sgbuf(substream) \
988 snd_pcm_get_dma_buf(substream)->private_data
989
990 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
991 unsigned long offset);
992 #else /* !SND_DMA_SGBUF */
993 /*
994 * fake using a continuous buffer
995 */
996 #define snd_pcm_sgbuf_ops_page NULL
997 #endif /* SND_DMA_SGBUF */
998
999 static inline dma_addr_t
1000 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1001 {
1002 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
1003 }
1004
1005 static inline void *
1006 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1007 {
1008 return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
1009 }
1010
1011 static inline unsigned int
1012 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1013 unsigned int ofs, unsigned int size)
1014 {
1015 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1016 }
1017
1018 /* handle mmap counter - PCM mmap callback should handle this counter properly */
1019 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1020 {
1021 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1022 atomic_inc(&substream->mmap_count);
1023 }
1024
1025 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1026 {
1027 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1028 atomic_dec(&substream->mmap_count);
1029 }
1030
1031 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1032 struct vm_area_struct *area);
1033 /* mmap for io-memory area */
1034 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1035 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
1036 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1037 #else
1038 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
1039 #define snd_pcm_lib_mmap_iomem NULL
1040 #endif
1041
1042 #define snd_pcm_lib_mmap_vmalloc NULL
1043
1044 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1045 {
1046 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1047 }
1048
1049 /*
1050 * Misc
1051 */
1052
1053 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1054 (IEC958_AES1_CON_ORIGINAL<<8)|\
1055 (IEC958_AES1_CON_PCM_CODER<<8)|\
1056 (IEC958_AES3_CON_FS_48000<<24))
1057
1058 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1059
1060 const char *snd_pcm_format_name(snd_pcm_format_t format);
1061
1062 /**
1063 * snd_pcm_stream_str - Get a string naming the direction of a stream
1064 * @substream: the pcm substream instance
1065 *
1066 * Return: A string naming the direction of the stream.
1067 */
1068 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1069 {
1070 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1071 return "Playback";
1072 else
1073 return "Capture";
1074 }
1075
1076 /*
1077 * PCM channel-mapping control API
1078 */
1079 /* array element of channel maps */
1080 struct snd_pcm_chmap_elem {
1081 unsigned char channels;
1082 unsigned char map[15];
1083 };
1084
1085 /* channel map information; retrieved via snd_kcontrol_chip() */
1086 struct snd_pcm_chmap {
1087 struct snd_pcm *pcm; /* assigned PCM instance */
1088 int stream; /* PLAYBACK or CAPTURE */
1089 struct snd_kcontrol *kctl;
1090 const struct snd_pcm_chmap_elem *chmap;
1091 unsigned int max_channels;
1092 unsigned int channel_mask; /* optional: active channels bitmask */
1093 void *private_data; /* optional: private data pointer */
1094 };
1095
1096 /* get the PCM substream assigned to the given chmap info */
1097 static inline struct snd_pcm_substream *
1098 snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1099 {
1100 struct snd_pcm_substream *s;
1101 for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1102 if (s->number == idx)
1103 return s;
1104 return NULL;
1105 }
1106
1107 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1108 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1109 /* Other world's standard channel maps (C/LFE prior to RL/RR) */
1110 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1111
1112 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1113 #define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1114 #define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1115 #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1116
1117 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1118 const struct snd_pcm_chmap_elem *chmap,
1119 int max_channels,
1120 unsigned long private_value,
1121 struct snd_pcm_chmap **info_ret);
1122
1123 /* Strong-typed conversion of pcm_format to bitwise */
1124 static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1125 {
1126 return 1ULL << (__force int) pcm_format;
1127 }
1128
1129 /* printk helpers */
1130 #define pcm_err(pcm, fmt, args...) \
1131 dev_err((pcm)->card->dev, fmt, ##args)
1132 #define pcm_warn(pcm, fmt, args...) \
1133 dev_warn((pcm)->card->dev, fmt, ##args)
1134 #define pcm_dbg(pcm, fmt, args...) \
1135 dev_dbg((pcm)->card->dev, fmt, ##args)
1136
1137 #endif /* __SOUND_PCM_H */
ubuntu-bionic-kernel mirror