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

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

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

~ [ 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