mixer.c 95.0 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
/*
 *   (Tentative) USB Audio Driver for ALSA
 *
 *   Mixer control part
 *
 *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
 *
 *   Many codes borrowed from audio.c by
 *	    Alan Cox (alan@lxorguk.ukuu.org.uk)
 *	    Thomas Sailer (sailer@ife.ee.ethz.ch)
 *
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
/*
 * TODOs, for both the mixer and the streaming interfaces:
 *
 *  - support for UAC2 effect units
 *  - support for graphical equalizers
 *  - RANGE and MEM set commands (UAC2)
 *  - RANGE and MEM interrupt dispatchers (UAC2)
 *  - audio channel clustering (UAC2)
 *  - audio sample rate converter units (UAC2)
 *  - proper handling of clock multipliers (UAC2)
 *  - dispatch clock change notifications (UAC2)
 *  	- stop PCM streams which use a clock that became invalid
 *  	- stop PCM streams which use a clock selector that has changed
 *  	- parse available sample rates again when clock sources changed
 */

L
Linus Torvalds 已提交
45 46 47
#include <linux/bitops.h>
#include <linux/init.h>
#include <linux/list.h>
48
#include <linux/log2.h>
L
Linus Torvalds 已提交
49 50 51
#include <linux/slab.h>
#include <linux/string.h>
#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

L
Linus Torvalds 已提交
56 57
#include <sound/core.h>
#include <sound/control.h>
58
#include <sound/hwdep.h>
59
#include <sound/info.h>
60
#include <sound/tlv.h>
L
Linus Torvalds 已提交
61 62

#include "usbaudio.h"
63
#include "mixer.h"
D
Daniel Mack 已提交
64
#include "helper.h"
D
Daniel Mack 已提交
65
#include "mixer_quirks.h"
66
#include "power.h"
67

68 69
#define MAX_ID_ELEMS	256

L
Linus Torvalds 已提交
70 71 72 73 74 75 76 77 78 79
struct usb_audio_term {
	int id;
	int type;
	int channels;
	unsigned int chconfig;
	int name;
};

struct usbmix_name_map;

80 81
struct mixer_build {
	struct snd_usb_audio *chip;
82
	struct usb_mixer_interface *mixer;
L
Linus Torvalds 已提交
83 84
	unsigned char *buffer;
	unsigned int buflen;
85
	DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
86
	DECLARE_BITMAP(termbitmap, MAX_ID_ELEMS);
87
	struct usb_audio_term oterm;
L
Linus Torvalds 已提交
88
	const struct usbmix_name_map *map;
89
	const struct usbmix_selector_map *selector_map;
L
Linus Torvalds 已提交
90 91
};

92
/*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
93 94 95 96 97 98 99 100 101 102 103 104 105 106
enum {
	USB_XU_CLOCK_RATE 		= 0xe301,
	USB_XU_CLOCK_SOURCE		= 0xe302,
	USB_XU_DIGITAL_IO_STATUS	= 0xe303,
	USB_XU_DEVICE_OPTIONS		= 0xe304,
	USB_XU_DIRECT_MONITORING	= 0xe305,
	USB_XU_METERING			= 0xe306
};
enum {
	USB_XU_CLOCK_SOURCE_SELECTOR = 0x02,	/* clock source*/
	USB_XU_CLOCK_RATE_SELECTOR = 0x03,	/* clock rate */
	USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01,	/* the spdif format */
	USB_XU_SOFT_LIMIT_SELECTOR = 0x03	/* soft limiter */
};
L
Linus Torvalds 已提交
107 108 109 110 111 112

/*
 * manual mapping of mixer names
 * if the mixer topology is too complicated and the parsed names are
 * ambiguous, add the entries in usbmixer_maps.c.
 */
113
#include "mixer_maps.c"
L
Linus Torvalds 已提交
114

115
static const struct usbmix_name_map *
116
find_map(const struct usbmix_name_map *p, int unitid, int control)
L
Linus Torvalds 已提交
117
{
118 119
	if (!p)
		return NULL;
L
Linus Torvalds 已提交
120

121
	for (; p->id; p++) {
122 123 124
		if (p->id == unitid &&
		    (!control || !p->control || control == p->control))
			return p;
L
Linus Torvalds 已提交
125
	}
126
	return NULL;
L
Linus Torvalds 已提交
127 128
}

129 130 131
/* get the mapped name if the unit matches */
static int
check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
L
Linus Torvalds 已提交
132
{
133 134
	if (!p || !p->name)
		return 0;
L
Linus Torvalds 已提交
135

136 137 138 139
	buflen--;
	return strlcpy(buf, p->name, buflen);
}

140 141
/* ignore the error value if ignore_ctl_error flag is set */
#define filter_error(cval, err) \
142
	((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
143

144 145 146 147 148
/* check whether the control should be ignored */
static inline int
check_ignored_ctl(const struct usbmix_name_map *p)
{
	if (!p || p->name || p->dB)
L
Linus Torvalds 已提交
149
		return 0;
150 151 152 153 154 155 156 157 158 159
	return 1;
}

/* dB mapping */
static inline void check_mapped_dB(const struct usbmix_name_map *p,
				   struct usb_mixer_elem_info *cval)
{
	if (p && p->dB) {
		cval->dBmin = p->dB->min;
		cval->dBmax = p->dB->max;
160
		cval->initialized = 1;
L
Linus Torvalds 已提交
161 162 163
	}
}

164
/* get the mapped selector source name */
165
static int check_mapped_selector_name(struct mixer_build *state, int unitid,
166 167 168 169
				      int index, char *buf, int buflen)
{
	const struct usbmix_selector_map *p;

170
	if (!state->selector_map)
171 172 173 174 175 176 177 178
		return 0;
	for (p = state->selector_map; p->id; p++) {
		if (p->id == unitid && index < p->count)
			return strlcpy(buf, p->names[index], buflen);
	}
	return 0;
}

L
Linus Torvalds 已提交
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,
				     unsigned char unit)
L
Linus Torvalds 已提交
184
{
185 186 187 188 189 190 191
	/* we just parse the header */
	struct uac_feature_unit_descriptor *hdr = NULL;

	while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
					USB_DT_CS_INTERFACE)) != NULL) {
		if (hdr->bLength >= 4 &&
		    hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
192
		    hdr->bDescriptorSubtype <= UAC3_SAMPLE_RATE_CONVERTER &&
193 194
		    hdr->bUnitID == unit)
			return hdr;
L
Linus Torvalds 已提交
195
	}
196

L
Linus Torvalds 已提交
197 198 199 200 201 202
	return NULL;
}

/*
 * copy a string with the given id
 */
203
static int snd_usb_copy_string_desc(struct snd_usb_audio *chip,
204
				    int index, char *buf, int maxlen)
L
Linus Torvalds 已提交
205
{
206
	int len = usb_string(chip->dev, index, buf, maxlen - 1);
207 208 209 210

	if (len < 0)
		return 0;

L
Linus Torvalds 已提交
211 212 213 214 215 216 217
	buf[len] = 0;
	return len;
}

/*
 * convert from the byte/word on usb descriptor to the zero-based integer
 */
218
static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
L
Linus Torvalds 已提交
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
{
	switch (cval->val_type) {
	case USB_MIXER_BOOLEAN:
		return !!val;
	case USB_MIXER_INV_BOOLEAN:
		return !val;
	case USB_MIXER_U8:
		val &= 0xff;
		break;
	case USB_MIXER_S8:
		val &= 0xff;
		if (val >= 0x80)
			val -= 0x100;
		break;
	case USB_MIXER_U16:
		val &= 0xffff;
		break;
	case USB_MIXER_S16:
		val &= 0xffff;
		if (val >= 0x8000)
			val -= 0x10000;
		break;
	}
	return val;
}

/*
 * convert from the zero-based int to the byte/word for usb descriptor
 */
248
static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
L
Linus Torvalds 已提交
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
{
	switch (cval->val_type) {
	case USB_MIXER_BOOLEAN:
		return !!val;
	case USB_MIXER_INV_BOOLEAN:
		return !val;
	case USB_MIXER_S8:
	case USB_MIXER_U8:
		return val & 0xff;
	case USB_MIXER_S16:
	case USB_MIXER_U16:
		return val & 0xffff;
	}
	return 0; /* not reached */
}

265
static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
L
Linus Torvalds 已提交
266
{
267
	if (!cval->res)
L
Linus Torvalds 已提交
268 269 270
		cval->res = 1;
	if (val < cval->min)
		return 0;
271 272
	else if (val >= cval->max)
		return (cval->max - cval->min + cval->res - 1) / cval->res;
L
Linus Torvalds 已提交
273 274 275 276
	else
		return (val - cval->min) / cval->res;
}

277
static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
L
Linus Torvalds 已提交
278 279 280
{
	if (val < 0)
		return cval->min;
281
	if (!cval->res)
L
Linus Torvalds 已提交
282 283 284 285 286 287 288 289
		cval->res = 1;
	val *= cval->res;
	val += cval->min;
	if (val > cval->max)
		return cval->max;
	return val;
}

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
static int uac2_ctl_value_size(int val_type)
{
	switch (val_type) {
	case USB_MIXER_S32:
	case USB_MIXER_U32:
		return 4;
	case USB_MIXER_S16:
	case USB_MIXER_U16:
		return 2;
	default:
		return 1;
	}
	return 0; /* unreachable */
}

L
Linus Torvalds 已提交
305 306 307 308 309

/*
 * retrieve a mixer value
 */

310 311
static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
			    int validx, int *value_ret)
L
Linus Torvalds 已提交
312
{
313
	struct snd_usb_audio *chip = cval->head.mixer->chip;
L
Linus Torvalds 已提交
314 315 316
	unsigned char buf[2];
	int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
	int timeout = 10;
317
	int idx = 0, err;
L
Linus Torvalds 已提交
318

319
	err = snd_usb_lock_shutdown(chip);
320 321
	if (err < 0)
		return -EIO;
322

L
Linus Torvalds 已提交
323
	while (timeout-- > 0) {
324
		idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
325 326 327 328
		err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
				      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
				      validx, idx, buf, val_len);
		if (err >= val_len) {
L
Linus Torvalds 已提交
329
			*value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
330 331
			err = 0;
			goto out;
332 333
		} else if (err == -ETIMEDOUT) {
			goto out;
L
Linus Torvalds 已提交
334 335
		}
	}
336 337 338
	usb_audio_dbg(chip,
		"cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
		request, validx, idx, cval->val_type);
339 340 341
	err = -EINVAL;

 out:
342
	snd_usb_unlock_shutdown(chip);
343
	return err;
L
Linus Torvalds 已提交
344 345
}

346 347
static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
			    int validx, int *value_ret)
348
{
349
	struct snd_usb_audio *chip = cval->head.mixer->chip;
350 351
	/* enough space for one range */
	unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
352
	unsigned char *val;
353
	int idx = 0, ret, val_size, size;
354 355
	__u8 bRequest;

356 357
	val_size = uac2_ctl_value_size(cval->val_type);

358 359
	if (request == UAC_GET_CUR) {
		bRequest = UAC2_CS_CUR;
360
		size = val_size;
361 362
	} else {
		bRequest = UAC2_CS_RANGE;
363
		size = sizeof(__u16) + 3 * val_size;
364 365 366
	}

	memset(buf, 0, sizeof(buf));
367

368
	ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
369 370 371
	if (ret)
		goto error;

372 373
	idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
	ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
374
			      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
375
			      validx, idx, buf, size);
376
	snd_usb_unlock_shutdown(chip);
377 378

	if (ret < 0) {
379
error:
380 381 382
		usb_audio_err(chip,
			"cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
			request, validx, idx, cval->val_type);
383 384 385
		return ret;
	}

386 387
	/* FIXME: how should we handle multiple triplets here? */

388 389 390 391 392 393 394 395
	switch (request) {
	case UAC_GET_CUR:
		val = buf;
		break;
	case UAC_GET_MIN:
		val = buf + sizeof(__u16);
		break;
	case UAC_GET_MAX:
396
		val = buf + sizeof(__u16) + val_size;
397 398
		break;
	case UAC_GET_RES:
399
		val = buf + sizeof(__u16) + val_size * 2;
400 401 402 403 404
		break;
	default:
		return -EINVAL;
	}

405 406
	*value_ret = convert_signed_value(cval,
					  snd_usb_combine_bytes(val, val_size));
407 408 409 410

	return 0;
}

411 412
static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
			 int validx, int *value_ret)
413
{
414 415
	validx += cval->idx_off;

416
	return (cval->head.mixer->protocol == UAC_VERSION_1) ?
417 418 419 420
		get_ctl_value_v1(cval, request, validx, value_ret) :
		get_ctl_value_v2(cval, request, validx, value_ret);
}

421 422
static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
			     int validx, int *value)
L
Linus Torvalds 已提交
423
{
424
	return get_ctl_value(cval, UAC_GET_CUR, validx, value);
L
Linus Torvalds 已提交
425 426 427
}

/* channel = 0: master, 1 = first channel */
428 429
static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
				  int channel, int *value)
L
Linus Torvalds 已提交
430
{
431 432 433
	return get_ctl_value(cval, UAC_GET_CUR,
			     (cval->control << 8) | channel,
			     value);
L
Linus Torvalds 已提交
434 435
}

436
int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
437 438 439 440 441 442 443 444 445 446
			     int channel, int index, int *value)
{
	int err;

	if (cval->cached & (1 << channel)) {
		*value = cval->cache_val[index];
		return 0;
	}
	err = get_cur_mix_raw(cval, channel, value);
	if (err < 0) {
447 448
		if (!cval->head.mixer->ignore_ctl_error)
			usb_audio_dbg(cval->head.mixer->chip,
449
				"cannot get current value for control %d ch %d: err = %d\n",
450
				      cval->control, channel, err);
451 452 453 454 455 456 457
		return err;
	}
	cval->cached |= 1 << channel;
	cval->cache_val[index] = *value;
	return 0;
}

L
Linus Torvalds 已提交
458 459 460 461
/*
 * set a mixer value
 */

D
Daniel Mack 已提交
462 463
int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
				int request, int validx, int value_set)
