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