sound/usb/mixer.c

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