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