L
Linus Torvalds 已提交
464
{
465
	struct snd_usb_audio *chip = cval->head.mixer->chip;
466
	unsigned char buf[4];
467
	int idx = 0, val_len, err, timeout = 10;
468

469 470
	validx += cval->idx_off;

471

472
	if (cval->head.mixer->protocol == UAC_VERSION_1) {
473
		val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
474
	} else { /* UAC_VERSION_2/3 */
475
		val_len = uac2_ctl_value_size(cval->val_type);
476 477 478

		/* FIXME */
		if (request != UAC_SET_CUR) {
479
			usb_audio_dbg(chip, "RANGE setting not yet supported\n");
480 481 482 483 484
			return -EINVAL;
		}

		request = UAC2_CS_CUR;
	}
L
Linus Torvalds 已提交
485 486 487 488

	value_set = convert_bytes_value(cval, value_set);
	buf[0] = value_set & 0xff;
	buf[1] = (value_set >> 8) & 0xff;
489 490
	buf[2] = (value_set >> 16) & 0xff;
	buf[3] = (value_set >> 24) & 0xff;
491 492

	err = snd_usb_lock_shutdown(chip);
493 494
	if (err < 0)
		return -EIO;
495

496
	while (timeout-- > 0) {
497
		idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
498 499 500 501 502
		err = snd_usb_ctl_msg(chip->dev,
				      usb_sndctrlpipe(chip->dev, 0), request,
				      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
				      validx, idx, buf, val_len);
		if (err >= 0) {
503 504
			err = 0;
			goto out;
505 506
		} else if (err == -ETIMEDOUT) {
			goto out;
507
		}
508
	}
509
	usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
510
		      request, validx, idx, cval->val_type, buf[0], buf[1]);
511 512 513
	err = -EINVAL;

 out:
514
	snd_usb_unlock_shutdown(chip);
515
	return err;
L
Linus Torvalds 已提交
516 517
}

518 519
static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
			     int validx, int value)
L
Linus Torvalds 已提交
520
{
D
Daniel Mack 已提交
521
	return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
L
Linus Torvalds 已提交
522 523
}

524
int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
525
			     int index, int value)
L
Linus Torvalds 已提交
526
{
527
	int err;
528 529 530 531 532
	unsigned int read_only = (channel == 0) ?
		cval->master_readonly :
		cval->ch_readonly & (1 << (channel - 1));

	if (read_only) {
533
		usb_audio_dbg(cval->head.mixer->chip,
534
			      "%s(): channel %d of control %d is read_only\n",
535 536 537 538
			    __func__, channel, cval->control);
		return 0;
	}

539 540 541
	err = snd_usb_mixer_set_ctl_value(cval,
					  UAC_SET_CUR, (cval->control << 8) | channel,
					  value);
542 543 544 545 546
	if (err < 0)
		return err;
	cval->cached |= 1 << channel;
	cval->cache_val[index] = value;
	return 0;
L
Linus Torvalds 已提交
547 548
}

549 550 551
/*
 * TLV callback for mixer volume controls
 */
552
int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
553 554 555
			 unsigned int size, unsigned int __user *_tlv)
{
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
556
	DECLARE_TLV_DB_MINMAX(scale, 0, 0);
557 558 559

	if (size < sizeof(scale))
		return -ENOMEM;
560 561
	if (cval->min_mute)
		scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE;
562 563
	scale[2] = cval->dBmin;
	scale[3] = cval->dBmax;
564 565 566 567
	if (copy_to_user(_tlv, scale, sizeof(scale)))
		return -EFAULT;
	return 0;
}
L
Linus Torvalds 已提交
568 569 570 571 572

/*
 * parser routines begin here...
 */

573
static int parse_audio_unit(struct mixer_build *state, int unitid);
L
Linus Torvalds 已提交
574 575 576 577 578 579


/*
 * check if the input/output channel routing is enabled on the given bitmap.
 * used for mixer unit parser
 */
580 581
static int check_matrix_bitmap(unsigned char *bmap,
			       int ich, int och, int num_outs)
L
Linus Torvalds 已提交
582 583 584 585 586 587 588 589 590 591 592 593
{
	int idx = ich * num_outs + och;
	return bmap[idx >> 3] & (0x80 >> (idx & 7));
}

/*
 * add an alsa control element
 * search and increment the index until an empty slot is found.
 *
 * if failed, give up and free the control instance.
 */

594
int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
595
			      struct snd_kcontrol *kctl)
L
Linus Torvalds 已提交
596
{
597
	struct usb_mixer_interface *mixer = list->mixer;
L
Linus Torvalds 已提交
598
	int err;
599

600
	while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
L
Linus Torvalds 已提交
601
		kctl->id.index++;
602 603
	err = snd_ctl_add(mixer->chip->card, kctl);
	if (err < 0) {
604 605
		usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
			      err);
606
		return err;
L
Linus Torvalds 已提交
607
	}
608 609 610
	list->kctl = kctl;
	list->next_id_elem = mixer->id_elems[list->id];
	mixer->id_elems[list->id] = list;
611
	return 0;
L
Linus Torvalds 已提交
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
}

/*
 * get a terminal name string
 */

static struct iterm_name_combo {
	int type;
	char *name;
} iterm_names[] = {
	{ 0x0300, "Output" },
	{ 0x0301, "Speaker" },
	{ 0x0302, "Headphone" },
	{ 0x0303, "HMD Audio" },
	{ 0x0304, "Desktop Speaker" },
	{ 0x0305, "Room Speaker" },
	{ 0x0306, "Com Speaker" },
	{ 0x0307, "LFE" },
	{ 0x0600, "External In" },
	{ 0x0601, "Analog In" },
	{ 0x0602, "Digital In" },
	{ 0x0603, "Line" },
	{ 0x0604, "Legacy In" },
	{ 0x0605, "IEC958 In" },
	{ 0x0606, "1394 DA Stream" },
	{ 0x0607, "1394 DV Stream" },
	{ 0x0700, "Embedded" },
	{ 0x0701, "Noise Source" },
	{ 0x0702, "Equalization Noise" },
	{ 0x0703, "CD" },
	{ 0x0704, "DAT" },
	{ 0x0705, "DCC" },
	{ 0x0706, "MiniDisk" },
	{ 0x0707, "Analog Tape" },
	{ 0x0708, "Phonograph" },
	{ 0x0709, "VCR Audio" },
	{ 0x070a, "Video Disk Audio" },
	{ 0x070b, "DVD Audio" },
	{ 0x070c, "TV Tuner Audio" },
	{ 0x070d, "Satellite Rec Audio" },
	{ 0x070e, "Cable Tuner Audio" },
	{ 0x070f, "DSS Audio" },
	{ 0x0710, "Radio Receiver" },
	{ 0x0711, "Radio Transmitter" },
	{ 0x0712, "Multi-Track Recorder" },
	{ 0x0713, "Synthesizer" },
	{ 0 },
};

661
static int get_term_name(struct snd_usb_audio *chip, struct usb_audio_term *iterm,
L
Linus Torvalds 已提交
662 663 664
			 unsigned char *name, int maxlen, int term_only)
{
	struct iterm_name_combo *names;
665
	int len;
L
Linus Torvalds 已提交
666

667
	if (iterm->name) {
668
		len = snd_usb_copy_string_desc(chip, iterm->name,
669
						name, maxlen);
670 671 672
		if (len)
			return len;
	}
L
Linus Torvalds 已提交
673 674 675 676 677 678

	/* virtual type - not a real terminal */
	if (iterm->type >> 16) {
		if (term_only)
			return 0;
		switch (iterm->type >> 16) {
679
		case UAC3_SELECTOR_UNIT:
680 681
			strcpy(name, "Selector");
			return 8;
682
		case UAC3_PROCESSING_UNIT:
683 684
			strcpy(name, "Process Unit");
			return 12;
685
		case UAC3_EXTENSION_UNIT:
686 687
			strcpy(name, "Ext Unit");
			return 8;
688
		case UAC3_MIXER_UNIT:
689 690
			strcpy(name, "Mixer");
			return 5;
L
Linus Torvalds 已提交
691 692 693 694 695 696 697
		default:
			return sprintf(name, "Unit %d", iterm->id);
		}
	}

	switch (iterm->type & 0xff00) {
	case 0x0100:
698 699
		strcpy(name, "PCM");
		return 3;
L
Linus Torvalds 已提交
700
	case 0x0200:
701 702
		strcpy(name, "Mic");
		return 3;
L
Linus Torvalds 已提交
703
	case 0x0400:
704 705
		strcpy(name, "Headset");
		return 7;
L
Linus Torvalds 已提交
706
	case 0x0500:
707 708
		strcpy(name, "Phone");
		return 5;
L
Linus Torvalds 已提交
709 710
	}

711
	for (names = iterm_names; names->type; names++) {
L
Linus Torvalds 已提交
712 713 714 715
		if (names->type == iterm->type) {
			strcpy(name, names->name);
			return strlen(names->name);
		}
716 717
	}

L
Linus Torvalds 已提交
718 719 720
	return 0;
}

721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
/*
 * Get logical cluster information for UAC3 devices.
 */
static int get_cluster_channels_v3(struct mixer_build *state, unsigned int cluster_id)
{
	struct uac3_cluster_header_descriptor c_header;
	int err;

	err = snd_usb_ctl_msg(state->chip->dev,
			usb_rcvctrlpipe(state->chip->dev, 0),
			UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
			USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
			cluster_id,
			snd_usb_ctrl_intf(state->chip),
			&c_header, sizeof(c_header));
	if (err < 0)
		goto error;
	if (err != sizeof(c_header)) {
		err = -EIO;
		goto error;
	}

	return c_header.bNrChannels;

error:
	usb_audio_err(state->chip, "cannot request logical cluster ID: %d (err: %d)\n", cluster_id, err);
	return err;
}

/*
 * Get number of channels for a Mixer Unit.
 */
static int uac_mixer_unit_get_channels(struct mixer_build *state,
				       struct uac_mixer_unit_descriptor *desc)
{
	int mu_channels;

	switch (state->mixer->protocol) {
	case UAC_VERSION_1:
	case UAC_VERSION_2:
	default:
762 763
		if (desc->bLength < sizeof(*desc) + desc->bNrInPins + 1)
			return 0; /* no bmControls -> skip */
764 765 766 767 768 769 770 771 772 773 774
		mu_channels = uac_mixer_unit_bNrChannels(desc);
		break;
	case UAC_VERSION_3:
		mu_channels = get_cluster_channels_v3(state,
				uac3_mixer_unit_wClusterDescrID(desc));
		break;
	}

	return mu_channels;
}

775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
/*
 * Parse Input Terminal Unit
 */
static int __check_input_term(struct mixer_build *state, int id,
			      struct usb_audio_term *term);

static int parse_term_uac1_iterm_unit(struct mixer_build *state,
				      struct usb_audio_term *term,
				      void *p1, int id)
{
	struct uac_input_terminal_descriptor *d = p1;

	term->type = le16_to_cpu(d->wTerminalType);
	term->channels = d->bNrChannels;
	term->chconfig = le16_to_cpu(d->wChannelConfig);
	term->name = d->iTerminal;
	return 0;
}

static int parse_term_uac2_iterm_unit(struct mixer_build *state,
				      struct usb_audio_term *term,
				      void *p1, int id)
{
	struct uac2_input_terminal_descriptor *d = p1;
	int err;

	/* call recursively to verify the referenced clock entity */
	err = __check_input_term(state, d->bCSourceID, term);
	if (err < 0)
		return err;

	/* save input term properties after recursion,
	 * to ensure they are not overriden by the recursion calls
	 */
	term->id = id;
	term->type = le16_to_cpu(d->wTerminalType);
	term->channels = d->bNrChannels;
	term->chconfig = le32_to_cpu(d->bmChannelConfig);
	term->name = d->iTerminal;
	return 0;
}

static int parse_term_uac3_iterm_unit(struct mixer_build *state,
				      struct usb_audio_term *term,
				      void *p1, int id)
{
	struct uac3_input_terminal_descriptor *d = p1;
	int err;

	/* call recursively to verify the referenced clock entity */
	err = __check_input_term(state, d->bCSourceID, term);
	if (err < 0)
		return err;

	/* save input term properties after recursion,
	 * to ensure they are not overriden by the recursion calls
	 */
	term->id = id;
	term->type = le16_to_cpu(d->wTerminalType);

	err = get_cluster_channels_v3(state, le16_to_cpu(d->wClusterDescrID));
	if (err < 0)
		return err;
	term->channels = err;

	/* REVISIT: UAC3 IT doesn't have channels cfg */
	term->chconfig = 0;

	term->name = le16_to_cpu(d->wTerminalDescrStr);
	return 0;
}

static int parse_term_mixer_unit(struct mixer_build *state,
				 struct usb_audio_term *term,
				 void *p1, int id)
{
	struct uac_mixer_unit_descriptor *d = p1;
	int protocol = state->mixer->protocol;
	int err;

	err = uac_mixer_unit_get_channels(state, d);
	if (err <= 0)
		return err;

	term->type = UAC3_MIXER_UNIT << 16; /* virtual type */
	term->channels = err;
	if (protocol != UAC_VERSION_3) {
		term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
		term->name = uac_mixer_unit_iMixer(d);
	}
	return 0;
}

static int parse_term_selector_unit(struct mixer_build *state,
				    struct usb_audio_term *term,
				    void *p1, int id)
{
	struct uac_selector_unit_descriptor *d = p1;
	int err;

	/* call recursively to retrieve the channel info */
	err = __check_input_term(state, d->baSourceID[0], term);
	if (err < 0)
		return err;
	term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */
	term->id = id;
	if (state->mixer->protocol != UAC_VERSION_3)
		term->name = uac_selector_unit_iSelector(d);
	return 0;
}

static int parse_term_proc_unit(struct mixer_build *state,
				struct usb_audio_term *term,
				void *p1, int id, int vtype)
{
	struct uac_processing_unit_descriptor *d = p1;
	int protocol = state->mixer->protocol;
	int err;

	if (d->bNrInPins) {
		/* call recursively to retrieve the channel info */
		err = __check_input_term(state, d->baSourceID[0], term);
		if (err < 0)
			return err;
	}

	term->type = vtype << 16; /* virtual type */
	term->id = id;

	if (protocol == UAC_VERSION_3)
		return 0;

	if (!term->channels) {
		term->channels = uac_processing_unit_bNrChannels(d);
		term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
	}
	term->name = uac_processing_unit_iProcessing(d, protocol);
	return 0;
}

static int parse_term_uac2_clock_source(struct mixer_build *state,
					struct usb_audio_term *term,
					void *p1, int id)
{
	struct uac_clock_source_descriptor *d = p1;

	term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
	term->id = id;
	term->name = d->iClockSource;
	return 0;
}

static int parse_term_uac3_clock_source(struct mixer_build *state,
					struct usb_audio_term *term,
					void *p1, int id)
{
	struct uac3_clock_source_descriptor *d = p1;

	term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
	term->id = id;
	term->name = le16_to_cpu(d->wClockSourceStr);
	return 0;
}

#define PTYPE(a, b)	((a) << 8 | (b))

L
Linus Torvalds 已提交
941 942 943 944
/*
 * parse the source unit recursively until it reaches to a terminal
 * or a branched unit.
 */
945
static int __check_input_term(struct mixer_build *state, int id,
946
			      struct usb_audio_term *term)
