1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 */
   4
   5#include <linux/init.h>
   6#include <linux/slab.h>
   7#include <linux/usb.h>
   8#include <linux/usb/audio.h>
   9#include <linux/usb/midi.h>
  10#include <linux/bits.h>
  11
  12#include <sound/control.h>
  13#include <sound/core.h>
  14#include <sound/info.h>
  15#include <sound/pcm.h>
  16
  17#include "usbaudio.h"
  18#include "card.h"
  19#include "mixer.h"
  20#include "mixer_quirks.h"
  21#include "midi.h"
 
  22#include "quirks.h"
  23#include "helper.h"
  24#include "endpoint.h"
  25#include "pcm.h"
  26#include "clock.h"
  27#include "stream.h"
  28
  29/*
  30 * handle the quirks for the contained interfaces
  31 */
  32static int create_composite_quirk(struct snd_usb_audio *chip,
  33				  struct usb_interface *iface,
  34				  struct usb_driver *driver,
  35				  const struct snd_usb_audio_quirk *quirk_comp)
  36{
  37	int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
  38	const struct snd_usb_audio_quirk *quirk;
  39	int err;
  40
  41	for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
  42		iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
  43		if (!iface)
  44			continue;
  45		if (quirk->ifnum != probed_ifnum &&
  46		    usb_interface_claimed(iface))
  47			continue;
  48		err = snd_usb_create_quirk(chip, iface, driver, quirk);
  49		if (err < 0)
  50			return err;
  51	}
  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			err = usb_driver_claim_interface(driver, iface,
  60							 USB_AUDIO_IFACE_UNUSED);
  61			if (err < 0)
  62				return err;
  63		}
  64	}
  65
  66	return 0;
  67}
  68
  69static int ignore_interface_quirk(struct snd_usb_audio *chip,
  70				  struct usb_interface *iface,
  71				  struct usb_driver *driver,
  72				  const struct snd_usb_audio_quirk *quirk)
  73{
  74	return 0;
  75}
  76
  77
  78static int create_any_midi_quirk(struct snd_usb_audio *chip,
  79				 struct usb_interface *intf,
  80				 struct usb_driver *driver,
  81				 const struct snd_usb_audio_quirk *quirk)
  82{
  83	return snd_usbmidi_create(chip->card, intf, &chip->midi_list, quirk);
  84}
  85
  86/*
  87 * create a stream for an interface with proper descriptors
  88 */
  89static int create_standard_audio_quirk(struct snd_usb_audio *chip,
  90				       struct usb_interface *iface,
  91				       struct usb_driver *driver,
  92				       const struct snd_usb_audio_quirk *quirk)
  93{
  94	struct usb_host_interface *alts;
  95	struct usb_interface_descriptor *altsd;
  96	int err;
  97
  98	alts = &iface->altsetting[0];
  99	altsd = get_iface_desc(alts);
 100	err = snd_usb_parse_audio_interface(chip, altsd->bInterfaceNumber);
 101	if (err < 0) {
 102		usb_audio_err(chip, "cannot setup if %d: error %d\n",
 103			   altsd->bInterfaceNumber, err);
 104		return err;
 105	}
 106	/* reset the current interface */
 107	usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
 108	return 0;
 109}
 110
 111/* create the audio stream and the corresponding endpoints from the fixed
 112 * audioformat object; this is used for quirks with the fixed EPs
 113 */
 114static int add_audio_stream_from_fixed_fmt(struct snd_usb_audio *chip,
 115					   struct audioformat *fp)
 116{
 117	int stream, err;
 118
 119	stream = (fp->endpoint & USB_DIR_IN) ?
 120		SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
 121
 122	snd_usb_audioformat_set_sync_ep(chip, fp);
 123
 124	err = snd_usb_add_audio_stream(chip, stream, fp);
 125	if (err < 0)
 126		return err;
 127
 128	err = snd_usb_add_endpoint(chip, fp->endpoint,
 129				   SND_USB_ENDPOINT_TYPE_DATA);
 130	if (err < 0)
 131		return err;
 132
 133	if (fp->sync_ep) {
 134		err = snd_usb_add_endpoint(chip, fp->sync_ep,
 135					   fp->implicit_fb ?
 136					   SND_USB_ENDPOINT_TYPE_DATA :
 137					   SND_USB_ENDPOINT_TYPE_SYNC);
 138		if (err < 0)
 139			return err;
 140	}
 141
 142	return 0;
 143}
 144
 145/*
 146 * create a stream for an endpoint/altsetting without proper descriptors
 147 */
 148static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
 149				     struct usb_interface *iface,
 150				     struct usb_driver *driver,
 151				     const struct snd_usb_audio_quirk *quirk)
 152{
 153	struct audioformat *fp;
 154	struct usb_host_interface *alts;
 155	struct usb_interface_descriptor *altsd;
 156	unsigned *rate_table = NULL;
 157	int err;
 158
 159	fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
 160	if (!fp)
 161		return -ENOMEM;
 162
 163	INIT_LIST_HEAD(&fp->list);
 164	if (fp->nr_rates > MAX_NR_RATES) {
 165		kfree(fp);
 166		return -EINVAL;
 167	}
 168	if (fp->nr_rates > 0) {
 169		rate_table = kmemdup(fp->rate_table,
 170				     sizeof(int) * fp->nr_rates, GFP_KERNEL);
 171		if (!rate_table) {
 172			kfree(fp);
 173			return -ENOMEM;
 174		}
 175		fp->rate_table = rate_table;
 176	}
 177
 178	if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
 179	    fp->altset_idx >= iface->num_altsetting) {
 180		err = -EINVAL;
 181		goto error;
 182	}
 183	alts = &iface->altsetting[fp->altset_idx];
 184	altsd = get_iface_desc(alts);
 185	if (altsd->bNumEndpoints <= fp->ep_idx) {
 186		err = -EINVAL;
 187		goto error;
 188	}
 189
 190	fp->protocol = altsd->bInterfaceProtocol;
 191
 192	if (fp->datainterval == 0)
 193		fp->datainterval = snd_usb_parse_datainterval(chip, alts);
 194	if (fp->maxpacksize == 0)
 195		fp->maxpacksize = le16_to_cpu(get_endpoint(alts, fp->ep_idx)->wMaxPacketSize);
 196	if (!fp->fmt_type)
 197		fp->fmt_type = UAC_FORMAT_TYPE_I;
 198
 199	err = add_audio_stream_from_fixed_fmt(chip, fp);
 200	if (err < 0)
 201		goto error;
 202
 203	usb_set_interface(chip->dev, fp->iface, 0);
 204	snd_usb_init_pitch(chip, fp);
 205	snd_usb_init_sample_rate(chip, fp, fp->rate_max);
 206	return 0;
 207
 208 error:
 209	list_del(&fp->list); /* unlink for avoiding double-free */
 210	kfree(fp);
 211	kfree(rate_table);
 212	return err;
 213}
 214
 215static int create_auto_pcm_quirk(struct snd_usb_audio *chip,
 216				 struct usb_interface *iface,
 217				 struct usb_driver *driver)
 218{
 219	struct usb_host_interface *alts;
 220	struct usb_interface_descriptor *altsd;
 221	struct usb_endpoint_descriptor *epd;
 222	struct uac1_as_header_descriptor *ashd;
 223	struct uac_format_type_i_discrete_descriptor *fmtd;
 224
 225	/*
 226	 * Most Roland/Yamaha audio streaming interfaces have more or less
 227	 * standard descriptors, but older devices might lack descriptors, and
 228	 * future ones might change, so ensure that we fail silently if the
 229	 * interface doesn't look exactly right.
 230	 */
 231
 232	/* must have a non-zero altsetting for streaming */
 233	if (iface->num_altsetting < 2)
 234		return -ENODEV;
 235	alts = &iface->altsetting[1];
 236	altsd = get_iface_desc(alts);
 237
 238	/* must have an isochronous endpoint for streaming */
 239	if (altsd->bNumEndpoints < 1)
 240		return -ENODEV;
 241	epd = get_endpoint(alts, 0);
 242	if (!usb_endpoint_xfer_isoc(epd))
 243		return -ENODEV;
 244
 245	/* must have format descriptors */
 246	ashd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
 247				       UAC_AS_GENERAL);
 248	fmtd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
 249				       UAC_FORMAT_TYPE);
 250	if (!ashd || ashd->bLength < 7 ||
 251	    !fmtd || fmtd->bLength < 8)
 252		return -ENODEV;
 253
 254	return create_standard_audio_quirk(chip, iface, driver, NULL);
 255}
 256
 257static int create_yamaha_midi_quirk(struct snd_usb_audio *chip,
 258				    struct usb_interface *iface,
 259				    struct usb_driver *driver,
 260				    struct usb_host_interface *alts)
 261{
 262	static const struct snd_usb_audio_quirk yamaha_midi_quirk = {
 263		.type = QUIRK_MIDI_YAMAHA
 264	};
 265	struct usb_midi_in_jack_descriptor *injd;
 266	struct usb_midi_out_jack_descriptor *outjd;
 267
 268	/* must have some valid jack descriptors */
 269	injd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
 270				       NULL, USB_MS_MIDI_IN_JACK);
 271	outjd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
 272					NULL, USB_MS_MIDI_OUT_JACK);
 273	if (!injd && !outjd)
 274		return -ENODEV;
 275	if ((injd && !snd_usb_validate_midi_desc(injd)) ||
 276	    (outjd && !snd_usb_validate_midi_desc(outjd)))
 277		return -ENODEV;
 278	if (injd && (injd->bLength < 5 ||
 279		     (injd->bJackType != USB_MS_EMBEDDED &&
 280		      injd->bJackType != USB_MS_EXTERNAL)))
 281		return -ENODEV;
 282	if (outjd && (outjd->bLength < 6 ||
 283		      (outjd->bJackType != USB_MS_EMBEDDED &&
 284		       outjd->bJackType != USB_MS_EXTERNAL)))
 285		return -ENODEV;
 286	return create_any_midi_quirk(chip, iface, driver, &yamaha_midi_quirk);
 287}
 288
 289static int create_roland_midi_quirk(struct snd_usb_audio *chip,
 290				    struct usb_interface *iface,
 291				    struct usb_driver *driver,
 292				    struct usb_host_interface *alts)
 293{
 294	static const struct snd_usb_audio_quirk roland_midi_quirk = {
 295		.type = QUIRK_MIDI_ROLAND
 296	};
 297	u8 *roland_desc = NULL;
 298
 299	/* might have a vendor-specific descriptor <06 24 F1 02 ...> */
 300	for (;;) {
 301		roland_desc = snd_usb_find_csint_desc(alts->extra,
 302						      alts->extralen,
 303						      roland_desc, 0xf1);
 304		if (!roland_desc)
 305			return -ENODEV;
 306		if (roland_desc[0] < 6 || roland_desc[3] != 2)
 307			continue;
 308		return create_any_midi_quirk(chip, iface, driver,
 309					     &roland_midi_quirk);
 310	}
 311}
 312
 313static int create_std_midi_quirk(struct snd_usb_audio *chip,
 314				 struct usb_interface *iface,
 315				 struct usb_driver *driver,
 316				 struct usb_host_interface *alts)
 317{
 318	struct usb_ms_header_descriptor *mshd;
 319	struct usb_ms_endpoint_descriptor *msepd;
 320
 321	/* must have the MIDIStreaming interface header descriptor*/
 322	mshd = (struct usb_ms_header_descriptor *)alts->extra;
 323	if (alts->extralen < 7 ||
 324	    mshd->bLength < 7 ||
 325	    mshd->bDescriptorType != USB_DT_CS_INTERFACE ||
 326	    mshd->bDescriptorSubtype != USB_MS_HEADER)
 327		return -ENODEV;
 328	/* must have the MIDIStreaming endpoint descriptor*/
 329	msepd = (struct usb_ms_endpoint_descriptor *)alts->endpoint[0].extra;
 330	if (alts->endpoint[0].extralen < 4 ||
 331	    msepd->bLength < 4 ||
 332	    msepd->bDescriptorType != USB_DT_CS_ENDPOINT ||
 333	    msepd->bDescriptorSubtype != UAC_MS_GENERAL ||
 334	    msepd->bNumEmbMIDIJack < 1 ||
 335	    msepd->bNumEmbMIDIJack > 16)
 336		return -ENODEV;
 337
 338	return create_any_midi_quirk(chip, iface, driver, NULL);
 339}
 340
 341static int create_auto_midi_quirk(struct snd_usb_audio *chip,
 342				  struct usb_interface *iface,
 343				  struct usb_driver *driver)
 344{
 345	struct usb_host_interface *alts;
 346	struct usb_interface_descriptor *altsd;
 347	struct usb_endpoint_descriptor *epd;
 348	int err;
 349
 350	alts = &iface->altsetting[0];
 351	altsd = get_iface_desc(alts);
 352
 353	/* must have at least one bulk/interrupt endpoint for streaming */
 354	if (altsd->bNumEndpoints < 1)
 355		return -ENODEV;
 356	epd = get_endpoint(alts, 0);
 357	if (!usb_endpoint_xfer_bulk(epd) &&
 358	    !usb_endpoint_xfer_int(epd))
 359		return -ENODEV;
 360
 361	switch (USB_ID_VENDOR(chip->usb_id)) {
 362	case 0x0499: /* Yamaha */
 363		err = create_yamaha_midi_quirk(chip, iface, driver, alts);
 364		if (err != -ENODEV)
 365			return err;
 366		break;
 367	case 0x0582: /* Roland */
 368		err = create_roland_midi_quirk(chip, iface, driver, alts);
 369		if (err != -ENODEV)
 370			return err;
 371		break;
 372	}
 373
 374	return create_std_midi_quirk(chip, iface, driver, alts);
 375}
 376
 377static int create_autodetect_quirk(struct snd_usb_audio *chip,
 378				   struct usb_interface *iface,
 379				   struct usb_driver *driver,
 380				   const struct snd_usb_audio_quirk *quirk)
 381{
 382	int err;
 383
 384	err = create_auto_pcm_quirk(chip, iface, driver);
 385	if (err == -ENODEV)
 386		err = create_auto_midi_quirk(chip, iface, driver);
 387	return err;
 388}
 389
 390/*
 391 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.  
 392 * The only way to detect the sample rate is by looking at wMaxPacketSize.
 393 */
 394static int create_uaxx_quirk(struct snd_usb_audio *chip,
 395			     struct usb_interface *iface,
 396			     struct usb_driver *driver,
 397			     const struct snd_usb_audio_quirk *quirk)
 398{
 399	static const struct audioformat ua_format = {
 400		.formats = SNDRV_PCM_FMTBIT_S24_3LE,
 401		.channels = 2,
 402		.fmt_type = UAC_FORMAT_TYPE_I,
 403		.altsetting = 1,
 404		.altset_idx = 1,
 405		.rates = SNDRV_PCM_RATE_CONTINUOUS,
 406	};
 407	struct usb_host_interface *alts;
 408	struct usb_interface_descriptor *altsd;
 409	struct audioformat *fp;
 410	int err;
 411
 412	/* both PCM and MIDI interfaces have 2 or more altsettings */
 413	if (iface->num_altsetting < 2)
 414		return -ENXIO;
 415	alts = &iface->altsetting[1];
 416	altsd = get_iface_desc(alts);
 417
 418	if (altsd->bNumEndpoints == 2) {
 419		static const struct snd_usb_midi_endpoint_info ua700_ep = {
 420			.out_cables = 0x0003,
 421			.in_cables  = 0x0003
 422		};
 423		static const struct snd_usb_audio_quirk ua700_quirk = {
 424			.type = QUIRK_MIDI_FIXED_ENDPOINT,
 425			.data = &ua700_ep
 426		};
 427		static const struct snd_usb_midi_endpoint_info uaxx_ep = {
 428			.out_cables = 0x0001,
 429			.in_cables  = 0x0001
 430		};
 431		static const struct snd_usb_audio_quirk uaxx_quirk = {
 432			.type = QUIRK_MIDI_FIXED_ENDPOINT,
 433			.data = &uaxx_ep
 434		};
 435		const struct snd_usb_audio_quirk *quirk =
 436			chip->usb_id == USB_ID(0x0582, 0x002b)
 437			? &ua700_quirk : &uaxx_quirk;
 438		return __snd_usbmidi_create(chip->card, iface,
 439					  &chip->midi_list, quirk,
 440					  chip->usb_id);
 
 441	}
 442
 443	if (altsd->bNumEndpoints != 1)
 444		return -ENXIO;
 445
 446	fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL);
 447	if (!fp)
 448		return -ENOMEM;
 449
 450	fp->iface = altsd->bInterfaceNumber;
 451	fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
 452	fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
 453	fp->datainterval = 0;
 454	fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
 455	INIT_LIST_HEAD(&fp->list);
 456
 457	switch (fp->maxpacksize) {
 458	case 0x120:
 459		fp->rate_max = fp->rate_min = 44100;
 460		break;
 461	case 0x138:
 462	case 0x140:
 463		fp->rate_max = fp->rate_min = 48000;
 464		break;
 465	case 0x258:
 466	case 0x260:
 467		fp->rate_max = fp->rate_min = 96000;
 468		break;
 469	default:
 470		usb_audio_err(chip, "unknown sample rate\n");
 471		kfree(fp);
 472		return -ENXIO;
 473	}
 474
 475	err = add_audio_stream_from_fixed_fmt(chip, fp);
 476	if (err < 0) {
 477		list_del(&fp->list); /* unlink for avoiding double-free */
 478		kfree(fp);
 479		return err;
 480	}
 481	usb_set_interface(chip->dev, fp->iface, 0);
 482	return 0;
 483}
 484
 485/*
 486 * Create a standard mixer for the specified interface.
 487 */
 488static int create_standard_mixer_quirk(struct snd_usb_audio *chip,
 489				       struct usb_interface *iface,
 490				       struct usb_driver *driver,
 491				       const struct snd_usb_audio_quirk *quirk)
 492{
 493	if (quirk->ifnum < 0)
 494		return 0;
 495
 496	return snd_usb_create_mixer(chip, quirk->ifnum);
 497}
 498
 499/*
 500 * audio-interface quirks
 501 *
 502 * returns zero if no standard audio/MIDI parsing is needed.
 503 * returns a positive value if standard audio/midi interfaces are parsed
 504 * after this.
 505 * returns a negative value at error.
 506 */
 507int snd_usb_create_quirk(struct snd_usb_audio *chip,
 508			 struct usb_interface *iface,
 509			 struct usb_driver *driver,
 510			 const struct snd_usb_audio_quirk *quirk)
 511{
 512	typedef int (*quirk_func_t)(struct snd_usb_audio *,
 513				    struct usb_interface *,
 514				    struct usb_driver *,
 515				    const struct snd_usb_audio_quirk *);
 516	static const quirk_func_t quirk_funcs[] = {
 517		[QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
 518		[QUIRK_COMPOSITE] = create_composite_quirk,
 519		[QUIRK_AUTODETECT] = create_autodetect_quirk,
 520		[QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk,
 521		[QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk,
 522		[QUIRK_MIDI_YAMAHA] = create_any_midi_quirk,
 523		[QUIRK_MIDI_ROLAND] = create_any_midi_quirk,
 524		[QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
 525		[QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
 526		[QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
 527		[QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
 528		[QUIRK_MIDI_CME] = create_any_midi_quirk,
 529		[QUIRK_MIDI_AKAI] = create_any_midi_quirk,
 530		[QUIRK_MIDI_FTDI] = create_any_midi_quirk,
 531		[QUIRK_MIDI_CH345] = create_any_midi_quirk,
 532		[QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
 533		[QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
 534		[QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
 535		[QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
 536	};
 537
 538	if (quirk->type < QUIRK_TYPE_COUNT) {
 539		return quirk_funcs[quirk->type](chip, iface, driver, quirk);
 540	} else {
 541		usb_audio_err(chip, "invalid quirk type %d\n", quirk->type);
 542		return -ENXIO;
 543	}
 544}
 545
 546/*
 547 * boot quirks
 548 */
 549
 550#define EXTIGY_FIRMWARE_SIZE_OLD 794
 551#define EXTIGY_FIRMWARE_SIZE_NEW 483
 552
 553static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
 554{
 555	struct usb_host_config *config = dev->actconfig;
 556	int err;
 557
 558	if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
 559	    le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
 560		dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
 561		/* Send message to force it to reconnect with full interface. */
 562		err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
 563				      0x10, 0x43, 0x0001, 0x000a, NULL, 0);
 564		if (err < 0)
 565			dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
 566		err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
 567				&dev->descriptor, sizeof(dev->descriptor));
 568		config = dev->actconfig;
 569		if (err < 0)
 570			dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
 571		err = usb_reset_configuration(dev);
 572		if (err < 0)
 573			dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
 574		dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
 575			    le16_to_cpu(get_cfg_desc(config)->wTotalLength));
 576		return -ENODEV; /* quit this anyway */
 577	}
 578	return 0;
 579}
 580
 581static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
 582{
 583	u8 buf = 1;
 584
 585	snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
 586			USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
 587			0, 0, &buf, 1);
 588	if (buf == 0) {
 589		snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
 590				USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
 591				1, 2000, NULL, 0);
 592		return -ENODEV;
 593	}
 594	return 0;
 595}
 596
 597static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
 598{
 599	int err;
 600
 601	if (dev->actconfig->desc.bConfigurationValue == 1) {
 602		dev_info(&dev->dev,
 603			   "Fast Track Pro switching to config #2\n");
 604		/* This function has to be available by the usb core module.
 605		 * if it is not avialable the boot quirk has to be left out
 606		 * and the configuration has to be set by udev or hotplug
 607		 * rules
 608		 */
 609		err = usb_driver_set_configuration(dev, 2);
 610		if (err < 0)
 611			dev_dbg(&dev->dev,
 612				"error usb_driver_set_configuration: %d\n",
 613				err);
 614		/* Always return an error, so that we stop creating a device
 615		   that will just be destroyed and recreated with a new
 616		   configuration */
 617		return -ENODEV;
 618	} else
 619		dev_info(&dev->dev, "Fast Track Pro config OK\n");
 620
 621	return 0;
 622}
 623
 624/*
 625 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
 626 * documented in the device's data sheet.
 627 */
 628static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
 629{
 630	u8 buf[4];
 631	buf[0] = 0x20;
 632	buf[1] = value & 0xff;
 633	buf[2] = (value >> 8) & 0xff;
 634	buf[3] = reg;
 635	return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
 636			       USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
 637			       0, 0, &buf, 4);
 638}
 639
 640static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
 641{
 642	/*
 643	 * Enable line-out driver mode, set headphone source to front
 644	 * channels, enable stereo mic.
 645	 */
 646	return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
 647}
 648
 649/*
 650 * CM6206 registers from the CM6206 datasheet rev 2.1
 651 */
 652#define CM6206_REG0_DMA_MASTER BIT(15)
 653#define CM6206_REG0_SPDIFO_RATE_48K (2 << 12)
 654#define CM6206_REG0_SPDIFO_RATE_96K (7 << 12)
 655/* Bit 4 thru 11 is the S/PDIF category code */
 656#define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4)
 657#define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3)
 658#define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2)
 659#define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1)
 660#define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0)
 661
 662#define CM6206_REG1_TEST_SEL_CLK BIT(14)
 663#define CM6206_REG1_PLLBIN_EN BIT(13)
 664#define CM6206_REG1_SOFT_MUTE_EN BIT(12)
 665#define CM6206_REG1_GPIO4_OUT BIT(11)
 666#define CM6206_REG1_GPIO4_OE BIT(10)
 667#define CM6206_REG1_GPIO3_OUT BIT(9)
 668#define CM6206_REG1_GPIO3_OE BIT(8)
 669#define CM6206_REG1_GPIO2_OUT BIT(7)
 670#define CM6206_REG1_GPIO2_OE BIT(6)
 671#define CM6206_REG1_GPIO1_OUT BIT(5)
 672#define CM6206_REG1_GPIO1_OE BIT(4)
 673#define CM6206_REG1_SPDIFO_INVALID BIT(3)
 674#define CM6206_REG1_SPDIF_LOOP_EN BIT(2)
 675#define CM6206_REG1_SPDIFO_DIS BIT(1)
 676#define CM6206_REG1_SPDIFI_MIX BIT(0)
 677
 678#define CM6206_REG2_DRIVER_ON BIT(15)
 679#define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13)
 680#define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13)
 681#define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13)
 682#define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13)
 683#define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12)
 684#define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11)
 685#define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10)
 686#define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9)
 687#define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8)
 688#define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7)
 689#define CM6206_REG2_MUTE_SUBWOOFER BIT(6)
 690#define CM6206_REG2_MUTE_CENTER BIT(5)
 691#define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3)
 692#define CM6206_REG2_MUTE_LEFT_FRONT BIT(3)
 693#define CM6206_REG2_EN_BTL BIT(2)
 694#define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0)
 695#define CM6206_REG2_MCUCLKSEL_3_MHZ (1)
 696#define CM6206_REG2_MCUCLKSEL_6_MHZ (2)
 697#define CM6206_REG2_MCUCLKSEL_12_MHZ (3)
 698
 699/* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */
 700#define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11)
 701#define CM6206_REG3_VRAP25EN BIT(10)
 702#define CM6206_REG3_MSEL1 BIT(9)
 703#define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7)
 704#define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7)
 705#define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7)
 706#define CM6206_REG3_PINSEL BIT(6)
 707#define CM6206_REG3_FOE BIT(5)
 708#define CM6206_REG3_ROE BIT(4)
 709#define CM6206_REG3_CBOE BIT(3)
 710#define CM6206_REG3_LOSE BIT(2)
 711#define CM6206_REG3_HPOE BIT(1)
 712#define CM6206_REG3_SPDIFI_CANREC BIT(0)
 713
 714#define CM6206_REG5_DA_RSTN BIT(13)
 715#define CM6206_REG5_AD_RSTN BIT(12)
 716#define CM6206_REG5_SPDIFO_AD2SPDO BIT(12)
 717#define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9)
 718#define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9)
 719#define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9)
 720#define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9)
 721#define CM6206_REG5_CODECM BIT(8)
 722#define CM6206_REG5_EN_HPF BIT(7)
 723#define CM6206_REG5_T_SEL_DSDA4 BIT(6)
 724#define CM6206_REG5_T_SEL_DSDA3 BIT(5)
 725#define CM6206_REG5_T_SEL_DSDA2 BIT(4)
 726#define CM6206_REG5_T_SEL_DSDA1 BIT(3)
 727#define CM6206_REG5_T_SEL_DSDAD_NORMAL 0
 728#define CM6206_REG5_T_SEL_DSDAD_FRONT 4
 729#define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5
 730#define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6
 731#define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7
 732
 733static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
 734{
 735	int err  = 0, reg;
 736	int val[] = {
 737		/*
 738		 * Values here are chosen based on sniffing USB traffic
 739		 * under Windows.
 740		 *
 741		 * REG0: DAC is master, sample rate 48kHz, no copyright
 742		 */
 743		CM6206_REG0_SPDIFO_RATE_48K |
 744		CM6206_REG0_SPDIFO_COPYRIGHT_NA,
 745		/*
 746		 * REG1: PLL binary search enable, soft mute enable.
 747		 */
 748		CM6206_REG1_PLLBIN_EN |
 749		CM6206_REG1_SOFT_MUTE_EN,
 750		/*
 751		 * REG2: enable output drivers,
 752		 * select front channels to the headphone output,
 753		 * then mute the headphone channels, run the MCU
 754		 * at 1.5 MHz.
 755		 */
 756		CM6206_REG2_DRIVER_ON |
 757		CM6206_REG2_HEADP_SEL_FRONT_CHANNELS |
 758		CM6206_REG2_MUTE_HEADPHONE_RIGHT |
 759		CM6206_REG2_MUTE_HEADPHONE_LEFT,
 760		/*
 761		 * REG3: default flyspeed, set 2.5V mic bias
 762		 * enable all line out ports and enable SPDIF
 763		 */
 764		CM6206_REG3_FLYSPEED_DEFAULT |
 765		CM6206_REG3_VRAP25EN |
 766		CM6206_REG3_FOE |
 767		CM6206_REG3_ROE |
 768		CM6206_REG3_CBOE |
 769		CM6206_REG3_LOSE |
 770		CM6206_REG3_HPOE |
 771		CM6206_REG3_SPDIFI_CANREC,
 772		/* REG4 is just a bunch of GPIO lines */
 773		0x0000,
 774		/* REG5: de-assert AD/DA reset signals */
 775		CM6206_REG5_DA_RSTN |
 776		CM6206_REG5_AD_RSTN };
 777
 778	for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
 779		err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
 780		if (err < 0)
 781			return err;
 782	}
 783
 784	return err;
 785}
 786
 787/* quirk for Plantronics GameCom 780 with CM6302 chip */
 788static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
 789{
 790	/* set the initial volume and don't change; other values are either
 791	 * too loud or silent due to firmware bug (bko#65251)
 792	 */
 793	u8 buf[2] = { 0x74, 0xe3 };
 794	return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
 795			USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
 796			UAC_FU_VOLUME << 8, 9 << 8, buf, 2);
 797}
 798
 799/*
 800 * Novation Twitch DJ controller
 801 * Focusrite Novation Saffire 6 USB audio card
 802 */
 803static int snd_usb_novation_boot_quirk(struct usb_device *dev)
 804{
 805	/* preemptively set up the device because otherwise the
 806	 * raw MIDI endpoints are not active */
 807	usb_set_interface(dev, 0, 1);
 808	return 0;
 809}
 810
 811/*
 812 * This call will put the synth in "USB send" mode, i.e it will send MIDI
 813 * messages through USB (this is disabled at startup). The synth will
 814 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
 815 * sign on its LCD. Values here are chosen based on sniffing USB traffic
 816 * under Windows.
 817 */
 818static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
 819{
 820	int err, actual_length;
 821	/* "midi send" enable */
 822	static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
 823	void *buf;
 824
 825	if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x05)))
 826		return -EINVAL;
 827	buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
 828	if (!buf)
 829		return -ENOMEM;
 830	err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
 831			ARRAY_SIZE(seq), &actual_length, 1000);
 832	kfree(buf);
 833	if (err < 0)
 834		return err;
 835
 836	return 0;
 837}
 838
 839/*
 840 * Some sound cards from Native Instruments are in fact compliant to the USB
 841 * audio standard of version 2 and other approved USB standards, even though
 842 * they come up as vendor-specific device when first connected.
 843 *
 844 * However, they can be told to come up with a new set of descriptors
 845 * upon their next enumeration, and the interfaces announced by the new
 846 * descriptors will then be handled by the kernel's class drivers. As the
 847 * product ID will also change, no further checks are required.
 848 */
 849
 850static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
 851{
 852	int ret;
 853
 854	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 855				  0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 856				  1, 0, NULL, 0, 1000);
 857
 858	if (ret < 0)
 859		return ret;
 860
 861	usb_reset_device(dev);
 862
 863	/* return -EAGAIN, so the creation of an audio interface for this
 864	 * temporary device is aborted. The device will reconnect with a
 865	 * new product ID */
 866	return -EAGAIN;
 867}
 868
 869static void mbox2_setup_48_24_magic(struct usb_device *dev)
 870{
 871	u8 srate[3];
 872	u8 temp[12];
 873
 874	/* Choose 48000Hz permanently */
 875	srate[0] = 0x80;
 876	srate[1] = 0xbb;
 877	srate[2] = 0x00;
 878
 879	/* Send the magic! */
 880	snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
 881		0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
 882	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
 883		0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
 884	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
 885		0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
 886	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
 887		0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
 888	return;
 889}
 890
 891/* Digidesign Mbox 2 needs to load firmware onboard
 892 * and driver must wait a few seconds for initialisation.
 893 */
 894
 895#define MBOX2_FIRMWARE_SIZE    646
 896#define MBOX2_BOOT_LOADING     0x01 /* Hard coded into the device */
 897#define MBOX2_BOOT_READY       0x02 /* Hard coded into the device */
 898
 899static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
 900{
 901	struct usb_host_config *config = dev->actconfig;
 902	int err;
 903	u8 bootresponse[0x12];
 904	int fwsize;
 905	int count;
 906
 907	fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
 908
 909	if (fwsize != MBOX2_FIRMWARE_SIZE) {
 910		dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
 911		return -ENODEV;
 912	}
 913
 914	dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
 915
 916	count = 0;
 917	bootresponse[0] = MBOX2_BOOT_LOADING;
 918	while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
 919		msleep(500); /* 0.5 second delay */
 920		snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
 921			/* Control magic - load onboard firmware */
 922			0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
 923		if (bootresponse[0] == MBOX2_BOOT_READY)
 924			break;
 925		dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
 926		count++;
 927	}
 928
 929	if (bootresponse[0] != MBOX2_BOOT_READY) {
 930		dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
 931		return -ENODEV;
 932	}
 933
 934	dev_dbg(&dev->dev, "device initialised!\n");
 935
 936	err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
 937		&dev->descriptor, sizeof(dev->descriptor));
 938	config = dev->actconfig;
 939	if (err < 0)
 940		dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
 941
 942	err = usb_reset_configuration(dev);
 943	if (err < 0)
 944		dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
 945	dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
 946		le16_to_cpu(get_cfg_desc(config)->wTotalLength));
 947
 948	mbox2_setup_48_24_magic(dev);
 949
 950	dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
 951
 952	return 0; /* Successful boot */
 953}
 954
 955static int snd_usb_axefx3_boot_quirk(struct usb_device *dev)
 956{
 957	int err;
 958
 959	dev_dbg(&dev->dev, "Waiting for Axe-Fx III to boot up...\n");
 960
 961	/* If the Axe-Fx III has not fully booted, it will timeout when trying
 962	 * to enable the audio streaming interface. A more generous timeout is
 963	 * used here to detect when the Axe-Fx III has finished booting as the
 964	 * set interface message will be acked once it has
 965	 */
 966	err = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 967				USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
 968				1, 1, NULL, 0, 120000);
 969	if (err < 0) {
 970		dev_err(&dev->dev,
 971			"failed waiting for Axe-Fx III to boot: %d\n", err);
 972		return err;
 973	}
 974
 975	dev_dbg(&dev->dev, "Axe-Fx III is now ready\n");
 976
 977	err = usb_set_interface(dev, 1, 0);
 978	if (err < 0)
 979		dev_dbg(&dev->dev,
 980			"error stopping Axe-Fx III interface: %d\n", err);
 981
 982	return 0;
 983}
 984
 985static void mbox3_setup_48_24_magic(struct usb_device *dev)
 986{
 987	/* The Mbox 3 is "little endian" */
 988	/* max volume is: 0x0000. */
 989	/* min volume is: 0x0080 (shown in little endian form) */
 990
 991
 992	/* Load 48000Hz rate into buffer */
 993	u8 com_buff[4] = {0x80, 0xbb, 0x00, 0x00};
 994
 995	/* Set 48000Hz sample rate */
 996	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
 997			0x01, 0x21, 0x0100, 0x0001, &com_buff, 4);  //Is this really needed?
 998	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
 999			0x01, 0x21, 0x0100, 0x8101, &com_buff, 4);
