]> bbs.cooldavid.org Git - net-next-2.6.git/blame - sound/usb/format.c
Merge branch 'for-linus' of git://oss.sgi.com/xfs/xfs
[net-next-2.6.git] / sound / usb / format.c
CommitLineData
e5779998
DM
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15 *
16 */
17
18#include <linux/init.h>
36db0456 19#include <linux/slab.h>
e5779998
DM
20#include <linux/usb.h>
21#include <linux/usb/audio.h>
7e847894 22#include <linux/usb/audio-v2.h>
e5779998
DM
23
24#include <sound/core.h>
25#include <sound/pcm.h>
26
27#include "usbaudio.h"
28#include "card.h"
29#include "quirks.h"
30#include "helper.h"
31#include "debug.h"
79f920fb 32#include "clock.h"
e5779998
DM
33
34/*
35 * parse the audio format type I descriptor
36 * and returns the corresponding pcm format
37 *
38 * @dev: usb device
39 * @fp: audioformat record
40 * @format: the format tag (wFormatTag)
41 * @fmt: the format type descriptor
42 */
29088fef 43static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
e5779998
DM
44 struct audioformat *fp,
45 int format, void *_fmt,
46 int protocol)
47{
e5779998 48 int sample_width, sample_bytes;
29088fef 49 u64 pcm_formats;
e5779998
DM
50
51 switch (protocol) {
52 case UAC_VERSION_1: {
53 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
54 sample_width = fmt->bBitResolution;
55 sample_bytes = fmt->bSubframeSize;
29088fef 56 format = 1 << format;
e5779998
DM
57 break;
58 }
59
60 case UAC_VERSION_2: {
61 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
62 sample_width = fmt->bBitResolution;
63 sample_bytes = fmt->bSubslotSize;
29088fef 64 format <<= 1;
e5779998
DM
65 break;
66 }
67
68 default:
69 return -EINVAL;
70 }
71
29088fef 72 pcm_formats = 0;
e5779998 73
29088fef
CL
74 if (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED)) {
75 /* some devices don't define this correctly... */
e5779998
DM
76 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
77 chip->dev->devnum, fp->iface, fp->altsetting);
29088fef
CL
78 format = 1 << UAC_FORMAT_TYPE_I_PCM;
79 }
80 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
e5779998
DM
81 if (sample_width > sample_bytes * 8) {
82 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
83 chip->dev->devnum, fp->iface, fp->altsetting,
84 sample_width, sample_bytes);
85 }
86 /* check the format byte size */
87 switch (sample_bytes) {
88 case 1:
29088fef 89 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
e5779998
DM
90 break;
91 case 2:
92 if (snd_usb_is_big_endian_format(chip, fp))
29088fef 93 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
e5779998 94 else
29088fef 95 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
e5779998
DM
96 break;
97 case 3:
98 if (snd_usb_is_big_endian_format(chip, fp))
29088fef 99 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
e5779998 100 else
29088fef 101 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
e5779998
DM
102 break;
103 case 4:
29088fef 104 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
e5779998
DM
105 break;
106 default:
107 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
108 chip->dev->devnum, fp->iface, fp->altsetting,
109 sample_width, sample_bytes);
110 break;
111 }
29088fef
CL
112 }
113 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
e5779998
DM
114 /* Dallas DS4201 workaround: it advertises U8 format, but really
115 supports S8. */
116 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
29088fef
CL
117 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
118 else
119 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
120 }
121 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
122 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
123 }
124 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
125 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
126 }
127 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
128 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
129 }
130 if (format & ~0x3f) {
131 snd_printk(KERN_INFO "%d:%u:%d : unsupported format bits %#x\n",
e5779998 132 chip->dev->devnum, fp->iface, fp->altsetting, format);
e5779998 133 }
29088fef 134 return pcm_formats;
e5779998
DM
135}
136
137
138/*
139 * parse the format descriptor and stores the possible sample rates
140 * on the audioformat table (audio class v1).
141 *
142 * @dev: usb device
143 * @fp: audioformat record
144 * @fmt: the format descriptor
145 * @offset: the start offset of descriptor pointing the rate type
146 * (7 for type I and II, 8 for type II)
147 */
148static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
149 unsigned char *fmt, int offset)
150{
151 int nr_rates = fmt[offset];
152
153 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
154 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
155 chip->dev->devnum, fp->iface, fp->altsetting);
156 return -1;
157 }
158
159 if (nr_rates) {
160 /*
161 * build the rate table and bitmap flags
162 */
163 int r, idx;
164
165 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
166 if (fp->rate_table == NULL) {
167 snd_printk(KERN_ERR "cannot malloc\n");
168 return -1;
169 }
170
171 fp->nr_rates = 0;
172 fp->rate_min = fp->rate_max = 0;
173 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
174 unsigned int rate = combine_triple(&fmt[idx]);
175 if (!rate)
176 continue;
177 /* C-Media CM6501 mislabels its 96 kHz altsetting */
178 if (rate == 48000 && nr_rates == 1 &&
179 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
180 chip->usb_id == USB_ID(0x0d8c, 0x0102)) &&
181 fp->altsetting == 5 && fp->maxpacksize == 392)
182 rate = 96000;
183 /* Creative VF0470 Live Cam reports 16 kHz instead of 8kHz */
184 if (rate == 16000 && chip->usb_id == USB_ID(0x041e, 0x4068))
185 rate = 8000;
186
187 fp->rate_table[fp->nr_rates] = rate;
188 if (!fp->rate_min || rate < fp->rate_min)
189 fp->rate_min = rate;
190 if (!fp->rate_max || rate > fp->rate_max)
191 fp->rate_max = rate;
192 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
193 fp->nr_rates++;
194 }
195 if (!fp->nr_rates) {
196 hwc_debug("All rates were zero. Skipping format!\n");
197 return -1;
198 }
199 } else {
200 /* continuous rates */
201 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
202 fp->rate_min = combine_triple(&fmt[offset + 1]);
203 fp->rate_max = combine_triple(&fmt[offset + 4]);
204 }
205 return 0;
206}
207
208/*
209 * parse the format descriptor and stores the possible sample rates
210 * on the audioformat table (audio class v2).
211 */
212static int parse_audio_format_rates_v2(struct snd_usb_audio *chip,
213 struct audioformat *fp,
214 struct usb_host_interface *iface)
215{
216 struct usb_device *dev = chip->dev;
217 unsigned char tmp[2], *data;
218 int i, nr_rates, data_size, ret = 0;
79f920fb 219 int clock = snd_usb_clock_find_source(chip, chip->ctrl_intf, fp->clock);
e5779998
DM
220
221 /* get the number of sample rates first by only fetching 2 bytes */
222 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
223 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
79f920fb 224 UAC2_CS_CONTROL_SAM_FREQ << 8, clock << 8,
45d76056 225 tmp, sizeof(tmp), 1000);
e5779998
DM
226
227 if (ret < 0) {
79f920fb
DM
228 snd_printk(KERN_ERR "%s(): unable to retrieve number of sample rates (clock %d)\n",
229 __func__, clock);
e5779998
DM
230 goto err;
231 }
232
233 nr_rates = (tmp[1] << 8) | tmp[0];
234 data_size = 2 + 12 * nr_rates;
235 data = kzalloc(data_size, GFP_KERNEL);
236 if (!data) {
237 ret = -ENOMEM;
238 goto err;
239 }
240
241 /* now get the full information */
242 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
79f920fb
DM
243 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
244 UAC2_CS_CONTROL_SAM_FREQ << 8, clock << 8,
245 data, data_size, 1000);
e5779998
DM
246
247 if (ret < 0) {
79f920fb
DM
248 snd_printk(KERN_ERR "%s(): unable to retrieve sample rate range (clock %d)\n",
249 __func__, clock);
e5779998
DM
250 ret = -EINVAL;
251 goto err_free;
252 }
253
254 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
255 if (!fp->rate_table) {
256 ret = -ENOMEM;
257 goto err_free;
258 }
259
260 fp->nr_rates = 0;
261 fp->rate_min = fp->rate_max = 0;
262
263 for (i = 0; i < nr_rates; i++) {
264 int rate = combine_quad(&data[2 + 12 * i]);
265
266 fp->rate_table[fp->nr_rates] = rate;
267 if (!fp->rate_min || rate < fp->rate_min)
268 fp->rate_min = rate;
269 if (!fp->rate_max || rate > fp->rate_max)
270 fp->rate_max = rate;
271 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
272 fp->nr_rates++;
273 }
274
275err_free:
276 kfree(data);
277err:
278 return ret;
279}
280
281/*
282 * parse the format type I and III descriptors
283 */
284static int parse_audio_format_i(struct snd_usb_audio *chip,
74754f97
DM
285 struct audioformat *fp, int format,
286 struct uac_format_type_i_continuous_descriptor *fmt,
e5779998
DM
287 struct usb_host_interface *iface)
288{
289 struct usb_interface_descriptor *altsd = get_iface_desc(iface);
e5779998
DM
290 int protocol = altsd->bInterfaceProtocol;
291 int pcm_format, ret;
292
293 if (fmt->bFormatType == UAC_FORMAT_TYPE_III) {
294 /* FIXME: the format type is really IECxxx
295 * but we give normal PCM format to get the existing
296 * apps working...
297 */
298 switch (chip->usb_id) {
299
300 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
301 if (chip->setup == 0x00 &&
302 fp->altsetting == 6)
303 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
304 else
305 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
306 break;
307 default:
308 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
309 }
29088fef 310 fp->formats = 1uLL << pcm_format;
e5779998 311 } else {
29088fef
CL
312 fp->formats = parse_audio_format_i_type(chip, fp, format,
313 fmt, protocol);
314 if (!fp->formats)
e5779998
DM
315 return -1;
316 }
317
e5779998
DM
318 /* gather possible sample rates */
319 /* audio class v1 reports possible sample rates as part of the
320 * proprietary class specific descriptor.
321 * audio class v2 uses class specific EP0 range requests for that.
322 */
323 switch (protocol) {
324 case UAC_VERSION_1:
325 fp->channels = fmt->bNrChannels;
74754f97 326 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
e5779998
DM
327 break;
328 case UAC_VERSION_2:
329 /* fp->channels is already set in this case */
330 ret = parse_audio_format_rates_v2(chip, fp, iface);
331 break;
332 }
333
334 if (fp->channels < 1) {
335 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
336 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
337 return -1;
338 }
339
340 return ret;
341}
342
343/*
344 * parse the format type II descriptor
345 */
346static int parse_audio_format_ii(struct snd_usb_audio *chip,
347 struct audioformat *fp,
348 int format, void *_fmt,
349 struct usb_host_interface *iface)
350{
351 int brate, framesize, ret;
352 struct usb_interface_descriptor *altsd = get_iface_desc(iface);
353 int protocol = altsd->bInterfaceProtocol;
354
355 switch (format) {
356 case UAC_FORMAT_TYPE_II_AC3:
357 /* FIXME: there is no AC3 format defined yet */
015eb0b0
CL
358 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
359 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
e5779998
DM
360 break;
361 case UAC_FORMAT_TYPE_II_MPEG:
015eb0b0 362 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
e5779998
DM
363 break;
364 default:
365 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag %#x is detected. processed as MPEG.\n",
366 chip->dev->devnum, fp->iface, fp->altsetting, format);
015eb0b0 367 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
e5779998
DM
368 break;
369 }
370
371 fp->channels = 1;
372
373 switch (protocol) {
374 case UAC_VERSION_1: {
375 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
376 brate = le16_to_cpu(fmt->wMaxBitRate);
377 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
378 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
379 fp->frame_size = framesize;
380 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
381 break;
382 }
383 case UAC_VERSION_2: {
384 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
385 brate = le16_to_cpu(fmt->wMaxBitRate);
386 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
387 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
388 fp->frame_size = framesize;
389 ret = parse_audio_format_rates_v2(chip, fp, iface);
390 break;
391 }
392 }
393
394 return ret;
395}
396
397int snd_usb_parse_audio_format(struct snd_usb_audio *chip, struct audioformat *fp,
74754f97
DM
398 int format, struct uac_format_type_i_continuous_descriptor *fmt,
399 int stream, struct usb_host_interface *iface)
e5779998
DM
400{
401 int err;
402
74754f97 403 switch (fmt->bFormatType) {
e5779998
DM
404 case UAC_FORMAT_TYPE_I:
405 case UAC_FORMAT_TYPE_III:
406 err = parse_audio_format_i(chip, fp, format, fmt, iface);
407 break;
408 case UAC_FORMAT_TYPE_II:
409 err = parse_audio_format_ii(chip, fp, format, fmt, iface);
410 break;
411 default:
412 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
74754f97
DM
413 chip->dev->devnum, fp->iface, fp->altsetting,
414 fmt->bFormatType);
8d091242 415 return -ENOTSUPP;
e5779998 416 }
74754f97 417 fp->fmt_type = fmt->bFormatType;
e5779998
DM
418 if (err < 0)
419 return err;
420#if 1
421 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
422 /* extigy apparently supports sample rates other than 48k
423 * but not in ordinary way. so we enable only 48k atm.
424 */
425 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
426 chip->usb_id == USB_ID(0x041e, 0x3020) ||
427 chip->usb_id == USB_ID(0x041e, 0x3061)) {
74754f97 428 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
e5779998
DM
429 fp->rates != SNDRV_PCM_RATE_48000 &&
430 fp->rates != SNDRV_PCM_RATE_96000)
8d091242 431 return -ENOTSUPP;
e5779998
DM
432 }
433#endif
434 return 0;
435}
436