sound/usb/mixer.c

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