xref: /openbmc/linux/sound/usb/mixer.c (revision 015d239a)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *   (Tentative) USB Audio Driver for ALSA
4  *
5  *   Mixer control part
6  *
7  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8  *
9  *   Many codes borrowed from audio.c by
10  *	    Alan Cox (alan@lxorguk.ukuu.org.uk)
11  *	    Thomas Sailer (sailer@ife.ee.ethz.ch)
12  */
13 
14 /*
15  * TODOs, for both the mixer and the streaming interfaces:
16  *
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
28  */
29 
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>
40 
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>
46 
47 #include "usbaudio.h"
48 #include "mixer.h"
49 #include "helper.h"
50 #include "mixer_quirks.h"
51 #include "power.h"
52 
53 #define MAX_ID_ELEMS	256
54 
55 struct usb_audio_term {
56 	int id;
57 	int type;
58 	int channels;
59 	unsigned int chconfig;
60 	int name;
61 };
62 
63 struct usbmix_name_map;
64 
65 struct mixer_build {
66 	struct snd_usb_audio *chip;
67 	struct usb_mixer_interface *mixer;
68 	unsigned char *buffer;
69 	unsigned int buflen;
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;
75 };
76 
77 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
78 enum {
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
85 };
86 enum {
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 */
91 };
92 
93 /*
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.
97  */
98 #include "mixer_maps.c"
99 
100 static const struct usbmix_name_map *
101 find_map(const struct usbmix_name_map *p, int unitid, int control)
102 {
103 	if (!p)
104 		return NULL;
105 
106 	for (; p->id; p++) {
107 		if (p->id == unitid &&
108 		    (!control || !p->control || control == p->control))
109 			return p;
110 	}
111 	return NULL;
112 }
113 
114 /* get the mapped name if the unit matches */
115 static int
116 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
117 {
118 	if (!p || !p->name)
119 		return 0;
120 
121 	buflen--;
122 	return strlcpy(buf, p->name, buflen);
123 }
124 
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))
128 
129 /* check whether the control should be ignored */
130 static inline int
131 check_ignored_ctl(const struct usbmix_name_map *p)
132 {
133 	if (!p || p->name || p->dB)
134 		return 0;
135 	return 1;
136 }
137 
138 /* dB mapping */
139 static inline void check_mapped_dB(const struct usbmix_name_map *p,
140 				   struct usb_mixer_elem_info *cval)
141 {
142 	if (p && p->dB) {
143 		cval->dBmin = p->dB->min;
144 		cval->dBmax = p->dB->max;
145 		cval->initialized = 1;
146 	}
147 }
148 
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)
152 {
153 	const struct usbmix_selector_map *p;
154 
155 	if (!state->selector_map)
156 		return 0;
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);
160 	}
161 	return 0;
162 }
163 
164 /*
165  * find an audio control unit with the given unit id
166  */
167 static void *find_audio_control_unit(struct mixer_build *state,
168 				     unsigned char unit)
169 {
170 	/* we just parse the header */
171 	struct uac_feature_unit_descriptor *hdr = NULL;
172 
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)
179 			return hdr;
180 	}
181 
182 	return NULL;
183 }
184 
185 /*
186  * copy a string with the given id
187  */
188 static int snd_usb_copy_string_desc(struct snd_usb_audio *chip,
189 				    int index, char *buf, int maxlen)
190 {
191 	int len = usb_string(chip->dev, index, buf, maxlen - 1);
192 
193 	if (len < 0)
194 		return 0;
195 
196 	buf[len] = 0;
197 	return len;
198 }
199 
200 /*
201  * convert from the byte/word on usb descriptor to the zero-based integer
202  */
203 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
204 {
205 	switch (cval->val_type) {
206 	case USB_MIXER_BOOLEAN:
207 		return !!val;
208 	case USB_MIXER_INV_BOOLEAN:
209 		return !val;
210 	case USB_MIXER_U8:
211 		val &= 0xff;
212 		break;
213 	case USB_MIXER_S8:
214 		val &= 0xff;
215 		if (val >= 0x80)
216 			val -= 0x100;
217 		break;
218 	case USB_MIXER_U16:
219 		val &= 0xffff;
220 		break;
221 	case USB_MIXER_S16:
222 		val &= 0xffff;
223 		if (val >= 0x8000)
224 			val -= 0x10000;
225 		break;
226 	}
227 	return val;
228 }
229 
230 /*
231  * convert from the zero-based int to the byte/word for usb descriptor
232  */
233 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
234 {
235 	switch (cval->val_type) {
236 	case USB_MIXER_BOOLEAN:
237 		return !!val;
238 	case USB_MIXER_INV_BOOLEAN:
239 		return !val;
240 	case USB_MIXER_S8:
241 	case USB_MIXER_U8:
242 		return val & 0xff;
243 	case USB_MIXER_S16:
244 	case USB_MIXER_U16:
245 		return val & 0xffff;
246 	}
247 	return 0; /* not reached */
248 }
249 
250 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
251 {
252 	if (!cval->res)
253 		cval->res = 1;
254 	if (val < cval->min)
255 		return 0;
256 	else if (val >= cval->max)
257 		return (cval->max - cval->min + cval->res - 1) / cval->res;
258 	else
259 		return (val - cval->min) / cval->res;
260 }
261 
262 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
263 {
264 	if (val < 0)
265 		return cval->min;
266 	if (!cval->res)
267 		cval->res = 1;
268 	val *= cval->res;
269 	val += cval->min;
270 	if (val > cval->max)
271 		return cval->max;
272 	return val;
273 }
274 
275 static int uac2_ctl_value_size(int val_type)
276 {
277 	switch (val_type) {
278 	case USB_MIXER_S32:
279 	case USB_MIXER_U32:
280 		return 4;
281 	case USB_MIXER_S16:
282 	case USB_MIXER_U16:
283 		return 2;
284 	default:
285 		return 1;
286 	}
287 	return 0; /* unreachable */
288 }
289 
290 
291 /*
292  * retrieve a mixer value
293  */
294 
295 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
296 			    int validx, int *value_ret)
297 {
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;
301 	int timeout = 10;
302 	int idx = 0, err;
303 
304 	err = snd_usb_lock_shutdown(chip);
305 	if (err < 0)
306 		return -EIO;
307 
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));
315 			err = 0;
316 			goto out;
317 		} else if (err == -ETIMEDOUT) {
318 			goto out;
319 		}
320 	}
321 	usb_audio_dbg(chip,
322 		"cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
323 		request, validx, idx, cval->val_type);
324 	err = -EINVAL;
325 
326  out:
327 	snd_usb_unlock_shutdown(chip);
328 	return err;
329 }
330 
331 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
332 			    int validx, int *value_ret)
333 {
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)];
337 	unsigned char *val;
338 	int idx = 0, ret, val_size, size;
339 	__u8 bRequest;
340 
341 	val_size = uac2_ctl_value_size(cval->val_type);
342 
343 	if (request == UAC_GET_CUR) {
344 		bRequest = UAC2_CS_CUR;
345 		size = val_size;
346 	} else {
347 		bRequest = UAC2_CS_RANGE;
348 		size = sizeof(__u16) + 3 * val_size;
349 	}
350 
351 	memset(buf, 0, sizeof(buf));
352 
353 	ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
354 	if (ret)
355 		goto error;
356 
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);
362 
363 	if (ret < 0) {
364 error:
365 		usb_audio_err(chip,
366 			"cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
367 			request, validx, idx, cval->val_type);
368 		return ret;
369 	}
370 
371 	/* FIXME: how should we handle multiple triplets here? */
372 
373 	switch (request) {
374 	case UAC_GET_CUR:
375 		val = buf;
376 		break;
377 	case UAC_GET_MIN:
378 		val = buf + sizeof(__u16);
379 		break;
380 	case UAC_GET_MAX:
381 		val = buf + sizeof(__u16) + val_size;
382 		break;
383 	case UAC_GET_RES:
384 		val = buf + sizeof(__u16) + val_size * 2;
385 		break;
386 	default:
387 		return -EINVAL;
388 	}
389 
390 	*value_ret = convert_signed_value(cval,
391 					  snd_usb_combine_bytes(val, val_size));
392 
393 	return 0;
394 }
395 
396 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
397 			 int validx, int *value_ret)
398 {
399 	validx += cval->idx_off;
400 
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);
404 }
405 
406 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
407 			     int validx, int *value)
408 {
409 	return get_ctl_value(cval, UAC_GET_CUR, validx, value);
410 }
411 
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)
415 {
416 	return get_ctl_value(cval, UAC_GET_CUR,
417 			     (cval->control << 8) | channel,
418 			     value);
419 }
420 
421 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
422 			     int channel, int index, int *value)
423 {
424 	int err;
425 
426 	if (cval->cached & (1 << channel)) {
427 		*value = cval->cache_val[index];
428 		return 0;
429 	}
430 	err = get_cur_mix_raw(cval, channel, value);
431 	if (err < 0) {
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);
436 		return err;
437 	}
438 	cval->cached |= 1 << channel;
439 	cval->cache_val[index] = *value;
440 	return 0;
441 }
442 
443 /*
444  * set a mixer value
445  */
446 
447 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
448 				int request, int validx, int value_set)
449 {
450 	struct snd_usb_audio *chip = cval->head.mixer->chip;
451 	unsigned char buf[4];
452 	int idx = 0, val_len, err, timeout = 10;
453 
454 	validx += cval->idx_off;
455 
456 
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);
461 
462 		/* FIXME */
463 		if (request != UAC_SET_CUR) {
464 			usb_audio_dbg(chip, "RANGE setting not yet supported\n");
465 			return -EINVAL;
466 		}
467 
468 		request = UAC2_CS_CUR;
469 	}
470 
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;
476 
477 	err = snd_usb_lock_shutdown(chip);
478 	if (err < 0)
479 		return -EIO;
480 
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);
487 		if (err >= 0) {
488 			err = 0;
489 			goto out;
490 		} else if (err == -ETIMEDOUT) {
491 			goto out;
492 		}
493 	}
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]);
496 	err = -EINVAL;
497 
498  out:
499 	snd_usb_unlock_shutdown(chip);
500 	return err;
501 }
502 
503 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
504 			     int validx, int value)
505 {
506 	return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
507 }
508 
509 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
510 			     int index, int value)
511 {
512 	int err;
513 	unsigned int read_only = (channel == 0) ?
514 		cval->master_readonly :
515 		cval->ch_readonly & (1 << (channel - 1));
516 
517 	if (read_only) {
518 		usb_audio_dbg(cval->head.mixer->chip,
519 			      "%s(): channel %d of control %d is read_only\n",
520 			    __func__, channel, cval->control);
521 		return 0;
522 	}
523 
524 	err = snd_usb_mixer_set_ctl_value(cval,
525 					  UAC_SET_CUR, (cval->control << 8) | channel,
526 					  value);
527 	if (err < 0)
528 		return err;
529 	cval->cached |= 1 << channel;
530 	cval->cache_val[index] = value;
531 	return 0;
532 }
533 
534 /*
535  * TLV callback for mixer volume controls
536  */
537 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
538 			 unsigned int size, unsigned int __user *_tlv)
539 {
540 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
541 	DECLARE_TLV_DB_MINMAX(scale, 0, 0);
542 
543 	if (size < sizeof(scale))
544 		return -ENOMEM;
545 	if (cval->min_mute)
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)))
550 		return -EFAULT;
551 	return 0;
552 }
553 
554 /*
555  * parser routines begin here...
556  */
557 
558 static int parse_audio_unit(struct mixer_build *state, int unitid);
559 
560 
561 /*
562  * check if the input/output channel routing is enabled on the given bitmap.
563  * used for mixer unit parser
564  */
565 static int check_matrix_bitmap(unsigned char *bmap,
566 			       int ich, int och, int num_outs)
567 {
568 	int idx = ich * num_outs + och;
569 	return bmap[idx >> 3] & (0x80 >> (idx & 7));
570 }
571 
572 /*
573  * add an alsa control element
574  * search and increment the index until an empty slot is found.
575  *
576  * if failed, give up and free the control instance.
577  */
578 
579 int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
580 			      struct snd_kcontrol *kctl)
581 {
582 	struct usb_mixer_interface *mixer = list->mixer;
583 	int err;
584 
585 	while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
586 		kctl->id.index++;
587 	err = snd_ctl_add(mixer->chip->card, kctl);
588 	if (err < 0) {
589 		usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
590 			      err);
591 		return err;
592 	}
593 	list->kctl = kctl;
594 	list->next_id_elem = mixer->id_elems[list->id];
595 	mixer->id_elems[list->id] = list;
596 	return 0;
597 }
598 
599 /*
600  * get a terminal name string
601  */
602 
603 static struct iterm_name_combo {
604 	int type;
605 	char *name;
606 } iterm_names[] = {
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" },
614 	{ 0x0307, "LFE" },
615 	{ 0x0600, "External In" },
616 	{ 0x0601, "Analog In" },
617 	{ 0x0602, "Digital In" },
618 	{ 0x0603, "Line" },
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" },
626 	{ 0x0703, "CD" },
627 	{ 0x0704, "DAT" },
628 	{ 0x0705, "DCC" },
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" },
643 	{ 0 },
644 };
645 
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)
648 {
649 	struct iterm_name_combo *names;
650 	int len;
651 
652 	if (iterm->name) {
653 		len = snd_usb_copy_string_desc(chip, iterm->name,
654 						name, maxlen);
655 		if (len)
656 			return len;
657 	}
658 
659 	/* virtual type - not a real terminal */
660 	if (iterm->type >> 16) {
661 		if (term_only)
662 			return 0;
663 		switch (iterm->type >> 16) {
664 		case UAC3_SELECTOR_UNIT:
665 			strcpy(name, "Selector");
666 			return 8;
667 		case UAC3_PROCESSING_UNIT:
668 			strcpy(name, "Process Unit");
669 			return 12;
670 		case UAC3_EXTENSION_UNIT:
671 			strcpy(name, "Ext Unit");
672 			return 8;
673 		case UAC3_MIXER_UNIT:
674 			strcpy(name, "Mixer");
675 			return 5;
676 		default:
677 			return sprintf(name, "Unit %d", iterm->id);
678 		}
679 	}
680 
681 	switch (iterm->type & 0xff00) {
682 	case 0x0100:
683 		strcpy(name, "PCM");
684 		return 3;
685 	case 0x0200:
686 		strcpy(name, "Mic");
687 		return 3;
688 	case 0x0400:
689 		strcpy(name, "Headset");
690 		return 7;
691 	case 0x0500:
692 		strcpy(name, "Phone");
693 		return 5;
694 	}
695 
696 	for (names = iterm_names; names->type; names++) {
697 		if (names->type == iterm->type) {
698 			strcpy(name, names->name);
699 			return strlen(names->name);
700 		}
701 	}
702 
703 	return 0;
704 }
705 
706 /*
707  * Get logical cluster information for UAC3 devices.
708  */
709 static int get_cluster_channels_v3(struct mixer_build *state, unsigned int cluster_id)
710 {
711 	struct uac3_cluster_header_descriptor c_header;
712 	int err;
713 
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,
718 			cluster_id,
719 			snd_usb_ctrl_intf(state->chip),
720 			&c_header, sizeof(c_header));
721 	if (err < 0)
722 		goto error;
723 	if (err != sizeof(c_header)) {
724 		err = -EIO;
725 		goto error;
726 	}
727 
728 	return c_header.bNrChannels;
729 
730 error:
731 	usb_audio_err(state->chip, "cannot request logical cluster ID: %d (err: %d)\n", cluster_id, err);
732 	return err;
733 }
734 
735 /*
736  * Get number of channels for a Mixer Unit.
737  */
738 static int uac_mixer_unit_get_channels(struct mixer_build *state,
739 				       struct uac_mixer_unit_descriptor *desc)
740 {
741 	int mu_channels;
742 
743 	switch (state->mixer->protocol) {
744 	case UAC_VERSION_1:
745 	case UAC_VERSION_2:
746 	default:
747 		if (desc->bLength < sizeof(*desc) + desc->bNrInPins + 1)
748 			return 0; /* no bmControls -> skip */
749 		mu_channels = uac_mixer_unit_bNrChannels(desc);
750 		break;
751 	case UAC_VERSION_3:
752 		mu_channels = get_cluster_channels_v3(state,
753 				uac3_mixer_unit_wClusterDescrID(desc));
754 		break;
755 	}
756 
757 	return mu_channels;
758 }
759 
760 /*
761  * Parse Input Terminal Unit
762  */
763 static int __check_input_term(struct mixer_build *state, int id,
764 			      struct usb_audio_term *term);
765 
766 static int parse_term_uac1_iterm_unit(struct mixer_build *state,
767 				      struct usb_audio_term *term,
768 				      void *p1, int id)
769 {
770 	struct uac_input_terminal_descriptor *d = p1;
771 
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;
776 	return 0;
777 }
778 
779 static int parse_term_uac2_iterm_unit(struct mixer_build *state,
780 				      struct usb_audio_term *term,
781 				      void *p1, int id)
782 {
783 	struct uac2_input_terminal_descriptor *d = p1;
784 	int err;
785 
786 	/* call recursively to verify the referenced clock entity */
787 	err = __check_input_term(state, d->bCSourceID, term);
788 	if (err < 0)
789 		return err;
790 
791 	/* save input term properties after recursion,
792 	 * to ensure they are not overriden by the recursion calls
793 	 */
794 	term->id = id;
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;
799 	return 0;
800 }
801 
802 static int parse_term_uac3_iterm_unit(struct mixer_build *state,
803 				      struct usb_audio_term *term,
804 				      void *p1, int id)
805 {
806 	struct uac3_input_terminal_descriptor *d = p1;
807 	int err;
808 
809 	/* call recursively to verify the referenced clock entity */
810 	err = __check_input_term(state, d->bCSourceID, term);
811 	if (err < 0)
812 		return err;
813 
814 	/* save input term properties after recursion,
815 	 * to ensure they are not overriden by the recursion calls
816 	 */
817 	term->id = id;
818 	term->type = le16_to_cpu(d->wTerminalType);
819 
820 	err = get_cluster_channels_v3(state, le16_to_cpu(d->wClusterDescrID));
821 	if (err < 0)
822 		return err;
823 	term->channels = err;
824 
825 	/* REVISIT: UAC3 IT doesn't have channels cfg */
826 	term->chconfig = 0;
827 
828 	term->name = le16_to_cpu(d->wTerminalDescrStr);
829 	return 0;
830 }
831 
832 static int parse_term_mixer_unit(struct mixer_build *state,
833 				 struct usb_audio_term *term,
834 				 void *p1, int id)
835 {
836 	struct uac_mixer_unit_descriptor *d = p1;
837 	int protocol = state->mixer->protocol;
838 	int err;
839 
840 	err = uac_mixer_unit_get_channels(state, d);
841 	if (err <= 0)
842 		return err;
843 
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);
849 	}
850 	return 0;
851 }
852 
853 static int parse_term_selector_unit(struct mixer_build *state,
854 				    struct usb_audio_term *term,
855 				    void *p1, int id)
856 {
857 	struct uac_selector_unit_descriptor *d = p1;
858 	int err;
859 
860 	/* call recursively to retrieve the channel info */
861 	err = __check_input_term(state, d->baSourceID[0], term);
862 	if (err < 0)
863 		return err;
864 	term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */
865 	term->id = id;
866 	if (state->mixer->protocol != UAC_VERSION_3)
867 		term->name = uac_selector_unit_iSelector(d);
868 	return 0;
869 }
870 
871 static int parse_term_proc_unit(struct mixer_build *state,
872 				struct usb_audio_term *term,
873 				void *p1, int id, int vtype)
874 {
875 	struct uac_processing_unit_descriptor *d = p1;
876 	int protocol = state->mixer->protocol;
877 	int err;
878 
879 	if (d->bNrInPins) {
880 		/* call recursively to retrieve the channel info */
881 		err = __check_input_term(state, d->baSourceID[0], term);
882 		if (err < 0)
883 			return err;
884 	}
885 
886 	term->type = vtype << 16; /* virtual type */
887 	term->id = id;
888 
889 	if (protocol == UAC_VERSION_3)
890 		return 0;
891 
892 	if (!term->channels) {
893 		term->channels = uac_processing_unit_bNrChannels(d);
894 		term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
895 	}
896 	term->name = uac_processing_unit_iProcessing(d, protocol);
897 	return 0;
898 }
899 
900 static int parse_term_uac2_clock_source(struct mixer_build *state,
901 					struct usb_audio_term *term,
902 					void *p1, int id)
903 {
904 	struct uac_clock_source_descriptor *d = p1;
905 
906 	term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
907 	term->id = id;
908 	term->name = d->iClockSource;
909 	return 0;
910 }
911 
912 static int parse_term_uac3_clock_source(struct mixer_build *state,
913 					struct usb_audio_term *term,
914 					void *p1, int id)
915 {
916 	struct uac3_clock_source_descriptor *d = p1;
917 
918 	term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
919 	term->id = id;
920 	term->name = le16_to_cpu(d->wClockSourceStr);
921 	return 0;
922 }
923 
924 #define PTYPE(a, b)	((a) << 8 | (b))
925 
926 /*
927  * parse the source unit recursively until it reaches to a terminal
928  * or a branched unit.
929  */
930 static int __check_input_term(struct mixer_build *state, int id,
931 			      struct usb_audio_term *term)
932 {
933 	int protocol = state->mixer->protocol;
934 	void *p1;
935 	unsigned char *hdr;
936 
937 	for (;;) {
938 		/* a loop in the terminal chain? */
939 		if (test_and_set_bit(id, state->termbitmap))
940 			return -EINVAL;
941 
942 		p1 = find_audio_control_unit(state, id);
943 		if (!p1)
944 			break;
945 		if (!snd_usb_validate_audio_desc(p1, protocol))
946 			break; /* bad descriptor */
947 
948 		hdr = p1;
949 		term->id = id;
950 
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;
957 
958 			id = d->bSourceID;
959 			break; /* continue to parse */
960 		}
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,
985 						    UAC3_EFFECT_UNIT);
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);
995 		default:
996 			return -ENODEV;
997 		}
998 	}
999 	return -ENODEV;
1000 }
1001 
1002 
1003 static int check_input_term(struct mixer_build *state, int id,
1004 			    struct usb_audio_term *term)
1005 {
1006 	memset(term, 0, sizeof(*term));
1007 	memset(state->termbitmap, 0, sizeof(state->termbitmap));
1008 	return __check_input_term(state, id, term);
1009 }
1010 
1011 /*
1012  * Feature Unit
1013  */
1014 
1015 /* feature unit control information */
1016 struct usb_feature_control_info {
1017 	int control;
1018 	const char *name;
1019 	int type;	/* data type for uac1 */
1020 	int type_uac2;	/* data type for uac2 if different from uac1, else -1 */
1021 };
1022 
1023 static const 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 },
1034 	/* UAC2 specific */
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 },
1038 };
1039 
1040 static void usb_mixer_elem_info_free(struct usb_mixer_elem_info *cval)
1041 {
1042 	kfree(cval);
1043 }
1044 
1045 /* private_free callback */
1046 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
1047 {
1048 	usb_mixer_elem_info_free(kctl->private_data);
1049 	kctl->private_data = NULL;
1050 }
1051 
1052 /*
1053  * interface to ALSA control for feature/mixer units
1054  */
1055 
1056 /* volume control quirks */
1057 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
1058 				  struct snd_kcontrol *kctl)
1059 {
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) {
1065 			cval->min = 0x0000;
1066 			cval->max = 0xffff;
1067 			cval->res = 0x00e6;
1068 			break;
1069 		}
1070 		if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1071 		    strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1072 			cval->min = 0x00;
1073 			cval->max = 0xff;
1074 			break;
1075 		}
1076 		if (strstr(kctl->id.name, "Effect Return") != NULL) {
1077 			cval->min = 0xb706;
1078 			cval->max = 0xff7b;
1079 			cval->res = 0x0073;
1080 			break;
1081 		}
1082 		if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1083 			(strstr(kctl->id.name, "Effect Send") != NULL)) {
1084 			cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
1085 			cval->max = 0xfcfe;
1086 			cval->res = 0x0073;
1087 		}
1088 		break;
1089 
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");
1095 			cval->min = 0x0000;
1096 			cval->max = 0x7f00;
1097 			cval->res = 0x0100;
1098 			break;
1099 		}
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");
1104 			cval->min = 0x00;
1105 			cval->max = 0x7f;
1106 			break;
1107 		}
1108 		break;
1109 
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");
1114 			cval->min = -256;
1115 		}
1116 		break;
1117 
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
1126 	 */
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");
1131 			cval->max = -256;
1132 		}
1133 		break;
1134 
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");
1139 			cval->min = 6080;
1140 			cval->max = 8768;
1141 			cval->res = 192;
1142 		}
1143 		break;
1144 
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
1159 	 */
1160 		if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1161 			usb_audio_info(chip,
1162 				"set resolution quirk: cval->res = 384\n");
1163 			cval->res = 384;
1164 		}
1165 		break;
1166 	}
1167 }
1168 
1169 /*
1170  * retrieve the minimum and maximum values for the specified control
1171  */
1172 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1173 				   int default_min, struct snd_kcontrol *kctl)
1174 {
1175 	/* for failsafe */
1176 	cval->min = default_min;
1177 	cval->max = cval->min + 1;
1178 	cval->res = 1;
1179 	cval->dBmin = cval->dBmax = 0;
1180 
1181 	if (cval->val_type == USB_MIXER_BOOLEAN ||
1182 	    cval->val_type == USB_MIXER_INV_BOOLEAN) {
1183 		cval->initialized = 1;
1184 	} else {
1185 		int minchn = 0;
1186 		if (cval->cmask) {
1187 			int i;
1188 			for (i = 0; i < MAX_CHANNELS; i++)
1189 				if (cval->cmask & (1 << i)) {
1190 					minchn = i + 1;
1191 					break;
1192 				}
1193 		}
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);
1200 			return -EINVAL;
1201 		}
1202 		if (get_ctl_value(cval, UAC_GET_RES,
1203 				  (cval->control << 8) | minchn,
1204 				  &cval->res) < 0) {
1205 			cval->res = 1;
1206 		} else {
1207 			int last_valid_res = cval->res;
1208 
1209 			while (cval->res > 1) {
1210 				if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1211 								(cval->control << 8) | minchn,
1212 								cval->res / 2) < 0)
1213 					break;
1214 				cval->res /= 2;
1215 			}
1216 			if (get_ctl_value(cval, UAC_GET_RES,
1217 					  (cval->control << 8) | minchn, &cval->res) < 0)
1218 				cval->res = last_valid_res;
1219 		}
1220 		if (cval->res == 0)
1221 			cval->res = 1;
1222 
1223 		/* Additional checks for the proper resolution
1224 		 *
1225 		 * Some devices report smaller resolutions than actually
1226 		 * reacting.  They don't return errors but simply clip
1227 		 * to the lower aligned value.
1228 		 */
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)
1233 				goto no_res_check;
1234 			for (;;) {
1235 				test = saved;
1236 				if (test < cval->max)
1237 					test += cval->res;
1238 				else
1239 					test -= cval->res;
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;
1244 					break;
1245 				}
1246 				if (test == check)
1247 					break;
1248 				cval->res *= 2;
1249 			}
1250 			snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1251 		}
1252 
1253 no_res_check:
1254 		cval->initialized = 1;
1255 	}
1256 
1257 	if (kctl)
1258 		volume_control_quirks(cval, kctl);
1259 
1260 	/* USB descriptions contain the dB scale in 1/256 dB unit
1261 	 * while ALSA TLV contains in 1/100 dB unit
1262 	 */
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)
1268 			cval->dBmax = 0;
1269 		else if (cval->dBmin > 0)
1270 			cval->dBmin = 0;
1271 		if (cval->dBmin > cval->dBmax) {
1272 			/* totally crap, return an error */
1273 			return -EINVAL;
1274 		}
1275 	}
1276 
1277 	return 0;
1278 }
1279 
1280 #define get_min_max(cval, def)	get_min_max_with_quirks(cval, def, NULL)
1281 
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)
1285 {
1286 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1287 
1288 	if (cval->val_type == USB_MIXER_BOOLEAN ||
1289 	    cval->val_type == USB_MIXER_INV_BOOLEAN)
1290 		uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1291 	else
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;
1298 	} else {
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,
1307 					       &kcontrol->id);
1308 			}
1309 		}
1310 		uinfo->value.integer.min = 0;
1311 		uinfo->value.integer.max =
1312 			(cval->max - cval->min + cval->res - 1) / cval->res;
1313 	}
1314 	return 0;
1315 }
1316 
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)
1320 {
1321 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1322 	int c, cnt, val, err;
1323 
1324 	ucontrol->value.integer.value[0] = cval->min;
1325 	if (cval->cmask) {
1326 		cnt = 0;
1327 		for (c = 0; c < MAX_CHANNELS; c++) {
1328 			if (!(cval->cmask & (1 << c)))
1329 				continue;
1330 			err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1331 			if (err < 0)
1332 				return filter_error(cval, err);
1333 			val = get_relative_value(cval, val);
1334 			ucontrol->value.integer.value[cnt] = val;
1335 			cnt++;
1336 		}
1337 		return 0;
1338 	} else {
1339 		/* master channel */
1340 		err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1341 		if (err < 0)
1342 			return filter_error(cval, err);
1343 		val = get_relative_value(cval, val);
1344 		ucontrol->value.integer.value[0] = val;
1345 	}
1346 	return 0;
1347 }
1348 
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)
1352 {
1353 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1354 	int c, cnt, val, oval, err;
1355 	int changed = 0;
1356 
1357 	if (cval->cmask) {
1358 		cnt = 0;
1359 		for (c = 0; c < MAX_CHANNELS; c++) {
1360 			if (!(cval->cmask & (1 << c)))
1361 				continue;
1362 			err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1363 			if (err < 0)
1364 				return filter_error(cval, err);
1365 			val = ucontrol->value.integer.value[cnt];
1366 			val = get_abs_value(cval, val);
1367 			if (oval != val) {
1368 				snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1369 				changed = 1;
1370 			}
1371 			cnt++;
1372 		}
1373 	} else {
1374 		/* master channel */
1375 		err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1376 		if (err < 0)
1377 			return filter_error(cval, err);
1378 		val = ucontrol->value.integer.value[0];
1379 		val = get_abs_value(cval, val);
1380 		if (val != oval) {
1381 			snd_usb_set_cur_mix_value(cval, 0, 0, val);
1382 			changed = 1;
1383 		}
1384 	}
1385 	return changed;
1386 }
1387 
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)
1391 {
1392 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1393 	int val, err;
1394 
1395 	err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1396 	if (err < 0)
1397 		return filter_error(cval, err);
1398 	val = (val != 0);
1399 	ucontrol->value.integer.value[0] = val;
1400 	return 0;
1401 }
1402 
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)
1406 {
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;
1410 
1411 	validx = cval->control << 8 | 0;
1412 
1413 	ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
1414 	if (ret)
1415 		goto error;
1416 
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;
1420 
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;
1427 
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;
1432 	}
1433 
1434 	snd_usb_unlock_shutdown(chip);
1435 
1436 	if (ret < 0) {
1437 error:
1438 		usb_audio_err(chip,
1439 			"cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1440 			UAC_GET_CUR, validx, idx, cval->val_type);
1441 		return ret;
1442 	}
1443 
1444 	ucontrol->value.integer.value[0] = val;
1445 	return 0;
1446 }
1447 
1448 static const 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,
1454 };
1455 
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,
1462 	.put = NULL,
1463 };
1464 
1465 /*
1466  * A control which shows the boolean value from reading a UAC control on
1467  * the master channel.
1468  */
1469 static const 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,
1475 	.put = NULL,
1476 };
1477 
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,
1484 	.put = NULL,
1485 };
1486 
1487 /*
1488  * This symbol is exported in order to allow the mixer quirks to
1489  * hook up to the standard feature unit control mechanism
1490  */
1491 const struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1492 
1493 /*
1494  * build a feature control
1495  */
1496 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1497 {
1498 	return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1499 }
1500 
1501 /*
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.
1505  */
1506 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1507 					struct snd_card *card)
1508 {
1509 	const char *names_to_check[] = {
1510 		"Headset", "headset", "Headphone", "headphone", NULL};
1511 	const char **s;
1512 	bool found = false;
1513 
1514 	if (strcmp("Speaker", kctl->id.name))
1515 		return;
1516 
1517 	for (s = names_to_check; *s; s++)
1518 		if (strstr(card->shortname, *s)) {
1519 			found = true;
1520 			break;
1521 		}
1522 
1523 	if (!found)
1524 		return;
1525 
1526 	strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1527 }
1528 
1529 static const struct usb_feature_control_info *get_feature_control_info(int control)
1530 {
1531 	int i;
1532 
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];
1536 	}
1537 	return NULL;
1538 }
1539 
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)
1546 {
1547 	const 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;
1553 	unsigned int range;
1554 
1555 	if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1556 		/* FIXME: not supported yet */
1557 		return;
1558 	}
1559 
1560 	map = find_map(imap, unitid, control);
1561 	if (check_ignored_ctl(map))
1562 		return;
1563 
1564 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1565 	if (!cval)
1566 		return;
1567 	snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
1568 	cval->control = control;
1569 	cval->cmask = ctl_mask;
1570 
1571 	ctl_info = get_feature_control_info(control);
1572 	if (!ctl_info) {
1573 		usb_mixer_elem_info_free(cval);
1574 		return;
1575 	}
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;
1581 
1582 	if (ctl_mask == 0) {
1583 		cval->channels = 1;	/* master channel */
1584 		cval->master_readonly = readonly_mask;
1585 	} else {
1586 		int i, c = 0;
1587 		for (i = 0; i < 16; i++)
1588 			if (ctl_mask & (1 << i))
1589 				c++;
1590 		cval->channels = c;
1591 		cval->ch_readonly = readonly_mask;
1592 	}
1593 
1594 	/*
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.
1598 	 */
1599 	if (cval->channels == readonly_mask)
1600 		kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1601 	else
1602 		kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1603 
1604 	if (!kctl) {
1605 		usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1606 		usb_mixer_elem_info_free(cval);
1607 		return;
1608 	}
1609 	kctl->private_free = snd_usb_mixer_elem_free;
1610 
1611 	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1612 	mapped_name = len != 0;
1613 	if (!len && nameid)
1614 		len = snd_usb_copy_string_desc(mixer->chip, nameid,
1615 				kctl->id.name, sizeof(kctl->id.name));
1616 
1617 	switch (control) {
1618 	case UAC_FU_MUTE:
1619 	case UAC_FU_VOLUME:
1620 		/*
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
1624 		 *   of terminal type.
1625 		 * - if the connected output can be determined, use it.
1626 		 * - otherwise, anonymous name.
1627 		 */
1628 		if (!len) {
1629 			if (iterm)
1630 				len = get_term_name(mixer->chip, iterm,
1631 						    kctl->id.name,
1632 						    sizeof(kctl->id.name), 1);
1633 			if (!len && oterm)
1634 				len = get_term_name(mixer->chip, oterm,
1635 						    kctl->id.name,
1636 						    sizeof(kctl->id.name), 1);
1637 			if (!len)
1638 				snprintf(kctl->id.name, sizeof(kctl->id.name),
1639 					 "Feature %d", unitid);
1640 		}
1641 
1642 		if (!mapped_name)
1643 			check_no_speaker_on_headset(kctl, mixer->chip->card);
1644 
1645 		/*
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 :)
1649 		 */
1650 		if (!mapped_name && oterm && !(oterm->type >> 16)) {
1651 			if ((oterm->type & 0xff00) == 0x0100)
1652 				append_ctl_name(kctl, " Capture");
1653 			else
1654 				append_ctl_name(kctl, " Playback");
1655 		}
1656 		append_ctl_name(kctl, control == UAC_FU_MUTE ?
1657 				" Switch" : " Volume");
1658 		break;
1659 	default:
1660 		if (!len)
1661 			strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1662 				sizeof(kctl->id.name));
1663 		break;
1664 	}
1665 
1666 	/* get min/max values */
1667 	get_min_max_with_quirks(cval, 0, kctl);
1668 
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;
1676 		}
1677 	}
1678 
1679 	snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1680 
1681 	range = (cval->max - cval->min) / cval->res;
1682 	/*
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.
1686 	 */
1687 	if (range > 384) {
1688 		usb_audio_warn(mixer->chip,
1689 			       "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1690 			       range);
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);
1695 	}
1696 
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);
1701 }
1702 
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,
1706 			      int readonly_mask)
1707 {
1708 	struct uac_feature_unit_descriptor *desc = raw_desc;
1709 	int nameid = uac_feature_unit_iFeature(desc);
1710 
1711 	__build_feature_ctl(state->mixer, state->map, ctl_mask, control,
1712 			iterm, &state->oterm, unitid, nameid, readonly_mask);
1713 }
1714 
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)
1718 {
1719 	__build_feature_ctl(mixer, badd_map, ctl_mask, control,
1720 			NULL, NULL, unitid, 0, 0);
1721 }
1722 
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)
1726 {
1727 	int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1728 
1729 	if (name_len == 0)
1730 		strlcpy(name, "Unknown", name_size);
1731 
1732 	/*
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.
1736 	 */
1737 	if (is_input)
1738 		strlcat(name, " - Input Jack", name_size);
1739 	else
1740 		strlcat(name, " - Output Jack", name_size);
1741 }
1742 
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)
1746 {
1747 	struct snd_kcontrol *kctl;
1748 	struct usb_mixer_elem_info *cval;
1749 
1750 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1751 	if (!cval)
1752 		return;
1753 	snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1754 	/*
1755 	 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1756 	 * number of channels connected.
1757 	 *
1758 	 * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1759 	 * following byte(s) specifies which connectors are inserted.
1760 	 *
1761 	 * This boolean ctl will simply report if any channels are connected
1762 	 * or not.
1763 	 */
1764 	if (mixer->protocol == UAC_VERSION_2)
1765 		cval->control = UAC2_TE_CONNECTOR;
1766 	else /* UAC_VERSION_3 */
1767 		cval->control = UAC3_TE_INSERTION;
1768 
1769 	cval->val_type = USB_MIXER_BOOLEAN;
1770 	cval->channels = 1; /* report true if any channel is connected */
1771 	cval->min = 0;
1772 	cval->max = 1;
1773 	kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1774 	if (!kctl) {
1775 		usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1776 		usb_mixer_elem_info_free(cval);
1777 		return;
1778 	}
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);
1783 }
1784 
1785 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1786 				   void *_ftr)
1787 {
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];
1792 	int ret;
1793 
1794 	if (state->mixer->protocol != UAC_VERSION_2)
1795 		return -EINVAL;
1796 
1797 	/*
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.
1800 	 */
1801 	if (!uac_v2v3_control_is_readable(hdr->bmControls,
1802 				      UAC2_CS_CONTROL_CLOCK_VALID))
1803 		return 0;
1804 
1805 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1806 	if (!cval)
1807 		return -ENOMEM;
1808 
1809 	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1810 
1811 	cval->min = 0;
1812 	cval->max = 1;
1813 	cval->channels = 1;
1814 	cval->val_type = USB_MIXER_BOOLEAN;
1815 	cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1816 
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);
1820 
1821 	if (!kctl) {
1822 		usb_mixer_elem_info_free(cval);
1823 		return -ENOMEM;
1824 	}
1825 
1826 	kctl->private_free = snd_usb_mixer_elem_free;
1827 	ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1828 				       name, sizeof(name));
1829 	if (ret > 0)
1830 		snprintf(kctl->id.name, sizeof(kctl->id.name),
1831 			 "%s Validity", name);
1832 	else
1833 		snprintf(kctl->id.name, sizeof(kctl->id.name),
1834 			 "Clock Source %d Validity", hdr->bClockID);
1835 
1836 	return snd_usb_mixer_add_control(&cval->head, kctl);
1837 }
1838 
1839 /*
1840  * parse a feature unit
1841  *
1842  * most of controls are defined here.
1843  */
1844 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1845 				    void *_ftr)
1846 {
1847 	int channels, i, j;
1848 	struct usb_audio_term iterm;
1849 	unsigned int master_bits;
1850 	int err, csize;
1851 	struct uac_feature_unit_descriptor *hdr = _ftr;
1852 	__u8 *bmaControls;
1853 
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;
1860 		csize = 4;
1861 		channels = (hdr->bLength - 6) / 4 - 1;
1862 		bmaControls = ftr->bmaControls;
1863 	} else { /* UAC_VERSION_3 */
1864 		struct uac3_feature_unit_descriptor *ftr = _ftr;
1865 
1866 		csize = 4;
1867 		channels = (ftr->bLength - 7) / 4 - 1;
1868 		bmaControls = ftr->bmaControls;
1869 	}
1870 
1871 	/* parse the source unit */
1872 	err = parse_audio_unit(state, hdr->bSourceID);
1873 	if (err < 0)
1874 		return err;
1875 
1876 	/* determine the input source type and name */
1877 	err = check_input_term(state, hdr->bSourceID, &iterm);
1878 	if (err < 0)
1879 		return err;
1880 
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);
1889 		break;
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 */
1894 		channels = 0;
1895 		break;
1896 
1897 	}
1898 
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;
1904 
1905 			for (j = 0; j < channels; j++) {
1906 				unsigned int mask;
1907 
1908 				mask = snd_usb_combine_bytes(bmaControls +
1909 							     csize * (j+1), csize);
1910 				if (mask & (1 << i))
1911 					ch_bits |= (1 << j);
1912 			}
1913 			/* audio class v1 controls are never read-only */
1914 
1915 			/*
1916 			 * The first channel must be set
1917 			 * (for ease of programming).
1918 			 */
1919 			if (ch_bits & 1)
1920 				build_feature_ctl(state, _ftr, ch_bits, control,
1921 						  &iterm, unitid, 0);
1922 			if (master_bits & (1 << i))
1923 				build_feature_ctl(state, _ftr, 0, control,
1924 						  &iterm, unitid, 0);
1925 		}
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;
1931 
1932 			for (j = 0; j < channels; j++) {
1933 				unsigned int mask;
1934 
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);
1941 				}
1942 			}
1943 
1944 			/*
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
1950 			 * channels.
1951 			 */
1952 
1953 			/*
1954 			 * The first channel must be set
1955 			 * (for ease of programming).
1956 			 */
1957 			if (ch_bits & 1)
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,
1962 						  &iterm, unitid,
1963 						  !uac_v2v3_control_is_writeable(master_bits,
1964 										 control));
1965 		}
1966 	}
1967 
1968 	return 0;
1969 }
1970 
1971 /*
1972  * Mixer Unit
1973  */
1974 
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)
1978 {
1979 	u8 *hdr = (u8 *)desc;
1980 	u8 *c = uac_mixer_unit_bmControls(desc, protocol);
1981 	size_t rest; /* remaining bytes after bmMixerControls */
1982 
1983 	switch (protocol) {
1984 	case UAC_VERSION_1:
1985 	default:
1986 		rest = 1; /* iMixer */
1987 		break;
1988 	case UAC_VERSION_2:
1989 		rest = 2; /* bmControls + iMixer */
1990 		break;
1991 	case UAC_VERSION_3:
1992 		rest = 6; /* bmControls + wMixerDescrStr */
1993 		break;
1994 	}
1995 
1996 	/* overflow? */
1997 	return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
1998 }
1999 
2000 /*
2001  * build a mixer unit control
2002  *
2003  * the callbacks are identical with feature unit.
2004  * input channel number (zero based) is given in control field instead.
2005  */
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)
2010 {
2011 	struct usb_mixer_elem_info *cval;
2012 	unsigned int i, len;
2013 	struct snd_kcontrol *kctl;
2014 	const struct usbmix_name_map *map;
2015 
2016 	map = find_map(state->map, unitid, 0);
2017 	if (check_ignored_ctl(map))
2018 		return;
2019 
2020 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2021 	if (!cval)
2022 		return;
2023 
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);
2029 
2030 		if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
2031 			cval->cmask |= (1 << i);
2032 			cval->channels++;
2033 		}
2034 	}
2035 
2036 	/* get min/max values */
2037 	get_min_max(cval, 0);
2038 
2039 	kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2040 	if (!kctl) {
2041 		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2042 		usb_mixer_elem_info_free(cval);
2043 		return;
2044 	}
2045 	kctl->private_free = snd_usb_mixer_elem_free;
2046 
2047 	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2048 	if (!len)
2049 		len = get_term_name(state->chip, iterm, kctl->id.name,
2050 				    sizeof(kctl->id.name), 0);
2051 	if (!len)
2052 		len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
2053 	append_ctl_name(kctl, " Volume");
2054 
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);
2058 }
2059 
2060 static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
2061 				      void *raw_desc)
2062 {
2063 	struct usb_audio_term iterm;
2064 	unsigned int control, bmctls, term_id;
2065 
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);
2076 	} else {
2077 		return 0; /* UAC1. No Insertion control */
2078 	}
2079 
2080 	check_input_term(state, term_id, &iterm);
2081 
2082 	/* Check for jack detection. */
2083 	if (uac_v2v3_control_is_readable(bmctls, control))
2084 		build_connector_control(state->mixer, &iterm, true);
2085 
2086 	return 0;
2087 }
2088 
2089 /*
2090  * parse a mixer unit
2091  */
2092 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
2093 				  void *raw_desc)
2094 {
2095 	struct uac_mixer_unit_descriptor *desc = raw_desc;
2096 	struct usb_audio_term iterm;
2097 	int input_pins, num_ins, num_outs;
2098 	int pin, ich, err;
2099 
2100 	err = uac_mixer_unit_get_channels(state, desc);
2101 	if (err < 0) {
2102 		usb_audio_err(state->chip,
2103 			      "invalid MIXER UNIT descriptor %d\n",
2104 			      unitid);
2105 		return err;
2106 	}
2107 
2108 	num_outs = err;
2109 	input_pins = desc->bNrInPins;
2110 
2111 	num_ins = 0;
2112 	ich = 0;
2113 	for (pin = 0; pin < input_pins; pin++) {
2114 		err = parse_audio_unit(state, desc->baSourceID[pin]);
2115 		if (err < 0)
2116 			continue;
2117 		/* no bmControls field (e.g. Maya44) -> ignore */
2118 		if (!num_outs)
2119 			continue;
2120 		err = check_input_term(state, desc->baSourceID[pin], &iterm);
2121 		if (err < 0)
2122 			return err;
2123 		num_ins += iterm.channels;
2124 		if (mixer_bitmap_overflow(desc, state->mixer->protocol,
2125 					  num_ins, num_outs))
2126 			break;
2127 		for (; ich < num_ins; ich++) {
2128 			int och, ich_has_controls = 0;
2129 
2130 			for (och = 0; och < num_outs; och++) {
2131 				__u8 *c = uac_mixer_unit_bmControls(desc,
2132 						state->mixer->protocol);
2133 
2134 				if (check_matrix_bitmap(c, ich, och, num_outs)) {
2135 					ich_has_controls = 1;
2136 					break;
2137 				}
2138 			}
2139 			if (ich_has_controls)
2140 				build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
2141 						     unitid, &iterm);
2142 		}
2143 	}
2144 	return 0;
2145 }
2146 
2147 /*
2148  * Processing Unit / Extension Unit
2149  */
2150 
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)
2154 {
2155 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2156 	int err, val;
2157 
2158 	err = get_cur_ctl_value(cval, cval->control << 8, &val);
2159 	if (err < 0) {
2160 		ucontrol->value.integer.value[0] = cval->min;
2161 		return filter_error(cval, err);
2162 	}
2163 	val = get_relative_value(cval, val);
2164 	ucontrol->value.integer.value[0] = val;
2165 	return 0;
2166 }
2167 
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)
2171 {
2172 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2173 	int val, oval, err;
2174 
2175 	err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2176 	if (err < 0)
2177 		return filter_error(cval, err);
2178 	val = ucontrol->value.integer.value[0];
2179 	val = get_abs_value(cval, val);
2180 	if (val != oval) {
2181 		set_cur_ctl_value(cval, cval->control << 8, val);
2182 		return 1;
2183 	}
2184 	return 0;
2185 }
2186 
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,
2194 };
2195 
2196 /*
2197  * predefined data for processing units
2198  */
2199 struct procunit_value_info {
2200 	int control;
2201 	const char *suffix;
2202 	int val_type;
2203 	int min_value;
2204 };
2205 
2206 struct procunit_info {
2207 	int type;
2208 	char *name;
2209 	const struct procunit_value_info *values;
2210 };
2211 
2212 static const struct procunit_value_info undefined_proc_info[] = {
2213 	{ 0x00, "Control Undefined", 0 },
2214 	{ 0 }
2215 };
2216 
2217 static const 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 },
2220 	{ 0 }
2221 };
2222 static const 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 },
2225 	{ 0 }
2226 };
2227 static const struct procunit_value_info threed_enh_proc_info[] = {
2228 	{ UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2229 	{ UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2230 	{ 0 }
2231 };
2232 static const 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 },
2237 	{ 0 }
2238 };
2239 static const 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 },
2244 	{ 0 }
2245 };
2246 static const 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 },
2253 	{ 0 }
2254 };
2255 
2256 static const 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 },
2263 	{ 0 },
2264 };
2265 
2266 static const struct procunit_value_info uac3_updown_proc_info[] = {
2267 	{ UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2268 	{ 0 }
2269 };
2270 static const struct procunit_value_info uac3_stereo_ext_proc_info[] = {
2271 	{ UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
2272 	{ 0 }
2273 };
2274 
2275 static const 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 },
2279 	{ 0 },
2280 };
2281 
2282 /*
2283  * predefined data for extension units
2284  */
2285 static const struct procunit_value_info clock_rate_xu_info[] = {
2286 	{ USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2287 	{ 0 }
2288 };
2289 static const struct procunit_value_info clock_source_xu_info[] = {
2290 	{ USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2291 	{ 0 }
2292 };
2293 static const struct procunit_value_info spdif_format_xu_info[] = {
2294 	{ USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2295 	{ 0 }
2296 };
2297 static const struct procunit_value_info soft_limit_xu_info[] = {
2298 	{ USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2299 	{ 0 }
2300 };
2301 static const 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 },
2306 	{ 0 }
2307 };
2308 
2309 /*
2310  * build a processing/extension unit
2311  */
2312 static int build_audio_procunit(struct mixer_build *state, int unitid,
2313 				void *raw_desc, const struct procunit_info *list,
2314 				bool extension_unit)
2315 {
2316 	struct uac_processing_unit_descriptor *desc = raw_desc;
2317 	int num_ins;
2318 	struct usb_mixer_elem_info *cval;
2319 	struct snd_kcontrol *kctl;
2320 	int i, err, nameid, type, len;
2321 	const struct procunit_info *info;
2322 	const struct procunit_value_info *valinfo;
2323 	const struct usbmix_name_map *map;
2324 	static const struct procunit_value_info default_value_info[] = {
2325 		{ 0x01, "Switch", USB_MIXER_BOOLEAN },
2326 		{ 0 }
2327 	};
2328 	static const struct procunit_info default_info = {
2329 		0, NULL, default_value_info
2330 	};
2331 	const char *name = extension_unit ?
2332 		"Extension Unit" : "Processing Unit";
2333 
2334 	num_ins = desc->bNrInPins;
2335 	for (i = 0; i < num_ins; i++) {
2336 		err = parse_audio_unit(state, desc->baSourceID[i]);
2337 		if (err < 0)
2338 			return err;
2339 	}
2340 
2341 	type = le16_to_cpu(desc->wProcessType);
2342 	for (info = list; info && info->type; info++)
2343 		if (info->type == type)
2344 			break;
2345 	if (!info || !info->type)
2346 		info = &default_info;
2347 
2348 	for (valinfo = info->values; valinfo->control; valinfo++) {
2349 		__u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2350 
2351 		if (state->mixer->protocol == UAC_VERSION_1) {
2352 			if (!(controls[valinfo->control / 8] &
2353 					(1 << ((valinfo->control % 8) - 1))))
2354 				continue;
2355 		} else { /* UAC_VERSION_2/3 */
2356 			if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
2357 							  valinfo->control))
2358 				continue;
2359 		}
2360 
2361 		map = find_map(state->map, unitid, valinfo->control);
2362 		if (check_ignored_ctl(map))
2363 			continue;
2364 		cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2365 		if (!cval)
2366 			return -ENOMEM;
2367 		snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2368 		cval->control = valinfo->control;
2369 		cval->val_type = valinfo->val_type;
2370 		cval->channels = 1;
2371 
2372 		if (state->mixer->protocol > UAC_VERSION_1 &&
2373 		    !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
2374 						   valinfo->control))
2375 			cval->master_readonly = 1;
2376 
2377 		/* get min/max values */
2378 		switch (type) {
2379 		case UAC_PROCESS_UP_DOWNMIX: {
2380 			bool mode_sel = false;
2381 
2382 			switch (state->mixer->protocol) {
2383 			case UAC_VERSION_1:
2384 			case UAC_VERSION_2:
2385 			default:
2386 				if (cval->control == UAC_UD_MODE_SELECT)
2387 					mode_sel = true;
2388 				break;
2389 			case UAC_VERSION_3:
2390 				if (cval->control == UAC3_UD_MODE_SELECT)
2391 					mode_sel = true;
2392 				break;
2393 			}
2394 
2395 			if (mode_sel) {
2396 				__u8 *control_spec = uac_processing_unit_specific(desc,
2397 								state->mixer->protocol);
2398 				cval->min = 1;
2399 				cval->max = control_spec[0];
2400 				cval->res = 1;
2401 				cval->initialized = 1;
2402 				break;
2403 			}
2404 
2405 			get_min_max(cval, valinfo->min_value);
2406 			break;
2407 		}
2408 		case USB_XU_CLOCK_RATE:
2409 			/*
2410 			 * E-Mu USB 0404/0202/TrackerPre/0204
2411 			 * samplerate control quirk
2412 			 */
2413 			cval->min = 0;
2414 			cval->max = 5;
2415 			cval->res = 1;
2416 			cval->initialized = 1;
2417 			break;
2418 		default:
2419 			get_min_max(cval, valinfo->min_value);
2420 			break;
2421 		}
2422 
2423 		kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2424 		if (!kctl) {
2425 			usb_mixer_elem_info_free(cval);
2426 			return -ENOMEM;
2427 		}
2428 		kctl->private_free = snd_usb_mixer_elem_free;
2429 
2430 		if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2431 			/* nothing */ ;
2432 		} else if (info->name) {
2433 			strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2434 		} else {
2435 			if (extension_unit)
2436 				nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
2437 			else
2438 				nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2439 			len = 0;
2440 			if (nameid)
2441 				len = snd_usb_copy_string_desc(state->chip,
2442 							       nameid,
2443 							       kctl->id.name,
2444 							       sizeof(kctl->id.name));
2445 			if (!len)
2446 				strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
2447 		}
2448 		append_ctl_name(kctl, " ");
2449 		append_ctl_name(kctl, valinfo->suffix);
2450 
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);
2455 
2456 		err = snd_usb_mixer_add_control(&cval->head, kctl);
2457 		if (err < 0)
2458 			return err;
2459 	}
2460 	return 0;
2461 }
2462 
2463 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2464 				       void *raw_desc)
2465 {
2466 	switch (state->mixer->protocol) {
2467 	case UAC_VERSION_1:
2468 	case UAC_VERSION_2:
2469 	default:
2470 		return build_audio_procunit(state, unitid, raw_desc,
2471 					    procunits, false);
2472 	case UAC_VERSION_3:
2473 		return build_audio_procunit(state, unitid, raw_desc,
2474 					    uac3_procunits, false);
2475 	}
2476 }
2477 
2478 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2479 				      void *raw_desc)
2480 {
2481 	/*
2482 	 * Note that we parse extension units with processing unit descriptors.
2483 	 * That's ok as the layout is the same.
2484 	 */
2485 	return build_audio_procunit(state, unitid, raw_desc, extunits, true);
2486 }
2487 
2488 /*
2489  * Selector Unit
2490  */
2491 
2492 /*
2493  * info callback for selector unit
2494  * use an enumerator type for routing
2495  */
2496 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2497 				   struct snd_ctl_elem_info *uinfo)
2498 {
2499 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2500 	const char **itemlist = (const char **)kcontrol->private_value;
2501 
2502 	if (snd_BUG_ON(!itemlist))
2503 		return -EINVAL;
2504 	return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2505 }
2506 
2507 /* get callback for selector unit */
2508 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2509 				  struct snd_ctl_elem_value *ucontrol)
2510 {
2511 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2512 	int val, err;
2513 
2514 	err = get_cur_ctl_value(cval, cval->control << 8, &val);
2515 	if (err < 0) {
2516 		ucontrol->value.enumerated.item[0] = 0;
2517 		return filter_error(cval, err);
2518 	}
2519 	val = get_relative_value(cval, val);
2520 	ucontrol->value.enumerated.item[0] = val;
2521 	return 0;
2522 }
2523 
2524 /* put callback for selector unit */
2525 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2526 				  struct snd_ctl_elem_value *ucontrol)
2527 {
2528 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2529 	int val, oval, err;
2530 
2531 	err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2532 	if (err < 0)
2533 		return filter_error(cval, err);
2534 	val = ucontrol->value.enumerated.item[0];
2535 	val = get_abs_value(cval, val);
2536 	if (val != oval) {
2537 		set_cur_ctl_value(cval, cval->control << 8, val);
2538 		return 1;
2539 	}
2540 	return 0;
2541 }
2542 
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,
2550 };
2551 
2552 /*
2553  * private free callback.
2554  * free both private_data and private_value
2555  */
2556 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2557 {
2558 	int i, num_ins = 0;
2559 
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;
2565 	}
2566 	if (kctl->private_value) {
2567 		char **itemlist = (char **)kctl->private_value;
2568 		for (i = 0; i < num_ins; i++)
2569 			kfree(itemlist[i]);
2570 		kfree(itemlist);
2571 		kctl->private_value = 0;
2572 	}
2573 }
2574 
2575 /*
2576  * parse a selector unit
2577  */
2578 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2579 				     void *raw_desc)
2580 {
2581 	struct uac_selector_unit_descriptor *desc = raw_desc;
2582 	unsigned int i, nameid, len;
2583 	int err;
2584 	struct usb_mixer_elem_info *cval;
2585 	struct snd_kcontrol *kctl;
2586 	const struct usbmix_name_map *map;
2587 	char **namelist;
2588 
2589 	for (i = 0; i < desc->bNrInPins; i++) {
2590 		err = parse_audio_unit(state, desc->baSourceID[i]);
2591 		if (err < 0)
2592 			return err;
2593 	}
2594 
2595 	if (desc->bNrInPins == 1) /* only one ? nonsense! */
2596 		return 0;
2597 
2598 	map = find_map(state->map, unitid, 0);
2599 	if (check_ignored_ctl(map))
2600 		return 0;
2601 
2602 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2603 	if (!cval)
2604 		return -ENOMEM;
2605 	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2606 	cval->val_type = USB_MIXER_U8;
2607 	cval->channels = 1;
2608 	cval->min = 1;
2609 	cval->max = desc->bNrInPins;
2610 	cval->res = 1;
2611 	cval->initialized = 1;
2612 
2613 	switch (state->mixer->protocol) {
2614 	case UAC_VERSION_1:
2615 	default:
2616 		cval->control = 0;
2617 		break;
2618 	case UAC_VERSION_2:
2619 	case UAC_VERSION_3:
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;
2625 		break;
2626 	}
2627 
2628 	namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2629 	if (!namelist) {
2630 		err = -ENOMEM;
2631 		goto error_cval;
2632 	}
2633 #define MAX_ITEM_NAME_LEN	64
2634 	for (i = 0; i < desc->bNrInPins; i++) {
2635 		struct usb_audio_term iterm;
2636 		len = 0;
2637 		namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2638 		if (!namelist[i]) {
2639 			err = -ENOMEM;
2640 			goto error_name;
2641 		}
2642 		len = check_mapped_selector_name(state, unitid, i, namelist[i],
2643 						 MAX_ITEM_NAME_LEN);
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);
2647 		if (! len)
2648 			sprintf(namelist[i], "Input %u", i);
2649 	}
2650 
2651 	kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2652 	if (! kctl) {
2653 		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2654 		err = -ENOMEM;
2655 		goto error_name;
2656 	}
2657 	kctl->private_value = (unsigned long)namelist;
2658 	kctl->private_free = usb_mixer_selector_elem_free;
2659 
2660 	/* check the static mapping table at first */
2661 	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2662 	if (!len) {
2663 		/* no mapping ? */
2664 		switch (state->mixer->protocol) {
2665 		case UAC_VERSION_1:
2666 		case UAC_VERSION_2:
2667 		default:
2668 		/* if iSelector is given, use it */
2669 			nameid = uac_selector_unit_iSelector(desc);
2670 			if (nameid)
2671 				len = snd_usb_copy_string_desc(state->chip,
2672 							nameid, kctl->id.name,
2673 							sizeof(kctl->id.name));
2674 			break;
2675 		case UAC_VERSION_3:
2676 			/* TODO: Class-Specific strings not yet supported */
2677 			break;
2678 		}
2679 
2680 		/* ... or pick up the terminal name at next */
2681 		if (!len)
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 */
2685 		if (!len)
2686 			strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2687 
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");
2694 		else
2695 			append_ctl_name(kctl, " Playback Source");
2696 	}
2697 
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);
2701 
2702  error_name:
2703 	for (i = 0; i < desc->bNrInPins; i++)
2704 		kfree(namelist[i]);
2705 	kfree(namelist);
2706  error_cval:
2707 	usb_mixer_elem_info_free(cval);
2708 	return err;
2709 }
2710 
2711 /*
2712  * parse an audio unit recursively
2713  */
2714 
2715 static int parse_audio_unit(struct mixer_build *state, int unitid)
2716 {
2717 	unsigned char *p1;
2718 	int protocol = state->mixer->protocol;
2719 
2720 	if (test_and_set_bit(unitid, state->unitbitmap))
2721 		return 0; /* the unit already visited */
2722 
2723 	p1 = find_audio_control_unit(state, unitid);
2724 	if (!p1) {
2725 		usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2726 		return -EINVAL;
2727 	}
2728 
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 */
2732 	}
2733 
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 */
2767 	default:
2768 		usb_audio_err(state->chip,
2769 			      "unit %u: unexpected type 0x%02x\n",
2770 			      unitid, p1[2]);
2771 		return -EINVAL;
2772 	}
2773 }
2774 
2775 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2776 {
2777 	/* kill pending URBs */
2778 	snd_usb_mixer_disconnect(mixer);
2779 
2780 	kfree(mixer->id_elems);
2781 	if (mixer->urb) {
2782 		kfree(mixer->urb->transfer_buffer);
2783 		usb_free_urb(mixer->urb);
2784 	}
2785 	usb_free_urb(mixer->rc_urb);
2786 	kfree(mixer->rc_setup_packet);
2787 	kfree(mixer);
2788 }
2789 
2790 static int snd_usb_mixer_dev_free(struct snd_device *device)
2791 {
2792 	struct usb_mixer_interface *mixer = device->device_data;
2793 	snd_usb_mixer_free(mixer);
2794 	return 0;
2795 }
2796 
2797 /* UAC3 predefined channels configuration */
2798 struct uac3_badd_profile {
2799 	int subclass;
2800 	const char *name;
2801 	int c_chmask;	/* capture channels mask */
2802 	int p_chmask;	/* playback channels mask */
2803 	int st_chmask;	/* side tone mixing channel mask */
2804 };
2805 
2806 static const struct uac3_badd_profile uac3_badd_profiles[] = {
2807 	{
2808 		/*
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
2812 		 */
2813 		.subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
2814 		.name = "GENERIC IO",
2815 		.c_chmask = -1,		/* dynamic channels */
2816 		.p_chmask = -1,		/* dynamic channels */
2817 	},
2818 	{
2819 		/* BAOF; Stereo only cfg, Mono alt possible */
2820 		.subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
2821 		.name = "HEADPHONE",
2822 		.p_chmask = 3,
2823 	},
2824 	{
2825 		/* BAOF; Mono or Stereo cfg, Mono alt possible */
2826 		.subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
2827 		.name = "SPEAKER",
2828 		.p_chmask = -1,		/* dynamic channels */
2829 	},
2830 	{
2831 		/* BAIF; Mono or Stereo cfg, Mono alt possible */
2832 		.subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
2833 		.name = "MICROPHONE",
2834 		.c_chmask = -1,		/* dynamic channels */
2835 	},
2836 	{
2837 		/*
2838 		 * BAIOF topology
2839 		 * IN: Mono only
2840 		 * OUT: Mono or Stereo cfg, Mono alt possible
2841 		 */
2842 		.subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
2843 		.name = "HEADSET",
2844 		.c_chmask = 1,
2845 		.p_chmask = -1,		/* dynamic channels */
2846 		.st_chmask = 1,
2847 	},
2848 	{
2849 		/* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
2850 		.subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
2851 		.name = "HEADSET ADAPTER",
2852 		.c_chmask = 1,
2853 		.p_chmask = 3,
2854 		.st_chmask = 1,
2855 	},
2856 	{
2857 		/* BAIF + BAOF; IN: Mono only; OUT: Mono only */
2858 		.subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
2859 		.name = "SPEAKERPHONE",
2860 		.c_chmask = 1,
2861 		.p_chmask = 1,
2862 	},
2863 	{ 0 } /* terminator */
2864 };
2865 
2866 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
2867 					      const struct uac3_badd_profile *f,
2868 					      int c_chmask, int p_chmask)
2869 {
2870 	/*
2871 	 * If both playback/capture channels are dynamic, make sure
2872 	 * at least one channel is present
2873 	 */
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?",
2877 				       f->name);
2878 			return false;
2879 		}
2880 		return true;
2881 	}
2882 
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",
2886 			       f->name);
2887 		return false;
2888 	}
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",
2892 			       f->name);
2893 		return false;
2894 	}
2895 	return true;
2896 }
2897 
2898 /*
2899  * create mixer controls for UAC3 BADD profiles
2900  *
2901  * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
2902  *
2903  * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
2904  */
2905 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
2906 				       int ctrlif)
2907 {
2908 	struct usb_device *dev = mixer->chip->dev;
2909 	struct usb_interface_assoc_descriptor *assoc;
2910 	int badd_profile = mixer->chip->badd_profile;
2911 	const struct uac3_badd_profile *f;
2912 	const struct usbmix_ctl_map *map;
2913 	int p_chmask = 0, c_chmask = 0, st_chmask = 0;
2914 	int i;
2915 
2916 	assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
2917 
2918 	/* Detect BADD capture/playback channels from AS EP descriptors */
2919 	for (i = 0; i < assoc->bInterfaceCount; i++) {
2920 		int intf = assoc->bFirstInterface + i;
2921 
2922 		struct usb_interface *iface;
2923 		struct usb_host_interface *alts;
2924 		struct usb_interface_descriptor *altsd;
2925 		unsigned int maxpacksize;
2926 		char dir_in;
2927 		int chmask, num;
2928 
2929 		if (intf == ctrlif)
2930 			continue;
2931 
2932 		iface = usb_ifnum_to_if(dev, intf);
2933 		if (!iface)
2934 			continue;
2935 
2936 		num = iface->num_altsetting;
2937 
2938 		if (num < 2)
2939 			return -EINVAL;
2940 
2941 		/*
2942 		 * The number of Channels in an AudioStreaming interface
2943 		 * and the audio sample bit resolution (16 bits or 24
2944 		 * bits) can be derived from the wMaxPacketSize field in
2945 		 * the Standard AS Audio Data Endpoint descriptor in
2946 		 * Alternate Setting 1
2947 		 */
2948 		alts = &iface->altsetting[1];
2949 		altsd = get_iface_desc(alts);
2950 
2951 		if (altsd->bNumEndpoints < 1)
2952 			return -EINVAL;
2953 
2954 		/* check direction */
2955 		dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
2956 		maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2957 
2958 		switch (maxpacksize) {
2959 		default:
2960 			usb_audio_err(mixer->chip,
2961 				"incorrect wMaxPacketSize 0x%x for BADD profile\n",
2962 				maxpacksize);
2963 			return -EINVAL;
2964 		case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
2965 		case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
2966 		case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
2967 		case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
2968 			chmask = 1;
2969 			break;
2970 		case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
2971 		case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
2972 		case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
2973 		case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
2974 			chmask = 3;
2975 			break;
2976 		}
2977 
2978 		if (dir_in)
2979 			c_chmask = chmask;
2980 		else
2981 			p_chmask = chmask;
2982 	}
2983 
2984 	usb_audio_dbg(mixer->chip,
2985 		"UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
2986 		badd_profile, c_chmask, p_chmask);
2987 
2988 	/* check the mapping table */
2989 	for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
2990 		if (map->id == badd_profile)
2991 			break;
2992 	}
2993 
2994 	if (!map->id)
2995 		return -EINVAL;
2996 
2997 	for (f = uac3_badd_profiles; f->name; f++) {
2998 		if (badd_profile == f->subclass)
2999 			break;
3000 	}
3001 	if (!f->name)
3002 		return -EINVAL;
3003 	if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
3004 		return -EINVAL;
3005 	st_chmask = f->st_chmask;
3006 
3007 	/* Playback */
3008 	if (p_chmask) {
3009 		/* Master channel, always writable */
3010 		build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3011 				       UAC3_BADD_FU_ID2, map->map);
3012 		/* Mono/Stereo volume channels, always writable */
3013 		build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
3014 				       UAC3_BADD_FU_ID2, map->map);
3015 	}
3016 
3017 	/* Capture */
3018 	if (c_chmask) {
3019 		/* Master channel, always writable */
3020 		build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3021 				       UAC3_BADD_FU_ID5, map->map);
3022 		/* Mono/Stereo volume channels, always writable */
3023 		build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
3024 				       UAC3_BADD_FU_ID5, map->map);
3025 	}
3026 
3027 	/* Side tone-mixing */
3028 	if (st_chmask) {
3029 		/* Master channel, always writable */
3030 		build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3031 				       UAC3_BADD_FU_ID7, map->map);
3032 		/* Mono volume channel, always writable */
3033 		build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
3034 				       UAC3_BADD_FU_ID7, map->map);
3035 	}
3036 
3037 	/* Insertion Control */
3038 	if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
3039 		struct usb_audio_term iterm, oterm;
3040 
3041 		/* Input Term - Insertion control */
3042 		memset(&iterm, 0, sizeof(iterm));
3043 		iterm.id = UAC3_BADD_IT_ID4;
3044 		iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3045 		build_connector_control(mixer, &iterm, true);
3046 
3047 		/* Output Term - Insertion control */
3048 		memset(&oterm, 0, sizeof(oterm));
3049 		oterm.id = UAC3_BADD_OT_ID3;
3050 		oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3051 		build_connector_control(mixer, &oterm, false);
3052 	}
3053 
3054 	return 0;
3055 }
3056 
3057 /*
3058  * create mixer controls
3059  *
3060  * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3061  */
3062 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
3063 {
3064 	struct mixer_build state;
3065 	int err;
3066 	const struct usbmix_ctl_map *map;
3067 	void *p;
3068 
3069 	memset(&state, 0, sizeof(state));
3070 	state.chip = mixer->chip;
3071 	state.mixer = mixer;
3072 	state.buffer = mixer->hostif->extra;
3073 	state.buflen = mixer->hostif->extralen;
3074 
3075 	/* check the mapping table */
3076 	for (map = usbmix_ctl_maps; map->id; map++) {
3077 		if (map->id == state.chip->usb_id) {
3078 			state.map = map->map;
3079 			state.selector_map = map->selector_map;
3080 			mixer->ignore_ctl_error = map->ignore_ctl_error;
3081 			break;
3082 		}
3083 	}
3084 
3085 	p = NULL;
3086 	while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
3087 					    mixer->hostif->extralen,
3088 					    p, UAC_OUTPUT_TERMINAL)) != NULL) {
3089 		if (!snd_usb_validate_audio_desc(p, mixer->protocol))
3090 			continue; /* skip invalid descriptor */
3091 
3092 		if (mixer->protocol == UAC_VERSION_1) {
3093 			struct uac1_output_terminal_descriptor *desc = p;
3094 
3095 			/* mark terminal ID as visited */
3096 			set_bit(desc->bTerminalID, state.unitbitmap);
3097 			state.oterm.id = desc->bTerminalID;
3098 			state.oterm.type = le16_to_cpu(desc->wTerminalType);
3099 			state.oterm.name = desc->iTerminal;
3100 			err = parse_audio_unit(&state, desc->bSourceID);
3101 			if (err < 0 && err != -EINVAL)
3102 				return err;
3103 		} else if (mixer->protocol == UAC_VERSION_2) {
3104 			struct uac2_output_terminal_descriptor *desc = p;
3105 
3106 			/* mark terminal ID as visited */
3107 			set_bit(desc->bTerminalID, state.unitbitmap);
3108 			state.oterm.id = desc->bTerminalID;
3109 			state.oterm.type = le16_to_cpu(desc->wTerminalType);
3110 			state.oterm.name = desc->iTerminal;
3111 			err = parse_audio_unit(&state, desc->bSourceID);
3112 			if (err < 0 && err != -EINVAL)
3113 				return err;
3114 
3115 			/*
3116 			 * For UAC2, use the same approach to also add the
3117 			 * clock selectors
3118 			 */
3119 			err = parse_audio_unit(&state, desc->bCSourceID);
3120 			if (err < 0 && err != -EINVAL)
3121 				return err;
3122 
3123 			if (uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3124 							 UAC2_TE_CONNECTOR)) {
3125 				build_connector_control(state.mixer, &state.oterm,
3126 							false);
3127 			}
3128 		} else {  /* UAC_VERSION_3 */
3129 			struct uac3_output_terminal_descriptor *desc = p;
3130 
3131 			/* mark terminal ID as visited */
3132 			set_bit(desc->bTerminalID, state.unitbitmap);
3133 			state.oterm.id = desc->bTerminalID;
3134 			state.oterm.type = le16_to_cpu(desc->wTerminalType);
3135 			state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
3136 			err = parse_audio_unit(&state, desc->bSourceID);
3137 			if (err < 0 && err != -EINVAL)
3138 				return err;
3139 
3140 			/*
3141 			 * For UAC3, use the same approach to also add the
3142 			 * clock selectors
3143 			 */
3144 			err = parse_audio_unit(&state, desc->bCSourceID);
3145 			if (err < 0 && err != -EINVAL)
3146 				return err;
3147 
3148 			if (uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
3149 							 UAC3_TE_INSERTION)) {
3150 				build_connector_control(state.mixer, &state.oterm,
3151 							false);
3152 			}
3153 		}
3154 	}
3155 
3156 	return 0;
3157 }
3158 
3159 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3160 {
3161 	struct usb_mixer_elem_list *list;
3162 
3163 	for_each_mixer_elem(list, mixer, unitid) {
3164 		struct usb_mixer_elem_info *info =
3165 			mixer_elem_list_to_info(list);
3166 		/* invalidate cache, so the value is read from the device */
3167 		info->cached = 0;
3168 		snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3169 			       &list->kctl->id);
3170 	}
3171 }
3172 
3173 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3174 				    struct usb_mixer_elem_list *list)
3175 {
3176 	struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3177 	static const char * const val_types[] = {"BOOLEAN", "INV_BOOLEAN",
3178 				    "S8", "U8", "S16", "U16"};
3179 	snd_iprintf(buffer, "    Info: id=%i, control=%i, cmask=0x%x, "
3180 			    "channels=%i, type=\"%s\"\n", cval->head.id,
3181 			    cval->control, cval->cmask, cval->channels,
3182 			    val_types[cval->val_type]);
3183 	snd_iprintf(buffer, "    Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3184 			    cval->min, cval->max, cval->dBmin, cval->dBmax);
3185 }
3186 
3187 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
3188 				    struct snd_info_buffer *buffer)
3189 {
3190 	struct snd_usb_audio *chip = entry->private_data;
3191 	struct usb_mixer_interface *mixer;
3192 	struct usb_mixer_elem_list *list;
3193 	int unitid;
3194 
3195 	list_for_each_entry(mixer, &chip->mixer_list, list) {
3196 		snd_iprintf(buffer,
3197 			"USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3198 				chip->usb_id, snd_usb_ctrl_intf(chip),
3199 				mixer->ignore_ctl_error);
3200 		snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
3201 		for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3202 			for_each_mixer_elem(list, mixer, unitid) {
3203 				snd_iprintf(buffer, "  Unit: %i\n", list->id);
3204 				if (list->kctl)
3205 					snd_iprintf(buffer,
3206 						    "    Control: name=\"%s\", index=%i\n",
3207 						    list->kctl->id.name,
3208 						    list->kctl->id.index);
3209 				if (list->dump)
3210 					list->dump(buffer, list);
3211 			}
3212 		}
3213 	}
3214 }
3215 
3216 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
3217 				       int attribute, int value, int index)
3218 {
3219 	struct usb_mixer_elem_list *list;
3220 	__u8 unitid = (index >> 8) & 0xff;
3221 	__u8 control = (value >> 8) & 0xff;
3222 	__u8 channel = value & 0xff;
3223 	unsigned int count = 0;
3224 
3225 	if (channel >= MAX_CHANNELS) {
3226 		usb_audio_dbg(mixer->chip,
3227 			"%s(): bogus channel number %d\n",
3228 			__func__, channel);
3229 		return;
3230 	}
3231 
3232 	for_each_mixer_elem(list, mixer, unitid)
3233 		count++;
3234 
3235 	if (count == 0)
3236 		return;
3237 
3238 	for_each_mixer_elem(list, mixer, unitid) {
3239 		struct usb_mixer_elem_info *info;
3240 
3241 		if (!list->kctl)
3242 			continue;
3243 
3244 		info = mixer_elem_list_to_info(list);
3245 		if (count > 1 && info->control != control)
3246 			continue;
3247 
3248 		switch (attribute) {
3249 		case UAC2_CS_CUR:
3250 			/* invalidate cache, so the value is read from the device */
3251 			if (channel)
3252 				info->cached &= ~(1 << channel);
3253 			else /* master channel */
3254 				info->cached = 0;
3255 
3256 			snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3257 				       &info->head.kctl->id);
3258 			break;
3259 
3260 		case UAC2_CS_RANGE:
3261 			/* TODO */
3262 			break;
3263 
3264 		case UAC2_CS_MEM:
3265 			/* TODO */
3266 			break;
3267 
3268 		default:
3269 			usb_audio_dbg(mixer->chip,
3270 				"unknown attribute %d in interrupt\n",
3271 				attribute);
3272 			break;
3273 		} /* switch */
3274 	}
3275 }
3276 
3277 static void snd_usb_mixer_interrupt(struct urb *urb)
3278 {
3279 	struct usb_mixer_interface *mixer = urb->context;
3280 	int len = urb->actual_length;
3281 	int ustatus = urb->status;
3282 
3283 	if (ustatus != 0)
3284 		goto requeue;
3285 
3286 	if (mixer->protocol == UAC_VERSION_1) {
3287 		struct uac1_status_word *status;
3288 
3289 		for (status = urb->transfer_buffer;
3290 		     len >= sizeof(*status);
3291 		     len -= sizeof(*status), status++) {
3292 			dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3293 						status->bStatusType,
3294 						status->bOriginator);
3295 
3296 			/* ignore any notifications not from the control interface */
3297 			if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
3298 				UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3299 				continue;
3300 
3301 			if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
3302 				snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3303 			else
3304 				snd_usb_mixer_notify_id(mixer, status->bOriginator);
3305 		}
3306 	} else { /* UAC_VERSION_2 */
3307 		struct uac2_interrupt_data_msg *msg;
3308 
3309 		for (msg = urb->transfer_buffer;
3310 		     len >= sizeof(*msg);
3311 		     len -= sizeof(*msg), msg++) {
3312 			/* drop vendor specific and endpoint requests */
3313 			if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
3314 			    (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
3315 				continue;
3316 
3317 			snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
3318 						   le16_to_cpu(msg->wValue),
3319 						   le16_to_cpu(msg->wIndex));
3320 		}
3321 	}
3322 
3323 requeue:
3324 	if (ustatus != -ENOENT &&
3325 	    ustatus != -ECONNRESET &&
3326 	    ustatus != -ESHUTDOWN) {
3327 		urb->dev = mixer->chip->dev;
3328 		usb_submit_urb(urb, GFP_ATOMIC);
3329 	}
3330 }
3331 
3332 /* create the handler for the optional status interrupt endpoint */
3333 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
3334 {
3335 	struct usb_endpoint_descriptor *ep;
3336 	void *transfer_buffer;
3337 	int buffer_length;
3338 	unsigned int epnum;
3339 
3340 	/* we need one interrupt input endpoint */
3341 	if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3342 		return 0;
3343 	ep = get_endpoint(mixer->hostif, 0);
3344 	if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3345 		return 0;
3346 
3347 	epnum = usb_endpoint_num(ep);
3348 	buffer_length = le16_to_cpu(ep->wMaxPacketSize);
3349 	transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
3350 	if (!transfer_buffer)
3351 		return -ENOMEM;
3352 	mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
3353 	if (!mixer->urb) {
3354 		kfree(transfer_buffer);
3355 		return -ENOMEM;
3356 	}
3357 	usb_fill_int_urb(mixer->urb, mixer->chip->dev,
3358 			 usb_rcvintpipe(mixer->chip->dev, epnum),
3359 			 transfer_buffer, buffer_length,
3360 			 snd_usb_mixer_interrupt, mixer, ep->bInterval);
3361 	usb_submit_urb(mixer->urb, GFP_KERNEL);
3362 	return 0;
3363 }
3364 
3365 static int keep_iface_ctl_get(struct snd_kcontrol *kcontrol,
3366 			      struct snd_ctl_elem_value *ucontrol)
3367 {
3368 	struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3369 
3370 	ucontrol->value.integer.value[0] = mixer->chip->keep_iface;
3371 	return 0;
3372 }
3373 
3374 static int keep_iface_ctl_put(struct snd_kcontrol *kcontrol,
3375 			      struct snd_ctl_elem_value *ucontrol)
3376 {
3377 	struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3378 	bool keep_iface = !!ucontrol->value.integer.value[0];
3379 
3380 	if (mixer->chip->keep_iface == keep_iface)
3381 		return 0;
3382 	mixer->chip->keep_iface = keep_iface;
3383 	return 1;
3384 }
3385 
3386 static const struct snd_kcontrol_new keep_iface_ctl = {
3387 	.iface = SNDRV_CTL_ELEM_IFACE_CARD,
3388 	.name = "Keep Interface",
3389 	.info = snd_ctl_boolean_mono_info,
3390 	.get = keep_iface_ctl_get,
3391 	.put = keep_iface_ctl_put,
3392 };
3393 
3394 static int create_keep_iface_ctl(struct usb_mixer_interface *mixer)
3395 {
3396 	struct snd_kcontrol *kctl = snd_ctl_new1(&keep_iface_ctl, mixer);
3397 
3398 	/* need only one control per card */
3399 	if (snd_ctl_find_id(mixer->chip->card, &kctl->id)) {
3400 		snd_ctl_free_one(kctl);
3401 		return 0;
3402 	}
3403 
3404 	return snd_ctl_add(mixer->chip->card, kctl);
3405 }
3406 
3407 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
3408 			 int ignore_error)
3409 {
3410 	static const struct snd_device_ops dev_ops = {
3411 		.dev_free = snd_usb_mixer_dev_free
3412 	};
3413 	struct usb_mixer_interface *mixer;
3414 	int err;
3415 
3416 	strcpy(chip->card->mixername, "USB Mixer");
3417 
3418 	mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3419 	if (!mixer)
3420 		return -ENOMEM;
3421 	mixer->chip = chip;
3422 	mixer->ignore_ctl_error = ignore_error;
3423 	mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
3424 				  GFP_KERNEL);
3425 	if (!mixer->id_elems) {
3426 		kfree(mixer);
3427 		return -ENOMEM;
3428 	}
3429 
3430 	mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
3431 	switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3432 	case UAC_VERSION_1:
3433 	default:
3434 		mixer->protocol = UAC_VERSION_1;
3435 		break;
3436 	case UAC_VERSION_2:
3437 		mixer->protocol = UAC_VERSION_2;
3438 		break;
3439 	case UAC_VERSION_3:
3440 		mixer->protocol = UAC_VERSION_3;
3441 		break;
3442 	}
3443 
3444 	if (mixer->protocol == UAC_VERSION_3 &&
3445 			chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3446 		err = snd_usb_mixer_controls_badd(mixer, ctrlif);
3447 		if (err < 0)
3448 			goto _error;
3449 	} else {
3450 		err = snd_usb_mixer_controls(mixer);
3451 		if (err < 0)
3452 			goto _error;
3453 	}
3454 
3455 	err = snd_usb_mixer_status_create(mixer);
3456 	if (err < 0)
3457 		goto _error;
3458 
3459 	err = create_keep_iface_ctl(mixer);
3460 	if (err < 0)
3461 		goto _error;
3462 
3463 	err = snd_usb_mixer_apply_create_quirk(mixer);
3464 	if (err < 0)
3465 		goto _error;
3466 
3467 	err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3468 	if (err < 0)
3469 		goto _error;
3470 
3471 	if (list_empty(&chip->mixer_list))
3472 		snd_card_ro_proc_new(chip->card, "usbmixer", chip,
3473 				     snd_usb_mixer_proc_read);
3474 
3475 	list_add(&mixer->list, &chip->mixer_list);
3476 	return 0;
3477 
3478 _error:
3479 	snd_usb_mixer_free(mixer);
3480 	return err;
3481 }
3482 
3483 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3484 {
3485 	if (mixer->disconnected)
3486 		return;
3487 	if (mixer->urb)
3488 		usb_kill_urb(mixer->urb);
3489 	if (mixer->rc_urb)
3490 		usb_kill_urb(mixer->rc_urb);
3491 	if (mixer->private_free)
3492 		mixer->private_free(mixer);
3493 	mixer->disconnected = true;
3494 }
3495 
3496 #ifdef CONFIG_PM
3497 /* stop any bus activity of a mixer */
3498 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
3499 {
3500 	usb_kill_urb(mixer->urb);
3501 	usb_kill_urb(mixer->rc_urb);
3502 }
3503 
3504 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
3505 {
3506 	int err;
3507 
3508 	if (mixer->urb) {
3509 		err = usb_submit_urb(mixer->urb, GFP_NOIO);
3510 		if (err < 0)
3511 			return err;
3512 	}
3513 
3514 	return 0;
3515 }
3516 
3517 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
3518 {
3519 	snd_usb_mixer_inactivate(mixer);
3520 	if (mixer->private_suspend)
3521 		mixer->private_suspend(mixer);
3522 	return 0;
3523 }
3524 
3525 static int restore_mixer_value(struct usb_mixer_elem_list *list)
3526 {
3527 	struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3528 	int c, err, idx;
3529 
3530 	if (cval->cmask) {
3531 		idx = 0;
3532 		for (c = 0; c < MAX_CHANNELS; c++) {
3533 			if (!(cval->cmask & (1 << c)))
3534 				continue;
3535 			if (cval->cached & (1 << (c + 1))) {
3536 				err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3537 							cval->cache_val[idx]);
3538 				if (err < 0)
3539 					return err;
3540 			}
3541 			idx++;
3542 		}
3543 	} else {
3544 		/* master */
3545 		if (cval->cached) {
3546 			err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3547 			if (err < 0)
3548 				return err;
3549 		}
3550 	}
3551 
3552 	return 0;
3553 }
3554 
3555 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
3556 {
3557 	struct usb_mixer_elem_list *list;
3558 	int id, err;
3559 
3560 	if (reset_resume) {
3561 		/* restore cached mixer values */
3562 		for (id = 0; id < MAX_ID_ELEMS; id++) {
3563 			for_each_mixer_elem(list, mixer, id) {
3564 				if (list->resume) {
3565 					err = list->resume(list);
3566 					if (err < 0)
3567 						return err;
3568 				}
3569 			}
3570 		}
3571 	}
3572 
3573 	snd_usb_mixer_resume_quirk(mixer);
3574 
3575 	return snd_usb_mixer_activate(mixer);
3576 }
3577 #endif
3578 
3579 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
3580 				 struct usb_mixer_interface *mixer,
3581 				 int unitid)
3582 {
3583 	list->mixer = mixer;
3584 	list->id = unitid;
3585 	list->dump = snd_usb_mixer_dump_cval;
3586 #ifdef CONFIG_PM
3587 	list->resume = restore_mixer_value;
3588 #endif
3589 }
3590