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 /* check whether the control should be ignored */
141 check_ignored_ctl(const struct usbmix_name_map *p)
143 if (!p || p->name || p->dB)
149 static inline void check_mapped_dB(const struct usbmix_name_map *p,
150 struct usb_mixer_elem_info *cval)
153 cval->dBmin = p->dB->min;
154 cval->dBmax = p->dB->max;
155 cval->initialized = 1;
159 /* get the mapped selector source name */
160 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
161 int index, char *buf, int buflen)
163 const struct usbmix_selector_map *p;
165 if (! state->selector_map)
167 for (p = state->selector_map; p->id; p++) {
168 if (p->id == unitid && index < p->count)
169 return strlcpy(buf, p->names[index], buflen);
175 * find an audio control unit with the given unit id
177 static void *find_audio_control_unit(struct mixer_build *state, unsigned char unit)
179 /* we just parse the header */
180 struct uac_feature_unit_descriptor *hdr = NULL;
182 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
183 USB_DT_CS_INTERFACE)) != NULL) {
184 if (hdr->bLength >= 4 &&
185 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
186 hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
187 hdr->bUnitID == unit)
195 * copy a string with the given id
197 static int snd_usb_copy_string_desc(struct mixer_build *state, int index, char *buf, int maxlen)
199 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
205 * convert from the byte/word on usb descriptor to the zero-based integer
207 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
209 switch (cval->val_type) {
210 case USB_MIXER_BOOLEAN:
212 case USB_MIXER_INV_BOOLEAN:
235 * convert from the zero-based int to the byte/word for usb descriptor
237 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
239 switch (cval->val_type) {
240 case USB_MIXER_BOOLEAN:
242 case USB_MIXER_INV_BOOLEAN:
251 return 0; /* not reached */
254 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
260 else if (val >= cval->max)
261 return (cval->max - cval->min + cval->res - 1) / cval->res;
263 return (val - cval->min) / cval->res;
266 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
281 * retrieve a mixer value
284 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
286 struct snd_usb_audio *chip = cval->mixer->chip;
287 unsigned char buf[2];
288 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
292 err = snd_usb_autoresume(cval->mixer->chip);
295 mutex_lock(&chip->shutdown_mutex);
296 while (timeout-- > 0) {
299 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8);
300 if (snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
301 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
302 validx, idx, buf, val_len) >= val_len) {
303 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
308 snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
309 request, validx, idx, cval->val_type);
313 mutex_unlock(&chip->shutdown_mutex);
314 snd_usb_autosuspend(cval->mixer->chip);
318 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
320 struct snd_usb_audio *chip = cval->mixer->chip;
321 unsigned char buf[2 + 3*sizeof(__u16)]; /* enough space for one range */
323 int idx = 0, ret, size;
326 if (request == UAC_GET_CUR) {
327 bRequest = UAC2_CS_CUR;
328 size = sizeof(__u16);
330 bRequest = UAC2_CS_RANGE;
334 memset(buf, 0, sizeof(buf));
336 ret = snd_usb_autoresume(chip) ? -EIO : 0;
340 mutex_lock(&chip->shutdown_mutex);
344 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8);
345 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
346 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
347 validx, idx, buf, size);
349 mutex_unlock(&chip->shutdown_mutex);
350 snd_usb_autosuspend(chip);
354 snd_printk(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
355 request, validx, idx, cval->val_type);
359 /* FIXME: how should we handle multiple triplets here? */
366 val = buf + sizeof(__u16);
369 val = buf + sizeof(__u16) * 2;
372 val = buf + sizeof(__u16) * 3;
378 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
383 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
385 return (cval->mixer->protocol == UAC_VERSION_1) ?
386 get_ctl_value_v1(cval, request, validx, value_ret) :
387 get_ctl_value_v2(cval, request, validx, value_ret);
390 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int *value)
392 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
395 /* channel = 0: master, 1 = first channel */
396 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
397 int channel, int *value)
399 return get_ctl_value(cval, UAC_GET_CUR, (cval->control << 8) | channel, value);
402 static int get_cur_mix_value(struct usb_mixer_elem_info *cval,
403 int channel, int index, int *value)
407 if (cval->cached & (1 << channel)) {
408 *value = cval->cache_val[index];
411 err = get_cur_mix_raw(cval, channel, value);
413 if (!cval->mixer->ignore_ctl_error)
414 snd_printd(KERN_ERR "cannot get current value for control %d ch %d: err = %d\n",
415 cval->control, channel, err);
418 cval->cached |= 1 << channel;
419 cval->cache_val[index] = *value;
428 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
429 int request, int validx, int value_set)
431 struct snd_usb_audio *chip = cval->mixer->chip;
432 unsigned char buf[2];
433 int idx = 0, val_len, err, timeout = 10;
435 if (cval->mixer->protocol == UAC_VERSION_1) {
436 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
437 } else { /* UAC_VERSION_2 */
438 /* audio class v2 controls are always 2 bytes in size */
439 val_len = sizeof(__u16);
442 if (request != UAC_SET_CUR) {
443 snd_printdd(KERN_WARNING "RANGE setting not yet supported\n");
447 request = UAC2_CS_CUR;
450 value_set = convert_bytes_value(cval, value_set);
451 buf[0] = value_set & 0xff;
452 buf[1] = (value_set >> 8) & 0xff;
453 err = snd_usb_autoresume(chip);
456 mutex_lock(&chip->shutdown_mutex);
457 while (timeout-- > 0) {
460 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8);
461 if (snd_usb_ctl_msg(chip->dev,
462 usb_sndctrlpipe(chip->dev, 0), request,
463 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
464 validx, idx, buf, val_len) >= 0) {
469 snd_printdd(KERN_ERR "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
470 request, validx, idx, cval->val_type, buf[0], buf[1]);
474 mutex_unlock(&chip->shutdown_mutex);
475 snd_usb_autosuspend(chip);
479 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int value)
481 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
484 static int set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
485 int index, int value)
488 unsigned int read_only = (channel == 0) ?
489 cval->master_readonly :
490 cval->ch_readonly & (1 << (channel - 1));
493 snd_printdd(KERN_INFO "%s(): channel %d of control %d is read_only\n",
494 __func__, channel, cval->control);
498 err = snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, (cval->control << 8) | channel,
502 cval->cached |= 1 << channel;
503 cval->cache_val[index] = value;
508 * TLV callback for mixer volume controls
510 static int mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
511 unsigned int size, unsigned int __user *_tlv)
513 struct usb_mixer_elem_info *cval = kcontrol->private_data;
514 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
516 if (size < sizeof(scale))
518 scale[2] = cval->dBmin;
519 scale[3] = cval->dBmax;
520 if (copy_to_user(_tlv, scale, sizeof(scale)))
526 * parser routines begin here...
529 static int parse_audio_unit(struct mixer_build *state, int unitid);
533 * check if the input/output channel routing is enabled on the given bitmap.
534 * used for mixer unit parser
536 static int check_matrix_bitmap(unsigned char *bmap, int ich, int och, int num_outs)
538 int idx = ich * num_outs + och;
539 return bmap[idx >> 3] & (0x80 >> (idx & 7));
544 * add an alsa control element
545 * search and increment the index until an empty slot is found.
547 * if failed, give up and free the control instance.
550 int snd_usb_mixer_add_control(struct usb_mixer_interface *mixer,
551 struct snd_kcontrol *kctl)
553 struct usb_mixer_elem_info *cval = kctl->private_data;
556 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
558 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
559 snd_printd(KERN_ERR "cannot add control (err = %d)\n", err);
562 cval->elem_id = &kctl->id;
563 cval->next_id_elem = mixer->id_elems[cval->id];
564 mixer->id_elems[cval->id] = cval;
570 * get a terminal name string
573 static struct iterm_name_combo {
577 { 0x0300, "Output" },
578 { 0x0301, "Speaker" },
579 { 0x0302, "Headphone" },
580 { 0x0303, "HMD Audio" },
581 { 0x0304, "Desktop Speaker" },
582 { 0x0305, "Room Speaker" },
583 { 0x0306, "Com Speaker" },
585 { 0x0600, "External In" },
586 { 0x0601, "Analog In" },
587 { 0x0602, "Digital In" },
589 { 0x0604, "Legacy In" },
590 { 0x0605, "IEC958 In" },
591 { 0x0606, "1394 DA Stream" },
592 { 0x0607, "1394 DV Stream" },
593 { 0x0700, "Embedded" },
594 { 0x0701, "Noise Source" },
595 { 0x0702, "Equalization Noise" },
599 { 0x0706, "MiniDisk" },
600 { 0x0707, "Analog Tape" },
601 { 0x0708, "Phonograph" },
602 { 0x0709, "VCR Audio" },
603 { 0x070a, "Video Disk Audio" },
604 { 0x070b, "DVD Audio" },
605 { 0x070c, "TV Tuner Audio" },
606 { 0x070d, "Satellite Rec Audio" },
607 { 0x070e, "Cable Tuner Audio" },
608 { 0x070f, "DSS Audio" },
609 { 0x0710, "Radio Receiver" },
610 { 0x0711, "Radio Transmitter" },
611 { 0x0712, "Multi-Track Recorder" },
612 { 0x0713, "Synthesizer" },
616 static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
617 unsigned char *name, int maxlen, int term_only)
619 struct iterm_name_combo *names;
622 return snd_usb_copy_string_desc(state, iterm->name, name, maxlen);
624 /* virtual type - not a real terminal */
625 if (iterm->type >> 16) {
628 switch (iterm->type >> 16) {
629 case UAC_SELECTOR_UNIT:
630 strcpy(name, "Selector"); return 8;
631 case UAC1_PROCESSING_UNIT:
632 strcpy(name, "Process Unit"); return 12;
633 case UAC1_EXTENSION_UNIT:
634 strcpy(name, "Ext Unit"); return 8;
636 strcpy(name, "Mixer"); return 5;
638 return sprintf(name, "Unit %d", iterm->id);
642 switch (iterm->type & 0xff00) {
644 strcpy(name, "PCM"); return 3;
646 strcpy(name, "Mic"); return 3;
648 strcpy(name, "Headset"); return 7;
650 strcpy(name, "Phone"); return 5;
653 for (names = iterm_names; names->type; names++)
654 if (names->type == iterm->type) {
655 strcpy(name, names->name);
656 return strlen(names->name);
663 * parse the source unit recursively until it reaches to a terminal
664 * or a branched unit.
666 static int check_input_term(struct mixer_build *state, int id, struct usb_audio_term *term)
671 memset(term, 0, sizeof(*term));
672 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
673 unsigned char *hdr = p1;
676 case UAC_INPUT_TERMINAL:
677 if (state->mixer->protocol == UAC_VERSION_1) {
678 struct uac_input_terminal_descriptor *d = p1;
679 term->type = le16_to_cpu(d->wTerminalType);
680 term->channels = d->bNrChannels;
681 term->chconfig = le16_to_cpu(d->wChannelConfig);
682 term->name = d->iTerminal;
683 } else { /* UAC_VERSION_2 */
684 struct uac2_input_terminal_descriptor *d = p1;
685 term->type = le16_to_cpu(d->wTerminalType);
686 term->channels = d->bNrChannels;
687 term->chconfig = le32_to_cpu(d->bmChannelConfig);
688 term->name = d->iTerminal;
690 /* call recursively to get the clock selectors */
691 err = check_input_term(state, d->bCSourceID, term);
696 case UAC_FEATURE_UNIT: {
697 /* the header is the same for v1 and v2 */
698 struct uac_feature_unit_descriptor *d = p1;
700 break; /* continue to parse */
702 case UAC_MIXER_UNIT: {
703 struct uac_mixer_unit_descriptor *d = p1;
704 term->type = d->bDescriptorSubtype << 16; /* virtual type */
705 term->channels = uac_mixer_unit_bNrChannels(d);
706 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
707 term->name = uac_mixer_unit_iMixer(d);
710 case UAC_SELECTOR_UNIT:
711 case UAC2_CLOCK_SELECTOR: {
712 struct uac_selector_unit_descriptor *d = p1;
713 /* call recursively to retrieve the channel info */
714 if (check_input_term(state, d->baSourceID[0], term) < 0)
716 term->type = d->bDescriptorSubtype << 16; /* virtual type */
718 term->name = uac_selector_unit_iSelector(d);
721 case UAC1_PROCESSING_UNIT:
722 case UAC1_EXTENSION_UNIT: {
723 struct uac_processing_unit_descriptor *d = p1;
725 id = d->baSourceID[0];
726 break; /* continue to parse */
728 term->type = d->bDescriptorSubtype << 16; /* virtual type */
729 term->channels = uac_processing_unit_bNrChannels(d);
730 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
731 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
734 case UAC2_CLOCK_SOURCE: {
735 struct uac_clock_source_descriptor *d = p1;
736 term->type = d->bDescriptorSubtype << 16; /* virtual type */
738 term->name = d->iClockSource;
753 /* feature unit control information */
754 struct usb_feature_control_info {
756 unsigned int type; /* control type (mute, volume, etc.) */
759 static struct usb_feature_control_info audio_feature_info[] = {
760 { "Mute", USB_MIXER_INV_BOOLEAN },
761 { "Volume", USB_MIXER_S16 },
762 { "Tone Control - Bass", USB_MIXER_S8 },
763 { "Tone Control - Mid", USB_MIXER_S8 },
764 { "Tone Control - Treble", USB_MIXER_S8 },
765 { "Graphic Equalizer", USB_MIXER_S8 }, /* FIXME: not implemeted yet */
766 { "Auto Gain Control", USB_MIXER_BOOLEAN },
767 { "Delay Control", USB_MIXER_U16 },
768 { "Bass Boost", USB_MIXER_BOOLEAN },
769 { "Loudness", USB_MIXER_BOOLEAN },
771 { "Input Gain Control", USB_MIXER_U16 },
772 { "Input Gain Pad Control", USB_MIXER_BOOLEAN },
773 { "Phase Inverter Control", USB_MIXER_BOOLEAN },
777 /* private_free callback */
778 static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
780 kfree(kctl->private_data);
781 kctl->private_data = NULL;
786 * interface to ALSA control for feature/mixer units
789 /* volume control quirks */
790 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
791 struct snd_kcontrol *kctl)
793 switch (cval->mixer->chip->usb_id) {
794 case USB_ID(0x0471, 0x0101):
795 case USB_ID(0x0471, 0x0104):
796 case USB_ID(0x0471, 0x0105):
797 case USB_ID(0x0672, 0x1041):
798 /* quirk for UDA1321/N101.
799 * note that detection between firmware 2.1.1.7 (N101)
800 * and later 2.1.1.21 is not very clear from datasheets.
801 * I hope that the min value is -15360 for newer firmware --jk
803 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
804 cval->min == -15616) {
806 "set volume quirk for UDA1321/N101 chip\n");
811 case USB_ID(0x046d, 0x09a4):
812 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
814 "set volume quirk for QuickCam E3500\n");
821 case USB_ID(0x046d, 0x0808):
822 case USB_ID(0x046d, 0x0809):
823 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
824 case USB_ID(0x046d, 0x0991):
825 /* Most audio usb devices lie about volume resolution.
826 * Most Logitech webcams have res = 384.
827 * Proboly there is some logitech magic behind this number --fishor
829 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
831 "set resolution quirk: cval->res = 384\n");
840 * retrieve the minimum and maximum values for the specified control
842 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
843 int default_min, struct snd_kcontrol *kctl)
846 cval->min = default_min;
847 cval->max = cval->min + 1;
849 cval->dBmin = cval->dBmax = 0;
851 if (cval->val_type == USB_MIXER_BOOLEAN ||
852 cval->val_type == USB_MIXER_INV_BOOLEAN) {
853 cval->initialized = 1;
858 for (i = 0; i < MAX_CHANNELS; i++)
859 if (cval->cmask & (1 << i)) {
864 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
865 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
866 snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
867 cval->id, snd_usb_ctrl_intf(cval->mixer->chip), cval->control, cval->id);
870 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
873 int last_valid_res = cval->res;
875 while (cval->res > 1) {
876 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
877 (cval->control << 8) | minchn, cval->res / 2) < 0)
881 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
882 cval->res = last_valid_res;
887 /* Additional checks for the proper resolution
889 * Some devices report smaller resolutions than actually
890 * reacting. They don't return errors but simply clip
891 * to the lower aligned value.
893 if (cval->min + cval->res < cval->max) {
894 int last_valid_res = cval->res;
895 int saved, test, check;
896 get_cur_mix_raw(cval, minchn, &saved);
899 if (test < cval->max)
903 if (test < cval->min || test > cval->max ||
904 set_cur_mix_value(cval, minchn, 0, test) ||
905 get_cur_mix_raw(cval, minchn, &check)) {
906 cval->res = last_valid_res;
913 set_cur_mix_value(cval, minchn, 0, saved);
916 cval->initialized = 1;
920 volume_control_quirks(cval, kctl);
922 /* USB descriptions contain the dB scale in 1/256 dB unit
923 * while ALSA TLV contains in 1/100 dB unit
925 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
926 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
927 if (cval->dBmin > cval->dBmax) {
928 /* something is wrong; assume it's either from/to 0dB */
931 else if (cval->dBmin > 0)
933 if (cval->dBmin > cval->dBmax) {
934 /* totally crap, return an error */
942 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
944 /* get a feature/mixer unit info */
945 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
947 struct usb_mixer_elem_info *cval = kcontrol->private_data;
949 if (cval->val_type == USB_MIXER_BOOLEAN ||
950 cval->val_type == USB_MIXER_INV_BOOLEAN)
951 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
953 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
954 uinfo->count = cval->channels;
955 if (cval->val_type == USB_MIXER_BOOLEAN ||
956 cval->val_type == USB_MIXER_INV_BOOLEAN) {
957 uinfo->value.integer.min = 0;
958 uinfo->value.integer.max = 1;
960 if (!cval->initialized) {
961 get_min_max_with_quirks(cval, 0, kcontrol);
962 if (cval->initialized && cval->dBmin >= cval->dBmax) {
963 kcontrol->vd[0].access &=
964 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
965 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
966 snd_ctl_notify(cval->mixer->chip->card,
967 SNDRV_CTL_EVENT_MASK_INFO,
971 uinfo->value.integer.min = 0;
972 uinfo->value.integer.max =
973 (cval->max - cval->min + cval->res - 1) / cval->res;
978 /* get the current value from feature/mixer unit */
979 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
981 struct usb_mixer_elem_info *cval = kcontrol->private_data;
982 int c, cnt, val, err;
984 ucontrol->value.integer.value[0] = cval->min;
987 for (c = 0; c < MAX_CHANNELS; c++) {
988 if (!(cval->cmask & (1 << c)))
990 err = get_cur_mix_value(cval, c + 1, cnt, &val);
992 return cval->mixer->ignore_ctl_error ? 0 : err;
993 val = get_relative_value(cval, val);
994 ucontrol->value.integer.value[cnt] = val;
1000 err = get_cur_mix_value(cval, 0, 0, &val);
1002 return cval->mixer->ignore_ctl_error ? 0 : err;
1003 val = get_relative_value(cval, val);
1004 ucontrol->value.integer.value[0] = val;
1009 /* put the current value to feature/mixer unit */
1010 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1012 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1013 int c, cnt, val, oval, err;
1018 for (c = 0; c < MAX_CHANNELS; c++) {
1019 if (!(cval->cmask & (1 << c)))
1021 err = get_cur_mix_value(cval, c + 1, cnt, &oval);
1023 return cval->mixer->ignore_ctl_error ? 0 : err;
1024 val = ucontrol->value.integer.value[cnt];
1025 val = get_abs_value(cval, val);
1027 set_cur_mix_value(cval, c + 1, cnt, val);
1033 /* master channel */
1034 err = get_cur_mix_value(cval, 0, 0, &oval);
1036 return cval->mixer->ignore_ctl_error ? 0 : err;
1037 val = ucontrol->value.integer.value[0];
1038 val = get_abs_value(cval, val);
1040 set_cur_mix_value(cval, 0, 0, val);
1047 static struct snd_kcontrol_new usb_feature_unit_ctl = {
1048 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1049 .name = "", /* will be filled later manually */
1050 .info = mixer_ctl_feature_info,
1051 .get = mixer_ctl_feature_get,
1052 .put = mixer_ctl_feature_put,
1055 /* the read-only variant */
1056 static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1057 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1058 .name = "", /* will be filled later manually */
1059 .info = mixer_ctl_feature_info,
1060 .get = mixer_ctl_feature_get,
1064 /* This symbol is exported in order to allow the mixer quirks to
1065 * hook up to the standard feature unit control mechanism */
1066 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1069 * build a feature control
1072 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1074 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1077 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1078 unsigned int ctl_mask, int control,
1079 struct usb_audio_term *iterm, int unitid,
1082 struct uac_feature_unit_descriptor *desc = raw_desc;
1083 unsigned int len = 0;
1084 int mapped_name = 0;
1085 int nameid = uac_feature_unit_iFeature(desc);
1086 struct snd_kcontrol *kctl;
1087 struct usb_mixer_elem_info *cval;
1088 const struct usbmix_name_map *map;
1091 control++; /* change from zero-based to 1-based value */
1093 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1094 /* FIXME: not supported yet */
1098 map = find_map(state, unitid, control);
1099 if (check_ignored_ctl(map))
1102 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1104 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1107 cval->mixer = state->mixer;
1109 cval->control = control;
1110 cval->cmask = ctl_mask;
1111 cval->val_type = audio_feature_info[control-1].type;
1112 if (ctl_mask == 0) {
1113 cval->channels = 1; /* master channel */
1114 cval->master_readonly = readonly_mask;
1117 for (i = 0; i < 16; i++)
1118 if (ctl_mask & (1 << i))
1121 cval->ch_readonly = readonly_mask;
1124 /* if all channels in the mask are marked read-only, make the control
1125 * read-only. set_cur_mix_value() will check the mask again and won't
1126 * issue write commands to read-only channels. */
1127 if (cval->channels == readonly_mask)
1128 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1130 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1133 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1137 kctl->private_free = usb_mixer_elem_free;
1139 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1140 mapped_name = len != 0;
1141 if (! len && nameid)
1142 len = snd_usb_copy_string_desc(state, nameid,
1143 kctl->id.name, sizeof(kctl->id.name));
1145 /* get min/max values */
1146 get_min_max_with_quirks(cval, 0, kctl);
1151 /* determine the control name. the rule is:
1152 * - if a name id is given in descriptor, use it.
1153 * - if the connected input can be determined, then use the name
1155 * - if the connected output can be determined, use it.
1156 * - otherwise, anonymous name.
1159 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1);
1161 len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1);
1163 len = snprintf(kctl->id.name, sizeof(kctl->id.name),
1164 "Feature %d", unitid);
1166 /* determine the stream direction:
1167 * if the connected output is USB stream, then it's likely a
1168 * capture stream. otherwise it should be playback (hopefully :)
1170 if (! mapped_name && ! (state->oterm.type >> 16)) {
1171 if ((state->oterm.type & 0xff00) == 0x0100) {
1172 len = append_ctl_name(kctl, " Capture");
1174 len = append_ctl_name(kctl, " Playback");
1177 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1178 " Switch" : " Volume");
1179 if (control == UAC_FU_VOLUME) {
1180 check_mapped_dB(map, cval);
1181 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1182 kctl->tlv.c = mixer_vol_tlv;
1183 kctl->vd[0].access |=
1184 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1185 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1192 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1193 sizeof(kctl->id.name));
1197 range = (cval->max - cval->min) / cval->res;
1198 /* Are there devices with volume range more than 255? I use a bit more
1199 * to be sure. 384 is a resolution magic number found on Logitech
1200 * devices. It will definitively catch all buggy Logitech devices.
1203 snd_printk(KERN_WARNING "usb_audio: Warning! Unlikely big "
1204 "volume range (=%u), cval->res is probably wrong.",
1206 snd_printk(KERN_WARNING "usb_audio: [%d] FU [%s] ch = %d, "
1207 "val = %d/%d/%d", cval->id,
1208 kctl->id.name, cval->channels,
1209 cval->min, cval->max, cval->res);
1212 snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1213 cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
1214 snd_usb_mixer_add_control(state->mixer, kctl);
1220 * parse a feature unit
1222 * most of controls are defined here.
1224 static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr)
1227 struct usb_audio_term iterm;
1228 unsigned int master_bits, first_ch_bits;
1230 struct uac_feature_unit_descriptor *hdr = _ftr;
1233 if (state->mixer->protocol == UAC_VERSION_1) {
1234 csize = hdr->bControlSize;
1236 snd_printdd(KERN_ERR "usbaudio: unit %u: "
1237 "invalid bControlSize == 0\n", unitid);
1240 channels = (hdr->bLength - 7) / csize - 1;
1241 bmaControls = hdr->bmaControls;
1243 struct uac2_feature_unit_descriptor *ftr = _ftr;
1245 channels = (hdr->bLength - 6) / 4 - 1;
1246 bmaControls = ftr->bmaControls;
1249 if (hdr->bLength < 7 || !csize || hdr->bLength < 7 + csize) {
1250 snd_printk(KERN_ERR "usbaudio: unit %u: invalid UAC_FEATURE_UNIT descriptor\n", unitid);
1254 /* parse the source unit */
1255 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1258 /* determine the input source type and name */
1259 if (check_input_term(state, hdr->bSourceID, &iterm) < 0)
1262 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1263 /* master configuration quirks */
1264 switch (state->chip->usb_id) {
1265 case USB_ID(0x08bb, 0x2702):
1266 snd_printk(KERN_INFO
1267 "usbmixer: master volume quirk for PCM2702 chip\n");
1268 /* disable non-functional volume control */
1269 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1273 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1277 if (state->mixer->protocol == UAC_VERSION_1) {
1278 /* check all control types */
1279 for (i = 0; i < 10; i++) {
1280 unsigned int ch_bits = 0;
1281 for (j = 0; j < channels; j++) {
1282 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1283 if (mask & (1 << i))
1284 ch_bits |= (1 << j);
1286 /* audio class v1 controls are never read-only */
1287 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1288 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, 0);
1289 if (master_bits & (1 << i))
1290 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 0);
1292 } else { /* UAC_VERSION_2 */
1293 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1294 unsigned int ch_bits = 0;
1295 unsigned int ch_read_only = 0;
1297 for (j = 0; j < channels; j++) {
1298 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1299 if (uac2_control_is_readable(mask, i)) {
1300 ch_bits |= (1 << j);
1301 if (!uac2_control_is_writeable(mask, i))
1302 ch_read_only |= (1 << j);
1306 /* NOTE: build_feature_ctl() will mark the control read-only if all channels
1307 * are marked read-only in the descriptors. Otherwise, the control will be
1308 * reported as writeable, but the driver will not actually issue a write
1309 * command for read-only channels */
1310 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1311 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, ch_read_only);
1312 if (uac2_control_is_readable(master_bits, i))
1313 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1314 !uac2_control_is_writeable(master_bits, i));
1327 * build a mixer unit control
1329 * the callbacks are identical with feature unit.
1330 * input channel number (zero based) is given in control field instead.
1333 static void build_mixer_unit_ctl(struct mixer_build *state,
1334 struct uac_mixer_unit_descriptor *desc,
1335 int in_pin, int in_ch, int unitid,
1336 struct usb_audio_term *iterm)
1338 struct usb_mixer_elem_info *cval;
1339 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1340 unsigned int i, len;
1341 struct snd_kcontrol *kctl;
1342 const struct usbmix_name_map *map;
1344 map = find_map(state, unitid, 0);
1345 if (check_ignored_ctl(map))
1348 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1352 cval->mixer = state->mixer;
1354 cval->control = in_ch + 1; /* based on 1 */
1355 cval->val_type = USB_MIXER_S16;
1356 for (i = 0; i < num_outs; i++) {
1357 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), in_ch, i, num_outs)) {
1358 cval->cmask |= (1 << i);
1363 /* get min/max values */
1364 get_min_max(cval, 0);
1366 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1368 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1372 kctl->private_free = usb_mixer_elem_free;
1374 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1376 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
1378 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1379 append_ctl_name(kctl, " Volume");
1381 snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
1382 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1383 snd_usb_mixer_add_control(state->mixer, kctl);
1388 * parse a mixer unit
1390 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, void *raw_desc)
1392 struct uac_mixer_unit_descriptor *desc = raw_desc;
1393 struct usb_audio_term iterm;
1394 int input_pins, num_ins, num_outs;
1397 if (desc->bLength < 11 || ! (input_pins = desc->bNrInPins) || ! (num_outs = uac_mixer_unit_bNrChannels(desc))) {
1398 snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
1401 /* no bmControls field (e.g. Maya44) -> ignore */
1402 if (desc->bLength <= 10 + input_pins) {
1403 snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
1409 for (pin = 0; pin < input_pins; pin++) {
1410 err = parse_audio_unit(state, desc->baSourceID[pin]);
1413 err = check_input_term(state, desc->baSourceID[pin], &iterm);
1416 num_ins += iterm.channels;
1417 for (; ich < num_ins; ++ich) {
1418 int och, ich_has_controls = 0;
1420 for (och = 0; och < num_outs; ++och) {
1421 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol),
1422 ich, och, num_outs)) {
1423 ich_has_controls = 1;
1427 if (ich_has_controls)
1428 build_mixer_unit_ctl(state, desc, pin, ich,
1437 * Processing Unit / Extension Unit
1440 /* get callback for processing/extension unit */
1441 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1443 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1446 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1447 if (err < 0 && cval->mixer->ignore_ctl_error) {
1448 ucontrol->value.integer.value[0] = cval->min;
1453 val = get_relative_value(cval, val);
1454 ucontrol->value.integer.value[0] = val;
1458 /* put callback for processing/extension unit */
1459 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1461 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1464 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1466 if (cval->mixer->ignore_ctl_error)
1470 val = ucontrol->value.integer.value[0];
1471 val = get_abs_value(cval, val);
1473 set_cur_ctl_value(cval, cval->control << 8, val);
1479 /* alsa control interface for processing/extension unit */
1480 static struct snd_kcontrol_new mixer_procunit_ctl = {
1481 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1482 .name = "", /* will be filled later */
1483 .info = mixer_ctl_feature_info,
1484 .get = mixer_ctl_procunit_get,
1485 .put = mixer_ctl_procunit_put,
1490 * predefined data for processing units
1492 struct procunit_value_info {
1499 struct procunit_info {
1502 struct procunit_value_info *values;
1505 static struct procunit_value_info updown_proc_info[] = {
1506 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1507 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1510 static struct procunit_value_info prologic_proc_info[] = {
1511 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1512 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1515 static struct procunit_value_info threed_enh_proc_info[] = {
1516 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1517 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
1520 static struct procunit_value_info reverb_proc_info[] = {
1521 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1522 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1523 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1524 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
1527 static struct procunit_value_info chorus_proc_info[] = {
1528 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1529 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1530 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1531 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1534 static struct procunit_value_info dcr_proc_info[] = {
1535 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1536 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1537 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1538 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1539 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1540 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
1544 static struct procunit_info procunits[] = {
1545 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1546 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1547 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1548 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1549 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1550 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
1554 * predefined data for extension units
1556 static struct procunit_value_info clock_rate_xu_info[] = {
1557 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1560 static struct procunit_value_info clock_source_xu_info[] = {
1561 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1564 static struct procunit_value_info spdif_format_xu_info[] = {
1565 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1568 static struct procunit_value_info soft_limit_xu_info[] = {
1569 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1572 static struct procunit_info extunits[] = {
1573 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1574 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1575 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1576 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1580 * build a processing/extension unit
1582 static int build_audio_procunit(struct mixer_build *state, int unitid, void *raw_desc, struct procunit_info *list, char *name)
1584 struct uac_processing_unit_descriptor *desc = raw_desc;
1585 int num_ins = desc->bNrInPins;
1586 struct usb_mixer_elem_info *cval;
1587 struct snd_kcontrol *kctl;
1588 int i, err, nameid, type, len;
1589 struct procunit_info *info;
1590 struct procunit_value_info *valinfo;
1591 const struct usbmix_name_map *map;
1592 static struct procunit_value_info default_value_info[] = {
1593 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1596 static struct procunit_info default_info = {
1597 0, NULL, default_value_info
1600 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1601 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
1602 snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1606 for (i = 0; i < num_ins; i++) {
1607 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1611 type = le16_to_cpu(desc->wProcessType);
1612 for (info = list; info && info->type; info++)
1613 if (info->type == type)
1615 if (! info || ! info->type)
1616 info = &default_info;
1618 for (valinfo = info->values; valinfo->control; valinfo++) {
1619 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
1621 if (! (controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
1623 map = find_map(state, unitid, valinfo->control);
1624 if (check_ignored_ctl(map))
1626 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1628 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1631 cval->mixer = state->mixer;
1633 cval->control = valinfo->control;
1634 cval->val_type = valinfo->val_type;
1637 /* get min/max values */
1638 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
1639 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
1640 /* FIXME: hard-coded */
1642 cval->max = control_spec[0];
1644 cval->initialized = 1;
1646 if (type == USB_XU_CLOCK_RATE) {
1647 /* E-Mu USB 0404/0202/TrackerPre/0204
1648 * samplerate control quirk
1653 cval->initialized = 1;
1655 get_min_max(cval, valinfo->min_value);
1658 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1660 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1664 kctl->private_free = usb_mixer_elem_free;
1666 if (check_mapped_name(map, kctl->id.name,
1667 sizeof(kctl->id.name)))
1669 else if (info->name)
1670 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1672 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
1675 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1677 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1679 append_ctl_name(kctl, " ");
1680 append_ctl_name(kctl, valinfo->suffix);
1682 snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
1683 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1684 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
1691 static int parse_audio_processing_unit(struct mixer_build *state, int unitid, void *raw_desc)
1693 return build_audio_procunit(state, unitid, raw_desc, procunits, "Processing Unit");
1696 static int parse_audio_extension_unit(struct mixer_build *state, int unitid, void *raw_desc)
1698 /* Note that we parse extension units with processing unit descriptors.
1699 * That's ok as the layout is the same */
1700 return build_audio_procunit(state, unitid, raw_desc, extunits, "Extension Unit");
1708 /* info callback for selector unit
1709 * use an enumerator type for routing
1711 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
1713 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1714 const char **itemlist = (const char **)kcontrol->private_value;
1716 if (snd_BUG_ON(!itemlist))
1718 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
1721 /* get callback for selector unit */
1722 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1724 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1727 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1729 if (cval->mixer->ignore_ctl_error) {
1730 ucontrol->value.enumerated.item[0] = 0;
1735 val = get_relative_value(cval, val);
1736 ucontrol->value.enumerated.item[0] = val;
1740 /* put callback for selector unit */
1741 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1743 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1746 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1748 if (cval->mixer->ignore_ctl_error)
1752 val = ucontrol->value.enumerated.item[0];
1753 val = get_abs_value(cval, val);
1755 set_cur_ctl_value(cval, cval->control << 8, val);
1761 /* alsa control interface for selector unit */
1762 static struct snd_kcontrol_new mixer_selectunit_ctl = {
1763 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1764 .name = "", /* will be filled later */
1765 .info = mixer_ctl_selector_info,
1766 .get = mixer_ctl_selector_get,
1767 .put = mixer_ctl_selector_put,
1771 /* private free callback.
1772 * free both private_data and private_value
1774 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
1778 if (kctl->private_data) {
1779 struct usb_mixer_elem_info *cval = kctl->private_data;
1780 num_ins = cval->max;
1782 kctl->private_data = NULL;
1784 if (kctl->private_value) {
1785 char **itemlist = (char **)kctl->private_value;
1786 for (i = 0; i < num_ins; i++)
1789 kctl->private_value = 0;
1794 * parse a selector unit
1796 static int parse_audio_selector_unit(struct mixer_build *state, int unitid, void *raw_desc)
1798 struct uac_selector_unit_descriptor *desc = raw_desc;
1799 unsigned int i, nameid, len;
1801 struct usb_mixer_elem_info *cval;
1802 struct snd_kcontrol *kctl;
1803 const struct usbmix_name_map *map;
1806 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
1807 snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
1811 for (i = 0; i < desc->bNrInPins; i++) {
1812 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1816 if (desc->bNrInPins == 1) /* only one ? nonsense! */
1819 map = find_map(state, unitid, 0);
1820 if (check_ignored_ctl(map))
1823 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1825 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1828 cval->mixer = state->mixer;
1830 cval->val_type = USB_MIXER_U8;
1833 cval->max = desc->bNrInPins;
1835 cval->initialized = 1;
1837 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1838 cval->control = UAC2_CX_CLOCK_SELECTOR;
1842 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
1844 snd_printk(KERN_ERR "cannot malloc\n");
1848 #define MAX_ITEM_NAME_LEN 64
1849 for (i = 0; i < desc->bNrInPins; i++) {
1850 struct usb_audio_term iterm;
1852 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
1853 if (! namelist[i]) {
1854 snd_printk(KERN_ERR "cannot malloc\n");
1861 len = check_mapped_selector_name(state, unitid, i, namelist[i],
1863 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
1864 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
1866 sprintf(namelist[i], "Input %d", i);
1869 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
1871 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1876 kctl->private_value = (unsigned long)namelist;
1877 kctl->private_free = usb_mixer_selector_elem_free;
1879 nameid = uac_selector_unit_iSelector(desc);
1880 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1884 snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1886 len = get_term_name(state, &state->oterm,
1887 kctl->id.name, sizeof(kctl->id.name), 0);
1889 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
1891 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1892 append_ctl_name(kctl, " Clock Source");
1893 else if ((state->oterm.type & 0xff00) == 0x0100)
1894 append_ctl_name(kctl, " Capture Source");
1896 append_ctl_name(kctl, " Playback Source");
1899 snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
1900 cval->id, kctl->id.name, desc->bNrInPins);
1901 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
1909 * parse an audio unit recursively
1912 static int parse_audio_unit(struct mixer_build *state, int unitid)
1916 if (test_and_set_bit(unitid, state->unitbitmap))
1917 return 0; /* the unit already visited */
1919 p1 = find_audio_control_unit(state, unitid);
1921 snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
1926 case UAC_INPUT_TERMINAL:
1927 case UAC2_CLOCK_SOURCE:
1929 case UAC_MIXER_UNIT:
1930 return parse_audio_mixer_unit(state, unitid, p1);
1931 case UAC_SELECTOR_UNIT:
1932 case UAC2_CLOCK_SELECTOR:
1933 return parse_audio_selector_unit(state, unitid, p1);
1934 case UAC_FEATURE_UNIT:
1935 return parse_audio_feature_unit(state, unitid, p1);
1936 case UAC1_PROCESSING_UNIT:
1937 /* UAC2_EFFECT_UNIT has the same value */
1938 if (state->mixer->protocol == UAC_VERSION_1)
1939 return parse_audio_processing_unit(state, unitid, p1);
1941 return 0; /* FIXME - effect units not implemented yet */
1942 case UAC1_EXTENSION_UNIT:
1943 /* UAC2_PROCESSING_UNIT_V2 has the same value */
1944 if (state->mixer->protocol == UAC_VERSION_1)
1945 return parse_audio_extension_unit(state, unitid, p1);
1946 else /* UAC_VERSION_2 */
1947 return parse_audio_processing_unit(state, unitid, p1);
1949 snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
1954 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
1956 kfree(mixer->id_elems);
1958 kfree(mixer->urb->transfer_buffer);
1959 usb_free_urb(mixer->urb);
1961 usb_free_urb(mixer->rc_urb);
1962 kfree(mixer->rc_setup_packet);
1966 static int snd_usb_mixer_dev_free(struct snd_device *device)
1968 struct usb_mixer_interface *mixer = device->device_data;
1969 snd_usb_mixer_free(mixer);
1974 * create mixer controls
1976 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
1978 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
1980 struct mixer_build state;
1982 const struct usbmix_ctl_map *map;
1985 memset(&state, 0, sizeof(state));
1986 state.chip = mixer->chip;
1987 state.mixer = mixer;
1988 state.buffer = mixer->hostif->extra;
1989 state.buflen = mixer->hostif->extralen;
1991 /* check the mapping table */
1992 for (map = usbmix_ctl_maps; map->id; map++) {
1993 if (map->id == state.chip->usb_id) {
1994 state.map = map->map;
1995 state.selector_map = map->selector_map;
1996 mixer->ignore_ctl_error = map->ignore_ctl_error;
2002 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra, mixer->hostif->extralen,
2003 p, UAC_OUTPUT_TERMINAL)) != NULL) {
2004 if (mixer->protocol == UAC_VERSION_1) {
2005 struct uac1_output_terminal_descriptor *desc = p;
2007 if (desc->bLength < sizeof(*desc))
2008 continue; /* invalid descriptor? */
2009 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
2010 state.oterm.id = desc->bTerminalID;
2011 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2012 state.oterm.name = desc->iTerminal;
2013 err = parse_audio_unit(&state, desc->bSourceID);
2016 } else { /* UAC_VERSION_2 */
2017 struct uac2_output_terminal_descriptor *desc = p;
2019 if (desc->bLength < sizeof(*desc))
2020 continue; /* invalid descriptor? */
2021 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
2022 state.oterm.id = desc->bTerminalID;
2023 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2024 state.oterm.name = desc->iTerminal;
2025 err = parse_audio_unit(&state, desc->bSourceID);
2029 /* for UAC2, use the same approach to also add the clock selectors */
2030 err = parse_audio_unit(&state, desc->bCSourceID);
2039 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
2041 struct usb_mixer_elem_info *info;
2043 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
2044 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2048 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2050 struct usb_mixer_elem_info *cval)
2052 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2053 "S8", "U8", "S16", "U16"};
2054 snd_iprintf(buffer, " Unit: %i\n", unitid);
2056 snd_iprintf(buffer, " Control: name=\"%s\", index=%i\n",
2057 cval->elem_id->name, cval->elem_id->index);
2058 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
2059 "channels=%i, type=\"%s\"\n", cval->id,
2060 cval->control, cval->cmask, cval->channels,
2061 val_types[cval->val_type]);
2062 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2063 cval->min, cval->max, cval->dBmin, cval->dBmax);
2066 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2067 struct snd_info_buffer *buffer)
2069 struct snd_usb_audio *chip = entry->private_data;
2070 struct usb_mixer_interface *mixer;
2071 struct usb_mixer_elem_info *cval;
2074 list_for_each_entry(mixer, &chip->mixer_list, list) {
2076 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2077 chip->usb_id, snd_usb_ctrl_intf(chip),
2078 mixer->ignore_ctl_error);
2079 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2080 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2081 for (cval = mixer->id_elems[unitid]; cval;
2082 cval = cval->next_id_elem)
2083 snd_usb_mixer_dump_cval(buffer, unitid, cval);
2088 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2089 int attribute, int value, int index)
2091 struct usb_mixer_elem_info *info;
2092 __u8 unitid = (index >> 8) & 0xff;
2093 __u8 control = (value >> 8) & 0xff;
2094 __u8 channel = value & 0xff;
2096 if (channel >= MAX_CHANNELS) {
2097 snd_printk(KERN_DEBUG "%s(): bogus channel number %d\n",
2102 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) {
2103 if (info->control != control)
2106 switch (attribute) {
2108 /* invalidate cache, so the value is read from the device */
2110 info->cached &= ~(1 << channel);
2111 else /* master channel */
2114 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2127 snd_printk(KERN_DEBUG "unknown attribute %d in interrupt\n",
2134 static void snd_usb_mixer_interrupt(struct urb *urb)
2136 struct usb_mixer_interface *mixer = urb->context;
2137 int len = urb->actual_length;
2138 int ustatus = urb->status;
2143 if (mixer->protocol == UAC_VERSION_1) {
2144 struct uac1_status_word *status;
2146 for (status = urb->transfer_buffer;
2147 len >= sizeof(*status);
2148 len -= sizeof(*status), status++) {
2149 snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
2150 status->bStatusType,
2151 status->bOriginator);
2153 /* ignore any notifications not from the control interface */
2154 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2155 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2158 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2159 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2161 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2163 } else { /* UAC_VERSION_2 */
2164 struct uac2_interrupt_data_msg *msg;
2166 for (msg = urb->transfer_buffer;
2167 len >= sizeof(*msg);
2168 len -= sizeof(*msg), msg++) {
2169 /* drop vendor specific and endpoint requests */
2170 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2171 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2174 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2175 le16_to_cpu(msg->wValue),
2176 le16_to_cpu(msg->wIndex));
2181 if (ustatus != -ENOENT && ustatus != -ECONNRESET && ustatus != -ESHUTDOWN) {
2182 urb->dev = mixer->chip->dev;
2183 usb_submit_urb(urb, GFP_ATOMIC);
2187 /* stop any bus activity of a mixer */
2188 void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2190 usb_kill_urb(mixer->urb);
2191 usb_kill_urb(mixer->rc_urb);
2194 int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2199 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2207 /* create the handler for the optional status interrupt endpoint */
2208 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2210 struct usb_endpoint_descriptor *ep;
2211 void *transfer_buffer;
2215 /* we need one interrupt input endpoint */
2216 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
2218 ep = get_endpoint(mixer->hostif, 0);
2219 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2222 epnum = usb_endpoint_num(ep);
2223 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2224 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2225 if (!transfer_buffer)
2227 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2229 kfree(transfer_buffer);
2232 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2233 usb_rcvintpipe(mixer->chip->dev, epnum),
2234 transfer_buffer, buffer_length,
2235 snd_usb_mixer_interrupt, mixer, ep->bInterval);
2236 usb_submit_urb(mixer->urb, GFP_KERNEL);
2240 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2243 static struct snd_device_ops dev_ops = {
2244 .dev_free = snd_usb_mixer_dev_free
2246 struct usb_mixer_interface *mixer;
2247 struct snd_info_entry *entry;
2250 strcpy(chip->card->mixername, "USB Mixer");
2252 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2256 mixer->ignore_ctl_error = ignore_error;
2257 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2259 if (!mixer->id_elems) {
2264 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2265 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
2268 mixer->protocol = UAC_VERSION_1;
2271 mixer->protocol = UAC_VERSION_2;
2275 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2276 (err = snd_usb_mixer_status_create(mixer)) < 0)
2279 snd_usb_mixer_apply_create_quirk(mixer);
2281 err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
2285 if (list_empty(&chip->mixer_list) &&
2286 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2287 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2289 list_add(&mixer->list, &chip->mixer_list);
2293 snd_usb_mixer_free(mixer);
2297 void snd_usb_mixer_disconnect(struct list_head *p)
2299 struct usb_mixer_interface *mixer;
2301 mixer = list_entry(p, struct usb_mixer_interface, list);
2302 usb_kill_urb(mixer->urb);
2303 usb_kill_urb(mixer->rc_urb);