Root/include/sound/pcm.h

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

Archive Download this file



interactive