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