mixer.c 58.8 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 29 30 31 32 33 34
/*
 *   (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
 *
 */

#include <linux/bitops.h>
#include <linux/init.h>
#include <linux/list.h>
#include <linux/slab.h>
#include <linux/string.h>
#include <linux/usb.h>
35
#include <linux/usb/audio.h>
36
#include <linux/usb/audio-v2.h>
37

L
Linus Torvalds 已提交
38 39
#include <sound/core.h>
#include <sound/control.h>
40
#include <sound/hwdep.h>
41
#include <sound/info.h>
42
#include <sound/tlv.h>
L
Linus Torvalds 已提交
43 44

#include "usbaudio.h"
45
#include "mixer.h"
D
Daniel Mack 已提交
46
#include "helper.h"
D
Daniel Mack 已提交
47
#include "mixer_quirks.h"
48

49 50
#define MAX_ID_ELEMS	256

L
Linus Torvalds 已提交
51 52 53 54 55 56 57 58 59 60
struct usb_audio_term {
	int id;
	int type;
	int channels;
	unsigned int chconfig;
	int name;
};

struct usbmix_name_map;

61 62
struct mixer_build {
	struct snd_usb_audio *chip;
63
	struct usb_mixer_interface *mixer;
L
Linus Torvalds 已提交
64 65
	unsigned char *buffer;
	unsigned int buflen;
66
	DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
67
	struct usb_audio_term oterm;
L
Linus Torvalds 已提交
68
	const struct usbmix_name_map *map;
69
	const struct usbmix_selector_map *selector_map;
L
Linus Torvalds 已提交
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
};

enum {
	USB_MIXER_BOOLEAN,
	USB_MIXER_INV_BOOLEAN,
	USB_MIXER_S8,
	USB_MIXER_U8,
	USB_MIXER_S16,
	USB_MIXER_U16,
};

enum {
	USB_PROC_UPDOWN = 1,
	USB_PROC_UPDOWN_SWITCH = 1,
	USB_PROC_UPDOWN_MODE_SEL = 2,

	USB_PROC_PROLOGIC = 2,
	USB_PROC_PROLOGIC_SWITCH = 1,
	USB_PROC_PROLOGIC_MODE_SEL = 2,

	USB_PROC_3DENH = 3,
	USB_PROC_3DENH_SWITCH = 1,
	USB_PROC_3DENH_SPACE = 2,

	USB_PROC_REVERB = 4,
	USB_PROC_REVERB_SWITCH = 1,
	USB_PROC_REVERB_LEVEL = 2,
	USB_PROC_REVERB_TIME = 3,
	USB_PROC_REVERB_DELAY = 4,

	USB_PROC_CHORUS = 5,
	USB_PROC_CHORUS_SWITCH = 1,
	USB_PROC_CHORUS_LEVEL = 2,
	USB_PROC_CHORUS_RATE = 3,
	USB_PROC_CHORUS_DEPTH = 4,

	USB_PROC_DCR = 6,
	USB_PROC_DCR_SWITCH = 1,
	USB_PROC_DCR_RATIO = 2,
	USB_PROC_DCR_MAX_AMP = 3,
	USB_PROC_DCR_THRESHOLD = 4,
	USB_PROC_DCR_ATTACK = 5,
	USB_PROC_DCR_RELEASE = 6,
};

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
/*E-mu 0202(0404) eXtension Unit(XU) control*/
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 已提交
130 131 132 133 134 135

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

138 139
static const struct usbmix_name_map *
find_map(struct mixer_build *state, int unitid, int control)
L
Linus Torvalds 已提交
140
{
141
	const struct usbmix_name_map *p = state->map;
L
Linus Torvalds 已提交
142

143 144
	if (!p)
		return NULL;
L
Linus Torvalds 已提交
145 146

	for (p = state->map; p->id; p++) {
147 148 149
		if (p->id == unitid &&
		    (!control || !p->control || control == p->control))
			return p;
L
Linus Torvalds 已提交
150
	}
151
	return NULL;
L
Linus Torvalds 已提交
152 153
}

154 155 156
/* 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 已提交
157
{
158 159
	if (!p || !p->name)
		return 0;
L
Linus Torvalds 已提交
160

161 162 163 164 165 166 167 168 169
	buflen--;
	return strlcpy(buf, p->name, buflen);
}

/* 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 已提交
170
		return 0;
171 172 173 174 175 176 177 178 179 180
	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;
L
Linus Torvalds 已提交
181 182 183
	}
}

184
/* get the mapped selector source name */
185
static int check_mapped_selector_name(struct mixer_build *state, int unitid,
186 187 188 189 190 191 192 193 194 195 196 197 198
				      int index, char *buf, int buflen)
{
	const struct usbmix_selector_map *p;

	if (! state->selector_map)
		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 已提交
199 200
/*
 * find an audio control unit with the given unit id
201
 * this doesn't return any clock related units, so they need to be handled elsewhere
L
Linus Torvalds 已提交
202
 */
203
static void *find_audio_control_unit(struct mixer_build *state, unsigned char unit)
L
Linus Torvalds 已提交
204 205 206 207 208 209
{
	unsigned char *p;

	p = NULL;
	while ((p = snd_usb_find_desc(state->buffer, state->buflen, p,
				      USB_DT_CS_INTERFACE)) != NULL) {
210
		if (p[0] >= 4 && p[2] >= UAC_INPUT_TERMINAL && p[2] <= UAC2_EXTENSION_UNIT_V2 && p[3] == unit)
L
Linus Torvalds 已提交
211 212 213 214 215 216 217 218 219
			return p;
	}
	return NULL;
}


/*
 * copy a string with the given id
 */
220
static int snd_usb_copy_string_desc(struct mixer_build *state, int index, char *buf, int maxlen)
L
Linus Torvalds 已提交
221 222 223 224 225 226 227 228 229
{
	int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
	buf[len] = 0;
	return len;
}

/*
 * convert from the byte/word on usb descriptor to the zero-based integer
 */
230
static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
L
Linus Torvalds 已提交
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
{
	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
 */
260
static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
L
Linus Torvalds 已提交
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
{
	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 */
}

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

289
static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
L
Linus Torvalds 已提交
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
{
	if (val < 0)
		return cval->min;
	if (! cval->res)
		cval->res = 1;
	val *= cval->res;
	val += cval->min;
	if (val > cval->max)
		return cval->max;
	return val;
}


/*
 * retrieve a mixer value
 */

307
static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
L
Linus Torvalds 已提交
308 309 310 311 312 313
{
	unsigned char buf[2];
	int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
	int timeout = 10;

	while (timeout-- > 0) {
314 315
		if (snd_usb_ctl_msg(cval->mixer->chip->dev,
				    usb_rcvctrlpipe(cval->mixer->chip->dev, 0),
L
Linus Torvalds 已提交
316 317
				    request,
				    USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
318
				    validx, cval->mixer->ctrlif | (cval->id << 8),
319
				    buf, val_len, 100) >= val_len) {
L
Linus Torvalds 已提交
320 321 322 323
			*value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
			return 0;
		}
	}
324 325
	snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
		    request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type);
L
Linus Torvalds 已提交
326 327 328
	return -EINVAL;
}

329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
{
	unsigned char buf[14]; /* enough space for one range of 4 bytes */
	unsigned char *val;
	int ret;
	__u8 bRequest;

	bRequest = (request == UAC_GET_CUR) ?
		UAC2_CS_CUR : UAC2_CS_RANGE;

	ret = snd_usb_ctl_msg(cval->mixer->chip->dev,
			      usb_rcvctrlpipe(cval->mixer->chip->dev, 0),
			      bRequest,
			      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
			      validx, cval->mixer->ctrlif | (cval->id << 8),
			      buf, sizeof(buf), 1000);

	if (ret < 0) {
		snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
			    request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type);
		return ret;
	}

	switch (request) {
	case UAC_GET_CUR:
		val = buf;
		break;
	case UAC_GET_MIN:
		val = buf + sizeof(__u16);
		break;
	case UAC_GET_MAX:
		val = buf + sizeof(__u16) * 2;
		break;
	case UAC_GET_RES:
		val = buf + sizeof(__u16) * 3;
		break;
	default:
		return -EINVAL;
	}

	*value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));

	return 0;
}

