sound/usb/mixer.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *   (Tentative) USB Audio Driver for ALSA
   4  *
   5  *   Mixer control part
   6  *
   7  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
   8  *
   9  *   Many codes borrowed from audio.c by
  10  *          Alan Cox (alan@lxorguk.ukuu.org.uk)
  11  *          Thomas Sailer (sailer@ife.ee.ethz.ch)
  12  */
  13
  14 /*
  15  * TODOs, for both the mixer and the streaming interfaces:
  16  *
  17  *  - support for UAC2 effect units
  18  *  - support for graphical equalizers
  19  *  - RANGE and MEM set commands (UAC2)
  20  *  - RANGE and MEM interrupt dispatchers (UAC2)
  21  *  - audio channel clustering (UAC2)
  22  *  - audio sample rate converter units (UAC2)
  23  *  - proper handling of clock multipliers (UAC2)
  24  *  - dispatch clock change notifications (UAC2)
  25  *      - stop PCM streams which use a clock that became invalid
  26  *      - stop PCM streams which use a clock selector that has changed
  27  *      - parse available sample rates again when clock sources changed
  28  */
  29
  30 #include <linux/bitops.h>
  31 #include <linux/init.h>
  32 #include <linux/list.h>
  33 #include <linux/log2.h>
  34 #include <linux/slab.h>
  35 #include <linux/string.h>
  36 #include <linux/usb.h>
  37 #include <linux/usb/audio.h>
  38 #include <linux/usb/audio-v2.h>
  39 #include <linux/usb/audio-v3.h>
  40
  41 #include <sound/core.h>
  42 #include <sound/control.h>
  43 #include <sound/hwdep.h>
  44 #include <sound/info.h>
  45 #include <sound/tlv.h>
  46
  47 #include "usbaudio.h"
  48 #include "mixer.h"
  49 #include "helper.h"
  50 #include "mixer_quirks.h"
  51 #include "power.h"
  52
  53 #define MAX_ID_ELEMS    256
  54
  55 struct usb_audio_term {
  56         int id;
  57         int type;
  58         int channels;
  59         unsigned int chconfig;
  60         int name;
  61 };
  62
  63 struct usbmix_name_map;
  64
  65 struct mixer_build {
  66         struct snd_usb_audio *chip;
  67         struct usb_mixer_interface *mixer;
  68         unsigned char *buffer;
  69         unsigned int buflen;
  70         DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
  71         DECLARE_BITMAP(termbitmap, MAX_ID_ELEMS);
  72         struct usb_audio_term oterm;
  73         const struct usbmix_name_map *map;
  74         const struct usbmix_selector_map *selector_map;
  75 };
  76
  77 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
  78 enum {
  79         USB_XU_CLOCK_RATE               = 0xe301,
  80         USB_XU_CLOCK_SOURCE             = 0xe302,
  81         USB_XU_DIGITAL_IO_STATUS        = 0xe303,
  82         USB_XU_DEVICE_OPTIONS           = 0xe304,
  83         USB_XU_DIRECT_MONITORING        = 0xe305,
  84         USB_XU_METERING                 = 0xe306
  85 };
  86 enum {
  87         USB_XU_CLOCK_SOURCE_SELECTOR = 0x02,    /* clock source*/
  88         USB_XU_CLOCK_RATE_SELECTOR = 0x03,      /* clock rate */
  89         USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01,  /* the spdif format */
  90         USB_XU_SOFT_LIMIT_SELECTOR = 0x03       /* soft limiter */
  91 };
  92
  93 /*
  94  * manual mapping of mixer names
  95  * if the mixer topology is too complicated and the parsed names are
  96  * ambiguous, add the entries in usbmixer_maps.c.
  97  */
  98 #include "mixer_maps.c"
  99
 100 static const struct usbmix_name_map *
 101 find_map(const struct usbmix_name_map *p, int unitid, int control)
 102 {
 103         if (!p)
 104                 return NULL;
 105
 106         for (; p->id; p++) {
 107                 if (p->id == unitid &&
 108                     (!control || !p->control || control == p->control))
 109                         return p;
 110         }
 111         return NULL;
 112 }
 113
 114 /* get the mapped name if the unit matches */
 115 static int
 116 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
 117 {
 118         int len;
 119
 120         if (!p || !p->name)
 121                 return 0;
 122
 123         buflen--;
 124         len = strscpy(buf, p->name, buflen);
 125         return len < 0 ? buflen : len;
 126 }
 127
 128 /* ignore the error value if ignore_ctl_error flag is set */
 129 #define filter_error(cval, err) \
 130         ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
 131
 132 /* check whether the control should be ignored */
 133 static inline int
 134 check_ignored_ctl(const struct usbmix_name_map *p)
 135 {
 136         if (!p || p->name || p->dB)
 137                 return 0;
 138         return 1;
 139 }
 140
 141 /* dB mapping */
 142 static inline void check_mapped_dB(const struct usbmix_name_map *p,
 143                                    struct usb_mixer_elem_info *cval)
 144 {
 145         if (p && p->dB) {
 146                 cval->dBmin = p->dB->min;
 147                 cval->dBmax = p->dB->max;
 148                 cval->min_mute = p->dB->min_mute;
 149                 cval->initialized = 1;
 150         }
 151 }
 152
 153 /* get the mapped selector source name */
 154 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
 155                                       int index, char *buf, int buflen)
 156 {
 157         const struct usbmix_selector_map *p;
 158         int len;
 159
 160         if (!state->selector_map)
 161                 return 0;
 162         for (p = state->selector_map; p->id; p++) {
 163                 if (p->id == unitid && index < p->count) {
 164                         len = strscpy(buf, p->names[index], buflen);
 165                         return len < 0 ? buflen : len;
 166                 }
 167         }
 168         return 0;
 169 }
 170
 171 /*
 172  * find an audio control unit with the given unit id
 173  */
 174 static void *find_audio_control_unit(struct mixer_build *state,
 175                                      unsigned char unit)
 176 {
 177         /* we just parse the header */
 178         struct uac_feature_unit_descriptor *hdr = NULL;
 179
 180         while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
 181                                         USB_DT_CS_INTERFACE)) != NULL) {
 182                 if (hdr->bLength >= 4 &&
 183                     hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
 184                     hdr->bDescriptorSubtype <= UAC3_SAMPLE_RATE_CONVERTER &&
 185                     hdr->bUnitID == unit)
 186                         return hdr;
 187         }
 188
 189         return NULL;
 190 }
 191
 192 /*
 193  * copy a string with the given id
 194  */
 195 static int snd_usb_copy_string_desc(struct snd_usb_audio *chip,
 196                                     int index, char *buf, int maxlen)
 197 {
 198         int len = usb_string(chip->dev, index, buf, maxlen - 1);
 199
 200         if (len < 0)
 201                 return 0;
 202
 203         buf[len] = 0;
 204         return len;
 205 }
 206
 207 /*
 208  * convert from the byte/word on usb descriptor to the zero-based integer
 209  */
 210 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
 211 {
 212         switch (cval->val_type) {
 213         case USB_MIXER_BOOLEAN:
 214                 return !!val;
 215         case USB_MIXER_INV_BOOLEAN:
 216                 return !val;
 217         case USB_MIXER_U8:
 218                 val &= 0xff;
 219                 break;
 220         case USB_MIXER_S8:
 221                 val &= 0xff;
 222                 if (val >= 0x80)
 223                         val -= 0x100;
 224                 break;
 225         case USB_MIXER_U16:
 226                 val &= 0xffff;
 227                 break;
 228         case USB_MIXER_S16:
 229                 val &= 0xffff;
 230                 if (val >= 0x8000)
 231                         val -= 0x10000;
 232                 break;
 233         }
 234         return val;
 235 }
 236
 237 /*
 238  * convert from the zero-based int to the byte/word for usb descriptor
 239  */
 240 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
 241 {
 242         switch (cval->val_type) {
 243         case USB_MIXER_BOOLEAN:
 244                 return !!val;
 245         case USB_MIXER_INV_BOOLEAN:
 246                 return !val;
 247         case USB_MIXER_S8:
 248         case USB_MIXER_U8:
 249                 return val & 0xff;
 250         case USB_MIXER_S16:
 251         case USB_MIXER_U16:
 252                 return val & 0xffff;
 253         }
 254         return 0; /* not reached */
 255 }
 256
 257 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
 258 {
 259         if (!cval->res)
 260                 cval->res = 1;
 261         if (val < cval->min)
 262                 return 0;
 263         else if (val >= cval->max)
 264                 return DIV_ROUND_UP(cval->max - cval->min, cval->res);
 265         else
 266                 return (val - cval->min) / cval->res;
 267 }
 268
 269 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
 270 {
 271         if (val < 0)
 272                 return cval->min;
 273         if (!cval->res)
 274                 cval->res = 1;
 275         val *= cval->res;
 276         val += cval->min;
 277         if (val > cval->max)
 278                 return cval->max;
 279         return val;
 280 }
 281
 282 static int uac2_ctl_value_size(int val_type)
 283 {
 284         switch (val_type) {
 285         case USB_MIXER_S32:
 286         case USB_MIXER_U32:
 287                 return 4;
 288         case USB_MIXER_S16:
 289         case USB_MIXER_U16:
 290                 return 2;
 291         default:
 292                 return 1;
 293         }
 294         return 0; /* unreachable */
 295 }
 296
 297
 298 /*
 299  * retrieve a mixer value
 300  */
 301
 302 static inline int mixer_ctrl_intf(struct usb_mixer_interface *mixer)
 303 {
 304         return get_iface_desc(mixer->hostif)->bInterfaceNumber;
 305 }
 306
 307 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
 308                             int validx, int *value_ret)
 309 {
 310         struct snd_usb_audio *chip = cval->head.mixer->chip;
 311         unsigned char buf[2];
 312         int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
 313         int timeout = 10;
 314         int idx = 0, err;
 315
 316         err = snd_usb_lock_shutdown(chip);
 317         if (err < 0)
 318                 return -EIO;
 319
 320         while (timeout-- > 0) {
 321                 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
 322                 err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
 323                                       USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
 324                                       validx, idx, buf, val_len);
 325                 if (err >= val_len) {
 326                         *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
 327                         err = 0;
 328                         goto out;
 329                 } else if (err == -ETIMEDOUT) {
 330                         goto out;
 331                 }
 332         }
 333         usb_audio_dbg(chip,
 334                 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
 335                 request, validx, idx, cval->val_type);
 336         err = -EINVAL;
 337
 338  out:
 339         snd_usb_unlock_shutdown(chip);
 340         return err;
 341 }
 342
 343 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
 344                             int validx, int *value_ret)
 345 {
 346         struct snd_usb_audio *chip = cval->head.mixer->chip;
 347         /* enough space for one range */
 348         unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
 349         unsigned char *val;
 350         int idx = 0, ret, val_size, size;
 351         __u8 bRequest;
 352
 353         val_size = uac2_ctl_value_size(cval->val_type);
 354
 355         if (request == UAC_GET_CUR) {
 356                 bRequest = UAC2_CS_CUR;
 357                 size = val_size;
 358         } else {
 359                 bRequest = UAC2_CS_RANGE;
 360                 size = sizeof(__u16) + 3 * val_size;
 361         }
 362
 363         memset(buf, 0, sizeof(buf));
 364
 365         if (snd_usb_lock_shutdown(chip))
 366                 return -EIO;
 367
 368         idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
 369         ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
 370                               USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
 371                               validx, idx, buf, size);
 372         snd_usb_unlock_shutdown(chip);
 373
 374         if (ret < 0) {
 375                 usb_audio_dbg(chip,
 376                         "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
 377                         request, validx, idx, cval->val_type);
 378                 return ret;
 379         }
 380
 381         /* FIXME: how should we handle multiple triplets here? */
 382
 383         switch (request) {
 384         case UAC_GET_CUR:
 385                 val = buf;
 386                 break;
 387         case UAC_GET_MIN:
 388                 val = buf + sizeof(__u16);
 389                 break;
 390         case UAC_GET_MAX:
 391                 val = buf + sizeof(__u16) + val_size;
 392                 break;
 393         case UAC_GET_RES:
 394                 val = buf + sizeof(__u16) + val_size * 2;
 395                 break;
 396         default:
 397                 return -EINVAL;
 398         }
 399
 400         *value_ret = convert_signed_value(cval,
 401                                           snd_usb_combine_bytes(val, val_size));
 402
 403         return 0;
 404 }
 405
 406 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
 407                          int validx, int *value_ret)
 408 {
 409         validx += cval->idx_off;
 410
 411         return (cval->head.mixer->protocol == UAC_VERSION_1) ?
 412                 get_ctl_value_v1(cval, request, validx, value_ret) :
 413                 get_ctl_value_v2(cval, request, validx, value_ret);
 414 }
 415
 416 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
 417                              int validx, int *value)
 418 {
 419         return get_ctl_value(cval, UAC_GET_CUR, validx, value);
 420 }
 421
 422 /* channel = 0: master, 1 = first channel */
 423 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
 424                                   int channel, int *value)
 425 {
 426         return get_ctl_value(cval, UAC_GET_CUR,
 427                              (cval->control << 8) | channel,
 428                              value);
 429 }
 430
 431 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
 432                              int channel, int index, int *value)
 433 {
 434         int err;
 435
 436         if (cval->cached & (1 << channel)) {
 437                 *value = cval->cache_val[index];
 438                 return 0;
 439         }
 440         err = get_cur_mix_raw(cval, channel, value);
 441         if (err < 0) {
 442                 if (!cval->head.mixer->ignore_ctl_error)
 443                         usb_audio_dbg(cval->head.mixer->chip,
 444                                 "cannot get current value for control %d ch %d: err = %d\n",
 445                                       cval->control, channel, err);
 446                 return err;
 447         }
 448         cval->cached |= 1 << channel;
 449         cval->cache_val[index] = *value;
 450         return 0;
 451 }
 452
 453 /*
 454  * set a mixer value
 455  */
 456
 457 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
 458                                 int request, int validx, int value_set)
 459 {
 460         struct snd_usb_audio *chip = cval->head.mixer->chip;
 461         unsigned char buf[4];
 462         int idx = 0, val_len, err, timeout = 10;
 463
 464         validx += cval->idx_off;
 465
 466
 467         if (cval->head.mixer->protocol == UAC_VERSION_1) {
 468                 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
 469         } else { /* UAC_VERSION_2/3 */
 470                 val_len = uac2_ctl_value_size(cval->val_type);
 471
 472                 /* FIXME */
 473                 if (request != UAC_SET_CUR) {
 474                         usb_audio_dbg(chip, "RANGE setting not yet supported\n");
 475                         return -EINVAL;
 476                 }
 477
 478                 request = UAC2_CS_CUR;
 479         }
 480
 481         value_set = convert_bytes_value(cval, value_set);
 482         buf[0] = value_set & 0xff;
 483         buf[1] = (value_set >> 8) & 0xff;
 484         buf[2] = (value_set >> 16) & 0xff;
 485         buf[3] = (value_set >> 24) & 0xff;
 486
 487         err = snd_usb_lock_shutdown(chip);
 488         if (err < 0)
 489                 return -EIO;
 490
 491         while (timeout-- > 0) {
 492                 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
 493                 err = snd_usb_ctl_msg(chip->dev,
 494                                       usb_sndctrlpipe(chip->dev, 0), request,
 495                                       USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
 496                                       validx, idx, buf, val_len);
 497                 if (err >= 0) {
 498                         err = 0;
 499                         goto out;
 500                 } else if (err == -ETIMEDOUT) {
 501                         goto out;
 502                 }
 503         }
 504         usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
 505                       request, validx, idx, cval->val_type, buf[0], buf[1]);
 506         err = -EINVAL;
 507
 508  out:
 509         snd_usb_unlock_shutdown(chip);
 510         return err;
 511 }
 512
 513 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
 514                              int validx, int value)
 515 {
 516         return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
 517 }
 518
 519 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
 520                              int index, int value)
 521 {
 522         int err;
 523         unsigned int read_only = (channel == 0) ?
 524                 cval->master_readonly :
 525                 cval->ch_readonly & (1 << (channel - 1));
 526
 527         if (read_only) {
 528                 usb_audio_dbg(cval->head.mixer->chip,
 529                               "%s(): channel %d of control %d is read_only\n",
 530                             __func__, channel, cval->control);
 531                 return 0;
 532         }
 533
 534         err = snd_usb_mixer_set_ctl_value(cval,
 535                                           UAC_SET_CUR, (cval->control << 8) | channel,
 536                                           value);
 537         if (err < 0)
 538                 return err;
 539         cval->cached |= 1 << channel;
 540         cval->cache_val[index] = value;
 541         return 0;
 542 }
 543
 544 /*
 545  * TLV callback for mixer volume controls
 546  */
 547 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
 548                          unsigned int size, unsigned int __user *_tlv)
 549 {
 550         struct usb_mixer_elem_info *cval = kcontrol->private_data;
 551         DECLARE_TLV_DB_MINMAX(scale, 0, 0);
 552
 553         if (size < sizeof(scale))
 554                 return -ENOMEM;
 555         if (cval->min_mute)
 556                 scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE;
 557         scale[2] = cval->dBmin;
 558         scale[3] = cval->dBmax;
 559         if (copy_to_user(_tlv, scale, sizeof(scale)))
 560                 return -EFAULT;
 561         return 0;
 562 }
 563
 564 /*
 565  * parser routines begin here...
 566  */
 567
 568 static int parse_audio_unit(struct mixer_build *state, int unitid);
 569
 570
 571 /*
 572  * check if the input/output channel routing is enabled on the given bitmap.
 573  * used for mixer unit parser
 574  */
 575 static int check_matrix_bitmap(unsigned char *bmap,
 576                                int ich, int och, int num_outs)
 577 {
 578         int idx = ich * num_outs + och;
 579         return bmap[idx >> 3] & (0x80 >> (idx & 7));
 580 }
 581
 582 /*
 583  * add an alsa control element
 584  * search and increment the index until an empty slot is found.
 585  *
 586  * if failed, give up and free the control instance.
 587  */
 588
 589 int snd_usb_mixer_add_list(struct usb_mixer_elem_list *list,
 590                            struct snd_kcontrol *kctl,
 591                            bool is_std_info)
 592 {
 593         struct usb_mixer_interface *mixer = list->mixer;
 594         int err;
 595
 596         while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
 597                 kctl->id.index++;
 598         err = snd_ctl_add(mixer->chip->card, kctl);
 599         if (err < 0) {
 600                 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
 601                               err);
 602                 return err;
 603         }
 604         list->kctl = kctl;
 605         list->is_std_info = is_std_info;
 606         list->next_id_elem = mixer->id_elems[list->id];
 607         mixer->id_elems[list->id] = list;
 608         return 0;
 609 }
 610
 611 /*
 612  * get a terminal name string
 613  */
 614
 615 static struct iterm_name_combo {
 616         int type;
 617         char *name;
 618 } iterm_names[] = {
 619         { 0x0300, "Output" },
 620         { 0x0301, "Speaker" },
 621         { 0x0302, "Headphone" },
 622         { 0x0303, "HMD Audio" },
 623         { 0x0304, "Desktop Speaker" },
 624         { 0x0305, "Room Speaker" },
 625         { 0x0306, "Com Speaker" },
 626         { 0x0307, "LFE" },
 627         { 0x0600, "External In" },
 628         { 0x0601, "Analog In" },
 629         { 0x0602, "Digital In" },
 630         { 0x0603, "Line" },
 631         { 0x0604, "Legacy In" },
 632         { 0x0605, "IEC958 In" },
 633         { 0x0606, "1394 DA Stream" },
 634         { 0x0607, "1394 DV Stream" },
 635         { 0x0700, "Embedded" },
 636         { 0x0701, "Noise Source" },
 637         { 0x0702, "Equalization Noise" },
 638         { 0x0703, "CD" },
 639         { 0x0704, "DAT" },
 640         { 0x0705, "DCC" },
 641         { 0x0706, "MiniDisk" },
 642         { 0x0707, "Analog Tape" },
 643         { 0x0708, "Phonograph" },
 644         { 0x0709, "VCR Audio" },
 645         { 0x070a, "Video Disk Audio" },
 646         { 0x070b, "DVD Audio" },
 647         { 0x070c, "TV Tuner Audio" },
 648         { 0x070d, "Satellite Rec Audio" },
 649         { 0x070e, "Cable Tuner Audio" },
 650         { 0x070f, "DSS Audio" },
 651         { 0x0710, "Radio Receiver" },
 652         { 0x0711, "Radio Transmitter" },
 653         { 0x0712, "Multi-Track Recorder" },
 654         { 0x0713, "Synthesizer" },
 655         { 0 },
 656 };
 657
 658 static int get_term_name(struct snd_usb_audio *chip, struct usb_audio_term *iterm,
 659                          unsigned char *name, int maxlen, int term_only)
 660 {
 661         struct iterm_name_combo *names;
 662         int len;
 663
 664         if (iterm->name) {
 665                 len = snd_usb_copy_string_desc(chip, iterm->name,
 666                                                 name, maxlen);
 667                 if (len)
 668                         return len;
 669         }
 670
 671         /* virtual type - not a real terminal */
 672         if (iterm->type >> 16) {
 673                 if (term_only)
 674                         return 0;
 675                 switch (iterm->type >> 16) {
 676                 case UAC3_SELECTOR_UNIT:
 677                         strcpy(name, "Selector");
 678                         return 8;
 679                 case UAC3_PROCESSING_UNIT:
 680                         strcpy(name, "Process Unit");
 681                         return 12;
 682                 case UAC3_EXTENSION_UNIT:
 683                         strcpy(name, "Ext Unit");
 684                         return 8;
 685                 case UAC3_MIXER_UNIT:
 686                         strcpy(name, "Mixer");
 687                         return 5;
 688                 default:
 689                         return sprintf(name, "Unit %d", iterm->id);
 690                 }
 691         }
 692
 693         switch (iterm->type & 0xff00) {
 694         case 0x0100:
 695                 strcpy(name, "PCM");
 696                 return 3;
 697         case 0x0200:
 698                 strcpy(name, "Mic");
 699                 return 3;
 700         case 0x0400:
 701                 strcpy(name, "Headset");
 702                 return 7;
 703         case 0x0500:
 704                 strcpy(name, "Phone");
 705                 return 5;
 706         }
 707
 708         for (names = iterm_names; names->type; names++) {
 709                 if (names->type == iterm->type) {
 710                         strcpy(name, names->name);
 711                         return strlen(names->name);
 712                 }
 713         }
 714
 715         return 0;
 716 }
 717
 718 /*
 719  * Get logical cluster information for UAC3 devices.
 720  */
 721 static int get_cluster_channels_v3(struct mixer_build *state, unsigned int cluster_id)
 722 {
 723         struct uac3_cluster_header_descriptor c_header;
 724         int err;
 725
 726         err = snd_usb_ctl_msg(state->chip->dev,
 727                         usb_rcvctrlpipe(state->chip->dev, 0),
 728                         UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
 729                         USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
 730                         cluster_id,
 731                         snd_usb_ctrl_intf(state->chip),
 732                         &c_header, sizeof(c_header));
 733         if (err < 0)
 734                 goto error;
 735         if (err != sizeof(c_header)) {
 736                 err = -EIO;
 737                 goto error;
 738         }
 739
 740         return c_header.bNrChannels;
 741
 742 error:
 743         usb_audio_err(state->chip, "cannot request logical cluster ID: %d (err: %d)\n", cluster_id, err);
 744         return err;
 745 }
 746
 747 /*
 748  * Get number of channels for a Mixer Unit.
 749  */
 750 static int uac_mixer_unit_get_channels(struct mixer_build *state,
 751                                        struct uac_mixer_unit_descriptor *desc)
 752 {
 753         int mu_channels;
 754
 755         switch (state->mixer->protocol) {
 756         case UAC_VERSION_1:
 757         case UAC_VERSION_2:
 758         default:
 759                 if (desc->bLength < sizeof(*desc) + desc->bNrInPins + 1)
 760                         return 0; /* no bmControls -> skip */
 761                 mu_channels = uac_mixer_unit_bNrChannels(desc);
 762                 break;
 763         case UAC_VERSION_3:
 764                 mu_channels = get_cluster_channels_v3(state,
 765                                 uac3_mixer_unit_wClusterDescrID(desc));
 766                 break;
 767         }
 768
 769         return mu_channels;
 770 }
 771
 772 /*
 773  * Parse Input Terminal Unit
 774  */
 775 static int __check_input_term(struct mixer_build *state, int id,
 776                               struct usb_audio_term *term);
 777
 778 static int parse_term_uac1_iterm_unit(struct mixer_build *state,
 779                                       struct usb_audio_term *term,
 780                                       void *p1, int id)
 781 {
 782         struct uac_input_terminal_descriptor *d = p1;
 783
 784         term->type = le16_to_cpu(d->wTerminalType);
 785         term->channels = d->bNrChannels;
 786         term->chconfig = le16_to_cpu(d->wChannelConfig);
 787         term->name = d->iTerminal;
 788         return 0;
 789 }
 790
 791 static int parse_term_uac2_iterm_unit(struct mixer_build *state,
 792                                       struct usb_audio_term *term,
 793                                       void *p1, int id)
 794 {
 795         struct uac2_input_terminal_descriptor *d = p1;
 796         int err;
 797
 798         /* call recursively to verify the referenced clock entity */
 799         err = __check_input_term(state, d->bCSourceID, term);
 800         if (err < 0)
 801                 return err;
 802
 803         /* save input term properties after recursion,
 804          * to ensure they are not overriden by the recursion calls
 805          */
 806         term->id = id;
 807         term->type = le16_to_cpu(d->wTerminalType);
 808         term->channels = d->bNrChannels;
 809         term->chconfig = le32_to_cpu(d->bmChannelConfig);
 810         term->name = d->iTerminal;
 811         return 0;
 812 }
 813
 814 static int parse_term_uac3_iterm_unit(struct mixer_build *state,
 815                                       struct usb_audio_term *term,
 816                                       void *p1, int id)
 817 {
 818         struct uac3_input_terminal_descriptor *d = p1;
 819         int err;
 820
 821         /* call recursively to verify the referenced clock entity */
 822         err = __check_input_term(state, d->bCSourceID, term);
 823         if (err < 0)
 824                 return err;
 825
 826         /* save input term properties after recursion,
 827          * to ensure they are not overriden by the recursion calls
 828          */
 829         term->id = id;
 830         term->type = le16_to_cpu(d->wTerminalType);
 831
 832         err = get_cluster_channels_v3(state, le16_to_cpu(d->wClusterDescrID));
 833         if (err < 0)
 834                 return err;
 835         term->channels = err;
 836
 837         /* REVISIT: UAC3 IT doesn't have channels cfg */
 838         term->chconfig = 0;
 839
 840         term->name = le16_to_cpu(d->wTerminalDescrStr);
 841         return 0;
 842 }
 843
 844 static int parse_term_mixer_unit(struct mixer_build *state,
 845                                  struct usb_audio_term *term,
 846                                  void *p1, int id)
 847 {
 848         struct uac_mixer_unit_descriptor *d = p1;
 849         int protocol = state->mixer->protocol;
 850         int err;
 851
 852         err = uac_mixer_unit_get_channels(state, d);
 853         if (err <= 0)
 854                 return err;
 855
 856         term->type = UAC3_MIXER_UNIT << 16; /* virtual type */
 857         term->channels = err;
 858         if (protocol != UAC_VERSION_3) {
 859                 term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
 860                 term->name = uac_mixer_unit_iMixer(d);
 861         }
 862         return 0;
 863 }
 864
 865 static int parse_term_selector_unit(struct mixer_build *state,
 866                                     struct usb_audio_term *term,
 867                                     void *p1, int id)
 868 {
 869         struct uac_selector_unit_descriptor *d = p1;
 870         int err;
 871
 872         /* call recursively to retrieve the channel info */
 873         err = __check_input_term(state, d->baSourceID[0], term);
 874         if (err < 0)
 875                 return err;
 876         term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */
 877         term->id = id;
 878         if (state->mixer->protocol != UAC_VERSION_3)
 879                 term->name = uac_selector_unit_iSelector(d);
 880         return 0;
 881 }
 882
 883 static int parse_term_proc_unit(struct mixer_build *state,
 884                                 struct usb_audio_term *term,
 885                                 void *p1, int id, int vtype)
 886 {
 887         struct uac_processing_unit_descriptor *d = p1;
 888         int protocol = state->mixer->protocol;
 889         int err;
 890
 891         if (d->bNrInPins) {
 892                 /* call recursively to retrieve the channel info */
 893                 err = __check_input_term(state, d->baSourceID[0], term);
 894                 if (err < 0)
 895                         return err;
 896         }
 897
 898         term->type = vtype << 16; /* virtual type */
 899         term->id = id;
 900
 901         if (protocol == UAC_VERSION_3)
 902                 return 0;
 903
 904         if (!term->channels) {
 905                 term->channels = uac_processing_unit_bNrChannels(d);
 906                 term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
 907         }
 908         term->name = uac_processing_unit_iProcessing(d, protocol);
 909         return 0;
 910 }
 911
 912 static int parse_term_effect_unit(struct mixer_build *state,
 913                                   struct usb_audio_term *term,
 914                                   void *p1, int id)
 915 {
 916         struct uac2_effect_unit_descriptor *d = p1;
 917         int err;
 918
 919         err = __check_input_term(state, d->bSourceID, term);
 920         if (err < 0)
 921                 return err;
 922         term->type = UAC3_EFFECT_UNIT << 16; /* virtual type */
 923         term->id = id;
 924         return 0;
 925 }
 926
 927 static int parse_term_uac2_clock_source(struct mixer_build *state,
 928                                         struct usb_audio_term *term,
 929                                         void *p1, int id)
 930 {
 931         struct uac_clock_source_descriptor *d = p1;
 932
 933         term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
 934         term->id = id;
 935         term->name = d->iClockSource;
 936         return 0;
 937 }
 938
 939 static int parse_term_uac3_clock_source(struct mixer_build *state,
 940                                         struct usb_audio_term *term,
 941                                         void *p1, int id)
 942 {
 943         struct uac3_clock_source_descriptor *d = p1;
 944
 945         term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
 946         term->id = id;
 947         term->name = le16_to_cpu(d->wClockSourceStr);
 948         return 0;
 949 }
 950
 951 #define PTYPE(a, b)     ((a) << 8 | (b))
 952
 953 /*
 954  * parse the source unit recursively until it reaches to a terminal
 955  * or a branched unit.
 956  */
 957 static int __check_input_term(struct mixer_build *state, int id,
 958                               struct usb_audio_term *term)
 959 {
 960         int protocol = state->mixer->protocol;
 961         void *p1;
 962         unsigned char *hdr;
 963
 964         for (;;) {
 965                 /* a loop in the terminal chain? */
 966                 if (test_and_set_bit(id, state->termbitmap))
 967                         return -EINVAL;
 968
 969                 p1 = find_audio_control_unit(state, id);
 970                 if (!p1)
 971                         break;
 972                 if (!snd_usb_validate_audio_desc(p1, protocol))
 973                         break; /* bad descriptor */
 974
 975                 hdr = p1;
 976                 term->id = id;
 977
 978                 switch (PTYPE(protocol, hdr[2])) {
 979                 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
 980                 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
 981                 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT): {
 982                         /* the header is the same for all versions */
 983                         struct uac_feature_unit_descriptor *d = p1;
 984
 985                         id = d->bSourceID;
 986                         break; /* continue to parse */
 987                 }
 988                 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
 989                         return parse_term_uac1_iterm_unit(state, term, p1, id);
 990                 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
 991                         return parse_term_uac2_iterm_unit(state, term, p1, id);
 992                 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
 993                         return parse_term_uac3_iterm_unit(state, term, p1, id);
 994                 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
 995                 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
 996                 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
 997                         return parse_term_mixer_unit(state, term, p1, id);
 998                 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
 999                 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
1000                 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
1001                 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
1002                 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
1003                         return parse_term_selector_unit(state, term, p1, id);
1004                 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
1005                 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
1006                 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
1007                         return parse_term_proc_unit(state, term, p1, id,
1008                                                     UAC3_PROCESSING_UNIT);
1009                 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
1010                 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
1011                         return parse_term_effect_unit(state, term, p1, id);
1012                 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
1013                 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
1014                 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
1015                         return parse_term_proc_unit(state, term, p1, id,
1016                                                     UAC3_EXTENSION_UNIT);
1017                 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
1018                         return parse_term_uac2_clock_source(state, term, p1, id);
1019                 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
1020                         return parse_term_uac3_clock_source(state, term, p1, id);
1021                 default:
1022                         return -ENODEV;
1023                 }
1024         }
1025         return -ENODEV;
1026 }
1027
1028
1029 static int check_input_term(struct mixer_build *state, int id,
1030                             struct usb_audio_term *term)
1031 {
1032         memset(term, 0, sizeof(*term));
1033         memset(state->termbitmap, 0, sizeof(state->termbitmap));
1034         return __check_input_term(state, id, term);
1035 }
1036
1037 /*
1038  * Feature Unit
1039  */
1040
1041 /* feature unit control information */
1042 struct usb_feature_control_info {
1043         int control;
1044         const char *name;
1045         int type;       /* data type for uac1 */
1046         int type_uac2;  /* data type for uac2 if different from uac1, else -1 */
1047 };
1048
1049 static const struct usb_feature_control_info audio_feature_info[] = {
1050         { UAC_FU_MUTE,                  "Mute",                 USB_MIXER_INV_BOOLEAN, -1 },
1051         { UAC_FU_VOLUME,                "Volume",               USB_MIXER_S16, -1 },
1052         { UAC_FU_BASS,                  "Tone Control - Bass",  USB_MIXER_S8, -1 },
1053         { UAC_FU_MID,                   "Tone Control - Mid",   USB_MIXER_S8, -1 },
1054         { UAC_FU_TREBLE,                "Tone Control - Treble", USB_MIXER_S8, -1 },
1055         { UAC_FU_GRAPHIC_EQUALIZER,     "Graphic Equalizer",    USB_MIXER_S8, -1 }, /* FIXME: not implemented yet */
1056         { UAC_FU_AUTOMATIC_GAIN,        "Auto Gain Control",    USB_MIXER_BOOLEAN, -1 },
1057         { UAC_FU_DELAY,                 "Delay Control",        USB_MIXER_U16, USB_MIXER_U32 },
1058         { UAC_FU_BASS_BOOST,            "Bass Boost",           USB_MIXER_BOOLEAN, -1 },
1059         { UAC_FU_LOUDNESS,              "Loudness",             USB_MIXER_BOOLEAN, -1 },
1060         /* UAC2 specific */
1061         { UAC2_FU_INPUT_GAIN,           "Input Gain Control",   USB_MIXER_S16, -1 },
1062         { UAC2_FU_INPUT_GAIN_PAD,       "Input Gain Pad Control", USB_MIXER_S16, -1 },
1063         { UAC2_FU_PHASE_INVERTER,        "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
1064 };
1065
1066 static void usb_mixer_elem_info_free(struct usb_mixer_elem_info *cval)
1067 {
1068         kfree(cval);
1069 }
1070
1071 /* private_free callback */
1072 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
1073 {
1074         usb_mixer_elem_info_free(kctl->private_data);
1075         kctl->private_data = NULL;
1076 }
1077
1078 /*
1079  * interface to ALSA control for feature/mixer units
1080  */
1081
1082 /* volume control quirks */
1083 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
1084                                   struct snd_kcontrol *kctl)
1085 {
1086         struct snd_usb_audio *chip = cval->head.mixer->chip;
1087         switch (chip->usb_id) {
1088         case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
1089         case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
1090                 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1091                         cval->min = 0x0000;
1092                         cval->max = 0xffff;
1093                         cval->res = 0x00e6;
1094                         break;
1095                 }
1096                 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1097                     strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1098                         cval->min = 0x00;
1099                         cval->max = 0xff;
1100                         break;
1101                 }
1102                 if (strstr(kctl->id.name, "Effect Return") != NULL) {
1103                         cval->min = 0xb706;
1104                         cval->max = 0xff7b;
1105                         cval->res = 0x0073;
1106                         break;
1107                 }
1108                 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1109                         (strstr(kctl->id.name, "Effect Send") != NULL)) {
1110                         cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
1111                         cval->max = 0xfcfe;
1112                         cval->res = 0x0073;
1113                 }
1114                 break;
1115
1116         case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
1117         case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
1118                 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1119                         usb_audio_info(chip,
1120                                        "set quirk for FTU Effect Duration\n");
1121                         cval->min = 0x0000;
1122                         cval->max = 0x7f00;
1123                         cval->res = 0x0100;
1124                         break;
1125                 }
1126                 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1127                     strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1128                         usb_audio_info(chip,
1129                                        "set quirks for FTU Effect Feedback/Volume\n");
1130                         cval->min = 0x00;
1131                         cval->max = 0x7f;
1132                         break;
1133                 }
1134                 break;
1135
1136         case USB_ID(0x0d8c, 0x0103):
1137                 if (!strcmp(kctl->id.name, "PCM Playback Volume")) {
1138                         usb_audio_info(chip,
1139                                  "set volume quirk for CM102-A+/102S+\n");
1140                         cval->min = -256;
1141                 }
1142                 break;
1143
1144         case USB_ID(0x0471, 0x0101):
1145         case USB_ID(0x0471, 0x0104):
1146         case USB_ID(0x0471, 0x0105):
1147         case USB_ID(0x0672, 0x1041):
1148         /* quirk for UDA1321/N101.
1149          * note that detection between firmware 2.1.1.7 (N101)
1150          * and later 2.1.1.21 is not very clear from datasheets.
1151          * I hope that the min value is -15360 for newer firmware --jk
1152          */
1153                 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
1154                     cval->min == -15616) {
1155                         usb_audio_info(chip,
1156                                  "set volume quirk for UDA1321/N101 chip\n");
1157                         cval->max = -256;
1158                 }
1159                 break;
1160
1161         case USB_ID(0x046d, 0x09a4):
1162                 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1163                         usb_audio_info(chip,
1164                                 "set volume quirk for QuickCam E3500\n");
1165                         cval->min = 6080;
1166                         cval->max = 8768;
1167                         cval->res = 192;
1168                 }
1169                 break;
1170
1171         case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
1172         case USB_ID(0x046d, 0x0808):
1173         case USB_ID(0x046d, 0x0809):
1174         case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1175         case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1176         case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1177         case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1178         case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1179         case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1180         case USB_ID(0x046d, 0x0991):
1181         case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1182         /* Most audio usb devices lie about volume resolution.
1183          * Most Logitech webcams have res = 384.
1184          * Probably there is some logitech magic behind this number --fishor
1185          */
1186                 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1187                         usb_audio_info(chip,
1188                                 "set resolution quirk: cval->res = 384\n");
1189                         cval->res = 384;
1190                 }
1191                 break;
1192         case USB_ID(0x0495, 0x3042): /* ESS Technology Asus USB DAC */
1193                 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1194                         strstr(kctl->id.name, "Capture Volume") != NULL) {
1195                         cval->min >>= 8;
1196                         cval->max = 0;
1197                         cval->res = 1;
1198                 }
1199                 break;
1200         case USB_ID(0x1224, 0x2a25): /* Jieli Technology USB PHY 2.0 */
1201                 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1202                         usb_audio_info(chip,
1203                                 "set resolution quirk: cval->res = 16\n");
1204                         cval->res = 16;
1205                 }
1206                 break;
1207         }
1208 }
1209
1210 /* forcibly initialize the current mixer value; if GET_CUR fails, set to
1211  * the minimum as default
1212  */
1213 static void init_cur_mix_raw(struct usb_mixer_elem_info *cval, int ch, int idx)
1214 {
1215         int val, err;
1216
1217         err = snd_usb_get_cur_mix_value(cval, ch, idx, &val);
1218         if (!err)
1219                 return;
1220         if (!cval->head.mixer->ignore_ctl_error)
1221                 usb_audio_warn(cval->head.mixer->chip,
1222                                "%d:%d: failed to get current value for ch %d (%d)\n",
1223                                cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1224                                ch, err);
1225         snd_usb_set_cur_mix_value(cval, ch, idx, cval->min);
1226 }
1227
1228 /*
1229  * retrieve the minimum and maximum values for the specified control
1230  */
1231 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1232                                    int default_min, struct snd_kcontrol *kctl)
1233 {
1234         int i, idx;
1235
1236         /* for failsafe */
1237         cval->min = default_min;
1238         cval->max = cval->min + 1;
1239         cval->res = 1;
1240         cval->dBmin = cval->dBmax = 0;
1241
1242         if (cval->val_type == USB_MIXER_BOOLEAN ||
1243             cval->val_type == USB_MIXER_INV_BOOLEAN) {
1244                 cval->initialized = 1;
1245         } else {
1246                 int minchn = 0;
1247                 if (cval->cmask) {
1248                         for (i = 0; i < MAX_CHANNELS; i++)
1249                                 if (cval->cmask & (1 << i)) {
1250                                         minchn = i + 1;
1251                                         break;
1252                                 }
1253                 }
1254                 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
1255                     get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1256                         usb_audio_err(cval->head.mixer->chip,
1257                                       "%d:%d: cannot get min/max values for control %d (id %d)\n",
1258                                    cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1259                                                                cval->control, cval->head.id);
1260                         return -EINVAL;
1261                 }
1262                 if (get_ctl_value(cval, UAC_GET_RES,
1263                                   (cval->control << 8) | minchn,
1264                                   &cval->res) < 0) {
1265                         cval->res = 1;
1266                 } else if (cval->head.mixer->protocol == UAC_VERSION_1) {
1267                         int last_valid_res = cval->res;
1268
1269                         while (cval->res > 1) {
1270                                 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1271                                                                 (cval->control << 8) | minchn,
1272                                                                 cval->res / 2) < 0)
1273                                         break;
1274                                 cval->res /= 2;
1275                         }
1276                         if (get_ctl_value(cval, UAC_GET_RES,
1277                                           (cval->control << 8) | minchn, &cval->res) < 0)
1278                                 cval->res = last_valid_res;
1279                 }
1280                 if (cval->res == 0)
1281                         cval->res = 1;
1282
1283                 /* Additional checks for the proper resolution
1284                  *
1285                  * Some devices report smaller resolutions than actually
1286                  * reacting.  They don't return errors but simply clip
1287                  * to the lower aligned value.
1288                  */
1289                 if (cval->min + cval->res < cval->max) {
1290                         int last_valid_res = cval->res;
1291                         int saved, test, check;
1292                         if (get_cur_mix_raw(cval, minchn, &saved) < 0)
1293                                 goto no_res_check;
1294                         for (;;) {
1295                                 test = saved;
1296                                 if (test < cval->max)
1297                                         test += cval->res;
1298                                 else
1299                                         test -= cval->res;
1300                                 if (test < cval->min || test > cval->max ||
1301                                     snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1302                                     get_cur_mix_raw(cval, minchn, &check)) {
1303                                         cval->res = last_valid_res;
1304                                         break;
1305                                 }
1306                                 if (test == check)
1307                                         break;
1308                                 cval->res *= 2;
1309                         }
1310                         snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1311                 }
1312
1313 no_res_check:
1314                 cval->initialized = 1;
1315         }
1316
1317         if (kctl)
1318                 volume_control_quirks(cval, kctl);
1319
1320         /* USB descriptions contain the dB scale in 1/256 dB unit
1321          * while ALSA TLV contains in 1/100 dB unit
1322          */
1323         cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1324         cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1325         if (cval->dBmin > cval->dBmax) {
1326                 /* something is wrong; assume it's either from/to 0dB */
1327                 if (cval->dBmin < 0)
1328                         cval->dBmax = 0;
1329                 else if (cval->dBmin > 0)
1330                         cval->dBmin = 0;
1331                 if (cval->dBmin > cval->dBmax) {
1332                         /* totally crap, return an error */
1333                         return -EINVAL;
1334                 }
1335         } else {
1336                 /* if the max volume is too low, it's likely a bogus range;
1337                  * here we use -96dB as the threshold
1338                  */
1339                 if (cval->dBmax <= -9600) {
1340                         usb_audio_info(cval->head.mixer->chip,
1341                                        "%d:%d: bogus dB values (%d/%d), disabling dB reporting\n",
1342                                        cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1343                                        cval->dBmin, cval->dBmax);
1344                         cval->dBmin = cval->dBmax = 0;
1345                 }
1346         }
1347
1348         /* initialize all elements */
1349         if (!cval->cmask) {
1350                 init_cur_mix_raw(cval, 0, 0);
1351         } else {
1352                 idx = 0;
1353                 for (i = 0; i < MAX_CHANNELS; i++) {
1354                         if (cval->cmask & (1 << i)) {
1355                                 init_cur_mix_raw(cval, i + 1, idx);
1356                                 idx++;
1357                         }
1358                 }
1359         }
1360
1361         return 0;
1362 }
1363
1364 #define get_min_max(cval, def)  get_min_max_with_quirks(cval, def, NULL)
1365
1366 /* get a feature/mixer unit info */
1367 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1368                                   struct snd_ctl_elem_info *uinfo)
1369 {
1370         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1371
1372         if (cval->val_type == USB_MIXER_BOOLEAN ||
1373             cval->val_type == USB_MIXER_INV_BOOLEAN)
1374                 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1375         else
1376                 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1377         uinfo->count = cval->channels;
1378         if (cval->val_type == USB_MIXER_BOOLEAN ||
1379             cval->val_type == USB_MIXER_INV_BOOLEAN) {
1380                 uinfo->value.integer.min = 0;
1381                 uinfo->value.integer.max = 1;
1382         } else {
1383                 if (!cval->initialized) {
1384                         get_min_max_with_quirks(cval, 0, kcontrol);
1385                         if (cval->initialized && cval->dBmin >= cval->dBmax) {
1386                                 kcontrol->vd[0].access &=
1387                                         ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1388                                           SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1389                                 snd_ctl_notify(cval->head.mixer->chip->card,
1390                                                SNDRV_CTL_EVENT_MASK_INFO,
1391                                                &kcontrol->id);
1392                         }
1393                 }
1394                 uinfo->value.integer.min = 0;
1395                 uinfo->value.integer.max =
1396                         DIV_ROUND_UP(cval->max - cval->min, cval->res);
1397         }
1398         return 0;
1399 }
1400
1401 /* get the current value from feature/mixer unit */
1402 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1403                                  struct snd_ctl_elem_value *ucontrol)
1404 {
1405         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1406         int c, cnt, val, err;
1407
1408         ucontrol->value.integer.value[0] = cval->min;
1409         if (cval->cmask) {
1410                 cnt = 0;
1411                 for (c = 0; c < MAX_CHANNELS; c++) {
1412                         if (!(cval->cmask & (1 << c)))
1413                                 continue;
1414                         err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1415                         if (err < 0)
1416                                 return filter_error(cval, err);
1417                         val = get_relative_value(cval, val);
1418                         ucontrol->value.integer.value[cnt] = val;
1419                         cnt++;
1420                 }
1421                 return 0;
1422         } else {
1423                 /* master channel */
1424                 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1425                 if (err < 0)
1426                         return filter_error(cval, err);
1427                 val = get_relative_value(cval, val);
1428                 ucontrol->value.integer.value[0] = val;
1429         }
1430         return 0;
1431 }
1432
1433 /* put the current value to feature/mixer unit */
1434 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1435                                  struct snd_ctl_elem_value *ucontrol)
1436 {
1437         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1438         int c, cnt, val, oval, err;
1439         int changed = 0;
1440
1441         if (cval->cmask) {
1442                 cnt = 0;
1443                 for (c = 0; c < MAX_CHANNELS; c++) {
1444                         if (!(cval->cmask & (1 << c)))
1445                                 continue;
1446                         err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1447                         if (err < 0)
1448                                 return filter_error(cval, err);
1449                         val = ucontrol->value.integer.value[cnt];
1450                         val = get_abs_value(cval, val);
1451                         if (oval != val) {
1452                                 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1453                                 changed = 1;
1454                         }
1455                         cnt++;
1456                 }
1457         } else {
1458                 /* master channel */
1459                 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1460                 if (err < 0)
1461                         return filter_error(cval, err);
1462                 val = ucontrol->value.integer.value[0];
1463                 val = get_abs_value(cval, val);
1464                 if (val != oval) {
1465                         snd_usb_set_cur_mix_value(cval, 0, 0, val);
1466                         changed = 1;
1467                 }
1468         }
1469         return changed;
1470 }
1471
1472 /* get the boolean value from the master channel of a UAC control */
1473 static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
1474                                      struct snd_ctl_elem_value *ucontrol)
1475 {
1476         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1477         int val, err;
1478
1479         err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1480         if (err < 0)
1481                 return filter_error(cval, err);
1482         val = (val != 0);
1483         ucontrol->value.integer.value[0] = val;
1484         return 0;
1485 }
1486
1487 static int get_connector_value(struct usb_mixer_elem_info *cval,
1488                                char *name, int *val)
1489 {
1490         struct snd_usb_audio *chip = cval->head.mixer->chip;
1491         int idx = 0, validx, ret;
1492
1493         validx = cval->control << 8 | 0;
1494
1495         ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
1496         if (ret)
1497                 goto error;
1498
1499         idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
1500         if (cval->head.mixer->protocol == UAC_VERSION_2) {
1501                 struct uac2_connectors_ctl_blk uac2_conn;
1502
1503                 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1504                                       USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1505                                       validx, idx, &uac2_conn, sizeof(uac2_conn));
1506                 if (val)
1507                         *val = !!uac2_conn.bNrChannels;
1508         } else { /* UAC_VERSION_3 */
1509                 struct uac3_insertion_ctl_blk uac3_conn;
1510
1511                 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1512                                       USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1513                                       validx, idx, &uac3_conn, sizeof(uac3_conn));
1514                 if (val)
1515                         *val = !!uac3_conn.bmConInserted;
1516         }
1517
1518         snd_usb_unlock_shutdown(chip);
1519
1520         if (ret < 0) {
1521                 if (name && strstr(name, "Speaker")) {
1522                         if (val)
1523                                 *val = 1;
1524                         return 0;
1525                 }
1526 error:
1527                 usb_audio_err(chip,
1528                         "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1529                         UAC_GET_CUR, validx, idx, cval->val_type);
1530                 return filter_error(cval, ret);
1531         }
1532
1533         return ret;
1534 }
1535
1536 /* get the connectors status and report it as boolean type */
1537 static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol,
1538                                    struct snd_ctl_elem_value *ucontrol)
1539 {
1540         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1541         int ret, val;
1542
1543         ret = get_connector_value(cval, kcontrol->id.name, &val);
1544
1545         if (ret < 0)
1546                 return ret;
1547
1548         ucontrol->value.integer.value[0] = val;
1549         return 0;
1550 }
1551
1552 static const struct snd_kcontrol_new usb_feature_unit_ctl = {
1553         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1554         .name = "", /* will be filled later manually */
1555         .info = mixer_ctl_feature_info,
1556         .get = mixer_ctl_feature_get,
1557         .put = mixer_ctl_feature_put,
1558 };
1559
1560 /* the read-only variant */
1561 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1562         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1563         .name = "", /* will be filled later manually */
1564         .info = mixer_ctl_feature_info,
1565         .get = mixer_ctl_feature_get,
1566         .put = NULL,
1567 };
1568
1569 /*
1570  * A control which shows the boolean value from reading a UAC control on
1571  * the master channel.
1572  */
1573 static const struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1574         .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1575         .name = "", /* will be filled later manually */
1576         .access = SNDRV_CTL_ELEM_ACCESS_READ,
1577         .info = snd_ctl_boolean_mono_info,
1578         .get = mixer_ctl_master_bool_get,
1579         .put = NULL,
1580 };
1581
1582 static const struct snd_kcontrol_new usb_connector_ctl_ro = {
1583         .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1584         .name = "", /* will be filled later manually */
1585         .access = SNDRV_CTL_ELEM_ACCESS_READ,
1586         .info = snd_ctl_boolean_mono_info,
1587         .get = mixer_ctl_connector_get,
1588         .put = NULL,
1589 };
1590
1591 /*
1592  * This symbol is exported in order to allow the mixer quirks to
1593  * hook up to the standard feature unit control mechanism
1594  */
1595 const struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1596
1597 /*
1598  * build a feature control
1599  */
1600 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1601 {
1602         return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1603 }
1604
1605 /*
1606  * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1607  * rename it to "Headphone". We determine if something is a headphone
1608  * similar to how udev determines form factor.
1609  */
1610 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1611                                         struct snd_card *card)
1612 {
1613         static const char * const names_to_check[] = {
1614                 "Headset", "headset", "Headphone", "headphone", NULL};
1615         const char * const *s;
1616         bool found = false;
1617
1618         if (strcmp("Speaker", kctl->id.name))
1619                 return;
1620
1621         for (s = names_to_check; *s; s++)
1622                 if (strstr(card->shortname, *s)) {
1623                         found = true;
1624                         break;
1625                 }
1626
1627         if (!found)
1628                 return;
1629
1630         strscpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1631 }
1632
1633 static const struct usb_feature_control_info *get_feature_control_info(int control)
1634 {
1635         int i;
1636
1637         for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1638                 if (audio_feature_info[i].control == control)
1639                         return &audio_feature_info[i];
1640         }
1641         return NULL;
1642 }
1643
1644 static void __build_feature_ctl(struct usb_mixer_interface *mixer,
1645                                 const struct usbmix_name_map *imap,
1646                                 unsigned int ctl_mask, int control,
1647                                 struct usb_audio_term *iterm,
1648                                 struct usb_audio_term *oterm,
1649                                 int unitid, int nameid, int readonly_mask)
1650 {
1651         const struct usb_feature_control_info *ctl_info;
1652         unsigned int len = 0;
1653         int mapped_name = 0;
1654         struct snd_kcontrol *kctl;
1655         struct usb_mixer_elem_info *cval;
1656         const struct usbmix_name_map *map;
1657         unsigned int range;
1658
1659         if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1660                 /* FIXME: not supported yet */
1661                 return;
1662         }
1663
1664         map = find_map(imap, unitid, control);
1665         if (check_ignored_ctl(map))
1666                 return;
1667
1668         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1669         if (!cval)
1670                 return;
1671         snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
1672         cval->control = control;
1673         cval->cmask = ctl_mask;
1674
1675         ctl_info = get_feature_control_info(control);
1676         if (!ctl_info) {
1677                 usb_mixer_elem_info_free(cval);
1678                 return;
1679         }
1680         if (mixer->protocol == UAC_VERSION_1)
1681                 cval->val_type = ctl_info->type;
1682         else /* UAC_VERSION_2 */
1683                 cval->val_type = ctl_info->type_uac2 >= 0 ?
1684                         ctl_info->type_uac2 : ctl_info->type;
1685
1686         if (ctl_mask == 0) {
1687                 cval->channels = 1;     /* master channel */
1688                 cval->master_readonly = readonly_mask;
1689         } else {
1690                 int i, c = 0;
1691                 for (i = 0; i < 16; i++)
1692                         if (ctl_mask & (1 << i))
1693                                 c++;
1694                 cval->channels = c;
1695                 cval->ch_readonly = readonly_mask;
1696         }
1697
1698         /*
1699          * If all channels in the mask are marked read-only, make the control
1700          * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1701          * issue write commands to read-only channels.
1702          */
1703         if (cval->channels == readonly_mask)
1704                 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1705         else
1706                 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1707
1708         if (!kctl) {
1709                 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1710                 usb_mixer_elem_info_free(cval);
1711                 return;
1712         }
1713         kctl->private_free = snd_usb_mixer_elem_free;
1714
1715         len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1716         mapped_name = len != 0;
1717         if (!len && nameid)
1718                 len = snd_usb_copy_string_desc(mixer->chip, nameid,
1719                                 kctl->id.name, sizeof(kctl->id.name));
1720
1721         switch (control) {
1722         case UAC_FU_MUTE:
1723         case UAC_FU_VOLUME:
1724                 /*
1725                  * determine the control name.  the rule is:
1726                  * - if a name id is given in descriptor, use it.
1727                  * - if the connected input can be determined, then use the name
1728                  *   of terminal type.
1729                  * - if the connected output can be determined, use it.
1730                  * - otherwise, anonymous name.
1731                  */
1732                 if (!len) {
1733                         if (iterm)
1734                                 len = get_term_name(mixer->chip, iterm,
1735                                                     kctl->id.name,
1736                                                     sizeof(kctl->id.name), 1);
1737                         if (!len && oterm)
1738                                 len = get_term_name(mixer->chip, oterm,
1739                                                     kctl->id.name,
1740                                                     sizeof(kctl->id.name), 1);
1741                         if (!len)
1742                                 snprintf(kctl->id.name, sizeof(kctl->id.name),
1743                                          "Feature %d", unitid);
1744                 }
1745
1746                 if (!mapped_name)
1747                         check_no_speaker_on_headset(kctl, mixer->chip->card);
1748
1749                 /*
1750                  * determine the stream direction:
1751                  * if the connected output is USB stream, then it's likely a
1752                  * capture stream.  otherwise it should be playback (hopefully :)
1753                  */
1754                 if (!mapped_name && oterm && !(oterm->type >> 16)) {
1755                         if ((oterm->type & 0xff00) == 0x0100)
1756                                 append_ctl_name(kctl, " Capture");
1757                         else
1758                                 append_ctl_name(kctl, " Playback");
1759                 }
1760                 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1761                                 " Switch" : " Volume");
1762                 break;
1763         default:
1764                 if (!len)
1765                         strscpy(kctl->id.name, audio_feature_info[control-1].name,
1766                                 sizeof(kctl->id.name));
1767                 break;
1768         }
1769
1770         /* get min/max values */
1771         get_min_max_with_quirks(cval, 0, kctl);
1772
1773         /* skip a bogus volume range */
1774         if (cval->max <= cval->min) {
1775                 usb_audio_dbg(mixer->chip,
1776                               "[%d] FU [%s] skipped due to invalid volume\n",
1777                               cval->head.id, kctl->id.name);
1778                 snd_ctl_free_one(kctl);
1779                 return;
1780         }
1781
1782
1783         if (control == UAC_FU_VOLUME) {
1784                 check_mapped_dB(map, cval);
1785                 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1786                         kctl->tlv.c = snd_usb_mixer_vol_tlv;
1787                         kctl->vd[0].access |=
1788                                 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1789                                 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1790                 }
1791         }
1792
1793         snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1794
1795         range = (cval->max - cval->min) / cval->res;
1796         /*
1797          * Are there devices with volume range more than 255? I use a bit more
1798          * to be sure. 384 is a resolution magic number found on Logitech
1799          * devices. It will definitively catch all buggy Logitech devices.
1800          */
1801         if (range > 384) {
1802                 usb_audio_warn(mixer->chip,
1803                                "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1804                                range);
1805                 usb_audio_warn(mixer->chip,
1806                                "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1807                                cval->head.id, kctl->id.name, cval->channels,
1808                                cval->min, cval->max, cval->res);
1809         }
1810
1811         usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1812                       cval->head.id, kctl->id.name, cval->channels,
1813                       cval->min, cval->max, cval->res);
1814         snd_usb_mixer_add_control(&cval->head, kctl);
1815 }
1816
1817 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1818                               unsigned int ctl_mask, int control,
1819                               struct usb_audio_term *iterm, int unitid,
1820                               int readonly_mask)
1821 {
1822         struct uac_feature_unit_descriptor *desc = raw_desc;
1823         int nameid = uac_feature_unit_iFeature(desc);
1824
1825         __build_feature_ctl(state->mixer, state->map, ctl_mask, control,
1826                         iterm, &state->oterm, unitid, nameid, readonly_mask);
1827 }
1828
1829 static void build_feature_ctl_badd(struct usb_mixer_interface *mixer,
1830                               unsigned int ctl_mask, int control, int unitid,
1831                               const struct usbmix_name_map *badd_map)
1832 {
1833         __build_feature_ctl(mixer, badd_map, ctl_mask, control,
1834                         NULL, NULL, unitid, 0, 0);
1835 }
1836
1837 static void get_connector_control_name(struct usb_mixer_interface *mixer,
1838                                        struct usb_audio_term *term,
1839                                        bool is_input, char *name, int name_size)
1840 {
1841         int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1842
1843         if (name_len == 0)
1844                 strscpy(name, "Unknown", name_size);
1845
1846         /*
1847          *  sound/core/ctljack.c has a convention of naming jack controls
1848          * by ending in " Jack".  Make it slightly more useful by
1849          * indicating Input or Output after the terminal name.
1850          */
1851         if (is_input)
1852                 strlcat(name, " - Input Jack", name_size);
1853         else
1854                 strlcat(name, " - Output Jack", name_size);
1855 }
1856
1857 /* get connector value to "wake up" the USB audio */
1858 static int connector_mixer_resume(struct usb_mixer_elem_list *list)
1859 {
1860         struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
1861
1862         get_connector_value(cval, NULL, NULL);
1863         return 0;
1864 }
1865
1866 /* Build a mixer control for a UAC connector control (jack-detect) */
1867 static void build_connector_control(struct usb_mixer_interface *mixer,
1868                                     const struct usbmix_name_map *imap,
1869                                     struct usb_audio_term *term, bool is_input)
1870 {
1871         struct snd_kcontrol *kctl;
1872         struct usb_mixer_elem_info *cval;
1873         const struct usbmix_name_map *map;
1874
1875         map = find_map(imap, term->id, 0);
1876         if (check_ignored_ctl(map))
1877                 return;
1878
1879         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1880         if (!cval)
1881                 return;
1882         snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1883
1884         /* set up a specific resume callback */
1885         cval->head.resume = connector_mixer_resume;
1886
1887         /*
1888          * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1889          * number of channels connected.
1890          *
1891          * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1892          * following byte(s) specifies which connectors are inserted.
1893          *
1894          * This boolean ctl will simply report if any channels are connected
1895          * or not.
1896          */
1897         if (mixer->protocol == UAC_VERSION_2)
1898                 cval->control = UAC2_TE_CONNECTOR;
1899         else /* UAC_VERSION_3 */
1900                 cval->control = UAC3_TE_INSERTION;
1901
1902         cval->val_type = USB_MIXER_BOOLEAN;
1903         cval->channels = 1; /* report true if any channel is connected */
1904         cval->min = 0;
1905         cval->max = 1;
1906         kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1907         if (!kctl) {
1908                 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1909                 usb_mixer_elem_info_free(cval);
1910                 return;
1911         }
1912
1913         if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)))
1914                 strlcat(kctl->id.name, " Jack", sizeof(kctl->id.name));
1915         else
1916                 get_connector_control_name(mixer, term, is_input, kctl->id.name,
1917                                            sizeof(kctl->id.name));
1918         kctl->private_free = snd_usb_mixer_elem_free;
1919         snd_usb_mixer_add_control(&cval->head, kctl);
1920 }
1921
1922 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1923                                    void *_ftr)
1924 {
1925         struct uac_clock_source_descriptor *hdr = _ftr;
1926         struct usb_mixer_elem_info *cval;
1927         struct snd_kcontrol *kctl;
1928         char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1929         int ret;
1930
1931         if (state->mixer->protocol != UAC_VERSION_2)
1932                 return -EINVAL;
1933
1934         /*
1935          * The only property of this unit we are interested in is the
1936          * clock source validity. If that isn't readable, just bail out.
1937          */
1938         if (!uac_v2v3_control_is_readable(hdr->bmControls,
1939                                       UAC2_CS_CONTROL_CLOCK_VALID))
1940                 return 0;
1941
1942         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1943         if (!cval)
1944                 return -ENOMEM;
1945
1946         snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1947
1948         cval->min = 0;
1949         cval->max = 1;
1950         cval->channels = 1;
1951         cval->val_type = USB_MIXER_BOOLEAN;
1952         cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1953
1954         cval->master_readonly = 1;
1955         /* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1956         kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1957
1958         if (!kctl) {
1959                 usb_mixer_elem_info_free(cval);
1960                 return -ENOMEM;
1961         }
1962
1963         kctl->private_free = snd_usb_mixer_elem_free;
1964         ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1965                                        name, sizeof(name));
1966         if (ret > 0)
1967                 snprintf(kctl->id.name, sizeof(kctl->id.name),
1968                          "%s Validity", name);
1969         else
1970                 snprintf(kctl->id.name, sizeof(kctl->id.name),
1971                          "Clock Source %d Validity", hdr->bClockID);
1972
1973         return snd_usb_mixer_add_control(&cval->head, kctl);
1974 }
1975
1976 /*
1977  * parse a feature unit
1978  *
1979  * most of controls are defined here.
1980  */
1981 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1982                                     void *_ftr)
1983 {
1984         int channels, i, j;
1985         struct usb_audio_term iterm;
1986         unsigned int master_bits;
1987         int err, csize;
1988         struct uac_feature_unit_descriptor *hdr = _ftr;
1989         __u8 *bmaControls;
1990
1991         if (state->mixer->protocol == UAC_VERSION_1) {
1992                 csize = hdr->bControlSize;
1993                 channels = (hdr->bLength - 7) / csize - 1;
1994                 bmaControls = hdr->bmaControls;
1995         } else if (state->mixer->protocol == UAC_VERSION_2) {
1996                 struct uac2_feature_unit_descriptor *ftr = _ftr;
1997                 csize = 4;
1998                 channels = (hdr->bLength - 6) / 4 - 1;
1999                 bmaControls = ftr->bmaControls;
2000         } else { /* UAC_VERSION_3 */
2001                 struct uac3_feature_unit_descriptor *ftr = _ftr;
2002
2003                 csize = 4;
2004                 channels = (ftr->bLength - 7) / 4 - 1;
2005                 bmaControls = ftr->bmaControls;
2006         }
2007
2008         /* parse the source unit */
2009         err = parse_audio_unit(state, hdr->bSourceID);
2010         if (err < 0)
2011                 return err;
2012
2013         /* determine the input source type and name */
2014         err = check_input_term(state, hdr->bSourceID, &iterm);
2015         if (err < 0)
2016                 return err;
2017
2018         master_bits = snd_usb_combine_bytes(bmaControls, csize);
2019         /* master configuration quirks */
2020         switch (state->chip->usb_id) {
2021         case USB_ID(0x08bb, 0x2702):
2022                 usb_audio_info(state->chip,
2023                                "usbmixer: master volume quirk for PCM2702 chip\n");
2024                 /* disable non-functional volume control */
2025                 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
2026                 break;
2027         case USB_ID(0x1130, 0xf211):
2028                 usb_audio_info(state->chip,
2029                                "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
2030                 /* disable non-functional volume control */
2031                 channels = 0;
2032                 break;
2033
2034         }
2035
2036         if (state->mixer->protocol == UAC_VERSION_1) {
2037                 /* check all control types */
2038                 for (i = 0; i < 10; i++) {
2039                         unsigned int ch_bits = 0;
2040                         int control = audio_feature_info[i].control;
2041
2042                         for (j = 0; j < channels; j++) {
2043                                 unsigned int mask;
2044
2045                                 mask = snd_usb_combine_bytes(bmaControls +
2046                                                              csize * (j+1), csize);
2047                                 if (mask & (1 << i))
2048                                         ch_bits |= (1 << j);
2049                         }
2050                         /* audio class v1 controls are never read-only */
2051
2052                         /*
2053                          * The first channel must be set
2054                          * (for ease of programming).
2055                          */
2056                         if (ch_bits & 1)
2057                                 build_feature_ctl(state, _ftr, ch_bits, control,
2058                                                   &iterm, unitid, 0);
2059                         if (master_bits & (1 << i))
2060                                 build_feature_ctl(state, _ftr, 0, control,
2061                                                   &iterm, unitid, 0);
2062                 }
2063         } else { /* UAC_VERSION_2/3 */
2064                 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
2065                         unsigned int ch_bits = 0;
2066                         unsigned int ch_read_only = 0;
2067                         int control = audio_feature_info[i].control;
2068
2069                         for (j = 0; j < channels; j++) {
2070                                 unsigned int mask;
2071
2072                                 mask = snd_usb_combine_bytes(bmaControls +
2073                                                              csize * (j+1), csize);
2074                                 if (uac_v2v3_control_is_readable(mask, control)) {
2075                                         ch_bits |= (1 << j);
2076                                         if (!uac_v2v3_control_is_writeable(mask, control))
2077                                                 ch_read_only |= (1 << j);
2078                                 }
2079                         }
2080
2081                         /*
2082                          * NOTE: build_feature_ctl() will mark the control
2083                          * read-only if all channels are marked read-only in
2084                          * the descriptors. Otherwise, the control will be
2085                          * reported as writeable, but the driver will not
2086                          * actually issue a write command for read-only
2087                          * channels.
2088                          */
2089
2090                         /*
2091                          * The first channel must be set
2092                          * (for ease of programming).
2093                          */
2094                         if (ch_bits & 1)
2095                                 build_feature_ctl(state, _ftr, ch_bits, control,
2096                                                   &iterm, unitid, ch_read_only);
2097                         if (uac_v2v3_control_is_readable(master_bits, control))
2098                                 build_feature_ctl(state, _ftr, 0, control,
2099                                                   &iterm, unitid,
2100                                                   !uac_v2v3_control_is_writeable(master_bits,
2101                                                                                  control));
2102                 }
2103         }
2104
2105         return 0;
2106 }
2107
2108 /*
2109  * Mixer Unit
2110  */
2111
2112 /* check whether the given in/out overflows bmMixerControls matrix */
2113 static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc,
2114                                   int protocol, int num_ins, int num_outs)
2115 {
2116         u8 *hdr = (u8 *)desc;
2117         u8 *c = uac_mixer_unit_bmControls(desc, protocol);
2118         size_t rest; /* remaining bytes after bmMixerControls */
2119
2120         switch (protocol) {
2121         case UAC_VERSION_1:
2122         default:
2123                 rest = 1; /* iMixer */
2124                 break;
2125         case UAC_VERSION_2:
2126                 rest = 2; /* bmControls + iMixer */
2127                 break;
2128         case UAC_VERSION_3:
2129                 rest = 6; /* bmControls + wMixerDescrStr */
2130                 break;
2131         }
2132
2133         /* overflow? */
2134         return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
2135 }
2136
2137 /*
2138  * build a mixer unit control
2139  *
2140  * the callbacks are identical with feature unit.
2141  * input channel number (zero based) is given in control field instead.
2142  */
2143 static void build_mixer_unit_ctl(struct mixer_build *state,
2144                                  struct uac_mixer_unit_descriptor *desc,
2145                                  int in_pin, int in_ch, int num_outs,
2146                                  int unitid, struct usb_audio_term *iterm)
2147 {
2148         struct usb_mixer_elem_info *cval;
2149         unsigned int i, len;
2150         struct snd_kcontrol *kctl;
2151         const struct usbmix_name_map *map;
2152
2153         map = find_map(state->map, unitid, 0);
2154         if (check_ignored_ctl(map))
2155                 return;
2156
2157         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2158         if (!cval)
2159                 return;
2160
2161         snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2162         cval->control = in_ch + 1; /* based on 1 */
2163         cval->val_type = USB_MIXER_S16;
2164         for (i = 0; i < num_outs; i++) {
2165                 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
2166
2167                 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
2168                         cval->cmask |= (1 << i);
2169                         cval->channels++;
2170                 }
2171         }
2172
2173         /* get min/max values */
2174         get_min_max(cval, 0);
2175
2176         kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2177         if (!kctl) {
2178                 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2179                 usb_mixer_elem_info_free(cval);
2180                 return;
2181         }
2182         kctl->private_free = snd_usb_mixer_elem_free;
2183
2184         len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2185         if (!len)
2186                 len = get_term_name(state->chip, iterm, kctl->id.name,
2187                                     sizeof(kctl->id.name), 0);
2188         if (!len)
2189                 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
2190         append_ctl_name(kctl, " Volume");
2191
2192         usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2193                     cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
2194         snd_usb_mixer_add_control(&cval->head, kctl);
2195 }
2196
2197 static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
2198                                       void *raw_desc)
2199 {
2200         struct usb_audio_term iterm;
2201         unsigned int control, bmctls, term_id;
2202
2203         if (state->mixer->protocol == UAC_VERSION_2) {
2204                 struct uac2_input_terminal_descriptor *d_v2 = raw_desc;
2205                 control = UAC2_TE_CONNECTOR;
2206                 term_id = d_v2->bTerminalID;
2207                 bmctls = le16_to_cpu(d_v2->bmControls);
2208         } else if (state->mixer->protocol == UAC_VERSION_3) {
2209                 struct uac3_input_terminal_descriptor *d_v3 = raw_desc;
2210                 control = UAC3_TE_INSERTION;
2211                 term_id = d_v3->bTerminalID;
2212                 bmctls = le32_to_cpu(d_v3->bmControls);
2213         } else {
2214                 return 0; /* UAC1. No Insertion control */
2215         }
2216
2217         check_input_term(state, term_id, &iterm);
2218
2219         /* Check for jack detection. */
2220         if ((iterm.type & 0xff00) != 0x0100 &&
2221             uac_v2v3_control_is_readable(bmctls, control))
2222                 build_connector_control(state->mixer, state->map, &iterm, true);
2223
2224         return 0;
2225 }
2226
2227 /*
2228  * parse a mixer unit
2229  */
2230 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
2231                                   void *raw_desc)
2232 {
2233         struct uac_mixer_unit_descriptor *desc = raw_desc;
2234         struct usb_audio_term iterm;
2235         int input_pins, num_ins, num_outs;
2236         int pin, ich, err;
2237
2238         err = uac_mixer_unit_get_channels(state, desc);
2239         if (err < 0) {
2240                 usb_audio_err(state->chip,
2241                               "invalid MIXER UNIT descriptor %d\n",
2242                               unitid);
2243                 return err;
2244         }
2245
2246         num_outs = err;
2247         input_pins = desc->bNrInPins;
2248
2249         num_ins = 0;
2250         ich = 0;
2251         for (pin = 0; pin < input_pins; pin++) {
2252                 err = parse_audio_unit(state, desc->baSourceID[pin]);
2253                 if (err < 0)
2254                         continue;
2255                 /* no bmControls field (e.g. Maya44) -> ignore */
2256                 if (!num_outs)
2257                         continue;
2258                 err = check_input_term(state, desc->baSourceID[pin], &iterm);
2259                 if (err < 0)
2260                         return err;
2261                 num_ins += iterm.channels;
2262                 if (mixer_bitmap_overflow(desc, state->mixer->protocol,
2263                                           num_ins, num_outs))
2264                         break;
2265                 for (; ich < num_ins; ich++) {
2266                         int och, ich_has_controls = 0;
2267
2268                         for (och = 0; och < num_outs; och++) {
2269                                 __u8 *c = uac_mixer_unit_bmControls(desc,
2270                                                 state->mixer->protocol);
2271
2272                                 if (check_matrix_bitmap(c, ich, och, num_outs)) {
2273                                         ich_has_controls = 1;
2274                                         break;
2275                                 }
2276                         }
2277                         if (ich_has_controls)
2278                                 build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
2279                                                      unitid, &iterm);
2280                 }
2281         }
2282         return 0;
2283 }
2284
2285 /*
2286  * Processing Unit / Extension Unit
2287  */
2288
2289 /* get callback for processing/extension unit */
2290 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
2291                                   struct snd_ctl_elem_value *ucontrol)
2292 {
2293         struct usb_mixer_elem_info *cval = kcontrol->private_data;
2294         int err, val;
2295
2296         err = get_cur_ctl_value(cval, cval->control << 8, &val);
2297         if (err < 0) {
2298                 ucontrol->value.integer.value[0] = cval->min;
2299                 return filter_error(cval, err);
2300         }
2301         val = get_relative_value(cval, val);
2302         ucontrol->value.integer.value[0] = val;
2303         return 0;
2304 }
2305
2306 /* put callback for processing/extension unit */
2307 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
2308                                   struct snd_ctl_elem_value *ucontrol)
2309 {
2310         struct usb_mixer_elem_info *cval = kcontrol->private_data;
2311         int val, oval, err;
2312
2313         err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2314         if (err < 0)
2315                 return filter_error(cval, err);
2316         val = ucontrol->value.integer.value[0];
2317         val = get_abs_value(cval, val);
2318         if (val != oval) {
2319                 set_cur_ctl_value(cval, cval->control << 8, val);
2320                 return 1;
2321         }
2322         return 0;
2323 }
2324
2325 /* alsa control interface for processing/extension unit */
2326 static const struct snd_kcontrol_new mixer_procunit_ctl = {
2327         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2328         .name = "", /* will be filled later */
2329         .info = mixer_ctl_feature_info,
2330         .get = mixer_ctl_procunit_get,
2331         .put = mixer_ctl_procunit_put,
2332 };
2333
2334 /*
2335  * predefined data for processing units
2336  */
2337 struct procunit_value_info {
2338         int control;
2339         const char *suffix;
2340         int val_type;
2341         int min_value;
2342 };
2343
2344 struct procunit_info {
2345         int type;
2346         char *name;
2347         const struct procunit_value_info *values;
2348 };
2349
2350 static const struct procunit_value_info undefined_proc_info[] = {
2351         { 0x00, "Control Undefined", 0 },
2352         { 0 }
2353 };
2354
2355 static const struct procunit_value_info updown_proc_info[] = {
2356         { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2357         { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2358         { 0 }
2359 };
2360 static const struct procunit_value_info prologic_proc_info[] = {
2361         { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2362         { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2363         { 0 }
2364 };
2365 static const struct procunit_value_info threed_enh_proc_info[] = {
2366         { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2367         { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2368         { 0 }
2369 };
2370 static const struct procunit_value_info reverb_proc_info[] = {
2371         { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2372         { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2373         { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2374         { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2375         { 0 }
2376 };
2377 static const struct procunit_value_info chorus_proc_info[] = {
2378         { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2379         { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2380         { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2381         { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2382         { 0 }
2383 };
2384 static const struct procunit_value_info dcr_proc_info[] = {
2385         { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2386         { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2387         { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2388         { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2389         { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2390         { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2391         { 0 }
2392 };
2393
2394 static const struct procunit_info procunits[] = {
2395         { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2396         { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2397         { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2398         { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2399         { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2400         { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2401         { 0 },
2402 };
2403
2404 static const struct procunit_value_info uac3_updown_proc_info[] = {
2405         { UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2406         { 0 }
2407 };
2408 static const struct procunit_value_info uac3_stereo_ext_proc_info[] = {
2409         { UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
2410         { 0 }
2411 };
2412
2413 static const struct procunit_info uac3_procunits[] = {
2414         { UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info },
2415         { UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info },
2416         { UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info },
2417         { 0 },
2418 };
2419
2420 /*
2421  * predefined data for extension units
2422  */
2423 static const struct procunit_value_info clock_rate_xu_info[] = {
2424         { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2425         { 0 }
2426 };
2427 static const struct procunit_value_info clock_source_xu_info[] = {
2428         { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2429         { 0 }
2430 };
2431 static const struct procunit_value_info spdif_format_xu_info[] = {
2432         { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2433         { 0 }
2434 };
2435 static const struct procunit_value_info soft_limit_xu_info[] = {
2436         { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2437         { 0 }
2438 };
2439 static const struct procunit_info extunits[] = {
2440         { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2441         { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2442         { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2443         { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2444         { 0 }
2445 };
2446
2447 /*
2448  * build a processing/extension unit
2449  */
2450 static int build_audio_procunit(struct mixer_build *state, int unitid,
2451                                 void *raw_desc, const struct procunit_info *list,
2452                                 bool extension_unit)
2453 {
2454         struct uac_processing_unit_descriptor *desc = raw_desc;
2455         int num_ins;
2456         struct usb_mixer_elem_info *cval;
2457         struct snd_kcontrol *kctl;
2458         int i, err, nameid, type, len, val;
2459         const struct procunit_info *info;
2460         const struct procunit_value_info *valinfo;
2461         const struct usbmix_name_map *map;
2462         static const struct procunit_value_info default_value_info[] = {
2463                 { 0x01, "Switch", USB_MIXER_BOOLEAN },
2464                 { 0 }
2465         };
2466         static const struct procunit_info default_info = {
2467                 0, NULL, default_value_info
2468         };
2469         const char *name = extension_unit ?
2470                 "Extension Unit" : "Processing Unit";
2471
2472         num_ins = desc->bNrInPins;
2473         for (i = 0; i < num_ins; i++) {
2474                 err = parse_audio_unit(state, desc->baSourceID[i]);
2475                 if (err < 0)
2476                         return err;
2477         }
2478
2479         type = le16_to_cpu(desc->wProcessType);
2480         for (info = list; info && info->type; info++)
2481                 if (info->type == type)
2482                         break;
2483         if (!info || !info->type)
2484                 info = &default_info;
2485
2486         for (valinfo = info->values; valinfo->control; valinfo++) {
2487                 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2488
2489                 if (state->mixer->protocol == UAC_VERSION_1) {
2490                         if (!(controls[valinfo->control / 8] &
2491                                         (1 << ((valinfo->control % 8) - 1))))
2492                                 continue;
2493                 } else { /* UAC_VERSION_2/3 */
2494                         if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
2495                                                           valinfo->control))
2496                                 continue;
2497                 }
2498
2499                 map = find_map(state->map, unitid, valinfo->control);
2500                 if (check_ignored_ctl(map))
2501                         continue;
2502                 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2503                 if (!cval)
2504                         return -ENOMEM;
2505                 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2506                 cval->control = valinfo->control;
2507                 cval->val_type = valinfo->val_type;
2508                 cval->channels = 1;
2509
2510                 if (state->mixer->protocol > UAC_VERSION_1 &&
2511                     !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
2512                                                    valinfo->control))
2513                         cval->master_readonly = 1;
2514
2515                 /* get min/max values */
2516                 switch (type) {
2517                 case UAC_PROCESS_UP_DOWNMIX: {
2518                         bool mode_sel = false;
2519
2520                         switch (state->mixer->protocol) {
2521                         case UAC_VERSION_1:
2522                         case UAC_VERSION_2:
2523                         default:
2524                                 if (cval->control == UAC_UD_MODE_SELECT)
2525                                         mode_sel = true;
2526                                 break;
2527                         case UAC_VERSION_3:
2528                                 if (cval->control == UAC3_UD_MODE_SELECT)
2529                                         mode_sel = true;
2530                                 break;
2531                         }
2532
2533                         if (mode_sel) {
2534                                 __u8 *control_spec = uac_processing_unit_specific(desc,
2535                                                                 state->mixer->protocol);
2536                                 cval->min = 1;
2537                                 cval->max = control_spec[0];
2538                                 cval->res = 1;
2539                                 cval->initialized = 1;
2540                                 break;
2541                         }
2542
2543                         get_min_max(cval, valinfo->min_value);
2544                         break;
2545                 }
2546                 case USB_XU_CLOCK_RATE:
2547                         /*
2548                          * E-Mu USB 0404/0202/TrackerPre/0204
2549                          * samplerate control quirk
2550                          */
2551                         cval->min = 0;
2552                         cval->max = 5;
2553                         cval->res = 1;
2554                         cval->initialized = 1;
2555                         break;
2556                 default:
2557                         get_min_max(cval, valinfo->min_value);
2558                         break;
2559                 }
2560
2561                 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2562                 if (err < 0) {
2563                         usb_mixer_elem_info_free(cval);
2564                         return -EINVAL;
2565                 }
2566
2567                 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2568                 if (!kctl) {
2569                         usb_mixer_elem_info_free(cval);
2570                         return -ENOMEM;
2571                 }
2572                 kctl->private_free = snd_usb_mixer_elem_free;
2573
2574                 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2575                         /* nothing */ ;
2576                 } else if (info->name) {
2577                         strscpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2578                 } else {
2579                         if (extension_unit)
2580                                 nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
2581                         else
2582                                 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2583                         len = 0;
2584                         if (nameid)
2585                                 len = snd_usb_copy_string_desc(state->chip,
2586                                                                nameid,
2587                                                                kctl->id.name,
2588                                                                sizeof(kctl->id.name));
2589                         if (!len)
2590                                 strscpy(kctl->id.name, name, sizeof(kctl->id.name));
2591                 }
2592                 append_ctl_name(kctl, " ");
2593                 append_ctl_name(kctl, valinfo->suffix);
2594
2595                 usb_audio_dbg(state->chip,
2596                               "[%d] PU [%s] ch = %d, val = %d/%d\n",
2597                               cval->head.id, kctl->id.name, cval->channels,
2598                               cval->min, cval->max);
2599
2600                 err = snd_usb_mixer_add_control(&cval->head, kctl);
2601                 if (err < 0)
2602                         return err;
2603         }
2604         return 0;
2605 }
2606
2607 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2608                                        void *raw_desc)
2609 {
2610         switch (state->mixer->protocol) {
2611         case UAC_VERSION_1:
2612         case UAC_VERSION_2:
2613         default:
2614                 return build_audio_procunit(state, unitid, raw_desc,
2615                                             procunits, false);
2616         case UAC_VERSION_3:
2617                 return build_audio_procunit(state, unitid, raw_desc,
2618                                             uac3_procunits, false);
2619         }
2620 }
2621
2622 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2623                                       void *raw_desc)
2624 {
2625         /*
2626          * Note that we parse extension units with processing unit descriptors.
2627          * That's ok as the layout is the same.
2628          */
2629         return build_audio_procunit(state, unitid, raw_desc, extunits, true);
2630 }
2631
2632 /*
2633  * Selector Unit
2634  */
2635
2636 /*
2637  * info callback for selector unit
2638  * use an enumerator type for routing
2639  */
2640 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2641                                    struct snd_ctl_elem_info *uinfo)
2642 {
2643         struct usb_mixer_elem_info *cval = kcontrol->private_data;
2644         const char **itemlist = (const char **)kcontrol->private_value;
2645
2646         if (snd_BUG_ON(!itemlist))
2647                 return -EINVAL;
2648         return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2649 }
2650
2651 /* get callback for selector unit */
2652 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2653                                   struct snd_ctl_elem_value *ucontrol)
2654 {
2655         struct usb_mixer_elem_info *cval = kcontrol->private_data;
2656         int val, err;
2657
2658         err = get_cur_ctl_value(cval, cval->control << 8, &val);
2659         if (err < 0) {
2660                 ucontrol->value.enumerated.item[0] = 0;
2661                 return filter_error(cval, err);
2662         }
2663         val = get_relative_value(cval, val);
2664         ucontrol->value.enumerated.item[0] = val;
2665         return 0;
2666 }
2667
2668 /* put callback for selector unit */
2669 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2670                                   struct snd_ctl_elem_value *ucontrol)
2671 {
2672         struct usb_mixer_elem_info *cval = kcontrol->private_data;
2673         int val, oval, err;
2674
2675         err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2676         if (err < 0)
2677                 return filter_error(cval, err);
2678         val = ucontrol->value.enumerated.item[0];
2679         val = get_abs_value(cval, val);
2680         if (val != oval) {
2681                 set_cur_ctl_value(cval, cval->control << 8, val);
2682                 return 1;
2683         }
2684         return 0;
2685 }
2686
2687 /* alsa control interface for selector unit */
2688 static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2689         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2690         .name = "", /* will be filled later */
2691         .info = mixer_ctl_selector_info,
2692         .get = mixer_ctl_selector_get,
2693         .put = mixer_ctl_selector_put,
2694 };
2695
2696 /*
2697  * private free callback.
2698  * free both private_data and private_value
2699  */
2700 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2701 {
2702         int i, num_ins = 0;
2703
2704         if (kctl->private_data) {
2705                 struct usb_mixer_elem_info *cval = kctl->private_data;
2706                 num_ins = cval->max;
2707                 usb_mixer_elem_info_free(cval);
2708                 kctl->private_data = NULL;
2709         }
2710         if (kctl->private_value) {
2711                 char **itemlist = (char **)kctl->private_value;
2712                 for (i = 0; i < num_ins; i++)
2713                         kfree(itemlist[i]);
2714                 kfree(itemlist);
2715                 kctl->private_value = 0;
2716         }
2717 }
2718
2719 /*
2720  * parse a selector unit
2721  */
2722 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2723                                      void *raw_desc)
2724 {
2725         struct uac_selector_unit_descriptor *desc = raw_desc;
2726         unsigned int i, nameid, len;
2727         int err;
2728         struct usb_mixer_elem_info *cval;
2729         struct snd_kcontrol *kctl;
2730         const struct usbmix_name_map *map;
2731         char **namelist;
2732
2733         for (i = 0; i < desc->bNrInPins; i++) {
2734                 err = parse_audio_unit(state, desc->baSourceID[i]);
2735                 if (err < 0)
2736                         return err;
2737         }
2738
2739         if (desc->bNrInPins == 1) /* only one ? nonsense! */
2740                 return 0;
2741
2742         map = find_map(state->map, unitid, 0);
2743         if (check_ignored_ctl(map))
2744                 return 0;
2745
2746         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2747         if (!cval)
2748                 return -ENOMEM;
2749         snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2750         cval->val_type = USB_MIXER_U8;
2751         cval->channels = 1;
2752         cval->min = 1;
2753         cval->max = desc->bNrInPins;
2754         cval->res = 1;
2755         cval->initialized = 1;
2756
2757         switch (state->mixer->protocol) {
2758         case UAC_VERSION_1:
2759         default:
2760                 cval->control = 0;
2761                 break;
2762         case UAC_VERSION_2:
2763         case UAC_VERSION_3:
2764                 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2765                     desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2766                         cval->control = UAC2_CX_CLOCK_SELECTOR;
2767                 else /* UAC2/3_SELECTOR_UNIT */
2768                         cval->control = UAC2_SU_SELECTOR;
2769                 break;
2770         }
2771
2772         namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2773         if (!namelist) {
2774                 err = -ENOMEM;
2775                 goto error_cval;
2776         }
2777 #define MAX_ITEM_NAME_LEN       64
2778         for (i = 0; i < desc->bNrInPins; i++) {
2779                 struct usb_audio_term iterm;
2780                 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2781                 if (!namelist[i]) {
2782                         err = -ENOMEM;
2783                         goto error_name;
2784                 }
2785                 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2786                                                  MAX_ITEM_NAME_LEN);
2787                 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2788                         len = get_term_name(state->chip, &iterm, namelist[i],
2789                                             MAX_ITEM_NAME_LEN, 0);
2790                 if (! len)
2791                         sprintf(namelist[i], "Input %u", i);
2792         }
2793
2794         kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2795         if (! kctl) {
2796                 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2797                 err = -ENOMEM;
2798                 goto error_name;
2799         }
2800         kctl->private_value = (unsigned long)namelist;
2801         kctl->private_free = usb_mixer_selector_elem_free;
2802
2803         /* check the static mapping table at first */
2804         len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2805         if (!len) {
2806                 /* no mapping ? */
2807                 switch (state->mixer->protocol) {
2808                 case UAC_VERSION_1:
2809                 case UAC_VERSION_2:
2810                 default:
2811                 /* if iSelector is given, use it */
2812                         nameid = uac_selector_unit_iSelector(desc);
2813                         if (nameid)
2814                                 len = snd_usb_copy_string_desc(state->chip,
2815                                                         nameid, kctl->id.name,
2816                                                         sizeof(kctl->id.name));
2817                         break;
2818                 case UAC_VERSION_3:
2819                         /* TODO: Class-Specific strings not yet supported */
2820                         break;
2821                 }
2822
2823                 /* ... or pick up the terminal name at next */
2824                 if (!len)
2825                         len = get_term_name(state->chip, &state->oterm,
2826                                     kctl->id.name, sizeof(kctl->id.name), 0);
2827                 /* ... or use the fixed string "USB" as the last resort */
2828                 if (!len)
2829                         strscpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2830
2831                 /* and add the proper suffix */
2832                 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2833                     desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2834                         append_ctl_name(kctl, " Clock Source");
2835                 else if ((state->oterm.type & 0xff00) == 0x0100)
2836                         append_ctl_name(kctl, " Capture Source");
2837                 else
2838                         append_ctl_name(kctl, " Playback Source");
2839         }
2840
2841         usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2842                     cval->head.id, kctl->id.name, desc->bNrInPins);
2843         return snd_usb_mixer_add_control(&cval->head, kctl);
2844
2845  error_name:
2846         for (i = 0; i < desc->bNrInPins; i++)
2847                 kfree(namelist[i]);
2848         kfree(namelist);
2849  error_cval:
2850         usb_mixer_elem_info_free(cval);
2851         return err;
2852 }
2853
2854 /*
2855  * parse an audio unit recursively
2856  */
2857
2858 static int parse_audio_unit(struct mixer_build *state, int unitid)
2859 {
2860         unsigned char *p1;
2861         int protocol = state->mixer->protocol;
2862
2863         if (test_and_set_bit(unitid, state->unitbitmap))
2864                 return 0; /* the unit already visited */
2865
2866         p1 = find_audio_control_unit(state, unitid);
2867         if (!p1) {
2868                 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2869                 return -EINVAL;
2870         }
2871
2872         if (!snd_usb_validate_audio_desc(p1, protocol)) {
2873                 usb_audio_dbg(state->chip, "invalid unit %d\n", unitid);
2874                 return 0; /* skip invalid unit */
2875         }
2876
2877         switch (PTYPE(protocol, p1[2])) {
2878         case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
2879         case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
2880         case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
2881                 return parse_audio_input_terminal(state, unitid, p1);
2882         case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
2883         case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
2884         case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
2885                 return parse_audio_mixer_unit(state, unitid, p1);
2886         case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
2887         case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
2888                 return parse_clock_source_unit(state, unitid, p1);
2889         case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
2890         case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
2891         case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
2892         case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
2893         case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
2894                 return parse_audio_selector_unit(state, unitid, p1);
2895         case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
2896         case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
2897         case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT):
2898                 return parse_audio_feature_unit(state, unitid, p1);
2899         case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
2900         case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
2901         case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
2902                 return parse_audio_processing_unit(state, unitid, p1);
2903         case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
2904         case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
2905         case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
2906                 return parse_audio_extension_unit(state, unitid, p1);
2907         case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
2908         case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
2909                 return 0; /* FIXME - effect units not implemented yet */
2910         default:
2911                 usb_audio_err(state->chip,
2912                               "unit %u: unexpected type 0x%02x\n",
2913                               unitid, p1[2]);
2914                 return -EINVAL;
2915         }
2916 }
2917
2918 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2919 {
2920         /* kill pending URBs */
2921         snd_usb_mixer_disconnect(mixer);
2922
2923         kfree(mixer->id_elems);
2924         if (mixer->urb) {
2925                 kfree(mixer->urb->transfer_buffer);
2926                 usb_free_urb(mixer->urb);
2927         }
2928         usb_free_urb(mixer->rc_urb);
2929         kfree(mixer->rc_setup_packet);
2930         kfree(mixer);
2931 }
2932
2933 static int snd_usb_mixer_dev_free(struct snd_device *device)
2934 {
2935         struct usb_mixer_interface *mixer = device->device_data;
2936         snd_usb_mixer_free(mixer);
2937         return 0;
2938 }
2939
2940 /* UAC3 predefined channels configuration */
2941 struct uac3_badd_profile {
2942         int subclass;
2943         const char *name;
2944         int c_chmask;   /* capture channels mask */
2945         int p_chmask;   /* playback channels mask */
2946         int st_chmask;  /* side tone mixing channel mask */
2947 };
2948
2949 static const struct uac3_badd_profile uac3_badd_profiles[] = {
2950         {
2951                 /*
2952                  * BAIF, BAOF or combination of both
2953                  * IN: Mono or Stereo cfg, Mono alt possible
2954                  * OUT: Mono or Stereo cfg, Mono alt possible
2955                  */
2956                 .subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
2957                 .name = "GENERIC IO",
2958                 .c_chmask = -1,         /* dynamic channels */
2959                 .p_chmask = -1,         /* dynamic channels */
2960         },
2961         {
2962                 /* BAOF; Stereo only cfg, Mono alt possible */
2963                 .subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
2964                 .name = "HEADPHONE",
2965                 .p_chmask = 3,
2966         },
2967         {
2968                 /* BAOF; Mono or Stereo cfg, Mono alt possible */
2969                 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
2970                 .name = "SPEAKER",
2971                 .p_chmask = -1,         /* dynamic channels */
2972         },
2973         {
2974                 /* BAIF; Mono or Stereo cfg, Mono alt possible */
2975                 .subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
2976                 .name = "MICROPHONE",
2977                 .c_chmask = -1,         /* dynamic channels */
2978         },
2979         {
2980                 /*
2981                  * BAIOF topology
2982                  * IN: Mono only
2983                  * OUT: Mono or Stereo cfg, Mono alt possible
2984                  */
2985                 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
2986                 .name = "HEADSET",
2987                 .c_chmask = 1,
2988                 .p_chmask = -1,         /* dynamic channels */
2989                 .st_chmask = 1,
2990         },
2991         {
2992                 /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
2993                 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
2994                 .name = "HEADSET ADAPTER",
2995                 .c_chmask = 1,
2996                 .p_chmask = 3,
2997                 .st_chmask = 1,
2998         },
2999         {
3000                 /* BAIF + BAOF; IN: Mono only; OUT: Mono only */
3001                 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
3002                 .name = "SPEAKERPHONE",
3003                 .c_chmask = 1,
3004                 .p_chmask = 1,
3005         },
3006         { 0 } /* terminator */
3007 };
3008
3009 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
3010                                               const struct uac3_badd_profile *f,
3011                                               int c_chmask, int p_chmask)
3012 {
3013         /*
3014          * If both playback/capture channels are dynamic, make sure
3015          * at least one channel is present
3016          */
3017         if (f->c_chmask < 0 && f->p_chmask < 0) {
3018                 if (!c_chmask && !p_chmask) {
3019                         usb_audio_warn(mixer->chip, "BAAD %s: no channels?",
3020                                        f->name);
3021                         return false;
3022                 }
3023                 return true;
3024         }
3025
3026         if ((f->c_chmask < 0 && !c_chmask) ||
3027             (f->c_chmask >= 0 && f->c_chmask != c_chmask)) {
3028                 usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch",
3029                                f->name);
3030                 return false;
3031         }
3032         if ((f->p_chmask < 0 && !p_chmask) ||
3033             (f->p_chmask >= 0 && f->p_chmask != p_chmask)) {
3034                 usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch",
3035                                f->name);
3036                 return false;
3037         }
3038         return true;
3039 }
3040
3041 /*
3042  * create mixer controls for UAC3 BADD profiles
3043  *
3044  * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
3045  *
3046  * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
3047  */
3048 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
3049                                        int ctrlif)
3050 {
3051         struct usb_device *dev = mixer->chip->dev;
3052         struct usb_interface_assoc_descriptor *assoc;
3053         int badd_profile = mixer->chip->badd_profile;
3054         const struct uac3_badd_profile *f;
3055         const struct usbmix_ctl_map *map;
3056         int p_chmask = 0, c_chmask = 0, st_chmask = 0;
3057         int i;
3058
3059         assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
3060
3061         /* Detect BADD capture/playback channels from AS EP descriptors */
3062         for (i = 0; i < assoc->bInterfaceCount; i++) {
3063                 int intf = assoc->bFirstInterface + i;
3064
3065                 struct usb_interface *iface;
3066                 struct usb_host_interface *alts;
3067                 struct usb_interface_descriptor *altsd;
3068                 unsigned int maxpacksize;
3069                 char dir_in;
3070                 int chmask, num;
3071
3072                 if (intf == ctrlif)
3073                         continue;
3074
3075                 iface = usb_ifnum_to_if(dev, intf);
3076                 if (!iface)
3077                         continue;
3078
3079                 num = iface->num_altsetting;
3080
3081                 if (num < 2)
3082                         return -EINVAL;
3083
3084                 /*
3085                  * The number of Channels in an AudioStreaming interface
3086                  * and the audio sample bit resolution (16 bits or 24
3087                  * bits) can be derived from the wMaxPacketSize field in
3088                  * the Standard AS Audio Data Endpoint descriptor in
3089                  * Alternate Setting 1
3090                  */
3091                 alts = &iface->altsetting[1];
3092                 altsd = get_iface_desc(alts);
3093
3094                 if (altsd->bNumEndpoints < 1)
3095                         return -EINVAL;
3096
3097                 /* check direction */
3098                 dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
3099                 maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3100
3101                 switch (maxpacksize) {
3102                 default:
3103                         usb_audio_err(mixer->chip,
3104                                 "incorrect wMaxPacketSize 0x%x for BADD profile\n",
3105                                 maxpacksize);
3106                         return -EINVAL;
3107                 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
3108                 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
3109                 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
3110                 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
3111                         chmask = 1;
3112                         break;
3113                 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
3114                 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
3115                 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
3116                 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
3117                         chmask = 3;
3118                         break;
3119                 }
3120
3121                 if (dir_in)
3122                         c_chmask = chmask;
3123                 else
3124                         p_chmask = chmask;
3125         }
3126
3127         usb_audio_dbg(mixer->chip,
3128                 "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
3129                 badd_profile, c_chmask, p_chmask);
3130
3131         /* check the mapping table */
3132         for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
3133                 if (map->id == badd_profile)
3134                         break;
3135         }
3136
3137         if (!map->id)
3138                 return -EINVAL;
3139
3140         for (f = uac3_badd_profiles; f->name; f++) {
3141                 if (badd_profile == f->subclass)
3142                         break;
3143         }
3144         if (!f->name)
3145                 return -EINVAL;
3146         if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
3147                 return -EINVAL;
3148         st_chmask = f->st_chmask;
3149
3150         /* Playback */
3151         if (p_chmask) {
3152                 /* Master channel, always writable */
3153                 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3154                                        UAC3_BADD_FU_ID2, map->map);
3155                 /* Mono/Stereo volume channels, always writable */
3156                 build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
3157                                        UAC3_BADD_FU_ID2, map->map);
3158         }
3159
3160         /* Capture */
3161         if (c_chmask) {
3162                 /* Master channel, always writable */
3163                 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3164                                        UAC3_BADD_FU_ID5, map->map);
3165                 /* Mono/Stereo volume channels, always writable */
3166                 build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
3167                                        UAC3_BADD_FU_ID5, map->map);
3168         }
3169
3170         /* Side tone-mixing */
3171         if (st_chmask) {
3172                 /* Master channel, always writable */
3173                 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3174                                        UAC3_BADD_FU_ID7, map->map);
3175                 /* Mono volume channel, always writable */
3176                 build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
3177                                        UAC3_BADD_FU_ID7, map->map);
3178         }
3179
3180         /* Insertion Control */
3181         if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
3182                 struct usb_audio_term iterm, oterm;
3183
3184                 /* Input Term - Insertion control */
3185                 memset(&iterm, 0, sizeof(iterm));
3186                 iterm.id = UAC3_BADD_IT_ID4;
3187                 iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3188                 build_connector_control(mixer, map->map, &iterm, true);
3189
3190                 /* Output Term - Insertion control */
3191                 memset(&oterm, 0, sizeof(oterm));
3192                 oterm.id = UAC3_BADD_OT_ID3;
3193                 oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3194                 build_connector_control(mixer, map->map, &oterm, false);
3195         }
3196
3197         return 0;
3198 }
3199
3200 /*
3201  * create mixer controls
3202  *
3203  * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3204  */
3205 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
3206 {
3207         struct mixer_build state;
3208         int err;
3209         const struct usbmix_ctl_map *map;
3210         void *p;
3211
3212         memset(&state, 0, sizeof(state));
3213         state.chip = mixer->chip;
3214         state.mixer = mixer;
3215         state.buffer = mixer->hostif->extra;
3216         state.buflen = mixer->hostif->extralen;
3217
3218         /* check the mapping table */
3219         for (map = usbmix_ctl_maps; map->id; map++) {
3220                 if (map->id == state.chip->usb_id) {
3221                         state.map = map->map;
3222                         state.selector_map = map->selector_map;
3223                         mixer->connector_map = map->connector_map;
3224                         break;
3225                 }
3226         }
3227
3228         p = NULL;
3229         while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
3230                                             mixer->hostif->extralen,
3231                                             p, UAC_OUTPUT_TERMINAL)) != NULL) {
3232                 if (!snd_usb_validate_audio_desc(p, mixer->protocol))
3233                         continue; /* skip invalid descriptor */
3234
3235                 if (mixer->protocol == UAC_VERSION_1) {
3236                         struct uac1_output_terminal_descriptor *desc = p;
3237
3238                         /* mark terminal ID as visited */
3239                         set_bit(desc->bTerminalID, state.unitbitmap);
3240                         state.oterm.id = desc->bTerminalID;
3241                         state.oterm.type = le16_to_cpu(desc->wTerminalType);
3242                         state.oterm.name = desc->iTerminal;
3243                         err = parse_audio_unit(&state, desc->bSourceID);
3244                         if (err < 0 && err != -EINVAL)
3245                                 return err;
3246                 } else if (mixer->protocol == UAC_VERSION_2) {
3247                         struct uac2_output_terminal_descriptor *desc = p;
3248
3249                         /* mark terminal ID as visited */
3250                         set_bit(desc->bTerminalID, state.unitbitmap);
3251                         state.oterm.id = desc->bTerminalID;
3252                         state.oterm.type = le16_to_cpu(desc->wTerminalType);
3253                         state.oterm.name = desc->iTerminal;
3254                         err = parse_audio_unit(&state, desc->bSourceID);
3255                         if (err < 0 && err != -EINVAL)
3256                                 return err;
3257
3258                         /*
3259                          * For UAC2, use the same approach to also add the
3260                          * clock selectors
3261                          */
3262                         err = parse_audio_unit(&state, desc->bCSourceID);
3263                         if (err < 0 && err != -EINVAL)
3264                                 return err;
3265
3266                         if ((state.oterm.type & 0xff00) != 0x0100 &&
3267                             uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3268                                                          UAC2_TE_CONNECTOR)) {
3269                                 build_connector_control(state.mixer, state.map,
3270                                                         &state.oterm, false);
3271                         }
3272                 } else {  /* UAC_VERSION_3 */
3273                         struct uac3_output_terminal_descriptor *desc = p;
3274
3275                         /* mark terminal ID as visited */
3276                         set_bit(desc->bTerminalID, state.unitbitmap);
3277                         state.oterm.id = desc->bTerminalID;
3278                         state.oterm.type = le16_to_cpu(desc->wTerminalType);
3279                         state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
3280                         err = parse_audio_unit(&state, desc->bSourceID);
3281                         if (err < 0 && err != -EINVAL)
3282                                 return err;
3283
3284                         /*
3285                          * For UAC3, use the same approach to also add the
3286                          * clock selectors
3287                          */
3288                         err = parse_audio_unit(&state, desc->bCSourceID);
3289                         if (err < 0 && err != -EINVAL)
3290                                 return err;
3291
3292                         if ((state.oterm.type & 0xff00) != 0x0100 &&
3293                             uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
3294                                                          UAC3_TE_INSERTION)) {
3295                                 build_connector_control(state.mixer, state.map,
3296                                                         &state.oterm, false);
3297                         }
3298                 }
3299         }
3300
3301         return 0;
3302 }
3303
3304 static int delegate_notify(struct usb_mixer_interface *mixer, int unitid,
3305                            u8 *control, u8 *channel)
3306 {
3307         const struct usbmix_connector_map *map = mixer->connector_map;
3308
3309         if (!map)
3310                 return unitid;
3311
3312         for (; map->id; map++) {
3313                 if (map->id == unitid) {
3314                         if (control && map->control)
3315                                 *control = map->control;
3316                         if (channel && map->channel)
3317                                 *channel = map->channel;
3318                         return map->delegated_id;
3319                 }
3320         }
3321         return unitid;
3322 }
3323
3324 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3325 {
3326         struct usb_mixer_elem_list *list;
3327
3328         unitid = delegate_notify(mixer, unitid, NULL, NULL);
3329
3330         for_each_mixer_elem(list, mixer, unitid) {
3331                 struct usb_mixer_elem_info *info;
3332
3333                 if (!list->is_std_info)
3334                         continue;
3335                 info = mixer_elem_list_to_info(list);
3336                 /* invalidate cache, so the value is read from the device */
3337                 info->cached = 0;
3338                 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3339                                &list->kctl->id);
3340         }
3341 }
3342
3343 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3344                                     struct usb_mixer_elem_list *list)
3345 {
3346         struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3347         static const char * const val_types[] = {
3348                 [USB_MIXER_BOOLEAN] = "BOOLEAN",
3349                 [USB_MIXER_INV_BOOLEAN] = "INV_BOOLEAN",
3350                 [USB_MIXER_S8] = "S8",
3351                 [USB_MIXER_U8] = "U8",
3352                 [USB_MIXER_S16] = "S16",
3353                 [USB_MIXER_U16] = "U16",
3354                 [USB_MIXER_S32] = "S32",
3355                 [USB_MIXER_U32] = "U32",
3356                 [USB_MIXER_BESPOKEN] = "BESPOKEN",
3357         };
3358         snd_iprintf(buffer, "    Info: id=%i, control=%i, cmask=0x%x, "
3359                             "channels=%i, type=\"%s\"\n", cval->head.id,
3360                             cval->control, cval->cmask, cval->channels,
3361                             val_types[cval->val_type]);
3362         snd_iprintf(buffer, "    Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3363                             cval->min, cval->max, cval->dBmin, cval->dBmax);
3364 }
3365
3366 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
3367                                     struct snd_info_buffer *buffer)
3368 {
3369         struct snd_usb_audio *chip = entry->private_data;
3370         struct usb_mixer_interface *mixer;
3371         struct usb_mixer_elem_list *list;
3372         int unitid;
3373
3374         list_for_each_entry(mixer, &chip->mixer_list, list) {
3375                 snd_iprintf(buffer,
3376                         "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3377                                 chip->usb_id, mixer_ctrl_intf(mixer),
3378                                 mixer->ignore_ctl_error);
3379                 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
3380                 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3381                         for_each_mixer_elem(list, mixer, unitid) {
3382                                 snd_iprintf(buffer, "  Unit: %i\n", list->id);
3383                                 if (list->kctl)
3384                                         snd_iprintf(buffer,
3385                                                     "    Control: name=\"%s\", index=%i\n",
3386                                                     list->kctl->id.name,
3387                                                     list->kctl->id.index);
3388                                 if (list->dump)
3389                                         list->dump(buffer, list);
3390                         }
3391                 }
3392         }
3393 }
3394
3395 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
3396                                        int attribute, int value, int index)
3397 {
3398         struct usb_mixer_elem_list *list;
3399         __u8 unitid = (index >> 8) & 0xff;
3400         __u8 control = (value >> 8) & 0xff;
3401         __u8 channel = value & 0xff;
3402         unsigned int count = 0;
3403
3404         if (channel >= MAX_CHANNELS) {
3405                 usb_audio_dbg(mixer->chip,
3406                         "%s(): bogus channel number %d\n",
3407                         __func__, channel);
3408                 return;
3409         }
3410
3411         unitid = delegate_notify(mixer, unitid, &control, &channel);
3412
3413         for_each_mixer_elem(list, mixer, unitid)
3414                 count++;
3415
3416         if (count == 0)
3417                 return;
3418
3419         for_each_mixer_elem(list, mixer, unitid) {
3420                 struct usb_mixer_elem_info *info;
3421
3422                 if (!list->kctl)
3423                         continue;
3424                 if (!list->is_std_info)
3425                         continue;
3426
3427                 info = mixer_elem_list_to_info(list);
3428                 if (count > 1 && info->control != control)
3429                         continue;
3430
3431                 switch (attribute) {
3432                 case UAC2_CS_CUR:
3433                         /* invalidate cache, so the value is read from the device */
3434                         if (channel)
3435                                 info->cached &= ~(1 << channel);
3436                         else /* master channel */
3437                                 info->cached = 0;
3438
3439                         snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3440                                        &info->head.kctl->id);
3441                         break;
3442
3443                 case UAC2_CS_RANGE:
3444                         /* TODO */
3445                         break;
3446
3447                 case UAC2_CS_MEM:
3448                         /* TODO */
3449                         break;
3450
3451                 default:
3452                         usb_audio_dbg(mixer->chip,
3453                                 "unknown attribute %d in interrupt\n",
3454                                 attribute);
3455                         break;
3456                 } /* switch */
3457         }
3458 }
3459
3460 static void snd_usb_mixer_interrupt(struct urb *urb)
3461 {
3462         struct usb_mixer_interface *mixer = urb->context;
3463         int len = urb->actual_length;
3464         int ustatus = urb->status;
3465
3466         if (ustatus != 0)
3467                 goto requeue;
3468
3469         if (mixer->protocol == UAC_VERSION_1) {
3470                 struct uac1_status_word *status;
3471
3472                 for (status = urb->transfer_buffer;
3473                      len >= sizeof(*status);
3474                      len -= sizeof(*status), status++) {
3475                         dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3476                                                 status->bStatusType,
3477                                                 status->bOriginator);
3478
3479                         /* ignore any notifications not from the control interface */
3480                         if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
3481                                 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3482                                 continue;
3483
3484                         if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
3485                                 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3486                         else
3487                                 snd_usb_mixer_notify_id(mixer, status->bOriginator);
3488                 }
3489         } else { /* UAC_VERSION_2 */
3490                 struct uac2_interrupt_data_msg *msg;
3491
3492                 for (msg = urb->transfer_buffer;
3493                      len >= sizeof(*msg);
3494                      len -= sizeof(*msg), msg++) {
3495                         /* drop vendor specific and endpoint requests */
3496                         if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
3497                             (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
3498                                 continue;
3499
3500                         snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
3501                                                    le16_to_cpu(msg->wValue),
3502                                                    le16_to_cpu(msg->wIndex));
3503                 }
3504         }
3505
3506 requeue:
3507         if (ustatus != -ENOENT &&
3508             ustatus != -ECONNRESET &&
3509             ustatus != -ESHUTDOWN) {
3510                 urb->dev = mixer->chip->dev;
3511                 usb_submit_urb(urb, GFP_ATOMIC);
3512         }
3513 }
3514
3515 /* create the handler for the optional status interrupt endpoint */
3516 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
3517 {
3518         struct usb_endpoint_descriptor *ep;
3519         void *transfer_buffer;
3520         int buffer_length;
3521         unsigned int epnum;
3522
3523         /* we need one interrupt input endpoint */
3524         if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3525                 return 0;
3526         ep = get_endpoint(mixer->hostif, 0);
3527         if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3528                 return 0;
3529
3530         epnum = usb_endpoint_num(ep);
3531         buffer_length = le16_to_cpu(ep->wMaxPacketSize);
3532         transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
3533         if (!transfer_buffer)
3534                 return -ENOMEM;
3535         mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
3536         if (!mixer->urb) {
3537                 kfree(transfer_buffer);
3538                 return -ENOMEM;
3539         }
3540         usb_fill_int_urb(mixer->urb, mixer->chip->dev,
3541                          usb_rcvintpipe(mixer->chip->dev, epnum),
3542                          transfer_buffer, buffer_length,
3543                          snd_usb_mixer_interrupt, mixer, ep->bInterval);
3544         usb_submit_urb(mixer->urb, GFP_KERNEL);
3545         return 0;
3546 }
3547
3548 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif)
3549 {
3550         static const struct snd_device_ops dev_ops = {
3551                 .dev_free = snd_usb_mixer_dev_free
3552         };
3553         struct usb_mixer_interface *mixer;
3554         int err;
3555
3556         strcpy(chip->card->mixername, "USB Mixer");
3557
3558         mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3559         if (!mixer)
3560                 return -ENOMEM;
3561         mixer->chip = chip;
3562         mixer->ignore_ctl_error = !!(chip->quirk_flags & QUIRK_FLAG_IGNORE_CTL_ERROR);
3563         mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
3564                                   GFP_KERNEL);
3565         if (!mixer->id_elems) {
3566                 kfree(mixer);
3567                 return -ENOMEM;
3568         }
3569
3570         mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
3571         switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3572         case UAC_VERSION_1:
3573         default:
3574                 mixer->protocol = UAC_VERSION_1;
3575                 break;
3576         case UAC_VERSION_2:
3577                 mixer->protocol = UAC_VERSION_2;
3578                 break;
3579         case UAC_VERSION_3:
3580                 mixer->protocol = UAC_VERSION_3;
3581                 break;
3582         }
3583
3584         if (mixer->protocol == UAC_VERSION_3 &&
3585                         chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3586                 err = snd_usb_mixer_controls_badd(mixer, ctrlif);
3587                 if (err < 0)
3588                         goto _error;
3589         } else {
3590                 err = snd_usb_mixer_controls(mixer);
3591                 if (err < 0)
3592                         goto _error;
3593         }
3594
3595         err = snd_usb_mixer_status_create(mixer);
3596         if (err < 0)
3597                 goto _error;
3598
3599         err = snd_usb_mixer_apply_create_quirk(mixer);
3600         if (err < 0)
3601                 goto _error;
3602
3603         err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3604         if (err < 0)
3605                 goto _error;
3606
3607         if (list_empty(&chip->mixer_list))
3608                 snd_card_ro_proc_new(chip->card, "usbmixer", chip,
3609                                      snd_usb_mixer_proc_read);
3610
3611         list_add(&mixer->list, &chip->mixer_list);
3612         return 0;
3613
3614 _error:
3615         snd_usb_mixer_free(mixer);
3616         return err;
3617 }
3618
3619 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3620 {
3621         if (mixer->disconnected)
3622                 return;
3623         if (mixer->urb)
3624                 usb_kill_urb(mixer->urb);
3625         if (mixer->rc_urb)
3626                 usb_kill_urb(mixer->rc_urb);
3627         if (mixer->private_free)
3628                 mixer->private_free(mixer);
3629         mixer->disconnected = true;
3630 }
3631
3632 /* stop any bus activity of a mixer */
3633 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
3634 {
3635         usb_kill_urb(mixer->urb);
3636         usb_kill_urb(mixer->rc_urb);
3637 }
3638
3639 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
3640 {
3641         int err;
3642
3643         if (mixer->urb) {
3644                 err = usb_submit_urb(mixer->urb, GFP_NOIO);
3645                 if (err < 0)
3646                         return err;
3647         }
3648
3649         return 0;
3650 }
3651
3652 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
3653 {
3654         snd_usb_mixer_inactivate(mixer);
3655         if (mixer->private_suspend)
3656                 mixer->private_suspend(mixer);
3657         return 0;
3658 }
3659
3660 static int restore_mixer_value(struct usb_mixer_elem_list *list)
3661 {
3662         struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3663         int c, err, idx;
3664
3665         if (cval->val_type == USB_MIXER_BESPOKEN)
3666                 return 0;
3667
3668         if (cval->cmask) {
3669                 idx = 0;
3670                 for (c = 0; c < MAX_CHANNELS; c++) {
3671                         if (!(cval->cmask & (1 << c)))
3672                                 continue;
3673                         if (cval->cached & (1 << (c + 1))) {
3674                                 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3675                                                         cval->cache_val[idx]);
3676                                 if (err < 0)
3677                                         return err;
3678                         }
3679                         idx++;
3680                 }
3681         } else {
3682                 /* master */
3683                 if (cval->cached) {
3684                         err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3685                         if (err < 0)
3686                                 return err;
3687                 }
3688         }
3689
3690         return 0;
3691 }
3692
3693 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer)
3694 {
3695         struct usb_mixer_elem_list *list;
3696         int id, err;
3697
3698         /* restore cached mixer values */
3699         for (id = 0; id < MAX_ID_ELEMS; id++) {
3700                 for_each_mixer_elem(list, mixer, id) {
3701                         if (list->resume) {
3702                                 err = list->resume(list);
3703                                 if (err < 0)
3704                                         return err;
3705                         }
3706                 }
3707         }
3708
3709         snd_usb_mixer_resume_quirk(mixer);
3710
3711         return snd_usb_mixer_activate(mixer);
3712 }
3713
3714 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
3715                                  struct usb_mixer_interface *mixer,
3716                                  int unitid)
3717 {
3718         list->mixer = mixer;
3719         list->id = unitid;
3720         list->dump = snd_usb_mixer_dump_cval;
3721         list->resume = restore_mixer_value;
3722 }