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