static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
{
	return (cval->mixer->protocol == UAC_VERSION_1) ?
		get_ctl_value_v1(cval, request, validx, value_ret) :
		get_ctl_value_v2(cval, request, validx, value_ret);
}

381
static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int *value)
L
Linus Torvalds 已提交
382
{
383
	return get_ctl_value(cval, UAC_GET_CUR, validx, value);
L
Linus Torvalds 已提交
384 385 386
}

/* channel = 0: master, 1 = first channel */
387 388
static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
				  int channel, int *value)
L
Linus Torvalds 已提交
389
{
390
	return get_ctl_value(cval, UAC_GET_CUR, (cval->control << 8) | channel, value);
L
Linus Torvalds 已提交
391 392
}

393 394 395 396 397 398 399 400 401 402 403 404
static int get_cur_mix_value(struct usb_mixer_elem_info *cval,
			     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) {
		if (!cval->mixer->ignore_ctl_error)
405
			snd_printd(KERN_ERR "cannot get current value for control %d ch %d: err = %d\n",
406 407 408 409 410 411 412 413 414
				   cval->control, channel, err);
		return err;
	}
	cval->cached |= 1 << channel;
	cval->cache_val[index] = *value;
	return 0;
}


L
Linus Torvalds 已提交
415 416 417 418
/*
 * set a mixer value
 */

D
Daniel Mack 已提交
419 420
int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
				int request, int validx, int value_set)
L
Linus Torvalds 已提交
421 422
{
	unsigned char buf[2];
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
	int val_len, timeout = 10;

	if (cval->mixer->protocol == UAC_VERSION_1) {
		val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
	} else { /* UAC_VERSION_2 */
		/* audio class v2 controls are always 2 bytes in size */
		val_len = sizeof(__u16);

		/* FIXME */
		if (request != UAC_SET_CUR) {
			snd_printdd(KERN_WARNING "RANGE setting not yet supported\n");
			return -EINVAL;
		}

		request = UAC2_CS_CUR;
	}
L
Linus Torvalds 已提交
439 440 441 442

	value_set = convert_bytes_value(cval, value_set);
	buf[0] = value_set & 0xff;
	buf[1] = (value_set >> 8) & 0xff;
V
Viral Mehta 已提交
443
	while (timeout-- > 0)
444 445
		if (snd_usb_ctl_msg(cval->mixer->chip->dev,
				    usb_sndctrlpipe(cval->mixer->chip->dev, 0),
L
Linus Torvalds 已提交
446 447
				    request,
				    USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
448
				    validx, cval->mixer->ctrlif | (cval->id << 8),
L
Linus Torvalds 已提交
449 450
				    buf, val_len, 100) >= 0)
			return 0;
451 452
	snd_printdd(KERN_ERR "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
		    request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type, buf[0], buf[1]);
L
Linus Torvalds 已提交
453 454 455
	return -EINVAL;
}

456
static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int value)
L
Linus Torvalds 已提交
457
{
D
Daniel Mack 已提交
458
	return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
L
Linus Torvalds 已提交
459 460
}

461 462
static int set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
			     int index, int value)
L
Linus Torvalds 已提交
463
{
464
	int err;
465 466 467 468 469 470 471 472 473 474
	unsigned int read_only = (channel == 0) ?
		cval->master_readonly :
		cval->ch_readonly & (1 << (channel - 1));

	if (read_only) {
		snd_printdd(KERN_INFO "%s(): channel %d of control %d is read_only\n",
			    __func__, channel, cval->control);
		return 0;
	}

D
Daniel Mack 已提交
475
	err = snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, (cval->control << 8) | channel,
476 477 478 479 480 481
			    value);
	if (err < 0)
		return err;
	cval->cached |= 1 << channel;
	cval->cache_val[index] = value;
	return 0;
L
Linus Torvalds 已提交
482 483
}

484 485 486 487 488 489 490
/*
 * TLV callback for mixer volume controls
 */
static int mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
			 unsigned int size, unsigned int __user *_tlv)
{
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
491
	DECLARE_TLV_DB_MINMAX(scale, 0, 0);
492 493 494

	if (size < sizeof(scale))
		return -ENOMEM;
495 496
	scale[2] = cval->dBmin;
	scale[3] = cval->dBmax;
497 498 499 500
	if (copy_to_user(_tlv, scale, sizeof(scale)))
		return -EFAULT;
	return 0;
}
L
Linus Torvalds 已提交
501 502 503 504 505

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

506
static int parse_audio_unit(struct mixer_build *state, int unitid);
L
Linus Torvalds 已提交
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526


/*
 * check if the input/output channel routing is enabled on the given bitmap.
 * used for mixer unit parser
 */
static int check_matrix_bitmap(unsigned char *bmap, int ich, int och, int num_outs)
{
	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.
 */

527
static int add_control_to_empty(struct mixer_build *state, struct snd_kcontrol *kctl)
L
Linus Torvalds 已提交
528
{
529
	struct usb_mixer_elem_info *cval = kctl->private_data;
L
Linus Torvalds 已提交
530
	int err;
531 532

	while (snd_ctl_find_id(state->chip->card, &kctl->id))
L
Linus Torvalds 已提交
533
		kctl->id.index++;
534
	if ((err = snd_ctl_add(state->chip->card, kctl)) < 0) {
L
Linus Torvalds 已提交
535
		snd_printd(KERN_ERR "cannot add control (err = %d)\n", err);
536
		return err;
L
Linus Torvalds 已提交
537
	}
538 539 540 541
	cval->elem_id = &kctl->id;
	cval->next_id_elem = state->mixer->id_elems[cval->id];
	state->mixer->id_elems[cval->id] = cval;
	return 0;
L
Linus Torvalds 已提交
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
}


/*
 * 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 },
};

592
static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
L
Linus Torvalds 已提交
593 594 595 596 597 598 599 600 601 602 603 604
			 unsigned char *name, int maxlen, int term_only)
{
	struct iterm_name_combo *names;

	if (iterm->name)
		return snd_usb_copy_string_desc(state, iterm->name, name, maxlen);

	/* virtual type - not a real terminal */
	if (iterm->type >> 16) {
		if (term_only)
			return 0;
		switch (iterm->type >> 16) {
605
		case UAC_SELECTOR_UNIT:
L
Linus Torvalds 已提交
606
			strcpy(name, "Selector"); return 8;
607
		case UAC_PROCESSING_UNIT_V1:
L
Linus Torvalds 已提交
608
			strcpy(name, "Process Unit"); return 12;
609
		case UAC_EXTENSION_UNIT_V1:
L
Linus Torvalds 已提交
610
			strcpy(name, "Ext Unit"); return 8;
611
		case UAC_MIXER_UNIT:
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
			strcpy(name, "Mixer"); return 5;
		default:
			return sprintf(name, "Unit %d", iterm->id);
		}
	}

	switch (iterm->type & 0xff00) {
	case 0x0100:
		strcpy(name, "PCM"); return 3;
	case 0x0200:
		strcpy(name, "Mic"); return 3;
	case 0x0400:
		strcpy(name, "Headset"); return 7;
	case 0x0500:
		strcpy(name, "Phone"); return 5;
	}

	for (names = iterm_names; names->type; names++)
		if (names->type == iterm->type) {
			strcpy(name, names->name);
			return strlen(names->name);
		}
	return 0;
}


/*
 * parse the source unit recursively until it reaches to a terminal
 * or a branched unit.
 */
