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