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, 0x3237), 0, 1, 1, 1, 1, 0x000d }, /* Usb X-Fi S51 Pro */
68 { USB_ID(0x041e, 0x3048), 2, 2, 6, 6, 2, 0x6e91 }, /* Toshiba SB0500 */
71 static void snd_usb_soundblaster_remote_complete(struct urb *urb)
73 struct usb_mixer_interface *mixer = urb->context;
74 const struct rc_config *rc = mixer->rc_cfg;
77 if (urb->status < 0 || urb->actual_length < rc->min_packet_length)
80 code = mixer->rc_buffer[rc->offset];
82 code |= mixer->rc_buffer[rc->offset + 1] << 8;
84 /* the Mute button actually changes the mixer control */
85 if (code == rc->mute_code)
86 snd_usb_mixer_notify_id(mixer, rc->mute_mixer_id);
87 mixer->rc_code = code;
89 wake_up(&mixer->rc_waitq);
92 static long snd_usb_sbrc_hwdep_read(struct snd_hwdep *hw, char __user *buf,
93 long count, loff_t *offset)
95 struct usb_mixer_interface *mixer = hw->private_data;
99 if (count != 1 && count != 4)
101 err = wait_event_interruptible(mixer->rc_waitq,
102 (rc_code = xchg(&mixer->rc_code, 0)) != 0);
105 err = put_user(rc_code, buf);
107 err = put_user(rc_code, (u32 __user *)buf);
109 return err < 0 ? err : count;
112 static unsigned int snd_usb_sbrc_hwdep_poll(struct snd_hwdep *hw, struct file *file,
115 struct usb_mixer_interface *mixer = hw->private_data;
117 poll_wait(file, &mixer->rc_waitq, wait);
118 return mixer->rc_code ? POLLIN | POLLRDNORM : 0;
121 static int snd_usb_soundblaster_remote_init(struct usb_mixer_interface *mixer)
123 struct snd_hwdep *hwdep;
126 for (i = 0; i < ARRAY_SIZE(rc_configs); ++i)
127 if (rc_configs[i].usb_id == mixer->chip->usb_id)
129 if (i >= ARRAY_SIZE(rc_configs))
131 mixer->rc_cfg = &rc_configs[i];
133 len = mixer->rc_cfg->packet_length;
135 init_waitqueue_head(&mixer->rc_waitq);
136 err = snd_hwdep_new(mixer->chip->card, "SB remote control", 0, &hwdep);
139 snprintf(hwdep->name, sizeof(hwdep->name),
140 "%s remote control", mixer->chip->card->shortname);
141 hwdep->iface = SNDRV_HWDEP_IFACE_SB_RC;
142 hwdep->private_data = mixer;
143 hwdep->ops.read = snd_usb_sbrc_hwdep_read;
144 hwdep->ops.poll = snd_usb_sbrc_hwdep_poll;
145 hwdep->exclusive = 1;
147 mixer->rc_urb = usb_alloc_urb(0, GFP_KERNEL);
150 mixer->rc_setup_packet = kmalloc(sizeof(*mixer->rc_setup_packet), GFP_KERNEL);
151 if (!mixer->rc_setup_packet) {
152 usb_free_urb(mixer->rc_urb);
153 mixer->rc_urb = NULL;
156 mixer->rc_setup_packet->bRequestType =
157 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
158 mixer->rc_setup_packet->bRequest = UAC_GET_MEM;
159 mixer->rc_setup_packet->wValue = cpu_to_le16(0);
160 mixer->rc_setup_packet->wIndex = cpu_to_le16(0);
161 mixer->rc_setup_packet->wLength = cpu_to_le16(len);
162 usb_fill_control_urb(mixer->rc_urb, mixer->chip->dev,
163 usb_rcvctrlpipe(mixer->chip->dev, 0),
164 (u8*)mixer->rc_setup_packet, mixer->rc_buffer, len,
165 snd_usb_soundblaster_remote_complete, mixer);
169 #define snd_audigy2nx_led_info snd_ctl_boolean_mono_info
171 static int snd_audigy2nx_led_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
173 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
174 int index = kcontrol->private_value;
176 ucontrol->value.integer.value[0] = mixer->audigy2nx_leds[index];
180 static int snd_audigy2nx_led_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
182 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
183 int index = kcontrol->private_value;
184 int value = ucontrol->value.integer.value[0];
189 changed = value != mixer->audigy2nx_leds[index];
190 down_read(&mixer->chip->shutdown_rwsem);
191 if (mixer->chip->shutdown) {
195 if (mixer->chip->usb_id == USB_ID(0x041e, 0x3042))
196 err = snd_usb_ctl_msg(mixer->chip->dev,
197 usb_sndctrlpipe(mixer->chip->dev, 0), 0x24,
198 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
200 /* USB X-Fi S51 Pro */
201 if (mixer->chip->usb_id == USB_ID(0x041e, 0x30df))
202 err = snd_usb_ctl_msg(mixer->chip->dev,
203 usb_sndctrlpipe(mixer->chip->dev, 0), 0x24,
204 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
207 err = snd_usb_ctl_msg(mixer->chip->dev,
208 usb_sndctrlpipe(mixer->chip->dev, 0), 0x24,
209 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
210 value, index + 2, NULL, 0);
212 up_read(&mixer->chip->shutdown_rwsem);
215 mixer->audigy2nx_leds[index] = value;
219 static struct snd_kcontrol_new snd_audigy2nx_controls[] = {
221 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
222 .name = "CMSS LED Switch",
223 .info = snd_audigy2nx_led_info,
224 .get = snd_audigy2nx_led_get,
225 .put = snd_audigy2nx_led_put,
229 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
230 .name = "Power LED Switch",
231 .info = snd_audigy2nx_led_info,
232 .get = snd_audigy2nx_led_get,
233 .put = snd_audigy2nx_led_put,
237 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
238 .name = "Dolby Digital LED Switch",
239 .info = snd_audigy2nx_led_info,
240 .get = snd_audigy2nx_led_get,
241 .put = snd_audigy2nx_led_put,
246 static int snd_audigy2nx_controls_create(struct usb_mixer_interface *mixer)
250 for (i = 0; i < ARRAY_SIZE(snd_audigy2nx_controls); ++i) {
251 /* USB X-Fi S51 doesn't have a CMSS LED */
252 if ((mixer->chip->usb_id == USB_ID(0x041e, 0x3042)) && i == 0)
254 /* USB X-Fi S51 Pro doesn't have one either */
255 if ((mixer->chip->usb_id == USB_ID(0x041e, 0x30df)) && i == 0)
257 if (i > 1 && /* Live24ext has 2 LEDs only */
258 (mixer->chip->usb_id == USB_ID(0x041e, 0x3040) ||
259 mixer->chip->usb_id == USB_ID(0x041e, 0x3042) ||
260 mixer->chip->usb_id == USB_ID(0x041e, 0x30df) ||
261 mixer->chip->usb_id == USB_ID(0x041e, 0x3048)))
263 err = snd_ctl_add(mixer->chip->card,
264 snd_ctl_new1(&snd_audigy2nx_controls[i], mixer));
268 mixer->audigy2nx_leds[1] = 1; /* Power LED is on by default */
272 static void snd_audigy2nx_proc_read(struct snd_info_entry *entry,
273 struct snd_info_buffer *buffer)
275 static const struct sb_jack {
278 } jacks_audigy2nx[] = {
284 }, jacks_live24ext[] = {
285 {4, "line in"}, /* &1=Line, &2=Mic*/
286 {3, "hph out"}, /* headphones */
287 {0, "RC "}, /* last command, 6 bytes see rc_config above */
290 const struct sb_jack *jacks;
291 struct usb_mixer_interface *mixer = entry->private_data;
295 snd_iprintf(buffer, "%s jacks\n\n", mixer->chip->card->shortname);
296 if (mixer->chip->usb_id == USB_ID(0x041e, 0x3020))
297 jacks = jacks_audigy2nx;
298 else if (mixer->chip->usb_id == USB_ID(0x041e, 0x3040) ||
299 mixer->chip->usb_id == USB_ID(0x041e, 0x3048))
300 jacks = jacks_live24ext;
304 for (i = 0; jacks[i].name; ++i) {
305 snd_iprintf(buffer, "%s: ", jacks[i].name);
306 down_read(&mixer->chip->shutdown_rwsem);
307 if (mixer->chip->shutdown)
310 err = snd_usb_ctl_msg(mixer->chip->dev,
311 usb_rcvctrlpipe(mixer->chip->dev, 0),
312 UAC_GET_MEM, USB_DIR_IN | USB_TYPE_CLASS |
313 USB_RECIP_INTERFACE, 0,
314 jacks[i].unitid << 8, buf, 3);
315 up_read(&mixer->chip->shutdown_rwsem);
316 if (err == 3 && (buf[0] == 3 || buf[0] == 6))
317 snd_iprintf(buffer, "%02x %02x\n", buf[1], buf[2]);
319 snd_iprintf(buffer, "?\n");
323 static int snd_xonar_u1_switch_get(struct snd_kcontrol *kcontrol,
324 struct snd_ctl_elem_value *ucontrol)
326 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
328 ucontrol->value.integer.value[0] = !!(mixer->xonar_u1_status & 0x02);
332 static int snd_xonar_u1_switch_put(struct snd_kcontrol *kcontrol,
333 struct snd_ctl_elem_value *ucontrol)
335 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
336 u8 old_status, new_status;
339 old_status = mixer->xonar_u1_status;
340 if (ucontrol->value.integer.value[0])
341 new_status = old_status | 0x02;
343 new_status = old_status & ~0x02;
344 changed = new_status != old_status;
345 down_read(&mixer->chip->shutdown_rwsem);
346 if (mixer->chip->shutdown)
349 err = snd_usb_ctl_msg(mixer->chip->dev,
350 usb_sndctrlpipe(mixer->chip->dev, 0), 0x08,
351 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
352 50, 0, &new_status, 1);
353 up_read(&mixer->chip->shutdown_rwsem);
356 mixer->xonar_u1_status = new_status;
360 static struct snd_kcontrol_new snd_xonar_u1_output_switch = {
361 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
362 .name = "Digital Playback Switch",
363 .info = snd_ctl_boolean_mono_info,
364 .get = snd_xonar_u1_switch_get,
365 .put = snd_xonar_u1_switch_put,
368 static int snd_xonar_u1_controls_create(struct usb_mixer_interface *mixer)
372 err = snd_ctl_add(mixer->chip->card,
373 snd_ctl_new1(&snd_xonar_u1_output_switch, mixer));
376 mixer->xonar_u1_status = 0x05;
380 /* Native Instruments device quirks */
382 #define _MAKE_NI_CONTROL(bRequest,wIndex) ((bRequest) << 16 | (wIndex))
384 static int snd_nativeinstruments_control_get(struct snd_kcontrol *kcontrol,
385 struct snd_ctl_elem_value *ucontrol)
387 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
388 struct usb_device *dev = mixer->chip->dev;
389 u8 bRequest = (kcontrol->private_value >> 16) & 0xff;
390 u16 wIndex = kcontrol->private_value & 0xffff;
394 down_read(&mixer->chip->shutdown_rwsem);
395 if (mixer->chip->shutdown)
398 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), bRequest,
399 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
401 &tmp, sizeof(tmp), 1000);
402 up_read(&mixer->chip->shutdown_rwsem);
406 "unable to issue vendor read request (ret = %d)", ret);
410 ucontrol->value.integer.value[0] = tmp;
415 static int snd_nativeinstruments_control_put(struct snd_kcontrol *kcontrol,
416 struct snd_ctl_elem_value *ucontrol)
418 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
419 struct usb_device *dev = mixer->chip->dev;
420 u8 bRequest = (kcontrol->private_value >> 16) & 0xff;
421 u16 wIndex = kcontrol->private_value & 0xffff;
422 u16 wValue = ucontrol->value.integer.value[0];
425 down_read(&mixer->chip->shutdown_rwsem);
426 if (mixer->chip->shutdown)
429 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), bRequest,
430 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
433 up_read(&mixer->chip->shutdown_rwsem);
437 "unable to issue vendor write request (ret = %d)", ret);
444 static struct snd_kcontrol_new snd_nativeinstruments_ta6_mixers[] = {
446 .name = "Direct Thru Channel A",
447 .private_value = _MAKE_NI_CONTROL(0x01, 0x03),
450 .name = "Direct Thru Channel B",
451 .private_value = _MAKE_NI_CONTROL(0x01, 0x05),
454 .name = "Phono Input Channel A",
455 .private_value = _MAKE_NI_CONTROL(0x02, 0x03),
458 .name = "Phono Input Channel B",
459 .private_value = _MAKE_NI_CONTROL(0x02, 0x05),
463 static struct snd_kcontrol_new snd_nativeinstruments_ta10_mixers[] = {
465 .name = "Direct Thru Channel A",
466 .private_value = _MAKE_NI_CONTROL(0x01, 0x03),
469 .name = "Direct Thru Channel B",
470 .private_value = _MAKE_NI_CONTROL(0x01, 0x05),
473 .name = "Direct Thru Channel C",
474 .private_value = _MAKE_NI_CONTROL(0x01, 0x07),
477 .name = "Direct Thru Channel D",
478 .private_value = _MAKE_NI_CONTROL(0x01, 0x09),
481 .name = "Phono Input Channel A",
482 .private_value = _MAKE_NI_CONTROL(0x02, 0x03),
485 .name = "Phono Input Channel B",
486 .private_value = _MAKE_NI_CONTROL(0x02, 0x05),
489 .name = "Phono Input Channel C",
490 .private_value = _MAKE_NI_CONTROL(0x02, 0x07),
493 .name = "Phono Input Channel D",
494 .private_value = _MAKE_NI_CONTROL(0x02, 0x09),
498 static int snd_nativeinstruments_create_mixer(struct usb_mixer_interface *mixer,
499 const struct snd_kcontrol_new *kc,
503 struct snd_kcontrol_new template = {
504 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
505 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
506 .get = snd_nativeinstruments_control_get,
507 .put = snd_nativeinstruments_control_put,
508 .info = snd_ctl_boolean_mono_info,
511 for (i = 0; i < count; i++) {
512 struct snd_kcontrol *c;
514 template.name = kc[i].name;
515 template.private_value = kc[i].private_value;
517 c = snd_ctl_new1(&template, mixer);
518 err = snd_ctl_add(mixer->chip->card, c);
527 /* M-Audio FastTrack Ultra quirks */
529 /* private_free callback */
530 static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
532 kfree(kctl->private_data);
533 kctl->private_data = NULL;
536 static int snd_maudio_ftu_create_ctl(struct usb_mixer_interface *mixer,
537 int in, int out, const char *name)
539 struct usb_mixer_elem_info *cval;
540 struct snd_kcontrol *kctl;
542 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
548 cval->val_type = USB_MIXER_S16;
550 cval->control = out + 1;
551 cval->cmask = 1 << in;
553 kctl = snd_ctl_new1(snd_usb_feature_unit_ctl, cval);
559 snprintf(kctl->id.name, sizeof(kctl->id.name), name);
560 kctl->private_free = usb_mixer_elem_free;
561 return snd_usb_mixer_add_control(mixer, kctl);
564 static int snd_maudio_ftu_create_mixer(struct usb_mixer_interface *mixer)
569 for (out = 0; out < 8; out++) {
570 for (in = 0; in < 8; in++) {
571 snprintf(name, sizeof(name),
572 "AIn%d - Out%d Capture Volume", in + 1, out + 1);
573 err = snd_maudio_ftu_create_ctl(mixer, in, out, name);
578 for (in = 8; in < 16; in++) {
579 snprintf(name, sizeof(name),
580 "DIn%d - Out%d Playback Volume", in - 7, out + 1);
581 err = snd_maudio_ftu_create_ctl(mixer, in, out, name);
590 void snd_emuusb_set_samplerate(struct snd_usb_audio *chip,
591 unsigned char samplerate_id)
593 struct usb_mixer_interface *mixer;
594 struct usb_mixer_elem_info *cval;
595 int unitid = 12; /* SamleRate ExtensionUnit ID */
597 list_for_each_entry(mixer, &chip->mixer_list, list) {
598 cval = mixer->id_elems[unitid];
600 snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR,
603 snd_usb_mixer_notify_id(mixer, unitid);
609 int snd_usb_mixer_apply_create_quirk(struct usb_mixer_interface *mixer)
612 struct snd_info_entry *entry;
614 if ((err = snd_usb_soundblaster_remote_init(mixer)) < 0)
617 switch (mixer->chip->usb_id) {
618 case USB_ID(0x041e, 0x3020):
619 case USB_ID(0x041e, 0x3040):
620 case USB_ID(0x041e, 0x3042):
621 case USB_ID(0x041e, 0x30df):
622 case USB_ID(0x041e, 0x3048):
623 err = snd_audigy2nx_controls_create(mixer);
626 if (!snd_card_proc_new(mixer->chip->card, "audigy2nx", &entry))
627 snd_info_set_text_ops(entry, mixer,
628 snd_audigy2nx_proc_read);
631 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
632 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
633 err = snd_maudio_ftu_create_mixer(mixer);
636 case USB_ID(0x0b05, 0x1739):
637 case USB_ID(0x0b05, 0x1743):
638 err = snd_xonar_u1_controls_create(mixer);
641 case USB_ID(0x17cc, 0x1011): /* Traktor Audio 6 */
642 err = snd_nativeinstruments_create_mixer(mixer,
643 snd_nativeinstruments_ta6_mixers,
644 ARRAY_SIZE(snd_nativeinstruments_ta6_mixers));
647 case USB_ID(0x17cc, 0x1021): /* Traktor Audio 10 */
648 err = snd_nativeinstruments_create_mixer(mixer,
649 snd_nativeinstruments_ta10_mixers,
650 ARRAY_SIZE(snd_nativeinstruments_ta10_mixers));
657 void snd_usb_mixer_rc_memory_change(struct usb_mixer_interface *mixer,
662 /* unit ids specific to Extigy/Audigy 2 NX: */
664 case 0: /* remote control */
665 mixer->rc_urb->dev = mixer->chip->dev;
666 usb_submit_urb(mixer->rc_urb, GFP_ATOMIC);
668 case 4: /* digital in jack */
669 case 7: /* line in jacks */
670 case 19: /* speaker out jacks */
671 case 20: /* headphones out jack */
673 /* live24ext: 4 = line-in jack */
674 case 3: /* hp-out jack (may actuate Mute) */
675 if (mixer->chip->usb_id == USB_ID(0x041e, 0x3040) ||
676 mixer->chip->usb_id == USB_ID(0x041e, 0x3048))
677 snd_usb_mixer_notify_id(mixer, mixer->rc_cfg->mute_mixer_id);
680 snd_printd(KERN_DEBUG "memory change in unknown unit %d\n", unitid);