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