1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * (Tentative) USB Audio Driver for ALSA 4 * 5 * Mixer control part 6 * 7 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de> 8 * 9 * Many codes borrowed from audio.c by 10 * Alan Cox (alan@lxorguk.ukuu.org.uk) 11 * Thomas Sailer (sailer@ife.ee.ethz.ch) 12 */ 13 14 /* 15 * TODOs, for both the mixer and the streaming interfaces: 16 * 17 * - support for UAC2 effect units 18 * - support for graphical equalizers 19 * - RANGE and MEM set commands (UAC2) 20 * - RANGE and MEM interrupt dispatchers (UAC2) 21 * - audio channel clustering (UAC2) 22 * - audio sample rate converter units (UAC2) 23 * - proper handling of clock multipliers (UAC2) 24 * - dispatch clock change notifications (UAC2) 25 * - stop PCM streams which use a clock that became invalid 26 * - stop PCM streams which use a clock selector that has changed 27 * - parse available sample rates again when clock sources changed 28 */ 29 30 #include <linux/bitops.h> 31 #include <linux/init.h> 32 #include <linux/list.h> 33 #include <linux/log2.h> 34 #include <linux/slab.h> 35 #include <linux/string.h> 36 #include <linux/usb.h> 37 #include <linux/usb/audio.h> 38 #include <linux/usb/audio-v2.h> 39 #include <linux/usb/audio-v3.h> 40 41 #include <sound/core.h> 42 #include <sound/control.h> 43 #include <sound/hwdep.h> 44 #include <sound/info.h> 45 #include <sound/tlv.h> 46 47 #include "usbaudio.h" 48 #include "mixer.h" 49 #include "helper.h" 50 #include "mixer_quirks.h" 51 #include "power.h" 52 53 #define MAX_ID_ELEMS 256 54 55 struct usb_audio_term { 56 int id; 57 int type; 58 int channels; 59 unsigned int chconfig; 60 int name; 61 }; 62 63 struct usbmix_name_map; 64 65 struct mixer_build { 66 struct snd_usb_audio *chip; 67 struct usb_mixer_interface *mixer; 68 unsigned char *buffer; 69 unsigned int buflen; 70 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS); 71 DECLARE_BITMAP(termbitmap, MAX_ID_ELEMS); 72 struct usb_audio_term oterm; 73 const struct usbmix_name_map *map; 74 const struct usbmix_selector_map *selector_map; 75 }; 76 77 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/ 78 enum { 79 USB_XU_CLOCK_RATE = 0xe301, 80 USB_XU_CLOCK_SOURCE = 0xe302, 81 USB_XU_DIGITAL_IO_STATUS = 0xe303, 82 USB_XU_DEVICE_OPTIONS = 0xe304, 83 USB_XU_DIRECT_MONITORING = 0xe305, 84 USB_XU_METERING = 0xe306 85 }; 86 enum { 87 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/ 88 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */ 89 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */ 90 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */ 91 }; 92 93 /* 94 * manual mapping of mixer names 95 * if the mixer topology is too complicated and the parsed names are 96 * ambiguous, add the entries in usbmixer_maps.c. 97 */ 98 #include "mixer_maps.c" 99 100 static const struct usbmix_name_map * 101 find_map(const struct usbmix_name_map *p, int unitid, int control) 102 { 103 if (!p) 104 return NULL; 105 106 for (; p->id; p++) { 107 if (p->id == unitid && 108 (!control || !p->control || control == p->control)) 109 return p; 110 } 111 return NULL; 112 } 113 114 /* get the mapped name if the unit matches */ 115 static int 116 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen) 117 { 118 int len; 119 120 if (!p || !p->name) 121 return 0; 122 123 buflen--; 124 len = strscpy(buf, p->name, buflen); 125 return len < 0 ? buflen : len; 126 } 127 128 /* ignore the error value if ignore_ctl_error flag is set */ 129 #define filter_error(cval, err) \ 130 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err)) 131 132 /* check whether the control should be ignored */ 133 static inline int 134 check_ignored_ctl(const struct usbmix_name_map *p) 135 { 136 if (!p || p->name || p->dB) 137 return 0; 138 return 1; 139 } 140 141 /* dB mapping */ 142 static inline void check_mapped_dB(const struct usbmix_name_map *p, 143 struct usb_mixer_elem_info *cval) 144 { 145 if (p && p->dB) { 146 cval->dBmin = p->dB->min; 147 cval->dBmax = p->dB->max; 148 cval->min_mute = p->dB->min_mute; 149 cval->initialized = 1; 150 } 151 } 152 153 /* get the mapped selector source name */ 154 static int check_mapped_selector_name(struct mixer_build *state, int unitid, 155 int index, char *buf, int buflen) 156 { 157 const struct usbmix_selector_map *p; 158 int len; 159 160 if (!state->selector_map) 161 return 0; 162 for (p = state->selector_map; p->id; p++) { 163 if (p->id == unitid && index < p->count) { 164 len = strscpy(buf, p->names[index], buflen); 165 return len < 0 ? buflen : len; 166 } 167 } 168 return 0; 169 } 170 171 /* 172 * find an audio control unit with the given unit id 173 */ 174 static void *find_audio_control_unit(struct mixer_build *state, 175 unsigned char unit) 176 { 177 /* we just parse the header */ 178 struct uac_feature_unit_descriptor *hdr = NULL; 179 180 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr, 181 USB_DT_CS_INTERFACE)) != NULL) { 182 if (hdr->bLength >= 4 && 183 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL && 184 hdr->bDescriptorSubtype <= UAC3_SAMPLE_RATE_CONVERTER && 185 hdr->bUnitID == unit) 186 return hdr; 187 } 188 189 return NULL; 190 } 191 192 /* 193 * copy a string with the given id 194 */ 195 static int snd_usb_copy_string_desc(struct snd_usb_audio *chip, 196 int index, char *buf, int maxlen) 197 { 198 int len = usb_string(chip->dev, index, buf, maxlen - 1); 199 200 if (len < 0) 201 return 0; 202 203 buf[len] = 0; 204 return len; 205 } 206 207 /* 208 * convert from the byte/word on usb descriptor to the zero-based integer 209 */ 210 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val) 211 { 212 switch (cval->val_type) { 213 case USB_MIXER_BOOLEAN: 214 return !!val; 215 case USB_MIXER_INV_BOOLEAN: 216 return !val; 217 case USB_MIXER_U8: 218 val &= 0xff; 219 break; 220 case USB_MIXER_S8: 221 val &= 0xff; 222 if (val >= 0x80) 223 val -= 0x100; 224 break; 225 case USB_MIXER_U16: 226 val &= 0xffff; 227 break; 228 case USB_MIXER_S16: 229 val &= 0xffff; 230 if (val >= 0x8000) 231 val -= 0x10000; 232 break; 233 } 234 return val; 235 } 236 237 /* 238 * convert from the zero-based int to the byte/word for usb descriptor 239 */ 240 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val) 241 { 242 switch (cval->val_type) { 243 case USB_MIXER_BOOLEAN: 244 return !!val; 245 case USB_MIXER_INV_BOOLEAN: 246 return !val; 247 case USB_MIXER_S8: 248 case USB_MIXER_U8: 249 return val & 0xff; 250 case USB_MIXER_S16: 251 case USB_MIXER_U16: 252 return val & 0xffff; 253 } 254 return 0; /* not reached */ 255 } 256 257 static int get_relative_value(struct usb_mixer_elem_info *cval, int val) 258 { 259 if (!cval->res) 260 cval->res = 1; 261 if (val < cval->min) 262 return 0; 263 else if (val >= cval->max) 264 return DIV_ROUND_UP(cval->max - cval->min, cval->res); 265 else 266 return (val - cval->min) / cval->res; 267 } 268 269 static int get_abs_value(struct usb_mixer_elem_info *cval, int val) 270 { 271 if (val < 0) 272 return cval->min; 273 if (!cval->res) 274 cval->res = 1; 275 val *= cval->res; 276 val += cval->min; 277 if (val > cval->max) 278 return cval->max; 279 return val; 280 } 281 282 static int uac2_ctl_value_size(int val_type) 283 { 284 switch (val_type) { 285 case USB_MIXER_S32: 286 case USB_MIXER_U32: 287 return 4; 288 case USB_MIXER_S16: 289 case USB_MIXER_U16: 290 return 2; 291 default: 292 return 1; 293 } 294 return 0; /* unreachable */ 295 } 296 297 298 /* 299 * retrieve a mixer value 300 */ 301 302 static inline int mixer_ctrl_intf(struct usb_mixer_interface *mixer) 303 { 304 return get_iface_desc(mixer->hostif)->bInterfaceNumber; 305 } 306 307 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request, 308 int validx, int *value_ret) 309 { 310 struct snd_usb_audio *chip = cval->head.mixer->chip; 311 unsigned char buf[2]; 312 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1; 313 int timeout = 10; 314 int idx = 0, err; 315 316 err = snd_usb_lock_shutdown(chip); 317 if (err < 0) 318 return -EIO; 319 320 while (timeout-- > 0) { 321 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8); 322 err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request, 323 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN, 324 validx, idx, buf, val_len); 325 if (err >= val_len) { 326 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len)); 327 err = 0; 328 goto out; 329 } else if (err == -ETIMEDOUT) { 330 goto out; 331 } 332 } 333 usb_audio_dbg(chip, 334 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n", 335 request, validx, idx, cval->val_type); 336 err = -EINVAL; 337 338 out: 339 snd_usb_unlock_shutdown(chip); 340 return err; 341 } 342 343 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request, 344 int validx, int *value_ret) 345 { 346 struct snd_usb_audio *chip = cval->head.mixer->chip; 347 /* enough space for one range */ 348 unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)]; 349 unsigned char *val; 350 int idx = 0, ret, val_size, size; 351 __u8 bRequest; 352 353 val_size = uac2_ctl_value_size(cval->val_type); 354 355 if (request == UAC_GET_CUR) { 356 bRequest = UAC2_CS_CUR; 357 size = val_size; 358 } else { 359 bRequest = UAC2_CS_RANGE; 360 size = sizeof(__u16) + 3 * val_size; 361 } 362 363 memset(buf, 0, sizeof(buf)); 364 365 if (snd_usb_lock_shutdown(chip)) 366 return -EIO; 367 368 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8); 369 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest, 370 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN, 371 validx, idx, buf, size); 372 snd_usb_unlock_shutdown(chip); 373 374 if (ret < 0) { 375 usb_audio_dbg(chip, 376 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n", 377 request, validx, idx, cval->val_type); 378 return ret; 379 } 380 381 /* FIXME: how should we handle multiple triplets here? */ 382 383 switch (request) { 384 case UAC_GET_CUR: 385 val = buf; 386 break; 387 case UAC_GET_MIN: 388 val = buf + sizeof(__u16); 389 break; 390 case UAC_GET_MAX: 391 val = buf + sizeof(__u16) + val_size; 392 break; 393 case UAC_GET_RES: 394 val = buf + sizeof(__u16) + val_size * 2; 395 break; 396 default: 397 return -EINVAL; 398 } 399 400 *value_ret = convert_signed_value(cval, 401 snd_usb_combine_bytes(val, val_size)); 402 403 return 0; 404 } 405 406 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, 407 int validx, int *value_ret) 408 { 409 validx += cval->idx_off; 410 411 return (cval->head.mixer->protocol == UAC_VERSION_1) ? 412 get_ctl_value_v1(cval, request, validx, value_ret) : 413 get_ctl_value_v2(cval, request, validx, value_ret); 414 } 415 416 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, 417 int validx, int *value) 418 { 419 return get_ctl_value(cval, UAC_GET_CUR, validx, value); 420 } 421 422 /* channel = 0: master, 1 = first channel */ 423 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval, 424 int channel, int *value) 425 { 426 return get_ctl_value(cval, UAC_GET_CUR, 427 (cval->control << 8) | channel, 428 value); 429 } 430 431 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval, 432 int channel, int index, int *value) 433 { 434 int err; 435 436 if (cval->cached & BIT(channel)) { 437 *value = cval->cache_val[index]; 438 return 0; 439 } 440 err = get_cur_mix_raw(cval, channel, value); 441 if (err < 0) { 442 if (!cval->head.mixer->ignore_ctl_error) 443 usb_audio_dbg(cval->head.mixer->chip, 444 "cannot get current value for control %d ch %d: err = %d\n", 445 cval->control, channel, err); 446 return err; 447 } 448 cval->cached |= BIT(channel); 449 cval->cache_val[index] = *value; 450 return 0; 451 } 452 453 /* 454 * set a mixer value 455 */ 456 457 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval, 458 int request, int validx, int value_set) 459 { 460 struct snd_usb_audio *chip = cval->head.mixer->chip; 461 unsigned char buf[4]; 462 int idx = 0, val_len, err, timeout = 10; 463 464 validx += cval->idx_off; 465 466 467 if (cval->head.mixer->protocol == UAC_VERSION_1) { 468 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1; 469 } else { /* UAC_VERSION_2/3 */ 470 val_len = uac2_ctl_value_size(cval->val_type); 471 472 /* FIXME */ 473 if (request != UAC_SET_CUR) { 474 usb_audio_dbg(chip, "RANGE setting not yet supported\n"); 475 return -EINVAL; 476 } 477 478 request = UAC2_CS_CUR; 479 } 480 481 value_set = convert_bytes_value(cval, value_set); 482 buf[0] = value_set & 0xff; 483 buf[1] = (value_set >> 8) & 0xff; 484 buf[2] = (value_set >> 16) & 0xff; 485 buf[3] = (value_set >> 24) & 0xff; 486 487 err = snd_usb_lock_shutdown(chip); 488 if (err < 0) 489 return -EIO; 490 491 while (timeout-- > 0) { 492 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8); 493 err = snd_usb_ctl_msg(chip->dev, 494 usb_sndctrlpipe(chip->dev, 0), request, 495 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT, 496 validx, idx, buf, val_len); 497 if (err >= 0) { 498 err = 0; 499 goto out; 500 } else if (err == -ETIMEDOUT) { 501 goto out; 502 } 503 } 504 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n", 505 request, validx, idx, cval->val_type, buf[0], buf[1]); 506 err = -EINVAL; 507 508 out: 509 snd_usb_unlock_shutdown(chip); 510 return err; 511 } 512 513 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, 514 int validx, int value) 515 { 516 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value); 517 } 518 519 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel, 520 int index, int value) 521 { 522 int err; 523 unsigned int read_only = (channel == 0) ? 524 cval->master_readonly : 525 cval->ch_readonly & BIT(channel - 1); 526 527 if (read_only) { 528 usb_audio_dbg(cval->head.mixer->chip, 529 "%s(): channel %d of control %d is read_only\n", 530 __func__, channel, cval->control); 531 return 0; 532 } 533 534 err = snd_usb_mixer_set_ctl_value(cval, 535 UAC_SET_CUR, (cval->control << 8) | channel, 536 value); 537 if (err < 0) 538 return err; 539 cval->cached |= BIT(channel); 540 cval->cache_val[index] = value; 541 return 0; 542 } 543 544 /* 545 * TLV callback for mixer volume controls 546 */ 547 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag, 548 unsigned int size, unsigned int __user *_tlv) 549 { 550 struct usb_mixer_elem_info *cval = kcontrol->private_data; 551 DECLARE_TLV_DB_MINMAX(scale, 0, 0); 552 553 if (size < sizeof(scale)) 554 return -ENOMEM; 555 if (cval->min_mute) 556 scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE; 557 scale[2] = cval->dBmin; 558 scale[3] = cval->dBmax; 559 if (copy_to_user(_tlv, scale, sizeof(scale))) 560 return -EFAULT; 561 return 0; 562 } 563 564 /* 565 * parser routines begin here... 566 */ 567 568 static int parse_audio_unit(struct mixer_build *state, int unitid); 569 570 571 /* 572 * check if the input/output channel routing is enabled on the given bitmap. 573 * used for mixer unit parser 574 */ 575 static int check_matrix_bitmap(unsigned char *bmap, 576 int ich, int och, int num_outs) 577 { 578 int idx = ich * num_outs + och; 579 return bmap[idx >> 3] & (0x80 >> (idx & 7)); 580 } 581 582 /* 583 * add an alsa control element 584 * search and increment the index until an empty slot is found. 585 * 586 * if failed, give up and free the control instance. 587 */ 588 589 int snd_usb_mixer_add_list(struct usb_mixer_elem_list *list, 590 struct snd_kcontrol *kctl, 591 bool is_std_info) 592 { 593 struct usb_mixer_interface *mixer = list->mixer; 594 int err; 595 596 while (snd_ctl_find_id(mixer->chip->card, &kctl->id)) 597 kctl->id.index++; 598 err = snd_ctl_add(mixer->chip->card, kctl); 599 if (err < 0) { 600 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n", 601 err); 602 return err; 603 } 604 list->kctl = kctl; 605 list->is_std_info = is_std_info; 606 list->next_id_elem = mixer->id_elems[list->id]; 607 mixer->id_elems[list->id] = list; 608 return 0; 609 } 610 611 /* 612 * get a terminal name string 613 */ 614 615 static struct iterm_name_combo { 616 int type; 617 char *name; 618 } iterm_names[] = { 619 { 0x0300, "Output" }, 620 { 0x0301, "Speaker" }, 621 { 0x0302, "Headphone" }, 622 { 0x0303, "HMD Audio" }, 623 { 0x0304, "Desktop Speaker" }, 624 { 0x0305, "Room Speaker" }, 625 { 0x0306, "Com Speaker" }, 626 { 0x0307, "LFE" }, 627 { 0x0600, "External In" }, 628 { 0x0601, "Analog In" }, 629 { 0x0602, "Digital In" }, 630 { 0x0603, "Line" }, 631 { 0x0604, "Legacy In" }, 632 { 0x0605, "IEC958 In" }, 633 { 0x0606, "1394 DA Stream" }, 634 { 0x0607, "1394 DV Stream" }, 635 { 0x0700, "Embedded" }, 636 { 0x0701, "Noise Source" }, 637 { 0x0702, "Equalization Noise" }, 638 { 0x0703, "CD" }, 639 { 0x0704, "DAT" }, 640 { 0x0705, "DCC" }, 641 { 0x0706, "MiniDisk" }, 642 { 0x0707, "Analog Tape" }, 643 { 0x0708, "Phonograph" }, 644 { 0x0709, "VCR Audio" }, 645 { 0x070a, "Video Disk Audio" }, 646 { 0x070b, "DVD Audio" }, 647 { 0x070c, "TV Tuner Audio" }, 648 { 0x070d, "Satellite Rec Audio" }, 649 { 0x070e, "Cable Tuner Audio" }, 650 { 0x070f, "DSS Audio" }, 651 { 0x0710, "Radio Receiver" }, 652 { 0x0711, "Radio Transmitter" }, 653 { 0x0712, "Multi-Track Recorder" }, 654 { 0x0713, "Synthesizer" }, 655 { 0 }, 656 }; 657 658 static int get_term_name(struct snd_usb_audio *chip, struct usb_audio_term *iterm, 659 unsigned char *name, int maxlen, int term_only) 660 { 661 struct iterm_name_combo *names; 662 int len; 663 664 if (iterm->name) { 665 len = snd_usb_copy_string_desc(chip, iterm->name, 666 name, maxlen); 667 if (len) 668 return len; 669 } 670 671 /* virtual type - not a real terminal */ 672 if (iterm->type >> 16) { 673 if (term_only) 674 return 0; 675 switch (iterm->type >> 16) { 676 case UAC3_SELECTOR_UNIT: 677 strcpy(name, "Selector"); 678 return 8; 679 case UAC3_PROCESSING_UNIT: 680 strcpy(name, "Process Unit"); 681 return 12; 682 case UAC3_EXTENSION_UNIT: 683 strcpy(name, "Ext Unit"); 684 return 8; 685 case UAC3_MIXER_UNIT: 686 strcpy(name, "Mixer"); 687 return 5; 688 default: 689 return sprintf(name, "Unit %d", iterm->id); 690 } 691 } 692 693 switch (iterm->type & 0xff00) { 694 case 0x0100: 695 strcpy(name, "PCM"); 696 return 3; 697 case 0x0200: 698 strcpy(name, "Mic"); 699 return 3; 700 case 0x0400: 701 strcpy(name, "Headset"); 702 return 7; 703 case 0x0500: 704 strcpy(name, "Phone"); 705 return 5; 706 } 707 708 for (names = iterm_names; names->type; names++) { 709 if (names->type == iterm->type) { 710 strcpy(name, names->name); 711 return strlen(names->name); 712 } 713 } 714 715 return 0; 716 } 717 718 /* 719 * Get logical cluster information for UAC3 devices. 720 */ 721 static int get_cluster_channels_v3(struct mixer_build *state, unsigned int cluster_id) 722 { 723 struct uac3_cluster_header_descriptor c_header; 724 int err; 725 726 err = snd_usb_ctl_msg(state->chip->dev, 727 usb_rcvctrlpipe(state->chip->dev, 0), 728 UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR, 729 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN, 730 cluster_id, 731 snd_usb_ctrl_intf(state->mixer->hostif), 732 &c_header, sizeof(c_header)); 733 if (err < 0) 734 goto error; 735 if (err != sizeof(c_header)) { 736 err = -EIO; 737 goto error; 738 } 739 740 return c_header.bNrChannels; 741 742 error: 743 usb_audio_err(state->chip, "cannot request logical cluster ID: %d (err: %d)\n", cluster_id, err); 744 return err; 745 } 746 747 /* 748 * Get number of channels for a Mixer Unit. 749 */ 750 static int uac_mixer_unit_get_channels(struct mixer_build *state, 751 struct uac_mixer_unit_descriptor *desc) 752 { 753 int mu_channels; 754 755 switch (state->mixer->protocol) { 756 case UAC_VERSION_1: 757 case UAC_VERSION_2: 758 default: 759 if (desc->bLength < sizeof(*desc) + desc->bNrInPins + 1) 760 return 0; /* no bmControls -> skip */ 761 mu_channels = uac_mixer_unit_bNrChannels(desc); 762 break; 763 case UAC_VERSION_3: 764 mu_channels = get_cluster_channels_v3(state, 765 uac3_mixer_unit_wClusterDescrID(desc)); 766 break; 767 } 768 769 return mu_channels; 770 } 771 772 /* 773 * Parse Input Terminal Unit 774 */ 775 static int __check_input_term(struct mixer_build *state, int id, 776 struct usb_audio_term *term); 777 778 static int parse_term_uac1_iterm_unit(struct mixer_build *state, 779 struct usb_audio_term *term, 780 void *p1, int id) 781 { 782 struct uac_input_terminal_descriptor *d = p1; 783 784 term->type = le16_to_cpu(d->wTerminalType); 785 term->channels = d->bNrChannels; 786 term->chconfig = le16_to_cpu(d->wChannelConfig); 787 term->name = d->iTerminal; 788 return 0; 789 } 790 791 static int parse_term_uac2_iterm_unit(struct mixer_build *state, 792 struct usb_audio_term *term, 793 void *p1, int id) 794 { 795 struct uac2_input_terminal_descriptor *d = p1; 796 int err; 797 798 /* call recursively to verify the referenced clock entity */ 799 err = __check_input_term(state, d->bCSourceID, term); 800 if (err < 0) 801 return err; 802 803 /* save input term properties after recursion, 804 * to ensure they are not overriden by the recursion calls 805 */ 806 term->id = id; 807 term->type = le16_to_cpu(d->wTerminalType); 808 term->channels = d->bNrChannels; 809 term->chconfig = le32_to_cpu(d->bmChannelConfig); 810 term->name = d->iTerminal; 811 return 0; 812 } 813 814 static int parse_term_uac3_iterm_unit(struct mixer_build *state, 815 struct usb_audio_term *term, 816 void *p1, int id) 817 { 818 struct uac3_input_terminal_descriptor *d = p1; 819 int err; 820 821 /* call recursively to verify the referenced clock entity */ 822 err = __check_input_term(state, d->bCSourceID, term); 823 if (err < 0) 824 return err; 825 826 /* save input term properties after recursion, 827 * to ensure they are not overriden by the recursion calls 828 */ 829 term->id = id; 830 term->type = le16_to_cpu(d->wTerminalType); 831 832 err = get_cluster_channels_v3(state, le16_to_cpu(d->wClusterDescrID)); 833 if (err < 0) 834 return err; 835 term->channels = err; 836 837 /* REVISIT: UAC3 IT doesn't have channels cfg */ 838 term->chconfig = 0; 839 840 term->name = le16_to_cpu(d->wTerminalDescrStr); 841 return 0; 842 } 843 844 static int parse_term_mixer_unit(struct mixer_build *state, 845 struct usb_audio_term *term, 846 void *p1, int id) 847 { 848 struct uac_mixer_unit_descriptor *d = p1; 849 int protocol = state->mixer->protocol; 850 int err; 851 852 err = uac_mixer_unit_get_channels(state, d); 853 if (err <= 0) 854 return err; 855 856 term->type = UAC3_MIXER_UNIT << 16; /* virtual type */ 857 term->channels = err; 858 if (protocol != UAC_VERSION_3) { 859 term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol); 860 term->name = uac_mixer_unit_iMixer(d); 861 } 862 return 0; 863 } 864 865 static int parse_term_selector_unit(struct mixer_build *state, 866 struct usb_audio_term *term, 867 void *p1, int id) 868 { 869 struct uac_selector_unit_descriptor *d = p1; 870 int err; 871 872 /* call recursively to retrieve the channel info */ 873 err = __check_input_term(state, d->baSourceID[0], term); 874 if (err < 0) 875 return err; 876 term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */ 877 term->id = id; 878 if (state->mixer->protocol != UAC_VERSION_3) 879 term->name = uac_selector_unit_iSelector(d); 880 return 0; 881 } 882 883 static int parse_term_proc_unit(struct mixer_build *state, 884 struct usb_audio_term *term, 885 void *p1, int id, int vtype) 886 { 887 struct uac_processing_unit_descriptor *d = p1; 888 int protocol = state->mixer->protocol; 889 int err; 890 891 if (d->bNrInPins) { 892 /* call recursively to retrieve the channel info */ 893 err = __check_input_term(state, d->baSourceID[0], term); 894 if (err < 0) 895 return err; 896 } 897 898 term->type = vtype << 16; /* virtual type */ 899 term->id = id; 900 901 if (protocol == UAC_VERSION_3) 902 return 0; 903 904 if (!term->channels) { 905 term->channels = uac_processing_unit_bNrChannels(d); 906 term->chconfig = uac_processing_unit_wChannelConfig(d, protocol); 907 } 908 term->name = uac_processing_unit_iProcessing(d, protocol); 909 return 0; 910 } 911 912 static int parse_term_effect_unit(struct mixer_build *state, 913 struct usb_audio_term *term, 914 void *p1, int id) 915 { 916 struct uac2_effect_unit_descriptor *d = p1; 917 int err; 918 919 err = __check_input_term(state, d->bSourceID, term); 920 if (err < 0) 921 return err; 922 term->type = UAC3_EFFECT_UNIT << 16; /* virtual type */ 923 term->id = id; 924 return 0; 925 } 926 927 static int parse_term_uac2_clock_source(struct mixer_build *state, 928 struct usb_audio_term *term, 929 void *p1, int id) 930 { 931 struct uac_clock_source_descriptor *d = p1; 932 933 term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */ 934 term->id = id; 935 term->name = d->iClockSource; 936 return 0; 937 } 938 939 static int parse_term_uac3_clock_source(struct mixer_build *state, 940 struct usb_audio_term *term, 941 void *p1, int id) 942 { 943 struct uac3_clock_source_descriptor *d = p1; 944 945 term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */ 946 term->id = id; 947 term->name = le16_to_cpu(d->wClockSourceStr); 948 return 0; 949 } 950 951 #define PTYPE(a, b) ((a) << 8 | (b)) 952 953 /* 954 * parse the source unit recursively until it reaches to a terminal 955 * or a branched unit. 956 */ 957 static int __check_input_term(struct mixer_build *state, int id, 958 struct usb_audio_term *term) 959 { 960 int protocol = state->mixer->protocol; 961 void *p1; 962 unsigned char *hdr; 963 964 for (;;) { 965 /* a loop in the terminal chain? */ 966 if (test_and_set_bit(id, state->termbitmap)) 967 return -EINVAL; 968 969 p1 = find_audio_control_unit(state, id); 970 if (!p1) 971 break; 972 if (!snd_usb_validate_audio_desc(p1, protocol)) 973 break; /* bad descriptor */ 974 975 hdr = p1; 976 term->id = id; 977 978 switch (PTYPE(protocol, hdr[2])) { 979 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT): 980 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT): 981 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT): { 982 /* the header is the same for all versions */ 983 struct uac_feature_unit_descriptor *d = p1; 984 985 id = d->bSourceID; 986 break; /* continue to parse */ 987 } 988 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL): 989 return parse_term_uac1_iterm_unit(state, term, p1, id); 990 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL): 991 return parse_term_uac2_iterm_unit(state, term, p1, id); 992 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL): 993 return parse_term_uac3_iterm_unit(state, term, p1, id); 994 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT): 995 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT): 996 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT): 997 return parse_term_mixer_unit(state, term, p1, id); 998 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT): 999 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT): 1000 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR): 1001 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT): 1002 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR): 1003 return parse_term_selector_unit(state, term, p1, id); 1004 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT): 1005 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2): 1006 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT): 1007 return parse_term_proc_unit(state, term, p1, id, 1008 UAC3_PROCESSING_UNIT); 1009 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT): 1010 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT): 1011 return parse_term_effect_unit(state, term, p1, id); 1012 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT): 1013 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2): 1014 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT): 1015 return parse_term_proc_unit(state, term, p1, id, 1016 UAC3_EXTENSION_UNIT); 1017 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE): 1018 return parse_term_uac2_clock_source(state, term, p1, id); 1019 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE): 1020 return parse_term_uac3_clock_source(state, term, p1, id); 1021 default: 1022 return -ENODEV; 1023 } 1024 } 1025 return -ENODEV; 1026 } 1027 1028 1029 static int check_input_term(struct mixer_build *state, int id, 1030 struct usb_audio_term *term) 1031 { 1032 memset(term, 0, sizeof(*term)); 1033 memset(state->termbitmap, 0, sizeof(state->termbitmap)); 1034 return __check_input_term(state, id, term); 1035 } 1036 1037 /* 1038 * Feature Unit 1039 */ 1040 1041 /* feature unit control information */ 1042 struct usb_feature_control_info { 1043 int control; 1044 const char *name; 1045 int type; /* data type for uac1 */ 1046 int type_uac2; /* data type for uac2 if different from uac1, else -1 */ 1047 }; 1048 1049 static const struct usb_feature_control_info audio_feature_info[] = { 1050 { UAC_FU_MUTE, "Mute", USB_MIXER_INV_BOOLEAN, -1 }, 1051 { UAC_FU_VOLUME, "Volume", USB_MIXER_S16, -1 }, 1052 { UAC_FU_BASS, "Tone Control - Bass", USB_MIXER_S8, -1 }, 1053 { UAC_FU_MID, "Tone Control - Mid", USB_MIXER_S8, -1 }, 1054 { UAC_FU_TREBLE, "Tone Control - Treble", USB_MIXER_S8, -1 }, 1055 { UAC_FU_GRAPHIC_EQUALIZER, "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemented yet */ 1056 { UAC_FU_AUTOMATIC_GAIN, "Auto Gain Control", USB_MIXER_BOOLEAN, -1 }, 1057 { UAC_FU_DELAY, "Delay Control", USB_MIXER_U16, USB_MIXER_U32 }, 1058 { UAC_FU_BASS_BOOST, "Bass Boost", USB_MIXER_BOOLEAN, -1 }, 1059 { UAC_FU_LOUDNESS, "Loudness", USB_MIXER_BOOLEAN, -1 }, 1060 /* UAC2 specific */ 1061 { UAC2_FU_INPUT_GAIN, "Input Gain Control", USB_MIXER_S16, -1 }, 1062 { UAC2_FU_INPUT_GAIN_PAD, "Input Gain Pad Control", USB_MIXER_S16, -1 }, 1063 { UAC2_FU_PHASE_INVERTER, "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 }, 1064 }; 1065 1066 static void usb_mixer_elem_info_free(struct usb_mixer_elem_info *cval) 1067 { 1068 kfree(cval); 1069 } 1070 1071 /* private_free callback */ 1072 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl) 1073 { 1074 usb_mixer_elem_info_free(kctl->private_data); 1075 kctl->private_data = NULL; 1076 } 1077 1078 /* 1079 * interface to ALSA control for feature/mixer units 1080 */ 1081 1082 /* volume control quirks */ 1083 static void volume_control_quirks(struct usb_mixer_elem_info *cval, 1084 struct snd_kcontrol *kctl) 1085 { 1086 struct snd_usb_audio *chip = cval->head.mixer->chip; 1087 switch (chip->usb_id) { 1088 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */ 1089 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */ 1090 if (strcmp(kctl->id.name, "Effect Duration") == 0) { 1091 cval->min = 0x0000; 1092 cval->max = 0xffff; 1093 cval->res = 0x00e6; 1094 break; 1095 } 1096 if (strcmp(kctl->id.name, "Effect Volume") == 0 || 1097 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) { 1098 cval->min = 0x00; 1099 cval->max = 0xff; 1100 break; 1101 } 1102 if (strstr(kctl->id.name, "Effect Return") != NULL) { 1103 cval->min = 0xb706; 1104 cval->max = 0xff7b; 1105 cval->res = 0x0073; 1106 break; 1107 } 1108 if ((strstr(kctl->id.name, "Playback Volume") != NULL) || 1109 (strstr(kctl->id.name, "Effect Send") != NULL)) { 1110 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */ 1111 cval->max = 0xfcfe; 1112 cval->res = 0x0073; 1113 } 1114 break; 1115 1116 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */ 1117 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */ 1118 if (strcmp(kctl->id.name, "Effect Duration") == 0) { 1119 usb_audio_info(chip, 1120 "set quirk for FTU Effect Duration\n"); 1121 cval->min = 0x0000; 1122 cval->max = 0x7f00; 1123 cval->res = 0x0100; 1124 break; 1125 } 1126 if (strcmp(kctl->id.name, "Effect Volume") == 0 || 1127 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) { 1128 usb_audio_info(chip, 1129 "set quirks for FTU Effect Feedback/Volume\n"); 1130 cval->min = 0x00; 1131 cval->max = 0x7f; 1132 break; 1133 } 1134 break; 1135 1136 case USB_ID(0x0d8c, 0x0103): 1137 if (!strcmp(kctl->id.name, "PCM Playback Volume")) { 1138 usb_audio_info(chip, 1139 "set volume quirk for CM102-A+/102S+\n"); 1140 cval->min = -256; 1141 } 1142 break; 1143 1144 case USB_ID(0x0471, 0x0101): 1145 case USB_ID(0x0471, 0x0104): 1146 case USB_ID(0x0471, 0x0105): 1147 case USB_ID(0x0672, 0x1041): 1148 /* quirk for UDA1321/N101. 1149 * note that detection between firmware 2.1.1.7 (N101) 1150 * and later 2.1.1.21 is not very clear from datasheets. 1151 * I hope that the min value is -15360 for newer firmware --jk 1152 */ 1153 if (!strcmp(kctl->id.name, "PCM Playback Volume") && 1154 cval->min == -15616) { 1155 usb_audio_info(chip, 1156 "set volume quirk for UDA1321/N101 chip\n"); 1157 cval->max = -256; 1158 } 1159 break; 1160 1161 case USB_ID(0x046d, 0x09a4): 1162 if (!strcmp(kctl->id.name, "Mic Capture Volume")) { 1163 usb_audio_info(chip, 1164 "set volume quirk for QuickCam E3500\n"); 1165 cval->min = 6080; 1166 cval->max = 8768; 1167 cval->res = 192; 1168 } 1169 break; 1170 1171 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */ 1172 case USB_ID(0x046d, 0x0808): 1173 case USB_ID(0x046d, 0x0809): 1174 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */ 1175 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */ 1176 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */ 1177 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */ 1178 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */ 1179 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */ 1180 case USB_ID(0x046d, 0x0991): 1181 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */ 1182 /* Most audio usb devices lie about volume resolution. 1183 * Most Logitech webcams have res = 384. 1184 * Probably there is some logitech magic behind this number --fishor 1185 */ 1186 if (!strcmp(kctl->id.name, "Mic Capture Volume")) { 1187 usb_audio_info(chip, 1188 "set resolution quirk: cval->res = 384\n"); 1189 cval->res = 384; 1190 } 1191 break; 1192 case USB_ID(0x0495, 0x3042): /* ESS Technology Asus USB DAC */ 1193 if ((strstr(kctl->id.name, "Playback Volume") != NULL) || 1194 strstr(kctl->id.name, "Capture Volume") != NULL) { 1195 cval->min >>= 8; 1196 cval->max = 0; 1197 cval->res = 1; 1198 } 1199 break; 1200 case USB_ID(0x1224, 0x2a25): /* Jieli Technology USB PHY 2.0 */ 1201 if (!strcmp(kctl->id.name, "Mic Capture Volume")) { 1202 usb_audio_info(chip, 1203 "set resolution quirk: cval->res = 16\n"); 1204 cval->res = 16; 1205 } 1206 break; 1207 case USB_ID(0x1bcf, 0x2283): /* NexiGo N930AF FHD Webcam */ 1208 case USB_ID(0x03f0, 0x654a): /* HP 320 FHD Webcam */ 1209 if (!strcmp(kctl->id.name, "Mic Capture Volume")) { 1210 usb_audio_info(chip, 1211 "set resolution quirk: cval->res = 16\n"); 1212 cval->res = 16; 1213 } 1214 break; 1215 case USB_ID(0x1bcf, 0x2281): /* HD Webcam */ 1216 if (!strcmp(kctl->id.name, "Mic Capture Volume")) { 1217 usb_audio_info(chip, 1218 "set resolution quirk: cval->res = 16\n"); 1219 cval->res = 16; 1220 } 1221 break; 1222 } 1223 } 1224 1225 /* forcibly initialize the current mixer value; if GET_CUR fails, set to 1226 * the minimum as default 1227 */ 1228 static void init_cur_mix_raw(struct usb_mixer_elem_info *cval, int ch, int idx) 1229 { 1230 int val, err; 1231 1232 err = snd_usb_get_cur_mix_value(cval, ch, idx, &val); 1233 if (!err) 1234 return; 1235 if (!cval->head.mixer->ignore_ctl_error) 1236 usb_audio_warn(cval->head.mixer->chip, 1237 "%d:%d: failed to get current value for ch %d (%d)\n", 1238 cval->head.id, mixer_ctrl_intf(cval->head.mixer), 1239 ch, err); 1240 snd_usb_set_cur_mix_value(cval, ch, idx, cval->min); 1241 } 1242 1243 /* 1244 * retrieve the minimum and maximum values for the specified control 1245 */ 1246 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval, 1247 int default_min, struct snd_kcontrol *kctl) 1248 { 1249 int i, idx; 1250 1251 /* for failsafe */ 1252 cval->min = default_min; 1253 cval->max = cval->min + 1; 1254 cval->res = 1; 1255 cval->dBmin = cval->dBmax = 0; 1256 1257 if (cval->val_type == USB_MIXER_BOOLEAN || 1258 cval->val_type == USB_MIXER_INV_BOOLEAN) { 1259 cval->initialized = 1; 1260 } else { 1261 int minchn = 0; 1262 if (cval->cmask) { 1263 for (i = 0; i < MAX_CHANNELS; i++) 1264 if (cval->cmask & BIT(i)) { 1265 minchn = i + 1; 1266 break; 1267 } 1268 } 1269 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 || 1270 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) { 1271 usb_audio_err(cval->head.mixer->chip, 1272 "%d:%d: cannot get min/max values for control %d (id %d)\n", 1273 cval->head.id, mixer_ctrl_intf(cval->head.mixer), 1274 cval->control, cval->head.id); 1275 return -EINVAL; 1276 } 1277 if (get_ctl_value(cval, UAC_GET_RES, 1278 (cval->control << 8) | minchn, 1279 &cval->res) < 0) { 1280 cval->res = 1; 1281 } else if (cval->head.mixer->protocol == UAC_VERSION_1) { 1282 int last_valid_res = cval->res; 1283 1284 while (cval->res > 1) { 1285 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES, 1286 (cval->control << 8) | minchn, 1287 cval->res / 2) < 0) 1288 break; 1289 cval->res /= 2; 1290 } 1291 if (get_ctl_value(cval, UAC_GET_RES, 1292 (cval->control << 8) | minchn, &cval->res) < 0) 1293 cval->res = last_valid_res; 1294 } 1295 if (cval->res == 0) 1296 cval->res = 1; 1297 1298 /* Additional checks for the proper resolution 1299 * 1300 * Some devices report smaller resolutions than actually 1301 * reacting. They don't return errors but simply clip 1302 * to the lower aligned value. 1303 */ 1304 if (cval->min + cval->res < cval->max) { 1305 int last_valid_res = cval->res; 1306 int saved, test, check; 1307 if (get_cur_mix_raw(cval, minchn, &saved) < 0) 1308 goto no_res_check; 1309 for (;;) { 1310 test = saved; 1311 if (test < cval->max) 1312 test += cval->res; 1313 else 1314 test -= cval->res; 1315 if (test < cval->min || test > cval->max || 1316 snd_usb_set_cur_mix_value(cval, minchn, 0, test) || 1317 get_cur_mix_raw(cval, minchn, &check)) { 1318 cval->res = last_valid_res; 1319 break; 1320 } 1321 if (test == check) 1322 break; 1323 cval->res *= 2; 1324 } 1325 snd_usb_set_cur_mix_value(cval, minchn, 0, saved); 1326 } 1327 1328 no_res_check: 1329 cval->initialized = 1; 1330 } 1331 1332 if (kctl) 1333 volume_control_quirks(cval, kctl); 1334 1335 /* USB descriptions contain the dB scale in 1/256 dB unit 1336 * while ALSA TLV contains in 1/100 dB unit 1337 */ 1338 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256; 1339 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256; 1340 if (cval->dBmin > cval->dBmax) { 1341 /* something is wrong; assume it's either from/to 0dB */ 1342 if (cval->dBmin < 0) 1343 cval->dBmax = 0; 1344 else if (cval->dBmin > 0) 1345 cval->dBmin = 0; 1346 if (cval->dBmin > cval->dBmax) { 1347 /* totally crap, return an error */ 1348 return -EINVAL; 1349 } 1350 } else { 1351 /* if the max volume is too low, it's likely a bogus range; 1352 * here we use -96dB as the threshold 1353 */ 1354 if (cval->dBmax <= -9600) { 1355 usb_audio_info(cval->head.mixer->chip, 1356 "%d:%d: bogus dB values (%d/%d), disabling dB reporting\n", 1357 cval->head.id, mixer_ctrl_intf(cval->head.mixer), 1358 cval->dBmin, cval->dBmax); 1359 cval->dBmin = cval->dBmax = 0; 1360 } 1361 } 1362 1363 /* initialize all elements */ 1364 if (!cval->cmask) { 1365 init_cur_mix_raw(cval, 0, 0); 1366 } else { 1367 idx = 0; 1368 for (i = 0; i < MAX_CHANNELS; i++) { 1369 if (cval->cmask & BIT(i)) { 1370 init_cur_mix_raw(cval, i + 1, idx); 1371 idx++; 1372 } 1373 } 1374 } 1375 1376 return 0; 1377 } 1378 1379 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL) 1380 1381 /* get the max value advertised via control API */ 1382 static int get_max_exposed(struct usb_mixer_elem_info *cval) 1383 { 1384 if (!cval->max_exposed) { 1385 if (cval->res) 1386 cval->max_exposed = 1387 DIV_ROUND_UP(cval->max - cval->min, cval->res); 1388 else 1389 cval->max_exposed = cval->max - cval->min; 1390 } 1391 return cval->max_exposed; 1392 } 1393 1394 /* get a feature/mixer unit info */ 1395 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, 1396 struct snd_ctl_elem_info *uinfo) 1397 { 1398 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1399 1400 if (cval->val_type == USB_MIXER_BOOLEAN || 1401 cval->val_type == USB_MIXER_INV_BOOLEAN) 1402 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN; 1403 else 1404 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER; 1405 uinfo->count = cval->channels; 1406 if (cval->val_type != USB_MIXER_BOOLEAN && 1407 cval->val_type != USB_MIXER_INV_BOOLEAN) { 1408 if (!cval->initialized) { 1409 get_min_max_with_quirks(cval, 0, kcontrol); 1410 if (cval->initialized && cval->dBmin >= cval->dBmax) { 1411 kcontrol->vd[0].access &= 1412 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ | 1413 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK); 1414 snd_ctl_notify(cval->head.mixer->chip->card, 1415 SNDRV_CTL_EVENT_MASK_INFO, 1416 &kcontrol->id); 1417 } 1418 } 1419 } 1420 1421 uinfo->value.integer.min = 0; 1422 uinfo->value.integer.max = get_max_exposed(cval); 1423 return 0; 1424 } 1425 1426 /* get the current value from feature/mixer unit */ 1427 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, 1428 struct snd_ctl_elem_value *ucontrol) 1429 { 1430 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1431 int c, cnt, val, err; 1432 1433 ucontrol->value.integer.value[0] = cval->min; 1434 if (cval->cmask) { 1435 cnt = 0; 1436 for (c = 0; c < MAX_CHANNELS; c++) { 1437 if (!(cval->cmask & BIT(c))) 1438 continue; 1439 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val); 1440 if (err < 0) 1441 return filter_error(cval, err); 1442 val = get_relative_value(cval, val); 1443 ucontrol->value.integer.value[cnt] = val; 1444 cnt++; 1445 } 1446 return 0; 1447 } else { 1448 /* master channel */ 1449 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val); 1450 if (err < 0) 1451 return filter_error(cval, err); 1452 val = get_relative_value(cval, val); 1453 ucontrol->value.integer.value[0] = val; 1454 } 1455 return 0; 1456 } 1457 1458 /* put the current value to feature/mixer unit */ 1459 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, 1460 struct snd_ctl_elem_value *ucontrol) 1461 { 1462 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1463 int max_val = get_max_exposed(cval); 1464 int c, cnt, val, oval, err; 1465 int changed = 0; 1466 1467 if (cval->cmask) { 1468 cnt = 0; 1469 for (c = 0; c < MAX_CHANNELS; c++) { 1470 if (!(cval->cmask & BIT(c))) 1471 continue; 1472 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval); 1473 if (err < 0) 1474 return filter_error(cval, err); 1475 val = ucontrol->value.integer.value[cnt]; 1476 if (val < 0 || val > max_val) 1477 return -EINVAL; 1478 val = get_abs_value(cval, val); 1479 if (oval != val) { 1480 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val); 1481 changed = 1; 1482 } 1483 cnt++; 1484 } 1485 } else { 1486 /* master channel */ 1487 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval); 1488 if (err < 0) 1489 return filter_error(cval, err); 1490 val = ucontrol->value.integer.value[0]; 1491 if (val < 0 || val > max_val) 1492 return -EINVAL; 1493 val = get_abs_value(cval, val); 1494 if (val != oval) { 1495 snd_usb_set_cur_mix_value(cval, 0, 0, val); 1496 changed = 1; 1497 } 1498 } 1499 return changed; 1500 } 1501 1502 /* get the boolean value from the master channel of a UAC control */ 1503 static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol, 1504 struct snd_ctl_elem_value *ucontrol) 1505 { 1506 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1507 int val, err; 1508 1509 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val); 1510 if (err < 0) 1511 return filter_error(cval, err); 1512 val = (val != 0); 1513 ucontrol->value.integer.value[0] = val; 1514 return 0; 1515 } 1516 1517 static int get_connector_value(struct usb_mixer_elem_info *cval, 1518 char *name, int *val) 1519 { 1520 struct snd_usb_audio *chip = cval->head.mixer->chip; 1521 int idx = 0, validx, ret; 1522 1523 validx = cval->control << 8 | 0; 1524 1525 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0; 1526 if (ret) 1527 goto error; 1528 1529 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8); 1530 if (cval->head.mixer->protocol == UAC_VERSION_2) { 1531 struct uac2_connectors_ctl_blk uac2_conn; 1532 1533 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR, 1534 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN, 1535 validx, idx, &uac2_conn, sizeof(uac2_conn)); 1536 if (val) 1537 *val = !!uac2_conn.bNrChannels; 1538 } else { /* UAC_VERSION_3 */ 1539 struct uac3_insertion_ctl_blk uac3_conn; 1540 1541 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR, 1542 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN, 1543 validx, idx, &uac3_conn, sizeof(uac3_conn)); 1544 if (val) 1545 *val = !!uac3_conn.bmConInserted; 1546 } 1547 1548 snd_usb_unlock_shutdown(chip); 1549 1550 if (ret < 0) { 1551 if (name && strstr(name, "Speaker")) { 1552 if (val) 1553 *val = 1; 1554 return 0; 1555 } 1556 error: 1557 usb_audio_err(chip, 1558 "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n", 1559 UAC_GET_CUR, validx, idx, cval->val_type); 1560 1561 if (val) 1562 *val = 0; 1563 1564 return filter_error(cval, ret); 1565 } 1566 1567 return ret; 1568 } 1569 1570 /* get the connectors status and report it as boolean type */ 1571 static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol, 1572 struct snd_ctl_elem_value *ucontrol) 1573 { 1574 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1575 int ret, val; 1576 1577 ret = get_connector_value(cval, kcontrol->id.name, &val); 1578 1579 if (ret < 0) 1580 return ret; 1581 1582 ucontrol->value.integer.value[0] = val; 1583 return 0; 1584 } 1585 1586 static const struct snd_kcontrol_new usb_feature_unit_ctl = { 1587 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 1588 .name = "", /* will be filled later manually */ 1589 .info = mixer_ctl_feature_info, 1590 .get = mixer_ctl_feature_get, 1591 .put = mixer_ctl_feature_put, 1592 }; 1593 1594 /* the read-only variant */ 1595 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = { 1596 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 1597 .name = "", /* will be filled later manually */ 1598 .info = mixer_ctl_feature_info, 1599 .get = mixer_ctl_feature_get, 1600 .put = NULL, 1601 }; 1602 1603 /* 1604 * A control which shows the boolean value from reading a UAC control on 1605 * the master channel. 1606 */ 1607 static const struct snd_kcontrol_new usb_bool_master_control_ctl_ro = { 1608 .iface = SNDRV_CTL_ELEM_IFACE_CARD, 1609 .name = "", /* will be filled later manually */ 1610 .access = SNDRV_CTL_ELEM_ACCESS_READ, 1611 .info = snd_ctl_boolean_mono_info, 1612 .get = mixer_ctl_master_bool_get, 1613 .put = NULL, 1614 }; 1615 1616 static const struct snd_kcontrol_new usb_connector_ctl_ro = { 1617 .iface = SNDRV_CTL_ELEM_IFACE_CARD, 1618 .name = "", /* will be filled later manually */ 1619 .access = SNDRV_CTL_ELEM_ACCESS_READ, 1620 .info = snd_ctl_boolean_mono_info, 1621 .get = mixer_ctl_connector_get, 1622 .put = NULL, 1623 }; 1624 1625 /* 1626 * This symbol is exported in order to allow the mixer quirks to 1627 * hook up to the standard feature unit control mechanism 1628 */ 1629 const struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl; 1630 1631 /* 1632 * build a feature control 1633 */ 1634 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str) 1635 { 1636 return strlcat(kctl->id.name, str, sizeof(kctl->id.name)); 1637 } 1638 1639 /* 1640 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we 1641 * rename it to "Headphone". We determine if something is a headphone 1642 * similar to how udev determines form factor. 1643 */ 1644 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl, 1645 struct snd_card *card) 1646 { 1647 static const char * const names_to_check[] = { 1648 "Headset", "headset", "Headphone", "headphone", NULL}; 1649 const char * const *s; 1650 bool found = false; 1651 1652 if (strcmp("Speaker", kctl->id.name)) 1653 return; 1654 1655 for (s = names_to_check; *s; s++) 1656 if (strstr(card->shortname, *s)) { 1657 found = true; 1658 break; 1659 } 1660 1661 if (!found) 1662 return; 1663 1664 snd_ctl_rename(card, kctl, "Headphone"); 1665 } 1666 1667 static const struct usb_feature_control_info *get_feature_control_info(int control) 1668 { 1669 int i; 1670 1671 for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) { 1672 if (audio_feature_info[i].control == control) 1673 return &audio_feature_info[i]; 1674 } 1675 return NULL; 1676 } 1677 1678 static void __build_feature_ctl(struct usb_mixer_interface *mixer, 1679 const struct usbmix_name_map *imap, 1680 unsigned int ctl_mask, int control, 1681 struct usb_audio_term *iterm, 1682 struct usb_audio_term *oterm, 1683 int unitid, int nameid, int readonly_mask) 1684 { 1685 const struct usb_feature_control_info *ctl_info; 1686 unsigned int len = 0; 1687 int mapped_name = 0; 1688 struct snd_kcontrol *kctl; 1689 struct usb_mixer_elem_info *cval; 1690 const struct usbmix_name_map *map; 1691 unsigned int range; 1692 1693 if (control == UAC_FU_GRAPHIC_EQUALIZER) { 1694 /* FIXME: not supported yet */ 1695 return; 1696 } 1697 1698 map = find_map(imap, unitid, control); 1699 if (check_ignored_ctl(map)) 1700 return; 1701 1702 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1703 if (!cval) 1704 return; 1705 snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid); 1706 cval->control = control; 1707 cval->cmask = ctl_mask; 1708 1709 ctl_info = get_feature_control_info(control); 1710 if (!ctl_info) { 1711 usb_mixer_elem_info_free(cval); 1712 return; 1713 } 1714 if (mixer->protocol == UAC_VERSION_1) 1715 cval->val_type = ctl_info->type; 1716 else /* UAC_VERSION_2 */ 1717 cval->val_type = ctl_info->type_uac2 >= 0 ? 1718 ctl_info->type_uac2 : ctl_info->type; 1719 1720 if (ctl_mask == 0) { 1721 cval->channels = 1; /* master channel */ 1722 cval->master_readonly = readonly_mask; 1723 } else { 1724 int i, c = 0; 1725 for (i = 0; i < 16; i++) 1726 if (ctl_mask & BIT(i)) 1727 c++; 1728 cval->channels = c; 1729 cval->ch_readonly = readonly_mask; 1730 } 1731 1732 /* 1733 * If all channels in the mask are marked read-only, make the control 1734 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't 1735 * issue write commands to read-only channels. 1736 */ 1737 if (cval->channels == readonly_mask) 1738 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval); 1739 else 1740 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval); 1741 1742 if (!kctl) { 1743 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n"); 1744 usb_mixer_elem_info_free(cval); 1745 return; 1746 } 1747 kctl->private_free = snd_usb_mixer_elem_free; 1748 1749 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)); 1750 mapped_name = len != 0; 1751 if (!len && nameid) 1752 len = snd_usb_copy_string_desc(mixer->chip, nameid, 1753 kctl->id.name, sizeof(kctl->id.name)); 1754 1755 switch (control) { 1756 case UAC_FU_MUTE: 1757 case UAC_FU_VOLUME: 1758 /* 1759 * determine the control name. the rule is: 1760 * - if a name id is given in descriptor, use it. 1761 * - if the connected input can be determined, then use the name 1762 * of terminal type. 1763 * - if the connected output can be determined, use it. 1764 * - otherwise, anonymous name. 1765 */ 1766 if (!len) { 1767 if (iterm) 1768 len = get_term_name(mixer->chip, iterm, 1769 kctl->id.name, 1770 sizeof(kctl->id.name), 1); 1771 if (!len && oterm) 1772 len = get_term_name(mixer->chip, oterm, 1773 kctl->id.name, 1774 sizeof(kctl->id.name), 1); 1775 if (!len) 1776 snprintf(kctl->id.name, sizeof(kctl->id.name), 1777 "Feature %d", unitid); 1778 } 1779 1780 if (!mapped_name) 1781 check_no_speaker_on_headset(kctl, mixer->chip->card); 1782 1783 /* 1784 * determine the stream direction: 1785 * if the connected output is USB stream, then it's likely a 1786 * capture stream. otherwise it should be playback (hopefully :) 1787 */ 1788 if (!mapped_name && oterm && !(oterm->type >> 16)) { 1789 if ((oterm->type & 0xff00) == 0x0100) 1790 append_ctl_name(kctl, " Capture"); 1791 else 1792 append_ctl_name(kctl, " Playback"); 1793 } 1794 append_ctl_name(kctl, control == UAC_FU_MUTE ? 1795 " Switch" : " Volume"); 1796 break; 1797 default: 1798 if (!len) 1799 strscpy(kctl->id.name, audio_feature_info[control-1].name, 1800 sizeof(kctl->id.name)); 1801 break; 1802 } 1803 1804 /* get min/max values */ 1805 get_min_max_with_quirks(cval, 0, kctl); 1806 1807 /* skip a bogus volume range */ 1808 if (cval->max <= cval->min) { 1809 usb_audio_dbg(mixer->chip, 1810 "[%d] FU [%s] skipped due to invalid volume\n", 1811 cval->head.id, kctl->id.name); 1812 snd_ctl_free_one(kctl); 1813 return; 1814 } 1815 1816 1817 if (control == UAC_FU_VOLUME) { 1818 check_mapped_dB(map, cval); 1819 if (cval->dBmin < cval->dBmax || !cval->initialized) { 1820 kctl->tlv.c = snd_usb_mixer_vol_tlv; 1821 kctl->vd[0].access |= 1822 SNDRV_CTL_ELEM_ACCESS_TLV_READ | 1823 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK; 1824 } 1825 } 1826 1827 snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl); 1828 1829 range = (cval->max - cval->min) / cval->res; 1830 /* 1831 * Are there devices with volume range more than 255? I use a bit more 1832 * to be sure. 384 is a resolution magic number found on Logitech 1833 * devices. It will definitively catch all buggy Logitech devices. 1834 */ 1835 if (range > 384) { 1836 usb_audio_warn(mixer->chip, 1837 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.", 1838 range); 1839 usb_audio_warn(mixer->chip, 1840 "[%d] FU [%s] ch = %d, val = %d/%d/%d", 1841 cval->head.id, kctl->id.name, cval->channels, 1842 cval->min, cval->max, cval->res); 1843 } 1844 1845 usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n", 1846 cval->head.id, kctl->id.name, cval->channels, 1847 cval->min, cval->max, cval->res); 1848 snd_usb_mixer_add_control(&cval->head, kctl); 1849 } 1850 1851 static void build_feature_ctl(struct mixer_build *state, void *raw_desc, 1852 unsigned int ctl_mask, int control, 1853 struct usb_audio_term *iterm, int unitid, 1854 int readonly_mask) 1855 { 1856 struct uac_feature_unit_descriptor *desc = raw_desc; 1857 int nameid = uac_feature_unit_iFeature(desc); 1858 1859 __build_feature_ctl(state->mixer, state->map, ctl_mask, control, 1860 iterm, &state->oterm, unitid, nameid, readonly_mask); 1861 } 1862 1863 static void build_feature_ctl_badd(struct usb_mixer_interface *mixer, 1864 unsigned int ctl_mask, int control, int unitid, 1865 const struct usbmix_name_map *badd_map) 1866 { 1867 __build_feature_ctl(mixer, badd_map, ctl_mask, control, 1868 NULL, NULL, unitid, 0, 0); 1869 } 1870 1871 static void get_connector_control_name(struct usb_mixer_interface *mixer, 1872 struct usb_audio_term *term, 1873 bool is_input, char *name, int name_size) 1874 { 1875 int name_len = get_term_name(mixer->chip, term, name, name_size, 0); 1876 1877 if (name_len == 0) 1878 strscpy(name, "Unknown", name_size); 1879 1880 /* 1881 * sound/core/ctljack.c has a convention of naming jack controls 1882 * by ending in " Jack". Make it slightly more useful by 1883 * indicating Input or Output after the terminal name. 1884 */ 1885 if (is_input) 1886 strlcat(name, " - Input Jack", name_size); 1887 else 1888 strlcat(name, " - Output Jack", name_size); 1889 } 1890 1891 /* get connector value to "wake up" the USB audio */ 1892 static int connector_mixer_resume(struct usb_mixer_elem_list *list) 1893 { 1894 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list); 1895 1896 get_connector_value(cval, NULL, NULL); 1897 return 0; 1898 } 1899 1900 /* Build a mixer control for a UAC connector control (jack-detect) */ 1901 static void build_connector_control(struct usb_mixer_interface *mixer, 1902 const struct usbmix_name_map *imap, 1903 struct usb_audio_term *term, bool is_input) 1904 { 1905 struct snd_kcontrol *kctl; 1906 struct usb_mixer_elem_info *cval; 1907 const struct usbmix_name_map *map; 1908 1909 map = find_map(imap, term->id, 0); 1910 if (check_ignored_ctl(map)) 1911 return; 1912 1913 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1914 if (!cval) 1915 return; 1916 snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id); 1917 1918 /* set up a specific resume callback */ 1919 cval->head.resume = connector_mixer_resume; 1920 1921 /* 1922 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the 1923 * number of channels connected. 1924 * 1925 * UAC3: The first byte specifies size of bitmap for the inserted controls. The 1926 * following byte(s) specifies which connectors are inserted. 1927 * 1928 * This boolean ctl will simply report if any channels are connected 1929 * or not. 1930 */ 1931 if (mixer->protocol == UAC_VERSION_2) 1932 cval->control = UAC2_TE_CONNECTOR; 1933 else /* UAC_VERSION_3 */ 1934 cval->control = UAC3_TE_INSERTION; 1935 1936 cval->val_type = USB_MIXER_BOOLEAN; 1937 cval->channels = 1; /* report true if any channel is connected */ 1938 cval->min = 0; 1939 cval->max = 1; 1940 kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval); 1941 if (!kctl) { 1942 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n"); 1943 usb_mixer_elem_info_free(cval); 1944 return; 1945 } 1946 1947 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) 1948 strlcat(kctl->id.name, " Jack", sizeof(kctl->id.name)); 1949 else 1950 get_connector_control_name(mixer, term, is_input, kctl->id.name, 1951 sizeof(kctl->id.name)); 1952 kctl->private_free = snd_usb_mixer_elem_free; 1953 snd_usb_mixer_add_control(&cval->head, kctl); 1954 } 1955 1956 static int parse_clock_source_unit(struct mixer_build *state, int unitid, 1957 void *_ftr) 1958 { 1959 struct uac_clock_source_descriptor *hdr = _ftr; 1960 struct usb_mixer_elem_info *cval; 1961 struct snd_kcontrol *kctl; 1962 int ret; 1963 1964 if (state->mixer->protocol != UAC_VERSION_2) 1965 return -EINVAL; 1966 1967 /* 1968 * The only property of this unit we are interested in is the 1969 * clock source validity. If that isn't readable, just bail out. 1970 */ 1971 if (!uac_v2v3_control_is_readable(hdr->bmControls, 1972 UAC2_CS_CONTROL_CLOCK_VALID)) 1973 return 0; 1974 1975 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1976 if (!cval) 1977 return -ENOMEM; 1978 1979 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID); 1980 1981 cval->min = 0; 1982 cval->max = 1; 1983 cval->channels = 1; 1984 cval->val_type = USB_MIXER_BOOLEAN; 1985 cval->control = UAC2_CS_CONTROL_CLOCK_VALID; 1986 1987 cval->master_readonly = 1; 1988 /* From UAC2 5.2.5.1.2 "Only the get request is supported." */ 1989 kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval); 1990 1991 if (!kctl) { 1992 usb_mixer_elem_info_free(cval); 1993 return -ENOMEM; 1994 } 1995 1996 kctl->private_free = snd_usb_mixer_elem_free; 1997 ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource, 1998 kctl->id.name, sizeof(kctl->id.name)); 1999 if (ret > 0) 2000 append_ctl_name(kctl, " Validity"); 2001 else 2002 snprintf(kctl->id.name, sizeof(kctl->id.name), 2003 "Clock Source %d Validity", hdr->bClockID); 2004 2005 return snd_usb_mixer_add_control(&cval->head, kctl); 2006 } 2007 2008 /* 2009 * parse a feature unit 2010 * 2011 * most of controls are defined here. 2012 */ 2013 static int parse_audio_feature_unit(struct mixer_build *state, int unitid, 2014 void *_ftr) 2015 { 2016 int channels, i, j; 2017 struct usb_audio_term iterm; 2018 unsigned int master_bits; 2019 int err, csize; 2020 struct uac_feature_unit_descriptor *hdr = _ftr; 2021 __u8 *bmaControls; 2022 2023 if (state->mixer->protocol == UAC_VERSION_1) { 2024 csize = hdr->bControlSize; 2025 channels = (hdr->bLength - 7) / csize - 1; 2026 bmaControls = hdr->bmaControls; 2027 } else if (state->mixer->protocol == UAC_VERSION_2) { 2028 struct uac2_feature_unit_descriptor *ftr = _ftr; 2029 csize = 4; 2030 channels = (hdr->bLength - 6) / 4 - 1; 2031 bmaControls = ftr->bmaControls; 2032 } else { /* UAC_VERSION_3 */ 2033 struct uac3_feature_unit_descriptor *ftr = _ftr; 2034 2035 csize = 4; 2036 channels = (ftr->bLength - 7) / 4 - 1; 2037 bmaControls = ftr->bmaControls; 2038 } 2039 2040 if (channels > 32) { 2041 usb_audio_info(state->chip, 2042 "usbmixer: too many channels (%d) in unit %d\n", 2043 channels, unitid); 2044 return -EINVAL; 2045 } 2046 2047 /* parse the source unit */ 2048 err = parse_audio_unit(state, hdr->bSourceID); 2049 if (err < 0) 2050 return err; 2051 2052 /* determine the input source type and name */ 2053 err = check_input_term(state, hdr->bSourceID, &iterm); 2054 if (err < 0) 2055 return err; 2056 2057 master_bits = snd_usb_combine_bytes(bmaControls, csize); 2058 /* master configuration quirks */ 2059 switch (state->chip->usb_id) { 2060 case USB_ID(0x08bb, 0x2702): 2061 usb_audio_info(state->chip, 2062 "usbmixer: master volume quirk for PCM2702 chip\n"); 2063 /* disable non-functional volume control */ 2064 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME); 2065 break; 2066 case USB_ID(0x1130, 0xf211): 2067 usb_audio_info(state->chip, 2068 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n"); 2069 /* disable non-functional volume control */ 2070 channels = 0; 2071 break; 2072 2073 } 2074 2075 if (state->mixer->protocol == UAC_VERSION_1) { 2076 /* check all control types */ 2077 for (i = 0; i < 10; i++) { 2078 unsigned int ch_bits = 0; 2079 int control = audio_feature_info[i].control; 2080 2081 for (j = 0; j < channels; j++) { 2082 unsigned int mask; 2083 2084 mask = snd_usb_combine_bytes(bmaControls + 2085 csize * (j+1), csize); 2086 if (mask & BIT(i)) 2087 ch_bits |= BIT(j); 2088 } 2089 /* audio class v1 controls are never read-only */ 2090 2091 /* 2092 * The first channel must be set 2093 * (for ease of programming). 2094 */ 2095 if (ch_bits & 1) 2096 build_feature_ctl(state, _ftr, ch_bits, control, 2097 &iterm, unitid, 0); 2098 if (master_bits & BIT(i)) 2099 build_feature_ctl(state, _ftr, 0, control, 2100 &iterm, unitid, 0); 2101 } 2102 } else { /* UAC_VERSION_2/3 */ 2103 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) { 2104 unsigned int ch_bits = 0; 2105 unsigned int ch_read_only = 0; 2106 int control = audio_feature_info[i].control; 2107 2108 for (j = 0; j < channels; j++) { 2109 unsigned int mask; 2110 2111 mask = snd_usb_combine_bytes(bmaControls + 2112 csize * (j+1), csize); 2113 if (uac_v2v3_control_is_readable(mask, control)) { 2114 ch_bits |= BIT(j); 2115 if (!uac_v2v3_control_is_writeable(mask, control)) 2116 ch_read_only |= BIT(j); 2117 } 2118 } 2119 2120 /* 2121 * NOTE: build_feature_ctl() will mark the control 2122 * read-only if all channels are marked read-only in 2123 * the descriptors. Otherwise, the control will be 2124 * reported as writeable, but the driver will not 2125 * actually issue a write command for read-only 2126 * channels. 2127 */ 2128 2129 /* 2130 * The first channel must be set 2131 * (for ease of programming). 2132 */ 2133 if (ch_bits & 1) 2134 build_feature_ctl(state, _ftr, ch_bits, control, 2135 &iterm, unitid, ch_read_only); 2136 if (uac_v2v3_control_is_readable(master_bits, control)) 2137 build_feature_ctl(state, _ftr, 0, control, 2138 &iterm, unitid, 2139 !uac_v2v3_control_is_writeable(master_bits, 2140 control)); 2141 } 2142 } 2143 2144 return 0; 2145 } 2146 2147 /* 2148 * Mixer Unit 2149 */ 2150 2151 /* check whether the given in/out overflows bmMixerControls matrix */ 2152 static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc, 2153 int protocol, int num_ins, int num_outs) 2154 { 2155 u8 *hdr = (u8 *)desc; 2156 u8 *c = uac_mixer_unit_bmControls(desc, protocol); 2157 size_t rest; /* remaining bytes after bmMixerControls */ 2158 2159 switch (protocol) { 2160 case UAC_VERSION_1: 2161 default: 2162 rest = 1; /* iMixer */ 2163 break; 2164 case UAC_VERSION_2: 2165 rest = 2; /* bmControls + iMixer */ 2166 break; 2167 case UAC_VERSION_3: 2168 rest = 6; /* bmControls + wMixerDescrStr */ 2169 break; 2170 } 2171 2172 /* overflow? */ 2173 return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0]; 2174 } 2175 2176 /* 2177 * build a mixer unit control 2178 * 2179 * the callbacks are identical with feature unit. 2180 * input channel number (zero based) is given in control field instead. 2181 */ 2182 static void build_mixer_unit_ctl(struct mixer_build *state, 2183 struct uac_mixer_unit_descriptor *desc, 2184 int in_pin, int in_ch, int num_outs, 2185 int unitid, struct usb_audio_term *iterm) 2186 { 2187 struct usb_mixer_elem_info *cval; 2188 unsigned int i, len; 2189 struct snd_kcontrol *kctl; 2190 const struct usbmix_name_map *map; 2191 2192 map = find_map(state->map, unitid, 0); 2193 if (check_ignored_ctl(map)) 2194 return; 2195 2196 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 2197 if (!cval) 2198 return; 2199 2200 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid); 2201 cval->control = in_ch + 1; /* based on 1 */ 2202 cval->val_type = USB_MIXER_S16; 2203 for (i = 0; i < num_outs; i++) { 2204 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol); 2205 2206 if (check_matrix_bitmap(c, in_ch, i, num_outs)) { 2207 cval->cmask |= BIT(i); 2208 cval->channels++; 2209 } 2210 } 2211 2212 /* get min/max values */ 2213 get_min_max(cval, 0); 2214 2215 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval); 2216 if (!kctl) { 2217 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 2218 usb_mixer_elem_info_free(cval); 2219 return; 2220 } 2221 kctl->private_free = snd_usb_mixer_elem_free; 2222 2223 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)); 2224 if (!len) 2225 len = get_term_name(state->chip, iterm, kctl->id.name, 2226 sizeof(kctl->id.name), 0); 2227 if (!len) 2228 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1); 2229 append_ctl_name(kctl, " Volume"); 2230 2231 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n", 2232 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max); 2233 snd_usb_mixer_add_control(&cval->head, kctl); 2234 } 2235 2236 static int parse_audio_input_terminal(struct mixer_build *state, int unitid, 2237 void *raw_desc) 2238 { 2239 struct usb_audio_term iterm; 2240 unsigned int control, bmctls, term_id; 2241 2242 if (state->mixer->protocol == UAC_VERSION_2) { 2243 struct uac2_input_terminal_descriptor *d_v2 = raw_desc; 2244 control = UAC2_TE_CONNECTOR; 2245 term_id = d_v2->bTerminalID; 2246 bmctls = le16_to_cpu(d_v2->bmControls); 2247 } else if (state->mixer->protocol == UAC_VERSION_3) { 2248 struct uac3_input_terminal_descriptor *d_v3 = raw_desc; 2249 control = UAC3_TE_INSERTION; 2250 term_id = d_v3->bTerminalID; 2251 bmctls = le32_to_cpu(d_v3->bmControls); 2252 } else { 2253 return 0; /* UAC1. No Insertion control */ 2254 } 2255 2256 check_input_term(state, term_id, &iterm); 2257 2258 /* Check for jack detection. */ 2259 if ((iterm.type & 0xff00) != 0x0100 && 2260 uac_v2v3_control_is_readable(bmctls, control)) 2261 build_connector_control(state->mixer, state->map, &iterm, true); 2262 2263 return 0; 2264 } 2265 2266 /* 2267 * parse a mixer unit 2268 */ 2269 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, 2270 void *raw_desc) 2271 { 2272 struct uac_mixer_unit_descriptor *desc = raw_desc; 2273 struct usb_audio_term iterm; 2274 int input_pins, num_ins, num_outs; 2275 int pin, ich, err; 2276 2277 err = uac_mixer_unit_get_channels(state, desc); 2278 if (err < 0) { 2279 usb_audio_err(state->chip, 2280 "invalid MIXER UNIT descriptor %d\n", 2281 unitid); 2282 return err; 2283 } 2284 2285 num_outs = err; 2286 input_pins = desc->bNrInPins; 2287 2288 num_ins = 0; 2289 ich = 0; 2290 for (pin = 0; pin < input_pins; pin++) { 2291 err = parse_audio_unit(state, desc->baSourceID[pin]); 2292 if (err < 0) 2293 continue; 2294 /* no bmControls field (e.g. Maya44) -> ignore */ 2295 if (!num_outs) 2296 continue; 2297 err = check_input_term(state, desc->baSourceID[pin], &iterm); 2298 if (err < 0) 2299 return err; 2300 num_ins += iterm.channels; 2301 if (mixer_bitmap_overflow(desc, state->mixer->protocol, 2302 num_ins, num_outs)) 2303 break; 2304 for (; ich < num_ins; ich++) { 2305 int och, ich_has_controls = 0; 2306 2307 for (och = 0; och < num_outs; och++) { 2308 __u8 *c = uac_mixer_unit_bmControls(desc, 2309 state->mixer->protocol); 2310 2311 if (check_matrix_bitmap(c, ich, och, num_outs)) { 2312 ich_has_controls = 1; 2313 break; 2314 } 2315 } 2316 if (ich_has_controls) 2317 build_mixer_unit_ctl(state, desc, pin, ich, num_outs, 2318 unitid, &iterm); 2319 } 2320 } 2321 return 0; 2322 } 2323 2324 /* 2325 * Processing Unit / Extension Unit 2326 */ 2327 2328 /* get callback for processing/extension unit */ 2329 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, 2330 struct snd_ctl_elem_value *ucontrol) 2331 { 2332 struct usb_mixer_elem_info *cval = kcontrol->private_data; 2333 int err, val; 2334 2335 err = get_cur_ctl_value(cval, cval->control << 8, &val); 2336 if (err < 0) { 2337 ucontrol->value.integer.value[0] = cval->min; 2338 return filter_error(cval, err); 2339 } 2340 val = get_relative_value(cval, val); 2341 ucontrol->value.integer.value[0] = val; 2342 return 0; 2343 } 2344 2345 /* put callback for processing/extension unit */ 2346 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, 2347 struct snd_ctl_elem_value *ucontrol) 2348 { 2349 struct usb_mixer_elem_info *cval = kcontrol->private_data; 2350 int val, oval, err; 2351 2352 err = get_cur_ctl_value(cval, cval->control << 8, &oval); 2353 if (err < 0) 2354 return filter_error(cval, err); 2355 val = ucontrol->value.integer.value[0]; 2356 if (val < 0 || val > get_max_exposed(cval)) 2357 return -EINVAL; 2358 val = get_abs_value(cval, val); 2359 if (val != oval) { 2360 set_cur_ctl_value(cval, cval->control << 8, val); 2361 return 1; 2362 } 2363 return 0; 2364 } 2365 2366 /* alsa control interface for processing/extension unit */ 2367 static const struct snd_kcontrol_new mixer_procunit_ctl = { 2368 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 2369 .name = "", /* will be filled later */ 2370 .info = mixer_ctl_feature_info, 2371 .get = mixer_ctl_procunit_get, 2372 .put = mixer_ctl_procunit_put, 2373 }; 2374 2375 /* 2376 * predefined data for processing units 2377 */ 2378 struct procunit_value_info { 2379 int control; 2380 const char *suffix; 2381 int val_type; 2382 int min_value; 2383 }; 2384 2385 struct procunit_info { 2386 int type; 2387 char *name; 2388 const struct procunit_value_info *values; 2389 }; 2390 2391 static const struct procunit_value_info undefined_proc_info[] = { 2392 { 0x00, "Control Undefined", 0 }, 2393 { 0 } 2394 }; 2395 2396 static const struct procunit_value_info updown_proc_info[] = { 2397 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 2398 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 }, 2399 { 0 } 2400 }; 2401 static const struct procunit_value_info prologic_proc_info[] = { 2402 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 2403 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 }, 2404 { 0 } 2405 }; 2406 static const struct procunit_value_info threed_enh_proc_info[] = { 2407 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 2408 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 }, 2409 { 0 } 2410 }; 2411 static const struct procunit_value_info reverb_proc_info[] = { 2412 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 2413 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 }, 2414 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 }, 2415 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 }, 2416 { 0 } 2417 }; 2418 static const struct procunit_value_info chorus_proc_info[] = { 2419 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 2420 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 }, 2421 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 }, 2422 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 }, 2423 { 0 } 2424 }; 2425 static const struct procunit_value_info dcr_proc_info[] = { 2426 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 2427 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 }, 2428 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 }, 2429 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 }, 2430 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 }, 2431 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 }, 2432 { 0 } 2433 }; 2434 2435 static const struct procunit_info procunits[] = { 2436 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info }, 2437 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info }, 2438 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info }, 2439 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info }, 2440 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info }, 2441 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info }, 2442 { 0 }, 2443 }; 2444 2445 static const struct procunit_value_info uac3_updown_proc_info[] = { 2446 { UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 }, 2447 { 0 } 2448 }; 2449 static const struct procunit_value_info uac3_stereo_ext_proc_info[] = { 2450 { UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 }, 2451 { 0 } 2452 }; 2453 2454 static const struct procunit_info uac3_procunits[] = { 2455 { UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info }, 2456 { UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info }, 2457 { UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info }, 2458 { 0 }, 2459 }; 2460 2461 /* 2462 * predefined data for extension units 2463 */ 2464 static const struct procunit_value_info clock_rate_xu_info[] = { 2465 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 }, 2466 { 0 } 2467 }; 2468 static const struct procunit_value_info clock_source_xu_info[] = { 2469 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN }, 2470 { 0 } 2471 }; 2472 static const struct procunit_value_info spdif_format_xu_info[] = { 2473 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN }, 2474 { 0 } 2475 }; 2476 static const struct procunit_value_info soft_limit_xu_info[] = { 2477 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN }, 2478 { 0 } 2479 }; 2480 static const struct procunit_info extunits[] = { 2481 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info }, 2482 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info }, 2483 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info }, 2484 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info }, 2485 { 0 } 2486 }; 2487 2488 /* 2489 * build a processing/extension unit 2490 */ 2491 static int build_audio_procunit(struct mixer_build *state, int unitid, 2492 void *raw_desc, const struct procunit_info *list, 2493 bool extension_unit) 2494 { 2495 struct uac_processing_unit_descriptor *desc = raw_desc; 2496 int num_ins; 2497 struct usb_mixer_elem_info *cval; 2498 struct snd_kcontrol *kctl; 2499 int i, err, nameid, type, len, val; 2500 const struct procunit_info *info; 2501 const struct procunit_value_info *valinfo; 2502 const struct usbmix_name_map *map; 2503 static const struct procunit_value_info default_value_info[] = { 2504 { 0x01, "Switch", USB_MIXER_BOOLEAN }, 2505 { 0 } 2506 }; 2507 static const struct procunit_info default_info = { 2508 0, NULL, default_value_info 2509 }; 2510 const char *name = extension_unit ? 2511 "Extension Unit" : "Processing Unit"; 2512 2513 num_ins = desc->bNrInPins; 2514 for (i = 0; i < num_ins; i++) { 2515 err = parse_audio_unit(state, desc->baSourceID[i]); 2516 if (err < 0) 2517 return err; 2518 } 2519 2520 type = le16_to_cpu(desc->wProcessType); 2521 for (info = list; info && info->type; info++) 2522 if (info->type == type) 2523 break; 2524 if (!info || !info->type) 2525 info = &default_info; 2526 2527 for (valinfo = info->values; valinfo->control; valinfo++) { 2528 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol); 2529 2530 if (state->mixer->protocol == UAC_VERSION_1) { 2531 if (!(controls[valinfo->control / 8] & 2532 BIT((valinfo->control % 8) - 1))) 2533 continue; 2534 } else { /* UAC_VERSION_2/3 */ 2535 if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8], 2536 valinfo->control)) 2537 continue; 2538 } 2539 2540 map = find_map(state->map, unitid, valinfo->control); 2541 if (check_ignored_ctl(map)) 2542 continue; 2543 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 2544 if (!cval) 2545 return -ENOMEM; 2546 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid); 2547 cval->control = valinfo->control; 2548 cval->val_type = valinfo->val_type; 2549 cval->channels = 1; 2550 2551 if (state->mixer->protocol > UAC_VERSION_1 && 2552 !uac_v2v3_control_is_writeable(controls[valinfo->control / 8], 2553 valinfo->control)) 2554 cval->master_readonly = 1; 2555 2556 /* get min/max values */ 2557 switch (type) { 2558 case UAC_PROCESS_UP_DOWNMIX: { 2559 bool mode_sel = false; 2560 2561 switch (state->mixer->protocol) { 2562 case UAC_VERSION_1: 2563 case UAC_VERSION_2: 2564 default: 2565 if (cval->control == UAC_UD_MODE_SELECT) 2566 mode_sel = true; 2567 break; 2568 case UAC_VERSION_3: 2569 if (cval->control == UAC3_UD_MODE_SELECT) 2570 mode_sel = true; 2571 break; 2572 } 2573 2574 if (mode_sel) { 2575 __u8 *control_spec = uac_processing_unit_specific(desc, 2576 state->mixer->protocol); 2577 cval->min = 1; 2578 cval->max = control_spec[0]; 2579 cval->res = 1; 2580 cval->initialized = 1; 2581 break; 2582 } 2583 2584 get_min_max(cval, valinfo->min_value); 2585 break; 2586 } 2587 case USB_XU_CLOCK_RATE: 2588 /* 2589 * E-Mu USB 0404/0202/TrackerPre/0204 2590 * samplerate control quirk 2591 */ 2592 cval->min = 0; 2593 cval->max = 5; 2594 cval->res = 1; 2595 cval->initialized = 1; 2596 break; 2597 default: 2598 get_min_max(cval, valinfo->min_value); 2599 break; 2600 } 2601 2602 err = get_cur_ctl_value(cval, cval->control << 8, &val); 2603 if (err < 0) { 2604 usb_mixer_elem_info_free(cval); 2605 return -EINVAL; 2606 } 2607 2608 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval); 2609 if (!kctl) { 2610 usb_mixer_elem_info_free(cval); 2611 return -ENOMEM; 2612 } 2613 kctl->private_free = snd_usb_mixer_elem_free; 2614 2615 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) { 2616 /* nothing */ ; 2617 } else if (info->name) { 2618 strscpy(kctl->id.name, info->name, sizeof(kctl->id.name)); 2619 } else { 2620 if (extension_unit) 2621 nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol); 2622 else 2623 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol); 2624 len = 0; 2625 if (nameid) 2626 len = snd_usb_copy_string_desc(state->chip, 2627 nameid, 2628 kctl->id.name, 2629 sizeof(kctl->id.name)); 2630 if (!len) 2631 strscpy(kctl->id.name, name, sizeof(kctl->id.name)); 2632 } 2633 append_ctl_name(kctl, " "); 2634 append_ctl_name(kctl, valinfo->suffix); 2635 2636 usb_audio_dbg(state->chip, 2637 "[%d] PU [%s] ch = %d, val = %d/%d\n", 2638 cval->head.id, kctl->id.name, cval->channels, 2639 cval->min, cval->max); 2640 2641 err = snd_usb_mixer_add_control(&cval->head, kctl); 2642 if (err < 0) 2643 return err; 2644 } 2645 return 0; 2646 } 2647 2648 static int parse_audio_processing_unit(struct mixer_build *state, int unitid, 2649 void *raw_desc) 2650 { 2651 switch (state->mixer->protocol) { 2652 case UAC_VERSION_1: 2653 case UAC_VERSION_2: 2654 default: 2655 return build_audio_procunit(state, unitid, raw_desc, 2656 procunits, false); 2657 case UAC_VERSION_3: 2658 return build_audio_procunit(state, unitid, raw_desc, 2659 uac3_procunits, false); 2660 } 2661 } 2662 2663 static int parse_audio_extension_unit(struct mixer_build *state, int unitid, 2664 void *raw_desc) 2665 { 2666 /* 2667 * Note that we parse extension units with processing unit descriptors. 2668 * That's ok as the layout is the same. 2669 */ 2670 return build_audio_procunit(state, unitid, raw_desc, extunits, true); 2671 } 2672 2673 /* 2674 * Selector Unit 2675 */ 2676 2677 /* 2678 * info callback for selector unit 2679 * use an enumerator type for routing 2680 */ 2681 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, 2682 struct snd_ctl_elem_info *uinfo) 2683 { 2684 struct usb_mixer_elem_info *cval = kcontrol->private_data; 2685 const char **itemlist = (const char **)kcontrol->private_value; 2686 2687 if (snd_BUG_ON(!itemlist)) 2688 return -EINVAL; 2689 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist); 2690 } 2691 2692 /* get callback for selector unit */ 2693 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, 2694 struct snd_ctl_elem_value *ucontrol) 2695 { 2696 struct usb_mixer_elem_info *cval = kcontrol->private_data; 2697 int val, err; 2698 2699 err = get_cur_ctl_value(cval, cval->control << 8, &val); 2700 if (err < 0) { 2701 ucontrol->value.enumerated.item[0] = 0; 2702 return filter_error(cval, err); 2703 } 2704 val = get_relative_value(cval, val); 2705 ucontrol->value.enumerated.item[0] = val; 2706 return 0; 2707 } 2708 2709 /* put callback for selector unit */ 2710 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, 2711 struct snd_ctl_elem_value *ucontrol) 2712 { 2713 struct usb_mixer_elem_info *cval = kcontrol->private_data; 2714 int val, oval, err; 2715 2716 err = get_cur_ctl_value(cval, cval->control << 8, &oval); 2717 if (err < 0) 2718 return filter_error(cval, err); 2719 val = ucontrol->value.enumerated.item[0]; 2720 if (val < 0 || val >= cval->max) /* here cval->max = # elements */ 2721 return -EINVAL; 2722 val = get_abs_value(cval, val); 2723 if (val != oval) { 2724 set_cur_ctl_value(cval, cval->control << 8, val); 2725 return 1; 2726 } 2727 return 0; 2728 } 2729 2730 /* alsa control interface for selector unit */ 2731 static const struct snd_kcontrol_new mixer_selectunit_ctl = { 2732 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 2733 .name = "", /* will be filled later */ 2734 .info = mixer_ctl_selector_info, 2735 .get = mixer_ctl_selector_get, 2736 .put = mixer_ctl_selector_put, 2737 }; 2738 2739 /* 2740 * private free callback. 2741 * free both private_data and private_value 2742 */ 2743 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl) 2744 { 2745 int i, num_ins = 0; 2746 2747 if (kctl->private_data) { 2748 struct usb_mixer_elem_info *cval = kctl->private_data; 2749 num_ins = cval->max; 2750 usb_mixer_elem_info_free(cval); 2751 kctl->private_data = NULL; 2752 } 2753 if (kctl->private_value) { 2754 char **itemlist = (char **)kctl->private_value; 2755 for (i = 0; i < num_ins; i++) 2756 kfree(itemlist[i]); 2757 kfree(itemlist); 2758 kctl->private_value = 0; 2759 } 2760 } 2761 2762 /* 2763 * parse a selector unit 2764 */ 2765 static int parse_audio_selector_unit(struct mixer_build *state, int unitid, 2766 void *raw_desc) 2767 { 2768 struct uac_selector_unit_descriptor *desc = raw_desc; 2769 unsigned int i, nameid, len; 2770 int err; 2771 struct usb_mixer_elem_info *cval; 2772 struct snd_kcontrol *kctl; 2773 const struct usbmix_name_map *map; 2774 char **namelist; 2775 2776 for (i = 0; i < desc->bNrInPins; i++) { 2777 err = parse_audio_unit(state, desc->baSourceID[i]); 2778 if (err < 0) 2779 return err; 2780 } 2781 2782 if (desc->bNrInPins == 1) /* only one ? nonsense! */ 2783 return 0; 2784 2785 map = find_map(state->map, unitid, 0); 2786 if (check_ignored_ctl(map)) 2787 return 0; 2788 2789 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 2790 if (!cval) 2791 return -ENOMEM; 2792 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid); 2793 cval->val_type = USB_MIXER_U8; 2794 cval->channels = 1; 2795 cval->min = 1; 2796 cval->max = desc->bNrInPins; 2797 cval->res = 1; 2798 cval->initialized = 1; 2799 2800 switch (state->mixer->protocol) { 2801 case UAC_VERSION_1: 2802 default: 2803 cval->control = 0; 2804 break; 2805 case UAC_VERSION_2: 2806 case UAC_VERSION_3: 2807 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR || 2808 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR) 2809 cval->control = UAC2_CX_CLOCK_SELECTOR; 2810 else /* UAC2/3_SELECTOR_UNIT */ 2811 cval->control = UAC2_SU_SELECTOR; 2812 break; 2813 } 2814 2815 namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL); 2816 if (!namelist) { 2817 err = -ENOMEM; 2818 goto error_cval; 2819 } 2820 #define MAX_ITEM_NAME_LEN 64 2821 for (i = 0; i < desc->bNrInPins; i++) { 2822 struct usb_audio_term iterm; 2823 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL); 2824 if (!namelist[i]) { 2825 err = -ENOMEM; 2826 goto error_name; 2827 } 2828 len = check_mapped_selector_name(state, unitid, i, namelist[i], 2829 MAX_ITEM_NAME_LEN); 2830 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0) 2831 len = get_term_name(state->chip, &iterm, namelist[i], 2832 MAX_ITEM_NAME_LEN, 0); 2833 if (! len) 2834 sprintf(namelist[i], "Input %u", i); 2835 } 2836 2837 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval); 2838 if (! kctl) { 2839 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 2840 err = -ENOMEM; 2841 goto error_name; 2842 } 2843 kctl->private_value = (unsigned long)namelist; 2844 kctl->private_free = usb_mixer_selector_elem_free; 2845 2846 /* check the static mapping table at first */ 2847 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)); 2848 if (!len) { 2849 /* no mapping ? */ 2850 switch (state->mixer->protocol) { 2851 case UAC_VERSION_1: 2852 case UAC_VERSION_2: 2853 default: 2854 /* if iSelector is given, use it */ 2855 nameid = uac_selector_unit_iSelector(desc); 2856 if (nameid) 2857 len = snd_usb_copy_string_desc(state->chip, 2858 nameid, kctl->id.name, 2859 sizeof(kctl->id.name)); 2860 break; 2861 case UAC_VERSION_3: 2862 /* TODO: Class-Specific strings not yet supported */ 2863 break; 2864 } 2865 2866 /* ... or pick up the terminal name at next */ 2867 if (!len) 2868 len = get_term_name(state->chip, &state->oterm, 2869 kctl->id.name, sizeof(kctl->id.name), 0); 2870 /* ... or use the fixed string "USB" as the last resort */ 2871 if (!len) 2872 strscpy(kctl->id.name, "USB", sizeof(kctl->id.name)); 2873 2874 /* and add the proper suffix */ 2875 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR || 2876 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR) 2877 append_ctl_name(kctl, " Clock Source"); 2878 else if ((state->oterm.type & 0xff00) == 0x0100) 2879 append_ctl_name(kctl, " Capture Source"); 2880 else 2881 append_ctl_name(kctl, " Playback Source"); 2882 } 2883 2884 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n", 2885 cval->head.id, kctl->id.name, desc->bNrInPins); 2886 return snd_usb_mixer_add_control(&cval->head, kctl); 2887 2888 error_name: 2889 for (i = 0; i < desc->bNrInPins; i++) 2890 kfree(namelist[i]); 2891 kfree(namelist); 2892 error_cval: 2893 usb_mixer_elem_info_free(cval); 2894 return err; 2895 } 2896 2897 /* 2898 * parse an audio unit recursively 2899 */ 2900 2901 static int parse_audio_unit(struct mixer_build *state, int unitid) 2902 { 2903 unsigned char *p1; 2904 int protocol = state->mixer->protocol; 2905 2906 if (test_and_set_bit(unitid, state->unitbitmap)) 2907 return 0; /* the unit already visited */ 2908 2909 p1 = find_audio_control_unit(state, unitid); 2910 if (!p1) { 2911 usb_audio_err(state->chip, "unit %d not found!\n", unitid); 2912 return -EINVAL; 2913 } 2914 2915 if (!snd_usb_validate_audio_desc(p1, protocol)) { 2916 usb_audio_dbg(state->chip, "invalid unit %d\n", unitid); 2917 return 0; /* skip invalid unit */ 2918 } 2919 2920 switch (PTYPE(protocol, p1[2])) { 2921 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL): 2922 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL): 2923 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL): 2924 return parse_audio_input_terminal(state, unitid, p1); 2925 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT): 2926 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT): 2927 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT): 2928 return parse_audio_mixer_unit(state, unitid, p1); 2929 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE): 2930 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE): 2931 return parse_clock_source_unit(state, unitid, p1); 2932 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT): 2933 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT): 2934 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT): 2935 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR): 2936 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR): 2937 return parse_audio_selector_unit(state, unitid, p1); 2938 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT): 2939 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT): 2940 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT): 2941 return parse_audio_feature_unit(state, unitid, p1); 2942 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT): 2943 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2): 2944 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT): 2945 return parse_audio_processing_unit(state, unitid, p1); 2946 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT): 2947 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2): 2948 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT): 2949 return parse_audio_extension_unit(state, unitid, p1); 2950 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT): 2951 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT): 2952 return 0; /* FIXME - effect units not implemented yet */ 2953 default: 2954 usb_audio_err(state->chip, 2955 "unit %u: unexpected type 0x%02x\n", 2956 unitid, p1[2]); 2957 return -EINVAL; 2958 } 2959 } 2960 2961 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer) 2962 { 2963 /* kill pending URBs */ 2964 snd_usb_mixer_disconnect(mixer); 2965 2966 kfree(mixer->id_elems); 2967 if (mixer->urb) { 2968 kfree(mixer->urb->transfer_buffer); 2969 usb_free_urb(mixer->urb); 2970 } 2971 usb_free_urb(mixer->rc_urb); 2972 kfree(mixer->rc_setup_packet); 2973 kfree(mixer); 2974 } 2975 2976 static int snd_usb_mixer_dev_free(struct snd_device *device) 2977 { 2978 struct usb_mixer_interface *mixer = device->device_data; 2979 snd_usb_mixer_free(mixer); 2980 return 0; 2981 } 2982 2983 /* UAC3 predefined channels configuration */ 2984 struct uac3_badd_profile { 2985 int subclass; 2986 const char *name; 2987 int c_chmask; /* capture channels mask */ 2988 int p_chmask; /* playback channels mask */ 2989 int st_chmask; /* side tone mixing channel mask */ 2990 }; 2991 2992 static const struct uac3_badd_profile uac3_badd_profiles[] = { 2993 { 2994 /* 2995 * BAIF, BAOF or combination of both 2996 * IN: Mono or Stereo cfg, Mono alt possible 2997 * OUT: Mono or Stereo cfg, Mono alt possible 2998 */ 2999 .subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO, 3000 .name = "GENERIC IO", 3001 .c_chmask = -1, /* dynamic channels */ 3002 .p_chmask = -1, /* dynamic channels */ 3003 }, 3004 { 3005 /* BAOF; Stereo only cfg, Mono alt possible */ 3006 .subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE, 3007 .name = "HEADPHONE", 3008 .p_chmask = 3, 3009 }, 3010 { 3011 /* BAOF; Mono or Stereo cfg, Mono alt possible */ 3012 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER, 3013 .name = "SPEAKER", 3014 .p_chmask = -1, /* dynamic channels */ 3015 }, 3016 { 3017 /* BAIF; Mono or Stereo cfg, Mono alt possible */ 3018 .subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE, 3019 .name = "MICROPHONE", 3020 .c_chmask = -1, /* dynamic channels */ 3021 }, 3022 { 3023 /* 3024 * BAIOF topology 3025 * IN: Mono only 3026 * OUT: Mono or Stereo cfg, Mono alt possible 3027 */ 3028 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET, 3029 .name = "HEADSET", 3030 .c_chmask = 1, 3031 .p_chmask = -1, /* dynamic channels */ 3032 .st_chmask = 1, 3033 }, 3034 { 3035 /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */ 3036 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER, 3037 .name = "HEADSET ADAPTER", 3038 .c_chmask = 1, 3039 .p_chmask = 3, 3040 .st_chmask = 1, 3041 }, 3042 { 3043 /* BAIF + BAOF; IN: Mono only; OUT: Mono only */ 3044 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE, 3045 .name = "SPEAKERPHONE", 3046 .c_chmask = 1, 3047 .p_chmask = 1, 3048 }, 3049 { 0 } /* terminator */ 3050 }; 3051 3052 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer, 3053 const struct uac3_badd_profile *f, 3054 int c_chmask, int p_chmask) 3055 { 3056 /* 3057 * If both playback/capture channels are dynamic, make sure 3058 * at least one channel is present 3059 */ 3060 if (f->c_chmask < 0 && f->p_chmask < 0) { 3061 if (!c_chmask && !p_chmask) { 3062 usb_audio_warn(mixer->chip, "BAAD %s: no channels?", 3063 f->name); 3064 return false; 3065 } 3066 return true; 3067 } 3068 3069 if ((f->c_chmask < 0 && !c_chmask) || 3070 (f->c_chmask >= 0 && f->c_chmask != c_chmask)) { 3071 usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch", 3072 f->name); 3073 return false; 3074 } 3075 if ((f->p_chmask < 0 && !p_chmask) || 3076 (f->p_chmask >= 0 && f->p_chmask != p_chmask)) { 3077 usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch", 3078 f->name); 3079 return false; 3080 } 3081 return true; 3082 } 3083 3084 /* 3085 * create mixer controls for UAC3 BADD profiles 3086 * 3087 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything 3088 * 3089 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it 3090 */ 3091 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer, 3092 int ctrlif) 3093 { 3094 struct usb_device *dev = mixer->chip->dev; 3095 struct usb_interface_assoc_descriptor *assoc; 3096 int badd_profile = mixer->chip->badd_profile; 3097 const struct uac3_badd_profile *f; 3098 const struct usbmix_ctl_map *map; 3099 int p_chmask = 0, c_chmask = 0, st_chmask = 0; 3100 int i; 3101 3102 assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc; 3103 3104 /* Detect BADD capture/playback channels from AS EP descriptors */ 3105 for (i = 0; i < assoc->bInterfaceCount; i++) { 3106 int intf = assoc->bFirstInterface + i; 3107 3108 struct usb_interface *iface; 3109 struct usb_host_interface *alts; 3110 struct usb_interface_descriptor *altsd; 3111 unsigned int maxpacksize; 3112 char dir_in; 3113 int chmask, num; 3114 3115 if (intf == ctrlif) 3116 continue; 3117 3118 iface = usb_ifnum_to_if(dev, intf); 3119 if (!iface) 3120 continue; 3121 3122 num = iface->num_altsetting; 3123 3124 if (num < 2) 3125 return -EINVAL; 3126 3127 /* 3128 * The number of Channels in an AudioStreaming interface 3129 * and the audio sample bit resolution (16 bits or 24 3130 * bits) can be derived from the wMaxPacketSize field in 3131 * the Standard AS Audio Data Endpoint descriptor in 3132 * Alternate Setting 1 3133 */ 3134 alts = &iface->altsetting[1]; 3135 altsd = get_iface_desc(alts); 3136 3137 if (altsd->bNumEndpoints < 1) 3138 return -EINVAL; 3139 3140 /* check direction */ 3141 dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN); 3142 maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize); 3143 3144 switch (maxpacksize) { 3145 default: 3146 usb_audio_err(mixer->chip, 3147 "incorrect wMaxPacketSize 0x%x for BADD profile\n", 3148 maxpacksize); 3149 return -EINVAL; 3150 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16: 3151 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16: 3152 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24: 3153 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24: 3154 chmask = 1; 3155 break; 3156 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16: 3157 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16: 3158 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24: 3159 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24: 3160 chmask = 3; 3161 break; 3162 } 3163 3164 if (dir_in) 3165 c_chmask = chmask; 3166 else 3167 p_chmask = chmask; 3168 } 3169 3170 usb_audio_dbg(mixer->chip, 3171 "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n", 3172 badd_profile, c_chmask, p_chmask); 3173 3174 /* check the mapping table */ 3175 for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) { 3176 if (map->id == badd_profile) 3177 break; 3178 } 3179 3180 if (!map->id) 3181 return -EINVAL; 3182 3183 for (f = uac3_badd_profiles; f->name; f++) { 3184 if (badd_profile == f->subclass) 3185 break; 3186 } 3187 if (!f->name) 3188 return -EINVAL; 3189 if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask)) 3190 return -EINVAL; 3191 st_chmask = f->st_chmask; 3192 3193 /* Playback */ 3194 if (p_chmask) { 3195 /* Master channel, always writable */ 3196 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE, 3197 UAC3_BADD_FU_ID2, map->map); 3198 /* Mono/Stereo volume channels, always writable */ 3199 build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME, 3200 UAC3_BADD_FU_ID2, map->map); 3201 } 3202 3203 /* Capture */ 3204 if (c_chmask) { 3205 /* Master channel, always writable */ 3206 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE, 3207 UAC3_BADD_FU_ID5, map->map); 3208 /* Mono/Stereo volume channels, always writable */ 3209 build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME, 3210 UAC3_BADD_FU_ID5, map->map); 3211 } 3212 3213 /* Side tone-mixing */ 3214 if (st_chmask) { 3215 /* Master channel, always writable */ 3216 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE, 3217 UAC3_BADD_FU_ID7, map->map); 3218 /* Mono volume channel, always writable */ 3219 build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME, 3220 UAC3_BADD_FU_ID7, map->map); 3221 } 3222 3223 /* Insertion Control */ 3224 if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) { 3225 struct usb_audio_term iterm, oterm; 3226 3227 /* Input Term - Insertion control */ 3228 memset(&iterm, 0, sizeof(iterm)); 3229 iterm.id = UAC3_BADD_IT_ID4; 3230 iterm.type = UAC_BIDIR_TERMINAL_HEADSET; 3231 build_connector_control(mixer, map->map, &iterm, true); 3232 3233 /* Output Term - Insertion control */ 3234 memset(&oterm, 0, sizeof(oterm)); 3235 oterm.id = UAC3_BADD_OT_ID3; 3236 oterm.type = UAC_BIDIR_TERMINAL_HEADSET; 3237 build_connector_control(mixer, map->map, &oterm, false); 3238 } 3239 3240 return 0; 3241 } 3242 3243 /* 3244 * create mixer controls 3245 * 3246 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers 3247 */ 3248 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer) 3249 { 3250 struct mixer_build state; 3251 int err; 3252 const struct usbmix_ctl_map *map; 3253 void *p; 3254 3255 memset(&state, 0, sizeof(state)); 3256 state.chip = mixer->chip; 3257 state.mixer = mixer; 3258 state.buffer = mixer->hostif->extra; 3259 state.buflen = mixer->hostif->extralen; 3260 3261 /* check the mapping table */ 3262 for (map = usbmix_ctl_maps; map->id; map++) { 3263 if (map->id == state.chip->usb_id) { 3264 state.map = map->map; 3265 state.selector_map = map->selector_map; 3266 mixer->connector_map = map->connector_map; 3267 break; 3268 } 3269 } 3270 3271 p = NULL; 3272 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra, 3273 mixer->hostif->extralen, 3274 p, UAC_OUTPUT_TERMINAL)) != NULL) { 3275 if (!snd_usb_validate_audio_desc(p, mixer->protocol)) 3276 continue; /* skip invalid descriptor */ 3277 3278 if (mixer->protocol == UAC_VERSION_1) { 3279 struct uac1_output_terminal_descriptor *desc = p; 3280 3281 /* mark terminal ID as visited */ 3282 set_bit(desc->bTerminalID, state.unitbitmap); 3283 state.oterm.id = desc->bTerminalID; 3284 state.oterm.type = le16_to_cpu(desc->wTerminalType); 3285 state.oterm.name = desc->iTerminal; 3286 err = parse_audio_unit(&state, desc->bSourceID); 3287 if (err < 0 && err != -EINVAL) 3288 return err; 3289 } else if (mixer->protocol == UAC_VERSION_2) { 3290 struct uac2_output_terminal_descriptor *desc = p; 3291 3292 /* mark terminal ID as visited */ 3293 set_bit(desc->bTerminalID, state.unitbitmap); 3294 state.oterm.id = desc->bTerminalID; 3295 state.oterm.type = le16_to_cpu(desc->wTerminalType); 3296 state.oterm.name = desc->iTerminal; 3297 err = parse_audio_unit(&state, desc->bSourceID); 3298 if (err < 0 && err != -EINVAL) 3299 return err; 3300 3301 /* 3302 * For UAC2, use the same approach to also add the 3303 * clock selectors 3304 */ 3305 err = parse_audio_unit(&state, desc->bCSourceID); 3306 if (err < 0 && err != -EINVAL) 3307 return err; 3308 3309 if ((state.oterm.type & 0xff00) != 0x0100 && 3310 uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls), 3311 UAC2_TE_CONNECTOR)) { 3312 build_connector_control(state.mixer, state.map, 3313 &state.oterm, false); 3314 } 3315 } else { /* UAC_VERSION_3 */ 3316 struct uac3_output_terminal_descriptor *desc = p; 3317 3318 /* mark terminal ID as visited */ 3319 set_bit(desc->bTerminalID, state.unitbitmap); 3320 state.oterm.id = desc->bTerminalID; 3321 state.oterm.type = le16_to_cpu(desc->wTerminalType); 3322 state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr); 3323 err = parse_audio_unit(&state, desc->bSourceID); 3324 if (err < 0 && err != -EINVAL) 3325 return err; 3326 3327 /* 3328 * For UAC3, use the same approach to also add the 3329 * clock selectors 3330 */ 3331 err = parse_audio_unit(&state, desc->bCSourceID); 3332 if (err < 0 && err != -EINVAL) 3333 return err; 3334 3335 if ((state.oterm.type & 0xff00) != 0x0100 && 3336 uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls), 3337 UAC3_TE_INSERTION)) { 3338 build_connector_control(state.mixer, state.map, 3339 &state.oterm, false); 3340 } 3341 } 3342 } 3343 3344 return 0; 3345 } 3346 3347 static int delegate_notify(struct usb_mixer_interface *mixer, int unitid, 3348 u8 *control, u8 *channel) 3349 { 3350 const struct usbmix_connector_map *map = mixer->connector_map; 3351 3352 if (!map) 3353 return unitid; 3354 3355 for (; map->id; map++) { 3356 if (map->id == unitid) { 3357 if (control && map->control) 3358 *control = map->control; 3359 if (channel && map->channel) 3360 *channel = map->channel; 3361 return map->delegated_id; 3362 } 3363 } 3364 return unitid; 3365 } 3366 3367 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid) 3368 { 3369 struct usb_mixer_elem_list *list; 3370 3371 unitid = delegate_notify(mixer, unitid, NULL, NULL); 3372 3373 for_each_mixer_elem(list, mixer, unitid) { 3374 struct usb_mixer_elem_info *info; 3375 3376 if (!list->is_std_info) 3377 continue; 3378 info = mixer_elem_list_to_info(list); 3379 /* invalidate cache, so the value is read from the device */ 3380 info->cached = 0; 3381 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE, 3382 &list->kctl->id); 3383 } 3384 } 3385 3386 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer, 3387 struct usb_mixer_elem_list *list) 3388 { 3389 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list); 3390 static const char * const val_types[] = { 3391 [USB_MIXER_BOOLEAN] = "BOOLEAN", 3392 [USB_MIXER_INV_BOOLEAN] = "INV_BOOLEAN", 3393 [USB_MIXER_S8] = "S8", 3394 [USB_MIXER_U8] = "U8", 3395 [USB_MIXER_S16] = "S16", 3396 [USB_MIXER_U16] = "U16", 3397 [USB_MIXER_S32] = "S32", 3398 [USB_MIXER_U32] = "U32", 3399 [USB_MIXER_BESPOKEN] = "BESPOKEN", 3400 }; 3401 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, " 3402 "channels=%i, type=\"%s\"\n", cval->head.id, 3403 cval->control, cval->cmask, cval->channels, 3404 val_types[cval->val_type]); 3405 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n", 3406 cval->min, cval->max, cval->dBmin, cval->dBmax); 3407 } 3408 3409 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry, 3410 struct snd_info_buffer *buffer) 3411 { 3412 struct snd_usb_audio *chip = entry->private_data; 3413 struct usb_mixer_interface *mixer; 3414 struct usb_mixer_elem_list *list; 3415 int unitid; 3416 3417 list_for_each_entry(mixer, &chip->mixer_list, list) { 3418 snd_iprintf(buffer, 3419 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n", 3420 chip->usb_id, mixer_ctrl_intf(mixer), 3421 mixer->ignore_ctl_error); 3422 snd_iprintf(buffer, "Card: %s\n", chip->card->longname); 3423 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) { 3424 for_each_mixer_elem(list, mixer, unitid) { 3425 snd_iprintf(buffer, " Unit: %i\n", list->id); 3426 if (list->kctl) 3427 snd_iprintf(buffer, 3428 " Control: name=\"%s\", index=%i\n", 3429 list->kctl->id.name, 3430 list->kctl->id.index); 3431 if (list->dump) 3432 list->dump(buffer, list); 3433 } 3434 } 3435 } 3436 } 3437 3438 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer, 3439 int attribute, int value, int index) 3440 { 3441 struct usb_mixer_elem_list *list; 3442 __u8 unitid = (index >> 8) & 0xff; 3443 __u8 control = (value >> 8) & 0xff; 3444 __u8 channel = value & 0xff; 3445 unsigned int count = 0; 3446 3447 if (channel >= MAX_CHANNELS) { 3448 usb_audio_dbg(mixer->chip, 3449 "%s(): bogus channel number %d\n", 3450 __func__, channel); 3451 return; 3452 } 3453 3454 unitid = delegate_notify(mixer, unitid, &control, &channel); 3455 3456 for_each_mixer_elem(list, mixer, unitid) 3457 count++; 3458 3459 if (count == 0) 3460 return; 3461 3462 for_each_mixer_elem(list, mixer, unitid) { 3463 struct usb_mixer_elem_info *info; 3464 3465 if (!list->kctl) 3466 continue; 3467 if (!list->is_std_info) 3468 continue; 3469 3470 info = mixer_elem_list_to_info(list); 3471 if (count > 1 && info->control != control) 3472 continue; 3473 3474 switch (attribute) { 3475 case UAC2_CS_CUR: 3476 /* invalidate cache, so the value is read from the device */ 3477 if (channel) 3478 info->cached &= ~BIT(channel); 3479 else /* master channel */ 3480 info->cached = 0; 3481 3482 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE, 3483 &info->head.kctl->id); 3484 break; 3485 3486 case UAC2_CS_RANGE: 3487 /* TODO */ 3488 break; 3489 3490 case UAC2_CS_MEM: 3491 /* TODO */ 3492 break; 3493 3494 default: 3495 usb_audio_dbg(mixer->chip, 3496 "unknown attribute %d in interrupt\n", 3497 attribute); 3498 break; 3499 } /* switch */ 3500 } 3501 } 3502 3503 static void snd_usb_mixer_interrupt(struct urb *urb) 3504 { 3505 struct usb_mixer_interface *mixer = urb->context; 3506 int len = urb->actual_length; 3507 int ustatus = urb->status; 3508 3509 if (ustatus != 0) 3510 goto requeue; 3511 3512 if (mixer->protocol == UAC_VERSION_1) { 3513 struct uac1_status_word *status; 3514 3515 for (status = urb->transfer_buffer; 3516 len >= sizeof(*status); 3517 len -= sizeof(*status), status++) { 3518 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n", 3519 status->bStatusType, 3520 status->bOriginator); 3521 3522 /* ignore any notifications not from the control interface */ 3523 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) != 3524 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF) 3525 continue; 3526 3527 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED) 3528 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator); 3529 else 3530 snd_usb_mixer_notify_id(mixer, status->bOriginator); 3531 } 3532 } else { /* UAC_VERSION_2 */ 3533 struct uac2_interrupt_data_msg *msg; 3534 3535 for (msg = urb->transfer_buffer; 3536 len >= sizeof(*msg); 3537 len -= sizeof(*msg), msg++) { 3538 /* drop vendor specific and endpoint requests */ 3539 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) || 3540 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP)) 3541 continue; 3542 3543 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute, 3544 le16_to_cpu(msg->wValue), 3545 le16_to_cpu(msg->wIndex)); 3546 } 3547 } 3548 3549 requeue: 3550 if (ustatus != -ENOENT && 3551 ustatus != -ECONNRESET && 3552 ustatus != -ESHUTDOWN) { 3553 urb->dev = mixer->chip->dev; 3554 usb_submit_urb(urb, GFP_ATOMIC); 3555 } 3556 } 3557 3558 /* create the handler for the optional status interrupt endpoint */ 3559 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer) 3560 { 3561 struct usb_endpoint_descriptor *ep; 3562 void *transfer_buffer; 3563 int buffer_length; 3564 unsigned int epnum; 3565 3566 /* we need one interrupt input endpoint */ 3567 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1) 3568 return 0; 3569 ep = get_endpoint(mixer->hostif, 0); 3570 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep)) 3571 return 0; 3572 3573 epnum = usb_endpoint_num(ep); 3574 buffer_length = le16_to_cpu(ep->wMaxPacketSize); 3575 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL); 3576 if (!transfer_buffer) 3577 return -ENOMEM; 3578 mixer->urb = usb_alloc_urb(0, GFP_KERNEL); 3579 if (!mixer->urb) { 3580 kfree(transfer_buffer); 3581 return -ENOMEM; 3582 } 3583 usb_fill_int_urb(mixer->urb, mixer->chip->dev, 3584 usb_rcvintpipe(mixer->chip->dev, epnum), 3585 transfer_buffer, buffer_length, 3586 snd_usb_mixer_interrupt, mixer, ep->bInterval); 3587 usb_submit_urb(mixer->urb, GFP_KERNEL); 3588 return 0; 3589 } 3590 3591 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif) 3592 { 3593 static const struct snd_device_ops dev_ops = { 3594 .dev_free = snd_usb_mixer_dev_free 3595 }; 3596 struct usb_mixer_interface *mixer; 3597 int err; 3598 3599 strcpy(chip->card->mixername, "USB Mixer"); 3600 3601 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL); 3602 if (!mixer) 3603 return -ENOMEM; 3604 mixer->chip = chip; 3605 mixer->ignore_ctl_error = !!(chip->quirk_flags & QUIRK_FLAG_IGNORE_CTL_ERROR); 3606 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems), 3607 GFP_KERNEL); 3608 if (!mixer->id_elems) { 3609 kfree(mixer); 3610 return -ENOMEM; 3611 } 3612 3613 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0]; 3614 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) { 3615 case UAC_VERSION_1: 3616 default: 3617 mixer->protocol = UAC_VERSION_1; 3618 break; 3619 case UAC_VERSION_2: 3620 mixer->protocol = UAC_VERSION_2; 3621 break; 3622 case UAC_VERSION_3: 3623 mixer->protocol = UAC_VERSION_3; 3624 break; 3625 } 3626 3627 if (mixer->protocol == UAC_VERSION_3 && 3628 chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) { 3629 err = snd_usb_mixer_controls_badd(mixer, ctrlif); 3630 if (err < 0) 3631 goto _error; 3632 } else { 3633 err = snd_usb_mixer_controls(mixer); 3634 if (err < 0) 3635 goto _error; 3636 } 3637 3638 err = snd_usb_mixer_status_create(mixer); 3639 if (err < 0) 3640 goto _error; 3641 3642 err = snd_usb_mixer_apply_create_quirk(mixer); 3643 if (err < 0) 3644 goto _error; 3645 3646 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops); 3647 if (err < 0) 3648 goto _error; 3649 3650 if (list_empty(&chip->mixer_list)) 3651 snd_card_ro_proc_new(chip->card, "usbmixer", chip, 3652 snd_usb_mixer_proc_read); 3653 3654 list_add(&mixer->list, &chip->mixer_list); 3655 return 0; 3656 3657 _error: 3658 snd_usb_mixer_free(mixer); 3659 return err; 3660 } 3661 3662 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer) 3663 { 3664 if (mixer->disconnected) 3665 return; 3666 if (mixer->urb) 3667 usb_kill_urb(mixer->urb); 3668 if (mixer->rc_urb) 3669 usb_kill_urb(mixer->rc_urb); 3670 if (mixer->private_free) 3671 mixer->private_free(mixer); 3672 mixer->disconnected = true; 3673 } 3674 3675 /* stop any bus activity of a mixer */ 3676 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer) 3677 { 3678 usb_kill_urb(mixer->urb); 3679 usb_kill_urb(mixer->rc_urb); 3680 } 3681 3682 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer) 3683 { 3684 int err; 3685 3686 if (mixer->urb) { 3687 err = usb_submit_urb(mixer->urb, GFP_NOIO); 3688 if (err < 0) 3689 return err; 3690 } 3691 3692 return 0; 3693 } 3694 3695 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer) 3696 { 3697 snd_usb_mixer_inactivate(mixer); 3698 if (mixer->private_suspend) 3699 mixer->private_suspend(mixer); 3700 return 0; 3701 } 3702 3703 static int restore_mixer_value(struct usb_mixer_elem_list *list) 3704 { 3705 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list); 3706 int c, err, idx; 3707 3708 if (cval->val_type == USB_MIXER_BESPOKEN) 3709 return 0; 3710 3711 if (cval->cmask) { 3712 idx = 0; 3713 for (c = 0; c < MAX_CHANNELS; c++) { 3714 if (!(cval->cmask & BIT(c))) 3715 continue; 3716 if (cval->cached & BIT(c + 1)) { 3717 err = snd_usb_set_cur_mix_value(cval, c + 1, idx, 3718 cval->cache_val[idx]); 3719 if (err < 0) 3720 break; 3721 } 3722 idx++; 3723 } 3724 } else { 3725 /* master */ 3726 if (cval->cached) 3727 snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val); 3728 } 3729 3730 return 0; 3731 } 3732 3733 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer) 3734 { 3735 struct usb_mixer_elem_list *list; 3736 int id, err; 3737 3738 /* restore cached mixer values */ 3739 for (id = 0; id < MAX_ID_ELEMS; id++) { 3740 for_each_mixer_elem(list, mixer, id) { 3741 if (list->resume) { 3742 err = list->resume(list); 3743 if (err < 0) 3744 return err; 3745 } 3746 } 3747 } 3748 3749 snd_usb_mixer_resume_quirk(mixer); 3750 3751 return snd_usb_mixer_activate(mixer); 3752 } 3753 3754 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list, 3755 struct usb_mixer_interface *mixer, 3756 int unitid) 3757 { 3758 list->mixer = mixer; 3759 list->id = unitid; 3760 list->dump = snd_usb_mixer_dump_cval; 3761 list->resume = restore_mixer_value; 3762 } 3763