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)
122 return strlcpy(buf, p->name, buflen);
125 /* ignore the error value if ignore_ctl_error flag is set */
126 #define filter_error(cval, err) \
127 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
129 /* check whether the control should be ignored */
131 check_ignored_ctl(const struct usbmix_name_map *p)
133 if (!p || p->name || p->dB)
139 static inline void check_mapped_dB(const struct usbmix_name_map *p,
140 struct usb_mixer_elem_info *cval)
143 cval->dBmin = p->dB->min;
144 cval->dBmax = p->dB->max;
145 cval->initialized = 1;
149 /* get the mapped selector source name */
150 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
151 int index, char *buf, int buflen)
153 const struct usbmix_selector_map *p;
155 if (!state->selector_map)
157 for (p = state->selector_map; p->id; p++) {
158 if (p->id == unitid && index < p->count)
159 return strlcpy(buf, p->names[index], buflen);
165 * find an audio control unit with the given unit id
167 static void *find_audio_control_unit(struct mixer_build *state,
170 /* we just parse the header */
171 struct uac_feature_unit_descriptor *hdr = NULL;
173 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
174 USB_DT_CS_INTERFACE)) != NULL) {
175 if (hdr->bLength >= 4 &&
176 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
177 hdr->bDescriptorSubtype <= UAC3_SAMPLE_RATE_CONVERTER &&
178 hdr->bUnitID == unit)
186 * copy a string with the given id
188 static int snd_usb_copy_string_desc(struct snd_usb_audio *chip,
189 int index, char *buf, int maxlen)
191 int len = usb_string(chip->dev, index, buf, maxlen - 1);
201 * convert from the byte/word on usb descriptor to the zero-based integer
203 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
205 switch (cval->val_type) {
206 case USB_MIXER_BOOLEAN:
208 case USB_MIXER_INV_BOOLEAN:
231 * convert from the zero-based int to the byte/word for usb descriptor
233 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
235 switch (cval->val_type) {
236 case USB_MIXER_BOOLEAN:
238 case USB_MIXER_INV_BOOLEAN:
247 return 0; /* not reached */
250 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
256 else if (val >= cval->max)
257 return (cval->max - cval->min + cval->res - 1) / cval->res;
259 return (val - cval->min) / cval->res;
262 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
275 static int uac2_ctl_value_size(int val_type)
287 return 0; /* unreachable */
292 * retrieve a mixer value
295 static inline int mixer_ctrl_intf(struct usb_mixer_interface *mixer)
297 return get_iface_desc(mixer->hostif)->bInterfaceNumber;
300 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
301 int validx, int *value_ret)
303 struct snd_usb_audio *chip = cval->head.mixer->chip;
304 unsigned char buf[2];
305 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
309 err = snd_usb_lock_shutdown(chip);
313 while (timeout-- > 0) {
314 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
315 err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
316 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
317 validx, idx, buf, val_len);
318 if (err >= val_len) {
319 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
322 } else if (err == -ETIMEDOUT) {
327 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
328 request, validx, idx, cval->val_type);
332 snd_usb_unlock_shutdown(chip);
336 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
337 int validx, int *value_ret)
339 struct snd_usb_audio *chip = cval->head.mixer->chip;
340 /* enough space for one range */
341 unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
343 int idx = 0, ret, val_size, size;
346 val_size = uac2_ctl_value_size(cval->val_type);
348 if (request == UAC_GET_CUR) {
349 bRequest = UAC2_CS_CUR;
352 bRequest = UAC2_CS_RANGE;
353 size = sizeof(__u16) + 3 * val_size;
356 memset(buf, 0, sizeof(buf));
358 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
362 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
363 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
364 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
365 validx, idx, buf, size);
366 snd_usb_unlock_shutdown(chip);
371 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
372 request, validx, idx, cval->val_type);
376 /* FIXME: how should we handle multiple triplets here? */
383 val = buf + sizeof(__u16);
386 val = buf + sizeof(__u16) + val_size;
389 val = buf + sizeof(__u16) + val_size * 2;
395 *value_ret = convert_signed_value(cval,
396 snd_usb_combine_bytes(val, val_size));
401 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
402 int validx, int *value_ret)
404 validx += cval->idx_off;
406 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
407 get_ctl_value_v1(cval, request, validx, value_ret) :
408 get_ctl_value_v2(cval, request, validx, value_ret);
411 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
412 int validx, int *value)
414 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
417 /* channel = 0: master, 1 = first channel */
418 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
419 int channel, int *value)
421 return get_ctl_value(cval, UAC_GET_CUR,
422 (cval->control << 8) | channel,
426 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
427 int channel, int index, int *value)
431 if (cval->cached & (1 << channel)) {
432 *value = cval->cache_val[index];
435 err = get_cur_mix_raw(cval, channel, value);
437 if (!cval->head.mixer->ignore_ctl_error)
438 usb_audio_dbg(cval->head.mixer->chip,
439 "cannot get current value for control %d ch %d: err = %d\n",
440 cval->control, channel, err);
443 cval->cached |= 1 << channel;
444 cval->cache_val[index] = *value;
452 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
453 int request, int validx, int value_set)
455 struct snd_usb_audio *chip = cval->head.mixer->chip;
456 unsigned char buf[4];
457 int idx = 0, val_len, err, timeout = 10;
459 validx += cval->idx_off;
462 if (cval->head.mixer->protocol == UAC_VERSION_1) {
463 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
464 } else { /* UAC_VERSION_2/3 */
465 val_len = uac2_ctl_value_size(cval->val_type);
468 if (request != UAC_SET_CUR) {
469 usb_audio_dbg(chip, "RANGE setting not yet supported\n");
473 request = UAC2_CS_CUR;
476 value_set = convert_bytes_value(cval, value_set);
477 buf[0] = value_set & 0xff;
478 buf[1] = (value_set >> 8) & 0xff;
479 buf[2] = (value_set >> 16) & 0xff;
480 buf[3] = (value_set >> 24) & 0xff;
482 err = snd_usb_lock_shutdown(chip);
486 while (timeout-- > 0) {
487 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
488 err = snd_usb_ctl_msg(chip->dev,
489 usb_sndctrlpipe(chip->dev, 0), request,
490 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
491 validx, idx, buf, val_len);
495 } else if (err == -ETIMEDOUT) {
499 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
500 request, validx, idx, cval->val_type, buf[0], buf[1]);
504 snd_usb_unlock_shutdown(chip);
508 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
509 int validx, int value)
511 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
514 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
515 int index, int value)
518 unsigned int read_only = (channel == 0) ?
519 cval->master_readonly :
520 cval->ch_readonly & (1 << (channel - 1));
523 usb_audio_dbg(cval->head.mixer->chip,
524 "%s(): channel %d of control %d is read_only\n",
525 __func__, channel, cval->control);
529 err = snd_usb_mixer_set_ctl_value(cval,
530 UAC_SET_CUR, (cval->control << 8) | channel,
534 cval->cached |= 1 << channel;
535 cval->cache_val[index] = value;
540 * TLV callback for mixer volume controls
542 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
543 unsigned int size, unsigned int __user *_tlv)
545 struct usb_mixer_elem_info *cval = kcontrol->private_data;
546 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
548 if (size < sizeof(scale))
551 scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE;
552 scale[2] = cval->dBmin;
553 scale[3] = cval->dBmax;
554 if (copy_to_user(_tlv, scale, sizeof(scale)))
560 * parser routines begin here...
563 static int parse_audio_unit(struct mixer_build *state, int unitid);
567 * check if the input/output channel routing is enabled on the given bitmap.
568 * used for mixer unit parser
570 static int check_matrix_bitmap(unsigned char *bmap,
571 int ich, int och, int num_outs)
573 int idx = ich * num_outs + och;
574 return bmap[idx >> 3] & (0x80 >> (idx & 7));
578 * add an alsa control element
579 * search and increment the index until an empty slot is found.
581 * if failed, give up and free the control instance.
584 int snd_usb_mixer_add_list(struct usb_mixer_elem_list *list,
585 struct snd_kcontrol *kctl,
588 struct usb_mixer_interface *mixer = list->mixer;
591 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
593 err = snd_ctl_add(mixer->chip->card, kctl);
595 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
600 list->is_std_info = is_std_info;
601 list->next_id_elem = mixer->id_elems[list->id];
602 mixer->id_elems[list->id] = list;
607 * get a terminal name string
610 static struct iterm_name_combo {
614 { 0x0300, "Output" },
615 { 0x0301, "Speaker" },
616 { 0x0302, "Headphone" },
617 { 0x0303, "HMD Audio" },
618 { 0x0304, "Desktop Speaker" },
619 { 0x0305, "Room Speaker" },
620 { 0x0306, "Com Speaker" },
622 { 0x0600, "External In" },
623 { 0x0601, "Analog In" },
624 { 0x0602, "Digital In" },
626 { 0x0604, "Legacy In" },
627 { 0x0605, "IEC958 In" },
628 { 0x0606, "1394 DA Stream" },
629 { 0x0607, "1394 DV Stream" },
630 { 0x0700, "Embedded" },
631 { 0x0701, "Noise Source" },
632 { 0x0702, "Equalization Noise" },
636 { 0x0706, "MiniDisk" },
637 { 0x0707, "Analog Tape" },
638 { 0x0708, "Phonograph" },
639 { 0x0709, "VCR Audio" },
640 { 0x070a, "Video Disk Audio" },
641 { 0x070b, "DVD Audio" },
642 { 0x070c, "TV Tuner Audio" },
643 { 0x070d, "Satellite Rec Audio" },
644 { 0x070e, "Cable Tuner Audio" },
645 { 0x070f, "DSS Audio" },
646 { 0x0710, "Radio Receiver" },
647 { 0x0711, "Radio Transmitter" },
648 { 0x0712, "Multi-Track Recorder" },
649 { 0x0713, "Synthesizer" },
653 static int get_term_name(struct snd_usb_audio *chip, struct usb_audio_term *iterm,
654 unsigned char *name, int maxlen, int term_only)
656 struct iterm_name_combo *names;
660 len = snd_usb_copy_string_desc(chip, iterm->name,
666 /* virtual type - not a real terminal */
667 if (iterm->type >> 16) {
670 switch (iterm->type >> 16) {
671 case UAC3_SELECTOR_UNIT:
672 strcpy(name, "Selector");
674 case UAC3_PROCESSING_UNIT:
675 strcpy(name, "Process Unit");
677 case UAC3_EXTENSION_UNIT:
678 strcpy(name, "Ext Unit");
680 case UAC3_MIXER_UNIT:
681 strcpy(name, "Mixer");
684 return sprintf(name, "Unit %d", iterm->id);
688 switch (iterm->type & 0xff00) {
696 strcpy(name, "Headset");
699 strcpy(name, "Phone");
703 for (names = iterm_names; names->type; names++) {
704 if (names->type == iterm->type) {
705 strcpy(name, names->name);
706 return strlen(names->name);
714 * Get logical cluster information for UAC3 devices.
716 static int get_cluster_channels_v3(struct mixer_build *state, unsigned int cluster_id)
718 struct uac3_cluster_header_descriptor c_header;
721 err = snd_usb_ctl_msg(state->chip->dev,
722 usb_rcvctrlpipe(state->chip->dev, 0),
723 UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
724 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
726 snd_usb_ctrl_intf(state->chip),
727 &c_header, sizeof(c_header));
730 if (err != sizeof(c_header)) {
735 return c_header.bNrChannels;
738 usb_audio_err(state->chip, "cannot request logical cluster ID: %d (err: %d)\n", cluster_id, err);
743 * Get number of channels for a Mixer Unit.
745 static int uac_mixer_unit_get_channels(struct mixer_build *state,
746 struct uac_mixer_unit_descriptor *desc)
750 switch (state->mixer->protocol) {
754 if (desc->bLength < sizeof(*desc) + desc->bNrInPins + 1)
755 return 0; /* no bmControls -> skip */
756 mu_channels = uac_mixer_unit_bNrChannels(desc);
759 mu_channels = get_cluster_channels_v3(state,
760 uac3_mixer_unit_wClusterDescrID(desc));
768 * Parse Input Terminal Unit
770 static int __check_input_term(struct mixer_build *state, int id,
771 struct usb_audio_term *term);
773 static int parse_term_uac1_iterm_unit(struct mixer_build *state,
774 struct usb_audio_term *term,
777 struct uac_input_terminal_descriptor *d = p1;
779 term->type = le16_to_cpu(d->wTerminalType);
780 term->channels = d->bNrChannels;
781 term->chconfig = le16_to_cpu(d->wChannelConfig);
782 term->name = d->iTerminal;
786 static int parse_term_uac2_iterm_unit(struct mixer_build *state,
787 struct usb_audio_term *term,
790 struct uac2_input_terminal_descriptor *d = p1;
793 /* call recursively to verify the referenced clock entity */
794 err = __check_input_term(state, d->bCSourceID, term);
798 /* save input term properties after recursion,
799 * to ensure they are not overriden by the recursion calls
802 term->type = le16_to_cpu(d->wTerminalType);
803 term->channels = d->bNrChannels;
804 term->chconfig = le32_to_cpu(d->bmChannelConfig);
805 term->name = d->iTerminal;
809 static int parse_term_uac3_iterm_unit(struct mixer_build *state,
810 struct usb_audio_term *term,
813 struct uac3_input_terminal_descriptor *d = p1;
816 /* call recursively to verify the referenced clock entity */
817 err = __check_input_term(state, d->bCSourceID, term);
821 /* save input term properties after recursion,
822 * to ensure they are not overriden by the recursion calls
825 term->type = le16_to_cpu(d->wTerminalType);
827 err = get_cluster_channels_v3(state, le16_to_cpu(d->wClusterDescrID));
830 term->channels = err;
832 /* REVISIT: UAC3 IT doesn't have channels cfg */
835 term->name = le16_to_cpu(d->wTerminalDescrStr);
839 static int parse_term_mixer_unit(struct mixer_build *state,
840 struct usb_audio_term *term,
843 struct uac_mixer_unit_descriptor *d = p1;
844 int protocol = state->mixer->protocol;
847 err = uac_mixer_unit_get_channels(state, d);
851 term->type = UAC3_MIXER_UNIT << 16; /* virtual type */
852 term->channels = err;
853 if (protocol != UAC_VERSION_3) {
854 term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
855 term->name = uac_mixer_unit_iMixer(d);
860 static int parse_term_selector_unit(struct mixer_build *state,
861 struct usb_audio_term *term,
864 struct uac_selector_unit_descriptor *d = p1;
867 /* call recursively to retrieve the channel info */
868 err = __check_input_term(state, d->baSourceID[0], term);
871 term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */
873 if (state->mixer->protocol != UAC_VERSION_3)
874 term->name = uac_selector_unit_iSelector(d);
878 static int parse_term_proc_unit(struct mixer_build *state,
879 struct usb_audio_term *term,
880 void *p1, int id, int vtype)
882 struct uac_processing_unit_descriptor *d = p1;
883 int protocol = state->mixer->protocol;
887 /* call recursively to retrieve the channel info */
888 err = __check_input_term(state, d->baSourceID[0], term);
893 term->type = vtype << 16; /* virtual type */
896 if (protocol == UAC_VERSION_3)
899 if (!term->channels) {
900 term->channels = uac_processing_unit_bNrChannels(d);
901 term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
903 term->name = uac_processing_unit_iProcessing(d, protocol);
907 static int parse_term_effect_unit(struct mixer_build *state,
908 struct usb_audio_term *term,
911 struct uac2_effect_unit_descriptor *d = p1;
914 err = __check_input_term(state, d->bSourceID, term);
917 term->type = UAC3_EFFECT_UNIT << 16; /* virtual type */
922 static int parse_term_uac2_clock_source(struct mixer_build *state,
923 struct usb_audio_term *term,
926 struct uac_clock_source_descriptor *d = p1;
928 term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
930 term->name = d->iClockSource;
934 static int parse_term_uac3_clock_source(struct mixer_build *state,
935 struct usb_audio_term *term,
938 struct uac3_clock_source_descriptor *d = p1;
940 term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
942 term->name = le16_to_cpu(d->wClockSourceStr);
946 #define PTYPE(a, b) ((a) << 8 | (b))
949 * parse the source unit recursively until it reaches to a terminal
950 * or a branched unit.
952 static int __check_input_term(struct mixer_build *state, int id,
953 struct usb_audio_term *term)
955 int protocol = state->mixer->protocol;
960 /* a loop in the terminal chain? */
961 if (test_and_set_bit(id, state->termbitmap))
964 p1 = find_audio_control_unit(state, id);
967 if (!snd_usb_validate_audio_desc(p1, protocol))
968 break; /* bad descriptor */
973 switch (PTYPE(protocol, hdr[2])) {
974 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
975 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
976 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT): {
977 /* the header is the same for all versions */
978 struct uac_feature_unit_descriptor *d = p1;
981 break; /* continue to parse */
983 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
984 return parse_term_uac1_iterm_unit(state, term, p1, id);
985 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
986 return parse_term_uac2_iterm_unit(state, term, p1, id);
987 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
988 return parse_term_uac3_iterm_unit(state, term, p1, id);
989 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
990 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
991 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
992 return parse_term_mixer_unit(state, term, p1, id);
993 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
994 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
995 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
996 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
997 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
998 return parse_term_selector_unit(state, term, p1, id);
999 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
1000 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
1001 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
1002 return parse_term_proc_unit(state, term, p1, id,
1003 UAC3_PROCESSING_UNIT);
1004 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
1005 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
1006 return parse_term_effect_unit(state, term, p1, id);
1007 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
1008 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
1009 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
1010 return parse_term_proc_unit(state, term, p1, id,
1011 UAC3_EXTENSION_UNIT);
1012 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
1013 return parse_term_uac2_clock_source(state, term, p1, id);
1014 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
1015 return parse_term_uac3_clock_source(state, term, p1, id);
1024 static int check_input_term(struct mixer_build *state, int id,
1025 struct usb_audio_term *term)
1027 memset(term, 0, sizeof(*term));
1028 memset(state->termbitmap, 0, sizeof(state->termbitmap));
1029 return __check_input_term(state, id, term);
1036 /* feature unit control information */
1037 struct usb_feature_control_info {
1040 int type; /* data type for uac1 */
1041 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
1044 static const struct usb_feature_control_info audio_feature_info[] = {
1045 { UAC_FU_MUTE, "Mute", USB_MIXER_INV_BOOLEAN, -1 },
1046 { UAC_FU_VOLUME, "Volume", USB_MIXER_S16, -1 },
1047 { UAC_FU_BASS, "Tone Control - Bass", USB_MIXER_S8, -1 },
1048 { UAC_FU_MID, "Tone Control - Mid", USB_MIXER_S8, -1 },
1049 { UAC_FU_TREBLE, "Tone Control - Treble", USB_MIXER_S8, -1 },
1050 { UAC_FU_GRAPHIC_EQUALIZER, "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemented yet */
1051 { UAC_FU_AUTOMATIC_GAIN, "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
1052 { UAC_FU_DELAY, "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
1053 { UAC_FU_BASS_BOOST, "Bass Boost", USB_MIXER_BOOLEAN, -1 },
1054 { UAC_FU_LOUDNESS, "Loudness", USB_MIXER_BOOLEAN, -1 },
1056 { UAC2_FU_INPUT_GAIN, "Input Gain Control", USB_MIXER_S16, -1 },
1057 { UAC2_FU_INPUT_GAIN_PAD, "Input Gain Pad Control", USB_MIXER_S16, -1 },
1058 { UAC2_FU_PHASE_INVERTER, "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
1061 static void usb_mixer_elem_info_free(struct usb_mixer_elem_info *cval)
1066 /* private_free callback */
1067 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
1069 usb_mixer_elem_info_free(kctl->private_data);
1070 kctl->private_data = NULL;
1074 * interface to ALSA control for feature/mixer units
1077 /* volume control quirks */
1078 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
1079 struct snd_kcontrol *kctl)
1081 struct snd_usb_audio *chip = cval->head.mixer->chip;
1082 switch (chip->usb_id) {
1083 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
1084 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
1085 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1091 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1092 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1097 if (strstr(kctl->id.name, "Effect Return") != NULL) {
1103 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1104 (strstr(kctl->id.name, "Effect Send") != NULL)) {
1105 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
1111 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
1112 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
1113 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1114 usb_audio_info(chip,
1115 "set quirk for FTU Effect Duration\n");
1121 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1122 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1123 usb_audio_info(chip,
1124 "set quirks for FTU Effect Feedback/Volume\n");
1131 case USB_ID(0x0d8c, 0x0103):
1132 if (!strcmp(kctl->id.name, "PCM Playback Volume")) {
1133 usb_audio_info(chip,
1134 "set volume quirk for CM102-A+/102S+\n");
1139 case USB_ID(0x0471, 0x0101):
1140 case USB_ID(0x0471, 0x0104):
1141 case USB_ID(0x0471, 0x0105):
1142 case USB_ID(0x0672, 0x1041):
1143 /* quirk for UDA1321/N101.
1144 * note that detection between firmware 2.1.1.7 (N101)
1145 * and later 2.1.1.21 is not very clear from datasheets.
1146 * I hope that the min value is -15360 for newer firmware --jk
1148 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
1149 cval->min == -15616) {
1150 usb_audio_info(chip,
1151 "set volume quirk for UDA1321/N101 chip\n");
1156 case USB_ID(0x046d, 0x09a4):
1157 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1158 usb_audio_info(chip,
1159 "set volume quirk for QuickCam E3500\n");
1166 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
1167 case USB_ID(0x046d, 0x0808):
1168 case USB_ID(0x046d, 0x0809):
1169 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1170 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1171 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1172 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1173 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1174 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1175 case USB_ID(0x046d, 0x0991):
1176 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1177 /* Most audio usb devices lie about volume resolution.
1178 * Most Logitech webcams have res = 384.
1179 * Probably there is some logitech magic behind this number --fishor
1181 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1182 usb_audio_info(chip,
1183 "set resolution quirk: cval->res = 384\n");
1187 case USB_ID(0x0495, 0x3042): /* ESS Technology Asus USB DAC */
1188 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1189 strstr(kctl->id.name, "Capture Volume") != NULL) {
1199 * retrieve the minimum and maximum values for the specified control
1201 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1202 int default_min, struct snd_kcontrol *kctl)
1205 cval->min = default_min;
1206 cval->max = cval->min + 1;
1208 cval->dBmin = cval->dBmax = 0;
1210 if (cval->val_type == USB_MIXER_BOOLEAN ||
1211 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1212 cval->initialized = 1;
1217 for (i = 0; i < MAX_CHANNELS; i++)
1218 if (cval->cmask & (1 << i)) {
1223 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
1224 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1225 usb_audio_err(cval->head.mixer->chip,
1226 "%d:%d: cannot get min/max values for control %d (id %d)\n",
1227 cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1228 cval->control, cval->head.id);
1231 if (get_ctl_value(cval, UAC_GET_RES,
1232 (cval->control << 8) | minchn,
1236 int last_valid_res = cval->res;
1238 while (cval->res > 1) {
1239 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1240 (cval->control << 8) | minchn,
1245 if (get_ctl_value(cval, UAC_GET_RES,
1246 (cval->control << 8) | minchn, &cval->res) < 0)
1247 cval->res = last_valid_res;
1252 /* Additional checks for the proper resolution
1254 * Some devices report smaller resolutions than actually
1255 * reacting. They don't return errors but simply clip
1256 * to the lower aligned value.
1258 if (cval->min + cval->res < cval->max) {
1259 int last_valid_res = cval->res;
1260 int saved, test, check;
1261 if (get_cur_mix_raw(cval, minchn, &saved) < 0)
1265 if (test < cval->max)
1269 if (test < cval->min || test > cval->max ||
1270 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1271 get_cur_mix_raw(cval, minchn, &check)) {
1272 cval->res = last_valid_res;
1279 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1283 cval->initialized = 1;
1287 volume_control_quirks(cval, kctl);
1289 /* USB descriptions contain the dB scale in 1/256 dB unit
1290 * while ALSA TLV contains in 1/100 dB unit
1292 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1293 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1294 if (cval->dBmin > cval->dBmax) {
1295 /* something is wrong; assume it's either from/to 0dB */
1296 if (cval->dBmin < 0)
1298 else if (cval->dBmin > 0)
1300 if (cval->dBmin > cval->dBmax) {
1301 /* totally crap, return an error */
1309 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1311 /* get a feature/mixer unit info */
1312 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1313 struct snd_ctl_elem_info *uinfo)
1315 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1317 if (cval->val_type == USB_MIXER_BOOLEAN ||
1318 cval->val_type == USB_MIXER_INV_BOOLEAN)
1319 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1321 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1322 uinfo->count = cval->channels;
1323 if (cval->val_type == USB_MIXER_BOOLEAN ||
1324 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1325 uinfo->value.integer.min = 0;
1326 uinfo->value.integer.max = 1;
1328 if (!cval->initialized) {
1329 get_min_max_with_quirks(cval, 0, kcontrol);
1330 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1331 kcontrol->vd[0].access &=
1332 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1333 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1334 snd_ctl_notify(cval->head.mixer->chip->card,
1335 SNDRV_CTL_EVENT_MASK_INFO,
1339 uinfo->value.integer.min = 0;
1340 uinfo->value.integer.max =
1341 (cval->max - cval->min + cval->res - 1) / cval->res;
1346 /* get the current value from feature/mixer unit */
1347 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1348 struct snd_ctl_elem_value *ucontrol)
1350 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1351 int c, cnt, val, err;
1353 ucontrol->value.integer.value[0] = cval->min;
1356 for (c = 0; c < MAX_CHANNELS; c++) {
1357 if (!(cval->cmask & (1 << c)))
1359 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1361 return filter_error(cval, err);
1362 val = get_relative_value(cval, val);
1363 ucontrol->value.integer.value[cnt] = val;
1368 /* master channel */
1369 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1371 return filter_error(cval, err);
1372 val = get_relative_value(cval, val);
1373 ucontrol->value.integer.value[0] = val;
1378 /* put the current value to feature/mixer unit */
1379 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1380 struct snd_ctl_elem_value *ucontrol)
1382 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1383 int c, cnt, val, oval, err;
1388 for (c = 0; c < MAX_CHANNELS; c++) {
1389 if (!(cval->cmask & (1 << c)))
1391 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1393 return filter_error(cval, err);
1394 val = ucontrol->value.integer.value[cnt];
1395 val = get_abs_value(cval, val);
1397 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1403 /* master channel */
1404 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1406 return filter_error(cval, err);
1407 val = ucontrol->value.integer.value[0];
1408 val = get_abs_value(cval, val);
1410 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1417 /* get the boolean value from the master channel of a UAC control */
1418 static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
1419 struct snd_ctl_elem_value *ucontrol)
1421 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1424 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1426 return filter_error(cval, err);
1428 ucontrol->value.integer.value[0] = val;
1432 /* get the connectors status and report it as boolean type */
1433 static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol,
1434 struct snd_ctl_elem_value *ucontrol)
1436 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1437 struct snd_usb_audio *chip = cval->head.mixer->chip;
1438 int idx = 0, validx, ret, val;
1440 validx = cval->control << 8 | 0;
1442 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
1446 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
1447 if (cval->head.mixer->protocol == UAC_VERSION_2) {
1448 struct uac2_connectors_ctl_blk uac2_conn;
1450 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1451 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1452 validx, idx, &uac2_conn, sizeof(uac2_conn));
1453 val = !!uac2_conn.bNrChannels;
1454 } else { /* UAC_VERSION_3 */
1455 struct uac3_insertion_ctl_blk uac3_conn;
1457 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1458 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1459 validx, idx, &uac3_conn, sizeof(uac3_conn));
1460 val = !!uac3_conn.bmConInserted;
1463 snd_usb_unlock_shutdown(chip);
1468 "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1469 UAC_GET_CUR, validx, idx, cval->val_type);
1470 return filter_error(cval, ret);
1473 ucontrol->value.integer.value[0] = val;
1477 static const struct snd_kcontrol_new usb_feature_unit_ctl = {
1478 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1479 .name = "", /* will be filled later manually */
1480 .info = mixer_ctl_feature_info,
1481 .get = mixer_ctl_feature_get,
1482 .put = mixer_ctl_feature_put,
1485 /* the read-only variant */
1486 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1487 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1488 .name = "", /* will be filled later manually */
1489 .info = mixer_ctl_feature_info,
1490 .get = mixer_ctl_feature_get,
1495 * A control which shows the boolean value from reading a UAC control on
1496 * the master channel.
1498 static const struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1499 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1500 .name = "", /* will be filled later manually */
1501 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1502 .info = snd_ctl_boolean_mono_info,
1503 .get = mixer_ctl_master_bool_get,
1507 static const struct snd_kcontrol_new usb_connector_ctl_ro = {
1508 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1509 .name = "", /* will be filled later manually */
1510 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1511 .info = snd_ctl_boolean_mono_info,
1512 .get = mixer_ctl_connector_get,
1517 * This symbol is exported in order to allow the mixer quirks to
1518 * hook up to the standard feature unit control mechanism
1520 const struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1523 * build a feature control
1525 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1527 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1531 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1532 * rename it to "Headphone". We determine if something is a headphone
1533 * similar to how udev determines form factor.
1535 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1536 struct snd_card *card)
1538 const char *names_to_check[] = {
1539 "Headset", "headset", "Headphone", "headphone", NULL};
1543 if (strcmp("Speaker", kctl->id.name))
1546 for (s = names_to_check; *s; s++)
1547 if (strstr(card->shortname, *s)) {
1555 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1558 static const struct usb_feature_control_info *get_feature_control_info(int control)
1562 for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1563 if (audio_feature_info[i].control == control)
1564 return &audio_feature_info[i];
1569 static void __build_feature_ctl(struct usb_mixer_interface *mixer,
1570 const struct usbmix_name_map *imap,
1571 unsigned int ctl_mask, int control,
1572 struct usb_audio_term *iterm,
1573 struct usb_audio_term *oterm,
1574 int unitid, int nameid, int readonly_mask)
1576 const struct usb_feature_control_info *ctl_info;
1577 unsigned int len = 0;
1578 int mapped_name = 0;
1579 struct snd_kcontrol *kctl;
1580 struct usb_mixer_elem_info *cval;
1581 const struct usbmix_name_map *map;
1584 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1585 /* FIXME: not supported yet */
1589 map = find_map(imap, unitid, control);
1590 if (check_ignored_ctl(map))
1593 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1596 snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
1597 cval->control = control;
1598 cval->cmask = ctl_mask;
1600 ctl_info = get_feature_control_info(control);
1602 usb_mixer_elem_info_free(cval);
1605 if (mixer->protocol == UAC_VERSION_1)
1606 cval->val_type = ctl_info->type;
1607 else /* UAC_VERSION_2 */
1608 cval->val_type = ctl_info->type_uac2 >= 0 ?
1609 ctl_info->type_uac2 : ctl_info->type;
1611 if (ctl_mask == 0) {
1612 cval->channels = 1; /* master channel */
1613 cval->master_readonly = readonly_mask;
1616 for (i = 0; i < 16; i++)
1617 if (ctl_mask & (1 << i))
1620 cval->ch_readonly = readonly_mask;
1624 * If all channels in the mask are marked read-only, make the control
1625 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1626 * issue write commands to read-only channels.
1628 if (cval->channels == readonly_mask)
1629 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1631 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1634 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1635 usb_mixer_elem_info_free(cval);
1638 kctl->private_free = snd_usb_mixer_elem_free;
1640 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1641 mapped_name = len != 0;
1643 len = snd_usb_copy_string_desc(mixer->chip, nameid,
1644 kctl->id.name, sizeof(kctl->id.name));
1650 * determine the control name. the rule is:
1651 * - if a name id is given in descriptor, use it.
1652 * - if the connected input can be determined, then use the name
1654 * - if the connected output can be determined, use it.
1655 * - otherwise, anonymous name.
1659 len = get_term_name(mixer->chip, iterm,
1661 sizeof(kctl->id.name), 1);
1663 len = get_term_name(mixer->chip, oterm,
1665 sizeof(kctl->id.name), 1);
1667 snprintf(kctl->id.name, sizeof(kctl->id.name),
1668 "Feature %d", unitid);
1672 check_no_speaker_on_headset(kctl, mixer->chip->card);
1675 * determine the stream direction:
1676 * if the connected output is USB stream, then it's likely a
1677 * capture stream. otherwise it should be playback (hopefully :)
1679 if (!mapped_name && oterm && !(oterm->type >> 16)) {
1680 if ((oterm->type & 0xff00) == 0x0100)
1681 append_ctl_name(kctl, " Capture");
1683 append_ctl_name(kctl, " Playback");
1685 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1686 " Switch" : " Volume");
1690 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1691 sizeof(kctl->id.name));
1695 /* get min/max values */
1696 get_min_max_with_quirks(cval, 0, kctl);
1698 /* skip a bogus volume range */
1699 if (cval->max <= cval->min) {
1700 usb_audio_dbg(mixer->chip,
1701 "[%d] FU [%s] skipped due to invalid volume\n",
1702 cval->head.id, kctl->id.name);
1703 snd_ctl_free_one(kctl);
1708 if (control == UAC_FU_VOLUME) {
1709 check_mapped_dB(map, cval);
1710 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1711 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1712 kctl->vd[0].access |=
1713 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1714 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1718 snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1720 range = (cval->max - cval->min) / cval->res;
1722 * Are there devices with volume range more than 255? I use a bit more
1723 * to be sure. 384 is a resolution magic number found on Logitech
1724 * devices. It will definitively catch all buggy Logitech devices.
1727 usb_audio_warn(mixer->chip,
1728 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1730 usb_audio_warn(mixer->chip,
1731 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1732 cval->head.id, kctl->id.name, cval->channels,
1733 cval->min, cval->max, cval->res);
1736 usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1737 cval->head.id, kctl->id.name, cval->channels,
1738 cval->min, cval->max, cval->res);
1739 snd_usb_mixer_add_control(&cval->head, kctl);
1742 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1743 unsigned int ctl_mask, int control,
1744 struct usb_audio_term *iterm, int unitid,
1747 struct uac_feature_unit_descriptor *desc = raw_desc;
1748 int nameid = uac_feature_unit_iFeature(desc);
1750 __build_feature_ctl(state->mixer, state->map, ctl_mask, control,
1751 iterm, &state->oterm, unitid, nameid, readonly_mask);
1754 static void build_feature_ctl_badd(struct usb_mixer_interface *mixer,
1755 unsigned int ctl_mask, int control, int unitid,
1756 const struct usbmix_name_map *badd_map)
1758 __build_feature_ctl(mixer, badd_map, ctl_mask, control,
1759 NULL, NULL, unitid, 0, 0);
1762 static void get_connector_control_name(struct usb_mixer_interface *mixer,
1763 struct usb_audio_term *term,
1764 bool is_input, char *name, int name_size)
1766 int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1769 strlcpy(name, "Unknown", name_size);
1772 * sound/core/ctljack.c has a convention of naming jack controls
1773 * by ending in " Jack". Make it slightly more useful by
1774 * indicating Input or Output after the terminal name.
1777 strlcat(name, " - Input Jack", name_size);
1779 strlcat(name, " - Output Jack", name_size);
1782 /* Build a mixer control for a UAC connector control (jack-detect) */
1783 static void build_connector_control(struct usb_mixer_interface *mixer,
1784 const struct usbmix_name_map *imap,
1785 struct usb_audio_term *term, bool is_input)
1787 struct snd_kcontrol *kctl;
1788 struct usb_mixer_elem_info *cval;
1789 const struct usbmix_name_map *map;
1791 map = find_map(imap, term->id, 0);
1792 if (check_ignored_ctl(map))
1795 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1798 snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1800 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1801 * number of channels connected.
1803 * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1804 * following byte(s) specifies which connectors are inserted.
1806 * This boolean ctl will simply report if any channels are connected
1809 if (mixer->protocol == UAC_VERSION_2)
1810 cval->control = UAC2_TE_CONNECTOR;
1811 else /* UAC_VERSION_3 */
1812 cval->control = UAC3_TE_INSERTION;
1814 cval->val_type = USB_MIXER_BOOLEAN;
1815 cval->channels = 1; /* report true if any channel is connected */
1818 kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1820 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1821 usb_mixer_elem_info_free(cval);
1825 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)))
1826 strlcat(kctl->id.name, " Jack", sizeof(kctl->id.name));
1828 get_connector_control_name(mixer, term, is_input, kctl->id.name,
1829 sizeof(kctl->id.name));
1830 kctl->private_free = snd_usb_mixer_elem_free;
1831 snd_usb_mixer_add_control(&cval->head, kctl);
1834 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1837 struct uac_clock_source_descriptor *hdr = _ftr;
1838 struct usb_mixer_elem_info *cval;
1839 struct snd_kcontrol *kctl;
1840 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1843 if (state->mixer->protocol != UAC_VERSION_2)
1847 * The only property of this unit we are interested in is the
1848 * clock source validity. If that isn't readable, just bail out.
1850 if (!uac_v2v3_control_is_readable(hdr->bmControls,
1851 UAC2_CS_CONTROL_CLOCK_VALID))
1854 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1858 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1863 cval->val_type = USB_MIXER_BOOLEAN;
1864 cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1866 cval->master_readonly = 1;
1867 /* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1868 kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1871 usb_mixer_elem_info_free(cval);
1875 kctl->private_free = snd_usb_mixer_elem_free;
1876 ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1877 name, sizeof(name));
1879 snprintf(kctl->id.name, sizeof(kctl->id.name),
1880 "%s Validity", name);
1882 snprintf(kctl->id.name, sizeof(kctl->id.name),
1883 "Clock Source %d Validity", hdr->bClockID);
1885 return snd_usb_mixer_add_control(&cval->head, kctl);
1889 * parse a feature unit
1891 * most of controls are defined here.
1893 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1897 struct usb_audio_term iterm;
1898 unsigned int master_bits;
1900 struct uac_feature_unit_descriptor *hdr = _ftr;
1903 if (state->mixer->protocol == UAC_VERSION_1) {
1904 csize = hdr->bControlSize;
1905 channels = (hdr->bLength - 7) / csize - 1;
1906 bmaControls = hdr->bmaControls;
1907 } else if (state->mixer->protocol == UAC_VERSION_2) {
1908 struct uac2_feature_unit_descriptor *ftr = _ftr;
1910 channels = (hdr->bLength - 6) / 4 - 1;
1911 bmaControls = ftr->bmaControls;
1912 } else { /* UAC_VERSION_3 */
1913 struct uac3_feature_unit_descriptor *ftr = _ftr;
1916 channels = (ftr->bLength - 7) / 4 - 1;
1917 bmaControls = ftr->bmaControls;
1920 /* parse the source unit */
1921 err = parse_audio_unit(state, hdr->bSourceID);
1925 /* determine the input source type and name */
1926 err = check_input_term(state, hdr->bSourceID, &iterm);
1930 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1931 /* master configuration quirks */
1932 switch (state->chip->usb_id) {
1933 case USB_ID(0x08bb, 0x2702):
1934 usb_audio_info(state->chip,
1935 "usbmixer: master volume quirk for PCM2702 chip\n");
1936 /* disable non-functional volume control */
1937 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1939 case USB_ID(0x1130, 0xf211):
1940 usb_audio_info(state->chip,
1941 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1942 /* disable non-functional volume control */
1948 if (state->mixer->protocol == UAC_VERSION_1) {
1949 /* check all control types */
1950 for (i = 0; i < 10; i++) {
1951 unsigned int ch_bits = 0;
1952 int control = audio_feature_info[i].control;
1954 for (j = 0; j < channels; j++) {
1957 mask = snd_usb_combine_bytes(bmaControls +
1958 csize * (j+1), csize);
1959 if (mask & (1 << i))
1960 ch_bits |= (1 << j);
1962 /* audio class v1 controls are never read-only */
1965 * The first channel must be set
1966 * (for ease of programming).
1969 build_feature_ctl(state, _ftr, ch_bits, control,
1971 if (master_bits & (1 << i))
1972 build_feature_ctl(state, _ftr, 0, control,
1975 } else { /* UAC_VERSION_2/3 */
1976 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1977 unsigned int ch_bits = 0;
1978 unsigned int ch_read_only = 0;
1979 int control = audio_feature_info[i].control;
1981 for (j = 0; j < channels; j++) {
1984 mask = snd_usb_combine_bytes(bmaControls +
1985 csize * (j+1), csize);
1986 if (uac_v2v3_control_is_readable(mask, control)) {
1987 ch_bits |= (1 << j);
1988 if (!uac_v2v3_control_is_writeable(mask, control))
1989 ch_read_only |= (1 << j);
1994 * NOTE: build_feature_ctl() will mark the control
1995 * read-only if all channels are marked read-only in
1996 * the descriptors. Otherwise, the control will be
1997 * reported as writeable, but the driver will not
1998 * actually issue a write command for read-only
2003 * The first channel must be set
2004 * (for ease of programming).
2007 build_feature_ctl(state, _ftr, ch_bits, control,
2008 &iterm, unitid, ch_read_only);
2009 if (uac_v2v3_control_is_readable(master_bits, control))
2010 build_feature_ctl(state, _ftr, 0, control,
2012 !uac_v2v3_control_is_writeable(master_bits,
2024 /* check whether the given in/out overflows bmMixerControls matrix */
2025 static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc,
2026 int protocol, int num_ins, int num_outs)
2028 u8 *hdr = (u8 *)desc;
2029 u8 *c = uac_mixer_unit_bmControls(desc, protocol);
2030 size_t rest; /* remaining bytes after bmMixerControls */
2035 rest = 1; /* iMixer */
2038 rest = 2; /* bmControls + iMixer */
2041 rest = 6; /* bmControls + wMixerDescrStr */
2046 return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
2050 * build a mixer unit control
2052 * the callbacks are identical with feature unit.
2053 * input channel number (zero based) is given in control field instead.
2055 static void build_mixer_unit_ctl(struct mixer_build *state,
2056 struct uac_mixer_unit_descriptor *desc,
2057 int in_pin, int in_ch, int num_outs,
2058 int unitid, struct usb_audio_term *iterm)
2060 struct usb_mixer_elem_info *cval;
2061 unsigned int i, len;
2062 struct snd_kcontrol *kctl;
2063 const struct usbmix_name_map *map;
2065 map = find_map(state->map, unitid, 0);
2066 if (check_ignored_ctl(map))
2069 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2073 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2074 cval->control = in_ch + 1; /* based on 1 */
2075 cval->val_type = USB_MIXER_S16;
2076 for (i = 0; i < num_outs; i++) {
2077 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
2079 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
2080 cval->cmask |= (1 << i);
2085 /* get min/max values */
2086 get_min_max(cval, 0);
2088 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2090 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2091 usb_mixer_elem_info_free(cval);
2094 kctl->private_free = snd_usb_mixer_elem_free;
2096 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2098 len = get_term_name(state->chip, iterm, kctl->id.name,
2099 sizeof(kctl->id.name), 0);
2101 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
2102 append_ctl_name(kctl, " Volume");
2104 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2105 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
2106 snd_usb_mixer_add_control(&cval->head, kctl);
2109 static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
2112 struct usb_audio_term iterm;
2113 unsigned int control, bmctls, term_id;
2115 if (state->mixer->protocol == UAC_VERSION_2) {
2116 struct uac2_input_terminal_descriptor *d_v2 = raw_desc;
2117 control = UAC2_TE_CONNECTOR;
2118 term_id = d_v2->bTerminalID;
2119 bmctls = le16_to_cpu(d_v2->bmControls);
2120 } else if (state->mixer->protocol == UAC_VERSION_3) {
2121 struct uac3_input_terminal_descriptor *d_v3 = raw_desc;
2122 control = UAC3_TE_INSERTION;
2123 term_id = d_v3->bTerminalID;
2124 bmctls = le32_to_cpu(d_v3->bmControls);
2126 return 0; /* UAC1. No Insertion control */
2129 check_input_term(state, term_id, &iterm);
2131 /* Check for jack detection. */
2132 if ((iterm.type & 0xff00) != 0x0100 &&
2133 uac_v2v3_control_is_readable(bmctls, control))
2134 build_connector_control(state->mixer, state->map, &iterm, true);
2140 * parse a mixer unit
2142 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
2145 struct uac_mixer_unit_descriptor *desc = raw_desc;
2146 struct usb_audio_term iterm;
2147 int input_pins, num_ins, num_outs;
2150 err = uac_mixer_unit_get_channels(state, desc);
2152 usb_audio_err(state->chip,
2153 "invalid MIXER UNIT descriptor %d\n",
2159 input_pins = desc->bNrInPins;
2163 for (pin = 0; pin < input_pins; pin++) {
2164 err = parse_audio_unit(state, desc->baSourceID[pin]);
2167 /* no bmControls field (e.g. Maya44) -> ignore */
2170 err = check_input_term(state, desc->baSourceID[pin], &iterm);
2173 num_ins += iterm.channels;
2174 if (mixer_bitmap_overflow(desc, state->mixer->protocol,
2177 for (; ich < num_ins; ich++) {
2178 int och, ich_has_controls = 0;
2180 for (och = 0; och < num_outs; och++) {
2181 __u8 *c = uac_mixer_unit_bmControls(desc,
2182 state->mixer->protocol);
2184 if (check_matrix_bitmap(c, ich, och, num_outs)) {
2185 ich_has_controls = 1;
2189 if (ich_has_controls)
2190 build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
2198 * Processing Unit / Extension Unit
2201 /* get callback for processing/extension unit */
2202 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
2203 struct snd_ctl_elem_value *ucontrol)
2205 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2208 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2210 ucontrol->value.integer.value[0] = cval->min;
2211 return filter_error(cval, err);
2213 val = get_relative_value(cval, val);
2214 ucontrol->value.integer.value[0] = val;
2218 /* put callback for processing/extension unit */
2219 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
2220 struct snd_ctl_elem_value *ucontrol)
2222 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2225 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2227 return filter_error(cval, err);
2228 val = ucontrol->value.integer.value[0];
2229 val = get_abs_value(cval, val);
2231 set_cur_ctl_value(cval, cval->control << 8, val);
2237 /* alsa control interface for processing/extension unit */
2238 static const struct snd_kcontrol_new mixer_procunit_ctl = {
2239 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2240 .name = "", /* will be filled later */
2241 .info = mixer_ctl_feature_info,
2242 .get = mixer_ctl_procunit_get,
2243 .put = mixer_ctl_procunit_put,
2247 * predefined data for processing units
2249 struct procunit_value_info {
2256 struct procunit_info {
2259 const struct procunit_value_info *values;
2262 static const struct procunit_value_info undefined_proc_info[] = {
2263 { 0x00, "Control Undefined", 0 },
2267 static const struct procunit_value_info updown_proc_info[] = {
2268 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2269 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2272 static const struct procunit_value_info prologic_proc_info[] = {
2273 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2274 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2277 static const struct procunit_value_info threed_enh_proc_info[] = {
2278 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2279 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2282 static const struct procunit_value_info reverb_proc_info[] = {
2283 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2284 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2285 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2286 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2289 static const struct procunit_value_info chorus_proc_info[] = {
2290 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2291 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2292 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2293 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2296 static const struct procunit_value_info dcr_proc_info[] = {
2297 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2298 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2299 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2300 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2301 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2302 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2306 static const struct procunit_info procunits[] = {
2307 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2308 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2309 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2310 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2311 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2312 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2316 static const struct procunit_value_info uac3_updown_proc_info[] = {
2317 { UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2320 static const struct procunit_value_info uac3_stereo_ext_proc_info[] = {
2321 { UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
2325 static const struct procunit_info uac3_procunits[] = {
2326 { UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info },
2327 { UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info },
2328 { UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info },
2333 * predefined data for extension units
2335 static const struct procunit_value_info clock_rate_xu_info[] = {
2336 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2339 static const struct procunit_value_info clock_source_xu_info[] = {
2340 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2343 static const struct procunit_value_info spdif_format_xu_info[] = {
2344 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2347 static const struct procunit_value_info soft_limit_xu_info[] = {
2348 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2351 static const struct procunit_info extunits[] = {
2352 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2353 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2354 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2355 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2360 * build a processing/extension unit
2362 static int build_audio_procunit(struct mixer_build *state, int unitid,
2363 void *raw_desc, const struct procunit_info *list,
2364 bool extension_unit)
2366 struct uac_processing_unit_descriptor *desc = raw_desc;
2368 struct usb_mixer_elem_info *cval;
2369 struct snd_kcontrol *kctl;
2370 int i, err, nameid, type, len;
2371 const struct procunit_info *info;
2372 const struct procunit_value_info *valinfo;
2373 const struct usbmix_name_map *map;
2374 static const struct procunit_value_info default_value_info[] = {
2375 { 0x01, "Switch", USB_MIXER_BOOLEAN },
2378 static const struct procunit_info default_info = {
2379 0, NULL, default_value_info
2381 const char *name = extension_unit ?
2382 "Extension Unit" : "Processing Unit";
2384 num_ins = desc->bNrInPins;
2385 for (i = 0; i < num_ins; i++) {
2386 err = parse_audio_unit(state, desc->baSourceID[i]);
2391 type = le16_to_cpu(desc->wProcessType);
2392 for (info = list; info && info->type; info++)
2393 if (info->type == type)
2395 if (!info || !info->type)
2396 info = &default_info;
2398 for (valinfo = info->values; valinfo->control; valinfo++) {
2399 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2401 if (state->mixer->protocol == UAC_VERSION_1) {
2402 if (!(controls[valinfo->control / 8] &
2403 (1 << ((valinfo->control % 8) - 1))))
2405 } else { /* UAC_VERSION_2/3 */
2406 if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
2411 map = find_map(state->map, unitid, valinfo->control);
2412 if (check_ignored_ctl(map))
2414 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2417 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2418 cval->control = valinfo->control;
2419 cval->val_type = valinfo->val_type;
2422 if (state->mixer->protocol > UAC_VERSION_1 &&
2423 !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
2425 cval->master_readonly = 1;
2427 /* get min/max values */
2429 case UAC_PROCESS_UP_DOWNMIX: {
2430 bool mode_sel = false;
2432 switch (state->mixer->protocol) {
2436 if (cval->control == UAC_UD_MODE_SELECT)
2440 if (cval->control == UAC3_UD_MODE_SELECT)
2446 __u8 *control_spec = uac_processing_unit_specific(desc,
2447 state->mixer->protocol);
2449 cval->max = control_spec[0];
2451 cval->initialized = 1;
2455 get_min_max(cval, valinfo->min_value);
2458 case USB_XU_CLOCK_RATE:
2460 * E-Mu USB 0404/0202/TrackerPre/0204
2461 * samplerate control quirk
2466 cval->initialized = 1;
2469 get_min_max(cval, valinfo->min_value);
2473 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2475 usb_mixer_elem_info_free(cval);
2478 kctl->private_free = snd_usb_mixer_elem_free;
2480 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2482 } else if (info->name) {
2483 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2486 nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
2488 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2491 len = snd_usb_copy_string_desc(state->chip,
2494 sizeof(kctl->id.name));
2496 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
2498 append_ctl_name(kctl, " ");
2499 append_ctl_name(kctl, valinfo->suffix);
2501 usb_audio_dbg(state->chip,
2502 "[%d] PU [%s] ch = %d, val = %d/%d\n",
2503 cval->head.id, kctl->id.name, cval->channels,
2504 cval->min, cval->max);
2506 err = snd_usb_mixer_add_control(&cval->head, kctl);
2513 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2516 switch (state->mixer->protocol) {
2520 return build_audio_procunit(state, unitid, raw_desc,
2523 return build_audio_procunit(state, unitid, raw_desc,
2524 uac3_procunits, false);
2528 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2532 * Note that we parse extension units with processing unit descriptors.
2533 * That's ok as the layout is the same.
2535 return build_audio_procunit(state, unitid, raw_desc, extunits, true);
2543 * info callback for selector unit
2544 * use an enumerator type for routing
2546 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2547 struct snd_ctl_elem_info *uinfo)
2549 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2550 const char **itemlist = (const char **)kcontrol->private_value;
2552 if (snd_BUG_ON(!itemlist))
2554 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2557 /* get callback for selector unit */
2558 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2559 struct snd_ctl_elem_value *ucontrol)
2561 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2564 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2566 ucontrol->value.enumerated.item[0] = 0;
2567 return filter_error(cval, err);
2569 val = get_relative_value(cval, val);
2570 ucontrol->value.enumerated.item[0] = val;
2574 /* put callback for selector unit */
2575 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2576 struct snd_ctl_elem_value *ucontrol)
2578 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2581 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2583 return filter_error(cval, err);
2584 val = ucontrol->value.enumerated.item[0];
2585 val = get_abs_value(cval, val);
2587 set_cur_ctl_value(cval, cval->control << 8, val);
2593 /* alsa control interface for selector unit */
2594 static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2595 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2596 .name = "", /* will be filled later */
2597 .info = mixer_ctl_selector_info,
2598 .get = mixer_ctl_selector_get,
2599 .put = mixer_ctl_selector_put,
2603 * private free callback.
2604 * free both private_data and private_value
2606 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2610 if (kctl->private_data) {
2611 struct usb_mixer_elem_info *cval = kctl->private_data;
2612 num_ins = cval->max;
2613 usb_mixer_elem_info_free(cval);
2614 kctl->private_data = NULL;
2616 if (kctl->private_value) {
2617 char **itemlist = (char **)kctl->private_value;
2618 for (i = 0; i < num_ins; i++)
2621 kctl->private_value = 0;
2626 * parse a selector unit
2628 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2631 struct uac_selector_unit_descriptor *desc = raw_desc;
2632 unsigned int i, nameid, len;
2634 struct usb_mixer_elem_info *cval;
2635 struct snd_kcontrol *kctl;
2636 const struct usbmix_name_map *map;
2639 for (i = 0; i < desc->bNrInPins; i++) {
2640 err = parse_audio_unit(state, desc->baSourceID[i]);
2645 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2648 map = find_map(state->map, unitid, 0);
2649 if (check_ignored_ctl(map))
2652 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2655 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2656 cval->val_type = USB_MIXER_U8;
2659 cval->max = desc->bNrInPins;
2661 cval->initialized = 1;
2663 switch (state->mixer->protocol) {
2670 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2671 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2672 cval->control = UAC2_CX_CLOCK_SELECTOR;
2673 else /* UAC2/3_SELECTOR_UNIT */
2674 cval->control = UAC2_SU_SELECTOR;
2678 namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2683 #define MAX_ITEM_NAME_LEN 64
2684 for (i = 0; i < desc->bNrInPins; i++) {
2685 struct usb_audio_term iterm;
2687 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2692 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2694 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2695 len = get_term_name(state->chip, &iterm, namelist[i],
2696 MAX_ITEM_NAME_LEN, 0);
2698 sprintf(namelist[i], "Input %u", i);
2701 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2703 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2707 kctl->private_value = (unsigned long)namelist;
2708 kctl->private_free = usb_mixer_selector_elem_free;
2710 /* check the static mapping table at first */
2711 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2714 switch (state->mixer->protocol) {
2718 /* if iSelector is given, use it */
2719 nameid = uac_selector_unit_iSelector(desc);
2721 len = snd_usb_copy_string_desc(state->chip,
2722 nameid, kctl->id.name,
2723 sizeof(kctl->id.name));
2726 /* TODO: Class-Specific strings not yet supported */
2730 /* ... or pick up the terminal name at next */
2732 len = get_term_name(state->chip, &state->oterm,
2733 kctl->id.name, sizeof(kctl->id.name), 0);
2734 /* ... or use the fixed string "USB" as the last resort */
2736 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2738 /* and add the proper suffix */
2739 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2740 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2741 append_ctl_name(kctl, " Clock Source");
2742 else if ((state->oterm.type & 0xff00) == 0x0100)
2743 append_ctl_name(kctl, " Capture Source");
2745 append_ctl_name(kctl, " Playback Source");
2748 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2749 cval->head.id, kctl->id.name, desc->bNrInPins);
2750 return snd_usb_mixer_add_control(&cval->head, kctl);
2753 for (i = 0; i < desc->bNrInPins; i++)
2757 usb_mixer_elem_info_free(cval);
2762 * parse an audio unit recursively
2765 static int parse_audio_unit(struct mixer_build *state, int unitid)
2768 int protocol = state->mixer->protocol;
2770 if (test_and_set_bit(unitid, state->unitbitmap))
2771 return 0; /* the unit already visited */
2773 p1 = find_audio_control_unit(state, unitid);
2775 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2779 if (!snd_usb_validate_audio_desc(p1, protocol)) {
2780 usb_audio_dbg(state->chip, "invalid unit %d\n", unitid);
2781 return 0; /* skip invalid unit */
2784 switch (PTYPE(protocol, p1[2])) {
2785 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
2786 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
2787 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
2788 return parse_audio_input_terminal(state, unitid, p1);
2789 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
2790 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
2791 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
2792 return parse_audio_mixer_unit(state, unitid, p1);
2793 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
2794 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
2795 return parse_clock_source_unit(state, unitid, p1);
2796 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
2797 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
2798 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
2799 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
2800 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
2801 return parse_audio_selector_unit(state, unitid, p1);
2802 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
2803 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
2804 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT):
2805 return parse_audio_feature_unit(state, unitid, p1);
2806 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
2807 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
2808 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
2809 return parse_audio_processing_unit(state, unitid, p1);
2810 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
2811 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
2812 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
2813 return parse_audio_extension_unit(state, unitid, p1);
2814 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
2815 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
2816 return 0; /* FIXME - effect units not implemented yet */
2818 usb_audio_err(state->chip,
2819 "unit %u: unexpected type 0x%02x\n",
2825 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2827 /* kill pending URBs */
2828 snd_usb_mixer_disconnect(mixer);
2830 kfree(mixer->id_elems);
2832 kfree(mixer->urb->transfer_buffer);
2833 usb_free_urb(mixer->urb);
2835 usb_free_urb(mixer->rc_urb);
2836 kfree(mixer->rc_setup_packet);
2840 static int snd_usb_mixer_dev_free(struct snd_device *device)
2842 struct usb_mixer_interface *mixer = device->device_data;
2843 snd_usb_mixer_free(mixer);
2847 /* UAC3 predefined channels configuration */
2848 struct uac3_badd_profile {
2851 int c_chmask; /* capture channels mask */
2852 int p_chmask; /* playback channels mask */
2853 int st_chmask; /* side tone mixing channel mask */
2856 static const struct uac3_badd_profile uac3_badd_profiles[] = {
2859 * BAIF, BAOF or combination of both
2860 * IN: Mono or Stereo cfg, Mono alt possible
2861 * OUT: Mono or Stereo cfg, Mono alt possible
2863 .subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
2864 .name = "GENERIC IO",
2865 .c_chmask = -1, /* dynamic channels */
2866 .p_chmask = -1, /* dynamic channels */
2869 /* BAOF; Stereo only cfg, Mono alt possible */
2870 .subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
2871 .name = "HEADPHONE",
2875 /* BAOF; Mono or Stereo cfg, Mono alt possible */
2876 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
2878 .p_chmask = -1, /* dynamic channels */
2881 /* BAIF; Mono or Stereo cfg, Mono alt possible */
2882 .subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
2883 .name = "MICROPHONE",
2884 .c_chmask = -1, /* dynamic channels */
2890 * OUT: Mono or Stereo cfg, Mono alt possible
2892 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
2895 .p_chmask = -1, /* dynamic channels */
2899 /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
2900 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
2901 .name = "HEADSET ADAPTER",
2907 /* BAIF + BAOF; IN: Mono only; OUT: Mono only */
2908 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
2909 .name = "SPEAKERPHONE",
2913 { 0 } /* terminator */
2916 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
2917 const struct uac3_badd_profile *f,
2918 int c_chmask, int p_chmask)
2921 * If both playback/capture channels are dynamic, make sure
2922 * at least one channel is present
2924 if (f->c_chmask < 0 && f->p_chmask < 0) {
2925 if (!c_chmask && !p_chmask) {
2926 usb_audio_warn(mixer->chip, "BAAD %s: no channels?",
2933 if ((f->c_chmask < 0 && !c_chmask) ||
2934 (f->c_chmask >= 0 && f->c_chmask != c_chmask)) {
2935 usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch",
2939 if ((f->p_chmask < 0 && !p_chmask) ||
2940 (f->p_chmask >= 0 && f->p_chmask != p_chmask)) {
2941 usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch",
2949 * create mixer controls for UAC3 BADD profiles
2951 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
2953 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
2955 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
2958 struct usb_device *dev = mixer->chip->dev;
2959 struct usb_interface_assoc_descriptor *assoc;
2960 int badd_profile = mixer->chip->badd_profile;
2961 const struct uac3_badd_profile *f;
2962 const struct usbmix_ctl_map *map;
2963 int p_chmask = 0, c_chmask = 0, st_chmask = 0;
2966 assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
2968 /* Detect BADD capture/playback channels from AS EP descriptors */
2969 for (i = 0; i < assoc->bInterfaceCount; i++) {
2970 int intf = assoc->bFirstInterface + i;
2972 struct usb_interface *iface;
2973 struct usb_host_interface *alts;
2974 struct usb_interface_descriptor *altsd;
2975 unsigned int maxpacksize;
2982 iface = usb_ifnum_to_if(dev, intf);
2986 num = iface->num_altsetting;
2992 * The number of Channels in an AudioStreaming interface
2993 * and the audio sample bit resolution (16 bits or 24
2994 * bits) can be derived from the wMaxPacketSize field in
2995 * the Standard AS Audio Data Endpoint descriptor in
2996 * Alternate Setting 1
2998 alts = &iface->altsetting[1];
2999 altsd = get_iface_desc(alts);
3001 if (altsd->bNumEndpoints < 1)
3004 /* check direction */
3005 dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
3006 maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3008 switch (maxpacksize) {
3010 usb_audio_err(mixer->chip,
3011 "incorrect wMaxPacketSize 0x%x for BADD profile\n",
3014 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
3015 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
3016 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
3017 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
3020 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
3021 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
3022 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
3023 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
3034 usb_audio_dbg(mixer->chip,
3035 "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
3036 badd_profile, c_chmask, p_chmask);
3038 /* check the mapping table */
3039 for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
3040 if (map->id == badd_profile)
3047 for (f = uac3_badd_profiles; f->name; f++) {
3048 if (badd_profile == f->subclass)
3053 if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
3055 st_chmask = f->st_chmask;
3059 /* Master channel, always writable */
3060 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3061 UAC3_BADD_FU_ID2, map->map);
3062 /* Mono/Stereo volume channels, always writable */
3063 build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
3064 UAC3_BADD_FU_ID2, map->map);
3069 /* Master channel, always writable */
3070 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3071 UAC3_BADD_FU_ID5, map->map);
3072 /* Mono/Stereo volume channels, always writable */
3073 build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
3074 UAC3_BADD_FU_ID5, map->map);
3077 /* Side tone-mixing */
3079 /* Master channel, always writable */
3080 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3081 UAC3_BADD_FU_ID7, map->map);
3082 /* Mono volume channel, always writable */
3083 build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
3084 UAC3_BADD_FU_ID7, map->map);
3087 /* Insertion Control */
3088 if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
3089 struct usb_audio_term iterm, oterm;
3091 /* Input Term - Insertion control */
3092 memset(&iterm, 0, sizeof(iterm));
3093 iterm.id = UAC3_BADD_IT_ID4;
3094 iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3095 build_connector_control(mixer, map->map, &iterm, true);
3097 /* Output Term - Insertion control */
3098 memset(&oterm, 0, sizeof(oterm));
3099 oterm.id = UAC3_BADD_OT_ID3;
3100 oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3101 build_connector_control(mixer, map->map, &oterm, false);
3108 * create mixer controls
3110 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3112 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
3114 struct mixer_build state;
3116 const struct usbmix_ctl_map *map;
3119 memset(&state, 0, sizeof(state));
3120 state.chip = mixer->chip;
3121 state.mixer = mixer;
3122 state.buffer = mixer->hostif->extra;
3123 state.buflen = mixer->hostif->extralen;
3125 /* check the mapping table */
3126 for (map = usbmix_ctl_maps; map->id; map++) {
3127 if (map->id == state.chip->usb_id) {
3128 state.map = map->map;
3129 state.selector_map = map->selector_map;
3130 mixer->connector_map = map->connector_map;
3131 mixer->ignore_ctl_error |= map->ignore_ctl_error;
3137 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
3138 mixer->hostif->extralen,
3139 p, UAC_OUTPUT_TERMINAL)) != NULL) {
3140 if (!snd_usb_validate_audio_desc(p, mixer->protocol))
3141 continue; /* skip invalid descriptor */
3143 if (mixer->protocol == UAC_VERSION_1) {
3144 struct uac1_output_terminal_descriptor *desc = p;
3146 /* mark terminal ID as visited */
3147 set_bit(desc->bTerminalID, state.unitbitmap);
3148 state.oterm.id = desc->bTerminalID;
3149 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3150 state.oterm.name = desc->iTerminal;
3151 err = parse_audio_unit(&state, desc->bSourceID);
3152 if (err < 0 && err != -EINVAL)
3154 } else if (mixer->protocol == UAC_VERSION_2) {
3155 struct uac2_output_terminal_descriptor *desc = p;
3157 /* mark terminal ID as visited */
3158 set_bit(desc->bTerminalID, state.unitbitmap);
3159 state.oterm.id = desc->bTerminalID;
3160 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3161 state.oterm.name = desc->iTerminal;
3162 err = parse_audio_unit(&state, desc->bSourceID);
3163 if (err < 0 && err != -EINVAL)
3167 * For UAC2, use the same approach to also add the
3170 err = parse_audio_unit(&state, desc->bCSourceID);
3171 if (err < 0 && err != -EINVAL)
3174 if ((state.oterm.type & 0xff00) != 0x0100 &&
3175 uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3176 UAC2_TE_CONNECTOR)) {
3177 build_connector_control(state.mixer, state.map,
3178 &state.oterm, false);
3180 } else { /* UAC_VERSION_3 */
3181 struct uac3_output_terminal_descriptor *desc = p;
3183 /* mark terminal ID as visited */
3184 set_bit(desc->bTerminalID, state.unitbitmap);
3185 state.oterm.id = desc->bTerminalID;
3186 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3187 state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
3188 err = parse_audio_unit(&state, desc->bSourceID);
3189 if (err < 0 && err != -EINVAL)
3193 * For UAC3, use the same approach to also add the
3196 err = parse_audio_unit(&state, desc->bCSourceID);
3197 if (err < 0 && err != -EINVAL)
3200 if ((state.oterm.type & 0xff00) != 0x0100 &&
3201 uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
3202 UAC3_TE_INSERTION)) {
3203 build_connector_control(state.mixer, state.map,
3204 &state.oterm, false);
3212 static int delegate_notify(struct usb_mixer_interface *mixer, int unitid,
3213 u8 *control, u8 *channel)
3215 const struct usbmix_connector_map *map = mixer->connector_map;
3220 for (; map->id; map++) {
3221 if (map->id == unitid) {
3222 if (control && map->control)
3223 *control = map->control;
3224 if (channel && map->channel)
3225 *channel = map->channel;
3226 return map->delegated_id;
3232 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3234 struct usb_mixer_elem_list *list;
3236 unitid = delegate_notify(mixer, unitid, NULL, NULL);
3238 for_each_mixer_elem(list, mixer, unitid) {
3239 struct usb_mixer_elem_info *info;
3241 if (!list->is_std_info)
3243 info = mixer_elem_list_to_info(list);
3244 /* invalidate cache, so the value is read from the device */
3246 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3251 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3252 struct usb_mixer_elem_list *list)
3254 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3255 static const char * const val_types[] = {"BOOLEAN", "INV_BOOLEAN",
3256 "S8", "U8", "S16", "U16"};
3257 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
3258 "channels=%i, type=\"%s\"\n", cval->head.id,
3259 cval->control, cval->cmask, cval->channels,
3260 val_types[cval->val_type]);
3261 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3262 cval->min, cval->max, cval->dBmin, cval->dBmax);
3265 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
3266 struct snd_info_buffer *buffer)
3268 struct snd_usb_audio *chip = entry->private_data;
3269 struct usb_mixer_interface *mixer;
3270 struct usb_mixer_elem_list *list;
3273 list_for_each_entry(mixer, &chip->mixer_list, list) {
3275 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3276 chip->usb_id, mixer_ctrl_intf(mixer),
3277 mixer->ignore_ctl_error);
3278 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
3279 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3280 for_each_mixer_elem(list, mixer, unitid) {
3281 snd_iprintf(buffer, " Unit: %i\n", list->id);
3284 " Control: name=\"%s\", index=%i\n",
3285 list->kctl->id.name,
3286 list->kctl->id.index);
3288 list->dump(buffer, list);
3294 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
3295 int attribute, int value, int index)
3297 struct usb_mixer_elem_list *list;
3298 __u8 unitid = (index >> 8) & 0xff;
3299 __u8 control = (value >> 8) & 0xff;
3300 __u8 channel = value & 0xff;
3301 unsigned int count = 0;
3303 if (channel >= MAX_CHANNELS) {
3304 usb_audio_dbg(mixer->chip,
3305 "%s(): bogus channel number %d\n",
3310 unitid = delegate_notify(mixer, unitid, &control, &channel);
3312 for_each_mixer_elem(list, mixer, unitid)
3318 for_each_mixer_elem(list, mixer, unitid) {
3319 struct usb_mixer_elem_info *info;
3323 if (!list->is_std_info)
3326 info = mixer_elem_list_to_info(list);
3327 if (count > 1 && info->control != control)
3330 switch (attribute) {
3332 /* invalidate cache, so the value is read from the device */
3334 info->cached &= ~(1 << channel);
3335 else /* master channel */
3338 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3339 &info->head.kctl->id);
3351 usb_audio_dbg(mixer->chip,
3352 "unknown attribute %d in interrupt\n",
3359 static void snd_usb_mixer_interrupt(struct urb *urb)
3361 struct usb_mixer_interface *mixer = urb->context;
3362 int len = urb->actual_length;
3363 int ustatus = urb->status;
3368 if (mixer->protocol == UAC_VERSION_1) {
3369 struct uac1_status_word *status;
3371 for (status = urb->transfer_buffer;
3372 len >= sizeof(*status);
3373 len -= sizeof(*status), status++) {
3374 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3375 status->bStatusType,
3376 status->bOriginator);
3378 /* ignore any notifications not from the control interface */
3379 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
3380 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3383 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
3384 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3386 snd_usb_mixer_notify_id(mixer, status->bOriginator);
3388 } else { /* UAC_VERSION_2 */
3389 struct uac2_interrupt_data_msg *msg;
3391 for (msg = urb->transfer_buffer;
3392 len >= sizeof(*msg);
3393 len -= sizeof(*msg), msg++) {
3394 /* drop vendor specific and endpoint requests */
3395 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
3396 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
3399 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
3400 le16_to_cpu(msg->wValue),
3401 le16_to_cpu(msg->wIndex));
3406 if (ustatus != -ENOENT &&
3407 ustatus != -ECONNRESET &&
3408 ustatus != -ESHUTDOWN) {
3409 urb->dev = mixer->chip->dev;
3410 usb_submit_urb(urb, GFP_ATOMIC);
3414 /* create the handler for the optional status interrupt endpoint */
3415 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
3417 struct usb_endpoint_descriptor *ep;
3418 void *transfer_buffer;
3422 /* we need one interrupt input endpoint */
3423 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3425 ep = get_endpoint(mixer->hostif, 0);
3426 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3429 epnum = usb_endpoint_num(ep);
3430 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
3431 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
3432 if (!transfer_buffer)
3434 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
3436 kfree(transfer_buffer);
3439 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
3440 usb_rcvintpipe(mixer->chip->dev, epnum),
3441 transfer_buffer, buffer_length,
3442 snd_usb_mixer_interrupt, mixer, ep->bInterval);
3443 usb_submit_urb(mixer->urb, GFP_KERNEL);
3447 static int keep_iface_ctl_get(struct snd_kcontrol *kcontrol,
3448 struct snd_ctl_elem_value *ucontrol)
3450 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3452 ucontrol->value.integer.value[0] = mixer->chip->keep_iface;
3456 static int keep_iface_ctl_put(struct snd_kcontrol *kcontrol,
3457 struct snd_ctl_elem_value *ucontrol)
3459 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3460 bool keep_iface = !!ucontrol->value.integer.value[0];
3462 if (mixer->chip->keep_iface == keep_iface)
3464 mixer->chip->keep_iface = keep_iface;
3468 static const struct snd_kcontrol_new keep_iface_ctl = {
3469 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
3470 .name = "Keep Interface",
3471 .info = snd_ctl_boolean_mono_info,
3472 .get = keep_iface_ctl_get,
3473 .put = keep_iface_ctl_put,
3476 static int create_keep_iface_ctl(struct usb_mixer_interface *mixer)
3478 struct snd_kcontrol *kctl = snd_ctl_new1(&keep_iface_ctl, mixer);
3480 /* need only one control per card */
3481 if (snd_ctl_find_id(mixer->chip->card, &kctl->id)) {
3482 snd_ctl_free_one(kctl);
3486 return snd_ctl_add(mixer->chip->card, kctl);
3489 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
3492 static const struct snd_device_ops dev_ops = {
3493 .dev_free = snd_usb_mixer_dev_free
3495 struct usb_mixer_interface *mixer;
3498 strcpy(chip->card->mixername, "USB Mixer");
3500 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3504 mixer->ignore_ctl_error = ignore_error;
3505 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
3507 if (!mixer->id_elems) {
3512 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
3513 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3516 mixer->protocol = UAC_VERSION_1;
3519 mixer->protocol = UAC_VERSION_2;
3522 mixer->protocol = UAC_VERSION_3;
3526 if (mixer->protocol == UAC_VERSION_3 &&
3527 chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3528 err = snd_usb_mixer_controls_badd(mixer, ctrlif);
3532 err = snd_usb_mixer_controls(mixer);
3537 err = snd_usb_mixer_status_create(mixer);
3541 err = create_keep_iface_ctl(mixer);
3545 err = snd_usb_mixer_apply_create_quirk(mixer);
3549 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3553 if (list_empty(&chip->mixer_list))
3554 snd_card_ro_proc_new(chip->card, "usbmixer", chip,
3555 snd_usb_mixer_proc_read);
3557 list_add(&mixer->list, &chip->mixer_list);
3561 snd_usb_mixer_free(mixer);
3565 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3567 if (mixer->disconnected)
3570 usb_kill_urb(mixer->urb);
3572 usb_kill_urb(mixer->rc_urb);
3573 if (mixer->private_free)
3574 mixer->private_free(mixer);
3575 mixer->disconnected = true;
3579 /* stop any bus activity of a mixer */
3580 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
3582 usb_kill_urb(mixer->urb);
3583 usb_kill_urb(mixer->rc_urb);
3586 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
3591 err = usb_submit_urb(mixer->urb, GFP_NOIO);
3599 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
3601 snd_usb_mixer_inactivate(mixer);
3602 if (mixer->private_suspend)
3603 mixer->private_suspend(mixer);
3607 static int restore_mixer_value(struct usb_mixer_elem_list *list)
3609 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3614 for (c = 0; c < MAX_CHANNELS; c++) {
3615 if (!(cval->cmask & (1 << c)))
3617 if (cval->cached & (1 << (c + 1))) {
3618 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3619 cval->cache_val[idx]);
3628 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3637 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
3639 struct usb_mixer_elem_list *list;
3643 /* restore cached mixer values */
3644 for (id = 0; id < MAX_ID_ELEMS; id++) {
3645 for_each_mixer_elem(list, mixer, id) {
3647 err = list->resume(list);
3655 snd_usb_mixer_resume_quirk(mixer);
3657 return snd_usb_mixer_activate(mixer);
3661 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
3662 struct usb_mixer_interface *mixer,
3665 list->mixer = mixer;
3667 list->dump = snd_usb_mixer_dump_cval;
3669 list->resume = restore_mixer_value;