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, 0x0819): /* Logitech Webcam C210 */ 917 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */ 918 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */ 919 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */ 920 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */ 921 case USB_ID(0x046d, 0x0991): 922 /* Most audio usb devices lie about volume resolution. 923 * Most Logitech webcams have res = 384. 924 * Proboly there is some logitech magic behind this number --fishor 925 */ 926 if (!strcmp(kctl->id.name, "Mic Capture Volume")) { 927 usb_audio_info(chip, 928 "set resolution quirk: cval->res = 384\n"); 929 cval->res = 384; 930 } 931 break; 932 } 933 } 934 935 /* 936 * retrieve the minimum and maximum values for the specified control 937 */ 938 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval, 939 int default_min, struct snd_kcontrol *kctl) 940 { 941 /* for failsafe */ 942 cval->min = default_min; 943 cval->max = cval->min + 1; 944 cval->res = 1; 945 cval->dBmin = cval->dBmax = 0; 946 947 if (cval->val_type == USB_MIXER_BOOLEAN || 948 cval->val_type == USB_MIXER_INV_BOOLEAN) { 949 cval->initialized = 1; 950 } else { 951 int minchn = 0; 952 if (cval->cmask) { 953 int i; 954 for (i = 0; i < MAX_CHANNELS; i++) 955 if (cval->cmask & (1 << i)) { 956 minchn = i + 1; 957 break; 958 } 959 } 960 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 || 961 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) { 962 usb_audio_err(cval->head.mixer->chip, 963 "%d:%d: cannot get min/max values for control %d (id %d)\n", 964 cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip), 965 cval->control, cval->head.id); 966 return -EINVAL; 967 } 968 if (get_ctl_value(cval, UAC_GET_RES, 969 (cval->control << 8) | minchn, 970 &cval->res) < 0) { 971 cval->res = 1; 972 } else { 973 int last_valid_res = cval->res; 974 975 while (cval->res > 1) { 976 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES, 977 (cval->control << 8) | minchn, 978 cval->res / 2) < 0) 979 break; 980 cval->res /= 2; 981 } 982 if (get_ctl_value(cval, UAC_GET_RES, 983 (cval->control << 8) | minchn, &cval->res) < 0) 984 cval->res = last_valid_res; 985 } 986 if (cval->res == 0) 987 cval->res = 1; 988 989 /* Additional checks for the proper resolution 990 * 991 * Some devices report smaller resolutions than actually 992 * reacting. They don't return errors but simply clip 993 * to the lower aligned value. 994 */ 995 if (cval->min + cval->res < cval->max) { 996 int last_valid_res = cval->res; 997 int saved, test, check; 998 get_cur_mix_raw(cval, minchn, &saved); 999 for (;;) { 1000 test = saved; 1001 if (test < cval->max) 1002 test += cval->res; 1003 else 1004 test -= cval->res; 1005 if (test < cval->min || test > cval->max || 1006 snd_usb_set_cur_mix_value(cval, minchn, 0, test) || 1007 get_cur_mix_raw(cval, minchn, &check)) { 1008 cval->res = last_valid_res; 1009 break; 1010 } 1011 if (test == check) 1012 break; 1013 cval->res *= 2; 1014 } 1015 snd_usb_set_cur_mix_value(cval, minchn, 0, saved); 1016 } 1017 1018 cval->initialized = 1; 1019 } 1020 1021 if (kctl) 1022 volume_control_quirks(cval, kctl); 1023 1024 /* USB descriptions contain the dB scale in 1/256 dB unit 1025 * while ALSA TLV contains in 1/100 dB unit 1026 */ 1027 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256; 1028 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256; 1029 if (cval->dBmin > cval->dBmax) { 1030 /* something is wrong; assume it's either from/to 0dB */ 1031 if (cval->dBmin < 0) 1032 cval->dBmax = 0; 1033 else if (cval->dBmin > 0) 1034 cval->dBmin = 0; 1035 if (cval->dBmin > cval->dBmax) { 1036 /* totally crap, return an error */ 1037 return -EINVAL; 1038 } 1039 } 1040 1041 return 0; 1042 } 1043 1044 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL) 1045 1046 /* get a feature/mixer unit info */ 1047 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, 1048 struct snd_ctl_elem_info *uinfo) 1049 { 1050 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1051 1052 if (cval->val_type == USB_MIXER_BOOLEAN || 1053 cval->val_type == USB_MIXER_INV_BOOLEAN) 1054 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN; 1055 else 1056 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER; 1057 uinfo->count = cval->channels; 1058 if (cval->val_type == USB_MIXER_BOOLEAN || 1059 cval->val_type == USB_MIXER_INV_BOOLEAN) { 1060 uinfo->value.integer.min = 0; 1061 uinfo->value.integer.max = 1; 1062 } else { 1063 if (!cval->initialized) { 1064 get_min_max_with_quirks(cval, 0, kcontrol); 1065 if (cval->initialized && cval->dBmin >= cval->dBmax) { 1066 kcontrol->vd[0].access &= 1067 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ | 1068 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK); 1069 snd_ctl_notify(cval->head.mixer->chip->card, 1070 SNDRV_CTL_EVENT_MASK_INFO, 1071 &kcontrol->id); 1072 } 1073 } 1074 uinfo->value.integer.min = 0; 1075 uinfo->value.integer.max = 1076 (cval->max - cval->min + cval->res - 1) / cval->res; 1077 } 1078 return 0; 1079 } 1080 1081 /* get the current value from feature/mixer unit */ 1082 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, 1083 struct snd_ctl_elem_value *ucontrol) 1084 { 1085 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1086 int c, cnt, val, err; 1087 1088 ucontrol->value.integer.value[0] = cval->min; 1089 if (cval->cmask) { 1090 cnt = 0; 1091 for (c = 0; c < MAX_CHANNELS; c++) { 1092 if (!(cval->cmask & (1 << c))) 1093 continue; 1094 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val); 1095 if (err < 0) 1096 return filter_error(cval, err); 1097 val = get_relative_value(cval, val); 1098 ucontrol->value.integer.value[cnt] = val; 1099 cnt++; 1100 } 1101 return 0; 1102 } else { 1103 /* master channel */ 1104 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val); 1105 if (err < 0) 1106 return filter_error(cval, err); 1107 val = get_relative_value(cval, val); 1108 ucontrol->value.integer.value[0] = val; 1109 } 1110 return 0; 1111 } 1112 1113 /* put the current value to feature/mixer unit */ 1114 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, 1115 struct snd_ctl_elem_value *ucontrol) 1116 { 1117 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1118 int c, cnt, val, oval, err; 1119 int changed = 0; 1120 1121 if (cval->cmask) { 1122 cnt = 0; 1123 for (c = 0; c < MAX_CHANNELS; c++) { 1124 if (!(cval->cmask & (1 << c))) 1125 continue; 1126 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval); 1127 if (err < 0) 1128 return filter_error(cval, err); 1129 val = ucontrol->value.integer.value[cnt]; 1130 val = get_abs_value(cval, val); 1131 if (oval != val) { 1132 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val); 1133 changed = 1; 1134 } 1135 cnt++; 1136 } 1137 } else { 1138 /* master channel */ 1139 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval); 1140 if (err < 0) 1141 return filter_error(cval, err); 1142 val = ucontrol->value.integer.value[0]; 1143 val = get_abs_value(cval, val); 1144 if (val != oval) { 1145 snd_usb_set_cur_mix_value(cval, 0, 0, val); 1146 changed = 1; 1147 } 1148 } 1149 return changed; 1150 } 1151 1152 static struct snd_kcontrol_new usb_feature_unit_ctl = { 1153 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 1154 .name = "", /* will be filled later manually */ 1155 .info = mixer_ctl_feature_info, 1156 .get = mixer_ctl_feature_get, 1157 .put = mixer_ctl_feature_put, 1158 }; 1159 1160 /* the read-only variant */ 1161 static struct snd_kcontrol_new usb_feature_unit_ctl_ro = { 1162 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 1163 .name = "", /* will be filled later manually */ 1164 .info = mixer_ctl_feature_info, 1165 .get = mixer_ctl_feature_get, 1166 .put = NULL, 1167 }; 1168 1169 /* 1170 * This symbol is exported in order to allow the mixer quirks to 1171 * hook up to the standard feature unit control mechanism 1172 */ 1173 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl; 1174 1175 /* 1176 * build a feature control 1177 */ 1178 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str) 1179 { 1180 return strlcat(kctl->id.name, str, sizeof(kctl->id.name)); 1181 } 1182 1183 /* 1184 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we 1185 * rename it to "Headphone". We determine if something is a headphone 1186 * similar to how udev determines form factor. 1187 */ 1188 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl, 1189 struct snd_card *card) 1190 { 1191 const char *names_to_check[] = { 1192 "Headset", "headset", "Headphone", "headphone", NULL}; 1193 const char **s; 1194 bool found = false; 1195 1196 if (strcmp("Speaker", kctl->id.name)) 1197 return; 1198 1199 for (s = names_to_check; *s; s++) 1200 if (strstr(card->shortname, *s)) { 1201 found = true; 1202 break; 1203 } 1204 1205 if (!found) 1206 return; 1207 1208 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name)); 1209 } 1210 1211 static void build_feature_ctl(struct mixer_build *state, void *raw_desc, 1212 unsigned int ctl_mask, int control, 1213 struct usb_audio_term *iterm, int unitid, 1214 int readonly_mask) 1215 { 1216 struct uac_feature_unit_descriptor *desc = raw_desc; 1217 unsigned int len = 0; 1218 int mapped_name = 0; 1219 int nameid = uac_feature_unit_iFeature(desc); 1220 struct snd_kcontrol *kctl; 1221 struct usb_mixer_elem_info *cval; 1222 const struct usbmix_name_map *map; 1223 unsigned int range; 1224 1225 control++; /* change from zero-based to 1-based value */ 1226 1227 if (control == UAC_FU_GRAPHIC_EQUALIZER) { 1228 /* FIXME: not supported yet */ 1229 return; 1230 } 1231 1232 map = find_map(state, unitid, control); 1233 if (check_ignored_ctl(map)) 1234 return; 1235 1236 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1237 if (!cval) 1238 return; 1239 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid); 1240 cval->control = control; 1241 cval->cmask = ctl_mask; 1242 cval->val_type = audio_feature_info[control-1].type; 1243 if (ctl_mask == 0) { 1244 cval->channels = 1; /* master channel */ 1245 cval->master_readonly = readonly_mask; 1246 } else { 1247 int i, c = 0; 1248 for (i = 0; i < 16; i++) 1249 if (ctl_mask & (1 << i)) 1250 c++; 1251 cval->channels = c; 1252 cval->ch_readonly = readonly_mask; 1253 } 1254 1255 /* 1256 * If all channels in the mask are marked read-only, make the control 1257 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't 1258 * issue write commands to read-only channels. 1259 */ 1260 if (cval->channels == readonly_mask) 1261 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval); 1262 else 1263 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval); 1264 1265 if (!kctl) { 1266 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 1267 kfree(cval); 1268 return; 1269 } 1270 kctl->private_free = snd_usb_mixer_elem_free; 1271 1272 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)); 1273 mapped_name = len != 0; 1274 if (!len && nameid) 1275 len = snd_usb_copy_string_desc(state, nameid, 1276 kctl->id.name, sizeof(kctl->id.name)); 1277 1278 switch (control) { 1279 case UAC_FU_MUTE: 1280 case UAC_FU_VOLUME: 1281 /* 1282 * determine the control name. the rule is: 1283 * - if a name id is given in descriptor, use it. 1284 * - if the connected input can be determined, then use the name 1285 * of terminal type. 1286 * - if the connected output can be determined, use it. 1287 * - otherwise, anonymous name. 1288 */ 1289 if (!len) { 1290 len = get_term_name(state, iterm, kctl->id.name, 1291 sizeof(kctl->id.name), 1); 1292 if (!len) 1293 len = get_term_name(state, &state->oterm, 1294 kctl->id.name, 1295 sizeof(kctl->id.name), 1); 1296 if (!len) 1297 snprintf(kctl->id.name, sizeof(kctl->id.name), 1298 "Feature %d", unitid); 1299 } 1300 1301 if (!mapped_name) 1302 check_no_speaker_on_headset(kctl, state->mixer->chip->card); 1303 1304 /* 1305 * determine the stream direction: 1306 * if the connected output is USB stream, then it's likely a 1307 * capture stream. otherwise it should be playback (hopefully :) 1308 */ 1309 if (!mapped_name && !(state->oterm.type >> 16)) { 1310 if ((state->oterm.type & 0xff00) == 0x0100) 1311 append_ctl_name(kctl, " Capture"); 1312 else 1313 append_ctl_name(kctl, " Playback"); 1314 } 1315 append_ctl_name(kctl, control == UAC_FU_MUTE ? 1316 " Switch" : " Volume"); 1317 break; 1318 default: 1319 if (!len) 1320 strlcpy(kctl->id.name, audio_feature_info[control-1].name, 1321 sizeof(kctl->id.name)); 1322 break; 1323 } 1324 1325 /* get min/max values */ 1326 get_min_max_with_quirks(cval, 0, kctl); 1327 1328 if (control == UAC_FU_VOLUME) { 1329 check_mapped_dB(map, cval); 1330 if (cval->dBmin < cval->dBmax || !cval->initialized) { 1331 kctl->tlv.c = snd_usb_mixer_vol_tlv; 1332 kctl->vd[0].access |= 1333 SNDRV_CTL_ELEM_ACCESS_TLV_READ | 1334 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK; 1335 } 1336 } 1337 1338 range = (cval->max - cval->min) / cval->res; 1339 /* 1340 * Are there devices with volume range more than 255? I use a bit more 1341 * to be sure. 384 is a resolution magic number found on Logitech 1342 * devices. It will definitively catch all buggy Logitech devices. 1343 */ 1344 if (range > 384) { 1345 usb_audio_warn(state->chip, 1346 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.", 1347 range); 1348 usb_audio_warn(state->chip, 1349 "[%d] FU [%s] ch = %d, val = %d/%d/%d", 1350 cval->head.id, kctl->id.name, cval->channels, 1351 cval->min, cval->max, cval->res); 1352 } 1353 1354 usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n", 1355 cval->head.id, kctl->id.name, cval->channels, 1356 cval->min, cval->max, cval->res); 1357 snd_usb_mixer_add_control(&cval->head, kctl); 1358 } 1359 1360 /* 1361 * parse a feature unit 1362 * 1363 * most of controls are defined here. 1364 */ 1365 static int parse_audio_feature_unit(struct mixer_build *state, int unitid, 1366 void *_ftr) 1367 { 1368 int channels, i, j; 1369 struct usb_audio_term iterm; 1370 unsigned int master_bits, first_ch_bits; 1371 int err, csize; 1372 struct uac_feature_unit_descriptor *hdr = _ftr; 1373 __u8 *bmaControls; 1374 1375 if (state->mixer->protocol == UAC_VERSION_1) { 1376 csize = hdr->bControlSize; 1377 if (!csize) { 1378 usb_audio_dbg(state->chip, 1379 "unit %u: invalid bControlSize == 0\n", 1380 unitid); 1381 return -EINVAL; 1382 } 1383 channels = (hdr->bLength - 7) / csize - 1; 1384 bmaControls = hdr->bmaControls; 1385 if (hdr->bLength < 7 + csize) { 1386 usb_audio_err(state->chip, 1387 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n", 1388 unitid); 1389 return -EINVAL; 1390 } 1391 } else { 1392 struct uac2_feature_unit_descriptor *ftr = _ftr; 1393 csize = 4; 1394 channels = (hdr->bLength - 6) / 4 - 1; 1395 bmaControls = ftr->bmaControls; 1396 if (hdr->bLength < 6 + csize) { 1397 usb_audio_err(state->chip, 1398 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n", 1399 unitid); 1400 return -EINVAL; 1401 } 1402 } 1403 1404 /* parse the source unit */ 1405 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0) 1406 return err; 1407 1408 /* determine the input source type and name */ 1409 err = check_input_term(state, hdr->bSourceID, &iterm); 1410 if (err < 0) 1411 return err; 1412 1413 master_bits = snd_usb_combine_bytes(bmaControls, csize); 1414 /* master configuration quirks */ 1415 switch (state->chip->usb_id) { 1416 case USB_ID(0x08bb, 0x2702): 1417 usb_audio_info(state->chip, 1418 "usbmixer: master volume quirk for PCM2702 chip\n"); 1419 /* disable non-functional volume control */ 1420 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME); 1421 break; 1422 case USB_ID(0x1130, 0xf211): 1423 usb_audio_info(state->chip, 1424 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n"); 1425 /* disable non-functional volume control */ 1426 channels = 0; 1427 break; 1428 1429 } 1430 if (channels > 0) 1431 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize); 1432 else 1433 first_ch_bits = 0; 1434 1435 if (state->mixer->protocol == UAC_VERSION_1) { 1436 /* check all control types */ 1437 for (i = 0; i < 10; i++) { 1438 unsigned int ch_bits = 0; 1439 for (j = 0; j < channels; j++) { 1440 unsigned int mask; 1441 1442 mask = snd_usb_combine_bytes(bmaControls + 1443 csize * (j+1), csize); 1444 if (mask & (1 << i)) 1445 ch_bits |= (1 << j); 1446 } 1447 /* audio class v1 controls are never read-only */ 1448 1449 /* 1450 * The first channel must be set 1451 * (for ease of programming). 1452 */ 1453 if (ch_bits & 1) 1454 build_feature_ctl(state, _ftr, ch_bits, i, 1455 &iterm, unitid, 0); 1456 if (master_bits & (1 << i)) 1457 build_feature_ctl(state, _ftr, 0, i, &iterm, 1458 unitid, 0); 1459 } 1460 } else { /* UAC_VERSION_2 */ 1461 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) { 1462 unsigned int ch_bits = 0; 1463 unsigned int ch_read_only = 0; 1464 1465 for (j = 0; j < channels; j++) { 1466 unsigned int mask; 1467 1468 mask = snd_usb_combine_bytes(bmaControls + 1469 csize * (j+1), csize); 1470 if (uac2_control_is_readable(mask, i)) { 1471 ch_bits |= (1 << j); 1472 if (!uac2_control_is_writeable(mask, i)) 1473 ch_read_only |= (1 << j); 1474 } 1475 } 1476 1477 /* 1478 * NOTE: build_feature_ctl() will mark the control 1479 * read-only if all channels are marked read-only in 1480 * the descriptors. Otherwise, the control will be 1481 * reported as writeable, but the driver will not 1482 * actually issue a write command for read-only 1483 * channels. 1484 */ 1485 1486 /* 1487 * The first channel must be set 1488 * (for ease of programming). 1489 */ 1490 if (ch_bits & 1) 1491 build_feature_ctl(state, _ftr, ch_bits, i, 1492 &iterm, unitid, ch_read_only); 1493 if (uac2_control_is_readable(master_bits, i)) 1494 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 1495 !uac2_control_is_writeable(master_bits, i)); 1496 } 1497 } 1498 1499 return 0; 1500 } 1501 1502 /* 1503 * Mixer Unit 1504 */ 1505 1506 /* 1507 * build a mixer unit control 1508 * 1509 * the callbacks are identical with feature unit. 1510 * input channel number (zero based) is given in control field instead. 1511 */ 1512 static void build_mixer_unit_ctl(struct mixer_build *state, 1513 struct uac_mixer_unit_descriptor *desc, 1514 int in_pin, int in_ch, int unitid, 1515 struct usb_audio_term *iterm) 1516 { 1517 struct usb_mixer_elem_info *cval; 1518 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc); 1519 unsigned int i, len; 1520 struct snd_kcontrol *kctl; 1521 const struct usbmix_name_map *map; 1522 1523 map = find_map(state, unitid, 0); 1524 if (check_ignored_ctl(map)) 1525 return; 1526 1527 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1528 if (!cval) 1529 return; 1530 1531 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid); 1532 cval->control = in_ch + 1; /* based on 1 */ 1533 cval->val_type = USB_MIXER_S16; 1534 for (i = 0; i < num_outs; i++) { 1535 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol); 1536 1537 if (check_matrix_bitmap(c, in_ch, i, num_outs)) { 1538 cval->cmask |= (1 << i); 1539 cval->channels++; 1540 } 1541 } 1542 1543 /* get min/max values */ 1544 get_min_max(cval, 0); 1545 1546 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval); 1547 if (!kctl) { 1548 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 1549 kfree(cval); 1550 return; 1551 } 1552 kctl->private_free = snd_usb_mixer_elem_free; 1553 1554 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)); 1555 if (!len) 1556 len = get_term_name(state, iterm, kctl->id.name, 1557 sizeof(kctl->id.name), 0); 1558 if (!len) 1559 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1); 1560 append_ctl_name(kctl, " Volume"); 1561 1562 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n", 1563 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max); 1564 snd_usb_mixer_add_control(&cval->head, kctl); 1565 } 1566 1567 /* 1568 * parse a mixer unit 1569 */ 1570 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, 1571 void *raw_desc) 1572 { 1573 struct uac_mixer_unit_descriptor *desc = raw_desc; 1574 struct usb_audio_term iterm; 1575 int input_pins, num_ins, num_outs; 1576 int pin, ich, err; 1577 1578 if (desc->bLength < 11 || !(input_pins = desc->bNrInPins) || 1579 !(num_outs = uac_mixer_unit_bNrChannels(desc))) { 1580 usb_audio_err(state->chip, 1581 "invalid MIXER UNIT descriptor %d\n", 1582 unitid); 1583 return -EINVAL; 1584 } 1585 /* no bmControls field (e.g. Maya44) -> ignore */ 1586 if (desc->bLength <= 10 + input_pins) { 1587 usb_audio_dbg(state->chip, "MU %d has no bmControls field\n", 1588 unitid); 1589 return 0; 1590 } 1591 1592 num_ins = 0; 1593 ich = 0; 1594 for (pin = 0; pin < input_pins; pin++) { 1595 err = parse_audio_unit(state, desc->baSourceID[pin]); 1596 if (err < 0) 1597 continue; 1598 err = check_input_term(state, desc->baSourceID[pin], &iterm); 1599 if (err < 0) 1600 return err; 1601 num_ins += iterm.channels; 1602 for (; ich < num_ins; ich++) { 1603 int och, ich_has_controls = 0; 1604 1605 for (och = 0; och < num_outs; och++) { 1606 __u8 *c = uac_mixer_unit_bmControls(desc, 1607 state->mixer->protocol); 1608 1609 if (check_matrix_bitmap(c, ich, och, num_outs)) { 1610 ich_has_controls = 1; 1611 break; 1612 } 1613 } 1614 if (ich_has_controls) 1615 build_mixer_unit_ctl(state, desc, pin, ich, 1616 unitid, &iterm); 1617 } 1618 } 1619 return 0; 1620 } 1621 1622 /* 1623 * Processing Unit / Extension Unit 1624 */ 1625 1626 /* get callback for processing/extension unit */ 1627 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, 1628 struct snd_ctl_elem_value *ucontrol) 1629 { 1630 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1631 int err, val; 1632 1633 err = get_cur_ctl_value(cval, cval->control << 8, &val); 1634 if (err < 0) { 1635 ucontrol->value.integer.value[0] = cval->min; 1636 return filter_error(cval, err); 1637 } 1638 val = get_relative_value(cval, val); 1639 ucontrol->value.integer.value[0] = val; 1640 return 0; 1641 } 1642 1643 /* put callback for processing/extension unit */ 1644 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, 1645 struct snd_ctl_elem_value *ucontrol) 1646 { 1647 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1648 int val, oval, err; 1649 1650 err = get_cur_ctl_value(cval, cval->control << 8, &oval); 1651 if (err < 0) 1652 return filter_error(cval, err); 1653 val = ucontrol->value.integer.value[0]; 1654 val = get_abs_value(cval, val); 1655 if (val != oval) { 1656 set_cur_ctl_value(cval, cval->control << 8, val); 1657 return 1; 1658 } 1659 return 0; 1660 } 1661 1662 /* alsa control interface for processing/extension unit */ 1663 static struct snd_kcontrol_new mixer_procunit_ctl = { 1664 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 1665 .name = "", /* will be filled later */ 1666 .info = mixer_ctl_feature_info, 1667 .get = mixer_ctl_procunit_get, 1668 .put = mixer_ctl_procunit_put, 1669 }; 1670 1671 /* 1672 * predefined data for processing units 1673 */ 1674 struct procunit_value_info { 1675 int control; 1676 char *suffix; 1677 int val_type; 1678 int min_value; 1679 }; 1680 1681 struct procunit_info { 1682 int type; 1683 char *name; 1684 struct procunit_value_info *values; 1685 }; 1686 1687 static struct procunit_value_info updown_proc_info[] = { 1688 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 1689 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 }, 1690 { 0 } 1691 }; 1692 static struct procunit_value_info prologic_proc_info[] = { 1693 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 1694 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 }, 1695 { 0 } 1696 }; 1697 static struct procunit_value_info threed_enh_proc_info[] = { 1698 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 1699 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 }, 1700 { 0 } 1701 }; 1702 static struct procunit_value_info reverb_proc_info[] = { 1703 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 1704 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 }, 1705 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 }, 1706 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 }, 1707 { 0 } 1708 }; 1709 static struct procunit_value_info chorus_proc_info[] = { 1710 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 1711 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 }, 1712 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 }, 1713 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 }, 1714 { 0 } 1715 }; 1716 static struct procunit_value_info dcr_proc_info[] = { 1717 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 1718 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 }, 1719 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 }, 1720 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 }, 1721 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 }, 1722 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 }, 1723 { 0 } 1724 }; 1725 1726 static struct procunit_info procunits[] = { 1727 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info }, 1728 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info }, 1729 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info }, 1730 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info }, 1731 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info }, 1732 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info }, 1733 { 0 }, 1734 }; 1735 /* 1736 * predefined data for extension units 1737 */ 1738 static struct procunit_value_info clock_rate_xu_info[] = { 1739 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 }, 1740 { 0 } 1741 }; 1742 static struct procunit_value_info clock_source_xu_info[] = { 1743 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN }, 1744 { 0 } 1745 }; 1746 static struct procunit_value_info spdif_format_xu_info[] = { 1747 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN }, 1748 { 0 } 1749 }; 1750 static struct procunit_value_info soft_limit_xu_info[] = { 1751 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN }, 1752 { 0 } 1753 }; 1754 static struct procunit_info extunits[] = { 1755 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info }, 1756 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info }, 1757 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info }, 1758 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info }, 1759 { 0 } 1760 }; 1761 1762 /* 1763 * build a processing/extension unit 1764 */ 1765 static int build_audio_procunit(struct mixer_build *state, int unitid, 1766 void *raw_desc, struct procunit_info *list, 1767 char *name) 1768 { 1769 struct uac_processing_unit_descriptor *desc = raw_desc; 1770 int num_ins = desc->bNrInPins; 1771 struct usb_mixer_elem_info *cval; 1772 struct snd_kcontrol *kctl; 1773 int i, err, nameid, type, len; 1774 struct procunit_info *info; 1775 struct procunit_value_info *valinfo; 1776 const struct usbmix_name_map *map; 1777 static struct procunit_value_info default_value_info[] = { 1778 { 0x01, "Switch", USB_MIXER_BOOLEAN }, 1779 { 0 } 1780 }; 1781 static struct procunit_info default_info = { 1782 0, NULL, default_value_info 1783 }; 1784 1785 if (desc->bLength < 13 || desc->bLength < 13 + num_ins || 1786 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) { 1787 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid); 1788 return -EINVAL; 1789 } 1790 1791 for (i = 0; i < num_ins; i++) { 1792 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0) 1793 return err; 1794 } 1795 1796 type = le16_to_cpu(desc->wProcessType); 1797 for (info = list; info && info->type; info++) 1798 if (info->type == type) 1799 break; 1800 if (!info || !info->type) 1801 info = &default_info; 1802 1803 for (valinfo = info->values; valinfo->control; valinfo++) { 1804 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol); 1805 1806 if (!(controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1)))) 1807 continue; 1808 map = find_map(state, unitid, valinfo->control); 1809 if (check_ignored_ctl(map)) 1810 continue; 1811 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1812 if (!cval) 1813 return -ENOMEM; 1814 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid); 1815 cval->control = valinfo->control; 1816 cval->val_type = valinfo->val_type; 1817 cval->channels = 1; 1818 1819 /* get min/max values */ 1820 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) { 1821 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol); 1822 /* FIXME: hard-coded */ 1823 cval->min = 1; 1824 cval->max = control_spec[0]; 1825 cval->res = 1; 1826 cval->initialized = 1; 1827 } else { 1828 if (type == USB_XU_CLOCK_RATE) { 1829 /* 1830 * E-Mu USB 0404/0202/TrackerPre/0204 1831 * samplerate control quirk 1832 */ 1833 cval->min = 0; 1834 cval->max = 5; 1835 cval->res = 1; 1836 cval->initialized = 1; 1837 } else 1838 get_min_max(cval, valinfo->min_value); 1839 } 1840 1841 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval); 1842 if (!kctl) { 1843 kfree(cval); 1844 return -ENOMEM; 1845 } 1846 kctl->private_free = snd_usb_mixer_elem_free; 1847 1848 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) { 1849 /* nothing */ ; 1850 } else if (info->name) { 1851 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name)); 1852 } else { 1853 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol); 1854 len = 0; 1855 if (nameid) 1856 len = snd_usb_copy_string_desc(state, nameid, 1857 kctl->id.name, 1858 sizeof(kctl->id.name)); 1859 if (!len) 1860 strlcpy(kctl->id.name, name, sizeof(kctl->id.name)); 1861 } 1862 append_ctl_name(kctl, " "); 1863 append_ctl_name(kctl, valinfo->suffix); 1864 1865 usb_audio_dbg(state->chip, 1866 "[%d] PU [%s] ch = %d, val = %d/%d\n", 1867 cval->head.id, kctl->id.name, cval->channels, 1868 cval->min, cval->max); 1869 1870 err = snd_usb_mixer_add_control(&cval->head, kctl); 1871 if (err < 0) 1872 return err; 1873 } 1874 return 0; 1875 } 1876 1877 static int parse_audio_processing_unit(struct mixer_build *state, int unitid, 1878 void *raw_desc) 1879 { 1880 return build_audio_procunit(state, unitid, raw_desc, 1881 procunits, "Processing Unit"); 1882 } 1883 1884 static int parse_audio_extension_unit(struct mixer_build *state, int unitid, 1885 void *raw_desc) 1886 { 1887 /* 1888 * Note that we parse extension units with processing unit descriptors. 1889 * That's ok as the layout is the same. 1890 */ 1891 return build_audio_procunit(state, unitid, raw_desc, 1892 extunits, "Extension Unit"); 1893 } 1894 1895 /* 1896 * Selector Unit 1897 */ 1898 1899 /* 1900 * info callback for selector unit 1901 * use an enumerator type for routing 1902 */ 1903 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, 1904 struct snd_ctl_elem_info *uinfo) 1905 { 1906 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1907 const char **itemlist = (const char **)kcontrol->private_value; 1908 1909 if (snd_BUG_ON(!itemlist)) 1910 return -EINVAL; 1911 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist); 1912 } 1913 1914 /* get callback for selector unit */ 1915 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, 1916 struct snd_ctl_elem_value *ucontrol) 1917 { 1918 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1919 int val, err; 1920 1921 err = get_cur_ctl_value(cval, cval->control << 8, &val); 1922 if (err < 0) { 1923 ucontrol->value.enumerated.item[0] = 0; 1924 return filter_error(cval, err); 1925 } 1926 val = get_relative_value(cval, val); 1927 ucontrol->value.enumerated.item[0] = val; 1928 return 0; 1929 } 1930 1931 /* put callback for selector unit */ 1932 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, 1933 struct snd_ctl_elem_value *ucontrol) 1934 { 1935 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1936 int val, oval, err; 1937 1938 err = get_cur_ctl_value(cval, cval->control << 8, &oval); 1939 if (err < 0) 1940 return filter_error(cval, err); 1941 val = ucontrol->value.enumerated.item[0]; 1942 val = get_abs_value(cval, val); 1943 if (val != oval) { 1944 set_cur_ctl_value(cval, cval->control << 8, val); 1945 return 1; 1946 } 1947 return 0; 1948 } 1949 1950 /* alsa control interface for selector unit */ 1951 static struct snd_kcontrol_new mixer_selectunit_ctl = { 1952 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 1953 .name = "", /* will be filled later */ 1954 .info = mixer_ctl_selector_info, 1955 .get = mixer_ctl_selector_get, 1956 .put = mixer_ctl_selector_put, 1957 }; 1958 1959 /* 1960 * private free callback. 1961 * free both private_data and private_value 1962 */ 1963 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl) 1964 { 1965 int i, num_ins = 0; 1966 1967 if (kctl->private_data) { 1968 struct usb_mixer_elem_info *cval = kctl->private_data; 1969 num_ins = cval->max; 1970 kfree(cval); 1971 kctl->private_data = NULL; 1972 } 1973 if (kctl->private_value) { 1974 char **itemlist = (char **)kctl->private_value; 1975 for (i = 0; i < num_ins; i++) 1976 kfree(itemlist[i]); 1977 kfree(itemlist); 1978 kctl->private_value = 0; 1979 } 1980 } 1981 1982 /* 1983 * parse a selector unit 1984 */ 1985 static int parse_audio_selector_unit(struct mixer_build *state, int unitid, 1986 void *raw_desc) 1987 { 1988 struct uac_selector_unit_descriptor *desc = raw_desc; 1989 unsigned int i, nameid, len; 1990 int err; 1991 struct usb_mixer_elem_info *cval; 1992 struct snd_kcontrol *kctl; 1993 const struct usbmix_name_map *map; 1994 char **namelist; 1995 1996 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) { 1997 usb_audio_err(state->chip, 1998 "invalid SELECTOR UNIT descriptor %d\n", unitid); 1999 return -EINVAL; 2000 } 2001 2002 for (i = 0; i < desc->bNrInPins; i++) { 2003 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0) 2004 return err; 2005 } 2006 2007 if (desc->bNrInPins == 1) /* only one ? nonsense! */ 2008 return 0; 2009 2010 map = find_map(state, unitid, 0); 2011 if (check_ignored_ctl(map)) 2012 return 0; 2013 2014 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 2015 if (!cval) 2016 return -ENOMEM; 2017 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid); 2018 cval->val_type = USB_MIXER_U8; 2019 cval->channels = 1; 2020 cval->min = 1; 2021 cval->max = desc->bNrInPins; 2022 cval->res = 1; 2023 cval->initialized = 1; 2024 2025 if (state->mixer->protocol == UAC_VERSION_1) 2026 cval->control = 0; 2027 else /* UAC_VERSION_2 */ 2028 cval->control = (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) ? 2029 UAC2_CX_CLOCK_SELECTOR : UAC2_SU_SELECTOR; 2030 2031 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL); 2032 if (!namelist) { 2033 kfree(cval); 2034 return -ENOMEM; 2035 } 2036 #define MAX_ITEM_NAME_LEN 64 2037 for (i = 0; i < desc->bNrInPins; i++) { 2038 struct usb_audio_term iterm; 2039 len = 0; 2040 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL); 2041 if (!namelist[i]) { 2042 while (i--) 2043 kfree(namelist[i]); 2044 kfree(namelist); 2045 kfree(cval); 2046 return -ENOMEM; 2047 } 2048 len = check_mapped_selector_name(state, unitid, i, namelist[i], 2049 MAX_ITEM_NAME_LEN); 2050 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0) 2051 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0); 2052 if (! len) 2053 sprintf(namelist[i], "Input %u", i); 2054 } 2055 2056 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval); 2057 if (! kctl) { 2058 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 2059 kfree(namelist); 2060 kfree(cval); 2061 return -ENOMEM; 2062 } 2063 kctl->private_value = (unsigned long)namelist; 2064 kctl->private_free = usb_mixer_selector_elem_free; 2065 2066 nameid = uac_selector_unit_iSelector(desc); 2067 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)); 2068 if (len) 2069 ; 2070 else if (nameid) 2071 snd_usb_copy_string_desc(state, nameid, kctl->id.name, 2072 sizeof(kctl->id.name)); 2073 else { 2074 len = get_term_name(state, &state->oterm, 2075 kctl->id.name, sizeof(kctl->id.name), 0); 2076 if (!len) 2077 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name)); 2078 2079 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) 2080 append_ctl_name(kctl, " Clock Source"); 2081 else if ((state->oterm.type & 0xff00) == 0x0100) 2082 append_ctl_name(kctl, " Capture Source"); 2083 else 2084 append_ctl_name(kctl, " Playback Source"); 2085 } 2086 2087 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n", 2088 cval->head.id, kctl->id.name, desc->bNrInPins); 2089 return snd_usb_mixer_add_control(&cval->head, kctl); 2090 } 2091 2092 /* 2093 * parse an audio unit recursively 2094 */ 2095 2096 static int parse_audio_unit(struct mixer_build *state, int unitid) 2097 { 2098 unsigned char *p1; 2099 2100 if (test_and_set_bit(unitid, state->unitbitmap)) 2101 return 0; /* the unit already visited */ 2102 2103 p1 = find_audio_control_unit(state, unitid); 2104 if (!p1) { 2105 usb_audio_err(state->chip, "unit %d not found!\n", unitid); 2106 return -EINVAL; 2107 } 2108 2109 switch (p1[2]) { 2110 case UAC_INPUT_TERMINAL: 2111 case UAC2_CLOCK_SOURCE: 2112 return 0; /* NOP */ 2113 case UAC_MIXER_UNIT: 2114 return parse_audio_mixer_unit(state, unitid, p1); 2115 case UAC_SELECTOR_UNIT: 2116 case UAC2_CLOCK_SELECTOR: 2117 return parse_audio_selector_unit(state, unitid, p1); 2118 case UAC_FEATURE_UNIT: 2119 return parse_audio_feature_unit(state, unitid, p1); 2120 case UAC1_PROCESSING_UNIT: 2121 /* UAC2_EFFECT_UNIT has the same value */ 2122 if (state->mixer->protocol == UAC_VERSION_1) 2123 return parse_audio_processing_unit(state, unitid, p1); 2124 else 2125 return 0; /* FIXME - effect units not implemented yet */ 2126 case UAC1_EXTENSION_UNIT: 2127 /* UAC2_PROCESSING_UNIT_V2 has the same value */ 2128 if (state->mixer->protocol == UAC_VERSION_1) 2129 return parse_audio_extension_unit(state, unitid, p1); 2130 else /* UAC_VERSION_2 */ 2131 return parse_audio_processing_unit(state, unitid, p1); 2132 case UAC2_EXTENSION_UNIT_V2: 2133 return parse_audio_extension_unit(state, unitid, p1); 2134 default: 2135 usb_audio_err(state->chip, 2136 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]); 2137 return -EINVAL; 2138 } 2139 } 2140 2141 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer) 2142 { 2143 kfree(mixer->id_elems); 2144 if (mixer->urb) { 2145 kfree(mixer->urb->transfer_buffer); 2146 usb_free_urb(mixer->urb); 2147 } 2148 usb_free_urb(mixer->rc_urb); 2149 kfree(mixer->rc_setup_packet); 2150 kfree(mixer); 2151 } 2152 2153 static int snd_usb_mixer_dev_free(struct snd_device *device) 2154 { 2155 struct usb_mixer_interface *mixer = device->device_data; 2156 snd_usb_mixer_free(mixer); 2157 return 0; 2158 } 2159 2160 /* 2161 * create mixer controls 2162 * 2163 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers 2164 */ 2165 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer) 2166 { 2167 struct mixer_build state; 2168 int err; 2169 const struct usbmix_ctl_map *map; 2170 void *p; 2171 2172 memset(&state, 0, sizeof(state)); 2173 state.chip = mixer->chip; 2174 state.mixer = mixer; 2175 state.buffer = mixer->hostif->extra; 2176 state.buflen = mixer->hostif->extralen; 2177 2178 /* check the mapping table */ 2179 for (map = usbmix_ctl_maps; map->id; map++) { 2180 if (map->id == state.chip->usb_id) { 2181 state.map = map->map; 2182 state.selector_map = map->selector_map; 2183 mixer->ignore_ctl_error = map->ignore_ctl_error; 2184 break; 2185 } 2186 } 2187 2188 p = NULL; 2189 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra, 2190 mixer->hostif->extralen, 2191 p, UAC_OUTPUT_TERMINAL)) != NULL) { 2192 if (mixer->protocol == UAC_VERSION_1) { 2193 struct uac1_output_terminal_descriptor *desc = p; 2194 2195 if (desc->bLength < sizeof(*desc)) 2196 continue; /* invalid descriptor? */ 2197 /* mark terminal ID as visited */ 2198 set_bit(desc->bTerminalID, state.unitbitmap); 2199 state.oterm.id = desc->bTerminalID; 2200 state.oterm.type = le16_to_cpu(desc->wTerminalType); 2201 state.oterm.name = desc->iTerminal; 2202 err = parse_audio_unit(&state, desc->bSourceID); 2203 if (err < 0 && err != -EINVAL) 2204 return err; 2205 } else { /* UAC_VERSION_2 */ 2206 struct uac2_output_terminal_descriptor *desc = p; 2207 2208 if (desc->bLength < sizeof(*desc)) 2209 continue; /* invalid descriptor? */ 2210 /* mark terminal ID as visited */ 2211 set_bit(desc->bTerminalID, state.unitbitmap); 2212 state.oterm.id = desc->bTerminalID; 2213 state.oterm.type = le16_to_cpu(desc->wTerminalType); 2214 state.oterm.name = desc->iTerminal; 2215 err = parse_audio_unit(&state, desc->bSourceID); 2216 if (err < 0 && err != -EINVAL) 2217 return err; 2218 2219 /* 2220 * For UAC2, use the same approach to also add the 2221 * clock selectors 2222 */ 2223 err = parse_audio_unit(&state, desc->bCSourceID); 2224 if (err < 0 && err != -EINVAL) 2225 return err; 2226 } 2227 } 2228 2229 return 0; 2230 } 2231 2232 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid) 2233 { 2234 struct usb_mixer_elem_list *list; 2235 2236 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) 2237 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE, 2238 &list->kctl->id); 2239 } 2240 2241 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer, 2242 struct usb_mixer_elem_list *list) 2243 { 2244 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list; 2245 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN", 2246 "S8", "U8", "S16", "U16"}; 2247 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, " 2248 "channels=%i, type=\"%s\"\n", cval->head.id, 2249 cval->control, cval->cmask, cval->channels, 2250 val_types[cval->val_type]); 2251 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n", 2252 cval->min, cval->max, cval->dBmin, cval->dBmax); 2253 } 2254 2255 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry, 2256 struct snd_info_buffer *buffer) 2257 { 2258 struct snd_usb_audio *chip = entry->private_data; 2259 struct usb_mixer_interface *mixer; 2260 struct usb_mixer_elem_list *list; 2261 int unitid; 2262 2263 list_for_each_entry(mixer, &chip->mixer_list, list) { 2264 snd_iprintf(buffer, 2265 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n", 2266 chip->usb_id, snd_usb_ctrl_intf(chip), 2267 mixer->ignore_ctl_error); 2268 snd_iprintf(buffer, "Card: %s\n", chip->card->longname); 2269 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) { 2270 for (list = mixer->id_elems[unitid]; list; 2271 list = list->next_id_elem) { 2272 snd_iprintf(buffer, " Unit: %i\n", list->id); 2273 if (list->kctl) 2274 snd_iprintf(buffer, 2275 " Control: name=\"%s\", index=%i\n", 2276 list->kctl->id.name, 2277 list->kctl->id.index); 2278 if (list->dump) 2279 list->dump(buffer, list); 2280 } 2281 } 2282 } 2283 } 2284 2285 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer, 2286 int attribute, int value, int index) 2287 { 2288 struct usb_mixer_elem_list *list; 2289 __u8 unitid = (index >> 8) & 0xff; 2290 __u8 control = (value >> 8) & 0xff; 2291 __u8 channel = value & 0xff; 2292 2293 if (channel >= MAX_CHANNELS) { 2294 usb_audio_dbg(mixer->chip, 2295 "%s(): bogus channel number %d\n", 2296 __func__, channel); 2297 return; 2298 } 2299 2300 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) { 2301 struct usb_mixer_elem_info *info; 2302 2303 if (!list->kctl) 2304 continue; 2305 2306 info = (struct usb_mixer_elem_info *)list; 2307 if (info->control != control) 2308 continue; 2309 2310 switch (attribute) { 2311 case UAC2_CS_CUR: 2312 /* invalidate cache, so the value is read from the device */ 2313 if (channel) 2314 info->cached &= ~(1 << channel); 2315 else /* master channel */ 2316 info->cached = 0; 2317 2318 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE, 2319 &info->head.kctl->id); 2320 break; 2321 2322 case UAC2_CS_RANGE: 2323 /* TODO */ 2324 break; 2325 2326 case UAC2_CS_MEM: 2327 /* TODO */ 2328 break; 2329 2330 default: 2331 usb_audio_dbg(mixer->chip, 2332 "unknown attribute %d in interrupt\n", 2333 attribute); 2334 break; 2335 } /* switch */ 2336 } 2337 } 2338 2339 static void snd_usb_mixer_interrupt(struct urb *urb) 2340 { 2341 struct usb_mixer_interface *mixer = urb->context; 2342 int len = urb->actual_length; 2343 int ustatus = urb->status; 2344 2345 if (ustatus != 0) 2346 goto requeue; 2347 2348 if (mixer->protocol == UAC_VERSION_1) { 2349 struct uac1_status_word *status; 2350 2351 for (status = urb->transfer_buffer; 2352 len >= sizeof(*status); 2353 len -= sizeof(*status), status++) { 2354 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n", 2355 status->bStatusType, 2356 status->bOriginator); 2357 2358 /* ignore any notifications not from the control interface */ 2359 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) != 2360 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF) 2361 continue; 2362 2363 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED) 2364 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator); 2365 else 2366 snd_usb_mixer_notify_id(mixer, status->bOriginator); 2367 } 2368 } else { /* UAC_VERSION_2 */ 2369 struct uac2_interrupt_data_msg *msg; 2370 2371 for (msg = urb->transfer_buffer; 2372 len >= sizeof(*msg); 2373 len -= sizeof(*msg), msg++) { 2374 /* drop vendor specific and endpoint requests */ 2375 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) || 2376 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP)) 2377 continue; 2378 2379 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute, 2380 le16_to_cpu(msg->wValue), 2381 le16_to_cpu(msg->wIndex)); 2382 } 2383 } 2384 2385 requeue: 2386 if (ustatus != -ENOENT && 2387 ustatus != -ECONNRESET && 2388 ustatus != -ESHUTDOWN) { 2389 urb->dev = mixer->chip->dev; 2390 usb_submit_urb(urb, GFP_ATOMIC); 2391 } 2392 } 2393 2394 /* create the handler for the optional status interrupt endpoint */ 2395 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer) 2396 { 2397 struct usb_endpoint_descriptor *ep; 2398 void *transfer_buffer; 2399 int buffer_length; 2400 unsigned int epnum; 2401 2402 /* we need one interrupt input endpoint */ 2403 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1) 2404 return 0; 2405 ep = get_endpoint(mixer->hostif, 0); 2406 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep)) 2407 return 0; 2408 2409 epnum = usb_endpoint_num(ep); 2410 buffer_length = le16_to_cpu(ep->wMaxPacketSize); 2411 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL); 2412 if (!transfer_buffer) 2413 return -ENOMEM; 2414 mixer->urb = usb_alloc_urb(0, GFP_KERNEL); 2415 if (!mixer->urb) { 2416 kfree(transfer_buffer); 2417 return -ENOMEM; 2418 } 2419 usb_fill_int_urb(mixer->urb, mixer->chip->dev, 2420 usb_rcvintpipe(mixer->chip->dev, epnum), 2421 transfer_buffer, buffer_length, 2422 snd_usb_mixer_interrupt, mixer, ep->bInterval); 2423 usb_submit_urb(mixer->urb, GFP_KERNEL); 2424 return 0; 2425 } 2426 2427 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif, 2428 int ignore_error) 2429 { 2430 static struct snd_device_ops dev_ops = { 2431 .dev_free = snd_usb_mixer_dev_free 2432 }; 2433 struct usb_mixer_interface *mixer; 2434 struct snd_info_entry *entry; 2435 int err; 2436 2437 strcpy(chip->card->mixername, "USB Mixer"); 2438 2439 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL); 2440 if (!mixer) 2441 return -ENOMEM; 2442 mixer->chip = chip; 2443 mixer->ignore_ctl_error = ignore_error; 2444 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems), 2445 GFP_KERNEL); 2446 if (!mixer->id_elems) { 2447 kfree(mixer); 2448 return -ENOMEM; 2449 } 2450 2451 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0]; 2452 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) { 2453 case UAC_VERSION_1: 2454 default: 2455 mixer->protocol = UAC_VERSION_1; 2456 break; 2457 case UAC_VERSION_2: 2458 mixer->protocol = UAC_VERSION_2; 2459 break; 2460 } 2461 2462 if ((err = snd_usb_mixer_controls(mixer)) < 0 || 2463 (err = snd_usb_mixer_status_create(mixer)) < 0) 2464 goto _error; 2465 2466 snd_usb_mixer_apply_create_quirk(mixer); 2467 2468 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops); 2469 if (err < 0) 2470 goto _error; 2471 2472 if (list_empty(&chip->mixer_list) && 2473 !snd_card_proc_new(chip->card, "usbmixer", &entry)) 2474 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read); 2475 2476 list_add(&mixer->list, &chip->mixer_list); 2477 return 0; 2478 2479 _error: 2480 snd_usb_mixer_free(mixer); 2481 return err; 2482 } 2483 2484 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer) 2485 { 2486 usb_kill_urb(mixer->urb); 2487 usb_kill_urb(mixer->rc_urb); 2488 } 2489 2490 #ifdef CONFIG_PM 2491 /* stop any bus activity of a mixer */ 2492 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer) 2493 { 2494 usb_kill_urb(mixer->urb); 2495 usb_kill_urb(mixer->rc_urb); 2496 } 2497 2498 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer) 2499 { 2500 int err; 2501 2502 if (mixer->urb) { 2503 err = usb_submit_urb(mixer->urb, GFP_NOIO); 2504 if (err < 0) 2505 return err; 2506 } 2507 2508 return 0; 2509 } 2510 2511 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer) 2512 { 2513 snd_usb_mixer_inactivate(mixer); 2514 return 0; 2515 } 2516 2517 static int restore_mixer_value(struct usb_mixer_elem_list *list) 2518 { 2519 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list; 2520 int c, err, idx; 2521 2522 if (cval->cmask) { 2523 idx = 0; 2524 for (c = 0; c < MAX_CHANNELS; c++) { 2525 if (!(cval->cmask & (1 << c))) 2526 continue; 2527 if (cval->cached & (1 << c)) { 2528 err = snd_usb_set_cur_mix_value(cval, c + 1, idx, 2529 cval->cache_val[idx]); 2530 if (err < 0) 2531 return err; 2532 } 2533 idx++; 2534 } 2535 } else { 2536 /* master */ 2537 if (cval->cached) { 2538 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val); 2539 if (err < 0) 2540 return err; 2541 } 2542 } 2543 2544 return 0; 2545 } 2546 2547 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume) 2548 { 2549 struct usb_mixer_elem_list *list; 2550 int id, err; 2551 2552 if (reset_resume) { 2553 /* restore cached mixer values */ 2554 for (id = 0; id < MAX_ID_ELEMS; id++) { 2555 for (list = mixer->id_elems[id]; list; 2556 list = list->next_id_elem) { 2557 if (list->resume) { 2558 err = list->resume(list); 2559 if (err < 0) 2560 return err; 2561 } 2562 } 2563 } 2564 } 2565 2566 return snd_usb_mixer_activate(mixer); 2567 } 2568 #endif 2569 2570 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list, 2571 struct usb_mixer_interface *mixer, 2572 int unitid) 2573 { 2574 list->mixer = mixer; 2575 list->id = unitid; 2576 list->dump = snd_usb_mixer_dump_cval; 2577 #ifdef CONFIG_PM 2578 list->resume = restore_mixer_value; 2579 #endif 2580 } 2581