642
static int check_input_term(struct mixer_build *state, int id, struct usb_audio_term *term)
L
Linus Torvalds 已提交
643
{
644
	void *p1;
L
Linus Torvalds 已提交
645 646 647

	memset(term, 0, sizeof(*term));
	while ((p1 = find_audio_control_unit(state, id)) != NULL) {
648
		unsigned char *hdr = p1;
L
Linus Torvalds 已提交
649
		term->id = id;
650
		switch (hdr[2]) {
651
		case UAC_INPUT_TERMINAL:
652 653 654 655 656 657 658 659 660 661 662 663 664
			if (state->mixer->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;
				term->type = le16_to_cpu(d->wTerminalType);
				term->channels = d->bNrChannels;
				term->chconfig = le32_to_cpu(d->bmChannelConfig);
				term->name = d->iTerminal;
			}
L
Linus Torvalds 已提交
665
			return 0;
666 667 668
		case UAC_FEATURE_UNIT: {
			/* the header is the same for v1 and v2 */
			struct uac_feature_unit_descriptor *d = p1;
669
			id = d->bSourceID;
L
Linus Torvalds 已提交
670
			break; /* continue to parse */
671 672 673 674 675 676 677
		}
		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, state->mixer->protocol);
			term->name = uac_mixer_unit_iMixer(d);
L
Linus Torvalds 已提交
678
			return 0;
679 680 681
		}
		case UAC_SELECTOR_UNIT: {
			struct uac_selector_unit_descriptor *d = p1;
L
Linus Torvalds 已提交
682
			/* call recursively to retrieve the channel info */
683
			if (check_input_term(state, d->baSourceID[0], term) < 0)
L
Linus Torvalds 已提交
684
				return -ENODEV;
685
			term->type = d->bDescriptorSubtype << 16; /* virtual type */
L
Linus Torvalds 已提交
686
			term->id = id;
687
			term->name = uac_selector_unit_iSelector(d);
L
Linus Torvalds 已提交
688
			return 0;
689
		}
690
		case UAC_PROCESSING_UNIT_V1:
691 692 693 694
		case UAC_EXTENSION_UNIT_V1: {
			struct uac_processing_unit_descriptor *d = p1;
			if (d->bNrInPins) {
				id = d->baSourceID[0];
L
Linus Torvalds 已提交
695 696
				break; /* continue to parse */
			}
697 698 699 700
			term->type = d->bDescriptorSubtype << 16; /* virtual type */
			term->channels = uac_processing_unit_bNrChannels(d);
			term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
			term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
L
Linus Torvalds 已提交
701
			return 0;
702
		}
L
Linus Torvalds 已提交
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
		default:
			return -ENODEV;
		}
	}
	return -ENODEV;
}


/*
 * Feature Unit
 */

/* feature unit control information */
struct usb_feature_control_info {
	const char *name;
	unsigned int type;	/* control type (mute, volume, etc.) */
};

static struct usb_feature_control_info audio_feature_info[] = {
	{ "Mute",		USB_MIXER_INV_BOOLEAN },
	{ "Volume",		USB_MIXER_S16 },
	{ "Tone Control - Bass",	USB_MIXER_S8 },
	{ "Tone Control - Mid",		USB_MIXER_S8 },
	{ "Tone Control - Treble",	USB_MIXER_S8 },
	{ "Graphic Equalizer",		USB_MIXER_S8 }, /* FIXME: not implemeted yet */
	{ "Auto Gain Control",	USB_MIXER_BOOLEAN },
	{ "Delay Control",	USB_MIXER_U16 },
	{ "Bass Boost",		USB_MIXER_BOOLEAN },
	{ "Loudness",		USB_MIXER_BOOLEAN },
};


/* private_free callback */
736
static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
L
Linus Torvalds 已提交
737
{
738 739
	kfree(kctl->private_data);
	kctl->private_data = NULL;
L
Linus Torvalds 已提交
740 741 742 743 744 745 746 747 748 749
}


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

/*
 * retrieve the minimum and maximum values for the specified control
 */
750
static int get_min_max(struct usb_mixer_elem_info *cval, int default_min)
L
Linus Torvalds 已提交
751 752 753 754 755
{
	/* for failsafe */
	cval->min = default_min;
	cval->max = cval->min + 1;
	cval->res = 1;
756
	cval->dBmin = cval->dBmax = 0;
L
Linus Torvalds 已提交
757 758 759 760 761 762 763 764 765 766 767 768 769 770

	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;
				}
		}
771 772
		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) {
773 774
			snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
				   cval->id, cval->mixer->ctrlif, cval->control, cval->id);
L
Linus Torvalds 已提交
775 776
			return -EINVAL;
		}
777
		if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
L
Linus Torvalds 已提交
778 779 780 781 782
			cval->res = 1;
		} else {
			int last_valid_res = cval->res;

			while (cval->res > 1) {
D
Daniel Mack 已提交
783 784
				if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
								(cval->control << 8) | minchn, cval->res / 2) < 0)
L
Linus Torvalds 已提交
785 786 787
					break;
				cval->res /= 2;
			}
788
			if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
L
Linus Torvalds 已提交
789 790 791 792
				cval->res = last_valid_res;
		}
		if (cval->res == 0)
			cval->res = 1;
793 794 795 796 797 798 799 800 801 802

		/* 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;
803
			get_cur_mix_raw(cval, minchn, &saved);
804 805 806 807 808 809 810
			for (;;) {
				test = saved;
				if (test < cval->max)
					test += cval->res;
				else
					test -= cval->res;
				if (test < cval->min || test > cval->max ||
811 812
				    set_cur_mix_value(cval, minchn, 0, test) ||
				    get_cur_mix_raw(cval, minchn, &check)) {
813 814 815 816 817 818 819
					cval->res = last_valid_res;
					break;
				}
				if (test == check)
					break;
				cval->res *= 2;
			}
820
			set_cur_mix_value(cval, minchn, 0, saved);
821 822
		}

L
Linus Torvalds 已提交
823 824
		cval->initialized = 1;
	}
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842

	/* 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 已提交
843 844 845 846 847
	return 0;
}


/* get a feature/mixer unit info */
848
static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
L
Linus Torvalds 已提交
849
{
850
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865

	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 {
		if (! cval->initialized)
			get_min_max(cval,  0);
		uinfo->value.integer.min = 0;
866 867
		uinfo->value.integer.max =
			(cval->max - cval->min + cval->res - 1) / cval->res;
L
Linus Torvalds 已提交
868 869 870 871 872
	}
	return 0;
}

/* get the current value from feature/mixer unit */
873
static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
874
{
875
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
876 877
	int c, cnt, val, err;

878
	ucontrol->value.integer.value[0] = cval->min;
L
Linus Torvalds 已提交
879 880 881
	if (cval->cmask) {
		cnt = 0;
		for (c = 0; c < MAX_CHANNELS; c++) {
882 883 884 885 886 887 888 889
			if (!(cval->cmask & (1 << c)))
				continue;
			err = get_cur_mix_value(cval, c + 1, cnt, &val);
			if (err < 0)
				return cval->mixer->ignore_ctl_error ? 0 : err;
			val = get_relative_value(cval, val);
			ucontrol->value.integer.value[cnt] = val;
			cnt++;
L
Linus Torvalds 已提交
890
		}
891
		return 0;
L
Linus Torvalds 已提交
892 893
	} else {
		/* master channel */
894 895 896
		err = get_cur_mix_value(cval, 0, 0, &val);
		if (err < 0)
			return cval->mixer->ignore_ctl_error ? 0 : err;
L
Linus Torvalds 已提交
897 898 899 900 901 902 903
		val = get_relative_value(cval, val);
		ucontrol->value.integer.value[0] = val;
	}
	return 0;
}

/* put the current value to feature/mixer unit */
904
static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
905
{
906
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
907 908 909 910 911 912
	int c, cnt, val, oval, err;
	int changed = 0;

	if (cval->cmask) {
		cnt = 0;
		for (c = 0; c < MAX_CHANNELS; c++) {
913 914 915 916 917 918 919 920 921 922
			if (!(cval->cmask & (1 << c)))
				continue;
			err = get_cur_mix_value(cval, c + 1, cnt, &oval);
			if (err < 0)
				return cval->mixer->ignore_ctl_error ? 0 : err;
			val = ucontrol->value.integer.value[cnt];
			val = get_abs_value(cval, val);
			if (oval != val) {
				set_cur_mix_value(cval, c + 1, cnt, val);
				changed = 1;
L
Linus Torvalds 已提交
923
			}
924
			cnt++;
L
Linus Torvalds 已提交
925 926 927
		}
	} else {
		/* master channel */
928
		err = get_cur_mix_value(cval, 0, 0, &oval);
L
Linus Torvalds 已提交
929
		if (err < 0)
930
			return cval->mixer->ignore_ctl_error ? 0 : err;
L
Linus Torvalds 已提交
931 932 933
		val = ucontrol->value.integer.value[0];
		val = get_abs_value(cval, val);
		if (val != oval) {
934
			set_cur_mix_value(cval, 0, 0, val);
L
Linus Torvalds 已提交
935 936 937 938 939 940
			changed = 1;
		}
	}
	return changed;
}

