sound/usb/mixer.c

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