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
29 #include <linux/bitops.h>
30 #include <linux/init.h>
31 #include <linux/list.h>
32 #include <linux/slab.h>
33 #include <linux/string.h>
34 #include <linux/usb.h>
35 #include <linux/usb/audio.h>
37 #include <sound/core.h>
38 #include <sound/control.h>
39 #include <sound/hwdep.h>
40 #include <sound/info.h>
41 #include <sound/tlv.h>
46 #include "mixer_quirks.h"
48 #define MAX_ID_ELEMS 256
50 struct usb_audio_term {
54 unsigned int chconfig;
58 struct usbmix_name_map;
61 struct snd_usb_audio *chip;
62 struct usb_mixer_interface *mixer;
63 unsigned char *buffer;
65 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
66 struct usb_audio_term oterm;
67 const struct usbmix_name_map *map;
68 const struct usbmix_selector_map *selector_map;
73 USB_MIXER_INV_BOOLEAN,
82 USB_PROC_UPDOWN_SWITCH = 1,
83 USB_PROC_UPDOWN_MODE_SEL = 2,
85 USB_PROC_PROLOGIC = 2,
86 USB_PROC_PROLOGIC_SWITCH = 1,
87 USB_PROC_PROLOGIC_MODE_SEL = 2,
90 USB_PROC_3DENH_SWITCH = 1,
91 USB_PROC_3DENH_SPACE = 2,
94 USB_PROC_REVERB_SWITCH = 1,
95 USB_PROC_REVERB_LEVEL = 2,
96 USB_PROC_REVERB_TIME = 3,
97 USB_PROC_REVERB_DELAY = 4,
100 USB_PROC_CHORUS_SWITCH = 1,
101 USB_PROC_CHORUS_LEVEL = 2,
102 USB_PROC_CHORUS_RATE = 3,
103 USB_PROC_CHORUS_DEPTH = 4,
106 USB_PROC_DCR_SWITCH = 1,
107 USB_PROC_DCR_RATIO = 2,
108 USB_PROC_DCR_MAX_AMP = 3,
109 USB_PROC_DCR_THRESHOLD = 4,
110 USB_PROC_DCR_ATTACK = 5,
111 USB_PROC_DCR_RELEASE = 6,
114 /*E-mu 0202(0404) eXtension Unit(XU) control*/
116 USB_XU_CLOCK_RATE = 0xe301,
117 USB_XU_CLOCK_SOURCE = 0xe302,
118 USB_XU_DIGITAL_IO_STATUS = 0xe303,
119 USB_XU_DEVICE_OPTIONS = 0xe304,
120 USB_XU_DIRECT_MONITORING = 0xe305,
121 USB_XU_METERING = 0xe306
124 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/
125 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */
126 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */
127 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */
131 * manual mapping of mixer names
132 * if the mixer topology is too complicated and the parsed names are
133 * ambiguous, add the entries in usbmixer_maps.c.
135 #include "mixer_maps.c"
137 static const struct usbmix_name_map *
138 find_map(struct mixer_build *state, int unitid, int control)
140 const struct usbmix_name_map *p = state->map;
145 for (p = state->map; p->id; p++) {
146 if (p->id == unitid &&
147 (!control || !p->control || control == p->control))
153 /* get the mapped name if the unit matches */
155 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
161 return strlcpy(buf, p->name, buflen);
164 /* check whether the control should be ignored */
166 check_ignored_ctl(const struct usbmix_name_map *p)
168 if (!p || p->name || p->dB)
174 static inline void check_mapped_dB(const struct usbmix_name_map *p,
175 struct usb_mixer_elem_info *cval)
178 cval->dBmin = p->dB->min;
179 cval->dBmax = p->dB->max;
183 /* get the mapped selector source name */
184 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
185 int index, char *buf, int buflen)
187 const struct usbmix_selector_map *p;
189 if (! state->selector_map)
191 for (p = state->selector_map; p->id; p++) {
192 if (p->id == unitid && index < p->count)
193 return strlcpy(buf, p->names[index], buflen);
199 * find an audio control unit with the given unit id
201 static void *find_audio_control_unit(struct mixer_build *state, unsigned char unit)
206 while ((p = snd_usb_find_desc(state->buffer, state->buflen, p,
207 USB_DT_CS_INTERFACE)) != NULL) {
208 if (p[0] >= 4 && p[2] >= UAC_INPUT_TERMINAL && p[2] <= UAC_EXTENSION_UNIT_V1 && p[3] == unit)
216 * copy a string with the given id
218 static int snd_usb_copy_string_desc(struct mixer_build *state, int index, char *buf, int maxlen)
220 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
226 * convert from the byte/word on usb descriptor to the zero-based integer
228 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
230 switch (cval->val_type) {
231 case USB_MIXER_BOOLEAN:
233 case USB_MIXER_INV_BOOLEAN:
256 * convert from the zero-based int to the byte/word for usb descriptor
258 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
260 switch (cval->val_type) {
261 case USB_MIXER_BOOLEAN:
263 case USB_MIXER_INV_BOOLEAN:
272 return 0; /* not reached */
275 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
281 else if (val >= cval->max)
282 return (cval->max - cval->min + cval->res - 1) / cval->res;
284 return (val - cval->min) / cval->res;
287 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
302 * retrieve a mixer value
305 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
307 unsigned char buf[2];
308 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
311 while (timeout-- > 0) {
312 if (snd_usb_ctl_msg(cval->mixer->chip->dev,
313 usb_rcvctrlpipe(cval->mixer->chip->dev, 0),
315 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
316 validx, cval->mixer->ctrlif | (cval->id << 8),
317 buf, val_len, 100) >= val_len) {
318 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
322 snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
323 request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type);
327 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int *value)
329 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
332 /* channel = 0: master, 1 = first channel */
333 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
334 int channel, int *value)
336 return get_ctl_value(cval, UAC_GET_CUR, (cval->control << 8) | channel, value);
339 static int get_cur_mix_value(struct usb_mixer_elem_info *cval,
340 int channel, int index, int *value)
344 if (cval->cached & (1 << channel)) {
345 *value = cval->cache_val[index];
348 err = get_cur_mix_raw(cval, channel, value);
350 if (!cval->mixer->ignore_ctl_error)
351 snd_printd(KERN_ERR "cannot get current value for "
352 "control %d ch %d: err = %d\n",
353 cval->control, channel, err);
356 cval->cached |= 1 << channel;
357 cval->cache_val[index] = *value;
366 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
367 int request, int validx, int value_set)
369 unsigned char buf[2];
370 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
373 value_set = convert_bytes_value(cval, value_set);
374 buf[0] = value_set & 0xff;
375 buf[1] = (value_set >> 8) & 0xff;
376 while (timeout-- > 0)
377 if (snd_usb_ctl_msg(cval->mixer->chip->dev,
378 usb_sndctrlpipe(cval->mixer->chip->dev, 0),
380 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
381 validx, cval->mixer->ctrlif | (cval->id << 8),
382 buf, val_len, 100) >= 0)
384 snd_printdd(KERN_ERR "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
385 request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type, buf[0], buf[1]);
389 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int value)
391 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
394 static int set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
395 int index, int value)
398 err = snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, (cval->control << 8) | channel,
402 cval->cached |= 1 << channel;
403 cval->cache_val[index] = value;
408 * TLV callback for mixer volume controls
410 static int mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
411 unsigned int size, unsigned int __user *_tlv)
413 struct usb_mixer_elem_info *cval = kcontrol->private_data;
414 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
416 if (size < sizeof(scale))
418 scale[2] = cval->dBmin;
419 scale[3] = cval->dBmax;
420 if (copy_to_user(_tlv, scale, sizeof(scale)))
426 * parser routines begin here...
429 static int parse_audio_unit(struct mixer_build *state, int unitid);
433 * check if the input/output channel routing is enabled on the given bitmap.
434 * used for mixer unit parser
436 static int check_matrix_bitmap(unsigned char *bmap, int ich, int och, int num_outs)
438 int idx = ich * num_outs + och;
439 return bmap[idx >> 3] & (0x80 >> (idx & 7));
444 * add an alsa control element
445 * search and increment the index until an empty slot is found.
447 * if failed, give up and free the control instance.
450 static int add_control_to_empty(struct mixer_build *state, struct snd_kcontrol *kctl)
452 struct usb_mixer_elem_info *cval = kctl->private_data;
455 while (snd_ctl_find_id(state->chip->card, &kctl->id))
457 if ((err = snd_ctl_add(state->chip->card, kctl)) < 0) {
458 snd_printd(KERN_ERR "cannot add control (err = %d)\n", err);
461 cval->elem_id = &kctl->id;
462 cval->next_id_elem = state->mixer->id_elems[cval->id];
463 state->mixer->id_elems[cval->id] = cval;
469 * get a terminal name string
472 static struct iterm_name_combo {
476 { 0x0300, "Output" },
477 { 0x0301, "Speaker" },
478 { 0x0302, "Headphone" },
479 { 0x0303, "HMD Audio" },
480 { 0x0304, "Desktop Speaker" },
481 { 0x0305, "Room Speaker" },
482 { 0x0306, "Com Speaker" },
484 { 0x0600, "External In" },
485 { 0x0601, "Analog In" },
486 { 0x0602, "Digital In" },
488 { 0x0604, "Legacy In" },
489 { 0x0605, "IEC958 In" },
490 { 0x0606, "1394 DA Stream" },
491 { 0x0607, "1394 DV Stream" },
492 { 0x0700, "Embedded" },
493 { 0x0701, "Noise Source" },
494 { 0x0702, "Equalization Noise" },
498 { 0x0706, "MiniDisk" },
499 { 0x0707, "Analog Tape" },
500 { 0x0708, "Phonograph" },
501 { 0x0709, "VCR Audio" },
502 { 0x070a, "Video Disk Audio" },
503 { 0x070b, "DVD Audio" },
504 { 0x070c, "TV Tuner Audio" },
505 { 0x070d, "Satellite Rec Audio" },
506 { 0x070e, "Cable Tuner Audio" },
507 { 0x070f, "DSS Audio" },
508 { 0x0710, "Radio Receiver" },
509 { 0x0711, "Radio Transmitter" },
510 { 0x0712, "Multi-Track Recorder" },
511 { 0x0713, "Synthesizer" },
515 static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
516 unsigned char *name, int maxlen, int term_only)
518 struct iterm_name_combo *names;
521 return snd_usb_copy_string_desc(state, iterm->name, name, maxlen);
523 /* virtual type - not a real terminal */
524 if (iterm->type >> 16) {
527 switch (iterm->type >> 16) {
528 case UAC_SELECTOR_UNIT:
529 strcpy(name, "Selector"); return 8;
530 case UAC_PROCESSING_UNIT_V1:
531 strcpy(name, "Process Unit"); return 12;
532 case UAC_EXTENSION_UNIT_V1:
533 strcpy(name, "Ext Unit"); return 8;
535 strcpy(name, "Mixer"); return 5;
537 return sprintf(name, "Unit %d", iterm->id);
541 switch (iterm->type & 0xff00) {
543 strcpy(name, "PCM"); return 3;
545 strcpy(name, "Mic"); return 3;
547 strcpy(name, "Headset"); return 7;
549 strcpy(name, "Phone"); return 5;
552 for (names = iterm_names; names->type; names++)
553 if (names->type == iterm->type) {
554 strcpy(name, names->name);
555 return strlen(names->name);
562 * parse the source unit recursively until it reaches to a terminal
563 * or a branched unit.
565 static int check_input_term(struct mixer_build *state, int id, struct usb_audio_term *term)
569 memset(term, 0, sizeof(*term));
570 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
573 case UAC_INPUT_TERMINAL:
574 term->type = combine_word(p1 + 4);
575 term->channels = p1[7];
576 term->chconfig = combine_word(p1 + 8);
579 case UAC_FEATURE_UNIT:
581 break; /* continue to parse */
583 term->type = p1[2] << 16; /* virtual type */
584 term->channels = p1[5 + p1[4]];
585 term->chconfig = combine_word(p1 + 6 + p1[4]);
586 term->name = p1[p1[0] - 1];
588 case UAC_SELECTOR_UNIT:
589 /* call recursively to retrieve the channel info */
590 if (check_input_term(state, p1[5], term) < 0)
592 term->type = p1[2] << 16; /* virtual type */
594 term->name = p1[9 + p1[0] - 1];
596 case UAC_PROCESSING_UNIT_V1:
597 case UAC_EXTENSION_UNIT_V1:
600 break; /* continue to parse */
602 term->type = p1[2] << 16; /* virtual type */
603 term->channels = p1[7 + p1[6]];
604 term->chconfig = combine_word(p1 + 8 + p1[6]);
605 term->name = p1[12 + p1[6] + p1[11 + p1[6]]];
619 /* feature unit control information */
620 struct usb_feature_control_info {
622 unsigned int type; /* control type (mute, volume, etc.) */
625 static struct usb_feature_control_info audio_feature_info[] = {
626 { "Mute", USB_MIXER_INV_BOOLEAN },
627 { "Volume", USB_MIXER_S16 },
628 { "Tone Control - Bass", USB_MIXER_S8 },
629 { "Tone Control - Mid", USB_MIXER_S8 },
630 { "Tone Control - Treble", USB_MIXER_S8 },
631 { "Graphic Equalizer", USB_MIXER_S8 }, /* FIXME: not implemeted yet */
632 { "Auto Gain Control", USB_MIXER_BOOLEAN },
633 { "Delay Control", USB_MIXER_U16 },
634 { "Bass Boost", USB_MIXER_BOOLEAN },
635 { "Loudness", USB_MIXER_BOOLEAN },
639 /* private_free callback */
640 static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
642 kfree(kctl->private_data);
643 kctl->private_data = NULL;
648 * interface to ALSA control for feature/mixer units
652 * retrieve the minimum and maximum values for the specified control
654 static int get_min_max(struct usb_mixer_elem_info *cval, int default_min)
657 cval->min = default_min;
658 cval->max = cval->min + 1;
660 cval->dBmin = cval->dBmax = 0;
662 if (cval->val_type == USB_MIXER_BOOLEAN ||
663 cval->val_type == USB_MIXER_INV_BOOLEAN) {
664 cval->initialized = 1;
669 for (i = 0; i < MAX_CHANNELS; i++)
670 if (cval->cmask & (1 << i)) {
675 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
676 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
677 snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
678 cval->id, cval->mixer->ctrlif, cval->control, cval->id);
681 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
684 int last_valid_res = cval->res;
686 while (cval->res > 1) {
687 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
688 (cval->control << 8) | minchn, cval->res / 2) < 0)
692 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
693 cval->res = last_valid_res;
698 /* Additional checks for the proper resolution
700 * Some devices report smaller resolutions than actually
701 * reacting. They don't return errors but simply clip
702 * to the lower aligned value.
704 if (cval->min + cval->res < cval->max) {
705 int last_valid_res = cval->res;
706 int saved, test, check;
707 get_cur_mix_raw(cval, minchn, &saved);
710 if (test < cval->max)
714 if (test < cval->min || test > cval->max ||
715 set_cur_mix_value(cval, minchn, 0, test) ||
716 get_cur_mix_raw(cval, minchn, &check)) {
717 cval->res = last_valid_res;
724 set_cur_mix_value(cval, minchn, 0, saved);
727 cval->initialized = 1;
730 /* USB descriptions contain the dB scale in 1/256 dB unit
731 * while ALSA TLV contains in 1/100 dB unit
733 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
734 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
735 if (cval->dBmin > cval->dBmax) {
736 /* something is wrong; assume it's either from/to 0dB */
739 else if (cval->dBmin > 0)
741 if (cval->dBmin > cval->dBmax) {
742 /* totally crap, return an error */
751 /* get a feature/mixer unit info */
752 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
754 struct usb_mixer_elem_info *cval = kcontrol->private_data;
756 if (cval->val_type == USB_MIXER_BOOLEAN ||
757 cval->val_type == USB_MIXER_INV_BOOLEAN)
758 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
760 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
761 uinfo->count = cval->channels;
762 if (cval->val_type == USB_MIXER_BOOLEAN ||
763 cval->val_type == USB_MIXER_INV_BOOLEAN) {
764 uinfo->value.integer.min = 0;
765 uinfo->value.integer.max = 1;
767 if (! cval->initialized)
768 get_min_max(cval, 0);
769 uinfo->value.integer.min = 0;
770 uinfo->value.integer.max =
771 (cval->max - cval->min + cval->res - 1) / cval->res;
776 /* get the current value from feature/mixer unit */
777 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
779 struct usb_mixer_elem_info *cval = kcontrol->private_data;
780 int c, cnt, val, err;
782 ucontrol->value.integer.value[0] = cval->min;
785 for (c = 0; c < MAX_CHANNELS; c++) {
786 if (!(cval->cmask & (1 << c)))
788 err = get_cur_mix_value(cval, c + 1, cnt, &val);
790 return cval->mixer->ignore_ctl_error ? 0 : err;
791 val = get_relative_value(cval, val);
792 ucontrol->value.integer.value[cnt] = val;
798 err = get_cur_mix_value(cval, 0, 0, &val);
800 return cval->mixer->ignore_ctl_error ? 0 : err;
801 val = get_relative_value(cval, val);
802 ucontrol->value.integer.value[0] = val;
807 /* put the current value to feature/mixer unit */
808 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
810 struct usb_mixer_elem_info *cval = kcontrol->private_data;
811 int c, cnt, val, oval, err;
816 for (c = 0; c < MAX_CHANNELS; c++) {
817 if (!(cval->cmask & (1 << c)))
819 err = get_cur_mix_value(cval, c + 1, cnt, &oval);
821 return cval->mixer->ignore_ctl_error ? 0 : err;
822 val = ucontrol->value.integer.value[cnt];
823 val = get_abs_value(cval, val);
825 set_cur_mix_value(cval, c + 1, cnt, val);
832 err = get_cur_mix_value(cval, 0, 0, &oval);
834 return cval->mixer->ignore_ctl_error ? 0 : err;
835 val = ucontrol->value.integer.value[0];
836 val = get_abs_value(cval, val);
838 set_cur_mix_value(cval, 0, 0, val);
845 static struct snd_kcontrol_new usb_feature_unit_ctl = {
846 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
847 .name = "", /* will be filled later manually */
848 .info = mixer_ctl_feature_info,
849 .get = mixer_ctl_feature_get,
850 .put = mixer_ctl_feature_put,
855 * build a feature control
858 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
860 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
863 static void build_feature_ctl(struct mixer_build *state, unsigned char *desc,
864 unsigned int ctl_mask, int control,
865 struct usb_audio_term *iterm, int unitid)
867 unsigned int len = 0;
869 int nameid = desc[desc[0] - 1];
870 struct snd_kcontrol *kctl;
871 struct usb_mixer_elem_info *cval;
872 const struct usbmix_name_map *map;
874 control++; /* change from zero-based to 1-based value */
876 if (control == UAC_GRAPHIC_EQUALIZER_CONTROL) {
877 /* FIXME: not supported yet */
881 map = find_map(state, unitid, control);
882 if (check_ignored_ctl(map))
885 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
887 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
890 cval->mixer = state->mixer;
892 cval->control = control;
893 cval->cmask = ctl_mask;
894 cval->val_type = audio_feature_info[control-1].type;
896 cval->channels = 1; /* master channel */
899 for (i = 0; i < 16; i++)
900 if (ctl_mask & (1 << i))
905 /* get min/max values */
906 get_min_max(cval, 0);
908 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
910 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
914 kctl->private_free = usb_mixer_elem_free;
916 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
917 mapped_name = len != 0;
919 len = snd_usb_copy_string_desc(state, nameid,
920 kctl->id.name, sizeof(kctl->id.name));
923 case UAC_MUTE_CONTROL:
924 case UAC_VOLUME_CONTROL:
925 /* determine the control name. the rule is:
926 * - if a name id is given in descriptor, use it.
927 * - if the connected input can be determined, then use the name
929 * - if the connected output can be determined, use it.
930 * - otherwise, anonymous name.
933 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1);
935 len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1);
937 len = snprintf(kctl->id.name, sizeof(kctl->id.name),
938 "Feature %d", unitid);
940 /* determine the stream direction:
941 * if the connected output is USB stream, then it's likely a
942 * capture stream. otherwise it should be playback (hopefully :)
944 if (! mapped_name && ! (state->oterm.type >> 16)) {
945 if ((state->oterm.type & 0xff00) == 0x0100) {
946 len = append_ctl_name(kctl, " Capture");
948 len = append_ctl_name(kctl, " Playback");
951 append_ctl_name(kctl, control == UAC_MUTE_CONTROL ?
952 " Switch" : " Volume");
953 if (control == UAC_VOLUME_CONTROL) {
954 kctl->tlv.c = mixer_vol_tlv;
955 kctl->vd[0].access |=
956 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
957 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
958 check_mapped_dB(map, cval);
964 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
965 sizeof(kctl->id.name));
969 /* volume control quirks */
970 switch (state->chip->usb_id) {
971 case USB_ID(0x0471, 0x0101):
972 case USB_ID(0x0471, 0x0104):
973 case USB_ID(0x0471, 0x0105):
974 case USB_ID(0x0672, 0x1041):
975 /* quirk for UDA1321/N101.
976 * note that detection between firmware 2.1.1.7 (N101)
977 * and later 2.1.1.21 is not very clear from datasheets.
978 * I hope that the min value is -15360 for newer firmware --jk
980 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
981 cval->min == -15616) {
983 "set volume quirk for UDA1321/N101 chip\n");
988 case USB_ID(0x046d, 0x09a4):
989 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
991 "set volume quirk for QuickCam E3500\n");
1000 snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1001 cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
1002 add_control_to_empty(state, kctl);
1008 * parse a feature unit
1010 * most of controlls are defined here.
1012 static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr)
1015 struct usb_audio_term iterm;
1016 unsigned int master_bits, first_ch_bits;
1018 struct uac_feature_unit_descriptor *ftr = _ftr;
1020 if (ftr->bLength < 7 || ! (csize = ftr->bControlSize) || ftr->bLength < 7 + csize) {
1021 snd_printk(KERN_ERR "usbaudio: unit %u: invalid UAC_FEATURE_UNIT descriptor\n", unitid);
1025 /* parse the source unit */
1026 if ((err = parse_audio_unit(state, ftr->bSourceID)) < 0)
1029 /* determine the input source type and name */
1030 if (check_input_term(state, ftr->bSourceID, &iterm) < 0)
1033 channels = (ftr->bLength - 7) / csize - 1;
1035 master_bits = snd_usb_combine_bytes(ftr->controls, csize);
1036 /* master configuration quirks */
1037 switch (state->chip->usb_id) {
1038 case USB_ID(0x08bb, 0x2702):
1039 snd_printk(KERN_INFO
1040 "usbmixer: master volume quirk for PCM2702 chip\n");
1041 /* disable non-functional volume control */
1042 master_bits &= ~UAC_FU_VOLUME;
1046 first_ch_bits = snd_usb_combine_bytes(ftr->controls + csize, csize);
1049 /* check all control types */
1050 for (i = 0; i < 10; i++) {
1051 unsigned int ch_bits = 0;
1052 for (j = 0; j < channels; j++) {
1053 unsigned int mask = snd_usb_combine_bytes(ftr->controls + csize * (j+1), csize);
1054 if (mask & (1 << i))
1055 ch_bits |= (1 << j);
1057 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1058 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid);
1059 if (master_bits & (1 << i))
1060 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid);
1072 * build a mixer unit control
1074 * the callbacks are identical with feature unit.
1075 * input channel number (zero based) is given in control field instead.
1078 static void build_mixer_unit_ctl(struct mixer_build *state, unsigned char *desc,
1079 int in_pin, int in_ch, int unitid,
1080 struct usb_audio_term *iterm)
1082 struct usb_mixer_elem_info *cval;
1083 unsigned int input_pins = desc[4];
1084 unsigned int num_outs = desc[5 + input_pins];
1085 unsigned int i, len;
1086 struct snd_kcontrol *kctl;
1087 const struct usbmix_name_map *map;
1089 map = find_map(state, unitid, 0);
1090 if (check_ignored_ctl(map))
1093 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1097 cval->mixer = state->mixer;
1099 cval->control = in_ch + 1; /* based on 1 */
1100 cval->val_type = USB_MIXER_S16;
1101 for (i = 0; i < num_outs; i++) {
1102 if (check_matrix_bitmap(desc + 9 + input_pins, in_ch, i, num_outs)) {
1103 cval->cmask |= (1 << i);
1108 /* get min/max values */
1109 get_min_max(cval, 0);
1111 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1113 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1117 kctl->private_free = usb_mixer_elem_free;
1119 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1121 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
1123 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1124 append_ctl_name(kctl, " Volume");
1126 snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
1127 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1128 add_control_to_empty(state, kctl);
1133 * parse a mixer unit
1135 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, unsigned char *desc)
1137 struct usb_audio_term iterm;
1138 int input_pins, num_ins, num_outs;
1141 if (desc[0] < 11 || ! (input_pins = desc[4]) || ! (num_outs = desc[5 + input_pins])) {
1142 snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
1145 /* no bmControls field (e.g. Maya44) -> ignore */
1146 if (desc[0] <= 10 + input_pins) {
1147 snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
1153 for (pin = 0; pin < input_pins; pin++) {
1154 err = parse_audio_unit(state, desc[5 + pin]);
1157 err = check_input_term(state, desc[5 + pin], &iterm);
1160 num_ins += iterm.channels;
1161 for (; ich < num_ins; ++ich) {
1162 int och, ich_has_controls = 0;
1164 for (och = 0; och < num_outs; ++och) {
1165 if (check_matrix_bitmap(desc + 9 + input_pins,
1166 ich, och, num_outs)) {
1167 ich_has_controls = 1;
1171 if (ich_has_controls)
1172 build_mixer_unit_ctl(state, desc, pin, ich,
1181 * Processing Unit / Extension Unit
1184 /* get callback for processing/extension unit */
1185 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1187 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1190 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1191 if (err < 0 && cval->mixer->ignore_ctl_error) {
1192 ucontrol->value.integer.value[0] = cval->min;
1197 val = get_relative_value(cval, val);
1198 ucontrol->value.integer.value[0] = val;
1202 /* put callback for processing/extension unit */
1203 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1205 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1208 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1210 if (cval->mixer->ignore_ctl_error)
1214 val = ucontrol->value.integer.value[0];
1215 val = get_abs_value(cval, val);
1217 set_cur_ctl_value(cval, cval->control << 8, val);
1223 /* alsa control interface for processing/extension unit */
1224 static struct snd_kcontrol_new mixer_procunit_ctl = {
1225 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1226 .name = "", /* will be filled later */
1227 .info = mixer_ctl_feature_info,
1228 .get = mixer_ctl_procunit_get,
1229 .put = mixer_ctl_procunit_put,
1234 * predefined data for processing units
1236 struct procunit_value_info {
1243 struct procunit_info {
1246 struct procunit_value_info *values;
1249 static struct procunit_value_info updown_proc_info[] = {
1250 { USB_PROC_UPDOWN_SWITCH, "Switch", USB_MIXER_BOOLEAN },
1251 { USB_PROC_UPDOWN_MODE_SEL, "Mode Select", USB_MIXER_U8, 1 },
1254 static struct procunit_value_info prologic_proc_info[] = {
1255 { USB_PROC_PROLOGIC_SWITCH, "Switch", USB_MIXER_BOOLEAN },
1256 { USB_PROC_PROLOGIC_MODE_SEL, "Mode Select", USB_MIXER_U8, 1 },
1259 static struct procunit_value_info threed_enh_proc_info[] = {
1260 { USB_PROC_3DENH_SWITCH, "Switch", USB_MIXER_BOOLEAN },
1261 { USB_PROC_3DENH_SPACE, "Spaciousness", USB_MIXER_U8 },
1264 static struct procunit_value_info reverb_proc_info[] = {
1265 { USB_PROC_REVERB_SWITCH, "Switch", USB_MIXER_BOOLEAN },
1266 { USB_PROC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1267 { USB_PROC_REVERB_TIME, "Time", USB_MIXER_U16 },
1268 { USB_PROC_REVERB_DELAY, "Delay", USB_MIXER_U8 },
1271 static struct procunit_value_info chorus_proc_info[] = {
1272 { USB_PROC_CHORUS_SWITCH, "Switch", USB_MIXER_BOOLEAN },
1273 { USB_PROC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1274 { USB_PROC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1275 { USB_PROC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1278 static struct procunit_value_info dcr_proc_info[] = {
1279 { USB_PROC_DCR_SWITCH, "Switch", USB_MIXER_BOOLEAN },
1280 { USB_PROC_DCR_RATIO, "Ratio", USB_MIXER_U16 },
1281 { USB_PROC_DCR_MAX_AMP, "Max Amp", USB_MIXER_S16 },
1282 { USB_PROC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1283 { USB_PROC_DCR_ATTACK, "Attack Time", USB_MIXER_U16 },
1284 { USB_PROC_DCR_RELEASE, "Release Time", USB_MIXER_U16 },
1288 static struct procunit_info procunits[] = {
1289 { USB_PROC_UPDOWN, "Up Down", updown_proc_info },
1290 { USB_PROC_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1291 { USB_PROC_3DENH, "3D Stereo Extender", threed_enh_proc_info },
1292 { USB_PROC_REVERB, "Reverb", reverb_proc_info },
1293 { USB_PROC_CHORUS, "Chorus", chorus_proc_info },
1294 { USB_PROC_DCR, "DCR", dcr_proc_info },
1298 * predefined data for extension units
1300 static struct procunit_value_info clock_rate_xu_info[] = {
1301 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1304 static struct procunit_value_info clock_source_xu_info[] = {
1305 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1308 static struct procunit_value_info spdif_format_xu_info[] = {
1309 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1312 static struct procunit_value_info soft_limit_xu_info[] = {
1313 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1316 static struct procunit_info extunits[] = {
1317 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1318 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1319 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1320 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1324 * build a processing/extension unit
1326 static int build_audio_procunit(struct mixer_build *state, int unitid, unsigned char *dsc, struct procunit_info *list, char *name)
1328 int num_ins = dsc[6];
1329 struct usb_mixer_elem_info *cval;
1330 struct snd_kcontrol *kctl;
1331 int i, err, nameid, type, len;
1332 struct procunit_info *info;
1333 struct procunit_value_info *valinfo;
1334 const struct usbmix_name_map *map;
1335 static struct procunit_value_info default_value_info[] = {
1336 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1339 static struct procunit_info default_info = {
1340 0, NULL, default_value_info
1343 if (dsc[0] < 13 || dsc[0] < 13 + num_ins || dsc[0] < num_ins + dsc[11 + num_ins]) {
1344 snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1348 for (i = 0; i < num_ins; i++) {
1349 if ((err = parse_audio_unit(state, dsc[7 + i])) < 0)
1353 type = combine_word(&dsc[4]);
1354 for (info = list; info && info->type; info++)
1355 if (info->type == type)
1357 if (! info || ! info->type)
1358 info = &default_info;
1360 for (valinfo = info->values; valinfo->control; valinfo++) {
1361 /* FIXME: bitmap might be longer than 8bit */
1362 if (! (dsc[12 + num_ins] & (1 << (valinfo->control - 1))))
1364 map = find_map(state, unitid, valinfo->control);
1365 if (check_ignored_ctl(map))
1367 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1369 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1372 cval->mixer = state->mixer;
1374 cval->control = valinfo->control;
1375 cval->val_type = valinfo->val_type;
1378 /* get min/max values */
1379 if (type == USB_PROC_UPDOWN && cval->control == USB_PROC_UPDOWN_MODE_SEL) {
1380 /* FIXME: hard-coded */
1382 cval->max = dsc[15];
1384 cval->initialized = 1;
1386 if (type == USB_XU_CLOCK_RATE) {
1387 /* E-Mu USB 0404/0202/TrackerPre
1388 * samplerate control quirk
1393 cval->initialized = 1;
1395 get_min_max(cval, valinfo->min_value);
1398 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1400 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1404 kctl->private_free = usb_mixer_elem_free;
1406 if (check_mapped_name(map, kctl->id.name,
1407 sizeof(kctl->id.name)))
1409 else if (info->name)
1410 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1412 nameid = dsc[12 + num_ins + dsc[11 + num_ins]];
1415 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1417 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1419 append_ctl_name(kctl, " ");
1420 append_ctl_name(kctl, valinfo->suffix);
1422 snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
1423 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1424 if ((err = add_control_to_empty(state, kctl)) < 0)
1431 static int parse_audio_processing_unit(struct mixer_build *state, int unitid, unsigned char *desc)
1433 return build_audio_procunit(state, unitid, desc, procunits, "Processing Unit");
1436 static int parse_audio_extension_unit(struct mixer_build *state, int unitid, unsigned char *desc)
1438 return build_audio_procunit(state, unitid, desc, extunits, "Extension Unit");
1446 /* info callback for selector unit
1447 * use an enumerator type for routing
1449 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
1451 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1452 char **itemlist = (char **)kcontrol->private_value;
1454 if (snd_BUG_ON(!itemlist))
1456 uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1458 uinfo->value.enumerated.items = cval->max;
1459 if ((int)uinfo->value.enumerated.item >= cval->max)
1460 uinfo->value.enumerated.item = cval->max - 1;
1461 strcpy(uinfo->value.enumerated.name, itemlist[uinfo->value.enumerated.item]);
1465 /* get callback for selector unit */
1466 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1468 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1471 err = get_cur_ctl_value(cval, 0, &val);
1473 if (cval->mixer->ignore_ctl_error) {
1474 ucontrol->value.enumerated.item[0] = 0;
1479 val = get_relative_value(cval, val);
1480 ucontrol->value.enumerated.item[0] = val;
1484 /* put callback for selector unit */
1485 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1487 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1490 err = get_cur_ctl_value(cval, 0, &oval);
1492 if (cval->mixer->ignore_ctl_error)
1496 val = ucontrol->value.enumerated.item[0];
1497 val = get_abs_value(cval, val);
1499 set_cur_ctl_value(cval, 0, val);
1505 /* alsa control interface for selector unit */
1506 static struct snd_kcontrol_new mixer_selectunit_ctl = {
1507 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1508 .name = "", /* will be filled later */
1509 .info = mixer_ctl_selector_info,
1510 .get = mixer_ctl_selector_get,
1511 .put = mixer_ctl_selector_put,
1515 /* private free callback.
1516 * free both private_data and private_value
1518 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
1522 if (kctl->private_data) {
1523 struct usb_mixer_elem_info *cval = kctl->private_data;
1524 num_ins = cval->max;
1526 kctl->private_data = NULL;
1528 if (kctl->private_value) {
1529 char **itemlist = (char **)kctl->private_value;
1530 for (i = 0; i < num_ins; i++)
1533 kctl->private_value = 0;
1538 * parse a selector unit
1540 static int parse_audio_selector_unit(struct mixer_build *state, int unitid, unsigned char *desc)
1542 unsigned int num_ins = desc[4];
1543 unsigned int i, nameid, len;
1545 struct usb_mixer_elem_info *cval;
1546 struct snd_kcontrol *kctl;
1547 const struct usbmix_name_map *map;
1550 if (! num_ins || desc[0] < 5 + num_ins) {
1551 snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
1555 for (i = 0; i < num_ins; i++) {
1556 if ((err = parse_audio_unit(state, desc[5 + i])) < 0)
1560 if (num_ins == 1) /* only one ? nonsense! */
1563 map = find_map(state, unitid, 0);
1564 if (check_ignored_ctl(map))
1567 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1569 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1572 cval->mixer = state->mixer;
1574 cval->val_type = USB_MIXER_U8;
1577 cval->max = num_ins;
1579 cval->initialized = 1;
1581 namelist = kmalloc(sizeof(char *) * num_ins, GFP_KERNEL);
1583 snd_printk(KERN_ERR "cannot malloc\n");
1587 #define MAX_ITEM_NAME_LEN 64
1588 for (i = 0; i < num_ins; i++) {
1589 struct usb_audio_term iterm;
1591 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
1592 if (! namelist[i]) {
1593 snd_printk(KERN_ERR "cannot malloc\n");
1600 len = check_mapped_selector_name(state, unitid, i, namelist[i],
1602 if (! len && check_input_term(state, desc[5 + i], &iterm) >= 0)
1603 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
1605 sprintf(namelist[i], "Input %d", i);
1608 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
1610 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1615 kctl->private_value = (unsigned long)namelist;
1616 kctl->private_free = usb_mixer_selector_elem_free;
1618 nameid = desc[desc[0] - 1];
1619 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1623 snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1625 len = get_term_name(state, &state->oterm,
1626 kctl->id.name, sizeof(kctl->id.name), 0);
1628 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
1630 if ((state->oterm.type & 0xff00) == 0x0100)
1631 append_ctl_name(kctl, " Capture Source");
1633 append_ctl_name(kctl, " Playback Source");
1636 snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
1637 cval->id, kctl->id.name, num_ins);
1638 if ((err = add_control_to_empty(state, kctl)) < 0)
1646 * parse an audio unit recursively
1649 static int parse_audio_unit(struct mixer_build *state, int unitid)
1653 if (test_and_set_bit(unitid, state->unitbitmap))
1654 return 0; /* the unit already visited */
1656 p1 = find_audio_control_unit(state, unitid);
1658 snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
1663 case UAC_INPUT_TERMINAL:
1665 case UAC_MIXER_UNIT:
1666 return parse_audio_mixer_unit(state, unitid, p1);
1667 case UAC_SELECTOR_UNIT:
1668 return parse_audio_selector_unit(state, unitid, p1);
1669 case UAC_FEATURE_UNIT:
1670 return parse_audio_feature_unit(state, unitid, p1);
1671 case UAC_PROCESSING_UNIT_V1:
1672 return parse_audio_processing_unit(state, unitid, p1);
1673 case UAC_EXTENSION_UNIT_V1:
1674 return parse_audio_extension_unit(state, unitid, p1);
1676 snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
1681 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
1683 kfree(mixer->id_elems);
1685 kfree(mixer->urb->transfer_buffer);
1686 usb_free_urb(mixer->urb);
1688 usb_free_urb(mixer->rc_urb);
1689 kfree(mixer->rc_setup_packet);
1693 static int snd_usb_mixer_dev_free(struct snd_device *device)
1695 struct usb_mixer_interface *mixer = device->device_data;
1696 snd_usb_mixer_free(mixer);
1701 * create mixer controls
1703 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
1705 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
1707 struct uac_output_terminal_descriptor_v1 *desc;
1708 struct mixer_build state;
1710 const struct usbmix_ctl_map *map;
1711 struct usb_host_interface *hostif;
1713 hostif = &usb_ifnum_to_if(mixer->chip->dev, mixer->ctrlif)->altsetting[0];
1714 memset(&state, 0, sizeof(state));
1715 state.chip = mixer->chip;
1716 state.mixer = mixer;
1717 state.buffer = hostif->extra;
1718 state.buflen = hostif->extralen;
1720 /* check the mapping table */
1721 for (map = usbmix_ctl_maps; map->id; map++) {
1722 if (map->id == state.chip->usb_id) {
1723 state.map = map->map;
1724 state.selector_map = map->selector_map;
1725 mixer->ignore_ctl_error = map->ignore_ctl_error;
1731 while ((desc = snd_usb_find_csint_desc(hostif->extra, hostif->extralen, desc, UAC_OUTPUT_TERMINAL)) != NULL) {
1732 if (desc->bLength < 9)
1733 continue; /* invalid descriptor? */
1734 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
1735 state.oterm.id = desc->bTerminalID;
1736 state.oterm.type = le16_to_cpu(desc->wTerminalType);
1737 state.oterm.name = desc->iTerminal;
1738 err = parse_audio_unit(&state, desc->bSourceID);
1745 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
1747 struct usb_mixer_elem_info *info;
1749 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
1750 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
1754 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
1756 struct usb_mixer_elem_info *cval)
1758 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
1759 "S8", "U8", "S16", "U16"};
1760 snd_iprintf(buffer, " Unit: %i\n", unitid);
1762 snd_iprintf(buffer, " Control: name=\"%s\", index=%i\n",
1763 cval->elem_id->name, cval->elem_id->index);
1764 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
1765 "channels=%i, type=\"%s\"\n", cval->id,
1766 cval->control, cval->cmask, cval->channels,
1767 val_types[cval->val_type]);
1768 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
1769 cval->min, cval->max, cval->dBmin, cval->dBmax);
1772 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
1773 struct snd_info_buffer *buffer)
1775 struct snd_usb_audio *chip = entry->private_data;
1776 struct usb_mixer_interface *mixer;
1777 struct usb_mixer_elem_info *cval;
1780 list_for_each_entry(mixer, &chip->mixer_list, list) {
1782 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
1783 chip->usb_id, mixer->ctrlif,
1784 mixer->ignore_ctl_error);
1785 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
1786 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
1787 for (cval = mixer->id_elems[unitid]; cval;
1788 cval = cval->next_id_elem)
1789 snd_usb_mixer_dump_cval(buffer, unitid, cval);
1794 static void snd_usb_mixer_status_complete(struct urb *urb)
1796 struct usb_mixer_interface *mixer = urb->context;
1798 if (urb->status == 0) {
1799 u8 *buf = urb->transfer_buffer;
1802 for (i = urb->actual_length; i >= 2; buf += 2, i -= 2) {
1803 snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
1805 /* ignore any notifications not from the control interface */
1806 if ((buf[0] & 0x0f) != 0)
1808 if (!(buf[0] & 0x40))
1809 snd_usb_mixer_notify_id(mixer, buf[1]);
1811 snd_usb_mixer_rc_memory_change(mixer, buf[1]);
1814 if (urb->status != -ENOENT && urb->status != -ECONNRESET) {
1815 urb->dev = mixer->chip->dev;
1816 usb_submit_urb(urb, GFP_ATOMIC);
1820 /* create the handler for the optional status interrupt endpoint */
1821 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
1823 struct usb_host_interface *hostif;
1824 struct usb_endpoint_descriptor *ep;
1825 void *transfer_buffer;
1829 hostif = &usb_ifnum_to_if(mixer->chip->dev, mixer->ctrlif)->altsetting[0];
1830 /* we need one interrupt input endpoint */
1831 if (get_iface_desc(hostif)->bNumEndpoints < 1)
1833 ep = get_endpoint(hostif, 0);
1834 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
1837 epnum = usb_endpoint_num(ep);
1838 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
1839 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
1840 if (!transfer_buffer)
1842 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
1844 kfree(transfer_buffer);
1847 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
1848 usb_rcvintpipe(mixer->chip->dev, epnum),
1849 transfer_buffer, buffer_length,
1850 snd_usb_mixer_status_complete, mixer, ep->bInterval);
1851 usb_submit_urb(mixer->urb, GFP_KERNEL);
1855 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
1858 static struct snd_device_ops dev_ops = {
1859 .dev_free = snd_usb_mixer_dev_free
1861 struct usb_mixer_interface *mixer;
1862 struct snd_info_entry *entry;
1863 struct usb_host_interface *host_iface;
1866 strcpy(chip->card->mixername, "USB Mixer");
1868 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
1872 mixer->ctrlif = ctrlif;
1873 mixer->ignore_ctl_error = ignore_error;
1874 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
1876 if (!mixer->id_elems) {
1881 host_iface = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
1882 protocol = host_iface->desc.bInterfaceProtocol;
1885 if (protocol != UAC_VERSION_1) {
1886 snd_printk(KERN_WARNING "mixer interface protocol 0x%02x not yet supported\n",
1891 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
1892 (err = snd_usb_mixer_status_create(mixer)) < 0)
1895 snd_usb_mixer_apply_create_quirk(mixer);
1897 err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
1901 if (list_empty(&chip->mixer_list) &&
1902 !snd_card_proc_new(chip->card, "usbmixer", &entry))
1903 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
1905 list_add(&mixer->list, &chip->mixer_list);
1909 snd_usb_mixer_free(mixer);
1913 void snd_usb_mixer_disconnect(struct list_head *p)
1915 struct usb_mixer_interface *mixer;
1917 mixer = list_entry(p, struct usb_mixer_interface, list);
1918 usb_kill_urb(mixer->urb);
1919 usb_kill_urb(mixer->rc_urb);