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 if (check_input_term(state
, d
->baSourceID
[0], term
) < 0)
720 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
722 term
->name
= uac_selector_unit_iSelector(d
);
725 case UAC1_PROCESSING_UNIT
:
726 case UAC1_EXTENSION_UNIT
:
727 /* UAC2_PROCESSING_UNIT_V2 */
728 /* UAC2_EFFECT_UNIT */ {
729 struct uac_processing_unit_descriptor
*d
= p1
;
731 if (state
->mixer
->protocol
== UAC_VERSION_2
&&
732 hdr
[2] == UAC2_EFFECT_UNIT
) {
733 /* UAC2/UAC1 unit IDs overlap here in an
734 * uncompatible way. Ignore this unit for now.
740 id
= d
->baSourceID
[0];
741 break; /* continue to parse */
743 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
744 term
->channels
= uac_processing_unit_bNrChannels(d
);
745 term
->chconfig
= uac_processing_unit_wChannelConfig(d
, state
->mixer
->protocol
);
746 term
->name
= uac_processing_unit_iProcessing(d
, state
->mixer
->protocol
);
749 case UAC2_CLOCK_SOURCE
: {
750 struct uac_clock_source_descriptor
*d
= p1
;
751 term
->type
= d
->bDescriptorSubtype
<< 16; /* virtual type */
753 term
->name
= d
->iClockSource
;
768 /* feature unit control information */
769 struct usb_feature_control_info
{
771 unsigned int type
; /* control type (mute, volume, etc.) */
774 static struct usb_feature_control_info audio_feature_info
[] = {
775 { "Mute", USB_MIXER_INV_BOOLEAN
},
776 { "Volume", USB_MIXER_S16
},
777 { "Tone Control - Bass", USB_MIXER_S8
},
778 { "Tone Control - Mid", USB_MIXER_S8
},
779 { "Tone Control - Treble", USB_MIXER_S8
},
780 { "Graphic Equalizer", USB_MIXER_S8
}, /* FIXME: not implemeted yet */
781 { "Auto Gain Control", USB_MIXER_BOOLEAN
},
782 { "Delay Control", USB_MIXER_U16
},
783 { "Bass Boost", USB_MIXER_BOOLEAN
},
784 { "Loudness", USB_MIXER_BOOLEAN
},
786 { "Input Gain Control", USB_MIXER_U16
},
787 { "Input Gain Pad Control", USB_MIXER_BOOLEAN
},
788 { "Phase Inverter Control", USB_MIXER_BOOLEAN
},
792 /* private_free callback */
793 static void usb_mixer_elem_free(struct snd_kcontrol
*kctl
)
795 kfree(kctl
->private_data
);
796 kctl
->private_data
= NULL
;
801 * interface to ALSA control for feature/mixer units
804 /* volume control quirks */
805 static void volume_control_quirks(struct usb_mixer_elem_info
*cval
,
806 struct snd_kcontrol
*kctl
)
808 switch (cval
->mixer
->chip
->usb_id
) {
809 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
810 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
811 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
817 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
818 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
823 if (strstr(kctl
->id
.name
, "Effect Return") != NULL
) {
829 if ((strstr(kctl
->id
.name
, "Playback Volume") != NULL
) ||
830 (strstr(kctl
->id
.name
, "Effect Send") != NULL
)) {
831 cval
->min
= 0xb5fb; /* -73 dB = 0xb6ff */
837 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
838 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
839 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
841 "usb-audio: set quirk for FTU Effect Duration\n");
847 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
848 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
850 "usb-audio: set quirks for FTU Effect Feedback/Volume\n");
857 case USB_ID(0x0471, 0x0101):
858 case USB_ID(0x0471, 0x0104):
859 case USB_ID(0x0471, 0x0105):
860 case USB_ID(0x0672, 0x1041):
861 /* quirk for UDA1321/N101.
862 * note that detection between firmware 2.1.1.7 (N101)
863 * and later 2.1.1.21 is not very clear from datasheets.
864 * I hope that the min value is -15360 for newer firmware --jk
866 if (!strcmp(kctl
->id
.name
, "PCM Playback Volume") &&
867 cval
->min
== -15616) {
869 "set volume quirk for UDA1321/N101 chip\n");
874 case USB_ID(0x046d, 0x09a4):
875 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
877 "set volume quirk for QuickCam E3500\n");
884 case USB_ID(0x046d, 0x0808):
885 case USB_ID(0x046d, 0x0809):
886 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
887 case USB_ID(0x046d, 0x0991):
888 /* Most audio usb devices lie about volume resolution.
889 * Most Logitech webcams have res = 384.
890 * Proboly there is some logitech magic behind this number --fishor
892 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
894 "set resolution quirk: cval->res = 384\n");
903 * retrieve the minimum and maximum values for the specified control
905 static int get_min_max_with_quirks(struct usb_mixer_elem_info
*cval
,
906 int default_min
, struct snd_kcontrol
*kctl
)
909 cval
->min
= default_min
;
910 cval
->max
= cval
->min
+ 1;
912 cval
->dBmin
= cval
->dBmax
= 0;
914 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
915 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
916 cval
->initialized
= 1;
921 for (i
= 0; i
< MAX_CHANNELS
; i
++)
922 if (cval
->cmask
& (1 << i
)) {
927 if (get_ctl_value(cval
, UAC_GET_MAX
, (cval
->control
<< 8) | minchn
, &cval
->max
) < 0 ||
928 get_ctl_value(cval
, UAC_GET_MIN
, (cval
->control
<< 8) | minchn
, &cval
->min
) < 0) {
929 snd_printd(KERN_ERR
"%d:%d: cannot get min/max values for control %d (id %d)\n",
930 cval
->id
, snd_usb_ctrl_intf(cval
->mixer
->chip
), cval
->control
, cval
->id
);
933 if (get_ctl_value(cval
, UAC_GET_RES
, (cval
->control
<< 8) | minchn
, &cval
->res
) < 0) {
936 int last_valid_res
= cval
->res
;
938 while (cval
->res
> 1) {
939 if (snd_usb_mixer_set_ctl_value(cval
, UAC_SET_RES
,
940 (cval
->control
<< 8) | minchn
, cval
->res
/ 2) < 0)
944 if (get_ctl_value(cval
, UAC_GET_RES
, (cval
->control
<< 8) | minchn
, &cval
->res
) < 0)
945 cval
->res
= last_valid_res
;
950 /* Additional checks for the proper resolution
952 * Some devices report smaller resolutions than actually
953 * reacting. They don't return errors but simply clip
954 * to the lower aligned value.
956 if (cval
->min
+ cval
->res
< cval
->max
) {
957 int last_valid_res
= cval
->res
;
958 int saved
, test
, check
;
959 get_cur_mix_raw(cval
, minchn
, &saved
);
962 if (test
< cval
->max
)
966 if (test
< cval
->min
|| test
> cval
->max
||
967 set_cur_mix_value(cval
, minchn
, 0, test
) ||
968 get_cur_mix_raw(cval
, minchn
, &check
)) {
969 cval
->res
= last_valid_res
;
976 set_cur_mix_value(cval
, minchn
, 0, saved
);
979 cval
->initialized
= 1;
983 volume_control_quirks(cval
, kctl
);
985 /* USB descriptions contain the dB scale in 1/256 dB unit
986 * while ALSA TLV contains in 1/100 dB unit
988 cval
->dBmin
= (convert_signed_value(cval
, cval
->min
) * 100) / 256;
989 cval
->dBmax
= (convert_signed_value(cval
, cval
->max
) * 100) / 256;
990 if (cval
->dBmin
> cval
->dBmax
) {
991 /* something is wrong; assume it's either from/to 0dB */
994 else if (cval
->dBmin
> 0)
996 if (cval
->dBmin
> cval
->dBmax
) {
997 /* totally crap, return an error */
1005 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1007 /* get a feature/mixer unit info */
1008 static int mixer_ctl_feature_info(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_info
*uinfo
)
1010 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1012 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1013 cval
->val_type
== USB_MIXER_INV_BOOLEAN
)
1014 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1016 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
1017 uinfo
->count
= cval
->channels
;
1018 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1019 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
1020 uinfo
->value
.integer
.min
= 0;
1021 uinfo
->value
.integer
.max
= 1;
1023 if (!cval
->initialized
) {
1024 get_min_max_with_quirks(cval
, 0, kcontrol
);
1025 if (cval
->initialized
&& cval
->dBmin
>= cval
->dBmax
) {
1026 kcontrol
->vd
[0].access
&=
1027 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1028 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
);
1029 snd_ctl_notify(cval
->mixer
->chip
->card
,
1030 SNDRV_CTL_EVENT_MASK_INFO
,
1034 uinfo
->value
.integer
.min
= 0;
1035 uinfo
->value
.integer
.max
=
1036 (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
1041 /* get the current value from feature/mixer unit */
1042 static int mixer_ctl_feature_get(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1044 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1045 int c
, cnt
, val
, err
;
1047 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1050 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1051 if (!(cval
->cmask
& (1 << c
)))
1053 err
= get_cur_mix_value(cval
, c
+ 1, cnt
, &val
);
1055 return cval
->mixer
->ignore_ctl_error
? 0 : err
;
1056 val
= get_relative_value(cval
, val
);
1057 ucontrol
->value
.integer
.value
[cnt
] = val
;
1062 /* master channel */
1063 err
= get_cur_mix_value(cval
, 0, 0, &val
);
1065 return cval
->mixer
->ignore_ctl_error
? 0 : err
;
1066 val
= get_relative_value(cval
, val
);
1067 ucontrol
->value
.integer
.value
[0] = val
;
1072 /* put the current value to feature/mixer unit */
1073 static int mixer_ctl_feature_put(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1075 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1076 int c
, cnt
, val
, oval
, err
;
1081 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1082 if (!(cval
->cmask
& (1 << c
)))
1084 err
= get_cur_mix_value(cval
, c
+ 1, cnt
, &oval
);
1086 return cval
->mixer
->ignore_ctl_error
? 0 : err
;
1087 val
= ucontrol
->value
.integer
.value
[cnt
];
1088 val
= get_abs_value(cval
, val
);
1090 set_cur_mix_value(cval
, c
+ 1, cnt
, val
);
1096 /* master channel */
1097 err
= get_cur_mix_value(cval
, 0, 0, &oval
);
1099 return cval
->mixer
->ignore_ctl_error
? 0 : err
;
1100 val
= ucontrol
->value
.integer
.value
[0];
1101 val
= get_abs_value(cval
, val
);
1103 set_cur_mix_value(cval
, 0, 0, val
);
1110 static struct snd_kcontrol_new usb_feature_unit_ctl
= {
1111 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1112 .name
= "", /* will be filled later manually */
1113 .info
= mixer_ctl_feature_info
,
1114 .get
= mixer_ctl_feature_get
,
1115 .put
= mixer_ctl_feature_put
,
1118 /* the read-only variant */
1119 static struct snd_kcontrol_new usb_feature_unit_ctl_ro
= {
1120 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1121 .name
= "", /* will be filled later manually */
1122 .info
= mixer_ctl_feature_info
,
1123 .get
= mixer_ctl_feature_get
,
1127 /* This symbol is exported in order to allow the mixer quirks to
1128 * hook up to the standard feature unit control mechanism */
1129 struct snd_kcontrol_new
*snd_usb_feature_unit_ctl
= &usb_feature_unit_ctl
;
1132 * build a feature control
1135 static size_t append_ctl_name(struct snd_kcontrol
*kctl
, const char *str
)
1137 return strlcat(kctl
->id
.name
, str
, sizeof(kctl
->id
.name
));
1140 /* A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1141 rename it to "Headphone". We determine if something is a headphone
1142 similar to how udev determines form factor. */
1143 static void check_no_speaker_on_headset(struct snd_kcontrol
*kctl
,
1144 struct snd_card
*card
)
1146 const char *names_to_check
[] = {
1147 "Headset", "headset", "Headphone", "headphone", NULL
};
1151 if (strcmp("Speaker", kctl
->id
.name
))
1154 for (s
= names_to_check
; *s
; s
++)
1155 if (strstr(card
->shortname
, *s
)) {
1163 strlcpy(kctl
->id
.name
, "Headphone", sizeof(kctl
->id
.name
));
1166 static void build_feature_ctl(struct mixer_build
*state
, void *raw_desc
,
1167 unsigned int ctl_mask
, int control
,
1168 struct usb_audio_term
*iterm
, int unitid
,
1171 struct uac_feature_unit_descriptor
*desc
= raw_desc
;
1172 unsigned int len
= 0;
1173 int mapped_name
= 0;
1174 int nameid
= uac_feature_unit_iFeature(desc
);
1175 struct snd_kcontrol
*kctl
;
1176 struct usb_mixer_elem_info
*cval
;
1177 const struct usbmix_name_map
*map
;
1180 control
++; /* change from zero-based to 1-based value */
1182 if (control
== UAC_FU_GRAPHIC_EQUALIZER
) {
1183 /* FIXME: not supported yet */
1187 map
= find_map(state
, unitid
, control
);
1188 if (check_ignored_ctl(map
))
1191 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1193 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1196 cval
->mixer
= state
->mixer
;
1198 cval
->control
= control
;
1199 cval
->cmask
= ctl_mask
;
1200 cval
->val_type
= audio_feature_info
[control
-1].type
;
1201 if (ctl_mask
== 0) {
1202 cval
->channels
= 1; /* master channel */
1203 cval
->master_readonly
= readonly_mask
;
1206 for (i
= 0; i
< 16; i
++)
1207 if (ctl_mask
& (1 << i
))
1210 cval
->ch_readonly
= readonly_mask
;
1213 /* if all channels in the mask are marked read-only, make the control
1214 * read-only. set_cur_mix_value() will check the mask again and won't
1215 * issue write commands to read-only channels. */
1216 if (cval
->channels
== readonly_mask
)
1217 kctl
= snd_ctl_new1(&usb_feature_unit_ctl_ro
, cval
);
1219 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1222 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1226 kctl
->private_free
= usb_mixer_elem_free
;
1228 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1229 mapped_name
= len
!= 0;
1230 if (! len
&& nameid
)
1231 len
= snd_usb_copy_string_desc(state
, nameid
,
1232 kctl
->id
.name
, sizeof(kctl
->id
.name
));
1237 /* determine the control name. the rule is:
1238 * - if a name id is given in descriptor, use it.
1239 * - if the connected input can be determined, then use the name
1241 * - if the connected output can be determined, use it.
1242 * - otherwise, anonymous name.
1245 len
= get_term_name(state
, iterm
, kctl
->id
.name
, sizeof(kctl
->id
.name
), 1);
1247 len
= get_term_name(state
, &state
->oterm
, kctl
->id
.name
, sizeof(kctl
->id
.name
), 1);
1249 len
= snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1250 "Feature %d", unitid
);
1254 check_no_speaker_on_headset(kctl
, state
->mixer
->chip
->card
);
1256 /* determine the stream direction:
1257 * if the connected output is USB stream, then it's likely a
1258 * capture stream. otherwise it should be playback (hopefully :)
1260 if (! mapped_name
&& ! (state
->oterm
.type
>> 16)) {
1261 if ((state
->oterm
.type
& 0xff00) == 0x0100) {
1262 len
= append_ctl_name(kctl
, " Capture");
1264 len
= append_ctl_name(kctl
, " Playback");
1267 append_ctl_name(kctl
, control
== UAC_FU_MUTE
?
1268 " Switch" : " Volume");
1272 strlcpy(kctl
->id
.name
, audio_feature_info
[control
-1].name
,
1273 sizeof(kctl
->id
.name
));
1277 /* get min/max values */
1278 get_min_max_with_quirks(cval
, 0, kctl
);
1280 if (control
== UAC_FU_VOLUME
) {
1281 check_mapped_dB(map
, cval
);
1282 if (cval
->dBmin
< cval
->dBmax
|| !cval
->initialized
) {
1283 kctl
->tlv
.c
= snd_usb_mixer_vol_tlv
;
1284 kctl
->vd
[0].access
|=
1285 SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1286 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
;
1290 range
= (cval
->max
- cval
->min
) / cval
->res
;
1291 /* Are there devices with volume range more than 255? I use a bit more
1292 * to be sure. 384 is a resolution magic number found on Logitech
1293 * devices. It will definitively catch all buggy Logitech devices.
1296 snd_printk(KERN_WARNING
"usb_audio: Warning! Unlikely big "
1297 "volume range (=%u), cval->res is probably wrong.",
1299 snd_printk(KERN_WARNING
"usb_audio: [%d] FU [%s] ch = %d, "
1300 "val = %d/%d/%d", cval
->id
,
1301 kctl
->id
.name
, cval
->channels
,
1302 cval
->min
, cval
->max
, cval
->res
);
1305 snd_printdd(KERN_INFO
"[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1306 cval
->id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
, cval
->res
);
1307 snd_usb_mixer_add_control(state
->mixer
, kctl
);
1313 * parse a feature unit
1315 * most of controls are defined here.
1317 static int parse_audio_feature_unit(struct mixer_build
*state
, int unitid
, void *_ftr
)
1320 struct usb_audio_term iterm
;
1321 unsigned int master_bits
, first_ch_bits
;
1323 struct uac_feature_unit_descriptor
*hdr
= _ftr
;
1326 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1327 csize
= hdr
->bControlSize
;
1329 snd_printdd(KERN_ERR
"usbaudio: unit %u: "
1330 "invalid bControlSize == 0\n", unitid
);
1333 channels
= (hdr
->bLength
- 7) / csize
- 1;
1334 bmaControls
= hdr
->bmaControls
;
1335 if (hdr
->bLength
< 7 + csize
) {
1336 snd_printk(KERN_ERR
"usbaudio: unit %u: "
1337 "invalid UAC_FEATURE_UNIT descriptor\n",
1342 struct uac2_feature_unit_descriptor
*ftr
= _ftr
;
1344 channels
= (hdr
->bLength
- 6) / 4 - 1;
1345 bmaControls
= ftr
->bmaControls
;
1346 if (hdr
->bLength
< 6 + csize
) {
1347 snd_printk(KERN_ERR
"usbaudio: unit %u: "
1348 "invalid UAC_FEATURE_UNIT descriptor\n",
1354 /* parse the source unit */
1355 if ((err
= parse_audio_unit(state
, hdr
->bSourceID
)) < 0)
1358 /* determine the input source type and name */
1359 if (check_input_term(state
, hdr
->bSourceID
, &iterm
) < 0)
1362 master_bits
= snd_usb_combine_bytes(bmaControls
, csize
);
1363 /* master configuration quirks */
1364 switch (state
->chip
->usb_id
) {
1365 case USB_ID(0x08bb, 0x2702):
1366 snd_printk(KERN_INFO
1367 "usbmixer: master volume quirk for PCM2702 chip\n");
1368 /* disable non-functional volume control */
1369 master_bits
&= ~UAC_CONTROL_BIT(UAC_FU_VOLUME
);
1371 case USB_ID(0x1130, 0xf211):
1372 snd_printk(KERN_INFO
1373 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1374 /* disable non-functional volume control */
1380 first_ch_bits
= snd_usb_combine_bytes(bmaControls
+ csize
, csize
);
1384 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1385 /* check all control types */
1386 for (i
= 0; i
< 10; i
++) {
1387 unsigned int ch_bits
= 0;
1388 for (j
= 0; j
< channels
; j
++) {
1389 unsigned int mask
= snd_usb_combine_bytes(bmaControls
+ csize
* (j
+1), csize
);
1390 if (mask
& (1 << i
))
1391 ch_bits
|= (1 << j
);
1393 /* audio class v1 controls are never read-only */
1394 if (ch_bits
& 1) /* the first channel must be set (for ease of programming) */
1395 build_feature_ctl(state
, _ftr
, ch_bits
, i
, &iterm
, unitid
, 0);
1396 if (master_bits
& (1 << i
))
1397 build_feature_ctl(state
, _ftr
, 0, i
, &iterm
, unitid
, 0);
1399 } else { /* UAC_VERSION_2 */
1400 for (i
= 0; i
< ARRAY_SIZE(audio_feature_info
); i
++) {
1401 unsigned int ch_bits
= 0;
1402 unsigned int ch_read_only
= 0;
1404 for (j
= 0; j
< channels
; j
++) {
1405 unsigned int mask
= snd_usb_combine_bytes(bmaControls
+ csize
* (j
+1), csize
);
1406 if (uac2_control_is_readable(mask
, i
)) {
1407 ch_bits
|= (1 << j
);
1408 if (!uac2_control_is_writeable(mask
, i
))
1409 ch_read_only
|= (1 << j
);
1413 /* NOTE: build_feature_ctl() will mark the control read-only if all channels
1414 * are marked read-only in the descriptors. Otherwise, the control will be
1415 * reported as writeable, but the driver will not actually issue a write
1416 * command for read-only channels */
1417 if (ch_bits
& 1) /* the first channel must be set (for ease of programming) */
1418 build_feature_ctl(state
, _ftr
, ch_bits
, i
, &iterm
, unitid
, ch_read_only
);
1419 if (uac2_control_is_readable(master_bits
, i
))
1420 build_feature_ctl(state
, _ftr
, 0, i
, &iterm
, unitid
,
1421 !uac2_control_is_writeable(master_bits
, i
));
1434 * build a mixer unit control
1436 * the callbacks are identical with feature unit.
1437 * input channel number (zero based) is given in control field instead.
1440 static void build_mixer_unit_ctl(struct mixer_build
*state
,
1441 struct uac_mixer_unit_descriptor
*desc
,
1442 int in_pin
, int in_ch
, int unitid
,
1443 struct usb_audio_term
*iterm
)
1445 struct usb_mixer_elem_info
*cval
;
1446 unsigned int num_outs
= uac_mixer_unit_bNrChannels(desc
);
1447 unsigned int i
, len
;
1448 struct snd_kcontrol
*kctl
;
1449 const struct usbmix_name_map
*map
;
1451 map
= find_map(state
, unitid
, 0);
1452 if (check_ignored_ctl(map
))
1455 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1459 cval
->mixer
= state
->mixer
;
1461 cval
->control
= in_ch
+ 1; /* based on 1 */
1462 cval
->val_type
= USB_MIXER_S16
;
1463 for (i
= 0; i
< num_outs
; i
++) {
1464 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc
, state
->mixer
->protocol
), in_ch
, i
, num_outs
)) {
1465 cval
->cmask
|= (1 << i
);
1470 /* get min/max values */
1471 get_min_max(cval
, 0);
1473 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1475 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1479 kctl
->private_free
= usb_mixer_elem_free
;
1481 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1483 len
= get_term_name(state
, iterm
, kctl
->id
.name
, sizeof(kctl
->id
.name
), 0);
1485 len
= sprintf(kctl
->id
.name
, "Mixer Source %d", in_ch
+ 1);
1486 append_ctl_name(kctl
, " Volume");
1488 snd_printdd(KERN_INFO
"[%d] MU [%s] ch = %d, val = %d/%d\n",
1489 cval
->id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
);
1490 snd_usb_mixer_add_control(state
->mixer
, kctl
);
1495 * parse a mixer unit
1497 static int parse_audio_mixer_unit(struct mixer_build
*state
, int unitid
, void *raw_desc
)
1499 struct uac_mixer_unit_descriptor
*desc
= raw_desc
;
1500 struct usb_audio_term iterm
;
1501 int input_pins
, num_ins
, num_outs
;
1504 if (desc
->bLength
< 11 || ! (input_pins
= desc
->bNrInPins
) || ! (num_outs
= uac_mixer_unit_bNrChannels(desc
))) {
1505 snd_printk(KERN_ERR
"invalid MIXER UNIT descriptor %d\n", unitid
);
1508 /* no bmControls field (e.g. Maya44) -> ignore */
1509 if (desc
->bLength
<= 10 + input_pins
) {
1510 snd_printdd(KERN_INFO
"MU %d has no bmControls field\n", unitid
);
1516 for (pin
= 0; pin
< input_pins
; pin
++) {
1517 err
= parse_audio_unit(state
, desc
->baSourceID
[pin
]);
1520 err
= check_input_term(state
, desc
->baSourceID
[pin
], &iterm
);
1523 num_ins
+= iterm
.channels
;
1524 for (; ich
< num_ins
; ++ich
) {
1525 int och
, ich_has_controls
= 0;
1527 for (och
= 0; och
< num_outs
; ++och
) {
1528 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc
, state
->mixer
->protocol
),
1529 ich
, och
, num_outs
)) {
1530 ich_has_controls
= 1;
1534 if (ich_has_controls
)
1535 build_mixer_unit_ctl(state
, desc
, pin
, ich
,
1544 * Processing Unit / Extension Unit
1547 /* get callback for processing/extension unit */
1548 static int mixer_ctl_procunit_get(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1550 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1553 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
1554 if (err
< 0 && cval
->mixer
->ignore_ctl_error
) {
1555 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1560 val
= get_relative_value(cval
, val
);
1561 ucontrol
->value
.integer
.value
[0] = val
;
1565 /* put callback for processing/extension unit */
1566 static int mixer_ctl_procunit_put(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1568 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1571 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
1573 if (cval
->mixer
->ignore_ctl_error
)
1577 val
= ucontrol
->value
.integer
.value
[0];
1578 val
= get_abs_value(cval
, val
);
1580 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
1586 /* alsa control interface for processing/extension unit */
1587 static struct snd_kcontrol_new mixer_procunit_ctl
= {
1588 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1589 .name
= "", /* will be filled later */
1590 .info
= mixer_ctl_feature_info
,
1591 .get
= mixer_ctl_procunit_get
,
1592 .put
= mixer_ctl_procunit_put
,
1597 * predefined data for processing units
1599 struct procunit_value_info
{
1606 struct procunit_info
{
1609 struct procunit_value_info
*values
;
1612 static struct procunit_value_info updown_proc_info
[] = {
1613 { UAC_UD_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1614 { UAC_UD_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
1617 static struct procunit_value_info prologic_proc_info
[] = {
1618 { UAC_DP_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1619 { UAC_DP_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
1622 static struct procunit_value_info threed_enh_proc_info
[] = {
1623 { UAC_3D_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1624 { UAC_3D_SPACE
, "Spaciousness", USB_MIXER_U8
},
1627 static struct procunit_value_info reverb_proc_info
[] = {
1628 { UAC_REVERB_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1629 { UAC_REVERB_LEVEL
, "Level", USB_MIXER_U8
},
1630 { UAC_REVERB_TIME
, "Time", USB_MIXER_U16
},
1631 { UAC_REVERB_FEEDBACK
, "Feedback", USB_MIXER_U8
},
1634 static struct procunit_value_info chorus_proc_info
[] = {
1635 { UAC_CHORUS_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1636 { UAC_CHORUS_LEVEL
, "Level", USB_MIXER_U8
},
1637 { UAC_CHORUS_RATE
, "Rate", USB_MIXER_U16
},
1638 { UAC_CHORUS_DEPTH
, "Depth", USB_MIXER_U16
},
1641 static struct procunit_value_info dcr_proc_info
[] = {
1642 { UAC_DCR_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
1643 { UAC_DCR_RATE
, "Ratio", USB_MIXER_U16
},
1644 { UAC_DCR_MAXAMPL
, "Max Amp", USB_MIXER_S16
},
1645 { UAC_DCR_THRESHOLD
, "Threshold", USB_MIXER_S16
},
1646 { UAC_DCR_ATTACK_TIME
, "Attack Time", USB_MIXER_U16
},
1647 { UAC_DCR_RELEASE_TIME
, "Release Time", USB_MIXER_U16
},
1651 static struct procunit_info procunits
[] = {
1652 { UAC_PROCESS_UP_DOWNMIX
, "Up Down", updown_proc_info
},
1653 { UAC_PROCESS_DOLBY_PROLOGIC
, "Dolby Prologic", prologic_proc_info
},
1654 { UAC_PROCESS_STEREO_EXTENDER
, "3D Stereo Extender", threed_enh_proc_info
},
1655 { UAC_PROCESS_REVERB
, "Reverb", reverb_proc_info
},
1656 { UAC_PROCESS_CHORUS
, "Chorus", chorus_proc_info
},
1657 { UAC_PROCESS_DYN_RANGE_COMP
, "DCR", dcr_proc_info
},
1661 * predefined data for extension units
1663 static struct procunit_value_info clock_rate_xu_info
[] = {
1664 { USB_XU_CLOCK_RATE_SELECTOR
, "Selector", USB_MIXER_U8
, 0 },
1667 static struct procunit_value_info clock_source_xu_info
[] = {
1668 { USB_XU_CLOCK_SOURCE_SELECTOR
, "External", USB_MIXER_BOOLEAN
},
1671 static struct procunit_value_info spdif_format_xu_info
[] = {
1672 { USB_XU_DIGITAL_FORMAT_SELECTOR
, "SPDIF/AC3", USB_MIXER_BOOLEAN
},
1675 static struct procunit_value_info soft_limit_xu_info
[] = {
1676 { USB_XU_SOFT_LIMIT_SELECTOR
, " ", USB_MIXER_BOOLEAN
},
1679 static struct procunit_info extunits
[] = {
1680 { USB_XU_CLOCK_RATE
, "Clock rate", clock_rate_xu_info
},
1681 { USB_XU_CLOCK_SOURCE
, "DigitalIn CLK source", clock_source_xu_info
},
1682 { USB_XU_DIGITAL_IO_STATUS
, "DigitalOut format:", spdif_format_xu_info
},
1683 { USB_XU_DEVICE_OPTIONS
, "AnalogueIn Soft Limit", soft_limit_xu_info
},
1687 * build a processing/extension unit
1689 static int build_audio_procunit(struct mixer_build
*state
, int unitid
, void *raw_desc
, struct procunit_info
*list
, char *name
)
1691 struct uac_processing_unit_descriptor
*desc
= raw_desc
;
1692 int num_ins
= desc
->bNrInPins
;
1693 struct usb_mixer_elem_info
*cval
;
1694 struct snd_kcontrol
*kctl
;
1695 int i
, err
, nameid
, type
, len
;
1696 struct procunit_info
*info
;
1697 struct procunit_value_info
*valinfo
;
1698 const struct usbmix_name_map
*map
;
1699 static struct procunit_value_info default_value_info
[] = {
1700 { 0x01, "Switch", USB_MIXER_BOOLEAN
},
1703 static struct procunit_info default_info
= {
1704 0, NULL
, default_value_info
1707 if (desc
->bLength
< 13 || desc
->bLength
< 13 + num_ins
||
1708 desc
->bLength
< num_ins
+ uac_processing_unit_bControlSize(desc
, state
->mixer
->protocol
)) {
1709 snd_printk(KERN_ERR
"invalid %s descriptor (id %d)\n", name
, unitid
);
1713 for (i
= 0; i
< num_ins
; i
++) {
1714 if ((err
= parse_audio_unit(state
, desc
->baSourceID
[i
])) < 0)
1718 type
= le16_to_cpu(desc
->wProcessType
);
1719 for (info
= list
; info
&& info
->type
; info
++)
1720 if (info
->type
== type
)
1722 if (! info
|| ! info
->type
)
1723 info
= &default_info
;
1725 for (valinfo
= info
->values
; valinfo
->control
; valinfo
++) {
1726 __u8
*controls
= uac_processing_unit_bmControls(desc
, state
->mixer
->protocol
);
1728 if (! (controls
[valinfo
->control
/ 8] & (1 << ((valinfo
->control
% 8) - 1))))
1730 map
= find_map(state
, unitid
, valinfo
->control
);
1731 if (check_ignored_ctl(map
))
1733 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1735 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1738 cval
->mixer
= state
->mixer
;
1740 cval
->control
= valinfo
->control
;
1741 cval
->val_type
= valinfo
->val_type
;
1744 /* get min/max values */
1745 if (type
== UAC_PROCESS_UP_DOWNMIX
&& cval
->control
== UAC_UD_MODE_SELECT
) {
1746 __u8
*control_spec
= uac_processing_unit_specific(desc
, state
->mixer
->protocol
);
1747 /* FIXME: hard-coded */
1749 cval
->max
= control_spec
[0];
1751 cval
->initialized
= 1;
1753 if (type
== USB_XU_CLOCK_RATE
) {
1754 /* E-Mu USB 0404/0202/TrackerPre/0204
1755 * samplerate control quirk
1760 cval
->initialized
= 1;
1762 get_min_max(cval
, valinfo
->min_value
);
1765 kctl
= snd_ctl_new1(&mixer_procunit_ctl
, cval
);
1767 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1771 kctl
->private_free
= usb_mixer_elem_free
;
1773 if (check_mapped_name(map
, kctl
->id
.name
,
1774 sizeof(kctl
->id
.name
)))
1776 else if (info
->name
)
1777 strlcpy(kctl
->id
.name
, info
->name
, sizeof(kctl
->id
.name
));
1779 nameid
= uac_processing_unit_iProcessing(desc
, state
->mixer
->protocol
);
1782 len
= snd_usb_copy_string_desc(state
, nameid
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1784 strlcpy(kctl
->id
.name
, name
, sizeof(kctl
->id
.name
));
1786 append_ctl_name(kctl
, " ");
1787 append_ctl_name(kctl
, valinfo
->suffix
);
1789 snd_printdd(KERN_INFO
"[%d] PU [%s] ch = %d, val = %d/%d\n",
1790 cval
->id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
);
1791 if ((err
= snd_usb_mixer_add_control(state
->mixer
, kctl
)) < 0)
1798 static int parse_audio_processing_unit(struct mixer_build
*state
, int unitid
, void *raw_desc
)
1800 return build_audio_procunit(state
, unitid
, raw_desc
, procunits
, "Processing Unit");
1803 static int parse_audio_extension_unit(struct mixer_build
*state
, int unitid
, void *raw_desc
)
1805 /* Note that we parse extension units with processing unit descriptors.
1806 * That's ok as the layout is the same */
1807 return build_audio_procunit(state
, unitid
, raw_desc
, extunits
, "Extension Unit");
1815 /* info callback for selector unit
1816 * use an enumerator type for routing
1818 static int mixer_ctl_selector_info(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_info
*uinfo
)
1820 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1821 const char **itemlist
= (const char **)kcontrol
->private_value
;
1823 if (snd_BUG_ON(!itemlist
))
1825 return snd_ctl_enum_info(uinfo
, 1, cval
->max
, itemlist
);
1828 /* get callback for selector unit */
1829 static int mixer_ctl_selector_get(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1831 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1834 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
1836 if (cval
->mixer
->ignore_ctl_error
) {
1837 ucontrol
->value
.enumerated
.item
[0] = 0;
1842 val
= get_relative_value(cval
, val
);
1843 ucontrol
->value
.enumerated
.item
[0] = val
;
1847 /* put callback for selector unit */
1848 static int mixer_ctl_selector_put(struct snd_kcontrol
*kcontrol
, struct snd_ctl_elem_value
*ucontrol
)
1850 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1853 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
1855 if (cval
->mixer
->ignore_ctl_error
)
1859 val
= ucontrol
->value
.enumerated
.item
[0];
1860 val
= get_abs_value(cval
, val
);
1862 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
1868 /* alsa control interface for selector unit */
1869 static struct snd_kcontrol_new mixer_selectunit_ctl
= {
1870 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1871 .name
= "", /* will be filled later */
1872 .info
= mixer_ctl_selector_info
,
1873 .get
= mixer_ctl_selector_get
,
1874 .put
= mixer_ctl_selector_put
,
1878 /* private free callback.
1879 * free both private_data and private_value
1881 static void usb_mixer_selector_elem_free(struct snd_kcontrol
*kctl
)
1885 if (kctl
->private_data
) {
1886 struct usb_mixer_elem_info
*cval
= kctl
->private_data
;
1887 num_ins
= cval
->max
;
1889 kctl
->private_data
= NULL
;
1891 if (kctl
->private_value
) {
1892 char **itemlist
= (char **)kctl
->private_value
;
1893 for (i
= 0; i
< num_ins
; i
++)
1896 kctl
->private_value
= 0;
1901 * parse a selector unit
1903 static int parse_audio_selector_unit(struct mixer_build
*state
, int unitid
, void *raw_desc
)
1905 struct uac_selector_unit_descriptor
*desc
= raw_desc
;
1906 unsigned int i
, nameid
, len
;
1908 struct usb_mixer_elem_info
*cval
;
1909 struct snd_kcontrol
*kctl
;
1910 const struct usbmix_name_map
*map
;
1913 if (!desc
->bNrInPins
|| desc
->bLength
< 5 + desc
->bNrInPins
) {
1914 snd_printk(KERN_ERR
"invalid SELECTOR UNIT descriptor %d\n", unitid
);
1918 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
1919 if ((err
= parse_audio_unit(state
, desc
->baSourceID
[i
])) < 0)
1923 if (desc
->bNrInPins
== 1) /* only one ? nonsense! */
1926 map
= find_map(state
, unitid
, 0);
1927 if (check_ignored_ctl(map
))
1930 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1932 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1935 cval
->mixer
= state
->mixer
;
1937 cval
->val_type
= USB_MIXER_U8
;
1940 cval
->max
= desc
->bNrInPins
;
1942 cval
->initialized
= 1;
1944 if (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
)
1945 cval
->control
= UAC2_CX_CLOCK_SELECTOR
;
1949 namelist
= kmalloc(sizeof(char *) * desc
->bNrInPins
, GFP_KERNEL
);
1951 snd_printk(KERN_ERR
"cannot malloc\n");
1955 #define MAX_ITEM_NAME_LEN 64
1956 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
1957 struct usb_audio_term iterm
;
1959 namelist
[i
] = kmalloc(MAX_ITEM_NAME_LEN
, GFP_KERNEL
);
1960 if (! namelist
[i
]) {
1961 snd_printk(KERN_ERR
"cannot malloc\n");
1968 len
= check_mapped_selector_name(state
, unitid
, i
, namelist
[i
],
1970 if (! len
&& check_input_term(state
, desc
->baSourceID
[i
], &iterm
) >= 0)
1971 len
= get_term_name(state
, &iterm
, namelist
[i
], MAX_ITEM_NAME_LEN
, 0);
1973 sprintf(namelist
[i
], "Input %d", i
);
1976 kctl
= snd_ctl_new1(&mixer_selectunit_ctl
, cval
);
1978 snd_printk(KERN_ERR
"cannot malloc kcontrol\n");
1983 kctl
->private_value
= (unsigned long)namelist
;
1984 kctl
->private_free
= usb_mixer_selector_elem_free
;
1986 nameid
= uac_selector_unit_iSelector(desc
);
1987 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1991 snd_usb_copy_string_desc(state
, nameid
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1993 len
= get_term_name(state
, &state
->oterm
,
1994 kctl
->id
.name
, sizeof(kctl
->id
.name
), 0);
1996 strlcpy(kctl
->id
.name
, "USB", sizeof(kctl
->id
.name
));
1998 if (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
)
1999 append_ctl_name(kctl
, " Clock Source");
2000 else if ((state
->oterm
.type
& 0xff00) == 0x0100)
2001 append_ctl_name(kctl
, " Capture Source");
2003 append_ctl_name(kctl
, " Playback Source");
2006 snd_printdd(KERN_INFO
"[%d] SU [%s] items = %d\n",
2007 cval
->id
, kctl
->id
.name
, desc
->bNrInPins
);
2008 if ((err
= snd_usb_mixer_add_control(state
->mixer
, kctl
)) < 0)
2016 * parse an audio unit recursively
2019 static int parse_audio_unit(struct mixer_build
*state
, int unitid
)
2023 if (test_and_set_bit(unitid
, state
->unitbitmap
))
2024 return 0; /* the unit already visited */
2026 p1
= find_audio_control_unit(state
, unitid
);
2028 snd_printk(KERN_ERR
"usbaudio: unit %d not found!\n", unitid
);
2033 case UAC_INPUT_TERMINAL
:
2034 case UAC2_CLOCK_SOURCE
:
2036 case UAC_MIXER_UNIT
:
2037 return parse_audio_mixer_unit(state
, unitid
, p1
);
2038 case UAC_SELECTOR_UNIT
:
2039 case UAC2_CLOCK_SELECTOR
:
2040 return parse_audio_selector_unit(state
, unitid
, p1
);
2041 case UAC_FEATURE_UNIT
:
2042 return parse_audio_feature_unit(state
, unitid
, p1
);
2043 case UAC1_PROCESSING_UNIT
:
2044 /* UAC2_EFFECT_UNIT has the same value */
2045 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2046 return parse_audio_processing_unit(state
, unitid
, p1
);
2048 return 0; /* FIXME - effect units not implemented yet */
2049 case UAC1_EXTENSION_UNIT
:
2050 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2051 if (state
->mixer
->protocol
== UAC_VERSION_1
)
2052 return parse_audio_extension_unit(state
, unitid
, p1
);
2053 else /* UAC_VERSION_2 */
2054 return parse_audio_processing_unit(state
, unitid
, p1
);
2056 snd_printk(KERN_ERR
"usbaudio: unit %u: unexpected type 0x%02x\n", unitid
, p1
[2]);
2061 static void snd_usb_mixer_free(struct usb_mixer_interface
*mixer
)
2063 kfree(mixer
->id_elems
);
2065 kfree(mixer
->urb
->transfer_buffer
);
2066 usb_free_urb(mixer
->urb
);
2068 usb_free_urb(mixer
->rc_urb
);
2069 kfree(mixer
->rc_setup_packet
);
2073 static int snd_usb_mixer_dev_free(struct snd_device
*device
)
2075 struct usb_mixer_interface
*mixer
= device
->device_data
;
2076 snd_usb_mixer_free(mixer
);
2081 * create mixer controls
2083 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2085 static int snd_usb_mixer_controls(struct usb_mixer_interface
*mixer
)
2087 struct mixer_build state
;
2089 const struct usbmix_ctl_map
*map
;
2092 memset(&state
, 0, sizeof(state
));
2093 state
.chip
= mixer
->chip
;
2094 state
.mixer
= mixer
;
2095 state
.buffer
= mixer
->hostif
->extra
;
2096 state
.buflen
= mixer
->hostif
->extralen
;
2098 /* check the mapping table */
2099 for (map
= usbmix_ctl_maps
; map
->id
; map
++) {
2100 if (map
->id
== state
.chip
->usb_id
) {
2101 state
.map
= map
->map
;
2102 state
.selector_map
= map
->selector_map
;
2103 mixer
->ignore_ctl_error
= map
->ignore_ctl_error
;
2109 while ((p
= snd_usb_find_csint_desc(mixer
->hostif
->extra
, mixer
->hostif
->extralen
,
2110 p
, UAC_OUTPUT_TERMINAL
)) != NULL
) {
2111 if (mixer
->protocol
== UAC_VERSION_1
) {
2112 struct uac1_output_terminal_descriptor
*desc
= p
;
2114 if (desc
->bLength
< sizeof(*desc
))
2115 continue; /* invalid descriptor? */
2116 set_bit(desc
->bTerminalID
, state
.unitbitmap
); /* mark terminal ID as visited */
2117 state
.oterm
.id
= desc
->bTerminalID
;
2118 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
2119 state
.oterm
.name
= desc
->iTerminal
;
2120 err
= parse_audio_unit(&state
, desc
->bSourceID
);
2123 } else { /* UAC_VERSION_2 */
2124 struct uac2_output_terminal_descriptor
*desc
= p
;
2126 if (desc
->bLength
< sizeof(*desc
))
2127 continue; /* invalid descriptor? */
2128 set_bit(desc
->bTerminalID
, state
.unitbitmap
); /* mark terminal ID as visited */
2129 state
.oterm
.id
= desc
->bTerminalID
;
2130 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
2131 state
.oterm
.name
= desc
->iTerminal
;
2132 err
= parse_audio_unit(&state
, desc
->bSourceID
);
2136 /* for UAC2, use the same approach to also add the clock selectors */
2137 err
= parse_audio_unit(&state
, desc
->bCSourceID
);
2146 void snd_usb_mixer_notify_id(struct usb_mixer_interface
*mixer
, int unitid
)
2148 struct usb_mixer_elem_info
*info
;
2150 for (info
= mixer
->id_elems
[unitid
]; info
; info
= info
->next_id_elem
)
2151 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
2155 static void snd_usb_mixer_dump_cval(struct snd_info_buffer
*buffer
,
2157 struct usb_mixer_elem_info
*cval
)
2159 static char *val_types
[] = {"BOOLEAN", "INV_BOOLEAN",
2160 "S8", "U8", "S16", "U16"};
2161 snd_iprintf(buffer
, " Unit: %i\n", unitid
);
2163 snd_iprintf(buffer
, " Control: name=\"%s\", index=%i\n",
2164 cval
->elem_id
->name
, cval
->elem_id
->index
);
2165 snd_iprintf(buffer
, " Info: id=%i, control=%i, cmask=0x%x, "
2166 "channels=%i, type=\"%s\"\n", cval
->id
,
2167 cval
->control
, cval
->cmask
, cval
->channels
,
2168 val_types
[cval
->val_type
]);
2169 snd_iprintf(buffer
, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2170 cval
->min
, cval
->max
, cval
->dBmin
, cval
->dBmax
);
2173 static void snd_usb_mixer_proc_read(struct snd_info_entry
*entry
,
2174 struct snd_info_buffer
*buffer
)
2176 struct snd_usb_audio
*chip
= entry
->private_data
;
2177 struct usb_mixer_interface
*mixer
;
2178 struct usb_mixer_elem_info
*cval
;
2181 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
2183 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2184 chip
->usb_id
, snd_usb_ctrl_intf(chip
),
2185 mixer
->ignore_ctl_error
);
2186 snd_iprintf(buffer
, "Card: %s\n", chip
->card
->longname
);
2187 for (unitid
= 0; unitid
< MAX_ID_ELEMS
; unitid
++) {
2188 for (cval
= mixer
->id_elems
[unitid
]; cval
;
2189 cval
= cval
->next_id_elem
)
2190 snd_usb_mixer_dump_cval(buffer
, unitid
, cval
);
2195 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface
*mixer
,
2196 int attribute
, int value
, int index
)
2198 struct usb_mixer_elem_info
*info
;
2199 __u8 unitid
= (index
>> 8) & 0xff;
2200 __u8 control
= (value
>> 8) & 0xff;
2201 __u8 channel
= value
& 0xff;
2203 if (channel
>= MAX_CHANNELS
) {
2204 snd_printk(KERN_DEBUG
"%s(): bogus channel number %d\n",
2209 for (info
= mixer
->id_elems
[unitid
]; info
; info
= info
->next_id_elem
) {
2210 if (info
->control
!= control
)
2213 switch (attribute
) {
2215 /* invalidate cache, so the value is read from the device */
2217 info
->cached
&= ~(1 << channel
);
2218 else /* master channel */
2221 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
2234 snd_printk(KERN_DEBUG
"unknown attribute %d in interrupt\n",
2241 static void snd_usb_mixer_interrupt(struct urb
*urb
)
2243 struct usb_mixer_interface
*mixer
= urb
->context
;
2244 int len
= urb
->actual_length
;
2245 int ustatus
= urb
->status
;
2250 if (mixer
->protocol
== UAC_VERSION_1
) {
2251 struct uac1_status_word
*status
;
2253 for (status
= urb
->transfer_buffer
;
2254 len
>= sizeof(*status
);
2255 len
-= sizeof(*status
), status
++) {
2256 snd_printd(KERN_DEBUG
"status interrupt: %02x %02x\n",
2257 status
->bStatusType
,
2258 status
->bOriginator
);
2260 /* ignore any notifications not from the control interface */
2261 if ((status
->bStatusType
& UAC1_STATUS_TYPE_ORIG_MASK
) !=
2262 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF
)
2265 if (status
->bStatusType
& UAC1_STATUS_TYPE_MEM_CHANGED
)
2266 snd_usb_mixer_rc_memory_change(mixer
, status
->bOriginator
);
2268 snd_usb_mixer_notify_id(mixer
, status
->bOriginator
);
2270 } else { /* UAC_VERSION_2 */
2271 struct uac2_interrupt_data_msg
*msg
;
2273 for (msg
= urb
->transfer_buffer
;
2274 len
>= sizeof(*msg
);
2275 len
-= sizeof(*msg
), msg
++) {
2276 /* drop vendor specific and endpoint requests */
2277 if ((msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_VENDOR
) ||
2278 (msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_EP
))
2281 snd_usb_mixer_interrupt_v2(mixer
, msg
->bAttribute
,
2282 le16_to_cpu(msg
->wValue
),
2283 le16_to_cpu(msg
->wIndex
));
2288 if (ustatus
!= -ENOENT
&& ustatus
!= -ECONNRESET
&& ustatus
!= -ESHUTDOWN
) {
2289 urb
->dev
= mixer
->chip
->dev
;
2290 usb_submit_urb(urb
, GFP_ATOMIC
);
2294 /* stop any bus activity of a mixer */
2295 void snd_usb_mixer_inactivate(struct usb_mixer_interface
*mixer
)
2297 usb_kill_urb(mixer
->urb
);
2298 usb_kill_urb(mixer
->rc_urb
);
2301 int snd_usb_mixer_activate(struct usb_mixer_interface
*mixer
)
2306 err
= usb_submit_urb(mixer
->urb
, GFP_NOIO
);
2314 /* create the handler for the optional status interrupt endpoint */
2315 static int snd_usb_mixer_status_create(struct usb_mixer_interface
*mixer
)
2317 struct usb_endpoint_descriptor
*ep
;
2318 void *transfer_buffer
;
2322 /* we need one interrupt input endpoint */
2323 if (get_iface_desc(mixer
->hostif
)->bNumEndpoints
< 1)
2325 ep
= get_endpoint(mixer
->hostif
, 0);
2326 if (!usb_endpoint_dir_in(ep
) || !usb_endpoint_xfer_int(ep
))
2329 epnum
= usb_endpoint_num(ep
);
2330 buffer_length
= le16_to_cpu(ep
->wMaxPacketSize
);
2331 transfer_buffer
= kmalloc(buffer_length
, GFP_KERNEL
);
2332 if (!transfer_buffer
)
2334 mixer
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
2336 kfree(transfer_buffer
);
2339 usb_fill_int_urb(mixer
->urb
, mixer
->chip
->dev
,
2340 usb_rcvintpipe(mixer
->chip
->dev
, epnum
),
2341 transfer_buffer
, buffer_length
,
2342 snd_usb_mixer_interrupt
, mixer
, ep
->bInterval
);
2343 usb_submit_urb(mixer
->urb
, GFP_KERNEL
);
2347 int snd_usb_create_mixer(struct snd_usb_audio
*chip
, int ctrlif
,
2350 static struct snd_device_ops dev_ops
= {
2351 .dev_free
= snd_usb_mixer_dev_free
2353 struct usb_mixer_interface
*mixer
;
2354 struct snd_info_entry
*entry
;
2357 strcpy(chip
->card
->mixername
, "USB Mixer");
2359 mixer
= kzalloc(sizeof(*mixer
), GFP_KERNEL
);
2363 mixer
->ignore_ctl_error
= ignore_error
;
2364 mixer
->id_elems
= kcalloc(MAX_ID_ELEMS
, sizeof(*mixer
->id_elems
),
2366 if (!mixer
->id_elems
) {
2371 mixer
->hostif
= &usb_ifnum_to_if(chip
->dev
, ctrlif
)->altsetting
[0];
2372 switch (get_iface_desc(mixer
->hostif
)->bInterfaceProtocol
) {
2375 mixer
->protocol
= UAC_VERSION_1
;
2378 mixer
->protocol
= UAC_VERSION_2
;
2382 if ((err
= snd_usb_mixer_controls(mixer
)) < 0 ||
2383 (err
= snd_usb_mixer_status_create(mixer
)) < 0)
2386 snd_usb_mixer_apply_create_quirk(mixer
);
2388 err
= snd_device_new(chip
->card
, SNDRV_DEV_LOWLEVEL
, mixer
, &dev_ops
);
2392 if (list_empty(&chip
->mixer_list
) &&
2393 !snd_card_proc_new(chip
->card
, "usbmixer", &entry
))
2394 snd_info_set_text_ops(entry
, chip
, snd_usb_mixer_proc_read
);
2396 list_add(&mixer
->list
, &chip
->mixer_list
);
2400 snd_usb_mixer_free(mixer
);
2404 void snd_usb_mixer_disconnect(struct list_head
*p
)
2406 struct usb_mixer_interface
*mixer
;
2408 mixer
= list_entry(p
, struct usb_mixer_interface
, list
);
2409 usb_kill_urb(mixer
->urb
);
2410 usb_kill_urb(mixer
->rc_urb
);