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
30 * TODOs, for both the mixer and the streaming interfaces:
32 * - support for UAC2 effect units
33 * - support for graphical equalizers
34 * - RANGE and MEM set commands (UAC2)
35 * - RANGE and MEM interrupt dispatchers (UAC2)
36 * - audio channel clustering (UAC2)
37 * - audio sample rate converter units (UAC2)
38 * - proper handling of clock multipliers (UAC2)
39 * - dispatch clock change notifications (UAC2)
40 * - stop PCM streams which use a clock that became invalid
41 * - stop PCM streams which use a clock selector that has changed
42 * - parse available sample rates again when clock sources changed
45 #include <linux/bitops.h>
46 #include <linux/init.h>
47 #include <linux/list.h>
48 #include <linux/log2.h>
49 #include <linux/slab.h>
50 #include <linux/string.h>
51 #include <linux/usb.h>
52 #include <linux/usb/audio.h>
53 #include <linux/usb/audio-v2.h>
55 #include <sound/core.h>
56 #include <sound/control.h>
57 #include <sound/hwdep.h>
58 #include <sound/info.h>
59 #include <sound/tlv.h>
64 #include "mixer_quirks.h"
67 #define MAX_ID_ELEMS 256
69 struct usb_audio_term {
73 unsigned int chconfig;
77 struct usbmix_name_map;
80 struct snd_usb_audio *chip;
81 struct usb_mixer_interface *mixer;
82 unsigned char *buffer;
84 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
85 DECLARE_BITMAP(termbitmap, MAX_ID_ELEMS);
86 struct usb_audio_term oterm;
87 const struct usbmix_name_map *map;
88 const struct usbmix_selector_map *selector_map;
91 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
93 USB_XU_CLOCK_RATE = 0xe301,
94 USB_XU_CLOCK_SOURCE = 0xe302,
95 USB_XU_DIGITAL_IO_STATUS = 0xe303,
96 USB_XU_DEVICE_OPTIONS = 0xe304,
97 USB_XU_DIRECT_MONITORING = 0xe305,
98 USB_XU_METERING = 0xe306
101 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/
102 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */
103 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */
104 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */
108 * manual mapping of mixer names
109 * if the mixer topology is too complicated and the parsed names are
110 * ambiguous, add the entries in usbmixer_maps.c.
112 #include "mixer_maps.c"
114 static const struct usbmix_name_map *
115 find_map(struct mixer_build *state, int unitid, int control)
117 const struct usbmix_name_map *p = state->map;
122 for (p = state->map; p->id; p++) {
123 if (p->id == unitid &&
124 (!control || !p->control || control == p->control))
130 /* get the mapped name if the unit matches */
132 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
138 return strlcpy(buf, p->name, buflen);
141 /* ignore the error value if ignore_ctl_error flag is set */
142 #define filter_error(cval, err) \
143 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
145 /* check whether the control should be ignored */
147 check_ignored_ctl(const struct usbmix_name_map *p)
149 if (!p || p->name || p->dB)
155 static inline void check_mapped_dB(const struct usbmix_name_map *p,
156 struct usb_mixer_elem_info *cval)
159 cval->dBmin = p->dB->min;
160 cval->dBmax = p->dB->max;
161 cval->initialized = 1;
165 /* get the mapped selector source name */
166 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
167 int index, char *buf, int buflen)
169 const struct usbmix_selector_map *p;
171 if (!state->selector_map)
173 for (p = state->selector_map; p->id; p++) {
174 if (p->id == unitid && index < p->count)
175 return strlcpy(buf, p->names[index], buflen);
181 * find an audio control unit with the given unit id
183 static void *find_audio_control_unit(struct mixer_build *state,
186 /* we just parse the header */
187 struct uac_feature_unit_descriptor *hdr = NULL;
189 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
190 USB_DT_CS_INTERFACE)) != NULL) {
191 if (hdr->bLength >= 4 &&
192 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
193 hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
194 hdr->bUnitID == unit)
202 * copy a string with the given id
204 static int snd_usb_copy_string_desc(struct mixer_build *state,
205 int index, char *buf, int maxlen)
207 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
217 * convert from the byte/word on usb descriptor to the zero-based integer
219 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
221 switch (cval->val_type) {
222 case USB_MIXER_BOOLEAN:
224 case USB_MIXER_INV_BOOLEAN:
247 * convert from the zero-based int to the byte/word for usb descriptor
249 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
251 switch (cval->val_type) {
252 case USB_MIXER_BOOLEAN:
254 case USB_MIXER_INV_BOOLEAN:
263 return 0; /* not reached */
266 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
272 else if (val >= cval->max)
273 return (cval->max - cval->min + cval->res - 1) / cval->res;
275 return (val - cval->min) / cval->res;
278 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
291 static int uac2_ctl_value_size(int val_type)
303 return 0; /* unreachable */
308 * retrieve a mixer value
311 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
312 int validx, int *value_ret)
314 struct snd_usb_audio *chip = cval->head.mixer->chip;
315 unsigned char buf[2];
316 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
320 err = snd_usb_lock_shutdown(chip);
324 while (timeout-- > 0) {
325 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
326 err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
327 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
328 validx, idx, buf, val_len);
329 if (err >= val_len) {
330 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
333 } else if (err == -ETIMEDOUT) {
338 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
339 request, validx, idx, cval->val_type);
343 snd_usb_unlock_shutdown(chip);
347 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
348 int validx, int *value_ret)
350 struct snd_usb_audio *chip = cval->head.mixer->chip;
351 /* enough space for one range */
352 unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
354 int idx = 0, ret, val_size, size;
357 val_size = uac2_ctl_value_size(cval->val_type);
359 if (request == UAC_GET_CUR) {
360 bRequest = UAC2_CS_CUR;
363 bRequest = UAC2_CS_RANGE;
364 size = sizeof(__u16) + 3 * val_size;
367 memset(buf, 0, sizeof(buf));
369 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
373 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
374 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
375 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
376 validx, idx, buf, size);
377 snd_usb_unlock_shutdown(chip);
382 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
383 request, validx, idx, cval->val_type);
387 /* FIXME: how should we handle multiple triplets here? */
394 val = buf + sizeof(__u16);
397 val = buf + sizeof(__u16) + val_size;
400 val = buf + sizeof(__u16) + val_size * 2;
406 *value_ret = convert_signed_value(cval,
407 snd_usb_combine_bytes(val, val_size));
412 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
413 int validx, int *value_ret)
415 validx += cval->idx_off;
417 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
418 get_ctl_value_v1(cval, request, validx, value_ret) :
419 get_ctl_value_v2(cval, request, validx, value_ret);
422 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
423 int validx, int *value)
425 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
428 /* channel = 0: master, 1 = first channel */
429 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
430 int channel, int *value)
432 return get_ctl_value(cval, UAC_GET_CUR,
433 (cval->control << 8) | channel,
437 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
438 int channel, int index, int *value)
442 if (cval->cached & (1 << channel)) {
443 *value = cval->cache_val[index];
446 err = get_cur_mix_raw(cval, channel, value);
448 if (!cval->head.mixer->ignore_ctl_error)
449 usb_audio_dbg(cval->head.mixer->chip,
450 "cannot get current value for control %d ch %d: err = %d\n",
451 cval->control, channel, err);
454 cval->cached |= 1 << channel;
455 cval->cache_val[index] = *value;
463 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
464 int request, int validx, int value_set)
466 struct snd_usb_audio *chip = cval->head.mixer->chip;
467 unsigned char buf[4];
468 int idx = 0, val_len, err, timeout = 10;
470 validx += cval->idx_off;
472 if (cval->head.mixer->protocol == UAC_VERSION_1) {
473 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
474 } else { /* UAC_VERSION_2 */
475 val_len = uac2_ctl_value_size(cval->val_type);
478 if (request != UAC_SET_CUR) {
479 usb_audio_dbg(chip, "RANGE setting not yet supported\n");
483 request = UAC2_CS_CUR;
486 value_set = convert_bytes_value(cval, value_set);
487 buf[0] = value_set & 0xff;
488 buf[1] = (value_set >> 8) & 0xff;
489 buf[2] = (value_set >> 16) & 0xff;
490 buf[3] = (value_set >> 24) & 0xff;
492 err = snd_usb_lock_shutdown(chip);
496 while (timeout-- > 0) {
497 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
498 err = snd_usb_ctl_msg(chip->dev,
499 usb_sndctrlpipe(chip->dev, 0), request,
500 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
501 validx, idx, buf, val_len);
505 } else if (err == -ETIMEDOUT) {
509 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
510 request, validx, idx, cval->val_type, buf[0], buf[1]);
514 snd_usb_unlock_shutdown(chip);
518 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
519 int validx, int value)
521 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
524 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
525 int index, int value)
528 unsigned int read_only = (channel == 0) ?
529 cval->master_readonly :
530 cval->ch_readonly & (1 << (channel - 1));
533 usb_audio_dbg(cval->head.mixer->chip,
534 "%s(): channel %d of control %d is read_only\n",
535 __func__, channel, cval->control);
539 err = snd_usb_mixer_set_ctl_value(cval,
540 UAC_SET_CUR, (cval->control << 8) | channel,
544 cval->cached |= 1 << channel;
545 cval->cache_val[index] = value;
550 * TLV callback for mixer volume controls
552 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
553 unsigned int size, unsigned int __user *_tlv)
555 struct usb_mixer_elem_info *cval = kcontrol->private_data;
556 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
558 if (size < sizeof(scale))
561 scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE;
562 scale[2] = cval->dBmin;
563 scale[3] = cval->dBmax;
564 if (copy_to_user(_tlv, scale, sizeof(scale)))
570 * parser routines begin here...
573 static int parse_audio_unit(struct mixer_build *state, int unitid);
577 * check if the input/output channel routing is enabled on the given bitmap.
578 * used for mixer unit parser
580 static int check_matrix_bitmap(unsigned char *bmap,
581 int ich, int och, int num_outs)
583 int idx = ich * num_outs + och;
584 return bmap[idx >> 3] & (0x80 >> (idx & 7));
588 * add an alsa control element
589 * search and increment the index until an empty slot is found.
591 * if failed, give up and free the control instance.
594 int snd_usb_mixer_add_list(struct usb_mixer_elem_list *list,
595 struct snd_kcontrol *kctl,
598 struct usb_mixer_interface *mixer = list->mixer;
601 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
603 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
604 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
609 list->is_std_info = is_std_info;
610 list->next_id_elem = mixer->id_elems[list->id];
611 mixer->id_elems[list->id] = list;
616 * get a terminal name string
619 static struct iterm_name_combo {
623 { 0x0300, "Output" },
624 { 0x0301, "Speaker" },
625 { 0x0302, "Headphone" },
626 { 0x0303, "HMD Audio" },
627 { 0x0304, "Desktop Speaker" },
628 { 0x0305, "Room Speaker" },
629 { 0x0306, "Com Speaker" },
631 { 0x0600, "External In" },
632 { 0x0601, "Analog In" },
633 { 0x0602, "Digital In" },
635 { 0x0604, "Legacy In" },
636 { 0x0605, "IEC958 In" },
637 { 0x0606, "1394 DA Stream" },
638 { 0x0607, "1394 DV Stream" },
639 { 0x0700, "Embedded" },
640 { 0x0701, "Noise Source" },
641 { 0x0702, "Equalization Noise" },
645 { 0x0706, "MiniDisk" },
646 { 0x0707, "Analog Tape" },
647 { 0x0708, "Phonograph" },
648 { 0x0709, "VCR Audio" },
649 { 0x070a, "Video Disk Audio" },
650 { 0x070b, "DVD Audio" },
651 { 0x070c, "TV Tuner Audio" },
652 { 0x070d, "Satellite Rec Audio" },
653 { 0x070e, "Cable Tuner Audio" },
654 { 0x070f, "DSS Audio" },
655 { 0x0710, "Radio Receiver" },
656 { 0x0711, "Radio Transmitter" },
657 { 0x0712, "Multi-Track Recorder" },
658 { 0x0713, "Synthesizer" },
662 static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
663 unsigned char *name, int maxlen, int term_only)
665 struct iterm_name_combo *names;
668 return snd_usb_copy_string_desc(state, iterm->name,
671 /* virtual type - not a real terminal */
672 if (iterm->type >> 16) {
675 switch (iterm->type >> 16) {
676 case UAC_SELECTOR_UNIT:
677 strcpy(name, "Selector");
679 case UAC1_PROCESSING_UNIT:
680 strcpy(name, "Process Unit");
682 case UAC1_EXTENSION_UNIT:
683 strcpy(name, "Ext Unit");
686 strcpy(name, "Mixer");
689 return sprintf(name, "Unit %d", iterm->id);
693 switch (iterm->type & 0xff00) {
701 strcpy(name, "Headset");
704 strcpy(name, "Phone");
708 for (names = iterm_names; names->type; names++) {
709 if (names->type == iterm->type) {
710 strcpy(name, names->name);
711 return strlen(names->name);
719 * parse the source unit recursively until it reaches to a terminal
720 * or a branched unit.
722 static int __check_input_term(struct mixer_build *state, int id,
723 struct usb_audio_term *term)
729 memset(term, 0, sizeof(*term));
731 /* a loop in the terminal chain? */
732 if (test_and_set_bit(id, state->termbitmap))
735 p1 = find_audio_control_unit(state, id);
742 case UAC_INPUT_TERMINAL:
743 if (state->mixer->protocol == UAC_VERSION_1) {
744 struct uac_input_terminal_descriptor *d = p1;
745 term->type = le16_to_cpu(d->wTerminalType);
746 term->channels = d->bNrChannels;
747 term->chconfig = le16_to_cpu(d->wChannelConfig);
748 term->name = d->iTerminal;
749 } else { /* UAC_VERSION_2 */
750 struct uac2_input_terminal_descriptor *d = p1;
752 /* call recursively to verify that the
753 * referenced clock entity is valid */
754 err = __check_input_term(state, d->bCSourceID, term);
758 /* save input term properties after recursion,
759 * to ensure they are not overriden by the
762 term->type = le16_to_cpu(d->wTerminalType);
763 term->channels = d->bNrChannels;
764 term->chconfig = le32_to_cpu(d->bmChannelConfig);
765 term->name = d->iTerminal;
768 case UAC_FEATURE_UNIT: {
769 /* the header is the same for v1 and v2 */
770 struct uac_feature_unit_descriptor *d = p1;
772 break; /* continue to parse */
774 case UAC_MIXER_UNIT: {
775 struct uac_mixer_unit_descriptor *d = p1;
776 term->type = d->bDescriptorSubtype << 16; /* virtual type */
777 term->channels = uac_mixer_unit_bNrChannels(d);
778 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
779 term->name = uac_mixer_unit_iMixer(d);
782 case UAC_SELECTOR_UNIT:
783 case UAC2_CLOCK_SELECTOR: {
784 struct uac_selector_unit_descriptor *d = p1;
785 /* call recursively to retrieve the channel info */
786 err = __check_input_term(state, d->baSourceID[0], term);
789 term->type = d->bDescriptorSubtype << 16; /* virtual type */
791 term->name = uac_selector_unit_iSelector(d);
794 case UAC1_PROCESSING_UNIT:
795 case UAC1_EXTENSION_UNIT:
796 /* UAC2_PROCESSING_UNIT_V2 */
797 /* UAC2_EFFECT_UNIT */
798 case UAC2_EXTENSION_UNIT_V2: {
799 struct uac_processing_unit_descriptor *d = p1;
801 if (state->mixer->protocol == UAC_VERSION_2 &&
802 hdr[2] == UAC2_EFFECT_UNIT) {
803 /* UAC2/UAC1 unit IDs overlap here in an
804 * uncompatible way. Ignore this unit for now.
810 id = d->baSourceID[0];
811 break; /* continue to parse */
813 term->type = d->bDescriptorSubtype << 16; /* virtual type */
814 term->channels = uac_processing_unit_bNrChannels(d);
815 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
816 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
819 case UAC2_CLOCK_SOURCE: {
820 struct uac_clock_source_descriptor *d = p1;
821 term->type = d->bDescriptorSubtype << 16; /* virtual type */
823 term->name = d->iClockSource;
834 static int check_input_term(struct mixer_build *state, int id,
835 struct usb_audio_term *term)
837 memset(term, 0, sizeof(*term));
838 memset(state->termbitmap, 0, sizeof(state->termbitmap));
839 return __check_input_term(state, id, term);
846 /* feature unit control information */
847 struct usb_feature_control_info {
849 int type; /* data type for uac1 */
850 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
853 static struct usb_feature_control_info audio_feature_info[] = {
854 { "Mute", USB_MIXER_INV_BOOLEAN, -1 },
855 { "Volume", USB_MIXER_S16, -1 },
856 { "Tone Control - Bass", USB_MIXER_S8, -1 },
857 { "Tone Control - Mid", USB_MIXER_S8, -1 },
858 { "Tone Control - Treble", USB_MIXER_S8, -1 },
859 { "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemeted yet */
860 { "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
861 { "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
862 { "Bass Boost", USB_MIXER_BOOLEAN, -1 },
863 { "Loudness", USB_MIXER_BOOLEAN, -1 },
865 { "Input Gain Control", USB_MIXER_S16, -1 },
866 { "Input Gain Pad Control", USB_MIXER_S16, -1 },
867 { "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
870 /* private_free callback */
871 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
873 kfree(kctl->private_data);
874 kctl->private_data = NULL;
878 * interface to ALSA control for feature/mixer units
881 /* volume control quirks */
882 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
883 struct snd_kcontrol *kctl)
885 struct snd_usb_audio *chip = cval->head.mixer->chip;
886 switch (chip->usb_id) {
887 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
888 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
889 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
895 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
896 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
901 if (strstr(kctl->id.name, "Effect Return") != NULL) {
907 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
908 (strstr(kctl->id.name, "Effect Send") != NULL)) {
909 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
915 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
916 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
917 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
919 "set quirk for FTU Effect Duration\n");
925 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
926 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
928 "set quirks for FTU Effect Feedback/Volume\n");
935 case USB_ID(0x0d8c, 0x0103):
936 if (!strcmp(kctl->id.name, "PCM Playback Volume")) {
938 "set volume quirk for CM102-A+/102S+\n");
943 case USB_ID(0x0471, 0x0101):
944 case USB_ID(0x0471, 0x0104):
945 case USB_ID(0x0471, 0x0105):
946 case USB_ID(0x0672, 0x1041):
947 /* quirk for UDA1321/N101.
948 * note that detection between firmware 2.1.1.7 (N101)
949 * and later 2.1.1.21 is not very clear from datasheets.
950 * I hope that the min value is -15360 for newer firmware --jk
952 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
953 cval->min == -15616) {
955 "set volume quirk for UDA1321/N101 chip\n");
960 case USB_ID(0x046d, 0x09a4):
961 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
963 "set volume quirk for QuickCam E3500\n");
970 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
971 case USB_ID(0x046d, 0x0808):
972 case USB_ID(0x046d, 0x0809):
973 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
974 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
975 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
976 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
977 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
978 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
979 case USB_ID(0x046d, 0x0991):
980 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
981 /* Most audio usb devices lie about volume resolution.
982 * Most Logitech webcams have res = 384.
983 * Probably there is some logitech magic behind this number --fishor
985 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
987 "set resolution quirk: cval->res = 384\n");
991 case USB_ID(0x0495, 0x3042): /* ESS Technology Asus USB DAC */
992 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
993 strstr(kctl->id.name, "Capture Volume") != NULL) {
1003 * retrieve the minimum and maximum values for the specified control
1005 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1006 int default_min, struct snd_kcontrol *kctl)
1009 cval->min = default_min;
1010 cval->max = cval->min + 1;
1012 cval->dBmin = cval->dBmax = 0;
1014 if (cval->val_type == USB_MIXER_BOOLEAN ||
1015 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1016 cval->initialized = 1;
1021 for (i = 0; i < MAX_CHANNELS; i++)
1022 if (cval->cmask & (1 << i)) {
1027 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
1028 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1029 usb_audio_err(cval->head.mixer->chip,
1030 "%d:%d: cannot get min/max values for control %d (id %d)\n",
1031 cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
1032 cval->control, cval->head.id);
1035 if (get_ctl_value(cval, UAC_GET_RES,
1036 (cval->control << 8) | minchn,
1040 int last_valid_res = cval->res;
1042 while (cval->res > 1) {
1043 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1044 (cval->control << 8) | minchn,
1049 if (get_ctl_value(cval, UAC_GET_RES,
1050 (cval->control << 8) | minchn, &cval->res) < 0)
1051 cval->res = last_valid_res;
1056 /* Additional checks for the proper resolution
1058 * Some devices report smaller resolutions than actually
1059 * reacting. They don't return errors but simply clip
1060 * to the lower aligned value.
1062 if (cval->min + cval->res < cval->max) {
1063 int last_valid_res = cval->res;
1064 int saved, test, check;
1065 if (get_cur_mix_raw(cval, minchn, &saved) < 0)
1069 if (test < cval->max)
1073 if (test < cval->min || test > cval->max ||
1074 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1075 get_cur_mix_raw(cval, minchn, &check)) {
1076 cval->res = last_valid_res;
1083 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1087 cval->initialized = 1;
1091 volume_control_quirks(cval, kctl);
1093 /* USB descriptions contain the dB scale in 1/256 dB unit
1094 * while ALSA TLV contains in 1/100 dB unit
1096 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1097 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1098 if (cval->dBmin > cval->dBmax) {
1099 /* something is wrong; assume it's either from/to 0dB */
1100 if (cval->dBmin < 0)
1102 else if (cval->dBmin > 0)
1104 if (cval->dBmin > cval->dBmax) {
1105 /* totally crap, return an error */
1113 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1115 /* get a feature/mixer unit info */
1116 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1117 struct snd_ctl_elem_info *uinfo)
1119 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1121 if (cval->val_type == USB_MIXER_BOOLEAN ||
1122 cval->val_type == USB_MIXER_INV_BOOLEAN)
1123 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1125 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1126 uinfo->count = cval->channels;
1127 if (cval->val_type == USB_MIXER_BOOLEAN ||
1128 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1129 uinfo->value.integer.min = 0;
1130 uinfo->value.integer.max = 1;
1132 if (!cval->initialized) {
1133 get_min_max_with_quirks(cval, 0, kcontrol);
1134 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1135 kcontrol->vd[0].access &=
1136 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1137 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1138 snd_ctl_notify(cval->head.mixer->chip->card,
1139 SNDRV_CTL_EVENT_MASK_INFO,
1143 uinfo->value.integer.min = 0;
1144 uinfo->value.integer.max =
1145 (cval->max - cval->min + cval->res - 1) / cval->res;
1150 /* get the current value from feature/mixer unit */
1151 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1152 struct snd_ctl_elem_value *ucontrol)
1154 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1155 int c, cnt, val, err;
1157 ucontrol->value.integer.value[0] = cval->min;
1160 for (c = 0; c < MAX_CHANNELS; c++) {
1161 if (!(cval->cmask & (1 << c)))
1163 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1165 return filter_error(cval, err);
1166 val = get_relative_value(cval, val);
1167 ucontrol->value.integer.value[cnt] = val;
1172 /* master channel */
1173 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1175 return filter_error(cval, err);
1176 val = get_relative_value(cval, val);
1177 ucontrol->value.integer.value[0] = val;
1182 /* put the current value to feature/mixer unit */
1183 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1184 struct snd_ctl_elem_value *ucontrol)
1186 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1187 int c, cnt, val, oval, err;
1192 for (c = 0; c < MAX_CHANNELS; c++) {
1193 if (!(cval->cmask & (1 << c)))
1195 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1197 return filter_error(cval, err);
1198 val = ucontrol->value.integer.value[cnt];
1199 val = get_abs_value(cval, val);
1201 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1207 /* master channel */
1208 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1210 return filter_error(cval, err);
1211 val = ucontrol->value.integer.value[0];
1212 val = get_abs_value(cval, val);
1214 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1221 static struct snd_kcontrol_new usb_feature_unit_ctl = {
1222 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1223 .name = "", /* will be filled later manually */
1224 .info = mixer_ctl_feature_info,
1225 .get = mixer_ctl_feature_get,
1226 .put = mixer_ctl_feature_put,
1229 /* the read-only variant */
1230 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1231 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1232 .name = "", /* will be filled later manually */
1233 .info = mixer_ctl_feature_info,
1234 .get = mixer_ctl_feature_get,
1239 * This symbol is exported in order to allow the mixer quirks to
1240 * hook up to the standard feature unit control mechanism
1242 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1245 * build a feature control
1247 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1249 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1253 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1254 * rename it to "Headphone". We determine if something is a headphone
1255 * similar to how udev determines form factor.
1257 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1258 struct snd_card *card)
1260 const char *names_to_check[] = {
1261 "Headset", "headset", "Headphone", "headphone", NULL};
1265 if (strcmp("Speaker", kctl->id.name))
1268 for (s = names_to_check; *s; s++)
1269 if (strstr(card->shortname, *s)) {
1277 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1280 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1281 unsigned int ctl_mask, int control,
1282 struct usb_audio_term *iterm, int unitid,
1285 struct uac_feature_unit_descriptor *desc = raw_desc;
1286 struct usb_feature_control_info *ctl_info;
1287 unsigned int len = 0;
1288 int mapped_name = 0;
1289 int nameid = uac_feature_unit_iFeature(desc);
1290 struct snd_kcontrol *kctl;
1291 struct usb_mixer_elem_info *cval;
1292 const struct usbmix_name_map *map;
1295 control++; /* change from zero-based to 1-based value */
1297 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1298 /* FIXME: not supported yet */
1302 map = find_map(state, unitid, control);
1303 if (check_ignored_ctl(map))
1306 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1309 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1310 cval->control = control;
1311 cval->cmask = ctl_mask;
1312 ctl_info = &audio_feature_info[control-1];
1313 if (state->mixer->protocol == UAC_VERSION_1)
1314 cval->val_type = ctl_info->type;
1315 else /* UAC_VERSION_2 */
1316 cval->val_type = ctl_info->type_uac2 >= 0 ?
1317 ctl_info->type_uac2 : ctl_info->type;
1319 if (ctl_mask == 0) {
1320 cval->channels = 1; /* master channel */
1321 cval->master_readonly = readonly_mask;
1324 for (i = 0; i < 16; i++)
1325 if (ctl_mask & (1 << i))
1328 cval->ch_readonly = readonly_mask;
1332 * If all channels in the mask are marked read-only, make the control
1333 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1334 * issue write commands to read-only channels.
1336 if (cval->channels == readonly_mask)
1337 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1339 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1342 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1346 kctl->private_free = snd_usb_mixer_elem_free;
1348 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1349 mapped_name = len != 0;
1351 len = snd_usb_copy_string_desc(state, nameid,
1352 kctl->id.name, sizeof(kctl->id.name));
1358 * determine the control name. the rule is:
1359 * - if a name id is given in descriptor, use it.
1360 * - if the connected input can be determined, then use the name
1362 * - if the connected output can be determined, use it.
1363 * - otherwise, anonymous name.
1366 len = get_term_name(state, iterm, kctl->id.name,
1367 sizeof(kctl->id.name), 1);
1369 len = get_term_name(state, &state->oterm,
1371 sizeof(kctl->id.name), 1);
1373 snprintf(kctl->id.name, sizeof(kctl->id.name),
1374 "Feature %d", unitid);
1378 check_no_speaker_on_headset(kctl, state->mixer->chip->card);
1381 * determine the stream direction:
1382 * if the connected output is USB stream, then it's likely a
1383 * capture stream. otherwise it should be playback (hopefully :)
1385 if (!mapped_name && !(state->oterm.type >> 16)) {
1386 if ((state->oterm.type & 0xff00) == 0x0100)
1387 append_ctl_name(kctl, " Capture");
1389 append_ctl_name(kctl, " Playback");
1391 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1392 " Switch" : " Volume");
1396 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1397 sizeof(kctl->id.name));
1401 /* get min/max values */
1402 get_min_max_with_quirks(cval, 0, kctl);
1404 if (control == UAC_FU_VOLUME) {
1405 check_mapped_dB(map, cval);
1406 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1407 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1408 kctl->vd[0].access |=
1409 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1410 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1414 snd_usb_mixer_fu_apply_quirk(state->mixer, cval, unitid, kctl);
1416 range = (cval->max - cval->min) / cval->res;
1418 * Are there devices with volume range more than 255? I use a bit more
1419 * to be sure. 384 is a resolution magic number found on Logitech
1420 * devices. It will definitively catch all buggy Logitech devices.
1423 usb_audio_warn(state->chip,
1424 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1426 usb_audio_warn(state->chip,
1427 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1428 cval->head.id, kctl->id.name, cval->channels,
1429 cval->min, cval->max, cval->res);
1432 usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1433 cval->head.id, kctl->id.name, cval->channels,
1434 cval->min, cval->max, cval->res);
1435 snd_usb_mixer_add_control(&cval->head, kctl);
1438 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1441 struct uac_clock_source_descriptor *hdr = _ftr;
1442 struct usb_mixer_elem_info *cval;
1443 struct snd_kcontrol *kctl;
1444 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1447 if (state->mixer->protocol != UAC_VERSION_2)
1450 if (hdr->bLength != sizeof(*hdr)) {
1451 usb_audio_dbg(state->chip,
1452 "Bogus clock source descriptor length of %d, ignoring.\n",
1458 * The only property of this unit we are interested in is the
1459 * clock source validity. If that isn't readable, just bail out.
1461 if (!uac2_control_is_readable(hdr->bmControls,
1462 ilog2(UAC2_CS_CONTROL_CLOCK_VALID)))
1465 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1469 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1474 cval->val_type = USB_MIXER_BOOLEAN;
1475 cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1477 if (uac2_control_is_writeable(hdr->bmControls,
1478 ilog2(UAC2_CS_CONTROL_CLOCK_VALID)))
1479 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1481 cval->master_readonly = 1;
1482 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1490 kctl->private_free = snd_usb_mixer_elem_free;
1491 ret = snd_usb_copy_string_desc(state, hdr->iClockSource,
1492 name, sizeof(name));
1494 snprintf(kctl->id.name, sizeof(kctl->id.name),
1495 "%s Validity", name);
1497 snprintf(kctl->id.name, sizeof(kctl->id.name),
1498 "Clock Source %d Validity", hdr->bClockID);
1500 return snd_usb_mixer_add_control(&cval->head, kctl);
1504 * parse a feature unit
1506 * most of controls are defined here.
1508 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1512 struct usb_audio_term iterm;
1513 unsigned int master_bits, first_ch_bits;
1515 struct uac_feature_unit_descriptor *hdr = _ftr;
1518 if (state->mixer->protocol == UAC_VERSION_1) {
1519 if (hdr->bLength < 7) {
1520 usb_audio_err(state->chip,
1521 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1525 csize = hdr->bControlSize;
1527 usb_audio_dbg(state->chip,
1528 "unit %u: invalid bControlSize == 0\n",
1532 channels = (hdr->bLength - 7) / csize - 1;
1533 bmaControls = hdr->bmaControls;
1534 if (hdr->bLength < 7 + csize) {
1535 usb_audio_err(state->chip,
1536 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1541 struct uac2_feature_unit_descriptor *ftr = _ftr;
1542 if (hdr->bLength < 6) {
1543 usb_audio_err(state->chip,
1544 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1549 channels = (hdr->bLength - 6) / 4 - 1;
1550 bmaControls = ftr->bmaControls;
1551 if (hdr->bLength < 6 + csize) {
1552 usb_audio_err(state->chip,
1553 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1559 /* parse the source unit */
1560 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1563 /* determine the input source type and name */
1564 err = check_input_term(state, hdr->bSourceID, &iterm);
1568 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1569 /* master configuration quirks */
1570 switch (state->chip->usb_id) {
1571 case USB_ID(0x08bb, 0x2702):
1572 usb_audio_info(state->chip,
1573 "usbmixer: master volume quirk for PCM2702 chip\n");
1574 /* disable non-functional volume control */
1575 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1577 case USB_ID(0x1130, 0xf211):
1578 usb_audio_info(state->chip,
1579 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1580 /* disable non-functional volume control */
1586 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1590 if (state->mixer->protocol == UAC_VERSION_1) {
1591 /* check all control types */
1592 for (i = 0; i < 10; i++) {
1593 unsigned int ch_bits = 0;
1594 for (j = 0; j < channels; j++) {
1597 mask = snd_usb_combine_bytes(bmaControls +
1598 csize * (j+1), csize);
1599 if (mask & (1 << i))
1600 ch_bits |= (1 << j);
1602 /* audio class v1 controls are never read-only */
1605 * The first channel must be set
1606 * (for ease of programming).
1609 build_feature_ctl(state, _ftr, ch_bits, i,
1611 if (master_bits & (1 << i))
1612 build_feature_ctl(state, _ftr, 0, i, &iterm,
1615 } else { /* UAC_VERSION_2 */
1616 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1617 unsigned int ch_bits = 0;
1618 unsigned int ch_read_only = 0;
1620 for (j = 0; j < channels; j++) {
1623 mask = snd_usb_combine_bytes(bmaControls +
1624 csize * (j+1), csize);
1625 if (uac2_control_is_readable(mask, i)) {
1626 ch_bits |= (1 << j);
1627 if (!uac2_control_is_writeable(mask, i))
1628 ch_read_only |= (1 << j);
1633 * NOTE: build_feature_ctl() will mark the control
1634 * read-only if all channels are marked read-only in
1635 * the descriptors. Otherwise, the control will be
1636 * reported as writeable, but the driver will not
1637 * actually issue a write command for read-only
1642 * The first channel must be set
1643 * (for ease of programming).
1646 build_feature_ctl(state, _ftr, ch_bits, i,
1647 &iterm, unitid, ch_read_only);
1648 if (uac2_control_is_readable(master_bits, i))
1649 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1650 !uac2_control_is_writeable(master_bits, i));
1662 * build a mixer unit control
1664 * the callbacks are identical with feature unit.
1665 * input channel number (zero based) is given in control field instead.
1667 static void build_mixer_unit_ctl(struct mixer_build *state,
1668 struct uac_mixer_unit_descriptor *desc,
1669 int in_pin, int in_ch, int unitid,
1670 struct usb_audio_term *iterm)
1672 struct usb_mixer_elem_info *cval;
1673 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1674 unsigned int i, len;
1675 struct snd_kcontrol *kctl;
1676 const struct usbmix_name_map *map;
1678 map = find_map(state, unitid, 0);
1679 if (check_ignored_ctl(map))
1682 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1686 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1687 cval->control = in_ch + 1; /* based on 1 */
1688 cval->val_type = USB_MIXER_S16;
1689 for (i = 0; i < num_outs; i++) {
1690 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
1692 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
1693 cval->cmask |= (1 << i);
1698 /* get min/max values */
1699 get_min_max(cval, 0);
1701 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1703 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1707 kctl->private_free = snd_usb_mixer_elem_free;
1709 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1711 len = get_term_name(state, iterm, kctl->id.name,
1712 sizeof(kctl->id.name), 0);
1714 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1715 append_ctl_name(kctl, " Volume");
1717 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
1718 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
1719 snd_usb_mixer_add_control(&cval->head, kctl);
1723 * parse a mixer unit
1725 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
1728 struct uac_mixer_unit_descriptor *desc = raw_desc;
1729 struct usb_audio_term iterm;
1730 int input_pins, num_ins, num_outs;
1733 if (desc->bLength < 11 || !(input_pins = desc->bNrInPins) ||
1734 desc->bLength < sizeof(*desc) + desc->bNrInPins ||
1735 !(num_outs = uac_mixer_unit_bNrChannels(desc))) {
1736 usb_audio_err(state->chip,
1737 "invalid MIXER UNIT descriptor %d\n",
1744 for (pin = 0; pin < input_pins; pin++) {
1745 err = parse_audio_unit(state, desc->baSourceID[pin]);
1748 /* no bmControls field (e.g. Maya44) -> ignore */
1749 if (desc->bLength <= 10 + input_pins)
1751 err = check_input_term(state, desc->baSourceID[pin], &iterm);
1754 num_ins += iterm.channels;
1755 for (; ich < num_ins; ich++) {
1756 int och, ich_has_controls = 0;
1758 for (och = 0; och < num_outs; och++) {
1759 __u8 *c = uac_mixer_unit_bmControls(desc,
1760 state->mixer->protocol);
1762 if (check_matrix_bitmap(c, ich, och, num_outs)) {
1763 ich_has_controls = 1;
1767 if (ich_has_controls)
1768 build_mixer_unit_ctl(state, desc, pin, ich,
1776 * Processing Unit / Extension Unit
1779 /* get callback for processing/extension unit */
1780 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
1781 struct snd_ctl_elem_value *ucontrol)
1783 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1786 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1788 ucontrol->value.integer.value[0] = cval->min;
1789 return filter_error(cval, err);
1791 val = get_relative_value(cval, val);
1792 ucontrol->value.integer.value[0] = val;
1796 /* put callback for processing/extension unit */
1797 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
1798 struct snd_ctl_elem_value *ucontrol)
1800 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1803 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1805 return filter_error(cval, err);
1806 val = ucontrol->value.integer.value[0];
1807 val = get_abs_value(cval, val);
1809 set_cur_ctl_value(cval, cval->control << 8, val);
1815 /* alsa control interface for processing/extension unit */
1816 static const struct snd_kcontrol_new mixer_procunit_ctl = {
1817 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1818 .name = "", /* will be filled later */
1819 .info = mixer_ctl_feature_info,
1820 .get = mixer_ctl_procunit_get,
1821 .put = mixer_ctl_procunit_put,
1825 * predefined data for processing units
1827 struct procunit_value_info {
1834 struct procunit_info {
1837 struct procunit_value_info *values;
1840 static struct procunit_value_info updown_proc_info[] = {
1841 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1842 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1845 static struct procunit_value_info prologic_proc_info[] = {
1846 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1847 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1850 static struct procunit_value_info threed_enh_proc_info[] = {
1851 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1852 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
1855 static struct procunit_value_info reverb_proc_info[] = {
1856 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1857 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1858 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1859 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
1862 static struct procunit_value_info chorus_proc_info[] = {
1863 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1864 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1865 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1866 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1869 static struct procunit_value_info dcr_proc_info[] = {
1870 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1871 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1872 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1873 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1874 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1875 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
1879 static struct procunit_info procunits[] = {
1880 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1881 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1882 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1883 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1884 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1885 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
1889 * predefined data for extension units
1891 static struct procunit_value_info clock_rate_xu_info[] = {
1892 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1895 static struct procunit_value_info clock_source_xu_info[] = {
1896 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1899 static struct procunit_value_info spdif_format_xu_info[] = {
1900 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1903 static struct procunit_value_info soft_limit_xu_info[] = {
1904 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1907 static struct procunit_info extunits[] = {
1908 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1909 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1910 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1911 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1916 * build a processing/extension unit
1918 static int build_audio_procunit(struct mixer_build *state, int unitid,
1919 void *raw_desc, struct procunit_info *list,
1922 struct uac_processing_unit_descriptor *desc = raw_desc;
1924 struct usb_mixer_elem_info *cval;
1925 struct snd_kcontrol *kctl;
1926 int i, err, nameid, type, len;
1927 struct procunit_info *info;
1928 struct procunit_value_info *valinfo;
1929 const struct usbmix_name_map *map;
1930 static struct procunit_value_info default_value_info[] = {
1931 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1934 static struct procunit_info default_info = {
1935 0, NULL, default_value_info
1938 if (desc->bLength < 13) {
1939 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
1943 num_ins = desc->bNrInPins;
1944 if (desc->bLength < 13 + num_ins ||
1945 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
1946 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
1950 for (i = 0; i < num_ins; i++) {
1951 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1955 type = le16_to_cpu(desc->wProcessType);
1956 for (info = list; info && info->type; info++)
1957 if (info->type == type)
1959 if (!info || !info->type)
1960 info = &default_info;
1962 for (valinfo = info->values; valinfo->control; valinfo++) {
1963 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
1965 if (!(controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
1967 map = find_map(state, unitid, valinfo->control);
1968 if (check_ignored_ctl(map))
1970 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1973 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1974 cval->control = valinfo->control;
1975 cval->val_type = valinfo->val_type;
1978 /* get min/max values */
1979 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
1980 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
1981 /* FIXME: hard-coded */
1983 cval->max = control_spec[0];
1985 cval->initialized = 1;
1987 if (type == USB_XU_CLOCK_RATE) {
1989 * E-Mu USB 0404/0202/TrackerPre/0204
1990 * samplerate control quirk
1995 cval->initialized = 1;
1997 get_min_max(cval, valinfo->min_value);
2000 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2005 kctl->private_free = snd_usb_mixer_elem_free;
2007 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2009 } else if (info->name) {
2010 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2012 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2015 len = snd_usb_copy_string_desc(state, nameid,
2017 sizeof(kctl->id.name));
2019 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
2021 append_ctl_name(kctl, " ");
2022 append_ctl_name(kctl, valinfo->suffix);
2024 usb_audio_dbg(state->chip,
2025 "[%d] PU [%s] ch = %d, val = %d/%d\n",
2026 cval->head.id, kctl->id.name, cval->channels,
2027 cval->min, cval->max);
2029 err = snd_usb_mixer_add_control(&cval->head, kctl);
2036 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2039 return build_audio_procunit(state, unitid, raw_desc,
2040 procunits, "Processing Unit");
2043 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2047 * Note that we parse extension units with processing unit descriptors.
2048 * That's ok as the layout is the same.
2050 return build_audio_procunit(state, unitid, raw_desc,
2051 extunits, "Extension Unit");
2059 * info callback for selector unit
2060 * use an enumerator type for routing
2062 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2063 struct snd_ctl_elem_info *uinfo)
2065 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2066 const char **itemlist = (const char **)kcontrol->private_value;
2068 if (snd_BUG_ON(!itemlist))
2070 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2073 /* get callback for selector unit */
2074 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2075 struct snd_ctl_elem_value *ucontrol)
2077 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2080 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2082 ucontrol->value.enumerated.item[0] = 0;
2083 return filter_error(cval, err);
2085 val = get_relative_value(cval, val);
2086 ucontrol->value.enumerated.item[0] = val;
2090 /* put callback for selector unit */
2091 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2092 struct snd_ctl_elem_value *ucontrol)
2094 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2097 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2099 return filter_error(cval, err);
2100 val = ucontrol->value.enumerated.item[0];
2101 val = get_abs_value(cval, val);
2103 set_cur_ctl_value(cval, cval->control << 8, val);
2109 /* alsa control interface for selector unit */
2110 static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2111 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2112 .name = "", /* will be filled later */
2113 .info = mixer_ctl_selector_info,
2114 .get = mixer_ctl_selector_get,
2115 .put = mixer_ctl_selector_put,
2119 * private free callback.
2120 * free both private_data and private_value
2122 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2126 if (kctl->private_data) {
2127 struct usb_mixer_elem_info *cval = kctl->private_data;
2128 num_ins = cval->max;
2130 kctl->private_data = NULL;
2132 if (kctl->private_value) {
2133 char **itemlist = (char **)kctl->private_value;
2134 for (i = 0; i < num_ins; i++)
2137 kctl->private_value = 0;
2142 * parse a selector unit
2144 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2147 struct uac_selector_unit_descriptor *desc = raw_desc;
2148 unsigned int i, nameid, len;
2150 struct usb_mixer_elem_info *cval;
2151 struct snd_kcontrol *kctl;
2152 const struct usbmix_name_map *map;
2155 if (desc->bLength < 5 || !desc->bNrInPins ||
2156 desc->bLength < 5 + desc->bNrInPins) {
2157 usb_audio_err(state->chip,
2158 "invalid SELECTOR UNIT descriptor %d\n", unitid);
2162 for (i = 0; i < desc->bNrInPins; i++) {
2163 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
2167 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2170 map = find_map(state, unitid, 0);
2171 if (check_ignored_ctl(map))
2174 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2177 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2178 cval->val_type = USB_MIXER_U8;
2181 cval->max = desc->bNrInPins;
2183 cval->initialized = 1;
2185 if (state->mixer->protocol == UAC_VERSION_1)
2187 else /* UAC_VERSION_2 */
2188 cval->control = (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) ?
2189 UAC2_CX_CLOCK_SELECTOR : UAC2_SU_SELECTOR;
2191 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
2196 #define MAX_ITEM_NAME_LEN 64
2197 for (i = 0; i < desc->bNrInPins; i++) {
2198 struct usb_audio_term iterm;
2200 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2208 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2210 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2211 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
2213 sprintf(namelist[i], "Input %u", i);
2216 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2218 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2219 for (i = 0; i < desc->bNrInPins; i++)
2225 kctl->private_value = (unsigned long)namelist;
2226 kctl->private_free = usb_mixer_selector_elem_free;
2228 /* check the static mapping table at first */
2229 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2232 /* if iSelector is given, use it */
2233 nameid = uac_selector_unit_iSelector(desc);
2235 len = snd_usb_copy_string_desc(state, nameid,
2237 sizeof(kctl->id.name));
2238 /* ... or pick up the terminal name at next */
2240 len = get_term_name(state, &state->oterm,
2241 kctl->id.name, sizeof(kctl->id.name), 0);
2242 /* ... or use the fixed string "USB" as the last resort */
2244 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2246 /* and add the proper suffix */
2247 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
2248 append_ctl_name(kctl, " Clock Source");
2249 else if ((state->oterm.type & 0xff00) == 0x0100)
2250 append_ctl_name(kctl, " Capture Source");
2252 append_ctl_name(kctl, " Playback Source");
2255 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2256 cval->head.id, kctl->id.name, desc->bNrInPins);
2257 return snd_usb_mixer_add_control(&cval->head, kctl);
2261 * parse an audio unit recursively
2264 static int parse_audio_unit(struct mixer_build *state, int unitid)
2268 if (test_and_set_bit(unitid, state->unitbitmap))
2269 return 0; /* the unit already visited */
2271 p1 = find_audio_control_unit(state, unitid);
2273 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2278 case UAC_INPUT_TERMINAL:
2280 case UAC_MIXER_UNIT:
2281 return parse_audio_mixer_unit(state, unitid, p1);
2282 case UAC2_CLOCK_SOURCE:
2283 return parse_clock_source_unit(state, unitid, p1);
2284 case UAC_SELECTOR_UNIT:
2285 case UAC2_CLOCK_SELECTOR:
2286 return parse_audio_selector_unit(state, unitid, p1);
2287 case UAC_FEATURE_UNIT:
2288 return parse_audio_feature_unit(state, unitid, p1);
2289 case UAC1_PROCESSING_UNIT:
2290 /* UAC2_EFFECT_UNIT has the same value */
2291 if (state->mixer->protocol == UAC_VERSION_1)
2292 return parse_audio_processing_unit(state, unitid, p1);
2294 return 0; /* FIXME - effect units not implemented yet */
2295 case UAC1_EXTENSION_UNIT:
2296 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2297 if (state->mixer->protocol == UAC_VERSION_1)
2298 return parse_audio_extension_unit(state, unitid, p1);
2299 else /* UAC_VERSION_2 */
2300 return parse_audio_processing_unit(state, unitid, p1);
2301 case UAC2_EXTENSION_UNIT_V2:
2302 return parse_audio_extension_unit(state, unitid, p1);
2304 usb_audio_err(state->chip,
2305 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2310 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2312 /* kill pending URBs */
2313 snd_usb_mixer_disconnect(mixer);
2315 kfree(mixer->id_elems);
2317 kfree(mixer->urb->transfer_buffer);
2318 usb_free_urb(mixer->urb);
2320 usb_free_urb(mixer->rc_urb);
2321 kfree(mixer->rc_setup_packet);
2325 static int snd_usb_mixer_dev_free(struct snd_device *device)
2327 struct usb_mixer_interface *mixer = device->device_data;
2328 snd_usb_mixer_free(mixer);
2333 * create mixer controls
2335 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2337 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
2339 struct mixer_build state;
2341 const struct usbmix_ctl_map *map;
2344 memset(&state, 0, sizeof(state));
2345 state.chip = mixer->chip;
2346 state.mixer = mixer;
2347 state.buffer = mixer->hostif->extra;
2348 state.buflen = mixer->hostif->extralen;
2350 /* check the mapping table */
2351 for (map = usbmix_ctl_maps; map->id; map++) {
2352 if (map->id == state.chip->usb_id) {
2353 state.map = map->map;
2354 state.selector_map = map->selector_map;
2355 mixer->ignore_ctl_error |= map->ignore_ctl_error;
2361 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
2362 mixer->hostif->extralen,
2363 p, UAC_OUTPUT_TERMINAL)) != NULL) {
2364 if (mixer->protocol == UAC_VERSION_1) {
2365 struct uac1_output_terminal_descriptor *desc = p;
2367 if (desc->bLength < sizeof(*desc))
2368 continue; /* invalid descriptor? */
2369 /* mark terminal ID as visited */
2370 set_bit(desc->bTerminalID, state.unitbitmap);
2371 state.oterm.id = desc->bTerminalID;
2372 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2373 state.oterm.name = desc->iTerminal;
2374 err = parse_audio_unit(&state, desc->bSourceID);
2375 if (err < 0 && err != -EINVAL)
2377 } else { /* UAC_VERSION_2 */
2378 struct uac2_output_terminal_descriptor *desc = p;
2380 if (desc->bLength < sizeof(*desc))
2381 continue; /* invalid descriptor? */
2382 /* mark terminal ID as visited */
2383 set_bit(desc->bTerminalID, state.unitbitmap);
2384 state.oterm.id = desc->bTerminalID;
2385 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2386 state.oterm.name = desc->iTerminal;
2387 err = parse_audio_unit(&state, desc->bSourceID);
2388 if (err < 0 && err != -EINVAL)
2392 * For UAC2, use the same approach to also add the
2395 err = parse_audio_unit(&state, desc->bCSourceID);
2396 if (err < 0 && err != -EINVAL)
2404 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
2406 struct usb_mixer_elem_list *list;
2408 for_each_mixer_elem(list, mixer, unitid) {
2409 struct usb_mixer_elem_info *info;
2411 if (!list->is_std_info)
2413 info = mixer_elem_list_to_info(list);
2414 /* invalidate cache, so the value is read from the device */
2416 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2421 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2422 struct usb_mixer_elem_list *list)
2424 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
2425 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2426 "S8", "U8", "S16", "U16"};
2427 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
2428 "channels=%i, type=\"%s\"\n", cval->head.id,
2429 cval->control, cval->cmask, cval->channels,
2430 val_types[cval->val_type]);
2431 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2432 cval->min, cval->max, cval->dBmin, cval->dBmax);
2435 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2436 struct snd_info_buffer *buffer)
2438 struct snd_usb_audio *chip = entry->private_data;
2439 struct usb_mixer_interface *mixer;
2440 struct usb_mixer_elem_list *list;
2443 list_for_each_entry(mixer, &chip->mixer_list, list) {
2445 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2446 chip->usb_id, snd_usb_ctrl_intf(chip),
2447 mixer->ignore_ctl_error);
2448 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2449 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2450 for_each_mixer_elem(list, mixer, unitid) {
2451 snd_iprintf(buffer, " Unit: %i\n", list->id);
2454 " Control: name=\"%s\", index=%i\n",
2455 list->kctl->id.name,
2456 list->kctl->id.index);
2458 list->dump(buffer, list);
2464 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2465 int attribute, int value, int index)
2467 struct usb_mixer_elem_list *list;
2468 __u8 unitid = (index >> 8) & 0xff;
2469 __u8 control = (value >> 8) & 0xff;
2470 __u8 channel = value & 0xff;
2471 unsigned int count = 0;
2473 if (channel >= MAX_CHANNELS) {
2474 usb_audio_dbg(mixer->chip,
2475 "%s(): bogus channel number %d\n",
2480 for_each_mixer_elem(list, mixer, unitid)
2486 for_each_mixer_elem(list, mixer, unitid) {
2487 struct usb_mixer_elem_info *info;
2491 if (!list->is_std_info)
2494 info = mixer_elem_list_to_info(list);
2495 if (count > 1 && info->control != control)
2498 switch (attribute) {
2500 /* invalidate cache, so the value is read from the device */
2502 info->cached &= ~(1 << channel);
2503 else /* master channel */
2506 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2507 &info->head.kctl->id);
2519 usb_audio_dbg(mixer->chip,
2520 "unknown attribute %d in interrupt\n",
2527 static void snd_usb_mixer_interrupt(struct urb *urb)
2529 struct usb_mixer_interface *mixer = urb->context;
2530 int len = urb->actual_length;
2531 int ustatus = urb->status;
2536 if (mixer->protocol == UAC_VERSION_1) {
2537 struct uac1_status_word *status;
2539 for (status = urb->transfer_buffer;
2540 len >= sizeof(*status);
2541 len -= sizeof(*status), status++) {
2542 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
2543 status->bStatusType,
2544 status->bOriginator);
2546 /* ignore any notifications not from the control interface */
2547 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2548 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2551 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2552 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2554 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2556 } else { /* UAC_VERSION_2 */
2557 struct uac2_interrupt_data_msg *msg;
2559 for (msg = urb->transfer_buffer;
2560 len >= sizeof(*msg);
2561 len -= sizeof(*msg), msg++) {
2562 /* drop vendor specific and endpoint requests */
2563 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2564 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2567 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2568 le16_to_cpu(msg->wValue),
2569 le16_to_cpu(msg->wIndex));
2574 if (ustatus != -ENOENT &&
2575 ustatus != -ECONNRESET &&
2576 ustatus != -ESHUTDOWN) {
2577 urb->dev = mixer->chip->dev;
2578 usb_submit_urb(urb, GFP_ATOMIC);
2582 /* create the handler for the optional status interrupt endpoint */
2583 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2585 struct usb_endpoint_descriptor *ep;
2586 void *transfer_buffer;
2590 /* we need one interrupt input endpoint */
2591 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
2593 ep = get_endpoint(mixer->hostif, 0);
2594 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2597 epnum = usb_endpoint_num(ep);
2598 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2599 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2600 if (!transfer_buffer)
2602 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2604 kfree(transfer_buffer);
2607 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2608 usb_rcvintpipe(mixer->chip->dev, epnum),
2609 transfer_buffer, buffer_length,
2610 snd_usb_mixer_interrupt, mixer, ep->bInterval);
2611 usb_submit_urb(mixer->urb, GFP_KERNEL);
2615 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2618 static struct snd_device_ops dev_ops = {
2619 .dev_free = snd_usb_mixer_dev_free
2621 struct usb_mixer_interface *mixer;
2622 struct snd_info_entry *entry;
2625 strcpy(chip->card->mixername, "USB Mixer");
2627 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2631 mixer->ignore_ctl_error = ignore_error;
2632 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2634 if (!mixer->id_elems) {
2639 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2640 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
2643 mixer->protocol = UAC_VERSION_1;
2646 mixer->protocol = UAC_VERSION_2;
2650 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2651 (err = snd_usb_mixer_status_create(mixer)) < 0)
2654 err = snd_usb_mixer_apply_create_quirk(mixer);
2658 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
2662 if (list_empty(&chip->mixer_list) &&
2663 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2664 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2666 list_add(&mixer->list, &chip->mixer_list);
2670 snd_usb_mixer_free(mixer);
2674 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
2676 if (mixer->disconnected)
2679 usb_kill_urb(mixer->urb);
2681 usb_kill_urb(mixer->rc_urb);
2682 mixer->disconnected = true;
2686 /* stop any bus activity of a mixer */
2687 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2689 usb_kill_urb(mixer->urb);
2690 usb_kill_urb(mixer->rc_urb);
2693 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2698 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2706 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
2708 snd_usb_mixer_inactivate(mixer);
2712 static int restore_mixer_value(struct usb_mixer_elem_list *list)
2714 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
2719 for (c = 0; c < MAX_CHANNELS; c++) {
2720 if (!(cval->cmask & (1 << c)))
2722 if (cval->cached & (1 << (c + 1))) {
2723 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
2724 cval->cache_val[idx]);
2733 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
2742 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
2744 struct usb_mixer_elem_list *list;
2748 /* restore cached mixer values */
2749 for (id = 0; id < MAX_ID_ELEMS; id++) {
2750 for_each_mixer_elem(list, mixer, id) {
2752 err = list->resume(list);
2760 return snd_usb_mixer_activate(mixer);
2764 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
2765 struct usb_mixer_interface *mixer,
2768 list->mixer = mixer;
2770 list->dump = snd_usb_mixer_dump_cval;
2772 list->resume = restore_mixer_value;