mixer.c 78.3 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
	struct usb_audio_term oterm;
L
Linus Torvalds 已提交
87
	const struct usbmix_name_map *map;
88
	const struct usbmix_selector_map *selector_map;
L
Linus Torvalds 已提交
89 90
};

91
/*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
92 93 94 95 96 97 98 99 100 101 102 103 104 105
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 已提交
106 107 108 109 110 111

/*
 * 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.
 */
112
#include "mixer_maps.c"
L
Linus Torvalds 已提交
113

114 115
static const struct usbmix_name_map *
find_map(struct mixer_build *state, int unitid, int control)
L
Linus Torvalds 已提交
116
{
117
	const struct usbmix_name_map *p = state->map;
L
Linus Torvalds 已提交
118

119 120
	if (!p)
		return NULL;
L
Linus Torvalds 已提交
121 122

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

130 131 132
/* 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 已提交
133
{
134 135
	if (!p || !p->name)
		return 0;
L
Linus Torvalds 已提交
136

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

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

145 146 147 148 149
/* 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 已提交
150
		return 0;
151 152 153 154 155 156 157 158 159 160
	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;
161
		cval->initialized = 1;
L
Linus Torvalds 已提交
162 163 164
	}
}

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

171
	if (!state->selector_map)
172 173 174 175 176 177 178 179
		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 已提交
180 181 182
/*
 * find an audio control unit with the given unit id
 */
183 184
static void *find_audio_control_unit(struct mixer_build *state,
				     unsigned char unit)
L
Linus Torvalds 已提交
185
{
186 187 188 189 190 191 192
	/* 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 &&
193
		    hdr->bDescriptorSubtype <= UAC3_SAMPLE_RATE_CONVERTER &&
194 195
		    hdr->bUnitID == unit)
			return hdr;
L
Linus Torvalds 已提交
196
	}
197

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

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

	if (len < 0)
		return 0;

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

/*
 * convert from the byte/word on usb descriptor to the zero-based integer
 */
219
static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
L
Linus Torvalds 已提交
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 248
{
	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
 */
249
static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
L
Linus Torvalds 已提交
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
{
	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 */
}

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

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

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
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 已提交
306 307 308 309 310

/*
 * retrieve a mixer value
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return 0;
}

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

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

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

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

437
int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
438 439 440 441 442 443 444 445 446 447
			     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) {
448 449
		if (!cval->head.mixer->ignore_ctl_error)
			usb_audio_dbg(cval->head.mixer->chip,
450
				"cannot get current value for control %d ch %d: err = %d\n",
451
				      cval->control, channel, err);
452 453 454 455 456 457 458
		return err;
	}
	cval->cached |= 1 << channel;
	cval->cache_val[index] = *value;
	return 0;
}

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

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

470 471
	validx += cval->idx_off;

472

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


/*
 * check if the input/output channel routing is enabled on the given bitmap.
 * used for mixer unit parser
 */
581 582
static int check_matrix_bitmap(unsigned char *bmap,
			       int ich, int och, int num_outs)
L
Linus Torvalds 已提交
583 584 585 586 587 588 589 590 591 592 593 594
{
	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.
 */

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

601
	while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
L
Linus Torvalds 已提交
602
		kctl->id.index++;
603
	if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 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 mixer_build *state, 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 668
	if (iterm->name) {
		len = snd_usb_copy_string_desc(state, 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 UAC_SELECTOR_UNIT:
680 681
			strcpy(name, "Selector");
			return 8;
682
		case UAC1_PROCESSING_UNIT:
683 684
			strcpy(name, "Process Unit");
			return 12;
685
		case UAC1_EXTENSION_UNIT:
686 687
			strcpy(name, "Ext Unit");
			return 8;
688
		case UAC_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 721 722 723 724
	return 0;
}

/*
 * parse the source unit recursively until it reaches to a terminal
 * or a branched unit.
 */
725 726
static int check_input_term(struct mixer_build *state, int id,
			    struct usb_audio_term *term)
L
Linus Torvalds 已提交
727
{
728
	int protocol = state->mixer->protocol;
729
	int err;
730
	void *p1;
L
Linus Torvalds 已提交
731 732 733

	memset(term, 0, sizeof(*term));
	while ((p1 = find_audio_control_unit(state, id)) != NULL) {
734
		unsigned char *hdr = p1;
L
Linus Torvalds 已提交
735
		term->id = id;
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 762 763 764 765 766 767 768 769 770 771 772 773 774 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

		if (protocol == UAC_VERSION_1 || protocol == UAC_VERSION_2) {
			switch (hdr[2]) {
			case UAC_INPUT_TERMINAL:
				if (protocol == UAC_VERSION_1) {
					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;
				} else { /* UAC_VERSION_2 */
					struct uac2_input_terminal_descriptor *d = p1;

					/* call recursively to verify that the
					 * referenced clock entity is valid */
					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;
			case UAC_FEATURE_UNIT: {
				/* the header is the same for v1 and v2 */
				struct uac_feature_unit_descriptor *d = p1;

				id = d->bSourceID;
				break; /* continue to parse */
			}
			case UAC_MIXER_UNIT: {
				struct uac_mixer_unit_descriptor *d = p1;

				term->type = d->bDescriptorSubtype << 16; /* virtual type */
				term->channels = uac_mixer_unit_bNrChannels(d);
				term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
				term->name = uac_mixer_unit_iMixer(d);
				return 0;
			}
			case UAC_SELECTOR_UNIT:
			case UAC2_CLOCK_SELECTOR: {
				struct uac_selector_unit_descriptor *d = p1;
				/* call recursively to retrieve the channel info */
				err = check_input_term(state, d->baSourceID[0], term);
				if (err < 0)
					return err;
				term->type = d->bDescriptorSubtype << 16; /* virtual type */
				term->id = id;
				term->name = uac_selector_unit_iSelector(d);
				return 0;
			}
			case UAC1_PROCESSING_UNIT:
			case UAC1_EXTENSION_UNIT:
			/* UAC2_PROCESSING_UNIT_V2 */
			/* UAC2_EFFECT_UNIT */
			case UAC2_EXTENSION_UNIT_V2: {
				struct uac_processing_unit_descriptor *d = p1;

				if (protocol == UAC_VERSION_2 &&
					hdr[2] == UAC2_EFFECT_UNIT) {
					/* UAC2/UAC1 unit IDs overlap here in an
					 * uncompatible way. Ignore this unit for now.
					 */
					return 0;
				}

				if (d->bNrInPins) {
					id = d->baSourceID[0];
					break; /* continue to parse */
				}
				term->type = d->bDescriptorSubtype << 16; /* virtual type */
				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;
			}
			case UAC2_CLOCK_SOURCE: {
				struct uac_clock_source_descriptor *d = p1;

				term->type = d->bDescriptorSubtype << 16; /* virtual type */
				term->id = id;
				term->name = d->iClockSource;
				return 0;
			}
			default:
				return -ENODEV;
			}
		} else { /* UAC_VERSION_3 */
			switch (hdr[2]) {
			case UAC_INPUT_TERMINAL: {
				struct uac3_input_terminal_descriptor *d = p1;
834

835 836
				/* call recursively to verify that the
				 * referenced clock entity is valid */
837 838 839
				err = check_input_term(state, d->bCSourceID, term);
				if (err < 0)
					return err;
840 841 842 843 844 845

				/* 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);
846 847 848 849 850 851

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

				term->name = le16_to_cpu(d->wTerminalDescrStr);
852 853
				return 0;
			}
854 855
			case UAC3_FEATURE_UNIT: {
				struct uac3_feature_unit_descriptor *d = p1;
856

857
				id = d->bSourceID;
L
Linus Torvalds 已提交
858 859
				break; /* continue to parse */
			}
860 861 862 863 864 865 866 867 868 869 870
			case UAC3_CLOCK_SOURCE: {
				struct uac3_clock_source_descriptor *d = p1;

				term->type = d->bDescriptorSubtype << 16; /* virtual type */
				term->id = id;
				term->name = le16_to_cpu(d->wClockSourceStr);
				return 0;
			}
			default:
				return -ENODEV;
			}
L
Linus Torvalds 已提交
871 872 873 874 875 876 877 878 879 880 881
		}
	}
	return -ENODEV;
}

/*
 * Feature Unit
 */

/* feature unit control information */
struct usb_feature_control_info {
882
	int control;
L
Linus Torvalds 已提交
883
	const char *name;
884 885
	int type;	/* data type for uac1 */
	int type_uac2;	/* data type for uac2 if different from uac1, else -1 */
L
Linus Torvalds 已提交
886 887 888
};

static struct usb_feature_control_info audio_feature_info[] = {
889 890 891 892 893 894 895 896 897 898
	{ 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 },
899
	/* UAC2 specific */
900 901 902
	{ 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 已提交
903 904 905
};

/* private_free callback */
906
void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
L
Linus Torvalds 已提交
907
{
908 909
	kfree(kctl->private_data);
	kctl->private_data = NULL;
L
Linus Torvalds 已提交
910 911 912 913 914 915
}

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

916 917 918 919
/* volume control quirks */
static void volume_control_quirks(struct usb_mixer_elem_info *cval,
				  struct snd_kcontrol *kctl)
{
920
	struct snd_usb_audio *chip = cval->head.mixer->chip;
921
	switch (chip->usb_id) {
922
	case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
923
	case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
		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;

950 951 952
	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) {
953 954
			usb_audio_info(chip,
				       "set quirk for FTU Effect Duration\n");
955 956 957 958 959 960 961
			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) {
962 963
			usb_audio_info(chip,
				       "set quirks for FTU Effect Feedback/Volume\n");
964 965 966 967 968 969
			cval->min = 0x00;
			cval->max = 0x7f;
			break;
		}
		break;

970 971 972 973 974 975 976 977 978 979 980
	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) {
981
			usb_audio_info(chip,
982 983 984 985 986 987 988
				 "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")) {
989
			usb_audio_info(chip,
990 991 992 993 994 995 996
				"set volume quirk for QuickCam E3500\n");
			cval->min = 6080;
			cval->max = 8768;
			cval->res = 192;
		}
		break;

997
	case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
998 999
	case USB_ID(0x046d, 0x0808):
	case USB_ID(0x046d, 0x0809):
1000
	case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1001
	case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1002
	case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1003
	case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1004
	case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1005
	case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1006
	case USB_ID(0x046d, 0x0991):
1007
	case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1008 1009
	/* Most audio usb devices lie about volume resolution.
	 * Most Logitech webcams have res = 384.
1010
	 * Probably there is some logitech magic behind this number --fishor
1011 1012
	 */
		if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1013
			usb_audio_info(chip,
1014 1015 1016 1017 1018 1019 1020
				"set resolution quirk: cval->res = 384\n");
			cval->res = 384;
		}
		break;
	}
}

L
Linus Torvalds 已提交
1021 1022 1023
/*
 * retrieve the minimum and maximum values for the specified control
 */
1024 1025
static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
				   int default_min, struct snd_kcontrol *kctl)
L
Linus Torvalds 已提交
1026 1027 1028 1029 1030
{
	/* for failsafe */
	cval->min = default_min;
	cval->max = cval->min + 1;
	cval->res = 1;
1031
	cval->dBmin = cval->dBmax = 0;
L
Linus Torvalds 已提交
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045

	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;
				}
		}
1046 1047
		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) {
1048
			usb_audio_err(cval->head.mixer->chip,
1049
				      "%d:%d: cannot get min/max values for control %d (id %d)\n",
1050 1051
				   cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
							       cval->control, cval->head.id);
L
Linus Torvalds 已提交
1052 1053
			return -EINVAL;
		}
1054 1055 1056
		if (get_ctl_value(cval, UAC_GET_RES,
				  (cval->control << 8) | minchn,
				  &cval->res) < 0) {
L
Linus Torvalds 已提交
1057 1058 1059 1060 1061
			cval->res = 1;
		} else {
			int last_valid_res = cval->res;

			while (cval->res > 1) {
D
Daniel Mack 已提交
1062
				if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1063 1064
								(cval->control << 8) | minchn,
								cval->res / 2) < 0)
L
Linus Torvalds 已提交
1065 1066 1067
					break;
				cval->res /= 2;
			}
