]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #ifndef __SOUND_PCM_H |
2 | #define __SOUND_PCM_H | |
3 | ||
4 | /* | |
5 | * Digital Audio (PCM) abstract layer | |
c1017a4c | 6 | * Copyright (c) by Jaroslav Kysela <perex@perex.cz> |
1da177e4 LT |
7 | * Abramo Bagnara <abramo@alsa-project.org> |
8 | * | |
9 | * | |
10 | * This program is free software; you can redistribute it and/or modify | |
11 | * it under the terms of the GNU General Public License as published by | |
12 | * the Free Software Foundation; either version 2 of the License, or | |
13 | * (at your option) any later version. | |
14 | * | |
15 | * This program is distributed in the hope that it will be useful, | |
16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | * GNU General Public License for more details. | |
19 | * | |
20 | * You should have received a copy of the GNU General Public License | |
21 | * along with this program; if not, write to the Free Software | |
22 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
23 | * | |
24 | */ | |
25 | ||
26 | #include <sound/asound.h> | |
27 | #include <sound/memalloc.h> | |
f90c06a2 | 28 | #include <sound/minors.h> |
1da177e4 | 29 | #include <linux/poll.h> |
f23f6e08 | 30 | #include <linux/mm.h> |
1da177e4 | 31 | #include <linux/bitops.h> |
e8db0be1 | 32 | #include <linux/pm_qos.h> |
1da177e4 | 33 | |
1da177e4 LT |
34 | #define snd_pcm_substream_chip(substream) ((substream)->private_data) |
35 | #define snd_pcm_chip(pcm) ((pcm)->private_data) | |
36 | ||
1da177e4 | 37 | #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE) |
a1ce3928 | 38 | #include <sound/pcm_oss.h> |
1da177e4 LT |
39 | #endif |
40 | ||
41 | /* | |
42 | * Hardware (lowlevel) section | |
43 | */ | |
44 | ||
877211f5 | 45 | struct snd_pcm_hardware { |
1da177e4 LT |
46 | unsigned int info; /* SNDRV_PCM_INFO_* */ |
47 | u64 formats; /* SNDRV_PCM_FMTBIT_* */ | |
48 | unsigned int rates; /* SNDRV_PCM_RATE_* */ | |
49 | unsigned int rate_min; /* min rate */ | |
50 | unsigned int rate_max; /* max rate */ | |
51 | unsigned int channels_min; /* min channels */ | |
52 | unsigned int channels_max; /* max channels */ | |
53 | size_t buffer_bytes_max; /* max buffer size */ | |
54 | size_t period_bytes_min; /* min period size */ | |
55 | size_t period_bytes_max; /* max period size */ | |
56 | unsigned int periods_min; /* min # of periods */ | |
57 | unsigned int periods_max; /* max # of periods */ | |
58 | size_t fifo_size; /* fifo size in bytes */ | |
877211f5 | 59 | }; |
1da177e4 | 60 | |
e0e6ce03 RD |
61 | struct snd_pcm_substream; |
62 | ||
877211f5 TI |
63 | struct snd_pcm_ops { |
64 | int (*open)(struct snd_pcm_substream *substream); | |
65 | int (*close)(struct snd_pcm_substream *substream); | |
66 | int (*ioctl)(struct snd_pcm_substream * substream, | |
1da177e4 | 67 | unsigned int cmd, void *arg); |
877211f5 TI |
68 | int (*hw_params)(struct snd_pcm_substream *substream, |
69 | struct snd_pcm_hw_params *params); | |
70 | int (*hw_free)(struct snd_pcm_substream *substream); | |
71 | int (*prepare)(struct snd_pcm_substream *substream); | |
72 | int (*trigger)(struct snd_pcm_substream *substream, int cmd); | |
73 | snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream); | |
4eeaaeae PLB |
74 | int (*wall_clock)(struct snd_pcm_substream *substream, |
75 | struct timespec *audio_ts); | |
877211f5 TI |
76 | int (*copy)(struct snd_pcm_substream *substream, int channel, |
77 | snd_pcm_uframes_t pos, | |
1da177e4 | 78 | void __user *buf, snd_pcm_uframes_t count); |
877211f5 | 79 | int (*silence)(struct snd_pcm_substream *substream, int channel, |
1da177e4 | 80 | snd_pcm_uframes_t pos, snd_pcm_uframes_t count); |
877211f5 TI |
81 | struct page *(*page)(struct snd_pcm_substream *substream, |
82 | unsigned long offset); | |
83 | int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma); | |
84 | int (*ack)(struct snd_pcm_substream *substream); | |
85 | }; | |
1da177e4 LT |
86 | |
87 | /* | |
88 | * | |
89 | */ | |
90 | ||
f90c06a2 PM |
91 | #if defined(CONFIG_SND_DYNAMIC_MINORS) |
92 | #define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2) | |
93 | #else | |
94 | #define SNDRV_PCM_DEVICES 8 | |
95 | #endif | |
896e6cc2 | 96 | |
1da177e4 LT |
97 | #define SNDRV_PCM_IOCTL1_FALSE ((void *)0) |
98 | #define SNDRV_PCM_IOCTL1_TRUE ((void *)1) | |
99 | ||
100 | #define SNDRV_PCM_IOCTL1_RESET 0 | |
101 | #define SNDRV_PCM_IOCTL1_INFO 1 | |
102 | #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2 | |
103 | #define SNDRV_PCM_IOCTL1_GSTATE 3 | |
8bea869c | 104 | #define SNDRV_PCM_IOCTL1_FIFO_SIZE 4 |
1da177e4 LT |
105 | |
106 | #define SNDRV_PCM_TRIGGER_STOP 0 | |
107 | #define SNDRV_PCM_TRIGGER_START 1 | |
108 | #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3 | |
109 | #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4 | |
110 | #define SNDRV_PCM_TRIGGER_SUSPEND 5 | |
111 | #define SNDRV_PCM_TRIGGER_RESUME 6 | |
112 | ||
113 | #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1) | |
114 | ||
115 | /* If you change this don't forget to change rates[] table in pcm_native.c */ | |
116 | #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */ | |
117 | #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */ | |
118 | #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */ | |
119 | #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */ | |
120 | #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */ | |
121 | #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */ | |
122 | #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */ | |
123 | #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */ | |
124 | #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */ | |
125 | #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */ | |
126 | #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */ | |
127 | #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */ | |
128 | #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */ | |
129 | ||
130 | #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */ | |
131 | #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */ | |
132 | ||
133 | #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\ | |
134 | SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\ | |
135 | SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100) | |
136 | #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000) | |
137 | #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\ | |
138 | SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000) | |
139 | #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\ | |
140 | SNDRV_PCM_RATE_192000) | |
fea952e5 CL |
141 | #define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt) |
142 | #define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8) | |
143 | #define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8) | |
144 | #define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE) | |
145 | #define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE) | |
146 | #define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE) | |
147 | #define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE) | |
148 | #define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE) | |
149 | #define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE) | |
150 | #define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE) | |
151 | #define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE) | |
152 | #define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE) | |
153 | #define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE) | |
154 | #define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE) | |
155 | #define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE) | |
156 | #define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE) | |
157 | #define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE) | |
158 | #define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE) | |
159 | #define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE) | |
160 | #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE) | |
161 | #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE) | |
162 | #define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW) | |
163 | #define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW) | |
164 | #define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM) | |
165 | #define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG) | |
166 | #define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM) | |
167 | #define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL) | |
168 | #define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE) | |
169 | #define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE) | |
170 | #define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE) | |
171 | #define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE) | |
172 | #define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE) | |
173 | #define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE) | |
174 | #define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE) | |
175 | #define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE) | |
176 | #define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE) | |
177 | #define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE) | |
178 | #define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE) | |
179 | #define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE) | |
180 | #define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24) | |
181 | #define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B) | |
182 | #define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40) | |
183 | #define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B) | |
ef7a4f97 DM |
184 | #define SNDRV_PCM_FMTBIT_DSD_U8 _SNDRV_PCM_FMTBIT(DSD_U8) |
185 | #define SNDRV_PCM_FMTBIT_DSD_U16_LE _SNDRV_PCM_FMTBIT(DSD_U16_LE) | |
1da177e4 LT |
186 | |
187 | #ifdef SNDRV_LITTLE_ENDIAN | |
188 | #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE | |
189 | #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE | |
190 | #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE | |
191 | #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE | |
192 | #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE | |
193 | #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE | |
194 | #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE | |
195 | #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE | |
196 | #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE | |
197 | #endif | |
198 | #ifdef SNDRV_BIG_ENDIAN | |
199 | #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE | |
200 | #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE | |
201 | #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE | |
202 | #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE | |
203 | #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE | |
204 | #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE | |
205 | #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE | |
206 | #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE | |
207 | #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE | |
208 | #endif | |
209 | ||
877211f5 TI |
210 | struct snd_pcm_file { |
211 | struct snd_pcm_substream *substream; | |
548a648b | 212 | int no_compat_mmap; |
1da177e4 LT |
213 | }; |
214 | ||
877211f5 TI |
215 | struct snd_pcm_hw_rule; |
216 | typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params, | |
217 | struct snd_pcm_hw_rule *rule); | |
1da177e4 | 218 | |
877211f5 | 219 | struct snd_pcm_hw_rule { |
1da177e4 LT |
220 | unsigned int cond; |
221 | snd_pcm_hw_rule_func_t func; | |
222 | int var; | |
223 | int deps[4]; | |
224 | void *private; | |
225 | }; | |
226 | ||
877211f5 TI |
227 | struct snd_pcm_hw_constraints { |
228 | struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK - | |
1da177e4 | 229 | SNDRV_PCM_HW_PARAM_FIRST_MASK + 1]; |
877211f5 | 230 | struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL - |
1da177e4 LT |
231 | SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1]; |
232 | unsigned int rules_num; | |
233 | unsigned int rules_all; | |
877211f5 TI |
234 | struct snd_pcm_hw_rule *rules; |
235 | }; | |
1da177e4 | 236 | |
877211f5 TI |
237 | static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs, |
238 | snd_pcm_hw_param_t var) | |
1da177e4 LT |
239 | { |
240 | return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK]; | |
241 | } | |
242 | ||
877211f5 TI |
243 | static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs, |
244 | snd_pcm_hw_param_t var) | |
1da177e4 LT |
245 | { |
246 | return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL]; | |
247 | } | |
248 | ||
877211f5 | 249 | struct snd_ratnum { |
1da177e4 LT |
250 | unsigned int num; |
251 | unsigned int den_min, den_max, den_step; | |
877211f5 | 252 | }; |
1da177e4 | 253 | |
877211f5 | 254 | struct snd_ratden { |
1da177e4 LT |
255 | unsigned int num_min, num_max, num_step; |
256 | unsigned int den; | |
877211f5 | 257 | }; |
1da177e4 | 258 | |
877211f5 | 259 | struct snd_pcm_hw_constraint_ratnums { |
1da177e4 | 260 | int nrats; |
877211f5 TI |
261 | struct snd_ratnum *rats; |
262 | }; | |
1da177e4 | 263 | |
877211f5 | 264 | struct snd_pcm_hw_constraint_ratdens { |
1da177e4 | 265 | int nrats; |
877211f5 TI |
266 | struct snd_ratden *rats; |
267 | }; | |
1da177e4 | 268 | |
877211f5 | 269 | struct snd_pcm_hw_constraint_list { |
1da177e4 | 270 | unsigned int count; |
4af87a93 | 271 | const unsigned int *list; |
1da177e4 | 272 | unsigned int mask; |
877211f5 | 273 | }; |
1da177e4 | 274 | |
4d96eb25 JK |
275 | struct snd_pcm_hwptr_log; |
276 | ||
877211f5 | 277 | struct snd_pcm_runtime { |
1da177e4 | 278 | /* -- Status -- */ |
877211f5 | 279 | struct snd_pcm_substream *trigger_master; |
07799e75 | 280 | struct timespec trigger_tstamp; /* trigger timestamp */ |
1da177e4 LT |
281 | int overrange; |
282 | snd_pcm_uframes_t avail_max; | |
283 | snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */ | |
e7636925 | 284 | snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */ |
bbf6ad13 | 285 | unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */ |
bd76af0f | 286 | unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */ |
4bbe1ddf | 287 | snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */ |
0e8014d7 | 288 | u64 hw_ptr_wrap; /* offset for hw_ptr due to boundary wrap-around */ |
1da177e4 LT |
289 | |
290 | /* -- HW params -- */ | |
291 | snd_pcm_access_t access; /* access mode */ | |
292 | snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */ | |
293 | snd_pcm_subformat_t subformat; /* subformat */ | |
294 | unsigned int rate; /* rate in Hz */ | |
295 | unsigned int channels; /* channels */ | |
296 | snd_pcm_uframes_t period_size; /* period size */ | |
297 | unsigned int periods; /* periods */ | |
298 | snd_pcm_uframes_t buffer_size; /* buffer size */ | |
1da177e4 LT |
299 | snd_pcm_uframes_t min_align; /* Min alignment for the format */ |
300 | size_t byte_align; | |
301 | unsigned int frame_bits; | |
302 | unsigned int sample_bits; | |
303 | unsigned int info; | |
304 | unsigned int rate_num; | |
305 | unsigned int rate_den; | |
ab69a490 | 306 | unsigned int no_period_wakeup: 1; |
1da177e4 LT |
307 | |
308 | /* -- SW params -- */ | |
877211f5 | 309 | int tstamp_mode; /* mmap timestamp is updated */ |
1da177e4 | 310 | unsigned int period_step; |
1da177e4 LT |
311 | snd_pcm_uframes_t start_threshold; |
312 | snd_pcm_uframes_t stop_threshold; | |
313 | snd_pcm_uframes_t silence_threshold; /* Silence filling happens when | |
314 | noise is nearest than this */ | |
315 | snd_pcm_uframes_t silence_size; /* Silence filling size */ | |
316 | snd_pcm_uframes_t boundary; /* pointers wrap point */ | |
317 | ||
318 | snd_pcm_uframes_t silence_start; /* starting pointer to silence area */ | |
319 | snd_pcm_uframes_t silence_filled; /* size filled with silence */ | |
320 | ||
877211f5 | 321 | union snd_pcm_sync_id sync; /* hardware synchronization ID */ |
1da177e4 LT |
322 | |
323 | /* -- mmap -- */ | |
503fc85a TI |
324 | struct snd_pcm_mmap_status *status; |
325 | struct snd_pcm_mmap_control *control; | |
1da177e4 LT |
326 | |
327 | /* -- locking / scheduling -- */ | |
5daeba34 | 328 | snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */ |
c91a988d JK |
329 | wait_queue_head_t sleep; /* poll sleep */ |
330 | wait_queue_head_t tsleep; /* transfer sleep */ | |
1da177e4 LT |
331 | struct fasync_struct *fasync; |
332 | ||
333 | /* -- private section -- */ | |
334 | void *private_data; | |
877211f5 | 335 | void (*private_free)(struct snd_pcm_runtime *runtime); |
1da177e4 LT |
336 | |
337 | /* -- hardware description -- */ | |
877211f5 TI |
338 | struct snd_pcm_hardware hw; |
339 | struct snd_pcm_hw_constraints hw_constraints; | |
1da177e4 LT |
340 | |
341 | /* -- interrupt callbacks -- */ | |
877211f5 TI |
342 | void (*transfer_ack_begin)(struct snd_pcm_substream *substream); |
343 | void (*transfer_ack_end)(struct snd_pcm_substream *substream); | |
1da177e4 LT |
344 | |
345 | /* -- timer -- */ | |
346 | unsigned int timer_resolution; /* timer resolution */ | |
b751eef1 | 347 | int tstamp_type; /* timestamp type */ |
1da177e4 LT |
348 | |
349 | /* -- DMA -- */ | |
350 | unsigned char *dma_area; /* DMA area */ | |
351 | dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */ | |
352 | size_t dma_bytes; /* size of DMA area */ | |
353 | ||
354 | struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */ | |
355 | ||
356 | #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE) | |
357 | /* -- OSS things -- */ | |
877211f5 | 358 | struct snd_pcm_oss_runtime oss; |
1da177e4 | 359 | #endif |
4d96eb25 JK |
360 | |
361 | #ifdef CONFIG_SND_PCM_XRUN_DEBUG | |
362 | struct snd_pcm_hwptr_log *hwptr_log; | |
363 | #endif | |
1da177e4 LT |
364 | }; |
365 | ||
877211f5 | 366 | struct snd_pcm_group { /* keep linked substreams */ |
1da177e4 LT |
367 | spinlock_t lock; |
368 | struct list_head substreams; | |
369 | int count; | |
877211f5 | 370 | }; |
1da177e4 | 371 | |
e7373b70 CL |
372 | struct pid; |
373 | ||
877211f5 TI |
374 | struct snd_pcm_substream { |
375 | struct snd_pcm *pcm; | |
376 | struct snd_pcm_str *pstr; | |
1da177e4 LT |
377 | void *private_data; /* copied from pcm->private_data */ |
378 | int number; | |
379 | char name[32]; /* substream name */ | |
380 | int stream; /* stream (direction) */ | |
cc749986 | 381 | struct pm_qos_request latency_pm_qos_req; /* pm_qos request */ |
1da177e4 LT |
382 | size_t buffer_bytes_max; /* limit ring buffer size */ |
383 | struct snd_dma_buffer dma_buffer; | |
384 | unsigned int dma_buf_id; | |
385 | size_t dma_max; | |
386 | /* -- hardware operations -- */ | |
877211f5 | 387 | struct snd_pcm_ops *ops; |
1da177e4 | 388 | /* -- runtime information -- */ |
877211f5 | 389 | struct snd_pcm_runtime *runtime; |
1da177e4 | 390 | /* -- timer section -- */ |
877211f5 | 391 | struct snd_timer *timer; /* timer */ |
1da177e4 | 392 | unsigned timer_running: 1; /* time is running */ |
1da177e4 | 393 | /* -- next substream -- */ |
877211f5 | 394 | struct snd_pcm_substream *next; |
1da177e4 LT |
395 | /* -- linked substreams -- */ |
396 | struct list_head link_list; /* linked list member */ | |
877211f5 TI |
397 | struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */ |
398 | struct snd_pcm_group *group; /* pointer to current group */ | |
1da177e4 | 399 | /* -- assigned files -- */ |
1576274d | 400 | void *file; |
0df63e44 | 401 | int ref_count; |
9c323fcb | 402 | atomic_t mmap_count; |
0df63e44 | 403 | unsigned int f_flags; |
3bf75f9b | 404 | void (*pcm_release)(struct snd_pcm_substream *); |
e7373b70 | 405 | struct pid *pid; |
1da177e4 LT |
406 | #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE) |
407 | /* -- OSS things -- */ | |
877211f5 | 408 | struct snd_pcm_oss_substream oss; |
1da177e4 | 409 | #endif |
b7d90a35 | 410 | #ifdef CONFIG_SND_VERBOSE_PROCFS |
877211f5 TI |
411 | struct snd_info_entry *proc_root; |
412 | struct snd_info_entry *proc_info_entry; | |
413 | struct snd_info_entry *proc_hw_params_entry; | |
414 | struct snd_info_entry *proc_sw_params_entry; | |
415 | struct snd_info_entry *proc_status_entry; | |
416 | struct snd_info_entry *proc_prealloc_entry; | |
c7132aeb | 417 | struct snd_info_entry *proc_prealloc_max_entry; |
b7d90a35 | 418 | #endif |
1da177e4 | 419 | /* misc flags */ |
3bf75f9b | 420 | unsigned int hw_opened: 1; |
1da177e4 LT |
421 | }; |
422 | ||
0df63e44 | 423 | #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0) |
1da177e4 LT |
424 | |
425 | ||
877211f5 | 426 | struct snd_pcm_str { |
1da177e4 | 427 | int stream; /* stream (direction) */ |
877211f5 | 428 | struct snd_pcm *pcm; |
1da177e4 LT |
429 | /* -- substreams -- */ |
430 | unsigned int substream_count; | |
431 | unsigned int substream_opened; | |
877211f5 | 432 | struct snd_pcm_substream *substream; |
1da177e4 LT |
433 | #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE) |
434 | /* -- OSS things -- */ | |
877211f5 | 435 | struct snd_pcm_oss_stream oss; |
1da177e4 | 436 | #endif |
b7d90a35 | 437 | #ifdef CONFIG_SND_VERBOSE_PROCFS |
877211f5 TI |
438 | struct snd_info_entry *proc_root; |
439 | struct snd_info_entry *proc_info_entry; | |
b7d90a35 | 440 | #ifdef CONFIG_SND_PCM_XRUN_DEBUG |
1da177e4 | 441 | unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */ |
877211f5 | 442 | struct snd_info_entry *proc_xrun_debug_entry; |
1da177e4 | 443 | #endif |
b7d90a35 | 444 | #endif |
2d3391ec | 445 | struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */ |
1da177e4 LT |
446 | }; |
447 | ||
877211f5 TI |
448 | struct snd_pcm { |
449 | struct snd_card *card; | |
f87135f5 | 450 | struct list_head list; |
f90c06a2 | 451 | int device; /* device number */ |
1da177e4 LT |
452 | unsigned int info_flags; |
453 | unsigned short dev_class; | |
454 | unsigned short dev_subclass; | |
455 | char id[64]; | |
456 | char name[80]; | |
877211f5 | 457 | struct snd_pcm_str streams[2]; |
1a60d4c5 | 458 | struct mutex open_mutex; |
1da177e4 LT |
459 | wait_queue_head_t open_wait; |
460 | void *private_data; | |
877211f5 | 461 | void (*private_free) (struct snd_pcm *pcm); |
c78085fc | 462 | struct device *dev; /* actual hw device this belongs to */ |
945e5038 | 463 | bool internal; /* pcm is for internal use only */ |
1da177e4 | 464 | #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE) |
877211f5 | 465 | struct snd_pcm_oss oss; |
1da177e4 LT |
466 | #endif |
467 | }; | |
468 | ||
877211f5 TI |
469 | struct snd_pcm_notify { |
470 | int (*n_register) (struct snd_pcm * pcm); | |
471 | int (*n_disconnect) (struct snd_pcm * pcm); | |
472 | int (*n_unregister) (struct snd_pcm * pcm); | |
1da177e4 | 473 | struct list_head list; |
877211f5 | 474 | }; |
1da177e4 LT |
475 | |
476 | /* | |
477 | * Registering | |
478 | */ | |
479 | ||
54047320 | 480 | extern const struct file_operations snd_pcm_f_ops[2]; |
1da177e4 | 481 | |
e6161653 | 482 | int snd_pcm_new(struct snd_card *card, const char *id, int device, |
1da177e4 | 483 | int playback_count, int capture_count, |
877211f5 | 484 | struct snd_pcm **rpcm); |
945e5038 LG |
485 | int snd_pcm_new_internal(struct snd_card *card, const char *id, int device, |
486 | int playback_count, int capture_count, | |
487 | struct snd_pcm **rpcm); | |
877211f5 | 488 | int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count); |
1da177e4 | 489 | |
877211f5 | 490 | int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree); |
1da177e4 LT |
491 | |
492 | /* | |
493 | * Native I/O | |
494 | */ | |
495 | ||
496 | extern rwlock_t snd_pcm_link_rwlock; | |
497 | ||
877211f5 TI |
498 | int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info); |
499 | int snd_pcm_info_user(struct snd_pcm_substream *substream, | |
500 | struct snd_pcm_info __user *info); | |
501 | int snd_pcm_status(struct snd_pcm_substream *substream, | |
502 | struct snd_pcm_status *status); | |
877211f5 | 503 | int snd_pcm_start(struct snd_pcm_substream *substream); |
fea952e5 | 504 | int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status); |
877211f5 | 505 | int snd_pcm_drain_done(struct snd_pcm_substream *substream); |
1da177e4 | 506 | #ifdef CONFIG_PM |
877211f5 TI |
507 | int snd_pcm_suspend(struct snd_pcm_substream *substream); |
508 | int snd_pcm_suspend_all(struct snd_pcm *pcm); | |
1da177e4 | 509 | #endif |
877211f5 | 510 | int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg); |
3bf75f9b TI |
511 | int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file, |
512 | struct snd_pcm_substream **rsubstream); | |
877211f5 | 513 | void snd_pcm_release_substream(struct snd_pcm_substream *substream); |
3bf75f9b TI |
514 | int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file, |
515 | struct snd_pcm_substream **rsubstream); | |
516 | void snd_pcm_detach_substream(struct snd_pcm_substream *substream); | |
1da177e4 | 517 | void snd_pcm_vma_notify_data(void *client, void *data); |
877211f5 | 518 | int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area); |
1da177e4 | 519 | |
acb03d44 EB |
520 | |
521 | #ifdef CONFIG_SND_DEBUG | |
522 | void snd_pcm_debug_name(struct snd_pcm_substream *substream, | |
523 | char *name, size_t len); | |
524 | #else | |
525 | static inline void | |
526 | snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size) | |
527 | { | |
528 | *buf = 0; | |
529 | } | |
530 | #endif | |
531 | ||
1da177e4 LT |
532 | /* |
533 | * PCM library | |
534 | */ | |
535 | ||
877211f5 | 536 | static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream) |
1da177e4 LT |
537 | { |
538 | return substream->group != &substream->self_group; | |
539 | } | |
540 | ||
877211f5 | 541 | static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream) |
1da177e4 LT |
542 | { |
543 | read_lock(&snd_pcm_link_rwlock); | |
544 | spin_lock(&substream->self_group.lock); | |
545 | } | |
546 | ||
877211f5 | 547 | static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream) |
1da177e4 LT |
548 | { |
549 | spin_unlock(&substream->self_group.lock); | |
550 | read_unlock(&snd_pcm_link_rwlock); | |
551 | } | |
552 | ||
877211f5 | 553 | static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream) |
1da177e4 LT |
554 | { |
555 | read_lock_irq(&snd_pcm_link_rwlock); | |
556 | spin_lock(&substream->self_group.lock); | |
557 | } | |
558 | ||
877211f5 | 559 | static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream) |
1da177e4 LT |
560 | { |
561 | spin_unlock(&substream->self_group.lock); | |
562 | read_unlock_irq(&snd_pcm_link_rwlock); | |
563 | } | |
564 | ||
565 | #define snd_pcm_stream_lock_irqsave(substream, flags) \ | |
566 | do { \ | |
567 | read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \ | |
568 | spin_lock(&substream->self_group.lock); \ | |
569 | } while (0) | |
570 | ||
571 | #define snd_pcm_stream_unlock_irqrestore(substream, flags) \ | |
572 | do { \ | |
573 | spin_unlock(&substream->self_group.lock); \ | |
574 | read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \ | |
575 | } while (0) | |
576 | ||
ef991b95 TI |
577 | #define snd_pcm_group_for_each_entry(s, substream) \ |
578 | list_for_each_entry(s, &substream->group->substreams, link_list) | |
1da177e4 | 579 | |
877211f5 | 580 | static inline int snd_pcm_running(struct snd_pcm_substream *substream) |
1da177e4 LT |
581 | { |
582 | return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING || | |
583 | (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING && | |
584 | substream->stream == SNDRV_PCM_STREAM_PLAYBACK)); | |
585 | } | |
586 | ||
877211f5 | 587 | static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size) |
1da177e4 LT |
588 | { |
589 | return size * 8 / runtime->sample_bits; | |
590 | } | |
591 | ||
877211f5 | 592 | static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size) |
1da177e4 LT |
593 | { |
594 | return size * 8 / runtime->frame_bits; | |
595 | } | |
596 | ||
877211f5 | 597 | static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size) |
1da177e4 LT |
598 | { |
599 | return size * runtime->sample_bits / 8; | |
600 | } | |
601 | ||
877211f5 | 602 | static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size) |
1da177e4 LT |
603 | { |
604 | return size * runtime->frame_bits / 8; | |
605 | } | |
606 | ||
877211f5 | 607 | static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes) |
1da177e4 LT |
608 | { |
609 | return bytes % runtime->byte_align == 0; | |
610 | } | |
611 | ||
877211f5 | 612 | static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream) |
1da177e4 | 613 | { |
877211f5 | 614 | struct snd_pcm_runtime *runtime = substream->runtime; |
1da177e4 LT |
615 | return frames_to_bytes(runtime, runtime->buffer_size); |
616 | } | |
617 | ||
877211f5 | 618 | static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream) |
1da177e4 | 619 | { |
877211f5 | 620 | struct snd_pcm_runtime *runtime = substream->runtime; |
1da177e4 LT |
621 | return frames_to_bytes(runtime, runtime->period_size); |
622 | } | |
623 | ||
624 | /* | |
625 | * result is: 0 ... (boundary - 1) | |
626 | */ | |
877211f5 | 627 | static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime) |
1da177e4 LT |
628 | { |
629 | snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr; | |
630 | if (avail < 0) | |
631 | avail += runtime->boundary; | |
632 | else if ((snd_pcm_uframes_t) avail >= runtime->boundary) | |
633 | avail -= runtime->boundary; | |
634 | return avail; | |
635 | } | |
636 | ||
637 | /* | |
638 | * result is: 0 ... (boundary - 1) | |
639 | */ | |
877211f5 | 640 | static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime) |
1da177e4 LT |
641 | { |
642 | snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr; | |
643 | if (avail < 0) | |
644 | avail += runtime->boundary; | |
645 | return avail; | |
646 | } | |
647 | ||
877211f5 | 648 | static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime) |
1da177e4 LT |
649 | { |
650 | return runtime->buffer_size - snd_pcm_playback_avail(runtime); | |
651 | } | |
652 | ||
877211f5 | 653 | static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime) |
1da177e4 LT |
654 | { |
655 | return runtime->buffer_size - snd_pcm_capture_avail(runtime); | |
656 | } | |
657 | ||
658 | /** | |
659 | * snd_pcm_playback_ready - check whether the playback buffer is available | |
660 | * @substream: the pcm substream instance | |
661 | * | |
662 | * Checks whether enough free space is available on the playback buffer. | |
663 | * | |
eb7c06e8 | 664 | * Return: Non-zero if available, or zero if not. |
1da177e4 | 665 | */ |
877211f5 | 666 | static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream) |
1da177e4 | 667 | { |
877211f5 | 668 | struct snd_pcm_runtime *runtime = substream->runtime; |
1da177e4 LT |
669 | return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min; |
670 | } | |
671 | ||
672 | /** | |
673 | * snd_pcm_capture_ready - check whether the capture buffer is available | |
674 | * @substream: the pcm substream instance | |
675 | * | |
676 | * Checks whether enough capture data is available on the capture buffer. | |
677 | * | |
eb7c06e8 | 678 | * Return: Non-zero if available, or zero if not. |
1da177e4 | 679 | */ |
877211f5 | 680 | static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream) |
1da177e4 | 681 | { |
877211f5 | 682 | struct snd_pcm_runtime *runtime = substream->runtime; |
1da177e4 LT |
683 | return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min; |
684 | } | |
685 | ||
686 | /** | |
687 | * snd_pcm_playback_data - check whether any data exists on the playback buffer | |
688 | * @substream: the pcm substream instance | |
689 | * | |
eb7c06e8 | 690 | * Checks whether any data exists on the playback buffer. |
1da177e4 | 691 | * |
eb7c06e8 YB |
692 | * Return: Non-zero if any data exists, or zero if not. If stop_threshold |
693 | * is bigger or equal to boundary, then this function returns always non-zero. | |
1da177e4 | 694 | */ |
877211f5 | 695 | static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream) |
1da177e4 | 696 | { |
877211f5 | 697 | struct snd_pcm_runtime *runtime = substream->runtime; |
1da177e4 LT |
698 | |
699 | if (runtime->stop_threshold >= runtime->boundary) | |
700 | return 1; | |
701 | return snd_pcm_playback_avail(runtime) < runtime->buffer_size; | |
702 | } | |
703 | ||
704 | /** | |
705 | * snd_pcm_playback_empty - check whether the playback buffer is empty | |
706 | * @substream: the pcm substream instance | |
707 | * | |
708 | * Checks whether the playback buffer is empty. | |
709 | * | |
eb7c06e8 | 710 | * Return: Non-zero if empty, or zero if not. |
1da177e4 | 711 | */ |
877211f5 | 712 | static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream) |
1da177e4 | 713 | { |
877211f5 | 714 | struct snd_pcm_runtime *runtime = substream->runtime; |
1da177e4 LT |
715 | return snd_pcm_playback_avail(runtime) >= runtime->buffer_size; |
716 | } | |
717 | ||
718 | /** | |
719 | * snd_pcm_capture_empty - check whether the capture buffer is empty | |
720 | * @substream: the pcm substream instance | |
721 | * | |
722 | * Checks whether the capture buffer is empty. | |
723 | * | |
eb7c06e8 | 724 | * Return: Non-zero if empty, or zero if not. |
1da177e4 | 725 | */ |
877211f5 | 726 | static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream) |
1da177e4 | 727 | { |
877211f5 | 728 | struct snd_pcm_runtime *runtime = substream->runtime; |
1da177e4 LT |
729 | return snd_pcm_capture_avail(runtime) == 0; |
730 | } | |
731 | ||
877211f5 TI |
732 | static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream, |
733 | struct snd_pcm_substream *master) | |
1da177e4 LT |
734 | { |
735 | substream->runtime->trigger_master = master; | |
736 | } | |
737 | ||
738 | static inline int hw_is_mask(int var) | |
739 | { | |
740 | return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK && | |
741 | var <= SNDRV_PCM_HW_PARAM_LAST_MASK; | |
742 | } | |
743 | ||
744 | static inline int hw_is_interval(int var) | |
745 | { | |
746 | return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL && | |
747 | var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; | |
748 | } | |
749 | ||
877211f5 | 750 | static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params, |
1da177e4 LT |
751 | snd_pcm_hw_param_t var) |
752 | { | |
753 | return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK]; | |
754 | } | |
755 | ||
877211f5 | 756 | static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params, |
1da177e4 LT |
757 | snd_pcm_hw_param_t var) |
758 | { | |
759 | return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL]; | |
760 | } | |
761 | ||
877211f5 | 762 | static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params, |
1da177e4 LT |
763 | snd_pcm_hw_param_t var) |
764 | { | |
b9f09a48 | 765 | return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK]; |
1da177e4 LT |
766 | } |
767 | ||
877211f5 | 768 | static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params, |
1da177e4 LT |
769 | snd_pcm_hw_param_t var) |
770 | { | |
b9f09a48 | 771 | return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL]; |
1da177e4 LT |
772 | } |
773 | ||
b51beb75 TI |
774 | #define params_channels(p) \ |
775 | (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min) | |
776 | #define params_rate(p) \ | |
777 | (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min) | |
778 | #define params_period_size(p) \ | |
779 | (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min) | |
780 | #define params_periods(p) \ | |
781 | (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min) | |
782 | #define params_buffer_size(p) \ | |
783 | (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min) | |
784 | #define params_buffer_bytes(p) \ | |
785 | (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min) | |
1da177e4 | 786 | |
877211f5 TI |
787 | int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v); |
788 | void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c); | |
789 | void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c); | |
790 | void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b, | |
791 | unsigned int k, struct snd_interval *c); | |
792 | void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k, | |
793 | const struct snd_interval *b, struct snd_interval *c); | |
4af87a93 MB |
794 | int snd_interval_list(struct snd_interval *i, unsigned int count, |
795 | const unsigned int *list, unsigned int mask); | |
877211f5 TI |
796 | int snd_interval_ratnum(struct snd_interval *i, |
797 | unsigned int rats_count, struct snd_ratnum *rats, | |
1da177e4 LT |
798 | unsigned int *nump, unsigned int *denp); |
799 | ||
877211f5 TI |
800 | void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params); |
801 | void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var); | |
877211f5 | 802 | int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params); |
1da177e4 | 803 | |
877211f5 | 804 | int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params); |
1da177e4 | 805 | |
877211f5 TI |
806 | int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream); |
807 | int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream); | |
1da177e4 | 808 | |
877211f5 | 809 | int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var, |
1da177e4 | 810 | u_int32_t mask); |
877211f5 | 811 | int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var, |
1da177e4 | 812 | u_int64_t mask); |
877211f5 | 813 | int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var, |
1da177e4 | 814 | unsigned int min, unsigned int max); |
877211f5 TI |
815 | int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var); |
816 | int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime, | |
1da177e4 LT |
817 | unsigned int cond, |
818 | snd_pcm_hw_param_t var, | |
1464189f | 819 | const struct snd_pcm_hw_constraint_list *l); |
877211f5 | 820 | int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime, |
1da177e4 LT |
821 | unsigned int cond, |
822 | snd_pcm_hw_param_t var, | |
877211f5 TI |
823 | struct snd_pcm_hw_constraint_ratnums *r); |
824 | int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime, | |
1da177e4 LT |
825 | unsigned int cond, |
826 | snd_pcm_hw_param_t var, | |
877211f5 TI |
827 | struct snd_pcm_hw_constraint_ratdens *r); |
828 | int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime, | |
1da177e4 LT |
829 | unsigned int cond, |
830 | unsigned int width, | |
831 | unsigned int msbits); | |
877211f5 | 832 | int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime, |
1da177e4 LT |
833 | unsigned int cond, |
834 | snd_pcm_hw_param_t var, | |
835 | unsigned long step); | |
877211f5 | 836 | int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime, |
1da177e4 LT |
837 | unsigned int cond, |
838 | snd_pcm_hw_param_t var); | |
d5b702a6 CL |
839 | int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime, |
840 | unsigned int base_rate); | |
877211f5 | 841 | int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime, |
1da177e4 LT |
842 | unsigned int cond, |
843 | int var, | |
844 | snd_pcm_hw_rule_func_t func, void *private, | |
845 | int dep, ...); | |
846 | ||
847 | int snd_pcm_format_signed(snd_pcm_format_t format); | |
848 | int snd_pcm_format_unsigned(snd_pcm_format_t format); | |
849 | int snd_pcm_format_linear(snd_pcm_format_t format); | |
850 | int snd_pcm_format_little_endian(snd_pcm_format_t format); | |
851 | int snd_pcm_format_big_endian(snd_pcm_format_t format); | |
1b44c28d TI |
852 | #if 0 /* just for DocBook */ |
853 | /** | |
9502dcad TI |
854 | * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian |
855 | * @format: the format to check | |
856 | * | |
eb7c06e8 | 857 | * Return: 1 if the given PCM format is CPU-endian, 0 if |
9502dcad TI |
858 | * opposite, or a negative error code if endian not specified. |
859 | */ | |
8cdfd251 | 860 | int snd_pcm_format_cpu_endian(snd_pcm_format_t format); |
1b44c28d | 861 | #endif /* DocBook */ |
9502dcad | 862 | #ifdef SNDRV_LITTLE_ENDIAN |
9d01a82e | 863 | #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format) |
9502dcad | 864 | #else |
9d01a82e | 865 | #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format) |
9502dcad | 866 | #endif |
1da177e4 LT |
867 | int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */ |
868 | int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */ | |
9502dcad | 869 | ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples); |
1da177e4 LT |
870 | const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format); |
871 | int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames); | |
872 | snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian); | |
1da177e4 | 873 | |
877211f5 TI |
874 | void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops); |
875 | void snd_pcm_set_sync(struct snd_pcm_substream *substream); | |
876 | int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream); | |
877 | int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream, | |
1da177e4 | 878 | unsigned int cmd, void *arg); |
1250932e JK |
879 | int snd_pcm_update_state(struct snd_pcm_substream *substream, |
880 | struct snd_pcm_runtime *runtime); | |
877211f5 TI |
881 | int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream); |
882 | int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream); | |
883 | int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream); | |
884 | int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream); | |
885 | int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream); | |
886 | void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr); | |
877211f5 TI |
887 | void snd_pcm_period_elapsed(struct snd_pcm_substream *substream); |
888 | snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream, | |
1da177e4 LT |
889 | const void __user *buf, |
890 | snd_pcm_uframes_t frames); | |
877211f5 | 891 | snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream, |
1da177e4 | 892 | void __user *buf, snd_pcm_uframes_t frames); |
877211f5 | 893 | snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream, |
1da177e4 | 894 | void __user **bufs, snd_pcm_uframes_t frames); |
877211f5 | 895 | snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream, |
1da177e4 LT |
896 | void __user **bufs, snd_pcm_uframes_t frames); |
897 | ||
7653d557 CL |
898 | extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates; |
899 | ||
877211f5 | 900 | int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime); |
918f3a0e | 901 | unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate); |
4be77a53 | 902 | unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit); |
1da177e4 | 903 | |
877211f5 | 904 | static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream, |
1da177e4 LT |
905 | struct snd_dma_buffer *bufp) |
906 | { | |
877211f5 | 907 | struct snd_pcm_runtime *runtime = substream->runtime; |
1da177e4 LT |
908 | if (bufp) { |
909 | runtime->dma_buffer_p = bufp; | |
910 | runtime->dma_area = bufp->area; | |
911 | runtime->dma_addr = bufp->addr; | |
912 | runtime->dma_bytes = bufp->bytes; | |
913 | } else { | |
914 | runtime->dma_buffer_p = NULL; | |
915 | runtime->dma_area = NULL; | |
916 | runtime->dma_addr = 0; | |
917 | runtime->dma_bytes = 0; | |
918 | } | |
919 | } | |
920 | ||
921 | /* | |
922 | * Timer interface | |
923 | */ | |
924 | ||
877211f5 TI |
925 | void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream); |
926 | void snd_pcm_timer_init(struct snd_pcm_substream *substream); | |
927 | void snd_pcm_timer_done(struct snd_pcm_substream *substream); | |
1da177e4 | 928 | |
b751eef1 JK |
929 | static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime, |
930 | struct timespec *tv) | |
931 | { | |
932 | if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC) | |
933 | do_posix_clock_monotonic_gettime(tv); | |
934 | else | |
935 | getnstimeofday(tv); | |
936 | } | |
937 | ||
1da177e4 LT |
938 | /* |
939 | * Memory | |
940 | */ | |
941 | ||
877211f5 TI |
942 | int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream); |
943 | int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm); | |
944 | int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream, | |
1da177e4 LT |
945 | int type, struct device *data, |
946 | size_t size, size_t max); | |
877211f5 | 947 | int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm, |
1da177e4 LT |
948 | int type, void *data, |
949 | size_t size, size_t max); | |
877211f5 TI |
950 | int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size); |
951 | int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream); | |
1da177e4 | 952 | |
681b84e1 CL |
953 | int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream, |
954 | size_t size, gfp_t gfp_flags); | |
955 | int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream); | |
956 | struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream, | |
957 | unsigned long offset); | |
958 | #if 0 /* for kernel-doc */ | |
959 | /** | |
960 | * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer | |
961 | * @substream: the substream to allocate the buffer to | |
962 | * @size: the requested buffer size, in bytes | |
963 | * | |
964 | * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is | |
965 | * contiguous in kernel virtual space, but not in physical memory. Use this | |
966 | * if the buffer is accessed by kernel code but not by device DMA. | |
967 | * | |
eb7c06e8 | 968 | * Return: 1 if the buffer was changed, 0 if not changed, or a negative error |
681b84e1 CL |
969 | * code. |
970 | */ | |
971 | static int snd_pcm_lib_alloc_vmalloc_buffer | |
972 | (struct snd_pcm_substream *substream, size_t size); | |
973 | /** | |
974 | * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer | |
975 | * @substream: the substream to allocate the buffer to | |
976 | * @size: the requested buffer size, in bytes | |
977 | * | |
978 | * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses | |
979 | * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory. | |
eb7c06e8 YB |
980 | * |
981 | * Return: 1 if the buffer was changed, 0 if not changed, or a negative error | |
982 | * code. | |
681b84e1 CL |
983 | */ |
984 | static int snd_pcm_lib_alloc_vmalloc_32_buffer | |
985 | (struct snd_pcm_substream *substream, size_t size); | |
986 | #endif | |
987 | #define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \ | |
988 | _snd_pcm_lib_alloc_vmalloc_buffer \ | |
989 | (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO) | |
990 | #define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \ | |
991 | _snd_pcm_lib_alloc_vmalloc_buffer \ | |
992 | (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO) | |
993 | ||
9d069dc0 TI |
994 | #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p) |
995 | ||
cc6a8acd | 996 | #ifdef CONFIG_SND_DMA_SGBUF |
77a23f26 TI |
997 | /* |
998 | * SG-buffer handling | |
999 | */ | |
1000 | #define snd_pcm_substream_sgbuf(substream) \ | |
9d069dc0 | 1001 | snd_pcm_get_dma_buf(substream)->private_data |
77a23f26 TI |
1002 | |
1003 | struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, | |
1004 | unsigned long offset); | |
cc6a8acd TI |
1005 | #else /* !SND_DMA_SGBUF */ |
1006 | /* | |
1007 | * fake using a continuous buffer | |
1008 | */ | |
9d069dc0 TI |
1009 | #define snd_pcm_sgbuf_ops_page NULL |
1010 | #endif /* SND_DMA_SGBUF */ | |
1011 | ||
cc6a8acd TI |
1012 | static inline dma_addr_t |
1013 | snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs) | |
1014 | { | |
9d069dc0 | 1015 | return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs); |
cc6a8acd TI |
1016 | } |
1017 | ||
1018 | static inline void * | |
1019 | snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs) | |
1020 | { | |
9d069dc0 | 1021 | return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs); |
cc6a8acd TI |
1022 | } |
1023 | ||
9d069dc0 TI |
1024 | static inline unsigned int |
1025 | snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream, | |
1026 | unsigned int ofs, unsigned int size) | |
1027 | { | |
1028 | return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size); | |
1029 | } | |
cc6a8acd | 1030 | |
1da177e4 LT |
1031 | /* handle mmap counter - PCM mmap callback should handle this counter properly */ |
1032 | static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area) | |
1033 | { | |
877211f5 | 1034 | struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data; |
9c323fcb | 1035 | atomic_inc(&substream->mmap_count); |
1da177e4 LT |
1036 | } |
1037 | ||
1038 | static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area) | |
1039 | { | |
877211f5 | 1040 | struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data; |
9c323fcb | 1041 | atomic_dec(&substream->mmap_count); |
1da177e4 LT |
1042 | } |
1043 | ||
18a2b962 TI |
1044 | int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream, |
1045 | struct vm_area_struct *area); | |
1da177e4 LT |
1046 | /* mmap for io-memory area */ |
1047 | #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA) | |
1048 | #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP | |
877211f5 | 1049 | int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area); |
1da177e4 LT |
1050 | #else |
1051 | #define SNDRV_PCM_INFO_MMAP_IOMEM 0 | |
1052 | #define snd_pcm_lib_mmap_iomem NULL | |
1053 | #endif | |
1054 | ||
3674f19d | 1055 | #define snd_pcm_lib_mmap_vmalloc NULL |
c32d977b | 1056 | |
1da177e4 LT |
1057 | static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max) |
1058 | { | |
1059 | *max = dma < 4 ? 64 * 1024 : 128 * 1024; | |
1060 | } | |
1061 | ||
1062 | /* | |
1063 | * Misc | |
1064 | */ | |
1065 | ||
1066 | #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\ | |
1067 | (IEC958_AES1_CON_ORIGINAL<<8)|\ | |
1068 | (IEC958_AES1_CON_PCM_CODER<<8)|\ | |
1069 | (IEC958_AES3_CON_FS_48000<<24)) | |
1070 | ||
7eaa943c TI |
1071 | #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime) |
1072 | ||
6e5265ec TI |
1073 | const char *snd_pcm_format_name(snd_pcm_format_t format); |
1074 | ||
1aad779f | 1075 | /** |
8513915a RD |
1076 | * snd_pcm_stream_str - Get a string naming the direction of a stream |
1077 | * @substream: the pcm substream instance | |
eb7c06e8 YB |
1078 | * |
1079 | * Return: A string naming the direction of the stream. | |
1aad779f OL |
1080 | */ |
1081 | static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream) | |
1082 | { | |
1083 | if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) | |
1084 | return "Playback"; | |
1085 | else | |
1086 | return "Capture"; | |
1087 | } | |
1088 | ||
2d3391ec TI |
1089 | /* |
1090 | * PCM channel-mapping control API | |
1091 | */ | |
1092 | /* array element of channel maps */ | |
1093 | struct snd_pcm_chmap_elem { | |
1094 | unsigned char channels; | |
1095 | unsigned char map[15]; | |
1096 | }; | |
1097 | ||
1098 | /* channel map information; retrieved via snd_kcontrol_chip() */ | |
1099 | struct snd_pcm_chmap { | |
1100 | struct snd_pcm *pcm; /* assigned PCM instance */ | |
1101 | int stream; /* PLAYBACK or CAPTURE */ | |
1102 | struct snd_kcontrol *kctl; | |
1103 | const struct snd_pcm_chmap_elem *chmap; | |
1104 | unsigned int max_channels; | |
1105 | unsigned int channel_mask; /* optional: active channels bitmask */ | |
1106 | void *private_data; /* optional: private data pointer */ | |
1107 | }; | |
1108 | ||
1109 | /* get the PCM substream assigned to the given chmap info */ | |
1110 | static inline struct snd_pcm_substream * | |
1111 | snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx) | |
1112 | { | |
1113 | struct snd_pcm_substream *s; | |
1114 | for (s = info->pcm->streams[info->stream].substream; s; s = s->next) | |
1115 | if (s->number == idx) | |
1116 | return s; | |
1117 | return NULL; | |
1118 | } | |
1119 | ||
1120 | /* ALSA-standard channel maps (RL/RR prior to C/LFE) */ | |
1121 | extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[]; | |
1122 | /* Other world's standard channel maps (C/LFE prior to RL/RR) */ | |
1123 | extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[]; | |
1124 | ||
1125 | /* bit masks to be passed to snd_pcm_chmap.channel_mask field */ | |
1126 | #define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4)) | |
1127 | #define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6)) | |
1128 | #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8)) | |
1129 | ||
1130 | int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream, | |
1131 | const struct snd_pcm_chmap_elem *chmap, | |
1132 | int max_channels, | |
1133 | unsigned long private_value, | |
1134 | struct snd_pcm_chmap **info_ret); | |
1135 | ||
1da177e4 | 1136 | #endif /* __SOUND_PCM_H */ |