1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * (Tentative) USB Audio Driver for ALSA
7 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
9 * Many codes borrowed from audio.c by
10 * Alan Cox (alan@lxorguk.ukuu.org.uk)
11 * Thomas Sailer (sailer@ife.ee.ethz.ch)
15 * TODOs, for both the mixer and the streaming interfaces:
17 * - support for UAC2 effect units
18 * - support for graphical equalizers
19 * - RANGE and MEM set commands (UAC2)
20 * - RANGE and MEM interrupt dispatchers (UAC2)
21 * - audio channel clustering (UAC2)
22 * - audio sample rate converter units (UAC2)
23 * - proper handling of clock multipliers (UAC2)
24 * - dispatch clock change notifications (UAC2)
25 * - stop PCM streams which use a clock that became invalid
26 * - stop PCM streams which use a clock selector that has changed
27 * - parse available sample rates again when clock sources changed
30 #include <linux/bitops.h>
31 #include <linux/init.h>
32 #include <linux/list.h>
33 #include <linux/log2.h>
34 #include <linux/slab.h>
35 #include <linux/string.h>
36 #include <linux/usb.h>
37 #include <linux/usb/audio.h>
38 #include <linux/usb/audio-v2.h>
39 #include <linux/usb/audio-v3.h>
41 #include <sound/core.h>
42 #include <sound/control.h>
43 #include <sound/hwdep.h>
44 #include <sound/info.h>
45 #include <sound/tlv.h>
50 #include "mixer_quirks.h"
53 #define MAX_ID_ELEMS 256
55 struct usb_audio_term
{
59 unsigned int chconfig
;
63 struct usbmix_name_map
;
66 struct snd_usb_audio
*chip
;
67 struct usb_mixer_interface
*mixer
;
68 unsigned char *buffer
;
70 DECLARE_BITMAP(unitbitmap
, MAX_ID_ELEMS
);
71 DECLARE_BITMAP(termbitmap
, MAX_ID_ELEMS
);
72 struct usb_audio_term oterm
;
73 const struct usbmix_name_map
*map
;
74 const struct usbmix_selector_map
*selector_map
;
77 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
79 USB_XU_CLOCK_RATE
= 0xe301,
80 USB_XU_CLOCK_SOURCE
= 0xe302,
81 USB_XU_DIGITAL_IO_STATUS
= 0xe303,
82 USB_XU_DEVICE_OPTIONS
= 0xe304,
83 USB_XU_DIRECT_MONITORING
= 0xe305,
84 USB_XU_METERING
= 0xe306
87 USB_XU_CLOCK_SOURCE_SELECTOR
= 0x02, /* clock source*/
88 USB_XU_CLOCK_RATE_SELECTOR
= 0x03, /* clock rate */
89 USB_XU_DIGITAL_FORMAT_SELECTOR
= 0x01, /* the spdif format */
90 USB_XU_SOFT_LIMIT_SELECTOR
= 0x03 /* soft limiter */
94 * manual mapping of mixer names
95 * if the mixer topology is too complicated and the parsed names are
96 * ambiguous, add the entries in usbmixer_maps.c.
98 #include "mixer_maps.c"
100 static const struct usbmix_name_map
*
101 find_map(const struct usbmix_name_map
*p
, int unitid
, int control
)
107 if (p
->id
== unitid
&&
108 (!control
|| !p
->control
|| control
== p
->control
))
114 /* get the mapped name if the unit matches */
116 check_mapped_name(const struct usbmix_name_map
*p
, char *buf
, int buflen
)
122 return strlcpy(buf
, p
->name
, buflen
);
125 /* ignore the error value if ignore_ctl_error flag is set */
126 #define filter_error(cval, err) \
127 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
129 /* check whether the control should be ignored */
131 check_ignored_ctl(const struct usbmix_name_map
*p
)
133 if (!p
|| p
->name
|| p
->dB
)
139 static inline void check_mapped_dB(const struct usbmix_name_map
*p
,
140 struct usb_mixer_elem_info
*cval
)
143 cval
->dBmin
= p
->dB
->min
;
144 cval
->dBmax
= p
->dB
->max
;
145 cval
->initialized
= 1;
149 /* get the mapped selector source name */
150 static int check_mapped_selector_name(struct mixer_build
*state
, int unitid
,
151 int index
, char *buf
, int buflen
)
153 const struct usbmix_selector_map
*p
;
155 if (!state
->selector_map
)
157 for (p
= state
->selector_map
; p
->id
; p
++) {
158 if (p
->id
== unitid
&& index
< p
->count
)
159 return strlcpy(buf
, p
->names
[index
], buflen
);
165 * find an audio control unit with the given unit id
167 static void *find_audio_control_unit(struct mixer_build
*state
,
170 /* we just parse the header */
171 struct uac_feature_unit_descriptor
*hdr
= NULL
;
173 while ((hdr
= snd_usb_find_desc(state
->buffer
, state
->buflen
, hdr
,
174 USB_DT_CS_INTERFACE
)) != NULL
) {
175 if (hdr
->bLength
>= 4 &&
176 hdr
->bDescriptorSubtype
>= UAC_INPUT_TERMINAL
&&
177 hdr
->bDescriptorSubtype
<= UAC3_SAMPLE_RATE_CONVERTER
&&
178 hdr
->bUnitID
== unit
)
186 * copy a string with the given id
188 static int snd_usb_copy_string_desc(struct snd_usb_audio
*chip
,
189 int index
, char *buf
, int maxlen
)
191 int len
= usb_string(chip
->dev
, index
, buf
, maxlen
- 1);
201 * convert from the byte/word on usb descriptor to the zero-based integer
203 static int convert_signed_value(struct usb_mixer_elem_info
*cval
, int val
)
205 switch (cval
->val_type
) {
206 case USB_MIXER_BOOLEAN
:
208 case USB_MIXER_INV_BOOLEAN
:
231 * convert from the zero-based int to the byte/word for usb descriptor
233 static int convert_bytes_value(struct usb_mixer_elem_info
*cval
, int val
)
235 switch (cval
->val_type
) {
236 case USB_MIXER_BOOLEAN
:
238 case USB_MIXER_INV_BOOLEAN
:
247 return 0; /* not reached */
250 static int get_relative_value(struct usb_mixer_elem_info
*cval
, int val
)
256 else if (val
>= cval
->max
)
257 return (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
259 return (val
- cval
->min
) / cval
->res
;
262 static int get_abs_value(struct usb_mixer_elem_info
*cval
, int val
)
275 static int uac2_ctl_value_size(int val_type
)
287 return 0; /* unreachable */
292 * retrieve a mixer value
295 static int get_ctl_value_v1(struct usb_mixer_elem_info
*cval
, int request
,
296 int validx
, int *value_ret
)
298 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
299 unsigned char buf
[2];
300 int val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
304 err
= snd_usb_lock_shutdown(chip
);
308 while (timeout
-- > 0) {
309 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
310 err
= snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), request
,
311 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
312 validx
, idx
, buf
, val_len
);
313 if (err
>= val_len
) {
314 *value_ret
= convert_signed_value(cval
, snd_usb_combine_bytes(buf
, val_len
));
317 } else if (err
== -ETIMEDOUT
) {
322 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
323 request
, validx
, idx
, cval
->val_type
);
327 snd_usb_unlock_shutdown(chip
);
331 static int get_ctl_value_v2(struct usb_mixer_elem_info
*cval
, int request
,
332 int validx
, int *value_ret
)
334 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
335 /* enough space for one range */
336 unsigned char buf
[sizeof(__u16
) + 3 * sizeof(__u32
)];
338 int idx
= 0, ret
, val_size
, size
;
341 val_size
= uac2_ctl_value_size(cval
->val_type
);
343 if (request
== UAC_GET_CUR
) {
344 bRequest
= UAC2_CS_CUR
;
347 bRequest
= UAC2_CS_RANGE
;
348 size
= sizeof(__u16
) + 3 * val_size
;
351 memset(buf
, 0, sizeof(buf
));
353 ret
= snd_usb_lock_shutdown(chip
) ? -EIO
: 0;
357 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
358 ret
= snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), bRequest
,
359 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
360 validx
, idx
, buf
, size
);
361 snd_usb_unlock_shutdown(chip
);
366 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
367 request
, validx
, idx
, cval
->val_type
);
371 /* FIXME: how should we handle multiple triplets here? */
378 val
= buf
+ sizeof(__u16
);
381 val
= buf
+ sizeof(__u16
) + val_size
;
384 val
= buf
+ sizeof(__u16
) + val_size
* 2;
390 *value_ret
= convert_signed_value(cval
,
391 snd_usb_combine_bytes(val
, val_size
));
396 static int get_ctl_value(struct usb_mixer_elem_info
*cval
, int request
,
397 int validx
, int *value_ret
)
399 validx
+= cval
->idx_off
;
401 return (cval
->head
.mixer
->protocol
== UAC_VERSION_1
) ?
402 get_ctl_value_v1(cval
, request
, validx
, value_ret
) :
403 get_ctl_value_v2(cval
, request
, validx
, value_ret
);
406 static int get_cur_ctl_value(struct usb_mixer_elem_info
*cval
,
407 int validx
, int *value
)
409 return get_ctl_value(cval
, UAC_GET_CUR
, validx
, value
);
412 /* channel = 0: master, 1 = first channel */
413 static inline int get_cur_mix_raw(struct usb_mixer_elem_info
*cval
,
414 int channel
, int *value
)
416 return get_ctl_value(cval
, UAC_GET_CUR
,
417 (cval
->control
<< 8) | channel
,
421 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info
*cval
,
422 int channel
, int index
, int *value
)
426 if (cval
->cached
& (1 << channel
)) {
427 *value
= cval
->cache_val
[index
];
430 err
= get_cur_mix_raw(cval
, channel
, value
);
432 if (!cval
->head
.mixer
->ignore_ctl_error
)
433 usb_audio_dbg(cval
->head
.mixer
->chip
,
434 "cannot get current value for control %d ch %d: err = %d\n",
435 cval
->control
, channel
, err
);
438 cval
->cached
|= 1 << channel
;
439 cval
->cache_val
[index
] = *value
;
447 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info
*cval
,
448 int request
, int validx
, int value_set
)
450 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
451 unsigned char buf
[4];
452 int idx
= 0, val_len
, err
, timeout
= 10;
454 validx
+= cval
->idx_off
;
457 if (cval
->head
.mixer
->protocol
== UAC_VERSION_1
) {
458 val_len
= cval
->val_type
>= USB_MIXER_S16
? 2 : 1;
459 } else { /* UAC_VERSION_2/3 */
460 val_len
= uac2_ctl_value_size(cval
->val_type
);
463 if (request
!= UAC_SET_CUR
) {
464 usb_audio_dbg(chip
, "RANGE setting not yet supported\n");
468 request
= UAC2_CS_CUR
;
471 value_set
= convert_bytes_value(cval
, value_set
);
472 buf
[0] = value_set
& 0xff;
473 buf
[1] = (value_set
>> 8) & 0xff;
474 buf
[2] = (value_set
>> 16) & 0xff;
475 buf
[3] = (value_set
>> 24) & 0xff;
477 err
= snd_usb_lock_shutdown(chip
);
481 while (timeout
-- > 0) {
482 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
483 err
= snd_usb_ctl_msg(chip
->dev
,
484 usb_sndctrlpipe(chip
->dev
, 0), request
,
485 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
486 validx
, idx
, buf
, val_len
);
490 } else if (err
== -ETIMEDOUT
) {
494 usb_audio_dbg(chip
, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
495 request
, validx
, idx
, cval
->val_type
, buf
[0], buf
[1]);
499 snd_usb_unlock_shutdown(chip
);
503 static int set_cur_ctl_value(struct usb_mixer_elem_info
*cval
,
504 int validx
, int value
)
506 return snd_usb_mixer_set_ctl_value(cval
, UAC_SET_CUR
, validx
, value
);
509 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info
*cval
, int channel
,
510 int index
, int value
)
513 unsigned int read_only
= (channel
== 0) ?
514 cval
->master_readonly
:
515 cval
->ch_readonly
& (1 << (channel
- 1));
518 usb_audio_dbg(cval
->head
.mixer
->chip
,
519 "%s(): channel %d of control %d is read_only\n",
520 __func__
, channel
, cval
->control
);
524 err
= snd_usb_mixer_set_ctl_value(cval
,
525 UAC_SET_CUR
, (cval
->control
<< 8) | channel
,
529 cval
->cached
|= 1 << channel
;
530 cval
->cache_val
[index
] = value
;
535 * TLV callback for mixer volume controls
537 int snd_usb_mixer_vol_tlv(struct snd_kcontrol
*kcontrol
, int op_flag
,
538 unsigned int size
, unsigned int __user
*_tlv
)
540 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
541 DECLARE_TLV_DB_MINMAX(scale
, 0, 0);
543 if (size
< sizeof(scale
))
546 scale
[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE
;
547 scale
[2] = cval
->dBmin
;
548 scale
[3] = cval
->dBmax
;
549 if (copy_to_user(_tlv
, scale
, sizeof(scale
)))
555 * parser routines begin here...
558 static int parse_audio_unit(struct mixer_build
*state
, int unitid
);
562 * check if the input/output channel routing is enabled on the given bitmap.
563 * used for mixer unit parser
565 static int check_matrix_bitmap(unsigned char *bmap
,
566 int ich
, int och
, int num_outs
)
568 int idx
= ich
* num_outs
+ och
;
569 return bmap
[idx
>> 3] & (0x80 >> (idx
& 7));
573 * add an alsa control element
574 * search and increment the index until an empty slot is found.
576 * if failed, give up and free the control instance.
579 int snd_usb_mixer_add_control(struct usb_mixer_elem_list
*list
,
580 struct snd_kcontrol
*kctl
)
582 struct usb_mixer_interface
*mixer
= list
->mixer
;
585 while (snd_ctl_find_id(mixer
->chip
->card
, &kctl
->id
))
587 err
= snd_ctl_add(mixer
->chip
->card
, kctl
);
589 usb_audio_dbg(mixer
->chip
, "cannot add control (err = %d)\n",
594 list
->next_id_elem
= mixer
->id_elems
[list
->id
];
595 mixer
->id_elems
[list
->id
] = list
;
600 * get a terminal name string
603 static struct iterm_name_combo
{
607 { 0x0300, "Output" },
608 { 0x0301, "Speaker" },
609 { 0x0302, "Headphone" },
610 { 0x0303, "HMD Audio" },
611 { 0x0304, "Desktop Speaker" },
612 { 0x0305, "Room Speaker" },
613 { 0x0306, "Com Speaker" },
615 { 0x0600, "External In" },
616 { 0x0601, "Analog In" },
617 { 0x0602, "Digital In" },
619 { 0x0604, "Legacy In" },
620 { 0x0605, "IEC958 In" },
621 { 0x0606, "1394 DA Stream" },
622 { 0x0607, "1394 DV Stream" },
623 { 0x0700, "Embedded" },
624 { 0x0701, "Noise Source" },
625 { 0x0702, "Equalization Noise" },
629 { 0x0706, "MiniDisk" },
630 { 0x0707, "Analog Tape" },
631 { 0x0708, "Phonograph" },
632 { 0x0709, "VCR Audio" },
633 { 0x070a, "Video Disk Audio" },
634 { 0x070b, "DVD Audio" },
635 { 0x070c, "TV Tuner Audio" },
636 { 0x070d, "Satellite Rec Audio" },
637 { 0x070e, "Cable Tuner Audio" },
638 { 0x070f, "DSS Audio" },
639 { 0x0710, "Radio Receiver" },
640 { 0x0711, "Radio Transmitter" },
641 { 0x0712, "Multi-Track Recorder" },
642 { 0x0713, "Synthesizer" },
646 static int get_term_name(struct snd_usb_audio
*chip
, struct usb_audio_term
*iterm
,
647 unsigned char *name
, int maxlen
, int term_only
)
649 struct iterm_name_combo
*names
;
653 len
= snd_usb_copy_string_desc(chip
, iterm
->name
,
659 /* virtual type - not a real terminal */
660 if (iterm
->type
>> 16) {
663 switch (iterm
->type
>> 16) {
664 case UAC3_SELECTOR_UNIT
:
665 strcpy(name
, "Selector");
667 case UAC3_PROCESSING_UNIT
:
668 strcpy(name
, "Process Unit");
670 case UAC3_EXTENSION_UNIT
:
671 strcpy(name
, "Ext Unit");
673 case UAC3_MIXER_UNIT
:
674 strcpy(name
, "Mixer");
677 return sprintf(name
, "Unit %d", iterm
->id
);
681 switch (iterm
->type
& 0xff00) {
689 strcpy(name
, "Headset");
692 strcpy(name
, "Phone");
696 for (names
= iterm_names
; names
->type
; names
++) {
697 if (names
->type
== iterm
->type
) {
698 strcpy(name
, names
->name
);
699 return strlen(names
->name
);
707 * Get logical cluster information for UAC3 devices.
709 static int get_cluster_channels_v3(struct mixer_build
*state
, unsigned int cluster_id
)
711 struct uac3_cluster_header_descriptor c_header
;
714 err
= snd_usb_ctl_msg(state
->chip
->dev
,
715 usb_rcvctrlpipe(state
->chip
->dev
, 0),
716 UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR
,
717 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
719 snd_usb_ctrl_intf(state
->chip
),
720 &c_header
, sizeof(c_header
));
723 if (err
!= sizeof(c_header
)) {
728 return c_header
.bNrChannels
;
731 usb_audio_err(state
->chip
, "cannot request logical cluster ID: %d (err: %d)\n", cluster_id
, err
);
736 * Get number of channels for a Mixer Unit.
738 static int uac_mixer_unit_get_channels(struct mixer_build
*state
,
739 struct uac_mixer_unit_descriptor
*desc
)
743 switch (state
->mixer
->protocol
) {
747 if (desc
->bLength
< sizeof(*desc
) + desc
->bNrInPins
+ 1)
748 return 0; /* no bmControls -> skip */
749 mu_channels
= uac_mixer_unit_bNrChannels(desc
);
752 mu_channels
= get_cluster_channels_v3(state
,
753 uac3_mixer_unit_wClusterDescrID(desc
));
761 * Parse Input Terminal Unit
763 static int __check_input_term(struct mixer_build
*state
, int id
,
764 struct usb_audio_term
*term
);
766 static int parse_term_uac1_iterm_unit(struct mixer_build
*state
,
767 struct usb_audio_term
*term
,
770 struct uac_input_terminal_descriptor
*d
= p1
;
772 term
->type
= le16_to_cpu(d
->wTerminalType
);
773 term
->channels
= d
->bNrChannels
;
774 term
->chconfig
= le16_to_cpu(d
->wChannelConfig
);
775 term
->name
= d
->iTerminal
;
779 static int parse_term_uac2_iterm_unit(struct mixer_build
*state
,
780 struct usb_audio_term
*term
,
783 struct uac2_input_terminal_descriptor
*d
= p1
;
786 /* call recursively to verify the referenced clock entity */
787 err
= __check_input_term(state
, d
->bCSourceID
, term
);
791 /* save input term properties after recursion,
792 * to ensure they are not overriden by the recursion calls
795 term
->type
= le16_to_cpu(d
->wTerminalType
);
796 term
->channels
= d
->bNrChannels
;
797 term
->chconfig
= le32_to_cpu(d
->bmChannelConfig
);
798 term
->name
= d
->iTerminal
;
802 static int parse_term_uac3_iterm_unit(struct mixer_build
*state
,
803 struct usb_audio_term
*term
,
806 struct uac3_input_terminal_descriptor
*d
= p1
;
809 /* call recursively to verify the referenced clock entity */
810 err
= __check_input_term(state
, d
->bCSourceID
, term
);
814 /* save input term properties after recursion,
815 * to ensure they are not overriden by the recursion calls
818 term
->type
= le16_to_cpu(d
->wTerminalType
);
820 err
= get_cluster_channels_v3(state
, le16_to_cpu(d
->wClusterDescrID
));
823 term
->channels
= err
;
825 /* REVISIT: UAC3 IT doesn't have channels cfg */
828 term
->name
= le16_to_cpu(d
->wTerminalDescrStr
);
832 static int parse_term_mixer_unit(struct mixer_build
*state
,
833 struct usb_audio_term
*term
,
836 struct uac_mixer_unit_descriptor
*d
= p1
;
837 int protocol
= state
->mixer
->protocol
;
840 err
= uac_mixer_unit_get_channels(state
, d
);
844 term
->type
= UAC3_MIXER_UNIT
<< 16; /* virtual type */
845 term
->channels
= err
;
846 if (protocol
!= UAC_VERSION_3
) {
847 term
->chconfig
= uac_mixer_unit_wChannelConfig(d
, protocol
);
848 term
->name
= uac_mixer_unit_iMixer(d
);
853 static int parse_term_selector_unit(struct mixer_build
*state
,
854 struct usb_audio_term
*term
,
857 struct uac_selector_unit_descriptor
*d
= p1
;
860 /* call recursively to retrieve the channel info */
861 err
= __check_input_term(state
, d
->baSourceID
[0], term
);
864 term
->type
= UAC3_SELECTOR_UNIT
<< 16; /* virtual type */
866 if (state
->mixer
->protocol
!= UAC_VERSION_3
)
867 term
->name
= uac_selector_unit_iSelector(d
);
871 static int parse_term_proc_unit(struct mixer_build
*state
,
872 struct usb_audio_term
*term
,
873 void *p1
, int id
, int vtype
)
875 struct uac_processing_unit_descriptor
*d
= p1
;
876 int protocol
= state
->mixer
->protocol
;
880 /* call recursively to retrieve the channel info */
881 err
= __check_input_term(state
, d
->baSourceID
[0], term
);
886 term
->type
= vtype
<< 16; /* virtual type */
889 if (protocol
== UAC_VERSION_3
)
892 if (!term
->channels
) {
893 term
->channels
= uac_processing_unit_bNrChannels(d
);
894 term
->chconfig
= uac_processing_unit_wChannelConfig(d
, protocol
);
896 term
->name
= uac_processing_unit_iProcessing(d
, protocol
);
900 static int parse_term_uac2_clock_source(struct mixer_build
*state
,
901 struct usb_audio_term
*term
,
904 struct uac_clock_source_descriptor
*d
= p1
;
906 term
->type
= UAC3_CLOCK_SOURCE
<< 16; /* virtual type */
908 term
->name
= d
->iClockSource
;
912 static int parse_term_uac3_clock_source(struct mixer_build
*state
,
913 struct usb_audio_term
*term
,
916 struct uac3_clock_source_descriptor
*d
= p1
;
918 term
->type
= UAC3_CLOCK_SOURCE
<< 16; /* virtual type */
920 term
->name
= le16_to_cpu(d
->wClockSourceStr
);
924 #define PTYPE(a, b) ((a) << 8 | (b))
927 * parse the source unit recursively until it reaches to a terminal
928 * or a branched unit.
930 static int __check_input_term(struct mixer_build
*state
, int id
,
931 struct usb_audio_term
*term
)
933 int protocol
= state
->mixer
->protocol
;
938 /* a loop in the terminal chain? */
939 if (test_and_set_bit(id
, state
->termbitmap
))
942 p1
= find_audio_control_unit(state
, id
);
945 if (!snd_usb_validate_audio_desc(p1
, protocol
))
946 break; /* bad descriptor */
951 switch (PTYPE(protocol
, hdr
[2])) {
952 case PTYPE(UAC_VERSION_1
, UAC_FEATURE_UNIT
):
953 case PTYPE(UAC_VERSION_2
, UAC_FEATURE_UNIT
):
954 case PTYPE(UAC_VERSION_3
, UAC3_FEATURE_UNIT
): {
955 /* the header is the same for all versions */
956 struct uac_feature_unit_descriptor
*d
= p1
;
959 break; /* continue to parse */
961 case PTYPE(UAC_VERSION_1
, UAC_INPUT_TERMINAL
):
962 return parse_term_uac1_iterm_unit(state
, term
, p1
, id
);
963 case PTYPE(UAC_VERSION_2
, UAC_INPUT_TERMINAL
):
964 return parse_term_uac2_iterm_unit(state
, term
, p1
, id
);
965 case PTYPE(UAC_VERSION_3
, UAC_INPUT_TERMINAL
):
966 return parse_term_uac3_iterm_unit(state
, term
, p1
, id
);
967 case PTYPE(UAC_VERSION_1
, UAC_MIXER_UNIT
):
968 case PTYPE(UAC_VERSION_2
, UAC_MIXER_UNIT
):
969 case PTYPE(UAC_VERSION_3
, UAC3_MIXER_UNIT
):
970 return parse_term_mixer_unit(state
, term
, p1
, id
);
971 case PTYPE(UAC_VERSION_1
, UAC_SELECTOR_UNIT
):
972 case PTYPE(UAC_VERSION_2
, UAC_SELECTOR_UNIT
):
973 case PTYPE(UAC_VERSION_2
, UAC2_CLOCK_SELECTOR
):
974 case PTYPE(UAC_VERSION_3
, UAC3_SELECTOR_UNIT
):
975 case PTYPE(UAC_VERSION_3
, UAC3_CLOCK_SELECTOR
):
976 return parse_term_selector_unit(state
, term
, p1
, id
);
977 case PTYPE(UAC_VERSION_1
, UAC1_PROCESSING_UNIT
):
978 case PTYPE(UAC_VERSION_2
, UAC2_PROCESSING_UNIT_V2
):
979 case PTYPE(UAC_VERSION_3
, UAC3_PROCESSING_UNIT
):
980 return parse_term_proc_unit(state
, term
, p1
, id
,
981 UAC3_PROCESSING_UNIT
);
982 case PTYPE(UAC_VERSION_2
, UAC2_EFFECT_UNIT
):
983 case PTYPE(UAC_VERSION_3
, UAC3_EFFECT_UNIT
):
984 return parse_term_proc_unit(state
, term
, p1
, id
,
986 case PTYPE(UAC_VERSION_1
, UAC1_EXTENSION_UNIT
):
987 case PTYPE(UAC_VERSION_2
, UAC2_EXTENSION_UNIT_V2
):
988 case PTYPE(UAC_VERSION_3
, UAC3_EXTENSION_UNIT
):
989 return parse_term_proc_unit(state
, term
, p1
, id
,
990 UAC3_EXTENSION_UNIT
);
991 case PTYPE(UAC_VERSION_2
, UAC2_CLOCK_SOURCE
):
992 return parse_term_uac2_clock_source(state
, term
, p1
, id
);
993 case PTYPE(UAC_VERSION_3
, UAC3_CLOCK_SOURCE
):
994 return parse_term_uac3_clock_source(state
, term
, p1
, id
);
1003 static int check_input_term(struct mixer_build
*state
, int id
,
1004 struct usb_audio_term
*term
)
1006 memset(term
, 0, sizeof(*term
));
1007 memset(state
->termbitmap
, 0, sizeof(state
->termbitmap
));
1008 return __check_input_term(state
, id
, term
);
1015 /* feature unit control information */
1016 struct usb_feature_control_info
{
1019 int type
; /* data type for uac1 */
1020 int type_uac2
; /* data type for uac2 if different from uac1, else -1 */
1023 static struct usb_feature_control_info audio_feature_info
[] = {
1024 { UAC_FU_MUTE
, "Mute", USB_MIXER_INV_BOOLEAN
, -1 },
1025 { UAC_FU_VOLUME
, "Volume", USB_MIXER_S16
, -1 },
1026 { UAC_FU_BASS
, "Tone Control - Bass", USB_MIXER_S8
, -1 },
1027 { UAC_FU_MID
, "Tone Control - Mid", USB_MIXER_S8
, -1 },
1028 { UAC_FU_TREBLE
, "Tone Control - Treble", USB_MIXER_S8
, -1 },
1029 { UAC_FU_GRAPHIC_EQUALIZER
, "Graphic Equalizer", USB_MIXER_S8
, -1 }, /* FIXME: not implemented yet */
1030 { UAC_FU_AUTOMATIC_GAIN
, "Auto Gain Control", USB_MIXER_BOOLEAN
, -1 },
1031 { UAC_FU_DELAY
, "Delay Control", USB_MIXER_U16
, USB_MIXER_U32
},
1032 { UAC_FU_BASS_BOOST
, "Bass Boost", USB_MIXER_BOOLEAN
, -1 },
1033 { UAC_FU_LOUDNESS
, "Loudness", USB_MIXER_BOOLEAN
, -1 },
1035 { UAC2_FU_INPUT_GAIN
, "Input Gain Control", USB_MIXER_S16
, -1 },
1036 { UAC2_FU_INPUT_GAIN_PAD
, "Input Gain Pad Control", USB_MIXER_S16
, -1 },
1037 { UAC2_FU_PHASE_INVERTER
, "Phase Inverter Control", USB_MIXER_BOOLEAN
, -1 },
1040 static void usb_mixer_elem_info_free(struct usb_mixer_elem_info
*cval
)
1045 /* private_free callback */
1046 void snd_usb_mixer_elem_free(struct snd_kcontrol
*kctl
)
1048 usb_mixer_elem_info_free(kctl
->private_data
);
1049 kctl
->private_data
= NULL
;
1053 * interface to ALSA control for feature/mixer units
1056 /* volume control quirks */
1057 static void volume_control_quirks(struct usb_mixer_elem_info
*cval
,
1058 struct snd_kcontrol
*kctl
)
1060 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
1061 switch (chip
->usb_id
) {
1062 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
1063 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
1064 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
1070 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
1071 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
1076 if (strstr(kctl
->id
.name
, "Effect Return") != NULL
) {
1082 if ((strstr(kctl
->id
.name
, "Playback Volume") != NULL
) ||
1083 (strstr(kctl
->id
.name
, "Effect Send") != NULL
)) {
1084 cval
->min
= 0xb5fb; /* -73 dB = 0xb6ff */
1090 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
1091 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
1092 if (strcmp(kctl
->id
.name
, "Effect Duration") == 0) {
1093 usb_audio_info(chip
,
1094 "set quirk for FTU Effect Duration\n");
1100 if (strcmp(kctl
->id
.name
, "Effect Volume") == 0 ||
1101 strcmp(kctl
->id
.name
, "Effect Feedback Volume") == 0) {
1102 usb_audio_info(chip
,
1103 "set quirks for FTU Effect Feedback/Volume\n");
1110 case USB_ID(0x0d8c, 0x0103):
1111 if (!strcmp(kctl
->id
.name
, "PCM Playback Volume")) {
1112 usb_audio_info(chip
,
1113 "set volume quirk for CM102-A+/102S+\n");
1118 case USB_ID(0x0471, 0x0101):
1119 case USB_ID(0x0471, 0x0104):
1120 case USB_ID(0x0471, 0x0105):
1121 case USB_ID(0x0672, 0x1041):
1122 /* quirk for UDA1321/N101.
1123 * note that detection between firmware 2.1.1.7 (N101)
1124 * and later 2.1.1.21 is not very clear from datasheets.
1125 * I hope that the min value is -15360 for newer firmware --jk
1127 if (!strcmp(kctl
->id
.name
, "PCM Playback Volume") &&
1128 cval
->min
== -15616) {
1129 usb_audio_info(chip
,
1130 "set volume quirk for UDA1321/N101 chip\n");
1135 case USB_ID(0x046d, 0x09a4):
1136 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
1137 usb_audio_info(chip
,
1138 "set volume quirk for QuickCam E3500\n");
1145 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
1146 case USB_ID(0x046d, 0x0808):
1147 case USB_ID(0x046d, 0x0809):
1148 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1149 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1150 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1151 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1152 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1153 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1154 case USB_ID(0x046d, 0x0991):
1155 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1156 /* Most audio usb devices lie about volume resolution.
1157 * Most Logitech webcams have res = 384.
1158 * Probably there is some logitech magic behind this number --fishor
1160 if (!strcmp(kctl
->id
.name
, "Mic Capture Volume")) {
1161 usb_audio_info(chip
,
1162 "set resolution quirk: cval->res = 384\n");
1170 * retrieve the minimum and maximum values for the specified control
1172 static int get_min_max_with_quirks(struct usb_mixer_elem_info
*cval
,
1173 int default_min
, struct snd_kcontrol
*kctl
)
1176 cval
->min
= default_min
;
1177 cval
->max
= cval
->min
+ 1;
1179 cval
->dBmin
= cval
->dBmax
= 0;
1181 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1182 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
1183 cval
->initialized
= 1;
1188 for (i
= 0; i
< MAX_CHANNELS
; i
++)
1189 if (cval
->cmask
& (1 << i
)) {
1194 if (get_ctl_value(cval
, UAC_GET_MAX
, (cval
->control
<< 8) | minchn
, &cval
->max
) < 0 ||
1195 get_ctl_value(cval
, UAC_GET_MIN
, (cval
->control
<< 8) | minchn
, &cval
->min
) < 0) {
1196 usb_audio_err(cval
->head
.mixer
->chip
,
1197 "%d:%d: cannot get min/max values for control %d (id %d)\n",
1198 cval
->head
.id
, snd_usb_ctrl_intf(cval
->head
.mixer
->chip
),
1199 cval
->control
, cval
->head
.id
);
1202 if (get_ctl_value(cval
, UAC_GET_RES
,
1203 (cval
->control
<< 8) | minchn
,
1207 int last_valid_res
= cval
->res
;
1209 while (cval
->res
> 1) {
1210 if (snd_usb_mixer_set_ctl_value(cval
, UAC_SET_RES
,
1211 (cval
->control
<< 8) | minchn
,
1216 if (get_ctl_value(cval
, UAC_GET_RES
,
1217 (cval
->control
<< 8) | minchn
, &cval
->res
) < 0)
1218 cval
->res
= last_valid_res
;
1223 /* Additional checks for the proper resolution
1225 * Some devices report smaller resolutions than actually
1226 * reacting. They don't return errors but simply clip
1227 * to the lower aligned value.
1229 if (cval
->min
+ cval
->res
< cval
->max
) {
1230 int last_valid_res
= cval
->res
;
1231 int saved
, test
, check
;
1232 if (get_cur_mix_raw(cval
, minchn
, &saved
) < 0)
1236 if (test
< cval
->max
)
1240 if (test
< cval
->min
|| test
> cval
->max
||
1241 snd_usb_set_cur_mix_value(cval
, minchn
, 0, test
) ||
1242 get_cur_mix_raw(cval
, minchn
, &check
)) {
1243 cval
->res
= last_valid_res
;
1250 snd_usb_set_cur_mix_value(cval
, minchn
, 0, saved
);
1254 cval
->initialized
= 1;
1258 volume_control_quirks(cval
, kctl
);
1260 /* USB descriptions contain the dB scale in 1/256 dB unit
1261 * while ALSA TLV contains in 1/100 dB unit
1263 cval
->dBmin
= (convert_signed_value(cval
, cval
->min
) * 100) / 256;
1264 cval
->dBmax
= (convert_signed_value(cval
, cval
->max
) * 100) / 256;
1265 if (cval
->dBmin
> cval
->dBmax
) {
1266 /* something is wrong; assume it's either from/to 0dB */
1267 if (cval
->dBmin
< 0)
1269 else if (cval
->dBmin
> 0)
1271 if (cval
->dBmin
> cval
->dBmax
) {
1272 /* totally crap, return an error */
1280 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1282 /* get a feature/mixer unit info */
1283 static int mixer_ctl_feature_info(struct snd_kcontrol
*kcontrol
,
1284 struct snd_ctl_elem_info
*uinfo
)
1286 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1288 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1289 cval
->val_type
== USB_MIXER_INV_BOOLEAN
)
1290 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1292 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
1293 uinfo
->count
= cval
->channels
;
1294 if (cval
->val_type
== USB_MIXER_BOOLEAN
||
1295 cval
->val_type
== USB_MIXER_INV_BOOLEAN
) {
1296 uinfo
->value
.integer
.min
= 0;
1297 uinfo
->value
.integer
.max
= 1;
1299 if (!cval
->initialized
) {
1300 get_min_max_with_quirks(cval
, 0, kcontrol
);
1301 if (cval
->initialized
&& cval
->dBmin
>= cval
->dBmax
) {
1302 kcontrol
->vd
[0].access
&=
1303 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1304 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
);
1305 snd_ctl_notify(cval
->head
.mixer
->chip
->card
,
1306 SNDRV_CTL_EVENT_MASK_INFO
,
1310 uinfo
->value
.integer
.min
= 0;
1311 uinfo
->value
.integer
.max
=
1312 (cval
->max
- cval
->min
+ cval
->res
- 1) / cval
->res
;
1317 /* get the current value from feature/mixer unit */
1318 static int mixer_ctl_feature_get(struct snd_kcontrol
*kcontrol
,
1319 struct snd_ctl_elem_value
*ucontrol
)
1321 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1322 int c
, cnt
, val
, err
;
1324 ucontrol
->value
.integer
.value
[0] = cval
->min
;
1327 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1328 if (!(cval
->cmask
& (1 << c
)))
1330 err
= snd_usb_get_cur_mix_value(cval
, c
+ 1, cnt
, &val
);
1332 return filter_error(cval
, err
);
1333 val
= get_relative_value(cval
, val
);
1334 ucontrol
->value
.integer
.value
[cnt
] = val
;
1339 /* master channel */
1340 err
= snd_usb_get_cur_mix_value(cval
, 0, 0, &val
);
1342 return filter_error(cval
, err
);
1343 val
= get_relative_value(cval
, val
);
1344 ucontrol
->value
.integer
.value
[0] = val
;
1349 /* put the current value to feature/mixer unit */
1350 static int mixer_ctl_feature_put(struct snd_kcontrol
*kcontrol
,
1351 struct snd_ctl_elem_value
*ucontrol
)
1353 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1354 int c
, cnt
, val
, oval
, err
;
1359 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
1360 if (!(cval
->cmask
& (1 << c
)))
1362 err
= snd_usb_get_cur_mix_value(cval
, c
+ 1, cnt
, &oval
);
1364 return filter_error(cval
, err
);
1365 val
= ucontrol
->value
.integer
.value
[cnt
];
1366 val
= get_abs_value(cval
, val
);
1368 snd_usb_set_cur_mix_value(cval
, c
+ 1, cnt
, val
);
1374 /* master channel */
1375 err
= snd_usb_get_cur_mix_value(cval
, 0, 0, &oval
);
1377 return filter_error(cval
, err
);
1378 val
= ucontrol
->value
.integer
.value
[0];
1379 val
= get_abs_value(cval
, val
);
1381 snd_usb_set_cur_mix_value(cval
, 0, 0, val
);
1388 /* get the boolean value from the master channel of a UAC control */
1389 static int mixer_ctl_master_bool_get(struct snd_kcontrol
*kcontrol
,
1390 struct snd_ctl_elem_value
*ucontrol
)
1392 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1395 err
= snd_usb_get_cur_mix_value(cval
, 0, 0, &val
);
1397 return filter_error(cval
, err
);
1399 ucontrol
->value
.integer
.value
[0] = val
;
1403 /* get the connectors status and report it as boolean type */
1404 static int mixer_ctl_connector_get(struct snd_kcontrol
*kcontrol
,
1405 struct snd_ctl_elem_value
*ucontrol
)
1407 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
1408 struct snd_usb_audio
*chip
= cval
->head
.mixer
->chip
;
1409 int idx
= 0, validx
, ret
, val
;
1411 validx
= cval
->control
<< 8 | 0;
1413 ret
= snd_usb_lock_shutdown(chip
) ? -EIO
: 0;
1417 idx
= snd_usb_ctrl_intf(chip
) | (cval
->head
.id
<< 8);
1418 if (cval
->head
.mixer
->protocol
== UAC_VERSION_2
) {
1419 struct uac2_connectors_ctl_blk uac2_conn
;
1421 ret
= snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), UAC2_CS_CUR
,
1422 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
1423 validx
, idx
, &uac2_conn
, sizeof(uac2_conn
));
1424 val
= !!uac2_conn
.bNrChannels
;
1425 } else { /* UAC_VERSION_3 */
1426 struct uac3_insertion_ctl_blk uac3_conn
;
1428 ret
= snd_usb_ctl_msg(chip
->dev
, usb_rcvctrlpipe(chip
->dev
, 0), UAC2_CS_CUR
,
1429 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_IN
,
1430 validx
, idx
, &uac3_conn
, sizeof(uac3_conn
));
1431 val
= !!uac3_conn
.bmConInserted
;
1434 snd_usb_unlock_shutdown(chip
);
1439 "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1440 UAC_GET_CUR
, validx
, idx
, cval
->val_type
);
1444 ucontrol
->value
.integer
.value
[0] = val
;
1448 static struct snd_kcontrol_new usb_feature_unit_ctl
= {
1449 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1450 .name
= "", /* will be filled later manually */
1451 .info
= mixer_ctl_feature_info
,
1452 .get
= mixer_ctl_feature_get
,
1453 .put
= mixer_ctl_feature_put
,
1456 /* the read-only variant */
1457 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro
= {
1458 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1459 .name
= "", /* will be filled later manually */
1460 .info
= mixer_ctl_feature_info
,
1461 .get
= mixer_ctl_feature_get
,
1466 * A control which shows the boolean value from reading a UAC control on
1467 * the master channel.
1469 static struct snd_kcontrol_new usb_bool_master_control_ctl_ro
= {
1470 .iface
= SNDRV_CTL_ELEM_IFACE_CARD
,
1471 .name
= "", /* will be filled later manually */
1472 .access
= SNDRV_CTL_ELEM_ACCESS_READ
,
1473 .info
= snd_ctl_boolean_mono_info
,
1474 .get
= mixer_ctl_master_bool_get
,
1478 static const struct snd_kcontrol_new usb_connector_ctl_ro
= {
1479 .iface
= SNDRV_CTL_ELEM_IFACE_CARD
,
1480 .name
= "", /* will be filled later manually */
1481 .access
= SNDRV_CTL_ELEM_ACCESS_READ
,
1482 .info
= snd_ctl_boolean_mono_info
,
1483 .get
= mixer_ctl_connector_get
,
1488 * This symbol is exported in order to allow the mixer quirks to
1489 * hook up to the standard feature unit control mechanism
1491 struct snd_kcontrol_new
*snd_usb_feature_unit_ctl
= &usb_feature_unit_ctl
;
1494 * build a feature control
1496 static size_t append_ctl_name(struct snd_kcontrol
*kctl
, const char *str
)
1498 return strlcat(kctl
->id
.name
, str
, sizeof(kctl
->id
.name
));
1502 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1503 * rename it to "Headphone". We determine if something is a headphone
1504 * similar to how udev determines form factor.
1506 static void check_no_speaker_on_headset(struct snd_kcontrol
*kctl
,
1507 struct snd_card
*card
)
1509 const char *names_to_check
[] = {
1510 "Headset", "headset", "Headphone", "headphone", NULL
};
1514 if (strcmp("Speaker", kctl
->id
.name
))
1517 for (s
= names_to_check
; *s
; s
++)
1518 if (strstr(card
->shortname
, *s
)) {
1526 strlcpy(kctl
->id
.name
, "Headphone", sizeof(kctl
->id
.name
));
1529 static struct usb_feature_control_info
*get_feature_control_info(int control
)
1533 for (i
= 0; i
< ARRAY_SIZE(audio_feature_info
); ++i
) {
1534 if (audio_feature_info
[i
].control
== control
)
1535 return &audio_feature_info
[i
];
1540 static void __build_feature_ctl(struct usb_mixer_interface
*mixer
,
1541 const struct usbmix_name_map
*imap
,
1542 unsigned int ctl_mask
, int control
,
1543 struct usb_audio_term
*iterm
,
1544 struct usb_audio_term
*oterm
,
1545 int unitid
, int nameid
, int readonly_mask
)
1547 struct usb_feature_control_info
*ctl_info
;
1548 unsigned int len
= 0;
1549 int mapped_name
= 0;
1550 struct snd_kcontrol
*kctl
;
1551 struct usb_mixer_elem_info
*cval
;
1552 const struct usbmix_name_map
*map
;
1555 if (control
== UAC_FU_GRAPHIC_EQUALIZER
) {
1556 /* FIXME: not supported yet */
1560 map
= find_map(imap
, unitid
, control
);
1561 if (check_ignored_ctl(map
))
1564 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1567 snd_usb_mixer_elem_init_std(&cval
->head
, mixer
, unitid
);
1568 cval
->control
= control
;
1569 cval
->cmask
= ctl_mask
;
1571 ctl_info
= get_feature_control_info(control
);
1573 usb_mixer_elem_info_free(cval
);
1576 if (mixer
->protocol
== UAC_VERSION_1
)
1577 cval
->val_type
= ctl_info
->type
;
1578 else /* UAC_VERSION_2 */
1579 cval
->val_type
= ctl_info
->type_uac2
>= 0 ?
1580 ctl_info
->type_uac2
: ctl_info
->type
;
1582 if (ctl_mask
== 0) {
1583 cval
->channels
= 1; /* master channel */
1584 cval
->master_readonly
= readonly_mask
;
1587 for (i
= 0; i
< 16; i
++)
1588 if (ctl_mask
& (1 << i
))
1591 cval
->ch_readonly
= readonly_mask
;
1595 * If all channels in the mask are marked read-only, make the control
1596 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1597 * issue write commands to read-only channels.
1599 if (cval
->channels
== readonly_mask
)
1600 kctl
= snd_ctl_new1(&usb_feature_unit_ctl_ro
, cval
);
1602 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
1605 usb_audio_err(mixer
->chip
, "cannot malloc kcontrol\n");
1606 usb_mixer_elem_info_free(cval
);
1609 kctl
->private_free
= snd_usb_mixer_elem_free
;
1611 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
1612 mapped_name
= len
!= 0;
1614 len
= snd_usb_copy_string_desc(mixer
->chip
, nameid
,
1615 kctl
->id
.name
, sizeof(kctl
->id
.name
));
1621 * determine the control name. the rule is:
1622 * - if a name id is given in descriptor, use it.
1623 * - if the connected input can be determined, then use the name
1625 * - if the connected output can be determined, use it.
1626 * - otherwise, anonymous name.
1630 len
= get_term_name(mixer
->chip
, iterm
,
1632 sizeof(kctl
->id
.name
), 1);
1634 len
= get_term_name(mixer
->chip
, oterm
,
1636 sizeof(kctl
->id
.name
), 1);
1638 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1639 "Feature %d", unitid
);
1643 check_no_speaker_on_headset(kctl
, mixer
->chip
->card
);
1646 * determine the stream direction:
1647 * if the connected output is USB stream, then it's likely a
1648 * capture stream. otherwise it should be playback (hopefully :)
1650 if (!mapped_name
&& oterm
&& !(oterm
->type
>> 16)) {
1651 if ((oterm
->type
& 0xff00) == 0x0100)
1652 append_ctl_name(kctl
, " Capture");
1654 append_ctl_name(kctl
, " Playback");
1656 append_ctl_name(kctl
, control
== UAC_FU_MUTE
?
1657 " Switch" : " Volume");
1661 strlcpy(kctl
->id
.name
, audio_feature_info
[control
-1].name
,
1662 sizeof(kctl
->id
.name
));
1666 /* get min/max values */
1667 get_min_max_with_quirks(cval
, 0, kctl
);
1669 if (control
== UAC_FU_VOLUME
) {
1670 check_mapped_dB(map
, cval
);
1671 if (cval
->dBmin
< cval
->dBmax
|| !cval
->initialized
) {
1672 kctl
->tlv
.c
= snd_usb_mixer_vol_tlv
;
1673 kctl
->vd
[0].access
|=
1674 SNDRV_CTL_ELEM_ACCESS_TLV_READ
|
1675 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
;
1679 snd_usb_mixer_fu_apply_quirk(mixer
, cval
, unitid
, kctl
);
1681 range
= (cval
->max
- cval
->min
) / cval
->res
;
1683 * Are there devices with volume range more than 255? I use a bit more
1684 * to be sure. 384 is a resolution magic number found on Logitech
1685 * devices. It will definitively catch all buggy Logitech devices.
1688 usb_audio_warn(mixer
->chip
,
1689 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1691 usb_audio_warn(mixer
->chip
,
1692 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1693 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1694 cval
->min
, cval
->max
, cval
->res
);
1697 usb_audio_dbg(mixer
->chip
, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1698 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
1699 cval
->min
, cval
->max
, cval
->res
);
1700 snd_usb_mixer_add_control(&cval
->head
, kctl
);
1703 static void build_feature_ctl(struct mixer_build
*state
, void *raw_desc
,
1704 unsigned int ctl_mask
, int control
,
1705 struct usb_audio_term
*iterm
, int unitid
,
1708 struct uac_feature_unit_descriptor
*desc
= raw_desc
;
1709 int nameid
= uac_feature_unit_iFeature(desc
);
1711 __build_feature_ctl(state
->mixer
, state
->map
, ctl_mask
, control
,
1712 iterm
, &state
->oterm
, unitid
, nameid
, readonly_mask
);
1715 static void build_feature_ctl_badd(struct usb_mixer_interface
*mixer
,
1716 unsigned int ctl_mask
, int control
, int unitid
,
1717 const struct usbmix_name_map
*badd_map
)
1719 __build_feature_ctl(mixer
, badd_map
, ctl_mask
, control
,
1720 NULL
, NULL
, unitid
, 0, 0);
1723 static void get_connector_control_name(struct usb_mixer_interface
*mixer
,
1724 struct usb_audio_term
*term
,
1725 bool is_input
, char *name
, int name_size
)
1727 int name_len
= get_term_name(mixer
->chip
, term
, name
, name_size
, 0);
1730 strlcpy(name
, "Unknown", name_size
);
1733 * sound/core/ctljack.c has a convention of naming jack controls
1734 * by ending in " Jack". Make it slightly more useful by
1735 * indicating Input or Output after the terminal name.
1738 strlcat(name
, " - Input Jack", name_size
);
1740 strlcat(name
, " - Output Jack", name_size
);
1743 /* Build a mixer control for a UAC connector control (jack-detect) */
1744 static void build_connector_control(struct usb_mixer_interface
*mixer
,
1745 struct usb_audio_term
*term
, bool is_input
)
1747 struct snd_kcontrol
*kctl
;
1748 struct usb_mixer_elem_info
*cval
;
1750 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1753 snd_usb_mixer_elem_init_std(&cval
->head
, mixer
, term
->id
);
1755 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1756 * number of channels connected.
1758 * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1759 * following byte(s) specifies which connectors are inserted.
1761 * This boolean ctl will simply report if any channels are connected
1764 if (mixer
->protocol
== UAC_VERSION_2
)
1765 cval
->control
= UAC2_TE_CONNECTOR
;
1766 else /* UAC_VERSION_3 */
1767 cval
->control
= UAC3_TE_INSERTION
;
1769 cval
->val_type
= USB_MIXER_BOOLEAN
;
1770 cval
->channels
= 1; /* report true if any channel is connected */
1773 kctl
= snd_ctl_new1(&usb_connector_ctl_ro
, cval
);
1775 usb_audio_err(mixer
->chip
, "cannot malloc kcontrol\n");
1776 usb_mixer_elem_info_free(cval
);
1779 get_connector_control_name(mixer
, term
, is_input
, kctl
->id
.name
,
1780 sizeof(kctl
->id
.name
));
1781 kctl
->private_free
= snd_usb_mixer_elem_free
;
1782 snd_usb_mixer_add_control(&cval
->head
, kctl
);
1785 static int parse_clock_source_unit(struct mixer_build
*state
, int unitid
,
1788 struct uac_clock_source_descriptor
*hdr
= _ftr
;
1789 struct usb_mixer_elem_info
*cval
;
1790 struct snd_kcontrol
*kctl
;
1791 char name
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
1794 if (state
->mixer
->protocol
!= UAC_VERSION_2
)
1798 * The only property of this unit we are interested in is the
1799 * clock source validity. If that isn't readable, just bail out.
1801 if (!uac_v2v3_control_is_readable(hdr
->bmControls
,
1802 UAC2_CS_CONTROL_CLOCK_VALID
))
1805 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
1809 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, hdr
->bClockID
);
1814 cval
->val_type
= USB_MIXER_BOOLEAN
;
1815 cval
->control
= UAC2_CS_CONTROL_CLOCK_VALID
;
1817 cval
->master_readonly
= 1;
1818 /* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1819 kctl
= snd_ctl_new1(&usb_bool_master_control_ctl_ro
, cval
);
1822 usb_mixer_elem_info_free(cval
);
1826 kctl
->private_free
= snd_usb_mixer_elem_free
;
1827 ret
= snd_usb_copy_string_desc(state
->chip
, hdr
->iClockSource
,
1828 name
, sizeof(name
));
1830 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1831 "%s Validity", name
);
1833 snprintf(kctl
->id
.name
, sizeof(kctl
->id
.name
),
1834 "Clock Source %d Validity", hdr
->bClockID
);
1836 return snd_usb_mixer_add_control(&cval
->head
, kctl
);
1840 * parse a feature unit
1842 * most of controls are defined here.
1844 static int parse_audio_feature_unit(struct mixer_build
*state
, int unitid
,
1848 struct usb_audio_term iterm
;
1849 unsigned int master_bits
;
1851 struct uac_feature_unit_descriptor
*hdr
= _ftr
;
1854 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1855 csize
= hdr
->bControlSize
;
1856 channels
= (hdr
->bLength
- 7) / csize
- 1;
1857 bmaControls
= hdr
->bmaControls
;
1858 } else if (state
->mixer
->protocol
== UAC_VERSION_2
) {
1859 struct uac2_feature_unit_descriptor
*ftr
= _ftr
;
1861 channels
= (hdr
->bLength
- 6) / 4 - 1;
1862 bmaControls
= ftr
->bmaControls
;
1863 } else { /* UAC_VERSION_3 */
1864 struct uac3_feature_unit_descriptor
*ftr
= _ftr
;
1867 channels
= (ftr
->bLength
- 7) / 4 - 1;
1868 bmaControls
= ftr
->bmaControls
;
1871 /* parse the source unit */
1872 err
= parse_audio_unit(state
, hdr
->bSourceID
);
1876 /* determine the input source type and name */
1877 err
= check_input_term(state
, hdr
->bSourceID
, &iterm
);
1881 master_bits
= snd_usb_combine_bytes(bmaControls
, csize
);
1882 /* master configuration quirks */
1883 switch (state
->chip
->usb_id
) {
1884 case USB_ID(0x08bb, 0x2702):
1885 usb_audio_info(state
->chip
,
1886 "usbmixer: master volume quirk for PCM2702 chip\n");
1887 /* disable non-functional volume control */
1888 master_bits
&= ~UAC_CONTROL_BIT(UAC_FU_VOLUME
);
1890 case USB_ID(0x1130, 0xf211):
1891 usb_audio_info(state
->chip
,
1892 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1893 /* disable non-functional volume control */
1899 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
1900 /* check all control types */
1901 for (i
= 0; i
< 10; i
++) {
1902 unsigned int ch_bits
= 0;
1903 int control
= audio_feature_info
[i
].control
;
1905 for (j
= 0; j
< channels
; j
++) {
1908 mask
= snd_usb_combine_bytes(bmaControls
+
1909 csize
* (j
+1), csize
);
1910 if (mask
& (1 << i
))
1911 ch_bits
|= (1 << j
);
1913 /* audio class v1 controls are never read-only */
1916 * The first channel must be set
1917 * (for ease of programming).
1920 build_feature_ctl(state
, _ftr
, ch_bits
, control
,
1922 if (master_bits
& (1 << i
))
1923 build_feature_ctl(state
, _ftr
, 0, control
,
1926 } else { /* UAC_VERSION_2/3 */
1927 for (i
= 0; i
< ARRAY_SIZE(audio_feature_info
); i
++) {
1928 unsigned int ch_bits
= 0;
1929 unsigned int ch_read_only
= 0;
1930 int control
= audio_feature_info
[i
].control
;
1932 for (j
= 0; j
< channels
; j
++) {
1935 mask
= snd_usb_combine_bytes(bmaControls
+
1936 csize
* (j
+1), csize
);
1937 if (uac_v2v3_control_is_readable(mask
, control
)) {
1938 ch_bits
|= (1 << j
);
1939 if (!uac_v2v3_control_is_writeable(mask
, control
))
1940 ch_read_only
|= (1 << j
);
1945 * NOTE: build_feature_ctl() will mark the control
1946 * read-only if all channels are marked read-only in
1947 * the descriptors. Otherwise, the control will be
1948 * reported as writeable, but the driver will not
1949 * actually issue a write command for read-only
1954 * The first channel must be set
1955 * (for ease of programming).
1958 build_feature_ctl(state
, _ftr
, ch_bits
, control
,
1959 &iterm
, unitid
, ch_read_only
);
1960 if (uac_v2v3_control_is_readable(master_bits
, control
))
1961 build_feature_ctl(state
, _ftr
, 0, control
,
1963 !uac_v2v3_control_is_writeable(master_bits
,
1975 /* check whether the given in/out overflows bmMixerControls matrix */
1976 static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor
*desc
,
1977 int protocol
, int num_ins
, int num_outs
)
1979 u8
*hdr
= (u8
*)desc
;
1980 u8
*c
= uac_mixer_unit_bmControls(desc
, protocol
);
1981 size_t rest
; /* remaining bytes after bmMixerControls */
1986 rest
= 1; /* iMixer */
1989 rest
= 2; /* bmControls + iMixer */
1992 rest
= 6; /* bmControls + wMixerDescrStr */
1997 return c
+ (num_ins
* num_outs
+ 7) / 8 + rest
> hdr
+ hdr
[0];
2001 * build a mixer unit control
2003 * the callbacks are identical with feature unit.
2004 * input channel number (zero based) is given in control field instead.
2006 static void build_mixer_unit_ctl(struct mixer_build
*state
,
2007 struct uac_mixer_unit_descriptor
*desc
,
2008 int in_pin
, int in_ch
, int num_outs
,
2009 int unitid
, struct usb_audio_term
*iterm
)
2011 struct usb_mixer_elem_info
*cval
;
2012 unsigned int i
, len
;
2013 struct snd_kcontrol
*kctl
;
2014 const struct usbmix_name_map
*map
;
2016 map
= find_map(state
->map
, unitid
, 0);
2017 if (check_ignored_ctl(map
))
2020 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
2024 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
2025 cval
->control
= in_ch
+ 1; /* based on 1 */
2026 cval
->val_type
= USB_MIXER_S16
;
2027 for (i
= 0; i
< num_outs
; i
++) {
2028 __u8
*c
= uac_mixer_unit_bmControls(desc
, state
->mixer
->protocol
);
2030 if (check_matrix_bitmap(c
, in_ch
, i
, num_outs
)) {
2031 cval
->cmask
|= (1 << i
);
2036 /* get min/max values */
2037 get_min_max(cval
, 0);
2039 kctl
= snd_ctl_new1(&usb_feature_unit_ctl
, cval
);
2041 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
2042 usb_mixer_elem_info_free(cval
);
2045 kctl
->private_free
= snd_usb_mixer_elem_free
;
2047 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
2049 len
= get_term_name(state
->chip
, iterm
, kctl
->id
.name
,
2050 sizeof(kctl
->id
.name
), 0);
2052 len
= sprintf(kctl
->id
.name
, "Mixer Source %d", in_ch
+ 1);
2053 append_ctl_name(kctl
, " Volume");
2055 usb_audio_dbg(state
->chip
, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2056 cval
->head
.id
, kctl
->id
.name
, cval
->channels
, cval
->min
, cval
->max
);
2057 snd_usb_mixer_add_control(&cval
->head
, kctl
);
2060 static int parse_audio_input_terminal(struct mixer_build
*state
, int unitid
,
2063 struct usb_audio_term iterm
;
2064 unsigned int control
, bmctls
, term_id
;
2066 if (state
->mixer
->protocol
== UAC_VERSION_2
) {
2067 struct uac2_input_terminal_descriptor
*d_v2
= raw_desc
;
2068 control
= UAC2_TE_CONNECTOR
;
2069 term_id
= d_v2
->bTerminalID
;
2070 bmctls
= le16_to_cpu(d_v2
->bmControls
);
2071 } else if (state
->mixer
->protocol
== UAC_VERSION_3
) {
2072 struct uac3_input_terminal_descriptor
*d_v3
= raw_desc
;
2073 control
= UAC3_TE_INSERTION
;
2074 term_id
= d_v3
->bTerminalID
;
2075 bmctls
= le32_to_cpu(d_v3
->bmControls
);
2077 return 0; /* UAC1. No Insertion control */
2080 check_input_term(state
, term_id
, &iterm
);
2082 /* Check for jack detection. */
2083 if (uac_v2v3_control_is_readable(bmctls
, control
))
2084 build_connector_control(state
->mixer
, &iterm
, true);
2090 * parse a mixer unit
2092 static int parse_audio_mixer_unit(struct mixer_build
*state
, int unitid
,
2095 struct uac_mixer_unit_descriptor
*desc
= raw_desc
;
2096 struct usb_audio_term iterm
;
2097 int input_pins
, num_ins
, num_outs
;
2100 err
= uac_mixer_unit_get_channels(state
, desc
);
2102 usb_audio_err(state
->chip
,
2103 "invalid MIXER UNIT descriptor %d\n",
2109 input_pins
= desc
->bNrInPins
;
2113 for (pin
= 0; pin
< input_pins
; pin
++) {
2114 err
= parse_audio_unit(state
, desc
->baSourceID
[pin
]);
2117 /* no bmControls field (e.g. Maya44) -> ignore */
2120 err
= check_input_term(state
, desc
->baSourceID
[pin
], &iterm
);
2123 num_ins
+= iterm
.channels
;
2124 if (mixer_bitmap_overflow(desc
, state
->mixer
->protocol
,
2127 for (; ich
< num_ins
; ich
++) {
2128 int och
, ich_has_controls
= 0;
2130 for (och
= 0; och
< num_outs
; och
++) {
2131 __u8
*c
= uac_mixer_unit_bmControls(desc
,
2132 state
->mixer
->protocol
);
2134 if (check_matrix_bitmap(c
, ich
, och
, num_outs
)) {
2135 ich_has_controls
= 1;
2139 if (ich_has_controls
)
2140 build_mixer_unit_ctl(state
, desc
, pin
, ich
, num_outs
,
2148 * Processing Unit / Extension Unit
2151 /* get callback for processing/extension unit */
2152 static int mixer_ctl_procunit_get(struct snd_kcontrol
*kcontrol
,
2153 struct snd_ctl_elem_value
*ucontrol
)
2155 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2158 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
2160 ucontrol
->value
.integer
.value
[0] = cval
->min
;
2161 return filter_error(cval
, err
);
2163 val
= get_relative_value(cval
, val
);
2164 ucontrol
->value
.integer
.value
[0] = val
;
2168 /* put callback for processing/extension unit */
2169 static int mixer_ctl_procunit_put(struct snd_kcontrol
*kcontrol
,
2170 struct snd_ctl_elem_value
*ucontrol
)
2172 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2175 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
2177 return filter_error(cval
, err
);
2178 val
= ucontrol
->value
.integer
.value
[0];
2179 val
= get_abs_value(cval
, val
);
2181 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
2187 /* alsa control interface for processing/extension unit */
2188 static const struct snd_kcontrol_new mixer_procunit_ctl
= {
2189 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
2190 .name
= "", /* will be filled later */
2191 .info
= mixer_ctl_feature_info
,
2192 .get
= mixer_ctl_procunit_get
,
2193 .put
= mixer_ctl_procunit_put
,
2197 * predefined data for processing units
2199 struct procunit_value_info
{
2206 struct procunit_info
{
2209 struct procunit_value_info
*values
;
2212 static struct procunit_value_info undefined_proc_info
[] = {
2213 { 0x00, "Control Undefined", 0 },
2217 static struct procunit_value_info updown_proc_info
[] = {
2218 { UAC_UD_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
2219 { UAC_UD_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
2222 static struct procunit_value_info prologic_proc_info
[] = {
2223 { UAC_DP_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
2224 { UAC_DP_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
2227 static struct procunit_value_info threed_enh_proc_info
[] = {
2228 { UAC_3D_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
2229 { UAC_3D_SPACE
, "Spaciousness", USB_MIXER_U8
},
2232 static struct procunit_value_info reverb_proc_info
[] = {
2233 { UAC_REVERB_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
2234 { UAC_REVERB_LEVEL
, "Level", USB_MIXER_U8
},
2235 { UAC_REVERB_TIME
, "Time", USB_MIXER_U16
},
2236 { UAC_REVERB_FEEDBACK
, "Feedback", USB_MIXER_U8
},
2239 static struct procunit_value_info chorus_proc_info
[] = {
2240 { UAC_CHORUS_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
2241 { UAC_CHORUS_LEVEL
, "Level", USB_MIXER_U8
},
2242 { UAC_CHORUS_RATE
, "Rate", USB_MIXER_U16
},
2243 { UAC_CHORUS_DEPTH
, "Depth", USB_MIXER_U16
},
2246 static struct procunit_value_info dcr_proc_info
[] = {
2247 { UAC_DCR_ENABLE
, "Switch", USB_MIXER_BOOLEAN
},
2248 { UAC_DCR_RATE
, "Ratio", USB_MIXER_U16
},
2249 { UAC_DCR_MAXAMPL
, "Max Amp", USB_MIXER_S16
},
2250 { UAC_DCR_THRESHOLD
, "Threshold", USB_MIXER_S16
},
2251 { UAC_DCR_ATTACK_TIME
, "Attack Time", USB_MIXER_U16
},
2252 { UAC_DCR_RELEASE_TIME
, "Release Time", USB_MIXER_U16
},
2256 static struct procunit_info procunits
[] = {
2257 { UAC_PROCESS_UP_DOWNMIX
, "Up Down", updown_proc_info
},
2258 { UAC_PROCESS_DOLBY_PROLOGIC
, "Dolby Prologic", prologic_proc_info
},
2259 { UAC_PROCESS_STEREO_EXTENDER
, "3D Stereo Extender", threed_enh_proc_info
},
2260 { UAC_PROCESS_REVERB
, "Reverb", reverb_proc_info
},
2261 { UAC_PROCESS_CHORUS
, "Chorus", chorus_proc_info
},
2262 { UAC_PROCESS_DYN_RANGE_COMP
, "DCR", dcr_proc_info
},
2266 static struct procunit_value_info uac3_updown_proc_info
[] = {
2267 { UAC3_UD_MODE_SELECT
, "Mode Select", USB_MIXER_U8
, 1 },
2270 static struct procunit_value_info uac3_stereo_ext_proc_info
[] = {
2271 { UAC3_EXT_WIDTH_CONTROL
, "Width Control", USB_MIXER_U8
},
2275 static struct procunit_info uac3_procunits
[] = {
2276 { UAC3_PROCESS_UP_DOWNMIX
, "Up Down", uac3_updown_proc_info
},
2277 { UAC3_PROCESS_STEREO_EXTENDER
, "3D Stereo Extender", uac3_stereo_ext_proc_info
},
2278 { UAC3_PROCESS_MULTI_FUNCTION
, "Multi-Function", undefined_proc_info
},
2283 * predefined data for extension units
2285 static struct procunit_value_info clock_rate_xu_info
[] = {
2286 { USB_XU_CLOCK_RATE_SELECTOR
, "Selector", USB_MIXER_U8
, 0 },
2289 static struct procunit_value_info clock_source_xu_info
[] = {
2290 { USB_XU_CLOCK_SOURCE_SELECTOR
, "External", USB_MIXER_BOOLEAN
},
2293 static struct procunit_value_info spdif_format_xu_info
[] = {
2294 { USB_XU_DIGITAL_FORMAT_SELECTOR
, "SPDIF/AC3", USB_MIXER_BOOLEAN
},
2297 static struct procunit_value_info soft_limit_xu_info
[] = {
2298 { USB_XU_SOFT_LIMIT_SELECTOR
, " ", USB_MIXER_BOOLEAN
},
2301 static struct procunit_info extunits
[] = {
2302 { USB_XU_CLOCK_RATE
, "Clock rate", clock_rate_xu_info
},
2303 { USB_XU_CLOCK_SOURCE
, "DigitalIn CLK source", clock_source_xu_info
},
2304 { USB_XU_DIGITAL_IO_STATUS
, "DigitalOut format:", spdif_format_xu_info
},
2305 { USB_XU_DEVICE_OPTIONS
, "AnalogueIn Soft Limit", soft_limit_xu_info
},
2310 * build a processing/extension unit
2312 static int build_audio_procunit(struct mixer_build
*state
, int unitid
,
2313 void *raw_desc
, struct procunit_info
*list
,
2314 bool extension_unit
)
2316 struct uac_processing_unit_descriptor
*desc
= raw_desc
;
2318 struct usb_mixer_elem_info
*cval
;
2319 struct snd_kcontrol
*kctl
;
2320 int i
, err
, nameid
, type
, len
;
2321 struct procunit_info
*info
;
2322 struct procunit_value_info
*valinfo
;
2323 const struct usbmix_name_map
*map
;
2324 static struct procunit_value_info default_value_info
[] = {
2325 { 0x01, "Switch", USB_MIXER_BOOLEAN
},
2328 static struct procunit_info default_info
= {
2329 0, NULL
, default_value_info
2331 const char *name
= extension_unit
?
2332 "Extension Unit" : "Processing Unit";
2334 num_ins
= desc
->bNrInPins
;
2335 for (i
= 0; i
< num_ins
; i
++) {
2336 err
= parse_audio_unit(state
, desc
->baSourceID
[i
]);
2341 type
= le16_to_cpu(desc
->wProcessType
);
2342 for (info
= list
; info
&& info
->type
; info
++)
2343 if (info
->type
== type
)
2345 if (!info
|| !info
->type
)
2346 info
= &default_info
;
2348 for (valinfo
= info
->values
; valinfo
->control
; valinfo
++) {
2349 __u8
*controls
= uac_processing_unit_bmControls(desc
, state
->mixer
->protocol
);
2351 if (state
->mixer
->protocol
== UAC_VERSION_1
) {
2352 if (!(controls
[valinfo
->control
/ 8] &
2353 (1 << ((valinfo
->control
% 8) - 1))))
2355 } else { /* UAC_VERSION_2/3 */
2356 if (!uac_v2v3_control_is_readable(controls
[valinfo
->control
/ 8],
2361 map
= find_map(state
->map
, unitid
, valinfo
->control
);
2362 if (check_ignored_ctl(map
))
2364 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
2367 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
2368 cval
->control
= valinfo
->control
;
2369 cval
->val_type
= valinfo
->val_type
;
2372 if (state
->mixer
->protocol
> UAC_VERSION_1
&&
2373 !uac_v2v3_control_is_writeable(controls
[valinfo
->control
/ 8],
2375 cval
->master_readonly
= 1;
2377 /* get min/max values */
2379 case UAC_PROCESS_UP_DOWNMIX
: {
2380 bool mode_sel
= false;
2382 switch (state
->mixer
->protocol
) {
2386 if (cval
->control
== UAC_UD_MODE_SELECT
)
2390 if (cval
->control
== UAC3_UD_MODE_SELECT
)
2396 __u8
*control_spec
= uac_processing_unit_specific(desc
,
2397 state
->mixer
->protocol
);
2399 cval
->max
= control_spec
[0];
2401 cval
->initialized
= 1;
2405 get_min_max(cval
, valinfo
->min_value
);
2408 case USB_XU_CLOCK_RATE
:
2410 * E-Mu USB 0404/0202/TrackerPre/0204
2411 * samplerate control quirk
2416 cval
->initialized
= 1;
2419 get_min_max(cval
, valinfo
->min_value
);
2423 kctl
= snd_ctl_new1(&mixer_procunit_ctl
, cval
);
2425 usb_mixer_elem_info_free(cval
);
2428 kctl
->private_free
= snd_usb_mixer_elem_free
;
2430 if (check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
))) {
2432 } else if (info
->name
) {
2433 strlcpy(kctl
->id
.name
, info
->name
, sizeof(kctl
->id
.name
));
2436 nameid
= uac_extension_unit_iExtension(desc
, state
->mixer
->protocol
);
2438 nameid
= uac_processing_unit_iProcessing(desc
, state
->mixer
->protocol
);
2441 len
= snd_usb_copy_string_desc(state
->chip
,
2444 sizeof(kctl
->id
.name
));
2446 strlcpy(kctl
->id
.name
, name
, sizeof(kctl
->id
.name
));
2448 append_ctl_name(kctl
, " ");
2449 append_ctl_name(kctl
, valinfo
->suffix
);
2451 usb_audio_dbg(state
->chip
,
2452 "[%d] PU [%s] ch = %d, val = %d/%d\n",
2453 cval
->head
.id
, kctl
->id
.name
, cval
->channels
,
2454 cval
->min
, cval
->max
);
2456 err
= snd_usb_mixer_add_control(&cval
->head
, kctl
);
2463 static int parse_audio_processing_unit(struct mixer_build
*state
, int unitid
,
2466 switch (state
->mixer
->protocol
) {
2470 return build_audio_procunit(state
, unitid
, raw_desc
,
2473 return build_audio_procunit(state
, unitid
, raw_desc
,
2474 uac3_procunits
, false);
2478 static int parse_audio_extension_unit(struct mixer_build
*state
, int unitid
,
2482 * Note that we parse extension units with processing unit descriptors.
2483 * That's ok as the layout is the same.
2485 return build_audio_procunit(state
, unitid
, raw_desc
, extunits
, true);
2493 * info callback for selector unit
2494 * use an enumerator type for routing
2496 static int mixer_ctl_selector_info(struct snd_kcontrol
*kcontrol
,
2497 struct snd_ctl_elem_info
*uinfo
)
2499 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2500 const char **itemlist
= (const char **)kcontrol
->private_value
;
2502 if (snd_BUG_ON(!itemlist
))
2504 return snd_ctl_enum_info(uinfo
, 1, cval
->max
, itemlist
);
2507 /* get callback for selector unit */
2508 static int mixer_ctl_selector_get(struct snd_kcontrol
*kcontrol
,
2509 struct snd_ctl_elem_value
*ucontrol
)
2511 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2514 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &val
);
2516 ucontrol
->value
.enumerated
.item
[0] = 0;
2517 return filter_error(cval
, err
);
2519 val
= get_relative_value(cval
, val
);
2520 ucontrol
->value
.enumerated
.item
[0] = val
;
2524 /* put callback for selector unit */
2525 static int mixer_ctl_selector_put(struct snd_kcontrol
*kcontrol
,
2526 struct snd_ctl_elem_value
*ucontrol
)
2528 struct usb_mixer_elem_info
*cval
= kcontrol
->private_data
;
2531 err
= get_cur_ctl_value(cval
, cval
->control
<< 8, &oval
);
2533 return filter_error(cval
, err
);
2534 val
= ucontrol
->value
.enumerated
.item
[0];
2535 val
= get_abs_value(cval
, val
);
2537 set_cur_ctl_value(cval
, cval
->control
<< 8, val
);
2543 /* alsa control interface for selector unit */
2544 static const struct snd_kcontrol_new mixer_selectunit_ctl
= {
2545 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
2546 .name
= "", /* will be filled later */
2547 .info
= mixer_ctl_selector_info
,
2548 .get
= mixer_ctl_selector_get
,
2549 .put
= mixer_ctl_selector_put
,
2553 * private free callback.
2554 * free both private_data and private_value
2556 static void usb_mixer_selector_elem_free(struct snd_kcontrol
*kctl
)
2560 if (kctl
->private_data
) {
2561 struct usb_mixer_elem_info
*cval
= kctl
->private_data
;
2562 num_ins
= cval
->max
;
2563 usb_mixer_elem_info_free(cval
);
2564 kctl
->private_data
= NULL
;
2566 if (kctl
->private_value
) {
2567 char **itemlist
= (char **)kctl
->private_value
;
2568 for (i
= 0; i
< num_ins
; i
++)
2571 kctl
->private_value
= 0;
2576 * parse a selector unit
2578 static int parse_audio_selector_unit(struct mixer_build
*state
, int unitid
,
2581 struct uac_selector_unit_descriptor
*desc
= raw_desc
;
2582 unsigned int i
, nameid
, len
;
2584 struct usb_mixer_elem_info
*cval
;
2585 struct snd_kcontrol
*kctl
;
2586 const struct usbmix_name_map
*map
;
2589 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
2590 err
= parse_audio_unit(state
, desc
->baSourceID
[i
]);
2595 if (desc
->bNrInPins
== 1) /* only one ? nonsense! */
2598 map
= find_map(state
->map
, unitid
, 0);
2599 if (check_ignored_ctl(map
))
2602 cval
= kzalloc(sizeof(*cval
), GFP_KERNEL
);
2605 snd_usb_mixer_elem_init_std(&cval
->head
, state
->mixer
, unitid
);
2606 cval
->val_type
= USB_MIXER_U8
;
2609 cval
->max
= desc
->bNrInPins
;
2611 cval
->initialized
= 1;
2613 switch (state
->mixer
->protocol
) {
2620 if (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
||
2621 desc
->bDescriptorSubtype
== UAC3_CLOCK_SELECTOR
)
2622 cval
->control
= UAC2_CX_CLOCK_SELECTOR
;
2623 else /* UAC2/3_SELECTOR_UNIT */
2624 cval
->control
= UAC2_SU_SELECTOR
;
2628 namelist
= kcalloc(desc
->bNrInPins
, sizeof(char *), GFP_KERNEL
);
2633 #define MAX_ITEM_NAME_LEN 64
2634 for (i
= 0; i
< desc
->bNrInPins
; i
++) {
2635 struct usb_audio_term iterm
;
2637 namelist
[i
] = kmalloc(MAX_ITEM_NAME_LEN
, GFP_KERNEL
);
2642 len
= check_mapped_selector_name(state
, unitid
, i
, namelist
[i
],
2644 if (! len
&& check_input_term(state
, desc
->baSourceID
[i
], &iterm
) >= 0)
2645 len
= get_term_name(state
->chip
, &iterm
, namelist
[i
],
2646 MAX_ITEM_NAME_LEN
, 0);
2648 sprintf(namelist
[i
], "Input %u", i
);
2651 kctl
= snd_ctl_new1(&mixer_selectunit_ctl
, cval
);
2653 usb_audio_err(state
->chip
, "cannot malloc kcontrol\n");
2657 kctl
->private_value
= (unsigned long)namelist
;
2658 kctl
->private_free
= usb_mixer_selector_elem_free
;
2660 /* check the static mapping table at first */
2661 len
= check_mapped_name(map
, kctl
->id
.name
, sizeof(kctl
->id
.name
));
2664 switch (state
->mixer
->protocol
) {
2668 /* if iSelector is given, use it */
2669 nameid
= uac_selector_unit_iSelector(desc
);
2671 len
= snd_usb_copy_string_desc(state
->chip
,
2672 nameid
, kctl
->id
.name
,
2673 sizeof(kctl
->id
.name
));
2676 /* TODO: Class-Specific strings not yet supported */
2680 /* ... or pick up the terminal name at next */
2682 len
= get_term_name(state
->chip
, &state
->oterm
,
2683 kctl
->id
.name
, sizeof(kctl
->id
.name
), 0);
2684 /* ... or use the fixed string "USB" as the last resort */
2686 strlcpy(kctl
->id
.name
, "USB", sizeof(kctl
->id
.name
));
2688 /* and add the proper suffix */
2689 if (desc
->bDescriptorSubtype
== UAC2_CLOCK_SELECTOR
||
2690 desc
->bDescriptorSubtype
== UAC3_CLOCK_SELECTOR
)
2691 append_ctl_name(kctl
, " Clock Source");
2692 else if ((state
->oterm
.type
& 0xff00) == 0x0100)
2693 append_ctl_name(kctl
, " Capture Source");
2695 append_ctl_name(kctl
, " Playback Source");
2698 usb_audio_dbg(state
->chip
, "[%d] SU [%s] items = %d\n",
2699 cval
->head
.id
, kctl
->id
.name
, desc
->bNrInPins
);
2700 return snd_usb_mixer_add_control(&cval
->head
, kctl
);
2703 for (i
= 0; i
< desc
->bNrInPins
; i
++)
2707 usb_mixer_elem_info_free(cval
);
2712 * parse an audio unit recursively
2715 static int parse_audio_unit(struct mixer_build
*state
, int unitid
)
2718 int protocol
= state
->mixer
->protocol
;
2720 if (test_and_set_bit(unitid
, state
->unitbitmap
))
2721 return 0; /* the unit already visited */
2723 p1
= find_audio_control_unit(state
, unitid
);
2725 usb_audio_err(state
->chip
, "unit %d not found!\n", unitid
);
2729 if (!snd_usb_validate_audio_desc(p1
, protocol
)) {
2730 usb_audio_dbg(state
->chip
, "invalid unit %d\n", unitid
);
2731 return 0; /* skip invalid unit */
2734 switch (PTYPE(protocol
, p1
[2])) {
2735 case PTYPE(UAC_VERSION_1
, UAC_INPUT_TERMINAL
):
2736 case PTYPE(UAC_VERSION_2
, UAC_INPUT_TERMINAL
):
2737 case PTYPE(UAC_VERSION_3
, UAC_INPUT_TERMINAL
):
2738 return parse_audio_input_terminal(state
, unitid
, p1
);
2739 case PTYPE(UAC_VERSION_1
, UAC_MIXER_UNIT
):
2740 case PTYPE(UAC_VERSION_2
, UAC_MIXER_UNIT
):
2741 case PTYPE(UAC_VERSION_3
, UAC3_MIXER_UNIT
):
2742 return parse_audio_mixer_unit(state
, unitid
, p1
);
2743 case PTYPE(UAC_VERSION_2
, UAC2_CLOCK_SOURCE
):
2744 case PTYPE(UAC_VERSION_3
, UAC3_CLOCK_SOURCE
):
2745 return parse_clock_source_unit(state
, unitid
, p1
);
2746 case PTYPE(UAC_VERSION_1
, UAC_SELECTOR_UNIT
):
2747 case PTYPE(UAC_VERSION_2
, UAC_SELECTOR_UNIT
):
2748 case PTYPE(UAC_VERSION_3
, UAC3_SELECTOR_UNIT
):
2749 case PTYPE(UAC_VERSION_2
, UAC2_CLOCK_SELECTOR
):
2750 case PTYPE(UAC_VERSION_3
, UAC3_CLOCK_SELECTOR
):
2751 return parse_audio_selector_unit(state
, unitid
, p1
);
2752 case PTYPE(UAC_VERSION_1
, UAC_FEATURE_UNIT
):
2753 case PTYPE(UAC_VERSION_2
, UAC_FEATURE_UNIT
):
2754 case PTYPE(UAC_VERSION_3
, UAC3_FEATURE_UNIT
):
2755 return parse_audio_feature_unit(state
, unitid
, p1
);
2756 case PTYPE(UAC_VERSION_1
, UAC1_PROCESSING_UNIT
):
2757 case PTYPE(UAC_VERSION_2
, UAC2_PROCESSING_UNIT_V2
):
2758 case PTYPE(UAC_VERSION_3
, UAC3_PROCESSING_UNIT
):
2759 return parse_audio_processing_unit(state
, unitid
, p1
);
2760 case PTYPE(UAC_VERSION_1
, UAC1_EXTENSION_UNIT
):
2761 case PTYPE(UAC_VERSION_2
, UAC2_EXTENSION_UNIT_V2
):
2762 case PTYPE(UAC_VERSION_3
, UAC3_EXTENSION_UNIT
):
2763 return parse_audio_extension_unit(state
, unitid
, p1
);
2764 case PTYPE(UAC_VERSION_2
, UAC2_EFFECT_UNIT
):
2765 case PTYPE(UAC_VERSION_3
, UAC3_EFFECT_UNIT
):
2766 return 0; /* FIXME - effect units not implemented yet */
2768 usb_audio_err(state
->chip
,
2769 "unit %u: unexpected type 0x%02x\n",
2775 static void snd_usb_mixer_free(struct usb_mixer_interface
*mixer
)
2777 /* kill pending URBs */
2778 snd_usb_mixer_disconnect(mixer
);
2780 kfree(mixer
->id_elems
);
2782 kfree(mixer
->urb
->transfer_buffer
);
2783 usb_free_urb(mixer
->urb
);
2785 usb_free_urb(mixer
->rc_urb
);
2786 kfree(mixer
->rc_setup_packet
);
2790 static int snd_usb_mixer_dev_free(struct snd_device
*device
)
2792 struct usb_mixer_interface
*mixer
= device
->device_data
;
2793 snd_usb_mixer_free(mixer
);
2797 /* UAC3 predefined channels configuration */
2798 struct uac3_badd_profile
{
2801 int c_chmask
; /* capture channels mask */
2802 int p_chmask
; /* playback channels mask */
2803 int st_chmask
; /* side tone mixing channel mask */
2806 static struct uac3_badd_profile uac3_badd_profiles
[] = {
2809 * BAIF, BAOF or combination of both
2810 * IN: Mono or Stereo cfg, Mono alt possible
2811 * OUT: Mono or Stereo cfg, Mono alt possible
2813 .subclass
= UAC3_FUNCTION_SUBCLASS_GENERIC_IO
,
2814 .name
= "GENERIC IO",
2815 .c_chmask
= -1, /* dynamic channels */
2816 .p_chmask
= -1, /* dynamic channels */
2819 /* BAOF; Stereo only cfg, Mono alt possible */
2820 .subclass
= UAC3_FUNCTION_SUBCLASS_HEADPHONE
,
2821 .name
= "HEADPHONE",
2825 /* BAOF; Mono or Stereo cfg, Mono alt possible */
2826 .subclass
= UAC3_FUNCTION_SUBCLASS_SPEAKER
,
2828 .p_chmask
= -1, /* dynamic channels */
2831 /* BAIF; Mono or Stereo cfg, Mono alt possible */
2832 .subclass
= UAC3_FUNCTION_SUBCLASS_MICROPHONE
,
2833 .name
= "MICROPHONE",
2834 .c_chmask
= -1, /* dynamic channels */
2840 * OUT: Mono or Stereo cfg, Mono alt possible
2842 .subclass
= UAC3_FUNCTION_SUBCLASS_HEADSET
,
2845 .p_chmask
= -1, /* dynamic channels */
2849 /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
2850 .subclass
= UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER
,
2851 .name
= "HEADSET ADAPTER",
2857 /* BAIF + BAOF; IN: Mono only; OUT: Mono only */
2858 .subclass
= UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE
,
2859 .name
= "SPEAKERPHONE",
2863 { 0 } /* terminator */
2866 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface
*mixer
,
2867 struct uac3_badd_profile
*f
,
2868 int c_chmask
, int p_chmask
)
2871 * If both playback/capture channels are dynamic, make sure
2872 * at least one channel is present
2874 if (f
->c_chmask
< 0 && f
->p_chmask
< 0) {
2875 if (!c_chmask
&& !p_chmask
) {
2876 usb_audio_warn(mixer
->chip
, "BAAD %s: no channels?",
2883 if ((f
->c_chmask
< 0 && !c_chmask
) ||
2884 (f
->c_chmask
>= 0 && f
->c_chmask
!= c_chmask
)) {
2885 usb_audio_warn(mixer
->chip
, "BAAD %s c_chmask mismatch",
2889 if ((f
->p_chmask
< 0 && !p_chmask
) ||
2890 (f
->p_chmask
>= 0 && f
->p_chmask
!= p_chmask
)) {
2891 usb_audio_warn(mixer
->chip
, "BAAD %s p_chmask mismatch",
2899 * create mixer controls for UAC3 BADD profiles
2901 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
2903 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
2905 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface
*mixer
,
2908 struct usb_device
*dev
= mixer
->chip
->dev
;
2909 struct usb_interface_assoc_descriptor
*assoc
;
2910 int badd_profile
= mixer
->chip
->badd_profile
;
2911 struct uac3_badd_profile
*f
;
2912 const struct usbmix_ctl_map
*map
;
2913 int p_chmask
= 0, c_chmask
= 0, st_chmask
= 0;
2916 assoc
= usb_ifnum_to_if(dev
, ctrlif
)->intf_assoc
;
2918 /* Detect BADD capture/playback channels from AS EP descriptors */
2919 for (i
= 0; i
< assoc
->bInterfaceCount
; i
++) {
2920 int intf
= assoc
->bFirstInterface
+ i
;
2922 struct usb_interface
*iface
;
2923 struct usb_host_interface
*alts
;
2924 struct usb_interface_descriptor
*altsd
;
2925 unsigned int maxpacksize
;
2932 iface
= usb_ifnum_to_if(dev
, intf
);
2933 num
= iface
->num_altsetting
;
2939 * The number of Channels in an AudioStreaming interface
2940 * and the audio sample bit resolution (16 bits or 24
2941 * bits) can be derived from the wMaxPacketSize field in
2942 * the Standard AS Audio Data Endpoint descriptor in
2943 * Alternate Setting 1
2945 alts
= &iface
->altsetting
[1];
2946 altsd
= get_iface_desc(alts
);
2948 if (altsd
->bNumEndpoints
< 1)
2951 /* check direction */
2952 dir_in
= (get_endpoint(alts
, 0)->bEndpointAddress
& USB_DIR_IN
);
2953 maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
2955 switch (maxpacksize
) {
2957 usb_audio_err(mixer
->chip
,
2958 "incorrect wMaxPacketSize 0x%x for BADD profile\n",
2961 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16
:
2962 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16
:
2963 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24
:
2964 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24
:
2967 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16
:
2968 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16
:
2969 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24
:
2970 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24
:
2981 usb_audio_dbg(mixer
->chip
,
2982 "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
2983 badd_profile
, c_chmask
, p_chmask
);
2985 /* check the mapping table */
2986 for (map
= uac3_badd_usbmix_ctl_maps
; map
->id
; map
++) {
2987 if (map
->id
== badd_profile
)
2994 for (f
= uac3_badd_profiles
; f
->name
; f
++) {
2995 if (badd_profile
== f
->subclass
)
3000 if (!uac3_badd_func_has_valid_channels(mixer
, f
, c_chmask
, p_chmask
))
3002 st_chmask
= f
->st_chmask
;
3006 /* Master channel, always writable */
3007 build_feature_ctl_badd(mixer
, 0, UAC_FU_MUTE
,
3008 UAC3_BADD_FU_ID2
, map
->map
);
3009 /* Mono/Stereo volume channels, always writable */
3010 build_feature_ctl_badd(mixer
, p_chmask
, UAC_FU_VOLUME
,
3011 UAC3_BADD_FU_ID2
, map
->map
);
3016 /* Master channel, always writable */
3017 build_feature_ctl_badd(mixer
, 0, UAC_FU_MUTE
,
3018 UAC3_BADD_FU_ID5
, map
->map
);
3019 /* Mono/Stereo volume channels, always writable */
3020 build_feature_ctl_badd(mixer
, c_chmask
, UAC_FU_VOLUME
,
3021 UAC3_BADD_FU_ID5
, map
->map
);
3024 /* Side tone-mixing */
3026 /* Master channel, always writable */
3027 build_feature_ctl_badd(mixer
, 0, UAC_FU_MUTE
,
3028 UAC3_BADD_FU_ID7
, map
->map
);
3029 /* Mono volume channel, always writable */
3030 build_feature_ctl_badd(mixer
, 1, UAC_FU_VOLUME
,
3031 UAC3_BADD_FU_ID7
, map
->map
);
3034 /* Insertion Control */
3035 if (f
->subclass
== UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER
) {
3036 struct usb_audio_term iterm
, oterm
;
3038 /* Input Term - Insertion control */
3039 memset(&iterm
, 0, sizeof(iterm
));
3040 iterm
.id
= UAC3_BADD_IT_ID4
;
3041 iterm
.type
= UAC_BIDIR_TERMINAL_HEADSET
;
3042 build_connector_control(mixer
, &iterm
, true);
3044 /* Output Term - Insertion control */
3045 memset(&oterm
, 0, sizeof(oterm
));
3046 oterm
.id
= UAC3_BADD_OT_ID3
;
3047 oterm
.type
= UAC_BIDIR_TERMINAL_HEADSET
;
3048 build_connector_control(mixer
, &oterm
, false);
3055 * create mixer controls
3057 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3059 static int snd_usb_mixer_controls(struct usb_mixer_interface
*mixer
)
3061 struct mixer_build state
;
3063 const struct usbmix_ctl_map
*map
;
3066 memset(&state
, 0, sizeof(state
));
3067 state
.chip
= mixer
->chip
;
3068 state
.mixer
= mixer
;
3069 state
.buffer
= mixer
->hostif
->extra
;
3070 state
.buflen
= mixer
->hostif
->extralen
;
3072 /* check the mapping table */
3073 for (map
= usbmix_ctl_maps
; map
->id
; map
++) {
3074 if (map
->id
== state
.chip
->usb_id
) {
3075 state
.map
= map
->map
;
3076 state
.selector_map
= map
->selector_map
;
3077 mixer
->ignore_ctl_error
= map
->ignore_ctl_error
;
3083 while ((p
= snd_usb_find_csint_desc(mixer
->hostif
->extra
,
3084 mixer
->hostif
->extralen
,
3085 p
, UAC_OUTPUT_TERMINAL
)) != NULL
) {
3086 if (!snd_usb_validate_audio_desc(p
, mixer
->protocol
))
3087 continue; /* skip invalid descriptor */
3089 if (mixer
->protocol
== UAC_VERSION_1
) {
3090 struct uac1_output_terminal_descriptor
*desc
= p
;
3092 /* mark terminal ID as visited */
3093 set_bit(desc
->bTerminalID
, state
.unitbitmap
);
3094 state
.oterm
.id
= desc
->bTerminalID
;
3095 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
3096 state
.oterm
.name
= desc
->iTerminal
;
3097 err
= parse_audio_unit(&state
, desc
->bSourceID
);
3098 if (err
< 0 && err
!= -EINVAL
)
3100 } else if (mixer
->protocol
== UAC_VERSION_2
) {
3101 struct uac2_output_terminal_descriptor
*desc
= p
;
3103 /* mark terminal ID as visited */
3104 set_bit(desc
->bTerminalID
, state
.unitbitmap
);
3105 state
.oterm
.id
= desc
->bTerminalID
;
3106 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
3107 state
.oterm
.name
= desc
->iTerminal
;
3108 err
= parse_audio_unit(&state
, desc
->bSourceID
);
3109 if (err
< 0 && err
!= -EINVAL
)
3113 * For UAC2, use the same approach to also add the
3116 err
= parse_audio_unit(&state
, desc
->bCSourceID
);
3117 if (err
< 0 && err
!= -EINVAL
)
3120 if (uac_v2v3_control_is_readable(le16_to_cpu(desc
->bmControls
),
3121 UAC2_TE_CONNECTOR
)) {
3122 build_connector_control(state
.mixer
, &state
.oterm
,
3125 } else { /* UAC_VERSION_3 */
3126 struct uac3_output_terminal_descriptor
*desc
= p
;
3128 /* mark terminal ID as visited */
3129 set_bit(desc
->bTerminalID
, state
.unitbitmap
);
3130 state
.oterm
.id
= desc
->bTerminalID
;
3131 state
.oterm
.type
= le16_to_cpu(desc
->wTerminalType
);
3132 state
.oterm
.name
= le16_to_cpu(desc
->wTerminalDescrStr
);
3133 err
= parse_audio_unit(&state
, desc
->bSourceID
);
3134 if (err
< 0 && err
!= -EINVAL
)
3138 * For UAC3, use the same approach to also add the
3141 err
= parse_audio_unit(&state
, desc
->bCSourceID
);
3142 if (err
< 0 && err
!= -EINVAL
)
3145 if (uac_v2v3_control_is_readable(le32_to_cpu(desc
->bmControls
),
3146 UAC3_TE_INSERTION
)) {
3147 build_connector_control(state
.mixer
, &state
.oterm
,
3156 void snd_usb_mixer_notify_id(struct usb_mixer_interface
*mixer
, int unitid
)
3158 struct usb_mixer_elem_list
*list
;
3160 for_each_mixer_elem(list
, mixer
, unitid
) {
3161 struct usb_mixer_elem_info
*info
=
3162 mixer_elem_list_to_info(list
);
3163 /* invalidate cache, so the value is read from the device */
3165 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
3170 static void snd_usb_mixer_dump_cval(struct snd_info_buffer
*buffer
,
3171 struct usb_mixer_elem_list
*list
)
3173 struct usb_mixer_elem_info
*cval
= mixer_elem_list_to_info(list
);
3174 static char *val_types
[] = {"BOOLEAN", "INV_BOOLEAN",
3175 "S8", "U8", "S16", "U16"};
3176 snd_iprintf(buffer
, " Info: id=%i, control=%i, cmask=0x%x, "
3177 "channels=%i, type=\"%s\"\n", cval
->head
.id
,
3178 cval
->control
, cval
->cmask
, cval
->channels
,
3179 val_types
[cval
->val_type
]);
3180 snd_iprintf(buffer
, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3181 cval
->min
, cval
->max
, cval
->dBmin
, cval
->dBmax
);
3184 static void snd_usb_mixer_proc_read(struct snd_info_entry
*entry
,
3185 struct snd_info_buffer
*buffer
)
3187 struct snd_usb_audio
*chip
= entry
->private_data
;
3188 struct usb_mixer_interface
*mixer
;
3189 struct usb_mixer_elem_list
*list
;
3192 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
3194 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3195 chip
->usb_id
, snd_usb_ctrl_intf(chip
),
3196 mixer
->ignore_ctl_error
);
3197 snd_iprintf(buffer
, "Card: %s\n", chip
->card
->longname
);
3198 for (unitid
= 0; unitid
< MAX_ID_ELEMS
; unitid
++) {
3199 for_each_mixer_elem(list
, mixer
, unitid
) {
3200 snd_iprintf(buffer
, " Unit: %i\n", list
->id
);
3203 " Control: name=\"%s\", index=%i\n",
3204 list
->kctl
->id
.name
,
3205 list
->kctl
->id
.index
);
3207 list
->dump(buffer
, list
);
3213 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface
*mixer
,
3214 int attribute
, int value
, int index
)
3216 struct usb_mixer_elem_list
*list
;
3217 __u8 unitid
= (index
>> 8) & 0xff;
3218 __u8 control
= (value
>> 8) & 0xff;
3219 __u8 channel
= value
& 0xff;
3220 unsigned int count
= 0;
3222 if (channel
>= MAX_CHANNELS
) {
3223 usb_audio_dbg(mixer
->chip
,
3224 "%s(): bogus channel number %d\n",
3229 for_each_mixer_elem(list
, mixer
, unitid
)
3235 for_each_mixer_elem(list
, mixer
, unitid
) {
3236 struct usb_mixer_elem_info
*info
;
3241 info
= mixer_elem_list_to_info(list
);
3242 if (count
> 1 && info
->control
!= control
)
3245 switch (attribute
) {
3247 /* invalidate cache, so the value is read from the device */
3249 info
->cached
&= ~(1 << channel
);
3250 else /* master channel */
3253 snd_ctl_notify(mixer
->chip
->card
, SNDRV_CTL_EVENT_MASK_VALUE
,
3254 &info
->head
.kctl
->id
);
3266 usb_audio_dbg(mixer
->chip
,
3267 "unknown attribute %d in interrupt\n",
3274 static void snd_usb_mixer_interrupt(struct urb
*urb
)
3276 struct usb_mixer_interface
*mixer
= urb
->context
;
3277 int len
= urb
->actual_length
;
3278 int ustatus
= urb
->status
;
3283 if (mixer
->protocol
== UAC_VERSION_1
) {
3284 struct uac1_status_word
*status
;
3286 for (status
= urb
->transfer_buffer
;
3287 len
>= sizeof(*status
);
3288 len
-= sizeof(*status
), status
++) {
3289 dev_dbg(&urb
->dev
->dev
, "status interrupt: %02x %02x\n",
3290 status
->bStatusType
,
3291 status
->bOriginator
);
3293 /* ignore any notifications not from the control interface */
3294 if ((status
->bStatusType
& UAC1_STATUS_TYPE_ORIG_MASK
) !=
3295 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF
)
3298 if (status
->bStatusType
& UAC1_STATUS_TYPE_MEM_CHANGED
)
3299 snd_usb_mixer_rc_memory_change(mixer
, status
->bOriginator
);
3301 snd_usb_mixer_notify_id(mixer
, status
->bOriginator
);
3303 } else { /* UAC_VERSION_2 */
3304 struct uac2_interrupt_data_msg
*msg
;
3306 for (msg
= urb
->transfer_buffer
;
3307 len
>= sizeof(*msg
);
3308 len
-= sizeof(*msg
), msg
++) {
3309 /* drop vendor specific and endpoint requests */
3310 if ((msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_VENDOR
) ||
3311 (msg
->bInfo
& UAC2_INTERRUPT_DATA_MSG_EP
))
3314 snd_usb_mixer_interrupt_v2(mixer
, msg
->bAttribute
,
3315 le16_to_cpu(msg
->wValue
),
3316 le16_to_cpu(msg
->wIndex
));
3321 if (ustatus
!= -ENOENT
&&
3322 ustatus
!= -ECONNRESET
&&
3323 ustatus
!= -ESHUTDOWN
) {
3324 urb
->dev
= mixer
->chip
->dev
;
3325 usb_submit_urb(urb
, GFP_ATOMIC
);
3329 /* create the handler for the optional status interrupt endpoint */
3330 static int snd_usb_mixer_status_create(struct usb_mixer_interface
*mixer
)
3332 struct usb_endpoint_descriptor
*ep
;
3333 void *transfer_buffer
;
3337 /* we need one interrupt input endpoint */
3338 if (get_iface_desc(mixer
->hostif
)->bNumEndpoints
< 1)
3340 ep
= get_endpoint(mixer
->hostif
, 0);
3341 if (!usb_endpoint_dir_in(ep
) || !usb_endpoint_xfer_int(ep
))
3344 epnum
= usb_endpoint_num(ep
);
3345 buffer_length
= le16_to_cpu(ep
->wMaxPacketSize
);
3346 transfer_buffer
= kmalloc(buffer_length
, GFP_KERNEL
);
3347 if (!transfer_buffer
)
3349 mixer
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
3351 kfree(transfer_buffer
);
3354 usb_fill_int_urb(mixer
->urb
, mixer
->chip
->dev
,
3355 usb_rcvintpipe(mixer
->chip
->dev
, epnum
),
3356 transfer_buffer
, buffer_length
,
3357 snd_usb_mixer_interrupt
, mixer
, ep
->bInterval
);
3358 usb_submit_urb(mixer
->urb
, GFP_KERNEL
);
3362 static int keep_iface_ctl_get(struct snd_kcontrol
*kcontrol
,
3363 struct snd_ctl_elem_value
*ucontrol
)
3365 struct usb_mixer_interface
*mixer
= snd_kcontrol_chip(kcontrol
);
3367 ucontrol
->value
.integer
.value
[0] = mixer
->chip
->keep_iface
;
3371 static int keep_iface_ctl_put(struct snd_kcontrol
*kcontrol
,
3372 struct snd_ctl_elem_value
*ucontrol
)
3374 struct usb_mixer_interface
*mixer
= snd_kcontrol_chip(kcontrol
);
3375 bool keep_iface
= !!ucontrol
->value
.integer
.value
[0];
3377 if (mixer
->chip
->keep_iface
== keep_iface
)
3379 mixer
->chip
->keep_iface
= keep_iface
;
3383 static const struct snd_kcontrol_new keep_iface_ctl
= {
3384 .iface
= SNDRV_CTL_ELEM_IFACE_CARD
,
3385 .name
= "Keep Interface",
3386 .info
= snd_ctl_boolean_mono_info
,
3387 .get
= keep_iface_ctl_get
,
3388 .put
= keep_iface_ctl_put
,
3391 static int create_keep_iface_ctl(struct usb_mixer_interface
*mixer
)
3393 struct snd_kcontrol
*kctl
= snd_ctl_new1(&keep_iface_ctl
, mixer
);
3395 /* need only one control per card */
3396 if (snd_ctl_find_id(mixer
->chip
->card
, &kctl
->id
)) {
3397 snd_ctl_free_one(kctl
);
3401 return snd_ctl_add(mixer
->chip
->card
, kctl
);
3404 int snd_usb_create_mixer(struct snd_usb_audio
*chip
, int ctrlif
,
3407 static struct snd_device_ops dev_ops
= {
3408 .dev_free
= snd_usb_mixer_dev_free
3410 struct usb_mixer_interface
*mixer
;
3413 strcpy(chip
->card
->mixername
, "USB Mixer");
3415 mixer
= kzalloc(sizeof(*mixer
), GFP_KERNEL
);
3419 mixer
->ignore_ctl_error
= ignore_error
;
3420 mixer
->id_elems
= kcalloc(MAX_ID_ELEMS
, sizeof(*mixer
->id_elems
),
3422 if (!mixer
->id_elems
) {
3427 mixer
->hostif
= &usb_ifnum_to_if(chip
->dev
, ctrlif
)->altsetting
[0];
3428 switch (get_iface_desc(mixer
->hostif
)->bInterfaceProtocol
) {
3431 mixer
->protocol
= UAC_VERSION_1
;
3434 mixer
->protocol
= UAC_VERSION_2
;
3437 mixer
->protocol
= UAC_VERSION_3
;
3441 if (mixer
->protocol
== UAC_VERSION_3
&&
3442 chip
->badd_profile
>= UAC3_FUNCTION_SUBCLASS_GENERIC_IO
) {
3443 err
= snd_usb_mixer_controls_badd(mixer
, ctrlif
);
3447 err
= snd_usb_mixer_controls(mixer
);
3452 err
= snd_usb_mixer_status_create(mixer
);
3456 err
= create_keep_iface_ctl(mixer
);
3460 err
= snd_usb_mixer_apply_create_quirk(mixer
);
3464 err
= snd_device_new(chip
->card
, SNDRV_DEV_CODEC
, mixer
, &dev_ops
);
3468 if (list_empty(&chip
->mixer_list
))
3469 snd_card_ro_proc_new(chip
->card
, "usbmixer", chip
,
3470 snd_usb_mixer_proc_read
);
3472 list_add(&mixer
->list
, &chip
->mixer_list
);
3476 snd_usb_mixer_free(mixer
);
3480 void snd_usb_mixer_disconnect(struct usb_mixer_interface
*mixer
)
3482 if (mixer
->disconnected
)
3485 usb_kill_urb(mixer
->urb
);
3487 usb_kill_urb(mixer
->rc_urb
);
3488 mixer
->disconnected
= true;
3492 /* stop any bus activity of a mixer */
3493 static void snd_usb_mixer_inactivate(struct usb_mixer_interface
*mixer
)
3495 usb_kill_urb(mixer
->urb
);
3496 usb_kill_urb(mixer
->rc_urb
);
3499 static int snd_usb_mixer_activate(struct usb_mixer_interface
*mixer
)
3504 err
= usb_submit_urb(mixer
->urb
, GFP_NOIO
);
3512 int snd_usb_mixer_suspend(struct usb_mixer_interface
*mixer
)
3514 snd_usb_mixer_inactivate(mixer
);
3518 static int restore_mixer_value(struct usb_mixer_elem_list
*list
)
3520 struct usb_mixer_elem_info
*cval
= mixer_elem_list_to_info(list
);
3525 for (c
= 0; c
< MAX_CHANNELS
; c
++) {
3526 if (!(cval
->cmask
& (1 << c
)))
3528 if (cval
->cached
& (1 << (c
+ 1))) {
3529 err
= snd_usb_set_cur_mix_value(cval
, c
+ 1, idx
,
3530 cval
->cache_val
[idx
]);
3539 err
= snd_usb_set_cur_mix_value(cval
, 0, 0, *cval
->cache_val
);
3548 int snd_usb_mixer_resume(struct usb_mixer_interface
*mixer
, bool reset_resume
)
3550 struct usb_mixer_elem_list
*list
;
3554 /* restore cached mixer values */
3555 for (id
= 0; id
< MAX_ID_ELEMS
; id
++) {
3556 for_each_mixer_elem(list
, mixer
, id
) {
3558 err
= list
->resume(list
);
3566 snd_usb_mixer_resume_quirk(mixer
);
3568 return snd_usb_mixer_activate(mixer
);
3572 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list
*list
,
3573 struct usb_mixer_interface
*mixer
,
3576 list
->mixer
= mixer
;
3578 list
->dump
= snd_usb_mixer_dump_cval
;
3580 list
->resume
= restore_mixer_value
;