1068 1069
			if (get_ctl_value(cval, UAC_GET_RES,
					  (cval->control << 8) | minchn, &cval->res) < 0)
L
Linus Torvalds 已提交
1070 1071 1072 1073
				cval->res = last_valid_res;
		}
		if (cval->res == 0)
			cval->res = 1;
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083

		/* 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;
1084
			get_cur_mix_raw(cval, minchn, &saved);
1085 1086 1087 1088 1089 1090 1091
			for (;;) {
				test = saved;
				if (test < cval->max)
					test += cval->res;
				else
					test -= cval->res;
				if (test < cval->min || test > cval->max ||
1092
				    snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1093
				    get_cur_mix_raw(cval, minchn, &check)) {
1094 1095 1096 1097 1098 1099 1100
					cval->res = last_valid_res;
					break;
				}
				if (test == check)
					break;
				cval->res *= 2;
			}
1101
			snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1102 1103
		}

L
Linus Torvalds 已提交
1104 1105
		cval->initialized = 1;
	}
1106

1107 1108 1109
	if (kctl)
		volume_control_quirks(cval, kctl);

1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
	/* 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 已提交
1127 1128 1129
	return 0;
}

1130
#define get_min_max(cval, def)	get_min_max_with_quirks(cval, def, NULL)
L
Linus Torvalds 已提交
1131 1132

/* get a feature/mixer unit info */
1133 1134
static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_info *uinfo)
L
Linus Torvalds 已提交
1135
{
1136
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148

	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 {
1149
		if (!cval->initialized) {
1150
			get_min_max_with_quirks(cval, 0, kcontrol);
1151 1152 1153 1154
			if (cval->initialized && cval->dBmin >= cval->dBmax) {
				kcontrol->vd[0].access &= 
					~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
					  SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1155
				snd_ctl_notify(cval->head.mixer->chip->card,
1156 1157 1158 1159
					       SNDRV_CTL_EVENT_MASK_INFO,
					       &kcontrol->id);
			}
		}
L
Linus Torvalds 已提交
1160
		uinfo->value.integer.min = 0;
1161 1162
		uinfo->value.integer.max =
			(cval->max - cval->min + cval->res - 1) / cval->res;
L
Linus Torvalds 已提交
1163 1164 1165 1166 1167
	}
	return 0;
}

/* get the current value from feature/mixer unit */
1168 1169
static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
				 struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
1170
{
1171
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1172 1173
	int c, cnt, val, err;

1174
	ucontrol->value.integer.value[0] = cval->min;
L
Linus Torvalds 已提交
1175 1176 1177
	if (cval->cmask) {
		cnt = 0;
		for (c = 0; c < MAX_CHANNELS; c++) {
1178 1179
			if (!(cval->cmask & (1 << c)))
				continue;
1180
			err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1181
			if (err < 0)
1182
				return filter_error(cval, err);
1183 1184 1185
			val = get_relative_value(cval, val);
			ucontrol->value.integer.value[cnt] = val;
			cnt++;
L
Linus Torvalds 已提交
1186
		}
1187
		return 0;
L
Linus Torvalds 已提交
1188 1189
	} else {
		/* master channel */
1190
		err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1191
		if (err < 0)
1192
			return filter_error(cval, err);
L
Linus Torvalds 已提交
1193 1194 1195 1196 1197 1198 1199
		val = get_relative_value(cval, val);
		ucontrol->value.integer.value[0] = val;
	}
	return 0;
}

/* put the current value to feature/mixer unit */
1200 1201
static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
				 struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
1202
{
1203
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1204 1205 1206 1207 1208 1209
	int c, cnt, val, oval, err;
	int changed = 0;

	if (cval->cmask) {
		cnt = 0;
		for (c = 0; c < MAX_CHANNELS; c++) {
1210 1211
			if (!(cval->cmask & (1 << c)))
				continue;
1212
			err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1213
			if (err < 0)
1214
				return filter_error(cval, err);
1215 1216 1217
			val = ucontrol->value.integer.value[cnt];
			val = get_abs_value(cval, val);
			if (oval != val) {
1218
				snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1219
				changed = 1;
L
Linus Torvalds 已提交
1220
			}
1221
			cnt++;
L
Linus Torvalds 已提交
1222 1223 1224
		}
	} else {
		/* master channel */
1225
		err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
L
Linus Torvalds 已提交
1226
		if (err < 0)
1227
			return filter_error(cval, err);
L
Linus Torvalds 已提交
1228 1229 1230
		val = ucontrol->value.integer.value[0];
		val = get_abs_value(cval, val);
		if (val != oval) {
1231
			snd_usb_set_cur_mix_value(cval, 0, 0, val);
L
Linus Torvalds 已提交
1232 1233 1234 1235 1236 1237
			changed = 1;
		}
	}
	return changed;
}

