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