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