941
static struct snd_kcontrol_new usb_feature_unit_ctl = {
L
Linus Torvalds 已提交
942 943 944 945 946 947 948
	.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,
};

949 950 951 952 953 954 955 956 957
/* the read-only variant */
static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
	.name = "", /* will be filled later manually */
	.info = mixer_ctl_feature_info,
	.get = mixer_ctl_feature_get,
	.put = NULL,
};

L
Linus Torvalds 已提交
958 959 960 961 962

/*
 * build a feature control
 */

T
Takashi Iwai 已提交
963 964 965 966 967
static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
{
	return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
}

968
static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
L
Linus Torvalds 已提交
969
			      unsigned int ctl_mask, int control,
970
			      struct usb_audio_term *iterm, int unitid,
971
			      int readonly_mask)
L
Linus Torvalds 已提交
972
{
973
	struct uac_feature_unit_descriptor *desc = raw_desc;
L
Linus Torvalds 已提交
974 975
	unsigned int len = 0;
	int mapped_name = 0;
976
	int nameid = uac_feature_unit_iFeature(desc);
977 978
	struct snd_kcontrol *kctl;
	struct usb_mixer_elem_info *cval;
979
	const struct usbmix_name_map *map;
L
Linus Torvalds 已提交
980 981 982

	control++; /* change from zero-based to 1-based value */

983
	if (control == UAC_GRAPHIC_EQUALIZER_CONTROL) {
L
Linus Torvalds 已提交
984 985 986 987
		/* FIXME: not supported yet */
		return;
	}

988 989
	map = find_map(state, unitid, control);
	if (check_ignored_ctl(map))
L
Linus Torvalds 已提交
990 991
		return;

992
	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
L
Linus Torvalds 已提交
993 994 995 996
	if (! cval) {
		snd_printk(KERN_ERR "cannot malloc kcontrol\n");
		return;
	}
997
	cval->mixer = state->mixer;
L
Linus Torvalds 已提交
998 999 1000 1001
	cval->id = unitid;
	cval->control = control;
	cval->cmask = ctl_mask;
	cval->val_type = audio_feature_info[control-1].type;
1002
	if (ctl_mask == 0) {
L
Linus Torvalds 已提交
1003
		cval->channels = 1;	/* master channel */
1004 1005
		cval->master_readonly = readonly_mask;
	} else {
L
Linus Torvalds 已提交
1006 1007 1008 1009 1010
		int i, c = 0;
		for (i = 0; i < 16; i++)
			if (ctl_mask & (1 << i))
				c++;
		cval->channels = c;
1011
		cval->ch_readonly = readonly_mask;
L
Linus Torvalds 已提交
1012 1013 1014 1015 1016
	}

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

1017 1018 1019 1020
	/* if all channels in the mask are marked read-only, make the control
	 * read-only. set_cur_mix_value() will check the mask again and won't
	 * issue write commands to read-only channels. */
	if (cval->channels == readonly_mask)
1021 1022 1023 1024
		kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
	else
		kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);

L
Linus Torvalds 已提交
1025 1026 1027 1028 1029 1030 1031
	if (! kctl) {
		snd_printk(KERN_ERR "cannot malloc kcontrol\n");
		kfree(cval);
		return;
	}
	kctl->private_free = usb_mixer_elem_free;

1032
	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
L
Linus Torvalds 已提交
1033 1034
	mapped_name = len != 0;
	if (! len && nameid)
1035 1036
		len = snd_usb_copy_string_desc(state, nameid,
				kctl->id.name, sizeof(kctl->id.name));
L
Linus Torvalds 已提交
1037 1038

	switch (control) {
1039 1040
	case UAC_MUTE_CONTROL:
	case UAC_VOLUME_CONTROL:
L
Linus Torvalds 已提交
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
		/* determine the control name.  the rule is:
		 * - 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.
		 */
		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)
				len = snprintf(kctl->id.name, sizeof(kctl->id.name),
					       "Feature %d", unitid);
		}
		/* determine the stream direction:
		 * if the connected output is USB stream, then it's likely a
		 * capture stream.  otherwise it should be playback (hopefully :)
		 */
		if (! mapped_name && ! (state->oterm.type >> 16)) {
			if ((state->oterm.type & 0xff00) == 0x0100) {
T
Takashi Iwai 已提交
1062
				len = append_ctl_name(kctl, " Capture");
L
Linus Torvalds 已提交
1063
			} else {
T
Takashi Iwai 已提交
1064
				len = append_ctl_name(kctl, " Playback");
L
Linus Torvalds 已提交
1065 1066
			}
		}
1067
		append_ctl_name(kctl, control == UAC_MUTE_CONTROL ?
T
Takashi Iwai 已提交
1068
				" Switch" : " Volume");
1069
		if (control == UAC_VOLUME_CONTROL) {
1070 1071 1072 1073
			kctl->tlv.c = mixer_vol_tlv;
			kctl->vd[0].access |= 
				SNDRV_CTL_ELEM_ACCESS_TLV_READ |
				SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1074
			check_mapped_dB(map, cval);
1075
		}
L
Linus Torvalds 已提交
1076 1077 1078 1079 1080 1081 1082 1083 1084
		break;

	default:
		if (! len)
			strlcpy(kctl->id.name, audio_feature_info[control-1].name,
				sizeof(kctl->id.name));
		break;
	}

1085
	/* volume control quirks */
1086 1087 1088 1089 1090
	switch (state->chip->usb_id) {
	case USB_ID(0x0471, 0x0101):
	case USB_ID(0x0471, 0x0104):
	case USB_ID(0x0471, 0x0105):
	case USB_ID(0x0672, 0x1041):
1091 1092 1093 1094 1095
	/* 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
	 */
1096 1097
		if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
		    cval->min == -15616) {
1098 1099
			snd_printk(KERN_INFO
				 "set volume quirk for UDA1321/N101 chip\n");
1100 1101
			cval->max = -256;
		}
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
		break;

	case USB_ID(0x046d, 0x09a4):
		if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
			snd_printk(KERN_INFO
				"set volume quirk for QuickCam E3500\n");
			cval->min = 6080;
			cval->max = 8768;
			cval->res = 192;
		}
		break;

L
Linus Torvalds 已提交
1114 1115 1116 1117
	}

	snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
		    cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
1118
	add_control_to_empty(state, kctl);
L
Linus Torvalds 已提交
1119 1120 1121 1122 1123 1124 1125 1126 1127
}



/*
 * parse a feature unit
 *
 * most of controlls are defined here.
 */
