sound/usb/mixer.c

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