sound/usb/mixer.c

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