usbmixer.c 39.5 KB
Newer Older
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 35 36 37 38 39 40 41 42 43 44
/*
 *   (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 <sound/driver.h>
#include <linux/bitops.h>
#include <linux/init.h>
#include <linux/list.h>
#include <linux/slab.h>
#include <linux/string.h>
#include <linux/usb.h>
#include <sound/core.h>
#include <sound/control.h>

#include "usbaudio.h"


/*
 */

Jaroslav Kysela's avatar
Jaroslav Kysela committed
45 46 47
/* ignore error from controls - for debugging */
/* #define IGNORE_CTL_ERROR */

48 49 50 51 52 53 54 55 56 57 58 59 60
typedef struct usb_mixer_build mixer_build_t;
typedef struct usb_audio_term usb_audio_term_t;
typedef struct usb_mixer_elem_info usb_mixer_elem_info_t;


struct usb_audio_term {
	int id;
	int type;
	int channels;
	unsigned int chconfig;
	int name;
};

Jaroslav Kysela's avatar
Jaroslav Kysela committed
61 62
struct usbmix_name_map;

63 64 65 66 67
struct usb_mixer_build {
	snd_usb_audio_t *chip;
	unsigned char *buffer;
	unsigned int buflen;
	unsigned int ctrlif;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
68 69
	unsigned short vendor;
	unsigned short product;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
70
	DECLARE_BITMAP(unitbitmap, 32*32);
71
	usb_audio_term_t oterm;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
72
	const struct usbmix_name_map *map;
73 74 75 76 77 78
};

struct usb_mixer_elem_info {
	snd_usb_audio_t *chip;
	unsigned int ctrlif;
	unsigned int id;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
79
	unsigned int control;	/* CS or ICN (high byte) */
80 81 82
	unsigned int cmask; /* channel mask bitmap: 0 = master */ 
	int channels;
	int val_type;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
83
	int min, max, res;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
84
	unsigned int initialized: 1;
85 86 87 88
};


enum {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
89 90
	USB_FEATURE_NONE = 0,
	USB_FEATURE_MUTE = 1,
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
	USB_FEATURE_VOLUME,
	USB_FEATURE_BASS,
	USB_FEATURE_MID,
	USB_FEATURE_TREBLE,
	USB_FEATURE_GEQ,
	USB_FEATURE_AGC,
	USB_FEATURE_DELAY,
	USB_FEATURE_BASSBOOST,
	FSB_FEATURE_LOUDNESS
};

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

Jaroslav Kysela's avatar
Jaroslav Kysela committed
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
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,
};

145 146 147
#define MAX_CHANNELS	10	/* max logical channels */


Jaroslav Kysela's avatar
Jaroslav Kysela committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
/*
 * 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.
 */
#include "usbmixer_maps.c"

/* get the mapped name if the unit matches */
static int check_mapped_name(mixer_build_t *state, int unitid, int control, char *buf, int buflen)
{
	const struct usbmix_name_map *p;

	if (! state->map)
		return 0;

	for (p = state->map; p->id; p++) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
164
		if (p->id == unitid && p->name &&
Jaroslav Kysela's avatar
Jaroslav Kysela committed
165 166
		    (! control || ! p->control || control == p->control)) {
			buflen--;
167
			return strlcpy(buf, p->name, buflen);
Jaroslav Kysela's avatar
Jaroslav Kysela committed
168 169 170 171 172
		}
	}
	return 0;
}

Jaroslav Kysela's avatar
Jaroslav Kysela committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
/* check whether the control should be ignored */
static int check_ignored_ctl(mixer_build_t *state, int unitid, int control)
{
	const struct usbmix_name_map *p;

	if (! state->map)
		return 0;
	for (p = state->map; p->id; p++) {
		if (p->id == unitid && ! p->name &&
		    (! control || ! p->control || control == p->control)) {
			// printk("ignored control %d:%d\n", unitid, control);
			return 1;
		}
	}
	return 0;
}
Jaroslav Kysela's avatar
Jaroslav Kysela committed
189

190 191 192 193 194 195 196 197 198
/*
 * find an audio control unit with the given unit id
 */
static void *find_audio_control_unit(mixer_build_t *state, unsigned char unit)
{
	unsigned char *p;

	p = NULL;
	while ((p = snd_usb_find_desc(state->buffer, state->buflen, p,
Jaroslav Kysela's avatar
Jaroslav Kysela committed
199
				      USB_DT_CS_INTERFACE)) != NULL) {
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
		if (p[0] >= 4 && p[2] >= INPUT_TERMINAL && p[2] <= EXTENSION_UNIT && p[3] == unit)
			return p;
	}
	return NULL;
}


/*
 * copy a string with the given id
 */