L
Linus Torvalds 已提交
947
{
948
	int protocol = state->mixer->protocol;
949
	void *p1;
950
	unsigned char *hdr;
L
Linus Torvalds 已提交
951

952 953 954 955 956 957 958 959
	for (;;) {
		/* a loop in the terminal chain? */
		if (test_and_set_bit(id, state->termbitmap))
			return -EINVAL;

		p1 = find_audio_control_unit(state, id);
		if (!p1)
			break;
960 961
		if (!snd_usb_validate_audio_desc(p1, protocol))
			break; /* bad descriptor */
962 963

		hdr = p1;
L
Linus Torvalds 已提交
964
		term->id = id;
965

966 967 968 969 970 971
		switch (PTYPE(protocol, hdr[2])) {
		case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
		case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
		case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT): {
			/* the header is the same for all versions */
			struct uac_feature_unit_descriptor *d = p1;
972

973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
			id = d->bSourceID;
			break; /* continue to parse */
		}
		case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
			return parse_term_uac1_iterm_unit(state, term, p1, id);
		case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
			return parse_term_uac2_iterm_unit(state, term, p1, id);
		case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
			return parse_term_uac3_iterm_unit(state, term, p1, id);
		case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
		case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
		case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
			return parse_term_mixer_unit(state, term, p1, id);
		case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
		case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
		case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
		case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
		case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
			return parse_term_selector_unit(state, term, p1, id);
		case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
		case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
		case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
			return parse_term_proc_unit(state, term, p1, id,
						    UAC3_PROCESSING_UNIT);
		case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
		case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
			return parse_term_proc_unit(state, term, p1, id,
						    UAC3_EFFECT_UNIT);
		case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
		case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
		case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
			return parse_term_proc_unit(state, term, p1, id,
						    UAC3_EXTENSION_UNIT);
		case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
			return parse_term_uac2_clock_source(state, term, p1, id);
		case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
			return parse_term_uac3_clock_source(state, term, p1, id);
		default:
			return -ENODEV;
L
Linus Torvalds 已提交
1012 1013 1014 1015 1016
		}
	}
	return -ENODEV;
}

1017 1018 1019 1020 1021 1022 1023 1024 1025

static int check_input_term(struct mixer_build *state, int id,
			    struct usb_audio_term *term)
{
	memset(term, 0, sizeof(*term));
	memset(state->termbitmap, 0, sizeof(state->termbitmap));
	return __check_input_term(state, id, term);
}

L
Linus Torvalds 已提交
1026 1027 1028 1029 1030 1031
/*
 * Feature Unit
 */

/* feature unit control information */
struct usb_feature_control_info {
1032
	int control;
L
Linus Torvalds 已提交
1033
	const char *name;
1034 1035
	int type;	/* data type for uac1 */
	int type_uac2;	/* data type for uac2 if different from uac1, else -1 */
L
Linus Torvalds 已提交
1036 1037 1038
};

static struct usb_feature_control_info audio_feature_info[] = {
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
	{ UAC_FU_MUTE,			"Mute",			USB_MIXER_INV_BOOLEAN, -1 },
	{ UAC_FU_VOLUME,		"Volume",		USB_MIXER_S16, -1 },
	{ UAC_FU_BASS,			"Tone Control - Bass",	USB_MIXER_S8, -1 },
	{ UAC_FU_MID,			"Tone Control - Mid",	USB_MIXER_S8, -1 },
	{ UAC_FU_TREBLE,		"Tone Control - Treble", USB_MIXER_S8, -1 },
	{ UAC_FU_GRAPHIC_EQUALIZER,	"Graphic Equalizer",	USB_MIXER_S8, -1 }, /* FIXME: not implemented yet */
	{ UAC_FU_AUTOMATIC_GAIN,	"Auto Gain Control",	USB_MIXER_BOOLEAN, -1 },
	{ UAC_FU_DELAY,			"Delay Control",	USB_MIXER_U16, USB_MIXER_U32 },
	{ UAC_FU_BASS_BOOST,		"Bass Boost",		USB_MIXER_BOOLEAN, -1 },
	{ UAC_FU_LOUDNESS,		"Loudness",		USB_MIXER_BOOLEAN, -1 },
1049
	/* UAC2 specific */
1050 1051 1052
	{ UAC2_FU_INPUT_GAIN,		"Input Gain Control",	USB_MIXER_S16, -1 },
	{ UAC2_FU_INPUT_GAIN_PAD,	"Input Gain Pad Control", USB_MIXER_S16, -1 },
	{ UAC2_FU_PHASE_INVERTER,	 "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
L
Linus Torvalds 已提交
1053 1054
};

1055 1056 1057 1058 1059
static void usb_mixer_elem_info_free(struct usb_mixer_elem_info *cval)
{
	kfree(cval);
}

L
Linus Torvalds 已提交
1060
/* private_free callback */
1061
void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
L
Linus Torvalds 已提交
1062
{
1063
	usb_mixer_elem_info_free(kctl->private_data);
1064
	kctl->private_data = NULL;
L
Linus Torvalds 已提交
1065 1066 1067 1068 1069 1070
}

/*
 * interface to ALSA control for feature/mixer units
 */

1071 1072 1073 1074
/* volume control quirks */
static void volume_control_quirks(struct usb_mixer_elem_info *cval,
				  struct snd_kcontrol *kctl)
{
1075
	struct snd_usb_audio *chip = cval->head.mixer->chip;
1076
	switch (chip->usb_id) {
1077
	case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
1078
	case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
		if (strcmp(kctl->id.name, "Effect Duration") == 0) {
			cval->min = 0x0000;
			cval->max = 0xffff;
			cval->res = 0x00e6;
			break;
		}
		if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
		    strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
			cval->min = 0x00;
			cval->max = 0xff;
			break;
		}
		if (strstr(kctl->id.name, "Effect Return") != NULL) {
			cval->min = 0xb706;
			cval->max = 0xff7b;
			cval->res = 0x0073;
			break;
		}
		if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
			(strstr(kctl->id.name, "Effect Send") != NULL)) {
			cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
			cval->max = 0xfcfe;
			cval->res = 0x0073;
		}
		break;

1105 1106 1107
	case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
	case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
		if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1108 1109
			usb_audio_info(chip,
				       "set quirk for FTU Effect Duration\n");
1110 1111 1112 1113 1114 1115 1116
			cval->min = 0x0000;
			cval->max = 0x7f00;
			cval->res = 0x0100;
			break;
		}
		if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
		    strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1117 1118
			usb_audio_info(chip,
				       "set quirks for FTU Effect Feedback/Volume\n");
1119 1120 1121 1122 1123 1124
			cval->min = 0x00;
			cval->max = 0x7f;
			break;
		}
		break;

1125 1126 1127 1128 1129 1130 1131 1132
	case USB_ID(0x0d8c, 0x0103):
		if (!strcmp(kctl->id.name, "PCM Playback Volume")) {
			usb_audio_info(chip,
				 "set volume quirk for CM102-A+/102S+\n");
			cval->min = -256;
		}
		break;

1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
	case USB_ID(0x0471, 0x0101):
	case USB_ID(0x0471, 0x0104):
	case USB_ID(0x0471, 0x0105):
	case USB_ID(0x0672, 0x1041):
	/* quirk for UDA1321/N101.
	 * note that detection between firmware 2.1.1.7 (N101)
	 * and later 2.1.1.21 is not very clear from datasheets.
	 * I hope that the min value is -15360 for newer firmware --jk
	 */
		if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
		    cval->min == -15616) {
1144
			usb_audio_info(chip,
1145 1146 1147 1148 1149 1150 1151
				 "set volume quirk for UDA1321/N101 chip\n");
			cval->max = -256;
		}
		break;

	case USB_ID(0x046d, 0x09a4):
		if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1152
			usb_audio_info(chip,
1153 1154 1155 1156 1157 1158 1159
				"set volume quirk for QuickCam E3500\n");
			cval->min = 6080;
			cval->max = 8768;
			cval->res = 192;
		}
		break;

1160
	case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
1161 1162
	case USB_ID(0x046d, 0x0808):
	case USB_ID(0x046d, 0x0809):
1163
	case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1164
	case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1165
	case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1166
	case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1167
	case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1168
	case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1169
	case USB_ID(0x046d, 0x0991):
1170
	case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1171 1172
	/* Most audio usb devices lie about volume resolution.
	 * Most Logitech webcams have res = 384.
1173
	 * Probably there is some logitech magic behind this number --fishor
1174 1175
	 */
		if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1176
			usb_audio_info(chip,
1177 1178 1179 1180 1181 1182 1183
				"set resolution quirk: cval->res = 384\n");
			cval->res = 384;
		}
		break;
	}
}

L
Linus Torvalds 已提交
1184 1185 1186
/*
 * retrieve the minimum and maximum values for the specified control
 */
1187 1188
static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
				   int default_min, struct snd_kcontrol *kctl)
L
Linus Torvalds 已提交
1189 1190 1191 1192 1193
{
	/* for failsafe */
	cval->min = default_min;
	cval->max = cval->min + 1;
	cval->res = 1;
1194
	cval->dBmin = cval->dBmax = 0;
L
Linus Torvalds 已提交
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208

	if (cval->val_type == USB_MIXER_BOOLEAN ||
	    cval->val_type == USB_MIXER_INV_BOOLEAN) {
		cval->initialized = 1;
	} else {
		int minchn = 0;
		if (cval->cmask) {
			int i;
			for (i = 0; i < MAX_CHANNELS; i++)
				if (cval->cmask & (1 << i)) {
					minchn = i + 1;
					break;
				}
		}
1209 1210
		if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
		    get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1211
			usb_audio_err(cval->head.mixer->chip,
1212
				      "%d:%d: cannot get min/max values for control %d (id %d)\n",
1213 1214
				   cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
							       cval->control, cval->head.id);
L
Linus Torvalds 已提交
1215 1216
			return -EINVAL;
		}
1217 1218 1219
		if (get_ctl_value(cval, UAC_GET_RES,
				  (cval->control << 8) | minchn,
				  &cval->res) < 0) {
L
Linus Torvalds 已提交
1220 1221 1222 1223 1224
			cval->res = 1;
		} else {
			int last_valid_res = cval->res;

			while (cval->res > 1) {
D
Daniel Mack 已提交
1225
				if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1226 1227
								(cval->control << 8) | minchn,
								cval->res / 2) < 0)
L
Linus Torvalds 已提交
1228 1229 1230
					break;
				cval->res /= 2;
			}
1231 1232
			if (get_ctl_value(cval, UAC_GET_RES,
					  (cval->control << 8) | minchn, &cval->res) < 0)
L
Linus Torvalds 已提交
1233 1234 1235 1236
				cval->res = last_valid_res;
		}
		if (cval->res == 0)
			cval->res = 1;
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246

		/* Additional checks for the proper resolution
		 *
		 * Some devices report smaller resolutions than actually
		 * reacting.  They don't return errors but simply clip
		 * to the lower aligned value.
		 */
		if (cval->min + cval->res < cval->max) {
			int last_valid_res = cval->res;
			int saved, test, check;
1247
			get_cur_mix_raw(cval, minchn, &saved);
1248 1249 1250 1251 1252 1253 1254
			for (;;) {
				test = saved;
				if (test < cval->max)
					test += cval->res;
				else
					test -= cval->res;
				if (test < cval->min || test > cval->max ||
1255
				    snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1256
				    get_cur_mix_raw(cval, minchn, &check)) {
1257 1258 1259 1260 1261 1262 1263
					cval->res = last_valid_res;
					break;
				}
				if (test == check)
					break;
				cval->res *= 2;
			}
1264
			snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1265 1266
		}

L
Linus Torvalds 已提交
1267 1268
		cval->initialized = 1;
	}
1269

1270 1271 1272
	if (kctl)
		volume_control_quirks(cval, kctl);

1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
	/* USB descriptions contain the dB scale in 1/256 dB unit
	 * while ALSA TLV contains in 1/100 dB unit
	 */
	cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
	cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
	if (cval->dBmin > cval->dBmax) {
		/* something is wrong; assume it's either from/to 0dB */
		if (cval->dBmin < 0)
			cval->dBmax = 0;
		else if (cval->dBmin > 0)
			cval->dBmin = 0;
		if (cval->dBmin > cval->dBmax) {
			/* totally crap, return an error */
			return -EINVAL;
		}
	}

L
Linus Torvalds 已提交
1290 1291 1292
	return 0;
}

1293
#define get_min_max(cval, def)	get_min_max_with_quirks(cval, def, NULL)
L
Linus Torvalds 已提交
1294 1295

/* get a feature/mixer unit info */
1296 1297
static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_info *uinfo)
L
Linus Torvalds 已提交
1298
{
1299
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311

	if (cval->val_type == USB_MIXER_BOOLEAN ||
	    cval->val_type == USB_MIXER_INV_BOOLEAN)
		uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
	else
		uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
	uinfo->count = cval->channels;
	if (cval->val_type == USB_MIXER_BOOLEAN ||
	    cval->val_type == USB_MIXER_INV_BOOLEAN) {
		uinfo->value.integer.min = 0;
		uinfo->value.integer.max = 1;
	} else {
1312
		if (!cval->initialized) {
1313
			get_min_max_with_quirks(cval, 0, kcontrol);
1314 1315 1316 1317
			if (cval->initialized && cval->dBmin >= cval->dBmax) {
				kcontrol->vd[0].access &= 
					~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
					  SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1318
				snd_ctl_notify(cval->head.mixer->chip->card,
1319 1320 1321 1322
					       SNDRV_CTL_EVENT_MASK_INFO,
					       &kcontrol->id);
			}
		}
L
Linus Torvalds 已提交
1323
		uinfo->value.integer.min = 0;
1324 1325
		uinfo->value.integer.max =
			(cval->max - cval->min + cval->res - 1) / cval->res;
L
Linus Torvalds 已提交
1326 1327 1328 1329 1330
	}
	return 0;
}

/* get the current value from feature/mixer unit */
1331 1332
static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
				 struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
1333
{
1334
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1335 1336
	int c, cnt, val, err;

1337
	ucontrol->value.integer.value[0] = cval->min;
L
Linus Torvalds 已提交
1338 1339 1340
	if (cval->cmask) {
		cnt = 0;
		for (c = 0; c < MAX_CHANNELS; c++) {
1341 1342
			if (!(cval->cmask & (1 << c)))
				continue;
1343
			err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1344
			if (err < 0)
1345
				return filter_error(cval, err);
1346 1347 1348
			val = get_relative_value(cval, val);
			ucontrol->value.integer.value[cnt] = val;
			cnt++;
L
Linus Torvalds 已提交
1349
		}
1350
		return 0;
L
Linus Torvalds 已提交
1351 1352
	} else {
		/* master channel */
1353
		err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1354
		if (err < 0)
1355
			return filter_error(cval, err);
L
Linus Torvalds 已提交
1356 1357 1358 1359 1360 1361 1362
		val = get_relative_value(cval, val);
		ucontrol->value.integer.value[0] = val;
	}
	return 0;
}

/* put the current value to feature/mixer unit */
1363 1364
static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
				 struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
