sound/usb/mixer.c

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