2 * USB Audio Driver for ALSA
4 * Quirks and vendor-specific extensions for mixer interfaces
6 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8 * Many codes borrowed from audio.c by
9 * Alan Cox (alan@lxorguk.ukuu.org.uk)
10 * Thomas Sailer (sailer@ife.ee.ethz.ch)
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include <linux/init.h>
29 #include <linux/slab.h>
30 #include <linux/usb.h>
31 #include <linux/usb/audio.h>
33 #include <sound/core.h>
34 #include <sound/control.h>
35 #include <sound/hwdep.h>
36 #include <sound/info.h>
40 #include "mixer_quirks.h"
43 extern struct snd_kcontrol_new *snd_usb_feature_unit_ctl;
46 * Sound Blaster remote control configuration
48 * format of remote control data:
50 * Audigy 2 NX: 06 80 xx 00 00 00
51 * Live! 24-bit: 06 80 xx yy 22 83
53 static const struct rc_config {
58 u8 min_packet_length; /* minimum accepted length of the URB result */
62 { USB_ID(0x041e, 0x3000), 0, 1, 2, 1, 18, 0x0013 }, /* Extigy */
63 { USB_ID(0x041e, 0x3020), 2, 1, 6, 6, 18, 0x0013 }, /* Audigy 2 NX */
64 { USB_ID(0x041e, 0x3040), 2, 2, 6, 6, 2, 0x6e91 }, /* Live! 24-bit */
65 { USB_ID(0x041e, 0x3042), 0, 1, 1, 1, 1, 0x000d }, /* Usb X-Fi S51 */
66 { USB_ID(0x041e, 0x30df), 0, 1, 1, 1, 1, 0x000d }, /* Usb X-Fi S51 Pro */
67 { USB_ID(0x041e, 0x3048), 2, 2, 6, 6, 2, 0x6e91 }, /* Toshiba SB0500 */
70 static void snd_usb_soundblaster_remote_complete(struct urb *urb)
72 struct usb_mixer_interface *mixer = urb->context;
73 const struct rc_config *rc = mixer->rc_cfg;
76 if (urb->status < 0 || urb->actual_length < rc->min_packet_length)
79 code = mixer->rc_buffer[rc->offset];
81 code |= mixer->rc_buffer[rc->offset + 1] << 8;
83 /* the Mute button actually changes the mixer control */
84 if (code == rc->mute_code)
85 snd_usb_mixer_notify_id(mixer, rc->mute_mixer_id);
86 mixer->rc_code = code;
88 wake_up(&mixer->rc_waitq);
91 static long snd_usb_sbrc_hwdep_read(struct snd_hwdep *hw, char __user *buf,
92 long count, loff_t *offset)
94 struct usb_mixer_interface *mixer = hw->private_data;
98 if (count != 1 && count != 4)
100 err = wait_event_interruptible(mixer->rc_waitq,
101 (rc_code = xchg(&mixer->rc_code, 0)) != 0);
104 err = put_user(rc_code, buf);
106 err = put_user(rc_code, (u32 __user *)buf);
108 return err < 0 ? err : count;
111 static unsigned int snd_usb_sbrc_hwdep_poll(struct snd_hwdep *hw, struct file *file,
114 struct usb_mixer_interface *mixer = hw->private_data;
116 poll_wait(file, &mixer->rc_waitq, wait);
117 return mixer->rc_code ? POLLIN | POLLRDNORM : 0;
120 static int snd_usb_soundblaster_remote_init(struct usb_mixer_interface *mixer)
122 struct snd_hwdep *hwdep;
125 for (i = 0; i < ARRAY_SIZE(rc_configs); ++i)
126 if (rc_configs[i].usb_id == mixer->chip->usb_id)
128 if (i >= ARRAY_SIZE(rc_configs))
130 mixer->rc_cfg = &rc_configs[i];
132 len = mixer->rc_cfg->packet_length;
134 init_waitqueue_head(&mixer->rc_waitq);
135 err = snd_hwdep_new(mixer->chip->card, "SB remote control", 0, &hwdep);
138 snprintf(hwdep->name, sizeof(hwdep->name),
139 "%s remote control", mixer->chip->card->shortname);
140 hwdep->iface = SNDRV_HWDEP_IFACE_SB_RC;
141 hwdep->private_data = mixer;
142 hwdep->ops.read = snd_usb_sbrc_hwdep_read;
143 hwdep->ops.poll = snd_usb_sbrc_hwdep_poll;
144 hwdep->exclusive = 1;
146 mixer->rc_urb = usb_alloc_urb(0, GFP_KERNEL);
149 mixer->rc_setup_packet = kmalloc(sizeof(*mixer->rc_setup_packet), GFP_KERNEL);
150 if (!mixer->rc_setup_packet) {
151 usb_free_urb(mixer->rc_urb);
152 mixer->rc_urb = NULL;
155 mixer->rc_setup_packet->bRequestType =
156 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
157 mixer->rc_setup_packet->bRequest = UAC_GET_MEM;
158 mixer->rc_setup_packet->wValue = cpu_to_le16(0);
159 mixer->rc_setup_packet->wIndex = cpu_to_le16(0);
160 mixer->rc_setup_packet->wLength = cpu_to_le16(len);
161 usb_fill_control_urb(mixer->rc_urb, mixer->chip->dev,
162 usb_rcvctrlpipe(mixer->chip->dev, 0),
163 (u8*)mixer->rc_setup_packet, mixer->rc_buffer, len,
164 snd_usb_soundblaster_remote_complete, mixer);
168 #define snd_audigy2nx_led_info snd_ctl_boolean_mono_info
170 static int snd_audigy2nx_led_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
172 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
173 int index = kcontrol->private_value;
175 ucontrol->value.integer.value[0] = mixer->audigy2nx_leds[index];
179 static int snd_audigy2nx_led_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
181 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
182 int index = kcontrol->private_value;
183 int value = ucontrol->value.integer.value[0];
188 changed = value != mixer->audigy2nx_leds[index];
189 down_read(&mixer->chip->shutdown_rwsem);
190 if (mixer->chip->shutdown) {
194 if (mixer->chip->usb_id == USB_ID(0x041e, 0x3042))
195 err = snd_usb_ctl_msg(mixer->chip->dev,
196 usb_sndctrlpipe(mixer->chip->dev, 0), 0x24,
197 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
199 /* USB X-Fi S51 Pro */
200 if (mixer->chip->usb_id == USB_ID(0x041e, 0x30df))
201 err = snd_usb_ctl_msg(mixer->chip->dev,
202 usb_sndctrlpipe(mixer->chip->dev, 0), 0x24,
203 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
206 err = snd_usb_ctl_msg(mixer->chip->dev,
207 usb_sndctrlpipe(mixer->chip->dev, 0), 0x24,
208 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
209 value, index + 2, NULL, 0);
211 up_read(&mixer->chip->shutdown_rwsem);
214 mixer->audigy2nx_leds[index] = value;
218 static struct snd_kcontrol_new snd_audigy2nx_controls[] = {
220 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
221 .name = "CMSS LED Switch",
222 .info = snd_audigy2nx_led_info,
223 .get = snd_audigy2nx_led_get,
224 .put = snd_audigy2nx_led_put,
228 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
229 .name = "Power LED Switch",
230 .info = snd_audigy2nx_led_info,
231 .get = snd_audigy2nx_led_get,
232 .put = snd_audigy2nx_led_put,
236 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
237 .name = "Dolby Digital LED Switch",
238 .info = snd_audigy2nx_led_info,
239 .get = snd_audigy2nx_led_get,
240 .put = snd_audigy2nx_led_put,
245 static int snd_audigy2nx_controls_create(struct usb_mixer_interface *mixer)
249 for (i = 0; i < ARRAY_SIZE(snd_audigy2nx_controls); ++i) {
250 /* USB X-Fi S51 doesn't have a CMSS LED */
251 if ((mixer->chip->usb_id == USB_ID(0x041e, 0x3042)) && i == 0)
253 /* USB X-Fi S51 Pro doesn't have one either */
254 if ((mixer->chip->usb_id == USB_ID(0x041e, 0x30df)) && i == 0)
256 if (i > 1 && /* Live24ext has 2 LEDs only */
257 (mixer->chip->usb_id == USB_ID(0x041e, 0x3040) ||
258 mixer->chip->usb_id == USB_ID(0x041e, 0x3042) ||
259 mixer->chip->usb_id == USB_ID(0x041e, 0x30df) ||
260 mixer->chip->usb_id == USB_ID(0x041e, 0x3048)))
262 err = snd_ctl_add(mixer->chip->card,
263 snd_ctl_new1(&snd_audigy2nx_controls[i], mixer));
267 mixer->audigy2nx_leds[1] = 1; /* Power LED is on by default */
271 static void snd_audigy2nx_proc_read(struct snd_info_entry *entry,
272 struct snd_info_buffer *buffer)
274 static const struct sb_jack {
277 } jacks_audigy2nx[] = {
283 }, jacks_live24ext[] = {
284 {4, "line in"}, /* &1=Line, &2=Mic*/
285 {3, "hph out"}, /* headphones */
286 {0, "RC "}, /* last command, 6 bytes see rc_config above */
289 const struct sb_jack *jacks;
290 struct usb_mixer_interface *mixer = entry->private_data;
294 snd_iprintf(buffer, "%s jacks\n\n", mixer->chip->card->shortname);
295 if (mixer->chip->usb_id == USB_ID(0x041e, 0x3020))
296 jacks = jacks_audigy2nx;
297 else if (mixer->chip->usb_id == USB_ID(0x041e, 0x3040) ||
298 mixer->chip->usb_id == USB_ID(0x041e, 0x3048))
299 jacks = jacks_live24ext;
303 for (i = 0; jacks[i].name; ++i) {
304 snd_iprintf(buffer, "%s: ", jacks[i].name);
305 down_read(&mixer->chip->shutdown_rwsem);
306 if (mixer->chip->shutdown)
309 err = snd_usb_ctl_msg(mixer->chip->dev,
310 usb_rcvctrlpipe(mixer->chip->dev, 0),
311 UAC_GET_MEM, USB_DIR_IN | USB_TYPE_CLASS |
312 USB_RECIP_INTERFACE, 0,
313 jacks[i].unitid << 8, buf, 3);
314 up_read(&mixer->chip->shutdown_rwsem);
315 if (err == 3 && (buf[0] == 3 || buf[0] == 6))
316 snd_iprintf(buffer, "%02x %02x\n", buf[1], buf[2]);
318 snd_iprintf(buffer, "?\n");
322 static int snd_xonar_u1_switch_get(struct snd_kcontrol *kcontrol,
323 struct snd_ctl_elem_value *ucontrol)
325 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
327 ucontrol->value.integer.value[0] = !!(mixer->xonar_u1_status & 0x02);
331 static int snd_xonar_u1_switch_put(struct snd_kcontrol *kcontrol,
332 struct snd_ctl_elem_value *ucontrol)
334 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
335 u8 old_status, new_status;
338 old_status = mixer->xonar_u1_status;
339 if (ucontrol->value.integer.value[0])
340 new_status = old_status | 0x02;
342 new_status = old_status & ~0x02;
343 changed = new_status != old_status;
344 down_read(&mixer->chip->shutdown_rwsem);
345 if (mixer->chip->shutdown)
348 err = snd_usb_ctl_msg(mixer->chip->dev,
349 usb_sndctrlpipe(mixer->chip->dev, 0), 0x08,
350 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
351 50, 0, &new_status, 1);
352 up_read(&mixer->chip->shutdown_rwsem);
355 mixer->xonar_u1_status = new_status;
359 static struct snd_kcontrol_new snd_xonar_u1_output_switch = {
360 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
361 .name = "Digital Playback Switch",
362 .info = snd_ctl_boolean_mono_info,
363 .get = snd_xonar_u1_switch_get,
364 .put = snd_xonar_u1_switch_put,
367 static int snd_xonar_u1_controls_create(struct usb_mixer_interface *mixer)
371 err = snd_ctl_add(mixer->chip->card,
372 snd_ctl_new1(&snd_xonar_u1_output_switch, mixer));
375 mixer->xonar_u1_status = 0x05;
379 /* Native Instruments device quirks */
381 #define _MAKE_NI_CONTROL(bRequest,wIndex) ((bRequest) << 16 | (wIndex))
383 static int snd_nativeinstruments_control_get(struct snd_kcontrol *kcontrol,
384 struct snd_ctl_elem_value *ucontrol)
386 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
387 struct usb_device *dev = mixer->chip->dev;
388 u8 bRequest = (kcontrol->private_value >> 16) & 0xff;
389 u16 wIndex = kcontrol->private_value & 0xffff;
393 down_read(&mixer->chip->shutdown_rwsem);
394 if (mixer->chip->shutdown)
397 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), bRequest,
398 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
399 0, cpu_to_le16(wIndex),
400 &tmp, sizeof(tmp), 1000);
401 up_read(&mixer->chip->shutdown_rwsem);
405 "unable to issue vendor read request (ret = %d)", ret);
409 ucontrol->value.integer.value[0] = tmp;
414 static int snd_nativeinstruments_control_put(struct snd_kcontrol *kcontrol,
415 struct snd_ctl_elem_value *ucontrol)
417 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
418 struct usb_device *dev = mixer->chip->dev;
419 u8 bRequest = (kcontrol->private_value >> 16) & 0xff;
420 u16 wIndex = kcontrol->private_value & 0xffff;
421 u16 wValue = ucontrol->value.integer.value[0];
424 down_read(&mixer->chip->shutdown_rwsem);
425 if (mixer->chip->shutdown)
428 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), bRequest,
429 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
430 cpu_to_le16(wValue), cpu_to_le16(wIndex),
432 up_read(&mixer->chip->shutdown_rwsem);
436 "unable to issue vendor write request (ret = %d)", ret);
443 static struct snd_kcontrol_new snd_nativeinstruments_ta6_mixers[] = {
445 .name = "Direct Thru Channel A",
446 .private_value = _MAKE_NI_CONTROL(0x01, 0x03),
449 .name = "Direct Thru Channel B",
450 .private_value = _MAKE_NI_CONTROL(0x01, 0x05),
453 .name = "Phono Input Channel A",
454 .private_value = _MAKE_NI_CONTROL(0x02, 0x03),
457 .name = "Phono Input Channel B",
458 .private_value = _MAKE_NI_CONTROL(0x02, 0x05),
462 static struct snd_kcontrol_new snd_nativeinstruments_ta10_mixers[] = {
464 .name = "Direct Thru Channel A",
465 .private_value = _MAKE_NI_CONTROL(0x01, 0x03),
468 .name = "Direct Thru Channel B",
469 .private_value = _MAKE_NI_CONTROL(0x01, 0x05),
472 .name = "Direct Thru Channel C",
473 .private_value = _MAKE_NI_CONTROL(0x01, 0x07),
476 .name = "Direct Thru Channel D",
477 .private_value = _MAKE_NI_CONTROL(0x01, 0x09),
480 .name = "Phono Input Channel A",
481 .private_value = _MAKE_NI_CONTROL(0x02, 0x03),
484 .name = "Phono Input Channel B",
485 .private_value = _MAKE_NI_CONTROL(0x02, 0x05),
488 .name = "Phono Input Channel C",
489 .private_value = _MAKE_NI_CONTROL(0x02, 0x07),
492 .name = "Phono Input Channel D",
493 .private_value = _MAKE_NI_CONTROL(0x02, 0x09),
497 static int snd_nativeinstruments_create_mixer(struct usb_mixer_interface *mixer,
498 const struct snd_kcontrol_new *kc,
502 struct snd_kcontrol_new template = {
503 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
504 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
505 .get = snd_nativeinstruments_control_get,
506 .put = snd_nativeinstruments_control_put,
507 .info = snd_ctl_boolean_mono_info,
510 for (i = 0; i < count; i++) {
511 struct snd_kcontrol *c;
513 template.name = kc[i].name;
514 template.private_value = kc[i].private_value;
516 c = snd_ctl_new1(&template, mixer);
517 err = snd_ctl_add(mixer->chip->card, c);
526 /* M-Audio FastTrack Ultra quirks */
528 /* private_free callback */
529 static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
531 kfree(kctl->private_data);
532 kctl->private_data = NULL;
535 static int snd_maudio_ftu_create_ctl(struct usb_mixer_interface *mixer,
536 int in, int out, const char *name)
538 struct usb_mixer_elem_info *cval;
539 struct snd_kcontrol *kctl;
541 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
547 cval->val_type = USB_MIXER_S16;
549 cval->control = out + 1;
550 cval->cmask = 1 << in;
552 kctl = snd_ctl_new1(snd_usb_feature_unit_ctl, cval);
558 snprintf(kctl->id.name, sizeof(kctl->id.name), name);
559 kctl->private_free = usb_mixer_elem_free;
560 return snd_usb_mixer_add_control(mixer, kctl);
563 static int snd_maudio_ftu_create_mixer(struct usb_mixer_interface *mixer)
568 for (out = 0; out < 8; out++) {
569 for (in = 0; in < 8; in++) {
570 snprintf(name, sizeof(name),
571 "AIn%d - Out%d Capture Volume", in + 1, out + 1);
572 err = snd_maudio_ftu_create_ctl(mixer, in, out, name);
577 for (in = 8; in < 16; in++) {
578 snprintf(name, sizeof(name),
579 "DIn%d - Out%d Playback Volume", in - 7, out + 1);
580 err = snd_maudio_ftu_create_ctl(mixer, in, out, name);
589 void snd_emuusb_set_samplerate(struct snd_usb_audio *chip,
590 unsigned char samplerate_id)
592 struct usb_mixer_interface *mixer;
593 struct usb_mixer_elem_info *cval;
594 int unitid = 12; /* SamleRate ExtensionUnit ID */
596 list_for_each_entry(mixer, &chip->mixer_list, list) {
597 cval = mixer->id_elems[unitid];
599 snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR,
602 snd_usb_mixer_notify_id(mixer, unitid);
608 int snd_usb_mixer_apply_create_quirk(struct usb_mixer_interface *mixer)
611 struct snd_info_entry *entry;
613 if ((err = snd_usb_soundblaster_remote_init(mixer)) < 0)
616 switch (mixer->chip->usb_id) {
617 case USB_ID(0x041e, 0x3020):
618 case USB_ID(0x041e, 0x3040):
619 case USB_ID(0x041e, 0x3042):
620 case USB_ID(0x041e, 0x30df):
621 case USB_ID(0x041e, 0x3048):
622 err = snd_audigy2nx_controls_create(mixer);
625 if (!snd_card_proc_new(mixer->chip->card, "audigy2nx", &entry))
626 snd_info_set_text_ops(entry, mixer,
627 snd_audigy2nx_proc_read);
630 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
631 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
632 err = snd_maudio_ftu_create_mixer(mixer);
635 case USB_ID(0x0b05, 0x1739):
636 case USB_ID(0x0b05, 0x1743):
637 err = snd_xonar_u1_controls_create(mixer);
640 case USB_ID(0x17cc, 0x1011): /* Traktor Audio 6 */
641 err = snd_nativeinstruments_create_mixer(mixer,
642 snd_nativeinstruments_ta6_mixers,
643 ARRAY_SIZE(snd_nativeinstruments_ta6_mixers));
646 case USB_ID(0x17cc, 0x1021): /* Traktor Audio 10 */
647 err = snd_nativeinstruments_create_mixer(mixer,
648 snd_nativeinstruments_ta10_mixers,
649 ARRAY_SIZE(snd_nativeinstruments_ta10_mixers));
656 void snd_usb_mixer_rc_memory_change(struct usb_mixer_interface *mixer,
661 /* unit ids specific to Extigy/Audigy 2 NX: */
663 case 0: /* remote control */
664 mixer->rc_urb->dev = mixer->chip->dev;
665 usb_submit_urb(mixer->rc_urb, GFP_ATOMIC);
667 case 4: /* digital in jack */
668 case 7: /* line in jacks */
669 case 19: /* speaker out jacks */
670 case 20: /* headphones out jack */
672 /* live24ext: 4 = line-in jack */
673 case 3: /* hp-out jack (may actuate Mute) */
674 if (mixer->chip->usb_id == USB_ID(0x041e, 0x3040) ||
675 mixer->chip->usb_id == USB_ID(0x041e, 0x3048))
676 snd_usb_mixer_notify_id(mixer, mixer->rc_cfg->mute_mixer_id);
679 snd_printd(KERN_DEBUG "memory change in unknown unit %d\n", unitid);