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