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);
216 * convert from the byte/word on usb descriptor to the zero-based integer
218 static int convert_signed_value(struct usb_mixer_elem_info
*cval
, int val
)
220 switch (cval
->val_type
) {
221 case USB_MIXER_BOOLEAN
:
223 case USB_MIXER_INV_BOOLEAN
:
246 * convert from the zero-based int to the byte/word for usb descriptor
248 static int convert_bytes_value(struct usb_mixer_elem_info
*cval
, int val
)
250 switch (cval
->val_type
) {
251 case USB_MIXER_BOOLEAN
:
253 case USB_MIXER_INV_BOOLEAN
:
262 return 0; /* not reached */
265 static int get_relative_value(struct usb_mixer_elem_info
*cval
, int val
)
271 else if (val
>= cval
->max
)
272 return (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
274 return (val
- cval
->min
) / cval
->res
;
277 static int get_abs_value(struct usb_mixer_elem_info
*cval
, int val
)
290 static int uac2_ctl_value_size(int val_type
)
302 return 0; /* unreachable */
307 * retrieve a mixer value
310 static int get_ctl_value_v1(struct usb_mixer_elem_info
*cval
, int request
,
311 int validx
, int *value_ret
)
313 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
314 unsigned char buf
[2];
315 int val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
319 err
= snd_usb_lock_shutdown(chip
);
323 while (timeout
-- > 0) {
324 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
325 err
= snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), request
,
326 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
327 validx
, idx
, buf
, val_len
);
328 if (err
>= val_len
) {
329 *value_ret
= convert_signed_value(cval
, snd_usb_combine_bytes(buf
, val_len
));
332 } else if (err
== -ETIMEDOUT
) {
337 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
338 request
, validx
, idx
, cval
->val_type
);
342 snd_usb_unlock_shutdown(chip
);
346 static int get_ctl_value_v2(struct usb_mixer_elem_info
*cval
, int request
,
347 int validx
, int *value_ret
)
349 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
350 /* enough space for one range */
351 unsigned char buf
[sizeof(__u16
) + 3 * sizeof(__u32
)];
353 int idx
= 0, ret
, val_size
, size
;
356 val_size
= uac2_ctl_value_size(cval
->val_type
);
358 if (request
== UAC_GET_CUR
) {
359 bRequest
= UAC2_CS_CUR
;
362 bRequest
= UAC2_CS_RANGE
;
363 size
= sizeof(__u16
) + 3 * val_size
;
366 memset(buf
, 0, sizeof(buf
));
368 ret
= snd_usb_lock_shutdown(chip
) ? -EIO
: 0;
372 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
373 ret
= snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), bRequest
,
374 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
375 validx
, idx
, buf
, size
);
376 snd_usb_unlock_shutdown(chip
);
381 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
382 request
, validx
, idx
, cval
->val_type
);
386 /* FIXME: how should we handle multiple triplets here? */
393 val
= buf
+ sizeof(__u16
);
396 val
= buf
+ sizeof(__u16
) + val_size
;
399 val
= buf
+ sizeof(__u16
) + val_size
* 2;
405 *value_ret
= convert_signed_value(cval
,
406 snd_usb_combine_bytes(val
, val_size
));
411 static int get_ctl_value(struct usb_mixer_elem_info
*cval
, int request
,
412 int validx
, int *value_ret
)
414 validx
+= cval
->idx_off
;
416 return (cval
->head
.mixer
->protocol
== UAC_VERSION_1
) ?
417 get_ctl_value_v1(cval
, request
, validx
, value_ret
) :
418 get_ctl_value_v2(cval
, request
, validx
, value_ret
);
421 static int get_cur_ctl_value(struct usb_mixer_elem_info
*cval
,
422 int validx
, int *value
)
424 return get_ctl_value(cval
, UAC_GET_CUR
, validx
, value
);
427 /* channel = 0: master, 1 = first channel */
428 static inline int get_cur_mix_raw(struct usb_mixer_elem_info
*cval
,
429 int channel
, int *value
)
431 return get_ctl_value(cval
, UAC_GET_CUR
,
432 (cval
->control
<< 8) | channel
,
436 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info
*cval
,
437 int channel
, int index
, int *value
)
441 if (cval
->cached
& (1 << channel
)) {
442 *value
= cval
->cache_val
[index
];
445 err
= get_cur_mix_raw(cval
, channel
, value
);
447 if (!cval
->head
.mixer
->ignore_ctl_error
)
448 usb_audio_dbg(cval
->head
.mixer
->chip
,
449 "cannot get current value for control %d ch %d: err = %d\n",
450 cval
->control
, channel
, err
);
453 cval
->cached
|= 1 << channel
;
454 cval
->cache_val
[index
] = *value
;
462 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info
*cval
,
463 int request
, int validx
, int value_set
)
465 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
466 unsigned char buf
[4];
467 int idx
= 0, val_len
, err
, timeout
= 10;
469 validx
+= cval
->idx_off
;
471 if (cval
->head
.mixer
->protocol
== UAC_VERSION_1
) {
472 val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
473 } else { /* UAC_VERSION_2 */
474 val_len
= uac2_ctl_value_size(cval
->val_type
);
477 if (request
!= UAC_SET_CUR
) {
478 usb_audio_dbg(chip
, "RANGE setting not yet supported\n");
482 request
= UAC2_CS_CUR
;
485 value_set
= convert_bytes_value(cval
, value_set
);
486 buf
[0] = value_set
& 0xff;
487 buf
[1] = (value_set
>> 8) & 0xff;
488 buf
[2] = (value_set
>> 16) & 0xff;
489 buf
[3] = (value_set
>> 24) & 0xff;
491 err
= snd_usb_lock_shutdown(chip
);
495 while (timeout
-- > 0) {
496 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
497 err
= snd_usb_ctl_msg(chip
->dev
,
498 usb_sndctrlpipe(chip
->dev
, 0), request
,
499 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
500 validx
, idx
, buf
, val_len
);
504 } else if (err
== -ETIMEDOUT
) {
508 usb_audio_dbg(chip
, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
509 request
, validx
, idx
, cval
->val_type
, buf
[0], buf
[1]);
513 snd_usb_unlock_shutdown(chip
);
517 static int set_cur_ctl_value(struct usb_mixer_elem_info
*cval
,
518 int validx
, int value
)
520 return snd_usb_mixer_set_ctl_value(cval
, UAC_SET_CUR
, validx
, value
);
523 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info
*cval
, int channel
,
524 int index
, int value
)
527 unsigned int read_only
= (channel
== 0) ?
528 cval
->master_readonly
:
529 cval
->ch_readonly
& (1 << (channel
- 1));
532 usb_audio_dbg(cval
->head
.mixer
->chip
,
533 "%s(): channel %d of control %d is read_only\n",
534 __func__
, channel
, cval
->control
);
538 err
= snd_usb_mixer_set_ctl_value(cval
,
539 UAC_SET_CUR
, (cval
->control
<< 8) | channel
,
543 cval
->cached
|= 1 << channel
;
544 cval
->cache_val
[index
] = value
;
549 * TLV callback for mixer volume controls
551 int snd_usb_mixer_vol_tlv(struct snd_kcontrol
*kcontrol
, int op_flag
,
552 unsigned int size
, unsigned int __user
*_tlv
)
554 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
555 DECLARE_TLV_DB_MINMAX(scale
, 0, 0);
557 if (size
< sizeof(scale
))
560 scale
[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE
;
561 scale
[2] = cval
->dBmin
;
562 scale
[3] = cval
->dBmax
;
563 if (copy_to_user(_tlv
, scale
, sizeof(scale
)))
569 * parser routines begin here...
572 static int parse_audio_unit(struct mixer_build
*state
, int unitid
);
576 * check if the input/output channel routing is enabled on the given bitmap.
577 * used for mixer unit parser
579 static int check_matrix_bitmap(unsigned char *bmap
,
580 int ich
, int och
, int num_outs
)
582 int idx
= ich
* num_outs
+ och
;
583 return bmap
[idx
>> 3] & (0x80 >> (idx
& 7));
587 * add an alsa control element
588 * search and increment the index until an empty slot is found.
590 * if failed, give up and free the control instance.
593 int snd_usb_mixer_add_control(struct usb_mixer_elem_list
*list
,
594 struct snd_kcontrol
*kctl
)
596 struct usb_mixer_interface
*mixer
= list
->mixer
;
599 while (snd_ctl_find_id(mixer
->chip
->card
, &kctl
->id
))
601 if ((err
= snd_ctl_add(mixer
->chip
->card
, kctl
)) < 0) {
602 usb_audio_dbg(mixer
->chip
, "cannot add control (err = %d)\n",
607 list
->next_id_elem
= mixer
->id_elems
[list
->id
];
608 mixer
->id_elems
[list
->id
] = list
;
613 * get a terminal name string
616 static struct iterm_name_combo
{
620 { 0x0300, "Output" },
621 { 0x0301, "Speaker" },
622 { 0x0302, "Headphone" },
623 { 0x0303, "HMD Audio" },
624 { 0x0304, "Desktop Speaker" },
625 { 0x0305, "Room Speaker" },
626 { 0x0306, "Com Speaker" },
628 { 0x0600, "External In" },
629 { 0x0601, "Analog In" },
630 { 0x0602, "Digital In" },
632 { 0x0604, "Legacy In" },
633 { 0x0605, "IEC958 In" },
634 { 0x0606, "1394 DA Stream" },
635 { 0x0607, "1394 DV Stream" },
636 { 0x0700, "Embedded" },
637 { 0x0701, "Noise Source" },
638 { 0x0702, "Equalization Noise" },
642 { 0x0706, "MiniDisk" },
643 { 0x0707, "Analog Tape" },
644 { 0x0708, "Phonograph" },
645 { 0x0709, "VCR Audio" },
646 { 0x070a, "Video Disk Audio" },
647 { 0x070b, "DVD Audio" },
648 { 0x070c, "TV Tuner Audio" },
649 { 0x070d, "Satellite Rec Audio" },
650 { 0x070e, "Cable Tuner Audio" },
651 { 0x070f, "DSS Audio" },
652 { 0x0710, "Radio Receiver" },
653 { 0x0711, "Radio Transmitter" },
654 { 0x0712, "Multi-Track Recorder" },
655 { 0x0713, "Synthesizer" },
659 static int get_term_name(struct mixer_build
*state
, struct usb_audio_term
*iterm
,
660 unsigned char *name
, int maxlen
, int term_only
)
662 struct iterm_name_combo
*names
;
665 return snd_usb_copy_string_desc(state
, iterm
->name
,
668 /* virtual type - not a real terminal */
669 if (iterm
->type
>> 16) {
672 switch (iterm
->type
>> 16) {
673 case UAC_SELECTOR_UNIT
:
674 strcpy(name
, "Selector");
676 case UAC1_PROCESSING_UNIT
:
677 strcpy(name
, "Process Unit");
679 case UAC1_EXTENSION_UNIT
:
680 strcpy(name
, "Ext Unit");
683 strcpy(name
, "Mixer");
686 return sprintf(name
, "Unit %d", iterm
->id
);
690 switch (iterm
->type
& 0xff00) {
698 strcpy(name
, "Headset");
701 strcpy(name
, "Phone");
705 for (names
= iterm_names
; names
->type
; names
++) {
706 if (names
->type
== iterm
->type
) {
707 strcpy(name
, names
->name
);
708 return strlen(names
->name
);
716 * parse the source unit recursively until it reaches to a terminal
717 * or a branched unit.
719 static int check_input_term(struct mixer_build
*state
, int id
,
720 struct usb_audio_term
*term
)
725 memset(term
, 0, sizeof(*term
));
726 while ((p1
= find_audio_control_unit(state
, id
)) != NULL
) {
727 unsigned char *hdr
= p1
;
730 case UAC_INPUT_TERMINAL
:
731 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
732 struct uac_input_terminal_descriptor
*d
= p1
;
733 term
->type
= le16_to_cpu(d
->wTerminalType
);
734 term
->channels
= d
->bNrChannels
;
735 term
->chconfig
= le16_to_cpu(d
->wChannelConfig
);
736 term
->name
= d
->iTerminal
;
737 } else { /* UAC_VERSION_2 */
738 struct uac2_input_terminal_descriptor
*d
= p1
;
740 /* call recursively to verify that the
741 * referenced clock entity is valid */
742 err
= check_input_term(state
, d
->bCSourceID
, term
);
746 /* save input term properties after recursion,
747 * to ensure they are not overriden by the
750 term
->type
= le16_to_cpu(d
->wTerminalType
);
751 term
->channels
= d
->bNrChannels
;
752 term
->chconfig
= le32_to_cpu(d
->bmChannelConfig
);
753 term
->name
= d
->iTerminal
;
756 case UAC_FEATURE_UNIT
: {
757 /* the header is the same for v1 and v2 */
758 struct uac_feature_unit_descriptor
*d
= p1
;
760 break; /* continue to parse */
762 case UAC_MIXER_UNIT
: {
763 struct uac_mixer_unit_descriptor
*d
= p1
;
764 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
765 term
->channels
= uac_mixer_unit_bNrChannels(d
);
766 term
->chconfig
= uac_mixer_unit_wChannelConfig(d
, state
->mixer
->protocol
);
767 term
->name
= uac_mixer_unit_iMixer(d
);
770 case UAC_SELECTOR_UNIT
:
771 case UAC2_CLOCK_SELECTOR
: {
772 struct uac_selector_unit_descriptor
*d
= p1
;
773 /* call recursively to retrieve the channel info */
774 err
= check_input_term(state
, d
->baSourceID
[0], term
);
777 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
779 term
->name
= uac_selector_unit_iSelector(d
);
782 case UAC1_PROCESSING_UNIT
:
783 case UAC1_EXTENSION_UNIT
:
784 /* UAC2_PROCESSING_UNIT_V2 */
785 /* UAC2_EFFECT_UNIT */
786 case UAC2_EXTENSION_UNIT_V2
: {
787 struct uac_processing_unit_descriptor
*d
= p1
;
789 if (state
->mixer
->protocol
== UAC_VERSION_2
&&
790 hdr
[2] == UAC2_EFFECT_UNIT
) {
791 /* UAC2/UAC1 unit IDs overlap here in an
792 * uncompatible way. Ignore this unit for now.
798 id
= d
->baSourceID
[0];
799 break; /* continue to parse */
801 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
802 term
->channels
= uac_processing_unit_bNrChannels(d
);
803 term
->chconfig
= uac_processing_unit_wChannelConfig(d
, state
->mixer
->protocol
);
804 term
->name
= uac_processing_unit_iProcessing(d
, state
->mixer
->protocol
);
807 case UAC2_CLOCK_SOURCE
: {
808 struct uac_clock_source_descriptor
*d
= p1
;
809 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
811 term
->name
= d
->iClockSource
;
825 /* feature unit control information */
826 struct usb_feature_control_info
{
828 int type
; /* data type for uac1 */
829 int type_uac2
; /* data type for uac2 if different from uac1, else -1 */
832 static struct usb_feature_control_info audio_feature_info
[] = {
833 { "Mute", USB_MIXER_INV_BOOLEAN
, -1 },
834 { "Volume", USB_MIXER_S16
, -1 },
835 { "Tone Control - Bass", USB_MIXER_S8
, -1 },
836 { "Tone Control - Mid", USB_MIXER_S8
, -1 },
837 { "Tone Control - Treble", USB_MIXER_S8
, -1 },
838 { "Graphic Equalizer", USB_MIXER_S8
, -1 }, /* FIXME: not implemeted yet */
839 { "Auto Gain Control", USB_MIXER_BOOLEAN
, -1 },
840 { "Delay Control", USB_MIXER_U16
, USB_MIXER_U32
},
841 { "Bass Boost", USB_MIXER_BOOLEAN
, -1 },
842 { "Loudness", USB_MIXER_BOOLEAN
, -1 },
844 { "Input Gain Control", USB_MIXER_S16
, -1 },
845 { "Input Gain Pad Control", USB_MIXER_S16
, -1 },
846 { "Phase Inverter Control", USB_MIXER_BOOLEAN
, -1 },
849 /* private_free callback */
850 void snd_usb_mixer_elem_free(struct snd_kcontrol
*kctl
)
852 kfree(kctl
->private_data
);
853 kctl
->private_data
= NULL
;
857 * interface to ALSA control for feature/mixer units
860 /* volume control quirks */
861 static void volume_control_quirks(struct usb_mixer_elem_info
*cval
,
862 struct snd_kcontrol
*kctl
)
864 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
865 switch (chip
->usb_id
) {
866 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
867 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
868 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
874 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
875 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
880 if (strstr(kctl
->id
.name
, "Effect Return") != NULL
) {
886 if ((strstr(kctl
->id
.name
, "Playback Volume") != NULL
) ||
887 (strstr(kctl
->id
.name
, "Effect Send") != NULL
)) {
888 cval
->min
= 0xb5fb; /* -73 dB = 0xb6ff */
894 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
895 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
896 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
898 "set quirk for FTU Effect Duration\n");
904 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
905 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
907 "set quirks for FTU Effect Feedback/Volume\n");
914 case USB_ID(0x0d8c, 0x0103):
915 if (!strcmp(kctl
->id
.name
, "PCM Playback Volume")) {
917 "set volume quirk for CM102-A+/102S+\n");
922 case USB_ID(0x0471, 0x0101):
923 case USB_ID(0x0471, 0x0104):
924 case USB_ID(0x0471, 0x0105):
925 case USB_ID(0x0672, 0x1041):
926 /* quirk for UDA1321/N101.
927 * note that detection between firmware 2.1.1.7 (N101)
928 * and later 2.1.1.21 is not very clear from datasheets.
929 * I hope that the min value is -15360 for newer firmware --jk
931 if (!strcmp(kctl
->id
.name
, "PCM Playback Volume") &&
932 cval
->min
== -15616) {
934 "set volume quirk for UDA1321/N101 chip\n");
939 case USB_ID(0x046d, 0x09a4):
940 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
942 "set volume quirk for QuickCam E3500\n");
949 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
950 case USB_ID(0x046d, 0x0808):
951 case USB_ID(0x046d, 0x0809):
952 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
953 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
954 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
955 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
956 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
957 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
958 case USB_ID(0x046d, 0x0991):
959 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
960 /* Most audio usb devices lie about volume resolution.
961 * Most Logitech webcams have res = 384.
962 * Probably there is some logitech magic behind this number --fishor
964 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
966 "set resolution quirk: cval->res = 384\n");
974 * retrieve the minimum and maximum values for the specified control
976 static int get_min_max_with_quirks(struct usb_mixer_elem_info
*cval
,
977 int default_min
, struct snd_kcontrol
*kctl
)
980 cval
->min
= default_min
;
981 cval
->max
= cval
->min
+ 1;
983 cval
->dBmin
= cval
->dBmax
= 0;
985 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
986 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
987 cval
->initialized
= 1;
992 for (i
= 0; i
< MAX_CHANNELS
; i
++)
993 if (cval
->cmask
& (1 << i
)) {
998 if (get_ctl_value(cval
, UAC_GET_MAX
, (cval
->control
<< 8) | minchn
, &cval
->max
) < 0 ||
999 get_ctl_value(cval
, UAC_GET_MIN
, (cval
->control
<< 8) | minchn
, &cval
->min
) < 0) {
1000 usb_audio_err(cval
->head
.mixer
->chip
,
1001 "%d:%d: cannot get min/max values for control %d (id %d)\n",
1002 cval
->head
.id
, snd_usb_ctrl_intf(cval
->head
.mixer
->chip
),
1003 cval
->control
, cval
->head
.id
);
1006 if (get_ctl_value(cval
, UAC_GET_RES
,
1007 (cval
->control
<< 8) | minchn
,
1011 int last_valid_res
= cval
->res
;
1013 while (cval
->res
> 1) {
1014 if (snd_usb_mixer_set_ctl_value(cval
, UAC_SET_RES
,
1015 (cval
->control
<< 8) | minchn
,
1020 if (get_ctl_value(cval
, UAC_GET_RES
,
1021 (cval
->control
<< 8) | minchn
, &cval
->res
) < 0)
1022 cval
->res
= last_valid_res
;
1027 /* Additional checks for the proper resolution
1029 * Some devices report smaller resolutions than actually
1030 * reacting. They don't return errors but simply clip
1031 * to the lower aligned value.
1033 if (cval
->min
+ cval
->res
< cval
->max
) {
1034 int last_valid_res
= cval
->res
;
1035 int saved
, test
, check
;
1036 get_cur_mix_raw(cval
, minchn
, &saved
);
1039 if (test
< cval
->max
)
1043 if (test
< cval
->min
|| test
> cval
->max
||
1044 snd_usb_set_cur_mix_value(cval
, minchn
, 0, test
) ||
1045 get_cur_mix_raw(cval
, minchn
, &check
)) {
1046 cval
->res
= last_valid_res
;
1053 snd_usb_set_cur_mix_value(cval
, minchn
, 0, saved
);
1056 cval
->initialized
= 1;
1060 volume_control_quirks(cval
, kctl
);
1062 /* USB descriptions contain the dB scale in 1/256 dB unit
1063 * while ALSA TLV contains in 1/100 dB unit
1065 cval
->dBmin
= (convert_signed_value(cval
, cval
->min
) * 100) / 256;
1066 cval
->dBmax
= (convert_signed_value(cval
, cval
->max
) * 100) / 256;
1067 if (cval
->dBmin
> cval
->dBmax
) {
1068 /* something is wrong; assume it's either from/to 0dB */
1069 if (cval
->dBmin
< 0)
1071 else if (cval
->dBmin
> 0)
1073 if (cval
->dBmin
> cval
->dBmax
) {
1074 /* totally crap, return an error */
1082 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1084 /* get a feature/mixer unit info */
1085 static int mixer_ctl_feature_info(struct snd_kcontrol
*kcontrol
,
1086 struct snd_ctl_elem_info
*uinfo
)
1088 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1090 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1091 cval
->val_type
== USB_MIXER_INV_BOOLEAN
)
1092 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1094 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
1095 uinfo
->count
= cval
->channels
;
1096 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1097 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
1098 uinfo
->value
.integer
.min
= 0;
1099 uinfo
->value
.integer
.max
= 1;
1101 if (!cval
->initialized
) {
1102 get_min_max_with_quirks(cval
, 0, kcontrol
);
1103 if (cval
->initialized
&& cval
->dBmin
>= cval
->dBmax
) {
1104 kcontrol
->vd
[0].access
&=
1105 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1106 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
);
1107 snd_ctl_notify(cval
->head
.mixer
->chip
->card
,
1108 SNDRV_CTL_EVENT_MASK_INFO
,
1112 uinfo
->value
.integer
.min
= 0;
1113 uinfo
->value
.integer
.max
=
1114 (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
1119 /* get the current value from feature/mixer unit */
1120 static int mixer_ctl_feature_get(struct snd_kcontrol
*kcontrol
,
1121 struct snd_ctl_elem_value
*ucontrol
)
1123 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1124 int c
, cnt
, val
, err
;
1126 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1129 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1130 if (!(cval
->cmask
& (1 << c
)))
1132 err
= snd_usb_get_cur_mix_value(cval
, c
+ 1, cnt
, &val
);
1134 return filter_error(cval
, err
);
1135 val
= get_relative_value(cval
, val
);
1136 ucontrol
->value
.integer
.value
[cnt
] = val
;
1141 /* master channel */
1142 err
= snd_usb_get_cur_mix_value(cval
, 0, 0, &val
);
1144 return filter_error(cval
, err
);
1145 val
= get_relative_value(cval
, val
);
1146 ucontrol
->value
.integer
.value
[0] = val
;
1151 /* put the current value to feature/mixer unit */
1152 static int mixer_ctl_feature_put(struct snd_kcontrol
*kcontrol
,
1153 struct snd_ctl_elem_value
*ucontrol
)
1155 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1156 int c
, cnt
, val
, oval
, err
;
1161 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1162 if (!(cval
->cmask
& (1 << c
)))
1164 err
= snd_usb_get_cur_mix_value(cval
, c
+ 1, cnt
, &oval
);
1166 return filter_error(cval
, err
);
1167 val
= ucontrol
->value
.integer
.value
[cnt
];
1168 val
= get_abs_value(cval
, val
);
1170 snd_usb_set_cur_mix_value(cval
, c
+ 1, cnt
, val
);
1176 /* master channel */
1177 err
= snd_usb_get_cur_mix_value(cval
, 0, 0, &oval
);
1179 return filter_error(cval
, err
);
1180 val
= ucontrol
->value
.integer
.value
[0];
1181 val
= get_abs_value(cval
, val
);
1183 snd_usb_set_cur_mix_value(cval
, 0, 0, val
);
1190 static struct snd_kcontrol_new usb_feature_unit_ctl
= {
1191 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1192 .name
= "", /* will be filled later manually */
1193 .info
= mixer_ctl_feature_info
,
1194 .get
= mixer_ctl_feature_get
,
1195 .put
= mixer_ctl_feature_put
,
1198 /* the read-only variant */
1199 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro
= {
1200 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1201 .name
= "", /* will be filled later manually */
1202 .info
= mixer_ctl_feature_info
,
1203 .get
= mixer_ctl_feature_get
,
1208 * This symbol is exported in order to allow the mixer quirks to
1209 * hook up to the standard feature unit control mechanism
1211 struct snd_kcontrol_new
*snd_usb_feature_unit_ctl
= &usb_feature_unit_ctl
;
1214 * build a feature control
1216 static size_t append_ctl_name(struct snd_kcontrol
*kctl
, const char *str
)
1218 return strlcat(kctl
->id
.name
, str
, sizeof(kctl
->id
.name
));
1222 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1223 * rename it to "Headphone". We determine if something is a headphone
1224 * similar to how udev determines form factor.
1226 static void check_no_speaker_on_headset(struct snd_kcontrol
*kctl
,
1227 struct snd_card
*card
)
1229 const char *names_to_check
[] = {
1230 "Headset", "headset", "Headphone", "headphone", NULL
};
1234 if (strcmp("Speaker", kctl
->id
.name
))
1237 for (s
= names_to_check
; *s
; s
++)
1238 if (strstr(card
->shortname
, *s
)) {
1246 strlcpy(kctl
->id
.name
, "Headphone", sizeof(kctl
->id
.name
));
1249 static void build_feature_ctl(struct mixer_build
*state
, void *raw_desc
,
1250 unsigned int ctl_mask
, int control
,
1251 struct usb_audio_term
*iterm
, int unitid
,
1254 struct uac_feature_unit_descriptor
*desc
= raw_desc
;
1255 struct usb_feature_control_info
*ctl_info
;
1256 unsigned int len
= 0;
1257 int mapped_name
= 0;
1258 int nameid
= uac_feature_unit_iFeature(desc
);
1259 struct snd_kcontrol
*kctl
;
1260 struct usb_mixer_elem_info
*cval
;
1261 const struct usbmix_name_map
*map
;
1264 control
++; /* change from zero-based to 1-based value */
1266 if (control
== UAC_FU_GRAPHIC_EQUALIZER
) {
1267 /* FIXME: not supported yet */
1271 map
= find_map(state
, unitid
, control
);
1272 if (check_ignored_ctl(map
))
1275 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1278 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
1279 cval
->control
= control
;
1280 cval
->cmask
= ctl_mask
;
1281 ctl_info
= &audio_feature_info
[control
-1];
1282 if (state
->mixer
->protocol
== UAC_VERSION_1
)
1283 cval
->val_type
= ctl_info
->type
;
1284 else /* UAC_VERSION_2 */
1285 cval
->val_type
= ctl_info
->type_uac2
>= 0 ?
1286 ctl_info
->type_uac2
: ctl_info
->type
;
1288 if (ctl_mask
== 0) {
1289 cval
->channels
= 1; /* master channel */
1290 cval
->master_readonly
= readonly_mask
;
1293 for (i
= 0; i
< 16; i
++)
1294 if (ctl_mask
& (1 << i
))
1297 cval
->ch_readonly
= readonly_mask
;
1301 * If all channels in the mask are marked read-only, make the control
1302 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1303 * issue write commands to read-only channels.
1305 if (cval
->channels
== readonly_mask
)
1306 kctl
= snd_ctl_new1(&usb_feature_unit_ctl_ro
, cval
);
1308 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1311 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
1315 kctl
->private_free
= snd_usb_mixer_elem_free
;
1317 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1318 mapped_name
= len
!= 0;
1320 len
= snd_usb_copy_string_desc(state
, nameid
,
1321 kctl
->id
.name
, sizeof(kctl
->id
.name
));
1327 * determine the control name. the rule is:
1328 * - if a name id is given in descriptor, use it.
1329 * - if the connected input can be determined, then use the name
1331 * - if the connected output can be determined, use it.
1332 * - otherwise, anonymous name.
1335 len
= get_term_name(state
, iterm
, kctl
->id
.name
,
1336 sizeof(kctl
->id
.name
), 1);
1338 len
= get_term_name(state
, &state
->oterm
,
1340 sizeof(kctl
->id
.name
), 1);
1342 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1343 "Feature %d", unitid
);
1347 check_no_speaker_on_headset(kctl
, state
->mixer
->chip
->card
);
1350 * determine the stream direction:
1351 * if the connected output is USB stream, then it's likely a
1352 * capture stream. otherwise it should be playback (hopefully :)
1354 if (!mapped_name
&& !(state
->oterm
.type
>> 16)) {
1355 if ((state
->oterm
.type
& 0xff00) == 0x0100)
1356 append_ctl_name(kctl
, " Capture");
1358 append_ctl_name(kctl
, " Playback");
1360 append_ctl_name(kctl
, control
== UAC_FU_MUTE
?
1361 " Switch" : " Volume");
1365 strlcpy(kctl
->id
.name
, audio_feature_info
[control
-1].name
,
1366 sizeof(kctl
->id
.name
));
1370 /* get min/max values */
1371 get_min_max_with_quirks(cval
, 0, kctl
);
1373 if (control
== UAC_FU_VOLUME
) {
1374 check_mapped_dB(map
, cval
);
1375 if (cval
->dBmin
< cval
->dBmax
|| !cval
->initialized
) {
1376 kctl
->tlv
.c
= snd_usb_mixer_vol_tlv
;
1377 kctl
->vd
[0].access
|=
1378 SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1379 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
;
1383 snd_usb_mixer_fu_apply_quirk(state
->mixer
, cval
, unitid
, kctl
);
1385 range
= (cval
->max
- cval
->min
) / cval
->res
;
1387 * Are there devices with volume range more than 255? I use a bit more
1388 * to be sure. 384 is a resolution magic number found on Logitech
1389 * devices. It will definitively catch all buggy Logitech devices.
1392 usb_audio_warn(state
->chip
,
1393 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1395 usb_audio_warn(state
->chip
,
1396 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1397 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1398 cval
->min
, cval
->max
, cval
->res
);
1401 usb_audio_dbg(state
->chip
, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1402 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1403 cval
->min
, cval
->max
, cval
->res
);
1404 snd_usb_mixer_add_control(&cval
->head
, kctl
);
1407 static int parse_clock_source_unit(struct mixer_build
*state
, int unitid
,
1410 struct uac_clock_source_descriptor
*hdr
= _ftr
;
1411 struct usb_mixer_elem_info
*cval
;
1412 struct snd_kcontrol
*kctl
;
1413 char name
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
1416 if (state
->mixer
->protocol
!= UAC_VERSION_2
)
1419 if (hdr
->bLength
!= sizeof(*hdr
)) {
1420 usb_audio_dbg(state
->chip
,
1421 "Bogus clock source descriptor length of %d, ignoring.\n",
1427 * The only property of this unit we are interested in is the
1428 * clock source validity. If that isn't readable, just bail out.
1430 if (!uac2_control_is_readable(hdr
->bmControls
,
1431 ilog2(UAC2_CS_CONTROL_CLOCK_VALID
)))
1434 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1438 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, hdr
->bClockID
);
1443 cval
->val_type
= USB_MIXER_BOOLEAN
;
1444 cval
->control
= UAC2_CS_CONTROL_CLOCK_VALID
;
1446 if (uac2_control_is_writeable(hdr
->bmControls
,
1447 ilog2(UAC2_CS_CONTROL_CLOCK_VALID
)))
1448 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1450 cval
->master_readonly
= 1;
1451 kctl
= snd_ctl_new1(&usb_feature_unit_ctl_ro
, cval
);
1459 kctl
->private_free
= snd_usb_mixer_elem_free
;
1460 ret
= snd_usb_copy_string_desc(state
, hdr
->iClockSource
,
1461 name
, sizeof(name
));
1463 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1464 "%s Validity", name
);
1466 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1467 "Clock Source %d Validity", hdr
->bClockID
);
1469 return snd_usb_mixer_add_control(&cval
->head
, kctl
);
1473 * parse a feature unit
1475 * most of controls are defined here.
1477 static int parse_audio_feature_unit(struct mixer_build
*state
, int unitid
,
1481 struct usb_audio_term iterm
;
1482 unsigned int master_bits
, first_ch_bits
;
1484 struct uac_feature_unit_descriptor
*hdr
= _ftr
;
1487 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1488 if (hdr
->bLength
< 7) {
1489 usb_audio_err(state
->chip
,
1490 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1494 csize
= hdr
->bControlSize
;
1496 usb_audio_dbg(state
->chip
,
1497 "unit %u: invalid bControlSize == 0\n",
1501 channels
= (hdr
->bLength
- 7) / csize
- 1;
1502 bmaControls
= hdr
->bmaControls
;
1503 if (hdr
->bLength
< 7 + csize
) {
1504 usb_audio_err(state
->chip
,
1505 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1510 struct uac2_feature_unit_descriptor
*ftr
= _ftr
;
1511 if (hdr
->bLength
< 6) {
1512 usb_audio_err(state
->chip
,
1513 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1518 channels
= (hdr
->bLength
- 6) / 4 - 1;
1519 bmaControls
= ftr
->bmaControls
;
1520 if (hdr
->bLength
< 6 + csize
) {
1521 usb_audio_err(state
->chip
,
1522 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1528 /* parse the source unit */
1529 if ((err
= parse_audio_unit(state
, hdr
->bSourceID
)) < 0)
1532 /* determine the input source type and name */
1533 err
= check_input_term(state
, hdr
->bSourceID
, &iterm
);
1537 master_bits
= snd_usb_combine_bytes(bmaControls
, csize
);
1538 /* master configuration quirks */
1539 switch (state
->chip
->usb_id
) {
1540 case USB_ID(0x08bb, 0x2702):
1541 usb_audio_info(state
->chip
,
1542 "usbmixer: master volume quirk for PCM2702 chip\n");
1543 /* disable non-functional volume control */
1544 master_bits
&= ~UAC_CONTROL_BIT(UAC_FU_VOLUME
);
1546 case USB_ID(0x1130, 0xf211):
1547 usb_audio_info(state
->chip
,
1548 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1549 /* disable non-functional volume control */
1555 first_ch_bits
= snd_usb_combine_bytes(bmaControls
+ csize
, csize
);
1559 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1560 /* check all control types */
1561 for (i
= 0; i
< 10; i
++) {
1562 unsigned int ch_bits
= 0;
1563 for (j
= 0; j
< channels
; j
++) {
1566 mask
= snd_usb_combine_bytes(bmaControls
+
1567 csize
* (j
+1), csize
);
1568 if (mask
& (1 << i
))
1569 ch_bits
|= (1 << j
);
1571 /* audio class v1 controls are never read-only */
1574 * The first channel must be set
1575 * (for ease of programming).
1578 build_feature_ctl(state
, _ftr
, ch_bits
, i
,
1580 if (master_bits
& (1 << i
))
1581 build_feature_ctl(state
, _ftr
, 0, i
, &iterm
,
1584 } else { /* UAC_VERSION_2 */
1585 for (i
= 0; i
< ARRAY_SIZE(audio_feature_info
); i
++) {
1586 unsigned int ch_bits
= 0;
1587 unsigned int ch_read_only
= 0;
1589 for (j
= 0; j
< channels
; j
++) {
1592 mask
= snd_usb_combine_bytes(bmaControls
+
1593 csize
* (j
+1), csize
);
1594 if (uac2_control_is_readable(mask
, i
)) {
1595 ch_bits
|= (1 << j
);
1596 if (!uac2_control_is_writeable(mask
, i
))
1597 ch_read_only
|= (1 << j
);
1602 * NOTE: build_feature_ctl() will mark the control
1603 * read-only if all channels are marked read-only in
1604 * the descriptors. Otherwise, the control will be
1605 * reported as writeable, but the driver will not
1606 * actually issue a write command for read-only
1611 * The first channel must be set
1612 * (for ease of programming).
1615 build_feature_ctl(state
, _ftr
, ch_bits
, i
,
1616 &iterm
, unitid
, ch_read_only
);
1617 if (uac2_control_is_readable(master_bits
, i
))
1618 build_feature_ctl(state
, _ftr
, 0, i
, &iterm
, unitid
,
1619 !uac2_control_is_writeable(master_bits
, i
));
1631 * build a mixer unit control
1633 * the callbacks are identical with feature unit.
1634 * input channel number (zero based) is given in control field instead.
1636 static void build_mixer_unit_ctl(struct mixer_build
*state
,
1637 struct uac_mixer_unit_descriptor
*desc
,
1638 int in_pin
, int in_ch
, int unitid
,
1639 struct usb_audio_term
*iterm
)
1641 struct usb_mixer_elem_info
*cval
;
1642 unsigned int num_outs
= uac_mixer_unit_bNrChannels(desc
);
1643 unsigned int i
, len
;
1644 struct snd_kcontrol
*kctl
;
1645 const struct usbmix_name_map
*map
;
1647 map
= find_map(state
, unitid
, 0);
1648 if (check_ignored_ctl(map
))
1651 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1655 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
1656 cval
->control
= in_ch
+ 1; /* based on 1 */
1657 cval
->val_type
= USB_MIXER_S16
;
1658 for (i
= 0; i
< num_outs
; i
++) {
1659 __u8
*c
= uac_mixer_unit_bmControls(desc
, state
->mixer
->protocol
);
1661 if (check_matrix_bitmap(c
, in_ch
, i
, num_outs
)) {
1662 cval
->cmask
|= (1 << i
);
1667 /* get min/max values */
1668 get_min_max(cval
, 0);
1670 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1672 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
1676 kctl
->private_free
= snd_usb_mixer_elem_free
;
1678 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1680 len
= get_term_name(state
, iterm
, kctl
->id
.name
,
1681 sizeof(kctl
->id
.name
), 0);
1683 len
= sprintf(kctl
->id
.name
, "Mixer Source %d", in_ch
+ 1);
1684 append_ctl_name(kctl
, " Volume");
1686 usb_audio_dbg(state
->chip
, "[%d] MU [%s] ch = %d, val = %d/%d\n",
1687 cval
->head
.id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
);
1688 snd_usb_mixer_add_control(&cval
->head
, kctl
);
1692 * parse a mixer unit
1694 static int parse_audio_mixer_unit(struct mixer_build
*state
, int unitid
,
1697 struct uac_mixer_unit_descriptor
*desc
= raw_desc
;
1698 struct usb_audio_term iterm
;
1699 int input_pins
, num_ins
, num_outs
;
1702 if (desc
->bLength
< 11 || !(input_pins
= desc
->bNrInPins
) ||
1703 !(num_outs
= uac_mixer_unit_bNrChannels(desc
))) {
1704 usb_audio_err(state
->chip
,
1705 "invalid MIXER UNIT descriptor %d\n",
1712 for (pin
= 0; pin
< input_pins
; pin
++) {
1713 err
= parse_audio_unit(state
, desc
->baSourceID
[pin
]);
1716 /* no bmControls field (e.g. Maya44) -> ignore */
1717 if (desc
->bLength
<= 10 + input_pins
)
1719 err
= check_input_term(state
, desc
->baSourceID
[pin
], &iterm
);
1722 num_ins
+= iterm
.channels
;
1723 for (; ich
< num_ins
; ich
++) {
1724 int och
, ich_has_controls
= 0;
1726 for (och
= 0; och
< num_outs
; och
++) {
1727 __u8
*c
= uac_mixer_unit_bmControls(desc
,
1728 state
->mixer
->protocol
);
1730 if (check_matrix_bitmap(c
, ich
, och
, num_outs
)) {
1731 ich_has_controls
= 1;
1735 if (ich_has_controls
)
1736 build_mixer_unit_ctl(state
, desc
, pin
, ich
,
1744 * Processing Unit / Extension Unit
1747 /* get callback for processing/extension unit */
1748 static int mixer_ctl_procunit_get(struct snd_kcontrol
*kcontrol
,
1749 struct snd_ctl_elem_value
*ucontrol
)
1751 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1754 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
1756 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1757 return filter_error(cval
, err
);
1759 val
= get_relative_value(cval
, val
);
1760 ucontrol
->value
.integer
.value
[0] = val
;
1764 /* put callback for processing/extension unit */
1765 static int mixer_ctl_procunit_put(struct snd_kcontrol
*kcontrol
,
1766 struct snd_ctl_elem_value
*ucontrol
)
1768 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1771 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
1773 return filter_error(cval
, err
);
1774 val
= ucontrol
->value
.integer
.value
[0];
1775 val
= get_abs_value(cval
, val
);
1777 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
1783 /* alsa control interface for processing/extension unit */
1784 static const struct snd_kcontrol_new mixer_procunit_ctl
= {
1785 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1786 .name
= "", /* will be filled later */
1787 .info
= mixer_ctl_feature_info
,
1788 .get
= mixer_ctl_procunit_get
,
1789 .put
= mixer_ctl_procunit_put
,
1793 * predefined data for processing units
1795 struct procunit_value_info
{
1802 struct procunit_info
{
1805 struct procunit_value_info
*values
;
1808 static struct procunit_value_info updown_proc_info
[] = {
1809 { UAC_UD_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1810 { UAC_UD_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
1813 static struct procunit_value_info prologic_proc_info
[] = {
1814 { UAC_DP_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1815 { UAC_DP_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
1818 static struct procunit_value_info threed_enh_proc_info
[] = {
1819 { UAC_3D_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1820 { UAC_3D_SPACE
, "Spaciousness", USB_MIXER_U8
},
1823 static struct procunit_value_info reverb_proc_info
[] = {
1824 { UAC_REVERB_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1825 { UAC_REVERB_LEVEL
, "Level", USB_MIXER_U8
},
1826 { UAC_REVERB_TIME
, "Time", USB_MIXER_U16
},
1827 { UAC_REVERB_FEEDBACK
, "Feedback", USB_MIXER_U8
},
1830 static struct procunit_value_info chorus_proc_info
[] = {
1831 { UAC_CHORUS_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1832 { UAC_CHORUS_LEVEL
, "Level", USB_MIXER_U8
},
1833 { UAC_CHORUS_RATE
, "Rate", USB_MIXER_U16
},
1834 { UAC_CHORUS_DEPTH
, "Depth", USB_MIXER_U16
},
1837 static struct procunit_value_info dcr_proc_info
[] = {
1838 { UAC_DCR_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1839 { UAC_DCR_RATE
, "Ratio", USB_MIXER_U16
},
1840 { UAC_DCR_MAXAMPL
, "Max Amp", USB_MIXER_S16
},
1841 { UAC_DCR_THRESHOLD
, "Threshold", USB_MIXER_S16
},
1842 { UAC_DCR_ATTACK_TIME
, "Attack Time", USB_MIXER_U16
},
1843 { UAC_DCR_RELEASE_TIME
, "Release Time", USB_MIXER_U16
},
1847 static struct procunit_info procunits
[] = {
1848 { UAC_PROCESS_UP_DOWNMIX
, "Up Down", updown_proc_info
},
1849 { UAC_PROCESS_DOLBY_PROLOGIC
, "Dolby Prologic", prologic_proc_info
},
1850 { UAC_PROCESS_STEREO_EXTENDER
, "3D Stereo Extender", threed_enh_proc_info
},
1851 { UAC_PROCESS_REVERB
, "Reverb", reverb_proc_info
},
1852 { UAC_PROCESS_CHORUS
, "Chorus", chorus_proc_info
},
1853 { UAC_PROCESS_DYN_RANGE_COMP
, "DCR", dcr_proc_info
},
1857 * predefined data for extension units
1859 static struct procunit_value_info clock_rate_xu_info
[] = {
1860 { USB_XU_CLOCK_RATE_SELECTOR
, "Selector", USB_MIXER_U8
, 0 },
1863 static struct procunit_value_info clock_source_xu_info
[] = {
1864 { USB_XU_CLOCK_SOURCE_SELECTOR
, "External", USB_MIXER_BOOLEAN
},
1867 static struct procunit_value_info spdif_format_xu_info
[] = {
1868 { USB_XU_DIGITAL_FORMAT_SELECTOR
, "SPDIF/AC3", USB_MIXER_BOOLEAN
},
1871 static struct procunit_value_info soft_limit_xu_info
[] = {
1872 { USB_XU_SOFT_LIMIT_SELECTOR
, " ", USB_MIXER_BOOLEAN
},
1875 static struct procunit_info extunits
[] = {
1876 { USB_XU_CLOCK_RATE
, "Clock rate", clock_rate_xu_info
},
1877 { USB_XU_CLOCK_SOURCE
, "DigitalIn CLK source", clock_source_xu_info
},
1878 { USB_XU_DIGITAL_IO_STATUS
, "DigitalOut format:", spdif_format_xu_info
},
1879 { USB_XU_DEVICE_OPTIONS
, "AnalogueIn Soft Limit", soft_limit_xu_info
},
1884 * build a processing/extension unit
1886 static int build_audio_procunit(struct mixer_build
*state
, int unitid
,
1887 void *raw_desc
, struct procunit_info
*list
,
1890 struct uac_processing_unit_descriptor
*desc
= raw_desc
;
1891 int num_ins
= desc
->bNrInPins
;
1892 struct usb_mixer_elem_info
*cval
;
1893 struct snd_kcontrol
*kctl
;
1894 int i
, err
, nameid
, type
, len
;
1895 struct procunit_info
*info
;
1896 struct procunit_value_info
*valinfo
;
1897 const struct usbmix_name_map
*map
;
1898 static struct procunit_value_info default_value_info
[] = {
1899 { 0x01, "Switch", USB_MIXER_BOOLEAN
},
1902 static struct procunit_info default_info
= {
1903 0, NULL
, default_value_info
1906 if (desc
->bLength
< 13 || desc
->bLength
< 13 + num_ins
||
1907 desc
->bLength
< num_ins
+ uac_processing_unit_bControlSize(desc
, state
->mixer
->protocol
)) {
1908 usb_audio_err(state
->chip
, "invalid %s descriptor (id %d)\n", name
, unitid
);
1912 for (i
= 0; i
< num_ins
; i
++) {
1913 if ((err
= parse_audio_unit(state
, desc
->baSourceID
[i
])) < 0)
1917 type
= le16_to_cpu(desc
->wProcessType
);
1918 for (info
= list
; info
&& info
->type
; info
++)
1919 if (info
->type
== type
)
1921 if (!info
|| !info
->type
)
1922 info
= &default_info
;
1924 for (valinfo
= info
->values
; valinfo
->control
; valinfo
++) {
1925 __u8
*controls
= uac_processing_unit_bmControls(desc
, state
->mixer
->protocol
);
1927 if (!(controls
[valinfo
->control
/ 8] & (1 << ((valinfo
->control
% 8) - 1))))
1929 map
= find_map(state
, unitid
, valinfo
->control
);
1930 if (check_ignored_ctl(map
))
1932 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1935 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
1936 cval
->control
= valinfo
->control
;
1937 cval
->val_type
= valinfo
->val_type
;
1940 /* get min/max values */
1941 if (type
== UAC_PROCESS_UP_DOWNMIX
&& cval
->control
== UAC_UD_MODE_SELECT
) {
1942 __u8
*control_spec
= uac_processing_unit_specific(desc
, state
->mixer
->protocol
);
1943 /* FIXME: hard-coded */
1945 cval
->max
= control_spec
[0];
1947 cval
->initialized
= 1;
1949 if (type
== USB_XU_CLOCK_RATE
) {
1951 * E-Mu USB 0404/0202/TrackerPre/0204
1952 * samplerate control quirk
1957 cval
->initialized
= 1;
1959 get_min_max(cval
, valinfo
->min_value
);
1962 kctl
= snd_ctl_new1(&mixer_procunit_ctl
, cval
);
1967 kctl
->private_free
= snd_usb_mixer_elem_free
;
1969 if (check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
))) {
1971 } else if (info
->name
) {
1972 strlcpy(kctl
->id
.name
, info
->name
, sizeof(kctl
->id
.name
));
1974 nameid
= uac_processing_unit_iProcessing(desc
, state
->mixer
->protocol
);
1977 len
= snd_usb_copy_string_desc(state
, nameid
,
1979 sizeof(kctl
->id
.name
));
1981 strlcpy(kctl
->id
.name
, name
, sizeof(kctl
->id
.name
));
1983 append_ctl_name(kctl
, " ");
1984 append_ctl_name(kctl
, valinfo
->suffix
);
1986 usb_audio_dbg(state
->chip
,
1987 "[%d] PU [%s] ch = %d, val = %d/%d\n",
1988 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1989 cval
->min
, cval
->max
);
1991 err
= snd_usb_mixer_add_control(&cval
->head
, kctl
);
1998 static int parse_audio_processing_unit(struct mixer_build
*state
, int unitid
,
2001 return build_audio_procunit(state
, unitid
, raw_desc
,
2002 procunits
, "Processing Unit");
2005 static int parse_audio_extension_unit(struct mixer_build
*state
, int unitid
,
2009 * Note that we parse extension units with processing unit descriptors.
2010 * That's ok as the layout is the same.
2012 return build_audio_procunit(state
, unitid
, raw_desc
,
2013 extunits
, "Extension Unit");
2021 * info callback for selector unit
2022 * use an enumerator type for routing
2024 static int mixer_ctl_selector_info(struct snd_kcontrol
*kcontrol
,
2025 struct snd_ctl_elem_info
*uinfo
)
2027 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2028 const char **itemlist
= (const char **)kcontrol
->private_value
;
2030 if (snd_BUG_ON(!itemlist
))
2032 return snd_ctl_enum_info(uinfo
, 1, cval
->max
, itemlist
);
2035 /* get callback for selector unit */
2036 static int mixer_ctl_selector_get(struct snd_kcontrol
*kcontrol
,
2037 struct snd_ctl_elem_value
*ucontrol
)
2039 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2042 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
2044 ucontrol
->value
.enumerated
.item
[0] = 0;
2045 return filter_error(cval
, err
);
2047 val
= get_relative_value(cval
, val
);
2048 ucontrol
->value
.enumerated
.item
[0] = val
;
2052 /* put callback for selector unit */
2053 static int mixer_ctl_selector_put(struct snd_kcontrol
*kcontrol
,
2054 struct snd_ctl_elem_value
*ucontrol
)
2056 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2059 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
2061 return filter_error(cval
, err
);
2062 val
= ucontrol
->value
.enumerated
.item
[0];
2063 val
= get_abs_value(cval
, val
);
2065 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
2071 /* alsa control interface for selector unit */
2072 static const struct snd_kcontrol_new mixer_selectunit_ctl
= {
2073 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
2074 .name
= "", /* will be filled later */
2075 .info
= mixer_ctl_selector_info
,
2076 .get
= mixer_ctl_selector_get
,
2077 .put
= mixer_ctl_selector_put
,
2081 * private free callback.
2082 * free both private_data and private_value
2084 static void usb_mixer_selector_elem_free(struct snd_kcontrol
*kctl
)
2088 if (kctl
->private_data
) {
2089 struct usb_mixer_elem_info
*cval
= kctl
->private_data
;
2090 num_ins
= cval
->max
;
2092 kctl
->private_data
= NULL
;
2094 if (kctl
->private_value
) {
2095 char **itemlist
= (char **)kctl
->private_value
;
2096 for (i
= 0; i
< num_ins
; i
++)
2099 kctl
->private_value
= 0;
2104 * parse a selector unit
2106 static int parse_audio_selector_unit(struct mixer_build
*state
, int unitid
,
2109 struct uac_selector_unit_descriptor
*desc
= raw_desc
;
2110 unsigned int i
, nameid
, len
;
2112 struct usb_mixer_elem_info
*cval
;
2113 struct snd_kcontrol
*kctl
;
2114 const struct usbmix_name_map
*map
;
2117 if (desc
->bLength
< 5 || !desc
->bNrInPins
||
2118 desc
->bLength
< 5 + desc
->bNrInPins
) {
2119 usb_audio_err(state
->chip
,
2120 "invalid SELECTOR UNIT descriptor %d\n", unitid
);
2124 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
2125 if ((err
= parse_audio_unit(state
, desc
->baSourceID
[i
])) < 0)
2129 if (desc
->bNrInPins
== 1) /* only one ? nonsense! */
2132 map
= find_map(state
, unitid
, 0);
2133 if (check_ignored_ctl(map
))
2136 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
2139 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
2140 cval
->val_type
= USB_MIXER_U8
;
2143 cval
->max
= desc
->bNrInPins
;
2145 cval
->initialized
= 1;
2147 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2149 else /* UAC_VERSION_2 */
2150 cval
->control
= (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
) ?
2151 UAC2_CX_CLOCK_SELECTOR
: UAC2_SU_SELECTOR
;
2153 namelist
= kmalloc(sizeof(char *) * desc
->bNrInPins
, GFP_KERNEL
);
2158 #define MAX_ITEM_NAME_LEN 64
2159 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
2160 struct usb_audio_term iterm
;
2162 namelist
[i
] = kmalloc(MAX_ITEM_NAME_LEN
, GFP_KERNEL
);
2170 len
= check_mapped_selector_name(state
, unitid
, i
, namelist
[i
],
2172 if (! len
&& check_input_term(state
, desc
->baSourceID
[i
], &iterm
) >= 0)
2173 len
= get_term_name(state
, &iterm
, namelist
[i
], MAX_ITEM_NAME_LEN
, 0);
2175 sprintf(namelist
[i
], "Input %u", i
);
2178 kctl
= snd_ctl_new1(&mixer_selectunit_ctl
, cval
);
2180 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
2185 kctl
->private_value
= (unsigned long)namelist
;
2186 kctl
->private_free
= usb_mixer_selector_elem_free
;
2188 /* check the static mapping table at first */
2189 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
2192 /* if iSelector is given, use it */
2193 nameid
= uac_selector_unit_iSelector(desc
);
2195 len
= snd_usb_copy_string_desc(state
, nameid
,
2197 sizeof(kctl
->id
.name
));
2198 /* ... or pick up the terminal name at next */
2200 len
= get_term_name(state
, &state
->oterm
,
2201 kctl
->id
.name
, sizeof(kctl
->id
.name
), 0);
2202 /* ... or use the fixed string "USB" as the last resort */
2204 strlcpy(kctl
->id
.name
, "USB", sizeof(kctl
->id
.name
));
2206 /* and add the proper suffix */
2207 if (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
)
2208 append_ctl_name(kctl
, " Clock Source");
2209 else if ((state
->oterm
.type
& 0xff00) == 0x0100)
2210 append_ctl_name(kctl
, " Capture Source");
2212 append_ctl_name(kctl
, " Playback Source");
2215 usb_audio_dbg(state
->chip
, "[%d] SU [%s] items = %d\n",
2216 cval
->head
.id
, kctl
->id
.name
, desc
->bNrInPins
);
2217 return snd_usb_mixer_add_control(&cval
->head
, kctl
);
2221 * parse an audio unit recursively
2224 static int parse_audio_unit(struct mixer_build
*state
, int unitid
)
2228 if (test_and_set_bit(unitid
, state
->unitbitmap
))
2229 return 0; /* the unit already visited */
2231 p1
= find_audio_control_unit(state
, unitid
);
2233 usb_audio_err(state
->chip
, "unit %d not found!\n", unitid
);
2238 case UAC_INPUT_TERMINAL
:
2240 case UAC_MIXER_UNIT
:
2241 return parse_audio_mixer_unit(state
, unitid
, p1
);
2242 case UAC2_CLOCK_SOURCE
:
2243 return parse_clock_source_unit(state
, unitid
, p1
);
2244 case UAC_SELECTOR_UNIT
:
2245 case UAC2_CLOCK_SELECTOR
:
2246 return parse_audio_selector_unit(state
, unitid
, p1
);
2247 case UAC_FEATURE_UNIT
:
2248 return parse_audio_feature_unit(state
, unitid
, p1
);
2249 case UAC1_PROCESSING_UNIT
:
2250 /* UAC2_EFFECT_UNIT has the same value */
2251 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2252 return parse_audio_processing_unit(state
, unitid
, p1
);
2254 return 0; /* FIXME - effect units not implemented yet */
2255 case UAC1_EXTENSION_UNIT
:
2256 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2257 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2258 return parse_audio_extension_unit(state
, unitid
, p1
);
2259 else /* UAC_VERSION_2 */
2260 return parse_audio_processing_unit(state
, unitid
, p1
);
2261 case UAC2_EXTENSION_UNIT_V2
:
2262 return parse_audio_extension_unit(state
, unitid
, p1
);
2264 usb_audio_err(state
->chip
,
2265 "unit %u: unexpected type 0x%02x\n", unitid
, p1
[2]);
2270 static void snd_usb_mixer_free(struct usb_mixer_interface
*mixer
)
2272 /* kill pending URBs */
2273 snd_usb_mixer_disconnect(mixer
);
2275 kfree(mixer
->id_elems
);
2277 kfree(mixer
->urb
->transfer_buffer
);
2278 usb_free_urb(mixer
->urb
);
2280 usb_free_urb(mixer
->rc_urb
);
2281 kfree(mixer
->rc_setup_packet
);
2285 static int snd_usb_mixer_dev_free(struct snd_device
*device
)
2287 struct usb_mixer_interface
*mixer
= device
->device_data
;
2288 snd_usb_mixer_free(mixer
);
2293 * create mixer controls
2295 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2297 static int snd_usb_mixer_controls(struct usb_mixer_interface
*mixer
)
2299 struct mixer_build state
;
2301 const struct usbmix_ctl_map
*map
;
2304 memset(&state
, 0, sizeof(state
));
2305 state
.chip
= mixer
->chip
;
2306 state
.mixer
= mixer
;
2307 state
.buffer
= mixer
->hostif
->extra
;
2308 state
.buflen
= mixer
->hostif
->extralen
;
2310 /* check the mapping table */
2311 for (map
= usbmix_ctl_maps
; map
->id
; map
++) {
2312 if (map
->id
== state
.chip
->usb_id
) {
2313 state
.map
= map
->map
;
2314 state
.selector_map
= map
->selector_map
;
2315 mixer
->ignore_ctl_error
= map
->ignore_ctl_error
;
2321 while ((p
= snd_usb_find_csint_desc(mixer
->hostif
->extra
,
2322 mixer
->hostif
->extralen
,
2323 p
, UAC_OUTPUT_TERMINAL
)) != NULL
) {
2324 if (mixer
->protocol
== UAC_VERSION_1
) {
2325 struct uac1_output_terminal_descriptor
*desc
= p
;
2327 if (desc
->bLength
< sizeof(*desc
))
2328 continue; /* invalid descriptor? */
2329 /* mark terminal ID as visited */
2330 set_bit(desc
->bTerminalID
, state
.unitbitmap
);
2331 state
.oterm
.id
= desc
->bTerminalID
;
2332 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
2333 state
.oterm
.name
= desc
->iTerminal
;
2334 err
= parse_audio_unit(&state
, desc
->bSourceID
);
2335 if (err
< 0 && err
!= -EINVAL
)
2337 } else { /* UAC_VERSION_2 */
2338 struct uac2_output_terminal_descriptor
*desc
= p
;
2340 if (desc
->bLength
< sizeof(*desc
))
2341 continue; /* invalid descriptor? */
2342 /* mark terminal ID as visited */
2343 set_bit(desc
->bTerminalID
, state
.unitbitmap
);
2344 state
.oterm
.id
= desc
->bTerminalID
;
2345 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
2346 state
.oterm
.name
= desc
->iTerminal
;
2347 err
= parse_audio_unit(&state
, desc
->bSourceID
);
2348 if (err
< 0 && err
!= -EINVAL
)
2352 * For UAC2, use the same approach to also add the
2355 err
= parse_audio_unit(&state
, desc
->bCSourceID
);
2356 if (err
< 0 && err
!= -EINVAL
)
2364 void snd_usb_mixer_notify_id(struct usb_mixer_interface
*mixer
, int unitid
)
2366 struct usb_mixer_elem_list
*list
;
2368 for (list
= mixer
->id_elems
[unitid
]; list
; list
= list
->next_id_elem
) {
2369 struct usb_mixer_elem_info
*info
=
2370 (struct usb_mixer_elem_info
*)list
;
2371 /* invalidate cache, so the value is read from the device */
2373 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
2378 static void snd_usb_mixer_dump_cval(struct snd_info_buffer
*buffer
,
2379 struct usb_mixer_elem_list
*list
)
2381 struct usb_mixer_elem_info
*cval
= (struct usb_mixer_elem_info
*)list
;
2382 static char *val_types
[] = {"BOOLEAN", "INV_BOOLEAN",
2383 "S8", "U8", "S16", "U16"};
2384 snd_iprintf(buffer
, " Info: id=%i, control=%i, cmask=0x%x, "
2385 "channels=%i, type=\"%s\"\n", cval
->head
.id
,
2386 cval
->control
, cval
->cmask
, cval
->channels
,
2387 val_types
[cval
->val_type
]);
2388 snd_iprintf(buffer
, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2389 cval
->min
, cval
->max
, cval
->dBmin
, cval
->dBmax
);
2392 static void snd_usb_mixer_proc_read(struct snd_info_entry
*entry
,
2393 struct snd_info_buffer
*buffer
)
2395 struct snd_usb_audio
*chip
= entry
->private_data
;
2396 struct usb_mixer_interface
*mixer
;
2397 struct usb_mixer_elem_list
*list
;
2400 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
2402 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2403 chip
->usb_id
, snd_usb_ctrl_intf(chip
),
2404 mixer
->ignore_ctl_error
);
2405 snd_iprintf(buffer
, "Card: %s\n", chip
->card
->longname
);
2406 for (unitid
= 0; unitid
< MAX_ID_ELEMS
; unitid
++) {
2407 for (list
= mixer
->id_elems
[unitid
]; list
;
2408 list
= list
->next_id_elem
) {
2409 snd_iprintf(buffer
, " Unit: %i\n", list
->id
);
2412 " Control: name=\"%s\", index=%i\n",
2413 list
->kctl
->id
.name
,
2414 list
->kctl
->id
.index
);
2416 list
->dump(buffer
, list
);
2422 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface
*mixer
,
2423 int attribute
, int value
, int index
)
2425 struct usb_mixer_elem_list
*list
;
2426 __u8 unitid
= (index
>> 8) & 0xff;
2427 __u8 control
= (value
>> 8) & 0xff;
2428 __u8 channel
= value
& 0xff;
2429 unsigned int count
= 0;
2431 if (channel
>= MAX_CHANNELS
) {
2432 usb_audio_dbg(mixer
->chip
,
2433 "%s(): bogus channel number %d\n",
2438 for (list
= mixer
->id_elems
[unitid
]; list
; list
= list
->next_id_elem
)
2444 for (list
= mixer
->id_elems
[unitid
]; list
; list
= list
->next_id_elem
) {
2445 struct usb_mixer_elem_info
*info
;
2450 info
= (struct usb_mixer_elem_info
*)list
;
2451 if (count
> 1 && info
->control
!= control
)
2454 switch (attribute
) {
2456 /* invalidate cache, so the value is read from the device */
2458 info
->cached
&= ~(1 << channel
);
2459 else /* master channel */
2462 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
2463 &info
->head
.kctl
->id
);
2475 usb_audio_dbg(mixer
->chip
,
2476 "unknown attribute %d in interrupt\n",
2483 static void snd_usb_mixer_interrupt(struct urb
*urb
)
2485 struct usb_mixer_interface
*mixer
= urb
->context
;
2486 int len
= urb
->actual_length
;
2487 int ustatus
= urb
->status
;
2492 if (mixer
->protocol
== UAC_VERSION_1
) {
2493 struct uac1_status_word
*status
;
2495 for (status
= urb
->transfer_buffer
;
2496 len
>= sizeof(*status
);
2497 len
-= sizeof(*status
), status
++) {
2498 dev_dbg(&urb
->dev
->dev
, "status interrupt: %02x %02x\n",
2499 status
->bStatusType
,
2500 status
->bOriginator
);
2502 /* ignore any notifications not from the control interface */
2503 if ((status
->bStatusType
& UAC1_STATUS_TYPE_ORIG_MASK
) !=
2504 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF
)
2507 if (status
->bStatusType
& UAC1_STATUS_TYPE_MEM_CHANGED
)
2508 snd_usb_mixer_rc_memory_change(mixer
, status
->bOriginator
);
2510 snd_usb_mixer_notify_id(mixer
, status
->bOriginator
);
2512 } else { /* UAC_VERSION_2 */
2513 struct uac2_interrupt_data_msg
*msg
;
2515 for (msg
= urb
->transfer_buffer
;
2516 len
>= sizeof(*msg
);
2517 len
-= sizeof(*msg
), msg
++) {
2518 /* drop vendor specific and endpoint requests */
2519 if ((msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_VENDOR
) ||
2520 (msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_EP
))
2523 snd_usb_mixer_interrupt_v2(mixer
, msg
->bAttribute
,
2524 le16_to_cpu(msg
->wValue
),
2525 le16_to_cpu(msg
->wIndex
));
2530 if (ustatus
!= -ENOENT
&&
2531 ustatus
!= -ECONNRESET
&&
2532 ustatus
!= -ESHUTDOWN
) {
2533 urb
->dev
= mixer
->chip
->dev
;
2534 usb_submit_urb(urb
, GFP_ATOMIC
);
2538 /* create the handler for the optional status interrupt endpoint */
2539 static int snd_usb_mixer_status_create(struct usb_mixer_interface
*mixer
)
2541 struct usb_endpoint_descriptor
*ep
;
2542 void *transfer_buffer
;
2546 /* we need one interrupt input endpoint */
2547 if (get_iface_desc(mixer
->hostif
)->bNumEndpoints
< 1)
2549 ep
= get_endpoint(mixer
->hostif
, 0);
2550 if (!usb_endpoint_dir_in(ep
) || !usb_endpoint_xfer_int(ep
))
2553 epnum
= usb_endpoint_num(ep
);
2554 buffer_length
= le16_to_cpu(ep
->wMaxPacketSize
);
2555 transfer_buffer
= kmalloc(buffer_length
, GFP_KERNEL
);
2556 if (!transfer_buffer
)
2558 mixer
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
2560 kfree(transfer_buffer
);
2563 usb_fill_int_urb(mixer
->urb
, mixer
->chip
->dev
,
2564 usb_rcvintpipe(mixer
->chip
->dev
, epnum
),
2565 transfer_buffer
, buffer_length
,
2566 snd_usb_mixer_interrupt
, mixer
, ep
->bInterval
);
2567 usb_submit_urb(mixer
->urb
, GFP_KERNEL
);
2571 int snd_usb_create_mixer(struct snd_usb_audio
*chip
, int ctrlif
,
2574 static struct snd_device_ops dev_ops
= {
2575 .dev_free
= snd_usb_mixer_dev_free
2577 struct usb_mixer_interface
*mixer
;
2578 struct snd_info_entry
*entry
;
2581 strcpy(chip
->card
->mixername
, "USB Mixer");
2583 mixer
= kzalloc(sizeof(*mixer
), GFP_KERNEL
);
2587 mixer
->ignore_ctl_error
= ignore_error
;
2588 mixer
->id_elems
= kcalloc(MAX_ID_ELEMS
, sizeof(*mixer
->id_elems
),
2590 if (!mixer
->id_elems
) {
2595 mixer
->hostif
= &usb_ifnum_to_if(chip
->dev
, ctrlif
)->altsetting
[0];
2596 switch (get_iface_desc(mixer
->hostif
)->bInterfaceProtocol
) {
2599 mixer
->protocol
= UAC_VERSION_1
;
2602 mixer
->protocol
= UAC_VERSION_2
;
2606 if ((err
= snd_usb_mixer_controls(mixer
)) < 0 ||
2607 (err
= snd_usb_mixer_status_create(mixer
)) < 0)
2610 snd_usb_mixer_apply_create_quirk(mixer
);
2612 err
= snd_device_new(chip
->card
, SNDRV_DEV_CODEC
, mixer
, &dev_ops
);
2616 if (list_empty(&chip
->mixer_list
) &&
2617 !snd_card_proc_new(chip
->card
, "usbmixer", &entry
))
2618 snd_info_set_text_ops(entry
, chip
, snd_usb_mixer_proc_read
);
2620 list_add(&mixer
->list
, &chip
->mixer_list
);
2624 snd_usb_mixer_free(mixer
);
2628 void snd_usb_mixer_disconnect(struct usb_mixer_interface
*mixer
)
2630 if (mixer
->disconnected
)
2633 usb_kill_urb(mixer
->urb
);
2635 usb_kill_urb(mixer
->rc_urb
);
2636 mixer
->disconnected
= true;
2640 /* stop any bus activity of a mixer */
2641 static void snd_usb_mixer_inactivate(struct usb_mixer_interface
*mixer
)
2643 usb_kill_urb(mixer
->urb
);
2644 usb_kill_urb(mixer
->rc_urb
);
2647 static int snd_usb_mixer_activate(struct usb_mixer_interface
*mixer
)
2652 err
= usb_submit_urb(mixer
->urb
, GFP_NOIO
);
2660 int snd_usb_mixer_suspend(struct usb_mixer_interface
*mixer
)
2662 snd_usb_mixer_inactivate(mixer
);
2666 static int restore_mixer_value(struct usb_mixer_elem_list
*list
)
2668 struct usb_mixer_elem_info
*cval
= (struct usb_mixer_elem_info
*)list
;
2673 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
2674 if (!(cval
->cmask
& (1 << c
)))
2676 if (cval
->cached
& (1 << (c
+ 1))) {
2677 err
= snd_usb_set_cur_mix_value(cval
, c
+ 1, idx
,
2678 cval
->cache_val
[idx
]);
2687 err
= snd_usb_set_cur_mix_value(cval
, 0, 0, *cval
->cache_val
);
2696 int snd_usb_mixer_resume(struct usb_mixer_interface
*mixer
, bool reset_resume
)
2698 struct usb_mixer_elem_list
*list
;
2702 /* restore cached mixer values */
2703 for (id
= 0; id
< MAX_ID_ELEMS
; id
++) {
2704 for (list
= mixer
->id_elems
[id
]; list
;
2705 list
= list
->next_id_elem
) {
2707 err
= list
->resume(list
);
2715 return snd_usb_mixer_activate(mixer
);
2719 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list
*list
,
2720 struct usb_mixer_interface
*mixer
,
2723 list
->mixer
= mixer
;
2725 list
->dump
= snd_usb_mixer_dump_cval
;
2727 list
->resume
= restore_mixer_value
;