sound/usb/mixer.c

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