xref: /openbmc/linux/sound/usb/mixer.c (revision 2d972b6a)
1 /*
2  *   (Tentative) USB Audio Driver for ALSA
3  *
4  *   Mixer control part
5  *
6  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
7  *
8  *   Many codes borrowed from audio.c by
9  *	    Alan Cox (alan@lxorguk.ukuu.org.uk)
10  *	    Thomas Sailer (sailer@ife.ee.ethz.ch)
11  *
12  *
13  *   This program is free software; you can redistribute it and/or modify
14  *   it under the terms of the GNU General Public License as published by
15  *   the Free Software Foundation; either version 2 of the License, or
16  *   (at your option) any later version.
17  *
18  *   This program is distributed in the hope that it will be useful,
19  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
20  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  *   GNU General Public License for more details.
22  *
23  *   You should have received a copy of the GNU General Public License
24  *   along with this program; if not, write to the Free Software
25  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
26  *
27  */
28 
29 /*
30  * TODOs, for both the mixer and the streaming interfaces:
31  *
32  *  - support for UAC2 effect units
33  *  - support for graphical equalizers
34  *  - RANGE and MEM set commands (UAC2)
35  *  - RANGE and MEM interrupt dispatchers (UAC2)
36  *  - audio channel clustering (UAC2)
37  *  - audio sample rate converter units (UAC2)
38  *  - proper handling of clock multipliers (UAC2)
39  *  - dispatch clock change notifications (UAC2)
40  *  	- stop PCM streams which use a clock that became invalid
41  *  	- stop PCM streams which use a clock selector that has changed
42  *  	- parse available sample rates again when clock sources changed
43  */
44 
45 #include <linux/bitops.h>
46 #include <linux/init.h>
47 #include <linux/list.h>
48 #include <linux/log2.h>
49 #include <linux/slab.h>
50 #include <linux/string.h>
51 #include <linux/usb.h>
52 #include <linux/usb/audio.h>
53 #include <linux/usb/audio-v2.h>
54 #include <linux/usb/audio-v3.h>
55 
56 #include <sound/core.h>
57 #include <sound/control.h>
58 #include <sound/hwdep.h>
59 #include <sound/info.h>
60 #include <sound/tlv.h>
61 
62 #include "usbaudio.h"
63 #include "mixer.h"
64 #include "helper.h"
65 #include "mixer_quirks.h"
66 #include "power.h"
67 
68 #define MAX_ID_ELEMS	256
69 
70 struct usb_audio_term {
71 	int id;
72 	int type;
73 	int channels;
74 	unsigned int chconfig;
75 	int name;
76 };
77 
78 struct usbmix_name_map;
79 
80 struct mixer_build {
81 	struct snd_usb_audio *chip;
82 	struct usb_mixer_interface *mixer;
83 	unsigned char *buffer;
84 	unsigned int buflen;
85 	DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
86 	struct usb_audio_term oterm;
87 	const struct usbmix_name_map *map;
88 	const struct usbmix_selector_map *selector_map;
89 };
90 
91 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
92 enum {
93 	USB_XU_CLOCK_RATE 		= 0xe301,
94 	USB_XU_CLOCK_SOURCE		= 0xe302,
95 	USB_XU_DIGITAL_IO_STATUS	= 0xe303,
96 	USB_XU_DEVICE_OPTIONS		= 0xe304,
97 	USB_XU_DIRECT_MONITORING	= 0xe305,
98 	USB_XU_METERING			= 0xe306
99 };
100 enum {
101 	USB_XU_CLOCK_SOURCE_SELECTOR = 0x02,	/* clock source*/
102 	USB_XU_CLOCK_RATE_SELECTOR = 0x03,	/* clock rate */
103 	USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01,	/* the spdif format */
104 	USB_XU_SOFT_LIMIT_SELECTOR = 0x03	/* soft limiter */
105 };
106 
107 /*
108  * manual mapping of mixer names
109  * if the mixer topology is too complicated and the parsed names are
110  * ambiguous, add the entries in usbmixer_maps.c.
111  */
112 #include "mixer_maps.c"
113 
114 static const struct usbmix_name_map *
115 find_map(struct mixer_build *state, int unitid, int control)
116 {
117 	const struct usbmix_name_map *p = state->map;
118 
119 	if (!p)
120 		return NULL;
121 
122 	for (p = state->map; p->id; p++) {
123 		if (p->id == unitid &&
124 		    (!control || !p->control || control == p->control))
125 			return p;
126 	}
127 	return NULL;
128 }
129 
130 /* get the mapped name if the unit matches */
131 static int
132 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
133 {
134 	if (!p || !p->name)
135 		return 0;
136 
137 	buflen--;
138 	return strlcpy(buf, p->name, buflen);
139 }
140 
141 /* ignore the error value if ignore_ctl_error flag is set */
142 #define filter_error(cval, err) \
143 	((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
144 
145 /* check whether the control should be ignored */
146 static inline int
147 check_ignored_ctl(const struct usbmix_name_map *p)
148 {
149 	if (!p || p->name || p->dB)
150 		return 0;
151 	return 1;
152 }
153 
154 /* dB mapping */
155 static inline void check_mapped_dB(const struct usbmix_name_map *p,
156 				   struct usb_mixer_elem_info *cval)
157 {
158 	if (p && p->dB) {
159 		cval->dBmin = p->dB->min;
160 		cval->dBmax = p->dB->max;
161 		cval->initialized = 1;
162 	}
163 }
164 
165 /* get the mapped selector source name */
166 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
167 				      int index, char *buf, int buflen)
168 {
169 	const struct usbmix_selector_map *p;
170 
171 	if (!state->selector_map)
172 		return 0;
173 	for (p = state->selector_map; p->id; p++) {
174 		if (p->id == unitid && index < p->count)
175 			return strlcpy(buf, p->names[index], buflen);
176 	}
177 	return 0;
178 }
179 
180 /*
181  * find an audio control unit with the given unit id
182  */
183 static void *find_audio_control_unit(struct mixer_build *state,
184 				     unsigned char unit)
185 {
186 	/* we just parse the header */
187 	struct uac_feature_unit_descriptor *hdr = NULL;
188 
189 	while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
190 					USB_DT_CS_INTERFACE)) != NULL) {
191 		if (hdr->bLength >= 4 &&
192 		    hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
193 		    hdr->bDescriptorSubtype <= UAC3_SAMPLE_RATE_CONVERTER &&
194 		    hdr->bUnitID == unit)
195 			return hdr;
196 	}
197 
198 	return NULL;
199 }
200 
201 /*
202  * copy a string with the given id
203  */
204 static int snd_usb_copy_string_desc(struct mixer_build *state,
205 				    int index, char *buf, int maxlen)
206 {
207 	int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
208 
209 	if (len < 0)
210 		return 0;
211 
212 	buf[len] = 0;
213 	return len;
214 }
215 
216 /*
217  * convert from the byte/word on usb descriptor to the zero-based integer
218  */
219 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
220 {
221 	switch (cval->val_type) {
222 	case USB_MIXER_BOOLEAN:
223 		return !!val;
224 	case USB_MIXER_INV_BOOLEAN:
225 		return !val;
226 	case USB_MIXER_U8:
227 		val &= 0xff;
228 		break;
229 	case USB_MIXER_S8:
230 		val &= 0xff;
231 		if (val >= 0x80)
232 			val -= 0x100;
233 		break;
234 	case USB_MIXER_U16:
235 		val &= 0xffff;
236 		break;
237 	case USB_MIXER_S16:
238 		val &= 0xffff;
239 		if (val >= 0x8000)
240 			val -= 0x10000;
241 		break;
242 	}
243 	return val;
244 }
245 
246 /*
247  * convert from the zero-based int to the byte/word for usb descriptor
248  */
249 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
250 {
251 	switch (cval->val_type) {
252 	case USB_MIXER_BOOLEAN:
253 		return !!val;
254 	case USB_MIXER_INV_BOOLEAN:
255 		return !val;
256 	case USB_MIXER_S8:
257 	case USB_MIXER_U8:
258 		return val & 0xff;
259 	case USB_MIXER_S16:
260 	case USB_MIXER_U16:
261 		return val & 0xffff;
262 	}
263 	return 0; /* not reached */
264 }
265 
266 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
267 {
268 	if (!cval->res)
269 		cval->res = 1;
270 	if (val < cval->min)
271 		return 0;
272 	else if (val >= cval->max)
273 		return (cval->max - cval->min + cval->res - 1) / cval->res;
274 	else
275 		return (val - cval->min) / cval->res;
276 }
277 
278 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
279 {
280 	if (val < 0)
281 		return cval->min;
282 	if (!cval->res)
283 		cval->res = 1;
284 	val *= cval->res;
285 	val += cval->min;
286 	if (val > cval->max)
287 		return cval->max;
288 	return val;
289 }
290 
291 static int uac2_ctl_value_size(int val_type)
292 {
293 	switch (val_type) {
294 	case USB_MIXER_S32:
295 	case USB_MIXER_U32:
296 		return 4;
297 	case USB_MIXER_S16:
298 	case USB_MIXER_U16:
299 		return 2;
300 	default:
301 		return 1;
302 	}
303 	return 0; /* unreachable */
304 }
305 
306 
307 /*
308  * retrieve a mixer value
309  */
310 
311 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
312 			    int validx, int *value_ret)
313 {
314 	struct snd_usb_audio *chip = cval->head.mixer->chip;
315 	unsigned char buf[2];
316 	int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
317 	int timeout = 10;
318 	int idx = 0, err;
319 
320 	err = snd_usb_lock_shutdown(chip);
321 	if (err < 0)
322 		return -EIO;
323 
324 	while (timeout-- > 0) {
325 		idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
326 		err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
327 				      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
328 				      validx, idx, buf, val_len);
329 		if (err >= val_len) {
330 			*value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
331 			err = 0;
332 			goto out;
333 		} else if (err == -ETIMEDOUT) {
334 			goto out;
335 		}
336 	}
337 	usb_audio_dbg(chip,
338 		"cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
339 		request, validx, idx, cval->val_type);
340 	err = -EINVAL;
341 
342  out:
343 	snd_usb_unlock_shutdown(chip);
344 	return err;
345 }
346 
347 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
348 			    int validx, int *value_ret)
349 {
350 	struct snd_usb_audio *chip = cval->head.mixer->chip;
351 	/* enough space for one range */
352 	unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
353 	unsigned char *val;
354 	int idx = 0, ret, val_size, size;
355 	__u8 bRequest;
356 
357 	val_size = uac2_ctl_value_size(cval->val_type);
358 
359 	if (request == UAC_GET_CUR) {
360 		bRequest = UAC2_CS_CUR;
361 		size = val_size;
362 	} else {
363 		bRequest = UAC2_CS_RANGE;
364 		size = sizeof(__u16) + 3 * val_size;
365 	}
366 
367 	memset(buf, 0, sizeof(buf));
368 
369 	ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
370 	if (ret)
371 		goto error;
372 
373 	idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
374 	ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
375 			      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
376 			      validx, idx, buf, size);
377 	snd_usb_unlock_shutdown(chip);
378 
379 	if (ret < 0) {
380 error:
381 		usb_audio_err(chip,
382 			"cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
383 			request, validx, idx, cval->val_type);
384 		return ret;
385 	}
386 
387 	/* FIXME: how should we handle multiple triplets here? */
388 
389 	switch (request) {
390 	case UAC_GET_CUR:
391 		val = buf;
392 		break;
393 	case UAC_GET_MIN:
394 		val = buf + sizeof(__u16);
395 		break;
396 	case UAC_GET_MAX:
397 		val = buf + sizeof(__u16) + val_size;
398 		break;
399 	case UAC_GET_RES:
400 		val = buf + sizeof(__u16) + val_size * 2;
401 		break;
402 	default:
403 		return -EINVAL;
404 	}
405 
406 	*value_ret = convert_signed_value(cval,
407 					  snd_usb_combine_bytes(val, val_size));
408 
409 	return 0;
410 }
411 
412 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
413 			 int validx, int *value_ret)
414 {
415 	validx += cval->idx_off;
416 
417 	return (cval->head.mixer->protocol == UAC_VERSION_1) ?
418 		get_ctl_value_v1(cval, request, validx, value_ret) :
419 		get_ctl_value_v2(cval, request, validx, value_ret);
420 }
421 
422 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
423 			     int validx, int *value)
424 {
425 	return get_ctl_value(cval, UAC_GET_CUR, validx, value);
426 }
427 
428 /* channel = 0: master, 1 = first channel */
429 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
430 				  int channel, int *value)
431 {
432 	return get_ctl_value(cval, UAC_GET_CUR,
433 			     (cval->control << 8) | channel,
434 			     value);
435 }
436 
437 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
438 			     int channel, int index, int *value)
439 {
440 	int err;
441 
442 	if (cval->cached & (1 << channel)) {
443 		*value = cval->cache_val[index];
444 		return 0;
445 	}
446 	err = get_cur_mix_raw(cval, channel, value);
447 	if (err < 0) {
448 		if (!cval->head.mixer->ignore_ctl_error)
449 			usb_audio_dbg(cval->head.mixer->chip,
450 				"cannot get current value for control %d ch %d: err = %d\n",
451 				      cval->control, channel, err);
452 		return err;
453 	}
454 	cval->cached |= 1 << channel;
455 	cval->cache_val[index] = *value;
456 	return 0;
457 }
458 
459 /*
460  * set a mixer value
461  */
462 
463 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
464 				int request, int validx, int value_set)
465 {
466 	struct snd_usb_audio *chip = cval->head.mixer->chip;
467 	unsigned char buf[4];
468 	int idx = 0, val_len, err, timeout = 10;
469 
470 	validx += cval->idx_off;
471 
472 
473 	if (cval->head.mixer->protocol == UAC_VERSION_1) {
474 		val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
475 	} else { /* UAC_VERSION_2/3 */
476 		val_len = uac2_ctl_value_size(cval->val_type);
477 
478 		/* FIXME */
479 		if (request != UAC_SET_CUR) {
480 			usb_audio_dbg(chip, "RANGE setting not yet supported\n");
481 			return -EINVAL;
482 		}
483 
484 		request = UAC2_CS_CUR;
485 	}
486 
487 	value_set = convert_bytes_value(cval, value_set);
488 	buf[0] = value_set & 0xff;
489 	buf[1] = (value_set >> 8) & 0xff;
490 	buf[2] = (value_set >> 16) & 0xff;
491 	buf[3] = (value_set >> 24) & 0xff;
492 
493 	err = snd_usb_lock_shutdown(chip);
494 	if (err < 0)
495 		return -EIO;
496 
497 	while (timeout-- > 0) {
498 		idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
499 		err = snd_usb_ctl_msg(chip->dev,
500 				      usb_sndctrlpipe(chip->dev, 0), request,
501 				      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
502 				      validx, idx, buf, val_len);
503 		if (err >= 0) {
504 			err = 0;
505 			goto out;
506 		} else if (err == -ETIMEDOUT) {
507 			goto out;
508 		}
509 	}
510 	usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
511 		      request, validx, idx, cval->val_type, buf[0], buf[1]);
512 	err = -EINVAL;
513 
514  out:
515 	snd_usb_unlock_shutdown(chip);
516 	return err;
517 }
518 
519 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
520 			     int validx, int value)
521 {
522 	return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
523 }
524 
525 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
526 			     int index, int value)
527 {
528 	int err;
529 	unsigned int read_only = (channel == 0) ?
530 		cval->master_readonly :
531 		cval->ch_readonly & (1 << (channel - 1));
532 
533 	if (read_only) {
534 		usb_audio_dbg(cval->head.mixer->chip,
535 			      "%s(): channel %d of control %d is read_only\n",
536 			    __func__, channel, cval->control);
537 		return 0;
538 	}
539 
540 	err = snd_usb_mixer_set_ctl_value(cval,
541 					  UAC_SET_CUR, (cval->control << 8) | channel,
542 					  value);
543 	if (err < 0)
544 		return err;
545 	cval->cached |= 1 << channel;
546 	cval->cache_val[index] = value;
547 	return 0;
548 }
549 
550 /*
551  * TLV callback for mixer volume controls
552  */
553 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
554 			 unsigned int size, unsigned int __user *_tlv)
555 {
556 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
557 	DECLARE_TLV_DB_MINMAX(scale, 0, 0);
558 
559 	if (size < sizeof(scale))
560 		return -ENOMEM;
561 	if (cval->min_mute)
562 		scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE;
563 	scale[2] = cval->dBmin;
564 	scale[3] = cval->dBmax;
565 	if (copy_to_user(_tlv, scale, sizeof(scale)))
566 		return -EFAULT;
567 	return 0;
568 }
569 
570 /*
571  * parser routines begin here...
572  */
573 
574 static int parse_audio_unit(struct mixer_build *state, int unitid);
575 
576 
577 /*
578  * check if the input/output channel routing is enabled on the given bitmap.
579  * used for mixer unit parser
580  */
581 static int check_matrix_bitmap(unsigned char *bmap,
582 			       int ich, int och, int num_outs)
583 {
584 	int idx = ich * num_outs + och;
585 	return bmap[idx >> 3] & (0x80 >> (idx & 7));
586 }
587 
588 /*
589  * add an alsa control element
590  * search and increment the index until an empty slot is found.
591  *
592  * if failed, give up and free the control instance.
593  */
594 
595 int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
596 			      struct snd_kcontrol *kctl)
597 {
598 	struct usb_mixer_interface *mixer = list->mixer;
599 	int err;
600 
601 	while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
602 		kctl->id.index++;
603 	if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
604 		usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
605 			      err);
606 		return err;
607 	}
608 	list->kctl = kctl;
609 	list->next_id_elem = mixer->id_elems[list->id];
610 	mixer->id_elems[list->id] = list;
611 	return 0;
612 }
613 
614 /*
615  * get a terminal name string
616  */
617 
618 static struct iterm_name_combo {
619 	int type;
620 	char *name;
621 } iterm_names[] = {
622 	{ 0x0300, "Output" },
623 	{ 0x0301, "Speaker" },
624 	{ 0x0302, "Headphone" },
625 	{ 0x0303, "HMD Audio" },
626 	{ 0x0304, "Desktop Speaker" },
627 	{ 0x0305, "Room Speaker" },
628 	{ 0x0306, "Com Speaker" },
629 	{ 0x0307, "LFE" },
630 	{ 0x0600, "External In" },
631 	{ 0x0601, "Analog In" },
632 	{ 0x0602, "Digital In" },
633 	{ 0x0603, "Line" },
634 	{ 0x0604, "Legacy In" },
635 	{ 0x0605, "IEC958 In" },
636 	{ 0x0606, "1394 DA Stream" },
637 	{ 0x0607, "1394 DV Stream" },
638 	{ 0x0700, "Embedded" },
639 	{ 0x0701, "Noise Source" },
640 	{ 0x0702, "Equalization Noise" },
641 	{ 0x0703, "CD" },
642 	{ 0x0704, "DAT" },
643 	{ 0x0705, "DCC" },
644 	{ 0x0706, "MiniDisk" },
645 	{ 0x0707, "Analog Tape" },
646 	{ 0x0708, "Phonograph" },
647 	{ 0x0709, "VCR Audio" },
648 	{ 0x070a, "Video Disk Audio" },
649 	{ 0x070b, "DVD Audio" },
650 	{ 0x070c, "TV Tuner Audio" },
651 	{ 0x070d, "Satellite Rec Audio" },
652 	{ 0x070e, "Cable Tuner Audio" },
653 	{ 0x070f, "DSS Audio" },
654 	{ 0x0710, "Radio Receiver" },
655 	{ 0x0711, "Radio Transmitter" },
656 	{ 0x0712, "Multi-Track Recorder" },
657 	{ 0x0713, "Synthesizer" },
658 	{ 0 },
659 };
660 
661 static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
662 			 unsigned char *name, int maxlen, int term_only)
663 {
664 	struct iterm_name_combo *names;
665 	int len;
666 
667 	if (iterm->name) {
668 		len = snd_usb_copy_string_desc(state, iterm->name,
669 						name, maxlen);
670 		if (len)
671 			return len;
672 	}
673 
674 	/* virtual type - not a real terminal */
675 	if (iterm->type >> 16) {
676 		if (term_only)
677 			return 0;
678 		switch (iterm->type >> 16) {
679 		case UAC_SELECTOR_UNIT:
680 			strcpy(name, "Selector");
681 			return 8;
682 		case UAC1_PROCESSING_UNIT:
683 			strcpy(name, "Process Unit");
684 			return 12;
685 		case UAC1_EXTENSION_UNIT:
686 			strcpy(name, "Ext Unit");
687 			return 8;
688 		case UAC_MIXER_UNIT:
689 			strcpy(name, "Mixer");
690 			return 5;
691 		default:
692 			return sprintf(name, "Unit %d", iterm->id);
693 		}
694 	}
695 
696 	switch (iterm->type & 0xff00) {
697 	case 0x0100:
698 		strcpy(name, "PCM");
699 		return 3;
700 	case 0x0200:
701 		strcpy(name, "Mic");
702 		return 3;
703 	case 0x0400:
704 		strcpy(name, "Headset");
705 		return 7;
706 	case 0x0500:
707 		strcpy(name, "Phone");
708 		return 5;
709 	}
710 
711 	for (names = iterm_names; names->type; names++) {
712 		if (names->type == iterm->type) {
713 			strcpy(name, names->name);
714 			return strlen(names->name);
715 		}
716 	}
717 
718 	return 0;
719 }
720 
721 /*
722  * parse the source unit recursively until it reaches to a terminal
723  * or a branched unit.
724  */
725 static int check_input_term(struct mixer_build *state, int id,
726 			    struct usb_audio_term *term)
727 {
728 	int protocol = state->mixer->protocol;
729 	int err;
730 	void *p1;
731 
732 	memset(term, 0, sizeof(*term));
733 	while ((p1 = find_audio_control_unit(state, id)) != NULL) {
734 		unsigned char *hdr = p1;
735 		term->id = id;
736 
737 		if (protocol == UAC_VERSION_1 || protocol == UAC_VERSION_2) {
738 			switch (hdr[2]) {
739 			case UAC_INPUT_TERMINAL:
740 				if (protocol == UAC_VERSION_1) {
741 					struct uac_input_terminal_descriptor *d = p1;
742 
743 					term->type = le16_to_cpu(d->wTerminalType);
744 					term->channels = d->bNrChannels;
745 					term->chconfig = le16_to_cpu(d->wChannelConfig);
746 					term->name = d->iTerminal;
747 				} else { /* UAC_VERSION_2 */
748 					struct uac2_input_terminal_descriptor *d = p1;
749 
750 					/* call recursively to verify that the
751 					 * referenced clock entity is valid */
752 					err = check_input_term(state, d->bCSourceID, term);
753 					if (err < 0)
754 						return err;
755 
756 					/* save input term properties after recursion,
757 					 * to ensure they are not overriden by the
758 					 * recursion calls */
759 					term->id = id;
760 					term->type = le16_to_cpu(d->wTerminalType);
761 					term->channels = d->bNrChannels;
762 					term->chconfig = le32_to_cpu(d->bmChannelConfig);
763 					term->name = d->iTerminal;
764 				}
765 				return 0;
766 			case UAC_FEATURE_UNIT: {
767 				/* the header is the same for v1 and v2 */
768 				struct uac_feature_unit_descriptor *d = p1;
769 
770 				id = d->bSourceID;
771 				break; /* continue to parse */
772 			}
773 			case UAC_MIXER_UNIT: {
774 				struct uac_mixer_unit_descriptor *d = p1;
775 
776 				term->type = d->bDescriptorSubtype << 16; /* virtual type */
777 				term->channels = uac_mixer_unit_bNrChannels(d);
778 				term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
779 				term->name = uac_mixer_unit_iMixer(d);
780 				return 0;
781 			}
782 			case UAC_SELECTOR_UNIT:
783 			case UAC2_CLOCK_SELECTOR: {
784 				struct uac_selector_unit_descriptor *d = p1;
785 				/* call recursively to retrieve the channel info */
786 				err = check_input_term(state, d->baSourceID[0], term);
787 				if (err < 0)
788 					return err;
789 				term->type = d->bDescriptorSubtype << 16; /* virtual type */
790 				term->id = id;
791 				term->name = uac_selector_unit_iSelector(d);
792 				return 0;
793 			}
794 			case UAC1_PROCESSING_UNIT:
795 			case UAC1_EXTENSION_UNIT:
796 			/* UAC2_PROCESSING_UNIT_V2 */
797 			/* UAC2_EFFECT_UNIT */
798 			case UAC2_EXTENSION_UNIT_V2: {
799 				struct uac_processing_unit_descriptor *d = p1;
800 
801 				if (protocol == UAC_VERSION_2 &&
802 					hdr[2] == UAC2_EFFECT_UNIT) {
803 					/* UAC2/UAC1 unit IDs overlap here in an
804 					 * uncompatible way. Ignore this unit for now.
805 					 */
806 					return 0;
807 				}
808 
809 				if (d->bNrInPins) {
810 					id = d->baSourceID[0];
811 					break; /* continue to parse */
812 				}
813 				term->type = d->bDescriptorSubtype << 16; /* virtual type */
814 				term->channels = uac_processing_unit_bNrChannels(d);
815 				term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
816 				term->name = uac_processing_unit_iProcessing(d, protocol);
817 				return 0;
818 			}
819 			case UAC2_CLOCK_SOURCE: {
820 				struct uac_clock_source_descriptor *d = p1;
821 
822 				term->type = d->bDescriptorSubtype << 16; /* virtual type */
823 				term->id = id;
824 				term->name = d->iClockSource;
825 				return 0;
826 			}
827 			default:
828 				return -ENODEV;
829 			}
830 		} else { /* UAC_VERSION_3 */
831 			switch (hdr[2]) {
832 			case UAC_INPUT_TERMINAL: {
833 				struct uac3_input_terminal_descriptor *d = p1;
834 
835 				/* call recursively to verify that the
836 				 * referenced clock entity is valid */
837 				err = check_input_term(state, d->bCSourceID, term);
838 				if (err < 0)
839 					return err;
840 
841 				/* save input term properties after recursion,
842 				 * to ensure they are not overriden by the
843 				 * recursion calls */
844 				term->id = id;
845 				term->type = le16_to_cpu(d->wTerminalType);
846 
847 				/* REVISIT: UAC3 IT doesn't have channels/cfg */
848 				term->channels = 0;
849 				term->chconfig = 0;
850 
851 				term->name = le16_to_cpu(d->wTerminalDescrStr);
852 				return 0;
853 			}
854 			case UAC3_FEATURE_UNIT: {
855 				struct uac3_feature_unit_descriptor *d = p1;
856 
857 				id = d->bSourceID;
858 				break; /* continue to parse */
859 			}
860 			case UAC3_CLOCK_SOURCE: {
861 				struct uac3_clock_source_descriptor *d = p1;
862 
863 				term->type = d->bDescriptorSubtype << 16; /* virtual type */
864 				term->id = id;
865 				term->name = le16_to_cpu(d->wClockSourceStr);
866 				return 0;
867 			}
868 			default:
869 				return -ENODEV;
870 			}
871 		}
872 	}
873 	return -ENODEV;
874 }
875 
876 /*
877  * Feature Unit
878  */
879 
880 /* feature unit control information */
881 struct usb_feature_control_info {
882 	int control;
883 	const char *name;
884 	int type;	/* data type for uac1 */
885 	int type_uac2;	/* data type for uac2 if different from uac1, else -1 */
886 };
887 
888 static struct usb_feature_control_info audio_feature_info[] = {
889 	{ UAC_FU_MUTE,			"Mute",			USB_MIXER_INV_BOOLEAN, -1 },
890 	{ UAC_FU_VOLUME,		"Volume",		USB_MIXER_S16, -1 },
891 	{ UAC_FU_BASS,			"Tone Control - Bass",	USB_MIXER_S8, -1 },
892 	{ UAC_FU_MID,			"Tone Control - Mid",	USB_MIXER_S8, -1 },
893 	{ UAC_FU_TREBLE,		"Tone Control - Treble", USB_MIXER_S8, -1 },
894 	{ UAC_FU_GRAPHIC_EQUALIZER,	"Graphic Equalizer",	USB_MIXER_S8, -1 }, /* FIXME: not implemented yet */
895 	{ UAC_FU_AUTOMATIC_GAIN,	"Auto Gain Control",	USB_MIXER_BOOLEAN, -1 },
896 	{ UAC_FU_DELAY,			"Delay Control",	USB_MIXER_U16, USB_MIXER_U32 },
897 	{ UAC_FU_BASS_BOOST,		"Bass Boost",		USB_MIXER_BOOLEAN, -1 },
898 	{ UAC_FU_LOUDNESS,		"Loudness",		USB_MIXER_BOOLEAN, -1 },
899 	/* UAC2 specific */
900 	{ UAC2_FU_INPUT_GAIN,		"Input Gain Control",	USB_MIXER_S16, -1 },
901 	{ UAC2_FU_INPUT_GAIN_PAD,	"Input Gain Pad Control", USB_MIXER_S16, -1 },
902 	{ UAC2_FU_PHASE_INVERTER,	 "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
903 };
904 
905 /* private_free callback */
906 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
907 {
908 	kfree(kctl->private_data);
909 	kctl->private_data = NULL;
910 }
911 
912 /*
913  * interface to ALSA control for feature/mixer units
914  */
915 
916 /* volume control quirks */
917 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
918 				  struct snd_kcontrol *kctl)
919 {
920 	struct snd_usb_audio *chip = cval->head.mixer->chip;
921 	switch (chip->usb_id) {
922 	case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
923 	case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
924 		if (strcmp(kctl->id.name, "Effect Duration") == 0) {
925 			cval->min = 0x0000;
926 			cval->max = 0xffff;
927 			cval->res = 0x00e6;
928 			break;
929 		}
930 		if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
931 		    strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
932 			cval->min = 0x00;
933 			cval->max = 0xff;
934 			break;
935 		}
936 		if (strstr(kctl->id.name, "Effect Return") != NULL) {
937 			cval->min = 0xb706;
938 			cval->max = 0xff7b;
939 			cval->res = 0x0073;
940 			break;
941 		}
942 		if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
943 			(strstr(kctl->id.name, "Effect Send") != NULL)) {
944 			cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
945 			cval->max = 0xfcfe;
946 			cval->res = 0x0073;
947 		}
948 		break;
949 
950 	case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
951 	case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
952 		if (strcmp(kctl->id.name, "Effect Duration") == 0) {
953 			usb_audio_info(chip,
954 				       "set quirk for FTU Effect Duration\n");
955 			cval->min = 0x0000;
956 			cval->max = 0x7f00;
957 			cval->res = 0x0100;
958 			break;
959 		}
960 		if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
961 		    strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
962 			usb_audio_info(chip,
963 				       "set quirks for FTU Effect Feedback/Volume\n");
964 			cval->min = 0x00;
965 			cval->max = 0x7f;
966 			break;
967 		}
968 		break;
969 
970 	case USB_ID(0x0471, 0x0101):
971 	case USB_ID(0x0471, 0x0104):
972 	case USB_ID(0x0471, 0x0105):
973 	case USB_ID(0x0672, 0x1041):
974 	/* quirk for UDA1321/N101.
975 	 * note that detection between firmware 2.1.1.7 (N101)
976 	 * and later 2.1.1.21 is not very clear from datasheets.
977 	 * I hope that the min value is -15360 for newer firmware --jk
978 	 */
979 		if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
980 		    cval->min == -15616) {
981 			usb_audio_info(chip,
982 				 "set volume quirk for UDA1321/N101 chip\n");
983 			cval->max = -256;
984 		}
985 		break;
986 
987 	case USB_ID(0x046d, 0x09a4):
988 		if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
989 			usb_audio_info(chip,
990 				"set volume quirk for QuickCam E3500\n");
991 			cval->min = 6080;
992 			cval->max = 8768;
993 			cval->res = 192;
994 		}
995 		break;
996 
997 	case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
998 	case USB_ID(0x046d, 0x0808):
999 	case USB_ID(0x046d, 0x0809):
1000 	case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1001 	case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1002 	case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1003 	case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1004 	case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1005 	case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1006 	case USB_ID(0x046d, 0x0991):
1007 	case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1008 	/* Most audio usb devices lie about volume resolution.
1009 	 * Most Logitech webcams have res = 384.
1010 	 * Probably there is some logitech magic behind this number --fishor
1011 	 */
1012 		if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1013 			usb_audio_info(chip,
1014 				"set resolution quirk: cval->res = 384\n");
1015 			cval->res = 384;
1016 		}
1017 		break;
1018 	}
1019 }
1020 
1021 /*
1022  * retrieve the minimum and maximum values for the specified control
1023  */
1024 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1025 				   int default_min, struct snd_kcontrol *kctl)
1026 {
1027 	/* for failsafe */
1028 	cval->min = default_min;
1029 	cval->max = cval->min + 1;
1030 	cval->res = 1;
1031 	cval->dBmin = cval->dBmax = 0;
1032 
1033 	if (cval->val_type == USB_MIXER_BOOLEAN ||
1034 	    cval->val_type == USB_MIXER_INV_BOOLEAN) {
1035 		cval->initialized = 1;
1036 	} else {
1037 		int minchn = 0;
1038 		if (cval->cmask) {
1039 			int i;
1040 			for (i = 0; i < MAX_CHANNELS; i++)
1041 				if (cval->cmask & (1 << i)) {
1042 					minchn = i + 1;
1043 					break;
1044 				}
1045 		}
1046 		if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
1047 		    get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1048 			usb_audio_err(cval->head.mixer->chip,
1049 				      "%d:%d: cannot get min/max values for control %d (id %d)\n",
1050 				   cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
1051 							       cval->control, cval->head.id);
1052 			return -EINVAL;
1053 		}
1054 		if (get_ctl_value(cval, UAC_GET_RES,
1055 				  (cval->control << 8) | minchn,
1056 				  &cval->res) < 0) {
1057 			cval->res = 1;
1058 		} else {
1059 			int last_valid_res = cval->res;
1060 
1061 			while (cval->res > 1) {
1062 				if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1063 								(cval->control << 8) | minchn,
1064 								cval->res / 2) < 0)
1065 					break;
1066 				cval->res /= 2;
1067 			}
1068 			if (get_ctl_value(cval, UAC_GET_RES,
1069 					  (cval->control << 8) | minchn, &cval->res) < 0)
1070 				cval->res = last_valid_res;
1071 		}
1072 		if (cval->res == 0)
1073 			cval->res = 1;
1074 
1075 		/* Additional checks for the proper resolution
1076 		 *
1077 		 * Some devices report smaller resolutions than actually
1078 		 * reacting.  They don't return errors but simply clip
1079 		 * to the lower aligned value.
1080 		 */
1081 		if (cval->min + cval->res < cval->max) {
1082 			int last_valid_res = cval->res;
1083 			int saved, test, check;
1084 			get_cur_mix_raw(cval, minchn, &saved);
1085 			for (;;) {
1086 				test = saved;
1087 				if (test < cval->max)
1088 					test += cval->res;
1089 				else
1090 					test -= cval->res;
1091 				if (test < cval->min || test > cval->max ||
1092 				    snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1093 				    get_cur_mix_raw(cval, minchn, &check)) {
1094 					cval->res = last_valid_res;
1095 					break;
1096 				}
1097 				if (test == check)
1098 					break;
1099 				cval->res *= 2;
1100 			}
1101 			snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1102 		}
1103 
1104 		cval->initialized = 1;
1105 	}
1106 
1107 	if (kctl)
1108 		volume_control_quirks(cval, kctl);
1109 
1110 	/* USB descriptions contain the dB scale in 1/256 dB unit
1111 	 * while ALSA TLV contains in 1/100 dB unit
1112 	 */
1113 	cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1114 	cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1115 	if (cval->dBmin > cval->dBmax) {
1116 		/* something is wrong; assume it's either from/to 0dB */
1117 		if (cval->dBmin < 0)
1118 			cval->dBmax = 0;
1119 		else if (cval->dBmin > 0)
1120 			cval->dBmin = 0;
1121 		if (cval->dBmin > cval->dBmax) {
1122 			/* totally crap, return an error */
1123 			return -EINVAL;
1124 		}
1125 	}
1126 
1127 	return 0;
1128 }
1129 
1130 #define get_min_max(cval, def)	get_min_max_with_quirks(cval, def, NULL)
1131 
1132 /* get a feature/mixer unit info */
1133 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1134 				  struct snd_ctl_elem_info *uinfo)
1135 {
1136 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1137 
1138 	if (cval->val_type == USB_MIXER_BOOLEAN ||
1139 	    cval->val_type == USB_MIXER_INV_BOOLEAN)
1140 		uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1141 	else
1142 		uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1143 	uinfo->count = cval->channels;
1144 	if (cval->val_type == USB_MIXER_BOOLEAN ||
1145 	    cval->val_type == USB_MIXER_INV_BOOLEAN) {
1146 		uinfo->value.integer.min = 0;
1147 		uinfo->value.integer.max = 1;
1148 	} else {
1149 		if (!cval->initialized) {
1150 			get_min_max_with_quirks(cval, 0, kcontrol);
1151 			if (cval->initialized && cval->dBmin >= cval->dBmax) {
1152 				kcontrol->vd[0].access &=
1153 					~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1154 					  SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1155 				snd_ctl_notify(cval->head.mixer->chip->card,
1156 					       SNDRV_CTL_EVENT_MASK_INFO,
1157 					       &kcontrol->id);
1158 			}
1159 		}
1160 		uinfo->value.integer.min = 0;
1161 		uinfo->value.integer.max =
1162 			(cval->max - cval->min + cval->res - 1) / cval->res;
1163 	}
1164 	return 0;
1165 }
1166 
1167 /* get the current value from feature/mixer unit */
1168 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1169 				 struct snd_ctl_elem_value *ucontrol)
1170 {
1171 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1172 	int c, cnt, val, err;
1173 
1174 	ucontrol->value.integer.value[0] = cval->min;
1175 	if (cval->cmask) {
1176 		cnt = 0;
1177 		for (c = 0; c < MAX_CHANNELS; c++) {
1178 			if (!(cval->cmask & (1 << c)))
1179 				continue;
1180 			err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1181 			if (err < 0)
1182 				return filter_error(cval, err);
1183 			val = get_relative_value(cval, val);
1184 			ucontrol->value.integer.value[cnt] = val;
1185 			cnt++;
1186 		}
1187 		return 0;
1188 	} else {
1189 		/* master channel */
1190 		err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1191 		if (err < 0)
1192 			return filter_error(cval, err);
1193 		val = get_relative_value(cval, val);
1194 		ucontrol->value.integer.value[0] = val;
1195 	}
1196 	return 0;
1197 }
1198 
1199 /* put the current value to feature/mixer unit */
1200 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1201 				 struct snd_ctl_elem_value *ucontrol)
1202 {
1203 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1204 	int c, cnt, val, oval, err;
1205 	int changed = 0;
1206 
1207 	if (cval->cmask) {
1208 		cnt = 0;
1209 		for (c = 0; c < MAX_CHANNELS; c++) {
1210 			if (!(cval->cmask & (1 << c)))
1211 				continue;
1212 			err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1213 			if (err < 0)
1214 				return filter_error(cval, err);
1215 			val = ucontrol->value.integer.value[cnt];
1216 			val = get_abs_value(cval, val);
1217 			if (oval != val) {
1218 				snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1219 				changed = 1;
1220 			}
1221 			cnt++;
1222 		}
1223 	} else {
1224 		/* master channel */
1225 		err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1226 		if (err < 0)
1227 			return filter_error(cval, err);
1228 		val = ucontrol->value.integer.value[0];
1229 		val = get_abs_value(cval, val);
1230 		if (val != oval) {
1231 			snd_usb_set_cur_mix_value(cval, 0, 0, val);
1232 			changed = 1;
1233 		}
1234 	}
1235 	return changed;
1236 }
1237 
1238 /* get the boolean value from the master channel of a UAC control */
1239 static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
1240 				     struct snd_ctl_elem_value *ucontrol)
1241 {
1242 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1243 	int val, err;
1244 
1245 	err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1246 	if (err < 0)
1247 		return filter_error(cval, err);
1248 	val = (val != 0);
1249 	ucontrol->value.integer.value[0] = val;
1250 	return 0;
1251 }
1252 
1253 static struct snd_kcontrol_new usb_feature_unit_ctl = {
1254 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1255 	.name = "", /* will be filled later manually */
1256 	.info = mixer_ctl_feature_info,
1257 	.get = mixer_ctl_feature_get,
1258 	.put = mixer_ctl_feature_put,
1259 };
1260 
1261 /* the read-only variant */
1262 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1263 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1264 	.name = "", /* will be filled later manually */
1265 	.info = mixer_ctl_feature_info,
1266 	.get = mixer_ctl_feature_get,
1267 	.put = NULL,
1268 };
1269 
1270 /*
1271  * A control which shows the boolean value from reading a UAC control on
1272  * the master channel.
1273  */
1274 static struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1275 	.iface = SNDRV_CTL_ELEM_IFACE_CARD,
1276 	.name = "", /* will be filled later manually */
1277 	.access = SNDRV_CTL_ELEM_ACCESS_READ,
1278 	.info = snd_ctl_boolean_mono_info,
1279 	.get = mixer_ctl_master_bool_get,
1280 	.put = NULL,
1281 };
1282 
1283 /*
1284  * This symbol is exported in order to allow the mixer quirks to
1285  * hook up to the standard feature unit control mechanism
1286  */
1287 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1288 
1289 /*
1290  * build a feature control
1291  */
1292 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1293 {
1294 	return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1295 }
1296 
1297 /*
1298  * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1299  * rename it to "Headphone". We determine if something is a headphone
1300  * similar to how udev determines form factor.
1301  */
1302 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1303 					struct snd_card *card)
1304 {
1305 	const char *names_to_check[] = {
1306 		"Headset", "headset", "Headphone", "headphone", NULL};
1307 	const char **s;
1308 	bool found = false;
1309 
1310 	if (strcmp("Speaker", kctl->id.name))
1311 		return;
1312 
1313 	for (s = names_to_check; *s; s++)
1314 		if (strstr(card->shortname, *s)) {
1315 			found = true;
1316 			break;
1317 		}
1318 
1319 	if (!found)
1320 		return;
1321 
1322 	strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1323 }
1324 
1325 static struct usb_feature_control_info *get_feature_control_info(int control)
1326 {
1327 	int i;
1328 
1329 	for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1330 		if (audio_feature_info[i].control == control)
1331 			return &audio_feature_info[i];
1332 	}
1333 	return NULL;
1334 }
1335 
1336 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1337 			      unsigned int ctl_mask, int control,
1338 			      struct usb_audio_term *iterm, int unitid,
1339 			      int readonly_mask)
1340 {
1341 	struct uac_feature_unit_descriptor *desc = raw_desc;
1342 	struct usb_feature_control_info *ctl_info;
1343 	unsigned int len = 0;
1344 	int mapped_name = 0;
1345 	int nameid = uac_feature_unit_iFeature(desc);
1346 	struct snd_kcontrol *kctl;
1347 	struct usb_mixer_elem_info *cval;
1348 	const struct usbmix_name_map *map;
1349 	unsigned int range;
1350 
1351 	if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1352 		/* FIXME: not supported yet */
1353 		return;
1354 	}
1355 
1356 	map = find_map(state, unitid, control);
1357 	if (check_ignored_ctl(map))
1358 		return;
1359 
1360 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1361 	if (!cval)
1362 		return;
1363 	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1364 	cval->control = control;
1365 	cval->cmask = ctl_mask;
1366 
1367 	ctl_info = get_feature_control_info(control);
1368 	if (!ctl_info) {
1369 		kfree(cval);
1370 		return;
1371 	}
1372 	if (state->mixer->protocol == UAC_VERSION_1)
1373 		cval->val_type = ctl_info->type;
1374 	else /* UAC_VERSION_2 */
1375 		cval->val_type = ctl_info->type_uac2 >= 0 ?
1376 			ctl_info->type_uac2 : ctl_info->type;
1377 
1378 	if (ctl_mask == 0) {
1379 		cval->channels = 1;	/* master channel */
1380 		cval->master_readonly = readonly_mask;
1381 	} else {
1382 		int i, c = 0;
1383 		for (i = 0; i < 16; i++)
1384 			if (ctl_mask & (1 << i))
1385 				c++;
1386 		cval->channels = c;
1387 		cval->ch_readonly = readonly_mask;
1388 	}
1389 
1390 	/*
1391 	 * If all channels in the mask are marked read-only, make the control
1392 	 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1393 	 * issue write commands to read-only channels.
1394 	 */
1395 	if (cval->channels == readonly_mask)
1396 		kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1397 	else
1398 		kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1399 
1400 	if (!kctl) {
1401 		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1402 		kfree(cval);
1403 		return;
1404 	}
1405 	kctl->private_free = snd_usb_mixer_elem_free;
1406 
1407 	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1408 	mapped_name = len != 0;
1409 	if (!len && nameid)
1410 		len = snd_usb_copy_string_desc(state, nameid,
1411 				kctl->id.name, sizeof(kctl->id.name));
1412 
1413 	switch (control) {
1414 	case UAC_FU_MUTE:
1415 	case UAC_FU_VOLUME:
1416 		/*
1417 		 * determine the control name.  the rule is:
1418 		 * - if a name id is given in descriptor, use it.
1419 		 * - if the connected input can be determined, then use the name
1420 		 *   of terminal type.
1421 		 * - if the connected output can be determined, use it.
1422 		 * - otherwise, anonymous name.
1423 		 */
1424 		if (!len) {
1425 			len = get_term_name(state, iterm, kctl->id.name,
1426 					    sizeof(kctl->id.name), 1);
1427 			if (!len)
1428 				len = get_term_name(state, &state->oterm,
1429 						    kctl->id.name,
1430 						    sizeof(kctl->id.name), 1);
1431 			if (!len)
1432 				snprintf(kctl->id.name, sizeof(kctl->id.name),
1433 					 "Feature %d", unitid);
1434 		}
1435 
1436 		if (!mapped_name)
1437 			check_no_speaker_on_headset(kctl, state->mixer->chip->card);
1438 
1439 		/*
1440 		 * determine the stream direction:
1441 		 * if the connected output is USB stream, then it's likely a
1442 		 * capture stream.  otherwise it should be playback (hopefully :)
1443 		 */
1444 		if (!mapped_name && !(state->oterm.type >> 16)) {
1445 			if ((state->oterm.type & 0xff00) == 0x0100)
1446 				append_ctl_name(kctl, " Capture");
1447 			else
1448 				append_ctl_name(kctl, " Playback");
1449 		}
1450 		append_ctl_name(kctl, control == UAC_FU_MUTE ?
1451 				" Switch" : " Volume");
1452 		break;
1453 	default:
1454 		if (!len)
1455 			strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1456 				sizeof(kctl->id.name));
1457 		break;
1458 	}
1459 
1460 	/* get min/max values */
1461 	get_min_max_with_quirks(cval, 0, kctl);
1462 
1463 	if (control == UAC_FU_VOLUME) {
1464 		check_mapped_dB(map, cval);
1465 		if (cval->dBmin < cval->dBmax || !cval->initialized) {
1466 			kctl->tlv.c = snd_usb_mixer_vol_tlv;
1467 			kctl->vd[0].access |=
1468 				SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1469 				SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1470 		}
1471 	}
1472 
1473 	snd_usb_mixer_fu_apply_quirk(state->mixer, cval, unitid, kctl);
1474 
1475 	range = (cval->max - cval->min) / cval->res;
1476 	/*
1477 	 * Are there devices with volume range more than 255? I use a bit more
1478 	 * to be sure. 384 is a resolution magic number found on Logitech
1479 	 * devices. It will definitively catch all buggy Logitech devices.
1480 	 */
1481 	if (range > 384) {
1482 		usb_audio_warn(state->chip,
1483 			       "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1484 			       range);
1485 		usb_audio_warn(state->chip,
1486 			       "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1487 			       cval->head.id, kctl->id.name, cval->channels,
1488 			       cval->min, cval->max, cval->res);
1489 	}
1490 
1491 	usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1492 		      cval->head.id, kctl->id.name, cval->channels,
1493 		      cval->min, cval->max, cval->res);
1494 	snd_usb_mixer_add_control(&cval->head, kctl);
1495 }
1496 
1497 static void get_connector_control_name(struct mixer_build *state,
1498 				       struct usb_audio_term *term,
1499 				       bool is_input, char *name, int name_size)
1500 {
1501 	int name_len = get_term_name(state, term, name, name_size, 0);
1502 
1503 	if (name_len == 0)
1504 		strlcpy(name, "Unknown", name_size);
1505 
1506 	/*
1507 	 *  sound/core/ctljack.c has a convention of naming jack controls
1508 	 * by ending in " Jack".  Make it slightly more useful by
1509 	 * indicating Input or Output after the terminal name.
1510 	 */
1511 	if (is_input)
1512 		strlcat(name, " - Input Jack", name_size);
1513 	else
1514 		strlcat(name, " - Output Jack", name_size);
1515 }
1516 
1517 /* Build a mixer control for a UAC connector control (jack-detect) */
1518 static void build_connector_control(struct mixer_build *state,
1519 				    struct usb_audio_term *term, bool is_input)
1520 {
1521 	struct snd_kcontrol *kctl;
1522 	struct usb_mixer_elem_info *cval;
1523 
1524 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1525 	if (!cval)
1526 		return;
1527 	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, term->id);
1528 	/*
1529 	 * The first byte from reading the UAC2_TE_CONNECTOR control returns the
1530 	 * number of channels connected.  This boolean ctl will simply report
1531 	 * if any channels are connected or not.
1532 	 * (Audio20_final.pdf Table 5-10: Connector Control CUR Parameter Block)
1533 	 */
1534 	cval->control = UAC2_TE_CONNECTOR;
1535 	cval->val_type = USB_MIXER_BOOLEAN;
1536 	cval->channels = 1; /* report true if any channel is connected */
1537 	cval->min = 0;
1538 	cval->max = 1;
1539 	kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1540 	if (!kctl) {
1541 		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1542 		kfree(cval);
1543 		return;
1544 	}
1545 	get_connector_control_name(state, term, is_input, kctl->id.name,
1546 				   sizeof(kctl->id.name));
1547 	kctl->private_free = snd_usb_mixer_elem_free;
1548 	snd_usb_mixer_add_control(&cval->head, kctl);
1549 }
1550 
1551 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1552 				   void *_ftr)
1553 {
1554 	struct uac_clock_source_descriptor *hdr = _ftr;
1555 	struct usb_mixer_elem_info *cval;
1556 	struct snd_kcontrol *kctl;
1557 	char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1558 	int ret;
1559 
1560 	if (state->mixer->protocol != UAC_VERSION_2)
1561 		return -EINVAL;
1562 
1563 	if (hdr->bLength != sizeof(*hdr)) {
1564 		usb_audio_dbg(state->chip,
1565 			      "Bogus clock source descriptor length of %d, ignoring.\n",
1566 			      hdr->bLength);
1567 		return 0;
1568 	}
1569 
1570 	/*
1571 	 * The only property of this unit we are interested in is the
1572 	 * clock source validity. If that isn't readable, just bail out.
1573 	 */
1574 	if (!uac_v2v3_control_is_readable(hdr->bmControls,
1575 				      UAC2_CS_CONTROL_CLOCK_VALID))
1576 		return 0;
1577 
1578 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1579 	if (!cval)
1580 		return -ENOMEM;
1581 
1582 	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1583 
1584 	cval->min = 0;
1585 	cval->max = 1;
1586 	cval->channels = 1;
1587 	cval->val_type = USB_MIXER_BOOLEAN;
1588 	cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1589 
1590 	cval->master_readonly = 1;
1591 	/* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1592 	kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1593 
1594 	if (!kctl) {
1595 		kfree(cval);
1596 		return -ENOMEM;
1597 	}
1598 
1599 	kctl->private_free = snd_usb_mixer_elem_free;
1600 	ret = snd_usb_copy_string_desc(state, hdr->iClockSource,
1601 				       name, sizeof(name));
1602 	if (ret > 0)
1603 		snprintf(kctl->id.name, sizeof(kctl->id.name),
1604 			 "%s Validity", name);
1605 	else
1606 		snprintf(kctl->id.name, sizeof(kctl->id.name),
1607 			 "Clock Source %d Validity", hdr->bClockID);
1608 
1609 	return snd_usb_mixer_add_control(&cval->head, kctl);
1610 }
1611 
1612 /*
1613  * parse a feature unit
1614  *
1615  * most of controls are defined here.
1616  */
1617 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1618 				    void *_ftr)
1619 {
1620 	int channels, i, j;
1621 	struct usb_audio_term iterm;
1622 	unsigned int master_bits, first_ch_bits;
1623 	int err, csize;
1624 	struct uac_feature_unit_descriptor *hdr = _ftr;
1625 	__u8 *bmaControls;
1626 
1627 	if (state->mixer->protocol == UAC_VERSION_1) {
1628 		if (hdr->bLength < 7) {
1629 			usb_audio_err(state->chip,
1630 				      "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1631 				      unitid);
1632 			return -EINVAL;
1633 		}
1634 		csize = hdr->bControlSize;
1635 		if (!csize) {
1636 			usb_audio_dbg(state->chip,
1637 				      "unit %u: invalid bControlSize == 0\n",
1638 				      unitid);
1639 			return -EINVAL;
1640 		}
1641 		channels = (hdr->bLength - 7) / csize - 1;
1642 		bmaControls = hdr->bmaControls;
1643 		if (hdr->bLength < 7 + csize) {
1644 			usb_audio_err(state->chip,
1645 				      "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1646 				      unitid);
1647 			return -EINVAL;
1648 		}
1649 	} else if (state->mixer->protocol == UAC_VERSION_2) {
1650 		struct uac2_feature_unit_descriptor *ftr = _ftr;
1651 		if (hdr->bLength < 6) {
1652 			usb_audio_err(state->chip,
1653 				      "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1654 				      unitid);
1655 			return -EINVAL;
1656 		}
1657 		csize = 4;
1658 		channels = (hdr->bLength - 6) / 4 - 1;
1659 		bmaControls = ftr->bmaControls;
1660 		if (hdr->bLength < 6 + csize) {
1661 			usb_audio_err(state->chip,
1662 				      "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1663 				      unitid);
1664 			return -EINVAL;
1665 		}
1666 	} else { /* UAC_VERSION_3 */
1667 		struct uac3_feature_unit_descriptor *ftr = _ftr;
1668 
1669 		if (hdr->bLength < 7) {
1670 			usb_audio_err(state->chip,
1671 				      "unit %u: invalid UAC3_FEATURE_UNIT descriptor\n",
1672 				      unitid);
1673 			return -EINVAL;
1674 		}
1675 		csize = 4;
1676 		channels = (ftr->bLength - 7) / 4 - 1;
1677 		bmaControls = ftr->bmaControls;
1678 		if (hdr->bLength < 7 + csize) {
1679 			usb_audio_err(state->chip,
1680 				      "unit %u: invalid UAC3_FEATURE_UNIT descriptor\n",
1681 				      unitid);
1682 			return -EINVAL;
1683 		}
1684 	}
1685 
1686 	/* parse the source unit */
1687 	if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1688 		return err;
1689 
1690 	/* determine the input source type and name */
1691 	err = check_input_term(state, hdr->bSourceID, &iterm);
1692 	if (err < 0)
1693 		return err;
1694 
1695 	master_bits = snd_usb_combine_bytes(bmaControls, csize);
1696 	/* master configuration quirks */
1697 	switch (state->chip->usb_id) {
1698 	case USB_ID(0x08bb, 0x2702):
1699 		usb_audio_info(state->chip,
1700 			       "usbmixer: master volume quirk for PCM2702 chip\n");
1701 		/* disable non-functional volume control */
1702 		master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1703 		break;
1704 	case USB_ID(0x1130, 0xf211):
1705 		usb_audio_info(state->chip,
1706 			       "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1707 		/* disable non-functional volume control */
1708 		channels = 0;
1709 		break;
1710 
1711 	}
1712 	if (channels > 0)
1713 		first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1714 	else
1715 		first_ch_bits = 0;
1716 
1717 	if (state->mixer->protocol == UAC_VERSION_1) {
1718 		/* check all control types */
1719 		for (i = 0; i < 10; i++) {
1720 			unsigned int ch_bits = 0;
1721 			int control = audio_feature_info[i].control;
1722 
1723 			for (j = 0; j < channels; j++) {
1724 				unsigned int mask;
1725 
1726 				mask = snd_usb_combine_bytes(bmaControls +
1727 							     csize * (j+1), csize);
1728 				if (mask & (1 << i))
1729 					ch_bits |= (1 << j);
1730 			}
1731 			/* audio class v1 controls are never read-only */
1732 
1733 			/*
1734 			 * The first channel must be set
1735 			 * (for ease of programming).
1736 			 */
1737 			if (ch_bits & 1)
1738 				build_feature_ctl(state, _ftr, ch_bits, control,
1739 						  &iterm, unitid, 0);
1740 			if (master_bits & (1 << i))
1741 				build_feature_ctl(state, _ftr, 0, control,
1742 						  &iterm, unitid, 0);
1743 		}
1744 	} else { /* UAC_VERSION_2/3 */
1745 		for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1746 			unsigned int ch_bits = 0;
1747 			unsigned int ch_read_only = 0;
1748 			int control = audio_feature_info[i].control;
1749 
1750 			for (j = 0; j < channels; j++) {
1751 				unsigned int mask;
1752 
1753 				mask = snd_usb_combine_bytes(bmaControls +
1754 							     csize * (j+1), csize);
1755 				if (uac_v2v3_control_is_readable(mask, control)) {
1756 					ch_bits |= (1 << j);
1757 					if (!uac_v2v3_control_is_writeable(mask, control))
1758 						ch_read_only |= (1 << j);
1759 				}
1760 			}
1761 
1762 			/*
1763 			 * NOTE: build_feature_ctl() will mark the control
1764 			 * read-only if all channels are marked read-only in
1765 			 * the descriptors. Otherwise, the control will be
1766 			 * reported as writeable, but the driver will not
1767 			 * actually issue a write command for read-only
1768 			 * channels.
1769 			 */
1770 
1771 			/*
1772 			 * The first channel must be set
1773 			 * (for ease of programming).
1774 			 */
1775 			if (ch_bits & 1)
1776 				build_feature_ctl(state, _ftr, ch_bits, control,
1777 						  &iterm, unitid, ch_read_only);
1778 			if (uac_v2v3_control_is_readable(master_bits, control))
1779 				build_feature_ctl(state, _ftr, 0, control,
1780 						  &iterm, unitid,
1781 						  !uac_v2v3_control_is_writeable(master_bits,
1782 										 control));
1783 		}
1784 	}
1785 
1786 	return 0;
1787 }
1788 
1789 /*
1790  * Mixer Unit
1791  */
1792 
1793 /*
1794  * build a mixer unit control
1795  *
1796  * the callbacks are identical with feature unit.
1797  * input channel number (zero based) is given in control field instead.
1798  */
1799 static void build_mixer_unit_ctl(struct mixer_build *state,
1800 				 struct uac_mixer_unit_descriptor *desc,
1801 				 int in_pin, int in_ch, int unitid,
1802 				 struct usb_audio_term *iterm)
1803 {
1804 	struct usb_mixer_elem_info *cval;
1805 	unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1806 	unsigned int i, len;
1807 	struct snd_kcontrol *kctl;
1808 	const struct usbmix_name_map *map;
1809 
1810 	map = find_map(state, unitid, 0);
1811 	if (check_ignored_ctl(map))
1812 		return;
1813 
1814 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1815 	if (!cval)
1816 		return;
1817 
1818 	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1819 	cval->control = in_ch + 1; /* based on 1 */
1820 	cval->val_type = USB_MIXER_S16;
1821 	for (i = 0; i < num_outs; i++) {
1822 		__u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
1823 
1824 		if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
1825 			cval->cmask |= (1 << i);
1826 			cval->channels++;
1827 		}
1828 	}
1829 
1830 	/* get min/max values */
1831 	get_min_max(cval, 0);
1832 
1833 	kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1834 	if (!kctl) {
1835 		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1836 		kfree(cval);
1837 		return;
1838 	}
1839 	kctl->private_free = snd_usb_mixer_elem_free;
1840 
1841 	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1842 	if (!len)
1843 		len = get_term_name(state, iterm, kctl->id.name,
1844 				    sizeof(kctl->id.name), 0);
1845 	if (!len)
1846 		len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1847 	append_ctl_name(kctl, " Volume");
1848 
1849 	usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
1850 		    cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
1851 	snd_usb_mixer_add_control(&cval->head, kctl);
1852 }
1853 
1854 static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
1855 				      void *raw_desc)
1856 {
1857 	struct usb_audio_term iterm;
1858 	struct uac2_input_terminal_descriptor *d = raw_desc;
1859 
1860 	check_input_term(state, d->bTerminalID, &iterm);
1861 	if (state->mixer->protocol == UAC_VERSION_2) {
1862 		/* Check for jack detection. */
1863 		if (uac_v2v3_control_is_readable(le16_to_cpu(d->bmControls),
1864 						 UAC2_TE_CONNECTOR)) {
1865 			build_connector_control(state, &iterm, true);
1866 		}
1867 	}
1868 	return 0;
1869 }
1870 
1871 /*
1872  * parse a mixer unit
1873  */
1874 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
1875 				  void *raw_desc)
1876 {
1877 	struct uac_mixer_unit_descriptor *desc = raw_desc;
1878 	struct usb_audio_term iterm;
1879 	int input_pins, num_ins, num_outs;
1880 	int pin, ich, err;
1881 
1882 	if (desc->bLength < 11 || !(input_pins = desc->bNrInPins) ||
1883 	    !(num_outs = uac_mixer_unit_bNrChannels(desc))) {
1884 		usb_audio_err(state->chip,
1885 			      "invalid MIXER UNIT descriptor %d\n",
1886 			      unitid);
1887 		return -EINVAL;
1888 	}
1889 
1890 	num_ins = 0;
1891 	ich = 0;
1892 	for (pin = 0; pin < input_pins; pin++) {
1893 		err = parse_audio_unit(state, desc->baSourceID[pin]);
1894 		if (err < 0)
1895 			continue;
1896 		/* no bmControls field (e.g. Maya44) -> ignore */
1897 		if (desc->bLength <= 10 + input_pins)
1898 			continue;
1899 		err = check_input_term(state, desc->baSourceID[pin], &iterm);
1900 		if (err < 0)
1901 			return err;
1902 		num_ins += iterm.channels;
1903 		for (; ich < num_ins; ich++) {
1904 			int och, ich_has_controls = 0;
1905 
1906 			for (och = 0; och < num_outs; och++) {
1907 				__u8 *c = uac_mixer_unit_bmControls(desc,
1908 						state->mixer->protocol);
1909 
1910 				if (check_matrix_bitmap(c, ich, och, num_outs)) {
1911 					ich_has_controls = 1;
1912 					break;
1913 				}
1914 			}
1915 			if (ich_has_controls)
1916 				build_mixer_unit_ctl(state, desc, pin, ich,
1917 						     unitid, &iterm);
1918 		}
1919 	}
1920 	return 0;
1921 }
1922 
1923 /*
1924  * Processing Unit / Extension Unit
1925  */
1926 
1927 /* get callback for processing/extension unit */
1928 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
1929 				  struct snd_ctl_elem_value *ucontrol)
1930 {
1931 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1932 	int err, val;
1933 
1934 	err = get_cur_ctl_value(cval, cval->control << 8, &val);
1935 	if (err < 0) {
1936 		ucontrol->value.integer.value[0] = cval->min;
1937 		return filter_error(cval, err);
1938 	}
1939 	val = get_relative_value(cval, val);
1940 	ucontrol->value.integer.value[0] = val;
1941 	return 0;
1942 }
1943 
1944 /* put callback for processing/extension unit */
1945 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
1946 				  struct snd_ctl_elem_value *ucontrol)
1947 {
1948 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
1949 	int val, oval, err;
1950 
1951 	err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1952 	if (err < 0)
1953 		return filter_error(cval, err);
1954 	val = ucontrol->value.integer.value[0];
1955 	val = get_abs_value(cval, val);
1956 	if (val != oval) {
1957 		set_cur_ctl_value(cval, cval->control << 8, val);
1958 		return 1;
1959 	}
1960 	return 0;
1961 }
1962 
1963 /* alsa control interface for processing/extension unit */
1964 static const struct snd_kcontrol_new mixer_procunit_ctl = {
1965 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1966 	.name = "", /* will be filled later */
1967 	.info = mixer_ctl_feature_info,
1968 	.get = mixer_ctl_procunit_get,
1969 	.put = mixer_ctl_procunit_put,
1970 };
1971 
1972 /*
1973  * predefined data for processing units
1974  */
1975 struct procunit_value_info {
1976 	int control;
1977 	char *suffix;
1978 	int val_type;
1979 	int min_value;
1980 };
1981 
1982 struct procunit_info {
1983 	int type;
1984 	char *name;
1985 	struct procunit_value_info *values;
1986 };
1987 
1988 static struct procunit_value_info updown_proc_info[] = {
1989 	{ UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1990 	{ UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1991 	{ 0 }
1992 };
1993 static struct procunit_value_info prologic_proc_info[] = {
1994 	{ UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1995 	{ UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1996 	{ 0 }
1997 };
1998 static struct procunit_value_info threed_enh_proc_info[] = {
1999 	{ UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2000 	{ UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2001 	{ 0 }
2002 };
2003 static struct procunit_value_info reverb_proc_info[] = {
2004 	{ UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2005 	{ UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2006 	{ UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2007 	{ UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2008 	{ 0 }
2009 };
2010 static struct procunit_value_info chorus_proc_info[] = {
2011 	{ UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2012 	{ UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2013 	{ UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2014 	{ UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2015 	{ 0 }
2016 };
2017 static struct procunit_value_info dcr_proc_info[] = {
2018 	{ UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2019 	{ UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2020 	{ UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2021 	{ UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2022 	{ UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2023 	{ UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2024 	{ 0 }
2025 };
2026 
2027 static struct procunit_info procunits[] = {
2028 	{ UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2029 	{ UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2030 	{ UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2031 	{ UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2032 	{ UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2033 	{ UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2034 	{ 0 },
2035 };
2036 /*
2037  * predefined data for extension units
2038  */
2039 static struct procunit_value_info clock_rate_xu_info[] = {
2040 	{ USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2041 	{ 0 }
2042 };
2043 static struct procunit_value_info clock_source_xu_info[] = {
2044 	{ USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2045 	{ 0 }
2046 };
2047 static struct procunit_value_info spdif_format_xu_info[] = {
2048 	{ USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2049 	{ 0 }
2050 };
2051 static struct procunit_value_info soft_limit_xu_info[] = {
2052 	{ USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2053 	{ 0 }
2054 };
2055 static struct procunit_info extunits[] = {
2056 	{ USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2057 	{ USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2058 	{ USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2059 	{ USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2060 	{ 0 }
2061 };
2062 
2063 /*
2064  * build a processing/extension unit
2065  */
2066 static int build_audio_procunit(struct mixer_build *state, int unitid,
2067 				void *raw_desc, struct procunit_info *list,
2068 				char *name)
2069 {
2070 	struct uac_processing_unit_descriptor *desc = raw_desc;
2071 	int num_ins = desc->bNrInPins;
2072 	struct usb_mixer_elem_info *cval;
2073 	struct snd_kcontrol *kctl;
2074 	int i, err, nameid, type, len;
2075 	struct procunit_info *info;
2076 	struct procunit_value_info *valinfo;
2077 	const struct usbmix_name_map *map;
2078 	static struct procunit_value_info default_value_info[] = {
2079 		{ 0x01, "Switch", USB_MIXER_BOOLEAN },
2080 		{ 0 }
2081 	};
2082 	static struct procunit_info default_info = {
2083 		0, NULL, default_value_info
2084 	};
2085 
2086 	if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
2087 	    desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
2088 		usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
2089 		return -EINVAL;
2090 	}
2091 
2092 	for (i = 0; i < num_ins; i++) {
2093 		if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
2094 			return err;
2095 	}
2096 
2097 	type = le16_to_cpu(desc->wProcessType);
2098 	for (info = list; info && info->type; info++)
2099 		if (info->type == type)
2100 			break;
2101 	if (!info || !info->type)
2102 		info = &default_info;
2103 
2104 	for (valinfo = info->values; valinfo->control; valinfo++) {
2105 		__u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2106 
2107 		if (!(controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
2108 			continue;
2109 		map = find_map(state, unitid, valinfo->control);
2110 		if (check_ignored_ctl(map))
2111 			continue;
2112 		cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2113 		if (!cval)
2114 			return -ENOMEM;
2115 		snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2116 		cval->control = valinfo->control;
2117 		cval->val_type = valinfo->val_type;
2118 		cval->channels = 1;
2119 
2120 		/* get min/max values */
2121 		if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
2122 			__u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
2123 			/* FIXME: hard-coded */
2124 			cval->min = 1;
2125 			cval->max = control_spec[0];
2126 			cval->res = 1;
2127 			cval->initialized = 1;
2128 		} else {
2129 			if (type == USB_XU_CLOCK_RATE) {
2130 				/*
2131 				 * E-Mu USB 0404/0202/TrackerPre/0204
2132 				 * samplerate control quirk
2133 				 */
2134 				cval->min = 0;
2135 				cval->max = 5;
2136 				cval->res = 1;
2137 				cval->initialized = 1;
2138 			} else
2139 				get_min_max(cval, valinfo->min_value);
2140 		}
2141 
2142 		kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2143 		if (!kctl) {
2144 			kfree(cval);
2145 			return -ENOMEM;
2146 		}
2147 		kctl->private_free = snd_usb_mixer_elem_free;
2148 
2149 		if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2150 			/* nothing */ ;
2151 		} else if (info->name) {
2152 			strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2153 		} else {
2154 			nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2155 			len = 0;
2156 			if (nameid)
2157 				len = snd_usb_copy_string_desc(state, nameid,
2158 							       kctl->id.name,
2159 							       sizeof(kctl->id.name));
2160 			if (!len)
2161 				strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
2162 		}
2163 		append_ctl_name(kctl, " ");
2164 		append_ctl_name(kctl, valinfo->suffix);
2165 
2166 		usb_audio_dbg(state->chip,
2167 			      "[%d] PU [%s] ch = %d, val = %d/%d\n",
2168 			      cval->head.id, kctl->id.name, cval->channels,
2169 			      cval->min, cval->max);
2170 
2171 		err = snd_usb_mixer_add_control(&cval->head, kctl);
2172 		if (err < 0)
2173 			return err;
2174 	}
2175 	return 0;
2176 }
2177 
2178 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2179 				       void *raw_desc)
2180 {
2181 	return build_audio_procunit(state, unitid, raw_desc,
2182 				    procunits, "Processing Unit");
2183 }
2184 
2185 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2186 				      void *raw_desc)
2187 {
2188 	/*
2189 	 * Note that we parse extension units with processing unit descriptors.
2190 	 * That's ok as the layout is the same.
2191 	 */
2192 	return build_audio_procunit(state, unitid, raw_desc,
2193 				    extunits, "Extension Unit");
2194 }
2195 
2196 /*
2197  * Selector Unit
2198  */
2199 
2200 /*
2201  * info callback for selector unit
2202  * use an enumerator type for routing
2203  */
2204 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2205 				   struct snd_ctl_elem_info *uinfo)
2206 {
2207 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2208 	const char **itemlist = (const char **)kcontrol->private_value;
2209 
2210 	if (snd_BUG_ON(!itemlist))
2211 		return -EINVAL;
2212 	return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2213 }
2214 
2215 /* get callback for selector unit */
2216 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2217 				  struct snd_ctl_elem_value *ucontrol)
2218 {
2219 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2220 	int val, err;
2221 
2222 	err = get_cur_ctl_value(cval, cval->control << 8, &val);
2223 	if (err < 0) {
2224 		ucontrol->value.enumerated.item[0] = 0;
2225 		return filter_error(cval, err);
2226 	}
2227 	val = get_relative_value(cval, val);
2228 	ucontrol->value.enumerated.item[0] = val;
2229 	return 0;
2230 }
2231 
2232 /* put callback for selector unit */
2233 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2234 				  struct snd_ctl_elem_value *ucontrol)
2235 {
2236 	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2237 	int val, oval, err;
2238 
2239 	err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2240 	if (err < 0)
2241 		return filter_error(cval, err);
2242 	val = ucontrol->value.enumerated.item[0];
2243 	val = get_abs_value(cval, val);
2244 	if (val != oval) {
2245 		set_cur_ctl_value(cval, cval->control << 8, val);
2246 		return 1;
2247 	}
2248 	return 0;
2249 }
2250 
2251 /* alsa control interface for selector unit */
2252 static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2253 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2254 	.name = "", /* will be filled later */
2255 	.info = mixer_ctl_selector_info,
2256 	.get = mixer_ctl_selector_get,
2257 	.put = mixer_ctl_selector_put,
2258 };
2259 
2260 /*
2261  * private free callback.
2262  * free both private_data and private_value
2263  */
2264 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2265 {
2266 	int i, num_ins = 0;
2267 
2268 	if (kctl->private_data) {
2269 		struct usb_mixer_elem_info *cval = kctl->private_data;
2270 		num_ins = cval->max;
2271 		kfree(cval);
2272 		kctl->private_data = NULL;
2273 	}
2274 	if (kctl->private_value) {
2275 		char **itemlist = (char **)kctl->private_value;
2276 		for (i = 0; i < num_ins; i++)
2277 			kfree(itemlist[i]);
2278 		kfree(itemlist);
2279 		kctl->private_value = 0;
2280 	}
2281 }
2282 
2283 /*
2284  * parse a selector unit
2285  */
2286 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2287 				     void *raw_desc)
2288 {
2289 	struct uac_selector_unit_descriptor *desc = raw_desc;
2290 	unsigned int i, nameid, len;
2291 	int err;
2292 	struct usb_mixer_elem_info *cval;
2293 	struct snd_kcontrol *kctl;
2294 	const struct usbmix_name_map *map;
2295 	char **namelist;
2296 
2297 	if (desc->bLength < 5 || !desc->bNrInPins ||
2298 	    desc->bLength < 5 + desc->bNrInPins) {
2299 		usb_audio_err(state->chip,
2300 			"invalid SELECTOR UNIT descriptor %d\n", unitid);
2301 		return -EINVAL;
2302 	}
2303 
2304 	for (i = 0; i < desc->bNrInPins; i++) {
2305 		if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
2306 			return err;
2307 	}
2308 
2309 	if (desc->bNrInPins == 1) /* only one ? nonsense! */
2310 		return 0;
2311 
2312 	map = find_map(state, unitid, 0);
2313 	if (check_ignored_ctl(map))
2314 		return 0;
2315 
2316 	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2317 	if (!cval)
2318 		return -ENOMEM;
2319 	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2320 	cval->val_type = USB_MIXER_U8;
2321 	cval->channels = 1;
2322 	cval->min = 1;
2323 	cval->max = desc->bNrInPins;
2324 	cval->res = 1;
2325 	cval->initialized = 1;
2326 
2327 	if (state->mixer->protocol == UAC_VERSION_1)
2328 		cval->control = 0;
2329 	else /* UAC_VERSION_2 */
2330 		cval->control = (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) ?
2331 			UAC2_CX_CLOCK_SELECTOR : UAC2_SU_SELECTOR;
2332 
2333 	namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
2334 	if (!namelist) {
2335 		kfree(cval);
2336 		return -ENOMEM;
2337 	}
2338 #define MAX_ITEM_NAME_LEN	64
2339 	for (i = 0; i < desc->bNrInPins; i++) {
2340 		struct usb_audio_term iterm;
2341 		len = 0;
2342 		namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2343 		if (!namelist[i]) {
2344 			while (i--)
2345 				kfree(namelist[i]);
2346 			kfree(namelist);
2347 			kfree(cval);
2348 			return -ENOMEM;
2349 		}
2350 		len = check_mapped_selector_name(state, unitid, i, namelist[i],
2351 						 MAX_ITEM_NAME_LEN);
2352 		if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2353 			len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
2354 		if (! len)
2355 			sprintf(namelist[i], "Input %u", i);
2356 	}
2357 
2358 	kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2359 	if (! kctl) {
2360 		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2361 		kfree(namelist);
2362 		kfree(cval);
2363 		return -ENOMEM;
2364 	}
2365 	kctl->private_value = (unsigned long)namelist;
2366 	kctl->private_free = usb_mixer_selector_elem_free;
2367 
2368 	/* check the static mapping table at first */
2369 	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2370 	if (!len) {
2371 		/* no mapping ? */
2372 		/* if iSelector is given, use it */
2373 		nameid = uac_selector_unit_iSelector(desc);
2374 		if (nameid)
2375 			len = snd_usb_copy_string_desc(state, nameid,
2376 						       kctl->id.name,
2377 						       sizeof(kctl->id.name));
2378 		/* ... or pick up the terminal name at next */
2379 		if (!len)
2380 			len = get_term_name(state, &state->oterm,
2381 				    kctl->id.name, sizeof(kctl->id.name), 0);
2382 		/* ... or use the fixed string "USB" as the last resort */
2383 		if (!len)
2384 			strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2385 
2386 		/* and add the proper suffix */
2387 		if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
2388 			append_ctl_name(kctl, " Clock Source");
2389 		else if ((state->oterm.type & 0xff00) == 0x0100)
2390 			append_ctl_name(kctl, " Capture Source");
2391 		else
2392 			append_ctl_name(kctl, " Playback Source");
2393 	}
2394 
2395 	usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2396 		    cval->head.id, kctl->id.name, desc->bNrInPins);
2397 	return snd_usb_mixer_add_control(&cval->head, kctl);
2398 }
2399 
2400 /*
2401  * parse an audio unit recursively
2402  */
2403 
2404 static int parse_audio_unit(struct mixer_build *state, int unitid)
2405 {
2406 	unsigned char *p1;
2407 	int protocol = state->mixer->protocol;
2408 
2409 	if (test_and_set_bit(unitid, state->unitbitmap))
2410 		return 0; /* the unit already visited */
2411 
2412 	p1 = find_audio_control_unit(state, unitid);
2413 	if (!p1) {
2414 		usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2415 		return -EINVAL;
2416 	}
2417 
2418 	if (protocol == UAC_VERSION_1 || protocol == UAC_VERSION_2) {
2419 		switch (p1[2]) {
2420 		case UAC_INPUT_TERMINAL:
2421 			return parse_audio_input_terminal(state, unitid, p1);
2422 		case UAC_MIXER_UNIT:
2423 			return parse_audio_mixer_unit(state, unitid, p1);
2424 		case UAC2_CLOCK_SOURCE:
2425 			return parse_clock_source_unit(state, unitid, p1);
2426 		case UAC_SELECTOR_UNIT:
2427 		case UAC2_CLOCK_SELECTOR:
2428 			return parse_audio_selector_unit(state, unitid, p1);
2429 		case UAC_FEATURE_UNIT:
2430 			return parse_audio_feature_unit(state, unitid, p1);
2431 		case UAC1_PROCESSING_UNIT:
2432 		/*   UAC2_EFFECT_UNIT has the same value */
2433 			if (protocol == UAC_VERSION_1)
2434 				return parse_audio_processing_unit(state, unitid, p1);
2435 			else
2436 				return 0; /* FIXME - effect units not implemented yet */
2437 		case UAC1_EXTENSION_UNIT:
2438 		/*   UAC2_PROCESSING_UNIT_V2 has the same value */
2439 			if (protocol == UAC_VERSION_1)
2440 				return parse_audio_extension_unit(state, unitid, p1);
2441 			else /* UAC_VERSION_2 */
2442 				return parse_audio_processing_unit(state, unitid, p1);
2443 		case UAC2_EXTENSION_UNIT_V2:
2444 			return parse_audio_extension_unit(state, unitid, p1);
2445 		default:
2446 			usb_audio_err(state->chip,
2447 				"unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2448 			return -EINVAL;
2449 		}
2450 	} else { /* UAC_VERSION_3 */
2451 		switch (p1[2]) {
2452 		case UAC_INPUT_TERMINAL:
2453 			return 0; /* NOP */
2454 		case UAC3_MIXER_UNIT:
2455 			return parse_audio_mixer_unit(state, unitid, p1);
2456 		case UAC3_CLOCK_SOURCE:
2457 			return parse_clock_source_unit(state, unitid, p1);
2458 		case UAC3_CLOCK_SELECTOR:
2459 			return parse_audio_selector_unit(state, unitid, p1);
2460 		case UAC3_FEATURE_UNIT:
2461 			return parse_audio_feature_unit(state, unitid, p1);
2462 		case UAC3_EFFECT_UNIT:
2463 			return 0; /* FIXME - effect units not implemented yet */
2464 		case UAC3_PROCESSING_UNIT:
2465 			return parse_audio_processing_unit(state, unitid, p1);
2466 		case UAC3_EXTENSION_UNIT:
2467 			return parse_audio_extension_unit(state, unitid, p1);
2468 		default:
2469 			usb_audio_err(state->chip,
2470 				"unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2471 			return -EINVAL;
2472 		}
2473 	}
2474 }
2475 
2476 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2477 {
2478 	/* kill pending URBs */
2479 	snd_usb_mixer_disconnect(mixer);
2480 
2481 	kfree(mixer->id_elems);
2482 	if (mixer->urb) {
2483 		kfree(mixer->urb->transfer_buffer);
2484 		usb_free_urb(mixer->urb);
2485 	}
2486 	usb_free_urb(mixer->rc_urb);
2487 	kfree(mixer->rc_setup_packet);
2488 	kfree(mixer);
2489 }
2490 
2491 static int snd_usb_mixer_dev_free(struct snd_device *device)
2492 {
2493 	struct usb_mixer_interface *mixer = device->device_data;
2494 	snd_usb_mixer_free(mixer);
2495 	return 0;
2496 }
2497 
2498 /*
2499  * create mixer controls
2500  *
2501  * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2502  */
2503 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
2504 {
2505 	struct mixer_build state;
2506 	int err;
2507 	const struct usbmix_ctl_map *map;
2508 	void *p;
2509 
2510 	memset(&state, 0, sizeof(state));
2511 	state.chip = mixer->chip;
2512 	state.mixer = mixer;
2513 	state.buffer = mixer->hostif->extra;
2514 	state.buflen = mixer->hostif->extralen;
2515 
2516 	/* check the mapping table */
2517 	for (map = usbmix_ctl_maps; map->id; map++) {
2518 		if (map->id == state.chip->usb_id) {
2519 			state.map = map->map;
2520 			state.selector_map = map->selector_map;
2521 			mixer->ignore_ctl_error = map->ignore_ctl_error;
2522 			break;
2523 		}
2524 	}
2525 
2526 	p = NULL;
2527 	while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
2528 					    mixer->hostif->extralen,
2529 					    p, UAC_OUTPUT_TERMINAL)) != NULL) {
2530 		if (mixer->protocol == UAC_VERSION_1) {
2531 			struct uac1_output_terminal_descriptor *desc = p;
2532 
2533 			if (desc->bLength < sizeof(*desc))
2534 				continue; /* invalid descriptor? */
2535 			/* mark terminal ID as visited */
2536 			set_bit(desc->bTerminalID, state.unitbitmap);
2537 			state.oterm.id = desc->bTerminalID;
2538 			state.oterm.type = le16_to_cpu(desc->wTerminalType);
2539 			state.oterm.name = desc->iTerminal;
2540 			err = parse_audio_unit(&state, desc->bSourceID);
2541 			if (err < 0 && err != -EINVAL)
2542 				return err;
2543 		} else if (mixer->protocol == UAC_VERSION_2) {
2544 			struct uac2_output_terminal_descriptor *desc = p;
2545 
2546 			if (desc->bLength < sizeof(*desc))
2547 				continue; /* invalid descriptor? */
2548 			/* mark terminal ID as visited */
2549 			set_bit(desc->bTerminalID, state.unitbitmap);
2550 			state.oterm.id = desc->bTerminalID;
2551 			state.oterm.type = le16_to_cpu(desc->wTerminalType);
2552 			state.oterm.name = desc->iTerminal;
2553 			err = parse_audio_unit(&state, desc->bSourceID);
2554 			if (err < 0 && err != -EINVAL)
2555 				return err;
2556 
2557 			/*
2558 			 * For UAC2, use the same approach to also add the
2559 			 * clock selectors
2560 			 */
2561 			err = parse_audio_unit(&state, desc->bCSourceID);
2562 			if (err < 0 && err != -EINVAL)
2563 				return err;
2564 
2565 			if (uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
2566 							 UAC2_TE_CONNECTOR)) {
2567 				build_connector_control(&state, &state.oterm,
2568 							false);
2569 			}
2570 		} else {  /* UAC_VERSION_3 */
2571 			struct uac3_output_terminal_descriptor *desc = p;
2572 
2573 			if (desc->bLength < sizeof(*desc))
2574 				continue; /* invalid descriptor? */
2575 			/* mark terminal ID as visited */
2576 			set_bit(desc->bTerminalID, state.unitbitmap);
2577 			state.oterm.id = desc->bTerminalID;
2578 			state.oterm.type = le16_to_cpu(desc->wTerminalType);
2579 			state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
2580 			err = parse_audio_unit(&state, desc->bSourceID);
2581 			if (err < 0 && err != -EINVAL)
2582 				return err;
2583 
2584 			/*
2585 			 * For UAC3, use the same approach to also add the
2586 			 * clock selectors
2587 			 */
2588 			err = parse_audio_unit(&state, desc->bCSourceID);
2589 			if (err < 0 && err != -EINVAL)
2590 				return err;
2591 		}
2592 	}
2593 
2594 	return 0;
2595 }
2596 
2597 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
2598 {
2599 	struct usb_mixer_elem_list *list;
2600 
2601 	for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
2602 		struct usb_mixer_elem_info *info =
2603 			(struct usb_mixer_elem_info *)list;
2604 		/* invalidate cache, so the value is read from the device */
2605 		info->cached = 0;
2606 		snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2607 			       &list->kctl->id);
2608 	}
2609 }
2610 
2611 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2612 				    struct usb_mixer_elem_list *list)
2613 {
2614 	struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2615 	static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2616 				    "S8", "U8", "S16", "U16"};
2617 	snd_iprintf(buffer, "    Info: id=%i, control=%i, cmask=0x%x, "
2618 			    "channels=%i, type=\"%s\"\n", cval->head.id,
2619 			    cval->control, cval->cmask, cval->channels,
2620 			    val_types[cval->val_type]);
2621 	snd_iprintf(buffer, "    Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2622 			    cval->min, cval->max, cval->dBmin, cval->dBmax);
2623 }
2624 
2625 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2626 				    struct snd_info_buffer *buffer)
2627 {
2628 	struct snd_usb_audio *chip = entry->private_data;
2629 	struct usb_mixer_interface *mixer;
2630 	struct usb_mixer_elem_list *list;
2631 	int unitid;
2632 
2633 	list_for_each_entry(mixer, &chip->mixer_list, list) {
2634 		snd_iprintf(buffer,
2635 			"USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2636 				chip->usb_id, snd_usb_ctrl_intf(chip),
2637 				mixer->ignore_ctl_error);
2638 		snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2639 		for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2640 			for (list = mixer->id_elems[unitid]; list;
2641 			     list = list->next_id_elem) {
2642 				snd_iprintf(buffer, "  Unit: %i\n", list->id);
2643 				if (list->kctl)
2644 					snd_iprintf(buffer,
2645 						    "    Control: name=\"%s\", index=%i\n",
2646 						    list->kctl->id.name,
2647 						    list->kctl->id.index);
2648 				if (list->dump)
2649 					list->dump(buffer, list);
2650 			}
2651 		}
2652 	}
2653 }
2654 
2655 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2656 				       int attribute, int value, int index)
2657 {
2658 	struct usb_mixer_elem_list *list;
2659 	__u8 unitid = (index >> 8) & 0xff;
2660 	__u8 control = (value >> 8) & 0xff;
2661 	__u8 channel = value & 0xff;
2662 	unsigned int count = 0;
2663 
2664 	if (channel >= MAX_CHANNELS) {
2665 		usb_audio_dbg(mixer->chip,
2666 			"%s(): bogus channel number %d\n",
2667 			__func__, channel);
2668 		return;
2669 	}
2670 
2671 	for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
2672 		count++;
2673 
2674 	if (count == 0)
2675 		return;
2676 
2677 	for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
2678 		struct usb_mixer_elem_info *info;
2679 
2680 		if (!list->kctl)
2681 			continue;
2682 
2683 		info = (struct usb_mixer_elem_info *)list;
2684 		if (count > 1 && info->control != control)
2685 			continue;
2686 
2687 		switch (attribute) {
2688 		case UAC2_CS_CUR:
2689 			/* invalidate cache, so the value is read from the device */
2690 			if (channel)
2691 				info->cached &= ~(1 << channel);
2692 			else /* master channel */
2693 				info->cached = 0;
2694 
2695 			snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2696 				       &info->head.kctl->id);
2697 			break;
2698 
2699 		case UAC2_CS_RANGE:
2700 			/* TODO */
2701 			break;
2702 
2703 		case UAC2_CS_MEM:
2704 			/* TODO */
2705 			break;
2706 
2707 		default:
2708 			usb_audio_dbg(mixer->chip,
2709 				"unknown attribute %d in interrupt\n",
2710 				attribute);
2711 			break;
2712 		} /* switch */
2713 	}
2714 }
2715 
2716 static void snd_usb_mixer_interrupt(struct urb *urb)
2717 {
2718 	struct usb_mixer_interface *mixer = urb->context;
2719 	int len = urb->actual_length;
2720 	int ustatus = urb->status;
2721 
2722 	if (ustatus != 0)
2723 		goto requeue;
2724 
2725 	if (mixer->protocol == UAC_VERSION_1) {
2726 		struct uac1_status_word *status;
2727 
2728 		for (status = urb->transfer_buffer;
2729 		     len >= sizeof(*status);
2730 		     len -= sizeof(*status), status++) {
2731 			dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
2732 						status->bStatusType,
2733 						status->bOriginator);
2734 
2735 			/* ignore any notifications not from the control interface */
2736 			if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2737 				UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2738 				continue;
2739 
2740 			if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2741 				snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2742 			else
2743 				snd_usb_mixer_notify_id(mixer, status->bOriginator);
2744 		}
2745 	} else { /* UAC_VERSION_2 */
2746 		struct uac2_interrupt_data_msg *msg;
2747 
2748 		for (msg = urb->transfer_buffer;
2749 		     len >= sizeof(*msg);
2750 		     len -= sizeof(*msg), msg++) {
2751 			/* drop vendor specific and endpoint requests */
2752 			if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2753 			    (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2754 				continue;
2755 
2756 			snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2757 						   le16_to_cpu(msg->wValue),
2758 						   le16_to_cpu(msg->wIndex));
2759 		}
2760 	}
2761 
2762 requeue:
2763 	if (ustatus != -ENOENT &&
2764 	    ustatus != -ECONNRESET &&
2765 	    ustatus != -ESHUTDOWN) {
2766 		urb->dev = mixer->chip->dev;
2767 		usb_submit_urb(urb, GFP_ATOMIC);
2768 	}
2769 }
2770 
2771 /* create the handler for the optional status interrupt endpoint */
2772 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2773 {
2774 	struct usb_endpoint_descriptor *ep;
2775 	void *transfer_buffer;
2776 	int buffer_length;
2777 	unsigned int epnum;
2778 
2779 	/* we need one interrupt input endpoint */
2780 	if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
2781 		return 0;
2782 	ep = get_endpoint(mixer->hostif, 0);
2783 	if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2784 		return 0;
2785 
2786 	epnum = usb_endpoint_num(ep);
2787 	buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2788 	transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2789 	if (!transfer_buffer)
2790 		return -ENOMEM;
2791 	mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2792 	if (!mixer->urb) {
2793 		kfree(transfer_buffer);
2794 		return -ENOMEM;
2795 	}
2796 	usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2797 			 usb_rcvintpipe(mixer->chip->dev, epnum),
2798 			 transfer_buffer, buffer_length,
2799 			 snd_usb_mixer_interrupt, mixer, ep->bInterval);
2800 	usb_submit_urb(mixer->urb, GFP_KERNEL);
2801 	return 0;
2802 }
2803 
2804 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2805 			 int ignore_error)
2806 {
2807 	static struct snd_device_ops dev_ops = {
2808 		.dev_free = snd_usb_mixer_dev_free
2809 	};
2810 	struct usb_mixer_interface *mixer;
2811 	struct snd_info_entry *entry;
2812 	int err;
2813 
2814 	strcpy(chip->card->mixername, "USB Mixer");
2815 
2816 	mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2817 	if (!mixer)
2818 		return -ENOMEM;
2819 	mixer->chip = chip;
2820 	mixer->ignore_ctl_error = ignore_error;
2821 	mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2822 				  GFP_KERNEL);
2823 	if (!mixer->id_elems) {
2824 		kfree(mixer);
2825 		return -ENOMEM;
2826 	}
2827 
2828 	mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2829 	switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
2830 	case UAC_VERSION_1:
2831 	default:
2832 		mixer->protocol = UAC_VERSION_1;
2833 		break;
2834 	case UAC_VERSION_2:
2835 		mixer->protocol = UAC_VERSION_2;
2836 		break;
2837 	case UAC_VERSION_3:
2838 		mixer->protocol = UAC_VERSION_3;
2839 		break;
2840 	}
2841 
2842 	if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2843 	    (err = snd_usb_mixer_status_create(mixer)) < 0)
2844 		goto _error;
2845 
2846 	snd_usb_mixer_apply_create_quirk(mixer);
2847 
2848 	err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
2849 	if (err < 0)
2850 		goto _error;
2851 
2852 	if (list_empty(&chip->mixer_list) &&
2853 	    !snd_card_proc_new(chip->card, "usbmixer", &entry))
2854 		snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2855 
2856 	list_add(&mixer->list, &chip->mixer_list);
2857 	return 0;
2858 
2859 _error:
2860 	snd_usb_mixer_free(mixer);
2861 	return err;
2862 }
2863 
2864 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
2865 {
2866 	if (mixer->disconnected)
2867 		return;
2868 	if (mixer->urb)
2869 		usb_kill_urb(mixer->urb);
2870 	if (mixer->rc_urb)
2871 		usb_kill_urb(mixer->rc_urb);
2872 	mixer->disconnected = true;
2873 }
2874 
2875 #ifdef CONFIG_PM
2876 /* stop any bus activity of a mixer */
2877 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2878 {
2879 	usb_kill_urb(mixer->urb);
2880 	usb_kill_urb(mixer->rc_urb);
2881 }
2882 
2883 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2884 {
2885 	int err;
2886 
2887 	if (mixer->urb) {
2888 		err = usb_submit_urb(mixer->urb, GFP_NOIO);
2889 		if (err < 0)
2890 			return err;
2891 	}
2892 
2893 	return 0;
2894 }
2895 
2896 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
2897 {
2898 	snd_usb_mixer_inactivate(mixer);
2899 	return 0;
2900 }
2901 
2902 static int restore_mixer_value(struct usb_mixer_elem_list *list)
2903 {
2904 	struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2905 	int c, err, idx;
2906 
2907 	if (cval->cmask) {
2908 		idx = 0;
2909 		for (c = 0; c < MAX_CHANNELS; c++) {
2910 			if (!(cval->cmask & (1 << c)))
2911 				continue;
2912 			if (cval->cached & (1 << (c + 1))) {
2913 				err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
2914 							cval->cache_val[idx]);
2915 				if (err < 0)
2916 					return err;
2917 			}
2918 			idx++;
2919 		}
2920 	} else {
2921 		/* master */
2922 		if (cval->cached) {
2923 			err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
2924 			if (err < 0)
2925 				return err;
2926 		}
2927 	}
2928 
2929 	return 0;
2930 }
2931 
2932 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
2933 {
2934 	struct usb_mixer_elem_list *list;
2935 	int id, err;
2936 
2937 	if (reset_resume) {
2938 		/* restore cached mixer values */
2939 		for (id = 0; id < MAX_ID_ELEMS; id++) {
2940 			for (list = mixer->id_elems[id]; list;
2941 			     list = list->next_id_elem) {
2942 				if (list->resume) {
2943 					err = list->resume(list);
2944 					if (err < 0)
2945 						return err;
2946 				}
2947 			}
2948 		}
2949 	}
2950 
2951 	return snd_usb_mixer_activate(mixer);
2952 }
2953 #endif
2954 
2955 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
2956 				 struct usb_mixer_interface *mixer,
2957 				 int unitid)
2958 {
2959 	list->mixer = mixer;
2960 	list->id = unitid;
2961 	list->dump = snd_usb_mixer_dump_cval;
2962 #ifdef CONFIG_PM
2963 	list->resume = restore_mixer_value;
2964 #endif
2965 }
2966