1128
static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr)
L
Linus Torvalds 已提交
1129 1130
{
	int channels, i, j;
1131
	struct usb_audio_term iterm;
L
Linus Torvalds 已提交
1132 1133
	unsigned int master_bits, first_ch_bits;
	int err, csize;
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
	struct uac_feature_unit_descriptor *hdr = _ftr;
	__u8 *bmaControls;

	if (state->mixer->protocol == UAC_VERSION_1) {
		csize = hdr->bControlSize;
		channels = (hdr->bLength - 7) / csize - 1;
		bmaControls = hdr->bmaControls;
	} else {
		struct uac2_feature_unit_descriptor *ftr = _ftr;
		csize = 4;
1144
		channels = (hdr->bLength - 6) / 4 - 1;
1145 1146
		bmaControls = ftr->bmaControls;
	}
L
Linus Torvalds 已提交
1147

1148
	if (hdr->bLength < 7 || !csize || hdr->bLength < 7 + csize) {
1149
		snd_printk(KERN_ERR "usbaudio: unit %u: invalid UAC_FEATURE_UNIT descriptor\n", unitid);
L
Linus Torvalds 已提交
1150 1151 1152 1153
		return -EINVAL;
	}

	/* parse the source unit */
1154
	if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
L
Linus Torvalds 已提交
1155 1156 1157
		return err;

	/* determine the input source type and name */
1158
	if (check_input_term(state, hdr->bSourceID, &iterm) < 0)
L
Linus Torvalds 已提交
1159 1160
		return -EINVAL;

1161
	master_bits = snd_usb_combine_bytes(bmaControls, csize);
1162 1163 1164 1165 1166 1167
	/* master configuration quirks */
	switch (state->chip->usb_id) {
	case USB_ID(0x08bb, 0x2702):
		snd_printk(KERN_INFO
			   "usbmixer: master volume quirk for PCM2702 chip\n");
		/* disable non-functional volume control */
1168
		master_bits &= ~UAC_FU_VOLUME;
1169 1170
		break;
	}
L
Linus Torvalds 已提交
1171
	if (channels > 0)
1172
		first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
L
Linus Torvalds 已提交
1173 1174
	else
		first_ch_bits = 0;
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205

	if (state->mixer->protocol == UAC_VERSION_1) {
		/* check all control types */
		for (i = 0; i < 10; i++) {
			unsigned int ch_bits = 0;
			for (j = 0; j < channels; j++) {
				unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
				if (mask & (1 << i))
					ch_bits |= (1 << j);
			}
			/* audio class v1 controls are never read-only */
			if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
				build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, 0);
			if (master_bits & (1 << i))
				build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 0);
		}
	} else { /* UAC_VERSION_2 */
		for (i = 0; i < 30/2; i++) {
			/* From the USB Audio spec v2.0:
			   bmaControls() is a (ch+1)-element array of 4-byte bitmaps,
			   each containing a set of bit pairs. If a Control is present,
			   it must be Host readable. If a certain Control is not
			   present then the bit pair must be set to 0b00.
			   If a Control is present but read-only, the bit pair must be
			   set to 0b01. If a Control is also Host programmable, the bit
			   pair must be set to 0b11. The value 0b10 is not allowed. */
			unsigned int ch_bits = 0;
			unsigned int ch_read_only = 0;

			for (j = 0; j < channels; j++) {
				unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1206
				if (uac2_control_is_readable(mask, i)) {
1207
					ch_bits |= (1 << j);
1208
					if (!uac2_control_is_writeable(mask, i))
1209 1210 1211 1212
						ch_read_only |= (1 << j);
				}
			}

1213 1214 1215 1216
			/* 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 */
1217
			if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1218
				build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, ch_read_only);
1219
			if (uac2_control_is_readable(master_bits, i))
1220
				build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1221
						  !uac2_control_is_writeable(master_bits, i));
L
Linus Torvalds 已提交
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
		}
	}

	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.
 */

1240 1241
static void build_mixer_unit_ctl(struct mixer_build *state,
				 struct uac_mixer_unit_descriptor *desc,
L
Linus Torvalds 已提交
1242
				 int in_pin, int in_ch, int unitid,
1243
				 struct usb_audio_term *iterm)
L
Linus Torvalds 已提交
1244
{
1245
	struct usb_mixer_elem_info *cval;
1246
	unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
L
Linus Torvalds 已提交
1247
	unsigned int i, len;
1248
	struct snd_kcontrol *kctl;
1249
	const struct usbmix_name_map *map;
L
Linus Torvalds 已提交
1250

1251 1252
	map = find_map(state, unitid, 0);
	if (check_ignored_ctl(map))
L
Linus Torvalds 已提交
1253 1254
		return;

1255
	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
L
Linus Torvalds 已提交
1256 1257 1258
	if (! cval)
		return;

1259
	cval->mixer = state->mixer;
L
Linus Torvalds 已提交
1260 1261 1262 1263
	cval->id = unitid;
	cval->control = in_ch + 1; /* based on 1 */
	cval->val_type = USB_MIXER_S16;
	for (i = 0; i < num_outs; i++) {
1264
		if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), in_ch, i, num_outs)) {
L
Linus Torvalds 已提交
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
			cval->cmask |= (1 << i);
			cval->channels++;
		}
	}

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

	kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
	if (! kctl) {
		snd_printk(KERN_ERR "cannot malloc kcontrol\n");
		kfree(cval);
		return;
	}
	kctl->private_free = usb_mixer_elem_free;

1281
	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
L
Linus Torvalds 已提交
1282 1283 1284 1285
	if (! len)
		len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
	if (! len)
		len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
T
Takashi Iwai 已提交
1286
	append_ctl_name(kctl, " Volume");
L
Linus Torvalds 已提交
1287 1288 1289

	snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
		    cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1290
	add_control_to_empty(state, kctl);
L
Linus Torvalds 已提交
1291 1292 1293 1294 1295 1296
}


/*
 * parse a mixer unit
 */