1365
{
1366
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1367 1368 1369 1370 1371 1372
	int c, cnt, val, oval, err;
	int changed = 0;

	if (cval->cmask) {
		cnt = 0;
		for (c = 0; c < MAX_CHANNELS; c++) {
1373 1374
			if (!(cval->cmask & (1 << c)))
				continue;
1375
			err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1376
			if (err < 0)
1377
				return filter_error(cval, err);
1378 1379 1380
			val = ucontrol->value.integer.value[cnt];
			val = get_abs_value(cval, val);
			if (oval != val) {
1381
				snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1382
				changed = 1;
L
Linus Torvalds 已提交
1383
			}
1384
			cnt++;
L
Linus Torvalds 已提交
1385 1386 1387
		}
	} else {
		/* master channel */
1388
		err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
L
Linus Torvalds 已提交
1389
		if (err < 0)
1390
			return filter_error(cval, err);
L
Linus Torvalds 已提交
1391 1392 1393
		val = ucontrol->value.integer.value[0];
		val = get_abs_value(cval, val);
		if (val != oval) {
1394
			snd_usb_set_cur_mix_value(cval, 0, 0, val);
L
Linus Torvalds 已提交
1395 1396 1397 1398 1399 1400
			changed = 1;
		}
	}
	return changed;
}

1401 1402 1403
/* get the boolean value from the master channel of a UAC control */
static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
				     struct snd_ctl_elem_value *ucontrol)
1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
{
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
	int val, err;

	err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
	if (err < 0)
		return filter_error(cval, err);
	val = (val != 0);
	ucontrol->value.integer.value[0] = val;
	return 0;
}

1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
/* get the connectors status and report it as boolean type */
static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol,
				   struct snd_ctl_elem_value *ucontrol)
{
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
	struct snd_usb_audio *chip = cval->head.mixer->chip;
	int idx = 0, validx, ret, val;

	validx = cval->control << 8 | 0;

	ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
	if (ret)
		goto error;

	idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
	if (cval->head.mixer->protocol == UAC_VERSION_2) {
		struct uac2_connectors_ctl_blk uac2_conn;

		ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
				      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
				      validx, idx, &uac2_conn, sizeof(uac2_conn));
		val = !!uac2_conn.bNrChannels;
	} else { /* UAC_VERSION_3 */
		struct uac3_insertion_ctl_blk uac3_conn;

		ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
				      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
				      validx, idx, &uac3_conn, sizeof(uac3_conn));
		val = !!uac3_conn.bmConInserted;
	}

	snd_usb_unlock_shutdown(chip);

	if (ret < 0) {
error:
		usb_audio_err(chip,
			"cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
			UAC_GET_CUR, validx, idx, cval->val_type);
		return ret;
	}

	ucontrol->value.integer.value[0] = val;
	return 0;
}

1461
static struct snd_kcontrol_new usb_feature_unit_ctl = {
L
Linus Torvalds 已提交
1462 1463 1464 1465 1466 1467 1468
	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
	.name = "", /* will be filled later manually */
	.info = mixer_ctl_feature_info,
	.get = mixer_ctl_feature_get,
	.put = mixer_ctl_feature_put,
};

1469
/* the read-only variant */
1470
static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1471 1472 1473 1474 1475 1476 1477
	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
	.name = "", /* will be filled later manually */
	.info = mixer_ctl_feature_info,
	.get = mixer_ctl_feature_get,
	.put = NULL,
};

1478 1479 1480 1481 1482
/*
 * A control which shows the boolean value from reading a UAC control on
 * the master channel.
 */
static struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1483 1484 1485 1486
	.iface = SNDRV_CTL_ELEM_IFACE_CARD,
	.name = "", /* will be filled later manually */
	.access = SNDRV_CTL_ELEM_ACCESS_READ,
	.info = snd_ctl_boolean_mono_info,
1487
	.get = mixer_ctl_master_bool_get,
1488 1489 1490
	.put = NULL,
};

1491 1492 1493 1494 1495 1496 1497 1498 1499
static const struct snd_kcontrol_new usb_connector_ctl_ro = {
	.iface = SNDRV_CTL_ELEM_IFACE_CARD,
	.name = "", /* will be filled later manually */
	.access = SNDRV_CTL_ELEM_ACCESS_READ,
	.info = snd_ctl_boolean_mono_info,
	.get = mixer_ctl_connector_get,
	.put = NULL,
};

1500 1501 1502 1503
/*
 * This symbol is exported in order to allow the mixer quirks to
 * hook up to the standard feature unit control mechanism
 */
1504
struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
L
Linus Torvalds 已提交
1505 1506 1507 1508

/*
 * build a feature control
 */
T
Takashi Iwai 已提交
1509 1510 1511 1512 1513
static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
{
	return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
}

1514 1515 1516 1517 1518
/*
 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
 * rename it to "Headphone". We determine if something is a headphone
 * similar to how udev determines form factor.
 */
1519 1520 1521 1522 1523 1524
static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
					struct snd_card *card)
{
	const char *names_to_check[] = {
		"Headset", "headset", "Headphone", "headphone", NULL};
	const char **s;
1525
	bool found = false;
1526 1527 1528 1529 1530 1531

	if (strcmp("Speaker", kctl->id.name))
		return;

	for (s = names_to_check; *s; s++)
		if (strstr(card->shortname, *s)) {
1532
			found = true;
1533 1534 1535 1536 1537 1538 1539 1540 1541
			break;
		}

	if (!found)
		return;

	strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
}

1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
static struct usb_feature_control_info *get_feature_control_info(int control)
{
	int i;

	for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
		if (audio_feature_info[i].control == control)
			return &audio_feature_info[i];
	}
	return NULL;
}

1553 1554 1555 1556 1557 1558
static void __build_feature_ctl(struct usb_mixer_interface *mixer,
				const struct usbmix_name_map *imap,
				unsigned int ctl_mask, int control,
				struct usb_audio_term *iterm,
				struct usb_audio_term *oterm,
				int unitid, int nameid, int readonly_mask)
L
Linus Torvalds 已提交
1559
{
1560
	struct usb_feature_control_info *ctl_info;
L
Linus Torvalds 已提交
1561 1562
	unsigned int len = 0;
	int mapped_name = 0;
1563 1564
	struct snd_kcontrol *kctl;
	struct usb_mixer_elem_info *cval;
1565
	const struct usbmix_name_map *map;
1566
	unsigned int range;
L
Linus Torvalds 已提交
1567

1568
	if (control == UAC_FU_GRAPHIC_EQUALIZER) {
L
Linus Torvalds 已提交
1569 1570 1571 1572
		/* FIXME: not supported yet */
		return;
	}

1573
	map = find_map(imap, unitid, control);
1574
	if (check_ignored_ctl(map))
L
Linus Torvalds 已提交
1575 1576
		return;

1577
	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1578
	if (!cval)
L
Linus Torvalds 已提交
1579
		return;
1580
	snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
L
Linus Torvalds 已提交
1581 1582
	cval->control = control;
	cval->cmask = ctl_mask;
1583 1584

	ctl_info = get_feature_control_info(control);
1585
	if (!ctl_info) {
1586
		usb_mixer_elem_info_free(cval);
1587
		return;
1588
	}
1589
	if (mixer->protocol == UAC_VERSION_1)
1590 1591 1592 1593 1594
		cval->val_type = ctl_info->type;
	else /* UAC_VERSION_2 */
		cval->val_type = ctl_info->type_uac2 >= 0 ?
			ctl_info->type_uac2 : ctl_info->type;

1595
	if (ctl_mask == 0) {
L
Linus Torvalds 已提交
1596
		cval->channels = 1;	/* master channel */
1597 1598
		cval->master_readonly = readonly_mask;
	} else {
L
Linus Torvalds 已提交
1599 1600 1601 1602 1603
		int i, c = 0;
		for (i = 0; i < 16; i++)
			if (ctl_mask & (1 << i))
				c++;
		cval->channels = c;
1604
		cval->ch_readonly = readonly_mask;
L
Linus Torvalds 已提交
1605 1606
	}

1607 1608
	/*
	 * If all channels in the mask are marked read-only, make the control
1609
	 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1610 1611
	 * issue write commands to read-only channels.
	 */
1612
	if (cval->channels == readonly_mask)
1613 1614 1615 1616
		kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
	else
		kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);

1617
	if (!kctl) {
1618
		usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1619
		usb_mixer_elem_info_free(cval);
L
Linus Torvalds 已提交
1620 1621
		return;
	}
1622
	kctl->private_free = snd_usb_mixer_elem_free;
L
Linus Torvalds 已提交
1623

1624
	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
L
Linus Torvalds 已提交
1625
	mapped_name = len != 0;
1626
	if (!len && nameid)
1627
		len = snd_usb_copy_string_desc(mixer->chip, nameid,
1628
				kctl->id.name, sizeof(kctl->id.name));
L
Linus Torvalds 已提交
1629 1630

	switch (control) {
1631 1632
	case UAC_FU_MUTE:
	case UAC_FU_VOLUME:
1633 1634
		/*
		 * determine the control name.  the rule is:
L
Linus Torvalds 已提交
1635 1636 1637 1638 1639 1640
		 * - if a name id is given in descriptor, use it.
		 * - if the connected input can be determined, then use the name
		 *   of terminal type.
		 * - if the connected output can be determined, use it.
		 * - otherwise, anonymous name.
		 */
1641
		if (!len) {
1642 1643 1644 1645 1646 1647
			if (iterm)
				len = get_term_name(mixer->chip, iterm,
						    kctl->id.name,
						    sizeof(kctl->id.name), 1);
			if (!len && oterm)
				len = get_term_name(mixer->chip, oterm,
1648 1649 1650
						    kctl->id.name,
						    sizeof(kctl->id.name), 1);
			if (!len)
1651 1652
				snprintf(kctl->id.name, sizeof(kctl->id.name),
					 "Feature %d", unitid);
L
Linus Torvalds 已提交
1653
		}
1654 1655

		if (!mapped_name)
1656
			check_no_speaker_on_headset(kctl, mixer->chip->card);
1657

1658 1659
		/*
		 * determine the stream direction:
L
Linus Torvalds 已提交
1660 1661 1662
		 * if the connected output is USB stream, then it's likely a
		 * capture stream.  otherwise it should be playback (hopefully :)
		 */
1663 1664
		if (!mapped_name && oterm && !(oterm->type >> 16)) {
			if ((oterm->type & 0xff00) == 0x0100)
1665
				append_ctl_name(kctl, " Capture");
1666
			else
1667
				append_ctl_name(kctl, " Playback");
L
Linus Torvalds 已提交
1668
		}
1669
		append_ctl_name(kctl, control == UAC_FU_MUTE ?
T
Takashi Iwai 已提交
1670
				" Switch" : " Volume");
L
Linus Torvalds 已提交
1671 1672
		break;
	default:
1673
		if (!len)
L
Linus Torvalds 已提交
1674 1675 1676 1677 1678
			strlcpy(kctl->id.name, audio_feature_info[control-1].name,
				sizeof(kctl->id.name));
		break;
	}

1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
	/* get min/max values */
	get_min_max_with_quirks(cval, 0, kctl);

	if (control == UAC_FU_VOLUME) {
		check_mapped_dB(map, cval);
		if (cval->dBmin < cval->dBmax || !cval->initialized) {
			kctl->tlv.c = snd_usb_mixer_vol_tlv;
			kctl->vd[0].access |=
				SNDRV_CTL_ELEM_ACCESS_TLV_READ |
				SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
		}
	}

1692
	snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1693

1694
	range = (cval->max - cval->min) / cval->res;
1695 1696
	/*
	 * Are there devices with volume range more than 255? I use a bit more
1697 1698 1699 1700
	 * to be sure. 384 is a resolution magic number found on Logitech
	 * devices. It will definitively catch all buggy Logitech devices.
	 */
	if (range > 384) {
1701
		usb_audio_warn(mixer->chip,
1702
			       "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1703
			       range);
1704
		usb_audio_warn(mixer->chip,
1705
			       "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1706
			       cval->head.id, kctl->id.name, cval->channels,
1707
			       cval->min, cval->max, cval->res);
1708 1709
	}

1710
	usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1711
		      cval->head.id, kctl->id.name, cval->channels,
1712
		      cval->min, cval->max, cval->res);
1713
	snd_usb_mixer_add_control(&cval->head, kctl);
L
Linus Torvalds 已提交
1714 1715
}

1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735
static void 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)
{
	struct uac_feature_unit_descriptor *desc = raw_desc;
	int nameid = uac_feature_unit_iFeature(desc);

	__build_feature_ctl(state->mixer, state->map, ctl_mask, control,
			iterm, &state->oterm, unitid, nameid, readonly_mask);
}

static void build_feature_ctl_badd(struct usb_mixer_interface *mixer,
			      unsigned int ctl_mask, int control, int unitid,
			      const struct usbmix_name_map *badd_map)
{
	__build_feature_ctl(mixer, badd_map, ctl_mask, control,
			NULL, NULL, unitid, 0, 0);
}

1736
static void get_connector_control_name(struct usb_mixer_interface *mixer,
1737 1738 1739
				       struct usb_audio_term *term,
				       bool is_input, char *name, int name_size)
{
1740
	int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756

	if (name_len == 0)
		strlcpy(name, "Unknown", name_size);

	/*
	 *  sound/core/ctljack.c has a convention of naming jack controls
	 * by ending in " Jack".  Make it slightly more useful by
	 * indicating Input or Output after the terminal name.
	 */
	if (is_input)
		strlcat(name, " - Input Jack", name_size);
	else
		strlcat(name, " - Output Jack", name_size);
}

/* Build a mixer control for a UAC connector control (jack-detect) */
1757
static void build_connector_control(struct usb_mixer_interface *mixer,
1758 1759 1760 1761 1762 1763 1764 1765
				    struct usb_audio_term *term, bool is_input)
{
	struct snd_kcontrol *kctl;
	struct usb_mixer_elem_info *cval;

	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
	if (!cval)
		return;
1766
	snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1767
	/*
1768 1769 1770 1771 1772 1773 1774 1775
	 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
	 * number of channels connected.
	 *
	 * UAC3: The first byte specifies size of bitmap for the inserted controls. The
	 * following byte(s) specifies which connectors are inserted.
	 *
	 * This boolean ctl will simply report if any channels are connected
	 * or not.
1776
	 */
1777
	if (mixer->protocol == UAC_VERSION_2)
1778 1779 1780 1781
		cval->control = UAC2_TE_CONNECTOR;
	else /* UAC_VERSION_3 */
		cval->control = UAC3_TE_INSERTION;

1782 1783 1784 1785
	cval->val_type = USB_MIXER_BOOLEAN;
	cval->channels = 1; /* report true if any channel is connected */
	cval->min = 0;
	cval->max = 1;
1786
	kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1787
	if (!kctl) {
1788
		usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1789
		usb_mixer_elem_info_free(cval);
1790 1791
		return;
	}
1792
	get_connector_control_name(mixer, term, is_input, kctl->id.name,
1793 1794 1795 1796 1797
				   sizeof(kctl->id.name));
	kctl->private_free = snd_usb_mixer_elem_free;
	snd_usb_mixer_add_control(&cval->head, kctl);
}

