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