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 & (1 << 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 |= 1 << 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 & (1 << (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 |= 1 << 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->chip), 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 if (!strcmp(kctl->id.name, "Mic Capture Volume")) { 1209 usb_audio_info(chip, 1210 "set resolution quirk: cval->res = 16\n"); 1211 cval->res = 16; 1212 } 1213 break; 1214 } 1215 } 1216 1217 /* forcibly initialize the current mixer value; if GET_CUR fails, set to 1218 * the minimum as default 1219 */ 1220 static void init_cur_mix_raw(struct usb_mixer_elem_info *cval, int ch, int idx) 1221 { 1222 int val, err; 1223 1224 err = snd_usb_get_cur_mix_value(cval, ch, idx, &val); 1225 if (!err) 1226 return; 1227 if (!cval->head.mixer->ignore_ctl_error) 1228 usb_audio_warn(cval->head.mixer->chip, 1229 "%d:%d: failed to get current value for ch %d (%d)\n", 1230 cval->head.id, mixer_ctrl_intf(cval->head.mixer), 1231 ch, err); 1232 snd_usb_set_cur_mix_value(cval, ch, idx, cval->min); 1233 } 1234 1235 /* 1236 * retrieve the minimum and maximum values for the specified control 1237 */ 1238 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval, 1239 int default_min, struct snd_kcontrol *kctl) 1240 { 1241 int i, idx; 1242 1243 /* for failsafe */ 1244 cval->min = default_min; 1245 cval->max = cval->min + 1; 1246 cval->res = 1; 1247 cval->dBmin = cval->dBmax = 0; 1248 1249 if (cval->val_type == USB_MIXER_BOOLEAN || 1250 cval->val_type == USB_MIXER_INV_BOOLEAN) { 1251 cval->initialized = 1; 1252 } else { 1253 int minchn = 0; 1254 if (cval->cmask) { 1255 for (i = 0; i < MAX_CHANNELS; i++) 1256 if (cval->cmask & (1 << i)) { 1257 minchn = i + 1; 1258 break; 1259 } 1260 } 1261 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 || 1262 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) { 1263 usb_audio_err(cval->head.mixer->chip, 1264 "%d:%d: cannot get min/max values for control %d (id %d)\n", 1265 cval->head.id, mixer_ctrl_intf(cval->head.mixer), 1266 cval->control, cval->head.id); 1267 return -EINVAL; 1268 } 1269 if (get_ctl_value(cval, UAC_GET_RES, 1270 (cval->control << 8) | minchn, 1271 &cval->res) < 0) { 1272 cval->res = 1; 1273 } else if (cval->head.mixer->protocol == UAC_VERSION_1) { 1274 int last_valid_res = cval->res; 1275 1276 while (cval->res > 1) { 1277 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES, 1278 (cval->control << 8) | minchn, 1279 cval->res / 2) < 0) 1280 break; 1281 cval->res /= 2; 1282 } 1283 if (get_ctl_value(cval, UAC_GET_RES, 1284 (cval->control << 8) | minchn, &cval->res) < 0) 1285 cval->res = last_valid_res; 1286 } 1287 if (cval->res == 0) 1288 cval->res = 1; 1289 1290 /* Additional checks for the proper resolution 1291 * 1292 * Some devices report smaller resolutions than actually 1293 * reacting. They don't return errors but simply clip 1294 * to the lower aligned value. 1295 */ 1296 if (cval->min + cval->res < cval->max) { 1297 int last_valid_res = cval->res; 1298 int saved, test, check; 1299 if (get_cur_mix_raw(cval, minchn, &saved) < 0) 1300 goto no_res_check; 1301 for (;;) { 1302 test = saved; 1303 if (test < cval->max) 1304 test += cval->res; 1305 else 1306 test -= cval->res; 1307 if (test < cval->min || test > cval->max || 1308 snd_usb_set_cur_mix_value(cval, minchn, 0, test) || 1309 get_cur_mix_raw(cval, minchn, &check)) { 1310 cval->res = last_valid_res; 1311 break; 1312 } 1313 if (test == check) 1314 break; 1315 cval->res *= 2; 1316 } 1317 snd_usb_set_cur_mix_value(cval, minchn, 0, saved); 1318 } 1319 1320 no_res_check: 1321 cval->initialized = 1; 1322 } 1323 1324 if (kctl) 1325 volume_control_quirks(cval, kctl); 1326 1327 /* USB descriptions contain the dB scale in 1/256 dB unit 1328 * while ALSA TLV contains in 1/100 dB unit 1329 */ 1330 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256; 1331 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256; 1332 if (cval->dBmin > cval->dBmax) { 1333 /* something is wrong; assume it's either from/to 0dB */ 1334 if (cval->dBmin < 0) 1335 cval->dBmax = 0; 1336 else if (cval->dBmin > 0) 1337 cval->dBmin = 0; 1338 if (cval->dBmin > cval->dBmax) { 1339 /* totally crap, return an error */ 1340 return -EINVAL; 1341 } 1342 } else { 1343 /* if the max volume is too low, it's likely a bogus range; 1344 * here we use -96dB as the threshold 1345 */ 1346 if (cval->dBmax <= -9600) { 1347 usb_audio_info(cval->head.mixer->chip, 1348 "%d:%d: bogus dB values (%d/%d), disabling dB reporting\n", 1349 cval->head.id, mixer_ctrl_intf(cval->head.mixer), 1350 cval->dBmin, cval->dBmax); 1351 cval->dBmin = cval->dBmax = 0; 1352 } 1353 } 1354 1355 /* initialize all elements */ 1356 if (!cval->cmask) { 1357 init_cur_mix_raw(cval, 0, 0); 1358 } else { 1359 idx = 0; 1360 for (i = 0; i < MAX_CHANNELS; i++) { 1361 if (cval->cmask & (1 << i)) { 1362 init_cur_mix_raw(cval, i + 1, idx); 1363 idx++; 1364 } 1365 } 1366 } 1367 1368 return 0; 1369 } 1370 1371 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL) 1372 1373 /* get a feature/mixer unit info */ 1374 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, 1375 struct snd_ctl_elem_info *uinfo) 1376 { 1377 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1378 1379 if (cval->val_type == USB_MIXER_BOOLEAN || 1380 cval->val_type == USB_MIXER_INV_BOOLEAN) 1381 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN; 1382 else 1383 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER; 1384 uinfo->count = cval->channels; 1385 if (cval->val_type == USB_MIXER_BOOLEAN || 1386 cval->val_type == USB_MIXER_INV_BOOLEAN) { 1387 uinfo->value.integer.min = 0; 1388 uinfo->value.integer.max = 1; 1389 } else { 1390 if (!cval->initialized) { 1391 get_min_max_with_quirks(cval, 0, kcontrol); 1392 if (cval->initialized && cval->dBmin >= cval->dBmax) { 1393 kcontrol->vd[0].access &= 1394 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ | 1395 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK); 1396 snd_ctl_notify(cval->head.mixer->chip->card, 1397 SNDRV_CTL_EVENT_MASK_INFO, 1398 &kcontrol->id); 1399 } 1400 } 1401 uinfo->value.integer.min = 0; 1402 uinfo->value.integer.max = 1403 DIV_ROUND_UP(cval->max - cval->min, cval->res); 1404 } 1405 return 0; 1406 } 1407 1408 /* get the current value from feature/mixer unit */ 1409 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, 1410 struct snd_ctl_elem_value *ucontrol) 1411 { 1412 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1413 int c, cnt, val, err; 1414 1415 ucontrol->value.integer.value[0] = cval->min; 1416 if (cval->cmask) { 1417 cnt = 0; 1418 for (c = 0; c < MAX_CHANNELS; c++) { 1419 if (!(cval->cmask & (1 << c))) 1420 continue; 1421 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val); 1422 if (err < 0) 1423 return filter_error(cval, err); 1424 val = get_relative_value(cval, val); 1425 ucontrol->value.integer.value[cnt] = val; 1426 cnt++; 1427 } 1428 return 0; 1429 } else { 1430 /* master channel */ 1431 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val); 1432 if (err < 0) 1433 return filter_error(cval, err); 1434 val = get_relative_value(cval, val); 1435 ucontrol->value.integer.value[0] = val; 1436 } 1437 return 0; 1438 } 1439 1440 /* put the current value to feature/mixer unit */ 1441 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, 1442 struct snd_ctl_elem_value *ucontrol) 1443 { 1444 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1445 int c, cnt, val, oval, err; 1446 int changed = 0; 1447 1448 if (cval->cmask) { 1449 cnt = 0; 1450 for (c = 0; c < MAX_CHANNELS; c++) { 1451 if (!(cval->cmask & (1 << c))) 1452 continue; 1453 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval); 1454 if (err < 0) 1455 return filter_error(cval, err); 1456 val = ucontrol->value.integer.value[cnt]; 1457 val = get_abs_value(cval, val); 1458 if (oval != val) { 1459 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val); 1460 changed = 1; 1461 } 1462 cnt++; 1463 } 1464 } else { 1465 /* master channel */ 1466 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval); 1467 if (err < 0) 1468 return filter_error(cval, err); 1469 val = ucontrol->value.integer.value[0]; 1470 val = get_abs_value(cval, val); 1471 if (val != oval) { 1472 snd_usb_set_cur_mix_value(cval, 0, 0, val); 1473 changed = 1; 1474 } 1475 } 1476 return changed; 1477 } 1478 1479 /* get the boolean value from the master channel of a UAC control */ 1480 static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol, 1481 struct snd_ctl_elem_value *ucontrol) 1482 { 1483 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1484 int val, err; 1485 1486 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val); 1487 if (err < 0) 1488 return filter_error(cval, err); 1489 val = (val != 0); 1490 ucontrol->value.integer.value[0] = val; 1491 return 0; 1492 } 1493 1494 static int get_connector_value(struct usb_mixer_elem_info *cval, 1495 char *name, int *val) 1496 { 1497 struct snd_usb_audio *chip = cval->head.mixer->chip; 1498 int idx = 0, validx, ret; 1499 1500 validx = cval->control << 8 | 0; 1501 1502 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0; 1503 if (ret) 1504 goto error; 1505 1506 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8); 1507 if (cval->head.mixer->protocol == UAC_VERSION_2) { 1508 struct uac2_connectors_ctl_blk uac2_conn; 1509 1510 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR, 1511 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN, 1512 validx, idx, &uac2_conn, sizeof(uac2_conn)); 1513 if (val) 1514 *val = !!uac2_conn.bNrChannels; 1515 } else { /* UAC_VERSION_3 */ 1516 struct uac3_insertion_ctl_blk uac3_conn; 1517 1518 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR, 1519 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN, 1520 validx, idx, &uac3_conn, sizeof(uac3_conn)); 1521 if (val) 1522 *val = !!uac3_conn.bmConInserted; 1523 } 1524 1525 snd_usb_unlock_shutdown(chip); 1526 1527 if (ret < 0) { 1528 if (name && strstr(name, "Speaker")) { 1529 if (val) 1530 *val = 1; 1531 return 0; 1532 } 1533 error: 1534 usb_audio_err(chip, 1535 "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n", 1536 UAC_GET_CUR, validx, idx, cval->val_type); 1537 1538 if (val) 1539 *val = 0; 1540 1541 return filter_error(cval, ret); 1542 } 1543 1544 return ret; 1545 } 1546 1547 /* get the connectors status and report it as boolean type */ 1548 static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol, 1549 struct snd_ctl_elem_value *ucontrol) 1550 { 1551 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1552 int ret, val; 1553 1554 ret = get_connector_value(cval, kcontrol->id.name, &val); 1555 1556 if (ret < 0) 1557 return ret; 1558 1559 ucontrol->value.integer.value[0] = val; 1560 return 0; 1561 } 1562 1563 static const struct snd_kcontrol_new usb_feature_unit_ctl = { 1564 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 1565 .name = "", /* will be filled later manually */ 1566 .info = mixer_ctl_feature_info, 1567 .get = mixer_ctl_feature_get, 1568 .put = mixer_ctl_feature_put, 1569 }; 1570 1571 /* the read-only variant */ 1572 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = { 1573 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 1574 .name = "", /* will be filled later manually */ 1575 .info = mixer_ctl_feature_info, 1576 .get = mixer_ctl_feature_get, 1577 .put = NULL, 1578 }; 1579 1580 /* 1581 * A control which shows the boolean value from reading a UAC control on 1582 * the master channel. 1583 */ 1584 static const struct snd_kcontrol_new usb_bool_master_control_ctl_ro = { 1585 .iface = SNDRV_CTL_ELEM_IFACE_CARD, 1586 .name = "", /* will be filled later manually */ 1587 .access = SNDRV_CTL_ELEM_ACCESS_READ, 1588 .info = snd_ctl_boolean_mono_info, 1589 .get = mixer_ctl_master_bool_get, 1590 .put = NULL, 1591 }; 1592 1593 static const struct snd_kcontrol_new usb_connector_ctl_ro = { 1594 .iface = SNDRV_CTL_ELEM_IFACE_CARD, 1595 .name = "", /* will be filled later manually */ 1596 .access = SNDRV_CTL_ELEM_ACCESS_READ, 1597 .info = snd_ctl_boolean_mono_info, 1598 .get = mixer_ctl_connector_get, 1599 .put = NULL, 1600 }; 1601 1602 /* 1603 * This symbol is exported in order to allow the mixer quirks to 1604 * hook up to the standard feature unit control mechanism 1605 */ 1606 const struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl; 1607 1608 /* 1609 * build a feature control 1610 */ 1611 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str) 1612 { 1613 return strlcat(kctl->id.name, str, sizeof(kctl->id.name)); 1614 } 1615 1616 /* 1617 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we 1618 * rename it to "Headphone". We determine if something is a headphone 1619 * similar to how udev determines form factor. 1620 */ 1621 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl, 1622 struct snd_card *card) 1623 { 1624 static const char * const names_to_check[] = { 1625 "Headset", "headset", "Headphone", "headphone", NULL}; 1626 const char * const *s; 1627 bool found = false; 1628 1629 if (strcmp("Speaker", kctl->id.name)) 1630 return; 1631 1632 for (s = names_to_check; *s; s++) 1633 if (strstr(card->shortname, *s)) { 1634 found = true; 1635 break; 1636 } 1637 1638 if (!found) 1639 return; 1640 1641 snd_ctl_rename(card, kctl, "Headphone"); 1642 } 1643 1644 static const struct usb_feature_control_info *get_feature_control_info(int control) 1645 { 1646 int i; 1647 1648 for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) { 1649 if (audio_feature_info[i].control == control) 1650 return &audio_feature_info[i]; 1651 } 1652 return NULL; 1653 } 1654 1655 static int feature_unit_mutevol_ctl_name(struct usb_mixer_interface *mixer, 1656 struct snd_kcontrol *kctl, 1657 struct usb_audio_term *iterm, 1658 struct usb_audio_term *oterm) 1659 { 1660 struct usb_audio_term *aterm, *bterm; 1661 bool output_first; 1662 int len = 0; 1663 1664 /* 1665 * If the input terminal is USB Streaming, we try getting the name of 1666 * the output terminal first in hopes of getting something more 1667 * descriptive than "PCM". 1668 */ 1669 output_first = iterm && !(iterm->type >> 16) && (iterm->type & 0xff00) == 0x0100; 1670 1671 aterm = output_first ? oterm : iterm; 1672 bterm = output_first ? iterm : oterm; 1673 1674 if (aterm) 1675 len = get_term_name(mixer->chip, aterm, kctl->id.name, 1676 sizeof(kctl->id.name), 1); 1677 if (!len && bterm) 1678 len = get_term_name(mixer->chip, bterm, kctl->id.name, 1679 sizeof(kctl->id.name), 1); 1680 return len; 1681 } 1682 1683 static void __build_feature_ctl(struct usb_mixer_interface *mixer, 1684 const struct usbmix_name_map *imap, 1685 unsigned int ctl_mask, int control, 1686 struct usb_audio_term *iterm, 1687 struct usb_audio_term *oterm, 1688 int unitid, int nameid, int readonly_mask) 1689 { 1690 const struct usb_feature_control_info *ctl_info; 1691 unsigned int len = 0; 1692 int mapped_name = 0; 1693 struct snd_kcontrol *kctl; 1694 struct usb_mixer_elem_info *cval; 1695 const struct usbmix_name_map *map; 1696 unsigned int range; 1697 1698 if (control == UAC_FU_GRAPHIC_EQUALIZER) { 1699 /* FIXME: not supported yet */ 1700 return; 1701 } 1702 1703 map = find_map(imap, unitid, control); 1704 if (check_ignored_ctl(map)) 1705 return; 1706 1707 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1708 if (!cval) 1709 return; 1710 snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid); 1711 cval->control = control; 1712 cval->cmask = ctl_mask; 1713 1714 ctl_info = get_feature_control_info(control); 1715 if (!ctl_info) { 1716 usb_mixer_elem_info_free(cval); 1717 return; 1718 } 1719 if (mixer->protocol == UAC_VERSION_1) 1720 cval->val_type = ctl_info->type; 1721 else /* UAC_VERSION_2 */ 1722 cval->val_type = ctl_info->type_uac2 >= 0 ? 1723 ctl_info->type_uac2 : ctl_info->type; 1724 1725 if (ctl_mask == 0) { 1726 cval->channels = 1; /* master channel */ 1727 cval->master_readonly = readonly_mask; 1728 } else { 1729 int i, c = 0; 1730 for (i = 0; i < 16; i++) 1731 if (ctl_mask & (1 << i)) 1732 c++; 1733 cval->channels = c; 1734 cval->ch_readonly = readonly_mask; 1735 } 1736 1737 /* 1738 * If all channels in the mask are marked read-only, make the control 1739 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't 1740 * issue write commands to read-only channels. 1741 */ 1742 if (cval->channels == readonly_mask) 1743 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval); 1744 else 1745 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval); 1746 1747 if (!kctl) { 1748 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n"); 1749 usb_mixer_elem_info_free(cval); 1750 return; 1751 } 1752 kctl->private_free = snd_usb_mixer_elem_free; 1753 1754 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)); 1755 mapped_name = len != 0; 1756 if (!len && nameid) 1757 len = snd_usb_copy_string_desc(mixer->chip, nameid, 1758 kctl->id.name, sizeof(kctl->id.name)); 1759 1760 switch (control) { 1761 case UAC_FU_MUTE: 1762 case UAC_FU_VOLUME: 1763 /* 1764 * Determine the control name: 1765 * - If a name id is given in descriptor, use it. 1766 * - If input and output terminals are present, try to derive 1767 * the name from either of these. 1768 * - Otherwise, make up a name using the feature unit ID. 1769 */ 1770 if (!len) { 1771 len = feature_unit_mutevol_ctl_name(mixer, kctl, iterm, 1772 oterm); 1773 if (!len) 1774 snprintf(kctl->id.name, sizeof(kctl->id.name), 1775 "Feature %d", unitid); 1776 } 1777 1778 if (!mapped_name) 1779 check_no_speaker_on_headset(kctl, mixer->chip->card); 1780 1781 /* 1782 * determine the stream direction: 1783 * if the connected output is USB stream, then it's likely a 1784 * capture stream. otherwise it should be playback (hopefully :) 1785 */ 1786 if (!mapped_name && oterm && !(oterm->type >> 16)) { 1787 if ((oterm->type & 0xff00) == 0x0100) 1788 append_ctl_name(kctl, " Capture"); 1789 else 1790 append_ctl_name(kctl, " Playback"); 1791 } 1792 append_ctl_name(kctl, control == UAC_FU_MUTE ? 1793 " Switch" : " Volume"); 1794 break; 1795 default: 1796 if (!len) 1797 strscpy(kctl->id.name, audio_feature_info[control-1].name, 1798 sizeof(kctl->id.name)); 1799 break; 1800 } 1801 1802 /* get min/max values */ 1803 get_min_max_with_quirks(cval, 0, kctl); 1804 1805 /* skip a bogus volume range */ 1806 if (cval->max <= cval->min) { 1807 usb_audio_dbg(mixer->chip, 1808 "[%d] FU [%s] skipped due to invalid volume\n", 1809 cval->head.id, kctl->id.name); 1810 snd_ctl_free_one(kctl); 1811 return; 1812 } 1813 1814 1815 if (control == UAC_FU_VOLUME) { 1816 check_mapped_dB(map, cval); 1817 if (cval->dBmin < cval->dBmax || !cval->initialized) { 1818 kctl->tlv.c = snd_usb_mixer_vol_tlv; 1819 kctl->vd[0].access |= 1820 SNDRV_CTL_ELEM_ACCESS_TLV_READ | 1821 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK; 1822 } 1823 } 1824 1825 snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl); 1826 1827 range = (cval->max - cval->min) / cval->res; 1828 /* 1829 * Are there devices with volume range more than 255? I use a bit more 1830 * to be sure. 384 is a resolution magic number found on Logitech 1831 * devices. It will definitively catch all buggy Logitech devices. 1832 */ 1833 if (range > 384) { 1834 usb_audio_warn(mixer->chip, 1835 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.", 1836 range); 1837 usb_audio_warn(mixer->chip, 1838 "[%d] FU [%s] ch = %d, val = %d/%d/%d", 1839 cval->head.id, kctl->id.name, cval->channels, 1840 cval->min, cval->max, cval->res); 1841 } 1842 1843 usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n", 1844 cval->head.id, kctl->id.name, cval->channels, 1845 cval->min, cval->max, cval->res); 1846 snd_usb_mixer_add_control(&cval->head, kctl); 1847 } 1848 1849 static void build_feature_ctl(struct mixer_build *state, void *raw_desc, 1850 unsigned int ctl_mask, int control, 1851 struct usb_audio_term *iterm, int unitid, 1852 int readonly_mask) 1853 { 1854 struct uac_feature_unit_descriptor *desc = raw_desc; 1855 int nameid = uac_feature_unit_iFeature(desc); 1856 1857 __build_feature_ctl(state->mixer, state->map, ctl_mask, control, 1858 iterm, &state->oterm, unitid, nameid, readonly_mask); 1859 } 1860 1861 static void build_feature_ctl_badd(struct usb_mixer_interface *mixer, 1862 unsigned int ctl_mask, int control, int unitid, 1863 const struct usbmix_name_map *badd_map) 1864 { 1865 __build_feature_ctl(mixer, badd_map, ctl_mask, control, 1866 NULL, NULL, unitid, 0, 0); 1867 } 1868 1869 static void get_connector_control_name(struct usb_mixer_interface *mixer, 1870 struct usb_audio_term *term, 1871 bool is_input, char *name, int name_size) 1872 { 1873 int name_len = get_term_name(mixer->chip, term, name, name_size, 0); 1874 1875 if (name_len == 0) 1876 strscpy(name, "Unknown", name_size); 1877 1878 /* 1879 * sound/core/ctljack.c has a convention of naming jack controls 1880 * by ending in " Jack". Make it slightly more useful by 1881 * indicating Input or Output after the terminal name. 1882 */ 1883 if (is_input) 1884 strlcat(name, " - Input Jack", name_size); 1885 else 1886 strlcat(name, " - Output Jack", name_size); 1887 } 1888 1889 /* get connector value to "wake up" the USB audio */ 1890 static int connector_mixer_resume(struct usb_mixer_elem_list *list) 1891 { 1892 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list); 1893 1894 get_connector_value(cval, NULL, NULL); 1895 return 0; 1896 } 1897 1898 /* Build a mixer control for a UAC connector control (jack-detect) */ 1899 static void build_connector_control(struct usb_mixer_interface *mixer, 1900 const struct usbmix_name_map *imap, 1901 struct usb_audio_term *term, bool is_input) 1902 { 1903 struct snd_kcontrol *kctl; 1904 struct usb_mixer_elem_info *cval; 1905 const struct usbmix_name_map *map; 1906 1907 map = find_map(imap, term->id, 0); 1908 if (check_ignored_ctl(map)) 1909 return; 1910 1911 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1912 if (!cval) 1913 return; 1914 snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id); 1915 1916 /* set up a specific resume callback */ 1917 cval->head.resume = connector_mixer_resume; 1918 1919 /* 1920 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the 1921 * number of channels connected. 1922 * 1923 * UAC3: The first byte specifies size of bitmap for the inserted controls. The 1924 * following byte(s) specifies which connectors are inserted. 1925 * 1926 * This boolean ctl will simply report if any channels are connected 1927 * or not. 1928 */ 1929 if (mixer->protocol == UAC_VERSION_2) 1930 cval->control = UAC2_TE_CONNECTOR; 1931 else /* UAC_VERSION_3 */ 1932 cval->control = UAC3_TE_INSERTION; 1933 1934 cval->val_type = USB_MIXER_BOOLEAN; 1935 cval->channels = 1; /* report true if any channel is connected */ 1936 cval->min = 0; 1937 cval->max = 1; 1938 kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval); 1939 if (!kctl) { 1940 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n"); 1941 usb_mixer_elem_info_free(cval); 1942 return; 1943 } 1944 1945 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) 1946 strlcat(kctl->id.name, " Jack", sizeof(kctl->id.name)); 1947 else 1948 get_connector_control_name(mixer, term, is_input, kctl->id.name, 1949 sizeof(kctl->id.name)); 1950 kctl->private_free = snd_usb_mixer_elem_free; 1951 snd_usb_mixer_add_control(&cval->head, kctl); 1952 } 1953 1954 static int parse_clock_source_unit(struct mixer_build *state, int unitid, 1955 void *_ftr) 1956 { 1957 struct uac_clock_source_descriptor *hdr = _ftr; 1958 struct usb_mixer_elem_info *cval; 1959 struct snd_kcontrol *kctl; 1960 int ret; 1961 1962 if (state->mixer->protocol != UAC_VERSION_2) 1963 return -EINVAL; 1964 1965 /* 1966 * The only property of this unit we are interested in is the 1967 * clock source validity. If that isn't readable, just bail out. 1968 */ 1969 if (!uac_v2v3_control_is_readable(hdr->bmControls, 1970 UAC2_CS_CONTROL_CLOCK_VALID)) 1971 return 0; 1972 1973 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1974 if (!cval) 1975 return -ENOMEM; 1976 1977 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID); 1978 1979 cval->min = 0; 1980 cval->max = 1; 1981 cval->channels = 1; 1982 cval->val_type = USB_MIXER_BOOLEAN; 1983 cval->control = UAC2_CS_CONTROL_CLOCK_VALID; 1984 1985 cval->master_readonly = 1; 1986 /* From UAC2 5.2.5.1.2 "Only the get request is supported." */ 1987 kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval); 1988 1989 if (!kctl) { 1990 usb_mixer_elem_info_free(cval); 1991 return -ENOMEM; 1992 } 1993 1994 kctl->private_free = snd_usb_mixer_elem_free; 1995 ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource, 1996 kctl->id.name, sizeof(kctl->id.name)); 1997 if (ret > 0) 1998 append_ctl_name(kctl, " Validity"); 1999 else 2000 snprintf(kctl->id.name, sizeof(kctl->id.name), 2001 "Clock Source %d Validity", hdr->bClockID); 2002 2003 return snd_usb_mixer_add_control(&cval->head, kctl); 2004 } 2005 2006 /* 2007 * parse a feature unit 2008 * 2009 * most of controls are defined here. 2010 */ 2011 static int parse_audio_feature_unit(struct mixer_build *state, int unitid, 2012 void *_ftr) 2013 { 2014 int channels, i, j; 2015 struct usb_audio_term iterm; 2016 unsigned int master_bits; 2017 int err, csize; 2018 struct uac_feature_unit_descriptor *hdr = _ftr; 2019 __u8 *bmaControls; 2020 2021 if (state->mixer->protocol == UAC_VERSION_1) { 2022 csize = hdr->bControlSize; 2023 channels = (hdr->bLength - 7) / csize - 1; 2024 bmaControls = hdr->bmaControls; 2025 } else if (state->mixer->protocol == UAC_VERSION_2) { 2026 struct uac2_feature_unit_descriptor *ftr = _ftr; 2027 csize = 4; 2028 channels = (hdr->bLength - 6) / 4 - 1; 2029 bmaControls = ftr->bmaControls; 2030 } else { /* UAC_VERSION_3 */ 2031 struct uac3_feature_unit_descriptor *ftr = _ftr; 2032 2033 csize = 4; 2034 channels = (ftr->bLength - 7) / 4 - 1; 2035 bmaControls = ftr->bmaControls; 2036 } 2037 2038 /* parse the source unit */ 2039 err = parse_audio_unit(state, hdr->bSourceID); 2040 if (err < 0) 2041 return err; 2042 2043 /* determine the input source type and name */ 2044 err = check_input_term(state, hdr->bSourceID, &iterm); 2045 if (err < 0) 2046 return err; 2047 2048 master_bits = snd_usb_combine_bytes(bmaControls, csize); 2049 /* master configuration quirks */ 2050 switch (state->chip->usb_id) { 2051 case USB_ID(0x08bb, 0x2702): 2052 usb_audio_info(state->chip, 2053 "usbmixer: master volume quirk for PCM2702 chip\n"); 2054 /* disable non-functional volume control */ 2055 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME); 2056 break; 2057 case USB_ID(0x1130, 0xf211): 2058 usb_audio_info(state->chip, 2059 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n"); 2060 /* disable non-functional volume control */ 2061 channels = 0; 2062 break; 2063 2064 } 2065 2066 if (state->mixer->protocol == UAC_VERSION_1) { 2067 /* check all control types */ 2068 for (i = 0; i < 10; i++) { 2069 unsigned int ch_bits = 0; 2070 int control = audio_feature_info[i].control; 2071 2072 for (j = 0; j < channels; j++) { 2073 unsigned int mask; 2074 2075 mask = snd_usb_combine_bytes(bmaControls + 2076 csize * (j+1), csize); 2077 if (mask & (1 << i)) 2078 ch_bits |= (1 << j); 2079 } 2080 /* audio class v1 controls are never read-only */ 2081 2082 /* 2083 * The first channel must be set 2084 * (for ease of programming). 2085 */ 2086 if (ch_bits & 1) 2087 build_feature_ctl(state, _ftr, ch_bits, control, 2088 &iterm, unitid, 0); 2089 if (master_bits & (1 << i)) 2090 build_feature_ctl(state, _ftr, 0, control, 2091 &iterm, unitid, 0); 2092 } 2093 } else { /* UAC_VERSION_2/3 */ 2094 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) { 2095 unsigned int ch_bits = 0; 2096 unsigned int ch_read_only = 0; 2097 int control = audio_feature_info[i].control; 2098 2099 for (j = 0; j < channels; j++) { 2100 unsigned int mask; 2101 2102 mask = snd_usb_combine_bytes(bmaControls + 2103 csize * (j+1), csize); 2104 if (uac_v2v3_control_is_readable(mask, control)) { 2105 ch_bits |= (1 << j); 2106 if (!uac_v2v3_control_is_writeable(mask, control)) 2107 ch_read_only |= (1 << j); 2108 } 2109 } 2110 2111 /* 2112 * NOTE: build_feature_ctl() will mark the control 2113 * read-only if all channels are marked read-only in 2114 * the descriptors. Otherwise, the control will be 2115 * reported as writeable, but the driver will not 2116 * actually issue a write command for read-only 2117 * channels. 2118 */ 2119 2120 /* 2121 * The first channel must be set 2122 * (for ease of programming). 2123 */ 2124 if (ch_bits & 1) 2125 build_feature_ctl(state, _ftr, ch_bits, control, 2126 &iterm, unitid, ch_read_only); 2127 if (uac_v2v3_control_is_readable(master_bits, control)) 2128 build_feature_ctl(state, _ftr, 0, control, 2129 &iterm, unitid, 2130 !uac_v2v3_control_is_writeable(master_bits, 2131 control)); 2132 } 2133 } 2134 2135 return 0; 2136 } 2137 2138 /* 2139 * Mixer Unit 2140 */ 2141 2142 /* check whether the given in/out overflows bmMixerControls matrix */ 2143 static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc, 2144 int protocol, int num_ins, int num_outs) 2145 { 2146 u8 *hdr = (u8 *)desc; 2147 u8 *c = uac_mixer_unit_bmControls(desc, protocol); 2148 size_t rest; /* remaining bytes after bmMixerControls */ 2149 2150 switch (protocol) { 2151 case UAC_VERSION_1: 2152 default: 2153 rest = 1; /* iMixer */ 2154 break; 2155 case UAC_VERSION_2: 2156 rest = 2; /* bmControls + iMixer */ 2157 break; 2158 case UAC_VERSION_3: 2159 rest = 6; /* bmControls + wMixerDescrStr */ 2160 break; 2161 } 2162 2163 /* overflow? */ 2164 return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0]; 2165 } 2166 2167 /* 2168 * build a mixer unit control 2169 * 2170 * the callbacks are identical with feature unit. 2171 * input channel number (zero based) is given in control field instead. 2172 */ 2173 static void build_mixer_unit_ctl(struct mixer_build *state, 2174 struct uac_mixer_unit_descriptor *desc, 2175 int in_pin, int in_ch, int num_outs, 2176 int unitid, struct usb_audio_term *iterm) 2177 { 2178 struct usb_mixer_elem_info *cval; 2179 unsigned int i, len; 2180 struct snd_kcontrol *kctl; 2181 const struct usbmix_name_map *map; 2182 2183 map = find_map(state->map, unitid, 0); 2184 if (check_ignored_ctl(map)) 2185 return; 2186 2187 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 2188 if (!cval) 2189 return; 2190 2191 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid); 2192 cval->control = in_ch + 1; /* based on 1 */ 2193 cval->val_type = USB_MIXER_S16; 2194 for (i = 0; i < num_outs; i++) { 2195 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol); 2196 2197 if (check_matrix_bitmap(c, in_ch, i, num_outs)) { 2198 cval->cmask |= (1 << i); 2199 cval->channels++; 2200 } 2201 } 2202 2203 /* get min/max values */ 2204 get_min_max(cval, 0); 2205 2206 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval); 2207 if (!kctl) { 2208 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 2209 usb_mixer_elem_info_free(cval); 2210 return; 2211 } 2212 kctl->private_free = snd_usb_mixer_elem_free; 2213 2214 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)); 2215 if (!len) 2216 len = get_term_name(state->chip, iterm, kctl->id.name, 2217 sizeof(kctl->id.name), 0); 2218 if (!len) 2219 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1); 2220 append_ctl_name(kctl, " Volume"); 2221 2222 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n", 2223 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max); 2224 snd_usb_mixer_add_control(&cval->head, kctl); 2225 } 2226 2227 static int parse_audio_input_terminal(struct mixer_build *state, int unitid, 2228 void *raw_desc) 2229 { 2230 struct usb_audio_term iterm; 2231 unsigned int control, bmctls, term_id; 2232 2233 if (state->mixer->protocol == UAC_VERSION_2) { 2234 struct uac2_input_terminal_descriptor *d_v2 = raw_desc; 2235 control = UAC2_TE_CONNECTOR; 2236 term_id = d_v2->bTerminalID; 2237 bmctls = le16_to_cpu(d_v2->bmControls); 2238 } else if (state->mixer->protocol == UAC_VERSION_3) { 2239 struct uac3_input_terminal_descriptor *d_v3 = raw_desc; 2240 control = UAC3_TE_INSERTION; 2241 term_id = d_v3->bTerminalID; 2242 bmctls = le32_to_cpu(d_v3->bmControls); 2243 } else { 2244 return 0; /* UAC1. No Insertion control */ 2245 } 2246 2247 check_input_term(state, term_id, &iterm); 2248 2249 /* Check for jack detection. */ 2250 if ((iterm.type & 0xff00) != 0x0100 && 2251 uac_v2v3_control_is_readable(bmctls, control)) 2252 build_connector_control(state->mixer, state->map, &iterm, true); 2253 2254 return 0; 2255 } 2256 2257 /* 2258 * parse a mixer unit 2259 */ 2260 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, 2261 void *raw_desc) 2262 { 2263 struct uac_mixer_unit_descriptor *desc = raw_desc; 2264 struct usb_audio_term iterm; 2265 int input_pins, num_ins, num_outs; 2266 int pin, ich, err; 2267 2268 err = uac_mixer_unit_get_channels(state, desc); 2269 if (err < 0) { 2270 usb_audio_err(state->chip, 2271 "invalid MIXER UNIT descriptor %d\n", 2272 unitid); 2273 return err; 2274 } 2275 2276 num_outs = err; 2277 input_pins = desc->bNrInPins; 2278 2279 num_ins = 0; 2280 ich = 0; 2281 for (pin = 0; pin < input_pins; pin++) { 2282 err = parse_audio_unit(state, desc->baSourceID[pin]); 2283 if (err < 0) 2284 continue; 2285 /* no bmControls field (e.g. Maya44) -> ignore */ 2286 if (!num_outs) 2287 continue; 2288 err = check_input_term(state, desc->baSourceID[pin], &iterm); 2289 if (err < 0) 2290 return err; 2291 num_ins += iterm.channels; 2292 if (mixer_bitmap_overflow(desc, state->mixer->protocol, 2293 num_ins, num_outs)) 2294 break; 2295 for (; ich < num_ins; ich++) { 2296 int och, ich_has_controls = 0; 2297 2298 for (och = 0; och < num_outs; och++) { 2299 __u8 *c = uac_mixer_unit_bmControls(desc, 2300 state->mixer->protocol); 2301 2302 if (check_matrix_bitmap(c, ich, och, num_outs)) { 2303 ich_has_controls = 1; 2304 break; 2305 } 2306 } 2307 if (ich_has_controls) 2308 build_mixer_unit_ctl(state, desc, pin, ich, num_outs, 2309 unitid, &iterm); 2310 } 2311 } 2312 return 0; 2313 } 2314 2315 /* 2316 * Processing Unit / Extension Unit 2317 */ 2318 2319 /* get callback for processing/extension unit */ 2320 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, 2321 struct snd_ctl_elem_value *ucontrol) 2322 { 2323 struct usb_mixer_elem_info *cval = kcontrol->private_data; 2324 int err, val; 2325 2326 err = get_cur_ctl_value(cval, cval->control << 8, &val); 2327 if (err < 0) { 2328 ucontrol->value.integer.value[0] = cval->min; 2329 return filter_error(cval, err); 2330 } 2331 val = get_relative_value(cval, val); 2332 ucontrol->value.integer.value[0] = val; 2333 return 0; 2334 } 2335 2336 /* put callback for processing/extension unit */ 2337 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, 2338 struct snd_ctl_elem_value *ucontrol) 2339 { 2340 struct usb_mixer_elem_info *cval = kcontrol->private_data; 2341 int val, oval, err; 2342 2343 err = get_cur_ctl_value(cval, cval->control << 8, &oval); 2344 if (err < 0) 2345 return filter_error(cval, err); 2346 val = ucontrol->value.integer.value[0]; 2347 val = get_abs_value(cval, val); 2348 if (val != oval) { 2349 set_cur_ctl_value(cval, cval->control << 8, val); 2350 return 1; 2351 } 2352 return 0; 2353 } 2354 2355 /* alsa control interface for processing/extension unit */ 2356 static const struct snd_kcontrol_new mixer_procunit_ctl = { 2357 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 2358 .name = "", /* will be filled later */ 2359 .info = mixer_ctl_feature_info, 2360 .get = mixer_ctl_procunit_get, 2361 .put = mixer_ctl_procunit_put, 2362 }; 2363 2364 /* 2365 * predefined data for processing units 2366 */ 2367 struct procunit_value_info { 2368 int control; 2369 const char *suffix; 2370 int val_type; 2371 int min_value; 2372 }; 2373 2374 struct procunit_info { 2375 int type; 2376 char *name; 2377 const struct procunit_value_info *values; 2378 }; 2379 2380 static const struct procunit_value_info undefined_proc_info[] = { 2381 { 0x00, "Control Undefined", 0 }, 2382 { 0 } 2383 }; 2384 2385 static const struct procunit_value_info updown_proc_info[] = { 2386 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 2387 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 }, 2388 { 0 } 2389 }; 2390 static const struct procunit_value_info prologic_proc_info[] = { 2391 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 2392 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 }, 2393 { 0 } 2394 }; 2395 static const struct procunit_value_info threed_enh_proc_info[] = { 2396 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 2397 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 }, 2398 { 0 } 2399 }; 2400 static const struct procunit_value_info reverb_proc_info[] = { 2401 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 2402 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 }, 2403 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 }, 2404 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 }, 2405 { 0 } 2406 }; 2407 static const struct procunit_value_info chorus_proc_info[] = { 2408 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 2409 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 }, 2410 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 }, 2411 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 }, 2412 { 0 } 2413 }; 2414 static const struct procunit_value_info dcr_proc_info[] = { 2415 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 2416 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 }, 2417 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 }, 2418 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 }, 2419 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 }, 2420 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 }, 2421 { 0 } 2422 }; 2423 2424 static const struct procunit_info procunits[] = { 2425 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info }, 2426 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info }, 2427 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info }, 2428 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info }, 2429 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info }, 2430 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info }, 2431 { 0 }, 2432 }; 2433 2434 static const struct procunit_value_info uac3_updown_proc_info[] = { 2435 { UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 }, 2436 { 0 } 2437 }; 2438 static const struct procunit_value_info uac3_stereo_ext_proc_info[] = { 2439 { UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 }, 2440 { 0 } 2441 }; 2442 2443 static const struct procunit_info uac3_procunits[] = { 2444 { UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info }, 2445 { UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info }, 2446 { UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info }, 2447 { 0 }, 2448 }; 2449 2450 /* 2451 * predefined data for extension units 2452 */ 2453 static const struct procunit_value_info clock_rate_xu_info[] = { 2454 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 }, 2455 { 0 } 2456 }; 2457 static const struct procunit_value_info clock_source_xu_info[] = { 2458 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN }, 2459 { 0 } 2460 }; 2461 static const struct procunit_value_info spdif_format_xu_info[] = { 2462 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN }, 2463 { 0 } 2464 }; 2465 static const struct procunit_value_info soft_limit_xu_info[] = { 2466 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN }, 2467 { 0 } 2468 }; 2469 static const struct procunit_info extunits[] = { 2470 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info }, 2471 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info }, 2472 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info }, 2473 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info }, 2474 { 0 } 2475 }; 2476 2477 /* 2478 * build a processing/extension unit 2479 */ 2480 static int build_audio_procunit(struct mixer_build *state, int unitid, 2481 void *raw_desc, const struct procunit_info *list, 2482 bool extension_unit) 2483 { 2484 struct uac_processing_unit_descriptor *desc = raw_desc; 2485 int num_ins; 2486 struct usb_mixer_elem_info *cval; 2487 struct snd_kcontrol *kctl; 2488 int i, err, nameid, type, len, val; 2489 const struct procunit_info *info; 2490 const struct procunit_value_info *valinfo; 2491 const struct usbmix_name_map *map; 2492 static const struct procunit_value_info default_value_info[] = { 2493 { 0x01, "Switch", USB_MIXER_BOOLEAN }, 2494 { 0 } 2495 }; 2496 static const struct procunit_info default_info = { 2497 0, NULL, default_value_info 2498 }; 2499 const char *name = extension_unit ? 2500 "Extension Unit" : "Processing Unit"; 2501 2502 num_ins = desc->bNrInPins; 2503 for (i = 0; i < num_ins; i++) { 2504 err = parse_audio_unit(state, desc->baSourceID[i]); 2505 if (err < 0) 2506 return err; 2507 } 2508 2509 type = le16_to_cpu(desc->wProcessType); 2510 for (info = list; info && info->type; info++) 2511 if (info->type == type) 2512 break; 2513 if (!info || !info->type) 2514 info = &default_info; 2515 2516 for (valinfo = info->values; valinfo->control; valinfo++) { 2517 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol); 2518 2519 if (state->mixer->protocol == UAC_VERSION_1) { 2520 if (!(controls[valinfo->control / 8] & 2521 (1 << ((valinfo->control % 8) - 1)))) 2522 continue; 2523 } else { /* UAC_VERSION_2/3 */ 2524 if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8], 2525 valinfo->control)) 2526 continue; 2527 } 2528 2529 map = find_map(state->map, unitid, valinfo->control); 2530 if (check_ignored_ctl(map)) 2531 continue; 2532 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 2533 if (!cval) 2534 return -ENOMEM; 2535 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid); 2536 cval->control = valinfo->control; 2537 cval->val_type = valinfo->val_type; 2538 cval->channels = 1; 2539 2540 if (state->mixer->protocol > UAC_VERSION_1 && 2541 !uac_v2v3_control_is_writeable(controls[valinfo->control / 8], 2542 valinfo->control)) 2543 cval->master_readonly = 1; 2544 2545 /* get min/max values */ 2546 switch (type) { 2547 case UAC_PROCESS_UP_DOWNMIX: { 2548 bool mode_sel = false; 2549 2550 switch (state->mixer->protocol) { 2551 case UAC_VERSION_1: 2552 case UAC_VERSION_2: 2553 default: 2554 if (cval->control == UAC_UD_MODE_SELECT) 2555 mode_sel = true; 2556 break; 2557 case UAC_VERSION_3: 2558 if (cval->control == UAC3_UD_MODE_SELECT) 2559 mode_sel = true; 2560 break; 2561 } 2562 2563 if (mode_sel) { 2564 __u8 *control_spec = uac_processing_unit_specific(desc, 2565 state->mixer->protocol); 2566 cval->min = 1; 2567 cval->max = control_spec[0]; 2568 cval->res = 1; 2569 cval->initialized = 1; 2570 break; 2571 } 2572 2573 get_min_max(cval, valinfo->min_value); 2574 break; 2575 } 2576 case USB_XU_CLOCK_RATE: 2577 /* 2578 * E-Mu USB 0404/0202/TrackerPre/0204 2579 * samplerate control quirk 2580 */ 2581 cval->min = 0; 2582 cval->max = 5; 2583 cval->res = 1; 2584 cval->initialized = 1; 2585 break; 2586 default: 2587 get_min_max(cval, valinfo->min_value); 2588 break; 2589 } 2590 2591 err = get_cur_ctl_value(cval, cval->control << 8, &val); 2592 if (err < 0) { 2593 usb_mixer_elem_info_free(cval); 2594 return -EINVAL; 2595 } 2596 2597 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval); 2598 if (!kctl) { 2599 usb_mixer_elem_info_free(cval); 2600 return -ENOMEM; 2601 } 2602 kctl->private_free = snd_usb_mixer_elem_free; 2603 2604 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) { 2605 /* nothing */ ; 2606 } else if (info->name) { 2607 strscpy(kctl->id.name, info->name, sizeof(kctl->id.name)); 2608 } else { 2609 if (extension_unit) 2610 nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol); 2611 else 2612 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol); 2613 len = 0; 2614 if (nameid) 2615 len = snd_usb_copy_string_desc(state->chip, 2616 nameid, 2617 kctl->id.name, 2618 sizeof(kctl->id.name)); 2619 if (!len) 2620 strscpy(kctl->id.name, name, sizeof(kctl->id.name)); 2621 } 2622 append_ctl_name(kctl, " "); 2623 append_ctl_name(kctl, valinfo->suffix); 2624 2625 usb_audio_dbg(state->chip, 2626 "[%d] PU [%s] ch = %d, val = %d/%d\n", 2627 cval->head.id, kctl->id.name, cval->channels, 2628 cval->min, cval->max); 2629 2630 err = snd_usb_mixer_add_control(&cval->head, kctl); 2631 if (err < 0) 2632 return err; 2633 } 2634 return 0; 2635 } 2636 2637 static int parse_audio_processing_unit(struct mixer_build *state, int unitid, 2638 void *raw_desc) 2639 { 2640 switch (state->mixer->protocol) { 2641 case UAC_VERSION_1: 2642 case UAC_VERSION_2: 2643 default: 2644 return build_audio_procunit(state, unitid, raw_desc, 2645 procunits, false); 2646 case UAC_VERSION_3: 2647 return build_audio_procunit(state, unitid, raw_desc, 2648 uac3_procunits, false); 2649 } 2650 } 2651 2652 static int parse_audio_extension_unit(struct mixer_build *state, int unitid, 2653 void *raw_desc) 2654 { 2655 /* 2656 * Note that we parse extension units with processing unit descriptors. 2657 * That's ok as the layout is the same. 2658 */ 2659 return build_audio_procunit(state, unitid, raw_desc, extunits, true); 2660 } 2661 2662 /* 2663 * Selector Unit 2664 */ 2665 2666 /* 2667 * info callback for selector unit 2668 * use an enumerator type for routing 2669 */ 2670 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, 2671 struct snd_ctl_elem_info *uinfo) 2672 { 2673 struct usb_mixer_elem_info *cval = kcontrol->private_data; 2674 const char **itemlist = (const char **)kcontrol->private_value; 2675 2676 if (snd_BUG_ON(!itemlist)) 2677 return -EINVAL; 2678 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist); 2679 } 2680 2681 /* get callback for selector unit */ 2682 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, 2683 struct snd_ctl_elem_value *ucontrol) 2684 { 2685 struct usb_mixer_elem_info *cval = kcontrol->private_data; 2686 int val, err; 2687 2688 err = get_cur_ctl_value(cval, cval->control << 8, &val); 2689 if (err < 0) { 2690 ucontrol->value.enumerated.item[0] = 0; 2691 return filter_error(cval, err); 2692 } 2693 val = get_relative_value(cval, val); 2694 ucontrol->value.enumerated.item[0] = val; 2695 return 0; 2696 } 2697 2698 /* put callback for selector unit */ 2699 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, 2700 struct snd_ctl_elem_value *ucontrol) 2701 { 2702 struct usb_mixer_elem_info *cval = kcontrol->private_data; 2703 int val, oval, err; 2704 2705 err = get_cur_ctl_value(cval, cval->control << 8, &oval); 2706 if (err < 0) 2707 return filter_error(cval, err); 2708 val = ucontrol->value.enumerated.item[0]; 2709 val = get_abs_value(cval, val); 2710 if (val != oval) { 2711 set_cur_ctl_value(cval, cval->control << 8, val); 2712 return 1; 2713 } 2714 return 0; 2715 } 2716 2717 /* alsa control interface for selector unit */ 2718 static const struct snd_kcontrol_new mixer_selectunit_ctl = { 2719 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 2720 .name = "", /* will be filled later */ 2721 .info = mixer_ctl_selector_info, 2722 .get = mixer_ctl_selector_get, 2723 .put = mixer_ctl_selector_put, 2724 }; 2725 2726 /* 2727 * private free callback. 2728 * free both private_data and private_value 2729 */ 2730 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl) 2731 { 2732 int i, num_ins = 0; 2733 2734 if (kctl->private_data) { 2735 struct usb_mixer_elem_info *cval = kctl->private_data; 2736 num_ins = cval->max; 2737 usb_mixer_elem_info_free(cval); 2738 kctl->private_data = NULL; 2739 } 2740 if (kctl->private_value) { 2741 char **itemlist = (char **)kctl->private_value; 2742 for (i = 0; i < num_ins; i++) 2743 kfree(itemlist[i]); 2744 kfree(itemlist); 2745 kctl->private_value = 0; 2746 } 2747 } 2748 2749 /* 2750 * parse a selector unit 2751 */ 2752 static int parse_audio_selector_unit(struct mixer_build *state, int unitid, 2753 void *raw_desc) 2754 { 2755 struct uac_selector_unit_descriptor *desc = raw_desc; 2756 unsigned int i, nameid, len; 2757 int err; 2758 struct usb_mixer_elem_info *cval; 2759 struct snd_kcontrol *kctl; 2760 const struct usbmix_name_map *map; 2761 char **namelist; 2762 2763 for (i = 0; i < desc->bNrInPins; i++) { 2764 err = parse_audio_unit(state, desc->baSourceID[i]); 2765 if (err < 0) 2766 return err; 2767 } 2768 2769 if (desc->bNrInPins == 1) /* only one ? nonsense! */ 2770 return 0; 2771 2772 map = find_map(state->map, unitid, 0); 2773 if (check_ignored_ctl(map)) 2774 return 0; 2775 2776 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 2777 if (!cval) 2778 return -ENOMEM; 2779 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid); 2780 cval->val_type = USB_MIXER_U8; 2781 cval->channels = 1; 2782 cval->min = 1; 2783 cval->max = desc->bNrInPins; 2784 cval->res = 1; 2785 cval->initialized = 1; 2786 2787 switch (state->mixer->protocol) { 2788 case UAC_VERSION_1: 2789 default: 2790 cval->control = 0; 2791 break; 2792 case UAC_VERSION_2: 2793 case UAC_VERSION_3: 2794 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR || 2795 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR) 2796 cval->control = UAC2_CX_CLOCK_SELECTOR; 2797 else /* UAC2/3_SELECTOR_UNIT */ 2798 cval->control = UAC2_SU_SELECTOR; 2799 break; 2800 } 2801 2802 namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL); 2803 if (!namelist) { 2804 err = -ENOMEM; 2805 goto error_cval; 2806 } 2807 #define MAX_ITEM_NAME_LEN 64 2808 for (i = 0; i < desc->bNrInPins; i++) { 2809 struct usb_audio_term iterm; 2810 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL); 2811 if (!namelist[i]) { 2812 err = -ENOMEM; 2813 goto error_name; 2814 } 2815 len = check_mapped_selector_name(state, unitid, i, namelist[i], 2816 MAX_ITEM_NAME_LEN); 2817 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0) 2818 len = get_term_name(state->chip, &iterm, namelist[i], 2819 MAX_ITEM_NAME_LEN, 0); 2820 if (! len) 2821 sprintf(namelist[i], "Input %u", i); 2822 } 2823 2824 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval); 2825 if (! kctl) { 2826 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 2827 err = -ENOMEM; 2828 goto error_name; 2829 } 2830 kctl->private_value = (unsigned long)namelist; 2831 kctl->private_free = usb_mixer_selector_elem_free; 2832 2833 /* check the static mapping table at first */ 2834 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)); 2835 if (!len) { 2836 /* no mapping ? */ 2837 switch (state->mixer->protocol) { 2838 case UAC_VERSION_1: 2839 case UAC_VERSION_2: 2840 default: 2841 /* if iSelector is given, use it */ 2842 nameid = uac_selector_unit_iSelector(desc); 2843 if (nameid) 2844 len = snd_usb_copy_string_desc(state->chip, 2845 nameid, kctl->id.name, 2846 sizeof(kctl->id.name)); 2847 break; 2848 case UAC_VERSION_3: 2849 /* TODO: Class-Specific strings not yet supported */ 2850 break; 2851 } 2852 2853 /* ... or pick up the terminal name at next */ 2854 if (!len) 2855 len = get_term_name(state->chip, &state->oterm, 2856 kctl->id.name, sizeof(kctl->id.name), 0); 2857 /* ... or use the fixed string "USB" as the last resort */ 2858 if (!len) 2859 strscpy(kctl->id.name, "USB", sizeof(kctl->id.name)); 2860 2861 /* and add the proper suffix */ 2862 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR || 2863 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR) 2864 append_ctl_name(kctl, " Clock Source"); 2865 else if ((state->oterm.type & 0xff00) == 0x0100) 2866 append_ctl_name(kctl, " Capture Source"); 2867 else 2868 append_ctl_name(kctl, " Playback Source"); 2869 } 2870 2871 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n", 2872 cval->head.id, kctl->id.name, desc->bNrInPins); 2873 return snd_usb_mixer_add_control(&cval->head, kctl); 2874 2875 error_name: 2876 for (i = 0; i < desc->bNrInPins; i++) 2877 kfree(namelist[i]); 2878 kfree(namelist); 2879 error_cval: 2880 usb_mixer_elem_info_free(cval); 2881 return err; 2882 } 2883 2884 /* 2885 * parse an audio unit recursively 2886 */ 2887 2888 static int parse_audio_unit(struct mixer_build *state, int unitid) 2889 { 2890 unsigned char *p1; 2891 int protocol = state->mixer->protocol; 2892 2893 if (test_and_set_bit(unitid, state->unitbitmap)) 2894 return 0; /* the unit already visited */ 2895 2896 p1 = find_audio_control_unit(state, unitid); 2897 if (!p1) { 2898 usb_audio_err(state->chip, "unit %d not found!\n", unitid); 2899 return -EINVAL; 2900 } 2901 2902 if (!snd_usb_validate_audio_desc(p1, protocol)) { 2903 usb_audio_dbg(state->chip, "invalid unit %d\n", unitid); 2904 return 0; /* skip invalid unit */ 2905 } 2906 2907 switch (PTYPE(protocol, p1[2])) { 2908 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL): 2909 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL): 2910 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL): 2911 return parse_audio_input_terminal(state, unitid, p1); 2912 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT): 2913 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT): 2914 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT): 2915 return parse_audio_mixer_unit(state, unitid, p1); 2916 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE): 2917 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE): 2918 return parse_clock_source_unit(state, unitid, p1); 2919 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT): 2920 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT): 2921 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT): 2922 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR): 2923 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR): 2924 return parse_audio_selector_unit(state, unitid, p1); 2925 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT): 2926 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT): 2927 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT): 2928 return parse_audio_feature_unit(state, unitid, p1); 2929 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT): 2930 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2): 2931 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT): 2932 return parse_audio_processing_unit(state, unitid, p1); 2933 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT): 2934 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2): 2935 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT): 2936 return parse_audio_extension_unit(state, unitid, p1); 2937 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT): 2938 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT): 2939 return 0; /* FIXME - effect units not implemented yet */ 2940 default: 2941 usb_audio_err(state->chip, 2942 "unit %u: unexpected type 0x%02x\n", 2943 unitid, p1[2]); 2944 return -EINVAL; 2945 } 2946 } 2947 2948 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer) 2949 { 2950 /* kill pending URBs */ 2951 snd_usb_mixer_disconnect(mixer); 2952 2953 kfree(mixer->id_elems); 2954 if (mixer->urb) { 2955 kfree(mixer->urb->transfer_buffer); 2956 usb_free_urb(mixer->urb); 2957 } 2958 usb_free_urb(mixer->rc_urb); 2959 kfree(mixer->rc_setup_packet); 2960 kfree(mixer); 2961 } 2962 2963 static int snd_usb_mixer_dev_free(struct snd_device *device) 2964 { 2965 struct usb_mixer_interface *mixer = device->device_data; 2966 snd_usb_mixer_free(mixer); 2967 return 0; 2968 } 2969 2970 /* UAC3 predefined channels configuration */ 2971 struct uac3_badd_profile { 2972 int subclass; 2973 const char *name; 2974 int c_chmask; /* capture channels mask */ 2975 int p_chmask; /* playback channels mask */ 2976 int st_chmask; /* side tone mixing channel mask */ 2977 }; 2978 2979 static const struct uac3_badd_profile uac3_badd_profiles[] = { 2980 { 2981 /* 2982 * BAIF, BAOF or combination of both 2983 * IN: Mono or Stereo cfg, Mono alt possible 2984 * OUT: Mono or Stereo cfg, Mono alt possible 2985 */ 2986 .subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO, 2987 .name = "GENERIC IO", 2988 .c_chmask = -1, /* dynamic channels */ 2989 .p_chmask = -1, /* dynamic channels */ 2990 }, 2991 { 2992 /* BAOF; Stereo only cfg, Mono alt possible */ 2993 .subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE, 2994 .name = "HEADPHONE", 2995 .p_chmask = 3, 2996 }, 2997 { 2998 /* BAOF; Mono or Stereo cfg, Mono alt possible */ 2999 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER, 3000 .name = "SPEAKER", 3001 .p_chmask = -1, /* dynamic channels */ 3002 }, 3003 { 3004 /* BAIF; Mono or Stereo cfg, Mono alt possible */ 3005 .subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE, 3006 .name = "MICROPHONE", 3007 .c_chmask = -1, /* dynamic channels */ 3008 }, 3009 { 3010 /* 3011 * BAIOF topology 3012 * IN: Mono only 3013 * OUT: Mono or Stereo cfg, Mono alt possible 3014 */ 3015 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET, 3016 .name = "HEADSET", 3017 .c_chmask = 1, 3018 .p_chmask = -1, /* dynamic channels */ 3019 .st_chmask = 1, 3020 }, 3021 { 3022 /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */ 3023 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER, 3024 .name = "HEADSET ADAPTER", 3025 .c_chmask = 1, 3026 .p_chmask = 3, 3027 .st_chmask = 1, 3028 }, 3029 { 3030 /* BAIF + BAOF; IN: Mono only; OUT: Mono only */ 3031 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE, 3032 .name = "SPEAKERPHONE", 3033 .c_chmask = 1, 3034 .p_chmask = 1, 3035 }, 3036 { 0 } /* terminator */ 3037 }; 3038 3039 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer, 3040 const struct uac3_badd_profile *f, 3041 int c_chmask, int p_chmask) 3042 { 3043 /* 3044 * If both playback/capture channels are dynamic, make sure 3045 * at least one channel is present 3046 */ 3047 if (f->c_chmask < 0 && f->p_chmask < 0) { 3048 if (!c_chmask && !p_chmask) { 3049 usb_audio_warn(mixer->chip, "BAAD %s: no channels?", 3050 f->name); 3051 return false; 3052 } 3053 return true; 3054 } 3055 3056 if ((f->c_chmask < 0 && !c_chmask) || 3057 (f->c_chmask >= 0 && f->c_chmask != c_chmask)) { 3058 usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch", 3059 f->name); 3060 return false; 3061 } 3062 if ((f->p_chmask < 0 && !p_chmask) || 3063 (f->p_chmask >= 0 && f->p_chmask != p_chmask)) { 3064 usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch", 3065 f->name); 3066 return false; 3067 } 3068 return true; 3069 } 3070 3071 /* 3072 * create mixer controls for UAC3 BADD profiles 3073 * 3074 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything 3075 * 3076 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it 3077 */ 3078 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer, 3079 int ctrlif) 3080 { 3081 struct usb_device *dev = mixer->chip->dev; 3082 struct usb_interface_assoc_descriptor *assoc; 3083 int badd_profile = mixer->chip->badd_profile; 3084 const struct uac3_badd_profile *f; 3085 const struct usbmix_ctl_map *map; 3086 int p_chmask = 0, c_chmask = 0, st_chmask = 0; 3087 int i; 3088 3089 assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc; 3090 3091 /* Detect BADD capture/playback channels from AS EP descriptors */ 3092 for (i = 0; i < assoc->bInterfaceCount; i++) { 3093 int intf = assoc->bFirstInterface + i; 3094 3095 struct usb_interface *iface; 3096 struct usb_host_interface *alts; 3097 struct usb_interface_descriptor *altsd; 3098 unsigned int maxpacksize; 3099 char dir_in; 3100 int chmask, num; 3101 3102 if (intf == ctrlif) 3103 continue; 3104 3105 iface = usb_ifnum_to_if(dev, intf); 3106 if (!iface) 3107 continue; 3108 3109 num = iface->num_altsetting; 3110 3111 if (num < 2) 3112 return -EINVAL; 3113 3114 /* 3115 * The number of Channels in an AudioStreaming interface 3116 * and the audio sample bit resolution (16 bits or 24 3117 * bits) can be derived from the wMaxPacketSize field in 3118 * the Standard AS Audio Data Endpoint descriptor in 3119 * Alternate Setting 1 3120 */ 3121 alts = &iface->altsetting[1]; 3122 altsd = get_iface_desc(alts); 3123 3124 if (altsd->bNumEndpoints < 1) 3125 return -EINVAL; 3126 3127 /* check direction */ 3128 dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN); 3129 maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize); 3130 3131 switch (maxpacksize) { 3132 default: 3133 usb_audio_err(mixer->chip, 3134 "incorrect wMaxPacketSize 0x%x for BADD profile\n", 3135 maxpacksize); 3136 return -EINVAL; 3137 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16: 3138 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16: 3139 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24: 3140 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24: 3141 chmask = 1; 3142 break; 3143 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16: 3144 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16: 3145 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24: 3146 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24: 3147 chmask = 3; 3148 break; 3149 } 3150 3151 if (dir_in) 3152 c_chmask = chmask; 3153 else 3154 p_chmask = chmask; 3155 } 3156 3157 usb_audio_dbg(mixer->chip, 3158 "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n", 3159 badd_profile, c_chmask, p_chmask); 3160 3161 /* check the mapping table */ 3162 for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) { 3163 if (map->id == badd_profile) 3164 break; 3165 } 3166 3167 if (!map->id) 3168 return -EINVAL; 3169 3170 for (f = uac3_badd_profiles; f->name; f++) { 3171 if (badd_profile == f->subclass) 3172 break; 3173 } 3174 if (!f->name) 3175 return -EINVAL; 3176 if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask)) 3177 return -EINVAL; 3178 st_chmask = f->st_chmask; 3179 3180 /* Playback */ 3181 if (p_chmask) { 3182 /* Master channel, always writable */ 3183 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE, 3184 UAC3_BADD_FU_ID2, map->map); 3185 /* Mono/Stereo volume channels, always writable */ 3186 build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME, 3187 UAC3_BADD_FU_ID2, map->map); 3188 } 3189 3190 /* Capture */ 3191 if (c_chmask) { 3192 /* Master channel, always writable */ 3193 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE, 3194 UAC3_BADD_FU_ID5, map->map); 3195 /* Mono/Stereo volume channels, always writable */ 3196 build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME, 3197 UAC3_BADD_FU_ID5, map->map); 3198 } 3199 3200 /* Side tone-mixing */ 3201 if (st_chmask) { 3202 /* Master channel, always writable */ 3203 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE, 3204 UAC3_BADD_FU_ID7, map->map); 3205 /* Mono volume channel, always writable */ 3206 build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME, 3207 UAC3_BADD_FU_ID7, map->map); 3208 } 3209 3210 /* Insertion Control */ 3211 if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) { 3212 struct usb_audio_term iterm, oterm; 3213 3214 /* Input Term - Insertion control */ 3215 memset(&iterm, 0, sizeof(iterm)); 3216 iterm.id = UAC3_BADD_IT_ID4; 3217 iterm.type = UAC_BIDIR_TERMINAL_HEADSET; 3218 build_connector_control(mixer, map->map, &iterm, true); 3219 3220 /* Output Term - Insertion control */ 3221 memset(&oterm, 0, sizeof(oterm)); 3222 oterm.id = UAC3_BADD_OT_ID3; 3223 oterm.type = UAC_BIDIR_TERMINAL_HEADSET; 3224 build_connector_control(mixer, map->map, &oterm, false); 3225 } 3226 3227 return 0; 3228 } 3229 3230 /* 3231 * create mixer controls 3232 * 3233 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers 3234 */ 3235 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer) 3236 { 3237 struct mixer_build state; 3238 int err; 3239 const struct usbmix_ctl_map *map; 3240 void *p; 3241 3242 memset(&state, 0, sizeof(state)); 3243 state.chip = mixer->chip; 3244 state.mixer = mixer; 3245 state.buffer = mixer->hostif->extra; 3246 state.buflen = mixer->hostif->extralen; 3247 3248 /* check the mapping table */ 3249 for (map = usbmix_ctl_maps; map->id; map++) { 3250 if (map->id == state.chip->usb_id) { 3251 state.map = map->map; 3252 state.selector_map = map->selector_map; 3253 mixer->connector_map = map->connector_map; 3254 break; 3255 } 3256 } 3257 3258 p = NULL; 3259 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra, 3260 mixer->hostif->extralen, 3261 p, UAC_OUTPUT_TERMINAL)) != NULL) { 3262 if (!snd_usb_validate_audio_desc(p, mixer->protocol)) 3263 continue; /* skip invalid descriptor */ 3264 3265 if (mixer->protocol == UAC_VERSION_1) { 3266 struct uac1_output_terminal_descriptor *desc = p; 3267 3268 /* mark terminal ID as visited */ 3269 set_bit(desc->bTerminalID, state.unitbitmap); 3270 state.oterm.id = desc->bTerminalID; 3271 state.oterm.type = le16_to_cpu(desc->wTerminalType); 3272 state.oterm.name = desc->iTerminal; 3273 err = parse_audio_unit(&state, desc->bSourceID); 3274 if (err < 0 && err != -EINVAL) 3275 return err; 3276 } else if (mixer->protocol == UAC_VERSION_2) { 3277 struct uac2_output_terminal_descriptor *desc = p; 3278 3279 /* mark terminal ID as visited */ 3280 set_bit(desc->bTerminalID, state.unitbitmap); 3281 state.oterm.id = desc->bTerminalID; 3282 state.oterm.type = le16_to_cpu(desc->wTerminalType); 3283 state.oterm.name = desc->iTerminal; 3284 err = parse_audio_unit(&state, desc->bSourceID); 3285 if (err < 0 && err != -EINVAL) 3286 return err; 3287 3288 /* 3289 * For UAC2, use the same approach to also add the 3290 * clock selectors 3291 */ 3292 err = parse_audio_unit(&state, desc->bCSourceID); 3293 if (err < 0 && err != -EINVAL) 3294 return err; 3295 3296 if ((state.oterm.type & 0xff00) != 0x0100 && 3297 uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls), 3298 UAC2_TE_CONNECTOR)) { 3299 build_connector_control(state.mixer, state.map, 3300 &state.oterm, false); 3301 } 3302 } else { /* UAC_VERSION_3 */ 3303 struct uac3_output_terminal_descriptor *desc = p; 3304 3305 /* mark terminal ID as visited */ 3306 set_bit(desc->bTerminalID, state.unitbitmap); 3307 state.oterm.id = desc->bTerminalID; 3308 state.oterm.type = le16_to_cpu(desc->wTerminalType); 3309 state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr); 3310 err = parse_audio_unit(&state, desc->bSourceID); 3311 if (err < 0 && err != -EINVAL) 3312 return err; 3313 3314 /* 3315 * For UAC3, use the same approach to also add the 3316 * clock selectors 3317 */ 3318 err = parse_audio_unit(&state, desc->bCSourceID); 3319 if (err < 0 && err != -EINVAL) 3320 return err; 3321 3322 if ((state.oterm.type & 0xff00) != 0x0100 && 3323 uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls), 3324 UAC3_TE_INSERTION)) { 3325 build_connector_control(state.mixer, state.map, 3326 &state.oterm, false); 3327 } 3328 } 3329 } 3330 3331 return 0; 3332 } 3333 3334 static int delegate_notify(struct usb_mixer_interface *mixer, int unitid, 3335 u8 *control, u8 *channel) 3336 { 3337 const struct usbmix_connector_map *map = mixer->connector_map; 3338 3339 if (!map) 3340 return unitid; 3341 3342 for (; map->id; map++) { 3343 if (map->id == unitid) { 3344 if (control && map->control) 3345 *control = map->control; 3346 if (channel && map->channel) 3347 *channel = map->channel; 3348 return map->delegated_id; 3349 } 3350 } 3351 return unitid; 3352 } 3353 3354 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid) 3355 { 3356 struct usb_mixer_elem_list *list; 3357 3358 unitid = delegate_notify(mixer, unitid, NULL, NULL); 3359 3360 for_each_mixer_elem(list, mixer, unitid) { 3361 struct usb_mixer_elem_info *info; 3362 3363 if (!list->is_std_info) 3364 continue; 3365 info = mixer_elem_list_to_info(list); 3366 /* invalidate cache, so the value is read from the device */ 3367 info->cached = 0; 3368 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE, 3369 &list->kctl->id); 3370 } 3371 } 3372 3373 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer, 3374 struct usb_mixer_elem_list *list) 3375 { 3376 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list); 3377 static const char * const val_types[] = { 3378 [USB_MIXER_BOOLEAN] = "BOOLEAN", 3379 [USB_MIXER_INV_BOOLEAN] = "INV_BOOLEAN", 3380 [USB_MIXER_S8] = "S8", 3381 [USB_MIXER_U8] = "U8", 3382 [USB_MIXER_S16] = "S16", 3383 [USB_MIXER_U16] = "U16", 3384 [USB_MIXER_S32] = "S32", 3385 [USB_MIXER_U32] = "U32", 3386 [USB_MIXER_BESPOKEN] = "BESPOKEN", 3387 }; 3388 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, " 3389 "channels=%i, type=\"%s\"\n", cval->head.id, 3390 cval->control, cval->cmask, cval->channels, 3391 val_types[cval->val_type]); 3392 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n", 3393 cval->min, cval->max, cval->dBmin, cval->dBmax); 3394 } 3395 3396 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry, 3397 struct snd_info_buffer *buffer) 3398 { 3399 struct snd_usb_audio *chip = entry->private_data; 3400 struct usb_mixer_interface *mixer; 3401 struct usb_mixer_elem_list *list; 3402 int unitid; 3403 3404 list_for_each_entry(mixer, &chip->mixer_list, list) { 3405 snd_iprintf(buffer, 3406 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n", 3407 chip->usb_id, mixer_ctrl_intf(mixer), 3408 mixer->ignore_ctl_error); 3409 snd_iprintf(buffer, "Card: %s\n", chip->card->longname); 3410 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) { 3411 for_each_mixer_elem(list, mixer, unitid) { 3412 snd_iprintf(buffer, " Unit: %i\n", list->id); 3413 if (list->kctl) 3414 snd_iprintf(buffer, 3415 " Control: name=\"%s\", index=%i\n", 3416 list->kctl->id.name, 3417 list->kctl->id.index); 3418 if (list->dump) 3419 list->dump(buffer, list); 3420 } 3421 } 3422 } 3423 } 3424 3425 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer, 3426 int attribute, int value, int index) 3427 { 3428 struct usb_mixer_elem_list *list; 3429 __u8 unitid = (index >> 8) & 0xff; 3430 __u8 control = (value >> 8) & 0xff; 3431 __u8 channel = value & 0xff; 3432 unsigned int count = 0; 3433 3434 if (channel >= MAX_CHANNELS) { 3435 usb_audio_dbg(mixer->chip, 3436 "%s(): bogus channel number %d\n", 3437 __func__, channel); 3438 return; 3439 } 3440 3441 unitid = delegate_notify(mixer, unitid, &control, &channel); 3442 3443 for_each_mixer_elem(list, mixer, unitid) 3444 count++; 3445 3446 if (count == 0) 3447 return; 3448 3449 for_each_mixer_elem(list, mixer, unitid) { 3450 struct usb_mixer_elem_info *info; 3451 3452 if (!list->kctl) 3453 continue; 3454 if (!list->is_std_info) 3455 continue; 3456 3457 info = mixer_elem_list_to_info(list); 3458 if (count > 1 && info->control != control) 3459 continue; 3460 3461 switch (attribute) { 3462 case UAC2_CS_CUR: 3463 /* invalidate cache, so the value is read from the device */ 3464 if (channel) 3465 info->cached &= ~(1 << channel); 3466 else /* master channel */ 3467 info->cached = 0; 3468 3469 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE, 3470 &info->head.kctl->id); 3471 break; 3472 3473 case UAC2_CS_RANGE: 3474 /* TODO */ 3475 break; 3476 3477 case UAC2_CS_MEM: 3478 /* TODO */ 3479 break; 3480 3481 default: 3482 usb_audio_dbg(mixer->chip, 3483 "unknown attribute %d in interrupt\n", 3484 attribute); 3485 break; 3486 } /* switch */ 3487 } 3488 } 3489 3490 static void snd_usb_mixer_interrupt(struct urb *urb) 3491 { 3492 struct usb_mixer_interface *mixer = urb->context; 3493 int len = urb->actual_length; 3494 int ustatus = urb->status; 3495 3496 if (ustatus != 0) 3497 goto requeue; 3498 3499 if (mixer->protocol == UAC_VERSION_1) { 3500 struct uac1_status_word *status; 3501 3502 for (status = urb->transfer_buffer; 3503 len >= sizeof(*status); 3504 len -= sizeof(*status), status++) { 3505 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n", 3506 status->bStatusType, 3507 status->bOriginator); 3508 3509 /* ignore any notifications not from the control interface */ 3510 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) != 3511 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF) 3512 continue; 3513 3514 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED) 3515 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator); 3516 else 3517 snd_usb_mixer_notify_id(mixer, status->bOriginator); 3518 } 3519 } else { /* UAC_VERSION_2 */ 3520 struct uac2_interrupt_data_msg *msg; 3521 3522 for (msg = urb->transfer_buffer; 3523 len >= sizeof(*msg); 3524 len -= sizeof(*msg), msg++) { 3525 /* drop vendor specific and endpoint requests */ 3526 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) || 3527 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP)) 3528 continue; 3529 3530 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute, 3531 le16_to_cpu(msg->wValue), 3532 le16_to_cpu(msg->wIndex)); 3533 } 3534 } 3535 3536 requeue: 3537 if (ustatus != -ENOENT && 3538 ustatus != -ECONNRESET && 3539 ustatus != -ESHUTDOWN) { 3540 urb->dev = mixer->chip->dev; 3541 usb_submit_urb(urb, GFP_ATOMIC); 3542 } 3543 } 3544 3545 /* create the handler for the optional status interrupt endpoint */ 3546 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer) 3547 { 3548 struct usb_endpoint_descriptor *ep; 3549 void *transfer_buffer; 3550 int buffer_length; 3551 unsigned int epnum; 3552 3553 /* we need one interrupt input endpoint */ 3554 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1) 3555 return 0; 3556 ep = get_endpoint(mixer->hostif, 0); 3557 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep)) 3558 return 0; 3559 3560 epnum = usb_endpoint_num(ep); 3561 buffer_length = le16_to_cpu(ep->wMaxPacketSize); 3562 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL); 3563 if (!transfer_buffer) 3564 return -ENOMEM; 3565 mixer->urb = usb_alloc_urb(0, GFP_KERNEL); 3566 if (!mixer->urb) { 3567 kfree(transfer_buffer); 3568 return -ENOMEM; 3569 } 3570 usb_fill_int_urb(mixer->urb, mixer->chip->dev, 3571 usb_rcvintpipe(mixer->chip->dev, epnum), 3572 transfer_buffer, buffer_length, 3573 snd_usb_mixer_interrupt, mixer, ep->bInterval); 3574 usb_submit_urb(mixer->urb, GFP_KERNEL); 3575 return 0; 3576 } 3577 3578 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif) 3579 { 3580 static const struct snd_device_ops dev_ops = { 3581 .dev_free = snd_usb_mixer_dev_free 3582 }; 3583 struct usb_mixer_interface *mixer; 3584 int err; 3585 3586 strcpy(chip->card->mixername, "USB Mixer"); 3587 3588 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL); 3589 if (!mixer) 3590 return -ENOMEM; 3591 mixer->chip = chip; 3592 mixer->ignore_ctl_error = !!(chip->quirk_flags & QUIRK_FLAG_IGNORE_CTL_ERROR); 3593 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems), 3594 GFP_KERNEL); 3595 if (!mixer->id_elems) { 3596 kfree(mixer); 3597 return -ENOMEM; 3598 } 3599 3600 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0]; 3601 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) { 3602 case UAC_VERSION_1: 3603 default: 3604 mixer->protocol = UAC_VERSION_1; 3605 break; 3606 case UAC_VERSION_2: 3607 mixer->protocol = UAC_VERSION_2; 3608 break; 3609 case UAC_VERSION_3: 3610 mixer->protocol = UAC_VERSION_3; 3611 break; 3612 } 3613 3614 if (mixer->protocol == UAC_VERSION_3 && 3615 chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) { 3616 err = snd_usb_mixer_controls_badd(mixer, ctrlif); 3617 if (err < 0) 3618 goto _error; 3619 } else { 3620 err = snd_usb_mixer_controls(mixer); 3621 if (err < 0) 3622 goto _error; 3623 } 3624 3625 err = snd_usb_mixer_status_create(mixer); 3626 if (err < 0) 3627 goto _error; 3628 3629 err = snd_usb_mixer_apply_create_quirk(mixer); 3630 if (err < 0) 3631 goto _error; 3632 3633 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops); 3634 if (err < 0) 3635 goto _error; 3636 3637 if (list_empty(&chip->mixer_list)) 3638 snd_card_ro_proc_new(chip->card, "usbmixer", chip, 3639 snd_usb_mixer_proc_read); 3640 3641 list_add(&mixer->list, &chip->mixer_list); 3642 return 0; 3643 3644 _error: 3645 snd_usb_mixer_free(mixer); 3646 return err; 3647 } 3648 3649 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer) 3650 { 3651 if (mixer->disconnected) 3652 return; 3653 if (mixer->urb) 3654 usb_kill_urb(mixer->urb); 3655 if (mixer->rc_urb) 3656 usb_kill_urb(mixer->rc_urb); 3657 if (mixer->private_free) 3658 mixer->private_free(mixer); 3659 mixer->disconnected = true; 3660 } 3661 3662 /* stop any bus activity of a mixer */ 3663 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer) 3664 { 3665 usb_kill_urb(mixer->urb); 3666 usb_kill_urb(mixer->rc_urb); 3667 } 3668 3669 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer) 3670 { 3671 int err; 3672 3673 if (mixer->urb) { 3674 err = usb_submit_urb(mixer->urb, GFP_NOIO); 3675 if (err < 0) 3676 return err; 3677 } 3678 3679 return 0; 3680 } 3681 3682 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer) 3683 { 3684 snd_usb_mixer_inactivate(mixer); 3685 if (mixer->private_suspend) 3686 mixer->private_suspend(mixer); 3687 return 0; 3688 } 3689 3690 static int restore_mixer_value(struct usb_mixer_elem_list *list) 3691 { 3692 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list); 3693 int c, err, idx; 3694 3695 if (cval->val_type == USB_MIXER_BESPOKEN) 3696 return 0; 3697 3698 if (cval->cmask) { 3699 idx = 0; 3700 for (c = 0; c < MAX_CHANNELS; c++) { 3701 if (!(cval->cmask & (1 << c))) 3702 continue; 3703 if (cval->cached & (1 << (c + 1))) { 3704 err = snd_usb_set_cur_mix_value(cval, c + 1, idx, 3705 cval->cache_val[idx]); 3706 if (err < 0) 3707 break; 3708 } 3709 idx++; 3710 } 3711 } else { 3712 /* master */ 3713 if (cval->cached) 3714 snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val); 3715 } 3716 3717 return 0; 3718 } 3719 3720 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer) 3721 { 3722 struct usb_mixer_elem_list *list; 3723 int id, err; 3724 3725 /* restore cached mixer values */ 3726 for (id = 0; id < MAX_ID_ELEMS; id++) { 3727 for_each_mixer_elem(list, mixer, id) { 3728 if (list->resume) { 3729 err = list->resume(list); 3730 if (err < 0) 3731 return err; 3732 } 3733 } 3734 } 3735 3736 snd_usb_mixer_resume_quirk(mixer); 3737 3738 return snd_usb_mixer_activate(mixer); 3739 } 3740 3741 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list, 3742 struct usb_mixer_interface *mixer, 3743 int unitid) 3744 { 3745 list->mixer = mixer; 3746 list->id = unitid; 3747 list->dump = snd_usb_mixer_dump_cval; 3748 list->resume = restore_mixer_value; 3749 } 3750