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