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