blob: 2c971858d6b70a146e57266bfa0afe7a1bfe80cb [file] [log] [blame]
Daniel Macke5779992010-03-04 19:46:13 +01001/*
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>
Stephen Rothwell36db0452010-03-29 16:02:50 +110018#include <linux/slab.h>
Daniel Macke5779992010-03-04 19:46:13 +010019#include <linux/usb.h>
20#include <linux/usb/audio.h>
21
Daniel Mack9e386582011-05-25 09:09:01 +020022#include <sound/control.h>
Daniel Macke5779992010-03-04 19:46:13 +010023#include <sound/core.h>
24#include <sound/info.h>
25#include <sound/pcm.h>
26
27#include "usbaudio.h"
28#include "card.h"
Daniel Mackf0b5e632010-03-11 21:13:23 +010029#include "mixer.h"
Daniel Mack7b1eda22010-03-11 21:13:22 +010030#include "mixer_quirks.h"
Daniel Macke5779992010-03-04 19:46:13 +010031#include "midi.h"
32#include "quirks.h"
33#include "helper.h"
34#include "endpoint.h"
35#include "pcm.h"
Daniel Mack3d8d4dc2010-06-16 17:57:31 +020036#include "clock.h"
Daniel Macke8e8bab2011-09-12 18:54:12 +020037#include "stream.h"
Daniel Macke5779992010-03-04 19:46:13 +010038
39/*
40 * handle the quirks for the contained interfaces
41 */
42static int create_composite_quirk(struct snd_usb_audio *chip,
43 struct usb_interface *iface,
44 struct usb_driver *driver,
45 const struct snd_usb_audio_quirk *quirk)
46{
47 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
48 int err;
49
50 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
51 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
52 if (!iface)
53 continue;
54 if (quirk->ifnum != probed_ifnum &&
55 usb_interface_claimed(iface))
56 continue;
57 err = snd_usb_create_quirk(chip, iface, driver, quirk);
58 if (err < 0)
59 return err;
60 if (quirk->ifnum != probed_ifnum)
61 usb_driver_claim_interface(driver, iface, (void *)-1L);
62 }
63 return 0;
64}
65
66static int ignore_interface_quirk(struct snd_usb_audio *chip,
67 struct usb_interface *iface,
68 struct usb_driver *driver,
69 const struct snd_usb_audio_quirk *quirk)
70{
71 return 0;
72}
73
74
75/*
76 * Allow alignment on audio sub-slot (channel samples) rather than
77 * on audio slots (audio frames)
78 */
79static int create_align_transfer_quirk(struct snd_usb_audio *chip,
80 struct usb_interface *iface,
81 struct usb_driver *driver,
82 const struct snd_usb_audio_quirk *quirk)
83{
84 chip->txfr_quirk = 1;
85 return 1; /* Continue with creating streams and mixer */
86}
87
88static int create_any_midi_quirk(struct snd_usb_audio *chip,
89 struct usb_interface *intf,
90 struct usb_driver *driver,
91 const struct snd_usb_audio_quirk *quirk)
92{
93 return snd_usbmidi_create(chip->card, intf, &chip->midi_list, quirk);
94}
95
96/*
97 * create a stream for an interface with proper descriptors
98 */
99static int create_standard_audio_quirk(struct snd_usb_audio *chip,
100 struct usb_interface *iface,
101 struct usb_driver *driver,
102 const struct snd_usb_audio_quirk *quirk)
103{
104 struct usb_host_interface *alts;
105 struct usb_interface_descriptor *altsd;
106 int err;
107
108 alts = &iface->altsetting[0];
109 altsd = get_iface_desc(alts);
Daniel Macke8e8bab2011-09-12 18:54:12 +0200110 err = snd_usb_parse_audio_interface(chip, altsd->bInterfaceNumber);
Daniel Macke5779992010-03-04 19:46:13 +0100111 if (err < 0) {
112 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
113 altsd->bInterfaceNumber, err);
114 return err;
115 }
116 /* reset the current interface */
117 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
118 return 0;
119}
120
121/*
122 * create a stream for an endpoint/altsetting without proper descriptors
123 */
124static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
125 struct usb_interface *iface,
126 struct usb_driver *driver,
127 const struct snd_usb_audio_quirk *quirk)
128{
129 struct audioformat *fp;
130 struct usb_host_interface *alts;
131 int stream, err;
132 unsigned *rate_table = NULL;
133
134 fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
Xi Wang8866f402012-02-14 05:18:48 -0500135 if (!fp) {
Daniel Macke5779992010-03-04 19:46:13 +0100136 snd_printk(KERN_ERR "cannot memdup\n");
137 return -ENOMEM;
138 }
Xi Wang8866f402012-02-14 05:18:48 -0500139 if (fp->nr_rates > MAX_NR_RATES) {
140 kfree(fp);
141 return -EINVAL;
142 }
Daniel Macke5779992010-03-04 19:46:13 +0100143 if (fp->nr_rates > 0) {
Thomas Meyer43df2a52011-11-10 19:38:43 +0100144 rate_table = kmemdup(fp->rate_table,
145 sizeof(int) * fp->nr_rates, GFP_KERNEL);
Daniel Macke5779992010-03-04 19:46:13 +0100146 if (!rate_table) {
147 kfree(fp);
148 return -ENOMEM;
149 }
Daniel Macke5779992010-03-04 19:46:13 +0100150 fp->rate_table = rate_table;
151 }
152
153 stream = (fp->endpoint & USB_DIR_IN)
154 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
Daniel Macke8e8bab2011-09-12 18:54:12 +0200155 err = snd_usb_add_audio_stream(chip, stream, fp);
Daniel Macke5779992010-03-04 19:46:13 +0100156 if (err < 0) {
157 kfree(fp);
158 kfree(rate_table);
159 return err;
160 }
161 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
162 fp->altset_idx >= iface->num_altsetting) {
163 kfree(fp);
164 kfree(rate_table);
165 return -EINVAL;
166 }
167 alts = &iface->altsetting[fp->altset_idx];
168 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
169 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
170 usb_set_interface(chip->dev, fp->iface, 0);
Daniel Mack767d75a2010-03-04 19:46:17 +0100171 snd_usb_init_pitch(chip, fp->iface, alts, fp);
172 snd_usb_init_sample_rate(chip, fp->iface, alts, fp, fp->rate_max);
Daniel Macke5779992010-03-04 19:46:13 +0100173 return 0;
174}
175
176/*
177 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
178 * The only way to detect the sample rate is by looking at wMaxPacketSize.
179 */
180static int create_uaxx_quirk(struct snd_usb_audio *chip,
181 struct usb_interface *iface,
182 struct usb_driver *driver,
183 const struct snd_usb_audio_quirk *quirk)
184{
185 static const struct audioformat ua_format = {
Clemens Ladisch015eb0b2010-03-04 19:46:15 +0100186 .formats = SNDRV_PCM_FMTBIT_S24_3LE,
Daniel Macke5779992010-03-04 19:46:13 +0100187 .channels = 2,
188 .fmt_type = UAC_FORMAT_TYPE_I,
189 .altsetting = 1,
190 .altset_idx = 1,
191 .rates = SNDRV_PCM_RATE_CONTINUOUS,
192 };
193 struct usb_host_interface *alts;
194 struct usb_interface_descriptor *altsd;
195 struct audioformat *fp;
196 int stream, err;
197
198 /* both PCM and MIDI interfaces have 2 or more altsettings */
199 if (iface->num_altsetting < 2)
200 return -ENXIO;
201 alts = &iface->altsetting[1];
202 altsd = get_iface_desc(alts);
203
204 if (altsd->bNumEndpoints == 2) {
205 static const struct snd_usb_midi_endpoint_info ua700_ep = {
206 .out_cables = 0x0003,
207 .in_cables = 0x0003
208 };
209 static const struct snd_usb_audio_quirk ua700_quirk = {
210 .type = QUIRK_MIDI_FIXED_ENDPOINT,
211 .data = &ua700_ep
212 };
213 static const struct snd_usb_midi_endpoint_info uaxx_ep = {
214 .out_cables = 0x0001,
215 .in_cables = 0x0001
216 };
217 static const struct snd_usb_audio_quirk uaxx_quirk = {
218 .type = QUIRK_MIDI_FIXED_ENDPOINT,
219 .data = &uaxx_ep
220 };
221 const struct snd_usb_audio_quirk *quirk =
222 chip->usb_id == USB_ID(0x0582, 0x002b)
223 ? &ua700_quirk : &uaxx_quirk;
224 return snd_usbmidi_create(chip->card, iface,
225 &chip->midi_list, quirk);
226 }
227
228 if (altsd->bNumEndpoints != 1)
229 return -ENXIO;
230
Thomas Meyer43df2a52011-11-10 19:38:43 +0100231 fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL);
Daniel Macke5779992010-03-04 19:46:13 +0100232 if (!fp)
233 return -ENOMEM;
Daniel Macke5779992010-03-04 19:46:13 +0100234
235 fp->iface = altsd->bInterfaceNumber;
236 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
237 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
238 fp->datainterval = 0;
239 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
240
241 switch (fp->maxpacksize) {
242 case 0x120:
243 fp->rate_max = fp->rate_min = 44100;
244 break;
245 case 0x138:
246 case 0x140:
247 fp->rate_max = fp->rate_min = 48000;
248 break;
249 case 0x258:
250 case 0x260:
251 fp->rate_max = fp->rate_min = 96000;
252 break;
253 default:
254 snd_printk(KERN_ERR "unknown sample rate\n");
255 kfree(fp);
256 return -ENXIO;
257 }
258
259 stream = (fp->endpoint & USB_DIR_IN)
260 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
Daniel Macke8e8bab2011-09-12 18:54:12 +0200261 err = snd_usb_add_audio_stream(chip, stream, fp);
Daniel Macke5779992010-03-04 19:46:13 +0100262 if (err < 0) {
263 kfree(fp);
264 return err;
265 }
266 usb_set_interface(chip->dev, fp->iface, 0);
267 return 0;
268}
269
270/*
Daniel Mack014950b2011-05-25 09:09:02 +0200271 * Create a standard mixer for the specified interface.
272 */
273static int create_standard_mixer_quirk(struct snd_usb_audio *chip,
274 struct usb_interface *iface,
275 struct usb_driver *driver,
276 const struct snd_usb_audio_quirk *quirk)
277{
278 if (quirk->ifnum < 0)
279 return 0;
280
281 return snd_usb_create_mixer(chip, quirk->ifnum, 0);
282}
283
284/*
Daniel Macke5779992010-03-04 19:46:13 +0100285 * audio-interface quirks
286 *
287 * returns zero if no standard audio/MIDI parsing is needed.
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300288 * returns a positive value if standard audio/midi interfaces are parsed
Daniel Macke5779992010-03-04 19:46:13 +0100289 * after this.
290 * returns a negative value at error.
291 */
292int snd_usb_create_quirk(struct snd_usb_audio *chip,
293 struct usb_interface *iface,
294 struct usb_driver *driver,
295 const struct snd_usb_audio_quirk *quirk)
296{
297 typedef int (*quirk_func_t)(struct snd_usb_audio *,
298 struct usb_interface *,
299 struct usb_driver *,
300 const struct snd_usb_audio_quirk *);
301 static const quirk_func_t quirk_funcs[] = {
302 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
303 [QUIRK_COMPOSITE] = create_composite_quirk,
304 [QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk,
305 [QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk,
306 [QUIRK_MIDI_YAMAHA] = create_any_midi_quirk,
307 [QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
308 [QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
Clemens Ladischc7f57212010-10-22 18:20:48 +0200309 [QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
Daniel Macke5779992010-03-04 19:46:13 +0100310 [QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
311 [QUIRK_MIDI_CME] = create_any_midi_quirk,
Krzysztof Foltman4434ade2010-05-20 20:31:10 +0100312 [QUIRK_MIDI_AKAI] = create_any_midi_quirk,
Kristian Amlie1ef0e0a2011-08-26 13:19:49 +0200313 [QUIRK_MIDI_FTDI] = create_any_midi_quirk,
Daniel Macke5779992010-03-04 19:46:13 +0100314 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
315 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
316 [QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
Daniel Mack014950b2011-05-25 09:09:02 +0200317 [QUIRK_AUDIO_ALIGN_TRANSFER] = create_align_transfer_quirk,
318 [QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
Daniel Macke5779992010-03-04 19:46:13 +0100319 };
320
321 if (quirk->type < QUIRK_TYPE_COUNT) {
322 return quirk_funcs[quirk->type](chip, iface, driver, quirk);
323 } else {
324 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
325 return -ENXIO;
326 }
327}
328
329/*
330 * boot quirks
331 */
332
333#define EXTIGY_FIRMWARE_SIZE_OLD 794
334#define EXTIGY_FIRMWARE_SIZE_NEW 483
335
336static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
337{
338 struct usb_host_config *config = dev->actconfig;
339 int err;
340
341 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
342 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
343 snd_printdd("sending Extigy boot sequence...\n");
344 /* Send message to force it to reconnect with full interface. */
345 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200346 0x10, 0x43, 0x0001, 0x000a, NULL, 0);
Daniel Macke5779992010-03-04 19:46:13 +0100347 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
348 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
349 &dev->descriptor, sizeof(dev->descriptor));
350 config = dev->actconfig;
351 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
352 err = usb_reset_configuration(dev);
353 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
354 snd_printdd("extigy_boot: new boot length = %d\n",
355 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
356 return -ENODEV; /* quit this anyway */
357 }
358 return 0;
359}
360
361static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
362{
363 u8 buf = 1;
364
365 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
366 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200367 0, 0, &buf, 1);
Daniel Macke5779992010-03-04 19:46:13 +0100368 if (buf == 0) {
369 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
370 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200371 1, 2000, NULL, 0);
Daniel Macke5779992010-03-04 19:46:13 +0100372 return -ENODEV;
373 }
374 return 0;
375}
376
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200377static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
378{
379 int err;
380
381 if (dev->actconfig->desc.bConfigurationValue == 1) {
382 snd_printk(KERN_INFO "usb-audio: "
383 "Fast Track Pro switching to config #2\n");
384 /* This function has to be available by the usb core module.
385 * if it is not avialable the boot quirk has to be left out
386 * and the configuration has to be set by udev or hotplug
387 * rules
388 */
389 err = usb_driver_set_configuration(dev, 2);
David Henningssonb98ae272013-01-04 17:02:18 +0100390 if (err < 0)
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200391 snd_printdd("error usb_driver_set_configuration: %d\n",
392 err);
David Henningssonb98ae272013-01-04 17:02:18 +0100393 /* Always return an error, so that we stop creating a device
394 that will just be destroyed and recreated with a new
395 configuration */
396 return -ENODEV;
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200397 } else
398 snd_printk(KERN_INFO "usb-audio: Fast Track Pro config OK\n");
399
400 return 0;
401}
402
Daniel Macke5779992010-03-04 19:46:13 +0100403/*
404 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
405 * documented in the device's data sheet.
406 */
407static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
408{
409 u8 buf[4];
410 buf[0] = 0x20;
411 buf[1] = value & 0xff;
412 buf[2] = (value >> 8) & 0xff;
413 buf[3] = reg;
414 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
415 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200416 0, 0, &buf, 4);
Daniel Macke5779992010-03-04 19:46:13 +0100417}
418
419static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
420{
421 /*
422 * Enable line-out driver mode, set headphone source to front
423 * channels, enable stereo mic.
424 */
425 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
426}
427
428/*
429 * C-Media CM6206 is based on CM106 with two additional
430 * registers that are not documented in the data sheet.
431 * Values here are chosen based on sniffing USB traffic
432 * under Windows.
433 */
434static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
435{
Daniel Mackdac8f842011-08-06 00:23:18 +0200436 int err = 0, reg;
Eric Lammerts157186b2011-05-27 18:16:52 -0400437 int val[] = {0x2004, 0x3000, 0xf800, 0x143f, 0x0000, 0x3000};
Daniel Macke5779992010-03-04 19:46:13 +0100438
439 for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
440 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
441 if (err < 0)
442 return err;
443 }
444
445 return err;
446}
447
448/*
449 * This call will put the synth in "USB send" mode, i.e it will send MIDI
450 * messages through USB (this is disabled at startup). The synth will
451 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
452 * sign on its LCD. Values here are chosen based on sniffing USB traffic
453 * under Windows.
454 */
455static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
456{
457 int err, actual_length;
458
459 /* "midi send" enable */
460 static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
461
462 void *buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
463 if (!buf)
464 return -ENOMEM;
465 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
466 ARRAY_SIZE(seq), &actual_length, 1000);
467 kfree(buf);
468 if (err < 0)
469 return err;
470
471 return 0;
472}
473
474/*
Daniel Mack54a8c502011-02-11 11:08:06 +0000475 * Some sound cards from Native Instruments are in fact compliant to the USB
476 * audio standard of version 2 and other approved USB standards, even though
477 * they come up as vendor-specific device when first connected.
478 *
479 * However, they can be told to come up with a new set of descriptors
480 * upon their next enumeration, and the interfaces announced by the new
481 * descriptors will then be handled by the kernel's class drivers. As the
482 * product ID will also change, no further checks are required.
483 */
484
485static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
486{
487 int ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
488 0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
489 cpu_to_le16(1), 0, NULL, 0, 1000);
490
491 if (ret < 0)
492 return ret;
493
494 usb_reset_device(dev);
495
496 /* return -EAGAIN, so the creation of an audio interface for this
497 * temporary device is aborted. The device will reconnect with a
498 * new product ID */
499 return -EAGAIN;
500}
501
Damien Zammitcb998642012-12-19 11:27:22 +0100502static void mbox2_setup_48_24_magic(struct usb_device *dev)
503{
504 u8 srate[3];
505 u8 temp[12];
506
507 /* Choose 48000Hz permanently */
508 srate[0] = 0x80;
509 srate[1] = 0xbb;
510 srate[2] = 0x00;
511
512 /* Send the magic! */
513 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
514 0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
515 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
516 0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
517 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
518 0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
519 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
520 0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
521 return;
522}
523
524/* Digidesign Mbox 2 needs to load firmware onboard
525 * and driver must wait a few seconds for initialisation.
526 */
527
528#define MBOX2_FIRMWARE_SIZE 646
529#define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
530#define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
531
Damien Zammitb7b435e2013-01-04 09:51:44 +0100532static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
Damien Zammitcb998642012-12-19 11:27:22 +0100533{
534 struct usb_host_config *config = dev->actconfig;
535 int err;
Damien Zammitb7b435e2013-01-04 09:51:44 +0100536 u8 bootresponse[12];
Damien Zammitcb998642012-12-19 11:27:22 +0100537 int fwsize;
538 int count;
539
540 fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
541
542 if (fwsize != MBOX2_FIRMWARE_SIZE) {
543 snd_printk(KERN_ERR "usb-audio: Invalid firmware size=%d.\n", fwsize);
544 return -ENODEV;
545 }
546
547 snd_printd("usb-audio: Sending Digidesign Mbox 2 boot sequence...\n");
548
549 count = 0;
Damien Zammitb7b435e2013-01-04 09:51:44 +0100550 bootresponse[0] = MBOX2_BOOT_LOADING;
551 while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
Damien Zammitcb998642012-12-19 11:27:22 +0100552 msleep(500); /* 0.5 second delay */
553 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
554 /* Control magic - load onboard firmware */
555 0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
Damien Zammitb7b435e2013-01-04 09:51:44 +0100556 if (bootresponse[0] == MBOX2_BOOT_READY)
Damien Zammitcb998642012-12-19 11:27:22 +0100557 break;
558 snd_printd("usb-audio: device not ready, resending boot sequence...\n");
559 count++;
560 }
561
Damien Zammitb7b435e2013-01-04 09:51:44 +0100562 if (bootresponse[0] != MBOX2_BOOT_READY) {
563 snd_printk(KERN_ERR "usb-audio: Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
Damien Zammitcb998642012-12-19 11:27:22 +0100564 return -ENODEV;
565 }
566
567 snd_printdd("usb-audio: device initialised!\n");
568
569 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
570 &dev->descriptor, sizeof(dev->descriptor));
571 config = dev->actconfig;
572 if (err < 0)
573 snd_printd("error usb_get_descriptor: %d\n", err);
574
575 err = usb_reset_configuration(dev);
576 if (err < 0)
577 snd_printd("error usb_reset_configuration: %d\n", err);
578 snd_printdd("mbox2_boot: new boot length = %d\n",
579 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
580
581 mbox2_setup_48_24_magic(dev);
582
583 snd_printk(KERN_INFO "usb-audio: Digidesign Mbox 2: 24bit 48kHz");
584
585 return 0; /* Successful boot */
586}
587
Daniel Mack54a8c502011-02-11 11:08:06 +0000588/*
Daniel Macke5779992010-03-04 19:46:13 +0100589 * Setup quirks
590 */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200591#define MAUDIO_SET 0x01 /* parse device_setup */
592#define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
593#define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
594#define MAUDIO_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
595#define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
596#define MAUDIO_SET_DI 0x10 /* enable Digital Input */
597#define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
598#define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48KHz+Digital Input */
599#define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
600#define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48KHz+Digital Input */
601#define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
602
603static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
604 int iface, int altno)
605{
606 /* Reset ALL ifaces to 0 altsetting.
607 * Call it for every possible altsetting of every interface.
608 */
609 usb_set_interface(chip->dev, iface, 0);
610 if (chip->setup & MAUDIO_SET) {
611 if (chip->setup & MAUDIO_SET_COMPATIBLE) {
612 if (iface != 1 && iface != 2)
613 return 1; /* skip all interfaces but 1 and 2 */
614 } else {
615 unsigned int mask;
616 if (iface == 1 || iface == 2)
617 return 1; /* skip interfaces 1 and 2 */
618 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
619 return 1; /* skip this altsetting */
620 mask = chip->setup & MAUDIO_SET_MASK;
621 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
622 return 1; /* skip this altsetting */
623 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
624 return 1; /* skip this altsetting */
625 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
626 return 1; /* skip this altsetting */
627 }
628 }
629 snd_printdd(KERN_INFO
630 "using altsetting %d for interface %d config %d\n",
631 altno, iface, chip->setup);
632 return 0; /* keep this altsetting */
633}
Daniel Macke5779992010-03-04 19:46:13 +0100634
635static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
636 int iface,
637 int altno)
638{
639 /* Reset ALL ifaces to 0 altsetting.
640 * Call it for every possible altsetting of every interface.
641 */
642 usb_set_interface(chip->dev, iface, 0);
643
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200644 if (chip->setup & MAUDIO_SET) {
645 unsigned int mask;
646 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
Daniel Macke5779992010-03-04 19:46:13 +0100647 return 1; /* skip this altsetting */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200648 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
Daniel Macke5779992010-03-04 19:46:13 +0100649 return 1; /* skip this altsetting */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200650 mask = chip->setup & MAUDIO_SET_MASK;
651 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
Daniel Macke5779992010-03-04 19:46:13 +0100652 return 1; /* skip this altsetting */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200653 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
Daniel Macke5779992010-03-04 19:46:13 +0100654 return 1; /* skip this altsetting */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200655 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
Daniel Macke5779992010-03-04 19:46:13 +0100656 return 1; /* skip this altsetting */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200657 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
Daniel Macke5779992010-03-04 19:46:13 +0100658 return 1; /* skip this altsetting */
659 }
660
661 return 0; /* keep this altsetting */
662}
663
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200664static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
665 int iface, int altno)
666{
667 /* Reset ALL ifaces to 0 altsetting.
668 * Call it for every possible altsetting of every interface.
669 */
670 usb_set_interface(chip->dev, iface, 0);
671
672 /* possible configuration where both inputs and only one output is
673 *used is not supported by the current setup
674 */
675 if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
676 if (chip->setup & MAUDIO_SET_96K) {
677 if (altno != 3 && altno != 6)
678 return 1;
679 } else if (chip->setup & MAUDIO_SET_DI) {
680 if (iface == 4)
681 return 1; /* no analog input */
682 if (altno != 2 && altno != 5)
683 return 1; /* enable only altsets 2 and 5 */
684 } else {
685 if (iface == 5)
686 return 1; /* disable digialt input */
687 if (altno != 2 && altno != 5)
688 return 1; /* enalbe only altsets 2 and 5 */
689 }
690 } else {
691 /* keep only 16-Bit mode */
692 if (altno != 1)
693 return 1;
694 }
695
696 snd_printdd(KERN_INFO
697 "using altsetting %d for interface %d config %d\n",
698 altno, iface, chip->setup);
699 return 0; /* keep this altsetting */
700}
701
Daniel Macke5779992010-03-04 19:46:13 +0100702int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
703 int iface,
704 int altno)
705{
706 /* audiophile usb: skip altsets incompatible with device_setup */
707 if (chip->usb_id == USB_ID(0x0763, 0x2003))
708 return audiophile_skip_setting_quirk(chip, iface, altno);
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200709 /* quattro usb: skip altsets incompatible with device_setup */
710 if (chip->usb_id == USB_ID(0x0763, 0x2001))
711 return quattro_skip_setting_quirk(chip, iface, altno);
712 /* fasttrackpro usb: skip altsets incompatible with device_setup */
713 if (chip->usb_id == USB_ID(0x0763, 0x2012))
714 return fasttrackpro_skip_setting_quirk(chip, iface, altno);
Daniel Macke5779992010-03-04 19:46:13 +0100715
716 return 0;
717}
718
719int snd_usb_apply_boot_quirk(struct usb_device *dev,
720 struct usb_interface *intf,
721 const struct snd_usb_audio_quirk *quirk)
722{
723 u32 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
724 le16_to_cpu(dev->descriptor.idProduct));
725
Daniel Mack3347b262011-02-11 11:34:12 +0000726 switch (id) {
727 case USB_ID(0x041e, 0x3000):
728 /* SB Extigy needs special boot-up sequence */
729 /* if more models come, this will go to the quirk list. */
Daniel Macke5779992010-03-04 19:46:13 +0100730 return snd_usb_extigy_boot_quirk(dev, intf);
731
Daniel Mack3347b262011-02-11 11:34:12 +0000732 case USB_ID(0x041e, 0x3020):
733 /* SB Audigy 2 NX needs its own boot-up magic, too */
Daniel Macke5779992010-03-04 19:46:13 +0100734 return snd_usb_audigy2nx_boot_quirk(dev);
735
Daniel Mack3347b262011-02-11 11:34:12 +0000736 case USB_ID(0x10f5, 0x0200):
737 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
Daniel Macke5779992010-03-04 19:46:13 +0100738 return snd_usb_cm106_boot_quirk(dev);
739
Daniel Mack3347b262011-02-11 11:34:12 +0000740 case USB_ID(0x0d8c, 0x0102):
741 /* C-Media CM6206 / CM106-Like Sound Device */
Wolfgang Breyha8129e792011-04-28 16:18:40 +0200742 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
Daniel Macke5779992010-03-04 19:46:13 +0100743 return snd_usb_cm6206_boot_quirk(dev);
744
Damien Zammitcb998642012-12-19 11:27:22 +0100745 case USB_ID(0x0dba, 0x3000):
746 /* Digidesign Mbox 2 */
747 return snd_usb_mbox2_boot_quirk(dev);
748
Daniel Mack3347b262011-02-11 11:34:12 +0000749 case USB_ID(0x133e, 0x0815):
750 /* Access Music VirusTI Desktop */
Daniel Macke5779992010-03-04 19:46:13 +0100751 return snd_usb_accessmusic_boot_quirk(dev);
752
Daniel Mack759e890f2011-05-18 11:28:41 +0200753 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
Daniel Mack3347b262011-02-11 11:34:12 +0000754 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
755 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
Daniel Mack54a8c502011-02-11 11:08:06 +0000756 return snd_usb_nativeinstruments_boot_quirk(dev);
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200757 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
758 return snd_usb_fasttrackpro_boot_quirk(dev);
Daniel Mack3347b262011-02-11 11:34:12 +0000759 }
Daniel Mack54a8c502011-02-11 11:08:06 +0000760
Daniel Macke5779992010-03-04 19:46:13 +0100761 return 0;
762}
763
764/*
765 * check if the device uses big-endian samples
766 */
767int snd_usb_is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
768{
Adam Buchbinder48fc7f72012-09-19 21:48:00 -0400769 /* it depends on altsetting whether the device is big-endian or not */
Daniel Macke5779992010-03-04 19:46:13 +0100770 switch (chip->usb_id) {
771 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200772 if (fp->altsetting == 2 || fp->altsetting == 3 ||
773 fp->altsetting == 5 || fp->altsetting == 6)
Daniel Macke5779992010-03-04 19:46:13 +0100774 return 1;
775 break;
776 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
777 if (chip->setup == 0x00 ||
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200778 fp->altsetting == 1 || fp->altsetting == 2 ||
779 fp->altsetting == 3)
Daniel Macke5779992010-03-04 19:46:13 +0100780 return 1;
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200781 break;
782 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
783 if (fp->altsetting == 2 || fp->altsetting == 3 ||
784 fp->altsetting == 5 || fp->altsetting == 6)
785 return 1;
786 break;
Daniel Macke5779992010-03-04 19:46:13 +0100787 }
788 return 0;
789}
790
791/*
Joseph Teichman1cdfa9f2011-02-08 01:22:36 -0500792 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
Daniel Macke5779992010-03-04 19:46:13 +0100793 * not for interface.
794 */
795
796enum {
797 EMU_QUIRK_SR_44100HZ = 0,
798 EMU_QUIRK_SR_48000HZ,
799 EMU_QUIRK_SR_88200HZ,
800 EMU_QUIRK_SR_96000HZ,
801 EMU_QUIRK_SR_176400HZ,
802 EMU_QUIRK_SR_192000HZ
803};
804
805static void set_format_emu_quirk(struct snd_usb_substream *subs,
806 struct audioformat *fmt)
807{
808 unsigned char emu_samplerate_id = 0;
809
810 /* When capture is active
811 * sample rate shouldn't be changed
812 * by playback substream
813 */
814 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
815 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].interface != -1)
816 return;
817 }
818
819 switch (fmt->rate_min) {
820 case 48000:
821 emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
822 break;
823 case 88200:
824 emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
825 break;
826 case 96000:
827 emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
828 break;
829 case 176400:
830 emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
831 break;
832 case 192000:
833 emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
834 break;
835 default:
836 emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
837 break;
838 }
839 snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
840}
841
842void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
843 struct audioformat *fmt)
844{
845 switch (subs->stream->chip->usb_id) {
846 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
847 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
848 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
Joseph Teichman1cdfa9f2011-02-08 01:22:36 -0500849 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
Daniel Macke5779992010-03-04 19:46:13 +0100850 set_format_emu_quirk(subs, fmt);
851 break;
852 }
853}
854
Daniel Mack2b58fd52012-09-04 10:23:07 +0200855void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
856{
857 /*
858 * "Playback Design" products send bogus feedback data at the start
859 * of the stream. Ignore them.
860 */
861 if ((le16_to_cpu(ep->chip->dev->descriptor.idVendor) == 0x23ba) &&
862 ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
863 ep->skip_packets = 4;
Eldad Zack83e3acd2013-01-13 23:02:03 +0100864
865 /*
866 * M-Audio Fast Track C400 - when packets are not skipped, real world
867 * latency varies by approx. +/- 50 frames (at 96KHz) each time the
868 * stream is (re)started. When skipping packets 16 at endpoint start
869 * up, the real world latency is stable within +/- 1 frame (also
870 * across power cycles).
871 */
872 if (ep->chip->usb_id == USB_ID(0x0763, 0x2030) &&
873 ep->type == SND_USB_ENDPOINT_TYPE_DATA)
874 ep->skip_packets = 16;
Daniel Mack2b58fd52012-09-04 10:23:07 +0200875}
876
877void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
878 __u8 request, __u8 requesttype, __u16 value,
879 __u16 index, void *data, __u16 size)
880{
881 /*
882 * "Playback Design" products need a 20ms delay after each
883 * class compliant request
884 */
885 if ((le16_to_cpu(dev->descriptor.idVendor) == 0x23ba) &&
886 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
887 mdelay(20);
888}
889