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 int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
296 int validx, int *value_ret)
298 struct snd_usb_audio *chip = cval->head.mixer->chip;
299 unsigned char buf[2];
300 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
304 err = snd_usb_lock_shutdown(chip);
308 while (timeout-- > 0) {
309 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
310 err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
311 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
312 validx, idx, buf, val_len);
313 if (err >= val_len) {
314 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
317 } else if (err == -ETIMEDOUT) {
322 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
323 request, validx, idx, cval->val_type);
327 snd_usb_unlock_shutdown(chip);
331 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
332 int validx, int *value_ret)
334 struct snd_usb_audio *chip = cval->head.mixer->chip;
335 /* enough space for one range */
336 unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
338 int idx = 0, ret, val_size, size;
341 val_size = uac2_ctl_value_size(cval->val_type);
343 if (request == UAC_GET_CUR) {
344 bRequest = UAC2_CS_CUR;
347 bRequest = UAC2_CS_RANGE;
348 size = sizeof(__u16) + 3 * val_size;
351 memset(buf, 0, sizeof(buf));
353 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
357 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
358 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
359 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
360 validx, idx, buf, size);
361 snd_usb_unlock_shutdown(chip);
366 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
367 request, validx, idx, cval->val_type);
371 /* FIXME: how should we handle multiple triplets here? */
378 val = buf + sizeof(__u16);
381 val = buf + sizeof(__u16) + val_size;
384 val = buf + sizeof(__u16) + val_size * 2;
390 *value_ret = convert_signed_value(cval,
391 snd_usb_combine_bytes(val, val_size));
396 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
397 int validx, int *value_ret)
399 validx += cval->idx_off;
401 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
402 get_ctl_value_v1(cval, request, validx, value_ret) :
403 get_ctl_value_v2(cval, request, validx, value_ret);
406 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
407 int validx, int *value)
409 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
412 /* channel = 0: master, 1 = first channel */
413 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
414 int channel, int *value)
416 return get_ctl_value(cval, UAC_GET_CUR,
417 (cval->control << 8) | channel,
421 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
422 int channel, int index, int *value)
426 if (cval->cached & (1 << channel)) {
427 *value = cval->cache_val[index];
430 err = get_cur_mix_raw(cval, channel, value);
432 if (!cval->head.mixer->ignore_ctl_error)
433 usb_audio_dbg(cval->head.mixer->chip,
434 "cannot get current value for control %d ch %d: err = %d\n",
435 cval->control, channel, err);
438 cval->cached |= 1 << channel;
439 cval->cache_val[index] = *value;
447 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
448 int request, int validx, int value_set)
450 struct snd_usb_audio *chip = cval->head.mixer->chip;
451 unsigned char buf[4];
452 int idx = 0, val_len, err, timeout = 10;
454 validx += cval->idx_off;
457 if (cval->head.mixer->protocol == UAC_VERSION_1) {
458 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
459 } else { /* UAC_VERSION_2/3 */
460 val_len = uac2_ctl_value_size(cval->val_type);
463 if (request != UAC_SET_CUR) {
464 usb_audio_dbg(chip, "RANGE setting not yet supported\n");
468 request = UAC2_CS_CUR;
471 value_set = convert_bytes_value(cval, value_set);
472 buf[0] = value_set & 0xff;
473 buf[1] = (value_set >> 8) & 0xff;
474 buf[2] = (value_set >> 16) & 0xff;
475 buf[3] = (value_set >> 24) & 0xff;
477 err = snd_usb_lock_shutdown(chip);
481 while (timeout-- > 0) {
482 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
483 err = snd_usb_ctl_msg(chip->dev,
484 usb_sndctrlpipe(chip->dev, 0), request,
485 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
486 validx, idx, buf, val_len);
490 } else if (err == -ETIMEDOUT) {
494 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
495 request, validx, idx, cval->val_type, buf[0], buf[1]);
499 snd_usb_unlock_shutdown(chip);
503 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
504 int validx, int value)
506 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
509 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
510 int index, int value)
513 unsigned int read_only = (channel == 0) ?
514 cval->master_readonly :
515 cval->ch_readonly & (1 << (channel - 1));
518 usb_audio_dbg(cval->head.mixer->chip,
519 "%s(): channel %d of control %d is read_only\n",
520 __func__, channel, cval->control);
524 err = snd_usb_mixer_set_ctl_value(cval,
525 UAC_SET_CUR, (cval->control << 8) | channel,
529 cval->cached |= 1 << channel;
530 cval->cache_val[index] = value;
535 * TLV callback for mixer volume controls
537 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
538 unsigned int size, unsigned int __user *_tlv)
540 struct usb_mixer_elem_info *cval = kcontrol->private_data;
541 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
543 if (size < sizeof(scale))
546 scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE;
547 scale[2] = cval->dBmin;
548 scale[3] = cval->dBmax;
549 if (copy_to_user(_tlv, scale, sizeof(scale)))
555 * parser routines begin here...
558 static int parse_audio_unit(struct mixer_build *state, int unitid);
562 * check if the input/output channel routing is enabled on the given bitmap.
563 * used for mixer unit parser
565 static int check_matrix_bitmap(unsigned char *bmap,
566 int ich, int och, int num_outs)
568 int idx = ich * num_outs + och;
569 return bmap[idx >> 3] & (0x80 >> (idx & 7));
573 * add an alsa control element
574 * search and increment the index until an empty slot is found.
576 * if failed, give up and free the control instance.
579 int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
580 struct snd_kcontrol *kctl)
582 struct usb_mixer_interface *mixer = list->mixer;
585 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
587 err = snd_ctl_add(mixer->chip->card, kctl);
589 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
594 list->next_id_elem = mixer->id_elems[list->id];
595 mixer->id_elems[list->id] = list;
600 * get a terminal name string
603 static struct iterm_name_combo {
607 { 0x0300, "Output" },
608 { 0x0301, "Speaker" },
609 { 0x0302, "Headphone" },
610 { 0x0303, "HMD Audio" },
611 { 0x0304, "Desktop Speaker" },
612 { 0x0305, "Room Speaker" },
613 { 0x0306, "Com Speaker" },
615 { 0x0600, "External In" },
616 { 0x0601, "Analog In" },
617 { 0x0602, "Digital In" },
619 { 0x0604, "Legacy In" },
620 { 0x0605, "IEC958 In" },
621 { 0x0606, "1394 DA Stream" },
622 { 0x0607, "1394 DV Stream" },
623 { 0x0700, "Embedded" },
624 { 0x0701, "Noise Source" },
625 { 0x0702, "Equalization Noise" },
629 { 0x0706, "MiniDisk" },
630 { 0x0707, "Analog Tape" },
631 { 0x0708, "Phonograph" },
632 { 0x0709, "VCR Audio" },
633 { 0x070a, "Video Disk Audio" },
634 { 0x070b, "DVD Audio" },
635 { 0x070c, "TV Tuner Audio" },
636 { 0x070d, "Satellite Rec Audio" },
637 { 0x070e, "Cable Tuner Audio" },
638 { 0x070f, "DSS Audio" },
639 { 0x0710, "Radio Receiver" },
640 { 0x0711, "Radio Transmitter" },
641 { 0x0712, "Multi-Track Recorder" },
642 { 0x0713, "Synthesizer" },
646 static int get_term_name(struct snd_usb_audio *chip, struct usb_audio_term *iterm,
647 unsigned char *name, int maxlen, int term_only)
649 struct iterm_name_combo *names;
653 len = snd_usb_copy_string_desc(chip, iterm->name,
659 /* virtual type - not a real terminal */
660 if (iterm->type >> 16) {
663 switch (iterm->type >> 16) {
664 case UAC3_SELECTOR_UNIT:
665 strcpy(name, "Selector");
667 case UAC3_PROCESSING_UNIT:
668 strcpy(name, "Process Unit");
670 case UAC3_EXTENSION_UNIT:
671 strcpy(name, "Ext Unit");
673 case UAC3_MIXER_UNIT:
674 strcpy(name, "Mixer");
677 return sprintf(name, "Unit %d", iterm->id);
681 switch (iterm->type & 0xff00) {
689 strcpy(name, "Headset");
692 strcpy(name, "Phone");
696 for (names = iterm_names; names->type; names++) {
697 if (names->type == iterm->type) {
698 strcpy(name, names->name);
699 return strlen(names->name);
707 * Get logical cluster information for UAC3 devices.
709 static int get_cluster_channels_v3(struct mixer_build *state, unsigned int cluster_id)
711 struct uac3_cluster_header_descriptor c_header;
714 err = snd_usb_ctl_msg(state->chip->dev,
715 usb_rcvctrlpipe(state->chip->dev, 0),
716 UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
717 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
719 snd_usb_ctrl_intf(state->chip),
720 &c_header, sizeof(c_header));
723 if (err != sizeof(c_header)) {
728 return c_header.bNrChannels;
731 usb_audio_err(state->chip, "cannot request logical cluster ID: %d (err: %d)\n", cluster_id, err);
736 * Get number of channels for a Mixer Unit.
738 static int uac_mixer_unit_get_channels(struct mixer_build *state,
739 struct uac_mixer_unit_descriptor *desc)
743 switch (state->mixer->protocol) {
747 if (desc->bLength < sizeof(*desc) + desc->bNrInPins + 1)
748 return 0; /* no bmControls -> skip */
749 mu_channels = uac_mixer_unit_bNrChannels(desc);
752 mu_channels = get_cluster_channels_v3(state,
753 uac3_mixer_unit_wClusterDescrID(desc));
761 * Parse Input Terminal Unit
763 static int __check_input_term(struct mixer_build *state, int id,
764 struct usb_audio_term *term);
766 static int parse_term_uac1_iterm_unit(struct mixer_build *state,
767 struct usb_audio_term *term,
770 struct uac_input_terminal_descriptor *d = p1;
772 term->type = le16_to_cpu(d->wTerminalType);
773 term->channels = d->bNrChannels;
774 term->chconfig = le16_to_cpu(d->wChannelConfig);
775 term->name = d->iTerminal;
779 static int parse_term_uac2_iterm_unit(struct mixer_build *state,
780 struct usb_audio_term *term,
783 struct uac2_input_terminal_descriptor *d = p1;
786 /* call recursively to verify the referenced clock entity */
787 err = __check_input_term(state, d->bCSourceID, term);
791 /* save input term properties after recursion,
792 * to ensure they are not overriden by the recursion calls
795 term->type = le16_to_cpu(d->wTerminalType);
796 term->channels = d->bNrChannels;
797 term->chconfig = le32_to_cpu(d->bmChannelConfig);
798 term->name = d->iTerminal;
802 static int parse_term_uac3_iterm_unit(struct mixer_build *state,
803 struct usb_audio_term *term,
806 struct uac3_input_terminal_descriptor *d = p1;
809 /* call recursively to verify the referenced clock entity */
810 err = __check_input_term(state, d->bCSourceID, term);
814 /* save input term properties after recursion,
815 * to ensure they are not overriden by the recursion calls
818 term->type = le16_to_cpu(d->wTerminalType);
820 err = get_cluster_channels_v3(state, le16_to_cpu(d->wClusterDescrID));
823 term->channels = err;
825 /* REVISIT: UAC3 IT doesn't have channels cfg */
828 term->name = le16_to_cpu(d->wTerminalDescrStr);
832 static int parse_term_mixer_unit(struct mixer_build *state,
833 struct usb_audio_term *term,
836 struct uac_mixer_unit_descriptor *d = p1;
837 int protocol = state->mixer->protocol;
840 err = uac_mixer_unit_get_channels(state, d);
844 term->type = UAC3_MIXER_UNIT << 16; /* virtual type */
845 term->channels = err;
846 if (protocol != UAC_VERSION_3) {
847 term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
848 term->name = uac_mixer_unit_iMixer(d);
853 static int parse_term_selector_unit(struct mixer_build *state,
854 struct usb_audio_term *term,
857 struct uac_selector_unit_descriptor *d = p1;
860 /* call recursively to retrieve the channel info */
861 err = __check_input_term(state, d->baSourceID[0], term);
864 term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */
866 if (state->mixer->protocol != UAC_VERSION_3)
867 term->name = uac_selector_unit_iSelector(d);
871 static int parse_term_proc_unit(struct mixer_build *state,
872 struct usb_audio_term *term,
873 void *p1, int id, int vtype)
875 struct uac_processing_unit_descriptor *d = p1;
876 int protocol = state->mixer->protocol;
880 /* call recursively to retrieve the channel info */
881 err = __check_input_term(state, d->baSourceID[0], term);
886 term->type = vtype << 16; /* virtual type */
889 if (protocol == UAC_VERSION_3)
892 if (!term->channels) {
893 term->channels = uac_processing_unit_bNrChannels(d);
894 term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
896 term->name = uac_processing_unit_iProcessing(d, protocol);
900 static int parse_term_effect_unit(struct mixer_build *state,
901 struct usb_audio_term *term,
904 term->type = UAC3_EFFECT_UNIT << 16; /* virtual type */
909 static int parse_term_uac2_clock_source(struct mixer_build *state,
910 struct usb_audio_term *term,
913 struct uac_clock_source_descriptor *d = p1;
915 term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
917 term->name = d->iClockSource;
921 static int parse_term_uac3_clock_source(struct mixer_build *state,
922 struct usb_audio_term *term,
925 struct uac3_clock_source_descriptor *d = p1;
927 term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
929 term->name = le16_to_cpu(d->wClockSourceStr);
933 #define PTYPE(a, b) ((a) << 8 | (b))
936 * parse the source unit recursively until it reaches to a terminal
937 * or a branched unit.
939 static int __check_input_term(struct mixer_build *state, int id,
940 struct usb_audio_term *term)
942 int protocol = state->mixer->protocol;
947 /* a loop in the terminal chain? */
948 if (test_and_set_bit(id, state->termbitmap))
951 p1 = find_audio_control_unit(state, id);
954 if (!snd_usb_validate_audio_desc(p1, protocol))
955 break; /* bad descriptor */
960 switch (PTYPE(protocol, hdr[2])) {
961 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
962 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
963 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT): {
964 /* the header is the same for all versions */
965 struct uac_feature_unit_descriptor *d = p1;
968 break; /* continue to parse */
970 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
971 return parse_term_uac1_iterm_unit(state, term, p1, id);
972 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
973 return parse_term_uac2_iterm_unit(state, term, p1, id);
974 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
975 return parse_term_uac3_iterm_unit(state, term, p1, id);
976 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
977 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
978 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
979 return parse_term_mixer_unit(state, term, p1, id);
980 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
981 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
982 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
983 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
984 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
985 return parse_term_selector_unit(state, term, p1, id);
986 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
987 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
988 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
989 return parse_term_proc_unit(state, term, p1, id,
990 UAC3_PROCESSING_UNIT);
991 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
992 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
993 return parse_term_effect_unit(state, term, p1, id);
994 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
995 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
996 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
997 return parse_term_proc_unit(state, term, p1, id,
998 UAC3_EXTENSION_UNIT);
999 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
1000 return parse_term_uac2_clock_source(state, term, p1, id);
1001 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
1002 return parse_term_uac3_clock_source(state, term, p1, id);
1011 static int check_input_term(struct mixer_build *state, int id,
1012 struct usb_audio_term *term)
1014 memset(term, 0, sizeof(*term));
1015 memset(state->termbitmap, 0, sizeof(state->termbitmap));
1016 return __check_input_term(state, id, term);
1023 /* feature unit control information */
1024 struct usb_feature_control_info {
1027 int type; /* data type for uac1 */
1028 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
1031 static const struct usb_feature_control_info audio_feature_info[] = {
1032 { UAC_FU_MUTE, "Mute", USB_MIXER_INV_BOOLEAN, -1 },
1033 { UAC_FU_VOLUME, "Volume", USB_MIXER_S16, -1 },
1034 { UAC_FU_BASS, "Tone Control - Bass", USB_MIXER_S8, -1 },
1035 { UAC_FU_MID, "Tone Control - Mid", USB_MIXER_S8, -1 },
1036 { UAC_FU_TREBLE, "Tone Control - Treble", USB_MIXER_S8, -1 },
1037 { UAC_FU_GRAPHIC_EQUALIZER, "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemented yet */
1038 { UAC_FU_AUTOMATIC_GAIN, "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
1039 { UAC_FU_DELAY, "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
1040 { UAC_FU_BASS_BOOST, "Bass Boost", USB_MIXER_BOOLEAN, -1 },
1041 { UAC_FU_LOUDNESS, "Loudness", USB_MIXER_BOOLEAN, -1 },
1043 { UAC2_FU_INPUT_GAIN, "Input Gain Control", USB_MIXER_S16, -1 },
1044 { UAC2_FU_INPUT_GAIN_PAD, "Input Gain Pad Control", USB_MIXER_S16, -1 },
1045 { UAC2_FU_PHASE_INVERTER, "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
1048 static void usb_mixer_elem_info_free(struct usb_mixer_elem_info *cval)
1053 /* private_free callback */
1054 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
1056 usb_mixer_elem_info_free(kctl->private_data);
1057 kctl->private_data = NULL;
1061 * interface to ALSA control for feature/mixer units
1064 /* volume control quirks */
1065 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
1066 struct snd_kcontrol *kctl)
1068 struct snd_usb_audio *chip = cval->head.mixer->chip;
1069 switch (chip->usb_id) {
1070 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
1071 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
1072 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1078 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1079 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1084 if (strstr(kctl->id.name, "Effect Return") != NULL) {
1090 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1091 (strstr(kctl->id.name, "Effect Send") != NULL)) {
1092 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
1098 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
1099 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
1100 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1101 usb_audio_info(chip,
1102 "set quirk for FTU Effect Duration\n");
1108 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1109 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1110 usb_audio_info(chip,
1111 "set quirks for FTU Effect Feedback/Volume\n");
1118 case USB_ID(0x0d8c, 0x0103):
1119 if (!strcmp(kctl->id.name, "PCM Playback Volume")) {
1120 usb_audio_info(chip,
1121 "set volume quirk for CM102-A+/102S+\n");
1126 case USB_ID(0x0471, 0x0101):
1127 case USB_ID(0x0471, 0x0104):
1128 case USB_ID(0x0471, 0x0105):
1129 case USB_ID(0x0672, 0x1041):
1130 /* quirk for UDA1321/N101.
1131 * note that detection between firmware 2.1.1.7 (N101)
1132 * and later 2.1.1.21 is not very clear from datasheets.
1133 * I hope that the min value is -15360 for newer firmware --jk
1135 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
1136 cval->min == -15616) {
1137 usb_audio_info(chip,
1138 "set volume quirk for UDA1321/N101 chip\n");
1143 case USB_ID(0x046d, 0x09a4):
1144 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1145 usb_audio_info(chip,
1146 "set volume quirk for QuickCam E3500\n");
1153 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
1154 case USB_ID(0x046d, 0x0808):
1155 case USB_ID(0x046d, 0x0809):
1156 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1157 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1158 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1159 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1160 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1161 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1162 case USB_ID(0x046d, 0x0991):
1163 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1164 /* Most audio usb devices lie about volume resolution.
1165 * Most Logitech webcams have res = 384.
1166 * Probably there is some logitech magic behind this number --fishor
1168 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1169 usb_audio_info(chip,
1170 "set resolution quirk: cval->res = 384\n");
1178 * retrieve the minimum and maximum values for the specified control
1180 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1181 int default_min, struct snd_kcontrol *kctl)
1184 cval->min = default_min;
1185 cval->max = cval->min + 1;
1187 cval->dBmin = cval->dBmax = 0;
1189 if (cval->val_type == USB_MIXER_BOOLEAN ||
1190 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1191 cval->initialized = 1;
1196 for (i = 0; i < MAX_CHANNELS; i++)
1197 if (cval->cmask & (1 << i)) {
1202 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
1203 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1204 usb_audio_err(cval->head.mixer->chip,
1205 "%d:%d: cannot get min/max values for control %d (id %d)\n",
1206 cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
1207 cval->control, cval->head.id);
1210 if (get_ctl_value(cval, UAC_GET_RES,
1211 (cval->control << 8) | minchn,
1215 int last_valid_res = cval->res;
1217 while (cval->res > 1) {
1218 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1219 (cval->control << 8) | minchn,
1224 if (get_ctl_value(cval, UAC_GET_RES,
1225 (cval->control << 8) | minchn, &cval->res) < 0)
1226 cval->res = last_valid_res;
1231 /* Additional checks for the proper resolution
1233 * Some devices report smaller resolutions than actually
1234 * reacting. They don't return errors but simply clip
1235 * to the lower aligned value.
1237 if (cval->min + cval->res < cval->max) {
1238 int last_valid_res = cval->res;
1239 int saved, test, check;
1240 if (get_cur_mix_raw(cval, minchn, &saved) < 0)
1244 if (test < cval->max)
1248 if (test < cval->min || test > cval->max ||
1249 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1250 get_cur_mix_raw(cval, minchn, &check)) {
1251 cval->res = last_valid_res;
1258 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1262 cval->initialized = 1;
1266 volume_control_quirks(cval, kctl);
1268 /* USB descriptions contain the dB scale in 1/256 dB unit
1269 * while ALSA TLV contains in 1/100 dB unit
1271 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1272 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1273 if (cval->dBmin > cval->dBmax) {
1274 /* something is wrong; assume it's either from/to 0dB */
1275 if (cval->dBmin < 0)
1277 else if (cval->dBmin > 0)
1279 if (cval->dBmin > cval->dBmax) {
1280 /* totally crap, return an error */
1288 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1290 /* get a feature/mixer unit info */
1291 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1292 struct snd_ctl_elem_info *uinfo)
1294 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1296 if (cval->val_type == USB_MIXER_BOOLEAN ||
1297 cval->val_type == USB_MIXER_INV_BOOLEAN)
1298 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1300 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1301 uinfo->count = cval->channels;
1302 if (cval->val_type == USB_MIXER_BOOLEAN ||
1303 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1304 uinfo->value.integer.min = 0;
1305 uinfo->value.integer.max = 1;
1307 if (!cval->initialized) {
1308 get_min_max_with_quirks(cval, 0, kcontrol);
1309 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1310 kcontrol->vd[0].access &=
1311 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1312 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1313 snd_ctl_notify(cval->head.mixer->chip->card,
1314 SNDRV_CTL_EVENT_MASK_INFO,
1318 uinfo->value.integer.min = 0;
1319 uinfo->value.integer.max =
1320 (cval->max - cval->min + cval->res - 1) / cval->res;
1325 /* get the current value from feature/mixer unit */
1326 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1327 struct snd_ctl_elem_value *ucontrol)
1329 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1330 int c, cnt, val, err;
1332 ucontrol->value.integer.value[0] = cval->min;
1335 for (c = 0; c < MAX_CHANNELS; c++) {
1336 if (!(cval->cmask & (1 << c)))
1338 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1340 return filter_error(cval, err);
1341 val = get_relative_value(cval, val);
1342 ucontrol->value.integer.value[cnt] = val;
1347 /* master channel */
1348 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1350 return filter_error(cval, err);
1351 val = get_relative_value(cval, val);
1352 ucontrol->value.integer.value[0] = val;
1357 /* put the current value to feature/mixer unit */
1358 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1359 struct snd_ctl_elem_value *ucontrol)
1361 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1362 int c, cnt, val, oval, err;
1367 for (c = 0; c < MAX_CHANNELS; c++) {
1368 if (!(cval->cmask & (1 << c)))
1370 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1372 return filter_error(cval, err);
1373 val = ucontrol->value.integer.value[cnt];
1374 val = get_abs_value(cval, val);
1376 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1382 /* master channel */
1383 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1385 return filter_error(cval, err);
1386 val = ucontrol->value.integer.value[0];
1387 val = get_abs_value(cval, val);
1389 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1396 /* get the boolean value from the master channel of a UAC control */
1397 static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
1398 struct snd_ctl_elem_value *ucontrol)
1400 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1403 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1405 return filter_error(cval, err);
1407 ucontrol->value.integer.value[0] = val;
1411 /* get the connectors status and report it as boolean type */
1412 static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol,
1413 struct snd_ctl_elem_value *ucontrol)
1415 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1416 struct snd_usb_audio *chip = cval->head.mixer->chip;
1417 int idx = 0, validx, ret, val;
1419 validx = cval->control << 8 | 0;
1421 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
1425 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
1426 if (cval->head.mixer->protocol == UAC_VERSION_2) {
1427 struct uac2_connectors_ctl_blk uac2_conn;
1429 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1430 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1431 validx, idx, &uac2_conn, sizeof(uac2_conn));
1432 val = !!uac2_conn.bNrChannels;
1433 } else { /* UAC_VERSION_3 */
1434 struct uac3_insertion_ctl_blk uac3_conn;
1436 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1437 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1438 validx, idx, &uac3_conn, sizeof(uac3_conn));
1439 val = !!uac3_conn.bmConInserted;
1442 snd_usb_unlock_shutdown(chip);
1447 "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1448 UAC_GET_CUR, validx, idx, cval->val_type);
1452 ucontrol->value.integer.value[0] = val;
1456 static const struct snd_kcontrol_new usb_feature_unit_ctl = {
1457 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1458 .name = "", /* will be filled later manually */
1459 .info = mixer_ctl_feature_info,
1460 .get = mixer_ctl_feature_get,
1461 .put = mixer_ctl_feature_put,
1464 /* the read-only variant */
1465 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1466 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1467 .name = "", /* will be filled later manually */
1468 .info = mixer_ctl_feature_info,
1469 .get = mixer_ctl_feature_get,
1474 * A control which shows the boolean value from reading a UAC control on
1475 * the master channel.
1477 static const struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1478 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1479 .name = "", /* will be filled later manually */
1480 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1481 .info = snd_ctl_boolean_mono_info,
1482 .get = mixer_ctl_master_bool_get,
1486 static const struct snd_kcontrol_new usb_connector_ctl_ro = {
1487 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1488 .name = "", /* will be filled later manually */
1489 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1490 .info = snd_ctl_boolean_mono_info,
1491 .get = mixer_ctl_connector_get,
1496 * This symbol is exported in order to allow the mixer quirks to
1497 * hook up to the standard feature unit control mechanism
1499 const struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1502 * build a feature control
1504 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1506 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1510 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1511 * rename it to "Headphone". We determine if something is a headphone
1512 * similar to how udev determines form factor.
1514 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1515 struct snd_card *card)
1517 const char *names_to_check[] = {
1518 "Headset", "headset", "Headphone", "headphone", NULL};
1522 if (strcmp("Speaker", kctl->id.name))
1525 for (s = names_to_check; *s; s++)
1526 if (strstr(card->shortname, *s)) {
1534 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1537 static const struct usb_feature_control_info *get_feature_control_info(int control)
1541 for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1542 if (audio_feature_info[i].control == control)
1543 return &audio_feature_info[i];
1548 static void __build_feature_ctl(struct usb_mixer_interface *mixer,
1549 const struct usbmix_name_map *imap,
1550 unsigned int ctl_mask, int control,
1551 struct usb_audio_term *iterm,
1552 struct usb_audio_term *oterm,
1553 int unitid, int nameid, int readonly_mask)
1555 const struct usb_feature_control_info *ctl_info;
1556 unsigned int len = 0;
1557 int mapped_name = 0;
1558 struct snd_kcontrol *kctl;
1559 struct usb_mixer_elem_info *cval;
1560 const struct usbmix_name_map *map;
1563 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1564 /* FIXME: not supported yet */
1568 map = find_map(imap, unitid, control);
1569 if (check_ignored_ctl(map))
1572 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1575 snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
1576 cval->control = control;
1577 cval->cmask = ctl_mask;
1579 ctl_info = get_feature_control_info(control);
1581 usb_mixer_elem_info_free(cval);
1584 if (mixer->protocol == UAC_VERSION_1)
1585 cval->val_type = ctl_info->type;
1586 else /* UAC_VERSION_2 */
1587 cval->val_type = ctl_info->type_uac2 >= 0 ?
1588 ctl_info->type_uac2 : ctl_info->type;
1590 if (ctl_mask == 0) {
1591 cval->channels = 1; /* master channel */
1592 cval->master_readonly = readonly_mask;
1595 for (i = 0; i < 16; i++)
1596 if (ctl_mask & (1 << i))
1599 cval->ch_readonly = readonly_mask;
1603 * If all channels in the mask are marked read-only, make the control
1604 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1605 * issue write commands to read-only channels.
1607 if (cval->channels == readonly_mask)
1608 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1610 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1613 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1614 usb_mixer_elem_info_free(cval);
1617 kctl->private_free = snd_usb_mixer_elem_free;
1619 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1620 mapped_name = len != 0;
1622 len = snd_usb_copy_string_desc(mixer->chip, nameid,
1623 kctl->id.name, sizeof(kctl->id.name));
1629 * determine the control name. the rule is:
1630 * - if a name id is given in descriptor, use it.
1631 * - if the connected input can be determined, then use the name
1633 * - if the connected output can be determined, use it.
1634 * - otherwise, anonymous name.
1638 len = get_term_name(mixer->chip, iterm,
1640 sizeof(kctl->id.name), 1);
1642 len = get_term_name(mixer->chip, oterm,
1644 sizeof(kctl->id.name), 1);
1646 snprintf(kctl->id.name, sizeof(kctl->id.name),
1647 "Feature %d", unitid);
1651 check_no_speaker_on_headset(kctl, mixer->chip->card);
1654 * determine the stream direction:
1655 * if the connected output is USB stream, then it's likely a
1656 * capture stream. otherwise it should be playback (hopefully :)
1658 if (!mapped_name && oterm && !(oterm->type >> 16)) {
1659 if ((oterm->type & 0xff00) == 0x0100)
1660 append_ctl_name(kctl, " Capture");
1662 append_ctl_name(kctl, " Playback");
1664 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1665 " Switch" : " Volume");
1669 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1670 sizeof(kctl->id.name));
1674 /* get min/max values */
1675 get_min_max_with_quirks(cval, 0, kctl);
1677 if (control == UAC_FU_VOLUME) {
1678 check_mapped_dB(map, cval);
1679 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1680 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1681 kctl->vd[0].access |=
1682 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1683 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1687 snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1689 range = (cval->max - cval->min) / cval->res;
1691 * Are there devices with volume range more than 255? I use a bit more
1692 * to be sure. 384 is a resolution magic number found on Logitech
1693 * devices. It will definitively catch all buggy Logitech devices.
1696 usb_audio_warn(mixer->chip,
1697 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1699 usb_audio_warn(mixer->chip,
1700 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1701 cval->head.id, kctl->id.name, cval->channels,
1702 cval->min, cval->max, cval->res);
1705 usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1706 cval->head.id, kctl->id.name, cval->channels,
1707 cval->min, cval->max, cval->res);
1708 snd_usb_mixer_add_control(&cval->head, kctl);
1711 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1712 unsigned int ctl_mask, int control,
1713 struct usb_audio_term *iterm, int unitid,
1716 struct uac_feature_unit_descriptor *desc = raw_desc;
1717 int nameid = uac_feature_unit_iFeature(desc);
1719 __build_feature_ctl(state->mixer, state->map, ctl_mask, control,
1720 iterm, &state->oterm, unitid, nameid, readonly_mask);
1723 static void build_feature_ctl_badd(struct usb_mixer_interface *mixer,
1724 unsigned int ctl_mask, int control, int unitid,
1725 const struct usbmix_name_map *badd_map)
1727 __build_feature_ctl(mixer, badd_map, ctl_mask, control,
1728 NULL, NULL, unitid, 0, 0);
1731 static void get_connector_control_name(struct usb_mixer_interface *mixer,
1732 struct usb_audio_term *term,
1733 bool is_input, char *name, int name_size)
1735 int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1738 strlcpy(name, "Unknown", name_size);
1741 * sound/core/ctljack.c has a convention of naming jack controls
1742 * by ending in " Jack". Make it slightly more useful by
1743 * indicating Input or Output after the terminal name.
1746 strlcat(name, " - Input Jack", name_size);
1748 strlcat(name, " - Output Jack", name_size);
1751 /* Build a mixer control for a UAC connector control (jack-detect) */
1752 static void build_connector_control(struct usb_mixer_interface *mixer,
1753 struct usb_audio_term *term, bool is_input)
1755 struct snd_kcontrol *kctl;
1756 struct usb_mixer_elem_info *cval;
1758 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1761 snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1763 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1764 * number of channels connected.
1766 * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1767 * following byte(s) specifies which connectors are inserted.
1769 * This boolean ctl will simply report if any channels are connected
1772 if (mixer->protocol == UAC_VERSION_2)
1773 cval->control = UAC2_TE_CONNECTOR;
1774 else /* UAC_VERSION_3 */
1775 cval->control = UAC3_TE_INSERTION;
1777 cval->val_type = USB_MIXER_BOOLEAN;
1778 cval->channels = 1; /* report true if any channel is connected */
1781 kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1783 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1784 usb_mixer_elem_info_free(cval);
1787 get_connector_control_name(mixer, term, is_input, kctl->id.name,
1788 sizeof(kctl->id.name));
1789 kctl->private_free = snd_usb_mixer_elem_free;
1790 snd_usb_mixer_add_control(&cval->head, kctl);
1793 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1796 struct uac_clock_source_descriptor *hdr = _ftr;
1797 struct usb_mixer_elem_info *cval;
1798 struct snd_kcontrol *kctl;
1799 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1802 if (state->mixer->protocol != UAC_VERSION_2)
1806 * The only property of this unit we are interested in is the
1807 * clock source validity. If that isn't readable, just bail out.
1809 if (!uac_v2v3_control_is_readable(hdr->bmControls,
1810 UAC2_CS_CONTROL_CLOCK_VALID))
1813 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1817 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1822 cval->val_type = USB_MIXER_BOOLEAN;
1823 cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1825 cval->master_readonly = 1;
1826 /* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1827 kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1830 usb_mixer_elem_info_free(cval);
1834 kctl->private_free = snd_usb_mixer_elem_free;
1835 ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1836 name, sizeof(name));
1838 snprintf(kctl->id.name, sizeof(kctl->id.name),
1839 "%s Validity", name);
1841 snprintf(kctl->id.name, sizeof(kctl->id.name),
1842 "Clock Source %d Validity", hdr->bClockID);
1844 return snd_usb_mixer_add_control(&cval->head, kctl);
1848 * parse a feature unit
1850 * most of controls are defined here.
1852 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1856 struct usb_audio_term iterm;
1857 unsigned int master_bits;
1859 struct uac_feature_unit_descriptor *hdr = _ftr;
1862 if (state->mixer->protocol == UAC_VERSION_1) {
1863 csize = hdr->bControlSize;
1864 channels = (hdr->bLength - 7) / csize - 1;
1865 bmaControls = hdr->bmaControls;
1866 } else if (state->mixer->protocol == UAC_VERSION_2) {
1867 struct uac2_feature_unit_descriptor *ftr = _ftr;
1869 channels = (hdr->bLength - 6) / 4 - 1;
1870 bmaControls = ftr->bmaControls;
1871 } else { /* UAC_VERSION_3 */
1872 struct uac3_feature_unit_descriptor *ftr = _ftr;
1875 channels = (ftr->bLength - 7) / 4 - 1;
1876 bmaControls = ftr->bmaControls;
1879 /* parse the source unit */
1880 err = parse_audio_unit(state, hdr->bSourceID);
1884 /* determine the input source type and name */
1885 err = check_input_term(state, hdr->bSourceID, &iterm);
1889 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1890 /* master configuration quirks */
1891 switch (state->chip->usb_id) {
1892 case USB_ID(0x08bb, 0x2702):
1893 usb_audio_info(state->chip,
1894 "usbmixer: master volume quirk for PCM2702 chip\n");
1895 /* disable non-functional volume control */
1896 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1898 case USB_ID(0x1130, 0xf211):
1899 usb_audio_info(state->chip,
1900 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1901 /* disable non-functional volume control */
1907 if (state->mixer->protocol == UAC_VERSION_1) {
1908 /* check all control types */
1909 for (i = 0; i < 10; i++) {
1910 unsigned int ch_bits = 0;
1911 int control = audio_feature_info[i].control;
1913 for (j = 0; j < channels; j++) {
1916 mask = snd_usb_combine_bytes(bmaControls +
1917 csize * (j+1), csize);
1918 if (mask & (1 << i))
1919 ch_bits |= (1 << j);
1921 /* audio class v1 controls are never read-only */
1924 * The first channel must be set
1925 * (for ease of programming).
1928 build_feature_ctl(state, _ftr, ch_bits, control,
1930 if (master_bits & (1 << i))
1931 build_feature_ctl(state, _ftr, 0, control,
1934 } else { /* UAC_VERSION_2/3 */
1935 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1936 unsigned int ch_bits = 0;
1937 unsigned int ch_read_only = 0;
1938 int control = audio_feature_info[i].control;
1940 for (j = 0; j < channels; j++) {
1943 mask = snd_usb_combine_bytes(bmaControls +
1944 csize * (j+1), csize);
1945 if (uac_v2v3_control_is_readable(mask, control)) {
1946 ch_bits |= (1 << j);
1947 if (!uac_v2v3_control_is_writeable(mask, control))
1948 ch_read_only |= (1 << j);
1953 * NOTE: build_feature_ctl() will mark the control
1954 * read-only if all channels are marked read-only in
1955 * the descriptors. Otherwise, the control will be
1956 * reported as writeable, but the driver will not
1957 * actually issue a write command for read-only
1962 * The first channel must be set
1963 * (for ease of programming).
1966 build_feature_ctl(state, _ftr, ch_bits, control,
1967 &iterm, unitid, ch_read_only);
1968 if (uac_v2v3_control_is_readable(master_bits, control))
1969 build_feature_ctl(state, _ftr, 0, control,
1971 !uac_v2v3_control_is_writeable(master_bits,
1983 /* check whether the given in/out overflows bmMixerControls matrix */
1984 static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc,
1985 int protocol, int num_ins, int num_outs)
1987 u8 *hdr = (u8 *)desc;
1988 u8 *c = uac_mixer_unit_bmControls(desc, protocol);
1989 size_t rest; /* remaining bytes after bmMixerControls */
1994 rest = 1; /* iMixer */
1997 rest = 2; /* bmControls + iMixer */
2000 rest = 6; /* bmControls + wMixerDescrStr */
2005 return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
2009 * build a mixer unit control
2011 * the callbacks are identical with feature unit.
2012 * input channel number (zero based) is given in control field instead.
2014 static void build_mixer_unit_ctl(struct mixer_build *state,
2015 struct uac_mixer_unit_descriptor *desc,
2016 int in_pin, int in_ch, int num_outs,
2017 int unitid, struct usb_audio_term *iterm)
2019 struct usb_mixer_elem_info *cval;
2020 unsigned int i, len;
2021 struct snd_kcontrol *kctl;
2022 const struct usbmix_name_map *map;
2024 map = find_map(state->map, unitid, 0);
2025 if (check_ignored_ctl(map))
2028 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2032 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2033 cval->control = in_ch + 1; /* based on 1 */
2034 cval->val_type = USB_MIXER_S16;
2035 for (i = 0; i < num_outs; i++) {
2036 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
2038 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
2039 cval->cmask |= (1 << i);
2044 /* get min/max values */
2045 get_min_max(cval, 0);
2047 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2049 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2050 usb_mixer_elem_info_free(cval);
2053 kctl->private_free = snd_usb_mixer_elem_free;
2055 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2057 len = get_term_name(state->chip, iterm, kctl->id.name,
2058 sizeof(kctl->id.name), 0);
2060 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
2061 append_ctl_name(kctl, " Volume");
2063 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2064 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
2065 snd_usb_mixer_add_control(&cval->head, kctl);
2068 static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
2071 struct usb_audio_term iterm;
2072 unsigned int control, bmctls, term_id;
2074 if (state->mixer->protocol == UAC_VERSION_2) {
2075 struct uac2_input_terminal_descriptor *d_v2 = raw_desc;
2076 control = UAC2_TE_CONNECTOR;
2077 term_id = d_v2->bTerminalID;
2078 bmctls = le16_to_cpu(d_v2->bmControls);
2079 } else if (state->mixer->protocol == UAC_VERSION_3) {
2080 struct uac3_input_terminal_descriptor *d_v3 = raw_desc;
2081 control = UAC3_TE_INSERTION;
2082 term_id = d_v3->bTerminalID;
2083 bmctls = le32_to_cpu(d_v3->bmControls);
2085 return 0; /* UAC1. No Insertion control */
2088 check_input_term(state, term_id, &iterm);
2090 /* Check for jack detection. */
2091 if (uac_v2v3_control_is_readable(bmctls, control))
2092 build_connector_control(state->mixer, &iterm, true);
2098 * parse a mixer unit
2100 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
2103 struct uac_mixer_unit_descriptor *desc = raw_desc;
2104 struct usb_audio_term iterm;
2105 int input_pins, num_ins, num_outs;
2108 err = uac_mixer_unit_get_channels(state, desc);
2110 usb_audio_err(state->chip,
2111 "invalid MIXER UNIT descriptor %d\n",
2117 input_pins = desc->bNrInPins;
2121 for (pin = 0; pin < input_pins; pin++) {
2122 err = parse_audio_unit(state, desc->baSourceID[pin]);
2125 /* no bmControls field (e.g. Maya44) -> ignore */
2128 err = check_input_term(state, desc->baSourceID[pin], &iterm);
2131 num_ins += iterm.channels;
2132 if (mixer_bitmap_overflow(desc, state->mixer->protocol,
2135 for (; ich < num_ins; ich++) {
2136 int och, ich_has_controls = 0;
2138 for (och = 0; och < num_outs; och++) {
2139 __u8 *c = uac_mixer_unit_bmControls(desc,
2140 state->mixer->protocol);
2142 if (check_matrix_bitmap(c, ich, och, num_outs)) {
2143 ich_has_controls = 1;
2147 if (ich_has_controls)
2148 build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
2156 * Processing Unit / Extension Unit
2159 /* get callback for processing/extension unit */
2160 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
2161 struct snd_ctl_elem_value *ucontrol)
2163 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2166 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2168 ucontrol->value.integer.value[0] = cval->min;
2169 return filter_error(cval, err);
2171 val = get_relative_value(cval, val);
2172 ucontrol->value.integer.value[0] = val;
2176 /* put callback for processing/extension unit */
2177 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
2178 struct snd_ctl_elem_value *ucontrol)
2180 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2183 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2185 return filter_error(cval, err);
2186 val = ucontrol->value.integer.value[0];
2187 val = get_abs_value(cval, val);
2189 set_cur_ctl_value(cval, cval->control << 8, val);
2195 /* alsa control interface for processing/extension unit */
2196 static const struct snd_kcontrol_new mixer_procunit_ctl = {
2197 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2198 .name = "", /* will be filled later */
2199 .info = mixer_ctl_feature_info,
2200 .get = mixer_ctl_procunit_get,
2201 .put = mixer_ctl_procunit_put,
2205 * predefined data for processing units
2207 struct procunit_value_info {
2214 struct procunit_info {
2217 const struct procunit_value_info *values;
2220 static const struct procunit_value_info undefined_proc_info[] = {
2221 { 0x00, "Control Undefined", 0 },
2225 static const struct procunit_value_info updown_proc_info[] = {
2226 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2227 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2230 static const struct procunit_value_info prologic_proc_info[] = {
2231 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2232 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2235 static const struct procunit_value_info threed_enh_proc_info[] = {
2236 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2237 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2240 static const struct procunit_value_info reverb_proc_info[] = {
2241 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2242 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2243 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2244 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2247 static const struct procunit_value_info chorus_proc_info[] = {
2248 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2249 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2250 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2251 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2254 static const struct procunit_value_info dcr_proc_info[] = {
2255 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2256 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2257 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2258 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2259 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2260 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2264 static const struct procunit_info procunits[] = {
2265 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2266 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2267 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2268 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2269 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2270 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2274 static const struct procunit_value_info uac3_updown_proc_info[] = {
2275 { UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2278 static const struct procunit_value_info uac3_stereo_ext_proc_info[] = {
2279 { UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
2283 static const struct procunit_info uac3_procunits[] = {
2284 { UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info },
2285 { UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info },
2286 { UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info },
2291 * predefined data for extension units
2293 static const struct procunit_value_info clock_rate_xu_info[] = {
2294 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2297 static const struct procunit_value_info clock_source_xu_info[] = {
2298 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2301 static const struct procunit_value_info spdif_format_xu_info[] = {
2302 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2305 static const struct procunit_value_info soft_limit_xu_info[] = {
2306 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2309 static const struct procunit_info extunits[] = {
2310 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2311 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2312 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2313 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2318 * build a processing/extension unit
2320 static int build_audio_procunit(struct mixer_build *state, int unitid,
2321 void *raw_desc, const struct procunit_info *list,
2322 bool extension_unit)
2324 struct uac_processing_unit_descriptor *desc = raw_desc;
2326 struct usb_mixer_elem_info *cval;
2327 struct snd_kcontrol *kctl;
2328 int i, err, nameid, type, len;
2329 const struct procunit_info *info;
2330 const struct procunit_value_info *valinfo;
2331 const struct usbmix_name_map *map;
2332 static const struct procunit_value_info default_value_info[] = {
2333 { 0x01, "Switch", USB_MIXER_BOOLEAN },
2336 static const struct procunit_info default_info = {
2337 0, NULL, default_value_info
2339 const char *name = extension_unit ?
2340 "Extension Unit" : "Processing Unit";
2342 num_ins = desc->bNrInPins;
2343 for (i = 0; i < num_ins; i++) {
2344 err = parse_audio_unit(state, desc->baSourceID[i]);
2349 type = le16_to_cpu(desc->wProcessType);
2350 for (info = list; info && info->type; info++)
2351 if (info->type == type)
2353 if (!info || !info->type)
2354 info = &default_info;
2356 for (valinfo = info->values; valinfo->control; valinfo++) {
2357 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2359 if (state->mixer->protocol == UAC_VERSION_1) {
2360 if (!(controls[valinfo->control / 8] &
2361 (1 << ((valinfo->control % 8) - 1))))
2363 } else { /* UAC_VERSION_2/3 */
2364 if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
2369 map = find_map(state->map, unitid, valinfo->control);
2370 if (check_ignored_ctl(map))
2372 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2375 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2376 cval->control = valinfo->control;
2377 cval->val_type = valinfo->val_type;
2380 if (state->mixer->protocol > UAC_VERSION_1 &&
2381 !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
2383 cval->master_readonly = 1;
2385 /* get min/max values */
2387 case UAC_PROCESS_UP_DOWNMIX: {
2388 bool mode_sel = false;
2390 switch (state->mixer->protocol) {
2394 if (cval->control == UAC_UD_MODE_SELECT)
2398 if (cval->control == UAC3_UD_MODE_SELECT)
2404 __u8 *control_spec = uac_processing_unit_specific(desc,
2405 state->mixer->protocol);
2407 cval->max = control_spec[0];
2409 cval->initialized = 1;
2413 get_min_max(cval, valinfo->min_value);
2416 case USB_XU_CLOCK_RATE:
2418 * E-Mu USB 0404/0202/TrackerPre/0204
2419 * samplerate control quirk
2424 cval->initialized = 1;
2427 get_min_max(cval, valinfo->min_value);
2431 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2433 usb_mixer_elem_info_free(cval);
2436 kctl->private_free = snd_usb_mixer_elem_free;
2438 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2440 } else if (info->name) {
2441 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2444 nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
2446 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2449 len = snd_usb_copy_string_desc(state->chip,
2452 sizeof(kctl->id.name));
2454 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
2456 append_ctl_name(kctl, " ");
2457 append_ctl_name(kctl, valinfo->suffix);
2459 usb_audio_dbg(state->chip,
2460 "[%d] PU [%s] ch = %d, val = %d/%d\n",
2461 cval->head.id, kctl->id.name, cval->channels,
2462 cval->min, cval->max);
2464 err = snd_usb_mixer_add_control(&cval->head, kctl);
2471 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2474 switch (state->mixer->protocol) {
2478 return build_audio_procunit(state, unitid, raw_desc,
2481 return build_audio_procunit(state, unitid, raw_desc,
2482 uac3_procunits, false);
2486 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2490 * Note that we parse extension units with processing unit descriptors.
2491 * That's ok as the layout is the same.
2493 return build_audio_procunit(state, unitid, raw_desc, extunits, true);
2501 * info callback for selector unit
2502 * use an enumerator type for routing
2504 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2505 struct snd_ctl_elem_info *uinfo)
2507 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2508 const char **itemlist = (const char **)kcontrol->private_value;
2510 if (snd_BUG_ON(!itemlist))
2512 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2515 /* get callback for selector unit */
2516 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2517 struct snd_ctl_elem_value *ucontrol)
2519 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2522 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2524 ucontrol->value.enumerated.item[0] = 0;
2525 return filter_error(cval, err);
2527 val = get_relative_value(cval, val);
2528 ucontrol->value.enumerated.item[0] = val;
2532 /* put callback for selector unit */
2533 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2534 struct snd_ctl_elem_value *ucontrol)
2536 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2539 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2541 return filter_error(cval, err);
2542 val = ucontrol->value.enumerated.item[0];
2543 val = get_abs_value(cval, val);
2545 set_cur_ctl_value(cval, cval->control << 8, val);
2551 /* alsa control interface for selector unit */
2552 static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2553 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2554 .name = "", /* will be filled later */
2555 .info = mixer_ctl_selector_info,
2556 .get = mixer_ctl_selector_get,
2557 .put = mixer_ctl_selector_put,
2561 * private free callback.
2562 * free both private_data and private_value
2564 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2568 if (kctl->private_data) {
2569 struct usb_mixer_elem_info *cval = kctl->private_data;
2570 num_ins = cval->max;
2571 usb_mixer_elem_info_free(cval);
2572 kctl->private_data = NULL;
2574 if (kctl->private_value) {
2575 char **itemlist = (char **)kctl->private_value;
2576 for (i = 0; i < num_ins; i++)
2579 kctl->private_value = 0;
2584 * parse a selector unit
2586 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2589 struct uac_selector_unit_descriptor *desc = raw_desc;
2590 unsigned int i, nameid, len;
2592 struct usb_mixer_elem_info *cval;
2593 struct snd_kcontrol *kctl;
2594 const struct usbmix_name_map *map;
2597 for (i = 0; i < desc->bNrInPins; i++) {
2598 err = parse_audio_unit(state, desc->baSourceID[i]);
2603 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2606 map = find_map(state->map, unitid, 0);
2607 if (check_ignored_ctl(map))
2610 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2613 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2614 cval->val_type = USB_MIXER_U8;
2617 cval->max = desc->bNrInPins;
2619 cval->initialized = 1;
2621 switch (state->mixer->protocol) {
2628 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2629 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2630 cval->control = UAC2_CX_CLOCK_SELECTOR;
2631 else /* UAC2/3_SELECTOR_UNIT */
2632 cval->control = UAC2_SU_SELECTOR;
2636 namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2641 #define MAX_ITEM_NAME_LEN 64
2642 for (i = 0; i < desc->bNrInPins; i++) {
2643 struct usb_audio_term iterm;
2645 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2650 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2652 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2653 len = get_term_name(state->chip, &iterm, namelist[i],
2654 MAX_ITEM_NAME_LEN, 0);
2656 sprintf(namelist[i], "Input %u", i);
2659 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2661 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2665 kctl->private_value = (unsigned long)namelist;
2666 kctl->private_free = usb_mixer_selector_elem_free;
2668 /* check the static mapping table at first */
2669 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2672 switch (state->mixer->protocol) {
2676 /* if iSelector is given, use it */
2677 nameid = uac_selector_unit_iSelector(desc);
2679 len = snd_usb_copy_string_desc(state->chip,
2680 nameid, kctl->id.name,
2681 sizeof(kctl->id.name));
2684 /* TODO: Class-Specific strings not yet supported */
2688 /* ... or pick up the terminal name at next */
2690 len = get_term_name(state->chip, &state->oterm,
2691 kctl->id.name, sizeof(kctl->id.name), 0);
2692 /* ... or use the fixed string "USB" as the last resort */
2694 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2696 /* and add the proper suffix */
2697 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2698 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2699 append_ctl_name(kctl, " Clock Source");
2700 else if ((state->oterm.type & 0xff00) == 0x0100)
2701 append_ctl_name(kctl, " Capture Source");
2703 append_ctl_name(kctl, " Playback Source");
2706 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2707 cval->head.id, kctl->id.name, desc->bNrInPins);
2708 return snd_usb_mixer_add_control(&cval->head, kctl);
2711 for (i = 0; i < desc->bNrInPins; i++)
2715 usb_mixer_elem_info_free(cval);
2720 * parse an audio unit recursively
2723 static int parse_audio_unit(struct mixer_build *state, int unitid)
2726 int protocol = state->mixer->protocol;
2728 if (test_and_set_bit(unitid, state->unitbitmap))
2729 return 0; /* the unit already visited */
2731 p1 = find_audio_control_unit(state, unitid);
2733 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2737 if (!snd_usb_validate_audio_desc(p1, protocol)) {
2738 usb_audio_dbg(state->chip, "invalid unit %d\n", unitid);
2739 return 0; /* skip invalid unit */
2742 switch (PTYPE(protocol, p1[2])) {
2743 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
2744 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
2745 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
2746 return parse_audio_input_terminal(state, unitid, p1);
2747 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
2748 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
2749 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
2750 return parse_audio_mixer_unit(state, unitid, p1);
2751 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
2752 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
2753 return parse_clock_source_unit(state, unitid, p1);
2754 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
2755 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
2756 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
2757 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
2758 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
2759 return parse_audio_selector_unit(state, unitid, p1);
2760 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
2761 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
2762 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT):
2763 return parse_audio_feature_unit(state, unitid, p1);
2764 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
2765 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
2766 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
2767 return parse_audio_processing_unit(state, unitid, p1);
2768 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
2769 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
2770 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
2771 return parse_audio_extension_unit(state, unitid, p1);
2772 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
2773 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
2774 return 0; /* FIXME - effect units not implemented yet */
2776 usb_audio_err(state->chip,
2777 "unit %u: unexpected type 0x%02x\n",
2783 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2785 /* kill pending URBs */
2786 snd_usb_mixer_disconnect(mixer);
2788 kfree(mixer->id_elems);
2790 kfree(mixer->urb->transfer_buffer);
2791 usb_free_urb(mixer->urb);
2793 usb_free_urb(mixer->rc_urb);
2794 kfree(mixer->rc_setup_packet);
2798 static int snd_usb_mixer_dev_free(struct snd_device *device)
2800 struct usb_mixer_interface *mixer = device->device_data;
2801 snd_usb_mixer_free(mixer);
2805 /* UAC3 predefined channels configuration */
2806 struct uac3_badd_profile {
2809 int c_chmask; /* capture channels mask */
2810 int p_chmask; /* playback channels mask */
2811 int st_chmask; /* side tone mixing channel mask */
2814 static const struct uac3_badd_profile uac3_badd_profiles[] = {
2817 * BAIF, BAOF or combination of both
2818 * IN: Mono or Stereo cfg, Mono alt possible
2819 * OUT: Mono or Stereo cfg, Mono alt possible
2821 .subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
2822 .name = "GENERIC IO",
2823 .c_chmask = -1, /* dynamic channels */
2824 .p_chmask = -1, /* dynamic channels */
2827 /* BAOF; Stereo only cfg, Mono alt possible */
2828 .subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
2829 .name = "HEADPHONE",
2833 /* BAOF; Mono or Stereo cfg, Mono alt possible */
2834 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
2836 .p_chmask = -1, /* dynamic channels */
2839 /* BAIF; Mono or Stereo cfg, Mono alt possible */
2840 .subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
2841 .name = "MICROPHONE",
2842 .c_chmask = -1, /* dynamic channels */
2848 * OUT: Mono or Stereo cfg, Mono alt possible
2850 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
2853 .p_chmask = -1, /* dynamic channels */
2857 /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
2858 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
2859 .name = "HEADSET ADAPTER",
2865 /* BAIF + BAOF; IN: Mono only; OUT: Mono only */
2866 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
2867 .name = "SPEAKERPHONE",
2871 { 0 } /* terminator */
2874 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
2875 const struct uac3_badd_profile *f,
2876 int c_chmask, int p_chmask)
2879 * If both playback/capture channels are dynamic, make sure
2880 * at least one channel is present
2882 if (f->c_chmask < 0 && f->p_chmask < 0) {
2883 if (!c_chmask && !p_chmask) {
2884 usb_audio_warn(mixer->chip, "BAAD %s: no channels?",
2891 if ((f->c_chmask < 0 && !c_chmask) ||
2892 (f->c_chmask >= 0 && f->c_chmask != c_chmask)) {
2893 usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch",
2897 if ((f->p_chmask < 0 && !p_chmask) ||
2898 (f->p_chmask >= 0 && f->p_chmask != p_chmask)) {
2899 usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch",
2907 * create mixer controls for UAC3 BADD profiles
2909 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
2911 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
2913 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
2916 struct usb_device *dev = mixer->chip->dev;
2917 struct usb_interface_assoc_descriptor *assoc;
2918 int badd_profile = mixer->chip->badd_profile;
2919 const struct uac3_badd_profile *f;
2920 const struct usbmix_ctl_map *map;
2921 int p_chmask = 0, c_chmask = 0, st_chmask = 0;
2924 assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
2926 /* Detect BADD capture/playback channels from AS EP descriptors */
2927 for (i = 0; i < assoc->bInterfaceCount; i++) {
2928 int intf = assoc->bFirstInterface + i;
2930 struct usb_interface *iface;
2931 struct usb_host_interface *alts;
2932 struct usb_interface_descriptor *altsd;
2933 unsigned int maxpacksize;
2940 iface = usb_ifnum_to_if(dev, intf);
2944 num = iface->num_altsetting;
2950 * The number of Channels in an AudioStreaming interface
2951 * and the audio sample bit resolution (16 bits or 24
2952 * bits) can be derived from the wMaxPacketSize field in
2953 * the Standard AS Audio Data Endpoint descriptor in
2954 * Alternate Setting 1
2956 alts = &iface->altsetting[1];
2957 altsd = get_iface_desc(alts);
2959 if (altsd->bNumEndpoints < 1)
2962 /* check direction */
2963 dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
2964 maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2966 switch (maxpacksize) {
2968 usb_audio_err(mixer->chip,
2969 "incorrect wMaxPacketSize 0x%x for BADD profile\n",
2972 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
2973 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
2974 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
2975 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
2978 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
2979 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
2980 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
2981 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
2992 usb_audio_dbg(mixer->chip,
2993 "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
2994 badd_profile, c_chmask, p_chmask);
2996 /* check the mapping table */
2997 for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
2998 if (map->id == badd_profile)
3005 for (f = uac3_badd_profiles; f->name; f++) {
3006 if (badd_profile == f->subclass)
3011 if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
3013 st_chmask = f->st_chmask;
3017 /* Master channel, always writable */
3018 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3019 UAC3_BADD_FU_ID2, map->map);
3020 /* Mono/Stereo volume channels, always writable */
3021 build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
3022 UAC3_BADD_FU_ID2, map->map);
3027 /* Master channel, always writable */
3028 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3029 UAC3_BADD_FU_ID5, map->map);
3030 /* Mono/Stereo volume channels, always writable */
3031 build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
3032 UAC3_BADD_FU_ID5, map->map);
3035 /* Side tone-mixing */
3037 /* Master channel, always writable */
3038 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3039 UAC3_BADD_FU_ID7, map->map);
3040 /* Mono volume channel, always writable */
3041 build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
3042 UAC3_BADD_FU_ID7, map->map);
3045 /* Insertion Control */
3046 if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
3047 struct usb_audio_term iterm, oterm;
3049 /* Input Term - Insertion control */
3050 memset(&iterm, 0, sizeof(iterm));
3051 iterm.id = UAC3_BADD_IT_ID4;
3052 iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3053 build_connector_control(mixer, &iterm, true);
3055 /* Output Term - Insertion control */
3056 memset(&oterm, 0, sizeof(oterm));
3057 oterm.id = UAC3_BADD_OT_ID3;
3058 oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3059 build_connector_control(mixer, &oterm, false);
3066 * create mixer controls
3068 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3070 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
3072 struct mixer_build state;
3074 const struct usbmix_ctl_map *map;
3077 memset(&state, 0, sizeof(state));
3078 state.chip = mixer->chip;
3079 state.mixer = mixer;
3080 state.buffer = mixer->hostif->extra;
3081 state.buflen = mixer->hostif->extralen;
3083 /* check the mapping table */
3084 for (map = usbmix_ctl_maps; map->id; map++) {
3085 if (map->id == state.chip->usb_id) {
3086 state.map = map->map;
3087 state.selector_map = map->selector_map;
3088 mixer->ignore_ctl_error = map->ignore_ctl_error;
3094 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
3095 mixer->hostif->extralen,
3096 p, UAC_OUTPUT_TERMINAL)) != NULL) {
3097 if (!snd_usb_validate_audio_desc(p, mixer->protocol))
3098 continue; /* skip invalid descriptor */
3100 if (mixer->protocol == UAC_VERSION_1) {
3101 struct uac1_output_terminal_descriptor *desc = p;
3103 /* mark terminal ID as visited */
3104 set_bit(desc->bTerminalID, state.unitbitmap);
3105 state.oterm.id = desc->bTerminalID;
3106 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3107 state.oterm.name = desc->iTerminal;
3108 err = parse_audio_unit(&state, desc->bSourceID);
3109 if (err < 0 && err != -EINVAL)
3111 } else if (mixer->protocol == UAC_VERSION_2) {
3112 struct uac2_output_terminal_descriptor *desc = p;
3114 /* mark terminal ID as visited */
3115 set_bit(desc->bTerminalID, state.unitbitmap);
3116 state.oterm.id = desc->bTerminalID;
3117 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3118 state.oterm.name = desc->iTerminal;
3119 err = parse_audio_unit(&state, desc->bSourceID);
3120 if (err < 0 && err != -EINVAL)
3124 * For UAC2, use the same approach to also add the
3127 err = parse_audio_unit(&state, desc->bCSourceID);
3128 if (err < 0 && err != -EINVAL)
3131 if (uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3132 UAC2_TE_CONNECTOR)) {
3133 build_connector_control(state.mixer, &state.oterm,
3136 } else { /* UAC_VERSION_3 */
3137 struct uac3_output_terminal_descriptor *desc = p;
3139 /* mark terminal ID as visited */
3140 set_bit(desc->bTerminalID, state.unitbitmap);
3141 state.oterm.id = desc->bTerminalID;
3142 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3143 state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
3144 err = parse_audio_unit(&state, desc->bSourceID);
3145 if (err < 0 && err != -EINVAL)
3149 * For UAC3, use the same approach to also add the
3152 err = parse_audio_unit(&state, desc->bCSourceID);
3153 if (err < 0 && err != -EINVAL)
3156 if (uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
3157 UAC3_TE_INSERTION)) {
3158 build_connector_control(state.mixer, &state.oterm,
3167 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3169 struct usb_mixer_elem_list *list;
3171 for_each_mixer_elem(list, mixer, unitid) {
3172 struct usb_mixer_elem_info *info =
3173 mixer_elem_list_to_info(list);
3174 /* invalidate cache, so the value is read from the device */
3176 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3181 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3182 struct usb_mixer_elem_list *list)
3184 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3185 static const char * const val_types[] = {"BOOLEAN", "INV_BOOLEAN",
3186 "S8", "U8", "S16", "U16"};
3187 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
3188 "channels=%i, type=\"%s\"\n", cval->head.id,
3189 cval->control, cval->cmask, cval->channels,
3190 val_types[cval->val_type]);
3191 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3192 cval->min, cval->max, cval->dBmin, cval->dBmax);
3195 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
3196 struct snd_info_buffer *buffer)
3198 struct snd_usb_audio *chip = entry->private_data;
3199 struct usb_mixer_interface *mixer;
3200 struct usb_mixer_elem_list *list;
3203 list_for_each_entry(mixer, &chip->mixer_list, list) {
3205 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3206 chip->usb_id, snd_usb_ctrl_intf(chip),
3207 mixer->ignore_ctl_error);
3208 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
3209 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3210 for_each_mixer_elem(list, mixer, unitid) {
3211 snd_iprintf(buffer, " Unit: %i\n", list->id);
3214 " Control: name=\"%s\", index=%i\n",
3215 list->kctl->id.name,
3216 list->kctl->id.index);
3218 list->dump(buffer, list);
3224 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
3225 int attribute, int value, int index)
3227 struct usb_mixer_elem_list *list;
3228 __u8 unitid = (index >> 8) & 0xff;
3229 __u8 control = (value >> 8) & 0xff;
3230 __u8 channel = value & 0xff;
3231 unsigned int count = 0;
3233 if (channel >= MAX_CHANNELS) {
3234 usb_audio_dbg(mixer->chip,
3235 "%s(): bogus channel number %d\n",
3240 for_each_mixer_elem(list, mixer, unitid)
3246 for_each_mixer_elem(list, mixer, unitid) {
3247 struct usb_mixer_elem_info *info;
3252 info = mixer_elem_list_to_info(list);
3253 if (count > 1 && info->control != control)
3256 switch (attribute) {
3258 /* invalidate cache, so the value is read from the device */
3260 info->cached &= ~(1 << channel);
3261 else /* master channel */
3264 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3265 &info->head.kctl->id);
3277 usb_audio_dbg(mixer->chip,
3278 "unknown attribute %d in interrupt\n",
3285 static void snd_usb_mixer_interrupt(struct urb *urb)
3287 struct usb_mixer_interface *mixer = urb->context;
3288 int len = urb->actual_length;
3289 int ustatus = urb->status;
3294 if (mixer->protocol == UAC_VERSION_1) {
3295 struct uac1_status_word *status;
3297 for (status = urb->transfer_buffer;
3298 len >= sizeof(*status);
3299 len -= sizeof(*status), status++) {
3300 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3301 status->bStatusType,
3302 status->bOriginator);
3304 /* ignore any notifications not from the control interface */
3305 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
3306 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3309 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
3310 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3312 snd_usb_mixer_notify_id(mixer, status->bOriginator);
3314 } else { /* UAC_VERSION_2 */
3315 struct uac2_interrupt_data_msg *msg;
3317 for (msg = urb->transfer_buffer;
3318 len >= sizeof(*msg);
3319 len -= sizeof(*msg), msg++) {
3320 /* drop vendor specific and endpoint requests */
3321 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
3322 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
3325 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
3326 le16_to_cpu(msg->wValue),
3327 le16_to_cpu(msg->wIndex));
3332 if (ustatus != -ENOENT &&
3333 ustatus != -ECONNRESET &&
3334 ustatus != -ESHUTDOWN) {
3335 urb->dev = mixer->chip->dev;
3336 usb_submit_urb(urb, GFP_ATOMIC);
3340 /* create the handler for the optional status interrupt endpoint */
3341 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
3343 struct usb_endpoint_descriptor *ep;
3344 void *transfer_buffer;
3348 /* we need one interrupt input endpoint */
3349 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3351 ep = get_endpoint(mixer->hostif, 0);
3352 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3355 epnum = usb_endpoint_num(ep);
3356 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
3357 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
3358 if (!transfer_buffer)
3360 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
3362 kfree(transfer_buffer);
3365 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
3366 usb_rcvintpipe(mixer->chip->dev, epnum),
3367 transfer_buffer, buffer_length,
3368 snd_usb_mixer_interrupt, mixer, ep->bInterval);
3369 usb_submit_urb(mixer->urb, GFP_KERNEL);
3373 static int keep_iface_ctl_get(struct snd_kcontrol *kcontrol,
3374 struct snd_ctl_elem_value *ucontrol)
3376 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3378 ucontrol->value.integer.value[0] = mixer->chip->keep_iface;
3382 static int keep_iface_ctl_put(struct snd_kcontrol *kcontrol,
3383 struct snd_ctl_elem_value *ucontrol)
3385 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3386 bool keep_iface = !!ucontrol->value.integer.value[0];
3388 if (mixer->chip->keep_iface == keep_iface)
3390 mixer->chip->keep_iface = keep_iface;
3394 static const struct snd_kcontrol_new keep_iface_ctl = {
3395 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
3396 .name = "Keep Interface",
3397 .info = snd_ctl_boolean_mono_info,
3398 .get = keep_iface_ctl_get,
3399 .put = keep_iface_ctl_put,
3402 static int create_keep_iface_ctl(struct usb_mixer_interface *mixer)
3404 struct snd_kcontrol *kctl = snd_ctl_new1(&keep_iface_ctl, mixer);
3406 /* need only one control per card */
3407 if (snd_ctl_find_id(mixer->chip->card, &kctl->id)) {
3408 snd_ctl_free_one(kctl);
3412 return snd_ctl_add(mixer->chip->card, kctl);
3415 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
3418 static const struct snd_device_ops dev_ops = {
3419 .dev_free = snd_usb_mixer_dev_free
3421 struct usb_mixer_interface *mixer;
3424 strcpy(chip->card->mixername, "USB Mixer");
3426 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3430 mixer->ignore_ctl_error = ignore_error;
3431 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
3433 if (!mixer->id_elems) {
3438 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
3439 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3442 mixer->protocol = UAC_VERSION_1;
3445 mixer->protocol = UAC_VERSION_2;
3448 mixer->protocol = UAC_VERSION_3;
3452 if (mixer->protocol == UAC_VERSION_3 &&
3453 chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3454 err = snd_usb_mixer_controls_badd(mixer, ctrlif);
3458 err = snd_usb_mixer_controls(mixer);
3463 err = snd_usb_mixer_status_create(mixer);
3467 err = create_keep_iface_ctl(mixer);
3471 err = snd_usb_mixer_apply_create_quirk(mixer);
3475 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3479 if (list_empty(&chip->mixer_list))
3480 snd_card_ro_proc_new(chip->card, "usbmixer", chip,
3481 snd_usb_mixer_proc_read);
3483 list_add(&mixer->list, &chip->mixer_list);
3487 snd_usb_mixer_free(mixer);
3491 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3493 if (mixer->disconnected)
3496 usb_kill_urb(mixer->urb);
3498 usb_kill_urb(mixer->rc_urb);
3499 if (mixer->private_free)
3500 mixer->private_free(mixer);
3501 mixer->disconnected = true;
3505 /* stop any bus activity of a mixer */
3506 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
3508 usb_kill_urb(mixer->urb);
3509 usb_kill_urb(mixer->rc_urb);
3512 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
3517 err = usb_submit_urb(mixer->urb, GFP_NOIO);
3525 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
3527 snd_usb_mixer_inactivate(mixer);
3528 if (mixer->private_suspend)
3529 mixer->private_suspend(mixer);
3533 static int restore_mixer_value(struct usb_mixer_elem_list *list)
3535 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3540 for (c = 0; c < MAX_CHANNELS; c++) {
3541 if (!(cval->cmask & (1 << c)))
3543 if (cval->cached & (1 << (c + 1))) {
3544 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3545 cval->cache_val[idx]);
3554 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3563 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
3565 struct usb_mixer_elem_list *list;
3569 /* restore cached mixer values */
3570 for (id = 0; id < MAX_ID_ELEMS; id++) {
3571 for_each_mixer_elem(list, mixer, id) {
3573 err = list->resume(list);
3581 snd_usb_mixer_resume_quirk(mixer);
3583 return snd_usb_mixer_activate(mixer);
3587 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
3588 struct usb_mixer_interface *mixer,
3591 list->mixer = mixer;
3593 list->dump = snd_usb_mixer_dump_cval;
3595 list->resume = restore_mixer_value;