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/log2.h>
49 #include <linux/slab.h>
50 #include <linux/string.h>
51 #include <linux/usb.h>
52 #include <linux/usb/audio.h>
53 #include <linux/usb/audio-v2.h>
55 #include <sound/core.h>
56 #include <sound/control.h>
57 #include <sound/hwdep.h>
58 #include <sound/info.h>
59 #include <sound/tlv.h>
64 #include "mixer_quirks.h"
67 #define MAX_ID_ELEMS 256
69 struct usb_audio_term
{
73 unsigned int chconfig
;
77 struct usbmix_name_map
;
80 struct snd_usb_audio
*chip
;
81 struct usb_mixer_interface
*mixer
;
82 unsigned char *buffer
;
84 DECLARE_BITMAP(unitbitmap
, MAX_ID_ELEMS
);
85 struct usb_audio_term oterm
;
86 const struct usbmix_name_map
*map
;
87 const struct usbmix_selector_map
*selector_map
;
90 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
92 USB_XU_CLOCK_RATE
= 0xe301,
93 USB_XU_CLOCK_SOURCE
= 0xe302,
94 USB_XU_DIGITAL_IO_STATUS
= 0xe303,
95 USB_XU_DEVICE_OPTIONS
= 0xe304,
96 USB_XU_DIRECT_MONITORING
= 0xe305,
97 USB_XU_METERING
= 0xe306
100 USB_XU_CLOCK_SOURCE_SELECTOR
= 0x02, /* clock source*/
101 USB_XU_CLOCK_RATE_SELECTOR
= 0x03, /* clock rate */
102 USB_XU_DIGITAL_FORMAT_SELECTOR
= 0x01, /* the spdif format */
103 USB_XU_SOFT_LIMIT_SELECTOR
= 0x03 /* soft limiter */
107 * manual mapping of mixer names
108 * if the mixer topology is too complicated and the parsed names are
109 * ambiguous, add the entries in usbmixer_maps.c.
111 #include "mixer_maps.c"
113 static const struct usbmix_name_map
*
114 find_map(struct mixer_build
*state
, int unitid
, int control
)
116 const struct usbmix_name_map
*p
= state
->map
;
121 for (p
= state
->map
; p
->id
; p
++) {
122 if (p
->id
== unitid
&&
123 (!control
|| !p
->control
|| control
== p
->control
))
129 /* get the mapped name if the unit matches */
131 check_mapped_name(const struct usbmix_name_map
*p
, char *buf
, int buflen
)
137 return strlcpy(buf
, p
->name
, buflen
);
140 /* ignore the error value if ignore_ctl_error flag is set */
141 #define filter_error(cval, err) \
142 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
144 /* check whether the control should be ignored */
146 check_ignored_ctl(const struct usbmix_name_map
*p
)
148 if (!p
|| p
->name
|| p
->dB
)
154 static inline void check_mapped_dB(const struct usbmix_name_map
*p
,
155 struct usb_mixer_elem_info
*cval
)
158 cval
->dBmin
= p
->dB
->min
;
159 cval
->dBmax
= p
->dB
->max
;
160 cval
->initialized
= 1;
164 /* get the mapped selector source name */
165 static int check_mapped_selector_name(struct mixer_build
*state
, int unitid
,
166 int index
, char *buf
, int buflen
)
168 const struct usbmix_selector_map
*p
;
170 if (!state
->selector_map
)
172 for (p
= state
->selector_map
; p
->id
; p
++) {
173 if (p
->id
== unitid
&& index
< p
->count
)
174 return strlcpy(buf
, p
->names
[index
], buflen
);
180 * find an audio control unit with the given unit id
182 static void *find_audio_control_unit(struct mixer_build
*state
,
185 /* we just parse the header */
186 struct uac_feature_unit_descriptor
*hdr
= NULL
;
188 while ((hdr
= snd_usb_find_desc(state
->buffer
, state
->buflen
, hdr
,
189 USB_DT_CS_INTERFACE
)) != NULL
) {
190 if (hdr
->bLength
>= 4 &&
191 hdr
->bDescriptorSubtype
>= UAC_INPUT_TERMINAL
&&
192 hdr
->bDescriptorSubtype
<= UAC2_SAMPLE_RATE_CONVERTER
&&
193 hdr
->bUnitID
== unit
)
201 * copy a string with the given id
203 static int snd_usb_copy_string_desc(struct mixer_build
*state
,
204 int index
, char *buf
, int maxlen
)
206 int len
= usb_string(state
->chip
->dev
, index
, buf
, maxlen
- 1);
212 * convert from the byte/word on usb descriptor to the zero-based integer
214 static int convert_signed_value(struct usb_mixer_elem_info
*cval
, int val
)
216 switch (cval
->val_type
) {
217 case USB_MIXER_BOOLEAN
:
219 case USB_MIXER_INV_BOOLEAN
:
242 * convert from the zero-based int to the byte/word for usb descriptor
244 static int convert_bytes_value(struct usb_mixer_elem_info
*cval
, int val
)
246 switch (cval
->val_type
) {
247 case USB_MIXER_BOOLEAN
:
249 case USB_MIXER_INV_BOOLEAN
:
258 return 0; /* not reached */
261 static int get_relative_value(struct usb_mixer_elem_info
*cval
, int val
)
267 else if (val
>= cval
->max
)
268 return (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
270 return (val
- cval
->min
) / cval
->res
;
273 static int get_abs_value(struct usb_mixer_elem_info
*cval
, int val
)
286 static int uac2_ctl_value_size(int val_type
)
298 return 0; /* unreachable */
303 * retrieve a mixer value
306 static int get_ctl_value_v1(struct usb_mixer_elem_info
*cval
, int request
,
307 int validx
, int *value_ret
)
309 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
310 unsigned char buf
[2];
311 int val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
315 err
= snd_usb_lock_shutdown(chip
);
319 while (timeout
-- > 0) {
320 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
321 err
= snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), request
,
322 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
323 validx
, idx
, buf
, val_len
);
324 if (err
>= val_len
) {
325 *value_ret
= convert_signed_value(cval
, snd_usb_combine_bytes(buf
, val_len
));
328 } else if (err
== -ETIMEDOUT
) {
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 unsigned char buf
[4 + 3 * sizeof(__u32
)]; /* enough space for one range */
348 int idx
= 0, ret
, size
;
351 if (request
== UAC_GET_CUR
) {
352 bRequest
= UAC2_CS_CUR
;
353 size
= uac2_ctl_value_size(cval
->val_type
);
355 bRequest
= UAC2_CS_RANGE
;
359 memset(buf
, 0, sizeof(buf
));
361 ret
= snd_usb_lock_shutdown(chip
) ? -EIO
: 0;
365 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
366 ret
= snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), bRequest
,
367 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
368 validx
, idx
, buf
, size
);
369 snd_usb_unlock_shutdown(chip
);
374 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
375 request
, validx
, idx
, cval
->val_type
);
379 /* FIXME: how should we handle multiple triplets here? */
386 val
= buf
+ sizeof(__u16
);
389 val
= buf
+ sizeof(__u16
) * 2;
392 val
= buf
+ sizeof(__u16
) * 3;
398 *value_ret
= convert_signed_value(cval
, snd_usb_combine_bytes(val
, sizeof(__u16
)));
403 static int get_ctl_value(struct usb_mixer_elem_info
*cval
, int request
,
404 int validx
, int *value_ret
)
406 validx
+= cval
->idx_off
;
408 return (cval
->head
.mixer
->protocol
== UAC_VERSION_1
) ?
409 get_ctl_value_v1(cval
, request
, validx
, value_ret
) :
410 get_ctl_value_v2(cval
, request
, validx
, value_ret
);
413 static int get_cur_ctl_value(struct usb_mixer_elem_info
*cval
,
414 int validx
, int *value
)
416 return get_ctl_value(cval
, UAC_GET_CUR
, validx
, value
);
419 /* channel = 0: master, 1 = first channel */
420 static inline int get_cur_mix_raw(struct usb_mixer_elem_info
*cval
,
421 int channel
, int *value
)
423 return get_ctl_value(cval
, UAC_GET_CUR
,
424 (cval
->control
<< 8) | channel
,
428 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info
*cval
,
429 int channel
, int index
, int *value
)
433 if (cval
->cached
& (1 << channel
)) {
434 *value
= cval
->cache_val
[index
];
437 err
= get_cur_mix_raw(cval
, channel
, value
);
439 if (!cval
->head
.mixer
->ignore_ctl_error
)
440 usb_audio_dbg(cval
->head
.mixer
->chip
,
441 "cannot get current value for control %d ch %d: err = %d\n",
442 cval
->control
, channel
, err
);
445 cval
->cached
|= 1 << channel
;
446 cval
->cache_val
[index
] = *value
;
454 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info
*cval
,
455 int request
, int validx
, int value_set
)
457 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
458 unsigned char buf
[4];
459 int idx
= 0, val_len
, err
, timeout
= 10;
461 validx
+= cval
->idx_off
;
463 if (cval
->head
.mixer
->protocol
== UAC_VERSION_1
) {
464 val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
465 } else { /* UAC_VERSION_2 */
466 val_len
= uac2_ctl_value_size(cval
->val_type
);
469 if (request
!= UAC_SET_CUR
) {
470 usb_audio_dbg(chip
, "RANGE setting not yet supported\n");
474 request
= UAC2_CS_CUR
;
477 value_set
= convert_bytes_value(cval
, value_set
);
478 buf
[0] = value_set
& 0xff;
479 buf
[1] = (value_set
>> 8) & 0xff;
480 buf
[2] = (value_set
>> 16) & 0xff;
481 buf
[3] = (value_set
>> 24) & 0xff;
483 err
= snd_usb_lock_shutdown(chip
);
487 while (timeout
-- > 0) {
488 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
489 err
= snd_usb_ctl_msg(chip
->dev
,
490 usb_sndctrlpipe(chip
->dev
, 0), request
,
491 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
492 validx
, idx
, buf
, val_len
);
496 } else if (err
== -ETIMEDOUT
) {
500 usb_audio_dbg(chip
, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
501 request
, validx
, idx
, cval
->val_type
, buf
[0], buf
[1]);
505 snd_usb_unlock_shutdown(chip
);
509 static int set_cur_ctl_value(struct usb_mixer_elem_info
*cval
,
510 int validx
, int value
)
512 return snd_usb_mixer_set_ctl_value(cval
, UAC_SET_CUR
, validx
, value
);
515 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info
*cval
, int channel
,
516 int index
, int value
)
519 unsigned int read_only
= (channel
== 0) ?
520 cval
->master_readonly
:
521 cval
->ch_readonly
& (1 << (channel
- 1));
524 usb_audio_dbg(cval
->head
.mixer
->chip
,
525 "%s(): channel %d of control %d is read_only\n",
526 __func__
, channel
, cval
->control
);
530 err
= snd_usb_mixer_set_ctl_value(cval
,
531 UAC_SET_CUR
, (cval
->control
<< 8) | channel
,
535 cval
->cached
|= 1 << channel
;
536 cval
->cache_val
[index
] = value
;
541 * TLV callback for mixer volume controls
543 int snd_usb_mixer_vol_tlv(struct snd_kcontrol
*kcontrol
, int op_flag
,
544 unsigned int size
, unsigned int __user
*_tlv
)
546 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
547 DECLARE_TLV_DB_MINMAX(scale
, 0, 0);
549 if (size
< sizeof(scale
))
552 scale
[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE
;
553 scale
[2] = cval
->dBmin
;
554 scale
[3] = cval
->dBmax
;
555 if (copy_to_user(_tlv
, scale
, sizeof(scale
)))
561 * parser routines begin here...
564 static int parse_audio_unit(struct mixer_build
*state
, int unitid
);
568 * check if the input/output channel routing is enabled on the given bitmap.
569 * used for mixer unit parser
571 static int check_matrix_bitmap(unsigned char *bmap
,
572 int ich
, int och
, int num_outs
)
574 int idx
= ich
* num_outs
+ och
;
575 return bmap
[idx
>> 3] & (0x80 >> (idx
& 7));
579 * add an alsa control element
580 * search and increment the index until an empty slot is found.
582 * if failed, give up and free the control instance.
585 int snd_usb_mixer_add_control(struct usb_mixer_elem_list
*list
,
586 struct snd_kcontrol
*kctl
)
588 struct usb_mixer_interface
*mixer
= list
->mixer
;
591 while (snd_ctl_find_id(mixer
->chip
->card
, &kctl
->id
))
593 if ((err
= snd_ctl_add(mixer
->chip
->card
, kctl
)) < 0) {
594 usb_audio_dbg(mixer
->chip
, "cannot add control (err = %d)\n",
599 list
->next_id_elem
= mixer
->id_elems
[list
->id
];
600 mixer
->id_elems
[list
->id
] = list
;
605 * get a terminal name string
608 static struct iterm_name_combo
{
612 { 0x0300, "Output" },
613 { 0x0301, "Speaker" },
614 { 0x0302, "Headphone" },
615 { 0x0303, "HMD Audio" },
616 { 0x0304, "Desktop Speaker" },
617 { 0x0305, "Room Speaker" },
618 { 0x0306, "Com Speaker" },
620 { 0x0600, "External In" },
621 { 0x0601, "Analog In" },
622 { 0x0602, "Digital In" },
624 { 0x0604, "Legacy In" },
625 { 0x0605, "IEC958 In" },
626 { 0x0606, "1394 DA Stream" },
627 { 0x0607, "1394 DV Stream" },
628 { 0x0700, "Embedded" },
629 { 0x0701, "Noise Source" },
630 { 0x0702, "Equalization Noise" },
634 { 0x0706, "MiniDisk" },
635 { 0x0707, "Analog Tape" },
636 { 0x0708, "Phonograph" },
637 { 0x0709, "VCR Audio" },
638 { 0x070a, "Video Disk Audio" },
639 { 0x070b, "DVD Audio" },
640 { 0x070c, "TV Tuner Audio" },
641 { 0x070d, "Satellite Rec Audio" },
642 { 0x070e, "Cable Tuner Audio" },
643 { 0x070f, "DSS Audio" },
644 { 0x0710, "Radio Receiver" },
645 { 0x0711, "Radio Transmitter" },
646 { 0x0712, "Multi-Track Recorder" },
647 { 0x0713, "Synthesizer" },
651 static int get_term_name(struct mixer_build
*state
, struct usb_audio_term
*iterm
,
652 unsigned char *name
, int maxlen
, int term_only
)
654 struct iterm_name_combo
*names
;
657 return snd_usb_copy_string_desc(state
, iterm
->name
,
660 /* virtual type - not a real terminal */
661 if (iterm
->type
>> 16) {
664 switch (iterm
->type
>> 16) {
665 case UAC_SELECTOR_UNIT
:
666 strcpy(name
, "Selector");
668 case UAC1_PROCESSING_UNIT
:
669 strcpy(name
, "Process Unit");
671 case UAC1_EXTENSION_UNIT
:
672 strcpy(name
, "Ext Unit");
675 strcpy(name
, "Mixer");
678 return sprintf(name
, "Unit %d", iterm
->id
);
682 switch (iterm
->type
& 0xff00) {
690 strcpy(name
, "Headset");
693 strcpy(name
, "Phone");
697 for (names
= iterm_names
; names
->type
; names
++) {
698 if (names
->type
== iterm
->type
) {
699 strcpy(name
, names
->name
);
700 return strlen(names
->name
);
708 * parse the source unit recursively until it reaches to a terminal
709 * or a branched unit.
711 static int check_input_term(struct mixer_build
*state
, int id
,
712 struct usb_audio_term
*term
)
717 memset(term
, 0, sizeof(*term
));
718 while ((p1
= find_audio_control_unit(state
, id
)) != NULL
) {
719 unsigned char *hdr
= p1
;
722 case UAC_INPUT_TERMINAL
:
723 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
724 struct uac_input_terminal_descriptor
*d
= p1
;
725 term
->type
= le16_to_cpu(d
->wTerminalType
);
726 term
->channels
= d
->bNrChannels
;
727 term
->chconfig
= le16_to_cpu(d
->wChannelConfig
);
728 term
->name
= d
->iTerminal
;
729 } else { /* UAC_VERSION_2 */
730 struct uac2_input_terminal_descriptor
*d
= p1
;
732 /* call recursively to verify that the
733 * referenced clock entity is valid */
734 err
= check_input_term(state
, d
->bCSourceID
, term
);
738 /* save input term properties after recursion,
739 * to ensure they are not overriden by the
742 term
->type
= le16_to_cpu(d
->wTerminalType
);
743 term
->channels
= d
->bNrChannels
;
744 term
->chconfig
= le32_to_cpu(d
->bmChannelConfig
);
745 term
->name
= d
->iTerminal
;
748 case UAC_FEATURE_UNIT
: {
749 /* the header is the same for v1 and v2 */
750 struct uac_feature_unit_descriptor
*d
= p1
;
752 break; /* continue to parse */
754 case UAC_MIXER_UNIT
: {
755 struct uac_mixer_unit_descriptor
*d
= p1
;
756 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
757 term
->channels
= uac_mixer_unit_bNrChannels(d
);
758 term
->chconfig
= uac_mixer_unit_wChannelConfig(d
, state
->mixer
->protocol
);
759 term
->name
= uac_mixer_unit_iMixer(d
);
762 case UAC_SELECTOR_UNIT
:
763 case UAC2_CLOCK_SELECTOR
: {
764 struct uac_selector_unit_descriptor
*d
= p1
;
765 /* call recursively to retrieve the channel info */
766 err
= check_input_term(state
, d
->baSourceID
[0], term
);
769 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
771 term
->name
= uac_selector_unit_iSelector(d
);
774 case UAC1_PROCESSING_UNIT
:
775 case UAC1_EXTENSION_UNIT
:
776 /* UAC2_PROCESSING_UNIT_V2 */
777 /* UAC2_EFFECT_UNIT */
778 case UAC2_EXTENSION_UNIT_V2
: {
779 struct uac_processing_unit_descriptor
*d
= p1
;
781 if (state
->mixer
->protocol
== UAC_VERSION_2
&&
782 hdr
[2] == UAC2_EFFECT_UNIT
) {
783 /* UAC2/UAC1 unit IDs overlap here in an
784 * uncompatible way. Ignore this unit for now.
790 id
= d
->baSourceID
[0];
791 break; /* continue to parse */
793 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
794 term
->channels
= uac_processing_unit_bNrChannels(d
);
795 term
->chconfig
= uac_processing_unit_wChannelConfig(d
, state
->mixer
->protocol
);
796 term
->name
= uac_processing_unit_iProcessing(d
, state
->mixer
->protocol
);
799 case UAC2_CLOCK_SOURCE
: {
800 struct uac_clock_source_descriptor
*d
= p1
;
801 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
803 term
->name
= d
->iClockSource
;
817 /* feature unit control information */
818 struct usb_feature_control_info
{
820 int type
; /* data type for uac1 */
821 int type_uac2
; /* data type for uac2 if different from uac1, else -1 */
824 static struct usb_feature_control_info audio_feature_info
[] = {
825 { "Mute", USB_MIXER_INV_BOOLEAN
, -1 },
826 { "Volume", USB_MIXER_S16
, -1 },
827 { "Tone Control - Bass", USB_MIXER_S8
, -1 },
828 { "Tone Control - Mid", USB_MIXER_S8
, -1 },
829 { "Tone Control - Treble", USB_MIXER_S8
, -1 },
830 { "Graphic Equalizer", USB_MIXER_S8
, -1 }, /* FIXME: not implemeted yet */
831 { "Auto Gain Control", USB_MIXER_BOOLEAN
, -1 },
832 { "Delay Control", USB_MIXER_U16
, USB_MIXER_U32
},
833 { "Bass Boost", USB_MIXER_BOOLEAN
, -1 },
834 { "Loudness", USB_MIXER_BOOLEAN
, -1 },
836 { "Input Gain Control", USB_MIXER_S16
, -1 },
837 { "Input Gain Pad Control", USB_MIXER_S16
, -1 },
838 { "Phase Inverter Control", USB_MIXER_BOOLEAN
, -1 },
841 /* private_free callback */
842 void snd_usb_mixer_elem_free(struct snd_kcontrol
*kctl
)
844 kfree(kctl
->private_data
);
845 kctl
->private_data
= NULL
;
849 * interface to ALSA control for feature/mixer units
852 /* volume control quirks */
853 static void volume_control_quirks(struct usb_mixer_elem_info
*cval
,
854 struct snd_kcontrol
*kctl
)
856 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
857 switch (chip
->usb_id
) {
858 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
859 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
860 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
866 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
867 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
872 if (strstr(kctl
->id
.name
, "Effect Return") != NULL
) {
878 if ((strstr(kctl
->id
.name
, "Playback Volume") != NULL
) ||
879 (strstr(kctl
->id
.name
, "Effect Send") != NULL
)) {
880 cval
->min
= 0xb5fb; /* -73 dB = 0xb6ff */
886 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
887 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
888 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
890 "set quirk for FTU Effect Duration\n");
896 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
897 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
899 "set quirks for FTU Effect Feedback/Volume\n");
906 case USB_ID(0x0471, 0x0101):
907 case USB_ID(0x0471, 0x0104):
908 case USB_ID(0x0471, 0x0105):
909 case USB_ID(0x0672, 0x1041):
910 /* quirk for UDA1321/N101.
911 * note that detection between firmware 2.1.1.7 (N101)
912 * and later 2.1.1.21 is not very clear from datasheets.
913 * I hope that the min value is -15360 for newer firmware --jk
915 if (!strcmp(kctl
->id
.name
, "PCM Playback Volume") &&
916 cval
->min
== -15616) {
918 "set volume quirk for UDA1321/N101 chip\n");
923 case USB_ID(0x046d, 0x09a4):
924 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
926 "set volume quirk for QuickCam E3500\n");
933 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
934 case USB_ID(0x046d, 0x0808):
935 case USB_ID(0x046d, 0x0809):
936 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
937 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
938 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
939 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
940 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
941 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
942 case USB_ID(0x046d, 0x0991):
943 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
944 /* Most audio usb devices lie about volume resolution.
945 * Most Logitech webcams have res = 384.
946 * Probably there is some logitech magic behind this number --fishor
948 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
950 "set resolution quirk: cval->res = 384\n");
958 * retrieve the minimum and maximum values for the specified control
960 static int get_min_max_with_quirks(struct usb_mixer_elem_info
*cval
,
961 int default_min
, struct snd_kcontrol
*kctl
)
964 cval
->min
= default_min
;
965 cval
->max
= cval
->min
+ 1;
967 cval
->dBmin
= cval
->dBmax
= 0;
969 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
970 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
971 cval
->initialized
= 1;
976 for (i
= 0; i
< MAX_CHANNELS
; i
++)
977 if (cval
->cmask
& (1 << i
)) {
982 if (get_ctl_value(cval
, UAC_GET_MAX
, (cval
->control
<< 8) | minchn
, &cval
->max
) < 0 ||
983 get_ctl_value(cval
, UAC_GET_MIN
, (cval
->control
<< 8) | minchn
, &cval
->min
) < 0) {
984 usb_audio_err(cval
->head
.mixer
->chip
,
985 "%d:%d: cannot get min/max values for control %d (id %d)\n",
986 cval
->head
.id
, snd_usb_ctrl_intf(cval
->head
.mixer
->chip
),
987 cval
->control
, cval
->head
.id
);
990 if (get_ctl_value(cval
, UAC_GET_RES
,
991 (cval
->control
<< 8) | minchn
,
995 int last_valid_res
= cval
->res
;
997 while (cval
->res
> 1) {
998 if (snd_usb_mixer_set_ctl_value(cval
, UAC_SET_RES
,
999 (cval
->control
<< 8) | minchn
,
1004 if (get_ctl_value(cval
, UAC_GET_RES
,
1005 (cval
->control
<< 8) | minchn
, &cval
->res
) < 0)
1006 cval
->res
= last_valid_res
;
1011 /* Additional checks for the proper resolution
1013 * Some devices report smaller resolutions than actually
1014 * reacting. They don't return errors but simply clip
1015 * to the lower aligned value.
1017 if (cval
->min
+ cval
->res
< cval
->max
) {
1018 int last_valid_res
= cval
->res
;
1019 int saved
, test
, check
;
1020 get_cur_mix_raw(cval
, minchn
, &saved
);
1023 if (test
< cval
->max
)
1027 if (test
< cval
->min
|| test
> cval
->max
||
1028 snd_usb_set_cur_mix_value(cval
, minchn
, 0, test
) ||
1029 get_cur_mix_raw(cval
, minchn
, &check
)) {
1030 cval
->res
= last_valid_res
;
1037 snd_usb_set_cur_mix_value(cval
, minchn
, 0, saved
);
1040 cval
->initialized
= 1;
1044 volume_control_quirks(cval
, kctl
);
1046 /* USB descriptions contain the dB scale in 1/256 dB unit
1047 * while ALSA TLV contains in 1/100 dB unit
1049 cval
->dBmin
= (convert_signed_value(cval
, cval
->min
) * 100) / 256;
1050 cval
->dBmax
= (convert_signed_value(cval
, cval
->max
) * 100) / 256;
1051 if (cval
->dBmin
> cval
->dBmax
) {
1052 /* something is wrong; assume it's either from/to 0dB */
1053 if (cval
->dBmin
< 0)
1055 else if (cval
->dBmin
> 0)
1057 if (cval
->dBmin
> cval
->dBmax
) {
1058 /* totally crap, return an error */
1066 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1068 /* get a feature/mixer unit info */
1069 static int mixer_ctl_feature_info(struct snd_kcontrol
*kcontrol
,
1070 struct snd_ctl_elem_info
*uinfo
)
1072 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1074 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1075 cval
->val_type
== USB_MIXER_INV_BOOLEAN
)
1076 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1078 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
1079 uinfo
->count
= cval
->channels
;
1080 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1081 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
1082 uinfo
->value
.integer
.min
= 0;
1083 uinfo
->value
.integer
.max
= 1;
1085 if (!cval
->initialized
) {
1086 get_min_max_with_quirks(cval
, 0, kcontrol
);
1087 if (cval
->initialized
&& cval
->dBmin
>= cval
->dBmax
) {
1088 kcontrol
->vd
[0].access
&=
1089 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1090 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
);
1091 snd_ctl_notify(cval
->head
.mixer
->chip
->card
,
1092 SNDRV_CTL_EVENT_MASK_INFO
,
1096 uinfo
->value
.integer
.min
= 0;
1097 uinfo
->value
.integer
.max
=
1098 (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
1103 /* get the current value from feature/mixer unit */
1104 static int mixer_ctl_feature_get(struct snd_kcontrol
*kcontrol
,
1105 struct snd_ctl_elem_value
*ucontrol
)
1107 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1108 int c
, cnt
, val
, err
;
1110 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1113 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1114 if (!(cval
->cmask
& (1 << c
)))
1116 err
= snd_usb_get_cur_mix_value(cval
, c
+ 1, cnt
, &val
);
1118 return filter_error(cval
, err
);
1119 val
= get_relative_value(cval
, val
);
1120 ucontrol
->value
.integer
.value
[cnt
] = val
;
1125 /* master channel */
1126 err
= snd_usb_get_cur_mix_value(cval
, 0, 0, &val
);
1128 return filter_error(cval
, err
);
1129 val
= get_relative_value(cval
, val
);
1130 ucontrol
->value
.integer
.value
[0] = val
;
1135 /* put the current value to feature/mixer unit */
1136 static int mixer_ctl_feature_put(struct snd_kcontrol
*kcontrol
,
1137 struct snd_ctl_elem_value
*ucontrol
)
1139 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1140 int c
, cnt
, val
, oval
, err
;
1145 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1146 if (!(cval
->cmask
& (1 << c
)))
1148 err
= snd_usb_get_cur_mix_value(cval
, c
+ 1, cnt
, &oval
);
1150 return filter_error(cval
, err
);
1151 val
= ucontrol
->value
.integer
.value
[cnt
];
1152 val
= get_abs_value(cval
, val
);
1154 snd_usb_set_cur_mix_value(cval
, c
+ 1, cnt
, val
);
1160 /* master channel */
1161 err
= snd_usb_get_cur_mix_value(cval
, 0, 0, &oval
);
1163 return filter_error(cval
, err
);
1164 val
= ucontrol
->value
.integer
.value
[0];
1165 val
= get_abs_value(cval
, val
);
1167 snd_usb_set_cur_mix_value(cval
, 0, 0, val
);
1174 static struct snd_kcontrol_new usb_feature_unit_ctl
= {
1175 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1176 .name
= "", /* will be filled later manually */
1177 .info
= mixer_ctl_feature_info
,
1178 .get
= mixer_ctl_feature_get
,
1179 .put
= mixer_ctl_feature_put
,
1182 /* the read-only variant */
1183 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro
= {
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
,
1192 * This symbol is exported in order to allow the mixer quirks to
1193 * hook up to the standard feature unit control mechanism
1195 struct snd_kcontrol_new
*snd_usb_feature_unit_ctl
= &usb_feature_unit_ctl
;
1198 * build a feature control
1200 static size_t append_ctl_name(struct snd_kcontrol
*kctl
, const char *str
)
1202 return strlcat(kctl
->id
.name
, str
, sizeof(kctl
->id
.name
));
1206 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1207 * rename it to "Headphone". We determine if something is a headphone
1208 * similar to how udev determines form factor.
1210 static void check_no_speaker_on_headset(struct snd_kcontrol
*kctl
,
1211 struct snd_card
*card
)
1213 const char *names_to_check
[] = {
1214 "Headset", "headset", "Headphone", "headphone", NULL
};
1218 if (strcmp("Speaker", kctl
->id
.name
))
1221 for (s
= names_to_check
; *s
; s
++)
1222 if (strstr(card
->shortname
, *s
)) {
1230 strlcpy(kctl
->id
.name
, "Headphone", sizeof(kctl
->id
.name
));
1233 static void build_feature_ctl(struct mixer_build
*state
, void *raw_desc
,
1234 unsigned int ctl_mask
, int control
,
1235 struct usb_audio_term
*iterm
, int unitid
,
1238 struct uac_feature_unit_descriptor
*desc
= raw_desc
;
1239 struct usb_feature_control_info
*ctl_info
;
1240 unsigned int len
= 0;
1241 int mapped_name
= 0;
1242 int nameid
= uac_feature_unit_iFeature(desc
);
1243 struct snd_kcontrol
*kctl
;
1244 struct usb_mixer_elem_info
*cval
;
1245 const struct usbmix_name_map
*map
;
1248 control
++; /* change from zero-based to 1-based value */
1250 if (control
== UAC_FU_GRAPHIC_EQUALIZER
) {
1251 /* FIXME: not supported yet */
1255 map
= find_map(state
, unitid
, control
);
1256 if (check_ignored_ctl(map
))
1259 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1262 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
1263 cval
->control
= control
;
1264 cval
->cmask
= ctl_mask
;
1265 ctl_info
= &audio_feature_info
[control
-1];
1266 if (state
->mixer
->protocol
== UAC_VERSION_1
)
1267 cval
->val_type
= ctl_info
->type
;
1268 else /* UAC_VERSION_2 */
1269 cval
->val_type
= ctl_info
->type_uac2
>= 0 ?
1270 ctl_info
->type_uac2
: ctl_info
->type
;
1272 if (ctl_mask
== 0) {
1273 cval
->channels
= 1; /* master channel */
1274 cval
->master_readonly
= readonly_mask
;
1277 for (i
= 0; i
< 16; i
++)
1278 if (ctl_mask
& (1 << i
))
1281 cval
->ch_readonly
= readonly_mask
;
1285 * If all channels in the mask are marked read-only, make the control
1286 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1287 * issue write commands to read-only channels.
1289 if (cval
->channels
== readonly_mask
)
1290 kctl
= snd_ctl_new1(&usb_feature_unit_ctl_ro
, cval
);
1292 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1295 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
1299 kctl
->private_free
= snd_usb_mixer_elem_free
;
1301 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1302 mapped_name
= len
!= 0;
1304 len
= snd_usb_copy_string_desc(state
, nameid
,
1305 kctl
->id
.name
, sizeof(kctl
->id
.name
));
1311 * determine the control name. the rule is:
1312 * - if a name id is given in descriptor, use it.
1313 * - if the connected input can be determined, then use the name
1315 * - if the connected output can be determined, use it.
1316 * - otherwise, anonymous name.
1319 len
= get_term_name(state
, iterm
, kctl
->id
.name
,
1320 sizeof(kctl
->id
.name
), 1);
1322 len
= get_term_name(state
, &state
->oterm
,
1324 sizeof(kctl
->id
.name
), 1);
1326 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1327 "Feature %d", unitid
);
1331 check_no_speaker_on_headset(kctl
, state
->mixer
->chip
->card
);
1334 * determine the stream direction:
1335 * if the connected output is USB stream, then it's likely a
1336 * capture stream. otherwise it should be playback (hopefully :)
1338 if (!mapped_name
&& !(state
->oterm
.type
>> 16)) {
1339 if ((state
->oterm
.type
& 0xff00) == 0x0100)
1340 append_ctl_name(kctl
, " Capture");
1342 append_ctl_name(kctl
, " Playback");
1344 append_ctl_name(kctl
, control
== UAC_FU_MUTE
?
1345 " Switch" : " Volume");
1349 strlcpy(kctl
->id
.name
, audio_feature_info
[control
-1].name
,
1350 sizeof(kctl
->id
.name
));
1354 /* get min/max values */
1355 get_min_max_with_quirks(cval
, 0, kctl
);
1357 if (control
== UAC_FU_VOLUME
) {
1358 check_mapped_dB(map
, cval
);
1359 if (cval
->dBmin
< cval
->dBmax
|| !cval
->initialized
) {
1360 kctl
->tlv
.c
= snd_usb_mixer_vol_tlv
;
1361 kctl
->vd
[0].access
|=
1362 SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1363 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
;
1367 snd_usb_mixer_fu_apply_quirk(state
->mixer
, cval
, unitid
, kctl
);
1369 range
= (cval
->max
- cval
->min
) / cval
->res
;
1371 * Are there devices with volume range more than 255? I use a bit more
1372 * to be sure. 384 is a resolution magic number found on Logitech
1373 * devices. It will definitively catch all buggy Logitech devices.
1376 usb_audio_warn(state
->chip
,
1377 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1379 usb_audio_warn(state
->chip
,
1380 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1381 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1382 cval
->min
, cval
->max
, cval
->res
);
1385 usb_audio_dbg(state
->chip
, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1386 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1387 cval
->min
, cval
->max
, cval
->res
);
1388 snd_usb_mixer_add_control(&cval
->head
, kctl
);
1391 static int parse_clock_source_unit(struct mixer_build
*state
, int unitid
,
1394 struct uac_clock_source_descriptor
*hdr
= _ftr
;
1395 struct usb_mixer_elem_info
*cval
;
1396 struct snd_kcontrol
*kctl
;
1397 char name
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
1400 if (state
->mixer
->protocol
!= UAC_VERSION_2
)
1403 if (hdr
->bLength
!= sizeof(*hdr
)) {
1404 usb_audio_dbg(state
->chip
,
1405 "Bogus clock source descriptor length of %d, ignoring.\n",
1411 * The only property of this unit we are interested in is the
1412 * clock source validity. If that isn't readable, just bail out.
1414 if (!uac2_control_is_readable(hdr
->bmControls
,
1415 ilog2(UAC2_CS_CONTROL_CLOCK_VALID
)))
1418 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1422 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, hdr
->bClockID
);
1427 cval
->val_type
= USB_MIXER_BOOLEAN
;
1428 cval
->control
= UAC2_CS_CONTROL_CLOCK_VALID
;
1430 if (uac2_control_is_writeable(hdr
->bmControls
,
1431 ilog2(UAC2_CS_CONTROL_CLOCK_VALID
)))
1432 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1434 cval
->master_readonly
= 1;
1435 kctl
= snd_ctl_new1(&usb_feature_unit_ctl_ro
, cval
);
1443 kctl
->private_free
= snd_usb_mixer_elem_free
;
1444 ret
= snd_usb_copy_string_desc(state
, hdr
->iClockSource
,
1445 name
, sizeof(name
));
1447 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1448 "%s Validity", name
);
1450 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1451 "Clock Source %d Validity", hdr
->bClockID
);
1453 return snd_usb_mixer_add_control(&cval
->head
, kctl
);
1457 * parse a feature unit
1459 * most of controls are defined here.
1461 static int parse_audio_feature_unit(struct mixer_build
*state
, int unitid
,
1465 struct usb_audio_term iterm
;
1466 unsigned int master_bits
, first_ch_bits
;
1468 struct uac_feature_unit_descriptor
*hdr
= _ftr
;
1471 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1472 csize
= hdr
->bControlSize
;
1474 usb_audio_dbg(state
->chip
,
1475 "unit %u: invalid bControlSize == 0\n",
1479 channels
= (hdr
->bLength
- 7) / csize
- 1;
1480 bmaControls
= hdr
->bmaControls
;
1481 if (hdr
->bLength
< 7 + csize
) {
1482 usb_audio_err(state
->chip
,
1483 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1488 struct uac2_feature_unit_descriptor
*ftr
= _ftr
;
1490 channels
= (hdr
->bLength
- 6) / 4 - 1;
1491 bmaControls
= ftr
->bmaControls
;
1492 if (hdr
->bLength
< 6 + csize
) {
1493 usb_audio_err(state
->chip
,
1494 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1500 /* parse the source unit */
1501 if ((err
= parse_audio_unit(state
, hdr
->bSourceID
)) < 0)
1504 /* determine the input source type and name */
1505 err
= check_input_term(state
, hdr
->bSourceID
, &iterm
);
1509 master_bits
= snd_usb_combine_bytes(bmaControls
, csize
);
1510 /* master configuration quirks */
1511 switch (state
->chip
->usb_id
) {
1512 case USB_ID(0x08bb, 0x2702):
1513 usb_audio_info(state
->chip
,
1514 "usbmixer: master volume quirk for PCM2702 chip\n");
1515 /* disable non-functional volume control */
1516 master_bits
&= ~UAC_CONTROL_BIT(UAC_FU_VOLUME
);
1518 case USB_ID(0x1130, 0xf211):
1519 usb_audio_info(state
->chip
,
1520 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1521 /* disable non-functional volume control */
1527 first_ch_bits
= snd_usb_combine_bytes(bmaControls
+ csize
, csize
);
1531 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1532 /* check all control types */
1533 for (i
= 0; i
< 10; i
++) {
1534 unsigned int ch_bits
= 0;
1535 for (j
= 0; j
< channels
; j
++) {
1538 mask
= snd_usb_combine_bytes(bmaControls
+
1539 csize
* (j
+1), csize
);
1540 if (mask
& (1 << i
))
1541 ch_bits
|= (1 << j
);
1543 /* audio class v1 controls are never read-only */
1546 * The first channel must be set
1547 * (for ease of programming).
1550 build_feature_ctl(state
, _ftr
, ch_bits
, i
,
1552 if (master_bits
& (1 << i
))
1553 build_feature_ctl(state
, _ftr
, 0, i
, &iterm
,
1556 } else { /* UAC_VERSION_2 */
1557 for (i
= 0; i
< ARRAY_SIZE(audio_feature_info
); i
++) {
1558 unsigned int ch_bits
= 0;
1559 unsigned int ch_read_only
= 0;
1561 for (j
= 0; j
< channels
; j
++) {
1564 mask
= snd_usb_combine_bytes(bmaControls
+
1565 csize
* (j
+1), csize
);
1566 if (uac2_control_is_readable(mask
, i
)) {
1567 ch_bits
|= (1 << j
);
1568 if (!uac2_control_is_writeable(mask
, i
))
1569 ch_read_only
|= (1 << j
);
1574 * NOTE: build_feature_ctl() will mark the control
1575 * read-only if all channels are marked read-only in
1576 * the descriptors. Otherwise, the control will be
1577 * reported as writeable, but the driver will not
1578 * actually issue a write command for read-only
1583 * The first channel must be set
1584 * (for ease of programming).
1587 build_feature_ctl(state
, _ftr
, ch_bits
, i
,
1588 &iterm
, unitid
, ch_read_only
);
1589 if (uac2_control_is_readable(master_bits
, i
))
1590 build_feature_ctl(state
, _ftr
, 0, i
, &iterm
, unitid
,
1591 !uac2_control_is_writeable(master_bits
, i
));
1603 * build a mixer unit control
1605 * the callbacks are identical with feature unit.
1606 * input channel number (zero based) is given in control field instead.
1608 static void build_mixer_unit_ctl(struct mixer_build
*state
,
1609 struct uac_mixer_unit_descriptor
*desc
,
1610 int in_pin
, int in_ch
, int unitid
,
1611 struct usb_audio_term
*iterm
)
1613 struct usb_mixer_elem_info
*cval
;
1614 unsigned int num_outs
= uac_mixer_unit_bNrChannels(desc
);
1615 unsigned int i
, len
;
1616 struct snd_kcontrol
*kctl
;
1617 const struct usbmix_name_map
*map
;
1619 map
= find_map(state
, unitid
, 0);
1620 if (check_ignored_ctl(map
))
1623 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1627 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
1628 cval
->control
= in_ch
+ 1; /* based on 1 */
1629 cval
->val_type
= USB_MIXER_S16
;
1630 for (i
= 0; i
< num_outs
; i
++) {
1631 __u8
*c
= uac_mixer_unit_bmControls(desc
, state
->mixer
->protocol
);
1633 if (check_matrix_bitmap(c
, in_ch
, i
, num_outs
)) {
1634 cval
->cmask
|= (1 << i
);
1639 /* get min/max values */
1640 get_min_max(cval
, 0);
1642 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1644 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
1648 kctl
->private_free
= snd_usb_mixer_elem_free
;
1650 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1652 len
= get_term_name(state
, iterm
, kctl
->id
.name
,
1653 sizeof(kctl
->id
.name
), 0);
1655 len
= sprintf(kctl
->id
.name
, "Mixer Source %d", in_ch
+ 1);
1656 append_ctl_name(kctl
, " Volume");
1658 usb_audio_dbg(state
->chip
, "[%d] MU [%s] ch = %d, val = %d/%d\n",
1659 cval
->head
.id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
);
1660 snd_usb_mixer_add_control(&cval
->head
, kctl
);
1664 * parse a mixer unit
1666 static int parse_audio_mixer_unit(struct mixer_build
*state
, int unitid
,
1669 struct uac_mixer_unit_descriptor
*desc
= raw_desc
;
1670 struct usb_audio_term iterm
;
1671 int input_pins
, num_ins
, num_outs
;
1674 if (desc
->bLength
< 11 || !(input_pins
= desc
->bNrInPins
) ||
1675 !(num_outs
= uac_mixer_unit_bNrChannels(desc
))) {
1676 usb_audio_err(state
->chip
,
1677 "invalid MIXER UNIT descriptor %d\n",
1684 for (pin
= 0; pin
< input_pins
; pin
++) {
1685 err
= parse_audio_unit(state
, desc
->baSourceID
[pin
]);
1688 /* no bmControls field (e.g. Maya44) -> ignore */
1689 if (desc
->bLength
<= 10 + input_pins
)
1691 err
= check_input_term(state
, desc
->baSourceID
[pin
], &iterm
);
1694 num_ins
+= iterm
.channels
;
1695 for (; ich
< num_ins
; ich
++) {
1696 int och
, ich_has_controls
= 0;
1698 for (och
= 0; och
< num_outs
; och
++) {
1699 __u8
*c
= uac_mixer_unit_bmControls(desc
,
1700 state
->mixer
->protocol
);
1702 if (check_matrix_bitmap(c
, ich
, och
, num_outs
)) {
1703 ich_has_controls
= 1;
1707 if (ich_has_controls
)
1708 build_mixer_unit_ctl(state
, desc
, pin
, ich
,
1716 * Processing Unit / Extension Unit
1719 /* get callback for processing/extension unit */
1720 static int mixer_ctl_procunit_get(struct snd_kcontrol
*kcontrol
,
1721 struct snd_ctl_elem_value
*ucontrol
)
1723 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1726 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
1728 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1729 return filter_error(cval
, err
);
1731 val
= get_relative_value(cval
, val
);
1732 ucontrol
->value
.integer
.value
[0] = val
;
1736 /* put callback for processing/extension unit */
1737 static int mixer_ctl_procunit_put(struct snd_kcontrol
*kcontrol
,
1738 struct snd_ctl_elem_value
*ucontrol
)
1740 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1743 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
1745 return filter_error(cval
, err
);
1746 val
= ucontrol
->value
.integer
.value
[0];
1747 val
= get_abs_value(cval
, val
);
1749 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
1755 /* alsa control interface for processing/extension unit */
1756 static const struct snd_kcontrol_new mixer_procunit_ctl
= {
1757 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1758 .name
= "", /* will be filled later */
1759 .info
= mixer_ctl_feature_info
,
1760 .get
= mixer_ctl_procunit_get
,
1761 .put
= mixer_ctl_procunit_put
,
1765 * predefined data for processing units
1767 struct procunit_value_info
{
1774 struct procunit_info
{
1777 struct procunit_value_info
*values
;
1780 static struct procunit_value_info updown_proc_info
[] = {
1781 { UAC_UD_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1782 { UAC_UD_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
1785 static struct procunit_value_info prologic_proc_info
[] = {
1786 { UAC_DP_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1787 { UAC_DP_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
1790 static struct procunit_value_info threed_enh_proc_info
[] = {
1791 { UAC_3D_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1792 { UAC_3D_SPACE
, "Spaciousness", USB_MIXER_U8
},
1795 static struct procunit_value_info reverb_proc_info
[] = {
1796 { UAC_REVERB_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1797 { UAC_REVERB_LEVEL
, "Level", USB_MIXER_U8
},
1798 { UAC_REVERB_TIME
, "Time", USB_MIXER_U16
},
1799 { UAC_REVERB_FEEDBACK
, "Feedback", USB_MIXER_U8
},
1802 static struct procunit_value_info chorus_proc_info
[] = {
1803 { UAC_CHORUS_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1804 { UAC_CHORUS_LEVEL
, "Level", USB_MIXER_U8
},
1805 { UAC_CHORUS_RATE
, "Rate", USB_MIXER_U16
},
1806 { UAC_CHORUS_DEPTH
, "Depth", USB_MIXER_U16
},
1809 static struct procunit_value_info dcr_proc_info
[] = {
1810 { UAC_DCR_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1811 { UAC_DCR_RATE
, "Ratio", USB_MIXER_U16
},
1812 { UAC_DCR_MAXAMPL
, "Max Amp", USB_MIXER_S16
},
1813 { UAC_DCR_THRESHOLD
, "Threshold", USB_MIXER_S16
},
1814 { UAC_DCR_ATTACK_TIME
, "Attack Time", USB_MIXER_U16
},
1815 { UAC_DCR_RELEASE_TIME
, "Release Time", USB_MIXER_U16
},
1819 static struct procunit_info procunits
[] = {
1820 { UAC_PROCESS_UP_DOWNMIX
, "Up Down", updown_proc_info
},
1821 { UAC_PROCESS_DOLBY_PROLOGIC
, "Dolby Prologic", prologic_proc_info
},
1822 { UAC_PROCESS_STEREO_EXTENDER
, "3D Stereo Extender", threed_enh_proc_info
},
1823 { UAC_PROCESS_REVERB
, "Reverb", reverb_proc_info
},
1824 { UAC_PROCESS_CHORUS
, "Chorus", chorus_proc_info
},
1825 { UAC_PROCESS_DYN_RANGE_COMP
, "DCR", dcr_proc_info
},
1829 * predefined data for extension units
1831 static struct procunit_value_info clock_rate_xu_info
[] = {
1832 { USB_XU_CLOCK_RATE_SELECTOR
, "Selector", USB_MIXER_U8
, 0 },
1835 static struct procunit_value_info clock_source_xu_info
[] = {
1836 { USB_XU_CLOCK_SOURCE_SELECTOR
, "External", USB_MIXER_BOOLEAN
},
1839 static struct procunit_value_info spdif_format_xu_info
[] = {
1840 { USB_XU_DIGITAL_FORMAT_SELECTOR
, "SPDIF/AC3", USB_MIXER_BOOLEAN
},
1843 static struct procunit_value_info soft_limit_xu_info
[] = {
1844 { USB_XU_SOFT_LIMIT_SELECTOR
, " ", USB_MIXER_BOOLEAN
},
1847 static struct procunit_info extunits
[] = {
1848 { USB_XU_CLOCK_RATE
, "Clock rate", clock_rate_xu_info
},
1849 { USB_XU_CLOCK_SOURCE
, "DigitalIn CLK source", clock_source_xu_info
},
1850 { USB_XU_DIGITAL_IO_STATUS
, "DigitalOut format:", spdif_format_xu_info
},
1851 { USB_XU_DEVICE_OPTIONS
, "AnalogueIn Soft Limit", soft_limit_xu_info
},
1856 * build a processing/extension unit
1858 static int build_audio_procunit(struct mixer_build
*state
, int unitid
,
1859 void *raw_desc
, struct procunit_info
*list
,
1862 struct uac_processing_unit_descriptor
*desc
= raw_desc
;
1863 int num_ins
= desc
->bNrInPins
;
1864 struct usb_mixer_elem_info
*cval
;
1865 struct snd_kcontrol
*kctl
;
1866 int i
, err
, nameid
, type
, len
;
1867 struct procunit_info
*info
;
1868 struct procunit_value_info
*valinfo
;
1869 const struct usbmix_name_map
*map
;
1870 static struct procunit_value_info default_value_info
[] = {
1871 { 0x01, "Switch", USB_MIXER_BOOLEAN
},
1874 static struct procunit_info default_info
= {
1875 0, NULL
, default_value_info
1878 if (desc
->bLength
< 13 || desc
->bLength
< 13 + num_ins
||
1879 desc
->bLength
< num_ins
+ uac_processing_unit_bControlSize(desc
, state
->mixer
->protocol
)) {
1880 usb_audio_err(state
->chip
, "invalid %s descriptor (id %d)\n", name
, unitid
);
1884 for (i
= 0; i
< num_ins
; i
++) {
1885 if ((err
= parse_audio_unit(state
, desc
->baSourceID
[i
])) < 0)
1889 type
= le16_to_cpu(desc
->wProcessType
);
1890 for (info
= list
; info
&& info
->type
; info
++)
1891 if (info
->type
== type
)
1893 if (!info
|| !info
->type
)
1894 info
= &default_info
;
1896 for (valinfo
= info
->values
; valinfo
->control
; valinfo
++) {
1897 __u8
*controls
= uac_processing_unit_bmControls(desc
, state
->mixer
->protocol
);
1899 if (!(controls
[valinfo
->control
/ 8] & (1 << ((valinfo
->control
% 8) - 1))))
1901 map
= find_map(state
, unitid
, valinfo
->control
);
1902 if (check_ignored_ctl(map
))
1904 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1907 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
1908 cval
->control
= valinfo
->control
;
1909 cval
->val_type
= valinfo
->val_type
;
1912 /* get min/max values */
1913 if (type
== UAC_PROCESS_UP_DOWNMIX
&& cval
->control
== UAC_UD_MODE_SELECT
) {
1914 __u8
*control_spec
= uac_processing_unit_specific(desc
, state
->mixer
->protocol
);
1915 /* FIXME: hard-coded */
1917 cval
->max
= control_spec
[0];
1919 cval
->initialized
= 1;
1921 if (type
== USB_XU_CLOCK_RATE
) {
1923 * E-Mu USB 0404/0202/TrackerPre/0204
1924 * samplerate control quirk
1929 cval
->initialized
= 1;
1931 get_min_max(cval
, valinfo
->min_value
);
1934 kctl
= snd_ctl_new1(&mixer_procunit_ctl
, cval
);
1939 kctl
->private_free
= snd_usb_mixer_elem_free
;
1941 if (check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
))) {
1943 } else if (info
->name
) {
1944 strlcpy(kctl
->id
.name
, info
->name
, sizeof(kctl
->id
.name
));
1946 nameid
= uac_processing_unit_iProcessing(desc
, state
->mixer
->protocol
);
1949 len
= snd_usb_copy_string_desc(state
, nameid
,
1951 sizeof(kctl
->id
.name
));
1953 strlcpy(kctl
->id
.name
, name
, sizeof(kctl
->id
.name
));
1955 append_ctl_name(kctl
, " ");
1956 append_ctl_name(kctl
, valinfo
->suffix
);
1958 usb_audio_dbg(state
->chip
,
1959 "[%d] PU [%s] ch = %d, val = %d/%d\n",
1960 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1961 cval
->min
, cval
->max
);
1963 err
= snd_usb_mixer_add_control(&cval
->head
, kctl
);
1970 static int parse_audio_processing_unit(struct mixer_build
*state
, int unitid
,
1973 return build_audio_procunit(state
, unitid
, raw_desc
,
1974 procunits
, "Processing Unit");
1977 static int parse_audio_extension_unit(struct mixer_build
*state
, int unitid
,
1981 * Note that we parse extension units with processing unit descriptors.
1982 * That's ok as the layout is the same.
1984 return build_audio_procunit(state
, unitid
, raw_desc
,
1985 extunits
, "Extension Unit");
1993 * info callback for selector unit
1994 * use an enumerator type for routing
1996 static int mixer_ctl_selector_info(struct snd_kcontrol
*kcontrol
,
1997 struct snd_ctl_elem_info
*uinfo
)
1999 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2000 const char **itemlist
= (const char **)kcontrol
->private_value
;
2002 if (snd_BUG_ON(!itemlist
))
2004 return snd_ctl_enum_info(uinfo
, 1, cval
->max
, itemlist
);
2007 /* get callback for selector unit */
2008 static int mixer_ctl_selector_get(struct snd_kcontrol
*kcontrol
,
2009 struct snd_ctl_elem_value
*ucontrol
)
2011 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2014 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
2016 ucontrol
->value
.enumerated
.item
[0] = 0;
2017 return filter_error(cval
, err
);
2019 val
= get_relative_value(cval
, val
);
2020 ucontrol
->value
.enumerated
.item
[0] = val
;
2024 /* put callback for selector unit */
2025 static int mixer_ctl_selector_put(struct snd_kcontrol
*kcontrol
,
2026 struct snd_ctl_elem_value
*ucontrol
)
2028 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2031 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
2033 return filter_error(cval
, err
);
2034 val
= ucontrol
->value
.enumerated
.item
[0];
2035 val
= get_abs_value(cval
, val
);
2037 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
2043 /* alsa control interface for selector unit */
2044 static const struct snd_kcontrol_new mixer_selectunit_ctl
= {
2045 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
2046 .name
= "", /* will be filled later */
2047 .info
= mixer_ctl_selector_info
,
2048 .get
= mixer_ctl_selector_get
,
2049 .put
= mixer_ctl_selector_put
,
2053 * private free callback.
2054 * free both private_data and private_value
2056 static void usb_mixer_selector_elem_free(struct snd_kcontrol
*kctl
)
2060 if (kctl
->private_data
) {
2061 struct usb_mixer_elem_info
*cval
= kctl
->private_data
;
2062 num_ins
= cval
->max
;
2064 kctl
->private_data
= NULL
;
2066 if (kctl
->private_value
) {
2067 char **itemlist
= (char **)kctl
->private_value
;
2068 for (i
= 0; i
< num_ins
; i
++)
2071 kctl
->private_value
= 0;
2076 * parse a selector unit
2078 static int parse_audio_selector_unit(struct mixer_build
*state
, int unitid
,
2081 struct uac_selector_unit_descriptor
*desc
= raw_desc
;
2082 unsigned int i
, nameid
, len
;
2084 struct usb_mixer_elem_info
*cval
;
2085 struct snd_kcontrol
*kctl
;
2086 const struct usbmix_name_map
*map
;
2089 if (!desc
->bNrInPins
|| desc
->bLength
< 5 + desc
->bNrInPins
) {
2090 usb_audio_err(state
->chip
,
2091 "invalid SELECTOR UNIT descriptor %d\n", unitid
);
2095 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
2096 if ((err
= parse_audio_unit(state
, desc
->baSourceID
[i
])) < 0)
2100 if (desc
->bNrInPins
== 1) /* only one ? nonsense! */
2103 map
= find_map(state
, unitid
, 0);
2104 if (check_ignored_ctl(map
))
2107 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
2110 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
2111 cval
->val_type
= USB_MIXER_U8
;
2114 cval
->max
= desc
->bNrInPins
;
2116 cval
->initialized
= 1;
2118 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2120 else /* UAC_VERSION_2 */
2121 cval
->control
= (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
) ?
2122 UAC2_CX_CLOCK_SELECTOR
: UAC2_SU_SELECTOR
;
2124 namelist
= kmalloc(sizeof(char *) * desc
->bNrInPins
, GFP_KERNEL
);
2129 #define MAX_ITEM_NAME_LEN 64
2130 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
2131 struct usb_audio_term iterm
;
2133 namelist
[i
] = kmalloc(MAX_ITEM_NAME_LEN
, GFP_KERNEL
);
2141 len
= check_mapped_selector_name(state
, unitid
, i
, namelist
[i
],
2143 if (! len
&& check_input_term(state
, desc
->baSourceID
[i
], &iterm
) >= 0)
2144 len
= get_term_name(state
, &iterm
, namelist
[i
], MAX_ITEM_NAME_LEN
, 0);
2146 sprintf(namelist
[i
], "Input %u", i
);
2149 kctl
= snd_ctl_new1(&mixer_selectunit_ctl
, cval
);
2151 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
2156 kctl
->private_value
= (unsigned long)namelist
;
2157 kctl
->private_free
= usb_mixer_selector_elem_free
;
2159 nameid
= uac_selector_unit_iSelector(desc
);
2160 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
2164 snd_usb_copy_string_desc(state
, nameid
, kctl
->id
.name
,
2165 sizeof(kctl
->id
.name
));
2167 len
= get_term_name(state
, &state
->oterm
,
2168 kctl
->id
.name
, sizeof(kctl
->id
.name
), 0);
2170 strlcpy(kctl
->id
.name
, "USB", sizeof(kctl
->id
.name
));
2172 if (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
)
2173 append_ctl_name(kctl
, " Clock Source");
2174 else if ((state
->oterm
.type
& 0xff00) == 0x0100)
2175 append_ctl_name(kctl
, " Capture Source");
2177 append_ctl_name(kctl
, " Playback Source");
2180 usb_audio_dbg(state
->chip
, "[%d] SU [%s] items = %d\n",
2181 cval
->head
.id
, kctl
->id
.name
, desc
->bNrInPins
);
2182 return snd_usb_mixer_add_control(&cval
->head
, kctl
);
2186 * parse an audio unit recursively
2189 static int parse_audio_unit(struct mixer_build
*state
, int unitid
)
2193 if (test_and_set_bit(unitid
, state
->unitbitmap
))
2194 return 0; /* the unit already visited */
2196 p1
= find_audio_control_unit(state
, unitid
);
2198 usb_audio_err(state
->chip
, "unit %d not found!\n", unitid
);
2203 case UAC_INPUT_TERMINAL
:
2205 case UAC_MIXER_UNIT
:
2206 return parse_audio_mixer_unit(state
, unitid
, p1
);
2207 case UAC2_CLOCK_SOURCE
:
2208 return parse_clock_source_unit(state
, unitid
, p1
);
2209 case UAC_SELECTOR_UNIT
:
2210 case UAC2_CLOCK_SELECTOR
:
2211 return parse_audio_selector_unit(state
, unitid
, p1
);
2212 case UAC_FEATURE_UNIT
:
2213 return parse_audio_feature_unit(state
, unitid
, p1
);
2214 case UAC1_PROCESSING_UNIT
:
2215 /* UAC2_EFFECT_UNIT has the same value */
2216 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2217 return parse_audio_processing_unit(state
, unitid
, p1
);
2219 return 0; /* FIXME - effect units not implemented yet */
2220 case UAC1_EXTENSION_UNIT
:
2221 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2222 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2223 return parse_audio_extension_unit(state
, unitid
, p1
);
2224 else /* UAC_VERSION_2 */
2225 return parse_audio_processing_unit(state
, unitid
, p1
);
2226 case UAC2_EXTENSION_UNIT_V2
:
2227 return parse_audio_extension_unit(state
, unitid
, p1
);
2229 usb_audio_err(state
->chip
,
2230 "unit %u: unexpected type 0x%02x\n", unitid
, p1
[2]);
2235 static void snd_usb_mixer_free(struct usb_mixer_interface
*mixer
)
2237 kfree(mixer
->id_elems
);
2239 kfree(mixer
->urb
->transfer_buffer
);
2240 usb_free_urb(mixer
->urb
);
2242 usb_free_urb(mixer
->rc_urb
);
2243 kfree(mixer
->rc_setup_packet
);
2247 static int snd_usb_mixer_dev_free(struct snd_device
*device
)
2249 struct usb_mixer_interface
*mixer
= device
->device_data
;
2250 snd_usb_mixer_free(mixer
);
2255 * create mixer controls
2257 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2259 static int snd_usb_mixer_controls(struct usb_mixer_interface
*mixer
)
2261 struct mixer_build state
;
2263 const struct usbmix_ctl_map
*map
;
2266 memset(&state
, 0, sizeof(state
));
2267 state
.chip
= mixer
->chip
;
2268 state
.mixer
= mixer
;
2269 state
.buffer
= mixer
->hostif
->extra
;
2270 state
.buflen
= mixer
->hostif
->extralen
;
2272 /* check the mapping table */
2273 for (map
= usbmix_ctl_maps
; map
->id
; map
++) {
2274 if (map
->id
== state
.chip
->usb_id
) {
2275 state
.map
= map
->map
;
2276 state
.selector_map
= map
->selector_map
;
2277 mixer
->ignore_ctl_error
= map
->ignore_ctl_error
;
2283 while ((p
= snd_usb_find_csint_desc(mixer
->hostif
->extra
,
2284 mixer
->hostif
->extralen
,
2285 p
, UAC_OUTPUT_TERMINAL
)) != NULL
) {
2286 if (mixer
->protocol
== UAC_VERSION_1
) {
2287 struct uac1_output_terminal_descriptor
*desc
= p
;
2289 if (desc
->bLength
< sizeof(*desc
))
2290 continue; /* invalid descriptor? */
2291 /* mark terminal ID as visited */
2292 set_bit(desc
->bTerminalID
, state
.unitbitmap
);
2293 state
.oterm
.id
= desc
->bTerminalID
;
2294 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
2295 state
.oterm
.name
= desc
->iTerminal
;
2296 err
= parse_audio_unit(&state
, desc
->bSourceID
);
2297 if (err
< 0 && err
!= -EINVAL
)
2299 } else { /* UAC_VERSION_2 */
2300 struct uac2_output_terminal_descriptor
*desc
= p
;
2302 if (desc
->bLength
< sizeof(*desc
))
2303 continue; /* invalid descriptor? */
2304 /* mark terminal ID as visited */
2305 set_bit(desc
->bTerminalID
, state
.unitbitmap
);
2306 state
.oterm
.id
= desc
->bTerminalID
;
2307 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
2308 state
.oterm
.name
= desc
->iTerminal
;
2309 err
= parse_audio_unit(&state
, desc
->bSourceID
);
2310 if (err
< 0 && err
!= -EINVAL
)
2314 * For UAC2, use the same approach to also add the
2317 err
= parse_audio_unit(&state
, desc
->bCSourceID
);
2318 if (err
< 0 && err
!= -EINVAL
)
2326 void snd_usb_mixer_notify_id(struct usb_mixer_interface
*mixer
, int unitid
)
2328 struct usb_mixer_elem_list
*list
;
2330 for (list
= mixer
->id_elems
[unitid
]; list
; list
= list
->next_id_elem
)
2331 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
2335 static void snd_usb_mixer_dump_cval(struct snd_info_buffer
*buffer
,
2336 struct usb_mixer_elem_list
*list
)
2338 struct usb_mixer_elem_info
*cval
= (struct usb_mixer_elem_info
*)list
;
2339 static char *val_types
[] = {"BOOLEAN", "INV_BOOLEAN",
2340 "S8", "U8", "S16", "U16"};
2341 snd_iprintf(buffer
, " Info: id=%i, control=%i, cmask=0x%x, "
2342 "channels=%i, type=\"%s\"\n", cval
->head
.id
,
2343 cval
->control
, cval
->cmask
, cval
->channels
,
2344 val_types
[cval
->val_type
]);
2345 snd_iprintf(buffer
, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2346 cval
->min
, cval
->max
, cval
->dBmin
, cval
->dBmax
);
2349 static void snd_usb_mixer_proc_read(struct snd_info_entry
*entry
,
2350 struct snd_info_buffer
*buffer
)
2352 struct snd_usb_audio
*chip
= entry
->private_data
;
2353 struct usb_mixer_interface
*mixer
;
2354 struct usb_mixer_elem_list
*list
;
2357 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
2359 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2360 chip
->usb_id
, snd_usb_ctrl_intf(chip
),
2361 mixer
->ignore_ctl_error
);
2362 snd_iprintf(buffer
, "Card: %s\n", chip
->card
->longname
);
2363 for (unitid
= 0; unitid
< MAX_ID_ELEMS
; unitid
++) {
2364 for (list
= mixer
->id_elems
[unitid
]; list
;
2365 list
= list
->next_id_elem
) {
2366 snd_iprintf(buffer
, " Unit: %i\n", list
->id
);
2369 " Control: name=\"%s\", index=%i\n",
2370 list
->kctl
->id
.name
,
2371 list
->kctl
->id
.index
);
2373 list
->dump(buffer
, list
);
2379 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface
*mixer
,
2380 int attribute
, int value
, int index
)
2382 struct usb_mixer_elem_list
*list
;
2383 __u8 unitid
= (index
>> 8) & 0xff;
2384 __u8 control
= (value
>> 8) & 0xff;
2385 __u8 channel
= value
& 0xff;
2386 unsigned int count
= 0;
2388 if (channel
>= MAX_CHANNELS
) {
2389 usb_audio_dbg(mixer
->chip
,
2390 "%s(): bogus channel number %d\n",
2395 for (list
= mixer
->id_elems
[unitid
]; list
; list
= list
->next_id_elem
)
2401 for (list
= mixer
->id_elems
[unitid
]; list
; list
= list
->next_id_elem
) {
2402 struct usb_mixer_elem_info
*info
;
2407 info
= (struct usb_mixer_elem_info
*)list
;
2408 if (count
> 1 && info
->control
!= control
)
2411 switch (attribute
) {
2413 /* invalidate cache, so the value is read from the device */
2415 info
->cached
&= ~(1 << channel
);
2416 else /* master channel */
2419 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
2420 &info
->head
.kctl
->id
);
2432 usb_audio_dbg(mixer
->chip
,
2433 "unknown attribute %d in interrupt\n",
2440 static void snd_usb_mixer_interrupt(struct urb
*urb
)
2442 struct usb_mixer_interface
*mixer
= urb
->context
;
2443 int len
= urb
->actual_length
;
2444 int ustatus
= urb
->status
;
2449 if (mixer
->protocol
== UAC_VERSION_1
) {
2450 struct uac1_status_word
*status
;
2452 for (status
= urb
->transfer_buffer
;
2453 len
>= sizeof(*status
);
2454 len
-= sizeof(*status
), status
++) {
2455 dev_dbg(&urb
->dev
->dev
, "status interrupt: %02x %02x\n",
2456 status
->bStatusType
,
2457 status
->bOriginator
);
2459 /* ignore any notifications not from the control interface */
2460 if ((status
->bStatusType
& UAC1_STATUS_TYPE_ORIG_MASK
) !=
2461 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF
)
2464 if (status
->bStatusType
& UAC1_STATUS_TYPE_MEM_CHANGED
)
2465 snd_usb_mixer_rc_memory_change(mixer
, status
->bOriginator
);
2467 snd_usb_mixer_notify_id(mixer
, status
->bOriginator
);
2469 } else { /* UAC_VERSION_2 */
2470 struct uac2_interrupt_data_msg
*msg
;
2472 for (msg
= urb
->transfer_buffer
;
2473 len
>= sizeof(*msg
);
2474 len
-= sizeof(*msg
), msg
++) {
2475 /* drop vendor specific and endpoint requests */
2476 if ((msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_VENDOR
) ||
2477 (msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_EP
))
2480 snd_usb_mixer_interrupt_v2(mixer
, msg
->bAttribute
,
2481 le16_to_cpu(msg
->wValue
),
2482 le16_to_cpu(msg
->wIndex
));
2487 if (ustatus
!= -ENOENT
&&
2488 ustatus
!= -ECONNRESET
&&
2489 ustatus
!= -ESHUTDOWN
) {
2490 urb
->dev
= mixer
->chip
->dev
;
2491 usb_submit_urb(urb
, GFP_ATOMIC
);
2495 /* create the handler for the optional status interrupt endpoint */
2496 static int snd_usb_mixer_status_create(struct usb_mixer_interface
*mixer
)
2498 struct usb_endpoint_descriptor
*ep
;
2499 void *transfer_buffer
;
2503 /* we need one interrupt input endpoint */
2504 if (get_iface_desc(mixer
->hostif
)->bNumEndpoints
< 1)
2506 ep
= get_endpoint(mixer
->hostif
, 0);
2507 if (!usb_endpoint_dir_in(ep
) || !usb_endpoint_xfer_int(ep
))
2510 epnum
= usb_endpoint_num(ep
);
2511 buffer_length
= le16_to_cpu(ep
->wMaxPacketSize
);
2512 transfer_buffer
= kmalloc(buffer_length
, GFP_KERNEL
);
2513 if (!transfer_buffer
)
2515 mixer
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
2517 kfree(transfer_buffer
);
2520 usb_fill_int_urb(mixer
->urb
, mixer
->chip
->dev
,
2521 usb_rcvintpipe(mixer
->chip
->dev
, epnum
),
2522 transfer_buffer
, buffer_length
,
2523 snd_usb_mixer_interrupt
, mixer
, ep
->bInterval
);
2524 usb_submit_urb(mixer
->urb
, GFP_KERNEL
);
2528 int snd_usb_create_mixer(struct snd_usb_audio
*chip
, int ctrlif
,
2531 static struct snd_device_ops dev_ops
= {
2532 .dev_free
= snd_usb_mixer_dev_free
2534 struct usb_mixer_interface
*mixer
;
2535 struct snd_info_entry
*entry
;
2538 strcpy(chip
->card
->mixername
, "USB Mixer");
2540 mixer
= kzalloc(sizeof(*mixer
), GFP_KERNEL
);
2544 mixer
->ignore_ctl_error
= ignore_error
;
2545 mixer
->id_elems
= kcalloc(MAX_ID_ELEMS
, sizeof(*mixer
->id_elems
),
2547 if (!mixer
->id_elems
) {
2552 mixer
->hostif
= &usb_ifnum_to_if(chip
->dev
, ctrlif
)->altsetting
[0];
2553 switch (get_iface_desc(mixer
->hostif
)->bInterfaceProtocol
) {
2556 mixer
->protocol
= UAC_VERSION_1
;
2559 mixer
->protocol
= UAC_VERSION_2
;
2563 if ((err
= snd_usb_mixer_controls(mixer
)) < 0 ||
2564 (err
= snd_usb_mixer_status_create(mixer
)) < 0)
2567 snd_usb_mixer_apply_create_quirk(mixer
);
2569 err
= snd_device_new(chip
->card
, SNDRV_DEV_CODEC
, mixer
, &dev_ops
);
2573 if (list_empty(&chip
->mixer_list
) &&
2574 !snd_card_proc_new(chip
->card
, "usbmixer", &entry
))
2575 snd_info_set_text_ops(entry
, chip
, snd_usb_mixer_proc_read
);
2577 list_add(&mixer
->list
, &chip
->mixer_list
);
2581 snd_usb_mixer_free(mixer
);
2585 void snd_usb_mixer_disconnect(struct usb_mixer_interface
*mixer
)
2587 usb_kill_urb(mixer
->urb
);
2588 usb_kill_urb(mixer
->rc_urb
);
2592 /* stop any bus activity of a mixer */
2593 static void snd_usb_mixer_inactivate(struct usb_mixer_interface
*mixer
)
2595 usb_kill_urb(mixer
->urb
);
2596 usb_kill_urb(mixer
->rc_urb
);
2599 static int snd_usb_mixer_activate(struct usb_mixer_interface
*mixer
)
2604 err
= usb_submit_urb(mixer
->urb
, GFP_NOIO
);
2612 int snd_usb_mixer_suspend(struct usb_mixer_interface
*mixer
)
2614 snd_usb_mixer_inactivate(mixer
);
2618 static int restore_mixer_value(struct usb_mixer_elem_list
*list
)
2620 struct usb_mixer_elem_info
*cval
= (struct usb_mixer_elem_info
*)list
;
2625 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
2626 if (!(cval
->cmask
& (1 << c
)))
2628 if (cval
->cached
& (1 << (c
+ 1))) {
2629 err
= snd_usb_set_cur_mix_value(cval
, c
+ 1, idx
,
2630 cval
->cache_val
[idx
]);
2639 err
= snd_usb_set_cur_mix_value(cval
, 0, 0, *cval
->cache_val
);
2648 int snd_usb_mixer_resume(struct usb_mixer_interface
*mixer
, bool reset_resume
)
2650 struct usb_mixer_elem_list
*list
;
2654 /* restore cached mixer values */
2655 for (id
= 0; id
< MAX_ID_ELEMS
; id
++) {
2656 for (list
= mixer
->id_elems
[id
]; list
;
2657 list
= list
->next_id_elem
) {
2659 err
= list
->resume(list
);
2667 return snd_usb_mixer_activate(mixer
);
2671 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list
*list
,
2672 struct usb_mixer_interface
*mixer
,
2675 list
->mixer
= mixer
;
2677 list
->dump
= snd_usb_mixer_dump_cval
;
2679 list
->resume
= restore_mixer_value
;