2 * (Tentative) USB Audio Driver for ALSA
6 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8 * Many codes borrowed from audio.c by
9 * Alan Cox (alan@lxorguk.ukuu.org.uk)
10 * Thomas Sailer (sailer@ife.ee.ethz.ch)
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * TODOs, for both the mixer and the streaming interfaces:
32 * - support for UAC2 effect units
33 * - support for graphical equalizers
34 * - RANGE and MEM set commands (UAC2)
35 * - RANGE and MEM interrupt dispatchers (UAC2)
36 * - audio channel clustering (UAC2)
37 * - audio sample rate converter units (UAC2)
38 * - proper handling of clock multipliers (UAC2)
39 * - dispatch clock change notifications (UAC2)
40 * - stop PCM streams which use a clock that became invalid
41 * - stop PCM streams which use a clock selector that has changed
42 * - parse available sample rates again when clock sources changed
45 #include <linux/bitops.h>
46 #include <linux/init.h>
47 #include <linux/list.h>
48 #include <linux/slab.h>
49 #include <linux/string.h>
50 #include <linux/usb.h>
51 #include <linux/usb/audio.h>
52 #include <linux/usb/audio-v2.h>
54 #include <sound/core.h>
55 #include <sound/control.h>
56 #include <sound/hwdep.h>
57 #include <sound/info.h>
58 #include <sound/tlv.h>
63 #include "mixer_quirks.h"
66 #define MAX_ID_ELEMS 256
68 struct usb_audio_term
{
72 unsigned int chconfig
;
76 struct usbmix_name_map
;
79 struct snd_usb_audio
*chip
;
80 struct usb_mixer_interface
*mixer
;
81 unsigned char *buffer
;
83 DECLARE_BITMAP(unitbitmap
, MAX_ID_ELEMS
);
84 struct usb_audio_term oterm
;
85 const struct usbmix_name_map
*map
;
86 const struct usbmix_selector_map
*selector_map
;
89 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
91 USB_XU_CLOCK_RATE
= 0xe301,
92 USB_XU_CLOCK_SOURCE
= 0xe302,
93 USB_XU_DIGITAL_IO_STATUS
= 0xe303,
94 USB_XU_DEVICE_OPTIONS
= 0xe304,
95 USB_XU_DIRECT_MONITORING
= 0xe305,
96 USB_XU_METERING
= 0xe306
99 USB_XU_CLOCK_SOURCE_SELECTOR
= 0x02, /* clock source*/
100 USB_XU_CLOCK_RATE_SELECTOR
= 0x03, /* clock rate */
101 USB_XU_DIGITAL_FORMAT_SELECTOR
= 0x01, /* the spdif format */
102 USB_XU_SOFT_LIMIT_SELECTOR
= 0x03 /* soft limiter */
106 * manual mapping of mixer names
107 * if the mixer topology is too complicated and the parsed names are
108 * ambiguous, add the entries in usbmixer_maps.c.
110 #include "mixer_maps.c"
112 static const struct usbmix_name_map
*
113 find_map(struct mixer_build
*state
, int unitid
, int control
)
115 const struct usbmix_name_map
*p
= state
->map
;
120 for (p
= state
->map
; p
->id
; p
++) {
121 if (p
->id
== unitid
&&
122 (!control
|| !p
->control
|| control
== p
->control
))
128 /* get the mapped name if the unit matches */
130 check_mapped_name(const struct usbmix_name_map
*p
, char *buf
, int buflen
)
136 return strlcpy(buf
, p
->name
, buflen
);
139 /* check whether the control should be ignored */
141 check_ignored_ctl(const struct usbmix_name_map
*p
)
143 if (!p
|| p
->name
|| p
->dB
)
149 static inline void check_mapped_dB(const struct usbmix_name_map
*p
,
150 struct usb_mixer_elem_info
*cval
)
153 cval
->dBmin
= p
->dB
->min
;
154 cval
->dBmax
= p
->dB
->max
;
155 cval
->initialized
= 1;
159 /* get the mapped selector source name */
160 static int check_mapped_selector_name(struct mixer_build
*state
, int unitid
,
161 int index
, char *buf
, int buflen
)
163 const struct usbmix_selector_map
*p
;
165 if (! state
->selector_map
)
167 for (p
= state
->selector_map
; p
->id
; p
++) {
168 if (p
->id
== unitid
&& index
< p
->count
)
169 return strlcpy(buf
, p
->names
[index
], buflen
);
175 * find an audio control unit with the given unit id
177 static void *find_audio_control_unit(struct mixer_build
*state
, unsigned char unit
)
179 /* we just parse the header */
180 struct uac_feature_unit_descriptor
*hdr
= NULL
;
182 while ((hdr
= snd_usb_find_desc(state
->buffer
, state
->buflen
, hdr
,
183 USB_DT_CS_INTERFACE
)) != NULL
) {
184 if (hdr
->bLength
>= 4 &&
185 hdr
->bDescriptorSubtype
>= UAC_INPUT_TERMINAL
&&
186 hdr
->bDescriptorSubtype
<= UAC2_SAMPLE_RATE_CONVERTER
&&
187 hdr
->bUnitID
== unit
)
195 * copy a string with the given id
197 static int snd_usb_copy_string_desc(struct mixer_build
*state
, int index
, char *buf
, int maxlen
)
199 int len
= usb_string(state
->chip
->dev
, index
, buf
, maxlen
- 1);
205 * convert from the byte/word on usb descriptor to the zero-based integer
207 static int convert_signed_value(struct usb_mixer_elem_info
*cval
, int val
)
209 switch (cval
->val_type
) {
210 case USB_MIXER_BOOLEAN
:
212 case USB_MIXER_INV_BOOLEAN
:
235 * convert from the zero-based int to the byte/word for usb descriptor
237 static int convert_bytes_value(struct usb_mixer_elem_info
*cval
, int val
)
239 switch (cval
->val_type
) {
240 case USB_MIXER_BOOLEAN
:
242 case USB_MIXER_INV_BOOLEAN
:
251 return 0; /* not reached */
254 static int get_relative_value(struct usb_mixer_elem_info
*cval
, int val
)
260 else if (val
>= cval
->max
)
261 return (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
263 return (val
- cval
->min
) / cval
->res
;
266 static int get_abs_value(struct usb_mixer_elem_info
*cval
, int val
)
281 * retrieve a mixer value
284 static int get_ctl_value_v1(struct usb_mixer_elem_info
*cval
, int request
, int validx
, int *value_ret
)
286 struct snd_usb_audio
*chip
= cval
->mixer
->chip
;
287 unsigned char buf
[2];
288 int val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
292 err
= snd_usb_autoresume(cval
->mixer
->chip
);
295 down_read(&chip
->shutdown_rwsem
);
296 while (timeout
-- > 0) {
299 idx
= snd_usb_ctrl_intf(chip
) | (cval
->id
<< 8);
300 if (snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), request
,
301 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
302 validx
, idx
, buf
, val_len
) >= val_len
) {
303 *value_ret
= convert_signed_value(cval
, snd_usb_combine_bytes(buf
, val_len
));
308 snd_printdd(KERN_ERR
"cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
309 request
, validx
, idx
, cval
->val_type
);
313 up_read(&chip
->shutdown_rwsem
);
314 snd_usb_autosuspend(cval
->mixer
->chip
);
318 static int get_ctl_value_v2(struct usb_mixer_elem_info
*cval
, int request
, int validx
, int *value_ret
)
320 struct snd_usb_audio
*chip
= cval
->mixer
->chip
;
321 unsigned char buf
[2 + 3*sizeof(__u16
)]; /* enough space for one range */
323 int idx
= 0, ret
, size
;
326 if (request
== UAC_GET_CUR
) {
327 bRequest
= UAC2_CS_CUR
;
328 size
= sizeof(__u16
);
330 bRequest
= UAC2_CS_RANGE
;
334 memset(buf
, 0, sizeof(buf
));
336 ret
= snd_usb_autoresume(chip
) ? -EIO
: 0;
340 down_read(&chip
->shutdown_rwsem
);
344 idx
= snd_usb_ctrl_intf(chip
) | (cval
->id
<< 8);
345 ret
= snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), bRequest
,
346 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
347 validx
, idx
, buf
, size
);
349 up_read(&chip
->shutdown_rwsem
);
350 snd_usb_autosuspend(chip
);
354 snd_printk(KERN_ERR
"cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
355 request
, validx
, idx
, cval
->val_type
);
359 /* FIXME: how should we handle multiple triplets here? */
366 val
= buf
+ sizeof(__u16
);
369 val
= buf
+ sizeof(__u16
) * 2;
372 val
= buf
+ sizeof(__u16
) * 3;
378 *value_ret
= convert_signed_value(cval
, snd_usb_combine_bytes(val
, sizeof(__u16
)));
383 static int get_ctl_value(struct usb_mixer_elem_info
*cval
, int request
, int validx
, int *value_ret
)
385 validx
+= cval
->idx_off
;
387 return (cval
->mixer
->protocol
== UAC_VERSION_1
) ?
388 get_ctl_value_v1(cval
, request
, validx
, value_ret
) :
389 get_ctl_value_v2(cval
, request
, validx
, value_ret
);
392 static int get_cur_ctl_value(struct usb_mixer_elem_info
*cval
, int validx
, int *value
)
394 return get_ctl_value(cval
, UAC_GET_CUR
, validx
, value
);
397 /* channel = 0: master, 1 = first channel */
398 static inline int get_cur_mix_raw(struct usb_mixer_elem_info
*cval
,
399 int channel
, int *value
)
401 return get_ctl_value(cval
, UAC_GET_CUR
, (cval
->control
<< 8) | channel
, value
);
404 static int get_cur_mix_value(struct usb_mixer_elem_info
*cval
,
405 int channel
, int index
, int *value
)
409 if (cval
->cached
& (1 << channel
)) {
410 *value
= cval
->cache_val
[index
];
413 err
= get_cur_mix_raw(cval
, channel
, value
);
415 if (!cval
->mixer
->ignore_ctl_error
)
416 snd_printd(KERN_ERR
"cannot get current value for control %d ch %d: err = %d\n",
417 cval
->control
, channel
, err
);
420 cval
->cached
|= 1 << channel
;
421 cval
->cache_val
[index
] = *value
;
430 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info
*cval
,
431 int request
, int validx
, int value_set
)
433 struct snd_usb_audio
*chip
= cval
->mixer
->chip
;
434 unsigned char buf
[2];
435 int idx
= 0, val_len
, err
, timeout
= 10;
437 validx
+= cval
->idx_off
;
439 if (cval
->mixer
->protocol
== UAC_VERSION_1
) {
440 val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
441 } else { /* UAC_VERSION_2 */
442 /* audio class v2 controls are always 2 bytes in size */
443 val_len
= sizeof(__u16
);
446 if (request
!= UAC_SET_CUR
) {
447 snd_printdd(KERN_WARNING
"RANGE setting not yet supported\n");
451 request
= UAC2_CS_CUR
;
454 value_set
= convert_bytes_value(cval
, value_set
);
455 buf
[0] = value_set
& 0xff;
456 buf
[1] = (value_set
>> 8) & 0xff;
457 err
= snd_usb_autoresume(chip
);
460 down_read(&chip
->shutdown_rwsem
);
461 while (timeout
-- > 0) {
464 idx
= snd_usb_ctrl_intf(chip
) | (cval
->id
<< 8);
465 if (snd_usb_ctl_msg(chip
->dev
,
466 usb_sndctrlpipe(chip
->dev
, 0), request
,
467 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
468 validx
, idx
, buf
, val_len
) >= 0) {
473 snd_printdd(KERN_ERR
"cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
474 request
, validx
, idx
, cval
->val_type
, buf
[0], buf
[1]);
478 up_read(&chip
->shutdown_rwsem
);
479 snd_usb_autosuspend(chip
);
483 static int set_cur_ctl_value(struct usb_mixer_elem_info
*cval
, int validx
, int value
)
485 return snd_usb_mixer_set_ctl_value(cval
, UAC_SET_CUR
, validx
, value
);
488 static int set_cur_mix_value(struct usb_mixer_elem_info
*cval
, int channel
,
489 int index
, int value
)
492 unsigned int read_only
= (channel
== 0) ?
493 cval
->master_readonly
:
494 cval
->ch_readonly
& (1 << (channel
- 1));
497 snd_printdd(KERN_INFO
"%s(): channel %d of control %d is read_only\n",
498 __func__
, channel
, cval
->control
);
502 err
= snd_usb_mixer_set_ctl_value(cval
, UAC_SET_CUR
, (cval
->control
<< 8) | channel
,
506 cval
->cached
|= 1 << channel
;
507 cval
->cache_val
[index
] = value
;
512 * TLV callback for mixer volume controls
514 int snd_usb_mixer_vol_tlv(struct snd_kcontrol
*kcontrol
, int op_flag
,
515 unsigned int size
, unsigned int __user
*_tlv
)
517 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
518 DECLARE_TLV_DB_MINMAX(scale
, 0, 0);
520 if (size
< sizeof(scale
))
522 scale
[2] = cval
->dBmin
;
523 scale
[3] = cval
->dBmax
;
524 if (copy_to_user(_tlv
, scale
, sizeof(scale
)))
530 * parser routines begin here...
533 static int parse_audio_unit(struct mixer_build
*state
, int unitid
);
537 * check if the input/output channel routing is enabled on the given bitmap.
538 * used for mixer unit parser
540 static int check_matrix_bitmap(unsigned char *bmap
, int ich
, int och
, int num_outs
)
542 int idx
= ich
* num_outs
+ och
;
543 return bmap
[idx
>> 3] & (0x80 >> (idx
& 7));
548 * add an alsa control element
549 * search and increment the index until an empty slot is found.
551 * if failed, give up and free the control instance.
554 int snd_usb_mixer_add_control(struct usb_mixer_interface
*mixer
,
555 struct snd_kcontrol
*kctl
)
557 struct usb_mixer_elem_info
*cval
= kctl
->private_data
;
560 while (snd_ctl_find_id(mixer
->chip
->card
, &kctl
->id
))
562 if ((err
= snd_ctl_add(mixer
->chip
->card
, kctl
)) < 0) {
563 snd_printd(KERN_ERR
"cannot add control (err = %d)\n", err
);
566 cval
->elem_id
= &kctl
->id
;
567 cval
->next_id_elem
= mixer
->id_elems
[cval
->id
];
568 mixer
->id_elems
[cval
->id
] = cval
;
574 * get a terminal name string
577 static struct iterm_name_combo
{
581 { 0x0300, "Output" },
582 { 0x0301, "Speaker" },
583 { 0x0302, "Headphone" },
584 { 0x0303, "HMD Audio" },
585 { 0x0304, "Desktop Speaker" },
586 { 0x0305, "Room Speaker" },
587 { 0x0306, "Com Speaker" },
589 { 0x0600, "External In" },
590 { 0x0601, "Analog In" },
591 { 0x0602, "Digital In" },
593 { 0x0604, "Legacy In" },
594 { 0x0605, "IEC958 In" },
595 { 0x0606, "1394 DA Stream" },
596 { 0x0607, "1394 DV Stream" },
597 { 0x0700, "Embedded" },
598 { 0x0701, "Noise Source" },
599 { 0x0702, "Equalization Noise" },
603 { 0x0706, "MiniDisk" },
604 { 0x0707, "Analog Tape" },
605 { 0x0708, "Phonograph" },
606 { 0x0709, "VCR Audio" },
607 { 0x070a, "Video Disk Audio" },
608 { 0x070b, "DVD Audio" },
609 { 0x070c, "TV Tuner Audio" },
610 { 0x070d, "Satellite Rec Audio" },
611 { 0x070e, "Cable Tuner Audio" },
612 { 0x070f, "DSS Audio" },
613 { 0x0710, "Radio Receiver" },
614 { 0x0711, "Radio Transmitter" },
615 { 0x0712, "Multi-Track Recorder" },
616 { 0x0713, "Synthesizer" },
620 static int get_term_name(struct mixer_build
*state
, struct usb_audio_term
*iterm
,
621 unsigned char *name
, int maxlen
, int term_only
)
623 struct iterm_name_combo
*names
;
626 return snd_usb_copy_string_desc(state
, iterm
->name
, name
, maxlen
);
628 /* virtual type - not a real terminal */
629 if (iterm
->type
>> 16) {
632 switch (iterm
->type
>> 16) {
633 case UAC_SELECTOR_UNIT
:
634 strcpy(name
, "Selector"); return 8;
635 case UAC1_PROCESSING_UNIT
:
636 strcpy(name
, "Process Unit"); return 12;
637 case UAC1_EXTENSION_UNIT
:
638 strcpy(name
, "Ext Unit"); return 8;
640 strcpy(name
, "Mixer"); return 5;
642 return sprintf(name
, "Unit %d", iterm
->id
);
646 switch (iterm
->type
& 0xff00) {
648 strcpy(name
, "PCM"); return 3;
650 strcpy(name
, "Mic"); return 3;
652 strcpy(name
, "Headset"); return 7;
654 strcpy(name
, "Phone"); return 5;
657 for (names
= iterm_names
; names
->type
; names
++)
658 if (names
->type
== iterm
->type
) {
659 strcpy(name
, names
->name
);
660 return strlen(names
->name
);
667 * parse the source unit recursively until it reaches to a terminal
668 * or a branched unit.
670 static int check_input_term(struct mixer_build
*state
, int id
, struct usb_audio_term
*term
)
675 memset(term
, 0, sizeof(*term
));
676 while ((p1
= find_audio_control_unit(state
, id
)) != NULL
) {
677 unsigned char *hdr
= p1
;
680 case UAC_INPUT_TERMINAL
:
681 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
682 struct uac_input_terminal_descriptor
*d
= p1
;
683 term
->type
= le16_to_cpu(d
->wTerminalType
);
684 term
->channels
= d
->bNrChannels
;
685 term
->chconfig
= le16_to_cpu(d
->wChannelConfig
);
686 term
->name
= d
->iTerminal
;
687 } else { /* UAC_VERSION_2 */
688 struct uac2_input_terminal_descriptor
*d
= p1
;
689 term
->type
= le16_to_cpu(d
->wTerminalType
);
690 term
->channels
= d
->bNrChannels
;
691 term
->chconfig
= le32_to_cpu(d
->bmChannelConfig
);
692 term
->name
= d
->iTerminal
;
694 /* call recursively to get the clock selectors */
695 err
= check_input_term(state
, d
->bCSourceID
, term
);
700 case UAC_FEATURE_UNIT
: {
701 /* the header is the same for v1 and v2 */
702 struct uac_feature_unit_descriptor
*d
= p1
;
704 break; /* continue to parse */
706 case UAC_MIXER_UNIT
: {
707 struct uac_mixer_unit_descriptor
*d
= p1
;
708 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
709 term
->channels
= uac_mixer_unit_bNrChannels(d
);
710 term
->chconfig
= uac_mixer_unit_wChannelConfig(d
, state
->mixer
->protocol
);
711 term
->name
= uac_mixer_unit_iMixer(d
);
714 case UAC_SELECTOR_UNIT
:
715 case UAC2_CLOCK_SELECTOR
: {
716 struct uac_selector_unit_descriptor
*d
= p1
;
717 /* call recursively to retrieve the channel info */
718 err
= check_input_term(state
, d
->baSourceID
[0], term
);
721 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
723 term
->name
= uac_selector_unit_iSelector(d
);
726 case UAC1_PROCESSING_UNIT
:
727 case UAC1_EXTENSION_UNIT
:
728 /* UAC2_PROCESSING_UNIT_V2 */
729 /* UAC2_EFFECT_UNIT */
730 case UAC2_EXTENSION_UNIT_V2
: {
731 struct uac_processing_unit_descriptor
*d
= p1
;
733 if (state
->mixer
->protocol
== UAC_VERSION_2
&&
734 hdr
[2] == UAC2_EFFECT_UNIT
) {
735 /* UAC2/UAC1 unit IDs overlap here in an
736 * uncompatible way. Ignore this unit for now.
742 id
= d
->baSourceID
[0];
743 break; /* continue to parse */
745 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
746 term
->channels
= uac_processing_unit_bNrChannels(d
);
747 term
->chconfig
= uac_processing_unit_wChannelConfig(d
, state
->mixer
->protocol
);
748 term
->name
= uac_processing_unit_iProcessing(d
, state
->mixer
->protocol
);
751 case UAC2_CLOCK_SOURCE
: {
752 struct uac_clock_source_descriptor
*d
= p1
;
753 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
755 term
->name
= d
->iClockSource
;
770 /* feature unit control information */
771 struct usb_feature_control_info
{
773 unsigned int type
; /* control type (mute, volume, etc.) */
776 static struct usb_feature_control_info audio_feature_info
[] = {
777 { "Mute", USB_MIXER_INV_BOOLEAN
},
778 { "Volume", USB_MIXER_S16
},
779 { "Tone Control - Bass", USB_MIXER_S8
},
780 { "Tone Control - Mid", USB_MIXER_S8
},
781 { "Tone Control - Treble", USB_MIXER_S8
},
782 { "Graphic Equalizer", USB_MIXER_S8
}, /* FIXME: not implemeted yet */
783 { "Auto Gain Control", USB_MIXER_BOOLEAN
},
784 { "Delay Control", USB_MIXER_U16
},
785 { "Bass Boost", USB_MIXER_BOOLEAN
},
786 { "Loudness", USB_MIXER_BOOLEAN
},
788 { "Input Gain Control", USB_MIXER_U16
},
789 { "Input Gain Pad Control", USB_MIXER_BOOLEAN
},
790 { "Phase Inverter Control", USB_MIXER_BOOLEAN
},
794 /* private_free callback */
795 static void usb_mixer_elem_free(struct snd_kcontrol
*kctl
)
797 kfree(kctl
->private_data
);
798 kctl
->private_data
= NULL
;
803 * interface to ALSA control for feature/mixer units
806 /* volume control quirks */
807 static void volume_control_quirks(struct usb_mixer_elem_info
*cval
,
808 struct snd_kcontrol
*kctl
)
810 switch (cval
->mixer
->chip
->usb_id
) {
811 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
812 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
813 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
819 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
820 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
825 if (strstr(kctl
->id
.name
, "Effect Return") != NULL
) {
831 if ((strstr(kctl
->id
.name
, "Playback Volume") != NULL
) ||
832 (strstr(kctl
->id
.name
, "Effect Send") != NULL
)) {
833 cval
->min
= 0xb5fb; /* -73 dB = 0xb6ff */
839 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
840 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
841 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
843 "usb-audio: set quirk for FTU Effect Duration\n");
849 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
850 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
852 "usb-audio: set quirks for FTU Effect Feedback/Volume\n");
859 case USB_ID(0x0471, 0x0101):
860 case USB_ID(0x0471, 0x0104):
861 case USB_ID(0x0471, 0x0105):
862 case USB_ID(0x0672, 0x1041):
863 /* quirk for UDA1321/N101.
864 * note that detection between firmware 2.1.1.7 (N101)
865 * and later 2.1.1.21 is not very clear from datasheets.
866 * I hope that the min value is -15360 for newer firmware --jk
868 if (!strcmp(kctl
->id
.name
, "PCM Playback Volume") &&
869 cval
->min
== -15616) {
871 "set volume quirk for UDA1321/N101 chip\n");
876 case USB_ID(0x046d, 0x09a4):
877 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
879 "set volume quirk for QuickCam E3500\n");
886 case USB_ID(0x046d, 0x0808):
887 case USB_ID(0x046d, 0x0809):
888 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
889 case USB_ID(0x046d, 0x0991):
890 /* Most audio usb devices lie about volume resolution.
891 * Most Logitech webcams have res = 384.
892 * Proboly there is some logitech magic behind this number --fishor
894 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
896 "set resolution quirk: cval->res = 384\n");
905 * retrieve the minimum and maximum values for the specified control
907 static int get_min_max_with_quirks(struct usb_mixer_elem_info
*cval
,
908 int default_min
, struct snd_kcontrol
*kctl
)
911 cval
->min
= default_min
;
912 cval
->max
= cval
->min
+ 1;
914 cval
->dBmin
= cval
->dBmax
= 0;
916 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
917 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
918 cval
->initialized
= 1;
923 for (i
= 0; i
< MAX_CHANNELS
; i
++)
924 if (cval
->cmask
& (1 << i
)) {
929 if (get_ctl_value(cval
, UAC_GET_MAX
, (cval
->control
<< 8) | minchn
, &cval
->max
) < 0 ||
930 get_ctl_value(cval
, UAC_GET_MIN
, (cval
->control
<< 8) | minchn
, &cval
->min
) < 0) {
931 snd_printd(KERN_ERR
"%d:%d: cannot get min/max values for control %d (id %d)\n",
932 cval
->id
, snd_usb_ctrl_intf(cval
->mixer
->chip
), cval
->control
, cval
->id
);
935 if (get_ctl_value(cval
, UAC_GET_RES
, (cval
->control
<< 8) | minchn
, &cval
->res
) < 0) {
938 int last_valid_res
= cval
->res
;
940 while (cval
->res
> 1) {
941 if (snd_usb_mixer_set_ctl_value(cval
, UAC_SET_RES
,
942 (cval
->control
<< 8) | minchn
, cval
->res
/ 2) < 0)
946 if (get_ctl_value(cval
, UAC_GET_RES
, (cval
->control
<< 8) | minchn
, &cval
->res
) < 0)
947 cval
->res
= last_valid_res
;
952 /* Additional checks for the proper resolution
954 * Some devices report smaller resolutions than actually
955 * reacting. They don't return errors but simply clip
956 * to the lower aligned value.
958 if (cval
->min
+ cval
->res
< cval
->max
) {
959 int last_valid_res
= cval
->res
;
960 int saved
, test
, check
;
961 get_cur_mix_raw(cval
, minchn
, &saved
);
964 if (test
< cval
->max
)
968 if (test
< cval
->min
|| test
> cval
->max
||
969 set_cur_mix_value(cval
, minchn
, 0, test
) ||
970 get_cur_mix_raw(cval
, minchn
, &check
)) {
971 cval
->res
= last_valid_res
;
978 set_cur_mix_value(cval
, minchn
, 0, saved
);
981 cval
->initialized
= 1;
985 volume_control_quirks(cval
, kctl
);
987 /* USB descriptions contain the dB scale in 1/256 dB unit
988 * while ALSA TLV contains in 1/100 dB unit
990 cval
->dBmin
= (convert_signed_value(cval
, cval
->min
) * 100) / 256;
991 cval
->dBmax
= (convert_signed_value(cval
, cval
->max
) * 100) / 256;
992 if (cval
->dBmin
> cval
->dBmax
) {
993 /* something is wrong; assume it's either from/to 0dB */
996 else if (cval
->dBmin
> 0)
998 if (cval
->dBmin
> cval
->dBmax
) {
999 /* totally crap, return an error */
1007 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1009 /* get a feature/mixer unit info */
1010 static int mixer_ctl_feature_info(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_info
*uinfo
)
1012 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1014 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1015 cval
->val_type
== USB_MIXER_INV_BOOLEAN
)
1016 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1018 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
1019 uinfo
->count
= cval
->channels
;
1020 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1021 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
1022 uinfo
->value
.integer
.min
= 0;
1023 uinfo
->value
.integer
.max
= 1;
1025 if (!cval
->initialized
) {
1026 get_min_max_with_quirks(cval
, 0, kcontrol
);
1027 if (cval
->initialized
&& cval
->dBmin
>= cval
->dBmax
) {
1028 kcontrol
->vd
[0].access
&=
1029 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1030 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
);
1031 snd_ctl_notify(cval
->mixer
->chip
->card
,
1032 SNDRV_CTL_EVENT_MASK_INFO
,
1036 uinfo
->value
.integer
.min
= 0;
1037 uinfo
->value
.integer
.max
=
1038 (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
1043 /* get the current value from feature/mixer unit */
1044 static int mixer_ctl_feature_get(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1046 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1047 int c
, cnt
, val
, err
;
1049 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1052 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1053 if (!(cval
->cmask
& (1 << c
)))
1055 err
= get_cur_mix_value(cval
, c
+ 1, cnt
, &val
);
1057 return cval
->mixer
->ignore_ctl_error
? 0 : err
;
1058 val
= get_relative_value(cval
, val
);
1059 ucontrol
->value
.integer
.value
[cnt
] = val
;
1064 /* master channel */
1065 err
= get_cur_mix_value(cval
, 0, 0, &val
);
1067 return cval
->mixer
->ignore_ctl_error
? 0 : err
;
1068 val
= get_relative_value(cval
, val
);
1069 ucontrol
->value
.integer
.value
[0] = val
;
1074 /* put the current value to feature/mixer unit */
1075 static int mixer_ctl_feature_put(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1077 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1078 int c
, cnt
, val
, oval
, err
;
1083 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1084 if (!(cval
->cmask
& (1 << c
)))
1086 err
= get_cur_mix_value(cval
, c
+ 1, cnt
, &oval
);
1088 return cval
->mixer
->ignore_ctl_error
? 0 : err
;
1089 val
= ucontrol
->value
.integer
.value
[cnt
];
1090 val
= get_abs_value(cval
, val
);
1092 set_cur_mix_value(cval
, c
+ 1, cnt
, val
);
1098 /* master channel */
1099 err
= get_cur_mix_value(cval
, 0, 0, &oval
);
1101 return cval
->mixer
->ignore_ctl_error
? 0 : err
;
1102 val
= ucontrol
->value
.integer
.value
[0];
1103 val
= get_abs_value(cval
, val
);
1105 set_cur_mix_value(cval
, 0, 0, val
);
1112 static struct snd_kcontrol_new usb_feature_unit_ctl
= {
1113 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1114 .name
= "", /* will be filled later manually */
1115 .info
= mixer_ctl_feature_info
,
1116 .get
= mixer_ctl_feature_get
,
1117 .put
= mixer_ctl_feature_put
,
1120 /* the read-only variant */
1121 static struct snd_kcontrol_new usb_feature_unit_ctl_ro
= {
1122 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1123 .name
= "", /* will be filled later manually */
1124 .info
= mixer_ctl_feature_info
,
1125 .get
= mixer_ctl_feature_get
,
1129 /* This symbol is exported in order to allow the mixer quirks to
1130 * hook up to the standard feature unit control mechanism */
1131 struct snd_kcontrol_new
*snd_usb_feature_unit_ctl
= &usb_feature_unit_ctl
;
1134 * build a feature control
1137 static size_t append_ctl_name(struct snd_kcontrol
*kctl
, const char *str
)
1139 return strlcat(kctl
->id
.name
, str
, sizeof(kctl
->id
.name
));
1142 /* A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1143 rename it to "Headphone". We determine if something is a headphone
1144 similar to how udev determines form factor. */
1145 static void check_no_speaker_on_headset(struct snd_kcontrol
*kctl
,
1146 struct snd_card
*card
)
1148 const char *names_to_check
[] = {
1149 "Headset", "headset", "Headphone", "headphone", NULL
};
1153 if (strcmp("Speaker", kctl
->id
.name
))
1156 for (s
= names_to_check
; *s
; s
++)
1157 if (strstr(card
->shortname
, *s
)) {
1165 strlcpy(kctl
->id
.name
, "Headphone", sizeof(kctl
->id
.name
));
1168 static void build_feature_ctl(struct mixer_build
*state
, void *raw_desc
,
1169 unsigned int ctl_mask
, int control
,
1170 struct usb_audio_term
*iterm
, int unitid
,
1173 struct uac_feature_unit_descriptor
*desc
= raw_desc
;
1174 unsigned int len
= 0;
1175 int mapped_name
= 0;
1176 int nameid
= uac_feature_unit_iFeature(desc
);
1177 struct snd_kcontrol
*kctl
;
1178 struct usb_mixer_elem_info
*cval
;
1179 const struct usbmix_name_map
*map
;
1182 control
++; /* change from zero-based to 1-based value */
1184 if (control
== UAC_FU_GRAPHIC_EQUALIZER
) {
1185 /* FIXME: not supported yet */
1189 map
= find_map(state
, unitid
, control
);
1190 if (check_ignored_ctl(map
))
1193 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1195 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1198 cval
->mixer
= state
->mixer
;
1200 cval
->control
= control
;
1201 cval
->cmask
= ctl_mask
;
1202 cval
->val_type
= audio_feature_info
[control
-1].type
;
1203 if (ctl_mask
== 0) {
1204 cval
->channels
= 1; /* master channel */
1205 cval
->master_readonly
= readonly_mask
;
1208 for (i
= 0; i
< 16; i
++)
1209 if (ctl_mask
& (1 << i
))
1212 cval
->ch_readonly
= readonly_mask
;
1215 /* if all channels in the mask are marked read-only, make the control
1216 * read-only. set_cur_mix_value() will check the mask again and won't
1217 * issue write commands to read-only channels. */
1218 if (cval
->channels
== readonly_mask
)
1219 kctl
= snd_ctl_new1(&usb_feature_unit_ctl_ro
, cval
);
1221 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1224 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1228 kctl
->private_free
= usb_mixer_elem_free
;
1230 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1231 mapped_name
= len
!= 0;
1232 if (! len
&& nameid
)
1233 len
= snd_usb_copy_string_desc(state
, nameid
,
1234 kctl
->id
.name
, sizeof(kctl
->id
.name
));
1239 /* determine the control name. the rule is:
1240 * - if a name id is given in descriptor, use it.
1241 * - if the connected input can be determined, then use the name
1243 * - if the connected output can be determined, use it.
1244 * - otherwise, anonymous name.
1247 len
= get_term_name(state
, iterm
, kctl
->id
.name
, sizeof(kctl
->id
.name
), 1);
1249 len
= get_term_name(state
, &state
->oterm
, kctl
->id
.name
, sizeof(kctl
->id
.name
), 1);
1251 len
= snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1252 "Feature %d", unitid
);
1256 check_no_speaker_on_headset(kctl
, state
->mixer
->chip
->card
);
1258 /* determine the stream direction:
1259 * if the connected output is USB stream, then it's likely a
1260 * capture stream. otherwise it should be playback (hopefully :)
1262 if (! mapped_name
&& ! (state
->oterm
.type
>> 16)) {
1263 if ((state
->oterm
.type
& 0xff00) == 0x0100) {
1264 len
= append_ctl_name(kctl
, " Capture");
1266 len
= append_ctl_name(kctl
, " Playback");
1269 append_ctl_name(kctl
, control
== UAC_FU_MUTE
?
1270 " Switch" : " Volume");
1274 strlcpy(kctl
->id
.name
, audio_feature_info
[control
-1].name
,
1275 sizeof(kctl
->id
.name
));
1279 /* get min/max values */
1280 get_min_max_with_quirks(cval
, 0, kctl
);
1282 if (control
== UAC_FU_VOLUME
) {
1283 check_mapped_dB(map
, cval
);
1284 if (cval
->dBmin
< cval
->dBmax
|| !cval
->initialized
) {
1285 kctl
->tlv
.c
= snd_usb_mixer_vol_tlv
;
1286 kctl
->vd
[0].access
|=
1287 SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1288 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
;
1292 range
= (cval
->max
- cval
->min
) / cval
->res
;
1293 /* Are there devices with volume range more than 255? I use a bit more
1294 * to be sure. 384 is a resolution magic number found on Logitech
1295 * devices. It will definitively catch all buggy Logitech devices.
1298 snd_printk(KERN_WARNING
"usb_audio: Warning! Unlikely big "
1299 "volume range (=%u), cval->res is probably wrong.",
1301 snd_printk(KERN_WARNING
"usb_audio: [%d] FU [%s] ch = %d, "
1302 "val = %d/%d/%d", cval
->id
,
1303 kctl
->id
.name
, cval
->channels
,
1304 cval
->min
, cval
->max
, cval
->res
);
1307 snd_printdd(KERN_INFO
"[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1308 cval
->id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
, cval
->res
);
1309 snd_usb_mixer_add_control(state
->mixer
, kctl
);
1315 * parse a feature unit
1317 * most of controls are defined here.
1319 static int parse_audio_feature_unit(struct mixer_build
*state
, int unitid
, void *_ftr
)
1322 struct usb_audio_term iterm
;
1323 unsigned int master_bits
, first_ch_bits
;
1325 struct uac_feature_unit_descriptor
*hdr
= _ftr
;
1328 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1329 csize
= hdr
->bControlSize
;
1331 snd_printdd(KERN_ERR
"usbaudio: unit %u: "
1332 "invalid bControlSize == 0\n", unitid
);
1335 channels
= (hdr
->bLength
- 7) / csize
- 1;
1336 bmaControls
= hdr
->bmaControls
;
1337 if (hdr
->bLength
< 7 + csize
) {
1338 snd_printk(KERN_ERR
"usbaudio: unit %u: "
1339 "invalid UAC_FEATURE_UNIT descriptor\n",
1344 struct uac2_feature_unit_descriptor
*ftr
= _ftr
;
1346 channels
= (hdr
->bLength
- 6) / 4 - 1;
1347 bmaControls
= ftr
->bmaControls
;
1348 if (hdr
->bLength
< 6 + csize
) {
1349 snd_printk(KERN_ERR
"usbaudio: unit %u: "
1350 "invalid UAC_FEATURE_UNIT descriptor\n",
1356 /* parse the source unit */
1357 if ((err
= parse_audio_unit(state
, hdr
->bSourceID
)) < 0)
1360 /* determine the input source type and name */
1361 err
= check_input_term(state
, hdr
->bSourceID
, &iterm
);
1365 master_bits
= snd_usb_combine_bytes(bmaControls
, csize
);
1366 /* master configuration quirks */
1367 switch (state
->chip
->usb_id
) {
1368 case USB_ID(0x08bb, 0x2702):
1369 snd_printk(KERN_INFO
1370 "usbmixer: master volume quirk for PCM2702 chip\n");
1371 /* disable non-functional volume control */
1372 master_bits
&= ~UAC_CONTROL_BIT(UAC_FU_VOLUME
);
1374 case USB_ID(0x1130, 0xf211):
1375 snd_printk(KERN_INFO
1376 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1377 /* disable non-functional volume control */
1383 first_ch_bits
= snd_usb_combine_bytes(bmaControls
+ csize
, csize
);
1387 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1388 /* check all control types */
1389 for (i
= 0; i
< 10; i
++) {
1390 unsigned int ch_bits
= 0;
1391 for (j
= 0; j
< channels
; j
++) {
1392 unsigned int mask
= snd_usb_combine_bytes(bmaControls
+ csize
* (j
+1), csize
);
1393 if (mask
& (1 << i
))
1394 ch_bits
|= (1 << j
);
1396 /* audio class v1 controls are never read-only */
1397 if (ch_bits
& 1) /* the first channel must be set (for ease of programming) */
1398 build_feature_ctl(state
, _ftr
, ch_bits
, i
, &iterm
, unitid
, 0);
1399 if (master_bits
& (1 << i
))
1400 build_feature_ctl(state
, _ftr
, 0, i
, &iterm
, unitid
, 0);
1402 } else { /* UAC_VERSION_2 */
1403 for (i
= 0; i
< ARRAY_SIZE(audio_feature_info
); i
++) {
1404 unsigned int ch_bits
= 0;
1405 unsigned int ch_read_only
= 0;
1407 for (j
= 0; j
< channels
; j
++) {
1408 unsigned int mask
= snd_usb_combine_bytes(bmaControls
+ csize
* (j
+1), csize
);
1409 if (uac2_control_is_readable(mask
, i
)) {
1410 ch_bits
|= (1 << j
);
1411 if (!uac2_control_is_writeable(mask
, i
))
1412 ch_read_only
|= (1 << j
);
1416 /* NOTE: build_feature_ctl() will mark the control read-only if all channels
1417 * are marked read-only in the descriptors. Otherwise, the control will be
1418 * reported as writeable, but the driver will not actually issue a write
1419 * command for read-only channels */
1420 if (ch_bits
& 1) /* the first channel must be set (for ease of programming) */
1421 build_feature_ctl(state
, _ftr
, ch_bits
, i
, &iterm
, unitid
, ch_read_only
);
1422 if (uac2_control_is_readable(master_bits
, i
))
1423 build_feature_ctl(state
, _ftr
, 0, i
, &iterm
, unitid
,
1424 !uac2_control_is_writeable(master_bits
, i
));
1437 * build a mixer unit control
1439 * the callbacks are identical with feature unit.
1440 * input channel number (zero based) is given in control field instead.
1443 static void build_mixer_unit_ctl(struct mixer_build
*state
,
1444 struct uac_mixer_unit_descriptor
*desc
,
1445 int in_pin
, int in_ch
, int unitid
,
1446 struct usb_audio_term
*iterm
)
1448 struct usb_mixer_elem_info
*cval
;
1449 unsigned int num_outs
= uac_mixer_unit_bNrChannels(desc
);
1450 unsigned int i
, len
;
1451 struct snd_kcontrol
*kctl
;
1452 const struct usbmix_name_map
*map
;
1454 map
= find_map(state
, unitid
, 0);
1455 if (check_ignored_ctl(map
))
1458 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1462 cval
->mixer
= state
->mixer
;
1464 cval
->control
= in_ch
+ 1; /* based on 1 */
1465 cval
->val_type
= USB_MIXER_S16
;
1466 for (i
= 0; i
< num_outs
; i
++) {
1467 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc
, state
->mixer
->protocol
), in_ch
, i
, num_outs
)) {
1468 cval
->cmask
|= (1 << i
);
1473 /* get min/max values */
1474 get_min_max(cval
, 0);
1476 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1478 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1482 kctl
->private_free
= usb_mixer_elem_free
;
1484 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1486 len
= get_term_name(state
, iterm
, kctl
->id
.name
, sizeof(kctl
->id
.name
), 0);
1488 len
= sprintf(kctl
->id
.name
, "Mixer Source %d", in_ch
+ 1);
1489 append_ctl_name(kctl
, " Volume");
1491 snd_printdd(KERN_INFO
"[%d] MU [%s] ch = %d, val = %d/%d\n",
1492 cval
->id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
);
1493 snd_usb_mixer_add_control(state
->mixer
, kctl
);
1498 * parse a mixer unit
1500 static int parse_audio_mixer_unit(struct mixer_build
*state
, int unitid
, void *raw_desc
)
1502 struct uac_mixer_unit_descriptor
*desc
= raw_desc
;
1503 struct usb_audio_term iterm
;
1504 int input_pins
, num_ins
, num_outs
;
1507 if (desc
->bLength
< 11 || ! (input_pins
= desc
->bNrInPins
) || ! (num_outs
= uac_mixer_unit_bNrChannels(desc
))) {
1508 snd_printk(KERN_ERR
"invalid MIXER UNIT descriptor %d\n", unitid
);
1511 /* no bmControls field (e.g. Maya44) -> ignore */
1512 if (desc
->bLength
<= 10 + input_pins
) {
1513 snd_printdd(KERN_INFO
"MU %d has no bmControls field\n", unitid
);
1519 for (pin
= 0; pin
< input_pins
; pin
++) {
1520 err
= parse_audio_unit(state
, desc
->baSourceID
[pin
]);
1523 err
= check_input_term(state
, desc
->baSourceID
[pin
], &iterm
);
1526 num_ins
+= iterm
.channels
;
1527 for (; ich
< num_ins
; ++ich
) {
1528 int och
, ich_has_controls
= 0;
1530 for (och
= 0; och
< num_outs
; ++och
) {
1531 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc
, state
->mixer
->protocol
),
1532 ich
, och
, num_outs
)) {
1533 ich_has_controls
= 1;
1537 if (ich_has_controls
)
1538 build_mixer_unit_ctl(state
, desc
, pin
, ich
,
1547 * Processing Unit / Extension Unit
1550 /* get callback for processing/extension unit */
1551 static int mixer_ctl_procunit_get(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1553 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1556 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
1557 if (err
< 0 && cval
->mixer
->ignore_ctl_error
) {
1558 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1563 val
= get_relative_value(cval
, val
);
1564 ucontrol
->value
.integer
.value
[0] = val
;
1568 /* put callback for processing/extension unit */
1569 static int mixer_ctl_procunit_put(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1571 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1574 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
1576 if (cval
->mixer
->ignore_ctl_error
)
1580 val
= ucontrol
->value
.integer
.value
[0];
1581 val
= get_abs_value(cval
, val
);
1583 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
1589 /* alsa control interface for processing/extension unit */
1590 static struct snd_kcontrol_new mixer_procunit_ctl
= {
1591 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1592 .name
= "", /* will be filled later */
1593 .info
= mixer_ctl_feature_info
,
1594 .get
= mixer_ctl_procunit_get
,
1595 .put
= mixer_ctl_procunit_put
,
1600 * predefined data for processing units
1602 struct procunit_value_info
{
1609 struct procunit_info
{
1612 struct procunit_value_info
*values
;
1615 static struct procunit_value_info updown_proc_info
[] = {
1616 { UAC_UD_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1617 { UAC_UD_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
1620 static struct procunit_value_info prologic_proc_info
[] = {
1621 { UAC_DP_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1622 { UAC_DP_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
1625 static struct procunit_value_info threed_enh_proc_info
[] = {
1626 { UAC_3D_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1627 { UAC_3D_SPACE
, "Spaciousness", USB_MIXER_U8
},
1630 static struct procunit_value_info reverb_proc_info
[] = {
1631 { UAC_REVERB_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1632 { UAC_REVERB_LEVEL
, "Level", USB_MIXER_U8
},
1633 { UAC_REVERB_TIME
, "Time", USB_MIXER_U16
},
1634 { UAC_REVERB_FEEDBACK
, "Feedback", USB_MIXER_U8
},
1637 static struct procunit_value_info chorus_proc_info
[] = {
1638 { UAC_CHORUS_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1639 { UAC_CHORUS_LEVEL
, "Level", USB_MIXER_U8
},
1640 { UAC_CHORUS_RATE
, "Rate", USB_MIXER_U16
},
1641 { UAC_CHORUS_DEPTH
, "Depth", USB_MIXER_U16
},
1644 static struct procunit_value_info dcr_proc_info
[] = {
1645 { UAC_DCR_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1646 { UAC_DCR_RATE
, "Ratio", USB_MIXER_U16
},
1647 { UAC_DCR_MAXAMPL
, "Max Amp", USB_MIXER_S16
},
1648 { UAC_DCR_THRESHOLD
, "Threshold", USB_MIXER_S16
},
1649 { UAC_DCR_ATTACK_TIME
, "Attack Time", USB_MIXER_U16
},
1650 { UAC_DCR_RELEASE_TIME
, "Release Time", USB_MIXER_U16
},
1654 static struct procunit_info procunits
[] = {
1655 { UAC_PROCESS_UP_DOWNMIX
, "Up Down", updown_proc_info
},
1656 { UAC_PROCESS_DOLBY_PROLOGIC
, "Dolby Prologic", prologic_proc_info
},
1657 { UAC_PROCESS_STEREO_EXTENDER
, "3D Stereo Extender", threed_enh_proc_info
},
1658 { UAC_PROCESS_REVERB
, "Reverb", reverb_proc_info
},
1659 { UAC_PROCESS_CHORUS
, "Chorus", chorus_proc_info
},
1660 { UAC_PROCESS_DYN_RANGE_COMP
, "DCR", dcr_proc_info
},
1664 * predefined data for extension units
1666 static struct procunit_value_info clock_rate_xu_info
[] = {
1667 { USB_XU_CLOCK_RATE_SELECTOR
, "Selector", USB_MIXER_U8
, 0 },
1670 static struct procunit_value_info clock_source_xu_info
[] = {
1671 { USB_XU_CLOCK_SOURCE_SELECTOR
, "External", USB_MIXER_BOOLEAN
},
1674 static struct procunit_value_info spdif_format_xu_info
[] = {
1675 { USB_XU_DIGITAL_FORMAT_SELECTOR
, "SPDIF/AC3", USB_MIXER_BOOLEAN
},
1678 static struct procunit_value_info soft_limit_xu_info
[] = {
1679 { USB_XU_SOFT_LIMIT_SELECTOR
, " ", USB_MIXER_BOOLEAN
},
1682 static struct procunit_info extunits
[] = {
1683 { USB_XU_CLOCK_RATE
, "Clock rate", clock_rate_xu_info
},
1684 { USB_XU_CLOCK_SOURCE
, "DigitalIn CLK source", clock_source_xu_info
},
1685 { USB_XU_DIGITAL_IO_STATUS
, "DigitalOut format:", spdif_format_xu_info
},
1686 { USB_XU_DEVICE_OPTIONS
, "AnalogueIn Soft Limit", soft_limit_xu_info
},
1690 * build a processing/extension unit
1692 static int build_audio_procunit(struct mixer_build
*state
, int unitid
, void *raw_desc
, struct procunit_info
*list
, char *name
)
1694 struct uac_processing_unit_descriptor
*desc
= raw_desc
;
1695 int num_ins
= desc
->bNrInPins
;
1696 struct usb_mixer_elem_info
*cval
;
1697 struct snd_kcontrol
*kctl
;
1698 int i
, err
, nameid
, type
, len
;
1699 struct procunit_info
*info
;
1700 struct procunit_value_info
*valinfo
;
1701 const struct usbmix_name_map
*map
;
1702 static struct procunit_value_info default_value_info
[] = {
1703 { 0x01, "Switch", USB_MIXER_BOOLEAN
},
1706 static struct procunit_info default_info
= {
1707 0, NULL
, default_value_info
1710 if (desc
->bLength
< 13 || desc
->bLength
< 13 + num_ins
||
1711 desc
->bLength
< num_ins
+ uac_processing_unit_bControlSize(desc
, state
->mixer
->protocol
)) {
1712 snd_printk(KERN_ERR
"invalid %s descriptor (id %d)\n", name
, unitid
);
1716 for (i
= 0; i
< num_ins
; i
++) {
1717 if ((err
= parse_audio_unit(state
, desc
->baSourceID
[i
])) < 0)
1721 type
= le16_to_cpu(desc
->wProcessType
);
1722 for (info
= list
; info
&& info
->type
; info
++)
1723 if (info
->type
== type
)
1725 if (! info
|| ! info
->type
)
1726 info
= &default_info
;
1728 for (valinfo
= info
->values
; valinfo
->control
; valinfo
++) {
1729 __u8
*controls
= uac_processing_unit_bmControls(desc
, state
->mixer
->protocol
);
1731 if (! (controls
[valinfo
->control
/ 8] & (1 << ((valinfo
->control
% 8) - 1))))
1733 map
= find_map(state
, unitid
, valinfo
->control
);
1734 if (check_ignored_ctl(map
))
1736 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1738 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1741 cval
->mixer
= state
->mixer
;
1743 cval
->control
= valinfo
->control
;
1744 cval
->val_type
= valinfo
->val_type
;
1747 /* get min/max values */
1748 if (type
== UAC_PROCESS_UP_DOWNMIX
&& cval
->control
== UAC_UD_MODE_SELECT
) {
1749 __u8
*control_spec
= uac_processing_unit_specific(desc
, state
->mixer
->protocol
);
1750 /* FIXME: hard-coded */
1752 cval
->max
= control_spec
[0];
1754 cval
->initialized
= 1;
1756 if (type
== USB_XU_CLOCK_RATE
) {
1757 /* E-Mu USB 0404/0202/TrackerPre/0204
1758 * samplerate control quirk
1763 cval
->initialized
= 1;
1765 get_min_max(cval
, valinfo
->min_value
);
1768 kctl
= snd_ctl_new1(&mixer_procunit_ctl
, cval
);
1770 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1774 kctl
->private_free
= usb_mixer_elem_free
;
1776 if (check_mapped_name(map
, kctl
->id
.name
,
1777 sizeof(kctl
->id
.name
)))
1779 else if (info
->name
)
1780 strlcpy(kctl
->id
.name
, info
->name
, sizeof(kctl
->id
.name
));
1782 nameid
= uac_processing_unit_iProcessing(desc
, state
->mixer
->protocol
);
1785 len
= snd_usb_copy_string_desc(state
, nameid
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1787 strlcpy(kctl
->id
.name
, name
, sizeof(kctl
->id
.name
));
1789 append_ctl_name(kctl
, " ");
1790 append_ctl_name(kctl
, valinfo
->suffix
);
1792 snd_printdd(KERN_INFO
"[%d] PU [%s] ch = %d, val = %d/%d\n",
1793 cval
->id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
);
1794 if ((err
= snd_usb_mixer_add_control(state
->mixer
, kctl
)) < 0)
1801 static int parse_audio_processing_unit(struct mixer_build
*state
, int unitid
, void *raw_desc
)
1803 return build_audio_procunit(state
, unitid
, raw_desc
, procunits
, "Processing Unit");
1806 static int parse_audio_extension_unit(struct mixer_build
*state
, int unitid
, void *raw_desc
)
1808 /* Note that we parse extension units with processing unit descriptors.
1809 * That's ok as the layout is the same */
1810 return build_audio_procunit(state
, unitid
, raw_desc
, extunits
, "Extension Unit");
1818 /* info callback for selector unit
1819 * use an enumerator type for routing
1821 static int mixer_ctl_selector_info(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_info
*uinfo
)
1823 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1824 const char **itemlist
= (const char **)kcontrol
->private_value
;
1826 if (snd_BUG_ON(!itemlist
))
1828 return snd_ctl_enum_info(uinfo
, 1, cval
->max
, itemlist
);
1831 /* get callback for selector unit */
1832 static int mixer_ctl_selector_get(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1834 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1837 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
1839 if (cval
->mixer
->ignore_ctl_error
) {
1840 ucontrol
->value
.enumerated
.item
[0] = 0;
1845 val
= get_relative_value(cval
, val
);
1846 ucontrol
->value
.enumerated
.item
[0] = val
;
1850 /* put callback for selector unit */
1851 static int mixer_ctl_selector_put(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1853 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1856 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
1858 if (cval
->mixer
->ignore_ctl_error
)
1862 val
= ucontrol
->value
.enumerated
.item
[0];
1863 val
= get_abs_value(cval
, val
);
1865 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
1871 /* alsa control interface for selector unit */
1872 static struct snd_kcontrol_new mixer_selectunit_ctl
= {
1873 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1874 .name
= "", /* will be filled later */
1875 .info
= mixer_ctl_selector_info
,
1876 .get
= mixer_ctl_selector_get
,
1877 .put
= mixer_ctl_selector_put
,
1881 /* private free callback.
1882 * free both private_data and private_value
1884 static void usb_mixer_selector_elem_free(struct snd_kcontrol
*kctl
)
1888 if (kctl
->private_data
) {
1889 struct usb_mixer_elem_info
*cval
= kctl
->private_data
;
1890 num_ins
= cval
->max
;
1892 kctl
->private_data
= NULL
;
1894 if (kctl
->private_value
) {
1895 char **itemlist
= (char **)kctl
->private_value
;
1896 for (i
= 0; i
< num_ins
; i
++)
1899 kctl
->private_value
= 0;
1904 * parse a selector unit
1906 static int parse_audio_selector_unit(struct mixer_build
*state
, int unitid
, void *raw_desc
)
1908 struct uac_selector_unit_descriptor
*desc
= raw_desc
;
1909 unsigned int i
, nameid
, len
;
1911 struct usb_mixer_elem_info
*cval
;
1912 struct snd_kcontrol
*kctl
;
1913 const struct usbmix_name_map
*map
;
1916 if (!desc
->bNrInPins
|| desc
->bLength
< 5 + desc
->bNrInPins
) {
1917 snd_printk(KERN_ERR
"invalid SELECTOR UNIT descriptor %d\n", unitid
);
1921 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
1922 if ((err
= parse_audio_unit(state
, desc
->baSourceID
[i
])) < 0)
1926 if (desc
->bNrInPins
== 1) /* only one ? nonsense! */
1929 map
= find_map(state
, unitid
, 0);
1930 if (check_ignored_ctl(map
))
1933 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1935 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1938 cval
->mixer
= state
->mixer
;
1940 cval
->val_type
= USB_MIXER_U8
;
1943 cval
->max
= desc
->bNrInPins
;
1945 cval
->initialized
= 1;
1947 if (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
)
1948 cval
->control
= UAC2_CX_CLOCK_SELECTOR
;
1952 namelist
= kmalloc(sizeof(char *) * desc
->bNrInPins
, GFP_KERNEL
);
1954 snd_printk(KERN_ERR
"cannot malloc\n");
1958 #define MAX_ITEM_NAME_LEN 64
1959 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
1960 struct usb_audio_term iterm
;
1962 namelist
[i
] = kmalloc(MAX_ITEM_NAME_LEN
, GFP_KERNEL
);
1963 if (! namelist
[i
]) {
1964 snd_printk(KERN_ERR
"cannot malloc\n");
1971 len
= check_mapped_selector_name(state
, unitid
, i
, namelist
[i
],
1973 if (! len
&& check_input_term(state
, desc
->baSourceID
[i
], &iterm
) >= 0)
1974 len
= get_term_name(state
, &iterm
, namelist
[i
], MAX_ITEM_NAME_LEN
, 0);
1976 sprintf(namelist
[i
], "Input %d", i
);
1979 kctl
= snd_ctl_new1(&mixer_selectunit_ctl
, cval
);
1981 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1986 kctl
->private_value
= (unsigned long)namelist
;
1987 kctl
->private_free
= usb_mixer_selector_elem_free
;
1989 nameid
= uac_selector_unit_iSelector(desc
);
1990 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1994 snd_usb_copy_string_desc(state
, nameid
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1996 len
= get_term_name(state
, &state
->oterm
,
1997 kctl
->id
.name
, sizeof(kctl
->id
.name
), 0);
1999 strlcpy(kctl
->id
.name
, "USB", sizeof(kctl
->id
.name
));
2001 if (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
)
2002 append_ctl_name(kctl
, " Clock Source");
2003 else if ((state
->oterm
.type
& 0xff00) == 0x0100)
2004 append_ctl_name(kctl
, " Capture Source");
2006 append_ctl_name(kctl
, " Playback Source");
2009 snd_printdd(KERN_INFO
"[%d] SU [%s] items = %d\n",
2010 cval
->id
, kctl
->id
.name
, desc
->bNrInPins
);
2011 if ((err
= snd_usb_mixer_add_control(state
->mixer
, kctl
)) < 0)
2019 * parse an audio unit recursively
2022 static int parse_audio_unit(struct mixer_build
*state
, int unitid
)
2026 if (test_and_set_bit(unitid
, state
->unitbitmap
))
2027 return 0; /* the unit already visited */
2029 p1
= find_audio_control_unit(state
, unitid
);
2031 snd_printk(KERN_ERR
"usbaudio: unit %d not found!\n", unitid
);
2036 case UAC_INPUT_TERMINAL
:
2037 case UAC2_CLOCK_SOURCE
:
2039 case UAC_MIXER_UNIT
:
2040 return parse_audio_mixer_unit(state
, unitid
, p1
);
2041 case UAC_SELECTOR_UNIT
:
2042 case UAC2_CLOCK_SELECTOR
:
2043 return parse_audio_selector_unit(state
, unitid
, p1
);
2044 case UAC_FEATURE_UNIT
:
2045 return parse_audio_feature_unit(state
, unitid
, p1
);
2046 case UAC1_PROCESSING_UNIT
:
2047 /* UAC2_EFFECT_UNIT has the same value */
2048 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2049 return parse_audio_processing_unit(state
, unitid
, p1
);
2051 return 0; /* FIXME - effect units not implemented yet */
2052 case UAC1_EXTENSION_UNIT
:
2053 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2054 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2055 return parse_audio_extension_unit(state
, unitid
, p1
);
2056 else /* UAC_VERSION_2 */
2057 return parse_audio_processing_unit(state
, unitid
, p1
);
2058 case UAC2_EXTENSION_UNIT_V2
:
2059 return parse_audio_extension_unit(state
, unitid
, p1
);
2061 snd_printk(KERN_ERR
"usbaudio: unit %u: unexpected type 0x%02x\n", unitid
, p1
[2]);
2066 static void snd_usb_mixer_free(struct usb_mixer_interface
*mixer
)
2068 kfree(mixer
->id_elems
);
2070 kfree(mixer
->urb
->transfer_buffer
);
2071 usb_free_urb(mixer
->urb
);
2073 usb_free_urb(mixer
->rc_urb
);
2074 kfree(mixer
->rc_setup_packet
);
2078 static int snd_usb_mixer_dev_free(struct snd_device
*device
)
2080 struct usb_mixer_interface
*mixer
= device
->device_data
;
2081 snd_usb_mixer_free(mixer
);
2086 * create mixer controls
2088 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2090 static int snd_usb_mixer_controls(struct usb_mixer_interface
*mixer
)
2092 struct mixer_build state
;
2094 const struct usbmix_ctl_map
*map
;
2097 memset(&state
, 0, sizeof(state
));
2098 state
.chip
= mixer
->chip
;
2099 state
.mixer
= mixer
;
2100 state
.buffer
= mixer
->hostif
->extra
;
2101 state
.buflen
= mixer
->hostif
->extralen
;
2103 /* check the mapping table */
2104 for (map
= usbmix_ctl_maps
; map
->id
; map
++) {
2105 if (map
->id
== state
.chip
->usb_id
) {
2106 state
.map
= map
->map
;
2107 state
.selector_map
= map
->selector_map
;
2108 mixer
->ignore_ctl_error
= map
->ignore_ctl_error
;
2114 while ((p
= snd_usb_find_csint_desc(mixer
->hostif
->extra
, mixer
->hostif
->extralen
,
2115 p
, UAC_OUTPUT_TERMINAL
)) != NULL
) {
2116 if (mixer
->protocol
== UAC_VERSION_1
) {
2117 struct uac1_output_terminal_descriptor
*desc
= p
;
2119 if (desc
->bLength
< sizeof(*desc
))
2120 continue; /* invalid descriptor? */
2121 set_bit(desc
->bTerminalID
, state
.unitbitmap
); /* mark terminal ID as visited */
2122 state
.oterm
.id
= desc
->bTerminalID
;
2123 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
2124 state
.oterm
.name
= desc
->iTerminal
;
2125 err
= parse_audio_unit(&state
, desc
->bSourceID
);
2126 if (err
< 0 && err
!= -EINVAL
)
2128 } else { /* UAC_VERSION_2 */
2129 struct uac2_output_terminal_descriptor
*desc
= p
;
2131 if (desc
->bLength
< sizeof(*desc
))
2132 continue; /* invalid descriptor? */
2133 set_bit(desc
->bTerminalID
, state
.unitbitmap
); /* mark terminal ID as visited */
2134 state
.oterm
.id
= desc
->bTerminalID
;
2135 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
2136 state
.oterm
.name
= desc
->iTerminal
;
2137 err
= parse_audio_unit(&state
, desc
->bSourceID
);
2138 if (err
< 0 && err
!= -EINVAL
)
2141 /* for UAC2, use the same approach to also add the clock selectors */
2142 err
= parse_audio_unit(&state
, desc
->bCSourceID
);
2143 if (err
< 0 && err
!= -EINVAL
)
2151 void snd_usb_mixer_notify_id(struct usb_mixer_interface
*mixer
, int unitid
)
2153 struct usb_mixer_elem_info
*info
;
2155 for (info
= mixer
->id_elems
[unitid
]; info
; info
= info
->next_id_elem
)
2156 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
2160 static void snd_usb_mixer_dump_cval(struct snd_info_buffer
*buffer
,
2162 struct usb_mixer_elem_info
*cval
)
2164 static char *val_types
[] = {"BOOLEAN", "INV_BOOLEAN",
2165 "S8", "U8", "S16", "U16"};
2166 snd_iprintf(buffer
, " Unit: %i\n", unitid
);
2168 snd_iprintf(buffer
, " Control: name=\"%s\", index=%i\n",
2169 cval
->elem_id
->name
, cval
->elem_id
->index
);
2170 snd_iprintf(buffer
, " Info: id=%i, control=%i, cmask=0x%x, "
2171 "channels=%i, type=\"%s\"\n", cval
->id
,
2172 cval
->control
, cval
->cmask
, cval
->channels
,
2173 val_types
[cval
->val_type
]);
2174 snd_iprintf(buffer
, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2175 cval
->min
, cval
->max
, cval
->dBmin
, cval
->dBmax
);
2178 static void snd_usb_mixer_proc_read(struct snd_info_entry
*entry
,
2179 struct snd_info_buffer
*buffer
)
2181 struct snd_usb_audio
*chip
= entry
->private_data
;
2182 struct usb_mixer_interface
*mixer
;
2183 struct usb_mixer_elem_info
*cval
;
2186 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
2188 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2189 chip
->usb_id
, snd_usb_ctrl_intf(chip
),
2190 mixer
->ignore_ctl_error
);
2191 snd_iprintf(buffer
, "Card: %s\n", chip
->card
->longname
);
2192 for (unitid
= 0; unitid
< MAX_ID_ELEMS
; unitid
++) {
2193 for (cval
= mixer
->id_elems
[unitid
]; cval
;
2194 cval
= cval
->next_id_elem
)
2195 snd_usb_mixer_dump_cval(buffer
, unitid
, cval
);
2200 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface
*mixer
,
2201 int attribute
, int value
, int index
)
2203 struct usb_mixer_elem_info
*info
;
2204 __u8 unitid
= (index
>> 8) & 0xff;
2205 __u8 control
= (value
>> 8) & 0xff;
2206 __u8 channel
= value
& 0xff;
2208 if (channel
>= MAX_CHANNELS
) {
2209 snd_printk(KERN_DEBUG
"%s(): bogus channel number %d\n",
2214 for (info
= mixer
->id_elems
[unitid
]; info
; info
= info
->next_id_elem
) {
2215 if (info
->control
!= control
)
2218 switch (attribute
) {
2220 /* invalidate cache, so the value is read from the device */
2222 info
->cached
&= ~(1 << channel
);
2223 else /* master channel */
2226 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
2239 snd_printk(KERN_DEBUG
"unknown attribute %d in interrupt\n",
2246 static void snd_usb_mixer_interrupt(struct urb
*urb
)
2248 struct usb_mixer_interface
*mixer
= urb
->context
;
2249 int len
= urb
->actual_length
;
2250 int ustatus
= urb
->status
;
2255 if (mixer
->protocol
== UAC_VERSION_1
) {
2256 struct uac1_status_word
*status
;
2258 for (status
= urb
->transfer_buffer
;
2259 len
>= sizeof(*status
);
2260 len
-= sizeof(*status
), status
++) {
2261 snd_printd(KERN_DEBUG
"status interrupt: %02x %02x\n",
2262 status
->bStatusType
,
2263 status
->bOriginator
);
2265 /* ignore any notifications not from the control interface */
2266 if ((status
->bStatusType
& UAC1_STATUS_TYPE_ORIG_MASK
) !=
2267 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF
)
2270 if (status
->bStatusType
& UAC1_STATUS_TYPE_MEM_CHANGED
)
2271 snd_usb_mixer_rc_memory_change(mixer
, status
->bOriginator
);
2273 snd_usb_mixer_notify_id(mixer
, status
->bOriginator
);
2275 } else { /* UAC_VERSION_2 */
2276 struct uac2_interrupt_data_msg
*msg
;
2278 for (msg
= urb
->transfer_buffer
;
2279 len
>= sizeof(*msg
);
2280 len
-= sizeof(*msg
), msg
++) {
2281 /* drop vendor specific and endpoint requests */
2282 if ((msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_VENDOR
) ||
2283 (msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_EP
))
2286 snd_usb_mixer_interrupt_v2(mixer
, msg
->bAttribute
,
2287 le16_to_cpu(msg
->wValue
),
2288 le16_to_cpu(msg
->wIndex
));
2293 if (ustatus
!= -ENOENT
&& ustatus
!= -ECONNRESET
&& ustatus
!= -ESHUTDOWN
) {
2294 urb
->dev
= mixer
->chip
->dev
;
2295 usb_submit_urb(urb
, GFP_ATOMIC
);
2299 /* stop any bus activity of a mixer */
2300 void snd_usb_mixer_inactivate(struct usb_mixer_interface
*mixer
)
2302 usb_kill_urb(mixer
->urb
);
2303 usb_kill_urb(mixer
->rc_urb
);
2306 int snd_usb_mixer_activate(struct usb_mixer_interface
*mixer
)
2311 err
= usb_submit_urb(mixer
->urb
, GFP_NOIO
);
2319 /* create the handler for the optional status interrupt endpoint */
2320 static int snd_usb_mixer_status_create(struct usb_mixer_interface
*mixer
)
2322 struct usb_endpoint_descriptor
*ep
;
2323 void *transfer_buffer
;
2327 /* we need one interrupt input endpoint */
2328 if (get_iface_desc(mixer
->hostif
)->bNumEndpoints
< 1)
2330 ep
= get_endpoint(mixer
->hostif
, 0);
2331 if (!usb_endpoint_dir_in(ep
) || !usb_endpoint_xfer_int(ep
))
2334 epnum
= usb_endpoint_num(ep
);
2335 buffer_length
= le16_to_cpu(ep
->wMaxPacketSize
);
2336 transfer_buffer
= kmalloc(buffer_length
, GFP_KERNEL
);
2337 if (!transfer_buffer
)
2339 mixer
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
2341 kfree(transfer_buffer
);
2344 usb_fill_int_urb(mixer
->urb
, mixer
->chip
->dev
,
2345 usb_rcvintpipe(mixer
->chip
->dev
, epnum
),
2346 transfer_buffer
, buffer_length
,
2347 snd_usb_mixer_interrupt
, mixer
, ep
->bInterval
);
2348 usb_submit_urb(mixer
->urb
, GFP_KERNEL
);
2352 int snd_usb_create_mixer(struct snd_usb_audio
*chip
, int ctrlif
,
2355 static struct snd_device_ops dev_ops
= {
2356 .dev_free
= snd_usb_mixer_dev_free
2358 struct usb_mixer_interface
*mixer
;
2359 struct snd_info_entry
*entry
;
2362 strcpy(chip
->card
->mixername
, "USB Mixer");
2364 mixer
= kzalloc(sizeof(*mixer
), GFP_KERNEL
);
2368 mixer
->ignore_ctl_error
= ignore_error
;
2369 mixer
->id_elems
= kcalloc(MAX_ID_ELEMS
, sizeof(*mixer
->id_elems
),
2371 if (!mixer
->id_elems
) {
2376 mixer
->hostif
= &usb_ifnum_to_if(chip
->dev
, ctrlif
)->altsetting
[0];
2377 switch (get_iface_desc(mixer
->hostif
)->bInterfaceProtocol
) {
2380 mixer
->protocol
= UAC_VERSION_1
;
2383 mixer
->protocol
= UAC_VERSION_2
;
2387 if ((err
= snd_usb_mixer_controls(mixer
)) < 0 ||
2388 (err
= snd_usb_mixer_status_create(mixer
)) < 0)
2391 snd_usb_mixer_apply_create_quirk(mixer
);
2393 err
= snd_device_new(chip
->card
, SNDRV_DEV_LOWLEVEL
, mixer
, &dev_ops
);
2397 if (list_empty(&chip
->mixer_list
) &&
2398 !snd_card_proc_new(chip
->card
, "usbmixer", &entry
))
2399 snd_info_set_text_ops(entry
, chip
, snd_usb_mixer_proc_read
);
2401 list_add(&mixer
->list
, &chip
->mixer_list
);
2405 snd_usb_mixer_free(mixer
);
2409 void snd_usb_mixer_disconnect(struct list_head
*p
)
2411 struct usb_mixer_interface
*mixer
;
2413 mixer
= list_entry(p
, struct usb_mixer_interface
, list
);
2414 usb_kill_urb(mixer
->urb
);
2415 usb_kill_urb(mixer
->rc_urb
);