static int snd_usb_copy_string_desc(mixer_build_t *state, int index, char *buf, int maxlen)
{
	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
 */
static int convert_signed_value(usb_mixer_elem_info_t *cval, int val)
{
	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
 */
static int convert_bytes_value(usb_mixer_elem_info_t *cval, int val)
{
	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 */
}

static int get_relative_value(usb_mixer_elem_info_t *cval, int val)
{
Jaroslav Kysela's avatar
Jaroslav Kysela committed
269 270
	if (! cval->res)
		cval->res = 1;
271 272 273
	if (val < cval->min)
		return 0;
	else if (val > cval->max)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
274
		return (cval->max - cval->min) / cval->res;
275
	else
Jaroslav Kysela's avatar
Jaroslav Kysela committed
276
		return (val - cval->min) / cval->res;
277 278 279 280 281 282
}

static int get_abs_value(usb_mixer_elem_info_t *cval, int val)
{
	if (val < 0)
		return cval->min;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
283 284
	if (! cval->res)
		cval->res = 1;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
285
	val *= cval->res;
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
	val += cval->min;
	if (val > cval->max)
		return cval->max;
	return val;
}


/*
 * retrieve a mixer value
 */

static int get_ctl_value(usb_mixer_elem_info_t *cval, int request, int validx, int *value_ret)
{
	unsigned char buf[2];
	int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
301
	int timeout = 10;
302
 
Jaroslav Kysela's avatar
Jaroslav Kysela committed
303 304 305 306 307 308 309 310 311
	while (timeout-- > 0) {
		if (usb_control_msg(cval->chip->dev, usb_rcvctrlpipe(cval->chip->dev, 0),
				    request,
				    USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
				    validx, cval->ctrlif | (cval->id << 8),
				    buf, val_len, HZ / 10) >= 0) {
			*value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
			return 0;
		}
Jaroslav Kysela's avatar
Jaroslav Kysela committed
312
	}
Jaroslav Kysela's avatar
Jaroslav Kysela committed
313
	snd_printdd(KERN_ERR "cannot get ctl value: req = 0x%x, wValue = 0x%x, wIndex = 0x%x, type = %d\n", request, validx, cval->ctrlif | (cval->id << 8), cval->val_type);
Jaroslav Kysela's avatar
Jaroslav Kysela committed
314
	return -EINVAL;
315 316 317 318 319 320 321 322 323 324
}

static int get_cur_ctl_value(usb_mixer_elem_info_t *cval, int validx, int *value)
{
	return get_ctl_value(cval, GET_CUR, validx, value);
}

/* channel = 0: master, 1 = first channel */
inline static int get_cur_mix_value(usb_mixer_elem_info_t *cval, int channel, int *value)
{
Jaroslav Kysela's avatar
Jaroslav Kysela committed
325
	return get_ctl_value(cval, GET_CUR, (cval->control << 8) | channel, value);
326 327 328 329 330 331 332 333 334 335
}

/*
 * set a mixer value
 */

static int set_ctl_value(usb_mixer_elem_info_t *cval, int request, int validx, int value_set)
{
	unsigned char buf[2];
	int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
336
	int timeout = 10;
337 338 339 340
 
	value_set = convert_bytes_value(cval, value_set);
	buf[0] = value_set & 0xff;
	buf[1] = (value_set >> 8) & 0xff;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
341 342 343 344 345 346 347
	while (timeout -- > 0)
		if (usb_control_msg(cval->chip->dev, usb_sndctrlpipe(cval->chip->dev, 0),
				    request,
				    USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
				    validx, cval->ctrlif | (cval->id << 8),
				    buf, val_len, HZ / 10) >= 0)
			return 0;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
348
	snd_printdd(KERN_ERR "cannot set ctl value: req = 0x%x, wValue = 0x%x, wIndex = 0x%x, type = %d, data = 0x%x/0x%x\n", request, validx, cval->ctrlif | (cval->id << 8), cval->val_type, buf[0], buf[1]);
Jaroslav Kysela's avatar
Jaroslav Kysela committed
349
	return -EINVAL;
350 351 352 353 354 355 356 357 358
}

static int set_cur_ctl_value(usb_mixer_elem_info_t *cval, int validx, int value)
{
	return set_ctl_value(cval, SET_CUR, validx, value);
}

inline static int set_cur_mix_value(usb_mixer_elem_info_t *cval, int channel, int value)
{
Jaroslav Kysela's avatar
Jaroslav Kysela committed
359
	return set_ctl_value(cval, SET_CUR, (cval->control << 8) | channel, value);
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
}


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

static int parse_audio_unit(mixer_build_t *state, int unitid);


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

static int add_control_to_empty(snd_card_t *card, snd_kcontrol_t *kctl)
{
	int err;
	while (snd_ctl_find_id(card, &kctl->id))
		kctl->id.index++;
	if ((err = snd_ctl_add(card, kctl)) < 0) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
394
		snd_printd(KERN_ERR "cannot add control (err = %d)\n", err);
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 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
		snd_ctl_free_one(kctl);
	}
	return err;
}


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

static int get_term_name(mixer_build_t *state, usb_audio_term_t *iterm,
			 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) {
		case SELECTOR_UNIT:
			strcpy(name, "Selector"); return 8;
		case PROCESSING_UNIT:
			strcpy(name, "Process Unit"); return 12;
		case EXTENSION_UNIT:
			strcpy(name, "Ext Unit"); return 8;
		case MIXER_UNIT:
			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.
 */
static int check_input_term(mixer_build_t *state, int id, usb_audio_term_t *term)
{
	unsigned char *p1;

	memset(term, 0, sizeof(*term));
	while ((p1 = find_audio_control_unit(state, id)) != NULL) {
		term->id = id;
		switch (p1[2]) {
		case INPUT_TERMINAL:
			term->type = combine_word(p1 + 4);
			term->channels = p1[7];
			term->chconfig = combine_word(p1 + 8);
			term->name = p1[11];
			return 0;
		case FEATURE_UNIT:
			id = p1[4];
			break; /* continue to parse */
		case MIXER_UNIT:
			term->type = p1[2] << 16; /* virtual type */
			term->channels = p1[5 + p1[4]];
			term->chconfig = combine_word(p1 + 6 + p1[4]);
			term->name = p1[p1[0] - 1];
			return 0;
		case SELECTOR_UNIT:
			/* call recursively to retrieve the channel info */
			if (check_input_term(state, p1[5], term) < 0)
				return -ENODEV;
			term->type = p1[2] << 16; /* virtual type */
			term->id = id;
			term->name = p1[9 + p1[0] - 1];
			return 0;
		case PROCESSING_UNIT:
		case EXTENSION_UNIT:
			if (p1[6] == 1) {
				id = p1[7];
				break; /* continue to parse */
			}
			term->type = p1[2] << 16; /* virtual type */
			term->channels = p1[7 + p1[6]];
			term->chconfig = combine_word(p1 + 8 + p1[6]);
			term->name = p1[12 + p1[6] + p1[11 + p1[6]]];
			return 0;
		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 */
static void usb_mixer_elem_free(snd_kcontrol_t *kctl)
{
	if (kctl->private_data) {
		snd_magic_kfree((void *)kctl->private_data);
		kctl->private_data = 0;
	}
}


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

Jaroslav Kysela's avatar
Jaroslav Kysela committed
586 587 588
/*
 * retrieve the minimum and maximum values for the specified control
 */
Jaroslav Kysela's avatar
Jaroslav Kysela committed
589
static int get_min_max(usb_mixer_elem_info_t *cval, int default_min)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
590 591
{
	/* for failsafe */
Jaroslav Kysela's avatar
Jaroslav Kysela committed
592 593
	cval->min = default_min;
	cval->max = cval->min + 1;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
594
	cval->res = 1;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613

	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;
				}
		}
		if (get_ctl_value(cval, GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
		    get_ctl_value(cval, GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
			snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n", cval->id, cval->ctrlif, cval->control, cval->id);
			return -EINVAL;
		}
Jaroslav Kysela's avatar
Jaroslav Kysela committed
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
		if (get_ctl_value(cval, GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
			cval->res = 1;
		} else {
			int last_valid_res = cval->res;
		
			while (cval->res > 1) {
				if (set_ctl_value(cval, SET_RES, (cval->control << 8) | minchn, cval->res / 2) < 0)
					break;
				cval->res /= 2;
			}
			if (get_ctl_value(cval, GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
				cval->res = last_valid_res;
		}
		if (cval->res == 0)
			cval->res = 1;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
629 630 631 632 633 634
		cval->initialized = 1;
	}
	return 0;
}


635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
/* get a feature/mixer unit info */
static int mixer_ctl_feature_info(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t *uinfo)
{	
	usb_mixer_elem_info_t *cval = snd_magic_cast(usb_mixer_elem_info_t, kcontrol->private_data, return -EINVAL);

	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 {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
651
		if (! cval->initialized)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
652
			get_min_max(cval,  0);
653
		uinfo->value.integer.min = 0;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
654
		uinfo->value.integer.max = (cval->max - cval->min) / cval->res;
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
	}
	return 0;
}

/* get the current value from feature/mixer unit */
static int mixer_ctl_feature_get(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol)
{
	usb_mixer_elem_info_t *cval = snd_magic_cast(usb_mixer_elem_info_t, kcontrol->private_data, return -EINVAL);
	int c, cnt, val, err;

	if (cval->cmask) {
		cnt = 0;
		for (c = 0; c < MAX_CHANNELS; c++) {
			if (cval->cmask & (1 << c)) {
				err = get_cur_mix_value(cval, c + 1, &val);
Jaroslav Kysela's avatar
Jaroslav Kysela committed
670 671 672 673 674 675
#ifdef IGNORE_CTL_ERROR
				if (err < 0) {
					ucontrol->value.integer.value[0] = cval->min;
					return 0;
				}
#endif
676
				if (err < 0) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
677
					snd_printd(KERN_ERR "cannot get current value for control %d ch %d: err = %d\n", cval->control, c + 1, err);
678
					return err;
679
				}
680 681 682 683 684 685 686 687
				val = get_relative_value(cval, val);
				ucontrol->value.integer.value[cnt] = val;
				cnt++;
			}
		}
	} else {
		/* master channel */
		err = get_cur_mix_value(cval, 0, &val);
Jaroslav Kysela's avatar
Jaroslav Kysela committed
688 689 690 691 692 693
#ifdef IGNORE_CTL_ERROR
		if (err < 0) {
			ucontrol->value.integer.value[0] = cval->min;
			return 0;
		}
#endif
694
		if (err < 0) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
695
			snd_printd(KERN_ERR "cannot get current value for control %d master ch: err = %d\n", cval->control, err);
696
			return err;
697
		}
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
		val = get_relative_value(cval, val);
		ucontrol->value.integer.value[0] = val;
	}
	return 0;
}

/* put the current value to feature/mixer unit */
static int mixer_ctl_feature_put(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol)
{
	usb_mixer_elem_info_t *cval = snd_magic_cast(usb_mixer_elem_info_t, kcontrol->private_data, return -EINVAL);
	int c, cnt, val, oval, err;
	int changed = 0;

	if (cval->cmask) {
		cnt = 0;
		for (c = 0; c < MAX_CHANNELS; c++) {
			if (cval->cmask & (1 << c)) {
				err = get_cur_mix_value(cval, c + 1, &oval);
Jaroslav Kysela's avatar
Jaroslav Kysela committed
716 717 718 719
#ifdef IGNORE_CTL_ERROR
				if (err < 0)
					return 0;
#endif
720 721 722 723 724 725 726 727
				if (err < 0)
					return err;
				val = ucontrol->value.integer.value[cnt];
				val = get_abs_value(cval, val);
				if (oval != val) {
					set_cur_mix_value(cval, c + 1, val);
					changed = 1;
				}
Jaroslav Kysela's avatar
Jaroslav Kysela committed
728
				get_cur_mix_value(cval, c + 1, &val);
729 730 731 732 733 734
				cnt++;
			}
		}
	} else {
		/* master channel */
		err = get_cur_mix_value(cval, 0, &oval);
Jaroslav Kysela's avatar
Jaroslav Kysela committed
735 736 737 738
#ifdef IGNORE_CTL_ERROR
		if (err < 0)
			return 0;
#endif
739 740 741 742 743 744 745 746 747 748 749 750 751
		if (err < 0)
			return err;
		val = ucontrol->value.integer.value[0];
		val = get_abs_value(cval, val);
		if (val != oval) {
			set_cur_mix_value(cval, 0, val);
			changed = 1;
		}
	}
	return changed;
}

static snd_kcontrol_new_t usb_feature_unit_ctl = {
752 753 754 755 756
	.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,
757 758 759 760 761 762 763 764 765 766 767
};


/*
 * build a feature control
 */

static void build_feature_ctl(mixer_build_t *state, unsigned char *desc,
			      unsigned int ctl_mask, int control,
			      usb_audio_term_t *iterm, int unitid)
{
Jaroslav Kysela's avatar
Jaroslav Kysela committed
768 769
	unsigned int len = 0;
	int mapped_name = 0;
770 771 772 773
	int nameid = desc[desc[0] - 1];
	snd_kcontrol_t *kctl;
	usb_mixer_elem_info_t *cval;

Jaroslav Kysela's avatar
Jaroslav Kysela committed
774 775
	control++; /* change from zero-based to 1-based value */

776 777 778 779 780
	if (control == USB_FEATURE_GEQ) {
		/* FIXME: not supported yet */
		return;
	}

Jaroslav Kysela's avatar
Jaroslav Kysela committed
781 782 783
	if (check_ignored_ctl(state, unitid, control))
		return;

784 785
	cval = snd_magic_kcalloc(usb_mixer_elem_info_t, 0, GFP_KERNEL);
	if (! cval) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
786
		snd_printk(KERN_ERR "cannot malloc kcontrol\n");
787 788 789 790 791 792 793
		return;
	}
	cval->chip = state->chip;
	cval->ctrlif = state->ctrlif;
	cval->id = unitid;
	cval->control = control;
	cval->cmask = ctl_mask;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
794
	cval->val_type = audio_feature_info[control-1].type;
795 796 797 798 799
	if (ctl_mask == 0)
		cval->channels = 1;	/* master channel */
	else {
		int i, c = 0;
		for (i = 0; i < 16; i++)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
800
			if (ctl_mask & (1 << i))
801 802 803 804 805
				c++;
		cval->channels = c;
	}

	/* get min/max values */
Jaroslav Kysela's avatar
Jaroslav Kysela committed
806
	get_min_max(cval, 0);
807 808 809

	kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
	if (! kctl) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
810
		snd_printk(KERN_ERR "cannot malloc kcontrol\n");
811 812 813 814 815
		snd_magic_kfree(cval);
		return;
	}
	kctl->private_free = usb_mixer_elem_free;

Jaroslav Kysela's avatar
Jaroslav Kysela committed
816 817 818
	len = check_mapped_name(state, unitid, control, kctl->id.name, sizeof(kctl->id.name));
	mapped_name = len != 0;
	if (! len && nameid)
819 820 821 822 823 824 825 826 827 828 829 830
		len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));

	switch (control) {
	case USB_FEATURE_MUTE:
	case USB_FEATURE_VOLUME:
		/* 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.
		 */
Jaroslav Kysela's avatar
Jaroslav Kysela committed
831
		if (! len) {
832 833 834 835
			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)
836 837
				len = snprintf(kctl->id.name, sizeof(kctl->id.name),
					       "Feature %d", unitid);
838 839 840 841 842
		}
		/* determine the stream direction:
		 * if the connected output is USB stream, then it's likely a
		 * capture stream.  otherwise it should be playback (hopefully :)
		 */
Jaroslav Kysela's avatar
Jaroslav Kysela committed
843
		if (! mapped_name && ! (state->oterm.type >> 16)) {
844
			if ((state->oterm.type & 0xff00) == 0x0100) {
845
				len = strlcat(kctl->id.name, " Capture", sizeof(kctl->id.name));
846
			} else {
847
				len = strlcat(kctl->id.name + len, " Playback", sizeof(kctl->id.name));
848 849
			}
		}
850 851
		strlcat(kctl->id.name + len, control == USB_FEATURE_MUTE ? " Switch" : " Volume",
			sizeof(kctl->id.name));
852 853 854
		break;

	default:
Jaroslav Kysela's avatar
Jaroslav Kysela committed
855
		if (! len)
856 857
			strlcpy(kctl->id.name, audio_feature_info[control-1].name,
				sizeof(kctl->id.name));
858 859 860
		break;
	}

Jaroslav Kysela's avatar
Jaroslav Kysela committed
861 862 863 864 865 866 867 868 869 870 871 872 873
	/* 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 (((state->vendor == 0x471 && (state->product == 0x104 || state->product == 0x105 || state->product == 0x101)) ||
	     (state->vendor == 0x672 && state->product == 0x1041)) && !strcmp(kctl->id.name, "PCM Playback Volume") &&
	     cval->min == -15616) {
		snd_printk("USB Audio: using volume control quirk for the UDA1321/N101 chip\n");
		cval->max = -256;
	}

	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);
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
	add_control_to_empty(state->chip->card, kctl);
}



/*
 * parse a feature unit
 *
 * most of controlls are defined here.
 */
static int parse_audio_feature_unit(mixer_build_t *state, int unitid, unsigned char *ftr)
{
	int channels, i, j;
	usb_audio_term_t iterm;
	unsigned int master_bits, first_ch_bits;
	int err, csize;

	if (ftr[0] < 7 || ! (csize = ftr[5]) || ftr[0] < 7 + csize) {
		snd_printk(KERN_ERR "usbaudio: unit %u: invalid FEATURE_UNIT descriptor\n", unitid);
		return -EINVAL;
	}

	/* parse the source unit */
	if ((err = parse_audio_unit(state, ftr[4])) < 0)
		return err;

	/* determine the input source type and name */
	if (check_input_term(state, ftr[4], &iterm) < 0)
		return -EINVAL;

	channels = (ftr[0] - 7) / csize - 1;

	master_bits = snd_usb_combine_bytes(ftr + 6, csize);
	if (channels > 0)
		first_ch_bits = snd_usb_combine_bytes(ftr + 6 + csize, csize);
	else
		first_ch_bits = 0;
	/* 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(ftr + 6 + csize * (j+1), csize);
			if (mask & (1 << i))
				ch_bits |= (1 << j);
		}
		if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
			build_feature_ctl(state, ftr, ch_bits, i, &iterm, unitid);
		if (master_bits & (1 << i))
			build_feature_ctl(state, ftr, 0, i, &iterm, unitid);
	}
	
	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.
 */

static void build_mixer_unit_ctl(mixer_build_t *state, unsigned char *desc,
				 int in_ch, int unitid)
{
	usb_mixer_elem_info_t *cval;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
944 945 946
	unsigned int num_ins = desc[4];
	unsigned int num_outs = desc[5 + num_ins];
	unsigned int i, len;
947 948 949
	snd_kcontrol_t *kctl;
	usb_audio_term_t iterm;

Jaroslav Kysela's avatar
Jaroslav Kysela committed
950 951 952
	if (check_ignored_ctl(state, unitid, 0))
		return;

953 954 955 956 957 958 959 960 961 962
	cval = snd_magic_kcalloc(usb_mixer_elem_info_t, 0, GFP_KERNEL);
	if (! cval)
		return;

	if (check_input_term(state, desc[5 + in_ch], &iterm) < 0)
		return;

	cval->chip = state->chip;
	cval->ctrlif = state->ctrlif;
	cval->id = unitid;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
963
	cval->control = in_ch + 1; /* based on 1 */
964 965 966 967 968 969 970 971 972
	cval->val_type = USB_MIXER_S16;
	for (i = 0; i < num_outs; i++) {
		if (check_matrix_bitmap(desc + 9 + num_ins, in_ch, i, num_outs)) {
			cval->cmask |= (1 << i);
			cval->channels++;
		}
	}

	/* get min/max values */
Jaroslav Kysela's avatar
Jaroslav Kysela committed
973
	get_min_max(cval, 0);
974 975 976

	kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
	if (! kctl) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
977
		snd_printk(KERN_ERR "cannot malloc kcontrol\n");
978 979 980 981 982
		snd_magic_kfree(cval);
		return;
	}
	kctl->private_free = usb_mixer_elem_free;

Jaroslav Kysela's avatar
Jaroslav Kysela committed
983 984 985
	len = check_mapped_name(state, unitid, 0, kctl->id.name, sizeof(kctl->id.name));
	if (! len)
		len = get_term_name(state, &iterm, kctl->id.name, sizeof(kctl->id.name), 0);
986 987
	if (! len)
		len = sprintf(kctl->id.name, "Mixer Source %d", in_ch);
988
	strlcat(kctl->id.name + len, " Volume", sizeof(kctl->id.name));
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026

	snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
		    cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
	add_control_to_empty(state->chip->card, kctl);
}


/*
 * parse a mixer unit
 */
static int parse_audio_mixer_unit(mixer_build_t *state, int unitid, unsigned char *desc)
{
	int num_ins, num_outs;
	int i, err;
	if (desc[0] < 12 || ! (num_ins = desc[4]) || ! (num_outs = desc[5 + num_ins]))
		return -EINVAL;

	for (i = 0; i < num_ins; i++) {
		err = parse_audio_unit(state, desc[5 + i]);
		if (err < 0)
			return err;
		if (check_matrix_bitmap(desc + 9 + num_ins, i, 0, num_outs))
			build_mixer_unit_ctl(state, desc, i, unitid);
	}
	return 0;
}


/*
 * Processing Unit / Extension Unit
 */

/* get callback for processing/extension unit */
static int mixer_ctl_procunit_get(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol)
{
	usb_mixer_elem_info_t *cval = snd_magic_cast(usb_mixer_elem_info_t, kcontrol->private_data, return -EINVAL);
	int err, val;

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1027
	err = get_cur_ctl_value(cval, cval->control << 8, &val);
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1028 1029 1030 1031 1032 1033
#ifdef IGNORE_CTL_ERROR
	if (err < 0) {
		ucontrol->value.integer.value[0] = cval->min;
		return 0;
	}
#endif
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
	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 */
static int mixer_ctl_procunit_put(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol)
{
	usb_mixer_elem_info_t *cval = snd_magic_cast(usb_mixer_elem_info_t, kcontrol->private_data, return -EINVAL);
	int val, oval, err;

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1047
	err = get_cur_ctl_value(cval, cval->control << 8, &oval);
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1048 1049 1050 1051
#ifdef IGNORE_CTL_ERROR
	if (err < 0)
		return 0;
#endif
1052 1053 1054 1055 1056
	if (err < 0)
		return err;
	val = ucontrol->value.integer.value[0];
	val = get_abs_value(cval, val);
	if (val != oval) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1057
		set_cur_ctl_value(cval, cval->control << 8, val);
1058 1059 1060 1061 1062 1063 1064
		return 1;
	}
	return 0;
}

/* alsa control interface for processing/extension unit */
static snd_kcontrol_new_t mixer_procunit_ctl = {
1065 1066 1067 1068 1069
	.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,
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
};


/*
 * predefined data for processing units
 */
struct procunit_value_info {
	int control;
	char *suffix;
	int val_type;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1080
	int min_value;
1081 1082 1083 1084 1085 1086 1087 1088 1089
};

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

static struct procunit_value_info updown_proc_info[] = {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1090
	{ USB_PROC_UPDOWN_SWITCH, "Switch", USB_MIXER_BOOLEAN },
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1091
	{ USB_PROC_UPDOWN_MODE_SEL, "Mode Select", USB_MIXER_U8, 1 },
1092 1093 1094
	{ 0 }
};
static struct procunit_value_info prologic_proc_info[] = {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1095
	{ USB_PROC_PROLOGIC_SWITCH, "Switch", USB_MIXER_BOOLEAN },
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1096
	{ USB_PROC_PROLOGIC_MODE_SEL, "Mode Select", USB_MIXER_U8, 1 },
1097 1098 1099
	{ 0 }
};
static struct procunit_value_info threed_enh_proc_info[] = {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1100 1101
	{ USB_PROC_3DENH_SWITCH, "Switch", USB_MIXER_BOOLEAN },
	{ USB_PROC_3DENH_SPACE, "Spaciousness", USB_MIXER_U8 },
1102 1103 1104
	{ 0 }
};
static struct procunit_value_info reverb_proc_info[] = {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1105 1106 1107 1108
	{ 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 },
1109 1110 1111
	{ 0 }
};
static struct procunit_value_info chorus_proc_info[] = {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1112 1113 1114 1115
	{ 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 },
1116 1117 1118
	{ 0 }
};
static struct procunit_value_info dcr_proc_info[] = {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1119 1120 1121 1122 1123 1124
	{ 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 },
1125 1126 1127 1128
	{ 0 }
};

static struct procunit_info procunits[] = {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1129 1130 1131 1132 1133 1134
	{ 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 },
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
	{ 0 },
};

/*
 * build a processing/extension unit
 */
static int build_audio_procunit(mixer_build_t *state, int unitid, unsigned char *dsc, struct procunit_info *list, char *name)
{
	int num_ins = dsc[6];
	usb_mixer_elem_info_t *cval;
	snd_kcontrol_t *kctl;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1146
	int i, err, nameid, type, len;
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
	struct procunit_info *info;
	struct procunit_value_info *valinfo;
	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
	};

	if (dsc[0] < 13 || dsc[0] < 13 + num_ins || dsc[0] < num_ins + dsc[11 + num_ins]) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1158
		snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
		return -EINVAL;
	}

	for (i = 0; i < num_ins; i++) {
		if ((err = parse_audio_unit(state, dsc[7 + i])) < 0)
			return err;
	}

	type = combine_word(&dsc[4]);
	if (! type)
		return 0; /* undefined? */

	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++) {
		/* FIXME: bitmap might be longer than 8bit */
		if (! (dsc[12 + num_ins] & (1 << (valinfo->control - 1))))
			continue;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1181 1182
		if (check_ignored_ctl(state, unitid, valinfo->control))
			continue;
1183 1184
		cval = snd_magic_kcalloc(usb_mixer_elem_info_t, 0, GFP_KERNEL);
		if (! cval) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1185
			snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195
			return -ENOMEM;
		}
		cval->chip = state->chip;
		cval->ctrlif = state->ctrlif;
		cval->id = unitid;
		cval->control = valinfo->control;
		cval->val_type = valinfo->val_type;
		cval->channels = 1;

		/* get min/max values */
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1196 1197 1198 1199 1200 1201 1202 1203
		if (type == USB_PROC_UPDOWN && cval->control == USB_PROC_UPDOWN_MODE_SEL) {
			/* FIXME: hard-coded */
			cval->min = 1;
			cval->max = dsc[15];
			cval->res = 1;
			cval->initialized = 1;
		} else
			get_min_max(cval, valinfo->min_value);
