1 /* 2 * (Tentative) USB Audio Driver for ALSA 3 * 4 * Mixer control part 5 * 6 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de> 7 * 8 * Many codes borrowed from audio.c by 9 * Alan Cox (alan@lxorguk.ukuu.org.uk) 10 * Thomas Sailer (sailer@ife.ee.ethz.ch) 11 * 12 * 13 * This program is free software; you can redistribute it and/or modify 14 * it under the terms of the GNU General Public License as published by 15 * the Free Software Foundation; either version 2 of the License, or 16 * (at your option) any later version. 17 * 18 * This program is distributed in the hope that it will be useful, 19 * but WITHOUT ANY WARRANTY; without even the implied warranty of 20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 * GNU General Public License for more details. 22 * 23 * You should have received a copy of the GNU General Public License 24 * along with this program; if not, write to the Free Software 25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 26 * 27 */ 28 29 /* 30 * TODOs, for both the mixer and the streaming interfaces: 31 * 32 * - support for UAC2 effect units 33 * - support for graphical equalizers 34 * - RANGE and MEM set commands (UAC2) 35 * - RANGE and MEM interrupt dispatchers (UAC2) 36 * - audio channel clustering (UAC2) 37 * - audio sample rate converter units (UAC2) 38 * - proper handling of clock multipliers (UAC2) 39 * - dispatch clock change notifications (UAC2) 40 * - stop PCM streams which use a clock that became invalid 41 * - stop PCM streams which use a clock selector that has changed 42 * - parse available sample rates again when clock sources changed 43 */ 44 45 #include <linux/bitops.h> 46 #include <linux/init.h> 47 #include <linux/list.h> 48 #include <linux/slab.h> 49 #include <linux/string.h> 50 #include <linux/usb.h> 51 #include <linux/usb/audio.h> 52 #include <linux/usb/audio-v2.h> 53 54 #include <sound/core.h> 55 #include <sound/control.h> 56 #include <sound/hwdep.h> 57 #include <sound/info.h> 58 #include <sound/tlv.h> 59 60 #include "usbaudio.h" 61 #include "mixer.h" 62 #include "helper.h" 63 #include "mixer_quirks.h" 64 #include "power.h" 65 66 #define MAX_ID_ELEMS 256 67 68 struct usb_audio_term { 69 int id; 70 int type; 71 int channels; 72 unsigned int chconfig; 73 int name; 74 }; 75 76 struct usbmix_name_map; 77 78 struct mixer_build { 79 struct snd_usb_audio *chip; 80 struct usb_mixer_interface *mixer; 81 unsigned char *buffer; 82 unsigned int buflen; 83 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS); 84 struct usb_audio_term oterm; 85 const struct usbmix_name_map *map; 86 const struct usbmix_selector_map *selector_map; 87 }; 88 89 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/ 90 enum { 91 USB_XU_CLOCK_RATE = 0xe301, 92 USB_XU_CLOCK_SOURCE = 0xe302, 93 USB_XU_DIGITAL_IO_STATUS = 0xe303, 94 USB_XU_DEVICE_OPTIONS = 0xe304, 95 USB_XU_DIRECT_MONITORING = 0xe305, 96 USB_XU_METERING = 0xe306 97 }; 98 enum { 99 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/ 100 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */ 101 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */ 102 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */ 103 }; 104 105 /* 106 * manual mapping of mixer names 107 * if the mixer topology is too complicated and the parsed names are 108 * ambiguous, add the entries in usbmixer_maps.c. 109 */ 110 #include "mixer_maps.c" 111 112 static const struct usbmix_name_map * 113 find_map(struct mixer_build *state, int unitid, int control) 114 { 115 const struct usbmix_name_map *p = state->map; 116 117 if (!p) 118 return NULL; 119 120 for (p = state->map; p->id; p++) { 121 if (p->id == unitid && 122 (!control || !p->control || control == p->control)) 123 return p; 124 } 125 return NULL; 126 } 127 128 /* get the mapped name if the unit matches */ 129 static int 130 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen) 131 { 132 if (!p || !p->name) 133 return 0; 134 135 buflen--; 136 return strlcpy(buf, p->name, buflen); 137 } 138 139 /* check whether the control should be ignored */ 140 static inline int 141 check_ignored_ctl(const struct usbmix_name_map *p) 142 { 143 if (!p || p->name || p->dB) 144 return 0; 145 return 1; 146 } 147 148 /* dB mapping */ 149 static inline void check_mapped_dB(const struct usbmix_name_map *p, 150 struct usb_mixer_elem_info *cval) 151 { 152 if (p && p->dB) { 153 cval->dBmin = p->dB->min; 154 cval->dBmax = p->dB->max; 155 cval->initialized = 1; 156 } 157 } 158 159 /* get the mapped selector source name */ 160 static int check_mapped_selector_name(struct mixer_build *state, int unitid, 161 int index, char *buf, int buflen) 162 { 163 const struct usbmix_selector_map *p; 164 165 if (! state->selector_map) 166 return 0; 167 for (p = state->selector_map; p->id; p++) { 168 if (p->id == unitid && index < p->count) 169 return strlcpy(buf, p->names[index], buflen); 170 } 171 return 0; 172 } 173 174 /* 175 * find an audio control unit with the given unit id 176 */ 177 static void *find_audio_control_unit(struct mixer_build *state, unsigned char unit) 178 { 179 /* we just parse the header */ 180 struct uac_feature_unit_descriptor *hdr = NULL; 181 182 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr, 183 USB_DT_CS_INTERFACE)) != NULL) { 184 if (hdr->bLength >= 4 && 185 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL && 186 hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER && 187 hdr->bUnitID == unit) 188 return hdr; 189 } 190 191 return NULL; 192 } 193 194 /* 195 * copy a string with the given id 196 */ 197 static int snd_usb_copy_string_desc(struct mixer_build *state, int index, char *buf, int maxlen) 198 { 199 int len = usb_string(state->chip->dev, index, buf, maxlen - 1); 200 buf[len] = 0; 201 return len; 202 } 203 204 /* 205 * convert from the byte/word on usb descriptor to the zero-based integer 206 */ 207 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val) 208 { 209 switch (cval->val_type) { 210 case USB_MIXER_BOOLEAN: 211 return !!val; 212 case USB_MIXER_INV_BOOLEAN: 213 return !val; 214 case USB_MIXER_U8: 215 val &= 0xff; 216 break; 217 case USB_MIXER_S8: 218 val &= 0xff; 219 if (val >= 0x80) 220 val -= 0x100; 221 break; 222 case USB_MIXER_U16: 223 val &= 0xffff; 224 break; 225 case USB_MIXER_S16: 226 val &= 0xffff; 227 if (val >= 0x8000) 228 val -= 0x10000; 229 break; 230 } 231 return val; 232 } 233 234 /* 235 * convert from the zero-based int to the byte/word for usb descriptor 236 */ 237 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val) 238 { 239 switch (cval->val_type) { 240 case USB_MIXER_BOOLEAN: 241 return !!val; 242 case USB_MIXER_INV_BOOLEAN: 243 return !val; 244 case USB_MIXER_S8: 245 case USB_MIXER_U8: 246 return val & 0xff; 247 case USB_MIXER_S16: 248 case USB_MIXER_U16: 249 return val & 0xffff; 250 } 251 return 0; /* not reached */ 252 } 253 254 static int get_relative_value(struct usb_mixer_elem_info *cval, int val) 255 { 256 if (! cval->res) 257 cval->res = 1; 258 if (val < cval->min) 259 return 0; 260 else if (val >= cval->max) 261 return (cval->max - cval->min + cval->res - 1) / cval->res; 262 else 263 return (val - cval->min) / cval->res; 264 } 265 266 static int get_abs_value(struct usb_mixer_elem_info *cval, int val) 267 { 268 if (val < 0) 269 return cval->min; 270 if (! cval->res) 271 cval->res = 1; 272 val *= cval->res; 273 val += cval->min; 274 if (val > cval->max) 275 return cval->max; 276 return val; 277 } 278 279 280 /* 281 * retrieve a mixer value 282 */ 283 284 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret) 285 { 286 struct snd_usb_audio *chip = cval->mixer->chip; 287 unsigned char buf[2]; 288 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1; 289 int timeout = 10; 290 int idx = 0, err; 291 292 err = snd_usb_autoresume(cval->mixer->chip); 293 if (err < 0) 294 return -EIO; 295 down_read(&chip->shutdown_rwsem); 296 while (timeout-- > 0) { 297 if (chip->shutdown) 298 break; 299 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8); 300 if (snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request, 301 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN, 302 validx, idx, buf, val_len) >= val_len) { 303 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len)); 304 err = 0; 305 goto out; 306 } 307 } 308 usb_audio_dbg(chip, 309 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n", 310 request, validx, idx, cval->val_type); 311 err = -EINVAL; 312 313 out: 314 up_read(&chip->shutdown_rwsem); 315 snd_usb_autosuspend(cval->mixer->chip); 316 return err; 317 } 318 319 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret) 320 { 321 struct snd_usb_audio *chip = cval->mixer->chip; 322 unsigned char buf[2 + 3*sizeof(__u16)]; /* enough space for one range */ 323 unsigned char *val; 324 int idx = 0, ret, size; 325 __u8 bRequest; 326 327 if (request == UAC_GET_CUR) { 328 bRequest = UAC2_CS_CUR; 329 size = sizeof(__u16); 330 } else { 331 bRequest = UAC2_CS_RANGE; 332 size = sizeof(buf); 333 } 334 335 memset(buf, 0, sizeof(buf)); 336 337 ret = snd_usb_autoresume(chip) ? -EIO : 0; 338 if (ret) 339 goto error; 340 341 down_read(&chip->shutdown_rwsem); 342 if (chip->shutdown) 343 ret = -ENODEV; 344 else { 345 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8); 346 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest, 347 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN, 348 validx, idx, buf, size); 349 } 350 up_read(&chip->shutdown_rwsem); 351 snd_usb_autosuspend(chip); 352 353 if (ret < 0) { 354 error: 355 usb_audio_err(chip, 356 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n", 357 request, validx, idx, cval->val_type); 358 return ret; 359 } 360 361 /* FIXME: how should we handle multiple triplets here? */ 362 363 switch (request) { 364 case UAC_GET_CUR: 365 val = buf; 366 break; 367 case UAC_GET_MIN: 368 val = buf + sizeof(__u16); 369 break; 370 case UAC_GET_MAX: 371 val = buf + sizeof(__u16) * 2; 372 break; 373 case UAC_GET_RES: 374 val = buf + sizeof(__u16) * 3; 375 break; 376 default: 377 return -EINVAL; 378 } 379 380 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16))); 381 382 return 0; 383 } 384 385 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret) 386 { 387 validx += cval->idx_off; 388 389 return (cval->mixer->protocol == UAC_VERSION_1) ? 390 get_ctl_value_v1(cval, request, validx, value_ret) : 391 get_ctl_value_v2(cval, request, validx, value_ret); 392 } 393 394 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int *value) 395 { 396 return get_ctl_value(cval, UAC_GET_CUR, validx, value); 397 } 398 399 /* channel = 0: master, 1 = first channel */ 400 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval, 401 int channel, int *value) 402 { 403 return get_ctl_value(cval, UAC_GET_CUR, (cval->control << 8) | channel, value); 404 } 405 406 static int get_cur_mix_value(struct usb_mixer_elem_info *cval, 407 int channel, int index, int *value) 408 { 409 int err; 410 411 if (cval->cached & (1 << channel)) { 412 *value = cval->cache_val[index]; 413 return 0; 414 } 415 err = get_cur_mix_raw(cval, channel, value); 416 if (err < 0) { 417 if (!cval->mixer->ignore_ctl_error) 418 usb_audio_dbg(cval->mixer->chip, 419 "cannot get current value for control %d ch %d: err = %d\n", 420 cval->control, channel, err); 421 return err; 422 } 423 cval->cached |= 1 << channel; 424 cval->cache_val[index] = *value; 425 return 0; 426 } 427 428 429 /* 430 * set a mixer value 431 */ 432 433 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval, 434 int request, int validx, int value_set) 435 { 436 struct snd_usb_audio *chip = cval->mixer->chip; 437 unsigned char buf[2]; 438 int idx = 0, val_len, err, timeout = 10; 439 440 validx += cval->idx_off; 441 442 if (cval->mixer->protocol == UAC_VERSION_1) { 443 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1; 444 } else { /* UAC_VERSION_2 */ 445 /* audio class v2 controls are always 2 bytes in size */ 446 val_len = sizeof(__u16); 447 448 /* FIXME */ 449 if (request != UAC_SET_CUR) { 450 usb_audio_dbg(chip, "RANGE setting not yet supported\n"); 451 return -EINVAL; 452 } 453 454 request = UAC2_CS_CUR; 455 } 456 457 value_set = convert_bytes_value(cval, value_set); 458 buf[0] = value_set & 0xff; 459 buf[1] = (value_set >> 8) & 0xff; 460 err = snd_usb_autoresume(chip); 461 if (err < 0) 462 return -EIO; 463 down_read(&chip->shutdown_rwsem); 464 while (timeout-- > 0) { 465 if (chip->shutdown) 466 break; 467 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8); 468 if (snd_usb_ctl_msg(chip->dev, 469 usb_sndctrlpipe(chip->dev, 0), request, 470 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT, 471 validx, idx, buf, val_len) >= 0) { 472 err = 0; 473 goto out; 474 } 475 } 476 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n", 477 request, validx, idx, cval->val_type, buf[0], buf[1]); 478 err = -EINVAL; 479 480 out: 481 up_read(&chip->shutdown_rwsem); 482 snd_usb_autosuspend(chip); 483 return err; 484 } 485 486 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int value) 487 { 488 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value); 489 } 490 491 static int set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel, 492 int index, int value) 493 { 494 int err; 495 unsigned int read_only = (channel == 0) ? 496 cval->master_readonly : 497 cval->ch_readonly & (1 << (channel - 1)); 498 499 if (read_only) { 500 usb_audio_dbg(cval->mixer->chip, 501 "%s(): channel %d of control %d is read_only\n", 502 __func__, channel, cval->control); 503 return 0; 504 } 505 506 err = snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, (cval->control << 8) | channel, 507 value); 508 if (err < 0) 509 return err; 510 cval->cached |= 1 << channel; 511 cval->cache_val[index] = value; 512 return 0; 513 } 514 515 /* 516 * TLV callback for mixer volume controls 517 */ 518 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag, 519 unsigned int size, unsigned int __user *_tlv) 520 { 521 struct usb_mixer_elem_info *cval = kcontrol->private_data; 522 DECLARE_TLV_DB_MINMAX(scale, 0, 0); 523 524 if (size < sizeof(scale)) 525 return -ENOMEM; 526 scale[2] = cval->dBmin; 527 scale[3] = cval->dBmax; 528 if (copy_to_user(_tlv, scale, sizeof(scale))) 529 return -EFAULT; 530 return 0; 531 } 532 533 /* 534 * parser routines begin here... 535 */ 536 537 static int parse_audio_unit(struct mixer_build *state, int unitid); 538 539 540 /* 541 * check if the input/output channel routing is enabled on the given bitmap. 542 * used for mixer unit parser 543 */ 544 static int check_matrix_bitmap(unsigned char *bmap, int ich, int och, int num_outs) 545 { 546 int idx = ich * num_outs + och; 547 return bmap[idx >> 3] & (0x80 >> (idx & 7)); 548 } 549 550 551 /* 552 * add an alsa control element 553 * search and increment the index until an empty slot is found. 554 * 555 * if failed, give up and free the control instance. 556 */ 557 558 int snd_usb_mixer_add_control(struct usb_mixer_interface *mixer, 559 struct snd_kcontrol *kctl) 560 { 561 struct usb_mixer_elem_info *cval = kctl->private_data; 562 int err; 563 564 while (snd_ctl_find_id(mixer->chip->card, &kctl->id)) 565 kctl->id.index++; 566 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) { 567 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n", err); 568 return err; 569 } 570 cval->elem_id = &kctl->id; 571 cval->next_id_elem = mixer->id_elems[cval->id]; 572 mixer->id_elems[cval->id] = cval; 573 return 0; 574 } 575 576 577 /* 578 * get a terminal name string 579 */ 580 581 static struct iterm_name_combo { 582 int type; 583 char *name; 584 } iterm_names[] = { 585 { 0x0300, "Output" }, 586 { 0x0301, "Speaker" }, 587 { 0x0302, "Headphone" }, 588 { 0x0303, "HMD Audio" }, 589 { 0x0304, "Desktop Speaker" }, 590 { 0x0305, "Room Speaker" }, 591 { 0x0306, "Com Speaker" }, 592 { 0x0307, "LFE" }, 593 { 0x0600, "External In" }, 594 { 0x0601, "Analog In" }, 595 { 0x0602, "Digital In" }, 596 { 0x0603, "Line" }, 597 { 0x0604, "Legacy In" }, 598 { 0x0605, "IEC958 In" }, 599 { 0x0606, "1394 DA Stream" }, 600 { 0x0607, "1394 DV Stream" }, 601 { 0x0700, "Embedded" }, 602 { 0x0701, "Noise Source" }, 603 { 0x0702, "Equalization Noise" }, 604 { 0x0703, "CD" }, 605 { 0x0704, "DAT" }, 606 { 0x0705, "DCC" }, 607 { 0x0706, "MiniDisk" }, 608 { 0x0707, "Analog Tape" }, 609 { 0x0708, "Phonograph" }, 610 { 0x0709, "VCR Audio" }, 611 { 0x070a, "Video Disk Audio" }, 612 { 0x070b, "DVD Audio" }, 613 { 0x070c, "TV Tuner Audio" }, 614 { 0x070d, "Satellite Rec Audio" }, 615 { 0x070e, "Cable Tuner Audio" }, 616 { 0x070f, "DSS Audio" }, 617 { 0x0710, "Radio Receiver" }, 618 { 0x0711, "Radio Transmitter" }, 619 { 0x0712, "Multi-Track Recorder" }, 620 { 0x0713, "Synthesizer" }, 621 { 0 }, 622 }; 623 624 static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm, 625 unsigned char *name, int maxlen, int term_only) 626 { 627 struct iterm_name_combo *names; 628 629 if (iterm->name) 630 return snd_usb_copy_string_desc(state, iterm->name, name, maxlen); 631 632 /* virtual type - not a real terminal */ 633 if (iterm->type >> 16) { 634 if (term_only) 635 return 0; 636 switch (iterm->type >> 16) { 637 case UAC_SELECTOR_UNIT: 638 strcpy(name, "Selector"); return 8; 639 case UAC1_PROCESSING_UNIT: 640 strcpy(name, "Process Unit"); return 12; 641 case UAC1_EXTENSION_UNIT: 642 strcpy(name, "Ext Unit"); return 8; 643 case UAC_MIXER_UNIT: 644 strcpy(name, "Mixer"); return 5; 645 default: 646 return sprintf(name, "Unit %d", iterm->id); 647 } 648 } 649 650 switch (iterm->type & 0xff00) { 651 case 0x0100: 652 strcpy(name, "PCM"); return 3; 653 case 0x0200: 654 strcpy(name, "Mic"); return 3; 655 case 0x0400: 656 strcpy(name, "Headset"); return 7; 657 case 0x0500: 658 strcpy(name, "Phone"); return 5; 659 } 660 661 for (names = iterm_names; names->type; names++) 662 if (names->type == iterm->type) { 663 strcpy(name, names->name); 664 return strlen(names->name); 665 } 666 return 0; 667 } 668 669 670 /* 671 * parse the source unit recursively until it reaches to a terminal 672 * or a branched unit. 673 */ 674 static int check_input_term(struct mixer_build *state, int id, struct usb_audio_term *term) 675 { 676 int err; 677 void *p1; 678 679 memset(term, 0, sizeof(*term)); 680 while ((p1 = find_audio_control_unit(state, id)) != NULL) { 681 unsigned char *hdr = p1; 682 term->id = id; 683 switch (hdr[2]) { 684 case UAC_INPUT_TERMINAL: 685 if (state->mixer->protocol == UAC_VERSION_1) { 686 struct uac_input_terminal_descriptor *d = p1; 687 term->type = le16_to_cpu(d->wTerminalType); 688 term->channels = d->bNrChannels; 689 term->chconfig = le16_to_cpu(d->wChannelConfig); 690 term->name = d->iTerminal; 691 } else { /* UAC_VERSION_2 */ 692 struct uac2_input_terminal_descriptor *d = p1; 693 term->type = le16_to_cpu(d->wTerminalType); 694 term->channels = d->bNrChannels; 695 term->chconfig = le32_to_cpu(d->bmChannelConfig); 696 term->name = d->iTerminal; 697 698 /* call recursively to get the clock selectors */ 699 err = check_input_term(state, d->bCSourceID, term); 700 if (err < 0) 701 return err; 702 } 703 return 0; 704 case UAC_FEATURE_UNIT: { 705 /* the header is the same for v1 and v2 */ 706 struct uac_feature_unit_descriptor *d = p1; 707 id = d->bSourceID; 708 break; /* continue to parse */ 709 } 710 case UAC_MIXER_UNIT: { 711 struct uac_mixer_unit_descriptor *d = p1; 712 term->type = d->bDescriptorSubtype << 16; /* virtual type */ 713 term->channels = uac_mixer_unit_bNrChannels(d); 714 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol); 715 term->name = uac_mixer_unit_iMixer(d); 716 return 0; 717 } 718 case UAC_SELECTOR_UNIT: 719 case UAC2_CLOCK_SELECTOR: { 720 struct uac_selector_unit_descriptor *d = p1; 721 /* call recursively to retrieve the channel info */ 722 err = check_input_term(state, d->baSourceID[0], term); 723 if (err < 0) 724 return err; 725 term->type = d->bDescriptorSubtype << 16; /* virtual type */ 726 term->id = id; 727 term->name = uac_selector_unit_iSelector(d); 728 return 0; 729 } 730 case UAC1_PROCESSING_UNIT: 731 case UAC1_EXTENSION_UNIT: 732 /* UAC2_PROCESSING_UNIT_V2 */ 733 /* UAC2_EFFECT_UNIT */ 734 case UAC2_EXTENSION_UNIT_V2: { 735 struct uac_processing_unit_descriptor *d = p1; 736 737 if (state->mixer->protocol == UAC_VERSION_2 && 738 hdr[2] == UAC2_EFFECT_UNIT) { 739 /* UAC2/UAC1 unit IDs overlap here in an 740 * uncompatible way. Ignore this unit for now. 741 */ 742 return 0; 743 } 744 745 if (d->bNrInPins) { 746 id = d->baSourceID[0]; 747 break; /* continue to parse */ 748 } 749 term->type = d->bDescriptorSubtype << 16; /* virtual type */ 750 term->channels = uac_processing_unit_bNrChannels(d); 751 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol); 752 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol); 753 return 0; 754 } 755 case UAC2_CLOCK_SOURCE: { 756 struct uac_clock_source_descriptor *d = p1; 757 term->type = d->bDescriptorSubtype << 16; /* virtual type */ 758 term->id = id; 759 term->name = d->iClockSource; 760 return 0; 761 } 762 default: 763 return -ENODEV; 764 } 765 } 766 return -ENODEV; 767 } 768 769 770 /* 771 * Feature Unit 772 */ 773 774 /* feature unit control information */ 775 struct usb_feature_control_info { 776 const char *name; 777 unsigned int type; /* control type (mute, volume, etc.) */ 778 }; 779 780 static struct usb_feature_control_info audio_feature_info[] = { 781 { "Mute", USB_MIXER_INV_BOOLEAN }, 782 { "Volume", USB_MIXER_S16 }, 783 { "Tone Control - Bass", USB_MIXER_S8 }, 784 { "Tone Control - Mid", USB_MIXER_S8 }, 785 { "Tone Control - Treble", USB_MIXER_S8 }, 786 { "Graphic Equalizer", USB_MIXER_S8 }, /* FIXME: not implemeted yet */ 787 { "Auto Gain Control", USB_MIXER_BOOLEAN }, 788 { "Delay Control", USB_MIXER_U16 }, 789 { "Bass Boost", USB_MIXER_BOOLEAN }, 790 { "Loudness", USB_MIXER_BOOLEAN }, 791 /* UAC2 specific */ 792 { "Input Gain Control", USB_MIXER_U16 }, 793 { "Input Gain Pad Control", USB_MIXER_BOOLEAN }, 794 { "Phase Inverter Control", USB_MIXER_BOOLEAN }, 795 }; 796 797 798 /* private_free callback */ 799 static void usb_mixer_elem_free(struct snd_kcontrol *kctl) 800 { 801 kfree(kctl->private_data); 802 kctl->private_data = NULL; 803 } 804 805 806 /* 807 * interface to ALSA control for feature/mixer units 808 */ 809 810 /* volume control quirks */ 811 static void volume_control_quirks(struct usb_mixer_elem_info *cval, 812 struct snd_kcontrol *kctl) 813 { 814 struct snd_usb_audio *chip = cval->mixer->chip; 815 switch (chip->usb_id) { 816 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */ 817 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */ 818 if (strcmp(kctl->id.name, "Effect Duration") == 0) { 819 cval->min = 0x0000; 820 cval->max = 0xffff; 821 cval->res = 0x00e6; 822 break; 823 } 824 if (strcmp(kctl->id.name, "Effect Volume") == 0 || 825 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) { 826 cval->min = 0x00; 827 cval->max = 0xff; 828 break; 829 } 830 if (strstr(kctl->id.name, "Effect Return") != NULL) { 831 cval->min = 0xb706; 832 cval->max = 0xff7b; 833 cval->res = 0x0073; 834 break; 835 } 836 if ((strstr(kctl->id.name, "Playback Volume") != NULL) || 837 (strstr(kctl->id.name, "Effect Send") != NULL)) { 838 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */ 839 cval->max = 0xfcfe; 840 cval->res = 0x0073; 841 } 842 break; 843 844 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */ 845 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */ 846 if (strcmp(kctl->id.name, "Effect Duration") == 0) { 847 usb_audio_info(chip, 848 "set quirk for FTU Effect Duration\n"); 849 cval->min = 0x0000; 850 cval->max = 0x7f00; 851 cval->res = 0x0100; 852 break; 853 } 854 if (strcmp(kctl->id.name, "Effect Volume") == 0 || 855 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) { 856 usb_audio_info(chip, 857 "set quirks for FTU Effect Feedback/Volume\n"); 858 cval->min = 0x00; 859 cval->max = 0x7f; 860 break; 861 } 862 break; 863 864 case USB_ID(0x0471, 0x0101): 865 case USB_ID(0x0471, 0x0104): 866 case USB_ID(0x0471, 0x0105): 867 case USB_ID(0x0672, 0x1041): 868 /* quirk for UDA1321/N101. 869 * note that detection between firmware 2.1.1.7 (N101) 870 * and later 2.1.1.21 is not very clear from datasheets. 871 * I hope that the min value is -15360 for newer firmware --jk 872 */ 873 if (!strcmp(kctl->id.name, "PCM Playback Volume") && 874 cval->min == -15616) { 875 usb_audio_info(chip, 876 "set volume quirk for UDA1321/N101 chip\n"); 877 cval->max = -256; 878 } 879 break; 880 881 case USB_ID(0x046d, 0x09a4): 882 if (!strcmp(kctl->id.name, "Mic Capture Volume")) { 883 usb_audio_info(chip, 884 "set volume quirk for QuickCam E3500\n"); 885 cval->min = 6080; 886 cval->max = 8768; 887 cval->res = 192; 888 } 889 break; 890 891 case USB_ID(0x046d, 0x0808): 892 case USB_ID(0x046d, 0x0809): 893 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */ 894 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */ 895 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */ 896 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */ 897 case USB_ID(0x046d, 0x0991): 898 /* Most audio usb devices lie about volume resolution. 899 * Most Logitech webcams have res = 384. 900 * Proboly there is some logitech magic behind this number --fishor 901 */ 902 if (!strcmp(kctl->id.name, "Mic Capture Volume")) { 903 usb_audio_info(chip, 904 "set resolution quirk: cval->res = 384\n"); 905 cval->res = 384; 906 } 907 break; 908 909 } 910 } 911 912 /* 913 * retrieve the minimum and maximum values for the specified control 914 */ 915 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval, 916 int default_min, struct snd_kcontrol *kctl) 917 { 918 /* for failsafe */ 919 cval->min = default_min; 920 cval->max = cval->min + 1; 921 cval->res = 1; 922 cval->dBmin = cval->dBmax = 0; 923 924 if (cval->val_type == USB_MIXER_BOOLEAN || 925 cval->val_type == USB_MIXER_INV_BOOLEAN) { 926 cval->initialized = 1; 927 } else { 928 int minchn = 0; 929 if (cval->cmask) { 930 int i; 931 for (i = 0; i < MAX_CHANNELS; i++) 932 if (cval->cmask & (1 << i)) { 933 minchn = i + 1; 934 break; 935 } 936 } 937 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 || 938 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) { 939 usb_audio_err(cval->mixer->chip, 940 "%d:%d: cannot get min/max values for control %d (id %d)\n", 941 cval->id, snd_usb_ctrl_intf(cval->mixer->chip), cval->control, cval->id); 942 return -EINVAL; 943 } 944 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) { 945 cval->res = 1; 946 } else { 947 int last_valid_res = cval->res; 948 949 while (cval->res > 1) { 950 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES, 951 (cval->control << 8) | minchn, cval->res / 2) < 0) 952 break; 953 cval->res /= 2; 954 } 955 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) 956 cval->res = last_valid_res; 957 } 958 if (cval->res == 0) 959 cval->res = 1; 960 961 /* Additional checks for the proper resolution 962 * 963 * Some devices report smaller resolutions than actually 964 * reacting. They don't return errors but simply clip 965 * to the lower aligned value. 966 */ 967 if (cval->min + cval->res < cval->max) { 968 int last_valid_res = cval->res; 969 int saved, test, check; 970 get_cur_mix_raw(cval, minchn, &saved); 971 for (;;) { 972 test = saved; 973 if (test < cval->max) 974 test += cval->res; 975 else 976 test -= cval->res; 977 if (test < cval->min || test > cval->max || 978 set_cur_mix_value(cval, minchn, 0, test) || 979 get_cur_mix_raw(cval, minchn, &check)) { 980 cval->res = last_valid_res; 981 break; 982 } 983 if (test == check) 984 break; 985 cval->res *= 2; 986 } 987 set_cur_mix_value(cval, minchn, 0, saved); 988 } 989 990 cval->initialized = 1; 991 } 992 993 if (kctl) 994 volume_control_quirks(cval, kctl); 995 996 /* USB descriptions contain the dB scale in 1/256 dB unit 997 * while ALSA TLV contains in 1/100 dB unit 998 */ 999 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256; 1000 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256; 1001 if (cval->dBmin > cval->dBmax) { 1002 /* something is wrong; assume it's either from/to 0dB */ 1003 if (cval->dBmin < 0) 1004 cval->dBmax = 0; 1005 else if (cval->dBmin > 0) 1006 cval->dBmin = 0; 1007 if (cval->dBmin > cval->dBmax) { 1008 /* totally crap, return an error */ 1009 return -EINVAL; 1010 } 1011 } 1012 1013 return 0; 1014 } 1015 1016 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL) 1017 1018 /* get a feature/mixer unit info */ 1019 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo) 1020 { 1021 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1022 1023 if (cval->val_type == USB_MIXER_BOOLEAN || 1024 cval->val_type == USB_MIXER_INV_BOOLEAN) 1025 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN; 1026 else 1027 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER; 1028 uinfo->count = cval->channels; 1029 if (cval->val_type == USB_MIXER_BOOLEAN || 1030 cval->val_type == USB_MIXER_INV_BOOLEAN) { 1031 uinfo->value.integer.min = 0; 1032 uinfo->value.integer.max = 1; 1033 } else { 1034 if (!cval->initialized) { 1035 get_min_max_with_quirks(cval, 0, kcontrol); 1036 if (cval->initialized && cval->dBmin >= cval->dBmax) { 1037 kcontrol->vd[0].access &= 1038 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ | 1039 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK); 1040 snd_ctl_notify(cval->mixer->chip->card, 1041 SNDRV_CTL_EVENT_MASK_INFO, 1042 &kcontrol->id); 1043 } 1044 } 1045 uinfo->value.integer.min = 0; 1046 uinfo->value.integer.max = 1047 (cval->max - cval->min + cval->res - 1) / cval->res; 1048 } 1049 return 0; 1050 } 1051 1052 /* get the current value from feature/mixer unit */ 1053 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol) 1054 { 1055 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1056 int c, cnt, val, err; 1057 1058 ucontrol->value.integer.value[0] = cval->min; 1059 if (cval->cmask) { 1060 cnt = 0; 1061 for (c = 0; c < MAX_CHANNELS; c++) { 1062 if (!(cval->cmask & (1 << c))) 1063 continue; 1064 err = get_cur_mix_value(cval, c + 1, cnt, &val); 1065 if (err < 0) 1066 return cval->mixer->ignore_ctl_error ? 0 : err; 1067 val = get_relative_value(cval, val); 1068 ucontrol->value.integer.value[cnt] = val; 1069 cnt++; 1070 } 1071 return 0; 1072 } else { 1073 /* master channel */ 1074 err = get_cur_mix_value(cval, 0, 0, &val); 1075 if (err < 0) 1076 return cval->mixer->ignore_ctl_error ? 0 : err; 1077 val = get_relative_value(cval, val); 1078 ucontrol->value.integer.value[0] = val; 1079 } 1080 return 0; 1081 } 1082 1083 /* put the current value to feature/mixer unit */ 1084 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol) 1085 { 1086 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1087 int c, cnt, val, oval, err; 1088 int changed = 0; 1089 1090 if (cval->cmask) { 1091 cnt = 0; 1092 for (c = 0; c < MAX_CHANNELS; c++) { 1093 if (!(cval->cmask & (1 << c))) 1094 continue; 1095 err = get_cur_mix_value(cval, c + 1, cnt, &oval); 1096 if (err < 0) 1097 return cval->mixer->ignore_ctl_error ? 0 : err; 1098 val = ucontrol->value.integer.value[cnt]; 1099 val = get_abs_value(cval, val); 1100 if (oval != val) { 1101 set_cur_mix_value(cval, c + 1, cnt, val); 1102 changed = 1; 1103 } 1104 cnt++; 1105 } 1106 } else { 1107 /* master channel */ 1108 err = get_cur_mix_value(cval, 0, 0, &oval); 1109 if (err < 0) 1110 return cval->mixer->ignore_ctl_error ? 0 : err; 1111 val = ucontrol->value.integer.value[0]; 1112 val = get_abs_value(cval, val); 1113 if (val != oval) { 1114 set_cur_mix_value(cval, 0, 0, val); 1115 changed = 1; 1116 } 1117 } 1118 return changed; 1119 } 1120 1121 static struct snd_kcontrol_new usb_feature_unit_ctl = { 1122 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 1123 .name = "", /* will be filled later manually */ 1124 .info = mixer_ctl_feature_info, 1125 .get = mixer_ctl_feature_get, 1126 .put = mixer_ctl_feature_put, 1127 }; 1128 1129 /* the read-only variant */ 1130 static struct snd_kcontrol_new usb_feature_unit_ctl_ro = { 1131 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 1132 .name = "", /* will be filled later manually */ 1133 .info = mixer_ctl_feature_info, 1134 .get = mixer_ctl_feature_get, 1135 .put = NULL, 1136 }; 1137 1138 /* This symbol is exported in order to allow the mixer quirks to 1139 * hook up to the standard feature unit control mechanism */ 1140 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl; 1141 1142 /* 1143 * build a feature control 1144 */ 1145 1146 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str) 1147 { 1148 return strlcat(kctl->id.name, str, sizeof(kctl->id.name)); 1149 } 1150 1151 /* A lot of headsets/headphones have a "Speaker" mixer. Make sure we 1152 rename it to "Headphone". We determine if something is a headphone 1153 similar to how udev determines form factor. */ 1154 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl, 1155 struct snd_card *card) 1156 { 1157 const char *names_to_check[] = { 1158 "Headset", "headset", "Headphone", "headphone", NULL}; 1159 const char **s; 1160 bool found = false; 1161 1162 if (strcmp("Speaker", kctl->id.name)) 1163 return; 1164 1165 for (s = names_to_check; *s; s++) 1166 if (strstr(card->shortname, *s)) { 1167 found = true; 1168 break; 1169 } 1170 1171 if (!found) 1172 return; 1173 1174 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name)); 1175 } 1176 1177 static void build_feature_ctl(struct mixer_build *state, void *raw_desc, 1178 unsigned int ctl_mask, int control, 1179 struct usb_audio_term *iterm, int unitid, 1180 int readonly_mask) 1181 { 1182 struct uac_feature_unit_descriptor *desc = raw_desc; 1183 unsigned int len = 0; 1184 int mapped_name = 0; 1185 int nameid = uac_feature_unit_iFeature(desc); 1186 struct snd_kcontrol *kctl; 1187 struct usb_mixer_elem_info *cval; 1188 const struct usbmix_name_map *map; 1189 unsigned int range; 1190 1191 control++; /* change from zero-based to 1-based value */ 1192 1193 if (control == UAC_FU_GRAPHIC_EQUALIZER) { 1194 /* FIXME: not supported yet */ 1195 return; 1196 } 1197 1198 map = find_map(state, unitid, control); 1199 if (check_ignored_ctl(map)) 1200 return; 1201 1202 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1203 if (! cval) { 1204 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 1205 return; 1206 } 1207 cval->mixer = state->mixer; 1208 cval->id = unitid; 1209 cval->control = control; 1210 cval->cmask = ctl_mask; 1211 cval->val_type = audio_feature_info[control-1].type; 1212 if (ctl_mask == 0) { 1213 cval->channels = 1; /* master channel */ 1214 cval->master_readonly = readonly_mask; 1215 } else { 1216 int i, c = 0; 1217 for (i = 0; i < 16; i++) 1218 if (ctl_mask & (1 << i)) 1219 c++; 1220 cval->channels = c; 1221 cval->ch_readonly = readonly_mask; 1222 } 1223 1224 /* if all channels in the mask are marked read-only, make the control 1225 * read-only. set_cur_mix_value() will check the mask again and won't 1226 * issue write commands to read-only channels. */ 1227 if (cval->channels == readonly_mask) 1228 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval); 1229 else 1230 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval); 1231 1232 if (! kctl) { 1233 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 1234 kfree(cval); 1235 return; 1236 } 1237 kctl->private_free = usb_mixer_elem_free; 1238 1239 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)); 1240 mapped_name = len != 0; 1241 if (! len && nameid) 1242 len = snd_usb_copy_string_desc(state, nameid, 1243 kctl->id.name, sizeof(kctl->id.name)); 1244 1245 switch (control) { 1246 case UAC_FU_MUTE: 1247 case UAC_FU_VOLUME: 1248 /* determine the control name. the rule is: 1249 * - if a name id is given in descriptor, use it. 1250 * - if the connected input can be determined, then use the name 1251 * of terminal type. 1252 * - if the connected output can be determined, use it. 1253 * - otherwise, anonymous name. 1254 */ 1255 if (! len) { 1256 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1); 1257 if (! len) 1258 len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1); 1259 if (! len) 1260 len = snprintf(kctl->id.name, sizeof(kctl->id.name), 1261 "Feature %d", unitid); 1262 } 1263 1264 if (!mapped_name) 1265 check_no_speaker_on_headset(kctl, state->mixer->chip->card); 1266 1267 /* determine the stream direction: 1268 * if the connected output is USB stream, then it's likely a 1269 * capture stream. otherwise it should be playback (hopefully :) 1270 */ 1271 if (! mapped_name && ! (state->oterm.type >> 16)) { 1272 if ((state->oterm.type & 0xff00) == 0x0100) { 1273 len = append_ctl_name(kctl, " Capture"); 1274 } else { 1275 len = append_ctl_name(kctl, " Playback"); 1276 } 1277 } 1278 append_ctl_name(kctl, control == UAC_FU_MUTE ? 1279 " Switch" : " Volume"); 1280 break; 1281 default: 1282 if (! len) 1283 strlcpy(kctl->id.name, audio_feature_info[control-1].name, 1284 sizeof(kctl->id.name)); 1285 break; 1286 } 1287 1288 /* get min/max values */ 1289 get_min_max_with_quirks(cval, 0, kctl); 1290 1291 if (control == UAC_FU_VOLUME) { 1292 check_mapped_dB(map, cval); 1293 if (cval->dBmin < cval->dBmax || !cval->initialized) { 1294 kctl->tlv.c = snd_usb_mixer_vol_tlv; 1295 kctl->vd[0].access |= 1296 SNDRV_CTL_ELEM_ACCESS_TLV_READ | 1297 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK; 1298 } 1299 } 1300 1301 range = (cval->max - cval->min) / cval->res; 1302 /* Are there devices with volume range more than 255? I use a bit more 1303 * to be sure. 384 is a resolution magic number found on Logitech 1304 * devices. It will definitively catch all buggy Logitech devices. 1305 */ 1306 if (range > 384) { 1307 usb_audio_warn(state->chip, "Warning! Unlikely big " 1308 "volume range (=%u), cval->res is probably wrong.", 1309 range); 1310 usb_audio_warn(state->chip, "[%d] FU [%s] ch = %d, " 1311 "val = %d/%d/%d", cval->id, 1312 kctl->id.name, cval->channels, 1313 cval->min, cval->max, cval->res); 1314 } 1315 1316 usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n", 1317 cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res); 1318 snd_usb_mixer_add_control(state->mixer, kctl); 1319 } 1320 1321 1322 1323 /* 1324 * parse a feature unit 1325 * 1326 * most of controls are defined here. 1327 */ 1328 static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr) 1329 { 1330 int channels, i, j; 1331 struct usb_audio_term iterm; 1332 unsigned int master_bits, first_ch_bits; 1333 int err, csize; 1334 struct uac_feature_unit_descriptor *hdr = _ftr; 1335 __u8 *bmaControls; 1336 1337 if (state->mixer->protocol == UAC_VERSION_1) { 1338 csize = hdr->bControlSize; 1339 if (!csize) { 1340 usb_audio_dbg(state->chip, 1341 "unit %u: invalid bControlSize == 0\n", 1342 unitid); 1343 return -EINVAL; 1344 } 1345 channels = (hdr->bLength - 7) / csize - 1; 1346 bmaControls = hdr->bmaControls; 1347 if (hdr->bLength < 7 + csize) { 1348 usb_audio_err(state->chip, 1349 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n", 1350 unitid); 1351 return -EINVAL; 1352 } 1353 } else { 1354 struct uac2_feature_unit_descriptor *ftr = _ftr; 1355 csize = 4; 1356 channels = (hdr->bLength - 6) / 4 - 1; 1357 bmaControls = ftr->bmaControls; 1358 if (hdr->bLength < 6 + csize) { 1359 usb_audio_err(state->chip, 1360 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n", 1361 unitid); 1362 return -EINVAL; 1363 } 1364 } 1365 1366 /* parse the source unit */ 1367 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0) 1368 return err; 1369 1370 /* determine the input source type and name */ 1371 err = check_input_term(state, hdr->bSourceID, &iterm); 1372 if (err < 0) 1373 return err; 1374 1375 master_bits = snd_usb_combine_bytes(bmaControls, csize); 1376 /* master configuration quirks */ 1377 switch (state->chip->usb_id) { 1378 case USB_ID(0x08bb, 0x2702): 1379 usb_audio_info(state->chip, 1380 "usbmixer: master volume quirk for PCM2702 chip\n"); 1381 /* disable non-functional volume control */ 1382 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME); 1383 break; 1384 case USB_ID(0x1130, 0xf211): 1385 usb_audio_info(state->chip, 1386 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n"); 1387 /* disable non-functional volume control */ 1388 channels = 0; 1389 break; 1390 1391 } 1392 if (channels > 0) 1393 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize); 1394 else 1395 first_ch_bits = 0; 1396 1397 if (state->mixer->protocol == UAC_VERSION_1) { 1398 /* check all control types */ 1399 for (i = 0; i < 10; i++) { 1400 unsigned int ch_bits = 0; 1401 for (j = 0; j < channels; j++) { 1402 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize); 1403 if (mask & (1 << i)) 1404 ch_bits |= (1 << j); 1405 } 1406 /* audio class v1 controls are never read-only */ 1407 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */ 1408 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, 0); 1409 if (master_bits & (1 << i)) 1410 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 0); 1411 } 1412 } else { /* UAC_VERSION_2 */ 1413 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) { 1414 unsigned int ch_bits = 0; 1415 unsigned int ch_read_only = 0; 1416 1417 for (j = 0; j < channels; j++) { 1418 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize); 1419 if (uac2_control_is_readable(mask, i)) { 1420 ch_bits |= (1 << j); 1421 if (!uac2_control_is_writeable(mask, i)) 1422 ch_read_only |= (1 << j); 1423 } 1424 } 1425 1426 /* NOTE: build_feature_ctl() will mark the control read-only if all channels 1427 * are marked read-only in the descriptors. Otherwise, the control will be 1428 * reported as writeable, but the driver will not actually issue a write 1429 * command for read-only channels */ 1430 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */ 1431 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, ch_read_only); 1432 if (uac2_control_is_readable(master_bits, i)) 1433 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 1434 !uac2_control_is_writeable(master_bits, i)); 1435 } 1436 } 1437 1438 return 0; 1439 } 1440 1441 1442 /* 1443 * Mixer Unit 1444 */ 1445 1446 /* 1447 * build a mixer unit control 1448 * 1449 * the callbacks are identical with feature unit. 1450 * input channel number (zero based) is given in control field instead. 1451 */ 1452 1453 static void build_mixer_unit_ctl(struct mixer_build *state, 1454 struct uac_mixer_unit_descriptor *desc, 1455 int in_pin, int in_ch, int unitid, 1456 struct usb_audio_term *iterm) 1457 { 1458 struct usb_mixer_elem_info *cval; 1459 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc); 1460 unsigned int i, len; 1461 struct snd_kcontrol *kctl; 1462 const struct usbmix_name_map *map; 1463 1464 map = find_map(state, unitid, 0); 1465 if (check_ignored_ctl(map)) 1466 return; 1467 1468 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1469 if (! cval) 1470 return; 1471 1472 cval->mixer = state->mixer; 1473 cval->id = unitid; 1474 cval->control = in_ch + 1; /* based on 1 */ 1475 cval->val_type = USB_MIXER_S16; 1476 for (i = 0; i < num_outs; i++) { 1477 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), in_ch, i, num_outs)) { 1478 cval->cmask |= (1 << i); 1479 cval->channels++; 1480 } 1481 } 1482 1483 /* get min/max values */ 1484 get_min_max(cval, 0); 1485 1486 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval); 1487 if (! kctl) { 1488 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 1489 kfree(cval); 1490 return; 1491 } 1492 kctl->private_free = usb_mixer_elem_free; 1493 1494 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)); 1495 if (! len) 1496 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0); 1497 if (! len) 1498 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1); 1499 append_ctl_name(kctl, " Volume"); 1500 1501 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n", 1502 cval->id, kctl->id.name, cval->channels, cval->min, cval->max); 1503 snd_usb_mixer_add_control(state->mixer, kctl); 1504 } 1505 1506 1507 /* 1508 * parse a mixer unit 1509 */ 1510 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, void *raw_desc) 1511 { 1512 struct uac_mixer_unit_descriptor *desc = raw_desc; 1513 struct usb_audio_term iterm; 1514 int input_pins, num_ins, num_outs; 1515 int pin, ich, err; 1516 1517 if (desc->bLength < 11 || ! (input_pins = desc->bNrInPins) || ! (num_outs = uac_mixer_unit_bNrChannels(desc))) { 1518 usb_audio_err(state->chip, "invalid MIXER UNIT descriptor %d\n", unitid); 1519 return -EINVAL; 1520 } 1521 /* no bmControls field (e.g. Maya44) -> ignore */ 1522 if (desc->bLength <= 10 + input_pins) { 1523 usb_audio_dbg(state->chip, "MU %d has no bmControls field\n", unitid); 1524 return 0; 1525 } 1526 1527 num_ins = 0; 1528 ich = 0; 1529 for (pin = 0; pin < input_pins; pin++) { 1530 err = parse_audio_unit(state, desc->baSourceID[pin]); 1531 if (err < 0) 1532 continue; 1533 err = check_input_term(state, desc->baSourceID[pin], &iterm); 1534 if (err < 0) 1535 return err; 1536 num_ins += iterm.channels; 1537 for (; ich < num_ins; ++ich) { 1538 int och, ich_has_controls = 0; 1539 1540 for (och = 0; och < num_outs; ++och) { 1541 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), 1542 ich, och, num_outs)) { 1543 ich_has_controls = 1; 1544 break; 1545 } 1546 } 1547 if (ich_has_controls) 1548 build_mixer_unit_ctl(state, desc, pin, ich, 1549 unitid, &iterm); 1550 } 1551 } 1552 return 0; 1553 } 1554 1555 1556 /* 1557 * Processing Unit / Extension Unit 1558 */ 1559 1560 /* get callback for processing/extension unit */ 1561 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol) 1562 { 1563 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1564 int err, val; 1565 1566 err = get_cur_ctl_value(cval, cval->control << 8, &val); 1567 if (err < 0 && cval->mixer->ignore_ctl_error) { 1568 ucontrol->value.integer.value[0] = cval->min; 1569 return 0; 1570 } 1571 if (err < 0) 1572 return err; 1573 val = get_relative_value(cval, val); 1574 ucontrol->value.integer.value[0] = val; 1575 return 0; 1576 } 1577 1578 /* put callback for processing/extension unit */ 1579 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol) 1580 { 1581 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1582 int val, oval, err; 1583 1584 err = get_cur_ctl_value(cval, cval->control << 8, &oval); 1585 if (err < 0) { 1586 if (cval->mixer->ignore_ctl_error) 1587 return 0; 1588 return err; 1589 } 1590 val = ucontrol->value.integer.value[0]; 1591 val = get_abs_value(cval, val); 1592 if (val != oval) { 1593 set_cur_ctl_value(cval, cval->control << 8, val); 1594 return 1; 1595 } 1596 return 0; 1597 } 1598 1599 /* alsa control interface for processing/extension unit */ 1600 static struct snd_kcontrol_new mixer_procunit_ctl = { 1601 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 1602 .name = "", /* will be filled later */ 1603 .info = mixer_ctl_feature_info, 1604 .get = mixer_ctl_procunit_get, 1605 .put = mixer_ctl_procunit_put, 1606 }; 1607 1608 1609 /* 1610 * predefined data for processing units 1611 */ 1612 struct procunit_value_info { 1613 int control; 1614 char *suffix; 1615 int val_type; 1616 int min_value; 1617 }; 1618 1619 struct procunit_info { 1620 int type; 1621 char *name; 1622 struct procunit_value_info *values; 1623 }; 1624 1625 static struct procunit_value_info updown_proc_info[] = { 1626 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 1627 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 }, 1628 { 0 } 1629 }; 1630 static struct procunit_value_info prologic_proc_info[] = { 1631 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 1632 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 }, 1633 { 0 } 1634 }; 1635 static struct procunit_value_info threed_enh_proc_info[] = { 1636 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 1637 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 }, 1638 { 0 } 1639 }; 1640 static struct procunit_value_info reverb_proc_info[] = { 1641 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 1642 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 }, 1643 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 }, 1644 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 }, 1645 { 0 } 1646 }; 1647 static struct procunit_value_info chorus_proc_info[] = { 1648 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 1649 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 }, 1650 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 }, 1651 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 }, 1652 { 0 } 1653 }; 1654 static struct procunit_value_info dcr_proc_info[] = { 1655 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN }, 1656 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 }, 1657 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 }, 1658 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 }, 1659 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 }, 1660 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 }, 1661 { 0 } 1662 }; 1663 1664 static struct procunit_info procunits[] = { 1665 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info }, 1666 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info }, 1667 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info }, 1668 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info }, 1669 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info }, 1670 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info }, 1671 { 0 }, 1672 }; 1673 /* 1674 * predefined data for extension units 1675 */ 1676 static struct procunit_value_info clock_rate_xu_info[] = { 1677 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 }, 1678 { 0 } 1679 }; 1680 static struct procunit_value_info clock_source_xu_info[] = { 1681 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN }, 1682 { 0 } 1683 }; 1684 static struct procunit_value_info spdif_format_xu_info[] = { 1685 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN }, 1686 { 0 } 1687 }; 1688 static struct procunit_value_info soft_limit_xu_info[] = { 1689 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN }, 1690 { 0 } 1691 }; 1692 static struct procunit_info extunits[] = { 1693 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info }, 1694 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info }, 1695 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info }, 1696 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info }, 1697 { 0 } 1698 }; 1699 /* 1700 * build a processing/extension unit 1701 */ 1702 static int build_audio_procunit(struct mixer_build *state, int unitid, void *raw_desc, struct procunit_info *list, char *name) 1703 { 1704 struct uac_processing_unit_descriptor *desc = raw_desc; 1705 int num_ins = desc->bNrInPins; 1706 struct usb_mixer_elem_info *cval; 1707 struct snd_kcontrol *kctl; 1708 int i, err, nameid, type, len; 1709 struct procunit_info *info; 1710 struct procunit_value_info *valinfo; 1711 const struct usbmix_name_map *map; 1712 static struct procunit_value_info default_value_info[] = { 1713 { 0x01, "Switch", USB_MIXER_BOOLEAN }, 1714 { 0 } 1715 }; 1716 static struct procunit_info default_info = { 1717 0, NULL, default_value_info 1718 }; 1719 1720 if (desc->bLength < 13 || desc->bLength < 13 + num_ins || 1721 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) { 1722 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid); 1723 return -EINVAL; 1724 } 1725 1726 for (i = 0; i < num_ins; i++) { 1727 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0) 1728 return err; 1729 } 1730 1731 type = le16_to_cpu(desc->wProcessType); 1732 for (info = list; info && info->type; info++) 1733 if (info->type == type) 1734 break; 1735 if (! info || ! info->type) 1736 info = &default_info; 1737 1738 for (valinfo = info->values; valinfo->control; valinfo++) { 1739 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol); 1740 1741 if (! (controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1)))) 1742 continue; 1743 map = find_map(state, unitid, valinfo->control); 1744 if (check_ignored_ctl(map)) 1745 continue; 1746 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1747 if (! cval) { 1748 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 1749 return -ENOMEM; 1750 } 1751 cval->mixer = state->mixer; 1752 cval->id = unitid; 1753 cval->control = valinfo->control; 1754 cval->val_type = valinfo->val_type; 1755 cval->channels = 1; 1756 1757 /* get min/max values */ 1758 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) { 1759 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol); 1760 /* FIXME: hard-coded */ 1761 cval->min = 1; 1762 cval->max = control_spec[0]; 1763 cval->res = 1; 1764 cval->initialized = 1; 1765 } else { 1766 if (type == USB_XU_CLOCK_RATE) { 1767 /* E-Mu USB 0404/0202/TrackerPre/0204 1768 * samplerate control quirk 1769 */ 1770 cval->min = 0; 1771 cval->max = 5; 1772 cval->res = 1; 1773 cval->initialized = 1; 1774 } else 1775 get_min_max(cval, valinfo->min_value); 1776 } 1777 1778 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval); 1779 if (! kctl) { 1780 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 1781 kfree(cval); 1782 return -ENOMEM; 1783 } 1784 kctl->private_free = usb_mixer_elem_free; 1785 1786 if (check_mapped_name(map, kctl->id.name, 1787 sizeof(kctl->id.name))) 1788 /* nothing */ ; 1789 else if (info->name) 1790 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name)); 1791 else { 1792 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol); 1793 len = 0; 1794 if (nameid) 1795 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name)); 1796 if (! len) 1797 strlcpy(kctl->id.name, name, sizeof(kctl->id.name)); 1798 } 1799 append_ctl_name(kctl, " "); 1800 append_ctl_name(kctl, valinfo->suffix); 1801 1802 usb_audio_dbg(state->chip, 1803 "[%d] PU [%s] ch = %d, val = %d/%d\n", 1804 cval->id, kctl->id.name, cval->channels, cval->min, cval->max); 1805 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0) 1806 return err; 1807 } 1808 return 0; 1809 } 1810 1811 1812 static int parse_audio_processing_unit(struct mixer_build *state, int unitid, void *raw_desc) 1813 { 1814 return build_audio_procunit(state, unitid, raw_desc, procunits, "Processing Unit"); 1815 } 1816 1817 static int parse_audio_extension_unit(struct mixer_build *state, int unitid, void *raw_desc) 1818 { 1819 /* Note that we parse extension units with processing unit descriptors. 1820 * That's ok as the layout is the same */ 1821 return build_audio_procunit(state, unitid, raw_desc, extunits, "Extension Unit"); 1822 } 1823 1824 1825 /* 1826 * Selector Unit 1827 */ 1828 1829 /* info callback for selector unit 1830 * use an enumerator type for routing 1831 */ 1832 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo) 1833 { 1834 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1835 const char **itemlist = (const char **)kcontrol->private_value; 1836 1837 if (snd_BUG_ON(!itemlist)) 1838 return -EINVAL; 1839 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist); 1840 } 1841 1842 /* get callback for selector unit */ 1843 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol) 1844 { 1845 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1846 int val, err; 1847 1848 err = get_cur_ctl_value(cval, cval->control << 8, &val); 1849 if (err < 0) { 1850 if (cval->mixer->ignore_ctl_error) { 1851 ucontrol->value.enumerated.item[0] = 0; 1852 return 0; 1853 } 1854 return err; 1855 } 1856 val = get_relative_value(cval, val); 1857 ucontrol->value.enumerated.item[0] = val; 1858 return 0; 1859 } 1860 1861 /* put callback for selector unit */ 1862 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol) 1863 { 1864 struct usb_mixer_elem_info *cval = kcontrol->private_data; 1865 int val, oval, err; 1866 1867 err = get_cur_ctl_value(cval, cval->control << 8, &oval); 1868 if (err < 0) { 1869 if (cval->mixer->ignore_ctl_error) 1870 return 0; 1871 return err; 1872 } 1873 val = ucontrol->value.enumerated.item[0]; 1874 val = get_abs_value(cval, val); 1875 if (val != oval) { 1876 set_cur_ctl_value(cval, cval->control << 8, val); 1877 return 1; 1878 } 1879 return 0; 1880 } 1881 1882 /* alsa control interface for selector unit */ 1883 static struct snd_kcontrol_new mixer_selectunit_ctl = { 1884 .iface = SNDRV_CTL_ELEM_IFACE_MIXER, 1885 .name = "", /* will be filled later */ 1886 .info = mixer_ctl_selector_info, 1887 .get = mixer_ctl_selector_get, 1888 .put = mixer_ctl_selector_put, 1889 }; 1890 1891 1892 /* private free callback. 1893 * free both private_data and private_value 1894 */ 1895 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl) 1896 { 1897 int i, num_ins = 0; 1898 1899 if (kctl->private_data) { 1900 struct usb_mixer_elem_info *cval = kctl->private_data; 1901 num_ins = cval->max; 1902 kfree(cval); 1903 kctl->private_data = NULL; 1904 } 1905 if (kctl->private_value) { 1906 char **itemlist = (char **)kctl->private_value; 1907 for (i = 0; i < num_ins; i++) 1908 kfree(itemlist[i]); 1909 kfree(itemlist); 1910 kctl->private_value = 0; 1911 } 1912 } 1913 1914 /* 1915 * parse a selector unit 1916 */ 1917 static int parse_audio_selector_unit(struct mixer_build *state, int unitid, void *raw_desc) 1918 { 1919 struct uac_selector_unit_descriptor *desc = raw_desc; 1920 unsigned int i, nameid, len; 1921 int err; 1922 struct usb_mixer_elem_info *cval; 1923 struct snd_kcontrol *kctl; 1924 const struct usbmix_name_map *map; 1925 char **namelist; 1926 1927 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) { 1928 usb_audio_err(state->chip, 1929 "invalid SELECTOR UNIT descriptor %d\n", unitid); 1930 return -EINVAL; 1931 } 1932 1933 for (i = 0; i < desc->bNrInPins; i++) { 1934 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0) 1935 return err; 1936 } 1937 1938 if (desc->bNrInPins == 1) /* only one ? nonsense! */ 1939 return 0; 1940 1941 map = find_map(state, unitid, 0); 1942 if (check_ignored_ctl(map)) 1943 return 0; 1944 1945 cval = kzalloc(sizeof(*cval), GFP_KERNEL); 1946 if (! cval) { 1947 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 1948 return -ENOMEM; 1949 } 1950 cval->mixer = state->mixer; 1951 cval->id = unitid; 1952 cval->val_type = USB_MIXER_U8; 1953 cval->channels = 1; 1954 cval->min = 1; 1955 cval->max = desc->bNrInPins; 1956 cval->res = 1; 1957 cval->initialized = 1; 1958 1959 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) 1960 cval->control = UAC2_CX_CLOCK_SELECTOR; 1961 else 1962 cval->control = 0; 1963 1964 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL); 1965 if (! namelist) { 1966 usb_audio_err(state->chip, "cannot malloc\n"); 1967 kfree(cval); 1968 return -ENOMEM; 1969 } 1970 #define MAX_ITEM_NAME_LEN 64 1971 for (i = 0; i < desc->bNrInPins; i++) { 1972 struct usb_audio_term iterm; 1973 len = 0; 1974 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL); 1975 if (! namelist[i]) { 1976 usb_audio_err(state->chip, "cannot malloc\n"); 1977 while (i--) 1978 kfree(namelist[i]); 1979 kfree(namelist); 1980 kfree(cval); 1981 return -ENOMEM; 1982 } 1983 len = check_mapped_selector_name(state, unitid, i, namelist[i], 1984 MAX_ITEM_NAME_LEN); 1985 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0) 1986 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0); 1987 if (! len) 1988 sprintf(namelist[i], "Input %d", i); 1989 } 1990 1991 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval); 1992 if (! kctl) { 1993 usb_audio_err(state->chip, "cannot malloc kcontrol\n"); 1994 kfree(namelist); 1995 kfree(cval); 1996 return -ENOMEM; 1997 } 1998 kctl->private_value = (unsigned long)namelist; 1999 kctl->private_free = usb_mixer_selector_elem_free; 2000 2001 nameid = uac_selector_unit_iSelector(desc); 2002 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)); 2003 if (len) 2004 ; 2005 else if (nameid) 2006 snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name)); 2007 else { 2008 len = get_term_name(state, &state->oterm, 2009 kctl->id.name, sizeof(kctl->id.name), 0); 2010 if (! len) 2011 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name)); 2012 2013 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) 2014 append_ctl_name(kctl, " Clock Source"); 2015 else if ((state->oterm.type & 0xff00) == 0x0100) 2016 append_ctl_name(kctl, " Capture Source"); 2017 else 2018 append_ctl_name(kctl, " Playback Source"); 2019 } 2020 2021 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n", 2022 cval->id, kctl->id.name, desc->bNrInPins); 2023 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0) 2024 return err; 2025 2026 return 0; 2027 } 2028 2029 2030 /* 2031 * parse an audio unit recursively 2032 */ 2033 2034 static int parse_audio_unit(struct mixer_build *state, int unitid) 2035 { 2036 unsigned char *p1; 2037 2038 if (test_and_set_bit(unitid, state->unitbitmap)) 2039 return 0; /* the unit already visited */ 2040 2041 p1 = find_audio_control_unit(state, unitid); 2042 if (!p1) { 2043 usb_audio_err(state->chip, "unit %d not found!\n", unitid); 2044 return -EINVAL; 2045 } 2046 2047 switch (p1[2]) { 2048 case UAC_INPUT_TERMINAL: 2049 case UAC2_CLOCK_SOURCE: 2050 return 0; /* NOP */ 2051 case UAC_MIXER_UNIT: 2052 return parse_audio_mixer_unit(state, unitid, p1); 2053 case UAC_SELECTOR_UNIT: 2054 case UAC2_CLOCK_SELECTOR: 2055 return parse_audio_selector_unit(state, unitid, p1); 2056 case UAC_FEATURE_UNIT: 2057 return parse_audio_feature_unit(state, unitid, p1); 2058 case UAC1_PROCESSING_UNIT: 2059 /* UAC2_EFFECT_UNIT has the same value */ 2060 if (state->mixer->protocol == UAC_VERSION_1) 2061 return parse_audio_processing_unit(state, unitid, p1); 2062 else 2063 return 0; /* FIXME - effect units not implemented yet */ 2064 case UAC1_EXTENSION_UNIT: 2065 /* UAC2_PROCESSING_UNIT_V2 has the same value */ 2066 if (state->mixer->protocol == UAC_VERSION_1) 2067 return parse_audio_extension_unit(state, unitid, p1); 2068 else /* UAC_VERSION_2 */ 2069 return parse_audio_processing_unit(state, unitid, p1); 2070 case UAC2_EXTENSION_UNIT_V2: 2071 return parse_audio_extension_unit(state, unitid, p1); 2072 default: 2073 usb_audio_err(state->chip, 2074 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]); 2075 return -EINVAL; 2076 } 2077 } 2078 2079 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer) 2080 { 2081 kfree(mixer->id_elems); 2082 if (mixer->urb) { 2083 kfree(mixer->urb->transfer_buffer); 2084 usb_free_urb(mixer->urb); 2085 } 2086 usb_free_urb(mixer->rc_urb); 2087 kfree(mixer->rc_setup_packet); 2088 kfree(mixer); 2089 } 2090 2091 static int snd_usb_mixer_dev_free(struct snd_device *device) 2092 { 2093 struct usb_mixer_interface *mixer = device->device_data; 2094 snd_usb_mixer_free(mixer); 2095 return 0; 2096 } 2097 2098 /* 2099 * create mixer controls 2100 * 2101 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers 2102 */ 2103 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer) 2104 { 2105 struct mixer_build state; 2106 int err; 2107 const struct usbmix_ctl_map *map; 2108 void *p; 2109 2110 memset(&state, 0, sizeof(state)); 2111 state.chip = mixer->chip; 2112 state.mixer = mixer; 2113 state.buffer = mixer->hostif->extra; 2114 state.buflen = mixer->hostif->extralen; 2115 2116 /* check the mapping table */ 2117 for (map = usbmix_ctl_maps; map->id; map++) { 2118 if (map->id == state.chip->usb_id) { 2119 state.map = map->map; 2120 state.selector_map = map->selector_map; 2121 mixer->ignore_ctl_error = map->ignore_ctl_error; 2122 break; 2123 } 2124 } 2125 2126 p = NULL; 2127 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra, mixer->hostif->extralen, 2128 p, UAC_OUTPUT_TERMINAL)) != NULL) { 2129 if (mixer->protocol == UAC_VERSION_1) { 2130 struct uac1_output_terminal_descriptor *desc = p; 2131 2132 if (desc->bLength < sizeof(*desc)) 2133 continue; /* invalid descriptor? */ 2134 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */ 2135 state.oterm.id = desc->bTerminalID; 2136 state.oterm.type = le16_to_cpu(desc->wTerminalType); 2137 state.oterm.name = desc->iTerminal; 2138 err = parse_audio_unit(&state, desc->bSourceID); 2139 if (err < 0 && err != -EINVAL) 2140 return err; 2141 } else { /* UAC_VERSION_2 */ 2142 struct uac2_output_terminal_descriptor *desc = p; 2143 2144 if (desc->bLength < sizeof(*desc)) 2145 continue; /* invalid descriptor? */ 2146 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */ 2147 state.oterm.id = desc->bTerminalID; 2148 state.oterm.type = le16_to_cpu(desc->wTerminalType); 2149 state.oterm.name = desc->iTerminal; 2150 err = parse_audio_unit(&state, desc->bSourceID); 2151 if (err < 0 && err != -EINVAL) 2152 return err; 2153 2154 /* for UAC2, use the same approach to also add the clock selectors */ 2155 err = parse_audio_unit(&state, desc->bCSourceID); 2156 if (err < 0 && err != -EINVAL) 2157 return err; 2158 } 2159 } 2160 2161 return 0; 2162 } 2163 2164 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid) 2165 { 2166 struct usb_mixer_elem_info *info; 2167 2168 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) 2169 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE, 2170 info->elem_id); 2171 } 2172 2173 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer, 2174 int unitid, 2175 struct usb_mixer_elem_info *cval) 2176 { 2177 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN", 2178 "S8", "U8", "S16", "U16"}; 2179 snd_iprintf(buffer, " Unit: %i\n", unitid); 2180 if (cval->elem_id) 2181 snd_iprintf(buffer, " Control: name=\"%s\", index=%i\n", 2182 cval->elem_id->name, cval->elem_id->index); 2183 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, " 2184 "channels=%i, type=\"%s\"\n", cval->id, 2185 cval->control, cval->cmask, cval->channels, 2186 val_types[cval->val_type]); 2187 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n", 2188 cval->min, cval->max, cval->dBmin, cval->dBmax); 2189 } 2190 2191 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry, 2192 struct snd_info_buffer *buffer) 2193 { 2194 struct snd_usb_audio *chip = entry->private_data; 2195 struct usb_mixer_interface *mixer; 2196 struct usb_mixer_elem_info *cval; 2197 int unitid; 2198 2199 list_for_each_entry(mixer, &chip->mixer_list, list) { 2200 snd_iprintf(buffer, 2201 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n", 2202 chip->usb_id, snd_usb_ctrl_intf(chip), 2203 mixer->ignore_ctl_error); 2204 snd_iprintf(buffer, "Card: %s\n", chip->card->longname); 2205 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) { 2206 for (cval = mixer->id_elems[unitid]; cval; 2207 cval = cval->next_id_elem) 2208 snd_usb_mixer_dump_cval(buffer, unitid, cval); 2209 } 2210 } 2211 } 2212 2213 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer, 2214 int attribute, int value, int index) 2215 { 2216 struct usb_mixer_elem_info *info; 2217 __u8 unitid = (index >> 8) & 0xff; 2218 __u8 control = (value >> 8) & 0xff; 2219 __u8 channel = value & 0xff; 2220 2221 if (channel >= MAX_CHANNELS) { 2222 usb_audio_dbg(mixer->chip, 2223 "%s(): bogus channel number %d\n", 2224 __func__, channel); 2225 return; 2226 } 2227 2228 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) { 2229 if (info->control != control) 2230 continue; 2231 2232 switch (attribute) { 2233 case UAC2_CS_CUR: 2234 /* invalidate cache, so the value is read from the device */ 2235 if (channel) 2236 info->cached &= ~(1 << channel); 2237 else /* master channel */ 2238 info->cached = 0; 2239 2240 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE, 2241 info->elem_id); 2242 break; 2243 2244 case UAC2_CS_RANGE: 2245 /* TODO */ 2246 break; 2247 2248 case UAC2_CS_MEM: 2249 /* TODO */ 2250 break; 2251 2252 default: 2253 usb_audio_dbg(mixer->chip, 2254 "unknown attribute %d in interrupt\n", 2255 attribute); 2256 break; 2257 } /* switch */ 2258 } 2259 } 2260 2261 static void snd_usb_mixer_interrupt(struct urb *urb) 2262 { 2263 struct usb_mixer_interface *mixer = urb->context; 2264 int len = urb->actual_length; 2265 int ustatus = urb->status; 2266 2267 if (ustatus != 0) 2268 goto requeue; 2269 2270 if (mixer->protocol == UAC_VERSION_1) { 2271 struct uac1_status_word *status; 2272 2273 for (status = urb->transfer_buffer; 2274 len >= sizeof(*status); 2275 len -= sizeof(*status), status++) { 2276 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n", 2277 status->bStatusType, 2278 status->bOriginator); 2279 2280 /* ignore any notifications not from the control interface */ 2281 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) != 2282 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF) 2283 continue; 2284 2285 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED) 2286 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator); 2287 else 2288 snd_usb_mixer_notify_id(mixer, status->bOriginator); 2289 } 2290 } else { /* UAC_VERSION_2 */ 2291 struct uac2_interrupt_data_msg *msg; 2292 2293 for (msg = urb->transfer_buffer; 2294 len >= sizeof(*msg); 2295 len -= sizeof(*msg), msg++) { 2296 /* drop vendor specific and endpoint requests */ 2297 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) || 2298 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP)) 2299 continue; 2300 2301 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute, 2302 le16_to_cpu(msg->wValue), 2303 le16_to_cpu(msg->wIndex)); 2304 } 2305 } 2306 2307 requeue: 2308 if (ustatus != -ENOENT && ustatus != -ECONNRESET && ustatus != -ESHUTDOWN) { 2309 urb->dev = mixer->chip->dev; 2310 usb_submit_urb(urb, GFP_ATOMIC); 2311 } 2312 } 2313 2314 /* create the handler for the optional status interrupt endpoint */ 2315 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer) 2316 { 2317 struct usb_endpoint_descriptor *ep; 2318 void *transfer_buffer; 2319 int buffer_length; 2320 unsigned int epnum; 2321 2322 /* we need one interrupt input endpoint */ 2323 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1) 2324 return 0; 2325 ep = get_endpoint(mixer->hostif, 0); 2326 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep)) 2327 return 0; 2328 2329 epnum = usb_endpoint_num(ep); 2330 buffer_length = le16_to_cpu(ep->wMaxPacketSize); 2331 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL); 2332 if (!transfer_buffer) 2333 return -ENOMEM; 2334 mixer->urb = usb_alloc_urb(0, GFP_KERNEL); 2335 if (!mixer->urb) { 2336 kfree(transfer_buffer); 2337 return -ENOMEM; 2338 } 2339 usb_fill_int_urb(mixer->urb, mixer->chip->dev, 2340 usb_rcvintpipe(mixer->chip->dev, epnum), 2341 transfer_buffer, buffer_length, 2342 snd_usb_mixer_interrupt, mixer, ep->bInterval); 2343 usb_submit_urb(mixer->urb, GFP_KERNEL); 2344 return 0; 2345 } 2346 2347 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif, 2348 int ignore_error) 2349 { 2350 static struct snd_device_ops dev_ops = { 2351 .dev_free = snd_usb_mixer_dev_free 2352 }; 2353 struct usb_mixer_interface *mixer; 2354 struct snd_info_entry *entry; 2355 int err; 2356 2357 strcpy(chip->card->mixername, "USB Mixer"); 2358 2359 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL); 2360 if (!mixer) 2361 return -ENOMEM; 2362 mixer->chip = chip; 2363 mixer->ignore_ctl_error = ignore_error; 2364 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems), 2365 GFP_KERNEL); 2366 if (!mixer->id_elems) { 2367 kfree(mixer); 2368 return -ENOMEM; 2369 } 2370 2371 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0]; 2372 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) { 2373 case UAC_VERSION_1: 2374 default: 2375 mixer->protocol = UAC_VERSION_1; 2376 break; 2377 case UAC_VERSION_2: 2378 mixer->protocol = UAC_VERSION_2; 2379 break; 2380 } 2381 2382 if ((err = snd_usb_mixer_controls(mixer)) < 0 || 2383 (err = snd_usb_mixer_status_create(mixer)) < 0) 2384 goto _error; 2385 2386 snd_usb_mixer_apply_create_quirk(mixer); 2387 2388 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops); 2389 if (err < 0) 2390 goto _error; 2391 2392 if (list_empty(&chip->mixer_list) && 2393 !snd_card_proc_new(chip->card, "usbmixer", &entry)) 2394 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read); 2395 2396 list_add(&mixer->list, &chip->mixer_list); 2397 return 0; 2398 2399 _error: 2400 snd_usb_mixer_free(mixer); 2401 return err; 2402 } 2403 2404 void snd_usb_mixer_disconnect(struct list_head *p) 2405 { 2406 struct usb_mixer_interface *mixer; 2407 2408 mixer = list_entry(p, struct usb_mixer_interface, list); 2409 usb_kill_urb(mixer->urb); 2410 usb_kill_urb(mixer->rc_urb); 2411 } 2412 2413 #ifdef CONFIG_PM 2414 /* stop any bus activity of a mixer */ 2415 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer) 2416 { 2417 usb_kill_urb(mixer->urb); 2418 usb_kill_urb(mixer->rc_urb); 2419 } 2420 2421 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer) 2422 { 2423 int err; 2424 2425 if (mixer->urb) { 2426 err = usb_submit_urb(mixer->urb, GFP_NOIO); 2427 if (err < 0) 2428 return err; 2429 } 2430 2431 return 0; 2432 } 2433 2434 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer) 2435 { 2436 snd_usb_mixer_inactivate(mixer); 2437 return 0; 2438 } 2439 2440 static int restore_mixer_value(struct usb_mixer_elem_info *cval) 2441 { 2442 int c, err, idx; 2443 2444 if (cval->cmask) { 2445 idx = 0; 2446 for (c = 0; c < MAX_CHANNELS; c++) { 2447 if (!(cval->cmask & (1 << c))) 2448 continue; 2449 if (cval->cached & (1 << c)) { 2450 err = set_cur_mix_value(cval, c + 1, idx, 2451 cval->cache_val[idx]); 2452 if (err < 0) 2453 return err; 2454 } 2455 idx++; 2456 } 2457 } else { 2458 /* master */ 2459 if (cval->cached) { 2460 err = set_cur_mix_value(cval, 0, 0, *cval->cache_val); 2461 if (err < 0) 2462 return err; 2463 } 2464 } 2465 2466 return 0; 2467 } 2468 2469 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume) 2470 { 2471 struct usb_mixer_elem_info *cval; 2472 int id, err; 2473 2474 /* FIXME: any mixer quirks? */ 2475 2476 if (reset_resume) { 2477 /* restore cached mixer values */ 2478 for (id = 0; id < MAX_ID_ELEMS; id++) { 2479 for (cval = mixer->id_elems[id]; cval; 2480 cval = cval->next_id_elem) { 2481 err = restore_mixer_value(cval); 2482 if (err < 0) 2483 return err; 2484 } 2485 } 2486 } 2487 2488 return snd_usb_mixer_activate(mixer); 2489 } 2490 #endif 2491