Loading...
1#ifndef __SOUND_PCM_H
2#define __SOUND_PCM_H
3
4/*
5 * Digital Audio (PCM) abstract layer
6 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
7 * Abramo Bagnara <abramo@alsa-project.org>
8 *
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 *
24 */
25
26#include <sound/asound.h>
27#include <sound/memalloc.h>
28#include <sound/minors.h>
29#include <linux/poll.h>
30#include <linux/mm.h>
31#include <linux/bitops.h>
32#include <linux/pm_qos_params.h>
33
34#define snd_pcm_substream_chip(substream) ((substream)->private_data)
35#define snd_pcm_chip(pcm) ((pcm)->private_data)
36
37#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
38#include "pcm_oss.h"
39#endif
40
41/*
42 * Hardware (lowlevel) section
43 */
44
45struct 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
61struct snd_pcm_substream;
62
63struct snd_pcm_ops {
64 int (*open)(struct snd_pcm_substream *substream);
65 int (*close)(struct snd_pcm_substream *substream);
66 int (*ioctl)(struct snd_pcm_substream * substream,
67 unsigned int cmd, void *arg);
68 int (*hw_params)(struct snd_pcm_substream *substream,
69 struct snd_pcm_hw_params *params);
70 int (*hw_free)(struct snd_pcm_substream *substream);
71 int (*prepare)(struct snd_pcm_substream *substream);
72 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
73 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
74 int (*copy)(struct snd_pcm_substream *substream, int channel,
75 snd_pcm_uframes_t pos,
76 void __user *buf, snd_pcm_uframes_t count);
77 int (*silence)(struct snd_pcm_substream *substream, int channel,
78 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
79 struct page *(*page)(struct snd_pcm_substream *substream,
80 unsigned long offset);
81 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
82 int (*ack)(struct snd_pcm_substream *substream);
83};
84
85/*
86 *
87 */
88
89#if defined(CONFIG_SND_DYNAMIC_MINORS)
90#define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
91#else
92#define SNDRV_PCM_DEVICES 8
93#endif
94
95#define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
96#define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
97
98#define SNDRV_PCM_IOCTL1_RESET 0
99#define SNDRV_PCM_IOCTL1_INFO 1
100#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
101#define SNDRV_PCM_IOCTL1_GSTATE 3
102#define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
103
104#define SNDRV_PCM_TRIGGER_STOP 0
105#define SNDRV_PCM_TRIGGER_START 1
106#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
107#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
108#define SNDRV_PCM_TRIGGER_SUSPEND 5
109#define SNDRV_PCM_TRIGGER_RESUME 6
110
111#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
112
113/* If you change this don't forget to change rates[] table in pcm_native.c */
114#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
115#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
116#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
117#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
118#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
119#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
120#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
121#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
122#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
123#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
124#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
125#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
126#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
127
128#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
129#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
130
131#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
132 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
133 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
134#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
135#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
136 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
137#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
138 SNDRV_PCM_RATE_192000)
139#define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
140#define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
141#define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
142#define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
143#define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
144#define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
145#define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
146#define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
147#define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
148#define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
149#define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
150#define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE)
151#define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE)
152#define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE)
153#define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE)
154#define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE)
155#define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE)
156#define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE)
157#define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE)
158#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
159#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
160#define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW)
161#define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW)
162#define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM)
163#define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG)
164#define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM)
165#define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
166#define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
167#define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
168#define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
169#define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
170#define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
171#define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
172#define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
173#define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
174#define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
175#define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
176#define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
177#define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
178#define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
179#define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
180#define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
181#define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
182
183#ifdef SNDRV_LITTLE_ENDIAN
184#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
185#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
186#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
187#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
188#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
189#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
190#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
191#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
192#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
193#endif
194#ifdef SNDRV_BIG_ENDIAN
195#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
196#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
197#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
198#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
199#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
200#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
201#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
202#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
203#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
204#endif
205
206struct snd_pcm_file {
207 struct snd_pcm_substream *substream;
208 int no_compat_mmap;
209};
210
211struct snd_pcm_hw_rule;
212typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
213 struct snd_pcm_hw_rule *rule);
214
215struct snd_pcm_hw_rule {
216 unsigned int cond;
217 snd_pcm_hw_rule_func_t func;
218 int var;
219 int deps[4];
220 void *private;
221};
222
223struct snd_pcm_hw_constraints {
224 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
225 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
226 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
227 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
228 unsigned int rules_num;
229 unsigned int rules_all;
230 struct snd_pcm_hw_rule *rules;
231};
232
233static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
234 snd_pcm_hw_param_t var)
235{
236 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
237}
238
239static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
240 snd_pcm_hw_param_t var)
241{
242 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
243}
244
245struct snd_ratnum {
246 unsigned int num;
247 unsigned int den_min, den_max, den_step;
248};
249
250struct snd_ratden {
251 unsigned int num_min, num_max, num_step;
252 unsigned int den;
253};
254
255struct snd_pcm_hw_constraint_ratnums {
256 int nrats;
257 struct snd_ratnum *rats;
258};
259
260struct snd_pcm_hw_constraint_ratdens {
261 int nrats;
262 struct snd_ratden *rats;
263};
264
265struct snd_pcm_hw_constraint_list {
266 unsigned int count;
267 unsigned int *list;
268 unsigned int mask;
269};
270
271struct snd_pcm_hwptr_log;
272
273struct snd_pcm_runtime {
274 /* -- Status -- */
275 struct snd_pcm_substream *trigger_master;
276 struct timespec trigger_tstamp; /* trigger timestamp */
277 int overrange;
278 snd_pcm_uframes_t avail_max;
279 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
280 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
281 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
282 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
283 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
284
285 /* -- HW params -- */
286 snd_pcm_access_t access; /* access mode */
287 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
288 snd_pcm_subformat_t subformat; /* subformat */
289 unsigned int rate; /* rate in Hz */
290 unsigned int channels; /* channels */
291 snd_pcm_uframes_t period_size; /* period size */
292 unsigned int periods; /* periods */
293 snd_pcm_uframes_t buffer_size; /* buffer size */
294 snd_pcm_uframes_t min_align; /* Min alignment for the format */
295 size_t byte_align;
296 unsigned int frame_bits;
297 unsigned int sample_bits;
298 unsigned int info;
299 unsigned int rate_num;
300 unsigned int rate_den;
301 unsigned int no_period_wakeup: 1;
302
303 /* -- SW params -- */
304 int tstamp_mode; /* mmap timestamp is updated */
305 unsigned int period_step;
306 snd_pcm_uframes_t start_threshold;
307 snd_pcm_uframes_t stop_threshold;
308 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
309 noise is nearest than this */
310 snd_pcm_uframes_t silence_size; /* Silence filling size */
311 snd_pcm_uframes_t boundary; /* pointers wrap point */
312
313 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
314 snd_pcm_uframes_t silence_filled; /* size filled with silence */
315
316 union snd_pcm_sync_id sync; /* hardware synchronization ID */
317
318 /* -- mmap -- */
319 struct snd_pcm_mmap_status *status;
320 struct snd_pcm_mmap_control *control;
321
322 /* -- locking / scheduling -- */
323 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
324 wait_queue_head_t sleep; /* poll sleep */
325 wait_queue_head_t tsleep; /* transfer sleep */
326 struct fasync_struct *fasync;
327
328 /* -- private section -- */
329 void *private_data;
330 void (*private_free)(struct snd_pcm_runtime *runtime);
331
332 /* -- hardware description -- */
333 struct snd_pcm_hardware hw;
334 struct snd_pcm_hw_constraints hw_constraints;
335
336 /* -- interrupt callbacks -- */
337 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
338 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
339
340 /* -- timer -- */
341 unsigned int timer_resolution; /* timer resolution */
342 int tstamp_type; /* timestamp type */
343
344 /* -- DMA -- */
345 unsigned char *dma_area; /* DMA area */
346 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
347 size_t dma_bytes; /* size of DMA area */
348
349 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
350
351#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
352 /* -- OSS things -- */
353 struct snd_pcm_oss_runtime oss;
354#endif
355
356#ifdef CONFIG_SND_PCM_XRUN_DEBUG
357 struct snd_pcm_hwptr_log *hwptr_log;
358#endif
359};
360
361struct snd_pcm_group { /* keep linked substreams */
362 spinlock_t lock;
363 struct list_head substreams;
364 int count;
365};
366
367struct pid;
368
369struct snd_pcm_substream {
370 struct snd_pcm *pcm;
371 struct snd_pcm_str *pstr;
372 void *private_data; /* copied from pcm->private_data */
373 int number;
374 char name[32]; /* substream name */
375 int stream; /* stream (direction) */
376 struct pm_qos_request_list latency_pm_qos_req; /* pm_qos request */
377 size_t buffer_bytes_max; /* limit ring buffer size */
378 struct snd_dma_buffer dma_buffer;
379 unsigned int dma_buf_id;
380 size_t dma_max;
381 /* -- hardware operations -- */
382 struct snd_pcm_ops *ops;
383 /* -- runtime information -- */
384 struct snd_pcm_runtime *runtime;
385 /* -- timer section -- */
386 struct snd_timer *timer; /* timer */
387 unsigned timer_running: 1; /* time is running */
388 /* -- next substream -- */
389 struct snd_pcm_substream *next;
390 /* -- linked substreams -- */
391 struct list_head link_list; /* linked list member */
392 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
393 struct snd_pcm_group *group; /* pointer to current group */
394 /* -- assigned files -- */
395 void *file;
396 int ref_count;
397 atomic_t mmap_count;
398 unsigned int f_flags;
399 void (*pcm_release)(struct snd_pcm_substream *);
400 struct pid *pid;
401#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
402 /* -- OSS things -- */
403 struct snd_pcm_oss_substream oss;
404#endif
405#ifdef CONFIG_SND_VERBOSE_PROCFS
406 struct snd_info_entry *proc_root;
407 struct snd_info_entry *proc_info_entry;
408 struct snd_info_entry *proc_hw_params_entry;
409 struct snd_info_entry *proc_sw_params_entry;
410 struct snd_info_entry *proc_status_entry;
411 struct snd_info_entry *proc_prealloc_entry;
412 struct snd_info_entry *proc_prealloc_max_entry;
413#endif
414 /* misc flags */
415 unsigned int hw_opened: 1;
416};
417
418#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
419
420
421struct snd_pcm_str {
422 int stream; /* stream (direction) */
423 struct snd_pcm *pcm;
424 /* -- substreams -- */
425 unsigned int substream_count;
426 unsigned int substream_opened;
427 struct snd_pcm_substream *substream;
428#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
429 /* -- OSS things -- */
430 struct snd_pcm_oss_stream oss;
431#endif
432#ifdef CONFIG_SND_VERBOSE_PROCFS
433 struct snd_info_entry *proc_root;
434 struct snd_info_entry *proc_info_entry;
435#ifdef CONFIG_SND_PCM_XRUN_DEBUG
436 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
437 struct snd_info_entry *proc_xrun_debug_entry;
438#endif
439#endif
440};
441
442struct snd_pcm {
443 struct snd_card *card;
444 struct list_head list;
445 int device; /* device number */
446 unsigned int info_flags;
447 unsigned short dev_class;
448 unsigned short dev_subclass;
449 char id[64];
450 char name[80];
451 struct snd_pcm_str streams[2];
452 struct mutex open_mutex;
453 wait_queue_head_t open_wait;
454 void *private_data;
455 void (*private_free) (struct snd_pcm *pcm);
456 struct device *dev; /* actual hw device this belongs to */
457#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
458 struct snd_pcm_oss oss;
459#endif
460};
461
462struct snd_pcm_notify {
463 int (*n_register) (struct snd_pcm * pcm);
464 int (*n_disconnect) (struct snd_pcm * pcm);
465 int (*n_unregister) (struct snd_pcm * pcm);
466 struct list_head list;
467};
468
469/*
470 * Registering
471 */
472
473extern const struct file_operations snd_pcm_f_ops[2];
474
475int snd_pcm_new(struct snd_card *card, const char *id, int device,
476 int playback_count, int capture_count,
477 struct snd_pcm **rpcm);
478int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
479
480int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
481
482/*
483 * Native I/O
484 */
485
486extern rwlock_t snd_pcm_link_rwlock;
487
488int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
489int snd_pcm_info_user(struct snd_pcm_substream *substream,
490 struct snd_pcm_info __user *info);
491int snd_pcm_status(struct snd_pcm_substream *substream,
492 struct snd_pcm_status *status);
493int snd_pcm_start(struct snd_pcm_substream *substream);
494int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
495int snd_pcm_drain_done(struct snd_pcm_substream *substream);
496#ifdef CONFIG_PM
497int snd_pcm_suspend(struct snd_pcm_substream *substream);
498int snd_pcm_suspend_all(struct snd_pcm *pcm);
499#endif
500int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
501int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
502 struct snd_pcm_substream **rsubstream);
503void snd_pcm_release_substream(struct snd_pcm_substream *substream);
504int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
505 struct snd_pcm_substream **rsubstream);
506void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
507void snd_pcm_vma_notify_data(void *client, void *data);
508int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
509
510
511#ifdef CONFIG_SND_DEBUG
512void snd_pcm_debug_name(struct snd_pcm_substream *substream,
513 char *name, size_t len);
514#else
515static inline void
516snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
517{
518 *buf = 0;
519}
520#endif
521
522/*
523 * PCM library
524 */
525
526static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
527{
528 return substream->group != &substream->self_group;
529}
530
531static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
532{
533 read_lock(&snd_pcm_link_rwlock);
534 spin_lock(&substream->self_group.lock);
535}
536
537static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
538{
539 spin_unlock(&substream->self_group.lock);
540 read_unlock(&snd_pcm_link_rwlock);
541}
542
543static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
544{
545 read_lock_irq(&snd_pcm_link_rwlock);
546 spin_lock(&substream->self_group.lock);
547}
548
549static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
550{
551 spin_unlock(&substream->self_group.lock);
552 read_unlock_irq(&snd_pcm_link_rwlock);
553}
554
555#define snd_pcm_stream_lock_irqsave(substream, flags) \
556do { \
557 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
558 spin_lock(&substream->self_group.lock); \
559} while (0)
560
561#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
562do { \
563 spin_unlock(&substream->self_group.lock); \
564 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
565} while (0)
566
567#define snd_pcm_group_for_each_entry(s, substream) \
568 list_for_each_entry(s, &substream->group->substreams, link_list)
569
570static inline int snd_pcm_running(struct snd_pcm_substream *substream)
571{
572 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
573 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
574 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
575}
576
577static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
578{
579 return size * 8 / runtime->sample_bits;
580}
581
582static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
583{
584 return size * 8 / runtime->frame_bits;
585}
586
587static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
588{
589 return size * runtime->sample_bits / 8;
590}
591
592static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
593{
594 return size * runtime->frame_bits / 8;
595}
596
597static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
598{
599 return bytes % runtime->byte_align == 0;
600}
601
602static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
603{
604 struct snd_pcm_runtime *runtime = substream->runtime;
605 return frames_to_bytes(runtime, runtime->buffer_size);
606}
607
608static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
609{
610 struct snd_pcm_runtime *runtime = substream->runtime;
611 return frames_to_bytes(runtime, runtime->period_size);
612}
613
614/*
615 * result is: 0 ... (boundary - 1)
616 */
617static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
618{
619 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
620 if (avail < 0)
621 avail += runtime->boundary;
622 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
623 avail -= runtime->boundary;
624 return avail;
625}
626
627/*
628 * result is: 0 ... (boundary - 1)
629 */
630static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
631{
632 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
633 if (avail < 0)
634 avail += runtime->boundary;
635 return avail;
636}
637
638static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
639{
640 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
641}
642
643static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
644{
645 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
646}
647
648/**
649 * snd_pcm_playback_ready - check whether the playback buffer is available
650 * @substream: the pcm substream instance
651 *
652 * Checks whether enough free space is available on the playback buffer.
653 *
654 * Returns non-zero if available, or zero if not.
655 */
656static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
657{
658 struct snd_pcm_runtime *runtime = substream->runtime;
659 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
660}
661
662/**
663 * snd_pcm_capture_ready - check whether the capture buffer is available
664 * @substream: the pcm substream instance
665 *
666 * Checks whether enough capture data is available on the capture buffer.
667 *
668 * Returns non-zero if available, or zero if not.
669 */
670static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
671{
672 struct snd_pcm_runtime *runtime = substream->runtime;
673 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
674}
675
676/**
677 * snd_pcm_playback_data - check whether any data exists on the playback buffer
678 * @substream: the pcm substream instance
679 *
680 * Checks whether any data exists on the playback buffer. If stop_threshold
681 * is bigger or equal to boundary, then this function returns always non-zero.
682 *
683 * Returns non-zero if exists, or zero if not.
684 */
685static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
686{
687 struct snd_pcm_runtime *runtime = substream->runtime;
688
689 if (runtime->stop_threshold >= runtime->boundary)
690 return 1;
691 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
692}
693
694/**
695 * snd_pcm_playback_empty - check whether the playback buffer is empty
696 * @substream: the pcm substream instance
697 *
698 * Checks whether the playback buffer is empty.
699 *
700 * Returns non-zero if empty, or zero if not.
701 */
702static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
703{
704 struct snd_pcm_runtime *runtime = substream->runtime;
705 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
706}
707
708/**
709 * snd_pcm_capture_empty - check whether the capture buffer is empty
710 * @substream: the pcm substream instance
711 *
712 * Checks whether the capture buffer is empty.
713 *
714 * Returns non-zero if empty, or zero if not.
715 */
716static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
717{
718 struct snd_pcm_runtime *runtime = substream->runtime;
719 return snd_pcm_capture_avail(runtime) == 0;
720}
721
722static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
723 struct snd_pcm_substream *master)
724{
725 substream->runtime->trigger_master = master;
726}
727
728static inline int hw_is_mask(int var)
729{
730 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
731 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
732}
733
734static inline int hw_is_interval(int var)
735{
736 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
737 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
738}
739
740static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
741 snd_pcm_hw_param_t var)
742{
743 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
744}
745
746static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
747 snd_pcm_hw_param_t var)
748{
749 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
750}
751
752static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
753 snd_pcm_hw_param_t var)
754{
755 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
756}
757
758static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
759 snd_pcm_hw_param_t var)
760{
761 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
762}
763
764#define params_channels(p) \
765 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min)
766#define params_rate(p) \
767 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min)
768#define params_period_size(p) \
769 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min)
770#define params_periods(p) \
771 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min)
772#define params_buffer_size(p) \
773 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min)
774#define params_buffer_bytes(p) \
775 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min)
776
777int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
778void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
779void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
780void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
781 unsigned int k, struct snd_interval *c);
782void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
783 const struct snd_interval *b, struct snd_interval *c);
784int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
785int snd_interval_ratnum(struct snd_interval *i,
786 unsigned int rats_count, struct snd_ratnum *rats,
787 unsigned int *nump, unsigned int *denp);
788
789void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
790void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
791int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
792
793int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
794
795int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
796int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
797
798int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
799 u_int32_t mask);
800int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
801 u_int64_t mask);
802int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
803 unsigned int min, unsigned int max);
804int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
805int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
806 unsigned int cond,
807 snd_pcm_hw_param_t var,
808 struct snd_pcm_hw_constraint_list *l);
809int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
810 unsigned int cond,
811 snd_pcm_hw_param_t var,
812 struct snd_pcm_hw_constraint_ratnums *r);
813int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
814 unsigned int cond,
815 snd_pcm_hw_param_t var,
816 struct snd_pcm_hw_constraint_ratdens *r);
817int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
818 unsigned int cond,
819 unsigned int width,
820 unsigned int msbits);
821int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
822 unsigned int cond,
823 snd_pcm_hw_param_t var,
824 unsigned long step);
825int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
826 unsigned int cond,
827 snd_pcm_hw_param_t var);
828int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
829 unsigned int cond,
830 int var,
831 snd_pcm_hw_rule_func_t func, void *private,
832 int dep, ...);
833
834int snd_pcm_format_signed(snd_pcm_format_t format);
835int snd_pcm_format_unsigned(snd_pcm_format_t format);
836int snd_pcm_format_linear(snd_pcm_format_t format);
837int snd_pcm_format_little_endian(snd_pcm_format_t format);
838int snd_pcm_format_big_endian(snd_pcm_format_t format);
839#if 0 /* just for DocBook */
840/**
841 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
842 * @format: the format to check
843 *
844 * Returns 1 if the given PCM format is CPU-endian, 0 if
845 * opposite, or a negative error code if endian not specified.
846 */
847int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
848#endif /* DocBook */
849#ifdef SNDRV_LITTLE_ENDIAN
850#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
851#else
852#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
853#endif
854int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
855int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
856ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
857const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
858int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
859snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
860
861void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
862void snd_pcm_set_sync(struct snd_pcm_substream *substream);
863int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
864int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
865 unsigned int cmd, void *arg);
866int snd_pcm_update_state(struct snd_pcm_substream *substream,
867 struct snd_pcm_runtime *runtime);
868int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
869int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
870int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
871int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
872int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
873void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
874void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
875snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
876 const void __user *buf,
877 snd_pcm_uframes_t frames);
878snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
879 void __user *buf, snd_pcm_uframes_t frames);
880snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
881 void __user **bufs, snd_pcm_uframes_t frames);
882snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
883 void __user **bufs, snd_pcm_uframes_t frames);
884
885extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
886
887int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
888unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
889
890static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
891 struct snd_dma_buffer *bufp)
892{
893 struct snd_pcm_runtime *runtime = substream->runtime;
894 if (bufp) {
895 runtime->dma_buffer_p = bufp;
896 runtime->dma_area = bufp->area;
897 runtime->dma_addr = bufp->addr;
898 runtime->dma_bytes = bufp->bytes;
899 } else {
900 runtime->dma_buffer_p = NULL;
901 runtime->dma_area = NULL;
902 runtime->dma_addr = 0;
903 runtime->dma_bytes = 0;
904 }
905}
906
907/*
908 * Timer interface
909 */
910
911void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
912void snd_pcm_timer_init(struct snd_pcm_substream *substream);
913void snd_pcm_timer_done(struct snd_pcm_substream *substream);
914
915static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
916 struct timespec *tv)
917{
918 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
919 do_posix_clock_monotonic_gettime(tv);
920 else
921 getnstimeofday(tv);
922}
923
924/*
925 * Memory
926 */
927
928int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
929int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
930int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
931 int type, struct device *data,
932 size_t size, size_t max);
933int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
934 int type, void *data,
935 size_t size, size_t max);
936int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
937int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
938
939int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
940 size_t size, gfp_t gfp_flags);
941int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
942struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
943 unsigned long offset);
944#if 0 /* for kernel-doc */
945/**
946 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
947 * @substream: the substream to allocate the buffer to
948 * @size: the requested buffer size, in bytes
949 *
950 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
951 * contiguous in kernel virtual space, but not in physical memory. Use this
952 * if the buffer is accessed by kernel code but not by device DMA.
953 *
954 * Returns 1 if the buffer was changed, 0 if not changed, or a negative error
955 * code.
956 */
957static int snd_pcm_lib_alloc_vmalloc_buffer
958 (struct snd_pcm_substream *substream, size_t size);
959/**
960 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
961 * @substream: the substream to allocate the buffer to
962 * @size: the requested buffer size, in bytes
963 *
964 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
965 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
966 */
967static int snd_pcm_lib_alloc_vmalloc_32_buffer
968 (struct snd_pcm_substream *substream, size_t size);
969#endif
970#define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
971 _snd_pcm_lib_alloc_vmalloc_buffer \
972 (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
973#define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
974 _snd_pcm_lib_alloc_vmalloc_buffer \
975 (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
976
977#ifdef CONFIG_SND_DMA_SGBUF
978/*
979 * SG-buffer handling
980 */
981#define snd_pcm_substream_sgbuf(substream) \
982 ((substream)->runtime->dma_buffer_p->private_data)
983
984static inline dma_addr_t
985snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
986{
987 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
988 return snd_sgbuf_get_addr(sg, ofs);
989}
990
991static inline void *
992snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
993{
994 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
995 return snd_sgbuf_get_ptr(sg, ofs);
996}
997
998struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
999 unsigned long offset);
1000unsigned int snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1001 unsigned int ofs, unsigned int size);
1002
1003#else /* !SND_DMA_SGBUF */
1004/*
1005 * fake using a continuous buffer
1006 */
1007static inline dma_addr_t
1008snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1009{
1010 return substream->runtime->dma_addr + ofs;
1011}
1012
1013static inline void *
1014snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1015{
1016 return substream->runtime->dma_area + ofs;
1017}
1018
1019#define snd_pcm_sgbuf_ops_page NULL
1020
1021#define snd_pcm_sgbuf_get_chunk_size(subs, ofs, size) (size)
1022
1023#endif /* SND_DMA_SGBUF */
1024
1025/* handle mmap counter - PCM mmap callback should handle this counter properly */
1026static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1027{
1028 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1029 atomic_inc(&substream->mmap_count);
1030}
1031
1032static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1033{
1034 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1035 atomic_dec(&substream->mmap_count);
1036}
1037
1038/* mmap for io-memory area */
1039#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1040#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
1041int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1042#else
1043#define SNDRV_PCM_INFO_MMAP_IOMEM 0
1044#define snd_pcm_lib_mmap_iomem NULL
1045#endif
1046
1047#define snd_pcm_lib_mmap_vmalloc NULL
1048
1049static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1050{
1051 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1052}
1053
1054/*
1055 * Misc
1056 */
1057
1058#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1059 (IEC958_AES1_CON_ORIGINAL<<8)|\
1060 (IEC958_AES1_CON_PCM_CODER<<8)|\
1061 (IEC958_AES3_CON_FS_48000<<24))
1062
1063#define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1064
1065const char *snd_pcm_format_name(snd_pcm_format_t format);
1066
1067#endif /* __SOUND_PCM_H */
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2#ifndef __SOUND_PCM_H
3#define __SOUND_PCM_H
4
5/*
6 * Digital Audio (PCM) abstract layer
7 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
8 * Abramo Bagnara <abramo@alsa-project.org>
9 */
10
11#include <sound/asound.h>
12#include <sound/memalloc.h>
13#include <sound/minors.h>
14#include <linux/poll.h>
15#include <linux/mm.h>
16#include <linux/bitops.h>
17#include <linux/pm_qos.h>
18#include <linux/refcount.h>
19#include <linux/uio.h>
20
21#define snd_pcm_substream_chip(substream) ((substream)->private_data)
22#define snd_pcm_chip(pcm) ((pcm)->private_data)
23
24#if IS_ENABLED(CONFIG_SND_PCM_OSS)
25#include <sound/pcm_oss.h>
26#endif
27
28/*
29 * Hardware (lowlevel) section
30 */
31
32struct snd_pcm_hardware {
33 unsigned int info; /* SNDRV_PCM_INFO_* */
34 u64 formats; /* SNDRV_PCM_FMTBIT_* */
35 u32 subformats; /* for S32_LE, SNDRV_PCM_SUBFMTBIT_* */
36 unsigned int rates; /* SNDRV_PCM_RATE_* */
37 unsigned int rate_min; /* min rate */
38 unsigned int rate_max; /* max rate */
39 unsigned int channels_min; /* min channels */
40 unsigned int channels_max; /* max channels */
41 size_t buffer_bytes_max; /* max buffer size */
42 size_t period_bytes_min; /* min period size */
43 size_t period_bytes_max; /* max period size */
44 unsigned int periods_min; /* min # of periods */
45 unsigned int periods_max; /* max # of periods */
46 size_t fifo_size; /* fifo size in bytes */
47};
48
49struct snd_pcm_status64;
50struct snd_pcm_substream;
51
52struct snd_pcm_audio_tstamp_config; /* definitions further down */
53struct snd_pcm_audio_tstamp_report;
54
55struct snd_pcm_ops {
56 int (*open)(struct snd_pcm_substream *substream);
57 int (*close)(struct snd_pcm_substream *substream);
58 int (*ioctl)(struct snd_pcm_substream * substream,
59 unsigned int cmd, void *arg);
60 int (*hw_params)(struct snd_pcm_substream *substream,
61 struct snd_pcm_hw_params *params);
62 int (*hw_free)(struct snd_pcm_substream *substream);
63 int (*prepare)(struct snd_pcm_substream *substream);
64 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
65 int (*sync_stop)(struct snd_pcm_substream *substream);
66 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
67 int (*get_time_info)(struct snd_pcm_substream *substream,
68 struct timespec64 *system_ts, struct timespec64 *audio_ts,
69 struct snd_pcm_audio_tstamp_config *audio_tstamp_config,
70 struct snd_pcm_audio_tstamp_report *audio_tstamp_report);
71 int (*fill_silence)(struct snd_pcm_substream *substream, int channel,
72 unsigned long pos, unsigned long bytes);
73 int (*copy)(struct snd_pcm_substream *substream, int channel,
74 unsigned long pos, struct iov_iter *iter, unsigned long bytes);
75 struct page *(*page)(struct snd_pcm_substream *substream,
76 unsigned long offset);
77 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
78 int (*ack)(struct snd_pcm_substream *substream);
79};
80
81/*
82 *
83 */
84
85#if defined(CONFIG_SND_DYNAMIC_MINORS)
86#define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
87#else
88#define SNDRV_PCM_DEVICES 8
89#endif
90
91#define SNDRV_PCM_IOCTL1_RESET 0
92/* 1 is absent slot. */
93#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
94/* 3 is absent slot. */
95#define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
96
97#define SNDRV_PCM_TRIGGER_STOP 0
98#define SNDRV_PCM_TRIGGER_START 1
99#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
100#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
101#define SNDRV_PCM_TRIGGER_SUSPEND 5
102#define SNDRV_PCM_TRIGGER_RESUME 6
103#define SNDRV_PCM_TRIGGER_DRAIN 7
104
105#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
106
107/* If you change this don't forget to change rates[] table in pcm_native.c */
108#define SNDRV_PCM_RATE_5512 (1U<<0) /* 5512Hz */
109#define SNDRV_PCM_RATE_8000 (1U<<1) /* 8000Hz */
110#define SNDRV_PCM_RATE_11025 (1U<<2) /* 11025Hz */
111#define SNDRV_PCM_RATE_16000 (1U<<3) /* 16000Hz */
112#define SNDRV_PCM_RATE_22050 (1U<<4) /* 22050Hz */
113#define SNDRV_PCM_RATE_32000 (1U<<5) /* 32000Hz */
114#define SNDRV_PCM_RATE_44100 (1U<<6) /* 44100Hz */
115#define SNDRV_PCM_RATE_48000 (1U<<7) /* 48000Hz */
116#define SNDRV_PCM_RATE_64000 (1U<<8) /* 64000Hz */
117#define SNDRV_PCM_RATE_88200 (1U<<9) /* 88200Hz */
118#define SNDRV_PCM_RATE_96000 (1U<<10) /* 96000Hz */
119#define SNDRV_PCM_RATE_176400 (1U<<11) /* 176400Hz */
120#define SNDRV_PCM_RATE_192000 (1U<<12) /* 192000Hz */
121#define SNDRV_PCM_RATE_352800 (1U<<13) /* 352800Hz */
122#define SNDRV_PCM_RATE_384000 (1U<<14) /* 384000Hz */
123
124#define SNDRV_PCM_RATE_CONTINUOUS (1U<<30) /* continuous range */
125#define SNDRV_PCM_RATE_KNOT (1U<<31) /* supports more non-continuos rates */
126
127#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
128 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
129 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
130#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
131#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
132 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
133#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
134 SNDRV_PCM_RATE_192000)
135#define SNDRV_PCM_RATE_8000_384000 (SNDRV_PCM_RATE_8000_192000|\
136 SNDRV_PCM_RATE_352800|\
137 SNDRV_PCM_RATE_384000)
138#define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
139#define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
140#define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
141#define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
142#define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
143#define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
144#define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
145#define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
146#define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
147#define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
148#define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
149// For S32/U32 formats, 'msbits' hardware parameter is often used to deliver information about the
150// available bit count in most significant bit. It's for the case of so-called 'left-justified' or
151// `right-padding` sample which has less width than 32 bit.
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_S20_LE _SNDRV_PCM_FMTBIT(S20_LE)
168#define SNDRV_PCM_FMTBIT_U20_LE _SNDRV_PCM_FMTBIT(U20_LE)
169#define SNDRV_PCM_FMTBIT_S20_BE _SNDRV_PCM_FMTBIT(S20_BE)
170#define SNDRV_PCM_FMTBIT_U20_BE _SNDRV_PCM_FMTBIT(U20_BE)
171#define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
172#define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
173#define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
174#define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
175#define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
176#define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
177#define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
178#define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
179#define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
180#define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
181#define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
182#define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
183#define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
184#define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
185#define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
186#define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
187#define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
188#define SNDRV_PCM_FMTBIT_DSD_U8 _SNDRV_PCM_FMTBIT(DSD_U8)
189#define SNDRV_PCM_FMTBIT_DSD_U16_LE _SNDRV_PCM_FMTBIT(DSD_U16_LE)
190#define SNDRV_PCM_FMTBIT_DSD_U32_LE _SNDRV_PCM_FMTBIT(DSD_U32_LE)
191#define SNDRV_PCM_FMTBIT_DSD_U16_BE _SNDRV_PCM_FMTBIT(DSD_U16_BE)
192#define SNDRV_PCM_FMTBIT_DSD_U32_BE _SNDRV_PCM_FMTBIT(DSD_U32_BE)
193
194#ifdef SNDRV_LITTLE_ENDIAN
195#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
196#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
197#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
198#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
199#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
200#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
201#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
202#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
203#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
204#define SNDRV_PCM_FMTBIT_S20 SNDRV_PCM_FMTBIT_S20_LE
205#define SNDRV_PCM_FMTBIT_U20 SNDRV_PCM_FMTBIT_U20_LE
206#endif
207#ifdef SNDRV_BIG_ENDIAN
208#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
209#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
210#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
211#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
212#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
213#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
214#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
215#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
216#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
217#define SNDRV_PCM_FMTBIT_S20 SNDRV_PCM_FMTBIT_S20_BE
218#define SNDRV_PCM_FMTBIT_U20 SNDRV_PCM_FMTBIT_U20_BE
219#endif
220
221#define _SNDRV_PCM_SUBFMTBIT(fmt) BIT((__force int)SNDRV_PCM_SUBFORMAT_##fmt)
222#define SNDRV_PCM_SUBFMTBIT_STD _SNDRV_PCM_SUBFMTBIT(STD)
223#define SNDRV_PCM_SUBFMTBIT_MSBITS_MAX _SNDRV_PCM_SUBFMTBIT(MSBITS_MAX)
224#define SNDRV_PCM_SUBFMTBIT_MSBITS_20 _SNDRV_PCM_SUBFMTBIT(MSBITS_20)
225#define SNDRV_PCM_SUBFMTBIT_MSBITS_24 _SNDRV_PCM_SUBFMTBIT(MSBITS_24)
226
227struct snd_pcm_file {
228 struct snd_pcm_substream *substream;
229 int no_compat_mmap;
230 unsigned int user_pversion; /* supported protocol version */
231};
232
233struct snd_pcm_hw_rule;
234typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
235 struct snd_pcm_hw_rule *rule);
236
237struct snd_pcm_hw_rule {
238 unsigned int cond;
239 int var;
240 int deps[5];
241
242 snd_pcm_hw_rule_func_t func;
243 void *private;
244};
245
246struct snd_pcm_hw_constraints {
247 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
248 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
249 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
250 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
251 unsigned int rules_num;
252 unsigned int rules_all;
253 struct snd_pcm_hw_rule *rules;
254};
255
256static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
257 snd_pcm_hw_param_t var)
258{
259 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
260}
261
262static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
263 snd_pcm_hw_param_t var)
264{
265 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
266}
267
268struct snd_ratnum {
269 unsigned int num;
270 unsigned int den_min, den_max, den_step;
271};
272
273struct snd_ratden {
274 unsigned int num_min, num_max, num_step;
275 unsigned int den;
276};
277
278struct snd_pcm_hw_constraint_ratnums {
279 int nrats;
280 const struct snd_ratnum *rats;
281};
282
283struct snd_pcm_hw_constraint_ratdens {
284 int nrats;
285 const struct snd_ratden *rats;
286};
287
288struct snd_pcm_hw_constraint_list {
289 const unsigned int *list;
290 unsigned int count;
291 unsigned int mask;
292};
293
294struct snd_pcm_hw_constraint_ranges {
295 unsigned int count;
296 const struct snd_interval *ranges;
297 unsigned int mask;
298};
299
300/*
301 * userspace-provided audio timestamp config to kernel,
302 * structure is for internal use only and filled with dedicated unpack routine
303 */
304struct snd_pcm_audio_tstamp_config {
305 /* 5 of max 16 bits used */
306 u32 type_requested:4;
307 u32 report_delay:1; /* add total delay to A/D or D/A */
308};
309
310static inline void snd_pcm_unpack_audio_tstamp_config(__u32 data,
311 struct snd_pcm_audio_tstamp_config *config)
312{
313 config->type_requested = data & 0xF;
314 config->report_delay = (data >> 4) & 1;
315}
316
317/*
318 * kernel-provided audio timestamp report to user-space
319 * structure is for internal use only and read by dedicated pack routine
320 */
321struct snd_pcm_audio_tstamp_report {
322 /* 6 of max 16 bits used for bit-fields */
323
324 /* for backwards compatibility */
325 u32 valid:1;
326
327 /* actual type if hardware could not support requested timestamp */
328 u32 actual_type:4;
329
330 /* accuracy represented in ns units */
331 u32 accuracy_report:1; /* 0 if accuracy unknown, 1 if accuracy field is valid */
332 u32 accuracy; /* up to 4.29s, will be packed in separate field */
333};
334
335static inline void snd_pcm_pack_audio_tstamp_report(__u32 *data, __u32 *accuracy,
336 const struct snd_pcm_audio_tstamp_report *report)
337{
338 u32 tmp;
339
340 tmp = report->accuracy_report;
341 tmp <<= 4;
342 tmp |= report->actual_type;
343 tmp <<= 1;
344 tmp |= report->valid;
345
346 *data &= 0xffff; /* zero-clear MSBs */
347 *data |= (tmp << 16);
348 *accuracy = report->accuracy;
349}
350
351
352struct snd_pcm_runtime {
353 /* -- Status -- */
354 snd_pcm_state_t state; /* stream state */
355 snd_pcm_state_t suspended_state; /* suspended stream state */
356 struct snd_pcm_substream *trigger_master;
357 struct timespec64 trigger_tstamp; /* trigger timestamp */
358 bool trigger_tstamp_latched; /* trigger timestamp latched in low-level driver/hardware */
359 int overrange;
360 snd_pcm_uframes_t avail_max;
361 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
362 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
363 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
364 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
365 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
366 u64 hw_ptr_wrap; /* offset for hw_ptr due to boundary wrap-around */
367
368 /* -- HW params -- */
369 snd_pcm_access_t access; /* access mode */
370 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
371 snd_pcm_subformat_t subformat; /* subformat */
372 unsigned int rate; /* rate in Hz */
373 unsigned int channels; /* channels */
374 snd_pcm_uframes_t period_size; /* period size */
375 unsigned int periods; /* periods */
376 snd_pcm_uframes_t buffer_size; /* buffer size */
377 snd_pcm_uframes_t min_align; /* Min alignment for the format */
378 size_t byte_align;
379 unsigned int frame_bits;
380 unsigned int sample_bits;
381 unsigned int info;
382 unsigned int rate_num;
383 unsigned int rate_den;
384 unsigned int no_period_wakeup: 1;
385
386 /* -- SW params; see struct snd_pcm_sw_params for comments -- */
387 int tstamp_mode;
388 unsigned int period_step;
389 snd_pcm_uframes_t start_threshold;
390 snd_pcm_uframes_t stop_threshold;
391 snd_pcm_uframes_t silence_threshold;
392 snd_pcm_uframes_t silence_size;
393 snd_pcm_uframes_t boundary;
394
395 /* internal data of auto-silencer */
396 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
397 snd_pcm_uframes_t silence_filled; /* already filled part of silence area */
398
399 union snd_pcm_sync_id sync; /* hardware synchronization ID */
400
401 /* -- mmap -- */
402 struct snd_pcm_mmap_status *status;
403 struct snd_pcm_mmap_control *control;
404
405 /* -- locking / scheduling -- */
406 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
407 wait_queue_head_t sleep; /* poll sleep */
408 wait_queue_head_t tsleep; /* transfer sleep */
409 struct snd_fasync *fasync;
410 bool stop_operating; /* sync_stop will be called */
411 struct mutex buffer_mutex; /* protect for buffer changes */
412 atomic_t buffer_accessing; /* >0: in r/w operation, <0: blocked */
413
414 /* -- private section -- */
415 void *private_data;
416 void (*private_free)(struct snd_pcm_runtime *runtime);
417
418 /* -- hardware description -- */
419 struct snd_pcm_hardware hw;
420 struct snd_pcm_hw_constraints hw_constraints;
421
422 /* -- timer -- */
423 unsigned int timer_resolution; /* timer resolution */
424 int tstamp_type; /* timestamp type */
425
426 /* -- DMA -- */
427 unsigned char *dma_area; /* DMA area */
428 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
429 size_t dma_bytes; /* size of DMA area */
430
431 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
432 unsigned int buffer_changed:1; /* buffer allocation changed; set only in managed mode */
433
434 /* -- audio timestamp config -- */
435 struct snd_pcm_audio_tstamp_config audio_tstamp_config;
436 struct snd_pcm_audio_tstamp_report audio_tstamp_report;
437 struct timespec64 driver_tstamp;
438
439#if IS_ENABLED(CONFIG_SND_PCM_OSS)
440 /* -- OSS things -- */
441 struct snd_pcm_oss_runtime oss;
442#endif
443};
444
445struct snd_pcm_group { /* keep linked substreams */
446 spinlock_t lock;
447 struct mutex mutex;
448 struct list_head substreams;
449 refcount_t refs;
450};
451
452struct pid;
453
454struct snd_pcm_substream {
455 struct snd_pcm *pcm;
456 struct snd_pcm_str *pstr;
457 void *private_data; /* copied from pcm->private_data */
458 int number;
459 char name[32]; /* substream name */
460 int stream; /* stream (direction) */
461 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
462 size_t buffer_bytes_max; /* limit ring buffer size */
463 struct snd_dma_buffer dma_buffer;
464 size_t dma_max;
465 /* -- hardware operations -- */
466 const struct snd_pcm_ops *ops;
467 /* -- runtime information -- */
468 struct snd_pcm_runtime *runtime;
469 /* -- timer section -- */
470 struct snd_timer *timer; /* timer */
471 unsigned timer_running: 1; /* time is running */
472 long wait_time; /* time in ms for R/W to wait for avail */
473 /* -- next substream -- */
474 struct snd_pcm_substream *next;
475 /* -- linked substreams -- */
476 struct list_head link_list; /* linked list member */
477 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
478 struct snd_pcm_group *group; /* pointer to current group */
479 /* -- assigned files -- */
480 int ref_count;
481 atomic_t mmap_count;
482 unsigned int f_flags;
483 void (*pcm_release)(struct snd_pcm_substream *);
484 struct pid *pid;
485#if IS_ENABLED(CONFIG_SND_PCM_OSS)
486 /* -- OSS things -- */
487 struct snd_pcm_oss_substream oss;
488#endif
489#ifdef CONFIG_SND_VERBOSE_PROCFS
490 struct snd_info_entry *proc_root;
491#endif /* CONFIG_SND_VERBOSE_PROCFS */
492 /* misc flags */
493 unsigned int hw_opened: 1;
494 unsigned int managed_buffer_alloc:1;
495};
496
497#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
498
499
500struct snd_pcm_str {
501 int stream; /* stream (direction) */
502 struct snd_pcm *pcm;
503 /* -- substreams -- */
504 unsigned int substream_count;
505 unsigned int substream_opened;
506 struct snd_pcm_substream *substream;
507#if IS_ENABLED(CONFIG_SND_PCM_OSS)
508 /* -- OSS things -- */
509 struct snd_pcm_oss_stream oss;
510#endif
511#ifdef CONFIG_SND_VERBOSE_PROCFS
512 struct snd_info_entry *proc_root;
513#ifdef CONFIG_SND_PCM_XRUN_DEBUG
514 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
515#endif
516#endif
517 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
518 struct device *dev;
519};
520
521struct snd_pcm {
522 struct snd_card *card;
523 struct list_head list;
524 int device; /* device number */
525 unsigned int info_flags;
526 unsigned short dev_class;
527 unsigned short dev_subclass;
528 char id[64];
529 char name[80];
530 struct snd_pcm_str streams[2];
531 struct mutex open_mutex;
532 wait_queue_head_t open_wait;
533 void *private_data;
534 void (*private_free) (struct snd_pcm *pcm);
535 bool internal; /* pcm is for internal use only */
536 bool nonatomic; /* whole PCM operations are in non-atomic context */
537 bool no_device_suspend; /* don't invoke device PM suspend */
538#if IS_ENABLED(CONFIG_SND_PCM_OSS)
539 struct snd_pcm_oss oss;
540#endif
541};
542
543/*
544 * Registering
545 */
546
547extern const struct file_operations snd_pcm_f_ops[2];
548
549int snd_pcm_new(struct snd_card *card, const char *id, int device,
550 int playback_count, int capture_count,
551 struct snd_pcm **rpcm);
552int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
553 int playback_count, int capture_count,
554 struct snd_pcm **rpcm);
555int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
556
557#if IS_ENABLED(CONFIG_SND_PCM_OSS)
558struct snd_pcm_notify {
559 int (*n_register) (struct snd_pcm * pcm);
560 int (*n_disconnect) (struct snd_pcm * pcm);
561 int (*n_unregister) (struct snd_pcm * pcm);
562 struct list_head list;
563};
564int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
565#endif
566
567/*
568 * Native I/O
569 */
570
571int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
572int snd_pcm_info_user(struct snd_pcm_substream *substream,
573 struct snd_pcm_info __user *info);
574int snd_pcm_status64(struct snd_pcm_substream *substream,
575 struct snd_pcm_status64 *status);
576int snd_pcm_start(struct snd_pcm_substream *substream);
577int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
578int snd_pcm_drain_done(struct snd_pcm_substream *substream);
579int snd_pcm_stop_xrun(struct snd_pcm_substream *substream);
580#ifdef CONFIG_PM
581int snd_pcm_suspend_all(struct snd_pcm *pcm);
582#else
583static inline int snd_pcm_suspend_all(struct snd_pcm *pcm)
584{
585 return 0;
586}
587#endif
588int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
589int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
590 struct snd_pcm_substream **rsubstream);
591void snd_pcm_release_substream(struct snd_pcm_substream *substream);
592int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
593 struct snd_pcm_substream **rsubstream);
594void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
595int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
596
597
598#ifdef CONFIG_SND_DEBUG
599void snd_pcm_debug_name(struct snd_pcm_substream *substream,
600 char *name, size_t len);
601#else
602static inline void
603snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
604{
605 *buf = 0;
606}
607#endif
608
609/*
610 * PCM library
611 */
612
613/**
614 * snd_pcm_stream_linked - Check whether the substream is linked with others
615 * @substream: substream to check
616 *
617 * Return: true if the given substream is being linked with others
618 */
619static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
620{
621 return substream->group != &substream->self_group;
622}
623
624void snd_pcm_stream_lock(struct snd_pcm_substream *substream);
625void snd_pcm_stream_unlock(struct snd_pcm_substream *substream);
626void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream);
627void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream);
628unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream);
629unsigned long _snd_pcm_stream_lock_irqsave_nested(struct snd_pcm_substream *substream);
630
631/**
632 * snd_pcm_stream_lock_irqsave - Lock the PCM stream
633 * @substream: PCM substream
634 * @flags: irq flags
635 *
636 * This locks the PCM stream like snd_pcm_stream_lock() but with the local
637 * IRQ (only when nonatomic is false). In nonatomic case, this is identical
638 * as snd_pcm_stream_lock().
639 */
640#define snd_pcm_stream_lock_irqsave(substream, flags) \
641 do { \
642 typecheck(unsigned long, flags); \
643 flags = _snd_pcm_stream_lock_irqsave(substream); \
644 } while (0)
645void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
646 unsigned long flags);
647
648/**
649 * snd_pcm_stream_lock_irqsave_nested - Single-nested PCM stream locking
650 * @substream: PCM substream
651 * @flags: irq flags
652 *
653 * This locks the PCM stream like snd_pcm_stream_lock_irqsave() but with
654 * the single-depth lockdep subclass.
655 */
656#define snd_pcm_stream_lock_irqsave_nested(substream, flags) \
657 do { \
658 typecheck(unsigned long, flags); \
659 flags = _snd_pcm_stream_lock_irqsave_nested(substream); \
660 } while (0)
661
662/* definitions for guard(); use like guard(pcm_stream_lock) */
663DEFINE_LOCK_GUARD_1(pcm_stream_lock, struct snd_pcm_substream,
664 snd_pcm_stream_lock(_T->lock),
665 snd_pcm_stream_unlock(_T->lock))
666DEFINE_LOCK_GUARD_1(pcm_stream_lock_irq, struct snd_pcm_substream,
667 snd_pcm_stream_lock_irq(_T->lock),
668 snd_pcm_stream_unlock_irq(_T->lock))
669DEFINE_LOCK_GUARD_1(pcm_stream_lock_irqsave, struct snd_pcm_substream,
670 snd_pcm_stream_lock_irqsave(_T->lock, _T->flags),
671 snd_pcm_stream_unlock_irqrestore(_T->lock, _T->flags),
672 unsigned long flags)
673
674/**
675 * snd_pcm_group_for_each_entry - iterate over the linked substreams
676 * @s: the iterator
677 * @substream: the substream
678 *
679 * Iterate over the all linked substreams to the given @substream.
680 * When @substream isn't linked with any others, this gives returns @substream
681 * itself once.
682 */
683#define snd_pcm_group_for_each_entry(s, substream) \
684 list_for_each_entry(s, &substream->group->substreams, link_list)
685
686#define for_each_pcm_streams(stream) \
687 for (stream = SNDRV_PCM_STREAM_PLAYBACK; \
688 stream <= SNDRV_PCM_STREAM_LAST; \
689 stream++)
690
691/**
692 * snd_pcm_running - Check whether the substream is in a running state
693 * @substream: substream to check
694 *
695 * Return: true if the given substream is in the state RUNNING, or in the
696 * state DRAINING for playback.
697 */
698static inline int snd_pcm_running(struct snd_pcm_substream *substream)
699{
700 return (substream->runtime->state == SNDRV_PCM_STATE_RUNNING ||
701 (substream->runtime->state == SNDRV_PCM_STATE_DRAINING &&
702 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
703}
704
705/**
706 * __snd_pcm_set_state - Change the current PCM state
707 * @runtime: PCM runtime to set
708 * @state: the current state to set
709 *
710 * Call within the stream lock
711 */
712static inline void __snd_pcm_set_state(struct snd_pcm_runtime *runtime,
713 snd_pcm_state_t state)
714{
715 runtime->state = state;
716 runtime->status->state = state; /* copy for mmap */
717}
718
719/**
720 * bytes_to_samples - Unit conversion of the size from bytes to samples
721 * @runtime: PCM runtime instance
722 * @size: size in bytes
723 *
724 * Return: the size in samples
725 */
726static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
727{
728 return size * 8 / runtime->sample_bits;
729}
730
731/**
732 * bytes_to_frames - Unit conversion of the size from bytes to frames
733 * @runtime: PCM runtime instance
734 * @size: size in bytes
735 *
736 * Return: the size in frames
737 */
738static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
739{
740 return size * 8 / runtime->frame_bits;
741}
742
743/**
744 * samples_to_bytes - Unit conversion of the size from samples to bytes
745 * @runtime: PCM runtime instance
746 * @size: size in samples
747 *
748 * Return: the byte size
749 */
750static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
751{
752 return size * runtime->sample_bits / 8;
753}
754
755/**
756 * frames_to_bytes - Unit conversion of the size from frames to bytes
757 * @runtime: PCM runtime instance
758 * @size: size in frames
759 *
760 * Return: the byte size
761 */
762static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
763{
764 return size * runtime->frame_bits / 8;
765}
766
767/**
768 * frame_aligned - Check whether the byte size is aligned to frames
769 * @runtime: PCM runtime instance
770 * @bytes: size in bytes
771 *
772 * Return: true if aligned, or false if not
773 */
774static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
775{
776 return bytes % runtime->byte_align == 0;
777}
778
779/**
780 * snd_pcm_lib_buffer_bytes - Get the buffer size of the current PCM in bytes
781 * @substream: PCM substream
782 *
783 * Return: buffer byte size
784 */
785static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
786{
787 struct snd_pcm_runtime *runtime = substream->runtime;
788 return frames_to_bytes(runtime, runtime->buffer_size);
789}
790
791/**
792 * snd_pcm_lib_period_bytes - Get the period size of the current PCM in bytes
793 * @substream: PCM substream
794 *
795 * Return: period byte size
796 */
797static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
798{
799 struct snd_pcm_runtime *runtime = substream->runtime;
800 return frames_to_bytes(runtime, runtime->period_size);
801}
802
803/**
804 * snd_pcm_playback_avail - Get the available (writable) space for playback
805 * @runtime: PCM runtime instance
806 *
807 * Result is between 0 ... (boundary - 1)
808 *
809 * Return: available frame size
810 */
811static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
812{
813 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
814 if (avail < 0)
815 avail += runtime->boundary;
816 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
817 avail -= runtime->boundary;
818 return avail;
819}
820
821/**
822 * snd_pcm_capture_avail - Get the available (readable) space for capture
823 * @runtime: PCM runtime instance
824 *
825 * Result is between 0 ... (boundary - 1)
826 *
827 * Return: available frame size
828 */
829static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
830{
831 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
832 if (avail < 0)
833 avail += runtime->boundary;
834 return avail;
835}
836
837/**
838 * snd_pcm_playback_hw_avail - Get the queued space for playback
839 * @runtime: PCM runtime instance
840 *
841 * Return: available frame size
842 */
843static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
844{
845 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
846}
847
848/**
849 * snd_pcm_capture_hw_avail - Get the free space for capture
850 * @runtime: PCM runtime instance
851 *
852 * Return: available frame size
853 */
854static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
855{
856 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
857}
858
859/**
860 * snd_pcm_playback_ready - check whether the playback buffer is available
861 * @substream: the pcm substream instance
862 *
863 * Checks whether enough free space is available on the playback buffer.
864 *
865 * Return: Non-zero if available, or zero if not.
866 */
867static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
868{
869 struct snd_pcm_runtime *runtime = substream->runtime;
870 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
871}
872
873/**
874 * snd_pcm_capture_ready - check whether the capture buffer is available
875 * @substream: the pcm substream instance
876 *
877 * Checks whether enough capture data is available on the capture buffer.
878 *
879 * Return: Non-zero if available, or zero if not.
880 */
881static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
882{
883 struct snd_pcm_runtime *runtime = substream->runtime;
884 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
885}
886
887/**
888 * snd_pcm_playback_data - check whether any data exists on the playback buffer
889 * @substream: the pcm substream instance
890 *
891 * Checks whether any data exists on the playback buffer.
892 *
893 * Return: Non-zero if any data exists, or zero if not. If stop_threshold
894 * is bigger or equal to boundary, then this function returns always non-zero.
895 */
896static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
897{
898 struct snd_pcm_runtime *runtime = substream->runtime;
899
900 if (runtime->stop_threshold >= runtime->boundary)
901 return 1;
902 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
903}
904
905/**
906 * snd_pcm_playback_empty - check whether the playback buffer is empty
907 * @substream: the pcm substream instance
908 *
909 * Checks whether the playback buffer is empty.
910 *
911 * Return: Non-zero if empty, or zero if not.
912 */
913static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
914{
915 struct snd_pcm_runtime *runtime = substream->runtime;
916 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
917}
918
919/**
920 * snd_pcm_capture_empty - check whether the capture buffer is empty
921 * @substream: the pcm substream instance
922 *
923 * Checks whether the capture buffer is empty.
924 *
925 * Return: Non-zero if empty, or zero if not.
926 */
927static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
928{
929 struct snd_pcm_runtime *runtime = substream->runtime;
930 return snd_pcm_capture_avail(runtime) == 0;
931}
932
933/**
934 * snd_pcm_trigger_done - Mark the master substream
935 * @substream: the pcm substream instance
936 * @master: the linked master substream
937 *
938 * When multiple substreams of the same card are linked and the hardware
939 * supports the single-shot operation, the driver calls this in the loop
940 * in snd_pcm_group_for_each_entry() for marking the substream as "done".
941 * Then most of trigger operations are performed only to the given master
942 * substream.
943 *
944 * The trigger_master mark is cleared at timestamp updates at the end
945 * of trigger operations.
946 */
947static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
948 struct snd_pcm_substream *master)
949{
950 substream->runtime->trigger_master = master;
951}
952
953static inline int hw_is_mask(int var)
954{
955 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
956 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
957}
958
959static inline int hw_is_interval(int var)
960{
961 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
962 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
963}
964
965static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
966 snd_pcm_hw_param_t var)
967{
968 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
969}
970
971static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
972 snd_pcm_hw_param_t var)
973{
974 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
975}
976
977static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
978 snd_pcm_hw_param_t var)
979{
980 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
981}
982
983static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
984 snd_pcm_hw_param_t var)
985{
986 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
987}
988
989/**
990 * params_channels - Get the number of channels from the hw params
991 * @p: hw params
992 *
993 * Return: the number of channels
994 */
995static inline unsigned int params_channels(const struct snd_pcm_hw_params *p)
996{
997 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_CHANNELS)->min;
998}
999
1000/**
1001 * params_rate - Get the sample rate from the hw params
1002 * @p: hw params
1003 *
1004 * Return: the sample rate
1005 */
1006static inline unsigned int params_rate(const struct snd_pcm_hw_params *p)
1007{
1008 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_RATE)->min;
1009}
1010
1011/**
1012 * params_period_size - Get the period size (in frames) from the hw params
1013 * @p: hw params
1014 *
1015 * Return: the period size in frames
1016 */
1017static inline unsigned int params_period_size(const struct snd_pcm_hw_params *p)
1018{
1019 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min;
1020}
1021
1022/**
1023 * params_periods - Get the number of periods from the hw params
1024 * @p: hw params
1025 *
1026 * Return: the number of periods
1027 */
1028static inline unsigned int params_periods(const struct snd_pcm_hw_params *p)
1029{
1030 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIODS)->min;
1031}
1032
1033/**
1034 * params_buffer_size - Get the buffer size (in frames) from the hw params
1035 * @p: hw params
1036 *
1037 * Return: the buffer size in frames
1038 */
1039static inline unsigned int params_buffer_size(const struct snd_pcm_hw_params *p)
1040{
1041 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min;
1042}
1043
1044/**
1045 * params_buffer_bytes - Get the buffer size (in bytes) from the hw params
1046 * @p: hw params
1047 *
1048 * Return: the buffer size in bytes
1049 */
1050static inline unsigned int params_buffer_bytes(const struct snd_pcm_hw_params *p)
1051{
1052 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min;
1053}
1054
1055int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
1056int snd_interval_list(struct snd_interval *i, unsigned int count,
1057 const unsigned int *list, unsigned int mask);
1058int snd_interval_ranges(struct snd_interval *i, unsigned int count,
1059 const struct snd_interval *list, unsigned int mask);
1060int snd_interval_ratnum(struct snd_interval *i,
1061 unsigned int rats_count, const struct snd_ratnum *rats,
1062 unsigned int *nump, unsigned int *denp);
1063
1064void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
1065void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
1066
1067int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1068
1069int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1070 u_int64_t mask);
1071int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1072 unsigned int min, unsigned int max);
1073int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
1074int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
1075 unsigned int cond,
1076 snd_pcm_hw_param_t var,
1077 const struct snd_pcm_hw_constraint_list *l);
1078int snd_pcm_hw_constraint_ranges(struct snd_pcm_runtime *runtime,
1079 unsigned int cond,
1080 snd_pcm_hw_param_t var,
1081 const struct snd_pcm_hw_constraint_ranges *r);
1082int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
1083 unsigned int cond,
1084 snd_pcm_hw_param_t var,
1085 const struct snd_pcm_hw_constraint_ratnums *r);
1086int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
1087 unsigned int cond,
1088 snd_pcm_hw_param_t var,
1089 const struct snd_pcm_hw_constraint_ratdens *r);
1090int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1091 unsigned int cond,
1092 unsigned int width,
1093 unsigned int msbits);
1094int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1095 unsigned int cond,
1096 snd_pcm_hw_param_t var,
1097 unsigned long step);
1098int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1099 unsigned int cond,
1100 snd_pcm_hw_param_t var);
1101int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
1102 unsigned int base_rate);
1103int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
1104 unsigned int cond,
1105 int var,
1106 snd_pcm_hw_rule_func_t func, void *private,
1107 int dep, ...);
1108
1109/**
1110 * snd_pcm_hw_constraint_single() - Constrain parameter to a single value
1111 * @runtime: PCM runtime instance
1112 * @var: The hw_params variable to constrain
1113 * @val: The value to constrain to
1114 *
1115 * Return: Positive if the value is changed, zero if it's not changed, or a
1116 * negative error code.
1117 */
1118static inline int snd_pcm_hw_constraint_single(
1119 struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1120 unsigned int val)
1121{
1122 return snd_pcm_hw_constraint_minmax(runtime, var, val, val);
1123}
1124
1125int snd_pcm_format_signed(snd_pcm_format_t format);
1126int snd_pcm_format_unsigned(snd_pcm_format_t format);
1127int snd_pcm_format_linear(snd_pcm_format_t format);
1128int snd_pcm_format_little_endian(snd_pcm_format_t format);
1129int snd_pcm_format_big_endian(snd_pcm_format_t format);
1130#if 0 /* just for kernel-doc */
1131/**
1132 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
1133 * @format: the format to check
1134 *
1135 * Return: 1 if the given PCM format is CPU-endian, 0 if
1136 * opposite, or a negative error code if endian not specified.
1137 */
1138int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1139#endif /* DocBook */
1140#ifdef SNDRV_LITTLE_ENDIAN
1141#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
1142#else
1143#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
1144#endif
1145int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
1146int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
1147ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1148const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
1149int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
1150
1151void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
1152 const struct snd_pcm_ops *ops);
1153void snd_pcm_set_sync(struct snd_pcm_substream *substream);
1154int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1155 unsigned int cmd, void *arg);
1156void snd_pcm_period_elapsed_under_stream_lock(struct snd_pcm_substream *substream);
1157void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
1158snd_pcm_sframes_t __snd_pcm_lib_xfer(struct snd_pcm_substream *substream,
1159 void *buf, bool interleaved,
1160 snd_pcm_uframes_t frames, bool in_kernel);
1161
1162static inline snd_pcm_sframes_t
1163snd_pcm_lib_write(struct snd_pcm_substream *substream,
1164 const void __user *buf, snd_pcm_uframes_t frames)
1165{
1166 return __snd_pcm_lib_xfer(substream, (void __force *)buf, true, frames, false);
1167}
1168
1169static inline snd_pcm_sframes_t
1170snd_pcm_lib_read(struct snd_pcm_substream *substream,
1171 void __user *buf, snd_pcm_uframes_t frames)
1172{
1173 return __snd_pcm_lib_xfer(substream, (void __force *)buf, true, frames, false);
1174}
1175
1176static inline snd_pcm_sframes_t
1177snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1178 void __user **bufs, snd_pcm_uframes_t frames)
1179{
1180 return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames, false);
1181}
1182
1183static inline snd_pcm_sframes_t
1184snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1185 void __user **bufs, snd_pcm_uframes_t frames)
1186{
1187 return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames, false);
1188}
1189
1190static inline snd_pcm_sframes_t
1191snd_pcm_kernel_write(struct snd_pcm_substream *substream,
1192 const void *buf, snd_pcm_uframes_t frames)
1193{
1194 return __snd_pcm_lib_xfer(substream, (void *)buf, true, frames, true);
1195}
1196
1197static inline snd_pcm_sframes_t
1198snd_pcm_kernel_read(struct snd_pcm_substream *substream,
1199 void *buf, snd_pcm_uframes_t frames)
1200{
1201 return __snd_pcm_lib_xfer(substream, buf, true, frames, true);
1202}
1203
1204static inline snd_pcm_sframes_t
1205snd_pcm_kernel_writev(struct snd_pcm_substream *substream,
1206 void **bufs, snd_pcm_uframes_t frames)
1207{
1208 return __snd_pcm_lib_xfer(substream, bufs, false, frames, true);
1209}
1210
1211static inline snd_pcm_sframes_t
1212snd_pcm_kernel_readv(struct snd_pcm_substream *substream,
1213 void **bufs, snd_pcm_uframes_t frames)
1214{
1215 return __snd_pcm_lib_xfer(substream, bufs, false, frames, true);
1216}
1217
1218int snd_pcm_hw_limit_rates(struct snd_pcm_hardware *hw);
1219
1220static inline int
1221snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime)
1222{
1223 return snd_pcm_hw_limit_rates(&runtime->hw);
1224}
1225
1226unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
1227unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
1228unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
1229 unsigned int rates_b);
1230unsigned int snd_pcm_rate_range_to_bits(unsigned int rate_min,
1231 unsigned int rate_max);
1232
1233/**
1234 * snd_pcm_set_runtime_buffer - Set the PCM runtime buffer
1235 * @substream: PCM substream to set
1236 * @bufp: the buffer information, NULL to clear
1237 *
1238 * Copy the buffer information to runtime->dma_buffer when @bufp is non-NULL.
1239 * Otherwise it clears the current buffer information.
1240 */
1241static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1242 struct snd_dma_buffer *bufp)
1243{
1244 struct snd_pcm_runtime *runtime = substream->runtime;
1245 if (bufp) {
1246 runtime->dma_buffer_p = bufp;
1247 runtime->dma_area = bufp->area;
1248 runtime->dma_addr = bufp->addr;
1249 runtime->dma_bytes = bufp->bytes;
1250 } else {
1251 runtime->dma_buffer_p = NULL;
1252 runtime->dma_area = NULL;
1253 runtime->dma_addr = 0;
1254 runtime->dma_bytes = 0;
1255 }
1256}
1257
1258/**
1259 * snd_pcm_gettime - Fill the timespec64 depending on the timestamp mode
1260 * @runtime: PCM runtime instance
1261 * @tv: timespec64 to fill
1262 */
1263static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
1264 struct timespec64 *tv)
1265{
1266 switch (runtime->tstamp_type) {
1267 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC:
1268 ktime_get_ts64(tv);
1269 break;
1270 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW:
1271 ktime_get_raw_ts64(tv);
1272 break;
1273 default:
1274 ktime_get_real_ts64(tv);
1275 break;
1276 }
1277}
1278
1279/*
1280 * Memory
1281 */
1282
1283void snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
1284void snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
1285void snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1286 int type, struct device *data,
1287 size_t size, size_t max);
1288void snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1289 int type, void *data,
1290 size_t size, size_t max);
1291int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
1292int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1293
1294int snd_pcm_set_managed_buffer(struct snd_pcm_substream *substream, int type,
1295 struct device *data, size_t size, size_t max);
1296int snd_pcm_set_managed_buffer_all(struct snd_pcm *pcm, int type,
1297 struct device *data,
1298 size_t size, size_t max);
1299
1300/**
1301 * snd_pcm_set_fixed_buffer - Preallocate and set up the fixed size PCM buffer
1302 * @substream: the pcm substream instance
1303 * @type: DMA type (SNDRV_DMA_TYPE_*)
1304 * @data: DMA type dependent data
1305 * @size: the requested pre-allocation size in bytes
1306 *
1307 * This is a variant of snd_pcm_set_managed_buffer(), but this pre-allocates
1308 * only the given sized buffer and doesn't allow re-allocation nor dynamic
1309 * allocation of a larger buffer unlike the standard one.
1310 * The function may return -ENOMEM error, hence the caller must check it.
1311 *
1312 * Return: zero if successful, or a negative error code
1313 */
1314static inline int __must_check
1315snd_pcm_set_fixed_buffer(struct snd_pcm_substream *substream, int type,
1316 struct device *data, size_t size)
1317{
1318 return snd_pcm_set_managed_buffer(substream, type, data, size, 0);
1319}
1320
1321/**
1322 * snd_pcm_set_fixed_buffer_all - Preallocate and set up the fixed size PCM buffer
1323 * @pcm: the pcm instance
1324 * @type: DMA type (SNDRV_DMA_TYPE_*)
1325 * @data: DMA type dependent data
1326 * @size: the requested pre-allocation size in bytes
1327 *
1328 * Apply the set up of the fixed buffer via snd_pcm_set_fixed_buffer() for
1329 * all substream. If any of allocation fails, it returns -ENOMEM, hence the
1330 * caller must check the return value.
1331 *
1332 * Return: zero if successful, or a negative error code
1333 */
1334static inline int __must_check
1335snd_pcm_set_fixed_buffer_all(struct snd_pcm *pcm, int type,
1336 struct device *data, size_t size)
1337{
1338 return snd_pcm_set_managed_buffer_all(pcm, type, data, size, 0);
1339}
1340
1341int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
1342 size_t size, gfp_t gfp_flags);
1343int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
1344struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
1345 unsigned long offset);
1346/**
1347 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
1348 * @substream: the substream to allocate the buffer to
1349 * @size: the requested buffer size, in bytes
1350 *
1351 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
1352 * contiguous in kernel virtual space, but not in physical memory. Use this
1353 * if the buffer is accessed by kernel code but not by device DMA.
1354 *
1355 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1356 * code.
1357 */
1358static inline int snd_pcm_lib_alloc_vmalloc_buffer
1359 (struct snd_pcm_substream *substream, size_t size)
1360{
1361 return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1362 GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO);
1363}
1364
1365/**
1366 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
1367 * @substream: the substream to allocate the buffer to
1368 * @size: the requested buffer size, in bytes
1369 *
1370 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
1371 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
1372 *
1373 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1374 * code.
1375 */
1376static inline int snd_pcm_lib_alloc_vmalloc_32_buffer
1377 (struct snd_pcm_substream *substream, size_t size)
1378{
1379 return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1380 GFP_KERNEL | GFP_DMA32 | __GFP_ZERO);
1381}
1382
1383#define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
1384
1385/**
1386 * snd_pcm_sgbuf_get_addr - Get the DMA address at the corresponding offset
1387 * @substream: PCM substream
1388 * @ofs: byte offset
1389 *
1390 * Return: DMA address
1391 */
1392static inline dma_addr_t
1393snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1394{
1395 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
1396}
1397
1398/**
1399 * snd_pcm_sgbuf_get_chunk_size - Compute the max size that fits within the
1400 * contig. page from the given size
1401 * @substream: PCM substream
1402 * @ofs: byte offset
1403 * @size: byte size to examine
1404 *
1405 * Return: chunk size
1406 */
1407static inline unsigned int
1408snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1409 unsigned int ofs, unsigned int size)
1410{
1411 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1412}
1413
1414/**
1415 * snd_pcm_mmap_data_open - increase the mmap counter
1416 * @area: VMA
1417 *
1418 * PCM mmap callback should handle this counter properly
1419 */
1420static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1421{
1422 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1423 atomic_inc(&substream->mmap_count);
1424}
1425
1426/**
1427 * snd_pcm_mmap_data_close - decrease the mmap counter
1428 * @area: VMA
1429 *
1430 * PCM mmap callback should handle this counter properly
1431 */
1432static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1433{
1434 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1435 atomic_dec(&substream->mmap_count);
1436}
1437
1438int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1439 struct vm_area_struct *area);
1440/* mmap for io-memory area */
1441#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1442#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
1443int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1444#else
1445#define SNDRV_PCM_INFO_MMAP_IOMEM 0
1446#define snd_pcm_lib_mmap_iomem NULL
1447#endif
1448
1449/**
1450 * snd_pcm_limit_isa_dma_size - Get the max size fitting with ISA DMA transfer
1451 * @dma: DMA number
1452 * @max: pointer to store the max size
1453 */
1454static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1455{
1456 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1457}
1458
1459/*
1460 * Misc
1461 */
1462
1463#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1464 (IEC958_AES1_CON_ORIGINAL<<8)|\
1465 (IEC958_AES1_CON_PCM_CODER<<8)|\
1466 (IEC958_AES3_CON_FS_48000<<24))
1467
1468const char *snd_pcm_format_name(snd_pcm_format_t format);
1469
1470/**
1471 * snd_pcm_direction_name - Get a string naming the direction of a stream
1472 * @direction: Stream's direction, one of SNDRV_PCM_STREAM_XXX
1473 *
1474 * Returns a string naming the direction of the stream.
1475 */
1476static inline const char *snd_pcm_direction_name(int direction)
1477{
1478 if (direction == SNDRV_PCM_STREAM_PLAYBACK)
1479 return "Playback";
1480 else
1481 return "Capture";
1482}
1483
1484/**
1485 * snd_pcm_stream_str - Get a string naming the direction of a stream
1486 * @substream: the pcm substream instance
1487 *
1488 * Return: A string naming the direction of the stream.
1489 */
1490static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1491{
1492 return snd_pcm_direction_name(substream->stream);
1493}
1494
1495/*
1496 * PCM channel-mapping control API
1497 */
1498/* array element of channel maps */
1499struct snd_pcm_chmap_elem {
1500 unsigned char channels;
1501 unsigned char map[15];
1502};
1503
1504/* channel map information; retrieved via snd_kcontrol_chip() */
1505struct snd_pcm_chmap {
1506 struct snd_pcm *pcm; /* assigned PCM instance */
1507 int stream; /* PLAYBACK or CAPTURE */
1508 struct snd_kcontrol *kctl;
1509 const struct snd_pcm_chmap_elem *chmap;
1510 unsigned int max_channels;
1511 unsigned int channel_mask; /* optional: active channels bitmask */
1512 void *private_data; /* optional: private data pointer */
1513};
1514
1515/**
1516 * snd_pcm_chmap_substream - get the PCM substream assigned to the given chmap info
1517 * @info: chmap information
1518 * @idx: the substream number index
1519 *
1520 * Return: the matched PCM substream, or NULL if not found
1521 */
1522static inline struct snd_pcm_substream *
1523snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1524{
1525 struct snd_pcm_substream *s;
1526 for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1527 if (s->number == idx)
1528 return s;
1529 return NULL;
1530}
1531
1532/* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1533extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1534/* Other world's standard channel maps (C/LFE prior to RL/RR) */
1535extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1536
1537/* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1538#define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1539#define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1540#define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1541
1542int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1543 const struct snd_pcm_chmap_elem *chmap,
1544 int max_channels,
1545 unsigned long private_value,
1546 struct snd_pcm_chmap **info_ret);
1547
1548/**
1549 * pcm_format_to_bits - Strong-typed conversion of pcm_format to bitwise
1550 * @pcm_format: PCM format
1551 *
1552 * Return: 64bit mask corresponding to the given PCM format
1553 */
1554static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1555{
1556 return 1ULL << (__force int) pcm_format;
1557}
1558
1559/**
1560 * pcm_for_each_format - helper to iterate for each format type
1561 * @f: the iterator variable in snd_pcm_format_t type
1562 */
1563#define pcm_for_each_format(f) \
1564 for ((f) = SNDRV_PCM_FORMAT_FIRST; \
1565 (__force int)(f) <= (__force int)SNDRV_PCM_FORMAT_LAST; \
1566 (f) = (__force snd_pcm_format_t)((__force int)(f) + 1))
1567
1568/* printk helpers */
1569#define pcm_err(pcm, fmt, args...) \
1570 dev_err((pcm)->card->dev, fmt, ##args)
1571#define pcm_warn(pcm, fmt, args...) \
1572 dev_warn((pcm)->card->dev, fmt, ##args)
1573#define pcm_dbg(pcm, fmt, args...) \
1574 dev_dbg((pcm)->card->dev, fmt, ##args)
1575
1576/* helpers for copying between iov_iter and iomem */
1577int copy_to_iter_fromio(struct iov_iter *itert, const void __iomem *src,
1578 size_t count);
1579int copy_from_iter_toio(void __iomem *dst, struct iov_iter *iter, size_t count);
1580
1581struct snd_pcm_status64 {
1582 snd_pcm_state_t state; /* stream state */
1583 u8 rsvd[4];
1584 s64 trigger_tstamp_sec; /* time when stream was started/stopped/paused */
1585 s64 trigger_tstamp_nsec;
1586 s64 tstamp_sec; /* reference timestamp */
1587 s64 tstamp_nsec;
1588 snd_pcm_uframes_t appl_ptr; /* appl ptr */
1589 snd_pcm_uframes_t hw_ptr; /* hw ptr */
1590 snd_pcm_sframes_t delay; /* current delay in frames */
1591 snd_pcm_uframes_t avail; /* number of frames available */
1592 snd_pcm_uframes_t avail_max; /* max frames available on hw since last status */
1593 snd_pcm_uframes_t overrange; /* count of ADC (capture) overrange detections from last status */
1594 snd_pcm_state_t suspended_state; /* suspended stream state */
1595 __u32 audio_tstamp_data; /* needed for 64-bit alignment, used for configs/report to/from userspace */
1596 s64 audio_tstamp_sec; /* sample counter, wall clock, PHC or on-demand sync'ed */
1597 s64 audio_tstamp_nsec;
1598 s64 driver_tstamp_sec; /* useful in case reference system tstamp is reported with delay */
1599 s64 driver_tstamp_nsec;
1600 __u32 audio_tstamp_accuracy; /* in ns units, only valid if indicated in audio_tstamp_data */
1601 unsigned char reserved[52-4*sizeof(s64)]; /* must be filled with zero */
1602};
1603
1604#define SNDRV_PCM_IOCTL_STATUS64 _IOR('A', 0x20, struct snd_pcm_status64)
1605#define SNDRV_PCM_IOCTL_STATUS_EXT64 _IOWR('A', 0x24, struct snd_pcm_status64)
1606
1607struct snd_pcm_status32 {
1608 snd_pcm_state_t state; /* stream state */
1609 s32 trigger_tstamp_sec; /* time when stream was started/stopped/paused */
1610 s32 trigger_tstamp_nsec;
1611 s32 tstamp_sec; /* reference timestamp */
1612 s32 tstamp_nsec;
1613 u32 appl_ptr; /* appl ptr */
1614 u32 hw_ptr; /* hw ptr */
1615 s32 delay; /* current delay in frames */
1616 u32 avail; /* number of frames available */
1617 u32 avail_max; /* max frames available on hw since last status */
1618 u32 overrange; /* count of ADC (capture) overrange detections from last status */
1619 snd_pcm_state_t suspended_state; /* suspended stream state */
1620 u32 audio_tstamp_data; /* needed for 64-bit alignment, used for configs/report to/from userspace */
1621 s32 audio_tstamp_sec; /* sample counter, wall clock, PHC or on-demand sync'ed */
1622 s32 audio_tstamp_nsec;
1623 s32 driver_tstamp_sec; /* useful in case reference system tstamp is reported with delay */
1624 s32 driver_tstamp_nsec;
1625 u32 audio_tstamp_accuracy; /* in ns units, only valid if indicated in audio_tstamp_data */
1626 unsigned char reserved[52-4*sizeof(s32)]; /* must be filled with zero */
1627};
1628
1629#define SNDRV_PCM_IOCTL_STATUS32 _IOR('A', 0x20, struct snd_pcm_status32)
1630#define SNDRV_PCM_IOCTL_STATUS_EXT32 _IOWR('A', 0x24, struct snd_pcm_status32)
1631
1632#endif /* __SOUND_PCM_H */