1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
/* get the current value from a mixer element */
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;
	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;
}

1253
static struct snd_kcontrol_new usb_feature_unit_ctl = {
L
Linus Torvalds 已提交
1254 1255 1256 1257 1258 1259 1260
	.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,
};

1261
/* the read-only variant */
1262
static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1263 1264 1265 1266 1267 1268 1269
	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
	.name = "", /* will be filled later manually */
	.info = mixer_ctl_feature_info,
	.get = mixer_ctl_feature_get,
	.put = NULL,
};

1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
/* A UAC connector mixer control */
static 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,
};

1280 1281 1282 1283
/*
 * This symbol is exported in order to allow the mixer quirks to
 * hook up to the standard feature unit control mechanism
 */
1284
struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
L
Linus Torvalds 已提交
1285 1286 1287 1288

/*
 * build a feature control
 */
T
Takashi Iwai 已提交
1289 1290 1291 1292 1293
static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
{
	return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
}

1294 1295 1296 1297 1298
/*
 * 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.
 */
1299 1300 1301 1302 1303 1304
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;
1305
	bool found = false;
1306 1307 1308 1309 1310 1311

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

	for (s = names_to_check; *s; s++)
		if (strstr(card->shortname, *s)) {
1312
			found = true;
1313 1314 1315 1316 1317 1318 1319 1320 1321
			break;
		}

	if (!found)
		return;

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

1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
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;
}

1333
static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
L
Linus Torvalds 已提交
1334
			      unsigned int ctl_mask, int control,
1335
			      struct usb_audio_term *iterm, int unitid,
1336
			      int readonly_mask)
L
Linus Torvalds 已提交
1337
{
1338
	struct uac_feature_unit_descriptor *desc = raw_desc;
1339
	struct usb_feature_control_info *ctl_info;
L
Linus Torvalds 已提交
1340 1341
	unsigned int len = 0;
	int mapped_name = 0;
1342
	int nameid = uac_feature_unit_iFeature(desc);
1343 1344
	struct snd_kcontrol *kctl;
	struct usb_mixer_elem_info *cval;
1345
	const struct usbmix_name_map *map;
1346
	unsigned int range;
L
Linus Torvalds 已提交
1347

1348
	if (control == UAC_FU_GRAPHIC_EQUALIZER) {
L
Linus Torvalds 已提交
1349 1350 1351 1352
		/* FIXME: not supported yet */
		return;
	}

1353 1354
	map = find_map(state, unitid, control);
	if (check_ignored_ctl(map))
L
Linus Torvalds 已提交
1355 1356
		return;

1357
	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1358
	if (!cval)
L
Linus Torvalds 已提交
1359
		return;
1360
	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
L
Linus Torvalds 已提交
1361 1362
	cval->control = control;
	cval->cmask = ctl_mask;
1363 1364 1365 1366

	ctl_info = get_feature_control_info(control);
	if (!ctl_info)
		return;
1367 1368 1369 1370 1371 1372
	if (state->mixer->protocol == UAC_VERSION_1)
		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;

1373
	if (ctl_mask == 0) {
L
Linus Torvalds 已提交
1374
		cval->channels = 1;	/* master channel */
1375 1376
		cval->master_readonly = readonly_mask;
	} else {
L
Linus Torvalds 已提交
1377 1378 1379 1380 1381
		int i, c = 0;
		for (i = 0; i < 16; i++)
			if (ctl_mask & (1 << i))
				c++;
		cval->channels = c;
1382
		cval->ch_readonly = readonly_mask;
L
Linus Torvalds 已提交
1383 1384
	}

1385 1386
	/*
	 * If all channels in the mask are marked read-only, make the control
1387
	 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1388 1389
	 * issue write commands to read-only channels.
	 */
1390
	if (cval->channels == readonly_mask)
1391 1392 1393 1394
		kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
	else
		kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);

1395
	if (!kctl) {
1396
		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
L
Linus Torvalds 已提交
1397 1398 1399
		kfree(cval);
		return;
	}
1400
	kctl->private_free = snd_usb_mixer_elem_free;
L
Linus Torvalds 已提交
1401

1402
	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
L
Linus Torvalds 已提交
1403
	mapped_name = len != 0;
1404
	if (!len && nameid)
1405 1406
		len = snd_usb_copy_string_desc(state, nameid,
				kctl->id.name, sizeof(kctl->id.name));
L
Linus Torvalds 已提交
1407 1408

	switch (control) {
1409 1410
	case UAC_FU_MUTE:
	case UAC_FU_VOLUME:
1411 1412
		/*
		 * determine the control name.  the rule is:
L
Linus Torvalds 已提交
1413 1414 1415 1416 1417 1418
		 * - 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.
		 */
1419 1420 1421 1422 1423 1424 1425 1426
		if (!len) {
			len = get_term_name(state, iterm, kctl->id.name,
					    sizeof(kctl->id.name), 1);
			if (!len)
				len = get_term_name(state, &state->oterm,
						    kctl->id.name,
						    sizeof(kctl->id.name), 1);
			if (!len)
1427 1428
				snprintf(kctl->id.name, sizeof(kctl->id.name),
					 "Feature %d", unitid);
L
Linus Torvalds 已提交
1429
		}
1430 1431 1432 1433

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

1434 1435
		/*
		 * determine the stream direction:
L
Linus Torvalds 已提交
1436 1437 1438
		 * if the connected output is USB stream, then it's likely a
		 * capture stream.  otherwise it should be playback (hopefully :)
		 */
1439 1440
		if (!mapped_name && !(state->oterm.type >> 16)) {
			if ((state->oterm.type & 0xff00) == 0x0100)
1441
				append_ctl_name(kctl, " Capture");
1442
			else
1443
				append_ctl_name(kctl, " Playback");
L
Linus Torvalds 已提交
1444
		}
1445
		append_ctl_name(kctl, control == UAC_FU_MUTE ?
T
Takashi Iwai 已提交
1446
				" Switch" : " Volume");
L
Linus Torvalds 已提交
1447 1448
		break;
	default:
1449
		if (!len)
L
Linus Torvalds 已提交
1450 1451 1452 1453 1454
			strlcpy(kctl->id.name, audio_feature_info[control-1].name,
				sizeof(kctl->id.name));
		break;
	}

1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
	/* 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;
		}
	}

1468 1469
	snd_usb_mixer_fu_apply_quirk(state->mixer, cval, unitid, kctl);

1470
	range = (cval->max - cval->min) / cval->res;
1471 1472
	/*
	 * Are there devices with volume range more than 255? I use a bit more
1473 1474 1475 1476
	 * to be sure. 384 is a resolution magic number found on Logitech
	 * devices. It will definitively catch all buggy Logitech devices.
	 */
	if (range > 384) {
1477
		usb_audio_warn(state->chip,
1478
			       "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1479
			       range);
1480 1481
		usb_audio_warn(state->chip,
			       "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1482
			       cval->head.id, kctl->id.name, cval->channels,
1483
			       cval->min, cval->max, cval->res);
1484 1485
	}

1486
	usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1487
		      cval->head.id, kctl->id.name, cval->channels,
1488
		      cval->min, cval->max, cval->res);
1489
	snd_usb_mixer_add_control(&cval->head, kctl);
L
Linus Torvalds 已提交
1490 1491
}

1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
static void get_connector_control_name(struct mixer_build *state,
				       struct usb_audio_term *term,
				       bool is_input, char *name, int name_size)
{
	int name_len = get_term_name(state, term, name, name_size, 0);

	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) */
