2 * (Tentative) USB Audio Driver for ALSA
6 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8 * Many codes borrowed from audio.c by
9 * Alan Cox (alan@lxorguk.ukuu.org.uk)
10 * Thomas Sailer (sailer@ife.ee.ethz.ch)
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * TODOs, for both the mixer and the streaming interfaces:
32 * - support for UAC2 effect units
33 * - support for graphical equalizers
34 * - RANGE and MEM set commands (UAC2)
35 * - RANGE and MEM interrupt dispatchers (UAC2)
36 * - audio channel clustering (UAC2)
37 * - audio sample rate converter units (UAC2)
38 * - proper handling of clock multipliers (UAC2)
39 * - dispatch clock change notifications (UAC2)
40 * - stop PCM streams which use a clock that became invalid
41 * - stop PCM streams which use a clock selector that has changed
42 * - parse available sample rates again when clock sources changed
45 #include <linux/bitops.h>
46 #include <linux/init.h>
47 #include <linux/list.h>
48 #include <linux/slab.h>
49 #include <linux/string.h>
50 #include <linux/usb.h>
51 #include <linux/usb/audio.h>
52 #include <linux/usb/audio-v2.h>
54 #include <sound/core.h>
55 #include <sound/control.h>
56 #include <sound/hwdep.h>
57 #include <sound/info.h>
58 #include <sound/tlv.h>
63 #include "mixer_quirks.h"
66 #define MAX_ID_ELEMS 256
68 struct usb_audio_term {
72 unsigned int chconfig;
76 struct usbmix_name_map;
79 struct snd_usb_audio *chip;
80 struct usb_mixer_interface *mixer;
81 unsigned char *buffer;
83 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
84 struct usb_audio_term oterm;
85 const struct usbmix_name_map *map;
86 const struct usbmix_selector_map *selector_map;
89 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
91 USB_XU_CLOCK_RATE = 0xe301,
92 USB_XU_CLOCK_SOURCE = 0xe302,
93 USB_XU_DIGITAL_IO_STATUS = 0xe303,
94 USB_XU_DEVICE_OPTIONS = 0xe304,
95 USB_XU_DIRECT_MONITORING = 0xe305,
96 USB_XU_METERING = 0xe306
99 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/
100 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */
101 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */
102 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */
106 * manual mapping of mixer names
107 * if the mixer topology is too complicated and the parsed names are
108 * ambiguous, add the entries in usbmixer_maps.c.
110 #include "mixer_maps.c"
112 static const struct usbmix_name_map *
113 find_map(struct mixer_build *state, int unitid, int control)
115 const struct usbmix_name_map *p = state->map;
120 for (p = state->map; p->id; p++) {
121 if (p->id == unitid &&
122 (!control || !p->control || control == p->control))
128 /* get the mapped name if the unit matches */
130 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
136 return strlcpy(buf, p->name, buflen);
139 /* ignore the error value if ignore_ctl_error flag is set */
140 #define filter_error(cval, err) \
141 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
143 /* check whether the control should be ignored */
145 check_ignored_ctl(const struct usbmix_name_map *p)
147 if (!p || p->name || p->dB)
153 static inline void check_mapped_dB(const struct usbmix_name_map *p,
154 struct usb_mixer_elem_info *cval)
157 cval->dBmin = p->dB->min;
158 cval->dBmax = p->dB->max;
159 cval->initialized = 1;
163 /* get the mapped selector source name */
164 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
165 int index, char *buf, int buflen)
167 const struct usbmix_selector_map *p;
169 if (!state->selector_map)
171 for (p = state->selector_map; p->id; p++) {
172 if (p->id == unitid && index < p->count)
173 return strlcpy(buf, p->names[index], buflen);
179 * find an audio control unit with the given unit id
181 static void *find_audio_control_unit(struct mixer_build *state,
184 /* we just parse the header */
185 struct uac_feature_unit_descriptor *hdr = NULL;
187 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
188 USB_DT_CS_INTERFACE)) != NULL) {
189 if (hdr->bLength >= 4 &&
190 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
191 hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
192 hdr->bUnitID == unit)
200 * copy a string with the given id
202 static int snd_usb_copy_string_desc(struct mixer_build *state,
203 int index, char *buf, int maxlen)
205 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
211 * convert from the byte/word on usb descriptor to the zero-based integer
213 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
215 switch (cval->val_type) {
216 case USB_MIXER_BOOLEAN:
218 case USB_MIXER_INV_BOOLEAN:
241 * convert from the zero-based int to the byte/word for usb descriptor
243 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
245 switch (cval->val_type) {
246 case USB_MIXER_BOOLEAN:
248 case USB_MIXER_INV_BOOLEAN:
257 return 0; /* not reached */
260 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
266 else if (val >= cval->max)
267 return (cval->max - cval->min + cval->res - 1) / cval->res;
269 return (val - cval->min) / cval->res;
272 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
285 static int uac2_ctl_value_size(int val_type)
297 return 0; /* unreachable */
302 * retrieve a mixer value
305 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
306 int validx, int *value_ret)
308 struct snd_usb_audio *chip = cval->head.mixer->chip;
309 unsigned char buf[2];
310 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
314 err = snd_usb_autoresume(chip);
318 down_read(&chip->shutdown_rwsem);
319 while (timeout-- > 0) {
322 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
323 if (snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
324 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
325 validx, idx, buf, val_len) >= val_len) {
326 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
332 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
333 request, validx, idx, cval->val_type);
337 up_read(&chip->shutdown_rwsem);
338 snd_usb_autosuspend(chip);
342 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
343 int validx, int *value_ret)
345 struct snd_usb_audio *chip = cval->head.mixer->chip;
346 unsigned char buf[4 + 3 * sizeof(__u32)]; /* enough space for one range */
348 int idx = 0, ret, size;
351 if (request == UAC_GET_CUR) {
352 bRequest = UAC2_CS_CUR;
353 size = uac2_ctl_value_size(cval->val_type);
355 bRequest = UAC2_CS_RANGE;
359 memset(buf, 0, sizeof(buf));
361 ret = snd_usb_autoresume(chip) ? -EIO : 0;
365 down_read(&chip->shutdown_rwsem);
366 if (chip->shutdown) {
369 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
370 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
371 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
372 validx, idx, buf, size);
374 up_read(&chip->shutdown_rwsem);
375 snd_usb_autosuspend(chip);
380 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
381 request, validx, idx, cval->val_type);
385 /* FIXME: how should we handle multiple triplets here? */
392 val = buf + sizeof(__u16);
395 val = buf + sizeof(__u16) * 2;
398 val = buf + sizeof(__u16) * 3;
404 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
409 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
410 int validx, int *value_ret)
412 validx += cval->idx_off;
414 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
415 get_ctl_value_v1(cval, request, validx, value_ret) :
416 get_ctl_value_v2(cval, request, validx, value_ret);
419 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
420 int validx, int *value)
422 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
425 /* channel = 0: master, 1 = first channel */
426 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
427 int channel, int *value)
429 return get_ctl_value(cval, UAC_GET_CUR,
430 (cval->control << 8) | channel,
434 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
435 int channel, int index, int *value)
439 if (cval->cached & (1 << channel)) {
440 *value = cval->cache_val[index];
443 err = get_cur_mix_raw(cval, channel, value);
445 if (!cval->head.mixer->ignore_ctl_error)
446 usb_audio_dbg(cval->head.mixer->chip,
447 "cannot get current value for control %d ch %d: err = %d\n",
448 cval->control, channel, err);
451 cval->cached |= 1 << channel;
452 cval->cache_val[index] = *value;
460 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
461 int request, int validx, int value_set)
463 struct snd_usb_audio *chip = cval->head.mixer->chip;
464 unsigned char buf[4];
465 int idx = 0, val_len, err, timeout = 10;
467 validx += cval->idx_off;
469 if (cval->head.mixer->protocol == UAC_VERSION_1) {
470 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
471 } else { /* UAC_VERSION_2 */
472 val_len = uac2_ctl_value_size(cval->val_type);
475 if (request != UAC_SET_CUR) {
476 usb_audio_dbg(chip, "RANGE setting not yet supported\n");
480 request = UAC2_CS_CUR;
483 value_set = convert_bytes_value(cval, value_set);
484 buf[0] = value_set & 0xff;
485 buf[1] = (value_set >> 8) & 0xff;
486 buf[2] = (value_set >> 16) & 0xff;
487 buf[3] = (value_set >> 24) & 0xff;
488 err = snd_usb_autoresume(chip);
491 down_read(&chip->shutdown_rwsem);
492 while (timeout-- > 0) {
495 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
496 if (snd_usb_ctl_msg(chip->dev,
497 usb_sndctrlpipe(chip->dev, 0), request,
498 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
499 validx, idx, buf, val_len) >= 0) {
504 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
505 request, validx, idx, cval->val_type, buf[0], buf[1]);
509 up_read(&chip->shutdown_rwsem);
510 snd_usb_autosuspend(chip);
514 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
515 int validx, int value)
517 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
520 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
521 int index, int value)
524 unsigned int read_only = (channel == 0) ?
525 cval->master_readonly :
526 cval->ch_readonly & (1 << (channel - 1));
529 usb_audio_dbg(cval->head.mixer->chip,
530 "%s(): channel %d of control %d is read_only\n",
531 __func__, channel, cval->control);
535 err = snd_usb_mixer_set_ctl_value(cval,
536 UAC_SET_CUR, (cval->control << 8) | channel,
540 cval->cached |= 1 << channel;
541 cval->cache_val[index] = value;
546 * TLV callback for mixer volume controls
548 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
549 unsigned int size, unsigned int __user *_tlv)
551 struct usb_mixer_elem_info *cval = kcontrol->private_data;
552 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
554 if (size < sizeof(scale))
556 scale[2] = cval->dBmin;
557 scale[3] = cval->dBmax;
558 if (copy_to_user(_tlv, scale, sizeof(scale)))
564 * parser routines begin here...
567 static int parse_audio_unit(struct mixer_build *state, int unitid);
571 * check if the input/output channel routing is enabled on the given bitmap.
572 * used for mixer unit parser
574 static int check_matrix_bitmap(unsigned char *bmap,
575 int ich, int och, int num_outs)
577 int idx = ich * num_outs + och;
578 return bmap[idx >> 3] & (0x80 >> (idx & 7));
582 * add an alsa control element
583 * search and increment the index until an empty slot is found.
585 * if failed, give up and free the control instance.
588 int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
589 struct snd_kcontrol *kctl)
591 struct usb_mixer_interface *mixer = list->mixer;
594 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
596 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
597 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
602 list->next_id_elem = mixer->id_elems[list->id];
603 mixer->id_elems[list->id] = list;
608 * get a terminal name string
611 static struct iterm_name_combo {
615 { 0x0300, "Output" },
616 { 0x0301, "Speaker" },
617 { 0x0302, "Headphone" },
618 { 0x0303, "HMD Audio" },
619 { 0x0304, "Desktop Speaker" },
620 { 0x0305, "Room Speaker" },
621 { 0x0306, "Com Speaker" },
623 { 0x0600, "External In" },
624 { 0x0601, "Analog In" },
625 { 0x0602, "Digital In" },
627 { 0x0604, "Legacy In" },
628 { 0x0605, "IEC958 In" },
629 { 0x0606, "1394 DA Stream" },
630 { 0x0607, "1394 DV Stream" },
631 { 0x0700, "Embedded" },
632 { 0x0701, "Noise Source" },
633 { 0x0702, "Equalization Noise" },
637 { 0x0706, "MiniDisk" },
638 { 0x0707, "Analog Tape" },
639 { 0x0708, "Phonograph" },
640 { 0x0709, "VCR Audio" },
641 { 0x070a, "Video Disk Audio" },
642 { 0x070b, "DVD Audio" },
643 { 0x070c, "TV Tuner Audio" },
644 { 0x070d, "Satellite Rec Audio" },
645 { 0x070e, "Cable Tuner Audio" },
646 { 0x070f, "DSS Audio" },
647 { 0x0710, "Radio Receiver" },
648 { 0x0711, "Radio Transmitter" },
649 { 0x0712, "Multi-Track Recorder" },
650 { 0x0713, "Synthesizer" },
654 static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
655 unsigned char *name, int maxlen, int term_only)
657 struct iterm_name_combo *names;
660 return snd_usb_copy_string_desc(state, iterm->name,
663 /* virtual type - not a real terminal */
664 if (iterm->type >> 16) {
667 switch (iterm->type >> 16) {
668 case UAC_SELECTOR_UNIT:
669 strcpy(name, "Selector");
671 case UAC1_PROCESSING_UNIT:
672 strcpy(name, "Process Unit");
674 case UAC1_EXTENSION_UNIT:
675 strcpy(name, "Ext Unit");
678 strcpy(name, "Mixer");
681 return sprintf(name, "Unit %d", iterm->id);
685 switch (iterm->type & 0xff00) {
693 strcpy(name, "Headset");
696 strcpy(name, "Phone");
700 for (names = iterm_names; names->type; names++) {
701 if (names->type == iterm->type) {
702 strcpy(name, names->name);
703 return strlen(names->name);
711 * parse the source unit recursively until it reaches to a terminal
712 * or a branched unit.
714 static int check_input_term(struct mixer_build *state, int id,
715 struct usb_audio_term *term)
720 memset(term, 0, sizeof(*term));
721 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
722 unsigned char *hdr = p1;
725 case UAC_INPUT_TERMINAL:
726 if (state->mixer->protocol == UAC_VERSION_1) {
727 struct uac_input_terminal_descriptor *d = p1;
728 term->type = le16_to_cpu(d->wTerminalType);
729 term->channels = d->bNrChannels;
730 term->chconfig = le16_to_cpu(d->wChannelConfig);
731 term->name = d->iTerminal;
732 } else { /* UAC_VERSION_2 */
733 struct uac2_input_terminal_descriptor *d = p1;
734 term->type = le16_to_cpu(d->wTerminalType);
735 term->channels = d->bNrChannels;
736 term->chconfig = le32_to_cpu(d->bmChannelConfig);
737 term->name = d->iTerminal;
739 /* call recursively to get the clock selectors */
740 err = check_input_term(state, d->bCSourceID, term);
745 case UAC_FEATURE_UNIT: {
746 /* the header is the same for v1 and v2 */
747 struct uac_feature_unit_descriptor *d = p1;
749 break; /* continue to parse */
751 case UAC_MIXER_UNIT: {
752 struct uac_mixer_unit_descriptor *d = p1;
753 term->type = d->bDescriptorSubtype << 16; /* virtual type */
754 term->channels = uac_mixer_unit_bNrChannels(d);
755 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
756 term->name = uac_mixer_unit_iMixer(d);
759 case UAC_SELECTOR_UNIT:
760 case UAC2_CLOCK_SELECTOR: {
761 struct uac_selector_unit_descriptor *d = p1;
762 /* call recursively to retrieve the channel info */
763 err = check_input_term(state, d->baSourceID[0], term);
766 term->type = d->bDescriptorSubtype << 16; /* virtual type */
768 term->name = uac_selector_unit_iSelector(d);
771 case UAC1_PROCESSING_UNIT:
772 case UAC1_EXTENSION_UNIT:
773 /* UAC2_PROCESSING_UNIT_V2 */
774 /* UAC2_EFFECT_UNIT */
775 case UAC2_EXTENSION_UNIT_V2: {
776 struct uac_processing_unit_descriptor *d = p1;
778 if (state->mixer->protocol == UAC_VERSION_2 &&
779 hdr[2] == UAC2_EFFECT_UNIT) {
780 /* UAC2/UAC1 unit IDs overlap here in an
781 * uncompatible way. Ignore this unit for now.
787 id = d->baSourceID[0];
788 break; /* continue to parse */
790 term->type = d->bDescriptorSubtype << 16; /* virtual type */
791 term->channels = uac_processing_unit_bNrChannels(d);
792 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
793 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
796 case UAC2_CLOCK_SOURCE: {
797 struct uac_clock_source_descriptor *d = p1;
798 term->type = d->bDescriptorSubtype << 16; /* virtual type */
800 term->name = d->iClockSource;
814 /* feature unit control information */
815 struct usb_feature_control_info {
817 int type; /* data type for uac1 */
818 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
821 static struct usb_feature_control_info audio_feature_info[] = {
822 { "Mute", USB_MIXER_INV_BOOLEAN, -1 },
823 { "Volume", USB_MIXER_S16, -1 },
824 { "Tone Control - Bass", USB_MIXER_S8, -1 },
825 { "Tone Control - Mid", USB_MIXER_S8, -1 },
826 { "Tone Control - Treble", USB_MIXER_S8, -1 },
827 { "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemeted yet */
828 { "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
829 { "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
830 { "Bass Boost", USB_MIXER_BOOLEAN, -1 },
831 { "Loudness", USB_MIXER_BOOLEAN, -1 },
833 { "Input Gain Control", USB_MIXER_S16, -1 },
834 { "Input Gain Pad Control", USB_MIXER_S16, -1 },
835 { "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
838 /* private_free callback */
839 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
841 kfree(kctl->private_data);
842 kctl->private_data = NULL;
846 * interface to ALSA control for feature/mixer units
849 /* volume control quirks */
850 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
851 struct snd_kcontrol *kctl)
853 struct snd_usb_audio *chip = cval->head.mixer->chip;
854 switch (chip->usb_id) {
855 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
856 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
857 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
863 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
864 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
869 if (strstr(kctl->id.name, "Effect Return") != NULL) {
875 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
876 (strstr(kctl->id.name, "Effect Send") != NULL)) {
877 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
883 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
884 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
885 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
887 "set quirk for FTU Effect Duration\n");
893 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
894 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
896 "set quirks for FTU Effect Feedback/Volume\n");
903 case USB_ID(0x0471, 0x0101):
904 case USB_ID(0x0471, 0x0104):
905 case USB_ID(0x0471, 0x0105):
906 case USB_ID(0x0672, 0x1041):
907 /* quirk for UDA1321/N101.
908 * note that detection between firmware 2.1.1.7 (N101)
909 * and later 2.1.1.21 is not very clear from datasheets.
910 * I hope that the min value is -15360 for newer firmware --jk
912 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
913 cval->min == -15616) {
915 "set volume quirk for UDA1321/N101 chip\n");
920 case USB_ID(0x046d, 0x09a4):
921 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
923 "set volume quirk for QuickCam E3500\n");
930 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
931 case USB_ID(0x046d, 0x0808):
932 case USB_ID(0x046d, 0x0809):
933 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
934 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
935 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
936 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
937 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
938 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
939 case USB_ID(0x046d, 0x0991):
940 /* Most audio usb devices lie about volume resolution.
941 * Most Logitech webcams have res = 384.
942 * Proboly there is some logitech magic behind this number --fishor
944 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
946 "set resolution quirk: cval->res = 384\n");
954 * retrieve the minimum and maximum values for the specified control
956 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
957 int default_min, struct snd_kcontrol *kctl)
960 cval->min = default_min;
961 cval->max = cval->min + 1;
963 cval->dBmin = cval->dBmax = 0;
965 if (cval->val_type == USB_MIXER_BOOLEAN ||
966 cval->val_type == USB_MIXER_INV_BOOLEAN) {
967 cval->initialized = 1;
972 for (i = 0; i < MAX_CHANNELS; i++)
973 if (cval->cmask & (1 << i)) {
978 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
979 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
980 usb_audio_err(cval->head.mixer->chip,
981 "%d:%d: cannot get min/max values for control %d (id %d)\n",
982 cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
983 cval->control, cval->head.id);
986 if (get_ctl_value(cval, UAC_GET_RES,
987 (cval->control << 8) | minchn,
991 int last_valid_res = cval->res;
993 while (cval->res > 1) {
994 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
995 (cval->control << 8) | minchn,
1000 if (get_ctl_value(cval, UAC_GET_RES,
1001 (cval->control << 8) | minchn, &cval->res) < 0)
1002 cval->res = last_valid_res;
1007 /* Additional checks for the proper resolution
1009 * Some devices report smaller resolutions than actually
1010 * reacting. They don't return errors but simply clip
1011 * to the lower aligned value.
1013 if (cval->min + cval->res < cval->max) {
1014 int last_valid_res = cval->res;
1015 int saved, test, check;
1016 get_cur_mix_raw(cval, minchn, &saved);
1019 if (test < cval->max)
1023 if (test < cval->min || test > cval->max ||
1024 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1025 get_cur_mix_raw(cval, minchn, &check)) {
1026 cval->res = last_valid_res;
1033 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1036 cval->initialized = 1;
1040 volume_control_quirks(cval, kctl);
1042 /* USB descriptions contain the dB scale in 1/256 dB unit
1043 * while ALSA TLV contains in 1/100 dB unit
1045 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1046 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1047 if (cval->dBmin > cval->dBmax) {
1048 /* something is wrong; assume it's either from/to 0dB */
1049 if (cval->dBmin < 0)
1051 else if (cval->dBmin > 0)
1053 if (cval->dBmin > cval->dBmax) {
1054 /* totally crap, return an error */
1062 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1064 /* get a feature/mixer unit info */
1065 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1066 struct snd_ctl_elem_info *uinfo)
1068 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1070 if (cval->val_type == USB_MIXER_BOOLEAN ||
1071 cval->val_type == USB_MIXER_INV_BOOLEAN)
1072 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1074 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1075 uinfo->count = cval->channels;
1076 if (cval->val_type == USB_MIXER_BOOLEAN ||
1077 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1078 uinfo->value.integer.min = 0;
1079 uinfo->value.integer.max = 1;
1081 if (!cval->initialized) {
1082 get_min_max_with_quirks(cval, 0, kcontrol);
1083 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1084 kcontrol->vd[0].access &=
1085 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1086 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1087 snd_ctl_notify(cval->head.mixer->chip->card,
1088 SNDRV_CTL_EVENT_MASK_INFO,
1092 uinfo->value.integer.min = 0;
1093 uinfo->value.integer.max =
1094 (cval->max - cval->min + cval->res - 1) / cval->res;
1099 /* get the current value from feature/mixer unit */
1100 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1101 struct snd_ctl_elem_value *ucontrol)
1103 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1104 int c, cnt, val, err;
1106 ucontrol->value.integer.value[0] = cval->min;
1109 for (c = 0; c < MAX_CHANNELS; c++) {
1110 if (!(cval->cmask & (1 << c)))
1112 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1114 return filter_error(cval, err);
1115 val = get_relative_value(cval, val);
1116 ucontrol->value.integer.value[cnt] = val;
1121 /* master channel */
1122 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1124 return filter_error(cval, err);
1125 val = get_relative_value(cval, val);
1126 ucontrol->value.integer.value[0] = val;
1131 /* put the current value to feature/mixer unit */
1132 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1133 struct snd_ctl_elem_value *ucontrol)
1135 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1136 int c, cnt, val, oval, err;
1141 for (c = 0; c < MAX_CHANNELS; c++) {
1142 if (!(cval->cmask & (1 << c)))
1144 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1146 return filter_error(cval, err);
1147 val = ucontrol->value.integer.value[cnt];
1148 val = get_abs_value(cval, val);
1150 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1156 /* master channel */
1157 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1159 return filter_error(cval, err);
1160 val = ucontrol->value.integer.value[0];
1161 val = get_abs_value(cval, val);
1163 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1170 static struct snd_kcontrol_new usb_feature_unit_ctl = {
1171 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1172 .name = "", /* will be filled later manually */
1173 .info = mixer_ctl_feature_info,
1174 .get = mixer_ctl_feature_get,
1175 .put = mixer_ctl_feature_put,
1178 /* the read-only variant */
1179 static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1180 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1181 .name = "", /* will be filled later manually */
1182 .info = mixer_ctl_feature_info,
1183 .get = mixer_ctl_feature_get,
1188 * This symbol is exported in order to allow the mixer quirks to
1189 * hook up to the standard feature unit control mechanism
1191 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1194 * build a feature control
1196 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1198 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1202 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1203 * rename it to "Headphone". We determine if something is a headphone
1204 * similar to how udev determines form factor.
1206 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1207 struct snd_card *card)
1209 const char *names_to_check[] = {
1210 "Headset", "headset", "Headphone", "headphone", NULL};
1214 if (strcmp("Speaker", kctl->id.name))
1217 for (s = names_to_check; *s; s++)
1218 if (strstr(card->shortname, *s)) {
1226 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1229 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1230 unsigned int ctl_mask, int control,
1231 struct usb_audio_term *iterm, int unitid,
1234 struct uac_feature_unit_descriptor *desc = raw_desc;
1235 struct usb_feature_control_info *ctl_info;
1236 unsigned int len = 0;
1237 int mapped_name = 0;
1238 int nameid = uac_feature_unit_iFeature(desc);
1239 struct snd_kcontrol *kctl;
1240 struct usb_mixer_elem_info *cval;
1241 const struct usbmix_name_map *map;
1244 control++; /* change from zero-based to 1-based value */
1246 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1247 /* FIXME: not supported yet */
1251 map = find_map(state, unitid, control);
1252 if (check_ignored_ctl(map))
1255 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1258 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1259 cval->control = control;
1260 cval->cmask = ctl_mask;
1261 ctl_info = &audio_feature_info[control-1];
1262 if (state->mixer->protocol == UAC_VERSION_1)
1263 cval->val_type = ctl_info->type;
1264 else /* UAC_VERSION_2 */
1265 cval->val_type = ctl_info->type_uac2 >= 0 ?
1266 ctl_info->type_uac2 : ctl_info->type;
1268 if (ctl_mask == 0) {
1269 cval->channels = 1; /* master channel */
1270 cval->master_readonly = readonly_mask;
1273 for (i = 0; i < 16; i++)
1274 if (ctl_mask & (1 << i))
1277 cval->ch_readonly = readonly_mask;
1281 * If all channels in the mask are marked read-only, make the control
1282 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1283 * issue write commands to read-only channels.
1285 if (cval->channels == readonly_mask)
1286 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1288 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1291 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1295 kctl->private_free = snd_usb_mixer_elem_free;
1297 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1298 mapped_name = len != 0;
1300 len = snd_usb_copy_string_desc(state, nameid,
1301 kctl->id.name, sizeof(kctl->id.name));
1307 * determine the control name. the rule is:
1308 * - if a name id is given in descriptor, use it.
1309 * - if the connected input can be determined, then use the name
1311 * - if the connected output can be determined, use it.
1312 * - otherwise, anonymous name.
1315 len = get_term_name(state, iterm, kctl->id.name,
1316 sizeof(kctl->id.name), 1);
1318 len = get_term_name(state, &state->oterm,
1320 sizeof(kctl->id.name), 1);
1322 snprintf(kctl->id.name, sizeof(kctl->id.name),
1323 "Feature %d", unitid);
1327 check_no_speaker_on_headset(kctl, state->mixer->chip->card);
1330 * determine the stream direction:
1331 * if the connected output is USB stream, then it's likely a
1332 * capture stream. otherwise it should be playback (hopefully :)
1334 if (!mapped_name && !(state->oterm.type >> 16)) {
1335 if ((state->oterm.type & 0xff00) == 0x0100)
1336 append_ctl_name(kctl, " Capture");
1338 append_ctl_name(kctl, " Playback");
1340 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1341 " Switch" : " Volume");
1345 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1346 sizeof(kctl->id.name));
1350 /* get min/max values */
1351 get_min_max_with_quirks(cval, 0, kctl);
1353 if (control == UAC_FU_VOLUME) {
1354 check_mapped_dB(map, cval);
1355 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1356 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1357 kctl->vd[0].access |=
1358 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1359 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1363 range = (cval->max - cval->min) / cval->res;
1365 * Are there devices with volume range more than 255? I use a bit more
1366 * to be sure. 384 is a resolution magic number found on Logitech
1367 * devices. It will definitively catch all buggy Logitech devices.
1370 usb_audio_warn(state->chip,
1371 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1373 usb_audio_warn(state->chip,
1374 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1375 cval->head.id, kctl->id.name, cval->channels,
1376 cval->min, cval->max, cval->res);
1379 usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1380 cval->head.id, kctl->id.name, cval->channels,
1381 cval->min, cval->max, cval->res);
1382 snd_usb_mixer_add_control(&cval->head, kctl);
1386 * parse a feature unit
1388 * most of controls are defined here.
1390 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1394 struct usb_audio_term iterm;
1395 unsigned int master_bits, first_ch_bits;
1397 struct uac_feature_unit_descriptor *hdr = _ftr;
1400 if (state->mixer->protocol == UAC_VERSION_1) {
1401 csize = hdr->bControlSize;
1403 usb_audio_dbg(state->chip,
1404 "unit %u: invalid bControlSize == 0\n",
1408 channels = (hdr->bLength - 7) / csize - 1;
1409 bmaControls = hdr->bmaControls;
1410 if (hdr->bLength < 7 + csize) {
1411 usb_audio_err(state->chip,
1412 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1417 struct uac2_feature_unit_descriptor *ftr = _ftr;
1419 channels = (hdr->bLength - 6) / 4 - 1;
1420 bmaControls = ftr->bmaControls;
1421 if (hdr->bLength < 6 + csize) {
1422 usb_audio_err(state->chip,
1423 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1429 /* parse the source unit */
1430 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1433 /* determine the input source type and name */
1434 err = check_input_term(state, hdr->bSourceID, &iterm);
1438 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1439 /* master configuration quirks */
1440 switch (state->chip->usb_id) {
1441 case USB_ID(0x08bb, 0x2702):
1442 usb_audio_info(state->chip,
1443 "usbmixer: master volume quirk for PCM2702 chip\n");
1444 /* disable non-functional volume control */
1445 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1447 case USB_ID(0x1130, 0xf211):
1448 usb_audio_info(state->chip,
1449 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1450 /* disable non-functional volume control */
1456 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1460 if (state->mixer->protocol == UAC_VERSION_1) {
1461 /* check all control types */
1462 for (i = 0; i < 10; i++) {
1463 unsigned int ch_bits = 0;
1464 for (j = 0; j < channels; j++) {
1467 mask = snd_usb_combine_bytes(bmaControls +
1468 csize * (j+1), csize);
1469 if (mask & (1 << i))
1470 ch_bits |= (1 << j);
1472 /* audio class v1 controls are never read-only */
1475 * The first channel must be set
1476 * (for ease of programming).
1479 build_feature_ctl(state, _ftr, ch_bits, i,
1481 if (master_bits & (1 << i))
1482 build_feature_ctl(state, _ftr, 0, i, &iterm,
1485 } else { /* UAC_VERSION_2 */
1486 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1487 unsigned int ch_bits = 0;
1488 unsigned int ch_read_only = 0;
1490 for (j = 0; j < channels; j++) {
1493 mask = snd_usb_combine_bytes(bmaControls +
1494 csize * (j+1), csize);
1495 if (uac2_control_is_readable(mask, i)) {
1496 ch_bits |= (1 << j);
1497 if (!uac2_control_is_writeable(mask, i))
1498 ch_read_only |= (1 << j);
1503 * NOTE: build_feature_ctl() will mark the control
1504 * read-only if all channels are marked read-only in
1505 * the descriptors. Otherwise, the control will be
1506 * reported as writeable, but the driver will not
1507 * actually issue a write command for read-only
1512 * The first channel must be set
1513 * (for ease of programming).
1516 build_feature_ctl(state, _ftr, ch_bits, i,
1517 &iterm, unitid, ch_read_only);
1518 if (uac2_control_is_readable(master_bits, i))
1519 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1520 !uac2_control_is_writeable(master_bits, i));
1532 * build a mixer unit control
1534 * the callbacks are identical with feature unit.
1535 * input channel number (zero based) is given in control field instead.
1537 static void build_mixer_unit_ctl(struct mixer_build *state,
1538 struct uac_mixer_unit_descriptor *desc,
1539 int in_pin, int in_ch, int unitid,
1540 struct usb_audio_term *iterm)
1542 struct usb_mixer_elem_info *cval;
1543 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1544 unsigned int i, len;
1545 struct snd_kcontrol *kctl;
1546 const struct usbmix_name_map *map;
1548 map = find_map(state, unitid, 0);
1549 if (check_ignored_ctl(map))
1552 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1556 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1557 cval->control = in_ch + 1; /* based on 1 */
1558 cval->val_type = USB_MIXER_S16;
1559 for (i = 0; i < num_outs; i++) {
1560 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
1562 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
1563 cval->cmask |= (1 << i);
1568 /* get min/max values */
1569 get_min_max(cval, 0);
1571 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1573 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1577 kctl->private_free = snd_usb_mixer_elem_free;
1579 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1581 len = get_term_name(state, iterm, kctl->id.name,
1582 sizeof(kctl->id.name), 0);
1584 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1585 append_ctl_name(kctl, " Volume");
1587 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
1588 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
1589 snd_usb_mixer_add_control(&cval->head, kctl);
1593 * parse a mixer unit
1595 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
1598 struct uac_mixer_unit_descriptor *desc = raw_desc;
1599 struct usb_audio_term iterm;
1600 int input_pins, num_ins, num_outs;
1603 if (desc->bLength < 11 || !(input_pins = desc->bNrInPins) ||
1604 !(num_outs = uac_mixer_unit_bNrChannels(desc))) {
1605 usb_audio_err(state->chip,
1606 "invalid MIXER UNIT descriptor %d\n",
1613 for (pin = 0; pin < input_pins; pin++) {
1614 err = parse_audio_unit(state, desc->baSourceID[pin]);
1617 /* no bmControls field (e.g. Maya44) -> ignore */
1618 if (desc->bLength <= 10 + input_pins)
1620 err = check_input_term(state, desc->baSourceID[pin], &iterm);
1623 num_ins += iterm.channels;
1624 for (; ich < num_ins; ich++) {
1625 int och, ich_has_controls = 0;
1627 for (och = 0; och < num_outs; och++) {
1628 __u8 *c = uac_mixer_unit_bmControls(desc,
1629 state->mixer->protocol);
1631 if (check_matrix_bitmap(c, ich, och, num_outs)) {
1632 ich_has_controls = 1;
1636 if (ich_has_controls)
1637 build_mixer_unit_ctl(state, desc, pin, ich,
1645 * Processing Unit / Extension Unit
1648 /* get callback for processing/extension unit */
1649 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
1650 struct snd_ctl_elem_value *ucontrol)
1652 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1655 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1657 ucontrol->value.integer.value[0] = cval->min;
1658 return filter_error(cval, err);
1660 val = get_relative_value(cval, val);
1661 ucontrol->value.integer.value[0] = val;
1665 /* put callback for processing/extension unit */
1666 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
1667 struct snd_ctl_elem_value *ucontrol)
1669 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1672 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1674 return filter_error(cval, err);
1675 val = ucontrol->value.integer.value[0];
1676 val = get_abs_value(cval, val);
1678 set_cur_ctl_value(cval, cval->control << 8, val);
1684 /* alsa control interface for processing/extension unit */
1685 static struct snd_kcontrol_new mixer_procunit_ctl = {
1686 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1687 .name = "", /* will be filled later */
1688 .info = mixer_ctl_feature_info,
1689 .get = mixer_ctl_procunit_get,
1690 .put = mixer_ctl_procunit_put,
1694 * predefined data for processing units
1696 struct procunit_value_info {
1703 struct procunit_info {
1706 struct procunit_value_info *values;
1709 static struct procunit_value_info updown_proc_info[] = {
1710 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1711 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1714 static struct procunit_value_info prologic_proc_info[] = {
1715 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1716 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1719 static struct procunit_value_info threed_enh_proc_info[] = {
1720 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1721 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
1724 static struct procunit_value_info reverb_proc_info[] = {
1725 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1726 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1727 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1728 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
1731 static struct procunit_value_info chorus_proc_info[] = {
1732 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1733 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1734 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1735 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1738 static struct procunit_value_info dcr_proc_info[] = {
1739 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1740 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1741 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1742 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1743 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1744 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
1748 static struct procunit_info procunits[] = {
1749 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1750 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1751 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1752 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1753 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1754 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
1758 * predefined data for extension units
1760 static struct procunit_value_info clock_rate_xu_info[] = {
1761 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1764 static struct procunit_value_info clock_source_xu_info[] = {
1765 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1768 static struct procunit_value_info spdif_format_xu_info[] = {
1769 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1772 static struct procunit_value_info soft_limit_xu_info[] = {
1773 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1776 static struct procunit_info extunits[] = {
1777 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1778 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1779 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1780 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1785 * build a processing/extension unit
1787 static int build_audio_procunit(struct mixer_build *state, int unitid,
1788 void *raw_desc, struct procunit_info *list,
1791 struct uac_processing_unit_descriptor *desc = raw_desc;
1792 int num_ins = desc->bNrInPins;
1793 struct usb_mixer_elem_info *cval;
1794 struct snd_kcontrol *kctl;
1795 int i, err, nameid, type, len;
1796 struct procunit_info *info;
1797 struct procunit_value_info *valinfo;
1798 const struct usbmix_name_map *map;
1799 static struct procunit_value_info default_value_info[] = {
1800 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1803 static struct procunit_info default_info = {
1804 0, NULL, default_value_info
1807 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1808 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
1809 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
1813 for (i = 0; i < num_ins; i++) {
1814 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1818 type = le16_to_cpu(desc->wProcessType);
1819 for (info = list; info && info->type; info++)
1820 if (info->type == type)
1822 if (!info || !info->type)
1823 info = &default_info;
1825 for (valinfo = info->values; valinfo->control; valinfo++) {
1826 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
1828 if (!(controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
1830 map = find_map(state, unitid, valinfo->control);
1831 if (check_ignored_ctl(map))
1833 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1836 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1837 cval->control = valinfo->control;
1838 cval->val_type = valinfo->val_type;
1841 /* get min/max values */
1842 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
1843 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
1844 /* FIXME: hard-coded */
1846 cval->max = control_spec[0];
1848 cval->initialized = 1;
1850 if (type == USB_XU_CLOCK_RATE) {
1852 * E-Mu USB 0404/0202/TrackerPre/0204
1853 * samplerate control quirk
1858 cval->initialized = 1;
1860 get_min_max(cval, valinfo->min_value);
1863 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1868 kctl->private_free = snd_usb_mixer_elem_free;
1870 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
1872 } else if (info->name) {
1873 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1875 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
1878 len = snd_usb_copy_string_desc(state, nameid,
1880 sizeof(kctl->id.name));
1882 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1884 append_ctl_name(kctl, " ");
1885 append_ctl_name(kctl, valinfo->suffix);
1887 usb_audio_dbg(state->chip,
1888 "[%d] PU [%s] ch = %d, val = %d/%d\n",
1889 cval->head.id, kctl->id.name, cval->channels,
1890 cval->min, cval->max);
1892 err = snd_usb_mixer_add_control(&cval->head, kctl);
1899 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
1902 return build_audio_procunit(state, unitid, raw_desc,
1903 procunits, "Processing Unit");
1906 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
1910 * Note that we parse extension units with processing unit descriptors.
1911 * That's ok as the layout is the same.
1913 return build_audio_procunit(state, unitid, raw_desc,
1914 extunits, "Extension Unit");
1922 * info callback for selector unit
1923 * use an enumerator type for routing
1925 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
1926 struct snd_ctl_elem_info *uinfo)
1928 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1929 const char **itemlist = (const char **)kcontrol->private_value;
1931 if (snd_BUG_ON(!itemlist))
1933 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
1936 /* get callback for selector unit */
1937 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
1938 struct snd_ctl_elem_value *ucontrol)
1940 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1943 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1945 ucontrol->value.enumerated.item[0] = 0;
1946 return filter_error(cval, err);
1948 val = get_relative_value(cval, val);
1949 ucontrol->value.enumerated.item[0] = val;
1953 /* put callback for selector unit */
1954 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
1955 struct snd_ctl_elem_value *ucontrol)
1957 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1960 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1962 return filter_error(cval, err);
1963 val = ucontrol->value.enumerated.item[0];
1964 val = get_abs_value(cval, val);
1966 set_cur_ctl_value(cval, cval->control << 8, val);
1972 /* alsa control interface for selector unit */
1973 static struct snd_kcontrol_new mixer_selectunit_ctl = {
1974 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1975 .name = "", /* will be filled later */
1976 .info = mixer_ctl_selector_info,
1977 .get = mixer_ctl_selector_get,
1978 .put = mixer_ctl_selector_put,
1982 * private free callback.
1983 * free both private_data and private_value
1985 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
1989 if (kctl->private_data) {
1990 struct usb_mixer_elem_info *cval = kctl->private_data;
1991 num_ins = cval->max;
1993 kctl->private_data = NULL;
1995 if (kctl->private_value) {
1996 char **itemlist = (char **)kctl->private_value;
1997 for (i = 0; i < num_ins; i++)
2000 kctl->private_value = 0;
2005 * parse a selector unit
2007 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2010 struct uac_selector_unit_descriptor *desc = raw_desc;
2011 unsigned int i, nameid, len;
2013 struct usb_mixer_elem_info *cval;
2014 struct snd_kcontrol *kctl;
2015 const struct usbmix_name_map *map;
2018 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
2019 usb_audio_err(state->chip,
2020 "invalid SELECTOR UNIT descriptor %d\n", unitid);
2024 for (i = 0; i < desc->bNrInPins; i++) {
2025 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
2029 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2032 map = find_map(state, unitid, 0);
2033 if (check_ignored_ctl(map))
2036 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2039 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2040 cval->val_type = USB_MIXER_U8;
2043 cval->max = desc->bNrInPins;
2045 cval->initialized = 1;
2047 if (state->mixer->protocol == UAC_VERSION_1)
2049 else /* UAC_VERSION_2 */
2050 cval->control = (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) ?
2051 UAC2_CX_CLOCK_SELECTOR : UAC2_SU_SELECTOR;
2053 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
2058 #define MAX_ITEM_NAME_LEN 64
2059 for (i = 0; i < desc->bNrInPins; i++) {
2060 struct usb_audio_term iterm;
2062 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2070 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2072 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2073 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
2075 sprintf(namelist[i], "Input %u", i);
2078 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2080 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2085 kctl->private_value = (unsigned long)namelist;
2086 kctl->private_free = usb_mixer_selector_elem_free;
2088 nameid = uac_selector_unit_iSelector(desc);
2089 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2093 snd_usb_copy_string_desc(state, nameid, kctl->id.name,
2094 sizeof(kctl->id.name));
2096 len = get_term_name(state, &state->oterm,
2097 kctl->id.name, sizeof(kctl->id.name), 0);
2099 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2101 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
2102 append_ctl_name(kctl, " Clock Source");
2103 else if ((state->oterm.type & 0xff00) == 0x0100)
2104 append_ctl_name(kctl, " Capture Source");
2106 append_ctl_name(kctl, " Playback Source");
2109 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2110 cval->head.id, kctl->id.name, desc->bNrInPins);
2111 return snd_usb_mixer_add_control(&cval->head, kctl);
2115 * parse an audio unit recursively
2118 static int parse_audio_unit(struct mixer_build *state, int unitid)
2122 if (test_and_set_bit(unitid, state->unitbitmap))
2123 return 0; /* the unit already visited */
2125 p1 = find_audio_control_unit(state, unitid);
2127 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2132 case UAC_INPUT_TERMINAL:
2133 case UAC2_CLOCK_SOURCE:
2135 case UAC_MIXER_UNIT:
2136 return parse_audio_mixer_unit(state, unitid, p1);
2137 case UAC_SELECTOR_UNIT:
2138 case UAC2_CLOCK_SELECTOR:
2139 return parse_audio_selector_unit(state, unitid, p1);
2140 case UAC_FEATURE_UNIT:
2141 return parse_audio_feature_unit(state, unitid, p1);
2142 case UAC1_PROCESSING_UNIT:
2143 /* UAC2_EFFECT_UNIT has the same value */
2144 if (state->mixer->protocol == UAC_VERSION_1)
2145 return parse_audio_processing_unit(state, unitid, p1);
2147 return 0; /* FIXME - effect units not implemented yet */
2148 case UAC1_EXTENSION_UNIT:
2149 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2150 if (state->mixer->protocol == UAC_VERSION_1)
2151 return parse_audio_extension_unit(state, unitid, p1);
2152 else /* UAC_VERSION_2 */
2153 return parse_audio_processing_unit(state, unitid, p1);
2154 case UAC2_EXTENSION_UNIT_V2:
2155 return parse_audio_extension_unit(state, unitid, p1);
2157 usb_audio_err(state->chip,
2158 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2163 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2165 kfree(mixer->id_elems);
2167 kfree(mixer->urb->transfer_buffer);
2168 usb_free_urb(mixer->urb);
2170 usb_free_urb(mixer->rc_urb);
2171 kfree(mixer->rc_setup_packet);
2175 static int snd_usb_mixer_dev_free(struct snd_device *device)
2177 struct usb_mixer_interface *mixer = device->device_data;
2178 snd_usb_mixer_free(mixer);
2183 * create mixer controls
2185 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2187 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
2189 struct mixer_build state;
2191 const struct usbmix_ctl_map *map;
2194 memset(&state, 0, sizeof(state));
2195 state.chip = mixer->chip;
2196 state.mixer = mixer;
2197 state.buffer = mixer->hostif->extra;
2198 state.buflen = mixer->hostif->extralen;
2200 /* check the mapping table */
2201 for (map = usbmix_ctl_maps; map->id; map++) {
2202 if (map->id == state.chip->usb_id) {
2203 state.map = map->map;
2204 state.selector_map = map->selector_map;
2205 mixer->ignore_ctl_error = map->ignore_ctl_error;
2211 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
2212 mixer->hostif->extralen,
2213 p, UAC_OUTPUT_TERMINAL)) != NULL) {
2214 if (mixer->protocol == UAC_VERSION_1) {
2215 struct uac1_output_terminal_descriptor *desc = p;
2217 if (desc->bLength < sizeof(*desc))
2218 continue; /* invalid descriptor? */
2219 /* mark terminal ID as visited */
2220 set_bit(desc->bTerminalID, state.unitbitmap);
2221 state.oterm.id = desc->bTerminalID;
2222 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2223 state.oterm.name = desc->iTerminal;
2224 err = parse_audio_unit(&state, desc->bSourceID);
2225 if (err < 0 && err != -EINVAL)
2227 } else { /* UAC_VERSION_2 */
2228 struct uac2_output_terminal_descriptor *desc = p;
2230 if (desc->bLength < sizeof(*desc))
2231 continue; /* invalid descriptor? */
2232 /* mark terminal ID as visited */
2233 set_bit(desc->bTerminalID, state.unitbitmap);
2234 state.oterm.id = desc->bTerminalID;
2235 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2236 state.oterm.name = desc->iTerminal;
2237 err = parse_audio_unit(&state, desc->bSourceID);
2238 if (err < 0 && err != -EINVAL)
2242 * For UAC2, use the same approach to also add the
2245 err = parse_audio_unit(&state, desc->bCSourceID);
2246 if (err < 0 && err != -EINVAL)
2254 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
2256 struct usb_mixer_elem_list *list;
2258 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
2259 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2263 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2264 struct usb_mixer_elem_list *list)
2266 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2267 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2268 "S8", "U8", "S16", "U16"};
2269 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
2270 "channels=%i, type=\"%s\"\n", cval->head.id,
2271 cval->control, cval->cmask, cval->channels,
2272 val_types[cval->val_type]);
2273 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2274 cval->min, cval->max, cval->dBmin, cval->dBmax);
2277 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2278 struct snd_info_buffer *buffer)
2280 struct snd_usb_audio *chip = entry->private_data;
2281 struct usb_mixer_interface *mixer;
2282 struct usb_mixer_elem_list *list;
2285 list_for_each_entry(mixer, &chip->mixer_list, list) {
2287 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2288 chip->usb_id, snd_usb_ctrl_intf(chip),
2289 mixer->ignore_ctl_error);
2290 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2291 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2292 for (list = mixer->id_elems[unitid]; list;
2293 list = list->next_id_elem) {
2294 snd_iprintf(buffer, " Unit: %i\n", list->id);
2297 " Control: name=\"%s\", index=%i\n",
2298 list->kctl->id.name,
2299 list->kctl->id.index);
2301 list->dump(buffer, list);
2307 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2308 int attribute, int value, int index)
2310 struct usb_mixer_elem_list *list;
2311 __u8 unitid = (index >> 8) & 0xff;
2312 __u8 control = (value >> 8) & 0xff;
2313 __u8 channel = value & 0xff;
2315 if (channel >= MAX_CHANNELS) {
2316 usb_audio_dbg(mixer->chip,
2317 "%s(): bogus channel number %d\n",
2322 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
2323 struct usb_mixer_elem_info *info;
2328 info = (struct usb_mixer_elem_info *)list;
2329 if (info->control != control)
2332 switch (attribute) {
2334 /* invalidate cache, so the value is read from the device */
2336 info->cached &= ~(1 << channel);
2337 else /* master channel */
2340 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2341 &info->head.kctl->id);
2353 usb_audio_dbg(mixer->chip,
2354 "unknown attribute %d in interrupt\n",
2361 static void snd_usb_mixer_interrupt(struct urb *urb)
2363 struct usb_mixer_interface *mixer = urb->context;
2364 int len = urb->actual_length;
2365 int ustatus = urb->status;
2370 if (mixer->protocol == UAC_VERSION_1) {
2371 struct uac1_status_word *status;
2373 for (status = urb->transfer_buffer;
2374 len >= sizeof(*status);
2375 len -= sizeof(*status), status++) {
2376 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
2377 status->bStatusType,
2378 status->bOriginator);
2380 /* ignore any notifications not from the control interface */
2381 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2382 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2385 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2386 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2388 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2390 } else { /* UAC_VERSION_2 */
2391 struct uac2_interrupt_data_msg *msg;
2393 for (msg = urb->transfer_buffer;
2394 len >= sizeof(*msg);
2395 len -= sizeof(*msg), msg++) {
2396 /* drop vendor specific and endpoint requests */
2397 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2398 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2401 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2402 le16_to_cpu(msg->wValue),
2403 le16_to_cpu(msg->wIndex));
2408 if (ustatus != -ENOENT &&
2409 ustatus != -ECONNRESET &&
2410 ustatus != -ESHUTDOWN) {
2411 urb->dev = mixer->chip->dev;
2412 usb_submit_urb(urb, GFP_ATOMIC);
2416 /* create the handler for the optional status interrupt endpoint */
2417 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2419 struct usb_endpoint_descriptor *ep;
2420 void *transfer_buffer;
2424 /* we need one interrupt input endpoint */
2425 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
2427 ep = get_endpoint(mixer->hostif, 0);
2428 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2431 epnum = usb_endpoint_num(ep);
2432 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2433 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2434 if (!transfer_buffer)
2436 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2438 kfree(transfer_buffer);
2441 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2442 usb_rcvintpipe(mixer->chip->dev, epnum),
2443 transfer_buffer, buffer_length,
2444 snd_usb_mixer_interrupt, mixer, ep->bInterval);
2445 usb_submit_urb(mixer->urb, GFP_KERNEL);
2449 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2452 static struct snd_device_ops dev_ops = {
2453 .dev_free = snd_usb_mixer_dev_free
2455 struct usb_mixer_interface *mixer;
2456 struct snd_info_entry *entry;
2459 strcpy(chip->card->mixername, "USB Mixer");
2461 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2465 mixer->ignore_ctl_error = ignore_error;
2466 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2468 if (!mixer->id_elems) {
2473 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2474 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
2477 mixer->protocol = UAC_VERSION_1;
2480 mixer->protocol = UAC_VERSION_2;
2484 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2485 (err = snd_usb_mixer_status_create(mixer)) < 0)
2488 snd_usb_mixer_apply_create_quirk(mixer);
2490 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
2494 if (list_empty(&chip->mixer_list) &&
2495 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2496 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2498 list_add(&mixer->list, &chip->mixer_list);
2502 snd_usb_mixer_free(mixer);
2506 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
2508 usb_kill_urb(mixer->urb);
2509 usb_kill_urb(mixer->rc_urb);
2513 /* stop any bus activity of a mixer */
2514 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2516 usb_kill_urb(mixer->urb);
2517 usb_kill_urb(mixer->rc_urb);
2520 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2525 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2533 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
2535 snd_usb_mixer_inactivate(mixer);
2539 static int restore_mixer_value(struct usb_mixer_elem_list *list)
2541 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2546 for (c = 0; c < MAX_CHANNELS; c++) {
2547 if (!(cval->cmask & (1 << c)))
2549 if (cval->cached & (1 << c)) {
2550 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
2551 cval->cache_val[idx]);
2560 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
2569 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
2571 struct usb_mixer_elem_list *list;
2575 /* restore cached mixer values */
2576 for (id = 0; id < MAX_ID_ELEMS; id++) {
2577 for (list = mixer->id_elems[id]; list;
2578 list = list->next_id_elem) {
2580 err = list->resume(list);
2588 return snd_usb_mixer_activate(mixer);
2592 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
2593 struct usb_mixer_interface *mixer,
2596 list->mixer = mixer;
2598 list->dump = snd_usb_mixer_dump_cval;
2600 list->resume = restore_mixer_value;