sound/usb/mixer.c

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