projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
[ALSA] Tiny clean up of PCM codes
[linux-2.6-block.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
6 * Copyright (c) by Jaroslav Kysela <perex@suse.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 <linux/poll.h>
29#include <linux/bitops.h>
30
1da177e4
LT		 31#define snd_pcm_substream_chip(substream) ((substream)->private_data)
32#define snd_pcm_chip(pcm) ((pcm)->private_data)
33
1da177e4
LT		 34#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
35#include "pcm_oss.h"
36#endif
37
38/*
39 * Hardware (lowlevel) section
40 */
41
877211f5 42struct snd_pcm_hardware {
1da177e4
LT		 43 unsigned int info; /* SNDRV_PCM_INFO_* */
44 u64 formats; /* SNDRV_PCM_FMTBIT_* */
45 unsigned int rates; /* SNDRV_PCM_RATE_* */
46 unsigned int rate_min; /* min rate */
47 unsigned int rate_max; /* max rate */
48 unsigned int channels_min; /* min channels */
49 unsigned int channels_max; /* max channels */
50 size_t buffer_bytes_max; /* max buffer size */
51 size_t period_bytes_min; /* min period size */
52 size_t period_bytes_max; /* max period size */
53 unsigned int periods_min; /* min # of periods */
54 unsigned int periods_max; /* max # of periods */
55 size_t fifo_size; /* fifo size in bytes */
877211f5 56};
1da177e4 57
877211f5
TI		 58struct snd_pcm_ops {
59 int (*open)(struct snd_pcm_substream *substream);
60 int (*close)(struct snd_pcm_substream *substream);
61 int (*ioctl)(struct snd_pcm_substream * substream,
1da177e4 62 unsigned int cmd, void *arg);
877211f5
TI		 63 int (*hw_params)(struct snd_pcm_substream *substream,
64 struct snd_pcm_hw_params *params);
65 int (*hw_free)(struct snd_pcm_substream *substream);
66 int (*prepare)(struct snd_pcm_substream *substream);
67 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
68 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
69 int (*copy)(struct snd_pcm_substream *substream, int channel,
70 snd_pcm_uframes_t pos,
1da177e4 71 void __user *buf, snd_pcm_uframes_t count);
877211f5 72 int (*silence)(struct snd_pcm_substream *substream, int channel,
1da177e4 73 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
877211f5
TI		 74 struct page *(*page)(struct snd_pcm_substream *substream,
75 unsigned long offset);
76 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
77 int (*ack)(struct snd_pcm_substream *substream);
78};
1da177e4
LT		 79
80/*
81 *
82 */
83
84#define SNDRV_PCM_DEVICES 8
85
86#define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
87#define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
88
89#define SNDRV_PCM_IOCTL1_RESET 0
90#define SNDRV_PCM_IOCTL1_INFO 1
91#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
92#define SNDRV_PCM_IOCTL1_GSTATE 3
93
94#define SNDRV_PCM_TRIGGER_STOP 0
95#define SNDRV_PCM_TRIGGER_START 1
96#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
97#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
98#define SNDRV_PCM_TRIGGER_SUSPEND 5
99#define SNDRV_PCM_TRIGGER_RESUME 6
100
101#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
102
103/* If you change this don't forget to change rates[] table in pcm_native.c */
104#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
105#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
106#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
107#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
108#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
109#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
110#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
111#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
112#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
113#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
114#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
115#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
116#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
117
118#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
119#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
120
121#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
122 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
123 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
124#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
125#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
126 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
127#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
128 SNDRV_PCM_RATE_192000)
129#define SNDRV_PCM_FMTBIT_S8 (1ULL << SNDRV_PCM_FORMAT_S8)
130#define SNDRV_PCM_FMTBIT_U8 (1ULL << SNDRV_PCM_FORMAT_U8)
131#define SNDRV_PCM_FMTBIT_S16_LE (1ULL << SNDRV_PCM_FORMAT_S16_LE)
132#define SNDRV_PCM_FMTBIT_S16_BE (1ULL << SNDRV_PCM_FORMAT_S16_BE)
133#define SNDRV_PCM_FMTBIT_U16_LE (1ULL << SNDRV_PCM_FORMAT_U16_LE)
134#define SNDRV_PCM_FMTBIT_U16_BE (1ULL << SNDRV_PCM_FORMAT_U16_BE)
135#define SNDRV_PCM_FMTBIT_S24_LE (1ULL << SNDRV_PCM_FORMAT_S24_LE)
136#define SNDRV_PCM_FMTBIT_S24_BE (1ULL << SNDRV_PCM_FORMAT_S24_BE)
137#define SNDRV_PCM_FMTBIT_U24_LE (1ULL << SNDRV_PCM_FORMAT_U24_LE)
138#define SNDRV_PCM_FMTBIT_U24_BE (1ULL << SNDRV_PCM_FORMAT_U24_BE)
139#define SNDRV_PCM_FMTBIT_S32_LE (1ULL << SNDRV_PCM_FORMAT_S32_LE)
140#define SNDRV_PCM_FMTBIT_S32_BE (1ULL << SNDRV_PCM_FORMAT_S32_BE)
141#define SNDRV_PCM_FMTBIT_U32_LE (1ULL << SNDRV_PCM_FORMAT_U32_LE)
142#define SNDRV_PCM_FMTBIT_U32_BE (1ULL << SNDRV_PCM_FORMAT_U32_BE)
143#define SNDRV_PCM_FMTBIT_FLOAT_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
144#define SNDRV_PCM_FMTBIT_FLOAT_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
145#define SNDRV_PCM_FMTBIT_FLOAT64_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
146#define SNDRV_PCM_FMTBIT_FLOAT64_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
147#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
148#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
149#define SNDRV_PCM_FMTBIT_MU_LAW (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
150#define SNDRV_PCM_FMTBIT_A_LAW (1ULL << SNDRV_PCM_FORMAT_A_LAW)
151#define SNDRV_PCM_FMTBIT_IMA_ADPCM (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
152#define SNDRV_PCM_FMTBIT_MPEG (1ULL << SNDRV_PCM_FORMAT_MPEG)
153#define SNDRV_PCM_FMTBIT_GSM (1ULL << SNDRV_PCM_FORMAT_GSM)
154#define SNDRV_PCM_FMTBIT_SPECIAL (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
155#define SNDRV_PCM_FMTBIT_S24_3LE (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
156#define SNDRV_PCM_FMTBIT_U24_3LE (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
157#define SNDRV_PCM_FMTBIT_S24_3BE (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
158#define SNDRV_PCM_FMTBIT_U24_3BE (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
159#define SNDRV_PCM_FMTBIT_S20_3LE (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
160#define SNDRV_PCM_FMTBIT_U20_3LE (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
161#define SNDRV_PCM_FMTBIT_S20_3BE (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
162#define SNDRV_PCM_FMTBIT_U20_3BE (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
163#define SNDRV_PCM_FMTBIT_S18_3LE (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
164#define SNDRV_PCM_FMTBIT_U18_3LE (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
165#define SNDRV_PCM_FMTBIT_S18_3BE (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
166#define SNDRV_PCM_FMTBIT_U18_3BE (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
167
168#ifdef SNDRV_LITTLE_ENDIAN
169#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
170#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
171#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
172#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
173#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
174#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
175#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
176#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
177#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
178#endif
179#ifdef SNDRV_BIG_ENDIAN
180#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
181#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
182#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
183#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
184#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
185#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
186#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
187#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
188#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
189#endif
190
877211f5
TI		 191struct snd_pcm_file {
192 struct snd_pcm_substream *substream;
193 struct snd_pcm_file *next;
1da177e4
LT		 194};
195
877211f5
TI		 196struct snd_pcm_hw_rule;
197typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
198 struct snd_pcm_hw_rule *rule);
1da177e4 199
877211f5 200struct snd_pcm_hw_rule {
1da177e4
LT		 201 unsigned int cond;
202 snd_pcm_hw_rule_func_t func;
203 int var;
204 int deps[4];
205 void *private;
206};
207
877211f5
TI		 208struct snd_pcm_hw_constraints {
209 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
1da177e4 210 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
877211f5 211 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
1da177e4
LT		 212 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
213 unsigned int rules_num;
214 unsigned int rules_all;
877211f5
TI		 215 struct snd_pcm_hw_rule *rules;
216};
1da177e4 217
877211f5
TI		 218static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
219 snd_pcm_hw_param_t var)
1da177e4
LT		 220{
221 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
222}
223
877211f5
TI		 224static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
225 snd_pcm_hw_param_t var)
1da177e4
LT		 226{
227 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
228}
229
877211f5 230struct snd_ratnum {
1da177e4
LT		 231 unsigned int num;
232 unsigned int den_min, den_max, den_step;
877211f5 233};
1da177e4 234
877211f5 235struct snd_ratden {
1da177e4
LT		 236 unsigned int num_min, num_max, num_step;
237 unsigned int den;
877211f5 238};
1da177e4 239
877211f5 240struct snd_pcm_hw_constraint_ratnums {
1da177e4 241 int nrats;
877211f5
TI		 242 struct snd_ratnum *rats;
243};
1da177e4 244
877211f5 245struct snd_pcm_hw_constraint_ratdens {
1da177e4 246 int nrats;
877211f5
TI		 247 struct snd_ratden *rats;
248};
1da177e4 249
877211f5 250struct snd_pcm_hw_constraint_list {
1da177e4
LT		 251 unsigned int count;
252 unsigned int *list;
253 unsigned int mask;
877211f5 254};
1da177e4 255
877211f5 256struct snd_pcm_runtime {
1da177e4 257 /* -- Status -- */
877211f5 258 struct snd_pcm_substream *trigger_master;
07799e75 259 struct timespec trigger_tstamp; /* trigger timestamp */
1da177e4
LT		 260 int overrange;
261 snd_pcm_uframes_t avail_max;
262 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
263 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time*/
264
265 /* -- HW params -- */
266 snd_pcm_access_t access; /* access mode */
267 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
268 snd_pcm_subformat_t subformat; /* subformat */
269 unsigned int rate; /* rate in Hz */
270 unsigned int channels; /* channels */
271 snd_pcm_uframes_t period_size; /* period size */
272 unsigned int periods; /* periods */
273 snd_pcm_uframes_t buffer_size; /* buffer size */
274 unsigned int tick_time; /* tick time */
275 snd_pcm_uframes_t min_align; /* Min alignment for the format */
276 size_t byte_align;
277 unsigned int frame_bits;
278 unsigned int sample_bits;
279 unsigned int info;
280 unsigned int rate_num;
281 unsigned int rate_den;
282
283 /* -- SW params -- */
877211f5 284 int tstamp_mode; /* mmap timestamp is updated */
1da177e4
LT		 285 unsigned int period_step;
286 unsigned int sleep_min; /* min ticks to sleep */
287 snd_pcm_uframes_t xfer_align; /* xfer size need to be a multiple */
288 snd_pcm_uframes_t start_threshold;
289 snd_pcm_uframes_t stop_threshold;
290 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
291 noise is nearest than this */
292 snd_pcm_uframes_t silence_size; /* Silence filling size */
293 snd_pcm_uframes_t boundary; /* pointers wrap point */
294
295 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
296 snd_pcm_uframes_t silence_filled; /* size filled with silence */
297
877211f5 298 union snd_pcm_sync_id sync; /* hardware synchronization ID */
1da177e4
LT		 299
300 /* -- mmap -- */
877211f5
TI		 301 volatile struct snd_pcm_mmap_status *status;
302 volatile struct snd_pcm_mmap_control *control;
1da177e4
LT		 303 atomic_t mmap_count;
304
305 /* -- locking / scheduling -- */
306 wait_queue_head_t sleep;
307 struct timer_list tick_timer;
308 struct fasync_struct *fasync;
309
310 /* -- private section -- */
311 void *private_data;
877211f5 312 void (*private_free)(struct snd_pcm_runtime *runtime);
1da177e4
LT		 313
314 /* -- hardware description -- */
877211f5
TI		 315 struct snd_pcm_hardware hw;
316 struct snd_pcm_hw_constraints hw_constraints;
1da177e4
LT		 317
318 /* -- interrupt callbacks -- */
877211f5
TI		 319 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
320 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
1da177e4
LT		 321
322 /* -- timer -- */
323 unsigned int timer_resolution; /* timer resolution */
324
325 /* -- DMA -- */
326 unsigned char *dma_area; /* DMA area */
327 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
328 size_t dma_bytes; /* size of DMA area */
329
330 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
331
332#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
333 /* -- OSS things -- */
877211f5 334 struct snd_pcm_oss_runtime oss;
1da177e4
LT		 335#endif
336};
337
877211f5 338struct snd_pcm_group { /* keep linked substreams */
1da177e4
LT		 339 spinlock_t lock;
340 struct list_head substreams;
341 int count;
877211f5 342};
1da177e4 343
877211f5
TI		 344struct snd_pcm_substream {
345 struct snd_pcm *pcm;
346 struct snd_pcm_str *pstr;
1da177e4
LT		 347 void *private_data; /* copied from pcm->private_data */
348 int number;
349 char name[32]; /* substream name */
350 int stream; /* stream (direction) */
351 size_t buffer_bytes_max; /* limit ring buffer size */
352 struct snd_dma_buffer dma_buffer;
353 unsigned int dma_buf_id;
354 size_t dma_max;
355 /* -- hardware operations -- */
877211f5 356 struct snd_pcm_ops *ops;
1da177e4 357 /* -- runtime information -- */
877211f5 358 struct snd_pcm_runtime *runtime;
1da177e4 359 /* -- timer section -- */
877211f5 360 struct snd_timer *timer; /* timer */
1da177e4
LT		 361 unsigned timer_running: 1; /* time is running */
362 spinlock_t timer_lock;
363 /* -- next substream -- */
877211f5 364 struct snd_pcm_substream *next;
1da177e4
LT		 365 /* -- linked substreams -- */
366 struct list_head link_list; /* linked list member */
877211f5
TI		 367 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
368 struct snd_pcm_group *group; /* pointer to current group */
1da177e4 369 /* -- assigned files -- */
877211f5 370 struct snd_pcm_file *file;
1da177e4
LT		 371 struct file *ffile;
372#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
373 /* -- OSS things -- */
877211f5 374 struct snd_pcm_oss_substream oss;
1da177e4 375#endif
877211f5
TI		 376 struct snd_info_entry *proc_root;
377 struct snd_info_entry *proc_info_entry;
378 struct snd_info_entry *proc_hw_params_entry;
379 struct snd_info_entry *proc_sw_params_entry;
380 struct snd_info_entry *proc_status_entry;
381 struct snd_info_entry *proc_prealloc_entry;
1da177e4
LT		 382 /* misc flags */
383 unsigned int no_mmap_ctrl: 1;
384};
385
386#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
387#define SUBSTREAM_BUSY(substream) ((substream)->file != NULL || ((substream)->oss.file != NULL))
388#else
389#define SUBSTREAM_BUSY(substream) ((substream)->file != NULL)
390#endif
391
392
877211f5 393struct snd_pcm_str {
1da177e4 394 int stream; /* stream (direction) */
877211f5 395 struct snd_pcm *pcm;
1da177e4
LT		 396 /* -- substreams -- */
397 unsigned int substream_count;
398 unsigned int substream_opened;
877211f5 399 struct snd_pcm_substream *substream;
1da177e4
LT		 400#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
401 /* -- OSS things -- */
877211f5 402 struct snd_pcm_oss_stream oss;
1da177e4 403#endif
877211f5 404 struct snd_pcm_file *files;
877211f5
TI		 405 struct snd_info_entry *proc_root;
406 struct snd_info_entry *proc_info_entry;
1da177e4
LT		 407#ifdef CONFIG_SND_DEBUG
408 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
877211f5 409 struct snd_info_entry *proc_xrun_debug_entry;
1da177e4
LT		 410#endif
411};
412
877211f5
TI		 413struct snd_pcm {
414 struct snd_card *card;
f87135f5 415 struct list_head list;
1da177e4
LT		 416 unsigned int device; /* device number */
417 unsigned int info_flags;
418 unsigned short dev_class;
419 unsigned short dev_subclass;
420 char id[64];
421 char name[80];
877211f5 422 struct snd_pcm_str streams[2];
1a60d4c5 423 struct mutex open_mutex;
1da177e4
LT		 424 wait_queue_head_t open_wait;
425 void *private_data;
877211f5 426 void (*private_free) (struct snd_pcm *pcm);
1da177e4 427#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
877211f5 428 struct snd_pcm_oss oss;
1da177e4
LT		 429#endif
430};
431
877211f5
TI		 432struct snd_pcm_notify {
433 int (*n_register) (struct snd_pcm * pcm);
434 int (*n_disconnect) (struct snd_pcm * pcm);
435 int (*n_unregister) (struct snd_pcm * pcm);
1da177e4 436 struct list_head list;
877211f5 437};
1da177e4
LT		 438
439/*
440 * Registering
441 */
442
2af677fc 443extern struct file_operations snd_pcm_f_ops[2];
1da177e4 444
877211f5 445int snd_pcm_new(struct snd_card *card, char *id, int device,
1da177e4 446 int playback_count, int capture_count,
877211f5
TI		 447 struct snd_pcm **rpcm);
448int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
1da177e4 449
877211f5 450int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
1da177e4
LT		 451
452/*
453 * Native I/O
454 */
455
456extern rwlock_t snd_pcm_link_rwlock;
457
877211f5
TI		 458int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
459int snd_pcm_info_user(struct snd_pcm_substream *substream,
460 struct snd_pcm_info __user *info);
461int snd_pcm_status(struct snd_pcm_substream *substream,
462 struct snd_pcm_status *status);
877211f5
TI		 463int snd_pcm_start(struct snd_pcm_substream *substream);
464int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
465int snd_pcm_drain_done(struct snd_pcm_substream *substream);
1da177e4 466#ifdef CONFIG_PM
877211f5
TI		 467int snd_pcm_suspend(struct snd_pcm_substream *substream);
468int snd_pcm_suspend_all(struct snd_pcm *pcm);
1da177e4 469#endif
877211f5
TI		 470int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
471int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct snd_pcm_substream **rsubstream);
472void snd_pcm_release_substream(struct snd_pcm_substream *substream);
1da177e4 473void snd_pcm_vma_notify_data(void *client, void *data);
877211f5 474int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
1da177e4
LT		 475
476#if BITS_PER_LONG >= 64
477
478static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
479{
480 *rem = *n % div;
481 *n /= div;
482}
483
484#elif defined(i386)
485
486static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
487{
488 u_int32_t low, high;
489 low = *n & 0xffffffff;
490 high = *n >> 32;
491 if (high) {
492 u_int32_t high1 = high % div;
493 high /= div;
494 asm("divl %2":"=a" (low), "=d" (*rem):"rm" (div), "a" (low), "d" (high1));
495 *n = (u_int64_t)high << 32 | low;
496 } else {
497 *n = low / div;
498 *rem = low % div;
499 }
500}
501#else
502
503static inline void divl(u_int32_t high, u_int32_t low,
504 u_int32_t div,
505 u_int32_t *q, u_int32_t *r)
506{
507 u_int64_t n = (u_int64_t)high << 32 | low;
508 u_int64_t d = (u_int64_t)div << 31;
509 u_int32_t q1 = 0;
510 int c = 32;
511 while (n > 0xffffffffU) {
512 q1 <<= 1;
513 if (n >= d) {
514 n -= d;
515 q1 |= 1;
516 }
517 d >>= 1;
518 c--;
519 }
520 q1 <<= c;
521 if (n) {
522 low = n;
523 *q = q1 | (low / div);
524 *r = low % div;
525 } else {
526 *r = 0;
527 *q = q1;
528 }
529 return;
530}
531
532static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
533{
534 u_int32_t low, high;
535 low = *n & 0xffffffff;
536 high = *n >> 32;
537 if (high) {
538 u_int32_t high1 = high % div;
539 u_int32_t low1 = low;
540 high /= div;
541 divl(high1, low1, div, &low, rem);
542 *n = (u_int64_t)high << 32 | low;
543 } else {
544 *n = low / div;
545 *rem = low % div;
546 }
547}
548#endif
549
550/*
551 * PCM library
552 */
553
877211f5 554static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
1da177e4
LT		 555{
556 return substream->group != &substream->self_group;
557}
558
877211f5 559static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
1da177e4
LT		 560{
561 read_lock(&snd_pcm_link_rwlock);
562 spin_lock(&substream->self_group.lock);
563}
564
877211f5 565static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
1da177e4
LT		 566{
567 spin_unlock(&substream->self_group.lock);
568 read_unlock(&snd_pcm_link_rwlock);
569}
570
877211f5 571static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
1da177e4
LT		 572{
573 read_lock_irq(&snd_pcm_link_rwlock);
574 spin_lock(&substream->self_group.lock);
575}
576
877211f5 577static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
1da177e4
LT		 578{
579 spin_unlock(&substream->self_group.lock);
580 read_unlock_irq(&snd_pcm_link_rwlock);
581}
582
583#define snd_pcm_stream_lock_irqsave(substream, flags) \
584do { \
585 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
586 spin_lock(&substream->self_group.lock); \
587} while (0)
588
589#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
590do { \
591 spin_unlock(&substream->self_group.lock); \
592 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
593} while (0)
594
595#define snd_pcm_group_for_each(pos, substream) \
596 list_for_each(pos, &substream->group->substreams)
597
598#define snd_pcm_group_substream_entry(pos) \
877211f5 599 list_entry(pos, struct snd_pcm_substream, link_list)
1da177e4 600
877211f5 601static inline int snd_pcm_running(struct snd_pcm_substream *substream)
1da177e4
LT		 602{
603 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
604 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
605 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
606}
607
877211f5 608static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT		 609{
610 return size * 8 / runtime->sample_bits;
611}
612
877211f5 613static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT		 614{
615 return size * 8 / runtime->frame_bits;
616}
617
877211f5 618static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT		 619{
620 return size * runtime->sample_bits / 8;
621}
622
877211f5 623static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
1da177e4
LT		 624{
625 return size * runtime->frame_bits / 8;
626}
627
877211f5 628static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
1da177e4
LT		 629{
630 return bytes % runtime->byte_align == 0;
631}
632
877211f5 633static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
1da177e4 634{
877211f5 635 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 636 return frames_to_bytes(runtime, runtime->buffer_size);
637}
638
877211f5 639static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
1da177e4 640{
877211f5 641 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 642 return frames_to_bytes(runtime, runtime->period_size);
643}
644
645/*
646 * result is: 0 ... (boundary - 1)
647 */
877211f5 648static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 649{
650 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
651 if (avail < 0)
652 avail += runtime->boundary;
653 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
654 avail -= runtime->boundary;
655 return avail;
656}
657
658/*
659 * result is: 0 ... (boundary - 1)
660 */
877211f5 661static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 662{
663 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
664 if (avail < 0)
665 avail += runtime->boundary;
666 return avail;
667}
668
877211f5 669static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 670{
671 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
672}
673
877211f5 674static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT		 675{
676 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
677}
678
679/**
680 * snd_pcm_playback_ready - check whether the playback buffer is available
681 * @substream: the pcm substream instance
682 *
683 * Checks whether enough free space is available on the playback buffer.
684 *
685 * Returns non-zero if available, or zero if not.
686 */
877211f5 687static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
1da177e4 688{
877211f5 689 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 690 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
691}
692
693/**
694 * snd_pcm_capture_ready - check whether the capture buffer is available
695 * @substream: the pcm substream instance
696 *
697 * Checks whether enough capture data is available on the capture buffer.
698 *
699 * Returns non-zero if available, or zero if not.
700 */
877211f5 701static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
1da177e4 702{
877211f5 703 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 704 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
705}
706
707/**
708 * snd_pcm_playback_data - check whether any data exists on the playback buffer
709 * @substream: the pcm substream instance
710 *
711 * Checks whether any data exists on the playback buffer. If stop_threshold
712 * is bigger or equal to boundary, then this function returns always non-zero.
713 *
714 * Returns non-zero if exists, or zero if not.
715 */
877211f5 716static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
1da177e4 717{
877211f5 718 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 719
720 if (runtime->stop_threshold >= runtime->boundary)
721 return 1;
722 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
723}
724
725/**
726 * snd_pcm_playback_empty - check whether the playback buffer is empty
727 * @substream: the pcm substream instance
728 *
729 * Checks whether the playback buffer is empty.
730 *
731 * Returns non-zero if empty, or zero if not.
732 */
877211f5 733static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
1da177e4 734{
877211f5 735 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 736 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
737}
738
739/**
740 * snd_pcm_capture_empty - check whether the capture buffer is empty
741 * @substream: the pcm substream instance
742 *
743 * Checks whether the capture buffer is empty.
744 *
745 * Returns non-zero if empty, or zero if not.
746 */
877211f5 747static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
1da177e4 748{
877211f5 749 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 750 return snd_pcm_capture_avail(runtime) == 0;
751}
752
877211f5
TI		 753static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
754 struct snd_pcm_substream *master)
1da177e4
LT		 755{
756 substream->runtime->trigger_master = master;
757}
758
759static inline int hw_is_mask(int var)
760{
761 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
762 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
763}
764
765static inline int hw_is_interval(int var)
766{
767 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
768 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
769}
770
877211f5 771static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
1da177e4
LT		 772 snd_pcm_hw_param_t var)
773{
774 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
775}
776
877211f5 777static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
1da177e4
LT		 778 snd_pcm_hw_param_t var)
779{
780 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
781}
782
877211f5 783static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
1da177e4
LT		 784 snd_pcm_hw_param_t var)
785{
877211f5 786 return (const struct snd_mask *)hw_param_mask((struct snd_pcm_hw_params*) params, var);
1da177e4
LT		 787}
788
877211f5 789static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
1da177e4
LT		 790 snd_pcm_hw_param_t var)
791{
877211f5 792 return (const struct snd_interval *)hw_param_interval((struct snd_pcm_hw_params*) params, var);
1da177e4
LT		 793}
794
795#define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
796#define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
797#define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
798#define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
799#define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
800#define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
801#define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
802#define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
803#define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
804#define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
805#define params_tick_time(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_TICK_TIME)->min
806
807
877211f5
TI		 808int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
809void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
810void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
811void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
812 unsigned int k, struct snd_interval *c);
813void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
814 const struct snd_interval *b, struct snd_interval *c);
815int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
816int snd_interval_ratnum(struct snd_interval *i,
817 unsigned int rats_count, struct snd_ratnum *rats,
1da177e4
LT		 818 unsigned int *nump, unsigned int *denp);
819
877211f5
TI		 820void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
821void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
822int snd_pcm_hw_param_near(struct snd_pcm_substream *substream,
823 struct snd_pcm_hw_params *params,
1da177e4
LT		 824 snd_pcm_hw_param_t var,
825 unsigned int val, int *dir);
877211f5
TI		 826int snd_pcm_hw_param_set(struct snd_pcm_substream *pcm,
827 struct snd_pcm_hw_params *params,
1da177e4
LT		 828 snd_pcm_hw_param_t var,
829 unsigned int val, int dir);
877211f5 830int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1da177e4 831
877211f5 832int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1da177e4 833
877211f5
TI		 834int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
835int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
1da177e4 836
877211f5 837int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 838 u_int32_t mask);
877211f5 839int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 840 u_int64_t mask);
877211f5 841int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 842 unsigned int min, unsigned int max);
877211f5
TI		 843int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
844int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
1da177e4
LT		 845 unsigned int cond,
846 snd_pcm_hw_param_t var,
877211f5
TI		 847 struct snd_pcm_hw_constraint_list *l);
848int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
1da177e4
LT		 849 unsigned int cond,
850 snd_pcm_hw_param_t var,
877211f5
TI		 851 struct snd_pcm_hw_constraint_ratnums *r);
852int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
1da177e4
LT		 853 unsigned int cond,
854 snd_pcm_hw_param_t var,
877211f5
TI		 855 struct snd_pcm_hw_constraint_ratdens *r);
856int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1da177e4
LT		 857 unsigned int cond,
858 unsigned int width,
859 unsigned int msbits);
877211f5 860int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1da177e4
LT		 861 unsigned int cond,
862 snd_pcm_hw_param_t var,
863 unsigned long step);
877211f5 864int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1da177e4
LT		 865 unsigned int cond,
866 snd_pcm_hw_param_t var);
877211f5 867int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
1da177e4
LT		 868 unsigned int cond,
869 int var,
870 snd_pcm_hw_rule_func_t func, void *private,
871 int dep, ...);
872
873int snd_pcm_format_signed(snd_pcm_format_t format);
874int snd_pcm_format_unsigned(snd_pcm_format_t format);
875int snd_pcm_format_linear(snd_pcm_format_t format);
876int snd_pcm_format_little_endian(snd_pcm_format_t format);
877int snd_pcm_format_big_endian(snd_pcm_format_t format);
1b44c28d
TI		 878#if 0 /* just for DocBook */
879/**
9502dcad
TI		 880 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
881 * @format: the format to check
882 *
883 * Returns 1 if the given PCM format is CPU-endian, 0 if
884 * opposite, or a negative error code if endian not specified.
885 */
8cdfd251 886int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1b44c28d 887#endif /* DocBook */
9502dcad 888#ifdef SNDRV_LITTLE_ENDIAN
9d01a82e 889#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
9502dcad 890#else
9d01a82e 891#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
9502dcad 892#endif
1da177e4
LT		 893int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
894int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
9502dcad 895ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1da177e4
LT		 896const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
897int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
898snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
899const char *snd_pcm_format_name(snd_pcm_format_t format);
900
877211f5
TI		 901void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
902void snd_pcm_set_sync(struct snd_pcm_substream *substream);
903int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
904int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1da177e4 905 unsigned int cmd, void *arg);
877211f5
TI		 906int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
907int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
908int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
909int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
910int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
911void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
912void snd_pcm_tick_prepare(struct snd_pcm_substream *substream);
913void snd_pcm_tick_set(struct snd_pcm_substream *substream, unsigned long ticks);
914void snd_pcm_tick_elapsed(struct snd_pcm_substream *substream);
915void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
916snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
1da177e4
LT		 917 const void __user *buf,
918 snd_pcm_uframes_t frames);
877211f5 919snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
1da177e4 920 void __user *buf, snd_pcm_uframes_t frames);
877211f5 921snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1da177e4 922 void __user **bufs, snd_pcm_uframes_t frames);
877211f5 923snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1da177e4
LT		 924 void __user **bufs, snd_pcm_uframes_t frames);
925
877211f5 926int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
1da177e4 927
877211f5 928static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1da177e4
LT		 929 struct snd_dma_buffer *bufp)
930{
877211f5 931 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT		 932 if (bufp) {
933 runtime->dma_buffer_p = bufp;
934 runtime->dma_area = bufp->area;
935 runtime->dma_addr = bufp->addr;
936 runtime->dma_bytes = bufp->bytes;
937 } else {
938 runtime->dma_buffer_p = NULL;
939 runtime->dma_area = NULL;
940 runtime->dma_addr = 0;
941 runtime->dma_bytes = 0;
942 }
943}
944
945/*
946 * Timer interface
947 */
948
877211f5
TI		 949void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
950void snd_pcm_timer_init(struct snd_pcm_substream *substream);
951void snd_pcm_timer_done(struct snd_pcm_substream *substream);
1da177e4
LT		 952
953/*
954 * Memory
955 */
956
877211f5
TI		 957int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
958int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
959int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1da177e4
LT		 960 int type, struct device *data,
961 size_t size, size_t max);
877211f5 962int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1da177e4
LT		 963 int type, void *data,
964 size_t size, size_t max);
877211f5
TI		 965int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
966int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1da177e4
LT		 967
968#define snd_pcm_substream_sgbuf(substream) ((substream)->runtime->dma_buffer_p->private_data)
969#define snd_pcm_sgbuf_pages(size) snd_sgbuf_aligned_pages(size)
970#define snd_pcm_sgbuf_get_addr(sgbuf,ofs) snd_sgbuf_get_addr(sgbuf,ofs)
877211f5 971struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, unsigned long offset);
1da177e4
LT		 972
973/* handle mmap counter - PCM mmap callback should handle this counter properly */
974static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
975{
877211f5 976 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1da177e4
LT		 977 atomic_inc(&substream->runtime->mmap_count);
978}
979
980static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
981{
877211f5 982 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1da177e4
LT		 983 atomic_dec(&substream->runtime->mmap_count);
984}
985
986/* mmap for io-memory area */
987#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
988#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
877211f5 989int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1da177e4
LT		 990#else
991#define SNDRV_PCM_INFO_MMAP_IOMEM 0
992#define snd_pcm_lib_mmap_iomem NULL
993#endif
994
995static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
996{
997 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
998}
999
1000/*
1001 * Misc
1002 */
1003
1004#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1005 (IEC958_AES1_CON_ORIGINAL<<8)|\
1006 (IEC958_AES1_CON_PCM_CODER<<8)|\
1007 (IEC958_AES3_CON_FS_48000<<24))
1008
1009#endif /* __SOUND_PCM_H */
Linux 6.x block layer and io_uring tree(s)