sound/usb/mixer.c

   1 /*
   2  *   (Tentative) USB Audio Driver for ALSA
   3  *
   4  *   Mixer control part
   5  *
   6  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
   7  *
   8  *   Many codes borrowed from audio.c by
   9  *          Alan Cox (alan@lxorguk.ukuu.org.uk)
  10  *          Thomas Sailer (sailer@ife.ee.ethz.ch)
  11  *
  12  *
  13  *   This program is free software; you can redistribute it and/or modify
  14  *   it under the terms of the GNU General Public License as published by
  15  *   the Free Software Foundation; either version 2 of the License, or
  16  *   (at your option) any later version.
  17  *
  18  *   This program is distributed in the hope that it will be useful,
  19  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  *   GNU General Public License for more details.
  22  *
  23  *   You should have received a copy of the GNU General Public License
  24  *   along with this program; if not, write to the Free Software
  25  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  26  *
  27  */
  28
  29 /*
  30  * TODOs, for both the mixer and the streaming interfaces:
  31  *
  32  *  - support for UAC2 effect units
  33  *  - support for graphical equalizers
  34  *  - RANGE and MEM set commands (UAC2)
  35  *  - RANGE and MEM interrupt dispatchers (UAC2)
  36  *  - audio channel clustering (UAC2)
  37  *  - audio sample rate converter units (UAC2)
  38  *  - proper handling of clock multipliers (UAC2)
  39  *  - dispatch clock change notifications (UAC2)
  40  *      - stop PCM streams which use a clock that became invalid
  41  *      - stop PCM streams which use a clock selector that has changed
  42  *      - parse available sample rates again when clock sources changed
  43  */
  44
  45 #include <linux/bitops.h>
  46 #include <linux/init.h>
  47 #include <linux/list.h>
  48 #include <linux/log2.h>
  49 #include <linux/slab.h>
  50 #include <linux/string.h>
  51 #include <linux/usb.h>
  52 #include <linux/usb/audio.h>
  53 #include <linux/usb/audio-v2.h>
  54
  55 #include <sound/core.h>
  56 #include <sound/control.h>
  57 #include <sound/hwdep.h>
  58 #include <sound/info.h>
  59 #include <sound/tlv.h>
  60
  61 #include "usbaudio.h"
  62 #include "mixer.h"
  63 #include "helper.h"
  64 #include "mixer_quirks.h"
  65 #include "power.h"
  66
  67 #define MAX_ID_ELEMS    256
  68
  69 struct usb_audio_term {
  70         int id;
  71         int type;
  72         int channels;
  73         unsigned int chconfig;
  74         int name;
  75 };
  76
  77 struct usbmix_name_map;
  78
  79 struct mixer_build {
  80         struct snd_usb_audio *chip;
  81         struct usb_mixer_interface *mixer;
  82         unsigned char *buffer;
  83         unsigned int buflen;
  84         DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
  85         struct usb_audio_term oterm;
  86         const struct usbmix_name_map *map;
  87         const struct usbmix_selector_map *selector_map;
  88 };
  89
  90 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
  91 enum {
  92         USB_XU_CLOCK_RATE               = 0xe301,
  93         USB_XU_CLOCK_SOURCE             = 0xe302,
  94         USB_XU_DIGITAL_IO_STATUS        = 0xe303,
  95         USB_XU_DEVICE_OPTIONS           = 0xe304,
  96         USB_XU_DIRECT_MONITORING        = 0xe305,
  97         USB_XU_METERING                 = 0xe306
  98 };
  99 enum {
 100         USB_XU_CLOCK_SOURCE_SELECTOR = 0x02,    /* clock source*/
 101         USB_XU_CLOCK_RATE_SELECTOR = 0x03,      /* clock rate */
 102         USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01,  /* the spdif format */
 103         USB_XU_SOFT_LIMIT_SELECTOR = 0x03       /* soft limiter */
 104 };
 105
 106 /*
 107  * manual mapping of mixer names
 108  * if the mixer topology is too complicated and the parsed names are
 109  * ambiguous, add the entries in usbmixer_maps.c.
 110  */
 111 #include "mixer_maps.c"
 112
 113 static const struct usbmix_name_map *
 114 find_map(struct mixer_build *state, int unitid, int control)
 115 {
 116         const struct usbmix_name_map *p = state->map;
 117
 118         if (!p)
 119                 return NULL;
 120
 121         for (p = state->map; p->id; p++) {
 122                 if (p->id == unitid &&
 123                     (!control || !p->control || control == p->control))
 124                         return p;
 125         }
 126         return NULL;
 127 }
 128
 129 /* get the mapped name if the unit matches */
 130 static int
 131 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
 132 {
 133         if (!p || !p->name)
 134                 return 0;
 135
 136         buflen--;
 137         return strlcpy(buf, p->name, buflen);
 138 }
 139
 140 /* ignore the error value if ignore_ctl_error flag is set */
 141 #define filter_error(cval, err) \
 142         ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
 143
 144 /* check whether the control should be ignored */
 145 static inline int
 146 check_ignored_ctl(const struct usbmix_name_map *p)
 147 {
 148         if (!p || p->name || p->dB)
 149                 return 0;
 150         return 1;
 151 }
 152
 153 /* dB mapping */
 154 static inline void check_mapped_dB(const struct usbmix_name_map *p,
 155                                    struct usb_mixer_elem_info *cval)
 156 {
 157         if (p && p->dB) {
 158                 cval->dBmin = p->dB->min;
 159                 cval->dBmax = p->dB->max;
 160                 cval->initialized = 1;
 161         }
 162 }
 163
 164 /* get the mapped selector source name */
 165 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
 166                                       int index, char *buf, int buflen)
 167 {
 168         const struct usbmix_selector_map *p;
 169
 170         if (!state->selector_map)
 171                 return 0;
 172         for (p = state->selector_map; p->id; p++) {
 173                 if (p->id == unitid && index < p->count)
 174                         return strlcpy(buf, p->names[index], buflen);
 175         }
 176         return 0;
 177 }
 178
 179 /*
 180  * find an audio control unit with the given unit id
 181  */
 182 static void *find_audio_control_unit(struct mixer_build *state,
 183                                      unsigned char unit)
 184 {
 185         /* we just parse the header */
 186         struct uac_feature_unit_descriptor *hdr = NULL;
 187
 188         while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
 189                                         USB_DT_CS_INTERFACE)) != NULL) {
 190                 if (hdr->bLength >= 4 &&
 191                     hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
 192                     hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
 193                     hdr->bUnitID == unit)
 194                         return hdr;
 195         }
 196
 197         return NULL;
 198 }
 199
 200 /*
 201  * copy a string with the given id
 202  */
 203 static int snd_usb_copy_string_desc(struct mixer_build *state,
 204                                     int index, char *buf, int maxlen)
 205 {
 206         int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
 207
 208         if (len < 0)
 209                 return 0;
 210
 211         buf[len] = 0;
 212         return len;
 213 }
 214
 215 /*
 216  * convert from the byte/word on usb descriptor to the zero-based integer
 217  */
 218 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
 219 {
 220         switch (cval->val_type) {
 221         case USB_MIXER_BOOLEAN:
 222                 return !!val;
 223         case USB_MIXER_INV_BOOLEAN:
 224                 return !val;
 225         case USB_MIXER_U8:
 226                 val &= 0xff;
 227                 break;
 228         case USB_MIXER_S8:
 229                 val &= 0xff;
 230                 if (val >= 0x80)
 231                         val -= 0x100;
 232                 break;
 233         case USB_MIXER_U16:
 234                 val &= 0xffff;
 235                 break;
 236         case USB_MIXER_S16:
 237                 val &= 0xffff;
 238                 if (val >= 0x8000)
 239                         val -= 0x10000;
 240                 break;
 241         }
 242         return val;
 243 }
 244
 245 /*
 246  * convert from the zero-based int to the byte/word for usb descriptor
 247  */
 248 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
 249 {
 250         switch (cval->val_type) {
 251         case USB_MIXER_BOOLEAN:
 252                 return !!val;
 253         case USB_MIXER_INV_BOOLEAN:
 254                 return !val;
 255         case USB_MIXER_S8:
 256         case USB_MIXER_U8:
 257                 return val & 0xff;
 258         case USB_MIXER_S16:
 259         case USB_MIXER_U16:
 260                 return val & 0xffff;
 261         }
 262         return 0; /* not reached */
 263 }
 264
 265 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
 266 {
 267         if (!cval->res)
 268                 cval->res = 1;
 269         if (val < cval->min)
 270                 return 0;
 271         else if (val >= cval->max)
 272                 return (cval->max - cval->min + cval->res - 1) / cval->res;
 273         else
 274                 return (val - cval->min) / cval->res;
 275 }
 276
 277 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
 278 {
 279         if (val < 0)
 280                 return cval->min;
 281         if (!cval->res)
 282                 cval->res = 1;
 283         val *= cval->res;
 284         val += cval->min;
 285         if (val > cval->max)
 286                 return cval->max;
 287         return val;
 288 }
 289
 290 static int uac2_ctl_value_size(int val_type)
 291 {
 292         switch (val_type) {
 293         case USB_MIXER_S32:
 294         case USB_MIXER_U32:
 295                 return 4;
 296         case USB_MIXER_S16:
 297         case USB_MIXER_U16:
 298                 return 2;
 299         default:
 300                 return 1;
 301         }
 302         return 0; /* unreachable */
 303 }
 304
 305
 306 /*
 307  * retrieve a mixer value
 308  */
 309
 310 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
 311                             int validx, int *value_ret)
 312 {
 313         struct snd_usb_audio *chip = cval->head.mixer->chip;
 314         unsigned char buf[2];
 315         int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
 316         int timeout = 10;
 317         int idx = 0, err;
 318
 319         err = snd_usb_lock_shutdown(chip);
 320         if (err < 0)
 321                 return -EIO;
 322
 323         while (timeout-- > 0) {
 324                 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
 325                 err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
 326                                       USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
 327                                       validx, idx, buf, val_len);
 328                 if (err >= val_len) {
 329                         *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
 330                         err = 0;
 331                         goto out;
 332                 } else if (err == -ETIMEDOUT) {
 333                         goto out;
 334                 }
 335         }
 336         usb_audio_dbg(chip,
 337                 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
 338                 request, validx, idx, cval->val_type);
 339         err = -EINVAL;
 340
 341  out:
 342         snd_usb_unlock_shutdown(chip);
 343         return err;
 344 }
 345
 346 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
 347                             int validx, int *value_ret)
 348 {
 349         struct snd_usb_audio *chip = cval->head.mixer->chip;
 350         /* enough space for one range */
 351         unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
 352         unsigned char *val;
 353         int idx = 0, ret, val_size, size;
 354         __u8 bRequest;
 355
 356         val_size = uac2_ctl_value_size(cval->val_type);
 357
 358         if (request == UAC_GET_CUR) {
 359                 bRequest = UAC2_CS_CUR;
 360                 size = val_size;
 361         } else {
 362                 bRequest = UAC2_CS_RANGE;
 363                 size = sizeof(__u16) + 3 * val_size;
 364         }
 365
 366         memset(buf, 0, sizeof(buf));
 367
 368         ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
 369         if (ret)
 370                 goto error;
 371
 372         idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
 373         ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
 374                               USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
 375                               validx, idx, buf, size);
 376         snd_usb_unlock_shutdown(chip);
 377
 378         if (ret < 0) {
 379 error:
 380                 usb_audio_err(chip,
 381                         "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
 382                         request, validx, idx, cval->val_type);
 383                 return ret;
 384         }
 385
 386         /* FIXME: how should we handle multiple triplets here? */
 387
 388         switch (request) {
 389         case UAC_GET_CUR:
 390                 val = buf;
 391                 break;
 392         case UAC_GET_MIN:
 393                 val = buf + sizeof(__u16);
 394                 break;
 395         case UAC_GET_MAX:
 396                 val = buf + sizeof(__u16) + val_size;
 397                 break;
 398         case UAC_GET_RES:
 399                 val = buf + sizeof(__u16) + val_size * 2;
 400                 break;
 401         default:
 402                 return -EINVAL;
 403         }
 404
 405         *value_ret = convert_signed_value(cval,
 406                                           snd_usb_combine_bytes(val, val_size));
 407
 408         return 0;
 409 }
 410
 411 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
 412                          int validx, int *value_ret)
 413 {
 414         validx += cval->idx_off;
 415
 416         return (cval->head.mixer->protocol == UAC_VERSION_1) ?
 417                 get_ctl_value_v1(cval, request, validx, value_ret) :
 418                 get_ctl_value_v2(cval, request, validx, value_ret);
 419 }
 420
 421 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
 422                              int validx, int *value)
 423 {
 424         return get_ctl_value(cval, UAC_GET_CUR, validx, value);
 425 }
 426
 427 /* channel = 0: master, 1 = first channel */
 428 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
 429                                   int channel, int *value)
 430 {
 431         return get_ctl_value(cval, UAC_GET_CUR,
 432                              (cval->control << 8) | channel,
 433                              value);
 434 }
 435
 436 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
 437                              int channel, int index, int *value)
 438 {
 439         int err;
 440
 441         if (cval->cached & (1 << channel)) {
 442                 *value = cval->cache_val[index];
 443                 return 0;
 444         }
 445         err = get_cur_mix_raw(cval, channel, value);
 446         if (err < 0) {
 447                 if (!cval->head.mixer->ignore_ctl_error)
 448                         usb_audio_dbg(cval->head.mixer->chip,
 449                                 "cannot get current value for control %d ch %d: err = %d\n",
 450                                       cval->control, channel, err);
 451                 return err;
 452         }
 453         cval->cached |= 1 << channel;
 454         cval->cache_val[index] = *value;
 455         return 0;
 456 }
 457
 458 /*
 459  * set a mixer value
 460  */
 461
 462 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
 463                                 int request, int validx, int value_set)
 464 {
 465         struct snd_usb_audio *chip = cval->head.mixer->chip;
 466         unsigned char buf[4];
 467         int idx = 0, val_len, err, timeout = 10;
 468
 469         validx += cval->idx_off;
 470
 471         if (cval->head.mixer->protocol == UAC_VERSION_1) {
 472                 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
 473         } else { /* UAC_VERSION_2 */
 474                 val_len = uac2_ctl_value_size(cval->val_type);
 475
 476                 /* FIXME */
 477                 if (request != UAC_SET_CUR) {
 478                         usb_audio_dbg(chip, "RANGE setting not yet supported\n");
 479                         return -EINVAL;
 480                 }
 481
 482                 request = UAC2_CS_CUR;
 483         }
 484
 485         value_set = convert_bytes_value(cval, value_set);
 486         buf[0] = value_set & 0xff;
 487         buf[1] = (value_set >> 8) & 0xff;
 488         buf[2] = (value_set >> 16) & 0xff;
 489         buf[3] = (value_set >> 24) & 0xff;
 490
 491         err = snd_usb_lock_shutdown(chip);
 492         if (err < 0)
 493                 return -EIO;
 494
 495         while (timeout-- > 0) {
 496                 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
 497                 err = snd_usb_ctl_msg(chip->dev,
 498                                       usb_sndctrlpipe(chip->dev, 0), request,
 499                                       USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
 500                                       validx, idx, buf, val_len);
 501                 if (err >= 0) {
 502                         err = 0;
 503                         goto out;
 504                 } else if (err == -ETIMEDOUT) {
 505                         goto out;
 506                 }
 507         }
 508         usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
 509                       request, validx, idx, cval->val_type, buf[0], buf[1]);
 510         err = -EINVAL;
 511
 512  out:
 513         snd_usb_unlock_shutdown(chip);
 514         return err;
 515 }
 516
 517 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
 518                              int validx, int value)
 519 {
 520         return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
 521 }
 522
 523 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
 524                              int index, int value)
 525 {
 526         int err;
 527         unsigned int read_only = (channel == 0) ?
 528                 cval->master_readonly :
 529                 cval->ch_readonly & (1 << (channel - 1));
 530
 531         if (read_only) {
 532                 usb_audio_dbg(cval->head.mixer->chip,
 533                               "%s(): channel %d of control %d is read_only\n",
 534                             __func__, channel, cval->control);
 535                 return 0;
 536         }
 537
 538         err = snd_usb_mixer_set_ctl_value(cval,
 539                                           UAC_SET_CUR, (cval->control << 8) | channel,
 540                                           value);
 541         if (err < 0)
 542                 return err;
 543         cval->cached |= 1 << channel;
 544         cval->cache_val[index] = value;
 545         return 0;
 546 }
 547
 548 /*
 549  * TLV callback for mixer volume controls
 550  */
 551 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
 552                          unsigned int size, unsigned int __user *_tlv)
 553 {
 554         struct usb_mixer_elem_info *cval = kcontrol->private_data;
 555         DECLARE_TLV_DB_MINMAX(scale, 0, 0);
 556
 557         if (size < sizeof(scale))
 558                 return -ENOMEM;
 559         if (cval->min_mute)
 560                 scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE;
 561         scale[2] = cval->dBmin;
 562         scale[3] = cval->dBmax;
 563         if (copy_to_user(_tlv, scale, sizeof(scale)))
 564                 return -EFAULT;
 565         return 0;
 566 }
 567
 568 /*
 569  * parser routines begin here...
 570  */
 571
 572 static int parse_audio_unit(struct mixer_build *state, int unitid);
 573
 574
 575 /*
 576  * check if the input/output channel routing is enabled on the given bitmap.
 577  * used for mixer unit parser
 578  */
 579 static int check_matrix_bitmap(unsigned char *bmap,
 580                                int ich, int och, int num_outs)
 581 {
 582         int idx = ich * num_outs + och;
 583         return bmap[idx >> 3] & (0x80 >> (idx & 7));
 584 }
 585
 586 /*
 587  * add an alsa control element
 588  * search and increment the index until an empty slot is found.
 589  *
 590  * if failed, give up and free the control instance.
 591  */
 592
 593 int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
 594                               struct snd_kcontrol *kctl)
 595 {
 596         struct usb_mixer_interface *mixer = list->mixer;
 597         int err;
 598
 599         while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
 600                 kctl->id.index++;
 601         if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
 602                 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
 603                               err);
 604                 return err;
 605         }
 606         list->kctl = kctl;
 607         list->next_id_elem = mixer->id_elems[list->id];
 608         mixer->id_elems[list->id] = list;
 609         return 0;
 610 }
 611
 612 /*
 613  * get a terminal name string
 614  */
 615
 616 static struct iterm_name_combo {
 617         int type;
 618         char *name;
 619 } iterm_names[] = {
 620         { 0x0300, "Output" },
 621         { 0x0301, "Speaker" },
 622         { 0x0302, "Headphone" },
 623         { 0x0303, "HMD Audio" },
 624         { 0x0304, "Desktop Speaker" },
 625         { 0x0305, "Room Speaker" },
 626         { 0x0306, "Com Speaker" },
 627         { 0x0307, "LFE" },
 628         { 0x0600, "External In" },
 629         { 0x0601, "Analog In" },
 630         { 0x0602, "Digital In" },
 631         { 0x0603, "Line" },
 632         { 0x0604, "Legacy In" },
 633         { 0x0605, "IEC958 In" },
 634         { 0x0606, "1394 DA Stream" },
 635         { 0x0607, "1394 DV Stream" },
 636         { 0x0700, "Embedded" },
 637         { 0x0701, "Noise Source" },
 638         { 0x0702, "Equalization Noise" },
 639         { 0x0703, "CD" },
 640         { 0x0704, "DAT" },
 641         { 0x0705, "DCC" },
 642         { 0x0706, "MiniDisk" },
 643         { 0x0707, "Analog Tape" },
 644         { 0x0708, "Phonograph" },
 645         { 0x0709, "VCR Audio" },
 646         { 0x070a, "Video Disk Audio" },
 647         { 0x070b, "DVD Audio" },
 648         { 0x070c, "TV Tuner Audio" },
 649         { 0x070d, "Satellite Rec Audio" },
 650         { 0x070e, "Cable Tuner Audio" },
 651         { 0x070f, "DSS Audio" },
 652         { 0x0710, "Radio Receiver" },
 653         { 0x0711, "Radio Transmitter" },
 654         { 0x0712, "Multi-Track Recorder" },
 655         { 0x0713, "Synthesizer" },
 656         { 0 },
 657 };
 658
 659 static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
 660                          unsigned char *name, int maxlen, int term_only)
 661 {
 662         struct iterm_name_combo *names;
 663
 664         if (iterm->name)
 665                 return snd_usb_copy_string_desc(state, iterm->name,
 666                                                 name, maxlen);
 667
 668         /* virtual type - not a real terminal */
 669         if (iterm->type >> 16) {
 670                 if (term_only)
 671                         return 0;
 672                 switch (iterm->type >> 16) {
 673                 case UAC_SELECTOR_UNIT:
 674                         strcpy(name, "Selector");
 675                         return 8;
 676                 case UAC1_PROCESSING_UNIT:
 677                         strcpy(name, "Process Unit");
 678                         return 12;
 679                 case UAC1_EXTENSION_UNIT:
 680                         strcpy(name, "Ext Unit");
 681                         return 8;
 682                 case UAC_MIXER_UNIT:
 683                         strcpy(name, "Mixer");
 684                         return 5;
 685                 default:
 686                         return sprintf(name, "Unit %d", iterm->id);
 687                 }
 688         }
 689
 690         switch (iterm->type & 0xff00) {
 691         case 0x0100:
 692                 strcpy(name, "PCM");
 693                 return 3;
 694         case 0x0200:
 695                 strcpy(name, "Mic");
 696                 return 3;
 697         case 0x0400:
 698                 strcpy(name, "Headset");
 699                 return 7;
 700         case 0x0500:
 701                 strcpy(name, "Phone");
 702                 return 5;
 703         }
 704
 705         for (names = iterm_names; names->type; names++) {
 706                 if (names->type == iterm->type) {
 707                         strcpy(name, names->name);
 708                         return strlen(names->name);
 709                 }
 710         }
 711
 712         return 0;
 713 }
 714
 715 /*
 716  * parse the source unit recursively until it reaches to a terminal
 717  * or a branched unit.
 718  */
 719 static int check_input_term(struct mixer_build *state, int id,
 720                             struct usb_audio_term *term)
 721 {
 722         int err;
 723         void *p1;
 724
 725         memset(term, 0, sizeof(*term));
 726         while ((p1 = find_audio_control_unit(state, id)) != NULL) {
 727                 unsigned char *hdr = p1;
 728                 term->id = id;
 729                 switch (hdr[2]) {
 730                 case UAC_INPUT_TERMINAL:
 731                         if (state->mixer->protocol == UAC_VERSION_1) {
 732                                 struct uac_input_terminal_descriptor *d = p1;
 733                                 term->type = le16_to_cpu(d->wTerminalType);
 734                                 term->channels = d->bNrChannels;
 735                                 term->chconfig = le16_to_cpu(d->wChannelConfig);
 736                                 term->name = d->iTerminal;
 737                         } else { /* UAC_VERSION_2 */
 738                                 struct uac2_input_terminal_descriptor *d = p1;
 739
 740                                 /* call recursively to verify that the
 741                                  * referenced clock entity is valid */
 742                                 err = check_input_term(state, d->bCSourceID, term);
 743                                 if (err < 0)
 744                                         return err;
 745
 746                                 /* save input term properties after recursion,
 747                                  * to ensure they are not overriden by the
 748                                  * recursion calls */
 749                                 term->id = id;
 750                                 term->type = le16_to_cpu(d->wTerminalType);
 751                                 term->channels = d->bNrChannels;
 752                                 term->chconfig = le32_to_cpu(d->bmChannelConfig);
 753                                 term->name = d->iTerminal;
 754                         }
 755                         return 0;
 756                 case UAC_FEATURE_UNIT: {
 757                         /* the header is the same for v1 and v2 */
 758                         struct uac_feature_unit_descriptor *d = p1;
 759                         id = d->bSourceID;
 760                         break; /* continue to parse */
 761                 }
 762                 case UAC_MIXER_UNIT: {
 763                         struct uac_mixer_unit_descriptor *d = p1;
 764                         term->type = d->bDescriptorSubtype << 16; /* virtual type */
 765                         term->channels = uac_mixer_unit_bNrChannels(d);
 766                         term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
 767                         term->name = uac_mixer_unit_iMixer(d);
 768                         return 0;
 769                 }
 770                 case UAC_SELECTOR_UNIT:
 771                 case UAC2_CLOCK_SELECTOR: {
 772                         struct uac_selector_unit_descriptor *d = p1;
 773                         /* call recursively to retrieve the channel info */
 774                         err = check_input_term(state, d->baSourceID[0], term);
 775                         if (err < 0)
 776                                 return err;
 777                         term->type = d->bDescriptorSubtype << 16; /* virtual type */
 778                         term->id = id;
 779                         term->name = uac_selector_unit_iSelector(d);
 780                         return 0;
 781                 }
 782                 case UAC1_PROCESSING_UNIT:
 783                 case UAC1_EXTENSION_UNIT:
 784                 /* UAC2_PROCESSING_UNIT_V2 */
 785                 /* UAC2_EFFECT_UNIT */
 786                 case UAC2_EXTENSION_UNIT_V2: {
 787                         struct uac_processing_unit_descriptor *d = p1;
 788
 789                         if (state->mixer->protocol == UAC_VERSION_2 &&
 790                                 hdr[2] == UAC2_EFFECT_UNIT) {
 791                                 /* UAC2/UAC1 unit IDs overlap here in an
 792                                  * uncompatible way. Ignore this unit for now.
 793                                  */
 794                                 return 0;
 795                         }
 796
 797                         if (d->bNrInPins) {
 798                                 id = d->baSourceID[0];
 799                                 break; /* continue to parse */
 800                         }
 801                         term->type = d->bDescriptorSubtype << 16; /* virtual type */
 802                         term->channels = uac_processing_unit_bNrChannels(d);
 803                         term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
 804                         term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
 805                         return 0;
 806                 }
 807                 case UAC2_CLOCK_SOURCE: {
 808                         struct uac_clock_source_descriptor *d = p1;
 809                         term->type = d->bDescriptorSubtype << 16; /* virtual type */
 810                         term->id = id;
 811                         term->name = d->iClockSource;
 812                         return 0;
 813                 }
 814                 default:
 815                         return -ENODEV;
 816                 }
 817         }
 818         return -ENODEV;
 819 }
 820
 821 /*
 822  * Feature Unit
 823  */
 824
 825 /* feature unit control information */
 826 struct usb_feature_control_info {
 827         const char *name;
 828         int type;       /* data type for uac1 */
 829         int type_uac2;  /* data type for uac2 if different from uac1, else -1 */
 830 };
 831
 832 static struct usb_feature_control_info audio_feature_info[] = {
 833         { "Mute",                       USB_MIXER_INV_BOOLEAN, -1 },
 834         { "Volume",                     USB_MIXER_S16, -1 },
 835         { "Tone Control - Bass",        USB_MIXER_S8, -1 },
 836         { "Tone Control - Mid",         USB_MIXER_S8, -1 },
 837         { "Tone Control - Treble",      USB_MIXER_S8, -1 },
 838         { "Graphic Equalizer",          USB_MIXER_S8, -1 }, /* FIXME: not implemeted yet */
 839         { "Auto Gain Control",          USB_MIXER_BOOLEAN, -1 },
 840         { "Delay Control",              USB_MIXER_U16, USB_MIXER_U32 },
 841         { "Bass Boost",                 USB_MIXER_BOOLEAN, -1 },
 842         { "Loudness",                   USB_MIXER_BOOLEAN, -1 },
 843         /* UAC2 specific */
 844         { "Input Gain Control",         USB_MIXER_S16, -1 },
 845         { "Input Gain Pad Control",     USB_MIXER_S16, -1 },
 846         { "Phase Inverter Control",     USB_MIXER_BOOLEAN, -1 },
 847 };
 848
 849 /* private_free callback */
 850 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
 851 {
 852         kfree(kctl->private_data);
 853         kctl->private_data = NULL;
 854 }
 855
 856 /*
 857  * interface to ALSA control for feature/mixer units
 858  */
 859
 860 /* volume control quirks */
 861 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
 862                                   struct snd_kcontrol *kctl)
 863 {
 864         struct snd_usb_audio *chip = cval->head.mixer->chip;
 865         switch (chip->usb_id) {
 866         case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
 867         case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
 868                 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
 869                         cval->min = 0x0000;
 870                         cval->max = 0xffff;
 871                         cval->res = 0x00e6;
 872                         break;
 873                 }
 874                 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
 875                     strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
 876                         cval->min = 0x00;
 877                         cval->max = 0xff;
 878                         break;
 879                 }
 880                 if (strstr(kctl->id.name, "Effect Return") != NULL) {
 881                         cval->min = 0xb706;
 882                         cval->max = 0xff7b;
 883                         cval->res = 0x0073;
 884                         break;
 885                 }
 886                 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
 887                         (strstr(kctl->id.name, "Effect Send") != NULL)) {
 888                         cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
 889                         cval->max = 0xfcfe;
 890                         cval->res = 0x0073;
 891                 }
 892                 break;
 893
 894         case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
 895         case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
 896                 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
 897                         usb_audio_info(chip,
 898                                        "set quirk for FTU Effect Duration\n");
 899                         cval->min = 0x0000;
 900                         cval->max = 0x7f00;
 901                         cval->res = 0x0100;
 902                         break;
 903                 }
 904                 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
 905                     strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
 906                         usb_audio_info(chip,
 907                                        "set quirks for FTU Effect Feedback/Volume\n");
 908                         cval->min = 0x00;
 909                         cval->max = 0x7f;
 910                         break;
 911                 }
 912                 break;
 913
 914         case USB_ID(0x0d8c, 0x0103):
 915                 if (!strcmp(kctl->id.name, "PCM Playback Volume")) {
 916                         usb_audio_info(chip,
 917                                  "set volume quirk for CM102-A+/102S+\n");
 918                         cval->min = -256;
 919                 }
 920                 break;
 921
 922         case USB_ID(0x0471, 0x0101):
 923         case USB_ID(0x0471, 0x0104):
 924         case USB_ID(0x0471, 0x0105):
 925         case USB_ID(0x0672, 0x1041):
 926         /* quirk for UDA1321/N101.
 927          * note that detection between firmware 2.1.1.7 (N101)
 928          * and later 2.1.1.21 is not very clear from datasheets.
 929          * I hope that the min value is -15360 for newer firmware --jk
 930          */
 931                 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
 932                     cval->min == -15616) {
 933                         usb_audio_info(chip,
 934                                  "set volume quirk for UDA1321/N101 chip\n");
 935                         cval->max = -256;
 936                 }
 937                 break;
 938
 939         case USB_ID(0x046d, 0x09a4):
 940                 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
 941                         usb_audio_info(chip,
 942                                 "set volume quirk for QuickCam E3500\n");
 943                         cval->min = 6080;
 944                         cval->max = 8768;
 945                         cval->res = 192;
 946                 }
 947                 break;
 948
 949         case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
 950         case USB_ID(0x046d, 0x0808):
 951         case USB_ID(0x046d, 0x0809):
 952         case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
 953         case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
 954         case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
 955         case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
 956         case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
 957         case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
 958         case USB_ID(0x046d, 0x0991):
 959         case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
 960         /* Most audio usb devices lie about volume resolution.
 961          * Most Logitech webcams have res = 384.
 962          * Probably there is some logitech magic behind this number --fishor
 963          */
 964                 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
 965                         usb_audio_info(chip,
 966                                 "set resolution quirk: cval->res = 384\n");
 967                         cval->res = 384;
 968                 }
 969                 break;
 970         }
 971 }
 972
 973 /*
 974  * retrieve the minimum and maximum values for the specified control
 975  */
 976 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
 977                                    int default_min, struct snd_kcontrol *kctl)
 978 {
 979         /* for failsafe */
 980         cval->min = default_min;
 981         cval->max = cval->min + 1;
 982         cval->res = 1;
 983         cval->dBmin = cval->dBmax = 0;
 984
 985         if (cval->val_type == USB_MIXER_BOOLEAN ||
 986             cval->val_type == USB_MIXER_INV_BOOLEAN) {
 987                 cval->initialized = 1;
 988         } else {
 989                 int minchn = 0;
 990                 if (cval->cmask) {
 991                         int i;
 992                         for (i = 0; i < MAX_CHANNELS; i++)
 993                                 if (cval->cmask & (1 << i)) {
 994                                         minchn = i + 1;
 995                                         break;
 996                                 }
 997                 }
 998                 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
 999                     get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1000                         usb_audio_err(cval->head.mixer->chip,
1001                                       "%d:%d: cannot get min/max values for control %d (id %d)\n",
1002                                    cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
1003                                                                cval->control, cval->head.id);
1004                         return -EINVAL;
1005                 }
1006                 if (get_ctl_value(cval, UAC_GET_RES,
1007                                   (cval->control << 8) | minchn,
1008                                   &cval->res) < 0) {
1009                         cval->res = 1;
1010                 } else {
1011                         int last_valid_res = cval->res;
1012
1013                         while (cval->res > 1) {
1014                                 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1015                                                                 (cval->control << 8) | minchn,
1016                                                                 cval->res / 2) < 0)
1017                                         break;
1018                                 cval->res /= 2;
1019                         }
1020                         if (get_ctl_value(cval, UAC_GET_RES,
1021                                           (cval->control << 8) | minchn, &cval->res) < 0)
1022                                 cval->res = last_valid_res;
1023                 }
1024                 if (cval->res == 0)
1025                         cval->res = 1;
1026
1027                 /* Additional checks for the proper resolution
1028                  *
1029                  * Some devices report smaller resolutions than actually
1030                  * reacting.  They don't return errors but simply clip
1031                  * to the lower aligned value.
1032                  */
1033                 if (cval->min + cval->res < cval->max) {
1034                         int last_valid_res = cval->res;
1035                         int saved, test, check;
1036                         get_cur_mix_raw(cval, minchn, &saved);
1037                         for (;;) {
1038                                 test = saved;
1039                                 if (test < cval->max)
1040                                         test += cval->res;
1041                                 else
1042                                         test -= cval->res;
1043                                 if (test < cval->min || test > cval->max ||
1044                                     snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1045                                     get_cur_mix_raw(cval, minchn, &check)) {
1046                                         cval->res = last_valid_res;
1047                                         break;
1048                                 }
1049                                 if (test == check)
1050                                         break;
1051                                 cval->res *= 2;
1052                         }
1053                         snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1054                 }
1055
1056                 cval->initialized = 1;
1057         }
1058
1059         if (kctl)
1060                 volume_control_quirks(cval, kctl);
1061
1062         /* USB descriptions contain the dB scale in 1/256 dB unit
1063          * while ALSA TLV contains in 1/100 dB unit
1064          */
1065         cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1066         cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1067         if (cval->dBmin > cval->dBmax) {
1068                 /* something is wrong; assume it's either from/to 0dB */
1069                 if (cval->dBmin < 0)
1070                         cval->dBmax = 0;
1071                 else if (cval->dBmin > 0)
1072                         cval->dBmin = 0;
1073                 if (cval->dBmin > cval->dBmax) {
1074                         /* totally crap, return an error */
1075                         return -EINVAL;
1076                 }
1077         }
1078
1079         return 0;
1080 }
1081
1082 #define get_min_max(cval, def)  get_min_max_with_quirks(cval, def, NULL)
1083
1084 /* get a feature/mixer unit info */
1085 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1086                                   struct snd_ctl_elem_info *uinfo)
1087 {
1088         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1089
1090         if (cval->val_type == USB_MIXER_BOOLEAN ||
1091             cval->val_type == USB_MIXER_INV_BOOLEAN)
1092                 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1093         else
1094                 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1095         uinfo->count = cval->channels;
1096         if (cval->val_type == USB_MIXER_BOOLEAN ||
1097             cval->val_type == USB_MIXER_INV_BOOLEAN) {
1098                 uinfo->value.integer.min = 0;
1099                 uinfo->value.integer.max = 1;
1100         } else {
1101                 if (!cval->initialized) {
1102                         get_min_max_with_quirks(cval, 0, kcontrol);
1103                         if (cval->initialized && cval->dBmin >= cval->dBmax) {
1104                                 kcontrol->vd[0].access &=
1105                                         ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1106                                           SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1107                                 snd_ctl_notify(cval->head.mixer->chip->card,
1108                                                SNDRV_CTL_EVENT_MASK_INFO,
1109                                                &kcontrol->id);
1110                         }
1111                 }
1112                 uinfo->value.integer.min = 0;
1113                 uinfo->value.integer.max =
1114                         (cval->max - cval->min + cval->res - 1) / cval->res;
1115         }
1116         return 0;
1117 }
1118
1119 /* get the current value from feature/mixer unit */
1120 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1121                                  struct snd_ctl_elem_value *ucontrol)
1122 {
1123         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1124         int c, cnt, val, err;
1125
1126         ucontrol->value.integer.value[0] = cval->min;
1127         if (cval->cmask) {
1128                 cnt = 0;
1129                 for (c = 0; c < MAX_CHANNELS; c++) {
1130                         if (!(cval->cmask & (1 << c)))
1131                                 continue;
1132                         err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1133                         if (err < 0)
1134                                 return filter_error(cval, err);
1135                         val = get_relative_value(cval, val);
1136                         ucontrol->value.integer.value[cnt] = val;
1137                         cnt++;
1138                 }
1139                 return 0;
1140         } else {
1141                 /* master channel */
1142                 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1143                 if (err < 0)
1144                         return filter_error(cval, err);
1145                 val = get_relative_value(cval, val);
1146                 ucontrol->value.integer.value[0] = val;
1147         }
1148         return 0;
1149 }
1150
1151 /* put the current value to feature/mixer unit */
1152 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1153                                  struct snd_ctl_elem_value *ucontrol)
1154 {
1155         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1156         int c, cnt, val, oval, err;
1157         int changed = 0;
1158
1159         if (cval->cmask) {
1160                 cnt = 0;
1161                 for (c = 0; c < MAX_CHANNELS; c++) {
1162                         if (!(cval->cmask & (1 << c)))
1163                                 continue;
1164                         err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1165                         if (err < 0)
1166                                 return filter_error(cval, err);
1167                         val = ucontrol->value.integer.value[cnt];
1168                         val = get_abs_value(cval, val);
1169                         if (oval != val) {
1170                                 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1171                                 changed = 1;
1172                         }
1173                         cnt++;
1174                 }
1175         } else {
1176                 /* master channel */
1177                 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1178                 if (err < 0)
1179                         return filter_error(cval, err);
1180                 val = ucontrol->value.integer.value[0];
1181                 val = get_abs_value(cval, val);
1182                 if (val != oval) {
1183                         snd_usb_set_cur_mix_value(cval, 0, 0, val);
1184                         changed = 1;
1185                 }
1186         }
1187         return changed;
1188 }
1189
1190 static struct snd_kcontrol_new usb_feature_unit_ctl = {
1191         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1192         .name = "", /* will be filled later manually */
1193         .info = mixer_ctl_feature_info,
1194         .get = mixer_ctl_feature_get,
1195         .put = mixer_ctl_feature_put,
1196 };
1197
1198 /* the read-only variant */
1199 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1200         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1201         .name = "", /* will be filled later manually */
1202         .info = mixer_ctl_feature_info,
1203         .get = mixer_ctl_feature_get,
1204         .put = NULL,
1205 };
1206
1207 /*
1208  * This symbol is exported in order to allow the mixer quirks to
1209  * hook up to the standard feature unit control mechanism
1210  */
1211 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1212
1213 /*
1214  * build a feature control
1215  */
1216 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1217 {
1218         return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1219 }
1220
1221 /*
1222  * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1223  * rename it to "Headphone". We determine if something is a headphone
1224  * similar to how udev determines form factor.
1225  */
1226 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1227                                         struct snd_card *card)
1228 {
1229         const char *names_to_check[] = {
1230                 "Headset", "headset", "Headphone", "headphone", NULL};
1231         const char **s;
1232         bool found = false;
1233
1234         if (strcmp("Speaker", kctl->id.name))
1235                 return;
1236
1237         for (s = names_to_check; *s; s++)
1238                 if (strstr(card->shortname, *s)) {
1239                         found = true;
1240                         break;
1241                 }
1242
1243         if (!found)
1244                 return;
1245
1246         strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1247 }
1248
1249 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1250                               unsigned int ctl_mask, int control,
1251                               struct usb_audio_term *iterm, int unitid,
1252                               int readonly_mask)
1253 {
1254         struct uac_feature_unit_descriptor *desc = raw_desc;
1255         struct usb_feature_control_info *ctl_info;
1256         unsigned int len = 0;
1257         int mapped_name = 0;
1258         int nameid = uac_feature_unit_iFeature(desc);
1259         struct snd_kcontrol *kctl;
1260         struct usb_mixer_elem_info *cval;
1261         const struct usbmix_name_map *map;
1262         unsigned int range;
1263
1264         control++; /* change from zero-based to 1-based value */
1265
1266         if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1267                 /* FIXME: not supported yet */
1268                 return;
1269         }
1270
1271         map = find_map(state, unitid, control);
1272         if (check_ignored_ctl(map))
1273                 return;
1274
1275         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1276         if (!cval)
1277                 return;
1278         snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1279         cval->control = control;
1280         cval->cmask = ctl_mask;
1281         ctl_info = &audio_feature_info[control-1];
1282         if (state->mixer->protocol == UAC_VERSION_1)
1283                 cval->val_type = ctl_info->type;
1284         else /* UAC_VERSION_2 */
1285                 cval->val_type = ctl_info->type_uac2 >= 0 ?
1286                         ctl_info->type_uac2 : ctl_info->type;
1287
1288         if (ctl_mask == 0) {
1289                 cval->channels = 1;     /* master channel */
1290                 cval->master_readonly = readonly_mask;
1291         } else {
1292                 int i, c = 0;
1293                 for (i = 0; i < 16; i++)
1294                         if (ctl_mask & (1 << i))
1295                                 c++;
1296                 cval->channels = c;
1297                 cval->ch_readonly = readonly_mask;
1298         }
1299
1300         /*
1301          * If all channels in the mask are marked read-only, make the control
1302          * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1303          * issue write commands to read-only channels.
1304          */
1305         if (cval->channels == readonly_mask)
1306                 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1307         else
1308                 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1309
1310         if (!kctl) {
1311                 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1312                 kfree(cval);
1313                 return;
1314         }
1315         kctl->private_free = snd_usb_mixer_elem_free;
1316
1317         len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1318         mapped_name = len != 0;
1319         if (!len && nameid)
1320                 len = snd_usb_copy_string_desc(state, nameid,
1321                                 kctl->id.name, sizeof(kctl->id.name));
1322
1323         switch (control) {
1324         case UAC_FU_MUTE:
1325         case UAC_FU_VOLUME:
1326                 /*
1327                  * determine the control name.  the rule is:
1328                  * - if a name id is given in descriptor, use it.
1329                  * - if the connected input can be determined, then use the name
1330                  *   of terminal type.
1331                  * - if the connected output can be determined, use it.
1332                  * - otherwise, anonymous name.
1333                  */
1334                 if (!len) {
1335                         len = get_term_name(state, iterm, kctl->id.name,
1336                                             sizeof(kctl->id.name), 1);
1337                         if (!len)
1338                                 len = get_term_name(state, &state->oterm,
1339                                                     kctl->id.name,
1340                                                     sizeof(kctl->id.name), 1);
1341                         if (!len)
1342                                 snprintf(kctl->id.name, sizeof(kctl->id.name),
1343                                          "Feature %d", unitid);
1344                 }
1345
1346                 if (!mapped_name)
1347                         check_no_speaker_on_headset(kctl, state->mixer->chip->card);
1348
1349                 /*
1350                  * determine the stream direction:
1351                  * if the connected output is USB stream, then it's likely a
1352                  * capture stream.  otherwise it should be playback (hopefully :)
1353                  */
1354                 if (!mapped_name && !(state->oterm.type >> 16)) {
1355                         if ((state->oterm.type & 0xff00) == 0x0100)
1356                                 append_ctl_name(kctl, " Capture");
1357                         else
1358                                 append_ctl_name(kctl, " Playback");
1359                 }
1360                 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1361                                 " Switch" : " Volume");
1362                 break;
1363         default:
1364                 if (!len)
1365                         strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1366                                 sizeof(kctl->id.name));
1367                 break;
1368         }
1369
1370         /* get min/max values */
1371         get_min_max_with_quirks(cval, 0, kctl);
1372
1373         if (control == UAC_FU_VOLUME) {
1374                 check_mapped_dB(map, cval);
1375                 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1376                         kctl->tlv.c = snd_usb_mixer_vol_tlv;
1377                         kctl->vd[0].access |=
1378                                 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1379                                 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1380                 }
1381         }
1382
1383         snd_usb_mixer_fu_apply_quirk(state->mixer, cval, unitid, kctl);
1384
1385         range = (cval->max - cval->min) / cval->res;
1386         /*
1387          * Are there devices with volume range more than 255? I use a bit more
1388          * to be sure. 384 is a resolution magic number found on Logitech
1389          * devices. It will definitively catch all buggy Logitech devices.
1390          */
1391         if (range > 384) {
1392                 usb_audio_warn(state->chip,
1393                                "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1394                                range);
1395                 usb_audio_warn(state->chip,
1396                                "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1397                                cval->head.id, kctl->id.name, cval->channels,
1398                                cval->min, cval->max, cval->res);
1399         }
1400
1401         usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1402                       cval->head.id, kctl->id.name, cval->channels,
1403                       cval->min, cval->max, cval->res);
1404         snd_usb_mixer_add_control(&cval->head, kctl);
1405 }
1406
1407 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1408                                    void *_ftr)
1409 {
1410         struct uac_clock_source_descriptor *hdr = _ftr;
1411         struct usb_mixer_elem_info *cval;
1412         struct snd_kcontrol *kctl;
1413         char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1414         int ret;
1415
1416         if (state->mixer->protocol != UAC_VERSION_2)
1417                 return -EINVAL;
1418
1419         if (hdr->bLength != sizeof(*hdr)) {
1420                 usb_audio_dbg(state->chip,
1421                               "Bogus clock source descriptor length of %d, ignoring.\n",
1422                               hdr->bLength);
1423                 return 0;
1424         }
1425
1426         /*
1427          * The only property of this unit we are interested in is the
1428          * clock source validity. If that isn't readable, just bail out.
1429          */
1430         if (!uac2_control_is_readable(hdr->bmControls,
1431                                       ilog2(UAC2_CS_CONTROL_CLOCK_VALID)))
1432                 return 0;
1433
1434         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1435         if (!cval)
1436                 return -ENOMEM;
1437
1438         snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1439
1440         cval->min = 0;
1441         cval->max = 1;
1442         cval->channels = 1;
1443         cval->val_type = USB_MIXER_BOOLEAN;
1444         cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1445
1446         if (uac2_control_is_writeable(hdr->bmControls,
1447                                       ilog2(UAC2_CS_CONTROL_CLOCK_VALID)))
1448                 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1449         else {
1450                 cval->master_readonly = 1;
1451                 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1452         }
1453
1454         if (!kctl) {
1455                 kfree(cval);
1456                 return -ENOMEM;
1457         }
1458
1459         kctl->private_free = snd_usb_mixer_elem_free;
1460         ret = snd_usb_copy_string_desc(state, hdr->iClockSource,
1461                                        name, sizeof(name));
1462         if (ret > 0)
1463                 snprintf(kctl->id.name, sizeof(kctl->id.name),
1464                          "%s Validity", name);
1465         else
1466                 snprintf(kctl->id.name, sizeof(kctl->id.name),
1467                          "Clock Source %d Validity", hdr->bClockID);
1468
1469         return snd_usb_mixer_add_control(&cval->head, kctl);
1470 }
1471
1472 /*
1473  * parse a feature unit
1474  *
1475  * most of controls are defined here.
1476  */
1477 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1478                                     void *_ftr)
1479 {
1480         int channels, i, j;
1481         struct usb_audio_term iterm;
1482         unsigned int master_bits, first_ch_bits;
1483         int err, csize;
1484         struct uac_feature_unit_descriptor *hdr = _ftr;
1485         __u8 *bmaControls;
1486
1487         if (state->mixer->protocol == UAC_VERSION_1) {
1488                 if (hdr->bLength < 7) {
1489                         usb_audio_err(state->chip,
1490                                       "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1491                                       unitid);
1492                         return -EINVAL;
1493                 }
1494                 csize = hdr->bControlSize;
1495                 if (!csize) {
1496                         usb_audio_dbg(state->chip,
1497                                       "unit %u: invalid bControlSize == 0\n",
1498                                       unitid);
1499                         return -EINVAL;
1500                 }
1501                 channels = (hdr->bLength - 7) / csize - 1;
1502                 bmaControls = hdr->bmaControls;
1503                 if (hdr->bLength < 7 + csize) {
1504                         usb_audio_err(state->chip,
1505                                       "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1506                                       unitid);
1507                         return -EINVAL;
1508                 }
1509         } else {
1510                 struct uac2_feature_unit_descriptor *ftr = _ftr;
1511                 if (hdr->bLength < 6) {
1512                         usb_audio_err(state->chip,
1513                                       "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1514                                       unitid);
1515                         return -EINVAL;
1516                 }
1517                 csize = 4;
1518                 channels = (hdr->bLength - 6) / 4 - 1;
1519                 bmaControls = ftr->bmaControls;
1520                 if (hdr->bLength < 6 + csize) {
1521                         usb_audio_err(state->chip,
1522                                       "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1523                                       unitid);
1524                         return -EINVAL;
1525                 }
1526         }
1527
1528         /* parse the source unit */
1529         if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1530                 return err;
1531
1532         /* determine the input source type and name */
1533         err = check_input_term(state, hdr->bSourceID, &iterm);
1534         if (err < 0)
1535                 return err;
1536
1537         master_bits = snd_usb_combine_bytes(bmaControls, csize);
1538         /* master configuration quirks */
1539         switch (state->chip->usb_id) {
1540         case USB_ID(0x08bb, 0x2702):
1541                 usb_audio_info(state->chip,
1542                                "usbmixer: master volume quirk for PCM2702 chip\n");
1543                 /* disable non-functional volume control */
1544                 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1545                 break;
1546         case USB_ID(0x1130, 0xf211):
1547                 usb_audio_info(state->chip,
1548                                "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1549                 /* disable non-functional volume control */
1550                 channels = 0;
1551                 break;
1552
1553         }
1554         if (channels > 0)
1555                 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1556         else
1557                 first_ch_bits = 0;
1558
1559         if (state->mixer->protocol == UAC_VERSION_1) {
1560                 /* check all control types */
1561                 for (i = 0; i < 10; i++) {
1562                         unsigned int ch_bits = 0;
1563                         for (j = 0; j < channels; j++) {
1564                                 unsigned int mask;
1565
1566                                 mask = snd_usb_combine_bytes(bmaControls +
1567                                                              csize * (j+1), csize);
1568                                 if (mask & (1 << i))
1569                                         ch_bits |= (1 << j);
1570                         }
1571                         /* audio class v1 controls are never read-only */
1572
1573                         /*
1574                          * The first channel must be set
1575                          * (for ease of programming).
1576                          */
1577                         if (ch_bits & 1)
1578                                 build_feature_ctl(state, _ftr, ch_bits, i,
1579                                                   &iterm, unitid, 0);
1580                         if (master_bits & (1 << i))
1581                                 build_feature_ctl(state, _ftr, 0, i, &iterm,
1582                                                   unitid, 0);
1583                 }
1584         } else { /* UAC_VERSION_2 */
1585                 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1586                         unsigned int ch_bits = 0;
1587                         unsigned int ch_read_only = 0;
1588
1589                         for (j = 0; j < channels; j++) {
1590                                 unsigned int mask;
1591
1592                                 mask = snd_usb_combine_bytes(bmaControls +
1593                                                              csize * (j+1), csize);
1594                                 if (uac2_control_is_readable(mask, i)) {
1595                                         ch_bits |= (1 << j);
1596                                         if (!uac2_control_is_writeable(mask, i))
1597                                                 ch_read_only |= (1 << j);
1598                                 }
1599                         }
1600
1601                         /*
1602                          * NOTE: build_feature_ctl() will mark the control
1603                          * read-only if all channels are marked read-only in
1604                          * the descriptors. Otherwise, the control will be
1605                          * reported as writeable, but the driver will not
1606                          * actually issue a write command for read-only
1607                          * channels.
1608                          */
1609
1610                         /*
1611                          * The first channel must be set
1612                          * (for ease of programming).
1613                          */
1614                         if (ch_bits & 1)
1615                                 build_feature_ctl(state, _ftr, ch_bits, i,
1616                                                   &iterm, unitid, ch_read_only);
1617                         if (uac2_control_is_readable(master_bits, i))
1618                                 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1619                                                   !uac2_control_is_writeable(master_bits, i));
1620                 }
1621         }
1622
1623         return 0;
1624 }
1625
1626 /*
1627  * Mixer Unit
1628  */
1629
1630 /*
1631  * build a mixer unit control
1632  *
1633  * the callbacks are identical with feature unit.
1634  * input channel number (zero based) is given in control field instead.
1635  */
1636 static void build_mixer_unit_ctl(struct mixer_build *state,
1637                                  struct uac_mixer_unit_descriptor *desc,
1638                                  int in_pin, int in_ch, int unitid,
1639                                  struct usb_audio_term *iterm)
1640 {
1641         struct usb_mixer_elem_info *cval;
1642         unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1643         unsigned int i, len;
1644         struct snd_kcontrol *kctl;
1645         const struct usbmix_name_map *map;
1646
1647         map = find_map(state, unitid, 0);
1648         if (check_ignored_ctl(map))
1649                 return;
1650
1651         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1652         if (!cval)
1653                 return;
1654
1655         snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1656         cval->control = in_ch + 1; /* based on 1 */
1657         cval->val_type = USB_MIXER_S16;
1658         for (i = 0; i < num_outs; i++) {
1659                 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
1660
1661                 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
1662                         cval->cmask |= (1 << i);
1663                         cval->channels++;
1664                 }
1665         }
1666
1667         /* get min/max values */
1668         get_min_max(cval, 0);
1669
1670         kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1671         if (!kctl) {
1672                 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1673                 kfree(cval);
1674                 return;
1675         }
1676         kctl->private_free = snd_usb_mixer_elem_free;
1677
1678         len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1679         if (!len)
1680                 len = get_term_name(state, iterm, kctl->id.name,
1681                                     sizeof(kctl->id.name), 0);
1682         if (!len)
1683                 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1684         append_ctl_name(kctl, " Volume");
1685
1686         usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
1687                     cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
1688         snd_usb_mixer_add_control(&cval->head, kctl);
1689 }
1690
1691 /*
1692  * parse a mixer unit
1693  */
1694 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
1695                                   void *raw_desc)
1696 {
1697         struct uac_mixer_unit_descriptor *desc = raw_desc;
1698         struct usb_audio_term iterm;
1699         int input_pins, num_ins, num_outs;
1700         int pin, ich, err;
1701
1702         if (desc->bLength < 11 || !(input_pins = desc->bNrInPins) ||
1703             !(num_outs = uac_mixer_unit_bNrChannels(desc))) {
1704                 usb_audio_err(state->chip,
1705                               "invalid MIXER UNIT descriptor %d\n",
1706                               unitid);
1707                 return -EINVAL;
1708         }
1709
1710         num_ins = 0;
1711         ich = 0;
1712         for (pin = 0; pin < input_pins; pin++) {
1713                 err = parse_audio_unit(state, desc->baSourceID[pin]);
1714                 if (err < 0)
1715                         continue;
1716                 /* no bmControls field (e.g. Maya44) -> ignore */
1717                 if (desc->bLength <= 10 + input_pins)
1718                         continue;
1719                 err = check_input_term(state, desc->baSourceID[pin], &iterm);
1720                 if (err < 0)
1721                         return err;
1722                 num_ins += iterm.channels;
1723                 for (; ich < num_ins; ich++) {
1724                         int och, ich_has_controls = 0;
1725
1726                         for (och = 0; och < num_outs; och++) {
1727                                 __u8 *c = uac_mixer_unit_bmControls(desc,
1728                                                 state->mixer->protocol);
1729
1730                                 if (check_matrix_bitmap(c, ich, och, num_outs)) {
1731                                         ich_has_controls = 1;
1732                                         break;
1733                                 }
1734                         }
1735                         if (ich_has_controls)
1736                                 build_mixer_unit_ctl(state, desc, pin, ich,
1737                                                      unitid, &iterm);
1738                 }
1739         }
1740         return 0;
1741 }
1742
1743 /*
1744  * Processing Unit / Extension Unit
1745  */
1746
1747 /* get callback for processing/extension unit */
1748 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
1749                                   struct snd_ctl_elem_value *ucontrol)
1750 {
1751         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1752         int err, val;
1753
1754         err = get_cur_ctl_value(cval, cval->control << 8, &val);
1755         if (err < 0) {
1756                 ucontrol->value.integer.value[0] = cval->min;
1757                 return filter_error(cval, err);
1758         }
1759         val = get_relative_value(cval, val);
1760         ucontrol->value.integer.value[0] = val;
1761         return 0;
1762 }
1763
1764 /* put callback for processing/extension unit */
1765 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
1766                                   struct snd_ctl_elem_value *ucontrol)
1767 {
1768         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1769         int val, oval, err;
1770
1771         err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1772         if (err < 0)
1773                 return filter_error(cval, err);
1774         val = ucontrol->value.integer.value[0];
1775         val = get_abs_value(cval, val);
1776         if (val != oval) {
1777                 set_cur_ctl_value(cval, cval->control << 8, val);
1778                 return 1;
1779         }
1780         return 0;
1781 }
1782
1783 /* alsa control interface for processing/extension unit */
1784 static const struct snd_kcontrol_new mixer_procunit_ctl = {
1785         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1786         .name = "", /* will be filled later */
1787         .info = mixer_ctl_feature_info,
1788         .get = mixer_ctl_procunit_get,
1789         .put = mixer_ctl_procunit_put,
1790 };
1791
1792 /*
1793  * predefined data for processing units
1794  */
1795 struct procunit_value_info {
1796         int control;
1797         char *suffix;
1798         int val_type;
1799         int min_value;
1800 };
1801
1802 struct procunit_info {
1803         int type;
1804         char *name;
1805         struct procunit_value_info *values;
1806 };
1807
1808 static struct procunit_value_info updown_proc_info[] = {
1809         { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1810         { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1811         { 0 }
1812 };
1813 static struct procunit_value_info prologic_proc_info[] = {
1814         { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1815         { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1816         { 0 }
1817 };
1818 static struct procunit_value_info threed_enh_proc_info[] = {
1819         { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1820         { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
1821         { 0 }
1822 };
1823 static struct procunit_value_info reverb_proc_info[] = {
1824         { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1825         { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1826         { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1827         { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
1828         { 0 }
1829 };
1830 static struct procunit_value_info chorus_proc_info[] = {
1831         { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1832         { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1833         { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1834         { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1835         { 0 }
1836 };
1837 static struct procunit_value_info dcr_proc_info[] = {
1838         { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1839         { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1840         { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1841         { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1842         { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1843         { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
1844         { 0 }
1845 };
1846
1847 static struct procunit_info procunits[] = {
1848         { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1849         { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1850         { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1851         { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1852         { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1853         { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
1854         { 0 },
1855 };
1856 /*
1857  * predefined data for extension units
1858  */
1859 static struct procunit_value_info clock_rate_xu_info[] = {
1860         { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1861         { 0 }
1862 };
1863 static struct procunit_value_info clock_source_xu_info[] = {
1864         { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1865         { 0 }
1866 };
1867 static struct procunit_value_info spdif_format_xu_info[] = {
1868         { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1869         { 0 }
1870 };
1871 static struct procunit_value_info soft_limit_xu_info[] = {
1872         { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1873         { 0 }
1874 };
1875 static struct procunit_info extunits[] = {
1876         { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1877         { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1878         { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1879         { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1880         { 0 }
1881 };
1882
1883 /*
1884  * build a processing/extension unit
1885  */
1886 static int build_audio_procunit(struct mixer_build *state, int unitid,
1887                                 void *raw_desc, struct procunit_info *list,
1888                                 char *name)
1889 {
1890         struct uac_processing_unit_descriptor *desc = raw_desc;
1891         int num_ins = desc->bNrInPins;
1892         struct usb_mixer_elem_info *cval;
1893         struct snd_kcontrol *kctl;
1894         int i, err, nameid, type, len;
1895         struct procunit_info *info;
1896         struct procunit_value_info *valinfo;
1897         const struct usbmix_name_map *map;
1898         static struct procunit_value_info default_value_info[] = {
1899                 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1900                 { 0 }
1901         };
1902         static struct procunit_info default_info = {
1903                 0, NULL, default_value_info
1904         };
1905
1906         if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1907             desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
1908                 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
1909                 return -EINVAL;
1910         }
1911
1912         for (i = 0; i < num_ins; i++) {
1913                 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1914                         return err;
1915         }
1916
1917         type = le16_to_cpu(desc->wProcessType);
1918         for (info = list; info && info->type; info++)
1919                 if (info->type == type)
1920                         break;
1921         if (!info || !info->type)
1922                 info = &default_info;
1923
1924         for (valinfo = info->values; valinfo->control; valinfo++) {
1925                 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
1926
1927                 if (!(controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
1928                         continue;
1929                 map = find_map(state, unitid, valinfo->control);
1930                 if (check_ignored_ctl(map))
1931                         continue;
1932                 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1933                 if (!cval)
1934                         return -ENOMEM;
1935                 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1936                 cval->control = valinfo->control;
1937                 cval->val_type = valinfo->val_type;
1938                 cval->channels = 1;
1939
1940                 /* get min/max values */
1941                 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
1942                         __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
1943                         /* FIXME: hard-coded */
1944                         cval->min = 1;
1945                         cval->max = control_spec[0];
1946                         cval->res = 1;
1947                         cval->initialized = 1;
1948                 } else {
1949                         if (type == USB_XU_CLOCK_RATE) {
1950                                 /*
1951                                  * E-Mu USB 0404/0202/TrackerPre/0204
1952                                  * samplerate control quirk
1953                                  */
1954                                 cval->min = 0;
1955                                 cval->max = 5;
1956                                 cval->res = 1;
1957                                 cval->initialized = 1;
1958                         } else
1959                                 get_min_max(cval, valinfo->min_value);
1960                 }
1961
1962                 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1963                 if (!kctl) {
1964                         kfree(cval);
1965                         return -ENOMEM;
1966                 }
1967                 kctl->private_free = snd_usb_mixer_elem_free;
1968
1969                 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
1970                         /* nothing */ ;
1971                 } else if (info->name) {
1972                         strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1973                 } else {
1974                         nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
1975                         len = 0;
1976                         if (nameid)
1977                                 len = snd_usb_copy_string_desc(state, nameid,
1978                                                                kctl->id.name,
1979                                                                sizeof(kctl->id.name));
1980                         if (!len)
1981                                 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1982                 }
1983                 append_ctl_name(kctl, " ");
1984                 append_ctl_name(kctl, valinfo->suffix);
1985
1986                 usb_audio_dbg(state->chip,
1987                               "[%d] PU [%s] ch = %d, val = %d/%d\n",
1988                               cval->head.id, kctl->id.name, cval->channels,
1989                               cval->min, cval->max);
1990
1991                 err = snd_usb_mixer_add_control(&cval->head, kctl);
1992                 if (err < 0)
1993                         return err;
1994         }
1995         return 0;
1996 }
1997
1998 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
1999                                        void *raw_desc)
2000 {
2001         return build_audio_procunit(state, unitid, raw_desc,
2002                                     procunits, "Processing Unit");
2003 }
2004
2005 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2006                                       void *raw_desc)
2007 {
2008         /*
2009          * Note that we parse extension units with processing unit descriptors.
2010          * That's ok as the layout is the same.
2011          */
2012         return build_audio_procunit(state, unitid, raw_desc,
2013                                     extunits, "Extension Unit");
2014 }
2015
2016 /*
2017  * Selector Unit
2018  */
2019
2020 /*
2021  * info callback for selector unit
2022  * use an enumerator type for routing
2023  */
2024 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2025                                    struct snd_ctl_elem_info *uinfo)
2026 {
2027         struct usb_mixer_elem_info *cval = kcontrol->private_data;
2028         const char **itemlist = (const char **)kcontrol->private_value;
2029
2030         if (snd_BUG_ON(!itemlist))
2031                 return -EINVAL;
2032         return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2033 }
2034
2035 /* get callback for selector unit */
2036 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2037                                   struct snd_ctl_elem_value *ucontrol)
2038 {
2039         struct usb_mixer_elem_info *cval = kcontrol->private_data;
2040         int val, err;
2041
2042         err = get_cur_ctl_value(cval, cval->control << 8, &val);
2043         if (err < 0) {
2044                 ucontrol->value.enumerated.item[0] = 0;
2045                 return filter_error(cval, err);
2046         }
2047         val = get_relative_value(cval, val);
2048         ucontrol->value.enumerated.item[0] = val;
2049         return 0;
2050 }
2051
2052 /* put callback for selector unit */
2053 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2054                                   struct snd_ctl_elem_value *ucontrol)
2055 {
2056         struct usb_mixer_elem_info *cval = kcontrol->private_data;
2057         int val, oval, err;
2058
2059         err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2060         if (err < 0)
2061                 return filter_error(cval, err);
2062         val = ucontrol->value.enumerated.item[0];
2063         val = get_abs_value(cval, val);
2064         if (val != oval) {
2065                 set_cur_ctl_value(cval, cval->control << 8, val);
2066                 return 1;
2067         }
2068         return 0;
2069 }
2070
2071 /* alsa control interface for selector unit */
2072 static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2073         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2074         .name = "", /* will be filled later */
2075         .info = mixer_ctl_selector_info,
2076         .get = mixer_ctl_selector_get,
2077         .put = mixer_ctl_selector_put,
2078 };
2079
2080 /*
2081  * private free callback.
2082  * free both private_data and private_value
2083  */
2084 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2085 {
2086         int i, num_ins = 0;
2087
2088         if (kctl->private_data) {
2089                 struct usb_mixer_elem_info *cval = kctl->private_data;
2090                 num_ins = cval->max;
2091                 kfree(cval);
2092                 kctl->private_data = NULL;
2093         }
2094         if (kctl->private_value) {
2095                 char **itemlist = (char **)kctl->private_value;
2096                 for (i = 0; i < num_ins; i++)
2097                         kfree(itemlist[i]);
2098                 kfree(itemlist);
2099                 kctl->private_value = 0;
2100         }
2101 }
2102
2103 /*
2104  * parse a selector unit
2105  */
2106 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2107                                      void *raw_desc)
2108 {
2109         struct uac_selector_unit_descriptor *desc = raw_desc;
2110         unsigned int i, nameid, len;
2111         int err;
2112         struct usb_mixer_elem_info *cval;
2113         struct snd_kcontrol *kctl;
2114         const struct usbmix_name_map *map;
2115         char **namelist;
2116
2117         if (desc->bLength < 5 || !desc->bNrInPins ||
2118             desc->bLength < 5 + desc->bNrInPins) {
2119                 usb_audio_err(state->chip,
2120                         "invalid SELECTOR UNIT descriptor %d\n", unitid);
2121                 return -EINVAL;
2122         }
2123
2124         for (i = 0; i < desc->bNrInPins; i++) {
2125                 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
2126                         return err;
2127         }
2128
2129         if (desc->bNrInPins == 1) /* only one ? nonsense! */
2130                 return 0;
2131
2132         map = find_map(state, unitid, 0);
2133         if (check_ignored_ctl(map))
2134                 return 0;
2135
2136         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2137         if (!cval)
2138                 return -ENOMEM;
2139         snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2140         cval->val_type = USB_MIXER_U8;
2141         cval->channels = 1;
2142         cval->min = 1;
2143         cval->max = desc->bNrInPins;
2144         cval->res = 1;
2145         cval->initialized = 1;
2146
2147         if (state->mixer->protocol == UAC_VERSION_1)
2148                 cval->control = 0;
2149         else /* UAC_VERSION_2 */
2150                 cval->control = (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) ?
2151                         UAC2_CX_CLOCK_SELECTOR : UAC2_SU_SELECTOR;
2152
2153         namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
2154         if (!namelist) {
2155                 kfree(cval);
2156                 return -ENOMEM;
2157         }
2158 #define MAX_ITEM_NAME_LEN       64
2159         for (i = 0; i < desc->bNrInPins; i++) {
2160                 struct usb_audio_term iterm;
2161                 len = 0;
2162                 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2163                 if (!namelist[i]) {
2164                         while (i--)
2165                                 kfree(namelist[i]);
2166                         kfree(namelist);
2167                         kfree(cval);
2168                         return -ENOMEM;
2169                 }
2170                 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2171                                                  MAX_ITEM_NAME_LEN);
2172                 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2173                         len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
2174                 if (! len)
2175                         sprintf(namelist[i], "Input %u", i);
2176         }
2177
2178         kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2179         if (! kctl) {
2180                 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2181                 kfree(namelist);
2182                 kfree(cval);
2183                 return -ENOMEM;
2184         }
2185         kctl->private_value = (unsigned long)namelist;
2186         kctl->private_free = usb_mixer_selector_elem_free;
2187
2188         /* check the static mapping table at first */
2189         len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2190         if (!len) {
2191                 /* no mapping ? */
2192                 /* if iSelector is given, use it */
2193                 nameid = uac_selector_unit_iSelector(desc);
2194                 if (nameid)
2195                         len = snd_usb_copy_string_desc(state, nameid,
2196                                                        kctl->id.name,
2197                                                        sizeof(kctl->id.name));
2198                 /* ... or pick up the terminal name at next */
2199                 if (!len)
2200                         len = get_term_name(state, &state->oterm,
2201                                     kctl->id.name, sizeof(kctl->id.name), 0);
2202                 /* ... or use the fixed string "USB" as the last resort */
2203                 if (!len)
2204                         strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2205
2206                 /* and add the proper suffix */
2207                 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
2208                         append_ctl_name(kctl, " Clock Source");
2209                 else if ((state->oterm.type & 0xff00) == 0x0100)
2210                         append_ctl_name(kctl, " Capture Source");
2211                 else
2212                         append_ctl_name(kctl, " Playback Source");
2213         }
2214
2215         usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2216                     cval->head.id, kctl->id.name, desc->bNrInPins);
2217         return snd_usb_mixer_add_control(&cval->head, kctl);
2218 }
2219
2220 /*
2221  * parse an audio unit recursively
2222  */
2223
2224 static int parse_audio_unit(struct mixer_build *state, int unitid)
2225 {
2226         unsigned char *p1;
2227
2228         if (test_and_set_bit(unitid, state->unitbitmap))
2229                 return 0; /* the unit already visited */
2230
2231         p1 = find_audio_control_unit(state, unitid);
2232         if (!p1) {
2233                 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2234                 return -EINVAL;
2235         }
2236
2237         switch (p1[2]) {
2238         case UAC_INPUT_TERMINAL:
2239                 return 0; /* NOP */
2240         case UAC_MIXER_UNIT:
2241                 return parse_audio_mixer_unit(state, unitid, p1);
2242         case UAC2_CLOCK_SOURCE:
2243                 return parse_clock_source_unit(state, unitid, p1);
2244         case UAC_SELECTOR_UNIT:
2245         case UAC2_CLOCK_SELECTOR:
2246                 return parse_audio_selector_unit(state, unitid, p1);
2247         case UAC_FEATURE_UNIT:
2248                 return parse_audio_feature_unit(state, unitid, p1);
2249         case UAC1_PROCESSING_UNIT:
2250         /*   UAC2_EFFECT_UNIT has the same value */
2251                 if (state->mixer->protocol == UAC_VERSION_1)
2252                         return parse_audio_processing_unit(state, unitid, p1);
2253                 else
2254                         return 0; /* FIXME - effect units not implemented yet */
2255         case UAC1_EXTENSION_UNIT:
2256         /*   UAC2_PROCESSING_UNIT_V2 has the same value */
2257                 if (state->mixer->protocol == UAC_VERSION_1)
2258                         return parse_audio_extension_unit(state, unitid, p1);
2259                 else /* UAC_VERSION_2 */
2260                         return parse_audio_processing_unit(state, unitid, p1);
2261         case UAC2_EXTENSION_UNIT_V2:
2262                 return parse_audio_extension_unit(state, unitid, p1);
2263         default:
2264                 usb_audio_err(state->chip,
2265                         "unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2266                 return -EINVAL;
2267         }
2268 }
2269
2270 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2271 {
2272         /* kill pending URBs */
2273         snd_usb_mixer_disconnect(mixer);
2274
2275         kfree(mixer->id_elems);
2276         if (mixer->urb) {
2277                 kfree(mixer->urb->transfer_buffer);
2278                 usb_free_urb(mixer->urb);
2279         }
2280         usb_free_urb(mixer->rc_urb);
2281         kfree(mixer->rc_setup_packet);
2282         kfree(mixer);
2283 }
2284
2285 static int snd_usb_mixer_dev_free(struct snd_device *device)
2286 {
2287         struct usb_mixer_interface *mixer = device->device_data;
2288         snd_usb_mixer_free(mixer);
2289         return 0;
2290 }
2291
2292 /*
2293  * create mixer controls
2294  *
2295  * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2296  */
2297 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
2298 {
2299         struct mixer_build state;
2300         int err;
2301         const struct usbmix_ctl_map *map;
2302         void *p;
2303
2304         memset(&state, 0, sizeof(state));
2305         state.chip = mixer->chip;
2306         state.mixer = mixer;
2307         state.buffer = mixer->hostif->extra;
2308         state.buflen = mixer->hostif->extralen;
2309
2310         /* check the mapping table */
2311         for (map = usbmix_ctl_maps; map->id; map++) {
2312                 if (map->id == state.chip->usb_id) {
2313                         state.map = map->map;
2314                         state.selector_map = map->selector_map;
2315                         mixer->ignore_ctl_error = map->ignore_ctl_error;
2316                         break;
2317                 }
2318         }
2319
2320         p = NULL;
2321         while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
2322                                             mixer->hostif->extralen,
2323                                             p, UAC_OUTPUT_TERMINAL)) != NULL) {
2324                 if (mixer->protocol == UAC_VERSION_1) {
2325                         struct uac1_output_terminal_descriptor *desc = p;
2326
2327                         if (desc->bLength < sizeof(*desc))
2328                                 continue; /* invalid descriptor? */
2329                         /* mark terminal ID as visited */
2330                         set_bit(desc->bTerminalID, state.unitbitmap);
2331                         state.oterm.id = desc->bTerminalID;
2332                         state.oterm.type = le16_to_cpu(desc->wTerminalType);
2333                         state.oterm.name = desc->iTerminal;
2334                         err = parse_audio_unit(&state, desc->bSourceID);
2335                         if (err < 0 && err != -EINVAL)
2336                                 return err;
2337                 } else { /* UAC_VERSION_2 */
2338                         struct uac2_output_terminal_descriptor *desc = p;
2339
2340                         if (desc->bLength < sizeof(*desc))
2341                                 continue; /* invalid descriptor? */
2342                         /* mark terminal ID as visited */
2343                         set_bit(desc->bTerminalID, state.unitbitmap);
2344                         state.oterm.id = desc->bTerminalID;
2345                         state.oterm.type = le16_to_cpu(desc->wTerminalType);
2346                         state.oterm.name = desc->iTerminal;
2347                         err = parse_audio_unit(&state, desc->bSourceID);
2348                         if (err < 0 && err != -EINVAL)
2349                                 return err;
2350
2351                         /*
2352                          * For UAC2, use the same approach to also add the
2353                          * clock selectors
2354                          */
2355                         err = parse_audio_unit(&state, desc->bCSourceID);
2356                         if (err < 0 && err != -EINVAL)
2357                                 return err;
2358                 }
2359         }
2360
2361         return 0;
2362 }
2363
2364 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
2365 {
2366         struct usb_mixer_elem_list *list;
2367
2368         for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
2369                 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2370                                &list->kctl->id);
2371 }
2372
2373 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2374                                     struct usb_mixer_elem_list *list)
2375 {
2376         struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2377         static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2378                                     "S8", "U8", "S16", "U16"};
2379         snd_iprintf(buffer, "    Info: id=%i, control=%i, cmask=0x%x, "
2380                             "channels=%i, type=\"%s\"\n", cval->head.id,
2381                             cval->control, cval->cmask, cval->channels,
2382                             val_types[cval->val_type]);
2383         snd_iprintf(buffer, "    Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2384                             cval->min, cval->max, cval->dBmin, cval->dBmax);
2385 }
2386
2387 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2388                                     struct snd_info_buffer *buffer)
2389 {
2390         struct snd_usb_audio *chip = entry->private_data;
2391         struct usb_mixer_interface *mixer;
2392         struct usb_mixer_elem_list *list;
2393         int unitid;
2394
2395         list_for_each_entry(mixer, &chip->mixer_list, list) {
2396                 snd_iprintf(buffer,
2397                         "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2398                                 chip->usb_id, snd_usb_ctrl_intf(chip),
2399                                 mixer->ignore_ctl_error);
2400                 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2401                 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2402                         for (list = mixer->id_elems[unitid]; list;
2403                              list = list->next_id_elem) {
2404                                 snd_iprintf(buffer, "  Unit: %i\n", list->id);
2405                                 if (list->kctl)
2406                                         snd_iprintf(buffer,
2407                                                     "    Control: name=\"%s\", index=%i\n",
2408                                                     list->kctl->id.name,
2409                                                     list->kctl->id.index);
2410                                 if (list->dump)
2411                                         list->dump(buffer, list);
2412                         }
2413                 }
2414         }
2415 }
2416
2417 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2418                                        int attribute, int value, int index)
2419 {
2420         struct usb_mixer_elem_list *list;
2421         __u8 unitid = (index >> 8) & 0xff;
2422         __u8 control = (value >> 8) & 0xff;
2423         __u8 channel = value & 0xff;
2424         unsigned int count = 0;
2425
2426         if (channel >= MAX_CHANNELS) {
2427                 usb_audio_dbg(mixer->chip,
2428                         "%s(): bogus channel number %d\n",
2429                         __func__, channel);
2430                 return;
2431         }
2432
2433         for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
2434                 count++;
2435
2436         if (count == 0)
2437                 return;
2438
2439         for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
2440                 struct usb_mixer_elem_info *info;
2441
2442                 if (!list->kctl)
2443                         continue;
2444
2445                 info = (struct usb_mixer_elem_info *)list;
2446                 if (count > 1 && info->control != control)
2447                         continue;
2448
2449                 switch (attribute) {
2450                 case UAC2_CS_CUR:
2451                         /* invalidate cache, so the value is read from the device */
2452                         if (channel)
2453                                 info->cached &= ~(1 << channel);
2454                         else /* master channel */
2455                                 info->cached = 0;
2456
2457                         snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2458                                        &info->head.kctl->id);
2459                         break;
2460
2461                 case UAC2_CS_RANGE:
2462                         /* TODO */
2463                         break;
2464
2465                 case UAC2_CS_MEM:
2466                         /* TODO */
2467                         break;
2468
2469                 default:
2470                         usb_audio_dbg(mixer->chip,
2471                                 "unknown attribute %d in interrupt\n",
2472                                 attribute);
2473                         break;
2474                 } /* switch */
2475         }
2476 }
2477
2478 static void snd_usb_mixer_interrupt(struct urb *urb)
2479 {
2480         struct usb_mixer_interface *mixer = urb->context;
2481         int len = urb->actual_length;
2482         int ustatus = urb->status;
2483
2484         if (ustatus != 0)
2485                 goto requeue;
2486
2487         if (mixer->protocol == UAC_VERSION_1) {
2488                 struct uac1_status_word *status;
2489
2490                 for (status = urb->transfer_buffer;
2491                      len >= sizeof(*status);
2492                      len -= sizeof(*status), status++) {
2493                         dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
2494                                                 status->bStatusType,
2495                                                 status->bOriginator);
2496
2497                         /* ignore any notifications not from the control interface */
2498                         if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2499                                 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2500                                 continue;
2501
2502                         if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2503                                 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2504                         else
2505                                 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2506                 }
2507         } else { /* UAC_VERSION_2 */
2508                 struct uac2_interrupt_data_msg *msg;
2509
2510                 for (msg = urb->transfer_buffer;
2511                      len >= sizeof(*msg);
2512                      len -= sizeof(*msg), msg++) {
2513                         /* drop vendor specific and endpoint requests */
2514                         if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2515                             (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2516                                 continue;
2517
2518                         snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2519                                                    le16_to_cpu(msg->wValue),
2520                                                    le16_to_cpu(msg->wIndex));
2521                 }
2522         }
2523
2524 requeue:
2525         if (ustatus != -ENOENT &&
2526             ustatus != -ECONNRESET &&
2527             ustatus != -ESHUTDOWN) {
2528                 urb->dev = mixer->chip->dev;
2529                 usb_submit_urb(urb, GFP_ATOMIC);
2530         }
2531 }
2532
2533 /* create the handler for the optional status interrupt endpoint */
2534 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2535 {
2536         struct usb_endpoint_descriptor *ep;
2537         void *transfer_buffer;
2538         int buffer_length;
2539         unsigned int epnum;
2540
2541         /* we need one interrupt input endpoint */
2542         if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
2543                 return 0;
2544         ep = get_endpoint(mixer->hostif, 0);
2545         if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2546                 return 0;
2547
2548         epnum = usb_endpoint_num(ep);
2549         buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2550         transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2551         if (!transfer_buffer)
2552                 return -ENOMEM;
2553         mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2554         if (!mixer->urb) {
2555                 kfree(transfer_buffer);
2556                 return -ENOMEM;
2557         }
2558         usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2559                          usb_rcvintpipe(mixer->chip->dev, epnum),
2560                          transfer_buffer, buffer_length,
2561                          snd_usb_mixer_interrupt, mixer, ep->bInterval);
2562         usb_submit_urb(mixer->urb, GFP_KERNEL);
2563         return 0;
2564 }
2565
2566 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2567                          int ignore_error)
2568 {
2569         static struct snd_device_ops dev_ops = {
2570                 .dev_free = snd_usb_mixer_dev_free
2571         };
2572         struct usb_mixer_interface *mixer;
2573         struct snd_info_entry *entry;
2574         int err;
2575
2576         strcpy(chip->card->mixername, "USB Mixer");
2577
2578         mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2579         if (!mixer)
2580                 return -ENOMEM;
2581         mixer->chip = chip;
2582         mixer->ignore_ctl_error = ignore_error;
2583         mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2584                                   GFP_KERNEL);
2585         if (!mixer->id_elems) {
2586                 kfree(mixer);
2587                 return -ENOMEM;
2588         }
2589
2590         mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2591         switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
2592         case UAC_VERSION_1:
2593         default:
2594                 mixer->protocol = UAC_VERSION_1;
2595                 break;
2596         case UAC_VERSION_2:
2597                 mixer->protocol = UAC_VERSION_2;
2598                 break;
2599         }
2600
2601         if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2602             (err = snd_usb_mixer_status_create(mixer)) < 0)
2603                 goto _error;
2604
2605         snd_usb_mixer_apply_create_quirk(mixer);
2606
2607         err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
2608         if (err < 0)
2609                 goto _error;
2610
2611         if (list_empty(&chip->mixer_list) &&
2612             !snd_card_proc_new(chip->card, "usbmixer", &entry))
2613                 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2614
2615         list_add(&mixer->list, &chip->mixer_list);
2616         return 0;
2617
2618 _error:
2619         snd_usb_mixer_free(mixer);
2620         return err;
2621 }
2622
2623 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
2624 {
2625         if (mixer->disconnected)
2626                 return;
2627         if (mixer->urb)
2628                 usb_kill_urb(mixer->urb);
2629         if (mixer->rc_urb)
2630                 usb_kill_urb(mixer->rc_urb);
2631         mixer->disconnected = true;
2632 }
2633
2634 #ifdef CONFIG_PM
2635 /* stop any bus activity of a mixer */
2636 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2637 {
2638         usb_kill_urb(mixer->urb);
2639         usb_kill_urb(mixer->rc_urb);
2640 }
2641
2642 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2643 {
2644         int err;
2645
2646         if (mixer->urb) {
2647                 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2648                 if (err < 0)
2649                         return err;
2650         }
2651
2652         return 0;
2653 }
2654
2655 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
2656 {
2657         snd_usb_mixer_inactivate(mixer);
2658         return 0;
2659 }
2660
2661 static int restore_mixer_value(struct usb_mixer_elem_list *list)
2662 {
2663         struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2664         int c, err, idx;
2665
2666         if (cval->cmask) {
2667                 idx = 0;
2668                 for (c = 0; c < MAX_CHANNELS; c++) {
2669                         if (!(cval->cmask & (1 << c)))
2670                                 continue;
2671                         if (cval->cached & (1 << (c + 1))) {
2672                                 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
2673                                                         cval->cache_val[idx]);
2674                                 if (err < 0)
2675                                         return err;
2676                         }
2677                         idx++;
2678                 }
2679         } else {
2680                 /* master */
2681                 if (cval->cached) {
2682                         err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
2683                         if (err < 0)
2684                                 return err;
2685                 }
2686         }
2687
2688         return 0;
2689 }
2690
2691 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
2692 {
2693         struct usb_mixer_elem_list *list;
2694         int id, err;
2695
2696         if (reset_resume) {
2697                 /* restore cached mixer values */
2698                 for (id = 0; id < MAX_ID_ELEMS; id++) {
2699                         for (list = mixer->id_elems[id]; list;
2700                              list = list->next_id_elem) {
2701                                 if (list->resume) {
2702                                         err = list->resume(list);
2703                                         if (err < 0)
2704                                                 return err;
2705                                 }
2706                         }
2707                 }
2708         }
2709
2710         return snd_usb_mixer_activate(mixer);
2711 }
2712 #endif
2713
2714 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
2715                                  struct usb_mixer_interface *mixer,
2716                                  int unitid)
2717 {
2718         list->mixer = mixer;
2719         list->id = unitid;
2720         list->dump = snd_usb_mixer_dump_cval;
2721 #ifdef CONFIG_PM
2722         list->resume = restore_mixer_value;
2723 #endif
2724 }