sound/usb/mixer.c

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