sound/usb/mixer.c

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