1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * (Tentative) USB Audio Driver for ALSA
7 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
9 * Many codes borrowed from audio.c by
10 * Alan Cox (alan@lxorguk.ukuu.org.uk)
11 * Thomas Sailer (sailer@ife.ee.ethz.ch)
15 * TODOs, for both the mixer and the streaming interfaces:
17 * - support for UAC2 effect units
18 * - support for graphical equalizers
19 * - RANGE and MEM set commands (UAC2)
20 * - RANGE and MEM interrupt dispatchers (UAC2)
21 * - audio channel clustering (UAC2)
22 * - audio sample rate converter units (UAC2)
23 * - proper handling of clock multipliers (UAC2)
24 * - dispatch clock change notifications (UAC2)
25 * - stop PCM streams which use a clock that became invalid
26 * - stop PCM streams which use a clock selector that has changed
27 * - parse available sample rates again when clock sources changed
30 #include <linux/bitops.h>
31 #include <linux/init.h>
32 #include <linux/list.h>
33 #include <linux/log2.h>
34 #include <linux/slab.h>
35 #include <linux/string.h>
36 #include <linux/usb.h>
37 #include <linux/usb/audio.h>
38 #include <linux/usb/audio-v2.h>
39 #include <linux/usb/audio-v3.h>
41 #include <sound/core.h>
42 #include <sound/control.h>
43 #include <sound/hwdep.h>
44 #include <sound/info.h>
45 #include <sound/tlv.h>
50 #include "mixer_quirks.h"
53 #define MAX_ID_ELEMS 256
55 struct usb_audio_term {
59 unsigned int chconfig;
63 struct usbmix_name_map;
66 struct snd_usb_audio *chip;
67 struct usb_mixer_interface *mixer;
68 unsigned char *buffer;
70 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
71 DECLARE_BITMAP(termbitmap, MAX_ID_ELEMS);
72 struct usb_audio_term oterm;
73 const struct usbmix_name_map *map;
74 const struct usbmix_selector_map *selector_map;
77 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
79 USB_XU_CLOCK_RATE = 0xe301,
80 USB_XU_CLOCK_SOURCE = 0xe302,
81 USB_XU_DIGITAL_IO_STATUS = 0xe303,
82 USB_XU_DEVICE_OPTIONS = 0xe304,
83 USB_XU_DIRECT_MONITORING = 0xe305,
84 USB_XU_METERING = 0xe306
87 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/
88 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */
89 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */
90 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */
94 * manual mapping of mixer names
95 * if the mixer topology is too complicated and the parsed names are
96 * ambiguous, add the entries in usbmixer_maps.c.
98 #include "mixer_maps.c"
100 static const struct usbmix_name_map *
101 find_map(const struct usbmix_name_map *p, int unitid, int control)
107 if (p->id == unitid &&
108 (!control || !p->control || control == p->control))
114 /* get the mapped name if the unit matches */
116 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
124 len = strscpy(buf, p->name, buflen);
125 return len < 0 ? buflen : len;
128 /* ignore the error value if ignore_ctl_error flag is set */
129 #define filter_error(cval, err) \
130 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
132 /* check whether the control should be ignored */
134 check_ignored_ctl(const struct usbmix_name_map *p)
136 if (!p || p->name || p->dB)
142 static inline void check_mapped_dB(const struct usbmix_name_map *p,
143 struct usb_mixer_elem_info *cval)
146 cval->dBmin = p->dB->min;
147 cval->dBmax = p->dB->max;
148 cval->initialized = 1;
152 /* get the mapped selector source name */
153 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
154 int index, char *buf, int buflen)
156 const struct usbmix_selector_map *p;
159 if (!state->selector_map)
161 for (p = state->selector_map; p->id; p++) {
162 if (p->id == unitid && index < p->count) {
163 len = strscpy(buf, p->names[index], buflen);
164 return len < 0 ? buflen : len;
171 * find an audio control unit with the given unit id
173 static void *find_audio_control_unit(struct mixer_build *state,
176 /* we just parse the header */
177 struct uac_feature_unit_descriptor *hdr = NULL;
179 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
180 USB_DT_CS_INTERFACE)) != NULL) {
181 if (hdr->bLength >= 4 &&
182 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
183 hdr->bDescriptorSubtype <= UAC3_SAMPLE_RATE_CONVERTER &&
184 hdr->bUnitID == unit)
192 * copy a string with the given id
194 static int snd_usb_copy_string_desc(struct snd_usb_audio *chip,
195 int index, char *buf, int maxlen)
197 int len = usb_string(chip->dev, index, buf, maxlen - 1);
207 * convert from the byte/word on usb descriptor to the zero-based integer
209 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
211 switch (cval->val_type) {
212 case USB_MIXER_BOOLEAN:
214 case USB_MIXER_INV_BOOLEAN:
237 * convert from the zero-based int to the byte/word for usb descriptor
239 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
241 switch (cval->val_type) {
242 case USB_MIXER_BOOLEAN:
244 case USB_MIXER_INV_BOOLEAN:
253 return 0; /* not reached */
256 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
262 else if (val >= cval->max)
263 return DIV_ROUND_UP(cval->max - cval->min, cval->res);
265 return (val - cval->min) / cval->res;
268 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
281 static int uac2_ctl_value_size(int val_type)
293 return 0; /* unreachable */
298 * retrieve a mixer value
301 static inline int mixer_ctrl_intf(struct usb_mixer_interface *mixer)
303 return get_iface_desc(mixer->hostif)->bInterfaceNumber;
306 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
307 int validx, int *value_ret)
309 struct snd_usb_audio *chip = cval->head.mixer->chip;
310 unsigned char buf[2];
311 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
315 err = snd_usb_lock_shutdown(chip);
319 while (timeout-- > 0) {
320 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
321 err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
322 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
323 validx, idx, buf, val_len);
324 if (err >= val_len) {
325 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
328 } else if (err == -ETIMEDOUT) {
333 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
334 request, validx, idx, cval->val_type);
338 snd_usb_unlock_shutdown(chip);
342 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
343 int validx, int *value_ret)
345 struct snd_usb_audio *chip = cval->head.mixer->chip;
346 /* enough space for one range */
347 unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
349 int idx = 0, ret, val_size, size;
352 val_size = uac2_ctl_value_size(cval->val_type);
354 if (request == UAC_GET_CUR) {
355 bRequest = UAC2_CS_CUR;
358 bRequest = UAC2_CS_RANGE;
359 size = sizeof(__u16) + 3 * val_size;
362 memset(buf, 0, sizeof(buf));
364 if (snd_usb_lock_shutdown(chip))
367 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
368 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
369 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
370 validx, idx, buf, size);
371 snd_usb_unlock_shutdown(chip);
375 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
376 request, validx, idx, cval->val_type);
380 /* FIXME: how should we handle multiple triplets here? */
387 val = buf + sizeof(__u16);
390 val = buf + sizeof(__u16) + val_size;
393 val = buf + sizeof(__u16) + val_size * 2;
399 *value_ret = convert_signed_value(cval,
400 snd_usb_combine_bytes(val, val_size));
405 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
406 int validx, int *value_ret)
408 validx += cval->idx_off;
410 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
411 get_ctl_value_v1(cval, request, validx, value_ret) :
412 get_ctl_value_v2(cval, request, validx, value_ret);
415 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
416 int validx, int *value)
418 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
421 /* channel = 0: master, 1 = first channel */
422 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
423 int channel, int *value)
425 return get_ctl_value(cval, UAC_GET_CUR,
426 (cval->control << 8) | channel,
430 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
431 int channel, int index, int *value)
435 if (cval->cached & (1 << channel)) {
436 *value = cval->cache_val[index];
439 err = get_cur_mix_raw(cval, channel, value);
441 if (!cval->head.mixer->ignore_ctl_error)
442 usb_audio_dbg(cval->head.mixer->chip,
443 "cannot get current value for control %d ch %d: err = %d\n",
444 cval->control, channel, err);
447 cval->cached |= 1 << channel;
448 cval->cache_val[index] = *value;
456 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
457 int request, int validx, int value_set)
459 struct snd_usb_audio *chip = cval->head.mixer->chip;
460 unsigned char buf[4];
461 int idx = 0, val_len, err, timeout = 10;
463 validx += cval->idx_off;
466 if (cval->head.mixer->protocol == UAC_VERSION_1) {
467 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
468 } else { /* UAC_VERSION_2/3 */
469 val_len = uac2_ctl_value_size(cval->val_type);
472 if (request != UAC_SET_CUR) {
473 usb_audio_dbg(chip, "RANGE setting not yet supported\n");
477 request = UAC2_CS_CUR;
480 value_set = convert_bytes_value(cval, value_set);
481 buf[0] = value_set & 0xff;
482 buf[1] = (value_set >> 8) & 0xff;
483 buf[2] = (value_set >> 16) & 0xff;
484 buf[3] = (value_set >> 24) & 0xff;
486 err = snd_usb_lock_shutdown(chip);
490 while (timeout-- > 0) {
491 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
492 err = snd_usb_ctl_msg(chip->dev,
493 usb_sndctrlpipe(chip->dev, 0), request,
494 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
495 validx, idx, buf, val_len);
499 } else if (err == -ETIMEDOUT) {
503 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
504 request, validx, idx, cval->val_type, buf[0], buf[1]);
508 snd_usb_unlock_shutdown(chip);
512 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
513 int validx, int value)
515 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
518 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
519 int index, int value)
522 unsigned int read_only = (channel == 0) ?
523 cval->master_readonly :
524 cval->ch_readonly & (1 << (channel - 1));
527 usb_audio_dbg(cval->head.mixer->chip,
528 "%s(): channel %d of control %d is read_only\n",
529 __func__, channel, cval->control);
533 err = snd_usb_mixer_set_ctl_value(cval,
534 UAC_SET_CUR, (cval->control << 8) | channel,
538 cval->cached |= 1 << channel;
539 cval->cache_val[index] = value;
544 * TLV callback for mixer volume controls
546 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
547 unsigned int size, unsigned int __user *_tlv)
549 struct usb_mixer_elem_info *cval = kcontrol->private_data;
550 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
552 if (size < sizeof(scale))
555 scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE;
556 scale[2] = cval->dBmin;
557 scale[3] = cval->dBmax;
558 if (copy_to_user(_tlv, scale, sizeof(scale)))
564 * parser routines begin here...
567 static int parse_audio_unit(struct mixer_build *state, int unitid);
571 * check if the input/output channel routing is enabled on the given bitmap.
572 * used for mixer unit parser
574 static int check_matrix_bitmap(unsigned char *bmap,
575 int ich, int och, int num_outs)
577 int idx = ich * num_outs + och;
578 return bmap[idx >> 3] & (0x80 >> (idx & 7));
582 * add an alsa control element
583 * search and increment the index until an empty slot is found.
585 * if failed, give up and free the control instance.
588 int snd_usb_mixer_add_list(struct usb_mixer_elem_list *list,
589 struct snd_kcontrol *kctl,
592 struct usb_mixer_interface *mixer = list->mixer;
595 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
597 err = snd_ctl_add(mixer->chip->card, kctl);
599 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
604 list->is_std_info = is_std_info;
605 list->next_id_elem = mixer->id_elems[list->id];
606 mixer->id_elems[list->id] = list;
611 * get a terminal name string
614 static struct iterm_name_combo {
618 { 0x0300, "Output" },
619 { 0x0301, "Speaker" },
620 { 0x0302, "Headphone" },
621 { 0x0303, "HMD Audio" },
622 { 0x0304, "Desktop Speaker" },
623 { 0x0305, "Room Speaker" },
624 { 0x0306, "Com Speaker" },
626 { 0x0600, "External In" },
627 { 0x0601, "Analog In" },
628 { 0x0602, "Digital In" },
630 { 0x0604, "Legacy In" },
631 { 0x0605, "IEC958 In" },
632 { 0x0606, "1394 DA Stream" },
633 { 0x0607, "1394 DV Stream" },
634 { 0x0700, "Embedded" },
635 { 0x0701, "Noise Source" },
636 { 0x0702, "Equalization Noise" },
640 { 0x0706, "MiniDisk" },
641 { 0x0707, "Analog Tape" },
642 { 0x0708, "Phonograph" },
643 { 0x0709, "VCR Audio" },
644 { 0x070a, "Video Disk Audio" },
645 { 0x070b, "DVD Audio" },
646 { 0x070c, "TV Tuner Audio" },
647 { 0x070d, "Satellite Rec Audio" },
648 { 0x070e, "Cable Tuner Audio" },
649 { 0x070f, "DSS Audio" },
650 { 0x0710, "Radio Receiver" },
651 { 0x0711, "Radio Transmitter" },
652 { 0x0712, "Multi-Track Recorder" },
653 { 0x0713, "Synthesizer" },
657 static int get_term_name(struct snd_usb_audio *chip, struct usb_audio_term *iterm,
658 unsigned char *name, int maxlen, int term_only)
660 struct iterm_name_combo *names;
664 len = snd_usb_copy_string_desc(chip, iterm->name,
670 /* virtual type - not a real terminal */
671 if (iterm->type >> 16) {
674 switch (iterm->type >> 16) {
675 case UAC3_SELECTOR_UNIT:
676 strcpy(name, "Selector");
678 case UAC3_PROCESSING_UNIT:
679 strcpy(name, "Process Unit");
681 case UAC3_EXTENSION_UNIT:
682 strcpy(name, "Ext Unit");
684 case UAC3_MIXER_UNIT:
685 strcpy(name, "Mixer");
688 return sprintf(name, "Unit %d", iterm->id);
692 switch (iterm->type & 0xff00) {
700 strcpy(name, "Headset");
703 strcpy(name, "Phone");
707 for (names = iterm_names; names->type; names++) {
708 if (names->type == iterm->type) {
709 strcpy(name, names->name);
710 return strlen(names->name);
718 * Get logical cluster information for UAC3 devices.
720 static int get_cluster_channels_v3(struct mixer_build *state, unsigned int cluster_id)
722 struct uac3_cluster_header_descriptor c_header;
725 err = snd_usb_ctl_msg(state->chip->dev,
726 usb_rcvctrlpipe(state->chip->dev, 0),
727 UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
728 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
730 snd_usb_ctrl_intf(state->chip),
731 &c_header, sizeof(c_header));
734 if (err != sizeof(c_header)) {
739 return c_header.bNrChannels;
742 usb_audio_err(state->chip, "cannot request logical cluster ID: %d (err: %d)\n", cluster_id, err);
747 * Get number of channels for a Mixer Unit.
749 static int uac_mixer_unit_get_channels(struct mixer_build *state,
750 struct uac_mixer_unit_descriptor *desc)
754 switch (state->mixer->protocol) {
758 if (desc->bLength < sizeof(*desc) + desc->bNrInPins + 1)
759 return 0; /* no bmControls -> skip */
760 mu_channels = uac_mixer_unit_bNrChannels(desc);
763 mu_channels = get_cluster_channels_v3(state,
764 uac3_mixer_unit_wClusterDescrID(desc));
772 * Parse Input Terminal Unit
774 static int __check_input_term(struct mixer_build *state, int id,
775 struct usb_audio_term *term);
777 static int parse_term_uac1_iterm_unit(struct mixer_build *state,
778 struct usb_audio_term *term,
781 struct uac_input_terminal_descriptor *d = p1;
783 term->type = le16_to_cpu(d->wTerminalType);
784 term->channels = d->bNrChannels;
785 term->chconfig = le16_to_cpu(d->wChannelConfig);
786 term->name = d->iTerminal;
790 static int parse_term_uac2_iterm_unit(struct mixer_build *state,
791 struct usb_audio_term *term,
794 struct uac2_input_terminal_descriptor *d = p1;
797 /* call recursively to verify the referenced clock entity */
798 err = __check_input_term(state, d->bCSourceID, term);
802 /* save input term properties after recursion,
803 * to ensure they are not overriden by the recursion calls
806 term->type = le16_to_cpu(d->wTerminalType);
807 term->channels = d->bNrChannels;
808 term->chconfig = le32_to_cpu(d->bmChannelConfig);
809 term->name = d->iTerminal;
813 static int parse_term_uac3_iterm_unit(struct mixer_build *state,
814 struct usb_audio_term *term,
817 struct uac3_input_terminal_descriptor *d = p1;
820 /* call recursively to verify the referenced clock entity */
821 err = __check_input_term(state, d->bCSourceID, term);
825 /* save input term properties after recursion,
826 * to ensure they are not overriden by the recursion calls
829 term->type = le16_to_cpu(d->wTerminalType);
831 err = get_cluster_channels_v3(state, le16_to_cpu(d->wClusterDescrID));
834 term->channels = err;
836 /* REVISIT: UAC3 IT doesn't have channels cfg */
839 term->name = le16_to_cpu(d->wTerminalDescrStr);
843 static int parse_term_mixer_unit(struct mixer_build *state,
844 struct usb_audio_term *term,
847 struct uac_mixer_unit_descriptor *d = p1;
848 int protocol = state->mixer->protocol;
851 err = uac_mixer_unit_get_channels(state, d);
855 term->type = UAC3_MIXER_UNIT << 16; /* virtual type */
856 term->channels = err;
857 if (protocol != UAC_VERSION_3) {
858 term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
859 term->name = uac_mixer_unit_iMixer(d);
864 static int parse_term_selector_unit(struct mixer_build *state,
865 struct usb_audio_term *term,
868 struct uac_selector_unit_descriptor *d = p1;
871 /* call recursively to retrieve the channel info */
872 err = __check_input_term(state, d->baSourceID[0], term);
875 term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */
877 if (state->mixer->protocol != UAC_VERSION_3)
878 term->name = uac_selector_unit_iSelector(d);
882 static int parse_term_proc_unit(struct mixer_build *state,
883 struct usb_audio_term *term,
884 void *p1, int id, int vtype)
886 struct uac_processing_unit_descriptor *d = p1;
887 int protocol = state->mixer->protocol;
891 /* call recursively to retrieve the channel info */
892 err = __check_input_term(state, d->baSourceID[0], term);
897 term->type = vtype << 16; /* virtual type */
900 if (protocol == UAC_VERSION_3)
903 if (!term->channels) {
904 term->channels = uac_processing_unit_bNrChannels(d);
905 term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
907 term->name = uac_processing_unit_iProcessing(d, protocol);
911 static int parse_term_effect_unit(struct mixer_build *state,
912 struct usb_audio_term *term,
915 struct uac2_effect_unit_descriptor *d = p1;
918 err = __check_input_term(state, d->bSourceID, 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) {
1199 case USB_ID(0x1224, 0x2a25): /* Jieli Technology USB PHY 2.0 */
1200 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1201 usb_audio_info(chip,
1202 "set resolution quirk: cval->res = 16\n");
1209 /* forcibly initialize the current mixer value; if GET_CUR fails, set to
1210 * the minimum as default
1212 static void init_cur_mix_raw(struct usb_mixer_elem_info *cval, int ch, int idx)
1216 err = snd_usb_get_cur_mix_value(cval, ch, idx, &val);
1219 if (!cval->head.mixer->ignore_ctl_error)
1220 usb_audio_warn(cval->head.mixer->chip,
1221 "%d:%d: failed to get current value for ch %d (%d)\n",
1222 cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1224 snd_usb_set_cur_mix_value(cval, ch, idx, cval->min);
1228 * retrieve the minimum and maximum values for the specified control
1230 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1231 int default_min, struct snd_kcontrol *kctl)
1236 cval->min = default_min;
1237 cval->max = cval->min + 1;
1239 cval->dBmin = cval->dBmax = 0;
1241 if (cval->val_type == USB_MIXER_BOOLEAN ||
1242 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1243 cval->initialized = 1;
1247 for (i = 0; i < MAX_CHANNELS; i++)
1248 if (cval->cmask & (1 << i)) {
1253 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
1254 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1255 usb_audio_err(cval->head.mixer->chip,
1256 "%d:%d: cannot get min/max values for control %d (id %d)\n",
1257 cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1258 cval->control, cval->head.id);
1261 if (get_ctl_value(cval, UAC_GET_RES,
1262 (cval->control << 8) | minchn,
1265 } else if (cval->head.mixer->protocol == UAC_VERSION_1) {
1266 int last_valid_res = cval->res;
1268 while (cval->res > 1) {
1269 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1270 (cval->control << 8) | minchn,
1275 if (get_ctl_value(cval, UAC_GET_RES,
1276 (cval->control << 8) | minchn, &cval->res) < 0)
1277 cval->res = last_valid_res;
1282 /* Additional checks for the proper resolution
1284 * Some devices report smaller resolutions than actually
1285 * reacting. They don't return errors but simply clip
1286 * to the lower aligned value.
1288 if (cval->min + cval->res < cval->max) {
1289 int last_valid_res = cval->res;
1290 int saved, test, check;
1291 if (get_cur_mix_raw(cval, minchn, &saved) < 0)
1295 if (test < cval->max)
1299 if (test < cval->min || test > cval->max ||
1300 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1301 get_cur_mix_raw(cval, minchn, &check)) {
1302 cval->res = last_valid_res;
1309 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1313 cval->initialized = 1;
1317 volume_control_quirks(cval, kctl);
1319 /* USB descriptions contain the dB scale in 1/256 dB unit
1320 * while ALSA TLV contains in 1/100 dB unit
1322 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1323 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1324 if (cval->dBmin > cval->dBmax) {
1325 /* something is wrong; assume it's either from/to 0dB */
1326 if (cval->dBmin < 0)
1328 else if (cval->dBmin > 0)
1330 if (cval->dBmin > cval->dBmax) {
1331 /* totally crap, return an error */
1335 /* if the max volume is too low, it's likely a bogus range;
1336 * here we use -96dB as the threshold
1338 if (cval->dBmax <= -9600) {
1339 usb_audio_info(cval->head.mixer->chip,
1340 "%d:%d: bogus dB values (%d/%d), disabling dB reporting\n",
1341 cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1342 cval->dBmin, cval->dBmax);
1343 cval->dBmin = cval->dBmax = 0;
1347 /* initialize all elements */
1349 init_cur_mix_raw(cval, 0, 0);
1352 for (i = 0; i < MAX_CHANNELS; i++) {
1353 if (cval->cmask & (1 << i)) {
1354 init_cur_mix_raw(cval, i + 1, idx);
1363 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1365 /* get a feature/mixer unit info */
1366 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1367 struct snd_ctl_elem_info *uinfo)
1369 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1371 if (cval->val_type == USB_MIXER_BOOLEAN ||
1372 cval->val_type == USB_MIXER_INV_BOOLEAN)
1373 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1375 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1376 uinfo->count = cval->channels;
1377 if (cval->val_type == USB_MIXER_BOOLEAN ||
1378 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1379 uinfo->value.integer.min = 0;
1380 uinfo->value.integer.max = 1;
1382 if (!cval->initialized) {
1383 get_min_max_with_quirks(cval, 0, kcontrol);
1384 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1385 kcontrol->vd[0].access &=
1386 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1387 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1388 snd_ctl_notify(cval->head.mixer->chip->card,
1389 SNDRV_CTL_EVENT_MASK_INFO,
1393 uinfo->value.integer.min = 0;
1394 uinfo->value.integer.max =
1395 DIV_ROUND_UP(cval->max - cval->min, cval->res);
1400 /* get the current value from feature/mixer unit */
1401 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1402 struct snd_ctl_elem_value *ucontrol)
1404 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1405 int c, cnt, val, err;
1407 ucontrol->value.integer.value[0] = cval->min;
1410 for (c = 0; c < MAX_CHANNELS; c++) {
1411 if (!(cval->cmask & (1 << c)))
1413 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1415 return filter_error(cval, err);
1416 val = get_relative_value(cval, val);
1417 ucontrol->value.integer.value[cnt] = val;
1422 /* master channel */
1423 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1425 return filter_error(cval, err);
1426 val = get_relative_value(cval, val);
1427 ucontrol->value.integer.value[0] = val;
1432 /* put the current value to feature/mixer unit */
1433 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1434 struct snd_ctl_elem_value *ucontrol)
1436 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1437 int c, cnt, val, oval, err;
1442 for (c = 0; c < MAX_CHANNELS; c++) {
1443 if (!(cval->cmask & (1 << c)))
1445 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1447 return filter_error(cval, err);
1448 val = ucontrol->value.integer.value[cnt];
1449 val = get_abs_value(cval, val);
1451 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1457 /* master channel */
1458 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1460 return filter_error(cval, err);
1461 val = ucontrol->value.integer.value[0];
1462 val = get_abs_value(cval, val);
1464 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1471 /* get the boolean value from the master channel of a UAC control */
1472 static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
1473 struct snd_ctl_elem_value *ucontrol)
1475 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1478 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1480 return filter_error(cval, err);
1482 ucontrol->value.integer.value[0] = val;
1486 static int get_connector_value(struct usb_mixer_elem_info *cval,
1487 char *name, int *val)
1489 struct snd_usb_audio *chip = cval->head.mixer->chip;
1490 int idx = 0, validx, ret;
1492 validx = cval->control << 8 | 0;
1494 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
1498 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
1499 if (cval->head.mixer->protocol == UAC_VERSION_2) {
1500 struct uac2_connectors_ctl_blk uac2_conn;
1502 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1503 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1504 validx, idx, &uac2_conn, sizeof(uac2_conn));
1506 *val = !!uac2_conn.bNrChannels;
1507 } else { /* UAC_VERSION_3 */
1508 struct uac3_insertion_ctl_blk uac3_conn;
1510 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1511 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1512 validx, idx, &uac3_conn, sizeof(uac3_conn));
1514 *val = !!uac3_conn.bmConInserted;
1517 snd_usb_unlock_shutdown(chip);
1520 if (name && strstr(name, "Speaker")) {
1527 "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1528 UAC_GET_CUR, validx, idx, cval->val_type);
1529 return filter_error(cval, ret);
1535 /* get the connectors status and report it as boolean type */
1536 static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol,
1537 struct snd_ctl_elem_value *ucontrol)
1539 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1542 ret = get_connector_value(cval, kcontrol->id.name, &val);
1547 ucontrol->value.integer.value[0] = val;
1551 static const struct snd_kcontrol_new usb_feature_unit_ctl = {
1552 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1553 .name = "", /* will be filled later manually */
1554 .info = mixer_ctl_feature_info,
1555 .get = mixer_ctl_feature_get,
1556 .put = mixer_ctl_feature_put,
1559 /* the read-only variant */
1560 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1561 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1562 .name = "", /* will be filled later manually */
1563 .info = mixer_ctl_feature_info,
1564 .get = mixer_ctl_feature_get,
1569 * A control which shows the boolean value from reading a UAC control on
1570 * the master channel.
1572 static const struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1573 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1574 .name = "", /* will be filled later manually */
1575 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1576 .info = snd_ctl_boolean_mono_info,
1577 .get = mixer_ctl_master_bool_get,
1581 static const struct snd_kcontrol_new usb_connector_ctl_ro = {
1582 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1583 .name = "", /* will be filled later manually */
1584 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1585 .info = snd_ctl_boolean_mono_info,
1586 .get = mixer_ctl_connector_get,
1591 * This symbol is exported in order to allow the mixer quirks to
1592 * hook up to the standard feature unit control mechanism
1594 const struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1597 * build a feature control
1599 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1601 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1605 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1606 * rename it to "Headphone". We determine if something is a headphone
1607 * similar to how udev determines form factor.
1609 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1610 struct snd_card *card)
1612 static const char * const names_to_check[] = {
1613 "Headset", "headset", "Headphone", "headphone", NULL};
1614 const char * const *s;
1617 if (strcmp("Speaker", kctl->id.name))
1620 for (s = names_to_check; *s; s++)
1621 if (strstr(card->shortname, *s)) {
1629 strscpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1632 static const struct usb_feature_control_info *get_feature_control_info(int control)
1636 for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1637 if (audio_feature_info[i].control == control)
1638 return &audio_feature_info[i];
1643 static void __build_feature_ctl(struct usb_mixer_interface *mixer,
1644 const struct usbmix_name_map *imap,
1645 unsigned int ctl_mask, int control,
1646 struct usb_audio_term *iterm,
1647 struct usb_audio_term *oterm,
1648 int unitid, int nameid, int readonly_mask)
1650 const struct usb_feature_control_info *ctl_info;
1651 unsigned int len = 0;
1652 int mapped_name = 0;
1653 struct snd_kcontrol *kctl;
1654 struct usb_mixer_elem_info *cval;
1655 const struct usbmix_name_map *map;
1658 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1659 /* FIXME: not supported yet */
1663 map = find_map(imap, unitid, control);
1664 if (check_ignored_ctl(map))
1667 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1670 snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
1671 cval->control = control;
1672 cval->cmask = ctl_mask;
1674 ctl_info = get_feature_control_info(control);
1676 usb_mixer_elem_info_free(cval);
1679 if (mixer->protocol == UAC_VERSION_1)
1680 cval->val_type = ctl_info->type;
1681 else /* UAC_VERSION_2 */
1682 cval->val_type = ctl_info->type_uac2 >= 0 ?
1683 ctl_info->type_uac2 : ctl_info->type;
1685 if (ctl_mask == 0) {
1686 cval->channels = 1; /* master channel */
1687 cval->master_readonly = readonly_mask;
1690 for (i = 0; i < 16; i++)
1691 if (ctl_mask & (1 << i))
1694 cval->ch_readonly = readonly_mask;
1698 * If all channels in the mask are marked read-only, make the control
1699 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1700 * issue write commands to read-only channels.
1702 if (cval->channels == readonly_mask)
1703 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1705 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1708 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1709 usb_mixer_elem_info_free(cval);
1712 kctl->private_free = snd_usb_mixer_elem_free;
1714 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1715 mapped_name = len != 0;
1717 len = snd_usb_copy_string_desc(mixer->chip, nameid,
1718 kctl->id.name, sizeof(kctl->id.name));
1724 * determine the control name. the rule is:
1725 * - if a name id is given in descriptor, use it.
1726 * - if the connected input can be determined, then use the name
1728 * - if the connected output can be determined, use it.
1729 * - otherwise, anonymous name.
1733 len = get_term_name(mixer->chip, iterm,
1735 sizeof(kctl->id.name), 1);
1737 len = get_term_name(mixer->chip, oterm,
1739 sizeof(kctl->id.name), 1);
1741 snprintf(kctl->id.name, sizeof(kctl->id.name),
1742 "Feature %d", unitid);
1746 check_no_speaker_on_headset(kctl, mixer->chip->card);
1749 * determine the stream direction:
1750 * if the connected output is USB stream, then it's likely a
1751 * capture stream. otherwise it should be playback (hopefully :)
1753 if (!mapped_name && oterm && !(oterm->type >> 16)) {
1754 if ((oterm->type & 0xff00) == 0x0100)
1755 append_ctl_name(kctl, " Capture");
1757 append_ctl_name(kctl, " Playback");
1759 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1760 " Switch" : " Volume");
1764 strscpy(kctl->id.name, audio_feature_info[control-1].name,
1765 sizeof(kctl->id.name));
1769 /* get min/max values */
1770 get_min_max_with_quirks(cval, 0, kctl);
1772 /* skip a bogus volume range */
1773 if (cval->max <= cval->min) {
1774 usb_audio_dbg(mixer->chip,
1775 "[%d] FU [%s] skipped due to invalid volume\n",
1776 cval->head.id, kctl->id.name);
1777 snd_ctl_free_one(kctl);
1782 if (control == UAC_FU_VOLUME) {
1783 check_mapped_dB(map, cval);
1784 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1785 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1786 kctl->vd[0].access |=
1787 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1788 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1792 snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1794 range = (cval->max - cval->min) / cval->res;
1796 * Are there devices with volume range more than 255? I use a bit more
1797 * to be sure. 384 is a resolution magic number found on Logitech
1798 * devices. It will definitively catch all buggy Logitech devices.
1801 usb_audio_warn(mixer->chip,
1802 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1804 usb_audio_warn(mixer->chip,
1805 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1806 cval->head.id, kctl->id.name, cval->channels,
1807 cval->min, cval->max, cval->res);
1810 usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1811 cval->head.id, kctl->id.name, cval->channels,
1812 cval->min, cval->max, cval->res);
1813 snd_usb_mixer_add_control(&cval->head, kctl);
1816 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1817 unsigned int ctl_mask, int control,
1818 struct usb_audio_term *iterm, int unitid,
1821 struct uac_feature_unit_descriptor *desc = raw_desc;
1822 int nameid = uac_feature_unit_iFeature(desc);
1824 __build_feature_ctl(state->mixer, state->map, ctl_mask, control,
1825 iterm, &state->oterm, unitid, nameid, readonly_mask);
1828 static void build_feature_ctl_badd(struct usb_mixer_interface *mixer,
1829 unsigned int ctl_mask, int control, int unitid,
1830 const struct usbmix_name_map *badd_map)
1832 __build_feature_ctl(mixer, badd_map, ctl_mask, control,
1833 NULL, NULL, unitid, 0, 0);
1836 static void get_connector_control_name(struct usb_mixer_interface *mixer,
1837 struct usb_audio_term *term,
1838 bool is_input, char *name, int name_size)
1840 int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1843 strscpy(name, "Unknown", name_size);
1846 * sound/core/ctljack.c has a convention of naming jack controls
1847 * by ending in " Jack". Make it slightly more useful by
1848 * indicating Input or Output after the terminal name.
1851 strlcat(name, " - Input Jack", name_size);
1853 strlcat(name, " - Output Jack", name_size);
1856 /* get connector value to "wake up" the USB audio */
1857 static int connector_mixer_resume(struct usb_mixer_elem_list *list)
1859 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
1861 get_connector_value(cval, NULL, NULL);
1865 /* Build a mixer control for a UAC connector control (jack-detect) */
1866 static void build_connector_control(struct usb_mixer_interface *mixer,
1867 const struct usbmix_name_map *imap,
1868 struct usb_audio_term *term, bool is_input)
1870 struct snd_kcontrol *kctl;
1871 struct usb_mixer_elem_info *cval;
1872 const struct usbmix_name_map *map;
1874 map = find_map(imap, term->id, 0);
1875 if (check_ignored_ctl(map))
1878 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1881 snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1883 /* set up a specific resume callback */
1884 cval->head.resume = connector_mixer_resume;
1887 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1888 * number of channels connected.
1890 * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1891 * following byte(s) specifies which connectors are inserted.
1893 * This boolean ctl will simply report if any channels are connected
1896 if (mixer->protocol == UAC_VERSION_2)
1897 cval->control = UAC2_TE_CONNECTOR;
1898 else /* UAC_VERSION_3 */
1899 cval->control = UAC3_TE_INSERTION;
1901 cval->val_type = USB_MIXER_BOOLEAN;
1902 cval->channels = 1; /* report true if any channel is connected */
1905 kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1907 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1908 usb_mixer_elem_info_free(cval);
1912 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)))
1913 strlcat(kctl->id.name, " Jack", sizeof(kctl->id.name));
1915 get_connector_control_name(mixer, term, is_input, kctl->id.name,
1916 sizeof(kctl->id.name));
1917 kctl->private_free = snd_usb_mixer_elem_free;
1918 snd_usb_mixer_add_control(&cval->head, kctl);
1921 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1924 struct uac_clock_source_descriptor *hdr = _ftr;
1925 struct usb_mixer_elem_info *cval;
1926 struct snd_kcontrol *kctl;
1927 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1930 if (state->mixer->protocol != UAC_VERSION_2)
1934 * The only property of this unit we are interested in is the
1935 * clock source validity. If that isn't readable, just bail out.
1937 if (!uac_v2v3_control_is_readable(hdr->bmControls,
1938 UAC2_CS_CONTROL_CLOCK_VALID))
1941 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1945 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1950 cval->val_type = USB_MIXER_BOOLEAN;
1951 cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1953 cval->master_readonly = 1;
1954 /* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1955 kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1958 usb_mixer_elem_info_free(cval);
1962 kctl->private_free = snd_usb_mixer_elem_free;
1963 ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1964 name, sizeof(name));
1966 snprintf(kctl->id.name, sizeof(kctl->id.name),
1967 "%s Validity", name);
1969 snprintf(kctl->id.name, sizeof(kctl->id.name),
1970 "Clock Source %d Validity", hdr->bClockID);
1972 return snd_usb_mixer_add_control(&cval->head, kctl);
1976 * parse a feature unit
1978 * most of controls are defined here.
1980 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1984 struct usb_audio_term iterm;
1985 unsigned int master_bits;
1987 struct uac_feature_unit_descriptor *hdr = _ftr;
1990 if (state->mixer->protocol == UAC_VERSION_1) {
1991 csize = hdr->bControlSize;
1992 channels = (hdr->bLength - 7) / csize - 1;
1993 bmaControls = hdr->bmaControls;
1994 } else if (state->mixer->protocol == UAC_VERSION_2) {
1995 struct uac2_feature_unit_descriptor *ftr = _ftr;
1997 channels = (hdr->bLength - 6) / 4 - 1;
1998 bmaControls = ftr->bmaControls;
1999 } else { /* UAC_VERSION_3 */
2000 struct uac3_feature_unit_descriptor *ftr = _ftr;
2003 channels = (ftr->bLength - 7) / 4 - 1;
2004 bmaControls = ftr->bmaControls;
2007 /* parse the source unit */
2008 err = parse_audio_unit(state, hdr->bSourceID);
2012 /* determine the input source type and name */
2013 err = check_input_term(state, hdr->bSourceID, &iterm);
2017 master_bits = snd_usb_combine_bytes(bmaControls, csize);
2018 /* master configuration quirks */
2019 switch (state->chip->usb_id) {
2020 case USB_ID(0x08bb, 0x2702):
2021 usb_audio_info(state->chip,
2022 "usbmixer: master volume quirk for PCM2702 chip\n");
2023 /* disable non-functional volume control */
2024 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
2026 case USB_ID(0x1130, 0xf211):
2027 usb_audio_info(state->chip,
2028 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
2029 /* disable non-functional volume control */
2035 if (state->mixer->protocol == UAC_VERSION_1) {
2036 /* check all control types */
2037 for (i = 0; i < 10; i++) {
2038 unsigned int ch_bits = 0;
2039 int control = audio_feature_info[i].control;
2041 for (j = 0; j < channels; j++) {
2044 mask = snd_usb_combine_bytes(bmaControls +
2045 csize * (j+1), csize);
2046 if (mask & (1 << i))
2047 ch_bits |= (1 << j);
2049 /* audio class v1 controls are never read-only */
2052 * The first channel must be set
2053 * (for ease of programming).
2056 build_feature_ctl(state, _ftr, ch_bits, control,
2058 if (master_bits & (1 << i))
2059 build_feature_ctl(state, _ftr, 0, control,
2062 } else { /* UAC_VERSION_2/3 */
2063 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
2064 unsigned int ch_bits = 0;
2065 unsigned int ch_read_only = 0;
2066 int control = audio_feature_info[i].control;
2068 for (j = 0; j < channels; j++) {
2071 mask = snd_usb_combine_bytes(bmaControls +
2072 csize * (j+1), csize);
2073 if (uac_v2v3_control_is_readable(mask, control)) {
2074 ch_bits |= (1 << j);
2075 if (!uac_v2v3_control_is_writeable(mask, control))
2076 ch_read_only |= (1 << j);
2081 * NOTE: build_feature_ctl() will mark the control
2082 * read-only if all channels are marked read-only in
2083 * the descriptors. Otherwise, the control will be
2084 * reported as writeable, but the driver will not
2085 * actually issue a write command for read-only
2090 * The first channel must be set
2091 * (for ease of programming).
2094 build_feature_ctl(state, _ftr, ch_bits, control,
2095 &iterm, unitid, ch_read_only);
2096 if (uac_v2v3_control_is_readable(master_bits, control))
2097 build_feature_ctl(state, _ftr, 0, control,
2099 !uac_v2v3_control_is_writeable(master_bits,
2111 /* check whether the given in/out overflows bmMixerControls matrix */
2112 static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc,
2113 int protocol, int num_ins, int num_outs)
2115 u8 *hdr = (u8 *)desc;
2116 u8 *c = uac_mixer_unit_bmControls(desc, protocol);
2117 size_t rest; /* remaining bytes after bmMixerControls */
2122 rest = 1; /* iMixer */
2125 rest = 2; /* bmControls + iMixer */
2128 rest = 6; /* bmControls + wMixerDescrStr */
2133 return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
2137 * build a mixer unit control
2139 * the callbacks are identical with feature unit.
2140 * input channel number (zero based) is given in control field instead.
2142 static void build_mixer_unit_ctl(struct mixer_build *state,
2143 struct uac_mixer_unit_descriptor *desc,
2144 int in_pin, int in_ch, int num_outs,
2145 int unitid, struct usb_audio_term *iterm)
2147 struct usb_mixer_elem_info *cval;
2148 unsigned int i, len;
2149 struct snd_kcontrol *kctl;
2150 const struct usbmix_name_map *map;
2152 map = find_map(state->map, unitid, 0);
2153 if (check_ignored_ctl(map))
2156 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2160 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2161 cval->control = in_ch + 1; /* based on 1 */
2162 cval->val_type = USB_MIXER_S16;
2163 for (i = 0; i < num_outs; i++) {
2164 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
2166 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
2167 cval->cmask |= (1 << i);
2172 /* get min/max values */
2173 get_min_max(cval, 0);
2175 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2177 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2178 usb_mixer_elem_info_free(cval);
2181 kctl->private_free = snd_usb_mixer_elem_free;
2183 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2185 len = get_term_name(state->chip, iterm, kctl->id.name,
2186 sizeof(kctl->id.name), 0);
2188 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
2189 append_ctl_name(kctl, " Volume");
2191 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2192 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
2193 snd_usb_mixer_add_control(&cval->head, kctl);
2196 static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
2199 struct usb_audio_term iterm;
2200 unsigned int control, bmctls, term_id;
2202 if (state->mixer->protocol == UAC_VERSION_2) {
2203 struct uac2_input_terminal_descriptor *d_v2 = raw_desc;
2204 control = UAC2_TE_CONNECTOR;
2205 term_id = d_v2->bTerminalID;
2206 bmctls = le16_to_cpu(d_v2->bmControls);
2207 } else if (state->mixer->protocol == UAC_VERSION_3) {
2208 struct uac3_input_terminal_descriptor *d_v3 = raw_desc;
2209 control = UAC3_TE_INSERTION;
2210 term_id = d_v3->bTerminalID;
2211 bmctls = le32_to_cpu(d_v3->bmControls);
2213 return 0; /* UAC1. No Insertion control */
2216 check_input_term(state, term_id, &iterm);
2218 /* Check for jack detection. */
2219 if ((iterm.type & 0xff00) != 0x0100 &&
2220 uac_v2v3_control_is_readable(bmctls, control))
2221 build_connector_control(state->mixer, state->map, &iterm, true);
2227 * parse a mixer unit
2229 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
2232 struct uac_mixer_unit_descriptor *desc = raw_desc;
2233 struct usb_audio_term iterm;
2234 int input_pins, num_ins, num_outs;
2237 err = uac_mixer_unit_get_channels(state, desc);
2239 usb_audio_err(state->chip,
2240 "invalid MIXER UNIT descriptor %d\n",
2246 input_pins = desc->bNrInPins;
2250 for (pin = 0; pin < input_pins; pin++) {
2251 err = parse_audio_unit(state, desc->baSourceID[pin]);
2254 /* no bmControls field (e.g. Maya44) -> ignore */
2257 err = check_input_term(state, desc->baSourceID[pin], &iterm);
2260 num_ins += iterm.channels;
2261 if (mixer_bitmap_overflow(desc, state->mixer->protocol,
2264 for (; ich < num_ins; ich++) {
2265 int och, ich_has_controls = 0;
2267 for (och = 0; och < num_outs; och++) {
2268 __u8 *c = uac_mixer_unit_bmControls(desc,
2269 state->mixer->protocol);
2271 if (check_matrix_bitmap(c, ich, och, num_outs)) {
2272 ich_has_controls = 1;
2276 if (ich_has_controls)
2277 build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
2285 * Processing Unit / Extension Unit
2288 /* get callback for processing/extension unit */
2289 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
2290 struct snd_ctl_elem_value *ucontrol)
2292 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2295 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2297 ucontrol->value.integer.value[0] = cval->min;
2298 return filter_error(cval, err);
2300 val = get_relative_value(cval, val);
2301 ucontrol->value.integer.value[0] = val;
2305 /* put callback for processing/extension unit */
2306 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
2307 struct snd_ctl_elem_value *ucontrol)
2309 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2312 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2314 return filter_error(cval, err);
2315 val = ucontrol->value.integer.value[0];
2316 val = get_abs_value(cval, val);
2318 set_cur_ctl_value(cval, cval->control << 8, val);
2324 /* alsa control interface for processing/extension unit */
2325 static const struct snd_kcontrol_new mixer_procunit_ctl = {
2326 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2327 .name = "", /* will be filled later */
2328 .info = mixer_ctl_feature_info,
2329 .get = mixer_ctl_procunit_get,
2330 .put = mixer_ctl_procunit_put,
2334 * predefined data for processing units
2336 struct procunit_value_info {
2343 struct procunit_info {
2346 const struct procunit_value_info *values;
2349 static const struct procunit_value_info undefined_proc_info[] = {
2350 { 0x00, "Control Undefined", 0 },
2354 static const struct procunit_value_info updown_proc_info[] = {
2355 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2356 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2359 static const struct procunit_value_info prologic_proc_info[] = {
2360 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2361 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2364 static const struct procunit_value_info threed_enh_proc_info[] = {
2365 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2366 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2369 static const struct procunit_value_info reverb_proc_info[] = {
2370 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2371 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2372 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2373 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2376 static const struct procunit_value_info chorus_proc_info[] = {
2377 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2378 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2379 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2380 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2383 static const struct procunit_value_info dcr_proc_info[] = {
2384 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2385 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2386 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2387 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2388 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2389 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2393 static const struct procunit_info procunits[] = {
2394 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2395 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2396 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2397 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2398 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2399 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2403 static const struct procunit_value_info uac3_updown_proc_info[] = {
2404 { UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2407 static const struct procunit_value_info uac3_stereo_ext_proc_info[] = {
2408 { UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
2412 static const struct procunit_info uac3_procunits[] = {
2413 { UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info },
2414 { UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info },
2415 { UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info },
2420 * predefined data for extension units
2422 static const struct procunit_value_info clock_rate_xu_info[] = {
2423 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2426 static const struct procunit_value_info clock_source_xu_info[] = {
2427 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2430 static const struct procunit_value_info spdif_format_xu_info[] = {
2431 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2434 static const struct procunit_value_info soft_limit_xu_info[] = {
2435 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2438 static const struct procunit_info extunits[] = {
2439 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2440 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2441 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2442 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2447 * build a processing/extension unit
2449 static int build_audio_procunit(struct mixer_build *state, int unitid,
2450 void *raw_desc, const struct procunit_info *list,
2451 bool extension_unit)
2453 struct uac_processing_unit_descriptor *desc = raw_desc;
2455 struct usb_mixer_elem_info *cval;
2456 struct snd_kcontrol *kctl;
2457 int i, err, nameid, type, len, val;
2458 const struct procunit_info *info;
2459 const struct procunit_value_info *valinfo;
2460 const struct usbmix_name_map *map;
2461 static const struct procunit_value_info default_value_info[] = {
2462 { 0x01, "Switch", USB_MIXER_BOOLEAN },
2465 static const struct procunit_info default_info = {
2466 0, NULL, default_value_info
2468 const char *name = extension_unit ?
2469 "Extension Unit" : "Processing Unit";
2471 num_ins = desc->bNrInPins;
2472 for (i = 0; i < num_ins; i++) {
2473 err = parse_audio_unit(state, desc->baSourceID[i]);
2478 type = le16_to_cpu(desc->wProcessType);
2479 for (info = list; info && info->type; info++)
2480 if (info->type == type)
2482 if (!info || !info->type)
2483 info = &default_info;
2485 for (valinfo = info->values; valinfo->control; valinfo++) {
2486 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2488 if (state->mixer->protocol == UAC_VERSION_1) {
2489 if (!(controls[valinfo->control / 8] &
2490 (1 << ((valinfo->control % 8) - 1))))
2492 } else { /* UAC_VERSION_2/3 */
2493 if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
2498 map = find_map(state->map, unitid, valinfo->control);
2499 if (check_ignored_ctl(map))
2501 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2504 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2505 cval->control = valinfo->control;
2506 cval->val_type = valinfo->val_type;
2509 if (state->mixer->protocol > UAC_VERSION_1 &&
2510 !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
2512 cval->master_readonly = 1;
2514 /* get min/max values */
2516 case UAC_PROCESS_UP_DOWNMIX: {
2517 bool mode_sel = false;
2519 switch (state->mixer->protocol) {
2523 if (cval->control == UAC_UD_MODE_SELECT)
2527 if (cval->control == UAC3_UD_MODE_SELECT)
2533 __u8 *control_spec = uac_processing_unit_specific(desc,
2534 state->mixer->protocol);
2536 cval->max = control_spec[0];
2538 cval->initialized = 1;
2542 get_min_max(cval, valinfo->min_value);
2545 case USB_XU_CLOCK_RATE:
2547 * E-Mu USB 0404/0202/TrackerPre/0204
2548 * samplerate control quirk
2553 cval->initialized = 1;
2556 get_min_max(cval, valinfo->min_value);
2560 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2562 usb_mixer_elem_info_free(cval);
2566 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2568 usb_mixer_elem_info_free(cval);
2571 kctl->private_free = snd_usb_mixer_elem_free;
2573 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2575 } else if (info->name) {
2576 strscpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2579 nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
2581 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2584 len = snd_usb_copy_string_desc(state->chip,
2587 sizeof(kctl->id.name));
2589 strscpy(kctl->id.name, name, sizeof(kctl->id.name));
2591 append_ctl_name(kctl, " ");
2592 append_ctl_name(kctl, valinfo->suffix);
2594 usb_audio_dbg(state->chip,
2595 "[%d] PU [%s] ch = %d, val = %d/%d\n",
2596 cval->head.id, kctl->id.name, cval->channels,
2597 cval->min, cval->max);
2599 err = snd_usb_mixer_add_control(&cval->head, kctl);
2606 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2609 switch (state->mixer->protocol) {
2613 return build_audio_procunit(state, unitid, raw_desc,
2616 return build_audio_procunit(state, unitid, raw_desc,
2617 uac3_procunits, false);
2621 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2625 * Note that we parse extension units with processing unit descriptors.
2626 * That's ok as the layout is the same.
2628 return build_audio_procunit(state, unitid, raw_desc, extunits, true);
2636 * info callback for selector unit
2637 * use an enumerator type for routing
2639 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2640 struct snd_ctl_elem_info *uinfo)
2642 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2643 const char **itemlist = (const char **)kcontrol->private_value;
2645 if (snd_BUG_ON(!itemlist))
2647 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2650 /* get callback for selector unit */
2651 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2652 struct snd_ctl_elem_value *ucontrol)
2654 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2657 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2659 ucontrol->value.enumerated.item[0] = 0;
2660 return filter_error(cval, err);
2662 val = get_relative_value(cval, val);
2663 ucontrol->value.enumerated.item[0] = val;
2667 /* put callback for selector unit */
2668 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2669 struct snd_ctl_elem_value *ucontrol)
2671 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2674 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2676 return filter_error(cval, err);
2677 val = ucontrol->value.enumerated.item[0];
2678 val = get_abs_value(cval, val);
2680 set_cur_ctl_value(cval, cval->control << 8, val);
2686 /* alsa control interface for selector unit */
2687 static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2688 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2689 .name = "", /* will be filled later */
2690 .info = mixer_ctl_selector_info,
2691 .get = mixer_ctl_selector_get,
2692 .put = mixer_ctl_selector_put,
2696 * private free callback.
2697 * free both private_data and private_value
2699 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2703 if (kctl->private_data) {
2704 struct usb_mixer_elem_info *cval = kctl->private_data;
2705 num_ins = cval->max;
2706 usb_mixer_elem_info_free(cval);
2707 kctl->private_data = NULL;
2709 if (kctl->private_value) {
2710 char **itemlist = (char **)kctl->private_value;
2711 for (i = 0; i < num_ins; i++)
2714 kctl->private_value = 0;
2719 * parse a selector unit
2721 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2724 struct uac_selector_unit_descriptor *desc = raw_desc;
2725 unsigned int i, nameid, len;
2727 struct usb_mixer_elem_info *cval;
2728 struct snd_kcontrol *kctl;
2729 const struct usbmix_name_map *map;
2732 for (i = 0; i < desc->bNrInPins; i++) {
2733 err = parse_audio_unit(state, desc->baSourceID[i]);
2738 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2741 map = find_map(state->map, unitid, 0);
2742 if (check_ignored_ctl(map))
2745 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2748 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2749 cval->val_type = USB_MIXER_U8;
2752 cval->max = desc->bNrInPins;
2754 cval->initialized = 1;
2756 switch (state->mixer->protocol) {
2763 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2764 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2765 cval->control = UAC2_CX_CLOCK_SELECTOR;
2766 else /* UAC2/3_SELECTOR_UNIT */
2767 cval->control = UAC2_SU_SELECTOR;
2771 namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2776 #define MAX_ITEM_NAME_LEN 64
2777 for (i = 0; i < desc->bNrInPins; i++) {
2778 struct usb_audio_term iterm;
2779 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2784 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2786 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2787 len = get_term_name(state->chip, &iterm, namelist[i],
2788 MAX_ITEM_NAME_LEN, 0);
2790 sprintf(namelist[i], "Input %u", i);
2793 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2795 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2799 kctl->private_value = (unsigned long)namelist;
2800 kctl->private_free = usb_mixer_selector_elem_free;
2802 /* check the static mapping table at first */
2803 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2806 switch (state->mixer->protocol) {
2810 /* if iSelector is given, use it */
2811 nameid = uac_selector_unit_iSelector(desc);
2813 len = snd_usb_copy_string_desc(state->chip,
2814 nameid, kctl->id.name,
2815 sizeof(kctl->id.name));
2818 /* TODO: Class-Specific strings not yet supported */
2822 /* ... or pick up the terminal name at next */
2824 len = get_term_name(state->chip, &state->oterm,
2825 kctl->id.name, sizeof(kctl->id.name), 0);
2826 /* ... or use the fixed string "USB" as the last resort */
2828 strscpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2830 /* and add the proper suffix */
2831 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2832 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2833 append_ctl_name(kctl, " Clock Source");
2834 else if ((state->oterm.type & 0xff00) == 0x0100)
2835 append_ctl_name(kctl, " Capture Source");
2837 append_ctl_name(kctl, " Playback Source");
2840 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2841 cval->head.id, kctl->id.name, desc->bNrInPins);
2842 return snd_usb_mixer_add_control(&cval->head, kctl);
2845 for (i = 0; i < desc->bNrInPins; i++)
2849 usb_mixer_elem_info_free(cval);
2854 * parse an audio unit recursively
2857 static int parse_audio_unit(struct mixer_build *state, int unitid)
2860 int protocol = state->mixer->protocol;
2862 if (test_and_set_bit(unitid, state->unitbitmap))
2863 return 0; /* the unit already visited */
2865 p1 = find_audio_control_unit(state, unitid);
2867 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2871 if (!snd_usb_validate_audio_desc(p1, protocol)) {
2872 usb_audio_dbg(state->chip, "invalid unit %d\n", unitid);
2873 return 0; /* skip invalid unit */
2876 switch (PTYPE(protocol, p1[2])) {
2877 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
2878 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
2879 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
2880 return parse_audio_input_terminal(state, unitid, p1);
2881 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
2882 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
2883 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
2884 return parse_audio_mixer_unit(state, unitid, p1);
2885 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
2886 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
2887 return parse_clock_source_unit(state, unitid, p1);
2888 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
2889 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
2890 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
2891 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
2892 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
2893 return parse_audio_selector_unit(state, unitid, p1);
2894 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
2895 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
2896 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT):
2897 return parse_audio_feature_unit(state, unitid, p1);
2898 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
2899 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
2900 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
2901 return parse_audio_processing_unit(state, unitid, p1);
2902 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
2903 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
2904 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
2905 return parse_audio_extension_unit(state, unitid, p1);
2906 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
2907 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
2908 return 0; /* FIXME - effect units not implemented yet */
2910 usb_audio_err(state->chip,
2911 "unit %u: unexpected type 0x%02x\n",
2917 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2919 /* kill pending URBs */
2920 snd_usb_mixer_disconnect(mixer);
2922 kfree(mixer->id_elems);
2924 kfree(mixer->urb->transfer_buffer);
2925 usb_free_urb(mixer->urb);
2927 usb_free_urb(mixer->rc_urb);
2928 kfree(mixer->rc_setup_packet);
2932 static int snd_usb_mixer_dev_free(struct snd_device *device)
2934 struct usb_mixer_interface *mixer = device->device_data;
2935 snd_usb_mixer_free(mixer);
2939 /* UAC3 predefined channels configuration */
2940 struct uac3_badd_profile {
2943 int c_chmask; /* capture channels mask */
2944 int p_chmask; /* playback channels mask */
2945 int st_chmask; /* side tone mixing channel mask */
2948 static const struct uac3_badd_profile uac3_badd_profiles[] = {
2951 * BAIF, BAOF or combination of both
2952 * IN: Mono or Stereo cfg, Mono alt possible
2953 * OUT: Mono or Stereo cfg, Mono alt possible
2955 .subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
2956 .name = "GENERIC IO",
2957 .c_chmask = -1, /* dynamic channels */
2958 .p_chmask = -1, /* dynamic channels */
2961 /* BAOF; Stereo only cfg, Mono alt possible */
2962 .subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
2963 .name = "HEADPHONE",
2967 /* BAOF; Mono or Stereo cfg, Mono alt possible */
2968 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
2970 .p_chmask = -1, /* dynamic channels */
2973 /* BAIF; Mono or Stereo cfg, Mono alt possible */
2974 .subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
2975 .name = "MICROPHONE",
2976 .c_chmask = -1, /* dynamic channels */
2982 * OUT: Mono or Stereo cfg, Mono alt possible
2984 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
2987 .p_chmask = -1, /* dynamic channels */
2991 /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
2992 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
2993 .name = "HEADSET ADAPTER",
2999 /* BAIF + BAOF; IN: Mono only; OUT: Mono only */
3000 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
3001 .name = "SPEAKERPHONE",
3005 { 0 } /* terminator */
3008 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
3009 const struct uac3_badd_profile *f,
3010 int c_chmask, int p_chmask)
3013 * If both playback/capture channels are dynamic, make sure
3014 * at least one channel is present
3016 if (f->c_chmask < 0 && f->p_chmask < 0) {
3017 if (!c_chmask && !p_chmask) {
3018 usb_audio_warn(mixer->chip, "BAAD %s: no channels?",
3025 if ((f->c_chmask < 0 && !c_chmask) ||
3026 (f->c_chmask >= 0 && f->c_chmask != c_chmask)) {
3027 usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch",
3031 if ((f->p_chmask < 0 && !p_chmask) ||
3032 (f->p_chmask >= 0 && f->p_chmask != p_chmask)) {
3033 usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch",
3041 * create mixer controls for UAC3 BADD profiles
3043 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
3045 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
3047 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
3050 struct usb_device *dev = mixer->chip->dev;
3051 struct usb_interface_assoc_descriptor *assoc;
3052 int badd_profile = mixer->chip->badd_profile;
3053 const struct uac3_badd_profile *f;
3054 const struct usbmix_ctl_map *map;
3055 int p_chmask = 0, c_chmask = 0, st_chmask = 0;
3058 assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
3060 /* Detect BADD capture/playback channels from AS EP descriptors */
3061 for (i = 0; i < assoc->bInterfaceCount; i++) {
3062 int intf = assoc->bFirstInterface + i;
3064 struct usb_interface *iface;
3065 struct usb_host_interface *alts;
3066 struct usb_interface_descriptor *altsd;
3067 unsigned int maxpacksize;
3074 iface = usb_ifnum_to_if(dev, intf);
3078 num = iface->num_altsetting;
3084 * The number of Channels in an AudioStreaming interface
3085 * and the audio sample bit resolution (16 bits or 24
3086 * bits) can be derived from the wMaxPacketSize field in
3087 * the Standard AS Audio Data Endpoint descriptor in
3088 * Alternate Setting 1
3090 alts = &iface->altsetting[1];
3091 altsd = get_iface_desc(alts);
3093 if (altsd->bNumEndpoints < 1)
3096 /* check direction */
3097 dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
3098 maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3100 switch (maxpacksize) {
3102 usb_audio_err(mixer->chip,
3103 "incorrect wMaxPacketSize 0x%x for BADD profile\n",
3106 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
3107 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
3108 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
3109 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
3112 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
3113 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
3114 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
3115 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
3126 usb_audio_dbg(mixer->chip,
3127 "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
3128 badd_profile, c_chmask, p_chmask);
3130 /* check the mapping table */
3131 for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
3132 if (map->id == badd_profile)
3139 for (f = uac3_badd_profiles; f->name; f++) {
3140 if (badd_profile == f->subclass)
3145 if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
3147 st_chmask = f->st_chmask;
3151 /* Master channel, always writable */
3152 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3153 UAC3_BADD_FU_ID2, map->map);
3154 /* Mono/Stereo volume channels, always writable */
3155 build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
3156 UAC3_BADD_FU_ID2, map->map);
3161 /* Master channel, always writable */
3162 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3163 UAC3_BADD_FU_ID5, map->map);
3164 /* Mono/Stereo volume channels, always writable */
3165 build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
3166 UAC3_BADD_FU_ID5, map->map);
3169 /* Side tone-mixing */
3171 /* Master channel, always writable */
3172 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3173 UAC3_BADD_FU_ID7, map->map);
3174 /* Mono volume channel, always writable */
3175 build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
3176 UAC3_BADD_FU_ID7, map->map);
3179 /* Insertion Control */
3180 if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
3181 struct usb_audio_term iterm, oterm;
3183 /* Input Term - Insertion control */
3184 memset(&iterm, 0, sizeof(iterm));
3185 iterm.id = UAC3_BADD_IT_ID4;
3186 iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3187 build_connector_control(mixer, map->map, &iterm, true);
3189 /* Output Term - Insertion control */
3190 memset(&oterm, 0, sizeof(oterm));
3191 oterm.id = UAC3_BADD_OT_ID3;
3192 oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3193 build_connector_control(mixer, map->map, &oterm, false);
3200 * create mixer controls
3202 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3204 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
3206 struct mixer_build state;
3208 const struct usbmix_ctl_map *map;
3211 memset(&state, 0, sizeof(state));
3212 state.chip = mixer->chip;
3213 state.mixer = mixer;
3214 state.buffer = mixer->hostif->extra;
3215 state.buflen = mixer->hostif->extralen;
3217 /* check the mapping table */
3218 for (map = usbmix_ctl_maps; map->id; map++) {
3219 if (map->id == state.chip->usb_id) {
3220 state.map = map->map;
3221 state.selector_map = map->selector_map;
3222 mixer->connector_map = map->connector_map;
3228 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
3229 mixer->hostif->extralen,
3230 p, UAC_OUTPUT_TERMINAL)) != NULL) {
3231 if (!snd_usb_validate_audio_desc(p, mixer->protocol))
3232 continue; /* skip invalid descriptor */
3234 if (mixer->protocol == UAC_VERSION_1) {
3235 struct uac1_output_terminal_descriptor *desc = p;
3237 /* mark terminal ID as visited */
3238 set_bit(desc->bTerminalID, state.unitbitmap);
3239 state.oterm.id = desc->bTerminalID;
3240 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3241 state.oterm.name = desc->iTerminal;
3242 err = parse_audio_unit(&state, desc->bSourceID);
3243 if (err < 0 && err != -EINVAL)
3245 } else if (mixer->protocol == UAC_VERSION_2) {
3246 struct uac2_output_terminal_descriptor *desc = p;
3248 /* mark terminal ID as visited */
3249 set_bit(desc->bTerminalID, state.unitbitmap);
3250 state.oterm.id = desc->bTerminalID;
3251 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3252 state.oterm.name = desc->iTerminal;
3253 err = parse_audio_unit(&state, desc->bSourceID);
3254 if (err < 0 && err != -EINVAL)
3258 * For UAC2, use the same approach to also add the
3261 err = parse_audio_unit(&state, desc->bCSourceID);
3262 if (err < 0 && err != -EINVAL)
3265 if ((state.oterm.type & 0xff00) != 0x0100 &&
3266 uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3267 UAC2_TE_CONNECTOR)) {
3268 build_connector_control(state.mixer, state.map,
3269 &state.oterm, false);
3271 } else { /* UAC_VERSION_3 */
3272 struct uac3_output_terminal_descriptor *desc = p;
3274 /* mark terminal ID as visited */
3275 set_bit(desc->bTerminalID, state.unitbitmap);
3276 state.oterm.id = desc->bTerminalID;
3277 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3278 state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
3279 err = parse_audio_unit(&state, desc->bSourceID);
3280 if (err < 0 && err != -EINVAL)
3284 * For UAC3, use the same approach to also add the
3287 err = parse_audio_unit(&state, desc->bCSourceID);
3288 if (err < 0 && err != -EINVAL)
3291 if ((state.oterm.type & 0xff00) != 0x0100 &&
3292 uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
3293 UAC3_TE_INSERTION)) {
3294 build_connector_control(state.mixer, state.map,
3295 &state.oterm, false);
3303 static int delegate_notify(struct usb_mixer_interface *mixer, int unitid,
3304 u8 *control, u8 *channel)
3306 const struct usbmix_connector_map *map = mixer->connector_map;
3311 for (; map->id; map++) {
3312 if (map->id == unitid) {
3313 if (control && map->control)
3314 *control = map->control;
3315 if (channel && map->channel)
3316 *channel = map->channel;
3317 return map->delegated_id;
3323 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3325 struct usb_mixer_elem_list *list;
3327 unitid = delegate_notify(mixer, unitid, NULL, NULL);
3329 for_each_mixer_elem(list, mixer, unitid) {
3330 struct usb_mixer_elem_info *info;
3332 if (!list->is_std_info)
3334 info = mixer_elem_list_to_info(list);
3335 /* invalidate cache, so the value is read from the device */
3337 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3342 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3343 struct usb_mixer_elem_list *list)
3345 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3346 static const char * const val_types[] = {
3347 [USB_MIXER_BOOLEAN] = "BOOLEAN",
3348 [USB_MIXER_INV_BOOLEAN] = "INV_BOOLEAN",
3349 [USB_MIXER_S8] = "S8",
3350 [USB_MIXER_U8] = "U8",
3351 [USB_MIXER_S16] = "S16",
3352 [USB_MIXER_U16] = "U16",
3353 [USB_MIXER_S32] = "S32",
3354 [USB_MIXER_U32] = "U32",
3355 [USB_MIXER_BESPOKEN] = "BESPOKEN",
3357 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
3358 "channels=%i, type=\"%s\"\n", cval->head.id,
3359 cval->control, cval->cmask, cval->channels,
3360 val_types[cval->val_type]);
3361 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3362 cval->min, cval->max, cval->dBmin, cval->dBmax);
3365 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
3366 struct snd_info_buffer *buffer)
3368 struct snd_usb_audio *chip = entry->private_data;
3369 struct usb_mixer_interface *mixer;
3370 struct usb_mixer_elem_list *list;
3373 list_for_each_entry(mixer, &chip->mixer_list, list) {
3375 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3376 chip->usb_id, mixer_ctrl_intf(mixer),
3377 mixer->ignore_ctl_error);
3378 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
3379 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3380 for_each_mixer_elem(list, mixer, unitid) {
3381 snd_iprintf(buffer, " Unit: %i\n", list->id);
3384 " Control: name=\"%s\", index=%i\n",
3385 list->kctl->id.name,
3386 list->kctl->id.index);
3388 list->dump(buffer, list);
3394 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
3395 int attribute, int value, int index)
3397 struct usb_mixer_elem_list *list;
3398 __u8 unitid = (index >> 8) & 0xff;
3399 __u8 control = (value >> 8) & 0xff;
3400 __u8 channel = value & 0xff;
3401 unsigned int count = 0;
3403 if (channel >= MAX_CHANNELS) {
3404 usb_audio_dbg(mixer->chip,
3405 "%s(): bogus channel number %d\n",
3410 unitid = delegate_notify(mixer, unitid, &control, &channel);
3412 for_each_mixer_elem(list, mixer, unitid)
3418 for_each_mixer_elem(list, mixer, unitid) {
3419 struct usb_mixer_elem_info *info;
3423 if (!list->is_std_info)
3426 info = mixer_elem_list_to_info(list);
3427 if (count > 1 && info->control != control)
3430 switch (attribute) {
3432 /* invalidate cache, so the value is read from the device */
3434 info->cached &= ~(1 << channel);
3435 else /* master channel */
3438 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3439 &info->head.kctl->id);
3451 usb_audio_dbg(mixer->chip,
3452 "unknown attribute %d in interrupt\n",
3459 static void snd_usb_mixer_interrupt(struct urb *urb)
3461 struct usb_mixer_interface *mixer = urb->context;
3462 int len = urb->actual_length;
3463 int ustatus = urb->status;
3468 if (mixer->protocol == UAC_VERSION_1) {
3469 struct uac1_status_word *status;
3471 for (status = urb->transfer_buffer;
3472 len >= sizeof(*status);
3473 len -= sizeof(*status), status++) {
3474 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3475 status->bStatusType,
3476 status->bOriginator);
3478 /* ignore any notifications not from the control interface */
3479 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
3480 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3483 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
3484 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3486 snd_usb_mixer_notify_id(mixer, status->bOriginator);
3488 } else { /* UAC_VERSION_2 */
3489 struct uac2_interrupt_data_msg *msg;
3491 for (msg = urb->transfer_buffer;
3492 len >= sizeof(*msg);
3493 len -= sizeof(*msg), msg++) {
3494 /* drop vendor specific and endpoint requests */
3495 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
3496 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
3499 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
3500 le16_to_cpu(msg->wValue),
3501 le16_to_cpu(msg->wIndex));
3506 if (ustatus != -ENOENT &&
3507 ustatus != -ECONNRESET &&
3508 ustatus != -ESHUTDOWN) {
3509 urb->dev = mixer->chip->dev;
3510 usb_submit_urb(urb, GFP_ATOMIC);
3514 /* create the handler for the optional status interrupt endpoint */
3515 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
3517 struct usb_endpoint_descriptor *ep;
3518 void *transfer_buffer;
3522 /* we need one interrupt input endpoint */
3523 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3525 ep = get_endpoint(mixer->hostif, 0);
3526 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3529 epnum = usb_endpoint_num(ep);
3530 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
3531 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
3532 if (!transfer_buffer)
3534 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
3536 kfree(transfer_buffer);
3539 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
3540 usb_rcvintpipe(mixer->chip->dev, epnum),
3541 transfer_buffer, buffer_length,
3542 snd_usb_mixer_interrupt, mixer, ep->bInterval);
3543 usb_submit_urb(mixer->urb, GFP_KERNEL);
3547 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif)
3549 static const struct snd_device_ops dev_ops = {
3550 .dev_free = snd_usb_mixer_dev_free
3552 struct usb_mixer_interface *mixer;
3555 strcpy(chip->card->mixername, "USB Mixer");
3557 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3561 mixer->ignore_ctl_error = !!(chip->quirk_flags & QUIRK_FLAG_IGNORE_CTL_ERROR);
3562 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
3564 if (!mixer->id_elems) {
3569 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
3570 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3573 mixer->protocol = UAC_VERSION_1;
3576 mixer->protocol = UAC_VERSION_2;
3579 mixer->protocol = UAC_VERSION_3;
3583 if (mixer->protocol == UAC_VERSION_3 &&
3584 chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3585 err = snd_usb_mixer_controls_badd(mixer, ctrlif);
3589 err = snd_usb_mixer_controls(mixer);
3594 err = snd_usb_mixer_status_create(mixer);
3598 err = snd_usb_mixer_apply_create_quirk(mixer);
3602 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3606 if (list_empty(&chip->mixer_list))
3607 snd_card_ro_proc_new(chip->card, "usbmixer", chip,
3608 snd_usb_mixer_proc_read);
3610 list_add(&mixer->list, &chip->mixer_list);
3614 snd_usb_mixer_free(mixer);
3618 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3620 if (mixer->disconnected)
3623 usb_kill_urb(mixer->urb);
3625 usb_kill_urb(mixer->rc_urb);
3626 if (mixer->private_free)
3627 mixer->private_free(mixer);
3628 mixer->disconnected = true;
3632 /* stop any bus activity of a mixer */
3633 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
3635 usb_kill_urb(mixer->urb);
3636 usb_kill_urb(mixer->rc_urb);
3639 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
3644 err = usb_submit_urb(mixer->urb, GFP_NOIO);
3652 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
3654 snd_usb_mixer_inactivate(mixer);
3655 if (mixer->private_suspend)
3656 mixer->private_suspend(mixer);
3660 static int restore_mixer_value(struct usb_mixer_elem_list *list)
3662 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3665 if (cval->val_type == USB_MIXER_BESPOKEN)
3670 for (c = 0; c < MAX_CHANNELS; c++) {
3671 if (!(cval->cmask & (1 << c)))
3673 if (cval->cached & (1 << (c + 1))) {
3674 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3675 cval->cache_val[idx]);
3684 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3693 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer)
3695 struct usb_mixer_elem_list *list;
3698 /* restore cached mixer values */
3699 for (id = 0; id < MAX_ID_ELEMS; id++) {
3700 for_each_mixer_elem(list, mixer, id) {
3702 err = list->resume(list);
3709 snd_usb_mixer_resume_quirk(mixer);
3711 return snd_usb_mixer_activate(mixer);
3715 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
3716 struct usb_mixer_interface *mixer,
3719 list->mixer = mixer;
3721 list->dump = snd_usb_mixer_dump_cval;
3723 list->resume = restore_mixer_value;