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 if (desc->bLength < sizeof(*desc))
745 if (!desc->bNrInPins)
747 if (desc->bLength < sizeof(*desc) + desc->bNrInPins)
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 the source unit recursively until it reaches to a terminal
769 * or a branched unit.
771 static int __check_input_term(struct mixer_build *state, int id,
772 struct usb_audio_term *term)
774 int protocol = state->mixer->protocol;
779 memset(term, 0, sizeof(*term));
781 /* a loop in the terminal chain? */
782 if (test_and_set_bit(id, state->termbitmap))
785 p1 = find_audio_control_unit(state, id);
792 if (protocol == UAC_VERSION_1 || protocol == UAC_VERSION_2) {
794 case UAC_INPUT_TERMINAL:
795 if (protocol == UAC_VERSION_1) {
796 struct uac_input_terminal_descriptor *d = p1;
798 term->type = le16_to_cpu(d->wTerminalType);
799 term->channels = d->bNrChannels;
800 term->chconfig = le16_to_cpu(d->wChannelConfig);
801 term->name = d->iTerminal;
802 } else { /* UAC_VERSION_2 */
803 struct uac2_input_terminal_descriptor *d = p1;
805 /* call recursively to verify that the
806 * referenced clock entity is valid */
807 err = __check_input_term(state, d->bCSourceID, term);
811 /* save input term properties after recursion,
812 * to ensure they are not overriden by the
815 term->type = le16_to_cpu(d->wTerminalType);
816 term->channels = d->bNrChannels;
817 term->chconfig = le32_to_cpu(d->bmChannelConfig);
818 term->name = d->iTerminal;
821 case UAC_FEATURE_UNIT: {
822 /* the header is the same for v1 and v2 */
823 struct uac_feature_unit_descriptor *d = p1;
826 break; /* continue to parse */
828 case UAC_MIXER_UNIT: {
829 struct uac_mixer_unit_descriptor *d = p1;
831 term->type = UAC3_MIXER_UNIT << 16; /* virtual type */
832 term->channels = uac_mixer_unit_bNrChannels(d);
833 term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
834 term->name = uac_mixer_unit_iMixer(d);
837 case UAC_SELECTOR_UNIT:
838 case UAC2_CLOCK_SELECTOR: {
839 struct uac_selector_unit_descriptor *d = p1;
840 /* call recursively to retrieve the channel info */
841 err = __check_input_term(state, d->baSourceID[0], term);
844 term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */
846 term->name = uac_selector_unit_iSelector(d);
849 case UAC1_PROCESSING_UNIT:
850 /* UAC2_EFFECT_UNIT */
851 if (protocol == UAC_VERSION_1)
852 term->type = UAC3_PROCESSING_UNIT << 16; /* virtual type */
853 else /* UAC_VERSION_2 */
854 term->type = UAC3_EFFECT_UNIT << 16; /* virtual type */
856 case UAC1_EXTENSION_UNIT:
857 /* UAC2_PROCESSING_UNIT_V2 */
858 if (protocol == UAC_VERSION_1 && !term->type)
859 term->type = UAC3_EXTENSION_UNIT << 16; /* virtual type */
860 else if (protocol == UAC_VERSION_2 && !term->type)
861 term->type = UAC3_PROCESSING_UNIT << 16; /* virtual type */
863 case UAC2_EXTENSION_UNIT_V2: {
864 struct uac_processing_unit_descriptor *d = p1;
866 if (protocol == UAC_VERSION_2 &&
867 hdr[2] == UAC2_EFFECT_UNIT) {
868 /* UAC2/UAC1 unit IDs overlap here in an
869 * uncompatible way. Ignore this unit for now.
875 id = d->baSourceID[0];
876 break; /* continue to parse */
879 term->type = UAC3_EXTENSION_UNIT << 16; /* virtual type */
881 term->channels = uac_processing_unit_bNrChannels(d);
882 term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
883 term->name = uac_processing_unit_iProcessing(d, protocol);
886 case UAC2_CLOCK_SOURCE: {
887 struct uac_clock_source_descriptor *d = p1;
889 term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
891 term->name = d->iClockSource;
897 } else { /* UAC_VERSION_3 */
899 case UAC_INPUT_TERMINAL: {
900 struct uac3_input_terminal_descriptor *d = p1;
902 /* call recursively to verify that the
903 * referenced clock entity is valid */
904 err = __check_input_term(state, d->bCSourceID, term);
908 /* save input term properties after recursion,
909 * to ensure they are not overriden by the
912 term->type = le16_to_cpu(d->wTerminalType);
914 err = get_cluster_channels_v3(state, le16_to_cpu(d->wClusterDescrID));
917 term->channels = err;
919 /* REVISIT: UAC3 IT doesn't have channels cfg */
922 term->name = le16_to_cpu(d->wTerminalDescrStr);
925 case UAC3_FEATURE_UNIT: {
926 struct uac3_feature_unit_descriptor *d = p1;
929 break; /* continue to parse */
931 case UAC3_CLOCK_SOURCE: {
932 struct uac3_clock_source_descriptor *d = p1;
934 term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
936 term->name = le16_to_cpu(d->wClockSourceStr);
939 case UAC3_MIXER_UNIT: {
940 struct uac_mixer_unit_descriptor *d = p1;
942 err = uac_mixer_unit_get_channels(state, d);
946 term->channels = err;
947 term->type = UAC3_MIXER_UNIT << 16; /* virtual type */
951 case UAC3_SELECTOR_UNIT:
952 case UAC3_CLOCK_SELECTOR: {
953 struct uac_selector_unit_descriptor *d = p1;
954 /* call recursively to retrieve the channel info */
955 err = __check_input_term(state, d->baSourceID[0], term);
958 term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */
960 term->name = 0; /* TODO: UAC3 Class-specific strings */
964 case UAC3_PROCESSING_UNIT: {
965 struct uac_processing_unit_descriptor *d = p1;
970 /* call recursively to retrieve the channel info */
971 err = __check_input_term(state, d->baSourceID[0], term);
975 term->type = UAC3_PROCESSING_UNIT << 16; /* virtual type */
977 term->name = 0; /* TODO: UAC3 Class-specific strings */
990 static int check_input_term(struct mixer_build *state, int id,
991 struct usb_audio_term *term)
993 memset(term, 0, sizeof(*term));
994 memset(state->termbitmap, 0, sizeof(state->termbitmap));
995 return __check_input_term(state, id, term);
1002 /* feature unit control information */
1003 struct usb_feature_control_info {
1006 int type; /* data type for uac1 */
1007 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
1010 static struct usb_feature_control_info audio_feature_info[] = {
1011 { UAC_FU_MUTE, "Mute", USB_MIXER_INV_BOOLEAN, -1 },
1012 { UAC_FU_VOLUME, "Volume", USB_MIXER_S16, -1 },
1013 { UAC_FU_BASS, "Tone Control - Bass", USB_MIXER_S8, -1 },
1014 { UAC_FU_MID, "Tone Control - Mid", USB_MIXER_S8, -1 },
1015 { UAC_FU_TREBLE, "Tone Control - Treble", USB_MIXER_S8, -1 },
1016 { UAC_FU_GRAPHIC_EQUALIZER, "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemented yet */
1017 { UAC_FU_AUTOMATIC_GAIN, "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
1018 { UAC_FU_DELAY, "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
1019 { UAC_FU_BASS_BOOST, "Bass Boost", USB_MIXER_BOOLEAN, -1 },
1020 { UAC_FU_LOUDNESS, "Loudness", USB_MIXER_BOOLEAN, -1 },
1022 { UAC2_FU_INPUT_GAIN, "Input Gain Control", USB_MIXER_S16, -1 },
1023 { UAC2_FU_INPUT_GAIN_PAD, "Input Gain Pad Control", USB_MIXER_S16, -1 },
1024 { UAC2_FU_PHASE_INVERTER, "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
1027 /* private_free callback */
1028 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
1030 kfree(kctl->private_data);
1031 kctl->private_data = NULL;
1035 * interface to ALSA control for feature/mixer units
1038 /* volume control quirks */
1039 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
1040 struct snd_kcontrol *kctl)
1042 struct snd_usb_audio *chip = cval->head.mixer->chip;
1043 switch (chip->usb_id) {
1044 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
1045 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
1046 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1052 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1053 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1058 if (strstr(kctl->id.name, "Effect Return") != NULL) {
1064 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1065 (strstr(kctl->id.name, "Effect Send") != NULL)) {
1066 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
1072 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
1073 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
1074 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1075 usb_audio_info(chip,
1076 "set quirk for FTU Effect Duration\n");
1082 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1083 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1084 usb_audio_info(chip,
1085 "set quirks for FTU Effect Feedback/Volume\n");
1092 case USB_ID(0x0d8c, 0x0103):
1093 if (!strcmp(kctl->id.name, "PCM Playback Volume")) {
1094 usb_audio_info(chip,
1095 "set volume quirk for CM102-A+/102S+\n");
1100 case USB_ID(0x0471, 0x0101):
1101 case USB_ID(0x0471, 0x0104):
1102 case USB_ID(0x0471, 0x0105):
1103 case USB_ID(0x0672, 0x1041):
1104 /* quirk for UDA1321/N101.
1105 * note that detection between firmware 2.1.1.7 (N101)
1106 * and later 2.1.1.21 is not very clear from datasheets.
1107 * I hope that the min value is -15360 for newer firmware --jk
1109 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
1110 cval->min == -15616) {
1111 usb_audio_info(chip,
1112 "set volume quirk for UDA1321/N101 chip\n");
1117 case USB_ID(0x046d, 0x09a4):
1118 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1119 usb_audio_info(chip,
1120 "set volume quirk for QuickCam E3500\n");
1127 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
1128 case USB_ID(0x046d, 0x0808):
1129 case USB_ID(0x046d, 0x0809):
1130 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1131 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1132 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1133 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1134 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1135 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1136 case USB_ID(0x046d, 0x0991):
1137 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1138 /* Most audio usb devices lie about volume resolution.
1139 * Most Logitech webcams have res = 384.
1140 * Probably there is some logitech magic behind this number --fishor
1142 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1143 usb_audio_info(chip,
1144 "set resolution quirk: cval->res = 384\n");
1152 * retrieve the minimum and maximum values for the specified control
1154 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1155 int default_min, struct snd_kcontrol *kctl)
1158 cval->min = default_min;
1159 cval->max = cval->min + 1;
1161 cval->dBmin = cval->dBmax = 0;
1163 if (cval->val_type == USB_MIXER_BOOLEAN ||
1164 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1165 cval->initialized = 1;
1170 for (i = 0; i < MAX_CHANNELS; i++)
1171 if (cval->cmask & (1 << i)) {
1176 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
1177 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1178 usb_audio_err(cval->head.mixer->chip,
1179 "%d:%d: cannot get min/max values for control %d (id %d)\n",
1180 cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
1181 cval->control, cval->head.id);
1184 if (get_ctl_value(cval, UAC_GET_RES,
1185 (cval->control << 8) | minchn,
1189 int last_valid_res = cval->res;
1191 while (cval->res > 1) {
1192 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1193 (cval->control << 8) | minchn,
1198 if (get_ctl_value(cval, UAC_GET_RES,
1199 (cval->control << 8) | minchn, &cval->res) < 0)
1200 cval->res = last_valid_res;
1205 /* Additional checks for the proper resolution
1207 * Some devices report smaller resolutions than actually
1208 * reacting. They don't return errors but simply clip
1209 * to the lower aligned value.
1211 if (cval->min + cval->res < cval->max) {
1212 int last_valid_res = cval->res;
1213 int saved, test, check;
1214 get_cur_mix_raw(cval, minchn, &saved);
1217 if (test < cval->max)
1221 if (test < cval->min || test > cval->max ||
1222 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1223 get_cur_mix_raw(cval, minchn, &check)) {
1224 cval->res = last_valid_res;
1231 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1234 cval->initialized = 1;
1238 volume_control_quirks(cval, kctl);
1240 /* USB descriptions contain the dB scale in 1/256 dB unit
1241 * while ALSA TLV contains in 1/100 dB unit
1243 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1244 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1245 if (cval->dBmin > cval->dBmax) {
1246 /* something is wrong; assume it's either from/to 0dB */
1247 if (cval->dBmin < 0)
1249 else if (cval->dBmin > 0)
1251 if (cval->dBmin > cval->dBmax) {
1252 /* totally crap, return an error */
1260 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1262 /* get a feature/mixer unit info */
1263 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1264 struct snd_ctl_elem_info *uinfo)
1266 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1268 if (cval->val_type == USB_MIXER_BOOLEAN ||
1269 cval->val_type == USB_MIXER_INV_BOOLEAN)
1270 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1272 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1273 uinfo->count = cval->channels;
1274 if (cval->val_type == USB_MIXER_BOOLEAN ||
1275 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1276 uinfo->value.integer.min = 0;
1277 uinfo->value.integer.max = 1;
1279 if (!cval->initialized) {
1280 get_min_max_with_quirks(cval, 0, kcontrol);
1281 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1282 kcontrol->vd[0].access &=
1283 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1284 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1285 snd_ctl_notify(cval->head.mixer->chip->card,
1286 SNDRV_CTL_EVENT_MASK_INFO,
1290 uinfo->value.integer.min = 0;
1291 uinfo->value.integer.max =
1292 (cval->max - cval->min + cval->res - 1) / cval->res;
1297 /* get the current value from feature/mixer unit */
1298 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1299 struct snd_ctl_elem_value *ucontrol)
1301 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1302 int c, cnt, val, err;
1304 ucontrol->value.integer.value[0] = cval->min;
1307 for (c = 0; c < MAX_CHANNELS; c++) {
1308 if (!(cval->cmask & (1 << c)))
1310 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1312 return filter_error(cval, err);
1313 val = get_relative_value(cval, val);
1314 ucontrol->value.integer.value[cnt] = val;
1319 /* master channel */
1320 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1322 return filter_error(cval, err);
1323 val = get_relative_value(cval, val);
1324 ucontrol->value.integer.value[0] = val;
1329 /* put the current value to feature/mixer unit */
1330 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1331 struct snd_ctl_elem_value *ucontrol)
1333 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1334 int c, cnt, val, oval, err;
1339 for (c = 0; c < MAX_CHANNELS; c++) {
1340 if (!(cval->cmask & (1 << c)))
1342 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1344 return filter_error(cval, err);
1345 val = ucontrol->value.integer.value[cnt];
1346 val = get_abs_value(cval, val);
1348 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1354 /* master channel */
1355 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1357 return filter_error(cval, err);
1358 val = ucontrol->value.integer.value[0];
1359 val = get_abs_value(cval, val);
1361 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1368 /* get the boolean value from the master channel of a UAC control */
1369 static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
1370 struct snd_ctl_elem_value *ucontrol)
1372 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1375 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1377 return filter_error(cval, err);
1379 ucontrol->value.integer.value[0] = val;
1383 /* get the connectors status and report it as boolean type */
1384 static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol,
1385 struct snd_ctl_elem_value *ucontrol)
1387 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1388 struct snd_usb_audio *chip = cval->head.mixer->chip;
1389 int idx = 0, validx, ret, val;
1391 validx = cval->control << 8 | 0;
1393 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
1397 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
1398 if (cval->head.mixer->protocol == UAC_VERSION_2) {
1399 struct uac2_connectors_ctl_blk uac2_conn;
1401 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1402 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1403 validx, idx, &uac2_conn, sizeof(uac2_conn));
1404 val = !!uac2_conn.bNrChannels;
1405 } else { /* UAC_VERSION_3 */
1406 struct uac3_insertion_ctl_blk uac3_conn;
1408 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1409 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1410 validx, idx, &uac3_conn, sizeof(uac3_conn));
1411 val = !!uac3_conn.bmConInserted;
1414 snd_usb_unlock_shutdown(chip);
1419 "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1420 UAC_GET_CUR, validx, idx, cval->val_type);
1424 ucontrol->value.integer.value[0] = val;
1428 static struct snd_kcontrol_new usb_feature_unit_ctl = {
1429 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1430 .name = "", /* will be filled later manually */
1431 .info = mixer_ctl_feature_info,
1432 .get = mixer_ctl_feature_get,
1433 .put = mixer_ctl_feature_put,
1436 /* the read-only variant */
1437 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1438 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1439 .name = "", /* will be filled later manually */
1440 .info = mixer_ctl_feature_info,
1441 .get = mixer_ctl_feature_get,
1446 * A control which shows the boolean value from reading a UAC control on
1447 * the master channel.
1449 static struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1450 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1451 .name = "", /* will be filled later manually */
1452 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1453 .info = snd_ctl_boolean_mono_info,
1454 .get = mixer_ctl_master_bool_get,
1458 static const struct snd_kcontrol_new usb_connector_ctl_ro = {
1459 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1460 .name = "", /* will be filled later manually */
1461 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1462 .info = snd_ctl_boolean_mono_info,
1463 .get = mixer_ctl_connector_get,
1468 * This symbol is exported in order to allow the mixer quirks to
1469 * hook up to the standard feature unit control mechanism
1471 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1474 * build a feature control
1476 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1478 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1482 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1483 * rename it to "Headphone". We determine if something is a headphone
1484 * similar to how udev determines form factor.
1486 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1487 struct snd_card *card)
1489 const char *names_to_check[] = {
1490 "Headset", "headset", "Headphone", "headphone", NULL};
1494 if (strcmp("Speaker", kctl->id.name))
1497 for (s = names_to_check; *s; s++)
1498 if (strstr(card->shortname, *s)) {
1506 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1509 static struct usb_feature_control_info *get_feature_control_info(int control)
1513 for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1514 if (audio_feature_info[i].control == control)
1515 return &audio_feature_info[i];
1520 static void __build_feature_ctl(struct usb_mixer_interface *mixer,
1521 const struct usbmix_name_map *imap,
1522 unsigned int ctl_mask, int control,
1523 struct usb_audio_term *iterm,
1524 struct usb_audio_term *oterm,
1525 int unitid, int nameid, int readonly_mask)
1527 struct usb_feature_control_info *ctl_info;
1528 unsigned int len = 0;
1529 int mapped_name = 0;
1530 struct snd_kcontrol *kctl;
1531 struct usb_mixer_elem_info *cval;
1532 const struct usbmix_name_map *map;
1535 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1536 /* FIXME: not supported yet */
1540 map = find_map(imap, unitid, control);
1541 if (check_ignored_ctl(map))
1544 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1547 snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
1548 cval->control = control;
1549 cval->cmask = ctl_mask;
1551 ctl_info = get_feature_control_info(control);
1556 if (mixer->protocol == UAC_VERSION_1)
1557 cval->val_type = ctl_info->type;
1558 else /* UAC_VERSION_2 */
1559 cval->val_type = ctl_info->type_uac2 >= 0 ?
1560 ctl_info->type_uac2 : ctl_info->type;
1562 if (ctl_mask == 0) {
1563 cval->channels = 1; /* master channel */
1564 cval->master_readonly = readonly_mask;
1567 for (i = 0; i < 16; i++)
1568 if (ctl_mask & (1 << i))
1571 cval->ch_readonly = readonly_mask;
1575 * If all channels in the mask are marked read-only, make the control
1576 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1577 * issue write commands to read-only channels.
1579 if (cval->channels == readonly_mask)
1580 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1582 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1585 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1589 kctl->private_free = snd_usb_mixer_elem_free;
1591 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1592 mapped_name = len != 0;
1594 len = snd_usb_copy_string_desc(mixer->chip, nameid,
1595 kctl->id.name, sizeof(kctl->id.name));
1601 * determine the control name. the rule is:
1602 * - if a name id is given in descriptor, use it.
1603 * - if the connected input can be determined, then use the name
1605 * - if the connected output can be determined, use it.
1606 * - otherwise, anonymous name.
1610 len = get_term_name(mixer->chip, iterm,
1612 sizeof(kctl->id.name), 1);
1614 len = get_term_name(mixer->chip, oterm,
1616 sizeof(kctl->id.name), 1);
1618 snprintf(kctl->id.name, sizeof(kctl->id.name),
1619 "Feature %d", unitid);
1623 check_no_speaker_on_headset(kctl, mixer->chip->card);
1626 * determine the stream direction:
1627 * if the connected output is USB stream, then it's likely a
1628 * capture stream. otherwise it should be playback (hopefully :)
1630 if (!mapped_name && oterm && !(oterm->type >> 16)) {
1631 if ((oterm->type & 0xff00) == 0x0100)
1632 append_ctl_name(kctl, " Capture");
1634 append_ctl_name(kctl, " Playback");
1636 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1637 " Switch" : " Volume");
1641 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1642 sizeof(kctl->id.name));
1646 /* get min/max values */
1647 get_min_max_with_quirks(cval, 0, kctl);
1649 if (control == UAC_FU_VOLUME) {
1650 check_mapped_dB(map, cval);
1651 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1652 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1653 kctl->vd[0].access |=
1654 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1655 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1659 snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1661 range = (cval->max - cval->min) / cval->res;
1663 * Are there devices with volume range more than 255? I use a bit more
1664 * to be sure. 384 is a resolution magic number found on Logitech
1665 * devices. It will definitively catch all buggy Logitech devices.
1668 usb_audio_warn(mixer->chip,
1669 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1671 usb_audio_warn(mixer->chip,
1672 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1673 cval->head.id, kctl->id.name, cval->channels,
1674 cval->min, cval->max, cval->res);
1677 usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1678 cval->head.id, kctl->id.name, cval->channels,
1679 cval->min, cval->max, cval->res);
1680 snd_usb_mixer_add_control(&cval->head, kctl);
1683 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1684 unsigned int ctl_mask, int control,
1685 struct usb_audio_term *iterm, int unitid,
1688 struct uac_feature_unit_descriptor *desc = raw_desc;
1689 int nameid = uac_feature_unit_iFeature(desc);
1691 __build_feature_ctl(state->mixer, state->map, ctl_mask, control,
1692 iterm, &state->oterm, unitid, nameid, readonly_mask);
1695 static void build_feature_ctl_badd(struct usb_mixer_interface *mixer,
1696 unsigned int ctl_mask, int control, int unitid,
1697 const struct usbmix_name_map *badd_map)
1699 __build_feature_ctl(mixer, badd_map, ctl_mask, control,
1700 NULL, NULL, unitid, 0, 0);
1703 static void get_connector_control_name(struct usb_mixer_interface *mixer,
1704 struct usb_audio_term *term,
1705 bool is_input, char *name, int name_size)
1707 int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1710 strlcpy(name, "Unknown", name_size);
1713 * sound/core/ctljack.c has a convention of naming jack controls
1714 * by ending in " Jack". Make it slightly more useful by
1715 * indicating Input or Output after the terminal name.
1718 strlcat(name, " - Input Jack", name_size);
1720 strlcat(name, " - Output Jack", name_size);
1723 /* Build a mixer control for a UAC connector control (jack-detect) */
1724 static void build_connector_control(struct usb_mixer_interface *mixer,
1725 struct usb_audio_term *term, bool is_input)
1727 struct snd_kcontrol *kctl;
1728 struct usb_mixer_elem_info *cval;
1730 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1733 snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1735 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1736 * number of channels connected.
1738 * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1739 * following byte(s) specifies which connectors are inserted.
1741 * This boolean ctl will simply report if any channels are connected
1744 if (mixer->protocol == UAC_VERSION_2)
1745 cval->control = UAC2_TE_CONNECTOR;
1746 else /* UAC_VERSION_3 */
1747 cval->control = UAC3_TE_INSERTION;
1749 cval->val_type = USB_MIXER_BOOLEAN;
1750 cval->channels = 1; /* report true if any channel is connected */
1753 kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1755 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1759 get_connector_control_name(mixer, term, is_input, kctl->id.name,
1760 sizeof(kctl->id.name));
1761 kctl->private_free = snd_usb_mixer_elem_free;
1762 snd_usb_mixer_add_control(&cval->head, kctl);
1765 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1768 struct uac_clock_source_descriptor *hdr = _ftr;
1769 struct usb_mixer_elem_info *cval;
1770 struct snd_kcontrol *kctl;
1771 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1774 if (state->mixer->protocol != UAC_VERSION_2)
1777 if (hdr->bLength != sizeof(*hdr)) {
1778 usb_audio_dbg(state->chip,
1779 "Bogus clock source descriptor length of %d, ignoring.\n",
1785 * The only property of this unit we are interested in is the
1786 * clock source validity. If that isn't readable, just bail out.
1788 if (!uac_v2v3_control_is_readable(hdr->bmControls,
1789 UAC2_CS_CONTROL_CLOCK_VALID))
1792 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1796 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1801 cval->val_type = USB_MIXER_BOOLEAN;
1802 cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1804 cval->master_readonly = 1;
1805 /* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1806 kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1813 kctl->private_free = snd_usb_mixer_elem_free;
1814 ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1815 name, sizeof(name));
1817 snprintf(kctl->id.name, sizeof(kctl->id.name),
1818 "%s Validity", name);
1820 snprintf(kctl->id.name, sizeof(kctl->id.name),
1821 "Clock Source %d Validity", hdr->bClockID);
1823 return snd_usb_mixer_add_control(&cval->head, kctl);
1827 * parse a feature unit
1829 * most of controls are defined here.
1831 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1835 struct usb_audio_term iterm;
1836 unsigned int master_bits;
1838 struct uac_feature_unit_descriptor *hdr = _ftr;
1841 if (state->mixer->protocol == UAC_VERSION_1) {
1842 if (hdr->bLength < 7) {
1843 usb_audio_err(state->chip,
1844 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1848 csize = hdr->bControlSize;
1850 usb_audio_dbg(state->chip,
1851 "unit %u: invalid bControlSize == 0\n",
1855 channels = (hdr->bLength - 7) / csize - 1;
1856 bmaControls = hdr->bmaControls;
1857 if (hdr->bLength < 7 + csize) {
1858 usb_audio_err(state->chip,
1859 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1863 } else if (state->mixer->protocol == UAC_VERSION_2) {
1864 struct uac2_feature_unit_descriptor *ftr = _ftr;
1865 if (hdr->bLength < 6) {
1866 usb_audio_err(state->chip,
1867 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1872 channels = (hdr->bLength - 6) / 4 - 1;
1873 bmaControls = ftr->bmaControls;
1874 if (hdr->bLength < 6 + csize) {
1875 usb_audio_err(state->chip,
1876 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1880 } else { /* UAC_VERSION_3 */
1881 struct uac3_feature_unit_descriptor *ftr = _ftr;
1883 if (hdr->bLength < 7) {
1884 usb_audio_err(state->chip,
1885 "unit %u: invalid UAC3_FEATURE_UNIT descriptor\n",
1890 channels = (ftr->bLength - 7) / 4 - 1;
1891 bmaControls = ftr->bmaControls;
1892 if (hdr->bLength < 7 + csize) {
1893 usb_audio_err(state->chip,
1894 "unit %u: invalid UAC3_FEATURE_UNIT descriptor\n",
1900 /* parse the source unit */
1901 err = parse_audio_unit(state, hdr->bSourceID);
1905 /* determine the input source type and name */
1906 err = check_input_term(state, hdr->bSourceID, &iterm);
1910 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1911 /* master configuration quirks */
1912 switch (state->chip->usb_id) {
1913 case USB_ID(0x08bb, 0x2702):
1914 usb_audio_info(state->chip,
1915 "usbmixer: master volume quirk for PCM2702 chip\n");
1916 /* disable non-functional volume control */
1917 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1919 case USB_ID(0x1130, 0xf211):
1920 usb_audio_info(state->chip,
1921 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1922 /* disable non-functional volume control */
1928 if (state->mixer->protocol == UAC_VERSION_1) {
1929 /* check all control types */
1930 for (i = 0; i < 10; i++) {
1931 unsigned int ch_bits = 0;
1932 int control = audio_feature_info[i].control;
1934 for (j = 0; j < channels; j++) {
1937 mask = snd_usb_combine_bytes(bmaControls +
1938 csize * (j+1), csize);
1939 if (mask & (1 << i))
1940 ch_bits |= (1 << j);
1942 /* audio class v1 controls are never read-only */
1945 * The first channel must be set
1946 * (for ease of programming).
1949 build_feature_ctl(state, _ftr, ch_bits, control,
1951 if (master_bits & (1 << i))
1952 build_feature_ctl(state, _ftr, 0, control,
1955 } else { /* UAC_VERSION_2/3 */
1956 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1957 unsigned int ch_bits = 0;
1958 unsigned int ch_read_only = 0;
1959 int control = audio_feature_info[i].control;
1961 for (j = 0; j < channels; j++) {
1964 mask = snd_usb_combine_bytes(bmaControls +
1965 csize * (j+1), csize);
1966 if (uac_v2v3_control_is_readable(mask, control)) {
1967 ch_bits |= (1 << j);
1968 if (!uac_v2v3_control_is_writeable(mask, control))
1969 ch_read_only |= (1 << j);
1974 * NOTE: build_feature_ctl() will mark the control
1975 * read-only if all channels are marked read-only in
1976 * the descriptors. Otherwise, the control will be
1977 * reported as writeable, but the driver will not
1978 * actually issue a write command for read-only
1983 * The first channel must be set
1984 * (for ease of programming).
1987 build_feature_ctl(state, _ftr, ch_bits, control,
1988 &iterm, unitid, ch_read_only);
1989 if (uac_v2v3_control_is_readable(master_bits, control))
1990 build_feature_ctl(state, _ftr, 0, control,
1992 !uac_v2v3_control_is_writeable(master_bits,
2004 /* check whether the given in/out overflows bmMixerControls matrix */
2005 static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc,
2006 int protocol, int num_ins, int num_outs)
2008 u8 *hdr = (u8 *)desc;
2009 u8 *c = uac_mixer_unit_bmControls(desc, protocol);
2010 size_t rest; /* remaining bytes after bmMixerControls */
2015 rest = 1; /* iMixer */
2018 rest = 2; /* bmControls + iMixer */
2021 rest = 6; /* bmControls + wMixerDescrStr */
2026 return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
2030 * build a mixer unit control
2032 * the callbacks are identical with feature unit.
2033 * input channel number (zero based) is given in control field instead.
2035 static void build_mixer_unit_ctl(struct mixer_build *state,
2036 struct uac_mixer_unit_descriptor *desc,
2037 int in_pin, int in_ch, int num_outs,
2038 int unitid, struct usb_audio_term *iterm)
2040 struct usb_mixer_elem_info *cval;
2041 unsigned int i, len;
2042 struct snd_kcontrol *kctl;
2043 const struct usbmix_name_map *map;
2045 map = find_map(state->map, unitid, 0);
2046 if (check_ignored_ctl(map))
2049 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2053 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2054 cval->control = in_ch + 1; /* based on 1 */
2055 cval->val_type = USB_MIXER_S16;
2056 for (i = 0; i < num_outs; i++) {
2057 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
2059 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
2060 cval->cmask |= (1 << i);
2065 /* get min/max values */
2066 get_min_max(cval, 0);
2068 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2070 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2074 kctl->private_free = snd_usb_mixer_elem_free;
2076 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2078 len = get_term_name(state->chip, iterm, kctl->id.name,
2079 sizeof(kctl->id.name), 0);
2081 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
2082 append_ctl_name(kctl, " Volume");
2084 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2085 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
2086 snd_usb_mixer_add_control(&cval->head, kctl);
2089 static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
2092 struct usb_audio_term iterm;
2093 unsigned int control, bmctls, term_id;
2095 if (state->mixer->protocol == UAC_VERSION_2) {
2096 struct uac2_input_terminal_descriptor *d_v2 = raw_desc;
2097 if (d_v2->bLength < sizeof(*d_v2))
2099 control = UAC2_TE_CONNECTOR;
2100 term_id = d_v2->bTerminalID;
2101 bmctls = le16_to_cpu(d_v2->bmControls);
2102 } else if (state->mixer->protocol == UAC_VERSION_3) {
2103 struct uac3_input_terminal_descriptor *d_v3 = raw_desc;
2104 if (d_v3->bLength < sizeof(*d_v3))
2106 control = UAC3_TE_INSERTION;
2107 term_id = d_v3->bTerminalID;
2108 bmctls = le32_to_cpu(d_v3->bmControls);
2110 return 0; /* UAC1. No Insertion control */
2113 check_input_term(state, term_id, &iterm);
2115 /* Check for jack detection. */
2116 if (uac_v2v3_control_is_readable(bmctls, control))
2117 build_connector_control(state->mixer, &iterm, true);
2123 * parse a mixer unit
2125 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
2128 struct uac_mixer_unit_descriptor *desc = raw_desc;
2129 struct usb_audio_term iterm;
2130 int input_pins, num_ins, num_outs;
2133 err = uac_mixer_unit_get_channels(state, desc);
2135 usb_audio_err(state->chip,
2136 "invalid MIXER UNIT descriptor %d\n",
2142 input_pins = desc->bNrInPins;
2146 for (pin = 0; pin < input_pins; pin++) {
2147 err = parse_audio_unit(state, desc->baSourceID[pin]);
2150 /* no bmControls field (e.g. Maya44) -> ignore */
2153 err = check_input_term(state, desc->baSourceID[pin], &iterm);
2156 num_ins += iterm.channels;
2157 if (mixer_bitmap_overflow(desc, state->mixer->protocol,
2160 for (; ich < num_ins; ich++) {
2161 int och, ich_has_controls = 0;
2163 for (och = 0; och < num_outs; och++) {
2164 __u8 *c = uac_mixer_unit_bmControls(desc,
2165 state->mixer->protocol);
2167 if (check_matrix_bitmap(c, ich, och, num_outs)) {
2168 ich_has_controls = 1;
2172 if (ich_has_controls)
2173 build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
2181 * Processing Unit / Extension Unit
2184 /* get callback for processing/extension unit */
2185 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
2186 struct snd_ctl_elem_value *ucontrol)
2188 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2191 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2193 ucontrol->value.integer.value[0] = cval->min;
2194 return filter_error(cval, err);
2196 val = get_relative_value(cval, val);
2197 ucontrol->value.integer.value[0] = val;
2201 /* put callback for processing/extension unit */
2202 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
2203 struct snd_ctl_elem_value *ucontrol)
2205 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2208 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2210 return filter_error(cval, err);
2211 val = ucontrol->value.integer.value[0];
2212 val = get_abs_value(cval, val);
2214 set_cur_ctl_value(cval, cval->control << 8, val);
2220 /* alsa control interface for processing/extension unit */
2221 static const struct snd_kcontrol_new mixer_procunit_ctl = {
2222 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2223 .name = "", /* will be filled later */
2224 .info = mixer_ctl_feature_info,
2225 .get = mixer_ctl_procunit_get,
2226 .put = mixer_ctl_procunit_put,
2230 * predefined data for processing units
2232 struct procunit_value_info {
2239 struct procunit_info {
2242 struct procunit_value_info *values;
2245 static struct procunit_value_info undefined_proc_info[] = {
2246 { 0x00, "Control Undefined", 0 },
2250 static struct procunit_value_info updown_proc_info[] = {
2251 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2252 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2255 static struct procunit_value_info prologic_proc_info[] = {
2256 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2257 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2260 static struct procunit_value_info threed_enh_proc_info[] = {
2261 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2262 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2265 static struct procunit_value_info reverb_proc_info[] = {
2266 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2267 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2268 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2269 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2272 static struct procunit_value_info chorus_proc_info[] = {
2273 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2274 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2275 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2276 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2279 static struct procunit_value_info dcr_proc_info[] = {
2280 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2281 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2282 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2283 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2284 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2285 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2289 static struct procunit_info procunits[] = {
2290 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2291 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2292 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2293 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2294 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2295 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2299 static struct procunit_value_info uac3_updown_proc_info[] = {
2300 { UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2303 static struct procunit_value_info uac3_stereo_ext_proc_info[] = {
2304 { UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
2308 static struct procunit_info uac3_procunits[] = {
2309 { UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info },
2310 { UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info },
2311 { UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info },
2316 * predefined data for extension units
2318 static struct procunit_value_info clock_rate_xu_info[] = {
2319 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2322 static struct procunit_value_info clock_source_xu_info[] = {
2323 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2326 static struct procunit_value_info spdif_format_xu_info[] = {
2327 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2330 static struct procunit_value_info soft_limit_xu_info[] = {
2331 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2334 static struct procunit_info extunits[] = {
2335 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2336 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2337 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2338 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2343 * build a processing/extension unit
2345 static int build_audio_procunit(struct mixer_build *state, int unitid,
2346 void *raw_desc, struct procunit_info *list,
2347 bool extension_unit)
2349 struct uac_processing_unit_descriptor *desc = raw_desc;
2351 struct usb_mixer_elem_info *cval;
2352 struct snd_kcontrol *kctl;
2353 int i, err, nameid, type, len;
2354 struct procunit_info *info;
2355 struct procunit_value_info *valinfo;
2356 const struct usbmix_name_map *map;
2357 static struct procunit_value_info default_value_info[] = {
2358 { 0x01, "Switch", USB_MIXER_BOOLEAN },
2361 static struct procunit_info default_info = {
2362 0, NULL, default_value_info
2364 const char *name = extension_unit ?
2365 "Extension Unit" : "Processing Unit";
2367 if (desc->bLength < 13) {
2368 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
2372 num_ins = desc->bNrInPins;
2373 if (desc->bLength < 13 + num_ins ||
2374 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
2375 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
2379 for (i = 0; i < num_ins; i++) {
2380 err = parse_audio_unit(state, desc->baSourceID[i]);
2385 type = le16_to_cpu(desc->wProcessType);
2386 for (info = list; info && info->type; info++)
2387 if (info->type == type)
2389 if (!info || !info->type)
2390 info = &default_info;
2392 for (valinfo = info->values; valinfo->control; valinfo++) {
2393 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2395 if (state->mixer->protocol == UAC_VERSION_1) {
2396 if (!(controls[valinfo->control / 8] &
2397 (1 << ((valinfo->control % 8) - 1))))
2399 } else { /* UAC_VERSION_2/3 */
2400 if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
2405 map = find_map(state->map, unitid, valinfo->control);
2406 if (check_ignored_ctl(map))
2408 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2411 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2412 cval->control = valinfo->control;
2413 cval->val_type = valinfo->val_type;
2416 if (state->mixer->protocol > UAC_VERSION_1 &&
2417 !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
2419 cval->master_readonly = 1;
2421 /* get min/max values */
2423 case UAC_PROCESS_UP_DOWNMIX: {
2424 bool mode_sel = false;
2426 switch (state->mixer->protocol) {
2430 if (cval->control == UAC_UD_MODE_SELECT)
2434 if (cval->control == UAC3_UD_MODE_SELECT)
2440 __u8 *control_spec = uac_processing_unit_specific(desc,
2441 state->mixer->protocol);
2443 cval->max = control_spec[0];
2445 cval->initialized = 1;
2449 get_min_max(cval, valinfo->min_value);
2452 case USB_XU_CLOCK_RATE:
2454 * E-Mu USB 0404/0202/TrackerPre/0204
2455 * samplerate control quirk
2460 cval->initialized = 1;
2463 get_min_max(cval, valinfo->min_value);
2467 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2472 kctl->private_free = snd_usb_mixer_elem_free;
2474 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2476 } else if (info->name) {
2477 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2480 nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
2482 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2485 len = snd_usb_copy_string_desc(state->chip,
2488 sizeof(kctl->id.name));
2490 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
2492 append_ctl_name(kctl, " ");
2493 append_ctl_name(kctl, valinfo->suffix);
2495 usb_audio_dbg(state->chip,
2496 "[%d] PU [%s] ch = %d, val = %d/%d\n",
2497 cval->head.id, kctl->id.name, cval->channels,
2498 cval->min, cval->max);
2500 err = snd_usb_mixer_add_control(&cval->head, kctl);
2507 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2510 switch (state->mixer->protocol) {
2514 return build_audio_procunit(state, unitid, raw_desc,
2517 return build_audio_procunit(state, unitid, raw_desc,
2518 uac3_procunits, false);
2522 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2526 * Note that we parse extension units with processing unit descriptors.
2527 * That's ok as the layout is the same.
2529 return build_audio_procunit(state, unitid, raw_desc, extunits, true);
2537 * info callback for selector unit
2538 * use an enumerator type for routing
2540 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2541 struct snd_ctl_elem_info *uinfo)
2543 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2544 const char **itemlist = (const char **)kcontrol->private_value;
2546 if (snd_BUG_ON(!itemlist))
2548 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2551 /* get callback for selector unit */
2552 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2553 struct snd_ctl_elem_value *ucontrol)
2555 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2558 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2560 ucontrol->value.enumerated.item[0] = 0;
2561 return filter_error(cval, err);
2563 val = get_relative_value(cval, val);
2564 ucontrol->value.enumerated.item[0] = val;
2568 /* put callback for selector unit */
2569 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2570 struct snd_ctl_elem_value *ucontrol)
2572 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2575 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2577 return filter_error(cval, err);
2578 val = ucontrol->value.enumerated.item[0];
2579 val = get_abs_value(cval, val);
2581 set_cur_ctl_value(cval, cval->control << 8, val);
2587 /* alsa control interface for selector unit */
2588 static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2589 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2590 .name = "", /* will be filled later */
2591 .info = mixer_ctl_selector_info,
2592 .get = mixer_ctl_selector_get,
2593 .put = mixer_ctl_selector_put,
2597 * private free callback.
2598 * free both private_data and private_value
2600 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2604 if (kctl->private_data) {
2605 struct usb_mixer_elem_info *cval = kctl->private_data;
2606 num_ins = cval->max;
2608 kctl->private_data = NULL;
2610 if (kctl->private_value) {
2611 char **itemlist = (char **)kctl->private_value;
2612 for (i = 0; i < num_ins; i++)
2615 kctl->private_value = 0;
2620 * parse a selector unit
2622 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2625 struct uac_selector_unit_descriptor *desc = raw_desc;
2626 unsigned int i, nameid, len;
2628 struct usb_mixer_elem_info *cval;
2629 struct snd_kcontrol *kctl;
2630 const struct usbmix_name_map *map;
2633 if (desc->bLength < 5 || !desc->bNrInPins ||
2634 desc->bLength < 5 + desc->bNrInPins) {
2635 usb_audio_err(state->chip,
2636 "invalid SELECTOR UNIT descriptor %d\n", unitid);
2640 for (i = 0; i < desc->bNrInPins; i++) {
2641 err = parse_audio_unit(state, desc->baSourceID[i]);
2646 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2649 map = find_map(state->map, unitid, 0);
2650 if (check_ignored_ctl(map))
2653 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2656 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2657 cval->val_type = USB_MIXER_U8;
2660 cval->max = desc->bNrInPins;
2662 cval->initialized = 1;
2664 switch (state->mixer->protocol) {
2671 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2672 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2673 cval->control = UAC2_CX_CLOCK_SELECTOR;
2674 else /* UAC2/3_SELECTOR_UNIT */
2675 cval->control = UAC2_SU_SELECTOR;
2679 namelist = kmalloc_array(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2684 #define MAX_ITEM_NAME_LEN 64
2685 for (i = 0; i < desc->bNrInPins; i++) {
2686 struct usb_audio_term iterm;
2688 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2696 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2698 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2699 len = get_term_name(state->chip, &iterm, namelist[i],
2700 MAX_ITEM_NAME_LEN, 0);
2702 sprintf(namelist[i], "Input %u", i);
2705 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2707 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2708 for (i = 0; i < desc->bNrInPins; i++)
2714 kctl->private_value = (unsigned long)namelist;
2715 kctl->private_free = usb_mixer_selector_elem_free;
2717 /* check the static mapping table at first */
2718 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2721 switch (state->mixer->protocol) {
2725 /* if iSelector is given, use it */
2726 nameid = uac_selector_unit_iSelector(desc);
2728 len = snd_usb_copy_string_desc(state->chip,
2729 nameid, kctl->id.name,
2730 sizeof(kctl->id.name));
2733 /* TODO: Class-Specific strings not yet supported */
2737 /* ... or pick up the terminal name at next */
2739 len = get_term_name(state->chip, &state->oterm,
2740 kctl->id.name, sizeof(kctl->id.name), 0);
2741 /* ... or use the fixed string "USB" as the last resort */
2743 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2745 /* and add the proper suffix */
2746 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2747 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2748 append_ctl_name(kctl, " Clock Source");
2749 else if ((state->oterm.type & 0xff00) == 0x0100)
2750 append_ctl_name(kctl, " Capture Source");
2752 append_ctl_name(kctl, " Playback Source");
2755 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2756 cval->head.id, kctl->id.name, desc->bNrInPins);
2757 return snd_usb_mixer_add_control(&cval->head, kctl);
2761 * parse an audio unit recursively
2764 static int parse_audio_unit(struct mixer_build *state, int unitid)
2767 int protocol = state->mixer->protocol;
2769 if (test_and_set_bit(unitid, state->unitbitmap))
2770 return 0; /* the unit already visited */
2772 p1 = find_audio_control_unit(state, unitid);
2774 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2778 if (protocol == UAC_VERSION_1 || protocol == UAC_VERSION_2) {
2780 case UAC_INPUT_TERMINAL:
2781 return parse_audio_input_terminal(state, unitid, p1);
2782 case UAC_MIXER_UNIT:
2783 return parse_audio_mixer_unit(state, unitid, p1);
2784 case UAC2_CLOCK_SOURCE:
2785 return parse_clock_source_unit(state, unitid, p1);
2786 case UAC_SELECTOR_UNIT:
2787 case UAC2_CLOCK_SELECTOR:
2788 return parse_audio_selector_unit(state, unitid, p1);
2789 case UAC_FEATURE_UNIT:
2790 return parse_audio_feature_unit(state, unitid, p1);
2791 case UAC1_PROCESSING_UNIT:
2792 /* UAC2_EFFECT_UNIT has the same value */
2793 if (protocol == UAC_VERSION_1)
2794 return parse_audio_processing_unit(state, unitid, p1);
2796 return 0; /* FIXME - effect units not implemented yet */
2797 case UAC1_EXTENSION_UNIT:
2798 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2799 if (protocol == UAC_VERSION_1)
2800 return parse_audio_extension_unit(state, unitid, p1);
2801 else /* UAC_VERSION_2 */
2802 return parse_audio_processing_unit(state, unitid, p1);
2803 case UAC2_EXTENSION_UNIT_V2:
2804 return parse_audio_extension_unit(state, unitid, p1);
2806 usb_audio_err(state->chip,
2807 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2810 } else { /* UAC_VERSION_3 */
2812 case UAC_INPUT_TERMINAL:
2813 return parse_audio_input_terminal(state, unitid, p1);
2814 case UAC3_MIXER_UNIT:
2815 return parse_audio_mixer_unit(state, unitid, p1);
2816 case UAC3_CLOCK_SOURCE:
2817 return parse_clock_source_unit(state, unitid, p1);
2818 case UAC3_SELECTOR_UNIT:
2819 case UAC3_CLOCK_SELECTOR:
2820 return parse_audio_selector_unit(state, unitid, p1);
2821 case UAC3_FEATURE_UNIT:
2822 return parse_audio_feature_unit(state, unitid, p1);
2823 case UAC3_EFFECT_UNIT:
2824 return 0; /* FIXME - effect units not implemented yet */
2825 case UAC3_PROCESSING_UNIT:
2826 return parse_audio_processing_unit(state, unitid, p1);
2827 case UAC3_EXTENSION_UNIT:
2828 return parse_audio_extension_unit(state, unitid, p1);
2830 usb_audio_err(state->chip,
2831 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2837 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2839 /* kill pending URBs */
2840 snd_usb_mixer_disconnect(mixer);
2842 kfree(mixer->id_elems);
2844 kfree(mixer->urb->transfer_buffer);
2845 usb_free_urb(mixer->urb);
2847 usb_free_urb(mixer->rc_urb);
2848 kfree(mixer->rc_setup_packet);
2852 static int snd_usb_mixer_dev_free(struct snd_device *device)
2854 struct usb_mixer_interface *mixer = device->device_data;
2855 snd_usb_mixer_free(mixer);
2859 /* UAC3 predefined channels configuration */
2860 struct uac3_badd_profile {
2863 int c_chmask; /* capture channels mask */
2864 int p_chmask; /* playback channels mask */
2865 int st_chmask; /* side tone mixing channel mask */
2868 static struct uac3_badd_profile uac3_badd_profiles[] = {
2871 * BAIF, BAOF or combination of both
2872 * IN: Mono or Stereo cfg, Mono alt possible
2873 * OUT: Mono or Stereo cfg, Mono alt possible
2875 .subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
2876 .name = "GENERIC IO",
2877 .c_chmask = -1, /* dynamic channels */
2878 .p_chmask = -1, /* dynamic channels */
2881 /* BAOF; Stereo only cfg, Mono alt possible */
2882 .subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
2883 .name = "HEADPHONE",
2887 /* BAOF; Mono or Stereo cfg, Mono alt possible */
2888 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
2890 .p_chmask = -1, /* dynamic channels */
2893 /* BAIF; Mono or Stereo cfg, Mono alt possible */
2894 .subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
2895 .name = "MICROPHONE",
2896 .c_chmask = -1, /* dynamic channels */
2902 * OUT: Mono or Stereo cfg, Mono alt possible
2904 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
2907 .p_chmask = -1, /* dynamic channels */
2911 /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
2912 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
2913 .name = "HEADSET ADAPTER",
2919 /* BAIF + BAOF; IN: Mono only; OUT: Mono only */
2920 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
2921 .name = "SPEAKERPHONE",
2925 { 0 } /* terminator */
2928 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
2929 struct uac3_badd_profile *f,
2930 int c_chmask, int p_chmask)
2933 * If both playback/capture channels are dynamic, make sure
2934 * at least one channel is present
2936 if (f->c_chmask < 0 && f->p_chmask < 0) {
2937 if (!c_chmask && !p_chmask) {
2938 usb_audio_warn(mixer->chip, "BAAD %s: no channels?",
2945 if ((f->c_chmask < 0 && !c_chmask) ||
2946 (f->c_chmask >= 0 && f->c_chmask != c_chmask)) {
2947 usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch",
2951 if ((f->p_chmask < 0 && !p_chmask) ||
2952 (f->p_chmask >= 0 && f->p_chmask != p_chmask)) {
2953 usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch",
2961 * create mixer controls for UAC3 BADD profiles
2963 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
2965 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
2967 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
2970 struct usb_device *dev = mixer->chip->dev;
2971 struct usb_interface_assoc_descriptor *assoc;
2972 int badd_profile = mixer->chip->badd_profile;
2973 struct uac3_badd_profile *f;
2974 const struct usbmix_ctl_map *map;
2975 int p_chmask = 0, c_chmask = 0, st_chmask = 0;
2978 assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
2980 /* Detect BADD capture/playback channels from AS EP descriptors */
2981 for (i = 0; i < assoc->bInterfaceCount; i++) {
2982 int intf = assoc->bFirstInterface + i;
2984 struct usb_interface *iface;
2985 struct usb_host_interface *alts;
2986 struct usb_interface_descriptor *altsd;
2987 unsigned int maxpacksize;
2994 iface = usb_ifnum_to_if(dev, intf);
2995 num = iface->num_altsetting;
3001 * The number of Channels in an AudioStreaming interface
3002 * and the audio sample bit resolution (16 bits or 24
3003 * bits) can be derived from the wMaxPacketSize field in
3004 * the Standard AS Audio Data Endpoint descriptor in
3005 * Alternate Setting 1
3007 alts = &iface->altsetting[1];
3008 altsd = get_iface_desc(alts);
3010 if (altsd->bNumEndpoints < 1)
3013 /* check direction */
3014 dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
3015 maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3017 switch (maxpacksize) {
3019 usb_audio_err(mixer->chip,
3020 "incorrect wMaxPacketSize 0x%x for BADD profile\n",
3023 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
3024 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
3025 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
3026 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
3029 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
3030 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
3031 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
3032 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
3043 usb_audio_dbg(mixer->chip,
3044 "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
3045 badd_profile, c_chmask, p_chmask);
3047 /* check the mapping table */
3048 for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
3049 if (map->id == badd_profile)
3056 for (f = uac3_badd_profiles; f->name; f++) {
3057 if (badd_profile == f->subclass)
3062 if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
3064 st_chmask = f->st_chmask;
3068 /* Master channel, always writable */
3069 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3070 UAC3_BADD_FU_ID2, map->map);
3071 /* Mono/Stereo volume channels, always writable */
3072 build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
3073 UAC3_BADD_FU_ID2, map->map);
3078 /* Master channel, always writable */
3079 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3080 UAC3_BADD_FU_ID5, map->map);
3081 /* Mono/Stereo volume channels, always writable */
3082 build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
3083 UAC3_BADD_FU_ID5, map->map);
3086 /* Side tone-mixing */
3088 /* Master channel, always writable */
3089 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3090 UAC3_BADD_FU_ID7, map->map);
3091 /* Mono volume channel, always writable */
3092 build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
3093 UAC3_BADD_FU_ID7, map->map);
3096 /* Insertion Control */
3097 if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
3098 struct usb_audio_term iterm, oterm;
3100 /* Input Term - Insertion control */
3101 memset(&iterm, 0, sizeof(iterm));
3102 iterm.id = UAC3_BADD_IT_ID4;
3103 iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3104 build_connector_control(mixer, &iterm, true);
3106 /* Output Term - Insertion control */
3107 memset(&oterm, 0, sizeof(oterm));
3108 oterm.id = UAC3_BADD_OT_ID3;
3109 oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3110 build_connector_control(mixer, &oterm, false);
3117 * create mixer controls
3119 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3121 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
3123 struct mixer_build state;
3125 const struct usbmix_ctl_map *map;
3128 memset(&state, 0, sizeof(state));
3129 state.chip = mixer->chip;
3130 state.mixer = mixer;
3131 state.buffer = mixer->hostif->extra;
3132 state.buflen = mixer->hostif->extralen;
3134 /* check the mapping table */
3135 for (map = usbmix_ctl_maps; map->id; map++) {
3136 if (map->id == state.chip->usb_id) {
3137 state.map = map->map;
3138 state.selector_map = map->selector_map;
3139 mixer->ignore_ctl_error = map->ignore_ctl_error;
3145 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
3146 mixer->hostif->extralen,
3147 p, UAC_OUTPUT_TERMINAL)) != NULL) {
3148 if (mixer->protocol == UAC_VERSION_1) {
3149 struct uac1_output_terminal_descriptor *desc = p;
3151 if (desc->bLength < sizeof(*desc))
3152 continue; /* invalid descriptor? */
3153 /* mark terminal ID as visited */
3154 set_bit(desc->bTerminalID, state.unitbitmap);
3155 state.oterm.id = desc->bTerminalID;
3156 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3157 state.oterm.name = desc->iTerminal;
3158 err = parse_audio_unit(&state, desc->bSourceID);
3159 if (err < 0 && err != -EINVAL)
3161 } else if (mixer->protocol == UAC_VERSION_2) {
3162 struct uac2_output_terminal_descriptor *desc = p;
3164 if (desc->bLength < sizeof(*desc))
3165 continue; /* invalid descriptor? */
3166 /* mark terminal ID as visited */
3167 set_bit(desc->bTerminalID, state.unitbitmap);
3168 state.oterm.id = desc->bTerminalID;
3169 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3170 state.oterm.name = desc->iTerminal;
3171 err = parse_audio_unit(&state, desc->bSourceID);
3172 if (err < 0 && err != -EINVAL)
3176 * For UAC2, use the same approach to also add the
3179 err = parse_audio_unit(&state, desc->bCSourceID);
3180 if (err < 0 && err != -EINVAL)
3183 if (uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3184 UAC2_TE_CONNECTOR)) {
3185 build_connector_control(state.mixer, &state.oterm,
3188 } else { /* UAC_VERSION_3 */
3189 struct uac3_output_terminal_descriptor *desc = p;
3191 if (desc->bLength < sizeof(*desc))
3192 continue; /* invalid descriptor? */
3193 /* mark terminal ID as visited */
3194 set_bit(desc->bTerminalID, state.unitbitmap);
3195 state.oterm.id = desc->bTerminalID;
3196 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3197 state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
3198 err = parse_audio_unit(&state, desc->bSourceID);
3199 if (err < 0 && err != -EINVAL)
3203 * For UAC3, use the same approach to also add the
3206 err = parse_audio_unit(&state, desc->bCSourceID);
3207 if (err < 0 && err != -EINVAL)
3210 if (uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
3211 UAC3_TE_INSERTION)) {
3212 build_connector_control(state.mixer, &state.oterm,
3221 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3223 struct usb_mixer_elem_list *list;
3225 for_each_mixer_elem(list, mixer, unitid) {
3226 struct usb_mixer_elem_info *info =
3227 mixer_elem_list_to_info(list);
3228 /* invalidate cache, so the value is read from the device */
3230 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3235 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3236 struct usb_mixer_elem_list *list)
3238 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3239 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
3240 "S8", "U8", "S16", "U16"};
3241 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
3242 "channels=%i, type=\"%s\"\n", cval->head.id,
3243 cval->control, cval->cmask, cval->channels,
3244 val_types[cval->val_type]);
3245 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3246 cval->min, cval->max, cval->dBmin, cval->dBmax);
3249 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
3250 struct snd_info_buffer *buffer)
3252 struct snd_usb_audio *chip = entry->private_data;
3253 struct usb_mixer_interface *mixer;
3254 struct usb_mixer_elem_list *list;
3257 list_for_each_entry(mixer, &chip->mixer_list, list) {
3259 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3260 chip->usb_id, snd_usb_ctrl_intf(chip),
3261 mixer->ignore_ctl_error);
3262 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
3263 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3264 for_each_mixer_elem(list, mixer, unitid) {
3265 snd_iprintf(buffer, " Unit: %i\n", list->id);
3268 " Control: name=\"%s\", index=%i\n",
3269 list->kctl->id.name,
3270 list->kctl->id.index);
3272 list->dump(buffer, list);
3278 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
3279 int attribute, int value, int index)
3281 struct usb_mixer_elem_list *list;
3282 __u8 unitid = (index >> 8) & 0xff;
3283 __u8 control = (value >> 8) & 0xff;
3284 __u8 channel = value & 0xff;
3285 unsigned int count = 0;
3287 if (channel >= MAX_CHANNELS) {
3288 usb_audio_dbg(mixer->chip,
3289 "%s(): bogus channel number %d\n",
3294 for_each_mixer_elem(list, mixer, unitid)
3300 for_each_mixer_elem(list, mixer, unitid) {
3301 struct usb_mixer_elem_info *info;
3306 info = mixer_elem_list_to_info(list);
3307 if (count > 1 && info->control != control)
3310 switch (attribute) {
3312 /* invalidate cache, so the value is read from the device */
3314 info->cached &= ~(1 << channel);
3315 else /* master channel */
3318 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3319 &info->head.kctl->id);
3331 usb_audio_dbg(mixer->chip,
3332 "unknown attribute %d in interrupt\n",
3339 static void snd_usb_mixer_interrupt(struct urb *urb)
3341 struct usb_mixer_interface *mixer = urb->context;
3342 int len = urb->actual_length;
3343 int ustatus = urb->status;
3348 if (mixer->protocol == UAC_VERSION_1) {
3349 struct uac1_status_word *status;
3351 for (status = urb->transfer_buffer;
3352 len >= sizeof(*status);
3353 len -= sizeof(*status), status++) {
3354 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3355 status->bStatusType,
3356 status->bOriginator);
3358 /* ignore any notifications not from the control interface */
3359 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
3360 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3363 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
3364 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3366 snd_usb_mixer_notify_id(mixer, status->bOriginator);
3368 } else { /* UAC_VERSION_2 */
3369 struct uac2_interrupt_data_msg *msg;
3371 for (msg = urb->transfer_buffer;
3372 len >= sizeof(*msg);
3373 len -= sizeof(*msg), msg++) {
3374 /* drop vendor specific and endpoint requests */
3375 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
3376 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
3379 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
3380 le16_to_cpu(msg->wValue),
3381 le16_to_cpu(msg->wIndex));
3386 if (ustatus != -ENOENT &&
3387 ustatus != -ECONNRESET &&
3388 ustatus != -ESHUTDOWN) {
3389 urb->dev = mixer->chip->dev;
3390 usb_submit_urb(urb, GFP_ATOMIC);
3394 /* create the handler for the optional status interrupt endpoint */
3395 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
3397 struct usb_endpoint_descriptor *ep;
3398 void *transfer_buffer;
3402 /* we need one interrupt input endpoint */
3403 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3405 ep = get_endpoint(mixer->hostif, 0);
3406 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3409 epnum = usb_endpoint_num(ep);
3410 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
3411 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
3412 if (!transfer_buffer)
3414 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
3416 kfree(transfer_buffer);
3419 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
3420 usb_rcvintpipe(mixer->chip->dev, epnum),
3421 transfer_buffer, buffer_length,
3422 snd_usb_mixer_interrupt, mixer, ep->bInterval);
3423 usb_submit_urb(mixer->urb, GFP_KERNEL);
3427 static int keep_iface_ctl_get(struct snd_kcontrol *kcontrol,
3428 struct snd_ctl_elem_value *ucontrol)
3430 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3432 ucontrol->value.integer.value[0] = mixer->chip->keep_iface;
3436 static int keep_iface_ctl_put(struct snd_kcontrol *kcontrol,
3437 struct snd_ctl_elem_value *ucontrol)
3439 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3440 bool keep_iface = !!ucontrol->value.integer.value[0];
3442 if (mixer->chip->keep_iface == keep_iface)
3444 mixer->chip->keep_iface = keep_iface;
3448 static const struct snd_kcontrol_new keep_iface_ctl = {
3449 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
3450 .name = "Keep Interface",
3451 .info = snd_ctl_boolean_mono_info,
3452 .get = keep_iface_ctl_get,
3453 .put = keep_iface_ctl_put,
3456 static int create_keep_iface_ctl(struct usb_mixer_interface *mixer)
3458 struct snd_kcontrol *kctl = snd_ctl_new1(&keep_iface_ctl, mixer);
3460 /* need only one control per card */
3461 if (snd_ctl_find_id(mixer->chip->card, &kctl->id)) {
3462 snd_ctl_free_one(kctl);
3466 return snd_ctl_add(mixer->chip->card, kctl);
3469 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
3472 static struct snd_device_ops dev_ops = {
3473 .dev_free = snd_usb_mixer_dev_free
3475 struct usb_mixer_interface *mixer;
3478 strcpy(chip->card->mixername, "USB Mixer");
3480 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3484 mixer->ignore_ctl_error = ignore_error;
3485 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
3487 if (!mixer->id_elems) {
3492 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
3493 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3496 mixer->protocol = UAC_VERSION_1;
3499 mixer->protocol = UAC_VERSION_2;
3502 mixer->protocol = UAC_VERSION_3;
3506 if (mixer->protocol == UAC_VERSION_3 &&
3507 chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3508 err = snd_usb_mixer_controls_badd(mixer, ctrlif);
3512 err = snd_usb_mixer_controls(mixer);
3517 err = snd_usb_mixer_status_create(mixer);
3521 err = create_keep_iface_ctl(mixer);
3525 err = snd_usb_mixer_apply_create_quirk(mixer);
3529 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3533 if (list_empty(&chip->mixer_list))
3534 snd_card_ro_proc_new(chip->card, "usbmixer", chip,
3535 snd_usb_mixer_proc_read);
3537 list_add(&mixer->list, &chip->mixer_list);
3541 snd_usb_mixer_free(mixer);
3545 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3547 if (mixer->disconnected)
3550 usb_kill_urb(mixer->urb);
3552 usb_kill_urb(mixer->rc_urb);
3553 mixer->disconnected = true;
3557 /* stop any bus activity of a mixer */
3558 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
3560 usb_kill_urb(mixer->urb);
3561 usb_kill_urb(mixer->rc_urb);
3564 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
3569 err = usb_submit_urb(mixer->urb, GFP_NOIO);
3577 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
3579 snd_usb_mixer_inactivate(mixer);
3583 static int restore_mixer_value(struct usb_mixer_elem_list *list)
3585 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3590 for (c = 0; c < MAX_CHANNELS; c++) {
3591 if (!(cval->cmask & (1 << c)))
3593 if (cval->cached & (1 << (c + 1))) {
3594 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3595 cval->cache_val[idx]);
3604 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3613 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
3615 struct usb_mixer_elem_list *list;
3619 /* restore cached mixer values */
3620 for (id = 0; id < MAX_ID_ELEMS; id++) {
3621 for_each_mixer_elem(list, mixer, id) {
3623 err = list->resume(list);
3631 snd_usb_mixer_resume_quirk(mixer);
3633 return snd_usb_mixer_activate(mixer);
3637 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
3638 struct usb_mixer_interface *mixer,
3641 list->mixer = mixer;
3643 list->dump = snd_usb_mixer_dump_cval;
3645 list->resume = restore_mixer_value;