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