[NETFILTER]: xt_connmark: add compat conversion functions
[hh.org.git] / sound / usb / usbmixer.c
blob491e975a0c87ef8d2a5a820beba42da61150cdac
1 /*
2 * (Tentative) USB Audio Driver for ALSA
4 * Mixer control part
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 <sound/driver.h>
30 #include <linux/bitops.h>
31 #include <linux/init.h>
32 #include <linux/list.h>
33 #include <linux/slab.h>
34 #include <linux/string.h>
35 #include <linux/usb.h>
36 #include <sound/core.h>
37 #include <sound/control.h>
38 #include <sound/hwdep.h>
39 #include <sound/info.h>
41 #include "usbaudio.h"
46 /* ignore error from controls - for debugging */
47 /* #define IGNORE_CTL_ERROR */
50 * Sound Blaster remote control configuration
52 * format of remote control data:
53 * Extigy: xx 00
54 * Audigy 2 NX: 06 80 xx 00 00 00
55 * Live! 24-bit: 06 80 xx yy 22 83
57 static const struct rc_config {
58 u32 usb_id;
59 u8 offset;
60 u8 length;
61 u8 packet_length;
62 u8 mute_mixer_id;
63 u32 mute_code;
64 } rc_configs[] = {
65 { USB_ID(0x041e, 0x3000), 0, 1, 2, 18, 0x0013 }, /* Extigy */
66 { USB_ID(0x041e, 0x3020), 2, 1, 6, 18, 0x0013 }, /* Audigy 2 NX */
67 { USB_ID(0x041e, 0x3040), 2, 2, 6, 2, 0x6e91 }, /* Live! 24-bit */
70 struct usb_mixer_interface {
71 struct snd_usb_audio *chip;
72 unsigned int ctrlif;
73 struct list_head list;
74 unsigned int ignore_ctl_error;
75 struct urb *urb;
76 struct usb_mixer_elem_info **id_elems; /* array[256], indexed by unit id */
78 /* Sound Blaster remote control stuff */
79 const struct rc_config *rc_cfg;
80 unsigned long rc_hwdep_open;
81 u32 rc_code;
82 wait_queue_head_t rc_waitq;
83 struct urb *rc_urb;
84 struct usb_ctrlrequest *rc_setup_packet;
85 u8 rc_buffer[6];
87 u8 audigy2nx_leds[3];
91 struct usb_audio_term {
92 int id;
93 int type;
94 int channels;
95 unsigned int chconfig;
96 int name;
99 struct usbmix_name_map;
101 struct mixer_build {
102 struct snd_usb_audio *chip;
103 struct usb_mixer_interface *mixer;
104 unsigned char *buffer;
105 unsigned int buflen;
106 DECLARE_BITMAP(unitbitmap, 256);
107 struct usb_audio_term oterm;
108 const struct usbmix_name_map *map;
109 const struct usbmix_selector_map *selector_map;
112 struct usb_mixer_elem_info {
113 struct usb_mixer_interface *mixer;
114 struct usb_mixer_elem_info *next_id_elem; /* list of controls with same id */
115 struct snd_ctl_elem_id *elem_id;
116 unsigned int id;
117 unsigned int control; /* CS or ICN (high byte) */
118 unsigned int cmask; /* channel mask bitmap: 0 = master */
119 int channels;
120 int val_type;
121 int min, max, res;
122 u8 initialized;
126 enum {
127 USB_FEATURE_NONE = 0,
128 USB_FEATURE_MUTE = 1,
129 USB_FEATURE_VOLUME,
130 USB_FEATURE_BASS,
131 USB_FEATURE_MID,
132 USB_FEATURE_TREBLE,
133 USB_FEATURE_GEQ,
134 USB_FEATURE_AGC,
135 USB_FEATURE_DELAY,
136 USB_FEATURE_BASSBOOST,
137 USB_FEATURE_LOUDNESS
140 enum {
141 USB_MIXER_BOOLEAN,
142 USB_MIXER_INV_BOOLEAN,
143 USB_MIXER_S8,
144 USB_MIXER_U8,
145 USB_MIXER_S16,
146 USB_MIXER_U16,
149 enum {
150 USB_PROC_UPDOWN = 1,
151 USB_PROC_UPDOWN_SWITCH = 1,
152 USB_PROC_UPDOWN_MODE_SEL = 2,
154 USB_PROC_PROLOGIC = 2,
155 USB_PROC_PROLOGIC_SWITCH = 1,
156 USB_PROC_PROLOGIC_MODE_SEL = 2,
158 USB_PROC_3DENH = 3,
159 USB_PROC_3DENH_SWITCH = 1,
160 USB_PROC_3DENH_SPACE = 2,
162 USB_PROC_REVERB = 4,
163 USB_PROC_REVERB_SWITCH = 1,
164 USB_PROC_REVERB_LEVEL = 2,
165 USB_PROC_REVERB_TIME = 3,
166 USB_PROC_REVERB_DELAY = 4,
168 USB_PROC_CHORUS = 5,
169 USB_PROC_CHORUS_SWITCH = 1,
170 USB_PROC_CHORUS_LEVEL = 2,
171 USB_PROC_CHORUS_RATE = 3,
172 USB_PROC_CHORUS_DEPTH = 4,
174 USB_PROC_DCR = 6,
175 USB_PROC_DCR_SWITCH = 1,
176 USB_PROC_DCR_RATIO = 2,
177 USB_PROC_DCR_MAX_AMP = 3,
178 USB_PROC_DCR_THRESHOLD = 4,
179 USB_PROC_DCR_ATTACK = 5,
180 USB_PROC_DCR_RELEASE = 6,
183 #define MAX_CHANNELS 10 /* max logical channels */
187 * manual mapping of mixer names
188 * if the mixer topology is too complicated and the parsed names are
189 * ambiguous, add the entries in usbmixer_maps.c.
191 #include "usbmixer_maps.c"
193 /* get the mapped name if the unit matches */
194 static int check_mapped_name(struct mixer_build *state, int unitid, int control, char *buf, int buflen)
196 const struct usbmix_name_map *p;
198 if (! state->map)
199 return 0;
201 for (p = state->map; p->id; p++) {
202 if (p->id == unitid && p->name &&
203 (! control || ! p->control || control == p->control)) {
204 buflen--;
205 return strlcpy(buf, p->name, buflen);
208 return 0;
211 /* check whether the control should be ignored */
212 static int check_ignored_ctl(struct mixer_build *state, int unitid, int control)
214 const struct usbmix_name_map *p;
216 if (! state->map)
217 return 0;
218 for (p = state->map; p->id; p++) {
219 if (p->id == unitid && ! p->name &&
220 (! control || ! p->control || control == p->control)) {
221 // printk("ignored control %d:%d\n", unitid, control);
222 return 1;
225 return 0;
228 /* get the mapped selector source name */
229 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
230 int index, char *buf, int buflen)
232 const struct usbmix_selector_map *p;
234 if (! state->selector_map)
235 return 0;
236 for (p = state->selector_map; p->id; p++) {
237 if (p->id == unitid && index < p->count)
238 return strlcpy(buf, p->names[index], buflen);
240 return 0;
244 * find an audio control unit with the given unit id
246 static void *find_audio_control_unit(struct mixer_build *state, unsigned char unit)
248 unsigned char *p;
250 p = NULL;
251 while ((p = snd_usb_find_desc(state->buffer, state->buflen, p,
252 USB_DT_CS_INTERFACE)) != NULL) {
253 if (p[0] >= 4 && p[2] >= INPUT_TERMINAL && p[2] <= EXTENSION_UNIT && p[3] == unit)
254 return p;
256 return NULL;
261 * copy a string with the given id
263 static int snd_usb_copy_string_desc(struct mixer_build *state, int index, char *buf, int maxlen)
265 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
266 buf[len] = 0;
267 return len;
271 * convert from the byte/word on usb descriptor to the zero-based integer
273 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
275 switch (cval->val_type) {
276 case USB_MIXER_BOOLEAN:
277 return !!val;
278 case USB_MIXER_INV_BOOLEAN:
279 return !val;
280 case USB_MIXER_U8:
281 val &= 0xff;
282 break;
283 case USB_MIXER_S8:
284 val &= 0xff;
285 if (val >= 0x80)
286 val -= 0x100;
287 break;
288 case USB_MIXER_U16:
289 val &= 0xffff;
290 break;
291 case USB_MIXER_S16:
292 val &= 0xffff;
293 if (val >= 0x8000)
294 val -= 0x10000;
295 break;
297 return val;
301 * convert from the zero-based int to the byte/word for usb descriptor
303 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
305 switch (cval->val_type) {
306 case USB_MIXER_BOOLEAN:
307 return !!val;
308 case USB_MIXER_INV_BOOLEAN:
309 return !val;
310 case USB_MIXER_S8:
311 case USB_MIXER_U8:
312 return val & 0xff;
313 case USB_MIXER_S16:
314 case USB_MIXER_U16:
315 return val & 0xffff;
317 return 0; /* not reached */
320 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
322 if (! cval->res)
323 cval->res = 1;
324 if (val < cval->min)
325 return 0;
326 else if (val >= cval->max)
327 return (cval->max - cval->min + cval->res - 1) / cval->res;
328 else
329 return (val - cval->min) / cval->res;
332 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
334 if (val < 0)
335 return cval->min;
336 if (! cval->res)
337 cval->res = 1;
338 val *= cval->res;
339 val += cval->min;
340 if (val > cval->max)
341 return cval->max;
342 return val;
347 * retrieve a mixer value
350 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
352 unsigned char buf[2];
353 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
354 int timeout = 10;
356 while (timeout-- > 0) {
357 if (snd_usb_ctl_msg(cval->mixer->chip->dev,
358 usb_rcvctrlpipe(cval->mixer->chip->dev, 0),
359 request,
360 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
361 validx, cval->mixer->ctrlif | (cval->id << 8),
362 buf, val_len, 100) >= 0) {
363 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
364 return 0;
367 snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
368 request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type);
369 return -EINVAL;
372 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int *value)
374 return get_ctl_value(cval, GET_CUR, validx, value);
377 /* channel = 0: master, 1 = first channel */
378 static inline int get_cur_mix_value(struct usb_mixer_elem_info *cval, int channel, int *value)
380 return get_ctl_value(cval, GET_CUR, (cval->control << 8) | channel, value);
384 * set a mixer value
387 static int set_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int value_set)
389 unsigned char buf[2];
390 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
391 int timeout = 10;
393 value_set = convert_bytes_value(cval, value_set);
394 buf[0] = value_set & 0xff;
395 buf[1] = (value_set >> 8) & 0xff;
396 while (timeout -- > 0)
397 if (snd_usb_ctl_msg(cval->mixer->chip->dev,
398 usb_sndctrlpipe(cval->mixer->chip->dev, 0),
399 request,
400 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
401 validx, cval->mixer->ctrlif | (cval->id << 8),
402 buf, val_len, 100) >= 0)
403 return 0;
404 snd_printdd(KERN_ERR "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
405 request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type, buf[0], buf[1]);
406 return -EINVAL;
409 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int value)
411 return set_ctl_value(cval, SET_CUR, validx, value);
414 static inline int set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel, int value)
416 return set_ctl_value(cval, SET_CUR, (cval->control << 8) | channel, value);
421 * parser routines begin here...
424 static int parse_audio_unit(struct mixer_build *state, int unitid);
428 * check if the input/output channel routing is enabled on the given bitmap.
429 * used for mixer unit parser
431 static int check_matrix_bitmap(unsigned char *bmap, int ich, int och, int num_outs)
433 int idx = ich * num_outs + och;
434 return bmap[idx >> 3] & (0x80 >> (idx & 7));
439 * add an alsa control element
440 * search and increment the index until an empty slot is found.
442 * if failed, give up and free the control instance.
445 static int add_control_to_empty(struct mixer_build *state, struct snd_kcontrol *kctl)
447 struct usb_mixer_elem_info *cval = kctl->private_data;
448 int err;
450 while (snd_ctl_find_id(state->chip->card, &kctl->id))
451 kctl->id.index++;
452 if ((err = snd_ctl_add(state->chip->card, kctl)) < 0) {
453 snd_printd(KERN_ERR "cannot add control (err = %d)\n", err);
454 return err;
456 cval->elem_id = &kctl->id;
457 cval->next_id_elem = state->mixer->id_elems[cval->id];
458 state->mixer->id_elems[cval->id] = cval;
459 return 0;
464 * get a terminal name string
467 static struct iterm_name_combo {
468 int type;
469 char *name;
470 } iterm_names[] = {
471 { 0x0300, "Output" },
472 { 0x0301, "Speaker" },
473 { 0x0302, "Headphone" },
474 { 0x0303, "HMD Audio" },
475 { 0x0304, "Desktop Speaker" },
476 { 0x0305, "Room Speaker" },
477 { 0x0306, "Com Speaker" },
478 { 0x0307, "LFE" },
479 { 0x0600, "External In" },
480 { 0x0601, "Analog In" },
481 { 0x0602, "Digital In" },
482 { 0x0603, "Line" },
483 { 0x0604, "Legacy In" },
484 { 0x0605, "IEC958 In" },
485 { 0x0606, "1394 DA Stream" },
486 { 0x0607, "1394 DV Stream" },
487 { 0x0700, "Embedded" },
488 { 0x0701, "Noise Source" },
489 { 0x0702, "Equalization Noise" },
490 { 0x0703, "CD" },
491 { 0x0704, "DAT" },
492 { 0x0705, "DCC" },
493 { 0x0706, "MiniDisk" },
494 { 0x0707, "Analog Tape" },
495 { 0x0708, "Phonograph" },
496 { 0x0709, "VCR Audio" },
497 { 0x070a, "Video Disk Audio" },
498 { 0x070b, "DVD Audio" },
499 { 0x070c, "TV Tuner Audio" },
500 { 0x070d, "Satellite Rec Audio" },
501 { 0x070e, "Cable Tuner Audio" },
502 { 0x070f, "DSS Audio" },
503 { 0x0710, "Radio Receiver" },
504 { 0x0711, "Radio Transmitter" },
505 { 0x0712, "Multi-Track Recorder" },
506 { 0x0713, "Synthesizer" },
507 { 0 },
510 static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
511 unsigned char *name, int maxlen, int term_only)
513 struct iterm_name_combo *names;
515 if (iterm->name)
516 return snd_usb_copy_string_desc(state, iterm->name, name, maxlen);
518 /* virtual type - not a real terminal */
519 if (iterm->type >> 16) {
520 if (term_only)
521 return 0;
522 switch (iterm->type >> 16) {
523 case SELECTOR_UNIT:
524 strcpy(name, "Selector"); return 8;
525 case PROCESSING_UNIT:
526 strcpy(name, "Process Unit"); return 12;
527 case EXTENSION_UNIT:
528 strcpy(name, "Ext Unit"); return 8;
529 case MIXER_UNIT:
530 strcpy(name, "Mixer"); return 5;
531 default:
532 return sprintf(name, "Unit %d", iterm->id);
536 switch (iterm->type & 0xff00) {
537 case 0x0100:
538 strcpy(name, "PCM"); return 3;
539 case 0x0200:
540 strcpy(name, "Mic"); return 3;
541 case 0x0400:
542 strcpy(name, "Headset"); return 7;
543 case 0x0500:
544 strcpy(name, "Phone"); return 5;
547 for (names = iterm_names; names->type; names++)
548 if (names->type == iterm->type) {
549 strcpy(name, names->name);
550 return strlen(names->name);
552 return 0;
557 * parse the source unit recursively until it reaches to a terminal
558 * or a branched unit.
560 static int check_input_term(struct mixer_build *state, int id, struct usb_audio_term *term)
562 unsigned char *p1;
564 memset(term, 0, sizeof(*term));
565 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
566 term->id = id;
567 switch (p1[2]) {
568 case INPUT_TERMINAL:
569 term->type = combine_word(p1 + 4);
570 term->channels = p1[7];
571 term->chconfig = combine_word(p1 + 8);
572 term->name = p1[11];
573 return 0;
574 case FEATURE_UNIT:
575 id = p1[4];
576 break; /* continue to parse */
577 case MIXER_UNIT:
578 term->type = p1[2] << 16; /* virtual type */
579 term->channels = p1[5 + p1[4]];
580 term->chconfig = combine_word(p1 + 6 + p1[4]);
581 term->name = p1[p1[0] - 1];
582 return 0;
583 case SELECTOR_UNIT:
584 /* call recursively to retrieve the channel info */
585 if (check_input_term(state, p1[5], term) < 0)
586 return -ENODEV;
587 term->type = p1[2] << 16; /* virtual type */
588 term->id = id;
589 term->name = p1[9 + p1[0] - 1];
590 return 0;
591 case PROCESSING_UNIT:
592 case EXTENSION_UNIT:
593 if (p1[6] == 1) {
594 id = p1[7];
595 break; /* continue to parse */
597 term->type = p1[2] << 16; /* virtual type */
598 term->channels = p1[7 + p1[6]];
599 term->chconfig = combine_word(p1 + 8 + p1[6]);
600 term->name = p1[12 + p1[6] + p1[11 + p1[6]]];
601 return 0;
602 default:
603 return -ENODEV;
606 return -ENODEV;
611 * Feature Unit
614 /* feature unit control information */
615 struct usb_feature_control_info {
616 const char *name;
617 unsigned int type; /* control type (mute, volume, etc.) */
620 static struct usb_feature_control_info audio_feature_info[] = {
621 { "Mute", USB_MIXER_INV_BOOLEAN },
622 { "Volume", USB_MIXER_S16 },
623 { "Tone Control - Bass", USB_MIXER_S8 },
624 { "Tone Control - Mid", USB_MIXER_S8 },
625 { "Tone Control - Treble", USB_MIXER_S8 },
626 { "Graphic Equalizer", USB_MIXER_S8 }, /* FIXME: not implemeted yet */
627 { "Auto Gain Control", USB_MIXER_BOOLEAN },
628 { "Delay Control", USB_MIXER_U16 },
629 { "Bass Boost", USB_MIXER_BOOLEAN },
630 { "Loudness", USB_MIXER_BOOLEAN },
634 /* private_free callback */
635 static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
637 kfree(kctl->private_data);
638 kctl->private_data = NULL;
643 * interface to ALSA control for feature/mixer units
647 * retrieve the minimum and maximum values for the specified control
649 static int get_min_max(struct usb_mixer_elem_info *cval, int default_min)
651 /* for failsafe */
652 cval->min = default_min;
653 cval->max = cval->min + 1;
654 cval->res = 1;
656 if (cval->val_type == USB_MIXER_BOOLEAN ||
657 cval->val_type == USB_MIXER_INV_BOOLEAN) {
658 cval->initialized = 1;
659 } else {
660 int minchn = 0;
661 if (cval->cmask) {
662 int i;
663 for (i = 0; i < MAX_CHANNELS; i++)
664 if (cval->cmask & (1 << i)) {
665 minchn = i + 1;
666 break;
669 if (get_ctl_value(cval, GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
670 get_ctl_value(cval, GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
671 snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
672 cval->id, cval->mixer->ctrlif, cval->control, cval->id);
673 return -EINVAL;
675 if (get_ctl_value(cval, GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
676 cval->res = 1;
677 } else {
678 int last_valid_res = cval->res;
680 while (cval->res > 1) {
681 if (set_ctl_value(cval, SET_RES, (cval->control << 8) | minchn, cval->res / 2) < 0)
682 break;
683 cval->res /= 2;
685 if (get_ctl_value(cval, GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
686 cval->res = last_valid_res;
688 if (cval->res == 0)
689 cval->res = 1;
691 /* Additional checks for the proper resolution
693 * Some devices report smaller resolutions than actually
694 * reacting. They don't return errors but simply clip
695 * to the lower aligned value.
697 if (cval->min + cval->res < cval->max) {
698 int last_valid_res = cval->res;
699 int saved, test, check;
700 get_cur_mix_value(cval, minchn, &saved);
701 for (;;) {
702 test = saved;
703 if (test < cval->max)
704 test += cval->res;
705 else
706 test -= cval->res;
707 if (test < cval->min || test > cval->max ||
708 set_cur_mix_value(cval, minchn, test) ||
709 get_cur_mix_value(cval, minchn, &check)) {
710 cval->res = last_valid_res;
711 break;
713 if (test == check)
714 break;
715 cval->res *= 2;
717 set_cur_mix_value(cval, minchn, saved);
720 cval->initialized = 1;
722 return 0;
726 /* get a feature/mixer unit info */
727 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
729 struct usb_mixer_elem_info *cval = kcontrol->private_data;
731 if (cval->val_type == USB_MIXER_BOOLEAN ||
732 cval->val_type == USB_MIXER_INV_BOOLEAN)
733 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
734 else
735 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
736 uinfo->count = cval->channels;
737 if (cval->val_type == USB_MIXER_BOOLEAN ||
738 cval->val_type == USB_MIXER_INV_BOOLEAN) {
739 uinfo->value.integer.min = 0;
740 uinfo->value.integer.max = 1;
741 } else {
742 if (! cval->initialized)
743 get_min_max(cval, 0);
744 uinfo->value.integer.min = 0;
745 uinfo->value.integer.max =
746 (cval->max - cval->min + cval->res - 1) / cval->res;
748 return 0;
751 /* get the current value from feature/mixer unit */
752 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
754 struct usb_mixer_elem_info *cval = kcontrol->private_data;
755 int c, cnt, val, err;
757 if (cval->cmask) {
758 cnt = 0;
759 for (c = 0; c < MAX_CHANNELS; c++) {
760 if (cval->cmask & (1 << c)) {
761 err = get_cur_mix_value(cval, c + 1, &val);
762 if (err < 0) {
763 if (cval->mixer->ignore_ctl_error) {
764 ucontrol->value.integer.value[0] = cval->min;
765 return 0;
767 snd_printd(KERN_ERR "cannot get current value for control %d ch %d: err = %d\n", cval->control, c + 1, err);
768 return err;
770 val = get_relative_value(cval, val);
771 ucontrol->value.integer.value[cnt] = val;
772 cnt++;
775 } else {
776 /* master channel */
777 err = get_cur_mix_value(cval, 0, &val);
778 if (err < 0) {
779 if (cval->mixer->ignore_ctl_error) {
780 ucontrol->value.integer.value[0] = cval->min;
781 return 0;
783 snd_printd(KERN_ERR "cannot get current value for control %d master ch: err = %d\n", cval->control, err);
784 return err;
786 val = get_relative_value(cval, val);
787 ucontrol->value.integer.value[0] = val;
789 return 0;
792 /* put the current value to feature/mixer unit */
793 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
795 struct usb_mixer_elem_info *cval = kcontrol->private_data;
796 int c, cnt, val, oval, err;
797 int changed = 0;
799 if (cval->cmask) {
800 cnt = 0;
801 for (c = 0; c < MAX_CHANNELS; c++) {
802 if (cval->cmask & (1 << c)) {
803 err = get_cur_mix_value(cval, c + 1, &oval);
804 if (err < 0) {
805 if (cval->mixer->ignore_ctl_error)
806 return 0;
807 return err;
809 val = ucontrol->value.integer.value[cnt];
810 val = get_abs_value(cval, val);
811 if (oval != val) {
812 set_cur_mix_value(cval, c + 1, val);
813 changed = 1;
815 get_cur_mix_value(cval, c + 1, &val);
816 cnt++;
819 } else {
820 /* master channel */
821 err = get_cur_mix_value(cval, 0, &oval);
822 if (err < 0 && cval->mixer->ignore_ctl_error)
823 return 0;
824 if (err < 0)
825 return err;
826 val = ucontrol->value.integer.value[0];
827 val = get_abs_value(cval, val);
828 if (val != oval) {
829 set_cur_mix_value(cval, 0, val);
830 changed = 1;
833 return changed;
836 static struct snd_kcontrol_new usb_feature_unit_ctl = {
837 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
838 .name = "", /* will be filled later manually */
839 .info = mixer_ctl_feature_info,
840 .get = mixer_ctl_feature_get,
841 .put = mixer_ctl_feature_put,
846 * build a feature control
849 static void build_feature_ctl(struct mixer_build *state, unsigned char *desc,
850 unsigned int ctl_mask, int control,
851 struct usb_audio_term *iterm, int unitid)
853 unsigned int len = 0;
854 int mapped_name = 0;
855 int nameid = desc[desc[0] - 1];
856 struct snd_kcontrol *kctl;
857 struct usb_mixer_elem_info *cval;
859 control++; /* change from zero-based to 1-based value */
861 if (control == USB_FEATURE_GEQ) {
862 /* FIXME: not supported yet */
863 return;
866 if (check_ignored_ctl(state, unitid, control))
867 return;
869 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
870 if (! cval) {
871 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
872 return;
874 cval->mixer = state->mixer;
875 cval->id = unitid;
876 cval->control = control;
877 cval->cmask = ctl_mask;
878 cval->val_type = audio_feature_info[control-1].type;
879 if (ctl_mask == 0)
880 cval->channels = 1; /* master channel */
881 else {
882 int i, c = 0;
883 for (i = 0; i < 16; i++)
884 if (ctl_mask & (1 << i))
885 c++;
886 cval->channels = c;
889 /* get min/max values */
890 get_min_max(cval, 0);
892 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
893 if (! kctl) {
894 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
895 kfree(cval);
896 return;
898 kctl->private_free = usb_mixer_elem_free;
900 len = check_mapped_name(state, unitid, control, kctl->id.name, sizeof(kctl->id.name));
901 mapped_name = len != 0;
902 if (! len && nameid)
903 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
905 switch (control) {
906 case USB_FEATURE_MUTE:
907 case USB_FEATURE_VOLUME:
908 /* determine the control name. the rule is:
909 * - if a name id is given in descriptor, use it.
910 * - if the connected input can be determined, then use the name
911 * of terminal type.
912 * - if the connected output can be determined, use it.
913 * - otherwise, anonymous name.
915 if (! len) {
916 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1);
917 if (! len)
918 len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1);
919 if (! len)
920 len = snprintf(kctl->id.name, sizeof(kctl->id.name),
921 "Feature %d", unitid);
923 /* determine the stream direction:
924 * if the connected output is USB stream, then it's likely a
925 * capture stream. otherwise it should be playback (hopefully :)
927 if (! mapped_name && ! (state->oterm.type >> 16)) {
928 if ((state->oterm.type & 0xff00) == 0x0100) {
929 len = strlcat(kctl->id.name, " Capture", sizeof(kctl->id.name));
930 } else {
931 len = strlcat(kctl->id.name + len, " Playback", sizeof(kctl->id.name));
934 strlcat(kctl->id.name + len, control == USB_FEATURE_MUTE ? " Switch" : " Volume",
935 sizeof(kctl->id.name));
936 break;
938 default:
939 if (! len)
940 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
941 sizeof(kctl->id.name));
942 break;
945 /* quirk for UDA1321/N101 */
946 /* note that detection between firmware 2.1.1.7 (N101) and later 2.1.1.21 */
947 /* is not very clear from datasheets */
948 /* I hope that the min value is -15360 for newer firmware --jk */
949 switch (state->chip->usb_id) {
950 case USB_ID(0x0471, 0x0101):
951 case USB_ID(0x0471, 0x0104):
952 case USB_ID(0x0471, 0x0105):
953 case USB_ID(0x0672, 0x1041):
954 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
955 cval->min == -15616) {
956 snd_printk(KERN_INFO "using volume control quirk for the UDA1321/N101 chip\n");
957 cval->max = -256;
961 snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
962 cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
963 add_control_to_empty(state, kctl);
969 * parse a feature unit
971 * most of controlls are defined here.
973 static int parse_audio_feature_unit(struct mixer_build *state, int unitid, unsigned char *ftr)
975 int channels, i, j;
976 struct usb_audio_term iterm;
977 unsigned int master_bits, first_ch_bits;
978 int err, csize;
980 if (ftr[0] < 7 || ! (csize = ftr[5]) || ftr[0] < 7 + csize) {
981 snd_printk(KERN_ERR "usbaudio: unit %u: invalid FEATURE_UNIT descriptor\n", unitid);
982 return -EINVAL;
985 /* parse the source unit */
986 if ((err = parse_audio_unit(state, ftr[4])) < 0)
987 return err;
989 /* determine the input source type and name */
990 if (check_input_term(state, ftr[4], &iterm) < 0)
991 return -EINVAL;
993 channels = (ftr[0] - 7) / csize - 1;
995 master_bits = snd_usb_combine_bytes(ftr + 6, csize);
996 if (channels > 0)
997 first_ch_bits = snd_usb_combine_bytes(ftr + 6 + csize, csize);
998 else
999 first_ch_bits = 0;
1000 /* check all control types */
1001 for (i = 0; i < 10; i++) {
1002 unsigned int ch_bits = 0;
1003 for (j = 0; j < channels; j++) {
1004 unsigned int mask = snd_usb_combine_bytes(ftr + 6 + csize * (j+1), csize);
1005 if (mask & (1 << i))
1006 ch_bits |= (1 << j);
1008 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1009 build_feature_ctl(state, ftr, ch_bits, i, &iterm, unitid);
1010 if (master_bits & (1 << i))
1011 build_feature_ctl(state, ftr, 0, i, &iterm, unitid);
1014 return 0;
1019 * Mixer Unit
1023 * build a mixer unit control
1025 * the callbacks are identical with feature unit.
1026 * input channel number (zero based) is given in control field instead.
1029 static void build_mixer_unit_ctl(struct mixer_build *state, unsigned char *desc,
1030 int in_pin, int in_ch, int unitid,
1031 struct usb_audio_term *iterm)
1033 struct usb_mixer_elem_info *cval;
1034 unsigned int input_pins = desc[4];
1035 unsigned int num_outs = desc[5 + input_pins];
1036 unsigned int i, len;
1037 struct snd_kcontrol *kctl;
1039 if (check_ignored_ctl(state, unitid, 0))
1040 return;
1042 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1043 if (! cval)
1044 return;
1046 cval->mixer = state->mixer;
1047 cval->id = unitid;
1048 cval->control = in_ch + 1; /* based on 1 */
1049 cval->val_type = USB_MIXER_S16;
1050 for (i = 0; i < num_outs; i++) {
1051 if (check_matrix_bitmap(desc + 9 + input_pins, in_ch, i, num_outs)) {
1052 cval->cmask |= (1 << i);
1053 cval->channels++;
1057 /* get min/max values */
1058 get_min_max(cval, 0);
1060 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1061 if (! kctl) {
1062 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1063 kfree(cval);
1064 return;
1066 kctl->private_free = usb_mixer_elem_free;
1068 len = check_mapped_name(state, unitid, 0, kctl->id.name, sizeof(kctl->id.name));
1069 if (! len)
1070 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
1071 if (! len)
1072 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1073 strlcat(kctl->id.name + len, " Volume", sizeof(kctl->id.name));
1075 snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
1076 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1077 add_control_to_empty(state, kctl);
1082 * parse a mixer unit
1084 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, unsigned char *desc)
1086 struct usb_audio_term iterm;
1087 int input_pins, num_ins, num_outs;
1088 int pin, ich, err;
1090 if (desc[0] < 11 || ! (input_pins = desc[4]) || ! (num_outs = desc[5 + input_pins])) {
1091 snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
1092 return -EINVAL;
1094 /* no bmControls field (e.g. Maya44) -> ignore */
1095 if (desc[0] <= 10 + input_pins) {
1096 snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
1097 return 0;
1100 num_ins = 0;
1101 ich = 0;
1102 for (pin = 0; pin < input_pins; pin++) {
1103 err = parse_audio_unit(state, desc[5 + pin]);
1104 if (err < 0)
1105 return err;
1106 err = check_input_term(state, desc[5 + pin], &iterm);
1107 if (err < 0)
1108 return err;
1109 num_ins += iterm.channels;
1110 for (; ich < num_ins; ++ich) {
1111 int och, ich_has_controls = 0;
1113 for (och = 0; och < num_outs; ++och) {
1114 if (check_matrix_bitmap(desc + 9 + input_pins,
1115 ich, och, num_outs)) {
1116 ich_has_controls = 1;
1117 break;
1120 if (ich_has_controls)
1121 build_mixer_unit_ctl(state, desc, pin, ich,
1122 unitid, &iterm);
1125 return 0;
1130 * Processing Unit / Extension Unit
1133 /* get callback for processing/extension unit */
1134 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1136 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1137 int err, val;
1139 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1140 if (err < 0 && cval->mixer->ignore_ctl_error) {
1141 ucontrol->value.integer.value[0] = cval->min;
1142 return 0;
1144 if (err < 0)
1145 return err;
1146 val = get_relative_value(cval, val);
1147 ucontrol->value.integer.value[0] = val;
1148 return 0;
1151 /* put callback for processing/extension unit */
1152 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1154 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1155 int val, oval, err;
1157 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1158 if (err < 0) {
1159 if (cval->mixer->ignore_ctl_error)
1160 return 0;
1161 return err;
1163 val = ucontrol->value.integer.value[0];
1164 val = get_abs_value(cval, val);
1165 if (val != oval) {
1166 set_cur_ctl_value(cval, cval->control << 8, val);
1167 return 1;
1169 return 0;
1172 /* alsa control interface for processing/extension unit */
1173 static struct snd_kcontrol_new mixer_procunit_ctl = {
1174 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1175 .name = "", /* will be filled later */
1176 .info = mixer_ctl_feature_info,
1177 .get = mixer_ctl_procunit_get,
1178 .put = mixer_ctl_procunit_put,
1183 * predefined data for processing units
1185 struct procunit_value_info {
1186 int control;
1187 char *suffix;
1188 int val_type;
1189 int min_value;
1192 struct procunit_info {
1193 int type;
1194 char *name;
1195 struct procunit_value_info *values;
1198 static struct procunit_value_info updown_proc_info[] = {
1199 { USB_PROC_UPDOWN_SWITCH, "Switch", USB_MIXER_BOOLEAN },
1200 { USB_PROC_UPDOWN_MODE_SEL, "Mode Select", USB_MIXER_U8, 1 },
1201 { 0 }
1203 static struct procunit_value_info prologic_proc_info[] = {
1204 { USB_PROC_PROLOGIC_SWITCH, "Switch", USB_MIXER_BOOLEAN },
1205 { USB_PROC_PROLOGIC_MODE_SEL, "Mode Select", USB_MIXER_U8, 1 },
1206 { 0 }
1208 static struct procunit_value_info threed_enh_proc_info[] = {
1209 { USB_PROC_3DENH_SWITCH, "Switch", USB_MIXER_BOOLEAN },
1210 { USB_PROC_3DENH_SPACE, "Spaciousness", USB_MIXER_U8 },
1211 { 0 }
1213 static struct procunit_value_info reverb_proc_info[] = {
1214 { USB_PROC_REVERB_SWITCH, "Switch", USB_MIXER_BOOLEAN },
1215 { USB_PROC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1216 { USB_PROC_REVERB_TIME, "Time", USB_MIXER_U16 },
1217 { USB_PROC_REVERB_DELAY, "Delay", USB_MIXER_U8 },
1218 { 0 }
1220 static struct procunit_value_info chorus_proc_info[] = {
1221 { USB_PROC_CHORUS_SWITCH, "Switch", USB_MIXER_BOOLEAN },
1222 { USB_PROC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1223 { USB_PROC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1224 { USB_PROC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1225 { 0 }
1227 static struct procunit_value_info dcr_proc_info[] = {
1228 { USB_PROC_DCR_SWITCH, "Switch", USB_MIXER_BOOLEAN },
1229 { USB_PROC_DCR_RATIO, "Ratio", USB_MIXER_U16 },
1230 { USB_PROC_DCR_MAX_AMP, "Max Amp", USB_MIXER_S16 },
1231 { USB_PROC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1232 { USB_PROC_DCR_ATTACK, "Attack Time", USB_MIXER_U16 },
1233 { USB_PROC_DCR_RELEASE, "Release Time", USB_MIXER_U16 },
1234 { 0 }
1237 static struct procunit_info procunits[] = {
1238 { USB_PROC_UPDOWN, "Up Down", updown_proc_info },
1239 { USB_PROC_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1240 { USB_PROC_3DENH, "3D Stereo Extender", threed_enh_proc_info },
1241 { USB_PROC_REVERB, "Reverb", reverb_proc_info },
1242 { USB_PROC_CHORUS, "Chorus", chorus_proc_info },
1243 { USB_PROC_DCR, "DCR", dcr_proc_info },
1244 { 0 },
1248 * build a processing/extension unit
1250 static int build_audio_procunit(struct mixer_build *state, int unitid, unsigned char *dsc, struct procunit_info *list, char *name)
1252 int num_ins = dsc[6];
1253 struct usb_mixer_elem_info *cval;
1254 struct snd_kcontrol *kctl;
1255 int i, err, nameid, type, len;
1256 struct procunit_info *info;
1257 struct procunit_value_info *valinfo;
1258 static struct procunit_value_info default_value_info[] = {
1259 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1260 { 0 }
1262 static struct procunit_info default_info = {
1263 0, NULL, default_value_info
1266 if (dsc[0] < 13 || dsc[0] < 13 + num_ins || dsc[0] < num_ins + dsc[11 + num_ins]) {
1267 snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1268 return -EINVAL;
1271 for (i = 0; i < num_ins; i++) {
1272 if ((err = parse_audio_unit(state, dsc[7 + i])) < 0)
1273 return err;
1276 type = combine_word(&dsc[4]);
1277 for (info = list; info && info->type; info++)
1278 if (info->type == type)
1279 break;
1280 if (! info || ! info->type)
1281 info = &default_info;
1283 for (valinfo = info->values; valinfo->control; valinfo++) {
1284 /* FIXME: bitmap might be longer than 8bit */
1285 if (! (dsc[12 + num_ins] & (1 << (valinfo->control - 1))))
1286 continue;
1287 if (check_ignored_ctl(state, unitid, valinfo->control))
1288 continue;
1289 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1290 if (! cval) {
1291 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1292 return -ENOMEM;
1294 cval->mixer = state->mixer;
1295 cval->id = unitid;
1296 cval->control = valinfo->control;
1297 cval->val_type = valinfo->val_type;
1298 cval->channels = 1;
1300 /* get min/max values */
1301 if (type == USB_PROC_UPDOWN && cval->control == USB_PROC_UPDOWN_MODE_SEL) {
1302 /* FIXME: hard-coded */
1303 cval->min = 1;
1304 cval->max = dsc[15];
1305 cval->res = 1;
1306 cval->initialized = 1;
1307 } else
1308 get_min_max(cval, valinfo->min_value);
1310 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1311 if (! kctl) {
1312 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1313 kfree(cval);
1314 return -ENOMEM;
1316 kctl->private_free = usb_mixer_elem_free;
1318 if (check_mapped_name(state, unitid, cval->control, kctl->id.name, sizeof(kctl->id.name)))
1320 else if (info->name)
1321 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1322 else {
1323 nameid = dsc[12 + num_ins + dsc[11 + num_ins]];
1324 len = 0;
1325 if (nameid)
1326 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1327 if (! len)
1328 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1330 strlcat(kctl->id.name, " ", sizeof(kctl->id.name));
1331 strlcat(kctl->id.name, valinfo->suffix, sizeof(kctl->id.name));
1333 snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
1334 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1335 if ((err = add_control_to_empty(state, kctl)) < 0)
1336 return err;
1338 return 0;
1342 static int parse_audio_processing_unit(struct mixer_build *state, int unitid, unsigned char *desc)
1344 return build_audio_procunit(state, unitid, desc, procunits, "Processing Unit");
1347 static int parse_audio_extension_unit(struct mixer_build *state, int unitid, unsigned char *desc)
1349 return build_audio_procunit(state, unitid, desc, NULL, "Extension Unit");
1354 * Selector Unit
1357 /* info callback for selector unit
1358 * use an enumerator type for routing
1360 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
1362 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1363 char **itemlist = (char **)kcontrol->private_value;
1365 snd_assert(itemlist, return -EINVAL);
1366 uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1367 uinfo->count = 1;
1368 uinfo->value.enumerated.items = cval->max;
1369 if ((int)uinfo->value.enumerated.item >= cval->max)
1370 uinfo->value.enumerated.item = cval->max - 1;
1371 strcpy(uinfo->value.enumerated.name, itemlist[uinfo->value.enumerated.item]);
1372 return 0;
1375 /* get callback for selector unit */
1376 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1378 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1379 int val, err;
1381 err = get_cur_ctl_value(cval, 0, &val);
1382 if (err < 0) {
1383 if (cval->mixer->ignore_ctl_error) {
1384 ucontrol->value.enumerated.item[0] = 0;
1385 return 0;
1387 return err;
1389 val = get_relative_value(cval, val);
1390 ucontrol->value.enumerated.item[0] = val;
1391 return 0;
1394 /* put callback for selector unit */
1395 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1397 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1398 int val, oval, err;
1400 err = get_cur_ctl_value(cval, 0, &oval);
1401 if (err < 0) {
1402 if (cval->mixer->ignore_ctl_error)
1403 return 0;
1404 return err;
1406 val = ucontrol->value.enumerated.item[0];
1407 val = get_abs_value(cval, val);
1408 if (val != oval) {
1409 set_cur_ctl_value(cval, 0, val);
1410 return 1;
1412 return 0;
1415 /* alsa control interface for selector unit */
1416 static struct snd_kcontrol_new mixer_selectunit_ctl = {
1417 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1418 .name = "", /* will be filled later */
1419 .info = mixer_ctl_selector_info,
1420 .get = mixer_ctl_selector_get,
1421 .put = mixer_ctl_selector_put,
1425 /* private free callback.
1426 * free both private_data and private_value
1428 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
1430 int i, num_ins = 0;
1432 if (kctl->private_data) {
1433 struct usb_mixer_elem_info *cval = kctl->private_data;
1434 num_ins = cval->max;
1435 kfree(cval);
1436 kctl->private_data = NULL;
1438 if (kctl->private_value) {
1439 char **itemlist = (char **)kctl->private_value;
1440 for (i = 0; i < num_ins; i++)
1441 kfree(itemlist[i]);
1442 kfree(itemlist);
1443 kctl->private_value = 0;
1448 * parse a selector unit
1450 static int parse_audio_selector_unit(struct mixer_build *state, int unitid, unsigned char *desc)
1452 unsigned int num_ins = desc[4];
1453 unsigned int i, nameid, len;
1454 int err;
1455 struct usb_mixer_elem_info *cval;
1456 struct snd_kcontrol *kctl;
1457 char **namelist;
1459 if (! num_ins || desc[0] < 6 + num_ins) {
1460 snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
1461 return -EINVAL;
1464 for (i = 0; i < num_ins; i++) {
1465 if ((err = parse_audio_unit(state, desc[5 + i])) < 0)
1466 return err;
1469 if (num_ins == 1) /* only one ? nonsense! */
1470 return 0;
1472 if (check_ignored_ctl(state, unitid, 0))
1473 return 0;
1475 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1476 if (! cval) {
1477 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1478 return -ENOMEM;
1480 cval->mixer = state->mixer;
1481 cval->id = unitid;
1482 cval->val_type = USB_MIXER_U8;
1483 cval->channels = 1;
1484 cval->min = 1;
1485 cval->max = num_ins;
1486 cval->res = 1;
1487 cval->initialized = 1;
1489 namelist = kmalloc(sizeof(char *) * num_ins, GFP_KERNEL);
1490 if (! namelist) {
1491 snd_printk(KERN_ERR "cannot malloc\n");
1492 kfree(cval);
1493 return -ENOMEM;
1495 #define MAX_ITEM_NAME_LEN 64
1496 for (i = 0; i < num_ins; i++) {
1497 struct usb_audio_term iterm;
1498 len = 0;
1499 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
1500 if (! namelist[i]) {
1501 snd_printk(KERN_ERR "cannot malloc\n");
1502 while (--i > 0)
1503 kfree(namelist[i]);
1504 kfree(namelist);
1505 kfree(cval);
1506 return -ENOMEM;
1508 len = check_mapped_selector_name(state, unitid, i, namelist[i],
1509 MAX_ITEM_NAME_LEN);
1510 if (! len && check_input_term(state, desc[5 + i], &iterm) >= 0)
1511 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
1512 if (! len)
1513 sprintf(namelist[i], "Input %d", i);
1516 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
1517 if (! kctl) {
1518 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1519 kfree(namelist);
1520 kfree(cval);
1521 return -ENOMEM;
1523 kctl->private_value = (unsigned long)namelist;
1524 kctl->private_free = usb_mixer_selector_elem_free;
1526 nameid = desc[desc[0] - 1];
1527 len = check_mapped_name(state, unitid, 0, kctl->id.name, sizeof(kctl->id.name));
1528 if (len)
1530 else if (nameid)
1531 snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1532 else {
1533 len = get_term_name(state, &state->oterm,
1534 kctl->id.name, sizeof(kctl->id.name), 0);
1535 if (! len)
1536 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
1538 if ((state->oterm.type & 0xff00) == 0x0100)
1539 strlcat(kctl->id.name, " Capture Source", sizeof(kctl->id.name));
1540 else
1541 strlcat(kctl->id.name, " Playback Source", sizeof(kctl->id.name));
1544 snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
1545 cval->id, kctl->id.name, num_ins);
1546 if ((err = add_control_to_empty(state, kctl)) < 0)
1547 return err;
1549 return 0;
1554 * parse an audio unit recursively
1557 static int parse_audio_unit(struct mixer_build *state, int unitid)
1559 unsigned char *p1;
1561 if (test_and_set_bit(unitid, state->unitbitmap))
1562 return 0; /* the unit already visited */
1564 p1 = find_audio_control_unit(state, unitid);
1565 if (!p1) {
1566 snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
1567 return -EINVAL;
1570 switch (p1[2]) {
1571 case INPUT_TERMINAL:
1572 return 0; /* NOP */
1573 case MIXER_UNIT:
1574 return parse_audio_mixer_unit(state, unitid, p1);
1575 case SELECTOR_UNIT:
1576 return parse_audio_selector_unit(state, unitid, p1);
1577 case FEATURE_UNIT:
1578 return parse_audio_feature_unit(state, unitid, p1);
1579 case PROCESSING_UNIT:
1580 return parse_audio_processing_unit(state, unitid, p1);
1581 case EXTENSION_UNIT:
1582 return parse_audio_extension_unit(state, unitid, p1);
1583 default:
1584 snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
1585 return -EINVAL;
1589 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
1591 kfree(mixer->id_elems);
1592 if (mixer->urb) {
1593 kfree(mixer->urb->transfer_buffer);
1594 usb_free_urb(mixer->urb);
1596 if (mixer->rc_urb)
1597 usb_free_urb(mixer->rc_urb);
1598 kfree(mixer->rc_setup_packet);
1599 kfree(mixer);
1602 static int snd_usb_mixer_dev_free(struct snd_device *device)
1604 struct usb_mixer_interface *mixer = device->device_data;
1605 snd_usb_mixer_free(mixer);
1606 return 0;
1610 * create mixer controls
1612 * walk through all OUTPUT_TERMINAL descriptors to search for mixers
1614 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
1616 unsigned char *desc;
1617 struct mixer_build state;
1618 int err;
1619 const struct usbmix_ctl_map *map;
1620 struct usb_host_interface *hostif;
1622 hostif = &usb_ifnum_to_if(mixer->chip->dev, mixer->ctrlif)->altsetting[0];
1623 memset(&state, 0, sizeof(state));
1624 state.chip = mixer->chip;
1625 state.mixer = mixer;
1626 state.buffer = hostif->extra;
1627 state.buflen = hostif->extralen;
1629 /* check the mapping table */
1630 for (map = usbmix_ctl_maps; map->id; map++) {
1631 if (map->id == state.chip->usb_id) {
1632 state.map = map->map;
1633 state.selector_map = map->selector_map;
1634 mixer->ignore_ctl_error = map->ignore_ctl_error;
1635 break;
1639 desc = NULL;
1640 while ((desc = snd_usb_find_csint_desc(hostif->extra, hostif->extralen, desc, OUTPUT_TERMINAL)) != NULL) {
1641 if (desc[0] < 9)
1642 continue; /* invalid descriptor? */
1643 set_bit(desc[3], state.unitbitmap); /* mark terminal ID as visited */
1644 state.oterm.id = desc[3];
1645 state.oterm.type = combine_word(&desc[4]);
1646 state.oterm.name = desc[8];
1647 err = parse_audio_unit(&state, desc[7]);
1648 if (err < 0)
1649 return err;
1651 return 0;
1654 static void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer,
1655 int unitid)
1657 struct usb_mixer_elem_info *info;
1659 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
1660 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
1661 info->elem_id);
1664 static void snd_usb_mixer_memory_change(struct usb_mixer_interface *mixer,
1665 int unitid)
1667 if (!mixer->rc_cfg)
1668 return;
1669 /* unit ids specific to Extigy/Audigy 2 NX: */
1670 switch (unitid) {
1671 case 0: /* remote control */
1672 mixer->rc_urb->dev = mixer->chip->dev;
1673 usb_submit_urb(mixer->rc_urb, GFP_ATOMIC);
1674 break;
1675 case 4: /* digital in jack */
1676 case 7: /* line in jacks */
1677 case 19: /* speaker out jacks */
1678 case 20: /* headphones out jack */
1679 break;
1680 default:
1681 snd_printd(KERN_DEBUG "memory change in unknown unit %d\n", unitid);
1682 break;
1686 static void snd_usb_mixer_status_complete(struct urb *urb, struct pt_regs *regs)
1688 struct usb_mixer_interface *mixer = urb->context;
1690 if (urb->status == 0) {
1691 u8 *buf = urb->transfer_buffer;
1692 int i;
1694 for (i = urb->actual_length; i >= 2; buf += 2, i -= 2) {
1695 snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
1696 buf[0], buf[1]);
1697 /* ignore any notifications not from the control interface */
1698 if ((buf[0] & 0x0f) != 0)
1699 continue;
1700 if (!(buf[0] & 0x40))
1701 snd_usb_mixer_notify_id(mixer, buf[1]);
1702 else
1703 snd_usb_mixer_memory_change(mixer, buf[1]);
1706 if (urb->status != -ENOENT && urb->status != -ECONNRESET) {
1707 urb->dev = mixer->chip->dev;
1708 usb_submit_urb(urb, GFP_ATOMIC);
1712 /* create the handler for the optional status interrupt endpoint */
1713 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
1715 struct usb_host_interface *hostif;
1716 struct usb_endpoint_descriptor *ep;
1717 void *transfer_buffer;
1718 int buffer_length;
1719 unsigned int epnum;
1721 hostif = &usb_ifnum_to_if(mixer->chip->dev, mixer->ctrlif)->altsetting[0];
1722 /* we need one interrupt input endpoint */
1723 if (get_iface_desc(hostif)->bNumEndpoints < 1)
1724 return 0;
1725 ep = get_endpoint(hostif, 0);
1726 if ((ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_IN ||
1727 (ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1728 return 0;
1730 epnum = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1731 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
1732 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
1733 if (!transfer_buffer)
1734 return -ENOMEM;
1735 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
1736 if (!mixer->urb) {
1737 kfree(transfer_buffer);
1738 return -ENOMEM;
1740 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
1741 usb_rcvintpipe(mixer->chip->dev, epnum),
1742 transfer_buffer, buffer_length,
1743 snd_usb_mixer_status_complete, mixer, ep->bInterval);
1744 usb_submit_urb(mixer->urb, GFP_KERNEL);
1745 return 0;
1748 static void snd_usb_soundblaster_remote_complete(struct urb *urb,
1749 struct pt_regs *regs)
1751 struct usb_mixer_interface *mixer = urb->context;
1752 const struct rc_config *rc = mixer->rc_cfg;
1753 u32 code;
1755 if (urb->status < 0 || urb->actual_length < rc->packet_length)
1756 return;
1758 code = mixer->rc_buffer[rc->offset];
1759 if (rc->length == 2)
1760 code |= mixer->rc_buffer[rc->offset + 1] << 8;
1762 /* the Mute button actually changes the mixer control */
1763 if (code == rc->mute_code)
1764 snd_usb_mixer_notify_id(mixer, rc->mute_mixer_id);
1765 mixer->rc_code = code;
1766 wmb();
1767 wake_up(&mixer->rc_waitq);
1770 static int snd_usb_sbrc_hwdep_open(struct snd_hwdep *hw, struct file *file)
1772 struct usb_mixer_interface *mixer = hw->private_data;
1774 if (test_and_set_bit(0, &mixer->rc_hwdep_open))
1775 return -EBUSY;
1776 return 0;
1779 static int snd_usb_sbrc_hwdep_release(struct snd_hwdep *hw, struct file *file)
1781 struct usb_mixer_interface *mixer = hw->private_data;
1783 clear_bit(0, &mixer->rc_hwdep_open);
1784 smp_mb__after_clear_bit();
1785 return 0;
1788 static long snd_usb_sbrc_hwdep_read(struct snd_hwdep *hw, char __user *buf,
1789 long count, loff_t *offset)
1791 struct usb_mixer_interface *mixer = hw->private_data;
1792 int err;
1793 u32 rc_code;
1795 if (count != 1 && count != 4)
1796 return -EINVAL;
1797 err = wait_event_interruptible(mixer->rc_waitq,
1798 (rc_code = xchg(&mixer->rc_code, 0)) != 0);
1799 if (err == 0) {
1800 if (count == 1)
1801 err = put_user(rc_code, buf);
1802 else
1803 err = put_user(rc_code, (u32 __user *)buf);
1805 return err < 0 ? err : count;
1808 static unsigned int snd_usb_sbrc_hwdep_poll(struct snd_hwdep *hw, struct file *file,
1809 poll_table *wait)
1811 struct usb_mixer_interface *mixer = hw->private_data;
1813 poll_wait(file, &mixer->rc_waitq, wait);
1814 return mixer->rc_code ? POLLIN | POLLRDNORM : 0;
1817 static int snd_usb_soundblaster_remote_init(struct usb_mixer_interface *mixer)
1819 struct snd_hwdep *hwdep;
1820 int err, len, i;
1822 for (i = 0; i < ARRAY_SIZE(rc_configs); ++i)
1823 if (rc_configs[i].usb_id == mixer->chip->usb_id)
1824 break;
1825 if (i >= ARRAY_SIZE(rc_configs))
1826 return 0;
1827 mixer->rc_cfg = &rc_configs[i];
1829 len = mixer->rc_cfg->packet_length;
1831 init_waitqueue_head(&mixer->rc_waitq);
1832 err = snd_hwdep_new(mixer->chip->card, "SB remote control", 0, &hwdep);
1833 if (err < 0)
1834 return err;
1835 snprintf(hwdep->name, sizeof(hwdep->name),
1836 "%s remote control", mixer->chip->card->shortname);
1837 hwdep->iface = SNDRV_HWDEP_IFACE_SB_RC;
1838 hwdep->private_data = mixer;
1839 hwdep->ops.read = snd_usb_sbrc_hwdep_read;
1840 hwdep->ops.open = snd_usb_sbrc_hwdep_open;
1841 hwdep->ops.release = snd_usb_sbrc_hwdep_release;
1842 hwdep->ops.poll = snd_usb_sbrc_hwdep_poll;
1844 mixer->rc_urb = usb_alloc_urb(0, GFP_KERNEL);
1845 if (!mixer->rc_urb)
1846 return -ENOMEM;
1847 mixer->rc_setup_packet = kmalloc(sizeof(*mixer->rc_setup_packet), GFP_KERNEL);
1848 if (!mixer->rc_setup_packet) {
1849 usb_free_urb(mixer->rc_urb);
1850 mixer->rc_urb = NULL;
1851 return -ENOMEM;
1853 mixer->rc_setup_packet->bRequestType =
1854 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
1855 mixer->rc_setup_packet->bRequest = GET_MEM;
1856 mixer->rc_setup_packet->wValue = cpu_to_le16(0);
1857 mixer->rc_setup_packet->wIndex = cpu_to_le16(0);
1858 mixer->rc_setup_packet->wLength = cpu_to_le16(len);
1859 usb_fill_control_urb(mixer->rc_urb, mixer->chip->dev,
1860 usb_rcvctrlpipe(mixer->chip->dev, 0),
1861 (u8*)mixer->rc_setup_packet, mixer->rc_buffer, len,
1862 snd_usb_soundblaster_remote_complete, mixer);
1863 return 0;
1866 static int snd_audigy2nx_led_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
1868 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1869 uinfo->count = 1;
1870 uinfo->value.integer.min = 0;
1871 uinfo->value.integer.max = 1;
1872 return 0;
1875 static int snd_audigy2nx_led_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1877 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
1878 int index = kcontrol->private_value;
1880 ucontrol->value.integer.value[0] = mixer->audigy2nx_leds[index];
1881 return 0;
1884 static int snd_audigy2nx_led_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1886 struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
1887 int index = kcontrol->private_value;
1888 int value = ucontrol->value.integer.value[0];
1889 int err, changed;
1891 if (value > 1)
1892 return -EINVAL;
1893 changed = value != mixer->audigy2nx_leds[index];
1894 err = snd_usb_ctl_msg(mixer->chip->dev,
1895 usb_sndctrlpipe(mixer->chip->dev, 0), 0x24,
1896 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
1897 value, index + 2, NULL, 0, 100);
1898 if (err < 0)
1899 return err;
1900 mixer->audigy2nx_leds[index] = value;
1901 return changed;
1904 static struct snd_kcontrol_new snd_audigy2nx_controls[] = {
1906 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1907 .name = "CMSS LED Switch",
1908 .info = snd_audigy2nx_led_info,
1909 .get = snd_audigy2nx_led_get,
1910 .put = snd_audigy2nx_led_put,
1911 .private_value = 0,
1914 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1915 .name = "Power LED Switch",
1916 .info = snd_audigy2nx_led_info,
1917 .get = snd_audigy2nx_led_get,
1918 .put = snd_audigy2nx_led_put,
1919 .private_value = 1,
1922 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1923 .name = "Dolby Digital LED Switch",
1924 .info = snd_audigy2nx_led_info,
1925 .get = snd_audigy2nx_led_get,
1926 .put = snd_audigy2nx_led_put,
1927 .private_value = 2,
1931 static int snd_audigy2nx_controls_create(struct usb_mixer_interface *mixer)
1933 int i, err;
1935 for (i = 0; i < ARRAY_SIZE(snd_audigy2nx_controls); ++i) {
1936 err = snd_ctl_add(mixer->chip->card,
1937 snd_ctl_new1(&snd_audigy2nx_controls[i], mixer));
1938 if (err < 0)
1939 return err;
1941 mixer->audigy2nx_leds[1] = 1; /* Power LED is on by default */
1942 return 0;
1945 static void snd_audigy2nx_proc_read(struct snd_info_entry *entry,
1946 struct snd_info_buffer *buffer)
1948 static const struct {
1949 int unitid;
1950 const char *name;
1951 } jacks[] = {
1952 {4, "dig in "},
1953 {7, "line in"},
1954 {19, "spk out"},
1955 {20, "hph out"},
1957 struct usb_mixer_interface *mixer = entry->private_data;
1958 int i, err;
1959 u8 buf[3];
1961 snd_iprintf(buffer, "%s jacks\n\n", mixer->chip->card->shortname);
1962 for (i = 0; i < ARRAY_SIZE(jacks); ++i) {
1963 snd_iprintf(buffer, "%s: ", jacks[i].name);
1964 err = snd_usb_ctl_msg(mixer->chip->dev,
1965 usb_rcvctrlpipe(mixer->chip->dev, 0),
1966 GET_MEM, USB_DIR_IN | USB_TYPE_CLASS |
1967 USB_RECIP_INTERFACE, 0,
1968 jacks[i].unitid << 8, buf, 3, 100);
1969 if (err == 3 && buf[0] == 3)
1970 snd_iprintf(buffer, "%02x %02x\n", buf[1], buf[2]);
1971 else
1972 snd_iprintf(buffer, "?\n");
1976 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif)
1978 static struct snd_device_ops dev_ops = {
1979 .dev_free = snd_usb_mixer_dev_free
1981 struct usb_mixer_interface *mixer;
1982 int err;
1984 strcpy(chip->card->mixername, "USB Mixer");
1986 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
1987 if (!mixer)
1988 return -ENOMEM;
1989 mixer->chip = chip;
1990 mixer->ctrlif = ctrlif;
1991 #ifdef IGNORE_CTL_ERROR
1992 mixer->ignore_ctl_error = 1;
1993 #endif
1994 mixer->id_elems = kcalloc(256, sizeof(*mixer->id_elems), GFP_KERNEL);
1995 if (!mixer->id_elems) {
1996 kfree(mixer);
1997 return -ENOMEM;
2000 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2001 (err = snd_usb_mixer_status_create(mixer)) < 0)
2002 goto _error;
2004 if ((err = snd_usb_soundblaster_remote_init(mixer)) < 0)
2005 goto _error;
2007 if (mixer->chip->usb_id == USB_ID(0x041e, 0x3020)) {
2008 struct snd_info_entry *entry;
2010 if ((err = snd_audigy2nx_controls_create(mixer)) < 0)
2011 goto _error;
2012 if (!snd_card_proc_new(chip->card, "audigy2nx", &entry))
2013 snd_info_set_text_ops(entry, mixer,
2014 snd_audigy2nx_proc_read);
2017 err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
2018 if (err < 0)
2019 goto _error;
2020 list_add(&mixer->list, &chip->mixer_list);
2021 return 0;
2023 _error:
2024 snd_usb_mixer_free(mixer);
2025 return err;
2028 void snd_usb_mixer_disconnect(struct list_head *p)
2030 struct usb_mixer_interface *mixer;
2032 mixer = list_entry(p, struct usb_mixer_interface, list);
2033 if (mixer->urb)
2034 usb_kill_urb(mixer->urb);
2035 if (mixer->rc_urb)
2036 usb_kill_urb(mixer->rc_urb);