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