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_lock_shutdown(chip);
318 while (timeout-- > 0) {
319 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
320 if (snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
321 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
322 validx, idx, buf, val_len) >= val_len) {
323 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
329 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
330 request, validx, idx, cval->val_type);
334 snd_usb_unlock_shutdown(chip);
338 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
339 int validx, int *value_ret)
341 struct snd_usb_audio *chip = cval->head.mixer->chip;
342 unsigned char buf[4 + 3 * sizeof(__u32)]; /* enough space for one range */
344 int idx = 0, ret, size;
347 if (request == UAC_GET_CUR) {
348 bRequest = UAC2_CS_CUR;
349 size = uac2_ctl_value_size(cval->val_type);
351 bRequest = UAC2_CS_RANGE;
355 memset(buf, 0, sizeof(buf));
357 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
361 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
362 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
363 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
364 validx, idx, buf, size);
365 snd_usb_unlock_shutdown(chip);
370 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
371 request, validx, idx, cval->val_type);
375 /* FIXME: how should we handle multiple triplets here? */
382 val = buf + sizeof(__u16);
385 val = buf + sizeof(__u16) * 2;
388 val = buf + sizeof(__u16) * 3;
394 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
399 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
400 int validx, int *value_ret)
402 validx += cval->idx_off;
404 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
405 get_ctl_value_v1(cval, request, validx, value_ret) :
406 get_ctl_value_v2(cval, request, validx, value_ret);
409 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
410 int validx, int *value)
412 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
415 /* channel = 0: master, 1 = first channel */
416 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
417 int channel, int *value)
419 return get_ctl_value(cval, UAC_GET_CUR,
420 (cval->control << 8) | channel,
424 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
425 int channel, int index, int *value)
429 if (cval->cached & (1 << channel)) {
430 *value = cval->cache_val[index];
433 err = get_cur_mix_raw(cval, channel, value);
435 if (!cval->head.mixer->ignore_ctl_error)
436 usb_audio_dbg(cval->head.mixer->chip,
437 "cannot get current value for control %d ch %d: err = %d\n",
438 cval->control, channel, err);
441 cval->cached |= 1 << channel;
442 cval->cache_val[index] = *value;
450 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
451 int request, int validx, int value_set)
453 struct snd_usb_audio *chip = cval->head.mixer->chip;
454 unsigned char buf[4];
455 int idx = 0, val_len, err, timeout = 10;
457 validx += cval->idx_off;
459 if (cval->head.mixer->protocol == UAC_VERSION_1) {
460 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
461 } else { /* UAC_VERSION_2 */
462 val_len = uac2_ctl_value_size(cval->val_type);
465 if (request != UAC_SET_CUR) {
466 usb_audio_dbg(chip, "RANGE setting not yet supported\n");
470 request = UAC2_CS_CUR;
473 value_set = convert_bytes_value(cval, value_set);
474 buf[0] = value_set & 0xff;
475 buf[1] = (value_set >> 8) & 0xff;
476 buf[2] = (value_set >> 16) & 0xff;
477 buf[3] = (value_set >> 24) & 0xff;
479 err = snd_usb_lock_shutdown(chip);
483 while (timeout-- > 0) {
484 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
485 if (snd_usb_ctl_msg(chip->dev,
486 usb_sndctrlpipe(chip->dev, 0), request,
487 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
488 validx, idx, buf, val_len) >= 0) {
493 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
494 request, validx, idx, cval->val_type, buf[0], buf[1]);
498 snd_usb_unlock_shutdown(chip);
502 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
503 int validx, int value)
505 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
508 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
509 int index, int value)
512 unsigned int read_only = (channel == 0) ?
513 cval->master_readonly :
514 cval->ch_readonly & (1 << (channel - 1));
517 usb_audio_dbg(cval->head.mixer->chip,
518 "%s(): channel %d of control %d is read_only\n",
519 __func__, channel, cval->control);
523 err = snd_usb_mixer_set_ctl_value(cval,
524 UAC_SET_CUR, (cval->control << 8) | channel,
528 cval->cached |= 1 << channel;
529 cval->cache_val[index] = value;
534 * TLV callback for mixer volume controls
536 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
537 unsigned int size, unsigned int __user *_tlv)
539 struct usb_mixer_elem_info *cval = kcontrol->private_data;
540 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
542 if (size < sizeof(scale))
544 scale[2] = cval->dBmin;
545 scale[3] = cval->dBmax;
546 if (copy_to_user(_tlv, scale, sizeof(scale)))
552 * parser routines begin here...
555 static int parse_audio_unit(struct mixer_build *state, int unitid);
559 * check if the input/output channel routing is enabled on the given bitmap.
560 * used for mixer unit parser
562 static int check_matrix_bitmap(unsigned char *bmap,
563 int ich, int och, int num_outs)
565 int idx = ich * num_outs + och;
566 return bmap[idx >> 3] & (0x80 >> (idx & 7));
570 * add an alsa control element
571 * search and increment the index until an empty slot is found.
573 * if failed, give up and free the control instance.
576 int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
577 struct snd_kcontrol *kctl)
579 struct usb_mixer_interface *mixer = list->mixer;
582 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
584 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
585 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
590 list->next_id_elem = mixer->id_elems[list->id];
591 mixer->id_elems[list->id] = list;
596 * get a terminal name string
599 static struct iterm_name_combo {
603 { 0x0300, "Output" },
604 { 0x0301, "Speaker" },
605 { 0x0302, "Headphone" },
606 { 0x0303, "HMD Audio" },
607 { 0x0304, "Desktop Speaker" },
608 { 0x0305, "Room Speaker" },
609 { 0x0306, "Com Speaker" },
611 { 0x0600, "External In" },
612 { 0x0601, "Analog In" },
613 { 0x0602, "Digital In" },
615 { 0x0604, "Legacy In" },
616 { 0x0605, "IEC958 In" },
617 { 0x0606, "1394 DA Stream" },
618 { 0x0607, "1394 DV Stream" },
619 { 0x0700, "Embedded" },
620 { 0x0701, "Noise Source" },
621 { 0x0702, "Equalization Noise" },
625 { 0x0706, "MiniDisk" },
626 { 0x0707, "Analog Tape" },
627 { 0x0708, "Phonograph" },
628 { 0x0709, "VCR Audio" },
629 { 0x070a, "Video Disk Audio" },
630 { 0x070b, "DVD Audio" },
631 { 0x070c, "TV Tuner Audio" },
632 { 0x070d, "Satellite Rec Audio" },
633 { 0x070e, "Cable Tuner Audio" },
634 { 0x070f, "DSS Audio" },
635 { 0x0710, "Radio Receiver" },
636 { 0x0711, "Radio Transmitter" },
637 { 0x0712, "Multi-Track Recorder" },
638 { 0x0713, "Synthesizer" },
642 static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
643 unsigned char *name, int maxlen, int term_only)
645 struct iterm_name_combo *names;
648 return snd_usb_copy_string_desc(state, iterm->name,
651 /* virtual type - not a real terminal */
652 if (iterm->type >> 16) {
655 switch (iterm->type >> 16) {
656 case UAC_SELECTOR_UNIT:
657 strcpy(name, "Selector");
659 case UAC1_PROCESSING_UNIT:
660 strcpy(name, "Process Unit");
662 case UAC1_EXTENSION_UNIT:
663 strcpy(name, "Ext Unit");
666 strcpy(name, "Mixer");
669 return sprintf(name, "Unit %d", iterm->id);
673 switch (iterm->type & 0xff00) {
681 strcpy(name, "Headset");
684 strcpy(name, "Phone");
688 for (names = iterm_names; names->type; names++) {
689 if (names->type == iterm->type) {
690 strcpy(name, names->name);
691 return strlen(names->name);
699 * parse the source unit recursively until it reaches to a terminal
700 * or a branched unit.
702 static int check_input_term(struct mixer_build *state, int id,
703 struct usb_audio_term *term)
708 memset(term, 0, sizeof(*term));
709 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
710 unsigned char *hdr = p1;
713 case UAC_INPUT_TERMINAL:
714 if (state->mixer->protocol == UAC_VERSION_1) {
715 struct uac_input_terminal_descriptor *d = p1;
716 term->type = le16_to_cpu(d->wTerminalType);
717 term->channels = d->bNrChannels;
718 term->chconfig = le16_to_cpu(d->wChannelConfig);
719 term->name = d->iTerminal;
720 } else { /* UAC_VERSION_2 */
721 struct uac2_input_terminal_descriptor *d = p1;
723 /* call recursively to verify that the
724 * referenced clock entity is valid */
725 err = check_input_term(state, d->bCSourceID, term);
729 /* save input term properties after recursion,
730 * to ensure they are not overriden by the
733 term->type = le16_to_cpu(d->wTerminalType);
734 term->channels = d->bNrChannels;
735 term->chconfig = le32_to_cpu(d->bmChannelConfig);
736 term->name = d->iTerminal;
739 case UAC_FEATURE_UNIT: {
740 /* the header is the same for v1 and v2 */
741 struct uac_feature_unit_descriptor *d = p1;
743 break; /* continue to parse */
745 case UAC_MIXER_UNIT: {
746 struct uac_mixer_unit_descriptor *d = p1;
747 term->type = d->bDescriptorSubtype << 16; /* virtual type */
748 term->channels = uac_mixer_unit_bNrChannels(d);
749 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
750 term->name = uac_mixer_unit_iMixer(d);
753 case UAC_SELECTOR_UNIT:
754 case UAC2_CLOCK_SELECTOR: {
755 struct uac_selector_unit_descriptor *d = p1;
756 /* call recursively to retrieve the channel info */
757 err = check_input_term(state, d->baSourceID[0], term);
760 term->type = d->bDescriptorSubtype << 16; /* virtual type */
762 term->name = uac_selector_unit_iSelector(d);
765 case UAC1_PROCESSING_UNIT:
766 case UAC1_EXTENSION_UNIT:
767 /* UAC2_PROCESSING_UNIT_V2 */
768 /* UAC2_EFFECT_UNIT */
769 case UAC2_EXTENSION_UNIT_V2: {
770 struct uac_processing_unit_descriptor *d = p1;
772 if (state->mixer->protocol == UAC_VERSION_2 &&
773 hdr[2] == UAC2_EFFECT_UNIT) {
774 /* UAC2/UAC1 unit IDs overlap here in an
775 * uncompatible way. Ignore this unit for now.
781 id = d->baSourceID[0];
782 break; /* continue to parse */
784 term->type = d->bDescriptorSubtype << 16; /* virtual type */
785 term->channels = uac_processing_unit_bNrChannels(d);
786 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
787 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
790 case UAC2_CLOCK_SOURCE: {
791 struct uac_clock_source_descriptor *d = p1;
792 term->type = d->bDescriptorSubtype << 16; /* virtual type */
794 term->name = d->iClockSource;
808 /* feature unit control information */
809 struct usb_feature_control_info {
811 int type; /* data type for uac1 */
812 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
815 static struct usb_feature_control_info audio_feature_info[] = {
816 { "Mute", USB_MIXER_INV_BOOLEAN, -1 },
817 { "Volume", USB_MIXER_S16, -1 },
818 { "Tone Control - Bass", USB_MIXER_S8, -1 },
819 { "Tone Control - Mid", USB_MIXER_S8, -1 },
820 { "Tone Control - Treble", USB_MIXER_S8, -1 },
821 { "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemeted yet */
822 { "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
823 { "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
824 { "Bass Boost", USB_MIXER_BOOLEAN, -1 },
825 { "Loudness", USB_MIXER_BOOLEAN, -1 },
827 { "Input Gain Control", USB_MIXER_S16, -1 },
828 { "Input Gain Pad Control", USB_MIXER_S16, -1 },
829 { "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
832 /* private_free callback */
833 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
835 kfree(kctl->private_data);
836 kctl->private_data = NULL;
840 * interface to ALSA control for feature/mixer units
843 /* volume control quirks */
844 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
845 struct snd_kcontrol *kctl)
847 struct snd_usb_audio *chip = cval->head.mixer->chip;
848 switch (chip->usb_id) {
849 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
850 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
851 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
857 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
858 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
863 if (strstr(kctl->id.name, "Effect Return") != NULL) {
869 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
870 (strstr(kctl->id.name, "Effect Send") != NULL)) {
871 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
877 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
878 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
879 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
881 "set quirk for FTU Effect Duration\n");
887 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
888 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
890 "set quirks for FTU Effect Feedback/Volume\n");
897 case USB_ID(0x0471, 0x0101):
898 case USB_ID(0x0471, 0x0104):
899 case USB_ID(0x0471, 0x0105):
900 case USB_ID(0x0672, 0x1041):
901 /* quirk for UDA1321/N101.
902 * note that detection between firmware 2.1.1.7 (N101)
903 * and later 2.1.1.21 is not very clear from datasheets.
904 * I hope that the min value is -15360 for newer firmware --jk
906 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
907 cval->min == -15616) {
909 "set volume quirk for UDA1321/N101 chip\n");
914 case USB_ID(0x046d, 0x09a4):
915 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
917 "set volume quirk for QuickCam E3500\n");
924 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
925 case USB_ID(0x046d, 0x0808):
926 case USB_ID(0x046d, 0x0809):
927 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
928 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
929 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
930 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
931 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
932 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
933 case USB_ID(0x046d, 0x0991):
934 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
935 /* Most audio usb devices lie about volume resolution.
936 * Most Logitech webcams have res = 384.
937 * Probably there is some logitech magic behind this number --fishor
939 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
941 "set resolution quirk: cval->res = 384\n");
949 * retrieve the minimum and maximum values for the specified control
951 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
952 int default_min, struct snd_kcontrol *kctl)
955 cval->min = default_min;
956 cval->max = cval->min + 1;
958 cval->dBmin = cval->dBmax = 0;
960 if (cval->val_type == USB_MIXER_BOOLEAN ||
961 cval->val_type == USB_MIXER_INV_BOOLEAN) {
962 cval->initialized = 1;
967 for (i = 0; i < MAX_CHANNELS; i++)
968 if (cval->cmask & (1 << i)) {
973 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
974 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
975 usb_audio_err(cval->head.mixer->chip,
976 "%d:%d: cannot get min/max values for control %d (id %d)\n",
977 cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
978 cval->control, cval->head.id);
981 if (get_ctl_value(cval, UAC_GET_RES,
982 (cval->control << 8) | minchn,
986 int last_valid_res = cval->res;
988 while (cval->res > 1) {
989 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
990 (cval->control << 8) | minchn,
995 if (get_ctl_value(cval, UAC_GET_RES,
996 (cval->control << 8) | minchn, &cval->res) < 0)
997 cval->res = last_valid_res;
1002 /* Additional checks for the proper resolution
1004 * Some devices report smaller resolutions than actually
1005 * reacting. They don't return errors but simply clip
1006 * to the lower aligned value.
1008 if (cval->min + cval->res < cval->max) {
1009 int last_valid_res = cval->res;
1010 int saved, test, check;
1011 get_cur_mix_raw(cval, minchn, &saved);
1014 if (test < cval->max)
1018 if (test < cval->min || test > cval->max ||
1019 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1020 get_cur_mix_raw(cval, minchn, &check)) {
1021 cval->res = last_valid_res;
1028 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1031 cval->initialized = 1;
1035 volume_control_quirks(cval, kctl);
1037 /* USB descriptions contain the dB scale in 1/256 dB unit
1038 * while ALSA TLV contains in 1/100 dB unit
1040 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1041 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1042 if (cval->dBmin > cval->dBmax) {
1043 /* something is wrong; assume it's either from/to 0dB */
1044 if (cval->dBmin < 0)
1046 else if (cval->dBmin > 0)
1048 if (cval->dBmin > cval->dBmax) {
1049 /* totally crap, return an error */
1057 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1059 /* get a feature/mixer unit info */
1060 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1061 struct snd_ctl_elem_info *uinfo)
1063 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1065 if (cval->val_type == USB_MIXER_BOOLEAN ||
1066 cval->val_type == USB_MIXER_INV_BOOLEAN)
1067 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1069 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1070 uinfo->count = cval->channels;
1071 if (cval->val_type == USB_MIXER_BOOLEAN ||
1072 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1073 uinfo->value.integer.min = 0;
1074 uinfo->value.integer.max = 1;
1076 if (!cval->initialized) {
1077 get_min_max_with_quirks(cval, 0, kcontrol);
1078 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1079 kcontrol->vd[0].access &=
1080 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1081 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1082 snd_ctl_notify(cval->head.mixer->chip->card,
1083 SNDRV_CTL_EVENT_MASK_INFO,
1087 uinfo->value.integer.min = 0;
1088 uinfo->value.integer.max =
1089 (cval->max - cval->min + cval->res - 1) / cval->res;
1094 /* get the current value from feature/mixer unit */
1095 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1096 struct snd_ctl_elem_value *ucontrol)
1098 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1099 int c, cnt, val, err;
1101 ucontrol->value.integer.value[0] = cval->min;
1104 for (c = 0; c < MAX_CHANNELS; c++) {
1105 if (!(cval->cmask & (1 << c)))
1107 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1109 return filter_error(cval, err);
1110 val = get_relative_value(cval, val);
1111 ucontrol->value.integer.value[cnt] = val;
1116 /* master channel */
1117 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1119 return filter_error(cval, err);
1120 val = get_relative_value(cval, val);
1121 ucontrol->value.integer.value[0] = val;
1126 /* put the current value to feature/mixer unit */
1127 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1128 struct snd_ctl_elem_value *ucontrol)
1130 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1131 int c, cnt, val, oval, err;
1136 for (c = 0; c < MAX_CHANNELS; c++) {
1137 if (!(cval->cmask & (1 << c)))
1139 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1141 return filter_error(cval, err);
1142 val = ucontrol->value.integer.value[cnt];
1143 val = get_abs_value(cval, val);
1145 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1151 /* master channel */
1152 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1154 return filter_error(cval, err);
1155 val = ucontrol->value.integer.value[0];
1156 val = get_abs_value(cval, val);
1158 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1165 static struct snd_kcontrol_new usb_feature_unit_ctl = {
1166 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1167 .name = "", /* will be filled later manually */
1168 .info = mixer_ctl_feature_info,
1169 .get = mixer_ctl_feature_get,
1170 .put = mixer_ctl_feature_put,
1173 /* the read-only variant */
1174 static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1175 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1176 .name = "", /* will be filled later manually */
1177 .info = mixer_ctl_feature_info,
1178 .get = mixer_ctl_feature_get,
1183 * This symbol is exported in order to allow the mixer quirks to
1184 * hook up to the standard feature unit control mechanism
1186 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1189 * build a feature control
1191 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1193 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1197 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1198 * rename it to "Headphone". We determine if something is a headphone
1199 * similar to how udev determines form factor.
1201 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1202 struct snd_card *card)
1204 const char *names_to_check[] = {
1205 "Headset", "headset", "Headphone", "headphone", NULL};
1209 if (strcmp("Speaker", kctl->id.name))
1212 for (s = names_to_check; *s; s++)
1213 if (strstr(card->shortname, *s)) {
1221 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1224 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1225 unsigned int ctl_mask, int control,
1226 struct usb_audio_term *iterm, int unitid,
1229 struct uac_feature_unit_descriptor *desc = raw_desc;
1230 struct usb_feature_control_info *ctl_info;
1231 unsigned int len = 0;
1232 int mapped_name = 0;
1233 int nameid = uac_feature_unit_iFeature(desc);
1234 struct snd_kcontrol *kctl;
1235 struct usb_mixer_elem_info *cval;
1236 const struct usbmix_name_map *map;
1239 control++; /* change from zero-based to 1-based value */
1241 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1242 /* FIXME: not supported yet */
1246 map = find_map(state, unitid, control);
1247 if (check_ignored_ctl(map))
1250 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1253 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1254 cval->control = control;
1255 cval->cmask = ctl_mask;
1256 ctl_info = &audio_feature_info[control-1];
1257 if (state->mixer->protocol == UAC_VERSION_1)
1258 cval->val_type = ctl_info->type;
1259 else /* UAC_VERSION_2 */
1260 cval->val_type = ctl_info->type_uac2 >= 0 ?
1261 ctl_info->type_uac2 : ctl_info->type;
1263 if (ctl_mask == 0) {
1264 cval->channels = 1; /* master channel */
1265 cval->master_readonly = readonly_mask;
1268 for (i = 0; i < 16; i++)
1269 if (ctl_mask & (1 << i))
1272 cval->ch_readonly = readonly_mask;
1276 * If all channels in the mask are marked read-only, make the control
1277 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1278 * issue write commands to read-only channels.
1280 if (cval->channels == readonly_mask)
1281 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1283 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1286 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1290 kctl->private_free = snd_usb_mixer_elem_free;
1292 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1293 mapped_name = len != 0;
1295 len = snd_usb_copy_string_desc(state, nameid,
1296 kctl->id.name, sizeof(kctl->id.name));
1302 * determine the control name. the rule is:
1303 * - if a name id is given in descriptor, use it.
1304 * - if the connected input can be determined, then use the name
1306 * - if the connected output can be determined, use it.
1307 * - otherwise, anonymous name.
1310 len = get_term_name(state, iterm, kctl->id.name,
1311 sizeof(kctl->id.name), 1);
1313 len = get_term_name(state, &state->oterm,
1315 sizeof(kctl->id.name), 1);
1317 snprintf(kctl->id.name, sizeof(kctl->id.name),
1318 "Feature %d", unitid);
1322 check_no_speaker_on_headset(kctl, state->mixer->chip->card);
1325 * determine the stream direction:
1326 * if the connected output is USB stream, then it's likely a
1327 * capture stream. otherwise it should be playback (hopefully :)
1329 if (!mapped_name && !(state->oterm.type >> 16)) {
1330 if ((state->oterm.type & 0xff00) == 0x0100)
1331 append_ctl_name(kctl, " Capture");
1333 append_ctl_name(kctl, " Playback");
1335 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1336 " Switch" : " Volume");
1340 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1341 sizeof(kctl->id.name));
1345 /* get min/max values */
1346 get_min_max_with_quirks(cval, 0, kctl);
1348 if (control == UAC_FU_VOLUME) {
1349 check_mapped_dB(map, cval);
1350 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1351 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1352 kctl->vd[0].access |=
1353 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1354 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1358 snd_usb_mixer_fu_apply_quirk(state->mixer, cval, unitid, kctl);
1360 range = (cval->max - cval->min) / cval->res;
1362 * Are there devices with volume range more than 255? I use a bit more
1363 * to be sure. 384 is a resolution magic number found on Logitech
1364 * devices. It will definitively catch all buggy Logitech devices.
1367 usb_audio_warn(state->chip,
1368 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1370 usb_audio_warn(state->chip,
1371 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1372 cval->head.id, kctl->id.name, cval->channels,
1373 cval->min, cval->max, cval->res);
1376 usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1377 cval->head.id, kctl->id.name, cval->channels,
1378 cval->min, cval->max, cval->res);
1379 snd_usb_mixer_add_control(&cval->head, kctl);
1383 * parse a feature unit
1385 * most of controls are defined here.
1387 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1391 struct usb_audio_term iterm;
1392 unsigned int master_bits, first_ch_bits;
1394 struct uac_feature_unit_descriptor *hdr = _ftr;
1397 if (state->mixer->protocol == UAC_VERSION_1) {
1398 csize = hdr->bControlSize;
1400 usb_audio_dbg(state->chip,
1401 "unit %u: invalid bControlSize == 0\n",
1405 channels = (hdr->bLength - 7) / csize - 1;
1406 bmaControls = hdr->bmaControls;
1407 if (hdr->bLength < 7 + csize) {
1408 usb_audio_err(state->chip,
1409 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1414 struct uac2_feature_unit_descriptor *ftr = _ftr;
1416 channels = (hdr->bLength - 6) / 4 - 1;
1417 bmaControls = ftr->bmaControls;
1418 if (hdr->bLength < 6 + csize) {
1419 usb_audio_err(state->chip,
1420 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1426 /* parse the source unit */
1427 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1430 /* determine the input source type and name */
1431 err = check_input_term(state, hdr->bSourceID, &iterm);
1435 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1436 /* master configuration quirks */
1437 switch (state->chip->usb_id) {
1438 case USB_ID(0x08bb, 0x2702):
1439 usb_audio_info(state->chip,
1440 "usbmixer: master volume quirk for PCM2702 chip\n");
1441 /* disable non-functional volume control */
1442 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1444 case USB_ID(0x1130, 0xf211):
1445 usb_audio_info(state->chip,
1446 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1447 /* disable non-functional volume control */
1453 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1457 if (state->mixer->protocol == UAC_VERSION_1) {
1458 /* check all control types */
1459 for (i = 0; i < 10; i++) {
1460 unsigned int ch_bits = 0;
1461 for (j = 0; j < channels; j++) {
1464 mask = snd_usb_combine_bytes(bmaControls +
1465 csize * (j+1), csize);
1466 if (mask & (1 << i))
1467 ch_bits |= (1 << j);
1469 /* audio class v1 controls are never read-only */
1472 * The first channel must be set
1473 * (for ease of programming).
1476 build_feature_ctl(state, _ftr, ch_bits, i,
1478 if (master_bits & (1 << i))
1479 build_feature_ctl(state, _ftr, 0, i, &iterm,
1482 } else { /* UAC_VERSION_2 */
1483 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1484 unsigned int ch_bits = 0;
1485 unsigned int ch_read_only = 0;
1487 for (j = 0; j < channels; j++) {
1490 mask = snd_usb_combine_bytes(bmaControls +
1491 csize * (j+1), csize);
1492 if (uac2_control_is_readable(mask, i)) {
1493 ch_bits |= (1 << j);
1494 if (!uac2_control_is_writeable(mask, i))
1495 ch_read_only |= (1 << j);
1500 * NOTE: build_feature_ctl() will mark the control
1501 * read-only if all channels are marked read-only in
1502 * the descriptors. Otherwise, the control will be
1503 * reported as writeable, but the driver will not
1504 * actually issue a write command for read-only
1509 * The first channel must be set
1510 * (for ease of programming).
1513 build_feature_ctl(state, _ftr, ch_bits, i,
1514 &iterm, unitid, ch_read_only);
1515 if (uac2_control_is_readable(master_bits, i))
1516 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1517 !uac2_control_is_writeable(master_bits, i));
1529 * build a mixer unit control
1531 * the callbacks are identical with feature unit.
1532 * input channel number (zero based) is given in control field instead.
1534 static void build_mixer_unit_ctl(struct mixer_build *state,
1535 struct uac_mixer_unit_descriptor *desc,
1536 int in_pin, int in_ch, int unitid,
1537 struct usb_audio_term *iterm)
1539 struct usb_mixer_elem_info *cval;
1540 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1541 unsigned int i, len;
1542 struct snd_kcontrol *kctl;
1543 const struct usbmix_name_map *map;
1545 map = find_map(state, unitid, 0);
1546 if (check_ignored_ctl(map))
1549 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1553 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1554 cval->control = in_ch + 1; /* based on 1 */
1555 cval->val_type = USB_MIXER_S16;
1556 for (i = 0; i < num_outs; i++) {
1557 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
1559 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
1560 cval->cmask |= (1 << i);
1565 /* get min/max values */
1566 get_min_max(cval, 0);
1568 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1570 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1574 kctl->private_free = snd_usb_mixer_elem_free;
1576 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1578 len = get_term_name(state, iterm, kctl->id.name,
1579 sizeof(kctl->id.name), 0);
1581 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1582 append_ctl_name(kctl, " Volume");
1584 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
1585 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
1586 snd_usb_mixer_add_control(&cval->head, kctl);
1590 * parse a mixer unit
1592 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
1595 struct uac_mixer_unit_descriptor *desc = raw_desc;
1596 struct usb_audio_term iterm;
1597 int input_pins, num_ins, num_outs;
1600 if (desc->bLength < 11 || !(input_pins = desc->bNrInPins) ||
1601 !(num_outs = uac_mixer_unit_bNrChannels(desc))) {
1602 usb_audio_err(state->chip,
1603 "invalid MIXER UNIT descriptor %d\n",
1610 for (pin = 0; pin < input_pins; pin++) {
1611 err = parse_audio_unit(state, desc->baSourceID[pin]);
1614 /* no bmControls field (e.g. Maya44) -> ignore */
1615 if (desc->bLength <= 10 + input_pins)
1617 err = check_input_term(state, desc->baSourceID[pin], &iterm);
1620 num_ins += iterm.channels;
1621 for (; ich < num_ins; ich++) {
1622 int och, ich_has_controls = 0;
1624 for (och = 0; och < num_outs; och++) {
1625 __u8 *c = uac_mixer_unit_bmControls(desc,
1626 state->mixer->protocol);
1628 if (check_matrix_bitmap(c, ich, och, num_outs)) {
1629 ich_has_controls = 1;
1633 if (ich_has_controls)
1634 build_mixer_unit_ctl(state, desc, pin, ich,
1642 * Processing Unit / Extension Unit
1645 /* get callback for processing/extension unit */
1646 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
1647 struct snd_ctl_elem_value *ucontrol)
1649 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1652 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1654 ucontrol->value.integer.value[0] = cval->min;
1655 return filter_error(cval, err);
1657 val = get_relative_value(cval, val);
1658 ucontrol->value.integer.value[0] = val;
1662 /* put callback for processing/extension unit */
1663 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
1664 struct snd_ctl_elem_value *ucontrol)
1666 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1669 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1671 return filter_error(cval, err);
1672 val = ucontrol->value.integer.value[0];
1673 val = get_abs_value(cval, val);
1675 set_cur_ctl_value(cval, cval->control << 8, val);
1681 /* alsa control interface for processing/extension unit */
1682 static struct snd_kcontrol_new mixer_procunit_ctl = {
1683 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1684 .name = "", /* will be filled later */
1685 .info = mixer_ctl_feature_info,
1686 .get = mixer_ctl_procunit_get,
1687 .put = mixer_ctl_procunit_put,
1691 * predefined data for processing units
1693 struct procunit_value_info {
1700 struct procunit_info {
1703 struct procunit_value_info *values;
1706 static struct procunit_value_info updown_proc_info[] = {
1707 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1708 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1711 static struct procunit_value_info prologic_proc_info[] = {
1712 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1713 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1716 static struct procunit_value_info threed_enh_proc_info[] = {
1717 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1718 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
1721 static struct procunit_value_info reverb_proc_info[] = {
1722 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1723 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1724 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1725 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
1728 static struct procunit_value_info chorus_proc_info[] = {
1729 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1730 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1731 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1732 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1735 static struct procunit_value_info dcr_proc_info[] = {
1736 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1737 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1738 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1739 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1740 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1741 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
1745 static struct procunit_info procunits[] = {
1746 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1747 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1748 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1749 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1750 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1751 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
1755 * predefined data for extension units
1757 static struct procunit_value_info clock_rate_xu_info[] = {
1758 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1761 static struct procunit_value_info clock_source_xu_info[] = {
1762 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1765 static struct procunit_value_info spdif_format_xu_info[] = {
1766 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1769 static struct procunit_value_info soft_limit_xu_info[] = {
1770 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1773 static struct procunit_info extunits[] = {
1774 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1775 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1776 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1777 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1782 * build a processing/extension unit
1784 static int build_audio_procunit(struct mixer_build *state, int unitid,
1785 void *raw_desc, struct procunit_info *list,
1788 struct uac_processing_unit_descriptor *desc = raw_desc;
1789 int num_ins = desc->bNrInPins;
1790 struct usb_mixer_elem_info *cval;
1791 struct snd_kcontrol *kctl;
1792 int i, err, nameid, type, len;
1793 struct procunit_info *info;
1794 struct procunit_value_info *valinfo;
1795 const struct usbmix_name_map *map;
1796 static struct procunit_value_info default_value_info[] = {
1797 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1800 static struct procunit_info default_info = {
1801 0, NULL, default_value_info
1804 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1805 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
1806 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
1810 for (i = 0; i < num_ins; i++) {
1811 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1815 type = le16_to_cpu(desc->wProcessType);
1816 for (info = list; info && info->type; info++)
1817 if (info->type == type)
1819 if (!info || !info->type)
1820 info = &default_info;
1822 for (valinfo = info->values; valinfo->control; valinfo++) {
1823 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
1825 if (!(controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
1827 map = find_map(state, unitid, valinfo->control);
1828 if (check_ignored_ctl(map))
1830 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1833 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1834 cval->control = valinfo->control;
1835 cval->val_type = valinfo->val_type;
1838 /* get min/max values */
1839 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
1840 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
1841 /* FIXME: hard-coded */
1843 cval->max = control_spec[0];
1845 cval->initialized = 1;
1847 if (type == USB_XU_CLOCK_RATE) {
1849 * E-Mu USB 0404/0202/TrackerPre/0204
1850 * samplerate control quirk
1855 cval->initialized = 1;
1857 get_min_max(cval, valinfo->min_value);
1860 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1865 kctl->private_free = snd_usb_mixer_elem_free;
1867 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
1869 } else if (info->name) {
1870 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1872 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
1875 len = snd_usb_copy_string_desc(state, nameid,
1877 sizeof(kctl->id.name));
1879 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1881 append_ctl_name(kctl, " ");
1882 append_ctl_name(kctl, valinfo->suffix);
1884 usb_audio_dbg(state->chip,
1885 "[%d] PU [%s] ch = %d, val = %d/%d\n",
1886 cval->head.id, kctl->id.name, cval->channels,
1887 cval->min, cval->max);
1889 err = snd_usb_mixer_add_control(&cval->head, kctl);
1896 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
1899 return build_audio_procunit(state, unitid, raw_desc,
1900 procunits, "Processing Unit");
1903 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
1907 * Note that we parse extension units with processing unit descriptors.
1908 * That's ok as the layout is the same.
1910 return build_audio_procunit(state, unitid, raw_desc,
1911 extunits, "Extension Unit");
1919 * info callback for selector unit
1920 * use an enumerator type for routing
1922 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
1923 struct snd_ctl_elem_info *uinfo)
1925 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1926 const char **itemlist = (const char **)kcontrol->private_value;
1928 if (snd_BUG_ON(!itemlist))
1930 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
1933 /* get callback for selector unit */
1934 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
1935 struct snd_ctl_elem_value *ucontrol)
1937 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1940 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1942 ucontrol->value.enumerated.item[0] = 0;
1943 return filter_error(cval, err);
1945 val = get_relative_value(cval, val);
1946 ucontrol->value.enumerated.item[0] = val;
1950 /* put callback for selector unit */
1951 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
1952 struct snd_ctl_elem_value *ucontrol)
1954 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1957 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1959 return filter_error(cval, err);
1960 val = ucontrol->value.enumerated.item[0];
1961 val = get_abs_value(cval, val);
1963 set_cur_ctl_value(cval, cval->control << 8, val);
1969 /* alsa control interface for selector unit */
1970 static struct snd_kcontrol_new mixer_selectunit_ctl = {
1971 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1972 .name = "", /* will be filled later */
1973 .info = mixer_ctl_selector_info,
1974 .get = mixer_ctl_selector_get,
1975 .put = mixer_ctl_selector_put,
1979 * private free callback.
1980 * free both private_data and private_value
1982 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
1986 if (kctl->private_data) {
1987 struct usb_mixer_elem_info *cval = kctl->private_data;
1988 num_ins = cval->max;
1990 kctl->private_data = NULL;
1992 if (kctl->private_value) {
1993 char **itemlist = (char **)kctl->private_value;
1994 for (i = 0; i < num_ins; i++)
1997 kctl->private_value = 0;
2002 * parse a selector unit
2004 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2007 struct uac_selector_unit_descriptor *desc = raw_desc;
2008 unsigned int i, nameid, len;
2010 struct usb_mixer_elem_info *cval;
2011 struct snd_kcontrol *kctl;
2012 const struct usbmix_name_map *map;
2015 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
2016 usb_audio_err(state->chip,
2017 "invalid SELECTOR UNIT descriptor %d\n", unitid);
2021 for (i = 0; i < desc->bNrInPins; i++) {
2022 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
2026 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2029 map = find_map(state, unitid, 0);
2030 if (check_ignored_ctl(map))
2033 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2036 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2037 cval->val_type = USB_MIXER_U8;
2040 cval->max = desc->bNrInPins;
2042 cval->initialized = 1;
2044 if (state->mixer->protocol == UAC_VERSION_1)
2046 else /* UAC_VERSION_2 */
2047 cval->control = (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) ?
2048 UAC2_CX_CLOCK_SELECTOR : UAC2_SU_SELECTOR;
2050 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
2055 #define MAX_ITEM_NAME_LEN 64
2056 for (i = 0; i < desc->bNrInPins; i++) {
2057 struct usb_audio_term iterm;
2059 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2067 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2069 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2070 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
2072 sprintf(namelist[i], "Input %u", i);
2075 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2077 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2082 kctl->private_value = (unsigned long)namelist;
2083 kctl->private_free = usb_mixer_selector_elem_free;
2085 nameid = uac_selector_unit_iSelector(desc);
2086 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2090 snd_usb_copy_string_desc(state, nameid, kctl->id.name,
2091 sizeof(kctl->id.name));
2093 len = get_term_name(state, &state->oterm,
2094 kctl->id.name, sizeof(kctl->id.name), 0);
2096 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2098 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
2099 append_ctl_name(kctl, " Clock Source");
2100 else if ((state->oterm.type & 0xff00) == 0x0100)
2101 append_ctl_name(kctl, " Capture Source");
2103 append_ctl_name(kctl, " Playback Source");
2106 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2107 cval->head.id, kctl->id.name, desc->bNrInPins);
2108 return snd_usb_mixer_add_control(&cval->head, kctl);
2112 * parse an audio unit recursively
2115 static int parse_audio_unit(struct mixer_build *state, int unitid)
2119 if (test_and_set_bit(unitid, state->unitbitmap))
2120 return 0; /* the unit already visited */
2122 p1 = find_audio_control_unit(state, unitid);
2124 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2129 case UAC_INPUT_TERMINAL:
2130 case UAC2_CLOCK_SOURCE:
2132 case UAC_MIXER_UNIT:
2133 return parse_audio_mixer_unit(state, unitid, p1);
2134 case UAC_SELECTOR_UNIT:
2135 case UAC2_CLOCK_SELECTOR:
2136 return parse_audio_selector_unit(state, unitid, p1);
2137 case UAC_FEATURE_UNIT:
2138 return parse_audio_feature_unit(state, unitid, p1);
2139 case UAC1_PROCESSING_UNIT:
2140 /* UAC2_EFFECT_UNIT has the same value */
2141 if (state->mixer->protocol == UAC_VERSION_1)
2142 return parse_audio_processing_unit(state, unitid, p1);
2144 return 0; /* FIXME - effect units not implemented yet */
2145 case UAC1_EXTENSION_UNIT:
2146 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2147 if (state->mixer->protocol == UAC_VERSION_1)
2148 return parse_audio_extension_unit(state, unitid, p1);
2149 else /* UAC_VERSION_2 */
2150 return parse_audio_processing_unit(state, unitid, p1);
2151 case UAC2_EXTENSION_UNIT_V2:
2152 return parse_audio_extension_unit(state, unitid, p1);
2154 usb_audio_err(state->chip,
2155 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2160 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2162 kfree(mixer->id_elems);
2164 kfree(mixer->urb->transfer_buffer);
2165 usb_free_urb(mixer->urb);
2167 usb_free_urb(mixer->rc_urb);
2168 kfree(mixer->rc_setup_packet);
2172 static int snd_usb_mixer_dev_free(struct snd_device *device)
2174 struct usb_mixer_interface *mixer = device->device_data;
2175 snd_usb_mixer_free(mixer);
2180 * create mixer controls
2182 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2184 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
2186 struct mixer_build state;
2188 const struct usbmix_ctl_map *map;
2191 memset(&state, 0, sizeof(state));
2192 state.chip = mixer->chip;
2193 state.mixer = mixer;
2194 state.buffer = mixer->hostif->extra;
2195 state.buflen = mixer->hostif->extralen;
2197 /* check the mapping table */
2198 for (map = usbmix_ctl_maps; map->id; map++) {
2199 if (map->id == state.chip->usb_id) {
2200 state.map = map->map;
2201 state.selector_map = map->selector_map;
2202 mixer->ignore_ctl_error = map->ignore_ctl_error;
2208 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
2209 mixer->hostif->extralen,
2210 p, UAC_OUTPUT_TERMINAL)) != NULL) {
2211 if (mixer->protocol == UAC_VERSION_1) {
2212 struct uac1_output_terminal_descriptor *desc = p;
2214 if (desc->bLength < sizeof(*desc))
2215 continue; /* invalid descriptor? */
2216 /* mark terminal ID as visited */
2217 set_bit(desc->bTerminalID, state.unitbitmap);
2218 state.oterm.id = desc->bTerminalID;
2219 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2220 state.oterm.name = desc->iTerminal;
2221 err = parse_audio_unit(&state, desc->bSourceID);
2222 if (err < 0 && err != -EINVAL)
2224 } else { /* UAC_VERSION_2 */
2225 struct uac2_output_terminal_descriptor *desc = p;
2227 if (desc->bLength < sizeof(*desc))
2228 continue; /* invalid descriptor? */
2229 /* mark terminal ID as visited */
2230 set_bit(desc->bTerminalID, state.unitbitmap);
2231 state.oterm.id = desc->bTerminalID;
2232 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2233 state.oterm.name = desc->iTerminal;
2234 err = parse_audio_unit(&state, desc->bSourceID);
2235 if (err < 0 && err != -EINVAL)
2239 * For UAC2, use the same approach to also add the
2242 err = parse_audio_unit(&state, desc->bCSourceID);
2243 if (err < 0 && err != -EINVAL)
2251 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
2253 struct usb_mixer_elem_list *list;
2255 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
2256 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2260 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2261 struct usb_mixer_elem_list *list)
2263 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2264 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2265 "S8", "U8", "S16", "U16"};
2266 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
2267 "channels=%i, type=\"%s\"\n", cval->head.id,
2268 cval->control, cval->cmask, cval->channels,
2269 val_types[cval->val_type]);
2270 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2271 cval->min, cval->max, cval->dBmin, cval->dBmax);
2274 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2275 struct snd_info_buffer *buffer)
2277 struct snd_usb_audio *chip = entry->private_data;
2278 struct usb_mixer_interface *mixer;
2279 struct usb_mixer_elem_list *list;
2282 list_for_each_entry(mixer, &chip->mixer_list, list) {
2284 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2285 chip->usb_id, snd_usb_ctrl_intf(chip),
2286 mixer->ignore_ctl_error);
2287 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2288 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2289 for (list = mixer->id_elems[unitid]; list;
2290 list = list->next_id_elem) {
2291 snd_iprintf(buffer, " Unit: %i\n", list->id);
2294 " Control: name=\"%s\", index=%i\n",
2295 list->kctl->id.name,
2296 list->kctl->id.index);
2298 list->dump(buffer, list);
2304 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2305 int attribute, int value, int index)
2307 struct usb_mixer_elem_list *list;
2308 __u8 unitid = (index >> 8) & 0xff;
2309 __u8 control = (value >> 8) & 0xff;
2310 __u8 channel = value & 0xff;
2312 if (channel >= MAX_CHANNELS) {
2313 usb_audio_dbg(mixer->chip,
2314 "%s(): bogus channel number %d\n",
2319 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
2320 struct usb_mixer_elem_info *info;
2325 info = (struct usb_mixer_elem_info *)list;
2326 if (info->control != control)
2329 switch (attribute) {
2331 /* invalidate cache, so the value is read from the device */
2333 info->cached &= ~(1 << channel);
2334 else /* master channel */
2337 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2338 &info->head.kctl->id);
2350 usb_audio_dbg(mixer->chip,
2351 "unknown attribute %d in interrupt\n",
2358 static void snd_usb_mixer_interrupt(struct urb *urb)
2360 struct usb_mixer_interface *mixer = urb->context;
2361 int len = urb->actual_length;
2362 int ustatus = urb->status;
2367 if (mixer->protocol == UAC_VERSION_1) {
2368 struct uac1_status_word *status;
2370 for (status = urb->transfer_buffer;
2371 len >= sizeof(*status);
2372 len -= sizeof(*status), status++) {
2373 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
2374 status->bStatusType,
2375 status->bOriginator);
2377 /* ignore any notifications not from the control interface */
2378 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2379 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2382 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2383 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2385 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2387 } else { /* UAC_VERSION_2 */
2388 struct uac2_interrupt_data_msg *msg;
2390 for (msg = urb->transfer_buffer;
2391 len >= sizeof(*msg);
2392 len -= sizeof(*msg), msg++) {
2393 /* drop vendor specific and endpoint requests */
2394 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2395 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2398 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2399 le16_to_cpu(msg->wValue),
2400 le16_to_cpu(msg->wIndex));
2405 if (ustatus != -ENOENT &&
2406 ustatus != -ECONNRESET &&
2407 ustatus != -ESHUTDOWN) {
2408 urb->dev = mixer->chip->dev;
2409 usb_submit_urb(urb, GFP_ATOMIC);
2413 /* create the handler for the optional status interrupt endpoint */
2414 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2416 struct usb_endpoint_descriptor *ep;
2417 void *transfer_buffer;
2421 /* we need one interrupt input endpoint */
2422 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
2424 ep = get_endpoint(mixer->hostif, 0);
2425 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2428 epnum = usb_endpoint_num(ep);
2429 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2430 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2431 if (!transfer_buffer)
2433 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2435 kfree(transfer_buffer);
2438 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2439 usb_rcvintpipe(mixer->chip->dev, epnum),
2440 transfer_buffer, buffer_length,
2441 snd_usb_mixer_interrupt, mixer, ep->bInterval);
2442 usb_submit_urb(mixer->urb, GFP_KERNEL);
2446 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2449 static struct snd_device_ops dev_ops = {
2450 .dev_free = snd_usb_mixer_dev_free
2452 struct usb_mixer_interface *mixer;
2453 struct snd_info_entry *entry;
2456 strcpy(chip->card->mixername, "USB Mixer");
2458 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2462 mixer->ignore_ctl_error = ignore_error;
2463 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2465 if (!mixer->id_elems) {
2470 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2471 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
2474 mixer->protocol = UAC_VERSION_1;
2477 mixer->protocol = UAC_VERSION_2;
2481 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2482 (err = snd_usb_mixer_status_create(mixer)) < 0)
2485 snd_usb_mixer_apply_create_quirk(mixer);
2487 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
2491 if (list_empty(&chip->mixer_list) &&
2492 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2493 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2495 list_add(&mixer->list, &chip->mixer_list);
2499 snd_usb_mixer_free(mixer);
2503 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
2505 usb_kill_urb(mixer->urb);
2506 usb_kill_urb(mixer->rc_urb);
2510 /* stop any bus activity of a mixer */
2511 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2513 usb_kill_urb(mixer->urb);
2514 usb_kill_urb(mixer->rc_urb);
2517 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2522 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2530 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
2532 snd_usb_mixer_inactivate(mixer);
2536 static int restore_mixer_value(struct usb_mixer_elem_list *list)
2538 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2543 for (c = 0; c < MAX_CHANNELS; c++) {
2544 if (!(cval->cmask & (1 << c)))
2546 if (cval->cached & (1 << (c + 1))) {
2547 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
2548 cval->cache_val[idx]);
2557 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
2566 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
2568 struct usb_mixer_elem_list *list;
2572 /* restore cached mixer values */
2573 for (id = 0; id < MAX_ID_ELEMS; id++) {
2574 for (list = mixer->id_elems[id]; list;
2575 list = list->next_id_elem) {
2577 err = list->resume(list);
2585 return snd_usb_mixer_activate(mixer);
2589 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
2590 struct usb_mixer_interface *mixer,
2593 list->mixer = mixer;
2595 list->dump = snd_usb_mixer_dump_cval;
2597 list->resume = restore_mixer_value;