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 if (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
) >= val_len
) {
324 *value_ret
= convert_signed_value(cval
, snd_usb_combine_bytes(buf
, val_len
));
330 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
331 request
, validx
, idx
, cval
->val_type
);
335 snd_usb_unlock_shutdown(chip
);
339 static int get_ctl_value_v2(struct usb_mixer_elem_info
*cval
, int request
,
340 int validx
, int *value_ret
)
342 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
343 unsigned char buf
[4 + 3 * sizeof(__u32
)]; /* enough space for one range */
345 int idx
= 0, ret
, size
;
348 if (request
== UAC_GET_CUR
) {
349 bRequest
= UAC2_CS_CUR
;
350 size
= uac2_ctl_value_size(cval
->val_type
);
352 bRequest
= UAC2_CS_RANGE
;
356 memset(buf
, 0, sizeof(buf
));
358 ret
= snd_usb_lock_shutdown(chip
) ? -EIO
: 0;
362 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
363 ret
= snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), bRequest
,
364 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
365 validx
, idx
, buf
, size
);
366 snd_usb_unlock_shutdown(chip
);
371 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
372 request
, validx
, idx
, cval
->val_type
);
376 /* FIXME: how should we handle multiple triplets here? */
383 val
= buf
+ sizeof(__u16
);
386 val
= buf
+ sizeof(__u16
) * 2;
389 val
= buf
+ sizeof(__u16
) * 3;
395 *value_ret
= convert_signed_value(cval
, snd_usb_combine_bytes(val
, sizeof(__u16
)));
400 static int get_ctl_value(struct usb_mixer_elem_info
*cval
, int request
,
401 int validx
, int *value_ret
)
403 validx
+= cval
->idx_off
;
405 return (cval
->head
.mixer
->protocol
== UAC_VERSION_1
) ?
406 get_ctl_value_v1(cval
, request
, validx
, value_ret
) :
407 get_ctl_value_v2(cval
, request
, validx
, value_ret
);
410 static int get_cur_ctl_value(struct usb_mixer_elem_info
*cval
,
411 int validx
, int *value
)
413 return get_ctl_value(cval
, UAC_GET_CUR
, validx
, value
);
416 /* channel = 0: master, 1 = first channel */
417 static inline int get_cur_mix_raw(struct usb_mixer_elem_info
*cval
,
418 int channel
, int *value
)
420 return get_ctl_value(cval
, UAC_GET_CUR
,
421 (cval
->control
<< 8) | channel
,
425 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info
*cval
,
426 int channel
, int index
, int *value
)
430 if (cval
->cached
& (1 << channel
)) {
431 *value
= cval
->cache_val
[index
];
434 err
= get_cur_mix_raw(cval
, channel
, value
);
436 if (!cval
->head
.mixer
->ignore_ctl_error
)
437 usb_audio_dbg(cval
->head
.mixer
->chip
,
438 "cannot get current value for control %d ch %d: err = %d\n",
439 cval
->control
, channel
, err
);
442 cval
->cached
|= 1 << channel
;
443 cval
->cache_val
[index
] = *value
;
451 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info
*cval
,
452 int request
, int validx
, int value_set
)
454 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
455 unsigned char buf
[4];
456 int idx
= 0, val_len
, err
, timeout
= 10;
458 validx
+= cval
->idx_off
;
460 if (cval
->head
.mixer
->protocol
== UAC_VERSION_1
) {
461 val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
462 } else { /* UAC_VERSION_2 */
463 val_len
= uac2_ctl_value_size(cval
->val_type
);
466 if (request
!= UAC_SET_CUR
) {
467 usb_audio_dbg(chip
, "RANGE setting not yet supported\n");
471 request
= UAC2_CS_CUR
;
474 value_set
= convert_bytes_value(cval
, value_set
);
475 buf
[0] = value_set
& 0xff;
476 buf
[1] = (value_set
>> 8) & 0xff;
477 buf
[2] = (value_set
>> 16) & 0xff;
478 buf
[3] = (value_set
>> 24) & 0xff;
480 err
= snd_usb_lock_shutdown(chip
);
484 while (timeout
-- > 0) {
485 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
486 if (snd_usb_ctl_msg(chip
->dev
,
487 usb_sndctrlpipe(chip
->dev
, 0), request
,
488 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
489 validx
, idx
, buf
, val_len
) >= 0) {
494 usb_audio_dbg(chip
, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
495 request
, validx
, idx
, cval
->val_type
, buf
[0], buf
[1]);
499 snd_usb_unlock_shutdown(chip
);
503 static int set_cur_ctl_value(struct usb_mixer_elem_info
*cval
,
504 int validx
, int value
)
506 return snd_usb_mixer_set_ctl_value(cval
, UAC_SET_CUR
, validx
, value
);
509 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info
*cval
, int channel
,
510 int index
, int value
)
513 unsigned int read_only
= (channel
== 0) ?
514 cval
->master_readonly
:
515 cval
->ch_readonly
& (1 << (channel
- 1));
518 usb_audio_dbg(cval
->head
.mixer
->chip
,
519 "%s(): channel %d of control %d is read_only\n",
520 __func__
, channel
, cval
->control
);
524 err
= snd_usb_mixer_set_ctl_value(cval
,
525 UAC_SET_CUR
, (cval
->control
<< 8) | channel
,
529 cval
->cached
|= 1 << channel
;
530 cval
->cache_val
[index
] = value
;
535 * TLV callback for mixer volume controls
537 int snd_usb_mixer_vol_tlv(struct snd_kcontrol
*kcontrol
, int op_flag
,
538 unsigned int size
, unsigned int __user
*_tlv
)
540 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
541 DECLARE_TLV_DB_MINMAX(scale
, 0, 0);
543 if (size
< sizeof(scale
))
546 scale
[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE
;
547 scale
[2] = cval
->dBmin
;
548 scale
[3] = cval
->dBmax
;
549 if (copy_to_user(_tlv
, scale
, sizeof(scale
)))
555 * parser routines begin here...
558 static int parse_audio_unit(struct mixer_build
*state
, int unitid
);
562 * check if the input/output channel routing is enabled on the given bitmap.
563 * used for mixer unit parser
565 static int check_matrix_bitmap(unsigned char *bmap
,
566 int ich
, int och
, int num_outs
)
568 int idx
= ich
* num_outs
+ och
;
569 return bmap
[idx
>> 3] & (0x80 >> (idx
& 7));
573 * add an alsa control element
574 * search and increment the index until an empty slot is found.
576 * if failed, give up and free the control instance.
579 int snd_usb_mixer_add_control(struct usb_mixer_elem_list
*list
,
580 struct snd_kcontrol
*kctl
)
582 struct usb_mixer_interface
*mixer
= list
->mixer
;
585 while (snd_ctl_find_id(mixer
->chip
->card
, &kctl
->id
))
587 if ((err
= snd_ctl_add(mixer
->chip
->card
, kctl
)) < 0) {
588 usb_audio_dbg(mixer
->chip
, "cannot add control (err = %d)\n",
593 list
->next_id_elem
= mixer
->id_elems
[list
->id
];
594 mixer
->id_elems
[list
->id
] = list
;
599 * get a terminal name string
602 static struct iterm_name_combo
{
606 { 0x0300, "Output" },
607 { 0x0301, "Speaker" },
608 { 0x0302, "Headphone" },
609 { 0x0303, "HMD Audio" },
610 { 0x0304, "Desktop Speaker" },
611 { 0x0305, "Room Speaker" },
612 { 0x0306, "Com Speaker" },
614 { 0x0600, "External In" },
615 { 0x0601, "Analog In" },
616 { 0x0602, "Digital In" },
618 { 0x0604, "Legacy In" },
619 { 0x0605, "IEC958 In" },
620 { 0x0606, "1394 DA Stream" },
621 { 0x0607, "1394 DV Stream" },
622 { 0x0700, "Embedded" },
623 { 0x0701, "Noise Source" },
624 { 0x0702, "Equalization Noise" },
628 { 0x0706, "MiniDisk" },
629 { 0x0707, "Analog Tape" },
630 { 0x0708, "Phonograph" },
631 { 0x0709, "VCR Audio" },
632 { 0x070a, "Video Disk Audio" },
633 { 0x070b, "DVD Audio" },
634 { 0x070c, "TV Tuner Audio" },
635 { 0x070d, "Satellite Rec Audio" },
636 { 0x070e, "Cable Tuner Audio" },
637 { 0x070f, "DSS Audio" },
638 { 0x0710, "Radio Receiver" },
639 { 0x0711, "Radio Transmitter" },
640 { 0x0712, "Multi-Track Recorder" },
641 { 0x0713, "Synthesizer" },
645 static int get_term_name(struct mixer_build
*state
, struct usb_audio_term
*iterm
,
646 unsigned char *name
, int maxlen
, int term_only
)
648 struct iterm_name_combo
*names
;
651 return snd_usb_copy_string_desc(state
, iterm
->name
,
654 /* virtual type - not a real terminal */
655 if (iterm
->type
>> 16) {
658 switch (iterm
->type
>> 16) {
659 case UAC_SELECTOR_UNIT
:
660 strcpy(name
, "Selector");
662 case UAC1_PROCESSING_UNIT
:
663 strcpy(name
, "Process Unit");
665 case UAC1_EXTENSION_UNIT
:
666 strcpy(name
, "Ext Unit");
669 strcpy(name
, "Mixer");
672 return sprintf(name
, "Unit %d", iterm
->id
);
676 switch (iterm
->type
& 0xff00) {
684 strcpy(name
, "Headset");
687 strcpy(name
, "Phone");
691 for (names
= iterm_names
; names
->type
; names
++) {
692 if (names
->type
== iterm
->type
) {
693 strcpy(name
, names
->name
);
694 return strlen(names
->name
);
702 * parse the source unit recursively until it reaches to a terminal
703 * or a branched unit.
705 static int check_input_term(struct mixer_build
*state
, int id
,
706 struct usb_audio_term
*term
)
711 memset(term
, 0, sizeof(*term
));
712 while ((p1
= find_audio_control_unit(state
, id
)) != NULL
) {
713 unsigned char *hdr
= p1
;
716 case UAC_INPUT_TERMINAL
:
717 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
718 struct uac_input_terminal_descriptor
*d
= p1
;
719 term
->type
= le16_to_cpu(d
->wTerminalType
);
720 term
->channels
= d
->bNrChannels
;
721 term
->chconfig
= le16_to_cpu(d
->wChannelConfig
);
722 term
->name
= d
->iTerminal
;
723 } else { /* UAC_VERSION_2 */
724 struct uac2_input_terminal_descriptor
*d
= p1
;
726 /* call recursively to verify that the
727 * referenced clock entity is valid */
728 err
= check_input_term(state
, d
->bCSourceID
, term
);
732 /* save input term properties after recursion,
733 * to ensure they are not overriden by the
736 term
->type
= le16_to_cpu(d
->wTerminalType
);
737 term
->channels
= d
->bNrChannels
;
738 term
->chconfig
= le32_to_cpu(d
->bmChannelConfig
);
739 term
->name
= d
->iTerminal
;
742 case UAC_FEATURE_UNIT
: {
743 /* the header is the same for v1 and v2 */
744 struct uac_feature_unit_descriptor
*d
= p1
;
746 break; /* continue to parse */
748 case UAC_MIXER_UNIT
: {
749 struct uac_mixer_unit_descriptor
*d
= p1
;
750 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
751 term
->channels
= uac_mixer_unit_bNrChannels(d
);
752 term
->chconfig
= uac_mixer_unit_wChannelConfig(d
, state
->mixer
->protocol
);
753 term
->name
= uac_mixer_unit_iMixer(d
);
756 case UAC_SELECTOR_UNIT
:
757 case UAC2_CLOCK_SELECTOR
: {
758 struct uac_selector_unit_descriptor
*d
= p1
;
759 /* call recursively to retrieve the channel info */
760 err
= check_input_term(state
, d
->baSourceID
[0], term
);
763 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
765 term
->name
= uac_selector_unit_iSelector(d
);
768 case UAC1_PROCESSING_UNIT
:
769 case UAC1_EXTENSION_UNIT
:
770 /* UAC2_PROCESSING_UNIT_V2 */
771 /* UAC2_EFFECT_UNIT */
772 case UAC2_EXTENSION_UNIT_V2
: {
773 struct uac_processing_unit_descriptor
*d
= p1
;
775 if (state
->mixer
->protocol
== UAC_VERSION_2
&&
776 hdr
[2] == UAC2_EFFECT_UNIT
) {
777 /* UAC2/UAC1 unit IDs overlap here in an
778 * uncompatible way. Ignore this unit for now.
784 id
= d
->baSourceID
[0];
785 break; /* continue to parse */
787 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
788 term
->channels
= uac_processing_unit_bNrChannels(d
);
789 term
->chconfig
= uac_processing_unit_wChannelConfig(d
, state
->mixer
->protocol
);
790 term
->name
= uac_processing_unit_iProcessing(d
, state
->mixer
->protocol
);
793 case UAC2_CLOCK_SOURCE
: {
794 struct uac_clock_source_descriptor
*d
= p1
;
795 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
797 term
->name
= d
->iClockSource
;
811 /* feature unit control information */
812 struct usb_feature_control_info
{
814 int type
; /* data type for uac1 */
815 int type_uac2
; /* data type for uac2 if different from uac1, else -1 */
818 static struct usb_feature_control_info audio_feature_info
[] = {
819 { "Mute", USB_MIXER_INV_BOOLEAN
, -1 },
820 { "Volume", USB_MIXER_S16
, -1 },
821 { "Tone Control - Bass", USB_MIXER_S8
, -1 },
822 { "Tone Control - Mid", USB_MIXER_S8
, -1 },
823 { "Tone Control - Treble", USB_MIXER_S8
, -1 },
824 { "Graphic Equalizer", USB_MIXER_S8
, -1 }, /* FIXME: not implemeted yet */
825 { "Auto Gain Control", USB_MIXER_BOOLEAN
, -1 },
826 { "Delay Control", USB_MIXER_U16
, USB_MIXER_U32
},
827 { "Bass Boost", USB_MIXER_BOOLEAN
, -1 },
828 { "Loudness", USB_MIXER_BOOLEAN
, -1 },
830 { "Input Gain Control", USB_MIXER_S16
, -1 },
831 { "Input Gain Pad Control", USB_MIXER_S16
, -1 },
832 { "Phase Inverter Control", USB_MIXER_BOOLEAN
, -1 },
835 /* private_free callback */
836 void snd_usb_mixer_elem_free(struct snd_kcontrol
*kctl
)
838 kfree(kctl
->private_data
);
839 kctl
->private_data
= NULL
;
843 * interface to ALSA control for feature/mixer units
846 /* volume control quirks */
847 static void volume_control_quirks(struct usb_mixer_elem_info
*cval
,
848 struct snd_kcontrol
*kctl
)
850 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
851 switch (chip
->usb_id
) {
852 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
853 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
854 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
860 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
861 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
866 if (strstr(kctl
->id
.name
, "Effect Return") != NULL
) {
872 if ((strstr(kctl
->id
.name
, "Playback Volume") != NULL
) ||
873 (strstr(kctl
->id
.name
, "Effect Send") != NULL
)) {
874 cval
->min
= 0xb5fb; /* -73 dB = 0xb6ff */
880 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
881 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
882 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
884 "set quirk for FTU Effect Duration\n");
890 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
891 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
893 "set quirks for FTU Effect Feedback/Volume\n");
900 case USB_ID(0x0471, 0x0101):
901 case USB_ID(0x0471, 0x0104):
902 case USB_ID(0x0471, 0x0105):
903 case USB_ID(0x0672, 0x1041):
904 /* quirk for UDA1321/N101.
905 * note that detection between firmware 2.1.1.7 (N101)
906 * and later 2.1.1.21 is not very clear from datasheets.
907 * I hope that the min value is -15360 for newer firmware --jk
909 if (!strcmp(kctl
->id
.name
, "PCM Playback Volume") &&
910 cval
->min
== -15616) {
912 "set volume quirk for UDA1321/N101 chip\n");
917 case USB_ID(0x046d, 0x09a4):
918 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
920 "set volume quirk for QuickCam E3500\n");
927 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
928 case USB_ID(0x046d, 0x0808):
929 case USB_ID(0x046d, 0x0809):
930 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
931 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
932 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
933 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
934 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
935 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
936 case USB_ID(0x046d, 0x0991):
937 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
938 /* Most audio usb devices lie about volume resolution.
939 * Most Logitech webcams have res = 384.
940 * Probably there is some logitech magic behind this number --fishor
942 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
944 "set resolution quirk: cval->res = 384\n");
952 * retrieve the minimum and maximum values for the specified control
954 static int get_min_max_with_quirks(struct usb_mixer_elem_info
*cval
,
955 int default_min
, struct snd_kcontrol
*kctl
)
958 cval
->min
= default_min
;
959 cval
->max
= cval
->min
+ 1;
961 cval
->dBmin
= cval
->dBmax
= 0;
963 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
964 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
965 cval
->initialized
= 1;
970 for (i
= 0; i
< MAX_CHANNELS
; i
++)
971 if (cval
->cmask
& (1 << i
)) {
976 if (get_ctl_value(cval
, UAC_GET_MAX
, (cval
->control
<< 8) | minchn
, &cval
->max
) < 0 ||
977 get_ctl_value(cval
, UAC_GET_MIN
, (cval
->control
<< 8) | minchn
, &cval
->min
) < 0) {
978 usb_audio_err(cval
->head
.mixer
->chip
,
979 "%d:%d: cannot get min/max values for control %d (id %d)\n",
980 cval
->head
.id
, snd_usb_ctrl_intf(cval
->head
.mixer
->chip
),
981 cval
->control
, cval
->head
.id
);
984 if (get_ctl_value(cval
, UAC_GET_RES
,
985 (cval
->control
<< 8) | minchn
,
989 int last_valid_res
= cval
->res
;
991 while (cval
->res
> 1) {
992 if (snd_usb_mixer_set_ctl_value(cval
, UAC_SET_RES
,
993 (cval
->control
<< 8) | minchn
,
998 if (get_ctl_value(cval
, UAC_GET_RES
,
999 (cval
->control
<< 8) | minchn
, &cval
->res
) < 0)
1000 cval
->res
= last_valid_res
;
1005 /* Additional checks for the proper resolution
1007 * Some devices report smaller resolutions than actually
1008 * reacting. They don't return errors but simply clip
1009 * to the lower aligned value.
1011 if (cval
->min
+ cval
->res
< cval
->max
) {
1012 int last_valid_res
= cval
->res
;
1013 int saved
, test
, check
;
1014 get_cur_mix_raw(cval
, minchn
, &saved
);
1017 if (test
< cval
->max
)
1021 if (test
< cval
->min
|| test
> cval
->max
||
1022 snd_usb_set_cur_mix_value(cval
, minchn
, 0, test
) ||
1023 get_cur_mix_raw(cval
, minchn
, &check
)) {
1024 cval
->res
= last_valid_res
;
1031 snd_usb_set_cur_mix_value(cval
, minchn
, 0, saved
);
1034 cval
->initialized
= 1;
1038 volume_control_quirks(cval
, kctl
);
1040 /* USB descriptions contain the dB scale in 1/256 dB unit
1041 * while ALSA TLV contains in 1/100 dB unit
1043 cval
->dBmin
= (convert_signed_value(cval
, cval
->min
) * 100) / 256;
1044 cval
->dBmax
= (convert_signed_value(cval
, cval
->max
) * 100) / 256;
1045 if (cval
->dBmin
> cval
->dBmax
) {
1046 /* something is wrong; assume it's either from/to 0dB */
1047 if (cval
->dBmin
< 0)
1049 else if (cval
->dBmin
> 0)
1051 if (cval
->dBmin
> cval
->dBmax
) {
1052 /* totally crap, return an error */
1060 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1062 /* get a feature/mixer unit info */
1063 static int mixer_ctl_feature_info(struct snd_kcontrol
*kcontrol
,
1064 struct snd_ctl_elem_info
*uinfo
)
1066 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1068 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1069 cval
->val_type
== USB_MIXER_INV_BOOLEAN
)
1070 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1072 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
1073 uinfo
->count
= cval
->channels
;
1074 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1075 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
1076 uinfo
->value
.integer
.min
= 0;
1077 uinfo
->value
.integer
.max
= 1;
1079 if (!cval
->initialized
) {
1080 get_min_max_with_quirks(cval
, 0, kcontrol
);
1081 if (cval
->initialized
&& cval
->dBmin
>= cval
->dBmax
) {
1082 kcontrol
->vd
[0].access
&=
1083 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1084 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
);
1085 snd_ctl_notify(cval
->head
.mixer
->chip
->card
,
1086 SNDRV_CTL_EVENT_MASK_INFO
,
1090 uinfo
->value
.integer
.min
= 0;
1091 uinfo
->value
.integer
.max
=
1092 (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
1097 /* get the current value from feature/mixer unit */
1098 static int mixer_ctl_feature_get(struct snd_kcontrol
*kcontrol
,
1099 struct snd_ctl_elem_value
*ucontrol
)
1101 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1102 int c
, cnt
, val
, err
;
1104 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1107 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1108 if (!(cval
->cmask
& (1 << c
)))
1110 err
= snd_usb_get_cur_mix_value(cval
, c
+ 1, cnt
, &val
);
1112 return filter_error(cval
, err
);
1113 val
= get_relative_value(cval
, val
);
1114 ucontrol
->value
.integer
.value
[cnt
] = val
;
1119 /* master channel */
1120 err
= snd_usb_get_cur_mix_value(cval
, 0, 0, &val
);
1122 return filter_error(cval
, err
);
1123 val
= get_relative_value(cval
, val
);
1124 ucontrol
->value
.integer
.value
[0] = val
;
1129 /* put the current value to feature/mixer unit */
1130 static int mixer_ctl_feature_put(struct snd_kcontrol
*kcontrol
,
1131 struct snd_ctl_elem_value
*ucontrol
)
1133 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1134 int c
, cnt
, val
, oval
, err
;
1139 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1140 if (!(cval
->cmask
& (1 << c
)))
1142 err
= snd_usb_get_cur_mix_value(cval
, c
+ 1, cnt
, &oval
);
1144 return filter_error(cval
, err
);
1145 val
= ucontrol
->value
.integer
.value
[cnt
];
1146 val
= get_abs_value(cval
, val
);
1148 snd_usb_set_cur_mix_value(cval
, c
+ 1, cnt
, val
);
1154 /* master channel */
1155 err
= snd_usb_get_cur_mix_value(cval
, 0, 0, &oval
);
1157 return filter_error(cval
, err
);
1158 val
= ucontrol
->value
.integer
.value
[0];
1159 val
= get_abs_value(cval
, val
);
1161 snd_usb_set_cur_mix_value(cval
, 0, 0, val
);
1168 static struct snd_kcontrol_new usb_feature_unit_ctl
= {
1169 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1170 .name
= "", /* will be filled later manually */
1171 .info
= mixer_ctl_feature_info
,
1172 .get
= mixer_ctl_feature_get
,
1173 .put
= mixer_ctl_feature_put
,
1176 /* the read-only variant */
1177 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro
= {
1178 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1179 .name
= "", /* will be filled later manually */
1180 .info
= mixer_ctl_feature_info
,
1181 .get
= mixer_ctl_feature_get
,
1186 * This symbol is exported in order to allow the mixer quirks to
1187 * hook up to the standard feature unit control mechanism
1189 struct snd_kcontrol_new
*snd_usb_feature_unit_ctl
= &usb_feature_unit_ctl
;
1192 * build a feature control
1194 static size_t append_ctl_name(struct snd_kcontrol
*kctl
, const char *str
)
1196 return strlcat(kctl
->id
.name
, str
, sizeof(kctl
->id
.name
));
1200 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1201 * rename it to "Headphone". We determine if something is a headphone
1202 * similar to how udev determines form factor.
1204 static void check_no_speaker_on_headset(struct snd_kcontrol
*kctl
,
1205 struct snd_card
*card
)
1207 const char *names_to_check
[] = {
1208 "Headset", "headset", "Headphone", "headphone", NULL
};
1212 if (strcmp("Speaker", kctl
->id
.name
))
1215 for (s
= names_to_check
; *s
; s
++)
1216 if (strstr(card
->shortname
, *s
)) {
1224 strlcpy(kctl
->id
.name
, "Headphone", sizeof(kctl
->id
.name
));
1227 static void build_feature_ctl(struct mixer_build
*state
, void *raw_desc
,
1228 unsigned int ctl_mask
, int control
,
1229 struct usb_audio_term
*iterm
, int unitid
,
1232 struct uac_feature_unit_descriptor
*desc
= raw_desc
;
1233 struct usb_feature_control_info
*ctl_info
;
1234 unsigned int len
= 0;
1235 int mapped_name
= 0;
1236 int nameid
= uac_feature_unit_iFeature(desc
);
1237 struct snd_kcontrol
*kctl
;
1238 struct usb_mixer_elem_info
*cval
;
1239 const struct usbmix_name_map
*map
;
1242 control
++; /* change from zero-based to 1-based value */
1244 if (control
== UAC_FU_GRAPHIC_EQUALIZER
) {
1245 /* FIXME: not supported yet */
1249 map
= find_map(state
, unitid
, control
);
1250 if (check_ignored_ctl(map
))
1253 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1256 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
1257 cval
->control
= control
;
1258 cval
->cmask
= ctl_mask
;
1259 ctl_info
= &audio_feature_info
[control
-1];
1260 if (state
->mixer
->protocol
== UAC_VERSION_1
)
1261 cval
->val_type
= ctl_info
->type
;
1262 else /* UAC_VERSION_2 */
1263 cval
->val_type
= ctl_info
->type_uac2
>= 0 ?
1264 ctl_info
->type_uac2
: ctl_info
->type
;
1266 if (ctl_mask
== 0) {
1267 cval
->channels
= 1; /* master channel */
1268 cval
->master_readonly
= readonly_mask
;
1271 for (i
= 0; i
< 16; i
++)
1272 if (ctl_mask
& (1 << i
))
1275 cval
->ch_readonly
= readonly_mask
;
1279 * If all channels in the mask are marked read-only, make the control
1280 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1281 * issue write commands to read-only channels.
1283 if (cval
->channels
== readonly_mask
)
1284 kctl
= snd_ctl_new1(&usb_feature_unit_ctl_ro
, cval
);
1286 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1289 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
1293 kctl
->private_free
= snd_usb_mixer_elem_free
;
1295 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1296 mapped_name
= len
!= 0;
1298 len
= snd_usb_copy_string_desc(state
, nameid
,
1299 kctl
->id
.name
, sizeof(kctl
->id
.name
));
1305 * determine the control name. the rule is:
1306 * - if a name id is given in descriptor, use it.
1307 * - if the connected input can be determined, then use the name
1309 * - if the connected output can be determined, use it.
1310 * - otherwise, anonymous name.
1313 len
= get_term_name(state
, iterm
, kctl
->id
.name
,
1314 sizeof(kctl
->id
.name
), 1);
1316 len
= get_term_name(state
, &state
->oterm
,
1318 sizeof(kctl
->id
.name
), 1);
1320 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1321 "Feature %d", unitid
);
1325 check_no_speaker_on_headset(kctl
, state
->mixer
->chip
->card
);
1328 * determine the stream direction:
1329 * if the connected output is USB stream, then it's likely a
1330 * capture stream. otherwise it should be playback (hopefully :)
1332 if (!mapped_name
&& !(state
->oterm
.type
>> 16)) {
1333 if ((state
->oterm
.type
& 0xff00) == 0x0100)
1334 append_ctl_name(kctl
, " Capture");
1336 append_ctl_name(kctl
, " Playback");
1338 append_ctl_name(kctl
, control
== UAC_FU_MUTE
?
1339 " Switch" : " Volume");
1343 strlcpy(kctl
->id
.name
, audio_feature_info
[control
-1].name
,
1344 sizeof(kctl
->id
.name
));
1348 /* get min/max values */
1349 get_min_max_with_quirks(cval
, 0, kctl
);
1351 if (control
== UAC_FU_VOLUME
) {
1352 check_mapped_dB(map
, cval
);
1353 if (cval
->dBmin
< cval
->dBmax
|| !cval
->initialized
) {
1354 kctl
->tlv
.c
= snd_usb_mixer_vol_tlv
;
1355 kctl
->vd
[0].access
|=
1356 SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1357 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
;
1361 snd_usb_mixer_fu_apply_quirk(state
->mixer
, cval
, unitid
, kctl
);
1363 range
= (cval
->max
- cval
->min
) / cval
->res
;
1365 * Are there devices with volume range more than 255? I use a bit more
1366 * to be sure. 384 is a resolution magic number found on Logitech
1367 * devices. It will definitively catch all buggy Logitech devices.
1370 usb_audio_warn(state
->chip
,
1371 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1373 usb_audio_warn(state
->chip
,
1374 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1375 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1376 cval
->min
, cval
->max
, cval
->res
);
1379 usb_audio_dbg(state
->chip
, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1380 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1381 cval
->min
, cval
->max
, cval
->res
);
1382 snd_usb_mixer_add_control(&cval
->head
, kctl
);
1385 static int parse_clock_source_unit(struct mixer_build
*state
, int unitid
,
1388 struct uac_clock_source_descriptor
*hdr
= _ftr
;
1389 struct usb_mixer_elem_info
*cval
;
1390 struct snd_kcontrol
*kctl
;
1391 char name
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
1394 if (state
->mixer
->protocol
!= UAC_VERSION_2
)
1397 if (hdr
->bLength
!= sizeof(*hdr
)) {
1398 usb_audio_dbg(state
->chip
,
1399 "Bogus clock source descriptor length of %d, ignoring.\n",
1405 * The only property of this unit we are interested in is the
1406 * clock source validity. If that isn't readable, just bail out.
1408 if (!uac2_control_is_readable(hdr
->bmControls
,
1409 ilog2(UAC2_CS_CONTROL_CLOCK_VALID
)))
1412 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1416 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, hdr
->bClockID
);
1421 cval
->val_type
= USB_MIXER_BOOLEAN
;
1422 cval
->control
= UAC2_CS_CONTROL_CLOCK_VALID
;
1424 if (uac2_control_is_writeable(hdr
->bmControls
,
1425 ilog2(UAC2_CS_CONTROL_CLOCK_VALID
)))
1426 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1428 cval
->master_readonly
= 1;
1429 kctl
= snd_ctl_new1(&usb_feature_unit_ctl_ro
, cval
);
1437 kctl
->private_free
= snd_usb_mixer_elem_free
;
1438 ret
= snd_usb_copy_string_desc(state
, hdr
->iClockSource
,
1439 name
, sizeof(name
));
1441 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1442 "%s Validity", name
);
1444 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1445 "Clock Source %d Validity", hdr
->bClockID
);
1447 return snd_usb_mixer_add_control(&cval
->head
, kctl
);
1451 * parse a feature unit
1453 * most of controls are defined here.
1455 static int parse_audio_feature_unit(struct mixer_build
*state
, int unitid
,
1459 struct usb_audio_term iterm
;
1460 unsigned int master_bits
, first_ch_bits
;
1462 struct uac_feature_unit_descriptor
*hdr
= _ftr
;
1465 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1466 csize
= hdr
->bControlSize
;
1468 usb_audio_dbg(state
->chip
,
1469 "unit %u: invalid bControlSize == 0\n",
1473 channels
= (hdr
->bLength
- 7) / csize
- 1;
1474 bmaControls
= hdr
->bmaControls
;
1475 if (hdr
->bLength
< 7 + csize
) {
1476 usb_audio_err(state
->chip
,
1477 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1482 struct uac2_feature_unit_descriptor
*ftr
= _ftr
;
1484 channels
= (hdr
->bLength
- 6) / 4 - 1;
1485 bmaControls
= ftr
->bmaControls
;
1486 if (hdr
->bLength
< 6 + csize
) {
1487 usb_audio_err(state
->chip
,
1488 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1494 /* parse the source unit */
1495 if ((err
= parse_audio_unit(state
, hdr
->bSourceID
)) < 0)
1498 /* determine the input source type and name */
1499 err
= check_input_term(state
, hdr
->bSourceID
, &iterm
);
1503 master_bits
= snd_usb_combine_bytes(bmaControls
, csize
);
1504 /* master configuration quirks */
1505 switch (state
->chip
->usb_id
) {
1506 case USB_ID(0x08bb, 0x2702):
1507 usb_audio_info(state
->chip
,
1508 "usbmixer: master volume quirk for PCM2702 chip\n");
1509 /* disable non-functional volume control */
1510 master_bits
&= ~UAC_CONTROL_BIT(UAC_FU_VOLUME
);
1512 case USB_ID(0x1130, 0xf211):
1513 usb_audio_info(state
->chip
,
1514 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1515 /* disable non-functional volume control */
1521 first_ch_bits
= snd_usb_combine_bytes(bmaControls
+ csize
, csize
);
1525 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1526 /* check all control types */
1527 for (i
= 0; i
< 10; i
++) {
1528 unsigned int ch_bits
= 0;
1529 for (j
= 0; j
< channels
; j
++) {
1532 mask
= snd_usb_combine_bytes(bmaControls
+
1533 csize
* (j
+1), csize
);
1534 if (mask
& (1 << i
))
1535 ch_bits
|= (1 << j
);
1537 /* audio class v1 controls are never read-only */
1540 * The first channel must be set
1541 * (for ease of programming).
1544 build_feature_ctl(state
, _ftr
, ch_bits
, i
,
1546 if (master_bits
& (1 << i
))
1547 build_feature_ctl(state
, _ftr
, 0, i
, &iterm
,
1550 } else { /* UAC_VERSION_2 */
1551 for (i
= 0; i
< ARRAY_SIZE(audio_feature_info
); i
++) {
1552 unsigned int ch_bits
= 0;
1553 unsigned int ch_read_only
= 0;
1555 for (j
= 0; j
< channels
; j
++) {
1558 mask
= snd_usb_combine_bytes(bmaControls
+
1559 csize
* (j
+1), csize
);
1560 if (uac2_control_is_readable(mask
, i
)) {
1561 ch_bits
|= (1 << j
);
1562 if (!uac2_control_is_writeable(mask
, i
))
1563 ch_read_only
|= (1 << j
);
1568 * NOTE: build_feature_ctl() will mark the control
1569 * read-only if all channels are marked read-only in
1570 * the descriptors. Otherwise, the control will be
1571 * reported as writeable, but the driver will not
1572 * actually issue a write command for read-only
1577 * The first channel must be set
1578 * (for ease of programming).
1581 build_feature_ctl(state
, _ftr
, ch_bits
, i
,
1582 &iterm
, unitid
, ch_read_only
);
1583 if (uac2_control_is_readable(master_bits
, i
))
1584 build_feature_ctl(state
, _ftr
, 0, i
, &iterm
, unitid
,
1585 !uac2_control_is_writeable(master_bits
, i
));
1597 * build a mixer unit control
1599 * the callbacks are identical with feature unit.
1600 * input channel number (zero based) is given in control field instead.
1602 static void build_mixer_unit_ctl(struct mixer_build
*state
,
1603 struct uac_mixer_unit_descriptor
*desc
,
1604 int in_pin
, int in_ch
, int unitid
,
1605 struct usb_audio_term
*iterm
)
1607 struct usb_mixer_elem_info
*cval
;
1608 unsigned int num_outs
= uac_mixer_unit_bNrChannels(desc
);
1609 unsigned int i
, len
;
1610 struct snd_kcontrol
*kctl
;
1611 const struct usbmix_name_map
*map
;
1613 map
= find_map(state
, unitid
, 0);
1614 if (check_ignored_ctl(map
))
1617 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1621 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
1622 cval
->control
= in_ch
+ 1; /* based on 1 */
1623 cval
->val_type
= USB_MIXER_S16
;
1624 for (i
= 0; i
< num_outs
; i
++) {
1625 __u8
*c
= uac_mixer_unit_bmControls(desc
, state
->mixer
->protocol
);
1627 if (check_matrix_bitmap(c
, in_ch
, i
, num_outs
)) {
1628 cval
->cmask
|= (1 << i
);
1633 /* get min/max values */
1634 get_min_max(cval
, 0);
1636 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1638 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
1642 kctl
->private_free
= snd_usb_mixer_elem_free
;
1644 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1646 len
= get_term_name(state
, iterm
, kctl
->id
.name
,
1647 sizeof(kctl
->id
.name
), 0);
1649 len
= sprintf(kctl
->id
.name
, "Mixer Source %d", in_ch
+ 1);
1650 append_ctl_name(kctl
, " Volume");
1652 usb_audio_dbg(state
->chip
, "[%d] MU [%s] ch = %d, val = %d/%d\n",
1653 cval
->head
.id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
);
1654 snd_usb_mixer_add_control(&cval
->head
, kctl
);
1658 * parse a mixer unit
1660 static int parse_audio_mixer_unit(struct mixer_build
*state
, int unitid
,
1663 struct uac_mixer_unit_descriptor
*desc
= raw_desc
;
1664 struct usb_audio_term iterm
;
1665 int input_pins
, num_ins
, num_outs
;
1668 if (desc
->bLength
< 11 || !(input_pins
= desc
->bNrInPins
) ||
1669 !(num_outs
= uac_mixer_unit_bNrChannels(desc
))) {
1670 usb_audio_err(state
->chip
,
1671 "invalid MIXER UNIT descriptor %d\n",
1678 for (pin
= 0; pin
< input_pins
; pin
++) {
1679 err
= parse_audio_unit(state
, desc
->baSourceID
[pin
]);
1682 /* no bmControls field (e.g. Maya44) -> ignore */
1683 if (desc
->bLength
<= 10 + input_pins
)
1685 err
= check_input_term(state
, desc
->baSourceID
[pin
], &iterm
);
1688 num_ins
+= iterm
.channels
;
1689 for (; ich
< num_ins
; ich
++) {
1690 int och
, ich_has_controls
= 0;
1692 for (och
= 0; och
< num_outs
; och
++) {
1693 __u8
*c
= uac_mixer_unit_bmControls(desc
,
1694 state
->mixer
->protocol
);
1696 if (check_matrix_bitmap(c
, ich
, och
, num_outs
)) {
1697 ich_has_controls
= 1;
1701 if (ich_has_controls
)
1702 build_mixer_unit_ctl(state
, desc
, pin
, ich
,
1710 * Processing Unit / Extension Unit
1713 /* get callback for processing/extension unit */
1714 static int mixer_ctl_procunit_get(struct snd_kcontrol
*kcontrol
,
1715 struct snd_ctl_elem_value
*ucontrol
)
1717 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1720 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
1722 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1723 return filter_error(cval
, err
);
1725 val
= get_relative_value(cval
, val
);
1726 ucontrol
->value
.integer
.value
[0] = val
;
1730 /* put callback for processing/extension unit */
1731 static int mixer_ctl_procunit_put(struct snd_kcontrol
*kcontrol
,
1732 struct snd_ctl_elem_value
*ucontrol
)
1734 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1737 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
1739 return filter_error(cval
, err
);
1740 val
= ucontrol
->value
.integer
.value
[0];
1741 val
= get_abs_value(cval
, val
);
1743 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
1749 /* alsa control interface for processing/extension unit */
1750 static const struct snd_kcontrol_new mixer_procunit_ctl
= {
1751 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1752 .name
= "", /* will be filled later */
1753 .info
= mixer_ctl_feature_info
,
1754 .get
= mixer_ctl_procunit_get
,
1755 .put
= mixer_ctl_procunit_put
,
1759 * predefined data for processing units
1761 struct procunit_value_info
{
1768 struct procunit_info
{
1771 struct procunit_value_info
*values
;
1774 static struct procunit_value_info updown_proc_info
[] = {
1775 { UAC_UD_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1776 { UAC_UD_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
1779 static struct procunit_value_info prologic_proc_info
[] = {
1780 { UAC_DP_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1781 { UAC_DP_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
1784 static struct procunit_value_info threed_enh_proc_info
[] = {
1785 { UAC_3D_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1786 { UAC_3D_SPACE
, "Spaciousness", USB_MIXER_U8
},
1789 static struct procunit_value_info reverb_proc_info
[] = {
1790 { UAC_REVERB_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1791 { UAC_REVERB_LEVEL
, "Level", USB_MIXER_U8
},
1792 { UAC_REVERB_TIME
, "Time", USB_MIXER_U16
},
1793 { UAC_REVERB_FEEDBACK
, "Feedback", USB_MIXER_U8
},
1796 static struct procunit_value_info chorus_proc_info
[] = {
1797 { UAC_CHORUS_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1798 { UAC_CHORUS_LEVEL
, "Level", USB_MIXER_U8
},
1799 { UAC_CHORUS_RATE
, "Rate", USB_MIXER_U16
},
1800 { UAC_CHORUS_DEPTH
, "Depth", USB_MIXER_U16
},
1803 static struct procunit_value_info dcr_proc_info
[] = {
1804 { UAC_DCR_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1805 { UAC_DCR_RATE
, "Ratio", USB_MIXER_U16
},
1806 { UAC_DCR_MAXAMPL
, "Max Amp", USB_MIXER_S16
},
1807 { UAC_DCR_THRESHOLD
, "Threshold", USB_MIXER_S16
},
1808 { UAC_DCR_ATTACK_TIME
, "Attack Time", USB_MIXER_U16
},
1809 { UAC_DCR_RELEASE_TIME
, "Release Time", USB_MIXER_U16
},
1813 static struct procunit_info procunits
[] = {
1814 { UAC_PROCESS_UP_DOWNMIX
, "Up Down", updown_proc_info
},
1815 { UAC_PROCESS_DOLBY_PROLOGIC
, "Dolby Prologic", prologic_proc_info
},
1816 { UAC_PROCESS_STEREO_EXTENDER
, "3D Stereo Extender", threed_enh_proc_info
},
1817 { UAC_PROCESS_REVERB
, "Reverb", reverb_proc_info
},
1818 { UAC_PROCESS_CHORUS
, "Chorus", chorus_proc_info
},
1819 { UAC_PROCESS_DYN_RANGE_COMP
, "DCR", dcr_proc_info
},
1823 * predefined data for extension units
1825 static struct procunit_value_info clock_rate_xu_info
[] = {
1826 { USB_XU_CLOCK_RATE_SELECTOR
, "Selector", USB_MIXER_U8
, 0 },
1829 static struct procunit_value_info clock_source_xu_info
[] = {
1830 { USB_XU_CLOCK_SOURCE_SELECTOR
, "External", USB_MIXER_BOOLEAN
},
1833 static struct procunit_value_info spdif_format_xu_info
[] = {
1834 { USB_XU_DIGITAL_FORMAT_SELECTOR
, "SPDIF/AC3", USB_MIXER_BOOLEAN
},
1837 static struct procunit_value_info soft_limit_xu_info
[] = {
1838 { USB_XU_SOFT_LIMIT_SELECTOR
, " ", USB_MIXER_BOOLEAN
},
1841 static struct procunit_info extunits
[] = {
1842 { USB_XU_CLOCK_RATE
, "Clock rate", clock_rate_xu_info
},
1843 { USB_XU_CLOCK_SOURCE
, "DigitalIn CLK source", clock_source_xu_info
},
1844 { USB_XU_DIGITAL_IO_STATUS
, "DigitalOut format:", spdif_format_xu_info
},
1845 { USB_XU_DEVICE_OPTIONS
, "AnalogueIn Soft Limit", soft_limit_xu_info
},
1850 * build a processing/extension unit
1852 static int build_audio_procunit(struct mixer_build
*state
, int unitid
,
1853 void *raw_desc
, struct procunit_info
*list
,
1856 struct uac_processing_unit_descriptor
*desc
= raw_desc
;
1857 int num_ins
= desc
->bNrInPins
;
1858 struct usb_mixer_elem_info
*cval
;
1859 struct snd_kcontrol
*kctl
;
1860 int i
, err
, nameid
, type
, len
;
1861 struct procunit_info
*info
;
1862 struct procunit_value_info
*valinfo
;
1863 const struct usbmix_name_map
*map
;
1864 static struct procunit_value_info default_value_info
[] = {
1865 { 0x01, "Switch", USB_MIXER_BOOLEAN
},
1868 static struct procunit_info default_info
= {
1869 0, NULL
, default_value_info
1872 if (desc
->bLength
< 13 || desc
->bLength
< 13 + num_ins
||
1873 desc
->bLength
< num_ins
+ uac_processing_unit_bControlSize(desc
, state
->mixer
->protocol
)) {
1874 usb_audio_err(state
->chip
, "invalid %s descriptor (id %d)\n", name
, unitid
);
1878 for (i
= 0; i
< num_ins
; i
++) {
1879 if ((err
= parse_audio_unit(state
, desc
->baSourceID
[i
])) < 0)
1883 type
= le16_to_cpu(desc
->wProcessType
);
1884 for (info
= list
; info
&& info
->type
; info
++)
1885 if (info
->type
== type
)
1887 if (!info
|| !info
->type
)
1888 info
= &default_info
;
1890 for (valinfo
= info
->values
; valinfo
->control
; valinfo
++) {
1891 __u8
*controls
= uac_processing_unit_bmControls(desc
, state
->mixer
->protocol
);
1893 if (!(controls
[valinfo
->control
/ 8] & (1 << ((valinfo
->control
% 8) - 1))))
1895 map
= find_map(state
, unitid
, valinfo
->control
);
1896 if (check_ignored_ctl(map
))
1898 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1901 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
1902 cval
->control
= valinfo
->control
;
1903 cval
->val_type
= valinfo
->val_type
;
1906 /* get min/max values */
1907 if (type
== UAC_PROCESS_UP_DOWNMIX
&& cval
->control
== UAC_UD_MODE_SELECT
) {
1908 __u8
*control_spec
= uac_processing_unit_specific(desc
, state
->mixer
->protocol
);
1909 /* FIXME: hard-coded */
1911 cval
->max
= control_spec
[0];
1913 cval
->initialized
= 1;
1915 if (type
== USB_XU_CLOCK_RATE
) {
1917 * E-Mu USB 0404/0202/TrackerPre/0204
1918 * samplerate control quirk
1923 cval
->initialized
= 1;
1925 get_min_max(cval
, valinfo
->min_value
);
1928 kctl
= snd_ctl_new1(&mixer_procunit_ctl
, cval
);
1933 kctl
->private_free
= snd_usb_mixer_elem_free
;
1935 if (check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
))) {
1937 } else if (info
->name
) {
1938 strlcpy(kctl
->id
.name
, info
->name
, sizeof(kctl
->id
.name
));
1940 nameid
= uac_processing_unit_iProcessing(desc
, state
->mixer
->protocol
);
1943 len
= snd_usb_copy_string_desc(state
, nameid
,
1945 sizeof(kctl
->id
.name
));
1947 strlcpy(kctl
->id
.name
, name
, sizeof(kctl
->id
.name
));
1949 append_ctl_name(kctl
, " ");
1950 append_ctl_name(kctl
, valinfo
->suffix
);
1952 usb_audio_dbg(state
->chip
,
1953 "[%d] PU [%s] ch = %d, val = %d/%d\n",
1954 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1955 cval
->min
, cval
->max
);
1957 err
= snd_usb_mixer_add_control(&cval
->head
, kctl
);
1964 static int parse_audio_processing_unit(struct mixer_build
*state
, int unitid
,
1967 return build_audio_procunit(state
, unitid
, raw_desc
,
1968 procunits
, "Processing Unit");
1971 static int parse_audio_extension_unit(struct mixer_build
*state
, int unitid
,
1975 * Note that we parse extension units with processing unit descriptors.
1976 * That's ok as the layout is the same.
1978 return build_audio_procunit(state
, unitid
, raw_desc
,
1979 extunits
, "Extension Unit");
1987 * info callback for selector unit
1988 * use an enumerator type for routing
1990 static int mixer_ctl_selector_info(struct snd_kcontrol
*kcontrol
,
1991 struct snd_ctl_elem_info
*uinfo
)
1993 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1994 const char **itemlist
= (const char **)kcontrol
->private_value
;
1996 if (snd_BUG_ON(!itemlist
))
1998 return snd_ctl_enum_info(uinfo
, 1, cval
->max
, itemlist
);
2001 /* get callback for selector unit */
2002 static int mixer_ctl_selector_get(struct snd_kcontrol
*kcontrol
,
2003 struct snd_ctl_elem_value
*ucontrol
)
2005 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2008 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
2010 ucontrol
->value
.enumerated
.item
[0] = 0;
2011 return filter_error(cval
, err
);
2013 val
= get_relative_value(cval
, val
);
2014 ucontrol
->value
.enumerated
.item
[0] = val
;
2018 /* put callback for selector unit */
2019 static int mixer_ctl_selector_put(struct snd_kcontrol
*kcontrol
,
2020 struct snd_ctl_elem_value
*ucontrol
)
2022 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2025 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
2027 return filter_error(cval
, err
);
2028 val
= ucontrol
->value
.enumerated
.item
[0];
2029 val
= get_abs_value(cval
, val
);
2031 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
2037 /* alsa control interface for selector unit */
2038 static const struct snd_kcontrol_new mixer_selectunit_ctl
= {
2039 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
2040 .name
= "", /* will be filled later */
2041 .info
= mixer_ctl_selector_info
,
2042 .get
= mixer_ctl_selector_get
,
2043 .put
= mixer_ctl_selector_put
,
2047 * private free callback.
2048 * free both private_data and private_value
2050 static void usb_mixer_selector_elem_free(struct snd_kcontrol
*kctl
)
2054 if (kctl
->private_data
) {
2055 struct usb_mixer_elem_info
*cval
= kctl
->private_data
;
2056 num_ins
= cval
->max
;
2058 kctl
->private_data
= NULL
;
2060 if (kctl
->private_value
) {
2061 char **itemlist
= (char **)kctl
->private_value
;
2062 for (i
= 0; i
< num_ins
; i
++)
2065 kctl
->private_value
= 0;
2070 * parse a selector unit
2072 static int parse_audio_selector_unit(struct mixer_build
*state
, int unitid
,
2075 struct uac_selector_unit_descriptor
*desc
= raw_desc
;
2076 unsigned int i
, nameid
, len
;
2078 struct usb_mixer_elem_info
*cval
;
2079 struct snd_kcontrol
*kctl
;
2080 const struct usbmix_name_map
*map
;
2083 if (!desc
->bNrInPins
|| desc
->bLength
< 5 + desc
->bNrInPins
) {
2084 usb_audio_err(state
->chip
,
2085 "invalid SELECTOR UNIT descriptor %d\n", unitid
);
2089 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
2090 if ((err
= parse_audio_unit(state
, desc
->baSourceID
[i
])) < 0)
2094 if (desc
->bNrInPins
== 1) /* only one ? nonsense! */
2097 map
= find_map(state
, unitid
, 0);
2098 if (check_ignored_ctl(map
))
2101 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
2104 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
2105 cval
->val_type
= USB_MIXER_U8
;
2108 cval
->max
= desc
->bNrInPins
;
2110 cval
->initialized
= 1;
2112 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2114 else /* UAC_VERSION_2 */
2115 cval
->control
= (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
) ?
2116 UAC2_CX_CLOCK_SELECTOR
: UAC2_SU_SELECTOR
;
2118 namelist
= kmalloc(sizeof(char *) * desc
->bNrInPins
, GFP_KERNEL
);
2123 #define MAX_ITEM_NAME_LEN 64
2124 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
2125 struct usb_audio_term iterm
;
2127 namelist
[i
] = kmalloc(MAX_ITEM_NAME_LEN
, GFP_KERNEL
);
2135 len
= check_mapped_selector_name(state
, unitid
, i
, namelist
[i
],
2137 if (! len
&& check_input_term(state
, desc
->baSourceID
[i
], &iterm
) >= 0)
2138 len
= get_term_name(state
, &iterm
, namelist
[i
], MAX_ITEM_NAME_LEN
, 0);
2140 sprintf(namelist
[i
], "Input %u", i
);
2143 kctl
= snd_ctl_new1(&mixer_selectunit_ctl
, cval
);
2145 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
2150 kctl
->private_value
= (unsigned long)namelist
;
2151 kctl
->private_free
= usb_mixer_selector_elem_free
;
2153 nameid
= uac_selector_unit_iSelector(desc
);
2154 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
2158 snd_usb_copy_string_desc(state
, nameid
, kctl
->id
.name
,
2159 sizeof(kctl
->id
.name
));
2161 len
= get_term_name(state
, &state
->oterm
,
2162 kctl
->id
.name
, sizeof(kctl
->id
.name
), 0);
2164 strlcpy(kctl
->id
.name
, "USB", sizeof(kctl
->id
.name
));
2166 if (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
)
2167 append_ctl_name(kctl
, " Clock Source");
2168 else if ((state
->oterm
.type
& 0xff00) == 0x0100)
2169 append_ctl_name(kctl
, " Capture Source");
2171 append_ctl_name(kctl
, " Playback Source");
2174 usb_audio_dbg(state
->chip
, "[%d] SU [%s] items = %d\n",
2175 cval
->head
.id
, kctl
->id
.name
, desc
->bNrInPins
);
2176 return snd_usb_mixer_add_control(&cval
->head
, kctl
);
2180 * parse an audio unit recursively
2183 static int parse_audio_unit(struct mixer_build
*state
, int unitid
)
2187 if (test_and_set_bit(unitid
, state
->unitbitmap
))
2188 return 0; /* the unit already visited */
2190 p1
= find_audio_control_unit(state
, unitid
);
2192 usb_audio_err(state
->chip
, "unit %d not found!\n", unitid
);
2197 case UAC_INPUT_TERMINAL
:
2199 case UAC_MIXER_UNIT
:
2200 return parse_audio_mixer_unit(state
, unitid
, p1
);
2201 case UAC2_CLOCK_SOURCE
:
2202 return parse_clock_source_unit(state
, unitid
, p1
);
2203 case UAC_SELECTOR_UNIT
:
2204 case UAC2_CLOCK_SELECTOR
:
2205 return parse_audio_selector_unit(state
, unitid
, p1
);
2206 case UAC_FEATURE_UNIT
:
2207 return parse_audio_feature_unit(state
, unitid
, p1
);
2208 case UAC1_PROCESSING_UNIT
:
2209 /* UAC2_EFFECT_UNIT has the same value */
2210 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2211 return parse_audio_processing_unit(state
, unitid
, p1
);
2213 return 0; /* FIXME - effect units not implemented yet */
2214 case UAC1_EXTENSION_UNIT
:
2215 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2216 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2217 return parse_audio_extension_unit(state
, unitid
, p1
);
2218 else /* UAC_VERSION_2 */
2219 return parse_audio_processing_unit(state
, unitid
, p1
);
2220 case UAC2_EXTENSION_UNIT_V2
:
2221 return parse_audio_extension_unit(state
, unitid
, p1
);
2223 usb_audio_err(state
->chip
,
2224 "unit %u: unexpected type 0x%02x\n", unitid
, p1
[2]);
2229 static void snd_usb_mixer_free(struct usb_mixer_interface
*mixer
)
2231 kfree(mixer
->id_elems
);
2233 kfree(mixer
->urb
->transfer_buffer
);
2234 usb_free_urb(mixer
->urb
);
2236 usb_free_urb(mixer
->rc_urb
);
2237 kfree(mixer
->rc_setup_packet
);
2241 static int snd_usb_mixer_dev_free(struct snd_device
*device
)
2243 struct usb_mixer_interface
*mixer
= device
->device_data
;
2244 snd_usb_mixer_free(mixer
);
2249 * create mixer controls
2251 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2253 static int snd_usb_mixer_controls(struct usb_mixer_interface
*mixer
)
2255 struct mixer_build state
;
2257 const struct usbmix_ctl_map
*map
;
2260 memset(&state
, 0, sizeof(state
));
2261 state
.chip
= mixer
->chip
;
2262 state
.mixer
= mixer
;
2263 state
.buffer
= mixer
->hostif
->extra
;
2264 state
.buflen
= mixer
->hostif
->extralen
;
2266 /* check the mapping table */
2267 for (map
= usbmix_ctl_maps
; map
->id
; map
++) {
2268 if (map
->id
== state
.chip
->usb_id
) {
2269 state
.map
= map
->map
;
2270 state
.selector_map
= map
->selector_map
;
2271 mixer
->ignore_ctl_error
= map
->ignore_ctl_error
;
2277 while ((p
= snd_usb_find_csint_desc(mixer
->hostif
->extra
,
2278 mixer
->hostif
->extralen
,
2279 p
, UAC_OUTPUT_TERMINAL
)) != NULL
) {
2280 if (mixer
->protocol
== UAC_VERSION_1
) {
2281 struct uac1_output_terminal_descriptor
*desc
= p
;
2283 if (desc
->bLength
< sizeof(*desc
))
2284 continue; /* invalid descriptor? */
2285 /* mark terminal ID as visited */
2286 set_bit(desc
->bTerminalID
, state
.unitbitmap
);
2287 state
.oterm
.id
= desc
->bTerminalID
;
2288 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
2289 state
.oterm
.name
= desc
->iTerminal
;
2290 err
= parse_audio_unit(&state
, desc
->bSourceID
);
2291 if (err
< 0 && err
!= -EINVAL
)
2293 } else { /* UAC_VERSION_2 */
2294 struct uac2_output_terminal_descriptor
*desc
= p
;
2296 if (desc
->bLength
< sizeof(*desc
))
2297 continue; /* invalid descriptor? */
2298 /* mark terminal ID as visited */
2299 set_bit(desc
->bTerminalID
, state
.unitbitmap
);
2300 state
.oterm
.id
= desc
->bTerminalID
;
2301 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
2302 state
.oterm
.name
= desc
->iTerminal
;
2303 err
= parse_audio_unit(&state
, desc
->bSourceID
);
2304 if (err
< 0 && err
!= -EINVAL
)
2308 * For UAC2, use the same approach to also add the
2311 err
= parse_audio_unit(&state
, desc
->bCSourceID
);
2312 if (err
< 0 && err
!= -EINVAL
)
2320 void snd_usb_mixer_notify_id(struct usb_mixer_interface
*mixer
, int unitid
)
2322 struct usb_mixer_elem_list
*list
;
2324 for (list
= mixer
->id_elems
[unitid
]; list
; list
= list
->next_id_elem
)
2325 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
2329 static void snd_usb_mixer_dump_cval(struct snd_info_buffer
*buffer
,
2330 struct usb_mixer_elem_list
*list
)
2332 struct usb_mixer_elem_info
*cval
= (struct usb_mixer_elem_info
*)list
;
2333 static char *val_types
[] = {"BOOLEAN", "INV_BOOLEAN",
2334 "S8", "U8", "S16", "U16"};
2335 snd_iprintf(buffer
, " Info: id=%i, control=%i, cmask=0x%x, "
2336 "channels=%i, type=\"%s\"\n", cval
->head
.id
,
2337 cval
->control
, cval
->cmask
, cval
->channels
,
2338 val_types
[cval
->val_type
]);
2339 snd_iprintf(buffer
, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2340 cval
->min
, cval
->max
, cval
->dBmin
, cval
->dBmax
);
2343 static void snd_usb_mixer_proc_read(struct snd_info_entry
*entry
,
2344 struct snd_info_buffer
*buffer
)
2346 struct snd_usb_audio
*chip
= entry
->private_data
;
2347 struct usb_mixer_interface
*mixer
;
2348 struct usb_mixer_elem_list
*list
;
2351 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
2353 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2354 chip
->usb_id
, snd_usb_ctrl_intf(chip
),
2355 mixer
->ignore_ctl_error
);
2356 snd_iprintf(buffer
, "Card: %s\n", chip
->card
->longname
);
2357 for (unitid
= 0; unitid
< MAX_ID_ELEMS
; unitid
++) {
2358 for (list
= mixer
->id_elems
[unitid
]; list
;
2359 list
= list
->next_id_elem
) {
2360 snd_iprintf(buffer
, " Unit: %i\n", list
->id
);
2363 " Control: name=\"%s\", index=%i\n",
2364 list
->kctl
->id
.name
,
2365 list
->kctl
->id
.index
);
2367 list
->dump(buffer
, list
);
2373 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface
*mixer
,
2374 int attribute
, int value
, int index
)
2376 struct usb_mixer_elem_list
*list
;
2377 __u8 unitid
= (index
>> 8) & 0xff;
2378 __u8 control
= (value
>> 8) & 0xff;
2379 __u8 channel
= value
& 0xff;
2380 unsigned int count
= 0;
2382 if (channel
>= MAX_CHANNELS
) {
2383 usb_audio_dbg(mixer
->chip
,
2384 "%s(): bogus channel number %d\n",
2389 for (list
= mixer
->id_elems
[unitid
]; list
; list
= list
->next_id_elem
)
2395 for (list
= mixer
->id_elems
[unitid
]; list
; list
= list
->next_id_elem
) {
2396 struct usb_mixer_elem_info
*info
;
2401 info
= (struct usb_mixer_elem_info
*)list
;
2402 if (count
> 1 && info
->control
!= control
)
2405 switch (attribute
) {
2407 /* invalidate cache, so the value is read from the device */
2409 info
->cached
&= ~(1 << channel
);
2410 else /* master channel */
2413 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
2414 &info
->head
.kctl
->id
);
2426 usb_audio_dbg(mixer
->chip
,
2427 "unknown attribute %d in interrupt\n",
2434 static void snd_usb_mixer_interrupt(struct urb
*urb
)
2436 struct usb_mixer_interface
*mixer
= urb
->context
;
2437 int len
= urb
->actual_length
;
2438 int ustatus
= urb
->status
;
2443 if (mixer
->protocol
== UAC_VERSION_1
) {
2444 struct uac1_status_word
*status
;
2446 for (status
= urb
->transfer_buffer
;
2447 len
>= sizeof(*status
);
2448 len
-= sizeof(*status
), status
++) {
2449 dev_dbg(&urb
->dev
->dev
, "status interrupt: %02x %02x\n",
2450 status
->bStatusType
,
2451 status
->bOriginator
);
2453 /* ignore any notifications not from the control interface */
2454 if ((status
->bStatusType
& UAC1_STATUS_TYPE_ORIG_MASK
) !=
2455 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF
)
2458 if (status
->bStatusType
& UAC1_STATUS_TYPE_MEM_CHANGED
)
2459 snd_usb_mixer_rc_memory_change(mixer
, status
->bOriginator
);
2461 snd_usb_mixer_notify_id(mixer
, status
->bOriginator
);
2463 } else { /* UAC_VERSION_2 */
2464 struct uac2_interrupt_data_msg
*msg
;
2466 for (msg
= urb
->transfer_buffer
;
2467 len
>= sizeof(*msg
);
2468 len
-= sizeof(*msg
), msg
++) {
2469 /* drop vendor specific and endpoint requests */
2470 if ((msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_VENDOR
) ||
2471 (msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_EP
))
2474 snd_usb_mixer_interrupt_v2(mixer
, msg
->bAttribute
,
2475 le16_to_cpu(msg
->wValue
),
2476 le16_to_cpu(msg
->wIndex
));
2481 if (ustatus
!= -ENOENT
&&
2482 ustatus
!= -ECONNRESET
&&
2483 ustatus
!= -ESHUTDOWN
) {
2484 urb
->dev
= mixer
->chip
->dev
;
2485 usb_submit_urb(urb
, GFP_ATOMIC
);
2489 /* create the handler for the optional status interrupt endpoint */
2490 static int snd_usb_mixer_status_create(struct usb_mixer_interface
*mixer
)
2492 struct usb_endpoint_descriptor
*ep
;
2493 void *transfer_buffer
;
2497 /* we need one interrupt input endpoint */
2498 if (get_iface_desc(mixer
->hostif
)->bNumEndpoints
< 1)
2500 ep
= get_endpoint(mixer
->hostif
, 0);
2501 if (!usb_endpoint_dir_in(ep
) || !usb_endpoint_xfer_int(ep
))
2504 epnum
= usb_endpoint_num(ep
);
2505 buffer_length
= le16_to_cpu(ep
->wMaxPacketSize
);
2506 transfer_buffer
= kmalloc(buffer_length
, GFP_KERNEL
);
2507 if (!transfer_buffer
)
2509 mixer
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
2511 kfree(transfer_buffer
);
2514 usb_fill_int_urb(mixer
->urb
, mixer
->chip
->dev
,
2515 usb_rcvintpipe(mixer
->chip
->dev
, epnum
),
2516 transfer_buffer
, buffer_length
,
2517 snd_usb_mixer_interrupt
, mixer
, ep
->bInterval
);
2518 usb_submit_urb(mixer
->urb
, GFP_KERNEL
);
2522 int snd_usb_create_mixer(struct snd_usb_audio
*chip
, int ctrlif
,
2525 static struct snd_device_ops dev_ops
= {
2526 .dev_free
= snd_usb_mixer_dev_free
2528 struct usb_mixer_interface
*mixer
;
2529 struct snd_info_entry
*entry
;
2532 strcpy(chip
->card
->mixername
, "USB Mixer");
2534 mixer
= kzalloc(sizeof(*mixer
), GFP_KERNEL
);
2538 mixer
->ignore_ctl_error
= ignore_error
;
2539 mixer
->id_elems
= kcalloc(MAX_ID_ELEMS
, sizeof(*mixer
->id_elems
),
2541 if (!mixer
->id_elems
) {
2546 mixer
->hostif
= &usb_ifnum_to_if(chip
->dev
, ctrlif
)->altsetting
[0];
2547 switch (get_iface_desc(mixer
->hostif
)->bInterfaceProtocol
) {
2550 mixer
->protocol
= UAC_VERSION_1
;
2553 mixer
->protocol
= UAC_VERSION_2
;
2557 if ((err
= snd_usb_mixer_controls(mixer
)) < 0 ||
2558 (err
= snd_usb_mixer_status_create(mixer
)) < 0)
2561 snd_usb_mixer_apply_create_quirk(mixer
);
2563 err
= snd_device_new(chip
->card
, SNDRV_DEV_CODEC
, mixer
, &dev_ops
);
2567 if (list_empty(&chip
->mixer_list
) &&
2568 !snd_card_proc_new(chip
->card
, "usbmixer", &entry
))
2569 snd_info_set_text_ops(entry
, chip
, snd_usb_mixer_proc_read
);
2571 list_add(&mixer
->list
, &chip
->mixer_list
);
2575 snd_usb_mixer_free(mixer
);
2579 void snd_usb_mixer_disconnect(struct usb_mixer_interface
*mixer
)
2581 usb_kill_urb(mixer
->urb
);
2582 usb_kill_urb(mixer
->rc_urb
);
2586 /* stop any bus activity of a mixer */
2587 static void snd_usb_mixer_inactivate(struct usb_mixer_interface
*mixer
)
2589 usb_kill_urb(mixer
->urb
);
2590 usb_kill_urb(mixer
->rc_urb
);
2593 static int snd_usb_mixer_activate(struct usb_mixer_interface
*mixer
)
2598 err
= usb_submit_urb(mixer
->urb
, GFP_NOIO
);
2606 int snd_usb_mixer_suspend(struct usb_mixer_interface
*mixer
)
2608 snd_usb_mixer_inactivate(mixer
);
2612 static int restore_mixer_value(struct usb_mixer_elem_list
*list
)
2614 struct usb_mixer_elem_info
*cval
= (struct usb_mixer_elem_info
*)list
;
2619 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
2620 if (!(cval
->cmask
& (1 << c
)))
2622 if (cval
->cached
& (1 << (c
+ 1))) {
2623 err
= snd_usb_set_cur_mix_value(cval
, c
+ 1, idx
,
2624 cval
->cache_val
[idx
]);
2633 err
= snd_usb_set_cur_mix_value(cval
, 0, 0, *cval
->cache_val
);
2642 int snd_usb_mixer_resume(struct usb_mixer_interface
*mixer
, bool reset_resume
)
2644 struct usb_mixer_elem_list
*list
;
2648 /* restore cached mixer values */
2649 for (id
= 0; id
< MAX_ID_ELEMS
; id
++) {
2650 for (list
= mixer
->id_elems
[id
]; list
;
2651 list
= list
->next_id_elem
) {
2653 err
= list
->resume(list
);
2661 return snd_usb_mixer_activate(mixer
);
2665 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list
*list
,
2666 struct usb_mixer_interface
*mixer
,
2669 list
->mixer
= mixer
;
2671 list
->dump
= snd_usb_mixer_dump_cval
;
2673 list
->resume
= restore_mixer_value
;