1297
static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, void *raw_desc)
L
Linus Torvalds 已提交
1298
{
1299
	struct uac_mixer_unit_descriptor *desc = raw_desc;
1300
	struct usb_audio_term iterm;
L
Linus Torvalds 已提交
1301 1302 1303
	int input_pins, num_ins, num_outs;
	int pin, ich, err;

1304
	if (desc->bLength < 11 || ! (input_pins = desc->bNrInPins) || ! (num_outs = uac_mixer_unit_bNrChannels(desc))) {
L
Linus Torvalds 已提交
1305 1306 1307 1308
		snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
		return -EINVAL;
	}
	/* no bmControls field (e.g. Maya44) -> ignore */
1309
	if (desc->bLength <= 10 + input_pins) {
L
Linus Torvalds 已提交
1310 1311 1312 1313 1314 1315 1316
		snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
		return 0;
	}

	num_ins = 0;
	ich = 0;
	for (pin = 0; pin < input_pins; pin++) {
1317
		err = parse_audio_unit(state, desc->baSourceID[pin]);
L
Linus Torvalds 已提交
1318 1319
		if (err < 0)
			return err;
1320
		err = check_input_term(state, desc->baSourceID[pin], &iterm);
L
Linus Torvalds 已提交
1321 1322 1323 1324 1325 1326 1327
		if (err < 0)
			return err;
		num_ins += iterm.channels;
		for (; ich < num_ins; ++ich) {
			int och, ich_has_controls = 0;

			for (och = 0; och < num_outs; ++och) {
1328
				if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol),
L
Linus Torvalds 已提交
1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347
							ich, och, num_outs)) {
					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 */
1348
static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
1349
{
1350
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1351 1352 1353
	int err, val;

	err = get_cur_ctl_value(cval, cval->control << 8, &val);
1354
	if (err < 0 && cval->mixer->ignore_ctl_error) {
L
Linus Torvalds 已提交
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365
		ucontrol->value.integer.value[0] = cval->min;
		return 0;
	}
	if (err < 0)
		return err;
	val = get_relative_value(cval, val);
	ucontrol->value.integer.value[0] = val;
	return 0;
}

/* put callback for processing/extension unit */
1366
static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
1367
{
1368
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1369 1370 1371 1372
	int val, oval, err;

	err = get_cur_ctl_value(cval, cval->control << 8, &oval);
	if (err < 0) {
1373
		if (cval->mixer->ignore_ctl_error)
L
Linus Torvalds 已提交
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
			return 0;
		return err;
	}
	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 */
1387
static struct snd_kcontrol_new mixer_procunit_ctl = {
L
Linus Torvalds 已提交
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459
	.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[] = {
	{ USB_PROC_UPDOWN_SWITCH, "Switch", USB_MIXER_BOOLEAN },
	{ USB_PROC_UPDOWN_MODE_SEL, "Mode Select", USB_MIXER_U8, 1 },
	{ 0 }
};
static struct procunit_value_info prologic_proc_info[] = {
	{ USB_PROC_PROLOGIC_SWITCH, "Switch", USB_MIXER_BOOLEAN },
	{ USB_PROC_PROLOGIC_MODE_SEL, "Mode Select", USB_MIXER_U8, 1 },
	{ 0 }
};
static struct procunit_value_info threed_enh_proc_info[] = {
	{ USB_PROC_3DENH_SWITCH, "Switch", USB_MIXER_BOOLEAN },
	{ USB_PROC_3DENH_SPACE, "Spaciousness", USB_MIXER_U8 },
	{ 0 }
};
static struct procunit_value_info reverb_proc_info[] = {
	{ USB_PROC_REVERB_SWITCH, "Switch", USB_MIXER_BOOLEAN },
	{ USB_PROC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
	{ USB_PROC_REVERB_TIME, "Time", USB_MIXER_U16 },
	{ USB_PROC_REVERB_DELAY, "Delay", USB_MIXER_U8 },
	{ 0 }
};
static struct procunit_value_info chorus_proc_info[] = {
	{ USB_PROC_CHORUS_SWITCH, "Switch", USB_MIXER_BOOLEAN },
	{ USB_PROC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
	{ USB_PROC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
	{ USB_PROC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
	{ 0 }
};
static struct procunit_value_info dcr_proc_info[] = {
	{ USB_PROC_DCR_SWITCH, "Switch", USB_MIXER_BOOLEAN },
	{ USB_PROC_DCR_RATIO, "Ratio", USB_MIXER_U16 },
	{ USB_PROC_DCR_MAX_AMP, "Max Amp", USB_MIXER_S16 },
	{ USB_PROC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
	{ USB_PROC_DCR_ATTACK, "Attack Time", USB_MIXER_U16 },
	{ USB_PROC_DCR_RELEASE, "Release Time", USB_MIXER_U16 },
	{ 0 }
};

static struct procunit_info procunits[] = {
	{ USB_PROC_UPDOWN, "Up Down", updown_proc_info },
	{ USB_PROC_PROLOGIC, "Dolby Prologic", prologic_proc_info },
	{ USB_PROC_3DENH, "3D Stereo Extender", threed_enh_proc_info },
	{ USB_PROC_REVERB, "Reverb", reverb_proc_info },
	{ USB_PROC_CHORUS, "Chorus", chorus_proc_info },
	{ USB_PROC_DCR, "DCR", dcr_proc_info },
	{ 0 },
};
1460 1461 1462 1463
/*
 * predefined data for extension units
 */
static struct procunit_value_info clock_rate_xu_info[] = {
1464 1465
	{ USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
	{ 0 }
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
};
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 }
};
L
Linus Torvalds 已提交
1486 1487 1488
/*
 * build a processing/extension unit
 */
1489
static int build_audio_procunit(struct mixer_build *state, int unitid, void *raw_desc, struct procunit_info *list, char *name)
L
Linus Torvalds 已提交
1490
{
1491 1492
	struct uac_processing_unit_descriptor *desc = raw_desc;
	int num_ins = desc->bNrInPins;
1493 1494
	struct usb_mixer_elem_info *cval;
	struct snd_kcontrol *kctl;
L
Linus Torvalds 已提交
1495 1496 1497
	int i, err, nameid, type, len;
	struct procunit_info *info;
	struct procunit_value_info *valinfo;
1498
	const struct usbmix_name_map *map;
L
Linus Torvalds 已提交
1499 1500 1501 1502 1503 1504 1505 1506
	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
	};

1507 1508
	if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
	    desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
L
Linus Torvalds 已提交
1509 1510 1511 1512 1513
		snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
		return -EINVAL;
	}

	for (i = 0; i < num_ins; i++) {
1514
		if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
L
Linus Torvalds 已提交
1515 1516 1517
			return err;
	}

1518
	type = le16_to_cpu(desc->wProcessType);
L
Linus Torvalds 已提交
1519 1520 1521 1522 1523 1524 1525
	for (info = list; info && info->type; info++)
		if (info->type == type)
			break;
	if (! info || ! info->type)
		info = &default_info;

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

		if (! (controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
L
Linus Torvalds 已提交
1529
			continue;
1530 1531
		map = find_map(state, unitid, valinfo->control);
		if (check_ignored_ctl(map))
L
Linus Torvalds 已提交
1532
			continue;
1533
		cval = kzalloc(sizeof(*cval), GFP_KERNEL);
L
Linus Torvalds 已提交
1534 1535 1536 1537
		if (! cval) {
			snd_printk(KERN_ERR "cannot malloc kcontrol\n");
			return -ENOMEM;
		}
1538
		cval->mixer = state->mixer;
L
Linus Torvalds 已提交
1539 1540 1541 1542 1543 1544 1545
		cval->id = unitid;
		cval->control = valinfo->control;
		cval->val_type = valinfo->val_type;
		cval->channels = 1;

		/* get min/max values */
		if (type == USB_PROC_UPDOWN && cval->control == USB_PROC_UPDOWN_MODE_SEL) {
1546
			__u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
L
Linus Torvalds 已提交
1547 1548
			/* FIXME: hard-coded */
			cval->min = 1;
1549
			cval->max = control_spec[0];
L
Linus Torvalds 已提交
1550 1551
			cval->res = 1;
			cval->initialized = 1;
1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
		} else {
			if (type == USB_XU_CLOCK_RATE) {
				/* E-Mu USB 0404/0202/TrackerPre
				 * 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 已提交
1564 1565 1566 1567 1568 1569 1570 1571 1572

		kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
		if (! kctl) {
			snd_printk(KERN_ERR "cannot malloc kcontrol\n");
			kfree(cval);
			return -ENOMEM;
		}
		kctl->private_free = usb_mixer_elem_free;

1573 1574 1575
		if (check_mapped_name(map, kctl->id.name,
						sizeof(kctl->id.name)))
			/* nothing */ ;
L
Linus Torvalds 已提交
1576 1577 1578
		else if (info->name)
			strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
		else {
1579
			nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
L
Linus Torvalds 已提交
1580 1581 1582 1583 1584 1585
			len = 0;
			if (nameid)
				len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
			if (! len)
				strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
		}
T
Takashi Iwai 已提交
1586 1587
		append_ctl_name(kctl, " ");
		append_ctl_name(kctl, valinfo->suffix);
L
Linus Torvalds 已提交
1588 1589 1590

		snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
			    cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1591
		if ((err = add_control_to_empty(state, kctl)) < 0)
L
Linus Torvalds 已提交
1592 1593 1594 1595 1596 1597
			return err;
	}
	return 0;
}


1598
static int parse_audio_processing_unit(struct mixer_build *state, int unitid, void *raw_desc)
L
Linus Torvalds 已提交
1599
{
1600
	return build_audio_procunit(state, unitid, raw_desc, procunits, "Processing Unit");
L
Linus Torvalds 已提交
1601 1602
}

1603
static int parse_audio_extension_unit(struct mixer_build *state, int unitid, void *raw_desc)
L
Linus Torvalds 已提交
1604
{
1605 1606 1607
	/* 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 已提交
1608 1609 1610 1611 1612 1613 1614 1615 1616 1617
}


/*
 * Selector Unit
 */

/* info callback for selector unit
 * use an enumerator type for routing
 */
1618
static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
L
Linus Torvalds 已提交
1619
{
1620
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1621 1622
	char **itemlist = (char **)kcontrol->private_value;

1623 1624
	if (snd_BUG_ON(!itemlist))
		return -EINVAL;
L
Linus Torvalds 已提交
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
	uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
	uinfo->count = 1;
	uinfo->value.enumerated.items = cval->max;
	if ((int)uinfo->value.enumerated.item >= cval->max)
		uinfo->value.enumerated.item = cval->max - 1;
	strcpy(uinfo->value.enumerated.name, itemlist[uinfo->value.enumerated.item]);
	return 0;
}

/* get callback for selector unit */
1635
static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
1636
{
1637
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1638 1639 1640 1641
	int val, err;

	err = get_cur_ctl_value(cval, 0, &val);
	if (err < 0) {
1642
		if (cval->mixer->ignore_ctl_error) {
L
Linus Torvalds 已提交
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653
			ucontrol->value.enumerated.item[0] = 0;
			return 0;
		}
		return err;
	}
	val = get_relative_value(cval, val);
	ucontrol->value.enumerated.item[0] = val;
	return 0;
}

/* put callback for selector unit */
1654
static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
1655
{
1656
	struct usb_mixer_elem_info *cval = kcontrol->private_data;
L
Linus Torvalds 已提交
1657 1658 1659 1660
	int val, oval, err;

	err = get_cur_ctl_value(cval, 0, &oval);
	if (err < 0) {
1661
		if (cval->mixer->ignore_ctl_error)
L
Linus Torvalds 已提交
1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674
			return 0;
		return err;
	}
	val = ucontrol->value.enumerated.item[0];
	val = get_abs_value(cval, val);
	if (val != oval) {
		set_cur_ctl_value(cval, 0, val);
		return 1;
	}
	return 0;
}

/* alsa control interface for selector unit */
1675
static struct snd_kcontrol_new mixer_selectunit_ctl = {
L
Linus Torvalds 已提交
1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
	.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,
};


/* private free callback.
 * free both private_data and private_value
 */
1687
static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
L
Linus Torvalds 已提交
1688 1689 1690 1691
{
	int i, num_ins = 0;

	if (kctl->private_data) {
1692
		struct usb_mixer_elem_info *cval = kctl->private_data;
L
Linus Torvalds 已提交
1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708
		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
 */
1709
static int parse_audio_selector_unit(struct mixer_build *state, int unitid, void *raw_desc)
L
Linus Torvalds 已提交
1710
{
1711
	struct uac_selector_unit_descriptor *desc = raw_desc;
L
Linus Torvalds 已提交
1712 1713
	unsigned int i, nameid, len;
	int err;
1714 1715
	struct usb_mixer_elem_info *cval;
	struct snd_kcontrol *kctl;
1716
	const struct usbmix_name_map *map;
L
Linus Torvalds 已提交
1717 1718
	char **namelist;

1719
	if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
L
Linus Torvalds 已提交
1720 1721 1722 1723
		snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
		return -EINVAL;
	}

1724 1725
	for (i = 0; i < desc->bNrInPins; i++) {
		if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
L
Linus Torvalds 已提交
1726 1727 1728
			return err;
	}

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

1732 1733
	map = find_map(state, unitid, 0);
	if (check_ignored_ctl(map))
L
Linus Torvalds 已提交
1734 1735
		return 0;

1736
	cval = kzalloc(sizeof(*cval), GFP_KERNEL);
L
Linus Torvalds 已提交
1737 1738 1739 1740
	if (! cval) {
		snd_printk(KERN_ERR "cannot malloc kcontrol\n");
		return -ENOMEM;
	}
1741
	cval->mixer = state->mixer;
L
Linus Torvalds 已提交
1742 1743 1744 1745
	cval->id = unitid;
	cval->val_type = USB_MIXER_U8;
	cval->channels = 1;
	cval->min = 1;
1746
	cval->max = desc->bNrInPins;
L
Linus Torvalds 已提交
1747 1748 1749
	cval->res = 1;
	cval->initialized = 1;

1750
	namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
L
Linus Torvalds 已提交
1751 1752 1753 1754 1755 1756
	if (! namelist) {
		snd_printk(KERN_ERR "cannot malloc\n");
		kfree(cval);
		return -ENOMEM;
	}
#define MAX_ITEM_NAME_LEN	64
1757
	for (i = 0; i < desc->bNrInPins; i++) {
1758
		struct usb_audio_term iterm;
L
Linus Torvalds 已提交
1759 1760 1761 1762
		len = 0;
		namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
		if (! namelist[i]) {
			snd_printk(KERN_ERR "cannot malloc\n");
1763
			while (i--)
L
Linus Torvalds 已提交
1764 1765 1766 1767 1768
				kfree(namelist[i]);
			kfree(namelist);
			kfree(cval);
			return -ENOMEM;
		}
1769 1770
		len = check_mapped_selector_name(state, unitid, i, namelist[i],
						 MAX_ITEM_NAME_LEN);
1771
		if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
L
Linus Torvalds 已提交
1772 1773 1774 1775 1776 1777 1778 1779
			len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
		if (! len)
			sprintf(namelist[i], "Input %d", i);
	}

	kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
	if (! kctl) {
		snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1780
		kfree(namelist);
L
Linus Torvalds 已提交
1781 1782 1783 1784 1785 1786
		kfree(cval);
		return -ENOMEM;
	}
	kctl->private_value = (unsigned long)namelist;
	kctl->private_free = usb_mixer_selector_elem_free;

1787
	nameid = uac_selector_unit_iSelector(desc);
1788
	len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
L
Linus Torvalds 已提交
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799
	if (len)
		;
	else if (nameid)
		snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
	else {
		len = get_term_name(state, &state->oterm,
				    kctl->id.name, sizeof(kctl->id.name), 0);
		if (! len)
			strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));

		if ((state->oterm.type & 0xff00) == 0x0100)
T
Takashi Iwai 已提交
1800
			append_ctl_name(kctl, " Capture Source");
L
Linus Torvalds 已提交
1801
		else
T
Takashi Iwai 已提交
1802
			append_ctl_name(kctl, " Playback Source");
L
Linus Torvalds 已提交
1803 1804 1805
	}

	snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
1806
		    cval->id, kctl->id.name, desc->bNrInPins);
1807
	if ((err = add_control_to_empty(state, kctl)) < 0)
L
Linus Torvalds 已提交
1808 1809 1810 1811 1812 1813 1814 1815 1816 1817
		return err;

	return 0;
}


/*
 * parse an audio unit recursively
 */

1818
static int parse_audio_unit(struct mixer_build *state, int unitid)
L
Linus Torvalds 已提交
1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831
{
	unsigned char *p1;

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

	p1 = find_audio_control_unit(state, unitid);
	if (!p1) {
		snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
		return -EINVAL;
	}

	switch (p1[2]) {
1832
	case UAC_INPUT_TERMINAL:
L
Linus Torvalds 已提交
1833
		return 0; /* NOP */
1834
	case UAC_MIXER_UNIT:
L
Linus Torvalds 已提交
1835
		return parse_audio_mixer_unit(state, unitid, p1);
1836
	case UAC_SELECTOR_UNIT:
L
Linus Torvalds 已提交
1837
		return parse_audio_selector_unit(state, unitid, p1);
1838
	case UAC_FEATURE_UNIT:
L
Linus Torvalds 已提交
1839
		return parse_audio_feature_unit(state, unitid, p1);
1840
	case UAC_PROCESSING_UNIT_V1:
1841 1842 1843 1844 1845
	/*   UAC2_EFFECT_UNIT has the same value */
		if (state->mixer->protocol == UAC_VERSION_1)
			return parse_audio_processing_unit(state, unitid, p1);
		else
			return 0; /* FIXME - effect units not implemented yet */
1846
	case UAC_EXTENSION_UNIT_V1:
1847 1848 1849 1850 1851
	/*   UAC2_PROCESSING_UNIT_V2 has the same value */
		if (state->mixer->protocol == UAC_VERSION_1)
			return parse_audio_extension_unit(state, unitid, p1);
		else /* UAC_VERSION_2 */
			return parse_audio_processing_unit(state, unitid, p1);
L
Linus Torvalds 已提交
1852 1853 1854 1855 1856 1857
	default:
		snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
		return -EINVAL;
	}
}

1858 1859
static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
{
1860 1861 1862 1863 1864
	kfree(mixer->id_elems);
	if (mixer->urb) {
		kfree(mixer->urb->transfer_buffer);
		usb_free_urb(mixer->urb);
	}
1865
	usb_free_urb(mixer->rc_urb);
1866
	kfree(mixer->rc_setup_packet);
1867 1868 1869
	kfree(mixer);
}

1870
static int snd_usb_mixer_dev_free(struct snd_device *device)
1871 1872 1873 1874 1875 1876
{
	struct usb_mixer_interface *mixer = device->device_data;
	snd_usb_mixer_free(mixer);
	return 0;
}

L
Linus Torvalds 已提交
1877 1878 1879
/*
 * create mixer controls
 *
1880
 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
L
Linus Torvalds 已提交
1881
 */
1882
static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
L
Linus Torvalds 已提交
1883
{
1884
	struct mixer_build state;
L
Linus Torvalds 已提交
1885 1886
	int err;
	const struct usbmix_ctl_map *map;
1887
	struct usb_host_interface *hostif;
1888
	void *p;
L
Linus Torvalds 已提交
1889

1890
	hostif = &usb_ifnum_to_if(mixer->chip->dev, mixer->ctrlif)->altsetting[0];
L
Linus Torvalds 已提交
1891
	memset(&state, 0, sizeof(state));
1892 1893
	state.chip = mixer->chip;
	state.mixer = mixer;
L
Linus Torvalds 已提交
1894 1895 1896 1897
	state.buffer = hostif->extra;
	state.buflen = hostif->extralen;

	/* check the mapping table */
1898 1899
	for (map = usbmix_ctl_maps; map->id; map++) {
		if (map->id == state.chip->usb_id) {
L
Linus Torvalds 已提交
1900
			state.map = map->map;
1901
			state.selector_map = map->selector_map;
1902
			mixer->ignore_ctl_error = map->ignore_ctl_error;
L
Linus Torvalds 已提交
1903 1904 1905 1906
			break;
		}
	}

1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933
	p = NULL;
	while ((p = snd_usb_find_csint_desc(hostif->extra, hostif->extralen, p, UAC_OUTPUT_TERMINAL)) != NULL) {
		if (mixer->protocol == UAC_VERSION_1) {
			struct uac_output_terminal_descriptor_v1 *desc = p;

			if (desc->bLength < sizeof(*desc))
				continue; /* invalid descriptor? */
			set_bit(desc->bTerminalID, state.unitbitmap);  /* mark terminal ID as visited */
			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);
			if (err < 0)
				return err;
		} else { /* UAC_VERSION_2 */
			struct uac2_output_terminal_descriptor *desc = p;

			if (desc->bLength < sizeof(*desc))
				continue; /* invalid descriptor? */
			set_bit(desc->bTerminalID, state.unitbitmap);  /* mark terminal ID as visited */
			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);
			if (err < 0)
				return err;
		}
L
Linus Torvalds 已提交
1934
	}
1935

L
Linus Torvalds 已提交
1936 1937
	return 0;
}
1938

D
Daniel Mack 已提交
1939
void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
1940
{
1941
	struct usb_mixer_elem_info *info;
1942 1943 1944 1945 1946 1947

	for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
		snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
			       info->elem_id);
}

1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975
static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
				    int unitid,
				    struct usb_mixer_elem_info *cval)
{
	static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
				    "S8", "U8", "S16", "U16"};
	snd_iprintf(buffer, "  Unit: %i\n", unitid);
	if (cval->elem_id)
		snd_iprintf(buffer, "    Control: name=\"%s\", index=%i\n",
				cval->elem_id->name, cval->elem_id->index);
	snd_iprintf(buffer, "    Info: id=%i, control=%i, cmask=0x%x, "
			    "channels=%i, type=\"%s\"\n", cval->id,
			    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;
	struct usb_mixer_elem_info *cval;
	int unitid;

	list_for_each_entry(mixer, &chip->mixer_list, list) {
		snd_iprintf(buffer,
1976 1977 1978
			"USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
				chip->usb_id, mixer->ctrlif,
				mixer->ignore_ctl_error);
1979 1980 1981 1982 1983 1984 1985 1986 1987
		snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
		for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
			for (cval = mixer->id_elems[unitid]; cval;
						cval = cval->next_id_elem)
				snd_usb_mixer_dump_cval(buffer, unitid, cval);
		}
	}
}

1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034
static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
				       int attribute, int value, int index)
{
	struct usb_mixer_elem_info *info;
	__u8 unitid = (index >> 8) & 0xff;
	__u8 control = (value >> 8) & 0xff;
	__u8 channel = value & 0xff;

	if (channel >= MAX_CHANNELS) {
		snd_printk(KERN_DEBUG "%s(): bogus channel number %d\n",
				__func__, channel);
		return;
	}

	for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) {
		if (info->control != control)
			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,
					info->elem_id);
			break;

		case UAC2_CS_RANGE:
			/* TODO */
			break;

		case UAC2_CS_MEM:
			/* TODO */
			break;

		default:
			snd_printk(KERN_DEBUG "unknown attribute %d in interrupt\n",
						attribute);
			break;
		} /* switch */
	}
}