1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813
static int parse_clock_source_unit(struct mixer_build *state, int unitid,
				   void *_ftr)
{
	struct uac_clock_source_descriptor *hdr = _ftr;
	struct usb_mixer_elem_info *cval;
	struct snd_kcontrol *kctl;
	char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
	int ret;

	if (state->mixer->protocol != UAC_VERSION_2)
		return -EINVAL;

	/*
	 * The only property of this unit we are interested in is the
	 * clock source validity. If that isn't readable, just bail out.
	 */
1814
	if (!uac_v2v3_control_is_readable(hdr->bmControls,
1815
				      UAC2_CS_CONTROL_CLOCK_VALID))
1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829
		return 0;

	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
	if (!cval)
		return -ENOMEM;

	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);

	cval->min = 0;
	cval->max = 1;
	cval->channels = 1;
	cval->val_type = USB_MIXER_BOOLEAN;
	cval->control = UAC2_CS_CONTROL_CLOCK_VALID;

1830 1831 1832
	cval->master_readonly = 1;
	/* From UAC2 5.2.5.1.2 "Only the get request is supported." */
	kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1833 1834

	if (!kctl) {
1835
		usb_mixer_elem_info_free(cval);
1836 1837 1838 1839
		return -ENOMEM;
	}

	kctl->private_free = snd_usb_mixer_elem_free;
1840
	ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851
				       name, sizeof(name));
	if (ret > 0)
		snprintf(kctl->id.name, sizeof(kctl->id.name),
			 "%s Validity", name);
	else
		snprintf(kctl->id.name, sizeof(kctl->id.name),
			 "Clock Source %d Validity", hdr->bClockID);

	return snd_usb_mixer_add_control(&cval->head, kctl);
}

L
Linus Torvalds 已提交
1852 1853 1854
/*
 * parse a feature unit
 *
L
Lucas De Marchi 已提交
1855
 * most of controls are defined here.
L
Linus Torvalds 已提交
1856
 */
1857 1858
static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
				    void *_ftr)
L
Linus Torvalds 已提交
1859 1860
{
	int channels, i, j;
1861
	struct usb_audio_term iterm;
L
Linus Torvalds 已提交
1862 1863
	unsigned int master_bits, first_ch_bits;
	int err, csize;
1864 1865 1866 1867 1868 1869 1870
	struct uac_feature_unit_descriptor *hdr = _ftr;
	__u8 *bmaControls;

	if (state->mixer->protocol == UAC_VERSION_1) {
		csize = hdr->bControlSize;
		channels = (hdr->bLength - 7) / csize - 1;
		bmaControls = hdr->bmaControls;
1871
	} else if (state->mixer->protocol == UAC_VERSION_2) {
1872 1873
		struct uac2_feature_unit_descriptor *ftr = _ftr;
		csize = 4;
1874
		channels = (hdr->bLength - 6) / 4 - 1;
1875
		bmaControls = ftr->bmaControls;
1876 1877 1878 1879 1880 1881
	} else { /* UAC_VERSION_3 */
		struct uac3_feature_unit_descriptor *ftr = _ftr;

		csize = 4;
		channels = (ftr->bLength - 7) / 4 - 1;
		bmaControls = ftr->bmaControls;
L
Linus Torvalds 已提交
1882 1883 1884
	}

	/* parse the source unit */
1885 1886
	err = parse_audio_unit(state, hdr->bSourceID);
	if (err < 0)
L
Linus Torvalds 已提交
1887 1888 1889
		return err;

	/* determine the input source type and name */
1890 1891 1892
	err = check_input_term(state, hdr->bSourceID, &iterm);
	if (err < 0)
		return err;
L
Linus Torvalds 已提交
1893

1894
	master_bits = snd_usb_combine_bytes(bmaControls, csize);
1895 1896 1897
	/* master configuration quirks */
	switch (state->chip->usb_id) {
	case USB_ID(0x08bb, 0x2702):
1898 1899
		usb_audio_info(state->chip,
			       "usbmixer: master volume quirk for PCM2702 chip\n");
1900
		/* disable non-functional volume control */
1901
		master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1902
		break;
1903
	case USB_ID(0x1130, 0xf211):
1904 1905
		usb_audio_info(state->chip,
			       "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1906 1907 1908 1909
		/* disable non-functional volume control */
		channels = 0;
		break;

1910
	}
L
Linus Torvalds 已提交
1911
	if (channels > 0)
1912
		first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
L
Linus Torvalds 已提交
1913 1914
	else
		first_ch_bits = 0;
1915 1916 1917 1918 1919

	if (state->mixer->protocol == UAC_VERSION_1) {
		/* check all control types */
		for (i = 0; i < 10; i++) {
			unsigned int ch_bits = 0;
1920 1921
			int control = audio_feature_info[i].control;

1922
			for (j = 0; j < channels; j++) {
1923 1924 1925 1926
				unsigned int mask;

				mask = snd_usb_combine_bytes(bmaControls +
							     csize * (j+1), csize);
1927 1928 1929 1930
				if (mask & (1 << i))
					ch_bits |= (1 << j);
			}
			/* audio class v1 controls are never read-only */
1931 1932 1933 1934 1935 1936

			/*
			 * The first channel must be set
			 * (for ease of programming).
			 */
			if (ch_bits & 1)
1937
				build_feature_ctl(state, _ftr, ch_bits, control,
1938
						  &iterm, unitid, 0);
1939
			if (master_bits & (1 << i))
1940 1941
				build_feature_ctl(state, _ftr, 0, control,
						  &iterm, unitid, 0);
1942
		}
1943
	} else { /* UAC_VERSION_2/3 */
1944
		for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1945 1946
			unsigned int ch_bits = 0;
			unsigned int ch_read_only = 0;
1947
			int control = audio_feature_info[i].control;
1948 1949

			for (j = 0; j < channels; j++) {
1950 1951 1952 1953
				unsigned int mask;

				mask = snd_usb_combine_bytes(bmaControls +
							     csize * (j+1), csize);
1954
				if (uac_v2v3_control_is_readable(mask, control)) {
1955
					ch_bits |= (1 << j);
1956
					if (!uac_v2v3_control_is_writeable(mask, control))
1957 1958 1959 1960
						ch_read_only |= (1 << j);
				}
			}

1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974
			/*
			 * NOTE: build_feature_ctl() will mark the control
			 * read-only if all channels are marked read-only in
			 * the descriptors. Otherwise, the control will be
			 * reported as writeable, but the driver will not
			 * actually issue a write command for read-only
			 * channels.
			 */

			/*
			 * The first channel must be set
			 * (for ease of programming).
			 */
			if (ch_bits & 1)
1975
				build_feature_ctl(state, _ftr, ch_bits, control,
1976
						  &iterm, unitid, ch_read_only);
1977
			if (uac_v2v3_control_is_readable(master_bits, control))
1978 1979
				build_feature_ctl(state, _ftr, 0, control,
						  &iterm, unitid,
1980 1981
						  !uac_v2v3_control_is_writeable(master_bits,
										 control));
L
Linus Torvalds 已提交
1982 1983 1984 1985 1986 1987 1988 1989 1990 1991
		}
	}

	return 0;
}

/*
 * Mixer Unit
 */

1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016
/* check whether the given in/out overflows bmMixerControls matrix */
static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc,
				  int protocol, int num_ins, int num_outs)
{
	u8 *hdr = (u8 *)desc;
	u8 *c = uac_mixer_unit_bmControls(desc, protocol);
	size_t rest; /* remaining bytes after bmMixerControls */

	switch (protocol) {
	case UAC_VERSION_1:
	default:
		rest = 1; /* iMixer */
		break;
	case UAC_VERSION_2:
		rest = 2; /* bmControls + iMixer */
		break;
	case UAC_VERSION_3:
		rest = 6; /* bmControls + wMixerDescrStr */
		break;
	}

	/* overflow? */
	return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
}

L
Linus Torvalds 已提交
2017 2018 2019 2020 2021 2022
/*
 * build a mixer unit control
 *
 * the callbacks are identical with feature unit.
 * input channel number (zero based) is given in control field instead.
 */
2023 2024
static void build_mixer_unit_ctl(struct mixer_build *state,
				 struct uac_mixer_unit_descriptor *desc,
2025 2026
				 int in_pin, int in_ch, int num_outs,
				 int unitid, struct usb_audio_term *iterm)
L
Linus Torvalds 已提交
2027
{
2028
	struct usb_mixer_elem_info *cval;
L
Linus Torvalds 已提交
2029
	unsigned int i, len;
2030
	struct snd_kcontrol *kctl;
2031
	const struct usbmix_name_map *map;
L
Linus Torvalds 已提交
2032

2033
	map = find_map(state->map, unitid, 0);
2034
	if (check_ignored_ctl(map))
L
Linus Torvalds 已提交
2035 2036
		return;

2037
	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2038
	if (!cval)
L
Linus Torvalds 已提交
2039 2040
		return;

2041
	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
L
Linus Torvalds 已提交
2042 2043 2044
	cval->control = in_ch + 1; /* based on 1 */
	cval->val_type = USB_MIXER_S16;
	for (i = 0; i < num_outs; i++) {
2045 2046 2047
		__u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);

		if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
L
Linus Torvalds 已提交
2048 2049 2050 2051 2052 2053 2054 2055 2056
			cval->cmask |= (1 << i);
			cval->channels++;
		}
	}

	/* get min/max values */
	get_min_max(cval, 0);

	kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2057
	if (!kctl) {
2058
		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2059
		usb_mixer_elem_info_free(cval);
L
Linus Torvalds 已提交
2060 2061
		return;
	}
2062
	kctl->private_free = snd_usb_mixer_elem_free;
L
Linus Torvalds 已提交
2063

2064
	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2065
	if (!len)
2066
		len = get_term_name(state->chip, iterm, kctl->id.name,
2067 2068
				    sizeof(kctl->id.name), 0);
	if (!len)
L
Linus Torvalds 已提交
2069
		len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
T
Takashi Iwai 已提交
2070
	append_ctl_name(kctl, " Volume");
L
Linus Torvalds 已提交
2071

2072
	usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2073 2074
		    cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
	snd_usb_mixer_add_control(&cval->head, kctl);
L
Linus Torvalds 已提交
2075 2076
}

2077 2078 2079 2080
static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
				      void *raw_desc)
{
	struct usb_audio_term iterm;
2081
	unsigned int control, bmctls, term_id;
2082 2083

	if (state->mixer->protocol == UAC_VERSION_2) {
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094
		struct uac2_input_terminal_descriptor *d_v2 = raw_desc;
		control = UAC2_TE_CONNECTOR;
		term_id = d_v2->bTerminalID;
		bmctls = le16_to_cpu(d_v2->bmControls);
	} else if (state->mixer->protocol == UAC_VERSION_3) {
		struct uac3_input_terminal_descriptor *d_v3 = raw_desc;
		control = UAC3_TE_INSERTION;
		term_id = d_v3->bTerminalID;
		bmctls = le32_to_cpu(d_v3->bmControls);
	} else {
		return 0; /* UAC1. No Insertion control */
2095
	}
2096 2097 2098 2099 2100

	check_input_term(state, term_id, &iterm);

	/* Check for jack detection. */
	if (uac_v2v3_control_is_readable(bmctls, control))
2101
		build_connector_control(state->mixer, &iterm, true);
2102

2103 2104 2105
	return 0;
}

L
Linus Torvalds 已提交
2106 2107 2108
/*
 * parse a mixer unit
 */
2109 2110
static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
				  void *raw_desc)
L
Linus Torvalds 已提交
2111
{
2112
	struct uac_mixer_unit_descriptor *desc = raw_desc;
2113
	struct usb_audio_term iterm;
L
Linus Torvalds 已提交
2114 2115 2116
	int input_pins, num_ins, num_outs;
	int pin, ich, err;

2117 2118
	err = uac_mixer_unit_get_channels(state, desc);
	if (err < 0) {
2119 2120 2121
		usb_audio_err(state->chip,
			      "invalid MIXER UNIT descriptor %d\n",
			      unitid);
2122
		return err;
L
Linus Torvalds 已提交
2123 2124
	}

2125 2126 2127
	num_outs = err;
	input_pins = desc->bNrInPins;

L
Linus Torvalds 已提交
2128 2129 2130
	num_ins = 0;
	ich = 0;
	for (pin = 0; pin < input_pins; pin++) {
2131
		err = parse_audio_unit(state, desc->baSourceID[pin]);
L
Linus Torvalds 已提交
2132
		if (err < 0)
2133
			continue;
2134
		/* no bmControls field (e.g. Maya44) -> ignore */
2135
		if (!num_outs)
2136
			continue;
2137
		err = check_input_term(state, desc->baSourceID[pin], &iterm);
L
Linus Torvalds 已提交
2138 2139 2140
		if (err < 0)
			return err;
		num_ins += iterm.channels;
2141 2142 2143
		if (mixer_bitmap_overflow(desc, state->mixer->protocol,
					  num_ins, num_outs))
			break;
2144
		for (; ich < num_ins; ich++) {
L
Linus Torvalds 已提交
2145 2146
			int och, ich_has_controls = 0;

2147 2148 2149 2150 2151
			for (och = 0; och < num_outs; och++) {
				__u8 *c = uac_mixer_unit_bmControls(desc,
						state->mixer->protocol);

				if (check_matrix_bitmap(c, ich, och, num_outs)) {
L
Linus Torvalds 已提交
2152 2153 2154 2155 2156
					ich_has_controls = 1;
					break;
				}
			}
			if (ich_has_controls)
2157
				build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
L
Linus Torvalds 已提交
2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168
						     unitid, &iterm);
		}
	}
	return 0;
}

/*
 * Processing Unit / Extension Unit
 */

/* get callback for processing/extension unit */
2169 2170
static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
2171
{
2172
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
2173 2174 2175
	int err, val;

	err = get_cur_ctl_value(cval, cval->control << 8, &val);
2176
	if (err < 0) {
L
Linus Torvalds 已提交
2177
		ucontrol->value.integer.value[0] = cval->min;
2178
		return filter_error(cval, err);
L
Linus Torvalds 已提交
2179 2180 2181 2182 2183 2184 2185
	}
	val = get_relative_value(cval, val);
	ucontrol->value.integer.value[0] = val;
	return 0;
}

/* put callback for processing/extension unit */
2186 2187
static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
2188
{
2189
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
2190 2191 2192
	int val, oval, err;

	err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2193 2194
	if (err < 0)
		return filter_error(cval, err);
L
Linus Torvalds 已提交
2195 2196 2197 2198 2199 2200 2201 2202 2203 2204
	val = ucontrol->value.integer.value[0];
	val = get_abs_value(cval, val);
	if (val != oval) {
		set_cur_ctl_value(cval, cval->control << 8, val);
		return 1;
	}
	return 0;
}

