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