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
  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"
  32 #include "clock.h"
  33 #include "format.h"
  34
  35 /*
  36  * parse the audio format type I descriptor
  37  * and returns the corresponding pcm format
  38  *
  39  * @dev: usb device
  40  * @fp: audioformat record
  41  * @format: the format tag (wFormatTag)
  42  * @fmt: the format type descriptor
  43  */
  44 static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
  45                                      struct audioformat *fp,
  46                                      unsigned int format, void *_fmt)
  47 {
  48         int sample_width, sample_bytes;
  49         u64 pcm_formats = 0;
  50
  51         switch (fp->protocol) {
  52         case UAC_VERSION_1:
  53         default: {
  54                 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
  55                 if (format >= 64) {
  56                         usb_audio_info(chip,
  57                                        "%u:%d: invalid format type %#x is detected, processed as PCM\n",
  58                                        fp->iface, fp->altsetting, format);
  59                         format = UAC_FORMAT_TYPE_I_PCM;
  60                 }
  61                 sample_width = fmt->bBitResolution;
  62                 sample_bytes = fmt->bSubframeSize;
  63                 format = 1 << format;
  64                 break;
  65         }
  66
  67         case UAC_VERSION_2: {
  68                 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
  69                 sample_width = fmt->bBitResolution;
  70                 sample_bytes = fmt->bSubslotSize;
  71
  72                 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA)
  73                         pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
  74
  75                 format <<= 1;
  76                 break;
  77         }
  78         }
  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 %#x\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
 156 /*
 157  * parse the format descriptor and stores the possible sample rates
 158  * on the audioformat table (audio class v1).
 159  *
 160  * @dev: usb device
 161  * @fp: audioformat record
 162  * @fmt: the format descriptor
 163  * @offset: the start offset of descriptor pointing the rate type
 164  *          (7 for type I and II, 8 for type II)
 165  */
 166 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
 167                                        unsigned char *fmt, int offset)
 168 {
 169         int nr_rates = fmt[offset];
 170
 171         if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
 172                 usb_audio_err(chip,
 173                         "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
 174                         fp->iface, fp->altsetting);
 175                 return -EINVAL;
 176         }
 177
 178         if (nr_rates) {
 179                 /*
 180                  * build the rate table and bitmap flags
 181                  */
 182                 int r, idx;
 183
 184                 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
 185                 if (fp->rate_table == NULL)
 186                         return -ENOMEM;
 187
 188                 fp->nr_rates = 0;
 189                 fp->rate_min = fp->rate_max = 0;
 190                 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
 191                         unsigned int rate = combine_triple(&fmt[idx]);
 192                         if (!rate)
 193                                 continue;
 194                         /* C-Media CM6501 mislabels its 96 kHz altsetting */
 195                         /* Terratec Aureon 7.1 USB C-Media 6206, too */
 196                         /* Ozone Z90 USB C-Media, too */
 197                         if (rate == 48000 && nr_rates == 1 &&
 198                             (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
 199                              chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
 200                              chip->usb_id == USB_ID(0x0d8c, 0x0078) ||
 201                              chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
 202                             fp->altsetting == 5 && fp->maxpacksize == 392)
 203                                 rate = 96000;
 204                         /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
 205                         if (rate == 16000 &&
 206                             (chip->usb_id == USB_ID(0x041e, 0x4064) ||
 207                              chip->usb_id == USB_ID(0x041e, 0x4068)))
 208                                 rate = 8000;
 209
 210                         fp->rate_table[fp->nr_rates] = rate;
 211                         if (!fp->rate_min || rate < fp->rate_min)
 212                                 fp->rate_min = rate;
 213                         if (!fp->rate_max || rate > fp->rate_max)
 214                                 fp->rate_max = rate;
 215                         fp->rates |= snd_pcm_rate_to_rate_bit(rate);
 216                         fp->nr_rates++;
 217                 }
 218                 if (!fp->nr_rates) {
 219                         hwc_debug("All rates were zero. Skipping format!\n");
 220                         return -EINVAL;
 221                 }
 222         } else {
 223                 /* continuous rates */
 224                 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
 225                 fp->rate_min = combine_triple(&fmt[offset + 1]);
 226                 fp->rate_max = combine_triple(&fmt[offset + 4]);
 227         }
 228         return 0;
 229 }
 230
 231 /*
 232  * Many Focusrite devices supports a limited set of sampling rates per
 233  * altsetting. Maximum rate is exposed in the last 4 bytes of Format Type
 234  * descriptor which has a non-standard bLength = 10.
 235  */
 236 static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
 237                                         struct audioformat *fp,
 238                                         unsigned int rate)
 239 {
 240         struct usb_interface *iface;
 241         struct usb_host_interface *alts;
 242         unsigned char *fmt;
 243         unsigned int max_rate;
 244
 245         iface = usb_ifnum_to_if(chip->dev, fp->iface);
 246         if (!iface)
 247                 return true;
 248
 249         alts = &iface->altsetting[fp->altset_idx];
 250         fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
 251                                       NULL, UAC_FORMAT_TYPE);
 252         if (!fmt)
 253                 return true;
 254
 255         if (fmt[0] == 10) { /* bLength */
 256                 max_rate = combine_quad(&fmt[6]);
 257
 258                 /* Validate max rate */
 259                 if (max_rate != 48000 &&
 260                     max_rate != 96000 &&
 261                     max_rate != 192000 &&
 262                     max_rate != 384000) {
 263
 264                         usb_audio_info(chip,
 265                                 "%u:%d : unexpected max rate: %u\n",
 266                                 fp->iface, fp->altsetting, max_rate);
 267
 268                         return true;
 269                 }
 270
 271                 return rate <= max_rate;
 272         }
 273
 274         return true;
 275 }
 276
 277 /*
 278  * Helper function to walk the array of sample rate triplets reported by
 279  * the device. The problem is that we need to parse whole array first to
 280  * get to know how many sample rates we have to expect.
 281  * Then fp->rate_table can be allocated and filled.
 282  */
 283 static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
 284                                         struct audioformat *fp, int nr_triplets,
 285                                         const unsigned char *data)
 286 {
 287         int i, nr_rates = 0;
 288
 289         fp->rates = fp->rate_min = fp->rate_max = 0;
 290
 291         for (i = 0; i < nr_triplets; i++) {
 292                 int min = combine_quad(&data[2 + 12 * i]);
 293                 int max = combine_quad(&data[6 + 12 * i]);
 294                 int res = combine_quad(&data[10 + 12 * i]);
 295                 unsigned int rate;
 296
 297                 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
 298                         continue;
 299
 300                 /*
 301                  * for ranges with res == 1, we announce a continuous sample
 302                  * rate range, and this function should return 0 for no further
 303                  * parsing.
 304                  */
 305                 if (res == 1) {
 306                         fp->rate_min = min;
 307                         fp->rate_max = max;
 308                         fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
 309                         return 0;
 310                 }
 311
 312                 for (rate = min; rate <= max; rate += res) {
 313                         /* Filter out invalid rates on Focusrite devices */
 314                         if (USB_ID_VENDOR(chip->usb_id) == 0x1235 &&
 315                             !focusrite_valid_sample_rate(chip, fp, rate))
 316                                 goto skip_rate;
 317
 318                         if (fp->rate_table)
 319                                 fp->rate_table[nr_rates] = rate;
 320                         if (!fp->rate_min || rate < fp->rate_min)
 321                                 fp->rate_min = rate;
 322                         if (!fp->rate_max || rate > fp->rate_max)
 323                                 fp->rate_max = rate;
 324                         fp->rates |= snd_pcm_rate_to_rate_bit(rate);
 325
 326                         nr_rates++;
 327                         if (nr_rates >= MAX_NR_RATES) {
 328                                 usb_audio_err(chip, "invalid uac2 rates\n");
 329                                 break;
 330                         }
 331
 332 skip_rate:
 333                         /* avoid endless loop */
 334                         if (res == 0)
 335                                 break;
 336                 }
 337         }
 338
 339         return nr_rates;
 340 }
 341
 342 /*
 343  * parse the format descriptor and stores the possible sample rates
 344  * on the audioformat table (audio class v2).
 345  */
 346 static int parse_audio_format_rates_v2(struct snd_usb_audio *chip,
 347                                        struct audioformat *fp)
 348 {
 349         struct usb_device *dev = chip->dev;
 350         unsigned char tmp[2], *data;
 351         int nr_triplets, data_size, ret = 0;
 352         int clock = snd_usb_clock_find_source(chip, fp->clock, false);
 353
 354         if (clock < 0) {
 355                 dev_err(&dev->dev,
 356                         "%s(): unable to find clock source (clock %d)\n",
 357                                 __func__, clock);
 358                 goto err;
 359         }
 360
 361         /* get the number of sample rates first by only fetching 2 bytes */
 362         ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
 363                               USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
 364                               UAC2_CS_CONTROL_SAM_FREQ << 8,
 365                               snd_usb_ctrl_intf(chip) | (clock << 8),
 366                               tmp, sizeof(tmp));
 367
 368         if (ret < 0) {
 369                 dev_err(&dev->dev,
 370                         "%s(): unable to retrieve number of sample rates (clock %d)\n",
 371                                 __func__, clock);
 372                 goto err;
 373         }
 374
 375         nr_triplets = (tmp[1] << 8) | tmp[0];
 376         data_size = 2 + 12 * nr_triplets;
 377         data = kzalloc(data_size, GFP_KERNEL);
 378         if (!data) {
 379                 ret = -ENOMEM;
 380                 goto err;
 381         }
 382
 383         /* now get the full information */
 384         ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
 385                               USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
 386                               UAC2_CS_CONTROL_SAM_FREQ << 8,
 387                               snd_usb_ctrl_intf(chip) | (clock << 8),
 388                               data, data_size);
 389
 390         if (ret < 0) {
 391                 dev_err(&dev->dev,
 392                         "%s(): unable to retrieve sample rate range (clock %d)\n",
 393                                 __func__, clock);
 394                 ret = -EINVAL;
 395                 goto err_free;
 396         }
 397
 398         /* Call the triplet parser, and make sure fp->rate_table is NULL.
 399          * We just use the return value to know how many sample rates we
 400          * will have to deal with. */
 401         kfree(fp->rate_table);
 402         fp->rate_table = NULL;
 403         fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
 404
 405         if (fp->nr_rates == 0) {
 406                 /* SNDRV_PCM_RATE_CONTINUOUS */
 407                 ret = 0;
 408                 goto err_free;
 409         }
 410
 411         fp->rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
 412         if (!fp->rate_table) {
 413                 ret = -ENOMEM;
 414                 goto err_free;
 415         }
 416
 417         /* Call the triplet parser again, but this time, fp->rate_table is
 418          * allocated, so the rates will be stored */
 419         parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
 420
 421 err_free:
 422         kfree(data);
 423 err:
 424         return ret;
 425 }
 426
 427 /*
 428  * parse the format type I and III descriptors
 429  */
 430 static int parse_audio_format_i(struct snd_usb_audio *chip,
 431                                 struct audioformat *fp, unsigned int format,
 432                                 struct uac_format_type_i_continuous_descriptor *fmt)
 433 {
 434         snd_pcm_format_t pcm_format;
 435         int ret;
 436
 437         if (fmt->bFormatType == UAC_FORMAT_TYPE_III) {
 438                 /* FIXME: the format type is really IECxxx
 439                  *        but we give normal PCM format to get the existing
 440                  *        apps working...
 441                  */
 442                 switch (chip->usb_id) {
 443
 444                 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
 445                         if (chip->setup == 0x00 &&
 446                             fp->altsetting == 6)
 447                                 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
 448                         else
 449                                 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
 450                         break;
 451                 default:
 452                         pcm_format = SNDRV_PCM_FORMAT_S16_LE;
 453                 }
 454                 fp->formats = pcm_format_to_bits(pcm_format);
 455         } else {
 456                 fp->formats = parse_audio_format_i_type(chip, fp, format, fmt);
 457                 if (!fp->formats)
 458                         return -EINVAL;
 459         }
 460
 461         /* gather possible sample rates */
 462         /* audio class v1 reports possible sample rates as part of the
 463          * proprietary class specific descriptor.
 464          * audio class v2 uses class specific EP0 range requests for that.
 465          */
 466         switch (fp->protocol) {
 467         default:
 468         case UAC_VERSION_1:
 469                 fp->channels = fmt->bNrChannels;
 470                 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
 471                 break;
 472         case UAC_VERSION_2:
 473                 /* fp->channels is already set in this case */
 474                 ret = parse_audio_format_rates_v2(chip, fp);
 475                 break;
 476         }
 477
 478         if (fp->channels < 1) {
 479                 usb_audio_err(chip,
 480                         "%u:%d : invalid channels %d\n",
 481                         fp->iface, fp->altsetting, fp->channels);
 482                 return -EINVAL;
 483         }
 484
 485         return ret;
 486 }
 487
 488 /*
 489  * parse the format type II descriptor
 490  */
 491 static int parse_audio_format_ii(struct snd_usb_audio *chip,
 492                                  struct audioformat *fp,
 493                                  int format, void *_fmt)
 494 {
 495         int brate, framesize, ret;
 496
 497         switch (format) {
 498         case UAC_FORMAT_TYPE_II_AC3:
 499                 /* FIXME: there is no AC3 format defined yet */
 500                 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
 501                 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
 502                 break;
 503         case UAC_FORMAT_TYPE_II_MPEG:
 504                 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
 505                 break;
 506         default:
 507                 usb_audio_info(chip,
 508                          "%u:%d : unknown format tag %#x is detected.  processed as MPEG.\n",
 509                          fp->iface, fp->altsetting, format);
 510                 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
 511                 break;
 512         }
 513
 514         fp->channels = 1;
 515
 516         switch (fp->protocol) {
 517         default:
 518         case UAC_VERSION_1: {
 519                 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
 520                 brate = le16_to_cpu(fmt->wMaxBitRate);
 521                 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
 522                 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
 523                 fp->frame_size = framesize;
 524                 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
 525                 break;
 526         }
 527         case UAC_VERSION_2: {
 528                 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
 529                 brate = le16_to_cpu(fmt->wMaxBitRate);
 530                 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
 531                 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
 532                 fp->frame_size = framesize;
 533                 ret = parse_audio_format_rates_v2(chip, fp);
 534                 break;
 535         }
 536         }
 537
 538         return ret;
 539 }
 540
 541 int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
 542                                struct audioformat *fp, unsigned int format,
 543                                struct uac_format_type_i_continuous_descriptor *fmt,
 544                                int stream)
 545 {
 546         int err;
 547
 548         switch (fmt->bFormatType) {
 549         case UAC_FORMAT_TYPE_I:
 550         case UAC_FORMAT_TYPE_III:
 551                 err = parse_audio_format_i(chip, fp, format, fmt);
 552                 break;
 553         case UAC_FORMAT_TYPE_II:
 554                 err = parse_audio_format_ii(chip, fp, format, fmt);
 555                 break;
 556         default:
 557                 usb_audio_info(chip,
 558                          "%u:%d : format type %d is not supported yet\n",
 559                          fp->iface, fp->altsetting,
 560                          fmt->bFormatType);
 561                 return -ENOTSUPP;
 562         }
 563         fp->fmt_type = fmt->bFormatType;
 564         if (err < 0)
 565                 return err;
 566 #if 1
 567         /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
 568         /* extigy apparently supports sample rates other than 48k
 569          * but not in ordinary way.  so we enable only 48k atm.
 570          */
 571         if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
 572             chip->usb_id == USB_ID(0x041e, 0x3020) ||
 573             chip->usb_id == USB_ID(0x041e, 0x3061)) {
 574                 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
 575                     fp->rates != SNDRV_PCM_RATE_48000 &&
 576                     fp->rates != SNDRV_PCM_RATE_96000)
 577                         return -ENOTSUPP;
 578         }
 579 #endif
 580         return 0;
 581 }
 582