2 * (Tentative) USB Audio Driver for ALSA
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
29 #include <linux/bitops.h>
30 #include <linux/init.h>
31 #include <linux/list.h>
32 #include <linux/slab.h>
33 #include <linux/string.h>
34 #include <linux/usb.h>
35 #include <linux/usb/audio.h>
36 #include <linux/usb/audio-v2.h>
38 #include <sound/core.h>
39 #include <sound/control.h>
40 #include <sound/hwdep.h>
41 #include <sound/info.h>
42 #include <sound/tlv.h>
47 #include "mixer_quirks.h"
49 #define MAX_ID_ELEMS 256
51 struct usb_audio_term {
55 unsigned int chconfig;
59 struct usbmix_name_map;
62 struct snd_usb_audio *chip;
63 struct usb_mixer_interface *mixer;
64 unsigned char *buffer;
66 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
67 struct usb_audio_term oterm;
68 const struct usbmix_name_map *map;
69 const struct usbmix_selector_map *selector_map;
74 USB_MIXER_INV_BOOLEAN,
82 /*E-mu 0202(0404) eXtension Unit(XU) control*/
84 USB_XU_CLOCK_RATE = 0xe301,
85 USB_XU_CLOCK_SOURCE = 0xe302,
86 USB_XU_DIGITAL_IO_STATUS = 0xe303,
87 USB_XU_DEVICE_OPTIONS = 0xe304,
88 USB_XU_DIRECT_MONITORING = 0xe305,
89 USB_XU_METERING = 0xe306
92 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/
93 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */
94 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */
95 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */
99 * manual mapping of mixer names
100 * if the mixer topology is too complicated and the parsed names are
101 * ambiguous, add the entries in usbmixer_maps.c.
103 #include "mixer_maps.c"
105 static const struct usbmix_name_map *
106 find_map(struct mixer_build *state, int unitid, int control)
108 const struct usbmix_name_map *p = state->map;
113 for (p = state->map; p->id; p++) {
114 if (p->id == unitid &&
115 (!control || !p->control || control == p->control))
121 /* get the mapped name if the unit matches */
123 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
129 return strlcpy(buf, p->name, buflen);
132 /* check whether the control should be ignored */
134 check_ignored_ctl(const struct usbmix_name_map *p)
136 if (!p || p->name || p->dB)
142 static inline void check_mapped_dB(const struct usbmix_name_map *p,
143 struct usb_mixer_elem_info *cval)
146 cval->dBmin = p->dB->min;
147 cval->dBmax = p->dB->max;
151 /* get the mapped selector source name */
152 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
153 int index, char *buf, int buflen)
155 const struct usbmix_selector_map *p;
157 if (! state->selector_map)
159 for (p = state->selector_map; p->id; p++) {
160 if (p->id == unitid && index < p->count)
161 return strlcpy(buf, p->names[index], buflen);
167 * find an audio control unit with the given unit id
168 * this doesn't return any clock related units, so they need to be handled elsewhere
170 static void *find_audio_control_unit(struct mixer_build *state, unsigned char unit)
175 while ((p = snd_usb_find_desc(state->buffer, state->buflen, p,
176 USB_DT_CS_INTERFACE)) != NULL) {
177 if (p[0] >= 4 && p[2] >= UAC_INPUT_TERMINAL && p[2] <= UAC2_EXTENSION_UNIT_V2 && p[3] == unit)
185 * copy a string with the given id
187 static int snd_usb_copy_string_desc(struct mixer_build *state, int index, char *buf, int maxlen)
189 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
195 * convert from the byte/word on usb descriptor to the zero-based integer
197 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
199 switch (cval->val_type) {
200 case USB_MIXER_BOOLEAN:
202 case USB_MIXER_INV_BOOLEAN:
225 * convert from the zero-based int to the byte/word for usb descriptor
227 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
229 switch (cval->val_type) {
230 case USB_MIXER_BOOLEAN:
232 case USB_MIXER_INV_BOOLEAN:
241 return 0; /* not reached */
244 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
250 else if (val >= cval->max)
251 return (cval->max - cval->min + cval->res - 1) / cval->res;
253 return (val - cval->min) / cval->res;
256 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
271 * retrieve a mixer value
274 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
276 unsigned char buf[2];
277 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
280 while (timeout-- > 0) {
281 if (snd_usb_ctl_msg(cval->mixer->chip->dev,
282 usb_rcvctrlpipe(cval->mixer->chip->dev, 0),
284 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
285 validx, cval->mixer->ctrlif | (cval->id << 8),
286 buf, val_len, 100) >= val_len) {
287 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
291 snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
292 request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type);
296 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
298 unsigned char buf[14]; /* enough space for one range of 4 bytes */
303 bRequest = (request == UAC_GET_CUR) ?
304 UAC2_CS_CUR : UAC2_CS_RANGE;
306 ret = snd_usb_ctl_msg(cval->mixer->chip->dev,
307 usb_rcvctrlpipe(cval->mixer->chip->dev, 0),
309 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
310 validx, cval->mixer->ctrlif | (cval->id << 8),
311 buf, sizeof(buf), 1000);
314 snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
315 request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type);
324 val = buf + sizeof(__u16);
327 val = buf + sizeof(__u16) * 2;
330 val = buf + sizeof(__u16) * 3;
336 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
341 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
343 return (cval->mixer->protocol == UAC_VERSION_1) ?
344 get_ctl_value_v1(cval, request, validx, value_ret) :
345 get_ctl_value_v2(cval, request, validx, value_ret);
348 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int *value)
350 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
353 /* channel = 0: master, 1 = first channel */
354 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
355 int channel, int *value)
357 return get_ctl_value(cval, UAC_GET_CUR, (cval->control << 8) | channel, value);
360 static int get_cur_mix_value(struct usb_mixer_elem_info *cval,
361 int channel, int index, int *value)
365 if (cval->cached & (1 << channel)) {
366 *value = cval->cache_val[index];
369 err = get_cur_mix_raw(cval, channel, value);
371 if (!cval->mixer->ignore_ctl_error)
372 snd_printd(KERN_ERR "cannot get current value for control %d ch %d: err = %d\n",
373 cval->control, channel, err);
376 cval->cached |= 1 << channel;
377 cval->cache_val[index] = *value;
386 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
387 int request, int validx, int value_set)
389 unsigned char buf[2];
390 int val_len, timeout = 10;
392 if (cval->mixer->protocol == UAC_VERSION_1) {
393 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
394 } else { /* UAC_VERSION_2 */
395 /* audio class v2 controls are always 2 bytes in size */
396 val_len = sizeof(__u16);
399 if (request != UAC_SET_CUR) {
400 snd_printdd(KERN_WARNING "RANGE setting not yet supported\n");
404 request = UAC2_CS_CUR;
407 value_set = convert_bytes_value(cval, value_set);
408 buf[0] = value_set & 0xff;
409 buf[1] = (value_set >> 8) & 0xff;
410 while (timeout-- > 0)
411 if (snd_usb_ctl_msg(cval->mixer->chip->dev,
412 usb_sndctrlpipe(cval->mixer->chip->dev, 0),
414 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
415 validx, cval->mixer->ctrlif | (cval->id << 8),
416 buf, val_len, 100) >= 0)
418 snd_printdd(KERN_ERR "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
419 request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type, buf[0], buf[1]);
423 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int value)
425 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
428 static int set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
429 int index, int value)
432 unsigned int read_only = (channel == 0) ?
433 cval->master_readonly :
434 cval->ch_readonly & (1 << (channel - 1));
437 snd_printdd(KERN_INFO "%s(): channel %d of control %d is read_only\n",
438 __func__, channel, cval->control);
442 err = snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, (cval->control << 8) | channel,
446 cval->cached |= 1 << channel;
447 cval->cache_val[index] = value;
452 * TLV callback for mixer volume controls
454 static int mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
455 unsigned int size, unsigned int __user *_tlv)
457 struct usb_mixer_elem_info *cval = kcontrol->private_data;
458 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
460 if (size < sizeof(scale))
462 scale[2] = cval->dBmin;
463 scale[3] = cval->dBmax;
464 if (copy_to_user(_tlv, scale, sizeof(scale)))
470 * parser routines begin here...
473 static int parse_audio_unit(struct mixer_build *state, int unitid);
477 * check if the input/output channel routing is enabled on the given bitmap.
478 * used for mixer unit parser
480 static int check_matrix_bitmap(unsigned char *bmap, int ich, int och, int num_outs)
482 int idx = ich * num_outs + och;
483 return bmap[idx >> 3] & (0x80 >> (idx & 7));
488 * add an alsa control element
489 * search and increment the index until an empty slot is found.
491 * if failed, give up and free the control instance.
494 static int add_control_to_empty(struct mixer_build *state, struct snd_kcontrol *kctl)
496 struct usb_mixer_elem_info *cval = kctl->private_data;
499 while (snd_ctl_find_id(state->chip->card, &kctl->id))
501 if ((err = snd_ctl_add(state->chip->card, kctl)) < 0) {
502 snd_printd(KERN_ERR "cannot add control (err = %d)\n", err);
505 cval->elem_id = &kctl->id;
506 cval->next_id_elem = state->mixer->id_elems[cval->id];
507 state->mixer->id_elems[cval->id] = cval;
513 * get a terminal name string
516 static struct iterm_name_combo {
520 { 0x0300, "Output" },
521 { 0x0301, "Speaker" },
522 { 0x0302, "Headphone" },
523 { 0x0303, "HMD Audio" },
524 { 0x0304, "Desktop Speaker" },
525 { 0x0305, "Room Speaker" },
526 { 0x0306, "Com Speaker" },
528 { 0x0600, "External In" },
529 { 0x0601, "Analog In" },
530 { 0x0602, "Digital In" },
532 { 0x0604, "Legacy In" },
533 { 0x0605, "IEC958 In" },
534 { 0x0606, "1394 DA Stream" },
535 { 0x0607, "1394 DV Stream" },
536 { 0x0700, "Embedded" },
537 { 0x0701, "Noise Source" },
538 { 0x0702, "Equalization Noise" },
542 { 0x0706, "MiniDisk" },
543 { 0x0707, "Analog Tape" },
544 { 0x0708, "Phonograph" },
545 { 0x0709, "VCR Audio" },
546 { 0x070a, "Video Disk Audio" },
547 { 0x070b, "DVD Audio" },
548 { 0x070c, "TV Tuner Audio" },
549 { 0x070d, "Satellite Rec Audio" },
550 { 0x070e, "Cable Tuner Audio" },
551 { 0x070f, "DSS Audio" },
552 { 0x0710, "Radio Receiver" },
553 { 0x0711, "Radio Transmitter" },
554 { 0x0712, "Multi-Track Recorder" },
555 { 0x0713, "Synthesizer" },
559 static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
560 unsigned char *name, int maxlen, int term_only)
562 struct iterm_name_combo *names;
565 return snd_usb_copy_string_desc(state, iterm->name, name, maxlen);
567 /* virtual type - not a real terminal */
568 if (iterm->type >> 16) {
571 switch (iterm->type >> 16) {
572 case UAC_SELECTOR_UNIT:
573 strcpy(name, "Selector"); return 8;
574 case UAC_PROCESSING_UNIT_V1:
575 strcpy(name, "Process Unit"); return 12;
576 case UAC_EXTENSION_UNIT_V1:
577 strcpy(name, "Ext Unit"); return 8;
579 strcpy(name, "Mixer"); return 5;
581 return sprintf(name, "Unit %d", iterm->id);
585 switch (iterm->type & 0xff00) {
587 strcpy(name, "PCM"); return 3;
589 strcpy(name, "Mic"); return 3;
591 strcpy(name, "Headset"); return 7;
593 strcpy(name, "Phone"); return 5;
596 for (names = iterm_names; names->type; names++)
597 if (names->type == iterm->type) {
598 strcpy(name, names->name);
599 return strlen(names->name);
606 * parse the source unit recursively until it reaches to a terminal
607 * or a branched unit.
609 static int check_input_term(struct mixer_build *state, int id, struct usb_audio_term *term)
613 memset(term, 0, sizeof(*term));
614 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
615 unsigned char *hdr = p1;
618 case UAC_INPUT_TERMINAL:
619 if (state->mixer->protocol == UAC_VERSION_1) {
620 struct uac_input_terminal_descriptor *d = p1;
621 term->type = le16_to_cpu(d->wTerminalType);
622 term->channels = d->bNrChannels;
623 term->chconfig = le16_to_cpu(d->wChannelConfig);
624 term->name = d->iTerminal;
625 } else { /* UAC_VERSION_2 */
626 struct uac2_input_terminal_descriptor *d = p1;
627 term->type = le16_to_cpu(d->wTerminalType);
628 term->channels = d->bNrChannels;
629 term->chconfig = le32_to_cpu(d->bmChannelConfig);
630 term->name = d->iTerminal;
633 case UAC_FEATURE_UNIT: {
634 /* the header is the same for v1 and v2 */
635 struct uac_feature_unit_descriptor *d = p1;
637 break; /* continue to parse */
639 case UAC_MIXER_UNIT: {
640 struct uac_mixer_unit_descriptor *d = p1;
641 term->type = d->bDescriptorSubtype << 16; /* virtual type */
642 term->channels = uac_mixer_unit_bNrChannels(d);
643 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
644 term->name = uac_mixer_unit_iMixer(d);
647 case UAC_SELECTOR_UNIT: {
648 struct uac_selector_unit_descriptor *d = p1;
649 /* call recursively to retrieve the channel info */
650 if (check_input_term(state, d->baSourceID[0], term) < 0)
652 term->type = d->bDescriptorSubtype << 16; /* virtual type */
654 term->name = uac_selector_unit_iSelector(d);
657 case UAC_PROCESSING_UNIT_V1:
658 case UAC_EXTENSION_UNIT_V1: {
659 struct uac_processing_unit_descriptor *d = p1;
661 id = d->baSourceID[0];
662 break; /* continue to parse */
664 term->type = d->bDescriptorSubtype << 16; /* virtual type */
665 term->channels = uac_processing_unit_bNrChannels(d);
666 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
667 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
682 /* feature unit control information */
683 struct usb_feature_control_info {
685 unsigned int type; /* control type (mute, volume, etc.) */
688 static struct usb_feature_control_info audio_feature_info[] = {
689 { "Mute", USB_MIXER_INV_BOOLEAN },
690 { "Volume", USB_MIXER_S16 },
691 { "Tone Control - Bass", USB_MIXER_S8 },
692 { "Tone Control - Mid", USB_MIXER_S8 },
693 { "Tone Control - Treble", USB_MIXER_S8 },
694 { "Graphic Equalizer", USB_MIXER_S8 }, /* FIXME: not implemeted yet */
695 { "Auto Gain Control", USB_MIXER_BOOLEAN },
696 { "Delay Control", USB_MIXER_U16 },
697 { "Bass Boost", USB_MIXER_BOOLEAN },
698 { "Loudness", USB_MIXER_BOOLEAN },
702 /* private_free callback */
703 static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
705 kfree(kctl->private_data);
706 kctl->private_data = NULL;
711 * interface to ALSA control for feature/mixer units
715 * retrieve the minimum and maximum values for the specified control
717 static int get_min_max(struct usb_mixer_elem_info *cval, int default_min)
720 cval->min = default_min;
721 cval->max = cval->min + 1;
723 cval->dBmin = cval->dBmax = 0;
725 if (cval->val_type == USB_MIXER_BOOLEAN ||
726 cval->val_type == USB_MIXER_INV_BOOLEAN) {
727 cval->initialized = 1;
732 for (i = 0; i < MAX_CHANNELS; i++)
733 if (cval->cmask & (1 << i)) {
738 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
739 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
740 snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
741 cval->id, cval->mixer->ctrlif, cval->control, cval->id);
744 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
747 int last_valid_res = cval->res;
749 while (cval->res > 1) {
750 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
751 (cval->control << 8) | minchn, cval->res / 2) < 0)
755 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
756 cval->res = last_valid_res;
761 /* Additional checks for the proper resolution
763 * Some devices report smaller resolutions than actually
764 * reacting. They don't return errors but simply clip
765 * to the lower aligned value.
767 if (cval->min + cval->res < cval->max) {
768 int last_valid_res = cval->res;
769 int saved, test, check;
770 get_cur_mix_raw(cval, minchn, &saved);
773 if (test < cval->max)
777 if (test < cval->min || test > cval->max ||
778 set_cur_mix_value(cval, minchn, 0, test) ||
779 get_cur_mix_raw(cval, minchn, &check)) {
780 cval->res = last_valid_res;
787 set_cur_mix_value(cval, minchn, 0, saved);
790 cval->initialized = 1;
793 /* USB descriptions contain the dB scale in 1/256 dB unit
794 * while ALSA TLV contains in 1/100 dB unit
796 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
797 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
798 if (cval->dBmin > cval->dBmax) {
799 /* something is wrong; assume it's either from/to 0dB */
802 else if (cval->dBmin > 0)
804 if (cval->dBmin > cval->dBmax) {
805 /* totally crap, return an error */
814 /* get a feature/mixer unit info */
815 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
817 struct usb_mixer_elem_info *cval = kcontrol->private_data;
819 if (cval->val_type == USB_MIXER_BOOLEAN ||
820 cval->val_type == USB_MIXER_INV_BOOLEAN)
821 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
823 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
824 uinfo->count = cval->channels;
825 if (cval->val_type == USB_MIXER_BOOLEAN ||
826 cval->val_type == USB_MIXER_INV_BOOLEAN) {
827 uinfo->value.integer.min = 0;
828 uinfo->value.integer.max = 1;
830 if (! cval->initialized)
831 get_min_max(cval, 0);
832 uinfo->value.integer.min = 0;
833 uinfo->value.integer.max =
834 (cval->max - cval->min + cval->res - 1) / cval->res;
839 /* get the current value from feature/mixer unit */
840 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
842 struct usb_mixer_elem_info *cval = kcontrol->private_data;
843 int c, cnt, val, err;
845 ucontrol->value.integer.value[0] = cval->min;
848 for (c = 0; c < MAX_CHANNELS; c++) {
849 if (!(cval->cmask & (1 << c)))
851 err = get_cur_mix_value(cval, c + 1, cnt, &val);
853 return cval->mixer->ignore_ctl_error ? 0 : err;
854 val = get_relative_value(cval, val);
855 ucontrol->value.integer.value[cnt] = val;
861 err = get_cur_mix_value(cval, 0, 0, &val);
863 return cval->mixer->ignore_ctl_error ? 0 : err;
864 val = get_relative_value(cval, val);
865 ucontrol->value.integer.value[0] = val;
870 /* put the current value to feature/mixer unit */
871 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
873 struct usb_mixer_elem_info *cval = kcontrol->private_data;
874 int c, cnt, val, oval, err;
879 for (c = 0; c < MAX_CHANNELS; c++) {
880 if (!(cval->cmask & (1 << c)))
882 err = get_cur_mix_value(cval, c + 1, cnt, &oval);
884 return cval->mixer->ignore_ctl_error ? 0 : err;
885 val = ucontrol->value.integer.value[cnt];
886 val = get_abs_value(cval, val);
888 set_cur_mix_value(cval, c + 1, cnt, val);
895 err = get_cur_mix_value(cval, 0, 0, &oval);
897 return cval->mixer->ignore_ctl_error ? 0 : err;
898 val = ucontrol->value.integer.value[0];
899 val = get_abs_value(cval, val);
901 set_cur_mix_value(cval, 0, 0, val);
908 static struct snd_kcontrol_new usb_feature_unit_ctl = {
909 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
910 .name = "", /* will be filled later manually */
911 .info = mixer_ctl_feature_info,
912 .get = mixer_ctl_feature_get,
913 .put = mixer_ctl_feature_put,
916 /* the read-only variant */
917 static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
918 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
919 .name = "", /* will be filled later manually */
920 .info = mixer_ctl_feature_info,
921 .get = mixer_ctl_feature_get,
927 * build a feature control
930 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
932 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
935 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
936 unsigned int ctl_mask, int control,
937 struct usb_audio_term *iterm, int unitid,
940 struct uac_feature_unit_descriptor *desc = raw_desc;
941 unsigned int len = 0;
943 int nameid = uac_feature_unit_iFeature(desc);
944 struct snd_kcontrol *kctl;
945 struct usb_mixer_elem_info *cval;
946 const struct usbmix_name_map *map;
948 control++; /* change from zero-based to 1-based value */
950 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
951 /* FIXME: not supported yet */
955 map = find_map(state, unitid, control);
956 if (check_ignored_ctl(map))
959 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
961 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
964 cval->mixer = state->mixer;
966 cval->control = control;
967 cval->cmask = ctl_mask;
968 cval->val_type = audio_feature_info[control-1].type;
970 cval->channels = 1; /* master channel */
971 cval->master_readonly = readonly_mask;
974 for (i = 0; i < 16; i++)
975 if (ctl_mask & (1 << i))
978 cval->ch_readonly = readonly_mask;
981 /* get min/max values */
982 get_min_max(cval, 0);
984 /* if all channels in the mask are marked read-only, make the control
985 * read-only. set_cur_mix_value() will check the mask again and won't
986 * issue write commands to read-only channels. */
987 if (cval->channels == readonly_mask)
988 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
990 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
993 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
997 kctl->private_free = usb_mixer_elem_free;
999 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1000 mapped_name = len != 0;
1001 if (! len && nameid)
1002 len = snd_usb_copy_string_desc(state, nameid,
1003 kctl->id.name, sizeof(kctl->id.name));
1008 /* determine the control name. the rule is:
1009 * - if a name id is given in descriptor, use it.
1010 * - if the connected input can be determined, then use the name
1012 * - if the connected output can be determined, use it.
1013 * - otherwise, anonymous name.
1016 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1);
1018 len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1);
1020 len = snprintf(kctl->id.name, sizeof(kctl->id.name),
1021 "Feature %d", unitid);
1023 /* determine the stream direction:
1024 * if the connected output is USB stream, then it's likely a
1025 * capture stream. otherwise it should be playback (hopefully :)
1027 if (! mapped_name && ! (state->oterm.type >> 16)) {
1028 if ((state->oterm.type & 0xff00) == 0x0100) {
1029 len = append_ctl_name(kctl, " Capture");
1031 len = append_ctl_name(kctl, " Playback");
1034 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1035 " Switch" : " Volume");
1036 if (control == UAC_FU_VOLUME) {
1037 kctl->tlv.c = mixer_vol_tlv;
1038 kctl->vd[0].access |=
1039 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1040 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1041 check_mapped_dB(map, cval);
1047 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1048 sizeof(kctl->id.name));
1052 /* volume control quirks */
1053 switch (state->chip->usb_id) {
1054 case USB_ID(0x0471, 0x0101):
1055 case USB_ID(0x0471, 0x0104):
1056 case USB_ID(0x0471, 0x0105):
1057 case USB_ID(0x0672, 0x1041):
1058 /* quirk for UDA1321/N101.
1059 * note that detection between firmware 2.1.1.7 (N101)
1060 * and later 2.1.1.21 is not very clear from datasheets.
1061 * I hope that the min value is -15360 for newer firmware --jk
1063 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
1064 cval->min == -15616) {
1065 snd_printk(KERN_INFO
1066 "set volume quirk for UDA1321/N101 chip\n");
1071 case USB_ID(0x046d, 0x09a4):
1072 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1073 snd_printk(KERN_INFO
1074 "set volume quirk for QuickCam E3500\n");
1083 snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1084 cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
1085 add_control_to_empty(state, kctl);
1091 * parse a feature unit
1093 * most of controlls are defined here.
1095 static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr)
1098 struct usb_audio_term iterm;
1099 unsigned int master_bits, first_ch_bits;
1101 struct uac_feature_unit_descriptor *hdr = _ftr;
1104 if (state->mixer->protocol == UAC_VERSION_1) {
1105 csize = hdr->bControlSize;
1106 channels = (hdr->bLength - 7) / csize - 1;
1107 bmaControls = hdr->bmaControls;
1109 struct uac2_feature_unit_descriptor *ftr = _ftr;
1111 channels = (hdr->bLength - 6) / 4 - 1;
1112 bmaControls = ftr->bmaControls;
1115 if (hdr->bLength < 7 || !csize || hdr->bLength < 7 + csize) {
1116 snd_printk(KERN_ERR "usbaudio: unit %u: invalid UAC_FEATURE_UNIT descriptor\n", unitid);
1120 /* parse the source unit */
1121 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1124 /* determine the input source type and name */
1125 if (check_input_term(state, hdr->bSourceID, &iterm) < 0)
1128 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1129 /* master configuration quirks */
1130 switch (state->chip->usb_id) {
1131 case USB_ID(0x08bb, 0x2702):
1132 snd_printk(KERN_INFO
1133 "usbmixer: master volume quirk for PCM2702 chip\n");
1134 /* disable non-functional volume control */
1135 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1139 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1143 if (state->mixer->protocol == UAC_VERSION_1) {
1144 /* check all control types */
1145 for (i = 0; i < 10; i++) {
1146 unsigned int ch_bits = 0;
1147 for (j = 0; j < channels; j++) {
1148 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1149 if (mask & (1 << i))
1150 ch_bits |= (1 << j);
1152 /* audio class v1 controls are never read-only */
1153 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1154 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, 0);
1155 if (master_bits & (1 << i))
1156 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 0);
1158 } else { /* UAC_VERSION_2 */
1159 for (i = 0; i < 30/2; i++) {
1160 /* From the USB Audio spec v2.0:
1161 bmaControls() is a (ch+1)-element array of 4-byte bitmaps,
1162 each containing a set of bit pairs. If a Control is present,
1163 it must be Host readable. If a certain Control is not
1164 present then the bit pair must be set to 0b00.
1165 If a Control is present but read-only, the bit pair must be
1166 set to 0b01. If a Control is also Host programmable, the bit
1167 pair must be set to 0b11. The value 0b10 is not allowed. */
1168 unsigned int ch_bits = 0;
1169 unsigned int ch_read_only = 0;
1171 for (j = 0; j < channels; j++) {
1172 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1173 if (uac2_control_is_readable(mask, i)) {
1174 ch_bits |= (1 << j);
1175 if (!uac2_control_is_writeable(mask, i))
1176 ch_read_only |= (1 << j);
1180 /* NOTE: build_feature_ctl() will mark the control read-only if all channels
1181 * are marked read-only in the descriptors. Otherwise, the control will be
1182 * reported as writeable, but the driver will not actually issue a write
1183 * command for read-only channels */
1184 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1185 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, ch_read_only);
1186 if (uac2_control_is_readable(master_bits, i))
1187 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1188 !uac2_control_is_writeable(master_bits, i));
1201 * build a mixer unit control
1203 * the callbacks are identical with feature unit.
1204 * input channel number (zero based) is given in control field instead.
1207 static void build_mixer_unit_ctl(struct mixer_build *state,
1208 struct uac_mixer_unit_descriptor *desc,
1209 int in_pin, int in_ch, int unitid,
1210 struct usb_audio_term *iterm)
1212 struct usb_mixer_elem_info *cval;
1213 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1214 unsigned int i, len;
1215 struct snd_kcontrol *kctl;
1216 const struct usbmix_name_map *map;
1218 map = find_map(state, unitid, 0);
1219 if (check_ignored_ctl(map))
1222 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1226 cval->mixer = state->mixer;
1228 cval->control = in_ch + 1; /* based on 1 */
1229 cval->val_type = USB_MIXER_S16;
1230 for (i = 0; i < num_outs; i++) {
1231 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), in_ch, i, num_outs)) {
1232 cval->cmask |= (1 << i);
1237 /* get min/max values */
1238 get_min_max(cval, 0);
1240 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1242 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1246 kctl->private_free = usb_mixer_elem_free;
1248 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1250 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
1252 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1253 append_ctl_name(kctl, " Volume");
1255 snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
1256 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1257 add_control_to_empty(state, kctl);
1262 * parse a mixer unit
1264 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, void *raw_desc)
1266 struct uac_mixer_unit_descriptor *desc = raw_desc;
1267 struct usb_audio_term iterm;
1268 int input_pins, num_ins, num_outs;
1271 if (desc->bLength < 11 || ! (input_pins = desc->bNrInPins) || ! (num_outs = uac_mixer_unit_bNrChannels(desc))) {
1272 snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
1275 /* no bmControls field (e.g. Maya44) -> ignore */
1276 if (desc->bLength <= 10 + input_pins) {
1277 snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
1283 for (pin = 0; pin < input_pins; pin++) {
1284 err = parse_audio_unit(state, desc->baSourceID[pin]);
1287 err = check_input_term(state, desc->baSourceID[pin], &iterm);
1290 num_ins += iterm.channels;
1291 for (; ich < num_ins; ++ich) {
1292 int och, ich_has_controls = 0;
1294 for (och = 0; och < num_outs; ++och) {
1295 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol),
1296 ich, och, num_outs)) {
1297 ich_has_controls = 1;
1301 if (ich_has_controls)
1302 build_mixer_unit_ctl(state, desc, pin, ich,
1311 * Processing Unit / Extension Unit
1314 /* get callback for processing/extension unit */
1315 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1317 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1320 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1321 if (err < 0 && cval->mixer->ignore_ctl_error) {
1322 ucontrol->value.integer.value[0] = cval->min;
1327 val = get_relative_value(cval, val);
1328 ucontrol->value.integer.value[0] = val;
1332 /* put callback for processing/extension unit */
1333 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1335 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1338 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1340 if (cval->mixer->ignore_ctl_error)
1344 val = ucontrol->value.integer.value[0];
1345 val = get_abs_value(cval, val);
1347 set_cur_ctl_value(cval, cval->control << 8, val);
1353 /* alsa control interface for processing/extension unit */
1354 static struct snd_kcontrol_new mixer_procunit_ctl = {
1355 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1356 .name = "", /* will be filled later */
1357 .info = mixer_ctl_feature_info,
1358 .get = mixer_ctl_procunit_get,
1359 .put = mixer_ctl_procunit_put,
1364 * predefined data for processing units
1366 struct procunit_value_info {
1373 struct procunit_info {
1376 struct procunit_value_info *values;
1379 static struct procunit_value_info updown_proc_info[] = {
1380 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1381 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1384 static struct procunit_value_info prologic_proc_info[] = {
1385 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1386 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1389 static struct procunit_value_info threed_enh_proc_info[] = {
1390 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1391 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
1394 static struct procunit_value_info reverb_proc_info[] = {
1395 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1396 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1397 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1398 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
1401 static struct procunit_value_info chorus_proc_info[] = {
1402 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1403 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1404 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1405 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1408 static struct procunit_value_info dcr_proc_info[] = {
1409 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1410 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1411 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1412 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1413 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1414 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
1418 static struct procunit_info procunits[] = {
1419 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1420 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1421 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1422 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1423 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1424 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
1428 * predefined data for extension units
1430 static struct procunit_value_info clock_rate_xu_info[] = {
1431 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1434 static struct procunit_value_info clock_source_xu_info[] = {
1435 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1438 static struct procunit_value_info spdif_format_xu_info[] = {
1439 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1442 static struct procunit_value_info soft_limit_xu_info[] = {
1443 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1446 static struct procunit_info extunits[] = {
1447 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1448 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1449 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1450 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1454 * build a processing/extension unit
1456 static int build_audio_procunit(struct mixer_build *state, int unitid, void *raw_desc, struct procunit_info *list, char *name)
1458 struct uac_processing_unit_descriptor *desc = raw_desc;
1459 int num_ins = desc->bNrInPins;
1460 struct usb_mixer_elem_info *cval;
1461 struct snd_kcontrol *kctl;
1462 int i, err, nameid, type, len;
1463 struct procunit_info *info;
1464 struct procunit_value_info *valinfo;
1465 const struct usbmix_name_map *map;
1466 static struct procunit_value_info default_value_info[] = {
1467 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1470 static struct procunit_info default_info = {
1471 0, NULL, default_value_info
1474 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1475 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
1476 snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1480 for (i = 0; i < num_ins; i++) {
1481 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1485 type = le16_to_cpu(desc->wProcessType);
1486 for (info = list; info && info->type; info++)
1487 if (info->type == type)
1489 if (! info || ! info->type)
1490 info = &default_info;
1492 for (valinfo = info->values; valinfo->control; valinfo++) {
1493 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
1495 if (! (controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
1497 map = find_map(state, unitid, valinfo->control);
1498 if (check_ignored_ctl(map))
1500 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1502 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1505 cval->mixer = state->mixer;
1507 cval->control = valinfo->control;
1508 cval->val_type = valinfo->val_type;
1511 /* get min/max values */
1512 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
1513 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
1514 /* FIXME: hard-coded */
1516 cval->max = control_spec[0];
1518 cval->initialized = 1;
1520 if (type == USB_XU_CLOCK_RATE) {
1521 /* E-Mu USB 0404/0202/TrackerPre
1522 * samplerate control quirk
1527 cval->initialized = 1;
1529 get_min_max(cval, valinfo->min_value);
1532 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1534 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1538 kctl->private_free = usb_mixer_elem_free;
1540 if (check_mapped_name(map, kctl->id.name,
1541 sizeof(kctl->id.name)))
1543 else if (info->name)
1544 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1546 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
1549 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1551 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1553 append_ctl_name(kctl, " ");
1554 append_ctl_name(kctl, valinfo->suffix);
1556 snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
1557 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1558 if ((err = add_control_to_empty(state, kctl)) < 0)
1565 static int parse_audio_processing_unit(struct mixer_build *state, int unitid, void *raw_desc)
1567 return build_audio_procunit(state, unitid, raw_desc, procunits, "Processing Unit");
1570 static int parse_audio_extension_unit(struct mixer_build *state, int unitid, void *raw_desc)
1572 /* Note that we parse extension units with processing unit descriptors.
1573 * That's ok as the layout is the same */
1574 return build_audio_procunit(state, unitid, raw_desc, extunits, "Extension Unit");
1582 /* info callback for selector unit
1583 * use an enumerator type for routing
1585 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
1587 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1588 char **itemlist = (char **)kcontrol->private_value;
1590 if (snd_BUG_ON(!itemlist))
1592 uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1594 uinfo->value.enumerated.items = cval->max;
1595 if ((int)uinfo->value.enumerated.item >= cval->max)
1596 uinfo->value.enumerated.item = cval->max - 1;
1597 strcpy(uinfo->value.enumerated.name, itemlist[uinfo->value.enumerated.item]);
1601 /* get callback for selector unit */
1602 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1604 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1607 err = get_cur_ctl_value(cval, 0, &val);
1609 if (cval->mixer->ignore_ctl_error) {
1610 ucontrol->value.enumerated.item[0] = 0;
1615 val = get_relative_value(cval, val);
1616 ucontrol->value.enumerated.item[0] = val;
1620 /* put callback for selector unit */
1621 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1623 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1626 err = get_cur_ctl_value(cval, 0, &oval);
1628 if (cval->mixer->ignore_ctl_error)
1632 val = ucontrol->value.enumerated.item[0];
1633 val = get_abs_value(cval, val);
1635 set_cur_ctl_value(cval, 0, val);
1641 /* alsa control interface for selector unit */
1642 static struct snd_kcontrol_new mixer_selectunit_ctl = {
1643 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1644 .name = "", /* will be filled later */
1645 .info = mixer_ctl_selector_info,
1646 .get = mixer_ctl_selector_get,
1647 .put = mixer_ctl_selector_put,
1651 /* private free callback.
1652 * free both private_data and private_value
1654 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
1658 if (kctl->private_data) {
1659 struct usb_mixer_elem_info *cval = kctl->private_data;
1660 num_ins = cval->max;
1662 kctl->private_data = NULL;
1664 if (kctl->private_value) {
1665 char **itemlist = (char **)kctl->private_value;
1666 for (i = 0; i < num_ins; i++)
1669 kctl->private_value = 0;
1674 * parse a selector unit
1676 static int parse_audio_selector_unit(struct mixer_build *state, int unitid, void *raw_desc)
1678 struct uac_selector_unit_descriptor *desc = raw_desc;
1679 unsigned int i, nameid, len;
1681 struct usb_mixer_elem_info *cval;
1682 struct snd_kcontrol *kctl;
1683 const struct usbmix_name_map *map;
1686 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
1687 snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
1691 for (i = 0; i < desc->bNrInPins; i++) {
1692 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1696 if (desc->bNrInPins == 1) /* only one ? nonsense! */
1699 map = find_map(state, unitid, 0);
1700 if (check_ignored_ctl(map))
1703 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1705 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1708 cval->mixer = state->mixer;
1710 cval->val_type = USB_MIXER_U8;
1713 cval->max = desc->bNrInPins;
1715 cval->initialized = 1;
1717 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
1719 snd_printk(KERN_ERR "cannot malloc\n");
1723 #define MAX_ITEM_NAME_LEN 64
1724 for (i = 0; i < desc->bNrInPins; i++) {
1725 struct usb_audio_term iterm;
1727 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
1728 if (! namelist[i]) {
1729 snd_printk(KERN_ERR "cannot malloc\n");
1736 len = check_mapped_selector_name(state, unitid, i, namelist[i],
1738 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
1739 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
1741 sprintf(namelist[i], "Input %d", i);
1744 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
1746 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1751 kctl->private_value = (unsigned long)namelist;
1752 kctl->private_free = usb_mixer_selector_elem_free;
1754 nameid = uac_selector_unit_iSelector(desc);
1755 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1759 snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1761 len = get_term_name(state, &state->oterm,
1762 kctl->id.name, sizeof(kctl->id.name), 0);
1764 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
1766 if ((state->oterm.type & 0xff00) == 0x0100)
1767 append_ctl_name(kctl, " Capture Source");
1769 append_ctl_name(kctl, " Playback Source");
1772 snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
1773 cval->id, kctl->id.name, desc->bNrInPins);
1774 if ((err = add_control_to_empty(state, kctl)) < 0)
1782 * parse an audio unit recursively
1785 static int parse_audio_unit(struct mixer_build *state, int unitid)
1789 if (test_and_set_bit(unitid, state->unitbitmap))
1790 return 0; /* the unit already visited */
1792 p1 = find_audio_control_unit(state, unitid);
1794 snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
1799 case UAC_INPUT_TERMINAL:
1801 case UAC_MIXER_UNIT:
1802 return parse_audio_mixer_unit(state, unitid, p1);
1803 case UAC_SELECTOR_UNIT:
1804 return parse_audio_selector_unit(state, unitid, p1);
1805 case UAC_FEATURE_UNIT:
1806 return parse_audio_feature_unit(state, unitid, p1);
1807 case UAC_PROCESSING_UNIT_V1:
1808 /* UAC2_EFFECT_UNIT has the same value */
1809 if (state->mixer->protocol == UAC_VERSION_1)
1810 return parse_audio_processing_unit(state, unitid, p1);
1812 return 0; /* FIXME - effect units not implemented yet */
1813 case UAC_EXTENSION_UNIT_V1:
1814 /* UAC2_PROCESSING_UNIT_V2 has the same value */
1815 if (state->mixer->protocol == UAC_VERSION_1)
1816 return parse_audio_extension_unit(state, unitid, p1);
1817 else /* UAC_VERSION_2 */
1818 return parse_audio_processing_unit(state, unitid, p1);
1820 snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
1825 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
1827 kfree(mixer->id_elems);
1829 kfree(mixer->urb->transfer_buffer);
1830 usb_free_urb(mixer->urb);
1832 usb_free_urb(mixer->rc_urb);
1833 kfree(mixer->rc_setup_packet);
1837 static int snd_usb_mixer_dev_free(struct snd_device *device)
1839 struct usb_mixer_interface *mixer = device->device_data;
1840 snd_usb_mixer_free(mixer);
1845 * create mixer controls
1847 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
1849 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
1851 struct mixer_build state;
1853 const struct usbmix_ctl_map *map;
1854 struct usb_host_interface *hostif;
1857 hostif = &usb_ifnum_to_if(mixer->chip->dev, mixer->ctrlif)->altsetting[0];
1858 memset(&state, 0, sizeof(state));
1859 state.chip = mixer->chip;
1860 state.mixer = mixer;
1861 state.buffer = hostif->extra;
1862 state.buflen = hostif->extralen;
1864 /* check the mapping table */
1865 for (map = usbmix_ctl_maps; map->id; map++) {
1866 if (map->id == state.chip->usb_id) {
1867 state.map = map->map;
1868 state.selector_map = map->selector_map;
1869 mixer->ignore_ctl_error = map->ignore_ctl_error;
1875 while ((p = snd_usb_find_csint_desc(hostif->extra, hostif->extralen, p, UAC_OUTPUT_TERMINAL)) != NULL) {
1876 if (mixer->protocol == UAC_VERSION_1) {
1877 struct uac_output_terminal_descriptor_v1 *desc = p;
1879 if (desc->bLength < sizeof(*desc))
1880 continue; /* invalid descriptor? */
1881 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
1882 state.oterm.id = desc->bTerminalID;
1883 state.oterm.type = le16_to_cpu(desc->wTerminalType);
1884 state.oterm.name = desc->iTerminal;
1885 err = parse_audio_unit(&state, desc->bSourceID);
1888 } else { /* UAC_VERSION_2 */
1889 struct uac2_output_terminal_descriptor *desc = p;
1891 if (desc->bLength < sizeof(*desc))
1892 continue; /* invalid descriptor? */
1893 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
1894 state.oterm.id = desc->bTerminalID;
1895 state.oterm.type = le16_to_cpu(desc->wTerminalType);
1896 state.oterm.name = desc->iTerminal;
1897 err = parse_audio_unit(&state, desc->bSourceID);
1906 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
1908 struct usb_mixer_elem_info *info;
1910 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
1911 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
1915 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
1917 struct usb_mixer_elem_info *cval)
1919 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
1920 "S8", "U8", "S16", "U16"};
1921 snd_iprintf(buffer, " Unit: %i\n", unitid);
1923 snd_iprintf(buffer, " Control: name=\"%s\", index=%i\n",
1924 cval->elem_id->name, cval->elem_id->index);
1925 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
1926 "channels=%i, type=\"%s\"\n", cval->id,
1927 cval->control, cval->cmask, cval->channels,
1928 val_types[cval->val_type]);
1929 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
1930 cval->min, cval->max, cval->dBmin, cval->dBmax);
1933 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
1934 struct snd_info_buffer *buffer)
1936 struct snd_usb_audio *chip = entry->private_data;
1937 struct usb_mixer_interface *mixer;
1938 struct usb_mixer_elem_info *cval;
1941 list_for_each_entry(mixer, &chip->mixer_list, list) {
1943 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
1944 chip->usb_id, mixer->ctrlif,
1945 mixer->ignore_ctl_error);
1946 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
1947 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
1948 for (cval = mixer->id_elems[unitid]; cval;
1949 cval = cval->next_id_elem)
1950 snd_usb_mixer_dump_cval(buffer, unitid, cval);
1955 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
1956 int attribute, int value, int index)
1958 struct usb_mixer_elem_info *info;
1959 __u8 unitid = (index >> 8) & 0xff;
1960 __u8 control = (value >> 8) & 0xff;
1961 __u8 channel = value & 0xff;
1963 if (channel >= MAX_CHANNELS) {
1964 snd_printk(KERN_DEBUG "%s(): bogus channel number %d\n",
1969 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) {
1970 if (info->control != control)
1973 switch (attribute) {
1975 /* invalidate cache, so the value is read from the device */
1977 info->cached &= ~(1 << channel);
1978 else /* master channel */
1981 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
1994 snd_printk(KERN_DEBUG "unknown attribute %d in interrupt\n",
2001 static void snd_usb_mixer_interrupt(struct urb *urb)
2003 struct usb_mixer_interface *mixer = urb->context;
2004 int len = urb->actual_length;
2006 if (urb->status != 0)
2009 if (mixer->protocol == UAC_VERSION_1) {
2010 struct uac1_status_word *status;
2012 for (status = urb->transfer_buffer;
2013 len >= sizeof(*status);
2014 len -= sizeof(*status), status++) {
2015 snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
2016 status->bStatusType,
2017 status->bOriginator);
2019 /* ignore any notifications not from the control interface */
2020 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2021 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2024 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2025 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2027 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2029 } else { /* UAC_VERSION_2 */
2030 struct uac2_interrupt_data_msg *msg;
2032 for (msg = urb->transfer_buffer;
2033 len >= sizeof(*msg);
2034 len -= sizeof(*msg), msg++) {
2035 /* drop vendor specific and endpoint requests */
2036 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2037 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2040 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2041 le16_to_cpu(msg->wValue),
2042 le16_to_cpu(msg->wIndex));
2047 if (urb->status != -ENOENT && urb->status != -ECONNRESET) {
2048 urb->dev = mixer->chip->dev;
2049 usb_submit_urb(urb, GFP_ATOMIC);
2053 /* create the handler for the optional status interrupt endpoint */
2054 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2056 struct usb_host_interface *hostif;
2057 struct usb_endpoint_descriptor *ep;
2058 void *transfer_buffer;
2062 hostif = &usb_ifnum_to_if(mixer->chip->dev, mixer->ctrlif)->altsetting[0];
2063 /* we need one interrupt input endpoint */
2064 if (get_iface_desc(hostif)->bNumEndpoints < 1)
2066 ep = get_endpoint(hostif, 0);
2067 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2070 epnum = usb_endpoint_num(ep);
2071 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2072 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2073 if (!transfer_buffer)
2075 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2077 kfree(transfer_buffer);
2080 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2081 usb_rcvintpipe(mixer->chip->dev, epnum),
2082 transfer_buffer, buffer_length,
2083 snd_usb_mixer_interrupt, mixer, ep->bInterval);
2084 usb_submit_urb(mixer->urb, GFP_KERNEL);
2088 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2091 static struct snd_device_ops dev_ops = {
2092 .dev_free = snd_usb_mixer_dev_free
2094 struct usb_mixer_interface *mixer;
2095 struct snd_info_entry *entry;
2096 struct usb_host_interface *host_iface;
2099 strcpy(chip->card->mixername, "USB Mixer");
2101 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2105 mixer->ctrlif = ctrlif;
2106 mixer->ignore_ctl_error = ignore_error;
2107 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2109 if (!mixer->id_elems) {
2114 host_iface = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2115 mixer->protocol = get_iface_desc(host_iface)->bInterfaceProtocol;
2117 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2118 (err = snd_usb_mixer_status_create(mixer)) < 0)
2121 snd_usb_mixer_apply_create_quirk(mixer);
2123 err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
2127 if (list_empty(&chip->mixer_list) &&
2128 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2129 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2131 list_add(&mixer->list, &chip->mixer_list);
2135 snd_usb_mixer_free(mixer);
2139 void snd_usb_mixer_disconnect(struct list_head *p)
2141 struct usb_mixer_interface *mixer;
2143 mixer = list_entry(p, struct usb_mixer_interface, list);
2144 usb_kill_urb(mixer->urb);
2145 usb_kill_urb(mixer->rc_urb);