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 <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>
46 /* ignore error from controls - for debugging */
47 /* #define IGNORE_CTL_ERROR */
49 struct usb_mixer_interface
{
50 struct snd_usb_audio
*chip
;
52 struct list_head list
;
53 unsigned int ignore_ctl_error
;
55 struct usb_mixer_elem_info
**id_elems
; /* array[256], indexed by unit id */
57 /* Sound Blaster remote control stuff */
63 unsigned long rc_hwdep_open
;
65 wait_queue_head_t rc_waitq
;
67 struct usb_ctrlrequest
*rc_setup_packet
;
74 struct usb_audio_term
{
78 unsigned int chconfig
;
82 struct usbmix_name_map
;
85 struct snd_usb_audio
*chip
;
86 struct usb_mixer_interface
*mixer
;
87 unsigned char *buffer
;
89 DECLARE_BITMAP(unitbitmap
, 256);
90 struct usb_audio_term oterm
;
91 const struct usbmix_name_map
*map
;
92 const struct usbmix_selector_map
*selector_map
;
95 struct usb_mixer_elem_info
{
96 struct usb_mixer_interface
*mixer
;
97 struct usb_mixer_elem_info
*next_id_elem
; /* list of controls with same id */
98 struct snd_ctl_elem_id
*elem_id
;
100 unsigned int control
; /* CS or ICN (high byte) */
101 unsigned int cmask
; /* channel mask bitmap: 0 = master */
110 USB_FEATURE_NONE
= 0,
111 USB_FEATURE_MUTE
= 1,
119 USB_FEATURE_BASSBOOST
,
125 USB_MIXER_INV_BOOLEAN
,
134 USB_PROC_UPDOWN_SWITCH
= 1,
135 USB_PROC_UPDOWN_MODE_SEL
= 2,
137 USB_PROC_PROLOGIC
= 2,
138 USB_PROC_PROLOGIC_SWITCH
= 1,
139 USB_PROC_PROLOGIC_MODE_SEL
= 2,
142 USB_PROC_3DENH_SWITCH
= 1,
143 USB_PROC_3DENH_SPACE
= 2,
146 USB_PROC_REVERB_SWITCH
= 1,
147 USB_PROC_REVERB_LEVEL
= 2,
148 USB_PROC_REVERB_TIME
= 3,
149 USB_PROC_REVERB_DELAY
= 4,
152 USB_PROC_CHORUS_SWITCH
= 1,
153 USB_PROC_CHORUS_LEVEL
= 2,
154 USB_PROC_CHORUS_RATE
= 3,
155 USB_PROC_CHORUS_DEPTH
= 4,
158 USB_PROC_DCR_SWITCH
= 1,
159 USB_PROC_DCR_RATIO
= 2,
160 USB_PROC_DCR_MAX_AMP
= 3,
161 USB_PROC_DCR_THRESHOLD
= 4,
162 USB_PROC_DCR_ATTACK
= 5,
163 USB_PROC_DCR_RELEASE
= 6,
166 #define MAX_CHANNELS 10 /* max logical channels */
170 * manual mapping of mixer names
171 * if the mixer topology is too complicated and the parsed names are
172 * ambiguous, add the entries in usbmixer_maps.c.
174 #include "usbmixer_maps.c"
176 /* get the mapped name if the unit matches */
177 static int check_mapped_name(struct mixer_build
*state
, int unitid
, int control
, char *buf
, int buflen
)
179 const struct usbmix_name_map
*p
;
184 for (p
= state
->map
; p
->id
; p
++) {
185 if (p
->id
== unitid
&& p
->name
&&
186 (! control
|| ! p
->control
|| control
== p
->control
)) {
188 return strlcpy(buf
, p
->name
, buflen
);
194 /* check whether the control should be ignored */
195 static int check_ignored_ctl(struct mixer_build
*state
, int unitid
, int control
)
197 const struct usbmix_name_map
*p
;
201 for (p
= state
->map
; p
->id
; p
++) {
202 if (p
->id
== unitid
&& ! p
->name
&&
203 (! control
|| ! p
->control
|| control
== p
->control
)) {
204 // printk("ignored control %d:%d\n", unitid, control);
211 /* get the mapped selector source name */
212 static int check_mapped_selector_name(struct mixer_build
*state
, int unitid
,
213 int index
, char *buf
, int buflen
)
215 const struct usbmix_selector_map
*p
;
217 if (! state
->selector_map
)
219 for (p
= state
->selector_map
; p
->id
; p
++) {
220 if (p
->id
== unitid
&& index
< p
->count
)
221 return strlcpy(buf
, p
->names
[index
], buflen
);
227 * find an audio control unit with the given unit id
229 static void *find_audio_control_unit(struct mixer_build
*state
, unsigned char unit
)
234 while ((p
= snd_usb_find_desc(state
->buffer
, state
->buflen
, p
,
235 USB_DT_CS_INTERFACE
)) != NULL
) {
236 if (p
[0] >= 4 && p
[2] >= INPUT_TERMINAL
&& p
[2] <= EXTENSION_UNIT
&& p
[3] == unit
)
244 * copy a string with the given id
246 static int snd_usb_copy_string_desc(struct mixer_build
*state
, int index
, char *buf
, int maxlen
)
248 int len
= usb_string(state
->chip
->dev
, index
, buf
, maxlen
- 1);
254 * convert from the byte/word on usb descriptor to the zero-based integer
256 static int convert_signed_value(struct usb_mixer_elem_info
*cval
, int val
)
258 switch (cval
->val_type
) {
259 case USB_MIXER_BOOLEAN
:
261 case USB_MIXER_INV_BOOLEAN
:
284 * convert from the zero-based int to the byte/word for usb descriptor
286 static int convert_bytes_value(struct usb_mixer_elem_info
*cval
, int val
)
288 switch (cval
->val_type
) {
289 case USB_MIXER_BOOLEAN
:
291 case USB_MIXER_INV_BOOLEAN
:
300 return 0; /* not reached */
303 static int get_relative_value(struct usb_mixer_elem_info
*cval
, int val
)
309 else if (val
>= cval
->max
)
310 return (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
312 return (val
- cval
->min
) / cval
->res
;
315 static int get_abs_value(struct usb_mixer_elem_info
*cval
, int val
)
330 * retrieve a mixer value
333 static int get_ctl_value(struct usb_mixer_elem_info
*cval
, int request
, int validx
, int *value_ret
)
335 unsigned char buf
[2];
336 int val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
339 while (timeout
-- > 0) {
340 if (snd_usb_ctl_msg(cval
->mixer
->chip
->dev
,
341 usb_rcvctrlpipe(cval
->mixer
->chip
->dev
, 0),
343 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
344 validx
, cval
->mixer
->ctrlif
| (cval
->id
<< 8),
345 buf
, val_len
, 100) >= 0) {
346 *value_ret
= convert_signed_value(cval
, snd_usb_combine_bytes(buf
, val_len
));
350 snd_printdd(KERN_ERR
"cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
351 request
, validx
, cval
->mixer
->ctrlif
| (cval
->id
<< 8), cval
->val_type
);
355 static int get_cur_ctl_value(struct usb_mixer_elem_info
*cval
, int validx
, int *value
)
357 return get_ctl_value(cval
, GET_CUR
, validx
, value
);
360 /* channel = 0: master, 1 = first channel */
361 static inline int get_cur_mix_value(struct usb_mixer_elem_info
*cval
, int channel
, int *value
)
363 return get_ctl_value(cval
, GET_CUR
, (cval
->control
<< 8) | channel
, value
);
370 static int set_ctl_value(struct usb_mixer_elem_info
*cval
, int request
, int validx
, int value_set
)
372 unsigned char buf
[2];
373 int val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
376 value_set
= convert_bytes_value(cval
, value_set
);
377 buf
[0] = value_set
& 0xff;
378 buf
[1] = (value_set
>> 8) & 0xff;
379 while (timeout
-- > 0)
380 if (snd_usb_ctl_msg(cval
->mixer
->chip
->dev
,
381 usb_sndctrlpipe(cval
->mixer
->chip
->dev
, 0),
383 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
384 validx
, cval
->mixer
->ctrlif
| (cval
->id
<< 8),
385 buf
, val_len
, 100) >= 0)
387 snd_printdd(KERN_ERR
"cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
388 request
, validx
, cval
->mixer
->ctrlif
| (cval
->id
<< 8), cval
->val_type
, buf
[0], buf
[1]);
392 static int set_cur_ctl_value(struct usb_mixer_elem_info
*cval
, int validx
, int value
)
394 return set_ctl_value(cval
, SET_CUR
, validx
, value
);
397 static inline int set_cur_mix_value(struct usb_mixer_elem_info
*cval
, int channel
, int value
)
399 return set_ctl_value(cval
, SET_CUR
, (cval
->control
<< 8) | channel
, value
);
404 * parser routines begin here...
407 static int parse_audio_unit(struct mixer_build
*state
, int unitid
);
411 * check if the input/output channel routing is enabled on the given bitmap.
412 * used for mixer unit parser
414 static int check_matrix_bitmap(unsigned char *bmap
, int ich
, int och
, int num_outs
)
416 int idx
= ich
* num_outs
+ och
;
417 return bmap
[idx
>> 3] & (0x80 >> (idx
& 7));
422 * add an alsa control element
423 * search and increment the index until an empty slot is found.
425 * if failed, give up and free the control instance.
428 static int add_control_to_empty(struct mixer_build
*state
, struct snd_kcontrol
*kctl
)
430 struct usb_mixer_elem_info
*cval
= kctl
->private_data
;
433 while (snd_ctl_find_id(state
->chip
->card
, &kctl
->id
))
435 if ((err
= snd_ctl_add(state
->chip
->card
, kctl
)) < 0) {
436 snd_printd(KERN_ERR
"cannot add control (err = %d)\n", err
);
439 cval
->elem_id
= &kctl
->id
;
440 cval
->next_id_elem
= state
->mixer
->id_elems
[cval
->id
];
441 state
->mixer
->id_elems
[cval
->id
] = cval
;
447 * get a terminal name string
450 static struct iterm_name_combo
{
454 { 0x0300, "Output" },
455 { 0x0301, "Speaker" },
456 { 0x0302, "Headphone" },
457 { 0x0303, "HMD Audio" },
458 { 0x0304, "Desktop Speaker" },
459 { 0x0305, "Room Speaker" },
460 { 0x0306, "Com Speaker" },
462 { 0x0600, "External In" },
463 { 0x0601, "Analog In" },
464 { 0x0602, "Digital In" },
466 { 0x0604, "Legacy In" },
467 { 0x0605, "IEC958 In" },
468 { 0x0606, "1394 DA Stream" },
469 { 0x0607, "1394 DV Stream" },
470 { 0x0700, "Embedded" },
471 { 0x0701, "Noise Source" },
472 { 0x0702, "Equalization Noise" },
476 { 0x0706, "MiniDisk" },
477 { 0x0707, "Analog Tape" },
478 { 0x0708, "Phonograph" },
479 { 0x0709, "VCR Audio" },
480 { 0x070a, "Video Disk Audio" },
481 { 0x070b, "DVD Audio" },
482 { 0x070c, "TV Tuner Audio" },
483 { 0x070d, "Satellite Rec Audio" },
484 { 0x070e, "Cable Tuner Audio" },
485 { 0x070f, "DSS Audio" },
486 { 0x0710, "Radio Receiver" },
487 { 0x0711, "Radio Transmitter" },
488 { 0x0712, "Multi-Track Recorder" },
489 { 0x0713, "Synthesizer" },
493 static int get_term_name(struct mixer_build
*state
, struct usb_audio_term
*iterm
,
494 unsigned char *name
, int maxlen
, int term_only
)
496 struct iterm_name_combo
*names
;
499 return snd_usb_copy_string_desc(state
, iterm
->name
, name
, maxlen
);
501 /* virtual type - not a real terminal */
502 if (iterm
->type
>> 16) {
505 switch (iterm
->type
>> 16) {
507 strcpy(name
, "Selector"); return 8;
508 case PROCESSING_UNIT
:
509 strcpy(name
, "Process Unit"); return 12;
511 strcpy(name
, "Ext Unit"); return 8;
513 strcpy(name
, "Mixer"); return 5;
515 return sprintf(name
, "Unit %d", iterm
->id
);
519 switch (iterm
->type
& 0xff00) {
521 strcpy(name
, "PCM"); return 3;
523 strcpy(name
, "Mic"); return 3;
525 strcpy(name
, "Headset"); return 7;
527 strcpy(name
, "Phone"); return 5;
530 for (names
= iterm_names
; names
->type
; names
++)
531 if (names
->type
== iterm
->type
) {
532 strcpy(name
, names
->name
);
533 return strlen(names
->name
);
540 * parse the source unit recursively until it reaches to a terminal
541 * or a branched unit.
543 static int check_input_term(struct mixer_build
*state
, int id
, struct usb_audio_term
*term
)
547 memset(term
, 0, sizeof(*term
));
548 while ((p1
= find_audio_control_unit(state
, id
)) != NULL
) {
552 term
->type
= combine_word(p1
+ 4);
553 term
->channels
= p1
[7];
554 term
->chconfig
= combine_word(p1
+ 8);
559 break; /* continue to parse */
561 term
->type
= p1
[2] << 16; /* virtual type */
562 term
->channels
= p1
[5 + p1
[4]];
563 term
->chconfig
= combine_word(p1
+ 6 + p1
[4]);
564 term
->name
= p1
[p1
[0] - 1];
567 /* call recursively to retrieve the channel info */
568 if (check_input_term(state
, p1
[5], term
) < 0)
570 term
->type
= p1
[2] << 16; /* virtual type */
572 term
->name
= p1
[9 + p1
[0] - 1];
574 case PROCESSING_UNIT
:
578 break; /* continue to parse */
580 term
->type
= p1
[2] << 16; /* virtual type */
581 term
->channels
= p1
[7 + p1
[6]];
582 term
->chconfig
= combine_word(p1
+ 8 + p1
[6]);
583 term
->name
= p1
[12 + p1
[6] + p1
[11 + p1
[6]]];
597 /* feature unit control information */
598 struct usb_feature_control_info
{
600 unsigned int type
; /* control type (mute, volume, etc.) */
603 static struct usb_feature_control_info audio_feature_info
[] = {
604 { "Mute", USB_MIXER_INV_BOOLEAN
},
605 { "Volume", USB_MIXER_S16
},
606 { "Tone Control - Bass", USB_MIXER_S8
},
607 { "Tone Control - Mid", USB_MIXER_S8
},
608 { "Tone Control - Treble", USB_MIXER_S8
},
609 { "Graphic Equalizer", USB_MIXER_S8
}, /* FIXME: not implemeted yet */
610 { "Auto Gain Control", USB_MIXER_BOOLEAN
},
611 { "Delay Control", USB_MIXER_U16
},
612 { "Bass Boost", USB_MIXER_BOOLEAN
},
613 { "Loudness", USB_MIXER_BOOLEAN
},
617 /* private_free callback */
618 static void usb_mixer_elem_free(struct snd_kcontrol
*kctl
)
620 kfree(kctl
->private_data
);
621 kctl
->private_data
= NULL
;
626 * interface to ALSA control for feature/mixer units
630 * retrieve the minimum and maximum values for the specified control
632 static int get_min_max(struct usb_mixer_elem_info
*cval
, int default_min
)
635 cval
->min
= default_min
;
636 cval
->max
= cval
->min
+ 1;
639 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
640 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
641 cval
->initialized
= 1;
646 for (i
= 0; i
< MAX_CHANNELS
; i
++)
647 if (cval
->cmask
& (1 << i
)) {
652 if (get_ctl_value(cval
, GET_MAX
, (cval
->control
<< 8) | minchn
, &cval
->max
) < 0 ||
653 get_ctl_value(cval
, GET_MIN
, (cval
->control
<< 8) | minchn
, &cval
->min
) < 0) {
654 snd_printd(KERN_ERR
"%d:%d: cannot get min/max values for control %d (id %d)\n",
655 cval
->id
, cval
->mixer
->ctrlif
, cval
->control
, cval
->id
);
658 if (get_ctl_value(cval
, GET_RES
, (cval
->control
<< 8) | minchn
, &cval
->res
) < 0) {
661 int last_valid_res
= cval
->res
;
663 while (cval
->res
> 1) {
664 if (set_ctl_value(cval
, SET_RES
, (cval
->control
<< 8) | minchn
, cval
->res
/ 2) < 0)
668 if (get_ctl_value(cval
, GET_RES
, (cval
->control
<< 8) | minchn
, &cval
->res
) < 0)
669 cval
->res
= last_valid_res
;
674 /* Additional checks for the proper resolution
676 * Some devices report smaller resolutions than actually
677 * reacting. They don't return errors but simply clip
678 * to the lower aligned value.
680 if (cval
->min
+ cval
->res
< cval
->max
) {
681 int last_valid_res
= cval
->res
;
682 int saved
, test
, check
;
683 get_cur_mix_value(cval
, minchn
, &saved
);
686 if (test
< cval
->max
)
690 if (test
< cval
->min
|| test
> cval
->max
||
691 set_cur_mix_value(cval
, minchn
, test
) ||
692 get_cur_mix_value(cval
, minchn
, &check
)) {
693 cval
->res
= last_valid_res
;
700 set_cur_mix_value(cval
, minchn
, saved
);
703 cval
->initialized
= 1;
709 /* get a feature/mixer unit info */
710 static int mixer_ctl_feature_info(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_info
*uinfo
)
712 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
714 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
715 cval
->val_type
== USB_MIXER_INV_BOOLEAN
)
716 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
718 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
719 uinfo
->count
= cval
->channels
;
720 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
721 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
722 uinfo
->value
.integer
.min
= 0;
723 uinfo
->value
.integer
.max
= 1;
725 if (! cval
->initialized
)
726 get_min_max(cval
, 0);
727 uinfo
->value
.integer
.min
= 0;
728 uinfo
->value
.integer
.max
=
729 (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
734 /* get the current value from feature/mixer unit */
735 static int mixer_ctl_feature_get(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
737 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
738 int c
, cnt
, val
, err
;
742 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
743 if (cval
->cmask
& (1 << c
)) {
744 err
= get_cur_mix_value(cval
, c
+ 1, &val
);
746 if (cval
->mixer
->ignore_ctl_error
) {
747 ucontrol
->value
.integer
.value
[0] = cval
->min
;
750 snd_printd(KERN_ERR
"cannot get current value for control %d ch %d: err = %d\n", cval
->control
, c
+ 1, err
);
753 val
= get_relative_value(cval
, val
);
754 ucontrol
->value
.integer
.value
[cnt
] = val
;
760 err
= get_cur_mix_value(cval
, 0, &val
);
762 if (cval
->mixer
->ignore_ctl_error
) {
763 ucontrol
->value
.integer
.value
[0] = cval
->min
;
766 snd_printd(KERN_ERR
"cannot get current value for control %d master ch: err = %d\n", cval
->control
, err
);
769 val
= get_relative_value(cval
, val
);
770 ucontrol
->value
.integer
.value
[0] = val
;
775 /* put the current value to feature/mixer unit */
776 static int mixer_ctl_feature_put(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
778 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
779 int c
, cnt
, val
, oval
, err
;
784 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
785 if (cval
->cmask
& (1 << c
)) {
786 err
= get_cur_mix_value(cval
, c
+ 1, &oval
);
788 if (cval
->mixer
->ignore_ctl_error
)
792 val
= ucontrol
->value
.integer
.value
[cnt
];
793 val
= get_abs_value(cval
, val
);
795 set_cur_mix_value(cval
, c
+ 1, val
);
798 get_cur_mix_value(cval
, c
+ 1, &val
);
804 err
= get_cur_mix_value(cval
, 0, &oval
);
805 if (err
< 0 && cval
->mixer
->ignore_ctl_error
)
809 val
= ucontrol
->value
.integer
.value
[0];
810 val
= get_abs_value(cval
, val
);
812 set_cur_mix_value(cval
, 0, val
);
819 static struct snd_kcontrol_new usb_feature_unit_ctl
= {
820 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
821 .name
= "", /* will be filled later manually */
822 .info
= mixer_ctl_feature_info
,
823 .get
= mixer_ctl_feature_get
,
824 .put
= mixer_ctl_feature_put
,
829 * build a feature control
832 static void build_feature_ctl(struct mixer_build
*state
, unsigned char *desc
,
833 unsigned int ctl_mask
, int control
,
834 struct usb_audio_term
*iterm
, int unitid
)
836 unsigned int len
= 0;
838 int nameid
= desc
[desc
[0] - 1];
839 struct snd_kcontrol
*kctl
;
840 struct usb_mixer_elem_info
*cval
;
842 control
++; /* change from zero-based to 1-based value */
844 if (control
== USB_FEATURE_GEQ
) {
845 /* FIXME: not supported yet */
849 if (check_ignored_ctl(state
, unitid
, control
))
852 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
854 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
857 cval
->mixer
= state
->mixer
;
859 cval
->control
= control
;
860 cval
->cmask
= ctl_mask
;
861 cval
->val_type
= audio_feature_info
[control
-1].type
;
863 cval
->channels
= 1; /* master channel */
866 for (i
= 0; i
< 16; i
++)
867 if (ctl_mask
& (1 << i
))
872 /* get min/max values */
873 get_min_max(cval
, 0);
875 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
877 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
881 kctl
->private_free
= usb_mixer_elem_free
;
883 len
= check_mapped_name(state
, unitid
, control
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
884 mapped_name
= len
!= 0;
886 len
= snd_usb_copy_string_desc(state
, nameid
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
889 case USB_FEATURE_MUTE
:
890 case USB_FEATURE_VOLUME
:
891 /* determine the control name. the rule is:
892 * - if a name id is given in descriptor, use it.
893 * - if the connected input can be determined, then use the name
895 * - if the connected output can be determined, use it.
896 * - otherwise, anonymous name.
899 len
= get_term_name(state
, iterm
, kctl
->id
.name
, sizeof(kctl
->id
.name
), 1);
901 len
= get_term_name(state
, &state
->oterm
, kctl
->id
.name
, sizeof(kctl
->id
.name
), 1);
903 len
= snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
904 "Feature %d", unitid
);
906 /* determine the stream direction:
907 * if the connected output is USB stream, then it's likely a
908 * capture stream. otherwise it should be playback (hopefully :)
910 if (! mapped_name
&& ! (state
->oterm
.type
>> 16)) {
911 if ((state
->oterm
.type
& 0xff00) == 0x0100) {
912 len
= strlcat(kctl
->id
.name
, " Capture", sizeof(kctl
->id
.name
));
914 len
= strlcat(kctl
->id
.name
+ len
, " Playback", sizeof(kctl
->id
.name
));
917 strlcat(kctl
->id
.name
+ len
, control
== USB_FEATURE_MUTE
? " Switch" : " Volume",
918 sizeof(kctl
->id
.name
));
923 strlcpy(kctl
->id
.name
, audio_feature_info
[control
-1].name
,
924 sizeof(kctl
->id
.name
));
928 /* quirk for UDA1321/N101 */
929 /* note that detection between firmware 2.1.1.7 (N101) and later 2.1.1.21 */
930 /* is not very clear from datasheets */
931 /* I hope that the min value is -15360 for newer firmware --jk */
932 switch (state
->chip
->usb_id
) {
933 case USB_ID(0x0471, 0x0101):
934 case USB_ID(0x0471, 0x0104):
935 case USB_ID(0x0471, 0x0105):
936 case USB_ID(0x0672, 0x1041):
937 if (!strcmp(kctl
->id
.name
, "PCM Playback Volume") &&
938 cval
->min
== -15616) {
939 snd_printk(KERN_INFO
"using volume control quirk for the UDA1321/N101 chip\n");
944 snd_printdd(KERN_INFO
"[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
945 cval
->id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
, cval
->res
);
946 add_control_to_empty(state
, kctl
);
952 * parse a feature unit
954 * most of controlls are defined here.
956 static int parse_audio_feature_unit(struct mixer_build
*state
, int unitid
, unsigned char *ftr
)
959 struct usb_audio_term iterm
;
960 unsigned int master_bits
, first_ch_bits
;
963 if (ftr
[0] < 7 || ! (csize
= ftr
[5]) || ftr
[0] < 7 + csize
) {
964 snd_printk(KERN_ERR
"usbaudio: unit %u: invalid FEATURE_UNIT descriptor\n", unitid
);
968 /* parse the source unit */
969 if ((err
= parse_audio_unit(state
, ftr
[4])) < 0)
972 /* determine the input source type and name */
973 if (check_input_term(state
, ftr
[4], &iterm
) < 0)
976 channels
= (ftr
[0] - 7) / csize
- 1;
978 master_bits
= snd_usb_combine_bytes(ftr
+ 6, csize
);
980 first_ch_bits
= snd_usb_combine_bytes(ftr
+ 6 + csize
, csize
);
983 /* check all control types */
984 for (i
= 0; i
< 10; i
++) {
985 unsigned int ch_bits
= 0;
986 for (j
= 0; j
< channels
; j
++) {
987 unsigned int mask
= snd_usb_combine_bytes(ftr
+ 6 + csize
* (j
+1), csize
);
991 if (ch_bits
& 1) /* the first channel must be set (for ease of programming) */
992 build_feature_ctl(state
, ftr
, ch_bits
, i
, &iterm
, unitid
);
993 if (master_bits
& (1 << i
))
994 build_feature_ctl(state
, ftr
, 0, i
, &iterm
, unitid
);
1006 * build a mixer unit control
1008 * the callbacks are identical with feature unit.
1009 * input channel number (zero based) is given in control field instead.
1012 static void build_mixer_unit_ctl(struct mixer_build
*state
, unsigned char *desc
,
1013 int in_pin
, int in_ch
, int unitid
,
1014 struct usb_audio_term
*iterm
)
1016 struct usb_mixer_elem_info
*cval
;
1017 unsigned int input_pins
= desc
[4];
1018 unsigned int num_outs
= desc
[5 + input_pins
];
1019 unsigned int i
, len
;
1020 struct snd_kcontrol
*kctl
;
1022 if (check_ignored_ctl(state
, unitid
, 0))
1025 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1029 cval
->mixer
= state
->mixer
;
1031 cval
->control
= in_ch
+ 1; /* based on 1 */
1032 cval
->val_type
= USB_MIXER_S16
;
1033 for (i
= 0; i
< num_outs
; i
++) {
1034 if (check_matrix_bitmap(desc
+ 9 + input_pins
, in_ch
, i
, num_outs
)) {
1035 cval
->cmask
|= (1 << i
);
1040 /* get min/max values */
1041 get_min_max(cval
, 0);
1043 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1045 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1049 kctl
->private_free
= usb_mixer_elem_free
;
1051 len
= check_mapped_name(state
, unitid
, 0, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1053 len
= get_term_name(state
, iterm
, kctl
->id
.name
, sizeof(kctl
->id
.name
), 0);
1055 len
= sprintf(kctl
->id
.name
, "Mixer Source %d", in_ch
+ 1);
1056 strlcat(kctl
->id
.name
+ len
, " Volume", sizeof(kctl
->id
.name
));
1058 snd_printdd(KERN_INFO
"[%d] MU [%s] ch = %d, val = %d/%d\n",
1059 cval
->id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
);
1060 add_control_to_empty(state
, kctl
);
1065 * parse a mixer unit
1067 static int parse_audio_mixer_unit(struct mixer_build
*state
, int unitid
, unsigned char *desc
)
1069 struct usb_audio_term iterm
;
1070 int input_pins
, num_ins
, num_outs
;
1073 if (desc
[0] < 11 || ! (input_pins
= desc
[4]) || ! (num_outs
= desc
[5 + input_pins
])) {
1074 snd_printk(KERN_ERR
"invalid MIXER UNIT descriptor %d\n", unitid
);
1077 /* no bmControls field (e.g. Maya44) -> ignore */
1078 if (desc
[0] <= 10 + input_pins
) {
1079 snd_printdd(KERN_INFO
"MU %d has no bmControls field\n", unitid
);
1085 for (pin
= 0; pin
< input_pins
; pin
++) {
1086 err
= parse_audio_unit(state
, desc
[5 + pin
]);
1089 err
= check_input_term(state
, desc
[5 + pin
], &iterm
);
1092 num_ins
+= iterm
.channels
;
1093 for (; ich
< num_ins
; ++ich
) {
1094 int och
, ich_has_controls
= 0;
1096 for (och
= 0; och
< num_outs
; ++och
) {
1097 if (check_matrix_bitmap(desc
+ 9 + input_pins
,
1098 ich
, och
, num_outs
)) {
1099 ich_has_controls
= 1;
1103 if (ich_has_controls
)
1104 build_mixer_unit_ctl(state
, desc
, pin
, ich
,
1113 * Processing Unit / Extension Unit
1116 /* get callback for processing/extension unit */
1117 static int mixer_ctl_procunit_get(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1119 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1122 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
1123 if (err
< 0 && cval
->mixer
->ignore_ctl_error
) {
1124 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1129 val
= get_relative_value(cval
, val
);
1130 ucontrol
->value
.integer
.value
[0] = val
;
1134 /* put callback for processing/extension unit */
1135 static int mixer_ctl_procunit_put(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1137 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1140 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
1142 if (cval
->mixer
->ignore_ctl_error
)
1146 val
= ucontrol
->value
.integer
.value
[0];
1147 val
= get_abs_value(cval
, val
);
1149 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
1155 /* alsa control interface for processing/extension unit */
1156 static struct snd_kcontrol_new mixer_procunit_ctl
= {
1157 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1158 .name
= "", /* will be filled later */
1159 .info
= mixer_ctl_feature_info
,
1160 .get
= mixer_ctl_procunit_get
,
1161 .put
= mixer_ctl_procunit_put
,
1166 * predefined data for processing units
1168 struct procunit_value_info
{
1175 struct procunit_info
{
1178 struct procunit_value_info
*values
;
1181 static struct procunit_value_info updown_proc_info
[] = {
1182 { USB_PROC_UPDOWN_SWITCH
, "Switch", USB_MIXER_BOOLEAN
},
1183 { USB_PROC_UPDOWN_MODE_SEL
, "Mode Select", USB_MIXER_U8
, 1 },
1186 static struct procunit_value_info prologic_proc_info
[] = {
1187 { USB_PROC_PROLOGIC_SWITCH
, "Switch", USB_MIXER_BOOLEAN
},
1188 { USB_PROC_PROLOGIC_MODE_SEL
, "Mode Select", USB_MIXER_U8
, 1 },
1191 static struct procunit_value_info threed_enh_proc_info
[] = {
1192 { USB_PROC_3DENH_SWITCH
, "Switch", USB_MIXER_BOOLEAN
},
1193 { USB_PROC_3DENH_SPACE
, "Spaciousness", USB_MIXER_U8
},
1196 static struct procunit_value_info reverb_proc_info
[] = {
1197 { USB_PROC_REVERB_SWITCH
, "Switch", USB_MIXER_BOOLEAN
},
1198 { USB_PROC_REVERB_LEVEL
, "Level", USB_MIXER_U8
},
1199 { USB_PROC_REVERB_TIME
, "Time", USB_MIXER_U16
},
1200 { USB_PROC_REVERB_DELAY
, "Delay", USB_MIXER_U8
},
1203 static struct procunit_value_info chorus_proc_info
[] = {
1204 { USB_PROC_CHORUS_SWITCH
, "Switch", USB_MIXER_BOOLEAN
},
1205 { USB_PROC_CHORUS_LEVEL
, "Level", USB_MIXER_U8
},
1206 { USB_PROC_CHORUS_RATE
, "Rate", USB_MIXER_U16
},
1207 { USB_PROC_CHORUS_DEPTH
, "Depth", USB_MIXER_U16
},
1210 static struct procunit_value_info dcr_proc_info
[] = {
1211 { USB_PROC_DCR_SWITCH
, "Switch", USB_MIXER_BOOLEAN
},
1212 { USB_PROC_DCR_RATIO
, "Ratio", USB_MIXER_U16
},
1213 { USB_PROC_DCR_MAX_AMP
, "Max Amp", USB_MIXER_S16
},
1214 { USB_PROC_DCR_THRESHOLD
, "Threshold", USB_MIXER_S16
},
1215 { USB_PROC_DCR_ATTACK
, "Attack Time", USB_MIXER_U16
},
1216 { USB_PROC_DCR_RELEASE
, "Release Time", USB_MIXER_U16
},
1220 static struct procunit_info procunits
[] = {
1221 { USB_PROC_UPDOWN
, "Up Down", updown_proc_info
},
1222 { USB_PROC_PROLOGIC
, "Dolby Prologic", prologic_proc_info
},
1223 { USB_PROC_3DENH
, "3D Stereo Extender", threed_enh_proc_info
},
1224 { USB_PROC_REVERB
, "Reverb", reverb_proc_info
},
1225 { USB_PROC_CHORUS
, "Chorus", chorus_proc_info
},
1226 { USB_PROC_DCR
, "DCR", dcr_proc_info
},
1231 * build a processing/extension unit
1233 static int build_audio_procunit(struct mixer_build
*state
, int unitid
, unsigned char *dsc
, struct procunit_info
*list
, char *name
)
1235 int num_ins
= dsc
[6];
1236 struct usb_mixer_elem_info
*cval
;
1237 struct snd_kcontrol
*kctl
;
1238 int i
, err
, nameid
, type
, len
;
1239 struct procunit_info
*info
;
1240 struct procunit_value_info
*valinfo
;
1241 static struct procunit_value_info default_value_info
[] = {
1242 { 0x01, "Switch", USB_MIXER_BOOLEAN
},
1245 static struct procunit_info default_info
= {
1246 0, NULL
, default_value_info
1249 if (dsc
[0] < 13 || dsc
[0] < 13 + num_ins
|| dsc
[0] < num_ins
+ dsc
[11 + num_ins
]) {
1250 snd_printk(KERN_ERR
"invalid %s descriptor (id %d)\n", name
, unitid
);
1254 for (i
= 0; i
< num_ins
; i
++) {
1255 if ((err
= parse_audio_unit(state
, dsc
[7 + i
])) < 0)
1259 type
= combine_word(&dsc
[4]);
1260 for (info
= list
; info
&& info
->type
; info
++)
1261 if (info
->type
== type
)
1263 if (! info
|| ! info
->type
)
1264 info
= &default_info
;
1266 for (valinfo
= info
->values
; valinfo
->control
; valinfo
++) {
1267 /* FIXME: bitmap might be longer than 8bit */
1268 if (! (dsc
[12 + num_ins
] & (1 << (valinfo
->control
- 1))))
1270 if (check_ignored_ctl(state
, unitid
, valinfo
->control
))
1272 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1274 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1277 cval
->mixer
= state
->mixer
;
1279 cval
->control
= valinfo
->control
;
1280 cval
->val_type
= valinfo
->val_type
;
1283 /* get min/max values */
1284 if (type
== USB_PROC_UPDOWN
&& cval
->control
== USB_PROC_UPDOWN_MODE_SEL
) {
1285 /* FIXME: hard-coded */
1287 cval
->max
= dsc
[15];
1289 cval
->initialized
= 1;
1291 get_min_max(cval
, valinfo
->min_value
);
1293 kctl
= snd_ctl_new1(&mixer_procunit_ctl
, cval
);
1295 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1299 kctl
->private_free
= usb_mixer_elem_free
;
1301 if (check_mapped_name(state
, unitid
, cval
->control
, kctl
->id
.name
, sizeof(kctl
->id
.name
)))
1303 else if (info
->name
)
1304 strlcpy(kctl
->id
.name
, info
->name
, sizeof(kctl
->id
.name
));
1306 nameid
= dsc
[12 + num_ins
+ dsc
[11 + num_ins
]];
1309 len
= snd_usb_copy_string_desc(state
, nameid
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1311 strlcpy(kctl
->id
.name
, name
, sizeof(kctl
->id
.name
));
1313 strlcat(kctl
->id
.name
, " ", sizeof(kctl
->id
.name
));
1314 strlcat(kctl
->id
.name
, valinfo
->suffix
, sizeof(kctl
->id
.name
));
1316 snd_printdd(KERN_INFO
"[%d] PU [%s] ch = %d, val = %d/%d\n",
1317 cval
->id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
);
1318 if ((err
= add_control_to_empty(state
, kctl
)) < 0)
1325 static int parse_audio_processing_unit(struct mixer_build
*state
, int unitid
, unsigned char *desc
)
1327 return build_audio_procunit(state
, unitid
, desc
, procunits
, "Processing Unit");
1330 static int parse_audio_extension_unit(struct mixer_build
*state
, int unitid
, unsigned char *desc
)
1332 return build_audio_procunit(state
, unitid
, desc
, NULL
, "Extension Unit");
1340 /* info callback for selector unit
1341 * use an enumerator type for routing
1343 static int mixer_ctl_selector_info(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_info
*uinfo
)
1345 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1346 char **itemlist
= (char **)kcontrol
->private_value
;
1348 snd_assert(itemlist
, return -EINVAL
);
1349 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_ENUMERATED
;
1351 uinfo
->value
.enumerated
.items
= cval
->max
;
1352 if ((int)uinfo
->value
.enumerated
.item
>= cval
->max
)
1353 uinfo
->value
.enumerated
.item
= cval
->max
- 1;
1354 strcpy(uinfo
->value
.enumerated
.name
, itemlist
[uinfo
->value
.enumerated
.item
]);
1358 /* get callback for selector unit */
1359 static int mixer_ctl_selector_get(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1361 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1364 err
= get_cur_ctl_value(cval
, 0, &val
);
1366 if (cval
->mixer
->ignore_ctl_error
) {
1367 ucontrol
->value
.enumerated
.item
[0] = 0;
1372 val
= get_relative_value(cval
, val
);
1373 ucontrol
->value
.enumerated
.item
[0] = val
;
1377 /* put callback for selector unit */
1378 static int mixer_ctl_selector_put(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1380 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1383 err
= get_cur_ctl_value(cval
, 0, &oval
);
1385 if (cval
->mixer
->ignore_ctl_error
)
1389 val
= ucontrol
->value
.enumerated
.item
[0];
1390 val
= get_abs_value(cval
, val
);
1392 set_cur_ctl_value(cval
, 0, val
);
1398 /* alsa control interface for selector unit */
1399 static struct snd_kcontrol_new mixer_selectunit_ctl
= {
1400 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1401 .name
= "", /* will be filled later */
1402 .info
= mixer_ctl_selector_info
,
1403 .get
= mixer_ctl_selector_get
,
1404 .put
= mixer_ctl_selector_put
,
1408 /* private free callback.
1409 * free both private_data and private_value
1411 static void usb_mixer_selector_elem_free(struct snd_kcontrol
*kctl
)
1415 if (kctl
->private_data
) {
1416 struct usb_mixer_elem_info
*cval
= kctl
->private_data
;
1417 num_ins
= cval
->max
;
1419 kctl
->private_data
= NULL
;
1421 if (kctl
->private_value
) {
1422 char **itemlist
= (char **)kctl
->private_value
;
1423 for (i
= 0; i
< num_ins
; i
++)
1426 kctl
->private_value
= 0;
1431 * parse a selector unit
1433 static int parse_audio_selector_unit(struct mixer_build
*state
, int unitid
, unsigned char *desc
)
1435 unsigned int num_ins
= desc
[4];
1436 unsigned int i
, nameid
, len
;
1438 struct usb_mixer_elem_info
*cval
;
1439 struct snd_kcontrol
*kctl
;
1442 if (! num_ins
|| desc
[0] < 6 + num_ins
) {
1443 snd_printk(KERN_ERR
"invalid SELECTOR UNIT descriptor %d\n", unitid
);
1447 for (i
= 0; i
< num_ins
; i
++) {
1448 if ((err
= parse_audio_unit(state
, desc
[5 + i
])) < 0)
1452 if (num_ins
== 1) /* only one ? nonsense! */
1455 if (check_ignored_ctl(state
, unitid
, 0))
1458 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1460 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1463 cval
->mixer
= state
->mixer
;
1465 cval
->val_type
= USB_MIXER_U8
;
1468 cval
->max
= num_ins
;
1470 cval
->initialized
= 1;
1472 namelist
= kmalloc(sizeof(char *) * num_ins
, GFP_KERNEL
);
1474 snd_printk(KERN_ERR
"cannot malloc\n");
1478 #define MAX_ITEM_NAME_LEN 64
1479 for (i
= 0; i
< num_ins
; i
++) {
1480 struct usb_audio_term iterm
;
1482 namelist
[i
] = kmalloc(MAX_ITEM_NAME_LEN
, GFP_KERNEL
);
1483 if (! namelist
[i
]) {
1484 snd_printk(KERN_ERR
"cannot malloc\n");
1491 len
= check_mapped_selector_name(state
, unitid
, i
, namelist
[i
],
1493 if (! len
&& check_input_term(state
, desc
[5 + i
], &iterm
) >= 0)
1494 len
= get_term_name(state
, &iterm
, namelist
[i
], MAX_ITEM_NAME_LEN
, 0);
1496 sprintf(namelist
[i
], "Input %d", i
);
1499 kctl
= snd_ctl_new1(&mixer_selectunit_ctl
, cval
);
1501 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1506 kctl
->private_value
= (unsigned long)namelist
;
1507 kctl
->private_free
= usb_mixer_selector_elem_free
;
1509 nameid
= desc
[desc
[0] - 1];
1510 len
= check_mapped_name(state
, unitid
, 0, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1514 snd_usb_copy_string_desc(state
, nameid
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1516 len
= get_term_name(state
, &state
->oterm
,
1517 kctl
->id
.name
, sizeof(kctl
->id
.name
), 0);
1519 strlcpy(kctl
->id
.name
, "USB", sizeof(kctl
->id
.name
));
1521 if ((state
->oterm
.type
& 0xff00) == 0x0100)
1522 strlcat(kctl
->id
.name
, " Capture Source", sizeof(kctl
->id
.name
));
1524 strlcat(kctl
->id
.name
, " Playback Source", sizeof(kctl
->id
.name
));
1527 snd_printdd(KERN_INFO
"[%d] SU [%s] items = %d\n",
1528 cval
->id
, kctl
->id
.name
, num_ins
);
1529 if ((err
= add_control_to_empty(state
, kctl
)) < 0)
1537 * parse an audio unit recursively
1540 static int parse_audio_unit(struct mixer_build
*state
, int unitid
)
1544 if (test_and_set_bit(unitid
, state
->unitbitmap
))
1545 return 0; /* the unit already visited */
1547 p1
= find_audio_control_unit(state
, unitid
);
1549 snd_printk(KERN_ERR
"usbaudio: unit %d not found!\n", unitid
);
1554 case INPUT_TERMINAL
:
1557 return parse_audio_mixer_unit(state
, unitid
, p1
);
1559 return parse_audio_selector_unit(state
, unitid
, p1
);
1561 return parse_audio_feature_unit(state
, unitid
, p1
);
1562 case PROCESSING_UNIT
:
1563 return parse_audio_processing_unit(state
, unitid
, p1
);
1564 case EXTENSION_UNIT
:
1565 return parse_audio_extension_unit(state
, unitid
, p1
);
1567 snd_printk(KERN_ERR
"usbaudio: unit %u: unexpected type 0x%02x\n", unitid
, p1
[2]);
1572 static void snd_usb_mixer_free(struct usb_mixer_interface
*mixer
)
1574 kfree(mixer
->id_elems
);
1576 kfree(mixer
->urb
->transfer_buffer
);
1577 usb_free_urb(mixer
->urb
);
1580 usb_free_urb(mixer
->rc_urb
);
1581 kfree(mixer
->rc_setup_packet
);
1585 static int snd_usb_mixer_dev_free(struct snd_device
*device
)
1587 struct usb_mixer_interface
*mixer
= device
->device_data
;
1588 snd_usb_mixer_free(mixer
);
1593 * create mixer controls
1595 * walk through all OUTPUT_TERMINAL descriptors to search for mixers
1597 static int snd_usb_mixer_controls(struct usb_mixer_interface
*mixer
)
1599 unsigned char *desc
;
1600 struct mixer_build state
;
1602 const struct usbmix_ctl_map
*map
;
1603 struct usb_host_interface
*hostif
;
1605 hostif
= &usb_ifnum_to_if(mixer
->chip
->dev
, mixer
->ctrlif
)->altsetting
[0];
1606 memset(&state
, 0, sizeof(state
));
1607 state
.chip
= mixer
->chip
;
1608 state
.mixer
= mixer
;
1609 state
.buffer
= hostif
->extra
;
1610 state
.buflen
= hostif
->extralen
;
1612 /* check the mapping table */
1613 for (map
= usbmix_ctl_maps
; map
->id
; map
++) {
1614 if (map
->id
== state
.chip
->usb_id
) {
1615 state
.map
= map
->map
;
1616 state
.selector_map
= map
->selector_map
;
1617 mixer
->ignore_ctl_error
= map
->ignore_ctl_error
;
1623 while ((desc
= snd_usb_find_csint_desc(hostif
->extra
, hostif
->extralen
, desc
, OUTPUT_TERMINAL
)) != NULL
) {
1625 continue; /* invalid descriptor? */
1626 set_bit(desc
[3], state
.unitbitmap
); /* mark terminal ID as visited */
1627 state
.oterm
.id
= desc
[3];
1628 state
.oterm
.type
= combine_word(&desc
[4]);
1629 state
.oterm
.name
= desc
[8];
1630 err
= parse_audio_unit(&state
, desc
[7]);
1637 static void snd_usb_mixer_notify_id(struct usb_mixer_interface
*mixer
,
1640 struct usb_mixer_elem_info
*info
;
1642 for (info
= mixer
->id_elems
[unitid
]; info
; info
= info
->next_id_elem
)
1643 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
1647 static void snd_usb_mixer_memory_change(struct usb_mixer_interface
*mixer
,
1650 if (mixer
->rc_type
== RC_NONE
)
1652 /* unit ids specific to Extigy/Audigy 2 NX: */
1654 case 0: /* remote control */
1655 mixer
->rc_urb
->dev
= mixer
->chip
->dev
;
1656 usb_submit_urb(mixer
->rc_urb
, GFP_ATOMIC
);
1658 case 4: /* digital in jack */
1659 case 7: /* line in jacks */
1660 case 19: /* speaker out jacks */
1661 case 20: /* headphones out jack */
1664 snd_printd(KERN_DEBUG
"memory change in unknown unit %d\n", unitid
);
1669 static void snd_usb_mixer_status_complete(struct urb
*urb
, struct pt_regs
*regs
)
1671 struct usb_mixer_interface
*mixer
= urb
->context
;
1673 if (urb
->status
== 0) {
1674 u8
*buf
= urb
->transfer_buffer
;
1677 for (i
= urb
->actual_length
; i
>= 2; buf
+= 2, i
-= 2) {
1678 snd_printd(KERN_DEBUG
"status interrupt: %02x %02x\n",
1680 /* ignore any notifications not from the control interface */
1681 if ((buf
[0] & 0x0f) != 0)
1683 if (!(buf
[0] & 0x40))
1684 snd_usb_mixer_notify_id(mixer
, buf
[1]);
1686 snd_usb_mixer_memory_change(mixer
, buf
[1]);
1689 if (urb
->status
!= -ENOENT
&& urb
->status
!= -ECONNRESET
) {
1690 urb
->dev
= mixer
->chip
->dev
;
1691 usb_submit_urb(urb
, GFP_ATOMIC
);
1695 /* create the handler for the optional status interrupt endpoint */
1696 static int snd_usb_mixer_status_create(struct usb_mixer_interface
*mixer
)
1698 struct usb_host_interface
*hostif
;
1699 struct usb_endpoint_descriptor
*ep
;
1700 void *transfer_buffer
;
1704 hostif
= &usb_ifnum_to_if(mixer
->chip
->dev
, mixer
->ctrlif
)->altsetting
[0];
1705 /* we need one interrupt input endpoint */
1706 if (get_iface_desc(hostif
)->bNumEndpoints
< 1)
1708 ep
= get_endpoint(hostif
, 0);
1709 if ((ep
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) != USB_DIR_IN
||
1710 (ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
)
1713 epnum
= ep
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1714 buffer_length
= le16_to_cpu(ep
->wMaxPacketSize
);
1715 transfer_buffer
= kmalloc(buffer_length
, GFP_KERNEL
);
1716 if (!transfer_buffer
)
1718 mixer
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1720 kfree(transfer_buffer
);
1723 usb_fill_int_urb(mixer
->urb
, mixer
->chip
->dev
,
1724 usb_rcvintpipe(mixer
->chip
->dev
, epnum
),
1725 transfer_buffer
, buffer_length
,
1726 snd_usb_mixer_status_complete
, mixer
, ep
->bInterval
);
1727 usb_submit_urb(mixer
->urb
, GFP_KERNEL
);
1731 static void snd_usb_soundblaster_remote_complete(struct urb
*urb
,
1732 struct pt_regs
*regs
)
1734 struct usb_mixer_interface
*mixer
= urb
->context
;
1736 * format of remote control data:
1738 * Audigy 2 NX: 06 80 xx 00 00 00
1740 int offset
= mixer
->rc_type
== RC_EXTIGY
? 0 : 2;
1743 if (urb
->status
< 0 || urb
->actual_length
<= offset
)
1745 code
= mixer
->rc_buffer
[offset
];
1746 /* the Mute button actually changes the mixer control */
1748 snd_usb_mixer_notify_id(mixer
, 18);
1749 mixer
->rc_code
= code
;
1751 wake_up(&mixer
->rc_waitq
);
1754 static int snd_usb_sbrc_hwdep_open(struct snd_hwdep
*hw
, struct file
*file
)
1756 struct usb_mixer_interface
*mixer
= hw
->private_data
;
1758 if (test_and_set_bit(0, &mixer
->rc_hwdep_open
))
1763 static int snd_usb_sbrc_hwdep_release(struct snd_hwdep
*hw
, struct file
*file
)
1765 struct usb_mixer_interface
*mixer
= hw
->private_data
;
1767 clear_bit(0, &mixer
->rc_hwdep_open
);
1768 smp_mb__after_clear_bit();
1772 static long snd_usb_sbrc_hwdep_read(struct snd_hwdep
*hw
, char __user
*buf
,
1773 long count
, loff_t
*offset
)
1775 struct usb_mixer_interface
*mixer
= hw
->private_data
;
1779 if (count
!= 1 && count
!= 4)
1781 err
= wait_event_interruptible(mixer
->rc_waitq
,
1782 (rc_code
= xchg(&mixer
->rc_code
, 0)) != 0);
1785 err
= put_user(rc_code
, buf
);
1787 err
= put_user(rc_code
, (u32 __user
*)buf
);
1789 return err
< 0 ? err
: count
;
1792 static unsigned int snd_usb_sbrc_hwdep_poll(struct snd_hwdep
*hw
, struct file
*file
,
1795 struct usb_mixer_interface
*mixer
= hw
->private_data
;
1797 poll_wait(file
, &mixer
->rc_waitq
, wait
);
1798 return mixer
->rc_code
? POLLIN
| POLLRDNORM
: 0;
1801 static int snd_usb_soundblaster_remote_init(struct usb_mixer_interface
*mixer
)
1803 struct snd_hwdep
*hwdep
;
1806 switch (mixer
->chip
->usb_id
) {
1807 case USB_ID(0x041e, 0x3000):
1808 mixer
->rc_type
= RC_EXTIGY
;
1811 case USB_ID(0x041e, 0x3020):
1812 mixer
->rc_type
= RC_AUDIGY2NX
;
1819 init_waitqueue_head(&mixer
->rc_waitq
);
1820 err
= snd_hwdep_new(mixer
->chip
->card
, "SB remote control", 0, &hwdep
);
1823 snprintf(hwdep
->name
, sizeof(hwdep
->name
),
1824 "%s remote control", mixer
->chip
->card
->shortname
);
1825 hwdep
->iface
= SNDRV_HWDEP_IFACE_SB_RC
;
1826 hwdep
->private_data
= mixer
;
1827 hwdep
->ops
.read
= snd_usb_sbrc_hwdep_read
;
1828 hwdep
->ops
.open
= snd_usb_sbrc_hwdep_open
;
1829 hwdep
->ops
.release
= snd_usb_sbrc_hwdep_release
;
1830 hwdep
->ops
.poll
= snd_usb_sbrc_hwdep_poll
;
1832 mixer
->rc_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1835 mixer
->rc_setup_packet
= kmalloc(sizeof(*mixer
->rc_setup_packet
), GFP_KERNEL
);
1836 if (!mixer
->rc_setup_packet
) {
1837 usb_free_urb(mixer
->rc_urb
);
1838 mixer
->rc_urb
= NULL
;
1841 mixer
->rc_setup_packet
->bRequestType
=
1842 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
;
1843 mixer
->rc_setup_packet
->bRequest
= GET_MEM
;
1844 mixer
->rc_setup_packet
->wValue
= cpu_to_le16(0);
1845 mixer
->rc_setup_packet
->wIndex
= cpu_to_le16(0);
1846 mixer
->rc_setup_packet
->wLength
= cpu_to_le16(len
);
1847 usb_fill_control_urb(mixer
->rc_urb
, mixer
->chip
->dev
,
1848 usb_rcvctrlpipe(mixer
->chip
->dev
, 0),
1849 (u8
*)mixer
->rc_setup_packet
, mixer
->rc_buffer
, len
,
1850 snd_usb_soundblaster_remote_complete
, mixer
);
1854 static int snd_audigy2nx_led_info(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_info
*uinfo
)
1856 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1858 uinfo
->value
.integer
.min
= 0;
1859 uinfo
->value
.integer
.max
= 1;
1863 static int snd_audigy2nx_led_get(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1865 struct usb_mixer_interface
*mixer
= snd_kcontrol_chip(kcontrol
);
1866 int index
= kcontrol
->private_value
;
1868 ucontrol
->value
.integer
.value
[0] = mixer
->audigy2nx_leds
[index
];
1872 static int snd_audigy2nx_led_put(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1874 struct usb_mixer_interface
*mixer
= snd_kcontrol_chip(kcontrol
);
1875 int index
= kcontrol
->private_value
;
1876 int value
= ucontrol
->value
.integer
.value
[0];
1881 changed
= value
!= mixer
->audigy2nx_leds
[index
];
1882 err
= snd_usb_ctl_msg(mixer
->chip
->dev
,
1883 usb_sndctrlpipe(mixer
->chip
->dev
, 0), 0x24,
1884 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
1885 value
, index
+ 2, NULL
, 0, 100);
1888 mixer
->audigy2nx_leds
[index
] = value
;
1892 static struct snd_kcontrol_new snd_audigy2nx_controls
[] = {
1894 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1895 .name
= "CMSS LED Switch",
1896 .info
= snd_audigy2nx_led_info
,
1897 .get
= snd_audigy2nx_led_get
,
1898 .put
= snd_audigy2nx_led_put
,
1902 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1903 .name
= "Power LED Switch",
1904 .info
= snd_audigy2nx_led_info
,
1905 .get
= snd_audigy2nx_led_get
,
1906 .put
= snd_audigy2nx_led_put
,
1910 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1911 .name
= "Dolby Digital LED Switch",
1912 .info
= snd_audigy2nx_led_info
,
1913 .get
= snd_audigy2nx_led_get
,
1914 .put
= snd_audigy2nx_led_put
,
1919 static int snd_audigy2nx_controls_create(struct usb_mixer_interface
*mixer
)
1923 for (i
= 0; i
< ARRAY_SIZE(snd_audigy2nx_controls
); ++i
) {
1924 err
= snd_ctl_add(mixer
->chip
->card
,
1925 snd_ctl_new1(&snd_audigy2nx_controls
[i
], mixer
));
1929 mixer
->audigy2nx_leds
[1] = 1; /* Power LED is on by default */
1933 static void snd_audigy2nx_proc_read(struct snd_info_entry
*entry
,
1934 struct snd_info_buffer
*buffer
)
1936 static const struct {
1945 struct usb_mixer_interface
*mixer
= entry
->private_data
;
1949 snd_iprintf(buffer
, "%s jacks\n\n", mixer
->chip
->card
->shortname
);
1950 for (i
= 0; i
< ARRAY_SIZE(jacks
); ++i
) {
1951 snd_iprintf(buffer
, "%s: ", jacks
[i
].name
);
1952 err
= snd_usb_ctl_msg(mixer
->chip
->dev
,
1953 usb_rcvctrlpipe(mixer
->chip
->dev
, 0),
1954 GET_MEM
, USB_DIR_IN
| USB_TYPE_CLASS
|
1955 USB_RECIP_INTERFACE
, 0,
1956 jacks
[i
].unitid
<< 8, buf
, 3, 100);
1957 if (err
== 3 && buf
[0] == 3)
1958 snd_iprintf(buffer
, "%02x %02x\n", buf
[1], buf
[2]);
1960 snd_iprintf(buffer
, "?\n");
1964 int snd_usb_create_mixer(struct snd_usb_audio
*chip
, int ctrlif
)
1966 static struct snd_device_ops dev_ops
= {
1967 .dev_free
= snd_usb_mixer_dev_free
1969 struct usb_mixer_interface
*mixer
;
1972 strcpy(chip
->card
->mixername
, "USB Mixer");
1974 mixer
= kzalloc(sizeof(*mixer
), GFP_KERNEL
);
1978 mixer
->ctrlif
= ctrlif
;
1979 #ifdef IGNORE_CTL_ERROR
1980 mixer
->ignore_ctl_error
= 1;
1982 mixer
->id_elems
= kcalloc(256, sizeof(*mixer
->id_elems
), GFP_KERNEL
);
1983 if (!mixer
->id_elems
) {
1988 if ((err
= snd_usb_mixer_controls(mixer
)) < 0 ||
1989 (err
= snd_usb_mixer_status_create(mixer
)) < 0)
1992 if ((err
= snd_usb_soundblaster_remote_init(mixer
)) < 0)
1995 if (mixer
->chip
->usb_id
== USB_ID(0x041e, 0x3020)) {
1996 struct snd_info_entry
*entry
;
1998 if ((err
= snd_audigy2nx_controls_create(mixer
)) < 0)
2000 if (!snd_card_proc_new(chip
->card
, "audigy2nx", &entry
))
2001 snd_info_set_text_ops(entry
, mixer
, 1024,
2002 snd_audigy2nx_proc_read
);
2005 err
= snd_device_new(chip
->card
, SNDRV_DEV_LOWLEVEL
, mixer
, &dev_ops
);
2008 list_add(&mixer
->list
, &chip
->mixer_list
);
2012 snd_usb_mixer_free(mixer
);
2016 void snd_usb_mixer_disconnect(struct list_head
*p
)
2018 struct usb_mixer_interface
*mixer
;
2020 mixer
= list_entry(p
, struct usb_mixer_interface
, list
);
2022 usb_kill_urb(mixer
->urb
);
2024 usb_kill_urb(mixer
->rc_urb
);