/* alsa control interface for processing/extension unit */
2205
static const struct snd_kcontrol_new mixer_procunit_ctl = {
L
Linus Torvalds 已提交
2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228
	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
	.name = "", /* will be filled later */
	.info = mixer_ctl_feature_info,
	.get = mixer_ctl_procunit_get,
	.put = mixer_ctl_procunit_put,
};

/*
 * predefined data for processing units
 */
struct procunit_value_info {
	int control;
	char *suffix;
	int val_type;
	int min_value;
};

struct procunit_info {
	int type;
	char *name;
	struct procunit_value_info *values;
};

2229 2230 2231 2232 2233
static struct procunit_value_info undefined_proc_info[] = {
	{ 0x00, "Control Undefined", 0 },
	{ 0 }
};

L
Linus Torvalds 已提交
2234
static struct procunit_value_info updown_proc_info[] = {
2235 2236
	{ UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
	{ UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
L
Linus Torvalds 已提交
2237 2238 2239
	{ 0 }
};
static struct procunit_value_info prologic_proc_info[] = {
2240 2241
	{ UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
	{ UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
L
Linus Torvalds 已提交
2242 2243 2244
	{ 0 }
};
static struct procunit_value_info threed_enh_proc_info[] = {
2245 2246
	{ UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
	{ UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
L
Linus Torvalds 已提交
2247 2248 2249
	{ 0 }
};
static struct procunit_value_info reverb_proc_info[] = {
2250 2251 2252 2253
	{ UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
	{ UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
	{ UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
	{ UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
L
Linus Torvalds 已提交
2254 2255 2256
	{ 0 }
};
static struct procunit_value_info chorus_proc_info[] = {
2257 2258 2259 2260
	{ UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
	{ UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
	{ UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
	{ UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
L
Linus Torvalds 已提交
2261 2262 2263
	{ 0 }
};
static struct procunit_value_info dcr_proc_info[] = {
2264 2265 2266 2267 2268 2269
	{ UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
	{ UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
	{ UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
	{ UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
	{ UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
	{ UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
L
Linus Torvalds 已提交
2270 2271 2272 2273
	{ 0 }
};

static struct procunit_info procunits[] = {
2274 2275 2276 2277 2278 2279
	{ UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
	{ UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
	{ UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
	{ UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
	{ UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
	{ UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
L
Linus Torvalds 已提交
2280 2281
	{ 0 },
};
2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298

static struct procunit_value_info uac3_updown_proc_info[] = {
	{ UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
	{ 0 }
};
static struct procunit_value_info uac3_stereo_ext_proc_info[] = {
	{ UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
	{ 0 }
};

static struct procunit_info uac3_procunits[] = {
	{ UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info },
	{ UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info },
	{ UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info },
	{ 0 },
};

2299 2300 2301 2302
/*
 * predefined data for extension units
 */
static struct procunit_value_info clock_rate_xu_info[] = {
2303 2304
	{ USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
	{ 0 }
2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324
};
static struct procunit_value_info clock_source_xu_info[] = {
	{ USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
	{ 0 }
};
static struct procunit_value_info spdif_format_xu_info[] = {
	{ USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
	{ 0 }
};
static struct procunit_value_info soft_limit_xu_info[] = {
	{ USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
	{ 0 }
};
static struct procunit_info extunits[] = {
	{ USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
	{ USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
	{ USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
	{ USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
	{ 0 }
};
2325

L
Linus Torvalds 已提交
2326 2327 2328
/*
 * build a processing/extension unit
 */
2329 2330
static int build_audio_procunit(struct mixer_build *state, int unitid,
				void *raw_desc, struct procunit_info *list,
2331
				bool extension_unit)
L
Linus Torvalds 已提交
2332
{
2333
	struct uac_processing_unit_descriptor *desc = raw_desc;
2334
	int num_ins;
2335 2336
	struct usb_mixer_elem_info *cval;
	struct snd_kcontrol *kctl;
L
Linus Torvalds 已提交
2337 2338 2339
	int i, err, nameid, type, len;
	struct procunit_info *info;
	struct procunit_value_info *valinfo;
2340
	const struct usbmix_name_map *map;
L
Linus Torvalds 已提交
2341 2342 2343 2344 2345 2346 2347
	static struct procunit_value_info default_value_info[] = {
		{ 0x01, "Switch", USB_MIXER_BOOLEAN },
		{ 0 }
	};
	static struct procunit_info default_info = {
		0, NULL, default_value_info
	};
2348 2349
	const char *name = extension_unit ?
		"Extension Unit" : "Processing Unit";
L
Linus Torvalds 已提交
2350

2351
	num_ins = desc->bNrInPins;
L
Linus Torvalds 已提交
2352
	for (i = 0; i < num_ins; i++) {
2353 2354
		err = parse_audio_unit(state, desc->baSourceID[i]);
		if (err < 0)
L
Linus Torvalds 已提交
2355 2356 2357
			return err;
	}

2358
	type = le16_to_cpu(desc->wProcessType);
L
Linus Torvalds 已提交
2359 2360 2361
	for (info = list; info && info->type; info++)
		if (info->type == type)
			break;
2362
	if (!info || !info->type)
L
Linus Torvalds 已提交
2363 2364 2365
		info = &default_info;

	for (valinfo = info->values; valinfo->control; valinfo++) {
2366
		__u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2367

2368 2369 2370 2371 2372 2373 2374 2375 2376 2377
		if (state->mixer->protocol == UAC_VERSION_1) {
			if (!(controls[valinfo->control / 8] &
					(1 << ((valinfo->control % 8) - 1))))
				continue;
		} else { /* UAC_VERSION_2/3 */
			if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
							  valinfo->control))
				continue;
		}

2378
		map = find_map(state->map, unitid, valinfo->control);
2379
		if (check_ignored_ctl(map))
L
Linus Torvalds 已提交
2380
			continue;
2381
		cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2382
		if (!cval)
L
Linus Torvalds 已提交
2383
			return -ENOMEM;
2384
		snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
L
Linus Torvalds 已提交
2385 2386 2387 2388
		cval->control = valinfo->control;
		cval->val_type = valinfo->val_type;
		cval->channels = 1;

2389 2390 2391 2392 2393
		if (state->mixer->protocol > UAC_VERSION_1 &&
		    !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
						   valinfo->control))
			cval->master_readonly = 1;

L
Linus Torvalds 已提交
2394
		/* get min/max values */
2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416
		switch (type) {
		case UAC_PROCESS_UP_DOWNMIX: {
			bool mode_sel = false;

			switch (state->mixer->protocol) {
			case UAC_VERSION_1:
			case UAC_VERSION_2:
			default:
				if (cval->control == UAC_UD_MODE_SELECT)
					mode_sel = true;
				break;
			case UAC_VERSION_3:
				if (cval->control == UAC3_UD_MODE_SELECT)
					mode_sel = true;
				break;
			}

			if (mode_sel) {
				__u8 *control_spec = uac_processing_unit_specific(desc,
								state->mixer->protocol);
				cval->min = 1;
				cval->max = control_spec[0];
2417 2418
				cval->res = 1;
				cval->initialized = 1;
2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437
				break;
			}

			get_min_max(cval, valinfo->min_value);
			break;
		}
		case USB_XU_CLOCK_RATE:
			/*
			 * E-Mu USB 0404/0202/TrackerPre/0204
			 * samplerate control quirk
			 */
			cval->min = 0;
			cval->max = 5;
			cval->res = 1;
			cval->initialized = 1;
			break;
		default:
			get_min_max(cval, valinfo->min_value);
			break;
2438
		}
L
Linus Torvalds 已提交
2439 2440

		kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2441
		if (!kctl) {
2442
			usb_mixer_elem_info_free(cval);
L
Linus Torvalds 已提交
2443 2444
			return -ENOMEM;
		}
2445
		kctl->private_free = snd_usb_mixer_elem_free;
L
Linus Torvalds 已提交
2446

2447
		if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2448
			/* nothing */ ;
2449
		} else if (info->name) {
L
Linus Torvalds 已提交
2450
			strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2451
		} else {
2452 2453 2454 2455
			if (extension_unit)
				nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
			else
				nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
L
Linus Torvalds 已提交
2456 2457
			len = 0;
			if (nameid)
2458 2459
				len = snd_usb_copy_string_desc(state->chip,
							       nameid,
2460 2461 2462
							       kctl->id.name,
							       sizeof(kctl->id.name));
			if (!len)
L
Linus Torvalds 已提交
2463 2464
				strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
		}
T
Takashi Iwai 已提交
2465 2466
		append_ctl_name(kctl, " ");
		append_ctl_name(kctl, valinfo->suffix);
L
Linus Torvalds 已提交
2467

2468
		usb_audio_dbg(state->chip,
2469
			      "[%d] PU [%s] ch = %d, val = %d/%d\n",
2470
			      cval->head.id, kctl->id.name, cval->channels,
2471 2472
			      cval->min, cval->max);

2473
		err = snd_usb_mixer_add_control(&cval->head, kctl);
2474
		if (err < 0)
L
Linus Torvalds 已提交
2475 2476 2477 2478 2479
			return err;
	}
	return 0;
}

2480 2481
static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
				       void *raw_desc)
L
Linus Torvalds 已提交
2482
{
2483 2484 2485 2486 2487
	switch (state->mixer->protocol) {
	case UAC_VERSION_1:
	case UAC_VERSION_2:
	default:
		return build_audio_procunit(state, unitid, raw_desc,
2488
					    procunits, false);
2489 2490
	case UAC_VERSION_3:
		return build_audio_procunit(state, unitid, raw_desc,
2491
					    uac3_procunits, false);
2492
	}
L
Linus Torvalds 已提交
2493 2494
}

2495 2496
static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
				      void *raw_desc)
L
Linus Torvalds 已提交
2497
{
2498 2499 2500 2501
	/*
	 * Note that we parse extension units with processing unit descriptors.
	 * That's ok as the layout is the same.
	 */
2502
	return build_audio_procunit(state, unitid, raw_desc, extunits, true);
L
Linus Torvalds 已提交
2503 2504 2505 2506 2507 2508
}

/*
 * Selector Unit
 */

2509 2510
/*
 * info callback for selector unit
L
Linus Torvalds 已提交
2511 2512
 * use an enumerator type for routing
 */
2513 2514
static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
				   struct snd_ctl_elem_info *uinfo)
L
Linus Torvalds 已提交
2515
{
2516
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2517
	const char **itemlist = (const char **)kcontrol->private_value;
L
Linus Torvalds 已提交
2518

2519 2520
	if (snd_BUG_ON(!itemlist))
		return -EINVAL;
2521
	return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
L
Linus Torvalds 已提交
2522 2523 2524
}

/* get callback for selector unit */
2525 2526
static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
2527
{
2528
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
2529 2530
	int val, err;

2531
	err = get_cur_ctl_value(cval, cval->control << 8, &val);
L
Linus Torvalds 已提交
2532
	if (err < 0) {
2533 2534
		ucontrol->value.enumerated.item[0] = 0;
		return filter_error(cval, err);
L
Linus Torvalds 已提交
2535 2536 2537 2538 2539 2540 2541
	}
	val = get_relative_value(cval, val);
	ucontrol->value.enumerated.item[0] = val;
	return 0;
}

/* put callback for selector unit */
2542 2543
static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
2544
{
2545
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
2546 2547
	int val, oval, err;

2548
	err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2549 2550
	if (err < 0)
		return filter_error(cval, err);
L
Linus Torvalds 已提交
2551 2552 2553
	val = ucontrol->value.enumerated.item[0];
	val = get_abs_value(cval, val);
	if (val != oval) {
2554
		set_cur_ctl_value(cval, cval->control << 8, val);
L
Linus Torvalds 已提交
2555 2556 2557 2558 2559 2560
		return 1;
	}
	return 0;
}

/* alsa control interface for selector unit */
2561
static const struct snd_kcontrol_new mixer_selectunit_ctl = {
L
Linus Torvalds 已提交
2562 2563 2564 2565 2566 2567 2568
	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
	.name = "", /* will be filled later */
	.info = mixer_ctl_selector_info,
	.get = mixer_ctl_selector_get,
	.put = mixer_ctl_selector_put,
};

2569 2570
/*
 * private free callback.
L
Linus Torvalds 已提交
2571 2572
 * free both private_data and private_value
 */
2573
static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
L
Linus Torvalds 已提交
2574 2575 2576 2577
{
	int i, num_ins = 0;

	if (kctl->private_data) {
2578
		struct usb_mixer_elem_info *cval = kctl->private_data;
L
Linus Torvalds 已提交
2579
		num_ins = cval->max;
2580
		usb_mixer_elem_info_free(cval);
L
Linus Torvalds 已提交
2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594
		kctl->private_data = NULL;
	}
	if (kctl->private_value) {
		char **itemlist = (char **)kctl->private_value;
		for (i = 0; i < num_ins; i++)
			kfree(itemlist[i]);
		kfree(itemlist);
		kctl->private_value = 0;
	}
}

/*
 * parse a selector unit
 */
2595 2596
static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
				     void *raw_desc)
L
Linus Torvalds 已提交
2597
{
2598
	struct uac_selector_unit_descriptor *desc = raw_desc;
L
Linus Torvalds 已提交
2599 2600
	unsigned int i, nameid, len;
	int err;
2601 2602
	struct usb_mixer_elem_info *cval;
	struct snd_kcontrol *kctl;
2603
	const struct usbmix_name_map *map;
L
Linus Torvalds 已提交
2604 2605
	char **namelist;

2606
	for (i = 0; i < desc->bNrInPins; i++) {
2607 2608
		err = parse_audio_unit(state, desc->baSourceID[i]);
		if (err < 0)
L
Linus Torvalds 已提交
2609 2610 2611
			return err;
	}

2612
	if (desc->bNrInPins == 1) /* only one ? nonsense! */
L
Linus Torvalds 已提交
2613 2614
		return 0;

2615
	map = find_map(state->map, unitid, 0);
2616
	if (check_ignored_ctl(map))
L
Linus Torvalds 已提交
2617 2618
		return 0;

2619
	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2620
	if (!cval)
L
Linus Torvalds 已提交
2621
		return -ENOMEM;
2622
	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
L
Linus Torvalds 已提交
2623 2624 2625
	cval->val_type = USB_MIXER_U8;
	cval->channels = 1;
	cval->min = 1;
2626
	cval->max = desc->bNrInPins;
L
Linus Torvalds 已提交
2627 2628 2629
	cval->res = 1;
	cval->initialized = 1;

2630 2631 2632
	switch (state->mixer->protocol) {
	case UAC_VERSION_1:
	default:
2633
		cval->control = 0;
2634 2635 2636 2637 2638 2639 2640 2641 2642 2643
		break;
	case UAC_VERSION_2:
	case UAC_VERSION_3:
		if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
		    desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
			cval->control = UAC2_CX_CLOCK_SELECTOR;
		else /* UAC2/3_SELECTOR_UNIT */
			cval->control = UAC2_SU_SELECTOR;
		break;
	}
2644

2645
	namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2646
	if (!namelist) {
2647 2648
		err = -ENOMEM;
		goto error_cval;
L
Linus Torvalds 已提交
2649 2650
	}
#define MAX_ITEM_NAME_LEN	64
2651
	for (i = 0; i < desc->bNrInPins; i++) {
2652
		struct usb_audio_term iterm;
L
Linus Torvalds 已提交
2653 2654
		len = 0;
		namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2655
		if (!namelist[i]) {
2656 2657
			err = -ENOMEM;
			goto error_name;
L
Linus Torvalds 已提交
2658
		}
2659 2660
		len = check_mapped_selector_name(state, unitid, i, namelist[i],
						 MAX_ITEM_NAME_LEN);
2661
		if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2662 2663
			len = get_term_name(state->chip, &iterm, namelist[i],
					    MAX_ITEM_NAME_LEN, 0);
L
Linus Torvalds 已提交
2664
		if (! len)
2665
			sprintf(namelist[i], "Input %u", i);
L
Linus Torvalds 已提交
2666 2667 2668 2669
	}

	kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
	if (! kctl) {
2670
		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2671 2672
		err = -ENOMEM;
		goto error_name;
L
Linus Torvalds 已提交
2673 2674 2675 2676
	}
	kctl->private_value = (unsigned long)namelist;
	kctl->private_free = usb_mixer_selector_elem_free;

2677
	/* check the static mapping table at first */
2678
	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2679
	if (!len) {
2680
		/* no mapping ? */
2681 2682 2683 2684
		switch (state->mixer->protocol) {
		case UAC_VERSION_1:
		case UAC_VERSION_2:
		default:
2685
		/* if iSelector is given, use it */
2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696
			nameid = uac_selector_unit_iSelector(desc);
			if (nameid)
				len = snd_usb_copy_string_desc(state->chip,
							nameid, kctl->id.name,
							sizeof(kctl->id.name));
			break;
		case UAC_VERSION_3:
			/* TODO: Class-Specific strings not yet supported */
			break;
		}

2697 2698
		/* ... or pick up the terminal name at next */
		if (!len)
2699
			len = get_term_name(state->chip, &state->oterm,
L
Linus Torvalds 已提交
2700
				    kctl->id.name, sizeof(kctl->id.name), 0);
2701
		/* ... or use the fixed string "USB" as the last resort */
2702
		if (!len)
L
Linus Torvalds 已提交
2703 2704
			strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));

2705
		/* and add the proper suffix */
2706 2707
		if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
		    desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2708 2709
			append_ctl_name(kctl, " Clock Source");
		else if ((state->oterm.type & 0xff00) == 0x0100)
T
Takashi Iwai 已提交
2710
			append_ctl_name(kctl, " Capture Source");
L
Linus Torvalds 已提交
2711
		else
T
Takashi Iwai 已提交
2712
			append_ctl_name(kctl, " Playback Source");
L
Linus Torvalds 已提交
2713 2714
	}

2715
	usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2716 2717
		    cval->head.id, kctl->id.name, desc->bNrInPins);
	return snd_usb_mixer_add_control(&cval->head, kctl);
2718 2719 2720 2721 2722 2723 2724 2725

 error_name:
	for (i = 0; i < desc->bNrInPins; i++)
		kfree(namelist[i]);
	kfree(namelist);
 error_cval:
	usb_mixer_elem_info_free(cval);
	return err;
L
Linus Torvalds 已提交
2726 2727 2728 2729 2730 2731
}

/*
 * parse an audio unit recursively
 */

2732
static int parse_audio_unit(struct mixer_build *state, int unitid)
L
Linus Torvalds 已提交
2733 2734
{
	unsigned char *p1;
2735
	int protocol = state->mixer->protocol;
L
Linus Torvalds 已提交
2736 2737 2738 2739 2740 2741

	if (test_and_set_bit(unitid, state->unitbitmap))
		return 0; /* the unit already visited */

	p1 = find_audio_control_unit(state, unitid);
	if (!p1) {
2742
		usb_audio_err(state->chip, "unit %d not found!\n", unitid);
L
Linus Torvalds 已提交
2743 2744 2745
		return -EINVAL;
	}

2746 2747 2748 2749 2750
	if (!snd_usb_validate_audio_desc(p1, protocol)) {
		usb_audio_dbg(state->chip, "invalid unit %d\n", unitid);
		return 0; /* skip invalid unit */
	}

2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788
	switch (PTYPE(protocol, p1[2])) {
	case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
	case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
	case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
		return parse_audio_input_terminal(state, unitid, p1);
	case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
	case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
	case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
		return parse_audio_mixer_unit(state, unitid, p1);
	case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
	case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
		return parse_clock_source_unit(state, unitid, p1);
	case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
	case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
	case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
	case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
	case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
		return parse_audio_selector_unit(state, unitid, p1);
	case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
	case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
	case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT):
		return parse_audio_feature_unit(state, unitid, p1);
	case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
	case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
	case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
		return parse_audio_processing_unit(state, unitid, p1);
	case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
	case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
	case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
		return parse_audio_extension_unit(state, unitid, p1);
	case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
	case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
		return 0; /* FIXME - effect units not implemented yet */
	default:
		usb_audio_err(state->chip,
			      "unit %u: unexpected type 0x%02x\n",
			      unitid, p1[2]);
		return -EINVAL;
L
Linus Torvalds 已提交
2789 2790 2791
	}
}

2792 2793
static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
{
2794 2795 2796
	/* kill pending URBs */
	snd_usb_mixer_disconnect(mixer);

2797 2798 2799 2800 2801
	kfree(mixer->id_elems);
	if (mixer->urb) {
		kfree(mixer->urb->transfer_buffer);
		usb_free_urb(mixer->urb);
	}
2802
	usb_free_urb(mixer->rc_urb);
2803
	kfree(mixer->rc_setup_packet);
2804 2805 2806
	kfree(mixer);
}

2807
static int snd_usb_mixer_dev_free(struct snd_device *device)
2808 2809 2810 2811 2812 2813
{
	struct usb_mixer_interface *mixer = device->device_data;
	snd_usb_mixer_free(mixer);
	return 0;
}

2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050
/* UAC3 predefined channels configuration */
struct uac3_badd_profile {
	int subclass;
	const char *name;
	int c_chmask;	/* capture channels mask */
	int p_chmask;	/* playback channels mask */
	int st_chmask;	/* side tone mixing channel mask */
};

static struct uac3_badd_profile uac3_badd_profiles[] = {
	{
		/*
		 * BAIF, BAOF or combination of both
		 * IN: Mono or Stereo cfg, Mono alt possible
		 * OUT: Mono or Stereo cfg, Mono alt possible
		 */
		.subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
		.name = "GENERIC IO",
		.c_chmask = -1,		/* dynamic channels */
		.p_chmask = -1,		/* dynamic channels */
	},
	{
		/* BAOF; Stereo only cfg, Mono alt possible */
		.subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
		.name = "HEADPHONE",
		.p_chmask = 3,
	},
	{
		/* BAOF; Mono or Stereo cfg, Mono alt possible */
		.subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
		.name = "SPEAKER",
		.p_chmask = -1,		/* dynamic channels */
	},
	{
		/* BAIF; Mono or Stereo cfg, Mono alt possible */
		.subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
		.name = "MICROPHONE",
		.c_chmask = -1,		/* dynamic channels */
	},
	{
		/*
		 * BAIOF topology
		 * IN: Mono only
		 * OUT: Mono or Stereo cfg, Mono alt possible
		 */
		.subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
		.name = "HEADSET",
		.c_chmask = 1,
		.p_chmask = -1,		/* dynamic channels */
		.st_chmask = 1,
	},
	{
		/* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
		.subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
		.name = "HEADSET ADAPTER",
		.c_chmask = 1,
		.p_chmask = 3,
		.st_chmask = 1,
	},
	{
		/* BAIF + BAOF; IN: Mono only; OUT: Mono only */
		.subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
		.name = "SPEAKERPHONE",
		.c_chmask = 1,
		.p_chmask = 1,
	},
	{ 0 } /* terminator */
};

static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
					      struct uac3_badd_profile *f,
					      int c_chmask, int p_chmask)
{
	/*
	 * If both playback/capture channels are dynamic, make sure
	 * at least one channel is present
	 */
	if (f->c_chmask < 0 && f->p_chmask < 0) {
		if (!c_chmask && !p_chmask) {
			usb_audio_warn(mixer->chip, "BAAD %s: no channels?",
				       f->name);
			return false;
		}
		return true;
	}

	if ((f->c_chmask < 0 && !c_chmask) ||
	    (f->c_chmask >= 0 && f->c_chmask != c_chmask)) {
		usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch",
			       f->name);
		return false;
	}
	if ((f->p_chmask < 0 && !p_chmask) ||
	    (f->p_chmask >= 0 && f->p_chmask != p_chmask)) {
		usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch",
			       f->name);
		return false;
	}
	return true;
}

/*
 * create mixer controls for UAC3 BADD profiles
 *
 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
 *
 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
 */
static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
				       int ctrlif)
{
	struct usb_device *dev = mixer->chip->dev;
	struct usb_interface_assoc_descriptor *assoc;
	int badd_profile = mixer->chip->badd_profile;
	struct uac3_badd_profile *f;
	const struct usbmix_ctl_map *map;
	int p_chmask = 0, c_chmask = 0, st_chmask = 0;
	int i;

	assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;

	/* Detect BADD capture/playback channels from AS EP descriptors */
	for (i = 0; i < assoc->bInterfaceCount; i++) {
		int intf = assoc->bFirstInterface + i;

		struct usb_interface *iface;
		struct usb_host_interface *alts;
		struct usb_interface_descriptor *altsd;
		unsigned int maxpacksize;
		char dir_in;
		int chmask, num;

		if (intf == ctrlif)
			continue;

		iface = usb_ifnum_to_if(dev, intf);
		num = iface->num_altsetting;

		if (num < 2)
			return -EINVAL;

		/*
		 * The number of Channels in an AudioStreaming interface
		 * and the audio sample bit resolution (16 bits or 24
		 * bits) can be derived from the wMaxPacketSize field in
		 * the Standard AS Audio Data Endpoint descriptor in
		 * Alternate Setting 1
		 */
		alts = &iface->altsetting[1];
		altsd = get_iface_desc(alts);

		if (altsd->bNumEndpoints < 1)
			return -EINVAL;

		/* check direction */
		dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
		maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);

		switch (maxpacksize) {
		default:
			usb_audio_err(mixer->chip,
				"incorrect wMaxPacketSize 0x%x for BADD profile\n",
				maxpacksize);
			return -EINVAL;
		case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
		case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
		case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
		case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
			chmask = 1;
			break;
		case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
		case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
		case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
		case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
			chmask = 3;
			break;
		}

		if (dir_in)
			c_chmask = chmask;
		else
			p_chmask = chmask;
	}

	usb_audio_dbg(mixer->chip,
		"UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
		badd_profile, c_chmask, p_chmask);

	/* check the mapping table */
	for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
		if (map->id == badd_profile)
			break;
	}

	if (!map->id)
		return -EINVAL;

	for (f = uac3_badd_profiles; f->name; f++) {
		if (badd_profile == f->subclass)
			break;
	}
	if (!f->name)
		return -EINVAL;
	if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
		return -EINVAL;
	st_chmask = f->st_chmask;

	/* Playback */
	if (p_chmask) {
		/* Master channel, always writable */
		build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
				       UAC3_BADD_FU_ID2, map->map);
		/* Mono/Stereo volume channels, always writable */
		build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
				       UAC3_BADD_FU_ID2, map->map);
	}

	/* Capture */
	if (c_chmask) {
		/* Master channel, always writable */
		build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
				       UAC3_BADD_FU_ID5, map->map);
		/* Mono/Stereo volume channels, always writable */
		build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
				       UAC3_BADD_FU_ID5, map->map);
	}

	/* Side tone-mixing */
	if (st_chmask) {
		/* Master channel, always writable */
		build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
				       UAC3_BADD_FU_ID7, map->map);
		/* Mono volume channel, always writable */
		build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
				       UAC3_BADD_FU_ID7, map->map);
	}

3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067
	/* Insertion Control */
	if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
		struct usb_audio_term iterm, oterm;

		/* Input Term - Insertion control */
		memset(&iterm, 0, sizeof(iterm));
		iterm.id = UAC3_BADD_IT_ID4;
		iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
		build_connector_control(mixer, &iterm, true);

		/* Output Term - Insertion control */
		memset(&oterm, 0, sizeof(oterm));
		oterm.id = UAC3_BADD_OT_ID3;
		oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
		build_connector_control(mixer, &oterm, false);
	}

3068 3069 3070
	return 0;
}

L
Linus Torvalds 已提交
3071 3072 3073
/*
 * create mixer controls
 *
3074
 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
L
Linus Torvalds 已提交
3075
 */
3076
static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
L
Linus Torvalds 已提交
3077
{
3078
	struct mixer_build state;
L
Linus Torvalds 已提交
3079 3080
	int err;
	const struct usbmix_ctl_map *map;
3081
	void *p;
L
Linus Torvalds 已提交
3082 3083

	memset(&state, 0, sizeof(state));
3084 3085
	state.chip = mixer->chip;
	state.mixer = mixer;
3086 3087
	state.buffer = mixer->hostif->extra;
	state.buflen = mixer->hostif->extralen;
L
Linus Torvalds 已提交
3088 3089

	/* check the mapping table */
3090 3091
	for (map = usbmix_ctl_maps; map->id; map++) {
		if (map->id == state.chip->usb_id) {
L
Linus Torvalds 已提交
3092
			state.map = map->map;
3093
			state.selector_map = map->selector_map;
3094
			mixer->ignore_ctl_error = map->ignore_ctl_error;
L
Linus Torvalds 已提交
3095 3096 3097 3098
			break;
		}
	}

3099
	p = NULL;
3100 3101
	while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
					    mixer->hostif->extralen,
3102
					    p, UAC_OUTPUT_TERMINAL)) != NULL) {
3103 3104 3105
		if (!snd_usb_validate_audio_desc(p, mixer->protocol))
			continue; /* skip invalid descriptor */

3106
		if (mixer->protocol == UAC_VERSION_1) {
3107
			struct uac1_output_terminal_descriptor *desc = p;
3108

3109 3110
			/* mark terminal ID as visited */
			set_bit(desc->bTerminalID, state.unitbitmap);
3111 3112 3113 3114
			state.oterm.id = desc->bTerminalID;
			state.oterm.type = le16_to_cpu(desc->wTerminalType);
			state.oterm.name = desc->iTerminal;
			err = parse_audio_unit(&state, desc->bSourceID);
3115
			if (err < 0 && err != -EINVAL)
3116
				return err;
3117
		} else if (mixer->protocol == UAC_VERSION_2) {
3118 3119
			struct uac2_output_terminal_descriptor *desc = p;

3120 3121
			/* mark terminal ID as visited */
			set_bit(desc->bTerminalID, state.unitbitmap);
3122 3123 3124 3125
			state.oterm.id = desc->bTerminalID;
			state.oterm.type = le16_to_cpu(desc->wTerminalType);
			state.oterm.name = desc->iTerminal;
			err = parse_audio_unit(&state, desc->bSourceID);
3126
			if (err < 0 && err != -EINVAL)
3127
				return err;
3128

3129 3130 3131 3132
			/*
			 * For UAC2, use the same approach to also add the
			 * clock selectors
			 */
3133
			err = parse_audio_unit(&state, desc->bCSourceID);
3134
			if (err < 0 && err != -EINVAL)
3135
				return err;
3136

3137
			if (uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3138
							 UAC2_TE_CONNECTOR)) {
3139
				build_connector_control(state.mixer, &state.oterm,
3140 3141
							false);
			}
3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160
		} else {  /* UAC_VERSION_3 */
			struct uac3_output_terminal_descriptor *desc = p;

			/* mark terminal ID as visited */
			set_bit(desc->bTerminalID, state.unitbitmap);
			state.oterm.id = desc->bTerminalID;
			state.oterm.type = le16_to_cpu(desc->wTerminalType);
			state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
			err = parse_audio_unit(&state, desc->bSourceID);
			if (err < 0 && err != -EINVAL)
				return err;

			/*
			 * For UAC3, use the same approach to also add the
			 * clock selectors
			 */
			err = parse_audio_unit(&state, desc->bCSourceID);
			if (err < 0 && err != -EINVAL)
				return err;
3161 3162 3163

			if (uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
							 UAC3_TE_INSERTION)) {
3164
				build_connector_control(state.mixer, &state.oterm,
3165 3166
							false);
			}
3167
		}
L
Linus Torvalds 已提交
3168
	}
3169

L
Linus Torvalds 已提交
3170 3171
	return 0;
}
3172

D
Daniel Mack 已提交
3173
void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3174
{
3175
	struct usb_mixer_elem_list *list;
3176

3177
	for_each_mixer_elem(list, mixer, unitid) {
3178
		struct usb_mixer_elem_info *info =
3179
			mixer_elem_list_to_info(list);
3180 3181
		/* invalidate cache, so the value is read from the device */
		info->cached = 0;
3182
		snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3183
			       &list->kctl->id);
3184
	}
3185 3186
}

3187
static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3188
				    struct usb_mixer_elem_list *list)
3189
{
3190
	struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3191 3192 3193
	static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
				    "S8", "U8", "S16", "U16"};
	snd_iprintf(buffer, "    Info: id=%i, control=%i, cmask=0x%x, "
3194
			    "channels=%i, type=\"%s\"\n", cval->head.id,
3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205
			    cval->control, cval->cmask, cval->channels,
			    val_types[cval->val_type]);
	snd_iprintf(buffer, "    Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
			    cval->min, cval->max, cval->dBmin, cval->dBmax);
}

static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
				    struct snd_info_buffer *buffer)
{
	struct snd_usb_audio *chip = entry->private_data;
	struct usb_mixer_interface *mixer;
3206
	struct usb_mixer_elem_list *list;
3207 3208 3209 3210
	int unitid;

	list_for_each_entry(mixer, &chip->mixer_list, list) {
		snd_iprintf(buffer,
3211
			"USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3212
				chip->usb_id, snd_usb_ctrl_intf(chip),
3213
				mixer->ignore_ctl_error);
3214 3215
		snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
		for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3216
			for_each_mixer_elem(list, mixer, unitid) {
3217 3218 3219 3220 3221 3222 3223 3224 3225
				snd_iprintf(buffer, "  Unit: %i\n", list->id);
				if (list->kctl)
					snd_iprintf(buffer,
						    "    Control: name=\"%s\", index=%i\n",
						    list->kctl->id.name,
						    list->kctl->id.index);
				if (list->dump)
					list->dump(buffer, list);
			}
3226 3227 3228 3229
		}
	}
}

3230 3231 3232
static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
				       int attribute, int value, int index)
{
3233
	struct usb_mixer_elem_list *list;
3234 3235 3236
	__u8 unitid = (index >> 8) & 0xff;
	__u8 control = (value >> 8) & 0xff;
	__u8 channel = value & 0xff;
3237
	unsigned int count = 0;
3238 3239

	if (channel >= MAX_CHANNELS) {
3240 3241 3242
		usb_audio_dbg(mixer->chip,
			"%s(): bogus channel number %d\n",
			__func__, channel);
3243 3244 3245
		return;
	}

3246
	for_each_mixer_elem(list, mixer, unitid)
3247 3248 3249 3250 3251
		count++;

	if (count == 0)
		return;

3252
	for_each_mixer_elem(list, mixer, unitid) {
3253 3254 3255 3256 3257
		struct usb_mixer_elem_info *info;

		if (!list->kctl)
			continue;

3258
		info = mixer_elem_list_to_info(list);
3259
		if (count > 1 && info->control != control)
3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270
			continue;

		switch (attribute) {
		case UAC2_CS_CUR:
			/* invalidate cache, so the value is read from the device */
			if (channel)
				info->cached &= ~(1 << channel);
			else /* master channel */
				info->cached = 0;

			snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3271
				       &info->head.kctl->id);
3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282
			break;

		case UAC2_CS_RANGE:
			/* TODO */
			break;

		case UAC2_CS_MEM:
			/* TODO */
			break;

		default:
3283 3284 3285
			usb_audio_dbg(mixer->chip,
				"unknown attribute %d in interrupt\n",
				attribute);
3286 3287 3288 3289 3290 3291
			break;
		} /* switch */
	}
}

