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