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