sound/usb/mixer.c

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