]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - include/sound/pcm.h
projects / mirror_ubuntu-focal-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ALSA: hda - remove unused variable in azx_position_ok()
[mirror_ubuntu-focal-kernel.git] / include / sound / pcm.h
CommitLineData
1da177e4
LT		 1#ifndef __SOUND_PCM_H
2#define __SOUND_PCM_H
3
4/*
5 * Digital Audio (PCM) abstract layer
c1017a4c 6 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
1da177e4
LT		 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>
f90c06a2 28#include <sound/minors.h>
1da177e4 29#include <linux/poll.h>
f23f6e08 30#include <linux/mm.h>
1da177e4 31#include <linux/bitops.h>
e8db0be1 32#include <linux/pm_qos.h>
1da177e4 33
1da177e4
LT		 34#define snd_pcm_substream_chip(substream) ((substream)->private_data)
35#define snd_pcm_chip(pcm) ((pcm)->private_data)
36
1da177e4 37#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
a1ce3928 38#include <sound/pcm_oss.h>
1da177e4
LT		 39#endif
40
41/*
42 * Hardware (lowlevel) section
43 */
44
877211f5 45struct snd_pcm_hardware {
1da177e4
LT		 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 */
877211f5 59};
1da177e4 60
e0e6ce03
RD		 61struct snd_pcm_substream;
62
877211f5
TI		 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,
1da177e4 67 unsigned int cmd, void *arg);
877211f5
TI		 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,
1da177e4 76 void __user *buf, snd_pcm_uframes_t count);
877211f5 77 int (*silence)(struct snd_pcm_substream *substream, int channel,
1da177e4 78 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
877211f5
TI		 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};
1da177e4
LT		 84
85/*
86 *
87 */
88
f90c06a2
PM		 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
896e6cc2 94
1da177e4
LT		 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
8bea869c 102#define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
1da177e4
LT		 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)
fea952e5
CL		 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)
1da177e4
LT		 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
877211f5
TI		 206struct snd_pcm_file {
207 struct snd_pcm_substream *substream;
548a648b 208 int no_compat_mmap;
1da177e4
LT		 209};
210
877211f5
TI		 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);
1da177e4 214
877211f5 215struct snd_pcm_hw_rule {
1da177e4
LT		 216 unsigned int cond;
217 snd_pcm_hw_rule_func_t func;
218 int var;
219 int deps[4];
220 void *private;
221};
222
877211f5
TI		 223struct snd_pcm_hw_constraints {
224 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
1da177e4 225 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
877211f5 226 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
1da177e4
LT		 227 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
228 unsigned int rules_num;
229 unsigned int rules_all;
877211f5
TI		 230 struct snd_pcm_hw_rule *rules;
231};
1da177e4 232
877211f5
TI		 233static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
234 snd_pcm_hw_param_t var)
1da177e4
LT		 235{
236 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
237}
238
877211f5
TI		 239static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
240 snd_pcm_hw_param_t var)
1da177e4
LT		 241{
242 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
243}
244
877211f5 245struct snd_ratnum {
1da177e4
LT		 246 unsigned int num;
247 unsigned int den_min, den_max, den_step;
877211f5 248};
1da177e4 249
877211f5 250struct snd_ratden {
1da177e4
LT		 251 unsigned int num_min, num_max, num_step;
252 unsigned int den;
877211f5 253};
1da177e4 254
877211f5 255struct snd_pcm_hw_constraint_ratnums {
1da177e4 256 int nrats;
877211f5
TI		 257 struct snd_ratnum *rats;
258};
1da177e4 259
877211f5 260struct snd_pcm_hw_constraint_ratdens {
1da177e4 261 int nrats;
877211f5
TI		 262 struct snd_ratden *rats;
263};
1da177e4 264
877211f5 265struct snd_pcm_hw_constraint_list {
1da177e4 266 unsigned int count;
4af87a93 267 const unsigned int *list;
1da177e4 268 unsigned int mask;
877211f5 269};
1da177e4 270
4d96eb25
JK		 271struct snd_pcm_hwptr_log;
272
877211f5 273struct snd_pcm_runtime {
1da177e4 274 /* -- Status -- */
877211f5 275 struct snd_pcm_substream *trigger_master;
07799e75 276 struct timespec trigger_tstamp; /* trigger timestamp */
1da177e4
LT		 277 int overrange;
278 snd_pcm_uframes_t avail_max;
279 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
e7636925 280 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
bbf6ad13 281 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
bd76af0f 282 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
4bbe1ddf 283 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
1da177e4
LT		 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 */
1da177e4
LT		 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;
ab69a490 301 unsigned int no_period_wakeup: 1;
1da177e4
LT		 302
303 /* -- SW params -- */
877211f5 304 int tstamp_mode; /* mmap timestamp is updated */
1da177e4 305 unsigned int period_step;
1da177e4
LT		 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
877211f5 316 union snd_pcm_sync_id sync; /* hardware synchronization ID */
1da177e4
LT		 317
318 /* -- mmap -- */
503fc85a
TI		 319 struct snd_pcm_mmap_status *status;
320 struct snd_pcm_mmap_control *control;
1da177e4
LT		 321
322 /* -- locking / scheduling -- */
5daeba34 323 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
c91a988d
JK		 324 wait_queue_head_t sleep; /* poll sleep */
325 wait_queue_head_t tsleep; /* transfer sleep */
1da177e4
LT		 326 struct fasync_struct *fasync;
327
328 /* -- private section -- */
329 void *private_data;
877211f5 330 void (*private_free)(struct snd_pcm_runtime *runtime);
1da177e4
LT		 331
332 /* -- hardware description -- */
877211f5
TI		 333 struct snd_pcm_hardware hw;
334 struct snd_pcm_hw_constraints hw_constraints;
1da177e4
LT		 335
336 /* -- interrupt callbacks -- */
877211f5
TI		 337 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
338 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
1da177e4
LT		 339
340 /* -- timer -- */
341 unsigned int timer_resolution; /* timer resolution */
b751eef1 342 int tstamp_type; /* timestamp type */
1da177e4
LT		 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 -- */
877211f5 353 struct snd_pcm_oss_runtime oss;
1da177e4 354#endif
4d96eb25
JK		 355
356#ifdef CONFIG_SND_PCM_XRUN_DEBUG
357 struct snd_pcm_hwptr_log *hwptr_log;
358#endif
1da177e4
LT		 359};
360
877211f5 361struct snd_pcm_group { /* keep linked substreams */
1da177e4
LT		 362 spinlock_t lock;
363 struct list_head substreams;
364 int count;
877211f5 365};
1da177e4 366
e7373b70
CL		 367struct pid;
368
877211f5
TI		 369struct snd_pcm_substream {
370 struct snd_pcm *pcm;
371 struct snd_pcm_str *pstr;
1da177e4
LT		 372 void *private_data; /* copied from pcm->private_data */
373 int number;
374 char name[32]; /* substream name */
375 int stream; /* stream (direction) */
cc749986 376 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
1da177e4
LT		 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 -- */
877211f5 382 struct snd_pcm_ops *ops;
1da177e4 383 /* -- runtime information -- */
877211f5 384 struct snd_pcm_runtime *runtime;
1da177e4 385 /* -- timer section -- */
877211f5 386 struct snd_timer *timer; /* timer */
1da177e4 387 unsigned timer_running: 1; /* time is running */
1da177e4 388 /* -- next substream -- */
877211f5 389 struct snd_pcm_substream *next;
1da177e4
LT		 390 /* -- linked substreams -- */
391 struct list_head link_list; /* linked list member */
877211f5
TI		 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 */
1da177e4 394 /* -- assigned files -- */
1576274d 395 void *file;
0df63e44 396 int ref_count;
9c323fcb 397 atomic_t mmap_count;
0df63e44 398 unsigned int f_flags;
3bf75f9b 399 void (*pcm_release)(struct snd_pcm_substream *);
e7373b70 400 struct pid *pid;
1da177e4
LT		 401#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
402 /* -- OSS things -- */
877211f5 403 struct snd_pcm_oss_substream oss;
1da177e4 404#endif
b7d90a35 405#ifdef CONFIG_SND_VERBOSE_PROCFS
877211f5
TI		 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;
c7132aeb 412 struct snd_info_entry *proc_prealloc_max_entry;
b7d90a35 413#endif
1da177e4 414 /* misc flags */
3bf75f9b 415 unsigned int hw_opened: 1;
1da177e4
LT		 416};
417
0df63e44 418#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
1da177e4
LT		 419
420
877211f5 421struct snd_pcm_str {
1da177e4 422 int stream; /* stream (direction) */
877211f5 423 struct snd_pcm *pcm;
1da177e4
LT		 424 /* -- substreams -- */
425 unsigned int substream_count;
426 unsigned int substream_opened;
877211f5 427 struct snd_pcm_substream *substream;
1da177e4
LT		 428#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
429 /* -- OSS things -- */
877211f5 430 struct snd_pcm_oss_stream oss;
1da177e4 431#endif
b7d90a35 432#ifdef CONFIG_SND_VERBOSE_PROCFS
877211f5
TI		 433 struct snd_info_entry *proc_root;
434 struct snd_info_entry *proc_info_entry;
b7d90a35 435#ifdef CONFIG_SND_PCM_XRUN_DEBUG
1da177e4 436 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
877211f5 437 struct snd_info_entry *proc_xrun_debug_entry;
1da177e4 438#endif
b7d90a35 439#endif
2d3391ec 440 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
1da177e4
LT		 441};
442
877211f5
TI		 443struct snd_pcm {
444 struct snd_card *card;
f87135f5 445 struct list_head list;
f90c06a2 446 int device; /* device number */
1da177e4
LT		 447 unsigned int info_flags;
448 unsigned short dev_class;
449 unsigned short dev_subclass;
450 char id[64];
451 char name[80];
877211f5 452 struct snd_pcm_str streams[2];
1a60d4c5 453 struct mutex open_mutex;
1da177e4
LT		 454 wait_queue_head_t open_wait;
455 void *private_data;
877211f5 456 void (*private_free) (struct snd_pcm *pcm);
c78085fc 457 struct device *dev; /* actual hw device this belongs to */
945e5038 458 bool internal; /* pcm is for internal use only */
1da177e4 459#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
877211f5 460 struct snd_pcm_oss oss;
1da177e4
LT		 461#endif
462};
463
877211f5
TI		 464struct snd_pcm_notify {
465 int (*n_register) (struct snd_pcm * pcm);
466 int (*n_disconnect) (struct snd_pcm * pcm);
467 int (*n_unregister) (struct snd_pcm * pcm);
1da177e4 468 struct list_head list;
877211f5 469};
1da177e4
LT		 470
471/*
472 * Registering
473 */
474
54047320 475extern const struct file_operations snd_pcm_f_ops[2];
1da177e4 476
e6161653 477int snd_pcm_new(struct snd_card *card, const char *id, int device,
1da177e4 478 int playback_count, int capture_count,
877211f5 479 struct snd_pcm **rpcm);
945e5038
LG		 480int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
481 int playback_count, int capture_count,
482 struct snd_pcm **rpcm);
877211f5 483int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
1da177e4 484
877211f5 485int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
1da177e4
LT		 486
487/*
488 * Native I/O
489 */
490
491extern rwlock_t snd_pcm_link_rwlock;
492
877211f5
TI		 493int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
494int snd_pcm_info_user(struct snd_pcm_substream *substream,
495 struct snd_pcm_info __user *info);
496int snd_pcm_status(struct snd_pcm_substream *substream,
497 struct snd_pcm_status *status);
877211f5 498int snd_pcm_start(struct snd_pcm_substream *substream);
fea952e5 499int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
877211f5 500int snd_pcm_drain_done(struct snd_pcm_substream *substream);
1da177e4 501#ifdef CONFIG_PM
877211f5
TI		 502int snd_pcm_suspend(struct snd_pcm_substream *substream);
503int snd_pcm_suspend_all(struct snd_pcm *pcm);
1da177e4 504#endif
877211f5 505int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
3bf75f9b
TI		 506int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
507 struct snd_pcm_substream **rsubstream);
877211f5 508void snd_pcm_release_substream(struct snd_pcm_substream *substream);
3bf75f9b
TI		 509int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
510 struct snd_pcm_substream **rsubstream);
511void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
1da177e4 512void snd_pcm_vma_notify_data(void *client, void *data);
877211f5 513int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
1da177e4 514
acb03d44
EB		 515
516#ifdef CONFIG_SND_DEBUG
517void snd_pcm_debug_name(struct snd_pcm_substream *substream,
518 char *name, size_t len);
519#else
520static inline void
521snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
522{
523 *buf = 0;
524}
525#endif
526
1da177e4
LT		 527/*
528 * PCM library
529 */
530
877211f5 531static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
1da177e4
LT		 532{
533 return substream->group != &substream->self_group;
534}
535
877211f5 536static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
1da177e4
LT		 537{
538 read_lock(&snd_pcm_link_rwlock);
539 spin_lock(&substream->self_group.lock);
540}
541
877211f5 542static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
1da177e4
LT		 543{
544 spin_unlock(&substream->self_group.lock);
545 read_unlock(&snd_pcm_link_rwlock);
546}
547
877211f5 548static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
1da177e4
LT		 549{
550 read_lock_irq(&snd_pcm_link_rwlock);
551 spin_lock(&substream->self_group.lock);
552}
553
877211f5 554static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
1da177e4
LT		 555{
556 spin_unlock(&substream->self_group.lock);
557 read_unlock_irq(&snd_pcm_link_rwlock);
558}
559
560#define snd_pcm_stream_lock_irqsave(substream, flags) \
561do { \
562 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
563 spin_lock(&substream->self_group.lock); \
564} while (0)
565
566#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
567do { \
568 spin_unlock(&substream->self_group.lock); \
569 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
570} while (0)
571
ef991b95
TI		 572#define snd_pcm_group_for_each_entry(s, substream) \
573 list_for_each_entry(s, &substream->group->substreams, link_list)
1da177e4 574
877211f5 575static inline int snd_pcm_running(struct snd_pcm_substream *substream)
1da177e4
LT		 576{
577 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
578 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
579 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
580}
581
877211f5 582static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT		 583{
584 return size * 8 / runtime->sample_bits;
585}
586
877211f5 587static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT		 588{
589 return size * 8 / runtime->frame_bits;
590}
591
877211f5 592static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT		 593{
594 return size * runtime->sample_bits / 8;
595}
596
877211f5 597static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
1da177e4
LT		 598{
599 return size * runtime->frame_bits / 8;
600}
601
877211f5 602static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
1da177e4
LT		 603{
604 return bytes % runtime->byte_align == 0;
605}
606
877211f5 607static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
1da177e4 608{
877211f5 609 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 610 return frames_to_bytes(runtime, runtime->buffer_size);
611}
612
877211f5 613static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
1da177e4 614{
877211f5 615 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 616 return frames_to_bytes(runtime, runtime->period_size);
617}
618
619/*
620 * result is: 0 ... (boundary - 1)
621 */
877211f5 622static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 623{
624 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
625 if (avail < 0)
626 avail += runtime->boundary;
627 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
628 avail -= runtime->boundary;
629 return avail;
630}
631
632/*
633 * result is: 0 ... (boundary - 1)
634 */
877211f5 635static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 636{
637 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
638 if (avail < 0)
639 avail += runtime->boundary;
640 return avail;
641}
642
877211f5 643static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 644{
645 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
646}
647
877211f5 648static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 649{
650 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
651}
652
653/**
654 * snd_pcm_playback_ready - check whether the playback buffer is available
655 * @substream: the pcm substream instance
656 *
657 * Checks whether enough free space is available on the playback buffer.
658 *
659 * Returns non-zero if available, or zero if not.
660 */
877211f5 661static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
1da177e4 662{
877211f5 663 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 664 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
665}
666
667/**
668 * snd_pcm_capture_ready - check whether the capture buffer is available
669 * @substream: the pcm substream instance
670 *
671 * Checks whether enough capture data is available on the capture buffer.
672 *
673 * Returns non-zero if available, or zero if not.
674 */
877211f5 675static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
1da177e4 676{
877211f5 677 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 678 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
679}
680
681/**
682 * snd_pcm_playback_data - check whether any data exists on the playback buffer
683 * @substream: the pcm substream instance
684 *
685 * Checks whether any data exists on the playback buffer. If stop_threshold
686 * is bigger or equal to boundary, then this function returns always non-zero.
687 *
688 * Returns non-zero if exists, or zero if not.
689 */
877211f5 690static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
1da177e4 691{
877211f5 692 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 693
694 if (runtime->stop_threshold >= runtime->boundary)
695 return 1;
696 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
697}
698
699/**
700 * snd_pcm_playback_empty - check whether the playback buffer is empty
701 * @substream: the pcm substream instance
702 *
703 * Checks whether the playback buffer is empty.
704 *
705 * Returns non-zero if empty, or zero if not.
706 */
877211f5 707static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
1da177e4 708{
877211f5 709 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 710 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
711}
712
713/**
714 * snd_pcm_capture_empty - check whether the capture buffer is empty
715 * @substream: the pcm substream instance
716 *
717 * Checks whether the capture buffer is empty.
718 *
719 * Returns non-zero if empty, or zero if not.
720 */
877211f5 721static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
1da177e4 722{
877211f5 723 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 724 return snd_pcm_capture_avail(runtime) == 0;
725}
726
877211f5
TI		 727static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
728 struct snd_pcm_substream *master)
1da177e4
LT		 729{
730 substream->runtime->trigger_master = master;
731}
732
733static inline int hw_is_mask(int var)
734{
735 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
736 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
737}
738
739static inline int hw_is_interval(int var)
740{
741 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
742 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
743}
744
877211f5 745static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
1da177e4
LT		 746 snd_pcm_hw_param_t var)
747{
748 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
749}
750
877211f5 751static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
1da177e4
LT		 752 snd_pcm_hw_param_t var)
753{
754 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
755}
756
877211f5 757static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
1da177e4
LT		 758 snd_pcm_hw_param_t var)
759{
b9f09a48 760 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
1da177e4
LT		 761}
762
877211f5 763static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
1da177e4
LT		 764 snd_pcm_hw_param_t var)
765{
b9f09a48 766 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
1da177e4
LT		 767}
768
b51beb75
TI		 769#define params_channels(p) \
770 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min)
771#define params_rate(p) \
772 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min)
773#define params_period_size(p) \
774 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min)
775#define params_periods(p) \
776 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min)
777#define params_buffer_size(p) \
778 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min)
779#define params_buffer_bytes(p) \
780 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min)
1da177e4 781
877211f5
TI		 782int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
783void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
784void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
785void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
786 unsigned int k, struct snd_interval *c);
787void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
788 const struct snd_interval *b, struct snd_interval *c);
4af87a93
MB		 789int snd_interval_list(struct snd_interval *i, unsigned int count,
790 const unsigned int *list, unsigned int mask);
877211f5
TI		 791int snd_interval_ratnum(struct snd_interval *i,
792 unsigned int rats_count, struct snd_ratnum *rats,
1da177e4
LT		 793 unsigned int *nump, unsigned int *denp);
794
877211f5
TI		 795void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
796void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
877211f5 797int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1da177e4 798
877211f5 799int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1da177e4 800
877211f5
TI		 801int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
802int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
1da177e4 803
877211f5 804int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 805 u_int32_t mask);
877211f5 806int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 807 u_int64_t mask);
877211f5 808int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 809 unsigned int min, unsigned int max);
877211f5
TI		 810int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
811int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
1da177e4
LT		 812 unsigned int cond,
813 snd_pcm_hw_param_t var,
1464189f 814 const struct snd_pcm_hw_constraint_list *l);
877211f5 815int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
1da177e4
LT		 816 unsigned int cond,
817 snd_pcm_hw_param_t var,
877211f5
TI		 818 struct snd_pcm_hw_constraint_ratnums *r);
819int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
1da177e4
LT		 820 unsigned int cond,
821 snd_pcm_hw_param_t var,
877211f5
TI		 822 struct snd_pcm_hw_constraint_ratdens *r);
823int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1da177e4
LT		 824 unsigned int cond,
825 unsigned int width,
826 unsigned int msbits);
877211f5 827int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1da177e4
LT		 828 unsigned int cond,
829 snd_pcm_hw_param_t var,
830 unsigned long step);
877211f5 831int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1da177e4
LT		 832 unsigned int cond,
833 snd_pcm_hw_param_t var);
d5b702a6
CL		 834int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
835 unsigned int base_rate);
877211f5 836int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
1da177e4
LT		 837 unsigned int cond,
838 int var,
839 snd_pcm_hw_rule_func_t func, void *private,
840 int dep, ...);
841
842int snd_pcm_format_signed(snd_pcm_format_t format);
843int snd_pcm_format_unsigned(snd_pcm_format_t format);
844int snd_pcm_format_linear(snd_pcm_format_t format);
845int snd_pcm_format_little_endian(snd_pcm_format_t format);
846int snd_pcm_format_big_endian(snd_pcm_format_t format);
1b44c28d
TI		 847#if 0 /* just for DocBook */
848/**
9502dcad
TI		 849 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
850 * @format: the format to check
851 *
852 * Returns 1 if the given PCM format is CPU-endian, 0 if
853 * opposite, or a negative error code if endian not specified.
854 */
8cdfd251 855int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1b44c28d 856#endif /* DocBook */
9502dcad 857#ifdef SNDRV_LITTLE_ENDIAN
9d01a82e 858#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
9502dcad 859#else
9d01a82e 860#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
9502dcad 861#endif
1da177e4
LT		 862int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
863int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
9502dcad 864ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1da177e4
LT		 865const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
866int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
867snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
1da177e4 868
877211f5
TI		 869void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
870void snd_pcm_set_sync(struct snd_pcm_substream *substream);
871int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
872int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1da177e4 873 unsigned int cmd, void *arg);
1250932e
JK		 874int snd_pcm_update_state(struct snd_pcm_substream *substream,
875 struct snd_pcm_runtime *runtime);
877211f5
TI		 876int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
877int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
878int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
879int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
880int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
881void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
877211f5
TI		 882void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
883snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
1da177e4
LT		 884 const void __user *buf,
885 snd_pcm_uframes_t frames);
877211f5 886snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
1da177e4 887 void __user *buf, snd_pcm_uframes_t frames);
877211f5 888snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1da177e4 889 void __user **bufs, snd_pcm_uframes_t frames);
877211f5 890snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1da177e4
LT		 891 void __user **bufs, snd_pcm_uframes_t frames);
892
7653d557
CL		 893extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
894
877211f5 895int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
918f3a0e 896unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
4be77a53 897unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
1da177e4 898
877211f5 899static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1da177e4
LT		 900 struct snd_dma_buffer *bufp)
901{
877211f5 902 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 903 if (bufp) {
904 runtime->dma_buffer_p = bufp;
905 runtime->dma_area = bufp->area;
906 runtime->dma_addr = bufp->addr;
907 runtime->dma_bytes = bufp->bytes;
908 } else {
909 runtime->dma_buffer_p = NULL;
910 runtime->dma_area = NULL;
911 runtime->dma_addr = 0;
912 runtime->dma_bytes = 0;
913 }
914}
915
916/*
917 * Timer interface
918 */
919
877211f5
TI		 920void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
921void snd_pcm_timer_init(struct snd_pcm_substream *substream);
922void snd_pcm_timer_done(struct snd_pcm_substream *substream);
1da177e4 923
b751eef1
JK		 924static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
925 struct timespec *tv)
926{
927 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
928 do_posix_clock_monotonic_gettime(tv);
929 else
930 getnstimeofday(tv);
931}
932
1da177e4
LT		 933/*
934 * Memory
935 */
936
877211f5
TI		 937int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
938int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
939int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1da177e4
LT		 940 int type, struct device *data,
941 size_t size, size_t max);
877211f5 942int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1da177e4
LT		 943 int type, void *data,
944 size_t size, size_t max);
877211f5
TI		 945int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
946int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1da177e4 947
681b84e1
CL		 948int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
949 size_t size, gfp_t gfp_flags);
950int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
951struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
952 unsigned long offset);
953#if 0 /* for kernel-doc */
954/**
955 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
956 * @substream: the substream to allocate the buffer to
957 * @size: the requested buffer size, in bytes
958 *
959 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
960 * contiguous in kernel virtual space, but not in physical memory. Use this
961 * if the buffer is accessed by kernel code but not by device DMA.
962 *
963 * Returns 1 if the buffer was changed, 0 if not changed, or a negative error
964 * code.
965 */
966static int snd_pcm_lib_alloc_vmalloc_buffer
967 (struct snd_pcm_substream *substream, size_t size);
968/**
969 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
970 * @substream: the substream to allocate the buffer to
971 * @size: the requested buffer size, in bytes
972 *
973 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
974 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
975 */
976static int snd_pcm_lib_alloc_vmalloc_32_buffer
977 (struct snd_pcm_substream *substream, size_t size);
978#endif
979#define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
980 _snd_pcm_lib_alloc_vmalloc_buffer \
981 (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
982#define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
983 _snd_pcm_lib_alloc_vmalloc_buffer \
984 (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
985
9d069dc0
TI		 986#define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
987
cc6a8acd 988#ifdef CONFIG_SND_DMA_SGBUF
77a23f26
TI		 989/*
990 * SG-buffer handling
991 */
992#define snd_pcm_substream_sgbuf(substream) \
9d069dc0 993 snd_pcm_get_dma_buf(substream)->private_data
77a23f26
TI		 994
995struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
996 unsigned long offset);
cc6a8acd
TI		 997#else /* !SND_DMA_SGBUF */
998/*
999 * fake using a continuous buffer
1000 */
9d069dc0
TI		 1001#define snd_pcm_sgbuf_ops_page NULL
1002#endif /* SND_DMA_SGBUF */
1003
cc6a8acd
TI		 1004static inline dma_addr_t
1005snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1006{
9d069dc0 1007 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
cc6a8acd
TI		 1008}
1009
1010static inline void *
1011snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1012{
9d069dc0 1013 return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
cc6a8acd
TI		 1014}
1015
9d069dc0
TI		 1016static inline unsigned int
1017snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1018 unsigned int ofs, unsigned int size)
1019{
1020 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1021}
cc6a8acd 1022
1da177e4
LT		 1023/* handle mmap counter - PCM mmap callback should handle this counter properly */
1024static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1025{
877211f5 1026 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
9c323fcb 1027 atomic_inc(&substream->mmap_count);
1da177e4
LT		 1028}
1029
1030static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1031{
877211f5 1032 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
9c323fcb 1033 atomic_dec(&substream->mmap_count);
1da177e4
LT		 1034}
1035
18a2b962
TI		 1036int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1037 struct vm_area_struct *area);
1da177e4
LT		 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
877211f5 1041int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1da177e4
LT		 1042#else
1043#define SNDRV_PCM_INFO_MMAP_IOMEM 0
1044#define snd_pcm_lib_mmap_iomem NULL
1045#endif
1046
3674f19d 1047#define snd_pcm_lib_mmap_vmalloc NULL
c32d977b 1048
1da177e4
LT		 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
7eaa943c
TI		 1063#define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1064
6e5265ec
TI		 1065const char *snd_pcm_format_name(snd_pcm_format_t format);
1066
1aad779f 1067/**
8513915a
RD		 1068 * snd_pcm_stream_str - Get a string naming the direction of a stream
1069 * @substream: the pcm substream instance
1aad779f
OL		 1070 */
1071static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1072{
1073 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1074 return "Playback";
1075 else
1076 return "Capture";
1077}
1078
2d3391ec
TI		 1079/*
1080 * PCM channel-mapping control API
1081 */
1082/* array element of channel maps */
1083struct snd_pcm_chmap_elem {
1084 unsigned char channels;
1085 unsigned char map[15];
1086};
1087
1088/* channel map information; retrieved via snd_kcontrol_chip() */
1089struct snd_pcm_chmap {
1090 struct snd_pcm *pcm; /* assigned PCM instance */
1091 int stream; /* PLAYBACK or CAPTURE */
1092 struct snd_kcontrol *kctl;
1093 const struct snd_pcm_chmap_elem *chmap;
1094 unsigned int max_channels;
1095 unsigned int channel_mask; /* optional: active channels bitmask */
1096 void *private_data; /* optional: private data pointer */
1097};
1098
1099/* get the PCM substream assigned to the given chmap info */
1100static inline struct snd_pcm_substream *
1101snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1102{
1103 struct snd_pcm_substream *s;
1104 for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1105 if (s->number == idx)
1106 return s;
1107 return NULL;
1108}
1109
1110/* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1111extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1112/* Other world's standard channel maps (C/LFE prior to RL/RR) */
1113extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1114
1115/* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1116#define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1117#define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1118#define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1119
1120int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1121 const struct snd_pcm_chmap_elem *chmap,
1122 int max_channels,
1123 unsigned long private_value,
1124 struct snd_pcm_chmap **info_ret);
1125
1da177e4 1126#endif /* __SOUND_PCM_H */
Ubuntu Focal Linux kernel mirror