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