static void build_connector_control(struct mixer_build *state,
				    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;
	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, term->id);
	cval->control = UAC2_TE_CONNECTOR;
	cval->val_type = USB_MIXER_BOOLEAN;
	cval->channels = 1; /* report true if any channel is connected */
	cval->min = 0;
	cval->max = 1;
	kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
	if (!kctl) {
		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
		kfree(cval);
		return;
	}
	get_connector_control_name(state, term, is_input, kctl->id.name,
				   sizeof(kctl->id.name));
	kctl->private_free = snd_usb_mixer_elem_free;
	snd_usb_mixer_add_control(&cval->head, kctl);
}

1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
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;

	if (hdr->bLength != sizeof(*hdr)) {
		usb_audio_dbg(state->chip,
			      "Bogus clock source descriptor length of %d, ignoring.\n",
			      hdr->bLength);
		return 0;
	}

	/*
	 * The only property of this unit we are interested in is the
	 * clock source validity. If that isn't readable, just bail out.
	 */
1563
	if (!uac_v2v3_control_is_readable(hdr->bmControls,
1564
				      UAC2_CS_CONTROL_CLOCK_VALID))
1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578
		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;

1579
	if (uac_v2v3_control_is_writeable(hdr->bmControls,
1580
				      UAC2_CS_CONTROL_CLOCK_VALID))
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
		kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
	else {
		cval->master_readonly = 1;
		kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
	}

	if (!kctl) {
		kfree(cval);
		return -ENOMEM;
	}

	kctl->private_free = snd_usb_mixer_elem_free;
	ret = snd_usb_copy_string_desc(state, hdr->iClockSource,
				       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 已提交
1605 1606 1607
/*
 * parse a feature unit
 *
L
Lucas De Marchi 已提交
1608
 * most of controls are defined here.
L
Linus Torvalds 已提交
1609
 */
1610 1611
static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
				    void *_ftr)
L
Linus Torvalds 已提交
1612 1613
{
	int channels, i, j;
1614
	struct usb_audio_term iterm;
L
Linus Torvalds 已提交
1615 1616
	unsigned int master_bits, first_ch_bits;
	int err, csize;
1617 1618 1619 1620
	struct uac_feature_unit_descriptor *hdr = _ftr;
	__u8 *bmaControls;

	if (state->mixer->protocol == UAC_VERSION_1) {
1621 1622 1623 1624 1625 1626
		if (hdr->bLength < 7) {
			usb_audio_err(state->chip,
				      "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
				      unitid);
			return -EINVAL;
		}
1627
		csize = hdr->bControlSize;
1628
		if (!csize) {
1629
			usb_audio_dbg(state->chip,
1630
				      "unit %u: invalid bControlSize == 0\n",
1631
				      unitid);
1632 1633
			return -EINVAL;
		}
1634 1635
		channels = (hdr->bLength - 7) / csize - 1;
		bmaControls = hdr->bmaControls;
1636
		if (hdr->bLength < 7 + csize) {
1637 1638 1639
			usb_audio_err(state->chip,
				      "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
				      unitid);
1640 1641
			return -EINVAL;
		}
1642
	} else if (state->mixer->protocol == UAC_VERSION_2) {
1643
		struct uac2_feature_unit_descriptor *ftr = _ftr;
1644 1645 1646 1647 1648 1649
		if (hdr->bLength < 6) {
			usb_audio_err(state->chip,
				      "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
				      unitid);
			return -EINVAL;
		}
1650
		csize = 4;
1651
		channels = (hdr->bLength - 6) / 4 - 1;
1652
		bmaControls = ftr->bmaControls;
1653
		if (hdr->bLength < 6 + csize) {
1654 1655 1656
			usb_audio_err(state->chip,
				      "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
				      unitid);
1657 1658
			return -EINVAL;
		}
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
	} else { /* UAC_VERSION_3 */
		struct uac3_feature_unit_descriptor *ftr = _ftr;

		if (hdr->bLength < 7) {
			usb_audio_err(state->chip,
				      "unit %u: invalid UAC3_FEATURE_UNIT descriptor\n",
				      unitid);
			return -EINVAL;
		}
		csize = 4;
		channels = (ftr->bLength - 7) / 4 - 1;
		bmaControls = ftr->bmaControls;
		if (hdr->bLength < 7 + csize) {
			usb_audio_err(state->chip,
				      "unit %u: invalid UAC3_FEATURE_UNIT descriptor\n",
				      unitid);
			return -EINVAL;
		}
L
Linus Torvalds 已提交
1677 1678 1679
	}

	/* parse the source unit */
1680
	if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
L
Linus Torvalds 已提交
1681 1682 1683
		return err;

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

1688
	master_bits = snd_usb_combine_bytes(bmaControls, csize);
1689 1690 1691
	/* master configuration quirks */
	switch (state->chip->usb_id) {
	case USB_ID(0x08bb, 0x2702):
1692 1693
		usb_audio_info(state->chip,
			       "usbmixer: master volume quirk for PCM2702 chip\n");
1694
		/* disable non-functional volume control */
1695
		master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1696
		break;
1697
	case USB_ID(0x1130, 0xf211):
1698 1699
		usb_audio_info(state->chip,
			       "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1700 1701 1702 1703
		/* disable non-functional volume control */
		channels = 0;
		break;

1704
	}
L
Linus Torvalds 已提交
1705
	if (channels > 0)
1706
		first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
L
Linus Torvalds 已提交
1707 1708
	else
		first_ch_bits = 0;
1709 1710 1711 1712 1713

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

1716
			for (j = 0; j < channels; j++) {
1717 1718 1719 1720
				unsigned int mask;

				mask = snd_usb_combine_bytes(bmaControls +
							     csize * (j+1), csize);
1721 1722 1723 1724
				if (mask & (1 << i))
					ch_bits |= (1 << j);
			}
			/* audio class v1 controls are never read-only */
1725 1726 1727 1728 1729 1730

			/*
			 * The first channel must be set
			 * (for ease of programming).
			 */
			if (ch_bits & 1)
1731
				build_feature_ctl(state, _ftr, ch_bits, control,
1732
						  &iterm, unitid, 0);
1733
			if (master_bits & (1 << i))
1734 1735
				build_feature_ctl(state, _ftr, 0, control,
						  &iterm, unitid, 0);
1736
		}
1737
	} else { /* UAC_VERSION_2/3 */
1738
		for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1739 1740
			unsigned int ch_bits = 0;
			unsigned int ch_read_only = 0;
1741
			int control = audio_feature_info[i].control;
1742 1743

			for (j = 0; j < channels; j++) {
1744 1745 1746 1747
				unsigned int mask;

				mask = snd_usb_combine_bytes(bmaControls +
							     csize * (j+1), csize);
1748
				if (uac_v2v3_control_is_readable(mask, control)) {
1749
					ch_bits |= (1 << j);
1750
					if (!uac_v2v3_control_is_writeable(mask, control))
1751 1752 1753 1754
						ch_read_only |= (1 << j);
				}
			}

1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768
			/*
			 * 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)
1769
				build_feature_ctl(state, _ftr, ch_bits, control,
1770
						  &iterm, unitid, ch_read_only);
1771
			if (uac_v2v3_control_is_readable(master_bits, control))
1772
				build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1773 1774
						  !uac_v2v3_control_is_writeable(master_bits,
										 control));
L
Linus Torvalds 已提交
1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
		}
	}

	return 0;
}

/*
 * Mixer Unit
 */

/*
 * build a mixer unit control
 *
 * the callbacks are identical with feature unit.
 * input channel number (zero based) is given in control field instead.
 */
1791 1792
static void build_mixer_unit_ctl(struct mixer_build *state,
				 struct uac_mixer_unit_descriptor *desc,
L
Linus Torvalds 已提交
1793
				 int in_pin, int in_ch, int unitid,
1794
				 struct usb_audio_term *iterm)
L
Linus Torvalds 已提交
1795
{
1796
	struct usb_mixer_elem_info *cval;
1797
	unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
L
Linus Torvalds 已提交
1798
	unsigned int i, len;
1799
	struct snd_kcontrol *kctl;
1800
	const struct usbmix_name_map *map;
L
Linus Torvalds 已提交
1801

1802 1803
	map = find_map(state, unitid, 0);
	if (check_ignored_ctl(map))
L
Linus Torvalds 已提交
1804 1805
		return;

1806
	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1807
	if (!cval)
L
Linus Torvalds 已提交
1808 1809
		return;

1810
	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
L
Linus Torvalds 已提交
1811 1812 1813
	cval->control = in_ch + 1; /* based on 1 */
	cval->val_type = USB_MIXER_S16;
	for (i = 0; i < num_outs; i++) {
1814 1815 1816
		__u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);

		if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
L
Linus Torvalds 已提交
1817 1818 1819 1820 1821 1822 1823 1824 1825
			cval->cmask |= (1 << i);
			cval->channels++;
		}
	}

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

	kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1826
	if (!kctl) {
1827
		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
L
Linus Torvalds 已提交
1828 1829 1830
		kfree(cval);
		return;
	}
