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