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