1831
	kctl->private_free = snd_usb_mixer_elem_free;
L
Linus Torvalds 已提交
1832

1833
	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1834 1835 1836 1837
	if (!len)
		len = get_term_name(state, iterm, kctl->id.name,
				    sizeof(kctl->id.name), 0);
	if (!len)
L
Linus Torvalds 已提交
1838
		len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
T
Takashi Iwai 已提交
1839
	append_ctl_name(kctl, " Volume");
L
Linus Torvalds 已提交
1840

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

1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
				      void *raw_desc)
{
	struct usb_audio_term iterm;
	struct uac2_input_terminal_descriptor *d = raw_desc;

	check_input_term(state, d->bTerminalID, &iterm);
	if (state->mixer->protocol == UAC_VERSION_2) {
		/* Check for jack detection. */
		if (uac_v2v3_control_is_readable(d->bmControls,
						 UAC2_TE_CONNECTOR)) {
			build_connector_control(state, &iterm, true);
		}
	}
	return 0;
}

L
Linus Torvalds 已提交
1863 1864 1865
/*
 * parse a mixer unit
 */
1866 1867
static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
				  void *raw_desc)
L
Linus Torvalds 已提交
1868
{
1869
	struct uac_mixer_unit_descriptor *desc = raw_desc;
1870
	struct usb_audio_term iterm;
L
Linus Torvalds 已提交
1871 1872 1873
	int input_pins, num_ins, num_outs;
	int pin, ich, err;

1874 1875 1876 1877 1878
	if (desc->bLength < 11 || !(input_pins = desc->bNrInPins) ||
	    !(num_outs = uac_mixer_unit_bNrChannels(desc))) {
		usb_audio_err(state->chip,
			      "invalid MIXER UNIT descriptor %d\n",
			      unitid);
L
Linus Torvalds 已提交
1879 1880 1881 1882 1883 1884
		return -EINVAL;
	}

	num_ins = 0;
	ich = 0;
	for (pin = 0; pin < input_pins; pin++) {
1885
		err = parse_audio_unit(state, desc->baSourceID[pin]);
L
Linus Torvalds 已提交
1886
		if (err < 0)
1887
			continue;
1888 1889 1890
		/* no bmControls field (e.g. Maya44) -> ignore */
		if (desc->bLength <= 10 + input_pins)
			continue;
1891
		err = check_input_term(state, desc->baSourceID[pin], &iterm);
L
Linus Torvalds 已提交
1892 1893 1894
		if (err < 0)
			return err;
		num_ins += iterm.channels;
1895
		for (; ich < num_ins; ich++) {
L
Linus Torvalds 已提交
1896 1897
			int och, ich_has_controls = 0;

1898 1899 1900 1901 1902
			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 已提交
1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919
					ich_has_controls = 1;
					break;
				}
			}
			if (ich_has_controls)
				build_mixer_unit_ctl(state, desc, pin, ich,
						     unitid, &iterm);
		}
	}
	return 0;
}

/*
 * Processing Unit / Extension Unit
 */

/* get callback for processing/extension unit */
1920 1921
static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
1922
{
1923
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1924 1925 1926
	int err, val;

	err = get_cur_ctl_value(cval, cval->control << 8, &val);
1927
	if (err < 0) {
L
Linus Torvalds 已提交
1928
		ucontrol->value.integer.value[0] = cval->min;
1929
		return filter_error(cval, err);
L
Linus Torvalds 已提交
1930 1931 1932 1933 1934 1935 1936
	}
	val = get_relative_value(cval, val);
	ucontrol->value.integer.value[0] = val;
	return 0;
}

