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>
54 #include <linux/usb/audio-v3.h>
56 #include <sound/core.h>
57 #include <sound/control.h>
58 #include <sound/hwdep.h>
59 #include <sound/info.h>
60 #include <sound/tlv.h>
65 #include "mixer_quirks.h"
68 #define MAX_ID_ELEMS 256
70 struct usb_audio_term {
74 unsigned int chconfig;
78 struct usbmix_name_map;
81 struct snd_usb_audio *chip;
82 struct usb_mixer_interface *mixer;
83 unsigned char *buffer;
85 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
86 DECLARE_BITMAP(termbitmap, MAX_ID_ELEMS);
87 struct usb_audio_term oterm;
88 const struct usbmix_name_map *map;
89 const struct usbmix_selector_map *selector_map;
92 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
94 USB_XU_CLOCK_RATE = 0xe301,
95 USB_XU_CLOCK_SOURCE = 0xe302,
96 USB_XU_DIGITAL_IO_STATUS = 0xe303,
97 USB_XU_DEVICE_OPTIONS = 0xe304,
98 USB_XU_DIRECT_MONITORING = 0xe305,
99 USB_XU_METERING = 0xe306
102 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/
103 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */
104 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */
105 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */
109 * manual mapping of mixer names
110 * if the mixer topology is too complicated and the parsed names are
111 * ambiguous, add the entries in usbmixer_maps.c.
113 #include "mixer_maps.c"
115 static const struct usbmix_name_map *
116 find_map(const struct usbmix_name_map *p, int unitid, int control)
122 if (p->id == unitid &&
123 (!control || !p->control || control == p->control))
129 /* get the mapped name if the unit matches */
131 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
137 return strlcpy(buf, p->name, buflen);
140 /* ignore the error value if ignore_ctl_error flag is set */
141 #define filter_error(cval, err) \
142 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
144 /* check whether the control should be ignored */
146 check_ignored_ctl(const struct usbmix_name_map *p)
148 if (!p || p->name || p->dB)
154 static inline void check_mapped_dB(const struct usbmix_name_map *p,
155 struct usb_mixer_elem_info *cval)
158 cval->dBmin = p->dB->min;
159 cval->dBmax = p->dB->max;
160 cval->initialized = 1;
164 /* get the mapped selector source name */
165 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
166 int index, char *buf, int buflen)
168 const struct usbmix_selector_map *p;
170 if (!state->selector_map)
172 for (p = state->selector_map; p->id; p++) {
173 if (p->id == unitid && index < p->count)
174 return strlcpy(buf, p->names[index], buflen);
180 * find an audio control unit with the given unit id
182 static void *find_audio_control_unit(struct mixer_build *state,
185 /* we just parse the header */
186 struct uac_feature_unit_descriptor *hdr = NULL;
188 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
189 USB_DT_CS_INTERFACE)) != NULL) {
190 if (hdr->bLength >= 4 &&
191 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
192 hdr->bDescriptorSubtype <= UAC3_SAMPLE_RATE_CONVERTER &&
193 hdr->bUnitID == unit)
201 * copy a string with the given id
203 static int snd_usb_copy_string_desc(struct snd_usb_audio *chip,
204 int index, char *buf, int maxlen)
206 int len = usb_string(chip->dev, index, buf, maxlen - 1);
216 * convert from the byte/word on usb descriptor to the zero-based integer
218 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
220 switch (cval->val_type) {
221 case USB_MIXER_BOOLEAN:
223 case USB_MIXER_INV_BOOLEAN:
246 * convert from the zero-based int to the byte/word for usb descriptor
248 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
250 switch (cval->val_type) {
251 case USB_MIXER_BOOLEAN:
253 case USB_MIXER_INV_BOOLEAN:
262 return 0; /* not reached */
265 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
271 else if (val >= cval->max)
272 return (cval->max - cval->min + cval->res - 1) / cval->res;
274 return (val - cval->min) / cval->res;
277 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
290 static int uac2_ctl_value_size(int val_type)
302 return 0; /* unreachable */
307 * retrieve a mixer value
310 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
311 int validx, int *value_ret)
313 struct snd_usb_audio *chip = cval->head.mixer->chip;
314 unsigned char buf[2];
315 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
319 err = snd_usb_lock_shutdown(chip);
323 while (timeout-- > 0) {
324 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
325 err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
326 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
327 validx, idx, buf, val_len);
328 if (err >= val_len) {
329 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
332 } else if (err == -ETIMEDOUT) {
337 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
338 request, validx, idx, cval->val_type);
342 snd_usb_unlock_shutdown(chip);
346 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
347 int validx, int *value_ret)
349 struct snd_usb_audio *chip = cval->head.mixer->chip;
350 /* enough space for one range */
351 unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
353 int idx = 0, ret, val_size, size;
356 val_size = uac2_ctl_value_size(cval->val_type);
358 if (request == UAC_GET_CUR) {
359 bRequest = UAC2_CS_CUR;
362 bRequest = UAC2_CS_RANGE;
363 size = sizeof(__u16) + 3 * val_size;
366 memset(buf, 0, sizeof(buf));
368 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
372 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
373 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
374 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
375 validx, idx, buf, size);
376 snd_usb_unlock_shutdown(chip);
381 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
382 request, validx, idx, cval->val_type);
386 /* FIXME: how should we handle multiple triplets here? */
393 val = buf + sizeof(__u16);
396 val = buf + sizeof(__u16) + val_size;
399 val = buf + sizeof(__u16) + val_size * 2;
405 *value_ret = convert_signed_value(cval,
406 snd_usb_combine_bytes(val, val_size));
411 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
412 int validx, int *value_ret)
414 validx += cval->idx_off;
416 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
417 get_ctl_value_v1(cval, request, validx, value_ret) :
418 get_ctl_value_v2(cval, request, validx, value_ret);
421 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
422 int validx, int *value)
424 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
427 /* channel = 0: master, 1 = first channel */
428 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
429 int channel, int *value)
431 return get_ctl_value(cval, UAC_GET_CUR,
432 (cval->control << 8) | channel,
436 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
437 int channel, int index, int *value)
441 if (cval->cached & (1 << channel)) {
442 *value = cval->cache_val[index];
445 err = get_cur_mix_raw(cval, channel, value);
447 if (!cval->head.mixer->ignore_ctl_error)
448 usb_audio_dbg(cval->head.mixer->chip,
449 "cannot get current value for control %d ch %d: err = %d\n",
450 cval->control, channel, err);
453 cval->cached |= 1 << channel;
454 cval->cache_val[index] = *value;
462 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
463 int request, int validx, int value_set)
465 struct snd_usb_audio *chip = cval->head.mixer->chip;
466 unsigned char buf[4];
467 int idx = 0, val_len, err, timeout = 10;
469 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/3 */
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 err = snd_ctl_add(mixer->chip->card, kctl);
605 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
610 list->is_std_info = is_std_info;
611 list->next_id_elem = mixer->id_elems[list->id];
612 mixer->id_elems[list->id] = list;
617 * get a terminal name string
620 static struct iterm_name_combo {
624 { 0x0300, "Output" },
625 { 0x0301, "Speaker" },
626 { 0x0302, "Headphone" },
627 { 0x0303, "HMD Audio" },
628 { 0x0304, "Desktop Speaker" },
629 { 0x0305, "Room Speaker" },
630 { 0x0306, "Com Speaker" },
632 { 0x0600, "External In" },
633 { 0x0601, "Analog In" },
634 { 0x0602, "Digital In" },
636 { 0x0604, "Legacy In" },
637 { 0x0605, "IEC958 In" },
638 { 0x0606, "1394 DA Stream" },
639 { 0x0607, "1394 DV Stream" },
640 { 0x0700, "Embedded" },
641 { 0x0701, "Noise Source" },
642 { 0x0702, "Equalization Noise" },
646 { 0x0706, "MiniDisk" },
647 { 0x0707, "Analog Tape" },
648 { 0x0708, "Phonograph" },
649 { 0x0709, "VCR Audio" },
650 { 0x070a, "Video Disk Audio" },
651 { 0x070b, "DVD Audio" },
652 { 0x070c, "TV Tuner Audio" },
653 { 0x070d, "Satellite Rec Audio" },
654 { 0x070e, "Cable Tuner Audio" },
655 { 0x070f, "DSS Audio" },
656 { 0x0710, "Radio Receiver" },
657 { 0x0711, "Radio Transmitter" },
658 { 0x0712, "Multi-Track Recorder" },
659 { 0x0713, "Synthesizer" },
663 static int get_term_name(struct snd_usb_audio *chip, struct usb_audio_term *iterm,
664 unsigned char *name, int maxlen, int term_only)
666 struct iterm_name_combo *names;
670 len = snd_usb_copy_string_desc(chip, iterm->name,
676 /* virtual type - not a real terminal */
677 if (iterm->type >> 16) {
680 switch (iterm->type >> 16) {
681 case UAC3_SELECTOR_UNIT:
682 strcpy(name, "Selector");
684 case UAC3_PROCESSING_UNIT:
685 strcpy(name, "Process Unit");
687 case UAC3_EXTENSION_UNIT:
688 strcpy(name, "Ext Unit");
690 case UAC3_MIXER_UNIT:
691 strcpy(name, "Mixer");
694 return sprintf(name, "Unit %d", iterm->id);
698 switch (iterm->type & 0xff00) {
706 strcpy(name, "Headset");
709 strcpy(name, "Phone");
713 for (names = iterm_names; names->type; names++) {
714 if (names->type == iterm->type) {
715 strcpy(name, names->name);
716 return strlen(names->name);
724 * Get logical cluster information for UAC3 devices.
726 static int get_cluster_channels_v3(struct mixer_build *state, unsigned int cluster_id)
728 struct uac3_cluster_header_descriptor c_header;
731 err = snd_usb_ctl_msg(state->chip->dev,
732 usb_rcvctrlpipe(state->chip->dev, 0),
733 UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
734 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
736 snd_usb_ctrl_intf(state->chip),
737 &c_header, sizeof(c_header));
740 if (err != sizeof(c_header)) {
745 return c_header.bNrChannels;
748 usb_audio_err(state->chip, "cannot request logical cluster ID: %d (err: %d)\n", cluster_id, err);
753 * Get number of channels for a Mixer Unit.
755 static int uac_mixer_unit_get_channels(struct mixer_build *state,
756 struct uac_mixer_unit_descriptor *desc)
760 switch (state->mixer->protocol) {
764 if (desc->bLength < sizeof(*desc) + desc->bNrInPins + 1)
765 return 0; /* no bmControls -> skip */
766 mu_channels = uac_mixer_unit_bNrChannels(desc);
769 mu_channels = get_cluster_channels_v3(state,
770 uac3_mixer_unit_wClusterDescrID(desc));
778 * Parse Input Terminal Unit
780 static int __check_input_term(struct mixer_build *state, int id,
781 struct usb_audio_term *term);
783 static int parse_term_uac1_iterm_unit(struct mixer_build *state,
784 struct usb_audio_term *term,
787 struct uac_input_terminal_descriptor *d = p1;
789 term->type = le16_to_cpu(d->wTerminalType);
790 term->channels = d->bNrChannels;
791 term->chconfig = le16_to_cpu(d->wChannelConfig);
792 term->name = d->iTerminal;
796 static int parse_term_uac2_iterm_unit(struct mixer_build *state,
797 struct usb_audio_term *term,
800 struct uac2_input_terminal_descriptor *d = p1;
803 /* call recursively to verify the referenced clock entity */
804 err = __check_input_term(state, d->bCSourceID, term);
808 /* save input term properties after recursion,
809 * to ensure they are not overriden by the recursion calls
812 term->type = le16_to_cpu(d->wTerminalType);
813 term->channels = d->bNrChannels;
814 term->chconfig = le32_to_cpu(d->bmChannelConfig);
815 term->name = d->iTerminal;
819 static int parse_term_uac3_iterm_unit(struct mixer_build *state,
820 struct usb_audio_term *term,
823 struct uac3_input_terminal_descriptor *d = p1;
826 /* call recursively to verify the referenced clock entity */
827 err = __check_input_term(state, d->bCSourceID, term);
831 /* save input term properties after recursion,
832 * to ensure they are not overriden by the recursion calls
835 term->type = le16_to_cpu(d->wTerminalType);
837 err = get_cluster_channels_v3(state, le16_to_cpu(d->wClusterDescrID));
840 term->channels = err;
842 /* REVISIT: UAC3 IT doesn't have channels cfg */
845 term->name = le16_to_cpu(d->wTerminalDescrStr);
849 static int parse_term_mixer_unit(struct mixer_build *state,
850 struct usb_audio_term *term,
853 struct uac_mixer_unit_descriptor *d = p1;
854 int protocol = state->mixer->protocol;
857 err = uac_mixer_unit_get_channels(state, d);
861 term->type = UAC3_MIXER_UNIT << 16; /* virtual type */
862 term->channels = err;
863 if (protocol != UAC_VERSION_3) {
864 term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
865 term->name = uac_mixer_unit_iMixer(d);
870 static int parse_term_selector_unit(struct mixer_build *state,
871 struct usb_audio_term *term,
874 struct uac_selector_unit_descriptor *d = p1;
877 /* call recursively to retrieve the channel info */
878 err = __check_input_term(state, d->baSourceID[0], term);
881 term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */
883 if (state->mixer->protocol != UAC_VERSION_3)
884 term->name = uac_selector_unit_iSelector(d);
888 static int parse_term_proc_unit(struct mixer_build *state,
889 struct usb_audio_term *term,
890 void *p1, int id, int vtype)
892 struct uac_processing_unit_descriptor *d = p1;
893 int protocol = state->mixer->protocol;
897 /* call recursively to retrieve the channel info */
898 err = __check_input_term(state, d->baSourceID[0], term);
903 term->type = vtype << 16; /* virtual type */
906 if (protocol == UAC_VERSION_3)
909 if (!term->channels) {
910 term->channels = uac_processing_unit_bNrChannels(d);
911 term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
913 term->name = uac_processing_unit_iProcessing(d, protocol);
917 static int parse_term_effect_unit(struct mixer_build *state,
918 struct usb_audio_term *term,
921 term->type = UAC3_EFFECT_UNIT << 16; /* virtual type */
926 static int parse_term_uac2_clock_source(struct mixer_build *state,
927 struct usb_audio_term *term,
930 struct uac_clock_source_descriptor *d = p1;
932 term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
934 term->name = d->iClockSource;
938 static int parse_term_uac3_clock_source(struct mixer_build *state,
939 struct usb_audio_term *term,
942 struct uac3_clock_source_descriptor *d = p1;
944 term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
946 term->name = le16_to_cpu(d->wClockSourceStr);
950 #define PTYPE(a, b) ((a) << 8 | (b))
953 * parse the source unit recursively until it reaches to a terminal
954 * or a branched unit.
956 static int __check_input_term(struct mixer_build *state, int id,
957 struct usb_audio_term *term)
959 int protocol = state->mixer->protocol;
964 /* a loop in the terminal chain? */
965 if (test_and_set_bit(id, state->termbitmap))
968 p1 = find_audio_control_unit(state, id);
971 if (!snd_usb_validate_audio_desc(p1, protocol))
972 break; /* bad descriptor */
977 switch (PTYPE(protocol, hdr[2])) {
978 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
979 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
980 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT): {
981 /* the header is the same for all versions */
982 struct uac_feature_unit_descriptor *d = p1;
985 break; /* continue to parse */
987 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
988 return parse_term_uac1_iterm_unit(state, term, p1, id);
989 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
990 return parse_term_uac2_iterm_unit(state, term, p1, id);
991 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
992 return parse_term_uac3_iterm_unit(state, term, p1, id);
993 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
994 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
995 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
996 return parse_term_mixer_unit(state, term, p1, id);
997 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
998 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
999 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
1000 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
1001 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
1002 return parse_term_selector_unit(state, term, p1, id);
1003 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
1004 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
1005 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
1006 return parse_term_proc_unit(state, term, p1, id,
1007 UAC3_PROCESSING_UNIT);
1008 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
1009 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
1010 return parse_term_effect_unit(state, term, p1, id);
1011 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
1012 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
1013 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
1014 return parse_term_proc_unit(state, term, p1, id,
1015 UAC3_EXTENSION_UNIT);
1016 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
1017 return parse_term_uac2_clock_source(state, term, p1, id);
1018 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
1019 return parse_term_uac3_clock_source(state, term, p1, id);
1028 static int check_input_term(struct mixer_build *state, int id,
1029 struct usb_audio_term *term)
1031 memset(term, 0, sizeof(*term));
1032 memset(state->termbitmap, 0, sizeof(state->termbitmap));
1033 return __check_input_term(state, id, term);
1040 /* feature unit control information */
1041 struct usb_feature_control_info {
1044 int type; /* data type for uac1 */
1045 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
1048 static const struct usb_feature_control_info audio_feature_info[] = {
1049 { UAC_FU_MUTE, "Mute", USB_MIXER_INV_BOOLEAN, -1 },
1050 { UAC_FU_VOLUME, "Volume", USB_MIXER_S16, -1 },
1051 { UAC_FU_BASS, "Tone Control - Bass", USB_MIXER_S8, -1 },
1052 { UAC_FU_MID, "Tone Control - Mid", USB_MIXER_S8, -1 },
1053 { UAC_FU_TREBLE, "Tone Control - Treble", USB_MIXER_S8, -1 },
1054 { UAC_FU_GRAPHIC_EQUALIZER, "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemented yet */
1055 { UAC_FU_AUTOMATIC_GAIN, "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
1056 { UAC_FU_DELAY, "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
1057 { UAC_FU_BASS_BOOST, "Bass Boost", USB_MIXER_BOOLEAN, -1 },
1058 { UAC_FU_LOUDNESS, "Loudness", USB_MIXER_BOOLEAN, -1 },
1060 { UAC2_FU_INPUT_GAIN, "Input Gain Control", USB_MIXER_S16, -1 },
1061 { UAC2_FU_INPUT_GAIN_PAD, "Input Gain Pad Control", USB_MIXER_S16, -1 },
1062 { UAC2_FU_PHASE_INVERTER, "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
1065 static void usb_mixer_elem_info_free(struct usb_mixer_elem_info *cval)
1070 /* private_free callback */
1071 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
1073 usb_mixer_elem_info_free(kctl->private_data);
1074 kctl->private_data = NULL;
1078 * interface to ALSA control for feature/mixer units
1081 /* volume control quirks */
1082 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
1083 struct snd_kcontrol *kctl)
1085 struct snd_usb_audio *chip = cval->head.mixer->chip;
1086 switch (chip->usb_id) {
1087 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
1088 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
1089 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1095 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1096 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1101 if (strstr(kctl->id.name, "Effect Return") != NULL) {
1107 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1108 (strstr(kctl->id.name, "Effect Send") != NULL)) {
1109 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
1115 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
1116 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
1117 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1118 usb_audio_info(chip,
1119 "set quirk for FTU Effect Duration\n");
1125 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1126 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1127 usb_audio_info(chip,
1128 "set quirks for FTU Effect Feedback/Volume\n");
1135 case USB_ID(0x0d8c, 0x0103):
1136 if (!strcmp(kctl->id.name, "PCM Playback Volume")) {
1137 usb_audio_info(chip,
1138 "set volume quirk for CM102-A+/102S+\n");
1143 case USB_ID(0x0471, 0x0101):
1144 case USB_ID(0x0471, 0x0104):
1145 case USB_ID(0x0471, 0x0105):
1146 case USB_ID(0x0672, 0x1041):
1147 /* quirk for UDA1321/N101.
1148 * note that detection between firmware 2.1.1.7 (N101)
1149 * and later 2.1.1.21 is not very clear from datasheets.
1150 * I hope that the min value is -15360 for newer firmware --jk
1152 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
1153 cval->min == -15616) {
1154 usb_audio_info(chip,
1155 "set volume quirk for UDA1321/N101 chip\n");
1160 case USB_ID(0x046d, 0x09a4):
1161 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1162 usb_audio_info(chip,
1163 "set volume quirk for QuickCam E3500\n");
1170 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
1171 case USB_ID(0x046d, 0x0808):
1172 case USB_ID(0x046d, 0x0809):
1173 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1174 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1175 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1176 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1177 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1178 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1179 case USB_ID(0x046d, 0x0991):
1180 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1181 /* Most audio usb devices lie about volume resolution.
1182 * Most Logitech webcams have res = 384.
1183 * Probably there is some logitech magic behind this number --fishor
1185 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1186 usb_audio_info(chip,
1187 "set resolution quirk: cval->res = 384\n");
1191 case USB_ID(0x0495, 0x3042): /* ESS Technology Asus USB DAC */
1192 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1193 strstr(kctl->id.name, "Capture Volume") != NULL) {
1203 * retrieve the minimum and maximum values for the specified control
1205 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1206 int default_min, struct snd_kcontrol *kctl)
1209 cval->min = default_min;
1210 cval->max = cval->min + 1;
1212 cval->dBmin = cval->dBmax = 0;
1214 if (cval->val_type == USB_MIXER_BOOLEAN ||
1215 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1216 cval->initialized = 1;
1221 for (i = 0; i < MAX_CHANNELS; i++)
1222 if (cval->cmask & (1 << i)) {
1227 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
1228 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1229 usb_audio_err(cval->head.mixer->chip,
1230 "%d:%d: cannot get min/max values for control %d (id %d)\n",
1231 cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
1232 cval->control, cval->head.id);
1235 if (get_ctl_value(cval, UAC_GET_RES,
1236 (cval->control << 8) | minchn,
1240 int last_valid_res = cval->res;
1242 while (cval->res > 1) {
1243 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1244 (cval->control << 8) | minchn,
1249 if (get_ctl_value(cval, UAC_GET_RES,
1250 (cval->control << 8) | minchn, &cval->res) < 0)
1251 cval->res = last_valid_res;
1256 /* Additional checks for the proper resolution
1258 * Some devices report smaller resolutions than actually
1259 * reacting. They don't return errors but simply clip
1260 * to the lower aligned value.
1262 if (cval->min + cval->res < cval->max) {
1263 int last_valid_res = cval->res;
1264 int saved, test, check;
1265 if (get_cur_mix_raw(cval, minchn, &saved) < 0)
1269 if (test < cval->max)
1273 if (test < cval->min || test > cval->max ||
1274 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1275 get_cur_mix_raw(cval, minchn, &check)) {
1276 cval->res = last_valid_res;
1283 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1287 cval->initialized = 1;
1291 volume_control_quirks(cval, kctl);
1293 /* USB descriptions contain the dB scale in 1/256 dB unit
1294 * while ALSA TLV contains in 1/100 dB unit
1296 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1297 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1298 if (cval->dBmin > cval->dBmax) {
1299 /* something is wrong; assume it's either from/to 0dB */
1300 if (cval->dBmin < 0)
1302 else if (cval->dBmin > 0)
1304 if (cval->dBmin > cval->dBmax) {
1305 /* totally crap, return an error */
1313 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1315 /* get a feature/mixer unit info */
1316 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1317 struct snd_ctl_elem_info *uinfo)
1319 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1321 if (cval->val_type == USB_MIXER_BOOLEAN ||
1322 cval->val_type == USB_MIXER_INV_BOOLEAN)
1323 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1325 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1326 uinfo->count = cval->channels;
1327 if (cval->val_type == USB_MIXER_BOOLEAN ||
1328 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1329 uinfo->value.integer.min = 0;
1330 uinfo->value.integer.max = 1;
1332 if (!cval->initialized) {
1333 get_min_max_with_quirks(cval, 0, kcontrol);
1334 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1335 kcontrol->vd[0].access &=
1336 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1337 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1338 snd_ctl_notify(cval->head.mixer->chip->card,
1339 SNDRV_CTL_EVENT_MASK_INFO,
1343 uinfo->value.integer.min = 0;
1344 uinfo->value.integer.max =
1345 (cval->max - cval->min + cval->res - 1) / cval->res;
1350 /* get the current value from feature/mixer unit */
1351 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1352 struct snd_ctl_elem_value *ucontrol)
1354 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1355 int c, cnt, val, err;
1357 ucontrol->value.integer.value[0] = cval->min;
1360 for (c = 0; c < MAX_CHANNELS; c++) {
1361 if (!(cval->cmask & (1 << c)))
1363 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1365 return filter_error(cval, err);
1366 val = get_relative_value(cval, val);
1367 ucontrol->value.integer.value[cnt] = val;
1372 /* master channel */
1373 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1375 return filter_error(cval, err);
1376 val = get_relative_value(cval, val);
1377 ucontrol->value.integer.value[0] = val;
1382 /* put the current value to feature/mixer unit */
1383 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1384 struct snd_ctl_elem_value *ucontrol)
1386 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1387 int c, cnt, val, oval, err;
1392 for (c = 0; c < MAX_CHANNELS; c++) {
1393 if (!(cval->cmask & (1 << c)))
1395 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1397 return filter_error(cval, err);
1398 val = ucontrol->value.integer.value[cnt];
1399 val = get_abs_value(cval, val);
1401 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1407 /* master channel */
1408 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1410 return filter_error(cval, err);
1411 val = ucontrol->value.integer.value[0];
1412 val = get_abs_value(cval, val);
1414 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1421 /* get the boolean value from the master channel of a UAC control */
1422 static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
1423 struct snd_ctl_elem_value *ucontrol)
1425 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1428 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1430 return filter_error(cval, err);
1432 ucontrol->value.integer.value[0] = val;
1436 /* get the connectors status and report it as boolean type */
1437 static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol,
1438 struct snd_ctl_elem_value *ucontrol)
1440 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1441 struct snd_usb_audio *chip = cval->head.mixer->chip;
1442 int idx = 0, validx, ret, val;
1444 validx = cval->control << 8 | 0;
1446 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
1450 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
1451 if (cval->head.mixer->protocol == UAC_VERSION_2) {
1452 struct uac2_connectors_ctl_blk uac2_conn;
1454 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1455 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1456 validx, idx, &uac2_conn, sizeof(uac2_conn));
1457 val = !!uac2_conn.bNrChannels;
1458 } else { /* UAC_VERSION_3 */
1459 struct uac3_insertion_ctl_blk uac3_conn;
1461 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1462 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1463 validx, idx, &uac3_conn, sizeof(uac3_conn));
1464 val = !!uac3_conn.bmConInserted;
1467 snd_usb_unlock_shutdown(chip);
1472 "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1473 UAC_GET_CUR, validx, idx, cval->val_type);
1474 return filter_error(cval, ret);
1477 ucontrol->value.integer.value[0] = val;
1481 static struct snd_kcontrol_new usb_feature_unit_ctl = {
1482 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1483 .name = "", /* will be filled later manually */
1484 .info = mixer_ctl_feature_info,
1485 .get = mixer_ctl_feature_get,
1486 .put = mixer_ctl_feature_put,
1489 /* the read-only variant */
1490 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1491 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1492 .name = "", /* will be filled later manually */
1493 .info = mixer_ctl_feature_info,
1494 .get = mixer_ctl_feature_get,
1499 * A control which shows the boolean value from reading a UAC control on
1500 * the master channel.
1502 static struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1503 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1504 .name = "", /* will be filled later manually */
1505 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1506 .info = snd_ctl_boolean_mono_info,
1507 .get = mixer_ctl_master_bool_get,
1511 static const struct snd_kcontrol_new usb_connector_ctl_ro = {
1512 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1513 .name = "", /* will be filled later manually */
1514 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1515 .info = snd_ctl_boolean_mono_info,
1516 .get = mixer_ctl_connector_get,
1521 * This symbol is exported in order to allow the mixer quirks to
1522 * hook up to the standard feature unit control mechanism
1524 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1527 * build a feature control
1529 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1531 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1535 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1536 * rename it to "Headphone". We determine if something is a headphone
1537 * similar to how udev determines form factor.
1539 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1540 struct snd_card *card)
1542 const char *names_to_check[] = {
1543 "Headset", "headset", "Headphone", "headphone", NULL};
1547 if (strcmp("Speaker", kctl->id.name))
1550 for (s = names_to_check; *s; s++)
1551 if (strstr(card->shortname, *s)) {
1559 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1562 static const struct usb_feature_control_info *get_feature_control_info(int control)
1566 for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1567 if (audio_feature_info[i].control == control)
1568 return &audio_feature_info[i];
1573 static void __build_feature_ctl(struct usb_mixer_interface *mixer,
1574 const struct usbmix_name_map *imap,
1575 unsigned int ctl_mask, int control,
1576 struct usb_audio_term *iterm,
1577 struct usb_audio_term *oterm,
1578 int unitid, int nameid, int readonly_mask)
1580 const struct usb_feature_control_info *ctl_info;
1581 unsigned int len = 0;
1582 int mapped_name = 0;
1583 struct snd_kcontrol *kctl;
1584 struct usb_mixer_elem_info *cval;
1585 const struct usbmix_name_map *map;
1588 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1589 /* FIXME: not supported yet */
1593 map = find_map(imap, unitid, control);
1594 if (check_ignored_ctl(map))
1597 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1600 snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
1601 cval->control = control;
1602 cval->cmask = ctl_mask;
1604 ctl_info = get_feature_control_info(control);
1606 usb_mixer_elem_info_free(cval);
1609 if (mixer->protocol == UAC_VERSION_1)
1610 cval->val_type = ctl_info->type;
1611 else /* UAC_VERSION_2 */
1612 cval->val_type = ctl_info->type_uac2 >= 0 ?
1613 ctl_info->type_uac2 : ctl_info->type;
1615 if (ctl_mask == 0) {
1616 cval->channels = 1; /* master channel */
1617 cval->master_readonly = readonly_mask;
1620 for (i = 0; i < 16; i++)
1621 if (ctl_mask & (1 << i))
1624 cval->ch_readonly = readonly_mask;
1628 * If all channels in the mask are marked read-only, make the control
1629 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1630 * issue write commands to read-only channels.
1632 if (cval->channels == readonly_mask)
1633 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1635 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1638 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1639 usb_mixer_elem_info_free(cval);
1642 kctl->private_free = snd_usb_mixer_elem_free;
1644 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1645 mapped_name = len != 0;
1647 len = snd_usb_copy_string_desc(mixer->chip, nameid,
1648 kctl->id.name, sizeof(kctl->id.name));
1654 * determine the control name. the rule is:
1655 * - if a name id is given in descriptor, use it.
1656 * - if the connected input can be determined, then use the name
1658 * - if the connected output can be determined, use it.
1659 * - otherwise, anonymous name.
1663 len = get_term_name(mixer->chip, iterm,
1665 sizeof(kctl->id.name), 1);
1667 len = get_term_name(mixer->chip, oterm,
1669 sizeof(kctl->id.name), 1);
1671 snprintf(kctl->id.name, sizeof(kctl->id.name),
1672 "Feature %d", unitid);
1676 check_no_speaker_on_headset(kctl, mixer->chip->card);
1679 * determine the stream direction:
1680 * if the connected output is USB stream, then it's likely a
1681 * capture stream. otherwise it should be playback (hopefully :)
1683 if (!mapped_name && oterm && !(oterm->type >> 16)) {
1684 if ((oterm->type & 0xff00) == 0x0100)
1685 append_ctl_name(kctl, " Capture");
1687 append_ctl_name(kctl, " Playback");
1689 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1690 " Switch" : " Volume");
1694 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1695 sizeof(kctl->id.name));
1699 /* get min/max values */
1700 get_min_max_with_quirks(cval, 0, kctl);
1702 /* skip a bogus volume range */
1703 if (cval->max <= cval->min) {
1704 usb_audio_dbg(mixer->chip,
1705 "[%d] FU [%s] skipped due to invalid volume\n",
1706 cval->head.id, kctl->id.name);
1707 snd_ctl_free_one(kctl);
1712 if (control == UAC_FU_VOLUME) {
1713 check_mapped_dB(map, cval);
1714 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1715 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1716 kctl->vd[0].access |=
1717 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1718 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1722 snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1724 range = (cval->max - cval->min) / cval->res;
1726 * Are there devices with volume range more than 255? I use a bit more
1727 * to be sure. 384 is a resolution magic number found on Logitech
1728 * devices. It will definitively catch all buggy Logitech devices.
1731 usb_audio_warn(mixer->chip,
1732 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1734 usb_audio_warn(mixer->chip,
1735 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1736 cval->head.id, kctl->id.name, cval->channels,
1737 cval->min, cval->max, cval->res);
1740 usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1741 cval->head.id, kctl->id.name, cval->channels,
1742 cval->min, cval->max, cval->res);
1743 snd_usb_mixer_add_control(&cval->head, kctl);
1746 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1747 unsigned int ctl_mask, int control,
1748 struct usb_audio_term *iterm, int unitid,
1751 struct uac_feature_unit_descriptor *desc = raw_desc;
1752 int nameid = uac_feature_unit_iFeature(desc);
1754 __build_feature_ctl(state->mixer, state->map, ctl_mask, control,
1755 iterm, &state->oterm, unitid, nameid, readonly_mask);
1758 static void build_feature_ctl_badd(struct usb_mixer_interface *mixer,
1759 unsigned int ctl_mask, int control, int unitid,
1760 const struct usbmix_name_map *badd_map)
1762 __build_feature_ctl(mixer, badd_map, ctl_mask, control,
1763 NULL, NULL, unitid, 0, 0);
1766 static void get_connector_control_name(struct usb_mixer_interface *mixer,
1767 struct usb_audio_term *term,
1768 bool is_input, char *name, int name_size)
1770 int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1773 strlcpy(name, "Unknown", name_size);
1776 * sound/core/ctljack.c has a convention of naming jack controls
1777 * by ending in " Jack". Make it slightly more useful by
1778 * indicating Input or Output after the terminal name.
1781 strlcat(name, " - Input Jack", name_size);
1783 strlcat(name, " - Output Jack", name_size);
1786 /* Build a mixer control for a UAC connector control (jack-detect) */
1787 static void build_connector_control(struct usb_mixer_interface *mixer,
1788 const struct usbmix_name_map *imap,
1789 struct usb_audio_term *term, bool is_input)
1791 struct snd_kcontrol *kctl;
1792 struct usb_mixer_elem_info *cval;
1793 const struct usbmix_name_map *map;
1795 map = find_map(imap, term->id, 0);
1796 if (check_ignored_ctl(map))
1799 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1802 snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1804 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1805 * number of channels connected.
1807 * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1808 * following byte(s) specifies which connectors are inserted.
1810 * This boolean ctl will simply report if any channels are connected
1813 if (mixer->protocol == UAC_VERSION_2)
1814 cval->control = UAC2_TE_CONNECTOR;
1815 else /* UAC_VERSION_3 */
1816 cval->control = UAC3_TE_INSERTION;
1818 cval->val_type = USB_MIXER_BOOLEAN;
1819 cval->channels = 1; /* report true if any channel is connected */
1822 kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1824 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1825 usb_mixer_elem_info_free(cval);
1829 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)))
1830 strlcat(kctl->id.name, " Jack", sizeof(kctl->id.name));
1832 get_connector_control_name(mixer, term, is_input, kctl->id.name,
1833 sizeof(kctl->id.name));
1834 kctl->private_free = snd_usb_mixer_elem_free;
1835 snd_usb_mixer_add_control(&cval->head, kctl);
1838 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1841 struct uac_clock_source_descriptor *hdr = _ftr;
1842 struct usb_mixer_elem_info *cval;
1843 struct snd_kcontrol *kctl;
1844 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1847 if (state->mixer->protocol != UAC_VERSION_2)
1851 * The only property of this unit we are interested in is the
1852 * clock source validity. If that isn't readable, just bail out.
1854 if (!uac_v2v3_control_is_readable(hdr->bmControls,
1855 UAC2_CS_CONTROL_CLOCK_VALID))
1858 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1862 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1867 cval->val_type = USB_MIXER_BOOLEAN;
1868 cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1870 cval->master_readonly = 1;
1871 /* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1872 kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1875 usb_mixer_elem_info_free(cval);
1879 kctl->private_free = snd_usb_mixer_elem_free;
1880 ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1881 name, sizeof(name));
1883 snprintf(kctl->id.name, sizeof(kctl->id.name),
1884 "%s Validity", name);
1886 snprintf(kctl->id.name, sizeof(kctl->id.name),
1887 "Clock Source %d Validity", hdr->bClockID);
1889 return snd_usb_mixer_add_control(&cval->head, kctl);
1893 * parse a feature unit
1895 * most of controls are defined here.
1897 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1901 struct usb_audio_term iterm;
1902 unsigned int master_bits, first_ch_bits;
1904 struct uac_feature_unit_descriptor *hdr = _ftr;
1907 if (state->mixer->protocol == UAC_VERSION_1) {
1908 csize = hdr->bControlSize;
1909 channels = (hdr->bLength - 7) / csize - 1;
1910 bmaControls = hdr->bmaControls;
1911 } else if (state->mixer->protocol == UAC_VERSION_2) {
1912 struct uac2_feature_unit_descriptor *ftr = _ftr;
1914 channels = (hdr->bLength - 6) / 4 - 1;
1915 bmaControls = ftr->bmaControls;
1916 } else { /* UAC_VERSION_3 */
1917 struct uac3_feature_unit_descriptor *ftr = _ftr;
1920 channels = (ftr->bLength - 7) / 4 - 1;
1921 bmaControls = ftr->bmaControls;
1924 /* parse the source unit */
1925 err = parse_audio_unit(state, hdr->bSourceID);
1929 /* determine the input source type and name */
1930 err = check_input_term(state, hdr->bSourceID, &iterm);
1934 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1935 /* master configuration quirks */
1936 switch (state->chip->usb_id) {
1937 case USB_ID(0x08bb, 0x2702):
1938 usb_audio_info(state->chip,
1939 "usbmixer: master volume quirk for PCM2702 chip\n");
1940 /* disable non-functional volume control */
1941 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1943 case USB_ID(0x1130, 0xf211):
1944 usb_audio_info(state->chip,
1945 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1946 /* disable non-functional volume control */
1952 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1956 if (state->mixer->protocol == UAC_VERSION_1) {
1957 /* check all control types */
1958 for (i = 0; i < 10; i++) {
1959 unsigned int ch_bits = 0;
1960 int control = audio_feature_info[i].control;
1962 for (j = 0; j < channels; j++) {
1965 mask = snd_usb_combine_bytes(bmaControls +
1966 csize * (j+1), csize);
1967 if (mask & (1 << i))
1968 ch_bits |= (1 << j);
1970 /* audio class v1 controls are never read-only */
1973 * The first channel must be set
1974 * (for ease of programming).
1977 build_feature_ctl(state, _ftr, ch_bits, control,
1979 if (master_bits & (1 << i))
1980 build_feature_ctl(state, _ftr, 0, control,
1983 } else { /* UAC_VERSION_2/3 */
1984 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1985 unsigned int ch_bits = 0;
1986 unsigned int ch_read_only = 0;
1987 int control = audio_feature_info[i].control;
1989 for (j = 0; j < channels; j++) {
1992 mask = snd_usb_combine_bytes(bmaControls +
1993 csize * (j+1), csize);
1994 if (uac_v2v3_control_is_readable(mask, control)) {
1995 ch_bits |= (1 << j);
1996 if (!uac_v2v3_control_is_writeable(mask, control))
1997 ch_read_only |= (1 << j);
2002 * NOTE: build_feature_ctl() will mark the control
2003 * read-only if all channels are marked read-only in
2004 * the descriptors. Otherwise, the control will be
2005 * reported as writeable, but the driver will not
2006 * actually issue a write command for read-only
2011 * The first channel must be set
2012 * (for ease of programming).
2015 build_feature_ctl(state, _ftr, ch_bits, control,
2016 &iterm, unitid, ch_read_only);
2017 if (uac_v2v3_control_is_readable(master_bits, control))
2018 build_feature_ctl(state, _ftr, 0, control,
2020 !uac_v2v3_control_is_writeable(master_bits,
2032 /* check whether the given in/out overflows bmMixerControls matrix */
2033 static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc,
2034 int protocol, int num_ins, int num_outs)
2036 u8 *hdr = (u8 *)desc;
2037 u8 *c = uac_mixer_unit_bmControls(desc, protocol);
2038 size_t rest; /* remaining bytes after bmMixerControls */
2043 rest = 1; /* iMixer */
2046 rest = 2; /* bmControls + iMixer */
2049 rest = 6; /* bmControls + wMixerDescrStr */
2054 return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
2058 * build a mixer unit control
2060 * the callbacks are identical with feature unit.
2061 * input channel number (zero based) is given in control field instead.
2063 static void build_mixer_unit_ctl(struct mixer_build *state,
2064 struct uac_mixer_unit_descriptor *desc,
2065 int in_pin, int in_ch, int num_outs,
2066 int unitid, struct usb_audio_term *iterm)
2068 struct usb_mixer_elem_info *cval;
2069 unsigned int i, len;
2070 struct snd_kcontrol *kctl;
2071 const struct usbmix_name_map *map;
2073 map = find_map(state->map, unitid, 0);
2074 if (check_ignored_ctl(map))
2077 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2081 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2082 cval->control = in_ch + 1; /* based on 1 */
2083 cval->val_type = USB_MIXER_S16;
2084 for (i = 0; i < num_outs; i++) {
2085 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
2087 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
2088 cval->cmask |= (1 << i);
2093 /* get min/max values */
2094 get_min_max(cval, 0);
2096 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2098 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2099 usb_mixer_elem_info_free(cval);
2102 kctl->private_free = snd_usb_mixer_elem_free;
2104 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2106 len = get_term_name(state->chip, iterm, kctl->id.name,
2107 sizeof(kctl->id.name), 0);
2109 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
2110 append_ctl_name(kctl, " Volume");
2112 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2113 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
2114 snd_usb_mixer_add_control(&cval->head, kctl);
2117 static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
2120 struct usb_audio_term iterm;
2121 unsigned int control, bmctls, term_id;
2123 if (state->mixer->protocol == UAC_VERSION_2) {
2124 struct uac2_input_terminal_descriptor *d_v2 = raw_desc;
2125 control = UAC2_TE_CONNECTOR;
2126 term_id = d_v2->bTerminalID;
2127 bmctls = le16_to_cpu(d_v2->bmControls);
2128 } else if (state->mixer->protocol == UAC_VERSION_3) {
2129 struct uac3_input_terminal_descriptor *d_v3 = raw_desc;
2130 control = UAC3_TE_INSERTION;
2131 term_id = d_v3->bTerminalID;
2132 bmctls = le32_to_cpu(d_v3->bmControls);
2134 return 0; /* UAC1. No Insertion control */
2137 check_input_term(state, term_id, &iterm);
2139 /* Check for jack detection. */
2140 if ((iterm.type & 0xff00) != 0x0100 &&
2141 uac_v2v3_control_is_readable(bmctls, control))
2142 build_connector_control(state->mixer, state->map, &iterm, true);
2148 * parse a mixer unit
2150 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
2153 struct uac_mixer_unit_descriptor *desc = raw_desc;
2154 struct usb_audio_term iterm;
2155 int input_pins, num_ins, num_outs;
2158 err = uac_mixer_unit_get_channels(state, desc);
2160 usb_audio_err(state->chip,
2161 "invalid MIXER UNIT descriptor %d\n",
2167 input_pins = desc->bNrInPins;
2171 for (pin = 0; pin < input_pins; pin++) {
2172 err = parse_audio_unit(state, desc->baSourceID[pin]);
2175 /* no bmControls field (e.g. Maya44) -> ignore */
2178 err = check_input_term(state, desc->baSourceID[pin], &iterm);
2181 num_ins += iterm.channels;
2182 if (mixer_bitmap_overflow(desc, state->mixer->protocol,
2185 for (; ich < num_ins; ich++) {
2186 int och, ich_has_controls = 0;
2188 for (och = 0; och < num_outs; och++) {
2189 __u8 *c = uac_mixer_unit_bmControls(desc,
2190 state->mixer->protocol);
2192 if (check_matrix_bitmap(c, ich, och, num_outs)) {
2193 ich_has_controls = 1;
2197 if (ich_has_controls)
2198 build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
2206 * Processing Unit / Extension Unit
2209 /* get callback for processing/extension unit */
2210 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
2211 struct snd_ctl_elem_value *ucontrol)
2213 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2216 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2218 ucontrol->value.integer.value[0] = cval->min;
2219 return filter_error(cval, err);
2221 val = get_relative_value(cval, val);
2222 ucontrol->value.integer.value[0] = val;
2226 /* put callback for processing/extension unit */
2227 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
2228 struct snd_ctl_elem_value *ucontrol)
2230 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2233 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2235 return filter_error(cval, err);
2236 val = ucontrol->value.integer.value[0];
2237 val = get_abs_value(cval, val);
2239 set_cur_ctl_value(cval, cval->control << 8, val);
2245 /* alsa control interface for processing/extension unit */
2246 static const struct snd_kcontrol_new mixer_procunit_ctl = {
2247 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2248 .name = "", /* will be filled later */
2249 .info = mixer_ctl_feature_info,
2250 .get = mixer_ctl_procunit_get,
2251 .put = mixer_ctl_procunit_put,
2255 * predefined data for processing units
2257 struct procunit_value_info {
2264 struct procunit_info {
2267 const struct procunit_value_info *values;
2270 static const struct procunit_value_info undefined_proc_info[] = {
2271 { 0x00, "Control Undefined", 0 },
2275 static const struct procunit_value_info updown_proc_info[] = {
2276 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2277 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2280 static const struct procunit_value_info prologic_proc_info[] = {
2281 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2282 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2285 static const struct procunit_value_info threed_enh_proc_info[] = {
2286 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2287 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2290 static const struct procunit_value_info reverb_proc_info[] = {
2291 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2292 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2293 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2294 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2297 static const struct procunit_value_info chorus_proc_info[] = {
2298 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2299 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2300 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2301 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2304 static const struct procunit_value_info dcr_proc_info[] = {
2305 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2306 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2307 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2308 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2309 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2310 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2314 static const struct procunit_info procunits[] = {
2315 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2316 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2317 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2318 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2319 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2320 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2324 static const struct procunit_value_info uac3_updown_proc_info[] = {
2325 { UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2328 static const struct procunit_value_info uac3_stereo_ext_proc_info[] = {
2329 { UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
2333 static const struct procunit_info uac3_procunits[] = {
2334 { UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info },
2335 { UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info },
2336 { UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info },
2341 * predefined data for extension units
2343 static const struct procunit_value_info clock_rate_xu_info[] = {
2344 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2347 static const struct procunit_value_info clock_source_xu_info[] = {
2348 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2351 static const struct procunit_value_info spdif_format_xu_info[] = {
2352 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2355 static const struct procunit_value_info soft_limit_xu_info[] = {
2356 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2359 static const struct procunit_info extunits[] = {
2360 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2361 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2362 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2363 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2368 * build a processing/extension unit
2370 static int build_audio_procunit(struct mixer_build *state, int unitid,
2371 void *raw_desc, const struct procunit_info *list,
2372 bool extension_unit)
2374 struct uac_processing_unit_descriptor *desc = raw_desc;
2376 struct usb_mixer_elem_info *cval;
2377 struct snd_kcontrol *kctl;
2378 int i, err, nameid, type, len;
2379 const struct procunit_info *info;
2380 const struct procunit_value_info *valinfo;
2381 const struct usbmix_name_map *map;
2382 static const struct procunit_value_info default_value_info[] = {
2383 { 0x01, "Switch", USB_MIXER_BOOLEAN },
2386 static const struct procunit_info default_info = {
2387 0, NULL, default_value_info
2389 const char *name = extension_unit ?
2390 "Extension Unit" : "Processing Unit";
2392 num_ins = desc->bNrInPins;
2393 for (i = 0; i < num_ins; i++) {
2394 err = parse_audio_unit(state, desc->baSourceID[i]);
2399 type = le16_to_cpu(desc->wProcessType);
2400 for (info = list; info && info->type; info++)
2401 if (info->type == type)
2403 if (!info || !info->type)
2404 info = &default_info;
2406 for (valinfo = info->values; valinfo->control; valinfo++) {
2407 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2409 if (state->mixer->protocol == UAC_VERSION_1) {
2410 if (!(controls[valinfo->control / 8] &
2411 (1 << ((valinfo->control % 8) - 1))))
2413 } else { /* UAC_VERSION_2/3 */
2414 if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
2419 map = find_map(state->map, unitid, valinfo->control);
2420 if (check_ignored_ctl(map))
2422 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2425 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2426 cval->control = valinfo->control;
2427 cval->val_type = valinfo->val_type;
2430 if (state->mixer->protocol > UAC_VERSION_1 &&
2431 !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
2433 cval->master_readonly = 1;
2435 /* get min/max values */
2437 case UAC_PROCESS_UP_DOWNMIX: {
2438 bool mode_sel = false;
2440 switch (state->mixer->protocol) {
2444 if (cval->control == UAC_UD_MODE_SELECT)
2448 if (cval->control == UAC3_UD_MODE_SELECT)
2454 __u8 *control_spec = uac_processing_unit_specific(desc,
2455 state->mixer->protocol);
2457 cval->max = control_spec[0];
2459 cval->initialized = 1;
2463 get_min_max(cval, valinfo->min_value);
2466 case USB_XU_CLOCK_RATE:
2468 * E-Mu USB 0404/0202/TrackerPre/0204
2469 * samplerate control quirk
2474 cval->initialized = 1;
2477 get_min_max(cval, valinfo->min_value);
2481 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2483 usb_mixer_elem_info_free(cval);
2486 kctl->private_free = snd_usb_mixer_elem_free;
2488 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2490 } else if (info->name) {
2491 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2494 nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
2496 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2499 len = snd_usb_copy_string_desc(state->chip,
2502 sizeof(kctl->id.name));
2504 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
2506 append_ctl_name(kctl, " ");
2507 append_ctl_name(kctl, valinfo->suffix);
2509 usb_audio_dbg(state->chip,
2510 "[%d] PU [%s] ch = %d, val = %d/%d\n",
2511 cval->head.id, kctl->id.name, cval->channels,
2512 cval->min, cval->max);
2514 err = snd_usb_mixer_add_control(&cval->head, kctl);
2521 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2524 switch (state->mixer->protocol) {
2528 return build_audio_procunit(state, unitid, raw_desc,
2531 return build_audio_procunit(state, unitid, raw_desc,
2532 uac3_procunits, false);
2536 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2540 * Note that we parse extension units with processing unit descriptors.
2541 * That's ok as the layout is the same.
2543 return build_audio_procunit(state, unitid, raw_desc, extunits, true);
2551 * info callback for selector unit
2552 * use an enumerator type for routing
2554 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2555 struct snd_ctl_elem_info *uinfo)
2557 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2558 const char **itemlist = (const char **)kcontrol->private_value;
2560 if (snd_BUG_ON(!itemlist))
2562 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2565 /* get callback for selector unit */
2566 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2567 struct snd_ctl_elem_value *ucontrol)
2569 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2572 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2574 ucontrol->value.enumerated.item[0] = 0;
2575 return filter_error(cval, err);
2577 val = get_relative_value(cval, val);
2578 ucontrol->value.enumerated.item[0] = val;
2582 /* put callback for selector unit */
2583 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2584 struct snd_ctl_elem_value *ucontrol)
2586 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2589 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2591 return filter_error(cval, err);
2592 val = ucontrol->value.enumerated.item[0];
2593 val = get_abs_value(cval, val);
2595 set_cur_ctl_value(cval, cval->control << 8, val);
2601 /* alsa control interface for selector unit */
2602 static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2603 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2604 .name = "", /* will be filled later */
2605 .info = mixer_ctl_selector_info,
2606 .get = mixer_ctl_selector_get,
2607 .put = mixer_ctl_selector_put,
2611 * private free callback.
2612 * free both private_data and private_value
2614 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2618 if (kctl->private_data) {
2619 struct usb_mixer_elem_info *cval = kctl->private_data;
2620 num_ins = cval->max;
2621 usb_mixer_elem_info_free(cval);
2622 kctl->private_data = NULL;
2624 if (kctl->private_value) {
2625 char **itemlist = (char **)kctl->private_value;
2626 for (i = 0; i < num_ins; i++)
2629 kctl->private_value = 0;
2634 * parse a selector unit
2636 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2639 struct uac_selector_unit_descriptor *desc = raw_desc;
2640 unsigned int i, nameid, len;
2642 struct usb_mixer_elem_info *cval;
2643 struct snd_kcontrol *kctl;
2644 const struct usbmix_name_map *map;
2647 for (i = 0; i < desc->bNrInPins; i++) {
2648 err = parse_audio_unit(state, desc->baSourceID[i]);
2653 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2656 map = find_map(state->map, unitid, 0);
2657 if (check_ignored_ctl(map))
2660 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2663 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2664 cval->val_type = USB_MIXER_U8;
2667 cval->max = desc->bNrInPins;
2669 cval->initialized = 1;
2671 switch (state->mixer->protocol) {
2678 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2679 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2680 cval->control = UAC2_CX_CLOCK_SELECTOR;
2681 else /* UAC2/3_SELECTOR_UNIT */
2682 cval->control = UAC2_SU_SELECTOR;
2686 namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2691 #define MAX_ITEM_NAME_LEN 64
2692 for (i = 0; i < desc->bNrInPins; i++) {
2693 struct usb_audio_term iterm;
2695 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2700 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2702 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2703 len = get_term_name(state->chip, &iterm, namelist[i],
2704 MAX_ITEM_NAME_LEN, 0);
2706 sprintf(namelist[i], "Input %u", i);
2709 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2711 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2715 kctl->private_value = (unsigned long)namelist;
2716 kctl->private_free = usb_mixer_selector_elem_free;
2718 /* check the static mapping table at first */
2719 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2722 switch (state->mixer->protocol) {
2726 /* if iSelector is given, use it */
2727 nameid = uac_selector_unit_iSelector(desc);
2729 len = snd_usb_copy_string_desc(state->chip,
2730 nameid, kctl->id.name,
2731 sizeof(kctl->id.name));
2734 /* TODO: Class-Specific strings not yet supported */
2738 /* ... or pick up the terminal name at next */
2740 len = get_term_name(state->chip, &state->oterm,
2741 kctl->id.name, sizeof(kctl->id.name), 0);
2742 /* ... or use the fixed string "USB" as the last resort */
2744 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2746 /* and add the proper suffix */
2747 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2748 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2749 append_ctl_name(kctl, " Clock Source");
2750 else if ((state->oterm.type & 0xff00) == 0x0100)
2751 append_ctl_name(kctl, " Capture Source");
2753 append_ctl_name(kctl, " Playback Source");
2756 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2757 cval->head.id, kctl->id.name, desc->bNrInPins);
2758 return snd_usb_mixer_add_control(&cval->head, kctl);
2761 for (i = 0; i < desc->bNrInPins; i++)
2765 usb_mixer_elem_info_free(cval);
2770 * parse an audio unit recursively
2773 static int parse_audio_unit(struct mixer_build *state, int unitid)
2776 int protocol = state->mixer->protocol;
2778 if (test_and_set_bit(unitid, state->unitbitmap))
2779 return 0; /* the unit already visited */
2781 p1 = find_audio_control_unit(state, unitid);
2783 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2787 if (!snd_usb_validate_audio_desc(p1, protocol)) {
2788 usb_audio_dbg(state->chip, "invalid unit %d\n", unitid);
2789 return 0; /* skip invalid unit */
2792 switch (PTYPE(protocol, p1[2])) {
2793 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
2794 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
2795 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
2796 return parse_audio_input_terminal(state, unitid, p1);
2797 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
2798 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
2799 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
2800 return parse_audio_mixer_unit(state, unitid, p1);
2801 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
2802 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
2803 return parse_clock_source_unit(state, unitid, p1);
2804 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
2805 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
2806 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
2807 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
2808 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
2809 return parse_audio_selector_unit(state, unitid, p1);
2810 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
2811 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
2812 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT):
2813 return parse_audio_feature_unit(state, unitid, p1);
2814 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
2815 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
2816 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
2817 return parse_audio_processing_unit(state, unitid, p1);
2818 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
2819 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
2820 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
2821 return parse_audio_extension_unit(state, unitid, p1);
2822 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
2823 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
2824 return 0; /* FIXME - effect units not implemented yet */
2826 usb_audio_err(state->chip,
2827 "unit %u: unexpected type 0x%02x\n",
2833 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2835 /* kill pending URBs */
2836 snd_usb_mixer_disconnect(mixer);
2838 kfree(mixer->id_elems);
2840 kfree(mixer->urb->transfer_buffer);
2841 usb_free_urb(mixer->urb);
2843 usb_free_urb(mixer->rc_urb);
2844 kfree(mixer->rc_setup_packet);
2848 static int snd_usb_mixer_dev_free(struct snd_device *device)
2850 struct usb_mixer_interface *mixer = device->device_data;
2851 snd_usb_mixer_free(mixer);
2855 /* UAC3 predefined channels configuration */
2856 struct uac3_badd_profile {
2859 int c_chmask; /* capture channels mask */
2860 int p_chmask; /* playback channels mask */
2861 int st_chmask; /* side tone mixing channel mask */
2864 static const struct uac3_badd_profile uac3_badd_profiles[] = {
2867 * BAIF, BAOF or combination of both
2868 * IN: Mono or Stereo cfg, Mono alt possible
2869 * OUT: Mono or Stereo cfg, Mono alt possible
2871 .subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
2872 .name = "GENERIC IO",
2873 .c_chmask = -1, /* dynamic channels */
2874 .p_chmask = -1, /* dynamic channels */
2877 /* BAOF; Stereo only cfg, Mono alt possible */
2878 .subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
2879 .name = "HEADPHONE",
2883 /* BAOF; Mono or Stereo cfg, Mono alt possible */
2884 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
2886 .p_chmask = -1, /* dynamic channels */
2889 /* BAIF; Mono or Stereo cfg, Mono alt possible */
2890 .subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
2891 .name = "MICROPHONE",
2892 .c_chmask = -1, /* dynamic channels */
2898 * OUT: Mono or Stereo cfg, Mono alt possible
2900 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
2903 .p_chmask = -1, /* dynamic channels */
2907 /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
2908 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
2909 .name = "HEADSET ADAPTER",
2915 /* BAIF + BAOF; IN: Mono only; OUT: Mono only */
2916 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
2917 .name = "SPEAKERPHONE",
2921 { 0 } /* terminator */
2924 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
2925 const struct uac3_badd_profile *f,
2926 int c_chmask, int p_chmask)
2929 * If both playback/capture channels are dynamic, make sure
2930 * at least one channel is present
2932 if (f->c_chmask < 0 && f->p_chmask < 0) {
2933 if (!c_chmask && !p_chmask) {
2934 usb_audio_warn(mixer->chip, "BAAD %s: no channels?",
2941 if ((f->c_chmask < 0 && !c_chmask) ||
2942 (f->c_chmask >= 0 && f->c_chmask != c_chmask)) {
2943 usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch",
2947 if ((f->p_chmask < 0 && !p_chmask) ||
2948 (f->p_chmask >= 0 && f->p_chmask != p_chmask)) {
2949 usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch",
2957 * create mixer controls for UAC3 BADD profiles
2959 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
2961 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
2963 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
2966 struct usb_device *dev = mixer->chip->dev;
2967 struct usb_interface_assoc_descriptor *assoc;
2968 int badd_profile = mixer->chip->badd_profile;
2969 const struct uac3_badd_profile *f;
2970 const struct usbmix_ctl_map *map;
2971 int p_chmask = 0, c_chmask = 0, st_chmask = 0;
2974 assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
2976 /* Detect BADD capture/playback channels from AS EP descriptors */
2977 for (i = 0; i < assoc->bInterfaceCount; i++) {
2978 int intf = assoc->bFirstInterface + i;
2980 struct usb_interface *iface;
2981 struct usb_host_interface *alts;
2982 struct usb_interface_descriptor *altsd;
2983 unsigned int maxpacksize;
2990 iface = usb_ifnum_to_if(dev, intf);
2994 num = iface->num_altsetting;
3000 * The number of Channels in an AudioStreaming interface
3001 * and the audio sample bit resolution (16 bits or 24
3002 * bits) can be derived from the wMaxPacketSize field in
3003 * the Standard AS Audio Data Endpoint descriptor in
3004 * Alternate Setting 1
3006 alts = &iface->altsetting[1];
3007 altsd = get_iface_desc(alts);
3009 if (altsd->bNumEndpoints < 1)
3012 /* check direction */
3013 dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
3014 maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3016 switch (maxpacksize) {
3018 usb_audio_err(mixer->chip,
3019 "incorrect wMaxPacketSize 0x%x for BADD profile\n",
3022 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
3023 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
3024 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
3025 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
3028 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
3029 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
3030 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
3031 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
3042 usb_audio_dbg(mixer->chip,
3043 "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
3044 badd_profile, c_chmask, p_chmask);
3046 /* check the mapping table */
3047 for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
3048 if (map->id == badd_profile)
3055 for (f = uac3_badd_profiles; f->name; f++) {
3056 if (badd_profile == f->subclass)
3061 if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
3063 st_chmask = f->st_chmask;
3067 /* Master channel, always writable */
3068 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3069 UAC3_BADD_FU_ID2, map->map);
3070 /* Mono/Stereo volume channels, always writable */
3071 build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
3072 UAC3_BADD_FU_ID2, map->map);
3077 /* Master channel, always writable */
3078 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3079 UAC3_BADD_FU_ID5, map->map);
3080 /* Mono/Stereo volume channels, always writable */
3081 build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
3082 UAC3_BADD_FU_ID5, map->map);
3085 /* Side tone-mixing */
3087 /* Master channel, always writable */
3088 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3089 UAC3_BADD_FU_ID7, map->map);
3090 /* Mono volume channel, always writable */
3091 build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
3092 UAC3_BADD_FU_ID7, map->map);
3095 /* Insertion Control */
3096 if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
3097 struct usb_audio_term iterm, oterm;
3099 /* Input Term - Insertion control */
3100 memset(&iterm, 0, sizeof(iterm));
3101 iterm.id = UAC3_BADD_IT_ID4;
3102 iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3103 build_connector_control(mixer, map->map, &iterm, true);
3105 /* Output Term - Insertion control */
3106 memset(&oterm, 0, sizeof(oterm));
3107 oterm.id = UAC3_BADD_OT_ID3;
3108 oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3109 build_connector_control(mixer, map->map, &oterm, false);
3116 * create mixer controls
3118 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3120 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
3122 struct mixer_build state;
3124 const struct usbmix_ctl_map *map;
3127 memset(&state, 0, sizeof(state));
3128 state.chip = mixer->chip;
3129 state.mixer = mixer;
3130 state.buffer = mixer->hostif->extra;
3131 state.buflen = mixer->hostif->extralen;
3133 /* check the mapping table */
3134 for (map = usbmix_ctl_maps; map->id; map++) {
3135 if (map->id == state.chip->usb_id) {
3136 state.map = map->map;
3137 state.selector_map = map->selector_map;
3138 mixer->connector_map = map->connector_map;
3139 mixer->ignore_ctl_error |= map->ignore_ctl_error;
3145 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
3146 mixer->hostif->extralen,
3147 p, UAC_OUTPUT_TERMINAL)) != NULL) {
3148 if (!snd_usb_validate_audio_desc(p, mixer->protocol))
3149 continue; /* skip invalid descriptor */
3151 if (mixer->protocol == UAC_VERSION_1) {
3152 struct uac1_output_terminal_descriptor *desc = p;
3154 /* mark terminal ID as visited */
3155 set_bit(desc->bTerminalID, state.unitbitmap);
3156 state.oterm.id = desc->bTerminalID;
3157 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3158 state.oterm.name = desc->iTerminal;
3159 err = parse_audio_unit(&state, desc->bSourceID);
3160 if (err < 0 && err != -EINVAL)
3162 } else if (mixer->protocol == UAC_VERSION_2) {
3163 struct uac2_output_terminal_descriptor *desc = p;
3165 /* mark terminal ID as visited */
3166 set_bit(desc->bTerminalID, state.unitbitmap);
3167 state.oterm.id = desc->bTerminalID;
3168 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3169 state.oterm.name = desc->iTerminal;
3170 err = parse_audio_unit(&state, desc->bSourceID);
3171 if (err < 0 && err != -EINVAL)
3175 * For UAC2, use the same approach to also add the
3178 err = parse_audio_unit(&state, desc->bCSourceID);
3179 if (err < 0 && err != -EINVAL)
3182 if ((state.oterm.type & 0xff00) != 0x0100 &&
3183 uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3184 UAC2_TE_CONNECTOR)) {
3185 build_connector_control(state.mixer, state.map,
3186 &state.oterm, false);
3188 } else { /* UAC_VERSION_3 */
3189 struct uac3_output_terminal_descriptor *desc = p;
3191 /* mark terminal ID as visited */
3192 set_bit(desc->bTerminalID, state.unitbitmap);
3193 state.oterm.id = desc->bTerminalID;
3194 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3195 state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
3196 err = parse_audio_unit(&state, desc->bSourceID);
3197 if (err < 0 && err != -EINVAL)
3201 * For UAC3, use the same approach to also add the
3204 err = parse_audio_unit(&state, desc->bCSourceID);
3205 if (err < 0 && err != -EINVAL)
3208 if ((state.oterm.type & 0xff00) != 0x0100 &&
3209 uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
3210 UAC3_TE_INSERTION)) {
3211 build_connector_control(state.mixer, state.map,
3212 &state.oterm, false);
3220 static int delegate_notify(struct usb_mixer_interface *mixer, int unitid,
3221 u8 *control, u8 *channel)
3223 const struct usbmix_connector_map *map = mixer->connector_map;
3228 for (; map->id; map++) {
3229 if (map->id == unitid) {
3230 if (control && map->control)
3231 *control = map->control;
3232 if (channel && map->channel)
3233 *channel = map->channel;
3234 return map->delegated_id;
3240 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3242 struct usb_mixer_elem_list *list;
3244 unitid = delegate_notify(mixer, unitid, NULL, NULL);
3246 for_each_mixer_elem(list, mixer, unitid) {
3247 struct usb_mixer_elem_info *info;
3249 if (!list->is_std_info)
3251 info = mixer_elem_list_to_info(list);
3252 /* invalidate cache, so the value is read from the device */
3254 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3259 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3260 struct usb_mixer_elem_list *list)
3262 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3263 static const char * const val_types[] = {
3264 "BOOLEAN", "INV_BOOLEAN", "S8", "U8", "S16", "U16", "S32", "U32",
3266 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
3267 "channels=%i, type=\"%s\"\n", cval->head.id,
3268 cval->control, cval->cmask, cval->channels,
3269 val_types[cval->val_type]);
3270 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3271 cval->min, cval->max, cval->dBmin, cval->dBmax);
3274 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
3275 struct snd_info_buffer *buffer)
3277 struct snd_usb_audio *chip = entry->private_data;
3278 struct usb_mixer_interface *mixer;
3279 struct usb_mixer_elem_list *list;
3282 list_for_each_entry(mixer, &chip->mixer_list, list) {
3284 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3285 chip->usb_id, snd_usb_ctrl_intf(chip),
3286 mixer->ignore_ctl_error);
3287 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
3288 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3289 for_each_mixer_elem(list, mixer, unitid) {
3290 snd_iprintf(buffer, " Unit: %i\n", list->id);
3293 " Control: name=\"%s\", index=%i\n",
3294 list->kctl->id.name,
3295 list->kctl->id.index);
3297 list->dump(buffer, list);
3303 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
3304 int attribute, int value, int index)
3306 struct usb_mixer_elem_list *list;
3307 __u8 unitid = (index >> 8) & 0xff;
3308 __u8 control = (value >> 8) & 0xff;
3309 __u8 channel = value & 0xff;
3310 unsigned int count = 0;
3312 if (channel >= MAX_CHANNELS) {
3313 usb_audio_dbg(mixer->chip,
3314 "%s(): bogus channel number %d\n",
3319 unitid = delegate_notify(mixer, unitid, &control, &channel);
3321 for_each_mixer_elem(list, mixer, unitid)
3327 for_each_mixer_elem(list, mixer, unitid) {
3328 struct usb_mixer_elem_info *info;
3332 if (!list->is_std_info)
3335 info = mixer_elem_list_to_info(list);
3336 if (count > 1 && info->control != control)
3339 switch (attribute) {
3341 /* invalidate cache, so the value is read from the device */
3343 info->cached &= ~(1 << channel);
3344 else /* master channel */
3347 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3348 &info->head.kctl->id);
3360 usb_audio_dbg(mixer->chip,
3361 "unknown attribute %d in interrupt\n",
3368 static void snd_usb_mixer_interrupt(struct urb *urb)
3370 struct usb_mixer_interface *mixer = urb->context;
3371 int len = urb->actual_length;
3372 int ustatus = urb->status;
3377 if (mixer->protocol == UAC_VERSION_1) {
3378 struct uac1_status_word *status;
3380 for (status = urb->transfer_buffer;
3381 len >= sizeof(*status);
3382 len -= sizeof(*status), status++) {
3383 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3384 status->bStatusType,
3385 status->bOriginator);
3387 /* ignore any notifications not from the control interface */
3388 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
3389 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3392 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
3393 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3395 snd_usb_mixer_notify_id(mixer, status->bOriginator);
3397 } else { /* UAC_VERSION_2 */
3398 struct uac2_interrupt_data_msg *msg;
3400 for (msg = urb->transfer_buffer;
3401 len >= sizeof(*msg);
3402 len -= sizeof(*msg), msg++) {
3403 /* drop vendor specific and endpoint requests */
3404 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
3405 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
3408 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
3409 le16_to_cpu(msg->wValue),
3410 le16_to_cpu(msg->wIndex));
3415 if (ustatus != -ENOENT &&
3416 ustatus != -ECONNRESET &&
3417 ustatus != -ESHUTDOWN) {
3418 urb->dev = mixer->chip->dev;
3419 usb_submit_urb(urb, GFP_ATOMIC);
3423 /* create the handler for the optional status interrupt endpoint */
3424 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
3426 struct usb_endpoint_descriptor *ep;
3427 void *transfer_buffer;
3431 /* we need one interrupt input endpoint */
3432 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3434 ep = get_endpoint(mixer->hostif, 0);
3435 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3438 epnum = usb_endpoint_num(ep);
3439 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
3440 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
3441 if (!transfer_buffer)
3443 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
3445 kfree(transfer_buffer);
3448 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
3449 usb_rcvintpipe(mixer->chip->dev, epnum),
3450 transfer_buffer, buffer_length,
3451 snd_usb_mixer_interrupt, mixer, ep->bInterval);
3452 usb_submit_urb(mixer->urb, GFP_KERNEL);
3456 static int keep_iface_ctl_get(struct snd_kcontrol *kcontrol,
3457 struct snd_ctl_elem_value *ucontrol)
3459 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3461 ucontrol->value.integer.value[0] = mixer->chip->keep_iface;
3465 static int keep_iface_ctl_put(struct snd_kcontrol *kcontrol,
3466 struct snd_ctl_elem_value *ucontrol)
3468 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3469 bool keep_iface = !!ucontrol->value.integer.value[0];
3471 if (mixer->chip->keep_iface == keep_iface)
3473 mixer->chip->keep_iface = keep_iface;
3477 static const struct snd_kcontrol_new keep_iface_ctl = {
3478 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
3479 .name = "Keep Interface",
3480 .info = snd_ctl_boolean_mono_info,
3481 .get = keep_iface_ctl_get,
3482 .put = keep_iface_ctl_put,
3485 static int create_keep_iface_ctl(struct usb_mixer_interface *mixer)
3487 struct snd_kcontrol *kctl = snd_ctl_new1(&keep_iface_ctl, mixer);
3489 /* need only one control per card */
3490 if (snd_ctl_find_id(mixer->chip->card, &kctl->id)) {
3491 snd_ctl_free_one(kctl);
3495 return snd_ctl_add(mixer->chip->card, kctl);
3498 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
3501 static struct snd_device_ops dev_ops = {
3502 .dev_free = snd_usb_mixer_dev_free
3504 struct usb_mixer_interface *mixer;
3505 struct snd_info_entry *entry;
3508 strcpy(chip->card->mixername, "USB Mixer");
3510 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3514 mixer->ignore_ctl_error = ignore_error;
3515 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
3517 if (!mixer->id_elems) {
3522 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
3523 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3526 mixer->protocol = UAC_VERSION_1;
3529 mixer->protocol = UAC_VERSION_2;
3532 mixer->protocol = UAC_VERSION_3;
3536 if (mixer->protocol == UAC_VERSION_3 &&
3537 chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3538 err = snd_usb_mixer_controls_badd(mixer, ctrlif);
3542 err = snd_usb_mixer_controls(mixer);
3547 err = snd_usb_mixer_status_create(mixer);
3551 err = create_keep_iface_ctl(mixer);
3555 err = snd_usb_mixer_apply_create_quirk(mixer);
3559 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3563 if (list_empty(&chip->mixer_list) &&
3564 !snd_card_proc_new(chip->card, "usbmixer", &entry))
3565 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
3567 list_add(&mixer->list, &chip->mixer_list);
3571 snd_usb_mixer_free(mixer);
3575 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3577 if (mixer->disconnected)
3580 usb_kill_urb(mixer->urb);
3582 usb_kill_urb(mixer->rc_urb);
3583 mixer->disconnected = true;
3587 /* stop any bus activity of a mixer */
3588 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
3590 usb_kill_urb(mixer->urb);
3591 usb_kill_urb(mixer->rc_urb);
3594 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
3599 err = usb_submit_urb(mixer->urb, GFP_NOIO);
3607 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
3609 snd_usb_mixer_inactivate(mixer);
3613 static int restore_mixer_value(struct usb_mixer_elem_list *list)
3615 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3620 for (c = 0; c < MAX_CHANNELS; c++) {
3621 if (!(cval->cmask & (1 << c)))
3623 if (cval->cached & (1 << (c + 1))) {
3624 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3625 cval->cache_val[idx]);
3634 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3643 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
3645 struct usb_mixer_elem_list *list;
3649 /* restore cached mixer values */
3650 for (id = 0; id < MAX_ID_ELEMS; id++) {
3651 for_each_mixer_elem(list, mixer, id) {
3653 err = list->resume(list);
3661 snd_usb_mixer_resume_quirk(mixer);
3663 return snd_usb_mixer_activate(mixer);
3667 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
3668 struct usb_mixer_interface *mixer,
3671 list->mixer = mixer;
3673 list->dump = snd_usb_mixer_dump_cval;
3675 list->resume = restore_mixer_value;