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