/* put callback for processing/extension unit */
1937 1938
static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
1939
{
1940
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1941 1942 1943
	int val, oval, err;

	err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1944 1945
	if (err < 0)
		return filter_error(cval, err);
L
Linus Torvalds 已提交
1946 1947 1948 1949 1950 1951 1952 1953 1954 1955
	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 */
1956
static const struct snd_kcontrol_new mixer_procunit_ctl = {
L
Linus Torvalds 已提交
1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980
	.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;
};

static struct procunit_value_info updown_proc_info[] = {
1981 1982
	{ UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
	{ UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
L
Linus Torvalds 已提交
1983 1984 1985
	{ 0 }
};
static struct procunit_value_info prologic_proc_info[] = {
1986 1987
	{ UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
	{ UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
L
Linus Torvalds 已提交
1988 1989 1990
	{ 0 }
};
static struct procunit_value_info threed_enh_proc_info[] = {
1991 1992
	{ UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
	{ UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
L
Linus Torvalds 已提交
1993 1994 1995
	{ 0 }
};
static struct procunit_value_info reverb_proc_info[] = {
1996 1997 1998 1999
	{ 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 已提交
2000 2001 2002
	{ 0 }
};
static struct procunit_value_info chorus_proc_info[] = {
2003 2004 2005 2006
	{ 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 已提交
2007 2008 2009
	{ 0 }
};
static struct procunit_value_info dcr_proc_info[] = {
2010 2011 2012 2013 2014 2015
	{ 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 已提交
2016 2017 2018 2019
	{ 0 }
};

static struct procunit_info procunits[] = {
2020 2021 2022 2023 2024 2025
	{ 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 已提交
2026 2027
	{ 0 },
};
2028 2029 2030 2031
/*
 * predefined data for extension units
 */
static struct procunit_value_info clock_rate_xu_info[] = {
2032 2033
	{ USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
	{ 0 }
2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053
};
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 }
};
2054

L
Linus Torvalds 已提交
2055 2056 2057
/*
 * build a processing/extension unit
 */
2058 2059 2060
static int build_audio_procunit(struct mixer_build *state, int unitid,
				void *raw_desc, struct procunit_info *list,
				char *name)
L
Linus Torvalds 已提交
2061
{
2062 2063
	struct uac_processing_unit_descriptor *desc = raw_desc;
	int num_ins = desc->bNrInPins;
2064 2065
	struct usb_mixer_elem_info *cval;
	struct snd_kcontrol *kctl;
L
Linus Torvalds 已提交
2066 2067 2068
	int i, err, nameid, type, len;
	struct procunit_info *info;
	struct procunit_value_info *valinfo;
2069
	const struct usbmix_name_map *map;
L
Linus Torvalds 已提交
2070 2071 2072 2073 2074 2075 2076 2077
	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
	};

2078 2079
	if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
	    desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
2080
		usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
L
Linus Torvalds 已提交
2081 2082 2083 2084
		return -EINVAL;
	}

	for (i = 0; i < num_ins; i++) {
2085
		if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
L
Linus Torvalds 已提交
2086 2087 2088
			return err;
	}

2089
	type = le16_to_cpu(desc->wProcessType);
L
Linus Torvalds 已提交
2090 2091 2092
	for (info = list; info && info->type; info++)
		if (info->type == type)
			break;
2093
	if (!info || !info->type)
L
Linus Torvalds 已提交
2094 2095 2096
		info = &default_info;

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

2099
		if (!(controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
L
Linus Torvalds 已提交
2100
			continue;
2101 2102
		map = find_map(state, unitid, valinfo->control);
		if (check_ignored_ctl(map))
L
Linus Torvalds 已提交
2103
			continue;
2104
		cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2105
		if (!cval)
L
Linus Torvalds 已提交
2106
			return -ENOMEM;
2107
		snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
L
Linus Torvalds 已提交
2108 2109 2110 2111 2112
		cval->control = valinfo->control;
		cval->val_type = valinfo->val_type;
		cval->channels = 1;

		/* get min/max values */
2113
		if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
2114
			__u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
L
Linus Torvalds 已提交
2115 2116
			/* FIXME: hard-coded */
			cval->min = 1;
2117
			cval->max = control_spec[0];
L
Linus Torvalds 已提交
2118 2119
			cval->res = 1;
			cval->initialized = 1;
2120 2121
		} else {
			if (type == USB_XU_CLOCK_RATE) {
2122 2123
				/*
				 * E-Mu USB 0404/0202/TrackerPre/0204
2124 2125 2126 2127 2128 2129 2130 2131 2132
				 * samplerate control quirk
				 */
				cval->min = 0;
				cval->max = 5;
				cval->res = 1;
				cval->initialized = 1;
			} else
				get_min_max(cval, valinfo->min_value);
		}
L
Linus Torvalds 已提交
2133 2134

		kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2135
		if (!kctl) {
L
Linus Torvalds 已提交
2136 2137 2138
			kfree(cval);
			return -ENOMEM;
		}
2139
		kctl->private_free = snd_usb_mixer_elem_free;
L
Linus Torvalds 已提交
2140

2141
		if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2142
			/* nothing */ ;
2143
		} else if (info->name) {
L
Linus Torvalds 已提交
2144
			strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2145
		} else {
2146
			nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
L
Linus Torvalds 已提交
2147 2148
			len = 0;
			if (nameid)
2149 2150 2151 2152
				len = snd_usb_copy_string_desc(state, nameid,
							       kctl->id.name,
							       sizeof(kctl->id.name));
			if (!len)
L
Linus Torvalds 已提交
2153 2154
				strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
		}
T
Takashi Iwai 已提交
2155 2156
		append_ctl_name(kctl, " ");
		append_ctl_name(kctl, valinfo->suffix);
L
Linus Torvalds 已提交
2157

2158
		usb_audio_dbg(state->chip,
2159
			      "[%d] PU [%s] ch = %d, val = %d/%d\n",
2160
			      cval->head.id, kctl->id.name, cval->channels,
2161 2162
			      cval->min, cval->max);

2163
		err = snd_usb_mixer_add_control(&cval->head, kctl);
2164
		if (err < 0)
L
Linus Torvalds 已提交
2165 2166 2167 2168 2169
			return err;
	}
	return 0;
}

2170 2171
static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
				       void *raw_desc)
L
Linus Torvalds 已提交
2172
{
2173 2174
	return build_audio_procunit(state, unitid, raw_desc,
				    procunits, "Processing Unit");
L
Linus Torvalds 已提交
2175 2176
}

2177 2178
static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
				      void *raw_desc)
L
Linus Torvalds 已提交
2179
{
2180 2181 2182 2183 2184 2185
	/*
	 * Note that we parse extension units with processing unit descriptors.
	 * That's ok as the layout is the same.
	 */
	return build_audio_procunit(state, unitid, raw_desc,
				    extunits, "Extension Unit");
L
Linus Torvalds 已提交
2186 2187 2188 2189 2190 2191
}

/*
 * Selector Unit
 */

2192 2193
/*
 * info callback for selector unit
L
Linus Torvalds 已提交
2194 2195
 * use an enumerator type for routing
 */
2196 2197
static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
				   struct snd_ctl_elem_info *uinfo)
L
Linus Torvalds 已提交
2198
{
2199
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
2200
	const char **itemlist = (const char **)kcontrol->private_value;
L
Linus Torvalds 已提交
2201

2202 2203
	if (snd_BUG_ON(!itemlist))
		return -EINVAL;
2204
	return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
L
Linus Torvalds 已提交
2205 2206 2207
}

/* get callback for selector unit */
2208 2209
static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
2210
{
2211
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
2212 2213
	int val, err;

2214
	err = get_cur_ctl_value(cval, cval->control << 8, &val);
L
Linus Torvalds 已提交
2215
	if (err < 0) {
2216 2217
		ucontrol->value.enumerated.item[0] = 0;
		return filter_error(cval, err);
L
Linus Torvalds 已提交
2218 2219 2220 2221 2222 2223 2224
	}
	val = get_relative_value(cval, val);
	ucontrol->value.enumerated.item[0] = val;
	return 0;
}

/* put callback for selector unit */
2225 2226
static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
2227
{
2228
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
2229 2230
	int val, oval, err;

2231
	err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2232 2233
	if (err < 0)
		return filter_error(cval, err);
L
Linus Torvalds 已提交
2234 2235 2236
	val = ucontrol->value.enumerated.item[0];
	val = get_abs_value(cval, val);
	if (val != oval) {
2237
		set_cur_ctl_value(cval, cval->control << 8, val);
L
Linus Torvalds 已提交
2238 2239 2240 2241 2242 2243
		return 1;
	}
	return 0;
}

/* alsa control interface for selector unit */
2244
static const struct snd_kcontrol_new mixer_selectunit_ctl = {
L
Linus Torvalds 已提交
2245 2246 2247 2248 2249 2250 2251
	.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,
};

2252 2253
/*
 * private free callback.
L
Linus Torvalds 已提交
2254 2255
 * free both private_data and private_value
 */
2256
static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
L
Linus Torvalds 已提交
2257 2258 2259 2260
{
	int i, num_ins = 0;

	if (kctl->private_data) {
2261
		struct usb_mixer_elem_info *cval = kctl->private_data;
L
Linus Torvalds 已提交
2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277
		num_ins = cval->max;
		kfree(cval);
		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
 */
2278 2279
static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
				     void *raw_desc)
L
Linus Torvalds 已提交
2280
{
2281
	struct uac_selector_unit_descriptor *desc = raw_desc;
L
Linus Torvalds 已提交
2282 2283
	unsigned int i, nameid, len;
	int err;
2284 2285
	struct usb_mixer_elem_info *cval;
	struct snd_kcontrol *kctl;
2286
	const struct usbmix_name_map *map;
L
Linus Torvalds 已提交
2287 2288
	char **namelist;

2289 2290
	if (desc->bLength < 5 || !desc->bNrInPins ||
	    desc->bLength < 5 + desc->bNrInPins) {
2291 2292
		usb_audio_err(state->chip,
			"invalid SELECTOR UNIT descriptor %d\n", unitid);
L
Linus Torvalds 已提交
2293 2294 2295
		return -EINVAL;
	}

2296 2297
	for (i = 0; i < desc->bNrInPins; i++) {
		if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
L
Linus Torvalds 已提交
2298 2299 2300
			return err;
	}

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

2304 2305
	map = find_map(state, unitid, 0);
	if (check_ignored_ctl(map))
L
Linus Torvalds 已提交
2306 2307
		return 0;

2308
	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2309
	if (!cval)
L
Linus Torvalds 已提交
2310
		return -ENOMEM;
2311
	snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
L
Linus Torvalds 已提交
2312 2313 2314
	cval->val_type = USB_MIXER_U8;
	cval->channels = 1;
	cval->min = 1;
2315
	cval->max = desc->bNrInPins;
L
Linus Torvalds 已提交
2316 2317 2318
	cval->res = 1;
	cval->initialized = 1;

2319
	if (state->mixer->protocol == UAC_VERSION_1)
2320
		cval->control = 0;
2321 2322 2323
	else /* UAC_VERSION_2 */
		cval->control = (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) ?
			UAC2_CX_CLOCK_SELECTOR : UAC2_SU_SELECTOR;
2324

2325
	namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
2326
	if (!namelist) {
L
Linus Torvalds 已提交
2327 2328 2329 2330
		kfree(cval);
		return -ENOMEM;
	}
#define MAX_ITEM_NAME_LEN	64
2331
	for (i = 0; i < desc->bNrInPins; i++) {
2332
		struct usb_audio_term iterm;
L
Linus Torvalds 已提交
2333 2334
		len = 0;
		namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2335
		if (!namelist[i]) {
2336
			while (i--)
L
Linus Torvalds 已提交
2337 2338 2339 2340 2341
				kfree(namelist[i]);
			kfree(namelist);
			kfree(cval);
			return -ENOMEM;
		}
2342 2343
		len = check_mapped_selector_name(state, unitid, i, namelist[i],
						 MAX_ITEM_NAME_LEN);
2344
		if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
L
Linus Torvalds 已提交
2345 2346
			len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
		if (! len)
2347
			sprintf(namelist[i], "Input %u", i);
L
Linus Torvalds 已提交
2348 2349 2350 2351
	}

	kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
	if (! kctl) {
2352
		usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2353
		kfree(namelist);
L
Linus Torvalds 已提交
2354 2355 2356 2357 2358 2359
		kfree(cval);
		return -ENOMEM;
	}
	kctl->private_value = (unsigned long)namelist;
	kctl->private_free = usb_mixer_selector_elem_free;

2360
	/* check the static mapping table at first */
2361
	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2362
	if (!len) {
2363 2364 2365 2366 2367 2368 2369 2370 2371 2372
		/* no mapping ? */
		/* if iSelector is given, use it */
		nameid = uac_selector_unit_iSelector(desc);
		if (nameid)
			len = snd_usb_copy_string_desc(state, nameid,
						       kctl->id.name,
						       sizeof(kctl->id.name));
		/* ... or pick up the terminal name at next */
		if (!len)
			len = get_term_name(state, &state->oterm,
L
Linus Torvalds 已提交
2373
				    kctl->id.name, sizeof(kctl->id.name), 0);
2374
		/* ... or use the fixed string "USB" as the last resort */
2375
		if (!len)
L
Linus Torvalds 已提交
2376 2377
			strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));

2378
		/* and add the proper suffix */
2379 2380 2381
		if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
			append_ctl_name(kctl, " Clock Source");
		else if ((state->oterm.type & 0xff00) == 0x0100)
T
Takashi Iwai 已提交
2382
			append_ctl_name(kctl, " Capture Source");
L
Linus Torvalds 已提交
2383
		else
T
Takashi Iwai 已提交
2384
			append_ctl_name(kctl, " Playback Source");
L
Linus Torvalds 已提交
2385 2386
	}

2387
	usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2388 2389
		    cval->head.id, kctl->id.name, desc->bNrInPins);
	return snd_usb_mixer_add_control(&cval->head, kctl);
L
Linus Torvalds 已提交
2390 2391 2392 2393 2394 2395
}

/*
 * parse an audio unit recursively
 */

2396
static int parse_audio_unit(struct mixer_build *state, int unitid)
L
Linus Torvalds 已提交
2397 2398
{
	unsigned char *p1;
2399
	int protocol = state->mixer->protocol;
L
Linus Torvalds 已提交
2400 2401 2402 2403 2404 2405

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

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

2410 2411 2412
	if (protocol == UAC_VERSION_1 || protocol == UAC_VERSION_2) {
		switch (p1[2]) {
		case UAC_INPUT_TERMINAL:
2413
			return parse_audio_input_terminal(state, unitid, p1);
2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435
		case UAC_MIXER_UNIT:
			return parse_audio_mixer_unit(state, unitid, p1);
		case UAC2_CLOCK_SOURCE:
			return parse_clock_source_unit(state, unitid, p1);
		case UAC_SELECTOR_UNIT:
		case UAC2_CLOCK_SELECTOR:
			return parse_audio_selector_unit(state, unitid, p1);
		case UAC_FEATURE_UNIT:
			return parse_audio_feature_unit(state, unitid, p1);
		case UAC1_PROCESSING_UNIT:
		/*   UAC2_EFFECT_UNIT has the same value */
			if (protocol == UAC_VERSION_1)
				return parse_audio_processing_unit(state, unitid, p1);
			else
				return 0; /* FIXME - effect units not implemented yet */
		case UAC1_EXTENSION_UNIT:
		/*   UAC2_PROCESSING_UNIT_V2 has the same value */
			if (protocol == UAC_VERSION_1)
				return parse_audio_extension_unit(state, unitid, p1);
			else /* UAC_VERSION_2 */
				return parse_audio_processing_unit(state, unitid, p1);
		case UAC2_EXTENSION_UNIT_V2:
2436
			return parse_audio_extension_unit(state, unitid, p1);
2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456
		default:
			usb_audio_err(state->chip,
				"unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
			return -EINVAL;
		}
	} else { /* UAC_VERSION_3 */
		switch (p1[2]) {
		case UAC_INPUT_TERMINAL:
			return 0; /* NOP */
		case UAC3_MIXER_UNIT:
			return parse_audio_mixer_unit(state, unitid, p1);
		case UAC3_CLOCK_SOURCE:
			return parse_clock_source_unit(state, unitid, p1);
		case UAC3_CLOCK_SELECTOR:
			return parse_audio_selector_unit(state, unitid, p1);
		case UAC3_FEATURE_UNIT:
			return parse_audio_feature_unit(state, unitid, p1);
		case UAC3_EFFECT_UNIT:
			return 0; /* FIXME - effect units not implemented yet */
		case UAC3_PROCESSING_UNIT:
2457
			return parse_audio_processing_unit(state, unitid, p1);
2458 2459 2460 2461 2462 2463 2464
		case UAC3_EXTENSION_UNIT:
			return parse_audio_extension_unit(state, unitid, p1);
		default:
			usb_audio_err(state->chip,
				"unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
			return -EINVAL;
		}
L
Linus Torvalds 已提交
2465 2466 2467
	}
}

2468 2469
static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
{
2470 2471 2472
	/* kill pending URBs */
	snd_usb_mixer_disconnect(mixer);

2473 2474 2475 2476 2477
	kfree(mixer->id_elems);
	if (mixer->urb) {
		kfree(mixer->urb->transfer_buffer);
		usb_free_urb(mixer->urb);
	}
2478
	usb_free_urb(mixer->rc_urb);
2479
	kfree(mixer->rc_setup_packet);
2480 2481 2482
	kfree(mixer);
}

2483
static int snd_usb_mixer_dev_free(struct snd_device *device)
2484 2485 2486 2487 2488 2489
{
	struct usb_mixer_interface *mixer = device->device_data;
	snd_usb_mixer_free(mixer);
	return 0;
}

L
Linus Torvalds 已提交
2490 2491 2492
/*
 * create mixer controls
 *
2493
 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
L
Linus Torvalds 已提交
2494
 */
2495
static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
L
Linus Torvalds 已提交
2496
{
2497
	struct mixer_build state;
L
Linus Torvalds 已提交
2498 2499
	int err;
	const struct usbmix_ctl_map *map;
2500
	void *p;
L
Linus Torvalds 已提交
2501 2502

	memset(&state, 0, sizeof(state));
2503 2504
	state.chip = mixer->chip;
	state.mixer = mixer;
2505 2506
	state.buffer = mixer->hostif->extra;
	state.buflen = mixer->hostif->extralen;
L
Linus Torvalds 已提交
2507 2508

	/* check the mapping table */
2509 2510
	for (map = usbmix_ctl_maps; map->id; map++) {
		if (map->id == state.chip->usb_id) {
L
Linus Torvalds 已提交
2511
			state.map = map->map;
2512
			state.selector_map = map->selector_map;
2513
			mixer->ignore_ctl_error = map->ignore_ctl_error;
L
Linus Torvalds 已提交
2514 2515 2516 2517
			break;
		}
	}

2518
	p = NULL;
2519 2520
	while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
					    mixer->hostif->extralen,
2521
					    p, UAC_OUTPUT_TERMINAL)) != NULL) {
2522
		if (mixer->protocol == UAC_VERSION_1) {
2523
			struct uac1_output_terminal_descriptor *desc = p;
2524 2525 2526

			if (desc->bLength < sizeof(*desc))
				continue; /* invalid descriptor? */
2527 2528
			/* mark terminal ID as visited */
			set_bit(desc->bTerminalID, state.unitbitmap);
2529 2530 2531 2532
			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);
2533
			if (err < 0 && err != -EINVAL)
2534
				return err;
2535
		} else if (mixer->protocol == UAC_VERSION_2) {
2536 2537 2538 2539
			struct uac2_output_terminal_descriptor *desc = p;

			if (desc->bLength < sizeof(*desc))
				continue; /* invalid descriptor? */
2540 2541
			/* mark terminal ID as visited */
			set_bit(desc->bTerminalID, state.unitbitmap);
2542 2543 2544 2545
			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);
2546
			if (err < 0 && err != -EINVAL)
2547
				return err;
2548

2549 2550 2551 2552
			/*
			 * For UAC2, use the same approach to also add the
			 * clock selectors
			 */
2553
			err = parse_audio_unit(&state, desc->bCSourceID);
2554
			if (err < 0 && err != -EINVAL)
2555
				return err;
2556 2557 2558 2559 2560 2561

			if (uac_v2v3_control_is_readable(desc->bmControls,
							 UAC2_TE_CONNECTOR)) {
				build_connector_control(&state, &state.oterm,
							false);
			}
2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582
		} else {  /* UAC_VERSION_3 */
			struct uac3_output_terminal_descriptor *desc = p;

			if (desc->bLength < sizeof(*desc))
				continue; /* invalid descriptor? */
			/* 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;
2583
		}
L
Linus Torvalds 已提交
2584
	}
2585

L
Linus Torvalds 已提交
2586 2587
	return 0;
}
2588

D
Daniel Mack 已提交
2589
void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
2590
{
2591
	struct usb_mixer_elem_list *list;
2592

2593 2594 2595 2596 2597
	for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
		struct usb_mixer_elem_info *info =
			(struct usb_mixer_elem_info *)list;
		/* invalidate cache, so the value is read from the device */
		info->cached = 0;
2598
		snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2599
			       &list->kctl->id);
2600
	}
