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 */
1305 /* if the max volume is too low, it's likely a bogus range;
1306 * here we use -96dB as the threshold
1308 if (cval->dBmax <= -9600) {
1309 usb_audio_info(cval->head.mixer->chip,
1310 "%d:%d: bogus dB values (%d/%d), disabling dB reporting\n",
1311 cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1312 cval->dBmin, cval->dBmax);
1313 cval->dBmin = cval->dBmax = 0;
1320 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1322 /* get a feature/mixer unit info */
1323 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1324 struct snd_ctl_elem_info *uinfo)
1326 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1328 if (cval->val_type == USB_MIXER_BOOLEAN ||
1329 cval->val_type == USB_MIXER_INV_BOOLEAN)
1330 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1332 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1333 uinfo->count = cval->channels;
1334 if (cval->val_type == USB_MIXER_BOOLEAN ||
1335 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1336 uinfo->value.integer.min = 0;
1337 uinfo->value.integer.max = 1;
1339 if (!cval->initialized) {
1340 get_min_max_with_quirks(cval, 0, kcontrol);
1341 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1342 kcontrol->vd[0].access &=
1343 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1344 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1345 snd_ctl_notify(cval->head.mixer->chip->card,
1346 SNDRV_CTL_EVENT_MASK_INFO,
1350 uinfo->value.integer.min = 0;
1351 uinfo->value.integer.max =
1352 (cval->max - cval->min + cval->res - 1) / cval->res;
1357 /* get the current value from feature/mixer unit */
1358 static int mixer_ctl_feature_get(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, err;
1364 ucontrol->value.integer.value[0] = cval->min;
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, &val);
1372 return filter_error(cval, err);
1373 val = get_relative_value(cval, val);
1374 ucontrol->value.integer.value[cnt] = val;
1379 /* master channel */
1380 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1382 return filter_error(cval, err);
1383 val = get_relative_value(cval, val);
1384 ucontrol->value.integer.value[0] = val;
1389 /* put the current value to feature/mixer unit */
1390 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1391 struct snd_ctl_elem_value *ucontrol)
1393 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1394 int c, cnt, val, oval, err;
1399 for (c = 0; c < MAX_CHANNELS; c++) {
1400 if (!(cval->cmask & (1 << c)))
1402 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1404 return filter_error(cval, err);
1405 val = ucontrol->value.integer.value[cnt];
1406 val = get_abs_value(cval, val);
1408 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1414 /* master channel */
1415 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1417 return filter_error(cval, err);
1418 val = ucontrol->value.integer.value[0];
1419 val = get_abs_value(cval, val);
1421 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1428 /* get the boolean value from the master channel of a UAC control */
1429 static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
1430 struct snd_ctl_elem_value *ucontrol)
1432 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1435 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1437 return filter_error(cval, err);
1439 ucontrol->value.integer.value[0] = val;
1443 /* get the connectors status and report it as boolean type */
1444 static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol,
1445 struct snd_ctl_elem_value *ucontrol)
1447 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1448 struct snd_usb_audio *chip = cval->head.mixer->chip;
1449 int idx = 0, validx, ret, val;
1451 validx = cval->control << 8 | 0;
1453 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
1457 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
1458 if (cval->head.mixer->protocol == UAC_VERSION_2) {
1459 struct uac2_connectors_ctl_blk uac2_conn;
1461 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1462 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1463 validx, idx, &uac2_conn, sizeof(uac2_conn));
1464 val = !!uac2_conn.bNrChannels;
1465 } else { /* UAC_VERSION_3 */
1466 struct uac3_insertion_ctl_blk uac3_conn;
1468 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1469 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1470 validx, idx, &uac3_conn, sizeof(uac3_conn));
1471 val = !!uac3_conn.bmConInserted;
1474 snd_usb_unlock_shutdown(chip);
1477 if (strstr(kcontrol->id.name, "Speaker")) {
1478 ucontrol->value.integer.value[0] = 1;
1483 "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1484 UAC_GET_CUR, validx, idx, cval->val_type);
1485 return filter_error(cval, ret);
1488 ucontrol->value.integer.value[0] = val;
1492 static const struct snd_kcontrol_new usb_feature_unit_ctl = {
1493 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1494 .name = "", /* will be filled later manually */
1495 .info = mixer_ctl_feature_info,
1496 .get = mixer_ctl_feature_get,
1497 .put = mixer_ctl_feature_put,
1500 /* the read-only variant */
1501 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1502 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1503 .name = "", /* will be filled later manually */
1504 .info = mixer_ctl_feature_info,
1505 .get = mixer_ctl_feature_get,
1510 * A control which shows the boolean value from reading a UAC control on
1511 * the master channel.
1513 static const struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1514 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1515 .name = "", /* will be filled later manually */
1516 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1517 .info = snd_ctl_boolean_mono_info,
1518 .get = mixer_ctl_master_bool_get,
1522 static const struct snd_kcontrol_new usb_connector_ctl_ro = {
1523 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1524 .name = "", /* will be filled later manually */
1525 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1526 .info = snd_ctl_boolean_mono_info,
1527 .get = mixer_ctl_connector_get,
1532 * This symbol is exported in order to allow the mixer quirks to
1533 * hook up to the standard feature unit control mechanism
1535 const struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1538 * build a feature control
1540 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1542 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1546 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1547 * rename it to "Headphone". We determine if something is a headphone
1548 * similar to how udev determines form factor.
1550 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1551 struct snd_card *card)
1553 const char *names_to_check[] = {
1554 "Headset", "headset", "Headphone", "headphone", NULL};
1558 if (strcmp("Speaker", kctl->id.name))
1561 for (s = names_to_check; *s; s++)
1562 if (strstr(card->shortname, *s)) {
1570 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1573 static const struct usb_feature_control_info *get_feature_control_info(int control)
1577 for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1578 if (audio_feature_info[i].control == control)
1579 return &audio_feature_info[i];
1584 static void __build_feature_ctl(struct usb_mixer_interface *mixer,
1585 const struct usbmix_name_map *imap,
1586 unsigned int ctl_mask, int control,
1587 struct usb_audio_term *iterm,
1588 struct usb_audio_term *oterm,
1589 int unitid, int nameid, int readonly_mask)
1591 const struct usb_feature_control_info *ctl_info;
1592 unsigned int len = 0;
1593 int mapped_name = 0;
1594 struct snd_kcontrol *kctl;
1595 struct usb_mixer_elem_info *cval;
1596 const struct usbmix_name_map *map;
1599 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1600 /* FIXME: not supported yet */
1604 map = find_map(imap, unitid, control);
1605 if (check_ignored_ctl(map))
1608 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1611 snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
1612 cval->control = control;
1613 cval->cmask = ctl_mask;
1615 ctl_info = get_feature_control_info(control);
1617 usb_mixer_elem_info_free(cval);
1620 if (mixer->protocol == UAC_VERSION_1)
1621 cval->val_type = ctl_info->type;
1622 else /* UAC_VERSION_2 */
1623 cval->val_type = ctl_info->type_uac2 >= 0 ?
1624 ctl_info->type_uac2 : ctl_info->type;
1626 if (ctl_mask == 0) {
1627 cval->channels = 1; /* master channel */
1628 cval->master_readonly = readonly_mask;
1631 for (i = 0; i < 16; i++)
1632 if (ctl_mask & (1 << i))
1635 cval->ch_readonly = readonly_mask;
1639 * If all channels in the mask are marked read-only, make the control
1640 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1641 * issue write commands to read-only channels.
1643 if (cval->channels == readonly_mask)
1644 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1646 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1649 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1650 usb_mixer_elem_info_free(cval);
1653 kctl->private_free = snd_usb_mixer_elem_free;
1655 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1656 mapped_name = len != 0;
1658 len = snd_usb_copy_string_desc(mixer->chip, nameid,
1659 kctl->id.name, sizeof(kctl->id.name));
1665 * determine the control name. the rule is:
1666 * - if a name id is given in descriptor, use it.
1667 * - if the connected input can be determined, then use the name
1669 * - if the connected output can be determined, use it.
1670 * - otherwise, anonymous name.
1674 len = get_term_name(mixer->chip, iterm,
1676 sizeof(kctl->id.name), 1);
1678 len = get_term_name(mixer->chip, oterm,
1680 sizeof(kctl->id.name), 1);
1682 snprintf(kctl->id.name, sizeof(kctl->id.name),
1683 "Feature %d", unitid);
1687 check_no_speaker_on_headset(kctl, mixer->chip->card);
1690 * determine the stream direction:
1691 * if the connected output is USB stream, then it's likely a
1692 * capture stream. otherwise it should be playback (hopefully :)
1694 if (!mapped_name && oterm && !(oterm->type >> 16)) {
1695 if ((oterm->type & 0xff00) == 0x0100)
1696 append_ctl_name(kctl, " Capture");
1698 append_ctl_name(kctl, " Playback");
1700 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1701 " Switch" : " Volume");
1705 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1706 sizeof(kctl->id.name));
1710 /* get min/max values */
1711 get_min_max_with_quirks(cval, 0, kctl);
1713 /* skip a bogus volume range */
1714 if (cval->max <= cval->min) {
1715 usb_audio_dbg(mixer->chip,
1716 "[%d] FU [%s] skipped due to invalid volume\n",
1717 cval->head.id, kctl->id.name);
1718 snd_ctl_free_one(kctl);
1723 if (control == UAC_FU_VOLUME) {
1724 check_mapped_dB(map, cval);
1725 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1726 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1727 kctl->vd[0].access |=
1728 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1729 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1733 snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1735 range = (cval->max - cval->min) / cval->res;
1737 * Are there devices with volume range more than 255? I use a bit more
1738 * to be sure. 384 is a resolution magic number found on Logitech
1739 * devices. It will definitively catch all buggy Logitech devices.
1742 usb_audio_warn(mixer->chip,
1743 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1745 usb_audio_warn(mixer->chip,
1746 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1747 cval->head.id, kctl->id.name, cval->channels,
1748 cval->min, cval->max, cval->res);
1751 usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1752 cval->head.id, kctl->id.name, cval->channels,
1753 cval->min, cval->max, cval->res);
1754 snd_usb_mixer_add_control(&cval->head, kctl);
1757 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1758 unsigned int ctl_mask, int control,
1759 struct usb_audio_term *iterm, int unitid,
1762 struct uac_feature_unit_descriptor *desc = raw_desc;
1763 int nameid = uac_feature_unit_iFeature(desc);
1765 __build_feature_ctl(state->mixer, state->map, ctl_mask, control,
1766 iterm, &state->oterm, unitid, nameid, readonly_mask);
1769 static void build_feature_ctl_badd(struct usb_mixer_interface *mixer,
1770 unsigned int ctl_mask, int control, int unitid,
1771 const struct usbmix_name_map *badd_map)
1773 __build_feature_ctl(mixer, badd_map, ctl_mask, control,
1774 NULL, NULL, unitid, 0, 0);
1777 static void get_connector_control_name(struct usb_mixer_interface *mixer,
1778 struct usb_audio_term *term,
1779 bool is_input, char *name, int name_size)
1781 int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1784 strlcpy(name, "Unknown", name_size);
1787 * sound/core/ctljack.c has a convention of naming jack controls
1788 * by ending in " Jack". Make it slightly more useful by
1789 * indicating Input or Output after the terminal name.
1792 strlcat(name, " - Input Jack", name_size);
1794 strlcat(name, " - Output Jack", name_size);
1797 /* Build a mixer control for a UAC connector control (jack-detect) */
1798 static void build_connector_control(struct usb_mixer_interface *mixer,
1799 const struct usbmix_name_map *imap,
1800 struct usb_audio_term *term, bool is_input)
1802 struct snd_kcontrol *kctl;
1803 struct usb_mixer_elem_info *cval;
1804 const struct usbmix_name_map *map;
1806 map = find_map(imap, term->id, 0);
1807 if (check_ignored_ctl(map))
1810 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1813 snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1815 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1816 * number of channels connected.
1818 * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1819 * following byte(s) specifies which connectors are inserted.
1821 * This boolean ctl will simply report if any channels are connected
1824 if (mixer->protocol == UAC_VERSION_2)
1825 cval->control = UAC2_TE_CONNECTOR;
1826 else /* UAC_VERSION_3 */
1827 cval->control = UAC3_TE_INSERTION;
1829 cval->val_type = USB_MIXER_BOOLEAN;
1830 cval->channels = 1; /* report true if any channel is connected */
1833 kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1835 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1836 usb_mixer_elem_info_free(cval);
1840 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)))
1841 strlcat(kctl->id.name, " Jack", sizeof(kctl->id.name));
1843 get_connector_control_name(mixer, term, is_input, kctl->id.name,
1844 sizeof(kctl->id.name));
1845 kctl->private_free = snd_usb_mixer_elem_free;
1846 snd_usb_mixer_add_control(&cval->head, kctl);
1849 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1852 struct uac_clock_source_descriptor *hdr = _ftr;
1853 struct usb_mixer_elem_info *cval;
1854 struct snd_kcontrol *kctl;
1855 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1858 if (state->mixer->protocol != UAC_VERSION_2)
1862 * The only property of this unit we are interested in is the
1863 * clock source validity. If that isn't readable, just bail out.
1865 if (!uac_v2v3_control_is_readable(hdr->bmControls,
1866 UAC2_CS_CONTROL_CLOCK_VALID))
1869 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1873 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1878 cval->val_type = USB_MIXER_BOOLEAN;
1879 cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1881 cval->master_readonly = 1;
1882 /* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1883 kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1886 usb_mixer_elem_info_free(cval);
1890 kctl->private_free = snd_usb_mixer_elem_free;
1891 ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1892 name, sizeof(name));
1894 snprintf(kctl->id.name, sizeof(kctl->id.name),
1895 "%s Validity", name);
1897 snprintf(kctl->id.name, sizeof(kctl->id.name),
1898 "Clock Source %d Validity", hdr->bClockID);
1900 return snd_usb_mixer_add_control(&cval->head, kctl);
1904 * parse a feature unit
1906 * most of controls are defined here.
1908 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1912 struct usb_audio_term iterm;
1913 unsigned int master_bits;
1915 struct uac_feature_unit_descriptor *hdr = _ftr;
1918 if (state->mixer->protocol == UAC_VERSION_1) {
1919 csize = hdr->bControlSize;
1920 channels = (hdr->bLength - 7) / csize - 1;
1921 bmaControls = hdr->bmaControls;
1922 } else if (state->mixer->protocol == UAC_VERSION_2) {
1923 struct uac2_feature_unit_descriptor *ftr = _ftr;
1925 channels = (hdr->bLength - 6) / 4 - 1;
1926 bmaControls = ftr->bmaControls;
1927 } else { /* UAC_VERSION_3 */
1928 struct uac3_feature_unit_descriptor *ftr = _ftr;
1931 channels = (ftr->bLength - 7) / 4 - 1;
1932 bmaControls = ftr->bmaControls;
1935 /* parse the source unit */
1936 err = parse_audio_unit(state, hdr->bSourceID);
1940 /* determine the input source type and name */
1941 err = check_input_term(state, hdr->bSourceID, &iterm);
1945 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1946 /* master configuration quirks */
1947 switch (state->chip->usb_id) {
1948 case USB_ID(0x08bb, 0x2702):
1949 usb_audio_info(state->chip,
1950 "usbmixer: master volume quirk for PCM2702 chip\n");
1951 /* disable non-functional volume control */
1952 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1954 case USB_ID(0x1130, 0xf211):
1955 usb_audio_info(state->chip,
1956 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1957 /* disable non-functional volume control */
1963 if (state->mixer->protocol == UAC_VERSION_1) {
1964 /* check all control types */
1965 for (i = 0; i < 10; i++) {
1966 unsigned int ch_bits = 0;
1967 int control = audio_feature_info[i].control;
1969 for (j = 0; j < channels; j++) {
1972 mask = snd_usb_combine_bytes(bmaControls +
1973 csize * (j+1), csize);
1974 if (mask & (1 << i))
1975 ch_bits |= (1 << j);
1977 /* audio class v1 controls are never read-only */
1980 * The first channel must be set
1981 * (for ease of programming).
1984 build_feature_ctl(state, _ftr, ch_bits, control,
1986 if (master_bits & (1 << i))
1987 build_feature_ctl(state, _ftr, 0, control,
1990 } else { /* UAC_VERSION_2/3 */
1991 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1992 unsigned int ch_bits = 0;
1993 unsigned int ch_read_only = 0;
1994 int control = audio_feature_info[i].control;
1996 for (j = 0; j < channels; j++) {
1999 mask = snd_usb_combine_bytes(bmaControls +
2000 csize * (j+1), csize);
2001 if (uac_v2v3_control_is_readable(mask, control)) {
2002 ch_bits |= (1 << j);
2003 if (!uac_v2v3_control_is_writeable(mask, control))
2004 ch_read_only |= (1 << j);
2009 * NOTE: build_feature_ctl() will mark the control
2010 * read-only if all channels are marked read-only in
2011 * the descriptors. Otherwise, the control will be
2012 * reported as writeable, but the driver will not
2013 * actually issue a write command for read-only
2018 * The first channel must be set
2019 * (for ease of programming).
2022 build_feature_ctl(state, _ftr, ch_bits, control,
2023 &iterm, unitid, ch_read_only);
2024 if (uac_v2v3_control_is_readable(master_bits, control))
2025 build_feature_ctl(state, _ftr, 0, control,
2027 !uac_v2v3_control_is_writeable(master_bits,
2039 /* check whether the given in/out overflows bmMixerControls matrix */
2040 static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc,
2041 int protocol, int num_ins, int num_outs)
2043 u8 *hdr = (u8 *)desc;
2044 u8 *c = uac_mixer_unit_bmControls(desc, protocol);
2045 size_t rest; /* remaining bytes after bmMixerControls */
2050 rest = 1; /* iMixer */
2053 rest = 2; /* bmControls + iMixer */
2056 rest = 6; /* bmControls + wMixerDescrStr */
2061 return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
2065 * build a mixer unit control
2067 * the callbacks are identical with feature unit.
2068 * input channel number (zero based) is given in control field instead.
2070 static void build_mixer_unit_ctl(struct mixer_build *state,
2071 struct uac_mixer_unit_descriptor *desc,
2072 int in_pin, int in_ch, int num_outs,
2073 int unitid, struct usb_audio_term *iterm)
2075 struct usb_mixer_elem_info *cval;
2076 unsigned int i, len;
2077 struct snd_kcontrol *kctl;
2078 const struct usbmix_name_map *map;
2080 map = find_map(state->map, unitid, 0);
2081 if (check_ignored_ctl(map))
2084 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2088 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2089 cval->control = in_ch + 1; /* based on 1 */
2090 cval->val_type = USB_MIXER_S16;
2091 for (i = 0; i < num_outs; i++) {
2092 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
2094 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
2095 cval->cmask |= (1 << i);
2100 /* get min/max values */
2101 get_min_max(cval, 0);
2103 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2105 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2106 usb_mixer_elem_info_free(cval);
2109 kctl->private_free = snd_usb_mixer_elem_free;
2111 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2113 len = get_term_name(state->chip, iterm, kctl->id.name,
2114 sizeof(kctl->id.name), 0);
2116 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
2117 append_ctl_name(kctl, " Volume");
2119 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2120 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
2121 snd_usb_mixer_add_control(&cval->head, kctl);
2124 static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
2127 struct usb_audio_term iterm;
2128 unsigned int control, bmctls, term_id;
2130 if (state->mixer->protocol == UAC_VERSION_2) {
2131 struct uac2_input_terminal_descriptor *d_v2 = raw_desc;
2132 control = UAC2_TE_CONNECTOR;
2133 term_id = d_v2->bTerminalID;
2134 bmctls = le16_to_cpu(d_v2->bmControls);
2135 } else if (state->mixer->protocol == UAC_VERSION_3) {
2136 struct uac3_input_terminal_descriptor *d_v3 = raw_desc;
2137 control = UAC3_TE_INSERTION;
2138 term_id = d_v3->bTerminalID;
2139 bmctls = le32_to_cpu(d_v3->bmControls);
2141 return 0; /* UAC1. No Insertion control */
2144 check_input_term(state, term_id, &iterm);
2146 /* Check for jack detection. */
2147 if ((iterm.type & 0xff00) != 0x0100 &&
2148 uac_v2v3_control_is_readable(bmctls, control))
2149 build_connector_control(state->mixer, state->map, &iterm, true);
2155 * parse a mixer unit
2157 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
2160 struct uac_mixer_unit_descriptor *desc = raw_desc;
2161 struct usb_audio_term iterm;
2162 int input_pins, num_ins, num_outs;
2165 err = uac_mixer_unit_get_channels(state, desc);
2167 usb_audio_err(state->chip,
2168 "invalid MIXER UNIT descriptor %d\n",
2174 input_pins = desc->bNrInPins;
2178 for (pin = 0; pin < input_pins; pin++) {
2179 err = parse_audio_unit(state, desc->baSourceID[pin]);
2182 /* no bmControls field (e.g. Maya44) -> ignore */
2185 err = check_input_term(state, desc->baSourceID[pin], &iterm);
2188 num_ins += iterm.channels;
2189 if (mixer_bitmap_overflow(desc, state->mixer->protocol,
2192 for (; ich < num_ins; ich++) {
2193 int och, ich_has_controls = 0;
2195 for (och = 0; och < num_outs; och++) {
2196 __u8 *c = uac_mixer_unit_bmControls(desc,
2197 state->mixer->protocol);
2199 if (check_matrix_bitmap(c, ich, och, num_outs)) {
2200 ich_has_controls = 1;
2204 if (ich_has_controls)
2205 build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
2213 * Processing Unit / Extension Unit
2216 /* get callback for processing/extension unit */
2217 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
2218 struct snd_ctl_elem_value *ucontrol)
2220 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2223 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2225 ucontrol->value.integer.value[0] = cval->min;
2226 return filter_error(cval, err);
2228 val = get_relative_value(cval, val);
2229 ucontrol->value.integer.value[0] = val;
2233 /* put callback for processing/extension unit */
2234 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
2235 struct snd_ctl_elem_value *ucontrol)
2237 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2240 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2242 return filter_error(cval, err);
2243 val = ucontrol->value.integer.value[0];
2244 val = get_abs_value(cval, val);
2246 set_cur_ctl_value(cval, cval->control << 8, val);
2252 /* alsa control interface for processing/extension unit */
2253 static const struct snd_kcontrol_new mixer_procunit_ctl = {
2254 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2255 .name = "", /* will be filled later */
2256 .info = mixer_ctl_feature_info,
2257 .get = mixer_ctl_procunit_get,
2258 .put = mixer_ctl_procunit_put,
2262 * predefined data for processing units
2264 struct procunit_value_info {
2271 struct procunit_info {
2274 const struct procunit_value_info *values;
2277 static const struct procunit_value_info undefined_proc_info[] = {
2278 { 0x00, "Control Undefined", 0 },
2282 static const struct procunit_value_info updown_proc_info[] = {
2283 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2284 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2287 static const struct procunit_value_info prologic_proc_info[] = {
2288 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2289 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2292 static const struct procunit_value_info threed_enh_proc_info[] = {
2293 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2294 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2297 static const struct procunit_value_info reverb_proc_info[] = {
2298 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2299 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2300 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2301 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2304 static const struct procunit_value_info chorus_proc_info[] = {
2305 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2306 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2307 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2308 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2311 static const struct procunit_value_info dcr_proc_info[] = {
2312 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2313 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2314 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2315 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2316 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2317 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2321 static const struct procunit_info procunits[] = {
2322 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2323 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2324 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2325 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2326 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2327 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2331 static const struct procunit_value_info uac3_updown_proc_info[] = {
2332 { UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2335 static const struct procunit_value_info uac3_stereo_ext_proc_info[] = {
2336 { UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
2340 static const struct procunit_info uac3_procunits[] = {
2341 { UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info },
2342 { UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info },
2343 { UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info },
2348 * predefined data for extension units
2350 static const struct procunit_value_info clock_rate_xu_info[] = {
2351 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2354 static const struct procunit_value_info clock_source_xu_info[] = {
2355 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2358 static const struct procunit_value_info spdif_format_xu_info[] = {
2359 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2362 static const struct procunit_value_info soft_limit_xu_info[] = {
2363 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2366 static const struct procunit_info extunits[] = {
2367 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2368 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2369 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2370 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2375 * build a processing/extension unit
2377 static int build_audio_procunit(struct mixer_build *state, int unitid,
2378 void *raw_desc, const struct procunit_info *list,
2379 bool extension_unit)
2381 struct uac_processing_unit_descriptor *desc = raw_desc;
2383 struct usb_mixer_elem_info *cval;
2384 struct snd_kcontrol *kctl;
2385 int i, err, nameid, type, len, val;
2386 const struct procunit_info *info;
2387 const struct procunit_value_info *valinfo;
2388 const struct usbmix_name_map *map;
2389 static const struct procunit_value_info default_value_info[] = {
2390 { 0x01, "Switch", USB_MIXER_BOOLEAN },
2393 static const struct procunit_info default_info = {
2394 0, NULL, default_value_info
2396 const char *name = extension_unit ?
2397 "Extension Unit" : "Processing Unit";
2399 num_ins = desc->bNrInPins;
2400 for (i = 0; i < num_ins; i++) {
2401 err = parse_audio_unit(state, desc->baSourceID[i]);
2406 type = le16_to_cpu(desc->wProcessType);
2407 for (info = list; info && info->type; info++)
2408 if (info->type == type)
2410 if (!info || !info->type)
2411 info = &default_info;
2413 for (valinfo = info->values; valinfo->control; valinfo++) {
2414 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2416 if (state->mixer->protocol == UAC_VERSION_1) {
2417 if (!(controls[valinfo->control / 8] &
2418 (1 << ((valinfo->control % 8) - 1))))
2420 } else { /* UAC_VERSION_2/3 */
2421 if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
2426 map = find_map(state->map, unitid, valinfo->control);
2427 if (check_ignored_ctl(map))
2429 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2432 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2433 cval->control = valinfo->control;
2434 cval->val_type = valinfo->val_type;
2437 if (state->mixer->protocol > UAC_VERSION_1 &&
2438 !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
2440 cval->master_readonly = 1;
2442 /* get min/max values */
2444 case UAC_PROCESS_UP_DOWNMIX: {
2445 bool mode_sel = false;
2447 switch (state->mixer->protocol) {
2451 if (cval->control == UAC_UD_MODE_SELECT)
2455 if (cval->control == UAC3_UD_MODE_SELECT)
2461 __u8 *control_spec = uac_processing_unit_specific(desc,
2462 state->mixer->protocol);
2464 cval->max = control_spec[0];
2466 cval->initialized = 1;
2470 get_min_max(cval, valinfo->min_value);
2473 case USB_XU_CLOCK_RATE:
2475 * E-Mu USB 0404/0202/TrackerPre/0204
2476 * samplerate control quirk
2481 cval->initialized = 1;
2484 get_min_max(cval, valinfo->min_value);
2488 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2490 usb_mixer_elem_info_free(cval);
2494 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2496 usb_mixer_elem_info_free(cval);
2499 kctl->private_free = snd_usb_mixer_elem_free;
2501 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2503 } else if (info->name) {
2504 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2507 nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
2509 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2512 len = snd_usb_copy_string_desc(state->chip,
2515 sizeof(kctl->id.name));
2517 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
2519 append_ctl_name(kctl, " ");
2520 append_ctl_name(kctl, valinfo->suffix);
2522 usb_audio_dbg(state->chip,
2523 "[%d] PU [%s] ch = %d, val = %d/%d\n",
2524 cval->head.id, kctl->id.name, cval->channels,
2525 cval->min, cval->max);
2527 err = snd_usb_mixer_add_control(&cval->head, kctl);
2534 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2537 switch (state->mixer->protocol) {
2541 return build_audio_procunit(state, unitid, raw_desc,
2544 return build_audio_procunit(state, unitid, raw_desc,
2545 uac3_procunits, false);
2549 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2553 * Note that we parse extension units with processing unit descriptors.
2554 * That's ok as the layout is the same.
2556 return build_audio_procunit(state, unitid, raw_desc, extunits, true);
2564 * info callback for selector unit
2565 * use an enumerator type for routing
2567 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2568 struct snd_ctl_elem_info *uinfo)
2570 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2571 const char **itemlist = (const char **)kcontrol->private_value;
2573 if (snd_BUG_ON(!itemlist))
2575 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2578 /* get callback for selector unit */
2579 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2580 struct snd_ctl_elem_value *ucontrol)
2582 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2585 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2587 ucontrol->value.enumerated.item[0] = 0;
2588 return filter_error(cval, err);
2590 val = get_relative_value(cval, val);
2591 ucontrol->value.enumerated.item[0] = val;
2595 /* put callback for selector unit */
2596 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2597 struct snd_ctl_elem_value *ucontrol)
2599 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2602 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2604 return filter_error(cval, err);
2605 val = ucontrol->value.enumerated.item[0];
2606 val = get_abs_value(cval, val);
2608 set_cur_ctl_value(cval, cval->control << 8, val);
2614 /* alsa control interface for selector unit */
2615 static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2616 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2617 .name = "", /* will be filled later */
2618 .info = mixer_ctl_selector_info,
2619 .get = mixer_ctl_selector_get,
2620 .put = mixer_ctl_selector_put,
2624 * private free callback.
2625 * free both private_data and private_value
2627 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2631 if (kctl->private_data) {
2632 struct usb_mixer_elem_info *cval = kctl->private_data;
2633 num_ins = cval->max;
2634 usb_mixer_elem_info_free(cval);
2635 kctl->private_data = NULL;
2637 if (kctl->private_value) {
2638 char **itemlist = (char **)kctl->private_value;
2639 for (i = 0; i < num_ins; i++)
2642 kctl->private_value = 0;
2647 * parse a selector unit
2649 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2652 struct uac_selector_unit_descriptor *desc = raw_desc;
2653 unsigned int i, nameid, len;
2655 struct usb_mixer_elem_info *cval;
2656 struct snd_kcontrol *kctl;
2657 const struct usbmix_name_map *map;
2660 for (i = 0; i < desc->bNrInPins; i++) {
2661 err = parse_audio_unit(state, desc->baSourceID[i]);
2666 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2669 map = find_map(state->map, unitid, 0);
2670 if (check_ignored_ctl(map))
2673 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2676 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2677 cval->val_type = USB_MIXER_U8;
2680 cval->max = desc->bNrInPins;
2682 cval->initialized = 1;
2684 switch (state->mixer->protocol) {
2691 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2692 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2693 cval->control = UAC2_CX_CLOCK_SELECTOR;
2694 else /* UAC2/3_SELECTOR_UNIT */
2695 cval->control = UAC2_SU_SELECTOR;
2699 namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2704 #define MAX_ITEM_NAME_LEN 64
2705 for (i = 0; i < desc->bNrInPins; i++) {
2706 struct usb_audio_term iterm;
2708 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2713 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2715 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2716 len = get_term_name(state->chip, &iterm, namelist[i],
2717 MAX_ITEM_NAME_LEN, 0);
2719 sprintf(namelist[i], "Input %u", i);
2722 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2724 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2728 kctl->private_value = (unsigned long)namelist;
2729 kctl->private_free = usb_mixer_selector_elem_free;
2731 /* check the static mapping table at first */
2732 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2735 switch (state->mixer->protocol) {
2739 /* if iSelector is given, use it */
2740 nameid = uac_selector_unit_iSelector(desc);
2742 len = snd_usb_copy_string_desc(state->chip,
2743 nameid, kctl->id.name,
2744 sizeof(kctl->id.name));
2747 /* TODO: Class-Specific strings not yet supported */
2751 /* ... or pick up the terminal name at next */
2753 len = get_term_name(state->chip, &state->oterm,
2754 kctl->id.name, sizeof(kctl->id.name), 0);
2755 /* ... or use the fixed string "USB" as the last resort */
2757 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2759 /* and add the proper suffix */
2760 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2761 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2762 append_ctl_name(kctl, " Clock Source");
2763 else if ((state->oterm.type & 0xff00) == 0x0100)
2764 append_ctl_name(kctl, " Capture Source");
2766 append_ctl_name(kctl, " Playback Source");
2769 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2770 cval->head.id, kctl->id.name, desc->bNrInPins);
2771 return snd_usb_mixer_add_control(&cval->head, kctl);
2774 for (i = 0; i < desc->bNrInPins; i++)
2778 usb_mixer_elem_info_free(cval);
2783 * parse an audio unit recursively
2786 static int parse_audio_unit(struct mixer_build *state, int unitid)
2789 int protocol = state->mixer->protocol;
2791 if (test_and_set_bit(unitid, state->unitbitmap))
2792 return 0; /* the unit already visited */
2794 p1 = find_audio_control_unit(state, unitid);
2796 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2800 if (!snd_usb_validate_audio_desc(p1, protocol)) {
2801 usb_audio_dbg(state->chip, "invalid unit %d\n", unitid);
2802 return 0; /* skip invalid unit */
2805 switch (PTYPE(protocol, p1[2])) {
2806 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
2807 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
2808 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
2809 return parse_audio_input_terminal(state, unitid, p1);
2810 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
2811 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
2812 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
2813 return parse_audio_mixer_unit(state, unitid, p1);
2814 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
2815 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
2816 return parse_clock_source_unit(state, unitid, p1);
2817 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
2818 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
2819 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
2820 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
2821 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
2822 return parse_audio_selector_unit(state, unitid, p1);
2823 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
2824 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
2825 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT):
2826 return parse_audio_feature_unit(state, unitid, p1);
2827 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
2828 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
2829 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
2830 return parse_audio_processing_unit(state, unitid, p1);
2831 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
2832 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
2833 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
2834 return parse_audio_extension_unit(state, unitid, p1);
2835 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
2836 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
2837 return 0; /* FIXME - effect units not implemented yet */
2839 usb_audio_err(state->chip,
2840 "unit %u: unexpected type 0x%02x\n",
2846 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2848 /* kill pending URBs */
2849 snd_usb_mixer_disconnect(mixer);
2851 kfree(mixer->id_elems);
2853 kfree(mixer->urb->transfer_buffer);
2854 usb_free_urb(mixer->urb);
2856 usb_free_urb(mixer->rc_urb);
2857 kfree(mixer->rc_setup_packet);
2861 static int snd_usb_mixer_dev_free(struct snd_device *device)
2863 struct usb_mixer_interface *mixer = device->device_data;
2864 snd_usb_mixer_free(mixer);
2868 /* UAC3 predefined channels configuration */
2869 struct uac3_badd_profile {
2872 int c_chmask; /* capture channels mask */
2873 int p_chmask; /* playback channels mask */
2874 int st_chmask; /* side tone mixing channel mask */
2877 static const struct uac3_badd_profile uac3_badd_profiles[] = {
2880 * BAIF, BAOF or combination of both
2881 * IN: Mono or Stereo cfg, Mono alt possible
2882 * OUT: Mono or Stereo cfg, Mono alt possible
2884 .subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
2885 .name = "GENERIC IO",
2886 .c_chmask = -1, /* dynamic channels */
2887 .p_chmask = -1, /* dynamic channels */
2890 /* BAOF; Stereo only cfg, Mono alt possible */
2891 .subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
2892 .name = "HEADPHONE",
2896 /* BAOF; Mono or Stereo cfg, Mono alt possible */
2897 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
2899 .p_chmask = -1, /* dynamic channels */
2902 /* BAIF; Mono or Stereo cfg, Mono alt possible */
2903 .subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
2904 .name = "MICROPHONE",
2905 .c_chmask = -1, /* dynamic channels */
2911 * OUT: Mono or Stereo cfg, Mono alt possible
2913 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
2916 .p_chmask = -1, /* dynamic channels */
2920 /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
2921 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
2922 .name = "HEADSET ADAPTER",
2928 /* BAIF + BAOF; IN: Mono only; OUT: Mono only */
2929 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
2930 .name = "SPEAKERPHONE",
2934 { 0 } /* terminator */
2937 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
2938 const struct uac3_badd_profile *f,
2939 int c_chmask, int p_chmask)
2942 * If both playback/capture channels are dynamic, make sure
2943 * at least one channel is present
2945 if (f->c_chmask < 0 && f->p_chmask < 0) {
2946 if (!c_chmask && !p_chmask) {
2947 usb_audio_warn(mixer->chip, "BAAD %s: no channels?",
2954 if ((f->c_chmask < 0 && !c_chmask) ||
2955 (f->c_chmask >= 0 && f->c_chmask != c_chmask)) {
2956 usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch",
2960 if ((f->p_chmask < 0 && !p_chmask) ||
2961 (f->p_chmask >= 0 && f->p_chmask != p_chmask)) {
2962 usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch",
2970 * create mixer controls for UAC3 BADD profiles
2972 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
2974 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
2976 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
2979 struct usb_device *dev = mixer->chip->dev;
2980 struct usb_interface_assoc_descriptor *assoc;
2981 int badd_profile = mixer->chip->badd_profile;
2982 const struct uac3_badd_profile *f;
2983 const struct usbmix_ctl_map *map;
2984 int p_chmask = 0, c_chmask = 0, st_chmask = 0;
2987 assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
2989 /* Detect BADD capture/playback channels from AS EP descriptors */
2990 for (i = 0; i < assoc->bInterfaceCount; i++) {
2991 int intf = assoc->bFirstInterface + i;
2993 struct usb_interface *iface;
2994 struct usb_host_interface *alts;
2995 struct usb_interface_descriptor *altsd;
2996 unsigned int maxpacksize;
3003 iface = usb_ifnum_to_if(dev, intf);
3007 num = iface->num_altsetting;
3013 * The number of Channels in an AudioStreaming interface
3014 * and the audio sample bit resolution (16 bits or 24
3015 * bits) can be derived from the wMaxPacketSize field in
3016 * the Standard AS Audio Data Endpoint descriptor in
3017 * Alternate Setting 1
3019 alts = &iface->altsetting[1];
3020 altsd = get_iface_desc(alts);
3022 if (altsd->bNumEndpoints < 1)
3025 /* check direction */
3026 dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
3027 maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3029 switch (maxpacksize) {
3031 usb_audio_err(mixer->chip,
3032 "incorrect wMaxPacketSize 0x%x for BADD profile\n",
3035 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
3036 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
3037 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
3038 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
3041 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
3042 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
3043 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
3044 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
3055 usb_audio_dbg(mixer->chip,
3056 "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
3057 badd_profile, c_chmask, p_chmask);
3059 /* check the mapping table */
3060 for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
3061 if (map->id == badd_profile)
3068 for (f = uac3_badd_profiles; f->name; f++) {
3069 if (badd_profile == f->subclass)
3074 if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
3076 st_chmask = f->st_chmask;
3080 /* Master channel, always writable */
3081 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3082 UAC3_BADD_FU_ID2, map->map);
3083 /* Mono/Stereo volume channels, always writable */
3084 build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
3085 UAC3_BADD_FU_ID2, map->map);
3090 /* Master channel, always writable */
3091 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3092 UAC3_BADD_FU_ID5, map->map);
3093 /* Mono/Stereo volume channels, always writable */
3094 build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
3095 UAC3_BADD_FU_ID5, map->map);
3098 /* Side tone-mixing */
3100 /* Master channel, always writable */
3101 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3102 UAC3_BADD_FU_ID7, map->map);
3103 /* Mono volume channel, always writable */
3104 build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
3105 UAC3_BADD_FU_ID7, map->map);
3108 /* Insertion Control */
3109 if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
3110 struct usb_audio_term iterm, oterm;
3112 /* Input Term - Insertion control */
3113 memset(&iterm, 0, sizeof(iterm));
3114 iterm.id = UAC3_BADD_IT_ID4;
3115 iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3116 build_connector_control(mixer, map->map, &iterm, true);
3118 /* Output Term - Insertion control */
3119 memset(&oterm, 0, sizeof(oterm));
3120 oterm.id = UAC3_BADD_OT_ID3;
3121 oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3122 build_connector_control(mixer, map->map, &oterm, false);
3129 * create mixer controls
3131 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3133 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
3135 struct mixer_build state;
3137 const struct usbmix_ctl_map *map;
3140 memset(&state, 0, sizeof(state));
3141 state.chip = mixer->chip;
3142 state.mixer = mixer;
3143 state.buffer = mixer->hostif->extra;
3144 state.buflen = mixer->hostif->extralen;
3146 /* check the mapping table */
3147 for (map = usbmix_ctl_maps; map->id; map++) {
3148 if (map->id == state.chip->usb_id) {
3149 state.map = map->map;
3150 state.selector_map = map->selector_map;
3151 mixer->connector_map = map->connector_map;
3152 mixer->ignore_ctl_error |= map->ignore_ctl_error;
3158 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
3159 mixer->hostif->extralen,
3160 p, UAC_OUTPUT_TERMINAL)) != NULL) {
3161 if (!snd_usb_validate_audio_desc(p, mixer->protocol))
3162 continue; /* skip invalid descriptor */
3164 if (mixer->protocol == UAC_VERSION_1) {
3165 struct uac1_output_terminal_descriptor *desc = p;
3167 /* mark terminal ID as visited */
3168 set_bit(desc->bTerminalID, state.unitbitmap);
3169 state.oterm.id = desc->bTerminalID;
3170 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3171 state.oterm.name = desc->iTerminal;
3172 err = parse_audio_unit(&state, desc->bSourceID);
3173 if (err < 0 && err != -EINVAL)
3175 } else if (mixer->protocol == UAC_VERSION_2) {
3176 struct uac2_output_terminal_descriptor *desc = p;
3178 /* mark terminal ID as visited */
3179 set_bit(desc->bTerminalID, state.unitbitmap);
3180 state.oterm.id = desc->bTerminalID;
3181 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3182 state.oterm.name = desc->iTerminal;
3183 err = parse_audio_unit(&state, desc->bSourceID);
3184 if (err < 0 && err != -EINVAL)
3188 * For UAC2, use the same approach to also add the
3191 err = parse_audio_unit(&state, desc->bCSourceID);
3192 if (err < 0 && err != -EINVAL)
3195 if ((state.oterm.type & 0xff00) != 0x0100 &&
3196 uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3197 UAC2_TE_CONNECTOR)) {
3198 build_connector_control(state.mixer, state.map,
3199 &state.oterm, false);
3201 } else { /* UAC_VERSION_3 */
3202 struct uac3_output_terminal_descriptor *desc = p;
3204 /* mark terminal ID as visited */
3205 set_bit(desc->bTerminalID, state.unitbitmap);
3206 state.oterm.id = desc->bTerminalID;
3207 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3208 state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
3209 err = parse_audio_unit(&state, desc->bSourceID);
3210 if (err < 0 && err != -EINVAL)
3214 * For UAC3, use the same approach to also add the
3217 err = parse_audio_unit(&state, desc->bCSourceID);
3218 if (err < 0 && err != -EINVAL)
3221 if ((state.oterm.type & 0xff00) != 0x0100 &&
3222 uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
3223 UAC3_TE_INSERTION)) {
3224 build_connector_control(state.mixer, state.map,
3225 &state.oterm, false);
3233 static int delegate_notify(struct usb_mixer_interface *mixer, int unitid,
3234 u8 *control, u8 *channel)
3236 const struct usbmix_connector_map *map = mixer->connector_map;
3241 for (; map->id; map++) {
3242 if (map->id == unitid) {
3243 if (control && map->control)
3244 *control = map->control;
3245 if (channel && map->channel)
3246 *channel = map->channel;
3247 return map->delegated_id;
3253 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3255 struct usb_mixer_elem_list *list;
3257 unitid = delegate_notify(mixer, unitid, NULL, NULL);
3259 for_each_mixer_elem(list, mixer, unitid) {
3260 struct usb_mixer_elem_info *info;
3262 if (!list->is_std_info)
3264 info = mixer_elem_list_to_info(list);
3265 /* invalidate cache, so the value is read from the device */
3267 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3272 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3273 struct usb_mixer_elem_list *list)
3275 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3276 static const char * const val_types[] = {
3277 [USB_MIXER_BOOLEAN] = "BOOLEAN",
3278 [USB_MIXER_INV_BOOLEAN] = "INV_BOOLEAN",
3279 [USB_MIXER_S8] = "S8",
3280 [USB_MIXER_U8] = "U8",
3281 [USB_MIXER_S16] = "S16",
3282 [USB_MIXER_U16] = "U16",
3283 [USB_MIXER_S32] = "S32",
3284 [USB_MIXER_U32] = "U32",
3285 [USB_MIXER_BESPOKEN] = "BESPOKEN",
3287 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
3288 "channels=%i, type=\"%s\"\n", cval->head.id,
3289 cval->control, cval->cmask, cval->channels,
3290 val_types[cval->val_type]);
3291 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3292 cval->min, cval->max, cval->dBmin, cval->dBmax);
3295 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
3296 struct snd_info_buffer *buffer)
3298 struct snd_usb_audio *chip = entry->private_data;
3299 struct usb_mixer_interface *mixer;
3300 struct usb_mixer_elem_list *list;
3303 list_for_each_entry(mixer, &chip->mixer_list, list) {
3305 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3306 chip->usb_id, mixer_ctrl_intf(mixer),
3307 mixer->ignore_ctl_error);
3308 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
3309 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3310 for_each_mixer_elem(list, mixer, unitid) {
3311 snd_iprintf(buffer, " Unit: %i\n", list->id);
3314 " Control: name=\"%s\", index=%i\n",
3315 list->kctl->id.name,
3316 list->kctl->id.index);
3318 list->dump(buffer, list);
3324 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
3325 int attribute, int value, int index)
3327 struct usb_mixer_elem_list *list;
3328 __u8 unitid = (index >> 8) & 0xff;
3329 __u8 control = (value >> 8) & 0xff;
3330 __u8 channel = value & 0xff;
3331 unsigned int count = 0;
3333 if (channel >= MAX_CHANNELS) {
3334 usb_audio_dbg(mixer->chip,
3335 "%s(): bogus channel number %d\n",
3340 unitid = delegate_notify(mixer, unitid, &control, &channel);
3342 for_each_mixer_elem(list, mixer, unitid)
3348 for_each_mixer_elem(list, mixer, unitid) {
3349 struct usb_mixer_elem_info *info;
3353 if (!list->is_std_info)
3356 info = mixer_elem_list_to_info(list);
3357 if (count > 1 && info->control != control)
3360 switch (attribute) {
3362 /* invalidate cache, so the value is read from the device */
3364 info->cached &= ~(1 << channel);
3365 else /* master channel */
3368 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3369 &info->head.kctl->id);
3381 usb_audio_dbg(mixer->chip,
3382 "unknown attribute %d in interrupt\n",
3389 static void snd_usb_mixer_interrupt(struct urb *urb)
3391 struct usb_mixer_interface *mixer = urb->context;
3392 int len = urb->actual_length;
3393 int ustatus = urb->status;
3398 if (mixer->protocol == UAC_VERSION_1) {
3399 struct uac1_status_word *status;
3401 for (status = urb->transfer_buffer;
3402 len >= sizeof(*status);
3403 len -= sizeof(*status), status++) {
3404 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3405 status->bStatusType,
3406 status->bOriginator);
3408 /* ignore any notifications not from the control interface */
3409 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
3410 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3413 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
3414 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3416 snd_usb_mixer_notify_id(mixer, status->bOriginator);
3418 } else { /* UAC_VERSION_2 */
3419 struct uac2_interrupt_data_msg *msg;
3421 for (msg = urb->transfer_buffer;
3422 len >= sizeof(*msg);
3423 len -= sizeof(*msg), msg++) {
3424 /* drop vendor specific and endpoint requests */
3425 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
3426 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
3429 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
3430 le16_to_cpu(msg->wValue),
3431 le16_to_cpu(msg->wIndex));
3436 if (ustatus != -ENOENT &&
3437 ustatus != -ECONNRESET &&
3438 ustatus != -ESHUTDOWN) {
3439 urb->dev = mixer->chip->dev;
3440 usb_submit_urb(urb, GFP_ATOMIC);
3444 /* create the handler for the optional status interrupt endpoint */
3445 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
3447 struct usb_endpoint_descriptor *ep;
3448 void *transfer_buffer;
3452 /* we need one interrupt input endpoint */
3453 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3455 ep = get_endpoint(mixer->hostif, 0);
3456 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3459 epnum = usb_endpoint_num(ep);
3460 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
3461 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
3462 if (!transfer_buffer)
3464 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
3466 kfree(transfer_buffer);
3469 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
3470 usb_rcvintpipe(mixer->chip->dev, epnum),
3471 transfer_buffer, buffer_length,
3472 snd_usb_mixer_interrupt, mixer, ep->bInterval);
3473 usb_submit_urb(mixer->urb, GFP_KERNEL);
3477 static int keep_iface_ctl_get(struct snd_kcontrol *kcontrol,
3478 struct snd_ctl_elem_value *ucontrol)
3480 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3482 ucontrol->value.integer.value[0] = mixer->chip->keep_iface;
3486 static int keep_iface_ctl_put(struct snd_kcontrol *kcontrol,
3487 struct snd_ctl_elem_value *ucontrol)
3489 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3490 bool keep_iface = !!ucontrol->value.integer.value[0];
3492 if (mixer->chip->keep_iface == keep_iface)
3494 mixer->chip->keep_iface = keep_iface;
3498 static const struct snd_kcontrol_new keep_iface_ctl = {
3499 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
3500 .name = "Keep Interface",
3501 .info = snd_ctl_boolean_mono_info,
3502 .get = keep_iface_ctl_get,
3503 .put = keep_iface_ctl_put,
3506 static int create_keep_iface_ctl(struct usb_mixer_interface *mixer)
3508 struct snd_kcontrol *kctl = snd_ctl_new1(&keep_iface_ctl, mixer);
3510 /* need only one control per card */
3511 if (snd_ctl_find_id(mixer->chip->card, &kctl->id)) {
3512 snd_ctl_free_one(kctl);
3516 return snd_ctl_add(mixer->chip->card, kctl);
3519 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
3522 static const struct snd_device_ops dev_ops = {
3523 .dev_free = snd_usb_mixer_dev_free
3525 struct usb_mixer_interface *mixer;
3528 strcpy(chip->card->mixername, "USB Mixer");
3530 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3534 mixer->ignore_ctl_error = ignore_error;
3535 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
3537 if (!mixer->id_elems) {
3542 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
3543 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3546 mixer->protocol = UAC_VERSION_1;
3549 mixer->protocol = UAC_VERSION_2;
3552 mixer->protocol = UAC_VERSION_3;
3556 if (mixer->protocol == UAC_VERSION_3 &&
3557 chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3558 err = snd_usb_mixer_controls_badd(mixer, ctrlif);
3562 err = snd_usb_mixer_controls(mixer);
3567 err = snd_usb_mixer_status_create(mixer);
3571 err = create_keep_iface_ctl(mixer);
3575 err = snd_usb_mixer_apply_create_quirk(mixer);
3579 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3583 if (list_empty(&chip->mixer_list))
3584 snd_card_ro_proc_new(chip->card, "usbmixer", chip,
3585 snd_usb_mixer_proc_read);
3587 list_add(&mixer->list, &chip->mixer_list);
3591 snd_usb_mixer_free(mixer);
3595 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3597 if (mixer->disconnected)
3600 usb_kill_urb(mixer->urb);
3602 usb_kill_urb(mixer->rc_urb);
3603 if (mixer->private_free)
3604 mixer->private_free(mixer);
3605 mixer->disconnected = true;
3609 /* stop any bus activity of a mixer */
3610 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
3612 usb_kill_urb(mixer->urb);
3613 usb_kill_urb(mixer->rc_urb);
3616 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
3621 err = usb_submit_urb(mixer->urb, GFP_NOIO);
3629 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
3631 snd_usb_mixer_inactivate(mixer);
3632 if (mixer->private_suspend)
3633 mixer->private_suspend(mixer);
3637 static int restore_mixer_value(struct usb_mixer_elem_list *list)
3639 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3642 if (cval->val_type == USB_MIXER_BESPOKEN)
3647 for (c = 0; c < MAX_CHANNELS; c++) {
3648 if (!(cval->cmask & (1 << c)))
3650 if (cval->cached & (1 << (c + 1))) {
3651 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3652 cval->cache_val[idx]);
3661 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3670 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
3672 struct usb_mixer_elem_list *list;
3676 /* restore cached mixer values */
3677 for (id = 0; id < MAX_ID_ELEMS; id++) {
3678 for_each_mixer_elem(list, mixer, id) {
3680 err = list->resume(list);
3688 snd_usb_mixer_resume_quirk(mixer);
3690 return snd_usb_mixer_activate(mixer);
3694 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
3695 struct usb_mixer_interface *mixer,
3698 list->mixer = mixer;
3700 list->dump = snd_usb_mixer_dump_cval;
3702 list->resume = restore_mixer_value;