2 * (Tentative) USB Audio Driver for ALSA
6 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8 * Many codes borrowed from audio.c by
9 * Alan Cox (alan@lxorguk.ukuu.org.uk)
10 * Thomas Sailer (sailer@ife.ee.ethz.ch)
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * TODOs, for both the mixer and the streaming interfaces:
32 * - support for UAC2 effect units
33 * - support for graphical equalizers
34 * - RANGE and MEM set commands (UAC2)
35 * - RANGE and MEM interrupt dispatchers (UAC2)
36 * - audio channel clustering (UAC2)
37 * - audio sample rate converter units (UAC2)
38 * - proper handling of clock multipliers (UAC2)
39 * - dispatch clock change notifications (UAC2)
40 * - stop PCM streams which use a clock that became invalid
41 * - stop PCM streams which use a clock selector that has changed
42 * - parse available sample rates again when clock sources changed
45 #include <linux/bitops.h>
46 #include <linux/init.h>
47 #include <linux/list.h>
48 #include <linux/slab.h>
49 #include <linux/string.h>
50 #include <linux/usb.h>
51 #include <linux/usb/audio.h>
52 #include <linux/usb/audio-v2.h>
54 #include <sound/core.h>
55 #include <sound/control.h>
56 #include <sound/hwdep.h>
57 #include <sound/info.h>
58 #include <sound/tlv.h>
63 #include "mixer_quirks.h"
66 #define MAX_ID_ELEMS 256
68 struct usb_audio_term
{
72 unsigned int chconfig
;
76 struct usbmix_name_map
;
79 struct snd_usb_audio
*chip
;
80 struct usb_mixer_interface
*mixer
;
81 unsigned char *buffer
;
83 DECLARE_BITMAP(unitbitmap
, MAX_ID_ELEMS
);
84 struct usb_audio_term oterm
;
85 const struct usbmix_name_map
*map
;
86 const struct usbmix_selector_map
*selector_map
;
89 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
91 USB_XU_CLOCK_RATE
= 0xe301,
92 USB_XU_CLOCK_SOURCE
= 0xe302,
93 USB_XU_DIGITAL_IO_STATUS
= 0xe303,
94 USB_XU_DEVICE_OPTIONS
= 0xe304,
95 USB_XU_DIRECT_MONITORING
= 0xe305,
96 USB_XU_METERING
= 0xe306
99 USB_XU_CLOCK_SOURCE_SELECTOR
= 0x02, /* clock source*/
100 USB_XU_CLOCK_RATE_SELECTOR
= 0x03, /* clock rate */
101 USB_XU_DIGITAL_FORMAT_SELECTOR
= 0x01, /* the spdif format */
102 USB_XU_SOFT_LIMIT_SELECTOR
= 0x03 /* soft limiter */
106 * manual mapping of mixer names
107 * if the mixer topology is too complicated and the parsed names are
108 * ambiguous, add the entries in usbmixer_maps.c.
110 #include "mixer_maps.c"
112 static const struct usbmix_name_map
*
113 find_map(struct mixer_build
*state
, int unitid
, int control
)
115 const struct usbmix_name_map
*p
= state
->map
;
120 for (p
= state
->map
; p
->id
; p
++) {
121 if (p
->id
== unitid
&&
122 (!control
|| !p
->control
|| control
== p
->control
))
128 /* get the mapped name if the unit matches */
130 check_mapped_name(const struct usbmix_name_map
*p
, char *buf
, int buflen
)
136 return strlcpy(buf
, p
->name
, buflen
);
139 /* ignore the error value if ignore_ctl_error flag is set */
140 #define filter_error(cval, err) \
141 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
143 /* check whether the control should be ignored */
145 check_ignored_ctl(const struct usbmix_name_map
*p
)
147 if (!p
|| p
->name
|| p
->dB
)
153 static inline void check_mapped_dB(const struct usbmix_name_map
*p
,
154 struct usb_mixer_elem_info
*cval
)
157 cval
->dBmin
= p
->dB
->min
;
158 cval
->dBmax
= p
->dB
->max
;
159 cval
->initialized
= 1;
163 /* get the mapped selector source name */
164 static int check_mapped_selector_name(struct mixer_build
*state
, int unitid
,
165 int index
, char *buf
, int buflen
)
167 const struct usbmix_selector_map
*p
;
169 if (!state
->selector_map
)
171 for (p
= state
->selector_map
; p
->id
; p
++) {
172 if (p
->id
== unitid
&& index
< p
->count
)
173 return strlcpy(buf
, p
->names
[index
], buflen
);
179 * find an audio control unit with the given unit id
181 static void *find_audio_control_unit(struct mixer_build
*state
,
184 /* we just parse the header */
185 struct uac_feature_unit_descriptor
*hdr
= NULL
;
187 while ((hdr
= snd_usb_find_desc(state
->buffer
, state
->buflen
, hdr
,
188 USB_DT_CS_INTERFACE
)) != NULL
) {
189 if (hdr
->bLength
>= 4 &&
190 hdr
->bDescriptorSubtype
>= UAC_INPUT_TERMINAL
&&
191 hdr
->bDescriptorSubtype
<= UAC2_SAMPLE_RATE_CONVERTER
&&
192 hdr
->bUnitID
== unit
)
200 * copy a string with the given id
202 static int snd_usb_copy_string_desc(struct mixer_build
*state
,
203 int index
, char *buf
, int maxlen
)
205 int len
= usb_string(state
->chip
->dev
, index
, buf
, maxlen
- 1);
215 * convert from the byte/word on usb descriptor to the zero-based integer
217 static int convert_signed_value(struct usb_mixer_elem_info
*cval
, int val
)
219 switch (cval
->val_type
) {
220 case USB_MIXER_BOOLEAN
:
222 case USB_MIXER_INV_BOOLEAN
:
245 * convert from the zero-based int to the byte/word for usb descriptor
247 static int convert_bytes_value(struct usb_mixer_elem_info
*cval
, int val
)
249 switch (cval
->val_type
) {
250 case USB_MIXER_BOOLEAN
:
252 case USB_MIXER_INV_BOOLEAN
:
261 return 0; /* not reached */
264 static int get_relative_value(struct usb_mixer_elem_info
*cval
, int val
)
270 else if (val
>= cval
->max
)
271 return (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
273 return (val
- cval
->min
) / cval
->res
;
276 static int get_abs_value(struct usb_mixer_elem_info
*cval
, int val
)
289 static int uac2_ctl_value_size(int val_type
)
301 return 0; /* unreachable */
306 * retrieve a mixer value
309 static int get_ctl_value_v1(struct usb_mixer_elem_info
*cval
, int request
,
310 int validx
, int *value_ret
)
312 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
313 unsigned char buf
[2];
314 int val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
318 err
= snd_usb_lock_shutdown(chip
);
322 while (timeout
-- > 0) {
323 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
324 if (snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), request
,
325 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
326 validx
, idx
, buf
, val_len
) >= val_len
) {
327 *value_ret
= convert_signed_value(cval
, snd_usb_combine_bytes(buf
, val_len
));
333 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
334 request
, validx
, idx
, cval
->val_type
);
338 snd_usb_unlock_shutdown(chip
);
342 static int get_ctl_value_v2(struct usb_mixer_elem_info
*cval
, int request
,
343 int validx
, int *value_ret
)
345 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
346 /* enough space for one range */
347 unsigned char buf
[sizeof(__u16
) + 3 * sizeof(__u32
)];
349 int idx
= 0, ret
, val_size
, size
;
352 val_size
= uac2_ctl_value_size(cval
->val_type
);
354 if (request
== UAC_GET_CUR
) {
355 bRequest
= UAC2_CS_CUR
;
358 bRequest
= UAC2_CS_RANGE
;
359 size
= sizeof(__u16
) + 3 * val_size
;
362 memset(buf
, 0, sizeof(buf
));
364 ret
= snd_usb_lock_shutdown(chip
) ? -EIO
: 0;
368 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
369 ret
= snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), bRequest
,
370 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
371 validx
, idx
, buf
, size
);
372 snd_usb_unlock_shutdown(chip
);
377 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
378 request
, validx
, idx
, cval
->val_type
);
382 /* FIXME: how should we handle multiple triplets here? */
389 val
= buf
+ sizeof(__u16
);
392 val
= buf
+ sizeof(__u16
) + val_size
;
395 val
= buf
+ sizeof(__u16
) + val_size
* 2;
401 *value_ret
= convert_signed_value(cval
,
402 snd_usb_combine_bytes(val
, val_size
));
407 static int get_ctl_value(struct usb_mixer_elem_info
*cval
, int request
,
408 int validx
, int *value_ret
)
410 validx
+= cval
->idx_off
;
412 return (cval
->head
.mixer
->protocol
== UAC_VERSION_1
) ?
413 get_ctl_value_v1(cval
, request
, validx
, value_ret
) :
414 get_ctl_value_v2(cval
, request
, validx
, value_ret
);
417 static int get_cur_ctl_value(struct usb_mixer_elem_info
*cval
,
418 int validx
, int *value
)
420 return get_ctl_value(cval
, UAC_GET_CUR
, validx
, value
);
423 /* channel = 0: master, 1 = first channel */
424 static inline int get_cur_mix_raw(struct usb_mixer_elem_info
*cval
,
425 int channel
, int *value
)
427 return get_ctl_value(cval
, UAC_GET_CUR
,
428 (cval
->control
<< 8) | channel
,
432 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info
*cval
,
433 int channel
, int index
, int *value
)
437 if (cval
->cached
& (1 << channel
)) {
438 *value
= cval
->cache_val
[index
];
441 err
= get_cur_mix_raw(cval
, channel
, value
);
443 if (!cval
->head
.mixer
->ignore_ctl_error
)
444 usb_audio_dbg(cval
->head
.mixer
->chip
,
445 "cannot get current value for control %d ch %d: err = %d\n",
446 cval
->control
, channel
, err
);
449 cval
->cached
|= 1 << channel
;
450 cval
->cache_val
[index
] = *value
;
458 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info
*cval
,
459 int request
, int validx
, int value_set
)
461 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
462 unsigned char buf
[4];
463 int idx
= 0, val_len
, err
, timeout
= 10;
465 validx
+= cval
->idx_off
;
467 if (cval
->head
.mixer
->protocol
== UAC_VERSION_1
) {
468 val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
469 } else { /* UAC_VERSION_2 */
470 val_len
= uac2_ctl_value_size(cval
->val_type
);
473 if (request
!= UAC_SET_CUR
) {
474 usb_audio_dbg(chip
, "RANGE setting not yet supported\n");
478 request
= UAC2_CS_CUR
;
481 value_set
= convert_bytes_value(cval
, value_set
);
482 buf
[0] = value_set
& 0xff;
483 buf
[1] = (value_set
>> 8) & 0xff;
484 buf
[2] = (value_set
>> 16) & 0xff;
485 buf
[3] = (value_set
>> 24) & 0xff;
487 err
= snd_usb_lock_shutdown(chip
);
491 while (timeout
-- > 0) {
492 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
493 if (snd_usb_ctl_msg(chip
->dev
,
494 usb_sndctrlpipe(chip
->dev
, 0), request
,
495 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
496 validx
, idx
, buf
, val_len
) >= 0) {
501 usb_audio_dbg(chip
, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
502 request
, validx
, idx
, cval
->val_type
, buf
[0], buf
[1]);
506 snd_usb_unlock_shutdown(chip
);
510 static int set_cur_ctl_value(struct usb_mixer_elem_info
*cval
,
511 int validx
, int value
)
513 return snd_usb_mixer_set_ctl_value(cval
, UAC_SET_CUR
, validx
, value
);
516 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info
*cval
, int channel
,
517 int index
, int value
)
520 unsigned int read_only
= (channel
== 0) ?
521 cval
->master_readonly
:
522 cval
->ch_readonly
& (1 << (channel
- 1));
525 usb_audio_dbg(cval
->head
.mixer
->chip
,
526 "%s(): channel %d of control %d is read_only\n",
527 __func__
, channel
, cval
->control
);
531 err
= snd_usb_mixer_set_ctl_value(cval
,
532 UAC_SET_CUR
, (cval
->control
<< 8) | channel
,
536 cval
->cached
|= 1 << channel
;
537 cval
->cache_val
[index
] = value
;
542 * TLV callback for mixer volume controls
544 int snd_usb_mixer_vol_tlv(struct snd_kcontrol
*kcontrol
, int op_flag
,
545 unsigned int size
, unsigned int __user
*_tlv
)
547 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
548 DECLARE_TLV_DB_MINMAX(scale
, 0, 0);
550 if (size
< sizeof(scale
))
553 scale
[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE
;
554 scale
[2] = cval
->dBmin
;
555 scale
[3] = cval
->dBmax
;
556 if (copy_to_user(_tlv
, scale
, sizeof(scale
)))
562 * parser routines begin here...
565 static int parse_audio_unit(struct mixer_build
*state
, int unitid
);
569 * check if the input/output channel routing is enabled on the given bitmap.
570 * used for mixer unit parser
572 static int check_matrix_bitmap(unsigned char *bmap
,
573 int ich
, int och
, int num_outs
)
575 int idx
= ich
* num_outs
+ och
;
576 return bmap
[idx
>> 3] & (0x80 >> (idx
& 7));
580 * add an alsa control element
581 * search and increment the index until an empty slot is found.
583 * if failed, give up and free the control instance.
586 int snd_usb_mixer_add_control(struct usb_mixer_elem_list
*list
,
587 struct snd_kcontrol
*kctl
)
589 struct usb_mixer_interface
*mixer
= list
->mixer
;
592 while (snd_ctl_find_id(mixer
->chip
->card
, &kctl
->id
))
594 if ((err
= snd_ctl_add(mixer
->chip
->card
, kctl
)) < 0) {
595 usb_audio_dbg(mixer
->chip
, "cannot add control (err = %d)\n",
600 list
->next_id_elem
= mixer
->id_elems
[list
->id
];
601 mixer
->id_elems
[list
->id
] = list
;
606 * get a terminal name string
609 static struct iterm_name_combo
{
613 { 0x0300, "Output" },
614 { 0x0301, "Speaker" },
615 { 0x0302, "Headphone" },
616 { 0x0303, "HMD Audio" },
617 { 0x0304, "Desktop Speaker" },
618 { 0x0305, "Room Speaker" },
619 { 0x0306, "Com Speaker" },
621 { 0x0600, "External In" },
622 { 0x0601, "Analog In" },
623 { 0x0602, "Digital In" },
625 { 0x0604, "Legacy In" },
626 { 0x0605, "IEC958 In" },
627 { 0x0606, "1394 DA Stream" },
628 { 0x0607, "1394 DV Stream" },
629 { 0x0700, "Embedded" },
630 { 0x0701, "Noise Source" },
631 { 0x0702, "Equalization Noise" },
635 { 0x0706, "MiniDisk" },
636 { 0x0707, "Analog Tape" },
637 { 0x0708, "Phonograph" },
638 { 0x0709, "VCR Audio" },
639 { 0x070a, "Video Disk Audio" },
640 { 0x070b, "DVD Audio" },
641 { 0x070c, "TV Tuner Audio" },
642 { 0x070d, "Satellite Rec Audio" },
643 { 0x070e, "Cable Tuner Audio" },
644 { 0x070f, "DSS Audio" },
645 { 0x0710, "Radio Receiver" },
646 { 0x0711, "Radio Transmitter" },
647 { 0x0712, "Multi-Track Recorder" },
648 { 0x0713, "Synthesizer" },
652 static int get_term_name(struct mixer_build
*state
, struct usb_audio_term
*iterm
,
653 unsigned char *name
, int maxlen
, int term_only
)
655 struct iterm_name_combo
*names
;
658 return snd_usb_copy_string_desc(state
, iterm
->name
,
661 /* virtual type - not a real terminal */
662 if (iterm
->type
>> 16) {
665 switch (iterm
->type
>> 16) {
666 case UAC_SELECTOR_UNIT
:
667 strcpy(name
, "Selector");
669 case UAC1_PROCESSING_UNIT
:
670 strcpy(name
, "Process Unit");
672 case UAC1_EXTENSION_UNIT
:
673 strcpy(name
, "Ext Unit");
676 strcpy(name
, "Mixer");
679 return sprintf(name
, "Unit %d", iterm
->id
);
683 switch (iterm
->type
& 0xff00) {
691 strcpy(name
, "Headset");
694 strcpy(name
, "Phone");
698 for (names
= iterm_names
; names
->type
; names
++) {
699 if (names
->type
== iterm
->type
) {
700 strcpy(name
, names
->name
);
701 return strlen(names
->name
);
709 * parse the source unit recursively until it reaches to a terminal
710 * or a branched unit.
712 static int check_input_term(struct mixer_build
*state
, int id
,
713 struct usb_audio_term
*term
)
718 memset(term
, 0, sizeof(*term
));
719 while ((p1
= find_audio_control_unit(state
, id
)) != NULL
) {
720 unsigned char *hdr
= p1
;
723 case UAC_INPUT_TERMINAL
:
724 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
725 struct uac_input_terminal_descriptor
*d
= p1
;
726 term
->type
= le16_to_cpu(d
->wTerminalType
);
727 term
->channels
= d
->bNrChannels
;
728 term
->chconfig
= le16_to_cpu(d
->wChannelConfig
);
729 term
->name
= d
->iTerminal
;
730 } else { /* UAC_VERSION_2 */
731 struct uac2_input_terminal_descriptor
*d
= p1
;
733 /* call recursively to verify that the
734 * referenced clock entity is valid */
735 err
= check_input_term(state
, d
->bCSourceID
, term
);
739 /* save input term properties after recursion,
740 * to ensure they are not overriden by the
743 term
->type
= le16_to_cpu(d
->wTerminalType
);
744 term
->channels
= d
->bNrChannels
;
745 term
->chconfig
= le32_to_cpu(d
->bmChannelConfig
);
746 term
->name
= d
->iTerminal
;
749 case UAC_FEATURE_UNIT
: {
750 /* the header is the same for v1 and v2 */
751 struct uac_feature_unit_descriptor
*d
= p1
;
753 break; /* continue to parse */
755 case UAC_MIXER_UNIT
: {
756 struct uac_mixer_unit_descriptor
*d
= p1
;
757 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
758 term
->channels
= uac_mixer_unit_bNrChannels(d
);
759 term
->chconfig
= uac_mixer_unit_wChannelConfig(d
, state
->mixer
->protocol
);
760 term
->name
= uac_mixer_unit_iMixer(d
);
763 case UAC_SELECTOR_UNIT
:
764 case UAC2_CLOCK_SELECTOR
: {
765 struct uac_selector_unit_descriptor
*d
= p1
;
766 /* call recursively to retrieve the channel info */
767 err
= check_input_term(state
, d
->baSourceID
[0], term
);
770 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
772 term
->name
= uac_selector_unit_iSelector(d
);
775 case UAC1_PROCESSING_UNIT
:
776 case UAC1_EXTENSION_UNIT
:
777 /* UAC2_PROCESSING_UNIT_V2 */
778 /* UAC2_EFFECT_UNIT */
779 case UAC2_EXTENSION_UNIT_V2
: {
780 struct uac_processing_unit_descriptor
*d
= p1
;
782 if (state
->mixer
->protocol
== UAC_VERSION_2
&&
783 hdr
[2] == UAC2_EFFECT_UNIT
) {
784 /* UAC2/UAC1 unit IDs overlap here in an
785 * uncompatible way. Ignore this unit for now.
791 id
= d
->baSourceID
[0];
792 break; /* continue to parse */
794 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
795 term
->channels
= uac_processing_unit_bNrChannels(d
);
796 term
->chconfig
= uac_processing_unit_wChannelConfig(d
, state
->mixer
->protocol
);
797 term
->name
= uac_processing_unit_iProcessing(d
, state
->mixer
->protocol
);
800 case UAC2_CLOCK_SOURCE
: {
801 struct uac_clock_source_descriptor
*d
= p1
;
802 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
804 term
->name
= d
->iClockSource
;
818 /* feature unit control information */
819 struct usb_feature_control_info
{
821 int type
; /* data type for uac1 */
822 int type_uac2
; /* data type for uac2 if different from uac1, else -1 */
825 static struct usb_feature_control_info audio_feature_info
[] = {
826 { "Mute", USB_MIXER_INV_BOOLEAN
, -1 },
827 { "Volume", USB_MIXER_S16
, -1 },
828 { "Tone Control - Bass", USB_MIXER_S8
, -1 },
829 { "Tone Control - Mid", USB_MIXER_S8
, -1 },
830 { "Tone Control - Treble", USB_MIXER_S8
, -1 },
831 { "Graphic Equalizer", USB_MIXER_S8
, -1 }, /* FIXME: not implemeted yet */
832 { "Auto Gain Control", USB_MIXER_BOOLEAN
, -1 },
833 { "Delay Control", USB_MIXER_U16
, USB_MIXER_U32
},
834 { "Bass Boost", USB_MIXER_BOOLEAN
, -1 },
835 { "Loudness", USB_MIXER_BOOLEAN
, -1 },
837 { "Input Gain Control", USB_MIXER_S16
, -1 },
838 { "Input Gain Pad Control", USB_MIXER_S16
, -1 },
839 { "Phase Inverter Control", USB_MIXER_BOOLEAN
, -1 },
842 /* private_free callback */
843 void snd_usb_mixer_elem_free(struct snd_kcontrol
*kctl
)
845 kfree(kctl
->private_data
);
846 kctl
->private_data
= NULL
;
850 * interface to ALSA control for feature/mixer units
853 /* volume control quirks */
854 static void volume_control_quirks(struct usb_mixer_elem_info
*cval
,
855 struct snd_kcontrol
*kctl
)
857 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
858 switch (chip
->usb_id
) {
859 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
860 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
861 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
867 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
868 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
873 if (strstr(kctl
->id
.name
, "Effect Return") != NULL
) {
879 if ((strstr(kctl
->id
.name
, "Playback Volume") != NULL
) ||
880 (strstr(kctl
->id
.name
, "Effect Send") != NULL
)) {
881 cval
->min
= 0xb5fb; /* -73 dB = 0xb6ff */
887 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
888 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
889 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
891 "set quirk for FTU Effect Duration\n");
897 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
898 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
900 "set quirks for FTU Effect Feedback/Volume\n");
907 case USB_ID(0x0d8c, 0x0103):
908 if (!strcmp(kctl
->id
.name
, "PCM Playback Volume")) {
910 "set volume quirk for CM102-A+/102S+\n");
915 case USB_ID(0x0471, 0x0101):
916 case USB_ID(0x0471, 0x0104):
917 case USB_ID(0x0471, 0x0105):
918 case USB_ID(0x0672, 0x1041):
919 /* quirk for UDA1321/N101.
920 * note that detection between firmware 2.1.1.7 (N101)
921 * and later 2.1.1.21 is not very clear from datasheets.
922 * I hope that the min value is -15360 for newer firmware --jk
924 if (!strcmp(kctl
->id
.name
, "PCM Playback Volume") &&
925 cval
->min
== -15616) {
927 "set volume quirk for UDA1321/N101 chip\n");
932 case USB_ID(0x046d, 0x09a4):
933 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
935 "set volume quirk for QuickCam E3500\n");
942 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
943 case USB_ID(0x046d, 0x0808):
944 case USB_ID(0x046d, 0x0809):
945 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
946 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
947 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
948 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
949 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
950 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
951 case USB_ID(0x046d, 0x0991):
952 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
953 /* Most audio usb devices lie about volume resolution.
954 * Most Logitech webcams have res = 384.
955 * Probably there is some logitech magic behind this number --fishor
957 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
959 "set resolution quirk: cval->res = 384\n");
967 * retrieve the minimum and maximum values for the specified control
969 static int get_min_max_with_quirks(struct usb_mixer_elem_info
*cval
,
970 int default_min
, struct snd_kcontrol
*kctl
)
973 cval
->min
= default_min
;
974 cval
->max
= cval
->min
+ 1;
976 cval
->dBmin
= cval
->dBmax
= 0;
978 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
979 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
980 cval
->initialized
= 1;
985 for (i
= 0; i
< MAX_CHANNELS
; i
++)
986 if (cval
->cmask
& (1 << i
)) {
991 if (get_ctl_value(cval
, UAC_GET_MAX
, (cval
->control
<< 8) | minchn
, &cval
->max
) < 0 ||
992 get_ctl_value(cval
, UAC_GET_MIN
, (cval
->control
<< 8) | minchn
, &cval
->min
) < 0) {
993 usb_audio_err(cval
->head
.mixer
->chip
,
994 "%d:%d: cannot get min/max values for control %d (id %d)\n",
995 cval
->head
.id
, snd_usb_ctrl_intf(cval
->head
.mixer
->chip
),
996 cval
->control
, cval
->head
.id
);
999 if (get_ctl_value(cval
, UAC_GET_RES
,
1000 (cval
->control
<< 8) | minchn
,
1004 int last_valid_res
= cval
->res
;
1006 while (cval
->res
> 1) {
1007 if (snd_usb_mixer_set_ctl_value(cval
, UAC_SET_RES
,
1008 (cval
->control
<< 8) | minchn
,
1013 if (get_ctl_value(cval
, UAC_GET_RES
,
1014 (cval
->control
<< 8) | minchn
, &cval
->res
) < 0)
1015 cval
->res
= last_valid_res
;
1020 /* Additional checks for the proper resolution
1022 * Some devices report smaller resolutions than actually
1023 * reacting. They don't return errors but simply clip
1024 * to the lower aligned value.
1026 if (cval
->min
+ cval
->res
< cval
->max
) {
1027 int last_valid_res
= cval
->res
;
1028 int saved
, test
, check
;
1029 get_cur_mix_raw(cval
, minchn
, &saved
);
1032 if (test
< cval
->max
)
1036 if (test
< cval
->min
|| test
> cval
->max
||
1037 snd_usb_set_cur_mix_value(cval
, minchn
, 0, test
) ||
1038 get_cur_mix_raw(cval
, minchn
, &check
)) {
1039 cval
->res
= last_valid_res
;
1046 snd_usb_set_cur_mix_value(cval
, minchn
, 0, saved
);
1049 cval
->initialized
= 1;
1053 volume_control_quirks(cval
, kctl
);
1055 /* USB descriptions contain the dB scale in 1/256 dB unit
1056 * while ALSA TLV contains in 1/100 dB unit
1058 cval
->dBmin
= (convert_signed_value(cval
, cval
->min
) * 100) / 256;
1059 cval
->dBmax
= (convert_signed_value(cval
, cval
->max
) * 100) / 256;
1060 if (cval
->dBmin
> cval
->dBmax
) {
1061 /* something is wrong; assume it's either from/to 0dB */
1062 if (cval
->dBmin
< 0)
1064 else if (cval
->dBmin
> 0)
1066 if (cval
->dBmin
> cval
->dBmax
) {
1067 /* totally crap, return an error */
1075 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1077 /* get a feature/mixer unit info */
1078 static int mixer_ctl_feature_info(struct snd_kcontrol
*kcontrol
,
1079 struct snd_ctl_elem_info
*uinfo
)
1081 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1083 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1084 cval
->val_type
== USB_MIXER_INV_BOOLEAN
)
1085 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1087 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
1088 uinfo
->count
= cval
->channels
;
1089 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1090 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
1091 uinfo
->value
.integer
.min
= 0;
1092 uinfo
->value
.integer
.max
= 1;
1094 if (!cval
->initialized
) {
1095 get_min_max_with_quirks(cval
, 0, kcontrol
);
1096 if (cval
->initialized
&& cval
->dBmin
>= cval
->dBmax
) {
1097 kcontrol
->vd
[0].access
&=
1098 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1099 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
);
1100 snd_ctl_notify(cval
->head
.mixer
->chip
->card
,
1101 SNDRV_CTL_EVENT_MASK_INFO
,
1105 uinfo
->value
.integer
.min
= 0;
1106 uinfo
->value
.integer
.max
=
1107 (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
1112 /* get the current value from feature/mixer unit */
1113 static int mixer_ctl_feature_get(struct snd_kcontrol
*kcontrol
,
1114 struct snd_ctl_elem_value
*ucontrol
)
1116 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1117 int c
, cnt
, val
, err
;
1119 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1122 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1123 if (!(cval
->cmask
& (1 << c
)))
1125 err
= snd_usb_get_cur_mix_value(cval
, c
+ 1, cnt
, &val
);
1127 return filter_error(cval
, err
);
1128 val
= get_relative_value(cval
, val
);
1129 ucontrol
->value
.integer
.value
[cnt
] = val
;
1134 /* master channel */
1135 err
= snd_usb_get_cur_mix_value(cval
, 0, 0, &val
);
1137 return filter_error(cval
, err
);
1138 val
= get_relative_value(cval
, val
);
1139 ucontrol
->value
.integer
.value
[0] = val
;
1144 /* put the current value to feature/mixer unit */
1145 static int mixer_ctl_feature_put(struct snd_kcontrol
*kcontrol
,
1146 struct snd_ctl_elem_value
*ucontrol
)
1148 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1149 int c
, cnt
, val
, oval
, err
;
1154 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1155 if (!(cval
->cmask
& (1 << c
)))
1157 err
= snd_usb_get_cur_mix_value(cval
, c
+ 1, cnt
, &oval
);
1159 return filter_error(cval
, err
);
1160 val
= ucontrol
->value
.integer
.value
[cnt
];
1161 val
= get_abs_value(cval
, val
);
1163 snd_usb_set_cur_mix_value(cval
, c
+ 1, cnt
, val
);
1169 /* master channel */
1170 err
= snd_usb_get_cur_mix_value(cval
, 0, 0, &oval
);
1172 return filter_error(cval
, err
);
1173 val
= ucontrol
->value
.integer
.value
[0];
1174 val
= get_abs_value(cval
, val
);
1176 snd_usb_set_cur_mix_value(cval
, 0, 0, val
);
1183 static struct snd_kcontrol_new usb_feature_unit_ctl
= {
1184 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1185 .name
= "", /* will be filled later manually */
1186 .info
= mixer_ctl_feature_info
,
1187 .get
= mixer_ctl_feature_get
,
1188 .put
= mixer_ctl_feature_put
,
1191 /* the read-only variant */
1192 static struct snd_kcontrol_new usb_feature_unit_ctl_ro
= {
1193 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1194 .name
= "", /* will be filled later manually */
1195 .info
= mixer_ctl_feature_info
,
1196 .get
= mixer_ctl_feature_get
,
1201 * This symbol is exported in order to allow the mixer quirks to
1202 * hook up to the standard feature unit control mechanism
1204 struct snd_kcontrol_new
*snd_usb_feature_unit_ctl
= &usb_feature_unit_ctl
;
1207 * build a feature control
1209 static size_t append_ctl_name(struct snd_kcontrol
*kctl
, const char *str
)
1211 return strlcat(kctl
->id
.name
, str
, sizeof(kctl
->id
.name
));
1215 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1216 * rename it to "Headphone". We determine if something is a headphone
1217 * similar to how udev determines form factor.
1219 static void check_no_speaker_on_headset(struct snd_kcontrol
*kctl
,
1220 struct snd_card
*card
)
1222 const char *names_to_check
[] = {
1223 "Headset", "headset", "Headphone", "headphone", NULL
};
1227 if (strcmp("Speaker", kctl
->id
.name
))
1230 for (s
= names_to_check
; *s
; s
++)
1231 if (strstr(card
->shortname
, *s
)) {
1239 strlcpy(kctl
->id
.name
, "Headphone", sizeof(kctl
->id
.name
));
1242 static void build_feature_ctl(struct mixer_build
*state
, void *raw_desc
,
1243 unsigned int ctl_mask
, int control
,
1244 struct usb_audio_term
*iterm
, int unitid
,
1247 struct uac_feature_unit_descriptor
*desc
= raw_desc
;
1248 struct usb_feature_control_info
*ctl_info
;
1249 unsigned int len
= 0;
1250 int mapped_name
= 0;
1251 int nameid
= uac_feature_unit_iFeature(desc
);
1252 struct snd_kcontrol
*kctl
;
1253 struct usb_mixer_elem_info
*cval
;
1254 const struct usbmix_name_map
*map
;
1257 control
++; /* change from zero-based to 1-based value */
1259 if (control
== UAC_FU_GRAPHIC_EQUALIZER
) {
1260 /* FIXME: not supported yet */
1264 map
= find_map(state
, unitid
, control
);
1265 if (check_ignored_ctl(map
))
1268 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1271 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
1272 cval
->control
= control
;
1273 cval
->cmask
= ctl_mask
;
1274 ctl_info
= &audio_feature_info
[control
-1];
1275 if (state
->mixer
->protocol
== UAC_VERSION_1
)
1276 cval
->val_type
= ctl_info
->type
;
1277 else /* UAC_VERSION_2 */
1278 cval
->val_type
= ctl_info
->type_uac2
>= 0 ?
1279 ctl_info
->type_uac2
: ctl_info
->type
;
1281 if (ctl_mask
== 0) {
1282 cval
->channels
= 1; /* master channel */
1283 cval
->master_readonly
= readonly_mask
;
1286 for (i
= 0; i
< 16; i
++)
1287 if (ctl_mask
& (1 << i
))
1290 cval
->ch_readonly
= readonly_mask
;
1294 * If all channels in the mask are marked read-only, make the control
1295 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1296 * issue write commands to read-only channels.
1298 if (cval
->channels
== readonly_mask
)
1299 kctl
= snd_ctl_new1(&usb_feature_unit_ctl_ro
, cval
);
1301 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1304 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
1308 kctl
->private_free
= snd_usb_mixer_elem_free
;
1310 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1311 mapped_name
= len
!= 0;
1313 len
= snd_usb_copy_string_desc(state
, nameid
,
1314 kctl
->id
.name
, sizeof(kctl
->id
.name
));
1320 * determine the control name. the rule is:
1321 * - if a name id is given in descriptor, use it.
1322 * - if the connected input can be determined, then use the name
1324 * - if the connected output can be determined, use it.
1325 * - otherwise, anonymous name.
1328 len
= get_term_name(state
, iterm
, kctl
->id
.name
,
1329 sizeof(kctl
->id
.name
), 1);
1331 len
= get_term_name(state
, &state
->oterm
,
1333 sizeof(kctl
->id
.name
), 1);
1335 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1336 "Feature %d", unitid
);
1340 check_no_speaker_on_headset(kctl
, state
->mixer
->chip
->card
);
1343 * determine the stream direction:
1344 * if the connected output is USB stream, then it's likely a
1345 * capture stream. otherwise it should be playback (hopefully :)
1347 if (!mapped_name
&& !(state
->oterm
.type
>> 16)) {
1348 if ((state
->oterm
.type
& 0xff00) == 0x0100)
1349 append_ctl_name(kctl
, " Capture");
1351 append_ctl_name(kctl
, " Playback");
1353 append_ctl_name(kctl
, control
== UAC_FU_MUTE
?
1354 " Switch" : " Volume");
1358 strlcpy(kctl
->id
.name
, audio_feature_info
[control
-1].name
,
1359 sizeof(kctl
->id
.name
));
1363 /* get min/max values */
1364 get_min_max_with_quirks(cval
, 0, kctl
);
1366 if (control
== UAC_FU_VOLUME
) {
1367 check_mapped_dB(map
, cval
);
1368 if (cval
->dBmin
< cval
->dBmax
|| !cval
->initialized
) {
1369 kctl
->tlv
.c
= snd_usb_mixer_vol_tlv
;
1370 kctl
->vd
[0].access
|=
1371 SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1372 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
;
1376 snd_usb_mixer_fu_apply_quirk(state
->mixer
, cval
, unitid
, kctl
);
1378 range
= (cval
->max
- cval
->min
) / cval
->res
;
1380 * Are there devices with volume range more than 255? I use a bit more
1381 * to be sure. 384 is a resolution magic number found on Logitech
1382 * devices. It will definitively catch all buggy Logitech devices.
1385 usb_audio_warn(state
->chip
,
1386 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1388 usb_audio_warn(state
->chip
,
1389 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1390 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1391 cval
->min
, cval
->max
, cval
->res
);
1394 usb_audio_dbg(state
->chip
, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1395 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1396 cval
->min
, cval
->max
, cval
->res
);
1397 snd_usb_mixer_add_control(&cval
->head
, kctl
);
1401 * parse a feature unit
1403 * most of controls are defined here.
1405 static int parse_audio_feature_unit(struct mixer_build
*state
, int unitid
,
1409 struct usb_audio_term iterm
;
1410 unsigned int master_bits
, first_ch_bits
;
1412 struct uac_feature_unit_descriptor
*hdr
= _ftr
;
1415 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1416 if (hdr
->bLength
< 7) {
1417 usb_audio_err(state
->chip
,
1418 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1422 csize
= hdr
->bControlSize
;
1424 usb_audio_dbg(state
->chip
,
1425 "unit %u: invalid bControlSize == 0\n",
1429 channels
= (hdr
->bLength
- 7) / csize
- 1;
1430 bmaControls
= hdr
->bmaControls
;
1431 if (hdr
->bLength
< 7 + csize
) {
1432 usb_audio_err(state
->chip
,
1433 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1438 struct uac2_feature_unit_descriptor
*ftr
= _ftr
;
1439 if (hdr
->bLength
< 6) {
1440 usb_audio_err(state
->chip
,
1441 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1446 channels
= (hdr
->bLength
- 6) / 4 - 1;
1447 bmaControls
= ftr
->bmaControls
;
1448 if (hdr
->bLength
< 6 + csize
) {
1449 usb_audio_err(state
->chip
,
1450 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1456 /* parse the source unit */
1457 if ((err
= parse_audio_unit(state
, hdr
->bSourceID
)) < 0)
1460 /* determine the input source type and name */
1461 err
= check_input_term(state
, hdr
->bSourceID
, &iterm
);
1465 master_bits
= snd_usb_combine_bytes(bmaControls
, csize
);
1466 /* master configuration quirks */
1467 switch (state
->chip
->usb_id
) {
1468 case USB_ID(0x08bb, 0x2702):
1469 usb_audio_info(state
->chip
,
1470 "usbmixer: master volume quirk for PCM2702 chip\n");
1471 /* disable non-functional volume control */
1472 master_bits
&= ~UAC_CONTROL_BIT(UAC_FU_VOLUME
);
1474 case USB_ID(0x1130, 0xf211):
1475 usb_audio_info(state
->chip
,
1476 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1477 /* disable non-functional volume control */
1483 first_ch_bits
= snd_usb_combine_bytes(bmaControls
+ csize
, csize
);
1487 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1488 /* check all control types */
1489 for (i
= 0; i
< 10; i
++) {
1490 unsigned int ch_bits
= 0;
1491 for (j
= 0; j
< channels
; j
++) {
1494 mask
= snd_usb_combine_bytes(bmaControls
+
1495 csize
* (j
+1), csize
);
1496 if (mask
& (1 << i
))
1497 ch_bits
|= (1 << j
);
1499 /* audio class v1 controls are never read-only */
1502 * The first channel must be set
1503 * (for ease of programming).
1506 build_feature_ctl(state
, _ftr
, ch_bits
, i
,
1508 if (master_bits
& (1 << i
))
1509 build_feature_ctl(state
, _ftr
, 0, i
, &iterm
,
1512 } else { /* UAC_VERSION_2 */
1513 for (i
= 0; i
< ARRAY_SIZE(audio_feature_info
); i
++) {
1514 unsigned int ch_bits
= 0;
1515 unsigned int ch_read_only
= 0;
1517 for (j
= 0; j
< channels
; j
++) {
1520 mask
= snd_usb_combine_bytes(bmaControls
+
1521 csize
* (j
+1), csize
);
1522 if (uac2_control_is_readable(mask
, i
)) {
1523 ch_bits
|= (1 << j
);
1524 if (!uac2_control_is_writeable(mask
, i
))
1525 ch_read_only
|= (1 << j
);
1530 * NOTE: build_feature_ctl() will mark the control
1531 * read-only if all channels are marked read-only in
1532 * the descriptors. Otherwise, the control will be
1533 * reported as writeable, but the driver will not
1534 * actually issue a write command for read-only
1539 * The first channel must be set
1540 * (for ease of programming).
1543 build_feature_ctl(state
, _ftr
, ch_bits
, i
,
1544 &iterm
, unitid
, ch_read_only
);
1545 if (uac2_control_is_readable(master_bits
, i
))
1546 build_feature_ctl(state
, _ftr
, 0, i
, &iterm
, unitid
,
1547 !uac2_control_is_writeable(master_bits
, i
));
1559 * build a mixer unit control
1561 * the callbacks are identical with feature unit.
1562 * input channel number (zero based) is given in control field instead.
1564 static void build_mixer_unit_ctl(struct mixer_build
*state
,
1565 struct uac_mixer_unit_descriptor
*desc
,
1566 int in_pin
, int in_ch
, int unitid
,
1567 struct usb_audio_term
*iterm
)
1569 struct usb_mixer_elem_info
*cval
;
1570 unsigned int num_outs
= uac_mixer_unit_bNrChannels(desc
);
1571 unsigned int i
, len
;
1572 struct snd_kcontrol
*kctl
;
1573 const struct usbmix_name_map
*map
;
1575 map
= find_map(state
, unitid
, 0);
1576 if (check_ignored_ctl(map
))
1579 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1583 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
1584 cval
->control
= in_ch
+ 1; /* based on 1 */
1585 cval
->val_type
= USB_MIXER_S16
;
1586 for (i
= 0; i
< num_outs
; i
++) {
1587 __u8
*c
= uac_mixer_unit_bmControls(desc
, state
->mixer
->protocol
);
1589 if (check_matrix_bitmap(c
, in_ch
, i
, num_outs
)) {
1590 cval
->cmask
|= (1 << i
);
1595 /* get min/max values */
1596 get_min_max(cval
, 0);
1598 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1600 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
1604 kctl
->private_free
= snd_usb_mixer_elem_free
;
1606 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1608 len
= get_term_name(state
, iterm
, kctl
->id
.name
,
1609 sizeof(kctl
->id
.name
), 0);
1611 len
= sprintf(kctl
->id
.name
, "Mixer Source %d", in_ch
+ 1);
1612 append_ctl_name(kctl
, " Volume");
1614 usb_audio_dbg(state
->chip
, "[%d] MU [%s] ch = %d, val = %d/%d\n",
1615 cval
->head
.id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
);
1616 snd_usb_mixer_add_control(&cval
->head
, kctl
);
1620 * parse a mixer unit
1622 static int parse_audio_mixer_unit(struct mixer_build
*state
, int unitid
,
1625 struct uac_mixer_unit_descriptor
*desc
= raw_desc
;
1626 struct usb_audio_term iterm
;
1627 int input_pins
, num_ins
, num_outs
;
1630 if (desc
->bLength
< 11 || !(input_pins
= desc
->bNrInPins
) ||
1631 !(num_outs
= uac_mixer_unit_bNrChannels(desc
))) {
1632 usb_audio_err(state
->chip
,
1633 "invalid MIXER UNIT descriptor %d\n",
1640 for (pin
= 0; pin
< input_pins
; pin
++) {
1641 err
= parse_audio_unit(state
, desc
->baSourceID
[pin
]);
1644 /* no bmControls field (e.g. Maya44) -> ignore */
1645 if (desc
->bLength
<= 10 + input_pins
)
1647 err
= check_input_term(state
, desc
->baSourceID
[pin
], &iterm
);
1650 num_ins
+= iterm
.channels
;
1651 for (; ich
< num_ins
; ich
++) {
1652 int och
, ich_has_controls
= 0;
1654 for (och
= 0; och
< num_outs
; och
++) {
1655 __u8
*c
= uac_mixer_unit_bmControls(desc
,
1656 state
->mixer
->protocol
);
1658 if (check_matrix_bitmap(c
, ich
, och
, num_outs
)) {
1659 ich_has_controls
= 1;
1663 if (ich_has_controls
)
1664 build_mixer_unit_ctl(state
, desc
, pin
, ich
,
1672 * Processing Unit / Extension Unit
1675 /* get callback for processing/extension unit */
1676 static int mixer_ctl_procunit_get(struct snd_kcontrol
*kcontrol
,
1677 struct snd_ctl_elem_value
*ucontrol
)
1679 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1682 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
1684 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1685 return filter_error(cval
, err
);
1687 val
= get_relative_value(cval
, val
);
1688 ucontrol
->value
.integer
.value
[0] = val
;
1692 /* put callback for processing/extension unit */
1693 static int mixer_ctl_procunit_put(struct snd_kcontrol
*kcontrol
,
1694 struct snd_ctl_elem_value
*ucontrol
)
1696 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1699 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
1701 return filter_error(cval
, err
);
1702 val
= ucontrol
->value
.integer
.value
[0];
1703 val
= get_abs_value(cval
, val
);
1705 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
1711 /* alsa control interface for processing/extension unit */
1712 static struct snd_kcontrol_new mixer_procunit_ctl
= {
1713 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1714 .name
= "", /* will be filled later */
1715 .info
= mixer_ctl_feature_info
,
1716 .get
= mixer_ctl_procunit_get
,
1717 .put
= mixer_ctl_procunit_put
,
1721 * predefined data for processing units
1723 struct procunit_value_info
{
1730 struct procunit_info
{
1733 struct procunit_value_info
*values
;
1736 static struct procunit_value_info updown_proc_info
[] = {
1737 { UAC_UD_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1738 { UAC_UD_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
1741 static struct procunit_value_info prologic_proc_info
[] = {
1742 { UAC_DP_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1743 { UAC_DP_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
1746 static struct procunit_value_info threed_enh_proc_info
[] = {
1747 { UAC_3D_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1748 { UAC_3D_SPACE
, "Spaciousness", USB_MIXER_U8
},
1751 static struct procunit_value_info reverb_proc_info
[] = {
1752 { UAC_REVERB_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1753 { UAC_REVERB_LEVEL
, "Level", USB_MIXER_U8
},
1754 { UAC_REVERB_TIME
, "Time", USB_MIXER_U16
},
1755 { UAC_REVERB_FEEDBACK
, "Feedback", USB_MIXER_U8
},
1758 static struct procunit_value_info chorus_proc_info
[] = {
1759 { UAC_CHORUS_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1760 { UAC_CHORUS_LEVEL
, "Level", USB_MIXER_U8
},
1761 { UAC_CHORUS_RATE
, "Rate", USB_MIXER_U16
},
1762 { UAC_CHORUS_DEPTH
, "Depth", USB_MIXER_U16
},
1765 static struct procunit_value_info dcr_proc_info
[] = {
1766 { UAC_DCR_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1767 { UAC_DCR_RATE
, "Ratio", USB_MIXER_U16
},
1768 { UAC_DCR_MAXAMPL
, "Max Amp", USB_MIXER_S16
},
1769 { UAC_DCR_THRESHOLD
, "Threshold", USB_MIXER_S16
},
1770 { UAC_DCR_ATTACK_TIME
, "Attack Time", USB_MIXER_U16
},
1771 { UAC_DCR_RELEASE_TIME
, "Release Time", USB_MIXER_U16
},
1775 static struct procunit_info procunits
[] = {
1776 { UAC_PROCESS_UP_DOWNMIX
, "Up Down", updown_proc_info
},
1777 { UAC_PROCESS_DOLBY_PROLOGIC
, "Dolby Prologic", prologic_proc_info
},
1778 { UAC_PROCESS_STEREO_EXTENDER
, "3D Stereo Extender", threed_enh_proc_info
},
1779 { UAC_PROCESS_REVERB
, "Reverb", reverb_proc_info
},
1780 { UAC_PROCESS_CHORUS
, "Chorus", chorus_proc_info
},
1781 { UAC_PROCESS_DYN_RANGE_COMP
, "DCR", dcr_proc_info
},
1785 * predefined data for extension units
1787 static struct procunit_value_info clock_rate_xu_info
[] = {
1788 { USB_XU_CLOCK_RATE_SELECTOR
, "Selector", USB_MIXER_U8
, 0 },
1791 static struct procunit_value_info clock_source_xu_info
[] = {
1792 { USB_XU_CLOCK_SOURCE_SELECTOR
, "External", USB_MIXER_BOOLEAN
},
1795 static struct procunit_value_info spdif_format_xu_info
[] = {
1796 { USB_XU_DIGITAL_FORMAT_SELECTOR
, "SPDIF/AC3", USB_MIXER_BOOLEAN
},
1799 static struct procunit_value_info soft_limit_xu_info
[] = {
1800 { USB_XU_SOFT_LIMIT_SELECTOR
, " ", USB_MIXER_BOOLEAN
},
1803 static struct procunit_info extunits
[] = {
1804 { USB_XU_CLOCK_RATE
, "Clock rate", clock_rate_xu_info
},
1805 { USB_XU_CLOCK_SOURCE
, "DigitalIn CLK source", clock_source_xu_info
},
1806 { USB_XU_DIGITAL_IO_STATUS
, "DigitalOut format:", spdif_format_xu_info
},
1807 { USB_XU_DEVICE_OPTIONS
, "AnalogueIn Soft Limit", soft_limit_xu_info
},
1812 * build a processing/extension unit
1814 static int build_audio_procunit(struct mixer_build
*state
, int unitid
,
1815 void *raw_desc
, struct procunit_info
*list
,
1818 struct uac_processing_unit_descriptor
*desc
= raw_desc
;
1820 struct usb_mixer_elem_info
*cval
;
1821 struct snd_kcontrol
*kctl
;
1822 int i
, err
, nameid
, type
, len
;
1823 struct procunit_info
*info
;
1824 struct procunit_value_info
*valinfo
;
1825 const struct usbmix_name_map
*map
;
1826 static struct procunit_value_info default_value_info
[] = {
1827 { 0x01, "Switch", USB_MIXER_BOOLEAN
},
1830 static struct procunit_info default_info
= {
1831 0, NULL
, default_value_info
1834 if (desc
->bLength
< 13) {
1835 usb_audio_err(state
->chip
, "invalid %s descriptor (id %d)\n", name
, unitid
);
1839 num_ins
= desc
->bNrInPins
;
1840 if (desc
->bLength
< 13 + num_ins
||
1841 desc
->bLength
< num_ins
+ uac_processing_unit_bControlSize(desc
, state
->mixer
->protocol
)) {
1842 usb_audio_err(state
->chip
, "invalid %s descriptor (id %d)\n", name
, unitid
);
1846 for (i
= 0; i
< num_ins
; i
++) {
1847 if ((err
= parse_audio_unit(state
, desc
->baSourceID
[i
])) < 0)
1851 type
= le16_to_cpu(desc
->wProcessType
);
1852 for (info
= list
; info
&& info
->type
; info
++)
1853 if (info
->type
== type
)
1855 if (!info
|| !info
->type
)
1856 info
= &default_info
;
1858 for (valinfo
= info
->values
; valinfo
->control
; valinfo
++) {
1859 __u8
*controls
= uac_processing_unit_bmControls(desc
, state
->mixer
->protocol
);
1861 if (!(controls
[valinfo
->control
/ 8] & (1 << ((valinfo
->control
% 8) - 1))))
1863 map
= find_map(state
, unitid
, valinfo
->control
);
1864 if (check_ignored_ctl(map
))
1866 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1869 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
1870 cval
->control
= valinfo
->control
;
1871 cval
->val_type
= valinfo
->val_type
;
1874 /* get min/max values */
1875 if (type
== UAC_PROCESS_UP_DOWNMIX
&& cval
->control
== UAC_UD_MODE_SELECT
) {
1876 __u8
*control_spec
= uac_processing_unit_specific(desc
, state
->mixer
->protocol
);
1877 /* FIXME: hard-coded */
1879 cval
->max
= control_spec
[0];
1881 cval
->initialized
= 1;
1883 if (type
== USB_XU_CLOCK_RATE
) {
1885 * E-Mu USB 0404/0202/TrackerPre/0204
1886 * samplerate control quirk
1891 cval
->initialized
= 1;
1893 get_min_max(cval
, valinfo
->min_value
);
1896 kctl
= snd_ctl_new1(&mixer_procunit_ctl
, cval
);
1901 kctl
->private_free
= snd_usb_mixer_elem_free
;
1903 if (check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
))) {
1905 } else if (info
->name
) {
1906 strlcpy(kctl
->id
.name
, info
->name
, sizeof(kctl
->id
.name
));
1908 nameid
= uac_processing_unit_iProcessing(desc
, state
->mixer
->protocol
);
1911 len
= snd_usb_copy_string_desc(state
, nameid
,
1913 sizeof(kctl
->id
.name
));
1915 strlcpy(kctl
->id
.name
, name
, sizeof(kctl
->id
.name
));
1917 append_ctl_name(kctl
, " ");
1918 append_ctl_name(kctl
, valinfo
->suffix
);
1920 usb_audio_dbg(state
->chip
,
1921 "[%d] PU [%s] ch = %d, val = %d/%d\n",
1922 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1923 cval
->min
, cval
->max
);
1925 err
= snd_usb_mixer_add_control(&cval
->head
, kctl
);
1932 static int parse_audio_processing_unit(struct mixer_build
*state
, int unitid
,
1935 return build_audio_procunit(state
, unitid
, raw_desc
,
1936 procunits
, "Processing Unit");
1939 static int parse_audio_extension_unit(struct mixer_build
*state
, int unitid
,
1943 * Note that we parse extension units with processing unit descriptors.
1944 * That's ok as the layout is the same.
1946 return build_audio_procunit(state
, unitid
, raw_desc
,
1947 extunits
, "Extension Unit");
1955 * info callback for selector unit
1956 * use an enumerator type for routing
1958 static int mixer_ctl_selector_info(struct snd_kcontrol
*kcontrol
,
1959 struct snd_ctl_elem_info
*uinfo
)
1961 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1962 const char **itemlist
= (const char **)kcontrol
->private_value
;
1964 if (snd_BUG_ON(!itemlist
))
1966 return snd_ctl_enum_info(uinfo
, 1, cval
->max
, itemlist
);
1969 /* get callback for selector unit */
1970 static int mixer_ctl_selector_get(struct snd_kcontrol
*kcontrol
,
1971 struct snd_ctl_elem_value
*ucontrol
)
1973 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1976 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
1978 ucontrol
->value
.enumerated
.item
[0] = 0;
1979 return filter_error(cval
, err
);
1981 val
= get_relative_value(cval
, val
);
1982 ucontrol
->value
.enumerated
.item
[0] = val
;
1986 /* put callback for selector unit */
1987 static int mixer_ctl_selector_put(struct snd_kcontrol
*kcontrol
,
1988 struct snd_ctl_elem_value
*ucontrol
)
1990 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1993 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
1995 return filter_error(cval
, err
);
1996 val
= ucontrol
->value
.enumerated
.item
[0];
1997 val
= get_abs_value(cval
, val
);
1999 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
2005 /* alsa control interface for selector unit */
2006 static struct snd_kcontrol_new mixer_selectunit_ctl
= {
2007 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
2008 .name
= "", /* will be filled later */
2009 .info
= mixer_ctl_selector_info
,
2010 .get
= mixer_ctl_selector_get
,
2011 .put
= mixer_ctl_selector_put
,
2015 * private free callback.
2016 * free both private_data and private_value
2018 static void usb_mixer_selector_elem_free(struct snd_kcontrol
*kctl
)
2022 if (kctl
->private_data
) {
2023 struct usb_mixer_elem_info
*cval
= kctl
->private_data
;
2024 num_ins
= cval
->max
;
2026 kctl
->private_data
= NULL
;
2028 if (kctl
->private_value
) {
2029 char **itemlist
= (char **)kctl
->private_value
;
2030 for (i
= 0; i
< num_ins
; i
++)
2033 kctl
->private_value
= 0;
2038 * parse a selector unit
2040 static int parse_audio_selector_unit(struct mixer_build
*state
, int unitid
,
2043 struct uac_selector_unit_descriptor
*desc
= raw_desc
;
2044 unsigned int i
, nameid
, len
;
2046 struct usb_mixer_elem_info
*cval
;
2047 struct snd_kcontrol
*kctl
;
2048 const struct usbmix_name_map
*map
;
2051 if (desc
->bLength
< 5 || !desc
->bNrInPins
||
2052 desc
->bLength
< 5 + desc
->bNrInPins
) {
2053 usb_audio_err(state
->chip
,
2054 "invalid SELECTOR UNIT descriptor %d\n", unitid
);
2058 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
2059 if ((err
= parse_audio_unit(state
, desc
->baSourceID
[i
])) < 0)
2063 if (desc
->bNrInPins
== 1) /* only one ? nonsense! */
2066 map
= find_map(state
, unitid
, 0);
2067 if (check_ignored_ctl(map
))
2070 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
2073 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
2074 cval
->val_type
= USB_MIXER_U8
;
2077 cval
->max
= desc
->bNrInPins
;
2079 cval
->initialized
= 1;
2081 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2083 else /* UAC_VERSION_2 */
2084 cval
->control
= (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
) ?
2085 UAC2_CX_CLOCK_SELECTOR
: UAC2_SU_SELECTOR
;
2087 namelist
= kmalloc(sizeof(char *) * desc
->bNrInPins
, GFP_KERNEL
);
2092 #define MAX_ITEM_NAME_LEN 64
2093 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
2094 struct usb_audio_term iterm
;
2096 namelist
[i
] = kmalloc(MAX_ITEM_NAME_LEN
, GFP_KERNEL
);
2104 len
= check_mapped_selector_name(state
, unitid
, i
, namelist
[i
],
2106 if (! len
&& check_input_term(state
, desc
->baSourceID
[i
], &iterm
) >= 0)
2107 len
= get_term_name(state
, &iterm
, namelist
[i
], MAX_ITEM_NAME_LEN
, 0);
2109 sprintf(namelist
[i
], "Input %u", i
);
2112 kctl
= snd_ctl_new1(&mixer_selectunit_ctl
, cval
);
2114 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
2119 kctl
->private_value
= (unsigned long)namelist
;
2120 kctl
->private_free
= usb_mixer_selector_elem_free
;
2122 /* check the static mapping table at first */
2123 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
2126 /* if iSelector is given, use it */
2127 nameid
= uac_selector_unit_iSelector(desc
);
2129 len
= snd_usb_copy_string_desc(state
, nameid
,
2131 sizeof(kctl
->id
.name
));
2132 /* ... or pick up the terminal name at next */
2134 len
= get_term_name(state
, &state
->oterm
,
2135 kctl
->id
.name
, sizeof(kctl
->id
.name
), 0);
2136 /* ... or use the fixed string "USB" as the last resort */
2138 strlcpy(kctl
->id
.name
, "USB", sizeof(kctl
->id
.name
));
2140 /* and add the proper suffix */
2141 if (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
)
2142 append_ctl_name(kctl
, " Clock Source");
2143 else if ((state
->oterm
.type
& 0xff00) == 0x0100)
2144 append_ctl_name(kctl
, " Capture Source");
2146 append_ctl_name(kctl
, " Playback Source");
2149 usb_audio_dbg(state
->chip
, "[%d] SU [%s] items = %d\n",
2150 cval
->head
.id
, kctl
->id
.name
, desc
->bNrInPins
);
2151 return snd_usb_mixer_add_control(&cval
->head
, kctl
);
2155 * parse an audio unit recursively
2158 static int parse_audio_unit(struct mixer_build
*state
, int unitid
)
2162 if (test_and_set_bit(unitid
, state
->unitbitmap
))
2163 return 0; /* the unit already visited */
2165 p1
= find_audio_control_unit(state
, unitid
);
2167 usb_audio_err(state
->chip
, "unit %d not found!\n", unitid
);
2172 case UAC_INPUT_TERMINAL
:
2173 case UAC2_CLOCK_SOURCE
:
2175 case UAC_MIXER_UNIT
:
2176 return parse_audio_mixer_unit(state
, unitid
, p1
);
2177 case UAC_SELECTOR_UNIT
:
2178 case UAC2_CLOCK_SELECTOR
:
2179 return parse_audio_selector_unit(state
, unitid
, p1
);
2180 case UAC_FEATURE_UNIT
:
2181 return parse_audio_feature_unit(state
, unitid
, p1
);
2182 case UAC1_PROCESSING_UNIT
:
2183 /* UAC2_EFFECT_UNIT has the same value */
2184 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2185 return parse_audio_processing_unit(state
, unitid
, p1
);
2187 return 0; /* FIXME - effect units not implemented yet */
2188 case UAC1_EXTENSION_UNIT
:
2189 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2190 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2191 return parse_audio_extension_unit(state
, unitid
, p1
);
2192 else /* UAC_VERSION_2 */
2193 return parse_audio_processing_unit(state
, unitid
, p1
);
2194 case UAC2_EXTENSION_UNIT_V2
:
2195 return parse_audio_extension_unit(state
, unitid
, p1
);
2197 usb_audio_err(state
->chip
,
2198 "unit %u: unexpected type 0x%02x\n", unitid
, p1
[2]);
2203 static void snd_usb_mixer_free(struct usb_mixer_interface
*mixer
)
2205 /* kill pending URBs */
2206 snd_usb_mixer_disconnect(mixer
);
2208 kfree(mixer
->id_elems
);
2210 kfree(mixer
->urb
->transfer_buffer
);
2211 usb_free_urb(mixer
->urb
);
2213 usb_free_urb(mixer
->rc_urb
);
2214 kfree(mixer
->rc_setup_packet
);
2218 static int snd_usb_mixer_dev_free(struct snd_device
*device
)
2220 struct usb_mixer_interface
*mixer
= device
->device_data
;
2221 snd_usb_mixer_free(mixer
);
2226 * create mixer controls
2228 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2230 static int snd_usb_mixer_controls(struct usb_mixer_interface
*mixer
)
2232 struct mixer_build state
;
2234 const struct usbmix_ctl_map
*map
;
2237 memset(&state
, 0, sizeof(state
));
2238 state
.chip
= mixer
->chip
;
2239 state
.mixer
= mixer
;
2240 state
.buffer
= mixer
->hostif
->extra
;
2241 state
.buflen
= mixer
->hostif
->extralen
;
2243 /* check the mapping table */
2244 for (map
= usbmix_ctl_maps
; map
->id
; map
++) {
2245 if (map
->id
== state
.chip
->usb_id
) {
2246 state
.map
= map
->map
;
2247 state
.selector_map
= map
->selector_map
;
2248 mixer
->ignore_ctl_error
= map
->ignore_ctl_error
;
2254 while ((p
= snd_usb_find_csint_desc(mixer
->hostif
->extra
,
2255 mixer
->hostif
->extralen
,
2256 p
, UAC_OUTPUT_TERMINAL
)) != NULL
) {
2257 if (mixer
->protocol
== UAC_VERSION_1
) {
2258 struct uac1_output_terminal_descriptor
*desc
= p
;
2260 if (desc
->bLength
< sizeof(*desc
))
2261 continue; /* invalid descriptor? */
2262 /* mark terminal ID as visited */
2263 set_bit(desc
->bTerminalID
, state
.unitbitmap
);
2264 state
.oterm
.id
= desc
->bTerminalID
;
2265 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
2266 state
.oterm
.name
= desc
->iTerminal
;
2267 err
= parse_audio_unit(&state
, desc
->bSourceID
);
2268 if (err
< 0 && err
!= -EINVAL
)
2270 } else { /* UAC_VERSION_2 */
2271 struct uac2_output_terminal_descriptor
*desc
= p
;
2273 if (desc
->bLength
< sizeof(*desc
))
2274 continue; /* invalid descriptor? */
2275 /* mark terminal ID as visited */
2276 set_bit(desc
->bTerminalID
, state
.unitbitmap
);
2277 state
.oterm
.id
= desc
->bTerminalID
;
2278 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
2279 state
.oterm
.name
= desc
->iTerminal
;
2280 err
= parse_audio_unit(&state
, desc
->bSourceID
);
2281 if (err
< 0 && err
!= -EINVAL
)
2285 * For UAC2, use the same approach to also add the
2288 err
= parse_audio_unit(&state
, desc
->bCSourceID
);
2289 if (err
< 0 && err
!= -EINVAL
)
2297 void snd_usb_mixer_notify_id(struct usb_mixer_interface
*mixer
, int unitid
)
2299 struct usb_mixer_elem_list
*list
;
2301 for (list
= mixer
->id_elems
[unitid
]; list
; list
= list
->next_id_elem
)
2302 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
2306 static void snd_usb_mixer_dump_cval(struct snd_info_buffer
*buffer
,
2307 struct usb_mixer_elem_list
*list
)
2309 struct usb_mixer_elem_info
*cval
= (struct usb_mixer_elem_info
*)list
;
2310 static char *val_types
[] = {"BOOLEAN", "INV_BOOLEAN",
2311 "S8", "U8", "S16", "U16"};
2312 snd_iprintf(buffer
, " Info: id=%i, control=%i, cmask=0x%x, "
2313 "channels=%i, type=\"%s\"\n", cval
->head
.id
,
2314 cval
->control
, cval
->cmask
, cval
->channels
,
2315 val_types
[cval
->val_type
]);
2316 snd_iprintf(buffer
, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2317 cval
->min
, cval
->max
, cval
->dBmin
, cval
->dBmax
);
2320 static void snd_usb_mixer_proc_read(struct snd_info_entry
*entry
,
2321 struct snd_info_buffer
*buffer
)
2323 struct snd_usb_audio
*chip
= entry
->private_data
;
2324 struct usb_mixer_interface
*mixer
;
2325 struct usb_mixer_elem_list
*list
;
2328 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
2330 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2331 chip
->usb_id
, snd_usb_ctrl_intf(chip
),
2332 mixer
->ignore_ctl_error
);
2333 snd_iprintf(buffer
, "Card: %s\n", chip
->card
->longname
);
2334 for (unitid
= 0; unitid
< MAX_ID_ELEMS
; unitid
++) {
2335 for (list
= mixer
->id_elems
[unitid
]; list
;
2336 list
= list
->next_id_elem
) {
2337 snd_iprintf(buffer
, " Unit: %i\n", list
->id
);
2340 " Control: name=\"%s\", index=%i\n",
2341 list
->kctl
->id
.name
,
2342 list
->kctl
->id
.index
);
2344 list
->dump(buffer
, list
);
2350 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface
*mixer
,
2351 int attribute
, int value
, int index
)
2353 struct usb_mixer_elem_list
*list
;
2354 __u8 unitid
= (index
>> 8) & 0xff;
2355 __u8 control
= (value
>> 8) & 0xff;
2356 __u8 channel
= value
& 0xff;
2358 if (channel
>= MAX_CHANNELS
) {
2359 usb_audio_dbg(mixer
->chip
,
2360 "%s(): bogus channel number %d\n",
2365 for (list
= mixer
->id_elems
[unitid
]; list
; list
= list
->next_id_elem
) {
2366 struct usb_mixer_elem_info
*info
;
2371 info
= (struct usb_mixer_elem_info
*)list
;
2372 if (info
->control
!= control
)
2375 switch (attribute
) {
2377 /* invalidate cache, so the value is read from the device */
2379 info
->cached
&= ~(1 << channel
);
2380 else /* master channel */
2383 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
2384 &info
->head
.kctl
->id
);
2396 usb_audio_dbg(mixer
->chip
,
2397 "unknown attribute %d in interrupt\n",
2404 static void snd_usb_mixer_interrupt(struct urb
*urb
)
2406 struct usb_mixer_interface
*mixer
= urb
->context
;
2407 int len
= urb
->actual_length
;
2408 int ustatus
= urb
->status
;
2413 if (mixer
->protocol
== UAC_VERSION_1
) {
2414 struct uac1_status_word
*status
;
2416 for (status
= urb
->transfer_buffer
;
2417 len
>= sizeof(*status
);
2418 len
-= sizeof(*status
), status
++) {
2419 dev_dbg(&urb
->dev
->dev
, "status interrupt: %02x %02x\n",
2420 status
->bStatusType
,
2421 status
->bOriginator
);
2423 /* ignore any notifications not from the control interface */
2424 if ((status
->bStatusType
& UAC1_STATUS_TYPE_ORIG_MASK
) !=
2425 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF
)
2428 if (status
->bStatusType
& UAC1_STATUS_TYPE_MEM_CHANGED
)
2429 snd_usb_mixer_rc_memory_change(mixer
, status
->bOriginator
);
2431 snd_usb_mixer_notify_id(mixer
, status
->bOriginator
);
2433 } else { /* UAC_VERSION_2 */
2434 struct uac2_interrupt_data_msg
*msg
;
2436 for (msg
= urb
->transfer_buffer
;
2437 len
>= sizeof(*msg
);
2438 len
-= sizeof(*msg
), msg
++) {
2439 /* drop vendor specific and endpoint requests */
2440 if ((msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_VENDOR
) ||
2441 (msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_EP
))
2444 snd_usb_mixer_interrupt_v2(mixer
, msg
->bAttribute
,
2445 le16_to_cpu(msg
->wValue
),
2446 le16_to_cpu(msg
->wIndex
));
2451 if (ustatus
!= -ENOENT
&&
2452 ustatus
!= -ECONNRESET
&&
2453 ustatus
!= -ESHUTDOWN
) {
2454 urb
->dev
= mixer
->chip
->dev
;
2455 usb_submit_urb(urb
, GFP_ATOMIC
);
2459 /* create the handler for the optional status interrupt endpoint */
2460 static int snd_usb_mixer_status_create(struct usb_mixer_interface
*mixer
)
2462 struct usb_endpoint_descriptor
*ep
;
2463 void *transfer_buffer
;
2467 /* we need one interrupt input endpoint */
2468 if (get_iface_desc(mixer
->hostif
)->bNumEndpoints
< 1)
2470 ep
= get_endpoint(mixer
->hostif
, 0);
2471 if (!usb_endpoint_dir_in(ep
) || !usb_endpoint_xfer_int(ep
))
2474 epnum
= usb_endpoint_num(ep
);
2475 buffer_length
= le16_to_cpu(ep
->wMaxPacketSize
);
2476 transfer_buffer
= kmalloc(buffer_length
, GFP_KERNEL
);
2477 if (!transfer_buffer
)
2479 mixer
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
2481 kfree(transfer_buffer
);
2484 usb_fill_int_urb(mixer
->urb
, mixer
->chip
->dev
,
2485 usb_rcvintpipe(mixer
->chip
->dev
, epnum
),
2486 transfer_buffer
, buffer_length
,
2487 snd_usb_mixer_interrupt
, mixer
, ep
->bInterval
);
2488 usb_submit_urb(mixer
->urb
, GFP_KERNEL
);
2492 int snd_usb_create_mixer(struct snd_usb_audio
*chip
, int ctrlif
,
2495 static struct snd_device_ops dev_ops
= {
2496 .dev_free
= snd_usb_mixer_dev_free
2498 struct usb_mixer_interface
*mixer
;
2499 struct snd_info_entry
*entry
;
2502 strcpy(chip
->card
->mixername
, "USB Mixer");
2504 mixer
= kzalloc(sizeof(*mixer
), GFP_KERNEL
);
2508 mixer
->ignore_ctl_error
= ignore_error
;
2509 mixer
->id_elems
= kcalloc(MAX_ID_ELEMS
, sizeof(*mixer
->id_elems
),
2511 if (!mixer
->id_elems
) {
2516 mixer
->hostif
= &usb_ifnum_to_if(chip
->dev
, ctrlif
)->altsetting
[0];
2517 switch (get_iface_desc(mixer
->hostif
)->bInterfaceProtocol
) {
2520 mixer
->protocol
= UAC_VERSION_1
;
2523 mixer
->protocol
= UAC_VERSION_2
;
2527 if ((err
= snd_usb_mixer_controls(mixer
)) < 0 ||
2528 (err
= snd_usb_mixer_status_create(mixer
)) < 0)
2531 snd_usb_mixer_apply_create_quirk(mixer
);
2533 err
= snd_device_new(chip
->card
, SNDRV_DEV_CODEC
, mixer
, &dev_ops
);
2537 if (list_empty(&chip
->mixer_list
) &&
2538 !snd_card_proc_new(chip
->card
, "usbmixer", &entry
))
2539 snd_info_set_text_ops(entry
, chip
, snd_usb_mixer_proc_read
);
2541 list_add(&mixer
->list
, &chip
->mixer_list
);
2545 snd_usb_mixer_free(mixer
);
2549 void snd_usb_mixer_disconnect(struct usb_mixer_interface
*mixer
)
2551 if (mixer
->disconnected
)
2554 usb_kill_urb(mixer
->urb
);
2556 usb_kill_urb(mixer
->rc_urb
);
2557 mixer
->disconnected
= true;
2561 /* stop any bus activity of a mixer */
2562 static void snd_usb_mixer_inactivate(struct usb_mixer_interface
*mixer
)
2564 usb_kill_urb(mixer
->urb
);
2565 usb_kill_urb(mixer
->rc_urb
);
2568 static int snd_usb_mixer_activate(struct usb_mixer_interface
*mixer
)
2573 err
= usb_submit_urb(mixer
->urb
, GFP_NOIO
);
2581 int snd_usb_mixer_suspend(struct usb_mixer_interface
*mixer
)
2583 snd_usb_mixer_inactivate(mixer
);
2587 static int restore_mixer_value(struct usb_mixer_elem_list
*list
)
2589 struct usb_mixer_elem_info
*cval
= (struct usb_mixer_elem_info
*)list
;
2594 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
2595 if (!(cval
->cmask
& (1 << c
)))
2597 if (cval
->cached
& (1 << (c
+ 1))) {
2598 err
= snd_usb_set_cur_mix_value(cval
, c
+ 1, idx
,
2599 cval
->cache_val
[idx
]);
2608 err
= snd_usb_set_cur_mix_value(cval
, 0, 0, *cval
->cache_val
);
2617 int snd_usb_mixer_resume(struct usb_mixer_interface
*mixer
, bool reset_resume
)
2619 struct usb_mixer_elem_list
*list
;
2623 /* restore cached mixer values */
2624 for (id
= 0; id
< MAX_ID_ELEMS
; id
++) {
2625 for (list
= mixer
->id_elems
[id
]; list
;
2626 list
= list
->next_id_elem
) {
2628 err
= list
->resume(list
);
2636 return snd_usb_mixer_activate(mixer
);
2640 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list
*list
,
2641 struct usb_mixer_interface
*mixer
,
2644 list
->mixer
= mixer
;
2646 list
->dump
= snd_usb_mixer_dump_cval
;
2648 list
->resume
= restore_mixer_value
;