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