2601 2602
}

2603
static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2604
				    struct usb_mixer_elem_list *list)
2605
{
2606
	struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2607 2608 2609
	static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
				    "S8", "U8", "S16", "U16"};
	snd_iprintf(buffer, "    Info: id=%i, control=%i, cmask=0x%x, "
2610
			    "channels=%i, type=\"%s\"\n", cval->head.id,
2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621
			    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;
2622
	struct usb_mixer_elem_list *list;
2623 2624 2625 2626
	int unitid;

	list_for_each_entry(mixer, &chip->mixer_list, list) {
		snd_iprintf(buffer,
2627
			"USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2628
				chip->usb_id, snd_usb_ctrl_intf(chip),
2629
				mixer->ignore_ctl_error);
2630 2631
		snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
		for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642
			for (list = mixer->id_elems[unitid]; list;
			     list = list->next_id_elem) {
				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);
			}
2643 2644 2645 2646
		}
	}
}

2647 2648 2649
static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
				       int attribute, int value, int index)
{
2650
	struct usb_mixer_elem_list *list;
2651 2652 2653
	__u8 unitid = (index >> 8) & 0xff;
	__u8 control = (value >> 8) & 0xff;
	__u8 channel = value & 0xff;
2654
	unsigned int count = 0;
2655 2656

	if (channel >= MAX_CHANNELS) {
2657 2658 2659
		usb_audio_dbg(mixer->chip,
			"%s(): bogus channel number %d\n",
			__func__, channel);
2660 2661 2662
		return;
	}

2663 2664 2665 2666 2667 2668
	for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
		count++;

	if (count == 0)
		return;

2669 2670 2671 2672 2673 2674 2675
	for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
		struct usb_mixer_elem_info *info;

		if (!list->kctl)
			continue;

		info = (struct usb_mixer_elem_info *)list;
2676
		if (count > 1 && info->control != control)
2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687
			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,
2688
				       &info->head.kctl->id);
