sound/usb/mixer.c

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