sound/usb/format.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  */
   4
   5 #include <linux/init.h>
   6 #include <linux/slab.h>
   7 #include <linux/usb.h>
   8 #include <linux/usb/audio.h>
   9 #include <linux/usb/audio-v2.h>
  10 #include <linux/usb/audio-v3.h>
  11
  12 #include <sound/core.h>
  13 #include <sound/pcm.h>
  14
  15 #include "usbaudio.h"
  16 #include "card.h"
  17 #include "quirks.h"
  18 #include "helper.h"
  19 #include "clock.h"
  20 #include "format.h"
  21
  22 /*
  23  * parse the audio format type I descriptor
  24  * and returns the corresponding pcm format
  25  *
  26  * @dev: usb device
  27  * @fp: audioformat record
  28  * @format: the format tag (wFormatTag)
  29  * @fmt: the format type descriptor (v1/v2) or AudioStreaming descriptor (v3)
  30  */
  31 static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
  32                                      struct audioformat *fp,
  33                                      u64 format, void *_fmt)
  34 {
  35         int sample_width, sample_bytes;
  36         u64 pcm_formats = 0;
  37
  38         switch (fp->protocol) {
  39         case UAC_VERSION_1:
  40         default: {
  41                 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
  42                 if (format >= 64)
  43                         return 0; /* invalid format */
  44                 sample_width = fmt->bBitResolution;
  45                 sample_bytes = fmt->bSubframeSize;
  46                 format = 1ULL << format;
  47                 break;
  48         }
  49
  50         case UAC_VERSION_2: {
  51                 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
  52                 sample_width = fmt->bBitResolution;
  53                 sample_bytes = fmt->bSubslotSize;
  54
  55                 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
  56                         pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
  57                         /* flag potentially raw DSD capable altsettings */
  58                         fp->dsd_raw = true;
  59                 }
  60
  61                 format <<= 1;
  62                 break;
  63         }
  64         case UAC_VERSION_3: {
  65                 struct uac3_as_header_descriptor *as = _fmt;
  66
  67                 sample_width = as->bBitResolution;
  68                 sample_bytes = as->bSubslotSize;
  69
  70                 if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
  71                         pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
  72
  73                 format <<= 1;
  74                 break;
  75         }
  76         }
  77
  78         fp->fmt_bits = sample_width;
  79
  80         if ((pcm_formats == 0) &&
  81             (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
  82                 /* some devices don't define this correctly... */
  83                 usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
  84                         fp->iface, fp->altsetting);
  85                 format = 1 << UAC_FORMAT_TYPE_I_PCM;
  86         }
  87         if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
  88                 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
  89                      /* Edirol SD-90 */
  90                      (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
  91                      /* Roland SC-D70 */
  92                     sample_width == 24 && sample_bytes == 2)
  93                         sample_bytes = 3;
  94                 else if (sample_width > sample_bytes * 8) {
  95                         usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
  96                                  fp->iface, fp->altsetting,
  97                                  sample_width, sample_bytes);
  98                 }
  99                 /* check the format byte size */
 100                 switch (sample_bytes) {
 101                 case 1:
 102                         pcm_formats |= SNDRV_PCM_FMTBIT_S8;
 103                         break;
 104                 case 2:
 105                         if (snd_usb_is_big_endian_format(chip, fp))
 106                                 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
 107                         else
 108                                 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
 109                         break;
 110                 case 3:
 111                         if (snd_usb_is_big_endian_format(chip, fp))
 112                                 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
 113                         else
 114                                 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
 115                         break;
 116                 case 4:
 117                         pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
 118                         break;
 119                 default:
 120                         usb_audio_info(chip,
 121                                  "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
 122                                  fp->iface, fp->altsetting,
 123                                  sample_width, sample_bytes);
 124                         break;
 125                 }
 126         }
 127         if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
 128                 /* Dallas DS4201 workaround: it advertises U8 format, but really
 129                    supports S8. */
 130                 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
 131                         pcm_formats |= SNDRV_PCM_FMTBIT_S8;
 132                 else
 133                         pcm_formats |= SNDRV_PCM_FMTBIT_U8;
 134         }
 135         if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
 136                 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
 137         }
 138         if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
 139                 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
 140         }
 141         if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
 142                 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
 143         }
 144         if (format & ~0x3f) {
 145                 usb_audio_info(chip,
 146                          "%u:%d : unsupported format bits %#llx\n",
 147                          fp->iface, fp->altsetting, format);
 148         }
 149
 150         pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
 151
 152         return pcm_formats;
 153 }
 154
 155 static int set_fixed_rate(struct audioformat *fp, int rate, int rate_bits)
 156 {
 157         kfree(fp->rate_table);
 158         fp->rate_table = kmalloc(sizeof(int), GFP_KERNEL);
 159         if (!fp->rate_table)
 160                 return -ENOMEM;
 161         fp->nr_rates = 1;
 162         fp->rate_min = rate;
 163         fp->rate_max = rate;
 164         fp->rates = rate_bits;
 165         fp->rate_table[0] = rate;
 166         return 0;
 167 }
 168
 169 /* set up rate_min, rate_max and rates from the rate table */
 170 static void set_rate_table_min_max(struct audioformat *fp)
 171 {
 172         unsigned int rate;
 173         int i;
 174
 175         fp->rate_min = INT_MAX;
 176         fp->rate_max = 0;
 177         fp->rates = 0;
 178         for (i = 0; i < fp->nr_rates; i++) {
 179                 rate = fp->rate_table[i];
 180                 fp->rate_min = min(fp->rate_min, rate);
 181                 fp->rate_max = max(fp->rate_max, rate);
 182                 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
 183         }
 184 }
 185
 186 /*
 187  * parse the format descriptor and stores the possible sample rates
 188  * on the audioformat table (audio class v1).
 189  *
 190  * @dev: usb device
 191  * @fp: audioformat record
 192  * @fmt: the format descriptor
 193  * @offset: the start offset of descriptor pointing the rate type
 194  *          (7 for type I and II, 8 for type II)
 195  */
 196 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
 197                                        unsigned char *fmt, int offset)
 198 {
 199         int nr_rates = fmt[offset];
 200
 201         if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
 202                 usb_audio_err(chip,
 203                         "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
 204                         fp->iface, fp->altsetting);
 205                 return -EINVAL;
 206         }
 207
 208         if (nr_rates) {
 209                 /*
 210                  * build the rate table and bitmap flags
 211                  */
 212                 int r, idx;
 213
 214                 fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
 215                                                GFP_KERNEL);
 216                 if (fp->rate_table == NULL)
 217                         return -ENOMEM;
 218
 219                 fp->nr_rates = 0;
 220                 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
 221                         unsigned int rate = combine_triple(&fmt[idx]);
 222                         if (!rate)
 223                                 continue;
 224                         /* C-Media CM6501 mislabels its 96 kHz altsetting */
 225                         /* Terratec Aureon 7.1 USB C-Media 6206, too */
 226                         if (rate == 48000 && nr_rates == 1 &&
 227                             (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
 228                              chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
 229                              chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
 230                             fp->altsetting == 5 && fp->maxpacksize == 392)
 231                                 rate = 96000;
 232                         /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
 233                         if (rate == 16000 &&
 234                             (chip->usb_id == USB_ID(0x041e, 0x4064) ||
 235                              chip->usb_id == USB_ID(0x041e, 0x4068)))
 236                                 rate = 8000;
 237
 238                         fp->rate_table[fp->nr_rates++] = rate;
 239                 }
 240                 if (!fp->nr_rates) {
 241                         usb_audio_info(chip,
 242                                        "%u:%d: All rates were zero\n",
 243                                        fp->iface, fp->altsetting);
 244                         return -EINVAL;
 245                 }
 246                 set_rate_table_min_max(fp);
 247         } else {
 248                 /* continuous rates */
 249                 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
 250                 fp->rate_min = combine_triple(&fmt[offset + 1]);
 251                 fp->rate_max = combine_triple(&fmt[offset + 4]);
 252         }
 253
 254         /* Jabra Evolve 65 headset */
 255         if (chip->usb_id == USB_ID(0x0b0e, 0x030b)) {
 256                 /* only 48kHz for playback while keeping 16kHz for capture */
 257                 if (fp->nr_rates != 1)
 258                         return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
 259         }
 260
 261         return 0;
 262 }
 263
 264
 265 /*
 266  * Presonus Studio 1810c supports a limited set of sampling
 267  * rates per altsetting but reports the full set each time.
 268  * If we don't filter out the unsupported rates and attempt
 269  * to configure the card, it will hang refusing to do any
 270  * further audio I/O until a hard reset is performed.
 271  *
 272  * The list of supported rates per altsetting (set of available
 273  * I/O channels) is described in the owner's manual, section 2.2.
 274  */
 275 static bool s1810c_valid_sample_rate(struct audioformat *fp,
 276                                      unsigned int rate)
 277 {
 278         switch (fp->altsetting) {
 279         case 1:
 280                 /* All ADAT ports available */
 281                 return rate <= 48000;
 282         case 2:
 283                 /* Half of ADAT ports available */
 284                 return (rate == 88200 || rate == 96000);
 285         case 3:
 286                 /* Analog I/O only (no S/PDIF nor ADAT) */
 287                 return rate >= 176400;
 288         default:
 289                 return false;
 290         }
 291         return false;
 292 }
 293
 294 /*
 295  * Many Focusrite devices supports a limited set of sampling rates per
 296  * altsetting. Maximum rate is exposed in the last 4 bytes of Format Type
 297  * descriptor which has a non-standard bLength = 10.
 298  */
 299 static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
 300                                         struct audioformat *fp,
 301                                         unsigned int rate)
 302 {
 303         struct usb_interface *iface;
 304         struct usb_host_interface *alts;
 305         unsigned char *fmt;
 306         unsigned int max_rate;
 307
 308         iface = usb_ifnum_to_if(chip->dev, fp->iface);
 309         if (!iface)
 310                 return true;
 311
 312         alts = &iface->altsetting[fp->altset_idx];
 313         fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
 314                                       NULL, UAC_FORMAT_TYPE);
 315         if (!fmt)
 316                 return true;
 317
 318         if (fmt[0] == 10) { /* bLength */
 319                 max_rate = combine_quad(&fmt[6]);
 320
 321                 /* Validate max rate */
 322                 if (max_rate != 48000 &&
 323                     max_rate != 96000 &&
 324                     max_rate != 192000 &&
 325                     max_rate != 384000) {
 326
 327                         usb_audio_info(chip,
 328                                 "%u:%d : unexpected max rate: %u\n",
 329                                 fp->iface, fp->altsetting, max_rate);
 330
 331                         return true;
 332                 }
 333
 334                 return rate <= max_rate;
 335         }
 336
 337         return true;
 338 }
 339
 340 /*
 341  * Helper function to walk the array of sample rate triplets reported by
 342  * the device. The problem is that we need to parse whole array first to
 343  * get to know how many sample rates we have to expect.
 344  * Then fp->rate_table can be allocated and filled.
 345  */
 346 static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
 347                                         struct audioformat *fp, int nr_triplets,
 348                                         const unsigned char *data)
 349 {
 350         int i, nr_rates = 0;
 351
 352         for (i = 0; i < nr_triplets; i++) {
 353                 int min = combine_quad(&data[2 + 12 * i]);
 354                 int max = combine_quad(&data[6 + 12 * i]);
 355                 int res = combine_quad(&data[10 + 12 * i]);
 356                 unsigned int rate;
 357
 358                 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
 359                         continue;
 360
 361                 /*
 362                  * for ranges with res == 1, we announce a continuous sample
 363                  * rate range, and this function should return 0 for no further
 364                  * parsing.
 365                  */
 366                 if (res == 1) {
 367                         fp->rate_min = min;
 368                         fp->rate_max = max;
 369                         fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
 370                         return 0;
 371                 }
 372
 373                 for (rate = min; rate <= max; rate += res) {
 374
 375                         /* Filter out invalid rates on Presonus Studio 1810c */
 376                         if (chip->usb_id == USB_ID(0x0194f, 0x010c) &&
 377                             !s1810c_valid_sample_rate(fp, rate))
 378                                 goto skip_rate;
 379
 380                         /* Filter out invalid rates on Focusrite devices */
 381                         if (USB_ID_VENDOR(chip->usb_id) == 0x1235 &&
 382                             !focusrite_valid_sample_rate(chip, fp, rate))
 383                                 goto skip_rate;
 384
 385                         if (fp->rate_table)
 386                                 fp->rate_table[nr_rates] = rate;
 387                         nr_rates++;
 388                         if (nr_rates >= MAX_NR_RATES) {
 389                                 usb_audio_err(chip, "invalid uac2 rates\n");
 390                                 break;
 391                         }
 392
 393 skip_rate:
 394                         /* avoid endless loop */
 395                         if (res == 0)
 396                                 break;
 397                 }
 398         }
 399
 400         return nr_rates;
 401 }
 402
 403 /* Line6 Helix series and the Rode Rodecaster Pro don't support the
 404  * UAC2_CS_RANGE usb function call. Return a static table of known
 405  * clock rates.
 406  */
 407 static int line6_parse_audio_format_rates_quirk(struct snd_usb_audio *chip,
 408                                                 struct audioformat *fp)
 409 {
 410         switch (chip->usb_id) {
 411         case USB_ID(0x0e41, 0x4241): /* Line6 Helix */
 412         case USB_ID(0x0e41, 0x4242): /* Line6 Helix Rack */
 413         case USB_ID(0x0e41, 0x4244): /* Line6 Helix LT */
 414         case USB_ID(0x0e41, 0x4246): /* Line6 HX-Stomp */
 415         case USB_ID(0x0e41, 0x4247): /* Line6 Pod Go */
 416         case USB_ID(0x0e41, 0x4248): /* Line6 Helix >= fw 2.82 */
 417         case USB_ID(0x0e41, 0x4249): /* Line6 Helix Rack >= fw 2.82 */
 418         case USB_ID(0x0e41, 0x424a): /* Line6 Helix LT >= fw 2.82 */
 419         case USB_ID(0x19f7, 0x0011): /* Rode Rodecaster Pro */
 420                 return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
 421         }
 422
 423         return -ENODEV;
 424 }
 425
 426 /* check whether the given altsetting is supported for the already set rate */
 427 static bool check_valid_altsetting_v2v3(struct snd_usb_audio *chip, int iface,
 428                                         int altsetting)
 429 {
 430         struct usb_device *dev = chip->dev;
 431         __le64 raw_data = 0;
 432         u64 data;
 433         int err;
 434
 435         /* we assume 64bit is enough for any altsettings */
 436         if (snd_BUG_ON(altsetting >= 64 - 8))
 437                 return false;
 438
 439         err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
 440                               USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
 441                               UAC2_AS_VAL_ALT_SETTINGS << 8,
 442                               iface, &raw_data, sizeof(raw_data));
 443         if (err < 0)
 444                 return false;
 445
 446         data = le64_to_cpu(raw_data);
 447         /* first byte contains the bitmap size */
 448         if ((data & 0xff) * 8 < altsetting)
 449                 return false;
 450         if (data & (1ULL << (altsetting + 8)))
 451                 return true;
 452
 453         return false;
 454 }
 455
 456 /*
 457  * Validate each sample rate with the altsetting
 458  * Rebuild the rate table if only partial values are valid
 459  */
 460 static int validate_sample_rate_table_v2v3(struct snd_usb_audio *chip,
 461                                            struct audioformat *fp,
 462                                            int clock)
 463 {
 464         struct usb_device *dev = chip->dev;
 465         unsigned int *table;
 466         unsigned int nr_rates;
 467         int i, err;
 468
 469         table = kcalloc(fp->nr_rates, sizeof(*table), GFP_KERNEL);
 470         if (!table)
 471                 return -ENOMEM;
 472
 473         /* clear the interface altsetting at first */
 474         usb_set_interface(dev, fp->iface, 0);
 475
 476         nr_rates = 0;
 477         for (i = 0; i < fp->nr_rates; i++) {
 478                 err = snd_usb_set_sample_rate_v2v3(chip, fp, clock,
 479                                                    fp->rate_table[i]);
 480                 if (err < 0)
 481                         continue;
 482
 483                 if (check_valid_altsetting_v2v3(chip, fp->iface, fp->altsetting))
 484                         table[nr_rates++] = fp->rate_table[i];
 485         }
 486
 487         if (!nr_rates) {
 488                 usb_audio_dbg(chip,
 489                               "No valid sample rate available for %d:%d, assuming a firmware bug\n",
 490                               fp->iface, fp->altsetting);
 491                 nr_rates = fp->nr_rates; /* continue as is */
 492         }
 493
 494         if (fp->nr_rates == nr_rates) {
 495                 kfree(table);
 496                 return 0;
 497         }
 498
 499         kfree(fp->rate_table);
 500         fp->rate_table = table;
 501         fp->nr_rates = nr_rates;
 502         return 0;
 503 }
 504
 505 /*
 506  * parse the format descriptor and stores the possible sample rates
 507  * on the audioformat table (audio class v2 and v3).
 508  */
 509 static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
 510                                        struct audioformat *fp)
 511 {
 512         struct usb_device *dev = chip->dev;
 513         unsigned char tmp[2], *data;
 514         int nr_triplets, data_size, ret = 0, ret_l6;
 515         int clock = snd_usb_clock_find_source(chip, fp, false);
 516
 517         if (clock < 0) {
 518                 dev_err(&dev->dev,
 519                         "%s(): unable to find clock source (clock %d)\n",
 520                                 __func__, clock);
 521                 goto err;
 522         }
 523
 524         /* get the number of sample rates first by only fetching 2 bytes */
 525         ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
 526                               USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
 527                               UAC2_CS_CONTROL_SAM_FREQ << 8,
 528                               snd_usb_ctrl_intf(chip) | (clock << 8),
 529                               tmp, sizeof(tmp));
 530
 531         if (ret < 0) {
 532                 /* line6 helix devices don't support UAC2_CS_CONTROL_SAM_FREQ call */
 533                 ret_l6 = line6_parse_audio_format_rates_quirk(chip, fp);
 534                 if (ret_l6 == -ENODEV) {
 535                         /* no line6 device found continue showing the error */
 536                         dev_err(&dev->dev,
 537                                 "%s(): unable to retrieve number of sample rates (clock %d)\n",
 538                                 __func__, clock);
 539                         goto err;
 540                 }
 541                 if (ret_l6 == 0) {
 542                         dev_info(&dev->dev,
 543                                 "%s(): unable to retrieve number of sample rates: set it to a predefined value (clock %d).\n",
 544                                 __func__, clock);
 545                         return 0;
 546                 }
 547                 ret = ret_l6;
 548                 goto err;
 549         }
 550
 551         nr_triplets = (tmp[1] << 8) | tmp[0];
 552         data_size = 2 + 12 * nr_triplets;
 553         data = kzalloc(data_size, GFP_KERNEL);
 554         if (!data) {
 555                 ret = -ENOMEM;
 556                 goto err;
 557         }
 558
 559         /* now get the full information */
 560         ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
 561                               USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
 562                               UAC2_CS_CONTROL_SAM_FREQ << 8,
 563                               snd_usb_ctrl_intf(chip) | (clock << 8),
 564                               data, data_size);
 565
 566         if (ret < 0) {
 567                 dev_err(&dev->dev,
 568                         "%s(): unable to retrieve sample rate range (clock %d)\n",
 569                                 __func__, clock);
 570                 ret = -EINVAL;
 571                 goto err_free;
 572         }
 573
 574         /* Call the triplet parser, and make sure fp->rate_table is NULL.
 575          * We just use the return value to know how many sample rates we
 576          * will have to deal with. */
 577         kfree(fp->rate_table);
 578         fp->rate_table = NULL;
 579         fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
 580
 581         if (fp->nr_rates == 0) {
 582                 /* SNDRV_PCM_RATE_CONTINUOUS */
 583                 ret = 0;
 584                 goto err_free;
 585         }
 586
 587         fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
 588         if (!fp->rate_table) {
 589                 ret = -ENOMEM;
 590                 goto err_free;
 591         }
 592
 593         /* Call the triplet parser again, but this time, fp->rate_table is
 594          * allocated, so the rates will be stored */
 595         parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
 596
 597         ret = validate_sample_rate_table_v2v3(chip, fp, clock);
 598         if (ret < 0)
 599                 goto err_free;
 600
 601         set_rate_table_min_max(fp);
 602
 603 err_free:
 604         kfree(data);
 605 err:
 606         return ret;
 607 }
 608
 609 /*
 610  * parse the format type I and III descriptors
 611  */
 612 static int parse_audio_format_i(struct snd_usb_audio *chip,
 613                                 struct audioformat *fp, u64 format,
 614                                 void *_fmt)
 615 {
 616         snd_pcm_format_t pcm_format;
 617         unsigned int fmt_type;
 618         int ret;
 619
 620         switch (fp->protocol) {
 621         default:
 622         case UAC_VERSION_1:
 623         case UAC_VERSION_2: {
 624                 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
 625
 626                 fmt_type = fmt->bFormatType;
 627                 break;
 628         }
 629         case UAC_VERSION_3: {
 630                 /* fp->fmt_type is already set in this case */
 631                 fmt_type = fp->fmt_type;
 632                 break;
 633         }
 634         }
 635
 636         if (fmt_type == UAC_FORMAT_TYPE_III) {
 637                 /* FIXME: the format type is really IECxxx
 638                  *        but we give normal PCM format to get the existing
 639                  *        apps working...
 640                  */
 641                 switch (chip->usb_id) {
 642
 643                 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
 644                         if (chip->setup == 0x00 &&
 645                             fp->altsetting == 6)
 646                                 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
 647                         else
 648                                 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
 649                         break;
 650                 default:
 651                         pcm_format = SNDRV_PCM_FORMAT_S16_LE;
 652                 }
 653                 fp->formats = pcm_format_to_bits(pcm_format);
 654         } else {
 655                 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
 656                 if (!fp->formats)
 657                         return -EINVAL;
 658         }
 659
 660         /* gather possible sample rates */
 661         /* audio class v1 reports possible sample rates as part of the
 662          * proprietary class specific descriptor.
 663          * audio class v2 uses class specific EP0 range requests for that.
 664          */
 665         switch (fp->protocol) {
 666         default:
 667         case UAC_VERSION_1: {
 668                 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
 669
 670                 fp->channels = fmt->bNrChannels;
 671                 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
 672                 break;
 673         }
 674         case UAC_VERSION_2:
 675         case UAC_VERSION_3: {
 676                 /* fp->channels is already set in this case */
 677                 ret = parse_audio_format_rates_v2v3(chip, fp);
 678                 break;
 679         }
 680         }
 681
 682         if (fp->channels < 1) {
 683                 usb_audio_err(chip,
 684                         "%u:%d : invalid channels %d\n",
 685                         fp->iface, fp->altsetting, fp->channels);
 686                 return -EINVAL;
 687         }
 688
 689         return ret;
 690 }
 691
 692 /*
 693  * parse the format type II descriptor
 694  */
 695 static int parse_audio_format_ii(struct snd_usb_audio *chip,
 696                                  struct audioformat *fp,
 697                                  u64 format, void *_fmt)
 698 {
 699         int brate, framesize, ret;
 700
 701         switch (format) {
 702         case UAC_FORMAT_TYPE_II_AC3:
 703                 /* FIXME: there is no AC3 format defined yet */
 704                 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
 705                 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
 706                 break;
 707         case UAC_FORMAT_TYPE_II_MPEG:
 708                 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
 709                 break;
 710         default:
 711                 usb_audio_info(chip,
 712                          "%u:%d : unknown format tag %#llx is detected.  processed as MPEG.\n",
 713                          fp->iface, fp->altsetting, format);
 714                 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
 715                 break;
 716         }
 717
 718         fp->channels = 1;
 719
 720         switch (fp->protocol) {
 721         default:
 722         case UAC_VERSION_1: {
 723                 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
 724                 brate = le16_to_cpu(fmt->wMaxBitRate);
 725                 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
 726                 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
 727                 fp->frame_size = framesize;
 728                 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
 729                 break;
 730         }
 731         case UAC_VERSION_2: {
 732                 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
 733                 brate = le16_to_cpu(fmt->wMaxBitRate);
 734                 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
 735                 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
 736                 fp->frame_size = framesize;
 737                 ret = parse_audio_format_rates_v2v3(chip, fp);
 738                 break;
 739         }
 740         }
 741
 742         return ret;
 743 }
 744
 745 int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
 746                                struct audioformat *fp, u64 format,
 747                                struct uac_format_type_i_continuous_descriptor *fmt,
 748                                int stream)
 749 {
 750         int err;
 751
 752         switch (fmt->bFormatType) {
 753         case UAC_FORMAT_TYPE_I:
 754         case UAC_FORMAT_TYPE_III:
 755                 err = parse_audio_format_i(chip, fp, format, fmt);
 756                 break;
 757         case UAC_FORMAT_TYPE_II:
 758                 err = parse_audio_format_ii(chip, fp, format, fmt);
 759                 break;
 760         default:
 761                 usb_audio_info(chip,
 762                          "%u:%d : format type %d is not supported yet\n",
 763                          fp->iface, fp->altsetting,
 764                          fmt->bFormatType);
 765                 return -ENOTSUPP;
 766         }
 767         fp->fmt_type = fmt->bFormatType;
 768         if (err < 0)
 769                 return err;
 770 #if 1
 771         /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
 772         /* extigy apparently supports sample rates other than 48k
 773          * but not in ordinary way.  so we enable only 48k atm.
 774          */
 775         if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
 776             chip->usb_id == USB_ID(0x041e, 0x3020) ||
 777             chip->usb_id == USB_ID(0x041e, 0x3061)) {
 778                 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
 779                     fp->rates != SNDRV_PCM_RATE_48000 &&
 780                     fp->rates != SNDRV_PCM_RATE_96000)
 781                         return -ENOTSUPP;
 782         }
 783 #endif
 784         return 0;
 785 }
 786
 787 int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
 788                                struct audioformat *fp,
 789                                struct uac3_as_header_descriptor *as,
 790                                int stream)
 791 {
 792         u64 format = le64_to_cpu(as->bmFormats);
 793         int err;
 794
 795         /*
 796          * Type I format bits are D0..D6
 797          * This test works because type IV is not supported
 798          */
 799         if (format & 0x7f)
 800                 fp->fmt_type = UAC_FORMAT_TYPE_I;
 801         else
 802                 fp->fmt_type = UAC_FORMAT_TYPE_III;
 803
 804         err = parse_audio_format_i(chip, fp, format, as);
 805         if (err < 0)
 806                 return err;
 807
 808         return 0;
 809 }