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