sound/usb/mixer.c

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