1204 1205 1206

		kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
		if (! kctl) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1207
			snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1208 1209 1210 1211 1212
			snd_magic_kfree(cval);
			return -ENOMEM;
		}
		kctl->private_free = usb_mixer_elem_free;

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1213 1214 1215
		if (check_mapped_name(state, unitid, cval->control, kctl->id.name, sizeof(kctl->id.name)))
			;
		else if (info->name)
1216
			strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1217 1218
		else {
			nameid = dsc[12 + num_ins + dsc[11 + num_ins]];
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1219 1220 1221
			len = 0;
			if (nameid)
				len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1222 1223
			if (! len)
				strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1224
		}
1225 1226 1227
		strlcat(kctl->id.name, ' ', sizeof(kctl->id.name));
		strlcat(kctl->id.name, valinfo->suffix, sizeof(kctl->id.name));

1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
		snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
			    cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
		if ((err = add_control_to_empty(state->chip->card, kctl)) < 0)
			return err;
	}
	return 0;
}


static int parse_audio_processing_unit(mixer_build_t *state, int unitid, unsigned char *desc)
{
	return build_audio_procunit(state, unitid, desc, procunits, "Processing Unit");
}

static int parse_audio_extension_unit(mixer_build_t *state, int unitid, unsigned char *desc)
{
	return build_audio_procunit(state, unitid, desc, NULL, "Extension Unit");
}


