xref: /openbmc/linux/sound/usb/mixer.c (revision b5f184fbdb03b4fcc1141de34dd5ec964ca5d99e)
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 	int len;
119 
120 	if (!p || !p->name)
121 		return 0;
122 
123 	buflen--;
124 	len = strscpy(buf, p->name, buflen);
125 	return len < 0 ? buflen : len;
126 }
127 
128 /* ignore the error value if ignore_ctl_error flag is set */
129 #define filter_error(cval, err) \
130 	((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
131 
132 /* check whether the control should be ignored */
133 static inline int
134 check_ignored_ctl(const struct usbmix_name_map *p)
135 {
136 	if (!p || p->name || p->dB)
137 		return 0;
138 	return 1;
139 }
140 
141 /* dB mapping */
142 static inline void check_mapped_dB(const struct usbmix_name_map *p,
143 				   struct usb_mixer_elem_info *cval)
144 {
145 	if (p && p->dB) {
146 		cval->dBmin = p->dB->min;
147 		cval->dBmax = p->dB->max;
148 		cval->initialized = 1;
149 	}
150 }
151 
152 /* get the mapped selector source name */
153 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
154 				      int index, char *buf, int buflen)
155 {
156 	const struct usbmix_selector_map *p;
157 	int len;
158 
159 	if (!state->selector_map)
160 		return 0;
161 	for (p = state->selector_map; p->id; p++) {
162 		if (p->id == unitid && index < p->count) {
163 			len = strscpy(buf, p->names[index], buflen);
164 			return len < 0 ? buflen : len;
165 		}
166 	}
167 	return 0;
168 }
169 
170 /*
171  * find an audio control unit with the given unit id
172  */
173 static void *find_audio_control_unit(struct mixer_build *state,
174 				     unsigned char unit)
175 {
176 	/* we just parse the header */
177 	struct uac_feature_unit_descriptor *hdr = NULL;
178 
179 	while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
180 					USB_DT_CS_INTERFACE)) != NULL) {
181 		if (hdr->bLength >= 4 &&
182 		    hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
183 		    hdr->bDescriptorSubtype <= UAC3_SAMPLE_RATE_CONVERTER &&
184 		    hdr->bUnitID == unit)
185 			return hdr;
186 	}
187 
188 	return NULL;
189 }
190 
191 /*
192  * copy a string with the given id
193  */
194 static int snd_usb_copy_string_desc(struct snd_usb_audio *chip,
195 				    int index, char *buf, int maxlen)
196 {
197 	int len = usb_string(chip->dev, index, buf, maxlen - 1);
198 
199 	if (len < 0)
200 		return 0;
201 
202 	buf[len] = 0;
203 	return len;
204 }
205 
206 /*
207  * convert from the byte/word on usb descriptor to the zero-based integer
208  */
209 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
210 {
211 	switch (cval->val_type) {
212 	case USB_MIXER_BOOLEAN:
213 		return !!val;
214 	case USB_MIXER_INV_BOOLEAN:
215 		return !val;
216 	case USB_MIXER_U8:
217 		val &= 0xff;
218 		break;
219 	case USB_MIXER_S8:
220 		val &= 0xff;
221 		if (val >= 0x80)
222 			val -= 0x100;
223 		break;
224 	case USB_MIXER_U16:
225 		val &= 0xffff;
226 		break;
227 	case USB_MIXER_S16:
228 		val &= 0xffff;
229 		if (val >= 0x8000)
230 			val -= 0x10000;
231 		break;
232 	}
233 	return val;
234 }
235 
236 /*
237  * convert from the zero-based int to the byte/word for usb descriptor
238  */
239 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
240 {
241 	switch (cval->val_type) {
242 	case USB_MIXER_BOOLEAN:
243 		return !!val;
244 	case USB_MIXER_INV_BOOLEAN:
245 		return !val;
246 	case USB_MIXER_S8:
247 	case USB_MIXER_U8:
248 		return val & 0xff;
249 	case USB_MIXER_S16:
250 	case USB_MIXER_U16:
251 		return val & 0xffff;
252 	}
253 	return 0; /* not reached */
254 }
255 
256 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
257 {
258 	if (!cval->res)
259 		cval->res = 1;
260 	if (val < cval->min)
261 		return 0;
262 	else if (val >= cval->max)
263 		return DIV_ROUND_UP(cval->max - cval->min, cval->res);
264 	else
265 		return (val - cval->min) / cval->res;
266 }
267 
268 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
269 {
270 	if (val < 0)
271 		return cval->min;
272 	if (!cval->res)
273 		cval->res = 1;
274 	val *= cval->res;
275 	val += cval->min;
276 	if (val > cval->max)
277 		return cval->max;
278 	return val;
279 }
280 
281 static int uac2_ctl_value_size(int val_type)
282 {
283 	switch (val_type) {
284 	case USB_MIXER_S32:
285 	case USB_MIXER_U32:
286 		return 4;
287 	case USB_MIXER_S16:
288 	case USB_MIXER_U16:
289 		return 2;
290 	default:
291 		return 1;
292 	}
293 	return 0; /* unreachable */
294 }
295 
296 
297 /*
298  * retrieve a mixer value
299  */
300 
301 static inline int mixer_ctrl_intf(struct usb_mixer_interface *mixer)
302 {
303 	return get_iface_desc(mixer->hostif)->bInterfaceNumber;
304 }
305 
306 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
307 			    int validx, int *value_ret)
308 {
309 	struct snd_usb_audio *chip = cval->head.mixer->chip;
310 	unsigned char buf[2];
311 	int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
312 	int timeout = 10;
313 	int idx = 0, err;
314 
315 	err = snd_usb_lock_shutdown(chip);
316 	if (err < 0)
317 		return -EIO;
318 
319 	while (timeout-- > 0) {
320 		idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
321 		err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
322 				      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
323 				      validx, idx, buf, val_len);
324 		if (err >= val_len) {
325 			*value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
326 			err = 0;
327 			goto out;
328 		} else if (err == -ETIMEDOUT) {
329 			goto out;
330 		}
331 	}
332 	usb_audio_dbg(chip,
333 		"cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
334 		request, validx, idx, cval->val_type);
335 	err = -EINVAL;
336 
337  out:
338 	snd_usb_unlock_shutdown(chip);
339 	return err;
340 }
341 
342 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
343 			    int validx, int *value_ret)
344 {
345 	struct snd_usb_audio *chip = cval->head.mixer->chip;
346 	/* enough space for one range */
347 	unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
348 	unsigned char *val;
349 	int idx = 0, ret, val_size, size;
350 	__u8 bRequest;
351 
352 	val_size = uac2_ctl_value_size(cval->val_type);
353 
354 	if (request == UAC_GET_CUR) {
355 		bRequest = UAC2_CS_CUR;
356 		size = val_size;
357 	} else {
358 		bRequest = UAC2_CS_RANGE;
359 		size = sizeof(__u16) + 3 * val_size;
360 	}
361 
362 	memset(buf, 0, sizeof(buf));
363 
364 	ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
365 	if (ret)
366 		goto error;
367 
368 	idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
369 	ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
370 			      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
371 			      validx, idx, buf, size);
372 	snd_usb_unlock_shutdown(chip);
373 
374 	if (ret < 0) {
375 error:
376 		usb_audio_err(chip,
377 			"cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
378 			request, validx, idx, cval->val_type);
379 		return ret;
380 	}
381 
382 	/* FIXME: how should we handle multiple triplets here? */
383 
384 	switch (request) {
385 	case UAC_GET_CUR:
386 		val = buf;
387 		break;
388 	case UAC_GET_MIN:
389 		val = buf + sizeof(__u16);
390 		break;
391 	case UAC_GET_MAX:
392 		val = buf + sizeof(__u16) + val_size;
393 		break;
394 	case UAC_GET_RES:
395 		val = buf + sizeof(__u16) + val_size * 2;
396 		break;
397 	default:
398 		return -EINVAL;
399 	}
400 
401 	*value_ret = convert_signed_value(cval,
402 					  snd_usb_combine_bytes(val, val_size));
403 
404 	return 0;
405 }
406 
407 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
408 			 int validx, int *value_ret)
409 {
410 	validx += cval->idx_off;
411 
412 	return (cval->head.mixer->protocol == UAC_VERSION_1) ?
413 		get_ctl_value_v1(cval, request, validx, value_ret) :
414 		get_ctl_value_v2(cval, request, validx, value_ret);
415 }
416 
417 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
418 			     int validx, int *value)
419 {
420 	return get_ctl_value(cval, UAC_GET_CUR, validx, value);
421 }
422 
423 /* channel = 0: master, 1 = first channel */
424 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
425 				  int channel, int *value)
426 {
427 	return get_ctl_value(cval, UAC_GET_CUR,
428 			     (cval->control << 8) | channel,
429 			     value);
430 }
431 
432 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
433 			     int channel, int index, int *value)
434 {
435 	int err;
436 
437 	if (cval->cached & (1 << channel)) {
438 		*value = cval->cache_val[index];
439 		return 0;
440 	}
441 	err = get_cur_mix_raw(cval, channel, value);
442 	if (err < 0) {
443 		if (!cval->head.mixer->ignore_ctl_error)
444 			usb_audio_dbg(cval->head.mixer->chip,
445 				"cannot get current value for control %d ch %d: err = %d\n",
446 				      cval->control, channel, err);
447 		return err;
448 	}
449 	cval->cached |= 1 << channel;
450 	cval->cache_val[index] = *value;
451 	return 0;
452 }
453 
454 /*
455  * set a mixer value
456  */
457 
458 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
459 				int request, int validx, int value_set)
460 {
461 	struct snd_usb_audio *chip = cval->head.mixer->chip;
462 	unsigned char buf[4];
463 	int idx = 0, val_len, err, timeout = 10;
464 
465 	validx += cval->idx_off;
466 
467 
468 	if (cval->head.mixer->protocol == UAC_VERSION_1) {
469 		val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
470 	} else { /* UAC_VERSION_2/3 */
471 		val_len = uac2_ctl_value_size(cval->val_type);
472 
473 		/* FIXME */
474 		if (request != UAC_SET_CUR) {
475 			usb_audio_dbg(chip, "RANGE setting not yet supported\n");
476 			return -EINVAL;
477 		}
478 
479 		request = UAC2_CS_CUR;
480 	}
481 
482 	value_set = convert_bytes_value(cval, value_set);
483 	buf[0] = value_set & 0xff;
484 	buf[1] = (value_set >> 8) & 0xff;
485 	buf[2] = (value_set >> 16) & 0xff;
486 	buf[3] = (value_set >> 24) & 0xff;
487 
488 	err = snd_usb_lock_shutdown(chip);
489 	if (err < 0)
490 		return -EIO;
491 
492 	while (timeout-- > 0) {
493 		idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
494 		err = snd_usb_ctl_msg(chip->dev,
495 				      usb_sndctrlpipe(chip->dev, 0), request,
496 				      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
497 				      validx, idx, buf, val_len);
498 		if (err >= 0) {
499 			err = 0;
500 			goto out;
501 		} else if (err == -ETIMEDOUT) {
502 			goto out;
503 		}
504 	}
505 	usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
506 		      request, validx, idx, cval->val_type, buf[0], buf[1]);
507 	err = -EINVAL;
508 
509  out:
510 	snd_usb_unlock_shutdown(chip);
511 	return err;
512 }
513 
514 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
515 			     int validx, int value)
516 {
517 	return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
518 }
519 
520 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
521 			     int index, int value)
522 {
523 	int err;
524 	unsigned int read_only = (channel == 0) ?
525 		cval->master_readonly :
526 		cval->ch_readonly & (1 << (channel - 1));
527 
528 	if (read_only) {
529 		usb_audio_dbg(cval->head.mixer->chip,
530 			      "%s(): channel %d of control %d is read_only\n",
531 			    __func__, channel, cval->control);
532 		return 0;
533 	}
534 
535 	err = snd_usb_mixer_set_ctl_value(cval,
536 					  UAC_SET_CUR, (cval->control << 8) | channel,
537 					  value);
538 	if (err < 0)
539 		return err;
540 	cval->cached |= 1 << channel;
541 	cval->cache_val[index] = value;
542 	return 0;
543 }
544 
545 /*
546  * TLV callback for mixer volume controls
547  */
548 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
549 			 unsigned int size, unsigned int __user *_tlv)
550 {
551 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
552 	DECLARE_TLV_DB_MINMAX(scale, 0, 0);
553 
554 	if (size < sizeof(scale))
555 		return -ENOMEM;
556 	if (cval->min_mute)
557 		scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE;
558 	scale[2] = cval->dBmin;
559 	scale[3] = cval->dBmax;
560 	if (copy_to_user(_tlv, scale, sizeof(scale)))
561 		return -EFAULT;
562 	return 0;
563 }
564 
565 /*
566  * parser routines begin here...
567  */
568 
569 static int parse_audio_unit(struct mixer_build *state, int unitid);
570 
571 
572 /*
573  * check if the input/output channel routing is enabled on the given bitmap.
574  * used for mixer unit parser
575  */
576 static int check_matrix_bitmap(unsigned char *bmap,
577 			       int ich, int och, int num_outs)
578 {
579 	int idx = ich * num_outs + och;
580 	return bmap[idx >> 3] & (0x80 >> (idx & 7));
581 }
582 
583 /*
584  * add an alsa control element
585  * search and increment the index until an empty slot is found.
586  *
587  * if failed, give up and free the control instance.
588  */
589 
590 int snd_usb_mixer_add_list(struct usb_mixer_elem_list *list,
591 			   struct snd_kcontrol *kctl,
592 			   bool is_std_info)
593 {
594 	struct usb_mixer_interface *mixer = list->mixer;
595 	int err;
596 
597 	while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
598 		kctl->id.index++;
599 	err = snd_ctl_add(mixer->chip->card, kctl);
600 	if (err < 0) {
601 		usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
602 			      err);
603 		return err;
604 	}
605 	list->kctl = kctl;
606 	list->is_std_info = is_std_info;
607 	list->next_id_elem = mixer->id_elems[list->id];
608 	mixer->id_elems[list->id] = list;
609 	return 0;
610 }
611 
612 /*
613  * get a terminal name string
614  */
615 
616 static struct iterm_name_combo {
617 	int type;
618 	char *name;
619 } iterm_names[] = {
620 	{ 0x0300, "Output" },
621 	{ 0x0301, "Speaker" },
622 	{ 0x0302, "Headphone" },
623 	{ 0x0303, "HMD Audio" },
624 	{ 0x0304, "Desktop Speaker" },
625 	{ 0x0305, "Room Speaker" },
626 	{ 0x0306, "Com Speaker" },
627 	{ 0x0307, "LFE" },
628 	{ 0x0600, "External In" },
629 	{ 0x0601, "Analog In" },
630 	{ 0x0602, "Digital In" },
631 	{ 0x0603, "Line" },
632 	{ 0x0604, "Legacy In" },
633 	{ 0x0605, "IEC958 In" },
634 	{ 0x0606, "1394 DA Stream" },
635 	{ 0x0607, "1394 DV Stream" },
636 	{ 0x0700, "Embedded" },
637 	{ 0x0701, "Noise Source" },
638 	{ 0x0702, "Equalization Noise" },
639 	{ 0x0703, "CD" },
640 	{ 0x0704, "DAT" },
641 	{ 0x0705, "DCC" },
642 	{ 0x0706, "MiniDisk" },
643 	{ 0x0707, "Analog Tape" },
644 	{ 0x0708, "Phonograph" },
645 	{ 0x0709, "VCR Audio" },
646 	{ 0x070a, "Video Disk Audio" },
647 	{ 0x070b, "DVD Audio" },
648 	{ 0x070c, "TV Tuner Audio" },
649 	{ 0x070d, "Satellite Rec Audio" },
650 	{ 0x070e, "Cable Tuner Audio" },
651 	{ 0x070f, "DSS Audio" },
652 	{ 0x0710, "Radio Receiver" },
653 	{ 0x0711, "Radio Transmitter" },
654 	{ 0x0712, "Multi-Track Recorder" },
655 	{ 0x0713, "Synthesizer" },
656 	{ 0 },
657 };
658 
659 static int get_term_name(struct snd_usb_audio *chip, struct usb_audio_term *iterm,
660 			 unsigned char *name, int maxlen, int term_only)
661 {
662 	struct iterm_name_combo *names;
663 	int len;
664 
665 	if (iterm->name) {
666 		len = snd_usb_copy_string_desc(chip, iterm->name,
667 						name, maxlen);
668 		if (len)
669 			return len;
670 	}
671 
672 	/* virtual type - not a real terminal */
673 	if (iterm->type >> 16) {
674 		if (term_only)
675 			return 0;
676 		switch (iterm->type >> 16) {
677 		case UAC3_SELECTOR_UNIT:
678 			strcpy(name, "Selector");
679 			return 8;
680 		case UAC3_PROCESSING_UNIT:
681 			strcpy(name, "Process Unit");
682 			return 12;
683 		case UAC3_EXTENSION_UNIT:
684 			strcpy(name, "Ext Unit");
685 			return 8;
686 		case UAC3_MIXER_UNIT:
687 			strcpy(name, "Mixer");
688 			return 5;
689 		default:
690 			return sprintf(name, "Unit %d", iterm->id);
691 		}
692 	}
693 
694 	switch (iterm->type & 0xff00) {
695 	case 0x0100:
696 		strcpy(name, "PCM");
697 		return 3;
698 	case 0x0200:
699 		strcpy(name, "Mic");
700 		return 3;
701 	case 0x0400:
702 		strcpy(name, "Headset");
703 		return 7;
704 	case 0x0500:
705 		strcpy(name, "Phone");
706 		return 5;
707 	}
708 
709 	for (names = iterm_names; names->type; names++) {
710 		if (names->type == iterm->type) {
711 			strcpy(name, names->name);
712 			return strlen(names->name);
713 		}
714 	}
715 
716 	return 0;
717 }
718 
719 /*
720  * Get logical cluster information for UAC3 devices.
721  */
722 static int get_cluster_channels_v3(struct mixer_build *state, unsigned int cluster_id)
723 {
724 	struct uac3_cluster_header_descriptor c_header;
725 	int err;
726 
727 	err = snd_usb_ctl_msg(state->chip->dev,
728 			usb_rcvctrlpipe(state->chip->dev, 0),
729 			UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
730 			USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
731 			cluster_id,
732 			snd_usb_ctrl_intf(state->chip),
733 			&c_header, sizeof(c_header));
734 	if (err < 0)
735 		goto error;
736 	if (err != sizeof(c_header)) {
737 		err = -EIO;
738 		goto error;
739 	}
740 
741 	return c_header.bNrChannels;
742 
743 error:
744 	usb_audio_err(state->chip, "cannot request logical cluster ID: %d (err: %d)\n", cluster_id, err);
745 	return err;
746 }
747 
748 /*
749  * Get number of channels for a Mixer Unit.
750  */
751 static int uac_mixer_unit_get_channels(struct mixer_build *state,
752 				       struct uac_mixer_unit_descriptor *desc)
753 {
754 	int mu_channels;
755 
756 	switch (state->mixer->protocol) {
757 	case UAC_VERSION_1:
758 	case UAC_VERSION_2:
759 	default:
760 		if (desc->bLength < sizeof(*desc) + desc->bNrInPins + 1)
761 			return 0; /* no bmControls -> skip */
762 		mu_channels = uac_mixer_unit_bNrChannels(desc);
763 		break;
764 	case UAC_VERSION_3:
765 		mu_channels = get_cluster_channels_v3(state,
766 				uac3_mixer_unit_wClusterDescrID(desc));
767 		break;
768 	}
769 
770 	return mu_channels;
771 }
772 
773 /*
774  * Parse Input Terminal Unit
775  */
776 static int __check_input_term(struct mixer_build *state, int id,
777 			      struct usb_audio_term *term);
778 
779 static int parse_term_uac1_iterm_unit(struct mixer_build *state,
780 				      struct usb_audio_term *term,
781 				      void *p1, int id)
782 {
783 	struct uac_input_terminal_descriptor *d = p1;
784 
785 	term->type = le16_to_cpu(d->wTerminalType);
786 	term->channels = d->bNrChannels;
787 	term->chconfig = le16_to_cpu(d->wChannelConfig);
788 	term->name = d->iTerminal;
789 	return 0;
790 }
791 
792 static int parse_term_uac2_iterm_unit(struct mixer_build *state,
793 				      struct usb_audio_term *term,
794 				      void *p1, int id)
795 {
796 	struct uac2_input_terminal_descriptor *d = p1;
797 	int err;
798 
799 	/* call recursively to verify the referenced clock entity */
800 	err = __check_input_term(state, d->bCSourceID, term);
801 	if (err < 0)
802 		return err;
803 
804 	/* save input term properties after recursion,
805 	 * to ensure they are not overriden by the recursion calls
806 	 */
807 	term->id = id;
808 	term->type = le16_to_cpu(d->wTerminalType);
809 	term->channels = d->bNrChannels;
810 	term->chconfig = le32_to_cpu(d->bmChannelConfig);
811 	term->name = d->iTerminal;
812 	return 0;
813 }
814 
815 static int parse_term_uac3_iterm_unit(struct mixer_build *state,
816 				      struct usb_audio_term *term,
817 				      void *p1, int id)
818 {
819 	struct uac3_input_terminal_descriptor *d = p1;
820 	int err;
821 
822 	/* call recursively to verify the referenced clock entity */
823 	err = __check_input_term(state, d->bCSourceID, term);
824 	if (err < 0)
825 		return err;
826 
827 	/* save input term properties after recursion,
828 	 * to ensure they are not overriden by the recursion calls
829 	 */
830 	term->id = id;
831 	term->type = le16_to_cpu(d->wTerminalType);
832 
833 	err = get_cluster_channels_v3(state, le16_to_cpu(d->wClusterDescrID));
834 	if (err < 0)
835 		return err;
836 	term->channels = err;
837 
838 	/* REVISIT: UAC3 IT doesn't have channels cfg */
839 	term->chconfig = 0;
840 
841 	term->name = le16_to_cpu(d->wTerminalDescrStr);
842 	return 0;
843 }
844 
845 static int parse_term_mixer_unit(struct mixer_build *state,
846 				 struct usb_audio_term *term,
847 				 void *p1, int id)
848 {
849 	struct uac_mixer_unit_descriptor *d = p1;
850 	int protocol = state->mixer->protocol;
851 	int err;
852 
853 	err = uac_mixer_unit_get_channels(state, d);
854 	if (err <= 0)
855 		return err;
856 
857 	term->type = UAC3_MIXER_UNIT << 16; /* virtual type */
858 	term->channels = err;
859 	if (protocol != UAC_VERSION_3) {
860 		term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
861 		term->name = uac_mixer_unit_iMixer(d);
862 	}
863 	return 0;
864 }
865 
866 static int parse_term_selector_unit(struct mixer_build *state,
867 				    struct usb_audio_term *term,
868 				    void *p1, int id)
869 {
870 	struct uac_selector_unit_descriptor *d = p1;
871 	int err;
872 
873 	/* call recursively to retrieve the channel info */
874 	err = __check_input_term(state, d->baSourceID[0], term);
875 	if (err < 0)
876 		return err;
877 	term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */
878 	term->id = id;
879 	if (state->mixer->protocol != UAC_VERSION_3)
880 		term->name = uac_selector_unit_iSelector(d);
881 	return 0;
882 }
883 
884 static int parse_term_proc_unit(struct mixer_build *state,
885 				struct usb_audio_term *term,
886 				void *p1, int id, int vtype)
887 {
888 	struct uac_processing_unit_descriptor *d = p1;
889 	int protocol = state->mixer->protocol;
890 	int err;
891 
892 	if (d->bNrInPins) {
893 		/* call recursively to retrieve the channel info */
894 		err = __check_input_term(state, d->baSourceID[0], term);
895 		if (err < 0)
896 			return err;
897 	}
898 
899 	term->type = vtype << 16; /* virtual type */
900 	term->id = id;
901 
902 	if (protocol == UAC_VERSION_3)
903 		return 0;
904 
905 	if (!term->channels) {
906 		term->channels = uac_processing_unit_bNrChannels(d);
907 		term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
908 	}
909 	term->name = uac_processing_unit_iProcessing(d, protocol);
910 	return 0;
911 }
912 
913 static int parse_term_effect_unit(struct mixer_build *state,
914 				  struct usb_audio_term *term,
915 				  void *p1, int id)
916 {
917 	struct uac2_effect_unit_descriptor *d = p1;
918 	int err;
919 
920 	err = __check_input_term(state, d->bSourceID, term);
921 	if (err < 0)
922 		return err;
923 	term->type = UAC3_EFFECT_UNIT << 16; /* virtual type */
924 	term->id = id;
925 	return 0;
926 }
927 
928 static int parse_term_uac2_clock_source(struct mixer_build *state,
929 					struct usb_audio_term *term,
930 					void *p1, int id)
931 {
932 	struct uac_clock_source_descriptor *d = p1;
933 
934 	term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
935 	term->id = id;
936 	term->name = d->iClockSource;
937 	return 0;
938 }
939 
940 static int parse_term_uac3_clock_source(struct mixer_build *state,
941 					struct usb_audio_term *term,
942 					void *p1, int id)
943 {
944 	struct uac3_clock_source_descriptor *d = p1;
945 
946 	term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
947 	term->id = id;
948 	term->name = le16_to_cpu(d->wClockSourceStr);
949 	return 0;
950 }
951 
952 #define PTYPE(a, b)	((a) << 8 | (b))
953 
954 /*
955  * parse the source unit recursively until it reaches to a terminal
956  * or a branched unit.
957  */
958 static int __check_input_term(struct mixer_build *state, int id,
959 			      struct usb_audio_term *term)
960 {
961 	int protocol = state->mixer->protocol;
962 	void *p1;
963 	unsigned char *hdr;
964 
965 	for (;;) {
966 		/* a loop in the terminal chain? */
967 		if (test_and_set_bit(id, state->termbitmap))
968 			return -EINVAL;
969 
970 		p1 = find_audio_control_unit(state, id);
971 		if (!p1)
972 			break;
973 		if (!snd_usb_validate_audio_desc(p1, protocol))
974 			break; /* bad descriptor */
975 
976 		hdr = p1;
977 		term->id = id;
978 
979 		switch (PTYPE(protocol, hdr[2])) {
980 		case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
981 		case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
982 		case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT): {
983 			/* the header is the same for all versions */
984 			struct uac_feature_unit_descriptor *d = p1;
985 
986 			id = d->bSourceID;
987 			break; /* continue to parse */
988 		}
989 		case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
990 			return parse_term_uac1_iterm_unit(state, term, p1, id);
991 		case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
992 			return parse_term_uac2_iterm_unit(state, term, p1, id);
993 		case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
994 			return parse_term_uac3_iterm_unit(state, term, p1, id);
995 		case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
996 		case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
997 		case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
998 			return parse_term_mixer_unit(state, term, p1, id);
999 		case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
1000 		case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
1001 		case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
1002 		case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
1003 		case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
1004 			return parse_term_selector_unit(state, term, p1, id);
1005 		case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
1006 		case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
1007 		case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
1008 			return parse_term_proc_unit(state, term, p1, id,
1009 						    UAC3_PROCESSING_UNIT);
1010 		case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
1011 		case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
1012 			return parse_term_effect_unit(state, term, p1, id);
1013 		case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
1014 		case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
1015 		case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
1016 			return parse_term_proc_unit(state, term, p1, id,
1017 						    UAC3_EXTENSION_UNIT);
1018 		case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
1019 			return parse_term_uac2_clock_source(state, term, p1, id);
1020 		case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
1021 			return parse_term_uac3_clock_source(state, term, p1, id);
1022 		default:
1023 			return -ENODEV;
1024 		}
1025 	}
1026 	return -ENODEV;
1027 }
1028 
1029 
1030 static int check_input_term(struct mixer_build *state, int id,
1031 			    struct usb_audio_term *term)
1032 {
1033 	memset(term, 0, sizeof(*term));
1034 	memset(state->termbitmap, 0, sizeof(state->termbitmap));
1035 	return __check_input_term(state, id, term);
1036 }
1037 
1038 /*
1039  * Feature Unit
1040  */
1041 
1042 /* feature unit control information */
1043 struct usb_feature_control_info {
1044 	int control;
1045 	const char *name;
1046 	int type;	/* data type for uac1 */
1047 	int type_uac2;	/* data type for uac2 if different from uac1, else -1 */
1048 };
1049 
1050 static const struct usb_feature_control_info audio_feature_info[] = {
1051 	{ UAC_FU_MUTE,			"Mute",			USB_MIXER_INV_BOOLEAN, -1 },
1052 	{ UAC_FU_VOLUME,		"Volume",		USB_MIXER_S16, -1 },
1053 	{ UAC_FU_BASS,			"Tone Control - Bass",	USB_MIXER_S8, -1 },
1054 	{ UAC_FU_MID,			"Tone Control - Mid",	USB_MIXER_S8, -1 },
1055 	{ UAC_FU_TREBLE,		"Tone Control - Treble", USB_MIXER_S8, -1 },
1056 	{ UAC_FU_GRAPHIC_EQUALIZER,	"Graphic Equalizer",	USB_MIXER_S8, -1 }, /* FIXME: not implemented yet */
1057 	{ UAC_FU_AUTOMATIC_GAIN,	"Auto Gain Control",	USB_MIXER_BOOLEAN, -1 },
1058 	{ UAC_FU_DELAY,			"Delay Control",	USB_MIXER_U16, USB_MIXER_U32 },
1059 	{ UAC_FU_BASS_BOOST,		"Bass Boost",		USB_MIXER_BOOLEAN, -1 },
1060 	{ UAC_FU_LOUDNESS,		"Loudness",		USB_MIXER_BOOLEAN, -1 },
1061 	/* UAC2 specific */
1062 	{ UAC2_FU_INPUT_GAIN,		"Input Gain Control",	USB_MIXER_S16, -1 },
1063 	{ UAC2_FU_INPUT_GAIN_PAD,	"Input Gain Pad Control", USB_MIXER_S16, -1 },
1064 	{ UAC2_FU_PHASE_INVERTER,	 "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
1065 };
1066 
1067 static void usb_mixer_elem_info_free(struct usb_mixer_elem_info *cval)
1068 {
1069 	kfree(cval);
1070 }
1071 
1072 /* private_free callback */
1073 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
1074 {
1075 	usb_mixer_elem_info_free(kctl->private_data);
1076 	kctl->private_data = NULL;
1077 }
1078 
1079 /*
1080  * interface to ALSA control for feature/mixer units
1081  */
1082 
1083 /* volume control quirks */
1084 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
1085 				  struct snd_kcontrol *kctl)
1086 {
1087 	struct snd_usb_audio *chip = cval->head.mixer->chip;
1088 	switch (chip->usb_id) {
1089 	case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
1090 	case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
1091 		if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1092 			cval->min = 0x0000;
1093 			cval->max = 0xffff;
1094 			cval->res = 0x00e6;
1095 			break;
1096 		}
1097 		if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1098 		    strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1099 			cval->min = 0x00;
1100 			cval->max = 0xff;
1101 			break;
1102 		}
1103 		if (strstr(kctl->id.name, "Effect Return") != NULL) {
1104 			cval->min = 0xb706;
1105 			cval->max = 0xff7b;
1106 			cval->res = 0x0073;
1107 			break;
1108 		}
1109 		if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1110 			(strstr(kctl->id.name, "Effect Send") != NULL)) {
1111 			cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
1112 			cval->max = 0xfcfe;
1113 			cval->res = 0x0073;
1114 		}
1115 		break;
1116 
1117 	case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
1118 	case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
1119 		if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1120 			usb_audio_info(chip,
1121 				       "set quirk for FTU Effect Duration\n");
1122 			cval->min = 0x0000;
1123 			cval->max = 0x7f00;
1124 			cval->res = 0x0100;
1125 			break;
1126 		}
1127 		if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1128 		    strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1129 			usb_audio_info(chip,
1130 				       "set quirks for FTU Effect Feedback/Volume\n");
1131 			cval->min = 0x00;
1132 			cval->max = 0x7f;
1133 			break;
1134 		}
1135 		break;
1136 
1137 	case USB_ID(0x0d8c, 0x0103):
1138 		if (!strcmp(kctl->id.name, "PCM Playback Volume")) {
1139 			usb_audio_info(chip,
1140 				 "set volume quirk for CM102-A+/102S+\n");
1141 			cval->min = -256;
1142 		}
1143 		break;
1144 
1145 	case USB_ID(0x0471, 0x0101):
1146 	case USB_ID(0x0471, 0x0104):
1147 	case USB_ID(0x0471, 0x0105):
1148 	case USB_ID(0x0672, 0x1041):
1149 	/* quirk for UDA1321/N101.
1150 	 * note that detection between firmware 2.1.1.7 (N101)
1151 	 * and later 2.1.1.21 is not very clear from datasheets.
1152 	 * I hope that the min value is -15360 for newer firmware --jk
1153 	 */
1154 		if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
1155 		    cval->min == -15616) {
1156 			usb_audio_info(chip,
1157 				 "set volume quirk for UDA1321/N101 chip\n");
1158 			cval->max = -256;
1159 		}
1160 		break;
1161 
1162 	case USB_ID(0x046d, 0x09a4):
1163 		if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1164 			usb_audio_info(chip,
1165 				"set volume quirk for QuickCam E3500\n");
1166 			cval->min = 6080;
1167 			cval->max = 8768;
1168 			cval->res = 192;
1169 		}
1170 		break;
1171 
1172 	case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
1173 	case USB_ID(0x046d, 0x0808):
1174 	case USB_ID(0x046d, 0x0809):
1175 	case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1176 	case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1177 	case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1178 	case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1179 	case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1180 	case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1181 	case USB_ID(0x046d, 0x0991):
1182 	case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1183 	/* Most audio usb devices lie about volume resolution.
1184 	 * Most Logitech webcams have res = 384.
1185 	 * Probably there is some logitech magic behind this number --fishor
1186 	 */
1187 		if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1188 			usb_audio_info(chip,
1189 				"set resolution quirk: cval->res = 384\n");
1190 			cval->res = 384;
1191 		}
1192 		break;
1193 	case USB_ID(0x0495, 0x3042): /* ESS Technology Asus USB DAC */
1194 		if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1195 			strstr(kctl->id.name, "Capture Volume") != NULL) {
1196 			cval->min >>= 8;
1197 			cval->max = 0;
1198 			cval->res = 1;
1199 		}
1200 		break;
1201 	}
1202 }
1203 
1204 /*
1205  * retrieve the minimum and maximum values for the specified control
1206  */
1207 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1208 				   int default_min, struct snd_kcontrol *kctl)
1209 {
1210 	/* for failsafe */
1211 	cval->min = default_min;
1212 	cval->max = cval->min + 1;
1213 	cval->res = 1;
1214 	cval->dBmin = cval->dBmax = 0;
1215 
1216 	if (cval->val_type == USB_MIXER_BOOLEAN ||
1217 	    cval->val_type == USB_MIXER_INV_BOOLEAN) {
1218 		cval->initialized = 1;
1219 	} else {
1220 		int minchn = 0;
1221 		if (cval->cmask) {
1222 			int i;
1223 			for (i = 0; i < MAX_CHANNELS; i++)
1224 				if (cval->cmask & (1 << i)) {
1225 					minchn = i + 1;
1226 					break;
1227 				}
1228 		}
1229 		if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
1230 		    get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1231 			usb_audio_err(cval->head.mixer->chip,
1232 				      "%d:%d: cannot get min/max values for control %d (id %d)\n",
1233 				   cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1234 							       cval->control, cval->head.id);
1235 			return -EINVAL;
1236 		}
1237 		if (get_ctl_value(cval, UAC_GET_RES,
1238 				  (cval->control << 8) | minchn,
1239 				  &cval->res) < 0) {
1240 			cval->res = 1;
1241 		} else if (cval->head.mixer->protocol == UAC_VERSION_1) {
1242 			int last_valid_res = cval->res;
1243 
1244 			while (cval->res > 1) {
1245 				if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1246 								(cval->control << 8) | minchn,
1247 								cval->res / 2) < 0)
1248 					break;
1249 				cval->res /= 2;
1250 			}
1251 			if (get_ctl_value(cval, UAC_GET_RES,
1252 					  (cval->control << 8) | minchn, &cval->res) < 0)
1253 				cval->res = last_valid_res;
1254 		}
1255 		if (cval->res == 0)
1256 			cval->res = 1;
1257 
1258 		/* Additional checks for the proper resolution
1259 		 *
1260 		 * Some devices report smaller resolutions than actually
1261 		 * reacting.  They don't return errors but simply clip
1262 		 * to the lower aligned value.
1263 		 */
1264 		if (cval->min + cval->res < cval->max) {
1265 			int last_valid_res = cval->res;
1266 			int saved, test, check;
1267 			if (get_cur_mix_raw(cval, minchn, &saved) < 0)
1268 				goto no_res_check;
1269 			for (;;) {
1270 				test = saved;
1271 				if (test < cval->max)
1272 					test += cval->res;
1273 				else
1274 					test -= cval->res;
1275 				if (test < cval->min || test > cval->max ||
1276 				    snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1277 				    get_cur_mix_raw(cval, minchn, &check)) {
1278 					cval->res = last_valid_res;
1279 					break;
1280 				}
1281 				if (test == check)
1282 					break;
1283 				cval->res *= 2;
1284 			}
1285 			snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1286 		}
1287 
1288 no_res_check:
1289 		cval->initialized = 1;
1290 	}
1291 
1292 	if (kctl)
1293 		volume_control_quirks(cval, kctl);
1294 
1295 	/* USB descriptions contain the dB scale in 1/256 dB unit
1296 	 * while ALSA TLV contains in 1/100 dB unit
1297 	 */
1298 	cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1299 	cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1300 	if (cval->dBmin > cval->dBmax) {
1301 		/* something is wrong; assume it's either from/to 0dB */
1302 		if (cval->dBmin < 0)
1303 			cval->dBmax = 0;
1304 		else if (cval->dBmin > 0)
1305 			cval->dBmin = 0;
1306 		if (cval->dBmin > cval->dBmax) {
1307 			/* totally crap, return an error */
1308 			return -EINVAL;
1309 		}
1310 	}
1311 
1312 	return 0;
1313 }
1314 
1315 #define get_min_max(cval, def)	get_min_max_with_quirks(cval, def, NULL)
1316 
1317 /* get a feature/mixer unit info */
1318 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1319 				  struct snd_ctl_elem_info *uinfo)
1320 {
1321 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1322 
1323 	if (cval->val_type == USB_MIXER_BOOLEAN ||
1324 	    cval->val_type == USB_MIXER_INV_BOOLEAN)
1325 		uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1326 	else
1327 		uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1328 	uinfo->count = cval->channels;
1329 	if (cval->val_type == USB_MIXER_BOOLEAN ||
1330 	    cval->val_type == USB_MIXER_INV_BOOLEAN) {
1331 		uinfo->value.integer.min = 0;
1332 		uinfo->value.integer.max = 1;
1333 	} else {
1334 		if (!cval->initialized) {
1335 			get_min_max_with_quirks(cval, 0, kcontrol);
1336 			if (cval->initialized && cval->dBmin >= cval->dBmax) {
1337 				kcontrol->vd[0].access &=
1338 					~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1339 					  SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1340 				snd_ctl_notify(cval->head.mixer->chip->card,
1341 					       SNDRV_CTL_EVENT_MASK_INFO,
1342 					       &kcontrol->id);
1343 			}
1344 		}
1345 		uinfo->value.integer.min = 0;
1346 		uinfo->value.integer.max =
1347 			DIV_ROUND_UP(cval->max - cval->min, cval->res);
1348 	}
1349 	return 0;
1350 }
1351 
1352 /* get the current value from feature/mixer unit */
1353 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1354 				 struct snd_ctl_elem_value *ucontrol)
1355 {
1356 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1357 	int c, cnt, val, err;
1358 
1359 	ucontrol->value.integer.value[0] = cval->min;
1360 	if (cval->cmask) {
1361 		cnt = 0;
1362 		for (c = 0; c < MAX_CHANNELS; c++) {
1363 			if (!(cval->cmask & (1 << c)))
1364 				continue;
1365 			err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1366 			if (err < 0)
1367 				return filter_error(cval, err);
1368 			val = get_relative_value(cval, val);
1369 			ucontrol->value.integer.value[cnt] = val;
1370 			cnt++;
1371 		}
1372 		return 0;
1373 	} else {
1374 		/* master channel */
1375 		err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1376 		if (err < 0)
1377 			return filter_error(cval, err);
1378 		val = get_relative_value(cval, val);
1379 		ucontrol->value.integer.value[0] = val;
1380 	}
1381 	return 0;
1382 }
1383 
1384 /* put the current value to feature/mixer unit */
1385 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1386 				 struct snd_ctl_elem_value *ucontrol)
1387 {
1388 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1389 	int c, cnt, val, oval, err;
1390 	int changed = 0;
1391 
1392 	if (cval->cmask) {
1393 		cnt = 0;
1394 		for (c = 0; c < MAX_CHANNELS; c++) {
1395 			if (!(cval->cmask & (1 << c)))
1396 				continue;
1397 			err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1398 			if (err < 0)
1399 				return filter_error(cval, err);
1400 			val = ucontrol->value.integer.value[cnt];
1401 			val = get_abs_value(cval, val);
1402 			if (oval != val) {
1403 				snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1404 				changed = 1;
1405 			}
1406 			cnt++;
1407 		}
1408 	} else {
1409 		/* master channel */
1410 		err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1411 		if (err < 0)
1412 			return filter_error(cval, err);
1413 		val = ucontrol->value.integer.value[0];
1414 		val = get_abs_value(cval, val);
1415 		if (val != oval) {
1416 			snd_usb_set_cur_mix_value(cval, 0, 0, val);
1417 			changed = 1;
1418 		}
1419 	}
1420 	return changed;
1421 }
1422 
1423 /* get the boolean value from the master channel of a UAC control */
1424 static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
1425 				     struct snd_ctl_elem_value *ucontrol)
1426 {
1427 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1428 	int val, err;
1429 
1430 	err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1431 	if (err < 0)
1432 		return filter_error(cval, err);
1433 	val = (val != 0);
1434 	ucontrol->value.integer.value[0] = val;
1435 	return 0;
1436 }
1437 
1438 /* get the connectors status and report it as boolean type */
1439 static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol,
1440 				   struct snd_ctl_elem_value *ucontrol)
1441 {
1442 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1443 	struct snd_usb_audio *chip = cval->head.mixer->chip;
1444 	int idx = 0, validx, ret, val;
1445 
1446 	validx = cval->control << 8 | 0;
1447 
1448 	ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
1449 	if (ret)
1450 		goto error;
1451 
1452 	idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
1453 	if (cval->head.mixer->protocol == UAC_VERSION_2) {
1454 		struct uac2_connectors_ctl_blk uac2_conn;
1455 
1456 		ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1457 				      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1458 				      validx, idx, &uac2_conn, sizeof(uac2_conn));
1459 		val = !!uac2_conn.bNrChannels;
1460 	} else { /* UAC_VERSION_3 */
1461 		struct uac3_insertion_ctl_blk uac3_conn;
1462 
1463 		ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1464 				      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1465 				      validx, idx, &uac3_conn, sizeof(uac3_conn));
1466 		val = !!uac3_conn.bmConInserted;
1467 	}
1468 
1469 	snd_usb_unlock_shutdown(chip);
1470 
1471 	if (ret < 0) {
1472 		if (strstr(kcontrol->id.name, "Speaker")) {
1473 			ucontrol->value.integer.value[0] = 1;
1474 			return 0;
1475 		}
1476 error:
1477 		usb_audio_err(chip,
1478 			"cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1479 			UAC_GET_CUR, validx, idx, cval->val_type);
1480 		return filter_error(cval, ret);
1481 	}
1482 
1483 	ucontrol->value.integer.value[0] = val;
1484 	return 0;
1485 }
1486 
1487 static const struct snd_kcontrol_new usb_feature_unit_ctl = {
1488 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1489 	.name = "", /* will be filled later manually */
1490 	.info = mixer_ctl_feature_info,
1491 	.get = mixer_ctl_feature_get,
1492 	.put = mixer_ctl_feature_put,
1493 };
1494 
1495 /* the read-only variant */
1496 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1497 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1498 	.name = "", /* will be filled later manually */
1499 	.info = mixer_ctl_feature_info,
1500 	.get = mixer_ctl_feature_get,
1501 	.put = NULL,
1502 };
1503 
1504 /*
1505  * A control which shows the boolean value from reading a UAC control on
1506  * the master channel.
1507  */
1508 static const struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1509 	.iface = SNDRV_CTL_ELEM_IFACE_CARD,
1510 	.name = "", /* will be filled later manually */
1511 	.access = SNDRV_CTL_ELEM_ACCESS_READ,
1512 	.info = snd_ctl_boolean_mono_info,
1513 	.get = mixer_ctl_master_bool_get,
1514 	.put = NULL,
1515 };
1516 
1517 static const struct snd_kcontrol_new usb_connector_ctl_ro = {
1518 	.iface = SNDRV_CTL_ELEM_IFACE_CARD,
1519 	.name = "", /* will be filled later manually */
1520 	.access = SNDRV_CTL_ELEM_ACCESS_READ,
1521 	.info = snd_ctl_boolean_mono_info,
1522 	.get = mixer_ctl_connector_get,
1523 	.put = NULL,
1524 };
1525 
1526 /*
1527  * This symbol is exported in order to allow the mixer quirks to
1528  * hook up to the standard feature unit control mechanism
1529  */
1530 const struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1531 
1532 /*
1533  * build a feature control
1534  */
1535 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1536 {
1537 	return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1538 }
1539 
1540 /*
1541  * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1542  * rename it to "Headphone". We determine if something is a headphone
1543  * similar to how udev determines form factor.
1544  */
1545 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1546 					struct snd_card *card)
1547 {
1548 	const char *names_to_check[] = {
1549 		"Headset", "headset", "Headphone", "headphone", NULL};
1550 	const char **s;
1551 	bool found = false;
1552 
1553 	if (strcmp("Speaker", kctl->id.name))
1554 		return;
1555 
1556 	for (s = names_to_check; *s; s++)
1557 		if (strstr(card->shortname, *s)) {
1558 			found = true;
1559 			break;
1560 		}
1561 
1562 	if (!found)
1563 		return;
1564 
1565 	strscpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1566 }
1567 
1568 static const struct usb_feature_control_info *get_feature_control_info(int control)
1569 {
1570 	int i;
1571 
1572 	for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1573 		if (audio_feature_info[i].control == control)
1574 			return &audio_feature_info[i];
1575 	}
1576 	return NULL;
1577 }
1578 
1579 static void __build_feature_ctl(struct usb_mixer_interface *mixer,
1580 				const struct usbmix_name_map *imap,
1581 				unsigned int ctl_mask, int control,
1582 				struct usb_audio_term *iterm,
1583 				struct usb_audio_term *oterm,
1584 				int unitid, int nameid, int readonly_mask)
1585 {
1586 	const struct usb_feature_control_info *ctl_info;
1587 	unsigned int len = 0;
1588 	int mapped_name = 0;
1589 	struct snd_kcontrol *kctl;
1590 	struct usb_mixer_elem_info *cval;
1591 	const struct usbmix_name_map *map;
1592 	unsigned int range;
1593 
1594 	if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1595 		/* FIXME: not supported yet */
1596 		return;
1597 	}
1598 
1599 	map = find_map(imap, unitid, control);
1600 	if (check_ignored_ctl(map))
1601 		return;
1602 
1603 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1604 	if (!cval)
1605 		return;
1606 	snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
1607 	cval->control = control;
1608 	cval->cmask = ctl_mask;
1609 
1610 	ctl_info = get_feature_control_info(control);
1611 	if (!ctl_info) {
1612 		usb_mixer_elem_info_free(cval);
1613 		return;
1614 	}
1615 	if (mixer->protocol == UAC_VERSION_1)
1616 		cval->val_type = ctl_info->type;
1617 	else /* UAC_VERSION_2 */
1618 		cval->val_type = ctl_info->type_uac2 >= 0 ?
1619 			ctl_info->type_uac2 : ctl_info->type;
1620 
1621 	if (ctl_mask == 0) {
1622 		cval->channels = 1;	/* master channel */
1623 		cval->master_readonly = readonly_mask;
1624 	} else {
1625 		int i, c = 0;
1626 		for (i = 0; i < 16; i++)
1627 			if (ctl_mask & (1 << i))
1628 				c++;
1629 		cval->channels = c;
1630 		cval->ch_readonly = readonly_mask;
1631 	}
1632 
1633 	/*
1634 	 * If all channels in the mask are marked read-only, make the control
1635 	 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1636 	 * issue write commands to read-only channels.
1637 	 */
1638 	if (cval->channels == readonly_mask)
1639 		kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1640 	else
1641 		kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1642 
1643 	if (!kctl) {
1644 		usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1645 		usb_mixer_elem_info_free(cval);
1646 		return;
1647 	}
1648 	kctl->private_free = snd_usb_mixer_elem_free;
1649 
1650 	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1651 	mapped_name = len != 0;
1652 	if (!len && nameid)
1653 		len = snd_usb_copy_string_desc(mixer->chip, nameid,
1654 				kctl->id.name, sizeof(kctl->id.name));
1655 
1656 	switch (control) {
1657 	case UAC_FU_MUTE:
1658 	case UAC_FU_VOLUME:
1659 		/*
1660 		 * determine the control name.  the rule is:
1661 		 * - if a name id is given in descriptor, use it.
1662 		 * - if the connected input can be determined, then use the name
1663 		 *   of terminal type.
1664 		 * - if the connected output can be determined, use it.
1665 		 * - otherwise, anonymous name.
1666 		 */
1667 		if (!len) {
1668 			if (iterm)
1669 				len = get_term_name(mixer->chip, iterm,
1670 						    kctl->id.name,
1671 						    sizeof(kctl->id.name), 1);
1672 			if (!len && oterm)
1673 				len = get_term_name(mixer->chip, oterm,
1674 						    kctl->id.name,
1675 						    sizeof(kctl->id.name), 1);
1676 			if (!len)
1677 				snprintf(kctl->id.name, sizeof(kctl->id.name),
1678 					 "Feature %d", unitid);
1679 		}
1680 
1681 		if (!mapped_name)
1682 			check_no_speaker_on_headset(kctl, mixer->chip->card);
1683 
1684 		/*
1685 		 * determine the stream direction:
1686 		 * if the connected output is USB stream, then it's likely a
1687 		 * capture stream.  otherwise it should be playback (hopefully :)
1688 		 */
1689 		if (!mapped_name && oterm && !(oterm->type >> 16)) {
1690 			if ((oterm->type & 0xff00) == 0x0100)
1691 				append_ctl_name(kctl, " Capture");
1692 			else
1693 				append_ctl_name(kctl, " Playback");
1694 		}
1695 		append_ctl_name(kctl, control == UAC_FU_MUTE ?
1696 				" Switch" : " Volume");
1697 		break;
1698 	default:
1699 		if (!len)
1700 			strscpy(kctl->id.name, audio_feature_info[control-1].name,
1701 				sizeof(kctl->id.name));
1702 		break;
1703 	}
1704 
1705 	/* get min/max values */
1706 	get_min_max_with_quirks(cval, 0, kctl);
1707 
1708 	/* skip a bogus volume range */
1709 	if (cval->max <= cval->min) {
1710 		usb_audio_dbg(mixer->chip,
1711 			      "[%d] FU [%s] skipped due to invalid volume\n",
1712 			      cval->head.id, kctl->id.name);
1713 		snd_ctl_free_one(kctl);
1714 		return;
1715 	}
1716 
1717 
1718 	if (control == UAC_FU_VOLUME) {
1719 		check_mapped_dB(map, cval);
1720 		if (cval->dBmin < cval->dBmax || !cval->initialized) {
1721 			kctl->tlv.c = snd_usb_mixer_vol_tlv;
1722 			kctl->vd[0].access |=
1723 				SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1724 				SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1725 		}
1726 	}
1727 
1728 	snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1729 
1730 	range = (cval->max - cval->min) / cval->res;
1731 	/*
1732 	 * Are there devices with volume range more than 255? I use a bit more
1733 	 * to be sure. 384 is a resolution magic number found on Logitech
1734 	 * devices. It will definitively catch all buggy Logitech devices.
1735 	 */
1736 	if (range > 384) {
1737 		usb_audio_warn(mixer->chip,
1738 			       "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1739 			       range);
1740 		usb_audio_warn(mixer->chip,
1741 			       "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1742 			       cval->head.id, kctl->id.name, cval->channels,
1743 			       cval->min, cval->max, cval->res);
1744 	}
1745 
1746 	usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1747 		      cval->head.id, kctl->id.name, cval->channels,
1748 		      cval->min, cval->max, cval->res);
1749 	snd_usb_mixer_add_control(&cval->head, kctl);
1750 }
1751 
1752 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1753 			      unsigned int ctl_mask, int control,
1754 			      struct usb_audio_term *iterm, int unitid,
1755 			      int readonly_mask)
1756 {
1757 	struct uac_feature_unit_descriptor *desc = raw_desc;
1758 	int nameid = uac_feature_unit_iFeature(desc);
1759 
1760 	__build_feature_ctl(state->mixer, state->map, ctl_mask, control,
1761 			iterm, &state->oterm, unitid, nameid, readonly_mask);
1762 }
1763 
1764 static void build_feature_ctl_badd(struct usb_mixer_interface *mixer,
1765 			      unsigned int ctl_mask, int control, int unitid,
1766 			      const struct usbmix_name_map *badd_map)
1767 {
1768 	__build_feature_ctl(mixer, badd_map, ctl_mask, control,
1769 			NULL, NULL, unitid, 0, 0);
1770 }
1771 
1772 static void get_connector_control_name(struct usb_mixer_interface *mixer,
1773 				       struct usb_audio_term *term,
1774 				       bool is_input, char *name, int name_size)
1775 {
1776 	int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1777 
1778 	if (name_len == 0)
1779 		strscpy(name, "Unknown", name_size);
1780 
1781 	/*
1782 	 *  sound/core/ctljack.c has a convention of naming jack controls
1783 	 * by ending in " Jack".  Make it slightly more useful by
1784 	 * indicating Input or Output after the terminal name.
1785 	 */
1786 	if (is_input)
1787 		strlcat(name, " - Input Jack", name_size);
1788 	else
1789 		strlcat(name, " - Output Jack", name_size);
1790 }
1791 
1792 /* Build a mixer control for a UAC connector control (jack-detect) */
1793 static void build_connector_control(struct usb_mixer_interface *mixer,
1794 				    const struct usbmix_name_map *imap,
1795 				    struct usb_audio_term *term, bool is_input)
1796 {
1797 	struct snd_kcontrol *kctl;
1798 	struct usb_mixer_elem_info *cval;
1799 	const struct usbmix_name_map *map;
1800 
1801 	map = find_map(imap, term->id, 0);
1802 	if (check_ignored_ctl(map))
1803 		return;
1804 
1805 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1806 	if (!cval)
1807 		return;
1808 	snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1809 	/*
1810 	 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1811 	 * number of channels connected.
1812 	 *
1813 	 * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1814 	 * following byte(s) specifies which connectors are inserted.
1815 	 *
1816 	 * This boolean ctl will simply report if any channels are connected
1817 	 * or not.
1818 	 */
1819 	if (mixer->protocol == UAC_VERSION_2)
1820 		cval->control = UAC2_TE_CONNECTOR;
1821 	else /* UAC_VERSION_3 */
1822 		cval->control = UAC3_TE_INSERTION;
1823 
1824 	cval->val_type = USB_MIXER_BOOLEAN;
1825 	cval->channels = 1; /* report true if any channel is connected */
1826 	cval->min = 0;
1827 	cval->max = 1;
1828 	kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1829 	if (!kctl) {
1830 		usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1831 		usb_mixer_elem_info_free(cval);
1832 		return;
1833 	}
1834 
1835 	if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)))
1836 		strlcat(kctl->id.name, " Jack", sizeof(kctl->id.name));
1837 	else
1838 		get_connector_control_name(mixer, term, is_input, kctl->id.name,
1839 					   sizeof(kctl->id.name));
1840 	kctl->private_free = snd_usb_mixer_elem_free;
1841 	snd_usb_mixer_add_control(&cval->head, kctl);
1842 }
1843 
1844 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1845 				   void *_ftr)
1846 {
1847 	struct uac_clock_source_descriptor *hdr = _ftr;
1848 	struct usb_mixer_elem_info *cval;
1849 	struct snd_kcontrol *kctl;
1850 	char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1851 	int ret;
1852 
1853 	if (state->mixer->protocol != UAC_VERSION_2)
1854 		return -EINVAL;
1855 
1856 	/*
1857 	 * The only property of this unit we are interested in is the
1858 	 * clock source validity. If that isn't readable, just bail out.
1859 	 */
1860 	if (!uac_v2v3_control_is_readable(hdr->bmControls,
1861 				      UAC2_CS_CONTROL_CLOCK_VALID))
1862 		return 0;
1863 
1864 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1865 	if (!cval)
1866 		return -ENOMEM;
1867 
1868 	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1869 
1870 	cval->min = 0;
1871 	cval->max = 1;
1872 	cval->channels = 1;
1873 	cval->val_type = USB_MIXER_BOOLEAN;
1874 	cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1875 
1876 	cval->master_readonly = 1;
1877 	/* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1878 	kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1879 
1880 	if (!kctl) {
1881 		usb_mixer_elem_info_free(cval);
1882 		return -ENOMEM;
1883 	}
1884 
1885 	kctl->private_free = snd_usb_mixer_elem_free;
1886 	ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1887 				       name, sizeof(name));
1888 	if (ret > 0)
1889 		snprintf(kctl->id.name, sizeof(kctl->id.name),
1890 			 "%s Validity", name);
1891 	else
1892 		snprintf(kctl->id.name, sizeof(kctl->id.name),
1893 			 "Clock Source %d Validity", hdr->bClockID);
1894 
1895 	return snd_usb_mixer_add_control(&cval->head, kctl);
1896 }
1897 
1898 /*
1899  * parse a feature unit
1900  *
1901  * most of controls are defined here.
1902  */
1903 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1904 				    void *_ftr)
1905 {
1906 	int channels, i, j;
1907 	struct usb_audio_term iterm;
1908 	unsigned int master_bits;
1909 	int err, csize;
1910 	struct uac_feature_unit_descriptor *hdr = _ftr;
1911 	__u8 *bmaControls;
1912 
1913 	if (state->mixer->protocol == UAC_VERSION_1) {
1914 		csize = hdr->bControlSize;
1915 		channels = (hdr->bLength - 7) / csize - 1;
1916 		bmaControls = hdr->bmaControls;
1917 	} else if (state->mixer->protocol == UAC_VERSION_2) {
1918 		struct uac2_feature_unit_descriptor *ftr = _ftr;
1919 		csize = 4;
1920 		channels = (hdr->bLength - 6) / 4 - 1;
1921 		bmaControls = ftr->bmaControls;
1922 	} else { /* UAC_VERSION_3 */
1923 		struct uac3_feature_unit_descriptor *ftr = _ftr;
1924 
1925 		csize = 4;
1926 		channels = (ftr->bLength - 7) / 4 - 1;
1927 		bmaControls = ftr->bmaControls;
1928 	}
1929 
1930 	/* parse the source unit */
1931 	err = parse_audio_unit(state, hdr->bSourceID);
1932 	if (err < 0)
1933 		return err;
1934 
1935 	/* determine the input source type and name */
1936 	err = check_input_term(state, hdr->bSourceID, &iterm);
1937 	if (err < 0)
1938 		return err;
1939 
1940 	master_bits = snd_usb_combine_bytes(bmaControls, csize);
1941 	/* master configuration quirks */
1942 	switch (state->chip->usb_id) {
1943 	case USB_ID(0x08bb, 0x2702):
1944 		usb_audio_info(state->chip,
1945 			       "usbmixer: master volume quirk for PCM2702 chip\n");
1946 		/* disable non-functional volume control */
1947 		master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1948 		break;
1949 	case USB_ID(0x1130, 0xf211):
1950 		usb_audio_info(state->chip,
1951 			       "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1952 		/* disable non-functional volume control */
1953 		channels = 0;
1954 		break;
1955 
1956 	}
1957 
1958 	if (state->mixer->protocol == UAC_VERSION_1) {
1959 		/* check all control types */
1960 		for (i = 0; i < 10; i++) {
1961 			unsigned int ch_bits = 0;
1962 			int control = audio_feature_info[i].control;
1963 
1964 			for (j = 0; j < channels; j++) {
1965 				unsigned int mask;
1966 
1967 				mask = snd_usb_combine_bytes(bmaControls +
1968 							     csize * (j+1), csize);
1969 				if (mask & (1 << i))
1970 					ch_bits |= (1 << j);
1971 			}
1972 			/* audio class v1 controls are never read-only */
1973 
1974 			/*
1975 			 * The first channel must be set
1976 			 * (for ease of programming).
1977 			 */
1978 			if (ch_bits & 1)
1979 				build_feature_ctl(state, _ftr, ch_bits, control,
1980 						  &iterm, unitid, 0);
1981 			if (master_bits & (1 << i))
1982 				build_feature_ctl(state, _ftr, 0, control,
1983 						  &iterm, unitid, 0);
1984 		}
1985 	} else { /* UAC_VERSION_2/3 */
1986 		for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1987 			unsigned int ch_bits = 0;
1988 			unsigned int ch_read_only = 0;
1989 			int control = audio_feature_info[i].control;
1990 
1991 			for (j = 0; j < channels; j++) {
1992 				unsigned int mask;
1993 
1994 				mask = snd_usb_combine_bytes(bmaControls +
1995 							     csize * (j+1), csize);
1996 				if (uac_v2v3_control_is_readable(mask, control)) {
1997 					ch_bits |= (1 << j);
1998 					if (!uac_v2v3_control_is_writeable(mask, control))
1999 						ch_read_only |= (1 << j);
2000 				}
2001 			}
2002 
2003 			/*
2004 			 * NOTE: build_feature_ctl() will mark the control
2005 			 * read-only if all channels are marked read-only in
2006 			 * the descriptors. Otherwise, the control will be
2007 			 * reported as writeable, but the driver will not
2008 			 * actually issue a write command for read-only
2009 			 * channels.
2010 			 */
2011 
2012 			/*
2013 			 * The first channel must be set
2014 			 * (for ease of programming).
2015 			 */
2016 			if (ch_bits & 1)
2017 				build_feature_ctl(state, _ftr, ch_bits, control,
2018 						  &iterm, unitid, ch_read_only);
2019 			if (uac_v2v3_control_is_readable(master_bits, control))
2020 				build_feature_ctl(state, _ftr, 0, control,
2021 						  &iterm, unitid,
2022 						  !uac_v2v3_control_is_writeable(master_bits,
2023 										 control));
2024 		}
2025 	}
2026 
2027 	return 0;
2028 }
2029 
2030 /*
2031  * Mixer Unit
2032  */
2033 
2034 /* check whether the given in/out overflows bmMixerControls matrix */
2035 static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc,
2036 				  int protocol, int num_ins, int num_outs)
2037 {
2038 	u8 *hdr = (u8 *)desc;
2039 	u8 *c = uac_mixer_unit_bmControls(desc, protocol);
2040 	size_t rest; /* remaining bytes after bmMixerControls */
2041 
2042 	switch (protocol) {
2043 	case UAC_VERSION_1:
2044 	default:
2045 		rest = 1; /* iMixer */
2046 		break;
2047 	case UAC_VERSION_2:
2048 		rest = 2; /* bmControls + iMixer */
2049 		break;
2050 	case UAC_VERSION_3:
2051 		rest = 6; /* bmControls + wMixerDescrStr */
2052 		break;
2053 	}
2054 
2055 	/* overflow? */
2056 	return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
2057 }
2058 
2059 /*
2060  * build a mixer unit control
2061  *
2062  * the callbacks are identical with feature unit.
2063  * input channel number (zero based) is given in control field instead.
2064  */
2065 static void build_mixer_unit_ctl(struct mixer_build *state,
2066 				 struct uac_mixer_unit_descriptor *desc,
2067 				 int in_pin, int in_ch, int num_outs,
2068 				 int unitid, struct usb_audio_term *iterm)
2069 {
2070 	struct usb_mixer_elem_info *cval;
2071 	unsigned int i, len;
2072 	struct snd_kcontrol *kctl;
2073 	const struct usbmix_name_map *map;
2074 
2075 	map = find_map(state->map, unitid, 0);
2076 	if (check_ignored_ctl(map))
2077 		return;
2078 
2079 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2080 	if (!cval)
2081 		return;
2082 
2083 	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2084 	cval->control = in_ch + 1; /* based on 1 */
2085 	cval->val_type = USB_MIXER_S16;
2086 	for (i = 0; i < num_outs; i++) {
2087 		__u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
2088 
2089 		if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
2090 			cval->cmask |= (1 << i);
2091 			cval->channels++;
2092 		}
2093 	}
2094 
2095 	/* get min/max values */
2096 	get_min_max(cval, 0);
2097 
2098 	kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2099 	if (!kctl) {
2100 		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2101 		usb_mixer_elem_info_free(cval);
2102 		return;
2103 	}
2104 	kctl->private_free = snd_usb_mixer_elem_free;
2105 
2106 	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2107 	if (!len)
2108 		len = get_term_name(state->chip, iterm, kctl->id.name,
2109 				    sizeof(kctl->id.name), 0);
2110 	if (!len)
2111 		len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
2112 	append_ctl_name(kctl, " Volume");
2113 
2114 	usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2115 		    cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
2116 	snd_usb_mixer_add_control(&cval->head, kctl);
2117 }
2118 
2119 static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
2120 				      void *raw_desc)
2121 {
2122 	struct usb_audio_term iterm;
2123 	unsigned int control, bmctls, term_id;
2124 
2125 	if (state->mixer->protocol == UAC_VERSION_2) {
2126 		struct uac2_input_terminal_descriptor *d_v2 = raw_desc;
2127 		control = UAC2_TE_CONNECTOR;
2128 		term_id = d_v2->bTerminalID;
2129 		bmctls = le16_to_cpu(d_v2->bmControls);
2130 	} else if (state->mixer->protocol == UAC_VERSION_3) {
2131 		struct uac3_input_terminal_descriptor *d_v3 = raw_desc;
2132 		control = UAC3_TE_INSERTION;
2133 		term_id = d_v3->bTerminalID;
2134 		bmctls = le32_to_cpu(d_v3->bmControls);
2135 	} else {
2136 		return 0; /* UAC1. No Insertion control */
2137 	}
2138 
2139 	check_input_term(state, term_id, &iterm);
2140 
2141 	/* Check for jack detection. */
2142 	if ((iterm.type & 0xff00) != 0x0100 &&
2143 	    uac_v2v3_control_is_readable(bmctls, control))
2144 		build_connector_control(state->mixer, state->map, &iterm, true);
2145 
2146 	return 0;
2147 }
2148 
2149 /*
2150  * parse a mixer unit
2151  */
2152 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
2153 				  void *raw_desc)
2154 {
2155 	struct uac_mixer_unit_descriptor *desc = raw_desc;
2156 	struct usb_audio_term iterm;
2157 	int input_pins, num_ins, num_outs;
2158 	int pin, ich, err;
2159 
2160 	err = uac_mixer_unit_get_channels(state, desc);
2161 	if (err < 0) {
2162 		usb_audio_err(state->chip,
2163 			      "invalid MIXER UNIT descriptor %d\n",
2164 			      unitid);
2165 		return err;
2166 	}
2167 
2168 	num_outs = err;
2169 	input_pins = desc->bNrInPins;
2170 
2171 	num_ins = 0;
2172 	ich = 0;
2173 	for (pin = 0; pin < input_pins; pin++) {
2174 		err = parse_audio_unit(state, desc->baSourceID[pin]);
2175 		if (err < 0)
2176 			continue;
2177 		/* no bmControls field (e.g. Maya44) -> ignore */
2178 		if (!num_outs)
2179 			continue;
2180 		err = check_input_term(state, desc->baSourceID[pin], &iterm);
2181 		if (err < 0)
2182 			return err;
2183 		num_ins += iterm.channels;
2184 		if (mixer_bitmap_overflow(desc, state->mixer->protocol,
2185 					  num_ins, num_outs))
2186 			break;
2187 		for (; ich < num_ins; ich++) {
2188 			int och, ich_has_controls = 0;
2189 
2190 			for (och = 0; och < num_outs; och++) {
2191 				__u8 *c = uac_mixer_unit_bmControls(desc,
2192 						state->mixer->protocol);
2193 
2194 				if (check_matrix_bitmap(c, ich, och, num_outs)) {
2195 					ich_has_controls = 1;
2196 					break;
2197 				}
2198 			}
2199 			if (ich_has_controls)
2200 				build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
2201 						     unitid, &iterm);
2202 		}
2203 	}
2204 	return 0;
2205 }
2206 
2207 /*
2208  * Processing Unit / Extension Unit
2209  */
2210 
2211 /* get callback for processing/extension unit */
2212 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
2213 				  struct snd_ctl_elem_value *ucontrol)
2214 {
2215 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2216 	int err, val;
2217 
2218 	err = get_cur_ctl_value(cval, cval->control << 8, &val);
2219 	if (err < 0) {
2220 		ucontrol->value.integer.value[0] = cval->min;
2221 		return filter_error(cval, err);
2222 	}
2223 	val = get_relative_value(cval, val);
2224 	ucontrol->value.integer.value[0] = val;
2225 	return 0;
2226 }
2227 
2228 /* put callback for processing/extension unit */
2229 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
2230 				  struct snd_ctl_elem_value *ucontrol)
2231 {
2232 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2233 	int val, oval, err;
2234 
2235 	err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2236 	if (err < 0)
2237 		return filter_error(cval, err);
2238 	val = ucontrol->value.integer.value[0];
2239 	val = get_abs_value(cval, val);
2240 	if (val != oval) {
2241 		set_cur_ctl_value(cval, cval->control << 8, val);
2242 		return 1;
2243 	}
2244 	return 0;
2245 }
2246 
2247 /* alsa control interface for processing/extension unit */
2248 static const struct snd_kcontrol_new mixer_procunit_ctl = {
2249 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2250 	.name = "", /* will be filled later */
2251 	.info = mixer_ctl_feature_info,
2252 	.get = mixer_ctl_procunit_get,
2253 	.put = mixer_ctl_procunit_put,
2254 };
2255 
2256 /*
2257  * predefined data for processing units
2258  */
2259 struct procunit_value_info {
2260 	int control;
2261 	const char *suffix;
2262 	int val_type;
2263 	int min_value;
2264 };
2265 
2266 struct procunit_info {
2267 	int type;
2268 	char *name;
2269 	const struct procunit_value_info *values;
2270 };
2271 
2272 static const struct procunit_value_info undefined_proc_info[] = {
2273 	{ 0x00, "Control Undefined", 0 },
2274 	{ 0 }
2275 };
2276 
2277 static const struct procunit_value_info updown_proc_info[] = {
2278 	{ UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2279 	{ UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2280 	{ 0 }
2281 };
2282 static const struct procunit_value_info prologic_proc_info[] = {
2283 	{ UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2284 	{ UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2285 	{ 0 }
2286 };
2287 static const struct procunit_value_info threed_enh_proc_info[] = {
2288 	{ UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2289 	{ UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2290 	{ 0 }
2291 };
2292 static const struct procunit_value_info reverb_proc_info[] = {
2293 	{ UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2294 	{ UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2295 	{ UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2296 	{ UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2297 	{ 0 }
2298 };
2299 static const struct procunit_value_info chorus_proc_info[] = {
2300 	{ UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2301 	{ UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2302 	{ UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2303 	{ UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2304 	{ 0 }
2305 };
2306 static const struct procunit_value_info dcr_proc_info[] = {
2307 	{ UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2308 	{ UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2309 	{ UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2310 	{ UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2311 	{ UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2312 	{ UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2313 	{ 0 }
2314 };
2315 
2316 static const struct procunit_info procunits[] = {
2317 	{ UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2318 	{ UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2319 	{ UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2320 	{ UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2321 	{ UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2322 	{ UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2323 	{ 0 },
2324 };
2325 
2326 static const struct procunit_value_info uac3_updown_proc_info[] = {
2327 	{ UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2328 	{ 0 }
2329 };
2330 static const struct procunit_value_info uac3_stereo_ext_proc_info[] = {
2331 	{ UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
2332 	{ 0 }
2333 };
2334 
2335 static const struct procunit_info uac3_procunits[] = {
2336 	{ UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info },
2337 	{ UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info },
2338 	{ UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info },
2339 	{ 0 },
2340 };
2341 
2342 /*
2343  * predefined data for extension units
2344  */
2345 static const struct procunit_value_info clock_rate_xu_info[] = {
2346 	{ USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2347 	{ 0 }
2348 };
2349 static const struct procunit_value_info clock_source_xu_info[] = {
2350 	{ USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2351 	{ 0 }
2352 };
2353 static const struct procunit_value_info spdif_format_xu_info[] = {
2354 	{ USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2355 	{ 0 }
2356 };
2357 static const struct procunit_value_info soft_limit_xu_info[] = {
2358 	{ USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2359 	{ 0 }
2360 };
2361 static const struct procunit_info extunits[] = {
2362 	{ USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2363 	{ USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2364 	{ USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2365 	{ USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2366 	{ 0 }
2367 };
2368 
2369 /*
2370  * build a processing/extension unit
2371  */
2372 static int build_audio_procunit(struct mixer_build *state, int unitid,
2373 				void *raw_desc, const struct procunit_info *list,
2374 				bool extension_unit)
2375 {
2376 	struct uac_processing_unit_descriptor *desc = raw_desc;
2377 	int num_ins;
2378 	struct usb_mixer_elem_info *cval;
2379 	struct snd_kcontrol *kctl;
2380 	int i, err, nameid, type, len, val;
2381 	const struct procunit_info *info;
2382 	const struct procunit_value_info *valinfo;
2383 	const struct usbmix_name_map *map;
2384 	static const struct procunit_value_info default_value_info[] = {
2385 		{ 0x01, "Switch", USB_MIXER_BOOLEAN },
2386 		{ 0 }
2387 	};
2388 	static const struct procunit_info default_info = {
2389 		0, NULL, default_value_info
2390 	};
2391 	const char *name = extension_unit ?
2392 		"Extension Unit" : "Processing Unit";
2393 
2394 	num_ins = desc->bNrInPins;
2395 	for (i = 0; i < num_ins; i++) {
2396 		err = parse_audio_unit(state, desc->baSourceID[i]);
2397 		if (err < 0)
2398 			return err;
2399 	}
2400 
2401 	type = le16_to_cpu(desc->wProcessType);
2402 	for (info = list; info && info->type; info++)
2403 		if (info->type == type)
2404 			break;
2405 	if (!info || !info->type)
2406 		info = &default_info;
2407 
2408 	for (valinfo = info->values; valinfo->control; valinfo++) {
2409 		__u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2410 
2411 		if (state->mixer->protocol == UAC_VERSION_1) {
2412 			if (!(controls[valinfo->control / 8] &
2413 					(1 << ((valinfo->control % 8) - 1))))
2414 				continue;
2415 		} else { /* UAC_VERSION_2/3 */
2416 			if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
2417 							  valinfo->control))
2418 				continue;
2419 		}
2420 
2421 		map = find_map(state->map, unitid, valinfo->control);
2422 		if (check_ignored_ctl(map))
2423 			continue;
2424 		cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2425 		if (!cval)
2426 			return -ENOMEM;
2427 		snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2428 		cval->control = valinfo->control;
2429 		cval->val_type = valinfo->val_type;
2430 		cval->channels = 1;
2431 
2432 		if (state->mixer->protocol > UAC_VERSION_1 &&
2433 		    !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
2434 						   valinfo->control))
2435 			cval->master_readonly = 1;
2436 
2437 		/* get min/max values */
2438 		switch (type) {
2439 		case UAC_PROCESS_UP_DOWNMIX: {
2440 			bool mode_sel = false;
2441 
2442 			switch (state->mixer->protocol) {
2443 			case UAC_VERSION_1:
2444 			case UAC_VERSION_2:
2445 			default:
2446 				if (cval->control == UAC_UD_MODE_SELECT)
2447 					mode_sel = true;
2448 				break;
2449 			case UAC_VERSION_3:
2450 				if (cval->control == UAC3_UD_MODE_SELECT)
2451 					mode_sel = true;
2452 				break;
2453 			}
2454 
2455 			if (mode_sel) {
2456 				__u8 *control_spec = uac_processing_unit_specific(desc,
2457 								state->mixer->protocol);
2458 				cval->min = 1;
2459 				cval->max = control_spec[0];
2460 				cval->res = 1;
2461 				cval->initialized = 1;
2462 				break;
2463 			}
2464 
2465 			get_min_max(cval, valinfo->min_value);
2466 			break;
2467 		}
2468 		case USB_XU_CLOCK_RATE:
2469 			/*
2470 			 * E-Mu USB 0404/0202/TrackerPre/0204
2471 			 * samplerate control quirk
2472 			 */
2473 			cval->min = 0;
2474 			cval->max = 5;
2475 			cval->res = 1;
2476 			cval->initialized = 1;
2477 			break;
2478 		default:
2479 			get_min_max(cval, valinfo->min_value);
2480 			break;
2481 		}
2482 
2483 		err = get_cur_ctl_value(cval, cval->control << 8, &val);
2484 		if (err < 0) {
2485 			usb_mixer_elem_info_free(cval);
2486 			return -EINVAL;
2487 		}
2488 
2489 		kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2490 		if (!kctl) {
2491 			usb_mixer_elem_info_free(cval);
2492 			return -ENOMEM;
2493 		}
2494 		kctl->private_free = snd_usb_mixer_elem_free;
2495 
2496 		if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2497 			/* nothing */ ;
2498 		} else if (info->name) {
2499 			strscpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2500 		} else {
2501 			if (extension_unit)
2502 				nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
2503 			else
2504 				nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2505 			len = 0;
2506 			if (nameid)
2507 				len = snd_usb_copy_string_desc(state->chip,
2508 							       nameid,
2509 							       kctl->id.name,
2510 							       sizeof(kctl->id.name));
2511 			if (!len)
2512 				strscpy(kctl->id.name, name, sizeof(kctl->id.name));
2513 		}
2514 		append_ctl_name(kctl, " ");
2515 		append_ctl_name(kctl, valinfo->suffix);
2516 
2517 		usb_audio_dbg(state->chip,
2518 			      "[%d] PU [%s] ch = %d, val = %d/%d\n",
2519 			      cval->head.id, kctl->id.name, cval->channels,
2520 			      cval->min, cval->max);
2521 
2522 		err = snd_usb_mixer_add_control(&cval->head, kctl);
2523 		if (err < 0)
2524 			return err;
2525 	}
2526 	return 0;
2527 }
2528 
2529 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2530 				       void *raw_desc)
2531 {
2532 	switch (state->mixer->protocol) {
2533 	case UAC_VERSION_1:
2534 	case UAC_VERSION_2:
2535 	default:
2536 		return build_audio_procunit(state, unitid, raw_desc,
2537 					    procunits, false);
2538 	case UAC_VERSION_3:
2539 		return build_audio_procunit(state, unitid, raw_desc,
2540 					    uac3_procunits, false);
2541 	}
2542 }
2543 
2544 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2545 				      void *raw_desc)
2546 {
2547 	/*
2548 	 * Note that we parse extension units with processing unit descriptors.
2549 	 * That's ok as the layout is the same.
2550 	 */
2551 	return build_audio_procunit(state, unitid, raw_desc, extunits, true);
2552 }
2553 
2554 /*
2555  * Selector Unit
2556  */
2557 
2558 /*
2559  * info callback for selector unit
2560  * use an enumerator type for routing
2561  */
2562 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2563 				   struct snd_ctl_elem_info *uinfo)
2564 {
2565 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2566 	const char **itemlist = (const char **)kcontrol->private_value;
2567 
2568 	if (snd_BUG_ON(!itemlist))
2569 		return -EINVAL;
2570 	return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2571 }
2572 
2573 /* get callback for selector unit */
2574 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2575 				  struct snd_ctl_elem_value *ucontrol)
2576 {
2577 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2578 	int val, err;
2579 
2580 	err = get_cur_ctl_value(cval, cval->control << 8, &val);
2581 	if (err < 0) {
2582 		ucontrol->value.enumerated.item[0] = 0;
2583 		return filter_error(cval, err);
2584 	}
2585 	val = get_relative_value(cval, val);
2586 	ucontrol->value.enumerated.item[0] = val;
2587 	return 0;
2588 }
2589 
2590 /* put callback for selector unit */
2591 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2592 				  struct snd_ctl_elem_value *ucontrol)
2593 {
2594 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2595 	int val, oval, err;
2596 
2597 	err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2598 	if (err < 0)
2599 		return filter_error(cval, err);
2600 	val = ucontrol->value.enumerated.item[0];
2601 	val = get_abs_value(cval, val);
2602 	if (val != oval) {
2603 		set_cur_ctl_value(cval, cval->control << 8, val);
2604 		return 1;
2605 	}
2606 	return 0;
2607 }
2608 
2609 /* alsa control interface for selector unit */
2610 static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2611 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2612 	.name = "", /* will be filled later */
2613 	.info = mixer_ctl_selector_info,
2614 	.get = mixer_ctl_selector_get,
2615 	.put = mixer_ctl_selector_put,
2616 };
2617 
2618 /*
2619  * private free callback.
2620  * free both private_data and private_value
2621  */
2622 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2623 {
2624 	int i, num_ins = 0;
2625 
2626 	if (kctl->private_data) {
2627 		struct usb_mixer_elem_info *cval = kctl->private_data;
2628 		num_ins = cval->max;
2629 		usb_mixer_elem_info_free(cval);
2630 		kctl->private_data = NULL;
2631 	}
2632 	if (kctl->private_value) {
2633 		char **itemlist = (char **)kctl->private_value;
2634 		for (i = 0; i < num_ins; i++)
2635 			kfree(itemlist[i]);
2636 		kfree(itemlist);
2637 		kctl->private_value = 0;
2638 	}
2639 }
2640 
2641 /*
2642  * parse a selector unit
2643  */
2644 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2645 				     void *raw_desc)
2646 {
2647 	struct uac_selector_unit_descriptor *desc = raw_desc;
2648 	unsigned int i, nameid, len;
2649 	int err;
2650 	struct usb_mixer_elem_info *cval;
2651 	struct snd_kcontrol *kctl;
2652 	const struct usbmix_name_map *map;
2653 	char **namelist;
2654 
2655 	for (i = 0; i < desc->bNrInPins; i++) {
2656 		err = parse_audio_unit(state, desc->baSourceID[i]);
2657 		if (err < 0)
2658 			return err;
2659 	}
2660 
2661 	if (desc->bNrInPins == 1) /* only one ? nonsense! */
2662 		return 0;
2663 
2664 	map = find_map(state->map, unitid, 0);
2665 	if (check_ignored_ctl(map))
2666 		return 0;
2667 
2668 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2669 	if (!cval)
2670 		return -ENOMEM;
2671 	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2672 	cval->val_type = USB_MIXER_U8;
2673 	cval->channels = 1;
2674 	cval->min = 1;
2675 	cval->max = desc->bNrInPins;
2676 	cval->res = 1;
2677 	cval->initialized = 1;
2678 
2679 	switch (state->mixer->protocol) {
2680 	case UAC_VERSION_1:
2681 	default:
2682 		cval->control = 0;
2683 		break;
2684 	case UAC_VERSION_2:
2685 	case UAC_VERSION_3:
2686 		if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2687 		    desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2688 			cval->control = UAC2_CX_CLOCK_SELECTOR;
2689 		else /* UAC2/3_SELECTOR_UNIT */
2690 			cval->control = UAC2_SU_SELECTOR;
2691 		break;
2692 	}
2693 
2694 	namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2695 	if (!namelist) {
2696 		err = -ENOMEM;
2697 		goto error_cval;
2698 	}
2699 #define MAX_ITEM_NAME_LEN	64
2700 	for (i = 0; i < desc->bNrInPins; i++) {
2701 		struct usb_audio_term iterm;
2702 		len = 0;
2703 		namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2704 		if (!namelist[i]) {
2705 			err = -ENOMEM;
2706 			goto error_name;
2707 		}
2708 		len = check_mapped_selector_name(state, unitid, i, namelist[i],
2709 						 MAX_ITEM_NAME_LEN);
2710 		if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2711 			len = get_term_name(state->chip, &iterm, namelist[i],
2712 					    MAX_ITEM_NAME_LEN, 0);
2713 		if (! len)
2714 			sprintf(namelist[i], "Input %u", i);
2715 	}
2716 
2717 	kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2718 	if (! kctl) {
2719 		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2720 		err = -ENOMEM;
2721 		goto error_name;
2722 	}
2723 	kctl->private_value = (unsigned long)namelist;
2724 	kctl->private_free = usb_mixer_selector_elem_free;
2725 
2726 	/* check the static mapping table at first */
2727 	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2728 	if (!len) {
2729 		/* no mapping ? */
2730 		switch (state->mixer->protocol) {
2731 		case UAC_VERSION_1:
2732 		case UAC_VERSION_2:
2733 		default:
2734 		/* if iSelector is given, use it */
2735 			nameid = uac_selector_unit_iSelector(desc);
2736 			if (nameid)
2737 				len = snd_usb_copy_string_desc(state->chip,
2738 							nameid, kctl->id.name,
2739 							sizeof(kctl->id.name));
2740 			break;
2741 		case UAC_VERSION_3:
2742 			/* TODO: Class-Specific strings not yet supported */
2743 			break;
2744 		}
2745 
2746 		/* ... or pick up the terminal name at next */
2747 		if (!len)
2748 			len = get_term_name(state->chip, &state->oterm,
2749 				    kctl->id.name, sizeof(kctl->id.name), 0);
2750 		/* ... or use the fixed string "USB" as the last resort */
2751 		if (!len)
2752 			strscpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2753 
2754 		/* and add the proper suffix */
2755 		if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2756 		    desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2757 			append_ctl_name(kctl, " Clock Source");
2758 		else if ((state->oterm.type & 0xff00) == 0x0100)
2759 			append_ctl_name(kctl, " Capture Source");
2760 		else
2761 			append_ctl_name(kctl, " Playback Source");
2762 	}
2763 
2764 	usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2765 		    cval->head.id, kctl->id.name, desc->bNrInPins);
2766 	return snd_usb_mixer_add_control(&cval->head, kctl);
2767 
2768  error_name:
2769 	for (i = 0; i < desc->bNrInPins; i++)
2770 		kfree(namelist[i]);
2771 	kfree(namelist);
2772  error_cval:
2773 	usb_mixer_elem_info_free(cval);
2774 	return err;
2775 }
2776 
2777 /*
2778  * parse an audio unit recursively
2779  */
2780 
2781 static int parse_audio_unit(struct mixer_build *state, int unitid)
2782 {
2783 	unsigned char *p1;
2784 	int protocol = state->mixer->protocol;
2785 
2786 	if (test_and_set_bit(unitid, state->unitbitmap))
2787 		return 0; /* the unit already visited */
2788 
2789 	p1 = find_audio_control_unit(state, unitid);
2790 	if (!p1) {
2791 		usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2792 		return -EINVAL;
2793 	}
2794 
2795 	if (!snd_usb_validate_audio_desc(p1, protocol)) {
2796 		usb_audio_dbg(state->chip, "invalid unit %d\n", unitid);
2797 		return 0; /* skip invalid unit */
2798 	}
2799 
2800 	switch (PTYPE(protocol, p1[2])) {
2801 	case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
2802 	case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
2803 	case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
2804 		return parse_audio_input_terminal(state, unitid, p1);
2805 	case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
2806 	case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
2807 	case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
2808 		return parse_audio_mixer_unit(state, unitid, p1);
2809 	case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
2810 	case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
2811 		return parse_clock_source_unit(state, unitid, p1);
2812 	case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
2813 	case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
2814 	case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
2815 	case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
2816 	case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
2817 		return parse_audio_selector_unit(state, unitid, p1);
2818 	case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
2819 	case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
2820 	case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT):
2821 		return parse_audio_feature_unit(state, unitid, p1);
2822 	case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
2823 	case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
2824 	case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
2825 		return parse_audio_processing_unit(state, unitid, p1);
2826 	case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
2827 	case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
2828 	case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
2829 		return parse_audio_extension_unit(state, unitid, p1);
2830 	case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
2831 	case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
2832 		return 0; /* FIXME - effect units not implemented yet */
2833 	default:
2834 		usb_audio_err(state->chip,
2835 			      "unit %u: unexpected type 0x%02x\n",
2836 			      unitid, p1[2]);
2837 		return -EINVAL;
2838 	}
2839 }
2840 
2841 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2842 {
2843 	/* kill pending URBs */
2844 	snd_usb_mixer_disconnect(mixer);
2845 
2846 	kfree(mixer->id_elems);
2847 	if (mixer->urb) {
2848 		kfree(mixer->urb->transfer_buffer);
2849 		usb_free_urb(mixer->urb);
2850 	}
2851 	usb_free_urb(mixer->rc_urb);
2852 	kfree(mixer->rc_setup_packet);
2853 	kfree(mixer);
2854 }
2855 
2856 static int snd_usb_mixer_dev_free(struct snd_device *device)
2857 {
2858 	struct usb_mixer_interface *mixer = device->device_data;
2859 	snd_usb_mixer_free(mixer);
2860 	return 0;
2861 }
2862 
2863 /* UAC3 predefined channels configuration */
2864 struct uac3_badd_profile {
2865 	int subclass;
2866 	const char *name;
2867 	int c_chmask;	/* capture channels mask */
2868 	int p_chmask;	/* playback channels mask */
2869 	int st_chmask;	/* side tone mixing channel mask */
2870 };
2871 
2872 static const struct uac3_badd_profile uac3_badd_profiles[] = {
2873 	{
2874 		/*
2875 		 * BAIF, BAOF or combination of both
2876 		 * IN: Mono or Stereo cfg, Mono alt possible
2877 		 * OUT: Mono or Stereo cfg, Mono alt possible
2878 		 */
2879 		.subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
2880 		.name = "GENERIC IO",
2881 		.c_chmask = -1,		/* dynamic channels */
2882 		.p_chmask = -1,		/* dynamic channels */
2883 	},
2884 	{
2885 		/* BAOF; Stereo only cfg, Mono alt possible */
2886 		.subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
2887 		.name = "HEADPHONE",
2888 		.p_chmask = 3,
2889 	},
2890 	{
2891 		/* BAOF; Mono or Stereo cfg, Mono alt possible */
2892 		.subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
2893 		.name = "SPEAKER",
2894 		.p_chmask = -1,		/* dynamic channels */
2895 	},
2896 	{
2897 		/* BAIF; Mono or Stereo cfg, Mono alt possible */
2898 		.subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
2899 		.name = "MICROPHONE",
2900 		.c_chmask = -1,		/* dynamic channels */
2901 	},
2902 	{
2903 		/*
2904 		 * BAIOF topology
2905 		 * IN: Mono only
2906 		 * OUT: Mono or Stereo cfg, Mono alt possible
2907 		 */
2908 		.subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
2909 		.name = "HEADSET",
2910 		.c_chmask = 1,
2911 		.p_chmask = -1,		/* dynamic channels */
2912 		.st_chmask = 1,
2913 	},
2914 	{
2915 		/* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
2916 		.subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
2917 		.name = "HEADSET ADAPTER",
2918 		.c_chmask = 1,
2919 		.p_chmask = 3,
2920 		.st_chmask = 1,
2921 	},
2922 	{
2923 		/* BAIF + BAOF; IN: Mono only; OUT: Mono only */
2924 		.subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
2925 		.name = "SPEAKERPHONE",
2926 		.c_chmask = 1,
2927 		.p_chmask = 1,
2928 	},
2929 	{ 0 } /* terminator */
2930 };
2931 
2932 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
2933 					      const struct uac3_badd_profile *f,
2934 					      int c_chmask, int p_chmask)
2935 {
2936 	/*
2937 	 * If both playback/capture channels are dynamic, make sure
2938 	 * at least one channel is present
2939 	 */
2940 	if (f->c_chmask < 0 && f->p_chmask < 0) {
2941 		if (!c_chmask && !p_chmask) {
2942 			usb_audio_warn(mixer->chip, "BAAD %s: no channels?",
2943 				       f->name);
2944 			return false;
2945 		}
2946 		return true;
2947 	}
2948 
2949 	if ((f->c_chmask < 0 && !c_chmask) ||
2950 	    (f->c_chmask >= 0 && f->c_chmask != c_chmask)) {
2951 		usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch",
2952 			       f->name);
2953 		return false;
2954 	}
2955 	if ((f->p_chmask < 0 && !p_chmask) ||
2956 	    (f->p_chmask >= 0 && f->p_chmask != p_chmask)) {
2957 		usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch",
2958 			       f->name);
2959 		return false;
2960 	}
2961 	return true;
2962 }
2963 
2964 /*
2965  * create mixer controls for UAC3 BADD profiles
2966  *
2967  * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
2968  *
2969  * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
2970  */
2971 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
2972 				       int ctrlif)
2973 {
2974 	struct usb_device *dev = mixer->chip->dev;
2975 	struct usb_interface_assoc_descriptor *assoc;
2976 	int badd_profile = mixer->chip->badd_profile;
2977 	const struct uac3_badd_profile *f;
2978 	const struct usbmix_ctl_map *map;
2979 	int p_chmask = 0, c_chmask = 0, st_chmask = 0;
2980 	int i;
2981 
2982 	assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
2983 
2984 	/* Detect BADD capture/playback channels from AS EP descriptors */
2985 	for (i = 0; i < assoc->bInterfaceCount; i++) {
2986 		int intf = assoc->bFirstInterface + i;
2987 
2988 		struct usb_interface *iface;
2989 		struct usb_host_interface *alts;
2990 		struct usb_interface_descriptor *altsd;
2991 		unsigned int maxpacksize;
2992 		char dir_in;
2993 		int chmask, num;
2994 
2995 		if (intf == ctrlif)
2996 			continue;
2997 
2998 		iface = usb_ifnum_to_if(dev, intf);
2999 		if (!iface)
3000 			continue;
3001 
3002 		num = iface->num_altsetting;
3003 
3004 		if (num < 2)
3005 			return -EINVAL;
3006 
3007 		/*
3008 		 * The number of Channels in an AudioStreaming interface
3009 		 * and the audio sample bit resolution (16 bits or 24
3010 		 * bits) can be derived from the wMaxPacketSize field in
3011 		 * the Standard AS Audio Data Endpoint descriptor in
3012 		 * Alternate Setting 1
3013 		 */
3014 		alts = &iface->altsetting[1];
3015 		altsd = get_iface_desc(alts);
3016 
3017 		if (altsd->bNumEndpoints < 1)
3018 			return -EINVAL;
3019 
3020 		/* check direction */
3021 		dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
3022 		maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3023 
3024 		switch (maxpacksize) {
3025 		default:
3026 			usb_audio_err(mixer->chip,
3027 				"incorrect wMaxPacketSize 0x%x for BADD profile\n",
3028 				maxpacksize);
3029 			return -EINVAL;
3030 		case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
3031 		case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
3032 		case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
3033 		case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
3034 			chmask = 1;
3035 			break;
3036 		case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
3037 		case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
3038 		case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
3039 		case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
3040 			chmask = 3;
3041 			break;
3042 		}
3043 
3044 		if (dir_in)
3045 			c_chmask = chmask;
3046 		else
3047 			p_chmask = chmask;
3048 	}
3049 
3050 	usb_audio_dbg(mixer->chip,
3051 		"UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
3052 		badd_profile, c_chmask, p_chmask);
3053 
3054 	/* check the mapping table */
3055 	for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
3056 		if (map->id == badd_profile)
3057 			break;
3058 	}
3059 
3060 	if (!map->id)
3061 		return -EINVAL;
3062 
3063 	for (f = uac3_badd_profiles; f->name; f++) {
3064 		if (badd_profile == f->subclass)
3065 			break;
3066 	}
3067 	if (!f->name)
3068 		return -EINVAL;
3069 	if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
3070 		return -EINVAL;
3071 	st_chmask = f->st_chmask;
3072 
3073 	/* Playback */
3074 	if (p_chmask) {
3075 		/* Master channel, always writable */
3076 		build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3077 				       UAC3_BADD_FU_ID2, map->map);
3078 		/* Mono/Stereo volume channels, always writable */
3079 		build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
3080 				       UAC3_BADD_FU_ID2, map->map);
3081 	}
3082 
3083 	/* Capture */
3084 	if (c_chmask) {
3085 		/* Master channel, always writable */
3086 		build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3087 				       UAC3_BADD_FU_ID5, map->map);
3088 		/* Mono/Stereo volume channels, always writable */
3089 		build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
3090 				       UAC3_BADD_FU_ID5, map->map);
3091 	}
3092 
3093 	/* Side tone-mixing */
3094 	if (st_chmask) {
3095 		/* Master channel, always writable */
3096 		build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3097 				       UAC3_BADD_FU_ID7, map->map);
3098 		/* Mono volume channel, always writable */
3099 		build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
3100 				       UAC3_BADD_FU_ID7, map->map);
3101 	}
3102 
3103 	/* Insertion Control */
3104 	if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
3105 		struct usb_audio_term iterm, oterm;
3106 
3107 		/* Input Term - Insertion control */
3108 		memset(&iterm, 0, sizeof(iterm));
3109 		iterm.id = UAC3_BADD_IT_ID4;
3110 		iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3111 		build_connector_control(mixer, map->map, &iterm, true);
3112 
3113 		/* Output Term - Insertion control */
3114 		memset(&oterm, 0, sizeof(oterm));
3115 		oterm.id = UAC3_BADD_OT_ID3;
3116 		oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3117 		build_connector_control(mixer, map->map, &oterm, false);
3118 	}
3119 
3120 	return 0;
3121 }
3122 
3123 /*
3124  * create mixer controls
3125  *
3126  * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3127  */
3128 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
3129 {
3130 	struct mixer_build state;
3131 	int err;
3132 	const struct usbmix_ctl_map *map;
3133 	void *p;
3134 
3135 	memset(&state, 0, sizeof(state));
3136 	state.chip = mixer->chip;
3137 	state.mixer = mixer;
3138 	state.buffer = mixer->hostif->extra;
3139 	state.buflen = mixer->hostif->extralen;
3140 
3141 	/* check the mapping table */
3142 	for (map = usbmix_ctl_maps; map->id; map++) {
3143 		if (map->id == state.chip->usb_id) {
3144 			state.map = map->map;
3145 			state.selector_map = map->selector_map;
3146 			mixer->connector_map = map->connector_map;
3147 			mixer->ignore_ctl_error |= map->ignore_ctl_error;
3148 			break;
3149 		}
3150 	}
3151 
3152 	p = NULL;
3153 	while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
3154 					    mixer->hostif->extralen,
3155 					    p, UAC_OUTPUT_TERMINAL)) != NULL) {
3156 		if (!snd_usb_validate_audio_desc(p, mixer->protocol))
3157 			continue; /* skip invalid descriptor */
3158 
3159 		if (mixer->protocol == UAC_VERSION_1) {
3160 			struct uac1_output_terminal_descriptor *desc = p;
3161 
3162 			/* mark terminal ID as visited */
3163 			set_bit(desc->bTerminalID, state.unitbitmap);
3164 			state.oterm.id = desc->bTerminalID;
3165 			state.oterm.type = le16_to_cpu(desc->wTerminalType);
3166 			state.oterm.name = desc->iTerminal;
3167 			err = parse_audio_unit(&state, desc->bSourceID);
3168 			if (err < 0 && err != -EINVAL)
3169 				return err;
3170 		} else if (mixer->protocol == UAC_VERSION_2) {
3171 			struct uac2_output_terminal_descriptor *desc = p;
3172 
3173 			/* mark terminal ID as visited */
3174 			set_bit(desc->bTerminalID, state.unitbitmap);
3175 			state.oterm.id = desc->bTerminalID;
3176 			state.oterm.type = le16_to_cpu(desc->wTerminalType);
3177 			state.oterm.name = desc->iTerminal;
3178 			err = parse_audio_unit(&state, desc->bSourceID);
3179 			if (err < 0 && err != -EINVAL)
3180 				return err;
3181 
3182 			/*
3183 			 * For UAC2, use the same approach to also add the
3184 			 * clock selectors
3185 			 */
3186 			err = parse_audio_unit(&state, desc->bCSourceID);
3187 			if (err < 0 && err != -EINVAL)
3188 				return err;
3189 
3190 			if ((state.oterm.type & 0xff00) != 0x0100 &&
3191 			    uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3192 							 UAC2_TE_CONNECTOR)) {
3193 				build_connector_control(state.mixer, state.map,
3194 							&state.oterm, false);
3195 			}
3196 		} else {  /* UAC_VERSION_3 */
3197 			struct uac3_output_terminal_descriptor *desc = p;
3198 
3199 			/* mark terminal ID as visited */
3200 			set_bit(desc->bTerminalID, state.unitbitmap);
3201 			state.oterm.id = desc->bTerminalID;
3202 			state.oterm.type = le16_to_cpu(desc->wTerminalType);
3203 			state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
3204 			err = parse_audio_unit(&state, desc->bSourceID);
3205 			if (err < 0 && err != -EINVAL)
3206 				return err;
3207 
3208 			/*
3209 			 * For UAC3, use the same approach to also add the
3210 			 * clock selectors
3211 			 */
3212 			err = parse_audio_unit(&state, desc->bCSourceID);
3213 			if (err < 0 && err != -EINVAL)
3214 				return err;
3215 
3216 			if ((state.oterm.type & 0xff00) != 0x0100 &&
3217 			    uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
3218 							 UAC3_TE_INSERTION)) {
3219 				build_connector_control(state.mixer, state.map,
3220 							&state.oterm, false);
3221 			}
3222 		}
3223 	}
3224 
3225 	return 0;
3226 }
3227 
3228 static int delegate_notify(struct usb_mixer_interface *mixer, int unitid,
3229 			   u8 *control, u8 *channel)
3230 {
3231 	const struct usbmix_connector_map *map = mixer->connector_map;
3232 
3233 	if (!map)
3234 		return unitid;
3235 
3236 	for (; map->id; map++) {
3237 		if (map->id == unitid) {
3238 			if (control && map->control)
3239 				*control = map->control;
3240 			if (channel && map->channel)
3241 				*channel = map->channel;
3242 			return map->delegated_id;
3243 		}
3244 	}
3245 	return unitid;
3246 }
3247 
3248 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3249 {
3250 	struct usb_mixer_elem_list *list;
3251 
3252 	unitid = delegate_notify(mixer, unitid, NULL, NULL);
3253 
3254 	for_each_mixer_elem(list, mixer, unitid) {
3255 		struct usb_mixer_elem_info *info;
3256 
3257 		if (!list->is_std_info)
3258 			continue;
3259 		info = mixer_elem_list_to_info(list);
3260 		/* invalidate cache, so the value is read from the device */
3261 		info->cached = 0;
3262 		snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3263 			       &list->kctl->id);
3264 	}
3265 }
3266 
3267 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3268 				    struct usb_mixer_elem_list *list)
3269 {
3270 	struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3271 	static const char * const val_types[] = {"BOOLEAN", "INV_BOOLEAN",
3272 				    "S8", "U8", "S16", "U16"};
3273 	snd_iprintf(buffer, "    Info: id=%i, control=%i, cmask=0x%x, "
3274 			    "channels=%i, type=\"%s\"\n", cval->head.id,
3275 			    cval->control, cval->cmask, cval->channels,
3276 			    val_types[cval->val_type]);
3277 	snd_iprintf(buffer, "    Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3278 			    cval->min, cval->max, cval->dBmin, cval->dBmax);
3279 }
3280 
3281 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
3282 				    struct snd_info_buffer *buffer)
3283 {
3284 	struct snd_usb_audio *chip = entry->private_data;
3285 	struct usb_mixer_interface *mixer;
3286 	struct usb_mixer_elem_list *list;
3287 	int unitid;
3288 
3289 	list_for_each_entry(mixer, &chip->mixer_list, list) {
3290 		snd_iprintf(buffer,
3291 			"USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3292 				chip->usb_id, mixer_ctrl_intf(mixer),
3293 				mixer->ignore_ctl_error);
3294 		snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
3295 		for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3296 			for_each_mixer_elem(list, mixer, unitid) {
3297 				snd_iprintf(buffer, "  Unit: %i\n", list->id);
3298 				if (list->kctl)
3299 					snd_iprintf(buffer,
3300 						    "    Control: name=\"%s\", index=%i\n",
3301 						    list->kctl->id.name,
3302 						    list->kctl->id.index);
3303 				if (list->dump)
3304 					list->dump(buffer, list);
3305 			}
3306 		}
3307 	}
3308 }
3309 
3310 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
3311 				       int attribute, int value, int index)
3312 {
3313 	struct usb_mixer_elem_list *list;
3314 	__u8 unitid = (index >> 8) & 0xff;
3315 	__u8 control = (value >> 8) & 0xff;
3316 	__u8 channel = value & 0xff;
3317 	unsigned int count = 0;
3318 
3319 	if (channel >= MAX_CHANNELS) {
3320 		usb_audio_dbg(mixer->chip,
3321 			"%s(): bogus channel number %d\n",
3322 			__func__, channel);
3323 		return;
3324 	}
3325 
3326 	unitid = delegate_notify(mixer, unitid, &control, &channel);
3327 
3328 	for_each_mixer_elem(list, mixer, unitid)
3329 		count++;
3330 
3331 	if (count == 0)
3332 		return;
3333 
3334 	for_each_mixer_elem(list, mixer, unitid) {
3335 		struct usb_mixer_elem_info *info;
3336 
3337 		if (!list->kctl)
3338 			continue;
3339 		if (!list->is_std_info)
3340 			continue;
3341 
3342 		info = mixer_elem_list_to_info(list);
3343 		if (count > 1 && info->control != control)
3344 			continue;
3345 
3346 		switch (attribute) {
3347 		case UAC2_CS_CUR:
3348 			/* invalidate cache, so the value is read from the device */
3349 			if (channel)
3350 				info->cached &= ~(1 << channel);
3351 			else /* master channel */
3352 				info->cached = 0;
3353 
3354 			snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3355 				       &info->head.kctl->id);
3356 			break;
3357 
3358 		case UAC2_CS_RANGE:
3359 			/* TODO */
3360 			break;
3361 
3362 		case UAC2_CS_MEM:
3363 			/* TODO */
3364 			break;
3365 
3366 		default:
3367 			usb_audio_dbg(mixer->chip,
3368 				"unknown attribute %d in interrupt\n",
3369 				attribute);
3370 			break;
3371 		} /* switch */
3372 	}
3373 }
3374 
3375 static void snd_usb_mixer_interrupt(struct urb *urb)
3376 {
3377 	struct usb_mixer_interface *mixer = urb->context;
3378 	int len = urb->actual_length;
3379 	int ustatus = urb->status;
3380 
3381 	if (ustatus != 0)
3382 		goto requeue;
3383 
3384 	if (mixer->protocol == UAC_VERSION_1) {
3385 		struct uac1_status_word *status;
3386 
3387 		for (status = urb->transfer_buffer;
3388 		     len >= sizeof(*status);
3389 		     len -= sizeof(*status), status++) {
3390 			dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3391 						status->bStatusType,
3392 						status->bOriginator);
3393 
3394 			/* ignore any notifications not from the control interface */
3395 			if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
3396 				UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3397 				continue;
3398 
3399 			if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
3400 				snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3401 			else
3402 				snd_usb_mixer_notify_id(mixer, status->bOriginator);
3403 		}
3404 	} else { /* UAC_VERSION_2 */
3405 		struct uac2_interrupt_data_msg *msg;
3406 
3407 		for (msg = urb->transfer_buffer;
3408 		     len >= sizeof(*msg);
3409 		     len -= sizeof(*msg), msg++) {
3410 			/* drop vendor specific and endpoint requests */
3411 			if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
3412 			    (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
3413 				continue;
3414 
3415 			snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
3416 						   le16_to_cpu(msg->wValue),
3417 						   le16_to_cpu(msg->wIndex));
3418 		}
3419 	}
3420 
3421 requeue:
3422 	if (ustatus != -ENOENT &&
3423 	    ustatus != -ECONNRESET &&
3424 	    ustatus != -ESHUTDOWN) {
3425 		urb->dev = mixer->chip->dev;
3426 		usb_submit_urb(urb, GFP_ATOMIC);
3427 	}
3428 }
3429 
3430 /* create the handler for the optional status interrupt endpoint */
3431 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
3432 {
3433 	struct usb_endpoint_descriptor *ep;
3434 	void *transfer_buffer;
3435 	int buffer_length;
3436 	unsigned int epnum;
3437 
3438 	/* we need one interrupt input endpoint */
3439 	if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3440 		return 0;
3441 	ep = get_endpoint(mixer->hostif, 0);
3442 	if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3443 		return 0;
3444 
3445 	epnum = usb_endpoint_num(ep);
3446 	buffer_length = le16_to_cpu(ep->wMaxPacketSize);
3447 	transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
3448 	if (!transfer_buffer)
3449 		return -ENOMEM;
3450 	mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
3451 	if (!mixer->urb) {
3452 		kfree(transfer_buffer);
3453 		return -ENOMEM;
3454 	}
3455 	usb_fill_int_urb(mixer->urb, mixer->chip->dev,
3456 			 usb_rcvintpipe(mixer->chip->dev, epnum),
3457 			 transfer_buffer, buffer_length,
3458 			 snd_usb_mixer_interrupt, mixer, ep->bInterval);
3459 	usb_submit_urb(mixer->urb, GFP_KERNEL);
3460 	return 0;
3461 }
3462 
3463 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
3464 			 int ignore_error)
3465 {
3466 	static const struct snd_device_ops dev_ops = {
3467 		.dev_free = snd_usb_mixer_dev_free
3468 	};
3469 	struct usb_mixer_interface *mixer;
3470 	int err;
3471 
3472 	strcpy(chip->card->mixername, "USB Mixer");
3473 
3474 	mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3475 	if (!mixer)
3476 		return -ENOMEM;
3477 	mixer->chip = chip;
3478 	mixer->ignore_ctl_error = ignore_error;
3479 	mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
3480 				  GFP_KERNEL);
3481 	if (!mixer->id_elems) {
3482 		kfree(mixer);
3483 		return -ENOMEM;
3484 	}
3485 
3486 	mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
3487 	switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3488 	case UAC_VERSION_1:
3489 	default:
3490 		mixer->protocol = UAC_VERSION_1;
3491 		break;
3492 	case UAC_VERSION_2:
3493 		mixer->protocol = UAC_VERSION_2;
3494 		break;
3495 	case UAC_VERSION_3:
3496 		mixer->protocol = UAC_VERSION_3;
3497 		break;
3498 	}
3499 
3500 	if (mixer->protocol == UAC_VERSION_3 &&
3501 			chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3502 		err = snd_usb_mixer_controls_badd(mixer, ctrlif);
3503 		if (err < 0)
3504 			goto _error;
3505 	} else {
3506 		err = snd_usb_mixer_controls(mixer);
3507 		if (err < 0)
3508 			goto _error;
3509 	}
3510 
3511 	err = snd_usb_mixer_status_create(mixer);
3512 	if (err < 0)
3513 		goto _error;
3514 
3515 	err = snd_usb_mixer_apply_create_quirk(mixer);
3516 	if (err < 0)
3517 		goto _error;
3518 
3519 	err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3520 	if (err < 0)
3521 		goto _error;
3522 
3523 	if (list_empty(&chip->mixer_list))
3524 		snd_card_ro_proc_new(chip->card, "usbmixer", chip,
3525 				     snd_usb_mixer_proc_read);
3526 
3527 	list_add(&mixer->list, &chip->mixer_list);
3528 	return 0;
3529 
3530 _error:
3531 	snd_usb_mixer_free(mixer);
3532 	return err;
3533 }
3534 
3535 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3536 {
3537 	if (mixer->disconnected)
3538 		return;
3539 	if (mixer->urb)
3540 		usb_kill_urb(mixer->urb);
3541 	if (mixer->rc_urb)
3542 		usb_kill_urb(mixer->rc_urb);
3543 	if (mixer->private_free)
3544 		mixer->private_free(mixer);
3545 	mixer->disconnected = true;
3546 }
3547 
3548 #ifdef CONFIG_PM
3549 /* stop any bus activity of a mixer */
3550 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
3551 {
3552 	usb_kill_urb(mixer->urb);
3553 	usb_kill_urb(mixer->rc_urb);
3554 }
3555 
3556 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
3557 {
3558 	int err;
3559 
3560 	if (mixer->urb) {
3561 		err = usb_submit_urb(mixer->urb, GFP_NOIO);
3562 		if (err < 0)
3563 			return err;
3564 	}
3565 
3566 	return 0;
3567 }
3568 
3569 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
3570 {
3571 	snd_usb_mixer_inactivate(mixer);
3572 	if (mixer->private_suspend)
3573 		mixer->private_suspend(mixer);
3574 	return 0;
3575 }
3576 
3577 static int restore_mixer_value(struct usb_mixer_elem_list *list)
3578 {
3579 	struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3580 	int c, err, idx;
3581 
3582 	if (cval->cmask) {
3583 		idx = 0;
3584 		for (c = 0; c < MAX_CHANNELS; c++) {
3585 			if (!(cval->cmask & (1 << c)))
3586 				continue;
3587 			if (cval->cached & (1 << (c + 1))) {
3588 				err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3589 							cval->cache_val[idx]);
3590 				if (err < 0)
3591 					return err;
3592 			}
3593 			idx++;
3594 		}
3595 	} else {
3596 		/* master */
3597 		if (cval->cached) {
3598 			err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3599 			if (err < 0)
3600 				return err;
3601 		}
3602 	}
3603 
3604 	return 0;
3605 }
3606 
3607 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
3608 {
3609 	struct usb_mixer_elem_list *list;
3610 	int id, err;
3611 
3612 	if (reset_resume) {
3613 		/* restore cached mixer values */
3614 		for (id = 0; id < MAX_ID_ELEMS; id++) {
3615 			for_each_mixer_elem(list, mixer, id) {
3616 				if (list->resume) {
3617 					err = list->resume(list);
3618 					if (err < 0)
3619 						return err;
3620 				}
3621 			}
3622 		}
3623 	}
3624 
3625 	snd_usb_mixer_resume_quirk(mixer);
3626 
3627 	return snd_usb_mixer_activate(mixer);
3628 }
3629 #endif
3630 
3631 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
3632 				 struct usb_mixer_interface *mixer,
3633 				 int unitid)
3634 {
3635 	list->mixer = mixer;
3636 	list->id = unitid;
3637 	list->dump = snd_usb_mixer_dump_cval;
3638 #ifdef CONFIG_PM
3639 	list->resume = restore_mixer_value;
3640 #endif
3641 }
3642