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