~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/sound/pcm.h

Version: ~ [ linux-5.5-rc1 ] ~ [ linux-5.4.2 ] ~ [ linux-5.3.15 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.88 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.158 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.206 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.206 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.78 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp