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