/*
 * Selector Unit
 */

/* info callback for selector unit
 * use an enumerator type for routing
 */
static int mixer_ctl_selector_info(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t *uinfo)
{	
	usb_mixer_elem_info_t *cval = snd_magic_cast(usb_mixer_elem_info_t, kcontrol->private_data, return -EINVAL);
	char **itemlist = (char **)kcontrol->private_value;

	snd_assert(itemlist, return -EINVAL);
	uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
	uinfo->count = 1;
	uinfo->value.enumerated.items = cval->max;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1264
	if ((int)uinfo->value.enumerated.item >= cval->max)
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
		uinfo->value.enumerated.item = cval->max - 1;
	strcpy(uinfo->value.enumerated.name, itemlist[uinfo->value.enumerated.item]);
	return 0;
}

/* get callback for selector unit */
static int mixer_ctl_selector_get(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol)
{
	usb_mixer_elem_info_t *cval = snd_magic_cast(usb_mixer_elem_info_t, kcontrol->private_data, return -EINVAL);
	int val, err;

	err = get_cur_ctl_value(cval, 0, &val);
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1277 1278 1279 1280 1281 1282
#ifdef IGNORE_CTL_ERROR
	if (err < 0) {
		ucontrol->value.enumerated.item[0] = 0;
		return 0;
	}
#endif
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
	if (err < 0)
		return err;
	val = get_relative_value(cval, val);
	ucontrol->value.enumerated.item[0] = val;
	return 0;
}