static void snd_usb_mixer_interrupt(struct urb *urb)
2035 2036
{
	struct usb_mixer_interface *mixer = urb->context;
2037 2038 2039 2040
	int len = urb->actual_length;

	if (urb->status != 0)
		goto requeue;
2041

2042 2043
	if (mixer->protocol == UAC_VERSION_1) {
		struct uac1_status_word *status;
2044

2045 2046 2047
		for (status = urb->transfer_buffer;
		     len >= sizeof(*status);
		     len -= sizeof(*status), status++) {
2048
			snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
2049 2050 2051
						status->bStatusType,
						status->bOriginator);

2052
			/* ignore any notifications not from the control interface */
2053 2054
			if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
				UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2055
				continue;
2056 2057 2058

			if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
				snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2059
			else
2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075
				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));
2076 2077
		}
	}
2078 2079

requeue:
2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099
	if (urb->status != -ENOENT && urb->status != -ECONNRESET) {
		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_host_interface *hostif;
	struct usb_endpoint_descriptor *ep;
	void *transfer_buffer;
	int buffer_length;
	unsigned int epnum;

	hostif = &usb_ifnum_to_if(mixer->chip->dev, mixer->ctrlif)->altsetting[0];
	/* we need one interrupt input endpoint */
	if (get_iface_desc(hostif)->bNumEndpoints < 1)
		return 0;
	ep = get_endpoint(hostif, 0);
2100
	if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2101 2102
		return 0;

2103
	epnum = usb_endpoint_num(ep);
2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115
	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,
2116
			 snd_usb_mixer_interrupt, mixer, ep->bInterval);
