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>
19 #include <linux/slab.h>
20 #include <linux/usb.h>
21 #include <linux/usb/audio.h>
22 #include <linux/usb/audio-v2.h>
23 #include <linux/usb/audio-v3.h>
24
25 #include <sound/core.h>
26 #include <sound/pcm.h>
27
28 #include "usbaudio.h"
29 #include "card.h"
30 #include "quirks.h"
31 #include "helper.h"
32 #include "debug.h"
33 #include "clock.h"
34 #include "format.h"
35
36 /*
37 * parse the audio format type I descriptor
38 * and returns the corresponding pcm format
39 *
40 * @dev: usb device
41 * @fp: audioformat record
42 * @format: the format tag (wFormatTag)
43 * @fmt: the format type descriptor (v1/v2) or AudioStreaming descriptor (v3)
44 */
parse_audio_format_i_type(struct snd_usb_audio * chip,struct audioformat * fp,u64 format,void * _fmt)45 static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
46 struct audioformat *fp,
47 u64 format, void *_fmt)
48 {
49 int sample_width, sample_bytes;
50 u64 pcm_formats = 0;
51
52 switch (fp->protocol) {
53 case UAC_VERSION_1:
54 default: {
55 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
56 sample_width = fmt->bBitResolution;
57 sample_bytes = fmt->bSubframeSize;
58 format = 1ULL << format;
59 break;
60 }
61
62 case UAC_VERSION_2: {
63 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
64 sample_width = fmt->bBitResolution;
65 sample_bytes = fmt->bSubslotSize;
66
67 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
68 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
69 /* flag potentially raw DSD capable altsettings */
70 fp->dsd_raw = true;
71 }
72
73 format <<= 1;
74 break;
75 }
76 case UAC_VERSION_3: {
77 struct uac3_as_header_descriptor *as = _fmt;
78
79 sample_width = as->bBitResolution;
80 sample_bytes = as->bSubslotSize;
81
82 if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
83 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
84
85 format <<= 1;
86 break;
87 }
88 }
89
90 if ((pcm_formats == 0) &&
91 (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
92 /* some devices don't define this correctly... */
93 usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
94 fp->iface, fp->altsetting);
95 format = 1 << UAC_FORMAT_TYPE_I_PCM;
96 }
97 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
98 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
99 /* Edirol SD-90 */
100 (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
101 /* Roland SC-D70 */
102 sample_width == 24 && sample_bytes == 2)
103 sample_bytes = 3;
104 else if (sample_width > sample_bytes * 8) {
105 usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
106 fp->iface, fp->altsetting,
107 sample_width, sample_bytes);
108 }
109 /* check the format byte size */
110 switch (sample_bytes) {
111 case 1:
112 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
113 break;
114 case 2:
115 if (snd_usb_is_big_endian_format(chip, fp))
116 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
117 else
118 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
119 break;
120 case 3:
121 if (snd_usb_is_big_endian_format(chip, fp))
122 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
123 else
124 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
125 break;
126 case 4:
127 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
128 break;
129 default:
130 usb_audio_info(chip,
131 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
132 fp->iface, fp->altsetting,
133 sample_width, sample_bytes);
134 break;
135 }
136 }
137 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
138 /* Dallas DS4201 workaround: it advertises U8 format, but really
139 supports S8. */
140 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
141 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
142 else
143 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
144 }
145 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
146 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
147 }
148 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
149 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
150 }
151 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
152 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
153 }
154 if (format & ~0x3f) {
155 usb_audio_info(chip,
156 "%u:%d : unsupported format bits %#llx\n",
157 fp->iface, fp->altsetting, format);
158 }
159
160 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
161
162 return pcm_formats;
163 }
164
165
166 /*
167 * parse the format descriptor and stores the possible sample rates
168 * on the audioformat table (audio class v1).
169 *
170 * @dev: usb device
171 * @fp: audioformat record
172 * @fmt: the format descriptor
173 * @offset: the start offset of descriptor pointing the rate type
174 * (7 for type I and II, 8 for type II)
175 */
parse_audio_format_rates_v1(struct snd_usb_audio * chip,struct audioformat * fp,unsigned char * fmt,int offset)176 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
177 unsigned char *fmt, int offset)
178 {
179 int nr_rates = fmt[offset];
180
181 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
182 usb_audio_err(chip,
183 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
184 fp->iface, fp->altsetting);
185 return -EINVAL;
186 }
187
188 if (nr_rates) {
189 /*
190 * build the rate table and bitmap flags
191 */
192 int r, idx;
193
194 fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
195 GFP_KERNEL);
196 if (fp->rate_table == NULL)
197 return -ENOMEM;
198
199 fp->nr_rates = 0;
200 fp->rate_min = fp->rate_max = 0;
201 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
202 unsigned int rate = combine_triple(&fmt[idx]);
203 if (!rate)
204 continue;
205 /* C-Media CM6501 mislabels its 96 kHz altsetting */
206 /* Terratec Aureon 7.1 USB C-Media 6206, too */
207 if (rate == 48000 && nr_rates == 1 &&
208 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
209 chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
210 chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
211 fp->altsetting == 5 && fp->maxpacksize == 392)
212 rate = 96000;
213 /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
214 if (rate == 16000 &&
215 (chip->usb_id == USB_ID(0x041e, 0x4064) ||
216 chip->usb_id == USB_ID(0x041e, 0x4068)))
217 rate = 8000;
218
219 fp->rate_table[fp->nr_rates] = rate;
220 if (!fp->rate_min || rate < fp->rate_min)
221 fp->rate_min = rate;
222 if (!fp->rate_max || rate > fp->rate_max)
223 fp->rate_max = rate;
224 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
225 fp->nr_rates++;
226 }
227 if (!fp->nr_rates) {
228 hwc_debug("All rates were zero. Skipping format!\n");
229 return -EINVAL;
230 }
231 } else {
232 /* continuous rates */
233 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
234 fp->rate_min = combine_triple(&fmt[offset + 1]);
235 fp->rate_max = combine_triple(&fmt[offset + 4]);
236 }
237 return 0;
238 }
239
240 /*
241 * Helper function to walk the array of sample rate triplets reported by
242 * the device. The problem is that we need to parse whole array first to
243 * get to know how many sample rates we have to expect.
244 * Then fp->rate_table can be allocated and filled.
245 */
parse_uac2_sample_rate_range(struct snd_usb_audio * chip,struct audioformat * fp,int nr_triplets,const unsigned char * data)246 static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
247 struct audioformat *fp, int nr_triplets,
248 const unsigned char *data)
249 {
250 int i, nr_rates = 0;
251
252 fp->rates = fp->rate_min = fp->rate_max = 0;
253
254 for (i = 0; i < nr_triplets; i++) {
255 int min = combine_quad(&data[2 + 12 * i]);
256 int max = combine_quad(&data[6 + 12 * i]);
257 int res = combine_quad(&data[10 + 12 * i]);
258 unsigned int rate;
259
260 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
261 continue;
262
263 /*
264 * for ranges with res == 1, we announce a continuous sample
265 * rate range, and this function should return 0 for no further
266 * parsing.
267 */
268 if (res == 1) {
269 fp->rate_min = min;
270 fp->rate_max = max;
271 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
272 return 0;
273 }
274
275 for (rate = min; rate <= max; rate += res) {
276 if (fp->rate_table)
277 fp->rate_table[nr_rates] = rate;
278 if (!fp->rate_min || rate < fp->rate_min)
279 fp->rate_min = rate;
280 if (!fp->rate_max || rate > fp->rate_max)
281 fp->rate_max = rate;
282 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
283
284 nr_rates++;
285 if (nr_rates >= MAX_NR_RATES) {
286 usb_audio_err(chip, "invalid uac2 rates\n");
287 break;
288 }
289
290 /* avoid endless loop */
291 if (res == 0)
292 break;
293 }
294 }
295
296 return nr_rates;
297 }
298
299 /*
300 * parse the format descriptor and stores the possible sample rates
301 * on the audioformat table (audio class v2 and v3).
302 */
parse_audio_format_rates_v2v3(struct snd_usb_audio * chip,struct audioformat * fp)303 static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
304 struct audioformat *fp)
305 {
306 struct usb_device *dev = chip->dev;
307 unsigned char tmp[2], *data;
308 int nr_triplets, data_size, ret = 0;
309 int clock = snd_usb_clock_find_source(chip, fp->protocol,
310 fp->clock, false);
311
312 if (clock < 0) {
313 dev_err(&dev->dev,
314 "%s(): unable to find clock source (clock %d)\n",
315 __func__, clock);
316 goto err;
317 }
318
319 /* get the number of sample rates first by only fetching 2 bytes */
320 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
321 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
322 UAC2_CS_CONTROL_SAM_FREQ << 8,
323 snd_usb_ctrl_intf(chip) | (clock << 8),
324 tmp, sizeof(tmp));
325
326 if (ret < 0) {
327 dev_err(&dev->dev,
328 "%s(): unable to retrieve number of sample rates (clock %d)\n",
329 __func__, clock);
330 goto err;
331 }
332
333 nr_triplets = (tmp[1] << 8) | tmp[0];
334 data_size = 2 + 12 * nr_triplets;
335 data = kzalloc(data_size, GFP_KERNEL);
336 if (!data) {
337 ret = -ENOMEM;
338 goto err;
339 }
340
341 /* now get the full information */
342 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
343 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
344 UAC2_CS_CONTROL_SAM_FREQ << 8,
345 snd_usb_ctrl_intf(chip) | (clock << 8),
346 data, data_size);
347
348 if (ret < 0) {
349 dev_err(&dev->dev,
350 "%s(): unable to retrieve sample rate range (clock %d)\n",
351 __func__, clock);
352 ret = -EINVAL;
353 goto err_free;
354 }
355
356 /* Call the triplet parser, and make sure fp->rate_table is NULL.
357 * We just use the return value to know how many sample rates we
358 * will have to deal with. */
359 kfree(fp->rate_table);
360 fp->rate_table = NULL;
361 fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
362
363 if (fp->nr_rates == 0) {
364 /* SNDRV_PCM_RATE_CONTINUOUS */
365 ret = 0;
366 goto err_free;
367 }
368
369 fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
370 if (!fp->rate_table) {
371 ret = -ENOMEM;
372 goto err_free;
373 }
374
375 /* Call the triplet parser again, but this time, fp->rate_table is
376 * allocated, so the rates will be stored */
377 parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
378
379 err_free:
380 kfree(data);
381 err:
382 return ret;
383 }
384
385 /*
386 * parse the format type I and III descriptors
387 */
parse_audio_format_i(struct snd_usb_audio * chip,struct audioformat * fp,u64 format,void * _fmt)388 static int parse_audio_format_i(struct snd_usb_audio *chip,
389 struct audioformat *fp, u64 format,
390 void *_fmt)
391 {
392 snd_pcm_format_t pcm_format;
393 unsigned int fmt_type;
394 int ret;
395
396 switch (fp->protocol) {
397 default:
398 case UAC_VERSION_1:
399 case UAC_VERSION_2: {
400 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
401
402 fmt_type = fmt->bFormatType;
403 break;
404 }
405 case UAC_VERSION_3: {
406 /* fp->fmt_type is already set in this case */
407 fmt_type = fp->fmt_type;
408 break;
409 }
410 }
411
412 if (fmt_type == UAC_FORMAT_TYPE_III) {
413 /* FIXME: the format type is really IECxxx
414 * but we give normal PCM format to get the existing
415 * apps working...
416 */
417 switch (chip->usb_id) {
418
419 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
420 if (chip->setup == 0x00 &&
421 fp->altsetting == 6)
422 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
423 else
424 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
425 break;
426 default:
427 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
428 }
429 fp->formats = pcm_format_to_bits(pcm_format);
430 } else {
431 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
432 if (!fp->formats)
433 return -EINVAL;
434 }
435
436 /* gather possible sample rates */
437 /* audio class v1 reports possible sample rates as part of the
438 * proprietary class specific descriptor.
439 * audio class v2 uses class specific EP0 range requests for that.
440 */
441 switch (fp->protocol) {
442 default:
443 case UAC_VERSION_1: {
444 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
445
446 fp->channels = fmt->bNrChannels;
447 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
448 break;
449 }
450 case UAC_VERSION_2:
451 case UAC_VERSION_3: {
452 /* fp->channels is already set in this case */
453 ret = parse_audio_format_rates_v2v3(chip, fp);
454 break;
455 }
456 }
457
458 if (fp->channels < 1) {
459 usb_audio_err(chip,
460 "%u:%d : invalid channels %d\n",
461 fp->iface, fp->altsetting, fp->channels);
462 return -EINVAL;
463 }
464
465 return ret;
466 }
467
468 /*
469 * parse the format type II descriptor
470 */
parse_audio_format_ii(struct snd_usb_audio * chip,struct audioformat * fp,u64 format,void * _fmt)471 static int parse_audio_format_ii(struct snd_usb_audio *chip,
472 struct audioformat *fp,
473 u64 format, void *_fmt)
474 {
475 int brate, framesize, ret;
476
477 switch (format) {
478 case UAC_FORMAT_TYPE_II_AC3:
479 /* FIXME: there is no AC3 format defined yet */
480 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
481 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
482 break;
483 case UAC_FORMAT_TYPE_II_MPEG:
484 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
485 break;
486 default:
487 usb_audio_info(chip,
488 "%u:%d : unknown format tag %#llx is detected. processed as MPEG.\n",
489 fp->iface, fp->altsetting, format);
490 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
491 break;
492 }
493
494 fp->channels = 1;
495
496 switch (fp->protocol) {
497 default:
498 case UAC_VERSION_1: {
499 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
500 brate = le16_to_cpu(fmt->wMaxBitRate);
501 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
502 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
503 fp->frame_size = framesize;
504 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
505 break;
506 }
507 case UAC_VERSION_2: {
508 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
509 brate = le16_to_cpu(fmt->wMaxBitRate);
510 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
511 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
512 fp->frame_size = framesize;
513 ret = parse_audio_format_rates_v2v3(chip, fp);
514 break;
515 }
516 }
517
518 return ret;
519 }
520
snd_usb_parse_audio_format(struct snd_usb_audio * chip,struct audioformat * fp,u64 format,struct uac_format_type_i_continuous_descriptor * fmt,int stream)521 int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
522 struct audioformat *fp, u64 format,
523 struct uac_format_type_i_continuous_descriptor *fmt,
524 int stream)
525 {
526 int err;
527
528 switch (fmt->bFormatType) {
529 case UAC_FORMAT_TYPE_I:
530 case UAC_FORMAT_TYPE_III:
531 err = parse_audio_format_i(chip, fp, format, fmt);
532 break;
533 case UAC_FORMAT_TYPE_II:
534 err = parse_audio_format_ii(chip, fp, format, fmt);
535 break;
536 default:
537 usb_audio_info(chip,
538 "%u:%d : format type %d is not supported yet\n",
539 fp->iface, fp->altsetting,
540 fmt->bFormatType);
541 return -ENOTSUPP;
542 }
543 fp->fmt_type = fmt->bFormatType;
544 if (err < 0)
545 return err;
546 #if 1
547 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
548 /* extigy apparently supports sample rates other than 48k
549 * but not in ordinary way. so we enable only 48k atm.
550 */
551 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
552 chip->usb_id == USB_ID(0x041e, 0x3020) ||
553 chip->usb_id == USB_ID(0x041e, 0x3061)) {
554 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
555 fp->rates != SNDRV_PCM_RATE_48000 &&
556 fp->rates != SNDRV_PCM_RATE_96000)
557 return -ENOTSUPP;
558 }
559 #endif
560 return 0;
561 }
562
snd_usb_parse_audio_format_v3(struct snd_usb_audio * chip,struct audioformat * fp,struct uac3_as_header_descriptor * as,int stream)563 int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
564 struct audioformat *fp,
565 struct uac3_as_header_descriptor *as,
566 int stream)
567 {
568 u64 format = le64_to_cpu(as->bmFormats);
569 int err;
570
571 /*
572 * Type I format bits are D0..D6
573 * This test works because type IV is not supported
574 */
575 if (format & 0x7f)
576 fp->fmt_type = UAC_FORMAT_TYPE_I;
577 else
578 fp->fmt_type = UAC_FORMAT_TYPE_III;
579
580 err = parse_audio_format_i(chip, fp, format, as);
581 if (err < 0)
582 return err;
583
584 return 0;
585 }
586
