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