2117 2118 2119 2120
	usb_submit_urb(mixer->urb, GFP_KERNEL);
	return 0;
}

2121 2122
int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
			 int ignore_error)
2123
{
2124
	static struct snd_device_ops dev_ops = {
2125 2126 2127
		.dev_free = snd_usb_mixer_dev_free
	};
	struct usb_mixer_interface *mixer;
2128
	struct snd_info_entry *entry;
2129
	struct usb_host_interface *host_iface;
2130
	int err;
2131 2132 2133

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

2134
	mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2135 2136 2137 2138
	if (!mixer)
		return -ENOMEM;
	mixer->chip = chip;
	mixer->ctrlif = ctrlif;
2139
	mixer->ignore_ctl_error = ignore_error;
2140 2141
	mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
				  GFP_KERNEL);
2142 2143 2144 2145
	if (!mixer->id_elems) {
		kfree(mixer);
		return -ENOMEM;
	}
2146

2147
	host_iface = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2148
	mixer->protocol = get_iface_desc(host_iface)->bInterfaceProtocol;
2149

2150
	if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2151 2152
	    (err = snd_usb_mixer_status_create(mixer)) < 0)
		goto _error;
2153

D
Daniel Mack 已提交
2154
	snd_usb_mixer_apply_create_quirk(mixer);
2155

2156
	err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
2157 2158
	if (err < 0)
		goto _error;
2159 2160 2161 2162 2163

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

2164 2165
	list_add(&mixer->list, &chip->mixer_list);
	return 0;
2166 2167 2168 2169

_error:
	snd_usb_mixer_free(mixer);
	return err;
2170 2171 2172 2173
}

void snd_usb_mixer_disconnect(struct list_head *p)
{
2174
	struct usb_mixer_interface *mixer;
D
Daniel Mack 已提交
2175

2176
	mixer = list_entry(p, struct usb_mixer_interface, list);
2177 2178
	usb_kill_urb(mixer->urb);
	usb_kill_urb(mixer->rc_urb);
2179
}