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