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