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