/* put callback for selector unit */
static int mixer_ctl_selector_put(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol)
{
	usb_mixer_elem_info_t *cval = snd_magic_cast(usb_mixer_elem_info_t, kcontrol->private_data, return -EINVAL);
	int val, oval, err;

	err = get_cur_ctl_value(cval, 0, &oval);
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1297 1298 1299 1300
#ifdef IGNORE_CTL_ERROR
	if (err < 0)
		return 0;
#endif
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
	if (err < 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 */
static snd_kcontrol_new_t mixer_selectunit_ctl = {
1314 1315 1316 1317 1318
	.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,
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
};


/* private free callback.
 * free both private_data and private_value
 */
static void usb_mixer_selector_elem_free(snd_kcontrol_t *kctl)
{
	int i, num_ins = 0;

	if (kctl->private_data) {
		usb_mixer_elem_info_t *cval = snd_magic_cast(usb_mixer_elem_info_t, kctl->private_data,);
		num_ins = cval->max;
		snd_magic_kfree(cval);
		kctl->private_data = 0;
	}
	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
 */
static int parse_audio_selector_unit(mixer_build_t *state, int unitid, unsigned char *desc)
{
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1349 1350 1351
	unsigned int num_ins = desc[4];
	unsigned int i, nameid, len;
	int err;
1352 1353 1354 1355 1356 1357 1358 1359 1360
	usb_mixer_elem_info_t *cval;
	snd_kcontrol_t *kctl;
	char **namelist;

	if (! num_ins || desc[0] < 6 + num_ins) {
		snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
		return -EINVAL;
	}

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1361 1362 1363
	if (check_ignored_ctl(state, unitid, 0))
		return 0;

1364 1365 1366 1367 1368 1369 1370
	for (i = 0; i < num_ins; i++) {
		if ((err = parse_audio_unit(state, desc[5 + i])) < 0)
			return err;
	}

	cval = snd_magic_kcalloc(usb_mixer_elem_info_t, 0, GFP_KERNEL);
	if (! cval) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1371
		snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1372 1373 1374 1375 1376 1377 1378 1379 1380
		return -ENOMEM;
	}
	cval->chip = state->chip;
	cval->ctrlif = state->ctrlif;
	cval->id = unitid;
	cval->val_type = USB_MIXER_U8;
	cval->channels = 1;
	cval->min = 1;
	cval->max = num_ins;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1381
	cval->res = 1;
1382
	cval->initialized = 1;
1383 1384 1385 1386 1387 1388 1389 1390 1391 1392

	namelist = kmalloc(sizeof(char *) * num_ins, GFP_KERNEL);
	if (! namelist) {
		snd_printk(KERN_ERR "cannot malloc\n");
		snd_magic_kfree(cval);
		return -ENOMEM;
	}
#define MAX_ITEM_NAME_LEN	64
	for (i = 0; i < num_ins; i++) {
		usb_audio_term_t iterm;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1393
		len = 0;
1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410
		namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
		if (! namelist[i]) {
			snd_printk(KERN_ERR "cannot malloc\n");
			while (--i > 0)
				kfree(namelist[i]);
			kfree(namelist);
			snd_magic_kfree(cval);
			return -ENOMEM;
		}
		if (check_input_term(state, desc[5 + i], &iterm) >= 0)
			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) {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1411
		snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1412 1413 1414 1415 1416 1417 1418
		snd_magic_kfree(cval);
		return -ENOMEM;
	}
	kctl->private_value = (unsigned long)namelist;
	kctl->private_free = usb_mixer_selector_elem_free;

	nameid = desc[desc[0] - 1];
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1419 1420 1421 1422
	len = check_mapped_name(state, unitid, 0, kctl->id.name, sizeof(kctl->id.name));
	if (len)
		;
	else if (nameid)
1423 1424
		snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
	else {
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1425 1426
		len = get_term_name(state, &state->oterm,
				    kctl->id.name, sizeof(kctl->id.name), 0);
1427
		if (! len)
1428 1429 1430 1431 1432 1433
			strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));

		if ((state->oterm.type & 0xff00) == 0x0100)
			strlcat(kctl->id.name, " Capture Source", sizeof(kctl->id.name));
		else
			strlcat(kctl->id.name, " Playback Source", sizeof(kctl->id.name));
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
	}

	snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
		    cval->id, kctl->id.name, num_ins);
	if ((err = add_control_to_empty(state->chip->card, kctl)) < 0)
		return err;

	return 0;
}


