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                 /* UAC2_PROCESSING_UNIT_V2 */
 725                 /* UAC2_EFFECT_UNIT */ {
 726                         struct uac_processing_unit_descriptor *d = p1;
 727
 728                         if (state->mixer->protocol == UAC_VERSION_2 &&
 729                                 hdr[2] == UAC2_EFFECT_UNIT) {
 730                                 /* UAC2/UAC1 unit IDs overlap here in an
 731                                  * uncompatible way. Ignore this unit for now.
 732                                  */
 733                                 return 0;
 734                         }
 735
 736                         if (d->bNrInPins) {
 737                                 id = d->baSourceID[0];
 738                                 break; /* continue to parse */
 739                         }
 740                         term->type = d->bDescriptorSubtype << 16; /* virtual type */
 741                         term->channels = uac_processing_unit_bNrChannels(d);
 742                         term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
 743                         term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
 744                         return 0;
 745                 }
 746                 case UAC2_CLOCK_SOURCE: {
 747                         struct uac_clock_source_descriptor *d = p1;
 748                         term->type = d->bDescriptorSubtype << 16; /* virtual type */
 749                         term->id = id;
 750                         term->name = d->iClockSource;
 751                         return 0;
 752                 }
 753                 default:
 754                         return -ENODEV;
 755                 }
 756         }
 757         return -ENODEV;
 758 }
 759
 760
 761 /*
 762  * Feature Unit
 763  */
 764
 765 /* feature unit control information */
 766 struct usb_feature_control_info {
 767         const char *name;
 768         unsigned int type;      /* control type (mute, volume, etc.) */
 769 };
 770
 771 static struct usb_feature_control_info audio_feature_info[] = {
 772         { "Mute",                       USB_MIXER_INV_BOOLEAN },
 773         { "Volume",                     USB_MIXER_S16 },
 774         { "Tone Control - Bass",        USB_MIXER_S8 },
 775         { "Tone Control - Mid",         USB_MIXER_S8 },
 776         { "Tone Control - Treble",      USB_MIXER_S8 },
 777         { "Graphic Equalizer",          USB_MIXER_S8 }, /* FIXME: not implemeted yet */
 778         { "Auto Gain Control",          USB_MIXER_BOOLEAN },
 779         { "Delay Control",              USB_MIXER_U16 },
 780         { "Bass Boost",                 USB_MIXER_BOOLEAN },
 781         { "Loudness",                   USB_MIXER_BOOLEAN },
 782         /* UAC2 specific */
 783         { "Input Gain Control",         USB_MIXER_U16 },
 784         { "Input Gain Pad Control",     USB_MIXER_BOOLEAN },
 785         { "Phase Inverter Control",     USB_MIXER_BOOLEAN },
 786 };
 787
 788
 789 /* private_free callback */
 790 static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
 791 {
 792         kfree(kctl->private_data);
 793         kctl->private_data = NULL;
 794 }
 795
 796
 797 /*
 798  * interface to ALSA control for feature/mixer units
 799  */
 800
 801 /* volume control quirks */
 802 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
 803                                   struct snd_kcontrol *kctl)
 804 {
 805         switch (cval->mixer->chip->usb_id) {
 806         case USB_ID(0x0471, 0x0101):
 807         case USB_ID(0x0471, 0x0104):
 808         case USB_ID(0x0471, 0x0105):
 809         case USB_ID(0x0672, 0x1041):
 810         /* quirk for UDA1321/N101.
 811          * note that detection between firmware 2.1.1.7 (N101)
 812          * and later 2.1.1.21 is not very clear from datasheets.
 813          * I hope that the min value is -15360 for newer firmware --jk
 814          */
 815                 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
 816                     cval->min == -15616) {
 817                         snd_printk(KERN_INFO
 818                                  "set volume quirk for UDA1321/N101 chip\n");
 819                         cval->max = -256;
 820                 }
 821                 break;
 822
 823         case USB_ID(0x046d, 0x09a4):
 824                 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
 825                         snd_printk(KERN_INFO
 826                                 "set volume quirk for QuickCam E3500\n");
 827                         cval->min = 6080;
 828                         cval->max = 8768;
 829                         cval->res = 192;
 830                 }
 831                 break;
 832
 833         case USB_ID(0x046d, 0x0808):
 834         case USB_ID(0x046d, 0x0809):
 835         case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
 836         case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
 837         case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
 838         case USB_ID(0x046d, 0x0991):
 839         /* Most audio usb devices lie about volume resolution.
 840          * Most Logitech webcams have res = 384.
 841          * Proboly there is some logitech magic behind this number --fishor
 842          */
 843                 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
 844                         snd_printk(KERN_INFO
 845                                 "set resolution quirk: cval->res = 384\n");
 846                         cval->res = 384;
 847                 }
 848                 break;
 849
 850         }
 851 }
 852
 853 /*
 854  * retrieve the minimum and maximum values for the specified control
 855  */
 856 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
 857                                    int default_min, struct snd_kcontrol *kctl)
 858 {
 859         /* for failsafe */
 860         cval->min = default_min;
 861         cval->max = cval->min + 1;
 862         cval->res = 1;
 863         cval->dBmin = cval->dBmax = 0;
 864
 865         if (cval->val_type == USB_MIXER_BOOLEAN ||
 866             cval->val_type == USB_MIXER_INV_BOOLEAN) {
 867                 cval->initialized = 1;
 868         } else {
 869                 int minchn = 0;
 870                 if (cval->cmask) {
 871                         int i;
 872                         for (i = 0; i < MAX_CHANNELS; i++)
 873                                 if (cval->cmask & (1 << i)) {
 874                                         minchn = i + 1;
 875                                         break;
 876                                 }
 877                 }
 878                 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
 879                     get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
 880                         snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
 881                                    cval->id, snd_usb_ctrl_intf(cval->mixer->chip), cval->control, cval->id);
 882                         return -EINVAL;
 883                 }
 884                 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
 885                         cval->res = 1;
 886                 } else {
 887                         int last_valid_res = cval->res;
 888
 889                         while (cval->res > 1) {
 890                                 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
 891                                                                 (cval->control << 8) | minchn, cval->res / 2) < 0)
 892                                         break;
 893                                 cval->res /= 2;
 894                         }
 895                         if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
 896                                 cval->res = last_valid_res;
 897                 }
 898                 if (cval->res == 0)
 899                         cval->res = 1;
 900
 901                 /* Additional checks for the proper resolution
 902                  *
 903                  * Some devices report smaller resolutions than actually
 904                  * reacting.  They don't return errors but simply clip
 905                  * to the lower aligned value.
 906                  */
 907                 if (cval->min + cval->res < cval->max) {
 908                         int last_valid_res = cval->res;
 909                         int saved, test, check;
 910                         get_cur_mix_raw(cval, minchn, &saved);
 911                         for (;;) {
 912                                 test = saved;
 913                                 if (test < cval->max)
 914                                         test += cval->res;
 915                                 else
 916                                         test -= cval->res;
 917                                 if (test < cval->min || test > cval->max ||
 918                                     set_cur_mix_value(cval, minchn, 0, test) ||
 919                                     get_cur_mix_raw(cval, minchn, &check)) {
 920                                         cval->res = last_valid_res;
 921                                         break;
 922                                 }
 923                                 if (test == check)
 924                                         break;
 925                                 cval->res *= 2;
 926                         }
 927                         set_cur_mix_value(cval, minchn, 0, saved);
 928                 }
 929
 930                 cval->initialized = 1;
 931         }
 932
 933         if (kctl)
 934                 volume_control_quirks(cval, kctl);
 935
 936         /* USB descriptions contain the dB scale in 1/256 dB unit
 937          * while ALSA TLV contains in 1/100 dB unit
 938          */
 939         cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
 940         cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
 941         if (cval->dBmin > cval->dBmax) {
 942                 /* something is wrong; assume it's either from/to 0dB */
 943                 if (cval->dBmin < 0)
 944                         cval->dBmax = 0;
 945                 else if (cval->dBmin > 0)
 946                         cval->dBmin = 0;
 947                 if (cval->dBmin > cval->dBmax) {
 948                         /* totally crap, return an error */
 949                         return -EINVAL;
 950                 }
 951         }
 952
 953         return 0;
 954 }
 955
 956 #define get_min_max(cval, def)  get_min_max_with_quirks(cval, def, NULL)
 957
 958 /* get a feature/mixer unit info */
 959 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
 960 {
 961         struct usb_mixer_elem_info *cval = kcontrol->private_data;
 962
 963         if (cval->val_type == USB_MIXER_BOOLEAN ||
 964             cval->val_type == USB_MIXER_INV_BOOLEAN)
 965                 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
 966         else
 967                 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
 968         uinfo->count = cval->channels;
 969         if (cval->val_type == USB_MIXER_BOOLEAN ||
 970             cval->val_type == USB_MIXER_INV_BOOLEAN) {
 971                 uinfo->value.integer.min = 0;
 972                 uinfo->value.integer.max = 1;
 973         } else {
 974                 if (!cval->initialized) {
 975                         get_min_max_with_quirks(cval, 0, kcontrol);
 976                         if (cval->initialized && cval->dBmin >= cval->dBmax) {
 977                                 kcontrol->vd[0].access &=
 978                                         ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
 979                                           SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
 980                                 snd_ctl_notify(cval->mixer->chip->card,
 981                                                SNDRV_CTL_EVENT_MASK_INFO,
 982                                                &kcontrol->id);
 983                         }
 984                 }
 985                 uinfo->value.integer.min = 0;
 986                 uinfo->value.integer.max =
 987                         (cval->max - cval->min + cval->res - 1) / cval->res;
 988         }
 989         return 0;
 990 }
 991
 992 /* get the current value from feature/mixer unit */
 993 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
 994 {
 995         struct usb_mixer_elem_info *cval = kcontrol->private_data;
 996         int c, cnt, val, err;
 997
 998         ucontrol->value.integer.value[0] = cval->min;
 999         if (cval->cmask) {
1000                 cnt = 0;
1001                 for (c = 0; c < MAX_CHANNELS; c++) {
1002                         if (!(cval->cmask & (1 << c)))
1003                                 continue;
1004                         err = get_cur_mix_value(cval, c + 1, cnt, &val);
1005                         if (err < 0)
1006                                 return cval->mixer->ignore_ctl_error ? 0 : err;
1007                         val = get_relative_value(cval, val);
1008                         ucontrol->value.integer.value[cnt] = val;
1009                         cnt++;
1010                 }
1011                 return 0;
1012         } else {
1013                 /* master channel */
1014                 err = get_cur_mix_value(cval, 0, 0, &val);
1015                 if (err < 0)
1016                         return cval->mixer->ignore_ctl_error ? 0 : err;
1017                 val = get_relative_value(cval, val);
1018                 ucontrol->value.integer.value[0] = val;
1019         }
1020         return 0;
1021 }
1022
1023 /* put the current value to feature/mixer unit */
1024 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1025 {
1026         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1027         int c, cnt, val, oval, err;
1028         int changed = 0;
1029
1030         if (cval->cmask) {
1031                 cnt = 0;
1032                 for (c = 0; c < MAX_CHANNELS; c++) {
1033                         if (!(cval->cmask & (1 << c)))
1034                                 continue;
1035                         err = get_cur_mix_value(cval, c + 1, cnt, &oval);
1036                         if (err < 0)
1037                                 return cval->mixer->ignore_ctl_error ? 0 : err;
1038                         val = ucontrol->value.integer.value[cnt];
1039                         val = get_abs_value(cval, val);
1040                         if (oval != val) {
1041                                 set_cur_mix_value(cval, c + 1, cnt, val);
1042                                 changed = 1;
1043                         }
1044                         cnt++;
1045                 }
1046         } else {
1047                 /* master channel */
1048                 err = get_cur_mix_value(cval, 0, 0, &oval);
1049                 if (err < 0)
1050                         return cval->mixer->ignore_ctl_error ? 0 : err;
1051                 val = ucontrol->value.integer.value[0];
1052                 val = get_abs_value(cval, val);
1053                 if (val != oval) {
1054                         set_cur_mix_value(cval, 0, 0, val);
1055                         changed = 1;
1056                 }
1057         }
1058         return changed;
1059 }
1060
1061 static struct snd_kcontrol_new usb_feature_unit_ctl = {
1062         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1063         .name = "", /* will be filled later manually */
1064         .info = mixer_ctl_feature_info,
1065         .get = mixer_ctl_feature_get,
1066         .put = mixer_ctl_feature_put,
1067 };
1068
1069 /* the read-only variant */
1070 static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1071         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1072         .name = "", /* will be filled later manually */
1073         .info = mixer_ctl_feature_info,
1074         .get = mixer_ctl_feature_get,
1075         .put = NULL,
1076 };
1077
1078 /* This symbol is exported in order to allow the mixer quirks to
1079  * hook up to the standard feature unit control mechanism */
1080 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1081
1082 /*
1083  * build a feature control
1084  */
1085
1086 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1087 {
1088         return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1089 }
1090
1091 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1092                               unsigned int ctl_mask, int control,
1093                               struct usb_audio_term *iterm, int unitid,
1094                               int readonly_mask)
1095 {
1096         struct uac_feature_unit_descriptor *desc = raw_desc;
1097         unsigned int len = 0;
1098         int mapped_name = 0;
1099         int nameid = uac_feature_unit_iFeature(desc);
1100         struct snd_kcontrol *kctl;
1101         struct usb_mixer_elem_info *cval;
1102         const struct usbmix_name_map *map;
1103         unsigned int range;
1104
1105         control++; /* change from zero-based to 1-based value */
1106
1107         if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1108                 /* FIXME: not supported yet */
1109                 return;
1110         }
1111
1112         map = find_map(state, unitid, control);
1113         if (check_ignored_ctl(map))
1114                 return;
1115
1116         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1117         if (! cval) {
1118                 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1119                 return;
1120         }
1121         cval->mixer = state->mixer;
1122         cval->id = unitid;
1123         cval->control = control;
1124         cval->cmask = ctl_mask;
1125         cval->val_type = audio_feature_info[control-1].type;
1126         if (ctl_mask == 0) {
1127                 cval->channels = 1;     /* master channel */
1128                 cval->master_readonly = readonly_mask;
1129         } else {
1130                 int i, c = 0;
1131                 for (i = 0; i < 16; i++)
1132                         if (ctl_mask & (1 << i))
1133                                 c++;
1134                 cval->channels = c;
1135                 cval->ch_readonly = readonly_mask;
1136         }
1137
1138         /* if all channels in the mask are marked read-only, make the control
1139          * read-only. set_cur_mix_value() will check the mask again and won't
1140          * issue write commands to read-only channels. */
1141         if (cval->channels == readonly_mask)
1142                 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1143         else
1144                 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1145
1146         if (! kctl) {
1147                 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1148                 kfree(cval);
1149                 return;
1150         }
1151         kctl->private_free = usb_mixer_elem_free;
1152
1153         len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1154         mapped_name = len != 0;
1155         if (! len && nameid)
1156                 len = snd_usb_copy_string_desc(state, nameid,
1157                                 kctl->id.name, sizeof(kctl->id.name));
1158
1159         /* get min/max values */
1160         get_min_max_with_quirks(cval, 0, kctl);
1161
1162         switch (control) {
1163         case UAC_FU_MUTE:
1164         case UAC_FU_VOLUME:
1165                 /* determine the control name.  the rule is:
1166                  * - if a name id is given in descriptor, use it.
1167                  * - if the connected input can be determined, then use the name
1168                  *   of terminal type.
1169                  * - if the connected output can be determined, use it.
1170                  * - otherwise, anonymous name.
1171                  */
1172                 if (! len) {
1173                         len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1);
1174                         if (! len)
1175                                 len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1);
1176                         if (! len)
1177                                 len = snprintf(kctl->id.name, sizeof(kctl->id.name),
1178                                                "Feature %d", unitid);
1179                 }
1180                 /* determine the stream direction:
1181                  * if the connected output is USB stream, then it's likely a
1182                  * capture stream.  otherwise it should be playback (hopefully :)
1183                  */
1184                 if (! mapped_name && ! (state->oterm.type >> 16)) {
1185                         if ((state->oterm.type & 0xff00) == 0x0100) {
1186                                 len = append_ctl_name(kctl, " Capture");
1187                         } else {
1188                                 len = append_ctl_name(kctl, " Playback");
1189                         }
1190                 }
1191                 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1192                                 " Switch" : " Volume");
1193                 if (control == UAC_FU_VOLUME) {
1194                         check_mapped_dB(map, cval);
1195                         if (cval->dBmin < cval->dBmax || !cval->initialized) {
1196                                 kctl->tlv.c = mixer_vol_tlv;
1197                                 kctl->vd[0].access |=
1198                                         SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1199                                         SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1200                         }
1201                 }
1202                 break;
1203
1204         default:
1205                 if (! len)
1206                         strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1207                                 sizeof(kctl->id.name));
1208                 break;
1209         }
1210
1211         range = (cval->max - cval->min) / cval->res;
1212         /* Are there devices with volume range more than 255? I use a bit more
1213          * to be sure. 384 is a resolution magic number found on Logitech
1214          * devices. It will definitively catch all buggy Logitech devices.
1215          */
1216         if (range > 384) {
1217                 snd_printk(KERN_WARNING "usb_audio: Warning! Unlikely big "
1218                            "volume range (=%u), cval->res is probably wrong.",
1219                            range);
1220                 snd_printk(KERN_WARNING "usb_audio: [%d] FU [%s] ch = %d, "
1221                            "val = %d/%d/%d", cval->id,
1222                            kctl->id.name, cval->channels,
1223                            cval->min, cval->max, cval->res);
1224         }
1225
1226         snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1227                     cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
1228         snd_usb_mixer_add_control(state->mixer, kctl);
1229 }
1230
1231
1232
1233 /*
1234  * parse a feature unit
1235  *
1236  * most of controls are defined here.
1237  */
1238 static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr)
1239 {
1240         int channels, i, j;
1241         struct usb_audio_term iterm;
1242         unsigned int master_bits, first_ch_bits;
1243         int err, csize;
1244         struct uac_feature_unit_descriptor *hdr = _ftr;
1245         __u8 *bmaControls;
1246
1247         if (state->mixer->protocol == UAC_VERSION_1) {
1248                 csize = hdr->bControlSize;
1249                 if (!csize) {
1250                         snd_printdd(KERN_ERR "usbaudio: unit %u: "
1251                                     "invalid bControlSize == 0\n", unitid);
1252                         return -EINVAL;
1253                 }
1254                 channels = (hdr->bLength - 7) / csize - 1;
1255                 bmaControls = hdr->bmaControls;
1256                 if (hdr->bLength < 7 + csize) {
1257                         snd_printk(KERN_ERR "usbaudio: unit %u: "
1258                                    "invalid UAC_FEATURE_UNIT descriptor\n",
1259                                    unitid);
1260                         return -EINVAL;
1261                 }
1262         } else {
1263                 struct uac2_feature_unit_descriptor *ftr = _ftr;
1264                 csize = 4;
1265                 channels = (hdr->bLength - 6) / 4 - 1;
1266                 bmaControls = ftr->bmaControls;
1267                 if (hdr->bLength < 6 + csize) {
1268                         snd_printk(KERN_ERR "usbaudio: unit %u: "
1269                                    "invalid UAC_FEATURE_UNIT descriptor\n",
1270                                    unitid);
1271                         return -EINVAL;
1272                 }
1273         }
1274
1275         /* parse the source unit */
1276         if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1277                 return err;
1278
1279         /* determine the input source type and name */
1280         err = check_input_term(state, hdr->bSourceID, &iterm);
1281         if (err < 0)
1282                 return err;
1283
1284         master_bits = snd_usb_combine_bytes(bmaControls, csize);
1285         /* master configuration quirks */
1286         switch (state->chip->usb_id) {
1287         case USB_ID(0x08bb, 0x2702):
1288                 snd_printk(KERN_INFO
1289                            "usbmixer: master volume quirk for PCM2702 chip\n");
1290                 /* disable non-functional volume control */
1291                 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1292                 break;
1293         }
1294         if (channels > 0)
1295                 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1296         else
1297                 first_ch_bits = 0;
1298
1299         if (state->mixer->protocol == UAC_VERSION_1) {
1300                 /* check all control types */
1301                 for (i = 0; i < 10; i++) {
1302                         unsigned int ch_bits = 0;
1303                         for (j = 0; j < channels; j++) {
1304                                 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1305                                 if (mask & (1 << i))
1306                                         ch_bits |= (1 << j);
1307                         }
1308                         /* audio class v1 controls are never read-only */
1309                         if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1310                                 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, 0);
1311                         if (master_bits & (1 << i))
1312                                 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 0);
1313                 }
1314         } else { /* UAC_VERSION_2 */
1315                 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1316                         unsigned int ch_bits = 0;
1317                         unsigned int ch_read_only = 0;
1318
1319                         for (j = 0; j < channels; j++) {
1320                                 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1321                                 if (uac2_control_is_readable(mask, i)) {
1322                                         ch_bits |= (1 << j);
1323                                         if (!uac2_control_is_writeable(mask, i))
1324                                                 ch_read_only |= (1 << j);
1325                                 }
1326                         }
1327
1328                         /* NOTE: build_feature_ctl() will mark the control read-only if all channels
1329                          * are marked read-only in the descriptors. Otherwise, the control will be
1330                          * reported as writeable, but the driver will not actually issue a write
1331                          * command for read-only channels */
1332                         if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1333                                 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, ch_read_only);
1334                         if (uac2_control_is_readable(master_bits, i))
1335                                 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1336                                                   !uac2_control_is_writeable(master_bits, i));
1337                 }
1338         }
1339
1340         return 0;
1341 }
1342
1343
1344 /*
1345  * Mixer Unit
1346  */
1347
1348 /*
1349  * build a mixer unit control
1350  *
1351  * the callbacks are identical with feature unit.
1352  * input channel number (zero based) is given in control field instead.
1353  */
1354
1355 static void build_mixer_unit_ctl(struct mixer_build *state,
1356                                  struct uac_mixer_unit_descriptor *desc,
1357                                  int in_pin, int in_ch, int unitid,
1358                                  struct usb_audio_term *iterm)
1359 {
1360         struct usb_mixer_elem_info *cval;
1361         unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1362         unsigned int i, len;
1363         struct snd_kcontrol *kctl;
1364         const struct usbmix_name_map *map;
1365
1366         map = find_map(state, unitid, 0);
1367         if (check_ignored_ctl(map))
1368                 return;
1369
1370         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1371         if (! cval)
1372                 return;
1373
1374         cval->mixer = state->mixer;
1375         cval->id = unitid;
1376         cval->control = in_ch + 1; /* based on 1 */
1377         cval->val_type = USB_MIXER_S16;
1378         for (i = 0; i < num_outs; i++) {
1379                 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), in_ch, i, num_outs)) {
1380                         cval->cmask |= (1 << i);
1381                         cval->channels++;
1382                 }
1383         }
1384
1385         /* get min/max values */
1386         get_min_max(cval, 0);
1387
1388         kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1389         if (! kctl) {
1390                 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1391                 kfree(cval);
1392                 return;
1393         }
1394         kctl->private_free = usb_mixer_elem_free;
1395
1396         len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1397         if (! len)
1398                 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
1399         if (! len)
1400                 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1401         append_ctl_name(kctl, " Volume");
1402
1403         snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
1404                     cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1405         snd_usb_mixer_add_control(state->mixer, kctl);
1406 }
1407
1408
1409 /*
1410  * parse a mixer unit
1411  */
1412 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, void *raw_desc)
1413 {
1414         struct uac_mixer_unit_descriptor *desc = raw_desc;
1415         struct usb_audio_term iterm;
1416         int input_pins, num_ins, num_outs;
1417         int pin, ich, err;
1418
1419         if (desc->bLength < 11 || ! (input_pins = desc->bNrInPins) || ! (num_outs = uac_mixer_unit_bNrChannels(desc))) {
1420                 snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
1421                 return -EINVAL;
1422         }
1423         /* no bmControls field (e.g. Maya44) -> ignore */
1424         if (desc->bLength <= 10 + input_pins) {
1425                 snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
1426                 return 0;
1427         }
1428
1429         num_ins = 0;
1430         ich = 0;
1431         for (pin = 0; pin < input_pins; pin++) {
1432                 err = parse_audio_unit(state, desc->baSourceID[pin]);
1433                 if (err < 0)
1434                         return err;
1435                 err = check_input_term(state, desc->baSourceID[pin], &iterm);
1436                 if (err < 0)
1437                         return err;
1438                 num_ins += iterm.channels;
1439                 for (; ich < num_ins; ++ich) {
1440                         int och, ich_has_controls = 0;
1441
1442                         for (och = 0; och < num_outs; ++och) {
1443                                 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol),
1444                                                         ich, och, num_outs)) {
1445                                         ich_has_controls = 1;
1446                                         break;
1447                                 }
1448                         }
1449                         if (ich_has_controls)
1450                                 build_mixer_unit_ctl(state, desc, pin, ich,
1451                                                      unitid, &iterm);
1452                 }
1453         }
1454         return 0;
1455 }
1456
1457
1458 /*
1459  * Processing Unit / Extension Unit
1460  */
1461
1462 /* get callback for processing/extension unit */
1463 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1464 {
1465         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1466         int err, val;
1467
1468         err = get_cur_ctl_value(cval, cval->control << 8, &val);
1469         if (err < 0 && cval->mixer->ignore_ctl_error) {
1470                 ucontrol->value.integer.value[0] = cval->min;
1471                 return 0;
1472         }
1473         if (err < 0)
1474                 return err;
1475         val = get_relative_value(cval, val);
1476         ucontrol->value.integer.value[0] = val;
1477         return 0;
1478 }
1479
1480 /* put callback for processing/extension unit */
1481 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1482 {
1483         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1484         int val, oval, err;
1485
1486         err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1487         if (err < 0) {
1488                 if (cval->mixer->ignore_ctl_error)
1489                         return 0;
1490                 return err;
1491         }
1492         val = ucontrol->value.integer.value[0];
1493         val = get_abs_value(cval, val);
1494         if (val != oval) {
1495                 set_cur_ctl_value(cval, cval->control << 8, val);
1496                 return 1;
1497         }
1498         return 0;
1499 }
1500
1501 /* alsa control interface for processing/extension unit */
1502 static struct snd_kcontrol_new mixer_procunit_ctl = {
1503         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1504         .name = "", /* will be filled later */
1505         .info = mixer_ctl_feature_info,
1506         .get = mixer_ctl_procunit_get,
1507         .put = mixer_ctl_procunit_put,
1508 };
1509
1510
1511 /*
1512  * predefined data for processing units
1513  */
1514 struct procunit_value_info {
1515         int control;
1516         char *suffix;
1517         int val_type;
1518         int min_value;
1519 };
1520
1521 struct procunit_info {
1522         int type;
1523         char *name;
1524         struct procunit_value_info *values;
1525 };
1526
1527 static struct procunit_value_info updown_proc_info[] = {
1528         { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1529         { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1530         { 0 }
1531 };
1532 static struct procunit_value_info prologic_proc_info[] = {
1533         { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1534         { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1535         { 0 }
1536 };
1537 static struct procunit_value_info threed_enh_proc_info[] = {
1538         { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1539         { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
1540         { 0 }
1541 };
1542 static struct procunit_value_info reverb_proc_info[] = {
1543         { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1544         { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1545         { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1546         { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
1547         { 0 }
1548 };
1549 static struct procunit_value_info chorus_proc_info[] = {
1550         { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1551         { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1552         { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1553         { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1554         { 0 }
1555 };
1556 static struct procunit_value_info dcr_proc_info[] = {
1557         { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1558         { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1559         { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1560         { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1561         { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1562         { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
1563         { 0 }
1564 };
1565
1566 static struct procunit_info procunits[] = {
1567         { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1568         { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1569         { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1570         { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1571         { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1572         { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
1573         { 0 },
1574 };
1575 /*
1576  * predefined data for extension units
1577  */
1578 static struct procunit_value_info clock_rate_xu_info[] = {
1579         { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1580         { 0 }
1581 };
1582 static struct procunit_value_info clock_source_xu_info[] = {
1583         { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1584         { 0 }
1585 };
1586 static struct procunit_value_info spdif_format_xu_info[] = {
1587         { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1588         { 0 }
1589 };
1590 static struct procunit_value_info soft_limit_xu_info[] = {
1591         { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1592         { 0 }
1593 };
1594 static struct procunit_info extunits[] = {
1595         { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1596         { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1597         { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1598         { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1599         { 0 }
1600 };
1601 /*
1602  * build a processing/extension unit
1603  */
1604 static int build_audio_procunit(struct mixer_build *state, int unitid, void *raw_desc, struct procunit_info *list, char *name)
1605 {
1606         struct uac_processing_unit_descriptor *desc = raw_desc;
1607         int num_ins = desc->bNrInPins;
1608         struct usb_mixer_elem_info *cval;
1609         struct snd_kcontrol *kctl;
1610         int i, err, nameid, type, len;
1611         struct procunit_info *info;
1612         struct procunit_value_info *valinfo;
1613         const struct usbmix_name_map *map;
1614         static struct procunit_value_info default_value_info[] = {
1615                 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1616                 { 0 }
1617         };
1618         static struct procunit_info default_info = {
1619                 0, NULL, default_value_info
1620         };
1621
1622         if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1623             desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
1624                 snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1625                 return -EINVAL;
1626         }
1627
1628         for (i = 0; i < num_ins; i++) {
1629                 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1630                         return err;
1631         }
1632
1633         type = le16_to_cpu(desc->wProcessType);
1634         for (info = list; info && info->type; info++)
1635                 if (info->type == type)
1636                         break;
1637         if (! info || ! info->type)
1638                 info = &default_info;
1639
1640         for (valinfo = info->values; valinfo->control; valinfo++) {
1641                 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
1642
1643                 if (! (controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
1644                         continue;
1645                 map = find_map(state, unitid, valinfo->control);
1646                 if (check_ignored_ctl(map))
1647                         continue;
1648                 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1649                 if (! cval) {
1650                         snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1651                         return -ENOMEM;
1652                 }
1653                 cval->mixer = state->mixer;
1654                 cval->id = unitid;
1655                 cval->control = valinfo->control;
1656                 cval->val_type = valinfo->val_type;
1657                 cval->channels = 1;
1658
1659                 /* get min/max values */
1660                 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
1661                         __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
1662                         /* FIXME: hard-coded */
1663                         cval->min = 1;
1664                         cval->max = control_spec[0];
1665                         cval->res = 1;
1666                         cval->initialized = 1;
1667                 } else {
1668                         if (type == USB_XU_CLOCK_RATE) {
1669                                 /* E-Mu USB 0404/0202/TrackerPre/0204
1670                                  * samplerate control quirk
1671                                  */
1672                                 cval->min = 0;
1673                                 cval->max = 5;
1674                                 cval->res = 1;
1675                                 cval->initialized = 1;
1676                         } else
1677                                 get_min_max(cval, valinfo->min_value);
1678                 }
1679
1680                 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1681                 if (! kctl) {
1682                         snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1683                         kfree(cval);
1684                         return -ENOMEM;
1685                 }
1686                 kctl->private_free = usb_mixer_elem_free;
1687
1688                 if (check_mapped_name(map, kctl->id.name,
1689                                                 sizeof(kctl->id.name)))
1690                         /* nothing */ ;
1691                 else if (info->name)
1692                         strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1693                 else {
1694                         nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
1695                         len = 0;
1696                         if (nameid)
1697                                 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1698                         if (! len)
1699                                 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1700                 }
1701                 append_ctl_name(kctl, " ");
1702                 append_ctl_name(kctl, valinfo->suffix);
1703
1704                 snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
1705                             cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1706                 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
1707                         return err;
1708         }
1709         return 0;
1710 }
1711
1712
1713 static int parse_audio_processing_unit(struct mixer_build *state, int unitid, void *raw_desc)
1714 {
1715         return build_audio_procunit(state, unitid, raw_desc, procunits, "Processing Unit");
1716 }
1717
1718 static int parse_audio_extension_unit(struct mixer_build *state, int unitid, void *raw_desc)
1719 {
1720         /* Note that we parse extension units with processing unit descriptors.
1721          * That's ok as the layout is the same */
1722         return build_audio_procunit(state, unitid, raw_desc, extunits, "Extension Unit");
1723 }
1724
1725
1726 /*
1727  * Selector Unit
1728  */
1729
1730 /* info callback for selector unit
1731  * use an enumerator type for routing
1732  */
1733 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
1734 {
1735         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1736         const char **itemlist = (const char **)kcontrol->private_value;
1737
1738         if (snd_BUG_ON(!itemlist))
1739                 return -EINVAL;
1740         return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
1741 }
1742
1743 /* get callback for selector unit */
1744 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1745 {
1746         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1747         int val, err;
1748
1749         err = get_cur_ctl_value(cval, cval->control << 8, &val);
1750         if (err < 0) {
1751                 if (cval->mixer->ignore_ctl_error) {
1752                         ucontrol->value.enumerated.item[0] = 0;
1753                         return 0;
1754                 }
1755                 return err;
1756         }
1757         val = get_relative_value(cval, val);
1758         ucontrol->value.enumerated.item[0] = val;
1759         return 0;
1760 }
1761
1762 /* put callback for selector unit */
1763 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1764 {
1765         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1766         int val, oval, err;
1767
1768         err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1769         if (err < 0) {
1770                 if (cval->mixer->ignore_ctl_error)
1771                         return 0;
1772                 return err;
1773         }
1774         val = ucontrol->value.enumerated.item[0];
1775         val = get_abs_value(cval, val);
1776         if (val != oval) {
1777                 set_cur_ctl_value(cval, cval->control << 8, val);
1778                 return 1;
1779         }
1780         return 0;
1781 }
1782
1783 /* alsa control interface for selector unit */
1784 static struct snd_kcontrol_new mixer_selectunit_ctl = {
1785         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1786         .name = "", /* will be filled later */
1787         .info = mixer_ctl_selector_info,
1788         .get = mixer_ctl_selector_get,
1789         .put = mixer_ctl_selector_put,
1790 };
1791
1792
1793 /* private free callback.
1794  * free both private_data and private_value
1795  */
1796 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
1797 {
1798         int i, num_ins = 0;
1799
1800         if (kctl->private_data) {
1801                 struct usb_mixer_elem_info *cval = kctl->private_data;
1802                 num_ins = cval->max;
1803                 kfree(cval);
1804                 kctl->private_data = NULL;
1805         }
1806         if (kctl->private_value) {
1807                 char **itemlist = (char **)kctl->private_value;
1808                 for (i = 0; i < num_ins; i++)
1809                         kfree(itemlist[i]);
1810                 kfree(itemlist);
1811                 kctl->private_value = 0;
1812         }
1813 }
1814
1815 /*
1816  * parse a selector unit
1817  */
1818 static int parse_audio_selector_unit(struct mixer_build *state, int unitid, void *raw_desc)
1819 {
1820         struct uac_selector_unit_descriptor *desc = raw_desc;
1821         unsigned int i, nameid, len;
1822         int err;
1823         struct usb_mixer_elem_info *cval;
1824         struct snd_kcontrol *kctl;
1825         const struct usbmix_name_map *map;
1826         char **namelist;
1827
1828         if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
1829                 snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
1830                 return -EINVAL;
1831         }
1832
1833         for (i = 0; i < desc->bNrInPins; i++) {
1834                 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1835                         return err;
1836         }
1837
1838         if (desc->bNrInPins == 1) /* only one ? nonsense! */
1839                 return 0;
1840
1841         map = find_map(state, unitid, 0);
1842         if (check_ignored_ctl(map))
1843                 return 0;
1844
1845         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1846         if (! cval) {
1847                 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1848                 return -ENOMEM;
1849         }
1850         cval->mixer = state->mixer;
1851         cval->id = unitid;
1852         cval->val_type = USB_MIXER_U8;
1853         cval->channels = 1;
1854         cval->min = 1;
1855         cval->max = desc->bNrInPins;
1856         cval->res = 1;
1857         cval->initialized = 1;
1858
1859         if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1860                 cval->control = UAC2_CX_CLOCK_SELECTOR;
1861         else
1862                 cval->control = 0;
1863
1864         namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
1865         if (! namelist) {
1866                 snd_printk(KERN_ERR "cannot malloc\n");
1867                 kfree(cval);
1868                 return -ENOMEM;
1869         }
1870 #define MAX_ITEM_NAME_LEN       64
1871         for (i = 0; i < desc->bNrInPins; i++) {
1872                 struct usb_audio_term iterm;
1873                 len = 0;
1874                 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
1875                 if (! namelist[i]) {
1876                         snd_printk(KERN_ERR "cannot malloc\n");
1877                         while (i--)
1878                                 kfree(namelist[i]);
1879                         kfree(namelist);
1880                         kfree(cval);
1881                         return -ENOMEM;
1882                 }
1883                 len = check_mapped_selector_name(state, unitid, i, namelist[i],
1884                                                  MAX_ITEM_NAME_LEN);
1885                 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
1886                         len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
1887                 if (! len)
1888                         sprintf(namelist[i], "Input %d", i);
1889         }
1890
1891         kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
1892         if (! kctl) {
1893                 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1894                 kfree(namelist);
1895                 kfree(cval);
1896                 return -ENOMEM;
1897         }
1898         kctl->private_value = (unsigned long)namelist;
1899         kctl->private_free = usb_mixer_selector_elem_free;
1900
1901         nameid = uac_selector_unit_iSelector(desc);
1902         len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1903         if (len)
1904                 ;
1905         else if (nameid)
1906                 snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1907         else {
1908                 len = get_term_name(state, &state->oterm,
1909                                     kctl->id.name, sizeof(kctl->id.name), 0);
1910                 if (! len)
1911                         strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
1912
1913                 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1914                         append_ctl_name(kctl, " Clock Source");
1915                 else if ((state->oterm.type & 0xff00) == 0x0100)
1916                         append_ctl_name(kctl, " Capture Source");
1917                 else
1918                         append_ctl_name(kctl, " Playback Source");
1919         }
1920
1921         snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
1922                     cval->id, kctl->id.name, desc->bNrInPins);
1923         if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
1924                 return err;
1925
1926         return 0;
1927 }
1928
1929
1930 /*
1931  * parse an audio unit recursively
1932  */
1933
1934 static int parse_audio_unit(struct mixer_build *state, int unitid)
1935 {
1936         unsigned char *p1;
1937
1938         if (test_and_set_bit(unitid, state->unitbitmap))
1939                 return 0; /* the unit already visited */
1940
1941         p1 = find_audio_control_unit(state, unitid);
1942         if (!p1) {
1943                 snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
1944                 return -EINVAL;
1945         }
1946
1947         switch (p1[2]) {
1948         case UAC_INPUT_TERMINAL:
1949         case UAC2_CLOCK_SOURCE:
1950                 return 0; /* NOP */
1951         case UAC_MIXER_UNIT:
1952                 return parse_audio_mixer_unit(state, unitid, p1);
1953         case UAC_SELECTOR_UNIT:
1954         case UAC2_CLOCK_SELECTOR:
1955                 return parse_audio_selector_unit(state, unitid, p1);
1956         case UAC_FEATURE_UNIT:
1957                 return parse_audio_feature_unit(state, unitid, p1);
1958         case UAC1_PROCESSING_UNIT:
1959         /*   UAC2_EFFECT_UNIT has the same value */
1960                 if (state->mixer->protocol == UAC_VERSION_1)
1961                         return parse_audio_processing_unit(state, unitid, p1);
1962                 else
1963                         return 0; /* FIXME - effect units not implemented yet */
1964         case UAC1_EXTENSION_UNIT:
1965         /*   UAC2_PROCESSING_UNIT_V2 has the same value */
1966                 if (state->mixer->protocol == UAC_VERSION_1)
1967                         return parse_audio_extension_unit(state, unitid, p1);
1968                 else /* UAC_VERSION_2 */
1969                         return parse_audio_processing_unit(state, unitid, p1);
1970         default:
1971                 snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
1972                 return -EINVAL;
1973         }
1974 }
1975
1976 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
1977 {
1978         kfree(mixer->id_elems);
1979         if (mixer->urb) {
1980                 kfree(mixer->urb->transfer_buffer);
1981                 usb_free_urb(mixer->urb);
1982         }
1983         usb_free_urb(mixer->rc_urb);
1984         kfree(mixer->rc_setup_packet);
1985         kfree(mixer);
1986 }
1987
1988 static int snd_usb_mixer_dev_free(struct snd_device *device)
1989 {
1990         struct usb_mixer_interface *mixer = device->device_data;
1991         snd_usb_mixer_free(mixer);
1992         return 0;
1993 }
1994
1995 /*
1996  * create mixer controls
1997  *
1998  * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
1999  */
2000 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
2001 {
2002         struct mixer_build state;
2003         int err;
2004         const struct usbmix_ctl_map *map;
2005         void *p;
2006
2007         memset(&state, 0, sizeof(state));
2008         state.chip = mixer->chip;
2009         state.mixer = mixer;
2010         state.buffer = mixer->hostif->extra;
2011         state.buflen = mixer->hostif->extralen;
2012
2013         /* check the mapping table */
2014         for (map = usbmix_ctl_maps; map->id; map++) {
2015                 if (map->id == state.chip->usb_id) {
2016                         state.map = map->map;
2017                         state.selector_map = map->selector_map;
2018                         mixer->ignore_ctl_error = map->ignore_ctl_error;
2019                         break;
2020                 }
2021         }
2022
2023         p = NULL;
2024         while ((p = snd_usb_find_csint_desc(mixer->hostif->extra, mixer->hostif->extralen,
2025                                             p, UAC_OUTPUT_TERMINAL)) != NULL) {
2026                 if (mixer->protocol == UAC_VERSION_1) {
2027                         struct uac1_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                 } else { /* UAC_VERSION_2 */
2039                         struct uac2_output_terminal_descriptor *desc = p;
2040
2041                         if (desc->bLength < sizeof(*desc))
2042                                 continue; /* invalid descriptor? */
2043                         set_bit(desc->bTerminalID, state.unitbitmap);  /* mark terminal ID as visited */
2044                         state.oterm.id = desc->bTerminalID;
2045                         state.oterm.type = le16_to_cpu(desc->wTerminalType);
2046                         state.oterm.name = desc->iTerminal;
2047                         err = parse_audio_unit(&state, desc->bSourceID);
2048                         if (err < 0 && err != -EINVAL)
2049                                 return err;
2050
2051                         /* for UAC2, use the same approach to also add the clock selectors */
2052                         err = parse_audio_unit(&state, desc->bCSourceID);
2053                         if (err < 0 && err != -EINVAL)
2054                                 return err;
2055                 }
2056         }
2057
2058         return 0;
2059 }
2060
2061 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
2062 {
2063         struct usb_mixer_elem_info *info;
2064
2065         for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
2066                 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2067                                info->elem_id);
2068 }
2069
2070 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2071                                     int unitid,
2072                                     struct usb_mixer_elem_info *cval)
2073 {
2074         static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2075                                     "S8", "U8", "S16", "U16"};
2076         snd_iprintf(buffer, "  Unit: %i\n", unitid);
2077         if (cval->elem_id)
2078                 snd_iprintf(buffer, "    Control: name=\"%s\", index=%i\n",
2079                                 cval->elem_id->name, cval->elem_id->index);
2080         snd_iprintf(buffer, "    Info: id=%i, control=%i, cmask=0x%x, "
2081                             "channels=%i, type=\"%s\"\n", cval->id,
2082                             cval->control, cval->cmask, cval->channels,
2083                             val_types[cval->val_type]);
2084         snd_iprintf(buffer, "    Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2085                             cval->min, cval->max, cval->dBmin, cval->dBmax);
2086 }
2087
2088 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2089                                     struct snd_info_buffer *buffer)
2090 {
2091         struct snd_usb_audio *chip = entry->private_data;
2092         struct usb_mixer_interface *mixer;
2093         struct usb_mixer_elem_info *cval;
2094         int unitid;
2095
2096         list_for_each_entry(mixer, &chip->mixer_list, list) {
2097                 snd_iprintf(buffer,
2098                         "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2099                                 chip->usb_id, snd_usb_ctrl_intf(chip),
2100                                 mixer->ignore_ctl_error);
2101                 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2102                 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2103                         for (cval = mixer->id_elems[unitid]; cval;
2104                                                 cval = cval->next_id_elem)
2105                                 snd_usb_mixer_dump_cval(buffer, unitid, cval);
2106                 }
2107         }
2108 }
2109
2110 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2111                                        int attribute, int value, int index)
2112 {
2113         struct usb_mixer_elem_info *info;
2114         __u8 unitid = (index >> 8) & 0xff;
2115         __u8 control = (value >> 8) & 0xff;
2116         __u8 channel = value & 0xff;
2117
2118         if (channel >= MAX_CHANNELS) {
2119                 snd_printk(KERN_DEBUG "%s(): bogus channel number %d\n",
2120                                 __func__, channel);
2121                 return;
2122         }
2123
2124         for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) {
2125                 if (info->control != control)
2126                         continue;
2127
2128                 switch (attribute) {
2129                 case UAC2_CS_CUR:
2130                         /* invalidate cache, so the value is read from the device */
2131                         if (channel)
2132                                 info->cached &= ~(1 << channel);
2133                         else /* master channel */
2134                                 info->cached = 0;
2135
2136                         snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2137                                         info->elem_id);
2138                         break;
2139
2140                 case UAC2_CS_RANGE:
2141                         /* TODO */
2142                         break;
2143
2144                 case UAC2_CS_MEM:
2145                         /* TODO */
2146                         break;
2147
2148                 default:
2149                         snd_printk(KERN_DEBUG "unknown attribute %d in interrupt\n",
2150                                                 attribute);
2151                         break;
2152                 } /* switch */
2153         }
2154 }
2155
2156 static void snd_usb_mixer_interrupt(struct urb *urb)
2157 {
2158         struct usb_mixer_interface *mixer = urb->context;
2159         int len = urb->actual_length;
2160         int ustatus = urb->status;
2161
2162         if (ustatus != 0)
2163                 goto requeue;
2164
2165         if (mixer->protocol == UAC_VERSION_1) {
2166                 struct uac1_status_word *status;
2167
2168                 for (status = urb->transfer_buffer;
2169                      len >= sizeof(*status);
2170                      len -= sizeof(*status), status++) {
2171                         snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
2172                                                 status->bStatusType,
2173                                                 status->bOriginator);
2174
2175                         /* ignore any notifications not from the control interface */
2176                         if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2177                                 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2178                                 continue;
2179
2180                         if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2181                                 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2182                         else
2183                                 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2184                 }
2185         } else { /* UAC_VERSION_2 */
2186                 struct uac2_interrupt_data_msg *msg;
2187
2188                 for (msg = urb->transfer_buffer;
2189                      len >= sizeof(*msg);
2190                      len -= sizeof(*msg), msg++) {
2191                         /* drop vendor specific and endpoint requests */
2192                         if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2193                             (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2194                                 continue;
2195
2196                         snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2197                                                    le16_to_cpu(msg->wValue),
2198                                                    le16_to_cpu(msg->wIndex));
2199                 }
2200         }
2201
2202 requeue:
2203         if (ustatus != -ENOENT && ustatus != -ECONNRESET && ustatus != -ESHUTDOWN) {
2204                 urb->dev = mixer->chip->dev;
2205                 usb_submit_urb(urb, GFP_ATOMIC);
2206         }
2207 }
2208
2209 /* stop any bus activity of a mixer */
2210 void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2211 {
2212         usb_kill_urb(mixer->urb);
2213         usb_kill_urb(mixer->rc_urb);
2214 }
2215
2216 int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2217 {
2218         int err;
2219
2220         if (mixer->urb) {
2221                 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2222                 if (err < 0)
2223                         return err;
2224         }
2225
2226         return 0;
2227 }
2228
2229 /* create the handler for the optional status interrupt endpoint */
2230 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2231 {
2232         struct usb_endpoint_descriptor *ep;
2233         void *transfer_buffer;
2234         int buffer_length;
2235         unsigned int epnum;
2236
2237         /* we need one interrupt input endpoint */
2238         if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
2239                 return 0;
2240         ep = get_endpoint(mixer->hostif, 0);
2241         if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2242                 return 0;
2243
2244         epnum = usb_endpoint_num(ep);
2245         buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2246         transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2247         if (!transfer_buffer)
2248                 return -ENOMEM;
2249         mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2250         if (!mixer->urb) {
2251                 kfree(transfer_buffer);
2252                 return -ENOMEM;
2253         }
2254         usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2255                          usb_rcvintpipe(mixer->chip->dev, epnum),
2256                          transfer_buffer, buffer_length,
2257                          snd_usb_mixer_interrupt, mixer, ep->bInterval);
2258         usb_submit_urb(mixer->urb, GFP_KERNEL);
2259         return 0;
2260 }
2261
2262 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2263                          int ignore_error)
2264 {
2265         static struct snd_device_ops dev_ops = {
2266                 .dev_free = snd_usb_mixer_dev_free
2267         };
2268         struct usb_mixer_interface *mixer;
2269         struct snd_info_entry *entry;
2270         int err;
2271
2272         strcpy(chip->card->mixername, "USB Mixer");
2273
2274         mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2275         if (!mixer)
2276                 return -ENOMEM;
2277         mixer->chip = chip;
2278         mixer->ignore_ctl_error = ignore_error;
2279         mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2280                                   GFP_KERNEL);
2281         if (!mixer->id_elems) {
2282                 kfree(mixer);
2283                 return -ENOMEM;
2284         }
2285
2286         mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2287         switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
2288         case UAC_VERSION_1:
2289         default:
2290                 mixer->protocol = UAC_VERSION_1;
2291                 break;
2292         case UAC_VERSION_2:
2293                 mixer->protocol = UAC_VERSION_2;
2294                 break;
2295         }
2296
2297         if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2298             (err = snd_usb_mixer_status_create(mixer)) < 0)
2299                 goto _error;
2300
2301         snd_usb_mixer_apply_create_quirk(mixer);
2302
2303         err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
2304         if (err < 0)
2305                 goto _error;
2306
2307         if (list_empty(&chip->mixer_list) &&
2308             !snd_card_proc_new(chip->card, "usbmixer", &entry))
2309                 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2310
2311         list_add(&mixer->list, &chip->mixer_list);
2312         return 0;
2313
2314 _error:
2315         snd_usb_mixer_free(mixer);
2316         return err;
2317 }
2318
2319 void snd_usb_mixer_disconnect(struct list_head *p)
2320 {
2321         struct usb_mixer_interface *mixer;
2322
2323         mixer = list_entry(p, struct usb_mixer_interface, list);
2324         usb_kill_urb(mixer->urb);
2325         usb_kill_urb(mixer->rc_urb);
2326 }