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