/*
 * parse an audio unit recursively
 */

static int parse_audio_unit(mixer_build_t *state, int unitid)
{
	unsigned char *p1;

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1453
	if (test_and_set_bit(unitid, state->unitbitmap))
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
		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]) {
	case INPUT_TERMINAL:
		return 0; /* NOP */
	case MIXER_UNIT:
		return parse_audio_mixer_unit(state, unitid, p1);
	case SELECTOR_UNIT:
		return parse_audio_selector_unit(state, unitid, p1);
	case FEATURE_UNIT:
		return parse_audio_feature_unit(state, unitid, p1);
	case PROCESSING_UNIT:
		return parse_audio_processing_unit(state, unitid, p1);
	case EXTENSION_UNIT:
		return parse_audio_extension_unit(state, unitid, p1);
	default:
		snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
		return -EINVAL;
	}
}

/*
 * create mixer controls
 *
 * walk through all OUTPUT_TERMINAL descriptors to search for mixers
 */
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1486
int snd_usb_create_mixer(snd_usb_audio_t *chip, int ctrlif)
1487 1488 1489 1490
{
	unsigned char *desc;
	mixer_build_t state;
	int err;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1491 1492
	const struct usbmix_ctl_map *map;
	struct usb_device_descriptor *dev = &chip->dev->descriptor;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1493
	struct usb_host_interface *hostif = &chip->dev->actconfig->interface[ctrlif].altsetting[0];
1494 1495 1496 1497 1498

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

	memset(&state, 0, sizeof(state));
	state.chip = chip;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1499 1500
	state.buffer = hostif->extra;
	state.buflen = hostif->extralen;
1501
	state.ctrlif = ctrlif;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1502 1503
	state.vendor = dev->idVendor;
	state.product = dev->idProduct;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1504 1505 1506 1507 1508 1509 1510 1511 1512

	/* check the mapping table */
	for (map = usbmix_ctl_maps; map->vendor; map++) {
		if (map->vendor == dev->idVendor && map->product == dev->idProduct) {
			state.map = map->map;
			break;
		}
	}

1513
	desc = NULL;
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1514
	while ((desc = snd_usb_find_csint_desc(hostif->extra, hostif->extralen, desc, OUTPUT_TERMINAL)) != NULL) {
1515 1516
		if (desc[0] < 9)
			continue; /* invalid descriptor? */
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1517
		set_bit(desc[3], state.unitbitmap);  /* mark terminal ID as visited */
1518 1519 1520 1521 1522 1523 1524 1525 1526
		state.oterm.id = desc[3];
		state.oterm.type = combine_word(&desc[4]);
		state.oterm.name = desc[8];
		err = parse_audio_unit(&state, desc[7]);
		if (err < 0)
			return err;
	}
	return 0;
}