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