2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699
			break;

		case UAC2_CS_RANGE:
			/* TODO */
			break;

		case UAC2_CS_MEM:
			/* TODO */
			break;

		default:
2700 2701 2702
			usb_audio_dbg(mixer->chip,
				"unknown attribute %d in interrupt\n",
				attribute);
2703 2704 2705 2706 2707 2708
			break;
		} /* switch */
	}
}

static void snd_usb_mixer_interrupt(struct urb *urb)
2709 2710
{
	struct usb_mixer_interface *mixer = urb->context;
2711
	int len = urb->actual_length;
2712
	int ustatus = urb->status;
2713

2714
	if (ustatus != 0)
2715
		goto requeue;
2716

2717 2718
	if (mixer->protocol == UAC_VERSION_1) {
		struct uac1_status_word *status;
2719

2720 2721 2722
		for (status = urb->transfer_buffer;
		     len >= sizeof(*status);
		     len -= sizeof(*status), status++) {
2723
			dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
2724 2725 2726
						status->bStatusType,
						status->bOriginator);

2727
			/* ignore any notifications not from the control interface */
2728 2729
			if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
				UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2730
				continue;
2731 2732 2733

			if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
				snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2734
			else
2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750
				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));
2751 2752
		}
	}
2753 2754

requeue:
2755 2756 2757
	if (ustatus != -ENOENT &&
	    ustatus != -ECONNRESET &&
	    ustatus != -ESHUTDOWN) {
2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771
		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 */
2772
	if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
2773
		return 0;
2774
	ep = get_endpoint(mixer->hostif, 0);
2775
	if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2776 2777
		return 0;

2778
	epnum = usb_endpoint_num(ep);
2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790
	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,
2791
			 snd_usb_mixer_interrupt, mixer, ep->bInterval);
2792 2793 2794 2795
	usb_submit_urb(mixer->urb, GFP_KERNEL);
	return 0;
}

2796 2797
int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
			 int ignore_error)
2798
{
2799
	static struct snd_device_ops dev_ops = {
2800 2801 2802
		.dev_free = snd_usb_mixer_dev_free
	};
	struct usb_mixer_interface *mixer;
2803
	struct snd_info_entry *entry;
2804
	int err;
2805 2806 2807

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

2808
	mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2809 2810 2811
	if (!mixer)
		return -ENOMEM;
	mixer->chip = chip;
2812
	mixer->ignore_ctl_error = ignore_error;
2813 2814
	mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
				  GFP_KERNEL);
2815 2816 2817 2818
	if (!mixer->id_elems) {
		kfree(mixer);
		return -ENOMEM;
	}
2819

2820 2821
	mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
	switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
2822 2823 2824 2825 2826 2827 2828
	case UAC_VERSION_1:
	default:
		mixer->protocol = UAC_VERSION_1;
		break;
	case UAC_VERSION_2:
		mixer->protocol = UAC_VERSION_2;
		break;
2829 2830 2831
	case UAC_VERSION_3:
		mixer->protocol = UAC_VERSION_3;
		break;
2832
	}
2833

2834
	if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2835 2836
	    (err = snd_usb_mixer_status_create(mixer)) < 0)
		goto _error;
2837

D
Daniel Mack 已提交
2838
	snd_usb_mixer_apply_create_quirk(mixer);
2839

2840
	err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
2841 2842
	if (err < 0)
		goto _error;
2843 2844 2845 2846 2847

	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);

2848 2849
	list_add(&mixer->list, &chip->mixer_list);
	return 0;
2850 2851 2852 2853

_error:
	snd_usb_mixer_free(mixer);
	return err;
2854 2855
}

2856
void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
2857
{
2858 2859 2860 2861 2862 2863 2864
	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;
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

#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;
}

2894
static int restore_mixer_value(struct usb_mixer_elem_list *list)
2895
{
2896
	struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2897 2898 2899 2900 2901 2902 2903
	int c, err, idx;

	if (cval->cmask) {
		idx = 0;
		for (c = 0; c < MAX_CHANNELS; c++) {
			if (!(cval->cmask & (1 << c)))
				continue;
2904
			if (cval->cached & (1 << (c + 1))) {
2905
				err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
2906 2907 2908 2909 2910 2911 2912 2913 2914
							cval->cache_val[idx]);
				if (err < 0)
					return err;
			}
			idx++;
		}
	} else {
		/* master */
		if (cval->cached) {
2915
			err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
2916 2917 2918 2919 2920 2921 2922 2923 2924 2925
			if (err < 0)
				return err;
		}
	}

	return 0;
}

int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
{
2926
	struct usb_mixer_elem_list *list;
2927 2928 2929 2930 2931
	int id, err;

	if (reset_resume) {
		/* restore cached mixer values */
		for (id = 0; id < MAX_ID_ELEMS; id++) {
2932 2933 2934 2935 2936 2937 2938
			for (list = mixer->id_elems[id]; list;
			     list = list->next_id_elem) {
				if (list->resume) {
					err = list->resume(list);
					if (err < 0)
						return err;
				}
2939 2940 2941 2942 2943 2944 2945
			}
		}
	}

	return snd_usb_mixer_activate(mixer);
}
#endif
2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957

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
}