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