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 #include <linux/init.h> 18 #include <linux/slab.h> 19 #include <linux/usb.h> 20 #include <linux/usb/audio.h> 21 #include <linux/usb/midi.h> 22 #include <linux/bits.h> 23 24 #include <sound/control.h> 25 #include <sound/core.h> 26 #include <sound/info.h> 27 #include <sound/pcm.h> 28 29 #include "usbaudio.h" 30 #include "card.h" 31 #include "mixer.h" 32 #include "mixer_quirks.h" 33 #include "midi.h" 34 #include "quirks.h" 35 #include "helper.h" 36 #include "endpoint.h" 37 #include "pcm.h" 38 #include "clock.h" 39 #include "stream.h" 40 41 /* 42 * handle the quirks for the contained interfaces 43 */ 44 static int create_composite_quirk(struct snd_usb_audio *chip, 45 struct usb_interface *iface, 46 struct usb_driver *driver, 47 const struct snd_usb_audio_quirk *quirk_comp) 48 { 49 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber; 50 const struct snd_usb_audio_quirk *quirk; 51 int err; 52 53 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) { 54 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum); 55 if (!iface) 56 continue; 57 if (quirk->ifnum != probed_ifnum && 58 usb_interface_claimed(iface)) 59 continue; 60 err = snd_usb_create_quirk(chip, iface, driver, quirk); 61 if (err < 0) 62 return err; 63 } 64 65 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) { 66 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum); 67 if (!iface) 68 continue; 69 if (quirk->ifnum != probed_ifnum && 70 !usb_interface_claimed(iface)) 71 usb_driver_claim_interface(driver, iface, (void *)-1L); 72 } 73 74 return 0; 75 } 76 77 static int ignore_interface_quirk(struct snd_usb_audio *chip, 78 struct usb_interface *iface, 79 struct usb_driver *driver, 80 const struct snd_usb_audio_quirk *quirk) 81 { 82 return 0; 83 } 84 85 86 /* 87 * Allow alignment on audio sub-slot (channel samples) rather than 88 * on audio slots (audio frames) 89 */ 90 static int create_align_transfer_quirk(struct snd_usb_audio *chip, 91 struct usb_interface *iface, 92 struct usb_driver *driver, 93 const struct snd_usb_audio_quirk *quirk) 94 { 95 chip->txfr_quirk = 1; 96 return 1; /* Continue with creating streams and mixer */ 97 } 98 99 static int create_any_midi_quirk(struct snd_usb_audio *chip, 100 struct usb_interface *intf, 101 struct usb_driver *driver, 102 const struct snd_usb_audio_quirk *quirk) 103 { 104 return snd_usbmidi_create(chip->card, intf, &chip->midi_list, quirk); 105 } 106 107 /* 108 * create a stream for an interface with proper descriptors 109 */ 110 static int create_standard_audio_quirk(struct snd_usb_audio *chip, 111 struct usb_interface *iface, 112 struct usb_driver *driver, 113 const struct snd_usb_audio_quirk *quirk) 114 { 115 struct usb_host_interface *alts; 116 struct usb_interface_descriptor *altsd; 117 int err; 118 119 if (chip->usb_id == USB_ID(0x1686, 0x00dd)) /* Zoom R16/24 */ 120 chip->tx_length_quirk = 1; 121 122 alts = &iface->altsetting[0]; 123 altsd = get_iface_desc(alts); 124 err = snd_usb_parse_audio_interface(chip, altsd->bInterfaceNumber); 125 if (err < 0) { 126 usb_audio_err(chip, "cannot setup if %d: error %d\n", 127 altsd->bInterfaceNumber, err); 128 return err; 129 } 130 /* reset the current interface */ 131 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0); 132 return 0; 133 } 134 135 /* 136 * create a stream for an endpoint/altsetting without proper descriptors 137 */ 138 static int create_fixed_stream_quirk(struct snd_usb_audio *chip, 139 struct usb_interface *iface, 140 struct usb_driver *driver, 141 const struct snd_usb_audio_quirk *quirk) 142 { 143 struct audioformat *fp; 144 struct usb_host_interface *alts; 145 struct usb_interface_descriptor *altsd; 146 int stream, err; 147 unsigned *rate_table = NULL; 148 149 fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL); 150 if (!fp) 151 return -ENOMEM; 152 153 INIT_LIST_HEAD(&fp->list); 154 if (fp->nr_rates > MAX_NR_RATES) { 155 kfree(fp); 156 return -EINVAL; 157 } 158 if (fp->nr_rates > 0) { 159 rate_table = kmemdup(fp->rate_table, 160 sizeof(int) * fp->nr_rates, GFP_KERNEL); 161 if (!rate_table) { 162 kfree(fp); 163 return -ENOMEM; 164 } 165 fp->rate_table = rate_table; 166 } 167 168 stream = (fp->endpoint & USB_DIR_IN) 169 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK; 170 err = snd_usb_add_audio_stream(chip, stream, fp); 171 if (err < 0) 172 goto error; 173 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber || 174 fp->altset_idx >= iface->num_altsetting) { 175 err = -EINVAL; 176 goto error; 177 } 178 alts = &iface->altsetting[fp->altset_idx]; 179 altsd = get_iface_desc(alts); 180 if (altsd->bNumEndpoints < 1) { 181 err = -EINVAL; 182 goto error; 183 } 184 185 fp->protocol = altsd->bInterfaceProtocol; 186 187 if (fp->datainterval == 0) 188 fp->datainterval = snd_usb_parse_datainterval(chip, alts); 189 if (fp->maxpacksize == 0) 190 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize); 191 usb_set_interface(chip->dev, fp->iface, 0); 192 snd_usb_init_pitch(chip, fp->iface, alts, fp); 193 snd_usb_init_sample_rate(chip, fp->iface, alts, fp, fp->rate_max); 194 return 0; 195 196 error: 197 list_del(&fp->list); /* unlink for avoiding double-free */ 198 kfree(fp); 199 kfree(rate_table); 200 return err; 201 } 202 203 static int create_auto_pcm_quirk(struct snd_usb_audio *chip, 204 struct usb_interface *iface, 205 struct usb_driver *driver) 206 { 207 struct usb_host_interface *alts; 208 struct usb_interface_descriptor *altsd; 209 struct usb_endpoint_descriptor *epd; 210 struct uac1_as_header_descriptor *ashd; 211 struct uac_format_type_i_discrete_descriptor *fmtd; 212 213 /* 214 * Most Roland/Yamaha audio streaming interfaces have more or less 215 * standard descriptors, but older devices might lack descriptors, and 216 * future ones might change, so ensure that we fail silently if the 217 * interface doesn't look exactly right. 218 */ 219 220 /* must have a non-zero altsetting for streaming */ 221 if (iface->num_altsetting < 2) 222 return -ENODEV; 223 alts = &iface->altsetting[1]; 224 altsd = get_iface_desc(alts); 225 226 /* must have an isochronous endpoint for streaming */ 227 if (altsd->bNumEndpoints < 1) 228 return -ENODEV; 229 epd = get_endpoint(alts, 0); 230 if (!usb_endpoint_xfer_isoc(epd)) 231 return -ENODEV; 232 233 /* must have format descriptors */ 234 ashd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, 235 UAC_AS_GENERAL); 236 fmtd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, 237 UAC_FORMAT_TYPE); 238 if (!ashd || ashd->bLength < 7 || 239 !fmtd || fmtd->bLength < 8) 240 return -ENODEV; 241 242 return create_standard_audio_quirk(chip, iface, driver, NULL); 243 } 244 245 static int create_yamaha_midi_quirk(struct snd_usb_audio *chip, 246 struct usb_interface *iface, 247 struct usb_driver *driver, 248 struct usb_host_interface *alts) 249 { 250 static const struct snd_usb_audio_quirk yamaha_midi_quirk = { 251 .type = QUIRK_MIDI_YAMAHA 252 }; 253 struct usb_midi_in_jack_descriptor *injd; 254 struct usb_midi_out_jack_descriptor *outjd; 255 256 /* must have some valid jack descriptors */ 257 injd = snd_usb_find_csint_desc(alts->extra, alts->extralen, 258 NULL, USB_MS_MIDI_IN_JACK); 259 outjd = snd_usb_find_csint_desc(alts->extra, alts->extralen, 260 NULL, USB_MS_MIDI_OUT_JACK); 261 if (!injd && !outjd) 262 return -ENODEV; 263 if (injd && (injd->bLength < 5 || 264 (injd->bJackType != USB_MS_EMBEDDED && 265 injd->bJackType != USB_MS_EXTERNAL))) 266 return -ENODEV; 267 if (outjd && (outjd->bLength < 6 || 268 (outjd->bJackType != USB_MS_EMBEDDED && 269 outjd->bJackType != USB_MS_EXTERNAL))) 270 return -ENODEV; 271 return create_any_midi_quirk(chip, iface, driver, &yamaha_midi_quirk); 272 } 273 274 static int create_roland_midi_quirk(struct snd_usb_audio *chip, 275 struct usb_interface *iface, 276 struct usb_driver *driver, 277 struct usb_host_interface *alts) 278 { 279 static const struct snd_usb_audio_quirk roland_midi_quirk = { 280 .type = QUIRK_MIDI_ROLAND 281 }; 282 u8 *roland_desc = NULL; 283 284 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */ 285 for (;;) { 286 roland_desc = snd_usb_find_csint_desc(alts->extra, 287 alts->extralen, 288 roland_desc, 0xf1); 289 if (!roland_desc) 290 return -ENODEV; 291 if (roland_desc[0] < 6 || roland_desc[3] != 2) 292 continue; 293 return create_any_midi_quirk(chip, iface, driver, 294 &roland_midi_quirk); 295 } 296 } 297 298 static int create_std_midi_quirk(struct snd_usb_audio *chip, 299 struct usb_interface *iface, 300 struct usb_driver *driver, 301 struct usb_host_interface *alts) 302 { 303 struct usb_ms_header_descriptor *mshd; 304 struct usb_ms_endpoint_descriptor *msepd; 305 306 /* must have the MIDIStreaming interface header descriptor*/ 307 mshd = (struct usb_ms_header_descriptor *)alts->extra; 308 if (alts->extralen < 7 || 309 mshd->bLength < 7 || 310 mshd->bDescriptorType != USB_DT_CS_INTERFACE || 311 mshd->bDescriptorSubtype != USB_MS_HEADER) 312 return -ENODEV; 313 /* must have the MIDIStreaming endpoint descriptor*/ 314 msepd = (struct usb_ms_endpoint_descriptor *)alts->endpoint[0].extra; 315 if (alts->endpoint[0].extralen < 4 || 316 msepd->bLength < 4 || 317 msepd->bDescriptorType != USB_DT_CS_ENDPOINT || 318 msepd->bDescriptorSubtype != UAC_MS_GENERAL || 319 msepd->bNumEmbMIDIJack < 1 || 320 msepd->bNumEmbMIDIJack > 16) 321 return -ENODEV; 322 323 return create_any_midi_quirk(chip, iface, driver, NULL); 324 } 325 326 static int create_auto_midi_quirk(struct snd_usb_audio *chip, 327 struct usb_interface *iface, 328 struct usb_driver *driver) 329 { 330 struct usb_host_interface *alts; 331 struct usb_interface_descriptor *altsd; 332 struct usb_endpoint_descriptor *epd; 333 int err; 334 335 alts = &iface->altsetting[0]; 336 altsd = get_iface_desc(alts); 337 338 /* must have at least one bulk/interrupt endpoint for streaming */ 339 if (altsd->bNumEndpoints < 1) 340 return -ENODEV; 341 epd = get_endpoint(alts, 0); 342 if (!usb_endpoint_xfer_bulk(epd) && 343 !usb_endpoint_xfer_int(epd)) 344 return -ENODEV; 345 346 switch (USB_ID_VENDOR(chip->usb_id)) { 347 case 0x0499: /* Yamaha */ 348 err = create_yamaha_midi_quirk(chip, iface, driver, alts); 349 if (err != -ENODEV) 350 return err; 351 break; 352 case 0x0582: /* Roland */ 353 err = create_roland_midi_quirk(chip, iface, driver, alts); 354 if (err != -ENODEV) 355 return err; 356 break; 357 } 358 359 return create_std_midi_quirk(chip, iface, driver, alts); 360 } 361 362 static int create_autodetect_quirk(struct snd_usb_audio *chip, 363 struct usb_interface *iface, 364 struct usb_driver *driver) 365 { 366 int err; 367 368 err = create_auto_pcm_quirk(chip, iface, driver); 369 if (err == -ENODEV) 370 err = create_auto_midi_quirk(chip, iface, driver); 371 return err; 372 } 373 374 static int create_autodetect_quirks(struct snd_usb_audio *chip, 375 struct usb_interface *iface, 376 struct usb_driver *driver, 377 const struct snd_usb_audio_quirk *quirk) 378 { 379 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber; 380 int ifcount, ifnum, err; 381 382 err = create_autodetect_quirk(chip, iface, driver); 383 if (err < 0) 384 return err; 385 386 /* 387 * ALSA PCM playback/capture devices cannot be registered in two steps, 388 * so we have to claim the other corresponding interface here. 389 */ 390 ifcount = chip->dev->actconfig->desc.bNumInterfaces; 391 for (ifnum = 0; ifnum < ifcount; ifnum++) { 392 if (ifnum == probed_ifnum || quirk->ifnum >= 0) 393 continue; 394 iface = usb_ifnum_to_if(chip->dev, ifnum); 395 if (!iface || 396 usb_interface_claimed(iface) || 397 get_iface_desc(iface->altsetting)->bInterfaceClass != 398 USB_CLASS_VENDOR_SPEC) 399 continue; 400 401 err = create_autodetect_quirk(chip, iface, driver); 402 if (err >= 0) 403 usb_driver_claim_interface(driver, iface, (void *)-1L); 404 } 405 406 return 0; 407 } 408 409 /* 410 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface. 411 * The only way to detect the sample rate is by looking at wMaxPacketSize. 412 */ 413 static int create_uaxx_quirk(struct snd_usb_audio *chip, 414 struct usb_interface *iface, 415 struct usb_driver *driver, 416 const struct snd_usb_audio_quirk *quirk) 417 { 418 static const struct audioformat ua_format = { 419 .formats = SNDRV_PCM_FMTBIT_S24_3LE, 420 .channels = 2, 421 .fmt_type = UAC_FORMAT_TYPE_I, 422 .altsetting = 1, 423 .altset_idx = 1, 424 .rates = SNDRV_PCM_RATE_CONTINUOUS, 425 }; 426 struct usb_host_interface *alts; 427 struct usb_interface_descriptor *altsd; 428 struct audioformat *fp; 429 int stream, err; 430 431 /* both PCM and MIDI interfaces have 2 or more altsettings */ 432 if (iface->num_altsetting < 2) 433 return -ENXIO; 434 alts = &iface->altsetting[1]; 435 altsd = get_iface_desc(alts); 436 437 if (altsd->bNumEndpoints == 2) { 438 static const struct snd_usb_midi_endpoint_info ua700_ep = { 439 .out_cables = 0x0003, 440 .in_cables = 0x0003 441 }; 442 static const struct snd_usb_audio_quirk ua700_quirk = { 443 .type = QUIRK_MIDI_FIXED_ENDPOINT, 444 .data = &ua700_ep 445 }; 446 static const struct snd_usb_midi_endpoint_info uaxx_ep = { 447 .out_cables = 0x0001, 448 .in_cables = 0x0001 449 }; 450 static const struct snd_usb_audio_quirk uaxx_quirk = { 451 .type = QUIRK_MIDI_FIXED_ENDPOINT, 452 .data = &uaxx_ep 453 }; 454 const struct snd_usb_audio_quirk *quirk = 455 chip->usb_id == USB_ID(0x0582, 0x002b) 456 ? &ua700_quirk : &uaxx_quirk; 457 return __snd_usbmidi_create(chip->card, iface, 458 &chip->midi_list, quirk, 459 chip->usb_id); 460 } 461 462 if (altsd->bNumEndpoints != 1) 463 return -ENXIO; 464 465 fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL); 466 if (!fp) 467 return -ENOMEM; 468 469 fp->iface = altsd->bInterfaceNumber; 470 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress; 471 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes; 472 fp->datainterval = 0; 473 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize); 474 INIT_LIST_HEAD(&fp->list); 475 476 switch (fp->maxpacksize) { 477 case 0x120: 478 fp->rate_max = fp->rate_min = 44100; 479 break; 480 case 0x138: 481 case 0x140: 482 fp->rate_max = fp->rate_min = 48000; 483 break; 484 case 0x258: 485 case 0x260: 486 fp->rate_max = fp->rate_min = 96000; 487 break; 488 default: 489 usb_audio_err(chip, "unknown sample rate\n"); 490 kfree(fp); 491 return -ENXIO; 492 } 493 494 stream = (fp->endpoint & USB_DIR_IN) 495 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK; 496 err = snd_usb_add_audio_stream(chip, stream, fp); 497 if (err < 0) { 498 list_del(&fp->list); /* unlink for avoiding double-free */ 499 kfree(fp); 500 return err; 501 } 502 usb_set_interface(chip->dev, fp->iface, 0); 503 return 0; 504 } 505 506 /* 507 * Create a standard mixer for the specified interface. 508 */ 509 static int create_standard_mixer_quirk(struct snd_usb_audio *chip, 510 struct usb_interface *iface, 511 struct usb_driver *driver, 512 const struct snd_usb_audio_quirk *quirk) 513 { 514 if (quirk->ifnum < 0) 515 return 0; 516 517 return snd_usb_create_mixer(chip, quirk->ifnum, 0); 518 } 519 520 /* 521 * audio-interface quirks 522 * 523 * returns zero if no standard audio/MIDI parsing is needed. 524 * returns a positive value if standard audio/midi interfaces are parsed 525 * after this. 526 * returns a negative value at error. 527 */ 528 int snd_usb_create_quirk(struct snd_usb_audio *chip, 529 struct usb_interface *iface, 530 struct usb_driver *driver, 531 const struct snd_usb_audio_quirk *quirk) 532 { 533 typedef int (*quirk_func_t)(struct snd_usb_audio *, 534 struct usb_interface *, 535 struct usb_driver *, 536 const struct snd_usb_audio_quirk *); 537 static const quirk_func_t quirk_funcs[] = { 538 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk, 539 [QUIRK_COMPOSITE] = create_composite_quirk, 540 [QUIRK_AUTODETECT] = create_autodetect_quirks, 541 [QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk, 542 [QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk, 543 [QUIRK_MIDI_YAMAHA] = create_any_midi_quirk, 544 [QUIRK_MIDI_ROLAND] = create_any_midi_quirk, 545 [QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk, 546 [QUIRK_MIDI_NOVATION] = create_any_midi_quirk, 547 [QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk, 548 [QUIRK_MIDI_EMAGIC] = create_any_midi_quirk, 549 [QUIRK_MIDI_CME] = create_any_midi_quirk, 550 [QUIRK_MIDI_AKAI] = create_any_midi_quirk, 551 [QUIRK_MIDI_FTDI] = create_any_midi_quirk, 552 [QUIRK_MIDI_CH345] = create_any_midi_quirk, 553 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk, 554 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk, 555 [QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk, 556 [QUIRK_AUDIO_ALIGN_TRANSFER] = create_align_transfer_quirk, 557 [QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk, 558 }; 559 560 if (quirk->type < QUIRK_TYPE_COUNT) { 561 return quirk_funcs[quirk->type](chip, iface, driver, quirk); 562 } else { 563 usb_audio_err(chip, "invalid quirk type %d\n", quirk->type); 564 return -ENXIO; 565 } 566 } 567 568 /* 569 * boot quirks 570 */ 571 572 #define EXTIGY_FIRMWARE_SIZE_OLD 794 573 #define EXTIGY_FIRMWARE_SIZE_NEW 483 574 575 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf) 576 { 577 struct usb_host_config *config = dev->actconfig; 578 int err; 579 580 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD || 581 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) { 582 dev_dbg(&dev->dev, "sending Extigy boot sequence...\n"); 583 /* Send message to force it to reconnect with full interface. */ 584 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0), 585 0x10, 0x43, 0x0001, 0x000a, NULL, 0); 586 if (err < 0) 587 dev_dbg(&dev->dev, "error sending boot message: %d\n", err); 588 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, 589 &dev->descriptor, sizeof(dev->descriptor)); 590 config = dev->actconfig; 591 if (err < 0) 592 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err); 593 err = usb_reset_configuration(dev); 594 if (err < 0) 595 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err); 596 dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n", 597 le16_to_cpu(get_cfg_desc(config)->wTotalLength)); 598 return -ENODEV; /* quit this anyway */ 599 } 600 return 0; 601 } 602 603 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev) 604 { 605 u8 buf = 1; 606 607 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a, 608 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER, 609 0, 0, &buf, 1); 610 if (buf == 0) { 611 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29, 612 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER, 613 1, 2000, NULL, 0); 614 return -ENODEV; 615 } 616 return 0; 617 } 618 619 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev) 620 { 621 int err; 622 623 if (dev->actconfig->desc.bConfigurationValue == 1) { 624 dev_info(&dev->dev, 625 "Fast Track Pro switching to config #2\n"); 626 /* This function has to be available by the usb core module. 627 * if it is not avialable the boot quirk has to be left out 628 * and the configuration has to be set by udev or hotplug 629 * rules 630 */ 631 err = usb_driver_set_configuration(dev, 2); 632 if (err < 0) 633 dev_dbg(&dev->dev, 634 "error usb_driver_set_configuration: %d\n", 635 err); 636 /* Always return an error, so that we stop creating a device 637 that will just be destroyed and recreated with a new 638 configuration */ 639 return -ENODEV; 640 } else 641 dev_info(&dev->dev, "Fast Track Pro config OK\n"); 642 643 return 0; 644 } 645 646 /* 647 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely 648 * documented in the device's data sheet. 649 */ 650 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value) 651 { 652 u8 buf[4]; 653 buf[0] = 0x20; 654 buf[1] = value & 0xff; 655 buf[2] = (value >> 8) & 0xff; 656 buf[3] = reg; 657 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION, 658 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT, 659 0, 0, &buf, 4); 660 } 661 662 static int snd_usb_cm106_boot_quirk(struct usb_device *dev) 663 { 664 /* 665 * Enable line-out driver mode, set headphone source to front 666 * channels, enable stereo mic. 667 */ 668 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004); 669 } 670 671 /* 672 * CM6206 registers from the CM6206 datasheet rev 2.1 673 */ 674 #define CM6206_REG0_DMA_MASTER BIT(15) 675 #define CM6206_REG0_SPDIFO_RATE_48K (2 << 12) 676 #define CM6206_REG0_SPDIFO_RATE_96K (7 << 12) 677 /* Bit 4 thru 11 is the S/PDIF category code */ 678 #define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4) 679 #define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3) 680 #define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2) 681 #define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1) 682 #define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0) 683 684 #define CM6206_REG1_TEST_SEL_CLK BIT(14) 685 #define CM6206_REG1_PLLBIN_EN BIT(13) 686 #define CM6206_REG1_SOFT_MUTE_EN BIT(12) 687 #define CM6206_REG1_GPIO4_OUT BIT(11) 688 #define CM6206_REG1_GPIO4_OE BIT(10) 689 #define CM6206_REG1_GPIO3_OUT BIT(9) 690 #define CM6206_REG1_GPIO3_OE BIT(8) 691 #define CM6206_REG1_GPIO2_OUT BIT(7) 692 #define CM6206_REG1_GPIO2_OE BIT(6) 693 #define CM6206_REG1_GPIO1_OUT BIT(5) 694 #define CM6206_REG1_GPIO1_OE BIT(4) 695 #define CM6206_REG1_SPDIFO_INVALID BIT(3) 696 #define CM6206_REG1_SPDIF_LOOP_EN BIT(2) 697 #define CM6206_REG1_SPDIFO_DIS BIT(1) 698 #define CM6206_REG1_SPDIFI_MIX BIT(0) 699 700 #define CM6206_REG2_DRIVER_ON BIT(15) 701 #define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13) 702 #define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13) 703 #define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13) 704 #define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13) 705 #define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12) 706 #define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11) 707 #define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10) 708 #define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9) 709 #define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8) 710 #define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7) 711 #define CM6206_REG2_MUTE_SUBWOOFER BIT(6) 712 #define CM6206_REG2_MUTE_CENTER BIT(5) 713 #define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3) 714 #define CM6206_REG2_MUTE_LEFT_FRONT BIT(3) 715 #define CM6206_REG2_EN_BTL BIT(2) 716 #define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0) 717 #define CM6206_REG2_MCUCLKSEL_3_MHZ (1) 718 #define CM6206_REG2_MCUCLKSEL_6_MHZ (2) 719 #define CM6206_REG2_MCUCLKSEL_12_MHZ (3) 720 721 /* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */ 722 #define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11) 723 #define CM6206_REG3_VRAP25EN BIT(10) 724 #define CM6206_REG3_MSEL1 BIT(9) 725 #define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7) 726 #define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7) 727 #define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7) 728 #define CM6206_REG3_PINSEL BIT(6) 729 #define CM6206_REG3_FOE BIT(5) 730 #define CM6206_REG3_ROE BIT(4) 731 #define CM6206_REG3_CBOE BIT(3) 732 #define CM6206_REG3_LOSE BIT(2) 733 #define CM6206_REG3_HPOE BIT(1) 734 #define CM6206_REG3_SPDIFI_CANREC BIT(0) 735 736 #define CM6206_REG5_DA_RSTN BIT(13) 737 #define CM6206_REG5_AD_RSTN BIT(12) 738 #define CM6206_REG5_SPDIFO_AD2SPDO BIT(12) 739 #define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9) 740 #define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9) 741 #define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9) 742 #define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9) 743 #define CM6206_REG5_CODECM BIT(8) 744 #define CM6206_REG5_EN_HPF BIT(7) 745 #define CM6206_REG5_T_SEL_DSDA4 BIT(6) 746 #define CM6206_REG5_T_SEL_DSDA3 BIT(5) 747 #define CM6206_REG5_T_SEL_DSDA2 BIT(4) 748 #define CM6206_REG5_T_SEL_DSDA1 BIT(3) 749 #define CM6206_REG5_T_SEL_DSDAD_NORMAL 0 750 #define CM6206_REG5_T_SEL_DSDAD_FRONT 4 751 #define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5 752 #define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6 753 #define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7 754 755 static int snd_usb_cm6206_boot_quirk(struct usb_device *dev) 756 { 757 int err = 0, reg; 758 int val[] = { 759 /* 760 * Values here are chosen based on sniffing USB traffic 761 * under Windows. 762 * 763 * REG0: DAC is master, sample rate 48kHz, no copyright 764 */ 765 CM6206_REG0_SPDIFO_RATE_48K | 766 CM6206_REG0_SPDIFO_COPYRIGHT_NA, 767 /* 768 * REG1: PLL binary search enable, soft mute enable. 769 */ 770 CM6206_REG1_PLLBIN_EN | 771 CM6206_REG1_SOFT_MUTE_EN, 772 /* 773 * REG2: enable output drivers, 774 * select front channels to the headphone output, 775 * then mute the headphone channels, run the MCU 776 * at 1.5 MHz. 777 */ 778 CM6206_REG2_DRIVER_ON | 779 CM6206_REG2_HEADP_SEL_FRONT_CHANNELS | 780 CM6206_REG2_MUTE_HEADPHONE_RIGHT | 781 CM6206_REG2_MUTE_HEADPHONE_LEFT, 782 /* 783 * REG3: default flyspeed, set 2.5V mic bias 784 * enable all line out ports and enable SPDIF 785 */ 786 CM6206_REG3_FLYSPEED_DEFAULT | 787 CM6206_REG3_VRAP25EN | 788 CM6206_REG3_FOE | 789 CM6206_REG3_ROE | 790 CM6206_REG3_CBOE | 791 CM6206_REG3_LOSE | 792 CM6206_REG3_HPOE | 793 CM6206_REG3_SPDIFI_CANREC, 794 /* REG4 is just a bunch of GPIO lines */ 795 0x0000, 796 /* REG5: de-assert AD/DA reset signals */ 797 CM6206_REG5_DA_RSTN | 798 CM6206_REG5_AD_RSTN }; 799 800 for (reg = 0; reg < ARRAY_SIZE(val); reg++) { 801 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]); 802 if (err < 0) 803 return err; 804 } 805 806 return err; 807 } 808 809 /* quirk for Plantronics GameCom 780 with CM6302 chip */ 810 static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev) 811 { 812 /* set the initial volume and don't change; other values are either 813 * too loud or silent due to firmware bug (bko#65251) 814 */ 815 u8 buf[2] = { 0x74, 0xe3 }; 816 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR, 817 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT, 818 UAC_FU_VOLUME << 8, 9 << 8, buf, 2); 819 } 820 821 /* 822 * Novation Twitch DJ controller 823 * Focusrite Novation Saffire 6 USB audio card 824 */ 825 static int snd_usb_novation_boot_quirk(struct usb_device *dev) 826 { 827 /* preemptively set up the device because otherwise the 828 * raw MIDI endpoints are not active */ 829 usb_set_interface(dev, 0, 1); 830 return 0; 831 } 832 833 /* 834 * This call will put the synth in "USB send" mode, i.e it will send MIDI 835 * messages through USB (this is disabled at startup). The synth will 836 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB 837 * sign on its LCD. Values here are chosen based on sniffing USB traffic 838 * under Windows. 839 */ 840 static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev) 841 { 842 int err, actual_length; 843 844 /* "midi send" enable */ 845 static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 }; 846 847 void *buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL); 848 if (!buf) 849 return -ENOMEM; 850 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf, 851 ARRAY_SIZE(seq), &actual_length, 1000); 852 kfree(buf); 853 if (err < 0) 854 return err; 855 856 return 0; 857 } 858 859 /* 860 * Some sound cards from Native Instruments are in fact compliant to the USB 861 * audio standard of version 2 and other approved USB standards, even though 862 * they come up as vendor-specific device when first connected. 863 * 864 * However, they can be told to come up with a new set of descriptors 865 * upon their next enumeration, and the interfaces announced by the new 866 * descriptors will then be handled by the kernel's class drivers. As the 867 * product ID will also change, no further checks are required. 868 */ 869 870 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev) 871 { 872 int ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 873 0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE, 874 1, 0, NULL, 0, 1000); 875 876 if (ret < 0) 877 return ret; 878 879 usb_reset_device(dev); 880 881 /* return -EAGAIN, so the creation of an audio interface for this 882 * temporary device is aborted. The device will reconnect with a 883 * new product ID */ 884 return -EAGAIN; 885 } 886 887 static void mbox2_setup_48_24_magic(struct usb_device *dev) 888 { 889 u8 srate[3]; 890 u8 temp[12]; 891 892 /* Choose 48000Hz permanently */ 893 srate[0] = 0x80; 894 srate[1] = 0xbb; 895 srate[2] = 0x00; 896 897 /* Send the magic! */ 898 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 899 0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003); 900 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 901 0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003); 902 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 903 0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003); 904 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 905 0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003); 906 return; 907 } 908 909 /* Digidesign Mbox 2 needs to load firmware onboard 910 * and driver must wait a few seconds for initialisation. 911 */ 912 913 #define MBOX2_FIRMWARE_SIZE 646 914 #define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */ 915 #define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */ 916 917 static int snd_usb_mbox2_boot_quirk(struct usb_device *dev) 918 { 919 struct usb_host_config *config = dev->actconfig; 920 int err; 921 u8 bootresponse[0x12]; 922 int fwsize; 923 int count; 924 925 fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength); 926 927 if (fwsize != MBOX2_FIRMWARE_SIZE) { 928 dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize); 929 return -ENODEV; 930 } 931 932 dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n"); 933 934 count = 0; 935 bootresponse[0] = MBOX2_BOOT_LOADING; 936 while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) { 937 msleep(500); /* 0.5 second delay */ 938 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 939 /* Control magic - load onboard firmware */ 940 0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012); 941 if (bootresponse[0] == MBOX2_BOOT_READY) 942 break; 943 dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n"); 944 count++; 945 } 946 947 if (bootresponse[0] != MBOX2_BOOT_READY) { 948 dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]); 949 return -ENODEV; 950 } 951 952 dev_dbg(&dev->dev, "device initialised!\n"); 953 954 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, 955 &dev->descriptor, sizeof(dev->descriptor)); 956 config = dev->actconfig; 957 if (err < 0) 958 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err); 959 960 err = usb_reset_configuration(dev); 961 if (err < 0) 962 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err); 963 dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n", 964 le16_to_cpu(get_cfg_desc(config)->wTotalLength)); 965 966 mbox2_setup_48_24_magic(dev); 967 968 dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz"); 969 970 return 0; /* Successful boot */ 971 } 972 973 static int snd_usb_axefx3_boot_quirk(struct usb_device *dev) 974 { 975 int err; 976 977 dev_dbg(&dev->dev, "Waiting for Axe-Fx III to boot up...\n"); 978 979 /* If the Axe-Fx III has not fully booted, it will timeout when trying 980 * to enable the audio streaming interface. A more generous timeout is 981 * used here to detect when the Axe-Fx III has finished booting as the 982 * set interface message will be acked once it has 983 */ 984 err = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 985 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE, 986 1, 1, NULL, 0, 120000); 987 if (err < 0) { 988 dev_err(&dev->dev, 989 "failed waiting for Axe-Fx III to boot: %d\n", err); 990 return err; 991 } 992 993 dev_dbg(&dev->dev, "Axe-Fx III is now ready\n"); 994 995 err = usb_set_interface(dev, 1, 0); 996 if (err < 0) 997 dev_dbg(&dev->dev, 998 "error stopping Axe-Fx III interface: %d\n", err); 999 1000 return 0; 1001 } 1002 1003 /* 1004 * Setup quirks 1005 */ 1006 #define MAUDIO_SET 0x01 /* parse device_setup */ 1007 #define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */ 1008 #define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */ 1009 #define MAUDIO_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */ 1010 #define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */ 1011 #define MAUDIO_SET_DI 0x10 /* enable Digital Input */ 1012 #define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */ 1013 #define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48KHz+Digital Input */ 1014 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */ 1015 #define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48KHz+Digital Input */ 1016 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */ 1017 1018 static int quattro_skip_setting_quirk(struct snd_usb_audio *chip, 1019 int iface, int altno) 1020 { 1021 /* Reset ALL ifaces to 0 altsetting. 1022 * Call it for every possible altsetting of every interface. 1023 */ 1024 usb_set_interface(chip->dev, iface, 0); 1025 if (chip->setup & MAUDIO_SET) { 1026 if (chip->setup & MAUDIO_SET_COMPATIBLE) { 1027 if (iface != 1 && iface != 2) 1028 return 1; /* skip all interfaces but 1 and 2 */ 1029 } else { 1030 unsigned int mask; 1031 if (iface == 1 || iface == 2) 1032 return 1; /* skip interfaces 1 and 2 */ 1033 if ((chip->setup & MAUDIO_SET_96K) && altno != 1) 1034 return 1; /* skip this altsetting */ 1035 mask = chip->setup & MAUDIO_SET_MASK; 1036 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2) 1037 return 1; /* skip this altsetting */ 1038 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3) 1039 return 1; /* skip this altsetting */ 1040 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4) 1041 return 1; /* skip this altsetting */ 1042 } 1043 } 1044 usb_audio_dbg(chip, 1045 "using altsetting %d for interface %d config %d\n", 1046 altno, iface, chip->setup); 1047 return 0; /* keep this altsetting */ 1048 } 1049 1050 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip, 1051 int iface, 1052 int altno) 1053 { 1054 /* Reset ALL ifaces to 0 altsetting. 1055 * Call it for every possible altsetting of every interface. 1056 */ 1057 usb_set_interface(chip->dev, iface, 0); 1058 1059 if (chip->setup & MAUDIO_SET) { 1060 unsigned int mask; 1061 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6) 1062 return 1; /* skip this altsetting */ 1063 if ((chip->setup & MAUDIO_SET_96K) && altno != 1) 1064 return 1; /* skip this altsetting */ 1065 mask = chip->setup & MAUDIO_SET_MASK; 1066 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2) 1067 return 1; /* skip this altsetting */ 1068 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3) 1069 return 1; /* skip this altsetting */ 1070 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4) 1071 return 1; /* skip this altsetting */ 1072 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5) 1073 return 1; /* skip this altsetting */ 1074 } 1075 1076 return 0; /* keep this altsetting */ 1077 } 1078 1079 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip, 1080 int iface, int altno) 1081 { 1082 /* Reset ALL ifaces to 0 altsetting. 1083 * Call it for every possible altsetting of every interface. 1084 */ 1085 usb_set_interface(chip->dev, iface, 0); 1086 1087 /* possible configuration where both inputs and only one output is 1088 *used is not supported by the current setup 1089 */ 1090 if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) { 1091 if (chip->setup & MAUDIO_SET_96K) { 1092 if (altno != 3 && altno != 6) 1093 return 1; 1094 } else if (chip->setup & MAUDIO_SET_DI) { 1095 if (iface == 4) 1096 return 1; /* no analog input */ 1097 if (altno != 2 && altno != 5) 1098 return 1; /* enable only altsets 2 and 5 */ 1099 } else { 1100 if (iface == 5) 1101 return 1; /* disable digialt input */ 1102 if (altno != 2 && altno != 5) 1103 return 1; /* enalbe only altsets 2 and 5 */ 1104 } 1105 } else { 1106 /* keep only 16-Bit mode */ 1107 if (altno != 1) 1108 return 1; 1109 } 1110 1111 usb_audio_dbg(chip, 1112 "using altsetting %d for interface %d config %d\n", 1113 altno, iface, chip->setup); 1114 return 0; /* keep this altsetting */ 1115 } 1116 1117 int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip, 1118 int iface, 1119 int altno) 1120 { 1121 /* audiophile usb: skip altsets incompatible with device_setup */ 1122 if (chip->usb_id == USB_ID(0x0763, 0x2003)) 1123 return audiophile_skip_setting_quirk(chip, iface, altno); 1124 /* quattro usb: skip altsets incompatible with device_setup */ 1125 if (chip->usb_id == USB_ID(0x0763, 0x2001)) 1126 return quattro_skip_setting_quirk(chip, iface, altno); 1127 /* fasttrackpro usb: skip altsets incompatible with device_setup */ 1128 if (chip->usb_id == USB_ID(0x0763, 0x2012)) 1129 return fasttrackpro_skip_setting_quirk(chip, iface, altno); 1130 1131 return 0; 1132 } 1133 1134 int snd_usb_apply_boot_quirk(struct usb_device *dev, 1135 struct usb_interface *intf, 1136 const struct snd_usb_audio_quirk *quirk, 1137 unsigned int id) 1138 { 1139 switch (id) { 1140 case USB_ID(0x041e, 0x3000): 1141 /* SB Extigy needs special boot-up sequence */ 1142 /* if more models come, this will go to the quirk list. */ 1143 return snd_usb_extigy_boot_quirk(dev, intf); 1144 1145 case USB_ID(0x041e, 0x3020): 1146 /* SB Audigy 2 NX needs its own boot-up magic, too */ 1147 return snd_usb_audigy2nx_boot_quirk(dev); 1148 1149 case USB_ID(0x10f5, 0x0200): 1150 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */ 1151 return snd_usb_cm106_boot_quirk(dev); 1152 1153 case USB_ID(0x0d8c, 0x0102): 1154 /* C-Media CM6206 / CM106-Like Sound Device */ 1155 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */ 1156 return snd_usb_cm6206_boot_quirk(dev); 1157 1158 case USB_ID(0x0dba, 0x3000): 1159 /* Digidesign Mbox 2 */ 1160 return snd_usb_mbox2_boot_quirk(dev); 1161 1162 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */ 1163 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */ 1164 return snd_usb_novation_boot_quirk(dev); 1165 1166 case USB_ID(0x133e, 0x0815): 1167 /* Access Music VirusTI Desktop */ 1168 return snd_usb_accessmusic_boot_quirk(dev); 1169 1170 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */ 1171 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */ 1172 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */ 1173 return snd_usb_nativeinstruments_boot_quirk(dev); 1174 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */ 1175 return snd_usb_fasttrackpro_boot_quirk(dev); 1176 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */ 1177 return snd_usb_gamecon780_boot_quirk(dev); 1178 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */ 1179 return snd_usb_axefx3_boot_quirk(dev); 1180 } 1181 1182 return 0; 1183 } 1184 1185 /* 1186 * check if the device uses big-endian samples 1187 */ 1188 int snd_usb_is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp) 1189 { 1190 /* it depends on altsetting whether the device is big-endian or not */ 1191 switch (chip->usb_id) { 1192 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */ 1193 if (fp->altsetting == 2 || fp->altsetting == 3 || 1194 fp->altsetting == 5 || fp->altsetting == 6) 1195 return 1; 1196 break; 1197 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */ 1198 if (chip->setup == 0x00 || 1199 fp->altsetting == 1 || fp->altsetting == 2 || 1200 fp->altsetting == 3) 1201 return 1; 1202 break; 1203 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */ 1204 if (fp->altsetting == 2 || fp->altsetting == 3 || 1205 fp->altsetting == 5 || fp->altsetting == 6) 1206 return 1; 1207 break; 1208 } 1209 return 0; 1210 } 1211 1212 /* 1213 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device, 1214 * not for interface. 1215 */ 1216 1217 enum { 1218 EMU_QUIRK_SR_44100HZ = 0, 1219 EMU_QUIRK_SR_48000HZ, 1220 EMU_QUIRK_SR_88200HZ, 1221 EMU_QUIRK_SR_96000HZ, 1222 EMU_QUIRK_SR_176400HZ, 1223 EMU_QUIRK_SR_192000HZ 1224 }; 1225 1226 static void set_format_emu_quirk(struct snd_usb_substream *subs, 1227 struct audioformat *fmt) 1228 { 1229 unsigned char emu_samplerate_id = 0; 1230 1231 /* When capture is active 1232 * sample rate shouldn't be changed 1233 * by playback substream 1234 */ 1235 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) { 1236 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].interface != -1) 1237 return; 1238 } 1239 1240 switch (fmt->rate_min) { 1241 case 48000: 1242 emu_samplerate_id = EMU_QUIRK_SR_48000HZ; 1243 break; 1244 case 88200: 1245 emu_samplerate_id = EMU_QUIRK_SR_88200HZ; 1246 break; 1247 case 96000: 1248 emu_samplerate_id = EMU_QUIRK_SR_96000HZ; 1249 break; 1250 case 176400: 1251 emu_samplerate_id = EMU_QUIRK_SR_176400HZ; 1252 break; 1253 case 192000: 1254 emu_samplerate_id = EMU_QUIRK_SR_192000HZ; 1255 break; 1256 default: 1257 emu_samplerate_id = EMU_QUIRK_SR_44100HZ; 1258 break; 1259 } 1260 snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id); 1261 subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0; 1262 } 1263 1264 void snd_usb_set_format_quirk(struct snd_usb_substream *subs, 1265 struct audioformat *fmt) 1266 { 1267 switch (subs->stream->chip->usb_id) { 1268 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */ 1269 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */ 1270 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */ 1271 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */ 1272 set_format_emu_quirk(subs, fmt); 1273 break; 1274 } 1275 } 1276 1277 bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio *chip) 1278 { 1279 /* devices which do not support reading the sample rate. */ 1280 switch (chip->usb_id) { 1281 case USB_ID(0x041E, 0x4080): /* Creative Live Cam VF0610 */ 1282 case USB_ID(0x04D8, 0xFEEA): /* Benchmark DAC1 Pre */ 1283 case USB_ID(0x0556, 0x0014): /* Phoenix Audio TMX320VC */ 1284 case USB_ID(0x05A3, 0x9420): /* ELP HD USB Camera */ 1285 case USB_ID(0x074D, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */ 1286 case USB_ID(0x1395, 0x740a): /* Sennheiser DECT */ 1287 case USB_ID(0x1901, 0x0191): /* GE B850V3 CP2114 audio interface */ 1288 case USB_ID(0x21B4, 0x0081): /* AudioQuest DragonFly */ 1289 return true; 1290 } 1291 1292 /* devices of these vendors don't support reading rate, either */ 1293 switch (USB_ID_VENDOR(chip->usb_id)) { 1294 case 0x045E: /* MS Lifecam */ 1295 case 0x047F: /* Plantronics */ 1296 case 0x1de7: /* Phoenix Audio */ 1297 return true; 1298 } 1299 1300 return false; 1301 } 1302 1303 /* ITF-USB DSD based DACs need a vendor cmd to switch 1304 * between PCM and native DSD mode 1305 */ 1306 static bool is_itf_usb_dsd_dac(unsigned int id) 1307 { 1308 switch (id) { 1309 case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */ 1310 case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */ 1311 case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */ 1312 case USB_ID(0x1852, 0x5065): /* Luxman DA-06 */ 1313 case USB_ID(0x0644, 0x8043): /* TEAC UD-501/UD-501V2/UD-503/NT-503 */ 1314 case USB_ID(0x0644, 0x8044): /* Esoteric D-05X */ 1315 case USB_ID(0x0644, 0x804a): /* TEAC UD-301 */ 1316 return true; 1317 } 1318 return false; 1319 } 1320 1321 int snd_usb_select_mode_quirk(struct snd_usb_substream *subs, 1322 struct audioformat *fmt) 1323 { 1324 struct usb_device *dev = subs->dev; 1325 int err; 1326 1327 if (is_itf_usb_dsd_dac(subs->stream->chip->usb_id)) { 1328 /* First switch to alt set 0, otherwise the mode switch cmd 1329 * will not be accepted by the DAC 1330 */ 1331 err = usb_set_interface(dev, fmt->iface, 0); 1332 if (err < 0) 1333 return err; 1334 1335 msleep(20); /* Delay needed after setting the interface */ 1336 1337 /* Vendor mode switch cmd is required. */ 1338 if (fmt->formats & SNDRV_PCM_FMTBIT_DSD_U32_BE) { 1339 /* DSD mode (DSD_U32) requested */ 1340 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0, 1341 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE, 1342 1, 1, NULL, 0); 1343 if (err < 0) 1344 return err; 1345 1346 } else { 1347 /* PCM or DOP mode (S32) requested */ 1348 /* PCM mode (S16) requested */ 1349 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0, 1350 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE, 1351 0, 1, NULL, 0); 1352 if (err < 0) 1353 return err; 1354 1355 } 1356 msleep(20); 1357 } 1358 return 0; 1359 } 1360 1361 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep) 1362 { 1363 /* 1364 * "Playback Design" products send bogus feedback data at the start 1365 * of the stream. Ignore them. 1366 */ 1367 if (USB_ID_VENDOR(ep->chip->usb_id) == 0x23ba && 1368 ep->type == SND_USB_ENDPOINT_TYPE_SYNC) 1369 ep->skip_packets = 4; 1370 1371 /* 1372 * M-Audio Fast Track C400/C600 - when packets are not skipped, real 1373 * world latency varies by approx. +/- 50 frames (at 96KHz) each time 1374 * the stream is (re)started. When skipping packets 16 at endpoint 1375 * start up, the real world latency is stable within +/- 1 frame (also 1376 * across power cycles). 1377 */ 1378 if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) || 1379 ep->chip->usb_id == USB_ID(0x0763, 0x2031)) && 1380 ep->type == SND_USB_ENDPOINT_TYPE_DATA) 1381 ep->skip_packets = 16; 1382 1383 /* Work around devices that report unreasonable feedback data */ 1384 if ((ep->chip->usb_id == USB_ID(0x0644, 0x8038) || /* TEAC UD-H01 */ 1385 ep->chip->usb_id == USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */ 1386 ep->syncmaxsize == 4) 1387 ep->tenor_fb_quirk = 1; 1388 } 1389 1390 void snd_usb_set_interface_quirk(struct usb_device *dev) 1391 { 1392 struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev); 1393 1394 if (!chip) 1395 return; 1396 /* 1397 * "Playback Design" products need a 50ms delay after setting the 1398 * USB interface. 1399 */ 1400 switch (USB_ID_VENDOR(chip->usb_id)) { 1401 case 0x23ba: /* Playback Design */ 1402 case 0x0644: /* TEAC Corp. */ 1403 msleep(50); 1404 break; 1405 } 1406 } 1407 1408 /* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */ 1409 void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe, 1410 __u8 request, __u8 requesttype, __u16 value, 1411 __u16 index, void *data, __u16 size) 1412 { 1413 struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev); 1414 1415 if (!chip) 1416 return; 1417 /* 1418 * "Playback Design" products need a 20ms delay after each 1419 * class compliant request 1420 */ 1421 if (USB_ID_VENDOR(chip->usb_id) == 0x23ba && 1422 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS) 1423 msleep(20); 1424 1425 /* 1426 * "TEAC Corp." products need a 20ms delay after each 1427 * class compliant request 1428 */ 1429 if (USB_ID_VENDOR(chip->usb_id) == 0x0644 && 1430 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS) 1431 msleep(20); 1432 1433 /* ITF-USB DSD based DACs functionality need a delay 1434 * after each class compliant request 1435 */ 1436 if (is_itf_usb_dsd_dac(chip->usb_id) 1437 && (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS) 1438 msleep(20); 1439 1440 /* Zoom R16/24, Logitech H650e, Jabra 550a needs a tiny delay here, 1441 * otherwise requests like get/set frequency return as failed despite 1442 * actually succeeding. 1443 */ 1444 if ((chip->usb_id == USB_ID(0x1686, 0x00dd) || 1445 chip->usb_id == USB_ID(0x046d, 0x0a46) || 1446 chip->usb_id == USB_ID(0x0b0e, 0x0349)) && 1447 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS) 1448 usleep_range(1000, 2000); 1449 } 1450 1451 /* 1452 * snd_usb_interface_dsd_format_quirks() is called from format.c to 1453 * augment the PCM format bit-field for DSD types. The UAC standards 1454 * don't have a designated bit field to denote DSD-capable interfaces, 1455 * hence all hardware that is known to support this format has to be 1456 * listed here. 1457 */ 1458 u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip, 1459 struct audioformat *fp, 1460 unsigned int sample_bytes) 1461 { 1462 struct usb_interface *iface; 1463 1464 /* Playback Designs */ 1465 if (USB_ID_VENDOR(chip->usb_id) == 0x23ba) { 1466 switch (fp->altsetting) { 1467 case 1: 1468 fp->dsd_dop = true; 1469 return SNDRV_PCM_FMTBIT_DSD_U16_LE; 1470 case 2: 1471 fp->dsd_bitrev = true; 1472 return SNDRV_PCM_FMTBIT_DSD_U8; 1473 case 3: 1474 fp->dsd_bitrev = true; 1475 return SNDRV_PCM_FMTBIT_DSD_U16_LE; 1476 } 1477 } 1478 1479 /* XMOS based USB DACs */ 1480 switch (chip->usb_id) { 1481 case USB_ID(0x1511, 0x0037): /* AURALiC VEGA */ 1482 case USB_ID(0x20b1, 0x0002): /* Wyred 4 Sound DAC-2 DSD */ 1483 case USB_ID(0x20b1, 0x2004): /* Matrix Audio X-SPDIF 2 */ 1484 case USB_ID(0x20b1, 0x2008): /* Matrix Audio X-Sabre */ 1485 case USB_ID(0x20b1, 0x300a): /* Matrix Audio Mini-i Pro */ 1486 case USB_ID(0x22d9, 0x0416): /* OPPO HA-1 */ 1487 case USB_ID(0x22d9, 0x0436): /* OPPO Sonica */ 1488 case USB_ID(0x22d9, 0x0461): /* OPPO UDP-205 */ 1489 case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */ 1490 case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */ 1491 if (fp->altsetting == 2) 1492 return SNDRV_PCM_FMTBIT_DSD_U32_BE; 1493 break; 1494 1495 case USB_ID(0x152a, 0x85de): /* SMSL D1 DAC */ 1496 case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */ 1497 case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */ 1498 case USB_ID(0x16b0, 0x06b2): /* NuPrime DAC-10 */ 1499 case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */ 1500 case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */ 1501 case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */ 1502 case USB_ID(0x20b1, 0x000a): /* Gustard DAC-X20U */ 1503 case USB_ID(0x20b1, 0x2005): /* Denafrips Ares DAC */ 1504 case USB_ID(0x20b1, 0x2009): /* DIYINHK DSD DXD 384kHz USB to I2S/DSD */ 1505 case USB_ID(0x20b1, 0x2023): /* JLsounds I2SoverUSB */ 1506 case USB_ID(0x20b1, 0x3021): /* Eastern El. MiniMax Tube DAC Supreme */ 1507 case USB_ID(0x20b1, 0x3023): /* Aune X1S 32BIT/384 DSD DAC */ 1508 case USB_ID(0x20b1, 0x302d): /* Unison Research Unico CD Due */ 1509 case USB_ID(0x20b1, 0x307b): /* CH Precision C1 DAC */ 1510 case USB_ID(0x20b1, 0x3086): /* Singxer F-1 converter board */ 1511 case USB_ID(0x22d9, 0x0426): /* OPPO HA-2 */ 1512 case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */ 1513 case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */ 1514 case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */ 1515 case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */ 1516 case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */ 1517 case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */ 1518 case USB_ID(0x6b42, 0x0042): /* MSB Technology */ 1519 if (fp->altsetting == 3) 1520 return SNDRV_PCM_FMTBIT_DSD_U32_BE; 1521 break; 1522 1523 /* Amanero Combo384 USB based DACs with native DSD support */ 1524 case USB_ID(0x16d0, 0x071a): /* Amanero - Combo384 */ 1525 case USB_ID(0x2ab6, 0x0004): /* T+A DAC8DSD-V2.0, MP1000E-V2.0, MP2000R-V2.0, MP2500R-V2.0, MP3100HV-V2.0 */ 1526 case USB_ID(0x2ab6, 0x0005): /* T+A USB HD Audio 1 */ 1527 case USB_ID(0x2ab6, 0x0006): /* T+A USB HD Audio 2 */ 1528 if (fp->altsetting == 2) { 1529 switch (le16_to_cpu(chip->dev->descriptor.bcdDevice)) { 1530 case 0x199: 1531 return SNDRV_PCM_FMTBIT_DSD_U32_LE; 1532 case 0x19b: 1533 case 0x203: 1534 return SNDRV_PCM_FMTBIT_DSD_U32_BE; 1535 default: 1536 break; 1537 } 1538 } 1539 break; 1540 case USB_ID(0x16d0, 0x0a23): 1541 if (fp->altsetting == 2) 1542 return SNDRV_PCM_FMTBIT_DSD_U32_BE; 1543 break; 1544 1545 default: 1546 break; 1547 } 1548 1549 /* ITF-USB DSD based DACs */ 1550 if (is_itf_usb_dsd_dac(chip->usb_id)) { 1551 iface = usb_ifnum_to_if(chip->dev, fp->iface); 1552 1553 /* Altsetting 2 support native DSD if the num of altsets is 1554 * three (0-2), 1555 * Altsetting 3 support native DSD if the num of altsets is 1556 * four (0-3). 1557 */ 1558 if (fp->altsetting == iface->num_altsetting - 1) 1559 return SNDRV_PCM_FMTBIT_DSD_U32_BE; 1560 } 1561 1562 /* Mostly generic method to detect many DSD-capable implementations - 1563 * from XMOS/Thesycon 1564 */ 1565 switch (USB_ID_VENDOR(chip->usb_id)) { 1566 case 0x20b1: /* XMOS based devices */ 1567 case 0x152a: /* Thesycon devices */ 1568 case 0x25ce: /* Mytek devices */ 1569 if (fp->dsd_raw) 1570 return SNDRV_PCM_FMTBIT_DSD_U32_BE; 1571 break; 1572 default: 1573 break; 1574 1575 } 1576 1577 return 0; 1578 } 1579 1580 void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio *chip, 1581 struct audioformat *fp, 1582 int stream) 1583 { 1584 switch (chip->usb_id) { 1585 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */ 1586 /* Optoplay sets the sample rate attribute although 1587 * it seems not supporting it in fact. 1588 */ 1589 fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE; 1590 break; 1591 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */ 1592 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */ 1593 /* doesn't set the sample rate attribute, but supports it */ 1594 fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE; 1595 break; 1596 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro USB */ 1597 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */ 1598 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */ 1599 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is 1600 an older model 77d:223) */ 1601 /* 1602 * plantronics headset and Griffin iMic have set adaptive-in 1603 * although it's really not... 1604 */ 1605 fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE; 1606 if (stream == SNDRV_PCM_STREAM_PLAYBACK) 1607 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE; 1608 else 1609 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC; 1610 break; 1611 } 1612 } 1613