sound/usb/mixer.c

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