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