static void snd_usb_mixer_interrupt(struct urb *urb)
3292 3293
{
	struct usb_mixer_interface *mixer = urb->context;
3294
	int len = urb->actual_length;
3295
	int ustatus = urb->status;
3296

3297
	if (ustatus != 0)
3298
		goto requeue;
3299

3300 3301
	if (mixer->protocol == UAC_VERSION_1) {
		struct uac1_status_word *status;
3302

3303 3304 3305
		for (status = urb->transfer_buffer;
		     len >= sizeof(*status);
		     len -= sizeof(*status), status++) {
3306
			dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3307 3308 3309
						status->bStatusType,
						status->bOriginator);

3310
			/* ignore any notifications not from the control interface */
3311 3312
			if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
				UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3313
				continue;
3314 3315 3316

			if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
				snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3317
			else
3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333
				snd_usb_mixer_notify_id(mixer, status->bOriginator);
		}
	} else { /* UAC_VERSION_2 */
		struct uac2_interrupt_data_msg *msg;

		for (msg = urb->transfer_buffer;
		     len >= sizeof(*msg);
		     len -= sizeof(*msg), msg++) {
			/* drop vendor specific and endpoint requests */
			if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
			    (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
				continue;

			snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
						   le16_to_cpu(msg->wValue),
						   le16_to_cpu(msg->wIndex));
3334 3335
		}
	}