1000
1001	/* Deactivate Tuner */
1002	/* on  = 0x01*/
1003	/* off = 0x00*/
1004	com_buff[0] = 0x00;
1005	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1006		0x01, 0x21, 0x0003, 0x2001, &com_buff, 1);
1007
1008	/* Set clock source to Internal (as opposed to S/PDIF) */
1009	com_buff[0] = 0x01;
1010	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1011			1, 0x21, 0x0100, 0x8001, &com_buff, 1);
1012
1013	/* Mute the hardware loopbacks to start the device in a known state. */
1014	com_buff[0] = 0x00;
1015	com_buff[1] = 0x80;
1016	/* Analogue input 1 left channel: */
1017	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1018			1, 0x21, 0x0110, 0x4001, &com_buff, 2);
1019	/* Analogue input 1 right channel: */
1020	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1021			1, 0x21, 0x0111, 0x4001, &com_buff, 2);
1022	/* Analogue input 2 left channel: */
1023	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1024			1, 0x21, 0x0114, 0x4001, &com_buff, 2);
1025	/* Analogue input 2 right channel: */
1026	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1027			1, 0x21, 0x0115, 0x4001, &com_buff, 2);
1028	/* Analogue input 3 left channel: */
1029	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1030			1, 0x21, 0x0118, 0x4001, &com_buff, 2);
1031	/* Analogue input 3 right channel: */
1032	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1033			1, 0x21, 0x0119, 0x4001, &com_buff, 2);
1034	/* Analogue input 4 left channel: */
1035	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1036			1, 0x21, 0x011c, 0x4001, &com_buff, 2);
1037	/* Analogue input 4 right channel: */
1038	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1039			1, 0x21, 0x011d, 0x4001, &com_buff, 2);
1040
1041	/* Set software sends to output */
1042	com_buff[0] = 0x00;
1043	com_buff[1] = 0x00;
1044	/* Analogue software return 1 left channel: */
1045	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1046			1, 0x21, 0x0100, 0x4001, &com_buff, 2);
1047	com_buff[0] = 0x00;
1048	com_buff[1] = 0x80;
1049	/* Analogue software return 1 right channel: */
1050	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1051			1, 0x21, 0x0101, 0x4001, &com_buff, 2);
1052	com_buff[0] = 0x00;
1053	com_buff[1] = 0x80;
1054	/* Analogue software return 2 left channel: */
1055	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1056			1, 0x21, 0x0104, 0x4001, &com_buff, 2);
1057	com_buff[0] = 0x00;
1058	com_buff[1] = 0x00;
1059	/* Analogue software return 2 right channel: */
1060	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1061			1, 0x21, 0x0105, 0x4001, &com_buff, 2);
1062
1063	com_buff[0] = 0x00;
1064	com_buff[1] = 0x80;
1065	/* Analogue software return 3 left channel: */
1066	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1067			1, 0x21, 0x0108, 0x4001, &com_buff, 2);
1068	/* Analogue software return 3 right channel: */
1069	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1070			1, 0x21, 0x0109, 0x4001, &com_buff, 2);
1071	/* Analogue software return 4 left channel: */
1072	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1073			1, 0x21, 0x010c, 0x4001, &com_buff, 2);
1074	/* Analogue software return 4 right channel: */
1075	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1076			1, 0x21, 0x010d, 0x4001, &com_buff, 2);
1077
1078	/* Return to muting sends */
1079	com_buff[0] = 0x00;
1080	com_buff[1] = 0x80;
1081	/* Analogue fx return left channel: */
1082	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1083			1, 0x21, 0x0120, 0x4001, &com_buff, 2);
1084	/* Analogue fx return right channel: */
1085	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1086			1, 0x21, 0x0121, 0x4001, &com_buff, 2);
1087
1088	/* Analogue software input 1 fx send: */
1089	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1090			1, 0x21, 0x0100, 0x4201, &com_buff, 2);
1091	/* Analogue software input 2 fx send: */
1092	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1093			1, 0x21, 0x0101, 0x4201, &com_buff, 2);
1094	/* Analogue software input 3 fx send: */
1095	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1096			1, 0x21, 0x0102, 0x4201, &com_buff, 2);
1097	/* Analogue software input 4 fx send: */
1098	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1099			1, 0x21, 0x0103, 0x4201, &com_buff, 2);
1100	/* Analogue input 1 fx send: */
1101	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1102			1, 0x21, 0x0104, 0x4201, &com_buff, 2);
1103	/* Analogue input 2 fx send: */
1104	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1105			1, 0x21, 0x0105, 0x4201, &com_buff, 2);
1106	/* Analogue input 3 fx send: */
1107	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1108			1, 0x21, 0x0106, 0x4201, &com_buff, 2);
1109	/* Analogue input 4 fx send: */
1110	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1111			1, 0x21, 0x0107, 0x4201, &com_buff, 2);
1112
1113	/* Toggle allowing host control */
1114	com_buff[0] = 0x02;
1115	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1116			3, 0x21, 0x0000, 0x2001, &com_buff, 1);
1117
1118	/* Do not dim fx returns */
1119	com_buff[0] = 0x00;
1120	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1121			3, 0x21, 0x0002, 0x2001, &com_buff, 1);
1122
1123	/* Do not set fx returns to mono */
1124	com_buff[0] = 0x00;
1125	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1126			3, 0x21, 0x0001, 0x2001, &com_buff, 1);
1127
1128	/* Mute the S/PDIF hardware loopback
1129	 * same odd volume logic here as above
1130	 */
1131	com_buff[0] = 0x00;
1132	com_buff[1] = 0x80;
1133	/* S/PDIF hardware input 1 left channel */
1134	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1135			1, 0x21, 0x0112, 0x4001, &com_buff, 2);
1136	/* S/PDIF hardware input 1 right channel */
1137	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1138			1, 0x21, 0x0113, 0x4001, &com_buff, 2);
1139	/* S/PDIF hardware input 2 left channel */
1140	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1141			1, 0x21, 0x0116, 0x4001, &com_buff, 2);
1142	/* S/PDIF hardware input 2 right channel */
1143	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1144			1, 0x21, 0x0117, 0x4001, &com_buff, 2);
1145	/* S/PDIF hardware input 3 left channel */
1146	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1147			1, 0x21, 0x011a, 0x4001, &com_buff, 2);
1148	/* S/PDIF hardware input 3 right channel */
1149	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1150			1, 0x21, 0x011b, 0x4001, &com_buff, 2);
1151	/* S/PDIF hardware input 4 left channel */
1152	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1153			1, 0x21, 0x011e, 0x4001, &com_buff, 2);
1154	/* S/PDIF hardware input 4 right channel */
1155	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1156			1, 0x21, 0x011f, 0x4001, &com_buff, 2);
1157	/* S/PDIF software return 1 left channel */
1158	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1159			1, 0x21, 0x0102, 0x4001, &com_buff, 2);
1160	/* S/PDIF software return 1 right channel */
1161	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1162			1, 0x21, 0x0103, 0x4001, &com_buff, 2);
1163	/* S/PDIF software return 2 left channel */
1164	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1165			1, 0x21, 0x0106, 0x4001, &com_buff, 2);
1166	/* S/PDIF software return 2 right channel */
1167	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1168			1, 0x21, 0x0107, 0x4001, &com_buff, 2);
1169
1170	com_buff[0] = 0x00;
1171	com_buff[1] = 0x00;
1172	/* S/PDIF software return 3 left channel */
1173	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1174			1, 0x21, 0x010a, 0x4001, &com_buff, 2);
1175
1176	com_buff[0] = 0x00;
1177	com_buff[1] = 0x80;
1178	/* S/PDIF software return 3 right channel */
1179	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1180			1, 0x21, 0x010b, 0x4001, &com_buff, 2);
1181	/* S/PDIF software return 4 left channel */
1182	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1183			1, 0x21, 0x010e, 0x4001, &com_buff, 2);
1184
1185	com_buff[0] = 0x00;
1186	com_buff[1] = 0x00;
1187	/* S/PDIF software return 4 right channel */
1188	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1189			1, 0x21, 0x010f, 0x4001, &com_buff, 2);
1190
1191	com_buff[0] = 0x00;
1192	com_buff[1] = 0x80;
1193	/* S/PDIF fx returns left channel */
1194	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1195			1, 0x21, 0x0122, 0x4001, &com_buff, 2);
1196	/* S/PDIF fx returns right channel */
1197	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1198			1, 0x21, 0x0123, 0x4001, &com_buff, 2);
1199
1200	/* Set the dropdown "Effect" to the first option */
1201	/* Room1  = 0x00 */
1202	/* Room2  = 0x01 */
1203	/* Room3  = 0x02 */
1204	/* Hall 1 = 0x03 */
1205	/* Hall 2 = 0x04 */
1206	/* Plate  = 0x05 */
1207	/* Delay  = 0x06 */
1208	/* Echo   = 0x07 */
1209	com_buff[0] = 0x00;
1210	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1211			1, 0x21, 0x0200, 0x4301, &com_buff, 1);	/* max is 0xff */
1212	/* min is 0x00 */
1213
1214
1215	/* Set the effect duration to 0 */
1216	/* max is 0xffff */
1217	/* min is 0x0000 */
1218	com_buff[0] = 0x00;
1219	com_buff[1] = 0x00;
1220	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1221			1, 0x21, 0x0400, 0x4301, &com_buff, 2);
1222
1223	/* Set the effect volume and feedback to 0 */
1224	/* max is 0xff */
1225	/* min is 0x00 */
1226	com_buff[0] = 0x00;
1227	/* feedback: */
1228	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1229			1, 0x21, 0x0500, 0x4301, &com_buff, 1);
1230	/* volume: */
1231	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1232			1, 0x21, 0x0300, 0x4301, &com_buff, 1);
1233
1234	/* Set soft button hold duration */
1235	/* 0x03 = 250ms */
1236	/* 0x05 = 500ms DEFAULT */
1237	/* 0x08 = 750ms */
1238	/* 0x0a = 1sec */
1239	com_buff[0] = 0x05;
1240	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1241			3, 0x21, 0x0005, 0x2001, &com_buff, 1);
1242
1243	/* Use dim LEDs for button of state */
1244	com_buff[0] = 0x00;
1245	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1246			3, 0x21, 0x0004, 0x2001, &com_buff, 1);
1247}
1248
1249#define MBOX3_DESCRIPTOR_SIZE	464
1250
1251static int snd_usb_mbox3_boot_quirk(struct usb_device *dev)
1252{
1253	struct usb_host_config *config = dev->actconfig;
1254	int err;
1255	int descriptor_size;
1256
1257	descriptor_size = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
1258
1259	if (descriptor_size != MBOX3_DESCRIPTOR_SIZE) {
1260		dev_err(&dev->dev, "Invalid descriptor size=%d.\n", descriptor_size);
1261		return -ENODEV;
1262	}
1263
1264	dev_dbg(&dev->dev, "device initialised!\n");
1265
1266	err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
1267		&dev->descriptor, sizeof(dev->descriptor));
1268	config = dev->actconfig;
1269	if (err < 0)
1270		dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
1271
1272	err = usb_reset_configuration(dev);
1273	if (err < 0)
1274		dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
1275	dev_dbg(&dev->dev, "mbox3_boot: new boot length = %d\n",
1276		le16_to_cpu(get_cfg_desc(config)->wTotalLength));
1277
1278	mbox3_setup_48_24_magic(dev);
1279	dev_info(&dev->dev, "Digidesign Mbox 3: 24bit 48kHz");
1280
1281	return 0; /* Successful boot */
1282}
1283
1284#define MICROBOOK_BUF_SIZE 128
1285
1286static int snd_usb_motu_microbookii_communicate(struct usb_device *dev, u8 *buf,
1287						int buf_size, int *length)
1288{
1289	int err, actual_length;
1290
1291	if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x01)))
1292		return -EINVAL;
1293	err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x01), buf, *length,
1294				&actual_length, 1000);
1295	if (err < 0)
1296		return err;
1297
1298	print_hex_dump(KERN_DEBUG, "MicroBookII snd: ", DUMP_PREFIX_NONE, 16, 1,
1299		       buf, actual_length, false);
1300
1301	memset(buf, 0, buf_size);
1302
1303	if (usb_pipe_type_check(dev, usb_rcvintpipe(dev, 0x82)))
1304		return -EINVAL;
1305	err = usb_interrupt_msg(dev, usb_rcvintpipe(dev, 0x82), buf, buf_size,
1306				&actual_length, 1000);
1307	if (err < 0)
1308		return err;
1309
1310	print_hex_dump(KERN_DEBUG, "MicroBookII rcv: ", DUMP_PREFIX_NONE, 16, 1,
1311		       buf, actual_length, false);
1312
1313	*length = actual_length;
1314	return 0;
1315}
1316
1317static int snd_usb_motu_microbookii_boot_quirk(struct usb_device *dev)
1318{
1319	int err, actual_length, poll_attempts = 0;
1320	static const u8 set_samplerate_seq[] = { 0x00, 0x00, 0x00, 0x00,
1321						 0x00, 0x00, 0x0b, 0x14,
1322						 0x00, 0x00, 0x00, 0x01 };
1323	static const u8 poll_ready_seq[] = { 0x00, 0x04, 0x00, 0x00,
1324					     0x00, 0x00, 0x0b, 0x18 };
1325	u8 *buf = kzalloc(MICROBOOK_BUF_SIZE, GFP_KERNEL);
1326
1327	if (!buf)
1328		return -ENOMEM;
1329
1330	dev_info(&dev->dev, "Waiting for MOTU Microbook II to boot up...\n");
1331
1332	/* First we tell the device which sample rate to use. */
1333	memcpy(buf, set_samplerate_seq, sizeof(set_samplerate_seq));
1334	actual_length = sizeof(set_samplerate_seq);
1335	err = snd_usb_motu_microbookii_communicate(dev, buf, MICROBOOK_BUF_SIZE,
1336						   &actual_length);
1337
1338	if (err < 0) {
1339		dev_err(&dev->dev,
1340			"failed setting the sample rate for Motu MicroBook II: %d\n",
1341			err);
1342		goto free_buf;
1343	}
1344
1345	/* Then we poll every 100 ms until the device informs of its readiness. */
1346	while (true) {
1347		if (++poll_attempts > 100) {
1348			dev_err(&dev->dev,
1349				"failed booting Motu MicroBook II: timeout\n");
1350			err = -ENODEV;
1351			goto free_buf;
1352		}
1353
1354		memset(buf, 0, MICROBOOK_BUF_SIZE);
1355		memcpy(buf, poll_ready_seq, sizeof(poll_ready_seq));
1356
1357		actual_length = sizeof(poll_ready_seq);
1358		err = snd_usb_motu_microbookii_communicate(
1359			dev, buf, MICROBOOK_BUF_SIZE, &actual_length);
1360		if (err < 0) {
1361			dev_err(&dev->dev,
1362				"failed booting Motu MicroBook II: communication error %d\n",
1363				err);
1364			goto free_buf;
1365		}
1366
1367		/* the device signals its readiness through a message of the
1368		 * form
1369		 *           XX 06 00 00 00 00 0b 18  00 00 00 01
1370		 * If the device is not yet ready to accept audio data, the
1371		 * last byte of that sequence is 00.
1372		 */
1373		if (actual_length == 12 && buf[actual_length - 1] == 1)
1374			break;
1375
1376		msleep(100);
1377	}
1378
1379	dev_info(&dev->dev, "MOTU MicroBook II ready\n");
1380
1381free_buf:
1382	kfree(buf);
1383	return err;
1384}
1385
1386static int snd_usb_motu_m_series_boot_quirk(struct usb_device *dev)
1387{
1388	msleep(2000);
1389
1390	return 0;
1391}
1392
1393/*
1394 * Setup quirks
1395 */
1396#define MAUDIO_SET		0x01 /* parse device_setup */
1397#define MAUDIO_SET_COMPATIBLE	0x80 /* use only "win-compatible" interfaces */
1398#define MAUDIO_SET_DTS		0x02 /* enable DTS Digital Output */
1399#define MAUDIO_SET_96K		0x04 /* 48-96kHz rate if set, 8-48kHz otherwise */
1400#define MAUDIO_SET_24B		0x08 /* 24bits sample if set, 16bits otherwise */
1401#define MAUDIO_SET_DI		0x10 /* enable Digital Input */
1402#define MAUDIO_SET_MASK		0x1f /* bit mask for setup value */
1403#define MAUDIO_SET_24B_48K_DI	 0x19 /* 24bits+48kHz+Digital Input */
1404#define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48kHz+No Digital Input */
1405#define MAUDIO_SET_16B_48K_DI	 0x11 /* 16bits+48kHz+Digital Input */
1406#define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48kHz+No Digital Input */
1407
1408static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
1409				      int iface, int altno)
1410{
1411	/* Reset ALL ifaces to 0 altsetting.
1412	 * Call it for every possible altsetting of every interface.
1413	 */
1414	usb_set_interface(chip->dev, iface, 0);
1415	if (chip->setup & MAUDIO_SET) {
1416		if (chip->setup & MAUDIO_SET_COMPATIBLE) {
1417			if (iface != 1 && iface != 2)
1418				return 1; /* skip all interfaces but 1 and 2 */
1419		} else {
1420			unsigned int mask;
1421			if (iface == 1 || iface == 2)
1422				return 1; /* skip interfaces 1 and 2 */
1423			if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1424				return 1; /* skip this altsetting */
1425			mask = chip->setup & MAUDIO_SET_MASK;
1426			if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1427				return 1; /* skip this altsetting */
1428			if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1429				return 1; /* skip this altsetting */
1430			if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
1431				return 1; /* skip this altsetting */
1432		}
1433	}
1434	usb_audio_dbg(chip,
1435		    "using altsetting %d for interface %d config %d\n",
1436		    altno, iface, chip->setup);
1437	return 0; /* keep this altsetting */
1438}
1439
1440static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
1441					 int iface,
1442					 int altno)
1443{
1444	/* Reset ALL ifaces to 0 altsetting.
1445	 * Call it for every possible altsetting of every interface.
1446	 */
1447	usb_set_interface(chip->dev, iface, 0);
1448
1449	if (chip->setup & MAUDIO_SET) {
1450		unsigned int mask;
1451		if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
1452			return 1; /* skip this altsetting */
1453		if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1454			return 1; /* skip this altsetting */
1455		mask = chip->setup & MAUDIO_SET_MASK;
1456		if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1457			return 1; /* skip this altsetting */
1458		if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1459			return 1; /* skip this altsetting */
1460		if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
1461			return 1; /* skip this altsetting */
1462		if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
1463			return 1; /* skip this altsetting */
1464	}
1465
1466	return 0; /* keep this altsetting */
1467}
1468
1469static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
1470					   int iface, int altno)
1471{
1472	/* Reset ALL ifaces to 0 altsetting.
1473	 * Call it for every possible altsetting of every interface.
1474	 */
1475	usb_set_interface(chip->dev, iface, 0);
1476
1477	/* possible configuration where both inputs and only one output is
1478	 *used is not supported by the current setup
1479	 */
1480	if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
1481		if (chip->setup & MAUDIO_SET_96K) {
1482			if (altno != 3 && altno != 6)
1483				return 1;
1484		} else if (chip->setup & MAUDIO_SET_DI) {
1485			if (iface == 4)
1486				return 1; /* no analog input */
1487			if (altno != 2 && altno != 5)
1488				return 1; /* enable only altsets 2 and 5 */
1489		} else {
1490			if (iface == 5)
1491				return 1; /* disable digialt input */
1492			if (altno != 2 && altno != 5)
1493				return 1; /* enalbe only altsets 2 and 5 */
1494		}
1495	} else {
1496		/* keep only 16-Bit mode */
1497		if (altno != 1)
1498			return 1;
1499	}
1500
1501	usb_audio_dbg(chip,
1502		    "using altsetting %d for interface %d config %d\n",
1503		    altno, iface, chip->setup);
1504	return 0; /* keep this altsetting */
1505}
1506
1507static int s1810c_skip_setting_quirk(struct snd_usb_audio *chip,
1508					   int iface, int altno)
1509{
1510	/*
1511	 * Altno settings:
1512	 *
1513	 * Playback (Interface 1):
1514	 * 1: 6 Analog + 2 S/PDIF
1515	 * 2: 6 Analog + 2 S/PDIF
1516	 * 3: 6 Analog
1517	 *
1518	 * Capture (Interface 2):
1519	 * 1: 8 Analog + 2 S/PDIF + 8 ADAT
1520	 * 2: 8 Analog + 2 S/PDIF + 4 ADAT
1521	 * 3: 8 Analog
1522	 */
1523
1524	/*
1525	 * I'll leave 2 as the default one and
1526	 * use device_setup to switch to the
1527	 * other two.
1528	 */
1529	if ((chip->setup == 0 || chip->setup > 2) && altno != 2)
1530		return 1;
1531	else if (chip->setup == 1 && altno != 1)
1532		return 1;
1533	else if (chip->setup == 2 && altno != 3)
1534		return 1;
1535
1536	return 0;
1537}
1538
1539int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
1540				  int iface,
1541				  int altno)
1542{
1543	/* audiophile usb: skip altsets incompatible with device_setup */
1544	if (chip->usb_id == USB_ID(0x0763, 0x2003))
1545		return audiophile_skip_setting_quirk(chip, iface, altno);
1546	/* quattro usb: skip altsets incompatible with device_setup */
1547	if (chip->usb_id == USB_ID(0x0763, 0x2001))
1548		return quattro_skip_setting_quirk(chip, iface, altno);
1549	/* fasttrackpro usb: skip altsets incompatible with device_setup */
1550	if (chip->usb_id == USB_ID(0x0763, 0x2012))
1551		return fasttrackpro_skip_setting_quirk(chip, iface, altno);
1552	/* presonus studio 1810c: skip altsets incompatible with device_setup */
1553	if (chip->usb_id == USB_ID(0x194f, 0x010c))
1554		return s1810c_skip_setting_quirk(chip, iface, altno);
1555
1556
1557	return 0;
1558}
1559
1560int snd_usb_apply_boot_quirk(struct usb_device *dev,
1561			     struct usb_interface *intf,
1562			     const struct snd_usb_audio_quirk *quirk,
1563			     unsigned int id)
1564{
1565	switch (id) {
1566	case USB_ID(0x041e, 0x3000):
1567		/* SB Extigy needs special boot-up sequence */
1568		/* if more models come, this will go to the quirk list. */
1569		return snd_usb_extigy_boot_quirk(dev, intf);
1570
1571	case USB_ID(0x041e, 0x3020):
1572		/* SB Audigy 2 NX needs its own boot-up magic, too */
1573		return snd_usb_audigy2nx_boot_quirk(dev);
1574
1575	case USB_ID(0x10f5, 0x0200):
1576		/* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1577		return snd_usb_cm106_boot_quirk(dev);
1578
1579	case USB_ID(0x0d8c, 0x0102):
1580		/* C-Media CM6206 / CM106-Like Sound Device */
1581	case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1582		return snd_usb_cm6206_boot_quirk(dev);
1583
1584	case USB_ID(0x0dba, 0x3000):
1585		/* Digidesign Mbox 2 */
1586		return snd_usb_mbox2_boot_quirk(dev);
1587	case USB_ID(0x0dba, 0x5000):
1588		/* Digidesign Mbox 3 */
1589		return snd_usb_mbox3_boot_quirk(dev);
1590
1591
1592	case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1593	case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1594		return snd_usb_novation_boot_quirk(dev);
1595
1596	case USB_ID(0x133e, 0x0815):
1597		/* Access Music VirusTI Desktop */
1598		return snd_usb_accessmusic_boot_quirk(dev);
1599
1600	case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1601	case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1602	case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1603		return snd_usb_nativeinstruments_boot_quirk(dev);
1604	case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
1605		return snd_usb_fasttrackpro_boot_quirk(dev);
1606	case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1607		return snd_usb_gamecon780_boot_quirk(dev);
1608	case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1609		return snd_usb_axefx3_boot_quirk(dev);
1610	case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
1611		/*
1612		 * For some reason interface 3 with vendor-spec class is
1613		 * detected on MicroBook IIc.
1614		 */
1615		if (get_iface_desc(intf->altsetting)->bInterfaceClass ==
1616		    USB_CLASS_VENDOR_SPEC &&
1617		    get_iface_desc(intf->altsetting)->bInterfaceNumber < 3)
1618			return snd_usb_motu_microbookii_boot_quirk(dev);
1619		break;
1620	}
1621
1622	return 0;
1623}
1624
1625int snd_usb_apply_boot_quirk_once(struct usb_device *dev,
1626				  struct usb_interface *intf,
1627				  const struct snd_usb_audio_quirk *quirk,
1628				  unsigned int id)
1629{
1630	switch (id) {
1631	case USB_ID(0x07fd, 0x0008): /* MOTU M Series */
1632		return snd_usb_motu_m_series_boot_quirk(dev);
1633	}
1634
1635	return 0;
1636}
1637
1638/*
1639 * check if the device uses big-endian samples
1640 */
1641int snd_usb_is_big_endian_format(struct snd_usb_audio *chip,
1642				 const struct audioformat *fp)
1643{
1644	/* it depends on altsetting whether the device is big-endian or not */
1645	switch (chip->usb_id) {
1646	case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1647		if (fp->altsetting == 2 || fp->altsetting == 3 ||
1648			fp->altsetting == 5 || fp->altsetting == 6)
1649			return 1;
1650		break;
1651	case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1652		if (chip->setup == 0x00 ||
1653			fp->altsetting == 1 || fp->altsetting == 2 ||
1654			fp->altsetting == 3)
1655			return 1;
1656		break;
1657	case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1658		if (fp->altsetting == 2 || fp->altsetting == 3 ||
1659			fp->altsetting == 5 || fp->altsetting == 6)
1660			return 1;
1661		break;
1662	}
1663	return 0;
1664}
1665
1666/*
1667 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1668 * not for interface.
1669 */
1670
1671enum {
1672	EMU_QUIRK_SR_44100HZ = 0,
1673	EMU_QUIRK_SR_48000HZ,
1674	EMU_QUIRK_SR_88200HZ,
1675	EMU_QUIRK_SR_96000HZ,
1676	EMU_QUIRK_SR_176400HZ,
1677	EMU_QUIRK_SR_192000HZ
1678};
1679
1680static void set_format_emu_quirk(struct snd_usb_substream *subs,
1681				 const struct audioformat *fmt)
1682{
1683	unsigned char emu_samplerate_id = 0;
1684
1685	/* When capture is active
1686	 * sample rate shouldn't be changed
1687	 * by playback substream
1688	 */
1689	if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1690		if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].cur_audiofmt)
1691			return;
1692	}
1693
1694	switch (fmt->rate_min) {
1695	case 48000:
1696		emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1697		break;
1698	case 88200:
1699		emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1700		break;
1701	case 96000:
1702		emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1703		break;
1704	case 176400:
1705		emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1706		break;
1707	case 192000:
1708		emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1709		break;
1710	default:
1711		emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1712		break;
1713	}
1714	snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
1715	subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
1716}
1717
1718static int pioneer_djm_set_format_quirk(struct snd_usb_substream *subs,
1719					u16 windex)
1720{
1721	unsigned int cur_rate = subs->data_endpoint->cur_rate;
1722	u8 sr[3];
1723	// Convert to little endian
1724	sr[0] = cur_rate & 0xff;
1725	sr[1] = (cur_rate >> 8) & 0xff;
1726	sr[2] = (cur_rate >> 16) & 0xff;
1727	usb_set_interface(subs->dev, 0, 1);
1728	// we should derive windex from fmt-sync_ep but it's not set
1729	snd_usb_ctl_msg(subs->stream->chip->dev,
1730		usb_sndctrlpipe(subs->stream->chip->dev, 0),
1731		0x01, 0x22, 0x0100, windex, &sr, 0x0003);
1732	return 0;
1733}
1734
1735void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1736			      const struct audioformat *fmt)
1737{
1738	switch (subs->stream->chip->usb_id) {
1739	case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1740	case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1741	case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1742	case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1743		set_format_emu_quirk(subs, fmt);
1744		break;
1745	case USB_ID(0x534d, 0x0021): /* MacroSilicon MS2100/MS2106 */
1746	case USB_ID(0x534d, 0x2109): /* MacroSilicon MS2109 */
1747		subs->stream_offset_adj = 2;
1748		break;
1749	case USB_ID(0x2b73, 0x0013): /* Pioneer DJM-450 */
1750		pioneer_djm_set_format_quirk(subs, 0x0082);
1751		break;
1752	case USB_ID(0x08e4, 0x017f): /* Pioneer DJM-750 */
1753	case USB_ID(0x08e4, 0x0163): /* Pioneer DJM-850 */
1754		pioneer_djm_set_format_quirk(subs, 0x0086);
1755		break;
1756	}
1757}
1758
1759int snd_usb_select_mode_quirk(struct snd_usb_audio *chip,
1760			      const struct audioformat *fmt)
1761{
1762	struct usb_device *dev = chip->dev;
1763	int err;
1764
1765	if (chip->quirk_flags & QUIRK_FLAG_ITF_USB_DSD_DAC) {
1766		/* First switch to alt set 0, otherwise the mode switch cmd
1767		 * will not be accepted by the DAC
1768		 */
1769		err = usb_set_interface(dev, fmt->iface, 0);
1770		if (err < 0)
1771			return err;
1772
1773		msleep(20); /* Delay needed after setting the interface */
1774
1775		/* Vendor mode switch cmd is required. */
1776		if (fmt->formats & SNDRV_PCM_FMTBIT_DSD_U32_BE) {
1777			/* DSD mode (DSD_U32) requested */
1778			err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1779					      USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1780					      1, 1, NULL, 0);
1781			if (err < 0)
1782				return err;
1783
1784		} else {
1785			/* PCM or DOP mode (S32) requested */
1786			/* PCM mode (S16) requested */
1787			err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1788					      USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1789					      0, 1, NULL, 0);
1790			if (err < 0)
1791				return err;
1792
1793		}
1794		msleep(20);
1795	}
1796	return 0;
1797}
1798
1799void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1800{
1801	/*
1802	 * "Playback Design" products send bogus feedback data at the start
1803	 * of the stream. Ignore them.
1804	 */
1805	if (USB_ID_VENDOR(ep->chip->usb_id) == 0x23ba &&
1806	    ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1807		ep->skip_packets = 4;
1808
1809	/*
1810	 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1811	 * world latency varies by approx. +/- 50 frames (at 96kHz) each time
1812	 * the stream is (re)started. When skipping packets 16 at endpoint
1813	 * start up, the real world latency is stable within +/- 1 frame (also
1814	 * across power cycles).
1815	 */
1816	if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1817	     ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
1818	    ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1819		ep->skip_packets = 16;
1820
1821	/* Work around devices that report unreasonable feedback data */
1822	if ((ep->chip->usb_id == USB_ID(0x0644, 0x8038) ||  /* TEAC UD-H01 */
1823	     ep->chip->usb_id == USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
1824	    ep->syncmaxsize == 4)
1825		ep->tenor_fb_quirk = 1;
1826}
1827
1828/* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
1829void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1830			   __u8 request, __u8 requesttype, __u16 value,
1831			   __u16 index, void *data, __u16 size)
1832{
1833	struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1834
1835	if (!chip || (requesttype & USB_TYPE_MASK) != USB_TYPE_CLASS)
1836		return;
1837
1838	if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY)
1839		msleep(20);
1840	else if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY_1M)
1841		usleep_range(1000, 2000);
1842	else if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY_5M)
1843		usleep_range(5000, 6000);
1844}
1845
1846/*
1847 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1848 * augment the PCM format bit-field for DSD types. The UAC standards
1849 * don't have a designated bit field to denote DSD-capable interfaces,
1850 * hence all hardware that is known to support this format has to be
1851 * listed here.
1852 */
1853u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1854					struct audioformat *fp,
1855					unsigned int sample_bytes)
1856{
1857	struct usb_interface *iface;
1858
1859	/* Playback Designs */
1860	if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1861	    USB_ID_PRODUCT(chip->usb_id) < 0x0110) {
1862		switch (fp->altsetting) {
1863		case 1:
1864			fp->dsd_dop = true;
1865			return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1866		case 2:
1867			fp->dsd_bitrev = true;
1868			return SNDRV_PCM_FMTBIT_DSD_U8;
1869		case 3:
1870			fp->dsd_bitrev = true;
1871			return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1872		}
1873	}
1874
1875	/* XMOS based USB DACs */
1876	switch (chip->usb_id) {
1877	case USB_ID(0x1511, 0x0037): /* AURALiC VEGA */
1878	case USB_ID(0x21ed, 0xd75a): /* Accuphase DAC-60 option card */
 
 
1879	case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
1880	case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
1881		if (fp->altsetting == 2)
1882			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1883		break;
1884
1885	case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
1886	case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
1887	case USB_ID(0x16d0, 0x06b2): /* NuPrime DAC-10 */
1888	case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
1889	case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
 
1890	case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
 
1891	case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
 
1892	case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
1893	case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
1894	case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
1895	case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
 
1896	case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
1897	case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
1898	case USB_ID(0x6b42, 0x0042): /* MSB Technology */
1899		if (fp->altsetting == 3)
1900			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1901		break;
1902
1903	/* Amanero Combo384 USB based DACs with native DSD support */
1904	case USB_ID(0x16d0, 0x071a):  /* Amanero - Combo384 */
1905	case USB_ID(0x2ab6, 0x0004):  /* T+A DAC8DSD-V2.0, MP1000E-V2.0, MP2000R-V2.0, MP2500R-V2.0, MP3100HV-V2.0 */
1906	case USB_ID(0x2ab6, 0x0005):  /* T+A USB HD Audio 1 */
1907	case USB_ID(0x2ab6, 0x0006):  /* T+A USB HD Audio 2 */
1908		if (fp->altsetting == 2) {
1909			switch (le16_to_cpu(chip->dev->descriptor.bcdDevice)) {
1910			case 0x199:
1911				return SNDRV_PCM_FMTBIT_DSD_U32_LE;
1912			case 0x19b:
1913			case 0x203:
1914				return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1915			default:
1916				break;
1917			}
1918		}
1919		break;
1920	case USB_ID(0x16d0, 0x0a23):
1921		if (fp->altsetting == 2)
1922			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1923		break;
1924
1925	default:
1926		break;
1927	}
1928
1929	/* ITF-USB DSD based DACs */
1930	if (chip->quirk_flags & QUIRK_FLAG_ITF_USB_DSD_DAC) {
1931		iface = usb_ifnum_to_if(chip->dev, fp->iface);
1932
1933		/* Altsetting 2 support native DSD if the num of altsets is
1934		 * three (0-2),
1935		 * Altsetting 3 support native DSD if the num of altsets is
1936		 * four (0-3).
1937		 */
1938		if (fp->altsetting == iface->num_altsetting - 1)
1939			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1940	}
1941
1942	/* Mostly generic method to detect many DSD-capable implementations */
1943	if ((chip->quirk_flags & QUIRK_FLAG_DSD_RAW) && fp->dsd_raw)
1944		return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1945
1946	return 0;
1947}
1948
1949void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio *chip,
1950					  struct audioformat *fp,
1951					  int stream)
1952{
1953	switch (chip->usb_id) {
1954	case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
1955		/* Optoplay sets the sample rate attribute although
1956		 * it seems not supporting it in fact.
1957		 */
1958		fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
1959		break;
1960	case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
1961	case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1962		/* doesn't set the sample rate attribute, but supports it */
1963		fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
1964		break;
1965	case USB_ID(0x0763, 0x2001):  /* M-Audio Quattro USB */
1966	case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
1967	case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
1968	case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
1969					an older model 77d:223) */
1970	/*
1971	 * plantronics headset and Griffin iMic have set adaptive-in
1972	 * although it's really not...
1973	 */
1974		fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
1975		if (stream == SNDRV_PCM_STREAM_PLAYBACK)
1976			fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
1977		else
1978			fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
1979		break;
1980	case USB_ID(0x07fd, 0x0004):  /* MOTU MicroBook IIc */
1981		/*
1982		 * MaxPacketsOnly attribute is erroneously set in endpoint
1983		 * descriptors. As a result this card produces noise with
1984		 * all sample rates other than 96 kHz.
1985		 */
1986		fp->attributes &= ~UAC_EP_CS_ATTR_FILL_MAX;
1987		break;
1988	case USB_ID(0x1224, 0x2a25):  /* Jieli Technology USB PHY 2.0 */
1989		/* mic works only when ep packet size is set to wMaxPacketSize */
1990		fp->attributes |= UAC_EP_CS_ATTR_FILL_MAX;
1991		break;
1992
 
 
 
 
1993	}
1994}
1995
1996/*
1997 * driver behavior quirk flags
1998 */
1999struct usb_audio_quirk_flags_table {
2000	u32 id;
2001	u32 flags;
2002};
2003
2004#define DEVICE_FLG(vid, pid, _flags) \
2005	{ .id = USB_ID(vid, pid), .flags = (_flags) }
2006#define VENDOR_FLG(vid, _flags) DEVICE_FLG(vid, 0, _flags)
2007
2008static const struct usb_audio_quirk_flags_table quirk_flags_table[] = {
2009	/* Device matches */
2010	DEVICE_FLG(0x041e, 0x3000, /* Creative SB Extigy */
2011		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2012	DEVICE_FLG(0x041e, 0x4080, /* Creative Live Cam VF0610 */
2013		   QUIRK_FLAG_GET_SAMPLE_RATE),
 
 
 
2014	DEVICE_FLG(0x046d, 0x084c, /* Logitech ConferenceCam Connect */
2015		   QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY_1M),
2016	DEVICE_FLG(0x046d, 0x0991, /* Logitech QuickCam Pro */
2017		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_IGNORE_CTL_ERROR),
2018	DEVICE_FLG(0x046d, 0x09a4, /* Logitech QuickCam E 3500 */
2019		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_IGNORE_CTL_ERROR),
2020	DEVICE_FLG(0x0499, 0x1509, /* Steinberg UR22 */
2021		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
 
 
2022	DEVICE_FLG(0x04d8, 0xfeea, /* Benchmark DAC1 Pre */
2023		   QUIRK_FLAG_GET_SAMPLE_RATE),
2024	DEVICE_FLG(0x04e8, 0xa051, /* Samsung USBC Headset (AKG) */
2025		   QUIRK_FLAG_SKIP_CLOCK_SELECTOR | QUIRK_FLAG_CTL_MSG_DELAY_5M),
 
 
2026	DEVICE_FLG(0x054c, 0x0b8c, /* Sony WALKMAN NW-A45 DAC */
2027		   QUIRK_FLAG_SET_IFACE_FIRST),
2028	DEVICE_FLG(0x0556, 0x0014, /* Phoenix Audio TMX320VC */
2029		   QUIRK_FLAG_GET_SAMPLE_RATE),
2030	DEVICE_FLG(0x05a3, 0x9420, /* ELP HD USB Camera */
2031		   QUIRK_FLAG_GET_SAMPLE_RATE),
2032	DEVICE_FLG(0x05a7, 0x1020, /* Bose Companion 5 */
2033		   QUIRK_FLAG_GET_SAMPLE_RATE),
2034	DEVICE_FLG(0x05e1, 0x0408, /* Syntek STK1160 */
2035		   QUIRK_FLAG_ALIGN_TRANSFER),
2036	DEVICE_FLG(0x05e1, 0x0480, /* Hauppauge Woodbury */
2037		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2038	DEVICE_FLG(0x0644, 0x8043, /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
2039		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2040		   QUIRK_FLAG_IFACE_DELAY),
2041	DEVICE_FLG(0x0644, 0x8044, /* Esoteric D-05X */
2042		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2043		   QUIRK_FLAG_IFACE_DELAY),
2044	DEVICE_FLG(0x0644, 0x804a, /* TEAC UD-301 */
2045		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2046		   QUIRK_FLAG_IFACE_DELAY),
2047	DEVICE_FLG(0x0644, 0x805f, /* TEAC Model 12 */
2048		   QUIRK_FLAG_FORCE_IFACE_RESET),
 
 
 
2049	DEVICE_FLG(0x06f8, 0xb000, /* Hercules DJ Console (Windows Edition) */
2050		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2051	DEVICE_FLG(0x06f8, 0xd002, /* Hercules DJ Console (Macintosh Edition) */
2052		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2053	DEVICE_FLG(0x0711, 0x5800, /* MCT Trigger 5 USB-to-HDMI */
2054		   QUIRK_FLAG_GET_SAMPLE_RATE),
2055	DEVICE_FLG(0x074d, 0x3553, /* Outlaw RR2150 (Micronas UAC3553B) */
2056		   QUIRK_FLAG_GET_SAMPLE_RATE),
2057	DEVICE_FLG(0x0763, 0x2030, /* M-Audio Fast Track C400 */
2058		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2059	DEVICE_FLG(0x0763, 0x2031, /* M-Audio Fast Track C600 */
2060		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
 
 
2061	DEVICE_FLG(0x08bb, 0x2702, /* LineX FM Transmitter */
2062		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2063	DEVICE_FLG(0x0951, 0x16ad, /* Kingston HyperX */
2064		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2065	DEVICE_FLG(0x0b0e, 0x0349, /* Jabra 550a */
2066		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
 
 
 
 
2067	DEVICE_FLG(0x0fd9, 0x0008, /* Hauppauge HVR-950Q */
2068		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
 
 
2069	DEVICE_FLG(0x1395, 0x740a, /* Sennheiser DECT */
2070		   QUIRK_FLAG_GET_SAMPLE_RATE),
2071	DEVICE_FLG(0x1397, 0x0507, /* Behringer UMC202HD */
2072		   QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2073	DEVICE_FLG(0x1397, 0x0508, /* Behringer UMC204HD */
2074		   QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2075	DEVICE_FLG(0x1397, 0x0509, /* Behringer UMC404HD */
2076		   QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2077	DEVICE_FLG(0x13e5, 0x0001, /* Serato Phono */
2078		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2079	DEVICE_FLG(0x154e, 0x1002, /* Denon DCD-1500RE */
2080		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2081	DEVICE_FLG(0x154e, 0x1003, /* Denon DA-300USB */
2082		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2083	DEVICE_FLG(0x154e, 0x3005, /* Marantz HD-DAC1 */
2084		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2085	DEVICE_FLG(0x154e, 0x3006, /* Marantz SA-14S1 */
2086		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
 
 
2087	DEVICE_FLG(0x154e, 0x500e, /* Denon DN-X1600 */
2088		   QUIRK_FLAG_IGNORE_CLOCK_SOURCE),
2089	DEVICE_FLG(0x1686, 0x00dd, /* Zoom R16/24 */
2090		   QUIRK_FLAG_TX_LENGTH | QUIRK_FLAG_CTL_MSG_DELAY_1M),
2091	DEVICE_FLG(0x17aa, 0x1046, /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
2092		   QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2093	DEVICE_FLG(0x17aa, 0x104d, /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
2094		   QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2095	DEVICE_FLG(0x1852, 0x5065, /* Luxman DA-06 */
2096		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2097	DEVICE_FLG(0x1901, 0x0191, /* GE B850V3 CP2114 audio interface */
2098		   QUIRK_FLAG_GET_SAMPLE_RATE),
 
 
 
 
2099	DEVICE_FLG(0x2040, 0x7200, /* Hauppauge HVR-950Q */
2100		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2101	DEVICE_FLG(0x2040, 0x7201, /* Hauppauge HVR-950Q-MXL */
2102		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2103	DEVICE_FLG(0x2040, 0x7210, /* Hauppauge HVR-950Q */
2104		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2105	DEVICE_FLG(0x2040, 0x7211, /* Hauppauge HVR-950Q-MXL */
2106		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2107	DEVICE_FLG(0x2040, 0x7213, /* Hauppauge HVR-950Q */
2108		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2109	DEVICE_FLG(0x2040, 0x7217, /* Hauppauge HVR-950Q */
2110		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2111	DEVICE_FLG(0x2040, 0x721b, /* Hauppauge HVR-950Q */
2112		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2113	DEVICE_FLG(0x2040, 0x721e, /* Hauppauge HVR-950Q */
2114		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2115	DEVICE_FLG(0x2040, 0x721f, /* Hauppauge HVR-950Q */
2116		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2117	DEVICE_FLG(0x2040, 0x7240, /* Hauppauge HVR-850 */
2118		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2119	DEVICE_FLG(0x2040, 0x7260, /* Hauppauge HVR-950Q */
2120		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2121	DEVICE_FLG(0x2040, 0x7270, /* Hauppauge HVR-950Q */
2122		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2123	DEVICE_FLG(0x2040, 0x7280, /* Hauppauge HVR-950Q */
2124		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2125	DEVICE_FLG(0x2040, 0x7281, /* Hauppauge HVR-950Q-MXL */
2126		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2127	DEVICE_FLG(0x2040, 0x8200, /* Hauppauge Woodbury */
2128		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2129	DEVICE_FLG(0x21b4, 0x0081, /* AudioQuest DragonFly */
2130		   QUIRK_FLAG_GET_SAMPLE_RATE),
 
 
 
 
2131	DEVICE_FLG(0x2522, 0x0007, /* LH Labs Geek Out HD Audio 1V5 */
2132		   QUIRK_FLAG_SET_IFACE_FIRST),
2133	DEVICE_FLG(0x2708, 0x0002, /* Audient iD14 */
2134		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2135	DEVICE_FLG(0x2912, 0x30c8, /* Audioengine D1 */
2136		   QUIRK_FLAG_GET_SAMPLE_RATE),
 
 
 
 
 
 
2137	DEVICE_FLG(0x30be, 0x0101, /* Schiit Hel */
2138		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2139	DEVICE_FLG(0x413c, 0xa506, /* Dell AE515 sound bar */
2140		   QUIRK_FLAG_GET_SAMPLE_RATE),
2141	DEVICE_FLG(0x534d, 0x0021, /* MacroSilicon MS2100/MS2106 */
2142		   QUIRK_FLAG_ALIGN_TRANSFER),
2143	DEVICE_FLG(0x534d, 0x2109, /* MacroSilicon MS2109 */
2144		   QUIRK_FLAG_ALIGN_TRANSFER),
2145	DEVICE_FLG(0x1224, 0x2a25, /* Jieli Technology USB PHY 2.0 */
2146		   QUIRK_FLAG_GET_SAMPLE_RATE),
2147	DEVICE_FLG(0x2b53, 0x0023, /* Fiero SC-01 (firmware v1.0.0 @ 48 kHz) */
2148		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2149	DEVICE_FLG(0x2b53, 0x0024, /* Fiero SC-01 (firmware v1.0.0 @ 96 kHz) */
2150		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2151	DEVICE_FLG(0x2b53, 0x0031, /* Fiero SC-01 (firmware v1.1.0) */
2152		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2153	DEVICE_FLG(0x0525, 0xa4ad, /* Hamedal C20 usb camero */
2154		   QUIRK_FLAG_IFACE_SKIP_CLOSE),
2155	DEVICE_FLG(0x0ecb, 0x205c, /* JBL Quantum610 Wireless */
2156		   QUIRK_FLAG_FIXED_RATE),
2157	DEVICE_FLG(0x0ecb, 0x2069, /* JBL Quantum810 Wireless */
2158		   QUIRK_FLAG_FIXED_RATE),
2159
2160	/* Vendor matches */
2161	VENDOR_FLG(0x045e, /* MS Lifecam */
2162		   QUIRK_FLAG_GET_SAMPLE_RATE),
2163	VENDOR_FLG(0x046d, /* Logitech */
2164		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2165	VENDOR_FLG(0x047f, /* Plantronics */
2166		   QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY),
2167	VENDOR_FLG(0x0644, /* TEAC Corp. */
2168		   QUIRK_FLAG_CTL_MSG_DELAY | QUIRK_FLAG_IFACE_DELAY),
2169	VENDOR_FLG(0x07fd, /* MOTU */
2170		   QUIRK_FLAG_VALIDATE_RATES),
2171	VENDOR_FLG(0x1235, /* Focusrite Novation */
2172		   QUIRK_FLAG_VALIDATE_RATES),
 
 
2173	VENDOR_FLG(0x152a, /* Thesycon devices */
2174		   QUIRK_FLAG_DSD_RAW),
 
 
2175	VENDOR_FLG(0x1de7, /* Phoenix Audio */
2176		   QUIRK_FLAG_GET_SAMPLE_RATE),
2177	VENDOR_FLG(0x20b1, /* XMOS based devices */
2178		   QUIRK_FLAG_DSD_RAW),
 
 
2179	VENDOR_FLG(0x22d9, /* Oppo */
2180		   QUIRK_FLAG_DSD_RAW),
2181	VENDOR_FLG(0x23ba, /* Playback Design */
2182		   QUIRK_FLAG_CTL_MSG_DELAY | QUIRK_FLAG_IFACE_DELAY |
2183		   QUIRK_FLAG_DSD_RAW),
2184	VENDOR_FLG(0x25ce, /* Mytek devices */
2185		   QUIRK_FLAG_DSD_RAW),
2186	VENDOR_FLG(0x278b, /* Rotel? */
2187		   QUIRK_FLAG_DSD_RAW),
2188	VENDOR_FLG(0x292b, /* Gustard/Ess based devices */
2189		   QUIRK_FLAG_DSD_RAW),
2190	VENDOR_FLG(0x2972, /* FiiO devices */
2191		   QUIRK_FLAG_DSD_RAW),
2192	VENDOR_FLG(0x2ab6, /* T+A devices */
2193		   QUIRK_FLAG_DSD_RAW),
 
 
 
 
 
 
2194	VENDOR_FLG(0x3353, /* Khadas devices */
 
 
2195		   QUIRK_FLAG_DSD_RAW),
2196	VENDOR_FLG(0x3842, /* EVGA */
2197		   QUIRK_FLAG_DSD_RAW),
2198	VENDOR_FLG(0xc502, /* HiBy devices */
2199		   QUIRK_FLAG_DSD_RAW),
2200
2201	{} /* terminator */
2202};
2203
2204void snd_usb_init_quirk_flags(struct snd_usb_audio *chip)
2205{
2206	const struct usb_audio_quirk_flags_table *p;
2207
2208	for (p = quirk_flags_table; p->id; p++) {
2209		if (chip->usb_id == p->id ||
2210		    (!USB_ID_PRODUCT(p->id) &&
2211		     USB_ID_VENDOR(chip->usb_id) == USB_ID_VENDOR(p->id))) {
2212			usb_audio_dbg(chip,
2213				      "Set quirk_flags 0x%x for device %04x:%04x\n",
2214				      p->flags, USB_ID_VENDOR(chip->usb_id),
2215				      USB_ID_PRODUCT(chip->usb_id));
2216			chip->quirk_flags |= p->flags;
2217			return;
2218		}
2219	}
2220}