sound/usb/mixer.c

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