3336 3337

requeue:
3338 3339 3340
	if (ustatus != -ENOENT &&
	    ustatus != -ECONNRESET &&
	    ustatus != -ESHUTDOWN) {
3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354
		urb->dev = mixer->chip->dev;
		usb_submit_urb(urb, GFP_ATOMIC);
	}
}

/* create the handler for the optional status interrupt endpoint */
static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
{
	struct usb_endpoint_descriptor *ep;
	void *transfer_buffer;
	int buffer_length;
	unsigned int epnum;

	/* we need one interrupt input endpoint */
3355
	if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3356
		return 0;
3357
	ep = get_endpoint(mixer->hostif, 0);
3358
	if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3359 3360
		return 0;

3361
	epnum = usb_endpoint_num(ep);
3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373
	buffer_length = le16_to_cpu(ep->wMaxPacketSize);
	transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
	if (!transfer_buffer)
		return -ENOMEM;
	mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
	if (!mixer->urb) {
		kfree(transfer_buffer);
		return -ENOMEM;
	}
	usb_fill_int_urb(mixer->urb, mixer->chip->dev,
			 usb_rcvintpipe(mixer->chip->dev, epnum),
			 transfer_buffer, buffer_length,
3374
			 snd_usb_mixer_interrupt, mixer, ep->bInterval);
3375 3376 3377 3378
	usb_submit_urb(mixer->urb, GFP_KERNEL);
	return 0;
}

3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420
static int keep_iface_ctl_get(struct snd_kcontrol *kcontrol,
			      struct snd_ctl_elem_value *ucontrol)
{
	struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);

	ucontrol->value.integer.value[0] = mixer->chip->keep_iface;
	return 0;
}

static int keep_iface_ctl_put(struct snd_kcontrol *kcontrol,
			      struct snd_ctl_elem_value *ucontrol)
{
	struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
	bool keep_iface = !!ucontrol->value.integer.value[0];

	if (mixer->chip->keep_iface == keep_iface)
		return 0;
	mixer->chip->keep_iface = keep_iface;
	return 1;
}

static const struct snd_kcontrol_new keep_iface_ctl = {
	.iface = SNDRV_CTL_ELEM_IFACE_CARD,
	.name = "Keep Interface",
	.info = snd_ctl_boolean_mono_info,
	.get = keep_iface_ctl_get,
	.put = keep_iface_ctl_put,
};

static int create_keep_iface_ctl(struct usb_mixer_interface *mixer)
{
	struct snd_kcontrol *kctl = snd_ctl_new1(&keep_iface_ctl, mixer);

	/* need only one control per card */
	if (snd_ctl_find_id(mixer->chip->card, &kctl->id)) {
		snd_ctl_free_one(kctl);
		return 0;
	}

	return snd_ctl_add(mixer->chip->card, kctl);
}

3421 3422
int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
			 int ignore_error)
3423
{
3424
	static struct snd_device_ops dev_ops = {
3425 3426 3427
		.dev_free = snd_usb_mixer_dev_free
	};
	struct usb_mixer_interface *mixer;
3428
	struct snd_info_entry *entry;
3429
	int err;
3430 3431 3432

	strcpy(chip->card->mixername, "USB Mixer");

3433
	mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3434 3435 3436
	if (!mixer)
		return -ENOMEM;
	mixer->chip = chip;
3437
	mixer->ignore_ctl_error = ignore_error;
3438 3439
	mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
				  GFP_KERNEL);
3440 3441 3442 3443
	if (!mixer->id_elems) {
		kfree(mixer);
		return -ENOMEM;
	}
3444

3445 3446
	mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
	switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3447 3448 3449 3450 3451 3452 3453
	case UAC_VERSION_1:
	default:
		mixer->protocol = UAC_VERSION_1;
		break;
	case UAC_VERSION_2:
		mixer->protocol = UAC_VERSION_2;
		break;
3454 3455 3456
	case UAC_VERSION_3:
		mixer->protocol = UAC_VERSION_3;
		break;
3457
	}
3458

3459 3460
	if (mixer->protocol == UAC_VERSION_3 &&
			chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3461 3462 3463 3464 3465 3466 3467
		err = snd_usb_mixer_controls_badd(mixer, ctrlif);
		if (err < 0)
			goto _error;
	} else {
		err = snd_usb_mixer_controls(mixer);
		if (err < 0)
			goto _error;
3468
	}
3469 3470 3471 3472 3473

	err = snd_usb_mixer_status_create(mixer);
	if (err < 0)
		goto _error;

3474 3475 3476
	err = create_keep_iface_ctl(mixer);
	if (err < 0)
		goto _error;
3477

D
Daniel Mack 已提交
3478
	snd_usb_mixer_apply_create_quirk(mixer);
3479

3480
	err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3481 3482
	if (err < 0)
		goto _error;
3483 3484 3485 3486 3487

	if (list_empty(&chip->mixer_list) &&
	    !snd_card_proc_new(chip->card, "usbmixer", &entry))
		snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);

3488 3489
	list_add(&mixer->list, &chip->mixer_list);
	return 0;
3490 3491 3492 3493

_error:
	snd_usb_mixer_free(mixer);
	return err;
3494 3495
}

3496
void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3497
{
3498 3499 3500 3501 3502 3503 3504
	if (mixer->disconnected)
		return;
	if (mixer->urb)
		usb_kill_urb(mixer->urb);
	if (mixer->rc_urb)
		usb_kill_urb(mixer->rc_urb);
	mixer->disconnected = true;
3505
}
3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533

#ifdef CONFIG_PM
/* stop any bus activity of a mixer */
static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
{
	usb_kill_urb(mixer->urb);
	usb_kill_urb(mixer->rc_urb);
}

static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
{
	int err;

	if (mixer->urb) {
		err = usb_submit_urb(mixer->urb, GFP_NOIO);
		if (err < 0)
			return err;
	}

	return 0;
}

int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
{
	snd_usb_mixer_inactivate(mixer);
	return 0;
}

3534
static int restore_mixer_value(struct usb_mixer_elem_list *list)
3535
{
3536
	struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3537 3538 3539 3540 3541 3542 3543
	int c, err, idx;

	if (cval->cmask) {
		idx = 0;
		for (c = 0; c < MAX_CHANNELS; c++) {
			if (!(cval->cmask & (1 << c)))
				continue;
3544
			if (cval->cached & (1 << (c + 1))) {
3545
				err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3546 3547 3548 3549 3550 3551 3552 3553 3554
							cval->cache_val[idx]);
				if (err < 0)
					return err;
			}
			idx++;
		}
	} else {
		/* master */
		if (cval->cached) {
3555
			err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3556 3557 3558 3559 3560 3561 3562 3563 3564 3565
			if (err < 0)
				return err;
		}
	}

	return 0;
}

int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
{
3566
	struct usb_mixer_elem_list *list;
3567 3568 3569 3570 3571
	int id, err;

	if (reset_resume) {
		/* restore cached mixer values */
		for (id = 0; id < MAX_ID_ELEMS; id++) {
3572
			for_each_mixer_elem(list, mixer, id) {
3573 3574 3575 3576 3577
				if (list->resume) {
					err = list->resume(list);
					if (err < 0)
						return err;
				}
3578 3579 3580 3581
			}
		}
	}

3582 3583
	snd_usb_mixer_resume_quirk(mixer);

3584 3585 3586
	return snd_usb_mixer_activate(mixer);
}
#endif
3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598

void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
				 struct usb_mixer_interface *mixer,
				 int unitid)
{
	list->mixer = mixer;
	list->id = unitid;
	list->dump = snd_usb_mixer_dump_cval;
#ifdef CONFIG_PM
	list->resume = restore_mixer_value;
#endif
}